houdini 1.0.0-next.2 → 1.0.0-next.21

package/build/runtime-esm/cache/lists.js

@@ -1,5 +1,5 @@
+import { flatten } from "../lib/flatten";
 import { rootID } from "./cache";
-import { flattenList } from "./stuff";
 class ListManager {
   rootID;
   cache;
@@ -151,7 +151,7 @@ class List {
                 edges: {
                   keyRaw: "edges",
                   type: "ConnectionEdge",
-                  update: where === "first" ? "prepend" : "append",
+                  updates: ["append", "prepend"],
                   selection: {
                     fields: {
                       node: {
@@ -187,7 +187,7 @@ class List {
           newEntries: {
             keyRaw: this.key,
             type: listType,
-            update: where === "first" ? "prepend" : "append",
+            updates: ["append", "prepend"],
             selection: {
               ...selection,
               fields: {
@@ -210,7 +210,7 @@ class List {
       data: insertData,
       variables,
       parent: this.recordID,
-      applyUpdates: true
+      applyUpdates: [where === "first" ? "prepend" : "append"]
     });
   }
   removeID(id, variables = {}) {
@@ -233,7 +233,7 @@ class List {
         embeddedConnectionID,
         "edges"
       );
-      for (const edge of flattenList(edges) || []) {
+      for (const edge of flatten(edges) || []) {
         if (!edge) {
           continue;
         }
@@ -311,7 +311,7 @@ class List {
     let entries = [];
     let value = this.cache._internal_unstable.storage.get(this.recordID, this.key).value;
     if (!this.connection) {
-      entries = flattenList(value);
+      entries = flatten(value);
     } else {
       entries = this.cache._internal_unstable.storage.get(value, "edges").value;
     }
@@ -325,6 +325,9 @@ class ListCollection {
   constructor(lists) {
     this.lists = lists;
   }
+  get selection() {
+    return this.lists[0].selection;
+  }
   append(...args) {
     this.lists.forEach((list) => list.append(...args));
   }

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

@@ -0,0 +1,30 @@
+import type { Cache } from './cache';
+export declare class StaleManager {
+    #private;
+    cache: Cache;
+    private fieldsTime;
+    constructor(cache: Cache);
+    /**
+     * get the FieldTime info
+     * @param id User:1
+     * @param field firstName
+     */
+    getFieldTime(id: string, field: string): number | undefined | null;
+    /**
+     * set the date to a field
+     * @param id User:1
+     * @param field firstName
+     */
+    setFieldTimeToNow(id: string, field: string): void;
+    /**
+     * set null to a field (stale)
+     * @param id User:1
+     * @param field firstName
+     */
+    markFieldStale(id: string, field: string): void;
+    markAllStale(): void;
+    markRecordStale(id: string): void;
+    markTypeStale(type: string): void;
+    markTypeFieldStale(type: string, field: string, when?: {}): void;
+    delete(id: string, field: string): void;
+}

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

@@ -0,0 +1,71 @@
+import { computeKey } from "../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 = 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);
+      }
+    }
+  }
+}
+export {
+  StaleManager
+};

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

@@ -7,7 +7,7 @@ export declare class InMemoryStorage {
     get layerCount(): number;
     get nextRank(): number;
     createLayer(optimistic?: boolean): Layer;
-    insert(id: string, field: string, location: OperationLocation, target: string): void;
+    insert(id: string, field: string, location: OperationLocations, target: string): void;
     remove(id: string, field: string, target: string): void;
     delete(id: string): void;
     deleteField(id: string, field: string): void;
@@ -21,7 +21,7 @@ export declare class InMemoryStorage {
         kind: 'link' | 'scalar' | 'unknown';
         displayLayers: number[];
     };
-    writeLink(id: string, field: string, value: string | LinkedList): number;
+    writeLink(id: string, field: string, value: string | NestedList): number;
     writeField(id: string, field: string, value: GraphQLValue): number;
     resolveLayer(id: number): void;
     get topLayer(): Layer;
@@ -37,7 +37,7 @@ export declare class Layer {
     get(id: string, field: string): [GraphQLField, 'link' | 'scalar'];
     getOperations(id: string, field: string): Operation[] | undefined;
     writeField(id: string, field: string, value: GraphQLField): LayerID;
-    writeLink(id: string, field: string, value: null | string | LinkedList): LayerID;
+    writeLink(id: string, field: string, value: null | string | NestedList): LayerID;
     isDisplayLayer(displayLayers: number[]): boolean;
     clear(): void;
     replaceID({ from, to }: {
@@ -47,19 +47,19 @@ export declare class Layer {
     removeUndefinedFields(): void;
     delete(id: string): void;
     deleteField(id: string, field: string): void;
-    insert(id: string, field: string, where: OperationLocation, target: string): void;
+    insert(id: string, field: string, where: OperationLocations, target: string): void;
     remove(id: string, field: string, target: string): void;
     writeLayer(layer: Layer): void;
     private addFieldOperation;
 }
-type GraphQLField = GraphQLValue | LinkedList;
+type GraphQLField = GraphQLValue | NestedList;
 type EntityMap<_Value> = {
     [id: string]: {
         [field: string]: _Value;
     };
 };
 type EntityFieldMap = EntityMap<GraphQLField>;
-type LinkMap = EntityMap<string | null | LinkedList>;
+type LinkMap = EntityMap<string | null | NestedList>;
 type OperationMap = {
     [id: string]: {
         deleted?: boolean;
@@ -69,30 +69,33 @@ type OperationMap = {
         };
     };
 };
-type LinkedList<_Result = string> = (_Result | null | LinkedList<_Result>)[];
+type NestedList<_Result = string> = (_Result | null | NestedList<_Result>)[];
 type InsertOperation = {
-    kind: OperationKind.insert;
-    location: OperationLocation;
+    kind: 'insert';
+    location: OperationLocations;
     id: string;
 };
 type RemoveOperation = {
-    kind: OperationKind.remove;
+    kind: 'remove';
     id: string;
 };
 type DeleteOperation = {
-    kind: OperationKind.delete;
+    kind: 'delete';
     target: string;
 };
 type ListOperation = InsertOperation | RemoveOperation;
 type Operation = ListOperation | DeleteOperation;
-export declare enum OperationLocation {
-    start = "start",
-    end = "end"
-}
-export declare enum OperationKind {
-    delete = "delete",
-    insert = "insert",
-    remove = "remove"
-}
+type ValuesOf<Target> = Target[keyof Target];
+export declare const OperationLocation: {
+    readonly start: "start";
+    readonly end: "end";
+};
+export type OperationLocations = ValuesOf<typeof OperationLocation>;
+export declare const OperationKind: {
+    readonly delete: "delete";
+    readonly insert: "insert";
+    readonly remove: "remove";
+};
+export type OperationKinds = ValuesOf<typeof OperationKind>;
 export type LayerID = number;
 export {};

package/build/runtime-esm/cache/storage.js

@@ -1,4 +1,4 @@
-import { flattenList } from "./stuff";
+import { flatten } from "../lib/flatten";
 class InMemoryStorage {
   data;
   idCount = 0;
@@ -198,7 +198,7 @@ class Layer {
   }
   writeLink(id, field, value) {
     const valueList = Array.isArray(value) ? value : [value];
-    for (const value2 of flattenList(valueList)) {
+    for (const value2 of flatten(valueList)) {
       if (!value2) {
         continue;
       }
@@ -350,17 +350,15 @@ function isInsertOperation(value) {
 function isRemoveOperation(value) {
   return !!value && value.kind === OperationKind.remove;
 }
-var OperationLocation = /* @__PURE__ */ ((OperationLocation2) => {
-  OperationLocation2["start"] = "start";
-  OperationLocation2["end"] = "end";
-  return OperationLocation2;
-})(OperationLocation || {});
-var OperationKind = /* @__PURE__ */ ((OperationKind2) => {
-  OperationKind2["delete"] = "delete";
-  OperationKind2["insert"] = "insert";
-  OperationKind2["remove"] = "remove";
-  return OperationKind2;
-})(OperationKind || {});
+const OperationLocation = {
+  start: "start",
+  end: "end"
+};
+const OperationKind = {
+  delete: "delete",
+  insert: "insert",
+  remove: "remove"
+};
 export {
   InMemoryStorage,
   Layer,

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

@@ -1,6 +1,4 @@
 import type { GraphQLValue } from '../lib/types';
-import type { LinkedList } from './cache';
-export declare function flattenList<T>(source: LinkedList<T>): T[];
 export declare function evaluateKey(key: string, variables?: {
     [key: string]: GraphQLValue;
 }): string;

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

@@ -1,18 +1,3 @@
-function flattenList(source) {
-  const flat = [];
-  const unvisited = [source || []];
-  while (unvisited.length > 0) {
-    const target = unvisited.shift();
-    for (const id of target) {
-      if (Array.isArray(id)) {
-        unvisited.push(id);
-        continue;
-      }
-      flat.push(id);
-    }
-  }
-  return flat;
-}
 function evaluateKey(key, variables = {}) {
   let evaluated = "";
   let varName = "";
@@ -40,6 +25,5 @@ function evaluateKey(key, variables = {}) {
 }
 const varChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789";
 export {
-  evaluateKey,
-  flattenList
+  evaluateKey
 };

package/build/runtime-esm/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-esm/cache/subscription.js

@@ -1,5 +1,6 @@
+import { flatten } from "../lib/flatten";
 import { getFieldsForType } from "../lib/selection";
-import { evaluateKey, flattenList } from "./stuff";
+import { evaluateKey } from "./stuff";
 class InMemorySubscriptions {
   cache;
   constructor(cache) {
@@ -28,7 +29,8 @@ class InMemorySubscriptions {
       this.addFieldSubscription({
         id: parent,
         key,
-        selection: [spec, targetSelection2]
+        selection: [spec, targetSelection2],
+        type
       });
       if (list) {
         this.registerList({
@@ -46,7 +48,7 @@ class InMemorySubscriptions {
           parent,
           key
         );
-        let children = !Array.isArray(linkedRecord) ? [linkedRecord] : flattenList(linkedRecord) || [];
+        let children = !Array.isArray(linkedRecord) ? [linkedRecord] : flatten(linkedRecord) || [];
         for (const child of children) {
           if (!child) {
             continue;
@@ -65,7 +67,8 @@ class InMemorySubscriptions {
   addFieldSubscription({
     id,
     key,
-    selection
+    selection,
+    type
   }) {
     const spec = selection[0];
     if (!this.subscribers[id]) {
@@ -137,7 +140,8 @@ class InMemorySubscriptions {
         this.addFieldSubscription({
           id: parent,
           key,
-          selection: [spec, fieldSelection]
+          selection: [spec, fieldSelection],
+          type: linkedType
         });
         if (list) {
           this.registerList({
@@ -153,7 +157,7 @@ class InMemorySubscriptions {
         const childSelection = selection.selection;
         if (childSelection) {
           const { value: link } = this.cache._internal_unstable.storage.get(parent, key);
-          const children = !Array.isArray(link) ? [link] : flattenList(link);
+          const children = !Array.isArray(link) ? [link] : flatten(link);
           for (const linkedRecord of children) {
             if (!linkedRecord) {
               continue;
@@ -189,7 +193,7 @@ class InMemorySubscriptions {
         continue;
       }
       const { value: previousValue } = this.cache._internal_unstable.storage.get(id, key);
-      const links = !Array.isArray(previousValue) ? [previousValue] : flattenList(previousValue);
+      const links = !Array.isArray(previousValue) ? [previousValue] : flatten(previousValue);
       for (const link of links) {
         if (link !== null) {
           linkedIDs.push([link, fieldSelection.selection || {}]);
@@ -229,7 +233,7 @@ class InMemorySubscriptions {
       if (kind === "scalar") {
         continue;
       }
-      const nextTargets = Array.isArray(value) ? flattenList(value) : [value];
+      const nextTargets = Array.isArray(value) ? flatten(value) : [value];
       for (const id2 of nextTargets) {
         if (visited.includes(id2)) {
           continue;

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

@@ -2,31 +2,23 @@ import type { HoudiniClient } from '.';
 import type { Layer } from '../cache/storage';
 import type { ConfigFile } from '../lib/config';
 import { Writable } from '../lib/store';
-import type { CachePolicy, DocumentArtifact, QueryResult, GraphQLObject, SubscriptionSpec } from '../lib/types';
+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>> {
     #private;
     constructor({ artifact, plugins, pipeline, client, cache, initialValue, fetching, }: {
         artifact: DocumentArtifact;
-        plugins?: ClientPlugin[];
-        pipeline?: ClientPlugin[];
-        client: HoudiniClient;
+        plugins?: ClientHooks[];
+        pipeline?: ClientHooks[];
+        client: HoudiniClient | null;
         cache?: boolean;
         initialValue?: _Data | null;
         fetching?: boolean;
     });
-    send({ metadata, session, fetch, variables, policy, stuff, cacheParams, setup, }?: {
-        fetch?: Fetch;
-        variables?: Record<string, any> | null;
-        metadata?: App.Metadata | null;
-        session?: App.Session | null;
-        policy?: CachePolicy;
-        stuff?: Partial<App.Stuff>;
-        cacheParams?: ClientPluginContext['cacheParams'];
-        setup?: boolean;
-    }): Promise<QueryResult<_Data, _Input>>;
+    send({ metadata, session, fetch, variables, policy, stuff, cacheParams, setup, silenceEcho, }?: SendParams): Promise<QueryResult<_Data, _Input>>;
 }
 declare function marshalVariables<_Data extends GraphQLObject, _Input extends {}>(ctx: ClientPluginContext): Record<string, any>;
-export type ClientPlugin = () => {
+export type ClientPlugin = () => ClientHooks | null | (ClientHooks | ClientPlugin | null)[];
+export type ClientHooks = {
     start?: ClientPluginEnterPhase;
     beforeNetwork?: ClientPluginEnterPhase;
     network?: ClientPluginEnterPhase;
@@ -41,7 +33,7 @@ export type ClientPluginContext = {
     text: string;
     hash: string;
     artifact: DocumentArtifact;
-    policy?: CachePolicy;
+    policy?: CachePolicies;
     fetch?: Fetch;
     variables?: Record<string, any>;
     metadata?: App.Metadata | null;
@@ -53,7 +45,7 @@ export type ClientPluginContext = {
         forceNotify?: boolean;
         disableWrite?: boolean;
         disableRead?: boolean;
-        applyUpdates?: boolean;
+        applyUpdates?: string[];
     };
     stuff: App.Stuff;
 };
@@ -84,4 +76,15 @@ export type ClientPluginExitHandlers = Omit<ClientPluginEnterHandlers, 'resolve'
 export type ClientPluginErrorHandlers = ClientPluginEnterHandlers & {
     error: unknown;
 };
+export type SendParams = {
+    fetch?: Fetch;
+    variables?: Record<string, any> | null;
+    metadata?: App.Metadata | null;
+    session?: App.Session | null;
+    policy?: CachePolicies;
+    stuff?: Partial<App.Stuff>;
+    cacheParams?: ClientPluginContext['cacheParams'];
+    setup?: boolean;
+    silenceEcho?: boolean;
+};
 export {};

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

@@ -3,7 +3,7 @@ import { deepEquals } from "../lib/deepEquals";
 import { marshalInputs, unmarshalSelection } from "../lib/scalars";
 import { Writable } from "../lib/store";
 import { ArtifactKind } from "../lib/types";
-import { cachePolicyPlugin } from "./plugins";
+import { cachePolicy } from "./plugins";
 const steps = {
   forward: ["start", "beforeNetwork", "network"],
   backwards: ["end", "afterNetwork"]
@@ -24,16 +24,15 @@ class DocumentStore extends Writable {
     initialValue,
     fetching
   }) {
-    if (fetching === void 0) {
-      fetching = artifact.kind === ArtifactKind.Query;
-    }
+    fetching ??= artifact.kind === ArtifactKind.Query;
     const initialState = {
       data: initialValue ?? null,
       errors: null,
       partial: false,
+      stale: false,
       source: null,
       fetching,
-      variables: null
+      variables: {}
     };
     super(initialState, () => {
       return () => {
@@ -47,13 +46,13 @@ class DocumentStore extends Writable {
     this.#client = client;
     this.#lastVariables = null;
     this.#configFile = getCurrentConfig();
-    this.#plugins = (pipeline ?? [
-      cachePolicyPlugin({
+    this.#plugins = pipeline ?? [
+      cachePolicy({
         enabled: cache,
         setFetching: (fetching2) => this.update((state) => ({ ...state, fetching: fetching2 }))
-      }),
+      })(),
       ...plugins ?? []
-    ]).map((factory) => factory());
+    ];
   }
   async send({
     metadata,
@@ -63,7 +62,8 @@ class DocumentStore extends Writable {
     policy,
     stuff,
     cacheParams,
-    setup = false
+    setup = false,
+    silenceEcho = false
   } = {}) {
     let context = new ClientPluginContextWrapper({
       config: this.#configFile,
@@ -94,6 +94,7 @@ class DocumentStore extends Writable {
         setup,
         currentStep: 0,
         index: 0,
+        silenceEcho,
         promise: {
           resolved: false,
           resolve,
@@ -231,6 +232,9 @@ class DocumentStore extends Writable {
     }
     this.#lastContext = ctx.context.draft();
     this.#lastVariables = this.#lastContext.stuff.inputs.marshaled;
+    if (ctx.silenceEcho && finalValue.data === this.state.data) {
+      return;
+    }
     this.set(finalValue);
   }
 }

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

@@ -1,25 +1,27 @@
 /// <reference path="../../../../../houdini.d.ts" />
-import type { DocumentArtifact, GraphQLObject } from '../lib/types';
-import type { ClientPlugin } from './documentStore';
+import type { DocumentArtifact, GraphQLObject, NestedList } from '../lib/types';
+import type { ClientPlugin, ClientHooks } from './documentStore';
 import { DocumentStore } from './documentStore';
 import { type FetchParamFn, type ThrowOnErrorParams } from './plugins';
 export { DocumentStore, type ClientPlugin } from './documentStore';
-export { fetchPlugin, mutationPlugin, queryPlugin, subscriptionPlugin } from './plugins';
+export { fetch, mutation, query, subscription } from './plugins';
 type ConstructorArgs = {
     url: string;
     fetchParams?: FetchParamFn;
-    plugins?: ClientPlugin[];
-    pipeline?: ClientPlugin[];
+    plugins?: NestedList<ClientPlugin>;
+    pipeline?: NestedList<ClientPlugin>;
     throwOnError?: ThrowOnErrorParams;
 };
+export type ObserveParams<_Data extends GraphQLObject, _Artifact extends DocumentArtifact = DocumentArtifact> = {
+    artifact: _Artifact;
+    cache?: boolean;
+    initialValue?: _Data | null;
+    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, }: {
-        artifact: DocumentArtifact;
-        cache?: boolean;
-        initialValue?: _Data | null;
-        fetching?: boolean;
-    }): DocumentStore<_Data, _Input>;
+    observe<_Data extends GraphQLObject, _Input extends Record<string, any>>({ artifact, cache, initialValue, fetching, }: ObserveParams<_Data>): DocumentStore<_Data, _Input>;
 }
+export declare function createPluginHooks(plugins: ClientPlugin[]): ClientHooks[];