@softr/sdk 0.0.25 → 0.0.26-alpha-0

package/dist/core/datasource.js

@@ -1,226 +0,0 @@
-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";
-import { assertResponseOk } from "./utils.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;
-	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
-			}
-		})
-	});
-	await assertResponseOk(res, `Softr datasource list failed for "${datasourceId}"`);
-	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" } })
-		});
-		await assertResponseOk(res, `Softr datasource get failed for "${datasourceId}"`);
-		const contentLength = res.headers.get("Content-Length");
-		if (contentLength && parseInt(contentLength, 10) === 0) return null;
-		const record = await res.json();
-		return {
-			id: record.id,
-			fields: options.select ? aliasFields(record.fields, options.select) : record.fields
-		};
-	}
-	return (await listRecords(datasourceId, {
-		where: options.where,
-		select: options.select,
-		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 })
-	});
-	await assertResponseOk(res, `Softr datasource create failed for "${datasourceId}"`);
-	const record = await res.json();
-	return {
-		id: record.id,
-		fields: options.select ? aliasFields(record.fields, options.select) : record.fields
-	};
-}
-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 })
-	});
-	await assertResponseOk(res, `Softr datasource update failed for "${datasourceId}"`);
-	const record = await res.json();
-	return {
-		id: record.id,
-		fields: options.select ? aliasFields(record.fields, options.select) : record.fields
-	};
-}
-async function deleteRecord(datasourceId, id) {
-	await assertResponseOk(await fetch(`${dsUrl(datasourceId)}/records/${id}`, {
-		method: "DELETE",
-		headers: { "Authorization": `Bearer ${readSessionToken()}` }
-	}), `Softr datasource delete failed for "${datasourceId}"`);
-}
-async function getMetric(datasourceId, options) {
-	const { select, where, aggregation, field } = options;
-	if (aggregation !== "COUNT" && !field) throw new Error(`field is required for aggregation "${aggregation}"`);
-	const fieldId = field ? select?.[field] ?? field : void 0;
-	const filterCriteria = where ? dealiasFilterCriteria(buildFilterCriteria(where), select ?? {}) : {};
-	const res = await fetch(`${dsUrl(datasourceId)}/chart/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" },
-			groupBy: [],
-			metrics: [{
-				field: fieldId,
-				aggregation
-			}],
-			filterCriteria
-		})
-	});
-	await assertResponseOk(res, `Softr datasource metric failed for "${datasourceId}"`);
-	const payload = await res.json();
-	const executionTimestamp = /* @__PURE__ */ new Date(payload.executionTimestamp * 1e3);
-	let value;
-	const responseKey = aggregation === "COUNT" && !fieldId ? COUNT_CNT : fieldId;
-	value = payload.data.find((item) => responseKey in item)?.[responseKey] ?? null;
-	return {
-		value,
-		executionTimestamp
-	};
-}
-async function getChart(datasourceId, options) {
-	const { select, where, groupBy, metrics, orderBy } = options;
-	const filterCriteria = where ? dealiasFilterCriteria(buildFilterCriteria(where), select ?? {}) : {};
-	const sortingOptions = orderBy ? dealiasOrderBy(buildOrderBy(orderBy), select ?? {}) : 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
-	}));
-	if (!yAxisFields.length) throw new Error("chart requires at least one metric");
-	const res = await fetch(`${dsUrl(datasourceId)}/chart/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" },
-			filterCriteria,
-			sortingOptions,
-			groupBy: groupByFields,
-			metrics: yAxisFields
-		})
-	});
-	await assertResponseOk(res, `Softr datasource chart failed for "${datasourceId}"`);
-	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,
-	chart: getChart
-};
-function withoutTrailingSlash(url) {
-	return url.replace(/\/+$/, "");
-}
-
-//#endregion
-export { ds, dsUrl };

package/dist/core/query.d.ts

