houdini 1.1.7 → 1.2.0-next.1

package/build/runtime-esm/lib/pageInfo.js

@@ -0,0 +1,52 @@
+import { siteURL } from "./constants";
+function nullPageInfo() {
+  return { startCursor: null, endCursor: null, hasNextPage: false, hasPreviousPage: false };
+}
+function missingPageSizeError(fnName) {
+  return {
+    message: `${fnName} is missing the required page arguments. For more information, please visit this link: ${siteURL}/guides/pagination`
+  };
+}
+function extractPageInfo(data, path) {
+  if (!data) {
+    return {
+      startCursor: null,
+      endCursor: null,
+      hasNextPage: false,
+      hasPreviousPage: false
+    };
+  }
+  let localPath = [...path];
+  let current = data;
+  while (localPath.length > 0) {
+    if (!current) {
+      break;
+    }
+    current = current[localPath.shift()];
+  }
+  return current?.pageInfo ?? nullPageInfo();
+}
+function countPage(source, value) {
+  let data = value;
+  if (value === null || data === null || data === void 0) {
+    return 0;
+  }
+  for (const field of source) {
+    const obj = data[field];
+    if (obj && !Array.isArray(obj)) {
+      data = obj;
+    } else if (!data) {
+      throw new Error("Could not count page size");
+    }
+    if (Array.isArray(obj)) {
+      return obj.length;
+    }
+  }
+  return 0;
+}
+export {
+  countPage,
+  extractPageInfo,
+  missingPageSizeError,
+  nullPageInfo
+};

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

@@ -0,0 +1,27 @@
+import type { SendParams } from '../client/documentStore';
+import type { CursorHandlers, FetchFn, GraphQLObject, GraphQLVariables, QueryArtifact, QueryResult, FetchParams } from './types';
+export declare function cursorHandlers<_Data extends GraphQLObject, _Input extends GraphQLVariables>({ artifact, fetchUpdate: parentFetchUpdate, fetch: parentFetch, getState, getVariables, getSession, }: {
+    artifact: QueryArtifact;
+    getState: () => _Data | null;
+    getVariables: () => NonNullable<_Input>;
+    getSession: () => Promise<App.Session>;
+    fetch: FetchFn<_Data, _Input>;
+    fetchUpdate: (arg: SendParams, updates: string[]) => ReturnType<FetchFn<_Data, _Input>>;
+}): CursorHandlers<_Data, _Input>;
+export declare function offsetHandlers<_Data extends GraphQLObject, _Input extends GraphQLVariables>({ artifact, storeName, getState, getVariables, fetch: parentFetch, fetchUpdate: parentFetchUpdate, getSession, }: {
+    artifact: QueryArtifact;
+    fetch: FetchFn<_Data, _Input>;
+    fetchUpdate: (arg: SendParams) => ReturnType<FetchFn<_Data, _Input>>;
+    storeName: string;
+    getState: () => _Data | null;
+    getVariables: () => _Input;
+    getSession: () => Promise<App.Session>;
+}): {
+    loadNextPage: ({ limit, offset, fetch, metadata, }?: {
+        limit?: number | undefined;
+        offset?: number | undefined;
+        fetch?: typeof fetch | undefined;
+        metadata?: {} | undefined;
+    }) => Promise<void>;
+    fetch(params?: FetchParams<_Input>): Promise<QueryResult<_Data, _Input>>;
+};

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

@@ -0,0 +1,194 @@
+import { getCurrentConfig } from "./config";
+import { deepEquals } from "./deepEquals";
+import { countPage, extractPageInfo, missingPageSizeError } from "./pageInfo";
+import { CachePolicy } from "./types";
+function cursorHandlers({
+  artifact,
+  fetchUpdate: parentFetchUpdate,
+  fetch: parentFetch,
+  getState,
+  getVariables,
+  getSession
+}) {
+  const loadPage = async ({
+    pageSizeVar,
+    input,
+    functionName,
+    metadata = {},
+    fetch,
+    where
+  }) => {
+    const config = getCurrentConfig();
+    const loadVariables = {
+      ...getVariables(),
+      ...input
+    };
+    if (!loadVariables[pageSizeVar] && !artifact.refetch.pageSize) {
+      throw missingPageSizeError(functionName);
+    }
+    let isSinglePage = artifact.refetch?.mode === "SinglePage";
+    await (isSinglePage ? parentFetch : parentFetchUpdate)(
+      {
+        variables: loadVariables,
+        fetch,
+        metadata,
+        policy: isSinglePage ? artifact.policy : CachePolicy.NetworkOnly,
+        session: await getSession()
+      },
+      isSinglePage ? [] : [where === "start" ? "prepend" : "append"]
+    );
+  };
+  const getPageInfo = () => {
+    return 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 && !deepEquals(getVariables(), variables)) {
+        return await parentFetch(args);
+      }
+      try {
+        var currentPageInfo = extractPageInfo(getState(), artifact.refetch.path);
+      } catch {
+        return await parentFetch(args);
+      }
+      const queryVariables = {};
+      const count = 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 || 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 missingPageSizeError("loadNextPage");
+      }
+      let isSinglePage = artifact.refetch?.mode === "SinglePage";
+      const targetFetch = isSinglePage ? parentFetch : parentFetchUpdate;
+      await targetFetch({
+        variables: queryVariables,
+        fetch,
+        metadata,
+        policy: isSinglePage ? artifact.policy : CachePolicy.NetworkOnly,
+        session: await getSession()
+      });
+      const pageSize = queryVariables.limit || artifact.refetch.pageSize;
+      currentOffset = offset + pageSize;
+    },
+    async fetch(params = {}) {
+      const { variables } = params;
+      if (variables && !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
+      });
+    }
+  };
+}
+export {
+  cursorHandlers,
+  offsetHandlers
+};

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

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

package/build/runtime-esm/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-esm/lib/selection.js

@@ -1,4 +1,12 @@
-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];
@@ -10,6 +18,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;
+}
 export {
   getFieldsForType
 };

package/build/runtime-esm/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-esm/lib/types.js

@@ -29,6 +29,7 @@ const DataSource = {
   Ssr: "ssr"
 };
 const fragmentKey = " $fragments";
+const PendingValue = Symbol("houdini_loading");
 export {
   ArtifactKind,
   CachePolicy,
@@ -38,6 +39,7 @@ export {
   CompiledSubscriptionKind,
   DataSource,
   PaginateMode,
+  PendingValue,
   RefetchUpdateMode,
   fragmentKey
 };

package/build/test/index.d.ts

@@ -9,3 +9,18 @@ export type Partial<T> = {
 export declare function pipelineTest(config: Config, documents: string[], shouldPass: boolean, testBody?: ((result: Error | Error[]) => void) | ((docs: Document[]) => void)): () => Promise<void>;
 export declare function mockCollectedDoc(query: string, data?: Partial<Document>): Document;
 export declare function clearMock(): void;
+export type Row = {
+    title: string;
+    pass: true;
+    documents: string[];
+    check?: (docs: Document[]) => void;
+    partial_config?: Partial<Config>;
+    nb_of_fail?: number;
+} | {
+    title: string;
+    pass: false;
+    documents: string[];
+    check?: (result: Error | Error[]) => void;
+    partial_config?: Partial<Config>;
+    nb_of_fail?: number;
+};