npm - slds-json-schema-renderer - Versions diffs - 1.0.0 - Mend

slds-json-schema-renderer 1.0.0

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.

Files changed (14) hide show

package/LICENSE +21 -0
package/README.md +118 -0
package/bin/cli.js +35 -0
package/lib/cli/generate.js +110 -0
package/lib/cli/index.js +6 -0
package/lib/frontend/bundle.mjs +1009 -0
package/lib/frontend/bundle.umd.js +1 -0
package/lib/frontend/style.css +1 -0
package/lib/index.js +14 -0
package/lib/templates/index.html +21 -0
package/lib/utils/html-generator.js +160 -0
package/lib/utils/schema-parser.js +266 -0
package/package.json +90 -0
package/src/templates/index.html +21 -0

package/lib/index.js ADDED Viewed

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Main entry point for the JSON Schema Documentation Generator
+ */
+var schemaParser = require('./utils/schema-parser');
+var htmlGenerator = require('./utils/html-generator');
+var cli = require('./cli');
+module.exports = {
+  schemaParser: schemaParser,
+  htmlGenerator: htmlGenerator,
+  cli: cli
+};

package/lib/templates/index.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>JSON Schema Documentation</title>
+    <!-- Stylesheet -->
+    <link rel="stylesheet" href="assets/style.css">
+</head>
+<body>
+<!-- App will be rendered here -->
+<div id="app"></div>
+<!-- Vue 3 from CDN -->
+<script src="assets/vue.js"></script>
+<!-- App bundle -->
+<script src="assets/bundle.umd.js"></script>
+</body>
+</html>

package/lib/utils/html-generator.js ADDED Viewed