@@ -1,354 +0,0 @@
-//#region src/core/query.d.ts
-
-type LogicalOperator = "AND" | "OR";
-type FilterOperator = "IS" | "IS_NOT" | "EQUAL" | "NOT_EQUAL" | "IS_EMPTY" | "IS_NOT_EMPTY" | "IS_ONE_OF" | "IS_NONE_OF" | "HAS_ALL_OF" | "HAS_ONE_OF" | "HAS_NONE_OF" | "CONTAINS" | "INLINE_CONTAINS" | "GT" | "LT" | "GTE" | "LTE" | "BETWEEN" | "IS_NOT_BETWEEN" | "DOES_NOT_CONTAINS" | "STARTS_WITH" | "ENDS_WITH";
-type ConditionFieldType = "TEXT" | "BOOLEAN" | "NUMERIC" | "ARRAY" | "DATE";
-interface Filter {
-  subject: string;
-  operator: FilterOperator;
-  value?: unknown;
-  type: ConditionFieldType;
-}
-type ConstructableFilter = Filter & {
-  [INTERNAL_KIND]: "FILTER";
-};
-type ConstructableFilterGroup = {
-  logicalOperator: LogicalOperator;
-  filters: Array<ConstructableFilter | ConstructableFilterGroup>;
-  [INTERNAL_KIND]: "LOGICAL_GROUP";
-};
-interface SortingOptionItem {
-  sortingField: string;
-  sortType: "ASC" | "DESC";
-}
-type ConstructableOrderBy = SortingOptionItem & {
-  [INTERNAL_KIND]: "ORDER_BY";
-};
-type AnyConstructable = ConstructableFilter | ConstructableFilterGroup;
-declare const INTERNAL_KIND: unique symbol;
-/**
- * Query builder for filter queries. This exist to alleviate the (LLM?) mental overhead. API filter schema is a bit
- * verbose and confusing, even when dealing with very basic queries. So to fall into the pit of success, aim here
- * is to simplify filtering as much as possible.
- *
- * @example
- * single filter
- * ```tsx
- * const query = q.text("title").contains("hello");
- *
- * const json = buildFilterCriteria(query);
- * // result
- * {
- *   "filterCriteria": {
- *     "filterConditionGroup": {
- *       "logicalOperator": "AND"
- *       "filterGroups": [{
- *         "logicalOperator": "AND",
- *         "filters": [{
- *           "subject": "title",
- *           "type": "TEXT",
- *           "operator": "CONTAINS",
- *           "value": "hello"
- *         }],
- *       }]
- *     }
- *   }
- *  }
- *
- * ```
- *
- * @example
- * combining multiple filters
- * ```tsx
- * const query = q.and(
- *   q.text("title").contains("hello"),
- *   q.number("views").is(100),
- *   q.or(
- *     q.text("author").is("John"),
- *     q.boolean("isPublished").is(true)
- *   )
- * );
- * ```
- */
-declare const q: {
-  select<T extends Record<string, string>>(mapping: T): T;
-  and(...filters: AnyConstructable[]): ConstructableFilterGroup;
-  or(...filters: AnyConstructable[]): ConstructableFilterGroup;
-  text(subject: string): {
-    is(value: string): {
-      operator: "IS";
-      value: string;
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNot(value: string): {
-      operator: "IS_NOT";
-      value: string;
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    contains(value: string): {
-      operator: "CONTAINS";
-      value: string;
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isOneOf(value: string[]): {
-      operator: "IS_ONE_OF";
-      value: string[];
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNoneOf(value: string[]): {
-      operator: "IS_NONE_OF";
-      value: string[];
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    startsWith(value: string): {
-      operator: "STARTS_WITH";
-      value: string;
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    endsWith(value: string): {
-      operator: "ENDS_WITH";
-      value: string;
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    hasAllOf(value: string[]): {
-      operator: "HAS_ALL_OF";
-      value: string[];
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isEmpty(): {
-      operator: "IS_EMPTY";
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNotEmpty(): {
-      operator: "IS_NOT_EMPTY";
-      subject: string;
-      type: "TEXT";
-      [INTERNAL_KIND]: "FILTER";
-    };
-  };
-  boolean(subject: string): {
-    is(value: boolean): {
-      operator: "IS";
-      value: boolean;
-      subject: string;
-      type: "BOOLEAN";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNot(value: boolean): {
-      operator: "IS_NOT";
-      value: boolean;
-      subject: string;
-      type: "BOOLEAN";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isEmpty(): {
-      operator: "IS_EMPTY";
-      subject: string;
-      type: "BOOLEAN";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNotEmpty(): {
-      operator: "IS_NOT_EMPTY";
-      subject: string;
-      type: "BOOLEAN";
-      [INTERNAL_KIND]: "FILTER";
-    };
-  };
-  number(subject: string): {
-    is(value: number): {
-      operator: "IS";
-      value: string;
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNot(value: number): {
-      operator: "IS_NOT";
-      value: string;
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    gt(value: number): {
-      operator: "GT";
-      value: string;
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    gte(value: number): {
-      operator: "GTE";
-      value: string;
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    lt(value: number): {
-      operator: "LT";
-      value: string;
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    lte(value: number): {
-      operator: "LTE";
-      value: string;
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    between(start: number, end: number): {
-      operator: "BETWEEN";
-      value: string[];
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isEmpty(): {
-      operator: "IS_EMPTY";
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNotEmpty(): {
-      operator: "IS_NOT_EMPTY";
-      subject: string;
-      type: "NUMERIC";
-      [INTERNAL_KIND]: "FILTER";
-    };
-  };
-  array(subject: string): {
-    is(value: string[]): {
-      operator: "IS";
-      value: string[];
-      subject: string;
-      type: "ARRAY";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isOneOf(value: string[]): {
-      operator: "IS_ONE_OF";
-      value: string[];
-      subject: string;
-      type: "ARRAY";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNoneOf(value: string[]): {
-      operator: "IS_NONE_OF";
-      value: string[];
-      subject: string;
-      type: "ARRAY";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    hasAllOf(value: string[]): {
-      operator: "HAS_ALL_OF";
-      value: string[];
-      subject: string;
-      type: "ARRAY";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isEmpty(): {
-      operator: "IS_EMPTY";
-      subject: string;
-      type: "ARRAY";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNotEmpty(): {
-      operator: "IS_NOT_EMPTY";
-      subject: string;
-      type: "ARRAY";
-      [INTERNAL_KIND]: "FILTER";
-    };
-  };
-  date(subject: string): {
-    is(value: string): {
-      operator: "IS";
-      value: string;
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNot(value: string): {
-      operator: "IS_NOT";
-      value: string;
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    gt(value: string): {
-      operator: "GT";
-      value: string;
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    gte(value: string): {
-      operator: "GTE";
-      value: string;
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    lt(value: string): {
-      operator: "LT";
-      value: string;
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    lte(value: string): {
-      operator: "LTE";
-      value: string;
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    between(start: string, end: string): {
-      operator: "BETWEEN";
-      value: string[];
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNotBetween(start: string, end: string): {
-      operator: "IS_NOT_BETWEEN";
-      value: string[];
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isEmpty(): {
-      operator: "IS_EMPTY";
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-    isNotEmpty(): {
-      operator: "IS_NOT_EMPTY";
-      subject: string;
-      type: "DATE";
-      [INTERNAL_KIND]: "FILTER";
-    };
-  };
-  asc(subject: string): ConstructableOrderBy;
-  desc(subject: string): ConstructableOrderBy;
-};
-//#endregion
-export { AnyConstructable, ConstructableOrderBy, q };