houdini 1.2.2 → 1.2.4

package/build/lib-esm/index.js

@@ -61830,6 +61830,9 @@ var DataSource = {
 };
 var fragmentKey = " $fragments";
 var PendingValue = Symbol("houdini_loading");
+function isPending(value) {
+  return typeof value === "symbol";
+}
 
 // src/runtime/lib/store.ts
 var subscriber_queue = [];
@@ -61948,6 +61951,7 @@ __export(fs_exports, {
   recursiveCopy: () => recursiveCopy,
   remove: () => remove,
   rmdir: () => rmdir,
+  snapshot: () => snapshot,
   stat: () => stat,
   writeFile: () => writeFile
 });
@@ -62142,16 +62146,17 @@ function existsSync(dirPath) {
   }
   return import_memfs.fs.existsSync(dirPath);
 }
-async function readdir(filepath) {
+async function readdir(filepath, opts) {
   if (!houdini_mode.is_testing) {
-    return await fs.readdir(filepath);
+    return await fs.readdir(filepath, opts);
   }
   if (filepath.includes("build/runtime")) {
-    return await fs.readdir(filepath);
+    return await fs.readdir(filepath, opts);
   }
   try {
-    return import_memfs.fs.readdirSync(filepath);
-  } catch {
+    return import_memfs.fs.readdirSync(filepath, opts);
+  } catch (e2) {
+    console.log(e2);
     return [];
   }
 }
@@ -62202,6 +62207,11 @@ async function recursiveCopy(source, target, transforms, notRoot) {
     );
   }
 }
+function snapshot(base) {
+  return Object.fromEntries(
+    Object.entries(import_memfs.vol.toJSON()).filter(([key]) => !base || key.startsWith(base)).map(([key, value]) => [!base ? key : key.substring(base.length), value])
+  );
+}
 async function glob(pattern) {
   return await promisify(import_glob.glob)(posixify(pattern));
 }
@@ -63741,10 +63751,10 @@ var ListManager = class {
     this.lists.get(list.name).get(parentID).lists.push(handler);
     this.listsByField.get(parentID).get(list.key).push(handler);
   }
