houdini 1.0.0-next.1 → 1.0.0-next.3

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

@@ -1,5 +1,6 @@
-import { Cache } from './cache';
-import type { ArgType, CacheTypeDef, FieldType, TypeFieldNames, ValidTypes } from './types';
+import type { FragmentArtifact } from '../lib/types';
+import type { Cache } from './cache';
+import type { CacheTypeDef, FragmentList, FragmentValue, FragmentVariables, ValidTypes } from './types';
 export declare class Record<Def extends CacheTypeDef, Type extends ValidTypes<Def>> {
     #private;
     type: string;
@@ -10,22 +11,21 @@ export declare class Record<Def extends CacheTypeDef, Type extends ValidTypes<De
         idFields: {};
         id: string;
     });
-    set<Field extends TypeFieldNames<Def, Type>>({ field, args, value, }: {
-        field: Field;
-        args?: ArgType<Def, Type, Field>;
-        value: FieldType<Def, Type, Field>;
+    read<_Fragment extends {
+        artifact: FragmentArtifact;
+    }>({ fragment, variables, }: {
+        fragment: _Fragment;
+        variables?: FragmentVariables<FragmentList<Def, Type>, _Fragment>;
+    }): {
+        data: FragmentValue<FragmentList<Def, Type>, _Fragment> | null;
+        partial: boolean;
+    };
+    write<_Fragment extends {
+        artifact: FragmentArtifact;
+    }, _Variable>(args: {
+        fragment: _Fragment;
+        data: FragmentValue<FragmentList<Def, Type>, _Fragment>;
+        variables?: FragmentVariables<FragmentList<Def, Type>, _Fragment>;
     }): void;
-    get<Field extends TypeFieldNames<Def, Type>>({ field, args, }: {
-        field: Field;
-        args?: ArgType<Def, Type, Field>;
-    }): FieldType<Def, Type, Field>;
     delete(): void;
 }
-export declare function computeKey({ field, args }: {
-    field: string;
-    args?: {
-        [key: string]: any;
-    };
-}): string;
-export declare const stringifyObjectWithNoQuotesOnKeys: (obj_from_json: {}) => string;
-export declare function marshalNestedList(list: any[]): any[];

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

@@ -1,9 +1,11 @@
+import { type SubscriptionSelection, type FragmentArtifact, type QueryArtifact } from '../../lib';
 import { Cache } from '../cache';
-import { Record } from '../record';
+import type { Record } from '../record';
 type CacheTypeDef = {
     types: {
         __ROOT__: {
             idFields: {};
+            fragments: [];
             fields: {
                 test: {
                     type: number | null;
@@ -39,6 +41,19 @@ type CacheTypeDef = {
             idFields: {
                 id: string;
             };
+            fragments: [
+                [
+                    {
+                        artifact: FragmentArtifact;
+                    },
+                    {
+                        firstName: string;
+                    },
+                    {
+                        pattern: string;
+                    }
+                ]
+            ];
             fields: {
                 firstName: {
                     type: string;
@@ -62,6 +77,7 @@ type CacheTypeDef = {
             idFields: {
                 id: string;
             };
+            fragments: [];
             fields: {
                 name: {
                     type: string | null;
@@ -85,6 +101,7 @@ type CacheTypeDef = {
             idFields: {
                 id: string;
             };
+            fragments: [];
             fields: {
                 name: {
                     type: string | null;
@@ -97,6 +114,26 @@ type CacheTypeDef = {
             };
         };
     };
+    queries: [
+        [
+            {
+                artifact: QueryArtifact;
+            },
+            {
+                viewer: {
+                    id: string;
+                    firstName: string;
+                    __typename: string;
+                    parent: {
+                        id: string;
+                        firstName: string;
+                        __typename: string;
+                    };
+                };
+            },
+            any
+        ]
+    ];
     lists: {
         All_Pets: {
             types: 'User' | 'Cat';
@@ -111,4 +148,10 @@ type CacheTypeDef = {
     };
 };
 export declare const testCache: () => Cache<CacheTypeDef>;
+export declare const testFragment: (selection: SubscriptionSelection) => {
+    artifact: FragmentArtifact;
+};
+export declare const testQuery: (selection: SubscriptionSelection) => {
+    artifact: QueryArtifact;
+};
 export {};

package/build/runtime/public/types.d.ts

@@ -11,6 +11,7 @@ export type CacheTypeDef = {
                     type: any;
                 };
             };
+            fragments: [any, any, any][];
         };
     };
     lists: {
@@ -19,11 +20,14 @@ export type CacheTypeDef = {
             filters: any;
         };
     };
+    queries: [any, any, any][];
 };
 export type ValidTypes<Def extends CacheTypeDef> = keyof Def['types'];
 export type TypeFields<Def extends CacheTypeDef, Type extends keyof Def['types']> = Def['types'][Type]['fields'];
 export type TypeFieldNames<Def extends CacheTypeDef, Type extends keyof Def['types']> = Extract<keyof TypeFields<Def, Type>, string>;
 export type TypeNames<Def extends CacheTypeDef> = Extract<Exclude<ValidTypes<Def>, '__ROOT__'>, string>;
+export type FragmentList<Def extends CacheTypeDef, Type extends ValidTypes<Def>> = Def['types'][Type]['fragments'];
+export type QueryList<Def extends CacheTypeDef> = Def['queries'];
 export type IDFields<Def extends CacheTypeDef, Type extends keyof Def['types']> = Def['types'][Type]['idFields'];
 export type ProxyUnion<Def extends CacheTypeDef, U> = U extends null ? null : U extends TypeNames<Def> ? Record<Def, U> : never;
 export type FieldType<Def extends CacheTypeDef, Type extends keyof Def['types'], Field extends keyof TypeFields<Def, Type>> = TypeFields<Def, Type>[Field]['type'];
@@ -34,3 +38,7 @@ export type ListFilters<Def extends CacheTypeDef, ListName extends ValidLists<De
     must_not?: Def['lists'][ListName]['filters'];
 } : never;
 export type ListType<Def extends CacheTypeDef, Name extends ValidLists<Def>> = ProxyUnion<Def, Def['lists'][Name]['types']>;
+export type FragmentVariables<_List, _Target> = _List extends [infer Head, ...infer Rest] ? Head extends [infer _Key, infer _Value, infer _Input] ? _Key extends _Target ? _Input : FragmentValue<Rest, _Target> : 'Encountered unknown fragment. Please make sure your runtime is up to date (ie, `vite dev` or `vite build`).' : 'Encountered unknown fragment. Please make sure your runtime is up to date (ie, `vite dev` or `vite build`).';
+export type FragmentValue<List, _Target> = List extends [infer Head, ...infer Rest] ? Head extends [infer _Key, infer _Value, infer _Input] ? _Key extends _Target ? _Value : FragmentValue<Rest, _Target> : 'Encountered unknown fragment. Please make sure your runtime is up to date (ie, `vite dev` or `vite build`).' : 'Encountered unknown fragment. Please make sure your runtime is up to date (ie, `vite dev` or `vite build`).';
+export type QueryValue<List, _Target> = List extends [infer Head, ...infer Rest] ? Head extends [infer _Key, infer _Value, infer _Input] ? _Key extends _Target ? _Value : QueryValue<Rest, _Target> : 'Encountered unknown query.Please make sure your runtime is up to date (ie, `vite dev` or `vite build`).' : 'Encountered unknown query.Please make sure your runtime is up to date (ie, `vite dev` or `vite build`).';
+export type QueryInput<List, _Target> = List extends [infer Head, ...infer Rest] ? Head extends [infer _Key, infer _Value, infer _Input] ? _Key extends _Target ? _Input : QueryValue<Rest, _Target> : 'Encountered unknown query.Please make sure your runtime is up to date (ie, `vite dev` or `vite build`).' : 'Encountered unknown query.Please make sure your runtime is up to date (ie, `vite dev` or `vite build`).';

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

@@ -1,10 +1,12 @@
-import { ConfigFile } from '../lib/config';
-import { GraphQLObject, GraphQLValue, SubscriptionSelection, SubscriptionSpec } from '../lib/types';
+import type { ConfigFile } from '../lib/config';
+import type { GraphQLObject, GraphQLValue, SubscriptionSelection, SubscriptionSpec } from '../lib/types';
 import { GarbageCollector } from './gc';
-import { ListCollection, ListManager } from './lists';
+import type { ListCollection } from './lists';
+import { ListManager } from './lists';
 import { SchemaManager } from './schema';
-import { InMemoryStorage, Layer, LayerID } from './storage';
-import { InMemorySubscriptions } from './subscription';
+import type { Layer, LayerID } from './storage';
+import { InMemoryStorage } from './storage';
+import { type FieldSelection, InMemorySubscriptions } from './subscription';
 export declare class Cache {
     _internal_unstable: CacheInternal;
     constructor(config?: ConfigFile);
@@ -59,10 +61,10 @@ declare class CacheInternal {
         parent?: string;
         root?: string;
         layer: Layer;
-        toNotify?: SubscriptionSpec[];
+        toNotify?: FieldSelection[];
         applyUpdates?: boolean;
         forceNotify?: boolean;
-    }): SubscriptionSpec[];
+    }): FieldSelection[];
     getSelection({ selection, parent, variables, stepsFromConnection, }: {
         selection: SubscriptionSelection;
         parent?: string;
@@ -94,7 +96,7 @@ declare class CacheInternal {
         linkedType: string;
         abstract: boolean;
         variables: {};
-        specs: SubscriptionSpec[];
+        specs: FieldSelection[];
         applyUpdates: boolean;
         fields: SubscriptionSelection;
         layer: Layer;

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

@@ -52,7 +52,7 @@ class Cache {
     ...args
   }) {
     const layer = layerID ? this._internal_unstable.storage.getLayer(layerID) : this._internal_unstable.storage.topLayer;
-    const subscribers = this._internal_unstable.writeSelection({ ...args, layer });
+    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)) {
@@ -190,6 +190,7 @@ class CacheInternal {
         link: !!fieldSelection
       });
       const currentSubscribers = this.subscriptions.get(parent, key);
+      const specs = currentSubscribers.map((sub) => sub[0]);
       const { value: previousValue, displayLayers } = this.storage.get(parent, key);
       const displayLayer = layer.isDisplayLayer(displayLayers);
       if (displayLayer) {
@@ -215,7 +216,7 @@ class CacheInternal {
         }
         const previousLinks = (0, import_stuff.flattenList)([previousValue]);
         for (const link of previousLinks) {
-          this.subscriptions.remove(link, fieldSelection, currentSubscribers, variables);
+          this.subscriptions.remove(link, fieldSelection, specs, variables);
         }
         layer.writeLink(parent, key, null);
         toNotify.push(...currentSubscribers);
@@ -239,16 +240,10 @@ class CacheInternal {
         layer.writeLink(parent, key, linkedID);
         if (linkedID && displayLayer && (linkChange || forceNotify)) {
           if (previousValue && typeof previousValue === "string") {
-            this.subscriptions.remove(
-              previousValue,
-              fieldSelection,
-              currentSubscribers,
-              variables
-            );
+            this.subscriptions.remove(previousValue, fieldSelection, specs, variables);
           }
           this.subscriptions.addMany({
             parent: linkedID,
-            selection: fieldSelection,
             subscribers: currentSubscribers,
             variables,
             parentType: linkedType
@@ -343,7 +338,7 @@ class CacheInternal {
           if (linkedIDs.includes(lostID) || !lostID) {
             continue;
           }
-          this.subscriptions.remove(lostID, fieldSelection, currentSubscribers, variables);
+          this.subscriptions.remove(lostID, fieldSelection, specs, variables);
         }
         if (contentChanged || oldIDs.length === 0 && newIDs.length === 0) {
           layer.writeLink(parent, key, linkedIDs);
@@ -354,7 +349,6 @@ class CacheInternal {
           }
           this.subscriptions.addMany({
             parent: id,
-            selection: fieldSelection,
             subscribers: currentSubscribers,
             variables,
             parentType: linkedType

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

@@ -1,4 +1,4 @@
-import { Cache } from './cache';
+import type { Cache } from './cache';
 export declare class GarbageCollector {
     cache: Cache;
     private lifetimes;

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

@@ -1,5 +1,5 @@
-import { SubscriptionSelection, ListWhen, SubscriptionSpec } from '../lib/types';
-import { Cache } from './cache';
+import type { SubscriptionSelection, ListWhen, SubscriptionSpec } from '../lib/types';
+import type { Cache } from './cache';
 export declare class ListManager {
     rootID: string;
     cache: Cache;
@@ -55,6 +55,7 @@ export declare class List {
 export declare class ListCollection {
     lists: List[];
     constructor(lists: List[]);
+    get selection(): SubscriptionSelection;
     append(...args: Parameters<List['append']>): void;
     prepend(...args: Parameters<List['prepend']>): void;
     addToList(...args: Parameters<List['addToList']>): void;

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

@@ -282,11 +282,11 @@ class List {
     this.cache._internal_unstable.subscriptions.remove(
       targetID,
       this.connection ? this.selection.fields.edges.selection : this.selection,
-      subscribers,
+      subscribers.map((sub) => sub[0]),
       variables
     );
     this.cache._internal_unstable.storage.remove(parentID, targetKey, targetID);
-    for (const spec of subscribers) {
+    for (const [spec] of subscribers) {
       spec.set(
         this.cache._internal_unstable.getSelection({
           parent: spec.parentID || this.manager.rootID,
@@ -350,6 +350,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-cjs/cache/schema.d.ts

@@ -1,5 +1,5 @@
-import { ConfigFile } from '../lib';
-import { Cache } from './cache';
+import type { ConfigFile } from '../lib/config';
+import type { Cache } from './cache';
 export type TypeInfo = {
     type: string;
     nullable: boolean;

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

@@ -1,5 +1,5 @@
-import { GraphQLValue } from '../lib/types';
-import { LinkedList } from './cache';
+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;

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

@@ -1,6 +1,9 @@
-import type { SubscriptionSpec, SubscriptionSelection, GraphQLObject } from '../lib/types';
-import type { GraphQLValue } from '../lib/types';
-import { Cache } from './cache';
+import type { GraphQLValue, SubscriptionSelection, SubscriptionSpec } from '../lib/types';
+import type { Cache } from './cache';
+export type FieldSelection = [
+    SubscriptionSpec,
+    Required<SubscriptionSelection>['fields'] | undefined
+];
 export declare class InMemorySubscriptions {
     private cache;
     constructor(cache: Cache);
@@ -16,22 +19,27 @@ export declare class InMemorySubscriptions {
             [key: string]: GraphQLValue;
         };
     }): void;
-    addFieldSubscription({ id, key, field, spec, parentType, variables, }: {
+    addFieldSubscription({ id, key, selection, }: {
         id: string;
         key: string;
-        field: Required<SubscriptionSelection>['fields'][string];
-        spec: SubscriptionSpec;
+        selection: FieldSelection;
+    }): void;
+    registerList({ list, id, key, parentType, selection, filters, variables, }: {
+        list: Required<Required<SubscriptionSelection>['fields'][string]>['list'];
+        selection: SubscriptionSelection;
+        id: string;
         parentType: string;
-        variables: GraphQLObject;
+        key: string;
+        filters: Required<SubscriptionSelection>['fields'][string]['filters'];
+        variables: Record<string, any>;
     }): void;
-    addMany({ parent, selection, variables, subscribers, parentType, }: {
+    addMany({ parent, variables, subscribers, parentType, }: {
         parent: string;
-        selection: SubscriptionSelection;
         variables: {};
-        subscribers: SubscriptionSpec[];
+        subscribers: FieldSelection[];
         parentType: string;
     }): void;
-    get(id: string, field: string): SubscriptionSpec[];
+    get(id: string, field: string): FieldSelection[];
     remove(id: string, selection: SubscriptionSelection, targets: SubscriptionSpec[], variables: {}, visited?: string[]): void;
     private removeSubscribers;
     removeAllSubscribers(id: string, targets?: SubscriptionSpec[], visited?: string[]): void;

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

@@ -41,16 +41,29 @@ class InMemorySubscriptions {
     const __typename = this.cache._internal_unstable.storage.get(parent, "__typename").value;
     let targetSelection = (0, import_selection.getFieldsForType)(selection, __typename);
     for (const fieldSelection of Object.values(targetSelection || {})) {
-      const { keyRaw, selection: innerSelection, type } = fieldSelection;
+      const { keyRaw, selection: innerSelection, type, list, filters } = fieldSelection;
       const key = (0, import_stuff.evaluateKey)(keyRaw, variables);
+      let targetSelection2;
+      if (innerSelection) {
+        const __typename2 = this.cache._internal_unstable.storage.get(parent, "__typename").value;
+        targetSelection2 = (0, import_selection.getFieldsForType)(innerSelection, __typename2);
+      }
       this.addFieldSubscription({
         id: parent,
         key,
-        field: fieldSelection,
-        spec,
-        parentType: parentType || spec.rootType,
-        variables
+        selection: [spec, targetSelection2]
       });
+      if (list) {
+        this.registerList({
+          list,
+          filters,
+          id: parent,
+          key,
+          variables,
+          selection: innerSelection,
+          parentType: parentType || spec.rootType
+        });
+      }
       if (innerSelection) {
         const { value: linkedRecord } = this.cache._internal_unstable.storage.get(
           parent,
@@ -75,11 +88,9 @@ class InMemorySubscriptions {
   addFieldSubscription({
     id,
     key,
-    field,
-    spec,
-    parentType,
-    variables
+    selection
   }) {
+    const spec = selection[0];
     if (!this.subscribers[id]) {
       this.subscribers[id] = {};
     }
@@ -90,8 +101,8 @@ class InMemorySubscriptions {
       this.keyVersions[key] = /* @__PURE__ */ new Set();
     }
     this.keyVersions[key].add(key);
-    if (!this.subscribers[id][key].map(({ set }) => set).includes(spec.set)) {
-      this.subscribers[id][key].push(spec);
+    if (!this.subscribers[id][key].map(([{ set }]) => set).includes(spec.set)) {
+      this.subscribers[id][key].push([spec, selection[1]]);
     }
     if (!this.referenceCounts[id]) {
       this.referenceCounts[id] = {};
@@ -102,61 +113,87 @@ class InMemorySubscriptions {
     const counts = this.referenceCounts[id][key];
     counts.set(spec.set, (counts.get(spec.set) || 0) + 1);
     this.cache._internal_unstable.lifetimes.resetLifetime(id, key);
-    const { selection, list, filters } = field;
-    if (selection && list) {
-      this.cache._internal_unstable.lists.add({
-        name: list.name,
-        connection: list.connection,
-        recordID: id,
-        recordType: this.cache._internal_unstable.storage.get(id, "__typename")?.value || parentType,
-        listType: list.type,
-        key,
-        selection,
-        filters: Object.entries(filters || {}).reduce((acc, [key2, { kind, value }]) => {
-          return {
-            ...acc,
-            [key2]: kind !== "Variable" ? value : variables[value]
-          };
-        }, {})
-      });
-    }
+    const { selection: innerSelection } = selection[1]?.[key] ?? {};
+  }
+  registerList({
+    list,
+    id,
+    key,
+    parentType,
+    selection,
+    filters,
+    variables
+  }) {
+    this.cache._internal_unstable.lists.add({
+      name: list.name,
+      connection: list.connection,
+      recordID: id,
+      recordType: this.cache._internal_unstable.storage.get(id, "__typename")?.value || parentType,
+      listType: list.type,
+      key,
+      selection,
+      filters: Object.entries(filters || {}).reduce((acc, [key2, { kind, value }]) => {
+        return {
+          ...acc,
+          [key2]: kind !== "Variable" ? value : variables[value]
+        };
+      }, {})
+    });
   }
   addMany({
     parent,
-    selection,
     variables,
     subscribers,
     parentType
   }) {
-    let targetSelection = (0, import_selection.getFieldsForType)(selection, parentType);
-    for (const fieldSelection of Object.values(targetSelection)) {
-      const { type: linkedType, keyRaw, selection: innerSelection } = fieldSelection;
-      const key = (0, import_stuff.evaluateKey)(keyRaw, variables);
-      for (const spec of subscribers) {
+    for (const [spec, targetSelection] of subscribers) {
+      for (const selection of Object.values(targetSelection ?? {})) {
+        const {
+          type: linkedType,
+          keyRaw,
+          selection: innerSelection,
+          list,
+          filters
+        } = selection;
+        const key = (0, import_stuff.evaluateKey)(keyRaw, variables);
+        const fieldSelection = innerSelection ? (0, import_selection.getFieldsForType)(innerSelection, parentType) : void 0;
         this.addFieldSubscription({
           id: parent,
           key,
-          field: fieldSelection,
-          spec,
-          parentType,
-          variables
+          selection: [spec, fieldSelection]
         });
-      }
-      if (innerSelection) {
-        const { value: link } = this.cache._internal_unstable.storage.get(parent, key);
-        const children = !Array.isArray(link) ? [link] : (0, import_stuff.flattenList)(link);
-        for (const linkedRecord of children) {
-          if (!linkedRecord) {
-            continue;
-          }
-          this.addMany({
-            parent: linkedRecord,
-            selection: innerSelection,
+        if (list) {
+          this.registerList({
+            list,
+            filters,
+            id: parent,
+            key,
             variables,
-            subscribers,
-            parentType: linkedType
+            selection: innerSelection,
+            parentType: parentType || spec.rootType
           });
         }
+        const childSelection = selection.selection;
+        if (childSelection) {
+          const { value: link } = this.cache._internal_unstable.storage.get(parent, key);
+          const children = !Array.isArray(link) ? [link] : (0, import_stuff.flattenList)(link);
+          for (const linkedRecord of children) {
+            if (!linkedRecord) {
+              continue;
+            }
+            const __typename = this.cache._internal_unstable.storage.get(
+              linkedRecord,
+              "__typename"
+            ).value;
+            let targetSelection2 = (0, import_selection.getFieldsForType)(childSelection, __typename);
+            this.addMany({
+              parent: linkedRecord,
+              variables,
+              subscribers: subscribers.map(([sub]) => [sub, targetSelection2]),
+              parentType: linkedType
+            });
+          }
+        }
       }
     }
   }
@@ -166,10 +203,12 @@ class InMemorySubscriptions {
   remove(id, selection, targets, variables, visited = []) {
     visited.push(id);
     const linkedIDs = [];
-    for (const fieldSelection of Object.values(selection.fields || {})) {
+    const __typename = this.cache._internal_unstable.storage.get(id, "__typename").value;
+    let targetSelection = (0, import_selection.getFieldsForType)(selection, __typename);
+    for (const fieldSelection of Object.values(targetSelection || {})) {
       const key = (0, import_stuff.evaluateKey)(fieldSelection.keyRaw, variables);
       this.removeSubscribers(id, key, targets);
-      if (!fieldSelection.selection?.fields) {
+      if (!fieldSelection.selection) {
         continue;
       }
       const { value: previousValue } = this.cache._internal_unstable.storage.get(id, key);
@@ -200,14 +239,14 @@ class InMemorySubscriptions {
     }
     if (this.subscribers[id]) {
       this.subscribers[id][fieldName] = this.get(id, fieldName).filter(
-        ({ set }) => !targets.includes(set)
+        ([{ set }]) => !targets.includes(set)
       );
     }
   }
   removeAllSubscribers(id, targets, visited = []) {
     visited.push(id);
     for (const field of Object.keys(this.subscribers[id] || [])) {
-      const subscribers = targets || this.subscribers[id][field];
+      const subscribers = targets || this.subscribers[id][field].map(([spec]) => spec);
       this.removeSubscribers(id, field, subscribers);
       const { value, kind } = this.cache._internal_unstable.storage.get(id, field);
       if (kind === "scalar") {