@steppy/player 0.0.0-stage → 0.4.0

package/dist/types/manifest/content.d.ts

@@ -0,0 +1,24 @@
+import type { CaptureContent, GuideManifest, ManifestStep } from './schema.js';
+/**
+ * Resolve a step's guide text for one (locale, layout).
+ *
+ * Two levels, no partials: a `Capture` either carries a full `content`
+ * override — the desktop/mobile twin-branch case, where the same logical step
+ * is authored once per layout — or it inherits the step-level value.
+ *
+ * The caller must pass the layout key it also read the *frame* from. Content
+ * and frame coming from the same `Capture` is the invariant that keeps a
+ * viewer from ever seeing one layout's instructions above another layout's
+ * screenshot; see `captureLayoutKey`.
+ */
+export declare function resolveStepContent(step: ManifestStep, locale: string, layoutKey: string): CaptureContent;
+/**
+ * The layout key a render should read `step.captures[locale]` under.
+ *
+ * Prefers the requested key, then the manifest default, then whatever the bag
+ * actually holds. The schema guarantees the full (locale × layout)
+ * cross-product, so the first branch is the live path; the rest only matter
+ * when a host sets an unrecognised `variant`, and they exist so the fallback
+ * lands on the manifest's own default rather than on object insertion order.
+ */
+export declare function captureLayoutKey(step: ManifestStep, locale: string, requested: string | null, manifest: Pick<GuideManifest, 'layouts' | 'defaultLayout'>): string | null;

package/dist/types/manifest/index.d.ts

@@ -0,0 +1,3 @@
+export { GuideManifestSchema, SUPPORTED_MAJOR_VERSION, type Bbox, type Capture, type CaptureContent, type CaptureSize, type CursorBehavior, type CursorTimings, type Frame, type GuideManifest, type ManifestAction, type ManifestStep, } from './schema.js';
+export { captureLayoutKey, resolveStepContent } from './content.js';
+export { parseManifest, type ParseError, type ParseErrorCode, type ParseResult, } from './parse.js';

package/dist/types/manifest/parse.d.ts

@@ -0,0 +1,23 @@
+import { type GuideManifest } from './schema.js';
+export type ParseErrorCode = 'invalid_json' | 'version_missing' | 'version_unsupported' | 'schema_invalid' | 'fetch_failed' | 'screenshot_missing' | 'bad_attribute';
+export interface ParseError {
+    code: ParseErrorCode;
+    message: string;
+    issues?: Array<{
+        path: string;
+        message: string;
+    }>;
+}
+export type ParseResult = {
+    ok: true;
+    manifest: GuideManifest;
+} | {
+    ok: false;
+    error: ParseError;
+};
+/**
+ * Parse and validate a manifest from either a JSON string or a pre-parsed
+ * value. Performs major-version compatibility check before structural
+ * validation so version errors are reported with a clearer code.
+ */
+export declare function parseManifest(input: unknown): ParseResult;