@constructive-io/react 0.18.7 → 0.18.9

package/public/orm/realtime.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Realtime Manager - WebSocket subscription support
+ * @generated by @constructive-io/graphql-codegen
+ * DO NOT EDIT - changes will be overwritten
+ */
+interface WsGraphQLError {
+    readonly message: string;
+    readonly [key: string]: unknown;
+}
+interface WsExecutionResult<TData = Record<string, unknown>> {
+    data?: TData | null;
+    errors?: readonly WsGraphQLError[];
+    extensions?: Record<string, unknown>;
+}
+interface WsSink<T> {
+    next(value: T): void;
+    error(error: unknown): void;
+    complete(): void;
+}
+/**
+ * Minimal interface matching the graphql-ws Client.
+ * Consumers pass a concrete instance via RealtimeConfig.client.
+ */
+export interface WsClient {
+    subscribe<TData = Record<string, unknown>>(payload: {
+        query: string;
+        variables?: Record<string, unknown>;
+    }, sink: WsSink<WsExecutionResult<TData>>): () => void;
+    dispose(): void;
+}
+/** The DML operation that triggered the subscription event */
+export type SubscriptionOperation = 'INSERT' | 'UPDATE' | 'DELETE';
+/** Connection state of the WebSocket */
+export type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 'reconnecting';
+/** Listener for connection state changes */
+export type ConnectionStateListener = (state: ConnectionState) => void;
+/** Function returned by subscribe() to cancel the subscription */
+export type Unsubscribe = () => void;
+/**
+ * A realtime subscription event delivered to the client.
+ *
+ * @typeParam T - The row type of the subscribed table
+ */
+export interface SubscriptionEvent<T> {
+    /** The DML operation that triggered this event */
+    operation: SubscriptionOperation;
+    /** The current row data (null for DELETE if row is no longer visible) */
+    data: T | null;
+    /** Previous field values (populated on UPDATE when available) */
+    previousValues?: Partial<T>;
+    /** Server-side timestamp of when the change occurred */
+    timestamp: string;
+}
+/**
+ * Options for creating a subscription.
+ *
+ * @typeParam T - The row type of the subscribed table
+ * @typeParam TFilter - The filter type for the table
+ */
+export interface SubscribeOptions<T, TFilter = Record<string, unknown>> {
+    /** Server-side filter to limit which events are delivered */
+    filter?: TFilter;
+    /** Called when a subscription event is received */
+    onEvent: (event: SubscriptionEvent<T>) => void;
+    /** Called when the subscription encounters an error */
+    onError?: (error: Error) => void;
+    /** Called when the subscription completes (server-initiated close) */
+    onComplete?: () => void;
+}
+/**
+ * Metadata about a subscription field, used internally to map
+ * table names to GraphQL subscription field names and types.
+ */
+export interface SubscriptionFieldMeta {
+    /** The GraphQL subscription field name (e.g., 'onContactChanged') */
+    fieldName: string;
+    /** The table name in the source schema (e.g., 'contact') */
+    tableName: string;
+    /** The data field name inside the subscription payload (e.g., 'contact') */
+    dataFieldName: string;
+}
+/**
+ * Configuration for the realtime (WebSocket) connection.
+ * Pass this as the `realtime` option in OrmClientConfig.
+ *
+ * @example
+ * ```ts
+ * import { createClient } from 'graphql-ws';
+ *
+ * const client = createOrmClient({
+ *   endpoint: 'https://api.example.com/graphql',
+ *   realtime: {
+ *     client: createClient({ url: 'wss://api.example.com/graphql' }),
+ *   },
+ * });
+ * ```
+ */
+export interface RealtimeConfig {
+    /**
+     * A graphql-ws Client instance (or any object satisfying WsClient).
+     * The consumer creates this themselves, giving full control over
+     * connection options, auth, and transport.
+     *
+     * @example
+     * ```ts
+     * import { createClient } from 'graphql-ws';
+     * const wsClient = createClient({ url: 'wss://...' });
+     * ```
+     */
+    client: WsClient;
+}
+/**
+ * Manages a graphql-ws WebSocket client and multiplexes
+ * subscriptions over it. Created by OrmClient when `realtime`
+ * config is provided.
+ */
+export declare class RealtimeManager {
+    private wsClient;
+    private connectionState;
+    private stateListeners;
+    private activeSubscriptions;
+    constructor(config: RealtimeConfig);
+    /**
+     * Subscribe to a GraphQL subscription operation.
+     * Models call this with typed metadata and documents.
+     */
+    subscribe<T>(meta: SubscriptionFieldMeta, document: string, variables: Record<string, unknown>, options: {
+        onEvent: (event: SubscriptionEvent<T>) => void;
+        onError?: (error: Error) => void;
+        onComplete?: () => void;
+    }): Unsubscribe;
+    /** Register a listener for connection state changes */
+    onConnectionStateChange(listener: ConnectionStateListener): Unsubscribe;
+    /** Get current connection state */
+    getConnectionState(): ConnectionState;
+    /** Number of active subscriptions */
+    getActiveSubscriptionCount(): number;
+    /** Dispose the manager and close the WebSocket connection */
+    dispose(): void;
+    private setConnectionState;
+}
+export {};

