@europeum-ebsi/cli 0.0.0 → 1.0.0-rc.0

package/src/commands/issuers-registry.ts

@@ -0,0 +1,385 @@
+import type { CommandDescriptor } from "./registry.ts";
+
+import { getClient, unwrap } from "../api/fetch.ts";
+import { q } from "../api/params.ts";
+import { contractAddressOptionFor } from "../ledger/registries.ts";
+import { requiredArg } from "./shared/args.ts";
+
+const PAGINATION_OPTIONS = [
+  {
+    description: "Cursor for pagination (page[after])",
+    flags: "--page-after <cursor>",
+  },
+  {
+    description: "Maximum number of items per page (page[size])",
+    flags: "--page-size <n>",
+  },
+];
+
+const { option: CONTRACT_ADDRESS_OPTION, resolve: contractAddress } =
+  contractAddressOptionFor("issuers-registry");
+
+export const issuersRegistryCommands: CommandDescriptor[] = [
+  {
+    args: [],
+    group: "Issuers Registry",
+    async handler(_args, opts, config) {
+      const client = getClient(config);
+      const result = await client.GET("/issuers-registry/issuers", {
+        params: {
+          query: q({
+            contractAddress: contractAddress(opts),
+            "page[after]": opts["pageAfter"]
+              ? Number(opts["pageAfter"])
+              : undefined,
+            "page[size]": opts["pageSize"]
+              ? Number(opts["pageSize"])
+              : undefined,
+          }),
+        },
+      });
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.list",
+    options: [...PAGINATION_OPTIONS, CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "list"],
+    summary: "List trusted issuers registered on the EBSI ledger",
+  },
+
+  {
+    args: [
+      {
+        description: "Issuer DID",
+        example: "did:ebsi:ziDnioxYYLW1a3FDD",
+        name: "did",
+        required: true,
+      },
+    ],
+    group: "Issuers Registry",
+    async handler(args, opts, config) {
+      const client = getClient(config);
+      const result = await client.GET("/issuers-registry/issuers/{did}", {
+        params: {
+          path: { did: requiredArg(args, "did") },
+          query: q({ contractAddress: contractAddress(opts) }),
+        },
+      });
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.get",
+    options: [CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "get"],
+    summary: "Get an issuer by DID",
+  },
+
+  {
+    args: [
+      {
+        description: "Issuer DID",
+        example: "did:ebsi:ziDnioxYYLW1a3FDD",
+        name: "did",
+        required: true,
+      },
+    ],
+    group: "Issuers Registry",
+    async handler(args, opts, config) {
+      const client = getClient(config);
+      const result = await client.GET(
+        "/issuers-registry/issuers/{did}/attributes",
+        {
+          params: {
+            path: { did: requiredArg(args, "did") },
+            query: q({
+              contractAddress: contractAddress(opts),
+              "page[after]": opts["pageAfter"]
+                ? Number(opts["pageAfter"])
+                : undefined,
+              "page[size]": opts["pageSize"]
+                ? Number(opts["pageSize"])
+                : undefined,
+            }),
+          },
+        },
+      );
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.attributes.list",
+    options: [...PAGINATION_OPTIONS, CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "attributes", "list"],
+    summary: "List attributes for an issuer",
+  },
+
+  {
+    args: [
+      {
+        description: "Issuer DID",
+        example: "did:ebsi:ziDnioxYYLW1a3FDD",
+        name: "did",
+        required: true,
+      },
+    ],
+    group: "Issuers Registry",
+    async handler(args, opts, config) {
+      const client = getClient(config);
+      const result = await client.GET(
+        "/issuers-registry/issuers/{did}/proxies",
+        {
+          params: {
+            path: { did: requiredArg(args, "did") },
+            query: q({
+              contractAddress: contractAddress(opts),
+              "page[after]": opts["pageAfter"]
+                ? Number(opts["pageAfter"])
+                : undefined,
+              "page[size]": opts["pageSize"]
+                ? Number(opts["pageSize"])
+                : undefined,
+            }),
+          },
+        },
+      );
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.proxies.list",
+    options: [...PAGINATION_OPTIONS, CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "proxies", "list"],
+    summary: "List proxy data for an issuer",
+  },
+
+  {
+    args: [
+      {
+        description: "Issuer DID",
+        example: "did:ebsi:ziDnioxYYLW1a3FDD",
+        name: "did",
+        required: true,
+      },
+      {
+        description: "Attribute ID",
+        example:
+          "447867bafab4c4ad26d4f4650e2390f92a831b6343b7c36ecb7c51fee336fa14",
+        name: "attributeId",
+        required: true,
+      },
+    ],
+    group: "Issuers Registry",
+    async handler(args, opts, config) {
+      const client = getClient(config);
+      const result = await client.GET(
+        "/issuers-registry/issuers/{did}/attributes/{attributeId}",
+        {
+          params: {
+            path: {
+              attributeId: requiredArg(args, "attributeId"),
+              did: requiredArg(args, "did"),
+            },
+            query: q({ contractAddress: contractAddress(opts) }),
+          },
+        },
+      );
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.attributes.get",
+    options: [CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "attributes", "get"],
+    summary: "Get an attribute for an issuer",
+  },
+
+  {
+    args: [
+      {
+        description: "Issuer DID",
+        example: "did:ebsi:ziDnioxYYLW1a3FDD",
+        name: "did",
+        required: true,
+      },
+      {
+        description: "Attribute ID",
+        example:
+          "447867bafab4c4ad26d4f4650e2390f92a831b6343b7c36ecb7c51fee336fa14",
+        name: "attributeId",
+        required: true,
+      },
+    ],
+    group: "Issuers Registry",
+    async handler(args, opts, config) {
+      const client = getClient(config);
+      const result = await client.GET(
+        "/issuers-registry/issuers/{did}/attributes/{attributeId}/revisions",
+        {
+          params: {
+            path: {
+              attributeId: requiredArg(args, "attributeId"),
+              did: requiredArg(args, "did"),
+            },
+            query: q({
+              contractAddress: contractAddress(opts),
+              "page[after]": opts["pageAfter"]
+                ? Number(opts["pageAfter"])
+                : undefined,
+              "page[size]": opts["pageSize"]
+                ? Number(opts["pageSize"])
+                : undefined,
+            }),
+          },
+        },
+      );
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.attributes.revisions",
+    options: [...PAGINATION_OPTIONS, CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "attributes", "revisions"],
+    summary: "List revisions of an issuer attribute",
+  },
+
+  {
+    args: [
+      {
+        description: "Issuer DID",
+        example: "did:ebsi:ziDnioxYYLW1a3FDD",
+        name: "did",
+        required: true,
+      },
+      {
+        description: "Attribute ID",
+        example:
+          "447867bafab4c4ad26d4f4650e2390f92a831b6343b7c36ecb7c51fee336fa14",
+        name: "attributeId",
+        required: true,
+      },
+      {
+        description: "Revision ID",
+        example:
+          "447867bafab4c4ad26d4f4650e2390f92a831b6343b7c36ecb7c51fee336fa14",
+        name: "revisionId",
+        required: true,
+      },
+    ],
+    group: "Issuers Registry",
+    async handler(args, opts, config) {
+      const client = getClient(config);
+      const result = await client.GET(
+        "/issuers-registry/issuers/{did}/attributes/{attributeId}/revisions/{revisionId}",
+        {
+          params: {
+            path: {
+              attributeId: requiredArg(args, "attributeId"),
+              did: requiredArg(args, "did"),
+              revisionId: requiredArg(args, "revisionId"),
+            },
+            query: q({ contractAddress: contractAddress(opts) }),
+          },
+        },
+      );
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.attributes.revision",
+    options: [CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "attributes", "revision"],
+    summary: "Get a specific revision of an issuer attribute",
+  },
+
+  {
+    args: [
+      {
+        description: "Issuer DID",
+        example: "did:ebsi:ziDnioxYYLW1a3FDD",
+        name: "did",
+        required: true,
+      },
+      {
+        description: "Proxy ID",
+        example:
+          "0x408db59ec66f14efe30eed366ad57a7f6863fbbb18edd3d3bf15837dc3a494a6",
+        name: "proxyId",
+        required: true,
+      },
+    ],
+    group: "Issuers Registry",
+    async handler(args, opts, config) {
+      const client = getClient(config);
+      const result = await client.GET(
+        "/issuers-registry/issuers/{did}/proxies/{proxyId}",
+        {
+          params: {
+            path: {
+              did: requiredArg(args, "did"),
+              proxyId: requiredArg(args, "proxyId"),
+            },
+            query: q({ contractAddress: contractAddress(opts) }),
+          },
+        },
+      );
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.proxies.get",
+    options: [CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "proxies", "get"],
+    summary: "Get a proxy for an issuer",
+  },
+
+  {
+    args: [
+      {
+        description: "Issuer DID",
+        example: "did:ebsi:ziDnioxYYLW1a3FDD",
+        name: "did",
+        required: true,
+      },
+      {
+        description: "Proxy ID",
+        example:
+          "0x408db59ec66f14efe30eed366ad57a7f6863fbbb18edd3d3bf15837dc3a494a6",
+        name: "proxyId",
+        required: true,
+      },
+      {
+        description:
+          "Path to a StatusList2021Credential or BitstringStatusListCredential",
+        example: "credentials/status/1",
+        name: "path",
+        required: true,
+      },
+    ],
+    group: "Issuers Registry",
+    async handler(args, opts, config) {
+      const client = getClient(config);
+      // The proxy forwards to arbitrary issuer-hosted content: the response is
+      // a bare JWT string over `text/plain`, not JSON -- `parseAs: "text"`
+      // avoids openapi-fetch's default `response.json()` throwing on it.
+      const result = await client.GET(
+        "/issuers-registry/issuers/{did}/proxies/{proxyId}/{path}",
+        {
+          params: {
+            path: {
+              did: requiredArg(args, "did"),
+              path: requiredArg(args, "path"),
+              proxyId: requiredArg(args, "proxyId"),
+            },
+            query: q({ contractAddress: contractAddress(opts) }),
+          },
+          parseAs: "text",
+        },
+      );
+      return unwrap(result);
+    },
+    id: "issuers-registry.issuers.proxies.content",
+    options: [CONTRACT_ADDRESS_OPTION],
+    segments: ["issuers-registry", "issuers", "proxies", "content"],
+    summary: "Get a status list credential through an issuer's proxy",
+  },
+
+  {
+    args: [],
+    group: "Issuers Registry",
+    async handler(_args, _opts, config) {
+      const client = getClient(config);
+      const result = await client.GET("/issuers-registry/abi");
+      return unwrap(result);
+    },
+    id: "issuers-registry.abi",
+    options: [],
+    segments: ["issuers-registry", "abi"],
+    summary: "Get the ABI of the Issuers Registry smart contract",
+  },
+];