@softr/sdk 0.0.12 → 0.0.14

package/dist/core/datasource.js

@@ -0,0 +1,221 @@
+import { buildFilterCriteria, buildOrderBy, dealiasFilterCriteria, dealiasOrderBy } from "./query.js";
+import { panic } from "../assertions.js";
+import { readUserTimezone } from "../cookies.js";
+import { sessionConfig } from "../auth/config.js";
+import { readSessionToken } from "../auth/session.js";
+
+//#region src/core/datasource.ts
+const MAX_RECORD_COUNT = 100;
+const COUNT_CNT = "COUNT_CNT";
+const dsUrl = (datasourceId) => {
+	const datasourceApiUrl = process.env.SOFTR_DATASOURCE_API_URL || "https://datasource-api-staging12.softr.io";
+	if (!datasourceApiUrl) panic("SOFTR_DATASOURCE_API_URL is not set.");
+	const { applicationId } = sessionConfig();
+	return `${withoutTrailingSlash(datasourceApiUrl)}/v1/datasource/vibe/applications/${applicationId}/datasources/${datasourceId}`;
+};
+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(`${dsUrl(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(`${dsUrl(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 rawFields = options.select ? dealiasData(options.data, options.select) : options.data;
+	const res = await fetch(`${dsUrl(datasourceId)}/records/new`, {
+		method: "POST",
+		headers: {
+			"Content-Type": "application/json",
+			"Authorization": `Bearer ${readSessionToken()}`
+		},
+		body: JSON.stringify({ fields: rawFields })
+	});
+	if (!res.ok) throw new Error(`Softr datasource create failed for "${datasourceId}": ${res.status}`);
+	const record = await res.json();
+	return options.select ? {
+		id: record.id,
+		fields: aliasFields(record.fields, options.select)
+	} : record;
+}
+async function updateRecord(datasourceId, options) {
+	if (!options.id) throw new Error(`Softr datasource update: id must not be empty`);
+	const rawFields = options.select ? dealiasData(options.data, options.select) : options.data;
+	const res = await fetch(`${dsUrl(datasourceId)}/records/${options.id}`, {
+		method: "PATCH",
+		headers: {
+			"Content-Type": "application/json",
+			"Authorization": `Bearer ${readSessionToken()}`
+		},
+		body: JSON.stringify({ fields: rawFields })
+	});
+	if (!res.ok) throw new Error(`Softr datasource update failed for "${datasourceId}": ${res.status}`);
+	const record = await res.json();
+	return options.select ? {
+		id: record.id,
+		fields: aliasFields(record.fields, options.select)
+	} : record;
+}
+async function deleteRecord(datasourceId, id) {
+	const res = await fetch(`${dsUrl(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(`${dsUrl(datasourceId)}/metric/data`, {
+		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(`${dsUrl(datasourceId)}/chart`, {
+		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;
+}
+function dealiasData(data, select) {
+	const result = {};
+	for (const [alias, value] of Object.entries(data)) result[select[alias] ?? alias] = value;
+	return result;
+}
+const ds = {
+	list: listRecords,
+	get: getRecord,
+	create: createRecord,
+	update: updateRecord,
+	delete: deleteRecord,
+	metric: getMetric,
+	chartData: getChartData
+};
+function withoutTrailingSlash(url) {
+	return url.replace(/\/+$/, "");
+}
+
+//#endregion
+export { ds };

package/dist/core/integration.d.ts

@@ -0,0 +1,7 @@
+//#region src/core/integration.d.ts
+declare function integrationFetch(integrationId: string, input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+declare const integration: {
+  fetch: typeof integrationFetch;
+};
+//#endregion
+export { integration };

package/dist/core/integration.js

@@ -0,0 +1,32 @@
+import { readSessionToken } from "../auth/session.js";
+
+//#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 { integration };

package/dist/{types-n-Sir_Y2.d.ts → core/query.d.ts}

@@ -351,132 +351,4 @@ declare const q: {
   desc(subject: string): ConstructableOrderBy;
 };
 //#endregion
-//#region src/auth/user.d.ts
-/**
- * Declare this interface in your app to narrow every group id the SDK takes and
- * returns. Without a declaration, a group id is a plain `string`.
- *
- * @example
- * declare module "@softr/sdk" {
- *   interface SoftrUserGroups {
- *     ids:
- *       | "b1f2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
- *       | "f9e8d7c6-5b4a-4938-8271-605f4e3d2c1b"
- *   }
- * }
- */
-interface SoftrUserGroups {}
-/** A Softr user group id, narrowed to your own ids if you declare {@link SoftrUserGroups}. */
-type SoftrUserGroupId = SoftrUserGroups extends {
-  ids: infer Id extends string;
-} ? Id : string;
-/** The signed-in visitor. */
-type User = {
-  id: string;
-  email: string;
-  name: string;
-  userGroupIds: Array<SoftrUserGroupId>;
-};
-//#endregion
-//#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 {
-  fields: Record<string, unknown>;
-}
-interface UpdateOptions {
-  id: string;
-  fields: Record<string, unknown>;
-}
-//#endregion
-export { SoftrUserGroups as _, DatasourcePermissions as a, ListResult as c, SoftrMe as d, SoftrPermissions as f, SoftrUserGroupId as g, UpdateOptions as h, CreateOptions as i, MetricOptions as l, SoftrUser as m, ChartDataOptions as n, GetOptions as o, SoftrRecord as p, ChartDataResult as r, ListOptions as s, AggregationFunction as t, MetricResult as u, User as v, q as y };
+export { AnyConstructable, ConstructableOrderBy, q };