@velumo/core 0.1.0-beta.0

package/dist/validation.js

@@ -0,0 +1,274 @@
+import { validateBackground } from "./background-validation.js";
+import { validateLayoutNode } from "./layout-validation.js";
+import { validateTheme } from "./theme-validation.js";
+import { describeType, issue } from "./validation-issue.js";
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isNonEmptyString(value) {
+    return typeof value === "string" && value.trim().length > 0;
+}
+function typeIssue(path, message, expected, received) {
+    return issue(path, "wrong_type", message, {
+        expected,
+        received: describeType(received),
+    });
+}
+function requiredIssue(path, message) {
+    return issue(path, "required", message, {
+        suggestion: `Provide a value for \`${path}\`.`,
+    });
+}
+const CAMERA_EASINGS = [
+    "linear",
+    "ease",
+    "ease-in",
+    "ease-out",
+    "ease-in-out",
+];
+const CAMERA_VIEW_KEYS = new Set(["x", "y", "zoom"]);
+const CAMERA_TRANSITION_KEYS = new Set(["duration", "easing"]);
+const CAMERA_STOP_KEYS = new Set(["camera", "transition", "cues", "hold"]);
+function isPercent(value) {
+    return (typeof value === "number" &&
+        Number.isFinite(value) &&
+        value >= 0 &&
+        value <= 100);
+}
+function valueIssue(path, message, received) {
+    return issue(path, "invalid_value", message, {
+        received: describeType(received),
+    });
+}
+function unknownFieldIssues(record, allowed, path) {
+    return Object.keys(record)
+        .filter((key) => !allowed.has(key))
+        .map((key) => issue(`${path}.${key}`, "unknown_field", `${path}.${key} is not allowed`, {
+        expected: [...allowed].join(", "),
+        suggestion: `Remove \`${key}\`; it is not a recognized field here.`,
+    }));
+}
+function validateCameraView(view, path) {
+    if (!isRecord(view)) {
+        return [typeIssue(path, `${path} must be an object`, "object", view)];
+    }
+    const issues = [];
+    for (const axis of ["x", "y"]) {
+        if (view[axis] === undefined) {
+            issues.push(requiredIssue(`${path}.${axis}`, `${path}.${axis} is required`));
+        }
+        else if (!isPercent(view[axis])) {
+            issues.push(valueIssue(`${path}.${axis}`, `${path}.${axis} must be a percentage 0-100`, view[axis]));
+        }
+    }
+    if (view.zoom !== undefined) {
+        if (typeof view.zoom !== "number" ||
+            !Number.isFinite(view.zoom) ||
+            view.zoom <= 0) {
+            issues.push(valueIssue(`${path}.zoom`, `${path}.zoom must be a number > 0`, view.zoom));
+        }
+    }
+    issues.push(...unknownFieldIssues(view, CAMERA_VIEW_KEYS, path));
+    return issues;
+}
+function validateCameraTransition(transition, path) {
+    if (!isRecord(transition)) {
+        return [typeIssue(path, `${path} must be an object`, "object", transition)];
+    }
+    const issues = [];
+    if (transition.duration !== undefined) {
+        if (typeof transition.duration !== "number" ||
+            !Number.isFinite(transition.duration) ||
+            transition.duration < 0) {
+            issues.push(valueIssue(`${path}.duration`, `${path}.duration must be a number >= 0`, transition.duration));
+        }
+    }
+    if (transition.easing !== undefined &&
+        !CAMERA_EASINGS.includes(transition.easing)) {
+        issues.push(issue(`${path}.easing`, "invalid_enum", `${path}.easing must be a known easing`, {
+            expected: CAMERA_EASINGS.join(", "),
+            received: typeof transition.easing === "string"
+                ? transition.easing
+                : describeType(transition.easing),
+            suggestion: `Use one of: ${CAMERA_EASINGS.join(", ")}.`,
+        }));
+    }
+    issues.push(...unknownFieldIssues(transition, CAMERA_TRANSITION_KEYS, path));
+    return issues;
+}
+function validateCameraStop(stop, path) {
+    if (!isRecord(stop)) {
+        return [typeIssue(path, `${path} must be an object`, "object", stop)];
+    }
+    const issues = [];
+    if (stop.camera === undefined) {
+        issues.push(requiredIssue(`${path}.camera`, `${path}.camera is required`));
+    }
+    else {
+        issues.push(...validateCameraView(stop.camera, `${path}.camera`));
+    }
+    if (stop.transition !== undefined) {
+        issues.push(...validateCameraTransition(stop.transition, `${path}.transition`));
+    }
+    if (stop.cues !== undefined) {
+        if (!Array.isArray(stop.cues)) {
+            issues.push(typeIssue(`${path}.cues`, `${path}.cues must be an array`, "array", stop.cues));
+        }
+        else {
+            stop.cues.forEach((cue, cueIndex) => {
+                const cuePath = `${path}.cues[${cueIndex}]`;
+                if (!isRecord(cue)) {
+                    issues.push(typeIssue(cuePath, `${cuePath} must be an object`, "object", cue));
+                    return;
+                }
+                if (typeof cue.time !== "number") {
+                    issues.push(requiredIssue(`${cuePath}.time`, `${cuePath}.time is required`));
+                }
+                else if (!Number.isFinite(cue.time) || cue.time < 0) {
+                    issues.push(valueIssue(`${cuePath}.time`, `${cuePath}.time must be a finite number >= 0`, cue.time));
+                }
+                if (!isRecord(cue.action) || typeof cue.action.type !== "string") {
+                    issues.push(requiredIssue(`${cuePath}.action`, `${cuePath}.action.type is required`));
+                }
+            });
+        }
+    }
+    if (stop.hold !== undefined) {
+        if (typeof stop.hold !== "number" ||
+            !Number.isFinite(stop.hold) ||
+            stop.hold < 0) {
+            issues.push(valueIssue(`${path}.hold`, `${path}.hold must be a number >= 0`, stop.hold));
+        }
+    }
+    issues.push(...unknownFieldIssues(stop, CAMERA_STOP_KEYS, path));
+    return issues;
+}
+function validateCameraPath(value, path) {
+    if (!Array.isArray(value)) {
+        return [typeIssue(path, `${path} must be an array`, "array", value)];
+    }
+    const issues = [];
+    if (value.length === 0) {
+        issues.push(issue(path, "constraint", `${path} must contain at least one stop`, {
+            suggestion: "Add a cameraStop, or remove the empty cameraPath.",
+        }));
+        return issues;
+    }
+    value.forEach((stop, index) => {
+        issues.push(...validateCameraStop(stop, `${path}[${index}]`));
+    });
+    return issues;
+}
+function validateSlideEntry(entry, index) {
+    const issues = [];
+    const path = `slides[${index}]`;
+    if (!isRecord(entry)) {
+        return [typeIssue(path, `${path} must be an object`, "object", entry)];
+    }
+    if (!isNonEmptyString(entry.id)) {
+        issues.push(requiredIssue(`${path}.id`, `${path}.id is required`));
+    }
+    if (entry.layout !== undefined) {
+        issues.push(...validateLayoutNode(entry.layout, `${path}.layout`));
+    }
+    if (Array.isArray(entry.layers)) {
+        entry.layers.forEach((layer, layerIndex) => {
+            const layerPath = `${path}.layers[${layerIndex}]`;
+            if (!isRecord(layer)) {
+                issues.push(typeIssue(layerPath, `${layerPath} must be an object`, "object", layer));
+                return;
+            }
+            if (!isNonEmptyString(layer.type)) {
+                issues.push(requiredIssue(`${layerPath}.type`, `${layerPath}.type is required`));
+            }
+        });
+    }
+    if (Array.isArray(entry.cues)) {
+        entry.cues.forEach((cue, cueIndex) => {
+            const cuePath = `${path}.cues[${cueIndex}]`;
+            if (!isRecord(cue)) {
+                issues.push(typeIssue(cuePath, `${cuePath} must be an object`, "object", cue));
+                return;
+            }
+            if (typeof cue.time !== "number") {
+                issues.push(requiredIssue(`${cuePath}.time`, `${cuePath}.time is required`));
+            }
+            else if (!Number.isFinite(cue.time) || cue.time < 0) {
+                issues.push(valueIssue(`${cuePath}.time`, `${cuePath}.time must be a finite number >= 0`, cue.time));
+            }
+        });
+    }
+    if (Array.isArray(entry.fragments)) {
+        entry.fragments.forEach((fragment, fragmentIndex) => {
+            const fragmentPath = `${path}.fragments[${fragmentIndex}]`;
+            if (!isRecord(fragment)) {
+                issues.push(typeIssue(fragmentPath, `${fragmentPath} must be an object`, "object", fragment));
+                return;
+            }
+            if (!isNonEmptyString(fragment.id)) {
+                issues.push(requiredIssue(`${fragmentPath}.id`, `${fragmentPath}.id is required`));
+            }
+        });
+    }
+    if (entry.background !== undefined) {
+        issues.push(...validateBackground(entry.background, `${path}.background`));
+    }
+    if (entry.cameraPath !== undefined) {
+        if (entry.kind !== "scene") {
+            issues.push(issue(`${path}.cameraPath`, "unknown_field", `${path}.cameraPath is only allowed on a scene (kind: "scene")`, {
+                suggestion: `Change this entry's kind to "scene", or remove cameraPath.`,
+            }));
+        }
+        else {
+            issues.push(...validateCameraPath(entry.cameraPath, `${path}.cameraPath`));
+        }
+    }
+    if (entry.chrome !== undefined && typeof entry.chrome !== "boolean") {
+        issues.push(typeIssue(`${path}.chrome`, `${path}.chrome must be a boolean`, "boolean", entry.chrome));
+    }
+    return issues;
+}
+function collectIssues(manifest) {
+    if (!isRecord(manifest)) {
+        return [
+            typeIssue("manifest", "manifest must be an object", "object", manifest),
+        ];
+    }
+    const issues = [];
+    if (!isRecord(manifest.deck)) {
+        issues.push(typeIssue("deck", "deck must be an object", "object", manifest.deck));
+    }
+    else {
+        if (!isNonEmptyString(manifest.deck.title)) {
+            issues.push(requiredIssue("deck.title", "deck.title is required"));
+        }
+        if (manifest.deck.watermark !== undefined &&
+            typeof manifest.deck.watermark !== "string") {
+            issues.push(typeIssue("deck.watermark", "deck.watermark must be a string", "string", manifest.deck.watermark));
+        }
+    }
+    if (!Array.isArray(manifest.slides)) {
+        issues.push(typeIssue("slides", "slides must be an array", "array", manifest.slides));
+    }
+    else {
+        manifest.slides.forEach((slide, index) => {
+            issues.push(...validateSlideEntry(slide, index));
+        });
+    }
+    if (manifest.theme !== undefined) {
+        issues.push(...validateTheme(manifest.theme));
+    }
+    return issues;
+}
+export function validateManifest(manifest) {
+    const issues = collectIssues(manifest);
+    return {
+        valid: issues.length === 0,
+        errors: issues.map((current) => current.message),
+        issues,
+    };
+}
+export function isValidManifest(manifest) {
+    return validateManifest(manifest).valid;
+}
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAI5D,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,SAAS,CAChB,IAAY,EACZ,OAAe,EACf,QAAgB,EAChB,QAAiB;IAEjB,OAAO,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE;QACxC,QAAQ;QACR,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;KACjC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,OAAe;IAClD,OAAO,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE;QACtC,UAAU,EAAE,yBAAyB,IAAI,KAAK;KAC/C,CAAC,CAAC;AACL,CAAC;AAED,MAAM,cAAc,GAAG;IACrB,QAAQ;IACR,MAAM;IACN,SAAS;IACT,UAAU;IACV,aAAa;CACL,CAAC;AAEX,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;AACrD,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC/D,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE3E,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QACtB,KAAK,IAAI,CAAC;QACV,KAAK,IAAI,GAAG,CACb,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CACjB,IAAY,EACZ,OAAe,EACf,QAAiB;IAEjB,OAAO,KAAK,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE;QAC3C,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;KACjC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAqB,EACrB,OAA4B,EAC5B,IAAY;IAEZ,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACvB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SAClC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACX,KAAK,CACH,GAAG,IAAI,IAAI,GAAG,EAAE,EAChB,eAAe,EACf,GAAG,IAAI,IAAI,GAAG,iBAAiB,EAC/B;QACE,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,UAAU,EAAE,YAAY,GAAG,wCAAwC;KACpE,CACF,CACF,CAAC;AACN,CAAC;AAED,SAAS,kBAAkB,CACzB,IAAa,EACb,IAAY;IAEZ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,oBAAoB,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,CAAU,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CACT,aAAa,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,EAAE,GAAG,IAAI,IAAI,IAAI,cAAc,CAAC,CAChE,CAAC;QACJ,CAAC;aAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAClC,MAAM,CAAC,IAAI,CACT,UAAU,CACR,GAAG,IAAI,IAAI,IAAI,EAAE,EACjB,GAAG,IAAI,IAAI,IAAI,6BAA6B,EAC5C,IAAI,CAAC,IAAI,CAAC,CACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,IACE,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;YAC7B,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,IAAI,IAAI,CAAC,EACd,CAAC;YACD,MAAM,CAAC,IAAI,CACT,UAAU,CACR,GAAG,IAAI,OAAO,EACd,GAAG,IAAI,4BAA4B,EACnC,IAAI,CAAC,IAAI,CACV,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,wBAAwB,CAC/B,UAAmB,EACnB,IAAY;IAEZ,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,oBAAoB,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IAC9E,CAAC;IACD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACtC,IACE,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ;YACvC,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC;YACrC,UAAU,CAAC,QAAQ,GAAG,CAAC,EACvB,CAAC;YACD,MAAM,CAAC,IAAI,CACT,UAAU,CACR,GAAG,IAAI,WAAW,EAClB,GAAG,IAAI,iCAAiC,EACxC,UAAU,CAAC,QAAQ,CACpB,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IACE,UAAU,CAAC,MAAM,KAAK,SAAS;QAC/B,CAAC,cAAc,CAAC,QAAQ,CACtB,UAAU,CAAC,MAAyC,CACrD,EACD,CAAC;QACD,MAAM,CAAC,IAAI,CACT,KAAK,CACH,GAAG,IAAI,SAAS,EAChB,cAAc,EACd,GAAG,IAAI,gCAAgC,EACvC;YACE,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;YACnC,QAAQ,EACN,OAAO,UAAU,CAAC,MAAM,KAAK,QAAQ;gBACnC,CAAC,CAAC,UAAU,CAAC,MAAM;gBACnB,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC;YACrC,UAAU,EAAE,eAAe,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxD,CACF,CACF,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,CAAC,CAAC,CAAC;IAC7E,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,kBAAkB,CACzB,IAAa,EACb,IAAY;IAEZ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,oBAAoB,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,SAAS,EAAE,GAAG,IAAI,qBAAqB,CAAC,CAAC,CAAC;IAC7E,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,CAAC,IAAI,CACT,GAAG,wBAAwB,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,IAAI,aAAa,CAAC,CACnE,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,IAAI,CACT,SAAS,CACP,GAAG,IAAI,OAAO,EACd,GAAG,IAAI,wBAAwB,EAC/B,OAAO,EACP,IAAI,CAAC,IAAI,CACV,CACF,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;gBAClC,MAAM,OAAO,GAAG,GAAG,IAAI,SAAS,QAAQ,GAAG,CAAC;gBAC5C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACnB,MAAM,CAAC,IAAI,CACT,SAAS,CAAC,OAAO,EAAE,GAAG,OAAO,oBAAoB,EAAE,QAAQ,EAAE,GAAG,CAAC,CAClE,CAAC;oBACF,OAAO;gBACT,CAAC;gBACD,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACjC,MAAM,CAAC,IAAI,CACT,aAAa,CAAC,GAAG,OAAO,OAAO,EAAE,GAAG,OAAO,mBAAmB,CAAC,CAChE,CAAC;gBACJ,CAAC;qBAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oBACtD,MAAM,CAAC,IAAI,CACT,UAAU,CACR,GAAG,OAAO,OAAO,EACjB,GAAG,OAAO,oCAAoC,EAC9C,GAAG,CAAC,IAAI,CACT,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACjE,MAAM,CAAC,IAAI,CACT,aAAa,CACX,GAAG,OAAO,SAAS,EACnB,GAAG,OAAO,0BAA0B,CACrC,CACF,CAAC;gBACJ,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,IACE,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;YAC7B,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,IAAI,GAAG,CAAC,EACb,CAAC;YACD,MAAM,CAAC,IAAI,CACT,UAAU,CACR,GAAG,IAAI,OAAO,EACd,GAAG,IAAI,6BAA6B,EACpC,IAAI,CAAC,IAAI,CACV,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAc,EACd,IAAY;IAEZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,mBAAmB,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,CACT,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,IAAI,iCAAiC,EAAE;YAClE,UAAU,EAAE,mDAAmD;SAChE,CAAC,CACH,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,IAAI,EAAE,GAAG,IAAI,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAc,EACd,KAAa;IAEb,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,UAAU,KAAK,GAAG,CAAC;IAEhC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,oBAAoB,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,KAAK,EAAE,GAAG,IAAI,iBAAiB,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;YACzC,MAAM,SAAS,GAAG,GAAG,IAAI,WAAW,UAAU,GAAG,CAAC;YAClD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,MAAM,CAAC,IAAI,CACT,SAAS,CACP,SAAS,EACT,GAAG,SAAS,oBAAoB,EAChC,QAAQ,EACR,KAAK,CACN,CACF,CAAC;gBACF,OAAO;YACT,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,MAAM,CAAC,IAAI,CACT,aAAa,CAAC,GAAG,SAAS,OAAO,EAAE,GAAG,SAAS,mBAAmB,CAAC,CACpE,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,GAAG,IAAI,SAAS,QAAQ,GAAG,CAAC;YAC5C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnB,MAAM,CAAC,IAAI,CACT,SAAS,CAAC,OAAO,EAAE,GAAG,OAAO,oBAAoB,EAAE,QAAQ,EAAE,GAAG,CAAC,CAClE,CAAC;gBACF,OAAO;YACT,CAAC;YAED,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACjC,MAAM,CAAC,IAAI,CACT,aAAa,CAAC,GAAG,OAAO,OAAO,EAAE,GAAG,OAAO,mBAAmB,CAAC,CAChE,CAAC;YACJ,CAAC;iBAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBACtD,MAAM,CAAC,IAAI,CACT,UAAU,CACR,GAAG,OAAO,OAAO,EACjB,GAAG,OAAO,oCAAoC,EAC9C,GAAG,CAAC,IAAI,CACT,CACF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QACnC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,aAAa,EAAE,EAAE;YAClD,MAAM,YAAY,GAAG,GAAG,IAAI,cAAc,aAAa,GAAG,CAAC;YAC3D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACxB,MAAM,CAAC,IAAI,CACT,SAAS,CACP,YAAY,EACZ,GAAG,YAAY,oBAAoB,EACnC,QAAQ,EACR,QAAQ,CACT,CACF,CAAC;gBACF,OAAO;YACT,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,IAAI,CACT,aAAa,CAAC,GAAG,YAAY,KAAK,EAAE,GAAG,YAAY,iBAAiB,CAAC,CACtE,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,IAAI,aAAa,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CACT,KAAK,CACH,GAAG,IAAI,aAAa,EACpB,eAAe,EACf,GAAG,IAAI,wDAAwD,EAC/D;gBACE,UAAU,EAAE,4DAA4D;aACzE,CACF,CACF,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CACT,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,IAAI,aAAa,CAAC,CAC9D,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACpE,MAAM,CAAC,IAAI,CACT,SAAS,CACP,GAAG,IAAI,SAAS,EAChB,GAAG,IAAI,2BAA2B,EAClC,SAAS,EACT,KAAK,CAAC,MAAM,CACb,CACF,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,QAAiB;IACtC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,SAAS,CAAC,UAAU,EAAE,4BAA4B,EAAE,QAAQ,EAAE,QAAQ,CAAC;SACxE,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,MAAM,CAAC,IAAI,CACT,SAAS,CAAC,MAAM,EAAE,wBAAwB,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,wBAAwB,CAAC,CAAC,CAAC;QACrE,CAAC;QACD,IACE,QAAQ,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS;YACrC,OAAO,QAAQ,CAAC,IAAI,CAAC,SAAS,KAAK,QAAQ,EAC3C,CAAC;YACD,MAAM,CAAC,IAAI,CACT,SAAS,CACP,gBAAgB,EAChB,iCAAiC,EACjC,QAAQ,EACR,QAAQ,CAAC,IAAI,CAAC,SAAS,CACxB,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,CAAC,IAAI,CACT,SAAS,CAAC,QAAQ,EAAE,yBAAyB,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CACzE,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACvC,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,QAAiB;IAChD,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAEvC,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;QAChD,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,QAAiB;IAC/C,OAAO,gBAAgB,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC;AAC1C,CAAC"}

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@velumo/core",
+  "version": "0.1.0-beta.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -b"
+  }
+}

