lemma-sdk 0.2.28 → 0.2.31

package/dist/react/useRecords.js

@@ -0,0 +1,146 @@
+import { useCallback, useEffect, useMemo, useState } from "react";
+import { normalizeError, resolvePodClient, stringifyComparable } from "./utils.js";
+export function useRecords({ client, podId, tableName, filters, sort, limit = 20, pageToken, offset, sortBy, order, params, enabled = true, autoLoad = true, }) {
+    const [records, setRecords] = useState([]);
+    const [total, setTotal] = useState(0);
+    const [nextPageToken, setNextPageToken] = useState(null);
+    const [isLoading, setIsLoading] = useState(false);
+    const [isLoadingMore, setIsLoadingMore] = useState(false);
+    const [error, setError] = useState(null);
+    const trimmedTableName = tableName.trim();
+    const isEnabled = enabled && trimmedTableName.length > 0;
+    const filtersKey = stringifyComparable(filters);
+    const sortKey = stringifyComparable(sort);
+    const paramsKey = stringifyComparable(params);
+    const stableFilters = useMemo(() => filters, [filtersKey]);
+    const stableSort = useMemo(() => sort, [sortKey]);
+    const stableParams = useMemo(() => params, [paramsKey]);
+    const refresh = useCallback(async (overrides = {}, signal) => {
+        if (!isEnabled) {
+            setRecords([]);
+            setTotal(0);
+            setNextPageToken(null);
+            setError(null);
+            setIsLoading(false);
+            return [];
+        }
+        setIsLoading(true);
+        setError(null);
+        try {
+            const scopedClient = resolvePodClient(client, podId);
+            const response = await scopedClient.records.list(trimmedTableName, {
+                filters: overrides.filters ?? stableFilters,
+                sort: overrides.sort ?? stableSort,
+                limit: overrides.limit ?? limit,
+                pageToken: overrides.pageToken ?? pageToken,
+                offset: overrides.offset ?? offset,
+                sortBy: overrides.sortBy ?? sortBy,
+                order: overrides.order ?? order,
+                params: overrides.params ?? stableParams,
+            });
+            if (signal?.aborted)
+                return [];
+            const nextRecords = (response.items ?? []);
+            setRecords(nextRecords);
+            setTotal(response.total ?? nextRecords.length);
+            setNextPageToken(response.next_page_token ?? null);
+            return nextRecords;
+        }
+        catch (refreshError) {
+            if (signal?.aborted)
+                return [];
+            const normalized = normalizeError(refreshError, "Failed to load records.");
+            setError(normalized);
+            return [];
+        }
+        finally {
+            if (!signal?.aborted)
+                setIsLoading(false);
+        }
+    }, [
+        client,
+        isEnabled,
+        limit,
+        offset,
+        order,
+        pageToken,
+        podId,
+        sortBy,
+        stableFilters,
+        stableParams,
+        stableSort,
+        trimmedTableName,
+    ]);
+    const loadMore = useCallback(async (overrides = {}) => {
+        if (!isEnabled || !nextPageToken || isLoading || isLoadingMore) {
+            return [];
+        }
+        setIsLoadingMore(true);
+        setError(null);
+        try {
+            const scopedClient = resolvePodClient(client, podId);
+            const response = await scopedClient.records.list(trimmedTableName, {
+                filters: stableFilters,
+                sort: stableSort,
+                limit: overrides.limit ?? limit,
+                pageToken: nextPageToken,
+                offset: overrides.offset,
+                sortBy: overrides.sortBy ?? sortBy,
+                order: overrides.order ?? order,
+                params: overrides.params ?? stableParams,
+            });
+            const moreRecords = (response.items ?? []);
+            setRecords((previous) => [...previous, ...moreRecords]);
+            setTotal(response.total ?? records.length + moreRecords.length);
+            setNextPageToken(response.next_page_token ?? null);
+            return moreRecords;
+        }
+        catch (loadError) {
+            const normalized = normalizeError(loadError, "Failed to load more records.");
+            setError(normalized);
+            return [];
+        }
+        finally {
+            setIsLoadingMore(false);
+        }
+    }, [client, isEnabled, isLoading, isLoadingMore, limit, nextPageToken, offset, order, podId, records.length, sortBy, stableFilters, stableParams, stableSort, trimmedTableName]);
+    useEffect(() => {
+        if (!isEnabled) {
+            setRecords([]);
+            setTotal(0);
+            setNextPageToken(null);
+            setError(null);
+            setIsLoading(false);
+            setIsLoadingMore(false);
+            return;
+        }
+        if (!autoLoad)
+            return;
+        const controller = new AbortController();
+        let cancelled = false;
+        (async () => {
+            try {
+                await refresh({}, controller.signal);
+            }
+            catch {
+                if (!cancelled) {
+                    setError(normalizeError(new Error("Failed to load records."), "Failed to load records."));
+                }
+            }
+        })();
+        return () => {
+            cancelled = true;
+            controller.abort();
+        };
+    }, [autoLoad, isEnabled, refresh]);
+    return useMemo(() => ({
+        records,
+        total,
+        nextPageToken,
+        isLoading,
+        isLoadingMore,
+        error,
+        refresh,
+        loadMore,
+    }), [error, isLoading, isLoadingMore, loadMore, nextPageToken, records, refresh, total]);
+}

