Initial commit.

Author: BigBlueHat

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2

.eslintrc.cjs

@@ -0,0 +1,15 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    // this is required for dynamic import() and top-level await
+    ecmaVersion: 2022,
+    sourceType: 'module'
+  },
+  env: {
+    node: true
+  },
+  extends: [
+    'digitalbazaar'
+  ],
+  ignorePatterns: ['node_modules/']
+};

.gitignore

@@ -1,130 +1,3 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional stylelint cache
-.stylelintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variable files
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
 .cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
+node_modules/
+package-lock.json

README.md

@@ -1 +1,15 @@
-# w3c-api-browser
+# w3c-api-browser
+
+Browse the [W3C API](https://api.w3.org/doc) in your browser!
+
+## Usage
+
+```sh
+$ npm i
+$ npm run server
+$ # Listening on http://localhost:8080
+```
+
+## License
+
+[BSD-3-Clause](LICENSE) Copyright 2024 Digital Bazaar, Inc.

byEditor.js

@@ -0,0 +1,44 @@
+import EleventyFetch from '@11ty/eleventy-fetch';
+
+const apiBaseUrl = 'https://api.w3.org';
+
+// TODO: support more editors via configuration or commandline argument
+// Manu Sporny's W3C ID
+const editorId = 'hhvask30a7co0gs0gcsgosgkowws0k4';
+
+const specs = await EleventyFetch(
+  // eslint-disable-next-line max-len
+  `${apiBaseUrl}/users/${editorId}/specifications?embed=true`,
+  {
+    duration: '1d',
+    type: 'json'
+  });
+const {specifications} = specs._embedded;
+
+let csv = `"${['Title', 'First Date', 'Latest Date', 'Latest Status',
+  'Series Version', 'Short Link', 'Editors'].join('","')}"\n`;
+const rows = await Promise.all(specifications.map(async spec => {
+  // gather editor info
+  const rv = await EleventyFetch(
+    `${spec._links['latest-version'].href}/editors?embed=true`,
+    {
+      duration: '1d',
+      type: 'json'
+    });
+  const editors = rv?._embedded?.editors || [];
+  const row = [];
+  row.push(
+    spec.title,
+    spec._links['first-version'].href.split('/').at(-1)
+      .replace(/([0-9]{4})([0-9]{2})([0-9]{2})/, '$1-$2-$3'),
+    spec._links['latest-version'].href.split('/').at(-1)
+      .replace(/([0-9]{4})([0-9]{2})([0-9]{2})/, '$1-$2-$3'),
+    spec._links['latest-version'].title,
+    spec['series-version'],
+    spec.shortlink,
+    editors.map(editor => editor.name).join(', ')
+  );
+  return `"${row.join('","')}"`;
+}));
+csv += rows.join('\n');
+console.log(csv);

index.js

@@ -0,0 +1,60 @@
+import {Application} from '@curveball/core';
+import browser from '@curveball/browser';
+
+// MUST not end in a trailing slash and will be stripped in response bodies for
+// to facilitate local browsing.
+const apiBaseUrl = 'https://api.w3.org';
+const title = 'W3C API';
+
+// port for this browser app to listen on
+const port = 8080;
+
+const app = new Application();
+app.use(browser({title}));
+app.use(async ctx => {
+  console.dir(ctx.request.requestTarget);
+  if(ctx.request.requestTarget === '/') {
+    // adding a home page response with some navigation
+    ctx.response.body = {
+      _links: {
+        groups: {
+          href: '/groups',
+          title: 'List Groups'
+        },
+        specifications: {
+          href: '/specifications',
+          title: 'List Specifications'
+        },
+        'code-repository': {
+          href: 'https://github.com/digitalbazaar/w3c-api-browser'
+        },
+        alternate: [
+          {
+            href: 'https://api.w3.org/doc',
+            type: 'text/html',
+            title: 'W3C API Docs'
+          },
+          {
+            href: 'https://api.w3.org/doc.json',
+            type: 'application/json',
+            title: 'W3C API Swagger'
+          }
+        ]
+      }
+    };
+  } else {
+    const resp = await fetch(
+      `${apiBaseUrl}${ctx.request.requestTarget}?embed=true`, {
+        headers: {
+          Accept: 'application/json'
+        }
+      }
+    );
+    const rv = await resp.json();
+    const localhosted = JSON.stringify(rv).replaceAll(apiBaseUrl, '');
+    ctx.response.body = localhosted;
+    ctx.response.type = 'application/hal+json';
+  }
+});
+app.listen(port);
+console.log(`Listening on http://localhost:${port}`);

package.json

@@ -0,0 +1,27 @@
+{
+  "name": "w3c-api-browser",
+  "version": "0.0.0",
+  "description": "Browse the W3C API (HAL) output.",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "serve": "node index.js",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint \"**/*.{js,cjs}\""
+  },
+  "keywords": [
+    "w3c",
+    "api",
+    "hal"
+  ],
+  "author": "Digital Bazaar, Inc.",
+  "license": "BSD-3-Clause",
+  "dependencies": {
+    "@11ty/eleventy-fetch": "^4.0.1",
+    "@curveball/browser": "^1.1.1",
+    "@curveball/core": "^1.0.0",
+    "@curveball/validator": "^1.0.0",
+    "eslint": "^8.45.0",
+    "eslint-config-digitalbazaar": "^5.0.1"
+  }
+}