tungsten 0.6.2 → 0.7.0

package/dist/testing/hostPipeline.js

@@ -0,0 +1,341 @@
+import { TungstenBaseComponent, TungstenBaseSimpleStoreComponent, TungstenBaseStatefulStoreComponent, TungstenBaseStoreComponent, TungstenSimpleComponent } from "../Components.js";
+import { ContentNodeComponentIsClassComponent, ContentNodeElementIsComponent } from '../ContentNode.js';
+import { $props, $type } from '../contentNodeSymbols.js';
+import { componentTypeIdentityKey } from '../hmr/componentIdentity.js';
+import { makeStore } from '../Store/makeStore.js';
+import { routing } from "../Servers/routing.js";
+import { resolveContent } from './resolveContent.js';
+import { missingStoreValue, testingComponentPackage } from './testingComponentPackage.js';
+const isPromise = value => value instanceof Promise || typeof value === 'object' && value !== null && 'then' in value;
+// The same list at runtime. Underscore-prefixed members are excluded by rule
+// (the framework's naming scheme), so only the plain-named ones are listed, and
+// frameworkMembersAreComplete below fails to compile if one is ever missed.
+const frameworkMemberNames = ['props', 'routeParams', 'routeData', 'parentComponent', 'childComponents', 'globalData', 'state', 'storeData', 'style', 'title', 'content', 'render', 'init', 'clientInit', 'serverInit', 'componentDidMount', 'componentDidHydrate', 'componentDidUpdate', 'componentDidRender', 'componentWillUnmount', 'componentDidUnmount', 'shouldStoreComponentUpdate', 'setState', 'triggerUpdate', 'pickProps', 'pickState', 'using', 'reactive', 'setTimeout', 'setInterval', 'clearTimeout', 'clearInterval', 'tungsten'];
+const frameworkMembers = new Set(frameworkMemberNames);
+// a key the store does not hold names itself when it is read, rather than coming back undefined
+const namingMissingKeys = store => new Proxy(store, {
+  get: (target, key) => typeof key === 'symbol' || key in target ? Reflect.get(target, key) : missingStoreValue(`store.${key}`)
+});
+const isStoreComponent = component => component instanceof TungstenBaseStoreComponent || component instanceof TungstenBaseSimpleStoreComponent || component instanceof TungstenBaseStatefulStoreComponent;
+// Runs routing only when asked: a unit test otherwise states the route itself.
+async function hostedRouting(options, context, networkedData) {
+  if (options.routing === true) {
+    const routes = typeof options.routes === 'function' ? options.routes(null, context, networkedData) : options.routes;
+    return {
+      routes,
+      internalStore: {
+        location: options.location,
+        matchedRouteInfo: await routing(options.location, routes, context, networkedData),
+        popMessages: []
+      }
+    };
+  }
+  const {
+    location,
+    matchedRoute
+  } = options;
+  const matchedRouteInfo = matchedRoute === undefined ? undefined : {
+    key: matchedRoute.key,
+    params: matchedRoute.params ?? {},
+    content: null,
+    ...('data' in matchedRoute ? {
+      data: matchedRoute.data
+    } : {})
+  };
+  return {
+    routes: options.routes,
+    internalStore: {
+      ...(location !== undefined ? {
+        location
+      } : {}),
+      ...(matchedRouteInfo !== undefined ? {
+        matchedRouteInfo
+      } : {}),
+      popMessages: []
+    }
+  };
+}
+/**
+ * Constructs a component outside of any app and drives it the way the framework
+ * does - init, then the mount lifecycles - calling its content function with
+ * whatever arguments its flavour takes, so tests don't have to match the
+ * (props) / (props, state) signature themselves.
+ *
+ * No DOM: content is returned as a content node tree, unstyled, and never
+ * reconciled. createTestApp() is the harness for anything that needs a document
+ * or app state. Lifecycle failures are thrown rather than only reported, so a
+ * test can't pass over one.
+ *
+ * State is not proxied (the construct package is marked `hosted`), so nothing
+ * re-renders on its own: updateProps() and updateState() are the renders.
+ *
+ * Store components have a structural overload: Schema is its own parameter, inferred from
+ * the class, so a generic wrapper (`Component extends { store: ComponentStore<S> }`) can
+ * call through without a cast. HostArgs is a conditional on Component, and a conditional
+ * on a type parameter is deferred, so nothing is assignable to it inside such a wrapper.
+ */
+// resolve: false has its own overloads, the content coming back as the component's own function
+// returns it; the rest resolve, so the content is always a promise
+// export async function host<
+//     Props extends TungstenComponentPropsBase,
+//     Schema extends object,
+//     Component extends TungstenBaseComponent<any, any> & { store: ComponentStore<Schema> },
+// >(
+//     ComponentType: TungstenComponentClass<Props, Component> & (new (...args: any) => { store: ComponentStore<Schema> }),
+//     props: Props,
+//     options: NoInfer<
+//         [Schema] extends [InternalStoreSchema] ? never : HostStoreOptions<Schema> & Unresolved
+//     >,
+// ): Promise<Hosted<Component>>
+// export async function host<
+//     Props extends TungstenComponentPropsBase,
+//     Component extends TungstenBaseComponent<any, any>,
+// >(
+//     ComponentType: TungstenComponentClass<Props, Component>,
+//     props: Props | undefined,
+//     options: HostOptions<Component> & Unresolved,
+// ): Promise<Hosted<Component>>
+// export async function host<
+//     Props extends TungstenComponentPropsBase,
+//     Schema extends object,
+//     Component extends TungstenBaseComponent<any, any> & { store: ComponentStore<Schema> },
+// >(
+//     ComponentType: TungstenComponentClass<Props, Component> & (new (...args: any) => { store: ComponentStore<Schema> }),
+//     props: Props,
+//     // NoInfer: Schema comes from the class alone, so a partial storeData can't widen it
+//     options: NoInfer<
+//         [Schema] extends [InternalStoreSchema] ? never : HostStoreOptions<Schema> & Resolved
+//     >,
+// ): Promise<HostedResolved<Component>>
+// // The general form: props optional only when none are required, options only without a store.
+// export async function host<
+//     Props extends TungstenComponentPropsBase,
+//     // not <Props, any>: the base is invariant in Props, so that rejects props narrower than the component's
+//     Component extends TungstenBaseComponent<any, any>,
+// >(
+//     ComponentType: TungstenComponentClass<Props, Component>,
+//     ...[props, options]: HostArgs<Props, Component>
+// ): Promise<HostedResolved<Component>>
+// actual
+export async function hostPipeline(ComponentType, props,
+// unknown, not a loose object type: the general overload's rest tuple can't be related to one
+options) {
+  const stored = options ?? {};
+  const storeData = stored.storeData ?? stored.partialStoreData;
+  const store = stored.store ?? stored.partialStore ?? (storeData === undefined ? undefined : makeStore(storeData, new Map()));
+  const partial = stored.partialStore !== undefined || stored.partialStoreData !== undefined;
+  // a partial store holds only the keys supplied, so name any other one read. On the store the
+  // instance shares, so a component resolve: true constructs is named it the same way
+  const shared = partial && store !== undefined ? namingMissingKeys(store) : store;
+  // one object each, so the routes function, the data function and the component see the same
+  // ones, as a request's do. Branded here, as the framework brands what it builds
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+  const context = stored.context ?? {};
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+  const networkedData = stored.networkedData ?? {};
+  const route = await hostedRouting(stored, context, networkedData);
+  const pending = [];
+  const failures = [];
+  // Instance.trackWork's no-scheduler path, except the work is kept so host
+  // can await it and the failure is re-thrown rather than logged.
+  const trackWork = (task, description) => {
+    const fail = error => {
+      failures.push(error instanceof Error ? new Error(`${description}: ${error.message}`, {
+        cause: error
+      }) : error);
+    };
+    let result;
+    try {
+      result = task();
+    } catch (error) {
+      fail(error);
+      return;
+    }
+    if (isPromise(result)) pending.push(Promise.resolve(result).catch(fail));
+  };
+  const settle = async () => {
+    while (pending.length > 0) await Promise.all(pending.splice(0));
+    if (failures.length > 0) throw failures[0];
+  };
+  let title;
+  const navigations = [];
+  // kept, not inlined: its instance is what resolving renders the rest of the tree against
+  const constructPackage = testingComponentPackage(
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- an absent props object is only reachable when Props allows {}
+  props ?? {}, {
+    ...(shared !== undefined ? {
+      store: shared
+    } : {}),
+    ...(route.routes !== undefined ? {
+      routes: route.routes
+    } : {}),
+    internalStore: route.internalStore,
+    context,
+    networkedData,
+    ...(stored.globalData !== undefined ? {
+      globalData: stored.globalData
+    } : {}),
+    trackWork,
+    // setState's work, run and awaited here rather than left to a timer
+    queueTask: (task, description) => {
+      trackWork(task, description);
+      return true;
+    },
+    setTitle: newTitle => {
+      title = newTitle;
+    },
+    // recorded, not carried out - navigating needs an app
+    goto: async to => {
+      navigations.push({
+        kind: 'goto',
+        to
+      });
+    },
+    redirect: to => {
+      navigations.push({
+        kind: 'redirect',
+        to
+      });
+    }
+  });
+  const component = new ComponentType(constructPackage);
+  // the component's own store is built at construction, from the keys there were: guard it too
+  if (partial && isStoreComponent(component)) component.store = namingMissingKeys(component.store);
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- state isn't on the base class, see StateOf
+  const stateful = component;
+  const simple = component instanceof TungstenSimpleComponent;
+  // Not awaited here: what the component's own content function returns is
+  // what comes back, so its declared type tells a test whether to await.
+  const ownContent = () => {
+    const contentFunction = component.content ?? component.render;
+    if (contentFunction === undefined) {
+      throw new Error(`host(): ${ComponentType.name} has no content or render function.`);
+    }
+    const call = contentFunction;
+    const result = simple ? call(component.props) : call(component.props, stateful.state);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- ContentOf recovers the concrete component's own return type
+    return result;
+  };
+  // resolve: the tree the app would render - every component in it constructed and asked for its
+  // content - so it is awaited whatever the hosted component's own content function returns
+  const guardPartialStore = built => {
+    if (isStoreComponent(built)) built.store = namingMissingKeys(built.store);
+  };
+  const resolved = async () => resolveContent(
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- ContentOf stays unresolved inside the generic; a content function returns a content tree
+  await ownContent(), component, constructPackage.instance, partial ? guardPartialStore : undefined);
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- resolving has its own overloads, whose content this is
+  const content = stored.resolve === false ? ownContent : resolved;
+  await component.__init();
+  component.__didMount();
+  await settle();
+  const core = {
+    get component() {
+      return component;
+    },
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- any from the constraint, see above
+    get props() {
+      return component.props;
+    },
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- as above
+    get state() {
+      return stateful.state;
+    },
+    get title() {
+      return title;
+    },
+    get navigations() {
+      return navigations;
+    },
+    content,
+    updateProps: async newProps => {
+      component.props = newProps;
+      // content first, then the completion lifecycles - the order
+      // __updateAndReturnContent() and its complete() callback run in.
+      const rendered = await content();
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- see UpdateCompletion
+      const completion = component;
+      // the framework passes the props the render saw, not the previous
+      // ones, despite componentDidUpdate's parameter name
+      if (simple) completion.__newUpdateCompleted(component.props);else completion.__newUpdateCompleted(component.props, stateful.state);
+      await settle();
+      return rendered;
+    },
+    updateState: async setter => {
+      if (stateful.state === undefined) {
+        throw new Error(`host(): ${ComponentType.name} has no state to update.`);
+      }
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- as above
+      const next = setter(stateful.state);
+      // a setter that mutated and returned nothing has already done the work
+      if (next !== undefined) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- StateOf is the component's own state type
+        stateful.state = next;
+      }
+      const rendered = await content();
+      await settle();
+      return rendered;
+    }
+  };
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- componentApi() collects exactly the members ComponentApi describes
+  return Object.assign(core, componentApi(component, core));
+}
+// export function hostPipelineGeneric<
+//     Props extends TungstenComponentPropsBase,
+//     Component extends TungstenBaseComponent<any, any>,
+// >(
+//     ComponentType: TungstenComponentClass<Props, Component>,
+//     ...args: HostGenericArgs<Component>
+// ): (props: Props) => Promise<HostedResolved<Component>>
+export function hostPipelineGeneric(ComponentType, options) {
+  // host()'s args are a conditional on Component, which stays deferred in a generic
+  // wrapper, so nothing is assignable to it here - the implementation signature is
+  // what this is calling
+  const call = hostPipeline;
+  return async props => call(ComponentType, props, options);
+}
+export async function hostPipelineJsx(element,
+// unknown: the overloads' options are conditional on Component, which nothing satisfies here
+options) {
+  if (!ContentNodeElementIsComponent(element) || !ContentNodeComponentIsClassComponent(element)) {
+    throw new Error(`hostJsx(): ${described(element)} is not a class component element.` + ' Give host() a component class; a function component is a function - call it.');
+  }
+  const ComponentType = element[$type]; // eslint-disable-line @typescript-eslint/no-unsafe-type-assertion -- the element's own class, which the call names when it wants the wrapper typed
+  return hostPipeline(ComponentType, element[$props], options); // eslint-disable-line @typescript-eslint/no-unsafe-type-assertion
+}
+// an html tag as written, a fragment as <>, a function component by name
+function described(element) {
+  const type = element[$type];
+  if (typeof type === 'string') return `<${type}>`;
+  if (typeof type === 'function') return `<${componentTypeIdentityKey(type)}>`;
+  return '<>';
+}
+// the variants hang off host() too, so a test reaches for one name
+hostPipeline.generic = hostPipelineGeneric;
+hostPipeline.jsx = hostPipelineJsx;
+// The component's own function members, bound and ready to call. Framework
+// members and anything the wrapper already provides are left out; the framework
+// keeps its internals under an underscore, which is the rest of the rule.
+function componentApi(component, core) {
+  const api = {};
+  const add = (name, descriptor) => {
+    if (descriptor === undefined || typeof descriptor.value !== 'function') return;
+    if (name.startsWith('_') || frameworkMembers.has(name)) return;
+    if (name in core || name in api) return;
+    const method = descriptor.value; // eslint-disable-line @typescript-eslint/no-unsafe-type-assertion -- guarded by the typeof above
+    // looked up only when called: a proxy field (a tRPC client) reads .bind as a procedure
+    api[name] = (...args) => Reflect.apply(method, component, args);
+  };
+  for (const name of Object.getOwnPropertyNames(component)) {
+    add(name, Object.getOwnPropertyDescriptor(component, name));
+  }
+  let prototype = Object.getPrototypeOf(component); // eslint-disable-line @typescript-eslint/no-unsafe-type-assertion
+  while (prototype !== null && prototype !== TungstenBaseComponent.prototype) {
+    for (const name of Object.getOwnPropertyNames(prototype)) {
+      if (name === 'constructor') continue;
+      add(name, Object.getOwnPropertyDescriptor(prototype, name));
+    }
+    prototype = Object.getPrototypeOf(prototype); // eslint-disable-line @typescript-eslint/no-unsafe-type-assertion
+  }
+  return api;
+}

