katanakit-js 6.4.3 → 6.7.1

package/dist/adapters/insforge/insforge.service.d.ts

@@ -1,7 +1,142 @@
 import { type InsForgeClient } from "@insforge/sdk";
 import type { ConfigFacade, FetchResult, IfConfig, IfInsertRows, IfInvokeOptions, IfListOptions, IfRpcCall, IfStorageRef, IfTableQuery, IfUpdatePatch, IfWriteQuery } from "../../types/index.js";
 /**
- * Registers the InsForge client and returns your methods alongside it — the
+ * InsForgeService - Singleton para el cliente InsForge (fallback de base de datos).
+ *
+ * Aplica el patrón Singleton: una única instancia mantiene el
+ * {@link InsForgeClient} y centraliza las operaciones de tabla, RPC,
+ * storage y edge functions, devolviendo siempre Safe Results.
+ *
+ * @example
+ * ```ts
+ * const insforge = InsForgeService.getInstance();
+ * insforge.useInit({ baseUrl: "https://app.insforge.app", anonKey: "…" });
+ * const result = await insforge.useSelect({ table: "posts" });
+ * ```
+ */
+export declare class InsForgeService {
+    private static instance;
+    /** InsForge client. InsForge is the database fallback, not the default. */
+    private client;
+    /**
+     * Constructor privado - enforce singleton.
+     */
+    private constructor();
+    /**
+     * Obtiene la instancia única del InsForgeService (Singleton).
+     *
+     * @returns La instancia única de {@link InsForgeService}.
+     */
+    static getInstance(): InsForgeService;
+    /**
+     * Registers the InsForge client. Call once per app. Prefer `apiKey`
+     * (server-only, admin) or `anonKey` (browser-safe) depending on the runtime.
+     *
+     * @param config - Backend URL + credentials + optional schema.
+     * @throws {Error} If the config fails validation.
+     *
+     * @example
+     * ```ts
+     * InsForgeService.getInstance().useInit({ baseUrl: "https://app.insforge.app", anonKey: "…" });
+     * ```
+     */
+    useInit(config: IfConfig): void;
+    /**
+     * Returns the initialized client (or `null` before `useInit`).
+     * Exposed for advanced use - the wrappers cover the supported surface.
+     *
+     * @returns The InsForge client or `null`.
+     */
+    useGetClient(): InsForgeClient | null;
+    /**
+     * Reads rows from a table with equality filters, ordering and pagination.
+     *
+     * @param query - Table, columns, filters, order, limit and offset.
+     * @returns Safe Result with the rows.
+     */
+    useSelect<T = Record<string, unknown>>(query: IfTableQuery): Promise<FetchResult<T[]>>;
+    /**
+     * Inserts one or more rows and returns the created rows.
+     *
+     * @param table - Table name.
+     * @param rows - Rows to insert (at least one).
+     * @param schema - Optional schema override.
+     * @returns Safe Result with the inserted rows.
+     */
+    useInsert<T = Record<string, unknown>>(table: string, rows: IfInsertRows, schema?: string): Promise<FetchResult<T[]>>;
+    /**
+     * Updates rows matching the filters and returns the updated rows.
+     * Filters are REQUIRED - mass updates are refused at validation time.
+     *
+     * @param query - Table + mandatory filters (+ optional schema).
+     * @param patch - Column patch (must not be empty).
+     * @returns Safe Result with the updated rows.
+     */
+    useUpdate<T = Record<string, unknown>>(query: IfWriteQuery, patch: IfUpdatePatch): Promise<FetchResult<T[]>>;
+    /**
+     * Deletes rows matching the filters and returns the deleted rows.
+     * Filters are REQUIRED - mass deletes are refused at validation time.
+     *
+     * @param query - Table + mandatory filters (+ optional schema).
+     * @returns Safe Result with the deleted rows.
+     */
+    useDelete<T = Record<string, unknown>>(query: IfWriteQuery): Promise<FetchResult<T[]>>;
+    /**
+     * Calls a Postgres function (RPC).
+     *
+     * @param call - Function name, params and optional schema.
+     * @returns Safe Result with the function output.
+     */
+    useRpc<T = unknown>(call: IfRpcCall): Promise<FetchResult<T>>;
+    /**
+     * Uploads a file to a bucket (standard PUT semantics: same key replaces).
+     *
+     * @param ref - Bucket + object key.
+     * @param file - File or Blob to upload.
+     * @returns Safe Result with the stored file metadata.
+     */
+    useUpload(ref: IfStorageRef, file: File | Blob): Promise<FetchResult<Record<string, unknown>>>;
+    /**
+     * Downloads a file from a bucket.
+     *
+     * @param ref - Bucket + object key.
+     * @returns Safe Result with the file as a Blob.
+     */
+    useDownload(ref: IfStorageRef): Promise<FetchResult<Blob>>;
+    /**
+     * Removes a file from a bucket.
+     *
+     * @param ref - Bucket + object key.
+     * @returns Safe Result with the deletion response.
+     */
+    useRemove(ref: IfStorageRef): Promise<FetchResult<Record<string, unknown>>>;
+    /**
+     * Lists objects in a bucket.
+     *
+     * @param bucket - Bucket name.
+     * @param options - Prefix, search, limit and offset.
+     * @returns Safe Result with the listing.
+     */
+    useListObjects(bucket: string, options?: IfListOptions): Promise<FetchResult<Record<string, unknown>>>;
+    /**
+     * Builds the public URL for an object in a public bucket (no network call).
+     *
+     * @param ref - Bucket + object key.
+     * @returns Safe Result with `{ publicUrl }`.
+     */
+    useGetPublicUrl(ref: IfStorageRef): FetchResult<{
+        publicUrl: string;
+    }>;
+    /**
+     * Invokes an edge function.
+     *
+     * @param options - Function slug + optional JSON body.
+     * @returns Safe Result with the function response.
+     */
+    useInvokeFunction<T = unknown>(options: IfInvokeOptions): Promise<FetchResult<T>>;
+}
+/**
+ * Registers the InsForge client and returns your methods alongside it - the
  * config-file entry point. One call is the whole setup: no separate
  * `useInitInsforge(...)` step.
  *
@@ -48,7 +183,7 @@ export declare function defineInsforgeConfig<T extends IfConfig>(input: T & This
 export declare function useInitInsforge(config: IfConfig): void;
 /**
  * Returns the initialized client (or `null` before `useInitInsforge`).
- * Exposed for advanced use — the wrappers cover the supported surface.
+ * Exposed for advanced use - the wrappers cover the supported surface.
  *
  * @returns The InsForge client or `null`.
  */
