houdini 2.0.0-next.8 → 2.0.0

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

@@ -1,487 +0,0 @@
-"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 documentStore_exports = {};
-__export(documentStore_exports, {
-  DocumentStore: () => DocumentStore
-});
-module.exports = __toCommonJS(documentStore_exports);
-var import_config = require("../lib/config");
-var import_deepEquals = require("../lib/deepEquals");
-var import_scalars = require("../lib/scalars");
-var import_store = require("../lib/store");
-var import_types = require("../lib/types");
-var import_plugins = require("./plugins");
-const steps = {
-  forward: ["start", "beforeNetwork", "network"],
-  backwards: ["end", "afterNetwork"]
-};
-let inflightRequests = {};
-class DocumentStore extends import_store.Writable {
-  artifact;
-  #client;
-  #configFile;
-  // the list of instantiated plugins
-  #plugins;
-  // we need to track the last set of variables used so we can
-  // detect if they have changed
-  #lastVariables;
-  // we need the last context value we've seen in order to pass it during cleanup
-  #lastContext = null;
-  // a reference to the earliest resolving open promise that the store has sent
-  pendingPromise = null;
-  serverSideFallback;
-  controllerKey(variables) {
-    const usedVariables = "dedupe" in this.artifact && this.artifact.dedupe?.match !== import_types.DedupeMatchMode.Variables ? {} : variables;
-    return `${this.artifact.name}@${stableStringify(usedVariables)}`;
-  }
-  constructor({
-    artifact,
-    plugins,
-    pipeline,
-    client,
-    cache,
-    enableCache = true,
-    initialValue,
-    initialVariables,
-    fetching
-  }) {
-    fetching ??= artifact.kind === import_types.ArtifactKind.Query;
-    const initialState = {
-      data: initialValue ?? null,
-      errors: null,
-      partial: false,
-      stale: false,
-      source: null,
-      fetching,
-      variables: initialVariables ?? null
-    };
-    super(initialState, () => {
-      return () => {
-        this.#lastVariables = null;
-        this.cleanup();
-      };
-    });
-    this.artifact = artifact;
-    this.#client = client;
-    this.#lastVariables = null;
-    this.#configFile = (0, import_config.getCurrentConfig)();
-    this.#plugins = pipeline ?? [
-      // cache policy needs to always come first so that it can be the first network to fire
-      (0, import_plugins.cachePolicy)({
-        cache,
-        enabled: enableCache,
-        setFetching: (fetching2, data) => {
-          this.update((state) => {
-            const newState = { ...state, fetching: fetching2 };
-            if (fetching2 && data) {
-              newState.data = data;
-            }
-            return newState;
-          });
-        }
-      })(),
-      ...plugins ?? []
-    ];
-  }
-  // used by the client to send a new set of variables to the pipeline
-  async send({
-    metadata,
-    session,
-    fetch,
-    variables,
-    policy,
-    stuff,
-    cacheParams,
-    setup = false,
-    silenceEcho = false,
-    abortController = new AbortController()
-  } = {}) {
-    if ("dedupe" in this.artifact && this.artifact.dedupe && this.artifact.dedupe.match !== "None") {
-      const dedupeKey = this.controllerKey(variables);
-      if (inflightRequests[dedupeKey]) {
-        if (this.artifact.dedupe.cancel === "first") {
-          inflightRequests[dedupeKey].controller.abort();
-          inflightRequests[dedupeKey].controller = abortController;
-        } else {
-          abortController.abort();
-        }
-      } else {
-        inflightRequests[dedupeKey] = {
-          variables,
-          controller: abortController
-        };
-      }
-    }
-    let context = new ClientPluginContextWrapper({
-      abortController,
-      config: this.#configFile,
-      name: this.artifact.name,
-      text: this.artifact.raw,
-      hash: this.artifact.hash,
-      policy: policy ?? this.artifact.policy,
-      variables: null,
-      metadata,
-      session,
-      fetch: fetch ?? this.getFetch(() => session),
-      stuff: {
-        inputs: {
-          changed: false,
-          init: false,
-          marshaled: {}
-        },
-        ...stuff
-      },
-      artifact: this.artifact,
-      lastVariables: this.#lastVariables,
-      cacheParams
-    });
-    const draft = context.draft();
-    draft.variables = variables ?? null;
-    context = context.apply(draft, false);
-    const promise = new Promise((resolve, reject) => {
-      const state = {
-        setup,
-        currentStep: 0,
-        index: 0,
-        silenceEcho,
-        promise: {
-          resolved: false,
-          resolve,
-          reject,
-          then: (...args) => promise.then(...args)
-        },
-        // patch the context with new variables
-        context
-      };
-      if (this.pendingPromise === null) {
-        this.pendingPromise = state.promise;
-      }
-      this.#step("forward", state);
-    });
-    const response = await promise;
-    delete inflightRequests[this.controllerKey(variables)];
-    return response;
-  }
-  async cleanup() {
-    for (const plugin of this.#plugins) {
-      plugin.cleanup?.(this.#lastContext);
-    }
-  }
-  getFetch(getSession) {
-    return async (input, init) => {
-      let url = "";
-      let queries = [];
-      if (typeof input === "string") {
-        url = input.startsWith("http") ? new URL(input).pathname : input;
-      }
-      if (input instanceof URL) {
-        url = input.pathname;
-      } else if (input instanceof Request) {
-        url = new URL(input.url).pathname;
-      }
-      if (input instanceof Request) {
-        const body = await input.json();
-        if (!Array.isArray(body)) {
-          queries = [body];
-        }
-      } else {
-        const body = JSON.parse(init?.body);
-        if (!Array.isArray(body)) {
-          queries = [body];
-        }
-      }
-      if (!url || queries.length === 0) {
-        return await globalThis.fetch(input, init);
-      }
-      if (this.#client?.proxies[url]) {
-        const result = await Promise.all(
-          queries.map(
-            (q) => this.#client?.proxies[url]({
-              ...q,
-              session: getSession()
-            })
-          )
-        );
-        return new Response(JSON.stringify(result.length === 1 ? result[0] : result));
-      }
-      return await globalThis.fetch(input, init);
-    };
-  }
-  #step(direction, ctx, value) {
-    const hook = direction === "error" ? "catch" : steps[direction][ctx.currentStep];
-    let valid = (i) => i <= this.#plugins.length;
-    let step = (i) => i + 1;
-    if (["backwards", "error"].includes(direction)) {
-      valid = (i) => i >= 0;
-      step = (i) => i - 1;
-    }
-    for (let index = ctx.index; valid(index); index = step(index)) {
-      let target = this.#plugins[index]?.[hook];
-      if (!target) {
-        continue;
-      }
-      const draft = ctx.context.draft();
-      let variablesRefChanged = (newContext) => newContext.variables !== draft.variables;
-      const common = {
-        initialValue: this.state,
-        client: this.#client,
-        variablesChanged,
-        marshalVariables,
-        updateState: this.update.bind(this),
-        next: (newContext) => {
-          const nextIndex = ["forward", "error"].includes(direction) ? (
-            // if we're going forward, add one
-            index + 1
-          ) : (
-            // if we're moving backwards but called next, we
-            // we need to invoke the same hook
-            index
-          );
-          const nextStep = ["backwards", "error"].includes(direction) ? 0 : ctx.currentStep;
-          this.#step("forward", {
-            ...ctx,
-            index: nextIndex,
-            currentStep: nextStep,
-            context: ctx.context.apply(newContext, variablesRefChanged(newContext))
-          });
-        },
-        resolve: (newContext, value2) => {
-          const nextIndex = direction === "backwards" ? (
-            // if we're going backwards, subtract one
-            index - 1
-          ) : (
-            // if we're moving forwards but then call resolve
-            // we need to visit the same hook
-            index
-          );
-          this.#step(
-            "backwards",
-            {
-              ...ctx,
-              index: nextIndex,
-              context: ctx.context.apply(newContext, variablesRefChanged(newContext))
-            },
-            value2
-          );
-        }
-      };
-      let handlers;
-      if (direction === "forward") {
-        handlers = common;
-      } else if (direction === "backwards") {
-        handlers = {
-          ...common,
-          value,
-          resolve: (ctx2, data) => {
-            return common.resolve(ctx2, data ?? value);
-          }
-        };
-      } else if (direction === "error") {
-        handlers = {
-          ...common,
-          error: value
-        };
-      }
-      try {
-        if (draft.abortController.signal.aborted) {
-          const abortError = new Error("aborted");
-          abortError.name = "AbortError";
-          throw abortError;
-        }
-        const result = target(draft, handlers);
-        result?.catch((err) => {
-          this.#step("error", { ...ctx, index: index - 1 }, err);
-        });
-      } catch (err) {
-        this.#step("error", { ...ctx, index: index - 1 }, err);
-      }
-      return;
-    }
-    if (direction === "forward") {
-      if (ctx.setup) {
-        return this.#step(
-          "backwards",
-          {
-            ...ctx,
-            currentStep: 0,
-            index: this.#plugins.length
-          },
-          this.state
-        );
-      }
-      if (ctx.currentStep <= steps.forward.length - 2) {
-        return this.#step("forward", {
-          ...ctx,
-          currentStep: ctx.currentStep + 1,
-          index: 0
-        });
-      }
-      throw new Error(
-        "Called next() on last possible plugin. Your chain is missing a plugin that calls resolve()."
-      );
-    }
-    if (direction === "error") {
-      if (!ctx.promise.resolved) {
-        ctx.promise.reject(value);
-        ctx.promise.resolved = true;
-      }
-      return;
-    }
-    if (ctx.currentStep > 0) {
-      return this.#step(
-        "backwards",
-        {
-          ...ctx,
-          currentStep: ctx.currentStep - 1,
-          index: this.#plugins.length - 1
-        },
-        value
-      );
-    }
-    if (!ctx.silenceEcho || value.data !== this.state.data) {
-      this.set(value);
-    }
-    if (!ctx.promise.resolved) {
-      ctx.promise.resolve(value);
-      ctx.promise.resolved = true;
-    }
-    this.#lastContext = ctx.context.draft();
-    this.#lastVariables = this.#lastContext.stuff.inputs.marshaled;
-  }
-}
-class ClientPluginContextWrapper {
-  // separate the last variables from what we pass to the user
-  #context;
-  #lastVariables;
-  constructor({
-    lastVariables,
-    ...values
-  }) {
-    this.#context = values;
-    this.#lastVariables = lastVariables;
-  }
-  get variables() {
-    return this.#context.variables;
-  }
-  // draft produces a wrapper over the context so users can mutate it without
-  // actually affecting the context values
-  draft() {
-    const ctx = {
-      ...this.#context
-    };
-    const applyVariables = this.applyVariables.bind(this);
-    return {
-      ...ctx,
-      get stuff() {
-        return ctx.stuff;
-      },
-      set stuff(val) {
-        ctx.stuff = val;
-      },
-      get variables() {
-        return ctx.variables ?? null;
-      },
-      set variables(val) {
-        Object.assign(ctx, applyVariables(ctx, { variables: val }));
-      }
-    };
-  }
-  applyVariables(source, values) {
-    const artifact = source.artifact;
-    const ctx = {
-      ...source,
-      ...values
-    };
-    const val = values.variables;
-    let changed = {};
-    for (const [name, value] of Object.entries(val ?? {})) {
-      if (value !== source.variables?.[name]) {
-        changed[name] = value;
-      }
-    }
-    ctx.stuff = {
-      ...ctx.stuff,
-      inputs: {
-        ...ctx.stuff.inputs
-      }
-    };
-    const firstInit = !ctx.stuff.inputs || !ctx.stuff.inputs.init;
-    const hasChanged = Object.keys(changed).length > 0 || firstInit;
-    if (hasChanged) {
-      const newVariables = {
-        ...ctx.stuff.inputs?.marshaled,
-        ...(0, import_scalars.marshalInputs)({
-          artifact,
-          input: changed,
-          config: source.config
-        })
-      };
-      ctx.stuff.inputs = {
-        init: true,
-        marshaled: newVariables,
-        changed: true
-      };
-      ctx.variables = val;
-    }
-    ctx.stuff = {
-      ...ctx.stuff,
-      inputs: {
-        ...ctx.stuff.inputs,
-        changed: !(0, import_deepEquals.deepEquals)(ctx.stuff.inputs.marshaled, this.#lastVariables)
-      }
-    };
-    return ctx;
-  }
-  // apply applies the draft value in a new context
-  apply(values, newVariables) {
-    if (newVariables) {
-      values = this.applyVariables(this.#context, values);
-    }
-    const wrapper = new ClientPluginContextWrapper({
-      ...values,
-      lastVariables: this.#lastVariables
-    });
-    return wrapper;
-  }
-}
-function marshalVariables(ctx) {
-  return ctx.stuff.inputs?.marshaled ?? {};
-}
-function variablesChanged(ctx) {
-  return ctx.stuff.inputs?.changed;
-}
-function stableStringify(obj) {
-  return JSON.stringify(sortObject(obj));
-}
-function sortObject(obj) {
-  if (obj === null || typeof obj !== "object") {
-    return obj;
-  }
-  if (Array.isArray(obj)) {
-    return obj.map(sortObject);
-  }
-  return Object.keys(obj).sort().reduce((result, key) => {
-    result[key] = sortObject(obj[key]);
-    return result;
-  }, {});
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  DocumentStore
-});

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

@@ -1,50 +0,0 @@
-/// <reference path="../../../../../houdini.d.ts" />
-import type { Cache } from '../cache/cache';
-import type { DocumentArtifact, GraphQLVariables, GraphQLObject, NestedList } from '../lib/types';
-import type { ClientHooks, ClientPlugin } from './documentStore';
-import { DocumentStore } from './documentStore';
-import type { FetchParamFn, ThrowOnErrorOperations, ThrowOnErrorParams } from './plugins';
-export { DocumentStore, type ClientPlugin, type SendParams } from './documentStore';
-export { fetch, mutation, query, subscription } from './plugins';
-export type HoudiniClientConstructorArgs = {
-    url?: string;
-    fetchParams?: FetchParamFn;
-    plugins?: NestedList<ClientPlugin>;
-    pipeline?: NestedList<ClientPlugin>;
-    throwOnError?: ThrowOnErrorParams;
-};
-export type ObserveParams<_Data extends GraphQLObject, _Artifact extends DocumentArtifact = DocumentArtifact, _Input extends GraphQLVariables = GraphQLVariables> = {
-    artifact: _Artifact;
-    enableCache?: boolean;
-    cache?: Cache;
-    initialValue?: _Data | null;
-    initialVariables?: _Input;
-    fetching?: boolean;
-};
-export declare class HoudiniClient {
-    url: string;
-    readonly throwOnError_operations: ThrowOnErrorOperations[];
-    private cache;
-    private throwOnError;
-    private fetchParams;
-    private pipeline;
-    private extraPlugins;
-    proxies: Record<string, (operation: {
-        query: string;
-        variables: any;
-        operationName: string;
-        session: App.Session | null | undefined;
-    }) => Promise<any>>;
-    componentCache: Record<string, any>;
-    setCache(cache: Cache): void;
-    constructor({ url, fetchParams, plugins, pipeline, throwOnError, }?: HoudiniClientConstructorArgs);
-    get plugins(): ClientPlugin[];
-    observe<_Data extends GraphQLObject, _Input extends GraphQLVariables>({ enableCache, fetching, ...rest }: ObserveParams<_Data, DocumentArtifact, _Input>): DocumentStore<_Data, _Input>;
-    registerProxy(url: string, handler: (operation: {
-        query: string;
-        variables: any;
-        operationName: string;
-        session: App.Session | null | undefined;
-    }) => Promise<any>): void;
-}
-export declare function createPluginHooks(plugins: ClientPlugin[]): ClientHooks[];

package/build/runtime-cjs/client/index.js

@@ -1,162 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var client_exports = {};
-__export(client_exports, {
-  DocumentStore: () => import_documentStore2.DocumentStore,
-  HoudiniClient: () => HoudiniClient,
-  createPluginHooks: () => createPluginHooks,
-  fetch: () => import_plugins2.fetch,
-  mutation: () => import_plugins2.mutation,
-  query: () => import_plugins2.query,
-  subscription: () => import_plugins2.subscription
-});
-module.exports = __toCommonJS(client_exports);
-var import_cache = __toESM(require("../cache"), 1);
-var import_lib = require("../lib");
-var import_flatten = require("../lib/flatten");
-var import_documentStore = require("./documentStore");
-var import_plugins = require("./plugins");
-var import_injectedPlugins = __toESM(require("./plugins/injectedPlugins"), 1);
-var import_documentStore2 = require("./documentStore");
-var import_plugins2 = require("./plugins");
-class HoudiniClient {
-  // the URL of the api
-  url;
-  // expose operations settings
-  throwOnError_operations;
-  cache = null;
-  throwOnError;
-  fetchParams;
-  pipeline;
-  extraPlugins;
-  proxies = {};
-  // this is modified by page entries when they load in order to register the components source
-  componentCache = {};
-  // we need the ability to link the client up with an external cache
-  setCache(cache) {
-    this.cache = cache;
-  }
-  constructor({
-    url,
-    fetchParams,
-    plugins,
-    pipeline,
-    throwOnError
-  } = {}) {
-    if (plugins && pipeline) {
-      throw new Error(
-        "A client cannot be given a pipeline and a list of plugins at the same time."
-      );
-    }
-    this.throwOnError_operations = throwOnError?.operations ?? [];
-    let serverPort = globalThis.process?.env?.HOUDINI_PORT ?? "5173";
-    this.url = url ?? (globalThis.window ? "" : `http://localhost:${serverPort}`) + (0, import_lib.localApiEndpoint)((0, import_lib.getCurrentConfig)());
-    this.throwOnError = throwOnError;
-    this.fetchParams = fetchParams;
-    this.pipeline = pipeline;
-    this.extraPlugins = plugins;
-  }
-  get plugins() {
-    return (0, import_flatten.flatten)(
-      [].concat(
-        // if they specified a throw behavior
-        this.throwOnError ? [(0, import_plugins.throwOnError)(this.throwOnError)] : [],
-        (0, import_plugins.fetchParams)(this.fetchParams),
-        // if the user wants to specify the entire pipeline, let them do so
-        this.pipeline ?? // the user doesn't have a specific pipeline so we should just add their desired plugins
-        // to the standard set
-        [
-          (0, import_plugins.optimisticKeys)(this.cache ?? import_cache.default),
-          // make sure that documents always work
-          (0, import_plugins.query)(this.cache ?? import_cache.default),
-          (0, import_plugins.mutation)(this.cache ?? import_cache.default),
-          (0, import_plugins.fragment)(this.cache ?? import_cache.default)
-        ].concat(
-          // add the specified middlewares
-          this.extraPlugins ?? [],
-          // and any middlewares we got from plugins
-          import_injectedPlugins.default,
-          // if they provided a fetch function, use it as the body for the fetch middleware
-          (0, import_plugins.fetch)()
-        )
-      )
-    );
-  }
-  observe({
-    enableCache = true,
-    fetching = false,
-    ...rest
-  }) {
-    return new import_documentStore.DocumentStore({
-      client: this,
-      plugins: createPluginHooks(this.plugins),
-      fetching,
-      enableCache,
-      cache: this.cache ?? void 0,
-      ...rest
-    });
-  }
-  registerProxy(url, handler) {
-    this.proxies[url] = handler;
-  }
-}
-function createPluginHooks(plugins) {
-  return plugins.reduce((hooks, plugin) => {
-    if (typeof plugin !== "function") {
-      throw new Error("Encountered client plugin that's not a function");
-    }
-    const result = plugin();
-    if (!result) {
-      return hooks;
-    }
-    if (!Array.isArray(result)) {
-      return hooks.concat(result);
-    }
-    for (const value of result) {
-      if (!value) {
-        continue;
-      }
-      if (typeof value === "function") {
-        return hooks.concat(createPluginHooks([value]));
-      }
-      hooks.push(value);
-    }
-    return hooks;
-  }, []);
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  DocumentStore,
-  HoudiniClient,
-  createPluginHooks,
-  fetch,
-  mutation,
-  query,
-  subscription
-});

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

@@ -1,9 +0,0 @@
-import cache from '../../cache';
-import { Cache } from '../../cache/cache';
-import type { ClientPlugin } from '../documentStore';
-export declare const cachePolicy: ({ enabled, setFetching, cache: localCache, serverSideFallback, }: {
-    enabled: boolean;
-    setFetching: (val: boolean, data?: any) => void;
-    cache?: Cache | undefined;
-    serverSideFallback?: boolean | undefined;
-}) => ClientPlugin;