@webiny/api-headless-cms 0.0.0-unstable.d7f521b032 → 0.0.0-unstable.dbdf5d6258

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,4 @@
+import { Abstraction } from "@webiny/di";
+export const OnEntryBeforeCreate = new Abstraction("OnEntryBeforeCreate");
+
+//# sourceMappingURL=OnEntryBeforeCreate.js.map

package/abstractions/entryHooks/OnEntryBeforeCreate.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["Abstraction","OnEntryBeforeCreate"],"sources":["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"],"mappings":"AAAA,SAASA,WAAW,QAAQ,YAAY;AAMxC,OAAO,MAAMC,mBAAmB,GAAG,IAAID,WAAW,CAAuB,qBAAqB,CAAC","ignoreList":[]}

package/abstractions/entryHooks/index.d.ts

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

package/abstractions/entryHooks/index.js

@@ -0,0 +1,3 @@
+export * from "./OnEntryBeforeCreate.js";
+
+//# sourceMappingURL=index.js.map

package/abstractions/entryHooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./OnEntryBeforeCreate.js\";\n"],"mappings":"AAAA","ignoreList":[]}

package/abstractions/index.d.ts

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

package/abstractions/index.js

@@ -0,0 +1,3 @@
+export * from "./entryHooks/index.js";
+
+//# sourceMappingURL=index.js.map

package/abstractions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./entryHooks/index.js\";\n"],"mappings":"AAAA","ignoreList":[]}

package/constants.d.ts

@@ -0,0 +1,45 @@
+import type { CmsIdentity, ICmsEntryLive } from "./types/index.js";
+export declare const ROOT_FOLDER = "root";
+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 {
+    revisionCreatedOn: string;
+    revisionSavedOn: string;
+    revisionModifiedOn: string | null;
+    revisionDeletedOn: string | null;
+    revisionRestoredOn: string | null;
+    revisionFirstPublishedOn: string | null;
+    revisionLastPublishedOn: string | null;
+    revisionCreatedBy: CmsIdentity;
+    revisionSavedBy: CmsIdentity;
+    revisionModifiedBy: CmsIdentity | null;
+    revisionDeletedBy: CmsIdentity | null;
+    revisionRestoredBy: CmsIdentity | null;
+    revisionFirstPublishedBy: CmsIdentity | null;
+    revisionLastPublishedBy: CmsIdentity | null;
+    createdOn: string;
+    savedOn: string;
+    modifiedOn: string | null;
+    deletedOn: string | null;
+    restoredOn: string | null;
+    firstPublishedOn: string | null;
+    lastPublishedOn: string | null;
+    createdBy: CmsIdentity;
+    savedBy: CmsIdentity;
+    modifiedBy: CmsIdentity | null;
+    deletedBy: CmsIdentity | null;
+    restoredBy: CmsIdentity | null;
+    firstPublishedBy: CmsIdentity | null;
+    lastPublishedBy: CmsIdentity | null;
+    live: ICmsEntryLive | null;
+}
+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;
+export declare const isIdentityEntryMetaField: (fieldName: string) => boolean;
+export declare const isRevisionEntryMetaField: (fieldName: string) => boolean;
+export declare const isEntryLevelEntryMetaField: (fieldName: string) => boolean;
+export declare const isDeletedEntryMetaField: (fieldName: string) => boolean;
+export declare const isRestoredEntryMetaField: (fieldName: string) => boolean;

package/constants.js

@@ -0,0 +1,59 @@
+export const ROOT_FOLDER = "root";
+export const CMS_MODEL_SINGLETON_TAG = "singleEntry";
+
+// Content entries - xOn and xBy meta fields.
+export const 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"];
+export 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]
+      });
+    }
+  }
+  /**
+   * Also add live field, as it's not part of entry meta fields, but it's required to be transfered.
+   */
+  pickedEntryMetaFields.live = object.live;
+  return pickedEntryMetaFields;
+};
+export 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");
+};
+export const isNonNullableEntryMetaField = fieldName => {
+  return !isNullableEntryMetaField(fieldName);
+};
+export const isDateTimeEntryMetaField = fieldName => {
+  // Only field ending with "On" are date/time fields.
+  return fieldName.endsWith("On");
+};
+export const isIdentityEntryMetaField = fieldName => {
+  // Only field ending with "On" are date/time fields.
+  return fieldName.endsWith("By");
+};
+export const isRevisionEntryMetaField = fieldName => {
+  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.startsWith("revision");
+};
+export const isEntryLevelEntryMetaField = fieldName => {
+  return ENTRY_META_FIELDS.includes(fieldName) && !fieldName.startsWith("revision");
+};
+export const isDeletedEntryMetaField = fieldName => {
+  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("deleted");
+};
+export const isRestoredEntryMetaField = fieldName => {
+  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("restored");
+};
+
+//# sourceMappingURL=constants.js.map

