@ja-platform/db 0.0.0-dev-20261028223022

package/dist/database/Batch.js

@@ -0,0 +1,189 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudError = exports.Batch = void 0;
+function validateAdapter(batchAdapter, object) {
+    if (object._adapter === batchAdapter || object._adapter.name == batchAdapter.name) {
+        return;
+    }
+    throw new Error('Cannot add an object in ' + object._adapter.description() + ' to a Batch in ' + batchAdapter.description());
+}
+class Batch {
+    /**
+     * Construct a new batch.
+     *
+     * If the same object is added to the batch multiple times, only the last instance
+     * is kept.
+     *
+     * @param adapter the Database instance
+     */
+    constructor(adapter) {
+        if (adapter._adapter) {
+            this.adapter = adapter._adapter;
+        }
+        else {
+            this.adapter = adapter;
+        }
+        this._operations = [];
+    }
+    /**
+     * Add an object to save to the batch. The object is saved when batch.execute() is called.
+     */
+    save(object) {
+        validateAdapter(this.adapter, object);
+        this._operations.push({ op: 'save', object: object });
+    }
+    /**
+     * Add an object to destroy to the batch. The object is destroyed when batch.execute() is called.
+     */
+    destroy(object) {
+        validateAdapter(this.adapter, object);
+        this._operations.push({ op: 'destroy', object: object });
+    }
+    /**
+     * Execute the batch.
+     *
+     * There are two classes of errors:
+     * 1. Network or code error. The entire batch is rejected with an error.
+     * 2. Individual object errors. In this case, the batch is rejected with a CrudError, which contains the individual errors.
+     */
+    execute() {
+        return this._execute();
+    }
+    /**
+     * @internal
+     */
+    async _execute() {
+        const ops = this._getOps();
+        if (ops.length == 0) {
+            return;
+        }
+        // Split into smaller batches, and execute them sequentially.
+        const batchLimit = this.adapter.batchLimit || 1000;
+        let splitBatches = [];
+        for (let i = 0; i < ops.length; i += batchLimit) {
+            splitBatches.push(ops.slice(i, i + batchLimit));
+        }
+        const adapter = this.adapter;
+        const errors = [];
+        for (const splitOps of splitBatches) {
+            const results = await adapter.applyBatch(splitOps);
+            splitOps.forEach((op, j) => {
+                const result = results[j];
+                if (result.error) {
+                    errors.push({
+                        object: op.object,
+                        operation: op.op,
+                        error: result.error
+                    });
+                    return;
+                }
+                if (op.op == 'put' || op.op == 'patch') {
+                    op.object._persisted();
+                    return;
+                }
+                if (op.op == 'delete') {
+                    op.object._destroyed();
+                    return;
+                }
+            });
+        }
+        if (errors.length > 0) {
+            throw new CrudError(errors);
+        }
+    }
+    _getOps() {
+        let opCache = new WeakMap();
+        let prebatch = [];
+        // Dedup based on the object instance, not object id.
+        function addOp(op) {
+            const previousOp = opCache.get(op.object);
+            if (previousOp) {
+                if (previousOp.op == 'delete') {
+                    // Can't do anything after a delete. Ignore this op.
+                    // [delete1, save2] => [delete1]
+                    // [delete1, delete2] => [delete1] (delete2 would be the same)
+                    return;
+                }
+                else if (op.op == 'delete') {
+                    // Replace previous save
+                    // [save1, delete2] => [delete2]
+                    previousOp.op = 'ignore';
+                }
+                else {
+                    // Both are saves. Because it's the same object, the patch will be the same for both.
+                    // Ignore the second one.
+                    // [save1, save2] => [save1]
+                    return;
+                }
+            }
+            opCache.set(op.object, op);
+            prebatch.push(op);
+        }
+        for (let op of this._operations) {
+            if (op.op == 'save') {
+                // _getDirtyList does not return any destroyed objects.
+                const dirtyList = op.object._getDirtyList();
+                for (let object of dirtyList) {
+                    const data = object.toData(false);
+                    let patch = null;
+                    if (object.persisted) {
+                        patch = object.toData(true);
+                    }
+                    addOp({
+                        op: patch == null ? 'put' : 'patch',
+                        type: object.type.name,
+                        id: object.id,
+                        data: data,
+                        patch: patch,
+                        object: object
+                    });
+                }
+            }
+            else if (op.op == 'destroy') {
+                addOp({
+                    op: 'delete',
+                    type: op.object.type.name,
+                    id: op.object.id,
+                    object: op.object
+                });
+            }
+            else {
+                throw new Error('Unknown op: ' + op.op);
+            }
+        }
+        let batch = [];
+        for (let op of prebatch) {
+            if (op.op == 'ignore') {
+                continue;
+            }
+            if (op.op == 'patch') {
+                if (Object.keys(op.patch.attributes).length === 0 && Object.keys(op.patch.belongs_to).length === 0) {
+                    // No-op
+                    continue;
+                }
+            }
+            batch.push(op);
+        }
+        return batch;
+    }
+}
+exports.Batch = Batch;
+class CrudError extends Error {
+    constructor(errors) {
+        super();
+        this.errors = errors;
+        let message = 'Crud operations failed.';
+        errors.forEach(function (error) {
+            message += '\n  ' + error.object.type.name + ' ' + error.object.id + ': ' + error.error.detail;
+        });
+        this.message = message;
+    }
+    /**
+     * Return the first error. Useful if this was used for a single operation.
+     */
+    firstError() {
+        return this.errors[0].error;
+    }
+}
+exports.CrudError = CrudError;
+//# sourceMappingURL=Batch.js.map

