@redocly/openapi-core 2.71.2 → 2.72.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/bundle/apply-overlay.js +2 -2
- package/lib/bundle/apply-overlay.js.map +1 -1
- package/lib/config/builtIn.d.ts.map +1 -1
- package/lib/config/builtIn.js +10 -0
- package/lib/config/builtIn.js.map +1 -1
- package/lib/config/config-resolvers.d.ts.map +1 -1
- package/lib/config/config-resolvers.js +12 -0
- package/lib/config/config-resolvers.js.map +1 -1
- package/lib/config/config.d.ts +7 -0
- package/lib/config/config.d.ts.map +1 -1
- package/lib/config/config.js +28 -0
- package/lib/config/config.js.map +1 -1
- package/lib/config/constants.d.ts.map +1 -1
- package/lib/config/constants.js +1 -1
- package/lib/config/constants.js.map +1 -1
- package/lib/config/diff-recommended.d.ts +4 -0
- package/lib/config/diff-recommended.d.ts.map +1 -0
- package/lib/config/diff-recommended.js +48 -0
- package/lib/config/diff-recommended.js.map +1 -0
- package/lib/config/rules.d.ts +7 -0
- package/lib/config/rules.d.ts.map +1 -1
- package/lib/config/rules.js +9 -0
- package/lib/config/rules.js.map +1 -1
- package/lib/config/types.d.ts +12 -1
- package/lib/config/types.d.ts.map +1 -1
- package/lib/config/utils.d.ts.map +1 -1
- package/lib/config/utils.js +14 -0
- package/lib/config/utils.js.map +1 -1
- package/lib/diff/changes.d.ts +4 -0
- package/lib/diff/changes.d.ts.map +1 -0
- package/lib/diff/changes.js +57 -0
- package/lib/diff/changes.js.map +1 -0
- package/lib/diff/diff-node.d.ts +9 -0
- package/lib/diff/diff-node.d.ts.map +1 -0
- package/lib/diff/diff-node.js +40 -0
- package/lib/diff/diff-node.js.map +1 -0
- package/lib/diff/diff-tree.d.ts +5 -0
- package/lib/diff/diff-tree.d.ts.map +1 -0
- package/lib/diff/diff-tree.js +53 -0
- package/lib/diff/diff-tree.js.map +1 -0
- package/lib/diff/direction.d.ts +4 -0
- package/lib/diff/direction.d.ts.map +1 -0
- package/lib/diff/direction.js +68 -0
- package/lib/diff/direction.js.map +1 -0
- package/lib/diff/impact.d.ts +7 -0
- package/lib/diff/impact.d.ts.map +1 -0
- package/lib/diff/impact.js +21 -0
- package/lib/diff/impact.js.map +1 -0
- package/lib/diff/index.d.ts +10 -0
- package/lib/diff/index.d.ts.map +1 -0
- package/lib/diff/index.js +104 -0
- package/lib/diff/index.js.map +1 -0
- package/lib/diff/judge.d.ts +11 -0
- package/lib/diff/judge.d.ts.map +1 -0
- package/lib/diff/judge.js +66 -0
- package/lib/diff/judge.js.map +1 -0
- package/lib/diff/pair-children.d.ts +8 -0
- package/lib/diff/pair-children.d.ts.map +1 -0
- package/lib/diff/pair-children.js +88 -0
- package/lib/diff/pair-children.js.map +1 -0
- package/lib/diff/rules/channel-address-changed.d.ts +3 -0
- package/lib/diff/rules/channel-address-changed.d.ts.map +1 -0
- package/lib/diff/rules/channel-address-changed.js +17 -0
- package/lib/diff/rules/channel-address-changed.js.map +1 -0
- package/lib/diff/rules/channel-removed.d.ts +3 -0
- package/lib/diff/rules/channel-removed.d.ts.map +1 -0
- package/lib/diff/rules/channel-removed.js +15 -0
- package/lib/diff/rules/channel-removed.js.map +1 -0
- package/lib/diff/rules/enum-values-added.d.ts +3 -0
- package/lib/diff/rules/enum-values-added.d.ts.map +1 -0
- package/lib/diff/rules/enum-values-added.js +24 -0
- package/lib/diff/rules/enum-values-added.js.map +1 -0
- package/lib/diff/rules/enum-values-removed.d.ts +3 -0
- package/lib/diff/rules/enum-values-removed.d.ts.map +1 -0
- package/lib/diff/rules/enum-values-removed.js +26 -0
- package/lib/diff/rules/enum-values-removed.js.map +1 -0
- package/lib/diff/rules/index.d.ts +91 -0
- package/lib/diff/rules/index.d.ts.map +1 -0
- package/lib/diff/rules/index.js +78 -0
- package/lib/diff/rules/index.js.map +1 -0
- package/lib/diff/rules/media-type-removed.d.ts +3 -0
- package/lib/diff/rules/media-type-removed.d.ts.map +1 -0
- package/lib/diff/rules/media-type-removed.js +22 -0
- package/lib/diff/rules/media-type-removed.js.map +1 -0
- package/lib/diff/rules/message-content-type-changed.d.ts +3 -0
- package/lib/diff/rules/message-content-type-changed.d.ts.map +1 -0
- package/lib/diff/rules/message-content-type-changed.js +17 -0
- package/lib/diff/rules/message-content-type-changed.js.map +1 -0
- package/lib/diff/rules/message-removed.d.ts +3 -0
- package/lib/diff/rules/message-removed.d.ts.map +1 -0
- package/lib/diff/rules/message-removed.js +18 -0
- package/lib/diff/rules/message-removed.js.map +1 -0
- package/lib/diff/rules/operation-action-changed.d.ts +3 -0
- package/lib/diff/rules/operation-action-changed.d.ts.map +1 -0
- package/lib/diff/rules/operation-action-changed.js +19 -0
- package/lib/diff/rules/operation-action-changed.js.map +1 -0
- package/lib/diff/rules/operation-id-changed.d.ts +3 -0
- package/lib/diff/rules/operation-id-changed.d.ts.map +1 -0
- package/lib/diff/rules/operation-id-changed.js +23 -0
- package/lib/diff/rules/operation-id-changed.js.map +1 -0
- package/lib/diff/rules/operation-removed.d.ts +3 -0
- package/lib/diff/rules/operation-removed.d.ts.map +1 -0
- package/lib/diff/rules/operation-removed.js +29 -0
- package/lib/diff/rules/operation-removed.js.map +1 -0
- package/lib/diff/rules/parameter-became-required.d.ts +3 -0
- package/lib/diff/rules/parameter-became-required.d.ts.map +1 -0
- package/lib/diff/rules/parameter-became-required.js +35 -0
- package/lib/diff/rules/parameter-became-required.js.map +1 -0
- package/lib/diff/rules/parameter-removed.d.ts +3 -0
- package/lib/diff/rules/parameter-removed.d.ts.map +1 -0
- package/lib/diff/rules/parameter-removed.js +35 -0
- package/lib/diff/rules/parameter-removed.js.map +1 -0
- package/lib/diff/rules/parameter-serialization-changed.d.ts +3 -0
- package/lib/diff/rules/parameter-serialization-changed.d.ts.map +1 -0
- package/lib/diff/rules/parameter-serialization-changed.js +25 -0
- package/lib/diff/rules/parameter-serialization-changed.js.map +1 -0
- package/lib/diff/rules/path-removed.d.ts +3 -0
- package/lib/diff/rules/path-removed.d.ts.map +1 -0
- package/lib/diff/rules/path-removed.js +61 -0
- package/lib/diff/rules/path-removed.js.map +1 -0
- package/lib/diff/rules/property-removed.d.ts +3 -0
- package/lib/diff/rules/property-removed.d.ts.map +1 -0
- package/lib/diff/rules/property-removed.js +40 -0
- package/lib/diff/rules/property-removed.js.map +1 -0
- package/lib/diff/rules/request-body-became-required.d.ts +3 -0
- package/lib/diff/rules/request-body-became-required.d.ts.map +1 -0
- package/lib/diff/rules/request-body-became-required.js +10 -0
- package/lib/diff/rules/request-body-became-required.js.map +1 -0
- package/lib/diff/rules/request-body-removed.d.ts +3 -0
- package/lib/diff/rules/request-body-removed.d.ts.map +1 -0
- package/lib/diff/rules/request-body-removed.js +8 -0
- package/lib/diff/rules/request-body-removed.js.map +1 -0
- package/lib/diff/rules/required-properties-added.d.ts +3 -0
- package/lib/diff/rules/required-properties-added.d.ts.map +1 -0
- package/lib/diff/rules/required-properties-added.js +18 -0
- package/lib/diff/rules/required-properties-added.js.map +1 -0
- package/lib/diff/rules/required-properties-removed.d.ts +3 -0
- package/lib/diff/rules/required-properties-removed.d.ts.map +1 -0
- package/lib/diff/rules/required-properties-removed.js +20 -0
- package/lib/diff/rules/required-properties-removed.js.map +1 -0
- package/lib/diff/rules/response-header-removed.d.ts +3 -0
- package/lib/diff/rules/response-header-removed.d.ts.map +1 -0
- package/lib/diff/rules/response-header-removed.js +28 -0
- package/lib/diff/rules/response-header-removed.js.map +1 -0
- package/lib/diff/rules/response-removed.d.ts +3 -0
- package/lib/diff/rules/response-removed.d.ts.map +1 -0
- package/lib/diff/rules/response-removed.js +17 -0
- package/lib/diff/rules/response-removed.js.map +1 -0
- package/lib/diff/rules/schema-combinator-changed.d.ts +3 -0
- package/lib/diff/rules/schema-combinator-changed.d.ts.map +1 -0
- package/lib/diff/rules/schema-combinator-changed.js +35 -0
- package/lib/diff/rules/schema-combinator-changed.js.map +1 -0
- package/lib/diff/rules/schema-constraint-changed.d.ts +3 -0
- package/lib/diff/rules/schema-constraint-changed.d.ts.map +1 -0
- package/lib/diff/rules/schema-constraint-changed.js +185 -0
- package/lib/diff/rules/schema-constraint-changed.js.map +1 -0
- package/lib/diff/rules/schema-type-changed.d.ts +3 -0
- package/lib/diff/rules/schema-type-changed.d.ts.map +1 -0
- package/lib/diff/rules/schema-type-changed.js +48 -0
- package/lib/diff/rules/schema-type-changed.js.map +1 -0
- package/lib/diff/rules/security-requirement-changed.d.ts +3 -0
- package/lib/diff/rules/security-requirement-changed.d.ts.map +1 -0
- package/lib/diff/rules/security-requirement-changed.js +58 -0
- package/lib/diff/rules/security-requirement-changed.js.map +1 -0
- package/lib/diff/rules/security-scheme-changed.d.ts +3 -0
- package/lib/diff/rules/security-scheme-changed.d.ts.map +1 -0
- package/lib/diff/rules/security-scheme-changed.js +34 -0
- package/lib/diff/rules/security-scheme-changed.js.map +1 -0
- package/lib/diff/rules/server-removed.d.ts +3 -0
- package/lib/diff/rules/server-removed.d.ts.map +1 -0
- package/lib/diff/rules/server-removed.js +41 -0
- package/lib/diff/rules/server-removed.js.map +1 -0
- package/lib/diff/rules/utils.d.ts +6 -0
- package/lib/diff/rules/utils.d.ts.map +1 -0
- package/lib/diff/rules/utils.js +26 -0
- package/lib/diff/rules/utils.js.map +1 -0
- package/lib/diff/types.d.ts +81 -0
- package/lib/diff/types.d.ts.map +1 -0
- package/lib/diff/types.js +2 -0
- package/lib/diff/types.js.map +1 -0
- package/lib/format/format.d.ts +1 -1
- package/lib/format/format.d.ts.map +1 -1
- package/lib/format/format.js +4 -1
- package/lib/format/format.js.map +1 -1
- package/lib/index.d.ts +6 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +5 -1
- package/lib/index.js.map +1 -1
- package/lib/node-tree/access.d.ts +9 -0
- package/lib/node-tree/access.d.ts.map +1 -0
- package/lib/node-tree/access.js +32 -0
- package/lib/node-tree/access.js.map +1 -0
- package/lib/node-tree/index.d.ts +11 -0
- package/lib/node-tree/index.d.ts.map +1 -0
- package/lib/node-tree/index.js +80 -0
- package/lib/node-tree/index.js.map +1 -0
- package/lib/node-tree/types.d.ts +17 -0
- package/lib/node-tree/types.d.ts.map +1 -0
- package/lib/node-tree/types.js +2 -0
- package/lib/node-tree/types.js.map +1 -0
- package/lib/resolve.js +2 -2
- package/lib/resolve.js.map +1 -1
- package/lib/rules/utils.js +1 -1
- package/lib/rules/utils.js.map +1 -1
- package/lib/types/redocly-yaml.d.ts.map +1 -1
- package/lib/types/redocly-yaml.js +22 -1
- package/lib/types/redocly-yaml.js.map +1 -1
- package/lib/utils/is-scalar.d.ts +3 -0
- package/lib/utils/is-scalar.d.ts.map +1 -0
- package/lib/utils/is-scalar.js +10 -0
- package/lib/utils/is-scalar.js.map +1 -0
- package/lib/utils/items-not-in.d.ts +3 -0
- package/lib/utils/items-not-in.d.ts.map +1 -0
- package/lib/utils/items-not-in.js +8 -0
- package/lib/utils/items-not-in.js.map +1 -0
- package/package.json +3 -4
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { nameOf } from '../diff-node.js';
|
|
2
|
+
import { ofNamedSchema } from './utils.js';
|
|
3
|
+
// `oneOf`/`anyOf` list alternatives, so dropping one accepts less; `allOf` combines constraints,
|
|
4
|
+
// so adding one accepts less.
|
|
5
|
+
function combinatorChanged(combinator) {
|
|
6
|
+
return (change, { report, getDirections }) => {
|
|
7
|
+
if (change.kind === 'modified')
|
|
8
|
+
return;
|
|
9
|
+
const removed = change.kind === 'removed';
|
|
10
|
+
const acceptsLess = combinator === 'allOf' ? !removed : removed;
|
|
11
|
+
if (!getDirections().includes(acceptsLess ? 'request' : 'response'))
|
|
12
|
+
return;
|
|
13
|
+
const owner = ofNamedSchema(change.node.parent?.parent);
|
|
14
|
+
report({
|
|
15
|
+
message: `\`${combinator}\` subschema${owner} was ${removed ? 'removed' : 'added'}.`,
|
|
16
|
+
});
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
// A whole list added constrains the schema, whichever keyword it is; removed, it frees it.
|
|
20
|
+
const listChanged = (change, { report, getDirections }) => {
|
|
21
|
+
if (change.kind === 'modified')
|
|
22
|
+
return;
|
|
23
|
+
const added = change.kind === 'added';
|
|
24
|
+
if (!getDirections().includes(added ? 'request' : 'response'))
|
|
25
|
+
return;
|
|
26
|
+
const owner = ofNamedSchema(change.node.parent);
|
|
27
|
+
report({ message: `\`${nameOf(change.node)}\`${owner} was ${added ? 'added' : 'removed'}.` });
|
|
28
|
+
};
|
|
29
|
+
export const SchemaCombinatorChanged = () => ({
|
|
30
|
+
Schema: { AllOf: listChanged, AnyOf: listChanged, OneOf: listChanged },
|
|
31
|
+
AllOf: { Schema: combinatorChanged('allOf') },
|
|
32
|
+
AnyOf: { Schema: combinatorChanged('anyOf') },
|
|
33
|
+
OneOf: { Schema: combinatorChanged('oneOf') },
|
|
34
|
+
});
|
|
35
|
+
//# sourceMappingURL=schema-combinator-changed.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-combinator-changed.js","sourceRoot":"","sources":["../../../src/diff/rules/schema-combinator-changed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,iGAAiG;AACjG,8BAA8B;AAC9B,SAAS,iBAAiB,CAAC,UAAuC;IAChE,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,EAAE;QAC3C,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU;YAAE,OAAO;QAEvC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC;QAC1C,MAAM,WAAW,GAAG,UAAU,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;QAChE,IAAI,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;YAAE,OAAO;QAE5E,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,MAAM,CAAC;YACL,OAAO,EAAE,KAAK,UAAU,eAAe,KAAK,QAAQ,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,GAAG;SACrF,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,2FAA2F;AAC3F,MAAM,WAAW,GAAc,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,EAAE;IACnE,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU;QAAE,OAAO;IAEvC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC;IACtC,IAAI,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;QAAE,OAAO;IAEtE,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,QAAQ,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC;AAChG,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAa,GAAG,EAAE,CAAC,CAAC;IACtD,MAAM,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE;IACtE,KAAK,EAAE,EAAE,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC,EAAE;IAC7C,KAAK,EAAE,EAAE,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC,EAAE;IAC7C,KAAK,EAAE,EAAE,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC,EAAE;CAC9C,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-constraint-changed.d.ts","sourceRoot":"","sources":["../../../src/diff/rules/schema-constraint-changed.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAU,QAAQ,EAAyC,MAAM,aAAa,CAAC;AAwL3F,eAAO,MAAM,uBAAuB,EAAE,QAapC,CAAC"}
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
import { fieldOf, keyKindOf } from '../../node-tree/access.js';
|
|
2
|
+
import { dequal } from '../../utils/dequal.js';
|
|
3
|
+
import { latestOf } from '../diff-node.js';
|
|
4
|
+
import { ofNamedSchema } from './utils.js';
|
|
5
|
+
const LOWER_LIMITS = new Set(['minLength', 'minItems', 'minProperties']);
|
|
6
|
+
const UPPER_LIMITS = new Set(['maxLength', 'maxItems', 'maxProperties']);
|
|
7
|
+
// Two values of these cannot be compared, so any change is taken as both fewer and more values.
|
|
8
|
+
const OPAQUE = new Set([
|
|
9
|
+
'multipleOf',
|
|
10
|
+
'pattern',
|
|
11
|
+
'format',
|
|
12
|
+
'const',
|
|
13
|
+
'contentEncoding',
|
|
14
|
+
'contentMediaType',
|
|
15
|
+
]);
|
|
16
|
+
// Flags that constrain the values only when set to this value.
|
|
17
|
+
const CONSTRAINING_FLAGS = {
|
|
18
|
+
uniqueItems: true,
|
|
19
|
+
additionalProperties: false,
|
|
20
|
+
unevaluatedItems: false,
|
|
21
|
+
unevaluatedProperties: false,
|
|
22
|
+
items: false,
|
|
23
|
+
};
|
|
24
|
+
// `if` is not here: it constrains nothing on its own.
|
|
25
|
+
const SUBSCHEMAS = new Set([
|
|
26
|
+
'not',
|
|
27
|
+
'then',
|
|
28
|
+
'else',
|
|
29
|
+
'contains',
|
|
30
|
+
'propertyNames',
|
|
31
|
+
'items',
|
|
32
|
+
'additionalProperties',
|
|
33
|
+
'unevaluatedItems',
|
|
34
|
+
'unevaluatedProperties',
|
|
35
|
+
'prefixItems',
|
|
36
|
+
'dependentSchemas',
|
|
37
|
+
'dependentRequired',
|
|
38
|
+
]);
|
|
39
|
+
// `sign` makes a greater difference mean a tighter bound on both sides: a higher minimum and a
|
|
40
|
+
// lower maximum each accept fewer values.
|
|
41
|
+
const LOWER = {
|
|
42
|
+
name: 'Lower bound',
|
|
43
|
+
inclusive: 'minimum',
|
|
44
|
+
exclusive: 'exclusiveMinimum',
|
|
45
|
+
operator: '>',
|
|
46
|
+
sign: 1,
|
|
47
|
+
};
|
|
48
|
+
const UPPER = {
|
|
49
|
+
name: 'Upper bound',
|
|
50
|
+
inclusive: 'maximum',
|
|
51
|
+
exclusive: 'exclusiveMaximum',
|
|
52
|
+
operator: '<',
|
|
53
|
+
sign: -1,
|
|
54
|
+
};
|
|
55
|
+
// Accepting fewer values breaks the clients that send them; accepting more, the ones that read
|
|
56
|
+
// them.
|
|
57
|
+
function breaks(shift, directions) {
|
|
58
|
+
return ((shift !== 'more' && directions.includes('request')) ||
|
|
59
|
+
(shift !== 'fewer' && directions.includes('response')));
|
|
60
|
+
}
|
|
61
|
+
function shiftOf(keyword, before, after) {
|
|
62
|
+
if (Object.hasOwn(CONSTRAINING_FLAGS, keyword)) {
|
|
63
|
+
const wasConstrained = before === CONSTRAINING_FLAGS[keyword];
|
|
64
|
+
const isConstrained = after === CONSTRAINING_FLAGS[keyword];
|
|
65
|
+
if (wasConstrained === isConstrained)
|
|
66
|
+
return undefined;
|
|
67
|
+
return isConstrained ? 'fewer' : 'more';
|
|
68
|
+
}
|
|
69
|
+
if (!LOWER_LIMITS.has(keyword) && !UPPER_LIMITS.has(keyword) && !OPAQUE.has(keyword)) {
|
|
70
|
+
return undefined;
|
|
71
|
+
}
|
|
72
|
+
if (before === undefined)
|
|
73
|
+
return 'fewer';
|
|
74
|
+
if (after === undefined)
|
|
75
|
+
return 'more';
|
|
76
|
+
if (typeof before !== 'number' || typeof after !== 'number' || OPAQUE.has(keyword)) {
|
|
77
|
+
return 'unknown';
|
|
78
|
+
}
|
|
79
|
+
return LOWER_LIMITS.has(keyword) === after > before ? 'fewer' : 'more';
|
|
80
|
+
}
|
|
81
|
+
/** Above zero when `bound` accepts fewer values than `other`, below zero when it accepts more. */
|
|
82
|
+
function compareTightness(bound, other, side) {
|
|
83
|
+
if (bound.value !== other.value)
|
|
84
|
+
return (bound.value - other.value) * side.sign;
|
|
85
|
+
return Number(bound.exclusive) - Number(other.exclusive);
|
|
86
|
+
}
|
|
87
|
+
// OpenAPI 3.0 makes `minimum` exclusive with `exclusiveMinimum: true`; OpenAPI 3.1 gives
|
|
88
|
+
// `exclusiveMinimum` a value of its own, and the tighter of the two keywords is the bound.
|
|
89
|
+
function boundOf(schema, side) {
|
|
90
|
+
const inclusive = fieldOf(schema, side.inclusive);
|
|
91
|
+
const exclusive = fieldOf(schema, side.exclusive);
|
|
92
|
+
if (typeof exclusive === 'number') {
|
|
93
|
+
const exclusiveBound = { value: exclusive, exclusive: true };
|
|
94
|
+
if (typeof inclusive !== 'number')
|
|
95
|
+
return exclusiveBound;
|
|
96
|
+
const inclusiveBound = { value: inclusive, exclusive: false };
|
|
97
|
+
return compareTightness(inclusiveBound, exclusiveBound, side) > 0
|
|
98
|
+
? inclusiveBound
|
|
99
|
+
: exclusiveBound;
|
|
100
|
+
}
|
|
101
|
+
if (typeof inclusive === 'number')
|
|
102
|
+
return { value: inclusive, exclusive: exclusive === true };
|
|
103
|
+
return undefined;
|
|
104
|
+
}
|
|
105
|
+
/** Above zero when the side accepts fewer values after the change, below zero when more. */
|
|
106
|
+
function tighteningOf(before, after, side) {
|
|
107
|
+
if (!before)
|
|
108
|
+
return 1;
|
|
109
|
+
if (!after)
|
|
110
|
+
return -1;
|
|
111
|
+
return compareTightness(after, before, side);
|
|
112
|
+
}
|
|
113
|
+
function describeBound(bound, side) {
|
|
114
|
+
return bound && `${side.operator}${bound.exclusive ? '' : '='} ${bound.value}`;
|
|
115
|
+
}
|
|
116
|
+
// A subschema constrains the values: added, the schema accepts fewer; removed, it accepts more.
|
|
117
|
+
const judgeSubschema = (change, { report, getDirections }) => {
|
|
118
|
+
const keyword = latestOf(change.node);
|
|
119
|
+
const key = String(keyword.key);
|
|
120
|
+
if (change.kind === 'modified' || keyKindOf(keyword) !== 'field' || !SUBSCHEMAS.has(key))
|
|
121
|
+
return;
|
|
122
|
+
const added = change.kind === 'added';
|
|
123
|
+
const parent = change.node.parent;
|
|
124
|
+
const other = added ? parent?.base : parent?.revision;
|
|
125
|
+
// A schema in place of `additionalProperties: false` accepts more; the flag's change reports it.
|
|
126
|
+
if (Object.hasOwn(CONSTRAINING_FLAGS, key) && fieldOf(other, key) === CONSTRAINING_FLAGS[key]) {
|
|
127
|
+
return;
|
|
128
|
+
}
|
|
129
|
+
if (!breaks(added ? 'fewer' : 'more', getDirections()))
|
|
130
|
+
return;
|
|
131
|
+
report({ message: `\`${key}\`${ofNamedSchema(parent)} was ${added ? 'added' : 'removed'}.` });
|
|
132
|
+
};
|
|
133
|
+
function judgeKeyword(change, { report, getDirections }) {
|
|
134
|
+
const { value: before } = change.base;
|
|
135
|
+
const { value: after } = change.revision;
|
|
136
|
+
const shift = shiftOf(change.property, before, after);
|
|
137
|
+
if (!shift || !breaks(shift, getDirections()))
|
|
138
|
+
return;
|
|
139
|
+
const subject = `\`${change.property}\`${ofNamedSchema(change.node)}`;
|
|
140
|
+
if (before === undefined)
|
|
141
|
+
report({ message: `${subject} was set to '${after}'.` });
|
|
142
|
+
else if (after === undefined)
|
|
143
|
+
report({ message: `${subject} was removed.` });
|
|
144
|
+
else
|
|
145
|
+
report({ message: `${subject} changed from '${before}' to '${after}'.` });
|
|
146
|
+
}
|
|
147
|
+
// Both keywords of a side can change together, so the side is judged once: by its inclusive
|
|
148
|
+
// keyword when that one changed.
|
|
149
|
+
function judgeBound(change, side, { report, getDirections }) {
|
|
150
|
+
const { base, revision } = change.node;
|
|
151
|
+
const inclusiveChanged = !dequal(fieldOf(base, side.inclusive), fieldOf(revision, side.inclusive));
|
|
152
|
+
if (change.property === side.exclusive && inclusiveChanged)
|
|
153
|
+
return;
|
|
154
|
+
const beforeBound = boundOf(base, side);
|
|
155
|
+
const afterBound = boundOf(revision, side);
|
|
156
|
+
if (!beforeBound && !afterBound)
|
|
157
|
+
return;
|
|
158
|
+
const tightening = tighteningOf(beforeBound, afterBound, side);
|
|
159
|
+
if (tightening === 0 || !breaks(tightening > 0 ? 'fewer' : 'more', getDirections()))
|
|
160
|
+
return;
|
|
161
|
+
const subject = `${side.name}${ofNamedSchema(change.node)}`;
|
|
162
|
+
const before = describeBound(beforeBound, side);
|
|
163
|
+
const after = describeBound(afterBound, side);
|
|
164
|
+
if (before === undefined)
|
|
165
|
+
report({ message: `${subject} was set to '${after}'.` });
|
|
166
|
+
else if (after === undefined)
|
|
167
|
+
report({ message: `${subject} was removed.` });
|
|
168
|
+
else
|
|
169
|
+
report({ message: `${subject} changed from '${before}' to '${after}'.` });
|
|
170
|
+
}
|
|
171
|
+
export const SchemaConstraintChanged = () => ({
|
|
172
|
+
Schema(change, context) {
|
|
173
|
+
if (change.kind !== 'modified')
|
|
174
|
+
return judgeSubschema(change, context);
|
|
175
|
+
const side = [LOWER, UPPER].find(({ inclusive, exclusive }) => change.property === inclusive || change.property === exclusive);
|
|
176
|
+
if (side)
|
|
177
|
+
judgeBound(change, side, context);
|
|
178
|
+
else
|
|
179
|
+
judgeKeyword(change, context);
|
|
180
|
+
},
|
|
181
|
+
SchemaList: judgeSubschema,
|
|
182
|
+
SchemaMap: judgeSubschema,
|
|
183
|
+
DependentRequired: judgeSubschema,
|
|
184
|
+
});
|
|
185
|
+
//# sourceMappingURL=schema-constraint-changed.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-constraint-changed.js","sourceRoot":"","sources":["../../../src/diff/rules/schema-constraint-changed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAO3C,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC;AACzE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC;AACzE,gGAAgG;AAChG,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC;IACrB,YAAY;IACZ,SAAS;IACT,QAAQ;IACR,OAAO;IACP,iBAAiB;IACjB,kBAAkB;CACnB,CAAC,CAAC;AACH,+DAA+D;AAC/D,MAAM,kBAAkB,GAA4B;IAClD,WAAW,EAAE,IAAI;IACjB,oBAAoB,EAAE,KAAK;IAC3B,gBAAgB,EAAE,KAAK;IACvB,qBAAqB,EAAE,KAAK;IAC5B,KAAK,EAAE,KAAK;CACb,CAAC;AACF,sDAAsD;AACtD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,KAAK;IACL,MAAM;IACN,MAAM;IACN,UAAU;IACV,eAAe;IACf,OAAO;IACP,sBAAsB;IACtB,kBAAkB;IAClB,uBAAuB;IACvB,aAAa;IACb,kBAAkB;IAClB,mBAAmB;CACpB,CAAC,CAAC;AAIH,+FAA+F;AAC/F,0CAA0C;AAC1C,MAAM,KAAK,GAAG;IACZ,IAAI,EAAE,aAAa;IACnB,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,kBAAkB;IAC7B,QAAQ,EAAE,GAAG;IACb,IAAI,EAAE,CAAC;CACR,CAAC;AACF,MAAM,KAAK,GAAG;IACZ,IAAI,EAAE,aAAa;IACnB,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,kBAAkB;IAC7B,QAAQ,EAAE,GAAG;IACb,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAGF,+FAA+F;AAC/F,QAAQ;AACR,SAAS,MAAM,CAAC,KAAY,EAAE,UAAuB;IACnD,OAAO,CACL,CAAC,KAAK,KAAK,MAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC,KAAK,KAAK,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CACvD,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAAe,EAAE,MAAe,EAAE,KAAc;IAC/D,IAAI,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,CAAC;QAC/C,MAAM,cAAc,GAAG,MAAM,KAAK,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,aAAa,GAAG,KAAK,KAAK,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC5D,IAAI,cAAc,KAAK,aAAa;YAAE,OAAO,SAAS,CAAC;QACvD,OAAO,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IAC1C,CAAC;IACD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QACrF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC;IACzC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACvC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QACnF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;AACzE,CAAC;AAED,kGAAkG;AAClG,SAAS,gBAAgB,CAAC,KAAY,EAAE,KAAY,EAAE,IAAU;IAC9D,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;QAAE,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;IAChF,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAC3D,CAAC;AAED,yFAAyF;AACzF,2FAA2F;AAC3F,SAAS,OAAO,CAAC,MAA6B,EAAE,IAAU;IACxD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,cAAc,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAC7D,IAAI,OAAO,SAAS,KAAK,QAAQ;YAAE,OAAO,cAAc,CAAC;QACzD,MAAM,cAAc,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAC9D,OAAO,gBAAgB,CAAC,cAAc,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC;YAC/D,CAAC,CAAC,cAAc;YAChB,CAAC,CAAC,cAAc,CAAC;IACrB,CAAC;IACD,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,KAAK,IAAI,EAAE,CAAC;IAC9F,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,4FAA4F;AAC5F,SAAS,YAAY,CAAC,MAAyB,EAAE,KAAwB,EAAE,IAAU;IACnF,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,CAAC;IACtB,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC,CAAC;IACtB,OAAO,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,aAAa,CAAC,KAAwB,EAAE,IAAU;IACzD,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;AACjF,CAAC;AAED,gGAAgG;AAChG,MAAM,cAAc,GAAc,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,EAAE;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO;IAEjG,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC;IACtC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;IAClC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC;IACtD,iGAAiG;IACjG,IAAI,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,GAAG,CAAC,IAAI,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9F,OAAO;IACT,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;QAAE,OAAO;IAE/D,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,GAAG,KAAK,aAAa,CAAC,MAAM,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC;AAChG,CAAC,CAAC;AAEF,SAAS,YAAY,CAAC,MAAsB,EAAE,EAAE,MAAM,EAAE,aAAa,EAAmB;IACtF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;IACtC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;IACzC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACtD,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,CAAC;QAAE,OAAO;IAEtD,MAAM,OAAO,GAAG,KAAK,MAAM,CAAC,QAAQ,KAAK,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IACtE,IAAI,MAAM,KAAK,SAAS;QAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,gBAAgB,KAAK,IAAI,EAAE,CAAC,CAAC;SAC9E,IAAI,KAAK,KAAK,SAAS;QAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,eAAe,EAAE,CAAC,CAAC;;QACxE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,kBAAkB,MAAM,SAAS,KAAK,IAAI,EAAE,CAAC,CAAC;AACjF,CAAC;AAED,4FAA4F;AAC5F,iCAAiC;AACjC,SAAS,UAAU,CACjB,MAAsB,EACtB,IAAU,EACV,EAAE,MAAM,EAAE,aAAa,EAAmB;IAE1C,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;IACvC,MAAM,gBAAgB,GAAG,CAAC,MAAM,CAC9B,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAC7B,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAClC,CAAC;IACF,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC,SAAS,IAAI,gBAAgB;QAAE,OAAO;IAEnE,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACxC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC3C,IAAI,CAAC,WAAW,IAAI,CAAC,UAAU;QAAE,OAAO;IAExC,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IAC/D,IAAI,UAAU,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;QAAE,OAAO;IAE5F,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IAC5D,MAAM,MAAM,GAAG,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAChD,MAAM,KAAK,GAAG,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAE9C,IAAI,MAAM,KAAK,SAAS;QAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,gBAAgB,KAAK,IAAI,EAAE,CAAC,CAAC;SAC9E,IAAI,KAAK,KAAK,SAAS;QAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,eAAe,EAAE,CAAC,CAAC;;QACxE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,kBAAkB,MAAM,SAAS,KAAK,IAAI,EAAE,CAAC,CAAC;AACjF,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAa,GAAG,EAAE,CAAC,CAAC;IACtD,MAAM,CAAC,MAAM,EAAE,OAAO;QACpB,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU;YAAE,OAAO,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEvE,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC9B,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,CAC7F,CAAC;QACF,IAAI,IAAI;YAAE,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;;YACvC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IACD,UAAU,EAAE,cAAc;IAC1B,SAAS,EAAE,cAAc;IACzB,iBAAiB,EAAE,cAAc;CAClC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-type-changed.d.ts","sourceRoot":"","sources":["../../../src/diff/rules/schema-type-changed.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AA0B5C,eAAO,MAAM,iBAAiB,EAAE,QAwB9B,CAAC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { fieldOf } from '../../node-tree/access.js';
|
|
2
|
+
import { dequal } from '../../utils/dequal.js';
|
|
3
|
+
import { ofNamedSchema } from './utils.js';
|
|
4
|
+
// `integer` accepts a subset of what `number` does, so it is the one implicit widening among
|
|
5
|
+
// the JSON Schema primitive types.
|
|
6
|
+
const WIDER_TYPE = { integer: 'number' };
|
|
7
|
+
/**
|
|
8
|
+
* The types a schema accepts, folding OpenAPI 3.0's `nullable: true` into the 3.1 spelling
|
|
9
|
+
* (`type: [..., 'null']`) so the two compare as equal.
|
|
10
|
+
*/
|
|
11
|
+
function acceptedTypes(type, nullable) {
|
|
12
|
+
const declared = Array.isArray(type) ? type : type === undefined ? [] : [type];
|
|
13
|
+
const types = declared.filter((value) => typeof value === 'string');
|
|
14
|
+
// Without a `type`, a schema already accepts `null` with every other type.
|
|
15
|
+
const addsNull = nullable === true && types.length > 0 && !types.includes('null');
|
|
16
|
+
return addsNull ? [...types, 'null'] : types;
|
|
17
|
+
}
|
|
18
|
+
function typesNotIn(types, accepted) {
|
|
19
|
+
return types.filter((type) => {
|
|
20
|
+
const wider = WIDER_TYPE[type];
|
|
21
|
+
return !accepted.includes(type) && (wider === undefined || !accepted.includes(wider));
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
export const SchemaTypeChanged = () => ({
|
|
25
|
+
Schema(change, { report, getDirections }) {
|
|
26
|
+
if (change.kind !== 'modified')
|
|
27
|
+
return;
|
|
28
|
+
const { base, revision } = change.node;
|
|
29
|
+
// A change to `type` or `nullable` is judged on what the schema accepts as a whole, and once:
|
|
30
|
+
// by `type` when both changed.
|
|
31
|
+
const typeChanged = !dequal(fieldOf(base, 'type'), fieldOf(revision, 'type'));
|
|
32
|
+
if (change.property !== 'type' && (change.property !== 'nullable' || typeChanged))
|
|
33
|
+
return;
|
|
34
|
+
const before = acceptedTypes(fieldOf(base, 'type'), fieldOf(base, 'nullable'));
|
|
35
|
+
const after = acceptedTypes(fieldOf(revision, 'type'), fieldOf(revision, 'nullable'));
|
|
36
|
+
// An absent `type` accepts every type: adding one narrows the schema, and removing one widens it.
|
|
37
|
+
const narrowed = after.length > 0 && (!before.length || typesNotIn(before, after).length > 0);
|
|
38
|
+
const widened = before.length > 0 && (!after.length || typesNotIn(after, before).length > 0);
|
|
39
|
+
const described = `from '${before.join(' | ') || 'any'}' to '${after.join(' | ') || 'any'}'`;
|
|
40
|
+
if (getDirections().includes('request') && narrowed) {
|
|
41
|
+
report({ message: `Type${ofNamedSchema(change.node)} narrowed ${described}.` });
|
|
42
|
+
}
|
|
43
|
+
if (getDirections().includes('response') && widened) {
|
|
44
|
+
report({ message: `Type${ofNamedSchema(change.node)} widened ${described}.` });
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
});
|
|
48
|
+
//# sourceMappingURL=schema-type-changed.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-type-changed.js","sourceRoot":"","sources":["../../../src/diff/rules/schema-type-changed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE/C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,6FAA6F;AAC7F,mCAAmC;AACnC,MAAM,UAAU,GAAoC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;AAE1E;;;GAGG;AACH,SAAS,aAAa,CAAC,IAAa,EAAE,QAAkB;IACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC;IACrF,2EAA2E;IAC3E,MAAM,QAAQ,GAAG,QAAQ,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClF,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC/C,CAAC;AAED,SAAS,UAAU,CAAC,KAAe,EAAE,QAAkB;IACrD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QAC3B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAa,GAAG,EAAE,CAAC,CAAC;IAChD,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE;QACtC,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU;YAAE,OAAO;QAEvC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;QACvC,8FAA8F;QAC9F,+BAA+B;QAC/B,MAAM,WAAW,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9E,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,UAAU,IAAI,WAAW,CAAC;YAAE,OAAO;QAE1F,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QAC/E,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;QACtF,kGAAkG;QAClG,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC9F,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC7F,MAAM,SAAS,GAAG,SAAS,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC;QAE7F,IAAI,aAAa,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,QAAQ,EAAE,CAAC;YACpD,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,SAAS,GAAG,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,IAAI,aAAa,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,OAAO,EAAE,CAAC;YACpD,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,SAAS,GAAG,EAAE,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"security-requirement-changed.d.ts","sourceRoot":"","sources":["../../../src/diff/rules/security-requirement-changed.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAsB5C,eAAO,MAAM,0BAA0B,EAAE,QAyCvC,CAAC"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { valueOf } from '../../node-tree/access.js';
|
|
2
|
+
import { isPlainObject } from '../../utils/is-plain-object.js';
|
|
3
|
+
import { itemsNotIn } from '../../utils/items-not-in.js';
|
|
4
|
+
// A client passes a requirement when it has every scheme of it, with every scope that the scheme
|
|
5
|
+
// asks for. An empty list, or a missing one, asks for no authentication.
|
|
6
|
+
function passesOne(credentials, requirements) {
|
|
7
|
+
if (!Array.isArray(requirements) || requirements.length === 0)
|
|
8
|
+
return true;
|
|
9
|
+
return requirements.some((requirement) => isPlainObject(requirement) &&
|
|
10
|
+
Object.entries(requirement).every(([scheme, scopes]) => scheme in credentials && itemsNotIn(scopes, credentials[scheme]).length === 0));
|
|
11
|
+
}
|
|
12
|
+
// Security sits outside the request/response split, so the rule does not read the direction.
|
|
13
|
+
// Each change asks one question: do the clients that authenticated before still pass one of the
|
|
14
|
+
// requirements of the revision?
|
|
15
|
+
export const SecurityRequirementChanged = () => ({
|
|
16
|
+
SecurityRequirementList(change, { report }) {
|
|
17
|
+
if (change.kind === 'added' && !passesOne({}, change.revision.value)) {
|
|
18
|
+
report({ message: 'Authentication became required.' });
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
SecurityRequirement(change, { report }) {
|
|
22
|
+
const list = change.node.parent;
|
|
23
|
+
const requirements = list?.revision && valueOf(list.revision);
|
|
24
|
+
if (change.kind === 'added') {
|
|
25
|
+
// Before, the list was empty and asked for no authentication; otherwise the new
|
|
26
|
+
// requirement only offers one more way to pass.
|
|
27
|
+
const before = list?.base && valueOf(list.base);
|
|
28
|
+
if (Array.isArray(before) && before.length === 0 && !passesOne({}, requirements)) {
|
|
29
|
+
report({ message: 'Authentication became required.' });
|
|
30
|
+
}
|
|
31
|
+
return;
|
|
32
|
+
}
|
|
33
|
+
const credentials = change.node.base && valueOf(change.node.base);
|
|
34
|
+
if (!isPlainObject(credentials) || passesOne(credentials, requirements))
|
|
35
|
+
return;
|
|
36
|
+
const schemes = Object.keys(credentials).join(' + ');
|
|
37
|
+
if (change.kind === 'removed') {
|
|
38
|
+
report({ message: `Security requirement \`${schemes}\` is no longer accepted.` });
|
|
39
|
+
}
|
|
40
|
+
else if (change.base.value === undefined) {
|
|
41
|
+
// A scheme the requirement did not have: a client must now hold it too.
|
|
42
|
+
report({
|
|
43
|
+
message: `Security requirement \`${schemes}\` now requires \`${change.property}\`.`,
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
else {
|
|
47
|
+
// The requirement keeps this scheme: its value is the list of scopes.
|
|
48
|
+
const added = itemsNotIn(change.revision.value, change.base.value);
|
|
49
|
+
if (!added.length)
|
|
50
|
+
return;
|
|
51
|
+
const scopes = added.map((scope) => `'${scope}'`).join(', ');
|
|
52
|
+
report({
|
|
53
|
+
message: `Security scheme \`${change.property}\` requires new scopes: ${scopes}.`,
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
});
|
|
58
|
+
//# sourceMappingURL=security-requirement-changed.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"security-requirement-changed.js","sourceRoot":"","sources":["../../../src/diff/rules/security-requirement-changed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAMzD,iGAAiG;AACjG,yEAAyE;AACzE,SAAS,SAAS,CAAC,WAAwB,EAAE,YAAqB;IAChE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC3E,OAAO,YAAY,CAAC,IAAI,CACtB,CAAC,WAAW,EAAE,EAAE,CACd,aAAa,CAAC,WAAW,CAAC;QAC1B,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAC/B,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CACnB,MAAM,IAAI,WAAW,IAAI,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAChF,CACJ,CAAC;AACJ,CAAC;AAED,6FAA6F;AAC7F,gGAAgG;AAChG,gCAAgC;AAChC,MAAM,CAAC,MAAM,0BAA0B,GAAa,GAAG,EAAE,CAAC,CAAC;IACzD,uBAAuB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE;QACxC,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACrE,MAAM,CAAC,EAAE,OAAO,EAAE,iCAAiC,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IACD,mBAAmB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE;QACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,YAAY,GAAG,IAAI,EAAE,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE9D,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC5B,gFAAgF;YAChF,gDAAgD;YAChD,MAAM,MAAM,GAAG,IAAI,EAAE,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC;gBACjF,MAAM,CAAC,EAAE,OAAO,EAAE,iCAAiC,EAAE,CAAC,CAAC;YACzD,CAAC;YACD,OAAO;QACT,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,SAAS,CAAC,WAAW,EAAE,YAAY,CAAC;YAAE,OAAO;QAEhF,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,EAAE,OAAO,EAAE,0BAA0B,OAAO,2BAA2B,EAAE,CAAC,CAAC;QACpF,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC3C,wEAAwE;YACxE,MAAM,CAAC;gBACL,OAAO,EAAE,0BAA0B,OAAO,qBAAqB,MAAM,CAAC,QAAQ,KAAK;aACpF,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,sEAAsE;YACtE,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK,CAAC,MAAM;gBAAE,OAAO;YAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7D,MAAM,CAAC;gBACL,OAAO,EAAE,qBAAqB,MAAM,CAAC,QAAQ,2BAA2B,MAAM,GAAG;aAClF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"security-scheme-changed.d.ts","sourceRoot":"","sources":["../../../src/diff/rules/security-scheme-changed.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAW5C,eAAO,MAAM,qBAAqB,EAAE,QAoBlC,CAAC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { fieldOf } from '../../node-tree/access.js';
|
|
2
|
+
import { nameOf } from '../diff-node.js';
|
|
3
|
+
const SCHEME_IDENTITY = new Set([
|
|
4
|
+
'type',
|
|
5
|
+
'scheme',
|
|
6
|
+
'in',
|
|
7
|
+
'name',
|
|
8
|
+
'bearerFormat',
|
|
9
|
+
'openIdConnectUrl',
|
|
10
|
+
]);
|
|
11
|
+
export const SecuritySchemeChanged = () => ({
|
|
12
|
+
SecurityScheme(change, { report }) {
|
|
13
|
+
if (change.kind === 'removed') {
|
|
14
|
+
report({ message: `Security scheme \`${nameOf(change.node)}\` was removed.` });
|
|
15
|
+
}
|
|
16
|
+
if (change.kind !== 'modified' || !SCHEME_IDENTITY.has(change.property))
|
|
17
|
+
return;
|
|
18
|
+
// Switching the scheme's `type` drags its other fields along (an apiKey has
|
|
19
|
+
// `in`/`name`, a bearer has `scheme`), so the type change speaks for them all.
|
|
20
|
+
const typeChanged = fieldOf(change.node.base, 'type') !== fieldOf(change.node.revision, 'type');
|
|
21
|
+
if (typeChanged && change.property !== 'type')
|
|
22
|
+
return;
|
|
23
|
+
const subject = `\`${change.property}\` of security scheme \`${nameOf(change.node)}\``;
|
|
24
|
+
const { value: before } = change.base;
|
|
25
|
+
const { value: after } = change.revision;
|
|
26
|
+
if (before === undefined)
|
|
27
|
+
report({ message: `${subject} was set to '${after}'.` });
|
|
28
|
+
else if (after === undefined)
|
|
29
|
+
report({ message: `${subject} was removed.` });
|
|
30
|
+
else
|
|
31
|
+
report({ message: `${subject} changed from '${before}' to '${after}'.` });
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
//# sourceMappingURL=security-scheme-changed.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"security-scheme-changed.js","sourceRoot":"","sources":["../../../src/diff/rules/security-scheme-changed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAGzC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC;IAC9B,MAAM;IACN,QAAQ;IACR,IAAI;IACJ,MAAM;IACN,cAAc;IACd,kBAAkB;CACnB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,qBAAqB,GAAa,GAAG,EAAE,CAAC,CAAC;IACpD,cAAc,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE;QAC/B,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,EAAE,OAAO,EAAE,qBAAqB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,OAAO;QAEhF,4EAA4E;QAC5E,+EAA+E;QAC/E,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAChG,IAAI,WAAW,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM;YAAE,OAAO;QAEtD,MAAM,OAAO,GAAG,KAAK,MAAM,CAAC,QAAQ,2BAA2B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACvF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;QACtC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;QAEzC,IAAI,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,gBAAgB,KAAK,IAAI,EAAE,CAAC,CAAC;aAC9E,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,eAAe,EAAE,CAAC,CAAC;;YACxE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,kBAAkB,MAAM,SAAS,KAAK,IAAI,EAAE,CAAC,CAAC;IACjF,CAAC;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server-removed.d.ts","sourceRoot":"","sources":["../../../src/diff/rules/server-removed.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAa,MAAM,aAAa,CAAC;AAavD,eAAO,MAAM,aAAa,EAAE,QA2B1B,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { fieldOf } from '../../node-tree/access.js';
|
|
2
|
+
import { latestOf, nameOf } from '../diff-node.js';
|
|
3
|
+
import { isRootField } from './utils.js';
|
|
4
|
+
const ADDRESS = new Set(['host', 'pathname', 'protocol']);
|
|
5
|
+
// An OpenAPI path or operation that loses its own `servers` falls back to the document's, so only
|
|
6
|
+
// the document's list counts.
|
|
7
|
+
const allServersRemoved = (change, { report }) => {
|
|
8
|
+
if (change.kind === 'removed' && isRootField(change.node)) {
|
|
9
|
+
report({ message: 'All servers were removed.' });
|
|
10
|
+
}
|
|
11
|
+
};
|
|
12
|
+
export const ServerRemoved = () => ({
|
|
13
|
+
Server(change, { report }) {
|
|
14
|
+
if (change.kind === 'removed') {
|
|
15
|
+
const url = fieldOf(latestOf(change.node), 'url');
|
|
16
|
+
const name = typeof url === 'string' ? url : nameOf(change.node);
|
|
17
|
+
report({ message: `Server \`${name}\` was removed.` });
|
|
18
|
+
}
|
|
19
|
+
if (change.kind !== 'modified')
|
|
20
|
+
return;
|
|
21
|
+
// An OpenAPI server is known by its URL; an AsyncAPI one by its key, and it moves with its
|
|
22
|
+
// `host`, `pathname`, or `protocol`.
|
|
23
|
+
const { value: before } = change.base;
|
|
24
|
+
const { value: after } = change.revision;
|
|
25
|
+
if (change.property === 'url') {
|
|
26
|
+
report({ message: `Server \`${before}\` became \`${after}\`.` });
|
|
27
|
+
}
|
|
28
|
+
if (ADDRESS.has(change.property)) {
|
|
29
|
+
const subject = `\`${change.property}\` of server \`${nameOf(change.node)}\``;
|
|
30
|
+
if (before === undefined)
|
|
31
|
+
report({ message: `${subject} was set to '${after}'.` });
|
|
32
|
+
else if (after === undefined)
|
|
33
|
+
report({ message: `${subject} was removed.` });
|
|
34
|
+
else
|
|
35
|
+
report({ message: `${subject} changed from '${before}' to '${after}'.` });
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
ServerMap: allServersRemoved,
|
|
39
|
+
ServerList: allServersRemoved,
|
|
40
|
+
});
|
|
41
|
+
//# sourceMappingURL=server-removed.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server-removed.js","sourceRoot":"","sources":["../../../src/diff/rules/server-removed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;AAE1D,kGAAkG;AAClG,8BAA8B;AAC9B,MAAM,iBAAiB,GAAc,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;IAC1D,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1D,MAAM,CAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC,CAAC;IACnD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAa,GAAG,EAAE,CAAC,CAAC;IAC5C,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE;QACvB,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;YAClD,MAAM,IAAI,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACjE,MAAM,CAAC,EAAE,OAAO,EAAE,YAAY,IAAI,iBAAiB,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU;YAAE,OAAO;QAEvC,2FAA2F;QAC3F,qCAAqC;QACrC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;QACtC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;QAEzC,IAAI,MAAM,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;YAC9B,MAAM,CAAC,EAAE,OAAO,EAAE,YAAY,MAAM,eAAe,KAAK,KAAK,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,MAAM,OAAO,GAAG,KAAK,MAAM,CAAC,QAAQ,kBAAkB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YAE9E,IAAI,MAAM,KAAK,SAAS;gBAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,gBAAgB,KAAK,IAAI,EAAE,CAAC,CAAC;iBAC9E,IAAI,KAAK,KAAK,SAAS;gBAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,eAAe,EAAE,CAAC,CAAC;;gBACxE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,kBAAkB,MAAM,SAAS,KAAK,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IACD,SAAS,EAAE,iBAAiB;IAC5B,UAAU,EAAE,iBAAiB;CAC9B,CAAC,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { DiffNode } from '../types.js';
|
|
2
|
+
/** `` of `Order` `` for a property or a component schema; nothing for an inline one. */
|
|
3
|
+
export declare function ofNamedSchema(schema: DiffNode | null | undefined): string;
|
|
4
|
+
export declare function propertiesMarkedAs(schema: DiffNode, keyword: 'readOnly' | 'writeOnly'): string[];
|
|
5
|
+
export declare function isRootField(node: DiffNode): boolean;
|
|
6
|
+
//# sourceMappingURL=utils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/diff/rules/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,wFAAwF;AACxF,wBAAgB,aAAa,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAMzE;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,GAAG,WAAW,GAAG,MAAM,EAAE,CAchG;AAGD,wBAAgB,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAEnD"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { fieldOf } from '../../node-tree/access.js';
|
|
2
|
+
import { comparedSidesOf, latestOf, nameOf, typeOf } from '../diff-node.js';
|
|
3
|
+
/** `` of `Order` `` for a property or a component schema; nothing for an inline one. */
|
|
4
|
+
export function ofNamedSchema(schema) {
|
|
5
|
+
if (!schema)
|
|
6
|
+
return '';
|
|
7
|
+
const container = latestOf(comparedSidesOf(schema)).parent?.type.name;
|
|
8
|
+
const isNamed = container === 'SchemaProperties' || container === 'NamedSchemas';
|
|
9
|
+
return isNamed ? ` of \`${nameOf(schema)}\`` : '';
|
|
10
|
+
}
|
|
11
|
+
export function propertiesMarkedAs(schema, keyword) {
|
|
12
|
+
const latestByName = new Map();
|
|
13
|
+
const sides = comparedSidesOf(schema);
|
|
14
|
+
for (const side of [sides.base, sides.revision]) {
|
|
15
|
+
const properties = side?.children.find((child) => child.type.name === 'SchemaProperties');
|
|
16
|
+
for (const property of properties?.children ?? []) {
|
|
17
|
+
latestByName.set(String(property.key), property);
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
return [...latestByName.keys()].filter((name) => fieldOf(latestByName.get(name), keyword) === true);
|
|
21
|
+
}
|
|
22
|
+
// `components` has maps of the same types as the document; only the document's own count.
|
|
23
|
+
export function isRootField(node) {
|
|
24
|
+
return node.parent !== null && typeOf(node.parent) === 'Root';
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/diff/rules/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAG5E,wFAAwF;AACxF,MAAM,UAAU,aAAa,CAAC,MAAmC;IAC/D,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAEvB,MAAM,SAAS,GAAG,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC;IACtE,MAAM,OAAO,GAAG,SAAS,KAAK,kBAAkB,IAAI,SAAS,KAAK,cAAc,CAAC;IACjF,OAAO,OAAO,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,MAAgB,EAAE,OAAiC;IACpF,MAAM,YAAY,GAAG,IAAI,GAAG,EAAqB,CAAC;IAClD,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAEtC,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC;QAC1F,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,QAAQ,IAAI,EAAE,EAAE,CAAC;YAClD,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CACpC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,KAAK,IAAI,CAC5D,CAAC;AACJ,CAAC;AAED,0FAA0F;AAC1F,MAAM,UAAU,WAAW,CAAC,IAAc;IACxC,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;AAChE,CAAC"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import type { NodeEntry } from '../node-tree/types.js';
|
|
2
|
+
import type { SpecVersion } from '../oas-types.js';
|
|
3
|
+
import type { Location } from '../ref-utils.js';
|
|
4
|
+
import type { NormalizedProblem } from '../walk.js';
|
|
5
|
+
export type Impact = 'patch' | 'minor' | 'major';
|
|
6
|
+
export type Direction = 'request' | 'response';
|
|
7
|
+
export type Pair = {
|
|
8
|
+
base?: NodeEntry;
|
|
9
|
+
revision?: NodeEntry;
|
|
10
|
+
};
|
|
11
|
+
/** One place in both documents; `base` or `revision` is missing where it was added or removed. */
|
|
12
|
+
export type DiffNode = {
|
|
13
|
+
base?: NodeEntry;
|
|
14
|
+
revision?: NodeEntry;
|
|
15
|
+
parent: DiffNode | null;
|
|
16
|
+
/** The places that reach this pair after `parent` did; it is compared under `parent` only. */
|
|
17
|
+
referencedBy: DiffNode[];
|
|
18
|
+
};
|
|
19
|
+
export type LocatedNode = {
|
|
20
|
+
location: Location;
|
|
21
|
+
value: unknown;
|
|
22
|
+
};
|
|
23
|
+
export type Change = {
|
|
24
|
+
path: string;
|
|
25
|
+
node: DiffNode;
|
|
26
|
+
} & ({
|
|
27
|
+
kind: 'added';
|
|
28
|
+
revision: LocatedNode;
|
|
29
|
+
} | {
|
|
30
|
+
kind: 'removed';
|
|
31
|
+
base: LocatedNode;
|
|
32
|
+
} | {
|
|
33
|
+
kind: 'modified';
|
|
34
|
+
property: string;
|
|
35
|
+
base: LocatedNode;
|
|
36
|
+
revision: LocatedNode;
|
|
37
|
+
});
|
|
38
|
+
export type DiffRuleContext = {
|
|
39
|
+
report: (report: {
|
|
40
|
+
message: string;
|
|
41
|
+
location?: Location;
|
|
42
|
+
}) => void;
|
|
43
|
+
location: Location;
|
|
44
|
+
getDirections: () => Direction[];
|
|
45
|
+
specVersion: SpecVersion;
|
|
46
|
+
};
|
|
47
|
+
export type DiffVisit = (change: Change, context: DiffRuleContext) => void;
|
|
48
|
+
export type DiffVisitor = {
|
|
49
|
+
[type: string]: DiffVisit | DiffVisitor;
|
|
50
|
+
};
|
|
51
|
+
export type DiffRule = () => DiffVisitor;
|
|
52
|
+
export type RuleVerdict = {
|
|
53
|
+
ruleId: string;
|
|
54
|
+
impact: Impact;
|
|
55
|
+
message: string;
|
|
56
|
+
location: Location;
|
|
57
|
+
};
|
|
58
|
+
export type JudgedChange = Change & {
|
|
59
|
+
impact: Impact;
|
|
60
|
+
verdicts: RuleVerdict[];
|
|
61
|
+
};
|
|
62
|
+
export type DiffSummary = Record<Impact, number>;
|
|
63
|
+
export type DiffResult = {
|
|
64
|
+
files: {
|
|
65
|
+
base: string;
|
|
66
|
+
revision: string;
|
|
67
|
+
};
|
|
68
|
+
specVersions: {
|
|
69
|
+
base: SpecVersion;
|
|
70
|
+
revision: SpecVersion;
|
|
71
|
+
};
|
|
72
|
+
infoVersions: {
|
|
73
|
+
base?: string;
|
|
74
|
+
revision?: string;
|
|
75
|
+
};
|
|
76
|
+
summary: DiffSummary;
|
|
77
|
+
bump?: Impact;
|
|
78
|
+
changes: JudgedChange[];
|
|
79
|
+
problems: NormalizedProblem[];
|
|
80
|
+
};
|
|
81
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/diff/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEpD,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;AAEjD,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAE/C,MAAM,MAAM,IAAI,GAAG;IAAE,IAAI,CAAC,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE9D,kGAAkG;AAClG,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC;IACxB,8FAA8F;IAC9F,YAAY,EAAE,QAAQ,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAEjE,MAAM,MAAM,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,CACpD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,GACxC;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,WAAW,CAAA;CAAE,GACtC;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,WAAW,CAAC;CACvB,CACJ,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;KAAE,KAAK,IAAI,CAAC;IACnE,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,MAAM,SAAS,EAAE,CAAC;IACjC,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;AAC3E,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,CAAA;CAAE,CAAC;AACtE,MAAM,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,WAAW,EAAE,CAAA;CAAE,CAAC;AAChF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEjD,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,YAAY,EAAE;QACZ,IAAI,EAAE,WAAW,CAAC;QAClB,QAAQ,EAAE,WAAW,CAAC;KACvB,CAAC;IACF,YAAY,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B,CAAC"}
|