@vnphu/nestjs-api-explorer 0.2.0 → 0.2.2

package/dist/api-explorer.html.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-explorer.html.d.ts","sourceRoot":"","sources":["../src/api-explorer.html.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAEnE,wBAAgB,eAAe,CAAC,OAAO,EAAE,0BAA0B,GAAG,MAAM,CAmhD3E"}
+{"version":3,"file":"api-explorer.html.d.ts","sourceRoot":"","sources":["../src/api-explorer.html.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAEnE,wBAAgB,eAAe,CAAC,OAAO,EAAE,0BAA0B,GAAG,MAAM,CAqnD3E"}

package/dist/api-explorer.html.js

@@ -254,7 +254,7 @@ function getExplorerHtml(options) {
 
     /* ── Summary Panel ── */
     #summary-panel {
-      width: 240px; flex-shrink: 0; border-left: 1px solid var(--border);
+      width: 400px; flex-shrink: 0; border-left: 1px solid var(--border);
       background: var(--bg-white); display: flex; flex-direction: column; overflow: hidden;
     }
     #summary-panel.hidden { display: none; }
@@ -263,6 +263,13 @@ function getExplorerHtml(options) {
       display: flex; align-items: center; justify-content: space-between;
     }
     .summary-header-title { font-size: 11px; font-weight: 700; color: var(--text); text-transform: uppercase; letter-spacing: 0.5px; }
+    .summary-copy-btn {
+      display: flex; align-items: center; gap: 4px; font-size: 11px; font-weight: 500;
+      color: var(--text-muted); background: none; border: 1px solid var(--border);
+      border-radius: var(--radius-sm); padding: 3px 8px; cursor: pointer; transition: all 0.15s;
+    }
+    .summary-copy-btn:hover { background: var(--bg-input); color: var(--accent); border-color: var(--accent); }
+    .summary-copy-btn.copied { color: #16a34a; border-color: #86efac; background: #f0fdf4; }
     #summary-body { flex: 1; overflow-y: auto; padding: 10px 14px 16px; display: flex; flex-direction: column; gap: 14px; }
     .summary-section { display: flex; flex-direction: column; gap: 6px; }
     .summary-section-label {
@@ -607,6 +614,9 @@ function getExplorerHtml(options) {
         <path d="M7 11V7a5 5 0 0 1 10 0v4"/>
       </svg>
     </button>
+    <a href="https://github.com/vnphu/nestjs-api-explorer" target="_blank" rel="noopener" class="icon-btn" title="View on GitHub" style="display:inline-flex;align-items:center;justify-content:center;text-decoration:none">
+      <svg width="15" height="15" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0 0 24 12c0-6.63-5.37-12-12-12z"/></svg>
+    </a>
     <button class="icon-btn" id="reload-btn" title="Reload routes">
       <svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round">
         <polyline points="23 4 23 10 17 10"/>
@@ -829,6 +839,10 @@ function getExplorerHtml(options) {
     <div id="summary-panel" class="hidden">
       <div class="summary-header">
         <span class="summary-header-title">Request Summary</span>
+        <button id="summary-copy-btn" class="summary-copy-btn hidden" title="Copy summary">
+          <svg width="13" height="13" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="9" y="9" width="13" height="13" rx="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg>
+          <span id="summary-copy-label">Copy</span>
+        </button>
       </div>
       <div id="summary-body">
         <div class="summary-empty" id="summary-empty">
@@ -928,11 +942,9 @@ function groupRoutes(routes) {
 
 function renderRouteItem(r) {
   const active = S.selected?.method === r.method && S.selected?.path === r.path ? ' active' : '';
-  const desc = r.description ? \`<span class="route-desc">\${esc(r.description.split('\\n')[0])}</span>\` : '';
   return \`<div class="route-item\${active}" data-method="\${r.method}" data-path="\${esc(r.path)}">
     <span class="method-badge method-\${r.method}">\${r.method}</span>
     <span class="route-path" title="\${esc(r.path)}">\${esc(r.path)}</span>
-    \${desc}
   </div>\`;
 }
 
@@ -1011,8 +1023,28 @@ function selectRoute(route) {
   document.querySelectorAll('#req-panel-inner .tab-panel').forEach(p => p.classList.remove('active'));
   document.getElementById('tab-params').classList.add('active');
 
-  // Auto-switch to Body tab for methods that send a body
+  // Auto-fill body editor from body schema if available
   const bodyMethods = ['POST', 'PUT', 'PATCH'];
+  if (bodyMethods.includes(route.method) && route.body?.length) {
+    const template = {};
+    route.body.forEach(f => {
+      if (f.type === 'number')       template[f.name] = 0;
+      else if (f.type === 'boolean') template[f.name] = false;
+      else if (f.type === 'array')   template[f.name] = [];
+      else if (f.type === 'object')  template[f.name] = {};
+      else                           template[f.name] = '';
+    });
+    S.body.content = JSON.stringify(template, null, 2);
+    S.body.type = 'json';
+    el.bodyEditor.value = S.body.content;
+    // Sync body type radio
+    document.querySelectorAll('[name="body-type"]').forEach(r => {
+      r.checked = r.value === 'json';
+    });
+    el.formatBtn.style.display = '';
+  }
+
+  // Auto-switch to Body tab for methods that send a body
   if (bodyMethods.includes(route.method) && !route.params.length) {
     el.reqTabBar.querySelectorAll('.tab-btn').forEach(b => b.classList.remove('active'));
     el.reqTabBar.querySelector('[data-tab="body"]').classList.add('active');
@@ -1198,16 +1230,21 @@ function renderSummary() {
   const empty = $('summary-empty');
   const content = $('summary-content');
 
+  const copyBtn = $('summary-copy-btn');
+
   if (!S.selected) {
     panel.classList.remove('hidden');
     empty.style.display = 'flex';
-    content.style.display = 'none';
+    content.classList.add('hidden');
+    copyBtn.classList.add('hidden');
     return;
   }
 
   panel.classList.remove('hidden');
   empty.style.display = 'none';
+  content.classList.remove('hidden');
   content.style.display = 'flex';
+  copyBtn.classList.remove('hidden');
 
   const method = S.selected.method;
   const fullUrl = buildUrl();
@@ -1320,6 +1357,65 @@ function renderSummary() {
   \`;
 }
 
+// ── Copy Summary ───────────────────────────────────────────────────
+function copySummary() {
+  if (!S.selected) return;
+  const r = S.selected;
+  const lines = [];
+
+  lines.push(\`\${r.method} \${buildUrl()}\`);
+  if (r.description) lines.push(\`\`, ...r.description.split('\\n').map(l => \`# \${l}\`));
+
+  if (r.params?.length) {
+    lines.push(\`\`, \`[Path Params]\`);
+    r.params.forEach(p => lines.push(\`  \${p}: \${S.pathParams[p] || ''}\`));
+  }
+
+  const activeQuery = S.queryParams.filter(p => p.enabled && p.key);
+  if (activeQuery.length) {
+    lines.push(\`\`, \`[Query Params]\`);
+    activeQuery.forEach(p => lines.push(\`  \${p.key}: \${p.value}\`));
+  }
+
+  if (r.query?.length) {
+    lines.push(\`\`, \`[Query Schema]\`);
+    r.query.forEach(f => lines.push(\`  \${f.name}: \${f.type}\${f.required ? ' (required)' : ''}\${f.rules?.length ? ' | ' + f.rules.join(', ') : ''}\${f.description ? ' — ' + f.description : ''}\`));
+  }
+
+  const activeHeaders = S.reqHeaders.filter(h => h.enabled && h.key);
+  if (activeHeaders.length) {
+    lines.push(\`\`, \`[Headers]\`);
+    activeHeaders.forEach(h => lines.push(\`  \${h.key}: \${h.value}\`));
+  }
+
+  if (r.headers?.length) {
+    lines.push(\`\`, \`[Required Headers]\`);
+    r.headers.forEach(f => lines.push(\`  \${f.name}\${f.required ? ' (required)' : ''}\${f.description ? ' — ' + f.description : ''}\`));
+  }
+
+  if (r.body?.length) {
+    lines.push(\`\`, \`[Body Schema]\`);
+    r.body.forEach(f => lines.push(\`  \${f.name}: \${f.type}\${f.required ? ' (required)' : ' (optional)'}\${f.rules?.length ? ' | ' + f.rules.join(', ') : ''}\${f.description ? ' — ' + f.description : ''}\`));
+  }
+
+  if (['POST','PUT','PATCH'].includes(r.method) && S.body.type !== 'none' && S.body.content) {
+    lines.push(\`\`, \`[Body Content (\${S.body.type})]\`, S.body.content);
+  }
+
+  if (r.response?.length) {
+    lines.push(\`\`, \`[Response Schema]\`);
+    r.response.forEach(f => lines.push(\`  \${f.name}: \${f.type}\${f.description ? ' — ' + f.description : ''}\`));
+  }
+
+  navigator.clipboard.writeText(lines.join('\\n')).then(() => {
+    const btn = $('summary-copy-btn');
+    const label = $('summary-copy-label');
+    btn.classList.add('copied');
+    label.textContent = 'Copied!';
+    setTimeout(() => { btn.classList.remove('copied'); label.textContent = 'Copy'; }, 1800);
+  });
+}
+
 // Render a list of DocField items (body/query/headers/response) in the summary panel
 function renderDocFields(label, fields) {
   if (!fields || fields.length === 0) return '';
@@ -1487,6 +1583,8 @@ function bindEvents() {
   el.baseUrl.addEventListener('input', () => { renderUrlBar(); renderSummary(); });
   el.sendBtn.addEventListener('click', sendRequest);
 
+  $('summary-copy-btn').addEventListener('click', copySummary);
+
   el.addQueryBtn.addEventListener('click', () => {
     S.queryParams.push({ id: uid(), key: '', value: '', enabled: true });
     renderQueryParams();

package/dist/api-explorer.html.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-explorer.html.js","sourceRoot":"","sources":["../src/api-explorer.html.ts"],"names":[],"mappings":";;AAEA,0CAmhDC;AAnhDD,SAAgB,eAAe,CAAC,OAAmC;IACjE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAChC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAE/C,OAAO,UAAU,CAAC;;;;;WAKT,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAm0BC,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAssBf,CAAC;AACT,CAAC"}
+{"version":3,"file":"api-explorer.html.js","sourceRoot":"","sources":["../src/api-explorer.html.ts"],"names":[],"mappings":";;AAEA,0CAqnDC;AArnDD,SAAgB,eAAe,CAAC,OAAmC;IACjE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAChC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAE/C,OAAO,UAAU,CAAC;;;;;WAKT,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAi1BC,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA0xBf,CAAC;AACT,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnphu/nestjs-api-explorer",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "An in-app API explorer for NestJS — like Postman, but built right into your app.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,6 +25,14 @@
   ],
   "author": "vnphu",
   "license": "MIT",
+  "homepage": "https://github.com/vnphu/nestjs-api-explorer#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vnphu/nestjs-api-explorer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vnphu/nestjs-api-explorer/issues"
+  },
   "peerDependencies": {
     "@nestjs/common": ">=9.0.0",
     "@nestjs/core": ">=9.0.0",