@webiny/api-form-builder-so-ddb 0.0.0-mt-1

package/types.d.ts

@@ -0,0 +1,65 @@
+import { FormBuilderStorageOperations as BaseFormBuilderStorageOperations, FormBuilderSystemStorageOperations as BaseFormBuilderSystemStorageOperations, FormBuilderSubmissionStorageOperations as BaseFormBuilderSubmissionStorageOperations, FormBuilderSettingsStorageOperations as BaseFormBuilderSettingsStorageOperations, FormBuilderFormStorageOperations as BaseFormBuilderFormStorageOperations } from "@webiny/api-form-builder/types";
+import { DocumentClient } from "aws-sdk/clients/dynamodb";
+import { Table, Entity } from "dynamodb-toolbox";
+import { DynamoDBTypes } from "dynamodb-toolbox/dist/classes/Table";
+import { EntityAttributeConfig, EntityCompositeAttributes } from "dynamodb-toolbox/dist/classes/Entity";
+import { Plugin } from "@webiny/plugins";
+export declare type AttributeDefinition = DynamoDBTypes | EntityAttributeConfig | EntityCompositeAttributes;
+export declare type Attributes = Record<string, AttributeDefinition>;
+export declare enum ENTITIES {
+    FORM = "FormBuilderForm",
+    SUBMISSION = "FormBuilderSubmission",
+    SYSTEM = "FormBuilderSystem",
+    SETTINGS = "FormBuilderSettings"
+}
+export interface FormBuilderStorageOperationsFactoryParams {
+    documentClient: DocumentClient;
+    table?: string;
+    attributes?: Record<ENTITIES, Attributes>;
+    plugins?: Plugin;
+}
+export interface FormBuilderSystemCreateKeysParams {
+    tenant: string;
+}
+export interface FormBuilderSystemStorageOperations extends BaseFormBuilderSystemStorageOperations {
+    createSystemPartitionKey: (params: FormBuilderSystemCreateKeysParams) => string;
+    createSystemSortKey: () => string;
+}
+export interface FormBuilderFormCreatePartitionKeyParams {
+    tenant: string;
+    locale: string;
+}
+export interface FormBuilderFormCreateGSIPartitionKeyParams {
+    id?: string;
+    formId?: string;
+    tenant: string;
+    locale: string;
+}
+export interface FormBuilderFormStorageOperations extends BaseFormBuilderFormStorageOperations {
+    createFormPartitionKey: (params: FormBuilderFormCreatePartitionKeyParams) => string;
+}
+export interface FormBuilderSubmissionStorageOperationsCreatePartitionKeyParams {
+    tenant: string;
+    locale: string;
+    formId: string;
+}
+export interface FormBuilderSubmissionStorageOperations extends BaseFormBuilderSubmissionStorageOperations {
+    createSubmissionPartitionKey: (params: FormBuilderSubmissionStorageOperationsCreatePartitionKeyParams) => string;
+    createSubmissionSortKey: (id: string) => string;
+}
+export interface FormBuilderSettingsStorageOperationsCreatePartitionKeyParams {
+    tenant: string;
+    locale: string;
+}
+export interface FormBuilderSettingsStorageOperations extends BaseFormBuilderSettingsStorageOperations {
+    createSettingsPartitionKey: (params: FormBuilderSettingsStorageOperationsCreatePartitionKeyParams) => string;
+    createSettingsSortKey: () => string;
+}
+export declare type Entities = "form" | "submission" | "system" | "settings";
+export interface FormBuilderStorageOperations extends BaseFormBuilderStorageOperations, FormBuilderSettingsStorageOperations, FormBuilderSubmissionStorageOperations, FormBuilderFormStorageOperations, FormBuilderSystemStorageOperations {
+    getTable(): Table;
+    getEntities(): Record<Entities, Entity<any>>;
+}
+export interface FormBuilderStorageOperationsFactory {
+    (params: FormBuilderStorageOperationsFactoryParams): FormBuilderStorageOperations;
+}

package/types.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ENTITIES = void 0;
+let ENTITIES;
+exports.ENTITIES = ENTITIES;
+
+(function (ENTITIES) {
+  ENTITIES["FORM"] = "FormBuilderForm";
+  ENTITIES["SUBMISSION"] = "FormBuilderSubmission";
+  ENTITIES["SYSTEM"] = "FormBuilderSystem";
+  ENTITIES["SETTINGS"] = "FormBuilderSettings";
+})(ENTITIES || (exports.ENTITIES = ENTITIES = {}));