package/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ROOT_FOLDER","CMS_MODEL_SINGLETON_TAG","ENTRY_META_FIELDS","pickEntryMetaFields","object","filter","pickedEntryMetaFields","entryMetaFieldName","fieldExists","undefined","mustPick","Object","assign","live","isNullableEntryMetaField","fieldName","lcFieldName","toLowerCase","includes","isNonNullableEntryMetaField","isDateTimeEntryMetaField","endsWith","isIdentityEntryMetaField","isRevisionEntryMetaField","startsWith","isEntryLevelEntryMetaField","isDeletedEntryMetaField","isRestoredEntryMetaField"],"sources":["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"],"mappings":"AAEA,OAAO,MAAMA,WAAW,GAAG,MAAM;AAEjC,OAAO,MAAMC,uBAAuB,GAAG,aAAa;;AAEpD;AACA,OAAO,MAAMC,iBAAiB,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;AAsCV,OAAO,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;EACA;AACJ;AACA;EACID,qBAAqB,CAACO,IAAI,GAAGT,MAAM,CAACS,IAAI;EAExC,OAAOP,qBAAqB;AAChC,CAAC;AAED,OAAO,MAAMQ,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;AAED,OAAO,MAAMC,2BAA2B,GAAIJ,SAAiB,IAAK;EAC9D,OAAO,CAACD,wBAAwB,CAACC,SAAS,CAAC;AAC/C,CAAC;AAED,OAAO,MAAMK,wBAAwB,GAAIL,SAAiB,IAAK;EAC3D;EACA,OAAOA,SAAS,CAACM,QAAQ,CAAC,IAAI,CAAC;AACnC,CAAC;AAED,OAAO,MAAMC,wBAAwB,GAAIP,SAAiB,IAAK;EAC3D;EACA,OAAOA,SAAS,CAACM,QAAQ,CAAC,IAAI,CAAC;AACnC,CAAC;AAED,OAAO,MAAME,wBAAwB,GAAIR,SAAiB,IAAK;EAC3D,OACIb,iBAAiB,CAACgB,QAAQ,CAACH,SAA+B,CAAC,IAC3DA,SAAS,CAACS,UAAU,CAAC,UAAU,CAAC;AAExC,CAAC;AAED,OAAO,MAAMC,0BAA0B,GAAIV,SAAiB,IAAK;EAC7D,OACIb,iBAAiB,CAACgB,QAAQ,CAACH,SAA+B,CAAC,IAC3D,CAACA,SAAS,CAACS,UAAU,CAAC,UAAU,CAAC;AAEzC,CAAC;AAED,OAAO,MAAME,uBAAuB,GAAIX,SAAiB,IAAK;EAC1D,OACIb,iBAAiB,CAACgB,QAAQ,CAACH,SAA+B,CAAC,IAAIA,SAAS,CAACG,QAAQ,CAAC,SAAS,CAAC;AAEpG,CAAC;AAED,OAAO,MAAMS,wBAAwB,GAAIZ,SAAiB,IAAK;EAC3D,OACIb,iBAAiB,CAACgB,QAAQ,CAACH,SAA+B,CAAC,IAC3DA,SAAS,CAACG,QAAQ,CAAC,UAAU,CAAC;AAEtC,CAAC","ignoreList":[]}

package/context.d.ts

@@ -1,4 +1,4 @@
-import { CmsContext, HeadlessCmsStorageOperations } from "./types";
+import type { CmsContext, HeadlessCmsStorageOperations } from "./types/index.js";
 import { ContextPlugin } from "@webiny/api";
 export interface CrudParams {
     storageOperations: HeadlessCmsStorageOperations;

package/context.js

@@ -1,94 +1,150 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createContextPlugin = void 0;
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-var _error = _interopRequireDefault(require("@webiny/error"));
-var _api = require("@webiny/api");
-var _CmsParametersPlugin = require("./plugins/CmsParametersPlugin");
-var _system = require("./crud/system.crud");
-var _settings = require("./crud/settings.crud");
-var _contentModelGroup = require("./crud/contentModelGroup.crud");
-var _contentModel = require("./crud/contentModel.crud");
-var _contentEntry = require("./crud/contentEntry.crud");
+import WebinyError 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 AccessControlAbstraction, CmsContext as CmsContextAbstraction, StorageOperations } 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";
 const getParameters = async context => {
-  const plugins = context.plugins.byType(_CmsParametersPlugin.CmsParametersPlugin.type);
+  const plugins = context.plugins.byType(CmsParametersPlugin.type);
   for (const plugin of plugins) {
     const result = await plugin.getParameters(context);
     if (result !== null) {
       return result;
     }
   }
-  throw new _error.default("Could not determine locale and/or type of the CMS.", "CMS_LOCALE_AND_TYPE_ERROR");
+  throw new WebinyError("Could not determine type of the CMS.", "CMS_TYPE_ERROR");
 };