package/public/orm/realtime.js

@@ -0,0 +1,104 @@
+"use strict";
+/**
+ * Realtime Manager - WebSocket subscription support
+ * @generated by @constructive-io/graphql-codegen
+ * DO NOT EDIT - changes will be overwritten
+ */
+// Minimal type shims so this module compiles without graphql-ws
+// installed.  Consumers supply a WsClient via RealtimeConfig;
+// the SDK itself never imports or requires graphql-ws.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RealtimeManager = void 0;
+// ============================================================================
+// RealtimeManager
+// ============================================================================
+/**
+ * Manages a graphql-ws WebSocket client and multiplexes
+ * subscriptions over it. Created by OrmClient when `realtime`
+ * config is provided.
+ */
+class RealtimeManager {
+    wsClient;
+    connectionState = 'disconnected';
+    stateListeners = new Set();
+    activeSubscriptions = 0;
+    constructor(config) {
+        this.wsClient = config.client;
+    }
+    /**
+     * Subscribe to a GraphQL subscription operation.
+     * Models call this with typed metadata and documents.
+     */
+    subscribe(meta, document, variables, options) {
+        this.activeSubscriptions++;
+        let disposed = false;
+        const cleanup = this.wsClient.subscribe({ query: document, variables }, {
+            next: (result) => {
+                if (disposed)
+                    return;
+                if (result.errors) {
+                    options.onError?.(new Error(result.errors.map((e) => e.message).join('; ')));
+                    return;
+                }
+                const payload = result.data?.[meta.fieldName];
+                if (!payload)
+                    return;
+                const event = {
+                    operation: payload.event ?? 'UPDATE',
+                    data: payload[meta.dataFieldName] ?? null,
+                    previousValues: payload.previousValues,
+                    timestamp: payload.timestamp ?? new Date().toISOString(),
+                };
+                options.onEvent(event);
+            },
+            error: (err) => {
+                if (disposed)
+                    return;
+                options.onError?.(err instanceof Error ? err : new Error(String(err)));
+            },
+            complete: () => {
+                if (disposed)
+                    return;
+                options.onComplete?.();
+            },
+        });
+        return () => {
+            if (disposed)
+                return;
+            disposed = true;
+            this.activeSubscriptions--;
+            cleanup();
+        };
+    }
+    /** Register a listener for connection state changes */
+    onConnectionStateChange(listener) {
+        this.stateListeners.add(listener);
+        return () => {
+            this.stateListeners.delete(listener);
+        };
+    }
+    /** Get current connection state */
+    getConnectionState() {
+        return this.connectionState;
+    }
+    /** Number of active subscriptions */
+    getActiveSubscriptionCount() {
+        return this.activeSubscriptions;
+    }
+    /** Dispose the manager and close the WebSocket connection */
+    dispose() {
+        this.wsClient.dispose();
+        this.stateListeners.clear();
+        this.activeSubscriptions = 0;
+        this.setConnectionState('disconnected');
+    }
+    setConnectionState(state) {
+        if (this.connectionState === state)
+            return;
+        this.connectionState = state;
+        for (const listener of this.stateListeners) {
+            listener(state);
+        }
+    }
+}
+exports.RealtimeManager = RealtimeManager;

package/public/schema-types.d.ts

@@ -8541,11 +8541,6 @@ export interface SetFieldOrderInput {
     clientMutationId?: string;
     fieldIds?: string[];
 }
