@squiz/dx-json-schema-lib 1.87.0 → 1.88.0

package/lib/utils/jsonBreakDetector/dereference/dereference.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/jsonBreakDetector/dereference/dereference.spec.js

@@ -0,0 +1,225 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const dereference_1 = require("./dereference");
+describe('dereferenceLocal', () => {
+    describe('JSON Schema Draft 7', () => {
+        it('dereferences a top-level $ref to a definition', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                $ref: '#/definitions/Person',
+                definitions: {
+                    Person: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                        required: ['name'],
+                    },
+                },
+            };
+            expect((0, dereference_1.dereferenceLocal)(schema)).toEqual({
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                definitions: {
+                    Person: {
+                        type: 'object',
+                        properties: {
+                            name: { type: 'string' },
+                        },
+                        required: ['name'],
+                    },
+                },
+                type: 'object',
+                properties: {
+                    name: { type: 'string' },
+                },
+                required: ['name'],
+            });
+        });
+        it('dereferences nested $refs in properties', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                type: 'object',
+                properties: {
+                    address: { $ref: '#/definitions/Address' },
+                },
+                definitions: {
+                    Address: {
+                        type: 'object',
+                        properties: {
+                            city: { $ref: '#/definitions/City' },
+                        },
+                    },
+                    City: {
+                        type: 'string',
+                        minLength: 1,
+                    },
+                },
+            };
+            expect((0, dereference_1.dereferenceLocal)(schema)).toEqual({
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                type: 'object',
+                properties: {
+                    address: {
+                        type: 'object',
+                        properties: {
+                            city: {
+                                type: 'string',
+                                minLength: 1,
+                            },
+                        },
+                    },
+                },
+                definitions: {
+                    Address: {
+                        type: 'object',
+                        properties: {
+                            city: { $ref: '#/definitions/City' },
+                        },
+                    },
+                    City: {
+                        type: 'string',
+                        minLength: 1,
+                    },
+                },
+            });
+        });
+        it('dereferences $refs inside combinators', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                oneOf: [{ $ref: '#/definitions/StringValue' }, { $ref: '#/definitions/NumberValue' }],
+                definitions: {
+                    StringValue: { type: 'string' },
+                    NumberValue: { type: 'number' },
+                },
+            };
+            expect((0, dereference_1.dereferenceLocal)(schema)).toEqual({
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                oneOf: [{ type: 'string' }, { type: 'number' }],
+                definitions: {
+                    StringValue: { type: 'string' },
+                    NumberValue: { type: 'number' },
+                },
+            });
+        });
+        it('dereferences chained $refs', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                $ref: '#/definitions/Outer',
+                definitions: {
+                    Outer: { $ref: '#/definitions/Inner' },
+                    Inner: {
+                        type: 'boolean',
+                    },
+                },
+            };
+            expect((0, dereference_1.dereferenceLocal)(schema)).toEqual({
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                definitions: {
+                    Outer: { $ref: '#/definitions/Inner' },
+                    Inner: {
+                        type: 'boolean',
+                    },
+                },
+                type: 'boolean',
+            });
+        });
+        it('merges sibling properties alongside a $ref', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                properties: {
+                    title: {
+                        $ref: '#/definitions/NonEmptyString',
+                        description: 'A human-readable title',
+                    },
+                },
+                definitions: {
+                    NonEmptyString: {
+                        type: 'string',
+                        minLength: 1,
+                    },
+                },
+            };
+            expect((0, dereference_1.dereferenceLocal)(schema)).toEqual({
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                properties: {
+                    title: {
+                        type: 'string',
+                        minLength: 1,
+                        description: 'A human-readable title',
+                    },
+                },
+                definitions: {
+                    NonEmptyString: {
+                        type: 'string',
+                        minLength: 1,
+                    },
+                },
+            });
+        });
+        it('resolves JSON pointer escaped property names', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                properties: {
+                    'foo/bar': { $ref: '#/definitions/foo~1bar' },
+                },
+                definitions: {
+                    'foo/bar': {
+                        type: 'string',
+                    },
+                },
+            };
+            expect((0, dereference_1.dereferenceLocal)(schema)).toEqual({
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                properties: {
+                    'foo/bar': {
+                        type: 'string',
+                    },
+                },
+                definitions: {
+                    'foo/bar': {
+                        type: 'string',
+                    },
+                },
+            });
+        });
+        it('does not infinitely recurse on circular definitions', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                $ref: '#/definitions/Node',
+                definitions: {
+                    Node: {
+                        type: 'object',
+                        properties: {
+                            child: { $ref: '#/definitions/Node' },
+                        },
+                    },
+                },
+            };
+            const result = (0, dereference_1.dereferenceLocal)(schema);
+            expect(result.type).toBe('object');
+            expect(result.properties.child).toEqual({
+                type: 'object',
+                properties: {
+                    child: { $ref: '#/definitions/Node' },
+                },
+            });
+        });
+        it('throws when a reference is not internal', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                $ref: 'https://example.com/schema.json',
+            };
+            expect(() => (0, dereference_1.dereferenceLocal)(schema)).toThrow('Only internal references starting with "#/" are supported. Received: "https://example.com/schema.json"');
+        });
+        it('throws when a JSON pointer cannot be resolved', () => {
+            const schema = {
+                $schema: 'http://json-schema.org/draft-07/schema#',
+                properties: {
+                    missing: { $ref: '#/definitions/DoesNotExist' },
+                },
+            };
+            expect(() => (0, dereference_1.dereferenceLocal)(schema)).toThrow('Could not resolve JSON pointer reference: "#/definitions/DoesNotExist" at segment "definitions"');
+        });
+    });
+});
+//# sourceMappingURL=dereference.spec.js.map

