@rushdb/javascript-sdk 0.9.4 → 0.10.0

package/cjs/sdk/index.js

@@ -1,23 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./sdk.js"), exports);
-__exportStar(require("./types.js"), exports);
-__exportStar(require("./errors.js"), exports);
-__exportStar(require("./transaction.js"), exports);
-__exportStar(require("./utils.js"), exports);
-__exportStar(require("./record.js"), exports);
-__exportStar(require("./model.js"), exports);

package/cjs/sdk/model.js

@@ -1,147 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Model = void 0;
-const rest_api_proxy_js_1 = require("../api/rest-api-proxy.js");
-const utils_js_1 = require("../common/utils.js");
-const errors_js_1 = require("./errors.js");
-const utils_js_2 = require("./utils.js");
-class Model extends rest_api_proxy_js_1.RestApiProxy {
-    constructor(modelName, schema, RushDBInstance) {
-        super();
-        this.label = modelName;
-        this.schema = schema;
-        RushDBInstance === null || RushDBInstance === void 0 ? void 0 : RushDBInstance.registerModel(this);
-    }
-    getLabel() {
-        return this.label;
-    }
-    async find(params = {}, transaction) {
-        var _a;
-        return (_a = this.apiProxy) === null || _a === void 0 ? void 0 : _a.records.find(this.label, params, transaction);
-    }
-    async findOne(params = {}, transaction) {
-        var _a;
-        return (_a = this.apiProxy) === null || _a === void 0 ? void 0 : _a.records.findOne(this.label, Object.assign({}, params), transaction);
-    }
-    async findById(id, transaction) {
-        return this.findOne({ where: { $id: id } }, transaction);
-    }
-    async findUniq(params = {}, transaction) {
-        var _a;
-        return (_a = this.apiProxy) === null || _a === void 0 ? void 0 : _a.records.findUniq(this.label, Object.assign({}, params), transaction);
-    }
-    async create(record, transaction) {
-        var _a;
-        const data = await (0, utils_js_2.mergeDefaultsWithPayload)(this.schema, record);
-        const uniqFields = (0, utils_js_2.pickUniqFieldsFromRecord)(this.schema, data);
-        if (!(0, utils_js_1.isEmptyObject)(uniqFields)) {
-            const tx = transaction !== null && transaction !== void 0 ? transaction : (await this.apiProxy.tx.begin());
-            const matchingRecords = await this.find({ where: uniqFields }, tx);
-            const hasOwnTransaction = typeof transaction !== 'undefined';
-            const canCreate = !((_a = matchingRecords === null || matchingRecords === void 0 ? void 0 : matchingRecords.data) === null || _a === void 0 ? void 0 : _a.length);
-            if (canCreate) {
-                const result = await this.apiProxy.records.create(this.label, data, tx);
-                if (!hasOwnTransaction) {
-                    await tx.commit();
-                }
-                return result;
-            }
-            else {
-                if (!hasOwnTransaction) {
-                    await tx.commit();
-                }
-                // @TODO: Make it optional
-                throw new errors_js_1.UniquenessError(this.label, uniqFields);
-            }
-        }
-        return await this.apiProxy.records.create(this.label, data, transaction);
-    }
-    attach(sourceId, target, options, transaction) {
-        return this.apiProxy.records.attach(sourceId, target, options, transaction);
-    }
-    detach(sourceId, target, options, transaction) {
-        return this.apiProxy.records.detach(sourceId, target, options, transaction);
-    }
-    async handleSetOrUpdate(id, record, method, transaction) {
-        var _a;
-        const data = await (0, utils_js_2.mergeDefaultsWithPayload)(this.schema, record);
-        const uniqFields = (0, utils_js_2.pickUniqFieldsFromRecord)(this.schema, data);
-        if (!(0, utils_js_1.isEmptyObject)(uniqFields)) {
-            const tx = transaction !== null && transaction !== void 0 ? transaction : (await this.apiProxy.tx.begin());
-            const matchingRecords = await this.find({ where: uniqFields }, tx);
-            const hasOwnTransaction = typeof transaction !== 'undefined';
-            const canUpdate = !((_a = matchingRecords === null || matchingRecords === void 0 ? void 0 : matchingRecords.data) === null || _a === void 0 ? void 0 : _a.length) ||
-                (matchingRecords.data.length === 1 && matchingRecords.data[0].__id === id);
-            if (canUpdate) {
-                const result = await this.apiProxy.records[method](id, data, tx);
-                if (!hasOwnTransaction) {
-                    await tx.commit();
-                }
-                return result;
-            }
-            else {
-                if (!hasOwnTransaction) {
-                    await tx.commit();
-                }
-                throw new errors_js_1.UniquenessError(this.label, uniqFields);
-            }
-        }
-        return await this.apiProxy.records[method](id, data, transaction);
-    }
-    async set(id, record, transaction) {
-        return await this.handleSetOrUpdate(id, record, 'set', transaction);
-    }
-    async update(id, record, transaction) {
-        return await this.handleSetOrUpdate(id, record, 'update', transaction);
-    }
-    async createMany(records, transaction) {
-        var _a;
-        // Begin a transaction if one isn't provided.
-        const hasOwnTransaction = typeof transaction !== 'undefined';
-        const tx = transaction !== null && transaction !== void 0 ? transaction : (await this.apiProxy.tx.begin());
-        try {
-            // Apply defaults in parallel
-            const recordsToStore = await Promise.all(records.map(async (record) => {
-                return await (0, utils_js_2.mergeDefaultsWithPayload)(this.schema, record);
-            }));
-            // Check uniqueness
-            const uniqProperties = (0, utils_js_2.pickUniqFieldsFromRecords)(recordsToStore, this.schema, this.label);
-            if (!(0, utils_js_1.isEmptyObject)(uniqProperties)) {
-                const criteria = Object.entries(uniqProperties).map(([key, values]) => ({
-                    [key]: { $in: values }
-                }));
-                const matchingRecords = await this.find({
-                    where: {
-                        $or: criteria
-                    }
-                }, tx);
-                if ((_a = matchingRecords === null || matchingRecords === void 0 ? void 0 : matchingRecords.data) === null || _a === void 0 ? void 0 : _a.length) {
-                    throw new errors_js_1.UniquenessError(this.label, Object.keys(uniqProperties));
-                }
-            }
-            // Create records in the database
-            const createdRecords = await this.apiProxy.records.createMany(this.label, recordsToStore, tx);
-            // Commit the transaction if it was created internally
-            if (!hasOwnTransaction) {
-                await tx.commit();
-            }
-            return createdRecords;
-        }
-        catch (error) {
-            if (!hasOwnTransaction) {
-                await tx.rollback();
-            }
-            throw error;
-        }
-    }
-    async delete(searchParams, transaction) {
-        if ((0, utils_js_1.isEmptyObject)(searchParams.where)) {
-            throw new errors_js_1.EmptyTargetError(`You must specify criteria to delete records of type '${this.label}'. Empty criteria are not allowed. If this was intentional, use the Dashboard instead.`);
-        }
-        return await this.apiProxy.records.delete(Object.assign(Object.assign({}, searchParams), { labels: [this.label] }), transaction);
-    }
-    async deleteById(idOrIds, transaction) {
-        return await this.apiProxy.records.deleteById(idOrIds, transaction);
-    }
-}
-exports.Model = Model;