@@ -0,0 +1,160 @@
+"use strict";
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return e; }; var t, e = {}, r = Object.prototype, n = r.hasOwnProperty, o = Object.defineProperty || function (t, e, r) { t[e] = r.value; }, i = "function" == typeof Symbol ? Symbol : {}, a = i.iterator || "@@iterator", c = i.asyncIterator || "@@asyncIterator", u = i.toStringTag || "@@toStringTag"; function define(t, e, r) { return Object.defineProperty(t, e, { value: r, enumerable: !0, configurable: !0, writable: !0 }), t[e]; } try { define({}, ""); } catch (t) { define = function define(t, e, r) { return t[e] = r; }; } function wrap(t, e, r, n) { var i = e && e.prototype instanceof Generator ? e : Generator, a = Object.create(i.prototype), c = new Context(n || []); return o(a, "_invoke", { value: makeInvokeMethod(t, r, c) }), a; } function tryCatch(t, e, r) { try { return { type: "normal", arg: t.call(e, r) }; } catch (t) { return { type: "throw", arg: t }; } } e.wrap = wrap; var h = "suspendedStart", l = "suspendedYield", f = "executing", s = "completed", y = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var p = {}; define(p, a, function () { return this; }); var d = Object.getPrototypeOf, v = d && d(d(values([]))); v && v !== r && n.call(v, a) && (p = v); var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p); function defineIteratorMethods(t) { ["next", "throw", "return"].forEach(function (e) { define(t, e, function (t) { return this._invoke(e, t); }); }); } function AsyncIterator(t, e) { function invoke(r, o, i, a) { var c = tryCatch(t[r], t, o); if ("throw" !== c.type) { var u = c.arg, h = u.value; return h && "object" == _typeof(h) && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) { invoke("next", t, i, a); }, function (t) { invoke("throw", t, i, a); }) : e.resolve(h).then(function (t) { u.value = t, i(u); }, function (t) { return invoke("throw", t, i, a); }); } a(c.arg); } var r; o(this, "_invoke", { value: function value(t, n) { function callInvokeWithMethodAndArg() { return new e(function (e, r) { invoke(t, n, e, r); }); } return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(e, r, n) { var o = h; return function (i, a) { if (o === f) throw Error("Generator is already running"); if (o === s) { if ("throw" === i) throw a; return { value: t, done: !0 }; } for (n.method = i, n.arg = a;;) { var c = n.delegate; if (c) { var u = maybeInvokeDelegate(c, n); if (u) { if (u === y) continue; return u; } } if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) { if (o === h) throw o = s, n.arg; n.dispatchException(n.arg); } else "return" === n.method && n.abrupt("return", n.arg); o = f; var p = tryCatch(e, r, n); if ("normal" === p.type) { if (o = n.done ? s : l, p.arg === y) continue; return { value: p.arg, done: n.done }; } "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg); } }; } function maybeInvokeDelegate(e, r) { var n = r.method, o = e.iterator[n]; if (o === t) return r.delegate = null, "throw" === n && e.iterator.return && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y; var i = tryCatch(o, e.iterator, r.arg); if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y; var a = i.arg; return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y); } function pushTryEntry(t) { var e = { tryLoc: t[0] }; 1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e); } function resetTryEntry(t) { var e = t.completion || {}; e.type = "normal", delete e.arg, t.completion = e; } function Context(t) { this.tryEntries = [{ tryLoc: "root" }], t.forEach(pushTryEntry, this), this.reset(!0); } function values(e) { if (e || "" === e) { var r = e[a]; if (r) return r.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) { var o = -1, i = function next() { for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next; return next.value = t, next.done = !0, next; }; return i.next = i; } } throw new TypeError(_typeof(e) + " is not iterable"); } return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), o(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) { var e = "function" == typeof t && t.constructor; return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name)); }, e.mark = function (t) { return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t; }, e.awrap = function (t) { return { __await: t }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () { return this; }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) { void 0 === i && (i = Promise); var a = new AsyncIterator(wrap(t, r, n, o), i); return e.isGeneratorFunction(r) ? a : a.next().then(function (t) { return t.done ? t.value : a.next(); }); }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () { return this; }), define(g, "toString", function () { return "[object Generator]"; }), e.keys = function (t) { var e = Object(t), r = []; for (var n in e) r.push(n); return r.reverse(), function next() { for (; r.length;) { var t = r.pop(); if (t in e) return next.value = t, next.done = !1, next; } return next.done = !0, next; }; }, e.values = values, Context.prototype = { constructor: Context, reset: function reset(e) { if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t); }, stop: function stop() { this.done = !0; var t = this.tryEntries[0].completion; if ("throw" === t.type) throw t.arg; return this.rval; }, dispatchException: function dispatchException(e) { if (this.done) throw e; var r = this; function handle(n, o) { return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o; } for (var o = this.tryEntries.length - 1; o >= 0; --o) { var i = this.tryEntries[o], a = i.completion; if ("root" === i.tryLoc) return handle("end"); if (i.tryLoc <= this.prev) { var c = n.call(i, "catchLoc"), u = n.call(i, "finallyLoc"); if (c && u) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } else if (c) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); } else { if (!u) throw Error("try statement without catch or finally"); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } } } }, abrupt: function abrupt(t, e) { for (var r = this.tryEntries.length - 1; r >= 0; --r) { var o = this.tryEntries[r]; if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) { var i = o; break; } } i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null); var a = i ? i.completion : {}; return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a); }, complete: function complete(t, e) { if ("throw" === t.type) throw t.arg; return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y; }, finish: function finish(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y; } }, catch: function _catch(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.tryLoc === t) { var n = r.completion; if ("throw" === n.type) { var o = n.arg; resetTryEntry(r); } return o; } } throw Error("illegal catch attempt"); }, delegateYield: function delegateYield(e, r, n) { return this.delegate = { iterator: values(e), resultName: r, nextLoc: n }, "next" === this.method && (this.arg = t), y; } }, e; }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+var fs = require('fs-extra');
+var path = require('path');
+/**
+ * Generate HTML documentation from parsed JSON schemas
+ * @param {Object} options - Generation options
+ * @param {Array} options.schemas - Array of parsed schemas
+ * @param {string} options.outputDir - Output directory
+ * @param {string} options.title - Documentation title
+ * @param {string} options.description - Documentation description
+ */
+function generate(_x) {
+  return _generate.apply(this, arguments);
+}
+/**
+ * Copy assets to the output directory
+ * @param {string} outputDir - Output directory
+ */
+function _generate() {
+  _generate = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(options) {
+    var schemas, outputDir, title, description, templatePath, html, appData, scriptTag, outputPath;
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          schemas = options.schemas, outputDir = options.outputDir, title = options.title, description = options.description;
+          _context.prev = 1;
+          console.log('Preparing output directory...');
+          // Create the output directory if it doesn't exist
+          _context.next = 5;
+          return fs.ensureDir(outputDir);
+        case 5:
+          // Read the HTML template
+          templatePath = path.join(__dirname, '../templates/index.html');
+          _context.next = 8;
+          return fs.readFile(templatePath, 'utf8');
+        case 8:
+          html = _context.sent;
+          // Prepare the data for the Vue components
+          appData = {
+            title: title,
+            description: description,
+            schemas: schemas,
+            generatedAt: new Date().toISOString()
+          };
+          console.log('Creating HTML output...');
+          // Add the data to the window object so it can be used by Vue
+          scriptTag = "<script>\n      window.__JSON_SCHEMA_DOCS_DATA__ = ".concat(JSON.stringify(appData), ";\n    </script>"); // Insert the script tag before the closing body tag
+          html = html.replace('</body>', "".concat(scriptTag, "</body>"));
+          console.log('Writing HTML file...');
+          // Write the HTML to the output directory
+          outputPath = path.join(outputDir, 'index.html');
+          _context.next = 17;
+          return fs.writeFile(outputPath, html);
+        case 17:
+          _context.next = 19;
+          return copyAssets(outputDir);
+        case 19:
+          return _context.abrupt("return", {
+            outputPath: outputPath,
+            schemasProcessed: schemas.length
+          });
+        case 22:
+          _context.prev = 22;
+          _context.t0 = _context["catch"](1);
+          throw new Error("Failed to generate HTML: ".concat(_context.t0.message));
+        case 25:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[1, 22]]);
+  }));
+  return _generate.apply(this, arguments);
+}
+function copyAssets(_x2) {
+  return _copyAssets.apply(this, arguments);
+}
+function _copyAssets() {
+  _copyAssets = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2(outputDir) {
+    var assetsDir, bundlePath, bundleTarget, vuePath, vueTarget;
+    return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _context2.prev = 0;
+          console.log('Copying assets...');
+          // Create assets directory
+          assetsDir = path.join(outputDir, 'assets');
+          _context2.next = 5;
+          return fs.ensureDir(assetsDir);
+        case 5:
+          _context2.prev = 5;
+          // Vite produces both ES modules and UMD files - we'll use the UMD version for broader compatibility
+          bundlePath = path.resolve(__dirname, '../../lib/frontend/');
+          bundleTarget = assetsDir;
+          _context2.next = 10;
+          return fs.pathExists(bundlePath);
+        case 10:
+          if (!_context2.sent) {
+            _context2.next = 24;
+            break;
+          }
+          _context2.next = 13;
+          return fs.copy(bundlePath, bundleTarget);
+        case 13:
+          console.log('Frontend bundle copied successfully');
+          // Copy Vue as well since we're externalizing it
+          vuePath = path.resolve(__dirname, '../../node_modules/vue/dist/vue.global.prod.js');
+          vueTarget = path.join(assetsDir, 'vue.js');
+          _context2.next = 18;
+          return fs.pathExists(vuePath);
+        case 18:
+          if (!_context2.sent) {
+            _context2.next = 22;
+            break;
+          }
+          _context2.next = 21;
+          return fs.copy(vuePath, vueTarget);
+        case 21:
+          console.log('Vue bundle copied successfully');
+        case 22:
+          _context2.next = 28;
+          break;
+        case 24:
+          console.warn('Warning: Frontend bundle not found at', bundlePath);
+          console.warn('Make sure you run "npm run build:frontend" first');
+          // Create a placeholder bundle
+          _context2.next = 28;
+          return fs.writeFile(bundleTarget, '// Placeholder bundle');
+        case 28:
+          _context2.next = 33;
+          break;
+        case 30:
+          _context2.prev = 30;
+          _context2.t0 = _context2["catch"](5);
+          console.warn("Warning: Could not copy frontend bundle: ".concat(_context2.t0.message));
+        case 33:
+          _context2.next = 38;
+          break;
+        case 35:
+          _context2.prev = 35;
+          _context2.t1 = _context2["catch"](0);
+          throw new Error("Failed to copy assets: ".concat(_context2.t1.message));
+        case 38:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2, null, [[0, 35], [5, 30]]);
+  }));
+  return _copyAssets.apply(this, arguments);
+}
+module.exports = {
+  generate: generate
+};