package/dist/react/useRelatedRecords.d.ts

@@ -0,0 +1,43 @@
+import type { LemmaClient } from "../client.js";
+import type { Table } from "../types.js";
+export interface RelatedRecordsInclude {
+    foreignKey: string;
+    as?: string;
+    fields?: string[];
+}
+export interface RelatedRecordsResolvedInclude {
+    foreignKey: string;
+    relationKey: string;
+    relatedTable: string;
+    relatedColumn: string;
+    fields: string[];
+}
+export interface RelatedRecordsColumn {
+    key: string;
+    field: string;
+    label: string;
+    source: "base" | "related";
+    relationKey?: string;
+}
+export interface UseRelatedRecordsOptions {
+    client: LemmaClient;
+    podId?: string;
+    tableName: string;
+    baseFields?: string[];
+    include: RelatedRecordsInclude[];
+    limit?: number;
+    offset?: number;
+    enabled?: boolean;
+    autoLoad?: boolean;
+}
+export interface UseRelatedRecordsResult<TRow extends Record<string, unknown> = Record<string, unknown>> {
+    records: TRow[];
+    columns: RelatedRecordsColumn[];
+    sql: string;
+    includes: RelatedRecordsResolvedInclude[];
+    baseTable: Table | null;
+    isLoading: boolean;
+    error: Error | null;
+    refresh: () => Promise<TRow[]>;
+}
+export declare function useRelatedRecords<TRow extends Record<string, unknown> = Record<string, unknown>>({ client, podId, tableName, baseFields, include, limit, offset, enabled, autoLoad, }: UseRelatedRecordsOptions): UseRelatedRecordsResult<TRow>;

package/dist/react/useRelatedRecords.js