package/cjs/sdk/record.js

@@ -1,122 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DBRecordsArrayInstance = exports.DBRecordInstance = exports.DBRecordDraft = exports.DBRecordsBatchDraft = void 0;
-const rest_api_proxy_js_1 = require("../api/rest-api-proxy.js");
-const utils_js_1 = require("./utils.js");
-class DBRecordsBatchDraft {
-    constructor({ label, options = {
-        returnResult: true,
-        suggestTypes: true
-    }, payload }) {
-        this.label = label;
-        this.options = options;
-        this.payload = payload;
-    }
-    toJson() {
-        return {
-            label: this.label,
-            options: this.options,
-            payload: this.payload
-        };
-    }
-}
-exports.DBRecordsBatchDraft = DBRecordsBatchDraft;
-class DBRecordDraft {
-    constructor({ label, properties = [] }) {
-        this.label = label;
-        this.properties = properties;
-    }
-    toJson() {
-        return {
-            label: this.label,
-            properties: this.properties
-        };
-    }
-}
-exports.DBRecordDraft = DBRecordDraft;
-class DBRecordInstance extends rest_api_proxy_js_1.RestApiProxy {
-    constructor(data) {
-        super();
-        this.data = data;
-    }
-    get id() {
-        try {
-            return this.data.__id;
-        }
-        catch (_a) {
-            throw new Error(`DBRecordInstance: Unable to access 'id'. The Record data is undefined.`);
-        }
-    }
-    get label() {
-        try {
-            return this.data.__label;
-        }
-        catch (_a) {
-            throw new Error(`DBRecordInstance: Unable to access 'label'. The Record data is undefined.`);
-        }
-    }
-    get proptypes() {
-        try {
-            return this.data.__proptypes;
-        }
-        catch (_a) {
-            throw new Error(`DBRecordInstance: Unable to access 'proptypes'. The Record data' is undefined.`);
-        }
-    }
-    get date() {
-        try {
-            return (0, utils_js_1.idToDate)(this.data.__id);
-        }
-        catch (_a) {
-            throw new Error(`DBRecordInstance: Unable to access 'date'. The Record data is undefined.`);
-        }
-    }
-    get timestamp() {
-        try {
-            return (0, utils_js_1.idToTimestamp)(this.data.__id);
-        }
-        catch (_a) {
-            throw new Error(`DBRecordInstance: Unable to access 'timestamp'. The Record data is undefined.`);
-        }
-    }
-    async delete(transaction) {
-        if (!this.data) {
-            throw new Error('DBRecordInstance: Unable to delete Record. The Record data is undefined.');
-        }
-        return await this.apiProxy.records.deleteById(this.data.__id, transaction);
-    }
-    async update(partialData, transaction) {
-        if (!this.data) {
-            throw new Error('DBRecordInstance: Unable to update Record. The Record data is undefined.');
-        }
-        return this.apiProxy.records.update(this.data.__id, partialData, transaction);
-    }
-    async set(data, transaction) {
-        if (!this.data) {
-            throw new Error('DBRecordInstance: Unable to set. The Record data is undefined.');
-        }
-        return this.apiProxy.records.set(this.data.__id, data, transaction);
-    }
-    async attach(target, options, transaction) {
-        if (!this.data) {
-            throw new Error('DBRecordInstance: Unable to attach Record. The Record data is undefined.');
-        }
-        return this.apiProxy.records.attach(this.data.__id, target, options, transaction);
-    }
-    async detach(target, options, transaction) {
-        if (!this.data) {
-            throw new Error('DBRecordInstance: Unable to detach Record. The Record data is undefined.');
-        }
-        return this.apiProxy.records.detach(this.data.__id, target, options, transaction);
-    }
-}
-exports.DBRecordInstance = DBRecordInstance;
-class DBRecordsArrayInstance extends rest_api_proxy_js_1.RestApiProxy {
-    constructor(data, total, searchParams) {
-        super();
-        this.data = data;
-        this.total = total;
-        this.searchParams = searchParams;
-    }
-}
-exports.DBRecordsArrayInstance = DBRecordsArrayInstance;

