@tinycloud/share-sdk 1.0.0-beta.3 → 1.0.0-beta.5

package/dist/index.d.cts

@@ -103,7 +103,7 @@ interface ShareErrorInfo {
     };
 }
 declare function toShareErrorInfo(error: unknown): ShareErrorInfo;
-/** Policy/v3 links are self-contained authorization metadata; no blob fetch adapter exists. */
+/** Policy/v3 links seal their authorization metadata in a fragment; no blob fetch adapter exists. */
 interface ShareFetchOptions {
     readonly expectedOrigin?: string;
     readonly signal?: AbortSignal;
@@ -226,8 +226,20 @@ interface PublishedShareMetadata {
 }
 /** Sender-only Policy/v3 material retained in encrypted history for delivery retries. */
 interface PublishedShareDeliveryMaterial {
+    /**
+     * The signed plaintext policy envelope. It is retained only in encrypted
+     * sender history so a delivery can be retried; it never travels in a URL.
+     */
     readonly envelope: Readonly<Record<string, unknown>>;
+    /** CIDv1/raw/sha2-256 of `sealedEnvelope`, and the CID in the share URL. */
     readonly shareCid: string;
+    /**
+     * Canonical `version || nonce || AES-256-GCM ciphertext+tag`, base64url.
+     * Node reopens this exact value before authorizing email delivery.
+     */
+    readonly sealedEnvelope: string;
+    /** 32-byte AES-GCM key for `sealedEnvelope`, base64url and fragment-only in the URL. */
+    readonly envelopeKey: string;
 }
 interface PublishedShare {
     readonly protocol: "tinycloud-share";
@@ -572,13 +584,9 @@ interface AddressedSharePublishOptions {
     readonly deliveryEmail?: string;
     readonly expiresAt: Date;
     /** Sender-history material required by Node's Policy/v3 delivery authorization. */
-    readonly onDeliveryMaterial?: (input: {
-        readonly envelope: Readonly<Record<string, unknown>>;
-        readonly shareCid: string;
-    }) => void;
+    readonly onDeliveryMaterial?: (input: PublishedShareDeliveryMaterial) => void;
     readonly authority: AddressedPublishAuthority;
 }
-/** Canonical application-neutral Policy/v3 addressed publisher shared by browser and CLI. */
 declare function publishAddressedShare(options: AddressedSharePublishOptions): Promise<PublishedShare>;
 
 interface ShareCacheKey {
@@ -803,6 +811,36 @@ declare function notifyShare(input: {
     readonly signal?: AbortSignal;
 }): Promise<ShareNotifyResult>;
 
+/** The signed, app-neutral receipt accepted by OpenCredentials' invitation endpoint. */
+interface CredentialInvitationReceipt {
+    readonly request: {
+        readonly returnLink: string;
+        readonly [field: string]: unknown;
+    };
+    readonly admission: Record<string, unknown>;
+    readonly proof: Record<string, unknown>;
+}
+interface CredentialInvitationResult {
+    readonly status: "accepted";
+}
+type CredentialInvitationErrorCode = "invalid-origin" | "invalid-receipt" | "rejected" | "invalid-response" | "transport";
+/** A detail-free boundary error; it never embeds signed invitation material. */
+declare class CredentialInvitationError extends Error {
+    readonly code: CredentialInvitationErrorCode;
+    constructor(code: CredentialInvitationErrorCode, message: string);
+}
+/**
+ * Submit a Node-authorized credential invitation without involving the Share
+ * application. Other TinyCloud applications can use this same boundary.
+ */
+declare function deliverCredentialInvitation(input: {
+    readonly credentialsOrigin: string;
+    readonly receipt: CredentialInvitationReceipt;
+    readonly shareUrl: string;
+    readonly fetchFn?: typeof globalThis.fetch;
+    readonly signal?: AbortSignal;
+}): Promise<CredentialInvitationResult>;
+
 type ShareRevocationResult = {
     readonly state: "revoked";
     readonly target: "bearer" | "recipientDid" | "email" | "emailDomain";
@@ -1051,4 +1089,4 @@ declare function parseNativeShareUrl(value: string): string;
 /** Receive through the public SDK without creating another transport protocol. */
 declare function openNativeShare(sharing: NativeSharingService, link: string): Promise<unknown>;
 
-export { type AddressedOwnerRootInput, type AddressedOwnerRootReceipt, type AddressedPolicyRegistrationInput, type AddressedPolicyRegistrationReceipt, type AddressedPublishAuthority, type AddressedSharePublishOptions, type CreateOwnerDelegationParams, DEFAULT_MAX_CONTENT_BLOB_BYTES, DEFAULT_MAX_SEALED_BLOB_BYTES, DEFAULT_SHARE_LIFETIME_MS, type DelegatedShareKey, EncryptedSenderShareHistory, type EncryptedShareHistoryStorage, MAX_CONTENT_BYTES, MemoryEncryptedShareHistoryStorage, MemorySenderShareKeyStorage, MemorySenderShareRecordStorage, MemoryShareCache, NATIVE_SHARE_FRAGMENT_PARAMETER, type NativeSharingService, OWNER_SHARE_REGISTRATION_DOMAIN, type OwnerDelegationPermission, type OwnerDelegationReceipt, type OwnerShareAction, type OwnerShareDecryption, type OwnerShareMatcher, type OwnerSharePolicyRegistration, type OwnerSharePolicyRegistrationReceipt, type OwnerSharePolicyV2, type ParsedAddressedEnvelope, type PublishedShare, type PublishedShareDeliveryMaterial, type PublishedShareMetadata, type RegisterOwnerSharePolicyParams, SHARE_CONTENT_LIMIT, SHARE_PUBLISH_RESULT_VERSION, SHARE_RESULT_VERSION, SHARE_V2_PROTOCOL, type SenderShareKeyStorage, type SenderShareRecord, type SenderShareRecordStorage, type SenderShareRevocationScope, SenderShareStore, type ShareAuthorizationAdapter, type ShareAuthorizationDenied, type ShareAuthorizationMethod, type ShareAuthorizationReady, type ShareAuthorizationRequired, type ShareAuthorizationResult, type ShareAuthorizedContent, type ShareCache, type ShareCacheEntry, type ShareCacheKey, type ShareCacheMetadata, type ShareDeliveryAdapter, type ShareErrorCode, type ShareErrorInfo, type ShareFetchOptions, type ShareHistoryView, type ShareInspection, type ShareMetadata, type ShareNodeTrust, ShareNotifyError, type ShareNotifyInput, type ShareNotifyResult, type ShareNotifyState, type SharePolicyChallenge, type SharePolicyPublishAdapter, type SharePolicyRootRevocation, type SharePolicySession, type SharePresentationMaterial, SharePublishError, type SharePublishErrorCode, type SharePublishOptions, type SharePublishTarget, type ShareReceiveAuthorizationRequired, ShareReceiveError, type ShareReceiveOutcome, type ShareReceiveResult, ShareRecipientClient, type ShareRecipientClientOptions, type ShareRevocationAdapter, type ShareRevocationResult, type ShareTarget, type SignedDelegation, type TargetPublishAdapter, type TargetPublishInput, type TargetPublishOutcome, authorizationMethodForTarget, authorizeShare, canonicalOwnerSharePolicy, claimShare, computeOwnerShareRegistrationCid, createAddressedAuthorization, createDelegatedShareKey, createNativeShare, createPolicyEnforcementDelegation, createShareV2HolderBindingArtifact, historyRecordForPublishedShare, inspectShare, listShares, normalizeShareTarget, notifyShare, openNativeShare, parseAddressedEnvelope, parseNativeShareUrl, publishAddressedShare, publishPolicyShare, publishTargetShare, receiveShare, recipientMatchesShareRecord, redactPublishedShare, restoreDelegatedShareKey, resumeShareAuthorization, revokeShare, showShare, targetAuthorizationMethod, toShareErrorInfo, validateOwnerSharePolicyRegistration, validateOwnerSharePolicyRegistrationBytes };
+export { type AddressedOwnerRootInput, type AddressedOwnerRootReceipt, type AddressedPolicyRegistrationInput, type AddressedPolicyRegistrationReceipt, type AddressedPublishAuthority, type AddressedSharePublishOptions, type CreateOwnerDelegationParams, CredentialInvitationError, type CredentialInvitationErrorCode, type CredentialInvitationReceipt, type CredentialInvitationResult, DEFAULT_MAX_CONTENT_BLOB_BYTES, DEFAULT_MAX_SEALED_BLOB_BYTES, DEFAULT_SHARE_LIFETIME_MS, type DelegatedShareKey, EncryptedSenderShareHistory, type EncryptedShareHistoryStorage, MAX_CONTENT_BYTES, MemoryEncryptedShareHistoryStorage, MemorySenderShareKeyStorage, MemorySenderShareRecordStorage, MemoryShareCache, NATIVE_SHARE_FRAGMENT_PARAMETER, type NativeSharingService, OWNER_SHARE_REGISTRATION_DOMAIN, type OwnerDelegationPermission, type OwnerDelegationReceipt, type OwnerShareAction, type OwnerShareDecryption, type OwnerShareMatcher, type OwnerSharePolicyRegistration, type OwnerSharePolicyRegistrationReceipt, type OwnerSharePolicyV2, type ParsedAddressedEnvelope, type PublishedShare, type PublishedShareDeliveryMaterial, type PublishedShareMetadata, type RegisterOwnerSharePolicyParams, SHARE_CONTENT_LIMIT, SHARE_PUBLISH_RESULT_VERSION, SHARE_RESULT_VERSION, SHARE_V2_PROTOCOL, type SenderShareKeyStorage, type SenderShareRecord, type SenderShareRecordStorage, type SenderShareRevocationScope, SenderShareStore, type ShareAuthorizationAdapter, type ShareAuthorizationDenied, type ShareAuthorizationMethod, type ShareAuthorizationReady, type ShareAuthorizationRequired, type ShareAuthorizationResult, type ShareAuthorizedContent, type ShareCache, type ShareCacheEntry, type ShareCacheKey, type ShareCacheMetadata, type ShareDeliveryAdapter, type ShareErrorCode, type ShareErrorInfo, type ShareFetchOptions, type ShareHistoryView, type ShareInspection, type ShareMetadata, type ShareNodeTrust, ShareNotifyError, type ShareNotifyInput, type ShareNotifyResult, type ShareNotifyState, type SharePolicyChallenge, type SharePolicyPublishAdapter, type SharePolicyRootRevocation, type SharePolicySession, type SharePresentationMaterial, SharePublishError, type SharePublishErrorCode, type SharePublishOptions, type SharePublishTarget, type ShareReceiveAuthorizationRequired, ShareReceiveError, type ShareReceiveOutcome, type ShareReceiveResult, ShareRecipientClient, type ShareRecipientClientOptions, type ShareRevocationAdapter, type ShareRevocationResult, type ShareTarget, type SignedDelegation, type TargetPublishAdapter, type TargetPublishInput, type TargetPublishOutcome, authorizationMethodForTarget, authorizeShare, canonicalOwnerSharePolicy, claimShare, computeOwnerShareRegistrationCid, createAddressedAuthorization, createDelegatedShareKey, createNativeShare, createPolicyEnforcementDelegation, createShareV2HolderBindingArtifact, deliverCredentialInvitation, historyRecordForPublishedShare, inspectShare, listShares, normalizeShareTarget, notifyShare, openNativeShare, parseAddressedEnvelope, parseNativeShareUrl, publishAddressedShare, publishPolicyShare, publishTargetShare, receiveShare, recipientMatchesShareRecord, redactPublishedShare, restoreDelegatedShareKey, resumeShareAuthorization, revokeShare, showShare, targetAuthorizationMethod, toShareErrorInfo, validateOwnerSharePolicyRegistration, validateOwnerSharePolicyRegistrationBytes };

package/dist/index.d.ts

@@ -103,7 +103,7 @@ interface ShareErrorInfo {
     };
 }
 declare function toShareErrorInfo(error: unknown): ShareErrorInfo;
-/** Policy/v3 links are self-contained authorization metadata; no blob fetch adapter exists. */
+/** Policy/v3 links seal their authorization metadata in a fragment; no blob fetch adapter exists. */
 interface ShareFetchOptions {
     readonly expectedOrigin?: string;
     readonly signal?: AbortSignal;
@@ -226,8 +226,20 @@ interface PublishedShareMetadata {
 }
 /** Sender-only Policy/v3 material retained in encrypted history for delivery retries. */
 interface PublishedShareDeliveryMaterial {
+    /**
+     * The signed plaintext policy envelope. It is retained only in encrypted
+     * sender history so a delivery can be retried; it never travels in a URL.
+     */
     readonly envelope: Readonly<Record<string, unknown>>;
+    /** CIDv1/raw/sha2-256 of `sealedEnvelope`, and the CID in the share URL. */
     readonly shareCid: string;
+    /**
+     * Canonical `version || nonce || AES-256-GCM ciphertext+tag`, base64url.
+     * Node reopens this exact value before authorizing email delivery.
+     */
+    readonly sealedEnvelope: string;
+    /** 32-byte AES-GCM key for `sealedEnvelope`, base64url and fragment-only in the URL. */
+    readonly envelopeKey: string;
 }
 interface PublishedShare {
     readonly protocol: "tinycloud-share";
@@ -572,13 +584,9 @@ interface AddressedSharePublishOptions {
     readonly deliveryEmail?: string;
     readonly expiresAt: Date;
     /** Sender-history material required by Node's Policy/v3 delivery authorization. */
-    readonly onDeliveryMaterial?: (input: {
-        readonly envelope: Readonly<Record<string, unknown>>;
-        readonly shareCid: string;
-    }) => void;
+    readonly onDeliveryMaterial?: (input: PublishedShareDeliveryMaterial) => void;
     readonly authority: AddressedPublishAuthority;
 }
-/** Canonical application-neutral Policy/v3 addressed publisher shared by browser and CLI. */
 declare function publishAddressedShare(options: AddressedSharePublishOptions): Promise<PublishedShare>;
 
 interface ShareCacheKey {
@@ -803,6 +811,36 @@ declare function notifyShare(input: {
     readonly signal?: AbortSignal;
 }): Promise<ShareNotifyResult>;
 
+/** The signed, app-neutral receipt accepted by OpenCredentials' invitation endpoint. */
+interface CredentialInvitationReceipt {
+    readonly request: {
+        readonly returnLink: string;
+        readonly [field: string]: unknown;
+    };
+    readonly admission: Record<string, unknown>;
+    readonly proof: Record<string, unknown>;
+}
+interface CredentialInvitationResult {
+    readonly status: "accepted";
+}
+type CredentialInvitationErrorCode = "invalid-origin" | "invalid-receipt" | "rejected" | "invalid-response" | "transport";
+/** A detail-free boundary error; it never embeds signed invitation material. */
+declare class CredentialInvitationError extends Error {
+    readonly code: CredentialInvitationErrorCode;
+    constructor(code: CredentialInvitationErrorCode, message: string);
+}
+/**
+ * Submit a Node-authorized credential invitation without involving the Share
+ * application. Other TinyCloud applications can use this same boundary.
+ */
+declare function deliverCredentialInvitation(input: {
+    readonly credentialsOrigin: string;
+    readonly receipt: CredentialInvitationReceipt;
+    readonly shareUrl: string;
+    readonly fetchFn?: typeof globalThis.fetch;
+    readonly signal?: AbortSignal;
+}): Promise<CredentialInvitationResult>;
+
 type ShareRevocationResult = {
     readonly state: "revoked";
     readonly target: "bearer" | "recipientDid" | "email" | "emailDomain";
@@ -1051,4 +1089,4 @@ declare function parseNativeShareUrl(value: string): string;
 /** Receive through the public SDK without creating another transport protocol. */
 declare function openNativeShare(sharing: NativeSharingService, link: string): Promise<unknown>;
 
-export { type AddressedOwnerRootInput, type AddressedOwnerRootReceipt, type AddressedPolicyRegistrationInput, type AddressedPolicyRegistrationReceipt, type AddressedPublishAuthority, type AddressedSharePublishOptions, type CreateOwnerDelegationParams, DEFAULT_MAX_CONTENT_BLOB_BYTES, DEFAULT_MAX_SEALED_BLOB_BYTES, DEFAULT_SHARE_LIFETIME_MS, type DelegatedShareKey, EncryptedSenderShareHistory, type EncryptedShareHistoryStorage, MAX_CONTENT_BYTES, MemoryEncryptedShareHistoryStorage, MemorySenderShareKeyStorage, MemorySenderShareRecordStorage, MemoryShareCache, NATIVE_SHARE_FRAGMENT_PARAMETER, type NativeSharingService, OWNER_SHARE_REGISTRATION_DOMAIN, type OwnerDelegationPermission, type OwnerDelegationReceipt, type OwnerShareAction, type OwnerShareDecryption, type OwnerShareMatcher, type OwnerSharePolicyRegistration, type OwnerSharePolicyRegistrationReceipt, type OwnerSharePolicyV2, type ParsedAddressedEnvelope, type PublishedShare, type PublishedShareDeliveryMaterial, type PublishedShareMetadata, type RegisterOwnerSharePolicyParams, SHARE_CONTENT_LIMIT, SHARE_PUBLISH_RESULT_VERSION, SHARE_RESULT_VERSION, SHARE_V2_PROTOCOL, type SenderShareKeyStorage, type SenderShareRecord, type SenderShareRecordStorage, type SenderShareRevocationScope, SenderShareStore, type ShareAuthorizationAdapter, type ShareAuthorizationDenied, type ShareAuthorizationMethod, type ShareAuthorizationReady, type ShareAuthorizationRequired, type ShareAuthorizationResult, type ShareAuthorizedContent, type ShareCache, type ShareCacheEntry, type ShareCacheKey, type ShareCacheMetadata, type ShareDeliveryAdapter, type ShareErrorCode, type ShareErrorInfo, type ShareFetchOptions, type ShareHistoryView, type ShareInspection, type ShareMetadata, type ShareNodeTrust, ShareNotifyError, type ShareNotifyInput, type ShareNotifyResult, type ShareNotifyState, type SharePolicyChallenge, type SharePolicyPublishAdapter, type SharePolicyRootRevocation, type SharePolicySession, type SharePresentationMaterial, SharePublishError, type SharePublishErrorCode, type SharePublishOptions, type SharePublishTarget, type ShareReceiveAuthorizationRequired, ShareReceiveError, type ShareReceiveOutcome, type ShareReceiveResult, ShareRecipientClient, type ShareRecipientClientOptions, type ShareRevocationAdapter, type ShareRevocationResult, type ShareTarget, type SignedDelegation, type TargetPublishAdapter, type TargetPublishInput, type TargetPublishOutcome, authorizationMethodForTarget, authorizeShare, canonicalOwnerSharePolicy, claimShare, computeOwnerShareRegistrationCid, createAddressedAuthorization, createDelegatedShareKey, createNativeShare, createPolicyEnforcementDelegation, createShareV2HolderBindingArtifact, historyRecordForPublishedShare, inspectShare, listShares, normalizeShareTarget, notifyShare, openNativeShare, parseAddressedEnvelope, parseNativeShareUrl, publishAddressedShare, publishPolicyShare, publishTargetShare, receiveShare, recipientMatchesShareRecord, redactPublishedShare, restoreDelegatedShareKey, resumeShareAuthorization, revokeShare, showShare, targetAuthorizationMethod, toShareErrorInfo, validateOwnerSharePolicyRegistration, validateOwnerSharePolicyRegistrationBytes };
+export { type AddressedOwnerRootInput, type AddressedOwnerRootReceipt, type AddressedPolicyRegistrationInput, type AddressedPolicyRegistrationReceipt, type AddressedPublishAuthority, type AddressedSharePublishOptions, type CreateOwnerDelegationParams, CredentialInvitationError, type CredentialInvitationErrorCode, type CredentialInvitationReceipt, type CredentialInvitationResult, DEFAULT_MAX_CONTENT_BLOB_BYTES, DEFAULT_MAX_SEALED_BLOB_BYTES, DEFAULT_SHARE_LIFETIME_MS, type DelegatedShareKey, EncryptedSenderShareHistory, type EncryptedShareHistoryStorage, MAX_CONTENT_BYTES, MemoryEncryptedShareHistoryStorage, MemorySenderShareKeyStorage, MemorySenderShareRecordStorage, MemoryShareCache, NATIVE_SHARE_FRAGMENT_PARAMETER, type NativeSharingService, OWNER_SHARE_REGISTRATION_DOMAIN, type OwnerDelegationPermission, type OwnerDelegationReceipt, type OwnerShareAction, type OwnerShareDecryption, type OwnerShareMatcher, type OwnerSharePolicyRegistration, type OwnerSharePolicyRegistrationReceipt, type OwnerSharePolicyV2, type ParsedAddressedEnvelope, type PublishedShare, type PublishedShareDeliveryMaterial, type PublishedShareMetadata, type RegisterOwnerSharePolicyParams, SHARE_CONTENT_LIMIT, SHARE_PUBLISH_RESULT_VERSION, SHARE_RESULT_VERSION, SHARE_V2_PROTOCOL, type SenderShareKeyStorage, type SenderShareRecord, type SenderShareRecordStorage, type SenderShareRevocationScope, SenderShareStore, type ShareAuthorizationAdapter, type ShareAuthorizationDenied, type ShareAuthorizationMethod, type ShareAuthorizationReady, type ShareAuthorizationRequired, type ShareAuthorizationResult, type ShareAuthorizedContent, type ShareCache, type ShareCacheEntry, type ShareCacheKey, type ShareCacheMetadata, type ShareDeliveryAdapter, type ShareErrorCode, type ShareErrorInfo, type ShareFetchOptions, type ShareHistoryView, type ShareInspection, type ShareMetadata, type ShareNodeTrust, ShareNotifyError, type ShareNotifyInput, type ShareNotifyResult, type ShareNotifyState, type SharePolicyChallenge, type SharePolicyPublishAdapter, type SharePolicyRootRevocation, type SharePolicySession, type SharePresentationMaterial, SharePublishError, type SharePublishErrorCode, type SharePublishOptions, type SharePublishTarget, type ShareReceiveAuthorizationRequired, ShareReceiveError, type ShareReceiveOutcome, type ShareReceiveResult, ShareRecipientClient, type ShareRecipientClientOptions, type ShareRevocationAdapter, type ShareRevocationResult, type ShareTarget, type SignedDelegation, type TargetPublishAdapter, type TargetPublishInput, type TargetPublishOutcome, authorizationMethodForTarget, authorizeShare, canonicalOwnerSharePolicy, claimShare, computeOwnerShareRegistrationCid, createAddressedAuthorization, createDelegatedShareKey, createNativeShare, createPolicyEnforcementDelegation, createShareV2HolderBindingArtifact, deliverCredentialInvitation, historyRecordForPublishedShare, inspectShare, listShares, normalizeShareTarget, notifyShare, openNativeShare, parseAddressedEnvelope, parseNativeShareUrl, publishAddressedShare, publishPolicyShare, publishTargetShare, receiveShare, recipientMatchesShareRecord, redactPublishedShare, restoreDelegatedShareKey, resumeShareAuthorization, revokeShare, showShare, targetAuthorizationMethod, toShareErrorInfo, validateOwnerSharePolicyRegistration, validateOwnerSharePolicyRegistrationBytes };