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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+# @webiny/api-form-builder-so-ddb-es
+[![](https://img.shields.io/npm/dw/@webiny/api-form-builder-so-ddb-es.svg)](https://www.npmjs.com/package/@webiny/api-form-builder-so-ddb-es) 
+[![](https://img.shields.io/npm/v/@webiny/api-form-builder-so-ddb-es.svg)](https://www.npmjs.com/package/@webiny/api-form-builder-so-ddb-es)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+The DynamoDB + Elasticsearch Storage Operations for the [Webiny Forms (@webiny/api-form-builder)](../api-form-builder) API. 
+  
+## Install
+```
+yarn add @webiny/api-form-builder-so-ddb-es
+```

package/configurations.d.ts

@@ -0,0 +1,9 @@
+export interface ElasticsearchConfigParams {
+    tenant: string;
+}
+declare const _default: {
+    es(params: ElasticsearchConfigParams): {
+        index: string;
+    };
+};
+export default _default;

package/configurations.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  es(params) {
+    const {
+      tenant
+    } = params;
+    const sharedIndex = process.env.ELASTICSEARCH_SHARED_INDEXES === "true";
+    const index = `${sharedIndex ? "root" : tenant}-form-builder`;
+    const prefix = process.env.ELASTIC_SEARCH_INDEX_PREFIX;
+
+    if (prefix) {
+      return {
+        index: prefix + index
+      };
+    }
+
+    return {
+      index
+    };
+  }
+
+};
+exports.default = _default;

package/definitions/elasticsearch.d.ts

@@ -0,0 +1,8 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { Attributes } from "../types";
+export interface Params {
+    table: Table;
+    entityName: string;
+    attributes: Attributes;
+}
+export declare const createElasticsearchEntity: (params: Params) => Entity<{}>;

package/definitions/elasticsearch.js

@@ -0,0 +1,47 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createElasticsearchEntity = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _dynamodbToolbox = require("dynamodb-toolbox");
+
+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 createElasticsearchEntity = params => {
+  const {
+    table,
+    entityName,
+    attributes
+  } = params;
+  return new _dynamodbToolbox.Entity({
+    name: entityName,
+    table,
+    attributes: _objectSpread({
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      index: {
+        type: "string"
+      },
+      data: {
+        type: "map"
+      },
+      TYPE: {
+        type: "string"
+      }
+    }, attributes || {})
+  });
+};
+
+exports.createElasticsearchEntity = createElasticsearchEntity;

package/definitions/form.d.ts

@@ -0,0 +1,8 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { Attributes } from "../types";
+export interface Params {
+    table: Table;
+    entityName: string;
+    attributes: Attributes;
+}
+export declare const createFormEntity: (params: Params) => Entity<any>;

package/definitions/form.js

@@ -0,0 +1,104 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createFormEntity = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _dynamodbToolbox = require("dynamodb-toolbox");
+
+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 createFormEntity = params => {
+  const {
+    table,
+    entityName,
+    attributes
+  } = params;
+  return new _dynamodbToolbox.Entity({
+    table,
+    name: entityName,
+    attributes: _objectSpread({
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      TYPE: {
+        type: "string"
+      },
+      id: {
+        type: "string"
+      },
+      formId: {
+        type: "string"
+      },
+      tenant: {
+        type: "string"
+      },
+      locale: {
+        type: "string"
+      },
+      createdBy: {
+        type: "map"
+      },
+      ownedBy: {
+        type: "map"
+      },
+      savedOn: {
+        type: "string"
+      },
+      createdOn: {
+        type: "string"
+      },
+      name: {
+        type: "string"
+      },
+      slug: {
+        type: "string"
+      },
+      version: {
+        type: "number"
+      },
+      locked: {
+        type: "boolean"
+      },
+      published: {
+        type: "boolean"
+      },
+      publishedOn: {
+        type: "string"
+      },
+      status: {
+        type: "string"
+      },
+      fields: {
+        type: "list"
+      },
+      layout: {
+        type: "list"
+      },
+      stats: {
+        type: "map"
+      },
+      settings: {
+        type: "map"
+      },
+      triggers: {
+        type: "map"
+      },
+      webinyVersion: {
+        type: "string"
+      }
+    }, attributes || {})
+  });
+};
+
+exports.createFormEntity = createFormEntity;

package/definitions/settings.d.ts

@@ -0,0 +1,8 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { Attributes } from "../types";
+export interface Params {
+    table: Table;
+    entityName: string;
+    attributes: Attributes;
+}
+export declare const createSettingsEntity: (params: Params) => Entity<any>;

package/definitions/settings.js

@@ -0,0 +1,53 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSettingsEntity = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _dynamodbToolbox = require("dynamodb-toolbox");
+
+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 createSettingsEntity = params => {
+  const {
+    entityName,
+    attributes,
+    table
+  } = params;
+  return new _dynamodbToolbox.Entity({
+    name: entityName,
+    table,
+    attributes: _objectSpread({
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      TYPE: {
+        type: "string"
+      },
+      reCaptcha: {
+        type: "map"
+      },
+      domain: {
+        type: "string"
+      },
+      tenant: {
+        type: "string"
+      },
+      locale: {
+        type: "string"
+      }
+    }, attributes || {})
+  });
+};
+
+exports.createSettingsEntity = createSettingsEntity;

package/definitions/submission.d.ts

@@ -0,0 +1,8 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { Attributes } from "../types";
+export interface Params {
+    table: Table;
+    entityName: string;
+    attributes: Attributes;
+}
+export declare const createSubmissionEntity: (params: Params) => Entity<any>;

package/definitions/submission.js

@@ -0,0 +1,74 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSubmissionEntity = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _dynamodbToolbox = require("dynamodb-toolbox");
+
+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 createSubmissionEntity = params => {
+  const {
+    table,
+    entityName,
+    attributes
+  } = params;
+  return new _dynamodbToolbox.Entity({
+    table,
+    name: entityName,
+    attributes: _objectSpread({
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      id: {
+        type: "string"
+      },
+      TYPE: {
+        type: "string"
+      },
+      data: {
+        type: "map"
+      },
+      meta: {
+        type: "map"
+      },
+      form: {
+        type: "map"
+      },
+      logs: {
+        type: "list"
+      },
+      createdOn: {
+        type: "string"
+      },
+      savedOn: {
+        type: "string"
+      },
+      ownedBy: {
+        type: "map"
+      },
+      tenant: {
+        type: "string"
+      },
+      locale: {
+        type: "string"
+      },
+      webinyVersion: {
+        type: "string"
+      }
+    }, attributes || {})
+  });
+};
+
+exports.createSubmissionEntity = createSubmissionEntity;

package/definitions/system.d.ts

@@ -0,0 +1,8 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { Attributes } from "../types";
+export interface Params {
+    table: Table;
+    entityName: string;
+    attributes: Attributes;
+}
+export declare const createSystemEntity: (params: Params) => Entity<any>;

package/definitions/system.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSystemEntity = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _dynamodbToolbox = require("dynamodb-toolbox");
+
+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 createSystemEntity = params => {
+  const {
+    entityName,
+    attributes,
+    table
+  } = params;
+  return new _dynamodbToolbox.Entity({
+    name: entityName,
+    table,
+    attributes: _objectSpread({
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      version: {
+        type: "string"
+      },
+      tenant: {
+        type: "string"
+      }
+    }, attributes || {})
+  });
+};
+
+exports.createSystemEntity = createSystemEntity;

package/definitions/table.d.ts

@@ -0,0 +1,7 @@
+import { DocumentClient } from "aws-sdk/clients/dynamodb";
+import { Table } from "dynamodb-toolbox";
+export interface Params {
+    tableName: string;
+    documentClient: DocumentClient;
+}
+export declare const createTable: (params: Params) => Table;

package/definitions/table.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createTable = void 0;
+
+var _dynamodbToolbox = require("dynamodb-toolbox");
+
+const createTable = params => {
+  const {
+    tableName,
+    documentClient
+  } = params;
+  return new _dynamodbToolbox.Table({
+    name: tableName || process.env.DB_TABLE,
+    partitionKey: "PK",
+    sortKey: "SK",
+    DocumentClient: documentClient
+  });
+};
+
+exports.createTable = createTable;

package/definitions/tableElasticsearch.d.ts

@@ -0,0 +1,7 @@
+import { Table } from "dynamodb-toolbox";
+import { DocumentClient } from "aws-sdk/clients/dynamodb";
+export interface Params {
+    documentClient: DocumentClient;
+    tableName?: string;
+}
+export declare const createElasticsearchTable: (params: Params) => Table;

package/definitions/tableElasticsearch.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createElasticsearchTable = void 0;
+
+var _dynamodbToolbox = require("dynamodb-toolbox");
+
+const createElasticsearchTable = params => {
+  const {
+    tableName,
+    documentClient
+  } = params;
+  return new _dynamodbToolbox.Table({
+    name: tableName || process.env.DB_TABLE_ELASTICSEARCH,
+    partitionKey: "PK",
+    sortKey: "SK",
+    DocumentClient: documentClient
+  });
+};
+
+exports.createElasticsearchTable = createElasticsearchTable;

package/index.d.ts

@@ -0,0 +1,2 @@
+import { FormBuilderStorageOperationsFactory } from "./types";
+export declare const createFormBuilderStorageOperations: FormBuilderStorageOperationsFactory;