houdini 1.0.0-next.4 → 1.0.0-next.6

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

@@ -0,0 +1,95 @@
+"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 staleManager_exports = {};
+__export(staleManager_exports, {
+  StaleManager: () => StaleManager
+});
+module.exports = __toCommonJS(staleManager_exports);
+var import_lib = require("../lib");
+class StaleManager {
+  cache;
+  fieldsTime = /* @__PURE__ */ new Map();
+  constructor(cache) {
+    this.cache = cache;
+  }
+  #initMapId = (id) => {
+    if (!this.fieldsTime.get(id)) {
+      this.fieldsTime.set(id, /* @__PURE__ */ new Map());
+    }
+  };
+  getFieldTime(id, field) {
+    return this.fieldsTime.get(id)?.get(field);
+  }
+  setFieldTimeToNow(id, field) {
+    this.#initMapId(id);
+    this.fieldsTime.get(id)?.set(field, new Date().valueOf());
+  }
+  markFieldStale(id, field) {
+    this.#initMapId(id);
+    this.fieldsTime.get(id)?.set(field, null);
+  }
+  markAllStale() {
+    for (const [id, fieldMap] of this.fieldsTime.entries()) {
+      for (const [field] of fieldMap.entries()) {
+        this.markFieldStale(id, field);
+      }
+    }
+  }
+  markRecordStale(id) {
+    const fieldsTimeOfType = this.fieldsTime.get(id);
+    if (fieldsTimeOfType) {
+      for (const [field] of fieldsTimeOfType.entries()) {
+        this.markFieldStale(id, field);
+      }
+    }
+  }
+  markTypeStale(type) {
+    for (const [id, fieldMap] of this.fieldsTime.entries()) {
+      if (id.startsWith(`${type}:`)) {
+        for (const [field] of fieldMap.entries()) {
+          this.markFieldStale(id, field);
+        }
+      }
+    }
+  }
+  markTypeFieldStale(type, field, when) {
+    const key = (0, import_lib.computeKey)({ field, args: when });
+    for (const [id, fieldMap] of this.fieldsTime.entries()) {
+      if (id.startsWith(`${type}:`)) {
+        for (const local_field of fieldMap.keys()) {
+          if (local_field === key) {
+            this.markFieldStale(id, field);
+          }
+        }
+      }
+    }
+  }
+  delete(id, field) {
+    if (this.fieldsTime.has(id)) {
+      this.fieldsTime.get(id)?.delete(field);
+      if (this.fieldsTime.get(id)?.size === 0) {
+        this.fieldsTime.delete(id);
+      }
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  StaleManager
+});

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

@@ -19,10 +19,11 @@ export declare class InMemorySubscriptions {
             [key: string]: GraphQLValue;
         };
     }): void;
-    addFieldSubscription({ id, key, selection, }: {
+    addFieldSubscription({ id, key, selection, type, }: {
         id: string;
         key: string;
         selection: FieldSelection;
+        type: string;
     }): void;
     registerList({ list, id, key, parentType, selection, filters, variables, }: {
         list: Required<Required<SubscriptionSelection>['fields'][string]>['list'];

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

@@ -51,7 +51,8 @@ class InMemorySubscriptions {
       this.addFieldSubscription({
         id: parent,
         key,
-        selection: [spec, targetSelection2]
+        selection: [spec, targetSelection2],
+        type
       });
       if (list) {
         this.registerList({
@@ -88,7 +89,8 @@ class InMemorySubscriptions {
   addFieldSubscription({
     id,
     key,
-    selection
+    selection,
+    type
   }) {
     const spec = selection[0];
     if (!this.subscribers[id]) {
@@ -160,7 +162,8 @@ class InMemorySubscriptions {
         this.addFieldSubscription({
           id: parent,
           key,
-          selection: [spec, fieldSelection]
+          selection: [spec, fieldSelection],
+          type: linkedType
         });
         if (list) {
           this.registerList({

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

@@ -54,6 +54,7 @@ class DocumentStore extends import_store.Writable {
       data: initialValue ?? null,
       errors: null,
       partial: false,
+      stale: false,
       source: null,
       fetching,
       variables: null

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

@@ -52,7 +52,8 @@ const cachePolicyPlugin = ({
               data: value.data,
               errors: null,
               source: import_types.DataSource.Cache,
-              partial: value.partial
+              partial: value.partial,
+              stale: value.stale
             });
           }
           useCache = !!(value.data !== null && allowed);
@@ -63,10 +64,11 @@ const cachePolicyPlugin = ({
               data: value.data,
               errors: null,
               source: import_types.DataSource.Cache,
-              partial: value.partial
+              partial: value.partial,
+              stale: value.stale
             });
           }
-          if (useCache && !value.partial) {
+          if (useCache && !value.partial && !value.stale) {
             return;
           }
         }

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

@@ -57,6 +57,7 @@ const fetchPlugin = (target) => {
           data: result.data,
           errors: !result.errors || result.errors.length === 0 ? null : result.errors,
           partial: false,
+          stale: false,
           source: import_types.DataSource.Network
         });
       }

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

@@ -59,6 +59,7 @@ const queryPlugin = (0, import_utils.documentPlugin)(import_types.ArtifactKind.Q
               errors: null,
               fetching: false,
               partial: false,
+              stale: false,
               source: import_types.DataSource.Cache,
               variables: ctx.variables ?? null
             });

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

@@ -1,4 +1,3 @@
-import type { GraphQLObject } from '../../lib/types';
 import type { ClientPluginContext } from '../documentStore';
 export declare function subscriptionPlugin(factory: SubscriptionHandler): import("../documentStore").ClientPlugin;
 export type SubscriptionHandler = (ctx: ClientPluginContext) => {
@@ -7,7 +6,7 @@ export type SubscriptionHandler = (ctx: ClientPluginContext) => {
         variables?: {};
     }, handlers: {
         next: (payload: {
-            data?: GraphQLObject;
+            data?: {} | null;
             errors?: readonly {
                 message: string;
             }[];

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

@@ -66,6 +66,7 @@ function subscriptionPlugin(factory) {
                 errors: [...errors ?? []],
                 fetching: false,
                 partial: true,
+                stale: false,
                 source: import_types.DataSource.Network,
                 variables: ctx.variables ?? null
               });
@@ -74,6 +75,7 @@ function subscriptionPlugin(factory) {
               clearSubscription?.();
               resolve(ctx, {
                 partial: true,
+                stale: false,
                 source: import_types.DataSource.Network,
                 data: null,
                 errors: [data],

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

@@ -55,6 +55,10 @@ export type ConfigFile = {
      * Specifies whether or not the cache should always use partial data. For more information: https://www.houdinigraphql.com/guides/caching-data#partial-data
      */
     defaultPartial?: boolean;
+    /**
+     * Specifies after how long a data goes stale in miliseconds. (default: `undefined`)
+     */
+    defaultLifetime?: number;
     /**
      * Specifies whether mutations should append or prepend list. For more information: https://www.houdinigraphql.com/api/graphql (default: `append`)
      */

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

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

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

@@ -22,3 +22,4 @@ __reExport(lib_exports, require("./log"), module.exports);
 __reExport(lib_exports, require("./scalars"), module.exports);
 __reExport(lib_exports, require("./types"), module.exports);
 __reExport(lib_exports, require("./store"), module.exports);
+__reExport(lib_exports, require("./key"), module.exports);

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

@@ -0,0 +1,6 @@
+export declare const computeKey: ({ field, args }: {
+    field: string;
+    args?: {
+        [key: string]: any;
+    } | undefined;
+}) => string;

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

@@ -0,0 +1,41 @@
+"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 key_exports = {};
+__export(key_exports, {
+  computeKey: () => computeKey
+});
+module.exports = __toCommonJS(key_exports);
+const computeKey = ({ field, args }) => {
+  const keys = Object.keys(args ?? {});
+  keys.sort();
+  return args && keys.length > 0 ? `${field}(${keys.map((key) => `${key}: ${stringifyObjectWithNoQuotesOnKeys(args[key])}`).join(", ")})` : field;
+};
+const stringifyObjectWithNoQuotesOnKeys = (obj_from_json) => {
+  if (Array.isArray(obj_from_json)) {
+    return `[${obj_from_json.map((obj) => `${stringifyObjectWithNoQuotesOnKeys(obj)}`).join(", ")}]`;
+  }
+  if (typeof obj_from_json !== "object" || obj_from_json instanceof Date || obj_from_json === null) {
+    return JSON.stringify(obj_from_json).replace(/"([^"]+)":/g, "$1: ");
+  }
+  return `{${Object.keys(obj_from_json).map((key) => `${key}: ${stringifyObjectWithNoQuotesOnKeys(obj_from_json[key])}`).join(", ")}}`;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  computeKey
+});

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

@@ -80,7 +80,7 @@ export type BaseCompiledDocument = {
         paginated: boolean;
         direction: 'forward' | 'backward' | 'both';
     };
-    pluginsData?: Record<string, any>;
+    plugin_data?: Record<string, any>;
 };
 export type HoudiniFetchContext = {
     variables: () => {};
@@ -164,7 +164,6 @@ export type SubscriptionSpec = {
 export type FetchQueryResult<_Data> = {
     result: RequestPayload<_Data | null>;
     source: DataSource | null;
-    partial: boolean;
 };
 export type QueryResult<_Data = GraphQLObject, _Input = Record<string, any>> = {
     data: _Data | null;
@@ -173,6 +172,7 @@ export type QueryResult<_Data = GraphQLObject, _Input = Record<string, any>> = {
     }[] | null;
     fetching: boolean;
     partial: boolean;
+    stale: boolean;
     source: DataSource | null;
     variables: _Input | null;
 };

package/build/runtime-cjs/public/cache.d.ts

@@ -2,7 +2,7 @@ import type { Cache as _Cache } from '../cache/cache';
 import { type QueryArtifact } from '../lib';
 import { ListCollection } from './list';
 import { Record } from './record';
-import type { CacheTypeDef, IDFields, QueryInput, QueryList, QueryValue, TypeNames, ValidLists } from './types';
+import type { ArgType, CacheTypeDef, IDFields, QueryInput, QueryList, QueryValue, TypeFieldNames, TypeNames, ValidLists } from './types';
 export declare class Cache<Def extends CacheTypeDef> {
     _internal_unstable: _Cache;
     constructor(cache: _Cache);
@@ -29,4 +29,11 @@ export declare class Cache<Def extends CacheTypeDef> {
         data: QueryValue<QueryList<Def>, _Query>;
         variables?: QueryInput<QueryList<Def>, _Query>;
     }): void;
+    /**
+     * Mark some elements of the cache stale.
+     */
+    markStale<_Type extends TypeNames<Def>, _Field extends TypeFieldNames<Def, _Type>>(type?: _Type, options?: {
+        field?: _Field;
+        when?: ArgType<Def, _Type, _Field>;
+    }): void;
 }

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

@@ -87,6 +87,9 @@ Please acknowledge this by setting acceptImperativeInstability to true in your c
     });
     return;
   }
+  markStale(type, options = {}) {
+    return this._internal_unstable.markTypeStale(type, options);
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/build/runtime-cjs/public/record.d.ts

@@ -1,6 +1,6 @@
 import type { FragmentArtifact } from '../lib/types';
 import type { Cache } from './cache';
-import type { CacheTypeDef, FragmentList, FragmentValue, FragmentVariables, ValidTypes } from './types';
+import type { ArgType, CacheTypeDef, FragmentList, FragmentValue, FragmentVariables, TypeFieldNames, ValidTypes } from './types';
 export declare class Record<Def extends CacheTypeDef, Type extends ValidTypes<Def>> {
     #private;
     type: string;
@@ -26,6 +26,16 @@ export declare class Record<Def extends CacheTypeDef, Type extends ValidTypes<De
         fragment: _Fragment;
         data: FragmentValue<FragmentList<Def, Type>, _Fragment>;
         variables?: FragmentVariables<FragmentList<Def, Type>, _Fragment>;
+        forceStale?: boolean;
     }): void;
     delete(): void;
+    /**
+     * Mark some elements of the record stale in the cache.
+     * @param field
+     * @param when
+     */
+    markStale<Field extends TypeFieldNames<Def, Type>>({ field, when, }?: {
+        field?: Field;
+        when?: ArgType<Def, Type, Field>;
+    }): void;
 }

package/build/runtime-cjs/public/record.js

@@ -70,12 +70,19 @@ class Record {
         config: this.#cache.config,
         artifact: args.fragment.artifact,
         input: args.variables
-      }) ?? void 0
+      }) ?? void 0,
+      forceStale: args.forceStale
     });
   }
   delete() {
     this.#cache._internal_unstable.delete(this.#id);
   }
+  markStale({
+    field,
+    when
+  } = {}) {
+    this.#cache._internal_unstable.markRecordStale(this.#id, { field, when });
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/build/runtime-cjs/public/tests/test.d.ts

@@ -1,7 +1,7 @@
 import { type SubscriptionSelection, type FragmentArtifact, type QueryArtifact } from '../../lib';
 import { Cache } from '../cache';
 import type { Record } from '../record';
-type CacheTypeDef = {
+export type CacheTypeDefTest = {
     types: {
         __ROOT__: {
             idFields: {};
@@ -16,23 +16,23 @@ type CacheTypeDef = {
                     args: never;
                 };
                 viewer: {
-                    type: Record<CacheTypeDef, 'User'> | null;
+                    type: Record<CacheTypeDefTest, 'User'> | null;
                     args: never;
                 };
                 pets: {
-                    type: (Record<CacheTypeDef, 'Cat'> | Record<CacheTypeDef, 'User'>)[];
+                    type: (Record<CacheTypeDefTest, 'Cat'> | Record<CacheTypeDefTest, 'User'>)[];
                     args: never;
                 };
                 listOfLists: {
-                    type: ((Record<CacheTypeDef, 'Cat'> | Record<CacheTypeDef, 'User'> | null | (null | Record<CacheTypeDef, 'User'>)[])[] | Record<CacheTypeDef, 'Cat'> | Record<CacheTypeDef, 'User'> | null)[];
+                    type: ((Record<CacheTypeDefTest, 'Cat'> | Record<CacheTypeDefTest, 'User'> | null | (null | Record<CacheTypeDefTest, 'User'>)[])[] | Record<CacheTypeDefTest, 'Cat'> | Record<CacheTypeDefTest, 'User'> | null)[];
                     args: never;
                 };
                 users: {
-                    type: Record<CacheTypeDef, 'User'>[] | null;
+                    type: Record<CacheTypeDefTest, 'User'>[] | null;
                     args: never;
                 };
                 pet: {
-                    type: Record<CacheTypeDef, 'Cat'> | Record<CacheTypeDef, 'User'>;
+                    type: Record<CacheTypeDefTest, 'Cat'> | Record<CacheTypeDefTest, 'User'>;
                     args: never;
                 };
             };
@@ -60,7 +60,7 @@ type CacheTypeDef = {
                     args: never;
                 };
                 parent: {
-                    type: Record<CacheTypeDef, 'User'>;
+                    type: Record<CacheTypeDefTest, 'User'>;
                     args: never;
                 };
                 id: {
@@ -84,7 +84,7 @@ type CacheTypeDef = {
                     args: never;
                 };
                 parent: {
-                    type: Record<CacheTypeDef, 'User'> | null;
+                    type: Record<CacheTypeDefTest, 'User'> | null;
                     args: never;
                 };
                 id: {
@@ -147,11 +147,10 @@ type CacheTypeDef = {
         };
     };
 };
-export declare const testCache: () => Cache<CacheTypeDef>;
+export declare const testCache: () => Cache<CacheTypeDefTest>;
 export declare const testFragment: (selection: SubscriptionSelection) => {
     artifact: FragmentArtifact;
 };
 export declare const testQuery: (selection: SubscriptionSelection) => {
     artifact: QueryArtifact;
 };
-export {};

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

@@ -4,9 +4,10 @@ import { GarbageCollector } from './gc';
 import type { ListCollection } from './lists';
 import { ListManager } from './lists';
 import { SchemaManager } from './schema';
+import { StaleManager } from './staleManager';
 import type { Layer, LayerID } from './storage';
 import { InMemoryStorage } from './storage';
-import { type FieldSelection, InMemorySubscriptions } from './subscription';
+import { InMemorySubscriptions, type FieldSelection } from './subscription';
 export declare class Cache {
     _internal_unstable: CacheInternal;
     constructor(config?: ConfigFile);
@@ -21,16 +22,27 @@ export declare class Cache {
         applyUpdates?: string[];
         notifySubscribers?: SubscriptionSpec[];
         forceNotify?: boolean;
+        forceStale?: boolean;
     }): SubscriptionSpec[];
     read(...args: Parameters<CacheInternal['getSelection']>): {
         data: GraphQLObject | null;
         partial: boolean;
+        stale: boolean;
     };
     subscribe(spec: SubscriptionSpec, variables?: {}): void;
     unsubscribe(spec: SubscriptionSpec, variables?: {}): void;
     list(name: string, parentID?: string, allLists?: boolean): ListCollection;
     delete(id: string): void;
     setConfig(config: ConfigFile): void;
+    markTypeStale(type?: string, options?: {
+        field?: string;
+        when?: {};
+    }): void;
+    markRecordStale(id: string, options: {
+        field?: string;
+        when?: {};
+    }): void;
+    getFieldTime(id: string, field: string): number | null | undefined;
 }
 declare class CacheInternal {
     private _disabled;
@@ -40,17 +52,19 @@ declare class CacheInternal {
     lists: ListManager;
     cache: Cache;
     lifetimes: GarbageCollector;
+    staleManager: StaleManager;
     schema: SchemaManager;
-    constructor({ storage, subscriptions, lists, cache, lifetimes, schema, }: {
+    constructor({ storage, subscriptions, lists, cache, lifetimes, staleManager, schema, }: {
         storage: InMemoryStorage;
         subscriptions: InMemorySubscriptions;
         lists: ListManager;
         cache: Cache;
         lifetimes: GarbageCollector;
+        staleManager: StaleManager;
         schema: SchemaManager;
     });
     setConfig(config: ConfigFile): void;
-    writeSelection({ data, selection, variables, parent, applyUpdates, layer, toNotify, forceNotify, }: {
+    writeSelection({ data, selection, variables, parent, applyUpdates, layer, toNotify, forceNotify, forceStale, }: {
         data: {
             [key: string]: GraphQLValue;
         };
@@ -64,6 +78,7 @@ declare class CacheInternal {
         toNotify?: FieldSelection[];
         applyUpdates?: string[];
         forceNotify?: boolean;
+        forceStale?: boolean;
     }): FieldSelection[];
     getSelection({ selection, parent, variables, stepsFromConnection, }: {
         selection: SubscriptionSelection;
@@ -73,6 +88,7 @@ declare class CacheInternal {
     }): {
         data: GraphQLObject | null;
         partial: boolean;
+        stale: boolean;
         hasData: boolean;
     };
     id(type: string, data: {} | null): string | null;
@@ -87,6 +103,7 @@ declare class CacheInternal {
     }): {
         data: LinkedList<GraphQLValue>;
         partial: boolean;
+        stale: boolean;
         hasData: boolean;
     };
     extractNestedListIDs({ value, abstract, recordID, key, linkedType, fields, variables, applyUpdates, specs, layer, forceNotify, }: {