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

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/DxContentMetaSchema.json

@@ -67,7 +67,14 @@
             "type": ["number", "integer", "array", "boolean", "string"]
           }
         }
-      ]
+      ],
+      "properties": {
+        "autoReload": {
+          "type": "boolean",
+          "description": "Whether the component should automatically reload when the input is changed",
+          "default": false
+        }
+      }
     }
   },
   "type": ["object", "boolean"],

package/src/manifest/v1/JobV1.ts

@@ -14,6 +14,21 @@ export type DxComponentInputSchema = CoreSchemaMetaSchema & {
   [k: string]: unknown;
 };
 export type CoreSchemaMetaSchema = CoreSchemaMetaSchema1 & CoreSchemaMetaSchema2;
+export type UiMetadata = {
+  /**
+   * Whether the component should automatically reload when the input is changed
+   */
+  autoReload?: boolean;
+  [k: string]: unknown;
+} & (
+  | {
+      collapsedByDefault?: boolean;
+    }
+  | {
+      inlineEditable?: boolean;
+      quickOption?: boolean;
+    }
+);
 export type CoreSchemaMetaSchema2 =
   | {
       $id?: string;
@@ -30,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?: {
@@ -65,11 +80,11 @@ export type CoreSchemaMetaSchema2 =
         [k: string]: CoreSchemaMetaSchema2 | StringArray;
       };
       propertyNames?: CoreSchemaMetaSchema2;
-      const?: true;
+      const?: unknown;
       /**
        * @minItems 1
        */
-      enum?: true[];
+      enum?: unknown[];
       type?:
         | (
             | 'array'
@@ -270,39 +285,32 @@ export interface JobFunction {
 }
 export interface CoreSchemaMetaSchema1 {
   $id?: string;
-  'ui:metadata'?:
-    | {
-        collapsedByDefault?: boolean;
-      }
-    | {
-        inlineEditable?: boolean;
-        quickOption?: boolean;
-      };
+  'ui:metadata'?: UiMetadata;
   $schema?: string;
   $ref?: string;
   $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?: {
@@ -318,11 +326,11 @@ export interface CoreSchemaMetaSchema1 {
     [k: string]: CoreSchemaMetaSchema2 | StringArray;
   };
   propertyNames?: CoreSchemaMetaSchema2;
-  const?: true;
+  const?: unknown;
   /**
    * @minItems 1
    */
-  enum?: true[];
+  enum?: unknown[];
   type?:
     | (
         | 'array'

package/src/manifest/v1/v1.json

@@ -449,6 +449,15 @@
           }
         ]
       }
+    },
+    "ui:metadata": {
+      "properties": {
+        "autoReload": {
+          "type": "boolean",
+          "default": "false"
+        }
+      },
+      "required": ["autoReload"]
     }
   },
   "required": ["name", "namespace", "displayName", "description", "version", "functions", "$schema", "mainFunction"],

package/src/manifest/v1/v1.spec.ts

@@ -346,6 +346,37 @@ describe('manifest/v1', () => {
       'failed validation: Value `{"collapsedByDefault":true,"quickOption":false,"inlineEditable":true}` in `#/functions/0/input/properties/users-contact/ui:metadata` does not match any given oneof schema',
     );
   });
+  it('should allow the autoReload field on the manifest', async () => {
+    const manifest = await fetchTestManifest('validComponent.json');
+
+    expect(
+      validationService.validateManifest(
+        {
+          ...manifest,
+          'ui:metadata': {
+            autoReload: false,
+          },
+        },
+        'v1',
+      ),
+    ).toEqual(true);
+  });
+  it('autoReload is required if ui:metadata is specified on the root of the manifest', async () => {
+    const manifest = await fetchTestManifest('validComponent.json');
+    expectToThrowErrorMatchingTypeAndMessage(
+      () => {
+        validationService.validateManifest(
+          {
+            ...manifest,
+            'ui:metadata': {},
+          },
+          'v1',
+        );
+      },
+      SchemaValidationError,
+      'failed validation: The required property `autoReload` is missing at `#/ui:metadata`',
+    );
+  });
   it('should fail if ui:metadata property on object with type string has collapsedByDefault flag', async () => {
     const manifest = await fetchTestManifest('validComponent.json');
     expectToThrowErrorMatchingTypeAndMessage(

package/src/manifest/v1/v1.ts

@@ -14,6 +14,21 @@ export type DxComponentInputSchema = CoreSchemaMetaSchema & {
   [k: string]: unknown;
 };
 export type CoreSchemaMetaSchema = CoreSchemaMetaSchema1 & CoreSchemaMetaSchema2;
+export type UiMetadata = {
+  /**
+   * Whether the component should automatically reload when the input is changed
+   */
+  autoReload?: boolean;
+  [k: string]: unknown;
+} & (
+  | {
+      collapsedByDefault?: boolean;
+    }
+  | {
+      inlineEditable?: boolean;
+      quickOption?: boolean;
+    }
+);
 export type CoreSchemaMetaSchema2 =
   | {
       $id?: string;
@@ -30,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?: {
@@ -65,11 +80,11 @@ export type CoreSchemaMetaSchema2 =
         [k: string]: CoreSchemaMetaSchema2 | StringArray;
       };
       propertyNames?: CoreSchemaMetaSchema2;
-      const?: true;
+      const?: unknown;
       /**
        * @minItems 1
        */
-      enum?: true[];
+      enum?: unknown[];
       type?:
         | (
             | 'array'
@@ -223,26 +238,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?: {
@@ -258,11 +273,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')[];
@@ -369,6 +384,10 @@ export interface ComponentManifest {
           [k: string]: unknown;
         };
   };
+  'ui:metadata'?: {
+    autoReload: boolean & string;
+    [k: string]: unknown;
+  };
 }
 /**
  * Icon for the component in Matrix and the DXP
@@ -2644,39 +2663,32 @@ export interface ComponentFunction {
 }
 export interface CoreSchemaMetaSchema1 {
   $id?: string;
-  'ui:metadata'?:
-    | {
-        collapsedByDefault?: boolean;
-      }
-    | {
-        inlineEditable?: boolean;
-        quickOption?: boolean;
-      };
+  'ui:metadata'?: UiMetadata;
   $schema?: string;
   $ref?: string;
   $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?: {
@@ -2692,11 +2704,11 @@ export interface CoreSchemaMetaSchema1 {
     [k: string]: CoreSchemaMetaSchema2 | StringArray;
   };
   propertyNames?: CoreSchemaMetaSchema2;
-  const?: true;
+  const?: unknown;
   /**
    * @minItems 1
    */
-  enum?: true[];
+  enum?: unknown[];
   type?:
     | (
         | 'array'
@@ -2903,26 +2915,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?: {
@@ -2938,11 +2950,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')[];