@lvl99dotcom/paintcanvas 0.0.0-stage → 0.3.0

package/dist/lib/messages/schema.js

@@ -0,0 +1,192 @@
+import { ImageEncoding } from "../image/index.js";
+import { UUID_PATTERN, brushPresetSchema } from "../presets/schema.js";
+// src/lib/messages/schema.ts
+/** Version of the drawing message protocol, sent in every message */
+var PROTOCOL_VERSION = 1;
+/** Kinds of drawing message */
+var CanvasMessageType = {
+	/** Pixels of the sender's whole drawing (all their layers, flattened) within an area */
+	Patch: "patch",
+	/** A finished brush or eraser stroke */
+	Stroke: "stroke",
+	/** The sender undid a step */
+	Undo: "undo",
+	/** The sender redid a step */
+	Redo: "redo"
+};
+/** Largest canvas width or height a message may refer to */
+var MAX_MESSAGE_CANVAS_SIZE = 1e4;
+/** Most points in one stroke message */
+var MAX_STROKE_POINTS = 1e5;
+/** Longest encoded image data in a patch (characters): a whole 10000 × 10000 canvas as base64 RGBA */
+var MAX_PATCH_DATA_LENGTH = Math.ceil(MAX_MESSAGE_CANVAS_SIZE * MAX_MESSAGE_CANVAS_SIZE * 4 / 3) * 4;
+var protocol = { const: 1 };
+var step = {
+	type: "string",
+	pattern: UUID_PATTERN
+};
+var coordinate = {
+	type: "integer",
+	minimum: 0,
+	maximum: MAX_MESSAGE_CANVAS_SIZE
+};
+var number = { type: "number" };
+/** JSON schema for the brush settings in a stroke message: a brush preset whose ID can be any name (built-in presets
+* have names like `round1`, not UUIDs) */
+var strokePresetSchema = {
+	...brushPresetSchema,
+	$id: "paintcanvas/stroke-preset",
+	properties: {
+		...brushPresetSchema.properties,
+		id: {
+			type: "string",
+			minLength: 1,
+			maxLength: 100
+		}
+	}
+};
+/** JSON schema for a patch message */
+var patchMessageSchema = {
+	$id: "paintcanvas/message/patch",
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"protocol",
+		"type",
+		"coords",
+		"encoding",
+		"data"
+	],
+	properties: {
+		protocol,
+		type: { const: CanvasMessageType.Patch },
+		coords: {
+			type: "array",
+			items: coordinate,
+			minItems: 4,
+			maxItems: 4
+		},
+		encoding: { enum: Object.values(ImageEncoding) },
+		data: {
+			type: "string",
+			pattern: "^[A-Za-z0-9+/]*={0,2}$",
+			maxLength: MAX_PATCH_DATA_LENGTH
+		}
+	}
+};
+/** JSON schema for a stroke message */
+var strokeMessageSchema = {
+	$id: "paintcanvas/message/stroke",
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"protocol",
+		"type",
+		"step",
+		"layer",
+		"mode",
+		"preset",
+		"size",
+		"colour",
+		"isPen",
+		"seed",
+		"points"
+	],
+	properties: {
+		protocol,
+		type: { const: CanvasMessageType.Stroke },
+		step,
+		layer: {
+			type: "string",
+			minLength: 1,
+			maxLength: 100
+		},
+		mode: { enum: ["paint", "erase"] },
+		preset: { $ref: "../stroke-preset" },
+		size: {
+			type: "object",
+			additionalProperties: false,
+			required: ["width", "height"],
+			properties: {
+				width: {
+					type: "number",
+					minimum: 0,
+					maximum: MAX_MESSAGE_CANVAS_SIZE
+				},
+				height: {
+					type: "number",
+					minimum: 0,
+					maximum: MAX_MESSAGE_CANVAS_SIZE
+				}
+			}
+		},
+		colour: {
+			type: "string",
+			pattern: "^#[0-9a-fA-F]{6}$"
+		},
+		isPen: { type: "boolean" },
+		seed: {
+			type: "integer",
+			minimum: 0,
+			maximum: 4294967295
+		},
+		points: {
+			type: "array",
+			minItems: 1,
+			maxItems: MAX_STROKE_POINTS,
+			items: {
+				type: "object",
+				additionalProperties: false,
+				required: [
+					"x",
+					"y",
+					"time"
+				],
+				properties: {
+					x: number,
+					y: number,
+					time: number,
+					rotation: number,
+					pressure: {
+						type: "number",
+						minimum: 0,
+						maximum: 1
+					},
+					tiltX: {
+						type: "number",
+						minimum: -90,
+						maximum: 90
+					},
+					tiltY: {
+						type: "number",
+						minimum: -90,
+						maximum: 90
+					}
+				}
+			}
+		}
+	}
+};
+/** JSON schema for an undo or redo message */
+var historyMessageSchema = {
+	$id: "paintcanvas/message/history",
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"protocol",
+		"type",
+		"step"
+	],
+	properties: {
+		protocol,
+		type: { enum: [CanvasMessageType.Undo, CanvasMessageType.Redo] },
+		step
+	}
+};
+var messageSchemas = [
+	strokePresetSchema,
+	patchMessageSchema,
+	strokeMessageSchema,
+	historyMessageSchema
+];
+export { CanvasMessageType, MAX_MESSAGE_CANVAS_SIZE, MAX_PATCH_DATA_LENGTH, MAX_STROKE_POINTS, PROTOCOL_VERSION, historyMessageSchema, messageSchemas, patchMessageSchema, strokeMessageSchema, strokePresetSchema };

