@theaiplatform/miniapp-sdk 0.3.1 → 0.3.2

package/README.md

@@ -30,7 +30,7 @@ Start with the [Miniapp SDK documentation](https://docs.theaiplatform.app/miniap
 - `@theaiplatform/miniapp-sdk/testing/rstest`
 - `@theaiplatform/miniapp-sdk/config-schema.json`
 
-## In-app E2E testing in 0.3.1
+## In-app E2E testing
 
 The `/testing/rstest` entry point extends Rstest's Playwright fixtures with a
 host-provided miniapp surface and exact TAP session provenance. Tests can assert

package/dist/rspack/index.d.ts

@@ -1,3 +1,4 @@
+import type { Format } from 'ajv';
 import type { LibConfig } from '@rslib/core';
 import { ModuleFederationOptions } from '@module-federation/rsbuild-plugin';
 import { RsbuildPlugin } from '@rsbuild/core';
@@ -29,8 +30,15 @@ declare type Config = {
 
 export declare const pluginTap: (options?: Config) => RsbuildPlugin;
 
+/** Registers the canonical JSON Schema formats used by TAP manifests. */
+export declare const registerTapManifestAjvFormats: <Registry extends TapManifestAjvFormatRegistry>(ajv: Registry) => Registry;
+
 export declare const tapLib: (options?: Config) => LibConfig;
 
+declare interface TapManifestAjvFormatRegistry {
+    addFormat(name: string, format: Format): unknown;
+}
+
 /** Emitted-package scan used to reject machine-local build artifacts. */
 export declare type TapPackageArtifactPortabilityOptions = {
     output: string;

package/dist/rspack/index.js

@@ -1994,27 +1994,30 @@ const isUrl = (value)=>{
         return false;
     }
 };
+const registerTapManifestAjvFormats = (ajv)=>{
+    ajv.addFormat('uri', {
+        type: 'string',
+        validate: isUrl
+    });
+    ajv.addFormat('uint8', {
+        type: 'number',
+        validate: (value)=>Number.isInteger(value) && value >= 0 && value <= 255
+    });
+    ajv.addFormat('uint16', {
+        type: 'number',
+        validate: (value)=>Number.isInteger(value) && value >= 0 && value <= 65535
+    });
+    ajv.addFormat('uint64', {
+        type: 'number',
+        validate: (value)=>Number.isSafeInteger(value) && value >= 0
+    });
+    return ajv;
+};
 const getSchemaValidator = async ()=>{
     if (!schemaValidator) {
-        const ajv = new __rspack_external_ajv_dist_2020_js_e85899db["default"]({
+        const ajv = registerTapManifestAjvFormats(new __rspack_external_ajv_dist_2020_js_e85899db["default"]({
             allErrors: true
-        });
-        ajv.addFormat('uri', {
-            type: 'string',
-            validate: isUrl
-        });
-        ajv.addFormat('uint8', {
-            type: 'number',
-            validate: (value)=>Number.isInteger(value) && value >= 0 && value <= 255
-        });
-        ajv.addFormat('uint16', {
-            type: 'number',
-            validate: (value)=>Number.isInteger(value) && value >= 0 && value <= 65535
-        });
-        ajv.addFormat('uint64', {
-            type: 'number',
-            validate: (value)=>Number.isSafeInteger(value) && value >= 0
-        });
+        }));
         schemaValidator = ajv.compile(config_schema_namespaceObject);
     }
     return schemaValidator;
@@ -3512,4 +3515,4 @@ const tapLib = (options = {})=>{
         ]
     };
 };
-export { assembleTapPackage, assertPortableTapPackageArtifacts, pluginTap, tapLib };
+export { assembleTapPackage, assertPortableTapPackageArtifacts, pluginTap, registerTapManifestAjvFormats, tapLib };

package/dist/testing/rstest.d.ts

@@ -1,31 +1,33 @@
 import { afterAll } from '@rstest/playwright';
-import { afterEach } from '@rstest/playwright';
-import { APIRequestContext } from 'playwright';
 import { beforeAll } from '@rstest/playwright';
-import { beforeEach } from '@rstest/playwright';
 import type { Browser } from 'playwright';
 import type { BrowserContext } from 'playwright';
 import { describe } from '@rstest/playwright';
 import { expect } from '@rstest/playwright';
 import type { FrameLocator } from 'playwright';
 import type { Page } from 'playwright';
-import { PlaywrightOptions } from '@rstest/playwright';
-import { PlaywrightServe } from '@rstest/playwright';
-import { PlaywrightTest } from '@rstest/playwright';
+import type { PlaywrightFixtures } from '@rstest/playwright';
+import type { PlaywrightTest } from '@rstest/playwright';
+import type { TestContext } from '@rstest/core';
+import type { TestOptions } from '@rstest/core';
 import { z } from 'zod';
 
 export { afterAll }
 
-export { afterEach }
+export declare const afterEach: TapAfterEachHook;
 
 export { beforeAll }
 
-export { beforeEach }
+export declare const beforeEach: TapBeforeEachHook;
 
 export { describe }
 
 export { expect }
 
+declare type MergeContext<ExtraContext, FixturesContext> = {
+    [Key in keyof FixturesContext | keyof ExtraContext]: Key extends keyof FixturesContext ? FixturesContext[Key] : Key extends keyof ExtraContext ? ExtraContext[Key] : never;
+};
+
 /** Validate a driver session before any endpoint or provenance field is used. */
 export declare function parseTapMiniappTestSession(value: unknown): TapMiniappTestSession;
 
@@ -60,6 +62,16 @@ declare const sessionSchema: z.ZodObject<{
     testBundleDigest: z.ZodString;
 }, z.core.$strip>;
 
+declare type TapAfterEachCallback<ExtraContext> = (context: TapHookContext<ExtraContext>) => void | Promise<void>;
+
+declare type TapAfterEachHook<ExtraContext = TapRstestFixtures> = (callback: TapAfterEachCallback<ExtraContext>, timeout?: number) => void;
+
+declare type TapBeforeEachCallback<ExtraContext> = (context: TapHookContext<ExtraContext>) => void | TapAfterEachCallback<ExtraContext> | Promise<void | TapAfterEachCallback<ExtraContext>>;
+
+declare type TapBeforeEachHook<ExtraContext = TapRstestFixtures> = (callback: TapBeforeEachCallback<ExtraContext>, timeout?: number) => void;
+
+declare type TapHookContext<ExtraContext> = TestContext & ExtraContext;
+
 export declare type TapMiniappTestControl = {
     /** Restore the run's declared fixture and permission scenario. */
     reset: () => Promise<void>;
@@ -85,47 +97,22 @@ export declare type TapRstestFixtures = {
     tap: TapMiniappTestFixture;
 };
 
+declare type TapRstestTest<ExtraContext = TapRstestFixtures> = Omit<PlaywrightTest<ExtraContext>, 'afterEach' | 'beforeEach' | 'extend'> & {
+    (description: string, callback?: (context: TapHookContext<ExtraContext>) => void | Promise<void>, timeout?: number): void;
+    (description: string, options: TestOptions, callback?: (context: TapHookContext<ExtraContext>) => void | Promise<void>): void;
+    afterEach: TapAfterEachHook<ExtraContext>;
+    beforeEach: TapBeforeEachHook<ExtraContext>;
+    extend: <FixturesContext extends Record<string, unknown> = Record<never, never>>(fixtures: PlaywrightFixtures<FixturesContext, ExtraContext>) => TapRstestTest<MergeContext<ExtraContext, FixturesContext>>;
+};
+
+/** Rstest's per-test context plus TAP's authorized browser and run fixtures. */
+export declare type TapTestContext = TestContext & TapRstestFixtures;
+
 /**
  * Rstest's Playwright test API with TAP-owned browser, page, iframe, and run
  * fixtures. The upstream runner still owns scheduling, assertions, hooks, and
  * reporting; TAP owns the privileged browser/session boundary.
  */
-export declare const test: PlaywrightTest<    {
-browser: Browser;
-context: BrowserContext;
-request: APIRequestContext;
-surface: FrameLocator;
-page: Page;
-tap: Readonly<Pick<{
-schemaVersion: 1;
-runId: string;
-workspaceId: string;
-channelId: string;
-packageId: string;
-installationId: string;
-mode: "surface" | "live-tap";
-dataScope: "fixture" | "selected-channel";
-permissionScenario: string;
-surfaceId: string;
-surfaceSelector: string;
-surfaceAssetOrigin: string;
-pageUrlPrefix: string;
-cdpEndpoint: string;
-cdpAuthorization: string;
-artifactDirectory: string;
-allowedNetworkOrigins: string[];
-credentialAliases: string[];
-sourceDigest: string;
-testBundleDigest: string;
-releaseDigest?: string | undefined;
-localGeneration?: number | undefined;
-}, "packageId" | "installationId" | "workspaceId" | "channelId" | "mode" | "runId" | "dataScope" | "permissionScenario" | "surfaceId" | "surfaceAssetOrigin" | "releaseDigest" | "localGeneration" | "sourceDigest" | "testBundleDigest"> & {
-readonly allowedNetworkOrigins: readonly string[];
-readonly credentialAliases: readonly string[];
-control: TapMiniappTestControl;
-}>;
-playwright: PlaywrightOptions;
-serve: PlaywrightServe;
-}>;
+export declare const test: TapRstestTest;
 
 export { }

package/dist/testing/rstest.js

@@ -161,7 +161,7 @@ const test = __rspack_external__rstest_playwright_5734ff29.test.extend({
                 path: (0, __rspack_external_node_path_806ed179.join)(traceDirectory, 'trace.zip')
             });
             const traceSummary = {
-                schemaVersion: 1,
+                schemaVersion: 2,
                 runId: session.runId,
                 taskId: task.id,
                 mode: session.mode,
@@ -171,11 +171,17 @@ const test = __rspack_external__rstest_playwright_5734ff29.test.extend({
                 sourceDigest: session.sourceDigest,
                 testBundleDigest: session.testBundleDigest,
                 tracePath: 'trace.zip',
-                redactions: [
+                traceRedacted: false,
+                traceSensitivity: 'raw-sensitive',
+                traceAccessScope: 'channel-only',
+                traceMayContain: [
                     'authorization headers',
                     'cookies',
                     'credential values',
-                    'network bodies'
+                    'network request and response bodies',
+                    'DOM snapshots',
+                    'screenshots',
+                    'test sources'
                 ]
             };
             await Promise.all([
@@ -191,7 +197,9 @@ const test = __rspack_external__rstest_playwright_5734ff29.test.extend({
                     `- Source digest: \`${session.sourceDigest}\``,
                     `- Test bundle digest: \`${session.testBundleDigest}\``,
                     '',
-                    'Open `trace.zip` from The AI Platform Test Lab for the DOM, screenshots, console, and network timeline. The final assertion outcome is authoritative in `report.json` and `report.md`.',
+                    '`trace.zip` is raw, sensitive, channel-only evidence. It is not redacted and may contain authorization headers, cookies, credential values, network bodies, DOM snapshots, screenshots, and test source.',
+                    '',
+                    'Open the trace from The AI Platform Test Lab for debugging. Do not publish it or attach it to specialist context. The final assertion outcome is authoritative in `report.json` and `report.md`.',
                     ''
                 ].join('\n'), 'utf8')
             ]);
@@ -214,6 +222,8 @@ const test = __rspack_external__rstest_playwright_5734ff29.test.extend({
         await use(fixtureMetadata(await loadSession(), page));
     }
 });
+const afterEach = __rspack_external__rstest_playwright_5734ff29.afterEach;
+const beforeEach = __rspack_external__rstest_playwright_5734ff29.beforeEach;
 function originOf(value) {
     try {
         const url = new URL(value);
@@ -233,9 +243,7 @@ const NON_NETWORK_PROTOCOLS = new Set([
     'file:'
 ]);
 var afterAll = __rspack_external__rstest_playwright_5734ff29.afterAll;
-var afterEach = __rspack_external__rstest_playwright_5734ff29.afterEach;
 var beforeAll = __rspack_external__rstest_playwright_5734ff29.beforeAll;
-var beforeEach = __rspack_external__rstest_playwright_5734ff29.beforeEach;
 var describe = __rspack_external__rstest_playwright_5734ff29.describe;
 var expect = __rspack_external__rstest_playwright_5734ff29.expect;
 export { afterAll, afterEach, beforeAll, beforeEach, describe, expect, parseTapMiniappTestSession, test };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theaiplatform/miniapp-sdk",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "TypeScript SDK for building, testing, and shipping portable miniapps on The AI Platform.",
   "type": "module",
   "engines": {