@webiny/api-headless-cms-ddb 0.0.0-mt-3 → 0.0.0-unstable.2af142b57e

package/plugins/CmsEntryFieldFilterPlugin.d.ts

@@ -0,0 +1,43 @@
+import { Plugin } from "@webiny/plugins";
+import { ValueFilterPlugin } from "@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin";
+import { Field } from "../operations/entry/filtering/types";
+import { CmsFieldFilterValueTransformPlugin } from "../types";
+/**
+ * This plugin is used to create the filter.
+ * Internally we have default one + the one for the reference field - because it is actually an object when filtering.
+ */
+interface CmsEntryFieldFilterPluginParams {
+    fieldType: string;
+    create: (params: CmsEntryFieldFilterPluginCreateParams) => null | CmsEntryFieldFilterPluginCreateResponse | CmsEntryFieldFilterPluginCreateResponse[];
+}
+interface CmsEntryFieldFilterPluginCreateParams {
+    key: string;
+    value: any;
+    field: Field;
+    fields: Record<string, Field>;
+    operation: string;
+    valueFilterPlugins: Record<string, ValueFilterPlugin>;
+    transformValuePlugins: Record<string, CmsFieldFilterValueTransformPlugin>;
+    getFilterCreatePlugin: (type: string) => CmsEntryFieldFilterPlugin;
+    negate: boolean;
+    compareValue: any;
+    transformValue: <I = any, O = any>(value: I) => O;
+}
+export interface CmsEntryFieldFilterPluginCreateResponse {
+    field: Field;
+    path: string;
+    fieldPathId: string;
+    plugin: ValueFilterPlugin;
+    negate: boolean;
+    compareValue: any;
+    transformValue: <I = any, O = any>(value: I) => O;
+}
+export declare class CmsEntryFieldFilterPlugin extends Plugin {
+    static readonly type: string;
+    static readonly ALL: string;
+    private readonly config;
+    readonly fieldType: string;
+    constructor(config: CmsEntryFieldFilterPluginParams);
+    create(params: CmsEntryFieldFilterPluginCreateParams): CmsEntryFieldFilterPluginCreateResponse | CmsEntryFieldFilterPluginCreateResponse[] | null;
+}
+export {};

package/plugins/CmsEntryFieldFilterPlugin.js

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CmsEntryFieldFilterPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _plugins = require("@webiny/plugins");
+class CmsEntryFieldFilterPlugin extends _plugins.Plugin {
+  constructor(config) {
+    super();
+    (0, _defineProperty2.default)(this, "config", void 0);
+    (0, _defineProperty2.default)(this, "fieldType", void 0);
+    this.config = config;
+    this.fieldType = this.config.fieldType;
+  }
+  create(params) {
+    return this.config.create(params);
+  }
+}
+exports.CmsEntryFieldFilterPlugin = CmsEntryFieldFilterPlugin;
+(0, _defineProperty2.default)(CmsEntryFieldFilterPlugin, "type", "cms.dynamodb.entry.field.filter");
+(0, _defineProperty2.default)(CmsEntryFieldFilterPlugin, "ALL", "*");

package/plugins/CmsEntryFieldFilterPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CmsEntryFieldFilterPlugin","Plugin","constructor","config","fieldType","create","params"],"sources":["CmsEntryFieldFilterPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { ValueFilterPlugin } from \"@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin\";\nimport { Field } from \"~/operations/entry/filtering/types\";\nimport { CmsFieldFilterValueTransformPlugin } from \"~/types\";\n\n/**\n * This plugin is used to create the filter.\n * Internally we have default one + the one for the reference field - because it is actually an object when filtering.\n */\n\ninterface CmsEntryFieldFilterPluginParams {\n    fieldType: string;\n    create: (\n        params: CmsEntryFieldFilterPluginCreateParams\n    ) => null | CmsEntryFieldFilterPluginCreateResponse | CmsEntryFieldFilterPluginCreateResponse[];\n}\n\ninterface CmsEntryFieldFilterPluginCreateParams {\n    key: string;\n    value: any;\n    field: Field;\n    fields: Record<string, Field>;\n    operation: string;\n    valueFilterPlugins: Record<string, ValueFilterPlugin>;\n    transformValuePlugins: Record<string, CmsFieldFilterValueTransformPlugin>;\n    getFilterCreatePlugin: (type: string) => CmsEntryFieldFilterPlugin;\n    negate: boolean;\n    compareValue: any;\n    transformValue: <I = any, O = any>(value: I) => O;\n}\n\nexport interface CmsEntryFieldFilterPluginCreateResponse {\n    field: Field;\n    path: string;\n    fieldPathId: string;\n    plugin: ValueFilterPlugin;\n    negate: boolean;\n    compareValue: any;\n    transformValue: <I = any, O = any>(value: I) => O;\n}\n\nexport class CmsEntryFieldFilterPlugin extends Plugin {\n    public static override readonly type: string = \"cms.dynamodb.entry.field.filter\";\n    public static readonly ALL: string = \"*\";\n\n    private readonly config: CmsEntryFieldFilterPluginParams;\n\n    public readonly fieldType: string;\n\n    public constructor(config: CmsEntryFieldFilterPluginParams) {\n        super();\n        this.config = config;\n        this.fieldType = this.config.fieldType;\n    }\n\n    public create(params: CmsEntryFieldFilterPluginCreateParams) {\n        return this.config.create(params);\n    }\n}\n"],"mappings":";;;;;;;;AAAA;AAyCO,MAAMA,yBAAyB,SAASC,eAAM,CAAC;EAQ3CC,WAAW,CAACC,MAAuC,EAAE;IACxD,KAAK,EAAE;IAAC;IAAA;IACR,IAAI,CAACA,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,SAAS,GAAG,IAAI,CAACD,MAAM,CAACC,SAAS;EAC1C;EAEOC,MAAM,CAACC,MAA6C,EAAE;IACzD,OAAO,IAAI,CAACH,MAAM,CAACE,MAAM,CAACC,MAAM,CAAC;EACrC;AACJ;AAAC;AAAA,8BAjBYN,yBAAyB,UACa,iCAAiC;AAAA,8BADvEA,yBAAyB,SAEG,GAAG"}

package/plugins/CmsEntryFieldSortingPlugin.d.ts

@@ -0,0 +1,42 @@
+import { Plugin } from "@webiny/plugins";
+import { Field } from "../operations/entry/filtering/types";
+import { CmsModel } from "@webiny/api-headless-cms/types";
+interface CmsEntryFieldSortingPluginCanUseParams {
+    model: CmsModel;
+    field?: Field;
+    fieldId: string;
+    order: "ASC" | "DESC";
+    /**
+     * Combination of fieldId and sortBy
+     *
+     * example: id_ASC or createdBy_DESC
+     */
+    sortBy: string;
+}
+interface CmsEntryFieldSortingPluginCreateSortParams {
+    model: CmsModel;
+    fieldId: string;
+    order: "ASC" | "DESC";
+    sortBy: string;
+    fields: Record<string, Field>;
+    field?: Field;
+}
+interface CmsEntryFieldSortingPluginCreateSortResult {
+    valuePath: string;
+    reverse: boolean;
+    fieldId: string;
+    field: Field;
+}
+interface CmsEntryFieldSortingPluginConfig {
+    createSort: (params: CmsEntryFieldSortingPluginCreateSortParams) => CmsEntryFieldSortingPluginCreateSortResult;
+    canUse: (params: CmsEntryFieldSortingPluginCanUseParams) => boolean;
+}
+export declare class CmsEntryFieldSortingPlugin extends Plugin {
+    static readonly type: string;
+    private readonly config;
+    constructor(config: CmsEntryFieldSortingPluginConfig);
+    canUse(params: CmsEntryFieldSortingPluginCanUseParams): boolean;
+    createSort(params: CmsEntryFieldSortingPluginCreateSortParams): CmsEntryFieldSortingPluginCreateSortResult;
+}
+export declare const createCmsEntryFieldSortingPlugin: (config: CmsEntryFieldSortingPluginConfig) => CmsEntryFieldSortingPlugin;
+export {};

package/plugins/CmsEntryFieldSortingPlugin.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCmsEntryFieldSortingPlugin = exports.CmsEntryFieldSortingPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _plugins = require("@webiny/plugins");
+class CmsEntryFieldSortingPlugin extends _plugins.Plugin {
+  constructor(config) {
+    super();
+    (0, _defineProperty2.default)(this, "config", void 0);
+    this.config = config;
+  }
+  canUse(params) {
+    return this.config.canUse(params);
+  }
+  createSort(params) {
+    return this.config.createSort(params);
+  }
+}
+exports.CmsEntryFieldSortingPlugin = CmsEntryFieldSortingPlugin;
+(0, _defineProperty2.default)(CmsEntryFieldSortingPlugin, "type", "cms.entry.field.sorting");
+const createCmsEntryFieldSortingPlugin = config => {
+  return new CmsEntryFieldSortingPlugin(config);
+};
+exports.createCmsEntryFieldSortingPlugin = createCmsEntryFieldSortingPlugin;

package/plugins/CmsEntryFieldSortingPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CmsEntryFieldSortingPlugin","Plugin","constructor","config","canUse","params","createSort","createCmsEntryFieldSortingPlugin"],"sources":["CmsEntryFieldSortingPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { Field } from \"~/operations/entry/filtering/types\";\nimport { CmsModel } from \"@webiny/api-headless-cms/types\";\n\ninterface CmsEntryFieldSortingPluginCanUseParams {\n    model: CmsModel;\n    field?: Field;\n    fieldId: string;\n    order: \"ASC\" | \"DESC\";\n    /**\n     * Combination of fieldId and sortBy\n     *\n     * example: id_ASC or createdBy_DESC\n     */\n    sortBy: string;\n}\n\ninterface CmsEntryFieldSortingPluginCreateSortParams {\n    model: CmsModel;\n    fieldId: string;\n    order: \"ASC\" | \"DESC\";\n    sortBy: string;\n    fields: Record<string, Field>;\n    field?: Field;\n}\n\ninterface CmsEntryFieldSortingPluginCreateSortResult {\n    valuePath: string;\n    reverse: boolean;\n    fieldId: string;\n    field: Field;\n}\n\ninterface CmsEntryFieldSortingPluginConfig {\n    createSort: (\n        params: CmsEntryFieldSortingPluginCreateSortParams\n    ) => CmsEntryFieldSortingPluginCreateSortResult;\n    canUse: (params: CmsEntryFieldSortingPluginCanUseParams) => boolean;\n}\n\nexport class CmsEntryFieldSortingPlugin extends Plugin {\n    public static override readonly type: string = \"cms.entry.field.sorting\";\n    private readonly config: CmsEntryFieldSortingPluginConfig;\n\n    public constructor(config: CmsEntryFieldSortingPluginConfig) {\n        super();\n        this.config = config;\n    }\n\n    public canUse(params: CmsEntryFieldSortingPluginCanUseParams): boolean {\n        return this.config.canUse(params);\n    }\n\n    public createSort(\n        params: CmsEntryFieldSortingPluginCreateSortParams\n    ): CmsEntryFieldSortingPluginCreateSortResult {\n        return this.config.createSort(params);\n    }\n}\n\nexport const createCmsEntryFieldSortingPlugin = (config: CmsEntryFieldSortingPluginConfig) => {\n    return new CmsEntryFieldSortingPlugin(config);\n};\n"],"mappings":";;;;;;;;AAAA;AAwCO,MAAMA,0BAA0B,SAASC,eAAM,CAAC;EAI5CC,WAAW,CAACC,MAAwC,EAAE;IACzD,KAAK,EAAE;IAAC;IACR,IAAI,CAACA,MAAM,GAAGA,MAAM;EACxB;EAEOC,MAAM,CAACC,MAA8C,EAAW;IACnE,OAAO,IAAI,CAACF,MAAM,CAACC,MAAM,CAACC,MAAM,CAAC;EACrC;EAEOC,UAAU,CACbD,MAAkD,EACR;IAC1C,OAAO,IAAI,CAACF,MAAM,CAACG,UAAU,CAACD,MAAM,CAAC;EACzC;AACJ;AAAC;AAAA,8BAlBYL,0BAA0B,UACY,yBAAyB;AAmBrE,MAAMO,gCAAgC,GAAIJ,MAAwC,IAAK;EAC1F,OAAO,IAAIH,0BAA0B,CAACG,MAAM,CAAC;AACjD,CAAC;AAAC"}

package/plugins/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./CmsEntryFieldFilterPathPlugin";
+export * from "./CmsEntryFieldSortingPlugin";
+export * from "./CmsEntryFieldFilterPlugin";