package/dist/lib/presets/index.d.ts

@@ -0,0 +1,32 @@
+import type { BrushPresetFile } from "./schema";
+import { type ValidationError } from "../validation/validators.generated.js";
+export * from "./schema";
+/** Result of validating a brush preset or preset file */
+export type PresetValidationResult<T> = {
+    valid: true;
+    value: T;
+} | {
+    valid: false;
+    errors: string[];
+};
+/**
+ * Turn validation errors into readable messages.
+ *
+ * @example
+ * formatErrors([{ instancePath: "/id", message: "must match pattern" }]); // ["/id must match pattern"]
+ */
+export declare const formatErrors: (errors: ValidationError[] | null | undefined) => string[];
+/**
+ * Check a brush preset a user made or imported against `brushPresetSchema`.
+ *
+ * @example
+ * isValidBrushPreset({ id: crypto.randomUUID(), name: "My brush" }).valid; // true
+ */
+export declare const isValidBrushPreset: (input: unknown) => PresetValidationResult<Record<string, unknown>>;
+/**
+ * Check a brush preset file against `brushPresetFileSchema`.
+ *
+ * @example
+ * isValidBrushPresetFile({ format: "paintcanvas-brush-presets", version: 1, presets: [] }).valid; // true
+ */
+export declare const isValidBrushPresetFile: (input: unknown) => PresetValidationResult<BrushPresetFile>;

package/dist/lib/presets/index.js

@@ -0,0 +1,35 @@
+import { validateBrushPreset, validateBrushPresetFile } from "../validation/validators.generated.js";
+import { BRUSH_PRESET_FILE_FORMAT, BRUSH_PRESET_FILE_FORMATS, BRUSH_PRESET_FILE_VERSION, MAX_PRESETS_PER_FILE, MAX_PRESET_FILE_FORMAT_LENGTH, MAX_PRESET_TEXT_LENGTH, MAX_SHAPE_DATA_URL_LENGTH, PNG_DATA_URL_PATTERN, UUID_PATTERN, brushPresetFileSchema, brushPresetSchema } from "./schema.js";
+// src/lib/presets/index.ts
+/**
+* Turn validation errors into readable messages.
+*
+* @example
+* formatErrors([{ instancePath: "/id", message: "must match pattern" }]); // ["/id must match pattern"]
+*/
+var formatErrors = (errors) => (errors ?? []).map((e) => `${e.instancePath || "/"} ${e.message ?? "is invalid"}`);
+/**
+* Validate a value with a pre-compiled validator.
+*/
+var check = (validate, input) => validate(input) ? {
+	valid: true,
+	value: input
+} : {
+	valid: false,
+	errors: formatErrors(validate.errors)
+};
+/**
+* Check a brush preset a user made or imported against `brushPresetSchema`.
+*
+* @example
+* isValidBrushPreset({ id: crypto.randomUUID(), name: "My brush" }).valid; // true
+*/
+var isValidBrushPreset = (input) => check(validateBrushPreset, input);
+/**
+* Check a brush preset file against `brushPresetFileSchema`.
+*
+* @example
+* isValidBrushPresetFile({ format: "paintcanvas-brush-presets", version: 1, presets: [] }).valid; // true
+*/
+var isValidBrushPresetFile = (input) => check(validateBrushPresetFile, input);
+export { BRUSH_PRESET_FILE_FORMAT, BRUSH_PRESET_FILE_FORMATS, BRUSH_PRESET_FILE_VERSION, MAX_PRESETS_PER_FILE, MAX_PRESET_FILE_FORMAT_LENGTH, MAX_PRESET_TEXT_LENGTH, MAX_SHAPE_DATA_URL_LENGTH, PNG_DATA_URL_PATTERN, UUID_PATTERN, brushPresetFileSchema, brushPresetSchema, formatErrors, isValidBrushPreset, isValidBrushPresetFile };