@k2b/rsql 0.4.0 → 1.0.0-rc.1

package/README.md

@@ -61,13 +61,17 @@ The `rsql` export reads `RSQL_URL` and `RSQL_API_TOKEN` lazily on first access:
 ```ts
 import { rsql } from "@k2b/rsql";
 
-await rsql.namespaces.list();
+const page = await rsql.namespaces.list({ limit: 100 });
 ```
 
 Imports remain browser-safe because environment variables are not read during
 module evaluation. Browser applications should use an explicit client and must
 not expose a server-wide administrative token.
 
+Namespace lists use cursor pagination. Pass `page.data.next_cursor` to the next
+`list` call, or call `listAll()` explicitly when the complete fleet must be
+loaded into memory.
+
 ## Development
 
 ```bash

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { createRsqlClient } from "./client.js";
 export { rsql } from "./default.js";
-export type { ApiErrorBody, ChangelogEntry, ColumnDefinition, CreateRsqlClientOptions, ImportFile, IndexCreateRequest, ListMeta, ListResponse, MutateOptions, NamespaceConfig, NamespaceDefinition, NamespaceModule, NamespaceOverview, NamespaceRecord, NamespacesModule, QueryInput, QueryRequest, QueryStatement, QueryValue, OverviewLatency, OverviewWindowName, RowsModule, RsqlClient, RsqlResult, SSEEvent, SSESubscribeOptions, SSESubscription, StorageSnapshot, TableCreateRequest, TableExportOptions, TableModule, TablesModule, TableUpdateRequest, } from "./types.js";
+export type { ApiErrorBody, ChangelogEntry, ColumnDefinition, CreateRsqlClientOptions, ImportFile, IndexCreateRequest, ListMeta, ListResponse, MutateOptions, NamespaceConfig, NamespaceDefinition, NamespaceListOptions, NamespaceModule, NamespaceOverview, NamespacePage, NamespaceRecord, NamespacesModule, QueryInput, QueryRequest, QueryStatement, QueryValue, OverviewLatency, OverviewWindowName, RowsModule, RsqlClient, RsqlResult, SSEEvent, SSESubscribeOptions, SSESubscription, StorageSnapshot, TableCreateRequest, TableExportOptions, TableModule, TablesModule, TableUpdateRequest, } from "./types.js";

package/dist/modules/namespaces.js

@@ -15,8 +15,33 @@ export const createNamespacesModule = (http) => {
                 body: JSON.stringify(payload),
             });
         },
-        list() {
-            return http.json(`/${version}/namespaces`);
+        list(options) {
+            return http.json(http.withQuery(`/${version}/namespaces`, {
+                limit: options?.limit,
+                cursor: options?.cursor,
+            }));
+        },
+        async listAll() {
+            const records = [];
+            let cursor;
+            let lastResult;
+            do {
+                lastResult = await http.json(http.withQuery(`/${version}/namespaces`, {
+                    limit: 500,
+                    cursor,
+                }));
+                if (!lastResult.ok) {
+                    return lastResult;
+                }
+                records.push(...lastResult.data.data);
+                cursor = lastResult.data.next_cursor;
+            } while (cursor);
+            return {
+                ok: true,
+                data: records,
+                status: lastResult?.status ?? 200,
+                headers: lastResult?.headers ?? new Headers(),
+            };
         },
         get(name) {
             return http.json(`/${version}/namespaces/${encodeURIComponent(name)}`);
@@ -64,6 +89,7 @@ export const createNamespacesModule = (http) => {
 const withDefaultNamespaceConfig = (config) => {
     const fallback = {
         journal_mode: "wal",
+        synchronous: "full",
         busy_timeout: 5000,
         query_timeout: 10000,
         foreign_keys: true,

package/dist/types.d.ts

@@ -20,6 +20,7 @@ export interface CreateRsqlClientOptions {
 }
 export interface NamespaceConfig {
     journal_mode: string;
+    synchronous?: "full" | "normal";
     busy_timeout: number;
     max_db_size?: number;
     query_timeout: number;
@@ -76,8 +77,8 @@ export interface IndexCreateRequest {
     _meta?: Record<string, unknown>;
 }
 export interface ListMeta {
-    total_count: number;
-    filter_count: number;
+    total_count?: number;
+    filter_count?: number;
     limit: number;
     offset: number;
 }
@@ -143,6 +144,14 @@ export interface NamespaceRecord {
     last_activity_at?: string;
     storage?: StorageSnapshot;
 }
+export interface NamespaceListOptions {
+    limit?: number;
+    cursor?: string;
+}
+export interface NamespacePage {
+    data: NamespaceRecord[];
+    next_cursor?: string;
+}
 export type OverviewWindowName = "1h" | "24h" | "7d" | "30d";
 export interface StorageSnapshot {
     used_bytes: number;
@@ -225,7 +234,8 @@ export interface NamespaceOverview {
 }
 export interface NamespacesModule {
     create(request: NamespaceDefinition): Promise<RsqlResult<NamespaceRecord>>;
-    list(): Promise<RsqlResult<NamespaceRecord[]>>;
+    list(options?: NamespaceListOptions): Promise<RsqlResult<NamespacePage>>;
+    listAll(): Promise<RsqlResult<NamespaceRecord[]>>;
     get(name: string): Promise<RsqlResult<NamespaceRecord>>;
     update(name: string, config: NamespaceConfig): Promise<RsqlResult<NamespaceRecord>>;
     delete(name: string): Promise<RsqlResult<void>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k2b/rsql",
-  "version": "0.4.0",
+  "version": "1.0.0-rc.1",
   "description": "Type-safe fetch client for rsql",
   "type": "module",
   "license": "MIT",