@softr/sdk 0.0.27 → 0.0.29

package/dist/cli.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import { version } from "./package.js";
+import { fetchSoftrEnvInput, metadataSourceFromEnv } from "./codegen/fetch-metadata.js";
 import { renderSoftrEnv } from "./codegen/softr-env.js";
 import { writeFileSync } from "node:fs";
 import path from "node:path";
@@ -7,7 +8,7 @@ import path from "node:path";
 //#region src/cli.ts
 const OUTPUT = "softr-env.d.ts";
 async function generate() {
-	writeFileSync(path.resolve(process.cwd(), OUTPUT), renderSoftrEnv(await getMetadata(), version), "utf8");
+	writeFileSync(path.resolve(process.cwd(), OUTPUT), renderSoftrEnv(await fetchSoftrEnvInput(metadataSourceFromEnv()), version), "utf8");
 	console.log(`[softr] wrote ${OUTPUT}`);
 }
 const [command] = process.argv.slice(2);
@@ -17,623 +18,6 @@ else {
 	console.error("usage: softr-sdk generate");
 	process.exit(1);
 }
-async function getMetadata() {
-	return {
-		userGroupIds: ["8f2b1c04-6d3a-4e58-9a71-c05e3b8d7f12", "3d9e7a56-1b84-42cf-8e0d-64a1f7c92b30"],
-		datasources: [{
-			"id": "FrkQIVpeTtfJDT",
-			"name": "Cafes",
-			"primaryFieldId": "9QrOA",
-			"fields": [
-				{
-					"id": "9QrOA",
-					"name": "Name",
-					"type": "SINGLE_LINE_TEXT",
-					"options": {
-						"minLength": 0,
-						"maxLength": 1024
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "hIpjI",
-					"name": "Description",
-					"type": "LONG_TEXT",
-					"options": { "type": "TEXT" },
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "r10tX",
-					"name": "Status",
-					"type": "SELECT",
-					"options": {
-						"allowToAddNewChoice": true,
-						"filters": null,
-						"choices": [
-							{
-								"id": "5db958e7-eacd-41ff-8e96-dffa73fbc06d",
-								"label": "Todo",
-								"color": "#386af5"
-							},
-							{
-								"id": "fccba54c-8ba2-43b9-8dcc-0b551fe54ff2",
-								"label": "In progress",
-								"color": "#f53878"
-							},
-							{
-								"id": "003d330c-6691-4327-85f4-d8cd55c12ab7",
-								"label": "Done",
-								"color": "#ef5f00"
-							}
-						]
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "pPOt7",
-					"name": "AI Summary",
-					"type": "LONG_TEXT",
-					"options": { "type": "TEXT" },
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null,
-					"aiOnly": true
-				},
-				{
-					"id": "rsww5",
-					"name": "Coffee Category",
-					"type": "SELECT",
-					"options": {
-						"allowToAddNewChoice": true,
-						"filters": null,
-						"choices": [
-							{
-								"id": "79176278-98e4-4980-b6c7-8adc7bd10943",
-								"label": "Espresso",
-								"color": "#6F4E37"
-							},
-							{
-								"id": "69fdef18-e778-455b-86a7-ddf9d39c8890",
-								"label": "Filter",
-								"color": "#C19A6B"
-							},
-							{
-								"id": "a419b11c-c2d7-4bcf-9f1d-19c48ff04942",
-								"label": "Cold Brew",
-								"color": "#2F4858"
-							},
-							{
-								"id": "a4d45385-ef7d-4817-97c0-50e7db429665",
-								"label": "Tea",
-								"color": "#2E7D32"
-							},
-							{
-								"id": "ae47ba65-d40b-468f-ad7e-ef87860bbef9",
-								"label": "Pastry",
-								"color": "#D97706"
-							}
-						]
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "obZYH",
-					"name": "Tags",
-					"type": "SELECT",
-					"options": {
-						"allowToAddNewChoice": true,
-						"filters": null,
-						"choices": [
-							{
-								"id": "fddfc32f-3c29-484f-b922-943ad13323eb",
-								"label": "Seasonal",
-								"color": "#F59E0B"
-							},
-							{
-								"id": "2a0288c2-b115-40ce-b83b-02242d0a9db3",
-								"label": "Signature",
-								"color": "#7C3AED"
-							},
-							{
-								"id": "d40016c8-d689-4607-9ea7-70ef9684739d",
-								"label": "Decaf",
-								"color": "#64748B"
-							},
-							{
-								"id": "0e1ba286-9fc4-4d24-a81f-d94a504ea025",
-								"label": "Vegan",
-								"color": "#16A34A"
-							},
-							{
-								"id": "983e1d1f-44f5-422f-a414-c8d223da47d1",
-								"label": "Gluten-free",
-								"color": "#0EA5E9"
-							}
-						]
-					},
-					"allowMultipleEntries": true,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "DnKHg",
-					"name": "Available Today",
-					"type": "CHECKBOX",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "TRrfv",
-					"name": "Price",
-					"type": "CURRENCY",
-					"options": {
-						"precision": 2,
-						"min": 0,
-						"max": null,
-						"isoCode": "USD",
-						"customSymbol": "$",
-						"showAs": "SYMBOL",
-						"showThousandSeparator": true,
-						"thousandSeparatorLocale": "DEFAULT",
-						"largeNumberAbbreviation": "NONE",
-						"symbolOrCodePosition": "BEFORE"
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "b1ShI",
-					"name": "Discount %",
-					"type": "PERCENT",
-					"options": {
-						"precision": 0,
-						"min": 0,
-						"max": 100,
-						"showThousandSeparator": false,
-						"thousandSeparatorLocale": "DEFAULT",
-						"progressBarColor": "#6F4E37",
-						"showNumber": true,
-						"showAs": "PROGRESS_BAR"
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "HgvTD",
-					"name": "Prep Time",
-					"type": "DURATION",
-					"options": { "format": "hours_minutes" },
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "OOtnV",
-					"name": "Customer Rating",
-					"type": "RATING",
-					"options": { "max": 5 },
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "sXpEY",
-					"name": "Roast Progress",
-					"type": "PROGRESS",
-					"options": null,
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "1G3aA",
-					"name": "Launch Date",
-					"type": "DATETIME",
-					"options": {
-						"precision": "DATE",
-						"useRelativeDatetimeFormat": false,
-						"timezoneType": "LOCAL",
-						"timezone": null,
-						"format": null
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "jNi5x",
-					"name": "Menu URL",
-					"type": "URL",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "NRq3e",
-					"name": "Supplier Email",
-					"type": "EMAIL",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "lJ06U",
-					"name": "Supplier Phone",
-					"type": "PHONE",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "3vzVE",
-					"name": "Roastery Address",
-					"type": "ADDRESS",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "5aV34",
-					"name": "Product Photo",
-					"type": "ATTACHMENT",
-					"options": {
-						"showAs": "PREVIEW",
-						"inferredFileType": "IMAGE",
-						"enableFileLinkExpiration": true,
-						"fileLinkExpirationValue": 1,
-						"fileLinkExpirationUnit": "HOURS"
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "0VNXa",
-					"name": "Barista",
-					"type": "USER",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "xVag5",
-					"name": "Order Link",
-					"type": "BUTTON",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "NniWf",
-					"name": "Supplier",
-					"type": "LINKED_RECORD",
-					"options": {
-						"linkedTableId": "vEhur4KK25b1NF",
-						"category": null,
-						"relationshipName": null
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "z0COG",
-					"name": "Supplier Email (Lookup)",
-					"type": "LOOKUP",
-					"options": {
-						"linkedRecordFieldId": "NniWf",
-						"lookupFieldId": "W2kQG",
-						"returnedField": {
-							"type": "EMAIL",
-							"options": {}
-						}
-					},
-					"allowMultipleEntries": false,
-					"readonly": true,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "y2qDf",
-					"name": "Origin Location",
-					"type": "ADDRESS",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "ub7Gi",
-					"name": "Drink Display Name",
-					"type": "FORMULA",
-					"options": {
-						"formula": "IF({Coffee Category}, {Name} & \" (\" & {Coffee Category} & \")\", {Name})",
-						"referencedFieldIds": ["9QrOA", "rsww5"],
-						"returnedField": {
-							"type": "SINGLE_LINE_TEXT",
-							"options": {
-								"minLength": 0,
-								"maxLength": 1024
-							}
-						},
-						"valid": true
-					},
-					"allowMultipleEntries": false,
-					"readonly": true,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "x8ENy",
-					"name": "Final Price",
-					"type": "FORMULA",
-					"options": {
-						"formula": "{Price} * (1 - IF({Discount %} = BLANK(), 0, {Discount %} / 100))",
-						"referencedFieldIds": ["TRrfv", "b1ShI"],
-						"returnedField": {
-							"type": "CURRENCY",
-							"options": {
-								"precision": 2,
-								"min": null,
-								"max": null,
-								"isoCode": "USD",
-								"customSymbol": "$",
-								"showAs": "SYMBOL",
-								"showThousandSeparator": true,
-								"thousandSeparatorLocale": "DEFAULT",
-								"largeNumberAbbreviation": "NONE",
-								"symbolOrCodePosition": "BEFORE"
-							}
-						},
-						"valid": true
-					},
-					"allowMultipleEntries": false,
-					"readonly": true,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "Fnxlk",
-					"name": "Prep Time (mins)",
-					"type": "FORMULA",
-					"options": {
-						"formula": "ROUND({Prep Time} / 60, 0)",
-						"referencedFieldIds": ["HgvTD"],
-						"returnedField": {
-							"type": "NUMBER",
-							"options": {
-								"precision": 0,
-								"min": null,
-								"max": null,
-								"showThousandSeparator": true,
-								"thousandSeparatorLocale": "DEFAULT",
-								"largeNumberAbbreviation": "NONE",
-								"prefix": null,
-								"suffix": null
-							}
-						},
-						"valid": true
-					},
-					"allowMultipleEntries": false,
-					"readonly": true,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "CXfMR",
-					"name": "Is Premium",
-					"type": "FORMULA",
-					"options": {
-						"formula": "OR({Price} > 6, {Customer Rating} = 5)",
-						"referencedFieldIds": ["OOtnV", "TRrfv"],
-						"returnedField": {
-							"type": "SINGLE_LINE_TEXT",
-							"options": {
-								"minLength": 0,
-								"maxLength": 1024
-							}
-						},
-						"valid": true
-					},
-					"allowMultipleEntries": false,
-					"readonly": true,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "FpC7H",
-					"name": "Launch Month",
-					"type": "FORMULA",
-					"options": {
-						"formula": "DATETIME_FORMAT({Launch Date}, \"yyyy-MM\")",
-						"referencedFieldIds": ["1G3aA"],
-						"returnedField": {
-							"type": "SINGLE_LINE_TEXT",
-							"options": {
-								"minLength": 0,
-								"maxLength": 1024
-							}
-						},
-						"valid": true
-					},
-					"allowMultipleEntries": false,
-					"readonly": true,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "yiEpo",
-					"name": "Tagline",
-					"type": "FORMULA",
-					"options": {
-						"formula": "IF(\n  Tags,\n  \"Try our \" & {Tags} & \" \" & {Name} & \"!\",\n  \"Try our \" & {Name} & \"!\"\n)",
-						"referencedFieldIds": ["9QrOA", "obZYH"],
-						"returnedField": {
-							"type": "SINGLE_LINE_TEXT",
-							"options": {
-								"minLength": 0,
-								"maxLength": 1024
-							}
-						},
-						"valid": true
-					},
-					"allowMultipleEntries": false,
-					"readonly": true,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				}
-			]
-		}, {
-			"id": "vEhur4KK25b1NF",
-			"name": "Suppliers",
-			"primaryFieldId": "LmeiI",
-			"fields": [
-				{
-					"id": "LmeiI",
-					"name": "Name",
-					"type": "SINGLE_LINE_TEXT",
-					"options": {
-						"minLength": 0,
-						"maxLength": 1024
-					},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": true,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "W2kQG",
-					"name": "Email",
-					"type": "EMAIL",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "xbWGH",
-					"name": "Phone",
-					"type": "PHONE",
-					"options": {},
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "gy9xg",
-					"name": "Tier",
-					"type": "NUMBER",
-					"options": { "precision": 0 },
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": true,
-					"defaultValue": null
-				},
-				{
-					"id": "pDvjG",
-					"name": "Score",
-					"type": "NUMBER",
-					"options": { "precision": 1 },
-					"allowMultipleEntries": false,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				},
-				{
-					"id": "xYAXG",
-					"name": "Cafes",
-					"type": "LINKED_RECORD",
-					"options": {
-						"linkedTableId": "FrkQIVpeTtfJDT",
-						"category": null,
-						"relationshipName": null
-					},
-					"allowMultipleEntries": true,
-					"readonly": false,
-					"required": false,
-					"createOnly": false,
-					"defaultValue": null
-				}
-			]
-		}]
-	};
-}
 
 //#endregion
 export {  };

package/dist/codegen/datasource-types.js

@@ -443,7 +443,7 @@ function nameOf(datasourceId, context) {
 }
 /**
 * Always quoted, even where an identifier would do. Find All References on a field id at a
-* `defineAction` call site matches string literals and quoted property names, so a bare key is
+* `defineQuery` call site matches string literals and quoted property names, so a bare key is
 * invisible to it and the id no longer navigates here.
 */
 function key(name) {

package/dist/codegen/fetch-metadata.js

@@ -0,0 +1,46 @@
+import { panic } from "../assertions.js";
+
+//#region src/codegen/fetch-metadata.ts
+function metadataSourceFromEnv(env = process.env) {
+	const missing = [
+		"SOFTR_STUDIO_API_URL",
+		"SOFTR_DATASOURCE_API_URL",
+		"SOFTR_APPLICATION_ID",
+		"SOFTR_STUDIO_TOKEN"
+	].filter((name) => !env[name]?.trim());
+	if (missing.length > 0) panic(`Cannot read the app's schema: ${missing.join(", ")} is not set.`);
+	return {
+		studioApiUrl: withoutTrailingSlash(env.SOFTR_STUDIO_API_URL),
+		datasourceApiUrl: withoutTrailingSlash(env.SOFTR_DATASOURCE_API_URL),
+		applicationId: env.SOFTR_APPLICATION_ID,
+		token: env.SOFTR_STUDIO_TOKEN
+	};
+}
+async function fetchSoftrEnvInput(source) {
+	const { studioApiUrl, datasourceApiUrl, applicationId, token } = source;
+	const registered = await apiFetch(`${studioApiUrl}/v1/applications/${applicationId}/datasources`, token);
+	return {
+		datasources: await Promise.all(registered.map(async ({ name, datasource }) => {
+			return {
+				...await apiFetch(`${datasourceApiUrl}/v1/datasource/vibe/applications/${applicationId}/datasources/${datasource.id}/metadata`, token),
+				id: datasource.id,
+				name
+			};
+		})),
+		userGroupIds: null
+	};
+}
+async function apiFetch(url, token) {
+	const response = await fetch(url, { headers: {
+		accept: "application/json",
+		Authorization: `Bearer ${token}`
+	} }).catch(() => panic(`Could not reach ${url}`));
+	if (!response.ok) panic(`${url} answered ${response.status}`);
+	return await response.json();
+}
+function withoutTrailingSlash(url) {
+	return url.replace(/\/+$/, "");
+}
+
+//#endregion
+export { fetchSoftrEnvInput, metadataSourceFromEnv };

package/dist/codegen/softr-env.js

@@ -13,8 +13,7 @@ function renderSoftrEnv(input, sdkVersion) {
 		"",
 		"declare module \"@softr/sdk\" {",
 		indent(interfaces),
-		"",
-		indent(renderUserGroups(input.userGroupIds)),
+		...input.userGroupIds === null ? [] : ["", indent(renderUserGroups(input.userGroupIds))],
 		"}",
 		""
 	].join("\n");