914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
12 KiB
Class: NotificationService
Hierarchy
-
TransactionBaseService↳
NotificationService
Constructors
constructor
• new NotificationService(container)
Parameters
| Name | Type |
|---|---|
container |
InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/notification.ts:34
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
attachmentGenerator_
• Protected attachmentGenerator_: unknown = null
Defined in
medusa/src/services/notification.ts:25
container_
• Protected Readonly container_: InjectedDependencies & {}
Defined in
medusa/src/services/notification.ts:26
logger_
• Protected Readonly logger_: Logger
Defined in
medusa/src/services/notification.ts:29
manager_
• Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
notificationProviderRepository_
• Protected Readonly notificationProviderRepository_: Repository<NotificationProvider>
Defined in
medusa/src/services/notification.ts:32
notificationRepository_
• Protected Readonly notificationRepository_: Repository<Notification>
Defined in
medusa/src/services/notification.ts:30
subscribers_
• Protected subscribers_: Object = {}
Defined in
medusa/src/services/notification.ts:24
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
• Protected get activeManager_(): EntityManager
Returns
EntityManager
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
atomicPhase_
▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>
Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.
Type parameters
| Name |
|---|
TResult |
TError |
Parameters
| Name | Type | Description |
|---|---|---|
work |
(transactionManager: EntityManager) => Promise<TResult> |
the transactional work to be done |
isolationOrErrorHandler? |
IsolationLevel | (error: TError) => Promise<void | TResult> |
the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? |
(error: TError) => Promise<void | TResult> |
Potential error handler |
Returns
Promise<TResult>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
handleEvent
▸ handleEvent(eventName, data): Promise<undefined | void | Notification[]>
Handles an event by relaying the event data to the subscribing providers. The result of the notification send will be persisted in the database in order to allow for resends. Will log any errors that are encountered.
Parameters
| Name | Type | Description |
|---|---|---|
eventName |
string |
the event to handle |
data |
Record<string, unknown> |
the data the event was sent with |
Returns
Promise<undefined | void | Notification[]>
the result of notification subscribed
Defined in
medusa/src/services/notification.ts:185
list
▸ list(selector, config?): Promise<Notification[]>
Retrieves a list of notifications.
Parameters
| Name | Type | Description |
|---|---|---|
selector |
Selector<Notification> |
the params to select the notifications by. |
config |
FindConfig<Notification> |
the configuration to apply to the query |
Returns
Promise<Notification[]>
the notifications that satisfy the query.
Defined in
medusa/src/services/notification.ts:78
listAndCount
▸ listAndCount(selector, config?): Promise<[Notification[], number]>
Retrieves a list of notifications and total count.
Parameters
| Name | Type | Description |
|---|---|---|
selector |
Selector<Notification> |
the params to select the notifications by. |
config |
FindConfig<Notification> |
the configuration to apply to the query |
Returns
Promise<[Notification[], number]>
the notifications that satisfy the query as well as the count.
Defined in
medusa/src/services/notification.ts:97
registerAttachmentGenerator
▸ registerAttachmentGenerator(service): void
Registers an attachment generator to the service. The generator can be used to generate on demand invoices or other documents.
Parameters
| Name | Type | Description |
|---|---|---|
service |
unknown |
the service to assign to the attachmentGenerator |
Returns
void
Defined in
medusa/src/services/notification.ts:52
registerInstalledProviders
▸ registerInstalledProviders(providerIds): Promise<void>
Takes a list of notification provider ids and persists them in the database.
Parameters
| Name | Type | Description |
|---|---|---|
providerIds |
string[] |
a list of provider ids |
Returns
Promise<void>
Defined in
medusa/src/services/notification.ts:60
resend
▸ resend(id, config?): Promise<Notification>
Resends a notification by retrieving a prior notification and calling the underlying provider's resendNotification method.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the notification |
config |
FindConfig<Notification> |
any configuration that might override the previous send |
Returns
Promise<Notification>
the newly created notification
Defined in
medusa/src/services/notification.ts:265
retrieve
▸ retrieve(id, config?): Promise<Notification>
Retrieves a notification with a given id
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the notification |
config |
FindConfig<Notification> |
the configuration to apply to the query |
Returns
Promise<Notification>
the notification
Defined in
medusa/src/services/notification.ts:118
retrieveProvider_
▸ Protected retrieveProvider_(id): AbstractNotificationService
Finds a provider with a given id. Will throw a NOT_FOUND error if the resolution fails.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the provider |
Returns
AbstractNotificationService
the notification provider
Defined in
medusa/src/services/notification.ts:166
send
▸ send(event, eventData, providerId): Promise<undefined | Notification>
Sends a notification, by calling the given provider's sendNotification method. Persists the Notification in the database.
Parameters
| Name | Type | Description |
|---|---|---|
event |
string |
the name of the event |
eventData |
Record<string, unknown> |
the data the event was sent with |
providerId |
string |
the provider that should hande the event. |
Returns
Promise<undefined | Notification>
the created notification
Defined in
medusa/src/services/notification.ts:217
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
subscribe
▸ subscribe(eventName, providerId): void
Subscribes a given provider to an event.
Parameters
| Name | Type | Description |
|---|---|---|
eventName |
string |
the event to subscribe to |
providerId |
string |
the provider that the event will be sent to |
Returns
void
Defined in
medusa/src/services/notification.ts:145
withTransaction
▸ withTransaction(transactionManager?): NotificationService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction