@object-ui/react 17.5.0 → 17.7.0

package/dist/hooks/useClientNotifications.js

@@ -1,162 +0,0 @@
-/**
- * ObjectUI
- * Copyright (c) 2024-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-/**
- * @object-ui/react - useClientNotifications
- *
- * Bridge hook between the @objectstack/client notifications API
- * and the local NotificationContext state. Fetches server-side
- * notifications and surfaces them through the existing provider.
- *
- * ADR-0030 (Notification Convergence): the `client.notifications.*` helpers
- * are the stable transport contract — the server routes them to the L5
- * `sys_inbox_message` materialization and the `sys_notification_receipt`
- * read-state spine (the re-modeled `sys_notification` L2 event carries no
- * recipient/read columns). This hook only needs to call the SDK with its
- * current signatures: `list(options)`, `markRead(ids[])`, `markAllRead()`.
- *
- * The former registerDevice/getPreferences/updatePreferences delegates were
- * removed (objectstack#3612): the SDK deleted those methods because the
- * /notifications/devices and /notifications/preferences server routes were
- * never built — every call was a guaranteed error. They return when the
- * server side exists.
- */
-import { useCallback, useContext, useEffect, useRef, useState } from 'react';
-import { SchemaRendererContext } from '../context/SchemaRendererContext';
-import { useNotifications } from '../context/NotificationContext';
-/* ------------------------------------------------------------------ */
-/*  Helpers                                                           */
-/* ------------------------------------------------------------------ */
-/** Normalise severity coming from the server into a valid local level. */
-function toSeverity(value) {
-    const valid = ['info', 'success', 'warning', 'error'];
-    if (typeof value === 'string' && valid.includes(value)) {
-        return value;
-    }
-    return 'info';
-}
-/**
- * Resolve the ObjectStack client from explicit option or SchemaRendererContext.
- *
- * The dataSource stored in context is typically an ObjectStackAdapter which
- * exposes `getClient()`.  When the caller passes a client directly we use
- * that instead.
- */
-function useResolvedClient(explicit) {
-    const rendererCtx = useContext(SchemaRendererContext);
-    if (explicit)
-        return explicit;
-    const dataSource = rendererCtx?.dataSource;
-    if (dataSource && typeof dataSource.getClient === 'function') {
-        return dataSource.getClient();
-    }
-    return null;
-}
-/* ------------------------------------------------------------------ */
-/*  Hook                                                              */
-/* ------------------------------------------------------------------ */
-/**
- * Bridge between the `@objectstack/client` notifications API and the
- * local {@link NotificationContext}.
- *
- * The hook resolves the ObjectStack client either from the explicit
- * `client` option or from the `SchemaRendererContext` dataSource, then
- * delegates to `client.notifications.*` methods.  Fetched notifications
- * are fed into the local provider via `useNotifications().notify()`.
- *
- * @example
- * ```tsx
- * function NotificationBell() {
- *   const { fetchNotifications, loading } = useClientNotifications({
- *     autoFetch: true,
- *     pollInterval: 30_000,
- *   });
- *
- *   return <Button onClick={fetchNotifications} disabled={loading}>🔔</Button>;
- * }
- * ```
- */
-export function useClientNotifications(options = {}) {
-    const { client: explicitClient, autoFetch = false, pollInterval = 0 } = options;
-    const client = useResolvedClient(explicitClient);
-    const { notify, markAsRead: localMarkAsRead } = useNotifications();
-    const [loading, setLoading] = useState(false);
-    const [error, setError] = useState(null);
-    // Track IDs that have already been pushed into the local context so we
-    // don't add duplicates on subsequent fetches / polls.
-    const seenIdsRef = useRef(new Set());
-    /* ---- fetchNotifications ---- */
-    const fetchNotifications = useCallback(async () => {
-        if (!client?.notifications)
-            return;
-        setLoading(true);
-        setError(null);
-        try {
-            const result = await client.notifications.list({});
-            const items = Array.isArray(result) ? result : result?.data ?? result?.items ?? [];
-            for (const item of items) {
-                const id = String(item.id ?? '');
-                if (!id || seenIdsRef.current.has(id))
-                    continue;
-                seenIdsRef.current.add(id);
-                notify({
-                    title: item.title ?? 'Notification',
-                    message: item.message ?? item.body,
-                    severity: toSeverity(item.severity ?? item.level),
-                    duration: 0, // server-driven notifications are persistent
-                });
-            }
-        }
-        catch (err) {
-            setError(err instanceof Error ? err : new Error('Failed to fetch notifications'));
-        }
-        finally {
-            setLoading(false);
-        }
-    }, [client, notify]);
-    /* ---- markAsRead (server + local) ---- */
-    const markAsRead = useCallback(async (id) => {
-        // Optimistically mark locally first
-        localMarkAsRead(id);
-        if (!client?.notifications)
-            return;
-        setError(null);
-        try {
-            // ADR-0030 / @objectstack/client v7+: the SDK exposes `markRead(ids[])`
-            // (batch) — there is no single-id `markAsRead`. Server-side this writes
-            // the `read` state to the `sys_notification_receipt` spine. We keep the
-            // friendly single-id hook API and adapt to the batch call.
-            await client.notifications.markRead([id]);
-        }
-        catch (err) {
-            const wrapped = err instanceof Error ? err : new Error('Failed to mark as read');
-            setError(wrapped);
-            throw wrapped;
-        }
-    }, [client, localMarkAsRead]);
-    /* ---- auto-fetch on mount ---- */
-    useEffect(() => {
-        if (autoFetch && client?.notifications) {
-            fetchNotifications();
-        }
-    }, [autoFetch, client, fetchNotifications]);
-    /* ---- polling ---- */
-    useEffect(() => {
-        if (!pollInterval || pollInterval <= 0 || !client?.notifications)
-            return;
-        const id = setInterval(() => {
-            fetchNotifications();
-        }, pollInterval);
-        return () => clearInterval(id);
-    }, [pollInterval, client, fetchNotifications]);
-    return {
-        fetchNotifications,
-        markAsRead,
-        loading,
-        error,
-    };
-}

