@webiny/db 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,20 @@
+# @webiny/db
+[![](https://img.shields.io/npm/dw/webiny-data.svg)](https://www.npmjs.com/package/webiny-data) 
+[![](https://img.shields.io/npm/v/webiny-data.svg)](https://www.npmjs.com/package/webiny-data)
+[![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)
+
+A set of frequently used data higher order functions.
+
+For more information, please visit 
+[the official docs](https://github.com/doitadrian/data). 
+  
+## Install
+```
+npm install --save @webiny/db
+```
+
+Or if you prefer yarn: 
+```
+yarn add @webiny/db
+```

package/index.d.ts

@@ -0,0 +1,72 @@
+export declare type Key = {
+    primary?: boolean;
+    unique?: boolean;
+    name: string;
+    fields: {
+        name: string;
+    }[];
+};
+export declare type Args = {
+    __batch?: {
+        instance: Batch;
+        operation: Operation;
+    };
+    table?: string;
+    meta?: boolean;
+    limit?: number;
+    sort?: Record<string, 1 | -1>;
+    data?: Record<string, any>;
+    query?: Record<string, any>;
+    keys?: Key[];
+};
+export declare type Result<T = any> = [T, Record<string, any>];
+export interface DbDriver {
+    create: (args: Args) => Promise<Result<true>>;
+    read: <T = Record<string, any>>(args: Args) => Promise<Result<T[]>>;
+    update: (args: Args) => Promise<Result<true>>;
+    delete: (args: Args) => Promise<Result<true>>;
+    createLog: (args: {
+        operation: string;
+        data: Args;
+        table: string;
+        id: string;
+    }) => Promise<Result<true>>;
+    readLogs: <T = Record<string, any>>(args: {
+        table: string;
+    }) => Promise<Result<T[]>>;
+}
+export declare type OperationType = "create" | "read" | "update" | "delete";
+export declare type Operation = [OperationType, Args];
+export declare type ConstructorArgs = {
+    driver: DbDriver;
+    table?: string;
+    logTable?: string;
+};
+declare class Db {
+    driver: DbDriver;
+    table: string;
+    logTable?: string;
+    constructor({ driver, table, logTable }: ConstructorArgs);
+    create(args: Args): Promise<Result<true>>;
+    read<T = Record<string, any>>(args: Args): Promise<Result<T[]>>;
+    update(args: Args): Promise<Result<true>>;
+    delete(args: Args): Promise<Result<true>>;
+    createLog(operation: any, args: Args): Promise<Result<true>>;
+    readLogs<T = Record<string, any>>(): Promise<Result<T[]>>;
+    batch<T0 = any, T1 = any, T2 = any, T3 = any, T4 = any, T5 = any, T6 = any, T7 = any, T8 = any, T9 = any>(): Batch<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9>;
+}
+declare class Batch<T0 = any, T1 = any, T2 = any, T3 = any, T4 = any, T5 = any, T6 = any, T7 = any, T8 = any, T9 = any> {
+    db: Db;
+    type: "batch" | "transaction";
+    id: string;
+    meta: Record<string, any>;
+    operations: Operation[];
+    constructor(db: any);
+    push(...operations: Operation[]): this;
+    create(...args: Args[]): this;
+    read(...args: Args[]): this;
+    update(...args: Args[]): this;
+    delete(...args: Args[]): this;
+    execute(): Promise<[T0?, T1?, T2?, T3?, T4?, T5?, T6?, T7?, T8?, T9?]>;
+}
+export { Batch, Db };

package/index.js

@@ -0,0 +1,212 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Db = exports.Batch = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+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; }
+
+// Generates a short and sortable ID, e.g. "1607677774994.tfz58m".
+const shortId = () => {
+  const time = new Date().getTime();
+  const uniqueId = Math.random().toString(36).slice(-6);
+  return `${time}.${uniqueId}`;
+}; // Picks necessary data from received args, ready to be stored in the log table.
+
+
+const getCreateLogData = args => {
+  const {
+    table,
+    meta,
+    limit,
+    sort,
+    data,
+    query,
+    keys
+  } = args;
+  const logData = {
+    table,
+    meta,
+    limit,
+    sort,
+    data,
+    query,
+    keys,
+    batch: null
+  };
+
+  if (args.__batch) {
+    logData.batch = {
+      id: args.__batch.instance.id,
+      type: args.__batch.instance.type
+    };
+  }
+
+  return logData;
+};
+
+class Db {
+  constructor({
+    driver,
+    table,
+    logTable
+  }) {
+    (0, _defineProperty2.default)(this, "driver", void 0);
+    (0, _defineProperty2.default)(this, "table", void 0);
+    (0, _defineProperty2.default)(this, "logTable", void 0);
+    this.driver = driver;
+    this.table = table;
+    this.logTable = logTable;
+  }
+
+  async create(args) {
+    const createArgs = _objectSpread(_objectSpread({}, args), {}, {
+      table: args.table || this.table
+    });
+
+    await this.createLog("create", createArgs);
+    return this.driver.create(createArgs);
+  }
+
+  async read(args) {
+    const readArgs = _objectSpread(_objectSpread({}, args), {}, {
+      table: args.table || this.table
+    });
+
+    await this.createLog("read", readArgs);
+    return this.driver.read(readArgs);
+  }
+
+  async update(args) {
+    const updateArgs = _objectSpread(_objectSpread({}, args), {}, {
+      table: args.table || this.table
+    });
+
+    await this.createLog("update", updateArgs);
+    return this.driver.update(updateArgs);
+  }
+
+  async delete(args) {
+    const deleteArgs = _objectSpread(_objectSpread({}, args), {}, {
+      table: args.table || this.table
+    });
+
+    await this.createLog("delete", deleteArgs);
+    return this.driver.delete(deleteArgs);
+  } // Logging functions.
+
+
+  async createLog(operation, args) {
+    if (!this.logTable) {
+      return;
+    }
+
+    const data = getCreateLogData(args);
+    return this.driver.createLog({
+      operation,
+      data,
+      table: this.logTable,
+      id: shortId()
+    });
+  }
+
+  async readLogs() {
+    if (!this.logTable) {
+      return;
+    }
+
+    return this.driver.readLogs({
+      table: this.logTable
+    });
+  }
+
+  batch() {
+    return new Batch(this);
+  }
+
+}
+
+exports.Db = Db;
+
+class Batch {
+  constructor(db) {
+    (0, _defineProperty2.default)(this, "db", void 0);
+    (0, _defineProperty2.default)(this, "type", void 0);
+    (0, _defineProperty2.default)(this, "id", void 0);
+    (0, _defineProperty2.default)(this, "meta", void 0);
+    (0, _defineProperty2.default)(this, "operations", void 0);
+    this.db = db;
+    this.type = "batch";
+    this.id = shortId();
+    this.meta = {};
+    this.operations = [];
+  }
+
+  push(...operations) {
+    for (let i = 0; i < operations.length; i++) {
+      const item = operations[i];
+      this.operations.push(item);
+    }
+
+    return this;
+  }
+
+  create(...args) {
+    for (let i = 0; i < args.length; i++) {
+      this.push(["create", args[i]]);
+    }
+
+    return this;
+  }
+
+  read(...args) {
+    for (let i = 0; i < args.length; i++) {
+      this.push(["read", args[i]]);
+    }
+
+    return this;
+  }
+
+  update(...args) {
+    for (let i = 0; i < args.length; i++) {
+      this.push(["update", args[i]]);
+    }
+
+    return this;
+  }
+
+  delete(...args) {
+    for (let i = 0; i < args.length; i++) {
+      this.push(["delete", args[i]]);
+    }
+
+    return this;
+  }
+
+  async execute() {
+    const promises = [];
+
+    for (let i = 0; i < this.operations.length; i++) {
+      const [operation, args] = this.operations[i];
+      promises.push(this.db[operation](_objectSpread(_objectSpread({}, args), {}, {
+        __batch: {
+          instance: this,
+          operation: this.operations[i]
+        }
+      })));
+    }
+
+    const result = Promise.all(promises);
+    return result;
+  }
+
+}
+
+exports.Batch = Batch;

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@webiny/db",
+  "version": "0.0.0-mt-1",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webiny/webiny-js.git"
+  },
+  "description": "A simple multi-database client.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.5.5",
+    "@babel/core": "^7.5.5",
+    "@webiny/cli": "^0.0.0-mt-1",
+    "@webiny/project-utils": "^0.0.0-mt-1",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.1.3"
+  },
+  "scripts": {
+    "build": "yarn webiny run build",
+    "watch": "yarn webiny run watch"
+  },
+  "gitHead": "37736d8456a6ecb342a6c3645060bd9a3f2d4bb0"
+}