@dfns/sdk 0.4.2-alpha.1 → 0.4.3-alpha.1

package/generated/webhooks/types.d.ts

@@ -3,7 +3,7 @@ export type CreateWebhookBody = {
     /** Webhook status */
     status?: ("Enabled" | "Disabled") | undefined;
     description?: string | undefined;
-    events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested") | "*")[];
+    events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified") | "*")[];
 };
 export type CreateWebhookResponse = {
     /** Webhook ID */
@@ -11,7 +11,7 @@ export type CreateWebhookResponse = {
     /** Webhook url */
     url: string;
     /** All events this webhook is subscribed to. */
-    events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested") | "*")[];
+    events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified") | "*")[];
     /** Webhook status */
     status: "Enabled" | "Disabled";
     /** Short description this webhook's purpose */
@@ -42,7 +42,7 @@ export type GetWebhookResponse = {
     /** Webhook url */
     url: string;
     /** All events this webhook is subscribed to. */
-    events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested") | "*")[];
+    events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified") | "*")[];
     /** Webhook status */
     status: "Enabled" | "Disabled";
     /** Short description this webhook's purpose */
@@ -63,7 +63,7 @@ export type GetWebhookEventResponse = {
     /** ISO date string when event was raised */
     date: string;
     /** Webhook event */
-    kind: "policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested";
+    kind: "policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified";
     data: {
         [x: string]: any;
     };
@@ -79,7 +79,7 @@ export type ListWebhookEventsParams = {
     webhookId: string;
 };
 export type ListWebhookEventsQuery = {
-    kind?: ("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested") | undefined;
+    kind?: ("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified") | undefined;
     deliveryFailed?: ("true" | "false") | undefined;
     limit?: number | undefined;
     paginationToken?: string | undefined;
@@ -91,7 +91,7 @@ export type ListWebhookEventsResponse = {
         /** ISO date string when event was raised */
         date: string;
         /** Webhook event */
-        kind: "policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested";
+        kind: "policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified";
         data: {
             [x: string]: any;
         };
@@ -118,7 +118,7 @@ export type ListWebhooksResponse = {
         /** Webhook url */
         url: string;
         /** All events this webhook is subscribed to. */
-        events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested") | "*")[];
+        events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified") | "*")[];
         /** Webhook status */
         status: "Enabled" | "Disabled";
         /** Short description this webhook's purpose */
@@ -144,7 +144,7 @@ export type PingWebhookRequest = PingWebhookParams;
 export type UpdateWebhookBody = {
     url?: string | undefined;
     description?: (string | undefined) | undefined;
-    events?: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested") | "*")[] | undefined;
+    events?: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified") | "*")[] | undefined;
     /** Webhook status */
     status?: (("Enabled" | "Disabled") | undefined) | undefined;
 };
@@ -157,7 +157,7 @@ export type UpdateWebhookResponse = {
     /** Webhook url */
     url: string;
     /** All events this webhook is subscribed to. */
-    events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested") | "*")[];
+    events: (("policy.approval.pending" | "policy.approval.resolved" | "wallet.blockchainevent.detected" | "wallet.created" | "wallet.delegated" | "wallet.exported" | "wallet.signature.failed" | "wallet.signature.rejected" | "wallet.signature.requested" | "wallet.signature.signed" | "wallet.transaction.broadcasted" | "wallet.transaction.confirmed" | "wallet.transaction.failed" | "wallet.transaction.rejected" | "wallet.transaction.requested" | "wallet.transfer.broadcasted" | "wallet.transfer.confirmed" | "wallet.transfer.failed" | "wallet.transfer.rejected" | "wallet.transfer.requested" | "wallet.tags.modified") | "*")[];
     /** Webhook status */
     status: "Enabled" | "Disabled";
     /** Short description this webhook's purpose */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfns/sdk",
-  "version": "0.4.2-alpha.1",
+  "version": "0.4.3-alpha.1",
   "dependencies": {
     "buffer": "6.0.3",
     "cross-fetch": "3.1.6",

package/signer.d.ts

@@ -5,7 +5,6 @@ export type UserVerificationRequirement = 'required' | 'preferred' | 'discourage
 export type AllowCredential = {
     type: 'public-key';
     id: string;
-    transports: CredentialTransport[];
 };
 export type SupportedCredential = {
     kind: CredentialKind;
@@ -43,7 +42,7 @@ export type Fido2Assertion = {
         clientData: string;
         authenticatorData: string;
         signature: string;
-        userHandle: string;
+        userHandle?: string;
     };
 };
 export type PasswordAssertion = {
@@ -69,6 +68,3 @@ export type CredentialAssertion = KeyAssertion | Fido2Assertion | PasswordAssert
 export interface CredentialSigner<T extends CredentialAssertion = FirstFactorAssertion> {
     sign(challenge: UserActionChallenge): Promise<T>;
 }
-export declare class EmptySigner implements CredentialSigner {
-    sign(): Promise<never>;
-}

package/signer.js

@@ -1,10 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmptySigner = void 0;
-const dfnsError_1 = require("./dfnsError");
-class EmptySigner {
-    async sign() {
-        throw new dfnsError_1.DfnsError(-1, 'A signature is required, but an EmptySigner cannot fulfill it.');
-    }
-}
-exports.EmptySigner = EmptySigner;

package/types/auth.d.ts

@@ -0,0 +1 @@
+export * from '../generated/auth';

package/types/auth.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../generated/auth"), exports);

package/utils/fetch.js

@@ -5,9 +5,10 @@ const cross_fetch_1 = require("cross-fetch");
 const dfnsError_1 = require("../dfnsError");
 const baseAuthApi_1 = require("../baseAuthApi");
 const nonce_1 = require("./nonce");
+const DEFAULT_DFNS_BASE_URL = 'https://api.dfns.io';
 const fullUrl = (fetch) => {
     return async (resource, options) => {
-        const { baseUrl } = options.apiOptions;
+        const baseUrl = options.apiOptions.baseUrl || DEFAULT_DFNS_BASE_URL;
         resource = new URL(resource, baseUrl);
         return fetch(resource, options);
     };
@@ -83,6 +84,13 @@ const userAction = (fetch) => {
                 ...options.apiOptions,
                 baseUrl: options.apiOptions.baseAuthUrl || options.apiOptions.baseUrl,
             };
+            if (!apiOptions.signer) {
+                throw new dfnsError_1.DfnsError(-1, 'A "signer" needs to be passed to Dfns client.', {
+                    detail: `Most non-readonly endpoints require "User Action Signing" flow.` +
+                        ` During that flow, the credential "signer" that you passed will handle signing` +
+                        ` the user action challenge, using your credential.`,
+                });
+            }
             const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
                 userActionPayload: options.body ?? '',
                 userActionHttpMethod: options.method,