@webiny/api-headless-cms-ddb 5.17.4 → 5.18.0-beta.3

package/dynamoDb/storage/richText.d.ts

@@ -1,8 +1,8 @@
-import { CmsModelFieldToStoragePlugin } from "@webiny/api-headless-cms/types";
+import { StorageTransformPlugin } from "@webiny/api-headless-cms/content/plugins/storage/StorageTransformPlugin";
 export declare type OriginalValue = Record<string, any> | any[];
 export interface StorageValue {
     compression: string;
     value: any;
 }
-declare const _default: () => CmsModelFieldToStoragePlugin<OriginalValue, StorageValue>;
+declare const _default: () => StorageTransformPlugin<any, any>;
 export default _default;

package/dynamoDb/storage/richText.js

@@ -11,12 +11,18 @@ var _jsonpack = _interopRequireDefault(require("jsonpack"));
 
 var _error = _interopRequireDefault(require("@webiny/error"));
 
+var _StorageTransformPlugin = require("@webiny/api-headless-cms/content/plugins/storage/StorageTransformPlugin");
+
 /**
  * Remove when jsonpack gets PR with a fix merged
  * https://github.com/rgcl/jsonpack/pull/25/files
  * NOTE 2021-07-28: it seems PR is not going to be merged so keep this.
  */
 const transformArray = value => {
+  if (!value) {
+    return value;
+  }
+
   let isArray = Array.isArray(value);
   const shouldBeArray = value instanceof Array === false && isArray;
 
@@ -34,75 +40,71 @@ const transformArray = value => {
   return value;
 };
 
-var _default = () => {
-  return {
-    type: "cms-model-field-to-storage",
-    name: "cms-model-field-to-storage-rich-text",
-    fieldType: "rich-text",
-
-    async fromStorage({
-      field,
-      value: storageValue
-    }) {
-      if (!storageValue) {
-        return storageValue;
-      } else if (typeof storageValue !== "object") {
-        throw new _error.default(`Value received in "fromStorage" function is not an object in field "${field.fieldId}".`);
-      }
-      /**
-       * This is to circumvent a bug introduced with 5.8.0 storage operations.
-       * Do not remove.
-       */
-
-
-      if (storageValue.hasOwnProperty("compression") === false) {
-        return storageValue;
-      }
-
-      const {
-        compression,
-        value
-      } = storageValue;
-
-      if (!compression) {
-        throw new _error.default(`Missing compression in "fromStorage" function in field "${field.fieldId}": ${JSON.stringify(storageValue)}.`, "MISSING_COMPRESSION", {
-          value: storageValue
-        });
-      }
-
-      if (compression !== "jsonpack") {
-        throw new _error.default(`This plugin cannot transform something not packed with "jsonpack".`, "WRONG_COMPRESSION", {
-          compression
-        });
-      }
-
-      try {
-        return _jsonpack.default.unpack(value);
-      } catch {
-        return null;
-      }
-    },
-
-    async toStorage({
+const plugin = new _StorageTransformPlugin.StorageTransformPlugin({
+  fieldType: "rich-text",
+  fromStorage: async ({
+    field,
+    value: storageValue
+  }) => {
+    if (!storageValue) {
+      return storageValue;
+    } else if (typeof storageValue !== "object") {
+      throw new _error.default(`RichText value received in "fromStorage" function is not an object in field "${field.fieldId}".`);
+    }
+    /**
+     * This is to circumvent a bug introduced with 5.8.0 storage operations.
+     * Do not remove.
+     */
+
+
+    if (storageValue.hasOwnProperty("compression") === false) {
+      return storageValue;
+    }
+
+    const {
+      compression,
       value
-    }) {
-      /**
-       * There is a possibility that we are trying to compress already compressed value.
-       * Introduced a bug with 5.8.0 storage operations, so just return the value to correct it.
-       */
-      if (value && value.hasOwnProperty("compression") === true) {
-        return value;
-      }
-
-      value = transformArray(value);
-      return {
-        compression: "jsonpack",
-        value: value ? _jsonpack.default.pack(value) : value
-      };
+    } = storageValue;
+
+    if (!compression) {
+      throw new _error.default(`Missing compression in "fromStorage" function in field "${field.fieldId}": ${JSON.stringify(storageValue)}.`, "MISSING_COMPRESSION", {
+        value: storageValue
+      });
     }
 
-  };
+    if (compression !== "jsonpack") {
+      throw new _error.default(`This plugin cannot transform something not packed with "jsonpack".`, "WRONG_COMPRESSION", {
+        compression
+      });
+    }
+
+    try {
+      return _jsonpack.default.unpack(value);
+    } catch {
+      return null;
+    }
+  },
+  toStorage: async ({
+    value
+  }) => {
+    /**
+     * There is a possibility that we are trying to compress already compressed value.
+     * Introduced a bug with 5.8.0 storage operations, so just return the value to correct it.
+     */
+    if (value && value.hasOwnProperty("compression") === true) {
+      return value;
+    }
+
+    value = transformArray(value);
+    return {
+      compression: "jsonpack",
+      value: value ? _jsonpack.default.pack(value) : value
+    };
+  }
+});
+
+var _default = () => {
+  return plugin;
 };
 
-exports.default = _default;
-//# sourceMappingURL=richText.js.map
+exports.default = _default;

package/dynamoDb/transformValue/datetime.d.ts

@@ -1,3 +1,3 @@
 import { CmsFieldFilterValueTransformPlugin } from "../../types";
-declare const _default: () => CmsFieldFilterValueTransformPlugin<Date | string | number, number>;
+declare const _default: () => CmsFieldFilterValueTransformPlugin;
 export default _default;

package/dynamoDb/transformValue/datetime.js

@@ -44,5 +44,4 @@ var _default = () => ({
   }
 });
 
-exports.default = _default;
-//# sourceMappingURL=datetime.js.map
+exports.default = _default;

package/index.d.ts

@@ -1,6 +1,2 @@
-import { CmsContentEntryConfiguration } from "./operations/entry/CmsContentEntryDynamo";
-interface Configuration {
-    entry?: CmsContentEntryConfiguration;
-}
-declare const _default: (configuration?: Configuration) => (import("@webiny/api-headless-cms/types").CmsContentModelGroupStorageOperationsProvider | import("@webiny/api-headless-cms/types").CmsContentModelStorageOperationsProvider | import("@webiny/api-headless-cms/types").CmsContentEntryStorageOperationsProvider | import("@webiny/api-headless-cms/types").CmsSettingsStorageOperationsProviderPlugin | import("@webiny/api-headless-cms/types").CmsSystemStorageOperationsProviderPlugin | (import("./types").CmsFieldFilterPathPlugin | import("@webiny/api-headless-cms/types").CmsModelFieldToStoragePlugin<import("./dynamoDb/storage/richText").OriginalValue, import("./dynamoDb/storage/richText").StorageValue> | import("@webiny/api-headless-cms/types").CmsModelFieldToStoragePlugin<string | Date, string> | import("./types").CmsFieldFilterValueTransformPlugin<string | number | Date, number>)[])[];
-export default _default;
+import { StorageOperationsFactory } from "./types";
+export declare const createStorageOperations: StorageOperationsFactory;

package/index.js

@@ -5,26 +5,121 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.createStorageOperations = void 0;
 
-var _settings = _interopRequireDefault(require("./operations/settings"));
+var _filters = _interopRequireDefault(require("@webiny/db-dynamodb/plugins/filters"));
 
-var _system = _interopRequireDefault(require("./operations/system"));
+var _dynamoDb = _interopRequireDefault(require("./dynamoDb"));
 
-var _modelGroup = _interopRequireDefault(require("./operations/modelGroup"));
+var _types = require("./types");
 
-var _model = _interopRequireDefault(require("./operations/model"));
+var _table = require("./definitions/table");
 
-var _entry = _interopRequireDefault(require("./operations/entry"));
+var _settings = require("./definitions/settings");
 
-var _dynamoDb = _interopRequireDefault(require("./dynamoDb"));
+var _system = require("./definitions/system");
+
+var _group = require("./definitions/group");
+
+var _model = require("./definitions/model");
+
+var _entry = require("./definitions/entry");
+
+var _plugins = require("@webiny/plugins");
+
+var _system2 = require("./operations/system");
+
+var _settings2 = require("./operations/settings");
+
+var _group2 = require("./operations/group");
+
+var _model2 = require("./operations/model");
+
+var _entry2 = require("./operations/entry");
 
-var _default = configuration => {
+const createStorageOperations = params => {
   const {
-    entry
-  } = configuration || {};
-  return [(0, _settings.default)(), (0, _system.default)(), (0, _modelGroup.default)(), (0, _model.default)(), (0, _entry.default)(entry), (0, _dynamoDb.default)()];
+    attributes = {},
+    table,
+    documentClient,
+    plugins: customPlugins,
+    modelFieldToGraphQLPlugins
+  } = params;
+  const tableInstance = (0, _table.createTable)({
+    table,
+    documentClient
+  });
+  const entities = {
+    settings: (0, _settings.createSettingsEntity)({
+      entityName: _types.ENTITIES.SETTINGS,
+      table: tableInstance,
+      attributes: attributes[_types.ENTITIES.SETTINGS]
+    }),
+    system: (0, _system.createSystemEntity)({
+      entityName: _types.ENTITIES.SYSTEM,
+      table: tableInstance,
+      attributes: attributes[_types.ENTITIES.SYSTEM]
+    }),
+    groups: (0, _group.createGroupEntity)({
+      entityName: _types.ENTITIES.GROUPS,
+      table: tableInstance,
+      attributes: attributes[_types.ENTITIES.GROUPS]
+    }),
+    models: (0, _model.createModelEntity)({
+      entityName: _types.ENTITIES.MODELS,
+      table: tableInstance,
+      attributes: attributes[_types.ENTITIES.MODELS]
+    }),
+    entries: (0, _entry.createEntryEntity)({
+      entityName: _types.ENTITIES.ENTRIES,
+      table: tableInstance,
+      attributes: attributes[_types.ENTITIES.ENTRIES]
+    })
+  };
+  const plugins = new _plugins.PluginsContainer([
+  /**
+   * User defined custom plugins.
+   */
+  ...(customPlugins || []),
+  /**
+   * Plugins of type CmsModelFieldToGraphQLPlugin.
+   */
+  modelFieldToGraphQLPlugins,
+  /**
+   * DynamoDB filter plugins for the where conditions.
+   */
+  (0, _filters.default)(),
+  /**
+   * Field plugins for DynamoDB.
+   */
+  (0, _dynamoDb.default)()]);
+  return {
+    plugins: [
+    /**
+     * Field plugins for DynamoDB.
+     * We must pass them to the base application.
+     */
+    (0, _dynamoDb.default)()],
+    getEntities: () => entities,
+    getTable: () => tableInstance,
+    system: (0, _system2.createSystemStorageOperations)({
+      entity: entities.system
+    }),
+    settings: (0, _settings2.createSettingsStorageOperations)({
+      entity: entities.settings
+    }),
+    groups: (0, _group2.createGroupsStorageOperations)({
+      entity: entities.groups,
+      plugins
+    }),
+    models: (0, _model2.createModelsStorageOperations)({
+      entity: entities.models
+    }),
+    entries: (0, _entry2.createEntriesStorageOperations)({
+      entity: entities.entries,
+      plugins
+    })
+  };
 };
 
-exports.default = _default;
-//# sourceMappingURL=index.js.map
+exports.createStorageOperations = createStorageOperations;

package/operations/entry/dataLoaders.d.ts

@@ -1,23 +1,38 @@
-import { CmsContentEntry, CmsContentModel, CmsContext } from "@webiny/api-headless-cms/types";
-import { CmsContentEntryDynamo } from "./CmsContentEntryDynamo";
+import { CmsEntry, CmsModel } from "@webiny/api-headless-cms/types";
+import { Entity } from "dynamodb-toolbox";
+export interface GetAllEntryRevisionsParams {
+    ids: readonly string[];
+    model: CmsModel;
+}
+export interface GetRevisionByIdParams {
+    ids: readonly string[];
+    model: CmsModel;
+}
+export interface GetPublishedRevisionByEntryIdParams {
+    ids: readonly string[];
+    model: CmsModel;
+}
+export interface GetLatestRevisionByEntryIdParams {
+    ids: readonly string[];
+    model: CmsModel;
+}
+interface ClearLoaderParams {
+    model: CmsModel;
+    entry?: CmsEntry;
+}
+export interface Params {
+    entity: Entity<any>;
+}
 export declare class DataLoadersHandler {
-    private readonly _loaders;
-    private readonly _context;
-    private readonly _storageOperations;
-    constructor(context: CmsContext, storageOperations: CmsContentEntryDynamo);
-    getAllEntryRevisions(model: CmsContentModel, ids: readonly string[]): Promise<CmsContentEntry[]>;
-    clearAllEntryRevisions(model: CmsContentModel, entry?: CmsContentEntry): void;
-    getRevisionById(model: CmsContentModel, ids: readonly string[]): Promise<CmsContentEntry[]>;
-    clearRevisionById(model: CmsContentModel, entry?: CmsContentEntry): void;
-    getPublishedRevisionByEntryId(model: CmsContentModel, ids: readonly string[]): Promise<CmsContentEntry[]>;
-    clearPublishedRevisionByEntryId(model: CmsContentModel, entry?: CmsContentEntry): void;
-    getLatestRevisionByEntryId(model: CmsContentModel, ids: readonly string[]): Promise<CmsContentEntry[]>;
-    clearLatestRevisionByEntryId(model: CmsContentModel, entry?: CmsContentEntry): void;
+    private readonly loaders;
+    private readonly entity;
+    constructor(params: any);
+    getAllEntryRevisions(params: GetAllEntryRevisionsParams): Promise<CmsEntry[]>;
+    getRevisionById(params: GetRevisionByIdParams): Promise<CmsEntry[]>;
+    getPublishedRevisionByEntryId(params: GetPublishedRevisionByEntryIdParams): Promise<CmsEntry[]>;
+    getLatestRevisionByEntryId(params: GetLatestRevisionByEntryIdParams): Promise<CmsEntry[]>;
     private getLoader;
     private loadMany;
-    /**
-     * Helper to clear the cache for certain data loader.
-     * If entry is passed then clear target key only.
-     */
-    private clear;
+    clearAll(params: Omit<ClearLoaderParams, "entry">): void;
 }
+export {};