feat: Finalize first version

Author: olivierodo

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  npm-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 18
+      - run: npm install
+      - run: npm run build
+      - name: Upload Release Asset
+        id: upload-release-asset
+        uses: sekwah41/upload-release-assets@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{  github.event.release.upload_url }}
+          asset_path: ./dist/hwt.tar.gz
+          asset_name: hwt.tar.gz
+          asset_content_type: application/tar+gzip

index.js

@@ -1,10 +1,46 @@
 import clipboard from 'clipboardy';
-import JWT from './src/index.js';
+import { program } from 'commander';
 import chalk from 'chalk';
+import Debug from 'debug';
+import JWT from './src/index.js';
+import { Render } from './src/table.js';
+
+global.debug = Debug('hwt')
 
-const input = clipboard.readSync()
 try {
-  const result = JWT(input, { format: 'aw' })
+  program
+    .option('--raw')
+    .option('-c, --claims <claims>')
+    .hook('preAction', (command, actionCommand) => {
+      const options = command.opts()
+      let format = 'human'
+      if (options.raw) {
+        format = 'raw'
+      }
+      if (options.claims) {
+        command.opts().claims = options.claims.split(',').map(_ => _.trim())
+      }
+      command.opts().format = format
+    })
+    .action(({ format, claims }) => {
+      debug('received token:')
+      const input = clipboard.readSync()
+      debug(input)
+      const result = JWT(input, { format, claims })
+      process.stdout.write(Render(result, { format }) + '\n')
+    })
+    .parse()
 } catch(e) {
-  process.stdout.write(`😩 Oups ${chalk.red(e.message)}\n`)
+  debug(e)
+  let { message } = e
+  if (e instanceof SyntaxError) {
+    const input = clipboard.readSync()
+    message =  `The clipboard ${chalk.red('does not contain a JWT')}, here what I got 👇` + '\n'
+    message += '---' + '\n'
+    message += input + '\n'
+    message += '---' + '\n'
+  } else {
+    message = '😩 something went wrong: ' + chalk.red(message) + '\n'
+  }
+  process.stdout.write(message)
 }

package-lock.json

@@ -1,21 +1,26 @@
 {
   "name": "simple-jwt",
-  "version": "1.0.0",
-  "description": "",
+  "version": "0.0.1",
+  "description": "A human friendly JWT inspector for your terminal. ",
   "type": "module",
   "main": "index.js",
   "scripts": {
-    "build": "esbuild index.js  --inject:./import-meta-url.js --define:import.meta.url=import_meta_url --sourcemap  --bundle --platform=node --outfile=dist/jwt.cjs && pkg --out-path dist --compress GZip dist/jwt.cjs ",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js tests/",
-    "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch  tests/",
-    "test:debug": "DEBUG=* node --experimental-vm-modules node_modules/jest/bin/jest.js --watch  tests/"
+    "prebuild": "esbuild index.js  --inject:./scripts/import-meta-url.build.js --define:import.meta.url=import_meta_url --sourcemap  --bundle --platform=node --outfile=dist/hwt.cjs",
+    "build": "pkg --out-path dist --compress GZip dist/hwt.cjs ",
+    "postbuild": "tar -cvzf dist/hwt.tar.gz dist/hwt-*",
+    "test": "TZ=UTC node --experimental-vm-modules node_modules/jest/bin/jest.js tests/",
+    "test:watch": "TZ=UTC node --experimental-vm-modules node_modules/jest/bin/jest.js --watch  tests/",
+    "test:debug": "DEBUG=* TZ=UTC node --experimental-vm-modules node_modules/jest/bin/jest.js --watch  tests/"
   },
   "keywords": [],
   "author": "Olivier Rodomond",
   "license": "ISC",
   "dependencies": {
     "chalk": "^5.2.0",
     "clipboardy": "^3.0.0",
+    "commander": "^9.4.1",
+    "console-table-printer": "^2.11.1",
+    "debug": "^4.3.4",
     "moment": "^2.29.4"
   },
   "devDependencies": {
@@ -24,5 +29,10 @@
     "jwt-simple": "^0.5.6",
     "pkg": "^5.8.0",
     "yaml": "^2.2.1"
+  },
+  "jest": {
+    "moduleNameMapper": {
+      "#(.*)": "<rootDir>/node_modules/$1"
+    }
   }
 }

package.json

@@ -0,0 +1,30 @@
+#!/bin/bash
+set -e
+
+echoerr() { echo -e "\n$@\n" 1>&2; }
+
+if [ -z ${HOME+x} ]; then
+  echoerr "\$HOME is unset, you need to have this variable to use this installer.";
+  exit 1
+fi
+
+if [ "$(uname)" == "Darwin" ]; then
+  OS=darwin
+elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
+  OS=linux
+else
+  echoerr "This installer is only supported on Linux and MacOS"
+  exit 1
+fi
+
+ARCH="$(uname -m)"
+if [ "$ARCH" == "x86_64" ]; then
+  ARCH=x64
+fi
+
+mkdir -p $HOME/.local/bin
+mkdir -p $HOME/.local/lib
+cd $HOME/.local/lib
+
+# @TODO
+

import-meta-url.js renamed to scripts/import-meta-url.build.js

@@ -0,0 +1,52 @@
+export default {
+  "jti": {
+    "title": "🎫 Token Id",
+    "comment": "The id of the token",
+    "order": 1
+  },
+  "typ": {
+    "title": "👮 Type",
+    "comment": "The authorization header type",
+    "order": 2
+  },
+  "exp": {
+    "title": "👈 Expirate at",
+    "comment": "The time when the token will be expired",
+    "order": 3
+  },
+  "iat": {
+    "title": "👉 Issued at",
+    "comment": "The time when the token has been issued",
+    "order": 4
+  },
+  "iss": {
+    "title": "🌐 Issued by",
+    "comment": "The authority that issued the token",
+    "order": 5
+  },
+  "sub": {
+    "title": "🤗 User Id",
+    "comment": "The unique Id of the user identity",
+    "order": 6
+  },
+  "azp": {
+    "title": "🚂 Client ID",
+    "comment": "The Unique ID of the Application requesting the current token",
+    "order": 7
+  },
+  "sid": {
+    "title": "🍬 Session Id",
+    "comment": "The Unique ID of the current session",
+    "order": 8
+  },
+  "session_state": {
+    "title": "🍬 Session State",
+    "comment": "The current state of the session",
+    "order": 9
+  },
+  "scope": {
+    "title": "🔑 Permissions",
+    "comment": "The List of permission carried by the jwt",
+    "order": 10
+  }
+}