package/plugins/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _CmsEntryFieldFilterPathPlugin = require("./CmsEntryFieldFilterPathPlugin");
+Object.keys(_CmsEntryFieldFilterPathPlugin).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _CmsEntryFieldFilterPathPlugin[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _CmsEntryFieldFilterPathPlugin[key];
+    }
+  });
+});
+var _CmsEntryFieldSortingPlugin = require("./CmsEntryFieldSortingPlugin");
+Object.keys(_CmsEntryFieldSortingPlugin).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _CmsEntryFieldSortingPlugin[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _CmsEntryFieldSortingPlugin[key];
+    }
+  });
+});
+var _CmsEntryFieldFilterPlugin = require("./CmsEntryFieldFilterPlugin");
+Object.keys(_CmsEntryFieldFilterPlugin).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _CmsEntryFieldFilterPlugin[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _CmsEntryFieldFilterPlugin[key];
+    }
+  });
+});

package/plugins/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./CmsEntryFieldFilterPathPlugin\";\nexport * from \"./CmsEntryFieldSortingPlugin\";\nexport * from \"./CmsEntryFieldFilterPlugin\";\n"],"mappings":";;;;;AAAA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}

package/types.d.ts

@@ -1,5 +1,5 @@
 import { Plugin } from "@webiny/plugins/types";
-import { CmsModelField, CmsModelFieldToGraphQLPlugin, HeadlessCmsStorageOperations as BaseHeadlessCmsStorageOperations } from "@webiny/api-headless-cms/types";
+import { CmsModelField, HeadlessCmsStorageOperations as BaseHeadlessCmsStorageOperations } from "@webiny/api-headless-cms/types";
 import { DynamoDBTypes, TableConstructor } from "dynamodb-toolbox/dist/classes/Table";
 import { EntityAttributeConfig, EntityCompositeAttributes } from "dynamodb-toolbox/dist/classes/Entity";
 import { DocumentClient } from "aws-sdk/clients/dynamodb";
