@rushdb/javascript-sdk 0.9.2 → 0.9.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @rushdb/javascript-sdk
 
+## 0.9.4
+
+### Patch Changes
+
+- 09e2d57: Update docs, minor fixes and cleanups
+
+## 0.9.3
+
+### Patch Changes
+
+- 22ce867: billing setup update for dev/prod envs
+
 ## 0.9.2
 
 ### Patch Changes

package/cjs/api/api.js

@@ -32,7 +32,7 @@ class RestAPI {
             },
             values: async (id, transaction) => {
                 var _a;
-                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.properties.values(id, transaction);
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.properties.values(id, {}, transaction);
             }
         };
         this.labels = {
@@ -260,7 +260,7 @@ class RestAPI {
                 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);
+                const result = new record_js_1.DBRecordInstance(response.data);
                 result.init(this);
                 return result;
             },
@@ -270,7 +270,7 @@ class RestAPI {
                 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);
+                const result = new record_js_1.DBRecordInstance(response.data);
                 result.init(this);
                 return result;
             },

package/cjs/api/create-api.js

@@ -58,15 +58,25 @@ const createApi = (fetcher, logger) => ({
         // updateValues: (id: string, transaction?: Transaction | string) => {
         //   // @TODO
         // },
-        values: (id, transaction) => {
+        values: (id, options, transaction) => {
             const txId = (0, utils_js_2.pickTransactionId)(transaction);
             const path = `/properties/${id}/values`;
+            const { sort, skip, limit } = options !== null && options !== void 0 ? options : {};
+            const queryParams = new URLSearchParams();
+            if (sort)
+                queryParams.append('sort', sort);
+            if (skip !== undefined)
+                queryParams.append('skip', skip.toString());
+            if (limit !== undefined)
+                queryParams.append('limit', limit.toString());
+            const queryString = queryParams.toString();
+            const fullPath = queryString ? `${path}?${queryString}` : path;
             const payload = {
                 headers: Object.assign({}, (0, utils_js_2.buildTransactionHeader)(txId)),
                 method: 'GET'
             };
-            logger === null || logger === void 0 ? void 0 : logger(Object.assign({ path }, payload));
-            return fetcher(path, payload);
+            logger === null || logger === void 0 ? void 0 : logger(Object.assign({ path: fullPath }, payload));
+            return fetcher(fullPath, payload);
         }
     },
     records: {

package/cjs/sdk/record.js

@@ -35,41 +35,79 @@ class DBRecordDraft {
 }
 exports.DBRecordDraft = DBRecordDraft;
 class DBRecordInstance extends rest_api_proxy_js_1.RestApiProxy {
-    constructor(data, searchParams) {
+    constructor(data) {
         super();
         this.data = data;
-        this.searchParams = searchParams;
     }
-    __date() {
-        return (0, utils_js_1.idToDate)(this.data.__id);
+    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.`);
+        }
     }
-    __timestamp() {
-        return (0, utils_js_1.idToTimestamp)(this.data.__id);
+    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) {
-            return await this.apiProxy.records.deleteById(this.data.__id, 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) {
-            return this.apiProxy.records.update(this.data.__id, 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) {
-            return this.apiProxy.records.set(this.data.__id, 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) {
-            return this.apiProxy.records.attach(this.data.__id, 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) {
-            return this.apiProxy.records.detach(this.data.__id, 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;

package/esm/api/api.js

@@ -29,7 +29,7 @@ export class RestAPI {
             },
             values: async (id, transaction) => {
                 var _a;
-                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.properties.values(id, transaction);
+                return (_a = this.api) === null || _a === void 0 ? void 0 : _a.properties.values(id, {}, transaction);
             }
         };
         this.labels = {
@@ -257,7 +257,7 @@ export class RestAPI {
                 const { searchParams } = 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 DBRecordInstance(response.data, searchParamsOrTransaction);
+                const result = new DBRecordInstance(response.data);
                 result.init(this);
                 return result;
             },
@@ -267,7 +267,7 @@ export class RestAPI {
                 const { searchParams } = 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 DBRecordInstance(response.data, searchParamsOrTransaction);
+                const result = new DBRecordInstance(response.data);
                 result.init(this);
                 return result;
             },

package/esm/api/create-api.js

@@ -55,15 +55,25 @@ export const createApi = (fetcher, logger) => ({
         // updateValues: (id: string, transaction?: Transaction | string) => {
         //   // @TODO
         // },
-        values: (id, transaction) => {
+        values: (id, options, transaction) => {
             const txId = pickTransactionId(transaction);
             const path = `/properties/${id}/values`;
+            const { sort, skip, limit } = options !== null && options !== void 0 ? options : {};
+            const queryParams = new URLSearchParams();
+            if (sort)
+                queryParams.append('sort', sort);
+            if (skip !== undefined)
+                queryParams.append('skip', skip.toString());
+            if (limit !== undefined)
+                queryParams.append('limit', limit.toString());
+            const queryString = queryParams.toString();
+            const fullPath = queryString ? `${path}?${queryString}` : path;
             const payload = {
                 headers: Object.assign({}, buildTransactionHeader(txId)),
                 method: 'GET'
             };
-            logger === null || logger === void 0 ? void 0 : logger(Object.assign({ path }, payload));
-            return fetcher(path, payload);
+            logger === null || logger === void 0 ? void 0 : logger(Object.assign({ path: fullPath }, payload));
+            return fetcher(fullPath, payload);
         }
     },
     records: {

package/esm/sdk/record.js

@@ -30,41 +30,79 @@ export class DBRecordDraft {
     }
 }
 export class DBRecordInstance extends RestApiProxy {
-    constructor(data, searchParams) {
+    constructor(data) {
         super();
         this.data = data;
-        this.searchParams = searchParams;
     }
-    __date() {
-        return idToDate(this.data.__id);
+    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.`);
+        }
     }
-    __timestamp() {
-        return idToTimestamp(this.data.__id);
+    get date() {
+        try {
+            return idToDate(this.data.__id);
+        }
+        catch (_a) {
+            throw new Error(`DBRecordInstance: Unable to access 'date'. The Record data is undefined.`);
+        }
+    }
+    get timestamp() {
+        try {
+            return 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) {
-            return await this.apiProxy.records.deleteById(this.data.__id, 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) {
-            return this.apiProxy.records.update(this.data.__id, 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) {
-            return this.apiProxy.records.set(this.data.__id, 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) {
-            return this.apiProxy.records.attach(this.data.__id, 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) {
-            return this.apiProxy.records.detach(this.data.__id, 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);
     }
 }
 export class DBRecordsArrayInstance extends RestApiProxy {

package/package.json

@@ -12,7 +12,7 @@
     "rushdb"
   ],
   "license": "Apache-2.0",
-  "version": "0.9.2",
+  "version": "0.9.4",
   "type": "module",
   "main": "cjs/index.cjs.node.js",
   "types": "types/index.d.ts",

package/types/api/create-api.d.ts

@@ -1,7 +1,7 @@
 import type { createFetcher } from '../network/index.js';
 import type { DBRecord, DBRecordTarget, Relation, RelationDetachOptions, RelationOptions } from '../sdk/record.js';
 import type { Transaction } from '../sdk/transaction.js';
-import type { Property, PropertyValuesData, SearchQuery, Schema, MaybeArray } from '../types/index.js';
+import type { Property, PropertyValuesData, SearchQuery, Schema, MaybeArray, OrderDirection } from '../types/index.js';
 import type { ApiResponse } from './types.js';
 import { DBRecordsBatchDraft, DBRecordDraft } from '../sdk/record.js';
 import type { Logger } from '../sdk/types.js';
@@ -13,7 +13,11 @@ export declare const createApi: (fetcher: ReturnType<typeof createFetcher>, logg
         delete: (id: string, transaction?: Transaction | string) => Promise<ApiResponse<Property>>;
         find: <S extends Schema = any>(searchParams: SearchQuery<S>, transaction?: Transaction | string) => Promise<ApiResponse<Property[]>>;
         findById: (id: string, transaction?: Transaction | string) => Promise<ApiResponse<Property>>;
-        values: (id: string, transaction?: Transaction | string) => Promise<ApiResponse<Property & PropertyValuesData>>;
+        values: (id: string, options?: {
+            sort?: OrderDirection;
+            skip?: number;
+            limit?: number;
+        }, transaction?: Transaction | string) => Promise<ApiResponse<Property & PropertyValuesData>>;
     };
     records: {
         attach(source: DBRecordTarget, idOrIds: MaybeArray<string>, options?: RelationOptions, transaction?: Transaction | string): Promise<ApiResponse<{

package/types/sdk/record.d.ts

@@ -86,21 +86,23 @@ export declare class DBRecordDraft {
 }
 export declare class DBRecordInstance<S extends Schema = Schema> extends RestApiProxy {
     data?: DBRecord<S>;
-    searchParams?: SearchQuery<S>;
-    constructor(data?: DBRecord<S>, searchParams?: SearchQuery<S>);
-    __date(): Date;
-    __timestamp(): number;
+    constructor(data?: DBRecord<S>);
+    get id(): string;
+    get label(): string;
+    get proptypes(): FlattenTypes<FlattenTypes<{ [Key in RequiredKeysRead<S>]: S[Key]["type"]; } & { [Key_1 in OptionalKeysRead<S>]?: S[Key_1]["type"] | undefined; }>> | undefined;
+    get date(): Date;
+    get timestamp(): number;
     delete(transaction?: Transaction | string): Promise<import("../api/types.js").ApiResponse<{
         message: string;
-    }, Record<string, any>> | undefined>;
-    update<S extends Schema = Schema>(partialData: DBRecordDraft | Partial<InferSchemaTypesWrite<S>>, transaction?: Transaction | string): Promise<DBRecordInstance<S> | undefined>;
-    set<S extends Schema = Schema>(data: DBRecordDraft | InferSchemaTypesWrite<S>, transaction?: Transaction | string): Promise<DBRecordInstance<S> | undefined>;
+    }, Record<string, any>>>;
+    update<S extends Schema = Schema>(partialData: DBRecordDraft | Partial<InferSchemaTypesWrite<S>>, transaction?: Transaction | string): Promise<DBRecordInstance<S>>;
+    set<S extends Schema = Schema>(data: DBRecordDraft | InferSchemaTypesWrite<S>, transaction?: Transaction | string): Promise<DBRecordInstance<S>>;
     attach(target: RelationTarget, options?: RelationOptions, transaction?: Transaction | string): Promise<import("../api/types.js").ApiResponse<{
         message: string;
-    }, Record<string, any>> | undefined>;
+    }, Record<string, any>>>;
     detach(target: RelationTarget, options?: RelationDetachOptions, transaction?: Transaction | string): Promise<import("../api/types.js").ApiResponse<{
         message: string;
-    }, Record<string, any>> | undefined>;
+    }, Record<string, any>>>;
 }
 export declare class DBRecordsArrayInstance<S extends Schema = Schema> extends RestApiProxy {
     data?: DBRecord<S>[];

package/types/types/query.d.ts

@@ -36,7 +36,8 @@ export type Expression<S extends Schema = Schema> = IdExpression | (S extends Sc
     [Key in keyof S]?: S[Key] extends MaybeArray<number> ? MaybeLogicalExpression<NumberExpression> : S[Key] extends MaybeArray<boolean> ? MaybeLogicalExpression<BooleanExpression> : S[Key] extends MaybeArray<string> ? MaybeLogicalExpression<DatetimeExpression> | MaybeLogicalExpression<StringExpression> : S[Key] extends MaybeArray<null> ? MaybeLogicalExpression<NullExpression> : LogicalExpression | Partial<PropertyExpression>;
 });
 export type Where<S extends Schema = Schema> = ((Expression<S> & Related) & LogicalGrouping<Expression<S> & Related>) | LogicalGrouping<Expression<S> & Related>;
-export type Order<S extends Schema = Schema> = 'asc' | 'desc' | Partial<Record<keyof S, 'asc' | 'desc'>>;
+export type OrderDirection = 'asc' | 'desc';
+export type Order<S extends Schema = Schema> = OrderDirection | Partial<Record<keyof S, OrderDirection>>;
 export type AggregateCollectFn = {
     alias: string;
     field?: string;