@dyno-cloud/schema 0.0.0-stage → 0.1.2

package/ts/Release.ts

@@ -0,0 +1,12 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Labels the caller gives. Outside the hash, so two callers who name a release differently
+ * still get the same hash.
+ */
+export type Release = { game: string | null, version: string | null, 
+/**
+ * The game's id on the dyno site, a UUID: from `--game-id`, or from the `dyno.toml` entry
+ * for the build. Null when neither gives one.
+ */
+game_id?: string | null, };

package/ts/ResultRef.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Status } from "./Status";
+
+/**
+ * One side of a comparison.
+ */
+export type ResultRef = { result_hash: string, 
+/**
+ * Whether `result_hash` matches the result's deterministic part.
+ */
+hash_matches: boolean, build_id: string | null, status: Status, 
+/**
+ * The dyno version that made the result.
+ */
+tool: string, };

package/ts/RuleId.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Every rule that Phases 1 and 2 name. Field reports reuse these ids.
+ */
+export type RuleId = "audio.pcm_over_budget" | "audio.stereo" | "audio.silence_share" | "render.antialias_or_resolution" | "textures.over_budget" | "files.duplicate" | "files.unreferenced" | "contract.ready_in_time" | "contract.no_audio_before_active" | "contract.throttled_while_inactive" | "diagnostic.alloc_before_active";

package/ts/RunCoverage.ts

@@ -0,0 +1,8 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Whether the browser and device runs that a check asked for gave every required measure.
+ *
+ * It sits in the deterministic part, so the status and exit code never read the run part.
+ */
+export type RunCoverage = "not_requested" | "complete" | "missing" | "invalid";

package/ts/RunInfo.ts

@@ -0,0 +1,50 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { BuildLink } from "./BuildLink";
+import type { DriverInfo } from "./DriverInfo";
+import type { Environment } from "./Environment";
+import type { Finding } from "./Finding";
+import type { Machine } from "./Machine";
+import type { Measure } from "./Measure";
+import type { Release } from "./Release";
+import type { Target } from "./Target";
+import type { TierReport } from "./TierReport";
+import type { ToolBuild } from "./ToolBuild";
+
+/**
+ * What differs between machines and runs. The hash excludes it.
+ *
+ * A field that a later dyno added is missing from a result that an earlier one wrote, so a
+ * reader treats a missing or null field as not known.
+ */
+export type RunInfo = { 
+/**
+ * A UUID v4 that dyno makes when the check starts. Each game of a games file gets its own,
+ * and an upload sends it again when it is retried, so the site keeps one run.
+ */
+run_id?: string | null, 
+/**
+ * How the run's evidence ties to the build.
+ */
+build_link?: BuildLink | null, 
+/**
+ * What actually ran: the browser, the OS and the device. Null when there was no browser or
+ * device run, or when the run failed before the browser said what it was.
+ */
+environment?: Environment | null, 
+/**
+ * RFC 3339 UTC time the check started.
+ */
+started_at: string, duration_ms: number, machine: Machine, tool_build: ToolBuild, target: Target, release: Release, 
+/**
+ * The browser driver. Null when there was no browser run.
+ */
+driver: DriverInfo | null, 
+/**
+ * Browser, device and model measures. Sorted by id.
+ */
+measures: Array<Measure>, 
+/**
+ * Lab rule findings, such as the host contract checks. Sorted by rule id, then by the
+ * finding's canonical JSON.
+ */
+findings: Array<Finding>, tier: TierReport, };

package/ts/RunMark.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The steps of a run.
+ */
+export type RunMark = "navigated" | "idle" | "activated" | "deactivated" | "frame_document";

package/ts/RunRequest.ts

@@ -0,0 +1,24 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { HostProfile } from "./HostProfile";
+import type { Scenario } from "./Scenario";
+
+/**
+ * What dyno asks a driver to run.
+ */
+export type RunRequest = { protocol_version: number, 
+/**
+ * The full launch URL, query string included. It never goes into a result.
+ */
+launch_url: string, host_profile: HostProfile, scenario: Scenario, 
+/**
+ * Demo spins to play after load (Phase 2). Null for a load-and-idle run.
+ */
+spins: number | null, 
+/**
+ * The game frame is idle after this long with no new requests.
+ */
+idle_after_ms: number, 
+/**
+ * The driver stops and sends an error after this long.
+ */
+timeout_ms: number, };

package/ts/Scenario.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The harness scenario of a browser run.
+ */
+export type Scenario = "alone" | "aged" | "overlap";

package/ts/Scope.ts

@@ -0,0 +1,12 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Covers } from "./Covers";
+
+/**
+ * What a value covers, and what it does not.
+ */
+export type Scope = { covers: Covers, 
+/**
+ * Plain-English parts the value leaves out, such as "a.ogg: did not decode". Sorted. Any
+ * entry makes the value partial, so a budget reads it as a floor.
+ */
+not_covered: Array<string>, };