package/cjs/sdk/sdk.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initSDK = void 0;
-const api_js_1 = require("../api/api.js");
-const constants_js_1 = require("../common/constants.js");
-const record_js_1 = require("./record.js");
-const utils_js_1 = require("./utils.js");
-const initSDK = (httpClient) => {
-    class RushDB extends api_js_1.RestAPI {
-        constructor(token, config) {
-            var _a;
-            const props = (0, utils_js_1.parseConfig)(config);
-            super(token, Object.assign(Object.assign({}, props), { httpClient: (_a = props.httpClient) !== null && _a !== void 0 ? _a : httpClient }));
-            this.state = {
-                debug: false,
-                timeout: (0, utils_js_1.validateInteger)('timeout', props.timeout, constants_js_1.DEFAULT_TIMEOUT),
-                token
-            };
-            this.models = new Map();
-            RushDB.instance = this;
-        }
-        static getInstance() {
-            return RushDB.instance;
-        }
-        registerModel(model) {
-            const label = model.getLabel();
-            // Inject the API into the model
-            model.init(this);
-            this.models.set(label, model);
-            return model; //as unknown as Model<T['schema']> & Omit<RestAPI, 'find'>
-        }
-        getModels() {
-            return this.models;
-        }
-        getModel(label) {
-            return this.models.get(label);
-        }
-        toInstance(record) {
-            const result = new record_js_1.DBRecordInstance(record);
-            result.init(this);
-            return result;
-        }
-    }
-    return RushDB;
-};
-exports.initSDK = initSDK;

package/cjs/sdk/transaction.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Transaction = void 0;
-const rest_api_proxy_js_1 = require("../api/rest-api-proxy.js");
-class Transaction extends rest_api_proxy_js_1.RestApiProxy {
-    constructor(id) {
-        super();
-        this.id = id;
-    }
-    async rollback() {
-        return await this.apiProxy.tx.rollback(this.id);
-    }
-    async commit() {
-        return await this.apiProxy.tx.commit(this.id);
-    }
-}
-exports.Transaction = Transaction;

