@softr/sdk 0.0.12 → 0.0.14

package/dist/server.js

@@ -1,432 +1,7 @@
-import { _ as dealiasOrderBy, a as readSessionToken, c as readUserTimezone, d as panic, f as softAssert, g as dealiasFilterCriteria, h as buildOrderBy, l as writeCookies, m as buildFilterCriteria, n as makeSessionDataCookie, o as fetchVisitor, p as todo, r as makeSessionTokenCookie, s as platformFetch, t as clearSession } from "./session-kTqxT5_K.js";
-import { z } from "zod";
+import { auth } from "./auth/server.js";
+import { ds } from "./core/datasource.js";
+import { workflow } from "./core/workflow.js";
+import { integration } from "./core/integration.js";
 import "@tanstack/react-start/server-only";
 
-//#region src/auth/methods/utils.ts
-function authError(code, message) {
-	return {
-		success: false,
-		error: {
-			code,
-			message
-		}
-	};
-}
-const errorSchema = z.object({ message: z.string() });
-async function describe(response, action) {
-	const body = errorSchema.safeParse(await response.json().catch(() => null));
-	const said = body.success && body.data.message ? body.data.message : response.statusText;
-	return `Softr platform refused the ${action}: ${response.status} ${said}`.trim();
-}
-
-//#endregion
-//#region src/auth/methods/password.ts
-const signInBody = z.object({
-	jwt: z.string().nullish(),
-	authenticatorAppAction: z.string().nullish()
-});
-/**
-* Signs a visitor in with an email and password.
-*
-* The cache is primed from the same `/me` the resolver would have called anyway,
-* so the next request costs no round-trip.
-*/
-async function signIn(credentials) {
-	const response = await platformFetch("sign-in", {
-		method: "POST",
-		headers: {
-			"content-type": "application/json",
-			accept: "application/json"
-		},
-		body: JSON.stringify(credentials)
-	});
-	if (response.status === 401 || response.status === 429) return authError(response.status === 401 ? "invalidCredentials" : "tooManyAttempts", await describe(response, "sign-in"));
-	if (response.status >= 500) panic(await describe(response, "sign-in"));
-	if (response.status === 400) todo(await describe(response, "sign-in"));
-	if (!response.ok) throw new Error(`${await describe(response, "sign-in")}. Check SOFTR_APPLICATION_ID and that the app allows sign-in.`);
-	const raw = await response.text();
-	const body = signInBody.parse(raw.length === 0 ? {} : JSON.parse(raw));
-	if (body.authenticatorAppAction) todo(`Softr platform asked for an authenticator step (${body.authenticatorAppAction}) to finish the sign-in. This app requires an authenticator app, which the SDK cannot finish yet.`);
-	const token = body.jwt;
-	if (!token) todo("Softr platform answered the sign-in by emailing a one-time code. This app is configured for passwordless sign-in, which the SDK cannot finish yet.");
-	const user = await fetchVisitor(token);
-	if (!user) panic("Session token issued, but no user could be resolved for it.");
-	writeCookies([makeSessionTokenCookie(token), makeSessionDataCookie(user, token)]);
-	return {
-		success: true,
-		data: user
-	};
-}
-/**
-* Signs the visitor out and clears the session cookies.
-*
-* This revokes **every** outstanding session for that user in this app, on every
-* device: the platform stamps `tokensInvalidatedAt` and rejects anything issued
-* before it. There is no per-device sign-out.
-*
-* A platform that could not revoke leaves the caller signed out here and
-* possibly still signed in elsewhere — loud outside production, logged in it,
-* because the local half already succeeded.
-*/
-async function signOut() {
-	const token = readSessionToken();
-	clearSession();
-	if (!token) return;
-	const response = await platformFetch("sign-out", {
-		method: "POST",
-		headers: {
-			authorization: `Bearer ${token}`,
-			accept: "application/json"
-		}
-	});
-	softAssert(response.ok || response.status < 500, () => `Softr platform could not revoke the session: ${response.status}. This browser is signed out, but other devices may still be.`);
-}
-
-//#endregion
-//#region src/auth/methods/signup.ts
-/**
-* Starts a sign-up flow by emailing a verification code.
-*
-* User only exists once `confirmSignUp` returns the code.
-*/
-async function signUp(details) {
-	const response = await platformFetch("sign-up", {
-		method: "POST",
-		headers: {
-			"content-type": "application/json",
-			accept: "application/json"
-		},
-		body: JSON.stringify(signUpBody(details))
-	});
-	if (response.status >= 500) panic(await describe(response, "sign-up"));
-	if (response.status === 409) return authError("emailTaken", await describe(response, "sign-up"));
-	if (!response.ok) return authError("invalidDetails", await describe(response, "sign-up"));
-	return {
-		success: true,
-		data: null
-	};
-}
-/**
-* Finishes sign-up flow with the emailed code and signs the visitor in.
-*
-* The platform splits on how the app is configured: a code-only app creates the
-* user on the second `sign-up` request and answers with a token, while a
-* password app answers it with an empty 200 and expects the password on
-* `users/new`.
-*/
-async function confirmSignUp(details) {
-	const verified = await platformFetch("sign-up", {
-		method: "POST",
-		headers: {
-			"content-type": "application/json",
-			accept: "application/json"
-		},
-		body: JSON.stringify({
-			...signUpBody(details),
-			token: details.code
-		})
-	});
-	if (verified.status >= 500) panic(await describe(verified, "sign-up"));
-	if (verified.status === 409) return authError("emailTaken", await describe(verified, "sign-up"));
-	if (!verified.ok) return authError("invalidCode", await describe(verified, "sign-up"));
-	const verifiedBody = await verified.text();
-	let token = tokenBody.parse(verifiedBody.length === 0 ? {} : JSON.parse(verifiedBody)).jwt;
-	if (!token) {
-		const created = await platformFetch("new", {
-			method: "POST",
-			headers: {
-				"content-type": "application/json",
-				accept: "application/json"
-			},
-			body: JSON.stringify({
-				...signUpBody(details),
-				password: details.password,
-				token: details.code
-			})
-		});
-		if (created.status >= 500) panic(await describe(created, "sign-up"));
-		if (created.status === 409) return authError("emailTaken", await describe(created, "sign-up"));
-		if (created.ok) {
-			const createdBody = await created.text();
-			token = tokenBody.parse(createdBody.length === 0 ? {} : JSON.parse(createdBody)).jwt;
-		} else {
-			const signedIn = await signIn({
-				email: details.email,
-				password: details.password
-			});
-			if (!signedIn.success) return authError("invalidCode", await describe(created, "sign-up"));
-			return signedIn;
-		}
-	}
-	if (!token) todo("Softr platform accepted the sign-up and returned no session token. This app is configured for a sign-up flow the SDK cannot finish yet.");
-	const user = await fetchVisitor(token);
-	if (!user) panic("Session token issued, but no user could be resolved for it.");
-	writeCookies([makeSessionTokenCookie(token), makeSessionDataCookie(user, token)]);
-	return {
-		success: true,
-		data: user
-	};
-}
-/**
-* `name` is dropped when absent rather than sent as `undefined`: the platform's
-* validator runs on whatever key is present, and an explicit null is not the
-* same request as no name at all.
-*/
-function signUpBody(details) {
-	return details.name === void 0 ? { email: details.email } : {
-		email: details.email,
-		name: details.name
-	};
-}
-const tokenBody = z.object({ jwt: z.string().nullish() });
-
-//#endregion
-//#region src/auth/server.ts
-/**
-* Server-only auth methods, should be called from the app's own `createServerFn` handlers.
-*/
-const auth = {
-	signIn,
-	signOut,
-	signUp,
-	confirmSignUp
-};
-
-//#endregion
-//#region src/core/datasource.ts
-const MAX_RECORD_COUNT = 100;
-const COUNT_CNT = "COUNT_CNT";
-const BASE_URL$2 = () => (import.meta.env.VITE_SOFTR_BASE_URL ?? "").replace(/\/$/, "");
-async function listRecords(datasourceId, options = {}) {
-	const { select, where, orderBy } = options;
-	const count = Math.min(options.limit ?? 20, MAX_RECORD_COUNT);
-	const offset = options.offset ?? null;
-	const filterCriteria = where ? dealiasFilterCriteria(buildFilterCriteria(where), select ?? {}) : {};
-	const sortingOption = orderBy ? dealiasOrderBy(buildOrderBy(orderBy), select ?? {}) : void 0;
-	const res = await fetch(`${BASE_URL$2()}/api/datasources/${datasourceId}/records`, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/json",
-			"X-User-Timezone": options.timeZone ?? readUserTimezone() ?? "UTC",
-			"Authorization": `Bearer ${readSessionToken()}`
-		},
-		body: JSON.stringify({
-			options: { userLocale: "en-US" },
-			filterCriteria,
-			sortingOption,
-			pagingOption: {
-				offset,
-				count
-			}
-		})
-	});
-	if (!res.ok) throw new Error(`Softr datasource list failed for "${datasourceId}": ${res.status}`);
-	const payload = await res.json();
-	const nextOffset = payload.offset < payload.total ? payload.offset : null;
-	return {
-		records: payload.items.map((item) => ({
-			id: item.id,
-			fields: select ? aliasFields(item.fields, select) : item.fields
-		})),
-		total: payload.total,
-		nextOffset
-	};
-}
-async function getRecord(datasourceId, options) {
-	if (options.id !== void 0) {
-		if (!options.id) throw new Error(`Softr datasource get: id must not be empty`);
-		const res = await fetch(`${BASE_URL$2()}/api/datasources/${datasourceId}/records/${options.id}`, {
-			method: "POST",
-			headers: {
-				"Content-Type": "application/json",
-				"X-User-Timezone": options.timeZone ?? readUserTimezone() ?? "UTC",
-				"Authorization": `Bearer ${readSessionToken()}`
-			},
-			body: JSON.stringify({ options: { userLocale: "en-US" } })
-		});
-		if (!res.ok) throw new Error(`Softr datasource get failed for "${datasourceId}": ${res.status}`);
-		const contentLength = res.headers.get("Content-Length");
-		if (contentLength && parseInt(contentLength, 10) === 0) return null;
-		return res.json();
-	}
-	return (await listRecords(datasourceId, {
-		where: options.where,
-		limit: 1,
-		timeZone: options.timeZone
-	})).records[0] ?? null;
-}
-async function createRecord(datasourceId, options) {
-	const res = await fetch(`${BASE_URL$2()}/api/datasources/${datasourceId}/records`, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/json",
-			"Authorization": `Bearer ${readSessionToken()}`
-		},
-		body: JSON.stringify({ fields: options.fields })
-	});
-	if (!res.ok) throw new Error(`Softr datasource create failed for "${datasourceId}": ${res.status}`);
-	return (await res.json()).record;
-}
-async function updateRecord(datasourceId, options) {
-	if (!options.id) throw new Error(`Softr datasource update: id must not be empty`);
-	const res = await fetch(`${BASE_URL$2()}/api/datasources/${datasourceId}/records/${options.id}`, {
-		method: "PATCH",
-		headers: {
-			"Content-Type": "application/json",
-			"Authorization": `Bearer ${readSessionToken()}`
-		},
-		body: JSON.stringify({ fields: options.fields })
-	});
-	if (!res.ok) throw new Error(`Softr datasource update failed for "${datasourceId}": ${res.status}`);
-	return (await res.json()).record;
-}
-async function deleteRecord(datasourceId, id) {
-	const res = await fetch(`${BASE_URL$2()}/api/datasources/${datasourceId}/records/${id}`, {
-		method: "DELETE",
-		headers: { "Authorization": `Bearer ${readSessionToken()}` }
-	});
-	if (!res.ok) throw new Error(`Softr datasource delete failed for "${datasourceId}": ${res.status}`);
-}
-async function getMetric(datasourceId, options) {
-	const { select, where, aggregation, field } = options;
-	const fieldId = field ? select?.[field] ?? field : void 0;
-	const filterCriteria = where ? dealiasFilterCriteria(buildFilterCriteria(where), select ?? {}) : {};
-	const res = await fetch(`${BASE_URL$2()}/api/datasources/${datasourceId}/chartMetricData`, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/json",
-			"X-User-Timezone": options.timeZone ?? readUserTimezone() ?? "UTC",
-			"Authorization": `Bearer ${readSessionToken()}`
-		},
-		body: JSON.stringify({
-			options: { userLocale: "en-US" },
-			calculationField: {
-				field: fieldId,
-				aggregation
-			},
-			filterCriteria
-		})
-	});
-	if (!res.ok) throw new Error(`Softr datasource metric failed for "${datasourceId}": ${res.status}`);
-	const payload = await res.json();
-	const executionTimestamp = /* @__PURE__ */ new Date(payload.executionTimestamp * 1e3);
-	let value;
-	if (aggregation === "COUNT") value = payload.data.find((item) => COUNT_CNT in item)?.[COUNT_CNT] ?? null;
-	else {
-		if (!fieldId) throw new Error(`field is required for aggregation "${aggregation}"`);
-		value = payload.data.find((item) => fieldId in item)?.[fieldId] ?? null;
-	}
-	return {
-		value,
-		executionTimestamp
-	};
-}
-async function getChartData(datasourceId, options) {
-	const { select, where, groupBy, metrics, orderBy } = options;
-	const filterCriteria = where ? dealiasFilterCriteria(buildFilterCriteria(where), select ?? {}) : {};
-	const sortingOption = orderBy ? dealiasOrderBy(buildOrderBy(orderBy), select ?? {})[0] : void 0;
-	const groupByFields = (Array.isArray(groupBy) ? groupBy : [groupBy]).map((field) => ({ field: select?.[field] ?? field }));
-	const yAxisFields = Object.values(metrics).map(({ field, aggregation }) => ({
-		field: field ? select?.[field] ?? field : void 0,
-		aggregation
-	}));
-	const res = await fetch(`${BASE_URL$2()}/api/datasources/${datasourceId}/chartData`, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/json",
-			"X-User-Timezone": options.timeZone ?? readUserTimezone() ?? "UTC",
-			"Authorization": `Bearer ${readSessionToken()}`
-		},
-		body: JSON.stringify({
-			options: { userLocale: "en-US" },
-			filterCriteria,
-			sortingOption,
-			xAxisFields: groupByFields,
-			yAxisFields
-		})
-	});
-	if (!res.ok) throw new Error(`Softr datasource chartData failed for "${datasourceId}": ${res.status}`);
-	const payload = await res.json();
-	const executionTimestamp = /* @__PURE__ */ new Date(payload.executionTimestamp * 1e3);
-	const aliases = {};
-	const multipleMetrics = Object.keys(metrics).length > 1;
-	for (const [alias, { field, aggregation }] of Object.entries(metrics)) if (aggregation === "COUNT") aliases[COUNT_CNT] = alias;
-	else {
-		const fieldId = field ? select?.[field] ?? field : field;
-		if (fieldId) {
-			const suffix = multipleMetrics ? `_${aggregation.toLowerCase()}` : "";
-			aliases[fieldId + suffix] = alias;
-		}
-	}
-	for (const field of Array.isArray(groupBy) ? groupBy : [groupBy]) aliases[select?.[field] ?? field] = field;
-	return {
-		data: payload.data.map((item) => {
-			const row = {};
-			for (const [rawKey, alias] of Object.entries(aliases)) if (rawKey in item) row[alias] = item[rawKey];
-			return row;
-		}),
-		executionTimestamp
-	};
-}
-function aliasFields(fields, aliases) {
-	const result = {};
-	for (const [alias, fieldId] of Object.entries(aliases)) result[alias] = fields[fieldId];
-	return result;
-}
-const ds = {
-	list: listRecords,
-	get: getRecord,
-	create: createRecord,
-	update: updateRecord,
-	delete: deleteRecord,
-	metric: getMetric,
-	chartData: getChartData
-};
-
-//#endregion
-//#region src/core/workflow.ts
-const BASE_URL$1 = () => (import.meta.env.VITE_SOFTR_BASE_URL ?? "").replace(/\/$/, "");
-async function triggerWorkflow(workflowId, payload) {
-	const res = await fetch(`${BASE_URL$1()}/api/workflows/${workflowId}/trigger`, {
-		method: "POST",
-		headers: {
-			"Authorization": `Bearer ${readSessionToken()}`,
-			...payload ? { "Content-Type": "application/json" } : {}
-		},
-		...payload ? { body: JSON.stringify(payload) } : {}
-	});
-	if (!res.ok) throw new Error(`Softr workflow trigger failed: ${res.status}`);
-}
-const workflow = { trigger: triggerWorkflow };
-
-//#endregion
-//#region src/core/integration.ts
-const BASE_URL = () => (import.meta.env.VITE_SOFTR_BASE_URL ?? "").replace(/\/$/, "");
-async function integrationFetch(integrationId, input, init) {
-	const req = new Request(input, init);
-	if (req.signal.aborted) throw req.signal.reason ?? new DOMException("The operation was aborted.", "AbortError");
-	const reqHeaders = {};
-	new Headers(req.headers).forEach((value, key) => {
-		reqHeaders[key] = value;
-	});
-	const payload = {
-		method: req.method,
-		url: req.url,
-		headers: reqHeaders
-	};
-	const method = req.method.toUpperCase();
-	if (method !== "GET" && method !== "HEAD" && req.body !== null) payload.body = await req.clone().text();
-	return fetch(`${BASE_URL()}/api/integrations/${integrationId}/proxy`, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/json",
-			"Authorization": `Bearer ${readSessionToken()}`
-		},
-		body: JSON.stringify(payload),
-		signal: req.signal
-	});
-}
-const integration = { fetch: integrationFetch };
-
-//#endregion
 export { auth, ds, integration, workflow };