package/ts/Severity.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The verdict a flag gives when it is on.
+ */
+export type Severity = "allow" | "warn" | "fail";

package/ts/Shard.ts

@@ -0,0 +1,17 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Shard I of N, written "I/N" with I from 1 to N. Game k in id order, counting from 0, falls
+ * in shard (k mod N) + 1.
+ *
+ * `Shard::new` and deserializing both check that 1 <= I <= N, so every shard is valid.
+ */
+export type Shard = { 
+/**
+ * I, from 1 to N.
+ */
+index: number, 
+/**
+ * N, the number of shards.
+ */
+count: number, };

package/ts/Source.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Where a value comes from.
+ */
+export type Source = "static" | "lab" | "device" | "model" | "field";

package/ts/SourceKind.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * What a texture upload with no source path held. Facts only: an allocation
+ * with no pixels is often a render target, but the probe does not see what fills it.
+ */
+export type SourceKind = "empty" | "canvas";

package/ts/Statistic.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Which reading of a quantity a measure is: over the build's files, by idle, at idle or at its
+ * peak, for example.
+ */
+export type Statistic = "all_files" | "all_files_at48k" | "all_files_at24k" | "largest" | "since_navigation" | "by_idle" | "to_playable" | "at_idle" | "while_inactive" | "peak" | "median_peak_over_baseline" | "modelled_active" | "modelled_inactive" | "during_spins" | "peak_during_spins" | "growth_per100_spins" | "peak_during_bonus" | "of_runs";

package/ts/Status.ts

@@ -0,0 +1,9 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The overall status of a result. The exit code comes from it alone.
+ *
+ * When several statuses apply, the worst wins. From worst to best: fail, invalid, incomplete,
+ * warn, pass. The variants below are not declared in that order.
+ */
+export type Status = "pass" | "warn" | "fail" | "incomplete" | "invalid";

package/ts/Target.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The target as given on the command line.
+ */
+export type Target = { 
+/**
+ * The build folder or .zip path as given. Null when none.
+ */
+build: string | null, 
+/**
+ * The launch URL without its user info, query string or fragment, which can carry passwords
+ * and session ids. Null when none.
+ */
+launch_url: string | null, };

package/ts/Tier.ts

@@ -0,0 +1,9 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * A provisional tier. The worst gate sets it.
+ *
+ * A line is a modelled footprint limit on the reference iPhone. The proposed lines are 500 MB
+ * while active and 250 MB while inactive. The phone calibration sets them.
+ */
+export type Tier = "playable" | "blocked" | "preloadable";

package/ts/TierReport.ts

@@ -0,0 +1,26 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { DeviceClass } from "./DeviceClass";
+import type { MeasureStatus } from "./MeasureStatus";
+import type { Tier } from "./Tier";
+
+/**
+ * The provisional Reels tier. Report-only: it decides nothing in Phase 1.
+ */
+export type TierReport = { 
+/**
+ * Estimated once the model is calibrated. Unsupported with no launch URL, because the
+ * total needs a JS heap reading.
+ */
+status: MeasureStatus, 
+/**
+ * Null unless the status is estimated.
+ */
+tier: Tier | null, device_class: DeviceClass, 
+/**
+ * The plan phase that builds the tier.
+ */
+phase: number, 
+/**
+ * Why there is no tier. Null otherwise.
+ */
+reason: string | null, };

package/ts/ToolBuild.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The dyno binary that made the result.
+ */
+export type ToolBuild = { version: string, 
+/**
+ * The commit the binary was built from. Null for a local build.
+ */
+git_sha: string | null, 
+/**
+ * "debug" or "release".
+ */
+profile: string, };

package/ts/Uncertainty.ts

@@ -0,0 +1,19 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { UncertaintyKind } from "./UncertaintyKind";
+
+/**
+ * How close a value is to the truth.
+ */
+export type Uncertainty = { kind: UncertaintyKind, 
+/**
+ * The lowest likely value, in the measure's unit.
+ */
+low: number | null, 
+/**
+ * The highest likely value, in the measure's unit.
+ */
+high: number | null, 
+/**
+ * A short plain-English note, such as "0 to 23% below the decoded size".
+ */
+note: string | null, };

package/ts/UncertaintyKind.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The kind of uncertainty.
+ */
+export type UncertaintyKind = "exact" | "floor" | "range" | "model_error" | "unknown";

package/ts/UncleanExit.ts

@@ -0,0 +1,16 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { LiveFrame } from "./LiveFrame";
+import type { ProfileRef } from "./ProfileRef";
+
+/**
+ * An observed unclean exit: the last page died with game frames live. Never sampled.
+ */
+export type UncleanExit = { schema_version: number, 
+/**
+ * The host profile, such as reels version 0.
+ */
+host_profile: ProfileRef, 
+/**
+ * The game frames that were live when the page died.
+ */
+frames: Array<LiveFrame>, };

