@interop/did-cli 0.7.1 → 0.9.0

package/dist/commands/was/publish.js

@@ -0,0 +1,151 @@
+/**
+ * `was publish`/`unpublish` (the world-readable `PublicCanRead` toggle) and
+ * `was grant` (delegate a signed capability to another DID) run functions.
+ */
+import { resolveDidRef } from '../../meta.js';
+import { saveToCollection } from '../../storage.js';
+import { encodeCapability } from '../../zcap/encoding.js';
+import { expiresFromTtl } from '../../zcap/ttl.js';
+import { resolveWasTarget } from '../../was/client.js';
+import { storageIdFor, writeCreateMeta } from '../zcap.js';
+import { handleForTarget, reportError, wasUrl } from './shared.js';
+/** The capability actions WAS servers match against (HTTP verbs). */
+const WAS_ACTIONS = ['GET', 'PUT', 'POST', 'DELETE'];
+/**
+ * Normalizes grant action verbs to their canonical uppercase form,
+ * rejecting anything that is not a WAS-supported HTTP verb.
+ *
+ * @param actions {string[]}
+ * @returns {WasAction[]}
+ */
+function normalizeActions(actions) {
+    return actions.map(action => {
+        const verb = action.toUpperCase();
+        if (!WAS_ACTIONS.includes(verb)) {
+            throw new Error(`Unknown action "${action}" (supported: GET, PUT, POST, DELETE).`);
+        }
+        return verb;
+    });
+}
+/**
+ * Makes a space, collection, or resource world-readable (the
+ * `PublicCanRead` policy) and prints its public URL -- the "share via
+ * public link" case.
+ *
+ * @param options {object}
+ * @param options.address {string}   A space/collection/resource address.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export async function runPublish(options) {
+    try {
+        const target = await resolveWasTarget({
+            address: options.address,
+            server: options.server,
+            did: options.did
+        });
+        const { handle, url } = handleForTarget(target);
+        await handle.setPublic();
+        console.error(`Published (world-readable): ${url}`);
+        console.log(url);
+        return 0;
+    }
+    catch (err) {
+        return reportError({ action: 'publish the path', err });
+    }
+}
+/**
+ * Reverts a published space, collection, or resource to capability-only
+ * access (clears its policy). Idempotent.
+ *
+ * @param options {object}
+ * @param options.address {string}   A space/collection/resource address.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export async function runUnpublish(options) {
+    try {
+        const target = await resolveWasTarget({
+            address: options.address,
+            server: options.server,
+            did: options.did
+        });
+        const { handle, url } = handleForTarget(target);
+        await handle.clearPolicy();
+        console.error(`Unpublished (capability-only access): ${url}`);
+        return 0;
+    }
+    catch (err) {
+        return reportError({ action: 'unpublish the path', err });
+    }
+}
+/**
+ * Delegates access to a space, collection, or resource: signs a capability
+ * for the `--to` DID with the given actions and expiration, and prints
+ * `{ delegatedCapability, encoded }` (the same shape as `zcap delegate`).
+ * `--save` stores the capability in the local zcap store
+ * (`~/.config/did-cli-wallet/zcaps/`).
+ *
+ * @param options {object}
+ * @param options.address {string}   The space/collection/resource address.
+ * @param options.to {string}   The delegatee DID (or stored-DID handle).
+ * @param options.action {string[]}   Allowed actions (HTTP verbs; lowercase
+ *   accepted).
+ * @param [options.ttl] {string}   Time-to-live for expiration (default 1y).
+ * @param [options.expires] {string}   Explicit ISO 8601 expiration
+ *   (overrides --ttl).
+ * @param [options.save] {boolean}   Save the capability to the zcap store.
+ * @param [options.handle] {string}   Short tag for the saved zcap.
+ * @param [options.description] {string}   Longer description for the saved
+ *   zcap.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export async function runGrant(options) {
+    try {
+        const actions = normalizeActions(options.action);
+        const delegatee = await resolveDidRef({ ref: options.to });
+        if (!delegatee) {
+            throw new Error(`No locally stored DID found for "${options.to}".`);
+        }
+        const expires = options.expires ?? expiresFromTtl(options.ttl ?? '1y').toISOString();
+        const target = await resolveWasTarget({
+            address: options.address,
+            server: options.server,
+            did: options.did
+        });
+        const url = wasUrl({
+            server: target.server,
+            spaceId: target.spaceId,
+            collectionId: target.collectionId,
+            resourceId: target.resourceId
+        });
+        const delegatedCapability = await target.client.grant({
+            to: delegatee,
+            actions,
+            expires,
+            target: url
+        });
+        const encoded = encodeCapability(delegatedCapability);
+        if (options.save) {
+            const storageId = storageIdFor(delegatedCapability.id);
+            const filePath = await saveToCollection('zcaps', storageId, delegatedCapability);
+            await writeCreateMeta({
+                storageId,
+                created: new Date().toISOString(),
+                handle: options.handle,
+                description: options.description
+            });
+            console.error(`Capability saved to ${filePath}`);
+        }
+        console.log(JSON.stringify({ delegatedCapability, encoded }, null, 2));
+        return 0;
+    }
+    catch (err) {
+        return reportError({ action: 'grant access', err });
+    }
+}
+//# sourceMappingURL=publish.js.map

package/dist/commands/was/publish.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish.js","sourceRoot":"","sources":["../../../src/commands/was/publish.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAElE,qEAAqE;AACrE,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAA;AAG7D;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,OAAiB;IACzC,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;QAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,EAAe,CAAA;QAC9C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,mBAAmB,MAAM,wCAAwC,CAClE,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAIhC;IACC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC;YACpC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC,CAAA;QACF,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC,CAAA;QAC/C,MAAM,MAAM,CAAC,SAAS,EAAE,CAAA;QACxB,OAAO,CAAC,KAAK,CAAC,+BAA+B,GAAG,EAAE,CAAC,CAAA;QACnD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAChB,OAAO,CAAC,CAAA;IACV,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,WAAW,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,EAAE,CAAC,CAAA;IACzD,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAIlC;IACC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC;YACpC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC,CAAA;QACF,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC,CAAA;QAC/C,MAAM,MAAM,CAAC,WAAW,EAAE,CAAA;QAC1B,OAAO,CAAC,KAAK,CAAC,yCAAyC,GAAG,EAAE,CAAC,CAAA;QAC7D,OAAO,CAAC,CAAA;IACV,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,WAAW,CAAC,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,EAAE,CAAC,CAAA;IAC3D,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,OAW9B;IACC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QAChD,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAA;QAC1D,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,oCAAoC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAA;QACrE,CAAC;QACD,MAAM,OAAO,GACX,OAAO,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;QACtE,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC;YACpC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC,CAAA;QACF,MAAM,GAAG,GAAG,MAAM,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC,CAAA;QACF,MAAM,mBAAmB,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;YACpD,EAAE,EAAE,SAAS;YACb,OAAO;YACP,OAAO;YACP,MAAM,EAAE,GAAG;SACZ,CAAC,CAAA;QACF,MAAM,OAAO,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,CAAA;QACrD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,SAAS,GAAG,YAAY,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAA;YACtD,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CACrC,OAAO,EACP,SAAS,EACT,mBAAmB,CACpB,CAAA;YACD,MAAM,eAAe,CAAC;gBACpB,SAAS;gBACT,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACjC,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,WAAW,EAAE,OAAO,CAAC,WAAW;aACjC,CAAC,CAAA;YACF,OAAO,CAAC,KAAK,CAAC,uBAAuB,QAAQ,EAAE,CAAC,CAAA;QAClD,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,mBAAmB,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;QACtE,OAAO,CAAC,CAAA;IACV,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,WAAW,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAA;IACrD,CAAC;AACH,CAAC"}

package/dist/commands/was/resource.d.ts

@@ -0,0 +1,148 @@
+/**
+ * Adds a resource to a collection (server-generated id) and prints the
+ * `{ id, url, contentType }` add result. The collection comes from a path
+ * or a `--capability` targeting one.
+ *
+ * @param options {object}
+ * @param [options.address] {string}   The collection address.
+ * @param [options.capability] {string}   A capability reference instead of
+ *   a path.
+ * @param [options.file] {string}   The payload file; stdin when omitted.
+ * @param [options.contentType] {string}   Explicit payload content type.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export declare function runResourceAdd(options: {
+    address?: string;
+    capability?: string;
+    file?: string;
+    contentType?: string;
+    server?: string;
+    did?: string;
+}): Promise<number>;
+/**
+ * Creates or replaces a resource at a known id (upsert) and prints
+ * `{ id, url }`. The resource comes from a path or a `--capability`
+ * targeting one.
+ *
+ * @param options {object}
+ * @param [options.address] {string}   The resource address.
+ * @param [options.capability] {string}   A capability reference instead of
+ *   a path.
+ * @param [options.file] {string}   The payload file; stdin when omitted.
+ * @param [options.contentType] {string}   Explicit payload content type.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export declare function runResourcePut(options: {
+    address?: string;
+    capability?: string;
+    file?: string;
+    contentType?: string;
+    server?: string;
+    did?: string;
+}): Promise<number>;
+/**
+ * Reads a resource: JSON pretty-printed to stdout, binary written raw
+ * (`--output` for files). The resource comes from a path or a
+ * `--capability` targeting one.
+ *
+ * @param options {object}
+ * @param [options.address] {string}   The resource address.
+ * @param [options.capability] {string}   A capability reference instead of
+ *   a path.
+ * @param [options.output] {string}   The output file path; stdout when
+ *   omitted.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export declare function runResourceGet(options: {
+    address?: string;
+    capability?: string;
+    output?: string;
+    server?: string;
+    did?: string;
+}): Promise<number>;
+/**
+ * Reads a resource's metadata object (server-managed `contentType` / `size` /
+ * timestamps plus the user-writable `custom`) and pretty-prints it. The
+ * resource comes from a path or a `--capability` targeting one.
+ *
+ * @param options {object}
+ * @param [options.address] {string}   The resource address.
+ * @param [options.capability] {string}   A capability reference instead of
+ *   a path.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export declare function runResourceMetaGet(options: {
+    address?: string;
+    capability?: string;
+    server?: string;
+    did?: string;
+}): Promise<number>;
+/**
+ * Updates a resource's user-writable metadata and prints the resulting
+ * metadata. `--name`/`--tag` are read-modify-write sugar that preserve the
+ * other field; giving both, or `--json`, is a full `custom` replacement so
+ * any omitted property is cleared. The resource comes from a path or a
+ * `--capability` targeting one.
+ *
+ * @param options {object}
+ * @param [options.address] {string}   The resource address.
+ * @param [options.capability] {string}   A capability reference instead of
+ *   a path.
+ * @param [options.name] {string}   The resource's display name.
+ * @param options.tag {string[]}   Repeatable `key=value` tag pairs.
+ * @param [options.json] {string}   Full `custom` JSON (inline or a file
+ *   path); mutually exclusive with `--name`/`--tag`.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export declare function runResourceMetaPut(options: {
+    address?: string;
+    capability?: string;
+    name?: string;
+    tag: string[];
+    json?: string;
+    server?: string;
+    did?: string;
+}): Promise<number>;
+/**
+ * Lists the resources in a collection.
+ *
+ * @param options {object}
+ * @param options.address {string}   The collection address.
+ * @param [options.json] {boolean}   Output the raw listing JSON.
+ * @param [options.plain] {boolean}   Output one resource id per line.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export declare function runResourceList(options: {
+    address: string;
+    json?: boolean;
+    plain?: boolean;
+    server?: string;
+    did?: string;
+}): Promise<number>;
+/**
+ * Deletes a resource on the server. Idempotent.
+ *
+ * @param options {object}
+ * @param options.address {string}   The resource address.
+ * @param [options.server] {string}   The server base URL.
+ * @param [options.did] {string}   The signing DID or stored-DID handle.
+ * @returns {Promise<number>}   The process exit code.
+ */
+export declare function runResourceDelete(options: {
+    address: string;
+    server?: string;
+    did?: string;
+}): Promise<number>;
+//# sourceMappingURL=resource.d.ts.map

package/dist/commands/was/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../../src/commands/was/resource.ts"],"names":[],"mappings":"AAoFA;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CA2ClB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CAoBlB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CAgBlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,EAAE;IAChD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CAgBlB;AAsDD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,EAAE;IAChD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CAgClB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CA8BlB;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,EAAE;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CA6BlB"}