-const createContextPlugin = ({
+export const createContextPlugin = ({
   storageOperations
 }) => {
-  return new _api.ContextPlugin(async context => {
+  const plugin = new ContextPlugin(async context => {
     const {
-      type,
-      locale
+      type
     } = await getParameters(context);
-    const getLocale = () => {
-      const systemLocale = context.i18n.getLocale(locale);
-      if (!systemLocale) {
-        throw new _error.default(`There is no locale "${locale}" in the system.`);
-      }
-      return systemLocale;
-    };
-    const getIdentity = () => {
-      return context.security.getIdentity();
-    };
     const getTenant = () => {
       return context.tenancy.getCurrentTenant();
     };
-    if (storageOperations.beforeInit) {
-      await storageOperations.beforeInit(context);
+    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 getSchema({
+          context,
+          getTenant,
+          type
+        });
+      });
+      setSchemaType(originalType);
+      return async input => {
+        return processRequestBody(input, schema, context);
+      };
     }
-    context.cms = (0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)((0, _objectSpread2.default)({
+    context.plugins.register(new StorageOperationsCmsModelPlugin(createCmsModelFieldConvertersAttachFactory(context.plugins)));
+    await storageOperations.beforeInit(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: () => {
+        return context.security.withoutAuthorization(() => {
+          return context.cms.listGroups();
+        });
+      }
+    });
+    context.cms = {
       type,
-      locale,
-      getLocale,
       READ: type === "read",
       PREVIEW: type === "preview",
       MANAGE: type === "manage",
-      storageOperations
-    }, (0, _system.createSystemCrud)({
-      context,
-      getTenant,
-      getLocale,
-      getIdentity,
-      storageOperations
-    })), (0, _settings.createSettingsCrud)({
-      context,
-      getTenant,
-      getLocale,
-      storageOperations
-    })), (0, _contentModelGroup.createModelGroupsCrud)({
-      context,
-      getTenant,
-      getLocale,
-      getIdentity,
-      storageOperations
-    })), (0, _contentModel.createModelsCrud)({
-      context,
-      getLocale,
-      getTenant,
-      getIdentity,
-      storageOperations
-    })), (0, _contentEntry.createContentEntryCrud)({
-      context,
-      getIdentity,
-      getTenant,
-      storageOperations
-    }));
+      storageOperations,
+      accessControl,
+      getExecutableSchema,
+      ...createModelGroupsCrud({
+        context
+      }),
+      ...createModelsCrud({
+        context
+      }),
+      ...createContentEntryCrud({
+        context
+      }),
+      export: {
+        ...createExportCrud(context)
+      },
+      importing: {
+        ...createImportCrud(context)
+      }
+    };
+
+    // Register legacy dependencies
+    context.container.registerInstance(StorageOperations, storageOperations);
+    context.container.registerInstance(AccessControlAbstraction, accessControl);
+    context.container.registerInstance(CmsContextAbstraction, context);
+    context.container.registerInstance(PluginsContainer, context.plugins);
+    context.container.registerInstance(EntryToStorageTransform, (model, entry) => {
+      return entryToStorageTransform(context, model, entry);
+    });
+    context.container.registerInstance(EntryFromStorageTransform, (model, entry) => {
+      return entryFromStorageTransform(context, model, entry);
+    });
+    context.container.registerInstance(SearchableFieldsProvider, params => {
+      return getSearchableFields({
+        plugins: context.plugins,
+        fields: params.fields,
+        input: []
+      });
+    });
+
+    // Register features
+    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);
     if (!storageOperations.init) {
       return;
     }
     await storageOperations.init(context);
   });
+  plugin.name = "cms.createContext";
+  return plugin;
 };
-exports.createContextPlugin = createContextPlugin;
+
+//# sourceMappingURL=context.js.map

package/context.js.map

