@squiz/dx-json-schema-lib 1.21.1-alpha.5 → 1.21.1-alpha.7

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

@@ -143,6 +143,7 @@ export type CoreSchemaMetaSchema5 = {
  */
 export type SchemaArray1 = CoreSchemaMetaSchema5[];
 export type StringArray1 = string[];
+export type ImageAdditionalInfo = FileAdditionalInfo;
 export interface ComponentManifest {
     /**
      * the manifest schema version
@@ -201,6 +202,26 @@ export interface ComponentManifest {
     previews?: {
         [k: string]: PreviewDefinition;
     };
+    /**
+     * Mocked uri objects used in the preview
+     */
+    mockedUris?: {
+        /**
+         * Property for defining the mock URI object
+         */
+        [k: string]: {
+            type: 'file';
+            /**
+             * Path to uri object
+             */
+            path: string;
+            [k: string]: unknown;
+        } | {
+            type: 'inline';
+            value: MatrixAssetSchema;
+            [k: string]: unknown;
+        };
+    };
 }
 /**
  * Icon for the component in Matrix and the DXP
@@ -459,3 +480,378 @@ export interface FunctionPreviewConfiguration {
 export interface ResponseHeaders2 {
     [k: string]: string;
 }
+/**
+ * Inline URI object
+ */
+export interface MatrixAssetSchema {
+    /**
+     * The asset ID.
+     */
+    id: string;
+    /**
+     * The asset type code.
+     */
+    type: string;
+    /**
+     * The asset type friendly name.
+     */
+    type_name: string;
+    /**
+     * The asset semantic version.
+     */
+    version: string;
+    /**
+     * The asset standard field name.
+     */
+    name: string;
+    /**
+     * The asset standard field short name.
+     */
+    short_name: string;
+    /**
+     * A object representing the asset status of the asset resource.
+     */
+    status: {
+        /**
+         * The bitwise id of the asset status
+         */
+        id: 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256;
+        /**
+         * The type code of the asset status
+         */
+        code: 'archived' | 'under_construction' | 'pending_approval' | 'approved' | 'live' | 'live_approval' | 'editing' | 'editing_approval' | 'editing_approved';
+        /**
+         * The description of the asset status
+         */
+        name?: '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';
+    };
+    /**
+     * A object representing when the asset status was created.
+     */
+    created: {
+        /**
+         * The creation date of the asset in ISO 8601 format.
+         */
+        date: string | null;
+        /**
+         * The asset ID of the User that created the asset.
+         */
+        user_id: string | null;
+    };
+    /**
+     * A object representing when the asset status was last updated.
+     */
+    updated: {
+        /**
+         * The last updated date of the asset in ISO 8601 format.
+         */
+        date: string | null;
+        /**
+         * The asset ID of the User that last updated the asset.
+         */
+        user_id: string | null;
+    };
+    /**
+     * A object representing when the asset status was last published.
+     */
+    published: {
+        /**
+         * The last published date of the asset in ISO 8601 format.
+         */
+        date: string | null;
+        /**
+         * The asset ID of the User that last published the asset.
+         */
+        user_id: string | null;
+    };
+    /**
+     * A object representing when the asset status was last changed.
+     */
+    status_changed?: {
+        /**
+         * The last date the state of the asset was changed in ISO 8601 format.
+         */
+        date: string | null;
+        /**
+         * The asset ID of the User that last changed the asset status.
+         */
+        user_id: string | null;
+    };
+    /**
+     * The primary URL for the asset.
+     */
+    url: string;
+    /**
+     * All URLs for the asset including the primary URL.
+     */
+    urls: string[];
+    /**
+     * List of attributes for the asset in key-value form.
+     */
+    attributes: {
+        [k: string]: unknown;
+    };
+    /**
+     * List of metadata values in key-value form.
+     */
+    metadata?: {
+        [k: string]: string[];
+    };
+    /**
+     * The contents for the asset (excluding file assets).
+     */
+    contents?: string;
+    /**
+     * The thumbnail image associated with the asset, shows a subset data of an image or image variety.
+     */
+    thumbnail?: {
+        /**
+         * The asset ID of the Image asset of the file.
+         */
+        asset_id?: string;
+        /**
+         * The accessible URL of the thumbnail image file.
+         */
+        url?: string;
+        /**
+         * The file name of the thumbnail image.
+         */
+        file_name?: string;
+        /**
+         * The image file width in pixels.
+         */
+        width?: number;
+        /**
+         * The image file height in pixels.
+         */
+        height?: number;
+        /**
+         * The file type of the image file, generally its extension.
+         */
+        file_type?: string;
+        /**
+         * The file size in bytes
+         */
+        file_size?: number;
+        /**
+         * The file size in human readable format
+         */
+        file_size_readable?: number;
+        /**
+         * The friendly name of the file asset
+         */
+        title?: string;
+        /**
+         * The alt attribute of the Image asset
+         */
+        alt?: string;
+        [k: string]: unknown;
+    };
+    /**
+     * All direct dependent child assets of the asset in normalized asset format.
+     */
+    include_dependents?: MatrixAssetSchema1[];
+    /**
+     * Additional data of an arbitrary nature related to the requested asset, which may include derived information or special child asset information.
+     */
+    additional?: AssetAdditionalInfo | FileAdditionalInfo | ImageAdditionalInfo | CalendarEventAdditionalInfo;
+    [k: string]: unknown;
+}
+export interface MatrixAssetSchema1 {
+    /**
+     * The asset ID.
+     */
+    id: string;
+    /**
+     * The asset type code.
+     */
+    type: string;
+    /**
+     * The asset type friendly name.
+     */
+    type_name: string;
+    /**
+     * The asset semantic version.
+     */
+    version: string;
+    /**
+     * The asset standard field name.
+     */
+    name: string;
+    /**
+     * The asset standard field short name.
+     */
+    short_name: string;
+    /**
+     * A object representing the asset status of the asset resource.
+     */
+    status: {
+        /**
+         * The bitwise id of the asset status
+         */
+        id: 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256;
+        /**
+         * The type code of the asset status
+         */
+        code: 'archived' | 'under_construction' | 'pending_approval' | 'approved' | 'live' | 'live_approval' | 'editing' | 'editing_approval' | 'editing_approved';
+        /**
+         * The description of the asset status
+         */
+        name?: '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';
+    };
+    /**
+     * A object representing when the asset status was created.
+     */
+    created: {
+        /**
+         * The creation date of the asset in ISO 8601 format.
+         */
+        date: string | null;
+        /**
+         * The asset ID of the User that created the asset.
+         */
+        user_id: string | null;
+    };
+    /**
+     * A object representing when the asset status was last updated.
+     */
+    updated: {
+        /**
+         * The last updated date of the asset in ISO 8601 format.
+         */
+        date: string | null;
+        /**
+         * The asset ID of the User that last updated the asset.
+         */
+        user_id: string | null;
+    };
+    /**
+     * A object representing when the asset status was last published.
+     */
+    published: {
+        /**
+         * The last published date of the asset in ISO 8601 format.
+         */
+        date: string | null;
+        /**
+         * The asset ID of the User that last published the asset.
+         */
+        user_id: string | null;
+    };
+    /**
+     * A object representing when the asset status was last changed.
+     */
+    status_changed?: {
+        /**
+         * The last date the state of the asset was changed in ISO 8601 format.
+         */
+        date: string | null;
+        /**
+         * The asset ID of the User that last changed the asset status.
+         */
+        user_id: string | null;
+    };
+    /**
+     * The primary URL for the asset.
+     */
+    url: string;
+    /**
+     * All URLs for the asset including the primary URL.
+     */
+    urls: string[];
+    /**
+     * List of attributes for the asset in key-value form.
+     */
+    attributes: {
+        [k: string]: unknown;
+    };
+    /**
+     * List of metadata values in key-value form.
+     */
+    metadata?: {
+        [k: string]: string[];
+    };
+    /**
+     * The contents for the asset (excluding file assets).
+     */
+    contents?: string;
+    /**
+     * The thumbnail image associated with the asset, shows a subset data of an image or image variety.
+     */
+    thumbnail?: {
+        /**
+         * The asset ID of the Image asset of the file.
+         */
+        asset_id?: string;
+        /**
+         * The accessible URL of the thumbnail image file.
+         */
+        url?: string;
+        /**
+         * The file name of the thumbnail image.
+         */
+        file_name?: string;
+        /**
+         * The image file width in pixels.
+         */
+        width?: number;
+        /**
+         * The image file height in pixels.
+         */
+        height?: number;
+        /**
+         * The file type of the image file, generally its extension.
+         */
+        file_type?: string;
+        /**
+         * The file size in bytes
+         */
+        file_size?: number;
+        /**
+         * The file size in human readable format
+         */
+        file_size_readable?: number;
+        /**
+         * The friendly name of the file asset
+         */
+        title?: string;
+        /**
+         * The alt attribute of the Image asset
+         */
+        alt?: string;
+        [k: string]: unknown;
+    };
+    /**
+     * All direct dependent child assets of the asset in normalized asset format.
+     */
+    include_dependents?: MatrixAssetSchema1[];
+    /**
+     * Additional data of an arbitrary nature related to the requested asset, which may include derived information or special child asset information.
+     */
+    additional?: AssetAdditionalInfo | FileAdditionalInfo | ImageAdditionalInfo | CalendarEventAdditionalInfo;
+    [k: string]: unknown;
+}
+export interface AssetAdditionalInfo {
+    [k: string]: unknown;
+}
+export interface FileAdditionalInfo {
+    file_info?: {
+        file_name?: string;
+        size_readable?: string;
+        size_bytes?: number;
+        width?: number;
+        height?: number;
+        modified_readable?: string;
+        modified_unix?: number;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
+export interface CalendarEventAdditionalInfo {
+    event_info?: {
+        duration?: number;
+        frequency?: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}

package/lib/manifest/v1/v1.json

@@ -361,6 +361,54 @@
                     }
                 }
             }
+        },
+        "mockedUris": {
+            "type": "object",
+            "description": "Mocked uri objects used in the preview",
+            "propertyNames": {
+                "type": "string",
+                "pattern": "^[a-z0-9_\\-]+:\\/\\/"
+            },
+            "additionalProperties": {
+                "type": "object",
+                "description": "Property for defining the mock URI object",
+                "properties": {
+                    "type": {
+                        "description": "An enum of 'file' or 'inline' for how the uri object is defined",
+                        "enum": ["file", "inline"]
+                    }
+                },
+                "required": ["type"],
+                "oneOf": [
+                    {
+                        "type": "object",
+                        "properties": {
+                            "type": {
+                                "enum": ["file"]
+                            },
+                            "path": {
+                                "type": "string",
+                                "format": "uri-reference",
+                                "description": "Path to uri object"
+                            }
+                        },
+                        "required": ["type", "path"]
+                    },
+                    {
+                        "type": "object",
+                        "properties": {
+                            "type": {
+                                "enum": ["inline"]
+                            },
+                            "value": {
+                                "$ref": "MatrixAssetSchema.json",
+                                "description": "Inline URI object"
+                            }
+                        },
+                        "required": ["type", "value"]
+                    }
+                ]
+            }
         }
     },
     "required": ["name", "namespace", "displayName", "description", "version", "functions", "$schema", "mainFunction"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dx-json-schema-lib",
-  "version": "1.21.1-alpha.5",
+  "version": "1.21.1-alpha.7",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
@@ -30,5 +30,5 @@
     "json-schema-library": "7.4.5",
     "ts-brand": "0.0.2"
   },
-  "gitHead": "e29eaf410e59548e7f9969206882e512750e9472"
+  "gitHead": "3473320147ec8528a9b52c791d28ef3ec0745c97"
 }

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';
@@ -123,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);
 
@@ -143,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,
   },