@constructive-io/sdk 0.24.1 → 0.25.1

package/usage/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/usage/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/usage/orm/select-types.d.ts

@@ -0,0 +1,125 @@
+/**
+ * Type utilities for select inference
+ * @generated by @constructive-io/graphql-codegen
+ * DO NOT EDIT - changes will be overwritten
+ */
+export interface ConnectionResult<T> {
+    nodes: T[];
+    totalCount: number;
+    pageInfo: PageInfo;
+}
+export interface PageInfo {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    startCursor?: string | null;
+    endCursor?: string | null;
+}
+export interface FindManyArgs<TSelect, TWhere, TOrderBy> {
+    select?: TSelect;
+    where?: TWhere;
+    orderBy?: TOrderBy[];
+    first?: number;
+    last?: number;
+    after?: string;
+    before?: string;
+    offset?: number;
+}
+export interface FindFirstArgs<TSelect, TWhere, TOrderBy> {
+    select?: TSelect;
+    where?: TWhere;
+    orderBy?: TOrderBy[];
+}
+export interface CreateArgs<TSelect, TData> {
+    data: TData;
+    select?: TSelect;
+}
+export interface UpdateArgs<TSelect, TWhere, TData> {
+    where: TWhere;
+    data: TData;
+    select?: TSelect;
+}
+export type FindOneArgs<TSelect, TIdName extends string = 'id', TId = string> = {
+    select?: TSelect;
+} & Record<TIdName, TId>;
+export interface DeleteArgs<TWhere, TSelect = undefined> {
+    where: TWhere;
+    select?: TSelect;
+}
+export interface BulkInsertArgs<TSelect, TData, TOnConflict = unknown> {
+    data: TData[];
+    select?: TSelect;
+    onConflict?: TOnConflict;
+}
+export interface BulkUpsertArgs<TSelect, TData, TOnConflict = unknown> {
+    data: TData[];
+    select?: TSelect;
+    onConflict: TOnConflict;
+}
+export interface BulkUpdateArgs<TSelect, TWhere, TData> {
+    where: TWhere;
+    data: TData;
+    select?: TSelect;
+}
+export interface BulkDeleteArgs<TSelect, TWhere> {
+    where: TWhere;
+    select?: TSelect;
+}
+export interface BulkMutationResult<T> {
+    affectedCount: number;
+    returning: T[];
+}
+type DepthLevel = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+type DecrementDepth = {
+    0: 0;
+    1: 0;
+    2: 1;
+    3: 2;
+    4: 3;
+    5: 4;
+    6: 5;
+    7: 6;
+    8: 7;
+    9: 8;
+    10: 9;
+};
+/**
+ * Recursively validates select objects, rejecting unknown keys.
+ *
+ * NOTE: Depth is intentionally capped to avoid circular-instantiation issues
+ * in very large cyclic schemas.
+ */
+export type DeepExact<T, Shape, Depth extends DepthLevel = 10> = Depth extends 0 ? T extends Shape ? T : never : T extends Shape ? Exclude<keyof T, keyof Shape> extends never ? {
+    [K in keyof T]: K extends keyof Shape ? T[K] extends {
+        select: infer NS;
+    } ? Extract<Shape[K], {
+        select?: unknown;
+    }> extends {
+        select?: infer ShapeNS;
+    } ? DeepExact<Omit<T[K], 'select'> & {
+        select: DeepExact<NS, NonNullable<ShapeNS>, DecrementDepth[Depth]>;
+    }, Extract<Shape[K], {
+        select?: unknown;
+    }>, DecrementDepth[Depth]> : never : T[K] : never;
+} : never : never;
+/**
+ * Enforces exact select shape while keeping contextual typing on `S extends XxxSelect`.
+ * Use this as an intersection in overloads:
+ * `{ select: S } & StrictSelect<S, XxxSelect>`.
+ */
+export type StrictSelect<S, Shape> = S extends DeepExact<S, Shape> ? {} : never;
+/**
+ * Hook-optimized strict select variant.
+ *
+ * Uses a shallower recursion depth to keep editor autocomplete responsive
+ * in large schemas while still validating common nested-select mistakes.
+ */
+export type HookStrictSelect<S, Shape> = S extends DeepExact<S, Shape, 5> ? {} : never;
+/**
+ * Infer result type from select configuration
+ */
+export type InferSelectResult<TEntity, TSelect> = TSelect extends undefined ? TEntity : {
+    [K in keyof TSelect as TSelect[K] extends false | undefined ? never : K]: TSelect[K] extends true ? K extends keyof TEntity ? TEntity[K] : never : TSelect[K] extends {
+        select: infer NestedSelect;
+    } ? K extends keyof TEntity ? NonNullable<TEntity[K]> extends ConnectionResult<infer NodeType> ? ConnectionResult<InferSelectResult<NodeType, NestedSelect>> : InferSelectResult<NonNullable<TEntity[K]>, NestedSelect> | (null extends TEntity[K] ? null : never) : never : K extends keyof TEntity ? TEntity[K] : never;
+};
+export {};

package/usage/orm/select-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/usage/orm/types.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Types re-export
+ * @generated by @constructive-io/graphql-codegen
+ * DO NOT EDIT - changes will be overwritten
+ */
+export * from './input-types';

package/usage/orm/types.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Types re-export
+ * @generated by @constructive-io/graphql-codegen
+ * DO NOT EDIT - changes will be overwritten
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Re-export all types from input-types
+__exportStar(require("./input-types"), exports);

package/esm/objects/orm/query/index.d.ts