package/dist/types.d.ts

@@ -0,0 +1,115 @@
+import { AnyConstructable, ConstructableOrderBy } from "./core/query.js";
+import { SoftrUserGroupId } from "./auth/user.js";
+
+//#region src/types.d.ts
+interface SoftrUser {
+  id: string;
+  email: string;
+  name: string;
+  userGroupIds: Array<SoftrUserGroupId>;
+}
+interface DatasourcePermissions {
+  read: boolean;
+  create: boolean;
+  update: boolean;
+  delete: boolean;
+}
+interface SoftrPermissions {
+  datasources: Record<string, DatasourcePermissions>;
+  workflows: Record<string, boolean>;
+}
+interface SoftrMe {
+  user: SoftrUser | null;
+  permissions: SoftrPermissions;
+}
+type GetByIdOptions = {
+  id: string;
+  where?: never;
+  timeZone?: string;
+};
+type GetByWhereOptions = {
+  id?: never;
+  where: AnyConstructable;
+  timeZone?: string;
+};
+type GetOptions = GetByIdOptions | GetByWhereOptions;
+interface ListOptions {
+  /**
+   * Maps human-readable aliases to Softr field IDs.
+   * When provided, returned fields are keyed by alias instead of raw field ID.
+   */
+  select?: Record<string, string>;
+  where?: AnyConstructable;
+  orderBy?: ConstructableOrderBy | ConstructableOrderBy[];
+  /**
+   * Number of records to return per page. Defaults to 20, max 100.
+   */
+  limit?: number;
+  /**
+   * Offset to start from. Pass the `nextOffset` from a previous result to paginate.
+   * Omit or pass `null` to start from the beginning.
+   */
+  offset?: number | null;
+  /** Override the timezone for this request. */
+  timeZone?: string;
+}
+interface ListResult<T = SoftrRecord> {
+  records: T[];
+  total: number;
+  /** Offset to pass as `offset` in the next call, or `null` when there are no more pages. */
+  nextOffset: number | null;
+}
+interface SoftrRecord {
+  id: string;
+  fields: Record<string, unknown>;
+}
+type AggregationFunction = 'SUM' | 'AVG' | 'MAX' | 'MIN' | 'COUNT' | 'DISTINCT';
+interface MetricOptions {
+  select?: Record<string, string>;
+  where?: AnyConstructable;
+  aggregation: AggregationFunction;
+  /** Field alias (resolved via select) or raw field ID. Not required for COUNT. */
+  field?: string;
+  /** Override the timezone for this request. */
+  timeZone?: string;
+}
+interface MetricResult {
+  value: number | null;
+  executionTimestamp: Date;
+}
+interface ChartDataOptions {
+  select?: Record<string, string>;
+  where?: AnyConstructable;
+  /** Field alias (resolved via select) or raw field ID. */
+  groupBy: string | string[];
+  metrics: Record<string, {
+    field?: string;
+    aggregation: AggregationFunction;
+  }>;
+  orderBy?: ConstructableOrderBy;
+  /** Override the timezone for this request. */
+  timeZone?: string;
+}
+interface ChartDataResult {
+  data: Record<string, unknown>[];
+  executionTimestamp: Date;
+}
+interface CreateOptions {
+  /**
+   * Maps human-readable aliases to Softr field IDs.
+   * When provided, `data` keys are interpreted as aliases.
+   */
+  select?: Record<string, string>;
+  data: Record<string, unknown>;
+}
+interface UpdateOptions {
+  id: string;
+  /**
+   * Maps human-readable aliases to Softr field IDs.
+   * When provided, `data` keys are interpreted as aliases.
+   */
+  select?: Record<string, string>;
+  data: Record<string, unknown>;
+}
+//#endregion
+export { AggregationFunction, ChartDataOptions, ChartDataResult, CreateOptions, DatasourcePermissions, GetOptions, ListOptions, ListResult, MetricOptions, MetricResult, SoftrMe, SoftrPermissions, SoftrRecord, SoftrUser, UpdateOptions };

package/dist/vite.d.ts

@@ -1,26 +1,6 @@
-import "@tanstack/router-generator";
+import { Manifest, ManifestNode } from "./routes/manifest.js";
 import { PluginOption } from "vite";
 
-//#region src/routes/discover.d.ts
-
-type VisibilityValue = string | Array<VisibilityValue> | {
-  [key: string]: VisibilityValue;
-};
-//#endregion
-//#region src/routes/manifest.d.ts
-type ManifestNode = {
-  routePath: string;
-  filePath: string;
-  _fsRouteType?: string;
-  inferFullPath: string | null;
-  createFileRouteProps: Array<string>;
-  visibility: VisibilityValue | null;
-  children: Array<ManifestNode>;
-};
-type Manifest = {
-  root: ManifestNode;
-};
-//#endregion
 //#region src/vite.d.ts
 declare const MANIFEST_RELATIVE_PATH: string;
 /** Writes `<root>/dist/routes.json` and returns its path. Throws on a rule it cannot read. */