@ekodb/ekodb-client 0.5.0 → 0.6.0

package/dist/functions.d.ts

@@ -5,12 +5,12 @@ export interface Script {
     label: string;
     name: string;
     description?: string;
-    version: string;
+    version?: string;
     parameters: {
         [key: string]: ParameterDefinition;
     };
     functions: FunctionStageConfig[];
-    tags: string[];
+    tags?: string[];
     created_at?: string;
     updated_at?: string;
 }
@@ -129,6 +129,51 @@ export type FunctionStageConfig = {
     input_field: string;
     output_field: string;
     model?: string;
+} | {
+    type: "FindById";
+    collection: string;
+    record_id: string;
+} | {
+    type: "FindOne";
+    collection: string;
+    key: string;
+    value: any;
+} | {
+    type: "If";
+    condition: ScriptCondition;
+    then_functions: FunctionStageConfig[];
+    else_functions?: FunctionStageConfig[];
+} | {
+    type: "ForEach";
+    functions: FunctionStageConfig[];
+} | {
+    type: "CallFunction";
+    function_label: string;
+    params?: Record<string, any>;
+} | {
+    type: "FindOneAndUpdate";
+    collection: string;
+    record_id: string;
+    updates: Record<string, any>;
+    bypass_ripple?: boolean;
+    ttl?: number;
+} | {
+    type: "UpdateWithAction";
+    collection: string;
+    record_id: string;
+    action: string;
+    field: string;
+    value: any;
+    bypass_ripple?: boolean;
+} | {
+    type: "CreateSavepoint";
+    name: string;
+} | {
+    type: "RollbackToSavepoint";
+    name: string;
+} | {
+    type: "ReleaseSavepoint";
+    name: string;
 };
 export interface ChatMessage {
     role: string;
@@ -148,6 +193,34 @@ export interface SortFieldConfig {
     field: string;
     ascending: boolean;
 }
+export type ScriptCondition = {
+    type: "FieldEquals";
+    field: string;
+    value: any;
+} | {
+    type: "FieldExists";
+    field: string;
+} | {
+    type: "HasRecords";
+} | {
+    type: "CountEquals";
+    count: number;
+} | {
+    type: "CountGreaterThan";
+    count: number;
+} | {
+    type: "CountLessThan";
+    count: number;
+} | {
+    type: "And";
+    conditions: ScriptCondition[];
+} | {
+    type: "Or";
+    conditions: ScriptCondition[];
+} | {
+    type: "Not";
+    condition: ScriptCondition;
+};
 export interface FunctionResult {
     records: Record<string, any>[];
     stats: FunctionStats;
@@ -192,4 +265,14 @@ export declare const Stage: {
     hybridSearch: (collection: string, query_text: string, query_vector?: number[], limit?: number) => FunctionStageConfig;
     chat: (messages: ChatMessage[], model?: string, temperature?: number, max_tokens?: number) => FunctionStageConfig;
     embed: (input_field: string, output_field: string, model?: string) => FunctionStageConfig;
+    findById: (collection: string, record_id: string) => FunctionStageConfig;
+    findOne: (collection: string, key: string, value: any) => FunctionStageConfig;
+    if: (condition: ScriptCondition, thenFunctions: FunctionStageConfig[], elseFunctions?: FunctionStageConfig[]) => FunctionStageConfig;
+    forEach: (functions: FunctionStageConfig[]) => FunctionStageConfig;
+    callFunction: (function_label: string, params?: Record<string, any>) => FunctionStageConfig;
+    findOneAndUpdate: (collection: string, record_id: string, updates: Record<string, any>, bypassRipple?: boolean, ttl?: number) => FunctionStageConfig;
+    updateWithAction: (collection: string, record_id: string, action: string, field: string, value: any, bypassRipple?: boolean) => FunctionStageConfig;
+    createSavepoint: (name: string) => FunctionStageConfig;
+    rollbackToSavepoint: (name: string) => FunctionStageConfig;
+    releaseSavepoint: (name: string) => FunctionStageConfig;
 };

package/dist/functions.js

@@ -151,4 +151,59 @@ exports.Stage = {
         output_field,
         model,
     }),
+    findById: (collection, record_id) => ({
+        type: "FindById",
+        collection,
+        record_id,
+    }),
+    findOne: (collection, key, value) => ({
+        type: "FindOne",
+        collection,
+        key,
+        value,
+    }),
+    if: (condition, thenFunctions, elseFunctions) => ({
+        type: "If",
+        condition,
+        then_functions: thenFunctions,
+        else_functions: elseFunctions,
+    }),
+    forEach: (functions) => ({
+        type: "ForEach",
+        functions,
+    }),
+    callFunction: (function_label, params) => ({
+        type: "CallFunction",
+        function_label,
+        params,
+    }),
+    findOneAndUpdate: (collection, record_id, updates, bypassRipple = false, ttl) => ({
+        type: "FindOneAndUpdate",
+        collection,
+        record_id,
+        updates,
+        bypass_ripple: bypassRipple,
+        ttl,
+    }),
+    updateWithAction: (collection, record_id, action, field, value, bypassRipple = false) => ({
+        type: "UpdateWithAction",
+        collection,
+        record_id,
+        action,
+        field,
+        value,
+        bypass_ripple: bypassRipple,
+    }),
+    createSavepoint: (name) => ({
+        type: "CreateSavepoint",
+        name,
+    }),
+    rollbackToSavepoint: (name) => ({
+        type: "RollbackToSavepoint",
+        name,
+    }),
+    releaseSavepoint: (name) => ({
+        type: "ReleaseSavepoint",
+        name,
+    }),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ekodb/ekodb-client",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Official TypeScript/JavaScript client for ekoDB",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/functions.ts

@@ -6,10 +6,10 @@ export interface Script {
   label: string;
   name: string;
   description?: string;
-  version: string;
+  version?: string;
   parameters: { [key: string]: ParameterDefinition };
   functions: FunctionStageConfig[];
-  tags: string[];
+  tags?: string[];
   created_at?: string;
   updated_at?: string;
 }
@@ -132,6 +132,61 @@ export type FunctionStageConfig =
       input_field: string;
       output_field: string;
       model?: string;
+    }
+  | {
+      type: "FindById";
+      collection: string;
+      record_id: string;
+    }
+  | {
+      type: "FindOne";
+      collection: string;
+      key: string;
+      value: any;
+    }
+  | {
+      type: "If";
+      condition: ScriptCondition;
+      then_functions: FunctionStageConfig[];
+      else_functions?: FunctionStageConfig[];
+    }
+  | {
+      type: "ForEach";
+      functions: FunctionStageConfig[];
+    }
+  | {
+      type: "CallFunction";
+      function_label: string;
+      params?: Record<string, any>;
+    }
+  | {
+      type: "FindOneAndUpdate";
+      collection: string;
+      record_id: string;
+      updates: Record<string, any>;
+      bypass_ripple?: boolean;
+      ttl?: number;
+    }
+  | {
+      type: "UpdateWithAction";
+      collection: string;
+      record_id: string;
+      action: string;
+      field: string;
+      value: any;
+      bypass_ripple?: boolean;
+    }
+  | {
+      type: "CreateSavepoint";
+      name: string;
+    }
+  | {
+      type: "RollbackToSavepoint";
+      name: string;
+    }
+  | {
+      type: "ReleaseSavepoint";
+      name: string;
     };
 
 export interface ChatMessage {
@@ -173,6 +228,17 @@ export interface SortFieldConfig {
   ascending: boolean;
 }
 
+export type ScriptCondition =
+  | { type: "FieldEquals"; field: string; value: any }
+  | { type: "FieldExists"; field: string }
+  | { type: "HasRecords" }
+  | { type: "CountEquals"; count: number }
+  | { type: "CountGreaterThan"; count: number }
+  | { type: "CountLessThan"; count: number }
+  | { type: "And"; conditions: ScriptCondition[] }
+  | { type: "Or"; conditions: ScriptCondition[] }
+  | { type: "Not"; condition: ScriptCondition };
+
 export interface FunctionResult {
   records: Record<string, any>[];
   stats: FunctionStats;
@@ -417,4 +483,93 @@ export const Stage = {
     output_field,
     model,
   }),
+
+  findById: (collection: string, record_id: string): FunctionStageConfig => ({
+    type: "FindById",
+    collection,
+    record_id,
+  }),
+
+  findOne: (
+    collection: string,
+    key: string,
+    value: any,
+  ): FunctionStageConfig => ({
+    type: "FindOne",
+    collection,
+    key,
+    value,
+  }),
+
+  if: (
+    condition: ScriptCondition,
+    thenFunctions: FunctionStageConfig[],
+    elseFunctions?: FunctionStageConfig[],
+  ): FunctionStageConfig => ({
+    type: "If",
+    condition,
+    then_functions: thenFunctions,
+    else_functions: elseFunctions,
+  }),
+
+  forEach: (functions: FunctionStageConfig[]): FunctionStageConfig => ({
+    type: "ForEach",
+    functions,
+  }),
+
+  callFunction: (
+    function_label: string,
+    params?: Record<string, any>,
+  ): FunctionStageConfig => ({
+    type: "CallFunction",
+    function_label,
+    params,
+  }),
+
+  findOneAndUpdate: (
+    collection: string,
+    record_id: string,
+    updates: Record<string, any>,
+    bypassRipple = false,
+    ttl?: number,
+  ): FunctionStageConfig => ({
+    type: "FindOneAndUpdate",
+    collection,
+    record_id,
+    updates,
+    bypass_ripple: bypassRipple,
+    ttl,
+  }),
+
+  updateWithAction: (
+    collection: string,
+    record_id: string,
+    action: string,
+    field: string,
+    value: any,
+    bypassRipple = false,
+  ): FunctionStageConfig => ({
+    type: "UpdateWithAction",
+    collection,
+    record_id,
+    action,
+    field,
+    value,
+    bypass_ripple: bypassRipple,
+  }),
+
+  createSavepoint: (name: string): FunctionStageConfig => ({
+    type: "CreateSavepoint",
+    name,
+  }),
+
+  rollbackToSavepoint: (name: string): FunctionStageConfig => ({
+    type: "RollbackToSavepoint",
+    name,
+  }),
+
+  releaseSavepoint: (name: string): FunctionStageConfig => ({
+    type: "ReleaseSavepoint",
+    name,
+  }),
 };