@async/framework 0.11.16 → 0.11.17

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.11.17 - 2026-06-19
+
+- Added the stream backpatch protocol to `createBoundaryReceiver(...)` with
+  strict `attrs` validation for built numeric triples and no-build named
+  tuples.
+- Added pending-slot replacement and reveal coordination for `as-ready`,
+  `forwards`, `backwards`, and `together` stream groups, including collapsed
+  and hidden tail visibility handling.
+- Added the `AsyncStream` browser helper for no-build JSON stream patches,
+  template replacement, configured `data-async-*` attributes, and direct-child
+  reveal metadata synthesis.
+- Added stream backpatch scenario-size coverage and updated browser scenario
+  budgets for the expanded public stream surface.
+- Bundle size from bundled TypeScript source: `browser.ts` raw 221,403 B (221.4 KB / 0.221 MB), gzip 42,093 B (42.1 KB / 0.042 MB), br 34,797 B (34.8 KB / 0.035 MB) -> `browser.min.js` raw 95,027 B (95.0 KB / 0.095 MB), gzip 28,145 B (28.1 KB / 0.028 MB), br 24,793 B (24.8 KB / 0.025 MB); delta raw -126,376 B (-126.4 KB / -0.126 MB), gzip -13,948 B (-13.9 KB / -0.014 MB), br -10,004 B (-10.0 KB / -0.010 MB).
+
 ## 0.11.16 - 2026-06-19
 
 - Added runtime slice entrypoints for `@async/framework/runtime`,

package/browser.d.ts

@@ -513,10 +513,30 @@ export interface LoaderInstance {
 export type AsyncLoaderOptions = LoaderOptions;
 export type AsyncLoaderInstance = LoaderInstance;
 
+export type AttributePatchValue = string | number | boolean | null | undefined;
+export type BuiltAttributePatchTriples = readonly AttributePatchValue[];
+export type NoBuildAttributePatchTuple = readonly [targetName: string, attrName: string, value: AttributePatchValue];
+export type NoBuildAttributePatchTuples = readonly NoBuildAttributePatchTuple[];
+export interface StreamReplacement {
+  target: string;
+  html?: TemplateLike;
+  template?: string;
+  mode?: "pending" | "boundary";
+}
+export interface StreamRevealMetadata {
+  group: string;
+  index: number;
+  count: number;
+  order?: "as-ready" | "forwards" | "backwards" | "together";
+  tail?: "collapsed" | "hidden";
+}
 export interface BoundaryPatch {
   boundary: string;
   seq: number;
   html?: TemplateLike;
+  replace?: StreamReplacement | readonly StreamReplacement[];
+  attrs?: BuiltAttributePatchTriples | NoBuildAttributePatchTuples;
+  reveal?: StreamRevealMetadata;
   signals?: Record<string, unknown>;
   cache?: { browser?: Record<string, unknown> };
   redirect?: string;
@@ -526,17 +546,24 @@ export interface BoundaryPatch {
   meta?: Record<string, unknown>;
 }
 
+export interface BoundaryPatchCounts {
+  applied: number;
+  ignored?: number;
+}
+
 export type BoundaryApplyResult =
-  | { status: "applied"; boundary: string; seq: number }
+  | { status: "applied"; boundary: string; seq: number; attrs?: BoundaryPatchCounts; replace?: BoundaryPatchCounts }
+  | { status: "buffered"; boundary: string; seq: number; reveal: Required<Pick<StreamRevealMetadata, "group" | "index" | "count">> & Pick<StreamRevealMetadata, "order" | "tail"> }
   | { status: "ignored-stale"; boundary: string; seq: number; lastSeq: number }
   | { status: "ignored-destroyed"; boundary: string; seq: number; parentScope?: string }
-  | { status: "redirected"; boundary: string; seq: number; redirect: string }
+  | { status: "redirected"; boundary: string; seq: number; redirect: string; attrs?: BoundaryPatchCounts; replace?: BoundaryPatchCounts }
   | { status: "errored"; boundary: string; seq: number; error: Error };
 
 export interface BoundaryReceiverInspection {
   destroyed: boolean;
   boundaries: Record<string, { lastSeq: number; applied: number; ignored: number; errored?: number; lastStatus?: BoundaryApplyResult["status"] }>;
-  recent: Array<{ boundary: string; seq: number; status: BoundaryApplyResult["status"]; lastSeq?: number; parentScope?: string; redirect?: string }>;
+  reveal: Record<string, { count: number; order: string; tail?: string; pending: number[]; committed: number[] }>;
+  recent: Array<{ boundary: string; seq: number; status: BoundaryApplyResult["status"]; lastSeq?: number; parentScope?: string; redirect?: string; attrs?: BoundaryPatchCounts; replace?: BoundaryPatchCounts; reveal?: StreamRevealMetadata }>;
 }
 
 export interface BoundaryReceiverOptions {
@@ -545,6 +572,7 @@ export interface BoundaryReceiverOptions {
   cache?: CacheRegistry;
   scheduler?: Scheduler;
   router?: Router;
+  attributes?: AttributeConfig;
   onApply?(result: BoundaryApplyResult, patch: BoundaryPatch): void;
   onIgnore?(result: BoundaryApplyResult, patch: BoundaryPatch): void;
   onError?(error: Error, result: BoundaryApplyResult, patch: BoundaryPatch): void;
@@ -560,6 +588,18 @@ export interface BoundaryReceiver {
   destroy(): void;
 }
 
+export interface AsyncStreamApplyOptions extends Partial<BoundaryReceiverOptions> {
+  receiver?: BoundaryReceiver;
+  runtime?: AppRuntime;
+  root?: Document | Element | DocumentFragment;
+}
+
+export interface AsyncStreamNamespace {
+  applyScript(script: Element, options?: AsyncStreamApplyOptions): Promise<BoundaryApplyResult>;
+  applyCurrentScript(script?: Element, options?: AsyncStreamApplyOptions): Promise<BoundaryApplyResult>;
+  applyCurrentScript(options?: AsyncStreamApplyOptions): Promise<BoundaryApplyResult>;
+}
+
 export interface RegistryStore {
   target: RuntimeTarget;
   register(type: RegistryType, id: string, value: unknown): string;
@@ -696,6 +736,7 @@ export interface AsyncNamespace extends AppHub {
   inspectRoots: AppHub["inspectRoots"];
   attributeName: typeof attributeName;
   defineAttributeConfig: typeof defineAttributeConfig;
+  AsyncStream: AsyncStreamNamespace;
   createBoundaryReceiver: typeof createBoundaryReceiver;
   createCacheRegistry: typeof createCacheRegistry;
   defineCache: typeof defineCache;
@@ -736,6 +777,7 @@ export declare function defineApp(initial?: AppDefinition): AppHub;
 export declare function readSnapshot(root?: Document | Element, options?: { attributes?: AttributeConfig }): RegistryRuntimeSnapshot;
 export declare function attributeName(attributes: AttributeConfig | undefined, type: keyof NormalizedAttributeConfig, name: string): string;
 export declare function defineAttributeConfig(config?: AttributeConfig): NormalizedAttributeConfig;
+export declare const AsyncStream: AsyncStreamNamespace;
 export declare function createBoundaryReceiver(options: BoundaryReceiverOptions): BoundaryReceiver;
 export declare function createCacheRegistry(initialMap?: Record<string, CacheDefinition | CacheDefinitionOptions>, options?: { now?: () => number; registry?: RegistryStore; type?: "cache.browser" | "cache.server" }): CacheRegistry;
 export declare function defineCache(options?: CacheDefinitionOptions): CacheDefinition;