@squiz/dx-json-schema-lib 1.16.0 → 1.21.1-alpha.10

package/src/JsonValidationService.spec.ts

@@ -4,6 +4,7 @@ import { SchemaValidationError } from './errors/SchemaValidationError';
 import validManifest from './manifest/v1/__test__/schemas/validComponent.json';
 import validManifestJson from './manifest/v1/__test__/schemas/validComponentJson.json';
 import { FormattedText } from './formatted-text/v1/formattedText';
+import inputStringWithFormat from './manifest/v1/__test__/schemas/inputStringWithFormat.json';
 import { JSONSchema } from 'json-schema-library';
 import { PrimitiveType, ResolvableType, TypeResolver } from './jsonTypeResolution/arbitraryTypeResolution';
 
@@ -59,6 +60,11 @@ describe('JsonValidationService', () => {
         'failed validation: Invalid manifest version',
       );
     });
+
+    it('should return true for a valid manifest with a string format MatrixAssetUri', () => {
+      const result = jsonValidationService.validateManifest(inputStringWithFormat, 'v1');
+      expect(result).toBe(true);
+    });
   });
 
   describe('validateContentSchema', () => {
@@ -141,6 +147,62 @@ describe('JsonValidationService', () => {
   });
 
   describe('validateComponentInput', () => {
+    describe('matrix-asset-uri input', () => {
+      const functionInputSchema = {
+        type: 'object',
+
+        properties: {
+          'matrix-asset': { type: 'string', format: 'matrix-asset-uri', matrixAssetTypes: ['image'] },
+        },
+
+        required: ['matrix-asset'],
+      };
+      it('should return true for valid a string with matrix-asset-uri format', () => {
+        const validMatrixAssetUri = 'matrix-asset://canary.uat.matrix.squiz.cloud/abc123';
+        expect(
+          jsonValidationService.validateComponentInput(functionInputSchema, {
+            'matrix-asset': validMatrixAssetUri,
+          }),
+        ).toEqual(true);
+      });
+      it('should throw error for invalid matrix-asset-uri format', () => {
+        const invalidMatrixAssetUri = 'not-valid://canary.uat.matrix.squiz.cloud//abc123';
+        expectToThrowErrorMatchingTypeAndMessage(
+          () => {
+            jsonValidationService.validateComponentInput(functionInputSchema, {
+              'matrix-asset': invalidMatrixAssetUri,
+            });
+          },
+          SchemaValidationError,
+          `failed validation: value "not-valid://canary.uat.matrix.squiz.cloud//abc123" isn't a valid matrix asset uri`,
+        );
+      });
+      it('should throw error for invalid matrix-asset-uri type number', () => {
+        const invalidMatrixAssetUri = 1234;
+        expectToThrowErrorMatchingTypeAndMessage(
+          () => {
+            jsonValidationService.validateComponentInput(functionInputSchema, {
+              'matrix-asset': invalidMatrixAssetUri,
+            });
+          },
+          SchemaValidationError,
+          'failed validation: Expected `1234` (number) in `#/matrix-asset` to be of type `string`',
+        );
+      });
+      it('should throw error for invalid matrix-asset-uri which does not contain correct number of parts', () => {
+        const invalidMatrixAssetUri = 'matrix://';
+        expectToThrowErrorMatchingTypeAndMessage(
+          () => {
+            jsonValidationService.validateComponentInput(functionInputSchema, {
+              'matrix-asset': invalidMatrixAssetUri,
+            });
+          },
+          SchemaValidationError,
+          `failed validation: value "matrix://" isn't a valid matrix asset uri`,
+        );
+      });
+    });
+
     describe('FormattedText input', () => {
       it('should handle type as an array', () => {
         const functionInputSchema = {

package/src/JsonValidationService.ts

@@ -3,6 +3,8 @@ import JSONQuery, { Input } from '@sagold/json-query';
 import DxComponentInputSchema from './manifest/v1/DxComponentInputSchema.json';
 import DxComponentIcons from './manifest/v1/DxComponentIcons.json';
 import DxContentMetaSchema from './manifest/v1/DxContentMetaSchema.json';
+import MatrixAssetSchema from './manifest/v1/MatrixAssetSchema.json';
+
 import Draft07Schema from './manifest/v1/Draft-07.json';
 
 import FormattedText from './formatted-text/v1/formattedText.json';
@@ -13,14 +15,18 @@ import { Draft07, JSONError, JSONSchema, Draft, DraftConfig, isJSONError } from
 
 import { draft07Config } from 'json-schema-library';
 import { MANIFEST_MODELS } from '.';
+import { customFormatValidators } from './validators/customFormatValidators';
 import { AnyPrimitiveType, AnyResolvableType, TypeResolver } from './jsonTypeResolution/arbitraryTypeResolution';
 import { JsonResolutionError } from './errors/JsonResolutionError';
 
 const defaultConfig: DraftConfig = {
   ...draft07Config,
+  validateFormat: {
+    ...draft07Config.validateFormat,
+    ...customFormatValidators,
+  },
   errors: {
     ...draft07Config.errors,
-
     enumError(data) {
       let values = '[]';
 
@@ -119,6 +125,7 @@ const v1Schema = new Draft07(v1, defaultConfig);
 v1Schema.addRemoteSchema('DxComponentInputSchema.json/DxContentMetaSchema.json', DxContentMetaSchema);
 v1Schema.addRemoteSchema('/DxComponentInputSchema.json', ComponentInputSchema.getSchema());
 v1Schema.addRemoteSchema('/DxComponentIcons.json', DxComponentIcons);
+v1Schema.addRemoteSchema('/MatrixAssetSchema.json', MatrixAssetSchema);
 v1Schema.addRemoteSchema('http://json-schema.org/draft-07/schema', Draft07Schema);
 v1Schema.addRemoteSchema('http://json-schema.org/draft-07/schema#', Draft07Schema);
 
@@ -139,6 +146,7 @@ export const ManifestV1MetaSchema: MetaSchemaInput = {
     'DxComponentInputSchema.json/DxContentMetaSchema.json': DxContentMetaSchema,
     '/DxComponentInputSchema.json': DxComponentInputSchema,
     '/DxComponentIcons.json': DxComponentIcons,
+    '/MatrixAssetSchema.json': MatrixAssetSchema,
     'http://json-schema.org/draft-07/schema': Draft07Schema,
     'http://json-schema.org/draft-07/schema#': Draft07Schema,
   },

package/src/index.ts

@@ -11,4 +11,6 @@ export * from './JsonValidationService';
 export * from './errors/SchemaValidationError';
 export * from './errors/JsonResolutionError';
 
+export * from './validators/utils/matrixAssetValidator';
+
 export * from './jsonTypeResolution';

package/src/manifest/v1/DxContentMetaSchema.json

@@ -140,7 +140,34 @@
         }
       ]
     },
-    "format": { "type": "string" },
+    "format": {
+      "type": "string",
+      "enum": [
+        "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": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "$ref": "#/matrixAssetEnum"
+      }
+    },
     "contentMediaType": { "type": "string" },
     "contentEncoding": { "type": "string" },
     "if": { "$ref": "#" },
@@ -161,5 +188,93 @@
       },
       "required": ["required"]
     }
+  },
+  "matrixAssetEnum": {
+    "enum": [
+      "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"
+    ]
   }
 }

package/src/manifest/v1/MatrixAssetSchema.json

@@ -0,0 +1,371 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "MatrixAssetSchema.json",
+  "title": "Matrix asset schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The asset ID."
+    },
+    "type": {
+      "type": "string",
+      "description": "The asset type code."
+    },
+    "type_name": {
+      "type": "string",
+      "description": "The asset type friendly name."
+    },
+    "version": {
+      "type": "string",
+      "description": "The asset semantic version."
+    },
+    "name": {
+      "type": "string",
+      "description": "The asset standard field name."
+    },
+    "short_name": {
+      "type": "string",
+      "description": "The asset standard field short name."
+    },
+    "status": {
+      "type": "object",
+      "description": "A object representing the asset status of the asset resource.",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int32",
+          "description": "The bitwise id of the asset status",
+          "enum": [1, 2, 4, 8, 16, 32, 64, 128, 256]
+        },
+        "code": {
+          "type": "string",
+          "description": "The type code of the asset status",
+          "enum": [
+            "archived",
+            "under_construction",
+            "pending_approval",
+            "approved",
+            "live",
+            "live_approval",
+            "editing",
+            "editing_approval",
+            "editing_approved"
+          ]
+        },
+        "name": {
+          "type": "string",
+          "description": "The description of the asset status",
+          "enum": [
+            "Archived",
+            "Under Construction",
+            "Pending Approval",
+            "Approved To Go Live",
+            "Live",
+            "Up For Review",
+            "Safe Editing",
+            "Safe Editing Pending Approval",
+            "Safe Edit Approved To Go Live"
+          ]
+        }
+      },
+      "required": ["id", "code"]
+    },
+    "created": {
+      "type": "object",
+      "description": "A object representing when the asset status was created.",
+      "additionalProperties": false,
+      "properties": {
+        "date": {
+          "type": ["string", "null"],
+          "format": "date-time",
+          "description": "The creation date of the asset in ISO 8601 format."
+        },
+        "user_id": {
+          "type": ["string", "null"],
+          "description": "The asset ID of the User that created the asset."
+        }
+      },
+      "required": ["date", "user_id"]
+    },
+    "updated": {
+      "type": "object",
+      "description": "A object representing when the asset status was last updated.",
+      "additionalProperties": false,
+      "properties": {
+        "date": {
+          "type": ["string", "null"],
+          "format": "date-time",
+          "description": "The last updated date of the asset in ISO 8601 format."
+        },
+        "user_id": {
+          "type": ["string", "null"],
+          "description": "The asset ID of the User that last updated the asset."
+        }
+      },
+      "required": ["date", "user_id"]
+    },
+    "published": {
+      "type": "object",
+      "description": "A object representing when the asset status was last published.",
+      "additionalProperties": false,
+      "properties": {
+        "date": {
+          "type": ["string", "null"],
+          "format": "date-time",
+          "description": "The last published date of the asset in ISO 8601 format."
+        },
+        "user_id": {
+          "type": ["string", "null"],
+          "description": "The asset ID of the User that last published the asset."
+        }
+      },
+      "required": ["date", "user_id"]
+    },
+    "status_changed": {
+      "type": "object",
+      "description": "A object representing when the asset status was last changed.",
+      "additionalProperties": false,
+      "properties": {
+        "date": {
+          "type": ["string", "null"],
+          "format": "date-time",
+          "description": "The last date the state of the asset was changed in ISO 8601 format."
+        },
+        "user_id": {
+          "type": ["string", "null"],
+          "description": "The asset ID of the User that last changed the asset status."
+        }
+      },
+      "required": ["date", "user_id"]
+    },
+    "url": {
+      "type": "string",
+      "description": "The primary URL for the asset.",
+      "example": "http://mydomain.net/page"
+    },
+    "urls": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "All URLs for the asset including the primary URL.",
+      "example": ["http://mydomain.net/page", "http://seconddomain.net/blog"]
+    },
+    "attributes": {
+      "type": "object",
+      "description": "List of attributes for the asset in key-value form."
+    },
+    "metadata": {
+      "type": "object",
+      "nullable": true,
+      "additionalProperties": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      },
+      "example": {
+        "foo": ["bar1", "bar2"],
+        "bar": ["foo"]
+      },
+      "description": "List of metadata values in key-value form."
+    },
+    "contents": {
+      "type": "string",
+      "description": "The contents for the asset (excluding file assets)."
+    },
+    "thumbnail": {
+      "type": "object",
+      "nullable": true,
+      "properties": {
+        "asset_id": {
+          "type": "string",
+          "description": "The asset ID of the Image asset of the file."
+        },
+        "url": {
+          "type": "string",
+          "description": "The accessible URL of the thumbnail image file."
+        },
+        "file_name": {
+          "type": "string",
+          "description": "The file name of the thumbnail image."
+        },
+        "width": {
+          "type": "integer",
+          "description": "The image file width in pixels."
+        },
+        "height": {
+          "type": "integer",
+          "description": "The image file height in pixels."
+        },
+        "file_type": {
+          "type": "string",
+          "description": "The file type of the image file, generally its extension."
+        },
+        "file_size": {
+          "type": "integer",
+          "description": "The file size in bytes"
+        },
+        "file_size_readable": {
+          "type": "integer",
+          "description": "The file size in human readable format"
+        },
+        "title": {
+          "type": "string",
+          "description": "The friendly name of the file asset"
+        },
+        "alt": {
+          "type": "string",
+          "description": "The alt attribute of the Image asset"
+        }
+      },
+      "description": "The thumbnail image associated with the asset, shows a subset data of an image or image variety.",
+      "example": {
+        "asset_id": "42",
+        "url": "http://mydomain.net/image.png",
+        "file_name": "image.png",
+        "width": 630,
+        "height": 630,
+        "file_type": "png",
+        "file_size": 40336,
+        "file_size_readable": "39.4 KB",
+        "title": "Company Logo",
+        "alt": "A company logo image"
+      }
+    },
+    "include_dependents": {
+      "type": "array",
+      "items": {
+        "$ref": "#"
+      },
+      "description": "All direct dependent child assets of the asset in normalized asset format."
+    },
+    "additional": {
+      "description": "Additional data of an arbitrary nature related to the requested asset, which may include derived information or special child asset information.",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/AssetAdditional"
+        },
+        {
+          "$ref": "#/definitions/AssetFileAdditional"
+        },
+        {
+          "$ref": "#/definitions/AssetImageAdditional"
+        },
+        {
+          "$ref": "#/definitions/AssetCalendarEventAdditional"
+        }
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "type",
+    "type_name",
+    "version",
+    "name",
+    "short_name",
+    "status",
+    "created",
+    "updated",
+    "published",
+    "url",
+    "urls",
+    "attributes"
+  ],
+
+  "definitions": {
+    "AssetAdditional": {
+      "title": "Asset additional info",
+      "type": "object",
+      "properties": {}
+    },
+    "AssetFileAdditional": {
+      "title": "File additional info",
+      "type": "object",
+      "properties": {
+        "file_info": {
+          "type": "object",
+          "properties": {
+            "file_name": {
+              "type": "string"
+            },
+            "size_readable": {
+              "type": "string"
+            },
+            "size_bytes": {
+              "type": "integer"
+            },
+            "width": {
+              "type": "integer",
+              "nullable": true
+            },
+            "height": {
+              "type": "integer",
+              "nullable": true
+            },
+            "modified_readable": {
+              "type": "string"
+            },
+            "modified_unix": {
+              "type": "integer"
+            }
+          }
+        }
+      },
+      "example": {
+        "file_info": {
+          "file_name": "logo.png",
+          "size_readable": "6.2 MB",
+          "size_bytes": 6553070,
+          "width": 1200,
+          "height": 600,
+          "modified_readable": "Feb 3, 2023 12:26 PM",
+          "modified_unix": 1675387561
+        }
+      }
+    },
+    "AssetImageAdditional": {
+      "title": "Image additional info",
+      "properties": {
+        "varieties": {
+          "type": "array",
+          "items": {
+            "$ref": "#"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/AssetFileAdditional"
+        }
+      ]
+    },
+    "AssetCalendarEventAdditional": {
+      "title": "Calendar Event additional info",
+      "type": "object",
+      "properties": {
+        "event_info": {
+          "type": "object",
+          "properties": {
+            "duration": {
+              "type": "integer"
+            },
+            "frequency": {
+              "type": "string",
+              "nullable": true
+            }
+          }
+        }
+      },
+      "example": {
+        "event_info": {
+          "duration": 1800,
+          "frequency": "FREQ=DAILY;INTERVAL=1"
+        }
+      }
+    }
+  }
+}

package/src/manifest/v1/__test__/schemas/inputStringWithFormat.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "../../v1.json",
+  "description": "t",
+  "displayName": "t",
+  "name": "test",
+  "namespace": "other",
+  "mainFunction": "main",
+  "version": "1.0.4",
+  "environment": [],
+  "functions": [
+    {
+      "entry": "main.js",
+      "name": "main",
+      "output": {
+        "responseType": "html"
+      },
+      "input": {
+        "type": "object",
+        "properties": {
+          "prop": {
+            "type": "string",
+            "format": "matrix-asset-uri"
+          }
+        },
+        "required": []
+      }
+    }
+  ]
+}

package/src/manifest/v1/subSchemas.ts

@@ -1,5 +1,6 @@
 import DxComponentIcons from './DxComponentIcons.json';
 import DxComponentInputSchema from './DxComponentInputSchema.json';
 import DxContentMetaSchema from './DxContentMetaSchema.json';
+import MatrixAssetSchema from './MatrixAssetSchema.json';
 
-export { DxComponentIcons, DxComponentInputSchema, DxContentMetaSchema };
+export { DxComponentIcons, DxComponentInputSchema, DxContentMetaSchema, MatrixAssetSchema };