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

package/operations/settings/index.d.ts

@@ -0,0 +1,7 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { FormBuilderSettingsStorageOperations } from "../../types";
+export interface Params {
+    entity: Entity<any>;
+    table: Table;
+}
+export declare const createSettingsStorageOperations: (params: Params) => FormBuilderSettingsStorageOperations;

package/operations/settings/index.js

@@ -0,0 +1,122 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSettingsStorageOperations = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _cleanup = require("@webiny/db-dynamodb/utils/cleanup");
+
+var _get = require("@webiny/db-dynamodb/utils/get");
+
+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 createSettingsStorageOperations = params => {
+  const {
+    entity
+  } = params;
+
+  const createSettingsPartitionKey = ({
+    tenant,
+    locale
+  }) => {
+    return `T#${tenant}#L#${locale}#FB#SETTINGS`;
+  };
+
+  const createSettingsSortKey = () => {
+    return "default";
+  };
+
+  const createKeys = params => {
+    return {
+      PK: createSettingsPartitionKey(params),
+      SK: createSettingsSortKey()
+    };
+  };
+
+  const createSettings = async params => {
+    const {
+      settings
+    } = params;
+    const keys = createKeys(settings);
+
+    try {
+      await entity.put(_objectSpread(_objectSpread({}, settings), keys));
+      return settings;
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not create the settings record by given keys.", ex.code || "CREATE_SETTINGS_ERROR", {
+        keys,
+        settings
+      });
+    }
+  };
+
+  const getSettings = async params => {
+    const keys = createKeys(params);
+
+    try {
+      const item = await (0, _get.get)({
+        entity,
+        keys
+      });
+      return (0, _cleanup.cleanupItem)(entity, item);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not get the settings record by given keys.", ex.code || "LOAD_SETTINGS_ERROR", {
+        keys
+      });
+    }
+  };
+
+  const updateSettings = async params => {
+    const {
+      settings,
+      original
+    } = params;
+    const keys = createKeys(settings);
+
+    try {
+      await entity.put(_objectSpread(_objectSpread({}, settings), keys));
+      return settings;
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not update the settings record by given keys.", ex.code || "UPDATE_SETTINGS_ERROR", {
+        keys,
+        original,
+        settings
+      });
+    }
+  };
+
+  const deleteSettings = async params => {
+    const {
+      settings
+    } = params;
+    const keys = createKeys(settings);
+
+    try {
+      await entity.delete();
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not delete the settings record by given keys.", ex.code || "DELETE_SETTINGS_ERROR", {
+        keys
+      });
+    }
+  };
+
+  return {
+    createSettings,
+    getSettings,
+    updateSettings,
+    deleteSettings,
+    createSettingsPartitionKey,
+    createSettingsSortKey
+  };
+};
+
+exports.createSettingsStorageOperations = createSettingsStorageOperations;

package/operations/submission/fields.d.ts

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

package/operations/submission/fields.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _FormSubmissionDynamoDbFieldPlugin = require("../../plugins/FormSubmissionDynamoDbFieldPlugin");
+
+var _default = () => [new _FormSubmissionDynamoDbFieldPlugin.FormSubmissionDynamoDbFieldPlugin({
+  field: "createdOn",
+  type: "date"
+}), new _FormSubmissionDynamoDbFieldPlugin.FormSubmissionDynamoDbFieldPlugin({
+  field: "savedOn",
+  type: "date"
+})];
+
+exports.default = _default;

package/operations/submission/index.d.ts

@@ -0,0 +1,9 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { PluginsContainer } from "@webiny/plugins";
+import { FormBuilderSubmissionStorageOperations } from "../../types";
+export interface Params {
+    entity: Entity<any>;
+    table: Table;
+    plugins: PluginsContainer;
+}
+export declare const createSubmissionStorageOperations: (params: Params) => FormBuilderSubmissionStorageOperations;

package/operations/submission/index.js

