@vidos-id/openid4vc-issuer-cli 0.0.0-rc.1

package/README.md

@@ -0,0 +1,207 @@
+# @vidos-id/openid4vc-issuer-cli
+
+Terminal client for [`@vidos-id/openid4vc-issuer-web-server`](../issuer-web-server/).
+
+This CLI no longer issues credentials locally or manages issuer key material. It signs into a running issuer web server, manages templates and issuance offers, and exposes the same app-level workflows as the web client in a terminal-friendly form.
+
+For wallet-side credential receipt and storage, use [`@vidos-id/openid4vc-wallet-cli`](../wallet-cli/).
+
+## Install
+
+Download the latest GitHub Release artifact and make it executable:
+
+```bash
+curl -L -o openid4vc-issuer https://github.com/vidos-id/openid4vc-tools/releases/latest/download/openid4vc-issuer.js
+chmod +x openid4vc-issuer
+./openid4vc-issuer --help
+```
+
+For development in this repo, run the bin entry directly with Bun:
+
+```bash
+bun packages/issuer-cli/src/index.ts --help
+```
+
+## What It Does
+
+- sign in to a local or remote issuer web server
+- support guest sessions and username/password accounts
+- inspect the issuer metadata published at `/.well-known/openid-credential-issuer`
+- list, create, and delete templates
+- list issuances, create new issuance offers, inspect offer URIs, and update status
+- provide an interactive terminal flow with prompts and menus
+
+Running `openid4vc-issuer` with no subcommand starts the interactive mode by default.
+
+## Server
+
+Run the API separately:
+
+```bash
+bun run --filter '@vidos-id/openid4vc-issuer-web-server' dev
+```
+
+Default local server URL:
+
+- `http://localhost:3001`
+
+Most commands use the saved session server automatically. You can override it with `--server-url`.
+
+## Session Storage
+
+By default the CLI stores the authenticated session at:
+
+- `~/.config/vidos-id/openid4vc-issuer-session.json`
+
+Override it with `--session-file <file>`.
+
+## Commands
+
+### `auth signin`
+
+Sign in with either a guest session or username/password.
+
+```bash
+openid4vc-issuer auth signin --anonymous
+openid4vc-issuer auth signin --server-url http://localhost:3001 --username ada --password secret
+```
+
+### `auth signup`
+
+Create an account and save the resulting session.
+
+```bash
+openid4vc-issuer auth signup --username ada --password secret
+```
+
+### `auth whoami`
+
+Show the saved session.
+
+```bash
+openid4vc-issuer auth whoami
+```
+
+### `auth signout`
+
+Sign out and clear the saved session file.
+
+```bash
+openid4vc-issuer auth signout
+```
+
+### `metadata`
+
+Show the issuer metadata document exposed by the server.
+
+```bash
+openid4vc-issuer metadata
+openid4vc-issuer metadata --server-url http://localhost:3001 --output json
+```
+
+### `templates list`
+
+List the predefined and custom templates visible to the current user.
+
+```bash
+openid4vc-issuer templates list
+```
+
+### `templates create`
+
+Create a custom template.
+
+```bash
+openid4vc-issuer templates create \
+  --name "Conference Pass" \
+  --vct https://issuer.example/credentials/conference-pass \
+  --claims '{"given_name":"Ada","pass_level":"speaker"}'
+
+openid4vc-issuer templates create \
+  --name "PID" \
+  --vct urn:eudi:pid:1 \
+  --claims-file examples/pid/pid-minimal.claims.json
+```
+
+### `templates delete`
+
+Delete a custom template by id.
+
+```bash
+openid4vc-issuer templates delete --template-id <template-id>
+```
+
+### `issuances list`
+
+List issuances for the current user.
+
+```bash
+openid4vc-issuer issuances list
+```
+
+### `issuances create`
+
+Create an issuance offer from a template. The output includes the `openid-credential-offer://` URI for wallet handoff.
+
+```bash
+openid4vc-issuer issuances create \
+  --template-id <template-id> \
+  --claims '{"seat":"A-12"}' \
+  --status active
+```
+
+### `issuances show`
+
+Show one issuance, including its current state, claims, and offer URI.
+
+```bash
+openid4vc-issuer issuances show --issuance-id <issuance-id>
+```
+
+### `issuances status`
+
+Update credential status for an issuance.
+
+```bash
+openid4vc-issuer issuances status --issuance-id <issuance-id> --status suspended
+openid4vc-issuer issuances status --issuance-id <issuance-id> --status revoked
+```
+
+## Interactive Mode
+
+Start the interactive terminal flow by running the CLI without a subcommand:
+
+```bash
+openid4vc-issuer
+openid4vc-issuer --server-url http://localhost:3001
+```
+
+The interactive mode can:
+
+- choose the target server URL
+- sign in as guest or with credentials
+- inspect issuer metadata
+- create and delete templates
+- create issuances from a selected template
+- inspect and update existing issuances
+
+## Global options
+
+- running `openid4vc-issuer` with no subcommand starts interactive mode
+- `--server-url <url>` - override the issuer web server URL
+- `--session-file <file>` - override the saved session file location
+- `--verbose` - enable verbose logging to stderr
+- `--version` - show version number
+- `--help` - show help for a command
+
+## Notes
+
+- `openid4vc-issuer` is an app client of `openid4vc-issuer-web-server`; it does not issue locally
+- `openid4vc-issuer` does not receive or store credentials; wallet redemption belongs to [`openid4vc-wallet receive`](../wallet-cli/)
+- command output is concise text meant for terminal usage rather than raw JSON dumps
+
+## Test
+
+```bash
+bun test packages/issuer-cli/src/index.test.ts
+```

