houdini 1.2.2 → 1.2.4

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

@@ -46,18 +46,16 @@ class HoudiniClient {
     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
     });
   }
 }

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

@@ -68,6 +68,9 @@ const cachePolicy = ({
     },
     afterNetwork(ctx, { resolve, value, marshalVariables }) {
       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) {

package/build/runtime-esm/client/plugins/mutation.js

@@ -5,7 +5,7 @@ import { documentPlugin } from "../utils";
 const mutation = documentPlugin(ArtifactKind.Mutation, () => {
   return {
     async start(ctx, { next, marshalVariables }) {
-      const layer = cache._internal_unstable.storage.createLayer(true);
+      const layerOptimistic = cache._internal_unstable.storage.createLayer(true);
       const optimisticResponse = ctx.stuff.optimisticResponse;
       let toNotify = [];
       if (optimisticResponse) {
@@ -16,25 +16,29 @@ const mutation = documentPlugin(ArtifactKind.Mutation, () => {
             data: optimisticResponse
           }),
           variables: marshalVariables(ctx),
-          layer: layer.id
+          layer: layerOptimistic.id
         });
       }
       ctx.cacheParams = {
         ...ctx.cacheParams,
-        layer,
+        layer: layerOptimistic,
         notifySubscribers: toNotify,
         forceNotify: true
       };
       next(ctx);
     },
     afterNetwork(ctx, { resolve }) {
-      ctx.cacheParams?.layer?.clear();
+      if (ctx.cacheParams?.layer) {
+        cache.clearLayer(ctx.cacheParams.layer.id);
+      }
       resolve(ctx);
     },
     end(ctx, { resolve, value }) {
       const hasErrors = value.errors && value.errors.length > 0;
       if (hasErrors) {
-        ctx.cacheParams?.layer?.clear();
+        if (ctx.cacheParams?.layer) {
+          cache.clearLayer(ctx.cacheParams.layer.id);
+        }
       }
       if (ctx.cacheParams?.layer) {
         cache._internal_unstable.storage.resolveLayer(ctx.cacheParams.layer.id);
@@ -44,7 +48,7 @@ const mutation = documentPlugin(ArtifactKind.Mutation, () => {
     catch(ctx, { error }) {
       if (ctx.cacheParams?.layer) {
         const { layer } = ctx.cacheParams;
-        layer.clear();
+        cache.clearLayer(layer.id);
         cache._internal_unstable.storage.resolveLayer(layer.id);
       }
       throw error;

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

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

package/build/runtime-esm/lib/index.js

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

package/build/runtime-esm/lib/lru.d.ts

@@ -0,0 +1,52 @@
+/**
+ * This file is a copy and paste of a very simple and effective LRU cache
+ * using javascript maps. It was copied under the MIT license found at the
+ * bottom of the page.
+ */
+/**
+ * JS maps (both plain objects and Map) maintain key insertion
+ * order, which means there is an easy way to simulate LRU behavior
+ * that should also perform quite well:
+ *
+ * To insert a new value, first delete the key from the inner _map,
+ * then _map.set(k, v). By deleting and reinserting, you ensure that the
+ * map sees the key as the last inserted key.
+ *
+ * Get does the same: if the key is present, delete and reinsert it.
+ */
+export declare class LRUCache<T> {
+    _capacity: number;
+    _map: Map<string, T>;
+    constructor(capacity?: number);
+    set(key: string, value: T): void;
+    get(key: string): T | null;
+    has(key: string): boolean;
+    delete(key: string): void;
+    size(): number;
+    capacity(): number;
+    clear(): void;
+}
+export declare function createLRUCache<T>(capacity?: number): LRUCache<T>;
+/**
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */

package/build/runtime-esm/lib/lru.js

@@ -0,0 +1,48 @@
+class LRUCache {
+  _capacity;
+  _map;
+  constructor(capacity = 1e3) {
+    this._capacity = capacity;
+    this._map = /* @__PURE__ */ new Map();
+  }
+  set(key, value) {
+    this._map.delete(key);
+    this._map.set(key, value);
+    if (this._map.size > this._capacity) {
+      const firstKey = this._map.keys().next();
+      if (!firstKey.done) {
+        this._map.delete(firstKey.value);
+      }
+    }
+  }
+  get(key) {
+    const value = this._map.get(key);
+    if (value != null) {
+      this._map.delete(key);
+      this._map.set(key, value);
+    }
+    return value ?? null;
+  }
+  has(key) {
+    return this._map.has(key);
+  }
+  delete(key) {
+    this._map.delete(key);
+  }
+  size() {
+    return this._map.size;
+  }
+  capacity() {
+    return this._capacity - this._map.size;
+  }
+  clear() {
+    this._map.clear();
+  }
+}
+function createLRUCache(capacity = 1e3) {
+  return new LRUCache(capacity);
+}
+export {
+  LRUCache,
+  createLRUCache
+};

package/build/runtime-esm/lib/types.d.ts

@@ -316,4 +316,5 @@ interface VariableNode {
 }
 export declare const PendingValue: unique symbol;
 export type LoadingType = typeof PendingValue;
+export declare function isPending(value: any): value is LoadingType;
 export {};

package/build/runtime-esm/lib/types.js

@@ -30,6 +30,9 @@ const DataSource = {
 };
 const fragmentKey = " $fragments";
 const PendingValue = Symbol("houdini_loading");
+function isPending(value) {
+  return typeof value === "symbol";
+}
 export {
   ArtifactKind,
   CachePolicy,
@@ -41,5 +44,6 @@ export {
   PaginateMode,
   PendingValue,
   RefetchUpdateMode,
-  fragmentKey
+  fragmentKey,
+  isPending
 };

package/build/test-cjs/index.js

@@ -54390,6 +54390,7 @@ __export(fs_exports, {
   recursiveCopy: () => recursiveCopy,
   remove: () => remove,
   rmdir: () => rmdir,
+  snapshot: () => snapshot,
   stat: () => stat,
   writeFile: () => writeFile
 });
@@ -54584,16 +54585,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 import_promises.default.readdir(filepath);
+    return await import_promises.default.readdir(filepath, opts);
   }
   if (filepath.includes("build/runtime")) {
-    return await import_promises.default.readdir(filepath);
+    return await import_promises.default.readdir(filepath, opts);
   }
   try {
-    return import_memfs.fs.readdirSync(filepath);
-  } catch {
+    return import_memfs.fs.readdirSync(filepath, opts);
+  } catch (e) {
+    console.log(e);
     return [];
   }
 }
@@ -54644,6 +54646,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 (0, import_node_util.promisify)(import_glob.glob)(posixify(pattern));
 }
@@ -54775,10 +54782,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);
       }
     }
   }
@@ -54875,6 +54882,10 @@ var List = class {
                   updates: ["append", "prepend"],
                   selection: {
                     fields: {
+                      __typename: {
+                        keyRaw: "__typename",
+                        type: "String"
+                      },
                       node: {
                         type: listType,
                         keyRaw: "node",
@@ -54899,7 +54910,15 @@ var List = class {
       };
       insertData = {
         newEntry: {
-          edges: [{ node: { ...data, __typename: listType } }]
+          edges: [
+            {
+              __typename: listType + "Edge",
+              node: {
+                ...data,
+                __typename: listType
+              }
+            }
+          ]
         }
       };
     } else {
@@ -54935,7 +54954,7 @@ var List = class {
       layer: layer?.id
     });
   }
-  removeID(id, variables = {}) {
+  removeID(id, variables = {}, layer) {
     if (!this.validateWhen()) {
       return;
     }
@@ -54982,7 +55001,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({
@@ -54995,12 +55014,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;
@@ -55032,7 +55051,7 @@ var List = class {
     layer,
     where
   }) {
-    if (!this.remove(data, variables)) {
+    if (!this.remove(data, variables, layer)) {
       this.addToList(selection, data, variables, where, layer);
     }
   }
@@ -55169,7 +55188,7 @@ var StaleManager = class {
 // src/runtime/cache/storage.ts
 var InMemoryStorage = class {
   data;
-  idCount = 0;
+  idCount = 1;
   rank = 0;
   constructor() {
     this.data = [];
@@ -55189,11 +55208,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);
@@ -55327,6 +55346,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;
@@ -55565,6 +55601,9 @@ var InMemorySubscriptions = class {
   subscribers = {};
   referenceCounts = {};
   keyVersions = {};
+  activeFields(parent2) {
+    return Object.keys(this.subscribers[parent2] || {});
+  }
   add({
     parent: parent2,
     spec,
@@ -55833,20 +55872,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) {
@@ -55885,10 +55911,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(config2) {
     this._internal_unstable.setConfig(config2);
@@ -55920,6 +55946,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;
@@ -56207,8 +56303,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");
@@ -56217,15 +56321,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);
           }
         }
       }
@@ -56760,7 +56856,7 @@ var fragment = documentPlugin(ArtifactKind.Fragment, function() {
 var mutation = documentPlugin(ArtifactKind.Mutation, () => {
   return {
     async start(ctx, { next, marshalVariables }) {
-      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) {
@@ -56771,25 +56867,29 @@ var mutation = documentPlugin(ArtifactKind.Mutation, () => {
             data: optimisticResponse
           }),
           variables: marshalVariables(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);
@@ -56799,7 +56899,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;
@@ -57590,7 +57690,7 @@ function deepMerge2(filepath, ...targets) {
 }
 
 // src/lib/parse.ts
-async function parseJS(str, config2) {
+function parseJS(str, config2) {
   const defaultConfig = {
     plugins: ["typescript", "importAssertions"],
     sourceType: "module"
@@ -58817,7 +58917,7 @@ function operationObject({
   if (operationKind === "insert" || operationKind === "toggle") {
     operation.position = position;
   }
-  if (operationKind === "insert" && allLists) {
+  if (allLists && operationKind !== "delete") {
     operation.target = "all";
   }
   if (parentID) {
@@ -60653,12 +60753,28 @@ ${exportStatement("config")}
       },
       [path_exports.join(config2.runtimeSource, "client", "plugins", "injectedPlugins.js")]: (content) => injectPlugins({ config: config2, content, importStatement, exportStatement })
     }),
-    ...config2.plugins.filter((plugin2) => plugin2.includeRuntime).map((plugin2) => generatePluginRuntime(config2, docs, plugin2)),
+    ...config2.plugins.filter((plugin2) => plugin2.includeRuntime).map(
+      (plugin2) => generatePluginRuntime({
+        config: config2,
+        docs,
+        plugin: plugin2,
+        importStatement,
+        exportDefaultStatement: exportStatement,
+        exportStarStatement: exportStar
+      })
+    ),
     generatePluginIndex({ config: config2, exportStatement: exportStar })
   ]);
   await generateGraphqlReturnTypes(config2, docs);
 }
-async function generatePluginRuntime(config2, docs, plugin2) {
+async function generatePluginRuntime({
+  config: config2,
+  docs,
+  plugin: plugin2,
+  importStatement,
+  exportDefaultStatement,
+  exportStarStatement
+}) {
   if (houdini_mode.is_testing || !plugin2.includeRuntime) {
     return;
   }
@@ -60686,7 +60802,13 @@ async function generatePluginRuntime(config2, docs, plugin2) {
     Object.fromEntries(
       Object.entries(transformMap).map(([key, value]) => [
         path_exports.join(runtime_path, key),
-        (content) => value({ config: config2, content })
+        (content) => value({
+          config: config2,
+          content,
+          importStatement,
+          exportDefaultStatement,
+          exportStarStatement
+        })
       ])
     )
   );
@@ -62554,14 +62676,12 @@ async function typeCheck(config2, docs) {
         for (const targetType of targetTypes) {
           const missingIDFields = config2.keyFieldsForType(targetType.name).filter((fieldName) => !targetType.getFields()[fieldName]);
           if (missingIDFields.length > 0) {
-            const message = `@${config2.listDirective} on ${logGreen(
-              targetType.name
-            )} as a configuration issue. Object identification missing: ${missingIDFields.map((c) => `"${logYellow(c)}"`).join(", ")}. Check 'Custom IDs' if needed.`;
             errors.push(
               new HoudiniError({
                 filepath: filename,
-                message,
-                description: message
+                message: `@${config2.listDirective} on ${logGreen(
+                  targetType.name
+                )} has a configuration issue: ${targetType} dos not have a valid key. Please check this link for more information: https://houdinigraphql.com/guides/caching-data#custom-ids`
               })
             );
             return;