@@ -0,0 +1,239 @@
+import { useCallback, useEffect, useMemo, useState } from "react";
+import { buildJoinedRecordsQuery, parseForeignKeyReference } from "../datastore-query.js";
+import { normalizeError, resolvePodClient, stringifyComparable } from "./utils.js";
+function sentenceCase(value) {
+    return value
+        .replace(/[_\.]/g, " ")
+        .replace(/\s+/g, " ")
+        .trim()
+        .replace(/\b\w/g, (match) => match.toUpperCase());
+}
+function inferRelationKey(foreignKey, relatedTable) {
+    const stripped = foreignKey
+        .replace(/_id$/i, "")
+        .replace(/_uuid$/i, "")
+        .replace(/_fk$/i, "")
+        .trim();
+    return stripped.length > 0 ? stripped : relatedTable;
+}
+function pickDefaultBaseFields(table) {
+    const names = table.columns
+        .map((column) => column.name)
+        .filter((name) => name !== "created_at" && name !== "updated_at");
+    const prioritized = ["id", "name", "title", "label", "status", "type"];
+    const next = [];
+    prioritized.forEach((name) => {
+        if (names.includes(name) && !next.includes(name)) {
+            next.push(name);
+        }
+    });
+    names.forEach((name) => {
+        if (!next.includes(name)) {
+            next.push(name);
+        }
+    });
+    return next.slice(0, 5);
+}
+function pickDefaultRelatedFields(table, relatedColumn) {
+    const names = table.columns.map((column) => column.name);
+    const prioritized = ["id", "name", "title", "label", "email", "slug", relatedColumn];
+    const next = [];
+    prioritized.forEach((name) => {
+        if (names.includes(name) && !next.includes(name)) {
+            next.push(name);
+        }
+    });
+    if (next.length === 0 && names.length > 0) {
+        next.push(names[0]);
+    }
+    return next.slice(0, 3);
+}
+function readAliasedValue(record, prefix, field) {
+    return record[`${prefix}${field}`];
+}
+export function useRelatedRecords({ client, podId, tableName, baseFields, include, limit = 20, offset, enabled = true, autoLoad = true, }) {
+    const [records, setRecords] = useState([]);
+    const [columns, setColumns] = useState([]);
+    const [sql, setSql] = useState("");
+    const [includes, setIncludes] = useState([]);
+    const [baseTable, setBaseTable] = useState(null);
+    const [isLoading, setIsLoading] = useState(false);
+    const [error, setError] = useState(null);
+    const trimmedTableName = tableName.trim();
+    const includeKey = stringifyComparable(include);
+    const baseFieldsKey = stringifyComparable(baseFields);
+    const stableInclude = useMemo(() => include, [includeKey]);
+    const stableBaseFields = useMemo(() => baseFields, [baseFieldsKey]);
+    const isEnabled = enabled && trimmedTableName.length > 0 && stableInclude.length > 0;
+    const refresh = useCallback(async (signal) => {
+        if (!isEnabled) {
+            setRecords([]);
+            setColumns([]);
+            setSql("");
+            setIncludes([]);
+            setBaseTable(null);
+            setError(null);
+            setIsLoading(false);
+            return [];
+        }
+        setIsLoading(true);
+        setError(null);
+        try {
+            const scopedClient = resolvePodClient(client, podId);
+            const nextBaseTable = await scopedClient.tables.get(trimmedTableName);
+            if (signal?.aborted)
+                return [];
+            if (nextBaseTable.enable_rls) {
+                throw new Error(`Related record queries are not supported for RLS-enabled table "${trimmedTableName}". Use table-scoped record APIs instead.`);
+            }
+            setBaseTable(nextBaseTable);
+            const resolvedBaseFields = (stableBaseFields?.length ? stableBaseFields : pickDefaultBaseFields(nextBaseTable))
+                .filter((field, index, allFields) => field.trim().length > 0 && allFields.indexOf(field) === index);
+            const resolvedIncludes = await Promise.all(stableInclude.map(async (entry, index) => {
+                if (signal?.aborted)
+                    throw new Error("Aborted");
+                const baseColumn = nextBaseTable.columns.find((column) => column.name === entry.foreignKey) ?? null;
+                const reference = baseColumn?.foreign_key?.references
+                    ? parseForeignKeyReference(baseColumn.foreign_key.references)
+                    : null;
+                if (!baseColumn) {
+                    throw new Error(`Column "${entry.foreignKey}" was not found on table "${trimmedTableName}".`);
+                }
+                if (!reference) {
+                    throw new Error(`Column "${entry.foreignKey}" on "${trimmedTableName}" is not a foreign key.`);
+                }
+                const relatedTable = await scopedClient.tables.get(reference.table);
+                if (relatedTable.enable_rls) {
+                    throw new Error(`Related record queries cannot join into RLS-enabled table "${reference.table}". Use table-scoped record APIs instead.`);
+                }
+                const relationKey = entry.as?.trim() || inferRelationKey(entry.foreignKey, reference.table);
+                const relatedFields = (entry.fields?.length ? entry.fields : pickDefaultRelatedFields(relatedTable, reference.column))
+                    .filter((field, fieldIndex, allFields) => field.trim().length > 0 && allFields.indexOf(field) === fieldIndex);
+                if (relatedFields.length === 0) {
+                    throw new Error(`No display fields were resolved for relation "${entry.foreignKey}".`);
+                }
+                return {
+                    foreignKey: entry.foreignKey,
+                    relationKey,
+                    relatedTable: reference.table,
+                    relatedColumn: reference.column,
+                    fields: relatedFields,
+                    alias: `rel_${index}_${relationKey}`,
+                };
+            }));
+            const nextSql = buildJoinedRecordsQuery({
+                from: { table: trimmedTableName, alias: "base" },
+                select: [
+                    ...resolvedBaseFields.map((field) => ({
+                        table: "base",
+                        column: field,
+                        as: `base__${field}`,
+                    })),
+                    ...resolvedIncludes.flatMap((entry) => entry.fields.map((field) => ({
+                        table: entry.alias,
+                        column: field,
+                        as: `${entry.relationKey}__${field}`,
+                    }))),
+                ],
+                joins: resolvedIncludes.map((entry) => ({
+                    table: entry.relatedTable,
+                    alias: entry.alias,
+                    type: "left",
+                    on: {
+                        left: { table: "base", column: entry.foreignKey },
+                        right: { table: entry.alias, column: entry.relatedColumn },
+                    },
+                })),
+                limit,
+                offset,
+            });
+            setSql(nextSql);
+            setIncludes(resolvedIncludes.map(({ alias: _alias, ...rest }) => rest));
+            const response = await scopedClient.datastore.query(nextSql);
+            if (signal?.aborted)
+                return [];
+            const nextColumns = [
+                ...resolvedBaseFields.map((field) => ({
+                    key: field,
+                    field,
+                    label: sentenceCase(field),
+                    source: "base",
+                })),
+                ...resolvedIncludes.flatMap((entry) => entry.fields.map((field) => ({
+                    key: `${entry.relationKey}.${field}`,
+                    field,
+                    label: `${sentenceCase(entry.relationKey)} ${sentenceCase(field)}`,
+                    source: "related",
+                    relationKey: entry.relationKey,
+                }))),
+            ];
+            const nextRecords = (response.items ?? []).map((record) => {
+                const nextRecord = {};
+                resolvedBaseFields.forEach((field) => {
+                    nextRecord[field] = readAliasedValue(record, "base__", field);
+                });
+                resolvedIncludes.forEach((entry) => {
+                    nextRecord[entry.relationKey] = entry.fields.reduce((accumulator, field) => {
+                        accumulator[field] = readAliasedValue(record, `${entry.relationKey}__`, field);
+                        return accumulator;
+                    }, {});
+                });
+                return nextRecord;
+            });
+            setColumns(nextColumns);
+            setRecords(nextRecords);
+            return nextRecords;
+        }
+        catch (refreshError) {
+            if (signal?.aborted)
+                return [];
+            const normalized = normalizeError(refreshError, "Failed to load related records.");
+            setError(normalized);
+            return [];
+        }
+        finally {
+            if (!signal?.aborted)
+                setIsLoading(false);
+        }
+    }, [client, isEnabled, limit, offset, podId, stableBaseFields, stableInclude, trimmedTableName]);
+    useEffect(() => {
+        if (!isEnabled) {
+            setRecords([]);
+            setColumns([]);
+            setSql("");
+            setIncludes([]);
+            setBaseTable(null);
+            setError(null);
+            setIsLoading(false);
+            return;
+        }
+        if (!autoLoad)
+            return;
+        const controller = new AbortController();
+        let cancelled = false;
+        (async () => {
+            try {
+                await refresh(controller.signal);
+            }
+            catch {
+                if (!cancelled) {
+                    setError(normalizeError(new Error("Failed to load related records."), "Failed to load related records."));
+                }
+            }
+        })();
+        return () => {
+            cancelled = true;
+            controller.abort();
+        };
+    }, [autoLoad, isEnabled, refresh]);
+    return useMemo(() => ({
+        records,
+        columns,
+        sql,
+        includes,
+        baseTable,
+        isLoading,
+        error,
+        refresh,
+    }), [baseTable, columns, error, includes, isLoading, records, refresh, sql]);
+}