package/dist/database/Batch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Batch.js","sourceRoot":"","sources":["../../src/database/Batch.ts"],"names":[],"mappings":";;;AA8BA,SAAS,eAAe,CAAC,YAA6B,EAAE,MAAsB;IAC5E,IAAI,MAAM,CAAC,QAAQ,KAAK,YAAY,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC;QAClF,OAAO;IACT,CAAC;IACD,MAAM,IAAI,KAAK,CACb,0BAA0B,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,GAAG,iBAAiB,GAAG,YAAY,CAAC,WAAW,EAAE,CAC5G,CAAC;AACJ,CAAC;AAED;IAME;;;;;;;OAOG;IACH,YAAY,OAAmC;QAC7C,IAAK,OAAoB,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,GAAI,OAAoB,CAAC,QAAQ,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,OAA0B,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAsB;QACzB,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAsB;QAC5B,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3B,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,6DAA6D;QAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC;QACnD,IAAI,YAAY,GAA8B,EAAE,CAAC;QACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;YAChD,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;YACpC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAEnD,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;gBACzB,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;gBAE1B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBACjB,MAAM,CAAC,IAAI,CAAC;wBACV,MAAM,EAAE,EAAE,CAAC,MAAM;wBACjB,SAAS,EAAE,EAAE,CAAC,EAAE;wBAChB,KAAK,EAAE,MAAM,CAAC,KAAK;qBACpB,CAAC,CAAC;oBACH,OAAO;gBACT,CAAC;gBAED,IAAI,EAAE,CAAC,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC;oBACvC,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;oBACvB,OAAO;gBACT,CAAC;gBAED,IAAI,EAAE,CAAC,EAAE,IAAI,QAAQ,EAAE,CAAC;oBACtB,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;oBACvB,OAAO;gBACT,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAEO,OAAO;QACb,IAAI,OAAO,GAAG,IAAI,OAAO,EAAyC,CAAC;QAEnE,IAAI,QAAQ,GAA4B,EAAE,CAAC;QAE3C,qDAAqD;QACrD,SAAS,KAAK,CAAC,EAAyB;YACtC,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;YAE1C,IAAI,UAAU,EAAE,CAAC;gBACf,IAAI,UAAU,CAAC,EAAE,IAAI,QAAQ,EAAE,CAAC;oBAC9B,oDAAoD;oBACpD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO;gBACT,CAAC;qBAAM,IAAI,EAAE,CAAC,EAAE,IAAI,QAAQ,EAAE,CAAC;oBAC7B,wBAAwB;oBACxB,gCAAgC;oBAChC,UAAU,CAAC,EAAE,GAAG,QAAQ,CAAC;gBAC3B,CAAC;qBAAM,CAAC;oBACN,qFAAqF;oBACrF,yBAAyB;oBACzB,4BAA4B;oBAC5B,OAAO;gBACT,CAAC;YACH,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpB,CAAC;QAED,KAAK,IAAI,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAChC,IAAI,EAAE,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;gBACpB,uDAAuD;gBACvD,MAAM,SAAS,GAAG,EAAE,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;gBAC5C,KAAK,IAAI,MAAM,IAAI,SAAS,EAAE,CAAC;oBAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAClC,IAAI,KAAK,GAAG,IAAI,CAAC;oBACjB,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;wBACrB,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBAC9B,CAAC;oBACD,KAAK,CAAC;wBACJ,EAAE,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO;wBACnC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI;wBACtB,EAAE,EAAE,MAAM,CAAC,EAAE;wBACb,IAAI,EAAE,IAAI;wBACV,KAAK,EAAE,KAAK;wBACZ,MAAM,EAAE,MAAM;qBACf,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;iBAAM,IAAI,EAAE,CAAC,EAAE,IAAI,SAAS,EAAE,CAAC;gBAC9B,KAAK,CAAC;oBACJ,EAAE,EAAE,QAAQ;oBACZ,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI;oBACzB,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE;oBAChB,MAAM,EAAE,EAAE,CAAC,MAAM;iBAClB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,IAAI,KAAK,GAA4B,EAAE,CAAC;QAExC,KAAK,IAAI,EAAE,IAAI,QAAQ,EAAE,CAAC;YACxB,IAAI,EAAE,CAAC,EAAE,IAAI,QAAQ,EAAE,CAAC;gBACtB,SAAS;YACX,CAAC;YACD,IAAI,EAAE,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC;gBACrB,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACnG,QAAQ;oBACR,SAAS;gBACX,CAAC;YACH,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF;;AAED,eAAuB,SAAQ,KAAK;IAGlC,YAAY,MAAoB;QAC9B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,OAAO,GAAG,yBAAyB,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,UAAU,KAAK;YAC5B,OAAO,IAAI,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;QACjG,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9B,CAAC;CACF","sourcesContent":["import { PersistedObjectData } from '../types/ObjectData';\nimport * as j from '../utils/JourneyPromise';\nimport { DatabaseAdapter } from './adapters/DatabaseAdapter';\nimport { Database } from './Database';\nimport { DatabaseObject } from './DatabaseObject';\n\ninterface BatchOperation {\n  object: DatabaseObject;\n  op: 'save' | 'destroy';\n}\n\nexport interface BatchError {\n  object: DatabaseObject;\n  operation: 'put' | 'patch' | 'delete' | 'ignore';\n  error: { detail: string };\n}\n\nexport interface ExecuteBatchOperation {\n  op: 'put' | 'patch' | 'delete' | 'ignore';\n  type: string;\n  id: string;\n  object: DatabaseObject;\n  data?: PersistedObjectData;\n  patch?: PersistedObjectData;\n}\n\nexport interface ExecuteBatchResult {\n  error?: any;\n}\n\nfunction validateAdapter(batchAdapter: DatabaseAdapter, object: DatabaseObject) {\n  if (object._adapter === batchAdapter || object._adapter.name == batchAdapter.name) {\n    return;\n  }\n  throw new Error(\n    'Cannot add an object in ' + object._adapter.description() + ' to a Batch in ' + batchAdapter.description()\n  );\n}\n\nexport class Batch {\n  /** @internal */\n  adapter: DatabaseAdapter;\n  /** @internal */\n  private _operations: BatchOperation[];\n\n  /**\n   * Construct a new batch.\n   *\n   * If the same object is added to the batch multiple times, only the last instance\n   * is kept.\n   *\n   * @param adapter the Database instance\n   */\n  constructor(adapter: DatabaseAdapter | Database) {\n    if ((adapter as Database)._adapter) {\n      this.adapter = (adapter as Database)._adapter;\n    } else {\n      this.adapter = adapter as DatabaseAdapter;\n    }\n    this._operations = [];\n  }\n\n  /**\n   * Add an object to save to the batch. The object is saved when batch.execute() is called.\n   */\n  save(object: DatabaseObject) {\n    validateAdapter(this.adapter, object);\n    this._operations.push({ op: 'save', object: object });\n  }\n\n  /**\n   * Add an object to destroy to the batch. The object is destroyed when batch.execute() is called.\n   */\n  destroy(object: DatabaseObject) {\n    validateAdapter(this.adapter, object);\n    this._operations.push({ op: 'destroy', object: object });\n  }\n\n  /**\n   * Execute the batch.\n   *\n   * There are two classes of errors:\n   * 1. Network or code error. The entire batch is rejected with an error.\n   * 2. Individual object errors. In this case, the batch is rejected with a CrudError, which contains the individual errors.\n   */\n  execute(): j.Promise<void> {\n    return this._execute();\n  }\n\n  /**\n   * @internal\n   */\n  async _execute(): Promise<void> {\n    const ops = this._getOps();\n    if (ops.length == 0) {\n      return;\n    }\n\n    // Split into smaller batches, and execute them sequentially.\n    const batchLimit = this.adapter.batchLimit || 1000;\n    let splitBatches: ExecuteBatchOperation[][] = [];\n    for (let i = 0; i < ops.length; i += batchLimit) {\n      splitBatches.push(ops.slice(i, i + batchLimit));\n    }\n\n    const adapter = this.adapter;\n    const errors: BatchError[] = [];\n    for (const splitOps of splitBatches) {\n      const results = await adapter.applyBatch(splitOps);\n\n      splitOps.forEach((op, j) => {\n        const result = results[j];\n\n        if (result.error) {\n          errors.push({\n            object: op.object,\n            operation: op.op,\n            error: result.error\n          });\n          return;\n        }\n\n        if (op.op == 'put' || op.op == 'patch') {\n          op.object._persisted();\n          return;\n        }\n\n        if (op.op == 'delete') {\n          op.object._destroyed();\n          return;\n        }\n      });\n    }\n\n    if (errors.length > 0) {\n      throw new CrudError(errors);\n    }\n  }\n\n  private _getOps(): ExecuteBatchOperation[] {\n    let opCache = new WeakMap<DatabaseObject, ExecuteBatchOperation>();\n\n    let prebatch: ExecuteBatchOperation[] = [];\n\n    // Dedup based on the object instance, not object id.\n    function addOp(op: ExecuteBatchOperation) {\n      const previousOp = opCache.get(op.object);\n\n      if (previousOp) {\n        if (previousOp.op == 'delete') {\n          // Can't do anything after a delete. Ignore this op.\n          // [delete1, save2] => [delete1]\n          // [delete1, delete2] => [delete1] (delete2 would be the same)\n          return;\n        } else if (op.op == 'delete') {\n          // Replace previous save\n          // [save1, delete2] => [delete2]\n          previousOp.op = 'ignore';\n        } else {\n          // Both are saves. Because it's the same object, the patch will be the same for both.\n          // Ignore the second one.\n          // [save1, save2] => [save1]\n          return;\n        }\n      }\n      opCache.set(op.object, op);\n      prebatch.push(op);\n    }\n\n    for (let op of this._operations) {\n      if (op.op == 'save') {\n        // _getDirtyList does not return any destroyed objects.\n        const dirtyList = op.object._getDirtyList();\n        for (let object of dirtyList) {\n          const data = object.toData(false);\n          let patch = null;\n          if (object.persisted) {\n            patch = object.toData(true);\n          }\n          addOp({\n            op: patch == null ? 'put' : 'patch',\n            type: object.type.name,\n            id: object.id,\n            data: data,\n            patch: patch,\n            object: object\n          });\n        }\n      } else if (op.op == 'destroy') {\n        addOp({\n          op: 'delete',\n          type: op.object.type.name,\n          id: op.object.id,\n          object: op.object\n        });\n      } else {\n        throw new Error('Unknown op: ' + op.op);\n      }\n    }\n\n    let batch: ExecuteBatchOperation[] = [];\n\n    for (let op of prebatch) {\n      if (op.op == 'ignore') {\n        continue;\n      }\n      if (op.op == 'patch') {\n        if (Object.keys(op.patch.attributes).length === 0 && Object.keys(op.patch.belongs_to).length === 0) {\n          // No-op\n          continue;\n        }\n      }\n      batch.push(op);\n    }\n\n    return batch;\n  }\n}\n\nexport class CrudError extends Error {\n  errors: BatchError[];\n\n  constructor(errors: BatchError[]) {\n    super();\n    this.errors = errors;\n\n    let message = 'Crud operations failed.';\n    errors.forEach(function (error) {\n      message += '\\n  ' + error.object.type.name + ' ' + error.object.id + ': ' + error.error.detail;\n    });\n    this.message = message;\n  }\n\n  /**\n   * Return the first error. Useful if this was used for a single operation.\n   */\n  firstError() {\n    return this.errors[0].error;\n  }\n}\n"]}

package/dist/database/Collection.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Collection = void 0;
+const DatabaseObject_1 = require("./DatabaseObject");
+const Query_1 = require("../query/Query");
+// ## Collection
+// This is the external interface for an object collection, as in `DB.asset`.
+class Collection {
+    constructor(adapter, type) {
+        this.type = type;
+        this.adapter = adapter;
+    }
+    /**
+     * Query for all objects in the collection. The query may be filtered further.
+     *
+     * Return the results as a Query. Call `.toArray()` to get the results.
+     */
+    all() {
+        return new Query_1.Query(this.adapter, this.type);
+    }
+    /**
+     * Create a new object.
+     *
+     * It is not saved until .save() is called.
+     *
+     * @param attributes - Enumerable object to initialize with.
+     */
+    create(attributes) {
+        let object = DatabaseObject_1.DatabaseObject.build(this.adapter, this.type);
+        object.setAll(attributes);
+        return object;
+    }
+    where(...args) {
+        return this.all().where(...args);
+    }
+    /** @internal */
+    _get(id) {
+        // TODO: varargs
+        if (arguments.length == 1 && typeof arguments[0] == 'string') {
+            // Find by ID - return a placeholder
+            const promise = this.adapter.get(this.type.name, id);
+            return promise.then((data) => {
+                if (data == null) {
+                    return null;
+                }
+                else {
+                    return DatabaseObject_1.DatabaseObject.build(this.adapter, this.type, id, data);
+                }
+            });
+        }
+        else if (arguments.length == 1 && arguments[0] == null) {
+            // This can happen when passing in null/undefined as an ID.
+            return Promise.reject('Query expression or ID required');
+        }
+        else {
+            // Same as a where query, but only return a single result.
+            return this.where.apply(this, arguments)._get();
+        }
+    }
+    // Aliases
+    _first() {
+        return this._get.apply(this, arguments);
+    }
+    first() {
+        return this._get.apply(this, arguments);
+    }
+}
+exports.Collection = Collection;
+//# sourceMappingURL=Collection.js.map

package/dist/database/Collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Collection.js","sourceRoot":"","sources":["../../src/database/Collection.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAGlD,0CAAuC;AAGvC,gBAAgB;AAChB,6EAA6E;AAE7E;IAIE,YAAY,OAAwB,EAAE,IAAqB;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,GAAG;QACD,OAAO,IAAI,aAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAgB;QACrB,IAAI,MAAM,GAAG,+BAAc,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC1B,OAAO,MAAW,CAAC;IACrB,CAAC;IA+BD,KAAK,CAAC,GAAG,IAAW;QAClB,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,gBAAgB;IAChB,IAAI,CAAC,EAAW;QACd,gBAAgB;QAChB,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,IAAI,OAAO,SAAS,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC;YAC7D,oCAAoC;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACrD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC3B,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjB,OAAO,IAAI,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,OAAO,+BAAc,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAM,CAAC;gBACtE,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YACzD,2DAA2D;YAC3D,OAAO,OAAO,CAAC,MAAM,CAAC,iCAAiC,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,0DAA0D;YAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAClD,CAAC;IACH,CAAC;IAED,UAAU;IACF,MAAM;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAmCD,KAAK;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import { DatabaseObject } from './DatabaseObject';\nimport { SchemaModelType } from '@ja-platform/parser-schema';\nimport { DatabaseAdapter } from './adapters/DatabaseAdapter';\nimport { Query } from '../query/Query';\nimport * as j from '../utils/JourneyPromise';\n\n// ## Collection\n// This is the external interface for an object collection, as in `DB.asset`.\n\nexport class Collection<T extends DatabaseObject = DatabaseObject> {\n  type: SchemaModelType;\n  adapter: DatabaseAdapter;\n\n  constructor(adapter: DatabaseAdapter, type: SchemaModelType) {\n    this.type = type;\n    this.adapter = adapter;\n  }\n\n  /**\n   * Query for all objects in the collection. The query may be filtered further.\n   *\n   * Return the results as a Query. Call `.toArray()` to get the results.\n   */\n  all(): Query<T> {\n    return new Query(this.adapter, this.type);\n  }\n\n  /**\n   * Create a new object.\n   *\n   * It is not saved until .save() is called.\n   *\n   * @param attributes - Enumerable object to initialize with.\n   */\n  create(attributes?: any): T {\n    let object = DatabaseObject.build(this.adapter, this.type);\n    object.setAll(attributes);\n    return object as T;\n  }\n\n  /**\n   * Filter by a query string and arguments.\n   *\n   * Return the results as a Query. Call `.toArray()` to get the results.\n   *\n   *\n   * Example:\n   *\n   *    DB.user.where('email = ? and archived != ?', email, false)\n   *\n   * @param query the query string\n   * @param args the query args\n   */\n  where(query: string, ...args: any[]): Query<T>;\n\n  /**\n   * Filter by an object of {attribute: value} pairs.\n   *\n   * Return the results as a Query. Call `.toArray()` to get the results.\n   *\n   * @param filters an object of {field: value}\n   */\n  where(filters: { [key: string]: any }): Query<T>;\n\n  /**\n   * Same as .all()\n   */\n  where(): Query<T>;\n\n  where(...args: any[]): Query<T> {\n    return this.all().where(...args);\n  }\n\n  /** @internal */\n  _get(id?: string): Promise<T | null> {\n    // TODO: varargs\n    if (arguments.length == 1 && typeof arguments[0] == 'string') {\n      // Find by ID - return a placeholder\n      const promise = this.adapter.get(this.type.name, id);\n      return promise.then((data) => {\n        if (data == null) {\n          return null;\n        } else {\n          return DatabaseObject.build(this.adapter, this.type, id, data) as T;\n        }\n      });\n    } else if (arguments.length == 1 && arguments[0] == null) {\n      // This can happen when passing in null/undefined as an ID.\n      return Promise.reject('Query expression or ID required');\n    } else {\n      // Same as a where query, but only return a single result.\n      return this.where.apply(this, arguments)._get();\n    }\n  }\n\n  // Aliases\n  private _first(): Promise<T> {\n    return this._get.apply(this, arguments);\n  }\n\n  /**\n   * Get a single object by id.\n   */\n  first(id: string): j.Promise<T>;\n\n  /**\n   * Get a single object by query.\n   *\n   * If the query has more than one matching result, only the first seen one is returned.\n   *\n   * Same as .where(...).first().\n   *\n   * @param query the query string\n   * @param args the query args\n   */\n  first(query: string, ...args: any[]): j.Promise<T>;\n\n  /**\n   * Return a single object from the collection.\n   */\n  first(): j.Promise<T>;\n\n  /**\n   * Get a single object by query.\n   *\n   * If the query has more than one matching result, only the first seen one is returned.\n   *\n   * Same as .where(...).first().\n   *\n   * @param filters an object of {field: value}\n   */\n  first(filters: { [key: string]: any }): j.Promise<T>;\n\n  first(): j.Promise<T> {\n    return this._get.apply(this, arguments);\n  }\n}\n\nexport type TypedCollection<T> = Collection<DatabaseObject & T>;\n"]}

package/dist/database/Database.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Query = exports.DatabaseObject = exports.Collection = exports.Database = void 0;
+// ## Database
+// This is the external database interface, the `DB` object.
+const credentials_1 = require("../credentials");
+const JourneyAPIAdapter_1 = require("./JourneyAPIAdapter");
+const Collection_1 = require("./Collection");
+Object.defineProperty(exports, "Collection", { enumerable: true, get: function () { return Collection_1.Collection; } });
+const Batch_1 = require("./Batch");
+const DatabaseObject_1 = require("./DatabaseObject");
+Object.defineProperty(exports, "DatabaseObject", { enumerable: true, get: function () { return DatabaseObject_1.DatabaseObject; } });
+const Query_1 = require("../query/Query");
+Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return Query_1.Query; } });
+class Database {
+    /**
+     * Convenience factory method for getting a Database Object
+     */
+    static async instance(options) {
+        var credentials = new credentials_1.ApiCredentials(options);
+        let api = new JourneyAPIAdapter_1.JourneyAPIAdapter(credentials, null);
+        await api.loadDataModel();
+        // setup a database instance now that we have all the required components
+        return new Database(api.schema, api);
+    }
+    static getTypedDatabase(schema, adapter) {
+        return new Database(schema, adapter);
+    }
+    constructor(schema, adapter) {
+        for (var name in schema.objects) {
+            if (schema.objects.hasOwnProperty(name)) {
+                this[name] = new Collection_1.Collection(adapter, schema.objects[name]);
+            }
+        }
+        this.schema = schema;
+        this._adapter = adapter;
+        // Extends batch.Batch, passing adapter as an argument to the constfructor.
+        class DatabaseBatch extends Batch_1.Batch {
+            constructor() {
+                super(adapter);
+            }
+        }
+        this.Batch = DatabaseBatch;
+    }
+}
+exports.Database = Database;
+//# sourceMappingURL=Database.js.map

