@etohq/types 1.3.0 → 1.5.0

package/dist/common/config-module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-module.d.ts","sourceRoot":"","sources":["../../src/common/config-module.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,gBAAgB,CAAA;AAEvB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAE3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAExC;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,CAAA;IACnB;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,YAAY,CAAA;CAC9C;AAED;;;;GAIG;AACH,KAAK,cAAc,GAAG;IACpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAChD,UAAU,CAAC,EAAE;YACX;;eAEG;YACH,GAAG,CAAC,EAAE;gBACJ;;mBAEG;gBACH,kBAAkB,CAAC,EAAE,KAAK,CAAA;aAC3B,CAAA;SACF,CAAA;KACF,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE;QACJ;;;;;;;;;;;;;;;;;;WAkBG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;;;;;;;;;;;;;;;;WAiBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;WAkBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAE9C;;;;;;;;;;;;;;;WAeG;QACH,gBAAgB,CAAC,EAAE;YACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;SAEjB,CAAA;KACF,CAAA;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI;IACvD;;OAEG;IACH,aAAa,EAAE,oBAAoB,CAAA;IAEnC;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,EAAE,YAAY,CAAA;IAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,EAAE,CACL;QACE,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,GACD,MAAM,CACT,EAAE,CAAA;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CAAC,EAAE,MAAM,CACd,IAAI,EACJ,OAAO,GAAG,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC,CACzE,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAKxE,iBAAiB,EAAE,wBAAwB,CAAC,IAAI,CAAC,CAAA;CAGlD,CAAA;AAED,KAAK,iCAAiC,CAAC,IAAI,GAAG,MAAM,IAAI,yBAAyB,GAAG;IAClF;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAA;IACV;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,iCAAiC,CAAC,IAAI,GAAG,MAAM,IAAI,yBAAyB,GAAG;IAClF;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAA;IACV;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,IAAI,GAAG,MAAM,IAAI,OAAO,CACrD,iCAAiC,CAAC,IAAI,CAAC,GAAG,iCAAiC,CAAC,IAAI,CAAC,CAClF,EAAE,CAAA;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,IAAI,GAAG,MAAM,IAAI,OAAO,CAC9C,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,SAAS,CAAC,GAAG;IACxC,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACrC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAA;CAClC,CACF,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,IAAI,GAAG,MAAM,IAAI;IACzC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAA;CACnC,CAAA"}
+{"version":3,"file":"config-module.d.ts","sourceRoot":"","sources":["../../src/common/config-module.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAExC;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,IAAI,MAAM,EAAE,CAAA;IAElB;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,YAAY,CAAA;CAC9C;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;;;OAMG;IACH,eAAe,CAAC,EAAE;QAChB,aAAa,CAAC,EAAE;YACd,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CAAA;QACD,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,0BAA0B;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,uBAAuB;QACvB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,iBAAiB,CAAC,EAAE,MAAM,CAAA;QAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,WAAW,CAAC,EAAE;YACZ,IAAI,EAAE,MAAM,CAAA;YACZ,IAAI,EAAE,MAAM,CAAA;SACb,EAAE,CAAA;QACH,2BAA2B,CAAC,EAAE,OAAO,CAAA;QACrC;;;WAGG;QACH,WAAW,CAAC,EAAE,OAAO,CAAA;KACtB,CAAA;CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAChD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;IACpC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;IACpC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAChD,UAAU,CAAC,EAAE;YACX;;eAEG;YACH,GAAG,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAA;SAClC,CAAA;KACF,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;IAE/B,aAAa,CAAC,EAAE,aAAa,CAAA;IAE7B;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE;QACJ;;;;;;;;;;;;;;;;;;WAkBG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;;;;;;;;;;;;;;;WAgBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QAErB;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,UAAU,CAAC,EAAE,WAAW,CAAA;QAExB;;;;;;;;;;;;;;;;;WAiBG;QACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;QAEhC;;;;;;;;;;;;;;;;;WAiBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;WAkBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAE9C;;;;;;;;;;;;;;;WAeG;QACH,gBAAgB,CAAC,EAAE;YACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;SAEjB,CAAA;KACF,CAAA;IAED;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI;IACvD;;OAEG;IACH,aAAa,EAAE,oBAAoB,CAAA;IAEnC;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,EAAE,YAAY,CAAA;IAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,EAAE,CACL;QACE;;WAEG;QACH,OAAO,EAAE,MAAM,CAAA;QACf;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,GACD,MAAM,CACT,EAAE,CAAA;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAA;IAEtC,OAAO,CAAC,EAAE,MAAM,CACd,IAAI,EACJ,OAAO,GAAG,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC,CACzE,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAIxE,iBAAiB,EAAE,wBAAwB,CAAC,IAAI,CAAC,CAAA;IAEjD;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAA;AAED,KAAK,iCAAiC,CAAC,IAAI,GAAG,MAAM,IAAI,yBAAyB,GAAG;IAClF;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAA;IACV;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,iCAAiC,CAAC,IAAI,GAAG,MAAM,IAAI,yBAAyB,GAAG;IAClF;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAA;IACV;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,IAAI,GAAG,MAAM,IAAI,OAAO,CACrD,iCAAiC,CAAC,IAAI,CAAC,GAAG,iCAAiC,CAAC,IAAI,CAAC,CAClF,EAAE,CAAA;AAGH;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,IAAI,GAAG,MAAM,IAAI,OAAO,CAC9C,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,SAAS,CAAC,GAAG;IACxC,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACrC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAA;CAClC,CACF,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,OAAO,GAAG,SAAS,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,IAAI,GAAG,MAAM,IAAI;IACzC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAC1B,OAAO,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAA;CACnC,CAAA;AAGD,MAAM,MAAM,uBAAuB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI;IAClE,iBAAiB,EAAE,wBAAwB,CAAC,IAAI,CAAC,CAAA;IACjD,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAA;CAClC,CAAA"}

package/dist/common/modules.d.ts

@@ -1,32 +1,150 @@
 export type BaseAddressDTO = {
-    id?: string;
-    address_1: string;
-    address_2?: string | null;
-    company?: string | null;
-    country_code: string;
-    city?: string | null;
-    phone?: string | null;
-    postal_code?: string | null;
-    province?: string | null;
-    metadata?: Record<string, unknown> | null;
-    created_at?: string | Date;
-    updated_at?: string | Date;
-    deleted_at?: string | Date | null;
+    /**
+     * The ID of the customer address.
+     */
+    id: string;
+    /**
+     * The address name of the customer address.
+     */
+    address_name?: string;
+    /**
+     * Whether the customer address is default shipping.
+     */
+    is_default_shipping: boolean;
+    /**
+     * Whether the customer address is default billing.
+     */
+    is_default_billing: boolean;
+    /**
+     * The associated customer's ID.
+     */
+    customer_id: string;
+    /**
+     * The company of the customer address.
+     */
+    company?: string;
+    /**
+     * The first name of the customer address.
+     */
+    first_name?: string;
+    /**
+     * The last name of the customer address.
+     */
+    last_name?: string;
+    /**
+     * The address 1 of the customer address.
+     */
+    address_1?: string;
+    /**
+     * The address 2 of the customer address.
+     */
+    address_2?: string;
+    /**
+     * The city of the customer address.
+     */
+    city?: string;
+    /**
+     * The country code of the customer address.
+     */
+    country_code?: string;
+    /**
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the customer address.
+     */
+    province?: string;
+    /**
+     * The postal code of the customer address.
+     */
+    postal_code?: string;
+    /**
+     * The phone of the customer address.
+     */
+    phone?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The created at of the customer address.
+     */
+    created_at: string;
+    /**
+     * The updated at of the customer address.
+     */
+    updated_at: string;
 };
-export interface BaseCustomerDTO {
+export type BaseCustomerDTO = {
+    /**
+     * The ID of the customer.
+     */
     id: string;
+    /**
+     * The email of the customer.
+     */
     email: string;
+    /**
+     * A flag indicating if customer has an account or not.
+     */
     has_account: boolean;
+    /**
+     * The associated default billing address's ID.
+     */
     default_billing_address_id: string | null;
+    /**
+     * The associated default shipping address's ID.
+     */
     default_shipping_address_id: string | null;
+    /**
+     * The company name of the customer.
+     */
     company_name: string | null;
+    /**
+     * The first name of the customer.
+     */
     first_name: string | null;
+    /**
+     * The last name of the customer.
+     */
     last_name: string | null;
+    /**
+     * The addresses of the customer.
+     */
+    addresses: BaseAddressDTO[];
+    /**
+     * The phone of the customer.
+     */
     phone: string | null;
+    /**
+     * The groups of the customer.
+     */
+    groups: {
+        /**
+         * The ID of the group.
+         */
+        id: string;
+        /**
+         * The name of the group.
+         */
+        name: string;
+    }[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata: Record<string, unknown>;
+    /**
+     * Who created the customer.
+     */
     created_by: string | null;
+    /**
+     * The deletion date of the customer.
+     */
     deleted_at: Date | string | null;
+    /**
+     * The creation date of the customer.
+     */
     created_at: Date | string;
+    /**
+     * The update date of the customer.
+     */
     updated_at: Date | string;
-}
+};
 //# sourceMappingURL=modules.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../src/common/modules.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CAClC,CAAA;AAMD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,2BAA2B,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1C,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAA;IAChC,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;CAC1B"}
+{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../src/common/modules.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAA;IAE5B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAKD,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,2BAA2B,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1C;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,SAAS,EAAE,cAAc,EAAE,CAAA;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,MAAM,EAAE;QACN;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;KACb,EAAE,CAAA;IAEH;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAA;IAEhC;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;CAC1B,CAAA"}

package/dist/dal/repository-service.d.ts

@@ -39,7 +39,7 @@ export interface RepositoryService<T = any> extends BaseRepositoryService {
         entity: any;
         update: any;
     }[], context?: Context): Promise<InferRepositoryReturnType<T>[]>;
-    delete(idsOrPKs: FindOptions<T>["where"], context?: Context): Promise<void>;
+    delete(idsOrPKs: FindOptions<T>["where"], context?: Context): Promise<string[]>;
     /**
      * Soft delete entities and cascade to related entities if configured.
      *
@@ -60,7 +60,7 @@ export interface TreeRepositoryService<T = any> extends BaseRepositoryService {
     find(options?: FindOptions<T>, transformOptions?: RepositoryTransformOptions, context?: Context): Promise<InferRepositoryReturnType<T>[]>;
     findAndCount(options?: FindOptions<T>, transformOptions?: RepositoryTransformOptions, context?: Context): Promise<[InferRepositoryReturnType<T>[], number]>;
     create(data: unknown[], context?: Context): Promise<InferRepositoryReturnType<T>[]>;
-    delete(ids: string[], context?: Context): Promise<void>;
+    delete(ids: string[], context?: Context): Promise<string[]>;
 }
 /**
  * @interface

package/dist/dal/repository-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"repository-service.d.ts","sourceRoot":"","sources":["../../src/dal/repository-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,WAAW,IAAI,mBAAmB,EAClC,WAAW,EACX,uBAAuB,EACxB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAEhD,KAAK,eAAe,GAAG,MAAM,CAAA;AAC7B,KAAK,YAAY,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,EAAE,CAAA;AAEpC;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GACrE,WAAW,CAAC,CAAC,CAAC,GACd,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;AAE/B,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;IAC9C,OAAO,EAAE,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;IAC9C,OAAO,EAAE,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;CAC/C,CAAA;AAED;;;;GAIG;AACH,UAAU,qBAAqB;IAC7B,WAAW,CAAC,QAAQ,GAAG,OAAO,EAC5B,IAAI,EAAE,CAAC,kBAAkB,EAAE,QAAQ,KAAK,OAAO,CAAC,GAAG,CAAC,EACpD,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,WAAW,CAAC,EAAE,QAAQ,CAAA;QACtB,wBAAwB,CAAC,EAAE,OAAO,CAAA;KACnC,GACA,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf,eAAe,CAAC,QAAQ,GAAG,OAAO,KAAK,QAAQ,CAAA;IAE/C,gBAAgB,CAAC,QAAQ,GAAG,OAAO,KAAK,QAAQ,CAAA;IAEhD,SAAS,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,EAAE,EACzC,IAAI,EAAE,GAAG,EACT,OAAO,CAAC,EAAE,GAAG,GACZ,OAAO,CAAC,OAAO,CAAC,CAAA;CACpB;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,qBAAqB;IACvE,IAAI,CACF,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,YAAY,CACV,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEpD,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,MAAM,CACJ,IAAI,EAAE;QAAE,MAAM,MAAC;QAAC,MAAM,MAAA;KAAE,EAAE,EAC1B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3E;;;;;;;OAOG;IACH,UAAU,CACR,WAAW,EACP,MAAM,GACN,MAAM,EAAE,GACR,mBAAmB,GACnB,mBAAmB,EAAE,EACzB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEvE,OAAO,CACL,WAAW,EAAE,MAAM,EAAE,GAAG,mBAAmB,EAC3C,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEvE,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,iBAAiB,CACf,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,CAAC,EAAE,uBAAuB,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,EAC9D,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC;QACT,QAAQ,EAAE,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAA;QACxC,gBAAgB,EAAE,gBAAgB,CAAA;KACnC,CAAC,CAAA;CACH;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,qBAAqB;IAC3E,IAAI,CACF,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,gBAAgB,CAAC,EAAE,0BAA0B,EAC7C,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,YAAY,CACV,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,gBAAgB,CAAC,EAAE,0BAA0B,EAC7C,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEpD,MAAM,CACJ,IAAI,EAAE,OAAO,EAAE,EACf,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACxD;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,uBAAuB,GAAG,MAAM,IAAI;IAC/D;;OAEG;IACH,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAA;CAC/C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,uBAAuB,GAAG,MAAM,IAAI;IAC5D;;OAEG;IACH,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAA;CAC/C,CAAA"}
+{"version":3,"file":"repository-service.d.ts","sourceRoot":"","sources":["../../src/dal/repository-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,WAAW,IAAI,mBAAmB,EAClC,WAAW,EACX,uBAAuB,EACxB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAEhD,KAAK,eAAe,GAAG,MAAM,CAAA;AAC7B,KAAK,YAAY,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,EAAE,CAAA;AAEpC;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GACrE,WAAW,CAAC,CAAC,CAAC,GACd,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;AAE/B,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;IAC9C,OAAO,EAAE,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;IAC9C,OAAO,EAAE,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;CAC/C,CAAA;AAED;;;;GAIG;AACH,UAAU,qBAAqB;IAC7B,WAAW,CAAC,QAAQ,GAAG,OAAO,EAC5B,IAAI,EAAE,CAAC,kBAAkB,EAAE,QAAQ,KAAK,OAAO,CAAC,GAAG,CAAC,EACpD,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,WAAW,CAAC,EAAE,QAAQ,CAAA;QACtB,wBAAwB,CAAC,EAAE,OAAO,CAAA;KACnC,GACA,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf,eAAe,CAAC,QAAQ,GAAG,OAAO,KAAK,QAAQ,CAAA;IAE/C,gBAAgB,CAAC,QAAQ,GAAG,OAAO,KAAK,QAAQ,CAAA;IAEhD,SAAS,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,EAAE,EACzC,IAAI,EAAE,GAAG,EACT,OAAO,CAAC,EAAE,GAAG,GACZ,OAAO,CAAC,OAAO,CAAC,CAAA;CACpB;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,qBAAqB;IACvE,IAAI,CACF,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,YAAY,CACV,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEpD,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,MAAM,CACJ,IAAI,EAAE;QAAE,MAAM,MAAC;QAAC,MAAM,MAAA;KAAE,EAAE,EAC1B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,MAAM,CACJ,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAEpB;;;;;;;OAOG;IACH,UAAU,CACR,WAAW,EACP,MAAM,GACN,MAAM,EAAE,GACR,mBAAmB,GACnB,mBAAmB,EAAE,EACzB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEvE,OAAO,CACL,WAAW,EAAE,MAAM,EAAE,GAAG,mBAAmB,EAC3C,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEvE,MAAM,CACJ,IAAI,EAAE,GAAG,EAAE,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,iBAAiB,CACf,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,CAAC,EAAE,uBAAuB,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,EAC9D,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC;QACT,QAAQ,EAAE,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAA;QACxC,gBAAgB,EAAE,gBAAgB,CAAA;KACnC,CAAC,CAAA;CACH;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,qBAAqB;IAC3E,IAAI,CACF,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,gBAAgB,CAAC,EAAE,0BAA0B,EAC7C,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,YAAY,CACV,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,gBAAgB,CAAC,EAAE,0BAA0B,EAC7C,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEpD,MAAM,CACJ,IAAI,EAAE,OAAO,EAAE,EACf,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;CAC5D;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,uBAAuB,GAAG,MAAM,IAAI;IAC/D;;OAEG;IACH,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAA;CAC/C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,uBAAuB,GAAG,MAAM,IAAI;IAC5D;;OAEG;IACH,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAA;CAC/C,CAAA"}

package/dist/dml/index.d.ts

@@ -138,6 +138,13 @@ export type InferManyToManyFields<Relation> = InferHasManyFields<Relation>;
 export type InferSchemaFields<Schema extends DMLSchema> = Prettify<{
     [K in keyof Schema]: Schema[K] extends RelationshipType<any> ? Schema[K]["type"] extends "belongsTo" ? InferBelongsToFields<Schema[K]["$dataType"]> : Schema[K]["type"] extends "hasOne" | "hasOneWithFK" ? InferHasOneFields<Schema[K]["$dataType"]> : Schema[K]["type"] extends "hasMany" ? InferHasManyFields<Schema[K]["$dataType"]> : Schema[K]["type"] extends "manyToMany" ? InferManyToManyFields<Schema[K]["$dataType"]> : never : Schema[K]["$dataType"];
 } & InferForeignKeys<Schema>>;
+/**
+ * Infers the types of the schema fields from the DML entity
+ * for module services
+ */
+export type InferSchemaFieldsForModuleServices<Schema extends DMLSchema> = Prettify<{
+    [K in keyof Schema]: Schema[K] extends RelationshipType<any> ? Schema[K]["type"] extends "belongsTo" ? string : Schema[K]["type"] extends "hasOne" | "hasOneWithFK" ? string : Schema[K]["type"] extends "hasMany" ? string[] : Schema[K]["type"] extends "manyToMany" ? string[] : never : Schema[K]["$dataType"];
+} & InferForeignKeys<Schema>>;
 /**
  * Infers the schema properties without the relationships
  */
@@ -158,6 +165,7 @@ export type ExtractEntityRelations<Schema extends Record<string, any>, OfType ex
  * Helper to infer the schema type of a DmlEntity
  */
 export type Infer<T> = T extends IDmlEntity<infer Schema, any> ? EntityConstructor<InferSchemaFields<Schema>> : never;
+export type InferEntityForModuleService<T> = T extends IDmlEntity<infer Schema, any> ? InferSchemaFieldsForModuleServices<Schema> : never;
 /**
  * The actions to cascade from a given entity to its
  * relationship.

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dml/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AAE/C;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAC5B,MAAM,EACN,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAC1C,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAE5E,MAAM,MAAM,4BAA4B,CAAC,OAAO,SAAS,gBAAgB,IACvE,OAAO,SAAS,MAAM,GAClB,SAAS,CAAC,OAAO,CAAC,GAClB,OAAO,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAC1B,OAAO,SAAS;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GACrC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAC/B,KAAK,CAAA;AAEX;;GAEG;AACH,MAAM,WAAW,UAAU,CACzB,MAAM,SAAS,SAAS,EACxB,MAAM,SAAS,gBAAgB;IAE/B,IAAI,EAAE,4BAA4B,CAAC,MAAM,CAAC,CAAA;IAC1C,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,OAAO,GACP,QAAQ,GACR,UAAU,GACV,OAAO,GACP,MAAM,GACN,IAAI,GACJ,QAAQ,CAAA;AAEZ;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,cAAc,GACd,SAAS,GACT,WAAW,GACX,YAAY,CAAA;AAEhB;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,GAC3E,IAAI,GACJ,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,GAAG,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE;QACR,IAAI,EAAE,cAAc,CAAA;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAA;IACD,OAAO,EAAE;QACP,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAA;KACzB,EAAE,CAAA;IACH,aAAa,EAAE,oBAAoB,EAAE,CAAA;IACrC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;IAC5B,SAAS,EAAE,CAAC,CAAA;IACZ,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAC3C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAEvB;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,iBAAiB,CAAA;IACvB,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,OAAO,CAAA;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;IAChC,SAAS,EAAE,CAAC,CAAA;IACZ,IAAI,EAAE,iBAAiB,CAAA;IACvB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,oBAAoB,CAAA;CACtD,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,KAAK,CAAE,SAAQ,QAAQ;IACxD,QAAQ,KAAK,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,SAAS,IAAI;KACtD,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,WAAW,EAAE,IAAI,CAAA;KAAE,GACzD,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,eAAe,EAAE,GAAG,MAAM,MAAM,EAAE,CAAA;KAAE,GACtD,GAAG,MAAM,GAAG,MAAM,EAAE,GACpB,GAAG,CAAC,GAAG,MAAM,KAAK,GACpB,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,WAAW,EAAE,IAAI,CAAA;KAAE,GAC/C,IAAI,SAAS,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GACjC,MAAM,GAAG,IAAI,GACb,MAAM,GACR,KAAK;CACV,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,QAAQ,IAAI,QAAQ,SAAS,MAAM,UAAU,CAC5E,MAAM,CAAC,EACP,GAAG,CACJ,GACG,iBAAiB,CAAC,CAAC,CAAC,GACpB,QAAQ,SAAS,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,GACtD,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI,GAC3B,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,QAAQ,IAAI,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AAExE;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,IAAI,QAAQ,SAAS,MAAM,UAAU,CAC1E,MAAM,CAAC,EACP,GAAG,CACJ,GACG,iBAAiB,CAAC,CAAC,CAAC,EAAE,GACtB,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,QAAQ,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAA;AAE1E;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,SAAS,IAAI,QAAQ,CAChE;KACG,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,GACxD,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,WAAW,GACnC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAC5C,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,QAAQ,GAAG,cAAc,GACnD,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GACzC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,SAAS,GACnC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAC1C,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,YAAY,GACtC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAC7C,KAAK,GACP,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;CAC3B,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,MAAM,SAAS,SAAS,IAAI,QAAQ,CACpE;KACG,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,IAAI,CAAA;KAAE,GACxD,IAAI,SAAS,iBAAiB,GAC5B,KAAK,GACL,CAAC,GACH,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;CAC/B,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAChC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAClC,MAAM,SAAS,iBAAiB,IAC9B;KACD,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,GACjE,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAChC,CAAC,GACD,KAAK,GACP,KAAK;CACV,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;AAE1B;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,MAAM,MAAM,EAAE,GAAG,CAAC,GAC1D,iBAAiB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAC5C,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,sBAAsB,EAAE,uBAAuB,IAAI;IAC5E;;;OAGG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAA;IAC/B,MAAM,CAAC,EAAE,uBAAuB,CAAA;CACjC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAEhF;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GAC3D,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,CAAA;AAEL;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,MAAM,SAAS,SAAS,IAC3D,MAAM,qBAAqB,CAAC,MAAM,CAAC,CAAA;AAErC;;;GAGG;AACH,MAAM,MAAM,+BAA+B,CAAC,MAAM,SAAS,SAAS,IAAI;KACrE,CAAC,IAAI,MAAM,qBAAqB,CAAC,MAAM,CAAC,GAAG,MAAM;CACnD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,MAAM,SAAS,SAAS,IAChD,CAAC,CAAC,OAAO,EAAE,+BAA+B,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,GAC9D;IACE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EACP,MAAM,GACN,CAAC,CAAC,OAAO,EAAE,+BAA+B,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,CAAA;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAEL,MAAM,MAAM,WAAW,CACrB,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,KAAK,GAAG,MAAM,IACZ;IACF;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,EAAE,EAAE,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAA;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;AAC/D,MAAM,MAAM,YAAY,GAAG;IAAE,GAAG,EAAE,gBAAgB,CAAA;CAAE,CAAA;AACpD,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,YAAY,CAAA;AAExD,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;KAC3D,CAAC,IAAI,MAAM,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAC3D,UAAU,GACV,cAAc,CAAC,CAAC,CAAC;CACtB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dml/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AAE/C;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAC5B,MAAM,EACN,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAC1C,CAAA;AAED,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN;IACE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAEL,MAAM,MAAM,4BAA4B,CAAC,OAAO,SAAS,gBAAgB,IACvE,OAAO,SAAS,MAAM,GAClB,SAAS,CAAC,OAAO,CAAC,GAClB,OAAO,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAC1B,OAAO,SAAS;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GACrC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAC/B,KAAK,CAAA;AAEX;;GAEG;AACH,MAAM,WAAW,UAAU,CACzB,MAAM,SAAS,SAAS,EACxB,MAAM,SAAS,gBAAgB;IAE/B,IAAI,EAAE,4BAA4B,CAAC,MAAM,CAAC,CAAA;IAC1C,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,OAAO,GACP,QAAQ,GACR,UAAU,GACV,OAAO,GACP,MAAM,GACN,IAAI,GACJ,QAAQ,CAAA;AAEZ;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,cAAc,GACd,SAAS,GACT,WAAW,GACX,YAAY,CAAA;AAEhB;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,GAC3E,IAAI,GACJ,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,GAAG,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE;QACR,IAAI,EAAE,cAAc,CAAA;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAA;IACD,OAAO,EAAE;QACP,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAA;KACzB,EAAE,CAAA;IACH,aAAa,EAAE,oBAAoB,EAAE,CAAA;IACrC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;IAC5B,SAAS,EAAE,CAAC,CAAA;IACZ,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAC3C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAEvB;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,iBAAiB,CAAA;IACvB,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,OAAO,CAAA;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;IAChC,SAAS,EAAE,CAAC,CAAA;IACZ,IAAI,EAAE,iBAAiB,CAAA;IACvB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,oBAAoB,CAAA;CACtD,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,KAAK,CAAE,SAAQ,QAAQ;IACxD,QAAQ,KAAK,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,SAAS,IAAI;KACtD,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,WAAW,EAAE,IAAI,CAAA;KAAE,GACzD,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,eAAe,EAAE,GAAG,MAAM,MAAM,EAAE,CAAA;KAAE,GACtD,GAAG,MAAM,GAAG,MAAM,EAAE,GACpB,GAAG,CAAC,GAAG,MAAM,KAAK,GACpB,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,WAAW,EAAE,IAAI,CAAA;KAAE,GAC/C,IAAI,SAAS,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GACjC,MAAM,GAAG,IAAI,GACb,MAAM,GACR,KAAK;CACV,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,QAAQ,IAAI,QAAQ,SAAS,MAAM,UAAU,CAC5E,MAAM,CAAC,EACP,GAAG,CACJ,GACG,iBAAiB,CAAC,CAAC,CAAC,GACpB,QAAQ,SAAS,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,GACtD,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI,GAC3B,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,QAAQ,IAAI,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AAExE;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,IAAI,QAAQ,SAAS,MAAM,UAAU,CAC1E,MAAM,CAAC,EACP,GAAG,CACJ,GACG,iBAAiB,CAAC,CAAC,CAAC,EAAE,GACtB,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,QAAQ,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAA;AAE1E;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,SAAS,IAAI,QAAQ,CAChE;KACG,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,GACxD,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,WAAW,GACnC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAC5C,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,QAAQ,GAAG,cAAc,GACnD,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GACzC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,SAAS,GACnC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAC1C,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,YAAY,GACtC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAC7C,KAAK,GACP,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;CAC3B,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAC7B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kCAAkC,CAAC,MAAM,SAAS,SAAS,IACrE,QAAQ,CACN;KACG,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,GACxD,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,WAAW,GACnC,MAAM,GACN,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,QAAQ,GAAG,cAAc,GACnD,MAAM,GACN,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,SAAS,GACnC,MAAM,EAAE,GACR,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,YAAY,GACtC,MAAM,EAAE,GACV,KAAK,GACP,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;CAC3B,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,MAAM,SAAS,SAAS,IAAI,QAAQ,CACpE;KACG,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,IAAI,CAAA;KAAE,GACxD,IAAI,SAAS,iBAAiB,GAC5B,KAAK,GACL,CAAC,GACH,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;CAC/B,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAChC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAClC,MAAM,SAAS,iBAAiB,IAC9B;KACD,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,GACjE,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAChC,CAAC,GACD,KAAK,GACP,KAAK;CACV,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;AAE1B;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,MAAM,MAAM,EAAE,GAAG,CAAC,GAC1D,iBAAiB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAC5C,KAAK,CAAA;AAET,MAAM,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAC/D,MAAM,MAAM,EACZ,GAAG,CACJ,GACG,kCAAkC,CAAC,MAAM,CAAC,GAC1C,KAAK,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,sBAAsB,EAAE,uBAAuB,IAAI;IAC5E;;;OAGG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAA;IAC/B,MAAM,CAAC,EAAE,uBAAuB,CAAA;CACjC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAEhF;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GAC3D,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,CAAA;AAEL;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,MAAM,SAAS,SAAS,IAC3D,MAAM,qBAAqB,CAAC,MAAM,CAAC,CAAA;AAErC;;;GAGG;AACH,MAAM,MAAM,+BAA+B,CAAC,MAAM,SAAS,SAAS,IAAI;KACrE,CAAC,IAAI,MAAM,qBAAqB,CAAC,MAAM,CAAC,GAAG,MAAM;CACnD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,MAAM,SAAS,SAAS,IAChD,CAAC,CAAC,OAAO,EAAE,+BAA+B,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,GAC9D;IACE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EACP,MAAM,GACN,CAAC,CAAC,OAAO,EAAE,+BAA+B,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,CAAA;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAEL,MAAM,MAAM,WAAW,CACrB,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,KAAK,GAAG,MAAM,IACZ;IACF;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,EAAE,EAAE,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAA;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;AAC/D,MAAM,MAAM,YAAY,GAAG;IAAE,GAAG,EAAE,gBAAgB,CAAA;CAAE,CAAA;AACpD,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,YAAY,CAAA;AAExD,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;KAC3D,CAAC,IAAI,MAAM,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAC3D,UAAU,GACV,cAAc,CAAC,CAAC,CAAC;CACtB,CAAA"}

package/dist/event-bus/common.d.ts

@@ -1,6 +1,9 @@
 import { Context } from "../shared-context";
 export type Subscriber<TData = unknown> = (data: Event<TData>) => Promise<void>;
 export type SubscriberContext = {
+    /**
+     * The ID of the subscriber. Useful when retrying failed subscribers.
+     */
     subscriberId: string;
 };
 export type SubscriberDescriptor = {
@@ -8,13 +11,34 @@ export type SubscriberDescriptor = {
     subscriber: Subscriber;
 };
 export type EventMetadata = Record<string, unknown> & {
+    /**
+     * The ID of the event's group. Grouped events are useful when you have distributed transactions
+     * where you need to explicitly group, release and clear events upon lifecycle events of a transaction.
+     *
+     * When set, you must release the grouped events using the Event Module's `releaseGroupedEvents` method to emit the events.
+     */
     eventGroupId?: string;
 };
 export type Event<TData = unknown> = {
+    /**
+     * The event's name.
+     *
+     * @example
+     * user.created
+     */
     name: string;
+    /**
+     * Additional meadata to pass with the event.
+     */
     metadata?: EventMetadata;
+    /**
+     * The data payload that subscribers receive. For example, the ID or IDs of the created user. (e.g. { id: "123" } or { ids: ["123", "456"] })
+     */
     data: TData;
 };
+/**
+ * The details of an event to emit.
+ */
 export type Message<TData = unknown> = Event<TData> & {
     options?: Record<string, unknown>;
 };

package/dist/event-bus/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/event-bus/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE3C,MAAM,MAAM,UAAU,CAAC,KAAK,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAE/E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACpD,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,KAAK,CAAC,KAAK,GAAG,OAAO,IAAI;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,OAAO,CAAC,KAAK,GAAG,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,GAAG,IAAI;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAA;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B,CAAA"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/event-bus/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE3C,MAAM,MAAM,UAAU,CAAC,KAAK,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAE/E,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACpD;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,KAAK,CAAC,KAAK,GAAG,OAAO,IAAI;IACnC;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,GAAG,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,GAAG,IAAI;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAA;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B,CAAA"}

package/dist/event-bus/event-bus-module.d.ts

@@ -1,9 +1,67 @@
 import { Message, Subscriber, SubscriberContext } from "./common";
 export interface IEventBusModuleService {
+    /**
+     * This method emits one or more events. Subscribers listening to the event(s) are executed asynchronously.
+     *
+     * @param data - The details of the events to emit.
+     * @param options - Additional options for the event.
+     *
+     * @example
+     * await eventModuleService.emit({
+     *   name: "user.created",
+     *   data: {
+     *     user_id: "user_123"
+     *   }
+     * })
+     */
     emit<T>(data: Message<T> | Message<T>[], options?: Record<string, unknown>): Promise<void>;
+    /**
+     * This method adds a subscriber to an event. It's mainly used internally to register subscribers.
+     *
+     * @param eventName - The name of the event to subscribe to.
+     * @param subscriber - The subscriber function to execute when the event is emitted.
+     * @param context - The context of the subscriber.
+     * @returns The instance of the Event Module
+     *
+     * @example
+     * eventModuleService.subscribe("user.created", async (data) => {
+     *   console.log("User created", data)
+     * })
+     */
     subscribe(eventName: string | symbol, subscriber: Subscriber, context?: SubscriberContext): this;
+    /**
+     * This method removes a subscriber from an event. It's mainly used internally to unregister subscribers.
+     *
+     * @param eventName - The name of the event to unsubscribe from.
+     * @param subscriber - The subscriber function to remove.
+     * @param context - The context of the subscriber.
+     * @returns The instance of the Event Module
+     *
+     * @example
+     * eventModuleService.unsubscribe("user.created", async (data) => {
+     *   console.log("User created", data)
+     * })
+     */
     unsubscribe(eventName: string | symbol, subscriber: Subscriber, context?: SubscriberContext): this;
+    /**
+     * This method emits all events in the specified group. Grouped events are useful when you have distributed transactions
+     * where you need to explicitly group, release and clear events upon lifecycle events of a transaction.
+     *
+     * @param eventGroupId - The ID of the event group.
+     *
+     * @example
+     * await eventModuleService.releaseGroupedEvents("group_123")
+     */
     releaseGroupedEvents(eventGroupId: string): Promise<void>;
+    /**
+     * This method removes all events in the specified group. Grouped events are useful when you have distributed transactions
+     * where you need to explicitly group, release and clear events upon lifecycle events of a transaction.
+     *
+     * @param eventGroupId - The ID of the event group.
+     *
+     * @example
+     * await eventModuleService.clearGroupedEvents("group_123")
+     */
     clearGroupedEvents(eventGroupId: string): Promise<void>;
 }
 //# sourceMappingURL=event-bus-module.d.ts.map

package/dist/event-bus/event-bus-module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-bus-module.d.ts","sourceRoot":"","sources":["../../src/event-bus/event-bus-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAEjE,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,CAAC,EACJ,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,SAAS,CACP,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,CAAA;IAEP,WAAW,CACT,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,CAAA;IAEP,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzD,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACxD"}
+{"version":3,"file":"event-bus-module.d.ts","sourceRoot":"","sources":["../../src/event-bus/event-bus-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAEjE,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,CAAC,EACJ,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;OAYG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,CAAA;IAEP;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,CAAA;IAEP;;;;;;;;OAQG;IACH,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzD;;;;;;;;OAQG;IACH,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACxD"}

package/dist/file/common.d.ts

@@ -1,13 +1,18 @@
+/**
+ * The access level of the file.
+ */
+export type FileAccessPermission = "public" | "private";
 /**
  * The File details.
  */
 export interface FileDTO {
     /**
-     * The ID of the File.
+     * The ID of the file. You can use this ID later to
+     * retrieve or delete the file.
      */
     id: string;
     /**
-     * The URL of the File.
+     * The URL of the file.
      */
     url: string;
 }
@@ -22,4 +27,19 @@ export interface FilterableFileProps {
      */
     id?: string;
 }
+export interface UploadFileUrlDTO {
+    /**
+     * The URL of the file.
+     */
+    url: string;
+    /**
+     * The file's key allowing you to later
+     * identify the file in the third-party
+     * system. For example, the S3 Module Provider
+     * returns the file's key in S3, whereas the
+     * Local File Module Provider returns the file's
+     * path.
+     */
+    key: string;
+}
 //# sourceMappingURL=common.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/file/common.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/file/common.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;;;;;OAOG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ"}

package/dist/file/mutations.d.ts

@@ -1,22 +1,40 @@
+import { FileAccessPermission } from "./common";
 /**
  * The File to be created.
  */
 export interface CreateFileDTO {
     /**
-     * The filename of the uploaded file
+     * The name of the uploaded file
      */
     filename: string;
     /**
      * The mimetype of the uploaded file
+     *
+     * @example
+     * image/png
      */
     mimeType: string;
     /**
-     * The file content as a binary-encoded string
+     * The file content as a binary-encoded string.
      */
     content: string;
     /**
      * The access level of the file. Defaults to private if not passed
      */
-    access?: "public" | "private";
+    access?: FileAccessPermission;
+}
+export interface GetUploadFileUrlDTO {
+    /**
+     * The name of the file to be uploaded
+     */
+    filename: string;
+    /**
+     * The mimetype of the file to be uploaded
+     */
+    mimeType?: string;
+    /**
+     * The access level of the file to be uploaded. Defaults to private if not passed
+     */
+    access?: FileAccessPermission;
 }
 //# sourceMappingURL=mutations.d.ts.map

package/dist/file/mutations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/file/mutations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;CAC9B"}
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/file/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B"}

package/dist/file/provider.d.ts

@@ -1,3 +1,5 @@
+import { Readable } from "stream";
+import { FileAccessPermission } from "./common";
 /**
  * @interface
  *
@@ -5,11 +7,17 @@
  */
 export type ProviderFileResultDTO = {
     /**
-     * The file's URL.
+     * The file's URL that users or systems
+     * can use to access the file.
      */
     url: string;
     /**
-     * The file's key.
+     * The file's key allowing you to later
+     * identify the file in the third-party
+     * system. For example, the S3 Module Provider
+     * returns the file's key in S3, whereas the
+     * Local File Module Provider returns the file's
+     * path.
      */
     key: string;
 };
@@ -20,7 +28,12 @@ export type ProviderFileResultDTO = {
  */
 export type ProviderGetFileDTO = {
     /**
-     * The file's key.
+     * The file's key allowing you to later
+     * identify the file in the third-party
+     * system. For example, the S3 Module Provider
+     * returns the file's key in S3, whereas the
+     * Local File Module Provider returns the file's
+     * path.
      */
     fileKey: string;
     [x: string]: unknown;
@@ -59,7 +72,30 @@ export type ProviderUploadFileDTO = {
     /**
      * The access level of the file. Defaults to private if not passed
      */
-    access?: "public" | "private";
+    access?: FileAccessPermission;
+};
+/**
+ * @interface
+ *
+ * The details of the file to get a presigned upload URL for.
+ */
+export type ProviderGetPresignedUploadUrlDTO = {
+    /**
+     * The filename of the file to get a presigned upload URL for.
+     */
+    filename: string;
+    /**
+     * The mimetype of the file to get a presigned upload URL for.
+     */
+    mimeType?: string;
+    /**
+     * The access level of the file to get a presigned upload URL for.
+     */
+    access?: FileAccessPermission;
+    /**
+     * The validity of the presigned upload URL in seconds.
+     */
+    expiresIn?: number;
 };
 export interface IFileProvider {
     /**
@@ -72,13 +108,13 @@ export interface IFileProvider {
      */
     upload(file: ProviderUploadFileDTO): Promise<ProviderFileResultDTO>;
     /**
-     * This method is used to delete a file from storage.
+     * This method is used to delete one or more files from the storage
      *
-     * @param {ProviderDeleteFileDTO} fileData - The details of the file to remove.
+     * @param {ProviderDeleteFileDTO | ProviderDeleteFileDTO[]} fileData - The details of the files to remove.
      * @returns {Promise<void>} Resolves when the file is deleted successfully.
      *
      */
-    delete(fileData: ProviderDeleteFileDTO): Promise<void>;
+    delete(fileData: ProviderDeleteFileDTO | ProviderDeleteFileDTO[]): Promise<void>;
     /**
      * This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file.
      *
@@ -89,5 +125,37 @@ export interface IFileProvider {
      *
      */
     getPresignedDownloadUrl(fileData: ProviderGetFileDTO): Promise<string>;
+    /**
+     * This method is used to get a presigned upload URL for a file. For some providers,
+     * such as S3, a presigned URL indicates a temporary URL to get upload a file.
+     *
+     * If your provider doesn’t perform or offer a similar functionality, you don't have to
+     * implement this method. Instead, an error is thrown when the method is called.
+     *
+     * @param {ProviderGetPresignedUploadUrlDTO} fileData - The details of the file to get a presigned upload URL for.
+     * @returns {Promise<ProviderFileResultDTO>} The presigned URL and file key to upload the file to
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   // ...
+     *   async getPresignedUploadUrl(
+     *     fileData: ProviderGetPresignedUploadUrlDTO
+     *   ): Promise<ProviderFileResultDTO> {
+     *     // TODO logic to get the presigned upload URL
+     *     // for example:
+     *     return this.client.getPresignedUploadUrl(fileData.filename, fileData.mimeType)
+     *   }
+     * }
+     *
+     */
+    getPresignedUploadUrl?(fileData: ProviderGetPresignedUploadUrlDTO): Promise<ProviderFileResultDTO>;
+    /**
+     * Get the file contents as a readable stream.
+     */
+    getDownloadStream(fileData: ProviderGetFileDTO): Promise<Readable>;
+    /**
+     * Get the file contents as a Node.js Buffer
+     */
+    getAsBuffer(fileData: ProviderGetFileDTO): Promise<Buffer>;
 }
 //# sourceMappingURL=provider.d.ts.map