@squiz/dx-json-schema-lib 1.2.13-alpha.0

package/src/errors/SchemaValidationError.ts

@@ -0,0 +1,9 @@
+import { IOutputError } from 'better-ajv-errors';
+
+export class SchemaValidationError extends Error {
+  constructor(validationErrors: IOutputError[], error?: Error) {
+    super(`failed validation: ${validationErrors.map((e) => e.error).join(', ')}`);
+    this.stack = error?.stack;
+    this.name = 'SchemaValidationError';
+  }
+}

package/src/formatted-text/v1/formattedText.json

@@ -0,0 +1,145 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "array",
+  "additionalProperties": false,
+  "title": "FormattedText",
+
+  "items": {
+    "$ref": "#/definitions/FormattedNodes"
+  },
+
+  "definitions": {
+    "FormattedNodes": {
+      "anyOf": [{ "$ref": "#/definitions/HigherOrderFormattedNodes" }, { "$ref": "#/definitions/BaseFormattedNodes" }]
+    },
+
+    "HigherOrderFormattedNodes": {
+      "anyOf": [
+        { "$ref": "#/definitions/FormattedTextLinkToMatrixAsset" },
+        { "$ref": "#/definitions/FormattedTextMatrixImage" }
+      ]
+    },
+
+    "BaseFormattedNodes": {
+      "anyOf": [{ "$ref": "#/definitions/FormattedTextTag" }, { "$ref": "#/definitions/TextNode" }]
+    },
+
+    "TextNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": { "const": "text" },
+        "value": { "type": "string" }
+      },
+      "required": ["type", "value"]
+    },
+
+    "FormattedNode": {
+      "type": "object",
+      "properties": {
+        "type": { "type": "string" },
+        "formattingOptions": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "alignment": {
+              "type": "string",
+              "enum": ["center", "left", "right", "justify"]
+            }
+          }
+        }
+      },
+      "required": ["type"],
+
+      "additionalProperties": false
+    },
+
+    "FormattedNodeWithChildren": {
+      "type": "object",
+      "additionalProperties": false,
+      "allOf": [
+        { "$ref": "#/definitions/FormattedNode" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "children": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/FormattedNodes"
+              }
+            }
+          },
+          "required": ["children"]
+        }
+      ]
+    },
+
+    "FormattedTextTag": {
+      "allOf": [
+        { "$ref": "#/definitions/FormattedNodeWithChildren" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "type": { "const": "tag" },
+            "tag": { "type": "string", "minLength": 1 },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": { "type": "string" }
+            },
+            "font": {
+              "title": "FormattedNodeFontProperties",
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "bold": { "type": "boolean" },
+                "underline": { "type": "boolean" },
+                "italics": { "type": "boolean" },
+                "color": { "type": "string" },
+                "size": { "type": "string" },
+                "fontFamily": { "type": "string" }
+              }
+            }
+          },
+          "required": ["type", "tag"]
+        }
+      ]
+    },
+
+    "FormattedTextLinkToMatrixAsset": {
+      "allOf": [
+        { "$ref": "#/definitions/FormattedNodeWithChildren" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "type": { "const": "link-to-matrix-asset" },
+            "matrixIdentifier": { "type": "string", "minLength": 1 },
+            "matrixDomain": { "type": "string", "minLength": 1 },
+            "matrixAssetId": { "type": "string", "minLength": 1 },
+            "target": { "type": "string", "enum": ["_blank", "_self", "_parent", "_top"] }
+          },
+          "required": ["type", "matrixDomain", "matrixAssetId", "target"]
+        }
+      ]
+    },
+
+    "FormattedTextMatrixImage": {
+      "allOf": [
+        { "$ref": "#/definitions/FormattedNode" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "type": { "const": "matrix-image" },
+            "matrixIdentifier": { "type": "string", "minLength": 1 },
+            "matrixDomain": { "type": "string", "minLength": 1 },
+            "matrixAssetId": { "type": "string", "minLength": 1 }
+          },
+          "required": ["type", "matrixDomain", "matrixAssetId"]
+        }
+      ]
+    }
+  }
+}

package/src/formatted-text/v1/formattedText.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type FormattedNodes = HigherOrderFormattedNodes | BaseFormattedNodes;
+export type HigherOrderFormattedNodes = FormattedTextLinkToMatrixAsset | FormattedTextMatrixImage;
+export type FormattedTextLinkToMatrixAsset = FormattedNodeWithChildren & {
+  type: 'link-to-matrix-asset';
+  matrixIdentifier?: string;
+  matrixDomain: string;
+  matrixAssetId: string;
+  target: '_blank' | '_self' | '_parent' | '_top';
+};
+export type FormattedNodeWithChildren = FormattedNode & {
+  children: FormattedNodes[];
+};
+export type FormattedTextMatrixImage = FormattedNode & {
+  type: 'matrix-image';
+  matrixIdentifier?: string;
+  matrixDomain: string;
+  matrixAssetId: string;
+};
+export type BaseFormattedNodes = FormattedTextTag | TextNode;
+export type FormattedTextTag = FormattedNodeWithChildren & {
+  type: 'tag';
+  tag: string;
+  attributes?: {
+    [k: string]: string;
+  };
+  font?: FormattedNodeFontProperties;
+};
+export type FormattedText = FormattedNodes[];
+
+export interface FormattedNode {
+  type: string;
+  formattingOptions?: {
+    alignment?: 'center' | 'left' | 'right' | 'justify';
+  };
+}
+export interface FormattedNodeFontProperties {
+  bold?: boolean;
+  underline?: boolean;
+  italics?: boolean;
+  color?: string;
+  size?: string;
+  fontFamily?: string;
+}
+export interface TextNode {
+  type: 'text';
+  value: string;
+}

package/src/formatted-text/v1/formattedTextModels.ts

@@ -0,0 +1 @@
+export * as v1 from './formattedText';

package/src/formatted-text/v1/formattedTextSchemas.ts

@@ -0,0 +1,3 @@
+import v1 from './formattedText.json';
+
+export { v1 };

package/src/index.ts

@@ -0,0 +1,10 @@
+export * as MANIFEST_MODELS from './manifest/v1/manifestModels';
+export * as MANIFEST_SCHEMAS from './manifest/v1/manifestSchemas';
+
+export * as FORMATTED_TEXT_MODELS from './formatted-text/v1/formattedTextModels';
+export * as FORMATTED_TEXT_SCHEMAS from './formatted-text/v1/formattedTextSchemas';
+
+export * as SUB_SCHEMAS from './manifest/v1/subSchemas';
+
+export * from './JsonValidationService';
+export * from './errors/SchemaValidationError';