@@ -0,0 +1,247 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSubmissionStorageOperations = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _cleanup = require("@webiny/db-dynamodb/utils/cleanup");
+
+var _utils = require("@webiny/utils");
+
+var _query = require("@webiny/db-dynamodb/utils/query");
+
+var _cursor = require("@webiny/db-dynamodb/utils/cursor");
+
+var _sort = require("@webiny/db-dynamodb/utils/sort");
+
+var _filter = require("@webiny/db-dynamodb/utils/filter");
+
+var _FormSubmissionDynamoDbFieldPlugin = require("../../plugins/FormSubmissionDynamoDbFieldPlugin");
+
+var _get = require("@webiny/db-dynamodb/utils/get");
+
+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 createSubmissionStorageOperations = params => {
+  const {
+    entity,
+    plugins
+  } = params;
+
+  const createSubmissionPartitionKey = params => {
+    const {
+      tenant,
+      locale,
+      formId
+    } = params;
+    const {
+      id
+    } = (0, _utils.parseIdentifier)(formId);
+    return `T#${tenant}#L#${locale}#FB#FS#${id}`;
+  };
+
+  const createSubmissionSortKey = id => {
+    return id;
+  };
+
+  const createSubmissionType = () => {
+    return "fb.formSubmission";
+  };
+
+  const createSubmission = async params => {
+    const {
+      submission,
+      form
+    } = params;
+    const keys = {
+      PK: createSubmissionPartitionKey(form),
+      SK: createSubmissionSortKey(submission.id)
+    };
+
+    try {
+      await entity.put(_objectSpread(_objectSpread(_objectSpread({}, submission), keys), {}, {
+        TYPE: createSubmissionType()
+      }));
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not create form submission in the DynamoDB.", ex.code || "UPDATE_FORM_SUBMISSION_ERROR", {
+        submission,
+        form,
+        keys
+      });
+    }
+
+    return submission;
+  };
+
+  const updateSubmission = async params => {
+    const {
+      submission,
+      form,
+      original
+    } = params;
+    const keys = {
+      PK: createSubmissionPartitionKey(form),
+      SK: createSubmissionSortKey(submission.id)
+    };
+
+    try {
+      await entity.put(_objectSpread(_objectSpread(_objectSpread({}, submission), keys), {}, {
+        TYPE: createSubmissionType()
+      }));
+      return submission;
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not update form submission in the DynamoDB.", ex.code || "UPDATE_FORM_SUBMISSION_ERROR", {
+        submission,
+        original,
+        form,
+        keys
+      });
+    }
+  };
+
+  const deleteSubmission = async params => {
+    const {
+      submission,
+      form
+    } = params;
+    const keys = {
+      PK: createSubmissionPartitionKey(form),
+      SK: createSubmissionSortKey(submission.id)
+    };
+
+    try {
+      await entity.delete(keys);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not delete form submission from DynamoDB.", ex.code || "DELETE_FORM_SUBMISSION_ERROR", {
+        submission,
+        form,
+        keys
+      });
+    }
+
+    return submission;
+  };
+
+  const listSubmissions = async params => {
+    const {
+      where: initialWhere,
+      sort,
+      limit = 100000,
+      after
+    } = params;
+
+    const where = _objectSpread({}, initialWhere);
+
+    const {
+      tenant,
+      locale,
+      formId
+    } = where;
+    /**
+     * We need to remove conditions so we do not filter by them again.
+     */
+
+    delete where.tenant;
+    delete where.locale;
+    delete where.formId;
+    const queryAllParams = {
+      entity,
+      partitionKey: createSubmissionPartitionKey({
+        tenant,
+        locale,
+        formId
+      }),
+      options: {
+        gte: " ",
+        reverse: true
+      }
+    };
+    let results;
+
+    try {
+      results = await (0, _query.queryAll)(queryAllParams);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could list form submissions.", ex.code || "LIST_SUBMISSIONS_ERROR", {
+        where: initialWhere,
+        partitionKey: queryAllParams.partitionKey
+      });
+    }
+
+    const fields = plugins.byType(_FormSubmissionDynamoDbFieldPlugin.FormSubmissionDynamoDbFieldPlugin.type);
+    const filteredSubmissions = (0, _filter.filterItems)({
+      plugins,
+      items: results,
+      where,
+      fields
+    });
+    const sortedSubmissions = (0, _sort.sortItems)({
+      items: filteredSubmissions,
+      sort,
+      fields
+    });
+    const totalCount = sortedSubmissions.length;
+    const start = (0, _cursor.decodeCursor)(after) || 0;
+    const hasMoreItems = totalCount > start + limit;
+    const end = limit > totalCount + start + limit ? undefined : start + limit;
+    const items = sortedSubmissions.slice(start, end);
+    /**
+     * Although we do not need a cursor here, we will use it as such to keep it standardized.
+     * Number is simply encoded.
+     */
+
+    const cursor = items.length > 0 ? (0, _cursor.encodeCursor)(start + limit) : null;
+    const meta = {
+      hasMoreItems,
+      totalCount,
+      cursor
+    };
+    return {
+      items,
+      meta
+    };
+  };
+
+  const getSubmission = async params => {
+    const {
+      where
+    } = params;
+    const keys = {
+      PK: createSubmissionPartitionKey(where),
+      SK: createSubmissionSortKey(where.id)
+    };
+
+    try {
+      const item = await (0, _get.get)({
+        entity,
+        keys
+      });
+      return (0, _cleanup.cleanupItem)(entity, item);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not oad submission.", ex.code || "GET_SUBMISSION_ERROR", {
+        where,
+        keys
+      });
+    }
+  };
+
+  return {
+    createSubmission,
+    deleteSubmission,
+    updateSubmission,
+    listSubmissions,
+    getSubmission,
+    createSubmissionPartitionKey,
+    createSubmissionSortKey
+  };
+};
+
+exports.createSubmissionStorageOperations = createSubmissionStorageOperations;

