@medusajs/types 1.12.0-preview-20240702060633 → 1.12.0-preview-20240702090445

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,5 +1,16 @@
1
+ /**
2
+ * Symbol to identify a DML entity from an object
3
+ */
1
4
  export declare const IsDmlEntity: unique symbol;
5
+ /**
6
+ * Representation of DML schema. It must be a key-value pair
7
+ * with string based keys and properties/relationships
8
+ * as the value.
9
+ */
2
10
  export type DMLSchema = Record<string, PropertyType<any> | RelationshipType<any>>;
11
+ /**
12
+ * Representation of a DML entity
13
+ */
3
14
  export interface IDmlEntity<Schema extends DMLSchema> {
4
15
  [IsDmlEntity]: true;
5
16
  schema: Schema;
@@ -43,9 +54,9 @@ export type PropertyType<T> = {
43
54
  */
44
55
  export type RelationshipOptions = {
45
56
  /**
46
- * The name of the relationship as defined
47
- * in the other data model. This is only required
48
- * by the `belongsTo` relationship method.
57
+ * The name of the relationship as defined in the other
58
+ * data model. This is only required by the `belongsTo`
59
+ * relationship method.
49
60
  */
50
61
  mappedBy?: string;
51
62
  } & Record<string, any>;
@@ -80,7 +91,8 @@ export interface EntityConstructor<Props> extends Function {
80
91
  new (): Props;
81
92
  }
82
93
  /**
83
- * From a IDmlEntity, infer the foreign keys name and type for belongsTo relation meaning hasOne and ManyToOne
94
+ * From a IDmlEntity, infer the foreign keys name and type for
95
+ * "belongsTo" relation meaning "hasOne" and "ManyToOne"
84
96
  */
85
97
  export type InferForeignKeys<T> = T extends IDmlEntity<infer Schema> ? {
86
98
  [K in keyof Schema as Schema[K] extends {
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dml/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,eAA4B,CAAA;AAEpD,MAAM,MAAM,SAAS,GAAG,MAAM,CAC5B,MAAM,EACN,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAC1C,CAAA;AAED,MAAM,WAAW,UAAU,CAAC,MAAM,SAAS,SAAS;IAClD,CAAC,WAAW,CAAC,EAAE,IAAI,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,UAAU,GACV,OAAO,GACP,MAAM,GACN,IAAI,CAAA;AAER;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,SAAS,GACT,WAAW,GACX,YAAY,CAAA;AAEhB;;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;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;CACtC,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,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,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;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,MAAM,MAAM,CAAC,GAChE;KACG,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,IAAI,CAAA;KAAE,GACxD,IAAI,SAAS,iBAAiB,GAC5B,GAAG,CAAC,GAAG,MAAM,KAAK,GAClB,CAAC,GACH,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,IAAI,CAAA;KAAE,GAC1C,IAAI,SAAS,iBAAiB,GAC5B,MAAM,GACN,MAAM,CAAC,CAAC,CAAC,GACX,MAAM,CAAC,CAAC,CAAC;CACd,GACD,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,MAAM,MAAM,CAAC,GACrD,iBAAiB,CACf;KACG,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,MAAM,MAAM,CAAC,GAC7D,KAAK,CAAC,CAAC,CAAC,GACR,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,MAAM,MAAM,CAAC,CAAC,GAAG,IAAI,GACrD,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,GACf,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;CAC3B,GAAG,gBAAgB,CAAC,CAAC,CAAC,CACxB,GACD,KAAK,CAAA;AAET;;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;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,aAAa,IAAI;IAC1C;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE3E;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,GAClE,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,CAAA;AAEL;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,SAAS,UAAU,CACnE,MAAM,MAAM,CACb,GACG;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;CACf,GAAG,gBAAgB,CAAC,CAAC,CAAC,GACvB,KAAK,CAAC,CAAA;AAEV,MAAM,MAAM,WAAW,CACrB,OAAO,SAAS,SAAS,GAAG,SAAS,EACrC,MAAM,GAAG,MAAM,IACb;IACF;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,EAAE,EAAE,wBAAwB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAAA;IACnD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,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,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACtD,UAAU,GACV,cAAc,CAAC,CAAC,CAAC;CACtB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dml/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,WAAW,eAA4B,CAAA;AAEpD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAC5B,MAAM,EACN,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAC1C,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,MAAM,SAAS,SAAS;IAClD,CAAC,WAAW,CAAC,EAAE,IAAI,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,UAAU,GACV,OAAO,GACP,MAAM,GACN,IAAI,CAAA;AAER;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,SAAS,GACT,WAAW,GACX,YAAY,CAAA;AAEhB;;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;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;CACtC,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,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,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,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,MAAM,MAAM,CAAC,GAChE;KACG,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,IAAI,CAAA;KAAE,GACxD,IAAI,SAAS,iBAAiB,GAC5B,GAAG,CAAC,GAAG,MAAM,KAAK,GAClB,CAAC,GACH,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,IAAI,CAAA;KAAE,GAC1C,IAAI,SAAS,iBAAiB,GAC5B,MAAM,GACN,MAAM,CAAC,CAAC,CAAC,GACX,MAAM,CAAC,CAAC,CAAC;CACd,GACD,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,CAAC,MAAM,MAAM,CAAC,GACrD,iBAAiB,CACf;KACG,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,MAAM,MAAM,CAAC,GAC7D,KAAK,CAAC,CAAC,CAAC,GACR,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,MAAM,MAAM,CAAC,CAAC,GAAG,IAAI,GACrD,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,GACf,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;CAC3B,GAAG,gBAAgB,CAAC,CAAC,CAAC,CACxB,GACD,KAAK,CAAA;AAET;;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;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,aAAa,IAAI;IAC1C;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE3E;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,GAClE,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,CAAA;AAEL;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,SAAS,UAAU,CACnE,MAAM,MAAM,CACb,GACG;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;CACf,GAAG,gBAAgB,CAAC,CAAC,CAAC,GACvB,KAAK,CAAC,CAAA;AAEV,MAAM,MAAM,WAAW,CACrB,OAAO,SAAS,SAAS,GAAG,SAAS,EACrC,MAAM,GAAG,MAAM,IACb;IACF;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,EAAE,EAAE,wBAAwB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAAA;IACnD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,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,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACtD,UAAU,GACV,cAAc,CAAC,CAAC,CAAC;CACtB,CAAA"}
package/dist/dml/index.js CHANGED
@@ -1,5 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.IsDmlEntity = void 0;
4
+ /**
5
+ * Symbol to identify a DML entity from an object
6
+ */
4
7
  exports.IsDmlEntity = Symbol.for("isDmlEntity");
5
8
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dml/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dml/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@medusajs/types",
3
- "version": "1.12.0-preview-20240702060633",
3
+ "version": "1.12.0-preview-20240702090445",
4
4
  "description": "Medusa Types definition",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",