@webiny/api-headless-cms-ddb-es 0.0.0-unstable.615a930a68 → 0.0.0-unstable.61c048f412

package/README.md

@@ -1,35 +1,11 @@
 # @webiny/api-headless-cms-ddb-es
 
-[![](https://img.shields.io/npm/dw/@webiny/api-headless-cms-ddb-es.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms-ddb-es)
-[![](https://img.shields.io/npm/v/@webiny/api-headless-cms-ddb-es.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms-ddb-es)
-[![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-es
-```
+---
 
-Or if you prefer yarn:
-
-```
-yarn add @webiny/api-headless-cms-ddb-es
-```
-
-
-## Testing
-To run the tests only for this package you must filter it with keywords.
-
-### Env variables
-
-###### LOCAL_ELASTICSEARCH
-If set, does not run Elasticsearch when starting the tests, use local one. You must install it and run if, of course.
-
-###### ELASTICSEARCH_PORT
-Custom port for local elasticsearch.
-
-### Command
-````
-ELASTICSEARCH_PORT=9200 LOCAL_ELASTICSEARCH=true yarn test packages/api-headless-cms --keyword=cms:ddb-es --keyword=cms:base
-````
+_This README file is automatically generated during the publish process._

package/configurations.d.ts

@@ -1,12 +1,18 @@
-import { CmsModel } from "@webiny/api-headless-cms/types";
-interface ElasticsearchConfig {
+import type { CmsModel } from "@webiny/api-headless-cms/types/index.js";
+import type { CmsContext } from "./types.js";
+import type { ElasticsearchIndexRequestBody } from "@webiny/api-elasticsearch/types.js";
+interface ConfigurationsElasticsearch {
     index: string;
 }
-interface CmsElasticsearchParams {
-    model: CmsModel;
+export interface CmsElasticsearchParams {
+    model: Pick<CmsModel, "tenant" | "modelId">;
 }
-interface Configurations {
-    es: (params: CmsElasticsearchParams) => ElasticsearchConfig;
+export interface ConfigurationsIndexSettingsParams {
+    context: CmsContext;
+}
+export interface Configurations {
+    es: (params: CmsElasticsearchParams) => ConfigurationsElasticsearch;
+    indexSettings: (params: ConfigurationsIndexSettingsParams) => Partial<ElasticsearchIndexRequestBody>;
 }
 export declare const configurations: Configurations;
 export {};

package/configurations.js

@@ -1,43 +1,37 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.configurations = void 0;
-
-var _error = _interopRequireDefault(require("@webiny/error"));
-
-const configurations = {
+import WebinyError from "@webiny/error";
+import { getElasticsearchIndexPrefix, getLastAddedIndexPlugin, isSharedElasticsearchIndex } from "@webiny/api-elasticsearch";
+import { CmsEntryElasticsearchIndexPlugin } from "./plugins/index.js";
+export const configurations = {
   es({
     model
   }) {
     const {
-      tenant,
-      locale
+      tenant
     } = model;
-
     if (!tenant) {
-      throw new _error.default(`Missing "tenant" parameter when trying to create Elasticsearch index name.`, "TENANT_ERROR");
-    } else if (!locale) {
-      throw new _error.default(`Missing "locale" parameter when trying to create Elasticsearch index name.`, "LOCALE_ERROR");
+      throw new WebinyError(`Missing "tenant" parameter when trying to create Elasticsearch index name.`, "TENANT_ERROR");
     }
-
-    const sharedIndex = process.env.ELASTICSEARCH_SHARED_INDEXES === "true";
-    const index = [sharedIndex ? "root" : tenant, "headless-cms", locale, model.modelId].join("-").toLowerCase();
-    const prefix = process.env.ELASTIC_SEARCH_INDEX_PREFIX || "";
-
+    const sharedIndex = isSharedElasticsearchIndex();
+    const index = [sharedIndex ? "root" : tenant, "headless-cms", model.modelId].join("-").toLowerCase();
+    const prefix = getElasticsearchIndexPrefix();
     if (!prefix) {
       return {
         index
       };
     }
-
     return {
       index: prefix + index
     };
+  },
+  indexSettings: ({
+    context
+  }) => {
+    const plugin = getLastAddedIndexPlugin({
+      container: context.plugins,
+      type: CmsEntryElasticsearchIndexPlugin.type
+    });
+    return plugin ? plugin.body : {};
   }
-
 };
-exports.configurations = configurations;
+
+//# sourceMappingURL=configurations.js.map

package/configurations.js.map

@@ -1 +1 @@
-{"version":3,"names":["configurations","es","model","tenant","locale","WebinyError","sharedIndex","process","env","ELASTICSEARCH_SHARED_INDEXES","index","modelId","join","toLowerCase","prefix","ELASTIC_SEARCH_INDEX_PREFIX"],"sources":["configurations.ts"],"sourcesContent":["import { CmsModel } from \"@webiny/api-headless-cms/types\";\nimport WebinyError from \"@webiny/error\";\n\ninterface ElasticsearchConfig {\n    index: string;\n}\n\ninterface CmsElasticsearchParams {\n    model: CmsModel;\n}\ninterface Configurations {\n    es: (params: CmsElasticsearchParams) => ElasticsearchConfig;\n}\n\nexport const configurations: Configurations = {\n    es({ model }) {\n        const { tenant, locale } = model;\n\n        if (!tenant) {\n            throw new WebinyError(\n                `Missing \"tenant\" parameter when trying to create Elasticsearch index name.`,\n                \"TENANT_ERROR\"\n            );\n        } else if (!locale) {\n            throw new WebinyError(\n                `Missing \"locale\" parameter when trying to create Elasticsearch index name.`,\n                \"LOCALE_ERROR\"\n            );\n        }\n\n        const sharedIndex = process.env.ELASTICSEARCH_SHARED_INDEXES === \"true\";\n        const index = [sharedIndex ? \"root\" : tenant, \"headless-cms\", locale, model.modelId]\n            .join(\"-\")\n            .toLowerCase();\n\n        const prefix = process.env.ELASTIC_SEARCH_INDEX_PREFIX || \"\";\n        if (!prefix) {\n            return {\n                index\n            };\n        }\n        return {\n            index: prefix + index\n        };\n    }\n};\n"],"mappings":";;;;;;;;;AACA;;AAaO,MAAMA,cAA8B,GAAG;EAC1CC,EAAE,CAAC;IAAEC;EAAF,CAAD,EAAY;IACV,MAAM;MAAEC,MAAF;MAAUC;IAAV,IAAqBF,KAA3B;;IAEA,IAAI,CAACC,MAAL,EAAa;MACT,MAAM,IAAIE,cAAJ,CACD,4EADC,EAEF,cAFE,CAAN;IAIH,CALD,MAKO,IAAI,CAACD,MAAL,EAAa;MAChB,MAAM,IAAIC,cAAJ,CACD,4EADC,EAEF,cAFE,CAAN;IAIH;;IAED,MAAMC,WAAW,GAAGC,OAAO,CAACC,GAAR,CAAYC,4BAAZ,KAA6C,MAAjE;IACA,MAAMC,KAAK,GAAG,CAACJ,WAAW,GAAG,MAAH,GAAYH,MAAxB,EAAgC,cAAhC,EAAgDC,MAAhD,EAAwDF,KAAK,CAACS,OAA9D,EACTC,IADS,CACJ,GADI,EAETC,WAFS,EAAd;IAIA,MAAMC,MAAM,GAAGP,OAAO,CAACC,GAAR,CAAYO,2BAAZ,IAA2C,EAA1D;;IACA,IAAI,CAACD,MAAL,EAAa;MACT,OAAO;QACHJ;MADG,CAAP;IAGH;;IACD,OAAO;MACHA,KAAK,EAAEI,MAAM,GAAGJ;IADb,CAAP;EAGH;;AA9ByC,CAAvC"}
+{"version":3,"names":["WebinyError","getElasticsearchIndexPrefix","getLastAddedIndexPlugin","isSharedElasticsearchIndex","CmsEntryElasticsearchIndexPlugin","configurations","es","model","tenant","sharedIndex","index","modelId","join","toLowerCase","prefix","indexSettings","context","plugin","container","plugins","type","body"],"sources":["configurations.ts"],"sourcesContent":["import type { CmsModel } from \"@webiny/api-headless-cms/types/index.js\";\nimport WebinyError from \"@webiny/error\";\nimport type { CmsContext } from \"~/types.js\";\nimport {\n    getElasticsearchIndexPrefix,\n    getLastAddedIndexPlugin,\n    isSharedElasticsearchIndex\n} from \"@webiny/api-elasticsearch\";\nimport type { ElasticsearchIndexRequestBody } from \"@webiny/api-elasticsearch/types.js\";\nimport { CmsEntryElasticsearchIndexPlugin } from \"~/plugins/index.js\";\n\ninterface ConfigurationsElasticsearch {\n    index: string;\n}\n\nexport interface CmsElasticsearchParams {\n    model: Pick<CmsModel, \"tenant\" | \"modelId\">;\n}\n\nexport interface ConfigurationsIndexSettingsParams {\n    context: CmsContext;\n}\n\nexport interface Configurations {\n    es: (params: CmsElasticsearchParams) => ConfigurationsElasticsearch;\n    indexSettings: (\n        params: ConfigurationsIndexSettingsParams\n    ) => Partial<ElasticsearchIndexRequestBody>;\n}\n\nexport const configurations: Configurations = {\n    es({ model }) {\n        const { tenant } = model;\n\n        if (!tenant) {\n            throw new WebinyError(\n                `Missing \"tenant\" parameter when trying to create Elasticsearch index name.`,\n                \"TENANT_ERROR\"\n            );\n        }\n\n        const sharedIndex = isSharedElasticsearchIndex();\n        const index = [sharedIndex ? \"root\" : tenant, \"headless-cms\", model.modelId]\n            .join(\"-\")\n            .toLowerCase();\n\n        const prefix = getElasticsearchIndexPrefix();\n\n        if (!prefix) {\n            return {\n                index\n            };\n        }\n        return {\n            index: prefix + index\n        };\n    },\n    indexSettings: ({ context }) => {\n        const plugin = getLastAddedIndexPlugin<CmsEntryElasticsearchIndexPlugin>({\n            container: context.plugins,\n            type: CmsEntryElasticsearchIndexPlugin.type\n        });\n\n        return plugin ? plugin.body : {};\n    }\n};\n"],"mappings":"AACA,OAAOA,WAAW,MAAM,eAAe;AAEvC,SACIC,2BAA2B,EAC3BC,uBAAuB,EACvBC,0BAA0B,QACvB,2BAA2B;AAElC,SAASC,gCAAgC;AAqBzC,OAAO,MAAMC,cAA8B,GAAG;EAC1CC,EAAEA,CAAC;IAAEC;EAAM,CAAC,EAAE;IACV,MAAM;MAAEC;IAAO,CAAC,GAAGD,KAAK;IAExB,IAAI,CAACC,MAAM,EAAE;MACT,MAAM,IAAIR,WAAW,CACjB,4EAA4E,EAC5E,cACJ,CAAC;IACL;IAEA,MAAMS,WAAW,GAAGN,0BAA0B,CAAC,CAAC;IAChD,MAAMO,KAAK,GAAG,CAACD,WAAW,GAAG,MAAM,GAAGD,MAAM,EAAE,cAAc,EAAED,KAAK,CAACI,OAAO,CAAC,CACvEC,IAAI,CAAC,GAAG,CAAC,CACTC,WAAW,CAAC,CAAC;IAElB,MAAMC,MAAM,GAAGb,2BAA2B,CAAC,CAAC;IAE5C,IAAI,CAACa,MAAM,EAAE;MACT,OAAO;QACHJ;MACJ,CAAC;IACL;IACA,OAAO;MACHA,KAAK,EAAEI,MAAM,GAAGJ;IACpB,CAAC;EACL,CAAC;EACDK,aAAa,EAAEA,CAAC;IAAEC;EAAQ,CAAC,KAAK;IAC5B,MAAMC,MAAM,GAAGf,uBAAuB,CAAmC;MACrEgB,SAAS,EAAEF,OAAO,CAACG,OAAO;MAC1BC,IAAI,EAAEhB,gCAAgC,CAACgB;IAC3C,CAAC,CAAC;IAEF,OAAOH,MAAM,GAAGA,MAAM,CAACI,IAAI,GAAG,CAAC,CAAC;EACpC;AACJ,CAAC","ignoreList":[]}

package/definitions/entry.d.ts

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

package/definitions/entry.js

@@ -1,90 +1,13 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createEntryEntity = void 0;
-
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
-var _dynamodbToolbox = require("dynamodb-toolbox");
-
-const createEntryEntity = params => {
+import { createStandardEntity } from "@webiny/db-dynamodb";
+export const createEntryEntity = params => {
   const {
     table,
-    entityName,
-    attributes
+    entityName
   } = params;
-  return new _dynamodbToolbox.Entity({
+  return createStandardEntity({
     name: entityName,
-    table,
-    attributes: (0, _objectSpread2.default)({
-      PK: {
-        type: "string",
-        partitionKey: true
-      },
-      SK: {
-        type: "string",
-        sortKey: true
-      },
-      TYPE: {
-        type: "string"
-      },
-      __type: {
-        type: "string"
-      },
-      webinyVersion: {
-        type: "string"
-      },
-      tenant: {
-        type: "string"
-      },
-      entryId: {
-        type: "string"
-      },
-      id: {
-        type: "string"
-      },
-      createdBy: {
-        type: "map"
-      },
-      ownedBy: {
-        type: "map"
-      },
-      createdOn: {
-        type: "string"
-      },
-      savedOn: {
-        type: "string"
-      },
-      modelId: {
-        type: "string"
-      },
-      locale: {
-        type: "string"
-      },
-      publishedOn: {
-        type: "string"
-      },
-      version: {
-        type: "number"
-      },
-      locked: {
-        type: "boolean"
-      },
-      status: {
-        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":["createEntryEntity","params","table","entityName","attributes","Entity","name","PK","type","partitionKey","SK","sortKey","TYPE","__type","webinyVersion","tenant","entryId","id","createdBy","ownedBy","createdOn","savedOn","modelId","locale","publishedOn","version","locked","status","values","meta"],"sources":["entry.ts"],"sourcesContent":["import { Entity, Table } from \"dynamodb-toolbox\";\nimport { Attributes } from \"~/types\";\n\nexport interface CreateEntryEntityParams {\n    table: Table;\n    entityName: string;\n    attributes: Attributes;\n}\nexport const createEntryEntity = (params: CreateEntryEntityParams): 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            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            createdBy: {\n                type: \"map\"\n            },\n            ownedBy: {\n                type: \"map\"\n            },\n            createdOn: {\n                type: \"string\"\n            },\n            savedOn: {\n                type: \"string\"\n            },\n            modelId: {\n                type: \"string\"\n            },\n            locale: {\n                type: \"string\"\n            },\n            publishedOn: {\n                type: \"string\"\n            },\n            version: {\n                type: \"number\"\n            },\n            locked: {\n                type: \"boolean\"\n            },\n            status: {\n                type: \"string\"\n            },\n            values: {\n                type: \"map\"\n            },\n            meta: {\n                type: \"map\"\n            },\n            ...(attributes || {})\n        }\n    });\n};\n"],"mappings":";;;;;;;;;;;AAAA;;AAQO,MAAMA,iBAAiB,GAAIC,MAAD,IAAkD;EAC/E,MAAM;IAAEC,KAAF;IAASC,UAAT;IAAqBC;EAArB,IAAoCH,MAA1C;EACA,OAAO,IAAII,uBAAJ,CAAW;IACdC,IAAI,EAAEH,UADQ;IAEdD,KAFc;IAGdE,UAAU;MACNG,EAAE,EAAE;QACAC,IAAI,EAAE,QADN;QAEAC,YAAY,EAAE;MAFd,CADE;MAKNC,EAAE,EAAE;QACAF,IAAI,EAAE,QADN;QAEAG,OAAO,EAAE;MAFT,CALE;MASNC,IAAI,EAAE;QACFJ,IAAI,EAAE;MADJ,CATA;MAYNK,MAAM,EAAE;QACJL,IAAI,EAAE;MADF,CAZF;MAeNM,aAAa,EAAE;QACXN,IAAI,EAAE;MADK,CAfT;MAkBNO,MAAM,EAAE;QACJP,IAAI,EAAE;MADF,CAlBF;MAqBNQ,OAAO,EAAE;QACLR,IAAI,EAAE;MADD,CArBH;MAwBNS,EAAE,EAAE;QACAT,IAAI,EAAE;MADN,CAxBE;MA2BNU,SAAS,EAAE;QACPV,IAAI,EAAE;MADC,CA3BL;MA8BNW,OAAO,EAAE;QACLX,IAAI,EAAE;MADD,CA9BH;MAiCNY,SAAS,EAAE;QACPZ,IAAI,EAAE;MADC,CAjCL;MAoCNa,OAAO,EAAE;QACLb,IAAI,EAAE;MADD,CApCH;MAuCNc,OAAO,EAAE;QACLd,IAAI,EAAE;MADD,CAvCH;MA0CNe,MAAM,EAAE;QACJf,IAAI,EAAE;MADF,CA1CF;MA6CNgB,WAAW,EAAE;QACThB,IAAI,EAAE;MADG,CA7CP;MAgDNiB,OAAO,EAAE;QACLjB,IAAI,EAAE;MADD,CAhDH;MAmDNkB,MAAM,EAAE;QACJlB,IAAI,EAAE;MADF,CAnDF;MAsDNmB,MAAM,EAAE;QACJnB,IAAI,EAAE;MADF,CAtDF;MAyDNoB,MAAM,EAAE;QACJpB,IAAI,EAAE;MADF,CAzDF;MA4DNqB,IAAI,EAAE;QACFrB,IAAI,EAAE;MADJ;IA5DA,GA+DFJ,UAAU,IAAI,EA/DZ;EAHI,CAAX,CAAP;AAqEH,CAvEM"}
+{"version":3,"names":["createStandardEntity","createEntryEntity","params","table","entityName","name"],"sources":["entry.ts"],"sourcesContent":["import { createStandardEntity, type ITable } from \"@webiny/db-dynamodb\";\nimport type { IEntryEntity, IEntryEntityAttributesData } from \"~/definitions/types.js\";\n\nexport interface CreateEntryEntityParams {\n    table: ITable;\n    entityName: string;\n}\nexport const createEntryEntity = (params: CreateEntryEntityParams): IEntryEntity => {\n    const { table, entityName } = params;\n    return createStandardEntity<IEntryEntityAttributesData>({\n        name: entityName,\n        table: table.table\n    });\n};\n"],"mappings":"AAAA,SAASA,oBAAoB,QAAqB,qBAAqB;AAOvE,OAAO,MAAMC,iBAAiB,GAAIC,MAA+B,IAAmB;EAChF,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,8 +1,8 @@
-import { Entity, Table } from "dynamodb-toolbox";
-import { Attributes } from "../types";
-export interface CreateGroupEntityParams {
-    table: Table;
+import { type ITable } from "@webiny/db-dynamodb";
+import type { IGroupEntity } from "../definitions/types.js";
+interface Params {
+    table: ITable;
     entityName: string;
-    attributes: Attributes;
 }
-export declare const createGroupEntity: (params: CreateGroupEntityParams) => Entity<any>;
+export declare const createGroupEntity: (params: Params) => IGroupEntity;
+export {};

package/definitions/group.js

@@ -1,70 +1,13 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createGroupEntity = void 0;
-
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
-var _dynamodbToolbox = require("dynamodb-toolbox");
-
-const createGroupEntity = params => {
+import { createStandardEntity } from "@webiny/db-dynamodb";
+export const createGroupEntity = params => {
   const {
     table,
-    attributes,
     entityName
   } = params;
-  return new _dynamodbToolbox.Entity({
-    name: entityName,
-    table,
-    attributes: (0, _objectSpread2.default)({
-      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":["createGroupEntity","params","table","attributes","entityName","Entity","name","PK","partitionKey","SK","sortKey","TYPE","type","webinyVersion","id","slug","locale","description","icon","createdBy","createdOn","savedOn","tenant"],"sources":["group.ts"],"sourcesContent":["import { Entity, Table } from \"dynamodb-toolbox\";\nimport { Attributes } from \"~/types\";\n\nexport interface CreateGroupEntityParams {\n    table: Table;\n    entityName: string;\n    attributes: Attributes;\n}\nexport const createGroupEntity = (params: CreateGroupEntityParams): 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;;AAQO,MAAMA,iBAAiB,GAAIC,MAAD,IAAkD;EAC/E,MAAM;IAAEC,KAAF;IAASC,UAAT;IAAqBC;EAArB,IAAoCH,MAA1C;EACA,OAAO,IAAII,uBAAJ,CAAW;IACdC,IAAI,EAAEF,UADQ;IAEdF,KAFc;IAGdC,UAAU;MACNI,EAAE,EAAE;QACAC,YAAY,EAAE;MADd,CADE;MAINC,EAAE,EAAE;QACAC,OAAO,EAAE;MADT,CAJE;MAONC,IAAI,EAAE;QACFC,IAAI,EAAE;MADJ,CAPA;MAUNC,aAAa,EAAE;QACXD,IAAI,EAAE;MADK,CAVT;MAaNE,EAAE,EAAE;QACAF,IAAI,EAAE;MADN,CAbE;MAgBNN,IAAI,EAAE;QACFM,IAAI,EAAE;MADJ,CAhBA;MAmBNG,IAAI,EAAE;QACFH,IAAI,EAAE;MADJ,CAnBA;MAsBNI,MAAM,EAAE;QACJJ,IAAI,EAAE;MADF,CAtBF;MAyBNK,WAAW,EAAE;QACTL,IAAI,EAAE;MADG,CAzBP;MA4BNM,IAAI,EAAE;QACFN,IAAI,EAAE;MADJ,CA5BA;MAgCNO,SAAS,EAAE;QACPP,IAAI,EAAE;MADC,CAhCL;MAmCNQ,SAAS,EAAE;QACPR,IAAI,EAAE;MADC,CAnCL;MAsCNS,OAAO,EAAE;QACLT,IAAI,EAAE;MADD,CAtCH;MAyCNU,MAAM,EAAE;QACJV,IAAI,EAAE;MADF;IAzCF,GA4CFT,UAAU,IAAI,EA5CZ;EAHI,CAAX,CAAP;AAkDH,CApDM"}
+{"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 \"~/definitions/types.js\";\nimport type { CmsGroup } from \"@webiny/api-headless-cms/types/index.js\";\n\ninterface Params {\n    table: ITable;\n    entityName: string;\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;AAQvE,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,8 +1,8 @@
-import { Entity, Table } from "dynamodb-toolbox";
-import { Attributes } from "../types";
-export interface CreateModelEntityParams {
-    table: Table;
+import { type ITable } from "@webiny/db-dynamodb";
+import type { IModelEntity } from "../definitions/types.js";
+interface Params {
+    table: ITable;
     entityName: string;
-    attributes: Attributes;
 }
-export declare const createModelEntity: (params: CreateModelEntityParams) => Entity<any>;
+export declare const createModelEntity: (params: Params) => IModelEntity;
+export {};

package/definitions/model.js

@@ -1,92 +1,13 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createModelEntity = void 0;
-
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
-var _dynamodbToolbox = require("dynamodb-toolbox");
-
-const createModelEntity = params => {
+import { createStandardEntity } from "@webiny/db-dynamodb";
+export const createModelEntity = params => {
   const {
     table,
-    attributes,
     entityName
   } = params;
-  return new _dynamodbToolbox.Entity({
-    name: entityName,
-    table,
-    attributes: (0, _objectSpread2.default)({
-      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
-      },
-      locale: {
-        type: "string",
-        required: true
-      },
-      group: {
-        type: "map",
-        required: true
-      },
-      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
-      },
-      lockedFields: {
-        type: "list",
-        required: true
-      },
-      titleFieldId: {
-        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":["createModelEntity","params","table","attributes","entityName","Entity","name","PK","partitionKey","SK","sortKey","TYPE","type","required","webinyVersion","modelId","locale","group","description","createdOn","savedOn","createdBy","fields","layout","lockedFields","titleFieldId","tenant"],"sources":["model.ts"],"sourcesContent":["import { Entity, Table } from \"dynamodb-toolbox\";\nimport { Attributes } from \"~/types\";\n\nexport interface CreateModelEntityParams {\n    table: Table;\n    entityName: string;\n    attributes: Attributes;\n}\n\nexport const createModelEntity = (params: CreateModelEntityParams): 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            locale: {\n                type: \"string\",\n                required: true\n            },\n            group: {\n                type: \"map\",\n                required: true\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            lockedFields: {\n                type: \"list\",\n                required: true\n            },\n            titleFieldId: {\n                type: \"string\"\n            },\n            tenant: {\n                type: \"string\",\n                required: true\n            },\n            ...(attributes || {})\n        }\n    });\n};\n"],"mappings":";;;;;;;;;;;AAAA;;AASO,MAAMA,iBAAiB,GAAIC,MAAD,IAAkD;EAC/E,MAAM;IAAEC,KAAF;IAASC,UAAT;IAAqBC;EAArB,IAAoCH,MAA1C;EACA,OAAO,IAAII,uBAAJ,CAAW;IACdC,IAAI,EAAEF,UADQ;IAEdF,KAFc;IAGdC,UAAU;MACNI,EAAE,EAAE;QACAC,YAAY,EAAE;MADd,CADE;MAINC,EAAE,EAAE;QACAC,OAAO,EAAE;MADT,CAJE;MAONC,IAAI,EAAE;QACFC,IAAI,EAAE,QADJ;QAEFC,QAAQ,EAAE;MAFR,CAPA;MAWNC,aAAa,EAAE;QACXF,IAAI,EAAE,QADK;QAEXC,QAAQ,EAAE;MAFC,CAXT;MAeNP,IAAI,EAAE;QACFM,IAAI,EAAE,QADJ;QAEFC,QAAQ,EAAE;MAFR,CAfA;MAmBNE,OAAO,EAAE;QACLH,IAAI,EAAE,QADD;QAELC,QAAQ,EAAE;MAFL,CAnBH;MAuBNG,MAAM,EAAE;QACJJ,IAAI,EAAE,QADF;QAEJC,QAAQ,EAAE;MAFN,CAvBF;MA2BNI,KAAK,EAAE;QACHL,IAAI,EAAE,KADH;QAEHC,QAAQ,EAAE;MAFP,CA3BD;MA+BNK,WAAW,EAAE;QACTN,IAAI,EAAE;MADG,CA/BP;MAkCNO,SAAS,EAAE;QACPP,IAAI,EAAE,QADC;QAEPC,QAAQ,EAAE;MAFH,CAlCL;MAsCNO,OAAO,EAAE;QACLR,IAAI,EAAE,QADD;QAELC,QAAQ,EAAE;MAFL,CAtCH;MA0CNQ,SAAS,EAAE;QACPT,IAAI,EAAE,KADC;QAEPC,QAAQ,EAAE;MAFH,CA1CL;MA8CNS,MAAM,EAAE;QACJV,IAAI,EAAE,MADF;QAEJC,QAAQ,EAAE;MAFN,CA9CF;MAkDNU,MAAM,EAAE;QACJX,IAAI,EAAE,MADF;QAEJC,QAAQ,EAAE;MAFN,CAlDF;MAsDNW,YAAY,EAAE;QACVZ,IAAI,EAAE,MADI;QAEVC,QAAQ,EAAE;MAFA,CAtDR;MA0DNY,YAAY,EAAE;QACVb,IAAI,EAAE;MADI,CA1DR;MA6DNc,MAAM,EAAE;QACJd,IAAI,EAAE,QADF;QAEJC,QAAQ,EAAE;MAFN;IA7DF,GAiEFV,UAAU,IAAI,EAjEZ;EAHI,CAAX,CAAP;AAuEH,CAzEM"}
+{"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 \"~/definitions/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/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 IEntryEntityAttributesData {
+    tenant: string;
+    entryId: string;
+    id: string;
+    modelId: 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<IEntryEntityAttributesData>;
+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 IEntryEntityAttributesData {\n    tenant: string;\n    entryId: string;\n    id: string;\n    modelId: string;\n\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<IEntryEntityAttributesData>;\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,3 @@
-declare const _default: () => import("@webiny/api-headless-cms").StorageTransformPlugin<any, any>[];
+declare const _default: () => import("@webiny/api-headless-cms/index.js").StorageTransformPlugin<any, any, import("@webiny/api-headless-cms/types/modelField.js").CmsModelField>[];
 export default _default;
+export declare const createDynamoDbPlugins: () => import("@webiny/api-headless-cms/index.js").StorageTransformPlugin<any, any, import("@webiny/api-headless-cms/types/modelField.js").CmsModelField>[];

package/dynamoDb/index.js

@@ -1,16 +1,8 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _richText = require("./storage/richText");
-
-var _longText = require("./storage/longText");
-
-var _date = require("./storage/date");
-
-var _default = () => [(0, _richText.createRichTextStorageTransformPlugin)(), (0, _longText.createLongTextStorageTransformPlugin)(), (0, _date.createDateStorageTransformPlugin)()];
-
-exports.default = _default;
+import { createRichTextStorageTransformPlugin } from "./storage/richText.js";
+import { createLongTextStorageTransformPlugin } from "./storage/longText.js";
+export default () => createDynamoDbPlugins();
+export const createDynamoDbPlugins = () => {
+  return [createRichTextStorageTransformPlugin(), createLongTextStorageTransformPlugin()];
+};
+
+//# sourceMappingURL=index.js.map

package/dynamoDb/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["createRichTextStorageTransformPlugin","createLongTextStorageTransformPlugin","createDateStorageTransformPlugin"],"sources":["index.ts"],"sourcesContent":["import { createRichTextStorageTransformPlugin } from \"./storage/richText\";\nimport { createLongTextStorageTransformPlugin } from \"./storage/longText\";\nimport { createDateStorageTransformPlugin } from \"./storage/date\";\n\nexport default () => [\n    createRichTextStorageTransformPlugin(),\n    createLongTextStorageTransformPlugin(),\n    createDateStorageTransformPlugin()\n];\n"],"mappings":";;;;;;;AAAA;;AACA;;AACA;;eAEe,MAAM,CACjB,IAAAA,8CAAA,GADiB,EAEjB,IAAAC,8CAAA,GAFiB,EAGjB,IAAAC,sCAAA,GAHiB,C"}
+{"version":3,"names":["createRichTextStorageTransformPlugin","createLongTextStorageTransformPlugin","createDynamoDbPlugins"],"sources":["index.ts"],"sourcesContent":["import { createRichTextStorageTransformPlugin } from \"./storage/richText.js\";\nimport { createLongTextStorageTransformPlugin } from \"./storage/longText.js\";\n\nexport default () => createDynamoDbPlugins();\n\nexport const createDynamoDbPlugins = () => {\n    return [createRichTextStorageTransformPlugin(), createLongTextStorageTransformPlugin()];\n};\n"],"mappings":"AAAA,SAASA,oCAAoC;AAC7C,SAASC,oCAAoC;AAE7C,eAAe,MAAMC,qBAAqB,CAAC,CAAC;AAE5C,OAAO,MAAMA,qBAAqB,GAAGA,CAAA,KAAM;EACvC,OAAO,CAACF,oCAAoC,CAAC,CAAC,EAAEC,oCAAoC,CAAC,CAAC,CAAC;AAC3F,CAAC","ignoreList":[]}

package/dynamoDb/storage/longText.d.ts

@@ -7,4 +7,4 @@ export interface StorageValue {
     value: string;
     isArray?: boolean;
 }
-export declare const createLongTextStorageTransformPlugin: () => StorageTransformPlugin<string | string[], StorageValue>;
+export declare const createLongTextStorageTransformPlugin: () => StorageTransformPlugin<string | string[], StorageValue, import("@webiny/api-headless-cms/types").CmsModelField>;