@arbidocs/client 0.3.36 → 0.3.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -728,9 +728,12 @@ interface paths {
728
728
  * List Documents
729
729
  * @description List documents in the current workspace.
730
730
  *
731
- * By default returns all documents (no pagination) since the frontend needs
732
- * the full set for client-side sort/search/filter. Pass ``limit``/``offset``
733
- * to opt into pagination — useful for the CLI when streaming a workspace.
731
+ * By default returns all documents (no pagination, full shape) since the
732
+ * frontend's client-side sort/search/filter needs the complete set.
733
+ *
734
+ * Pagination params (``limit``/``offset``) opt into server-side paging. When
735
+ * paginating, ``order`` chooses the scan (id ascending vs created_at
736
+ * descending) and ``fields=lite`` trims per-row decrypt cost.
734
737
  */
735
738
  get: operations['list_documents'];
736
739
  put?: never;
@@ -8637,8 +8640,12 @@ interface operations {
8637
8640
  query?: {
8638
8641
  /** @description Optional page size. Omit to return every document in the workspace (the default — the web UI's sort/search/filter is client-side and needs the full list). Set when paging through huge workspaces from a CLI. */
8639
8642
  limit?: number | null;
8640
- /** @description Optional offset for pagination. Requires a stable id-ordered scan. */
8643
+ /** @description Optional offset for pagination. Requires a stable ordered scan. */
8641
8644
  offset?: number | null;
8645
+ /** @description Ordering for paginated results. ``id_asc`` (default) walks docs by primary key and matches legacy behavior. ``created_desc`` returns newest-first and uses ix_docs_workspace_id_created_at_id_desc so the frontend's progressive loader hits a warm index. Ignored when limit/offset are omitted (unpaginated full-list has no order). */
8646
+ order?: string;
8647
+ /** @description Response payload shape. ``full`` (default) returns DocResponse with doctags and decrypted doc_metadata — unchanged legacy behavior. ``lite`` skips the doctags JOIN and doc_metadata decrypt for each row: doctags=[] and doc_metadata=None. Used by the frontend's progressive loader to halve per-row decrypt work; full metadata is fetched on-demand per doc via /v1/document/ when a row is opened. */
8648
+ fields?: string;
8642
8649
  };
8643
8650
  header?: never;
8644
8651
  path?: never;
package/dist/index.d.ts CHANGED
@@ -728,9 +728,12 @@ interface paths {
728
728
  * List Documents
729
729
  * @description List documents in the current workspace.
730
730
  *
731
- * By default returns all documents (no pagination) since the frontend needs
732
- * the full set for client-side sort/search/filter. Pass ``limit``/``offset``
733
- * to opt into pagination — useful for the CLI when streaming a workspace.
731
+ * By default returns all documents (no pagination, full shape) since the
732
+ * frontend's client-side sort/search/filter needs the complete set.
733
+ *
734
+ * Pagination params (``limit``/``offset``) opt into server-side paging. When
735
+ * paginating, ``order`` chooses the scan (id ascending vs created_at
736
+ * descending) and ``fields=lite`` trims per-row decrypt cost.
734
737
  */
735
738
  get: operations['list_documents'];
736
739
  put?: never;
@@ -8637,8 +8640,12 @@ interface operations {
8637
8640
  query?: {
8638
8641
  /** @description Optional page size. Omit to return every document in the workspace (the default — the web UI's sort/search/filter is client-side and needs the full list). Set when paging through huge workspaces from a CLI. */
8639
8642
  limit?: number | null;
8640
- /** @description Optional offset for pagination. Requires a stable id-ordered scan. */
8643
+ /** @description Optional offset for pagination. Requires a stable ordered scan. */
8641
8644
  offset?: number | null;
8645
+ /** @description Ordering for paginated results. ``id_asc`` (default) walks docs by primary key and matches legacy behavior. ``created_desc`` returns newest-first and uses ix_docs_workspace_id_created_at_id_desc so the frontend's progressive loader hits a warm index. Ignored when limit/offset are omitted (unpaginated full-list has no order). */
8646
+ order?: string;
8647
+ /** @description Response payload shape. ``full`` (default) returns DocResponse with doctags and decrypted doc_metadata — unchanged legacy behavior. ``lite`` skips the doctags JOIN and doc_metadata decrypt for each row: doctags=[] and doc_metadata=None. Used by the frontend's progressive loader to halve per-row decrypt work; full metadata is fetched on-demand per doc via /v1/document/ when a row is opened. */
8648
+ fields?: string;
8642
8649
  };
8643
8650
  header?: never;
8644
8651
  path?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arbidocs/client",
3
- "version": "0.3.36",
3
+ "version": "0.3.37",
4
4
  "description": "TypeScript SDK for the ARBI API — zero-knowledge auth, E2E encryption, and type-safe REST client",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",