@series-inc/rundot-syncplay 5.23.0-beta.7

package/dist/certification.d.ts

@@ -0,0 +1,455 @@
+import { runPredictionCullingLab } from './prediction-culling.js';
+import { type ProtocolRollbackGame } from './protocol-lab.js';
+export type CertificationFixtureKind = 'event-callbacks' | 'bot-replacement' | 'ecs-lite' | 'external-physics-gate' | 'fixed-foundation' | 'genre-128' | 'kcc-lite' | 'navigation-grid' | 'netcode' | 'physics-builtin' | 'prediction-culling' | 'projectile-hitscan' | 'protocol-matrix' | 'reference-samples' | 'replay-node' | 'replay-browser' | 'schema-tooling' | 'static-analysis';
+export type CertificationRuntimeTarget = 'node' | 'chromium' | 'webkit';
+export type CertificationResult = 'pass' | 'fail' | 'skip';
+export type CertificationNetcodeShape = 'input-minimal' | 'moderate-state' | 'command-bursts';
+export type CertificationProtocolProfileId = 'delay-jitter' | 'loss-duplicate-reorder' | 'reconnect' | 'late-join' | 'asymmetric-latency' | 'input-delay' | 'bots' | 'command-bursts' | 'expected-desync';
+export interface CertificationBudgets {
+    readonly maxReplayBytes?: number;
+    readonly maxPackedInputBytesPerSecond?: number;
+    readonly maxRollbackDepth?: number;
+    readonly requireChecksumConvergence?: boolean;
+    readonly requireExpectedDesyncArtifacts?: boolean;
+    readonly maxElapsedMs?: number;
+    readonly maxHeapUsedBytes?: number;
+    readonly maxRssBytes?: number;
+}
+export interface CertificationManifest {
+    readonly manifestId?: string;
+    readonly artifactDir?: string;
+    readonly benchmarkProfile?: boolean;
+    readonly fixtures?: readonly CertificationFixture[];
+}
+export type CertificationFixtureTier = 'required' | 'optional' | 'experimental' | 'optional-browser' | 'optional-integration' | 'stress';
+export type CertificationFixture = CertificationBotReplacementFixture | CertificationEcsLiteFixture | CertificationExternalPhysicsGateFixture | CertificationEventCallbacksFixture | CertificationFixedFoundationFixture | CertificationGenre128Fixture | CertificationKccLiteFixture | CertificationNavigationGridFixture | CertificationNetcodeFixture | CertificationPhysicsBuiltinFixture | CertificationPredictionCullingFixture | CertificationProjectileHitscanFixture | CertificationProtocolMatrixFixture | CertificationReferenceSamplesFixture | CertificationReplayNodeFixture | CertificationSchemaToolingFixture | CertificationStaticAnalysisFixture | CertificationBrowserReplayFixture;
+export interface CertificationFixtureBase {
+    readonly fixtureId: string;
+    readonly kind: CertificationFixtureKind;
+    readonly tier?: CertificationFixtureTier;
+    readonly required?: boolean;
+    readonly runtimeTarget?: CertificationRuntimeTarget;
+    readonly players: number;
+    readonly frames: number;
+    readonly seed: number;
+    readonly budgets?: CertificationBudgets;
+}
+export interface CertificationNetcodeFixture extends CertificationFixtureBase {
+    readonly kind: 'netcode';
+    readonly runtimeTarget?: 'node';
+    readonly shape: CertificationNetcodeShape;
+    readonly hz?: number;
+    readonly rttMs?: number;
+    readonly jitterMs?: number;
+    readonly lossPercent?: number;
+    readonly duplicatePermille?: number;
+    readonly inputDelayFrames?: number;
+    readonly bundleSizeFrames?: number;
+    readonly eventTimelineLimit?: number;
+}
+export interface CertificationFixedFoundationFixture extends CertificationFixtureBase {
+    readonly kind: 'fixed-foundation';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationStaticAnalysisFixture extends CertificationFixtureBase {
+    readonly kind: 'static-analysis';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationSchemaToolingFixture extends CertificationFixtureBase {
+    readonly kind: 'schema-tooling';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationEventCallbacksFixture extends CertificationFixtureBase {
+    readonly kind: 'event-callbacks';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationPhysicsBuiltinFixture extends CertificationFixtureBase {
+    readonly kind: 'physics-builtin';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationPredictionCullingFixture extends CertificationFixtureBase {
+    readonly kind: 'prediction-culling';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationExternalPhysicsGateFixture extends CertificationFixtureBase {
+    readonly kind: 'external-physics-gate';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationEcsLiteFixture extends CertificationFixtureBase {
+    readonly kind: 'ecs-lite';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationKccLiteFixture extends CertificationFixtureBase {
+    readonly kind: 'kcc-lite';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationNavigationGridFixture extends CertificationFixtureBase {
+    readonly kind: 'navigation-grid';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationProjectileHitscanFixture extends CertificationFixtureBase {
+    readonly kind: 'projectile-hitscan';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationBotReplacementFixture extends CertificationFixtureBase {
+    readonly kind: 'bot-replacement';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationGenre128Fixture extends CertificationFixtureBase {
+    readonly kind: 'genre-128';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationProtocolMatrixFixture extends CertificationFixtureBase {
+    readonly kind: 'protocol-matrix';
+    readonly runtimeTarget?: 'node';
+    readonly profiles?: readonly CertificationProtocolProfileId[];
+}
+export interface CertificationReferenceSamplesFixture extends CertificationFixtureBase {
+    readonly kind: 'reference-samples';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationReplayNodeFixture extends CertificationFixtureBase {
+    readonly kind: 'replay-node';
+    readonly runtimeTarget?: 'node';
+}
+export interface CertificationBrowserReplayFixture extends CertificationFixtureBase {
+    readonly kind: 'replay-browser';
+    readonly runtimeTarget: 'chromium' | 'webkit';
+}
+export interface CertificationBudgetResult {
+    readonly name: keyof CertificationBudgets;
+    readonly limit?: number | boolean;
+    readonly actual?: number | boolean;
+    readonly gating: boolean;
+    readonly result: CertificationResult;
+}
+export interface CertificationFixtureReport {
+    readonly schemaVersion: 1;
+    readonly reportId: string;
+    readonly manifestId: string;
+    readonly fixtureId: string;
+    readonly kind: CertificationFixtureKind;
+    readonly tier: CertificationFixtureTier;
+    readonly required: boolean;
+    readonly runtimeTarget: CertificationRuntimeTarget;
+    readonly players: number;
+    readonly frames: number;
+    readonly seed: number;
+    readonly artifactPath: string;
+    readonly reportPath: string;
+    readonly metrics: CertificationMetrics;
+    readonly budgets: readonly CertificationBudgetResult[];
+    readonly failures: readonly string[];
+    readonly result: CertificationResult;
+}
+export type CertificationMetrics = CertificationBotReplacementMetrics | CertificationEcsLiteMetrics | CertificationExternalPhysicsGateMetrics | CertificationEventCallbacksMetrics | CertificationFixedFoundationMetrics | CertificationGenre128Metrics | CertificationKccLiteMetrics | CertificationNavigationGridMetrics | CertificationNetcodeMetrics | CertificationPhysicsBuiltinMetrics | CertificationPredictionCullingMetrics | CertificationProjectileHitscanMetrics | CertificationProtocolMatrixMetrics | CertificationReferenceSamplesMetrics | CertificationReplayNodeMetrics | CertificationSchemaToolingMetrics | CertificationStaticAnalysisMetrics | CertificationBrowserReplayMetrics;
+export interface CertificationNetcodeMetrics {
+    readonly shape: CertificationNetcodeShape;
+    readonly game: ProtocolRollbackGame;
+    readonly authorityChecksum: string;
+    readonly clientChecksum: string;
+    readonly checksumConverged: boolean;
+    readonly rollbacks: number;
+    readonly maxRollbackDepth: number;
+    readonly replayBytes: number;
+    readonly packedInputBytesPerTick: string;
+    readonly packedInputBytesPerSecond: string;
+    readonly inputBytesPerTick: string;
+    readonly checksumCostMsP95: string;
+    readonly elapsedMs: string;
+    readonly heapUsedBytes: number;
+    readonly rssBytes: number;
+}
+export interface CertificationFixedFoundationMetrics {
+    readonly goldenChecksum: string;
+    readonly checksumConverged: boolean;
+    readonly fixedMath: {
+        readonly a: number;
+        readonly b: number;
+        readonly add: number;
+        readonly sub: number;
+        readonly mul: number;
+        readonly div: number;
+        readonly clamp: number;
+    };
+    readonly vectors: {
+        readonly a: {
+            readonly x: number;
+            readonly y: number;
+        };
+        readonly b: {
+            readonly x: number;
+            readonly y: number;
+        };
+        readonly circlesIntersect: boolean;
+    };
+    readonly rng: readonly number[];
+    readonly timers: {
+        readonly milliseconds: number;
+        readonly frames: number;
+        readonly cooldown: {
+            readonly start: unknown;
+            readonly ticked: unknown;
+            readonly ready: unknown;
+        };
+        readonly due: readonly unknown[];
+        readonly pending: readonly unknown[];
+    };
+    readonly collections: {
+        readonly sortedKeys: readonly string[];
+        readonly stableEntries: readonly unknown[];
+        readonly stableMapEntries: readonly unknown[];
+        readonly stableSetValues: readonly string[];
+        readonly shuffle: readonly string[];
+    };
+}
+export interface CertificationReplayNodeMetrics {
+    readonly finalChecksum: string;
+    readonly replayBytes: number;
+    readonly packedInputBytesPerTick: string;
+    readonly packedInputBytesPerSecond: string;
+    readonly replayVerification: {
+        readonly frames: number;
+        readonly checksums: number;
+        readonly mismatches: number;
+        readonly finalChecksum: string;
+    };
+    readonly elapsedMs: string;
+    readonly heapUsedBytes: number;
+    readonly rssBytes: number;
+}
+export interface CertificationStaticAnalysisMetrics {
+    readonly parser: 'typescript-ast' | 'regex-scanner';
+    readonly dependencyPosture: 'package-internal-no-runtime-parser-dependency';
+    readonly diagnostics: readonly {
+        readonly ruleId: string;
+        readonly severity: string;
+        readonly suggestion: string;
+    }[];
+    readonly errors: number;
+    readonly warnings: number;
+    readonly alternativesReported: number;
+    readonly result: 'pass' | 'fail';
+}
+export interface CertificationSchemaToolingMetrics {
+    readonly artifactId: string;
+    readonly descriptorId: string;
+    readonly commandSchemaId: string;
+    readonly prototypeSchemaId: string;
+    readonly defaultInputFactoryPresent: boolean;
+    readonly canonicalInput: unknown;
+    readonly serializedStateBytes: number;
+    readonly frameDumpChecksum: string;
+    readonly frameDumpChecksumMatch: boolean;
+    readonly generatedTypesBytes: number;
+    readonly generatedHelpers: readonly string[];
+    readonly generatedRuntimeValidatorsPresent: boolean;
+    readonly checksumConverged: boolean;
+}
+export interface CertificationEventCallbacksMetrics {
+    readonly predictionStates: readonly string[];
+    readonly records: number;
+    readonly confirmed: number;
+    readonly canceled: number;
+    readonly verifiedOnly: number;
+    readonly lifecycleEvents: number;
+    readonly physicsEvents: number;
+    readonly eventChecksum: string;
+    readonly checksumConverged: boolean;
+}
+export interface CertificationPhysicsBuiltinMetrics {
+    readonly engine: string;
+    readonly uninterruptedChecksum: string;
+    readonly restoredChecksum: string;
+    readonly checksumConverged: boolean;
+    readonly collisionEventsStable: boolean;
+    readonly queryOrderStable: boolean;
+    readonly snapshotHashStable: boolean;
+    readonly collisionEvents: number;
+    readonly snapshotBytesP95: number;
+    readonly result: 'pass' | 'fail';
+}
+export interface CertificationPredictionCullingMetrics {
+    readonly passProfile: ReturnType<typeof runPredictionCullingLab>;
+    readonly expectedFailureProfile: ReturnType<typeof runPredictionCullingLab>;
+    readonly expectedFailureDetected: boolean;
+    readonly checksumConverged: boolean;
+}
+export interface CertificationExternalPhysicsGateMetrics {
+    readonly engine: 'rapier2d-compat';
+    readonly packageName: string;
+    readonly certified: boolean;
+    readonly checksummedGameplayAllowed: boolean;
+    readonly checksummedGameplayRejected: boolean;
+    readonly requiredGates: readonly string[];
+    readonly knownIssue: string;
+    readonly checksumConverged: boolean;
+}
+export interface CertificationEcsLiteMetrics {
+    readonly stableEntityIds: boolean;
+    readonly queryOrderStable: boolean;
+    readonly snapshotRestoreEqual: boolean;
+    readonly rollbackCreateDestroyEqual: boolean;
+    readonly singletonStateStable: boolean;
+    readonly componentLifecycleStable: boolean;
+    readonly checksumConverged: boolean;
+    readonly worldChecksum: string;
+}
+export interface CertificationKccLiteMetrics {
+    readonly groundedFrames: number;
+    readonly horizontalTravel: number;
+    readonly jumps: number;
+    readonly coyoteJumps: number;
+    readonly wallCollisions: number;
+    readonly leftWallCollisions: number;
+    readonly rightWallCollisions: number;
+    readonly rollbackChecksumEqual: boolean;
+    readonly queryOrderStable: boolean;
+    readonly finalChecksum: string;
+    readonly checksumConverged: boolean;
+}
+export interface CertificationNavigationGridMetrics {
+    readonly pathChecksum: string;
+    readonly pathsFound: number;
+    readonly unreachableDetected: boolean;
+    readonly queryOrderStable: boolean;
+    readonly avoidanceStable: boolean;
+    readonly rollbackChecksumEqual: boolean;
+    readonly checksumConverged: boolean;
+}
+export interface CertificationProjectileHitscanMetrics {
+    readonly raycastOrderStable: boolean;
+    readonly projectileHits: number;
+    readonly hitscanHits: number;
+    readonly cooldownBlocks: number;
+    readonly respawns: number;
+    readonly rollbackChecksumEqual: boolean;
+    readonly eventCancellationCount: number;
+    readonly finalChecksum: string;
+    readonly checksumConverged: boolean;
+}
+export interface CertificationBotReplacementMetrics {
+    readonly botInputFrames: number;
+    readonly disconnectedSlot: number;
+    readonly replacementChecksumEqual: boolean;
+    readonly authorityChecksum: string;
+    readonly replacementChecksum: string;
+    readonly checksumConverged: boolean;
+}
+export interface CertificationGenre128Metrics {
+    readonly players: number;
+    readonly frames: number;
+    readonly movementFrames: number;
+    readonly collisionOrHitResolutions: number;
+    readonly events: number;
+    readonly botInputFrames: number;
+    readonly authorityChecksum: string;
+    readonly clientChecksum: string;
+    readonly replayVerification: {
+        readonly mismatches: number;
+        readonly finalChecksum: string;
+    };
+    readonly protocolRollback: {
+        readonly rollbacks: number;
+        readonly maxRollbackDepth: number;
+    };
+    readonly checksumConverged: boolean;
+}
+export interface CertificationFrameModelMetrics {
+    readonly currentFrame: number;
+    readonly verifiedFrame: number;
+    readonly predictedFrame: number;
+    readonly previousPredictedFrame: number;
+    readonly rollbackCount: number;
+    readonly correctionCount: number;
+    readonly maxRollbackDepth: number;
+    readonly deterministicStats: {
+        readonly confirmations: number;
+        readonly deliveries: number;
+        readonly duplicates: number;
+        readonly lost: number;
+        readonly reorders: number;
+        readonly disconnectDrops: number;
+        readonly absentInputFrames: number;
+        readonly botInputFrames: number;
+        readonly commandProfiles: number;
+    };
+}
+export interface CertificationDesyncArtifact {
+    readonly firstDesyncFrame: number;
+    readonly localChecksum: string;
+    readonly authorityChecksum: string;
+    readonly inputDump: unknown;
+    readonly stateDump: unknown;
+    readonly schemaArtifactId: string;
+    readonly runtimeConfig: unknown;
+    readonly fieldDiff: readonly {
+        readonly path: string;
+        readonly local: unknown;
+        readonly authority: unknown;
+    }[];
+}
+export interface CertificationProtocolProfileMetrics {
+    readonly profileId: CertificationProtocolProfileId;
+    readonly channel: 'input' | 'command';
+    readonly authorityChecksum: string;
+    readonly clientChecksum: string;
+    readonly checksumConverged: boolean;
+    readonly rollbacks: number;
+    readonly corrections: number;
+    readonly maxRollbackDepth: number;
+    readonly confirmations: number;
+    readonly deliveries: number;
+    readonly duplicates: number;
+    readonly lost: number;
+    readonly disconnectDrops: number;
+    readonly absentInputFrames: number;
+    readonly botInputFrames: number;
+    readonly inputDelayFrames: number;
+    readonly reorders: number;
+    readonly result: 'pass' | 'desync' | 'fail';
+    readonly desyncArtifact?: CertificationDesyncArtifact;
+}
+export interface CertificationProtocolMatrixMetrics {
+    readonly schemaArtifactId: 'protocol-matrix/v1';
+    readonly profiles: readonly CertificationProtocolProfileMetrics[];
+    readonly frameModel: CertificationFrameModelMetrics;
+    readonly checksumConverged: boolean;
+    readonly expectedDesyncArtifacts: boolean;
+    readonly maxRollbackDepth: number;
+}
+export interface CertificationReferenceSampleMetrics {
+    readonly sampleId: string;
+    readonly players: number;
+    readonly frames: number;
+    readonly mechanics: readonly string[];
+    readonly finalChecksum: string;
+    readonly replayChecksum: string;
+    readonly rollbackChecksumEqual: boolean;
+    readonly events: number;
+}
+export interface CertificationReferenceSamplesMetrics {
+    readonly samples: readonly CertificationReferenceSampleMetrics[];
+    readonly sampleIds: readonly string[];
+    readonly checksumConverged: boolean;
+}
+export interface CertificationBrowserReplayMetrics {
+    readonly skippedReason: string;
+}
+export interface CertificationSuiteReport {
+    readonly schemaVersion: 1;
+    readonly reportId: string;
+    readonly manifestId: string;
+    readonly artifactDir: string;
+    readonly benchmarkProfile: boolean;
+    readonly fixtures: readonly CertificationFixtureReport[];
+    readonly failures: readonly string[];
+    readonly result: 'pass' | 'fail';
+}
+export interface CertificationSuiteRun {
+    readonly report: CertificationSuiteReport;
+    readonly fixtureReports: readonly CertificationFixtureReport[];
+}
+export declare function createDefaultCertificationManifest(): Required<CertificationManifest>;
+export declare function runCertificationSuite(manifestInput?: CertificationManifest): CertificationSuiteRun;
+export declare function stableCertificationJson(value: CertificationSuiteReport | CertificationFixtureReport): string;