@webiny/api-headless-cms 0.0.0-unstable.9bd236cf5e → 0.0.0-unstable.9f53ea597d

package/README.md

@@ -1,73 +1,11 @@
 # @webiny/api-headless-cms
 
-[![](https://img.shields.io/npm/dw/@webiny/api-headless-cms.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms)
-[![](https://img.shields.io/npm/v/@webiny/api-headless-cms.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms)
-[![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
-```
+---
 
-Or if you prefer yarn:
-
-```
-yarn add @webiny/api-headless-cms
-```
-
-## Testing
-Due to possibility of multiple storage operations, the tests are completely decoupled from those storage operations.
-
-The [jest.setup.js](./jest.setup.js) is using [@webiny/project-utils/testing/presets.js](../project-utils/testing/presets/index.js) to find and load all the packages containing `@webiny/api-headless-cms` and `storage-operations` keywords in their `package.json` file.
-Those packages are then used to build the test run - one for each of the packages. So depending on how many storage operations there are in the repository, that much of `api-headless-cms` tests will run.
-
-### Defining test environment
-To make it possible for api-headless-cms tests to run with a storage operations package you MUST create `presets.js` file in `storage-operations-package-path/__tests__/__api__/` directory. That file is loaded when setting up the api-headless-cms tests.
-
-It MUST contain the `testEnvironment` variable which contains path to the environment definition file.
-
-That environment file MUST define the test environment which extends `NodeEnvironment` class.
-
-Test environment MUST expose `__getStorageOperationsPlugins` method, via `this.global` property of the class, which will load the required plugins in the `api-headless-cms` tests.
-
-
-### Examples of preset and test environment files
-
-The first implementation of the decoupled storage operations is DynamoDB/Elasticsearch, which you can find in [@webiny/api-headless-cms-ddb-es](../api-headless-cms-ddb-es).
-Files which you can check to help you define your own presets and test environment are:
-* [presets.js](../api-headless-cms-ddb-es/__tests__/__api__/presets.js) - an array of presets of which last one defines the environment to be loaded
-* [environment.js](../api-headless-cms-ddb-es/__tests__/__api__/environment.js) - a class which extends NodeEnvironment and exposes `__getStorageOperationsPlugins` to the tests
-
-### Debugging when testing
-For the WebStorm (PhpStorm,...) when starting a test you must have some values defined in the run/debug configurations screen:
-#### Node options
-`````
---inspect=9229
-`````
-#### Working directory
-`````
-PATH_TO_YOUR_PROJECT_ROOT
-`````
-example:
-````
-~/webiny/webiny-js/
-````
-#### Jest options
-For DynamoDB + Elasticsearch storage operations tests:
-`````
---keyword=cms:base --keyword=cms:ddb-es
-`````
-For the DynamoDB storage operations tests:
-`````
---keyword=cms:base --keyword=cms:ddb
-`````
-Note that base keyword is the `cms:base`. It tells Jest setup to load the `api-headless-cms` tests with the api-headless-cms-ddb-es tests.
-
-#### Environment variables
-If you want to use local Elasticsearch:
-`````
-ELASTICSEARCH_PORT=9200;LOCAL_ELASTICSEARCH=true
-`````
-Nothing if you do not want to use the local Elasticsearch.
+_This README file is automatically generated during the publish process._

package/abstractions/entryHooks/OnEntryBeforeCreate.d.ts

@@ -0,0 +1,8 @@
+import { Abstraction } from "@webiny/di";
+export interface IOnEntryBeforeCreate {
+    execute(): Promise<void>;
+}
+export declare const OnEntryBeforeCreate: Abstraction<IOnEntryBeforeCreate>;
+export declare namespace OnEntryBeforeCreate {
+    type Interface = IOnEntryBeforeCreate;
+}

package/abstractions/entryHooks/OnEntryBeforeCreate.js

@@ -0,0 +1,5 @@
+import { Abstraction } from "@webiny/di";
+const OnEntryBeforeCreate = new Abstraction("OnEntryBeforeCreate");
+export { OnEntryBeforeCreate };
+
+//# sourceMappingURL=OnEntryBeforeCreate.js.map

package/abstractions/entryHooks/OnEntryBeforeCreate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractions/entryHooks/OnEntryBeforeCreate.js","sources":["../../../src/abstractions/entryHooks/OnEntryBeforeCreate.ts"],"sourcesContent":["import { Abstraction } from \"@webiny/di\";\n\nexport interface IOnEntryBeforeCreate {\n    execute(): Promise<void>;\n}\n\nexport const OnEntryBeforeCreate = new Abstraction<IOnEntryBeforeCreate>(\"OnEntryBeforeCreate\");\n\nexport namespace OnEntryBeforeCreate {\n    export type Interface = IOnEntryBeforeCreate;\n}\n"],"names":["OnEntryBeforeCreate","Abstraction"],"mappings":";AAMO,MAAMA,sBAAsB,IAAIC,YAAkC"}

package/abstractions/entryHooks/index.d.ts

@@ -0,0 +1 @@
+export * from "./OnEntryBeforeCreate.js";

package/abstractions/entryHooks/index.js

@@ -0,0 +1 @@
+export * from "./OnEntryBeforeCreate.js";

package/abstractions/index.d.ts

@@ -0,0 +1 @@
+export * from "./entryHooks/index.js";

package/abstractions/index.js

@@ -0,0 +1 @@
+export * from "./entryHooks/index.js";

package/constants.d.ts

@@ -1,6 +1,6 @@
-import type { CmsIdentity } from "./types";
+import type { CmsIdentity, ICmsEntryLive } from "./types/index.js";
 export declare const ROOT_FOLDER = "root";
-export declare const CMS_MODEL_SINGLETON_TAG = "singleton";
+export declare const CMS_MODEL_SINGLETON_TAG = "singleEntry";
 export declare const ENTRY_META_FIELDS: readonly ["createdOn", "modifiedOn", "savedOn", "deletedOn", "restoredOn", "firstPublishedOn", "lastPublishedOn", "createdBy", "modifiedBy", "savedBy", "deletedBy", "restoredBy", "firstPublishedBy", "lastPublishedBy", "revisionCreatedOn", "revisionModifiedOn", "revisionSavedOn", "revisionDeletedOn", "revisionRestoredOn", "revisionFirstPublishedOn", "revisionLastPublishedOn", "revisionCreatedBy", "revisionModifiedBy", "revisionSavedBy", "revisionDeletedBy", "revisionRestoredBy", "revisionFirstPublishedBy", "revisionLastPublishedBy"];
 export type EntryMetaFieldName = (typeof ENTRY_META_FIELDS)[number];
 export interface RecordWithEntryMetaFields {
@@ -32,8 +32,9 @@ export interface RecordWithEntryMetaFields {
     restoredBy: CmsIdentity | null;
     firstPublishedBy: CmsIdentity | null;
     lastPublishedBy: CmsIdentity | null;
+    live: ICmsEntryLive | null;
 }
-export declare const pickEntryMetaFields: (object: Partial<RecordWithEntryMetaFields>, filter?: ((fieldName: EntryMetaFieldName | string) => boolean) | undefined) => Partial<RecordWithEntryMetaFields>;
+export declare const pickEntryMetaFields: (object: Partial<RecordWithEntryMetaFields>, filter?: (fieldName: EntryMetaFieldName | string) => boolean) => Partial<RecordWithEntryMetaFields>;
 export declare const isNullableEntryMetaField: (fieldName: string) => boolean;
 export declare const isNonNullableEntryMetaField: (fieldName: string) => boolean;
 export declare const isDateTimeEntryMetaField: (fieldName: string) => boolean;

package/constants.js

@@ -1,70 +1,59 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.pickEntryMetaFields = exports.isRevisionEntryMetaField = exports.isRestoredEntryMetaField = exports.isNullableEntryMetaField = exports.isNonNullableEntryMetaField = exports.isIdentityEntryMetaField = exports.isEntryLevelEntryMetaField = exports.isDeletedEntryMetaField = exports.isDateTimeEntryMetaField = exports.ROOT_FOLDER = exports.ENTRY_META_FIELDS = exports.CMS_MODEL_SINGLETON_TAG = void 0;
-const ROOT_FOLDER = exports.ROOT_FOLDER = "root";
-const CMS_MODEL_SINGLETON_TAG = exports.CMS_MODEL_SINGLETON_TAG = "singleton";
-
-// Content entries - xOn and xBy meta fields.
-const ENTRY_META_FIELDS = exports.ENTRY_META_FIELDS = [
-// Entry-level meta fields.
-"createdOn", "modifiedOn", "savedOn", "deletedOn", "restoredOn", "firstPublishedOn", "lastPublishedOn", "createdBy", "modifiedBy", "savedBy", "deletedBy", "restoredBy", "firstPublishedBy", "lastPublishedBy",
-// Revision-level meta fields.
-"revisionCreatedOn", "revisionModifiedOn", "revisionSavedOn", "revisionDeletedOn", "revisionRestoredOn", "revisionFirstPublishedOn", "revisionLastPublishedOn", "revisionCreatedBy", "revisionModifiedBy", "revisionSavedBy", "revisionDeletedBy", "revisionRestoredBy", "revisionFirstPublishedBy", "revisionLastPublishedBy"];
-const pickEntryMetaFields = (object, filter) => {
-  const pickedEntryMetaFields = {};
-  for (const entryMetaFieldName of ENTRY_META_FIELDS) {
-    const fieldExists = entryMetaFieldName in object;
-    if (!fieldExists) {
-      object[entryMetaFieldName] = undefined;
-    }
-    const mustPick = !filter || filter(entryMetaFieldName);
-    if (mustPick) {
-      Object.assign(pickedEntryMetaFields, {
-        [entryMetaFieldName]: object[entryMetaFieldName]
-      });
+const ROOT_FOLDER = "root";
+const CMS_MODEL_SINGLETON_TAG = "singleEntry";
+const ENTRY_META_FIELDS = [
+    "createdOn",
+    "modifiedOn",
+    "savedOn",
+    "deletedOn",
+    "restoredOn",
+    "firstPublishedOn",
+    "lastPublishedOn",
+    "createdBy",
+    "modifiedBy",
+    "savedBy",
+    "deletedBy",
+    "restoredBy",
+    "firstPublishedBy",
+    "lastPublishedBy",
+    "revisionCreatedOn",
+    "revisionModifiedOn",
+    "revisionSavedOn",
+    "revisionDeletedOn",
+    "revisionRestoredOn",
+    "revisionFirstPublishedOn",
+    "revisionLastPublishedOn",
+    "revisionCreatedBy",
+    "revisionModifiedBy",
+    "revisionSavedBy",
+    "revisionDeletedBy",
+    "revisionRestoredBy",
+    "revisionFirstPublishedBy",
+    "revisionLastPublishedBy"
+];
+const pickEntryMetaFields = (object, filter)=>{
+    const pickedEntryMetaFields = {};
+    for (const entryMetaFieldName of ENTRY_META_FIELDS){
+        const fieldExists = entryMetaFieldName in object;
+        if (!fieldExists) object[entryMetaFieldName] = void 0;
+        const mustPick = !filter || filter(entryMetaFieldName);
+        if (mustPick) Object.assign(pickedEntryMetaFields, {
+            [entryMetaFieldName]: object[entryMetaFieldName]
+        });
     }
-  }
-  return pickedEntryMetaFields;
-};
-exports.pickEntryMetaFields = pickEntryMetaFields;
-const isNullableEntryMetaField = fieldName => {
-  // Only modifiedX, publishedX, deletedX fields are nullable.
-  const lcFieldName = fieldName.toLowerCase();
-  return lcFieldName.includes("modified") || lcFieldName.includes("published") || lcFieldName.includes("deleted") || lcFieldName.includes("restored");
-};
-exports.isNullableEntryMetaField = isNullableEntryMetaField;
-const isNonNullableEntryMetaField = fieldName => {
-  return !isNullableEntryMetaField(fieldName);
-};
-exports.isNonNullableEntryMetaField = isNonNullableEntryMetaField;
-const isDateTimeEntryMetaField = fieldName => {
-  // Only field ending with "On" are date/time fields.
-  return fieldName.endsWith("On");
-};
-exports.isDateTimeEntryMetaField = isDateTimeEntryMetaField;
-const isIdentityEntryMetaField = fieldName => {
-  // Only field ending with "On" are date/time fields.
-  return fieldName.endsWith("By");
-};
-exports.isIdentityEntryMetaField = isIdentityEntryMetaField;
-const isRevisionEntryMetaField = fieldName => {
-  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.startsWith("revision");
-};
-exports.isRevisionEntryMetaField = isRevisionEntryMetaField;
-const isEntryLevelEntryMetaField = fieldName => {
-  return ENTRY_META_FIELDS.includes(fieldName) && !fieldName.startsWith("revision");
-};
-exports.isEntryLevelEntryMetaField = isEntryLevelEntryMetaField;
-const isDeletedEntryMetaField = fieldName => {
-  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("deleted");
-};
-exports.isDeletedEntryMetaField = isDeletedEntryMetaField;
-const isRestoredEntryMetaField = fieldName => {
-  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("restored");
-};
-exports.isRestoredEntryMetaField = isRestoredEntryMetaField;
+    pickedEntryMetaFields.live = object.live;
+    return pickedEntryMetaFields;
+};
+const isNullableEntryMetaField = (fieldName)=>{
+    const lcFieldName = fieldName.toLowerCase();
+    return lcFieldName.includes("modified") || lcFieldName.includes("published") || lcFieldName.includes("deleted") || lcFieldName.includes("restored");
+};
+const isNonNullableEntryMetaField = (fieldName)=>!isNullableEntryMetaField(fieldName);
+const isDateTimeEntryMetaField = (fieldName)=>fieldName.endsWith("On");
+const isIdentityEntryMetaField = (fieldName)=>fieldName.endsWith("By");
+const isRevisionEntryMetaField = (fieldName)=>ENTRY_META_FIELDS.includes(fieldName) && fieldName.startsWith("revision");
+const isEntryLevelEntryMetaField = (fieldName)=>ENTRY_META_FIELDS.includes(fieldName) && !fieldName.startsWith("revision");
+const isDeletedEntryMetaField = (fieldName)=>ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("deleted");
+const isRestoredEntryMetaField = (fieldName)=>ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("restored");
+export { CMS_MODEL_SINGLETON_TAG, ENTRY_META_FIELDS, ROOT_FOLDER, isDateTimeEntryMetaField, isDeletedEntryMetaField, isEntryLevelEntryMetaField, isIdentityEntryMetaField, isNonNullableEntryMetaField, isNullableEntryMetaField, isRestoredEntryMetaField, isRevisionEntryMetaField, pickEntryMetaFields };
 
 //# sourceMappingURL=constants.js.map

package/constants.js.map

@@ -1 +1 @@
-{"version":3,"names":["ROOT_FOLDER","exports","CMS_MODEL_SINGLETON_TAG","ENTRY_META_FIELDS","pickEntryMetaFields","object","filter","pickedEntryMetaFields","entryMetaFieldName","fieldExists","undefined","mustPick","Object","assign","isNullableEntryMetaField","fieldName","lcFieldName","toLowerCase","includes","isNonNullableEntryMetaField","isDateTimeEntryMetaField","endsWith","isIdentityEntryMetaField","isRevisionEntryMetaField","startsWith","isEntryLevelEntryMetaField","isDeletedEntryMetaField","isRestoredEntryMetaField"],"sources":["constants.ts"],"sourcesContent":["import type { CmsIdentity } from \"~/types\";\n\nexport const ROOT_FOLDER = \"root\";\n\nexport const CMS_MODEL_SINGLETON_TAG = \"singleton\";\n\n// Content entries - xOn and xBy meta fields.\nexport const ENTRY_META_FIELDS = [\n    // Entry-level meta fields.\n    \"createdOn\",\n    \"modifiedOn\",\n    \"savedOn\",\n    \"deletedOn\",\n    \"restoredOn\",\n    \"firstPublishedOn\",\n    \"lastPublishedOn\",\n    \"createdBy\",\n    \"modifiedBy\",\n    \"savedBy\",\n    \"deletedBy\",\n    \"restoredBy\",\n    \"firstPublishedBy\",\n    \"lastPublishedBy\",\n\n    // Revision-level meta fields.\n    \"revisionCreatedOn\",\n    \"revisionModifiedOn\",\n    \"revisionSavedOn\",\n    \"revisionDeletedOn\",\n    \"revisionRestoredOn\",\n    \"revisionFirstPublishedOn\",\n    \"revisionLastPublishedOn\",\n    \"revisionCreatedBy\",\n    \"revisionModifiedBy\",\n    \"revisionSavedBy\",\n    \"revisionDeletedBy\",\n    \"revisionRestoredBy\",\n    \"revisionFirstPublishedBy\",\n    \"revisionLastPublishedBy\"\n] as const;\n\nexport type EntryMetaFieldName = (typeof ENTRY_META_FIELDS)[number];\n\nexport interface RecordWithEntryMetaFields {\n    revisionCreatedOn: string;\n    revisionSavedOn: string;\n    revisionModifiedOn: string | null;\n    revisionDeletedOn: string | null;\n    revisionRestoredOn: string | null;\n    revisionFirstPublishedOn: string | null;\n    revisionLastPublishedOn: string | null;\n    revisionCreatedBy: CmsIdentity;\n    revisionSavedBy: CmsIdentity;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionRestoredBy: CmsIdentity | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n\n    // Entry-level meta fields.\n    createdOn: string;\n    savedOn: string;\n    modifiedOn: string | null;\n    deletedOn: string | null;\n    restoredOn: string | null;\n    firstPublishedOn: string | null;\n    lastPublishedOn: string | null;\n    createdBy: CmsIdentity;\n    savedBy: CmsIdentity;\n    modifiedBy: CmsIdentity | null;\n    deletedBy: CmsIdentity | null;\n    restoredBy: CmsIdentity | null;\n    firstPublishedBy: CmsIdentity | null;\n    lastPublishedBy: CmsIdentity | null;\n}\n\nexport const pickEntryMetaFields = (\n    object: Partial<RecordWithEntryMetaFields>,\n    filter?: (fieldName: EntryMetaFieldName | string) => boolean\n) => {\n    const pickedEntryMetaFields: Partial<RecordWithEntryMetaFields> = {};\n    for (const entryMetaFieldName of ENTRY_META_FIELDS) {\n        const fieldExists = entryMetaFieldName in object;\n        if (!fieldExists) {\n            object[entryMetaFieldName] = undefined;\n        }\n\n        const mustPick = !filter || filter(entryMetaFieldName);\n        if (mustPick) {\n            Object.assign(pickedEntryMetaFields, {\n                [entryMetaFieldName]: object[entryMetaFieldName]\n            });\n        }\n    }\n\n    return pickedEntryMetaFields;\n};\n\nexport const isNullableEntryMetaField = (fieldName: string) => {\n    // Only modifiedX, publishedX, deletedX fields are nullable.\n    const lcFieldName = fieldName.toLowerCase();\n    return (\n        lcFieldName.includes(\"modified\") ||\n        lcFieldName.includes(\"published\") ||\n        lcFieldName.includes(\"deleted\") ||\n        lcFieldName.includes(\"restored\")\n    );\n};\n\nexport const isNonNullableEntryMetaField = (fieldName: string) => {\n    return !isNullableEntryMetaField(fieldName);\n};\n\nexport const isDateTimeEntryMetaField = (fieldName: string) => {\n    // Only field ending with \"On\" are date/time fields.\n    return fieldName.endsWith(\"On\");\n};\n\nexport const isIdentityEntryMetaField = (fieldName: string) => {\n    // Only field ending with \"On\" are date/time fields.\n    return fieldName.endsWith(\"By\");\n};\n\nexport const isRevisionEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        fieldName.startsWith(\"revision\")\n    );\n};\n\nexport const isEntryLevelEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        !fieldName.startsWith(\"revision\")\n    );\n};\n\nexport const isDeletedEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) && fieldName.includes(\"deleted\")\n    );\n};\n\nexport const isRestoredEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        fieldName.includes(\"restored\")\n    );\n};\n"],"mappings":";;;;;;AAEO,MAAMA,WAAW,GAAAC,OAAA,CAAAD,WAAA,GAAG,MAAM;AAE1B,MAAME,uBAAuB,GAAAD,OAAA,CAAAC,uBAAA,GAAG,WAAW;;AAElD;AACO,MAAMC,iBAAiB,GAAAF,OAAA,CAAAE,iBAAA,GAAG;AAC7B;AACA,WAAW,EACX,YAAY,EACZ,SAAS,EACT,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,SAAS,EACT,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,iBAAiB;AAEjB;AACA,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,yBAAyB,CACnB;AAqCH,MAAMC,mBAAmB,GAAGA,CAC/BC,MAA0C,EAC1CC,MAA4D,KAC3D;EACD,MAAMC,qBAAyD,GAAG,CAAC,CAAC;EACpE,KAAK,MAAMC,kBAAkB,IAAIL,iBAAiB,EAAE;IAChD,MAAMM,WAAW,GAAGD,kBAAkB,IAAIH,MAAM;IAChD,IAAI,CAACI,WAAW,EAAE;MACdJ,MAAM,CAACG,kBAAkB,CAAC,GAAGE,SAAS;IAC1C;IAEA,MAAMC,QAAQ,GAAG,CAACL,MAAM,IAAIA,MAAM,CAACE,kBAAkB,CAAC;IACtD,IAAIG,QAAQ,EAAE;MACVC,MAAM,CAACC,MAAM,CAACN,qBAAqB,EAAE;QACjC,CAACC,kBAAkB,GAAGH,MAAM,CAACG,kBAAkB;MACnD,CAAC,CAAC;IACN;EACJ;EAEA,OAAOD,qBAAqB;AAChC,CAAC;AAACN,OAAA,CAAAG,mBAAA,GAAAA,mBAAA;AAEK,MAAMU,wBAAwB,GAAIC,SAAiB,IAAK;EAC3D;EACA,MAAMC,WAAW,GAAGD,SAAS,CAACE,WAAW,CAAC,CAAC;EAC3C,OACID,WAAW,CAACE,QAAQ,CAAC,UAAU,CAAC,IAChCF,WAAW,CAACE,QAAQ,CAAC,WAAW,CAAC,IACjCF,WAAW,CAACE,QAAQ,CAAC,SAAS,CAAC,IAC/BF,WAAW,CAACE,QAAQ,CAAC,UAAU,CAAC;AAExC,CAAC;AAACjB,OAAA,CAAAa,wBAAA,GAAAA,wBAAA;AAEK,MAAMK,2BAA2B,GAAIJ,SAAiB,IAAK;EAC9D,OAAO,CAACD,wBAAwB,CAACC,SAAS,CAAC;AAC/C,CAAC;AAACd,OAAA,CAAAkB,2BAAA,GAAAA,2BAAA;AAEK,MAAMC,wBAAwB,GAAIL,SAAiB,IAAK;EAC3D;EACA,OAAOA,SAAS,CAACM,QAAQ,CAAC,IAAI,CAAC;AACnC,CAAC;AAACpB,OAAA,CAAAmB,wBAAA,GAAAA,wBAAA;AAEK,MAAME,wBAAwB,GAAIP,SAAiB,IAAK;EAC3D;EACA,OAAOA,SAAS,CAACM,QAAQ,CAAC,IAAI,CAAC;AACnC,CAAC;AAACpB,OAAA,CAAAqB,wBAAA,GAAAA,wBAAA;AAEK,MAAMC,wBAAwB,GAAIR,SAAiB,IAAK;EAC3D,OACIZ,iBAAiB,CAACe,QAAQ,CAACH,SAA+B,CAAC,IAC3DA,SAAS,CAACS,UAAU,CAAC,UAAU,CAAC;AAExC,CAAC;AAACvB,OAAA,CAAAsB,wBAAA,GAAAA,wBAAA;AAEK,MAAME,0BAA0B,GAAIV,SAAiB,IAAK;EAC7D,OACIZ,iBAAiB,CAACe,QAAQ,CAACH,SAA+B,CAAC,IAC3D,CAACA,SAAS,CAACS,UAAU,CAAC,UAAU,CAAC;AAEzC,CAAC;AAACvB,OAAA,CAAAwB,0BAAA,GAAAA,0BAAA;AAEK,MAAMC,uBAAuB,GAAIX,SAAiB,IAAK;EAC1D,OACIZ,iBAAiB,CAACe,QAAQ,CAACH,SAA+B,CAAC,IAAIA,SAAS,CAACG,QAAQ,CAAC,SAAS,CAAC;AAEpG,CAAC;AAACjB,OAAA,CAAAyB,uBAAA,GAAAA,uBAAA;AAEK,MAAMC,wBAAwB,GAAIZ,SAAiB,IAAK;EAC3D,OACIZ,iBAAiB,CAACe,QAAQ,CAACH,SAA+B,CAAC,IAC3DA,SAAS,CAACG,QAAQ,CAAC,UAAU,CAAC;AAEtC,CAAC;AAACjB,OAAA,CAAA0B,wBAAA,GAAAA,wBAAA","ignoreList":[]}
+{"version":3,"file":"constants.js","sources":["../src/constants.ts"],"sourcesContent":["import type { CmsIdentity, ICmsEntryLive } from \"~/types/index.js\";\n\nexport const ROOT_FOLDER = \"root\";\n\nexport const CMS_MODEL_SINGLETON_TAG = \"singleEntry\";\n\n// Content entries - xOn and xBy meta fields.\nexport const ENTRY_META_FIELDS = [\n    // Entry-level meta fields.\n    \"createdOn\",\n    \"modifiedOn\",\n    \"savedOn\",\n    \"deletedOn\",\n    \"restoredOn\",\n    \"firstPublishedOn\",\n    \"lastPublishedOn\",\n    \"createdBy\",\n    \"modifiedBy\",\n    \"savedBy\",\n    \"deletedBy\",\n    \"restoredBy\",\n    \"firstPublishedBy\",\n    \"lastPublishedBy\",\n\n    // Revision-level meta fields.\n    \"revisionCreatedOn\",\n    \"revisionModifiedOn\",\n    \"revisionSavedOn\",\n    \"revisionDeletedOn\",\n    \"revisionRestoredOn\",\n    \"revisionFirstPublishedOn\",\n    \"revisionLastPublishedOn\",\n    \"revisionCreatedBy\",\n    \"revisionModifiedBy\",\n    \"revisionSavedBy\",\n    \"revisionDeletedBy\",\n    \"revisionRestoredBy\",\n    \"revisionFirstPublishedBy\",\n    \"revisionLastPublishedBy\"\n] as const;\n\nexport type EntryMetaFieldName = (typeof ENTRY_META_FIELDS)[number];\n\nexport interface RecordWithEntryMetaFields {\n    revisionCreatedOn: string;\n    revisionSavedOn: string;\n    revisionModifiedOn: string | null;\n    revisionDeletedOn: string | null;\n    revisionRestoredOn: string | null;\n    revisionFirstPublishedOn: string | null;\n    revisionLastPublishedOn: string | null;\n    revisionCreatedBy: CmsIdentity;\n    revisionSavedBy: CmsIdentity;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionRestoredBy: CmsIdentity | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n\n    // Entry-level meta fields.\n    createdOn: string;\n    savedOn: string;\n    modifiedOn: string | null;\n    deletedOn: string | null;\n    restoredOn: string | null;\n    firstPublishedOn: string | null;\n    lastPublishedOn: string | null;\n    createdBy: CmsIdentity;\n    savedBy: CmsIdentity;\n    modifiedBy: CmsIdentity | null;\n    deletedBy: CmsIdentity | null;\n    restoredBy: CmsIdentity | null;\n    firstPublishedBy: CmsIdentity | null;\n    lastPublishedBy: CmsIdentity | null;\n    live: ICmsEntryLive | null;\n}\n\nexport const pickEntryMetaFields = (\n    object: Partial<RecordWithEntryMetaFields>,\n    filter?: (fieldName: EntryMetaFieldName | string) => boolean\n) => {\n    const pickedEntryMetaFields: Partial<RecordWithEntryMetaFields> = {};\n    for (const entryMetaFieldName of ENTRY_META_FIELDS) {\n        const fieldExists = entryMetaFieldName in object;\n        if (!fieldExists) {\n            object[entryMetaFieldName] = undefined;\n        }\n\n        const mustPick = !filter || filter(entryMetaFieldName);\n        if (mustPick) {\n            Object.assign(pickedEntryMetaFields, {\n                [entryMetaFieldName]: object[entryMetaFieldName]\n            });\n        }\n    }\n    /**\n     * Also add live field, as it's not part of entry meta fields, but it's required to be transfered.\n     */\n    pickedEntryMetaFields.live = object.live;\n\n    return pickedEntryMetaFields;\n};\n\nexport const isNullableEntryMetaField = (fieldName: string) => {\n    // Only modifiedX, publishedX, deletedX fields are nullable.\n    const lcFieldName = fieldName.toLowerCase();\n    return (\n        lcFieldName.includes(\"modified\") ||\n        lcFieldName.includes(\"published\") ||\n        lcFieldName.includes(\"deleted\") ||\n        lcFieldName.includes(\"restored\")\n    );\n};\n\nexport const isNonNullableEntryMetaField = (fieldName: string) => {\n    return !isNullableEntryMetaField(fieldName);\n};\n\nexport const isDateTimeEntryMetaField = (fieldName: string) => {\n    // Only field ending with \"On\" are date/time fields.\n    return fieldName.endsWith(\"On\");\n};\n\nexport const isIdentityEntryMetaField = (fieldName: string) => {\n    // Only field ending with \"On\" are date/time fields.\n    return fieldName.endsWith(\"By\");\n};\n\nexport const isRevisionEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        fieldName.startsWith(\"revision\")\n    );\n};\n\nexport const isEntryLevelEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        !fieldName.startsWith(\"revision\")\n    );\n};\n\nexport const isDeletedEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) && fieldName.includes(\"deleted\")\n    );\n};\n\nexport const isRestoredEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        fieldName.includes(\"restored\")\n    );\n};\n"],"names":["ROOT_FOLDER","CMS_MODEL_SINGLETON_TAG","ENTRY_META_FIELDS","pickEntryMetaFields","object","filter","pickedEntryMetaFields","entryMetaFieldName","fieldExists","undefined","mustPick","Object","isNullableEntryMetaField","fieldName","lcFieldName","isNonNullableEntryMetaField","isDateTimeEntryMetaField","isIdentityEntryMetaField","isRevisionEntryMetaField","isEntryLevelEntryMetaField","isDeletedEntryMetaField","isRestoredEntryMetaField"],"mappings":"AAEO,MAAMA,cAAc;AAEpB,MAAMC,0BAA0B;AAGhC,MAAMC,oBAAoB;IAE7B;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IAGA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACH;AAsCM,MAAMC,sBAAsB,CAC/BC,QACAC;IAEA,MAAMC,wBAA4D,CAAC;IACnE,KAAK,MAAMC,sBAAsBL,kBAAmB;QAChD,MAAMM,cAAcD,sBAAsBH;QAC1C,IAAI,CAACI,aACDJ,MAAM,CAACG,mBAAmB,GAAGE;QAGjC,MAAMC,WAAW,CAACL,UAAUA,OAAOE;QACnC,IAAIG,UACAC,OAAO,MAAM,CAACL,uBAAuB;YACjC,CAACC,mBAAmB,EAAEH,MAAM,CAACG,mBAAmB;QACpD;IAER;IAIAD,sBAAsB,IAAI,GAAGF,OAAO,IAAI;IAExC,OAAOE;AACX;AAEO,MAAMM,2BAA2B,CAACC;IAErC,MAAMC,cAAcD,UAAU,WAAW;IACzC,OACIC,YAAY,QAAQ,CAAC,eACrBA,YAAY,QAAQ,CAAC,gBACrBA,YAAY,QAAQ,CAAC,cACrBA,YAAY,QAAQ,CAAC;AAE7B;AAEO,MAAMC,8BAA8B,CAACF,YACjC,CAACD,yBAAyBC;AAG9B,MAAMG,2BAA2B,CAACH,YAE9BA,UAAU,QAAQ,CAAC;AAGvB,MAAMI,2BAA2B,CAACJ,YAE9BA,UAAU,QAAQ,CAAC;AAGvB,MAAMK,2BAA2B,CAACL,YAEjCX,kBAAkB,QAAQ,CAACW,cAC3BA,UAAU,UAAU,CAAC;AAItB,MAAMM,6BAA6B,CAACN,YAEnCX,kBAAkB,QAAQ,CAACW,cAC3B,CAACA,UAAU,UAAU,CAAC;AAIvB,MAAMO,0BAA0B,CAACP,YAEhCX,kBAAkB,QAAQ,CAACW,cAAoCA,UAAU,QAAQ,CAAC;AAInF,MAAMQ,2BAA2B,CAACR,YAEjCX,kBAAkB,QAAQ,CAACW,cAC3BA,UAAU,QAAQ,CAAC"}

package/context.d.ts

@@ -1,6 +1,3 @@
-import type { CmsContext, HeadlessCmsStorageOperations } from "./types";
+import type { CmsContext } from "./types/index.js";
 import { ContextPlugin } from "@webiny/api";
-export interface CrudParams {
-    storageOperations: HeadlessCmsStorageOperations;
-}
-export declare const createContextPlugin: ({ storageOperations }: CrudParams) => ContextPlugin<CmsContext>;
+export declare const createContextPlugin: () => ContextPlugin<CmsContext>;

package/context.js

@@ -1,164 +1,131 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createContextPlugin = void 0;
-var _error = _interopRequireDefault(require("@webiny/error"));
-var _api = require("@webiny/api");
-var _handlerGraphql = require("@webiny/handler-graphql");
-var _CmsParametersPlugin = require("./plugins/CmsParametersPlugin");
-var _AccessControl = require("./crud/AccessControl/AccessControl");
-var _system = require("./crud/system.crud");
-var _contentModelGroup = require("./crud/contentModelGroup.crud");
-var _contentModel = require("./crud/contentModel.crud");
-var _contentEntry = require("./crud/contentEntry.crud");
-var _plugins = require("./plugins");
-var _valueKeyStorageConverter = require("./utils/converters/valueKeyStorageConverter");
-var _export = require("./export");
-var _importing = require("./export/crud/importing");
-var _getSchema = require("./graphql/getSchema");
-const getParameters = async context => {
-  const plugins = context.plugins.byType(_CmsParametersPlugin.CmsParametersPlugin.type);
-  for (const plugin of plugins) {
-    const result = await plugin.getParameters(context);
-    if (result !== null) {
-      return result;
+import error from "@webiny/error";
+import { ContextPlugin } from "@webiny/api";
+import { processRequestBody } from "@webiny/handler-graphql";
+import { CmsParametersPlugin } from "./plugins/CmsParametersPlugin.js";
+import { AccessControl } from "./crud/AccessControl/AccessControl.js";
+import { createModelGroupsCrud } from "./crud/contentModelGroup.crud.js";
+import { createModelsCrud } from "./crud/contentModel.crud.js";
+import { createContentEntryCrud } from "./crud/contentEntry.crud.js";
+import { StorageOperationsCmsModelPlugin } from "./plugins/index.js";
+import { createCmsModelFieldConvertersAttachFactory } from "./utils/converters/valueKeyStorageConverter.js";
+import { createExportCrud } from "./export/index.js";
+import { createImportCrud } from "./export/crud/importing.js";
+import { getSchema } from "./graphql/getSchema.js";
+import { CmsInstallerFeature } from "./features/installer/feature.js";
+import { ContentEntriesFeature } from "./features/contentEntry/ContentEntriesFeature.js";
+import { AccessControl as abstractions_js_AccessControl, CmsContext, StorageOperations, StorageOperationsFactory } from "./features/shared/abstractions.js";
+import { EntryFromStorageTransform, EntryToStorageTransform, PluginsContainer, SearchableFieldsProvider } from "./legacy/abstractions.js";
+import { entryFromStorageTransform, entryToStorageTransform } from "./utils/entryStorage.js";
+import { getSearchableFields } from "./crud/contentEntry/searchableFields.js";
+import { ContentModelGroupFeature } from "./features/contentModelGroup/ContentModelGroupFeature.js";
+import { ContentModelFeature } from "./features/contentModel/ContentModelFeature.js";
+import { ModelBuilderFeature } from "./features/modelBuilder/index.js";
+import { CmsWhereMapperFeature } from "./features/whereMapper/feature.js";
+import { CmsSortMapperFeature } from "./features/sortMapper/feature.js";
+import { GraphQLFeature } from "./features/graphql/index.js";
+import { ValidationFeature } from "./features/validation/index.js";
+import { StorageFeature } from "./features/storage/index.js";
+import { CmsWebhooksFeature } from "./features/webhooks/feature.js";
+const getParameters = async (context)=>{
+    const plugins = context.plugins.byType(CmsParametersPlugin.type);
+    for (const plugin of plugins){
+        const result = await plugin.getParameters(context);
+        if (null !== result) return result;
     }
-  }
-  throw new _error.default("Could not determine locale and/or type of the CMS.", "CMS_LOCALE_AND_TYPE_ERROR");
+    throw new error("Could not determine type of the CMS.", "CMS_TYPE_ERROR");
 };
-const createContextPlugin = ({
-  storageOperations
-}) => {
-  const plugin = new _api.ContextPlugin(async context => {
-    const {
-      type,
-      locale: localeCode
-    } = await getParameters(context);
-    if (localeCode) {
-      const locale = context.i18n.getLocale(localeCode);
-      if (locale) {
-        context.i18n.setContentLocale(locale);
-      }
-    }
-    const getLocale = () => {
-      const locale = context.i18n.getContentLocale();
-      if (!locale) {
-        throw new _error.default("Missing content locale in cms context.ts.", "LOCALE_ERROR");
-      }
-      return locale;
-    };
-    const getIdentity = () => {
-      return context.security.getIdentity();
-    };
-    const getTenant = () => {
-      return context.tenancy.getCurrentTenant();
-    };
-    const setSchemaType = type => {
-      if (!type) {
-        return;
-      }
-      context.cms.type = type;
-      switch (type) {
-        case "read":
-          context.cms.READ = true;
-          break;
-        case "preview":
-          context.cms.PREVIEW = true;
-          break;
-        default:
-          context.cms.MANAGE = true;
-      }
-    };
-    async function getExecutableSchema(type) {
-      const originalType = context.cms.type;
-      setSchemaType(type);
-      const schema = await context.security.withoutAuthorization(() => {
-        return (0, _getSchema.getSchema)({
-          context,
-          getTenant,
-          getLocale,
-          type
-        });
-      });
-      setSchemaType(originalType);
-      return async input => {
-        return (0, _handlerGraphql.processRequestBody)(input, schema, context);
-      };
-    }
-    context.plugins.register(new _plugins.StorageOperationsCmsModelPlugin((0, _valueKeyStorageConverter.createCmsModelFieldConvertersAttachFactory)(context.plugins)));
-    await context.benchmark.measure("headlessCms.createContext", async () => {
-      await storageOperations.beforeInit(context);
-      const accessControl = new _AccessControl.AccessControl({
-        getIdentity: context.security.getIdentity,
-        getGroupsPermissions: () => context.security.getPermissions("cms.contentModelGroup"),
-        getModelsPermissions: () => context.security.getPermissions("cms.contentModel"),
-        getEntriesPermissions: () => context.security.getPermissions("cms.contentEntry"),
-        listAllGroups: () => {
-          return context.security.withoutAuthorization(() => {
-            return context.cms.listGroups();
-          });
-        }
-      });
-      context.cms = {
-        type,
-        locale: localeCode,
-        getLocale,
-        READ: type === "read",
-        PREVIEW: type === "preview",
-        MANAGE: type === "manage",
-        storageOperations,
-        accessControl,
-        getExecutableSchema,
-        ...(0, _system.createSystemCrud)({
-          context,
-          getTenant,
-          getLocale,
-          getIdentity,
-          storageOperations
-        }),
-        ...(0, _contentModelGroup.createModelGroupsCrud)({
-          context,
-          getTenant,
-          getLocale,
-          getIdentity,
-          storageOperations,
-          accessControl
-        }),
-        ...(0, _contentModel.createModelsCrud)({
-          context,
-          getLocale,
-          getTenant,
-          getIdentity,
-          storageOperations,
-          accessControl
-        }),
-        ...(0, _contentEntry.createContentEntryCrud)({
-          context,
-          getIdentity,
-          getTenant,
-          getLocale,
-          storageOperations,
-          accessControl
-        }),
-        export: {
-          ...(0, _export.createExportCrud)(context)
-        },
-        importing: {
-          ...(0, _importing.createImportCrud)(context)
+const createContextPlugin = ()=>{
+    const plugin = new ContextPlugin(async (context)=>{
+        const { type } = await getParameters(context);
+        const getTenant = ()=>context.tenancy.getCurrentTenant();
+        const setSchemaType = (type)=>{
+            if (!type) return;
+            context.cms.type = type;
+            switch(type){
+                case "read":
+                    context.cms.READ = true;
+                    break;
+                case "preview":
+                    context.cms.PREVIEW = true;
+                    break;
+                default:
+                    context.cms.MANAGE = true;
+            }
+        };
+        GraphQLFeature.register(context.container);
+        ValidationFeature.register(context.container);
+        StorageFeature.register(context.container);
+        async function getExecutableSchema(type) {
+            const originalType = context.cms.type;
+            setSchemaType(type);
+            const schema = await context.security.withoutAuthorization(()=>getSchema({
+                    context,
+                    getTenant,
+                    type
+                }));
+            setSchemaType(originalType);
+            return async (input)=>processRequestBody(input, schema, context);
         }
-      };
-      if (!storageOperations.init) {
-        return;
-      }
-      await storageOperations.init(context);
+        context.plugins.register(new StorageOperationsCmsModelPlugin(createCmsModelFieldConvertersAttachFactory(context)));
+        const accessControl = new AccessControl({
+            getIdentity: async ()=>context.security.getIdentity(),
+            getGroupsPermissions: ()=>context.security.getPermissions("cms.contentModelGroup"),
+            getModelsPermissions: ()=>context.security.getPermissions("cms.contentModel"),
+            getEntriesPermissions: ()=>context.security.getPermissions("cms.contentEntry"),
+            listAllGroups: ()=>context.security.withoutAuthorization(()=>context.cms.listGroups())
+        });
+        const storageOperationsFactory = context.container.resolve(StorageOperationsFactory);
+        const storageOperations = await storageOperationsFactory.create(context);
+        await storageOperations.beforeInit(context);
+        context.cms = {
+            type,
+            READ: "read" === type,
+            PREVIEW: "preview" === type,
+            MANAGE: "manage" === type,
+            storageOperations,
+            accessControl,
+            getExecutableSchema,
+            ...createModelGroupsCrud({
+                context
+            }),
+            ...createModelsCrud({
+                context
+            }),
+            ...createContentEntryCrud({
+                context
+            }),
+            export: {
+                ...createExportCrud(context)
+            },
+            importing: {
+                ...createImportCrud(context)
+            }
+        };
+        context.container.registerInstance(StorageOperations, storageOperations);
+        context.container.registerInstance(abstractions_js_AccessControl, accessControl);
+        context.container.registerInstance(CmsContext, context);
+        context.container.registerInstance(PluginsContainer, context.plugins);
+        context.container.registerInstance(EntryToStorageTransform, (model, entry)=>entryToStorageTransform(context, model, entry));
+        context.container.registerInstance(EntryFromStorageTransform, (model, entry)=>entryFromStorageTransform(context, model, entry));
+        context.container.registerInstance(SearchableFieldsProvider, (params)=>getSearchableFields({
+                context,
+                fields: params.fields,
+                input: []
+            }));
+        CmsInstallerFeature.register(context.container);
+        ContentEntriesFeature.register(context.container);
+        ContentModelFeature.register(context.container);
+        ContentModelGroupFeature.register(context.container);
+        ModelBuilderFeature.register(context.container);
+        CmsWhereMapperFeature.register(context.container);
+        CmsSortMapperFeature.register(context.container);
+        CmsWebhooksFeature.register(context.container);
+        if (!storageOperations.init) return;
+        await storageOperations.init(context);
     });
-  });
-  plugin.name = "cms.createContext";
-  return plugin;
+    plugin.name = "cms.createContext";
+    return plugin;
 };
-exports.createContextPlugin = createContextPlugin;
+export { createContextPlugin };
 
 //# sourceMappingURL=context.js.map