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

package/plugins/FormElasticsearchSortModifierPlugin.d.ts

@@ -0,0 +1,4 @@
+import { ElasticsearchSortModifierPlugin } from "@webiny/api-elasticsearch/plugins/definition/ElasticsearchSortModifierPlugin";
+export declare class FormElasticsearchSortModifierPlugin extends ElasticsearchSortModifierPlugin {
+    static readonly type: string;
+}

package/plugins/FormElasticsearchSortModifierPlugin.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FormElasticsearchSortModifierPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _ElasticsearchSortModifierPlugin = require("@webiny/api-elasticsearch/plugins/definition/ElasticsearchSortModifierPlugin");
+
+class FormElasticsearchSortModifierPlugin extends _ElasticsearchSortModifierPlugin.ElasticsearchSortModifierPlugin {}
+
+exports.FormElasticsearchSortModifierPlugin = FormElasticsearchSortModifierPlugin;
+(0, _defineProperty2.default)(FormElasticsearchSortModifierPlugin, "type", "formBuilder.elasticsearch.modifier.sort.form");

package/plugins/SubmissionElasticsearchBodyModifierPlugin.d.ts

@@ -0,0 +1,4 @@
+import { ElasticsearchBodyModifierPlugin } from "@webiny/api-elasticsearch/plugins/definition/ElasticsearchBodyModifierPlugin";
+export declare class SubmissionElasticsearchBodyModifierPlugin extends ElasticsearchBodyModifierPlugin {
+    static readonly type: string;
+}

package/plugins/SubmissionElasticsearchBodyModifierPlugin.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SubmissionElasticsearchBodyModifierPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _ElasticsearchBodyModifierPlugin = require("@webiny/api-elasticsearch/plugins/definition/ElasticsearchBodyModifierPlugin");
+
+class SubmissionElasticsearchBodyModifierPlugin extends _ElasticsearchBodyModifierPlugin.ElasticsearchBodyModifierPlugin {}
+
+exports.SubmissionElasticsearchBodyModifierPlugin = SubmissionElasticsearchBodyModifierPlugin;
+(0, _defineProperty2.default)(SubmissionElasticsearchBodyModifierPlugin, "type", "formBuilder.elasticsearch.modifier.body.submission");

package/plugins/SubmissionElasticsearchFieldPlugin.d.ts

@@ -0,0 +1,4 @@
+import { ElasticsearchFieldPlugin } from "@webiny/api-elasticsearch/plugins/definition/ElasticsearchFieldPlugin";
+export declare class SubmissionElasticsearchFieldPlugin extends ElasticsearchFieldPlugin {
+    static readonly type: string;
+}

package/plugins/SubmissionElasticsearchFieldPlugin.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SubmissionElasticsearchFieldPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _ElasticsearchFieldPlugin = require("@webiny/api-elasticsearch/plugins/definition/ElasticsearchFieldPlugin");
+
+class SubmissionElasticsearchFieldPlugin extends _ElasticsearchFieldPlugin.ElasticsearchFieldPlugin {}
+
+exports.SubmissionElasticsearchFieldPlugin = SubmissionElasticsearchFieldPlugin;
+(0, _defineProperty2.default)(SubmissionElasticsearchFieldPlugin, "type", "formBuilder.elasticsearch.fieldDefinition.submission");

package/plugins/SubmissionElasticsearchQueryModifierPlugin.d.ts

@@ -0,0 +1,4 @@
+import { ElasticsearchQueryModifierPlugin } from "@webiny/api-elasticsearch/plugins/definition/ElasticsearchQueryModifierPlugin";
+export declare class SubmissionElasticsearchQueryModifierPlugin extends ElasticsearchQueryModifierPlugin {
+    static readonly type: string;
+}

package/plugins/SubmissionElasticsearchQueryModifierPlugin.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SubmissionElasticsearchQueryModifierPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _ElasticsearchQueryModifierPlugin = require("@webiny/api-elasticsearch/plugins/definition/ElasticsearchQueryModifierPlugin");
+
+class SubmissionElasticsearchQueryModifierPlugin extends _ElasticsearchQueryModifierPlugin.ElasticsearchQueryModifierPlugin {}
+
+exports.SubmissionElasticsearchQueryModifierPlugin = SubmissionElasticsearchQueryModifierPlugin;
+(0, _defineProperty2.default)(SubmissionElasticsearchQueryModifierPlugin, "type", "formBuilder.elasticsearch.modifier.query.submission");

package/plugins/SubmissionElasticsearchSortModifierPlugin.d.ts

@@ -0,0 +1,4 @@
+import { ElasticsearchSortModifierPlugin } from "@webiny/api-elasticsearch/plugins/definition/ElasticsearchSortModifierPlugin";
+export declare class SubmissionElasticsearchSortModifierPlugin extends ElasticsearchSortModifierPlugin {
+    static readonly type: string;
+}

package/plugins/SubmissionElasticsearchSortModifierPlugin.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SubmissionElasticsearchSortModifierPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _ElasticsearchSortModifierPlugin = require("@webiny/api-elasticsearch/plugins/definition/ElasticsearchSortModifierPlugin");
+
+class SubmissionElasticsearchSortModifierPlugin extends _ElasticsearchSortModifierPlugin.ElasticsearchSortModifierPlugin {}
+
+exports.SubmissionElasticsearchSortModifierPlugin = SubmissionElasticsearchSortModifierPlugin;
+(0, _defineProperty2.default)(SubmissionElasticsearchSortModifierPlugin, "type", "formBuilder.elasticsearch.modifier.sort.submission");