-export interface AppendSmartTagsInput {
-    clientMutationId?: string;
-    pTableId?: string;
-    pTags?: unknown;
-}
 export interface ProvisionUniqueConstraintInput {
     clientMutationId?: string;
     databaseId?: string;
@@ -17255,9 +17250,6 @@ export interface BootstrapUserPayload {
 export interface SetFieldOrderPayload {
     clientMutationId?: string | null;
 }
-export interface AppendSmartTagsPayload {
-    clientMutationId?: string | null;
-}
 export interface ProvisionUniqueConstraintPayload {
     clientMutationId?: string | null;
 }

package/esm/public/hooks/mutations/useAppendSmartTagsMutation.d.ts

@@ -1,20 +0,0 @@
-/**
- * Custom mutation hook for appendSmartTags
- * @generated by @constructive-io/graphql-codegen
- * DO NOT EDIT - changes will be overwritten
- */
-import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
-import type { AppendSmartTagsVariables } from '../../orm/mutation';
-import type { AppendSmartTagsPayloadSelect, AppendSmartTagsPayload } from '../../orm/input-types';
-import type { InferSelectResult, HookStrictSelect } from '../../orm/select-types';
-export type { AppendSmartTagsVariables } from '../../orm/mutation';
-export type { AppendSmartTagsPayloadSelect } from '../../orm/input-types';
-export declare function useAppendSmartTagsMutation<S extends AppendSmartTagsPayloadSelect>(params: {
-    selection: {
-        fields: S & AppendSmartTagsPayloadSelect;
-    } & HookStrictSelect<NoInfer<S>, AppendSmartTagsPayloadSelect>;
-} & Omit<UseMutationOptions<{
-    appendSmartTags: InferSelectResult<AppendSmartTagsPayload, S> | null;
-}, Error, AppendSmartTagsVariables>, 'mutationFn'>): UseMutationResult<{
-    appendSmartTags: InferSelectResult<AppendSmartTagsPayload, S> | null;
-}, Error, AppendSmartTagsVariables>;

package/esm/public/hooks/mutations/useAppendSmartTagsMutation.js

@@ -1,23 +0,0 @@
-/**
- * Custom mutation hook for appendSmartTags
- * @generated by @constructive-io/graphql-codegen
- * DO NOT EDIT - changes will be overwritten
- */
-import { useMutation } from '@tanstack/react-query';
-import { getClient } from '../client';
-import { buildSelectionArgs } from '../selection';
-import { customMutationKeys } from '../mutation-keys';
-export function useAppendSmartTagsMutation(params) {
-    const args = buildSelectionArgs(params.selection);
-    const { selection: _selection, ...mutationOptions } = params ?? {};
-    void _selection;
-    return useMutation({
-        mutationKey: customMutationKeys.appendSmartTags(),
-        mutationFn: (variables) => getClient()
-            .mutation.appendSmartTags(variables, {
-            select: args.select,
-        })
-            .unwrap(),
-        ...mutationOptions,
-    });
-}

package/public/hooks/mutations/useAppendSmartTagsMutation.d.ts

@@ -1,20 +0,0 @@
-/**
- * Custom mutation hook for appendSmartTags
- * @generated by @constructive-io/graphql-codegen
- * DO NOT EDIT - changes will be overwritten
- */
-import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
-import type { AppendSmartTagsVariables } from '../../orm/mutation';
-import type { AppendSmartTagsPayloadSelect, AppendSmartTagsPayload } from '../../orm/input-types';
-import type { InferSelectResult, HookStrictSelect } from '../../orm/select-types';
-export type { AppendSmartTagsVariables } from '../../orm/mutation';
-export type { AppendSmartTagsPayloadSelect } from '../../orm/input-types';
-export declare function useAppendSmartTagsMutation<S extends AppendSmartTagsPayloadSelect>(params: {
-    selection: {
-        fields: S & AppendSmartTagsPayloadSelect;
-    } & HookStrictSelect<NoInfer<S>, AppendSmartTagsPayloadSelect>;
-} & Omit<UseMutationOptions<{
-    appendSmartTags: InferSelectResult<AppendSmartTagsPayload, S> | null;
-}, Error, AppendSmartTagsVariables>, 'mutationFn'>): UseMutationResult<{
-    appendSmartTags: InferSelectResult<AppendSmartTagsPayload, S> | null;
-}, Error, AppendSmartTagsVariables>;

package/public/hooks/mutations/useAppendSmartTagsMutation.js

@@ -1,26 +0,0 @@
-"use strict";
-/**
- * Custom mutation hook for appendSmartTags
- * @generated by @constructive-io/graphql-codegen
- * DO NOT EDIT - changes will be overwritten
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAppendSmartTagsMutation = useAppendSmartTagsMutation;
-const react_query_1 = require("@tanstack/react-query");
-const client_1 = require("../client");
-const selection_1 = require("../selection");
-const mutation_keys_1 = require("../mutation-keys");
-function useAppendSmartTagsMutation(params) {
-    const args = (0, selection_1.buildSelectionArgs)(params.selection);
-    const { selection: _selection, ...mutationOptions } = params ?? {};
-    void _selection;
-    return (0, react_query_1.useMutation)({
-        mutationKey: mutation_keys_1.customMutationKeys.appendSmartTags(),
-        mutationFn: (variables) => (0, client_1.getClient)()
-            .mutation.appendSmartTags(variables, {
-            select: args.select,
-        })
-            .unwrap(),
-        ...mutationOptions,
-    });
-}