package/src/background-validation.ts

@@ -0,0 +1,315 @@
+import type { ValidationIssue } from "./types.js";
+import { describeType, issue } from "./validation-issue.js";
+
+type IndexedRecord = Record<string, unknown>;
+
+const BLEND_MODES = ["normal", "screen", "multiply", "overlay"] as const;
+const SHAPE_VALUES = ["circle", "ellipse"] as const;
+const BACKGROUND_KEYS = new Set(["color", "layers"]);
+const LINEAR_KEYS = new Set(["type", "stops", "angle", "blend", "opacity"]);
+const RADIAL_KEYS = new Set([
+  "type",
+  "stops",
+  "shape",
+  "position",
+  "blend",
+  "opacity",
+]);
+const STOP_KEYS = new Set(["color", "at"]);
+const POSITION_KEYS = new Set(["x", "y"]);
+const LAYER_TYPES = "linear, radial";
+
+function isRecord(value: unknown): value is IndexedRecord {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+function isNonEmptyString(value: unknown): value is string {
+  return typeof value === "string" && value.trim().length > 0;
+}
+
+function isFiniteInRange(value: unknown, min: number, max: number): boolean {
+  return (
+    typeof value === "number" &&
+    Number.isFinite(value) &&
+    value >= min &&
+    value <= max
+  );
+}
+
+function typeIssue(
+  path: string,
+  message: string,
+  expected: string,
+  received: unknown,
+): ValidationIssue {
+  return issue(path, "wrong_type", message, {
+    expected,
+    received: describeType(received),
+  });
+}
+
+function requiredIssue(path: string, message: string): ValidationIssue {
+  return issue(path, "required", message, {
+    suggestion: `Provide a value for \`${path}\`.`,
+  });
+}
+
+function enumIssue(
+  path: string,
+  message: string,
+  allowed: readonly string[],
+  received: unknown,
+): ValidationIssue {
+  return issue(path, "invalid_enum", message, {
+    expected: allowed.join(", "),
+    received: typeof received === "string" ? received : describeType(received),
+    suggestion: `Use one of: ${allowed.join(", ")}.`,
+  });
+}
+
+function valueIssue(
+  path: string,
+  message: string,
+  received: unknown,
+): ValidationIssue {
+  return issue(path, "invalid_value", message, {
+    received:
+      typeof received === "number" ? String(received) : describeType(received),
+  });
+}
+
+function unknownFields(
+  node: IndexedRecord,
+  allowed: ReadonlySet<string>,
+  path: string,
+): readonly ValidationIssue[] {
+  return Object.keys(node)
+    .filter((key) => !allowed.has(key))
+    .map((key) =>
+      issue(
+        `${path}.${key}`,
+        "unknown_field",
+        `${path}.${key} is not allowed`,
+        {
+          expected: [...allowed].join(", "),
+          suggestion: `Remove \`${key}\`; it is not a recognized field here.`,
+        },
+      ),
+    );
+}
+
+function validateStop(
+  value: unknown,
+  path: string,
+): readonly ValidationIssue[] {
+  if (!isRecord(value)) {
+    return [typeIssue(path, `${path} must be an object`, "object", value)];
+  }
+  const issues: ValidationIssue[] = [];
+  issues.push(...unknownFields(value, STOP_KEYS, path));
+  if (!isNonEmptyString(value.color)) {
+    issues.push(requiredIssue(`${path}.color`, `${path}.color is required`));
+  }
+  if (value.at !== undefined && !isFiniteInRange(value.at, 0, 100)) {
+    issues.push(
+      valueIssue(
+        `${path}.at`,
+        `${path}.at must be a percentage 0-100`,
+        value.at,
+      ),
+    );
+  }
+  return issues;
+}
+
+function validateStops(
+  value: unknown,
+  path: string,
+): readonly ValidationIssue[] {
+  if (!Array.isArray(value)) {
+    if (value === undefined) {
+      return [requiredIssue(path, `${path} is required`)];
+    }
+    return [typeIssue(path, `${path} must be an array`, "array", value)];
+  }
+  if (value.length === 0) {
+    return [
+      issue(path, "required", `${path} must have at least one stop`, {
+        suggestion: "A gradient needs one or more color stops.",
+      }),
+    ];
+  }
+  const issues: ValidationIssue[] = [];
+  value.forEach((stop, index) => {
+    issues.push(...validateStop(stop, `${path}[${index}]`));
+  });
+  return issues;
+}
+
+function validateCompositing(
+  node: IndexedRecord,
+  path: string,
+): readonly ValidationIssue[] {
+  const issues: ValidationIssue[] = [];
+  if (
+    node.blend !== undefined &&
+    !(
+      typeof node.blend === "string" &&
+      BLEND_MODES.includes(node.blend as never)
+    )
+  ) {
+    issues.push(
+      enumIssue(
+        `${path}.blend`,
+        `${path}.blend must be normal, screen, multiply, or overlay`,
+        BLEND_MODES,
+        node.blend,
+      ),
+    );
+  }
+  if (node.opacity !== undefined && !isFiniteInRange(node.opacity, 0, 1)) {
+    issues.push(
+      valueIssue(
+        `${path}.opacity`,
+        `${path}.opacity must be a number 0-1`,
+        node.opacity,
+      ),
+    );
+  }
+  return issues;
+}
+
+function validateLayer(
+  value: unknown,
+  path: string,
+): readonly ValidationIssue[] {
+  if (!isRecord(value)) {
+    return [typeIssue(path, `${path} must be an object`, "object", value)];
+  }
+  const issues: ValidationIssue[] = [];
+
+  if (value.type === "linear") {
+    issues.push(...unknownFields(value, LINEAR_KEYS, path));
+    issues.push(...validateStops(value.stops, `${path}.stops`));
+    if (
+      value.angle !== undefined &&
+      !(typeof value.angle === "number" && Number.isFinite(value.angle))
+    ) {
+      issues.push(
+        valueIssue(
+          `${path}.angle`,
+          `${path}.angle must be a finite number`,
+          value.angle,
+        ),
+      );
+    }
+    issues.push(...validateCompositing(value, path));
+  } else if (value.type === "radial") {
+    issues.push(...unknownFields(value, RADIAL_KEYS, path));
+    issues.push(...validateStops(value.stops, `${path}.stops`));
+    if (
+      value.shape !== undefined &&
+      !(
+        typeof value.shape === "string" &&
+        SHAPE_VALUES.includes(value.shape as never)
+      )
+    ) {
+      issues.push(
+        enumIssue(
+          `${path}.shape`,
+          `${path}.shape must be circle or ellipse`,
+          SHAPE_VALUES,
+          value.shape,
+        ),
+      );
+    }
+    if (value.position !== undefined) {
+      if (!isRecord(value.position)) {
+        issues.push(
+          typeIssue(
+            `${path}.position`,
+            `${path}.position must be an object`,
+            "object",
+            value.position,
+          ),
+        );
+      } else {
+        issues.push(
+          ...unknownFields(value.position, POSITION_KEYS, `${path}.position`),
+        );
+        for (const axis of ["x", "y"] as const) {
+          if (!isFiniteInRange(value.position[axis], 0, 100)) {
+            issues.push(
+              valueIssue(
+                `${path}.position.${axis}`,
+                `${path}.position.${axis} must be a percentage 0-100`,
+                value.position[axis],
+              ),
+            );
+          }
+        }
+      }
+    }
+    issues.push(...validateCompositing(value, path));
+  } else {
+    issues.push(
+      issue(
+        `${path}.type`,
+        "unknown_kind",
+        `${path}.type must be a known gradient type`,
+        {
+          expected: LAYER_TYPES,
+          received:
+            typeof value.type === "string"
+              ? value.type
+              : describeType(value.type),
+          suggestion: `Use one of: ${LAYER_TYPES}.`,
+        },
+      ),
+    );
+  }
+  return issues;
+}
+
+export function validateBackground(
+  value: unknown,
+  path: string,
+): readonly ValidationIssue[] {
+  if (!isRecord(value)) {
+    return [typeIssue(path, `${path} must be an object`, "object", value)];
+  }
+  const issues: ValidationIssue[] = [];
+  issues.push(...unknownFields(value, BACKGROUND_KEYS, path));
+
+  if (value.color !== undefined && !isNonEmptyString(value.color)) {
+    issues.push(
+      value.color === ""
+        ? requiredIssue(`${path}.color`, `${path}.color must not be empty`)
+        : typeIssue(
+            `${path}.color`,
+            `${path}.color must be a string`,
+            "string",
+            value.color,
+          ),
+    );
+  }
+
+  if (value.layers !== undefined) {
+    if (!Array.isArray(value.layers)) {
+      issues.push(
+        typeIssue(
+          `${path}.layers`,
+          `${path}.layers must be an array`,
+          "array",
+          value.layers,
+        ),
+      );
+    } else {
+      value.layers.forEach((layer, index) => {
+        issues.push(...validateLayer(layer, `${path}.layers[${index}]`));
+      });
+    }
+  }
+
+  return issues;
+}