@webiny/api-headless-cms-ddb 6.0.0-beta.0 → 6.0.0-rc.1

package/README.md

@@ -1,25 +1,11 @@
 # @webiny/api-headless-cms-ddb
 
-[![](https://img.shields.io/npm/dw/@webiny/api-headless-cms-ddb.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms-ddb)
-[![](https://img.shields.io/npm/v/@webiny/api-headless-cms-ddb.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms-ddb)
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
 
-## Install
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
 
-```
-npm install --save @webiny/api-headless-cms-ddb
-```
+---
 
-Or if you prefer yarn:
-
-```
-yarn add @webiny/api-headless-cms-ddb
-```
-
-## Testing
-To run the tests only for this package you must filter it with keywords.
-### Command
-````
-yarn test packages/api-headless-cms --keyword=cms:ddb --keyword=cms:base
-````
+_This README file is automatically generated during the publish process._

package/definitions/entry.d.ts

@@ -1,9 +1,8 @@
-import { Entity, Table } from "@webiny/db-dynamodb/toolbox";
-import { Attributes } from "../types";
+import { type ITable } from "@webiny/db-dynamodb";
+import type { IEntryEntity } from "./types.js";
 interface Params {
-    table: Table<string, string, string>;
+    table: ITable;
     entityName: string;
-    attributes: Attributes;
 }
-export declare const createEntryEntity: (params: Params) => Entity<any>;
+export declare const createEntryEntity: (params: Params) => IEntryEntity;
 export {};

package/definitions/entry.js

@@ -1,188 +1,13 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createEntryEntity = void 0;
-var _toolbox = require("@webiny/db-dynamodb/toolbox");
-const createEntryEntity = params => {
+import { createStandardEntity } from "@webiny/db-dynamodb";
+export const createEntryEntity = params => {
   const {
     table,
-    entityName,
-    attributes
+    entityName
   } = params;
-  return new _toolbox.Entity({
+  return createStandardEntity({
     name: entityName,
-    table,
-    attributes: {
-      PK: {
-        type: "string",
-        partitionKey: true
-      },
-      SK: {
-        type: "string",
-        sortKey: true
-      },
-      GSI1_PK: {
-        type: "string"
-      },
-      GSI1_SK: {
-        type: "string"
-      },
-      TYPE: {
-        type: "string"
-      },
-      __type: {
-        type: "string"
-      },
-      webinyVersion: {
-        type: "string"
-      },
-      tenant: {
-        type: "string"
-      },
-      entryId: {
-        type: "string"
-      },
-      id: {
-        type: "string"
-      },
-      modelId: {
-        type: "string"
-      },
-      locale: {
-        type: "string"
-      },
-      /**
-       * Revision-level meta fields. 👇
-       */
-      revisionCreatedOn: {
-        type: "string"
-      },
-      revisionModifiedOn: {
-        type: "string"
-      },
-      revisionSavedOn: {
-        type: "string"
-      },
-      revisionDeletedOn: {
-        type: "string"
-      },
-      revisionRestoredOn: {
-        type: "string"
-      },
-      revisionFirstPublishedOn: {
-        type: "string"
-      },
-      revisionLastPublishedOn: {
-        type: "string"
-      },
-      revisionCreatedBy: {
-        type: "map"
-      },
-      revisionModifiedBy: {
-        type: "map"
-      },
-      revisionSavedBy: {
-        type: "map"
-      },
-      revisionDeletedBy: {
-        type: "map"
-      },
-      revisionRestoredBy: {
-        type: "map"
-      },
-      revisionFirstPublishedBy: {
-        type: "map"
-      },
-      revisionLastPublishedBy: {
-        type: "map"
-      },
-      /**
-       * Entry-level meta fields. 👇
-       */
-      createdOn: {
-        type: "string"
-      },
-      modifiedOn: {
-        type: "string"
-      },
-      savedOn: {
-        type: "string"
-      },
-      deletedOn: {
-        type: "string"
-      },
-      restoredOn: {
-        type: "string"
-      },
-      firstPublishedOn: {
-        type: "string"
-      },
-      lastPublishedOn: {
-        type: "string"
-      },
-      createdBy: {
-        type: "map"
-      },
-      modifiedBy: {
-        type: "map"
-      },
-      savedBy: {
-        type: "map"
-      },
-      deletedBy: {
-        type: "map"
-      },
-      restoredBy: {
-        type: "map"
-      },
-      firstPublishedBy: {
-        type: "map"
-      },
-      lastPublishedBy: {
-        type: "map"
-      },
-      /**
-       * Deprecated fields. 👇
-       */
-      ownedBy: {
-        type: "map"
-      },
-      publishedOn: {
-        type: "string"
-      },
-      /**
-       * The rest. 👇
-       */
-      version: {
-        type: "number"
-      },
-      locked: {
-        type: "boolean"
-      },
-      status: {
-        type: "string"
-      },
-      location: {
-        type: "map"
-      },
-      wbyDeleted: {
-        type: "boolean"
-      },
-      binOriginalFolderId: {
-        type: "string"
-      },
-      values: {
-        type: "map"
-      },
-      meta: {
-        type: "map"
-      },
-      ...(attributes || {})
-    }
+    table: table.table
   });
 };
-exports.createEntryEntity = createEntryEntity;
 
 //# sourceMappingURL=entry.js.map

package/definitions/entry.js.map

@@ -1 +1 @@
-{"version":3,"names":["_toolbox","require","createEntryEntity","params","table","entityName","attributes","Entity","name","PK","type","partitionKey","SK","sortKey","GSI1_PK","GSI1_SK","TYPE","__type","webinyVersion","tenant","entryId","id","modelId","locale","revisionCreatedOn","revisionModifiedOn","revisionSavedOn","revisionDeletedOn","revisionRestoredOn","revisionFirstPublishedOn","revisionLastPublishedOn","revisionCreatedBy","revisionModifiedBy","revisionSavedBy","revisionDeletedBy","revisionRestoredBy","revisionFirstPublishedBy","revisionLastPublishedBy","createdOn","modifiedOn","savedOn","deletedOn","restoredOn","firstPublishedOn","lastPublishedOn","createdBy","modifiedBy","savedBy","deletedBy","restoredBy","firstPublishedBy","lastPublishedBy","ownedBy","publishedOn","version","locked","status","location","wbyDeleted","binOriginalFolderId","values","meta","exports"],"sources":["entry.ts"],"sourcesContent":["import { Entity, Table } from \"@webiny/db-dynamodb/toolbox\";\nimport { Attributes } from \"~/types\";\n\ninterface Params {\n    table: Table<string, string, string>;\n    entityName: string;\n    attributes: Attributes;\n}\n\nexport const createEntryEntity = (params: Params): Entity<any> => {\n    const { table, entityName, attributes } = params;\n    return new Entity({\n        name: entityName,\n        table,\n        attributes: {\n            PK: {\n                type: \"string\",\n                partitionKey: true\n            },\n            SK: {\n                type: \"string\",\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            __type: {\n                type: \"string\"\n            },\n            webinyVersion: {\n                type: \"string\"\n            },\n            tenant: {\n                type: \"string\"\n            },\n            entryId: {\n                type: \"string\"\n            },\n            id: {\n                type: \"string\"\n            },\n            modelId: {\n                type: \"string\"\n            },\n            locale: {\n                type: \"string\"\n            },\n\n            /**\n             * Revision-level meta fields. 👇\n             */\n            revisionCreatedOn: { type: \"string\" },\n            revisionModifiedOn: { type: \"string\" },\n            revisionSavedOn: { type: \"string\" },\n            revisionDeletedOn: { type: \"string\" },\n            revisionRestoredOn: { type: \"string\" },\n            revisionFirstPublishedOn: { type: \"string\" },\n            revisionLastPublishedOn: { type: \"string\" },\n            revisionCreatedBy: { type: \"map\" },\n            revisionModifiedBy: { type: \"map\" },\n            revisionSavedBy: { type: \"map\" },\n            revisionDeletedBy: { type: \"map\" },\n            revisionRestoredBy: { type: \"map\" },\n            revisionFirstPublishedBy: { type: \"map\" },\n            revisionLastPublishedBy: { type: \"map\" },\n\n            /**\n             * Entry-level meta fields. 👇\n             */\n            createdOn: { type: \"string\" },\n            modifiedOn: { type: \"string\" },\n            savedOn: { type: \"string\" },\n            deletedOn: { type: \"string\" },\n            restoredOn: { type: \"string\" },\n            firstPublishedOn: { type: \"string\" },\n            lastPublishedOn: { type: \"string\" },\n            createdBy: { type: \"map\" },\n            modifiedBy: { type: \"map\" },\n            savedBy: { type: \"map\" },\n            deletedBy: { type: \"map\" },\n            restoredBy: { type: \"map\" },\n            firstPublishedBy: { type: \"map\" },\n            lastPublishedBy: { type: \"map\" },\n\n            /**\n             * Deprecated fields. 👇\n             */\n            ownedBy: {\n                type: \"map\"\n            },\n            publishedOn: {\n                type: \"string\"\n            },\n\n            /**\n             * The rest. 👇\n             */\n            version: {\n                type: \"number\"\n            },\n            locked: {\n                type: \"boolean\"\n            },\n            status: {\n                type: \"string\"\n            },\n            location: {\n                type: \"map\"\n            },\n            wbyDeleted: {\n                type: \"boolean\"\n            },\n            binOriginalFolderId: {\n                type: \"string\"\n            },\n            values: {\n                type: \"map\"\n            },\n            meta: {\n                type: \"map\"\n            },\n            ...(attributes || {})\n        }\n    });\n};\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,OAAA;AASO,MAAMC,iBAAiB,GAAIC,MAAc,IAAkB;EAC9D,MAAM;IAAEC,KAAK;IAAEC,UAAU;IAAEC;EAAW,CAAC,GAAGH,MAAM;EAChD,OAAO,IAAII,eAAM,CAAC;IACdC,IAAI,EAAEH,UAAU;IAChBD,KAAK;IACLE,UAAU,EAAE;MACRG,EAAE,EAAE;QACAC,IAAI,EAAE,QAAQ;QACdC,YAAY,EAAE;MAClB,CAAC;MACDC,EAAE,EAAE;QACAF,IAAI,EAAE,QAAQ;QACdG,OAAO,EAAE;MACb,CAAC;MACDC,OAAO,EAAE;QACLJ,IAAI,EAAE;MACV,CAAC;MACDK,OAAO,EAAE;QACLL,IAAI,EAAE;MACV,CAAC;MACDM,IAAI,EAAE;QACFN,IAAI,EAAE;MACV,CAAC;MACDO,MAAM,EAAE;QACJP,IAAI,EAAE;MACV,CAAC;MACDQ,aAAa,EAAE;QACXR,IAAI,EAAE;MACV,CAAC;MACDS,MAAM,EAAE;QACJT,IAAI,EAAE;MACV,CAAC;MACDU,OAAO,EAAE;QACLV,IAAI,EAAE;MACV,CAAC;MACDW,EAAE,EAAE;QACAX,IAAI,EAAE;MACV,CAAC;MACDY,OAAO,EAAE;QACLZ,IAAI,EAAE;MACV,CAAC;MACDa,MAAM,EAAE;QACJb,IAAI,EAAE;MACV,CAAC;MAED;AACZ;AACA;MACYc,iBAAiB,EAAE;QAAEd,IAAI,EAAE;MAAS,CAAC;MACrCe,kBAAkB,EAAE;QAAEf,IAAI,EAAE;MAAS,CAAC;MACtCgB,eAAe,EAAE;QAAEhB,IAAI,EAAE;MAAS,CAAC;MACnCiB,iBAAiB,EAAE;QAAEjB,IAAI,EAAE;MAAS,CAAC;MACrCkB,kBAAkB,EAAE;QAAElB,IAAI,EAAE;MAAS,CAAC;MACtCmB,wBAAwB,EAAE;QAAEnB,IAAI,EAAE;MAAS,CAAC;MAC5CoB,uBAAuB,EAAE;QAAEpB,IAAI,EAAE;MAAS,CAAC;MAC3CqB,iBAAiB,EAAE;QAAErB,IAAI,EAAE;MAAM,CAAC;MAClCsB,kBAAkB,EAAE;QAAEtB,IAAI,EAAE;MAAM,CAAC;MACnCuB,eAAe,EAAE;QAAEvB,IAAI,EAAE;MAAM,CAAC;MAChCwB,iBAAiB,EAAE;QAAExB,IAAI,EAAE;MAAM,CAAC;MAClCyB,kBAAkB,EAAE;QAAEzB,IAAI,EAAE;MAAM,CAAC;MACnC0B,wBAAwB,EAAE;QAAE1B,IAAI,EAAE;MAAM,CAAC;MACzC2B,uBAAuB,EAAE;QAAE3B,IAAI,EAAE;MAAM,CAAC;MAExC;AACZ;AACA;MACY4B,SAAS,EAAE;QAAE5B,IAAI,EAAE;MAAS,CAAC;MAC7B6B,UAAU,EAAE;QAAE7B,IAAI,EAAE;MAAS,CAAC;MAC9B8B,OAAO,EAAE;QAAE9B,IAAI,EAAE;MAAS,CAAC;MAC3B+B,SAAS,EAAE;QAAE/B,IAAI,EAAE;MAAS,CAAC;MAC7BgC,UAAU,EAAE;QAAEhC,IAAI,EAAE;MAAS,CAAC;MAC9BiC,gBAAgB,EAAE;QAAEjC,IAAI,EAAE;MAAS,CAAC;MACpCkC,eAAe,EAAE;QAAElC,IAAI,EAAE;MAAS,CAAC;MACnCmC,SAAS,EAAE;QAAEnC,IAAI,EAAE;MAAM,CAAC;MAC1BoC,UAAU,EAAE;QAAEpC,IAAI,EAAE;MAAM,CAAC;MAC3BqC,OAAO,EAAE;QAAErC,IAAI,EAAE;MAAM,CAAC;MACxBsC,SAAS,EAAE;QAAEtC,IAAI,EAAE;MAAM,CAAC;MAC1BuC,UAAU,EAAE;QAAEvC,IAAI,EAAE;MAAM,CAAC;MAC3BwC,gBAAgB,EAAE;QAAExC,IAAI,EAAE;MAAM,CAAC;MACjCyC,eAAe,EAAE;QAAEzC,IAAI,EAAE;MAAM,CAAC;MAEhC;AACZ;AACA;MACY0C,OAAO,EAAE;QACL1C,IAAI,EAAE;MACV,CAAC;MACD2C,WAAW,EAAE;QACT3C,IAAI,EAAE;MACV,CAAC;MAED;AACZ;AACA;MACY4C,OAAO,EAAE;QACL5C,IAAI,EAAE;MACV,CAAC;MACD6C,MAAM,EAAE;QACJ7C,IAAI,EAAE;MACV,CAAC;MACD8C,MAAM,EAAE;QACJ9C,IAAI,EAAE;MACV,CAAC;MACD+C,QAAQ,EAAE;QACN/C,IAAI,EAAE;MACV,CAAC;MACDgD,UAAU,EAAE;QACRhD,IAAI,EAAE;MACV,CAAC;MACDiD,mBAAmB,EAAE;QACjBjD,IAAI,EAAE;MACV,CAAC;MACDkD,MAAM,EAAE;QACJlD,IAAI,EAAE;MACV,CAAC;MACDmD,IAAI,EAAE;QACFnD,IAAI,EAAE;MACV,CAAC;MACD,IAAIJ,UAAU,IAAI,CAAC,CAAC;IACxB;EACJ,CAAC,CAAC;AACN,CAAC;AAACwD,OAAA,CAAA5D,iBAAA,GAAAA,iBAAA","ignoreList":[]}
+{"version":3,"names":["createStandardEntity","createEntryEntity","params","table","entityName","name"],"sources":["entry.ts"],"sourcesContent":["import { createStandardEntity, type ITable } from \"@webiny/db-dynamodb\";\nimport type { IEntryEntity, IEntryEntityAttirbutesData } from \"./types.js\";\n\ninterface Params {\n    table: ITable;\n    entityName: string;\n}\n\nexport const createEntryEntity = (params: Params): IEntryEntity => {\n    const { table, entityName } = params;\n    return createStandardEntity<IEntryEntityAttirbutesData>({\n        name: entityName,\n        table: table.table\n    });\n};\n"],"mappings":"AAAA,SAASA,oBAAoB,QAAqB,qBAAqB;AAQvE,OAAO,MAAMC,iBAAiB,GAAIC,MAAc,IAAmB;EAC/D,MAAM;IAAEC,KAAK;IAAEC;EAAW,CAAC,GAAGF,MAAM;EACpC,OAAOF,oBAAoB,CAA6B;IACpDK,IAAI,EAAED,UAAU;IAChBD,KAAK,EAAEA,KAAK,CAACA;EACjB,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/definitions/group.d.ts

@@ -1,9 +1,8 @@
-import { Entity, Table } from "@webiny/db-dynamodb/toolbox";
-import { Attributes } from "../types";
+import { type ITable } from "@webiny/db-dynamodb";
+import type { IGroupEntity } from "./types.js";
 interface Params {
-    table: Table<string, string, string>;
+    table: ITable;
     entityName: string;
-    attributes: Attributes;
 }
-export declare const createGroupEntity: (params: Params) => Entity<any>;
+export declare const createGroupEntity: (params: Params) => IGroupEntity;
 export {};

package/definitions/group.js

@@ -1,66 +1,13 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createGroupEntity = void 0;
-var _toolbox = require("@webiny/db-dynamodb/toolbox");
-const createGroupEntity = params => {
+import { createStandardEntity } from "@webiny/db-dynamodb";
+export const createGroupEntity = params => {
   const {
     table,
-    attributes,
     entityName
   } = params;
-  return new _toolbox.Entity({
-    name: entityName,
-    table,
-    attributes: {
-      PK: {
-        partitionKey: true
-      },
-      SK: {
-        sortKey: true
-      },
-      TYPE: {
-        type: "string"
-      },
-      webinyVersion: {
-        type: "string"
-      },
-      id: {
-        type: "string"
-      },
-      name: {
-        type: "string"
-      },
-      slug: {
-        type: "string"
-      },
-      locale: {
-        type: "string"
-      },
-      description: {
-        type: "string"
-      },
-      icon: {
-        type: "string"
-      },
-      createdBy: {
-        type: "map"
-      },
-      createdOn: {
-        type: "string"
-      },
-      savedOn: {
-        type: "string"
-      },
-      tenant: {
-        type: "string"
-      },
-      ...(attributes || {})
-    }
+  return createStandardEntity({
+    table: table.table,
+    name: entityName
   });
 };
-exports.createGroupEntity = createGroupEntity;
 
 //# sourceMappingURL=group.js.map

package/definitions/group.js.map

@@ -1 +1 @@
-{"version":3,"names":["_toolbox","require","createGroupEntity","params","table","attributes","entityName","Entity","name","PK","partitionKey","SK","sortKey","TYPE","type","webinyVersion","id","slug","locale","description","icon","createdBy","createdOn","savedOn","tenant","exports"],"sources":["group.ts"],"sourcesContent":["import { Entity, Table } from \"@webiny/db-dynamodb/toolbox\";\nimport { Attributes } from \"~/types\";\n\ninterface Params {\n    table: Table<string, string, string>;\n    entityName: string;\n    attributes: Attributes;\n}\nexport const createGroupEntity = (params: Params): Entity<any> => {\n    const { table, attributes, entityName } = params;\n    return new Entity({\n        name: entityName,\n        table,\n        attributes: {\n            PK: {\n                partitionKey: true\n            },\n            SK: {\n                sortKey: true\n            },\n            TYPE: {\n                type: \"string\"\n            },\n            webinyVersion: {\n                type: \"string\"\n            },\n            id: {\n                type: \"string\"\n            },\n            name: {\n                type: \"string\"\n            },\n            slug: {\n                type: \"string\"\n            },\n            locale: {\n                type: \"string\"\n            },\n            description: {\n                type: \"string\"\n            },\n            icon: {\n                type: \"string\"\n            },\n\n            createdBy: {\n                type: \"map\"\n            },\n            createdOn: {\n                type: \"string\"\n            },\n            savedOn: {\n                type: \"string\"\n            },\n            tenant: {\n                type: \"string\"\n            },\n            ...(attributes || {})\n        }\n    });\n};\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,OAAA;AAQO,MAAMC,iBAAiB,GAAIC,MAAc,IAAkB;EAC9D,MAAM;IAAEC,KAAK;IAAEC,UAAU;IAAEC;EAAW,CAAC,GAAGH,MAAM;EAChD,OAAO,IAAII,eAAM,CAAC;IACdC,IAAI,EAAEF,UAAU;IAChBF,KAAK;IACLC,UAAU,EAAE;MACRI,EAAE,EAAE;QACAC,YAAY,EAAE;MAClB,CAAC;MACDC,EAAE,EAAE;QACAC,OAAO,EAAE;MACb,CAAC;MACDC,IAAI,EAAE;QACFC,IAAI,EAAE;MACV,CAAC;MACDC,aAAa,EAAE;QACXD,IAAI,EAAE;MACV,CAAC;MACDE,EAAE,EAAE;QACAF,IAAI,EAAE;MACV,CAAC;MACDN,IAAI,EAAE;QACFM,IAAI,EAAE;MACV,CAAC;MACDG,IAAI,EAAE;QACFH,IAAI,EAAE;MACV,CAAC;MACDI,MAAM,EAAE;QACJJ,IAAI,EAAE;MACV,CAAC;MACDK,WAAW,EAAE;QACTL,IAAI,EAAE;MACV,CAAC;MACDM,IAAI,EAAE;QACFN,IAAI,EAAE;MACV,CAAC;MAEDO,SAAS,EAAE;QACPP,IAAI,EAAE;MACV,CAAC;MACDQ,SAAS,EAAE;QACPR,IAAI,EAAE;MACV,CAAC;MACDS,OAAO,EAAE;QACLT,IAAI,EAAE;MACV,CAAC;MACDU,MAAM,EAAE;QACJV,IAAI,EAAE;MACV,CAAC;MACD,IAAIT,UAAU,IAAI,CAAC,CAAC;IACxB;EACJ,CAAC,CAAC;AACN,CAAC;AAACoB,OAAA,CAAAvB,iBAAA,GAAAA,iBAAA","ignoreList":[]}
+{"version":3,"names":["createStandardEntity","createGroupEntity","params","table","entityName","name"],"sources":["group.ts"],"sourcesContent":["import { createStandardEntity, type ITable } from \"@webiny/db-dynamodb\";\nimport type { IGroupEntity } from \"./types.js\";\nimport type { CmsGroup } from \"@webiny/api-headless-cms/types/index.js\";\n\ninterface Params {\n    table: ITable;\n    entityName: string;\n}\n\nexport const createGroupEntity = (params: Params): IGroupEntity => {\n    const { table, entityName } = params;\n    return createStandardEntity<CmsGroup>({\n        table: table.table,\n        name: entityName\n    });\n};\n"],"mappings":"AAAA,SAASA,oBAAoB,QAAqB,qBAAqB;AASvE,OAAO,MAAMC,iBAAiB,GAAIC,MAAc,IAAmB;EAC/D,MAAM;IAAEC,KAAK;IAAEC;EAAW,CAAC,GAAGF,MAAM;EACpC,OAAOF,oBAAoB,CAAW;IAClCG,KAAK,EAAEA,KAAK,CAACA,KAAK;IAClBE,IAAI,EAAED;EACV,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/definitions/model.d.ts

@@ -1,9 +1,8 @@
-import { Entity, Table } from "@webiny/db-dynamodb/toolbox";
-import { Attributes } from "../types";
+import { type ITable } from "@webiny/db-dynamodb";
+import type { IModelEntity } from "./types.js";
 interface Params {
-    table: Table<string, string, string>;
+    table: ITable;
     entityName: string;
-    attributes: Attributes;
 }
-export declare const createModelEntity: (params: Params) => Entity<any>;
+export declare const createModelEntity: (params: Params) => IModelEntity;
 export {};

package/definitions/model.js

@@ -1,110 +1,13 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createModelEntity = void 0;
-var _toolbox = require("@webiny/db-dynamodb/toolbox");
-const createModelEntity = params => {
+import { createStandardEntity } from "@webiny/db-dynamodb";
+export const createModelEntity = params => {
   const {
     table,
-    attributes,
     entityName
   } = params;
-  return new _toolbox.Entity({
-    name: entityName,
-    table,
-    attributes: {
-      PK: {
-        partitionKey: true
-      },
-      SK: {
-        sortKey: true
-      },
-      TYPE: {
-        type: "string",
-        required: true
-      },
-      webinyVersion: {
-        type: "string",
-        required: true
-      },
-      name: {
-        type: "string",
-        required: true
-      },
-      modelId: {
-        type: "string",
-        required: true
-      },
-      singularApiName: {
-        type: "string",
-        required: true
-      },
-      pluralApiName: {
-        type: "string",
-        required: true
-      },
-      locale: {
-        type: "string",
-        required: true
-      },
-      group: {
-        type: "map",
-        required: true
-      },
-      icon: {
-        type: "string"
-      },
-      description: {
-        type: "string"
-      },
-      createdOn: {
-        type: "string",
-        required: true
-      },
-      savedOn: {
-        type: "string",
-        required: true
-      },
-      createdBy: {
-        type: "map",
-        required: true
-      },
-      fields: {
-        type: "list",
-        required: true
-      },
-      layout: {
-        type: "list",
-        required: true
-      },
-      tags: {
-        type: "list",
-        required: false,
-        default: []
-      },
-      lockedFields: {
-        type: "list",
-        required: true
-      },
-      titleFieldId: {
-        type: "string"
-      },
-      descriptionFieldId: {
-        type: "string"
-      },
-      imageFieldId: {
-        type: "string"
-      },
-      tenant: {
-        type: "string",
-        required: true
-      },
-      ...(attributes || {})
-    }
+  return createStandardEntity({
+    table: table.table,
+    name: entityName
   });
 };
-exports.createModelEntity = createModelEntity;
 
 //# sourceMappingURL=model.js.map

package/definitions/model.js.map

@@ -1 +1 @@
-{"version":3,"names":["_toolbox","require","createModelEntity","params","table","attributes","entityName","Entity","name","PK","partitionKey","SK","sortKey","TYPE","type","required","webinyVersion","modelId","singularApiName","pluralApiName","locale","group","icon","description","createdOn","savedOn","createdBy","fields","layout","tags","default","lockedFields","titleFieldId","descriptionFieldId","imageFieldId","tenant","exports"],"sources":["model.ts"],"sourcesContent":["import { Entity, Table } from \"@webiny/db-dynamodb/toolbox\";\nimport { Attributes } from \"~/types\";\n\ninterface Params {\n    table: Table<string, string, string>;\n    entityName: string;\n    attributes: Attributes;\n}\n\nexport const createModelEntity = (params: Params): Entity<any> => {\n    const { table, attributes, entityName } = params;\n    return new Entity({\n        name: entityName,\n        table,\n        attributes: {\n            PK: {\n                partitionKey: true\n            },\n            SK: {\n                sortKey: true\n            },\n            TYPE: {\n                type: \"string\",\n                required: true\n            },\n            webinyVersion: {\n                type: \"string\",\n                required: true\n            },\n            name: {\n                type: \"string\",\n                required: true\n            },\n            modelId: {\n                type: \"string\",\n                required: true\n            },\n            singularApiName: {\n                type: \"string\",\n                required: true\n            },\n            pluralApiName: {\n                type: \"string\",\n                required: true\n            },\n            locale: {\n                type: \"string\",\n                required: true\n            },\n            group: {\n                type: \"map\",\n                required: true\n            },\n            icon: {\n                type: \"string\"\n            },\n            description: {\n                type: \"string\"\n            },\n            createdOn: {\n                type: \"string\",\n                required: true\n            },\n            savedOn: {\n                type: \"string\",\n                required: true\n            },\n            createdBy: {\n                type: \"map\",\n                required: true\n            },\n            fields: {\n                type: \"list\",\n                required: true\n            },\n            layout: {\n                type: \"list\",\n                required: true\n            },\n            tags: {\n                type: \"list\",\n                required: false,\n                default: []\n            },\n            lockedFields: {\n                type: \"list\",\n                required: true\n            },\n            titleFieldId: {\n                type: \"string\"\n            },\n            descriptionFieldId: {\n                type: \"string\"\n            },\n            imageFieldId: {\n                type: \"string\"\n            },\n            tenant: {\n                type: \"string\",\n                required: true\n            },\n            ...(attributes || {})\n        }\n    });\n};\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,OAAA;AASO,MAAMC,iBAAiB,GAAIC,MAAc,IAAkB;EAC9D,MAAM;IAAEC,KAAK;IAAEC,UAAU;IAAEC;EAAW,CAAC,GAAGH,MAAM;EAChD,OAAO,IAAII,eAAM,CAAC;IACdC,IAAI,EAAEF,UAAU;IAChBF,KAAK;IACLC,UAAU,EAAE;MACRI,EAAE,EAAE;QACAC,YAAY,EAAE;MAClB,CAAC;MACDC,EAAE,EAAE;QACAC,OAAO,EAAE;MACb,CAAC;MACDC,IAAI,EAAE;QACFC,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDC,aAAa,EAAE;QACXF,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDP,IAAI,EAAE;QACFM,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDE,OAAO,EAAE;QACLH,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDG,eAAe,EAAE;QACbJ,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDI,aAAa,EAAE;QACXL,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDK,MAAM,EAAE;QACJN,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDM,KAAK,EAAE;QACHP,IAAI,EAAE,KAAK;QACXC,QAAQ,EAAE;MACd,CAAC;MACDO,IAAI,EAAE;QACFR,IAAI,EAAE;MACV,CAAC;MACDS,WAAW,EAAE;QACTT,IAAI,EAAE;MACV,CAAC;MACDU,SAAS,EAAE;QACPV,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDU,OAAO,EAAE;QACLX,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACDW,SAAS,EAAE;QACPZ,IAAI,EAAE,KAAK;QACXC,QAAQ,EAAE;MACd,CAAC;MACDY,MAAM,EAAE;QACJb,IAAI,EAAE,MAAM;QACZC,QAAQ,EAAE;MACd,CAAC;MACDa,MAAM,EAAE;QACJd,IAAI,EAAE,MAAM;QACZC,QAAQ,EAAE;MACd,CAAC;MACDc,IAAI,EAAE;QACFf,IAAI,EAAE,MAAM;QACZC,QAAQ,EAAE,KAAK;QACfe,OAAO,EAAE;MACb,CAAC;MACDC,YAAY,EAAE;QACVjB,IAAI,EAAE,MAAM;QACZC,QAAQ,EAAE;MACd,CAAC;MACDiB,YAAY,EAAE;QACVlB,IAAI,EAAE;MACV,CAAC;MACDmB,kBAAkB,EAAE;QAChBnB,IAAI,EAAE;MACV,CAAC;MACDoB,YAAY,EAAE;QACVpB,IAAI,EAAE;MACV,CAAC;MACDqB,MAAM,EAAE;QACJrB,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE;MACd,CAAC;MACD,IAAIV,UAAU,IAAI,CAAC,CAAC;IACxB;EACJ,CAAC,CAAC;AACN,CAAC;AAAC+B,OAAA,CAAAlC,iBAAA,GAAAA,iBAAA","ignoreList":[]}
+{"version":3,"names":["createStandardEntity","createModelEntity","params","table","entityName","name"],"sources":["model.ts"],"sourcesContent":["import { createStandardEntity, type ITable } from \"@webiny/db-dynamodb\";\nimport type { IModelEntity } from \"./types.js\";\nimport type { CmsModel } from \"@webiny/api-headless-cms/types/index.js\";\n\ninterface Params {\n    table: ITable;\n    entityName: string;\n}\n\nexport const createModelEntity = (params: Params): IModelEntity => {\n    const { table, entityName } = params;\n    return createStandardEntity<CmsModel>({\n        table: table.table,\n        name: entityName\n    });\n};\n"],"mappings":"AAAA,SAASA,oBAAoB,QAAqB,qBAAqB;AASvE,OAAO,MAAMC,iBAAiB,GAAIC,MAAc,IAAmB;EAC/D,MAAM;IAAEC,KAAK;IAAEC;EAAW,CAAC,GAAGF,MAAM;EACpC,OAAOF,oBAAoB,CAAW;IAClCG,KAAK,EAAEA,KAAK,CAACA,KAAK;IAClBE,IAAI,EAAED;EACV,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/definitions/table.d.ts

@@ -1,9 +1,7 @@
-import { TableModifier } from "../types";
-import { DynamoDBDocument } from "@webiny/aws-sdk/client-dynamodb";
-import { Table } from "@webiny/db-dynamodb/toolbox";
+import type { DynamoDBDocument } from "@webiny/aws-sdk/client-dynamodb/index.js";
 interface Params {
-    table?: TableModifier;
+    name?: string;
     documentClient: DynamoDBDocument;
 }
-export declare const createTable: ({ table, documentClient }: Params) => Table<string, string, string>;
+export declare const createTable: (params: Params) => import("@webiny/db-dynamodb").ITable<string, "PK", "SK">;
 export {};

package/definitions/table.js

@@ -1,31 +1,9 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createTable = void 0;
-var _toolbox = require("@webiny/db-dynamodb/toolbox");
-const createTable = ({
-  table,
-  documentClient
-}) => {
-  const tableConfig = {
-    name: process.env.DB_TABLE_HEADLESS_CMS || process.env.DB_TABLE,
-    partitionKey: "PK",
-    sortKey: "SK",
-    DocumentClient: documentClient,
-    indexes: {
-      GSI1: {
-        partitionKey: "GSI1_PK",
-        sortKey: "GSI1_SK"
-      }
-    },
-    autoExecute: true,
-    autoParse: true
-  };
-  const config = typeof table === "function" ? table(tableConfig) : tableConfig;
-  return new _toolbox.Table(config);
+import { createTable as baseCreateTable } from "@webiny/db-dynamodb";
+export const createTable = params => {
+  return baseCreateTable({
+    name: params.name || process.env.DB_TABLE_HEADLESS_CMS || process.env.DB_TABLE,
+    documentClient: params.documentClient
+  });
 };
-exports.createTable = createTable;
 
 //# sourceMappingURL=table.js.map

package/definitions/table.js.map

@@ -1 +1 @@
-{"version":3,"names":["_toolbox","require","createTable","table","documentClient","tableConfig","name","process","env","DB_TABLE_HEADLESS_CMS","DB_TABLE","partitionKey","sortKey","DocumentClient","indexes","GSI1","autoExecute","autoParse","config","Table","exports"],"sources":["table.ts"],"sourcesContent":["import { TableModifier } from \"~/types\";\nimport { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb\";\nimport { Table } from \"@webiny/db-dynamodb/toolbox\";\nimport { TableConstructor } from \"@webiny/db-dynamodb/toolbox\";\n\ninterface Params {\n    table?: TableModifier;\n    documentClient: DynamoDBDocument;\n}\nexport const createTable = ({ table, documentClient }: Params): Table<string, string, string> => {\n    const tableConfig: TableConstructor<string, string, string> = {\n        name: process.env.DB_TABLE_HEADLESS_CMS || (process.env.DB_TABLE as string),\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    const config = typeof table === \"function\" ? table(tableConfig) : tableConfig;\n\n    return new Table(config);\n};\n"],"mappings":";;;;;;AAEA,IAAAA,QAAA,GAAAC,OAAA;AAOO,MAAMC,WAAW,GAAGA,CAAC;EAAEC,KAAK;EAAEC;AAAuB,CAAC,KAAoC;EAC7F,MAAMC,WAAqD,GAAG;IAC1DC,IAAI,EAAEC,OAAO,CAACC,GAAG,CAACC,qBAAqB,IAAKF,OAAO,CAACC,GAAG,CAACE,QAAmB;IAC3EC,YAAY,EAAE,IAAI;IAClBC,OAAO,EAAE,IAAI;IACbC,cAAc,EAAET,cAAc;IAC9BU,OAAO,EAAE;MACLC,IAAI,EAAE;QACFJ,YAAY,EAAE,SAAS;QACvBC,OAAO,EAAE;MACb;IACJ,CAAC;IACDI,WAAW,EAAE,IAAI;IACjBC,SAAS,EAAE;EACf,CAAC;EAED,MAAMC,MAAM,GAAG,OAAOf,KAAK,KAAK,UAAU,GAAGA,KAAK,CAACE,WAAW,CAAC,GAAGA,WAAW;EAE7E,OAAO,IAAIc,cAAK,CAACD,MAAM,CAAC;AAC5B,CAAC;AAACE,OAAA,CAAAlB,WAAA,GAAAA,WAAA","ignoreList":[]}
+{"version":3,"names":["createTable","baseCreateTable","params","name","process","env","DB_TABLE_HEADLESS_CMS","DB_TABLE","documentClient"],"sources":["table.ts"],"sourcesContent":["import { createTable as baseCreateTable } from \"@webiny/db-dynamodb\";\nimport type { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\n\ninterface Params {\n    name?: string;\n    documentClient: DynamoDBDocument;\n}\n\nexport const createTable = (params: Params) => {\n    return baseCreateTable({\n        name: params.name || process.env.DB_TABLE_HEADLESS_CMS || (process.env.DB_TABLE as string),\n        documentClient: params.documentClient\n    });\n};\n"],"mappings":"AAAA,SAASA,WAAW,IAAIC,eAAe,QAAQ,qBAAqB;AAQpE,OAAO,MAAMD,WAAW,GAAIE,MAAc,IAAK;EAC3C,OAAOD,eAAe,CAAC;IACnBE,IAAI,EAAED,MAAM,CAACC,IAAI,IAAIC,OAAO,CAACC,GAAG,CAACC,qBAAqB,IAAKF,OAAO,CAACC,GAAG,CAACE,QAAmB;IAC1FC,cAAc,EAAEN,MAAM,CAACM;EAC3B,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/definitions/types.d.ts

@@ -0,0 +1,59 @@
+import type { IEntity, IStandardEntityAttributes } from "@webiny/db-dynamodb";
+import type { GenericRecord } from "@webiny/api/types.js";
+import type { CmsEntryStatus, CmsGroup, CmsIdentity, CmsModel, ICmsEntryLocation, IEntryState } from "@webiny/api-headless-cms/types/index.js";
+export interface IEntryEntityAttirbutesData {
+    id: string;
+    entryId: string;
+    modelId: string;
+    tenant: string;
+    /**
+     * Revision-level meta fields. 👇
+     */
+    revisionCreatedOn: string;
+    revisionModifiedOn: string | null;
+    revisionSavedOn: string;
+    revisionDeletedOn: string | null;
+    revisionRestoredOn: string | null;
+    revisionFirstPublishedOn: string | null;
+    revisionLastPublishedOn: string | null;
+    revisionCreatedBy: CmsIdentity;
+    revisionModifiedBy: CmsIdentity | null;
+    revisionSavedBy: CmsIdentity;
+    revisionDeletedBy: CmsIdentity | null;
+    revisionRestoredBy: CmsIdentity | null;
+    revisionFirstPublishedBy: CmsIdentity | null;
+    revisionLastPublishedBy: CmsIdentity | null;
+    /**
+     * Entry-level meta fields. 👇
+     */
+    createdOn: string;
+    modifiedOn: string | null;
+    savedOn: string;
+    deletedOn: string | null;
+    restoredOn: string | null;
+    firstPublishedOn: string | null;
+    lastPublishedOn: string | null;
+    createdBy: CmsIdentity;
+    modifiedBy: CmsIdentity | null;
+    savedBy: CmsIdentity;
+    deletedBy: CmsIdentity | null;
+    restoredBy: CmsIdentity | null;
+    firstPublishedBy: CmsIdentity | null;
+    lastPublishedBy: CmsIdentity | null;
+    /**
+     * The rest. 👇
+     */
+    version: number;
+    locked: boolean;
+    status: CmsEntryStatus;
+    location?: ICmsEntryLocation;
+    wbyDeleted?: boolean | null;
+    binOriginalFolderId?: string;
+    values: GenericRecord;
+    meta?: GenericRecord;
+    state?: IEntryState;
+}
+export type IEntryEntityAttributes = IStandardEntityAttributes<IEntryEntityAttirbutesData>;
+export type IModelEntity = IEntity<IStandardEntityAttributes<CmsModel>>;
+export type IGroupEntity = IEntity<IStandardEntityAttributes<CmsGroup>>;
+export type IEntryEntity = IEntity<IEntryEntityAttributes>;

package/definitions/types.js

@@ -0,0 +1,3 @@
+export {};
+
+//# sourceMappingURL=types.js.map

package/definitions/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { IEntity, IStandardEntityAttributes } from \"@webiny/db-dynamodb\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\nimport type {\n    CmsEntryStatus,\n    CmsGroup,\n    CmsIdentity,\n    CmsModel,\n    ICmsEntryLocation,\n    IEntryState\n} from \"@webiny/api-headless-cms/types/index.js\";\n\nexport interface IEntryEntityAttirbutesData {\n    id: string;\n    entryId: string;\n    modelId: string;\n\n    tenant: string;\n    /**\n     * Revision-level meta fields. 👇\n     */\n    revisionCreatedOn: string;\n    revisionModifiedOn: string | null;\n    revisionSavedOn: string;\n    revisionDeletedOn: string | null;\n    revisionRestoredOn: string | null;\n    revisionFirstPublishedOn: string | null;\n    revisionLastPublishedOn: string | null;\n    revisionCreatedBy: CmsIdentity;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionSavedBy: CmsIdentity;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionRestoredBy: CmsIdentity | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n\n    /**\n     * Entry-level meta fields. 👇\n     */\n    createdOn: string;\n    modifiedOn: string | null;\n    savedOn: string;\n    deletedOn: string | null;\n    restoredOn: string | null;\n    firstPublishedOn: string | null;\n    lastPublishedOn: string | null;\n    createdBy: CmsIdentity;\n    modifiedBy: CmsIdentity | null;\n    savedBy: CmsIdentity;\n    deletedBy: CmsIdentity | null;\n    restoredBy: CmsIdentity | null;\n    firstPublishedBy: CmsIdentity | null;\n    lastPublishedBy: CmsIdentity | null;\n\n    /**\n     * The rest. 👇\n     */\n    version: number;\n    locked: boolean;\n    status: CmsEntryStatus;\n    location?: ICmsEntryLocation;\n    wbyDeleted?: boolean | null;\n    binOriginalFolderId?: string;\n    values: GenericRecord;\n    meta?: GenericRecord;\n    state?: IEntryState;\n}\n\nexport type IEntryEntityAttributes = IStandardEntityAttributes<IEntryEntityAttirbutesData>;\n\nexport type IModelEntity = IEntity<IStandardEntityAttributes<CmsModel>>;\nexport type IGroupEntity = IEntity<IStandardEntityAttributes<CmsGroup>>;\nexport type IEntryEntity = IEntity<IEntryEntityAttributes>;\n"],"mappings":"","ignoreList":[]}

package/dynamoDb/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: () => (import("@webiny/api-headless-cms").StorageTransformPlugin<any, any, import("@webiny/api-headless-cms/types").CmsModelField> | import("..").CmsEntryFieldFilterPathPlugin | import("../types").CmsFieldFilterValueTransformPlugin)[];
+declare const _default: () => (import("@webiny/api-headless-cms/index.js").StorageTransformPlugin<any, any, import("@webiny/api-headless-cms/types/modelField.js").CmsModelField> | import("../index.js").CmsEntryFieldFilterPathPlugin | import("../types.js").CmsFieldFilterValueTransformPlugin)[];
 export default _default;