@@ -1 +1 @@
-{"version":3,"names":["getParameters","context","plugins","byType","CmsParametersPlugin","type","plugin","result","WebinyError","createContextPlugin","storageOperations","ContextPlugin","locale","getLocale","systemLocale","i18n","getIdentity","security","getTenant","tenancy","getCurrentTenant","beforeInit","cms","READ","PREVIEW","MANAGE","createSystemCrud","createSettingsCrud","createModelGroupsCrud","createModelsCrud","createContentEntryCrud","init"],"sources":["context.ts"],"sourcesContent":["import { CmsContext, HeadlessCmsStorageOperations } from \"~/types\";\nimport WebinyError from \"@webiny/error\";\nimport { ContextPlugin } from \"@webiny/api\";\nimport { CmsParametersPlugin, CmsParametersPluginResponse } from \"~/plugins/CmsParametersPlugin\";\nimport { createSystemCrud } from \"~/crud/system.crud\";\nimport { createSettingsCrud } from \"~/crud/settings.crud\";\nimport { createModelGroupsCrud } from \"~/crud/contentModelGroup.crud\";\nimport { createModelsCrud } from \"~/crud/contentModel.crud\";\nimport { createContentEntryCrud } from \"~/crud/contentEntry.crud\";\n\nconst getParameters = async (context: CmsContext): Promise<CmsParametersPluginResponse> => {\n    const plugins = context.plugins.byType<CmsParametersPlugin>(CmsParametersPlugin.type);\n\n    for (const plugin of plugins) {\n        const result = await plugin.getParameters(context);\n        if (result !== null) {\n            return result;\n        }\n    }\n    throw new WebinyError(\n        \"Could not determine locale and/or type of the CMS.\",\n        \"CMS_LOCALE_AND_TYPE_ERROR\"\n    );\n};\n\nexport interface CrudParams {\n    storageOperations: HeadlessCmsStorageOperations;\n}\n\nexport const createContextPlugin = ({ storageOperations }: CrudParams) => {\n    return new ContextPlugin<CmsContext>(async context => {\n        const { type, locale } = await getParameters(context);\n\n        const getLocale = () => {\n            const systemLocale = context.i18n.getLocale(locale);\n            if (!systemLocale) {\n                throw new WebinyError(`There is no locale \"${locale}\" in the system.`);\n            }\n            return systemLocale;\n        };\n\n        const getIdentity = () => {\n            return context.security.getIdentity();\n        };\n\n        const getTenant = () => {\n            return context.tenancy.getCurrentTenant();\n        };\n\n        if (storageOperations.beforeInit) {\n            await storageOperations.beforeInit(context);\n        }\n\n        context.cms = {\n            type,\n            locale,\n            getLocale,\n            READ: type === \"read\",\n            PREVIEW: type === \"preview\",\n            MANAGE: type === \"manage\",\n            storageOperations,\n            ...createSystemCrud({\n                context,\n                getTenant,\n                getLocale,\n                getIdentity,\n                storageOperations\n            }),\n            ...createSettingsCrud({\n                context,\n                getTenant,\n                getLocale,\n                storageOperations\n            }),\n            ...createModelGroupsCrud({\n                context,\n                getTenant,\n                getLocale,\n                getIdentity,\n                storageOperations\n            }),\n            ...createModelsCrud({\n                context,\n                getLocale,\n                getTenant,\n                getIdentity,\n                storageOperations\n            }),\n            ...createContentEntryCrud({\n                context,\n                getIdentity,\n                getTenant,\n                storageOperations\n            })\n        };\n\n        if (!storageOperations.init) {\n            return;\n        }\n        await storageOperations.init(context);\n    });\n};\n"],"mappings":";;;;;;;;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA,MAAMA,aAAa,GAAG,MAAOC,OAAmB,IAA2C;EACvF,MAAMC,OAAO,GAAGD,OAAO,CAACC,OAAO,CAACC,MAAM,CAAsBC,wCAAmB,CAACC,IAAI,CAAC;EAErF,KAAK,MAAMC,MAAM,IAAIJ,OAAO,EAAE;IAC1B,MAAMK,MAAM,GAAG,MAAMD,MAAM,CAACN,aAAa,CAACC,OAAO,CAAC;IAClD,IAAIM,MAAM,KAAK,IAAI,EAAE;MACjB,OAAOA,MAAM;IACjB;EACJ;EACA,MAAM,IAAIC,cAAW,CACjB,oDAAoD,EACpD,2BAA2B,CAC9B;AACL,CAAC;AAMM,MAAMC,mBAAmB,GAAG,CAAC;EAAEC;AAA8B,CAAC,KAAK;EACtE,OAAO,IAAIC,kBAAa,CAAa,MAAMV,OAAO,IAAI;IAClD,MAAM;MAAEI,IAAI;MAAEO;IAAO,CAAC,GAAG,MAAMZ,aAAa,CAACC,OAAO,CAAC;IAErD,MAAMY,SAAS,GAAG,MAAM;MACpB,MAAMC,YAAY,GAAGb,OAAO,CAACc,IAAI,CAACF,SAAS,CAACD,MAAM,CAAC;MACnD,IAAI,CAACE,YAAY,EAAE;QACf,MAAM,IAAIN,cAAW,CAAE,uBAAsBI,MAAO,kBAAiB,CAAC;MAC1E;MACA,OAAOE,YAAY;IACvB,CAAC;IAED,MAAME,WAAW,GAAG,MAAM;MACtB,OAAOf,OAAO,CAACgB,QAAQ,CAACD,WAAW,EAAE;IACzC,CAAC;IAED,MAAME,SAAS,GAAG,MAAM;MACpB,OAAOjB,OAAO,CAACkB,OAAO,CAACC,gBAAgB,EAAE;IAC7C,CAAC;IAED,IAAIV,iBAAiB,CAACW,UAAU,EAAE;MAC9B,MAAMX,iBAAiB,CAACW,UAAU,CAACpB,OAAO,CAAC;IAC/C;IAEAA,OAAO,CAACqB,GAAG;MACPjB,IAAI;MACJO,MAAM;MACNC,SAAS;MACTU,IAAI,EAAElB,IAAI,KAAK,MAAM;MACrBmB,OAAO,EAAEnB,IAAI,KAAK,SAAS;MAC3BoB,MAAM,EAAEpB,IAAI,KAAK,QAAQ;MACzBK;IAAiB,GACd,IAAAgB,wBAAgB,EAAC;MAChBzB,OAAO;MACPiB,SAAS;MACTL,SAAS;MACTG,WAAW;MACXN;IACJ,CAAC,CAAC,GACC,IAAAiB,4BAAkB,EAAC;MAClB1B,OAAO;MACPiB,SAAS;MACTL,SAAS;MACTH;IACJ,CAAC,CAAC,GACC,IAAAkB,wCAAqB,EAAC;MACrB3B,OAAO;MACPiB,SAAS;MACTL,SAAS;MACTG,WAAW;MACXN;IACJ,CAAC,CAAC,GACC,IAAAmB,8BAAgB,EAAC;MAChB5B,OAAO;MACPY,SAAS;MACTK,SAAS;MACTF,WAAW;MACXN;IACJ,CAAC,CAAC,GACC,IAAAoB,oCAAsB,EAAC;MACtB7B,OAAO;MACPe,WAAW;MACXE,SAAS;MACTR;IACJ,CAAC,CAAC,CACL;IAED,IAAI,CAACA,iBAAiB,CAACqB,IAAI,EAAE;MACzB;IACJ;IACA,MAAMrB,iBAAiB,CAACqB,IAAI,CAAC9B,OAAO,CAAC;EACzC,CAAC,CAAC;AACN,CAAC;AAAC"}
+{"version":3,"names":["WebinyError","ContextPlugin","processRequestBody","CmsParametersPlugin","AccessControl","createModelGroupsCrud","createModelsCrud","createContentEntryCrud","StorageOperationsCmsModelPlugin","createCmsModelFieldConvertersAttachFactory","createExportCrud","createImportCrud","getSchema","CmsInstallerFeature","ContentEntriesFeature","AccessControlAbstraction","CmsContext","CmsContextAbstraction","StorageOperations","EntryFromStorageTransform","EntryToStorageTransform","PluginsContainer","SearchableFieldsProvider","entryFromStorageTransform","entryToStorageTransform","getSearchableFields","ContentModelGroupFeature","ContentModelFeature","ModelBuilderFeature","CmsWhereMapperFeature","CmsSortMapperFeature","getParameters","context","plugins","byType","type","plugin","result","createContextPlugin","storageOperations","getTenant","tenancy","getCurrentTenant","setSchemaType","cms","READ","PREVIEW","MANAGE","getExecutableSchema","originalType","schema","security","withoutAuthorization","input","register","beforeInit","accessControl","getIdentity","getGroupsPermissions","getPermissions","getModelsPermissions","getEntriesPermissions","listAllGroups","listGroups","export","importing","container","registerInstance","model","entry","params","fields","init","name"],"sources":["context.ts"],"sourcesContent":["import type { ApiEndpoint, CmsContext, HeadlessCmsStorageOperations } from \"~/types/index.js\";\nimport WebinyError from \"@webiny/error\";\nimport { ContextPlugin } from \"@webiny/api\";\nimport type { GraphQLRequestBody } from \"@webiny/handler-graphql/types.js\";\nimport { processRequestBody } from \"@webiny/handler-graphql\";\nimport type { CmsParametersPluginResponse } from \"~/plugins/CmsParametersPlugin.js\";\nimport { CmsParametersPlugin } from \"~/plugins/CmsParametersPlugin.js\";\nimport { AccessControl } from \"~/crud/AccessControl/AccessControl.js\";\nimport { createModelGroupsCrud } from \"~/crud/contentModelGroup.crud.js\";\nimport { createModelsCrud } from \"~/crud/contentModel.crud.js\";\nimport { createContentEntryCrud } from \"~/crud/contentEntry.crud.js\";\nimport { StorageOperationsCmsModelPlugin } from \"~/plugins/index.js\";\nimport { createCmsModelFieldConvertersAttachFactory } from \"~/utils/converters/valueKeyStorageConverter.js\";\nimport { createExportCrud } from \"~/export/index.js\";\nimport { createImportCrud } from \"~/export/crud/importing.js\";\nimport { getSchema } from \"~/graphql/getSchema.js\";\nimport { CmsInstallerFeature } from \"~/features/installer/feature.js\";\nimport { ContentEntriesFeature } from \"~/features/contentEntry/ContentEntriesFeature.js\";\nimport {\n    AccessControl as AccessControlAbstraction,\n    CmsContext as CmsContextAbstraction,\n    StorageOperations\n} from \"~/features/shared/abstractions.js\";\nimport {\n    EntryFromStorageTransform,\n    EntryToStorageTransform,\n    PluginsContainer,\n    SearchableFieldsProvider\n} from \"./legacy/abstractions.js\";\nimport { entryFromStorageTransform, entryToStorageTransform } from \"~/utils/entryStorage.js\";\nimport { getSearchableFields } from \"~/crud/contentEntry/searchableFields.js\";\nimport { ContentModelGroupFeature } from \"~/features/contentModelGroup/ContentModelGroupFeature.js\";\nimport { ContentModelFeature } from \"~/features/contentModel/ContentModelFeature.js\";\nimport { ModelBuilderFeature } from \"~/features/modelBuilder/index.js\";\nimport { CmsWhereMapperFeature } from \"~/features/whereMapper/feature.js\";\nimport { CmsSortMapperFeature } from \"~/features/sortMapper/feature.js\";\n\nconst getParameters = async (context: CmsContext): Promise<CmsParametersPluginResponse> => {\n    const plugins = context.plugins.byType<CmsParametersPlugin>(CmsParametersPlugin.type);\n\n    for (const plugin of plugins) {\n        const result = await plugin.getParameters(context);\n        if (result !== null) {\n            return result;\n        }\n    }\n    throw new WebinyError(\"Could not determine type of the CMS.\", \"CMS_TYPE_ERROR\");\n};\n\nexport interface CrudParams {\n    storageOperations: HeadlessCmsStorageOperations;\n}\n\nexport const createContextPlugin = ({ storageOperations }: CrudParams) => {\n    const plugin = new ContextPlugin<CmsContext>(async context => {\n        const { type } = await getParameters(context);\n\n        const getTenant = () => {\n            return context.tenancy.getCurrentTenant();\n        };\n\n        const setSchemaType = (type: ApiEndpoint | null) => {\n            if (!type) {\n                return;\n            }\n\n            context.cms.type = type;\n\n            switch (type) {\n                case \"read\":\n                    context.cms.READ = true;\n                    break;\n                case \"preview\":\n                    context.cms.PREVIEW = true;\n                    break;\n                default:\n                    context.cms.MANAGE = true;\n            }\n        };\n\n        async function getExecutableSchema(type: ApiEndpoint) {\n            const originalType = context.cms.type;\n            setSchemaType(type);\n\n            const schema = await context.security.withoutAuthorization(() => {\n                return getSchema({\n                    context,\n                    getTenant,\n                    type\n                });\n            });\n\n            setSchemaType(originalType);\n\n            return async <TData, TExtensions>(input: GraphQLRequestBody | GraphQLRequestBody[]) => {\n                return processRequestBody<TData, TExtensions>(input, schema, context);\n            };\n        }\n\n        context.plugins.register(\n            new StorageOperationsCmsModelPlugin(\n                createCmsModelFieldConvertersAttachFactory(context.plugins)\n            )\n        );\n\n        await storageOperations.beforeInit(context);\n\n        const accessControl = new AccessControl({\n            getIdentity: async () => context.security.getIdentity(),\n            getGroupsPermissions: () => context.security.getPermissions(\"cms.contentModelGroup\"),\n            getModelsPermissions: () => context.security.getPermissions(\"cms.contentModel\"),\n            getEntriesPermissions: () => context.security.getPermissions(\"cms.contentEntry\"),\n            listAllGroups: () => {\n                return context.security.withoutAuthorization(() => {\n                    return context.cms.listGroups();\n                });\n            }\n        });\n\n        context.cms = {\n            type,\n            READ: type === \"read\",\n            PREVIEW: type === \"preview\",\n            MANAGE: type === \"manage\",\n            storageOperations,\n            accessControl,\n            getExecutableSchema,\n            ...createModelGroupsCrud({\n                context\n            }),\n            ...createModelsCrud({\n                context\n            }),\n            ...createContentEntryCrud({\n                context\n            }),\n            export: {\n                ...createExportCrud(context)\n            },\n            importing: {\n                ...createImportCrud(context)\n            }\n        };\n\n        // Register legacy dependencies\n        context.container.registerInstance(StorageOperations, storageOperations);\n        context.container.registerInstance(AccessControlAbstraction, accessControl);\n        context.container.registerInstance(CmsContextAbstraction, context);\n        context.container.registerInstance(PluginsContainer, context.plugins);\n        context.container.registerInstance(EntryToStorageTransform, (model, entry) => {\n            return entryToStorageTransform(context, model, entry);\n        });\n        context.container.registerInstance(EntryFromStorageTransform, (model, entry) => {\n            return entryFromStorageTransform(context, model, entry);\n        });\n        context.container.registerInstance(SearchableFieldsProvider, params => {\n            return getSearchableFields({\n                plugins: context.plugins,\n                fields: params.fields,\n                input: []\n            });\n        });\n\n        // Register features\n        CmsInstallerFeature.register(context.container);\n        ContentEntriesFeature.register(context.container);\n        ContentModelFeature.register(context.container);\n        ContentModelGroupFeature.register(context.container);\n        ModelBuilderFeature.register(context.container);\n\n        CmsWhereMapperFeature.register(context.container);\n        CmsSortMapperFeature.register(context.container);\n\n        if (!storageOperations.init) {\n            return;\n        }\n        await storageOperations.init(context);\n    });\n\n    plugin.name = \"cms.createContext\";\n\n    return plugin;\n};\n"],"mappings":"AACA,OAAOA,WAAW,MAAM,eAAe;AACvC,SAASC,aAAa,QAAQ,aAAa;AAE3C,SAASC,kBAAkB,QAAQ,yBAAyB;AAE5D,SAASC,mBAAmB;AAC5B,SAASC,aAAa;AACtB,SAASC,qBAAqB;AAC9B,SAASC,gBAAgB;AACzB,SAASC,sBAAsB;AAC/B,SAASC,+BAA+B;AACxC,SAASC,0CAA0C;AACnD,SAASC,gBAAgB;AACzB,SAASC,gBAAgB;AACzB,SAASC,SAAS;AAClB,SAASC,mBAAmB;AAC5B,SAASC,qBAAqB;AAC9B,SACIV,aAAa,IAAIW,wBAAwB,EACzCC,UAAU,IAAIC,qBAAqB,EACnCC,iBAAiB;AAErB,SACIC,yBAAyB,EACzBC,uBAAuB,EACvBC,gBAAgB,EAChBC,wBAAwB;AAE5B,SAASC,yBAAyB,EAAEC,uBAAuB;AAC3D,SAASC,mBAAmB;AAC5B,SAASC,wBAAwB;AACjC,SAASC,mBAAmB;AAC5B,SAASC,mBAAmB;AAC5B,SAASC,qBAAqB;AAC9B,SAASC,oBAAoB;AAE7B,MAAMC,aAAa,GAAG,MAAOC,OAAmB,IAA2C;EACvF,MAAMC,OAAO,GAAGD,OAAO,CAACC,OAAO,CAACC,MAAM,CAAsB/B,mBAAmB,CAACgC,IAAI,CAAC;EAErF,KAAK,MAAMC,MAAM,IAAIH,OAAO,EAAE;IAC1B,MAAMI,MAAM,GAAG,MAAMD,MAAM,CAACL,aAAa,CAACC,OAAO,CAAC;IAClD,IAAIK,MAAM,KAAK,IAAI,EAAE;MACjB,OAAOA,MAAM;IACjB;EACJ;EACA,MAAM,IAAIrC,WAAW,CAAC,sCAAsC,EAAE,gBAAgB,CAAC;AACnF,CAAC;AAMD,OAAO,MAAMsC,mBAAmB,GAAGA,CAAC;EAAEC;AAA8B,CAAC,KAAK;EACtE,MAAMH,MAAM,GAAG,IAAInC,aAAa,CAAa,MAAM+B,OAAO,IAAI;IAC1D,MAAM;MAAEG;IAAK,CAAC,GAAG,MAAMJ,aAAa,CAACC,OAAO,CAAC;IAE7C,MAAMQ,SAAS,GAAGA,CAAA,KAAM;MACpB,OAAOR,OAAO,CAACS,OAAO,CAACC,gBAAgB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAMC,aAAa,GAAIR,IAAwB,IAAK;MAChD,IAAI,CAACA,IAAI,EAAE;QACP;MACJ;MAEAH,OAAO,CAACY,GAAG,CAACT,IAAI,GAAGA,IAAI;MAEvB,QAAQA,IAAI;QACR,KAAK,MAAM;UACPH,OAAO,CAACY,GAAG,CAACC,IAAI,GAAG,IAAI;UACvB;QACJ,KAAK,SAAS;UACVb,OAAO,CAACY,GAAG,CAACE,OAAO,GAAG,IAAI;UAC1B;QACJ;UACId,OAAO,CAACY,GAAG,CAACG,MAAM,GAAG,IAAI;MACjC;IACJ,CAAC;IAED,eAAeC,mBAAmBA,CAACb,IAAiB,EAAE;MAClD,MAAMc,YAAY,GAAGjB,OAAO,CAACY,GAAG,CAACT,IAAI;MACrCQ,aAAa,CAACR,IAAI,CAAC;MAEnB,MAAMe,MAAM,GAAG,MAAMlB,OAAO,CAACmB,QAAQ,CAACC,oBAAoB,CAAC,MAAM;QAC7D,OAAOxC,SAAS,CAAC;UACboB,OAAO;UACPQ,SAAS;UACTL;QACJ,CAAC,CAAC;MACN,CAAC,CAAC;MAEFQ,aAAa,CAACM,YAAY,CAAC;MAE3B,OAAO,MAA2BI,KAAgD,IAAK;QACnF,OAAOnD,kBAAkB,CAAqBmD,KAAK,EAAEH,MAAM,EAAElB,OAAO,CAAC;MACzE,CAAC;IACL;IAEAA,OAAO,CAACC,OAAO,CAACqB,QAAQ,CACpB,IAAI9C,+BAA+B,CAC/BC,0CAA0C,CAACuB,OAAO,CAACC,OAAO,CAC9D,CACJ,CAAC;IAED,MAAMM,iBAAiB,CAACgB,UAAU,CAACvB,OAAO,CAAC;IAE3C,MAAMwB,aAAa,GAAG,IAAIpD,aAAa,CAAC;MACpCqD,WAAW,EAAE,MAAAA,CAAA,KAAYzB,OAAO,CAACmB,QAAQ,CAACM,WAAW,CAAC,CAAC;MACvDC,oBAAoB,EAAEA,CAAA,KAAM1B,OAAO,CAACmB,QAAQ,CAACQ,cAAc,CAAC,uBAAuB,CAAC;MACpFC,oBAAoB,EAAEA,CAAA,KAAM5B,OAAO,CAACmB,QAAQ,CAACQ,cAAc,CAAC,kBAAkB,CAAC;MAC/EE,qBAAqB,EAAEA,CAAA,KAAM7B,OAAO,CAACmB,QAAQ,CAACQ,cAAc,CAAC,kBAAkB,CAAC;MAChFG,aAAa,EAAEA,CAAA,KAAM;QACjB,OAAO9B,OAAO,CAACmB,QAAQ,CAACC,oBAAoB,CAAC,MAAM;UAC/C,OAAOpB,OAAO,CAACY,GAAG,CAACmB,UAAU,CAAC,CAAC;QACnC,CAAC,CAAC;MACN;IACJ,CAAC,CAAC;IAEF/B,OAAO,CAACY,GAAG,GAAG;MACVT,IAAI;MACJU,IAAI,EAAEV,IAAI,KAAK,MAAM;MACrBW,OAAO,EAAEX,IAAI,KAAK,SAAS;MAC3BY,MAAM,EAAEZ,IAAI,KAAK,QAAQ;MACzBI,iBAAiB;MACjBiB,aAAa;MACbR,mBAAmB;MACnB,GAAG3C,qBAAqB,CAAC;QACrB2B;MACJ,CAAC,CAAC;MACF,GAAG1B,gBAAgB,CAAC;QAChB0B;MACJ,CAAC,CAAC;MACF,GAAGzB,sBAAsB,CAAC;QACtByB;MACJ,CAAC,CAAC;MACFgC,MAAM,EAAE;QACJ,GAAGtD,gBAAgB,CAACsB,OAAO;MAC/B,CAAC;MACDiC,SAAS,EAAE;QACP,GAAGtD,gBAAgB,CAACqB,OAAO;MAC/B;IACJ,CAAC;;IAED;IACAA,OAAO,CAACkC,SAAS,CAACC,gBAAgB,CAACjD,iBAAiB,EAAEqB,iBAAiB,CAAC;IACxEP,OAAO,CAACkC,SAAS,CAACC,gBAAgB,CAACpD,wBAAwB,EAAEyC,aAAa,CAAC;IAC3ExB,OAAO,CAACkC,SAAS,CAACC,gBAAgB,CAAClD,qBAAqB,EAAEe,OAAO,CAAC;IAClEA,OAAO,CAACkC,SAAS,CAACC,gBAAgB,CAAC9C,gBAAgB,EAAEW,OAAO,CAACC,OAAO,CAAC;IACrED,OAAO,CAACkC,SAAS,CAACC,gBAAgB,CAAC/C,uBAAuB,EAAE,CAACgD,KAAK,EAAEC,KAAK,KAAK;MAC1E,OAAO7C,uBAAuB,CAACQ,OAAO,EAAEoC,KAAK,EAAEC,KAAK,CAAC;IACzD,CAAC,CAAC;IACFrC,OAAO,CAACkC,SAAS,CAACC,gBAAgB,CAAChD,yBAAyB,EAAE,CAACiD,KAAK,EAAEC,KAAK,KAAK;MAC5E,OAAO9C,yBAAyB,CAACS,OAAO,EAAEoC,KAAK,EAAEC,KAAK,CAAC;IAC3D,CAAC,CAAC;IACFrC,OAAO,CAACkC,SAAS,CAACC,gBAAgB,CAAC7C,wBAAwB,EAAEgD,MAAM,IAAI;MACnE,OAAO7C,mBAAmB,CAAC;QACvBQ,OAAO,EAAED,OAAO,CAACC,OAAO;QACxBsC,MAAM,EAAED,MAAM,CAACC,MAAM;QACrBlB,KAAK,EAAE;MACX,CAAC,CAAC;IACN,CAAC,CAAC;;IAEF;IACAxC,mBAAmB,CAACyC,QAAQ,CAACtB,OAAO,CAACkC,SAAS,CAAC;IAC/CpD,qBAAqB,CAACwC,QAAQ,CAACtB,OAAO,CAACkC,SAAS,CAAC;IACjDvC,mBAAmB,CAAC2B,QAAQ,CAACtB,OAAO,CAACkC,SAAS,CAAC;IAC/CxC,wBAAwB,CAAC4B,QAAQ,CAACtB,OAAO,CAACkC,SAAS,CAAC;IACpDtC,mBAAmB,CAAC0B,QAAQ,CAACtB,OAAO,CAACkC,SAAS,CAAC;IAE/CrC,qBAAqB,CAACyB,QAAQ,CAACtB,OAAO,CAACkC,SAAS,CAAC;IACjDpC,oBAAoB,CAACwB,QAAQ,CAACtB,OAAO,CAACkC,SAAS,CAAC;IAEhD,IAAI,CAAC3B,iBAAiB,CAACiC,IAAI,EAAE;MACzB;IACJ;IACA,MAAMjC,iBAAiB,CAACiC,IAAI,CAACxC,OAAO,CAAC;EACzC,CAAC,CAAC;EAEFI,MAAM,CAACqC,IAAI,GAAG,mBAAmB;EAEjC,OAAOrC,MAAM;AACjB,CAAC","ignoreList":[]}

