@webiny/api-headless-cms-ddb 0.0.0-ee-vpcs.549378cf03

package/plugins/CmsEntryFieldFilterPlugin.js

@@ -0,0 +1,31 @@
+"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,yBAAN,SAAwCC,eAAxC,CAA+C;EAQ3CC,WAAW,CAACC,MAAD,EAA0C;IACxD;IADwD;IAAA;IAExD,KAAKA,MAAL,GAAcA,MAAd;IACA,KAAKC,SAAL,GAAiB,KAAKD,MAAL,CAAYC,SAA7B;EACH;;EAEMC,MAAM,CAACC,MAAD,EAAgD;IACzD,OAAO,KAAKH,MAAL,CAAYE,MAAZ,CAAmBC,MAAnB,CAAP;EACH;;AAhBiD;;;8BAAzCN,yB,UACsC,iC;8BADtCA,yB,SAE4B,G"}

package/plugins/index.d.ts

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

package/plugins/index.js

@@ -0,0 +1,18 @@
+"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];
+    }
+  });
+});

package/plugins/index.js.map

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

package/types.d.ts

@@ -0,0 +1,53 @@
+import { Plugin } from "@webiny/plugins/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";
+import { Entity, Table } from "dynamodb-toolbox";
+interface CmsFieldFilterValueTransformParams {
+    /**
+     * A field which value we are transforming.
+     */
+    field: Partial<CmsModelField> & Pick<CmsModelField, "id" | "storageId" | "fieldId" | "settings">;
+    value: any;
+}
+export interface CmsFieldFilterValueTransformPlugin extends Plugin {
+    /**
+     * A plugin type.
+     */
+    type: "cms-field-filter-value-transform";
+    /**
+     * A field type this plugin is for.
+     */
+    fieldType: string;
+    /**
+     * Transform method which expect field definition and value to transform.
+     */
+    transform: (params: CmsFieldFilterValueTransformParams) => any;
+}
+export declare type AttributeDefinition = DynamoDBTypes | EntityAttributeConfig | EntityCompositeAttributes;
+export declare type Attributes = Record<string, AttributeDefinition>;
+export declare enum ENTITIES {
+    SYSTEM = "CmsSystem",
+    SETTINGS = "CmsSettings",
+    GROUPS = "CmsGroups",
+    MODELS = "CmsModels",
+    ENTRIES = "CmsEntries"
+}
+export interface TableModifier {
+    (table: TableConstructor): TableConstructor;
+}
+export interface StorageOperationsFactoryParams {
+    documentClient: DocumentClient;
+    table?: TableModifier;
+    attributes?: Record<ENTITIES, Attributes>;
+    plugins?: Plugin[] | Plugin[][];
+}
+export interface HeadlessCmsStorageOperations extends BaseHeadlessCmsStorageOperations {
+    getTable: () => Table;
+    getEntities: () => Record<"system" | "settings" | "groups" | "models" | "entries", Entity<any>>;
+}
+export interface StorageOperationsFactory {
+    (params: StorageOperationsFactoryParams): HeadlessCmsStorageOperations;
+}
+export {};

package/types.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ENTITIES = void 0;
+let ENTITIES;
+exports.ENTITIES = ENTITIES;
+
+(function (ENTITIES) {
+  ENTITIES["SYSTEM"] = "CmsSystem";
+  ENTITIES["SETTINGS"] = "CmsSettings";
+  ENTITIES["GROUPS"] = "CmsGroups";
+  ENTITIES["MODELS"] = "CmsModels";
+  ENTITIES["ENTRIES"] = "CmsEntries";
+})(ENTITIES || (exports.ENTITIES = ENTITIES = {}));

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,Q;;;WAAAA,Q;EAAAA,Q;EAAAA,Q;EAAAA,Q;EAAAA,Q;EAAAA,Q;GAAAA,Q,wBAAAA,Q"}