package/ts/Unit.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The unit of a value. Sizes are always integer bytes. Only a change in size can be negative.
+ */
+export type Unit = "bytes" | "bytes_change" | "ms" | "count" | "hertz" | "basis_points" | "milli" | "flag" | "text";

package/ts/Verdict.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The outcome of one budget, rule or doctor check.
+ */
+export type Verdict = "pass" | "warn" | "fail" | "incomplete";

package/ts/VerdictChange.ts

@@ -0,0 +1,12 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { BudgetId } from "./BudgetId";
+import type { Verdict } from "./Verdict";
+
+/**
+ * One budget verdict that changed.
+ */
+export type VerdictChange = { budget: BudgetId, 
+/**
+ * Null when the side has no verdict for this budget.
+ */
+base: Verdict | null, head: Verdict | null, };

package/ts/Versions.ts

@@ -0,0 +1,22 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The versions of everything that shapes a result.
+ */
+export type Versions = { 
+/**
+ * The schema version. `CheckResult::new` sets it.
+ */
+schema: number, 
+/**
+ * The dyno version, such as "0.1.0".
+ */
+tool: string, 
+/**
+ * The version of the budget and rule logic in `dyno-score`.
+ */
+scoring: number, 
+/**
+ * The fitted memory model's version. Null until the phone calibration sets one.
+ */
+model: string | null, };

package/ts/Viewport.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * A size in CSS pixels.
+ */
+export type Viewport = { width: number, height: number, };

package/ts/index.ts

@@ -0,0 +1,89 @@
+// Generated by dyno-schema. Do not edit this file manually.
+export type * from "./AssetChange";
+export type * from "./AssetChangeKind";
+export type * from "./AudioState";
+export type * from "./BrowserEngine";
+export type * from "./BudgetId";
+export type * from "./BudgetLimit";
+export type * from "./BudgetRef";
+export type * from "./BudgetVerdict";
+export type * from "./BuildLink";
+export type * from "./BuildManifest";
+export type * from "./CatalogueEntry";
+export type * from "./CatalogueResult";
+export type * from "./CheckResult";
+export type * from "./CompareDeterministic";
+export type * from "./CompareResult";
+export type * from "./CompareRun";
+export type * from "./ContextKind";
+export type * from "./Covers";
+export type * from "./Deterministic";
+export type * from "./DeviceClass";
+export type * from "./DeviceEntry";
+export type * from "./DeviceKind";
+export type * from "./DoctorCheck";
+export type * from "./DoctorCheckId";
+export type * from "./DoctorReport";
+export type * from "./DriverInfo";
+export type * from "./DriverMessage";
+export type * from "./Environment";
+export type * from "./EnvironmentBrowser";
+export type * from "./EnvironmentDevice";
+export type * from "./EnvironmentOs";
+export type * from "./Evidence";
+export type * from "./ExposureCheckpoint";
+export type * from "./ExposureSample";
+export type * from "./FileKind";
+export type * from "./Finding";
+export type * from "./Fix";
+export type * from "./FixAction";
+export type * from "./FrameState";
+export type * from "./GameHookKind";
+export type * from "./HostProfile";
+export type * from "./Inputs";
+export type * from "./Library";
+export type * from "./LibraryBucket";
+export type * from "./LiveFrame";
+export type * from "./Machine";
+export type * from "./ManifestFile";
+export type * from "./Measure";
+export type * from "./MeasureChange";
+export type * from "./MeasureEntry";
+export type * from "./MeasureId";
+export type * from "./MeasureItem";
+export type * from "./MeasureStatus";
+export type * from "./MeasureValue";
+export type * from "./MessageDirection";
+export type * from "./Method";
+export type * from "./OsName";
+export type * from "./ProbeEvent";
+export type * from "./ProfileRef";
+export type * from "./Quantity";
+export type * from "./RelPath";
+export type * from "./Release";
+export type * from "./ResultRef";
+export type * from "./RuleId";
+export type * from "./RunCoverage";
+export type * from "./RunInfo";
+export type * from "./RunMark";
+export type * from "./RunRequest";
+export type * from "./Scenario";
+export type * from "./Scope";
+export type * from "./Severity";
+export type * from "./Shard";
+export type * from "./Source";
+export type * from "./SourceKind";
+export type * from "./Statistic";
+export type * from "./Status";
+export type * from "./Target";
+export type * from "./Tier";
+export type * from "./TierReport";
+export type * from "./ToolBuild";
+export type * from "./Uncertainty";
+export type * from "./UncertaintyKind";
+export type * from "./UncleanExit";
+export type * from "./Unit";
+export type * from "./Verdict";
+export type * from "./VerdictChange";
+export type * from "./Versions";
+export type * from "./Viewport";

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.