package/operations/system/index.d.ts

@@ -0,0 +1,7 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { FormBuilderSystemStorageOperations } from "../../types";
+export interface Params {
+    entity: Entity<any>;
+    table: Table;
+}
+export declare const createSystemStorageOperations: (params: Params) => FormBuilderSystemStorageOperations;

package/operations/system/index.js

@@ -0,0 +1,105 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSystemStorageOperations = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _cleanup = require("@webiny/db-dynamodb/utils/cleanup");
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _get = require("@webiny/db-dynamodb/utils/get");
+
+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 createSystemStorageOperations = params => {
+  const {
+    entity
+  } = params;
+
+  const createSystemPartitionKey = ({
+    tenant
+  }) => {
+    return `T#${tenant}#SYSTEM`;
+  };
+
+  const createSystemSortKey = () => {
+    return "FB";
+  };
+
+  const createKeys = params => {
+    return {
+      PK: createSystemPartitionKey(params),
+      SK: createSystemSortKey()
+    };
+  };
+
+  const createSystem = async params => {
+    const {
+      system
+    } = params;
+    const keys = createKeys(system);
+
+    try {
+      await entity.put(_objectSpread(_objectSpread({}, system), keys));
+      return system;
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not create the system record by given keys.", ex.code || "CREATE_SYSTEM_ERROR", {
+        keys,
+        system
+      });
+    }
+  };
+
+  const getSystem = async params => {
+    const keys = createKeys(params);
+
+    try {
+      const item = await (0, _get.get)({
+        entity,
+        keys
+      });
+      return (0, _cleanup.cleanupItem)(entity, item);
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not get the system record by given keys.", ex.code || "LOAD_SYSTEM_ERROR", {
+        keys
+      });
+    }
+  };
+
+  const updateSystem = async params => {
+    const {
+      system,
+      original
+    } = params;
+    const keys = createKeys(system);
+
+    try {
+      await entity.put(_objectSpread(_objectSpread({}, system), keys));
+      return system;
+    } catch (ex) {
+      throw new _error.default(ex.message || "Could not update the system record by given keys.", ex.code || "UPDATE_SYSTEM_ERROR", {
+        keys,
+        original,
+        system
+      });
+    }
+  };
+
+  return {
+    createSystem,
+    getSystem,
+    updateSystem,
+    createSystemPartitionKey,
+    createSystemSortKey
+  };
+};
+
+exports.createSystemStorageOperations = createSystemStorageOperations;