@@ -8,7 +8,7 @@ interface CmsFieldFilterValueTransformParams {
     /**
      * A field which value we are transforming.
      */
-    field: CmsModelField;
+    field: Partial<CmsModelField> & Pick<CmsModelField, "id" | "storageId" | "fieldId" | "settings">;
     value: any;
 }
 export interface CmsFieldFilterValueTransformPlugin extends Plugin {
@@ -25,36 +25,6 @@ export interface CmsFieldFilterValueTransformPlugin extends Plugin {
      */
     transform: (params: CmsFieldFilterValueTransformParams) => any;
 }
-interface CmsFieldFilterPathParams {
-    /**
-     * A field for which we are creating the value path.
-     */
-    field: CmsModelField;
-    /**
-     * If value is an array we will need index position.
-     * It is up to the developer to add.
-     */
-    index?: number | string;
-}
-export interface CmsFieldFilterPathPlugin extends Plugin {
-    /**
-     * A plugin type.
-     */
-    type: "cms-field-filter-path";
-    /**
-     * A field type this plugin is for.
-     */
-    fieldType: string;
-    /**
-     * A field id this plugin is for.
-     * It is meant for targeting only specific fields in a certain type.
-     */
-    fieldId?: string[];
-    /**
-     * Get a path for given field.
-     */
-    createPath: (params: CmsFieldFilterPathParams) => string;
-}
 export declare type AttributeDefinition = DynamoDBTypes | EntityAttributeConfig | EntityCompositeAttributes;
 export declare type Attributes = Record<string, AttributeDefinition>;
 export declare enum ENTITIES {
@@ -70,7 +40,6 @@ export interface TableModifier {
 export interface StorageOperationsFactoryParams {
     documentClient: DocumentClient;
     table?: TableModifier;
-    modelFieldToGraphQLPlugins: CmsModelFieldToGraphQLPlugin[];
     attributes?: Record<ENTITIES, Attributes>;
     plugins?: Plugin[] | Plugin[][];
 }

package/types.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.ENTITIES = void 0;
 let ENTITIES;
 exports.ENTITIES = ENTITIES;
-
 (function (ENTITIES) {
   ENTITIES["SYSTEM"] = "CmsSystem";
   ENTITIES["SETTINGS"] = "CmsSettings";

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ENTITIES"],"sources":["types.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins/types\";\nimport {\n    CmsModelField,\n    HeadlessCmsStorageOperations as BaseHeadlessCmsStorageOperations\n} from \"@webiny/api-headless-cms/types\";\nimport { DynamoDBTypes, TableConstructor } from \"dynamodb-toolbox/dist/classes/Table\";\nimport {\n    EntityAttributeConfig,\n    EntityCompositeAttributes\n} from \"dynamodb-toolbox/dist/classes/Entity\";\nimport { DocumentClient } from \"aws-sdk/clients/dynamodb\";\nimport { Entity, Table } from \"dynamodb-toolbox\";\n\ninterface CmsFieldFilterValueTransformParams {\n    /**\n     * A field which value we are transforming.\n     */\n    field: Partial<CmsModelField> &\n        Pick<CmsModelField, \"id\" | \"storageId\" | \"fieldId\" | \"settings\">;\n    value: any;\n}\n\nexport interface CmsFieldFilterValueTransformPlugin extends Plugin {\n    /**\n     * A plugin type.\n     */\n    type: \"cms-field-filter-value-transform\";\n    /**\n     * A field type this plugin is for.\n     */\n    fieldType: string;\n    /**\n     * Transform method which expect field definition and value to transform.\n     */\n    transform: (params: CmsFieldFilterValueTransformParams) => any;\n}\n\nexport type AttributeDefinition = DynamoDBTypes | EntityAttributeConfig | EntityCompositeAttributes;\n\nexport type Attributes = Record<string, AttributeDefinition>;\n\nexport enum ENTITIES {\n    SYSTEM = \"CmsSystem\",\n    SETTINGS = \"CmsSettings\",\n    GROUPS = \"CmsGroups\",\n    MODELS = \"CmsModels\",\n    ENTRIES = \"CmsEntries\"\n}\n\nexport interface TableModifier {\n    (table: TableConstructor): TableConstructor;\n}\n\nexport interface StorageOperationsFactoryParams {\n    documentClient: DocumentClient;\n    table?: TableModifier;\n    attributes?: Record<ENTITIES, Attributes>;\n    plugins?: Plugin[] | Plugin[][];\n}\n\nexport interface HeadlessCmsStorageOperations extends BaseHeadlessCmsStorageOperations {\n    getTable: () => Table;\n    getEntities: () => Record<\"system\" | \"settings\" | \"groups\" | \"models\" | \"entries\", Entity<any>>;\n}\n\nexport interface StorageOperationsFactory {\n    (params: StorageOperationsFactoryParams): HeadlessCmsStorageOperations;\n}\n"],"mappings":";;;;;;IAyCYA,QAAQ;AAAA;AAAA,WAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;AAAA,GAARA,QAAQ,wBAARA,QAAQ"}

package/dynamoDb/path/ref.d.ts

@@ -1,3 +0,0 @@
-import { CmsFieldFilterPathPlugin } from "../../types";
-declare const _default: () => CmsFieldFilterPathPlugin;
-export default _default;

package/dynamoDb/path/ref.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _default = () => ({
-  type: "cms-field-filter-path",
-  name: "cms-field-filter-path-ref",
-  fieldType: "ref",
-  createPath: ({
-    field,
-    index
-  }) => {
-    const paths = [field.fieldId];
-
-    if (index !== undefined) {
-      paths.push(String(index));
-    }
-
-    paths.push("entryId");
-    return paths.join(".");
-  }
-});
-
-exports.default = _default;

package/operations/entry/utils.d.ts

@@ -1,31 +0,0 @@
-import { CmsEntry, CmsEntryListWhere, CmsModel, CmsModelField } from "@webiny/api-headless-cms/types";
-import { PluginsContainer } from "@webiny/plugins";
-interface ModelField {
-    def: CmsModelField;
-    valueTransformer: (value: any) => any;
-    valuePath: string;
-    isSystemField?: boolean;
-}
-declare type ModelFieldRecords = Record<string, ModelField>;
-export interface FilterItemFromStorage {
-    (field: CmsModelField, value: any): Promise<any>;
-}
-interface FilterItemsParams {
-    items: CmsEntry[];
-    where: CmsEntryListWhere;
-    plugins: PluginsContainer;
-    fields: ModelFieldRecords;
-    fromStorage: FilterItemFromStorage;
-}
-export declare const filterItems: (params: FilterItemsParams) => Promise<CmsEntry[]>;
-interface SortEntryItemsArgs {
-    items: CmsEntry[];
-    sort: string[];
-    fields: ModelFieldRecords;
-}
-export declare const sortEntryItems: (params: SortEntryItemsArgs) => CmsEntry[];
-export declare const buildModelFields: ({ plugins, model }: {
-    plugins: PluginsContainer;
-    model: CmsModel;
-}) => Record<string, ModelField>;
-export {};