@webiny/api-file-manager-ddb 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,30 @@
+# @webiny/api-file-manager-ddb
+
+[![](https://img.shields.io/npm/dw/@webiny/api-file-manager-ddb.svg)](https://www.npmjs.com/package/@webiny/api-file-manager-ddb)
+[![](https://img.shields.io/npm/v/@webiny/api-file-manager-ddb.svg)](https://www.npmjs.com/package/@webiny/api-file-manager-ddb)
+[![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)
+
+## Install
+
+```
+npm install --save @webiny/api-file-manager-ddb
+```
+
+Or if you prefer yarn:
+
+```
+yarn add @webiny/api-file-manager-ddb
+```
+
+
+## Testing
+To run the tests only for this package you must filter it with keywords.
+
+### Env variables
+
+
+### Command
+````
+yarn test packages/api-file-manager --keyword=fm:ddb --keyword=fm:base
+````

package/definitions/filesEntity.d.ts

@@ -0,0 +1,7 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { FileManagerContext } from "@webiny/api-file-manager/types";
+declare const _default: (params: {
+    context: FileManagerContext;
+    table: Table;
+}) => Entity<any>;
+export default _default;

package/definitions/filesEntity.js

@@ -0,0 +1,80 @@
+"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 _dynamodbToolbox = require("dynamodb-toolbox");
+
+var _attributes = require("@webiny/db-dynamodb/utils/attributes");
+
+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; }
+
+var _default = params => {
+  const {
+    context,
+    table
+  } = params;
+  const entityName = "Files";
+  const attributes = (0, _attributes.getExtraAttributes)(context, entityName);
+  return new _dynamodbToolbox.Entity({
+    name: entityName,
+    table,
+    attributes: _objectSpread({
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      TYPE: {
+        type: "string"
+      },
+      id: {
+        type: "string"
+      },
+      key: {
+        type: "string"
+      },
+      size: {
+        type: "number"
+      },
+      type: {
+        type: "string"
+      },
+      name: {
+        type: "string"
+      },
+      meta: {
+        type: "map"
+      },
+      tags: {
+        type: "list"
+      },
+      createdOn: {
+        type: "string"
+      },
+      createdBy: {
+        type: "map"
+      },
+      tenant: {
+        type: "string"
+      },
+      locale: {
+        type: "string"
+      },
+      webinyVersion: {
+        type: "string"
+      }
+    }, attributes)
+  });
+};
+
+exports.default = _default;

package/definitions/settingsEntity.d.ts

@@ -0,0 +1,7 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { FileManagerContext } from "@webiny/api-file-manager/types";
+declare const _default: (params: {
+    context: FileManagerContext;
+    table: Table;
+}) => Entity<any>;
+export default _default;

package/definitions/settingsEntity.js

@@ -0,0 +1,56 @@
+"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 _dynamodbToolbox = require("dynamodb-toolbox");
+
+var _attributes = require("@webiny/db-dynamodb/utils/attributes");
+
+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; }
+
+var _default = params => {
+  const {
+    context,
+    table
+  } = params;
+  const entityName = "Settings";
+  const attributes = (0, _attributes.getExtraAttributes)(context, entityName);
+  return new _dynamodbToolbox.Entity({
+    name: entityName,
+    table,
+    attributes: _objectSpread({
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      TYPE: {
+        type: "string"
+      },
+      key: {
+        type: "string"
+      },
+      uploadMinFileSize: {
+        type: "number"
+      },
+      uploadMaxFileSize: {
+        type: "number"
+      },
+      srcPrefix: {
+        type: "string"
+      }
+    }, attributes)
+  });
+};
+
+exports.default = _default;

package/definitions/systemEntity.d.ts

@@ -0,0 +1,7 @@
+import { Entity, Table } from "dynamodb-toolbox";
+import { FileManagerContext } from "@webiny/api-file-manager/types";
+declare const _default: (params: {
+    context: FileManagerContext;
+    table: Table;
+}) => Entity<any>;
+export default _default;

package/definitions/systemEntity.js

@@ -0,0 +1,44 @@
+"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 _dynamodbToolbox = require("dynamodb-toolbox");
+
+var _attributes = require("@webiny/db-dynamodb/utils/attributes");
+
+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; }
+
+var _default = params => {
+  const {
+    context,
+    table
+  } = params;
+  const entityName = "System";
+  const attributes = (0, _attributes.getExtraAttributes)(context, entityName);
+  return new _dynamodbToolbox.Entity({
+    name: entityName,
+    table,
+    attributes: _objectSpread({
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      version: {
+        type: "string"
+      }
+    }, attributes)
+  });
+};
+
+exports.default = _default;

package/definitions/table.d.ts

@@ -0,0 +1,6 @@
+import { Table } from "dynamodb-toolbox";
+import { FileManagerContext } from "@webiny/api-file-manager/types";
+declare const _default: (params: {
+    context: FileManagerContext;
+}) => Table;
+export default _default;

package/definitions/table.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _dynamodbToolbox = require("dynamodb-toolbox");
+
+var _configurations = _interopRequireDefault(require("../operations/configurations"));
+
+var _utils = require("../operations/utils");
+
+var _default = params => {
+  const {
+    context
+  } = params;
+  return new _dynamodbToolbox.Table({
+    name: _configurations.default.db().table || (0, _utils.getTable)(context),
+    partitionKey: "PK",
+    sortKey: "SK",
+    DocumentClient: (0, _utils.getDocumentClient)(context)
+  });
+};
+
+exports.default = _default;

package/index.d.ts

@@ -0,0 +1,5 @@
+import { FilesStorageOperationsProviderDdb } from "./operations/files";
+import { SettingsStorageOperationsProviderDdbPlugin } from "./operations/settings";
+import { SystemStorageOperationsProviderDdbPlugin } from "./operations/system";
+declare const _default: () => (FilesStorageOperationsProviderDdb | SettingsStorageOperationsProviderDdbPlugin | SystemStorageOperationsProviderDdbPlugin)[];
+export default _default;

package/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _files = require("./operations/files");
+
+var _settings = require("./operations/settings");
+
+var _system = require("./operations/system");
+
+var _default = () => [new _files.FilesStorageOperationsProviderDdb(), new _settings.SettingsStorageOperationsProviderDdbPlugin(), new _system.SystemStorageOperationsProviderDdbPlugin()];
+
+exports.default = _default;

package/operations/configurations.d.ts

@@ -0,0 +1,14 @@
+declare const _default: {
+    db: () => {
+        table: string;
+        keys: {
+            primary: boolean;
+            unique: boolean;
+            name: string;
+            fields: {
+                name: string;
+            }[];
+        }[];
+    };
+};
+export default _default;

package/operations/configurations.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  db: () => ({
+    table: process.env.DB_TABLE_FILE_MANGER || process.env.DB_TABLE,
+    keys: [{
+      primary: true,
+      unique: true,
+      name: "primary",
+      fields: [{
+        name: "PK"
+      }, {
+        name: "SK"
+      }]
+    }]
+  })
+};
+exports.default = _default;

package/operations/files/FilesStorageOperations.d.ts

@@ -0,0 +1,22 @@
+import { File, FileManagerContext, FileManagerFilesStorageOperations, FileManagerFilesStorageOperationsCreateBatchParams, FileManagerFilesStorageOperationsCreateParams, FileManagerFilesStorageOperationsDeleteParams, FileManagerFilesStorageOperationsGetParams, FileManagerFilesStorageOperationsListParams, FileManagerFilesStorageOperationsListResponse, FileManagerFilesStorageOperationsTagsParams, FileManagerFilesStorageOperationsTagsResponse, FileManagerFilesStorageOperationsUpdateParams } from "@webiny/api-file-manager/types";
+interface ConstructorParams {
+    context: FileManagerContext;
+}
+export declare class FilesStorageOperations implements FileManagerFilesStorageOperations {
+    private readonly _context;
+    private readonly table;
+    private readonly entity;
+    private get context();
+    constructor({ context }: ConstructorParams);
+    get(params: FileManagerFilesStorageOperationsGetParams): Promise<File | null>;
+    create(params: FileManagerFilesStorageOperationsCreateParams): Promise<File>;
+    update(params: FileManagerFilesStorageOperationsUpdateParams): Promise<File>;
+    delete(params: FileManagerFilesStorageOperationsDeleteParams): Promise<void>;
+    createBatch(params: FileManagerFilesStorageOperationsCreateBatchParams): Promise<File[]>;
+    list(params: FileManagerFilesStorageOperationsListParams): Promise<FileManagerFilesStorageOperationsListResponse>;
+    tags(params: FileManagerFilesStorageOperationsTagsParams): Promise<FileManagerFilesStorageOperationsTagsResponse>;
+    private createQueryAllOptions;
+    private createPartitionKey;
+    private createSortKey;
+}
+export {};