package/dist/spec-bridge/SpecBridge.d.ts

@@ -1,28 +0,0 @@
-/**
- * ObjectUI
- * Copyright (c) 2024-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import type { BaseSchema } from '@object-ui/types';
-import type { BridgeContext, BridgeFn } from './types';
-export declare class SpecBridge {
-    private bridges;
-    private context;
-    constructor(context?: BridgeContext);
-    register(specType: string, bridge: BridgeFn): void;
-    /**
-     * Transform a spec schema into a schema node tree.
-     *
-     * Returns `BaseSchema` rather than `SchemaNode` — see {@link BridgeFn} for
-     * the ruling (objectui#4580 Q4-B) and the measurement behind it. A registered
-     * bridge always produces an object; the union only made callers narrow.
-     */
-    transform(specType: string, spec: any): BaseSchema;
-    /** Transform a ListView spec */
-    transformListView(spec: any): BaseSchema;
-    /** Transform a FormView spec */
-    transformFormView(spec: any): BaseSchema;
-    updateContext(ctx: Partial<BridgeContext>): void;
-}

package/dist/spec-bridge/SpecBridge.js

@@ -1,56 +0,0 @@
-/**
- * ObjectUI
- * Copyright (c) 2024-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import { bridgeListView } from './bridges/list-view';
-import { bridgeFormView } from './bridges/form-view';
-export class SpecBridge {
-    constructor(context = {}) {
-        Object.defineProperty(this, "bridges", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
-        Object.defineProperty(this, "context", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.context = context;
-        this.register('list', bridgeListView);
-        this.register('form', bridgeFormView);
-    }
-    register(specType, bridge) {
-        this.bridges.set(specType, bridge);
-    }
-    /**
-     * Transform a spec schema into a schema node tree.
-     *
-     * Returns `BaseSchema` rather than `SchemaNode` — see {@link BridgeFn} for
-     * the ruling (objectui#4580 Q4-B) and the measurement behind it. A registered
-     * bridge always produces an object; the union only made callers narrow.
-     */
-    transform(specType, spec) {
-        const bridge = this.bridges.get(specType);
-        if (!bridge) {
-            throw new Error(`No bridge registered for spec type: ${specType}`);
-        }
-        return bridge(spec, this.context);
-    }
-    /** Transform a ListView spec */
-    transformListView(spec) {
-        return this.transform('list', spec);
-    }
-    /** Transform a FormView spec */
-    transformFormView(spec) {
-        return this.transform('form', spec);
-    }
-    updateContext(ctx) {
-        this.context = { ...this.context, ...ctx };
-    }
-}

