houdini 1.1.7 → 1.2.0-next.1

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

@@ -0,0 +1,219 @@
+"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 pagination_exports = {};
+__export(pagination_exports, {
+  cursorHandlers: () => cursorHandlers,
+  offsetHandlers: () => offsetHandlers
+});
+module.exports = __toCommonJS(pagination_exports);
+var import_config = require("./config");
+var import_deepEquals = require("./deepEquals");
+var import_pageInfo = require("./pageInfo");
+var import_types = require("./types");
+function cursorHandlers({
+  artifact,
+  fetchUpdate: parentFetchUpdate,
+  fetch: parentFetch,
+  getState,
+  getVariables,
+  getSession
+}) {
+  const loadPage = async ({
+    pageSizeVar,
+    input,
+    functionName,
+    metadata = {},
+    fetch,
+    where
+  }) => {
+    const config = (0, import_config.getCurrentConfig)();
+    const loadVariables = {
+      ...getVariables(),
+      ...input
+    };
+    if (!loadVariables[pageSizeVar] && !artifact.refetch.pageSize) {
+      throw (0, import_pageInfo.missingPageSizeError)(functionName);
+    }
+    let isSinglePage = artifact.refetch?.mode === "SinglePage";
+    await (isSinglePage ? parentFetch : parentFetchUpdate)(
+      {
+        variables: loadVariables,
+        fetch,
+        metadata,
+        policy: isSinglePage ? artifact.policy : import_types.CachePolicy.NetworkOnly,
+        session: await getSession()
+      },
+      isSinglePage ? [] : [where === "start" ? "prepend" : "append"]
+    );
+  };
+  const getPageInfo = () => {
+    return (0, import_pageInfo.extractPageInfo)(getState(), artifact.refetch?.path ?? []);
+  };
+  return {
+    loadNextPage: async ({
+      first,
+      after,
+      fetch,
+      metadata
+    } = {}) => {
+      const currentPageInfo = getPageInfo();
+      if (!currentPageInfo.hasNextPage) {
+        return;
+      }
+      const input = {
+        first: first ?? artifact.refetch.pageSize,
+        after: after ?? currentPageInfo.endCursor,
+        before: null,
+        last: null
+      };
+      return await loadPage({
+        pageSizeVar: "first",
+        functionName: "loadNextPage",
+        input,
+        fetch,
+        metadata,
+        where: "end"
+      });
+    },
+    loadPreviousPage: async ({
+      last,
+      before,
+      fetch,
+      metadata
+    } = {}) => {
+      const currentPageInfo = getPageInfo();
+      if (!currentPageInfo.hasPreviousPage) {
+        return;
+      }
+      const input = {
+        before: before ?? currentPageInfo.startCursor,
+        last: last ?? artifact.refetch.pageSize,
+        first: null,
+        after: null
+      };
+      return await loadPage({
+        pageSizeVar: "last",
+        functionName: "loadPreviousPage",
+        input,
+        fetch,
+        metadata,
+        where: "start"
+      });
+    },
+    async fetch(args) {
+      const { variables } = args ?? {};
+      if (variables && !(0, import_deepEquals.deepEquals)(getVariables(), variables)) {
+        return await parentFetch(args);
+      }
+      try {
+        var currentPageInfo = (0, import_pageInfo.extractPageInfo)(getState(), artifact.refetch.path);
+      } catch {
+        return await parentFetch(args);
+      }
+      const queryVariables = {};
+      const count = (0, import_pageInfo.countPage)(artifact.refetch.path.concat("edges"), getState()) || artifact.refetch.pageSize;
+      if (count && count > artifact.refetch.pageSize) {
+        if (currentPageInfo.hasPreviousPage && currentPageInfo.hasNextPage && !(variables?.["first"] && variables?.["after"] || variables?.["last"] && variables?.["before"])) {
+          console.warn(`\u26A0\uFE0F Encountered a fetch() in the middle of the connection.
+Make sure to pass a cursor value by hand that includes the current set (ie the entry before startCursor)
+`);
+        }
+        if (!currentPageInfo.hasPreviousPage) {
+          queryVariables["first"] = count;
+          queryVariables["after"] = null;
+          queryVariables["last"] = null;
+          queryVariables["before"] = null;
+        } else if (!currentPageInfo.hasNextPage) {
+          queryVariables["last"] = count;
+          queryVariables["first"] = null;
+          queryVariables["after"] = null;
+          queryVariables["before"] = null;
+        }
+      }
+      Object.assign(queryVariables, variables ?? {});
+      const result = await parentFetch({
+        ...args,
+        variables: queryVariables
+      });
+      return result;
+    }
+  };
+}
+function offsetHandlers({
+  artifact,
+  storeName,
+  getState,
+  getVariables,
+  fetch: parentFetch,
+  fetchUpdate: parentFetchUpdate,
+  getSession
+}) {
+  let getOffset = () => artifact.refetch?.start || (0, import_pageInfo.countPage)(artifact.refetch.path, getState()) || artifact.refetch.pageSize;
+  let currentOffset = getOffset() ?? 0;
+  return {
+    loadNextPage: async ({
+      limit,
+      offset,
+      fetch,
+      metadata
+    } = {}) => {
+      const queryVariables = {
+        ...getVariables(),
+        offset: offset ?? getOffset()
+      };
+      if (limit || limit === 0) {
+        queryVariables.limit = limit;
+      }
+      if (!queryVariables.limit && !artifact.refetch.pageSize) {
+        throw (0, import_pageInfo.missingPageSizeError)("loadNextPage");
+      }
+      let isSinglePage = artifact.refetch?.mode === "SinglePage";
+      const targetFetch = isSinglePage ? parentFetch : parentFetchUpdate;
+      await targetFetch({
+        variables: queryVariables,
+        fetch,
+        metadata,
+        policy: isSinglePage ? artifact.policy : import_types.CachePolicy.NetworkOnly,
+        session: await getSession()
+      });
+      const pageSize = queryVariables.limit || artifact.refetch.pageSize;
+      currentOffset = offset + pageSize;
+    },
+    async fetch(params = {}) {
+      const { variables } = params;
+      if (variables && !(0, import_deepEquals.deepEquals)(getVariables(), variables)) {
+        return parentFetch.call(this, params);
+      }
+      const count = currentOffset || getOffset();
+      const queryVariables = {};
+      if (!artifact.refetch.pageSize || count > artifact.refetch.pageSize) {
+        queryVariables.limit = count;
+      }
+      return await parentFetch.call(this, {
+        ...params,
+        variables: queryVariables
+      });
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  cursorHandlers,
+  offsetHandlers
+});

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

@@ -37,7 +37,7 @@ async function marshalSelection({
   if (Array.isArray(data)) {
     return await Promise.all(data.map((val) => marshalSelection({ selection, data: val })));
   }
-  const targetSelection = (0, import_selection.getFieldsForType)(selection, data["__typename"]);
+  const targetSelection = (0, import_selection.getFieldsForType)(selection, data["__typename"], false);
   return Object.fromEntries(
     await Promise.all(
       Object.entries(data).map(async ([fieldName, value]) => {

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

@@ -1,2 +1,2 @@
 import type { SubscriptionSelection } from './types';
-export declare function getFieldsForType(selection: SubscriptionSelection, __typename: string | undefined | null): Required<SubscriptionSelection>['fields'];
+export declare function getFieldsForType(selection: SubscriptionSelection, __typename: string | undefined | null, loading: boolean): Required<SubscriptionSelection>['fields'];

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

@@ -21,7 +21,15 @@ __export(selection_exports, {
   getFieldsForType: () => getFieldsForType
 });
 module.exports = __toCommonJS(selection_exports);
-function getFieldsForType(selection, __typename) {
+function getFieldsForType(selection, __typename, loading) {
+  if (loading) {
+    if (selection.loadingTypes && selection.loadingTypes.length > 0) {
+      return deepMerge(
+        ...selection.loadingTypes.map((type) => selection.abstractFields?.fields[type])
+      );
+    }
+    return selection.fields ?? {};
+  }
   let targetSelection = selection.fields || {};
   if (selection.abstractFields && __typename) {
     const mappedType = selection.abstractFields.typeMap[__typename];
@@ -33,6 +41,25 @@ function getFieldsForType(selection, __typename) {
   }
   return targetSelection;
 }
+function deepMerge(...objects) {
+  const mergedObj = {};
+  for (let obj of objects) {
+    if (!obj) {
+      continue;
+    }
+    for (let prop in obj) {
+      if (prop in obj) {
+        const val = obj[prop];
+        if (typeof val === "object" && val !== null && !Array.isArray(val)) {
+          mergedObj[prop] = deepMerge(mergedObj[prop] || {}, val);
+        } else {
+          mergedObj[prop] = val;
+        }
+      }
+    }
+  }
+  return mergedObj;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   getFieldsForType

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

@@ -25,6 +25,7 @@ declare global {
             };
             optimisticResponse?: GraphQLObject;
             parentID?: string;
+            silenceLoading?: boolean;
         }
     }
 }
@@ -52,9 +53,12 @@ export type CompiledDocumentKind = ArtifactKinds;
 export type QueryArtifact = BaseCompiledDocument<'HoudiniQuery'> & {
     policy?: CachePolicies;
     partial?: boolean;
+    enableLoadingState?: 'global' | 'local';
 };
 export type MutationArtifact = BaseCompiledDocument<'HoudiniMutation'>;
-export type FragmentArtifact = BaseCompiledDocument<'HoudiniFragment'>;
+export type FragmentArtifact = BaseCompiledDocument<'HoudiniFragment'> & {
+    enableLoadingState?: 'global' | 'local';
+};
 export type SubscriptionArtifact = BaseCompiledDocument<'HoudiniSubscription'>;
 export declare const RefetchUpdateMode: {
     readonly append: "append";
@@ -128,12 +132,34 @@ export type GraphQLObject = {
     [key: string]: GraphQLValue;
 };
 export type GraphQLValue = number | string | boolean | null | GraphQLObject | GraphQLValue[] | undefined;
+export type GraphQLVariables = {
+    [key: string]: any;
+} | null;
+export type LoadingSpec = {
+    kind: 'continue';
+    list?: {
+        depth: number;
+        count: number;
+    };
+} | {
+    kind: 'value';
+    value?: any;
+    list?: {
+        depth: number;
+        count: number;
+    };
+};
 export type SubscriptionSelection = {
-    fragments?: Record<string, ValueMap>;
+    loadingTypes?: string[];
+    fragments?: Record<string, {
+        arguments: ValueMap;
+        loading?: boolean;
+    }>;
     fields?: {
         [fieldName: string]: {
             type: string;
             nullable?: boolean;
+            required?: boolean;
             keyRaw: string;
             operations?: MutationOperation[];
             list?: {
@@ -141,6 +167,7 @@ export type SubscriptionSelection = {
                 connection: boolean;
                 type: string;
             };
+            loading?: LoadingSpec;
             directives?: {
                 name: string;
                 arguments: ValueMap;
@@ -153,6 +180,7 @@ export type SubscriptionSelection = {
             }>;
             selection?: SubscriptionSelection;
             abstract?: boolean;
+            abstractHasRequired?: boolean;
         };
     };
     abstractFields?: {
@@ -175,7 +203,7 @@ export type FetchQueryResult<_Data> = {
     result: RequestPayload<_Data | null>;
     source: DataSources | null;
 };
-export type QueryResult<_Data = GraphQLObject, _Input = Record<string, any>> = {
+export type QueryResult<_Data = GraphQLObject, _Input = GraphQLVariables> = {
     data: _Data | null;
     errors: {
         message: string;
@@ -194,9 +222,54 @@ export type RequestPayload<GraphQLObject = any> = {
 };
 export type NestedList<_Result = string> = (_Result | null | NestedList<_Result>)[];
 export type ValueOf<Parent> = Parent[keyof Parent];
-export declare const fragmentKey = " $fragments";
+export declare const fragmentKey: " $fragments";
 export type ValueNode = VariableNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | NullValueNode | EnumValueNode | ListValueNode | ObjectValueNode;
 export type ValueMap = Record<string, ValueNode>;
+export type FetchParams<_Input> = {
+    variables?: _Input;
+    /**
+     * The policy to use when performing the fetch. If set to CachePolicy.NetworkOnly,
+     * a request will always be sent, even if the variables are the same as the last call
+     * to fetch.
+     */
+    policy?: CachePolicies;
+    /**
+     * An object that will be passed to the fetch function.
+     * You can do what you want with it!
+     */
+    metadata?: App.Metadata;
+};
+export type FetchFn<_Data extends GraphQLObject, _Input = any> = (params?: FetchParams<_Input>) => Promise<QueryResult<_Data, _Input>>;
+export type CursorHandlers<_Data extends GraphQLObject, _Input> = {
+    loadNextPage: (args?: {
+        first?: number;
+        after?: string;
+        fetch?: typeof globalThis.fetch;
+        metadata?: {};
+    }) => Promise<void>;
+    loadPreviousPage: (args?: {
+        last?: number;
+        before?: string;
+        fetch?: typeof globalThis.fetch;
+        metadata?: {};
+    }) => Promise<void>;
+    fetch(args?: FetchParams<_Input> | undefined): Promise<QueryResult<_Data, _Input>>;
+};
+export type OffsetHandlers<_Data extends GraphQLObject, _Input> = {
+    loadNextPage: (args?: {
+        limit?: number;
+        offset?: number;
+        metadata?: {};
+        fetch?: typeof globalThis.fetch;
+    }) => Promise<void>;
+    fetch(args?: FetchParams<_Input> | undefined): Promise<QueryResult<_Data, _Input>>;
+};
+export type PageInfo = {
+    startCursor: string | null;
+    endCursor: string | null;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+};
 interface IntValueNode {
     readonly kind: 'IntValue';
     readonly value: string;
@@ -241,4 +314,6 @@ interface VariableNode {
     readonly kind: 'Variable';
     readonly name: NameNode;
 }
+export declare const PendingValue: unique symbol;
+export type LoadingType = typeof PendingValue;
 export {};

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

@@ -26,6 +26,7 @@ __export(types_exports, {
   CompiledSubscriptionKind: () => CompiledSubscriptionKind,
   DataSource: () => DataSource,
   PaginateMode: () => PaginateMode,
+  PendingValue: () => PendingValue,
   RefetchUpdateMode: () => RefetchUpdateMode,
   fragmentKey: () => fragmentKey
 });
@@ -61,6 +62,7 @@ const DataSource = {
   Ssr: "ssr"
 };
 const fragmentKey = " $fragments";
+const PendingValue = Symbol("houdini_loading");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ArtifactKind,
@@ -71,6 +73,7 @@ const fragmentKey = " $fragments";
   CompiledSubscriptionKind,
   DataSource,
   PaginateMode,
+  PendingValue,
   RefetchUpdateMode,
   fragmentKey
 });

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

@@ -3,7 +3,6 @@ import type { GraphQLObject, GraphQLValue, NestedList, SubscriptionSelection, Su
 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';
@@ -57,15 +56,13 @@ declare class CacheInternal {
     cache: Cache;
     lifetimes: GarbageCollector;
     staleManager: StaleManager;
-    schema: SchemaManager;
-    constructor({ storage, subscriptions, lists, cache, lifetimes, staleManager, schema, disabled, config, }: {
+    constructor({ storage, subscriptions, lists, cache, lifetimes, staleManager, disabled, config, }: {
         storage: InMemoryStorage;
         subscriptions: InMemorySubscriptions;
         lists: ListManager;
         cache: Cache;
         lifetimes: GarbageCollector;
         staleManager: StaleManager;
-        schema: SchemaManager;
         disabled: boolean;
         config?: ConfigFile;
     });
@@ -87,12 +84,13 @@ declare class CacheInternal {
         forceNotify?: boolean;
         forceStale?: boolean;
     }): FieldSelection[];
-    getSelection({ selection, parent, variables, stepsFromConnection, ignoreMasking, fullCheck, }: {
+    getSelection({ selection, parent, variables, stepsFromConnection, ignoreMasking, fullCheck, loading: generateLoading, }: {
         selection: SubscriptionSelection;
         parent?: string;
-        variables?: {};
+        variables?: {} | null;
         stepsFromConnection?: number | null;
         ignoreMasking?: boolean;
+        loading?: boolean;
         fullCheck?: boolean;
     }): {
         data: GraphQLObject | null;
@@ -104,13 +102,14 @@ declare class CacheInternal {
     id(type: string, id: string): string | null;
     idFields(type: string): string[];
     computeID(type: string, data: any): string;
-    hydrateNestedList({ fields, variables, linkedList, stepsFromConnection, ignoreMasking, fullCheck, }: {
+    hydrateNestedList({ fields, variables, linkedList, stepsFromConnection, ignoreMasking, fullCheck, loading, }: {
         fields: SubscriptionSelection;
-        variables?: {};
+        variables?: {} | null;
         linkedList: NestedList;
         stepsFromConnection: number | null;
         ignoreMasking: boolean;
         fullCheck?: boolean;
+        loading?: boolean;
     }): {
         data: NestedList<GraphQLValue>;
         partial: boolean;