@inditextech/swagger-ui-plugin-diff-highlight 0.3.0-SNAPSHOT.108.1 → 0.3.0-SNAPSHOT.118.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/dist/index.js +82 -6
- package/dist/index.mjs +83 -7
- package/package.json +2 -2
package/dist/index.js
CHANGED
|
@@ -36,6 +36,13 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
|
|
37
37
|
// src/DiffHighlightPlugin.jsx
|
|
38
38
|
var import_react = __toESM(require("react"));
|
|
39
|
+
var EnumDiffContext = (0, import_react.createContext)(null);
|
|
40
|
+
var enumValueKey = (value) => JSON.stringify(
|
|
41
|
+
value,
|
|
42
|
+
(_, item) => item && typeof item === "object" && !Array.isArray(item) ? Object.fromEntries(
|
|
43
|
+
Object.keys(item).sort().map((key) => [key, item[key]])
|
|
44
|
+
) : item
|
|
45
|
+
);
|
|
39
46
|
var wrapContents = (status, children) => /* @__PURE__ */ import_react.default.createElement("div", { className: `diff-wrap diff-${status}`, style: { display: "contents" } }, children);
|
|
40
47
|
var readStatus = (immutableMap) => immutableMap && typeof immutableMap.get === "function" ? immutableMap.get("x-diff-status") : void 0;
|
|
41
48
|
var describeSchema = (schema) => {
|
|
@@ -55,19 +62,88 @@ var DiffHighlightPlugin = () => ({
|
|
|
55
62
|
* Schema properties: each property value is rendered as a nested `<Model>`.
|
|
56
63
|
*/
|
|
57
64
|
Model: (Original) => (props) => {
|
|
65
|
+
var _a, _b;
|
|
58
66
|
const status = readStatus(props.schema);
|
|
67
|
+
const original = (_a = props.schema) == null ? void 0 : _a.get("x-diff-original");
|
|
68
|
+
const updated = (_b = props.schema) == null ? void 0 : _b.get("x-diff-new");
|
|
69
|
+
const originalEnum = original == null ? void 0 : original.get("enum");
|
|
70
|
+
const updatedEnum = updated == null ? void 0 : updated.get("enum");
|
|
71
|
+
if (status === "updated" && (originalEnum || updatedEnum)) {
|
|
72
|
+
const type = props.schema.get("type") || "object";
|
|
73
|
+
const supplemental = type === "object" || type === "array";
|
|
74
|
+
const schema = supplemental ? props.schema.remove("enum").remove("x-diff-status").remove("x-diff-original").remove("x-diff-new") : props.schema.set("enum", updatedEnum || originalEnum);
|
|
75
|
+
return /* @__PURE__ */ import_react.default.createElement(
|
|
76
|
+
EnumDiffContext.Provider,
|
|
77
|
+
{
|
|
78
|
+
value: {
|
|
79
|
+
original,
|
|
80
|
+
updated,
|
|
81
|
+
supplemental,
|
|
82
|
+
getComponent: props.getComponent
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
/* @__PURE__ */ import_react.default.createElement(Original, { ...props, schema })
|
|
86
|
+
);
|
|
87
|
+
}
|
|
88
|
+
let content = /* @__PURE__ */ import_react.default.createElement(Original, { ...props });
|
|
59
89
|
if (status === "deleted") {
|
|
60
|
-
|
|
90
|
+
content = /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-deleted" }, /* @__PURE__ */ import_react.default.createElement(Original, { ...props }));
|
|
61
91
|
}
|
|
62
92
|
if (status === "added") {
|
|
63
|
-
|
|
93
|
+
content = /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-added" }, /* @__PURE__ */ import_react.default.createElement(Original, { ...props }));
|
|
64
94
|
}
|
|
65
95
|
if (status === "updated") {
|
|
66
|
-
const
|
|
67
|
-
const
|
|
68
|
-
|
|
96
|
+
const originalType = describeSchema(original);
|
|
97
|
+
const updatedType = describeSchema(updated);
|
|
98
|
+
content = /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-updated-inline" }, originalType === updatedType ? updatedType : /* @__PURE__ */ import_react.default.createElement(import_react.default.Fragment, null, /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-updated-old" }, originalType), /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-updated-arrow" }, " \u2192 "), /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-updated-new" }, updatedType)));
|
|
69
99
|
}
|
|
70
|
-
return /* @__PURE__ */ import_react.default.createElement(
|
|
100
|
+
return /* @__PURE__ */ import_react.default.createElement(EnumDiffContext.Provider, { value: null }, content);
|
|
101
|
+
},
|
|
102
|
+
ModelCollapse: (Original) => function ModelCollapse(props) {
|
|
103
|
+
const diff = (0, import_react.useContext)(EnumDiffContext);
|
|
104
|
+
if (!(diff == null ? void 0 : diff.supplemental)) return /* @__PURE__ */ import_react.default.createElement(Original, { ...props });
|
|
105
|
+
const EnumModel = diff.getComponent("EnumModel");
|
|
106
|
+
return /* @__PURE__ */ import_react.default.createElement(EnumDiffContext.Provider, { value: null }, /* @__PURE__ */ import_react.default.createElement(Original, { ...props }, props.children, /* @__PURE__ */ import_react.default.createElement(
|
|
107
|
+
EnumDiffContext.Provider,
|
|
108
|
+
{
|
|
109
|
+
value: { ...diff, supplemental: false }
|
|
110
|
+
},
|
|
111
|
+
/* @__PURE__ */ import_react.default.createElement(EnumModel, { getComponent: diff.getComponent })
|
|
112
|
+
)));
|
|
113
|
+
},
|
|
114
|
+
EnumModel: (Original) => function EnumModel(props) {
|
|
115
|
+
var _a, _b, _c, _d;
|
|
116
|
+
const diff = (0, import_react.useContext)(EnumDiffContext);
|
|
117
|
+
if (!diff) return /* @__PURE__ */ import_react.default.createElement(Original, { ...props });
|
|
118
|
+
const originalEnum = (_b = (_a = diff.original) == null ? void 0 : _a.get("enum")) == null ? void 0 : _b.toJS();
|
|
119
|
+
const updatedEnum = (_d = (_c = diff.updated) == null ? void 0 : _c.get("enum")) == null ? void 0 : _d.toJS();
|
|
120
|
+
const originalKeys = new Set(originalEnum == null ? void 0 : originalEnum.map(enumValueKey));
|
|
121
|
+
const updatedKeys = new Set(updatedEnum == null ? void 0 : updatedEnum.map(enumValueKey));
|
|
122
|
+
const values = (originalEnum || []).concat(
|
|
123
|
+
(updatedEnum == null ? void 0 : updatedEnum.filter(
|
|
124
|
+
(value) => !originalKeys.has(enumValueKey(value))
|
|
125
|
+
)) || []
|
|
126
|
+
);
|
|
127
|
+
const originalType = describeSchema(diff.original);
|
|
128
|
+
const updatedType = describeSchema(diff.updated);
|
|
129
|
+
const ModelCollapse = props.getComponent("ModelCollapse");
|
|
130
|
+
return /* @__PURE__ */ import_react.default.createElement("span", { className: "prop-enum" }, /* @__PURE__ */ import_react.default.createElement("br", null), originalType !== updatedType && /* @__PURE__ */ import_react.default.createElement("div", { className: "diff-type-change" }, "Type:", " ", /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-updated-inline" }, /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-updated-old" }, originalType), /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-updated-arrow" }, " \u2192 "), /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-updated-new" }, updatedType))), "Enum:", /* @__PURE__ */ import_react.default.createElement("br", null), /* @__PURE__ */ import_react.default.createElement(
|
|
131
|
+
ModelCollapse,
|
|
132
|
+
{
|
|
133
|
+
collapsedContent: /* @__PURE__ */ import_react.default.createElement("span", null, "Array [ ", values.length, " ]")
|
|
134
|
+
},
|
|
135
|
+
!originalEnum && /* @__PURE__ */ import_react.default.createElement(import_react.default.Fragment, null, /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-deleted" }, "unrestricted"), " "),
|
|
136
|
+
"[ ",
|
|
137
|
+
values.map((value, index) => /* @__PURE__ */ import_react.default.createElement(import_react.default.Fragment, { key: index }, index > 0 && ", ", /* @__PURE__ */ import_react.default.createElement(
|
|
138
|
+
"span",
|
|
139
|
+
{
|
|
140
|
+
className: !originalKeys.has(enumValueKey(value)) ? "diff-added" : !updatedKeys.has(enumValueKey(value)) ? "diff-deleted" : void 0
|
|
141
|
+
},
|
|
142
|
+
typeof value === "string" ? value : JSON.stringify(value)
|
|
143
|
+
))),
|
|
144
|
+
" ]",
|
|
145
|
+
!updatedEnum && /* @__PURE__ */ import_react.default.createElement(import_react.default.Fragment, null, " ", /* @__PURE__ */ import_react.default.createElement("span", { className: "diff-added" }, "unrestricted"))
|
|
146
|
+
));
|
|
71
147
|
},
|
|
72
148
|
/**
|
|
73
149
|
* Parameters: one `<tr>` per parameter; status lives on the param object.
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
// src/DiffHighlightPlugin.jsx
|
|
2
|
-
import React from "react";
|
|
2
|
+
import React, { createContext, useContext } from "react";
|
|
3
|
+
var EnumDiffContext = createContext(null);
|
|
4
|
+
var enumValueKey = (value) => JSON.stringify(
|
|
5
|
+
value,
|
|
6
|
+
(_, item) => item && typeof item === "object" && !Array.isArray(item) ? Object.fromEntries(
|
|
7
|
+
Object.keys(item).sort().map((key) => [key, item[key]])
|
|
8
|
+
) : item
|
|
9
|
+
);
|
|
3
10
|
var wrapContents = (status, children) => /* @__PURE__ */ React.createElement("div", { className: `diff-wrap diff-${status}`, style: { display: "contents" } }, children);
|
|
4
11
|
var readStatus = (immutableMap) => immutableMap && typeof immutableMap.get === "function" ? immutableMap.get("x-diff-status") : void 0;
|
|
5
12
|
var describeSchema = (schema) => {
|
|
@@ -19,19 +26,88 @@ var DiffHighlightPlugin = () => ({
|
|
|
19
26
|
* Schema properties: each property value is rendered as a nested `<Model>`.
|
|
20
27
|
*/
|
|
21
28
|
Model: (Original) => (props) => {
|
|
29
|
+
var _a, _b;
|
|
22
30
|
const status = readStatus(props.schema);
|
|
31
|
+
const original = (_a = props.schema) == null ? void 0 : _a.get("x-diff-original");
|
|
32
|
+
const updated = (_b = props.schema) == null ? void 0 : _b.get("x-diff-new");
|
|
33
|
+
const originalEnum = original == null ? void 0 : original.get("enum");
|
|
34
|
+
const updatedEnum = updated == null ? void 0 : updated.get("enum");
|
|
35
|
+
if (status === "updated" && (originalEnum || updatedEnum)) {
|
|
36
|
+
const type = props.schema.get("type") || "object";
|
|
37
|
+
const supplemental = type === "object" || type === "array";
|
|
38
|
+
const schema = supplemental ? props.schema.remove("enum").remove("x-diff-status").remove("x-diff-original").remove("x-diff-new") : props.schema.set("enum", updatedEnum || originalEnum);
|
|
39
|
+
return /* @__PURE__ */ React.createElement(
|
|
40
|
+
EnumDiffContext.Provider,
|
|
41
|
+
{
|
|
42
|
+
value: {
|
|
43
|
+
original,
|
|
44
|
+
updated,
|
|
45
|
+
supplemental,
|
|
46
|
+
getComponent: props.getComponent
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
/* @__PURE__ */ React.createElement(Original, { ...props, schema })
|
|
50
|
+
);
|
|
51
|
+
}
|
|
52
|
+
let content = /* @__PURE__ */ React.createElement(Original, { ...props });
|
|
23
53
|
if (status === "deleted") {
|
|
24
|
-
|
|
54
|
+
content = /* @__PURE__ */ React.createElement("span", { className: "diff-deleted" }, /* @__PURE__ */ React.createElement(Original, { ...props }));
|
|
25
55
|
}
|
|
26
56
|
if (status === "added") {
|
|
27
|
-
|
|
57
|
+
content = /* @__PURE__ */ React.createElement("span", { className: "diff-added" }, /* @__PURE__ */ React.createElement(Original, { ...props }));
|
|
28
58
|
}
|
|
29
59
|
if (status === "updated") {
|
|
30
|
-
const
|
|
31
|
-
const
|
|
32
|
-
|
|
60
|
+
const originalType = describeSchema(original);
|
|
61
|
+
const updatedType = describeSchema(updated);
|
|
62
|
+
content = /* @__PURE__ */ React.createElement("span", { className: "diff-updated-inline" }, originalType === updatedType ? updatedType : /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement("span", { className: "diff-updated-old" }, originalType), /* @__PURE__ */ React.createElement("span", { className: "diff-updated-arrow" }, " \u2192 "), /* @__PURE__ */ React.createElement("span", { className: "diff-updated-new" }, updatedType)));
|
|
33
63
|
}
|
|
34
|
-
return /* @__PURE__ */ React.createElement(
|
|
64
|
+
return /* @__PURE__ */ React.createElement(EnumDiffContext.Provider, { value: null }, content);
|
|
65
|
+
},
|
|
66
|
+
ModelCollapse: (Original) => function ModelCollapse(props) {
|
|
67
|
+
const diff = useContext(EnumDiffContext);
|
|
68
|
+
if (!(diff == null ? void 0 : diff.supplemental)) return /* @__PURE__ */ React.createElement(Original, { ...props });
|
|
69
|
+
const EnumModel = diff.getComponent("EnumModel");
|
|
70
|
+
return /* @__PURE__ */ React.createElement(EnumDiffContext.Provider, { value: null }, /* @__PURE__ */ React.createElement(Original, { ...props }, props.children, /* @__PURE__ */ React.createElement(
|
|
71
|
+
EnumDiffContext.Provider,
|
|
72
|
+
{
|
|
73
|
+
value: { ...diff, supplemental: false }
|
|
74
|
+
},
|
|
75
|
+
/* @__PURE__ */ React.createElement(EnumModel, { getComponent: diff.getComponent })
|
|
76
|
+
)));
|
|
77
|
+
},
|
|
78
|
+
EnumModel: (Original) => function EnumModel(props) {
|
|
79
|
+
var _a, _b, _c, _d;
|
|
80
|
+
const diff = useContext(EnumDiffContext);
|
|
81
|
+
if (!diff) return /* @__PURE__ */ React.createElement(Original, { ...props });
|
|
82
|
+
const originalEnum = (_b = (_a = diff.original) == null ? void 0 : _a.get("enum")) == null ? void 0 : _b.toJS();
|
|
83
|
+
const updatedEnum = (_d = (_c = diff.updated) == null ? void 0 : _c.get("enum")) == null ? void 0 : _d.toJS();
|
|
84
|
+
const originalKeys = new Set(originalEnum == null ? void 0 : originalEnum.map(enumValueKey));
|
|
85
|
+
const updatedKeys = new Set(updatedEnum == null ? void 0 : updatedEnum.map(enumValueKey));
|
|
86
|
+
const values = (originalEnum || []).concat(
|
|
87
|
+
(updatedEnum == null ? void 0 : updatedEnum.filter(
|
|
88
|
+
(value) => !originalKeys.has(enumValueKey(value))
|
|
89
|
+
)) || []
|
|
90
|
+
);
|
|
91
|
+
const originalType = describeSchema(diff.original);
|
|
92
|
+
const updatedType = describeSchema(diff.updated);
|
|
93
|
+
const ModelCollapse = props.getComponent("ModelCollapse");
|
|
94
|
+
return /* @__PURE__ */ React.createElement("span", { className: "prop-enum" }, /* @__PURE__ */ React.createElement("br", null), originalType !== updatedType && /* @__PURE__ */ React.createElement("div", { className: "diff-type-change" }, "Type:", " ", /* @__PURE__ */ React.createElement("span", { className: "diff-updated-inline" }, /* @__PURE__ */ React.createElement("span", { className: "diff-updated-old" }, originalType), /* @__PURE__ */ React.createElement("span", { className: "diff-updated-arrow" }, " \u2192 "), /* @__PURE__ */ React.createElement("span", { className: "diff-updated-new" }, updatedType))), "Enum:", /* @__PURE__ */ React.createElement("br", null), /* @__PURE__ */ React.createElement(
|
|
95
|
+
ModelCollapse,
|
|
96
|
+
{
|
|
97
|
+
collapsedContent: /* @__PURE__ */ React.createElement("span", null, "Array [ ", values.length, " ]")
|
|
98
|
+
},
|
|
99
|
+
!originalEnum && /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement("span", { className: "diff-deleted" }, "unrestricted"), " "),
|
|
100
|
+
"[ ",
|
|
101
|
+
values.map((value, index) => /* @__PURE__ */ React.createElement(React.Fragment, { key: index }, index > 0 && ", ", /* @__PURE__ */ React.createElement(
|
|
102
|
+
"span",
|
|
103
|
+
{
|
|
104
|
+
className: !originalKeys.has(enumValueKey(value)) ? "diff-added" : !updatedKeys.has(enumValueKey(value)) ? "diff-deleted" : void 0
|
|
105
|
+
},
|
|
106
|
+
typeof value === "string" ? value : JSON.stringify(value)
|
|
107
|
+
))),
|
|
108
|
+
" ]",
|
|
109
|
+
!updatedEnum && /* @__PURE__ */ React.createElement(React.Fragment, null, " ", /* @__PURE__ */ React.createElement("span", { className: "diff-added" }, "unrestricted"))
|
|
110
|
+
));
|
|
35
111
|
},
|
|
36
112
|
/**
|
|
37
113
|
* Parameters: one `<tr>` per parameter; status lives on the param object.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@inditextech/swagger-ui-plugin-diff-highlight",
|
|
3
|
-
"version": "0.3.0-SNAPSHOT.
|
|
3
|
+
"version": "0.3.0-SNAPSHOT.118.1",
|
|
4
4
|
"description": "Highlight API changes (added/updated/deleted) inline in swagger-ui-react via a custom diff-highlighting plugin.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"swagger",
|
|
@@ -79,7 +79,7 @@
|
|
|
79
79
|
"eslint-plugin-react": "^7.37.5",
|
|
80
80
|
"eslint-plugin-react-hooks": "^7.1.1",
|
|
81
81
|
"globals": "^17.7.0",
|
|
82
|
-
"immutable": "^
|
|
82
|
+
"immutable": "^5.1.9",
|
|
83
83
|
"jsdom": "^29.1.1",
|
|
84
84
|
"prettier": "^3.9.4",
|
|
85
85
|
"react": "^18.3.1",
|