@signstack/cli 0.1.1

package/dist/libs/signstack/base/schemas/asset.schema.json

@@ -0,0 +1,220 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://signstack.ai/schemas/asset/v1beta2",
+    "title": "SignStack Asset",
+    "description": "An Asset wraps a file (PDF, HTML, image, CSS) for use in templates. HTML Assets can reference other Assets for partials, styles, and images. All references are versioned (key@version). Each Asset version is immutable.",
+    "type": "object",
+    "required": ["apiVersion", "kind", "metadata", "spec"],
+    "additionalProperties": false,
+    "properties": {
+        "apiVersion": {
+            "type": "string",
+            "const": "signstack/v1beta2",
+            "description": "API version for the asset schema"
+        },
+        "kind": {
+            "type": "string",
+            "const": "Asset",
+            "description": "Resource type identifier"
+        },
+        "metadata": {
+            "type": "object",
+            "required": ["key", "version", "name"],
+            "additionalProperties": false,
+            "properties": {
+                "key": {
+                    "type": "string",
+                    "pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*$",
+                    "description": "Unique identifier for the asset (snake_case)",
+                    "examples": ["company_logo", "offer_letter", "corporate_theme"]
+                },
+                "version": {
+                    "type": "string",
+                    "pattern": "^(draft|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*))$",
+                    "description": "Semantic version (e.g., 1.0.0)"
+                },
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 200,
+                    "description": "Human-readable name for the asset"
+                },
+                "description": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 1000,
+                    "description": "Description of the asset"
+                },
+                "labels": {
+                    "type": "object",
+                    "propertyNames": {
+                        "pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*$"
+                    },
+                    "additionalProperties": { "type": "string" },
+                    "description": "Key-value labels for categorization"
+                }
+            }
+        },
+        "spec": {
+            "type": "object",
+            "required": ["type"],
+            "additionalProperties": false,
+            "description": "Asset specification. HTML assets can reference other versioned assets for dependencies. Use 'file' for file-based assets or 'content' for inline HTML/CSS.",
+            "properties": {
+                "type": {
+                    "type": "string",
+                    "enum": ["pdf", "html", "image", "css"],
+                    "description": "Asset type"
+                },
+                "file": {
+                    "type": "string",
+                    "description": "Relative path to the asset file",
+                    "examples": [
+                        "./offer_letter.html",
+                        "./document.pdf",
+                        "./logo.png",
+                        "./theme.css"
+                    ]
+                },
+                "fileId": {
+                    "type": "string",
+                    "pattern": "^f_[0-9a-z]{26}$",
+                    "description": "Uploaded file identifier (used by API for PDF/image assets)"
+                },
+                "content": {
+                    "type": "string",
+                    "description": "Inline content for html or css assets. Use this instead of 'file' when providing content directly."
+                },
+                "partials": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "oneOf": [
+                            {
+                                "type": "string",
+                                "pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*@(draft|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*))$"
+                            },
+                            {
+                                "type": "object",
+                                "required": ["asset"],
+                                "additionalProperties": false,
+                                "properties": {
+                                    "asset": {
+                                        "type": "string",
+                                        "pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*@(draft|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*))$",
+                                        "description": "Asset reference (key@version)"
+                                    },
+                                    "roleMap": {
+                                        "type": "object",
+                                        "additionalProperties": {
+                                            "type": "string"
+                                        },
+                                        "description": "Maps roles defined in the partial to roles in the parent context"
+                                    }
+                                }
+                            }
+                        ]
+                    },
+                    "description": "Handlebars partials. Keys are partial names used in {{> name}}. Values can be a simple asset reference (key@version) or an object with asset and roleMap."
+                },
+                "styles": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*@(draft|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*))$"
+                    },
+                    "description": "CSS asset references (key@version). Order matters for cascading."
+                },
+                "images": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string",
+                        "pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*@(draft|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*))$"
+                    },
+                    "description": "Image asset references. Keys are names used in HTML, values are asset references (key@version)."
+                },
+                "data": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "description": "Data configuration for HTML assets",
+                    "properties": {
+                        "schema": {
+                            "type": "string",
+                            "pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*@(draft|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*))$",
+                            "description": "Schema defining the data context this HTML expects (key@version). Required for HTML assets. Partials can use the same schema as parent for implicit inheritance."
+                        }
+                    },
+                    "required": ["schema"]
+                },
+                "pdfSettings": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "description": "PDF rendering settings for HTML assets",
+                    "properties": {
+                        "paperSize": {
+                            "type": "string",
+                            "enum": ["Letter", "Legal", "A4", "A3"],
+                            "default": "Letter",
+                            "description": "Paper size for PDF output"
+                        }
+                    }
+                }
+            },
+            "allOf": [
+                {
+                    "if": { "properties": { "type": { "const": "pdf" } } },
+                    "then": {
+                        "anyOf": [
+                            {
+                                "required": ["file"],
+                                "properties": {
+                                    "file": { "pattern": "\\.(pdf)$" }
+                                }
+                            },
+                            { "required": ["fileId"] }
+                        ]
+                    }
+                },
+                {
+                    "if": { "properties": { "type": { "const": "html" } } },
+                    "then": {
+                        "anyOf": [
+                            {
+                                "required": ["file"],
+                                "properties": {
+                                    "file": { "pattern": "\\.(html|hbs|handlebars)$" }
+                                }
+                            },
+                            { "required": ["content"] }
+                        ]
+                    }
+                },
+                {
+                    "if": { "properties": { "type": { "const": "image" } } },
+                    "then": {
+                        "anyOf": [
+                            {
+                                "required": ["file"],
+                                "properties": {
+                                    "file": { "pattern": "\\.(png|jpg|jpeg|gif|svg|webp)$" }
+                                }
+                            },
+                            { "required": ["fileId"] }
+                        ]
+                    }
+                },
+                {
+                    "if": { "properties": { "type": { "const": "css" } } },
+                    "then": {
+                        "anyOf": [
+                            {
+                                "required": ["file"],
+                                "properties": { "file": { "pattern": "\\.(css)$" } }
+                            },
+                            { "required": ["content"] }
+                        ]
+                    }
+                }
+            ]
+        }
+    }
+}