@rushdb/javascript-sdk 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @rushdb/javascript-sdk
+
+## 0.1.0
+
+### Minor Changes
+
+- 0fc7f66: Initial release before migrating to RushDB domain

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RushDB
+
+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,119 @@
+<div align="center">
+
+![RushDB Logo](https://raw.githubusercontent.com/rush-db/rushdb/main/rushdb-logo.svg)
+
+# RushDB SDK
+
+> The RushDB.com SDK for JavaScript and TypeScript
+
+[![NPM Version](https://img.shields.io/npm/v/%40collect.so%2Fjavascript-sdk)](https://www.npmjs.com/package/@rushdb/javascript-sdk)
+[![License](https://img.shields.io/badge/License-MIT-blue)](#license "Go to license section")
+
+![NPM Downloads](https://img.shields.io/npm/dw/%40collect.so%2Fjavascript-sdk)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40collect.so%2Fjavascript-sdk)
+
+
+[![Made with Node](https://img.shields.io/badge/dynamic/json?label=node&query=%24.engines%5B%22node%22%5D&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcollect-so%2Fcollect%2Fmaster%2Fpackage.json)](https://nodejs.org "Go to Node.js homepage")
+[![Package - Typescript](https://img.shields.io/github/package-json/dependency-version/collect-so/collect/dev/typescript?logo=typescript&logoColor=white)](https://www.npmjs.com/package/typescript "Go to TypeScript on NPM")
+
+[Homepage](https://rushdb.com) — [Blog](https://rushdb.com/blog) — [Platform](https://app.rushdb.com) — [Docs](https://docs.rushdb.com) — [Examples](https://github.com/rush-db/rushdb/examples)
+</div>
+
+## Features
+
+---
+- **Automatic Type Inference**: Enjoy seamless type safety with automatic TypeScript inference.
+- **Isomorphic Architecture**: Fully compatible with both server and browser environments.
+- **Zero Dependencies**: Lightweight and efficient with no external dependencies.
+- **No Configuration Needed**: Plug-and-play design requires no setup or configuration.
+
+
+## Installation
+
+---
+NPM:
+```bash
+npm install @rushdb/javascript-sdk
+```
+
+YARN:
+```bash
+yarn add @rushdb/javascript-sdk
+```
+
+PNPM:
+```bash
+pnmp add @rushdb/javascript-sdk
+```
+
+
+## Usage
+
+---
+
+1. **Obtain RushDB API Token**: Grab your API token from the [Dashboard](https://app.rushdb.com).
+2. **Setup RushDB Instance**: Initialize your RushDB instance with obtained token.
+3. **(Optional) Define Data Models**: Tailor your data models to fit your needs.
+4. **Manage Your Data**: Push, link, fetch, and manage your data effortlessly.
+
+### TLDR;
+```ts
+/* ./your-app/src/db.ts */
+
+import RushDB, { Model } from '@rushdb/javascript-sdk'
+
+// Setup RushDB instance
+const db = new RushDB("API_TOKEN")
+
+// Optionaly define Model
+export const UserRepo = new Model(
+    'USER',
+    {
+        name: { type: 'string' },
+        email: { type: 'string', uniq: true },
+        verified: { type: 'boolean', default: false },
+        hobbies: { type: 'string', multiple: true, requiered: false },
+        rating: { type: 'number', default: 1 },
+        created: { type: 'datetime', default: () => new Date().toISOString() },
+        password: { type: 'string' }
+    },
+    db
+)
+
+// Create new Record
+const newUser = await UserRepo.create({
+    name: "John Galt",
+    email: 'john.g@example.com',
+    hobbies: ['Programming', 'Hiking'],
+    password: '********'
+})
+
+// Find Records by specific criteria
+const matchedUsers = await UserRepo.find({
+    where: {
+        email: { $ne: 'john.g@example.com' },
+        hobbies: { $in: ['Hiking'] },
+        rating: { $gte: 1.5 }
+    }
+})
+```
+
+<div align="center">
+<b>You're Awesome!</b>  🚀
+</div>
+
+---
+
+<div align="center" style="margin-top: 20px">
+
+> Check the [Docs](https://docs.rushdb.com) and [Examples Repository](https://github.com/collect-so/examples) to learn more 🤓
+
+
+</div>
+
+
+## Contributing
+
+---
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+

package/cjs/api/api.js

@@ -0,0 +1,328 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestAPI = void 0;
+const utils_js_1 = require("../common/utils.js");
+const index_js_1 = require("../network/index.js");
+const errors_js_1 = require("../sdk/errors.js");
+const record_js_1 = require("../sdk/record.js");
+const transaction_js_1 = require("../sdk/transaction.js");
+const create_api_js_1 = require("./create-api.js");
+const utils_js_2 = require("./utils.js");
+class RestAPI {
+    constructor(token, config) {
+        this.relations = {
+            find: async ({ pagination, search, transaction }) => {
+                const { searchParams } = (0, utils_js_2.createSearchParams)(search);
+                const tx = (0, utils_js_2.pickTransaction)(transaction);
+                return await this.api.relations.find(searchParams, pagination, tx);
+            }
+        };
+        this.properties = {
+            delete: async (id, transaction) => {
+                var _a;
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.properties.delete(id, transaction);
+            },
+            find: async (searchParams, transaction) => {
+                var _a;
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.properties.find(searchParams, transaction);
+            },
+            findById: async (id, transaction) => {
+                var _a;
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.properties.findById(id, transaction);
+            },
+            values: async (id, transaction) => {
+                var _a;
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.properties.values(id, transaction);
+            }
+        };
+        this.labels = {
+            find: async (searchParams, transaction) => {
+                return this.api.labels.find(searchParams, transaction);
+            }
+        };
+        this.tx = {
+            begin: async (config) => {
+                var _a;
+                const transaction = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.tx.begin(config));
+                const result = new transaction_js_1.Transaction(transaction.data.id);
+                result.init(this);
+                return result;
+            },
+            commit: async (id) => { var _a; return (_a = this.api) === null || _a === void 0 ? void 0 : _a.tx.commit(id); },
+            get: async (id) => {
+                var _a;
+                const transaction = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.tx.get(id));
+                const result = new transaction_js_1.Transaction(transaction.data.id);
+                result.init(this);
+                return result;
+            },
+            rollback: async (id) => { var _a; return (_a = this.api) === null || _a === void 0 ? void 0 : _a.tx.commit(id); }
+        };
+        this.fetcher = null;
+        if (config === null || config === void 0 ? void 0 : config.httpClient) {
+            const url = (0, utils_js_2.buildUrl)(config);
+            this.fetcher = (0, index_js_1.createFetcher)({
+                httpClient: config.httpClient,
+                token,
+                url
+            });
+        }
+        this.api = (0, create_api_js_1.createApi)(this.fetcher);
+        this.records = {
+            attach: async (sourceId, target, options, transaction) => {
+                var _a, _b;
+                // target is MaybeArray<DBRecordInstance>
+                if (target instanceof record_js_1.DBRecordInstance) {
+                    const id = (_a = target.data) === null || _a === void 0 ? void 0 : _a.__id;
+                    if (id) {
+                        return await this.api.records.attach(sourceId, id, options, transaction);
+                    }
+                    else {
+                        throw new errors_js_1.EmptyTargetError('Attach error: Target id is empty');
+                    }
+                }
+                else if ((0, utils_js_1.isArray)(target) && target.every((r) => r instanceof record_js_1.DBRecordInstance)) {
+                    const ids = target.map((r) => { var _a; return (_a = r.data) === null || _a === void 0 ? void 0 : _a.__id; }).filter(utils_js_1.toBoolean);
+                    if (ids.length) {
+                        return await this.api.records.attach(sourceId, ids, options, transaction);
+                    }
+                    else {
+                        throw new errors_js_1.EmptyTargetError('Attach error: Target ids are empty');
+                    }
+                }
+                // target is DBRecordsArrayInstance
+                else if (target instanceof record_js_1.DBRecordsArrayInstance) {
+                    const ids = (_b = target.data) === null || _b === void 0 ? void 0 : _b.map((r) => r.__id).filter(Boolean);
+                    if (ids === null || ids === void 0 ? void 0 : ids.length) {
+                        return await this.api.records.attach(sourceId, ids, options, transaction);
+                    }
+                    else {
+                        throw new errors_js_1.EmptyTargetError('Attach error: Target ids are empty');
+                    }
+                }
+                // target is MaybeArray<DBRecord>
+                else if ((0, utils_js_1.isObject)(target) && '__id' in target) {
+                    return await this.api.records.attach(sourceId, target.__id, options, transaction);
+                }
+                else if ((0, utils_js_1.isArray)(target) && target.every((r) => (0, utils_js_1.isObject)(r) && '__id' in r)) {
+                    const ids = target === null || target === void 0 ? void 0 : target.map((r) => r.__id).filter(Boolean);
+                    if (ids === null || ids === void 0 ? void 0 : ids.length) {
+                        return await this.api.records.attach(sourceId, ids, options, transaction);
+                    }
+                    else {
+                        throw new errors_js_1.EmptyTargetError('Attach error: Target ids are empty');
+                    }
+                }
+                // target is MaybeArray<string>
+                else {
+                    return await this.api.records.attach(sourceId, target, options, transaction);
+                }
+            },
+            create: async (labelOrData, maybeDataOrTransaction, transaction) => {
+                var _a, _b;
+                let response;
+                if (labelOrData instanceof record_js_1.DBRecordDraft) {
+                    response = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.records.create(labelOrData, (0, utils_js_2.pickTransaction)(maybeDataOrTransaction)));
+                }
+                if (!response && (0, utils_js_1.isString)(labelOrData)) {
+                    if ((0, utils_js_1.isObjectFlat)(maybeDataOrTransaction)) {
+                        const normalizedRecord = (0, utils_js_2.normalizeRecord)({
+                            label: labelOrData,
+                            payload: maybeDataOrTransaction
+                        });
+                        response = await ((_b = this.api) === null || _b === void 0 ? void 0 : _b.records.create(new record_js_1.DBRecordDraft(normalizedRecord), transaction));
+                    }
+                    else if ((0, utils_js_1.isObject)(maybeDataOrTransaction)) {
+                        throw Error('Provided data is not a flat object. Consider to use `createMany` method.');
+                    }
+                }
+                if ((response === null || response === void 0 ? void 0 : response.success) && (response === null || response === void 0 ? void 0 : response.data)) {
+                    const result = new record_js_1.DBRecordInstance(response.data);
+                    result.init(this);
+                    return result;
+                }
+                return new record_js_1.DBRecordInstance();
+            },
+            createMany: async (labelOrData, maybeDataOrTransaction, transaction) => {
+                var _a, _b;
+                let response;
+                if (labelOrData instanceof record_js_1.DBRecordsBatchDraft) {
+                    response = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.records.createMany(labelOrData, (0, utils_js_2.pickTransaction)(maybeDataOrTransaction)));
+                }
+                if (!response &&
+                    (0, utils_js_1.isString)(labelOrData) &&
+                    ((0, utils_js_1.isArray)(maybeDataOrTransaction) || (0, utils_js_1.isObject)(maybeDataOrTransaction))) {
+                    const data = new record_js_1.DBRecordsBatchDraft({
+                        label: labelOrData,
+                        payload: maybeDataOrTransaction
+                    });
+                    response = await ((_b = this.api) === null || _b === void 0 ? void 0 : _b.records.createMany(data, transaction));
+                }
+                if ((response === null || response === void 0 ? void 0 : response.success) && (response === null || response === void 0 ? void 0 : response.data)) {
+                    const result = new record_js_1.DBRecordsArrayInstance(response.data, response.total);
+                    result.init(this);
+                    return result;
+                }
+                return new record_js_1.DBRecordsArrayInstance([]);
+            },
+            delete: async (searchParams, transaction) => {
+                var _a;
+                if ((0, utils_js_1.isEmptyObject)(searchParams.where)) {
+                    throw new errors_js_1.EmptyTargetError(`You must specify criteria to delete records. Empty criteria are not allowed. If this was intentional, use the Dashboard instead.`);
+                }
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.records.delete(searchParams, transaction);
+            },
+            deleteById: async (idOrIds, transaction) => {
+                var _a;
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.records.deleteById(idOrIds, transaction);
+            },
+            detach: async (sourceId, target, options, transaction) => {
+                var _a, _b;
+                // target is MaybeArray<DBRecordInstance>
+                if (target instanceof record_js_1.DBRecordInstance) {
+                    const id = (_a = target.data) === null || _a === void 0 ? void 0 : _a.__id;
+                    if (id) {
+                        return await this.api.records.detach(sourceId, id, options, transaction);
+                    }
+                    else {
+                        throw new errors_js_1.EmptyTargetError('Detach error: Target id is empty');
+                    }
+                }
+                else if ((0, utils_js_1.isArray)(target) && target.every((r) => r instanceof record_js_1.DBRecordInstance)) {
+                    const ids = target.map((r) => { var _a; return (_a = r.data) === null || _a === void 0 ? void 0 : _a.__id; }).filter(Boolean);
+                    if (ids.length) {
+                        return await this.api.records.detach(sourceId, ids, options, transaction);
+                    }
+                    else {
+                        throw new errors_js_1.EmptyTargetError('Detach error: Target ids are empty');
+                    }
+                }
+                // target is DBRecordsArrayInstance
+                else if (target instanceof record_js_1.DBRecordsArrayInstance) {
+                    const ids = (_b = target.data) === null || _b === void 0 ? void 0 : _b.map((r) => r.__id).filter(Boolean);
+                    if (ids === null || ids === void 0 ? void 0 : ids.length) {
+                        return await this.api.records.detach(sourceId, ids, options, transaction);
+                    }
+                    else {
+                        throw new errors_js_1.EmptyTargetError('Detach error: Target ids are empty');
+                    }
+                }
+                // target is MaybeArray<DBRecord>
+                else if ((0, utils_js_1.isObject)(target) && '__id' in target) {
+                    return await this.api.records.detach(sourceId, target.__id, options, transaction);
+                }
+                else if ((0, utils_js_1.isArray)(target) && target.every((r) => (0, utils_js_1.isObject)(r) && '__id' in r)) {
+                    const ids = target === null || target === void 0 ? void 0 : target.map((r) => r.__id).filter(Boolean);
+                    if (ids === null || ids === void 0 ? void 0 : ids.length) {
+                        return await this.api.records.detach(sourceId, ids, options, transaction);
+                    }
+                    else {
+                        throw new errors_js_1.EmptyTargetError('Detach error: Target ids are empty');
+                    }
+                }
+                // target is MaybeArray<string>
+                else {
+                    return await this.api.records.detach(sourceId, target, options, transaction);
+                }
+            },
+            export: async (searchParams, transaction) => {
+                var _a;
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.records.export(searchParams, transaction);
+            },
+            find: async (labelOrSearchParams, searchParamsOrTransaction, transaction) => {
+                var _a;
+                const isTransactionParam = (0, utils_js_2.isTransaction)(searchParamsOrTransaction);
+                const { id, searchParams } = (0, utils_js_2.createSearchParams)(labelOrSearchParams, searchParamsOrTransaction);
+                const tx = isTransactionParam ? searchParamsOrTransaction : transaction;
+                const response = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.records.find({ id, searchParams }, tx));
+                const result = new record_js_1.DBRecordsArrayInstance(response.data, response.total, searchParamsOrTransaction);
+                result.init(this);
+                return result;
+            },
+            findById: async (idOrIds, transaction) => {
+                var _a, _b;
+                if ((0, utils_js_1.isArray)(idOrIds)) {
+                    const response = (await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.records.findById(idOrIds, transaction)));
+                    const result = new record_js_1.DBRecordsArrayInstance(response.data, response.total);
+                    result.init(this);
+                    return result;
+                }
+                else {
+                    const response = (await ((_b = this.api) === null || _b === void 0 ? void 0 : _b.records.findById(idOrIds, transaction)));
+                    const result = new record_js_1.DBRecordInstance(response.data);
+                    result.init(this);
+                    return result;
+                }
+            },
+            findOne: async (labelOrSearchParams, searchParamsOrTransaction, transaction) => {
+                var _a;
+                const isTransactionParam = (0, utils_js_2.isTransaction)(searchParamsOrTransaction);
+                const { searchParams } = (0, utils_js_2.createSearchParams)(labelOrSearchParams, searchParamsOrTransaction);
+                const tx = isTransactionParam ? searchParamsOrTransaction : transaction;
+                const response = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.records.findOne(searchParams, tx));
+                const result = new record_js_1.DBRecordInstance(response.data, searchParamsOrTransaction);
+                result.init(this);
+                return result;
+            },
+            findUniq: async (labelOrSearchParams, searchParamsOrTransaction, transaction) => {
+                var _a;
+                const isTransactionParam = (0, utils_js_2.isTransaction)(searchParamsOrTransaction);
+                const { searchParams } = (0, utils_js_2.createSearchParams)(labelOrSearchParams, searchParamsOrTransaction);
+                const tx = isTransactionParam ? searchParamsOrTransaction : transaction;
+                const response = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.records.findUniq(searchParams, tx));
+                const result = new record_js_1.DBRecordInstance(response.data, searchParamsOrTransaction);
+                result.init(this);
+                return result;
+            },
+            properties: async (id, transaction) => {
+                var _a;
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.records.properties(id, transaction);
+            },
+            relations: async (id, transaction) => {
+                return await this.api.records.relations(id, transaction);
+            },
+            set: async (id, data, transaction) => {
+                var _a, _b;
+                let response;
+                if (data instanceof record_js_1.DBRecordDraft) {
+                    response = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.records.set(id, data, transaction));
+                }
+                else if ((0, utils_js_1.isObjectFlat)(data)) {
+                    const properties = (0, utils_js_2.prepareProperties)(data);
+                    response = await ((_b = this.api) === null || _b === void 0 ? void 0 : _b.records.set(id, new record_js_1.DBRecordDraft({ properties }), transaction));
+                }
+                else if ((0, utils_js_1.isObject)(data)) {
+                    throw Error('Provided data is not a flat object. Consider to use `createMany` method.');
+                }
+                if ((response === null || response === void 0 ? void 0 : response.success) && (response === null || response === void 0 ? void 0 : response.data)) {
+                    const result = new record_js_1.DBRecordInstance(response.data);
+                    result.init(this);
+                    return result;
+                }
+                return new record_js_1.DBRecordInstance();
+            },
+            update: async (id, data, transaction) => {
+                var _a, _b;
+                let response;
+                if (data instanceof record_js_1.DBRecordDraft) {
+                    response = await ((_a = this.api) === null || _a === void 0 ? void 0 : _a.records.update(id, data, transaction));
+                }
+                else if ((0, utils_js_1.isObjectFlat)(data)) {
+                    const properties = (0, utils_js_2.prepareProperties)(data);
+                    const recordDraft = new record_js_1.DBRecordDraft({ properties });
+                    response = await ((_b = this.api) === null || _b === void 0 ? void 0 : _b.records.update(id, recordDraft, transaction));
+                }
+                else if ((0, utils_js_1.isObject)(data)) {
+                    throw Error('Provided data is not a flat object. Consider to use `createMany` method.');
+                }
+                if ((response === null || response === void 0 ? void 0 : response.success) && (response === null || response === void 0 ? void 0 : response.data)) {
+                    const result = new record_js_1.DBRecordInstance(response.data);
+                    result.init(this);
+                    return result;
+                }
+                return new record_js_1.DBRecordInstance();
+            }
+        };
+    }
+}
+exports.RestAPI = RestAPI;

package/cjs/api/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_BASE_PATH = exports.DEFAULT_PROTOCOL = exports.DEFAULT_PORT = exports.DEFAULT_HOST = void 0;
+exports.DEFAULT_HOST = 'api.rushdb.com';
+exports.DEFAULT_PORT = 443;
+exports.DEFAULT_PROTOCOL = 'https';
+exports.DEFAULT_BASE_PATH = '/api/v1';