houdini 1.0.0-next.2 → 1.0.0-next.3

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

@@ -31,10 +31,6 @@ export type ConfigFile = {
      * FYI: `schemaPath` or `schema` should be defined
      */
     schema?: string | GraphQLSchema;
-    /**
-     * A url to use to pull the schema. For more information: https://www.houdinigraphql.com/api/cli#generate
-     */
-    apiUrl?: string | ((env: Record<string, string | undefined>) => string);
     /**
      * An object describing custom scalars for your project. For more information: https://www.houdinigraphql.com/api/config#custom-scalars
      */
@@ -43,11 +39,6 @@ export type ConfigFile = {
      * A path that the generator will use to write schema.graphql and documents.gql files containing all of the internal fragment and directive definitions used in the project.
      */
     definitionsPath?: string;
-    /**
-     * One of "kit" or "svelte". Used to tell the preprocessor what kind of loading paradigm to generate for you. (default: `kit`)
-     * @deprecated please follow the steps here: http://www.houdinigraphql.com/guides/release-notes#0170
-     */
-    framework?: 'kit' | 'svelte';
     /**
      * One of "esm" or "commonjs". Tells the artifact generator what kind of modules to create. (default: `esm`)
      */
@@ -90,20 +81,9 @@ export type ConfigFile = {
      */
     defaultFragmentMasking?: 'enable' | 'disable';
     /**
-     * Configures the houdini plugin's schema polling behavior. By default, houdini will poll your APIs
-     * during development in order to keep it's definition of your schema up to date. The schemaPollingInterval
-     * config value sets the amount of time between each request in milliseconds (default 2 seconds).
-     * To limit the schema introspection to just on the start of the server, set schemaPollingInterval to 0.
-     * To disable the schema introspection, set schemaPollingInterval to null.
-     */
-    schemaPollInterval?: number | null;
-    /**
-     * An object containing the environment variables you want passed onto the api when polling for a new schema.
-     * The keys dictate the header names. If the value is a string, the corresponding environment variable will be used
-     * directly. If the value is a function, the current environment will be passed to your function so you can perform any
-     * logic you need
+     * Configure the dev environment to watch a remote schema for changes
      */
-    schemaPollHeaders?: Record<string, string | ((env: Record<string, string | undefined>) => string)> | ((env: Record<string, string | undefined>) => Record<string, string>);
+    watchSchema?: WatchSchemaConfig;
     /**
      * An object describing the plugins enabled for the project
      */
@@ -133,6 +113,25 @@ export type TypeConfig = {
         };
     };
 };
+export type WatchSchemaConfig = {
+    /**
+     * A url to use to pull the schema. For more information: https://www.houdinigraphql.com/api/cli#generate
+     */
+    url: string | ((env: Record<string, string | undefined>) => string);
+    /**
+     * sets the amount of time between each request in milliseconds (default 2 seconds).
+     * To limit the schema introspection to just on the start of the server, set interval to 0.
+     * To disable the schema introspection, set interval to null.
+     */
+    interval?: number | null;
+    /**
+     * An object containing the environment variables you want passed onto the api when polling for a new schema.
+     * The keys dictate the header names. If the value is a string, the corresponding environment variable will be used
+     * directly. If the value is a function, the current environment will be passed to your function so you can perform any
+     * logic you need
+     */
+    headers?: Record<string, string | ((env: Record<string, string | undefined>) => string)> | ((env: Record<string, string | undefined>) => Record<string, string>);
+};
 export type ScalarSpec = {
     type: string;
     marshal?: (val: any) => any;

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

@@ -1,11 +1,11 @@
 import type { ConfigFile } from './config';
-import type { MutationArtifact, QueryArtifact, SubscriptionArtifact, SubscriptionSelection } from './types';
+import type { FragmentArtifact, MutationArtifact, QueryArtifact, SubscriptionArtifact, SubscriptionSelection } from './types';
 export declare function marshalSelection({ selection, data, }: {
     selection: SubscriptionSelection;
     data: any;
 }): Promise<{} | null | undefined>;
 export declare function marshalInputs<T>({ artifact, input, config, rootType, }: {
-    artifact: QueryArtifact | MutationArtifact | SubscriptionArtifact;
+    artifact: QueryArtifact | MutationArtifact | SubscriptionArtifact | FragmentArtifact;
     input: unknown;
     rootType?: string;
     config: ConfigFile;

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

@@ -1,19 +1,32 @@
 import type { Cache as _Cache } from '../cache/cache';
-import type { SchemaManager, TypeInfo } from '../cache/schema';
+import { type QueryArtifact } from '../lib';
 import { ListCollection } from './list';
 import { Record } from './record';
-import type { CacheTypeDef, IDFields, TypeNames, ValidLists } from './types';
+import type { CacheTypeDef, IDFields, QueryInput, QueryList, QueryValue, TypeNames, ValidLists } from './types';
 export declare class Cache<Def extends CacheTypeDef> {
     _internal_unstable: _Cache;
     constructor(cache: _Cache);
     validateInstabilityWarning(): void;
-    setFieldType(...args: Parameters<SchemaManager['setFieldType']>): void;
-    get root(): Record<Def, '__ROOT__'>;
     get<T extends TypeNames<Def>>(type: T, data: IDFields<Def, T>): Record<Def, T>;
-    get config(): import("..").ConfigFile;
+    get config(): import("../lib").ConfigFile;
     list<Name extends ValidLists<Def>>(name: Name, { parentID, allLists }?: {
         parentID?: string;
         allLists?: boolean;
     }): ListCollection<Def, Name>;
+    read<_Query extends {
+        artifact: QueryArtifact;
+    }>({ query, variables, }: {
+        query: _Query;
+        variables?: QueryInput<QueryList<Def>, _Query>;
+    }): {
+        data: QueryValue<QueryList<Def>, _Query> | null;
+        partial: boolean;
+    };
+    write<_Query extends {
+        artifact: QueryArtifact;
+    }>({ query, variables, data, }: {
+        query: _Query;
+        data: QueryValue<QueryList<Def>, _Query>;
+        variables?: QueryInput<QueryList<Def>, _Query>;
+    }): void;
 }
-export declare function _typeInfo<Def extends CacheTypeDef>(cache: Cache<Def>, type: string, field: string): TypeInfo;

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

@@ -1,4 +1,4 @@
-import { rootID } from "../cache/cache";
+import { marshalInputs } from "../lib";
 import { ListCollection } from "./list";
 import { Record } from "./record";
 class Cache {
@@ -12,19 +12,6 @@ class Cache {
 Please acknowledge this by setting acceptImperativeInstability to true in your config file.`);
     }
   }
-  setFieldType(...args) {
-    this.validateInstabilityWarning();
-    this._internal_unstable._internal_unstable.schema.setFieldType(...args);
-  }
-  get root() {
-    this.validateInstabilityWarning();
-    return new Record({
-      cache: this,
-      type: "Query",
-      id: rootID,
-      idFields: {}
-    });
-  }
   get(type, data) {
     this.validateInstabilityWarning();
     let recordID = this._internal_unstable._internal_unstable.id(type, data);
@@ -42,6 +29,7 @@ Please acknowledge this by setting acceptImperativeInstability to true in your c
     return this._internal_unstable._internal_unstable.config;
   }
   list(name, { parentID, allLists } = {}) {
+    this.validateInstabilityWarning();
     return new ListCollection({
       cache: this,
       name,
@@ -49,24 +37,34 @@ Please acknowledge this by setting acceptImperativeInstability to true in your c
       allLists
     });
   }
-}
-function _typeInfo(cache, type, field) {
-  if (field === "__typename") {
-    return {
-      type: "String",
-      nullable: false,
-      link: false
-    };
+  read({
+    query,
+    variables
+  }) {
+    this.validateInstabilityWarning();
+    return this._internal_unstable.read({
+      selection: query.artifact.selection,
+      variables
+    });
   }
-  const info = cache._internal_unstable._internal_unstable.schema.fieldType(type, field);
-  if (!info) {
-    throw new Error(
-      `Unknown field: ${field} for type ${type}. Please provide type information using setFieldType().`
-    );
+  write({
+    query,
+    variables,
+    data
+  }) {
+    this.validateInstabilityWarning();
+    this._internal_unstable.write({
+      selection: query.artifact.selection,
+      data,
+      variables: marshalInputs({
+        config: this.config,
+        artifact: query.artifact,
+        input: variables
+      }) ?? {}
+    });
+    return;
   }
-  return info;
 }
 export {
-  Cache,
-  _typeInfo
+  Cache
 };

package/build/runtime-esm/public/list.js

@@ -1,5 +1,3 @@
-import { keyFieldsForType } from "../lib/config";
-import { _typeInfo } from "./cache";
 import { Record } from "./record";
 class ListCollection {
   #parentID;
@@ -60,7 +58,7 @@ class ListCollection {
     return new ListCollection({
       parentID: this.#parentID,
       allLists: this.#allLists,
-      when: this.#when,
+      when: filter,
       cache: this.#cache,
       name: this.#name
     });
@@ -96,36 +94,16 @@ class ListCollection {
     }
   }
   #listOperationPayload(records) {
-    const selection = {
-      abstractFields: {
-        fields: {},
-        typeMap: {}
-      }
-    };
+    let selection = this.#collection.selection;
+    const connectionSelection = selection.fields?.["edges"]?.selection?.fields?.node.selection;
+    if (connectionSelection) {
+      selection = connectionSelection;
+    }
     const data = [];
     for (const record of records) {
       if (!(record instanceof Record)) {
         throw new Error("You must provide a Record to a list operation");
       }
-      const keys = keyFieldsForType(this.#cache.config, record.type);
-      selection.abstractFields.fields[record.type] = keys.reduce(
-        (acc, key) => {
-          const keyInfo = _typeInfo(this.#cache, record.type, key);
-          return {
-            ...acc,
-            [key]: {
-              type: keyInfo.type,
-              keyRaw: key
-            }
-          };
-        },
-        {
-          __typename: {
-            type: "String",
-            keyRaw: "__typename"
-          }
-        }
-      );
       data.push({ __typename: record.type, ...record.idFields });
     }
     return {

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

@@ -1,5 +1,6 @@
+import type { FragmentArtifact } from '../lib/types';
 import type { Cache } from './cache';
-import type { ArgType, CacheTypeDef, FieldType, TypeFieldNames, ValidTypes } from './types';
+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-esm/public/record.js

@@ -1,6 +1,6 @@
 import { rootID } from "../cache/cache";
+import { marshalInputs } from "../lib";
 import { keyFieldsForType } from "../lib/config";
-import { _typeInfo } from "./cache";
 class Record {
   #id;
   #cache;
@@ -24,199 +24,36 @@ class Record {
       }
     }
   }
-  set({
-    field,
-    args,
-    value
+  read({
+    fragment,
+    variables
   }) {
-    this.#cache.validateInstabilityWarning();
-    const key = computeKey({ field, args });
-    const typeInfo = _typeInfo(this.#cache, this.type, field);
-    let newValue;
-    if (typeInfo.link) {
-      const keys = keyFieldsForType(this.#cache.config, typeInfo.type);
-      typeInfo.selection = {
-        fields: keys.reduce(
-          (acc, key2) => {
-            const keyInfo = _typeInfo(this.#cache, typeInfo.type, key2);
-            return {
-              ...acc,
-              [key2]: {
-                type: keyInfo.type,
-                keyRaw: key2
-              }
-            };
-          },
-          {
-            __typename: {
-              type: "String",
-              keyRaw: "__typename"
-            }
-          }
-        )
-      };
-    }
-    if (!typeInfo.link) {
-      const fnMarshal = this.#cache.config.scalars?.[typeInfo.type]?.marshal;
-      if (fnMarshal) {
-        newValue = fnMarshal(value);
-      } else {
-        newValue = value;
-      }
-    } else if (value instanceof Record) {
-      newValue = {
-        ...value.idFields,
-        __typename: value.type
-      };
-    } else if (Array.isArray(value)) {
-      newValue = marshalNestedList(value);
-    } else if (value !== null) {
-      throw new Error("Value must be a RecordProxy if the field is a link to another record");
-    }
-    this.#cache._internal_unstable._internal_unstable.lifetimes.resetLifetime(this.#id, key);
-    this.#cache._internal_unstable.write({
+    return this.#cache._internal_unstable.read({
+      selection: fragment.artifact.selection,
       parent: this.#id,
-      selection: {
-        fields: {
-          [field]: {
-            keyRaw: key,
-            ...typeInfo
-          }
-        }
-      },
-      data: {
-        [field]: newValue
-      }
+      variables: marshalInputs({
+        config: this.#cache.config,
+        artifact: fragment.artifact,
+        input: variables
+      }) ?? void 0
     });
   }
-  get({
-    field,
-    args
-  }) {
-    this.#cache.validateInstabilityWarning();
-    const key = computeKey({ field, args });
-    const typeInfo = _typeInfo(this.#cache, this.type, field);
-    if (typeInfo.link) {
-      const keys = keyFieldsForType(this.#cache.config, typeInfo.type);
-      typeInfo.selection = {
-        fields: keys.reduce(
-          (acc, key2) => {
-            const keyInfo = _typeInfo(this.#cache, typeInfo.type, key2);
-            return {
-              ...acc,
-              [key2]: {
-                type: keyInfo.type,
-                keyRaw: key2
-              }
-            };
-          },
-          {
-            __typename: {
-              type: "String",
-              keyRaw: "__typename"
-            }
-          }
-        )
-      };
-    }
-    const result = this.#cache._internal_unstable.read({
+  write(args) {
+    this.#cache._internal_unstable.write({
+      data: args.data,
+      selection: args.fragment.artifact.selection,
       parent: this.#id,
-      selection: {
-        fields: {
-          [field]: {
-            keyRaw: key,
-            ...typeInfo
-          }
-        }
-      }
+      variables: marshalInputs({
+        config: this.#cache.config,
+        artifact: args.fragment.artifact,
+        input: args.variables
+      }) ?? void 0
     });
-    if (!typeInfo.link) {
-      return result.data?.[field] ?? (typeInfo.nullable ? null : void 0);
-    }
-    const data = result.data?.[field] || {};
-    let finalResult = unmarshalNestedList(
-      this.#cache,
-      !Array.isArray(data) ? [data] : data
-    ).map((val) => {
-      if (typeInfo.nullable && (val === null || Object.keys(val).length === 0)) {
-        return null;
-      }
-      return val;
-    });
-    return Array.isArray(data) ? finalResult : finalResult[0];
   }
   delete() {
     this.#cache._internal_unstable.delete(this.#id);
   }
 }
-function 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(", ")}}`;
-};
-function marshalNestedList(list) {
-  const newValue = [];
-  for (const inner of list) {
-    if (Array.isArray(inner)) {
-      newValue.push(marshalNestedList(inner));
-    } else if (inner instanceof Record) {
-      newValue.push({ ...inner.idFields, __typename: inner.type });
-    } else {
-      newValue.push(inner);
-    }
-  }
-  return newValue;
-}
-function unmarshalNestedList(cache, list) {
-  const newValue = [];
-  for (const inner of list) {
-    if (Array.isArray(inner)) {
-      newValue.push(unmarshalNestedList(cache, inner));
-    } else if (inner === null) {
-      newValue.push(null);
-    } else if (inner.__typename) {
-      const type = inner.__typename;
-      let recordID = cache._internal_unstable._internal_unstable.id(type, inner);
-      if (!recordID) {
-        throw new Error("todo");
-      }
-      const typename = cache._internal_unstable.read({
-        selection: {
-          fields: {
-            __typename: {
-              keyRaw: "__typename",
-              type: "String"
-            }
-          }
-        },
-        parent: recordID
-      }).data?.__typename;
-      newValue.push(
-        new Record({
-          cache,
-          type: type || typename,
-          idFields: inner,
-          id: recordID
-        })
-      );
-    } else {
-      newValue.push(inner);
-    }
-  }
-  return newValue;
-}
 export {
-  Record,
-  computeKey,
-  marshalNestedList,
-  stringifyObjectWithNoQuotesOnKeys
+  Record
 };

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

@@ -1,9 +1,11 @@
+import { type SubscriptionSelection, type FragmentArtifact, type QueryArtifact } from '../../lib';
 import { Cache } from '../cache';
 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-esm/public/tests/test.js

@@ -1,7 +1,32 @@
 import { testConfigFile } from "../../../test";
 import { Cache as _Cache } from "../../cache/cache";
+import {
+  ArtifactKind
+} from "../../lib";
 import { Cache } from "../cache";
 const testCache = () => new Cache(new _Cache(testConfigFile()));
+const testFragment = (selection) => ({
+  artifact: {
+    kind: ArtifactKind.Fragment,
+    hash: "",
+    raw: "",
+    name: "",
+    rootType: "User",
+    selection
+  }
+});
+const testQuery = (selection) => ({
+  artifact: {
+    kind: ArtifactKind.Query,
+    hash: "",
+    raw: "",
+    name: "",
+    rootType: "Query",
+    selection
+  }
+});
 export {
-  testCache
+  testCache,
+  testFragment,
+  testQuery
 };