package/lib/utils/schema-parser.js ADDED Viewed

@@ -0,0 +1,266 @@
+"use strict";
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return e; }; var t, e = {}, r = Object.prototype, n = r.hasOwnProperty, o = Object.defineProperty || function (t, e, r) { t[e] = r.value; }, i = "function" == typeof Symbol ? Symbol : {}, a = i.iterator || "@@iterator", c = i.asyncIterator || "@@asyncIterator", u = i.toStringTag || "@@toStringTag"; function define(t, e, r) { return Object.defineProperty(t, e, { value: r, enumerable: !0, configurable: !0, writable: !0 }), t[e]; } try { define({}, ""); } catch (t) { define = function define(t, e, r) { return t[e] = r; }; } function wrap(t, e, r, n) { var i = e && e.prototype instanceof Generator ? e : Generator, a = Object.create(i.prototype), c = new Context(n || []); return o(a, "_invoke", { value: makeInvokeMethod(t, r, c) }), a; } function tryCatch(t, e, r) { try { return { type: "normal", arg: t.call(e, r) }; } catch (t) { return { type: "throw", arg: t }; } } e.wrap = wrap; var h = "suspendedStart", l = "suspendedYield", f = "executing", s = "completed", y = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var p = {}; define(p, a, function () { return this; }); var d = Object.getPrototypeOf, v = d && d(d(values([]))); v && v !== r && n.call(v, a) && (p = v); var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p); function defineIteratorMethods(t) { ["next", "throw", "return"].forEach(function (e) { define(t, e, function (t) { return this._invoke(e, t); }); }); } function AsyncIterator(t, e) { function invoke(r, o, i, a) { var c = tryCatch(t[r], t, o); if ("throw" !== c.type) { var u = c.arg, h = u.value; return h && "object" == _typeof(h) && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) { invoke("next", t, i, a); }, function (t) { invoke("throw", t, i, a); }) : e.resolve(h).then(function (t) { u.value = t, i(u); }, function (t) { return invoke("throw", t, i, a); }); } a(c.arg); } var r; o(this, "_invoke", { value: function value(t, n) { function callInvokeWithMethodAndArg() { return new e(function (e, r) { invoke(t, n, e, r); }); } return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(e, r, n) { var o = h; return function (i, a) { if (o === f) throw Error("Generator is already running"); if (o === s) { if ("throw" === i) throw a; return { value: t, done: !0 }; } for (n.method = i, n.arg = a;;) { var c = n.delegate; if (c) { var u = maybeInvokeDelegate(c, n); if (u) { if (u === y) continue; return u; } } if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) { if (o === h) throw o = s, n.arg; n.dispatchException(n.arg); } else "return" === n.method && n.abrupt("return", n.arg); o = f; var p = tryCatch(e, r, n); if ("normal" === p.type) { if (o = n.done ? s : l, p.arg === y) continue; return { value: p.arg, done: n.done }; } "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg); } }; } function maybeInvokeDelegate(e, r) { var n = r.method, o = e.iterator[n]; if (o === t) return r.delegate = null, "throw" === n && e.iterator.return && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y; var i = tryCatch(o, e.iterator, r.arg); if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y; var a = i.arg; return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y); } function pushTryEntry(t) { var e = { tryLoc: t[0] }; 1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e); } function resetTryEntry(t) { var e = t.completion || {}; e.type = "normal", delete e.arg, t.completion = e; } function Context(t) { this.tryEntries = [{ tryLoc: "root" }], t.forEach(pushTryEntry, this), this.reset(!0); } function values(e) { if (e || "" === e) { var r = e[a]; if (r) return r.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) { var o = -1, i = function next() { for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next; return next.value = t, next.done = !0, next; }; return i.next = i; } } throw new TypeError(_typeof(e) + " is not iterable"); } return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), o(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) { var e = "function" == typeof t && t.constructor; return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name)); }, e.mark = function (t) { return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t; }, e.awrap = function (t) { return { __await: t }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () { return this; }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) { void 0 === i && (i = Promise); var a = new AsyncIterator(wrap(t, r, n, o), i); return e.isGeneratorFunction(r) ? a : a.next().then(function (t) { return t.done ? t.value : a.next(); }); }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () { return this; }), define(g, "toString", function () { return "[object Generator]"; }), e.keys = function (t) { var e = Object(t), r = []; for (var n in e) r.push(n); return r.reverse(), function next() { for (; r.length;) { var t = r.pop(); if (t in e) return next.value = t, next.done = !1, next; } return next.done = !0, next; }; }, e.values = values, Context.prototype = { constructor: Context, reset: function reset(e) { if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t); }, stop: function stop() { this.done = !0; var t = this.tryEntries[0].completion; if ("throw" === t.type) throw t.arg; return this.rval; }, dispatchException: function dispatchException(e) { if (this.done) throw e; var r = this; function handle(n, o) { return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o; } for (var o = this.tryEntries.length - 1; o >= 0; --o) { var i = this.tryEntries[o], a = i.completion; if ("root" === i.tryLoc) return handle("end"); if (i.tryLoc <= this.prev) { var c = n.call(i, "catchLoc"), u = n.call(i, "finallyLoc"); if (c && u) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } else if (c) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); } else { if (!u) throw Error("try statement without catch or finally"); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } } } }, abrupt: function abrupt(t, e) { for (var r = this.tryEntries.length - 1; r >= 0; --r) { var o = this.tryEntries[r]; if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) { var i = o; break; } } i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null); var a = i ? i.completion : {}; return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a); }, complete: function complete(t, e) { if ("throw" === t.type) throw t.arg; return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y; }, finish: function finish(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y; } }, catch: function _catch(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.tryLoc === t) { var n = r.completion; if ("throw" === n.type) { var o = n.arg; resetTryEntry(r); } return o; } } throw Error("illegal catch attempt"); }, delegateYield: function delegateYield(e, r, n) { return this.delegate = { iterator: values(e), resultName: r, nextLoc: n }, "next" === this.method && (this.arg = t), y; } }, e; }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+var fs = require('fs-extra');
+var path = require('path');
+var $RefParser = require('json-schema-ref-parser');
+var Ajv = require('ajv');
+var glob = require('glob');
+// Initialize AJV with options
+var ajv = new Ajv({
+  allErrors: true,
+  verbose: true,
+  strict: false
+});
+/**
+ * Parse a JSON schema file
+ * @param {string} filePath - Path to the JSON schema file
+ * @returns {Object} Parsed schema
+ */
+function parse(_x) {
+  return _parse.apply(this, arguments);
+}
+/**
+ * Process a schema to resolve references and add metadata
+ * @param {Object} schema - The JSON schema object
+ * @param {string} filePath - Path to the JSON schema file
+ * @returns {Object} Processed schema
+ */
+function _parse() {
+  _parse = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(filePath) {
+    var schemaContent, rawSchema, validate;
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _context.prev = 0;
+          _context.next = 3;
+          return fs.readFile(filePath, 'utf8');
+        case 3:
+          schemaContent = _context.sent;
+          _context.prev = 4;
+          rawSchema = JSON.parse(schemaContent);
+          _context.next = 11;
+          break;
+        case 8:
+          _context.prev = 8;
+          _context.t0 = _context["catch"](4);
+          throw new Error("Invalid JSON in file ".concat(filePath, ": ").concat(_context.t0.message));
+        case 11:
+          // Check if it's a valid JSON schema (should have a $schema property or type property)
+          if (!rawSchema.$schema && !rawSchema.type) {
+            console.warn("Warning: File ".concat(filePath, " may not be a JSON schema (missing $schema or type property)"));
+          }
+          // Attempt to validate against JSON Schema draft-07
+          try {
+            validate = ajv.compile({
+              $schema: "http://json-schema.org/draft-07/schema#"
+            });
+            validate(rawSchema);
+            if (validate.errors) {
+              console.warn("Warning: Schema validation issues in ".concat(filePath, ":"));
+              validate.errors.forEach(function (err) {
+                console.warn("  - ".concat(err.instancePath, " ").concat(err.message));
+              });
+            }
+          } catch (err) {
+            console.warn("Warning: Failed to validate schema ".concat(filePath, ": ").concat(err.message));
+          }
+          // Process the schema to normalize and add metadata
+          _context.next = 15;
+          return processSchema(rawSchema, filePath);
+        case 15:
+          return _context.abrupt("return", _context.sent);
+        case 18:
+          _context.prev = 18;
+          _context.t1 = _context["catch"](0);
+          throw new Error("Failed to parse schema: ".concat(_context.t1.message));
+        case 21:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[0, 18], [4, 8]]);
+  }));
+  return _parse.apply(this, arguments);
+}
+function processSchema(_x2, _x3) {
+  return _processSchema.apply(this, arguments);
+}
+/**
+ * Parse multiple schema files from a directory
+ * @param {string} directoryPath - Path to the directory containing JSON schema files
+ * @param {Object} options - Parsing options
+ * @returns {Array} Array of parsed schemas
+ */
+function _processSchema() {
+  _processSchema = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2(schema, filePath) {
+    var dereferencedSchema, stats;
+    return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _context2.prev = 0;
+          _context2.next = 3;
+          return $RefParser.dereference(schema, {
+            resolve: {
+              file: true,
+              http: false
+            }
+          });
+        case 3:
+          dereferencedSchema = _context2.sent;
+          _context2.next = 6;
+          return fs.stat(filePath);
+        case 6:
+          stats = _context2.sent;
+          // Add metadata
+          dereferencedSchema._metadata = {
+            fileName: path.basename(filePath),
+            filePath: filePath,
+            fileSize: stats.size,
+            lastModified: stats.mtime,
+            processed: new Date().toISOString()
+          };
+          // Extract additional useful metadata from the schema
+          if (dereferencedSchema.title) {
+            dereferencedSchema._metadata.title = dereferencedSchema.title;
+          }
+          if (dereferencedSchema.$id) {
+            dereferencedSchema._metadata.id = dereferencedSchema.$id;
+          }
+          // Extract all schema types (if it's an array of types)
+          if (dereferencedSchema.type) {
+            if (Array.isArray(dereferencedSchema.type)) {
+              dereferencedSchema._metadata.types = dereferencedSchema.type;
+            } else {
+              dereferencedSchema._metadata.types = [dereferencedSchema.type];
+            }
+          }
+          // Count properties
+          if (dereferencedSchema.properties) {
+            dereferencedSchema._metadata.propertyCount = Object.keys(dereferencedSchema.properties).length;
+            // Count required properties
+            if (Array.isArray(dereferencedSchema.required)) {
+              dereferencedSchema._metadata.requiredPropertyCount = dereferencedSchema.required.length;
+            }
+          }
+          return _context2.abrupt("return", dereferencedSchema);
+        case 15:
+          _context2.prev = 15;
+          _context2.t0 = _context2["catch"](0);
+          throw new Error("Failed to process schema: ".concat(_context2.t0.message));
+        case 18:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2, null, [[0, 15]]);
+  }));
+  return _processSchema.apply(this, arguments);
+}
+function parseDirectory(_x4) {
+  return _parseDirectory.apply(this, arguments);
+}
+function _parseDirectory() {
+  _parseDirectory = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee3(directoryPath) {
+    var options,
+      _options$pattern,
+      pattern,
+      _options$verbose,
+      verbose,
+      schemaFiles,
+      schemas,
+      _iterator,
+      _step,
+      file,
+      schema,
+      _args3 = arguments;
+    return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          options = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
+          _options$pattern = options.pattern, pattern = _options$pattern === void 0 ? '**/*.json' : _options$pattern, _options$verbose = options.verbose, verbose = _options$verbose === void 0 ? false : _options$verbose;
+          _context3.prev = 2;
+          // Find all JSON files in the directory
+          schemaFiles = glob.sync(path.join(directoryPath, pattern));
+          if (!(schemaFiles.length === 0)) {
+            _context3.next = 6;
+            break;
+          }
+          throw new Error("No JSON schema files found in ".concat(directoryPath));
+        case 6:
+          // Parse each schema file
+          schemas = [];
+          _iterator = _createForOfIteratorHelper(schemaFiles);
+          _context3.prev = 8;
+          _iterator.s();
+        case 10:
+          if ((_step = _iterator.n()).done) {
+            _context3.next = 25;
+            break;
+          }
+          file = _step.value;
+          if (verbose) {
+            console.log("Parsing schema: ".concat(file));
+          }
+          _context3.prev = 13;
+          _context3.next = 16;
+          return parse(file);
+        case 16:
+          schema = _context3.sent;
+          schemas.push({
+            fileName: path.basename(file),
+            filePath: file,
+            schema: schema
+          });
+          _context3.next = 23;
+          break;
+        case 20:
+          _context3.prev = 20;
+          _context3.t0 = _context3["catch"](13);
+          if (verbose) {
+            console.error("Error parsing schema ".concat(file, ": ").concat(_context3.t0.message));
+          }
+        case 23:
+          _context3.next = 10;
+          break;
+        case 25:
+          _context3.next = 30;
+          break;
+        case 27:
+          _context3.prev = 27;
+          _context3.t1 = _context3["catch"](8);
+          _iterator.e(_context3.t1);
+        case 30:
+          _context3.prev = 30;
+          _iterator.f();
+          return _context3.finish(30);
+        case 33:
+          return _context3.abrupt("return", schemas);
+        case 36:
+          _context3.prev = 36;
+          _context3.t2 = _context3["catch"](2);
+          throw new Error("Failed to parse directory: ".concat(_context3.t2.message));
+        case 39:
+        case "end":
+          return _context3.stop();
+      }
+    }, _callee3, null, [[2, 36], [8, 27, 30, 33], [13, 20]]);
+  }));
+  return _parseDirectory.apply(this, arguments);
+}
+module.exports = {
+  parse: parse,
+  parseDirectory: parseDirectory
+};