package/dist/spec-bridge/bridges/form-view.d.ts

@@ -1,82 +0,0 @@
-/**
- * ObjectUI
- * Copyright (c) 2024-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import type { BridgeFn } from '../types';
-interface FormField {
-    field: string;
-    /** Field type (spec FormFieldSchema reuses Data.FieldType; auto-infers widget). */
-    type?: string;
-    /** Options for select/multiselect/radio/checkboxes fields. */
-    options?: any[];
-    /** Target object name for lookup/master_detail fields. */
-    reference?: string;
-    label?: string;
-    placeholder?: string;
-    helpText?: string;
-    readonly?: boolean;
-    required?: boolean;
-    hidden?: boolean;
-    colSpan?: number;
-    widget?: string;
-    dependsOn?: string[];
-    /** Canonical conditional-visibility predicate (ADR-0089). */
-    visibleWhen?: string;
-    /** @deprecated ADR-0089 → `visibleWhen`. */
-    visibleOn?: string;
-}
-interface FormSection {
-    /** Stable section identifier for i18n lookup (spec FormSectionSchema.name). */
-    name?: string;
-    label?: string;
-    description?: string;
-    collapsible?: boolean;
-    collapsed?: boolean;
-    columns?: number;
-    /** Section-level conditional-visibility predicate (ADR-0089). */
-    visibleWhen?: string;
-    fields?: FormField[];
-}
-/**
- * The subset of `@objectstack/spec` FormViewSchema the bridge consumes.
- * Every serializable spec key is either mapped onto the `object-form` node
- * or listed here with an explicit reason for being ignored — the bridge must
- * never silently drop spec configuration (#2545).
- */
-interface FormViewSpec {
-    type?: string;
-    layout?: string;
-    columns?: number;
-    title?: string;
-    description?: string;
-    defaultTab?: string;
-    tabPosition?: string;
-    allowSkip?: boolean;
-    showStepIndicator?: boolean;
-    splitDirection?: string;
-    splitSize?: number;
-    splitResizable?: boolean;
-    drawerSide?: string;
-    drawerWidth?: string;
-    modalSize?: string;
-    data?: any;
-    sections?: FormSection[];
-    /** Legacy alias of `sections` (spec: "Legacy support → alias to sections"). */
-    groups?: FormSection[];
-    /** Inline master-detail child collections. */
-    subforms?: any[];
-    defaultSort?: any;
-    sharing?: any;
-    aria?: {
-        ariaLabel?: string;
-        ariaDescribedBy?: string;
-        role?: string;
-    };
-    submitBehavior?: any;
-}
-/** Transforms a FormView spec into a Form SchemaNode */
-export declare const bridgeFormView: BridgeFn<FormViewSpec>;
-export {};

package/dist/spec-bridge/bridges/form-view.js

