@squiz/dx-json-schema-lib 1.77.0 → 1.78.0

package/lib/manifest/v1/v1.d.ts

@@ -37,26 +37,26 @@ export type CoreSchemaMetaSchema2 = {
     $comment?: string;
     title?: string;
     description?: string;
-    default?: true;
+    default?: unknown;
     readOnly?: boolean;
     writeOnly?: boolean;
-    examples?: true[];
+    examples?: unknown[];
     multipleOf?: number;
     maximum?: number;
     exclusiveMaximum?: number;
     minimum?: number;
     exclusiveMinimum?: number;
     maxLength?: number;
-    minLength?: number & number;
+    minLength?: number;
     pattern?: string;
     additionalItems?: CoreSchemaMetaSchema2;
     items?: CoreSchemaMetaSchema2 | SchemaArray;
     maxItems?: number;
-    minItems?: number & number;
+    minItems?: number;
     uniqueItems?: boolean;
     contains?: CoreSchemaMetaSchema2;
     maxProperties?: number;
-    minProperties?: number & number;
+    minProperties?: number;
     required?: StringArray;
     additionalProperties?: CoreSchemaMetaSchema2;
     definitions?: {
@@ -72,11 +72,11 @@ export type CoreSchemaMetaSchema2 = {
         [k: string]: CoreSchemaMetaSchema2 | StringArray;
     };
     propertyNames?: CoreSchemaMetaSchema2;
-    const?: true;
+    const?: unknown;
     /**
      * @minItems 1
      */
-    enum?: true[];
+    enum?: unknown[];
     type?: ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage' | 'SquizLink') | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage' | 'SquizLink')[];
     format?: 'date-time' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'json-pointer' | 'matrix-asset-uri' | 'multi-line' | 'password' | 'phone' | 'regex' | 'relative-json-pointer' | 'uri-reference' | 'uri-template' | 'uri' | 'uuid';
     matrixAssetTypes?: ('audioFile' | 'bodycopyContainer' | 'bodycopyDiv' | 'calendarEventsSearchPage' | 'contentContainerTemplate' | 'contentTypeMarkdown' | 'contentTypeNestContent' | 'contentTypeRawHtml' | 'contentTypeSnippet' | 'contentTypeWysiwyg' | 'cssFileFolder' | 'cssFile' | 'customForm' | 'dataRecord' | 'designAreaAssetLineage' | 'designAreaBody' | 'designAreaMenuNormal' | 'designAreaNestContent' | 'designCssCustomisation' | 'designCss' | 'designCustomisation' | 'designScss' | 'design' | 'docx' | 'excelDoc' | 'file' | 'folder' | 'gitBridge' | 'googleAnalyticsConnector' | 'googleAnalyticsView' | 'image' | 'jsFileFolder' | 'jsFile' | 'jsonWebToken' | 'layoutManager' | 'layout' | 'link' | 'metadataFieldDate' | 'metadataFieldRelatedAsset' | 'metadataFieldSelect' | 'metadataFieldText' | 'metadataFieldWysiwyg' | 'metadataSchema' | 'metadataSection' | 'newsItem' | 'oauthAccountManager' | 'pageAccountManager' | 'pageAssetListing' | 'pageCalendarEventsSearch' | 'pageCalendar' | 'pagePasswordReset' | 'pageRemoteContent' | 'pageRestResourceJs' | 'pageRestResourceOauthSession' | 'pageRestResourceOauthTwoLegged' | 'pageRestResource' | 'pageSiteMap' | 'pageStandard' | 'paintLayoutBodycopy' | 'paintLayoutPage' | 'pdfFile' | 'pdf' | 'persona' | 'powerpointDoc' | 'pptx' | 'redirectPage' | 'regex' | 'regularExpression' | 'rtfFile' | 'samlAccountManager' | 'saml2Acs' | 'saml2Sls' | 'searchPage' | 'site' | 'textFile' | 'TriggerTypes?' | 'userGroup' | 'wordDoc' | 'workflowSchema' | 'workflowStepCondition' | 'workflowStep' | 'workflowStream' | 'xlsx' | 'xmlFile')[];
@@ -103,26 +103,26 @@ export type CoreSchemaMetaSchema5 = {
     $comment?: string;
     title?: string;
     description?: string;
-    default?: true;
+    default?: unknown;
     readOnly?: boolean;
     writeOnly?: boolean;
-    examples?: true[];
+    examples?: unknown[];
     multipleOf?: number;
     maximum?: number;
     exclusiveMaximum?: number;
     minimum?: number;
     exclusiveMinimum?: number;
     maxLength?: number;
-    minLength?: number & number;
+    minLength?: number;
     pattern?: string;
     additionalItems?: CoreSchemaMetaSchema5;
     items?: CoreSchemaMetaSchema5 | SchemaArray1;
     maxItems?: number;
-    minItems?: number & number;
+    minItems?: number;
     uniqueItems?: boolean;
     contains?: CoreSchemaMetaSchema5;
     maxProperties?: number;
-    minProperties?: number & number;
+    minProperties?: number;
     required?: StringArray1;
     additionalProperties?: CoreSchemaMetaSchema5;
     definitions?: {
@@ -138,11 +138,11 @@ export type CoreSchemaMetaSchema5 = {
         [k: string]: CoreSchemaMetaSchema5 | StringArray1;
     };
     propertyNames?: CoreSchemaMetaSchema5;
-    const?: true;
+    const?: unknown;
     /**
      * @minItems 1
      */
-    enum?: true[];
+    enum?: unknown[];
     type?: ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string') | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string')[];
     format?: string;
     contentMediaType?: string;
@@ -290,26 +290,26 @@ export interface CoreSchemaMetaSchema1 {
     $comment?: string;
     title?: string;
     description?: string;
-    default?: true;
+    default?: unknown;
     readOnly?: boolean;
     writeOnly?: boolean;
-    examples?: true[];
+    examples?: unknown[];
     multipleOf?: number;
     maximum?: number;
     exclusiveMaximum?: number;
     minimum?: number;
     exclusiveMinimum?: number;
     maxLength?: number;
-    minLength?: number & number;
+    minLength?: number;
     pattern?: string;
     additionalItems?: CoreSchemaMetaSchema2;
     items?: CoreSchemaMetaSchema2 | SchemaArray;
     maxItems?: number;
-    minItems?: number & number;
+    minItems?: number;
     uniqueItems?: boolean;
     contains?: CoreSchemaMetaSchema2;
     maxProperties?: number;
-    minProperties?: number & number;
+    minProperties?: number;
     required?: StringArray;
     additionalProperties?: CoreSchemaMetaSchema2;
     definitions?: {
@@ -325,11 +325,11 @@ export interface CoreSchemaMetaSchema1 {
         [k: string]: CoreSchemaMetaSchema2 | StringArray;
     };
     propertyNames?: CoreSchemaMetaSchema2;
-    const?: true;
+    const?: unknown;
     /**
      * @minItems 1
      */
-    enum?: true[];
+    enum?: unknown[];
     type?: ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage' | 'SquizLink') | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage' | 'SquizLink')[];
     format?: 'date-time' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'json-pointer' | 'matrix-asset-uri' | 'multi-line' | 'password' | 'phone' | 'regex' | 'relative-json-pointer' | 'uri-reference' | 'uri-template' | 'uri' | 'uuid';
     matrixAssetTypes?: ('audioFile' | 'bodycopyContainer' | 'bodycopyDiv' | 'calendarEventsSearchPage' | 'contentContainerTemplate' | 'contentTypeMarkdown' | 'contentTypeNestContent' | 'contentTypeRawHtml' | 'contentTypeSnippet' | 'contentTypeWysiwyg' | 'cssFileFolder' | 'cssFile' | 'customForm' | 'dataRecord' | 'designAreaAssetLineage' | 'designAreaBody' | 'designAreaMenuNormal' | 'designAreaNestContent' | 'designCssCustomisation' | 'designCss' | 'designCustomisation' | 'designScss' | 'design' | 'docx' | 'excelDoc' | 'file' | 'folder' | 'gitBridge' | 'googleAnalyticsConnector' | 'googleAnalyticsView' | 'image' | 'jsFileFolder' | 'jsFile' | 'jsonWebToken' | 'layoutManager' | 'layout' | 'link' | 'metadataFieldDate' | 'metadataFieldRelatedAsset' | 'metadataFieldSelect' | 'metadataFieldText' | 'metadataFieldWysiwyg' | 'metadataSchema' | 'metadataSection' | 'newsItem' | 'oauthAccountManager' | 'pageAccountManager' | 'pageAssetListing' | 'pageCalendarEventsSearch' | 'pageCalendar' | 'pagePasswordReset' | 'pageRemoteContent' | 'pageRestResourceJs' | 'pageRestResourceOauthSession' | 'pageRestResourceOauthTwoLegged' | 'pageRestResource' | 'pageSiteMap' | 'pageStandard' | 'paintLayoutBodycopy' | 'paintLayoutPage' | 'pdfFile' | 'pdf' | 'persona' | 'powerpointDoc' | 'pptx' | 'redirectPage' | 'regex' | 'regularExpression' | 'rtfFile' | 'samlAccountManager' | 'saml2Acs' | 'saml2Sls' | 'searchPage' | 'site' | 'textFile' | 'TriggerTypes?' | 'userGroup' | 'wordDoc' | 'workflowSchema' | 'workflowStepCondition' | 'workflowStep' | 'workflowStream' | 'xlsx' | 'xmlFile')[];
@@ -395,26 +395,26 @@ export interface CoreSchemaMetaSchema4 {
     $comment?: string;
     title?: string;
     description?: string;
-    default?: true;
+    default?: unknown;
     readOnly?: boolean;
     writeOnly?: boolean;
-    examples?: true[];
+    examples?: unknown[];
     multipleOf?: number;
     maximum?: number;
     exclusiveMaximum?: number;
     minimum?: number;
     exclusiveMinimum?: number;
     maxLength?: number;
-    minLength?: number & number;
+    minLength?: number;
     pattern?: string;
     additionalItems?: CoreSchemaMetaSchema5;
     items?: CoreSchemaMetaSchema5 | SchemaArray1;
     maxItems?: number;
-    minItems?: number & number;
+    minItems?: number;
     uniqueItems?: boolean;
     contains?: CoreSchemaMetaSchema5;
     maxProperties?: number;
-    minProperties?: number & number;
+    minProperties?: number;
     required?: StringArray1;
     additionalProperties?: CoreSchemaMetaSchema5;
     definitions?: {
@@ -430,11 +430,11 @@ export interface CoreSchemaMetaSchema4 {
         [k: string]: CoreSchemaMetaSchema5 | StringArray1;
     };
     propertyNames?: CoreSchemaMetaSchema5;
-    const?: true;
+    const?: unknown;
     /**
      * @minItems 1
      */
-    enum?: true[];
+    enum?: unknown[];
     type?: ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string') | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string')[];
     format?: string;
     contentMediaType?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dx-json-schema-lib",
-  "version": "1.77.0",
+  "version": "1.78.0",
   "description": "",
   "main": "lib/index.js",
   "private": false,
@@ -23,7 +23,7 @@
     "@types/node": "20.12.12",
     "dotenv": "16.0.3",
     "jest": "29.4.1",
-    "json-schema-to-typescript": "11.0.3",
+    "json-schema-to-typescript": "14.1.0",
     "rimraf": "5.0.7",
     "ts-jest": "29.0.5",
     "ts-loader": "9.3.1",

package/src/JsonValidationService.spec.ts

@@ -1060,6 +1060,178 @@ describe('JsonSchemaService', () => {
 
       expect(jsonSchemaService.validateInput({ 'my-input': [] }, schema)).toEqual(true);
     });
+
+    it.each([
+      ['with attributes', { title: 'Link title' }],
+      ['without attributes', undefined],
+    ])('should validate link-to-matrix-asset - %s', (_: string, attributes?: Record<string, string>) => {
+      const formattedText: FormattedText = [
+        {
+          type: 'link-to-matrix-asset',
+          matrixIdentifier: 'matrix-identifier',
+          matrixDomain: 'https://matrix-api-url',
+          target: '_blank',
+          matrixAssetId: '12345',
+          children: [{ type: 'text', value: 'hello' }],
+          attributes,
+        },
+      ];
+      const schema = {
+        type: 'object',
+        properties: {
+          myInput: {
+            type: 'FormattedText',
+          },
+        },
+      };
+      const value = {
+        myInput: formattedText,
+      };
+
+      expect(jsonSchemaService.validateInput(value, schema)).toBe(true);
+    });
+
+    it('should throw if link-to-matrix-asset contains a reserved attribute', () => {
+      const formattedText: FormattedText = [
+        {
+          type: 'link-to-matrix-asset',
+          matrixIdentifier: 'matrix-identifier',
+          matrixDomain: 'https://matrix-api-url',
+          target: '_blank',
+          matrixAssetId: '12345',
+          children: [{ type: 'text', value: 'hello' }],
+          attributes: {
+            // href is reserved (resolved from the selected Matrix asset)
+            href: 'https://www.my-matrix.squiz.net',
+          } as any,
+        },
+      ];
+      const schema = {
+        type: 'object',
+        properties: {
+          myInput: {
+            type: 'FormattedText',
+          },
+        },
+      };
+      const value = {
+        myInput: formattedText,
+      };
+
+      expect(() => jsonSchemaService.validateInput(value, schema)).toThrow(/does not match any given oneof schema/);
+    });
+
+    it.each([
+      ['with attributes', { title: 'Link title' }],
+      ['without attributes', undefined],
+    ])('should validate matrix-image - %s', (_: string, attributes?: Record<string, string>) => {
+      const formattedText: FormattedText = [
+        {
+          type: 'matrix-image',
+          matrixIdentifier: 'matrix-identifier',
+          matrixDomain: 'https://matrix-api-url',
+          matrixAssetId: '12345',
+          attributes,
+        },
+      ];
+      const schema = {
+        type: 'object',
+        properties: {
+          myInput: {
+            type: 'FormattedText',
+          },
+        },
+      };
+      const value = {
+        myInput: formattedText,
+      };
+
+      expect(jsonSchemaService.validateInput(value, schema)).toBe(true);
+    });
+
+    it('should throw if matrix-image contains a reserved attribute', () => {
+      const formattedText: FormattedText = [
+        {
+          type: 'matrix-image',
+          matrixIdentifier: 'matrix-identifier',
+          matrixDomain: 'https://matrix-api-url',
+          matrixAssetId: '12345',
+          attributes: {
+            // src is reserved (resolved from the selected Matrix asset)
+            src: 'https://www.my-matrix.squiz.net/image.png',
+          } as any,
+        },
+      ];
+      const schema = {
+        type: 'object',
+        properties: {
+          myInput: {
+            type: 'FormattedText',
+          },
+        },
+      };
+      const value = {
+        myInput: formattedText,
+      };
+
+      expect(() => jsonSchemaService.validateInput(value, schema)).toThrow(/does not match any given oneof schema/);
+    });
+
+    it.each([
+      ['with attributes', { title: 'Link title' }],
+      ['without attributes', undefined],
+    ])('should validate dam-image - %s', (_: string, attributes?: Record<string, string>) => {
+      const formattedText: FormattedText = [
+        {
+          type: 'dam-image',
+          damSystemIdentifier: 'dam-identifier',
+          damObjectId: '12345',
+          damSystemType: 'bynder',
+          attributes,
+        },
+      ];
+      const schema = {
+        type: 'object',
+        properties: {
+          myInput: {
+            type: 'FormattedText',
+          },
+        },
+      };
+      const value = {
+        myInput: formattedText,
+      };
+
+      expect(jsonSchemaService.validateInput(value, schema)).toBe(true);
+    });
+
+    it('should throw if dam-image contains a reserved attribute', () => {
+      const formattedText: FormattedText = [
+        {
+          type: 'dam-image',
+          damSystemIdentifier: 'dam-identifier',
+          damObjectId: '12345',
+          damSystemType: 'bynder',
+          attributes: {
+            // src is reserved (resolved from the selected DAM asset)
+            src: 'https://www.my-matrix.squiz.net/image.png',
+          } as any,
+        },
+      ];
+      const schema = {
+        type: 'object',
+        properties: {
+          myInput: {
+            type: 'FormattedText',
+          },
+        },
+      };
+      const value = {
+        myInput: formattedText,
+      };
+
+      expect(() => jsonSchemaService.validateInput(value, schema)).toThrow(/does not match any given oneof schema/);
+    });
   });
 
   describe('standard inputs', () => {

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

@@ -145,7 +145,24 @@
         "matrixIdentifier": { "type": "string", "minLength": 1 },
         "matrixDomain": { "type": "string", "minLength": 1 },
         "matrixAssetId": { "type": "string", "minLength": 1 },
-        "target": { "type": "string", "enum": ["_blank", "_self", "_parent", "_top"] }
+        "target": { "type": "string", "enum": ["_blank", "_self", "_parent", "_top"] },
+        "attributes": {
+          "allOf": [
+            {
+              "type": "object",
+              "properties": {
+                "href": false,
+                "target": false
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            }
+          ]
+        }
       },
       "required": ["type", "matrixDomain", "matrixAssetId", "target", "children"]
     },
@@ -159,7 +176,23 @@
         "matrixIdentifier": { "type": "string", "minLength": 1 },
         "matrixDomain": { "type": "string", "minLength": 1 },
         "matrixAssetId": { "type": "string", "minLength": 1 },
-        "formattingOptions": { "$ref": "#/definitions/FormattingOptions" }
+        "formattingOptions": { "$ref": "#/definitions/FormattingOptions" },
+        "attributes": {
+          "allOf": [
+            {
+              "type": "object",
+              "properties": {
+                "src": false
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            }
+          ]
+        }
       },
       "required": ["type", "matrixDomain", "matrixAssetId"]
     },
@@ -174,7 +207,23 @@
         "damSystemIdentifier": { "type": "string", "minLength": 1 },
         "damObjectId": { "type": "string", "minLength": 1 },
         "damAdditional": { "type": "object", "properties": { "variant": { "type": "string", "minLength": 1 } } },
-        "formattingOptions": { "$ref": "#/definitions/FormattingOptions" }
+        "formattingOptions": { "$ref": "#/definitions/FormattingOptions" },
+        "attributes": {
+          "allOf": [
+            {
+              "type": "object",
+              "properties": {
+                "src": false
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            }
+          ]
+        }
       },
       "required": ["type", "damSystemType", "damSystemIdentifier", "damObjectId"]
     }

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

@@ -22,6 +22,13 @@ export interface FormattedTextLinkToMatrixAsset {
   matrixDomain: string;
   matrixAssetId: string;
   target: '_blank' | '_self' | '_parent' | '_top';
+  attributes?: {
+    href?: never;
+    target?: never;
+    [k: string]: unknown;
+  } & {
+    [k: string]: string;
+  };
 }
 export interface FormattingOptions {
   alignment?: 'center' | 'left' | 'right' | 'justify';
@@ -33,6 +40,12 @@ export interface FormattedTextMatrixImage {
   matrixDomain: string;
   matrixAssetId: string;
   formattingOptions?: FormattingOptions;
+  attributes?: {
+    src?: never;
+    [k: string]: unknown;
+  } & {
+    [k: string]: string;
+  };
 }
 export interface FormattedTextDamImage {
   type: 'dam-image';
@@ -44,6 +57,12 @@ export interface FormattedTextDamImage {
     [k: string]: unknown;
   };
   formattingOptions?: FormattingOptions;
+  attributes?: {
+    src?: never;
+    [k: string]: unknown;
+  } & {
+    [k: string]: string;
+  };
 }
 export interface FormattedTextTag {
   children?: WithChildrenNode;

package/src/manifest/v1/JobV1.ts

@@ -45,26 +45,26 @@ export type CoreSchemaMetaSchema2 =
       $comment?: string;
       title?: string;
       description?: string;
-      default?: true;
+      default?: unknown;
       readOnly?: boolean;
       writeOnly?: boolean;
-      examples?: true[];
+      examples?: unknown[];
       multipleOf?: number;
       maximum?: number;
       exclusiveMaximum?: number;
       minimum?: number;
       exclusiveMinimum?: number;
       maxLength?: number;
-      minLength?: number & number;
+      minLength?: number;
       pattern?: string;
       additionalItems?: CoreSchemaMetaSchema2;
       items?: CoreSchemaMetaSchema2 | SchemaArray;
       maxItems?: number;
-      minItems?: number & number;
+      minItems?: number;
       uniqueItems?: boolean;
       contains?: CoreSchemaMetaSchema2;
       maxProperties?: number;
-      minProperties?: number & number;
+      minProperties?: number;
       required?: StringArray;
       additionalProperties?: CoreSchemaMetaSchema2;
       definitions?: {
@@ -80,11 +80,11 @@ export type CoreSchemaMetaSchema2 =
         [k: string]: CoreSchemaMetaSchema2 | StringArray;
       };
       propertyNames?: CoreSchemaMetaSchema2;
-      const?: true;
+      const?: unknown;
       /**
        * @minItems 1
        */
-      enum?: true[];
+      enum?: unknown[];
       type?:
         | (
             | 'array'
@@ -291,26 +291,26 @@ export interface CoreSchemaMetaSchema1 {
   $comment?: string;
   title?: string;
   description?: string;
-  default?: true;
+  default?: unknown;
   readOnly?: boolean;
   writeOnly?: boolean;
-  examples?: true[];
+  examples?: unknown[];
   multipleOf?: number;
   maximum?: number;
   exclusiveMaximum?: number;
   minimum?: number;
   exclusiveMinimum?: number;
   maxLength?: number;
-  minLength?: number & number;
+  minLength?: number;
   pattern?: string;
   additionalItems?: CoreSchemaMetaSchema2;
   items?: CoreSchemaMetaSchema2 | SchemaArray;
   maxItems?: number;
-  minItems?: number & number;
+  minItems?: number;
   uniqueItems?: boolean;
   contains?: CoreSchemaMetaSchema2;
   maxProperties?: number;
-  minProperties?: number & number;
+  minProperties?: number;
   required?: StringArray;
   additionalProperties?: CoreSchemaMetaSchema2;
   definitions?: {
@@ -326,11 +326,11 @@ export interface CoreSchemaMetaSchema1 {
     [k: string]: CoreSchemaMetaSchema2 | StringArray;
   };
   propertyNames?: CoreSchemaMetaSchema2;
-  const?: true;
+  const?: unknown;
   /**
    * @minItems 1
    */
-  enum?: true[];
+  enum?: unknown[];
   type?:
     | (
         | 'array'