@ontahi/react 1.0.0-alpha.11 → 1.0.0-alpha.13

package/dist/graph/semantic-invalidation.js

@@ -0,0 +1,55 @@
+'use client';
+import { mayAffectGraphRead, } from '@ontahi/core/data-graph';
+export const ONTAHI_GRAPH_READ_META_KEY = 'ontahi.graphRead';
+export const withCanonicalGraphReadMeta = (meta, request, lifecycle = 'once') => ({
+    ...meta,
+    [ONTAHI_GRAPH_READ_META_KEY]: { kind: 'canonical', request, lifecycle },
+});
+export const withUnknownGraphReadMeta = (meta, lifecycle = 'once') => ({
+    ...meta,
+    [ONTAHI_GRAPH_READ_META_KEY]: { kind: 'unknown', lifecycle },
+});
+export const getCanonicalGraphReadFromMeta = (meta) => {
+    const dependency = meta?.[ONTAHI_GRAPH_READ_META_KEY];
+    return dependency &&
+        typeof dependency === 'object' &&
+        'kind' in dependency &&
+        dependency.kind === 'canonical' &&
+        'request' in dependency
+        ? dependency.request
+        : undefined;
+};
+export const invalidateSemanticGraphReads = async (queryClient, committed, options) => {
+    const affected = queryClient
+        .getQueryCache()
+        .findAll()
+        .flatMap(query => {
+        const dependency = query.meta?.[ONTAHI_GRAPH_READ_META_KEY];
+        if (dependency &&
+            typeof dependency === 'object' &&
+            'lifecycle' in dependency &&
+            dependency.lifecycle === 'live' &&
+            query.state.fetchStatus === 'fetching') {
+            // Its observation already receives committed revisions from the runtime. Restarting the
+            // query here would create a second subscription and a redundant initial snapshot.
+            return [];
+        }
+        if (dependency &&
+            typeof dependency === 'object' &&
+            'kind' in dependency &&
+            dependency.kind === 'unknown') {
+            return committed.mutations.length > 0 ? [{ queryKey: query.queryKey }] : [];
+        }
+        const read = getCanonicalGraphReadFromMeta(query.meta);
+        return read && committed.mutations.some(mutation => mayAffectGraphRead(mutation, read))
+            ? [{ queryKey: query.queryKey, request: read }]
+            : [];
+    });
+    const queryKeys = affected.map(item => item.queryKey);
+    if (options?.causedBy && options.associateRefreshes) {
+        options.associateRefreshes(affected.flatMap(item => (item.request ? [item.request] : [])), options.causedBy);
+    }
+    await Promise.all(queryKeys.map(queryKey => queryClient.invalidateQueries({ queryKey, exact: true })));
+    return { queryKeys };
+};
+//# sourceMappingURL=semantic-invalidation.js.map

