@penpair/core 0.1.3 → 0.3.0

package/dist/instance/config-schema.d.ts

@@ -0,0 +1,422 @@
+/** Editor hints for the core settings. Adapter-owned properties remain open; `config check` also checks semantic constraints. */
+export declare const projectConfigSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly title: "penpair project configuration";
+    readonly type: "object";
+    readonly required: readonly ["instance"];
+    readonly properties: {
+        readonly schemaVersion: {
+            readonly const: 1;
+        };
+        readonly connection: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["credential"];
+            readonly properties: {
+                readonly credential: {
+                    readonly oneOf: readonly [{
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["type", "path"];
+                        readonly properties: {
+                            readonly type: {
+                                readonly const: "file";
+                            };
+                            readonly path: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    }, {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["type", "service", "account"];
+                        readonly properties: {
+                            readonly type: {
+                                readonly const: "keychain";
+                            };
+                            readonly service: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly account: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    }];
+                };
+            };
+        };
+        readonly audit: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly contrast: {
+                    readonly type: "boolean";
+                };
+                readonly library: {
+                    readonly type: "boolean";
+                };
+                readonly touchTargets: {
+                    readonly type: "boolean";
+                };
+                readonly names: {
+                    readonly type: "boolean";
+                };
+                readonly blankText: {
+                    readonly type: "boolean";
+                };
+                readonly interactiveIds: {
+                    readonly type: "array";
+                    readonly maxItems: 1000;
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly allowBlank: {
+                    readonly type: "array";
+                    readonly maxItems: 1000;
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly nameSegments: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly maximum: 10;
+                };
+                readonly suppressions: {
+                    readonly type: "array";
+                    readonly maxItems: 1000;
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["rule", "nodeId", "reason"];
+                        readonly properties: {
+                            readonly rule: {
+                                readonly enum: readonly ["contrast", "library", "touch-target", "names", "blank-text"];
+                            };
+                            readonly nodeId: {
+                                readonly type: "string";
+                            };
+                            readonly reason: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly backup: {
+            readonly type: "object";
+            readonly required: readonly ["noteFile", "remindAfterDays"];
+            readonly properties: {
+                readonly noteFile: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly pattern: "^(?![/\\\\])(?!.*(?:^|[/\\\\])\\.\\.(?:[/\\\\]|$)).+$";
+                };
+                readonly remindAfterDays: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                };
+            };
+        };
+        readonly file: {
+            readonly type: "object";
+            readonly required: readonly ["id"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly pattern: "\\S";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly instance: {
+            readonly type: "string";
+            readonly pattern: "^[a-z][a-z0-9-]{0,30}$";
+        };
+        readonly snippets: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly pattern: "^(?![/\\\\])(?![A-Za-z]:[/\\\\])(?!.*(?:^|[/\\\\])\\.\\.(?:[/\\\\]|$)).+$";
+            };
+        };
+        readonly adapters: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+                readonly minLength: 1;
+            };
+        };
+        readonly baselines: {
+            readonly type: "object";
+            readonly required: readonly ["page", "root", "frames"];
+            readonly properties: {
+                readonly page: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly root: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly pattern: "^(?![/\\\\])(?![A-Za-z]:[/\\\\])(?!.*(?:^|[/\\\\])\\.\\.(?:[/\\\\]|$)).+$";
+                };
+                readonly coverage: {
+                    readonly type: "object";
+                    readonly required: readonly ["required"];
+                    readonly properties: {
+                        readonly required: {
+                            readonly type: "array";
+                            readonly minItems: 1;
+                            readonly maxItems: 1000;
+                            readonly items: {
+                                readonly type: "object";
+                                readonly required: readonly ["route", "viewport", "theme", "state", "fixture"];
+                                readonly additionalProperties: false;
+                                readonly properties: {
+                                    readonly viewport: {
+                                        readonly type: "object";
+                                        readonly required: readonly ["width", "height"];
+                                        readonly additionalProperties: false;
+                                        readonly properties: {
+                                            readonly width: {
+                                                readonly type: "integer";
+                                                readonly minimum: 1;
+                                                readonly maximum: 16384;
+                                            };
+                                            readonly height: {
+                                                readonly type: "integer";
+                                                readonly minimum: 1;
+                                                readonly maximum: 16384;
+                                            };
+                                        };
+                                    };
+                                    readonly theme: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                    readonly state: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                    readonly fixture: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                    readonly route: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                };
+                            };
+                        };
+                        readonly unsupported: {
+                            readonly type: "array";
+                            readonly maxItems: 1000;
+                            readonly items: {
+                                readonly required: readonly ["route", "viewport", "theme", "state", "fixture", "reason"];
+                                readonly properties: {
+                                    readonly reason: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                    readonly viewport: {
+                                        readonly type: "object";
+                                        readonly required: readonly ["width", "height"];
+                                        readonly additionalProperties: false;
+                                        readonly properties: {
+                                            readonly width: {
+                                                readonly type: "integer";
+                                                readonly minimum: 1;
+                                                readonly maximum: 16384;
+                                            };
+                                            readonly height: {
+                                                readonly type: "integer";
+                                                readonly minimum: 1;
+                                                readonly maximum: 16384;
+                                            };
+                                        };
+                                    };
+                                    readonly theme: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                    readonly state: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                    readonly fixture: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                    readonly route: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                };
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                            };
+                        };
+                    };
+                };
+                readonly threshold: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                };
+                readonly frames: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 1000;
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["frame", "id"];
+                        readonly dependentRequired: {
+                            readonly case: readonly ["route"];
+                        };
+                        readonly properties: {
+                            readonly frame: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly id: {
+                                readonly type: "string";
+                                readonly pattern: "^[a-z0-9][a-z0-9_-]{0,63}$";
+                            };
+                            readonly route: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly case: {
+                                readonly type: "object";
+                                readonly required: readonly ["viewport", "theme", "state", "fixture"];
+                                readonly additionalProperties: false;
+                                readonly properties: {
+                                    readonly fonts: {
+                                        readonly type: "array";
+                                        readonly maxItems: 100;
+                                        readonly uniqueItems: true;
+                                        readonly items: {
+                                            readonly type: "string";
+                                            readonly minLength: 1;
+                                        };
+                                    };
+                                    readonly activeThemeIds: {
+                                        readonly type: "array";
+                                        readonly maxItems: 100;
+                                        readonly uniqueItems: true;
+                                        readonly items: {
+                                            readonly type: "string";
+                                            readonly minLength: 1;
+                                        };
+                                    };
+                                    readonly viewport: {
+                                        readonly type: "object";
+                                        readonly required: readonly ["width", "height"];
+                                        readonly additionalProperties: false;
+                                        readonly properties: {
+                                            readonly width: {
+                                                readonly type: "integer";
+                                                readonly minimum: 1;
+                                                readonly maximum: 16384;
+                                            };
+                                            readonly height: {
+                                                readonly type: "integer";
+                                                readonly minimum: 1;
+                                                readonly maximum: 16384;
+                                            };
+                                        };
+                                    };
+                                    readonly theme: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                    readonly state: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                    readonly fixture: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                        readonly maxLength: 200;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    readonly oneOf: readonly [{
+        readonly required: readonly ["profile"];
+        readonly properties: {
+            readonly profile: {
+                readonly type: "object";
+                readonly required: readonly ["type", "origin"];
+                readonly properties: {
+                    readonly type: {
+                        readonly const: "external";
+                    };
+                    readonly origin: {
+                        readonly type: "string";
+                        readonly pattern: "^https?://[^/?#]+$";
+                    };
+                };
+            };
+        };
+    }, {
+        readonly required: readonly ["penpotVersion", "ports", "directory"];
+        readonly not: {
+            readonly required: readonly ["profile"];
+        };
+        readonly properties: {
+            readonly penpotVersion: {
+                readonly type: "string";
+                readonly pattern: "^\\d+\\.\\d+(\\.\\d+)?$";
+            };
+            readonly ports: {
+                readonly type: "object";
+                readonly required: readonly ["frontend", "mail"];
+                readonly properties: {
+                    readonly frontend: {
+                        readonly type: "integer";
+                        readonly minimum: 1024;
+                        readonly maximum: 65535;
+                    };
+                    readonly mail: {
+                        readonly type: "integer";
+                        readonly minimum: 1024;
+                        readonly maximum: 65535;
+                    };
+                };
+            };
+            readonly directory: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly pattern: "^(?!/).+$";
+            };
+            readonly composeProject: {
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9][a-z0-9_-]*$";
+            };
+        };
+    }];
+};