-  removeIDFromAllLists(id) {
+  removeIDFromAllLists(id, layer) {
     for (const fieldMap of this.lists.values()) {
       for (const list of fieldMap.values()) {
-        list.removeID(id);
+        list.removeID(id, void 0, layer);
       }
     }
   }
@@ -63841,6 +63851,10 @@ var List = class {
                   updates: ["append", "prepend"],
                   selection: {
                     fields: {
+                      __typename: {
+                        keyRaw: "__typename",
+                        type: "String"
+                      },
                       node: {
                         type: listType,
                         keyRaw: "node",
@@ -63865,7 +63879,15 @@ var List = class {
       };
       insertData = {
         newEntry: {
-          edges: [{ node: { ...data, __typename: listType } }]
+          edges: [
+            {
+              __typename: listType + "Edge",
+              node: {
+                ...data,
+                __typename: listType
+              }
+            }
+          ]
         }
       };
     } else {
@@ -63901,7 +63923,7 @@ var List = class {
       layer: layer?.id
     });
   }
-  removeID(id, variables = {}) {
+  removeID(id, variables = {}, layer) {
     if (!this.validateWhen()) {
       return;
     }
@@ -63948,7 +63970,7 @@ var List = class {
       subscribers.map((sub) => sub[0]),
       variables
     );
-    this.cache._internal_unstable.storage.remove(parentID, targetKey, targetID);
+    this.cache._internal_unstable.storage.remove(parentID, targetKey, targetID, layer);
     for (const [spec] of subscribers) {
       spec.set(
         this.cache._internal_unstable.getSelection({
@@ -63961,12 +63983,12 @@ var List = class {
     }
     return true;
   }
-  remove(data, variables = {}) {
+  remove(data, variables = {}, layer) {
     const targetID = this.cache._internal_unstable.id(this.listType(data), data);
     if (!targetID) {
       return;
     }
-    return this.removeID(targetID, variables);
+    return this.removeID(targetID, variables, layer);
   }
   listType(data) {
     return data.__typename || this.type;
@@ -63998,7 +64020,7 @@ var List = class {
     layer,
     where
   }) {
-    if (!this.remove(data, variables)) {
+    if (!this.remove(data, variables, layer)) {
       this.addToList(selection, data, variables, where, layer);
     }
   }
@@ -64135,7 +64157,7 @@ var StaleManager = class {
 // src/runtime/cache/storage.ts
 var InMemoryStorage = class {
   data;
-  idCount = 0;
+  idCount = 1;
   rank = 0;
   constructor() {
     this.data = [];
@@ -64155,11 +64177,11 @@ var InMemoryStorage = class {
   insert(id, field, location, target) {
     return this.topLayer.insert(id, field, location, target);
   }
-  remove(id, field, target) {
-    return this.topLayer.remove(id, field, target);
+  remove(id, field, target, layerToUser = this.topLayer) {
+    return layerToUser.remove(id, field, target);
   }
-  delete(id) {
-    return this.topLayer.delete(id);
+  delete(id, layerToUser = this.topLayer) {
+    return layerToUser.delete(id);
   }
   deleteField(id, field) {
     return this.topLayer.deleteField(id, field);
@@ -64293,6 +64315,23 @@ var InMemoryStorage = class {
     }
     return this.data[this.data.length - 1];
   }
+  serialize() {
+    return JSON.stringify({
+      rank: this.rank,
+      fields: this.topLayer.fields,
+      links: this.topLayer.links
+    });
+  }
+  hydrate(args, layer) {
+    if (!args) {
+      return;
+    }
+    const { rank, fields, links } = args;
+    this.rank = rank;
+    layer ??= this.createLayer(true);
+    layer.fields = fields;
+    layer.links = links;
+  }
 };
 var Layer = class {
   id;
@@ -64531,6 +64570,9 @@ var InMemorySubscriptions = class {
   subscribers = {};
   referenceCounts = {};
   keyVersions = {};
+  activeFields(parent) {
+    return Object.keys(this.subscribers[parent] || {});
+  }
   add({
     parent,
     spec,
@@ -64799,20 +64841,7 @@ var Cache = class {
   }) {
     const layer = layerID ? this._internal_unstable.storage.getLayer(layerID) : this._internal_unstable.storage.topLayer;
     const subscribers = this._internal_unstable.writeSelection({ ...args, layer }).map((sub) => sub[0]);
-    const notified = [];
-    for (const spec of subscribers.concat(notifySubscribers)) {
-      if (!notified.includes(spec.set)) {
-        notified.push(spec.set);
-        spec.set(
-          this._internal_unstable.getSelection({
-            parent: spec.parentID || rootID,
-            selection: spec.selection,
-            variables: spec.variables?.() || {},
-            ignoreMasking: false
-          }).data
-        );
-      }
-    }
+    this.#notifySubscribers(subscribers.concat(notifySubscribers));
     return subscribers;
   }
   read(...args) {
@@ -64851,10 +64880,10 @@ var Cache = class {
     }
     return handler;
   }
-  delete(id) {
+  delete(id, layer) {
     this._internal_unstable.subscriptions.removeAllSubscribers(id);
-    this._internal_unstable.lists.removeIDFromAllLists(id);
-    this._internal_unstable.storage.delete(id);
+    this._internal_unstable.lists.removeIDFromAllLists(id, layer);
+    this._internal_unstable.storage.delete(id, layer);
   }
   setConfig(config) {
     this._internal_unstable.setConfig(config);
@@ -64886,6 +64915,76 @@ var Cache = class {
   config() {
     return this._internal_unstable.config;
   }
+  serialize() {
+    return this._internal_unstable.storage.serialize();
+  }
+  hydrate(...args) {
+    return this._internal_unstable.storage.hydrate(...args);
+  }
+  clearLayer(layerID) {
+    const layer = this._internal_unstable.storage.getLayer(layerID);
+    if (!layer) {
+      throw new Error("Cannot find layer with id: " + layerID);
+    }
+    const toNotify = [];
+    const allFields = [];
+    for (const target of [layer.fields, layer.links]) {
+      for (const [id, fields] of Object.entries(target)) {
+        allFields.push(
+          ...Object.entries(fields).map(([field, value]) => ({ id, field, value }))
+        );
+      }
+    }
+    const displayFields = [];
+    for (const pair of allFields) {
+      const { displayLayers } = this._internal_unstable.storage.get(pair.id, pair.field);
+      if (!displayLayers.includes(layerID)) {
+        continue;
+      }
+      displayFields.push(pair);
+    }
+    for (const [id, operation] of Object.entries(layer.operations)) {
+      if (operation.deleted) {
+        displayFields.push(
+          ...this._internal_unstable.subscriptions.activeFields(id).map((field) => ({ id, field }))
+        );
+      }
+      const fields = Object.keys(operation.fields ?? {});
+      if (fields.length > 0) {
+        displayFields.push(...fields.map((field) => ({ id, field })));
+      }
+    }
+    layer.clear();
+    for (const display of displayFields) {
+      const { field, id } = display;
+      const notify = !("value" in display) || this._internal_unstable.storage.get(id, field).value !== display.value;
+      if (notify) {
+        toNotify.push(
+          ...this._internal_unstable.subscriptions.get(id, field).map((sub) => sub[0])
+        );
+      }
+    }
+    this.#notifySubscribers(toNotify);
+  }
+  #notifySubscribers(subs) {
+    if (subs.length === 0) {
+      return;
+    }
+    const notified = [];
+    for (const spec of subs) {
+      if (!notified.includes(spec.set)) {
+        notified.push(spec.set);
+        spec.set(
+          this._internal_unstable.getSelection({
+            parent: spec.parentID || rootID,
+            selection: spec.selection,
+            variables: spec.variables?.() || {},
+            ignoreMasking: false
+          }).data
+        );
+      }
+    }
+  }
 };
 var CacheInternal = class {
   _disabled = false;
@@ -65173,8 +65272,16 @@ var CacheInternal = class {
               operation.position || "last",
               layer
             );
+          } else if (operation.action === "toggle" && target instanceof Object && fieldSelection && operation.list) {
+            this.cache.list(operation.list, parentID, operation.target === "all").when(operation.when).toggleElement({
+              selection: fieldSelection,
+              data: target,
+              variables,
+              where: operation.position || "last",
+              layer
+            });
           } else if (operation.action === "remove" && target instanceof Object && fieldSelection && operation.list) {
-            this.cache.list(operation.list, parentID, operation.target === "all").when(operation.when).remove(target, variables);
+            this.cache.list(operation.list, parentID, operation.target === "all").when(operation.when).remove(target, variables, layer);
           } else if (operation.action === "delete" && operation.type) {
             if (typeof target !== "string") {
               throw new Error("Cannot delete a record with a non-string ID");
@@ -65183,15 +65290,7 @@ var CacheInternal = class {
             if (!targetID) {
               continue;
             }
-            this.cache.delete(targetID);
-          } else if (operation.action === "toggle" && target instanceof Object && fieldSelection && operation.list) {
-            this.cache.list(operation.list, parentID, operation.target === "all").when(operation.when).toggleElement({
-              selection: fieldSelection,
-              data: target,
-              variables,
-              where: operation.position || "last",
-              layer
-            });
+            this.cache.delete(targetID, layer);
           }
         }
       }
@@ -65660,6 +65759,9 @@ var cachePolicy = ({
     },
     afterNetwork(ctx, { resolve: resolve2, value, marshalVariables: marshalVariables2 }) {
       if (value.source !== DataSource.Cache && enabled && value.data && !ctx.cacheParams?.disableWrite) {
+        if (ctx.cacheParams && "serverSideFallback" in ctx.cacheParams) {
+          serverSideFallback = ctx.cacheParams?.serverSideFallback ?? serverSideFallback;
+        }
         const targetCache = serverSide && serverSideFallback ? new Cache({ disabled: false }) : localCache;
         let layer;
         if (!serverSide && ctx.cacheParams?.layer) {
@@ -65817,7 +65919,7 @@ var fragment = documentPlugin(ArtifactKind.Fragment, function() {
 var mutation = documentPlugin(ArtifactKind.Mutation, () => {
   return {
     async start(ctx, { next, marshalVariables: marshalVariables2 }) {
-      const layer = cache_default._internal_unstable.storage.createLayer(true);
+      const layerOptimistic = cache_default._internal_unstable.storage.createLayer(true);
       const optimisticResponse = ctx.stuff.optimisticResponse;
       let toNotify = [];
       if (optimisticResponse) {
@@ -65828,25 +65930,29 @@ var mutation = documentPlugin(ArtifactKind.Mutation, () => {
             data: optimisticResponse
           }),
           variables: marshalVariables2(ctx),
-          layer: layer.id
+          layer: layerOptimistic.id
         });
       }
       ctx.cacheParams = {
         ...ctx.cacheParams,
-        layer,
+        layer: layerOptimistic,
         notifySubscribers: toNotify,
         forceNotify: true
       };
       next(ctx);
     },
     afterNetwork(ctx, { resolve: resolve2 }) {
-      ctx.cacheParams?.layer?.clear();
+      if (ctx.cacheParams?.layer) {
+        cache_default.clearLayer(ctx.cacheParams.layer.id);
+      }
       resolve2(ctx);
     },
     end(ctx, { resolve: resolve2, value }) {
       const hasErrors = value.errors && value.errors.length > 0;
       if (hasErrors) {
-        ctx.cacheParams?.layer?.clear();
+        if (ctx.cacheParams?.layer) {
+          cache_default.clearLayer(ctx.cacheParams.layer.id);
+        }
       }
       if (ctx.cacheParams?.layer) {
         cache_default._internal_unstable.storage.resolveLayer(ctx.cacheParams.layer.id);
@@ -65856,7 +65962,7 @@ var mutation = documentPlugin(ArtifactKind.Mutation, () => {
     catch(ctx, { error }) {
       if (ctx.cacheParams?.layer) {
         const { layer } = ctx.cacheParams;
-        layer.clear();
+        cache_default.clearLayer(layer.id);
         cache_default._internal_unstable.storage.resolveLayer(layer.id);
       }
       throw error;
@@ -65997,20 +66103,23 @@ var steps = {
   backwards: ["end", "afterNetwork"]
 };
 var DocumentStore = class extends Writable {
-  #artifact;
+  artifact;
   #client;
   #configFile;
   #plugins;
   #lastVariables;
   #lastContext = null;
   pendingPromise = null;
+  serverSideFallback;
   constructor({
     artifact,
     plugins: plugins2,
     pipeline: pipeline2,
     client: client2,
-    cache = true,
+    cache,
+    enableCache = true,
     initialValue,
+    initialVariables,
     fetching
   }) {
     fetching ??= artifact.kind === ArtifactKind.Query;
@@ -66021,7 +66130,7 @@ var DocumentStore = class extends Writable {
       stale: false,
       source: null,
       fetching,
-      variables: null
+      variables: initialVariables ?? null
     };
     super(initialState, () => {
       return () => {
@@ -66029,13 +66138,14 @@ var DocumentStore = class extends Writable {
         this.cleanup();
       };
     });
-    this.#artifact = artifact;
+    this.artifact = artifact;
     this.#client = client2;
     this.#lastVariables = null;
     this.#configFile = getCurrentConfig();
     this.#plugins = pipeline2 ?? [
       cachePolicy({
-        enabled: cache,
+        cache,
+        enabled: enableCache,
         setFetching: (fetching2, data) => {
           this.update((state) => {
             const newState = { ...state, fetching: fetching2 };
@@ -66062,9 +66172,9 @@ var DocumentStore = class extends Writable {
   } = {}) {
     let context = new ClientPluginContextWrapper({
       config: this.#configFile,
-      text: this.#artifact.raw,
-      hash: this.#artifact.hash,
-      policy: policy ?? this.#artifact.policy,
+      text: this.artifact.raw,
+      hash: this.artifact.hash,
+      policy: policy ?? this.artifact.policy,
       variables: null,
       metadata,
       session,
@@ -66077,7 +66187,7 @@ var DocumentStore = class extends Writable {
         },
         ...stuff
       },
-      artifact: this.#artifact,
+      artifact: this.artifact,
       lastVariables: this.#lastVariables,
       cacheParams
     });
@@ -66371,18 +66481,16 @@ var HoudiniClient = class {
     this.url = url;
   }
   observe({
-    artifact,
-    cache = true,
-    initialValue,
-    fetching = false
+    enableCache = true,
+    fetching = false,
+    ...rest
   }) {
     return new DocumentStore({
       client: this,
-      artifact,
       plugins: createPluginHooks(this.plugins),
-      cache,
-      initialValue,
-      fetching
+      fetching,
+      enableCache,
+      ...rest
     });
   }
 };
@@ -67422,7 +67530,7 @@ function deepMerge2(filepath, ...targets) {
 }
 
 // src/lib/parse.ts
-async function parseJS(str, config) {
+function parseJS(str, config) {
   const defaultConfig = {
     plugins: ["typescript", "importAssertions"],
     sourceType: "module"
@@ -67736,6 +67844,7 @@ async function find_graphql(config, parsedScript, walker) {
 }
 export {
   ArtifactKind,
+  Cache,
   CachePolicy,
   CompiledFragmentKind,
   CompiledMutationKind,
@@ -67772,6 +67881,7 @@ export {
   getRootType,
   hashDocument,
   houdini_mode,
+  isPending,
   keyFieldsForType,
   mutation,
   operation_requires_variables,

package/build/runtime/cache/cache.d.ts

@@ -8,6 +8,7 @@ import type { Layer, LayerID } from './storage';
 import { InMemoryStorage } from './storage';
 import { InMemorySubscriptions, type FieldSelection } from './subscription';
 export declare class Cache {
+    #private;
     _internal_unstable: CacheInternal;
     constructor({ disabled, ...config }?: ConfigFile & {
         disabled?: boolean;
@@ -33,7 +34,7 @@ export declare class Cache {
     subscribe(spec: SubscriptionSpec, variables?: {}): void;
     unsubscribe(spec: SubscriptionSpec, variables?: {}): void;
     list(name: string, parentID?: string, allLists?: boolean): ListCollection;
-    delete(id: string): void;
+    delete(id: string, layer?: Layer): void;
     setConfig(config: ConfigFile): void;
     markTypeStale(options?: {
         type: string;
@@ -46,6 +47,9 @@ export declare class Cache {
     }): void;
     getFieldTime(id: string, field: string): number | null | undefined;
     config(): ConfigFile;
+    serialize(): string;
+    hydrate(...args: Parameters<InMemoryStorage['hydrate']>): void;
+    clearLayer(layerID: Layer['id']): void;
 }
 declare class CacheInternal {
     private _disabled;

package/build/runtime/cache/lists.d.ts

@@ -21,7 +21,7 @@ export declare class ListManager {
         filters?: List['filters'];
         abstract?: boolean;
     }): void;
-    removeIDFromAllLists(id: string): void;
+    removeIDFromAllLists(id: string, layer?: Layer): void;
     deleteField(parentID: string, field: string): void;
 }
 export declare class List {
@@ -54,8 +54,8 @@ export declare class List {
         layer?: Layer;
     }): void;
     addToList(selection: SubscriptionSelection, data: {}, variables: {} | undefined, where: 'first' | 'last', layer?: Layer): void;
-    removeID(id: string, variables?: {}): true | undefined;
-    remove(data: {}, variables?: {}): true | undefined;
+    removeID(id: string, variables?: {}, layer?: Layer): true | undefined;
+    remove(data: {}, variables?: {}, layer?: Layer): true | undefined;
     listType(data: {
         __typename?: string;
     }): string;

package/build/runtime/cache/storage.d.ts

@@ -8,8 +8,8 @@ export declare class InMemoryStorage {
     get nextRank(): number;
     createLayer(optimistic?: boolean): Layer;
     insert(id: string, field: string, location: OperationLocations, target: string): void;
-    remove(id: string, field: string, target: string): void;
-    delete(id: string): void;
+    remove(id: string, field: string, target: string, layerToUser?: Layer): void;
+    delete(id: string, layerToUser?: Layer): void;
     deleteField(id: string, field: string): void;
     getLayer(id: number): Layer;
     replaceID(replacement: {
@@ -25,6 +25,12 @@ export declare class InMemoryStorage {
     writeField(id: string, field: string, value: GraphQLValue): number;
     resolveLayer(id: number): void;
     get topLayer(): Layer;
+    serialize(): string;
+    hydrate(args?: {
+        rank: number;
+        fields: EntityFieldMap;
+        links: LinkMap;
+    }, layer?: Layer): void;
 }
 export declare class Layer {
     readonly id: LayerID;

package/build/runtime/cache/subscription.d.ts

@@ -10,6 +10,7 @@ export declare class InMemorySubscriptions {
     private subscribers;
     private referenceCounts;
     private keyVersions;
+    activeFields(parent: string): string[];
     add({ parent, spec, selection, variables, parentType, }: {
         parent: string;
         parentType?: string;

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

@@ -1,21 +1,27 @@
 import type { HoudiniClient } from '.';
+import type { Cache } from '../cache/cache';
 import type { Layer } from '../cache/storage';
 import type { ConfigFile } from '../lib/config';
 import { Writable } from '../lib/store';
 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;
+    readonly artifact: DocumentArtifact;
     pendingPromise: {
         then: (val: any) => void;
     } | null;
-    constructor({ artifact, plugins, pipeline, client, cache, initialValue, fetching, }: {
+    serverSideFallback?: boolean;
+    constructor({ artifact, plugins, pipeline, client, cache, enableCache, initialValue, initialVariables, fetching, }: {
         artifact: DocumentArtifact;
         plugins?: ClientHooks[];
         pipeline?: ClientHooks[];
         client: HoudiniClient | null;
-        cache?: boolean;
+        cache?: Cache;
+        enableCache?: boolean;
         initialValue?: _Data | null;
         fetching?: boolean;
+        serverSideFallback?: boolean;
+        initialVariables?: _Input;
     });
     send({ metadata, session, fetch, variables, policy, stuff, cacheParams, setup, silenceEcho, }?: SendParams): Promise<QueryResult<_Data, _Input>>;
     cleanup(): Promise<void>;
@@ -51,6 +57,7 @@ export type ClientPluginContext = {
         disableRead?: boolean;
         disableSubscriptions?: boolean;
         applyUpdates?: string[];
+        serverSideFallback?: boolean;
     };
     stuff: App.Stuff;
 };

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

@@ -1,4 +1,5 @@
 /// <reference path="../../../../../houdini.d.ts" />
+import type { Cache } from '../cache/cache';
 import type { DocumentArtifact, GraphQLVariables, GraphQLObject, NestedList } from '../lib/types';
 import type { ClientHooks, ClientPlugin } from './documentStore';
 import { DocumentStore } from './documentStore';
@@ -12,10 +13,12 @@ export type HoudiniClientConstructorArgs = {
     pipeline?: NestedList<ClientPlugin>;
     throwOnError?: ThrowOnErrorParams;
 };
-export type ObserveParams<_Data extends GraphQLObject, _Artifact extends DocumentArtifact = DocumentArtifact> = {
+export type ObserveParams<_Data extends GraphQLObject, _Artifact extends DocumentArtifact = DocumentArtifact, _Input extends GraphQLVariables = GraphQLVariables> = {
     artifact: _Artifact;
-    cache?: boolean;
+    enableCache?: boolean;
+    cache?: Cache;
     initialValue?: _Data | null;
+    initialVariables?: _Input;
     fetching?: boolean;
 };
 export declare class HoudiniClient {
@@ -23,6 +26,6 @@ export declare class HoudiniClient {
     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>;
+    observe<_Data extends GraphQLObject, _Input extends GraphQLVariables>({ enableCache, fetching, ...rest }: ObserveParams<_Data, DocumentArtifact, _Input>): DocumentStore<_Data, _Input>;
 }
 export declare function createPluginHooks(plugins: ClientPlugin[]): ClientHooks[];

package/build/runtime/lib/index.d.ts

@@ -6,3 +6,4 @@ export * from './scalars';
 export * from './types';
 export * from './store';
 export * from './key';
+export * from './lru';