@valtrix/sdk 0.3.0 → 0.4.0

package/dist/client.d.ts

@@ -168,7 +168,7 @@ export type ClientShape = {
     tables: Record<string, object>;
     records: Record<string, object>;
 };
-export type RecordByIdResult = {
+export type RecordLookupResult = {
     record: {
         id: string;
         entityType: string;
@@ -187,8 +187,9 @@ export type ValtrixClient<S extends ClientShape> = {
 } & {
     records: {
         [K in keyof S['records']]: RecordHandle<S['records'][K]>;
+    } & {
+        get: (recordId: string) => Promise<RecordLookupResult>;
     };
-    recordById: (recordId: string) => Promise<RecordByIdResult>;
     connect: ConnectApi;
     orgs: OrgsApi;
     schema: () => Promise<ApiSchema>;

package/dist/client.js

@@ -296,9 +296,8 @@ export function createClient(config) {
     for (const entityType of config.records) {
         records[entityType] = new RecordHandle(http, entityType);
     }
-    client.records = records;
-    client.recordById = async (recordId) => {
-        const response = await http.request('GET', `/v1/records/by-id/${encodeURIComponent(recordId)}`);
+    records.get = async (recordId) => {
+        const response = await http.request('GET', `/v1/records/${encodeURIComponent(recordId)}`);
         return {
             record: {
                 id: response.record.id,
@@ -311,6 +310,7 @@ export function createClient(config) {
             tables: response.tables,
         };
     };
+    client.records = records;
     client.connect = new ConnectApi(http);
     client.orgs = new OrgsApi(http);
     client.schema = () => http.request('GET', '/v1/schema');

package/dist/codegen.js

@@ -30,6 +30,8 @@ function columnDoc(column, indent) {
     const extra = [];
     if (column.type === 'date')
         extra.push('ISO 8601 date string.');
+    if (column.type === 'reference')
+        extra.push('Valtrix record ID of the referenced record.');
     if (column.writable)
         extra.push('Writable through valtrix.records.');
     return docComment(column.description, extra, indent);
@@ -54,11 +56,11 @@ export function emitClientSource(schema, options = {}) {
     tables.forEach((table, index) => {
         const { interfaceName } = tableProperties[index];
         const identityNote = table.row_identity === 'record'
-            ? ' Rows keep their source record ids; _record_id resolves via recordById().'
+            ? ' Rows keep their source record ids; _record_id (rec_ prefix) resolves via records.get().'
             : table.row_identity === 'synthetic'
                 ? ' Rows are derived aggregates; _record_id is synthetic (syn_ prefix) and does not resolve to a record.'
                 : table.row_identity === 'mixed'
-                    ? ' Rows mix source record ids and synthetic (syn_ prefixed) ids; only record ids resolve via recordById().'
+                    ? ' Rows mix record (rec_ prefix) and synthetic (syn_ prefix) ids; only record ids resolve via records.get().'
                     : '';
         const header = docComment(`Table "${table.name}" (${table.entity_type}), schema ${table.schema_version ?? 'unpublished'}.${identityNote}`, [], '');
         parts.push(`${header}export interface ${interfaceName} {`);

package/dist/protocol.d.ts

@@ -1,6 +1,6 @@
 export type ApiColumn = {
     key: string;
-    type: 'string' | 'number' | 'boolean' | 'date' | 'json';
+    type: 'string' | 'number' | 'boolean' | 'date' | 'json' | 'reference';
     nullable: boolean;
     description: string;
     writable: boolean;

package/package.json

@@ -1,53 +1,47 @@
 {
-    "name": "@valtrix/sdk",
-    "version": "0.3.0",
-    "description": "Typed client and codegen CLI for the Valtrix Tables API. Run valtrix generate to get a client typed against your published tables.",
-    "license": "MIT",
-    "type": "module",
-    "main": "src/index.ts",
-    "types": "src/index.ts",
-    "exports": {
-        ".": "./src/index.ts"
-    },
-    "bin": {
-        "valtrix": "./bin/valtrix.mjs"
-    },
-    "files": [
-        "bin",
-        "dist"
-    ],
-    "keywords": [
-        "valtrix",
-        "sdk",
-        "typed-client",
-        "codegen",
-        "data-api"
-    ],
-    "engines": {
-        "node": ">=18.17"
-    },
-    "publishConfig": {
-        "access": "public",
-        "main": "./dist/index.js",
-        "types": "./dist/index.d.ts",
-        "exports": {
-            ".": {
-                "types": "./dist/index.d.ts",
-                "import": "./dist/index.js"
-            }
-        }
-    },
-    "scripts": {
-        "build": "tsc -p tsconfig.build.json",
-        "prepublishOnly": "pnpm build && pnpm test:run",
-        "typecheck": "tsc --noEmit",
-        "test": "vitest",
-        "test:run": "vitest run"
-    },
-    "devDependencies": {
-        "@types/node": "^25.0.8",
-        "@valtrix/tsconfig": "workspace:*",
-        "typescript": "^5.9.3",
-        "vitest": "^4.0.17"
+  "name": "@valtrix/sdk",
+  "version": "0.4.0",
+  "description": "Typed client and codegen CLI for the Valtrix Tables API. Run valtrix generate to get a client typed against your published tables.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
     }
-}
+  },
+  "bin": {
+    "valtrix": "./bin/valtrix.mjs"
+  },
+  "files": [
+    "bin",
+    "dist"
+  ],
+  "keywords": [
+    "valtrix",
+    "sdk",
+    "typed-client",
+    "codegen",
+    "data-api"
+  ],
+  "engines": {
+    "node": ">=18.17"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.8",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17",
+    "@valtrix/tsconfig": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "test:run": "vitest run"
+  }
+}

package/src/index.ts

@@ -1,56 +0,0 @@
-export {
-    ConnectApi,
-    createClient,
-    OrgsApi,
-    RecordHandle,
-    TableHandle,
-} from './client.js'
-export type {
-    ClientShape,
-    CreateClientConfig,
-    FindManyQuery,
-    MetaFields,
-    OrderBy,
-    Org,
-    OrgsPage,
-    OrgsQuery,
-    OrgStatus,
-    RecordIdFilter,
-    RowsPage,
-    TableChange,
-    TableWriteOutcome,
-    UpsertResult,
-    ValtrixClient,
-    Where,
-    WhereOperators,
-    WhereValue,
-} from './client.js'
-export {
-    errorFromResponse,
-    ValtrixAuthError,
-    ValtrixCursorExpiredError,
-    ValtrixError,
-    ValtrixRateLimitError,
-} from './errors.js'
-export type { FieldIssue } from './errors.js'
-export { camelCase, emitClientSource, pascalCase } from './codegen.js'
-export type { GeneratedClient } from './codegen.js'
-export { runCli } from './cli.js'
-export type {
-    ApiChange,
-    ApiChangesResponse,
-    ApiColumn,
-    ApiConnectSessionResponse,
-    ApiDeleteResponse,
-    ApiOrg,
-    ApiOrgConnection,
-    ApiOrgsResponse,
-    ApiRecord,
-    ApiRecordResponse,
-    ApiRecordType,
-    ApiRowsResponse,
-    ApiSchema,
-    ApiTable,
-    ApiTableOutcome,
-    ApiUpsertResponse,
-} from './protocol.js'