@dashai/sdk 0.8.0 → 0.10.0

package/dist/{types-BLNQ1S1C.d.cts → types-BwlzFHbq.d.cts}

@@ -199,6 +199,16 @@ interface ClientConfig {
      * Resolved tokens are attached as `Authorization: Bearer <token>`.
      */
     getToken?: TokenResolver;
+    /**
+     * Custom Modules Platform v1 — a static `dwk_` API key used as the
+     * Bearer credential. Convenience over `getToken: () => apiKey` for the
+     * common "deployed module with one long-lived key" case (set it from
+     * `process.env.DASHWISE_API_KEY`). Precedence: a non-null `getToken()`
+     * result wins; otherwise `apiKey` is used. NEVER expose this to the
+     * browser — keep it server-only (route client data through server
+     * actions / route handlers).
+     */
+    apiKey?: string;
     /**
      * Installation ID this client is scoped to. Required for module
      * runtime calls. Typical values:
@@ -391,6 +401,104 @@ interface Client {
         timeoutMs?: number;
         idempotencyKey?: string;
     }): Promise<TOutput>;
+    /**
+     * Custom Modules Platform v1 (P1b) — access to the workspace's shared
+     * Data Hub tables (the ones no-code users build), scoped by the key's
+     * datahub grants. Requires the client to be authenticated with a
+     * scoped `dwk_` API key that holds matching grants. Hits the
+     * runtime Data Hub bridge:
+     *   GET/POST/PATCH/DELETE :installationId/datahub/tables/:tableId/rows…
+     *
+     * Untyped in v1 (rows are `Record<string, unknown>` — they follow the
+     * Data Hub table's own field schema, not the module manifest).
+     */
+    datahub: DatahubClient;
+}
+/** Custom Modules Platform v1 (P1b) — Data Hub access surface. */
+interface DatahubClient {
+    /**
+     * Bind a Data Hub table by its numeric id. Pass a hand-written row
+     * interface as the type argument for typed `filter` / `sort` keys on
+     * `list()`; defaults to an untyped `Record` (Data Hub rows have no
+     * compile-time schema).
+     */
+    table<Row = Record<string, unknown>>(tableId: number): DatahubTableClient<Row>;
+}
+/** Result envelope of a Data Hub list (mirrors the backend RowQueryService). */
+interface DatahubListResult {
+    results: Array<Record<string, unknown>>;
+    count: number;
+    /**
+     * 1-based index of the next page, or `null` when on the last page.
+     * Mirrors the backend envelope (`RowQueryService.list` →
+     * `offset + size < count ? page + 1 : null`).
+     */
+    next: number | null;
+    /**
+     * 1-based index of the previous page, or `null` when on the first page.
+     * Mirrors the backend envelope (`page > 1 ? page - 1 : null`).
+     */
+    previous: number | null;
+}
+/**
+ * Typed options for {@link DatahubTableClient.list}. A higher-level
+ * mirror of {@link ListOpts} that the runtime compiles to the Data Hub
+ * bridge's flat query protocol (`filter__<field>__<op>` /
+ * `filters=<json>` / `order_by` / `search` / `size` / `page`).
+ *
+ * Unlike module tables, Data Hub rows have no compile-time row type, so
+ * `Row` defaults to a bare `Record` — pass a hand-written interface as
+ * the type argument for editor help on `filter` / `sort` keys.
+ *
+ * The raw `Record<string, string>` passthrough on `list()` stays
+ * supported for back-compat; reach for it when you need a flat param
+ * the typed shape doesn't model yet.
+ */
+interface DatahubListOpts<Row = Record<string, unknown>> {
+    /**
+     * Recursive filter clause, same shape as {@link ListOpts.filter}. Top
+     * level keys are AND'd; bare primitives are shorthand for
+     * `{ equal: ... }`. Simple (non-grouped) filters compile to repeated
+     * `filter__<field>__<op>=<value>` params; any clause using `AND` / `OR`
+     * grouping compiles to a single `filters=<json>` tree param (the
+     * backend's Phase 9b syntax).
+     */
+    filter?: Where<Row>;
+    /**
+     * Sort order, same shape as {@link ListOpts.sort}. Compiles to the
+     * Data Hub `order_by` param (`-` prefix for descending), joined with
+     * commas for multi-field sorts.
+     */
+    sort?: SortClause<Row>[];
+    /** Full-text / substring search across searchable fields → `search`. */
+    search?: string;
+    /** Page size → `size`. */
+    limit?: number;
+    /** 1-based page index → `page`. */
+    page?: number;
+}
+/** Row CRUD against a single Data Hub table, gated by the key's grants. */
+interface DatahubTableClient<Row = Record<string, unknown>> {
+    /**
+     * List rows. Accepts either:
+     *   - a typed {@link DatahubListOpts} object (`{ filter, sort, search,
+     *     limit, page }`), which the client compiles to the Data Hub
+     *     bridge's flat query protocol; or
+     *   - the raw Baserow flat shape (`Record<string, string>`, e.g.
+     *     `{ size: '50', order_by: '-created_on' }`) for back-compat and
+     *     for params the typed shape doesn't model yet.
+     *
+     * The two are distinguished structurally: an options object carrying
+     * any of the known `DatahubListOpts` keys is compiled; anything else
+     * is passed through verbatim as raw query params.
+     */
+    list(opts?: DatahubListOpts<Row> | Record<string, string>): Promise<DatahubListResult>;
+    get(rowId: number): Promise<Record<string, unknown>>;
+    create(body: Record<string, unknown>): Promise<Record<string, unknown>>;
+    update(rowId: number, body: Record<string, unknown>): Promise<Record<string, unknown>>;
+    delete(rowId: number): Promise<{
+        success: true;
+    }>;
 }
 