package/dist/testing/hydrateTestApp.d.ts

@@ -1,6 +1,8 @@
 import type { ConstructPackage, TungstenBaseComponent, TungstenComponentPropsBase } from '../Components.jsx';
 import type { TaggedAttributeMismatch } from '../hydrate/renderHydrationMismatchBanner.js';
 import type { TestAppOptions } from './createTestApp.js';
+import { Instance } from '../Instance/Instance.js';
+import { UpdateScheduler } from '../update/UpdateScheduler.js';
 export type HydrateTestAppOptions<Props extends object> = TestAppOptions<Props> & {
     serverProps?: Props;
     csr?: boolean;
@@ -19,6 +21,21 @@ export type HydrateTestApp<Component extends TungstenBaseComponent> = {
     unmount(): Promise<void>;
     [Symbol.asyncDispose](): Promise<void>;
 };
+export declare function requireClient(harness: string): void;
+export declare function bridgeHappyDomGlobals(document: Document): void;
+export declare class HydrateTestAppImplementation<Component extends TungstenBaseComponent> implements HydrateTestApp<Component> {
+    #private;
+    readonly document: Document;
+    readonly container: HTMLElement;
+    readonly component: Component;
+    readonly html: string;
+    readonly mismatches: readonly TaggedAttributeMismatch[];
+    constructor(document: Document, container: HTMLElement, component: Component, instance: Instance, scheduler: UpdateScheduler, ownsContainer: boolean, html: string, mismatches: readonly TaggedAttributeMismatch[]);
+    resolved: () => Promise<void>;
+    setProps: (props: Component["props"]) => Promise<void>;
+    [Symbol.asyncDispose]: () => Promise<void>;
+    unmount: () => Promise<void>;
+}
 /**
  * The hydration round trip createTestApp() deliberately doesn't cover: render a component to
  * HTML the way a real server would, parse it with a real HTML parser, hydrate a fresh client

package/dist/testing/hydrateTestApp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hydrateTestApp.d.ts","sourceRoot":"","sources":["../../src/testing/hydrateTestApp.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACR,gBAAgB,EAChB,qBAAqB,EACrB,0BAA0B,EAC7B,MAAM,mBAAmB,CAAA;AAI1B,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA;AAK1F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAaxD,MAAM,MAAM,qBAAqB,CAAC,KAAK,SAAS,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG;IAM9E,WAAW,CAAC,EAAE,KAAK,CAAA;IAEnB,GAAG,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,KAAK,kBAAkB,CAAC,KAAK,SAAS,MAAM,IAAI,MAAM,SAAS,KAAK,GAC9D,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC,GACxC,MAAM,KAAK,SAAS,KAAK,GACrB,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC,GACxC,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,CAAA;AAEpE,MAAM,MAAM,cAAc,CAAC,SAAS,SAAS,qBAAqB,IAAI;IAClE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAA;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAG7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAIrB,QAAQ,CAAC,UAAU,EAAE,SAAS,uBAAuB,EAAE,CAAA;IAEvD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAExB,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACzC,CAAA;AAsGD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAChC,KAAK,SAAS,0BAA0B,EACxC,SAAS,SAAS,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,EACjD,SAAS,GAAG,SAAS,EAErB,aAAa,EAAE,KAAK,GAAG,EAAE,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,SAAS,EACzE,GAAG,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,GACnC,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAgIpC"}
+{"version":3,"file":"hydrateTestApp.d.ts","sourceRoot":"","sources":["../../src/testing/hydrateTestApp.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACR,gBAAgB,EAAE,qBAAqB,EAAE,0BAA0B,EACtE,MAAM,mBAAmB,CAAA;AAI1B,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA;AAI1F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAKxD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAUlD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAM9D,MAAM,MAAM,qBAAqB,CAAC,KAAK,SAAS,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG;IAM9E,WAAW,CAAC,EAAE,KAAK,CAAA;IAEnB,GAAG,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,KAAK,kBAAkB,CAAC,KAAK,SAAS,MAAM,IAAI,MAAM,SAAS,KAAK,GAC9D,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC,GACxC,MAAM,KAAK,SAAS,KAAK,GACrB,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC,GACxC,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,CAAA;AAEpE,MAAM,MAAM,cAAc,CAAC,SAAS,SAAS,qBAAqB,IAAI;IAClE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAA;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAG7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAIrB,QAAQ,CAAC,UAAU,EAAE,SAAS,uBAAuB,EAAE,CAAA;IAEvD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAExB,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACzC,CAAA;AAcD,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAQnD;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAY9D;AAED,qBAAa,4BAA4B,CAAC,SAAS,SAAS,qBAAqB,CACjF,YAAW,cAAc,CAAC,SAAS,CAAC;;IAChC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAA;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,SAAS,uBAAuB,EAAE,CAAA;gBAOnD,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,WAAW,EACtB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,eAAe,EAC1B,aAAa,EAAE,OAAO,EACtB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,SAAS,uBAAuB,EAAE;IAYlD,QAAQ,QAAa,OAAO,CAAC,IAAI,CAAC,CAEjC;IAED,QAAQ,GAAU,OAAO,SAAS,CAAC,OAAO,CAAC,KAAG,OAAO,CAAC,IAAI,CAAC,CAK1D;IAED,CAAC,MAAM,CAAC,YAAY,CAAC,QAAa,OAAO,CAAC,IAAI,CAAC,CAE9C;IAED,OAAO,QAAa,OAAO,CAAC,IAAI,CAAC,CA0BhC;CACJ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAChC,KAAK,SAAS,0BAA0B,EACxC,SAAS,SAAS,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,EACjD,SAAS,GAAG,SAAS,EAErB,aAAa,EAAE,KAAK,GAAG,EAAE,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,SAAS,EACzE,GAAG,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,GACnC,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAiJpC"}

package/dist/testing/hydrateTestApp.js

@@ -8,6 +8,7 @@ function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a),
 function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
 import { $props, $type } from '../contentNodeSymbols.js';
 import { Instance } from '../Instance/Instance.js';
+import { toRoutes } from '../routing/routesArray.js';
 import { hydrateRootComponent, makeDefaultHydrateMeta } from "../hydrate/hydrate.js";
 import { contentTreeToRenderingTree } from '../render/contentTreeToRenderingTree.js';
 import { renderingNodeToHtml } from '../render/renderingTreeToHtml.js';
@@ -15,13 +16,21 @@ import { initStores } from '../Servers/initStores.js';
 import { deleteNodeIfRendered } from '../update/integrateUpdateVdom.js';
 import { UpdateScheduler } from '../update/UpdateScheduler.js';
 import { DomPointer } from '../DomPointer.js';
+import { isClient } from '../isClient.js';
 import { waitForEnvIfLoading } from './loadEnv.js';
 // hydrate.tsx references several DOM globals directly (Node.COMMENT_NODE, `instanceof Text`, the
 // bare `document`) the way real browser code always can - happy-dom only puts these on its own
 // Window, not on Node.js's global scope. Every hand-written hydration test before this harness
 // bridged them manually; a caller of hydrateTestApp() shouldn't need to know that hydrate() was
 // written assuming a real browser to begin with.
-function bridgeHappyDomGlobals(document) {
+// Hydration is browser code: isClient decides what tungsten's modules do from the moment they load,
+// so a node-only run would take server paths and fail far from here
+export function requireClient(harness) {
+  if (!isClient) {
+    throw new Error(`${harness} needs a browser-like environment, and isClient is false: no global window` + ` existed when tungsten loaded. Run it in a DOM test suite whose setup puts happy-dom's` + ` window on the global before the tests are imported.`);
+  }
+}
+export function bridgeHappyDomGlobals(document) {
   const window = document.defaultView;
   if (window === null) return;
   const globals = globalThis; // eslint-disable-line @typescript-eslint/no-unsafe-type-assertion -- bridging happy-dom's globals onto the global scope
@@ -38,7 +47,7 @@ var _instance = /*#__PURE__*/new WeakMap();
 var _scheduler = /*#__PURE__*/new WeakMap();
 var _ownsContainer = /*#__PURE__*/new WeakMap();
 var _unmounted = /*#__PURE__*/new WeakMap();
-class HydrateTestAppImplementation {
+export class HydrateTestAppImplementation {
   constructor(document, container, component, instance, scheduler, ownsContainer, html, mismatches) {
     _defineProperty(this, "document", void 0);
     _defineProperty(this, "container", void 0);
@@ -111,6 +120,7 @@ class HydrateTestAppImplementation {
  * client hydrator does, so a caller reproducing that class of bug should assert on the rejection.
  */
 export async function hydrateTestApp(RootComponent, ...args) {
+  requireClient('hydrateTestApp()');
   await waitForEnvIfLoading();
   const options = args[0];
   const suppliedDocument = options?.document ?? globalThis.document;
@@ -137,7 +147,7 @@ export async function hydrateTestApp(RootComponent, ...args) {
   const clientProps = options?.props ?? {}; // eslint-disable-line @typescript-eslint/no-unsafe-type-assertion
   const serverProps = options?.serverProps ?? clientProps;
   const location = options?.location ?? '/';
-  const globalData = options?.globalData ?? {};
+  const globalData = options?.globalData ? options.globalData : {};
   const matchedRouteInfo = {
     key: null,
     params: options?.routeParams ?? {},
@@ -157,7 +167,11 @@ export async function hydrateTestApp(RootComponent, ...args) {
   // routing() falls back to the built-in 404 when neither '404' nor 'default' is given
   // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
   const appRoutes = options?.routes ?? {};
-  const routes = typeof appRoutes === 'function' ? appRoutes(null) : appRoutes;
+  const context = options?.context ?? {};
+  // one object for both passes: the server's is serialized into the page and carried to the client
+  const networkedData = options?.networkedData ?? {};
+  // dev, so a path given twice fails the test
+  const routes = toRoutes(typeof appRoutes === 'function' ? appRoutes(null, context, networkedData) : appRoutes, true);
   // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- rootToHtml.ts builds a root content node the same way
   const componentNode = {
     [$type]: RootComponent,
@@ -172,13 +186,16 @@ export async function hydrateTestApp(RootComponent, ...args) {
       internalStore,
       stores,
       storeSubscriptions
-    } = initStores(location, null, globalData, matchedRouteInfo);
+    } = initStores(location, null, globalData, matchedRouteInfo, null, context, networkedData);
     const ssrInstance = new Instance(location, instanceConfig, null, appRoutes, routes, internalStore, stores, storeSubscriptions, globalData, matchedRouteInfo, {
       document,
       window: document.defaultView,
       scheduler: ssrScheduler,
       navigation: false
     });
+    ssrInstance.fileVersions = options?.fileVersions;
+    ssrInstance.context = context;
+    ssrInstance.networkedData = networkedData;
     for (const override of options?.stores ?? []) {
       const store = override.registration.getStore(ssrInstance.stores);
       await override.initialize(store);
@@ -210,7 +227,7 @@ export async function hydrateTestApp(RootComponent, ...args) {
     internalStore,
     stores,
     storeSubscriptions
-  } = initStores(location, null, globalData, matchedRouteInfo);
+  } = initStores(location, null, globalData, matchedRouteInfo, null, context, networkedData);
   const runtimeContext = {
     document,
     window: document.defaultView,
@@ -218,6 +235,9 @@ export async function hydrateTestApp(RootComponent, ...args) {
     navigation: false
   };
   const instance = new Instance(location, instanceConfig, null, appRoutes, routes, internalStore, stores, storeSubscriptions, globalData, matchedRouteInfo, runtimeContext);
+  instance.fileVersions = options?.fileVersions;
+  instance.context = context;
+  instance.networkedData = networkedData;
   try {
     for (const override of options?.stores ?? []) {
       const store = override.registration.getStore(instance.stores);

package/dist/testing/hydrateTestPipelineApp.d.ts

@@ -0,0 +1,30 @@
+import type { ConstructPackage, TungstenBaseComponent, TungstenComponentPropsBase } from '../Components.jsx';
+import type { ReqRes } from '../ReqRes.js';
+import type { PipelineApp } from '../pipeline/pipelineDefinition.js';
+import type { TestStoreOverride } from './createTestApp.js';
+import type { HydrateTestApp } from './hydrateTestApp.js';
+export type HydrateTestPipelineAppOptions<Props extends object> = {
+    document?: Document;
+    props?: Props;
+    serverProps?: Props;
+    container?: HTMLElement;
+    location?: string;
+    reqRes?: ReqRes;
+    stores?: readonly TestStoreOverride<any>[];
+    fileVersions?: Record<string, string>;
+    csr?: boolean;
+};
+export type HydrateTestPipelineApp<Component extends TungstenBaseComponent> = HydrateTestApp<Component>;
+type HydrateTestPipelineAppArgs<Props extends object> = object extends Props ? [options?: HydrateTestPipelineAppOptions<Props>] : keyof Props extends never ? [options?: HydrateTestPipelineAppOptions<Props>] : [options: HydrateTestPipelineAppOptions<Props> & {
+    props: Props;
+}];
+/**
+ * hydrateTestApp() for an app built with pipeline() or splitPipeline(): the server pass runs the
+ * app's server stages, as a request does, and renders; the page carries the all-routes data and
+ * the networked data; the client pass runs the app's client stages, as hydratePipeline() does, and
+ * hydrates the parsed HTML. So a component whose markup depends on a context only one side makes
+ * shows up in `mismatches`, or throws on a structural difference.
+ */
+export declare function hydrateTestPipelineApp<Props extends TungstenComponentPropsBase, Component extends TungstenBaseComponent<any, any>, RouteData = undefined>(app: PipelineApp<any>, RootComponent: new (pkg: ConstructPackage<Props, RouteData>) => Component, ...args: HydrateTestPipelineAppArgs<Props>): Promise<HydrateTestPipelineApp<Component>>;
+export {};
+//# sourceMappingURL=hydrateTestPipelineApp.d.ts.map

package/dist/testing/hydrateTestPipelineApp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hydrateTestPipelineApp.d.ts","sourceRoot":"","sources":["../../src/testing/hydrateTestPipelineApp.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACR,gBAAgB,EAAE,qBAAqB,EAAE,0BAA0B,EACtE,MAAM,mBAAmB,CAAA;AAI1B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAI1C,OAAO,KAAK,EAAE,WAAW,EAAgB,MAAM,mCAAmC,CAAA;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAyBzD,MAAM,MAAM,6BAA6B,CAAC,KAAK,SAAS,MAAM,IAAI;IAC9D,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb,WAAW,CAAC,EAAE,KAAK,CAAA;IACnB,SAAS,CAAC,EAAE,WAAW,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,SAAS,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAA;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,GAAG,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,CAAC,SAAS,SAAS,qBAAqB,IACpE,cAAc,CAAC,SAAS,CAAC,CAAA;AAE/B,KAAK,0BAA0B,CAAC,KAAK,SAAS,MAAM,IAAI,MAAM,SAAS,KAAK,GACtE,CAAC,OAAO,CAAC,EAAE,6BAA6B,CAAC,KAAK,CAAC,CAAC,GAChD,MAAM,KAAK,SAAS,KAAK,GACrB,CAAC,OAAO,CAAC,EAAE,6BAA6B,CAAC,KAAK,CAAC,CAAC,GAChD,CAAC,OAAO,EAAE,6BAA6B,CAAC,KAAK,CAAC,GAAG;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,CAAA;AAiB5E;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CACxC,KAAK,SAAS,0BAA0B,EACxC,SAAS,SAAS,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,EACjD,SAAS,GAAG,SAAS,EAErB,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,EACrB,aAAa,EAAE,KAAK,GAAG,EAAE,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,SAAS,EACzE,GAAG,IAAI,EAAE,0BAA0B,CAAC,KAAK,CAAC,GAC3C,OAAO,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC,CA+I5C"}