@rushdb/javascript-sdk 1.3.2 → 1.4.0

package/dist/sdk/transaction.d.ts

@@ -1,10 +1,38 @@
-import { RestApiProxy } from '../api/rest-api-proxy.js';
-export declare class Transaction extends RestApiProxy {
+/**
+ * Represents a database transaction that groups multiple operations.
+ * Transactions ensure that a series of operations are executed atomically,
+ * meaning either all operations succeed or none of them are applied.
+ *
+ * Use transactions when you need to perform multiple related operations
+ * that should be treated as a single unit of work. For example, creating
+ * related records, updating multiple records, or performing operations
+ * that need to be rolled back if any part fails.
+ */
+export declare class Transaction {
     readonly id: string;
+    /**
+     * Creates a new Transaction instance.
+     * Typically, you should not create Transaction instances directly.
+     * Instead, use the tx.begin() method from a RushDB instance.
+     *
+     * @param id - The transaction ID provided by the database
+     */
     constructor(id: string);
+    /**
+     * Rolls back (cancels) all operations performed within this transaction.
+     * Use this when an error occurs or when you want to undo changes.
+     *
+     * @returns Promise resolving to the result of the rollback operation
+     */
     rollback(): Promise<import("../index.node.js").ApiResponse<{
         message: string;
     }>>;
+    /**
+     * Commits (applies) all operations performed within this transaction.
+     * This finalizes all changes made within the transaction.
+     *
+     * @returns Promise resolving to the result of the commit operation
+     */
     commit(): Promise<import("../index.node.js").ApiResponse<{
         message: string;
     }>>;

package/dist/sdk/types.d.ts

@@ -10,6 +10,14 @@ export type State = {
     debug: boolean;
     timeout: number;
     token?: string;
+    initialized: boolean;
+    serverSettings?: {
+        selfHosted: boolean;
+        dashboardUrl: string;
+        googleOAuthEnabled: boolean;
+        githubOAuthEnabled: boolean;
+        customDB?: boolean;
+    };
 } & Partial<ApiConnectionConfig>;
 export type Logger = (payload: any) => void;
 export type SDKConfig = {

package/dist/types/schema.d.ts

@@ -1,6 +1,6 @@
-import type { FlattenTypes, MaybePromise } from './utils.js';
+import type { FlattenTypes } from './utils.js';
 import type { DatetimeObject, PropertyType, PropertyValue } from './value.js';
-export type SchemaDefaultValue<T extends PropertyType = PropertyType> = MaybePromise<PropertyValue<T>>;
+export type SchemaDefaultValue<T extends PropertyType = PropertyType> = PropertyValue<T> | (() => PropertyValue<T>) | (() => Promise<PropertyValue<T>>);
 export type SchemaField<T extends PropertyType = PropertyType> = {
     default?: SchemaDefaultValue<T>;
     multiple?: boolean;

package/dist/types/utils.d.ts

@@ -1,5 +1,4 @@
 import type { PropertyValue } from './value';
-export type MaybePromise<T = any> = () => Promise<T> | T;
 export type RequireAtLeastOne<T> = {
     [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
 }[keyof T];

package/package.json

@@ -33,7 +33,7 @@
     "rushdb"
   ],
   "license": "Apache-2.0",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "type": "module",
   "files": [
     "dist"

package/dist/api/rest-api-proxy.d.ts

@@ -1,6 +0,0 @@
-import type { RestAPI } from './api.js';
-export declare class RestApiProxy {
-    protected apiProxy: RestAPI;
-    constructor();
-    init(api: RestAPI): void;
-}