houdini 1.1.7 → 1.2.0-next.1

package/build/runtime-cjs/cache/stuff.js

@@ -21,7 +21,7 @@ __export(stuff_exports, {
   evaluateKey: () => evaluateKey
 });
 module.exports = __toCommonJS(stuff_exports);
-function evaluateKey(key, variables = {}) {
+function evaluateKey(key, variables = null) {
   let evaluated = "";
   let varName = "";
   let inString = false;
@@ -31,7 +31,7 @@ function evaluateKey(key, variables = {}) {
         varName += char;
         continue;
       }
-      const value = variables[varName.slice(1)];
+      const value = variables?.[varName.slice(1)];
       evaluated += typeof value !== "undefined" ? JSON.stringify(value) : "undefined";
       varName = "";
     }

package/build/runtime-cjs/cache/subscription.js

@@ -40,7 +40,7 @@ class InMemorySubscriptions {
     parentType
   }) {
     const __typename = this.cache._internal_unstable.storage.get(parent, "__typename").value;
-    let targetSelection = (0, import_selection.getFieldsForType)(selection, __typename);
+    let targetSelection = (0, import_selection.getFieldsForType)(selection, __typename, false);
     for (const fieldSelection of Object.values(targetSelection || {})) {
       const {
         keyRaw,
@@ -57,7 +57,7 @@ class InMemorySubscriptions {
       let targetSelection2;
       if (innerSelection) {
         const __typename2 = this.cache._internal_unstable.storage.get(parent, "__typename").value;
-        targetSelection2 = (0, import_selection.getFieldsForType)(innerSelection, __typename2);
+        targetSelection2 = (0, import_selection.getFieldsForType)(innerSelection, __typename2, false);
       }
       this.addFieldSubscription({
         id: parent,
@@ -168,7 +168,7 @@ class InMemorySubscriptions {
           filters
         } = selection;
         const key = (0, import_stuff.evaluateKey)(keyRaw, variables);
-        const fieldSelection = innerSelection ? (0, import_selection.getFieldsForType)(innerSelection, parentType) : void 0;
+        const fieldSelection = innerSelection ? (0, import_selection.getFieldsForType)(innerSelection, parentType, false) : void 0;
         this.addFieldSubscription({
           id: parent,
           key,
@@ -198,7 +198,7 @@ class InMemorySubscriptions {
               linkedRecord,
               "__typename"
             ).value;
-            let targetSelection2 = (0, import_selection.getFieldsForType)(childSelection, __typename);
+            let targetSelection2 = (0, import_selection.getFieldsForType)(childSelection, __typename, false);
             this.addMany({
               parent: linkedRecord,
               variables,
@@ -217,7 +217,7 @@ class InMemorySubscriptions {
     visited.push(id);
     const linkedIDs = [];
     const __typename = this.cache._internal_unstable.storage.get(id, "__typename").value;
-    let targetSelection = (0, import_selection.getFieldsForType)(selection, __typename);
+    let targetSelection = (0, import_selection.getFieldsForType)(selection, __typename, false);
     for (const fieldSelection of Object.values(targetSelection || {})) {
       const key = (0, import_stuff.evaluateKey)(fieldSelection.keyRaw, variables);
       this.removeSubscribers(id, key, targets);

package/build/runtime-cjs/client/documentStore.d.ts

@@ -2,9 +2,12 @@ import type { HoudiniClient } from '.';
 import type { Layer } from '../cache/storage';
 import type { ConfigFile } from '../lib/config';
 import { Writable } from '../lib/store';
-import type { DocumentArtifact, QueryResult, GraphQLObject, SubscriptionSpec, CachePolicies } from '../lib/types';
-export declare class DocumentStore<_Data extends GraphQLObject, _Input extends Record<string, any>> extends Writable<QueryResult<_Data, _Input>> {
+import type { DocumentArtifact, QueryResult, GraphQLObject, SubscriptionSpec, CachePolicies, GraphQLVariables } from '../lib/types';
+export declare class DocumentStore<_Data extends GraphQLObject, _Input extends GraphQLVariables> extends Writable<QueryResult<_Data, _Input>> {
     #private;
+    pendingPromise: {
+        then: (val: any) => void;
+    } | null;
     constructor({ artifact, plugins, pipeline, client, cache, initialValue, fetching, }: {
         artifact: DocumentArtifact;
         plugins?: ClientHooks[];
@@ -17,7 +20,7 @@ export declare class DocumentStore<_Data extends GraphQLObject, _Input extends R
     send({ metadata, session, fetch, variables, policy, stuff, cacheParams, setup, silenceEcho, }?: SendParams): Promise<QueryResult<_Data, _Input>>;
     cleanup(): Promise<void>;
 }
-declare function marshalVariables<_Data extends GraphQLObject, _Input extends {}>(ctx: ClientPluginContext): Record<string, any>;
+declare function marshalVariables<_Data extends GraphQLObject, _Input extends GraphQLVariables>(ctx: ClientPluginContext): Record<string, any>;
 export type ClientPlugin = () => ClientHooks | null | (ClientHooks | ClientPlugin | null)[];
 export type ClientHooks = {
     start?: ClientPluginEnterPhase;

package/build/runtime-cjs/client/documentStore.js

@@ -38,6 +38,7 @@ class DocumentStore extends import_store.Writable {
   #plugins;
   #lastVariables;
   #lastContext = null;
+  pendingPromise = null;
   constructor({
     artifact,
     plugins,
@@ -70,7 +71,15 @@ class DocumentStore extends import_store.Writable {
     this.#plugins = pipeline ?? [
       (0, import_plugins.cachePolicy)({
         enabled: cache,
-        setFetching: (fetching2) => this.update((state) => ({ ...state, fetching: fetching2 }))
+        setFetching: (fetching2, data) => {
+          this.update((state) => {
+            const newState = { ...state, fetching: fetching2 };
+            if (fetching2 && data) {
+              newState.data = data;
+            }
+            return newState;
+          });
+        }
       })(),
       ...plugins ?? []
     ];
@@ -110,7 +119,7 @@ class DocumentStore extends import_store.Writable {
     const draft = context.draft();
     draft.variables = variables ?? null;
     context = context.apply(draft, false);
-    return await new Promise((resolve, reject) => {
+    const promise = new Promise((resolve, reject) => {
       const state = {
         setup,
         currentStep: 0,
@@ -119,12 +128,17 @@ class DocumentStore extends import_store.Writable {
         promise: {
           resolved: false,
           resolve,
-          reject
+          reject,
+          then: (...args) => promise.then(...args)
         },
         context
       };
+      if (this.pendingPromise === null) {
+        this.pendingPromise = state.promise;
+      }
       this.#step("forward", state);
     });
+    return await promise;
   }
   async cleanup() {
     for (const plugin of this.#plugins) {
@@ -243,16 +257,15 @@ class DocumentStore extends import_store.Writable {
         value
       );
     }
+    if (!ctx.silenceEcho || value.data !== this.state.data) {
+      this.set(value);
+    }
     if (!ctx.promise.resolved) {
       ctx.promise.resolve(value);
       ctx.promise.resolved = true;
     }
     this.#lastContext = ctx.context.draft();
     this.#lastVariables = this.#lastContext.stuff.inputs.marshaled;
-    if (ctx.silenceEcho && value.data === this.state.data) {
-      return;
-    }
-    this.set(value);
   }
 }
 class ClientPluginContextWrapper {

package/build/runtime-cjs/client/index.d.ts

@@ -1,11 +1,11 @@
 /// <reference path="../../../../../houdini.d.ts" />
-import type { DocumentArtifact, GraphQLObject, NestedList } from '../lib/types';
-import type { ClientPlugin, ClientHooks } from './documentStore';
+import type { DocumentArtifact, GraphQLVariables, GraphQLObject, NestedList } from '../lib/types';
+import type { ClientHooks, ClientPlugin } from './documentStore';
 import { DocumentStore } from './documentStore';
-import { type FetchParamFn, type ThrowOnErrorParams } from './plugins';
-export { DocumentStore, type ClientPlugin } from './documentStore';
+import type { FetchParamFn, ThrowOnErrorOperations, ThrowOnErrorParams } from './plugins';
+export { DocumentStore, type ClientPlugin, type SendParams } from './documentStore';
 export { fetch, mutation, query, subscription } from './plugins';
-type ConstructorArgs = {
+export type HoudiniClientConstructorArgs = {
     url: string;
     fetchParams?: FetchParamFn;
     plugins?: NestedList<ClientPlugin>;
@@ -19,9 +19,10 @@ export type ObserveParams<_Data extends GraphQLObject, _Artifact extends Documen
     fetching?: boolean;
 };
 export declare class HoudiniClient {
-    #private;
     url: string;
-    constructor({ url, fetchParams, plugins, pipeline, throwOnError }: ConstructorArgs);
-    observe<_Data extends GraphQLObject, _Input extends Record<string, any>>({ artifact, cache, initialValue, fetching, }: ObserveParams<_Data>): DocumentStore<_Data, _Input>;
+    readonly plugins: ClientPlugin[];
+    readonly throwOnError_operations: ThrowOnErrorOperations[];
+    constructor({ url, fetchParams, plugins, pipeline, throwOnError, }: HoudiniClientConstructorArgs);
+    observe<_Data extends GraphQLObject, _Input extends GraphQLVariables>({ artifact, cache, initialValue, fetching, }: ObserveParams<_Data>): DocumentStore<_Data, _Input>;
 }
 export declare function createPluginHooks(plugins: ClientPlugin[]): ClientHooks[];

package/build/runtime-cjs/client/index.js

@@ -41,14 +41,22 @@ var import_documentStore2 = require("./documentStore");
 var import_plugins2 = require("./plugins");
 class HoudiniClient {
   url;
-  #plugins;
-  constructor({ url, fetchParams, plugins, pipeline, throwOnError }) {
+  plugins;
+  throwOnError_operations;
+  constructor({
+    url,
+    fetchParams,
+    plugins,
+    pipeline,
+    throwOnError
+  }) {
     if (plugins && pipeline) {
       throw new Error(
         "A client cannot be given a pipeline and a list of plugins at the same time."
       );
     }
-    this.#plugins = (0, import_flatten.flatten)(
+    this.throwOnError_operations = throwOnError?.operations ?? [];
+    this.plugins = (0, import_flatten.flatten)(
       [].concat(
         throwOnError ? [(0, import_plugins.throwOnError)(throwOnError)] : [],
         (0, import_plugins.fetchParams)(fetchParams),
@@ -74,7 +82,7 @@ class HoudiniClient {
     return new import_documentStore.DocumentStore({
       client: this,
       artifact,
-      plugins: createPluginHooks(this.#plugins),
+      plugins: createPluginHooks(this.plugins),
       cache,
       initialValue,
       fetching

package/build/runtime-cjs/client/plugins/cache.d.ts

@@ -3,7 +3,7 @@ import { Cache } from '../../cache/cache';
 import type { ClientPlugin } from '../documentStore';
 export declare const cachePolicy: ({ enabled, setFetching, cache: localCache, serverSideFallback, }: {
     enabled: boolean;
-    setFetching: (val: boolean) => void;
+    setFetching: (val: boolean, data?: any) => void;
     cache?: Cache | undefined;
     serverSideFallback?: boolean | undefined;
 }) => ClientPlugin;

package/build/runtime-cjs/client/plugins/cache.js

@@ -41,7 +41,7 @@ const cachePolicy = ({
     network(ctx, { initialValue, next, resolve, marshalVariables }) {
       const { policy, artifact } = ctx;
       let useCache = false;
-      if (enabled && artifact.kind === import_types.ArtifactKind.Query && !ctx.cacheParams?.disableRead) {
+      if (enabled && (artifact.kind === import_types.ArtifactKind.Query || artifact.kind === import_types.ArtifactKind.Fragment) && !ctx.cacheParams?.disableRead) {
         if (policy !== import_types.CachePolicy.NetworkOnly) {
           const value = localCache.read({
             selection: artifact.selection,
@@ -82,7 +82,17 @@ const cachePolicy = ({
           localCache._internal_unstable.collectGarbage();
         }, 0);
       }
-      setFetching(!useCache);
+      if (!ctx.stuff?.silenceLoading) {
+        let fetchingState = null;
+        if (!useCache && "enableLoadingState" in artifact && artifact.enableLoadingState) {
+          fetchingState = localCache.read({
+            selection: artifact.selection,
+            variables: marshalVariables(ctx),
+            loading: true
+          }).data;
+        }
+        setFetching(!useCache, fetchingState);
+      }
       return next(ctx);
     },
     afterNetwork(ctx, { resolve, value, marshalVariables }) {

package/build/runtime-cjs/client/plugins/fetch.d.ts

@@ -21,6 +21,7 @@ export type FetchContext = {
 export type RequestHandlerArgs = FetchContext & FetchParams;
 export type RequestHandler<_Data = any> = (args: RequestHandlerArgs) => Promise<RequestPayload<_Data>>;
 export type FetchParams = {
+    name: string;
     text: string;
     hash: string;
     variables: {

package/build/runtime-cjs/client/plugins/fetch.js

@@ -33,6 +33,7 @@ const fetch = (target) => {
         }
         const fetch2 = ctx.fetch ?? globalThis.fetch;
         const fetchParams = {
+          name: ctx.artifact.name,
           text: ctx.text,
           hash: ctx.hash,
           variables: marshalVariables(ctx)
@@ -73,10 +74,10 @@ const defaultFetch = (url, params) => {
       "Could not find configured client url. Please specify one in your HoudiniClient constructor."
     );
   }
-  return async ({ fetch: fetch2, text, variables }) => {
+  return async ({ fetch: fetch2, name, text, variables }) => {
     const result = await fetch2(url, {
       method: "POST",
-      body: JSON.stringify({ query: text, variables }),
+      body: JSON.stringify({ operationName: name, query: text, variables }),
       ...params,
       headers: {
         Accept: "application/graphql+json, application/json",

package/build/runtime-cjs/client/plugins/fragment.js

@@ -28,16 +28,22 @@ __export(fragment_exports, {
 });
 module.exports = __toCommonJS(fragment_exports);
 var import_cache = __toESM(require("../../cache"), 1);
+var import_deepEquals = require("../../lib/deepEquals");
 var import_types = require("../../lib/types");
 var import_utils = require("../utils");
 const fragment = (0, import_utils.documentPlugin)(import_types.ArtifactKind.Fragment, function() {
   let subscriptionSpec = null;
+  let lastReference = null;
   return {
     start(ctx, { next, resolve, variablesChanged, marshalVariables }) {
       if (!ctx.stuff.parentID) {
         return next(ctx);
       }
-      if (variablesChanged(ctx) && !ctx.cacheParams?.disableSubscriptions) {
+      const currentReference = {
+        parent: ctx.stuff.parentID,
+        variables: marshalVariables(ctx)
+      };
+      if (!ctx.cacheParams?.disableSubscriptions && (!(0, import_deepEquals.deepEquals)(lastReference, currentReference) || variablesChanged(ctx))) {
         if (subscriptionSpec) {
           import_cache.default.unsubscribe(subscriptionSpec, subscriptionSpec.variables?.() || {});
         }
@@ -60,6 +66,7 @@ const fragment = (0, import_utils.documentPlugin)(import_types.ArtifactKind.Frag
           }
         };
         import_cache.default.subscribe(subscriptionSpec, variables);
+        lastReference = currentReference;
       }
       next(ctx);
     },

package/build/runtime-cjs/client/plugins/query.js

@@ -47,10 +47,11 @@ const query = (0, import_utils.documentPlugin)(import_types.ArtifactKind.Query,
           import_cache.default.unsubscribe(subscriptionSpec, subscriptionSpec.variables?.() || {});
         }
         lastVariables = { ...marshalVariables(ctx) };
+        const variables = lastVariables;
         subscriptionSpec = {
           rootType: ctx.artifact.rootType,
           selection: ctx.artifact.selection,
-          variables: () => lastVariables,
+          variables: () => variables,
           set: (newValue) => {
             resolve(ctx, {
               data: newValue,

package/build/runtime-cjs/client/plugins/subscription.d.ts

@@ -3,6 +3,7 @@ export declare function subscription(factory: SubscriptionHandler): import("../d
 export type SubscriptionHandler = (ctx: ClientPluginContext) => SubscriptionClient;
 export type SubscriptionClient = {
     subscribe: (payload: {
+        operationName: string;
         query: string;
         variables?: {};
     }, handlers: {

package/build/runtime-cjs/client/plugins/subscription.js

@@ -55,6 +55,7 @@ function subscription(factory) {
         clearSubscription?.();
         clearSubscription = client.subscribe(
           {
+            operationName: ctx.artifact.name,
             query: ctx.artifact.raw,
             variables: marshalVariables(ctx)
           },

package/build/runtime-cjs/client/plugins/throwOnError.d.ts

@@ -1,7 +1,8 @@
 import type { QueryResult } from '../../lib';
 import type { ClientPlugin, ClientPluginContext } from '../documentStore';
+export type ThrowOnErrorOperations = 'all' | 'query' | 'mutation' | 'subscription';
 export type ThrowOnErrorParams = {
-    operations: ('all' | 'query' | 'mutation' | 'subscription')[];
+    operations: ThrowOnErrorOperations[];
     error?: (errors: NonNullable<QueryResult<any, any>['errors']>, ctx: ClientPluginContext) => unknown;
 };
 export declare const throwOnError: ({ operations, error }: ThrowOnErrorParams) => ClientPlugin;

package/build/runtime-cjs/lib/config.js

@@ -58,7 +58,8 @@ function defaultConfigValues(file) {
   };
 }
 function keyFieldsForType(configFile, type) {
-  return configFile.types?.[type]?.keys || configFile.defaultKeys;
+  const withDefault = defaultConfigValues(configFile);
+  return withDefault.types?.[type]?.keys || withDefault.defaultKeys;
 }
 function computeID(configFile, type, data) {
   const fields = keyFieldsForType(configFile, type);

package/build/runtime-cjs/lib/pageInfo.d.ts

@@ -0,0 +1,7 @@
+import type { GraphQLObject, PageInfo } from './types';
+export declare function nullPageInfo(): PageInfo;
+export declare function missingPageSizeError(fnName: string): {
+    message: string;
+};
+export declare function extractPageInfo(data: any, path: string[]): PageInfo;
+export declare function countPage<_Data extends GraphQLObject>(source: string[], value: _Data | null): number;

package/build/runtime-cjs/lib/pageInfo.js

@@ -0,0 +1,79 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var pageInfo_exports = {};
+__export(pageInfo_exports, {
+  countPage: () => countPage,
+  extractPageInfo: () => extractPageInfo,
+  missingPageSizeError: () => missingPageSizeError,
+  nullPageInfo: () => nullPageInfo
+});
+module.exports = __toCommonJS(pageInfo_exports);
+var import_constants = require("./constants");
+function nullPageInfo() {
+  return { startCursor: null, endCursor: null, hasNextPage: false, hasPreviousPage: false };
+}
+function missingPageSizeError(fnName) {
+  return {
+    message: `${fnName} is missing the required page arguments. For more information, please visit this link: ${import_constants.siteURL}/guides/pagination`
+  };
+}
+function extractPageInfo(data, path) {
+  if (!data) {
+    return {
+      startCursor: null,
+      endCursor: null,
+      hasNextPage: false,
+      hasPreviousPage: false
+    };
+  }
+  let localPath = [...path];
+  let current = data;
+  while (localPath.length > 0) {
+    if (!current) {
+      break;
+    }
+    current = current[localPath.shift()];
+  }
+  return current?.pageInfo ?? nullPageInfo();
+}
+function countPage(source, value) {
+  let data = value;
+  if (value === null || data === null || data === void 0) {
+    return 0;
+  }
+  for (const field of source) {
+    const obj = data[field];
+    if (obj && !Array.isArray(obj)) {
+      data = obj;
+    } else if (!data) {
+      throw new Error("Could not count page size");
+    }
+    if (Array.isArray(obj)) {
+      return obj.length;
+    }
+  }
+  return 0;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  countPage,
+  extractPageInfo,
+  missingPageSizeError,
+  nullPageInfo
+});

package/build/runtime-cjs/lib/pagination.d.ts

@@ -0,0 +1,27 @@
+import type { SendParams } from '../client/documentStore';
+import type { CursorHandlers, FetchFn, GraphQLObject, GraphQLVariables, QueryArtifact, QueryResult, FetchParams } from './types';
+export declare function cursorHandlers<_Data extends GraphQLObject, _Input extends GraphQLVariables>({ artifact, fetchUpdate: parentFetchUpdate, fetch: parentFetch, getState, getVariables, getSession, }: {
+    artifact: QueryArtifact;
+    getState: () => _Data | null;
+    getVariables: () => NonNullable<_Input>;
+    getSession: () => Promise<App.Session>;
+    fetch: FetchFn<_Data, _Input>;
+    fetchUpdate: (arg: SendParams, updates: string[]) => ReturnType<FetchFn<_Data, _Input>>;
+}): CursorHandlers<_Data, _Input>;
+export declare function offsetHandlers<_Data extends GraphQLObject, _Input extends GraphQLVariables>({ artifact, storeName, getState, getVariables, fetch: parentFetch, fetchUpdate: parentFetchUpdate, getSession, }: {
+    artifact: QueryArtifact;
+    fetch: FetchFn<_Data, _Input>;
+    fetchUpdate: (arg: SendParams) => ReturnType<FetchFn<_Data, _Input>>;
+    storeName: string;
+    getState: () => _Data | null;
+    getVariables: () => _Input;
+    getSession: () => Promise<App.Session>;
+}): {
+    loadNextPage: ({ limit, offset, fetch, metadata, }?: {
+        limit?: number | undefined;
+        offset?: number | undefined;
+        fetch?: typeof fetch | undefined;
+        metadata?: {} | undefined;
+    }) => Promise<void>;
+    fetch(params?: FetchParams<_Input>): Promise<QueryResult<_Data, _Input>>;
+};