package/dist/graph/semantic-invalidation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic-invalidation.js","sourceRoot":"","sources":["../../src/graph/semantic-invalidation.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EACL,kBAAkB,GAGnB,MAAM,yBAAyB,CAAC;AAIjC,MAAM,CAAC,MAAM,0BAA0B,GAAG,kBAA2B,CAAC;AAwBtE,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,IAA2B,EAC3B,OAAyB,EACzB,YAA6B,MAAM,EACd,EAAE,CAAC,CAAC;IACzB,GAAG,IAAI;IACP,CAAC,0BAA0B,CAAC,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE;CACxE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,IAA2B,EAC3B,YAA6B,MAAM,EACd,EAAE,CAAC,CAAC;IACzB,GAAG,IAAI;IACP,CAAC,0BAA0B,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE;CAC7D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,IAA2B,EACG,EAAE;IAChC,MAAM,UAAU,GAAG,IAAI,EAAE,CAAC,0BAA0B,CAAC,CAAC;IACtD,OAAO,UAAU;QACf,OAAO,UAAU,KAAK,QAAQ;QAC9B,MAAM,IAAI,UAAU;QACpB,UAAU,CAAC,IAAI,KAAK,WAAW;QAC/B,SAAS,IAAI,UAAU;QACvB,CAAC,CAAE,UAAU,CAAC,OAA4B;QAC1C,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,KAAK,EAC/C,WAAwB,EACxB,SAA+B,EAC/B,OAA8C,EACN,EAAE;IAC1C,MAAM,QAAQ,GACZ,WAAW;SACR,aAAa,EAAE;SACf,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC,EAAE;QACf,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,0BAA0B,CAAC,CAAC;QAC5D,IACE,UAAU;YACV,OAAO,UAAU,KAAK,QAAQ;YAC9B,WAAW,IAAI,UAAU;YACzB,UAAU,CAAC,SAAS,KAAK,MAAM;YAC/B,KAAK,CAAC,KAAK,CAAC,WAAW,KAAK,UAAU,EACtC,CAAC;YACD,wFAAwF;YACxF,kFAAkF;YAClF,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IACE,UAAU;YACV,OAAO,UAAU,KAAK,QAAQ;YAC9B,MAAM,IAAI,UAAU;YACpB,UAAU,CAAC,IAAI,KAAK,SAAS,EAC7B,CAAC;YACD,OAAO,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9E,CAAC;QACD,MAAM,IAAI,GAAG,6BAA6B,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvD,OAAO,IAAI,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACrF,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC/C,CAAC,CAAC,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IACP,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE,QAAQ,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACpD,OAAO,CAAC,kBAAkB,CACxB,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAC9D,OAAO,CAAC,QAAQ,CACjB,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CACf,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CACpF,CAAC;IAEF,OAAO,EAAE,SAAS,EAAE,CAAC;AACvB,CAAC,CAAC","sourcesContent":["'use client';\n\nimport {\n  mayAffectGraphRead,\n  type CommittedMutationSet,\n  type GraphReadRequest,\n} from '@ontahi/core/data-graph';\nimport type { RuntimeProtocolGraphRefreshCause } from '@ontahi/core/runtime/protocol';\nimport type { QueryClient, QueryKey, QueryMeta } from '@tanstack/react-query';\n\nexport const ONTAHI_GRAPH_READ_META_KEY = 'ontahi.graphRead' as const;\n\ntype OntahiGraphReadMeta = QueryMeta & {\n  readonly [ONTAHI_GRAPH_READ_META_KEY]:\n    | {\n        readonly kind: 'canonical';\n        readonly request: GraphReadRequest;\n        readonly lifecycle: 'once' | 'live';\n      }\n    | { readonly kind: 'unknown'; readonly lifecycle: 'once' | 'live' };\n};\n\nexport type SemanticGraphReadInvalidation = {\n  readonly queryKeys: readonly QueryKey[];\n};\n\nexport type SemanticGraphReadInvalidationOptions = {\n  readonly causedBy?: RuntimeProtocolGraphRefreshCause;\n  readonly associateRefreshes?: (\n    requests: readonly GraphReadRequest[],\n    causedBy: RuntimeProtocolGraphRefreshCause,\n  ) => void;\n};\n\nexport const withCanonicalGraphReadMeta = (\n  meta: QueryMeta | undefined,\n  request: GraphReadRequest,\n  lifecycle: 'once' | 'live' = 'once',\n): OntahiGraphReadMeta => ({\n  ...meta,\n  [ONTAHI_GRAPH_READ_META_KEY]: { kind: 'canonical', request, lifecycle },\n});\n\nexport const withUnknownGraphReadMeta = (\n  meta: QueryMeta | undefined,\n  lifecycle: 'once' | 'live' = 'once',\n): OntahiGraphReadMeta => ({\n  ...meta,\n  [ONTAHI_GRAPH_READ_META_KEY]: { kind: 'unknown', lifecycle },\n});\n\nexport const getCanonicalGraphReadFromMeta = (\n  meta: QueryMeta | undefined,\n): GraphReadRequest | undefined => {\n  const dependency = meta?.[ONTAHI_GRAPH_READ_META_KEY];\n  return dependency &&\n    typeof dependency === 'object' &&\n    'kind' in dependency &&\n    dependency.kind === 'canonical' &&\n    'request' in dependency\n    ? (dependency.request as GraphReadRequest)\n    : undefined;\n};\n\nexport const invalidateSemanticGraphReads = async (\n  queryClient: QueryClient,\n  committed: CommittedMutationSet,\n  options?: SemanticGraphReadInvalidationOptions,\n): Promise<SemanticGraphReadInvalidation> => {\n  const affected: Array<{ readonly queryKey: QueryKey; readonly request?: GraphReadRequest }> =\n    queryClient\n      .getQueryCache()\n      .findAll()\n      .flatMap(query => {\n        const dependency = query.meta?.[ONTAHI_GRAPH_READ_META_KEY];\n        if (\n          dependency &&\n          typeof dependency === 'object' &&\n          'lifecycle' in dependency &&\n          dependency.lifecycle === 'live' &&\n          query.state.fetchStatus === 'fetching'\n        ) {\n          // Its observation already receives committed revisions from the runtime. Restarting the\n          // query here would create a second subscription and a redundant initial snapshot.\n          return [];\n        }\n        if (\n          dependency &&\n          typeof dependency === 'object' &&\n          'kind' in dependency &&\n          dependency.kind === 'unknown'\n        ) {\n          return committed.mutations.length > 0 ? [{ queryKey: query.queryKey }] : [];\n        }\n        const read = getCanonicalGraphReadFromMeta(query.meta);\n        return read && committed.mutations.some(mutation => mayAffectGraphRead(mutation, read))\n          ? [{ queryKey: query.queryKey, request: read }]\n          : [];\n      });\n  const queryKeys = affected.map(item => item.queryKey);\n  if (options?.causedBy && options.associateRefreshes) {\n    options.associateRefreshes(\n      affected.flatMap(item => (item.request ? [item.request] : [])),\n      options.causedBy,\n    );\n  }\n\n  await Promise.all(\n    queryKeys.map(queryKey => queryClient.invalidateQueries({ queryKey, exact: true })),\n  );\n\n  return { queryKeys };\n};\n"]}

package/dist/graph/websocket-runtime-transport.d.ts

@@ -0,0 +1,32 @@
+import { type DurableOperationObservationCapability, type EventObservationCapability, type GraphObservationCapability, type RuntimeTransport } from '@ontahi/core/runtime/protocol';
+type WebSocketEvent = {
+    readonly data?: unknown;
+    readonly code?: number;
+    readonly reason?: string;
+};
+export type RuntimeWebSocket = {
+    readonly readyState: number;
+    send(data: string): void;
+    close(code?: number, reason?: string): void;
+    addEventListener(type: string, listener: (event: WebSocketEvent) => void): void;
+    removeEventListener(type: string, listener: (event: WebSocketEvent) => void): void;
+};
+export type WebSocketRuntimeTransportOptions = {
+    readonly url?: string;
+    readonly protocols?: string | string[];
+    readonly createWebSocket?: (url: string, protocols?: string | string[]) => RuntimeWebSocket;
+    readonly observationId?: () => string;
+    readonly handshakeTimeoutMs?: number;
+    /** Delay before restoring a durable Operation observation after a lost session. */
+    readonly reconnectDelayMs?: number;
+    readonly reportError?: (error: Error) => void;
+};
+export type WebSocketRuntimeTransport = RuntimeTransport<never> & {
+    readonly durableOperation: DurableOperationObservationCapability;
+    readonly graph: GraphObservationCapability<never>;
+    readonly events: EventObservationCapability<never>;
+    close(): void;
+};
+export declare const createWebSocketRuntimeTransport: ({ url, protocols, createWebSocket, observationId, handshakeTimeoutMs, reconnectDelayMs, reportError, }?: WebSocketRuntimeTransportOptions) => WebSocketRuntimeTransport;
+export {};
+//# sourceMappingURL=websocket-runtime-transport.d.ts.map

package/dist/graph/websocket-runtime-transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-runtime-transport.d.ts","sourceRoot":"","sources":["../../src/graph/websocket-runtime-transport.ts"],"names":[],"mappings":"AAGA,OAAO,EAKL,KAAK,qCAAqC,EAC1C,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAK/B,KAAK,gBAAgB,EAEtB,MAAM,+BAA+B,CAAC;AAGvC,KAAK,cAAc,GAAG;IACpB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI,CAAC;IAChF,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI,CAAC;CACpF,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACvC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,gBAAgB,CAAC;IAC5F,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,MAAM,CAAC;IACtC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,mFAAmF;IACnF,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG;IAChE,QAAQ,CAAC,gBAAgB,EAAE,qCAAqC,CAAC;IACjE,QAAQ,CAAC,KAAK,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACnD,KAAK,IAAI,IAAI,CAAC;CACf,CAAC;AAkJF,eAAO,MAAM,+BAA+B,GAAI,yGAQ7C,gCAAqC,KAAG,yBA2iB1C,CAAC"}