@@ -1,69 +0,0 @@
-/**
- * Custom query operations
- * @generated by @constructive-io/graphql-codegen
- * DO NOT EDIT - changes will be overwritten
- */
-import { OrmClient } from '../client';
-import { QueryBuilder } from '../query-builder';
-import type { InferSelectResult, StrictSelect } from '../select-types';
-import type { Object, ObjectSelect, ObjectConnection } from '../input-types';
-export interface RevParseVariables {
-    dbId?: string;
-    storeId?: string;
-    refname?: string;
-}
-export interface GetAllObjectsFromRootVariables {
-    databaseId?: string;
-    id?: string;
-    /** Only read the first `n` values of the set. */
-    first?: number;
-    /**
-     * Skip the first `n` values from our `after` cursor, an alternative to cursor
-     * based pagination. May not be used with `last`.
-     */
-    offset?: number;
-    /** Read all values in the set after (below) this cursor. */
-    after?: string;
-}
-export interface GetPathObjectsFromRootVariables {
-    databaseId?: string;
-    id?: string;
-    path?: string[];
-    /** Only read the first `n` values of the set. */
-    first?: number;
-    /**
-     * Skip the first `n` values from our `after` cursor, an alternative to cursor
-     * based pagination. May not be used with `last`.
-     */
-    offset?: number;
-    /** Read all values in the set after (below) this cursor. */
-    after?: string;
-}
-export interface GetObjectAtPathVariables {
-    dbId?: string;
-    storeId?: string;
-    path?: string[];
-    refname?: string;
-}
-export declare function createQueryOperations(client: OrmClient): {
-    revParse: (args: RevParseVariables, options?: {
-        select?: Record<string, unknown>;
-    }) => QueryBuilder<{
-        revParse: string | null;
-    }>;
-    getAllObjectsFromRoot: (args: GetAllObjectsFromRootVariables, options?: {
-        select?: Record<string, unknown>;
-    }) => QueryBuilder<{
-        getAllObjectsFromRoot: ObjectConnection | null;
-    }>;
-    getPathObjectsFromRoot: (args: GetPathObjectsFromRootVariables, options?: {
-        select?: Record<string, unknown>;
-    }) => QueryBuilder<{
-        getPathObjectsFromRoot: ObjectConnection | null;
-    }>;
-    getObjectAtPath: <S extends ObjectSelect>(args: GetObjectAtPathVariables, options: {
-        select: S;
-    } & StrictSelect<S, ObjectSelect>) => QueryBuilder<{
-        getObjectAtPath: InferSelectResult<Object, S> | null;
-    }>;
-};

package/esm/objects/orm/query/index.js

@@ -1,110 +0,0 @@
-import { QueryBuilder, buildCustomDocument } from '../query-builder';
-import { connectionFieldsMap } from '../input-types';
-export function createQueryOperations(client) {
-    return {
-        revParse: (args, options) => new QueryBuilder({
-            client,
-            operation: 'query',
-            operationName: 'RevParse',
-            fieldName: 'revParse',
-            ...buildCustomDocument('query', 'RevParse', 'revParse', options?.select, args, [
-                {
-                    name: 'dbId',
-                    type: 'UUID',
-                },
-                {
-                    name: 'storeId',
-                    type: 'UUID',
-                },
-                {
-                    name: 'refname',
-                    type: 'String',
-                },
-            ], connectionFieldsMap, undefined),
-        }),
-        getAllObjectsFromRoot: (args, options) => new QueryBuilder({
-            client,
-            operation: 'query',
-            operationName: 'GetAllObjectsFromRoot',
-            fieldName: 'getAllObjectsFromRoot',
-            ...buildCustomDocument('query', 'GetAllObjectsFromRoot', 'getAllObjectsFromRoot', options?.select, args, [
-                {
-                    name: 'databaseId',
-                    type: 'UUID',
-                },
-                {
-                    name: 'id',
-                    type: 'UUID',
-                },
-                {
-                    name: 'first',
-                    type: 'Int',
-                },
-                {
-                    name: 'offset',
-                    type: 'Int',
-                },
-                {
-                    name: 'after',
-                    type: 'Cursor',
-                },
-            ], connectionFieldsMap, undefined),
-        }),
-        getPathObjectsFromRoot: (args, options) => new QueryBuilder({
-            client,
-            operation: 'query',
-            operationName: 'GetPathObjectsFromRoot',
-            fieldName: 'getPathObjectsFromRoot',
-            ...buildCustomDocument('query', 'GetPathObjectsFromRoot', 'getPathObjectsFromRoot', options?.select, args, [
-                {
-                    name: 'databaseId',
-                    type: 'UUID',
-                },
-                {
-                    name: 'id',
-                    type: 'UUID',
-                },
-                {
-                    name: 'path',
-                    type: '[String]',
-                },
-                {
-                    name: 'first',
-                    type: 'Int',
-                },
-                {
-                    name: 'offset',
-                    type: 'Int',
-                },
-                {
-                    name: 'after',
-                    type: 'Cursor',
-                },
-            ], connectionFieldsMap, undefined),
-        }),
-        getObjectAtPath: (args, options) => new QueryBuilder({
-            client,
-            operation: 'query',
-            operationName: 'GetObjectAtPath',
-            fieldName: 'getObjectAtPath',
-            ...buildCustomDocument('query', 'GetObjectAtPath', 'getObjectAtPath', options.select, args, [
-                {
-                    name: 'dbId',
-                    type: 'UUID',
-                },
-                {
-                    name: 'storeId',
-                    type: 'UUID',
-                },
-                {
-                    name: 'path',
-                    type: '[String]',
-                },
-                {
-                    name: 'refname',
-                    type: 'String',
-                },
-            ], connectionFieldsMap, 'Object'),
-        }),
-    };
-}