@@ -1,126 +0,0 @@
-/**
- * ObjectUI
- * Copyright (c) 2024-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-function mapField(field) {
-    const mapped = {
-        name: field.field,
-        label: field.label ?? field.field,
-    };
-    if (field.type)
-        mapped.type = field.type;
-    if (field.options)
-        mapped.options = field.options;
-    if (field.reference)
-        mapped.reference = field.reference;
-    if (field.placeholder)
-        mapped.placeholder = field.placeholder;
-    if (field.helpText)
-        mapped.helpText = field.helpText;
-    if (field.readonly != null)
-        mapped.readonly = field.readonly;
-    if (field.required != null)
-        mapped.required = field.required;
-    if (field.hidden != null)
-        mapped.hidden = field.hidden;
-    if (field.colSpan != null)
-        mapped.colSpan = field.colSpan;
-    if (field.widget)
-        mapped.widget = field.widget;
-    if (field.dependsOn)
-        mapped.dependsOn = field.dependsOn;
-    // ADR-0089: `visibleWhen` is the canonical view-form-field visibility predicate
-    // (the spec folds the deprecated `visibleOn` into it at parse). Prefer it and
-    // fall back to `visibleOn` for raw / un-normalized metadata. The ObjectForm
-    // renderer reads this view-level predicate from the node's `visibleOn` slot.
-    const visiblePredicate = field.visibleWhen ?? field.visibleOn;
-    if (visiblePredicate)
-        mapped.visibleOn = visiblePredicate;
-    return mapped;
-}
-function mapSection(section) {
-    const mapped = {
-        fields: (section.fields ?? []).map(mapField),
-    };
-    if (section.name)
-        mapped.name = section.name;
-    if (section.label)
-        mapped.label = section.label;
-    if (section.description)
-        mapped.description = section.description;
-    if (section.collapsible != null)
-        mapped.collapsible = section.collapsible;
-    if (section.collapsed != null)
-        mapped.collapsed = section.collapsed;
-    if (section.columns != null)
-        mapped.columns = section.columns;
-    if (section.visibleWhen)
-        mapped.visibleWhen = section.visibleWhen;
-    return mapped;
-}
-/** Maps spec formType to ObjectUI formType */
-function mapFormType(type) {
-    if (!type)
-        return undefined;
-    const validTypes = ['simple', 'tabbed', 'wizard', 'split', 'drawer', 'modal'];
-    return validTypes.includes(type) ? type : undefined;
-}
-/**
- * Spec FormViewSchema keys carried onto the `object-form` node verbatim.
- * All of them are declared with the same name (and semantics) on
- * `ObjectFormSchema`, so no per-key mapping is needed — only presence checks.
- */
-const PASSTHROUGH_KEYS = [
-    'layout',
-    'columns',
-    'title',
-    'description',
-    'defaultTab',
-    'tabPosition',
-    'allowSkip',
-    'showStepIndicator',
-    'splitDirection',
-    'splitSize',
-    'splitResizable',
-    'drawerSide',
-    'drawerWidth',
-    'modalSize',
-    'subforms',
-];
-/** Transforms a FormView spec into a Form SchemaNode */
-export const bridgeFormView = (spec, _context) => {
-    // Spec defines `groups` as a legacy alias of `sections`; normalize here so
-    // downstream renderers only ever see `sections` (ObjectForm never reads a
-    // `groups` key — before this normalization a groups-only spec silently
-    // rendered no sections at all, #2545).
-    const sections = (spec.sections ?? spec.groups ?? []).map(mapSection);
-    const formType = mapFormType(spec.type);
-    const node = {
-        type: 'object-form',
-        id: `form-${spec.type ?? 'default'}`,
-        sections,
-        data: spec.data,
-    };
-    // P1.2 — formType mapping (tabbed, wizard, split, drawer, modal)
-    if (formType)
-        node.formType = formType;
-    // #2545 — same-name spec keys (layout, title, tab/wizard/split/drawer/modal
-    // options, subforms) pass straight through onto the node.
-    for (const key of PASSTHROUGH_KEYS) {
-        if (spec[key] != null)
-            node[key] = spec[key];
-    }
-    if (spec.defaultSort)
-        node.defaultSort = spec.defaultSort;
-    if (spec.submitBehavior)
-        node.submitBehavior = spec.submitBehavior;
-    // P1.6 — i18n & ARIA
-    if (spec.sharing)
-        node.sharing = spec.sharing;
-    if (spec.aria)
-        node.aria = spec.aria;
-    return node;
-};

package/dist/spec-bridge/bridges/list-view.d.ts

@@ -1,20 +0,0 @@
-/**
- * ObjectUI
- * Copyright (c) 2024-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import type { BridgeFn } from '../types';
-import type { ListView } from '@objectstack/spec/ui';
-/**
- * Bridge input: the spec-canonical ListView (#2231 — the former hand-written
- * `ListViewSpec`/`ListColumn` mirrors are retired; the shape now derives from
- * `@objectstack/spec/ui` and can no longer drift). Relaxed to `Partial` because
- * hosts routinely hand the bridge fragmentary view-configs (every field was
- * optional in the old mirror too, including spec-required `columns`).
- */
-type ListViewSpec = Partial<ListView>;
-/** Transforms a ListView spec into a DataTable SchemaNode */
-export declare const bridgeListView: BridgeFn<ListViewSpec>;
-export {};