@webiny/db-dynamodb 6.0.0-alpha.5 → 6.0.0-rc.0

package/utils/createEntity.d.ts

@@ -1,54 +1,36 @@
-import type { AttributeDefinitions, Table } from "../toolbox";
-import { Entity } from "../toolbox";
-interface CreateStandardEntityParams {
-    table: Table<string, string, string>;
-    name: string;
-}
-export declare const createStandardEntity: (params: CreateStandardEntityParams) => Entity<any>;
-interface CreateLegacyEntityParams {
-    table: Table<string, string, string>;
-    name: string;
-    attributes?: AttributeDefinitions;
-}
-export declare const createLegacyEntity: (params: CreateLegacyEntityParams) => Entity<string, import("dynamodb-toolbox/dist/cjs/classes/Entity").Overlay, import("dynamodb-toolbox/dist/cjs/classes/Entity").Overlay, Table<string, string, string>, boolean, boolean, boolean, string, string, string, boolean, {
-    PK: {
-        partitionKey: true;
-    };
-    SK: {
-        sortKey: true;
-    };
-    GSI1_PK: {
-        type: "string";
-    };
-    GSI1_SK: {
-        type: "string";
-    };
-    TYPE: {
-        type: "string";
-    };
-}, {
-    PK: {
-        partitionKey: true;
-    };
-    SK: {
-        sortKey: true;
-    };
-    GSI1_PK: {
-        type: "string";
-    };
-    GSI1_SK: {
-        type: "string";
-    };
-    TYPE: {
-        type: "string";
-    };
-}, import("dynamodb-toolbox/dist/cjs/classes/Entity").ParsedAttributes<import("ts-toolbelt/out/Any/Key").Key>, any, {
-    [x: string]: any;
-    [x: number]: any;
-    [x: symbol]: any;
-}, {
-    [x: string]: any;
-    [x: number]: any;
-    [x: symbol]: any;
-}>;
-export {};
+import type { AttributeDefinitions } from "../toolbox.js";
+import { type EntityConstructor } from "../utils/entity/index.js";
+import type { GenericRecord } from "@webiny/api/types.js";
+export type IGlobalEntityAttributes<T = undefined> = {
+    PK: string;
+    SK: string;
+    TYPE: string;
+    GSI1_PK?: string;
+    GSI1_SK?: string;
+    GSI2_PK?: string;
+    GSI2_SK?: string;
+    expiresAt?: string | null;
+} & (T extends undefined ? {
+    data?: undefined;
+} : {
+    data: T;
+});
+export declare const globalEntityAttributes: AttributeDefinitions;
+export declare const createGlobalEntity: <T extends GenericRecord = GenericRecord>(params: Omit<EntityConstructor, "attributes"> & Partial<Pick<EntityConstructor, "attributes">>) => import("~/utils/entity/index.js").IEntity<IGlobalEntityAttributes<T>>;
+export type IStandardEntityAttributes<T = undefined> = {
+    PK: string;
+    SK: string;
+    GSI_TENANT: string;
+    TYPE: string;
+    GSI1_PK?: string;
+    GSI1_SK?: string;
+    GSI2_PK?: string;
+    GSI2_SK?: string;
+    expiresAt?: number | null;
+} & (T extends undefined ? {
+    data?: undefined;
+} : {
+    data: T;
+});
+export declare const standardEntityAttributes: AttributeDefinitions;
+export declare const createStandardEntity: <T extends GenericRecord = GenericRecord>(params: Omit<EntityConstructor, "attributes"> & Partial<Pick<EntityConstructor, "attributes">>) => import("~/utils/entity/index.js").IEntity<IStandardEntityAttributes<T>>;

package/utils/createEntity.js