package/crud/AccessControl/AccessControl.d.ts

@@ -0,0 +1,97 @@
+import type { CmsEntry, CmsEntryPermission, CmsGroup, CmsGroupPermission, CmsModel, CmsModelPermission } from "../../types/index.js";
+import type { SecurityIdentity } from "@webiny/api-core/types/security.js";
+export interface AccessControlParams {
+    getIdentity: () => Promise<SecurityIdentity>;
+    getGroupsPermissions: () => Promise<CmsGroupPermission[]>;
+    getModelsPermissions: () => Promise<CmsModelPermission[]>;
+    getEntriesPermissions: () => Promise<CmsEntryPermission[]>;
+    listAllGroups: () => Promise<CmsGroup[]>;
+}
+interface GetGroupsAccessControlListParams {
+    group?: CmsGroup;
+}
+interface CanAccessGroupParams extends GetGroupsAccessControlListParams {
+    rwd?: string;
+}
+interface GetModelsAccessControlListParams {
+    model?: CmsModel;
+}
+interface CanAccessModelParams extends GetModelsAccessControlListParams {
+    rwd?: string;
+}
+interface GetEntriesAccessControlListParams {
+    model: Pick<CmsModel, "modelId" | "createdBy" | "group" | "authorization">;
+    entry?: Pick<CmsEntry, "entryId" | "createdBy">;
+}
+export interface CanAccessEntryParams extends GetEntriesAccessControlListParams {
+    rwd?: string;
+    pw?: string;
+}
+interface AccessControlEntry {
+    rwd: string;
+    canAccessNonOwned: boolean;
+    canAccessOnlyOwned: boolean;
+}
+type AccessControlList = AccessControlEntry[];
+interface EntriesAccessControlEntry extends AccessControlEntry {
+    pw?: string;
+}
+type EntriesAccessControlList = EntriesAccessControlEntry[];
+export declare class AccessControl {
+    getIdentity: AccessControlParams["getIdentity"];
+    getGroupsPermissions: AccessControlParams["getGroupsPermissions"];
+    getModelsPermissions: AccessControlParams["getModelsPermissions"];
+    getEntriesPermissions: AccessControlParams["getEntriesPermissions"];
+    listAllGroupsCallback: AccessControlParams["listAllGroups"];
+    private fullAccessPermissions;
+    private allGroups;
+    constructor({ getIdentity, getGroupsPermissions, getModelsPermissions, getEntriesPermissions, listAllGroups }: AccessControlParams);
+    /**
+     * Groups-related methods below. 👇
+     * - canAccessGroup
+     * - ensureCanAccessGroup
+     * - canAccessNonOwnedGroups
+     * - canAccessOnlyOwnedGroups
+     * - getGroupsAccessControlList
+     * - hasFullAccessToGroups
+     */
+    canAccessGroup(params?: CanAccessGroupParams): Promise<boolean>;
+    canAccessNonOwnedGroups(params: GetGroupsAccessControlListParams): Promise<boolean>;
+    canAccessOnlyOwnedGroups(params: GetGroupsAccessControlListParams): Promise<boolean>;
+    getGroupsAccessControlList(params: GetGroupsAccessControlListParams): Promise<AccessControlList>;
+    hasFullAccessToGroups(): Promise<boolean>;
+    /**
+     * Models-related methods below. 👇
+     * - canAccessModel
+     * - ensureCanAccessModel
+     * - canAccessNonOwnedModels
+     * - canAccessOnlyOwnedModels
+     * - getModelsAccessControlList
+     * - hasFullAccessToModels
+     */
+    canAccessModel(params: CanAccessModelParams): Promise<boolean>;
+    ensureCanAccessModel(params?: CanAccessModelParams): Promise<void>;
+    canAccessNonOwnedModels(params: GetModelsAccessControlListParams): Promise<boolean>;
+    canAccessOnlyOwnedModels(params: GetModelsAccessControlListParams): Promise<boolean>;
+    getModelsAccessControlList(params: GetModelsAccessControlListParams): Promise<AccessControlList>;
+    hasFullAccessToModels(params: GetModelsAccessControlListParams): Promise<boolean>;
+    /**
+     * Entries-related methods below. 👇
+     * - canAccessEntry
+     * - ensureCanAccessEntry
+     * - canAccessNonOwnedEntries
+     * - canAccessOnlyOwnedEntries
+     * - getEntriesAccessControlList
+     * - hasFullAccessToEntries
+     */
+    canAccessEntry(params: CanAccessEntryParams): Promise<boolean>;
+    ensureCanAccessEntry(params: CanAccessEntryParams): Promise<void>;
+    canAccessNonOwnedEntries(params: GetEntriesAccessControlListParams): Promise<boolean>;
+    canAccessOnlyOwnedEntries(params: GetEntriesAccessControlListParams): Promise<boolean>;
+    getEntriesAccessControlList(params: GetEntriesAccessControlListParams): Promise<EntriesAccessControlList>;
+    hasFullAccessToEntries(params: GetEntriesAccessControlListParams): Promise<boolean>;
+    private modelAuthorizationDisabled;
+    private listAllGroups;
+    private getGroup;
+}
+export {};