package/lib/utils/jsonBreakDetector/dereference/dereference.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dereference.spec.js","sourceRoot":"","sources":["../../../../src/utils/jsonBreakDetector/dereference/dereference.spec.ts"],"names":[],"mappings":";;AAAA,+CAAiD;AAEjD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,IAAI,EAAE,sBAAsB;gBAC5B,WAAW,EAAE;oBACX,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;yBACzB;wBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;qBACnB;iBACF;aACF,CAAC;YAEF,MAAM,CAAC,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBACvC,OAAO,EAAE,yCAAyC;gBAClD,WAAW,EAAE;oBACX,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;yBACzB;wBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;qBACnB;iBACF;gBACD,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBACzB;gBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;aACnB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,OAAO,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE;iBAC3C;gBACD,WAAW,EAAE;oBACX,OAAO,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,IAAI,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE;yBACrC;qBACF;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,SAAS,EAAE,CAAC;qBACb;iBACF;aACF,CAAC;YAEF,MAAM,CAAC,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBACvC,OAAO,EAAE,yCAAyC;gBAClD,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,OAAO,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,IAAI,EAAE;gCACJ,IAAI,EAAE,QAAQ;gCACd,SAAS,EAAE,CAAC;6BACb;yBACF;qBACF;iBACF;gBACD,WAAW,EAAE;oBACX,OAAO,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,IAAI,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE;yBACrC;qBACF;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,SAAS,EAAE,CAAC;qBACb;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,2BAA2B,EAAE,EAAE,EAAE,IAAI,EAAE,2BAA2B,EAAE,CAAC;gBACrF,WAAW,EAAE;oBACX,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC/B,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAChC;aACF,CAAC;YAEF,MAAM,CAAC,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBACvC,OAAO,EAAE,yCAAyC;gBAClD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBAC/C,WAAW,EAAE;oBACX,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC/B,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAChC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,IAAI,EAAE,qBAAqB;gBAC3B,WAAW,EAAE;oBACX,KAAK,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE;oBACtC,KAAK,EAAE;wBACL,IAAI,EAAE,SAAS;qBAChB;iBACF;aACF,CAAC;YAEF,MAAM,CAAC,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBACvC,OAAO,EAAE,yCAAyC;gBAClD,WAAW,EAAE;oBACX,KAAK,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE;oBACtC,KAAK,EAAE;wBACL,IAAI,EAAE,SAAS;qBAChB;iBACF;gBACD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,8BAA8B;wBACpC,WAAW,EAAE,wBAAwB;qBACtC;iBACF;gBACD,WAAW,EAAE;oBACX,cAAc,EAAE;wBACd,IAAI,EAAE,QAAQ;wBACd,SAAS,EAAE,CAAC;qBACb;iBACF;aACF,CAAC;YAEF,MAAM,CAAC,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBACvC,OAAO,EAAE,yCAAyC;gBAClD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,SAAS,EAAE,CAAC;wBACZ,WAAW,EAAE,wBAAwB;qBACtC;iBACF;gBACD,WAAW,EAAE;oBACX,cAAc,EAAE;wBACd,IAAI,EAAE,QAAQ;wBACd,SAAS,EAAE,CAAC;qBACb;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,UAAU,EAAE;oBACV,SAAS,EAAE,EAAE,IAAI,EAAE,wBAAwB,EAAE;iBAC9C;gBACD,WAAW,EAAE;oBACX,SAAS,EAAE;wBACT,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF,CAAC;YAEF,MAAM,CAAC,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBACvC,OAAO,EAAE,yCAAyC;gBAClD,UAAU,EAAE;oBACV,SAAS,EAAE;wBACT,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,WAAW,EAAE;oBACX,SAAS,EAAE;wBACT,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,IAAI,EAAE,oBAAoB;gBAC1B,WAAW,EAAE;oBACX,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,KAAK,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE;yBACtC;qBACF;iBACF;aACF,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,8BAAgB,EAAC,MAAM,CAA4B,CAAC;YAEnE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,MAAM,CAAE,MAAM,CAAC,UAAsC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACnE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,KAAK,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE;iBACtC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,IAAI,EAAE,iCAAiC;aACxC,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAC5C,wGAAwG,CACzG,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,yCAAyC;gBAClD,UAAU,EAAE;oBACV,OAAO,EAAE,EAAE,IAAI,EAAE,4BAA4B,EAAE;iBAChD;aACF,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAC5C,iGAAiG,CAClG,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/utils/jsonBreakDetector/jsonBreakDetector.d.ts

