@softr/sdk 0.0.57 → 0.0.58-alpha.1

package/dist/codegen/datasource-docs.js

@@ -1,5 +1,5 @@
 import { assert, requireDefined } from "../assertions.js";
-import { choiceEntries, fieldTypeLiteral, isWritable, option, readExample, resolvedShape, scalarExample, underlyingType } from "./datasource-types.js";
+import { choiceEntries, fieldTypeLiteral, isWritable, linkedDatasource, option, readExample, resolvedShape, scalarExample, underlyingType } from "./datasource-types.js";
 
 //#region src/codegen/datasource-docs.ts
 const DOC_NOTE = "> This document is generated automatically when a change is made in the datasource.";
@@ -35,7 +35,7 @@ function relatedLinks(datasource, context) {
 		const linkedId = option(field.options, "linkedTableId");
 		if (typeof linkedId !== "string" || seen.has(linkedId)) continue;
 		seen.add(linkedId);
-		const linked = context.datasources.get(linkedId);
+		const linked = linkedDatasource(linkedId, context.datasources);
 		if (linked === void 0 || linked.id === datasource.id) continue;
 		links.push(docLink(linked, context));
 	}
@@ -138,7 +138,7 @@ function optionLines(field) {
 function linkLine(field, context) {
 	const linkedId = option(field.options, "linkedTableId");
 	if (typeof linkedId !== "string") return [];
-	const linked = context.datasources.get(linkedId);
+	const linked = linkedDatasource(linkedId, context.datasources);
 	if (linked === void 0) return [`- Links to: ${linkedId}, not registered`];
 	return [`- Links to: ${docLink(linked, context)} (${linked.id})`];
 }

package/dist/codegen/datasource-schema.js

@@ -0,0 +1,65 @@
+import { linkedDatasource, resolvedShape } from "./datasource-types.js";
+
+//#region src/codegen/datasource-schema.ts
+/**
+* The types a `contains` filter accepts, so a linked picker knows whether it can search its label.
+* Kept in step with `TextFieldType` in ../datasource/fields.ts, which is not exported.
+*/
+const SEARCHABLE_TYPES = new Set([
+	"SINGLE_LINE_TEXT",
+	"LONG_TEXT",
+	"URL",
+	"EMAIL",
+	"PHONE",
+	"ADDRESS",
+	"RECORD_ID",
+	"LOCATION",
+	"TIME",
+	"BUTTON"
+]);
+/**
+* One datasource's metadata as JSON, for tools that generate code from it.
+*
+* A linked field carries its target already resolved: the registration id and the field a person
+* recognises a row by. Readers never map table ids themselves. `datasources` is keyed by
+* registration id.
+*/
+function renderDatasourceSchema(datasource, datasources) {
+	const schema = {
+		id: datasource.id,
+		name: datasource.name,
+		primaryFieldId: datasource.primaryFieldId,
+		fields: datasource.fields.map((field) => schemaField(field, datasources))
+	};
+	return `${JSON.stringify(schema, null, 2)}\n`;
+}
+function schemaField(field, datasources) {
+	const base = {
+		id: field.id,
+		name: field.name,
+		type: field.type,
+		allowMultipleEntries: field.allowMultipleEntries,
+		required: field.required,
+		readonly: field.readonly,
+		createOnly: field.createOnly,
+		aiOnly: field.aiOnly === true,
+		defaultValue: field.defaultValue,
+		options: field.options
+	};
+	if (field.type !== "LINKED_RECORD") return base;
+	const linkedTableId = field.options?.["linkedTableId"];
+	const linked = typeof linkedTableId === "string" ? linkedDatasource(linkedTableId, datasources) : void 0;
+	if (linked === void 0 || linked.primaryFieldId === "") return base;
+	const primary = linked.fields.find((entry) => entry.id === linked.primaryFieldId);
+	return {
+		...base,
+		linked: {
+			datasourceId: linked.id,
+			labelFieldId: linked.primaryFieldId,
+			labelSearchable: primary !== void 0 && SEARCHABLE_TYPES.has(resolvedShape(primary).type)
+		}
+	};
+}
+
+//#endregion
+export { renderDatasourceSchema };

package/dist/codegen/datasource-types.js

@@ -46,6 +46,15 @@ function byId(datasources) {
 	return new Map(datasources.map((datasource) => [datasource.id, datasource]));
 }
 /**
+* The registered datasource a `LINKED_RECORD`'s `linkedTableId` names. That id is the underlying
+* table's own id, kept as `tableId`, while `datasources` is keyed by registration id. The
+* registration id is the fallback, in case a link names that one instead.
+*/
+function linkedDatasource(linkedTableId, datasources) {
+	for (const datasource of datasources.values()) if (datasource.tableId === linkedTableId) return datasource;
+	return datasources.get(linkedTableId);
+}
+/**
 * A TypeScript name per datasource, derived from its own name, with the id standing in wherever
 * the name cannot: two datasources can share a name, and a name can be blank or hold nothing an
 * identifier can keep. The id is unique by construction, so it settles both.
@@ -238,7 +247,7 @@ function union(members) {
 function linkedRecord(options, context) {
 	const linkedTableId = option(options, "linkedTableId");
 	if (typeof linkedTableId !== "string") return "LinkedRecord";
-	const linked = context.datasources.get(linkedTableId);
+	const linked = linkedDatasource(linkedTableId, context.datasources);
 	if (linked === void 0 || linked.primaryFieldId === "") return "LinkedRecord";
 	return `LinkedRecord<NonNullable<${`${nameOf(linked.id, context)}Read[${quote(linked.primaryFieldId)}]`}>>`;
 }
@@ -339,7 +348,7 @@ function lookupTag(field, datasource, context) {
 	const link = datasource.fields.find((candidate) => candidate.id === linkId);
 	if (link === void 0) return null;
 	const linkedTableId = option(link.options, "linkedTableId");
-	const target = (typeof linkedTableId === "string" ? context.datasources.get(linkedTableId) : void 0)?.fields.find((candidate) => candidate.id === targetId);
+	const target = (typeof linkedTableId === "string" ? linkedDatasource(linkedTableId, context.datasources) : void 0)?.fields.find((candidate) => candidate.id === targetId);
 	if (target === void 0) return null;
 	return `@lookup ${link.name} -> ${target.name}`;
 }
@@ -396,7 +405,7 @@ function readExample(shape, datasources) {
 function linkedLabelExample(options, datasources) {
 	const linkedTableId = option(options, "linkedTableId");
 	if (typeof linkedTableId !== "string") return "null";
-	const linked = datasources.get(linkedTableId);
+	const linked = linkedDatasource(linkedTableId, datasources);
 	const primary = linked?.fields.find((field) => field.id === linked.primaryFieldId);
 	if (linked === void 0 || primary === void 0) return "null";
 	const rest = new Map(datasources);
@@ -485,4 +494,4 @@ function indent(block) {
 }
 
 //#endregion
-export { choiceEntries, fieldTypeLiteral, isWritable, option, readExample, renderDatasourceTypes, resolvedShape, scalarExample, underlyingType };
+export { choiceEntries, fieldTypeLiteral, isWritable, linkedDatasource, option, readExample, renderDatasourceTypes, resolvedShape, scalarExample, underlyingType };

package/dist/codegen/fetch-metadata.js

@@ -22,9 +22,11 @@ async function fetchSoftrEnvInput(source) {
 	const [registered, userGroups] = await Promise.all([apiFetch(`${studioApiUrl}/v1/applications/${applicationId}/datasources`, token), apiFetch(`${studioApiUrl}/v1/applications/${applicationId}/access-control/user-groups`, token)]);
 	return {
 		datasources: await Promise.all(registered.map(async ({ name, datasource }) => {
+			const metadata = await apiFetch(`${datasourceApiUrl}/v1/datasource/vibe/studio/applications/${applicationId}/datasources/${datasource.id}/metadata`, token);
 			return {
-				...await apiFetch(`${datasourceApiUrl}/v1/datasource/vibe/studio/applications/${applicationId}/datasources/${datasource.id}/metadata`, token),
+				...metadata,
 				id: datasource.id,
+				tableId: metadata.id,
 				name
 			};
 		})),

package/dist/codegen/write-datasource-docs.js

@@ -1,12 +1,13 @@
 import { requireDefined } from "../assertions.js";
 import { renderDatasourceDoc, renderDatasourceIndex } from "./datasource-docs.js";
+import { renderDatasourceSchema } from "./datasource-schema.js";
 import { docFileNames } from "./doc-file-names.js";
 import { writeIfChanged } from "./write-if-changed.js";
 import path from "node:path";
 
 //#region src/codegen/write-datasource-docs.ts
 /**
-* Writes the index and one file per datasource, and touches nothing else in
+* Writes the index, and one doc and one schema JSON per datasource, and touches nothing else in
 * `docsDir`: the caller resolves it against `process.cwd()`, which can be any
 * directory a developer ran the bin from. `changed` is true when any file it
 * wrote now reads differently.
@@ -16,7 +17,11 @@ function writeDatasourceDocs(datasources, docsDir) {
 		datasources: new Map(datasources.map((datasource) => [datasource.id, datasource])),
 		fileNames: docFileNames(datasources)
 	};
-	const writes = [writeIfChanged(path.join(docsDir, "README.md"), renderDatasourceIndex(datasources, context)), ...datasources.map((datasource) => writeIfChanged(path.join(docsDir, requireDefined(context.fileNames.get(datasource.id))), renderDatasourceDoc(datasource, context)))];
+	const writes = [
+		writeIfChanged(path.join(docsDir, "README.md"), renderDatasourceIndex(datasources, context)),
+		...datasources.map((datasource) => writeIfChanged(path.join(docsDir, requireDefined(context.fileNames.get(datasource.id))), renderDatasourceDoc(datasource, context))),
+		...datasources.map((datasource) => writeIfChanged(path.join(docsDir, requireDefined(context.fileNames.get(datasource.id)).replace(/\.md$/, ".json")), renderDatasourceSchema(datasource, context.datasources)))
+	];
 	return {
 		fileNames: context.fileNames,
 		changed: writes.includes(true)

package/dist/package.js

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "0.0.57";
+var version = "0.0.58-alpha.1";
 
 //#endregion
 export { version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softr/sdk",
-  "version": "0.0.57",
+  "version": "0.0.58-alpha.1",
   "type": "module",
   "exports": {
     ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" },

package/skills/softr-sdk/SKILL.md

@@ -11,7 +11,7 @@ description: >-
 metadata:
   type: core
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 # Softr SDK core

package/skills/softr-sdk/auth/SKILL.md

@@ -16,7 +16,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `auth` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build.

package/skills/softr-sdk/charts-and-metrics/SKILL.md

@@ -12,7 +12,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler or a server-side route hook — importing it into a component fails the build. `defineQuery` and every type come from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/current-user/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 # The current user

package/skills/softr-sdk/file-uploads/SKILL.md

@@ -10,7 +10,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `upload` lives on `@softr/sdk/server` and runs inside server functions. `useFileUpload` and `FileItem` live on `@softr/sdk` and run in components. `FileAttachment` comes from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/integrations/SKILL.md

@@ -10,7 +10,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `integration` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineIntegration` and every type come from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/mcp/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `softrMcpMiddleware` lives on `@softr/sdk` and is registered once, in `src/start.ts`. The actions you hand it are the same `defineQuery` / `defineMutation` values the app's own pages use — declared wherever they already live, not duplicated for MCP.

package/skills/softr-sdk/pwa/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 # Installing the app

package/skills/softr-sdk/record-mutations/SKILL.md

@@ -11,7 +11,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineMutation` and every type come from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/record-queries/SKILL.md

@@ -13,7 +13,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler or a server-side route hook — importing it into a component fails the build. The same holds for any helper that calls `ds`: declare it inside the handler. A function at module level that calls `ds` keeps the server-only import in the browser bundle, and every page stops loading until it moves. `defineQuery` and every type come from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/region-visibility/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `Audience` and `defineVisibility` come from `@softr/sdk` and work anywhere.

package/skills/softr-sdk/routes-and-visibility/SKILL.md

@@ -13,7 +13,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `defineVisibility`, the access functions and the error predicates come from `@softr/sdk` and work anywhere.

package/skills/softr-sdk/workflows/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.57
+  library_version: 0.0.58-alpha.1
 ---
 
 **Boundary.** `workflow` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineWorkflow` and every type come from `@softr/sdk` and can be imported anywhere.