package/dist/database/Database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Database.js","sourceRoot":"","sources":["../../src/database/Database.ts"],"names":[],"mappings":";;;AAAA,cAAc;AACd,4DAA4D;AAC5D,gDAAsE;AACtE,2DAAwD;AAExD,6CAA2D;2FAAlD,uBAAU;AACnB,mCAAgC;AAEhC,qDAAkD;+FAAzC,+BAAc;AACvB,0CAAuC;sFAA9B,aAAK;AAGd;IACE;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAA6B;QACjD,IAAI,WAAW,GAAG,IAAI,4BAAc,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,GAAG,GAAG,IAAI,qCAAiB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAEnD,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC;QAE1B,yEAAyE;QACzE,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IAQD,MAAM,CAAC,gBAAgB,CACrB,MAAc,EACd,OAAwB;QAExB,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAiB,CAAC;IACvD,CAAC;IAED,YAAY,MAAc,EAAE,OAAwB;QAClD,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAChC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvC,IAA+B,CAAC,IAAI,CAAC,GAAG,IAAI,uBAAU,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,2EAA2E;QAC3E,MAAM,aAAc,SAAQ,aAAK;YAC/B;gBACE,KAAK,CAAC,OAAO,CAAC,CAAC;YACjB,CAAC;SACF;QAED,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC;IAC7B,CAAC;CACF","sourcesContent":["// ## Database\n// This is the external database interface, the `DB` object.\nimport { ApiCredentialOptions, ApiCredentials } from '../credentials';\nimport { JourneyAPIAdapter } from './JourneyAPIAdapter';\nimport { DatabaseAdapter } from './adapters/DatabaseAdapter';\nimport { Collection, TypedCollection } from './Collection';\nimport { Batch } from './Batch';\nimport { GenericDatabase } from './GenericDatabase';\nimport { DatabaseObject } from './DatabaseObject';\nimport { Query } from '../query/Query';\nimport { DBSchema as Schema } from '../Schema';\n\nexport class Database {\n  /**\n   * Convenience factory method for getting a Database Object\n   */\n  static async instance(options: ApiCredentialOptions) {\n    var credentials = new ApiCredentials(options);\n    let api = new JourneyAPIAdapter(credentials, null);\n\n    await api.loadDataModel();\n\n    // setup a database instance now that we have all the required components\n    return new Database(api.schema, api);\n  }\n\n  Batch: new () => Batch;\n  schema: Schema;\n\n  /** @internal */\n  _adapter: DatabaseAdapter;\n\n  static getTypedDatabase<T extends { [key: string]: {} }, U = { [K in keyof T]?: TypedCollection<T[K]> }>(\n    schema: Schema,\n    adapter: DatabaseAdapter\n  ): Database & U {\n    return new Database(schema, adapter) as Database & U;\n  }\n\n  constructor(schema: Schema, adapter: DatabaseAdapter) {\n    for (var name in schema.objects) {\n      if (schema.objects.hasOwnProperty(name)) {\n        (this as any as GenericDatabase)[name] = new Collection(adapter, schema.objects[name]);\n      }\n    }\n\n    this.schema = schema;\n    this._adapter = adapter;\n\n    // Extends batch.Batch, passing adapter as an argument to the constfructor.\n    class DatabaseBatch extends Batch {\n      constructor() {\n        super(adapter);\n      }\n    }\n\n    this.Batch = DatabaseBatch;\n  }\n}\n\nexport { Collection, DatabaseObject, Query };\n"]}