@@ -0,0 +1,8 @@
+import type { JSONSchema } from '@squiz/json-schema-library';
+import { JsonBreak } from './types';
+/**
+ * Detects breaking schema changes between beforeSchema and afterSchema.
+ * Returns each break with a dotted path location, e.g. `subtitle`, `image.width`, `tags[]`,
+ * `tags.{contains}`, and a message identifying the kind of break.
+ */
+export default function jsonBreakDetector(beforeSchema: JSONSchema, afterSchema: JSONSchema): JsonBreak[];

package/lib/utils/jsonBreakDetector/jsonBreakDetector.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = jsonBreakDetector;
+const dereference_1 = require("./dereference/dereference");
+const compareSubschemas_1 = require("./compareSubschemas");
+const types_1 = require("./types");
+/**
+ * Detects breaking schema changes between beforeSchema and afterSchema.
+ * Returns each break with a dotted path location, e.g. `subtitle`, `image.width`, `tags[]`,
+ * `tags.{contains}`, and a message identifying the kind of break.
+ */
+function jsonBreakDetector(beforeSchema, afterSchema) {
+    const breaks = [];
+    // Unfold $refs so inline schemas and $defs references can be compared on equal footing.
+    let processedBeforeSchema;
+    try {
+        processedBeforeSchema = (0, dereference_1.dereferenceLocal)(beforeSchema);
+    }
+    catch (error) {
+        (0, types_1.pushBreak)(breaks, '', error instanceof Error ? error.message : 'Could not dereference schema');
+    }
+    let processedAfterSchema;
+    try {
+        processedAfterSchema = (0, dereference_1.dereferenceLocal)(afterSchema);
+    }
+    catch (error) {
+        (0, types_1.pushBreak)(breaks, '', error instanceof Error ? error.message : 'Could not dereference schema');
+    }
+    if (processedBeforeSchema === undefined || processedAfterSchema === undefined) {
+        return breaks;
+    }
+    (0, compareSubschemas_1.compareSubschemas)(processedBeforeSchema, processedAfterSchema, '', breaks);
+    return breaks;
+}
+//# sourceMappingURL=jsonBreakDetector.js.map

package/lib/utils/jsonBreakDetector/jsonBreakDetector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonBreakDetector.js","sourceRoot":"","sources":["../../../src/utils/jsonBreakDetector/jsonBreakDetector.ts"],"names":[],"mappings":";;AAWA,oCAwBC;AAjCD,2DAA6D;AAC7D,2DAAwD;AACxD,mCAA+C;AAE/C;;;;GAIG;AACH,SAAwB,iBAAiB,CAAC,YAAwB,EAAE,WAAuB;IACzF,MAAM,MAAM,GAAgB,EAAE,CAAC;IAE/B,wFAAwF;IACxF,IAAI,qBAA6C,CAAC;IAClD,IAAI,CAAC;QACH,qBAAqB,GAAG,IAAA,8BAAgB,EAAC,YAAY,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAA,iBAAS,EAAC,MAAM,EAAE,EAAE,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,8BAA8B,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,oBAA4C,CAAC;IACjD,IAAI,CAAC;QACH,oBAAoB,GAAG,IAAA,8BAAgB,EAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAA,iBAAS,EAAC,MAAM,EAAE,EAAE,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,8BAA8B,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,qBAAqB,KAAK,SAAS,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;QAC9E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAA,qCAAiB,EAAC,qBAAqB,EAAE,oBAAoB,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAC3E,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/utils/jsonBreakDetector/jsonBreakDetector.spec.d.ts

@@ -0,0 +1 @@
+export {};