@renderify/runtime 0.1.0

package/dist/runtime.d.mts

@@ -0,0 +1,226 @@
+import { RuntimeExecutionResult, RuntimeEvent, RuntimeNode, RuntimeSourceLanguage, RuntimeSourceModule, RuntimePlan, RuntimeDiagnostic, RuntimeExecutionContext, RuntimeStateSnapshot, RuntimeExecutionProfile, JsonValue } from '@renderify/ir';
+import { SecurityChecker, SecurityInitializationInput, SecurityCheckResult } from '@renderify/security';
+
+type RuntimeDependencyUsage = "import" | "component" | "source-import";
+interface RuntimeDependencyProbeStatus {
+    usage: RuntimeDependencyUsage;
+    specifier: string;
+    resolvedSpecifier?: string;
+    ok: boolean;
+    message?: string;
+}
+
+type RuntimeSourceSandboxMode$1 = "none" | "worker" | "iframe";
+
+interface RuntimeEventDispatchRequest {
+    planId: string;
+    event: RuntimeEvent;
+}
+interface InteractiveRenderTarget {
+    element: string | HTMLElement;
+    onRuntimeEvent?: (request: RuntimeEventDispatchRequest) => void | Promise<void>;
+}
+type RenderTarget = string | HTMLElement | InteractiveRenderTarget;
+interface UIRenderer {
+    render(result: RuntimeExecutionResult, target?: RenderTarget): Promise<string>;
+    renderNode(node: RuntimeNode): string;
+}
+declare class DefaultUIRenderer implements UIRenderer {
+    private readonly mountSessions;
+    render(result: RuntimeExecutionResult, target?: RenderTarget): Promise<string>;
+    private renderPreactArtifact;
+    renderNode(node: RuntimeNode): string;
+    private renderNodeWithBindings;
+    private renderNodeInternal;
+    private resolveRenderTarget;
+    private resolveTargetElement;
+    private patchMountPoint;
+    private sanitizeHtmlForMount;
+    private reconcileChildren;
+    private shouldUseKeyedReconcile;
+    private reconcileKeyedChildren;
+    private applyDesiredChildren;
+    private getNodeKey;
+    private areNodesCompatible;
+    private reconcileNode;
+    private reconcileAttributes;
+    private shouldSkipInteractivePropertySync;
+    private syncMountSession;
+    private syncDelegatedListeners;
+    private handleDelegatedRuntimeEvent;
+    private loadPreactRenderer;
+    private loadPreactRenderToString;
+    private stringifyTarget;
+}
+
+interface CompileOptions {
+    pretty?: boolean;
+}
+interface RuntimeModuleLoader {
+    load(specifier: string): Promise<unknown>;
+    unload?(specifier: string): Promise<void>;
+}
+interface RuntimeExecutionInput {
+    plan: RuntimePlan;
+    context?: RuntimeExecutionContext;
+    event?: RuntimeEvent;
+    stateOverride?: RuntimeStateSnapshot;
+    signal?: AbortSignal;
+}
+
+interface RuntimePlanProbeResult {
+    planId: string;
+    diagnostics: RuntimeDiagnostic[];
+    dependencies: RuntimeDependencyProbeStatus[];
+}
+interface RuntimeManager {
+    initialize(): Promise<void>;
+    terminate(): Promise<void>;
+    probePlan(plan: RuntimePlan): Promise<RuntimePlanProbeResult>;
+    executePlan(plan: RuntimePlan, context?: RuntimeExecutionContext, event?: RuntimeEvent, stateOverride?: RuntimeStateSnapshot, signal?: AbortSignal): Promise<RuntimeExecutionResult>;
+    execute(input: RuntimeExecutionInput): Promise<RuntimeExecutionResult>;
+    compile(plan: RuntimePlan, options?: CompileOptions): Promise<string>;
+    getPlanState(planId: string): RuntimeStateSnapshot | undefined;
+    setPlanState(planId: string, snapshot: RuntimeStateSnapshot): void;
+    clearPlanState(planId: string): void;
+}
+interface RuntimeManagerOptions {
+    moduleLoader?: RuntimeModuleLoader;
+    sourceTranspiler?: RuntimeSourceTranspiler;
+    defaultMaxImports?: number;
+    defaultMaxComponentInvocations?: number;
+    defaultMaxExecutionMs?: number;
+    defaultExecutionProfile?: RuntimeExecutionProfile;
+    supportedPlanSpecVersions?: string[];
+    enforceModuleManifest?: boolean;
+    allowIsolationFallback?: boolean;
+    browserSourceSandboxMode?: RuntimeSourceSandboxMode;
+    browserSourceSandboxTimeoutMs?: number;
+    browserSourceSandboxFailClosed?: boolean;
+    enableDependencyPreflight?: boolean;
+    failOnDependencyPreflightError?: boolean;
+    remoteFetchTimeoutMs?: number;
+    remoteFetchRetries?: number;
+    remoteFetchBackoffMs?: number;
+    remoteFallbackCdnBases?: string[];
+}
+interface RuntimeSourceTranspileInput {
+    code: string;
+    language: RuntimeSourceLanguage;
+    filename?: string;
+    runtime?: RuntimeSourceModule["runtime"];
+}
+interface RuntimeSourceTranspiler {
+    transpile(input: RuntimeSourceTranspileInput): Promise<string>;
+}
+interface RuntimeEmbedRenderOptions {
+    target?: RenderTarget;
+    context?: RuntimeExecutionContext;
+    signal?: AbortSignal;
+    runtime?: RuntimeManager;
+    runtimeOptions?: RuntimeManagerOptions;
+    security?: SecurityChecker;
+    securityInitialization?: SecurityInitializationInput;
+    ui?: UIRenderer;
+    autoInitializeRuntime?: boolean;
+    autoTerminateRuntime?: boolean;
+    serializeTargetRenders?: boolean;
+}
+interface RuntimeEmbedRenderResult {
+    html: string;
+    execution: RuntimeExecutionResult;
+    security: SecurityCheckResult;
+    runtime: RuntimeManager;
+}
+declare class RuntimeSecurityViolationError extends Error {
+    readonly result: SecurityCheckResult;
+    constructor(result: SecurityCheckResult);
+}
+type RuntimeSourceSandboxMode = RuntimeSourceSandboxMode$1;
+
+declare function renderPlanInBrowser(plan: RuntimePlan, options?: RuntimeEmbedRenderOptions): Promise<RuntimeEmbedRenderResult>;
+
+interface JspmModuleLoaderOptions {
+    cdnBaseUrl?: string;
+    importMap?: Record<string, string>;
+}
+declare class JspmModuleLoader implements RuntimeModuleLoader {
+    private readonly cdnBaseUrl;
+    private readonly importMap;
+    private readonly cache;
+    constructor(options?: JspmModuleLoaderOptions);
+    load(specifier: string): Promise<unknown>;
+    unload(specifier: string): Promise<void>;
+    resolveSpecifier(specifier: string): string;
+    private importWithBestEffort;
+    private isUrl;
+    private hasUnsupportedScheme;
+    private isBareNpmSpecifier;
+    private isNodeBuiltinSpecifier;
+    private extractTopLevelPackageName;
+    private resolveNpmSpecifier;
+    private normalizeCdnBaseUrl;
+}
+
+type RuntimeComponentFactory = (props: Record<string, JsonValue>, context: RuntimeExecutionContext, children: RuntimeNode[]) => Promise<RuntimeNode | string> | RuntimeNode | string;
+
+declare class DefaultRuntimeManager implements RuntimeManager {
+    private readonly moduleLoader?;
+    private readonly sourceTranspiler;
+    private readonly states;
+    private readonly defaultMaxImports;
+    private readonly defaultMaxComponentInvocations;
+    private readonly defaultMaxExecutionMs;
+    private readonly defaultExecutionProfile;
+    private readonly supportedPlanSpecVersions;
+    private readonly enforceModuleManifest;
+    private readonly allowIsolationFallback;
+    private readonly browserSourceSandboxMode;
+    private readonly browserSourceSandboxTimeoutMs;
+    private readonly browserSourceSandboxFailClosed;
+    private readonly enableDependencyPreflight;
+    private readonly failOnDependencyPreflightError;
+    private readonly remoteFetchTimeoutMs;
+    private readonly remoteFetchRetries;
+    private readonly remoteFetchBackoffMs;
+    private readonly remoteFallbackCdnBases;
+    private readonly browserModuleUrlCache;
+    private readonly browserModuleInflight;
+    private readonly browserBlobUrls;
+    private initialized;
+    constructor(options?: RuntimeManagerOptions);
+    initialize(): Promise<void>;
+    terminate(): Promise<void>;
+    execute(input: RuntimeExecutionInput): Promise<RuntimeExecutionResult>;
+    probePlan(plan: RuntimePlan): Promise<RuntimePlanProbeResult>;
+    executePlan(plan: RuntimePlan, context?: RuntimeExecutionContext, event?: RuntimeEvent, stateOverride?: RuntimeStateSnapshot, signal?: AbortSignal): Promise<RuntimeExecutionResult>;
+    compile(plan: RuntimePlan, options?: CompileOptions): Promise<string>;
+    getPlanState(planId: string): RuntimeStateSnapshot | undefined;
+    setPlanState(planId: string, snapshot: RuntimeStateSnapshot): void;
+    clearPlanState(planId: string): void;
+    private resolveState;
+    private preflightPlanDependencies;
+    private resolveSourceRoot;
+    private resolveRuntimeSourceSpecifier;
+    private resolveSourceImportLoaderCandidate;
+    private resolveRuntimeSpecifier;
+    private createSourceModuleLoader;
+    private materializeFetchedModuleSource;
+    private toConfiguredFallbackUrl;
+    private toEsmFallbackUrl;
+    private rewriteImportsAsync;
+    private createBrowserBlobModuleUrl;
+    private revokeBrowserBlobUrls;
+    private normalizeSourceOutput;
+    private resolveNode;
+    private ensureInitialized;
+    private errorToMessage;
+}
+
+declare class BabelRuntimeSourceTranspiler implements RuntimeSourceTranspiler {
+    transpile(input: RuntimeSourceTranspileInput): Promise<string>;
+    private resolveBabel;
+    static mergeRuntimeHelpers(source: RuntimeSourceTranspileInput["code"], runtime: RuntimeSourceTranspileInput["runtime"]): string;
+}
+
+export { BabelRuntimeSourceTranspiler, type CompileOptions, DefaultRuntimeManager, DefaultUIRenderer, type InteractiveRenderTarget, JspmModuleLoader, type JspmModuleLoaderOptions, type RenderTarget, type RuntimeComponentFactory, type RuntimeDependencyProbeStatus, type RuntimeDependencyUsage, type RuntimeEmbedRenderOptions, type RuntimeEmbedRenderResult, type RuntimeEventDispatchRequest, type RuntimeExecutionInput, type RuntimeManager, type RuntimeManagerOptions, type RuntimeModuleLoader, type RuntimePlanProbeResult, RuntimeSecurityViolationError, type RuntimeSourceSandboxMode, type RuntimeSourceTranspileInput, type RuntimeSourceTranspiler, type UIRenderer, renderPlanInBrowser };