package/dist/index.d.mts

@@ -0,0 +1,198 @@
+import { Command } from "commander";
+
+//#region src/program.d.ts
+declare function createProgram(version: string): Command;
+//#endregion
+//#region src/actions/auth.d.ts
+type ActionDeps$4 = {
+  fetchImpl?: typeof fetch;
+};
+declare function authSignInAction(rawOptions: unknown, deps?: ActionDeps$4): Promise<{
+  serverUrl: string;
+  user: {
+    id: string;
+    username: string | null;
+    name: string;
+    isAnonymous: boolean;
+    createdAt: string;
+  };
+}>;
+declare function authSignUpAction(rawOptions: unknown, deps?: ActionDeps$4): Promise<{
+  serverUrl: string;
+  user: {
+    id: string;
+    username: string | null;
+    name: string;
+    isAnonymous: boolean;
+    createdAt: string;
+  };
+}>;
+declare function authWhoAmIAction(rawOptions: unknown, deps?: ActionDeps$4): Promise<{
+  serverUrl: string;
+  user: {
+    id: string;
+    username: string | null;
+    name: string;
+    isAnonymous: boolean;
+    createdAt: string;
+  };
+}>;
+declare function authSignOutAction(rawOptions: unknown, deps?: ActionDeps$4): Promise<{
+  serverUrl: string;
+}>;
+//#endregion
+//#region src/actions/interactive.d.ts
+type ActionDeps$3 = {
+  fetchImpl?: typeof fetch;
+};
+declare function interactiveAction(rawOptions: unknown, deps?: ActionDeps$3): Promise<void>;
+//#endregion
+//#region src/actions/issuances.d.ts
+type ActionDeps$2 = {
+  fetchImpl?: typeof fetch;
+};
+declare function listIssuancesAction(rawOptions: unknown, deps?: ActionDeps$2): Promise<{
+  serverUrl: string;
+  issuances: {
+    id: string;
+    ownerUserId: string;
+    templateId: string;
+    credentialConfigurationId: string;
+    vct: string;
+    claims: Record<string, unknown>;
+    state: "offered" | "redeeming" | "redeemed" | "expired" | "redemption_failed";
+    status: 0 | 1 | 2;
+    offerUri: string;
+    statusListId: string;
+    statusListIndex: number;
+    credential: string | null;
+    createdAt: string;
+    updatedAt: string;
+  }[];
+}>;
+declare function createIssuanceAction(rawOptions: unknown, deps?: ActionDeps$2): Promise<{
+  serverUrl: string;
+  detail: {
+    issuance: {
+      id: string;
+      ownerUserId: string;
+      templateId: string;
+      credentialConfigurationId: string;
+      vct: string;
+      claims: Record<string, unknown>;
+      state: "offered" | "redeeming" | "redeemed" | "expired" | "redemption_failed";
+      status: 0 | 1 | 2;
+      offerUri: string;
+      statusListId: string;
+      statusListIndex: number;
+      credential: string | null;
+      createdAt: string;
+      updatedAt: string;
+    };
+    qrPayload: string;
+  };
+}>;
+declare function showIssuanceAction(rawOptions: unknown, deps?: ActionDeps$2): Promise<{
+  serverUrl: string;
+  detail: {
+    issuance: {
+      id: string;
+      ownerUserId: string;
+      templateId: string;
+      credentialConfigurationId: string;
+      vct: string;
+      claims: Record<string, unknown>;
+      state: "offered" | "redeeming" | "redeemed" | "expired" | "redemption_failed";
+      status: 0 | 1 | 2;
+      offerUri: string;
+      statusListId: string;
+      statusListIndex: number;
+      credential: string | null;
+      createdAt: string;
+      updatedAt: string;
+    };
+    qrPayload: string;
+  };
+}>;
+declare function updateIssuanceStatusAction(rawOptions: unknown, deps?: ActionDeps$2): Promise<{
+  serverUrl: string;
+  detail: {
+    issuance: {
+      id: string;
+      ownerUserId: string;
+      templateId: string;
+      credentialConfigurationId: string;
+      vct: string;
+      claims: Record<string, unknown>;
+      state: "offered" | "redeeming" | "redeemed" | "expired" | "redemption_failed";
+      status: 0 | 1 | 2;
+      offerUri: string;
+      statusListId: string;
+      statusListIndex: number;
+      credential: string | null;
+      createdAt: string;
+      updatedAt: string;
+    };
+    qrPayload: string;
+  };
+}>;
+//#endregion
+//#region src/actions/metadata.d.ts
+type ActionDeps$1 = {
+  fetchImpl?: typeof fetch;
+};
+declare function metadataAction(rawOptions: unknown, deps?: ActionDeps$1): Promise<{
+  serverUrl: string;
+  metadata: {
+    credential_issuer: string;
+    token_endpoint: string;
+    credential_endpoint: string;
+    jwks: {
+      keys: Record<string, unknown>[];
+    };
+    credential_configurations_supported: Record<string, Record<string, unknown>>;
+    nonce_endpoint?: string | undefined;
+  };
+}>;
+//#endregion
+//#region src/actions/templates.d.ts
+type ActionDeps = {
+  fetchImpl?: typeof fetch;
+};
+declare function listTemplatesAction(rawOptions: unknown, deps?: ActionDeps): Promise<{
+  serverUrl: string;
+  templates: {
+    id: string;
+    ownerUserId: string;
+    name: string;
+    kind: "predefined" | "custom";
+    credentialConfigurationId: string;
+    vct: string;
+    defaultClaims: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+  }[];
+}>;
+declare function createTemplateAction(rawOptions: unknown, deps?: ActionDeps): Promise<{
+  serverUrl: string;
+  template: {
+    id: string;
+    ownerUserId: string;
+    name: string;
+    kind: "predefined" | "custom";
+    credentialConfigurationId: string;
+    vct: string;
+    defaultClaims: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+  };
+}>;
+declare function deleteTemplateAction(rawOptions: unknown, deps?: ActionDeps): Promise<{
+  serverUrl: string;
+  templateId: string;
+}>;
+//#endregion
+//#region src/index.d.ts
+declare function runCli(argv?: string[]): Promise<void>;
+//#endregion
+export { authSignInAction, authSignOutAction, authSignUpAction, authWhoAmIAction, createIssuanceAction, createProgram, createTemplateAction, deleteTemplateAction, interactiveAction, listIssuancesAction, listTemplatesAction, metadataAction, runCli, showIssuanceAction, updateIssuanceStatusAction };