@machhub-dev/sdk-ts 0.0.15 → 1.0.0

package/dist/cjs/classes/collection.d.ts

@@ -12,7 +12,7 @@ export declare class Collection {
     protected collectionName: string;
     protected queryParams: Record<string, any>;
     constructor(httpService: HTTPService, mqttService: MQTTService | null, collectionName: string);
-    filter(fieldName: string, operator: "=" | ">" | "<" | "<=" | ">=" | "!=" | "CONTAINS", value: any): Collection;
+    filter(fieldName: string, operator: "=" | ">" | "<" | "<=" | ">=" | "!=" | "CONTAINS" | "IN", value: any): Collection;
     sort(field: string, direction?: "asc" | "desc"): Collection;
     limit(limit: number): Collection;
     offset(offset: number): Collection;
@@ -25,7 +25,9 @@ export declare class Collection {
     count(options?: {
         filter?: any;
     }): Promise<number>;
-    getOne(id: string): Promise<any>;
+    getOne(id: string, options?: {
+        expand?: string | string[];
+    }): Promise<any>;
     create(data: Record<string, any>): Promise<any>;
     update(id: string, data: Record<string, any>): Promise<any>;
     delete(id: string): Promise<any>;

package/dist/cjs/classes/collection.js

@@ -75,12 +75,19 @@ class Collection {
             throw new CollectionError('count', this.collectionName, error);
         }
     }
-    async getOne(id) {
+    async getOne(id, options) {
         if (!id) {
             throw new Error("ID must be provided");
         }
         try {
-            return await this.httpService.request.get(id);
+            const queryParams = {};
+            // Handle expand parameter
+            if (options?.expand) {
+                queryParams.expand = Array.isArray(options.expand)
+                    ? options.expand.join(',')
+                    : options.expand;
+            }
+            return await this.httpService.request.get(id, queryParams);
         }
         catch (error) {
             throw new CollectionError('getOne', this.collectionName, error);

package/dist/classes/collection.d.ts

@@ -12,7 +12,7 @@ export declare class Collection {
     protected collectionName: string;
     protected queryParams: Record<string, any>;
     constructor(httpService: HTTPService, mqttService: MQTTService | null, collectionName: string);
-    filter(fieldName: string, operator: "=" | ">" | "<" | "<=" | ">=" | "!=" | "CONTAINS", value: any): Collection;
+    filter(fieldName: string, operator: "=" | ">" | "<" | "<=" | ">=" | "!=" | "CONTAINS" | "IN", value: any): Collection;
     sort(field: string, direction?: "asc" | "desc"): Collection;
     limit(limit: number): Collection;
     offset(offset: number): Collection;
@@ -25,7 +25,9 @@ export declare class Collection {
     count(options?: {
         filter?: any;
     }): Promise<number>;
-    getOne(id: string): Promise<any>;
+    getOne(id: string, options?: {
+        expand?: string | string[];
+    }): Promise<any>;
     create(data: Record<string, any>): Promise<any>;
     update(id: string, data: Record<string, any>): Promise<any>;
     delete(id: string): Promise<any>;

package/dist/classes/collection.js

@@ -71,12 +71,19 @@ export class Collection {
             throw new CollectionError('count', this.collectionName, error);
         }
     }
-    async getOne(id) {
+    async getOne(id, options) {
         if (!id) {
             throw new Error("ID must be provided");
         }
         try {
-            return await this.httpService.request.get(id);
+            const queryParams = {};
+            // Handle expand parameter
+            if (options?.expand) {
+                queryParams.expand = Array.isArray(options.expand)
+                    ? options.expand.join(',')
+                    : options.expand;
+            }
+            return await this.httpService.request.get(id, queryParams);
         }
         catch (error) {
             throw new CollectionError('getOne', this.collectionName, error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@machhub-dev/sdk-ts",
-  "version": "0.0.15",
+  "version": "1.0.0",
   "description": "MACHHUB TYPESCRIPT SDK",
   "keywords": [
     "machhub",

package/src/classes/collection.ts

@@ -1,5 +1,6 @@
 import { HTTPService } from "../services/http.service.js";
 import { MQTTService } from "../services/mqtt.service.js";
+import { Operator } from "../types/operator.models.js";
 
 export class CollectionError extends Error {
   public operation: string;
@@ -28,7 +29,7 @@ export class Collection {
   }
 
 
-  filter(fieldName: string, operator: "=" | ">" | "<" | "<=" | ">=" | "!=" | "CONTAINS", value: any): Collection {
+  filter(fieldName: string, operator: Operator, value: any): Collection {
     this.queryParams[`filter[${fieldName}][${operator}][${typeof value}]`] = value;
     return this;
   }
@@ -68,11 +69,14 @@ export class Collection {
     return results[0] ?? null
   }
 
-  async getAll(options?: { expand?: string | string[] }): Promise<any[]> {
+  async getAll(options?: { expand?: string | string[], fields?: string | string[] }): Promise<any[]> {
     try {
       this.applyOptions(options)
       if (options?.expand) {
-        this.queryParams.expand = Array.isArray(options.expand) ? options.expand.join() : options.expand
+        this.queryParams.expand = Array.isArray(options.expand) ? options.expand.join(",") : options.expand
+      }
+      if (options?.fields) {
+        this.queryParams.fields = Array.isArray(options.fields) ? options.fields.join(",") : options.fields
       }
       return await this.httpService.request.get(this.collectionName + "/all", this.queryParams);
     } catch (error) {
@@ -93,18 +97,26 @@ export class Collection {
       throw new CollectionError('count', this.collectionName, error as Error);
     }
   }
-
-  async getOne(id: string): Promise<any> {
+  
+  async getOne(id: string, options?: { expand?: string | string[] }): Promise<any> {
     if (!id) {
       throw new Error("ID must be provided");
     }
     try {
-      return await this.httpService.request.get(id);
+      const queryParams: any = {};
+
+      // Handle expand parameter
+      if (options?.expand) {
+        queryParams.expand = Array.isArray(options.expand)
+          ? options.expand.join(',')
+          : options.expand;
+      }
+
+      return await this.httpService.request.get(id, queryParams);
     } catch (error) {
       throw new CollectionError('getOne', this.collectionName, error as Error);
     }
   }
-
   async create(data: Record<string, any>): Promise<any> {
     try {
       const formData = new FormData();

package/src/index.ts

@@ -2,6 +2,7 @@ export { SDK, type SDKConfig } from './sdk-ts.js';
 
 // Export individual types
 export type { LoginResponse, PermissionResponse, User, Group, Feature, Permission, ActionResponse, Action, Scope } from './types/auth.models.js';
+export type { Operator } from './types/operator.models.js';
 export type { BaseResponse } from './types/response.models.js';
 export type { RecordID } from './types/recordID.models.js';
 export type { HistorizedData } from './types/tag.models.js';

package/src/types/operator.models.ts

@@ -0,0 +1,68 @@
+/**
+ * SurrealDB Operators
+ * Reference: https://surrealdb.com/docs/surrealql/operators
+ */
+
+/**
+ * Comparison operators
+ */
+export type ComparisonOperator =
+  | "=" // Equal to
+  | "!=" // Not equal to
+  | "==" // Exact equality
+  | "?=" // Matches a condition
+  | "*=" // All match a condition
+  | "~" // Contains / matches regex
+  | "!~" // Does not contain / match regex
+  | "?~" // Matches a condition (fuzzy)
+  | "*~" // All match a condition (fuzzy)
+  | "<" // Less than
+  | "<=" // Less than or equal to
+  | ">" // Greater than
+  | ">=" // Greater than or equal to;
+
+/**
+ * Containment operators
+ */
+export type ContainmentOperator =
+  | "CONTAINS" // Contains a value
+  | "CONTAINSNOT" // Does not contain a value
+  | "CONTAINSALL" // Contains all values
+  | "CONTAINSANY" // Contains any value
+  | "CONTAINSNONE" // Contains none of the values
+  | "INSIDE" // Value is inside
+  | "NOTINSIDE" // Value is not inside
+  | "ALLINSIDE" // All values are inside
+  | "ANYINSIDE" // Any value is inside
+  | "NONEINSIDE"; // No values are inside
+
+/**
+ * String operators
+ */
+export type StringOperator =
+  | "@@" // Matches a condition (full-text search)
+  | "@0@" // Matches a condition (exact match)
+  | "@1@" // Matches a condition (fuzzy match level 1)
+  | "@2@" // Matches a condition (fuzzy match level 2)
+  | "@3@"; // Matches a condition (fuzzy match level 3)
+
+/**
+ * Array operators
+ */
+export type ArrayOperator =
+  | "IN" // Value is in array
+  | "NOT IN"; // Value is not in array
+
+/**
+ * All available operators in SurrealDB
+ */
+export type Operator =
+  | ComparisonOperator
+  | ContainmentOperator
+  | StringOperator
+  | ArrayOperator;
+
+/**
+ * Common operators for basic queries
+ */
+export type BasicOperator = "=" | "!=" | "<" | "<=" | ">" | ">=" | "CONTAINS" | "IN";