package/dist/react/useReverseRelatedRecords.d.ts

@@ -0,0 +1,47 @@
+import type { LemmaClient } from "../client.js";
+import type { Table } from "../types.js";
+export interface ReverseRelationSelector {
+    tableName: string;
+    foreignKey: string;
+}
+export interface ReverseRelatedRelation {
+    tableName: string;
+    foreignKey: string;
+    referencedColumn: string;
+    label: string;
+}
+export interface ReverseRelatedRecordsColumn {
+    key: string;
+    field: string;
+    label: string;
+}
+export interface UseReverseRelatedRecordsOptions {
+    client: LemmaClient;
+    podId?: string;
+    tableName: string;
+    recordId?: string | null;
+    relation?: ReverseRelationSelector | null;
+    fields?: string[];
+    limit?: number;
+    offset?: number;
+    sortBy?: string;
+    order?: "asc" | "desc" | string;
+    tablesLimit?: number;
+    enabled?: boolean;
+    autoLoad?: boolean;
+}
+export interface UseReverseRelatedRecordsResult<TRow extends Record<string, unknown> = Record<string, unknown>> {
+    parentTable: Table | null;
+    relatedTable: Table | null;
+    parentRecord: Record<string, unknown> | null;
+    relations: ReverseRelatedRelation[];
+    selectedRelation: ReverseRelatedRelation | null;
+    columns: ReverseRelatedRecordsColumn[];
+    records: TRow[];
+    total: number;
+    nextPageToken: string | null;
+    isLoading: boolean;
+    error: Error | null;
+    refresh: () => Promise<TRow[]>;
+}
+export declare function useReverseRelatedRecords<TRow extends Record<string, unknown> = Record<string, unknown>>({ client, podId, tableName, recordId, relation, fields, limit, offset, sortBy, order, tablesLimit, enabled, autoLoad, }: UseReverseRelatedRecordsOptions): UseReverseRelatedRecordsResult<TRow>;