@@ -76,7 +211,7 @@ export declare function useIfSelect<T = Record<string, unknown>>(query: IfTableQ
 export declare function useIfInsert<T = Record<string, unknown>>(table: string, rows: IfInsertRows, schema?: string): Promise<FetchResult<T[]>>;
 /**
  * Updates rows matching the filters and returns the updated rows.
- * Filters are REQUIRED — mass updates are refused at validation time.
+ * Filters are REQUIRED - mass updates are refused at validation time.
  *
  * @param query - Table + mandatory filters (+ optional schema).
  * @param patch - Column patch (must not be empty).
@@ -85,7 +220,7 @@ export declare function useIfInsert<T = Record<string, unknown>>(table: string,
 export declare function useIfUpdate<T = Record<string, unknown>>(query: IfWriteQuery, patch: IfUpdatePatch): Promise<FetchResult<T[]>>;
 /**
  * Deletes rows matching the filters and returns the deleted rows.
- * Filters are REQUIRED — mass deletes are refused at validation time.
+ * Filters are REQUIRED - mass deletes are refused at validation time.
  *
  * @param query - Table + mandatory filters (+ optional schema).
  * @returns Safe Result with the deleted rows.

package/dist/adapters/insforge/insforge.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"insforge.service.d.ts","sourceRoot":"","sources":["../../../src/adapters/insforge/insforge.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAiBrF,OAAO,KAAK,EAEX,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,eAAe,EACf,aAAa,EACb,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,MAAM,sBAAsB,CAAC;AAkJ9B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,QAAQ,EACtD,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAClC,YAAY,CAAC,CAAC,CAAC,CAKjB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CActD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,cAAc,GAAG,IAAI,CAE5D;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,KAAK,EAAE,YAAY,GACjB,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAwB3B;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,YAAY,EAClB,MAAM,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAe3B;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,aAAa,GAClB,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAyB3B;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,KAAK,EAAE,YAAY,GACjB,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAc3B;AAED;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAYpF;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAChC,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE,IAAI,GAAG,IAAI,GACf,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAW/C;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAsBjF;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAChC,GAAG,EAAE,YAAY,GACf,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAW/C;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACrC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAa/C;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,YAAY,GAAG,WAAW,CAAC;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,CAiBvF;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,GAAG,OAAO,EACpD,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAazB"}
+{"version":3,"file":"insforge.service.d.ts","sourceRoot":"","sources":["../../../src/adapters/insforge/insforge.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAiBrF,OAAO,KAAK,EAEX,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,eAAe,EACf,aAAa,EACb,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,MAAM,sBAAsB,CAAC;AA+I9B;;;;;;;;;;;;;GAaG;AACH,qBAAa,eAAe;IAC3B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAkB;IAEzC,2EAA2E;IAC3E,OAAO,CAAC,MAAM,CAA+B;IAE7C;;OAEG;IACH,OAAO;IAEP;;;;OAIG;IACH,MAAM,CAAC,WAAW,IAAI,eAAe;IAOrC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI;IAgB/B;;;;;OAKG;IACH,YAAY,IAAI,cAAc,GAAG,IAAI;IAIrC;;;;;OAKG;IACG,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IA0B5F;;;;;;;OAOG;IACG,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,YAAY,EAClB,MAAM,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAiB5B;;;;;;;OAOG;IACG,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,aAAa,GAClB,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IA2B5B;;;;;;OAMG;IACG,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAgB5F;;;;;OAKG;IACG,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAcnE;;;;;;OAMG;IACG,SAAS,CACd,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE,IAAI,GAAG,IAAI,GACf,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAahD;;;;;OAKG;IACG,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAwBhE;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAajF;;;;;;OAMG;IACG,cAAc,CACnB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAehD;;;;;OAKG;IACH,eAAe,CAAC,GAAG,EAAE,YAAY,GAAG,WAAW,CAAC;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAqBtE;;;;;OAKG;IACG,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CAcvF;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,QAAQ,EACtD,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAClC,YAAY,CAAC,CAAC,CAAC,CAKjB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAEtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,cAAc,GAAG,IAAI,CAE5D;AAMD;;;;;;;;;;GAUG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,KAAK,EAAE,YAAY,GACjB,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAE3B;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,YAAY,EAClB,MAAM,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAE3B;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,aAAa,GAClB,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAE3B;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,KAAK,EAAE,YAAY,GACjB,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAE3B;AAED;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAEpF;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAChC,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE,IAAI,GAAG,IAAI,GACf,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAE/C;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAEjF;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAChC,GAAG,EAAE,YAAY,GACf,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAE/C;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACrC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,YAAY,GAAG,WAAW,CAAC;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,CAEvF;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,GAAG,OAAO,EACpD,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAEzB"}