package/package.json ADDED Viewed

@@ -0,0 +1,90 @@
+{
+  "name": "slds-json-schema-renderer",
+  "version": "1.0.0",
+  "description": "A CLI tool to generate documentation from JSON schema files",
+  "main": "lib/index.js",
+  "bin": {
+    "json-schema-docs": "./bin/cli.js"
+  },
+  "files": [
+    "bin/",
+    "lib/",
+    "src/templates/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "node ./bin/cli.js",
+    "clean": "rimraf lib",
+    "build:cli": "babel src --out-dir lib --copy-files --ignore 'src/frontend/**'",
+    "dev": "vite",
+    "build:frontend": "vite build",
+    "build": "npm run clean && npm run build:cli && npm run build:frontend",
+    "prepublishOnly": "npm run build",
+    "pages": "npm run build && npm run start -- generate -i ./test/ -o docs",
+    "semantic-release": "semantic-release"
+  },
+  "keywords": [
+    "json-schema",
+    "documentation",
+    "cli",
+    "static-site-generator",
+    "vue",
+    "slds"
+  ],
+  "author": "PhyberApex",
+  "license": "MIT",
+  "dependencies": {
+    "@salesforce-ux/design-system": "^2.17.5",
+    "ajv": "^8.12.0",
+    "chalk": "^4.1.2",
+    "commander": "^9.4.0",
+    "fs-extra": "^10.1.0",
+    "glob": "^8.0.3",
+    "json-schema-ref-parser": "^9.0.9",
+    "shx": "^0.4.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.15.7",
+    "@babel/core": "^7.15.5",
+    "@babel/preset-env": "^7.15.6",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.6",
+    "@semantic-release/npm": "^11.0.2",
+    "@vitejs/plugin-vue": "^4.2.3",
+    "css-loader": "^6.3.0",
+    "jest": "^29.0.3",
+    "rimraf": "^3.0.2",
+    "semantic-release": "^23.0.2",
+    "style-loader": "^3.3.0",
+    "vite": "^4.3.9",
+    "vue": "^3.2.47"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json",
+            "package-lock.json",
+            "CHANGELOG.md"
+          ],
+          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
+    ]
+  }
+}

package/src/templates/index.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>JSON Schema Documentation</title>
+    <!-- Stylesheet -->
+    <link rel="stylesheet" href="assets/style.css">
+</head>
+<body>
+<!-- App will be rendered here -->
+<div id="app"></div>
+<!-- Vue 3 from CDN -->
+<script src="assets/vue.js"></script>
+<!-- App bundle -->
+<script src="assets/bundle.umd.js"></script>
+</body>
+</html>