package/dist/runtime.d.ts

@@ -0,0 +1,226 @@
+import { RuntimeExecutionResult, RuntimeEvent, RuntimeNode, RuntimeSourceLanguage, RuntimeSourceModule, RuntimePlan, RuntimeDiagnostic, RuntimeExecutionContext, RuntimeStateSnapshot, RuntimeExecutionProfile, JsonValue } from '@renderify/ir';
+import { SecurityChecker, SecurityInitializationInput, SecurityCheckResult } from '@renderify/security';
+
+type RuntimeDependencyUsage = "import" | "component" | "source-import";
+interface RuntimeDependencyProbeStatus {
+    usage: RuntimeDependencyUsage;
+    specifier: string;
+    resolvedSpecifier?: string;
+    ok: boolean;
+    message?: string;
+}
+
+type RuntimeSourceSandboxMode$1 = "none" | "worker" | "iframe";
+
+interface RuntimeEventDispatchRequest {
+    planId: string;
+    event: RuntimeEvent;
+}
+interface InteractiveRenderTarget {
+    element: string | HTMLElement;
+    onRuntimeEvent?: (request: RuntimeEventDispatchRequest) => void | Promise<void>;
+}
+type RenderTarget = string | HTMLElement | InteractiveRenderTarget;
+interface UIRenderer {
+    render(result: RuntimeExecutionResult, target?: RenderTarget): Promise<string>;
+    renderNode(node: RuntimeNode): string;
+}
+declare class DefaultUIRenderer implements UIRenderer {
+    private readonly mountSessions;
+    render(result: RuntimeExecutionResult, target?: RenderTarget): Promise<string>;
+    private renderPreactArtifact;
+    renderNode(node: RuntimeNode): string;
+    private renderNodeWithBindings;
+    private renderNodeInternal;
+    private resolveRenderTarget;
+    private resolveTargetElement;
+    private patchMountPoint;
+    private sanitizeHtmlForMount;
+    private reconcileChildren;
+    private shouldUseKeyedReconcile;
+    private reconcileKeyedChildren;
+    private applyDesiredChildren;
+    private getNodeKey;
+    private areNodesCompatible;
+    private reconcileNode;
+    private reconcileAttributes;
+    private shouldSkipInteractivePropertySync;
+    private syncMountSession;
+    private syncDelegatedListeners;
+    private handleDelegatedRuntimeEvent;
+    private loadPreactRenderer;
+    private loadPreactRenderToString;
+    private stringifyTarget;
+}
+
+interface CompileOptions {
+    pretty?: boolean;
+}
+interface RuntimeModuleLoader {
+    load(specifier: string): Promise<unknown>;
+    unload?(specifier: string): Promise<void>;
+}
+interface RuntimeExecutionInput {
+    plan: RuntimePlan;
+    context?: RuntimeExecutionContext;
+    event?: RuntimeEvent;
+    stateOverride?: RuntimeStateSnapshot;
+    signal?: AbortSignal;
+}
+
+interface RuntimePlanProbeResult {
+    planId: string;
+    diagnostics: RuntimeDiagnostic[];
+    dependencies: RuntimeDependencyProbeStatus[];
+}
+interface RuntimeManager {
+    initialize(): Promise<void>;
+    terminate(): Promise<void>;
+    probePlan(plan: RuntimePlan): Promise<RuntimePlanProbeResult>;
+    executePlan(plan: RuntimePlan, context?: RuntimeExecutionContext, event?: RuntimeEvent, stateOverride?: RuntimeStateSnapshot, signal?: AbortSignal): Promise<RuntimeExecutionResult>;
+    execute(input: RuntimeExecutionInput): Promise<RuntimeExecutionResult>;
+    compile(plan: RuntimePlan, options?: CompileOptions): Promise<string>;
+    getPlanState(planId: string): RuntimeStateSnapshot | undefined;
+    setPlanState(planId: string, snapshot: RuntimeStateSnapshot): void;
+    clearPlanState(planId: string): void;
+}
+interface RuntimeManagerOptions {
+    moduleLoader?: RuntimeModuleLoader;
+    sourceTranspiler?: RuntimeSourceTranspiler;
+    defaultMaxImports?: number;
+    defaultMaxComponentInvocations?: number;
+    defaultMaxExecutionMs?: number;
+    defaultExecutionProfile?: RuntimeExecutionProfile;
+    supportedPlanSpecVersions?: string[];
+    enforceModuleManifest?: boolean;
+    allowIsolationFallback?: boolean;
+    browserSourceSandboxMode?: RuntimeSourceSandboxMode;
+    browserSourceSandboxTimeoutMs?: number;
+    browserSourceSandboxFailClosed?: boolean;
+    enableDependencyPreflight?: boolean;
+    failOnDependencyPreflightError?: boolean;
+    remoteFetchTimeoutMs?: number;
+    remoteFetchRetries?: number;
+    remoteFetchBackoffMs?: number;
+    remoteFallbackCdnBases?: string[];
+}
+interface RuntimeSourceTranspileInput {
+    code: string;
+    language: RuntimeSourceLanguage;
+    filename?: string;
+    runtime?: RuntimeSourceModule["runtime"];
+}
+interface RuntimeSourceTranspiler {
+    transpile(input: RuntimeSourceTranspileInput): Promise<string>;
+}
+interface RuntimeEmbedRenderOptions {
+    target?: RenderTarget;
+    context?: RuntimeExecutionContext;
+    signal?: AbortSignal;
+    runtime?: RuntimeManager;
+    runtimeOptions?: RuntimeManagerOptions;
+    security?: SecurityChecker;
+    securityInitialization?: SecurityInitializationInput;
+    ui?: UIRenderer;
+    autoInitializeRuntime?: boolean;
+    autoTerminateRuntime?: boolean;
+    serializeTargetRenders?: boolean;
+}
+interface RuntimeEmbedRenderResult {
+    html: string;
+    execution: RuntimeExecutionResult;
+    security: SecurityCheckResult;
+    runtime: RuntimeManager;
+}
+declare class RuntimeSecurityViolationError extends Error {
+    readonly result: SecurityCheckResult;
+    constructor(result: SecurityCheckResult);
+}
+type RuntimeSourceSandboxMode = RuntimeSourceSandboxMode$1;
+
+declare function renderPlanInBrowser(plan: RuntimePlan, options?: RuntimeEmbedRenderOptions): Promise<RuntimeEmbedRenderResult>;
+
+interface JspmModuleLoaderOptions {
+    cdnBaseUrl?: string;
+    importMap?: Record<string, string>;
+}
+declare class JspmModuleLoader implements RuntimeModuleLoader {
+    private readonly cdnBaseUrl;
+    private readonly importMap;
+    private readonly cache;
+    constructor(options?: JspmModuleLoaderOptions);
+    load(specifier: string): Promise<unknown>;
+    unload(specifier: string): Promise<void>;
+    resolveSpecifier(specifier: string): string;
+    private importWithBestEffort;
+    private isUrl;
+    private hasUnsupportedScheme;
+    private isBareNpmSpecifier;
+    private isNodeBuiltinSpecifier;
+    private extractTopLevelPackageName;
+    private resolveNpmSpecifier;
+    private normalizeCdnBaseUrl;
+}
+
+type RuntimeComponentFactory = (props: Record<string, JsonValue>, context: RuntimeExecutionContext, children: RuntimeNode[]) => Promise<RuntimeNode | string> | RuntimeNode | string;
+
+declare class DefaultRuntimeManager implements RuntimeManager {
+    private readonly moduleLoader?;
+    private readonly sourceTranspiler;
+    private readonly states;
+    private readonly defaultMaxImports;
+    private readonly defaultMaxComponentInvocations;
+    private readonly defaultMaxExecutionMs;
+    private readonly defaultExecutionProfile;
+    private readonly supportedPlanSpecVersions;
+    private readonly enforceModuleManifest;
+    private readonly allowIsolationFallback;
+    private readonly browserSourceSandboxMode;
+    private readonly browserSourceSandboxTimeoutMs;
+    private readonly browserSourceSandboxFailClosed;
+    private readonly enableDependencyPreflight;
+    private readonly failOnDependencyPreflightError;
+    private readonly remoteFetchTimeoutMs;
+    private readonly remoteFetchRetries;
+    private readonly remoteFetchBackoffMs;
+    private readonly remoteFallbackCdnBases;
+    private readonly browserModuleUrlCache;
+    private readonly browserModuleInflight;
+    private readonly browserBlobUrls;
+    private initialized;
+    constructor(options?: RuntimeManagerOptions);
+    initialize(): Promise<void>;
+    terminate(): Promise<void>;
+    execute(input: RuntimeExecutionInput): Promise<RuntimeExecutionResult>;
+    probePlan(plan: RuntimePlan): Promise<RuntimePlanProbeResult>;
+    executePlan(plan: RuntimePlan, context?: RuntimeExecutionContext, event?: RuntimeEvent, stateOverride?: RuntimeStateSnapshot, signal?: AbortSignal): Promise<RuntimeExecutionResult>;
+    compile(plan: RuntimePlan, options?: CompileOptions): Promise<string>;
+    getPlanState(planId: string): RuntimeStateSnapshot | undefined;
+    setPlanState(planId: string, snapshot: RuntimeStateSnapshot): void;
+    clearPlanState(planId: string): void;
+    private resolveState;
+    private preflightPlanDependencies;
+    private resolveSourceRoot;
+    private resolveRuntimeSourceSpecifier;
+    private resolveSourceImportLoaderCandidate;
+    private resolveRuntimeSpecifier;
+    private createSourceModuleLoader;
+    private materializeFetchedModuleSource;
+    private toConfiguredFallbackUrl;
+    private toEsmFallbackUrl;
+    private rewriteImportsAsync;
+    private createBrowserBlobModuleUrl;
+    private revokeBrowserBlobUrls;
+    private normalizeSourceOutput;
+    private resolveNode;
+    private ensureInitialized;
+    private errorToMessage;
+}
+
+declare class BabelRuntimeSourceTranspiler implements RuntimeSourceTranspiler {
+    transpile(input: RuntimeSourceTranspileInput): Promise<string>;
+    private resolveBabel;
+    static mergeRuntimeHelpers(source: RuntimeSourceTranspileInput["code"], runtime: RuntimeSourceTranspileInput["runtime"]): string;
+}
+
+export { BabelRuntimeSourceTranspiler, type CompileOptions, DefaultRuntimeManager, DefaultUIRenderer, type InteractiveRenderTarget, JspmModuleLoader, type JspmModuleLoaderOptions, type RenderTarget, type RuntimeComponentFactory, type RuntimeDependencyProbeStatus, type RuntimeDependencyUsage, type RuntimeEmbedRenderOptions, type RuntimeEmbedRenderResult, type RuntimeEventDispatchRequest, type RuntimeExecutionInput, type RuntimeManager, type RuntimeManagerOptions, type RuntimeModuleLoader, type RuntimePlanProbeResult, RuntimeSecurityViolationError, type RuntimeSourceSandboxMode, type RuntimeSourceTranspileInput, type RuntimeSourceTranspiler, type UIRenderer, renderPlanInBrowser };