@webiny/api-headless-cms-ddb 0.0.0-mt-1

package/types.d.ts

@@ -0,0 +1,84 @@
+import { Plugin } from "@webiny/plugins/types";
+import { CmsModelField, CmsModelFieldToGraphQLPlugin, 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: CmsModelField;
+    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;
+}
+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 {
+    SYSTEM = "CmsSystem",
+    SETTINGS = "CmsSettings",
+    GROUPS = "CmsGroups",
+    MODELS = "CmsModels",
+    ENTRIES = "CmsEntries"
+}
+export interface TableModifier {
+    (table: TableConstructor): TableConstructor;
+}
+export interface StorageOperationsFactoryParams {
+    documentClient: DocumentClient;
+    table?: TableModifier;
+    modelFieldToGraphQLPlugins: CmsModelFieldToGraphQLPlugin[];
+    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 = {}));