houdini-react 1.2.0-react.1 → 1.2.7

package/build/runtime-esm/routing/components/Router.d.ts

@@ -0,0 +1,56 @@
+import type { Cache } from '$houdini/runtime/cache/cache';
+import { DocumentStore, HoudiniClient } from '$houdini/runtime/client';
+import { LRUCache } from '$houdini/runtime/lib/lru';
+import { GraphQLObject, GraphQLVariables } from '$houdini/runtime/lib/types';
+import { QueryArtifact } from '$houdini/runtime/lib/types';
+import React from 'react';
+import { SuspenseCache } from '../lib/cache';
+import type { NavigationContext, RouterManifest } from '../lib/types';
+/**
+ * Router is the top level entry point for the filesystem-based router.
+ * It is responsible for loading various page sources (including API fetches) and
+ * then rendering when appropriate.
+ */
+export declare function Router({ manifest, intialURL, loaded_queries, loaded_artifacts, }: {
+    manifest: RouterManifest;
+    intialURL?: string;
+    loaded_queries?: Record<string, {
+        data: GraphQLObject;
+        variables: GraphQLVariables;
+    }>;
+    loaded_artifacts?: Record<string, QueryArtifact>;
+}): JSX.Element;
+export declare function useNavigationContext(): NavigationContext;
+export declare function RouterContextProvider({ children, client, cache, artifact_cache, component_cache, data_cache, pending_cache, last_variables, session: ssrSession, }: {
+    children: React.ReactElement;
+    client: HoudiniClient;
+    cache: Cache;
+    artifact_cache: SuspenseCache<QueryArtifact>;
+    component_cache: SuspenseCache<(props: any) => React.ReactElement>;
+    data_cache: SuspenseCache<DocumentStore<GraphQLObject, GraphQLVariables>>;
+    pending_cache: PendingCache;
+    last_variables: LRUCache<GraphQLVariables>;
+    session?: App.Session;
+}): JSX.Element;
+type RouterContext = {
+    client: HoudiniClient;
+    cache: Cache;
+    artifact_cache: SuspenseCache<QueryArtifact>;
+    component_cache: SuspenseCache<(props: any) => React.ReactElement>;
+    data_cache: SuspenseCache<DocumentStore<GraphQLObject, GraphQLVariables>>;
+    pending_cache: PendingCache;
+    last_variables: LRUCache<GraphQLVariables>;
+    session: App.Session;
+};
+export type PendingCache = SuspenseCache<Promise<void> & {
+    resolve: () => void;
+    reject: () => void;
+}>;
+export declare const useRouterContext: () => RouterContext;
+export declare function useClient(): HoudiniClient;
+export declare function useCache(): Cache;
+export declare function updateLocalSession(session: App.Session): void;
+export declare function useSession(): App.Session;
+export declare function useCurrentVariables(): GraphQLVariables;
+export declare function useQueryResult<_Data extends GraphQLObject, _Input extends GraphQLVariables>(name: string): [_Data | null, DocumentStore<_Data, _Input>];
+export {};

package/build/runtime-esm/routing/components/Router.js

@@ -0,0 +1,257 @@
+import { deepEquals } from "$houdini/runtime/lib/deepEquals";
+import React from "react";
+import { useStream } from "react-streaming";
+import { useDocumentStore } from "../../hooks/useDocumentStore";
+import { find_match } from "../lib/match";
+const NavContext = React.createContext({
+  currentRoute: "/",
+  goto: () => {
+    throw new Error("NOT FOUND");
+  }
+});
+function Router({
+  manifest,
+  intialURL,
+  loaded_queries,
+  loaded_artifacts
+}) {
+  const [current, setCurrent] = React.useState(() => {
+    return intialURL || window.location.pathname;
+  });
+  const [page, variables] = find_match(manifest, current);
+  useLoadPage({ page, variables, loaded_queries, loaded_artifacts });
+  const { component_cache } = useRouterContext();
+  const PageComponent = component_cache.get(page.id);
+  React.useEffect(() => {
+    if (window.location.pathname !== current) {
+      window.history.pushState({}, "", current);
+    }
+  }, [current]);
+  React.useEffect(() => {
+    const onChange = (evt) => {
+      setCurrent(window.location.pathname);
+    };
+    window.addEventListener("popstate", onChange);
+    return () => {
+      window.removeEventListener("popstate", onChange);
+    };
+  }, []);
+  return /* @__PURE__ */ React.createElement(
+    NavContext.Provider,
+    {
+      value: {
+        currentRoute: current,
+        goto: setCurrent
+      }
+    },
+    /* @__PURE__ */ React.createElement(VariableContext.Provider, { value: variables }, /* @__PURE__ */ React.createElement(PageComponent, { url: current }))
+  );
+}
+function useLoadPage({
+  page,
+  variables,
+  loaded_queries,
+  loaded_artifacts
+}) {
+  const {
+    client,
+    cache,
+    data_cache,
+    component_cache,
+    artifact_cache,
+    pending_cache,
+    last_variables
+  } = useRouterContext();
+  const stream = useStream();
+  const session = useSession();
+  function load_query({ id, artifact }) {
+    last_variables.set(page.id, variables);
+    if (pending_cache.has(id)) {
+      return pending_cache.get(id);
+    }
+    const observer = client.observe({ artifact, cache });
+    let resolve = () => {
+    };
+    let reject = () => {
+    };
+    const promise = new Promise((res, rej) => {
+      resolve = res;
+      reject = rej;
+      observer.send({
+        variables,
+        cacheParams: { disableSubscriptions: true },
+        session
+      }).then(() => {
+        data_cache.set(id, observer);
+        if (loaded_queries) {
+          loaded_queries[artifact.name] = {
+            data: observer.state.data,
+            variables
+          };
+        }
+        stream?.injectToStream(`
+						<script>
+							window.__houdini__cache__?.hydrate(${cache.serialize()}, window.__houdini__hydration__layer)
+
+							if (window.__houdini__nav_caches__?.pending_cache.has("${artifact.name}")) {
+								// before we resolve the pending signals,
+								// fill the data cache with values we got on the server
+								const new_store = window.__houdini__client__.observe({
+									artifact: window.__houdini__nav_caches__.artifact_cache.get("${artifact.name}"),
+									cache: window.__houdini__cache__,
+									initialValue: ${JSON.stringify(observer.state.data)}
+								})
+
+								window.__houdini__nav_caches__.data_cache.set("${artifact.name}", new_store)
+
+								// we're pushing this store onto the client, it should be initialized
+								new_store.send({
+									setup: true,
+									variables: ${JSON.stringify(variables)}
+								})
+
+								// notify anyone waiting on the pending cache
+								window.__houdini__nav_caches__.pending_cache.get("${artifact.name}").resolve()
+								window.__houdini__nav_caches__.pending_cache.delete("${artifact.name}")
+							}
+						<\/script>
+					`);
+        resolve();
+      }).catch(reject).finally(() => {
+        pending_cache.delete(id);
+      });
+    });
+    pending_cache.set(id, { ...promise, resolve, reject });
+    return pending_cache.get(id);
+  }
+  if (last_variables.has(page.id) && !deepEquals(last_variables.get(page.id), variables)) {
+    data_cache.clear();
+  }
+  const missing_artifacts = [];
+  const found_artifacts = {};
+  for (const key of Object.keys(page.documents)) {
+    if (artifact_cache.has(key)) {
+      found_artifacts[key] = artifact_cache.get(key);
+    } else {
+      missing_artifacts.push(key);
+    }
+  }
+  for (const artifact_id of missing_artifacts) {
+    page.documents[artifact_id].artifact().then((mod) => {
+      const artifact = mod.default;
+      artifact_cache.set(artifact_id, artifact);
+      if (loaded_artifacts) {
+        loaded_artifacts[artifact.name] = artifact;
+      }
+      stream?.injectToStream(`
+					<script type="module" src="@@houdini/artifact/${artifact.name}.js" async=""><\/script>
+				`);
+      load_query({ id: artifact.name, artifact });
+    }).catch((err) => {
+      console.log(err);
+    });
+  }
+  for (const artifact of Object.values(found_artifacts)) {
+    if (!data_cache.has(artifact.name)) {
+      load_query({ id: artifact.name, artifact });
+    }
+  }
+  if (!component_cache.has(page.id)) {
+    throw new Promise((resolve, reject) => {
+      page.component().then((mod) => {
+        component_cache.set(page.id, mod.default);
+        resolve();
+      }).catch(reject);
+    });
+  }
+}
+function useNavigationContext() {
+  return React.useContext(NavContext);
+}
+function RouterContextProvider({
+  children,
+  client,
+  cache,
+  artifact_cache,
+  component_cache,
+  data_cache,
+  pending_cache,
+  last_variables,
+  session: ssrSession = {}
+}) {
+  const [session, setSession] = React.useState(ssrSession);
+  const handleNewSession = React.useCallback((event) => {
+    setSession(event.detail);
+  }, []);
+  React.useEffect(() => {
+    window.addEventListener("_houdini_session_", handleNewSession);
+    return () => {
+      window.removeEventListener("_houdini_session_", handleNewSession);
+    };
+  }, []);
+  return /* @__PURE__ */ React.createElement(
+    Context.Provider,
+    {
+      value: {
+        client,
+        cache,
+        artifact_cache,
+        component_cache,
+        data_cache,
+        pending_cache,
+        last_variables,
+        session
+      }
+    },
+    children
+  );
+}
+const Context = React.createContext(null);
+const useRouterContext = () => {
+  const ctx = React.useContext(Context);
+  if (!ctx) {
+    throw new Error("Could not find router context");
+  }
+  return ctx;
+};
+function useClient() {
+  return useRouterContext().client;
+}
+function useCache() {
+  return useRouterContext().cache;
+}
+function updateLocalSession(session) {
+  window.dispatchEvent(
+    new CustomEvent("_houdini_session_", {
+      bubbles: true,
+      detail: session
+    })
+  );
+}
+function useSession() {
+  return useRouterContext().session;
+}
+function useCurrentVariables() {
+  return React.useContext(VariableContext);
+}
+const VariableContext = React.createContext(null);
+function useQueryResult(name) {
+  const store_ref = useRouterContext().data_cache.get(name);
+  const [{ data }, observer] = useDocumentStore({
+    artifact: store_ref.artifact,
+    observer: store_ref
+  });
+  return [data, observer];
+}
+export {
+  Router,
+  RouterContextProvider,
+  updateLocalSession,
+  useCache,
+  useClient,
+  useCurrentVariables,
+  useNavigationContext,
+  useQueryResult,
+  useRouterContext,
+  useSession
+};

package/build/runtime-esm/routing/components/index.d.ts

@@ -0,0 +1,2 @@
+export { Link } from './Link';
+export { Router, RouterContextProvider, useClient, updateLocalSession } from './Router';

package/build/runtime-esm/routing/components/index.js

@@ -0,0 +1,9 @@
+import { Link } from "./Link";
+import { Router, RouterContextProvider, useClient, updateLocalSession } from "./Router";
+export {
+  Link,
+  Router,
+  RouterContextProvider,
+  updateLocalSession,
+  useClient
+};

package/build/runtime-esm/routing/index.d.ts

@@ -0,0 +1,3 @@
+export * from './components';
+export { suspense_cache } from './lib/cache';
+export type { RouterManifest, RouterPageManifest } from './lib/types';

package/build/runtime-esm/routing/index.js

@@ -0,0 +1,5 @@
+export * from "./components";
+import { suspense_cache } from "./lib/cache";
+export {
+  suspense_cache
+};

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

@@ -0,0 +1,7 @@
+import { LRUCache } from '$houdini/runtime/lib/lru';
+export declare function suspense_cache<T>(): SuspenseCache<T>;
+export declare class SuspenseCache<_Data> extends LRUCache<_Data> {
+    #private;
+    get(key: string): _Data;
+    set(key: string, value: _Data): void;
+}

package/build/runtime-esm/routing/lib/cache.js

@@ -0,0 +1,29 @@
+import { LRUCache } from "$houdini/runtime/lib/lru";
+function suspense_cache() {
+  return new SuspenseCache();
+}
+class SuspenseCache extends LRUCache {
+  #callbacks = /* @__PURE__ */ new Map();
+  get(key) {
+    if (super.has(key)) {
+      return super.get(key);
+    }
+    throw new Promise((resolve, reject) => {
+      this.#subscribe(key, resolve, reject);
+    });
+  }
+  set(key, value) {
+    super.set(key, value);
+    if (this.#callbacks.has(key)) {
+      this.#callbacks.get(key)?.forEach(({ resolve }) => resolve());
+      this.#callbacks.delete(key);
+    }
+  }
+  #subscribe(key, resolve, reject) {
+    this.#callbacks.set(key, [...this.#callbacks.get(key) || [], { resolve, reject }]);
+  }
+}
+export {
+  SuspenseCache,
+  suspense_cache
+};

package/build/runtime-esm/routing/lib/match.d.ts

@@ -0,0 +1,38 @@
+import type { GraphQLVariables } from '$houdini/runtime/lib/types';
+import type { RouterManifest, RouterPageManifest } from './types';
+export type RouteParam = {
+    name: string;
+    matcher: string;
+    optional: boolean;
+    rest: boolean;
+    chained: boolean;
+};
+export interface ParamMatcher {
+    (param: string): boolean;
+}
+export declare function find_match(manifest: RouterManifest, current: string, allowNull: true): [RouterPageManifest | null, GraphQLVariables];
+export declare function find_match(manifest: RouterManifest, current: string, allowNull?: false): [RouterPageManifest, GraphQLVariables];
+/**
+ * Creates the regex pattern, extracts parameter names, and generates types for a route
+ */
+export declare function parse_page_pattern(id: string): {
+    pattern: RegExp;
+    params: RouteParam[];
+    page_id: string;
+};
+/**
+ * Splits a route id into its segments, removing segments that
+ * don't affect the path (i.e. groups). The root route is represented by `/`
+ * and will be returned as `['']`.
+ */
+export declare function get_route_segments(route: string): string[];
+export declare function exec(match: RegExpMatchArray, params: RouteParam[]): Record<string, string> | undefined;
+/**
+Copyright (c) 2020 [these people](https://github.com/sveltejs/kit/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/

package/build/runtime-esm/routing/lib/match.js

@@ -0,0 +1,122 @@
+const param_pattern = /^(\[)?(\.\.\.)?(\w+)(?:=(\w+))?(\])?$/;
+function find_match(manifest, current, allowNull) {
+  let match = null;
+  let matchVariables = null;
+  for (const page of Object.values(manifest.pages)) {
+    const urlMatch = current.match(page.pattern);
+    if (!urlMatch) {
+      continue;
+    }
+    match = page;
+    matchVariables = exec(urlMatch, page.params) || {};
+    break;
+  }
+  if (!match && !allowNull) {
+    throw new Error("404");
+  }
+  return [match, matchVariables];
+}
+function parse_page_pattern(id) {
+  const params = [];
+  const pattern = id === "/" ? /^\/$/ : new RegExp(
+    `^${get_route_segments(id).map((segment) => {
+      const rest_match = /^\[\.\.\.(\w+)(?:=(\w+))?\]$/.exec(segment);
+      if (rest_match) {
+        params.push({
+          name: rest_match[1],
+          matcher: rest_match[2],
+          optional: false,
+          rest: true,
+          chained: true
+        });
+        return "(?:/(.*))?";
+      }
+      const optional_match = /^\[\[(\w+)(?:=(\w+))?\]\]$/.exec(segment);
+      if (optional_match) {
+        params.push({
+          name: optional_match[1],
+          matcher: optional_match[2],
+          optional: true,
+          rest: false,
+          chained: true
+        });
+        return "(?:/([^/]+))?";
+      }
+      if (!segment) {
+        return;
+      }
+      const parts = segment.split(/\[(.+?)\](?!\])/);
+      const result = parts.map((content, i) => {
+        if (i % 2) {
+          if (content.startsWith("x+")) {
+            return escape(
+              String.fromCharCode(parseInt(content.slice(2), 16))
+            );
+          }
+          if (content.startsWith("u+")) {
+            return escape(
+              String.fromCharCode(
+                ...content.slice(2).split("-").map((code) => parseInt(code, 16))
+              )
+            );
+          }
+          const match = param_pattern.exec(content);
+          if (!match) {
+            throw new Error(
+              `Invalid param: ${content}. Params and matcher names can only have underscores and alphanumeric characters.`
+            );
+          }
+          const [, is_optional, is_rest, name, matcher] = match;
+          params.push({
+            name,
+            matcher,
+            optional: !!is_optional,
+            rest: !!is_rest,
+            chained: is_rest ? i === 1 && parts[0] === "" : false
+          });
+          return is_rest ? "(.*?)" : is_optional ? "([^/]*)?" : "([^/]+?)";
+        }
+        return escape(content);
+      }).join("");
+      return "/" + result;
+    }).join("")}/?$`
+  );
+  return { pattern, params, page_id: id };
+}
+function affects_path(segment) {
+  return !/^\([^)]+\)$/.test(segment);
+}
+function get_route_segments(route) {
+  return route.slice(1).split("/").filter(affects_path);
+}
+function exec(match, params) {
+  const result = {};
+  const values = match.slice(1);
+  let buffered = "";
+  for (let i = 0; i < params.length; i += 1) {
+    const param = params[i];
+    let value = values[i];
+    if (param.chained && param.rest && buffered) {
+      value = value ? buffered + "/" + value : buffered;
+    }
+    buffered = "";
+    if (value === void 0) {
+      if (param.rest)
+        result[param.name] = "";
+    } else {
+      result[param.name] = value;
+    }
+  }
+  if (buffered)
+    return;
+  return result;
+}
+function escape(str) {
+  return str.normalize().replace(/[[\]]/g, "\\$&").replace(/%/g, "%25").replace(/\//g, "%2[Ff]").replace(/\?/g, "%3[Ff]").replace(/#/g, "%23").replace(/[.*+?^${}()|\\]/g, "\\$&");
+}
+export {
+  exec,
+  find_match,
+  get_route_segments,
+  parse_page_pattern
+};

package/build/runtime-esm/routing/lib/types.d.ts

@@ -0,0 +1,23 @@
+import type { QueryArtifact } from '$houdini/runtime/lib/types';
+import type { RouteParam } from './match';
+export type RouterManifest = {
+    pages: Record<string, RouterPageManifest>;
+};
+export type RouterPageManifest = {
+    id: string;
+    pattern: RegExp;
+    params: RouteParam[];
+    documents: Record<string, {
+        artifact: () => Promise<{
+            default: QueryArtifact;
+        }>;
+        loading: boolean;
+    }>;
+    component: () => Promise<{
+        default: (props: any) => React.ReactElement;
+    }>;
+};
+export type NavigationContext = {
+    currentRoute: string;
+    goto: (route: string) => void;
+};

package/build/server/compat.d.ts

@@ -0,0 +1,7 @@
+import type { Config } from 'houdini';
+import type { Connect } from 'vite';
+import type { Server } from '.';
+export declare function dev_server({ server, config }: {
+    server: Connect.Server;
+    config: Config;
+}): Server;

package/build/server/index.d.ts

@@ -0,0 +1,17 @@
+import type { Config } from 'houdini';
+export declare function configure_server({ server, config }: {
+    server: Server;
+    config: Config;
+}): void;
+export type Server = {
+    use(fn: ServerMiddleware): void;
+};
+export type ServerMiddleware = (req: IncomingRequest, res: ServerResponse, next: () => void) => void;
+export type IncomingRequest = {
+    url?: string;
+    headers: Headers;
+};
+export type ServerResponse = {
+    redirect(url: string, status?: number): void;
+    set_header(name: string, value: string): void;
+};

package/build/server/session.d.ts

@@ -0,0 +1,3 @@
+import type { ServerResponse } from '.';
+export declare function set_session(res: ServerResponse, value: App.Session): void;
+export declare function get_session(req: Headers, secrets: string[]): App.Session;