@@ -1,61 +1,85 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createStandardEntity = exports.createLegacyEntity = void 0;
-var _toolbox = require("../toolbox");
-const createStandardEntity = params => {
-  return new _toolbox.Entity({
-    name: params.name,
-    table: params.table,
+import { createEntity } from "./entity/index.js";
+export const globalEntityAttributes = {
+  PK: {
+    partitionKey: true
+  },
+  SK: {
+    sortKey: true
+  },
+  GSI1_PK: {
+    type: "string"
+  },
+  GSI1_SK: {
+    type: "string"
+  },
+  GSI2_PK: {
+    type: "string"
+  },
+  GSI2_SK: {
+    type: "string"
+  },
+  TYPE: {
+    type: "string",
+    required: true
+  },
+  data: {
+    type: "map"
+  },
+  expiresAt: {
+    type: "number"
+  }
+};
+export const createGlobalEntity = params => {
+  return createEntity({
+    ...params,
     attributes: {
-      PK: {
-        partitionKey: true
-      },
-      SK: {
-        sortKey: true
-      },
-      GSI1_PK: {
-        type: "string"
-      },
-      GSI1_SK: {
-        type: "string"
-      },
-      TYPE: {
-        type: "string"
-      },
-      data: {
-        type: "map"
-      }
+      ...globalEntityAttributes,
+      ...params.attributes
     }
   });
 };
-exports.createStandardEntity = createStandardEntity;
-const createLegacyEntity = params => {
-  return new _toolbox.Entity({
-    table: params.table,
-    name: params.name,
+export const standardEntityAttributes = {
+  PK: {
+    partitionKey: true
+  },
+  SK: {
+    sortKey: true
+  },
+  GSI_TENANT: {
+    type: "string",
+    required: true
+  },
+  GSI1_PK: {
+    type: "string"
+  },
+  GSI1_SK: {
+    type: "string"
+  },
+  GSI2_PK: {
+    type: "string"
+  },
+  GSI2_SK: {
+    type: "string"
+  },
+  TYPE: {
+    type: "string",
+    required: true
+  },
+  data: {
+    type: "map"
+  },
+  expiresAt: {
+    type: "number"
+  }
+};
+export const createStandardEntity = params => {
+  return createEntity({
+    ...params,
     attributes: {
-      PK: {
-        partitionKey: true
-      },
-      SK: {
-        sortKey: true
-      },
-      GSI1_PK: {
-        type: "string"
-      },
-      GSI1_SK: {
-        type: "string"
-      },
-      TYPE: {
-        type: "string"
-      },
-      ...(params.attributes || {})
+      ...standardEntityAttributes,
+      ...params.attributes
     }
   });
 };
-exports.createLegacyEntity = createLegacyEntity;
 
 //# sourceMappingURL=createEntity.js.map

package/utils/createEntity.js.map

@@ -1 +1 @@
-{"version":3,"names":["_toolbox","require","createStandardEntity","params","Entity","name","table","attributes","PK","partitionKey","SK","sortKey","GSI1_PK","type","GSI1_SK","TYPE","data","exports","createLegacyEntity"],"sources":["createEntity.ts"],"sourcesContent":["import type { AttributeDefinitions, Table } from \"~/toolbox\";\nimport { Entity } from \"~/toolbox\";\n\ninterface CreateStandardEntityParams {\n    table: Table<string, string, string>;\n    name: string;\n}\n\nexport const createStandardEntity = (params: CreateStandardEntityParams): Entity<any> => {\n    return new Entity({\n        name: params.name,\n        table: params.table,\n        attributes: {\n            PK: {\n                partitionKey: true\n            },\n            SK: {\n                sortKey: true\n            },\n            GSI1_PK: {\n                type: \"string\"\n            },\n            GSI1_SK: {\n                type: \"string\"\n            },\n            TYPE: {\n                type: \"string\"\n            },\n            data: {\n                type: \"map\"\n            }\n        }\n    });\n};\n\ninterface CreateLegacyEntityParams {\n    table: Table<string, string, string>;\n    name: string;\n    attributes?: AttributeDefinitions;\n}\n\nexport const createLegacyEntity = (params: CreateLegacyEntityParams) => {\n    return new Entity({\n        table: params.table,\n        name: params.name,\n        attributes: {\n            PK: {\n                partitionKey: true\n            },\n            SK: {\n                sortKey: true\n            },\n            GSI1_PK: {\n                type: \"string\"\n            },\n            GSI1_SK: {\n                type: \"string\"\n            },\n            TYPE: {\n                type: \"string\"\n            },\n            ...(params.attributes || {})\n        }\n    });\n};\n"],"mappings":";;;;;;AACA,IAAAA,QAAA,GAAAC,OAAA;AAOO,MAAMC,oBAAoB,GAAIC,MAAkC,IAAkB;EACrF,OAAO,IAAIC,eAAM,CAAC;IACdC,IAAI,EAAEF,MAAM,CAACE,IAAI;IACjBC,KAAK,EAAEH,MAAM,CAACG,KAAK;IACnBC,UAAU,EAAE;MACRC,EAAE,EAAE;QACAC,YAAY,EAAE;MAClB,CAAC;MACDC,EAAE,EAAE;QACAC,OAAO,EAAE;MACb,CAAC;MACDC,OAAO,EAAE;QACLC,IAAI,EAAE;MACV,CAAC;MACDC,OAAO,EAAE;QACLD,IAAI,EAAE;MACV,CAAC;MACDE,IAAI,EAAE;QACFF,IAAI,EAAE;MACV,CAAC;MACDG,IAAI,EAAE;QACFH,IAAI,EAAE;MACV;IACJ;EACJ,CAAC,CAAC;AACN,CAAC;AAACI,OAAA,CAAAf,oBAAA,GAAAA,oBAAA;AAQK,MAAMgB,kBAAkB,GAAIf,MAAgC,IAAK;EACpE,OAAO,IAAIC,eAAM,CAAC;IACdE,KAAK,EAAEH,MAAM,CAACG,KAAK;IACnBD,IAAI,EAAEF,MAAM,CAACE,IAAI;IACjBE,UAAU,EAAE;MACRC,EAAE,EAAE;QACAC,YAAY,EAAE;MAClB,CAAC;MACDC,EAAE,EAAE;QACAC,OAAO,EAAE;MACb,CAAC;MACDC,OAAO,EAAE;QACLC,IAAI,EAAE;MACV,CAAC;MACDC,OAAO,EAAE;QACLD,IAAI,EAAE;MACV,CAAC;MACDE,IAAI,EAAE;QACFF,IAAI,EAAE;MACV,CAAC;MACD,IAAIV,MAAM,CAACI,UAAU,IAAI,CAAC,CAAC;IAC/B;EACJ,CAAC,CAAC;AACN,CAAC;AAACU,OAAA,CAAAC,kBAAA,GAAAA,kBAAA","ignoreList":[]}
+{"version":3,"names":["createEntity","globalEntityAttributes","PK","partitionKey","SK","sortKey","GSI1_PK","type","GSI1_SK","GSI2_PK","GSI2_SK","TYPE","required","data","expiresAt","createGlobalEntity","params","attributes","standardEntityAttributes","GSI_TENANT","createStandardEntity"],"sources":["createEntity.ts"],"sourcesContent":["import type { AttributeDefinitions } from \"~/toolbox.js\";\nimport { createEntity, type EntityConstructor } from \"~/utils/entity/index.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\n\nexport type IGlobalEntityAttributes<T = undefined> = {\n    PK: string;\n    SK: string;\n    TYPE: string;\n    GSI1_PK?: string;\n    GSI1_SK?: string;\n    GSI2_PK?: string;\n    GSI2_SK?: string;\n    expiresAt?: string | null;\n} & (T extends undefined ? { data?: undefined } : { data: T });\n\nexport const globalEntityAttributes: AttributeDefinitions = {\n    PK: {\n        partitionKey: true\n    },\n    SK: {\n        sortKey: true\n    },\n    GSI1_PK: {\n        type: \"string\"\n    },\n    GSI1_SK: {\n        type: \"string\"\n    },\n    GSI2_PK: {\n        type: \"string\"\n    },\n    GSI2_SK: {\n        type: \"string\"\n    },\n    TYPE: {\n        type: \"string\",\n        required: true\n    },\n    data: {\n        type: \"map\"\n    },\n    expiresAt: {\n        type: \"number\"\n    }\n};\n\nexport const createGlobalEntity = <T extends GenericRecord = GenericRecord>(\n    params: Omit<EntityConstructor, \"attributes\"> & Partial<Pick<EntityConstructor, \"attributes\">>\n) => {\n    return createEntity<IGlobalEntityAttributes<T>>({\n        ...params,\n        attributes: {\n            ...globalEntityAttributes,\n            ...params.attributes\n        }\n    });\n};\n\nexport type IStandardEntityAttributes<T = undefined> = {\n    PK: string;\n    SK: string;\n    GSI_TENANT: string;\n    TYPE: string;\n    GSI1_PK?: string;\n    GSI1_SK?: string;\n    GSI2_PK?: string;\n    GSI2_SK?: string;\n    expiresAt?: number | null;\n} & (T extends undefined ? { data?: undefined } : { data: T });\n\nexport const standardEntityAttributes: AttributeDefinitions = {\n    PK: {\n        partitionKey: true\n    },\n    SK: {\n        sortKey: true\n    },\n    GSI_TENANT: {\n        type: \"string\",\n        required: true\n    },\n    GSI1_PK: {\n        type: \"string\"\n    },\n    GSI1_SK: {\n        type: \"string\"\n    },\n    GSI2_PK: {\n        type: \"string\"\n    },\n    GSI2_SK: {\n        type: \"string\"\n    },\n    TYPE: {\n        type: \"string\",\n        required: true\n    },\n    data: {\n        type: \"map\"\n    },\n    expiresAt: {\n        type: \"number\"\n    }\n};\n\nexport const createStandardEntity = <T extends GenericRecord = GenericRecord>(\n    params: Omit<EntityConstructor, \"attributes\"> & Partial<Pick<EntityConstructor, \"attributes\">>\n) => {\n    return createEntity<IStandardEntityAttributes<T>>({\n        ...params,\n        attributes: {\n            ...standardEntityAttributes,\n            ...params.attributes\n        }\n    });\n};\n"],"mappings":"AACA,SAASA,YAAY;AAcrB,OAAO,MAAMC,sBAA4C,GAAG;EACxDC,EAAE,EAAE;IACAC,YAAY,EAAE;EAClB,CAAC;EACDC,EAAE,EAAE;IACAC,OAAO,EAAE;EACb,CAAC;EACDC,OAAO,EAAE;IACLC,IAAI,EAAE;EACV,CAAC;EACDC,OAAO,EAAE;IACLD,IAAI,EAAE;EACV,CAAC;EACDE,OAAO,EAAE;IACLF,IAAI,EAAE;EACV,CAAC;EACDG,OAAO,EAAE;IACLH,IAAI,EAAE;EACV,CAAC;EACDI,IAAI,EAAE;IACFJ,IAAI,EAAE,QAAQ;IACdK,QAAQ,EAAE;EACd,CAAC;EACDC,IAAI,EAAE;IACFN,IAAI,EAAE;EACV,CAAC;EACDO,SAAS,EAAE;IACPP,IAAI,EAAE;EACV;AACJ,CAAC;AAED,OAAO,MAAMQ,kBAAkB,GAC3BC,MAA8F,IAC7F;EACD,OAAOhB,YAAY,CAA6B;IAC5C,GAAGgB,MAAM;IACTC,UAAU,EAAE;MACR,GAAGhB,sBAAsB;MACzB,GAAGe,MAAM,CAACC;IACd;EACJ,CAAC,CAAC;AACN,CAAC;AAcD,OAAO,MAAMC,wBAA8C,GAAG;EAC1DhB,EAAE,EAAE;IACAC,YAAY,EAAE;EAClB,CAAC;EACDC,EAAE,EAAE;IACAC,OAAO,EAAE;EACb,CAAC;EACDc,UAAU,EAAE;IACRZ,IAAI,EAAE,QAAQ;IACdK,QAAQ,EAAE;EACd,CAAC;EACDN,OAAO,EAAE;IACLC,IAAI,EAAE;EACV,CAAC;EACDC,OAAO,EAAE;IACLD,IAAI,EAAE;EACV,CAAC;EACDE,OAAO,EAAE;IACLF,IAAI,EAAE;EACV,CAAC;EACDG,OAAO,EAAE;IACLH,IAAI,EAAE;EACV,CAAC;EACDI,IAAI,EAAE;IACFJ,IAAI,EAAE,QAAQ;IACdK,QAAQ,EAAE;EACd,CAAC;EACDC,IAAI,EAAE;IACFN,IAAI,EAAE;EACV,CAAC;EACDO,SAAS,EAAE;IACPP,IAAI,EAAE;EACV;AACJ,CAAC;AAED,OAAO,MAAMa,oBAAoB,GAC7BJ,MAA8F,IAC7F;EACD,OAAOhB,YAAY,CAA+B;IAC9C,GAAGgB,MAAM;IACTC,UAAU,EAAE;MACR,GAAGC,wBAAwB;MAC3B,GAAGF,MAAM,CAACC;IACd;EACJ,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/utils/createTable.d.ts

@@ -1,8 +1,11 @@
-import type { DynamoDBDocument } from "@webiny/aws-sdk/client-dynamodb";
-import { Table as BaseTable } from "../toolbox";
-export interface CreateTableParams {
-    name?: string;
-    documentClient: DynamoDBDocument;
+import type { ITable } from "../utils/table/index.js";
+import type { TableConstructor } from "../toolbox.js";
+export interface ICreateTableParamsIndexDefinition {
+    partitionKey: string;
+    sortKey?: string;
 }
-export type Table = BaseTable<string, "PK", "SK">;
-export declare const createTable: ({ name, documentClient }: CreateTableParams) => Table;
+export type ICreateTableParams = Partial<Omit<TableConstructor<string, string, string>, "DocumentClient">> & {
+    name: string;
+    documentClient: Pick<TableConstructor<string, string, string>, "DocumentClient">["DocumentClient"];
+};
+export declare const createTable: (params: ICreateTableParams) => ITable<string, "PK", "SK">;

package/utils/createTable.js

@@ -1,29 +1,39 @@
-"use strict";
+import { Table } from "./table/index.js";
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createTable = void 0;
-var _toolbox = require("../toolbox");
-const createTable = ({
-  name,
-  documentClient
-}) => {
-  return new _toolbox.Table({
-    name: name || String(process.env.DB_TABLE),
+// export interface ICreateTableParams {
+//     name?: string;
+//     documentClient: DynamoDBDocument;
+//     indexes?: GenericRecord<string, ICreateTableParamsIndexDefinition>;
+// }
+
+export const createTable = params => {
+  const {
+    documentClient,
+    indexes = {},
+    ...rest
+  } = params;
+  return new Table({
     partitionKey: "PK",
     sortKey: "SK",
     DocumentClient: documentClient,
     indexes: {
+      GSI_TENANT: {
+        partitionKey: "GSI_TENANT"
+      },
       GSI1: {
         partitionKey: "GSI1_PK",
         sortKey: "GSI1_SK"
-      }
+      },
+      GSI2: {
+        partitionKey: "GSI2_PK",
+        sortKey: "GSI2_SK"
+      },
+      ...indexes
     },
     autoExecute: true,
-    autoParse: true
+    autoParse: true,
+    ...rest
   });
 };
-exports.createTable = createTable;
 
 //# sourceMappingURL=createTable.js.map

package/utils/createTable.js.map

@@ -1 +1 @@
-{"version":3,"names":["_toolbox","require","createTable","name","documentClient","BaseTable","String","process","env","DB_TABLE","partitionKey","sortKey","DocumentClient","indexes","GSI1","autoExecute","autoParse","exports"],"sources":["createTable.ts"],"sourcesContent":["import type { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb\";\nimport { Table as BaseTable } from \"~/toolbox\";\n\nexport interface CreateTableParams {\n    name?: string;\n    documentClient: DynamoDBDocument;\n}\n\nexport type Table = BaseTable<string, \"PK\", \"SK\">;\n\nexport const createTable = ({ name, documentClient }: CreateTableParams): Table => {\n    return new BaseTable({\n        name: name || String(process.env.DB_TABLE),\n        partitionKey: \"PK\",\n        sortKey: \"SK\",\n        DocumentClient: documentClient,\n        indexes: {\n            GSI1: {\n                partitionKey: \"GSI1_PK\",\n                sortKey: \"GSI1_SK\"\n            }\n        },\n        autoExecute: true,\n        autoParse: true\n    });\n};\n"],"mappings":";;;;;;AACA,IAAAA,QAAA,GAAAC,OAAA;AASO,MAAMC,WAAW,GAAGA,CAAC;EAAEC,IAAI;EAAEC;AAAkC,CAAC,KAAY;EAC/E,OAAO,IAAIC,cAAS,CAAC;IACjBF,IAAI,EAAEA,IAAI,IAAIG,MAAM,CAACC,OAAO,CAACC,GAAG,CAACC,QAAQ,CAAC;IAC1CC,YAAY,EAAE,IAAI;IAClBC,OAAO,EAAE,IAAI;IACbC,cAAc,EAAER,cAAc;IAC9BS,OAAO,EAAE;MACLC,IAAI,EAAE;QACFJ,YAAY,EAAE,SAAS;QACvBC,OAAO,EAAE;MACb;IACJ,CAAC;IACDI,WAAW,EAAE,IAAI;IACjBC,SAAS,EAAE;EACf,CAAC,CAAC;AACN,CAAC;AAACC,OAAA,CAAAf,WAAA,GAAAA,WAAA","ignoreList":[]}
+{"version":3,"names":["Table","createTable","params","documentClient","indexes","rest","partitionKey","sortKey","DocumentClient","GSI_TENANT","GSI1","GSI2","autoExecute","autoParse"],"sources":["createTable.ts"],"sourcesContent":["import type { ITable } from \"~/utils/table/index.js\";\nimport { Table } from \"~/utils/table/index.js\";\nimport type { TableConstructor } from \"~/toolbox.js\";\n\nexport interface ICreateTableParamsIndexDefinition {\n    partitionKey: string;\n    sortKey?: string;\n}\n\n// export interface ICreateTableParams {\n//     name?: string;\n//     documentClient: DynamoDBDocument;\n//     indexes?: GenericRecord<string, ICreateTableParamsIndexDefinition>;\n// }\n\nexport type ICreateTableParams = Partial<\n    Omit<TableConstructor<string, string, string>, \"DocumentClient\">\n> & {\n    name: string;\n    documentClient: Pick<\n        TableConstructor<string, string, string>,\n        \"DocumentClient\"\n    >[\"DocumentClient\"];\n};\n\nexport const createTable = (params: ICreateTableParams): ITable<string, \"PK\", \"SK\"> => {\n    const { documentClient, indexes = {}, ...rest } = params;\n    return new Table({\n        partitionKey: \"PK\",\n        sortKey: \"SK\",\n        DocumentClient: documentClient,\n        indexes: {\n            GSI_TENANT: {\n                partitionKey: \"GSI_TENANT\"\n            },\n            GSI1: {\n                partitionKey: \"GSI1_PK\",\n                sortKey: \"GSI1_SK\"\n            },\n            GSI2: {\n                partitionKey: \"GSI2_PK\",\n                sortKey: \"GSI2_SK\"\n            },\n            ...indexes\n        },\n        autoExecute: true,\n        autoParse: true,\n        ...rest\n    });\n};\n"],"mappings":"AACA,SAASA,KAAK;;AAQd;AACA;AACA;AACA;AACA;;AAYA,OAAO,MAAMC,WAAW,GAAIC,MAA0B,IAAiC;EACnF,MAAM;IAAEC,cAAc;IAAEC,OAAO,GAAG,CAAC,CAAC;IAAE,GAAGC;EAAK,CAAC,GAAGH,MAAM;EACxD,OAAO,IAAIF,KAAK,CAAC;IACbM,YAAY,EAAE,IAAI;IAClBC,OAAO,EAAE,IAAI;IACbC,cAAc,EAAEL,cAAc;IAC9BC,OAAO,EAAE;MACLK,UAAU,EAAE;QACRH,YAAY,EAAE;MAClB,CAAC;MACDI,IAAI,EAAE;QACFJ,YAAY,EAAE,SAAS;QACvBC,OAAO,EAAE;MACb,CAAC;MACDI,IAAI,EAAE;QACFL,YAAY,EAAE,SAAS;QACvBC,OAAO,EAAE;MACb,CAAC;MACD,GAAGH;IACP,CAAC;IACDQ,WAAW,EAAE,IAAI;IACjBC,SAAS,EAAE,IAAI;IACf,GAAGR;EACP,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/utils/cursor.js

@@ -1,22 +1,14 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.encodeCursor = exports.decodeCursor = void 0;
-const encodeCursor = cursor => {
+export const encodeCursor = cursor => {
   if (!cursor) {
     return null;
   }
   return Buffer.from(JSON.stringify(cursor)).toString("base64");
 };
-exports.encodeCursor = encodeCursor;
-const decodeCursor = cursor => {
+export const decodeCursor = cursor => {
   if (!cursor) {
     return null;
   }
   return JSON.parse(Buffer.from(cursor, "base64").toString("ascii"));
 };
-exports.decodeCursor = decodeCursor;
 
 //# sourceMappingURL=cursor.js.map

package/utils/cursor.js.map

@@ -1 +1 @@
-{"version":3,"names":["encodeCursor","cursor","Buffer","from","JSON","stringify","toString","exports","decodeCursor","parse"],"sources":["cursor.ts"],"sourcesContent":["export const encodeCursor = (cursor?: any): string | null => {\n    if (!cursor) {\n        return null;\n    }\n\n    return Buffer.from(JSON.stringify(cursor)).toString(\"base64\");\n};\n\nexport const decodeCursor = (cursor?: string | null): string | null => {\n    if (!cursor) {\n        return null;\n    }\n\n    return JSON.parse(Buffer.from(cursor, \"base64\").toString(\"ascii\"));\n};\n"],"mappings":";;;;;;AAAO,MAAMA,YAAY,GAAIC,MAAY,IAAoB;EACzD,IAAI,CAACA,MAAM,EAAE;IACT,OAAO,IAAI;EACf;EAEA,OAAOC,MAAM,CAACC,IAAI,CAACC,IAAI,CAACC,SAAS,CAACJ,MAAM,CAAC,CAAC,CAACK,QAAQ,CAAC,QAAQ,CAAC;AACjE,CAAC;AAACC,OAAA,CAAAP,YAAA,GAAAA,YAAA;AAEK,MAAMQ,YAAY,GAAIP,MAAsB,IAAoB;EACnE,IAAI,CAACA,MAAM,EAAE;IACT,OAAO,IAAI;EACf;EAEA,OAAOG,IAAI,CAACK,KAAK,CAACP,MAAM,CAACC,IAAI,CAACF,MAAM,EAAE,QAAQ,CAAC,CAACK,QAAQ,CAAC,OAAO,CAAC,CAAC;AACtE,CAAC;AAACC,OAAA,CAAAC,YAAA,GAAAA,YAAA","ignoreList":[]}
+{"version":3,"names":["encodeCursor","cursor","Buffer","from","JSON","stringify","toString","decodeCursor","parse"],"sources":["cursor.ts"],"sourcesContent":["export const encodeCursor = (cursor?: any): string | null => {\n    if (!cursor) {\n        return null;\n    }\n\n    return Buffer.from(JSON.stringify(cursor)).toString(\"base64\");\n};\n\nexport const decodeCursor = (cursor?: string | null): string | null => {\n    if (!cursor) {\n        return null;\n    }\n\n    return JSON.parse(Buffer.from(cursor, \"base64\").toString(\"ascii\"));\n};\n"],"mappings":"AAAA,OAAO,MAAMA,YAAY,GAAIC,MAAY,IAAoB;EACzD,IAAI,CAACA,MAAM,EAAE;IACT,OAAO,IAAI;EACf;EAEA,OAAOC,MAAM,CAACC,IAAI,CAACC,IAAI,CAACC,SAAS,CAACJ,MAAM,CAAC,CAAC,CAACK,QAAQ,CAAC,QAAQ,CAAC;AACjE,CAAC;AAED,OAAO,MAAMC,YAAY,GAAIN,MAAsB,IAAoB;EACnE,IAAI,CAACA,MAAM,EAAE;IACT,OAAO,IAAI;EACf;EAEA,OAAOG,IAAI,CAACI,KAAK,CAACN,MAAM,CAACC,IAAI,CAACF,MAAM,EAAE,QAAQ,CAAC,CAACK,QAAQ,CAAC,OAAO,CAAC,CAAC;AACtE,CAAC","ignoreList":[]}

package/utils/delete.d.ts

@@ -1,4 +1,4 @@
-import type { Entity } from "../toolbox";
+import type { Entity } from "../toolbox.js";
 export interface IDeleteItemKeys {
     PK: string;
     SK: string;

package/utils/delete.js

@@ -1,10 +1,4 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.deleteItem = void 0;
-const deleteItem = async params => {
+export const deleteItem = async params => {
   const {
     entity,
     keys
@@ -13,6 +7,5 @@ const deleteItem = async params => {
     execute: true
   });
 };
-exports.deleteItem = deleteItem;
 
 //# sourceMappingURL=delete.js.map

package/utils/delete.js.map

@@ -1 +1 @@
-{"version":3,"names":["deleteItem","params","entity","keys","delete","execute","exports"],"sources":["delete.ts"],"sourcesContent":["import type { Entity } from \"~/toolbox\";\nexport interface IDeleteItemKeys {\n    PK: string;\n    SK: string;\n}\nexport interface IDeleteItemParams {\n    entity: Entity;\n    keys: IDeleteItemKeys;\n}\n\nexport const deleteItem = async (params: IDeleteItemParams) => {\n    const { entity, keys } = params;\n\n    return await entity.delete(keys, {\n        execute: true\n    });\n};\n"],"mappings":";;;;;;AAUO,MAAMA,UAAU,GAAG,MAAOC,MAAyB,IAAK;EAC3D,MAAM;IAAEC,MAAM;IAAEC;EAAK,CAAC,GAAGF,MAAM;EAE/B,OAAO,MAAMC,MAAM,CAACE,MAAM,CAACD,IAAI,EAAE;IAC7BE,OAAO,EAAE;EACb,CAAC,CAAC;AACN,CAAC;AAACC,OAAA,CAAAN,UAAA,GAAAA,UAAA","ignoreList":[]}
+{"version":3,"names":["deleteItem","params","entity","keys","delete","execute"],"sources":["delete.ts"],"sourcesContent":["import type { Entity } from \"~/toolbox.js\";\nexport interface IDeleteItemKeys {\n    PK: string;\n    SK: string;\n}\nexport interface IDeleteItemParams {\n    entity: Entity;\n    keys: IDeleteItemKeys;\n}\n\nexport const deleteItem = async (params: IDeleteItemParams) => {\n    const { entity, keys } = params;\n\n    return await entity.delete(keys, {\n        execute: true\n    });\n};\n"],"mappings":"AAUA,OAAO,MAAMA,UAAU,GAAG,MAAOC,MAAyB,IAAK;EAC3D,MAAM;IAAEC,MAAM;IAAEC;EAAK,CAAC,GAAGF,MAAM;EAE/B,OAAO,MAAMC,MAAM,CAACE,MAAM,CAACD,IAAI,EAAE;IAC7BE,OAAO,EAAE;EACb,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/utils/entity/Entity.d.ts

@@ -1,26 +1,28 @@
-import type { AttributeDefinitions, EntityConstructor as BaseEntityConstructor, Readonly, TableDef } from "../../toolbox";
-import { Entity as BaseEntity } from "../../toolbox";
-import type { ITableWriteBatch } from "../table/types";
-import type { IEntity, IEntityQueryAllParams, IEntityQueryOneParams, IEntityReadBatch, IEntityWriteBatch } from "./types";
-import type { IPutParamsItem } from "../put";
-import { put } from "../put";
-import type { GetRecordParamsKeys } from "../get";
-import { get, getClean } from "../get";
-import type { IDeleteItemKeys } from "../delete";
-import { deleteItem } from "../delete";
-import type { GenericRecord } from "@webiny/api/types";
+import type { AttributeDefinitions, EntityConstructor as BaseEntityConstructor, Readonly, TableDef } from "../../toolbox.js";
+import { Entity as BaseEntity } from "../../toolbox.js";
+import type { ITableWriteBatch } from "../table/types.js";
+import type { IEntity, IEntityCreateEntityReaderParams, IEntityCreateEntityWriterParams, IEntityDeleteResult, IEntityGetCleanResult, IEntityGetResult, IEntityPutResult, IEntityQueryAllCleanResult, IEntityQueryAllParams, IEntityQueryAllResult, IEntityQueryOneCleanResult, IEntityQueryOneParams, IEntityQueryOneResult, IEntityQueryPerPageParams, IEntityReadBatch, IEntityWriteBatch } from "./types.js";
+import type { IPutParamsItem } from "../put.js";
+import type { GetRecordParamsKeys } from "../get.js";
+import type { IDeleteItemKeys } from "../delete.js";
+import type { GenericRecord } from "@webiny/api/types.js";
 export type EntityConstructor<T extends Readonly<AttributeDefinitions> = Readonly<AttributeDefinitions>> = BaseEntityConstructor<TableDef, string, true, true, true, "created", "modified", "entity", false, T>;
-export declare class Entity implements IEntity {
+export declare class Entity<T extends GenericRecord = GenericRecord> implements IEntity<T> {
     readonly entity: BaseEntity;
+    get name(): string;
+    get table(): TableDef;
     constructor(params: EntityConstructor);
-    createEntityReader(): IEntityReadBatch;
-    createEntityWriter(): IEntityWriteBatch;
+    createEntityReader(params?: IEntityCreateEntityReaderParams): IEntityReadBatch<T>;
+    createEntityWriter(params?: IEntityCreateEntityWriterParams): IEntityWriteBatch<T>;
     createTableWriter(): ITableWriteBatch;
-    put<T extends GenericRecord = GenericRecord>(item: IPutParamsItem<T>): ReturnType<typeof put>;
-    get<T>(keys: GetRecordParamsKeys): ReturnType<typeof get<T>>;
-    getClean<T>(keys: GetRecordParamsKeys): ReturnType<typeof getClean<T>>;
-    delete(keys: IDeleteItemKeys): ReturnType<typeof deleteItem>;
-    queryOne<T>(params: IEntityQueryOneParams): Promise<T | null>;
-    queryAll<T>(params: IEntityQueryAllParams): Promise<T[]>;
+    put<T extends GenericRecord = GenericRecord>(item: IPutParamsItem<T>): IEntityPutResult;
+    get<T>(keys: GetRecordParamsKeys): IEntityGetResult<T>;
+    getClean<T>(keys: GetRecordParamsKeys): IEntityGetCleanResult<T>;
+    delete(keys: IDeleteItemKeys): IEntityDeleteResult;
+    queryOne<T>(params: IEntityQueryOneParams): IEntityQueryOneResult<T>;
+    queryOneClean<T>(params: IEntityQueryOneParams): IEntityQueryOneCleanResult<T>;
+    queryAll<T>(params: IEntityQueryAllParams): IEntityQueryAllResult<T>;
+    queryAllClean<T>(params: IEntityQueryAllParams): IEntityQueryAllCleanResult<T>;
+    queryPerPage<T>(params: IEntityQueryPerPageParams): Promise<import("../query.js").IQueryPageResponse<T>>;
 }
-export declare const createEntity: (params: EntityConstructor) => IEntity;
+export declare const createEntity: <T extends GenericRecord = GenericRecord>(params: EntityConstructor) => IEntity<T>;

package/utils/entity/Entity.js

@@ -1,77 +1,99 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createEntity = exports.Entity = void 0;
-var _toolbox = require("../../toolbox");
-var _put = require("../put");
-var _get = require("../get");
-var _delete = require("../delete");
-var _EntityReadBatch = require("./EntityReadBatch");
-var _EntityWriteBatch = require("./EntityWriteBatch");
-var _TableWriteBatch = require("../table/TableWriteBatch");
-var _query = require("../query");
-class Entity {
+import { Entity as BaseEntity } from "../../toolbox.js";
+import { put } from "../put.js";
+import { get, getClean } from "../get.js";
+import { deleteItem } from "../delete.js";
+import { createEntityReadBatch } from "./EntityReadBatch.js";
+import { createEntityWriteBatch } from "./EntityWriteBatch.js";
+import { createTableWriteBatch } from "../table/TableWriteBatch.js";
+import { queryAll, queryAllClean, queryOne, queryOneClean, queryPerPage } from "../query.js";
+export class Entity {
+  get name() {
+    return this.entity.name;
+  }
+  get table() {
+    /**
+     * Not possible to be undefined.
+     */
+    return this.entity.table;
+  }
   constructor(params) {
-    this.entity = new _toolbox.Entity(params);
+    this.entity = new BaseEntity(params);
   }
-  createEntityReader() {
-    return (0, _EntityReadBatch.createEntityReadBatch)({
-      entity: this.entity
+  createEntityReader(params) {
+    return createEntityReadBatch({
+      entity: this.entity,
+      read: params?.read
     });
   }
-  createEntityWriter() {
-    return (0, _EntityWriteBatch.createEntityWriteBatch)({
-      entity: this.entity
+  createEntityWriter(params) {
+    return createEntityWriteBatch({
+      entity: this.entity,
+      put: params?.put,
+      delete: params?.delete
     });
   }
   createTableWriter() {
-    return (0, _TableWriteBatch.createTableWriteBatch)({
+    return createTableWriteBatch({
       table: this.entity.table
     });
   }
   async put(item) {
-    return (0, _put.put)({
+    return put({
       entity: this.entity,
       item
     });
   }
   async get(keys) {
-    return (0, _get.get)({
+    return get({
       entity: this.entity,
       keys
     });
   }
   async getClean(keys) {
-    return (0, _get.getClean)({
+    return getClean({
       entity: this.entity,
       keys
     });
   }
   async delete(keys) {
-    return (0, _delete.deleteItem)({
+    return deleteItem({
       entity: this.entity,
       keys
     });
   }
-  queryOne(params) {
-    return (0, _query.queryOneClean)({
+  async queryOne(params) {
+    return queryOne({
+      ...params,
+      entity: this.entity
+    });
+  }
+  async queryOneClean(params) {
+    return queryOneClean({
+      ...params,
+      entity: this.entity
+    });
+  }
+  async queryAll(params) {
+    return queryAll({
+      ...params,
+      entity: this.entity
+    });
+  }
+  async queryAllClean(params) {
+    return queryAllClean({
       ...params,
       entity: this.entity
     });
   }
-  queryAll(params) {
-    return (0, _query.queryAllClean)({
+  async queryPerPage(params) {
+    return queryPerPage({
       ...params,
       entity: this.entity
     });
   }
 }
-exports.Entity = Entity;
-const createEntity = params => {
+export const createEntity = params => {
   return new Entity(params);
 };
-exports.createEntity = createEntity;
 
 //# sourceMappingURL=Entity.js.map