package/types.d.ts

@@ -0,0 +1,66 @@
+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 { Client } from "@elastic/elasticsearch";
+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",
+    ES_FORM = "FormBuilderFormEs",
+    SUBMISSION = "FormBuilderSubmission",
+    ES_SUBMISSION = "FormBuilderSubmissionEs",
+    SYSTEM = "FormBuilderSystem",
+    SETTINGS = "FormBuilderSettings"
+}
+export interface FormBuilderStorageOperationsFactoryParams {
+    documentClient: DocumentClient;
+    elasticsearch: Client;
+    table?: string;
+    esTable?: 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 FormBuilderFormCreateKeyParams {
+    id: string;
+    tenant: string;
+    locale: string;
+}
+export interface FormBuilderFormStorageOperations extends BaseFormBuilderFormStorageOperations {
+    createFormPartitionKey: (params: FormBuilderFormCreateKeyParams) => 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" | "esForm" | "submission" | "esSubmission" | "system" | "settings";
+export interface FormBuilderStorageOperations extends BaseFormBuilderStorageOperations, FormBuilderSettingsStorageOperations, FormBuilderSubmissionStorageOperations, FormBuilderFormStorageOperations, FormBuilderSystemStorageOperations {
+    getTable(): Table;
+    getEsTable(): Table;
+    getEntities(): Record<Entities, Entity<any>>;
+}
+export interface FormBuilderStorageOperationsFactory {
+    (params: FormBuilderStorageOperationsFactoryParams): FormBuilderStorageOperations;
+}

package/types.js

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

package/upgrades/5.16.0/index.d.ts

@@ -0,0 +1,8 @@
+import { UpgradePlugin } from "@webiny/api-upgrade/types";
+import { FormBuilderContext } from "@webiny/api-form-builder/types";
+declare const _default: () => UpgradePlugin<FormBuilderContext>;
+/**
+ * This upgrade adds:
+ * - formId (first part of the id) and webinyVersion to the form records
+ */
+export default _default;

package/upgrades/5.16.0/index.js

@@ -0,0 +1,141 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _query = require("@webiny/db-dynamodb/utils/query");
+
+var _utils = require("@webiny/utils");
+
+var _batchWrite = require("@webiny/db-dynamodb/utils/batchWrite");
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+const upgradeForms = async params => {
+  const {
+    storageOperations,
+    tenant,
+    locale,
+    webinyVersion
+  } = params;
+  /**
+   * We need all of the forms from the database.
+   * We are getting them from the Elasticsearch because there is no general PK for the forms.
+   */
+
+  let forms = [];
+
+  try {
+    const {
+      items
+    } = await storageOperations.listForms({
+      where: {
+        latest: true,
+        tenant: tenant.id,
+        locale: locale.code
+      },
+      after: null,
+      limit: 10000,
+      sort: ["createdOn_DESC"]
+    });
+    forms = items;
+  } catch (ex) {
+    console.log(ex.message);
+    return;
+  }
+
+  if (forms.length === 0) {
+    return;
+  }
+
+  const entity = storageOperations.getEntities().form;
+  const items = [];
+  /**
+   * ## Regular DynamoDB table.
+   * We need to get all the records from all of the forms.
+   * Unfortunately, we need to query in a loop to be able to get those forms.
+   */
+
+  for (const form of forms) {
+    const {
+      id: formId
+    } = (0, _utils.parseIdentifier)(form.id);
+    const formRecords = await (0, _query.queryAll)({
+      entity,
+      partitionKey: storageOperations.createFormPartitionKey({
+        id: form.id,
+        tenant: tenant.id,
+        locale: locale.code
+      })
+    });
+
+    for (const record of formRecords) {
+      /**
+       * Checks for "just in case".
+       */
+      if (!record || !record.PK || !record.SK) {
+        continue;
+      }
+
+      items.push(entity.putBatch(_objectSpread(_objectSpread({}, record), {}, {
+        formId,
+        webinyVersion
+      })));
+    }
+  }
+  /**
+   * And finally write all the records to the database again.
+   */
+
+
+  try {
+    await (0, _batchWrite.batchWriteAll)({
+      table: entity.table,
+      items
+    });
+  } catch (ex) {
+    throw new _error.default("Could not update all form records.", "UPGRADE_FORM_RECORDS_ERROR", {
+      error: ex
+    });
+  }
+  /**
+   * ## Elasticsearch DynamoDB table.
+   */
+
+};
+/**
+ * This upgrade adds:
+ * - formId (first part of the id) and webinyVersion to the form records
+ */
+
+
+var _default = () => {
+  return {
+    type: "api-upgrade",
+    app: "form-builder",
+    version: "5.16.0",
+    apply: async context => {
+      const tenant = context.tenancy.getCurrentTenant();
+      const locale = context.i18nContent.getLocale();
+      const storageOperations = context.formBuilder.storageOperations;
+      await upgradeForms({
+        storageOperations,
+        tenant,
+        locale,
+        webinyVersion: context.WEBINY_VERSION
+      });
+    }
+  };
+};
+
+exports.default = _default;