@lvl99dotcom/paintcanvas 0.0.0-stage → 0.2.0

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

@@ -0,0 +1,753 @@
+/** Matches a lowercase UUID */
+export declare const UUID_PATTERN = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$";
+/** The `format` of a brush preset file, unless the implementer names their own (see `PaintCanvasNames`) */
+export declare const BRUSH_PRESET_FILE_FORMAT = "paintcanvas-brush-presets";
+/** Formats of brush preset files that are imported by default */
+export declare const BRUSH_PRESET_FILE_FORMATS: readonly string[];
+/** Longest brush preset file format name (characters) */
+export declare const MAX_PRESET_FILE_FORMAT_LENGTH = 100;
+/** The version of the brush preset file format */
+export declare const BRUSH_PRESET_FILE_VERSION = 1;
+/** Most presets in one file */
+export declare const MAX_PRESETS_PER_FILE = 1000;
+/** Longest preset name, author name or handle (characters) */
+export declare const MAX_PRESET_TEXT_LENGTH = 100;
+/** Longest brush shape data URL (characters): a 2 MB PNG as base64 */
+export declare const MAX_SHAPE_DATA_URL_LENGTH: number;
+/** Matches a PNG data URL */
+export declare const PNG_DATA_URL_PATTERN = "^data:image/png;base64,[A-Za-z0-9+/]+={0,2}$";
+/** A brush preset file: what users export and import */
+export interface BrushPresetFile {
+    /** Names the app or kind of file, e.g. `BRUSH_PRESET_FILE_FORMAT` */
+    format: string;
+    version: typeof BRUSH_PRESET_FILE_VERSION;
+    /** Presets, each matching `brushPresetSchema` */
+    presets: Record<string, unknown>[];
+}
+/** JSON schema for a brush preset a user made or imported (see `BrushConfig` in the app) */
+export declare const brushPresetSchema: {
+    readonly $id: "paintcanvas/brush-preset";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["id"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 100;
+        };
+        readonly group: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 100;
+        };
+        readonly version: {
+            readonly type: "string";
+            readonly maxLength: 20;
+        };
+        readonly author: {
+            readonly anyOf: readonly [{
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 100;
+            }, {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["name"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 100;
+                    };
+                    readonly handle: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 100;
+                    };
+                    readonly email: {
+                        readonly type: "string";
+                        readonly maxLength: 254;
+                    };
+                    readonly website: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                    };
+                };
+            }];
+        };
+        readonly image: {
+            readonly type: "string";
+            readonly pattern: "^data:image/png;base64,[A-Za-z0-9+/]+={0,2}$";
+            readonly maxLength: number;
+        };
+        readonly colourMode: {
+            readonly enum: readonly [0, 1];
+        };
+        readonly hue: {
+            readonly anyOf: readonly [{
+                readonly type: "number";
+            }, {
+                readonly type: "string";
+                readonly maxLength: 20;
+            }];
+        };
+        readonly hueConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly saturation: {
+            readonly anyOf: readonly [{
+                readonly type: "number";
+            }, {
+                readonly type: "string";
+                readonly maxLength: 20;
+            }];
+        };
+        readonly saturationConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly lightness: {
+            readonly anyOf: readonly [{
+                readonly type: "number";
+            }, {
+                readonly type: "string";
+                readonly maxLength: 20;
+            }];
+        };
+        readonly lightnessConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly red: {
+            readonly anyOf: readonly [{
+                readonly type: "number";
+            }, {
+                readonly type: "string";
+                readonly maxLength: 20;
+            }];
+        };
+        readonly redConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly green: {
+            readonly anyOf: readonly [{
+                readonly type: "number";
+            }, {
+                readonly type: "string";
+                readonly maxLength: 20;
+            }];
+        };
+        readonly greenConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly blue: {
+            readonly anyOf: readonly [{
+                readonly type: "number";
+            }, {
+                readonly type: "string";
+                readonly maxLength: 20;
+            }];
+        };
+        readonly blueConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly alpha: {
+            readonly type: "number";
+            readonly minimum: 0;
+            readonly maximum: 1;
+        };
+        readonly alphaConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly width: {
+            readonly type: "number";
+            readonly minimum: 1;
+            readonly maximum: 256;
+        };
+        readonly widthConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly height: {
+            readonly type: "number";
+            readonly minimum: 1;
+            readonly maximum: 256;
+        };
+        readonly heightConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly constrainProportions: {
+            readonly type: "boolean";
+        };
+        readonly rotation: {
+            readonly type: "number";
+            readonly minimum: -360;
+            readonly maximum: 360;
+        };
+        readonly rotationConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly offsetX: {
+            readonly type: "number";
+            readonly minimum: -256;
+            readonly maximum: 256;
+        };
+        readonly offsetXConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly offsetY: {
+            readonly type: "number";
+            readonly minimum: -256;
+            readonly maximum: 256;
+        };
+        readonly offsetYConfig: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly useRandomise: {
+                    readonly type: "boolean";
+                };
+                readonly minRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxRandomise: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly usePressure: {
+                    readonly type: "boolean";
+                };
+                readonly minPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxPressure: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly useTilt: {
+                    readonly type: "boolean";
+                };
+                readonly minTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly maxTilt: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+            };
+        };
+        readonly sampleRate: {
+            readonly type: "number";
+            readonly minimum: 5;
+            readonly maximum: 400;
+        };
+        readonly smoothingType: {
+            readonly enum: readonly [0, 1, 2, 3];
+        };
+        readonly spacing: {
+            readonly type: "number";
+            readonly minimum: 0;
+            readonly maximum: 200;
+        };
+        readonly snapToPixelGrid: {
+            readonly type: "boolean";
+        };
+    };
+};
+/** JSON schema for a brush preset file */
+export declare const brushPresetFileSchema: {
+    readonly $id: "paintcanvas/brush-preset-file";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["format", "version", "presets"];
+    readonly properties: {
+        readonly format: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 100;
+        };
+        readonly version: {
+            readonly const: 1;
+        };
+        readonly presets: {
+            readonly type: "array";
+            readonly maxItems: 1000;
+            readonly items: {
+                readonly $ref: "brush-preset";
+            };
+        };
+    };
+};