@digitalcredentials/ssi - npm Package Compare versions

Comparing version 5.4.2 to 5.5.0

dist/ZCap.d.ts

+/*!
+ * Authorization Capabilities (zCap) interfaces.
+ * @see https://w3c-ccg.github.io/zcap-spec/
+ */
+/**
+ * A proof attached to a delegated zCap.
+ */
+export interface ICapabilityDelegationProof {
+    /** The cryptographic suite type (e.g. `'Ed25519Signature2020'`). */
+    type: string;
+    /** ISO 8601 date-time the proof was created. */
+    created: string;
+    /** Verification method URI used to sign. */
+    verificationMethod: string;
+    /** Always `'capabilityDelegation'`. */
+    proofPurpose: 'capabilityDelegation';
+    /**
+     * Ordered capability chain (root → parent). All entries are string IDs
+     * except the last delegated zCap, which is embedded as an object.
+     */
+    capabilityChain: Array<string | IDelegatedZcap>;
+    /** The encoded proof value. */
+    proofValue: string;
+}
+/**
+ * A root authorization capability (zCap). Root zCaps are unsigned, have no
+ * `expires` field and no delegation proof. Their `id` follows the convention
+ * `urn:zcap:root:${encodeURIComponent(invocationTarget)}`.
+ */
+export interface IRootZcap {
+    /** The zCap JSON-LD context URL. */
+    '@context': string;
+    /** Capability ID (`urn:zcap:root:<encodedTarget>`). */
+    id: string;
+    /** The DID(s) authorized to invoke. */
+    controller: string | string[];
+    /** Resource URI this capability grants access to (absolute URI). */
+    invocationTarget: string;
+}
+/**
+ * A delegated authorization capability (zCap). Delegated capabilities narrow
+ * a parent capability and must carry exactly one `capabilityDelegation` proof.
+ */
+export interface IDelegatedZcap {
+    /** JSON-LD context array; first entry MUST be the zCap context URL. */
+    '@context': string[];
+    /** Capability ID (absolute URI). */
+    id: string;
+    /** Parent capability ID (absolute URI). */
+    parentCapability: string;
+    /** The DID(s) authorized to invoke. */
+    controller: string | string[];
+    /** Resource URI this capability grants access to (absolute URI). */
+    invocationTarget: string;
+    /**
+     * The action(s) the controller may perform; if absent, no actions are
+     * allowed (except for the root zCap).
+     */
+    allowedAction?: string | string[];
+    /** ISO 8601 date-time when this capability expires. */
+    expires: string;
+    /** The capability delegation proof(s). */
+    proof: ICapabilityDelegationProof | ICapabilityDelegationProof[];
+}
+/**
+ * A zCap is either a root or a delegated authorization capability.
+ *
+ * Use this discriminated union when the call site knows it has a real,
+ * well-formed zCap and can narrow via `'parentCapability' in cap`.
+ */
+export type IZcap = IRootZcap | IDelegatedZcap;
+/**
+ * A permissive zCap shape that conflates root and delegated kinds and admits
+ * arbitrary additional properties (e.g. the opaque object returned from
+ * `jsigs.sign()`).
+ *
+ * Prefer the strict `IZcap` union when possible. Use `IZcapLike` only when:
+ * - the call site receives a capability whose kind is not yet known and
+ *   cannot reasonably discriminate, or
+ * - the call site needs to accept the open-ended shape produced by
+ *   linked-data signature libraries that may attach extra properties.
+ */
+export interface IZcapLike {
+    '@context': string | string[];
+    id: string;
+    invocationTarget: string;
+    controller?: string | string[];
+    parentCapability?: string;
+    allowedAction?: string | string[];
+    expires?: string;
+    proof?: ICapabilityDelegationProof | ICapabilityDelegationProof[];
+    [key: string]: unknown;
+}
+//# sourceMappingURL=ZCap.d.ts.map

dist/ZCap.d.ts.map

+{"version":3,"file":"ZCap.d.ts","sourceRoot":"","sources":["../src/ZCap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAA;IACf,4CAA4C;IAC5C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,uCAAuC;IACvC,YAAY,EAAE,sBAAsB,CAAA;IACpC;;;OAGG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC,CAAA;IAC/C,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,uDAAuD;IACvD,EAAE,EAAE,MAAM,CAAA;IACV,uCAAuC;IACvC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B,oEAAoE;IACpE,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,uEAAuE;IACvE,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,oCAAoC;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,2CAA2C;IAC3C,gBAAgB,EAAE,MAAM,CAAA;IACxB,uCAAuC;IACvC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B,oEAAoE;IACpE,gBAAgB,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAA;IACf,0CAA0C;IAC1C,KAAK,EAAE,0BAA0B,GAAG,0BAA0B,EAAE,CAAA;CACjE;AAED;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG,SAAS,GAAG,cAAc,CAAA;AAE9C;;;;;;;;;;GAUG;AACH,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,gBAAgB,EAAE,MAAM,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,0BAA0B,GAAG,0BAA0B,EAAE,CAAA;IACjE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB"}

dist/ZCap.js

+/*!
+ * Authorization Capabilities (zCap) interfaces.
+ * @see https://w3c-ccg.github.io/zcap-spec/
+ */
+export {};

dist/index.d.ts

@@ -9,2 +9,3 @@ /*!
 export * from './OBv3.js';
+export * from './ZCap.js';
 //# sourceMappingURL=index.d.ts.map

dist/index.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA"}

dist/index.js

@@ -9,1 +9,2 @@ /*!
 export * from './OBv3.js';
+export * from './ZCap.js';

package.json

 {
   "name": "@digitalcredentials/ssi",
   "description": "Typescript types for the W3C Verifiable Credentials Data Model.",
-  "version": "5.4.2",
+  "version": "5.5.0",
   "scripts": {
@@ -38,2 +38,6 @@ "build": "npm run clear && tsc -d",
       "default": "./dist/VCDM.js"
+    },
+    "./zcap": {
+      "types": "./dist/ZCap.d.ts",
+      "default": "./dist/ZCap.js"
     }
@@ -40,0 +44,0 @@ },

README.md

@@ -98,2 +98,3 @@ # SSI Types and Data Model _(@digitalcredentials/ssi)_
 * ... others (see individual exports in `/src`)
+* `IZcap` and related interfaces (`IRootZcap`, `IDelegatedZcap`, `IZcapLike`, and `ICapabilityDelegationProof`)
 
@@ -100,0 +101,0 @@ ## Contribute

No alert changes

Improved metrics

Total package byte prevSize

33221

19.41%

Number of package files

24

14.29%

Lines of code

506

24.63%

Number of lines in readme file

110

0.92%

No dependency changes