@acmekit/utils 2.13.1

package/dist/modules-sdk/types/acmekit-service.d.ts

@@ -0,0 +1,154 @@
+import { Constructor, Context, FindConfig, IDmlEntity, InferEntityForModuleService, InferEntityType, Pluralize, Prettify, RestoreReturn, SoftDeleteReturn } from "@acmekit/types";
+import { EventArgs } from "@mikro-orm/core";
+import { DmlEntity } from "../../dml";
+export type BaseMethods = "retrieve" | "list" | "listAndCount" | "delete" | "softDelete" | "restore" | "create" | "update";
+export type ModelDTOConfig = {
+    dto: object;
+    model?: DmlEntity<any, any>;
+    create?: any;
+    update?: any;
+};
+export type ModelsConfigTemplate = {
+    [key: string]: ModelDTOConfig;
+};
+/**
+ * We do not want the DML DTO to accept auto-managed timestamps
+ * as part of the input for the "create" and the "update"
+ * methods
+ */
+type DMLDTOExcludeProperties = "created_at" | "updated_at" | "deleted_at";
+export type ModelConfigurationsToConfigTemplate<T extends ModelEntries> = {
+    [Key in keyof T]: {
+        dto: T[Key] extends DmlEntity<any, any> ? InferEntityType<T[Key]> : T[Key] extends Constructor<any> ? InstanceType<T[Key]> : any;
+        inputDto: T[Key] extends DmlEntity<any, any> ? Omit<InferEntityForModuleService<T[Key]>, DMLDTOExcludeProperties> : T[Key] extends Constructor<any> ? InstanceType<T[Key]> : any;
+        model: T[Key] extends {
+            model: infer MODEL;
+        } ? MODEL : T[Key] extends IDmlEntity<any, any> ? T[Key] : never;
+    };
+};
+/**
+ * @deprecated should all notion of singular and plural be removed once all modules are aligned with the convention
+ */
+export type ExtractSingularName<T extends Record<any, any>, K = keyof T> = Capitalize<T[K] extends {
+    singular?: string;
+} ? T[K]["singular"] & string : K & string>;
+/**
+ * @deprecated should all notion of singular and plural be removed once all modules are aligned with the convention
+ * The pluralize will move to where it should be used instead
+ */
+export type ExtractPluralName<T extends Record<any, any>, K = keyof T> = Capitalize<T[K] extends {
+    plural?: string;
+} ? T[K]["plural"] & string : Pluralize<K & string>>;
+export type ModelEntries<Keys = string> = Record<Keys & string, DmlEntity<any, any>
+/**
+ * @deprecated
+ */
+ | Constructor<any>
+/**
+ * @deprecated
+ */
+ | {
+    name?: string;
+    singular?: string;
+    plural?: string;
+}>;
+/**
+ * Returns the input DTO for the servide
+ */
+type GetServiceInput<ModelConfig extends {
+    dto: any;
+    inputDto?: any;
+}> = Partial<[
+    undefined
+] extends ModelConfig["inputDto"] ? ModelConfig["dto"] : ModelConfig["inputDto"]>;
+export type ExtractKeysFromConfig<ModelsConfig> = ModelsConfig extends {
+    __empty: any;
+} ? string : keyof ModelsConfig;
+export type AbstractModuleService<TModelsDtoConfig extends Record<string, {
+    dto: any;
+    inputDto?: any;
+}>> = {
+    [TModelName in keyof TModelsDtoConfig as `retrieve${ExtractSingularName<TModelsDtoConfig, TModelName>}`]: (id: string, config?: FindConfig<TModelsDtoConfig[TModelName]["dto"]>, sharedContext?: Context) => Promise<TModelsDtoConfig[TModelName]["dto"]>;
+} & {
+    [TModelName in keyof TModelsDtoConfig as `list${ExtractPluralName<TModelsDtoConfig, TModelName>}`]: (filters?: any, config?: FindConfig<TModelsDtoConfig[TModelName]["dto"]>, sharedContext?: Context) => Promise<TModelsDtoConfig[TModelName]["dto"][]>;
+} & {
+    [TModelName in keyof TModelsDtoConfig as `listAndCount${ExtractPluralName<TModelsDtoConfig, TModelName>}`]: {
+        (filters?: any, config?: FindConfig<TModelsDtoConfig[TModelName]["dto"]>, sharedContext?: Context): Promise<[TModelsDtoConfig[TModelName]["dto"][], number]>;
+    };
+} & {
+    [TModelName in keyof TModelsDtoConfig as `delete${ExtractPluralName<TModelsDtoConfig, TModelName>}`]: {
+        (primaryKeyValues: string | object | string[] | object[], sharedContext?: Context): Promise<void>;
+    };
+} & {
+    [TModelName in keyof TModelsDtoConfig as `softDelete${ExtractPluralName<TModelsDtoConfig, TModelName>}`]: {
+        <TReturnableLinkableKeys extends string>(primaryKeyValues: string | object | string[] | object[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    };
+} & {
+    [TModelName in keyof TModelsDtoConfig as `restore${ExtractPluralName<TModelsDtoConfig, TModelName>}`]: {
+        <TReturnableLinkableKeys extends string>(primaryKeyValues: string | object | string[] | object[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    };
+} & {
+    [TModelName in keyof TModelsDtoConfig as `create${ExtractPluralName<TModelsDtoConfig, TModelName>}`]: {
+        (data: Prettify<GetServiceInput<TModelsDtoConfig[TModelName]>>, ...rest: any[]): Promise<TModelsDtoConfig[TModelName]["dto"]>;
+        (data: Prettify<GetServiceInput<TModelsDtoConfig[TModelName]>>[], ...rest: any[]): Promise<TModelsDtoConfig[TModelName]["dto"][]>;
+    };
+} & {
+    [TModelName in keyof TModelsDtoConfig as `update${ExtractPluralName<TModelsDtoConfig, TModelName>}`]: {
+        (data: Prettify<GetServiceInput<TModelsDtoConfig[TModelName]>>, ...rest: any[]): Promise<TModelsDtoConfig[TModelName]["dto"]>;
+        (dataOrOptions: Prettify<GetServiceInput<TModelsDtoConfig[TModelName]>>[] | {
+            selector: Record<string, any>;
+            data: Prettify<GetServiceInput<TModelsDtoConfig[TModelName]>> | Prettify<GetServiceInput<TModelsDtoConfig[TModelName]>>[];
+        } | {
+            selector: Record<string, any>;
+            data: Prettify<GetServiceInput<TModelsDtoConfig[TModelName]>> | Prettify<GetServiceInput<TModelsDtoConfig[TModelName]>>[];
+        }[], ...rest: any[]): Promise<TModelsDtoConfig[TModelName]["dto"][]>;
+    };
+};
+type InferModelFromConfig<T> = {
+    [K in keyof T as T[K] extends {
+        model: any;
+    } ? K : K extends IDmlEntity<any, any> ? K : never]: T[K] extends {
+        model: infer MODEL;
+    } ? MODEL extends IDmlEntity<any, any> ? MODEL : never : T[K] extends IDmlEntity<any, any> ? T[K] : never;
+};
+export type AcmeKitServiceReturnType<ModelsConfig extends Record<string, any>> = {
+    new (...args: any[]): AbstractModuleService<ModelsConfig>;
+    $modelObjects: InferModelFromConfig<ModelsConfig>;
+    /**
+     * helper function to aggregate events. Will format the message properly and store in
+     * the message aggregator in the context
+     * @param action
+     * @param object
+     * @param eventName optional, can be inferred from the module joiner config + action + object
+     * @param source optional, can be inferred from the module joiner config
+     * @param data
+     * @param context
+     */
+    aggregatedEvents({ action, object, eventName, source, data, context, }: {
+        action: string;
+        object: string;
+        eventName: string;
+        source?: string;
+        data: {
+            id: any;
+        } | {
+            id: any;
+        }[];
+        context: Context;
+    }): void;
+    /**
+     * this method is meant to react to any event the orm might emit
+     * when an entity is being mutated (created, updated, deleted).
+     * The default implementation will handle all event to be emitted as part
+     * of the message aggregator from the context.
+     *
+     * If you want to handle the event differently, you can override this method.
+     *
+     * @param event - The event type
+     * @param args - The event arguments
+     * @param context - The context
+     */
+    interceptEntityMutationEvents(event: "afterCreate" | "afterUpdate" | "afterUpsert" | "afterDelete", args: EventArgs<any>, context: Context): void;
+};
+export {};
+//# sourceMappingURL=acmekit-service.d.ts.map

package/dist/modules-sdk/types/acmekit-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acmekit-service.d.ts","sourceRoot":"","sources":["../../../src/modules-sdk/types/acmekit-service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,OAAO,EACP,UAAU,EACV,UAAU,EACV,2BAA2B,EAC3B,eAAe,EACf,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EACjB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAErC,MAAM,MAAM,WAAW,GACnB,UAAU,GACV,MAAM,GACN,cAAc,GACd,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,QAAQ,GACR,QAAQ,CAAA;AAEZ,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IAC3B,MAAM,CAAC,EAAE,GAAG,CAAA;IACZ,MAAM,CAAC,EAAE,GAAG,CAAA;CACb,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,CAAA;AAEpE;;;;GAIG;AACH,KAAK,uBAAuB,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CAAA;AAEzE,MAAM,MAAM,mCAAmC,CAAC,CAAC,SAAS,YAAY,IAAI;KACvE,GAAG,IAAI,MAAM,CAAC,GAAG;QAChB,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,GACnC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GACvB,CAAC,CAAC,GAAG,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,GAC/B,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GACpB,GAAG,CAAA;QACP,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,GACxC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,uBAAuB,CAAC,GAClE,CAAC,CAAC,GAAG,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,GAC/B,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GACpB,GAAG,CAAA;QACP,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS;YAAE,KAAK,EAAE,MAAM,KAAK,CAAA;SAAE,GACxC,KAAK,GACL,CAAC,CAAC,GAAG,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GACnC,CAAC,CAAC,GAAG,CAAC,GACN,KAAK,CAAA;KACV;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAC1B,CAAC,GAAG,MAAM,CAAC,IACT,UAAU,CACZ,CAAC,CAAC,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,GAAG,MAAM,CAC5E,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAC1B,CAAC,GAAG,MAAM,CAAC,IACT,UAAU,CACZ,CAAC,CAAC,CAAC,CAAC,SAAS;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,GACG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,GACvB,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,CAC1B,CAAA;AAGD,MAAM,MAAM,YAAY,CAAC,IAAI,GAAG,MAAM,IAAI,MAAM,CAC9C,IAAI,GAAG,MAAM,EACX,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;AACrB;;GAEG;GACD,WAAW,CAAC,GAAG,CAAC;AAClB;;GAEG;GACD;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CACxD,CAAA;AAED;;GAEG;AACH,KAAK,eAAe,CAAC,WAAW,SAAS;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;CAAE,IACnE,OAAO,CACL;IAAC,SAAS;CAAC,SAAS,WAAW,CAAC,UAAU,CAAC,GACvC,WAAW,CAAC,KAAK,CAAC,GAClB,WAAW,CAAC,UAAU,CAAC,CAC5B,CAAA;AAEH,MAAM,MAAM,qBAAqB,CAAC,YAAY,IAAI,YAAY,SAAS;IACrE,OAAO,EAAE,GAAG,CAAA;CACb,GACG,MAAM,GACN,MAAM,YAAY,CAAA;AAEtB,MAAM,MAAM,qBAAqB,CAC/B,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC,IACnE;KACD,UAAU,IAAI,MAAM,gBAAgB,IAAI,WAAW,mBAAmB,CACrE,gBAAgB,EAChB,UAAU,CACX,EAAE,GAAG,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,EACxD,aAAa,CAAC,EAAE,OAAO,KACpB,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC;CAClD,GAAG;KACD,UAAU,IAAI,MAAM,gBAAgB,IAAI,OAAO,iBAAiB,CAC/D,gBAAgB,EAChB,UAAU,CACX,EAAE,GAAG,CACJ,OAAO,CAAC,EAAE,GAAG,EACb,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,EACxD,aAAa,CAAC,EAAE,OAAO,KACpB,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;CACpD,GAAG;KACD,UAAU,IAAI,MAAM,gBAAgB,IAAI,eAAe,iBAAiB,CACvE,gBAAgB,EAChB,UAAU,CACX,EAAE,GAAG;QACJ,CACE,OAAO,CAAC,EAAE,GAAG,EACb,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,EACxD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;KAC5D;CACF,GAAG;KACD,UAAU,IAAI,MAAM,gBAAgB,IAAI,SAAS,iBAAiB,CACjE,gBAAgB,EAChB,UAAU,CACX,EAAE,GAAG;QACJ,CACE,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,EACvD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;KACjB;CACF,GAAG;KACD,UAAU,IAAI,MAAM,gBAAgB,IAAI,aAAa,iBAAiB,CACrE,gBAAgB,EAChB,UAAU,CACX,EAAE,GAAG;QACJ,CAAC,uBAAuB,SAAS,MAAM,EACrC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,EACvD,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;KAC5C;CACF,GAAG;KACD,UAAU,IAAI,MAAM,gBAAgB,IAAI,UAAU,iBAAiB,CAClE,gBAAgB,EAChB,UAAU,CACX,EAAE,GAAG;QACJ,CAAC,uBAAuB,SAAS,MAAM,EACrC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,EACvD,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;KAC5C;CACF,GAAG;KACD,UAAU,IAAI,MAAM,gBAAgB,IAAI,SAAS,iBAAiB,CACjE,gBAAgB,EAChB,UAAU,CACX,EAAE,GAAG;QACJ,CACE,IAAI,EAAE,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,EAC7D,GAAG,IAAI,EAAE,GAAG,EAAE,GACb,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;QAC/C,CACE,IAAI,EAAE,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAC/D,GAAG,IAAI,EAAE,GAAG,EAAE,GACb,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;KAClD;CACF,GAAG;KACD,UAAU,IAAI,MAAM,gBAAgB,IAAI,SAAS,iBAAiB,CACjE,gBAAgB,EAChB,UAAU,CACX,EAAE,GAAG;QACJ,CACE,IAAI,EAAE,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,EAC7D,GAAG,IAAI,EAAE,GAAG,EAAE,GACb,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;QAC/C,CACE,aAAa,EACT,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GACzD;YACE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;YAC7B,IAAI,EACA,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,GACvD,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAA;SAC9D,GACD;YACE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;YAC7B,IAAI,EACA,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,GACvD,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAA;SAC9D,EAAE,EACP,GAAG,IAAI,EAAE,GAAG,EAAE,GACb,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;KAClD;CACF,CAAA;AAwDD,KAAK,oBAAoB,CAAC,CAAC,IAAI;KAC5B,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,KAAK,EAAE,GAAG,CAAA;KAAE,GACxC,CAAC,GACD,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GAC9B,CAAC,GACD,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;QACvB,KAAK,EAAE,MAAM,KAAK,CAAA;KACnB,GACG,KAAK,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GAChC,KAAK,GACL,KAAK,GACP,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GACjC,CAAC,CAAC,CAAC,CAAC,GACJ,KAAK;CACV,CAAA;AAED,MAAM,MAAM,wBAAwB,CAAC,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAC3E;IACE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAA;IACzD,aAAa,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAA;IACjD;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EACf,MAAM,EACN,MAAM,EACN,SAAS,EACT,MAAM,EACN,IAAI,EACJ,OAAO,GACR,EAAE;QACD,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;QACd,SAAS,EAAE,MAAM,CAAA;QACjB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,EAAE;YAAE,EAAE,EAAE,GAAG,CAAA;SAAE,GAAG;YAAE,EAAE,EAAE,GAAG,CAAA;SAAE,EAAE,CAAA;QACjC,OAAO,EAAE,OAAO,CAAA;KACjB,GAAG,IAAI,CAAA;IAER;;;;;;;;;;;OAWG;IACH,6BAA6B,CAC3B,KAAK,EAAE,aAAa,GAAG,aAAa,GAAG,aAAa,GAAG,aAAa,EACpE,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,EACpB,OAAO,EAAE,OAAO,GACf,IAAI,CAAA;CACR,CAAA"}

package/dist/modules-sdk/types/acmekit-service.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=acmekit-service.js.map

package/dist/modules-sdk/types/acmekit-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"acmekit-service.js","sourceRoot":"","sources":["../../../src/modules-sdk/types/acmekit-service.ts"],"names":[],"mappings":""}

package/dist/modules-sdk/types/links-config.d.ts

@@ -0,0 +1,133 @@
+import { DMLSchema, IDmlEntity, IDmlEntityConfig, InferDmlEntityNameFromConfig, Prettify, SnakeCase } from "@acmekit/types";
+import { PrimaryKeyModifier } from "../../dml/properties/primary-key";
+/**
+ * Utils
+ */
+type FlattenUnion<T> = T extends {
+    [K in keyof T]: infer U;
+} ? {
+    [K in keyof T]: U;
+} : never;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+type UnionToOvlds<U> = UnionToIntersection<U extends any ? (f: U) => void : never>;
+type PopUnion<U> = UnionToOvlds<U> extends (a: infer A) => void ? A : never;
+type IsUnion<T> = [T] extends [UnionToIntersection<T>] ? false : true;
+type UnionToArray<T, A extends unknown[] = []> = IsUnion<T> extends true ? UnionToArray<Exclude<T, PopUnion<T>>, [PopUnion<T>, ...A]> : [T, ...A];
+/**
+ * End of utils
+ */
+/**
+ * Linkable keys
+ */
+type InferLinkableKeyName<Key, Property, DmlConfig extends IDmlEntityConfig> = Property extends PrimaryKeyModifier<any, any> ? `${Lowercase<SnakeCase<InferDmlEntityNameFromConfig<DmlConfig>>>}_${Key & string}` : never;
+type InferSchemaLinkableKeys<T> = T extends IDmlEntity<infer Schema, infer Config> ? {
+    [K in keyof Schema as Schema[K] extends PrimaryKeyModifier<any, any> ? InferLinkableKeyName<K, Schema[K], Config> : never]: Capitalize<InferDmlEntityNameFromConfig<Config>>;
+} : {};
+type InferSchemasLinkableKeys<T extends IDmlEntity<any, any>[]> = {
+    [K in keyof T]: InferSchemaLinkableKeys<T[K]>;
+};
+type AggregateSchemasLinkableKeys<T extends IDmlEntity<any, any>[]> = {
+    [K in keyof InferSchemasLinkableKeys<T>]: InferSchemasLinkableKeys<T>[K];
+};
+/**
+ * From an array of DmlEntity, returns a formatted object with the linkable keys
+ *
+ * @example:
+ *
+ * const user = model.define("user", {
+ *   id: model.id(),
+ *   name: model.text(),
+ * })
+ *
+ * const car = model.define("car", {
+ *   id: model.id(),
+ *   number_plate: model.text().primaryKey(),
+ *   test: model.text(),
+ * })
+ *
+ * const linkableKeys = buildLinkableKeysFromDmlObjects([user, car]) // { user_id: 'user', car_number_plate: 'car' }
+ *
+ */
+export type InferLinkableKeys<T extends IDmlEntity<any, any>[]> = UnionToIntersection<FlattenUnion<AggregateSchemasLinkableKeys<T>>[0]>;
+/**
+ * End Linkable keys
+ */
+/**
+ * Links config
+ */
+/**
+ * From a union infer an Array and return the last element
+ */
+type InferLastLink<ServiceName extends string, DmlEntity> = UnionToArray<InferSchemaLinksConfig<ServiceName, DmlEntity>[keyof InferSchemaLinksConfig<ServiceName, DmlEntity>]> extends [...any, infer V] ? V : never;
+type InferLastPrimaryKey<ServiceName extends string, DmlEntity> = InferLastLink<ServiceName, DmlEntity> extends {
+    primaryKey: infer PrimaryKey;
+} ? PrimaryKey : string;
+type InferLastLinkable<ServiceName extends string, DmlEntity> = InferLastLink<ServiceName, DmlEntity> extends {
+    linkable: infer Linkable;
+} ? Linkable : string;
+type InferPrimaryKeyNameOrNever<Schema extends DMLSchema, Key extends keyof Schema> = Schema[Key] extends PrimaryKeyModifier<any, any> ? Key : never;
+type InferSchemaLinksConfig<ServiceName extends string, T> = T extends IDmlEntity<infer Schema, infer Config> ? {
+    [K in keyof Schema as InferPrimaryKeyNameOrNever<Schema, K>]: {
+        serviceName: ServiceName;
+        field: T extends IDmlEntity<any, infer Config> ? InferDmlEntityNameFromConfig<Config> : string;
+        linkable: InferLinkableKeyName<K, Schema[K], Config>;
+        primaryKey: K;
+    };
+} : {};
+/**
+ * From an array of DmlEntity, returns a formatted links object.
+ * the toJSON of each object representation will return the last linkable definition
+ * as the default. To specify a specific linkable, you can chain until the desired linkable property.
+ *
+ *
+ * @example:
+ *
+ * const user = model.define("user", {
+ *   id: model.id(),
+ *   name: model.text(),
+ * })
+ *
+ * const car = model.define("car", {
+ *   id: model.id(),
+ *   number_plate: model.text().primaryKey(),
+ *   test: model.text(),
+ * })
+ *
+ * const linkConfig = buildLinkConfigFromModelObjects([user, car])
+ * // {
+ * //   user: {
+ * //     id: {
+ * //       serviceName: 'userService',
+ * //       field: 'user',
+ * //       linkable: 'user_id',
+ * //       primaryKey: 'id'
+ * //     },
+ * //     toJSON() { ... }
+ * //   },
+ * //   car: {
+ * //     number_plate: {
+ * //       serviceName: 'userService',
+ * //       field: 'car',
+ * //       linkable: 'car_number_plate',
+ * //       primaryKey: 'number_plate'
+ * //     },
+ * //     toJSON() { ... }
+ * //   }
+ * // }
+ *
+ */
+export type InfersLinksConfig<ServiceName extends string, T extends Record<string, IDmlEntity<any, any>>> = Prettify<{
+    [K in keyof T as T[K] extends IDmlEntity<any, infer Config> ? InferDmlEntityNameFromConfig<Config> : never]: Prettify<InferSchemaLinksConfig<ServiceName, T[K]> & {
+        toJSON: () => {
+            serviceName: ServiceName;
+            field: T[K] extends IDmlEntity<any, infer Config> ? InferDmlEntityNameFromConfig<Config> : string;
+            linkable: InferLastLinkable<ServiceName, T[K]>;
+            primaryKey: InferLastPrimaryKey<ServiceName, T[K]>;
+        };
+    }>;
+}>;
+export {};
+/**
+ * End Links config
+ */
+//# sourceMappingURL=links-config.d.ts.map

package/dist/modules-sdk/types/links-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"links-config.d.ts","sourceRoot":"","sources":["../../../src/modules-sdk/types/links-config.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,4BAA4B,EAC5B,QAAQ,EACR,SAAS,EACV,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAErE;;GAEG;AAEH,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC;CAAE,GACxD;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC;CAAE,GACrB,KAAK,CAAA;AAET,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAC7E,CAAC,EAAE,MAAM,CAAC,KACP,IAAI,GACL,CAAC,GACD,KAAK,CAAA;AAET,KAAK,YAAY,CAAC,CAAC,IAAI,mBAAmB,CACxC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CACvC,CAAA;AAED,KAAK,QAAQ,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG,KAAK,CAAA;AAE3E,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAA;AAErE,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GACpE,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,GAC1D,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;AAEb;;GAEG;AAEH;;GAEG;AAEH,KAAK,oBAAoB,CACvB,GAAG,EACH,QAAQ,EACR,SAAS,SAAS,gBAAgB,IAChC,QAAQ,SAAS,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,GAC7C,GAAG,SAAS,CAAC,SAAS,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,GACrE,MAAM,EAAE,GACV,KAAK,CAAA;AAET,KAAK,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CACpD,MAAM,MAAM,EACZ,MAAM,MAAM,CACb,GACG;KACG,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,GAChE,oBAAoB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAC1C,KAAK,GAAG,UAAU,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAC;CAC7D,GACD,EAAE,CAAA;AAEN,KAAK,wBAAwB,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI;KAC/D,CAAC,IAAI,MAAM,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAA;AAED,KAAK,4BAA4B,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI;KACnE,CAAC,IAAI,MAAM,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACzE,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAC5D,mBAAmB,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEvE;;GAEG;AAEH;;GAEG;AAEH;;GAEG;AACH,KAAK,aAAa,CAAC,WAAW,SAAS,MAAM,EAAE,SAAS,IAAI,YAAY,CACpE,sBAAsB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,MAAM,sBAAsB,CACzE,WAAW,EACX,SAAS,CACV,CAAC,CACL,SAAS,CAAC,GAAG,GAAG,EAAE,MAAM,CAAC,CAAC,GACvB,CAAC,GACD,KAAK,CAAA;AAET,KAAK,mBAAmB,CAAC,WAAW,SAAS,MAAM,EAAE,SAAS,IAAI,aAAa,CAC7E,WAAW,EACX,SAAS,CACV,SAAS;IACR,UAAU,EAAE,MAAM,UAAU,CAAA;CAC7B,GACG,UAAU,GACV,MAAM,CAAA;AAEV,KAAK,iBAAiB,CAAC,WAAW,SAAS,MAAM,EAAE,SAAS,IAAI,aAAa,CAC3E,WAAW,EACX,SAAS,CACV,SAAS;IACR,QAAQ,EAAE,MAAM,QAAQ,CAAA;CACzB,GACG,QAAQ,GACR,MAAM,CAAA;AAEV,KAAK,0BAA0B,CAC7B,MAAM,SAAS,SAAS,EACxB,GAAG,SAAS,MAAM,MAAM,IACtB,MAAM,CAAC,GAAG,CAAC,SAAS,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAA;AAElE,KAAK,sBAAsB,CACzB,WAAW,SAAS,MAAM,EAC1B,CAAC,IACC,CAAC,SAAS,UAAU,CAAC,MAAM,MAAM,EAAE,MAAM,MAAM,CAAC,GAChD;KACG,CAAC,IAAI,MAAM,MAAM,IAAI,0BAA0B,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG;QAC5D,WAAW,EAAE,WAAW,CAAA;QACxB,KAAK,EAAE,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GAC1C,4BAA4B,CAAC,MAAM,CAAC,GACpC,MAAM,CAAA;QACV,QAAQ,EAAE,oBAAoB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;QACpD,UAAU,EAAE,CAAC,CAAA;KACd;CACF,GACD,EAAE,CAAA;AAEN;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,MAAM,iBAAiB,CAC3B,WAAW,SAAS,MAAM,EAC1B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,IAC5C,QAAQ,CAAC;KACV,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GACvD,4BAA4B,CAAC,MAAM,CAAC,GACpC,KAAK,GAAG,QAAQ,CAClB,sBAAsB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;QAC1C,MAAM,EAAE,MAAM;YACZ,WAAW,EAAE,WAAW,CAAA;YACxB,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GAC7C,4BAA4B,CAAC,MAAM,CAAC,GACpC,MAAM,CAAA;YACV,QAAQ,EAAE,iBAAiB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAC9C,UAAU,EAAE,mBAAmB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;SACnD,CAAA;KACF,CACF;CACF,CAAC,CAAA;;AAEF;;GAEG"}

package/dist/modules-sdk/types/links-config.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * End Links config
+ */
+//# sourceMappingURL=links-config.js.map

package/dist/modules-sdk/types/links-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"links-config.js","sourceRoot":"","sources":["../../../src/modules-sdk/types/links-config.ts"],"names":[],"mappings":";;AAuNA;;GAEG"}

package/dist/notification/abstract-notification-provider.d.ts

@@ -0,0 +1,112 @@
+import { INotificationProvider, NotificationTypes } from "@acmekit/types";
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { AbstractNotificationProviderService } from "@acmekit/framework/utils"
+ * import { Logger } from "@acmekit/framework/types"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyNotificationProviderService extends AbstractNotificationProviderService {
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ * }
+ *
+ * export default MyNotificationProviderService
+ * ```
+ */
+export declare class AbstractNotificationProviderService implements INotificationProvider {
+    /**
+     * Each notification provider has a unique ID used to identify it.
+     *
+     * @example
+     * class MyNotificationProviderService extends AbstractNotificationProviderService {
+     *   static identifier = "my-notification"
+     *   // ...
+     * }
+     */
+    static identifier: string;
+    /**
+     * This method validates the options of the provider set in `acmekit-config.ts`.
+     * Implementing this method is optional. It's useful if your provider requires custom validation.
+     *
+     * If the options aren't valid, throw an error.
+     *
+     * @param options - The provider's options.
+     *
+     * @example
+     * class MyNotificationProviderService extends AbstractNotificationProviderService {
+     *   static validateOptions(options: Record<any, any>) {
+     *     if (!options.apiKey) {
+     *       throw new AcmeKitError(
+     *         AcmeKitError.Types.INVALID_DATA,
+     *         "API key is required in the provider's options."
+     *       )
+     *     }
+     *   }
+     * }
+     */
+    static validateOptions(options: Record<any, any>): void | never;
+    /**
+     * This method is used to send a notification using the third-party provider or your custom logic.
+     *
+     * @param {NotificationTypes.ProviderSendNotificationDTO} notification - The details of the
+     * notification to send.
+     * @returns {Promise<NotificationTypes.ProviderSendNotificationResultsDTO>} The result of sending
+     * the notification.
+     *
+     * @example
+     * // other imports...
+     * import {
+     *   ProviderSendNotificationDTO,
+     *   ProviderSendNotificationResultsDTO
+     * } from "@acmekit/framework/types"
+     *
+     * class MyNotificationProviderService extends AbstractNotificationProviderService {
+     *   // ...
+     *   async send(
+     *     notification: ProviderSendNotificationDTO
+     *   ): Promise<ProviderSendNotificationResultsDTO> {
+     *     // TODO send the notification using a third-party
+     *     // provider or custom logic.
+     *     // for example:
+     *     return this.client.send({
+     *       email: notification.to,
+     *       template: notification.template,
+     *       template_data: notification.data
+     *     })
+     *   }
+     * }
+     */
+    send(notification: NotificationTypes.ProviderSendNotificationDTO): Promise<NotificationTypes.ProviderSendNotificationResultsDTO>;
+}
+//# sourceMappingURL=abstract-notification-provider.d.ts.map

package/dist/notification/abstract-notification-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-notification-provider.d.ts","sourceRoot":"","sources":["../../src/notification/abstract-notification-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,qBAAa,mCACX,YAAW,qBAAqB;IAEhC;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,CAAA;IACzB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,GAAG,KAAK;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,IAAI,CACR,YAAY,EAAE,iBAAiB,CAAC,2BAA2B,GAC1D,OAAO,CAAC,iBAAiB,CAAC,kCAAkC,CAAC;CAOjE"}

package/dist/notification/abstract-notification-provider.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractNotificationProviderService = void 0;
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { AbstractNotificationProviderService } from "@acmekit/framework/utils"
+ * import { Logger } from "@acmekit/framework/types"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyNotificationProviderService extends AbstractNotificationProviderService {
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ * }
+ *
+ * export default MyNotificationProviderService
+ * ```
+ */
+class AbstractNotificationProviderService {
+    /**
+     * This method validates the options of the provider set in `acmekit-config.ts`.
+     * Implementing this method is optional. It's useful if your provider requires custom validation.
+     *
+     * If the options aren't valid, throw an error.
+     *
+     * @param options - The provider's options.
+     *
+     * @example
+     * class MyNotificationProviderService extends AbstractNotificationProviderService {
+     *   static validateOptions(options: Record<any, any>) {
+     *     if (!options.apiKey) {
+     *       throw new AcmeKitError(
+     *         AcmeKitError.Types.INVALID_DATA,
+     *         "API key is required in the provider's options."
+     *       )
+     *     }
+     *   }
+     * }
+     */
+    static validateOptions(options) { }
+    /**
+     * This method is used to send a notification using the third-party provider or your custom logic.
+     *
+     * @param {NotificationTypes.ProviderSendNotificationDTO} notification - The details of the
+     * notification to send.
+     * @returns {Promise<NotificationTypes.ProviderSendNotificationResultsDTO>} The result of sending
+     * the notification.
+     *
+     * @example
+     * // other imports...
+     * import {
+     *   ProviderSendNotificationDTO,
+     *   ProviderSendNotificationResultsDTO
+     * } from "@acmekit/framework/types"
+     *
+     * class MyNotificationProviderService extends AbstractNotificationProviderService {
+     *   // ...
+     *   async send(
+     *     notification: ProviderSendNotificationDTO
+     *   ): Promise<ProviderSendNotificationResultsDTO> {
+     *     // TODO send the notification using a third-party
+     *     // provider or custom logic.
+     *     // for example:
+     *     return this.client.send({
+     *       email: notification.to,
+     *       template: notification.template,
+     *       template_data: notification.data
+     *     })
+     *   }
+     * }
+     */
+    async send(notification) {
+        throw Error(`send is not implemented in ${Object.getPrototypeOf(this).constructor.name}`);
+    }
+}
+exports.AbstractNotificationProviderService = AbstractNotificationProviderService;
+//# sourceMappingURL=abstract-notification-provider.js.map

package/dist/notification/abstract-notification-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-notification-provider.js","sourceRoot":"","sources":["../../src/notification/abstract-notification-provider.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAa,mCAAmC;IAa9C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,eAAe,CAAC,OAAyB,IAAiB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,IAAI,CACR,YAA2D;QAE3D,MAAM,KAAK,CACT,8BACE,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,IAC1C,EAAE,CACH,CAAA;IACH,CAAC;CACF;AA3ED,kFA2EC"}

package/dist/notification/common.d.ts

@@ -0,0 +1,6 @@
+export declare enum NotificationStatus {
+    PENDING = "pending",
+    SUCCESS = "success",
+    FAILURE = "failure"
+}
+//# sourceMappingURL=common.d.ts.map

package/dist/notification/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/notification/common.ts"],"names":[],"mappings":"AAAA,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB"}

package/dist/notification/common.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationStatus = void 0;
+var NotificationStatus;
+(function (NotificationStatus) {
+    NotificationStatus["PENDING"] = "pending";
+    NotificationStatus["SUCCESS"] = "success";
+    NotificationStatus["FAILURE"] = "failure";
+})(NotificationStatus || (exports.NotificationStatus = NotificationStatus = {}));
+//# sourceMappingURL=common.js.map

package/dist/notification/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/notification/common.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;AACrB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B"}

package/dist/notification/events.d.ts

@@ -0,0 +1,14 @@
+export declare const NotificationEvents: {
+    NOTIFICATION_CREATED: "notification.notification.created";
+} & {
+    NOTIFICATION_UPDATED: "notification.notification.updated";
+} & {
+    NOTIFICATION_DELETED: "notification.notification.deleted";
+} & {
+    NOTIFICATION_RESTORED: "notification.notification.restored";
+} & {
+    NOTIFICATION_ATTACHED: "notification.notification.attached";
+} & {
+    NOTIFICATION_DETACHED: "notification.notification.detached";
+};
+//# sourceMappingURL=events.d.ts.map

package/dist/notification/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/notification/events.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,kBAAkB;;;;;;;;;;;;CAG9B,CAAA"}

package/dist/notification/events.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationEvents = void 0;
+// TODO: Comment temporarely and we will re enable it in the near future #14478
+// import { EventOptions } from "@acmekit/types"
+const event_bus_1 = require("../event-bus");
+const modules_sdk_1 = require("../modules-sdk");
+const eventBaseNames = ["notification"];
+exports.NotificationEvents = (0, event_bus_1.buildEventNamesFromEntityName)(eventBaseNames, modules_sdk_1.Modules.NOTIFICATION);
+// TODO: Comment temporarely and we will re enable it in the near future #14478
+// declare module "@acmekit/types" {
+//   export interface EventBusEventsOptions {
+//     // Notification events
+//     [NotificationEvents.NOTIFICATION_CREATED]?: EventOptions
+//     [NotificationEvents.NOTIFICATION_UPDATED]?: EventOptions
+//     [NotificationEvents.NOTIFICATION_DELETED]?: EventOptions
+//     [NotificationEvents.NOTIFICATION_RESTORED]?: EventOptions
+//     [NotificationEvents.NOTIFICATION_ATTACHED]?: EventOptions
+//     [NotificationEvents.NOTIFICATION_DETACHED]?: EventOptions
+//   }
+// }
+//# sourceMappingURL=events.js.map

package/dist/notification/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/notification/events.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAC/E,gDAAgD;AAChD,4CAA4D;AAC5D,gDAAwC;AAExC,MAAM,cAAc,GAAqB,CAAC,cAAc,CAAC,CAAA;AAE5C,QAAA,kBAAkB,GAAG,IAAA,yCAA6B,EAC7D,cAAc,EACd,qBAAO,CAAC,YAAY,CACrB,CAAA;AAED,+EAA+E;AAC/E,oCAAoC;AACpC,6CAA6C;AAC7C,6BAA6B;AAC7B,+DAA+D;AAC/D,+DAA+D;AAC/D,+DAA+D;AAC/D,gEAAgE;AAChE,gEAAgE;AAChE,gEAAgE;AAChE,MAAM;AACN,IAAI"}

package/dist/notification/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./abstract-notification-provider";
+export * from "./events";
+export * from "./common";
+//# sourceMappingURL=index.d.ts.map

package/dist/notification/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/notification/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAA;AAChD,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}