package/cjs/sdk/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/sdk/utils.js

@@ -1,103 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseConfig = exports.pickUniqFieldsFromRecords = exports.pickUniqFieldsFromRecord = exports.mergeDefaultsWithPayload = void 0;
-exports.validateInteger = validateInteger;
-exports.idToTimestamp = idToTimestamp;
-exports.idToDate = idToDate;
-const utils_js_1 = require("../common/utils.js");
-const constants_js_1 = require("./constants.js");
-const errors_js_1 = require("./errors.js");
-const mergeDefaultsWithPayload = async (schema, payload) => {
-    const defaultPromises = Object.entries(schema).map(async ([key, prop]) => {
-        if (prop.default &&
-            typeof prop.default !== 'undefined' &&
-            typeof payload[key] === 'undefined') {
-            return {
-                key,
-                value: typeof prop.default === 'function' ? await prop.default() : prop.default
-            };
-        }
-        else {
-            return { key, value: undefined };
-        }
-    });
-    const resolvedDefaults = await Promise.all(defaultPromises);
-    const defaults = resolvedDefaults.reduce((acc, { key, value }) => {
-        if (value !== undefined) {
-            acc[key] = value;
-        }
-        return acc;
-    }, {});
-    return Object.assign(Object.assign({}, defaults), payload);
-};
-exports.mergeDefaultsWithPayload = mergeDefaultsWithPayload;
-const pickUniqFieldsFromRecord = (schema, data) => {
-    return Object.entries(data)
-        .filter(([key]) => { var _a; return (_a = schema[key]) === null || _a === void 0 ? void 0 : _a.uniq; })
-        .reduce((acc, [key, value]) => {
-        if (key in schema) {
-            acc[key] = value;
-        }
-        return acc;
-    }, {});
-};
-exports.pickUniqFieldsFromRecord = pickUniqFieldsFromRecord;
-const pickUniqFieldsFromRecords = (data, schema, label) => {
-    const properties = {};
-    const uniqFields = Object.entries(schema)
-        .filter(([_, config]) => config.uniq)
-        .reduce((acc, [key]) => {
-        acc[key] = true;
-        return acc;
-    }, {});
-    data.forEach((record) => {
-        Object.entries(record).forEach(([key, value]) => {
-            if (key in uniqFields) {
-                if (properties[key]) {
-                    if (properties[key].includes(value)) {
-                        throw new errors_js_1.UniquenessError(label, { [key]: value });
-                    }
-                    properties[key] = [...properties[key], value];
-                }
-                else {
-                    properties[key] = [value];
-                }
-            }
-        });
-    });
-    return properties;
-};
-exports.pickUniqFieldsFromRecords = pickUniqFieldsFromRecords;
-const parseConfig = (config) => {
-    if (!config) {
-        return {};
-    }
-    if (!(0, utils_js_1.isObject)(config)) {
-        throw new Error('Config must be an object');
-    }
-    const values = Object.keys(config).filter((value) => !constants_js_1.ALLOWED_CONFIG_PROPERTIES.includes(value));
-    if (values.length > 0) {
-        throw new Error(`Config object may only contain the following: ${constants_js_1.ALLOWED_CONFIG_PROPERTIES.join(', ')}`);
-    }
-    return config;
-};
-exports.parseConfig = parseConfig;
-function validateInteger(name, n, defaultVal) {
-    if (!Number.isInteger(n)) {
-        if (defaultVal !== undefined) {
-            return defaultVal;
-        }
-        else {
-            throw new Error(`${name} must be an integer`);
-        }
-    }
-    return n;
-}
-function idToTimestamp(id) {
-    const parts = id.split('-');
-    const highBitsHex = parts[0] + parts[1].slice(0, 4);
-    return parseInt(highBitsHex, 16);
-}
-function idToDate(id) {
-    return new Date(idToTimestamp(id));
-}

package/cjs/types/expressions.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/types/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./value.js"), exports);
-__exportStar(require("./query.js"), exports);
-__exportStar(require("./utils.js"), exports);
-__exportStar(require("./schema.js"), exports);
-__exportStar(require("./expressions.js"), exports);

package/cjs/types/query.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/types/schema.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/types/utils.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/types/value.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });