houdini 1.2.10 → 1.2.12

package/build/router-esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/build/runtime/client/documentStore.d.ts

@@ -25,6 +25,7 @@ export declare class DocumentStore<_Data extends GraphQLObject, _Input extends G
     });
     send({ metadata, session, fetch, variables, policy, stuff, cacheParams, setup, silenceEcho, }?: SendParams): Promise<QueryResult<_Data, _Input>>;
     cleanup(): Promise<void>;
+    getFetch(getSession: () => App.Session | null | undefined): (input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>;
 }
 declare function marshalVariables<_Data extends GraphQLObject, _Input extends GraphQLVariables>(ctx: ClientPluginContext): Record<string, any>;
 export type ClientPlugin = () => ClientHooks | null | (ClientHooks | ClientPlugin | null)[];

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

@@ -7,7 +7,7 @@ import type { FetchParamFn, ThrowOnErrorOperations, ThrowOnErrorParams } from '.
 export { DocumentStore, type ClientPlugin, type SendParams } from './documentStore';
 export { fetch, mutation, query, subscription } from './plugins';
 export type HoudiniClientConstructorArgs = {
-    url: string;
+    url?: string;
     fetchParams?: FetchParamFn;
     plugins?: NestedList<ClientPlugin>;
     pipeline?: NestedList<ClientPlugin>;
@@ -25,7 +25,19 @@ export declare class HoudiniClient {
     url: string;
     readonly plugins: ClientPlugin[];
     readonly throwOnError_operations: ThrowOnErrorOperations[];
-    constructor({ url, fetchParams, plugins, pipeline, throwOnError, }: HoudiniClientConstructorArgs);
+    proxies: Record<string, (operation: {
+        query: string;
+        variables: any;
+        operationName: string;
+        session: App.Session | null | undefined;
+    }) => Promise<any>>;
+    constructor({ url, fetchParams, plugins, pipeline, throwOnError, }?: HoudiniClientConstructorArgs);
     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/lib/config.d.ts

@@ -5,6 +5,8 @@ export declare function setMockConfig(config: ConfigFile | null): void;
 export declare function defaultConfigValues(file: ConfigFile): ConfigFile;
 export declare function keyFieldsForType(configFile: ConfigFile, type: string): string[];
 export declare function computeID(configFile: ConfigFile, type: string, data: any): string;
+export declare function localApiEndpoint(configFile: ConfigFile): string;
+export declare function localApiSessionKeys(configFile: ConfigFile): string[];
 export declare function getCurrentConfig(): ConfigFile;
 export type ConfigFile = {
     /**
@@ -110,6 +112,23 @@ export type ConfigFile = {
      * you must enable this flag.
      */
     acceptImperativeInstability?: boolean;
+    /**
+     * Configure the router
+     */
+    router?: RouterConfig;
+};
+type RouterConfig = {
+    auth?: AuthStrategy;
+    apiEndpoint?: string;
+};
+type AuthStrategy = {
+    redirect: string;
+    sessionKeys: string[];
+    url: string;
+} | {
+    mutation: string;
+    sessionKeys: string[];
+    url: string;
 };
 type ScalarMap = {
     [typeName: string]: ScalarSpec;

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

@@ -317,4 +317,43 @@ interface VariableNode {
 export declare const PendingValue: unique symbol;
 export type LoadingType = typeof PendingValue;
 export declare function isPending(value: any): value is LoadingType;
+export type ProjectManifest = {
+    /** All of the pages in the project */
+    pages: Record<string, PageManifest>;
+    /** All of the layouts in the project */
+    layouts: Record<string, PageManifest>;
+    /** All of the page queries in the project */
+    page_queries: Record<string, QueryManifest>;
+    /** All of the layout queries in the project */
+    layout_queries: Record<string, QueryManifest>;
+    /** All of the artifacts in the project */
+    artifacts: string[];
+    /** Whether or not there is a local schema defined */
+    local_schema: boolean;
+    /** Whether or not there is a custom instance of yoga defined */
+    local_yoga: boolean;
+};
+export type PageManifest = {
+    id: string;
+    /** the name of every query that the page depends on */
+    queries: string[];
+    /** the list of queries that this page could potentially ask for */
+    query_options: string[];
+    /** the full url pattern of the page */
+    url: string;
+    /** the ids of layouts that wrap this page */
+    layouts: string[];
+    /** The filepath of the unit */
+    path: string;
+};
+export type QueryManifest = {
+    /** the name of the query */
+    name: string;
+    /** the url tied with the query */
+    url: string;
+    /** wether the query uses the loading directive (ie, wants a fallback) */
+    loading: boolean;
+    /** The filepath of the unit */
+    path: string;
+};
 export {};

package/build/runtime/router/cookies.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * cookie
+ * Copyright(c) 2012-2014 Roman Shtylman
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+/**
+ * Parse a cookie header.
+ *
+ * Parse the given cookie header string into an object
+ * The object has the various cookies as keys(names) => values
+ *
+ * @param {string} str
+ * @param {object} [options]
+ * @return {object}
+ * @public
+ */
+export declare function parse(str: string, options?: {
+    decode?: (val: string) => string;
+}): Record<string, string>;
+/**
+ * Serialize data into a cookie header.
+ *
+ * Serialize the a name value pair into a cookie string suitable for
+ * http headers. An optional options object specified cookie parameters.
+ *
+ * serialize('foo', 'bar', { httpOnly: true })
+ *   => "foo=bar; httpOnly"
+ *
+ */
+export declare function serialize(name: string, val: string, options: {
+    encode: boolean;
+    maxAge: number;
+    domain: string;
+    path: string;
+    expires: Date;
+    httpOnly: boolean;
+    priority: string | number;
+    secure: boolean;
+    sameSite: string | boolean;
+}): string;

package/build/runtime/router/jwt.d.ts

@@ -0,0 +1,117 @@
+type SubtleCryptoImportKeyAlgorithm = any;
+/**
+ * @typedef JwtAlgorithm
+ * @type {'ES256'|'ES384'|'ES512'|'HS256'|'HS384'|'HS512'|'RS256'|'RS384'|'RS512'}
+ */
+export type JwtAlgorithm = 'ES256' | 'ES384' | 'ES512' | 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512';
+/**
+ * @typedef JwtAlgorithms
+ */
+export interface JwtAlgorithms {
+    [key: string]: SubtleCryptoImportKeyAlgorithm;
+}
+/**
+ * @typedef JwtHeader
+ * @prop {string} [typ] Type
+ */
+export interface JwtHeader {
+    /**
+     * Type (default: `"JWT"`)
+     *
+     * @default "JWT"
+     */
+    typ?: string;
+    [key: string]: any;
+}
+/**
+ * @typedef JwtPayload
+ * @prop {string} [iss] Issuer
+ * @prop {string} [sub] Subject
+ * @prop {string | string[]} [aud] Audience
+ * @prop {string} [exp] Expiration Time
+ * @prop {string} [nbf] Not Before
+ * @prop {string} [iat] Issued At
+ * @prop {string} [jti] JWT ID
+ */
+export interface JwtPayload {
+    /** Issuer */
+    iss?: string;
+    /** Subject */
+    sub?: string;
+    /** Audience */
+    aud?: string | string[];
+    /** Expiration Time */
+    exp?: number;
+    /** Not Before */
+    nbf?: number;
+    /** Issued At */
+    iat?: number;
+    /** JWT ID */
+    jti?: string;
+    [key: string]: any;
+}
+/**
+ * @typedef JwtOptions
+ * @prop {JwtAlgorithm | string} algorithm
+ */
+export interface JwtOptions {
+    algorithm?: JwtAlgorithm | string;
+}
+/**
+ * @typedef JwtSignOptions
+ * @extends JwtOptions
+ * @prop {JwtHeader} [header]
+ */
+export interface JwtSignOptions extends JwtOptions {
+    header?: JwtHeader;
+}
+/**
+ * @typedef JwtVerifyOptions
+ * @extends JwtOptions
+ * @prop {boolean} [throwError=false] If `true` throw error if checks fail. (default: `false`)
+ */
+export interface JwtVerifyOptions extends JwtOptions {
+    /**
+     * If `true` throw error if checks fail. (default: `false`)
+     *
+     * @default false
+     */
+    throwError?: boolean;
+}
+/**
+ * @typedef JwtData
+ * @prop {JwtHeader} header
+ * @prop {JwtPayload} payload
+ */
+export interface JwtData {
+    header: JwtHeader;
+    payload: JwtPayload;
+}
+/**
+ * Signs a payload and returns the token
+ *
+ * @param {JwtPayload} payload The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload.
+ * @param {string | JsonWebKey} secret A string which is used to sign the payload.
+ * @param {JwtSignOptions | JwtAlgorithm | string} [options={ algorithm: 'HS256', header: { typ: 'JWT' } }] The options object or the algorithm.
+ * @throws {Error} If there's a validation issue.
+ * @returns {Promise<string>} Returns token as a `string`.
+ */
+export declare function encode(payload: JwtPayload, secret: string | JsonWebKey, options?: JwtSignOptions | JwtAlgorithm): Promise<string>;
+/**
+ * Verifies the integrity of the token and returns a boolean value.
+ *
+ * @param {string} token The token string generated by `jwt.sign()`.
+ * @param {string | JsonWebKey} secret The string which was used to sign the payload.
+ * @param {JWTVerifyOptions | JWTAlgorithm} options The options object or the algorithm.
+ * @throws {Error | string} Throws an error `string` if the token is invalid or an `Error-Object` if there's a validation issue.
+ * @returns {Promise<boolean>} Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherwise returns `false`.
+ */
+export declare function verify(token: string, secret: string | JsonWebKey, options?: JwtVerifyOptions | JwtAlgorithm): Promise<boolean>;
+/**
+ * Returns the payload **without** verifying the integrity of the token. Please use `jwt.verify()` first to keep your application secure!
+ *
+ * @param {string} token The token string generated by `jwt.sign()`.
+ * @returns {JwtData} Returns an `object` containing `header` and `payload`.
+ */
+export declare function decode(token: string): JwtData;
+export {};

package/build/runtime/router/server.d.ts

@@ -0,0 +1,25 @@
+import type { ConfigFile } from '../lib';
+type ServerHandlerArgs = {
+    url: string;
+    config: ConfigFile;
+    session_keys: string[];
+    set_header: (key: string, value: string | number | string[]) => void;
+    get_header: (key: string) => string | number | string[] | undefined;
+    redirect: (code: number, url: string) => void;
+    next: () => void;
+};
+export declare function handle_request(args: ServerHandlerArgs): Promise<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;
+};
+export declare function get_session(req: Headers, secrets: string[]): Promise<App.Session>;
+export {};

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

@@ -25,6 +25,7 @@ export declare class DocumentStore<_Data extends GraphQLObject, _Input extends G
     });
     send({ metadata, session, fetch, variables, policy, stuff, cacheParams, setup, silenceEcho, }?: SendParams): Promise<QueryResult<_Data, _Input>>;
     cleanup(): Promise<void>;
+    getFetch(getSession: () => App.Session | null | undefined): (input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>;
 }
 declare function marshalVariables<_Data extends GraphQLObject, _Input extends GraphQLVariables>(ctx: ClientPluginContext): Record<string, any>;
 export type ClientPlugin = () => ClientHooks | null | (ClientHooks | ClientPlugin | null)[];

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

@@ -91,7 +91,7 @@ class DocumentStore extends import_store.Writable {
   async send({
     metadata,
     session,
-    fetch = globalThis.fetch,
+    fetch,
     variables,
     policy,
     stuff,
@@ -108,7 +108,7 @@ class DocumentStore extends import_store.Writable {
       variables: null,
       metadata,
       session,
-      fetch,
+      fetch: fetch ?? this.getFetch(() => session),
       stuff: {
         inputs: {
           changed: false,
@@ -150,6 +150,46 @@ class DocumentStore extends import_store.Writable {
       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;

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

@@ -7,7 +7,7 @@ import type { FetchParamFn, ThrowOnErrorOperations, ThrowOnErrorParams } from '.
 export { DocumentStore, type ClientPlugin, type SendParams } from './documentStore';
 export { fetch, mutation, query, subscription } from './plugins';
 export type HoudiniClientConstructorArgs = {
-    url: string;
+    url?: string;
     fetchParams?: FetchParamFn;
     plugins?: NestedList<ClientPlugin>;
     pipeline?: NestedList<ClientPlugin>;
@@ -25,7 +25,19 @@ export declare class HoudiniClient {
     url: string;
     readonly plugins: ClientPlugin[];
     readonly throwOnError_operations: ThrowOnErrorOperations[];
-    constructor({ url, fetchParams, plugins, pipeline, throwOnError, }: HoudiniClientConstructorArgs);
+    proxies: Record<string, (operation: {
+        query: string;
+        variables: any;
+        operationName: string;
+        session: App.Session | null | undefined;
+    }) => Promise<any>>;
+    constructor({ url, fetchParams, plugins, pipeline, throwOnError, }?: HoudiniClientConstructorArgs);
     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

@@ -33,6 +33,7 @@ __export(client_exports, {
   subscription: () => import_plugins2.subscription
 });
 module.exports = __toCommonJS(client_exports);
+var import_lib = require("../lib");
 var import_flatten = require("../lib/flatten");
 var import_documentStore = require("./documentStore");
 var import_plugins = require("./plugins");
@@ -43,13 +44,14 @@ class HoudiniClient {
   url;
   plugins;
   throwOnError_operations;
+  proxies = {};
   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."
@@ -71,7 +73,8 @@ class HoudiniClient {
         )
       )
     );
-    this.url = url;
+    let serverPort = globalThis.process?.env?.HOUDINI_PORT ?? "5173";
+    this.url = url ?? (globalThis.window ? "" : `https://localhost:${serverPort}`) + (0, import_lib.localApiEndpoint)((0, import_lib.getCurrentConfig)());
   }
   observe({
     enableCache = true,
@@ -86,6 +89,9 @@ class HoudiniClient {
       ...rest
     });
   }
+  registerProxy(url, handler) {
+    this.proxies[url] = handler;
+  }
 }
 function createPluginHooks(plugins) {
   return plugins.reduce((hooks, plugin) => {

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

@@ -5,6 +5,8 @@ export declare function setMockConfig(config: ConfigFile | null): void;
 export declare function defaultConfigValues(file: ConfigFile): ConfigFile;
 export declare function keyFieldsForType(configFile: ConfigFile, type: string): string[];
 export declare function computeID(configFile: ConfigFile, type: string, data: any): string;
+export declare function localApiEndpoint(configFile: ConfigFile): string;
+export declare function localApiSessionKeys(configFile: ConfigFile): string[];
 export declare function getCurrentConfig(): ConfigFile;
 export type ConfigFile = {
     /**
@@ -110,6 +112,23 @@ export type ConfigFile = {
      * you must enable this flag.
      */
     acceptImperativeInstability?: boolean;
+    /**
+     * Configure the router
+     */
+    router?: RouterConfig;
+};
+type RouterConfig = {
+    auth?: AuthStrategy;
+    apiEndpoint?: string;
+};
+type AuthStrategy = {
+    redirect: string;
+    sessionKeys: string[];
+    url: string;
+} | {
+    mutation: string;
+    sessionKeys: string[];
+    url: string;
 };
 type ScalarMap = {
     [typeName: string]: ScalarSpec;

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

@@ -29,6 +29,8 @@ __export(config_exports, {
   getCurrentConfig: () => getCurrentConfig,
   getMockConfig: () => getMockConfig,
   keyFieldsForType: () => keyFieldsForType,
+  localApiEndpoint: () => localApiEndpoint,
+  localApiSessionKeys: () => localApiSessionKeys,
   setMockConfig: () => setMockConfig
 });
 module.exports = __toCommonJS(config_exports);
@@ -70,6 +72,12 @@ function computeID(configFile, type, data) {
   return id.slice(0, -2);
 }
 let _configFile = null;
+function localApiEndpoint(configFile) {
+  return configFile.router?.apiEndpoint ?? "/_api";
+}
+function localApiSessionKeys(configFile) {
+  return configFile.router?.auth?.sessionKeys ?? [];
+}
 function getCurrentConfig() {
   const mockConfig2 = getMockConfig();
   if (mockConfig2) {
@@ -92,5 +100,7 @@ function getCurrentConfig() {
   getCurrentConfig,
   getMockConfig,
   keyFieldsForType,
+  localApiEndpoint,
+  localApiSessionKeys,
   setMockConfig
 });

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

@@ -317,4 +317,43 @@ interface VariableNode {
 export declare const PendingValue: unique symbol;
 export type LoadingType = typeof PendingValue;
 export declare function isPending(value: any): value is LoadingType;
+export type ProjectManifest = {
+    /** All of the pages in the project */
+    pages: Record<string, PageManifest>;
+    /** All of the layouts in the project */
+    layouts: Record<string, PageManifest>;
+    /** All of the page queries in the project */
+    page_queries: Record<string, QueryManifest>;
+    /** All of the layout queries in the project */
+    layout_queries: Record<string, QueryManifest>;
+    /** All of the artifacts in the project */
+    artifacts: string[];
+    /** Whether or not there is a local schema defined */
+    local_schema: boolean;
+    /** Whether or not there is a custom instance of yoga defined */
+    local_yoga: boolean;
+};
+export type PageManifest = {
+    id: string;
+    /** the name of every query that the page depends on */
+    queries: string[];
+    /** the list of queries that this page could potentially ask for */
+    query_options: string[];
+    /** the full url pattern of the page */
+    url: string;
+    /** the ids of layouts that wrap this page */
+    layouts: string[];
+    /** The filepath of the unit */
+    path: string;
+};
+export type QueryManifest = {
+    /** the name of the query */
+    name: string;
+    /** the url tied with the query */
+    url: string;
+    /** wether the query uses the loading directive (ie, wants a fallback) */
+    loading: boolean;
+    /** The filepath of the unit */
+    path: string;
+};
 export {};

package/build/runtime-cjs/router/cookies.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * cookie
+ * Copyright(c) 2012-2014 Roman Shtylman
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+/**
+ * Parse a cookie header.
+ *
+ * Parse the given cookie header string into an object
+ * The object has the various cookies as keys(names) => values
+ *
+ * @param {string} str
+ * @param {object} [options]
+ * @return {object}
+ * @public
+ */
+export declare function parse(str: string, options?: {
+    decode?: (val: string) => string;
+}): Record<string, string>;
+/**
+ * Serialize data into a cookie header.
+ *
+ * Serialize the a name value pair into a cookie string suitable for
+ * http headers. An optional options object specified cookie parameters.
+ *
+ * serialize('foo', 'bar', { httpOnly: true })
+ *   => "foo=bar; httpOnly"
+ *
+ */
+export declare function serialize(name: string, val: string, options: {
+    encode: boolean;
+    maxAge: number;
+    domain: string;
+    path: string;
+    expires: Date;
+    httpOnly: boolean;
+    priority: string | number;
+    secure: boolean;
+    sameSite: string | boolean;
+}): string;