package/package.json

@@ -0,0 +1,56 @@
+{
+	"name": "@webiny/api-form-builder-so-ddb",
+	"version": "0.0.0-mt-1",
+	"main": "index.js",
+	"keywords": [
+		"@webiny/api-form-builder",
+		"storage-operations",
+		"dynamodb",
+		"fb:ddb"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/api-form-builder-so-ddb"
+	},
+	"contributors": [
+		"Pavel Denisjuk <pavel@webiny.com>",
+		"Sven Al Hamad <sven@webiny.com>",
+		"Adrian Smijulj <adrian@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.15.4",
+		"@webiny/api-form-builder": "0.0.0-mt-1",
+		"@webiny/db-dynamodb": "0.0.0-mt-1",
+		"@webiny/error": "0.0.0-mt-1",
+		"@webiny/plugins": "0.0.0-mt-1",
+		"@webiny/utils": "0.0.0-mt-1",
+		"dynamodb-toolbox": "0.3.4"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.5.5",
+		"@babel/core": "^7.5.5",
+		"@babel/preset-env": "^7.5.5",
+		"@babel/preset-typescript": "^7.8.3",
+		"@webiny/cli": "^0.0.0-mt-1",
+		"@webiny/handler-db": "^0.0.0-mt-1",
+		"@webiny/project-utils": "^0.0.0-mt-1",
+		"csvtojson": "^2.0.10",
+		"jest": "^26.6.3",
+		"jest-dynalite": "^3.2.0",
+		"jest-environment-node": "^27.2.4",
+		"rimraf": "^3.0.2",
+		"ttypescript": "^1.5.12",
+		"typescript": "^4.1.3"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "37736d8456a6ecb342a6c3645060bd9a3f2d4bb0"
+}

package/plugins/FormDynamoDbFieldPlugin.d.ts

@@ -0,0 +1,4 @@
+import { FieldPlugin } from "@webiny/db-dynamodb/plugins/definitions/FieldPlugin";
+export declare class FormDynamoDbFieldPlugin extends FieldPlugin {
+    static readonly type: string;
+}

package/plugins/FormDynamoDbFieldPlugin.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FormDynamoDbFieldPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _FieldPlugin = require("@webiny/db-dynamodb/plugins/definitions/FieldPlugin");
+
+class FormDynamoDbFieldPlugin extends _FieldPlugin.FieldPlugin {}
+
+exports.FormDynamoDbFieldPlugin = FormDynamoDbFieldPlugin;
+(0, _defineProperty2.default)(FormDynamoDbFieldPlugin, "type", "formBuilder.dynamodb.field.form");

package/plugins/FormSubmissionDynamoDbFieldPlugin.d.ts

@@ -0,0 +1,4 @@
+import { FieldPlugin } from "@webiny/db-dynamodb/plugins/definitions/FieldPlugin";
+export declare class FormSubmissionDynamoDbFieldPlugin extends FieldPlugin {
+    static readonly type: string;
+}

package/plugins/FormSubmissionDynamoDbFieldPlugin.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FormSubmissionDynamoDbFieldPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _FieldPlugin = require("@webiny/db-dynamodb/plugins/definitions/FieldPlugin");
+
+class FormSubmissionDynamoDbFieldPlugin extends _FieldPlugin.FieldPlugin {}
+
+exports.FormSubmissionDynamoDbFieldPlugin = FormSubmissionDynamoDbFieldPlugin;
+(0, _defineProperty2.default)(FormSubmissionDynamoDbFieldPlugin, "type", "formBuilder.dynamodb.field.formSubmission");