Improve did uri typing

.changeset/big-suits-hammer.md

@@ -0,0 +1,9 @@
+---
+"@agentcommercekit/did": patch
+"@agentcommercekit/ack-id": patch
+"@agentcommercekit/ack-pay": patch
+"agentcommercekit": patch
+"@agentcommercekit/vc": patch
+---
+
+Scope return type of did pkh creation; improve did uri typing

packages/did/src/methods/did-key.ts

@@ -1,6 +1,7 @@
 import { getPublicKeyFromPrivateKey } from "@agentcommercekit/keys"
 import { bytesToMultibase } from "@agentcommercekit/keys/encoding"
 import * as varint from "varint"
+import type { DidUri } from "../did-uri"
 import type { Keypair } from "@agentcommercekit/keys"
 
 /**
@@ -15,7 +16,7 @@ import type { Keypair } from "@agentcommercekit/keys"
 /**
  * The `did:key` Uri type
  */
-export type DidKeyUri = `did:key:z${string}`
+export type DidKeyUri = DidUri<"key", `z${string}`>
 
 export const KEY_CONFIG = {
   secp256k1: {

packages/did/src/methods/did-pkh.ts

@@ -138,7 +138,7 @@ export function createBlockchainAccountId(
 export function createDidPkhUri(
   chainId: Caip2ChainId,
   address: string
-): DidUri {
+): DidPkhUri {
   return `did:pkh:${createCaip10AccountId(chainId, address)}`
 }
 
@@ -147,7 +147,7 @@ export function createDidPkhUri(
  */
 export function createDidPkhUriFromCaip10AccountId(
   caip10AccountId: Caip10AccountId
-): DidUri {
+): DidPkhUri {
   return `did:pkh:${caip10AccountId}`
 }
 
@@ -203,7 +203,7 @@ export function createDidPkhDocumentFromDidPkhUri(
 export function createDidPkhDocumentFromCaip10AccountId(
   caip10AccountId: Caip10AccountId,
   controller?: DidUri
-): DidUriWithDocument {
+): DidUriWithDocument<DidPkhUri> {
   const did = createDidPkhUriFromCaip10AccountId(caip10AccountId)
   const verificationMethod = createVerificationMethod(did, caip10AccountId)
   const additionalContexts = jsonLdContexts[verificationMethod.type]
@@ -234,7 +234,7 @@ export function createDidPkhDocument({
   address,
   chainId,
   controller
-}: CreateDidPkhDocumentOptions): DidUriWithDocument {
+}: CreateDidPkhDocumentOptions): DidUriWithDocument<DidPkhUri> {
   const caip10AccountId = createCaip10AccountId(chainId, address)
   return createDidPkhDocumentFromCaip10AccountId(caip10AccountId, controller)
 }

packages/did/src/methods/did-web.ts

@@ -6,12 +6,13 @@ import type {
   CreateDidDocumentFromKeypairOptions,
   CreateDidDocumentOptions
 } from "../create-did-document"
+import type { DidUri } from "../did-uri"
 import type { DidUriWithDocument } from "../types"
 
 /**
  * The type of a local Did
  */
-export type DidWebUri = `did:web:${string}`
+export type DidWebUri = DidUri<"web">
 
 // Utility type to distribute Omit over unions
 type DistributiveOmit<T, K extends keyof T> = T extends unknown
@@ -62,7 +63,7 @@ type CreateDidWebDocumentParams = {
 export function createDidWebDocument({
   baseUrl,
   ...options
-}: CreateDidWebDocumentParams): DidUriWithDocument {
+}: CreateDidWebDocumentParams): DidUriWithDocument<DidWebUri> {
   const did = createDidWebUri(baseUrl)
   const didDocument = createDidDocument({
     did,
@@ -91,7 +92,7 @@ type CreateDidWebDocumentFromKeypairParams = Omit<
 export function createDidWebDocumentFromKeypair({
   baseUrl,
   ...options
-}: CreateDidWebDocumentFromKeypairParams): DidUriWithDocument {
+}: CreateDidWebDocumentFromKeypairParams): DidUriWithDocument<DidWebUri> {
   const did = createDidWebUri(baseUrl)
   const didDocument = createDidDocumentFromKeypair({
     did,

packages/did/src/types.ts

@@ -1,7 +1,7 @@
 import type { DidDocument } from "./did-document"
 import type { DidUri } from "./did-uri"
 
-export interface DidUriWithDocument {
-  did: DidUri
+export interface DidUriWithDocument<T extends DidUri = DidUri> {
+  did: T
   didDocument: DidDocument
 }