-export type { BaseInsert as B, ClientConfig as C, Deps as D, FetchImpl as F, ListOpts as L, Page as P, ReadOnlyTableClient as R, SlowQueryInfo as S, TokenResolver as T, Where as W, Client as a, BaseRow as b, BaseUpdate as c, FileRef as d, FilterOps as e, FilterValue as f, SortClause as g, SortDir as h, TableClient as i };
+export type { BaseInsert as B, ClientConfig as C, Deps as D, FetchImpl as F, ListOpts as L, Page as P, ReadOnlyTableClient as R, SlowQueryInfo as S, TokenResolver as T, Where as W, Client as a, BaseRow as b, BaseUpdate as c, DatahubClient as d, DatahubListOpts as e, DatahubListResult as f, DatahubTableClient as g, FileRef as h, FilterOps as i, FilterValue as j, SortClause as k, SortDir as l, TableClient as m };

package/dist/{types-BLNQ1S1C.d.ts → types-BwlzFHbq.d.ts}

@@ -199,6 +199,16 @@ interface ClientConfig {
      * Resolved tokens are attached as `Authorization: Bearer <token>`.
      */
     getToken?: TokenResolver;
+    /**
+     * Custom Modules Platform v1 — a static `dwk_` API key used as the
+     * Bearer credential. Convenience over `getToken: () => apiKey` for the
+     * common "deployed module with one long-lived key" case (set it from
+     * `process.env.DASHWISE_API_KEY`). Precedence: a non-null `getToken()`
+     * result wins; otherwise `apiKey` is used. NEVER expose this to the
+     * browser — keep it server-only (route client data through server
+     * actions / route handlers).
+     */
+    apiKey?: string;
     /**
      * Installation ID this client is scoped to. Required for module
      * runtime calls. Typical values:
@@ -391,6 +401,104 @@ interface Client {
         timeoutMs?: number;
         idempotencyKey?: string;
     }): Promise<TOutput>;
+    /**
+     * Custom Modules Platform v1 (P1b) — access to the workspace's shared
+     * Data Hub tables (the ones no-code users build), scoped by the key's
+     * datahub grants. Requires the client to be authenticated with a
+     * scoped `dwk_` API key that holds matching grants. Hits the
+     * runtime Data Hub bridge:
+     *   GET/POST/PATCH/DELETE :installationId/datahub/tables/:tableId/rows…
+     *
+     * Untyped in v1 (rows are `Record<string, unknown>` — they follow the
+     * Data Hub table's own field schema, not the module manifest).
+     */
+    datahub: DatahubClient;
+}
+/** Custom Modules Platform v1 (P1b) — Data Hub access surface. */
+interface DatahubClient {
+    /**
+     * Bind a Data Hub table by its numeric id. Pass a hand-written row
+     * interface as the type argument for typed `filter` / `sort` keys on
+     * `list()`; defaults to an untyped `Record` (Data Hub rows have no
+     * compile-time schema).
+     */
+    table<Row = Record<string, unknown>>(tableId: number): DatahubTableClient<Row>;
+}
+/** Result envelope of a Data Hub list (mirrors the backend RowQueryService). */
+interface DatahubListResult {
+    results: Array<Record<string, unknown>>;
+    count: number;
+    /**
+     * 1-based index of the next page, or `null` when on the last page.
+     * Mirrors the backend envelope (`RowQueryService.list` →
+     * `offset + size < count ? page + 1 : null`).
+     */
+    next: number | null;
+    /**
+     * 1-based index of the previous page, or `null` when on the first page.
+     * Mirrors the backend envelope (`page > 1 ? page - 1 : null`).
+     */
+    previous: number | null;
+}
+/**
+ * Typed options for {@link DatahubTableClient.list}. A higher-level
+ * mirror of {@link ListOpts} that the runtime compiles to the Data Hub
+ * bridge's flat query protocol (`filter__<field>__<op>` /
+ * `filters=<json>` / `order_by` / `search` / `size` / `page`).
+ *
+ * Unlike module tables, Data Hub rows have no compile-time row type, so
+ * `Row` defaults to a bare `Record` — pass a hand-written interface as
+ * the type argument for editor help on `filter` / `sort` keys.
+ *
+ * The raw `Record<string, string>` passthrough on `list()` stays
+ * supported for back-compat; reach for it when you need a flat param
+ * the typed shape doesn't model yet.
+ */
+interface DatahubListOpts<Row = Record<string, unknown>> {
+    /**
+     * Recursive filter clause, same shape as {@link ListOpts.filter}. Top
+     * level keys are AND'd; bare primitives are shorthand for
+     * `{ equal: ... }`. Simple (non-grouped) filters compile to repeated
+     * `filter__<field>__<op>=<value>` params; any clause using `AND` / `OR`
+     * grouping compiles to a single `filters=<json>` tree param (the
+     * backend's Phase 9b syntax).
+     */
+    filter?: Where<Row>;
+    /**
+     * Sort order, same shape as {@link ListOpts.sort}. Compiles to the
+     * Data Hub `order_by` param (`-` prefix for descending), joined with
+     * commas for multi-field sorts.
+     */
+    sort?: SortClause<Row>[];
+    /** Full-text / substring search across searchable fields → `search`. */
+    search?: string;
+    /** Page size → `size`. */
+    limit?: number;
+    /** 1-based page index → `page`. */
+    page?: number;
+}
+/** Row CRUD against a single Data Hub table, gated by the key's grants. */
+interface DatahubTableClient<Row = Record<string, unknown>> {
+    /**
+     * List rows. Accepts either:
+     *   - a typed {@link DatahubListOpts} object (`{ filter, sort, search,
+     *     limit, page }`), which the client compiles to the Data Hub
+     *     bridge's flat query protocol; or
+     *   - the raw Baserow flat shape (`Record<string, string>`, e.g.
+     *     `{ size: '50', order_by: '-created_on' }`) for back-compat and
+     *     for params the typed shape doesn't model yet.
+     *
+     * The two are distinguished structurally: an options object carrying
+     * any of the known `DatahubListOpts` keys is compiled; anything else
+     * is passed through verbatim as raw query params.
+     */
+    list(opts?: DatahubListOpts<Row> | Record<string, string>): Promise<DatahubListResult>;
+    get(rowId: number): Promise<Record<string, unknown>>;
+    create(body: Record<string, unknown>): Promise<Record<string, unknown>>;
+    update(rowId: number, body: Record<string, unknown>): Promise<Record<string, unknown>>;
+    delete(rowId: number): Promise<{
+        success: true;
+    }>;
 }
 
-export type { BaseInsert as B, ClientConfig as C, Deps as D, FetchImpl as F, ListOpts as L, Page as P, ReadOnlyTableClient as R, SlowQueryInfo as S, TokenResolver as T, Where as W, Client as a, BaseRow as b, BaseUpdate as c, FileRef as d, FilterOps as e, FilterValue as f, SortClause as g, SortDir as h, TableClient as i };
+export type { BaseInsert as B, ClientConfig as C, Deps as D, FetchImpl as F, ListOpts as L, Page as P, ReadOnlyTableClient as R, SlowQueryInfo as S, TokenResolver as T, Where as W, Client as a, BaseRow as b, BaseUpdate as c, DatahubClient as d, DatahubListOpts as e, DatahubListResult as f, DatahubTableClient as g, FileRef as h, FilterOps as i, FilterValue as j, SortClause as k, SortDir as l, TableClient as m };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashai/sdk",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Runtime client for DashWise: typed data access + auth helpers for modules.",
   "license": "MIT",
   "type": "module",
@@ -81,8 +81,7 @@
     "vitest": "^2.1.8"
   },
   "publishConfig": {
-    "access": "public",
-    "provenance": true
+    "access": "public"
   },
   "repository": {
     "type": "git",