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

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

@@ -14,6 +14,12 @@ export type DxComponentInputSchema = CoreSchemaMetaSchema & {
 export type CoreSchemaMetaSchema = CoreSchemaMetaSchema1 & CoreSchemaMetaSchema2;
 export type CoreSchemaMetaSchema2 = {
     $id?: string;
+    'ui:metadata'?: {
+        collapsedByDefault?: boolean;
+    } | {
+        inlineEditable?: boolean;
+        quickOption?: boolean;
+    };
     $schema?: string;
     $ref?: string;
     $comment?: string;
@@ -262,6 +268,12 @@ export interface ComponentFunction {
 }
 export interface CoreSchemaMetaSchema1 {
     $id?: string;
+    'ui:metadata'?: {
+        collapsedByDefault?: boolean;
+    } | {
+        inlineEditable?: boolean;
+        quickOption?: boolean;
+    };
     $schema?: string;
     $ref?: string;
     $comment?: string;

package/lib/manifest/v1/v1.spec.js

@@ -108,5 +108,234 @@ describe('manifest/v1', () => {
             }, 'v1');
         }, SchemaValidationError_1.SchemaValidationError, 'failed validation: Invalid property name `Bad-@@@Preview` at `#/previews`');
     });
+    it('should allow ui:metadata property object on input', async () => {
+        const manifest = await fetchTestManifest('validComponent.json');
+        expect(validationService.validateManifest({
+            ...manifest,
+            functions: [
+                {
+                    name: 'main',
+                    entry: 'main.js',
+                    output: {
+                        responseType: 'html',
+                    },
+                    input: {
+                        type: 'object',
+                        properties: {
+                            'users-contact': {
+                                type: 'object',
+                                description: 'A description of group can be provided if needed',
+                                required: ['fist-name', 'last-name', 'phone-number', 'email'],
+                                'ui:metadata': {
+                                    collapsedByDefault: true,
+                                },
+                                properties: {
+                                    'fist-name': {
+                                        type: 'string',
+                                        'ui:metadata': {
+                                            inlineEditable: true,
+                                            quickOption: false,
+                                        },
+                                    },
+                                    'last-name': {
+                                        type: 'string',
+                                        'ui:metadata': {
+                                            inlineEditable: true,
+                                            quickOption: false,
+                                        },
+                                    },
+                                    'phone-number': {
+                                        type: 'number',
+                                        'ui:metadata': {
+                                            inlineEditable: true,
+                                            quickOption: false,
+                                        },
+                                    },
+                                    email: {
+                                        type: 'string',
+                                        'ui:metadata': {
+                                            inlineEditable: true,
+                                            quickOption: false,
+                                        },
+                                    },
+                                },
+                            },
+                            'next-of-kin': {
+                                type: 'object',
+                                'ui:metadata': {
+                                    collapsedByDefault: true,
+                                },
+                                required: ['fist-name', 'last-name', 'phone-number', 'email'],
+                                properties: {
+                                    'fist-name': {
+                                        type: 'string',
+                                        'ui:metadata': {
+                                            inlineEditable: true,
+                                            quickOption: false,
+                                        },
+                                    },
+                                    'last-name': {
+                                        type: 'string',
+                                        'ui:metadata': {
+                                            inlineEditable: true,
+                                            quickOption: false,
+                                        },
+                                    },
+                                    'phone-number': {
+                                        type: 'number',
+                                        'ui:metadata': {
+                                            inlineEditable: true,
+                                            quickOption: false,
+                                        },
+                                    },
+                                    email: {
+                                        type: 'string',
+                                        'ui:metadata': {
+                                            inlineEditable: true,
+                                            quickOption: false,
+                                        },
+                                    },
+                                },
+                            },
+                            'text-position': {
+                                type: 'string',
+                                enum: ['left', 'right'],
+                                'ui:metadata': {
+                                    inlineEditable: false,
+                                    quickOption: true,
+                                },
+                            },
+                        },
+                        required: ['users-contact', 'next-of-kin'],
+                    },
+                },
+            ],
+        }, 'v1')).toEqual(true);
+    });
+    it('should fail if ui:metadata property object on object input group has flags other than collapsedByDefault', async () => {
+        const manifest = await fetchTestManifest('validComponent.json');
+        expectToThrowErrorMatchingTypeAndMessage(() => {
+            validationService.validateManifest({
+                ...manifest,
+                functions: [
+                    {
+                        name: 'main',
+                        entry: 'main.js',
+                        output: {
+                            responseType: 'html',
+                        },
+                        input: {
+                            type: 'object',
+                            properties: {
+                                'users-contact': {
+                                    type: 'object',
+                                    description: 'A description of group can be provided if needed',
+                                    required: ['fist-name', 'last-name', 'phone-number', 'email'],
+                                    'ui:metadata': {
+                                        collapsedByDefault: true,
+                                        quickOption: false,
+                                        inlineEditable: true,
+                                    },
+                                    properties: {
+                                        'fist-name': {
+                                            type: 'string',
+                                            'ui:metadata': {
+                                                inlineEditable: true,
+                                                quickOption: false,
+                                            },
+                                        },
+                                        'last-name': {
+                                            type: 'string',
+                                            'ui:metadata': {
+                                                inlineEditable: true,
+                                                quickOption: false,
+                                            },
+                                        },
+                                        'phone-number': {
+                                            type: 'number',
+                                            'ui:metadata': {
+                                                inlineEditable: true,
+                                                quickOption: false,
+                                            },
+                                        },
+                                        email: {
+                                            type: 'string',
+                                            'ui:metadata': {
+                                                inlineEditable: true,
+                                                quickOption: false,
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                            required: ['users-contact'],
+                        },
+                    },
+                ],
+            }, 'v1');
+        }, SchemaValidationError_1.SchemaValidationError, '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 fail if ui:metadata property on object with type string has collapsedByDefault flag', async () => {
+        const manifest = await fetchTestManifest('validComponent.json');
+        expectToThrowErrorMatchingTypeAndMessage(() => {
+            validationService.validateManifest({
+                ...manifest,
+                functions: [
+                    {
+                        name: 'main',
+                        entry: 'main.js',
+                        output: {
+                            responseType: 'html',
+                        },
+                        input: {
+                            type: 'object',
+                            properties: {
+                                'users-contact': {
+                                    type: 'object',
+                                    description: 'A description of group can be provided if needed',
+                                    required: ['fist-name', 'last-name', 'phone-number', 'email'],
+                                    'ui:metadata': {
+                                        collapsedByDefault: true,
+                                    },
+                                    properties: {
+                                        'fist-name': {
+                                            type: 'string',
+                                            'ui:metadata': {
+                                                inlineEditable: true,
+                                                quickOption: false,
+                                                collapsedByDefault: true,
+                                            },
+                                        },
+                                        'last-name': {
+                                            type: 'string',
+                                            'ui:metadata': {
+                                                inlineEditable: true,
+                                                quickOption: false,
+                                            },
+                                        },
+                                        'phone-number': {
+                                            type: 'number',
+                                            'ui:metadata': {
+                                                inlineEditable: true,
+                                                quickOption: false,
+                                            },
+                                        },
+                                        email: {
+                                            type: 'string',
+                                            'ui:metadata': {
+                                                inlineEditable: true,
+                                                quickOption: false,
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                            required: ['users-contact'],
+                        },
+                    },
+                ],
+            }, 'v1');
+        }, SchemaValidationError_1.SchemaValidationError, 'failed validation: Value `{"inlineEditable":true,"quickOption":false,"collapsedByDefault":true}` in `#/functions/0/input/properties/users-contact/properties/fist-name/ui:metadata` does not match any given oneof schema');
+    });
 });
 //# sourceMappingURL=v1.spec.js.map

package/lib/manifest/v1/v1.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"v1.spec.js","sourceRoot":"","sources":["../../../src/manifest/v1/v1.spec.ts"],"names":[],"mappings":";;AAAA,0CAAuC;AACvC,+BAA+B;AAC/B,8EAA2E;AAC3E,uEAAoE;AAEpE,MAAM,YAAY,GAAG,sBAAsB,CAAC;AAE5C,KAAK,UAAU,iBAAiB,CAAC,QAAgB;IAC/C,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAA,cAAO,EAAC,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE;QACnF,QAAQ,EAAE,OAAO;KAClB,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AACD,wDAAwD;AACxD,SAAS,wCAAwC,CAAC,QAAkB,EAAE,SAAmB,EAAE,OAAe;IACxG,IAAI,KAAK,GAAiB,IAAI,CAAC;IAE/B,IAAI;QACF,QAAQ,EAAE,CAAC;KACZ;IAAC,OAAO,CAAM,EAAE;QACf,KAAK,GAAG,CAAC,CAAC;KACX;IAED,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5B,MAAM,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;AAC1C,CAAC;AAED,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,iBAAwC,CAAC;IAE7C,SAAS,CAAC,GAAG,EAAE;QACb,iBAAiB,GAAG,IAAI,6CAAqB,EAAE,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAChE,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,gCAAgC,CAAC,CAAC;QAE3E,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC,EACD,6CAAqB,EACrB,sHAAsH,CACvH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;QAExE,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC,EACD,6CAAqB,EACrB,+HAA+H,CAChI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,sCAAsC,CAAC,CAAC;QACjF,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC,EACD,6CAAqB,EACrB,6GAA6G,CAC9G,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CACrE,sCAAsC,EACtC,CAAC,aAAa,EAAE,EAAE;QAChB,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,8CAA8C,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;YACpG,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;YAEhE,wCAAwC,CACtC,GAAG,EAAE;gBACH,iBAAiB,CAAC,gBAAgB,CAChC;oBACE,GAAG,QAAQ;oBACX,CAAC,YAAY,CAAC,EAAE,aAAa;iBAC9B,EACD,IAAI,CACL,CAAC;YACJ,CAAC,EACD,6CAAqB,EACrB,mCAAmC,YAAY,qBAAqB,YAAY,sBAAsB,aAAa,IAAI,CACxH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;YAEhE,wCAAwC,CACtC,GAAG,EAAE;gBACH,iBAAiB,CAAC,gBAAgB,CAChC;oBACE,GAAG,QAAQ;oBACX,SAAS,EAAE;wBACT;4BACE,IAAI,EAAE,aAAa;4BACnB,KAAK,EAAE,SAAS;4BAChB,KAAK,EAAE,EAAE;4BACT,MAAM,EAAE;gCACN,YAAY,EAAE,MAAM;6BACrB;yBACF;qBACF;iBACF,EACD,IAAI,CACL,CAAC;YACJ,CAAC,EACD,6CAAqB,EACrB,qEAAqE,YAAY,sBAAsB,aAAa,IAAI,CACzH,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAEhE,MAAM,CACJ,iBAAiB,CAAC,gBAAgB,CAChC;YACE,GAAG,QAAQ;YACX,QAAQ,EAAE;gBACR,YAAY,EAAE;oBACZ,YAAY,EAAE;wBACZ,IAAI,EAAE,EAAE;qBACT;iBACF;aACF;SACF,EACD,IAAI,CACL,CACF,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAEhE,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAChC;gBACE,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACR,gBAAgB,EAAE;wBAChB,YAAY,EAAE;4BACZ,IAAI,EAAE,EAAE;yBACT;qBACF;iBACF;aACF,EACD,IAAI,CACL,CAAC;QACJ,CAAC,EACD,6CAAqB,EACrB,2EAA2E,CAC5E,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"v1.spec.js","sourceRoot":"","sources":["../../../src/manifest/v1/v1.spec.ts"],"names":[],"mappings":";;AAAA,0CAAuC;AACvC,+BAA+B;AAC/B,8EAA2E;AAC3E,uEAAoE;AAEpE,MAAM,YAAY,GAAG,sBAAsB,CAAC;AAE5C,KAAK,UAAU,iBAAiB,CAAC,QAAgB;IAC/C,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAA,cAAO,EAAC,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE;QACnF,QAAQ,EAAE,OAAO;KAClB,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AACD,wDAAwD;AACxD,SAAS,wCAAwC,CAAC,QAAkB,EAAE,SAAmB,EAAE,OAAe;IACxG,IAAI,KAAK,GAAiB,IAAI,CAAC;IAE/B,IAAI;QACF,QAAQ,EAAE,CAAC;KACZ;IAAC,OAAO,CAAM,EAAE;QACf,KAAK,GAAG,CAAC,CAAC;KACX;IAED,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5B,MAAM,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;AAC1C,CAAC;AAED,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,iBAAwC,CAAC;IAE7C,SAAS,CAAC,GAAG,EAAE;QACb,iBAAiB,GAAG,IAAI,6CAAqB,EAAE,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAChE,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,gCAAgC,CAAC,CAAC;QAE3E,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC,EACD,6CAAqB,EACrB,sHAAsH,CACvH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,6BAA6B,CAAC,CAAC;QAExE,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC,EACD,6CAAqB,EACrB,+HAA+H,CAChI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,sCAAsC,CAAC,CAAC;QACjF,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC,EACD,6CAAqB,EACrB,6GAA6G,CAC9G,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CACrE,sCAAsC,EACtC,CAAC,aAAa,EAAE,EAAE;QAChB,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,8CAA8C,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;YACpG,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;YAEhE,wCAAwC,CACtC,GAAG,EAAE;gBACH,iBAAiB,CAAC,gBAAgB,CAChC;oBACE,GAAG,QAAQ;oBACX,CAAC,YAAY,CAAC,EAAE,aAAa;iBAC9B,EACD,IAAI,CACL,CAAC;YACJ,CAAC,EACD,6CAAqB,EACrB,mCAAmC,YAAY,qBAAqB,YAAY,sBAAsB,aAAa,IAAI,CACxH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;YAEhE,wCAAwC,CACtC,GAAG,EAAE;gBACH,iBAAiB,CAAC,gBAAgB,CAChC;oBACE,GAAG,QAAQ;oBACX,SAAS,EAAE;wBACT;4BACE,IAAI,EAAE,aAAa;4BACnB,KAAK,EAAE,SAAS;4BAChB,KAAK,EAAE,EAAE;4BACT,MAAM,EAAE;gCACN,YAAY,EAAE,MAAM;6BACrB;yBACF;qBACF;iBACF,EACD,IAAI,CACL,CAAC;YACJ,CAAC,EACD,6CAAqB,EACrB,qEAAqE,YAAY,sBAAsB,aAAa,IAAI,CACzH,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAEhE,MAAM,CACJ,iBAAiB,CAAC,gBAAgB,CAChC;YACE,GAAG,QAAQ;YACX,QAAQ,EAAE;gBACR,YAAY,EAAE;oBACZ,YAAY,EAAE;wBACZ,IAAI,EAAE,EAAE;qBACT;iBACF;aACF;SACF,EACD,IAAI,CACL,CACF,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAEhE,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAChC;gBACE,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACR,gBAAgB,EAAE;wBAChB,YAAY,EAAE;4BACZ,IAAI,EAAE,EAAE;yBACT;qBACF;iBACF;aACF,EACD,IAAI,CACL,CAAC;QACJ,CAAC,EACD,6CAAqB,EACrB,2EAA2E,CAC5E,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAChE,MAAM,CACJ,iBAAiB,CAAC,gBAAgB,CAChC;YACE,GAAG,QAAQ;YACX,SAAS,EAAE;gBACT;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,SAAS;oBAChB,MAAM,EAAE;wBACN,YAAY,EAAE,MAAM;qBACrB;oBACD,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,eAAe,EAAE;gCACf,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,kDAAkD;gCAC/D,QAAQ,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC;gCAC7D,aAAa,EAAE;oCACb,kBAAkB,EAAE,IAAI;iCACzB;gCACD,UAAU,EAAE;oCACV,WAAW,EAAE;wCACX,IAAI,EAAE,QAAQ;wCACd,aAAa,EAAE;4CACb,cAAc,EAAE,IAAI;4CACpB,WAAW,EAAE,KAAK;yCACnB;qCACF;oCACD,WAAW,EAAE;wCACX,IAAI,EAAE,QAAQ;wCACd,aAAa,EAAE;4CACb,cAAc,EAAE,IAAI;4CACpB,WAAW,EAAE,KAAK;yCACnB;qCACF;oCACD,cAAc,EAAE;wCACd,IAAI,EAAE,QAAQ;wCACd,aAAa,EAAE;4CACb,cAAc,EAAE,IAAI;4CACpB,WAAW,EAAE,KAAK;yCACnB;qCACF;oCACD,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,aAAa,EAAE;4CACb,cAAc,EAAE,IAAI;4CACpB,WAAW,EAAE,KAAK;yCACnB;qCACF;iCACF;6BACF;4BACD,aAAa,EAAE;gCACb,IAAI,EAAE,QAAQ;gCACd,aAAa,EAAE;oCACb,kBAAkB,EAAE,IAAI;iCACzB;gCACD,QAAQ,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC;gCAC7D,UAAU,EAAE;oCACV,WAAW,EAAE;wCACX,IAAI,EAAE,QAAQ;wCACd,aAAa,EAAE;4CACb,cAAc,EAAE,IAAI;4CACpB,WAAW,EAAE,KAAK;yCACnB;qCACF;oCACD,WAAW,EAAE;wCACX,IAAI,EAAE,QAAQ;wCACd,aAAa,EAAE;4CACb,cAAc,EAAE,IAAI;4CACpB,WAAW,EAAE,KAAK;yCACnB;qCACF;oCACD,cAAc,EAAE;wCACd,IAAI,EAAE,QAAQ;wCACd,aAAa,EAAE;4CACb,cAAc,EAAE,IAAI;4CACpB,WAAW,EAAE,KAAK;yCACnB;qCACF;oCACD,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,aAAa,EAAE;4CACb,cAAc,EAAE,IAAI;4CACpB,WAAW,EAAE,KAAK;yCACnB;qCACF;iCACF;6BACF;4BACD,eAAe,EAAE;gCACf,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;gCACvB,aAAa,EAAE;oCACb,cAAc,EAAE,KAAK;oCACrB,WAAW,EAAE,IAAI;iCAClB;6BACF;yBACF;wBACD,QAAQ,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC;qBAC3C;iBACF;aACF;SACF,EACD,IAAI,CACL,CACF,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0GAA0G,EAAE,KAAK,IAAI,EAAE;QACxH,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAChE,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAChC;gBACE,GAAG,QAAQ;gBACX,SAAS,EAAE;oBACT;wBACE,IAAI,EAAE,MAAM;wBACZ,KAAK,EAAE,SAAS;wBAChB,MAAM,EAAE;4BACN,YAAY,EAAE,MAAM;yBACrB;wBACD,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,eAAe,EAAE;oCACf,IAAI,EAAE,QAAQ;oCACd,WAAW,EAAE,kDAAkD;oCAC/D,QAAQ,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC;oCAC7D,aAAa,EAAE;wCACb,kBAAkB,EAAE,IAAI;wCACxB,WAAW,EAAE,KAAK;wCAClB,cAAc,EAAE,IAAI;qCACrB;oCACD,UAAU,EAAE;wCACV,WAAW,EAAE;4CACX,IAAI,EAAE,QAAQ;4CACd,aAAa,EAAE;gDACb,cAAc,EAAE,IAAI;gDACpB,WAAW,EAAE,KAAK;6CACnB;yCACF;wCACD,WAAW,EAAE;4CACX,IAAI,EAAE,QAAQ;4CACd,aAAa,EAAE;gDACb,cAAc,EAAE,IAAI;gDACpB,WAAW,EAAE,KAAK;6CACnB;yCACF;wCACD,cAAc,EAAE;4CACd,IAAI,EAAE,QAAQ;4CACd,aAAa,EAAE;gDACb,cAAc,EAAE,IAAI;gDACpB,WAAW,EAAE,KAAK;6CACnB;yCACF;wCACD,KAAK,EAAE;4CACL,IAAI,EAAE,QAAQ;4CACd,aAAa,EAAE;gDACb,cAAc,EAAE,IAAI;gDACpB,WAAW,EAAE,KAAK;6CACnB;yCACF;qCACF;iCACF;6BACF;4BACD,QAAQ,EAAE,CAAC,eAAe,CAAC;yBAC5B;qBACF;iBACF;aACF,EACD,IAAI,CACL,CAAC;QACJ,CAAC,EACD,6CAAqB,EACrB,sMAAsM,CACvM,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;QAC1G,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAChE,wCAAwC,CACtC,GAAG,EAAE;YACH,iBAAiB,CAAC,gBAAgB,CAChC;gBACE,GAAG,QAAQ;gBACX,SAAS,EAAE;oBACT;wBACE,IAAI,EAAE,MAAM;wBACZ,KAAK,EAAE,SAAS;wBAChB,MAAM,EAAE;4BACN,YAAY,EAAE,MAAM;yBACrB;wBACD,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,eAAe,EAAE;oCACf,IAAI,EAAE,QAAQ;oCACd,WAAW,EAAE,kDAAkD;oCAC/D,QAAQ,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC;oCAC7D,aAAa,EAAE;wCACb,kBAAkB,EAAE,IAAI;qCACzB;oCACD,UAAU,EAAE;wCACV,WAAW,EAAE;4CACX,IAAI,EAAE,QAAQ;4CACd,aAAa,EAAE;gDACb,cAAc,EAAE,IAAI;gDACpB,WAAW,EAAE,KAAK;gDAClB,kBAAkB,EAAE,IAAI;6CACzB;yCACF;wCACD,WAAW,EAAE;4CACX,IAAI,EAAE,QAAQ;4CACd,aAAa,EAAE;gDACb,cAAc,EAAE,IAAI;gDACpB,WAAW,EAAE,KAAK;6CACnB;yCACF;wCACD,cAAc,EAAE;4CACd,IAAI,EAAE,QAAQ;4CACd,aAAa,EAAE;gDACb,cAAc,EAAE,IAAI;gDACpB,WAAW,EAAE,KAAK;6CACnB;yCACF;wCACD,KAAK,EAAE;4CACL,IAAI,EAAE,QAAQ;4CACd,aAAa,EAAE;gDACb,cAAc,EAAE,IAAI;gDACpB,WAAW,EAAE,KAAK;6CACnB;yCACF;qCACF;iCACF;6BACF;4BACD,QAAQ,EAAE,CAAC,eAAe,CAAC;yBAC5B;qBACF;iBACF;aACF,EACD,IAAI,CACL,CAAC;QACJ,CAAC,EACD,6CAAqB,EACrB,2NAA2N,CAC5N,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dx-json-schema-lib",
-  "version": "1.76.1",
+  "version": "1.76.3",
   "description": "",
   "main": "lib/index.js",
   "private": false,
@@ -31,7 +31,7 @@
     "typescript": "4.9.4"
   },
   "dependencies": {
-    "@sagold/json-query": "6.0.0",
+    "@sagold/json-query": "^6.2.0",
     "@squiz/json-schema-library": "^7.4.7",
     "ts-brand": "0.0.2"
   }

package/src/JsonValidationService.spec.ts

@@ -2183,4 +2183,148 @@ describe('JSONSchemaService - validation', () => {
       },
     });
   });
+
+  it('should not use the resolver for primitive items in a resolvable array', async () => {
+    const mockMatrixAssetResolver = jest.fn((input: MatrixAssetType['__shape__']) => {
+      return {
+        name: input.matrixAssetId,
+        imageVariations: {
+          original: {
+            width: 0,
+            height: 0,
+            url: '',
+            mimeType: '',
+            byteSize: 0,
+            sha1Hash: '',
+            aspectRatio: '',
+          },
+        },
+      };
+    });
+    const mockMatrixLinkResolver = jest.fn((input: MatrixAssetLinkType['__shape__']): SquizLinkType['__shape__'] => {
+      return {
+        text: input.matrixAssetId,
+        url: 'www.test.com',
+        target: '_self',
+      };
+    });
+    const typeResolver = TypeResolverBuilder.new()
+      .addPrimitive(SquizImageType)
+      .addPrimitive(SquizLinkType)
+      .addPrimitive(FormattedTextType)
+      .addResolver(SquizImageType, MatrixAssetType, mockMatrixAssetResolver)
+      .addResolver(SquizLinkType, MatrixAssetLinkType, mockMatrixLinkResolver)
+      .build();
+
+    const jsonSchemaService = new JSONSchemaService(typeResolver, ComponentInputMetaSchema);
+
+    const schema = {
+      type: 'object',
+      properties: {
+        images: {
+          description: 'Gallery images',
+          type: 'array',
+          items: {
+            type: 'SquizImage',
+          },
+        },
+        squizLink: {
+          title: 'Squiz link',
+          type: 'array',
+          items: {
+            type: 'SquizLink',
+          },
+        },
+        //custom format
+        multiLine: {
+          title: 'Multi-line (textarea)',
+          type: 'array',
+          items: {
+            type: 'string',
+            format: 'multi-line',
+          },
+        },
+        //string array
+        listOfStrings: {
+          type: 'array',
+          title: 'A list of strings',
+          items: {
+            type: 'string',
+            default: 'Holy smokes',
+          },
+        },
+      },
+      required: ['images', 'links'],
+    };
+
+    const input: {
+      images: Array<MatrixAssetType['__shape__'] | SquizImageType['__shape__']>;
+      squizLink: Array<MatrixAssetLinkType['__shape__'] | SquizLinkType['__shape__']>;
+      multiline: Array<string>;
+      listOfStrings: Array<string>;
+    } = {
+      images: [
+        {
+          matrixDomain: 'https://feaas-page-render-us.dev.matrix.squiz.cloud/59',
+          matrixAssetId: '160',
+          matrixIdentifier: 'feaas-matrix-us',
+        },
+        {
+          imageVariations: {
+            original: { aspectRatio: '', byteSize: 0, height: 0, mimeType: '', sha1Hash: '', url: '', width: 0 },
+          },
+          name: '',
+        },
+      ],
+      squizLink: [
+        {
+          matrixDomain: 'https://feaas-page-render-us.dev.matrix.squiz.cloud/59',
+          matrixAssetId: '160',
+          matrixIdentifier: 'feaas-matrix-us',
+          target: '_self',
+        },
+        {
+          text: 'link text',
+          url: 'www.test.com',
+          target: '_self',
+        },
+      ],
+      multiline: ['wow', 'much', 'multiline'],
+      listOfStrings: ['very', 'string'],
+    };
+    const result = await jsonSchemaService.resolveInput(input, schema);
+    expect(result).toEqual({
+      images: [
+        {
+          imageVariations: {
+            original: { aspectRatio: '', byteSize: 0, height: 0, mimeType: '', sha1Hash: '', url: '', width: 0 },
+          },
+          name: (input.images[0] as MatrixAssetType['__shape__']).matrixAssetId,
+        },
+        {
+          imageVariations: {
+            original: { aspectRatio: '', byteSize: 0, height: 0, mimeType: '', sha1Hash: '', url: '', width: 0 },
+          },
+          name: '',
+        },
+      ],
+      squizLink: [
+        {
+          text: (input.squizLink[0] as MatrixAssetLinkType['__shape__']).matrixAssetId,
+          url: 'www.test.com',
+          target: '_self',
+        },
+        {
+          text: 'link text',
+          url: 'www.test.com',
+          target: '_self',
+        },
+      ],
+      multiline: ['wow', 'much', 'multiline'],
+      listOfStrings: ['very', 'string'],
+    });
+
+    expect(mockMatrixAssetResolver).toHaveBeenCalledTimes(1);
+    expect(mockMatrixLinkResolver).toHaveBeenCalledTimes(1);
+  });
 });

package/src/JsonValidationService.ts

@@ -178,11 +178,6 @@ export const ManifestV1MetaSchema: MetaSchemaInput = {
   },
 };
 
-const titleMap: Record<'SquizLink' | 'SquizImage', string[]> = {
-  ['SquizLink']: ['MatrixAssetLink'],
-  ['SquizImage']: ['MatrixAsset', 'DAMObject'],
-};
-
 interface MetaSchemaInput {
   root: JSONSchema;
   remotes?: Record<string, JSONSchema>;
@@ -249,8 +244,11 @@ export class JSONSchemaService<P extends AnyPrimitiveType, R extends AnyResolvab
     this.schema.each(
       input,
       async (schema, value, pointer) => {
-        if (this.typeResolver.isResolvableArraySchema(schema)) {
-          return await this.resolveInputArray(input, setters, schema, value, pointer);
+        // Bug in library for Array item schemas which won't resolve the oneOf schema
+        if (Array.isArray(schema?.oneOf)) {
+          const oldSchema = schema;
+          schema = this.schema.resolveOneOf(value, schema);
+          schema.oneOfSchema = oldSchema;
         }
         if (!this.typeResolver.isResolvableSchema(schema)) return;
         // If its a resolvable schema, it should exist in a oneOf array with other schemas
@@ -264,7 +262,7 @@ export class JSONSchemaService<P extends AnyPrimitiveType, R extends AnyResolvab
         if (!resolver) return;
         const setResolvedData = Promise.resolve()
           .then(() => resolver(value))
-          .then((resolvedData) => (item: typeof input) => JSONQuery.set(item, pointer, resolvedData))
+          .then((resolvedData) => (item: typeof input) => JSONQuery.set(item, pointer, resolvedData, 'replace' as any))
           .catch((e) => Promise.reject(new JsonResolutionError(e, pointer, value)));
         setters.push(setResolvedData);
       },
@@ -304,48 +302,6 @@ export class JSONSchemaService<P extends AnyPrimitiveType, R extends AnyResolvab
 
     return input;
   }
-
-  protected async resolveInputArray(
-    input: Input,
-    setters: Promise<(input: Input) => Input>[],
-    schema: JSONSchema,
-    value: unknown,
-    pointer: string,
-  ) {
-    const allPossibleSchemaTitles: string[] = schema.oneOf.map((o: JSONSchema) => {
-      return o.$ref.replace('.json', '');
-    });
-    const primitiveSchema = allPossibleSchemaTitles.find((title) => this.typeResolver.isPrimitiveType(title));
-    if (!this.isPrimitiveSchema(primitiveSchema)) return;
-
-    const primitiveSchemaKey: keyof typeof titleMap = primitiveSchema;
-    const mappedValues = titleMap[primitiveSchemaKey];
-
-    let matchedMappedValue: string | null = mappedValues[0];
-
-    if (this.isDamObject(value, schema)) {
-      matchedMappedValue = mappedValues.find((mappedValue) => mappedValue === 'DAMObject') || matchedMappedValue;
-    }
-    const resolver = this.typeResolver.tryGetResolver(primitiveSchema, { title: matchedMappedValue } as R);
-    if (!resolver) return;
-    const setResolvedData = Promise.resolve()
-      .then(() => resolver(value))
-      .then((resolvedData) => (item: typeof input) => this.assignResolvedData(item, pointer, resolvedData))
-      .catch((e) => Promise.reject(new JsonResolutionError(e, pointer, value)));
-    setters.push(setResolvedData);
-  }
-
-  private isDamObject(value: any, schema: JSONSchema): boolean {
-    const damObjectSchema = schema.oneOf.find((s: JSONSchema) => s.$ref === 'DAMObject.json');
-    if (!damObjectSchema) return false;
-
-    return typeof value === 'object' && value.damObjectId !== undefined;
-  }
-
-  private isPrimitiveSchema(value: string | undefined): value is keyof typeof titleMap {
-    if (!value) false;
-    return value === 'SquizLink' || value === 'SquizImage';
-  }
 }
 
 export class JsonValidationService {

package/src/jsonTypeResolution/TypeResolver.ts

@@ -82,17 +82,6 @@ export class TypeResolver<P extends AnyPrimitiveType, R extends AnyResolvableTyp
     return this.resolvables.has(schema.title);
   }
 
-  isResolvableArraySchema(schema: JSONSchema): schema is R {
-    if (Array.isArray(schema.oneOf) && schema.title === undefined) {
-      const hasResolvable = schema.oneOf.some((schema: JSONSchema) => {
-        const title = schema.$ref.replace('.json', '');
-        return this.resolvables.has(title);
-      });
-      return hasResolvable;
-    }
-    return false;
-  }
-
   getValidationSchemaForPrimitive(type: P['title']) {
     const primitiveSchema = this.primitives.get(type) as JsonResolutionSchema<string>;
     return [primitiveSchema, ...this.fetchResolvableSchemasForPrimitive(type)];

package/src/manifest/v1/DxContentMetaSchema.json

@@ -34,6 +34,40 @@
       "items": { "type": "string" },
       "uniqueItems": true,
       "default": []
+    },
+    "ui:metadata": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "collapsedByDefault": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          "if": {
+            "type": "object"
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "inlineEditable": {
+              "type": "boolean",
+              "default": false
+            },
+            "quickOption": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          "if": {
+            "type": ["number", "integer", "array", "boolean", "string"]
+          }
+        }
+      ]
     }
   },
   "type": ["object", "boolean"],
@@ -42,6 +76,7 @@
       "type": "string",
       "format": "uri-reference"
     },
+    "ui:metadata": { "$ref": "#/definitions/ui:metadata" },
     "$schema": {
       "type": "string",
       "format": "uri"

package/src/manifest/v1/JobV1.ts

@@ -17,6 +17,14 @@ export type CoreSchemaMetaSchema = CoreSchemaMetaSchema1 & CoreSchemaMetaSchema2
 export type CoreSchemaMetaSchema2 =
   | {
       $id?: string;
+      'ui:metadata'?:
+        | {
+            collapsedByDefault?: boolean;
+          }
+        | {
+            inlineEditable?: boolean;
+            quickOption?: boolean;
+          };
       $schema?: string;
       $ref?: string;
       $comment?: string;
@@ -262,6 +270,14 @@ export interface JobFunction {
 }
 export interface CoreSchemaMetaSchema1 {
   $id?: string;
+  'ui:metadata'?:
+    | {
+        collapsedByDefault?: boolean;
+      }
+    | {
+        inlineEditable?: boolean;
+        quickOption?: boolean;
+      };
   $schema?: string;
   $ref?: string;
   $comment?: string;