slds-json-schema-renderer 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+[![Deploy to GitHub Pages](https://github.com/PhyberApex/slds-json-schema-renderer/actions/workflows/deploy.yml/badge.svg)](https://github.com/PhyberApex/slds-json-schema-renderer/actions/workflows/deploy.yml)
+[![Release](https://github.com/PhyberApex/slds-json-schema-renderer/actions/workflows/release.yml/badge.svg)](https://github.com/PhyberApex/slds-json-schema-renderer/actions/workflows/release.yml)
+
+# SLDS JSON Schema Renderer
+
+A CLI tool that generates beautiful, interactive documentation from JSON schema files. The tool parses your JSON schemas and creates a static HTML site powered by Vue.js and the Salesforce Lightning Design System (SLDS). [Demo](https://phyberapex.github.io/slds-json-schema-renderer/)
+
+## Features
+
+- **Schema Parsing**: Automatically parses and validates JSON schema files
+- **SLDS Styling**: Professional look and feel using Salesforce Lightning Design System
+- **Vue.js Frontend**: Modern, component-based interface with Vue 3
+- **Static Output**: Generate completely static HTML that can be hosted anywhere
+- **CLI Tool**: Easy to use from the command line or as part of your build process
+- **Direct Icon Usage**: Uses SLDS icons directly as SVG file for better performance
+
+## Installation
+
+```bash
+# Install globally
+npm install -g slds-json-schema-renderer
+
+# Or install locally in your project
+npm install --save-dev slds-json-schema-renderer
+```
+
+## Usage
+
+### Basic Usage
+
+```bash
+# Generate documentation from JSON schemas
+json-schema-docs generate -i ./schemas -o ./docs
+```
+
+### Command Options
+
+```
+Usage: json-schema-docs generate [options]
+
+Generate documentation from JSON schema files
+
+Options:
+  -i, --input <directory>      Input directory containing JSON schema files (default: "./schemas")
+  -o, --output <directory>     Output directory for the generated documentation (default: "./docs")
+  -t, --title <title>          Documentation title (default: "JSON Schema Documentation")
+  -d, --description <description>  Documentation description (default: "")
+  -v, --verbose                Enable verbose output (default: false)
+  -h, --help                   Display help for command
+```
+
+### Examples
+
+Generate documentation with a custom title and description:
+
+```bash
+json-schema-docs generate -i ./schemas -o ./docs -t "API Documentation" -d "Documentation for our REST API endpoints"
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js (version 14 or higher)
+- npm or yarn
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/slds-json-schema-renderer.git
+cd slds-json-schema-renderer
+
+# Install dependencies
+npm install
+
+# Link for local development
+npm link
+```
+
+### Development Workflow
+
+```bash
+# Start the Vue development server (with hot reloading)
+npm run dev
+
+# Build the frontend only
+npm run build:frontend
+
+# Build the CLI code only
+npm run build:cli
+
+# Build everything
+npm run build
+```
+
+### Project Structure
+
+```
+slds-json-schema-renderer/
+├── bin/                      # CLI executable
+│   └── cli.js
+├── src/                      # All source code
+│   ├── frontend/            # Vue.js frontend application
+│   │   ├── components/      # Vue components
+│   │   ├── assets/          # Static assets
+│   │   └── index.js         # Frontend entry point
+│   └── templates/           # HTML templates
+└── lib/                      # Compiled code (generated)
+```
+
+## License
+
+MIT
+
+## Author
+
+PhyberApex

package/bin/cli.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const cli = require('../lib/cli');
+const pkg = require('../package.json');
+
+program
+    .version(pkg.version)
+    .description('JSON Schema Documentation Generator CLI');
+
+// Add the generate command
+program
+    .command('generate')
+    .description('Generate documentation from JSON schema files')
+    .option('-i, --input <directory>', 'Input directory containing JSON schema files', './schemas')
+    .option('-o, --output <directory>', 'Output directory for the generated documentation', './docs')
+    .option('-t, --title <title>', 'Documentation title', 'JSON Schema Documentation')
+    .option('-d, --description <description>', 'Documentation description', '')
+    .option('-v, --verbose', 'Enable verbose output', false)
+    .action(cli.generate);
+
+// Add the init command for future implementation
+program
+    .command('init')
+    .description('Initialize a new documentation project')
+    .action(() => {
+        console.log('Initialize command not yet implemented');
+    });
+
+program.parse(process.argv);
+
+// If no arguments, display help
+if (!process.argv.slice(2).length) {
+    program.outputHelp();
+}

package/lib/cli/generate.js

@@ -0,0 +1,110 @@
+"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 _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+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 _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+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 chalk = require('chalk');
+var schemaParser = require('../utils/schema-parser');
+var htmlGenerator = require('../utils/html-generator');
+
+/**
+ * Generate documentation from JSON schema files
+ * @param {Object} options - Command options
+ */
+function generate(_x) {
+  return _generate.apply(this, arguments);
+}
+function _generate() {
+  _generate = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(options) {
+    var input, output, title, description, verbose, schemas, typeStats, totalProperties, result;
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          input = options.input, output = options.output, title = options.title, description = options.description, verbose = options.verbose;
+          _context.prev = 1;
+          _context.next = 4;
+          return fs.ensureDir(output);
+        case 4:
+          console.log(chalk.blue("\uD83D\uDD0D Looking for JSON schema files in: ".concat(input)));
+
+          // Parse schema files from the input directory
+          _context.next = 7;
+          return schemaParser.parseDirectory(input, {
+            verbose: verbose
+          });
+        case 7:
+          schemas = _context.sent;
+          if (!(schemas.length === 0)) {
+            _context.next = 11;
+            break;
+          }
+          console.log(chalk.yellow("\u26A0\uFE0F No valid JSON schema files found in ".concat(input)));
+          return _context.abrupt("return");
+        case 11:
+          console.log(chalk.green("\u2705 Found and parsed ".concat(schemas.length, " JSON schema files")));
+
+          // Schema statistics
+          if (verbose) {
+            typeStats = {};
+            totalProperties = 0;
+            schemas.forEach(function (schema) {
+              var type = schema.schema.type || 'unknown';
+              typeStats[type] = (typeStats[type] || 0) + 1;
+              if (schema.schema.properties) {
+                totalProperties += Object.keys(schema.schema.properties).length;
+              }
+            });
+            console.log(chalk.blue("\uD83D\uDCCA Schema Statistics:"));
+            console.log("  - Total schemas: ".concat(schemas.length));
+            console.log("  - Total properties: ".concat(totalProperties));
+            console.log("  - Schema types: ".concat(Object.entries(typeStats).map(function (_ref) {
+              var _ref2 = _slicedToArray(_ref, 2),
+                type = _ref2[0],
+                count = _ref2[1];
+              return "".concat(type, " (").concat(count, ")");
+            }).join(', ')));
+          }
+          console.log(chalk.blue("\uD83D\uDD28 Generating HTML documentation..."));
+
+          // Generate the HTML documentation
+          _context.next = 16;
+          return htmlGenerator.generate({
+            schemas: schemas,
+            outputDir: output,
+            title: title,
+            description: description
+          });
+        case 16:
+          result = _context.sent;
+          console.log(chalk.green("\u2705 Documentation generated successfully"));
+          console.log("\uD83D\uDCD8 ".concat(result.schemasProcessed, " schemas documented"));
+          console.log("\uD83D\uDCC1 Output: ".concat(path.resolve(output)));
+          console.log("\uD83C\uDF10 Open ".concat(path.resolve(path.join(output, 'index.html')), " in your browser to view"));
+          _context.next = 28;
+          break;
+        case 23:
+          _context.prev = 23;
+          _context.t0 = _context["catch"](1);
+          console.error(chalk.red("\u274C Error generating documentation: ".concat(_context.t0.message)));
+          if (verbose) {
+            console.error(_context.t0);
+          }
+          process.exit(1);
+        case 28:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[1, 23]]);
+  }));
+  return _generate.apply(this, arguments);
+}
+module.exports = generate;

package/lib/cli/index.js

@@ -0,0 +1,6 @@
+"use strict";
+
+var generate = require('./generate');
+module.exports = {
+  generate: generate
+};