@dfns/sdk 0.2.5 → 0.3.0

package/dfnsApiClient.d.ts

@@ -3,11 +3,10 @@ import { AssetsClient } from './codegen/Assets';
 import { AuthClient } from './codegen/Auth';
 import { BlockchainsClient } from './codegen/Blockchains';
 import { CallbacksClient } from './codegen/Callbacks';
-import { PermissionsClient } from './codegen/Permissions';
 import { PolicyExecutionClient } from './codegen/PolicyExecution';
 import { PolicyManagementClient } from './codegen/PolicyManagement';
 import { PublicKeysClient } from './codegen/PublicKeys';
-import { PermissionsClient as PermissionsV2Client } from './generated/permissions';
+import { PermissionsClient } from './generated/permissions';
 import { PoliciesClient } from './generated/policies';
 import { SignersClient } from './generated/signers';
 import { WalletsClient } from './generated/wallets';
@@ -23,11 +22,7 @@ export declare class DfnsApiClient {
     get auth(): AuthClient;
     get blockchains(): BlockchainsClient;
     get callbacks(): CallbacksClient;
-    /**
-     * @deprecated use permissions v2 instead
-     */
     get permissions(): PermissionsClient;
-    get permissionsV2(): PermissionsV2Client;
     get policies(): PoliciesClient;
     /**
      * @deprecated use the new policy engine instead

package/dfnsApiClient.js

@@ -5,7 +5,6 @@ const Assets_1 = require("./codegen/Assets");
 const Auth_1 = require("./codegen/Auth");
 const Blockchains_1 = require("./codegen/Blockchains");
 const Callbacks_1 = require("./codegen/Callbacks");
-const Permissions_1 = require("./codegen/Permissions");
 const PolicyExecution_1 = require("./codegen/PolicyExecution");
 const PolicyManagement_1 = require("./codegen/PolicyManagement");
 const PublicKeys_1 = require("./codegen/PublicKeys");
@@ -30,13 +29,7 @@ class DfnsApiClient {
     get callbacks() {
         return new Callbacks_1.CallbacksClient(this.apiOptions);
     }
-    /**
-     * @deprecated use permissions v2 instead
-     */
     get permissions() {
-        return new Permissions_1.PermissionsClient(this.apiOptions);
-    }
-    get permissionsV2() {
         return new permissions_1.PermissionsClient(this.apiOptions);
     }
     get policies() {

package/dfnsDelegatedApiClient.d.ts

@@ -3,11 +3,10 @@ import { DelegatedAssetsClient } from './codegen/Assets';
 import { DelegatedAuthClient } from './codegen/Auth';
 import { DelegatedBlockchainsClient } from './codegen/Blockchains';
 import { DelegatedCallbacksClient } from './codegen/Callbacks';
-import { DelegatedPermissionsClient } from './codegen/Permissions';
 import { DelegatedPolicyExecutionClient } from './codegen/PolicyExecution';
 import { DelegatedPolicyManagementClient } from './codegen/PolicyManagement';
 import { DelegatedPublicKeysClient } from './codegen/PublicKeys';
-import { DelegatedPermissionsClient as DelegatedPermissionsV2Client } from './generated/permissions';
+import { DelegatedPermissionsClient } from './generated/permissions';
 import { DelegatedPoliciesClient } from './generated/policies';
 import { DelegatedSignersClient } from './generated/signers';
 import { DelegatedWalletsClient } from './generated/wallets';
@@ -22,11 +21,7 @@ export declare class DfnsDelegatedApiClient {
     get auth(): DelegatedAuthClient;
     get blockchains(): DelegatedBlockchainsClient;
     get callbacks(): DelegatedCallbacksClient;
-    /**
-     * @deprecated use permissions v2 instead
-     */
     get permissions(): DelegatedPermissionsClient;
-    get permissionsV2(): DelegatedPermissionsV2Client;
     get policies(): DelegatedPoliciesClient;
     /**
      * @deprecated use the new policy engine instead

package/dfnsDelegatedApiClient.js

@@ -5,7 +5,6 @@ const Assets_1 = require("./codegen/Assets");
 const Auth_1 = require("./codegen/Auth");
 const Blockchains_1 = require("./codegen/Blockchains");
 const Callbacks_1 = require("./codegen/Callbacks");
-const Permissions_1 = require("./codegen/Permissions");
 const PolicyExecution_1 = require("./codegen/PolicyExecution");
 const PolicyManagement_1 = require("./codegen/PolicyManagement");
 const PublicKeys_1 = require("./codegen/PublicKeys");
@@ -30,13 +29,7 @@ class DfnsDelegatedApiClient {
     get callbacks() {
         return new Callbacks_1.DelegatedCallbacksClient(this.apiOptions);
     }
-    /**
-     * @deprecated use permissions v2 instead
-     */
     get permissions() {
-        return new Permissions_1.DelegatedPermissionsClient(this.apiOptions);
-    }
-    get permissionsV2() {
         return new permissions_1.DelegatedPermissionsClient(this.apiOptions);
     }
     get policies() {

package/dfnsError.d.ts

@@ -2,4 +2,9 @@ export declare class DfnsError extends Error {
     httpStatus: number;
     context?: unknown;
     constructor(httpStatus: number, message: string, context?: unknown);
+    toString(): string;
+}
+export declare class PolicyPendingError extends DfnsError {
+    static HTTP_ACCEPTED: number;
+    constructor(context: unknown);
 }

package/dfnsError.js

@@ -1,11 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DfnsError = void 0;
+exports.PolicyPendingError = exports.DfnsError = void 0;
 class DfnsError extends Error {
     constructor(httpStatus, message, context) {
         super(message);
         this.httpStatus = httpStatus;
         this.context = context;
     }
+    toString() {
+        return JSON.stringify({
+            httpStatus: this.httpStatus,
+            message: this.message,
+            ...(this.context && this.context),
+        }, null, 2);
+    }
 }
 exports.DfnsError = DfnsError;
+class PolicyPendingError extends DfnsError {
+    constructor(context) {
+        super(PolicyPendingError.HTTP_ACCEPTED, 'Operation triggered a policy pending approval', context);
+    }
+}
+exports.PolicyPendingError = PolicyPendingError;
+PolicyPendingError.HTTP_ACCEPTED = 202;

package/generated/permissions/client.js

@@ -8,7 +8,7 @@ class PermissionsClient {
         this.apiOptions = apiOptions;
     }
     async archivePermission(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/archive', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/archive', {
             path: request ?? {},
             query: {},
         });
@@ -20,7 +20,7 @@ class PermissionsClient {
         return response.json();
     }
     async createAssignment(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/assignments', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments', {
             path: request ?? {},
             query: {},
         });
@@ -32,7 +32,7 @@ class PermissionsClient {
         return response.json();
     }
     async createPermission(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions', {
             path: request ?? {},
             query: {},
         });
@@ -44,7 +44,7 @@ class PermissionsClient {
         return response.json();
     }
     async deleteAssignment(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/assignments/:assignmentId', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments/:assignmentId', {
             path: request ?? {},
             query: {},
         });
@@ -56,7 +56,7 @@ class PermissionsClient {
         return response.json();
     }
     async getPermission(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId', {
             path: request ?? {},
             query: {},
         });
@@ -67,7 +67,7 @@ class PermissionsClient {
         return response.json();
     }
     async listAssignments(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/assignments', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments', {
             path: request ?? {},
             query: {},
         });
@@ -78,7 +78,7 @@ class PermissionsClient {
         return response.json();
     }
     async listPermissions(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions', {
             path: request ?? {},
             query: request?.query ?? {},
         });
@@ -89,7 +89,7 @@ class PermissionsClient {
         return response.json();
     }
     async updatePermission(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId', {
             path: request ?? {},
             query: {},
         });

package/generated/permissions/delegatedClient.js

@@ -9,7 +9,7 @@ class DelegatedPermissionsClient {
         this.apiOptions = apiOptions;
     }
     async archivePermissionInit(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/archive', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/archive', {
             path: request ?? {},
             query: {},
         });
@@ -22,7 +22,7 @@ class DelegatedPermissionsClient {
         return challenge;
     }
     async archivePermissionComplete(request, signedChallenge) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/archive', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/archive', {
             path: request ?? {},
             query: {},
         });
@@ -36,7 +36,7 @@ class DelegatedPermissionsClient {
         return response.json();
     }
     async createAssignmentInit(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/assignments', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments', {
             path: request ?? {},
             query: {},
         });
@@ -49,7 +49,7 @@ class DelegatedPermissionsClient {
         return challenge;
     }
     async createAssignmentComplete(request, signedChallenge) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/assignments', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments', {
             path: request ?? {},
             query: {},
         });
@@ -63,7 +63,7 @@ class DelegatedPermissionsClient {
         return response.json();
     }
     async createPermissionInit(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions', {
             path: request ?? {},
             query: {},
         });
@@ -76,7 +76,7 @@ class DelegatedPermissionsClient {
         return challenge;
     }
     async createPermissionComplete(request, signedChallenge) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions', {
             path: request ?? {},
             query: {},
         });
@@ -90,7 +90,7 @@ class DelegatedPermissionsClient {
         return response.json();
     }
     async deleteAssignmentInit(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/assignments/:assignmentId', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments/:assignmentId', {
             path: request ?? {},
             query: {},
         });
@@ -103,7 +103,7 @@ class DelegatedPermissionsClient {
         return challenge;
     }
     async deleteAssignmentComplete(request, signedChallenge) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/assignments/:assignmentId', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments/:assignmentId', {
             path: request ?? {},
             query: {},
         });
@@ -117,7 +117,7 @@ class DelegatedPermissionsClient {
         return response.json();
     }
     async getPermission(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId', {
             path: request ?? {},
             query: {},
         });
@@ -128,7 +128,7 @@ class DelegatedPermissionsClient {
         return response.json();
     }
     async listAssignments(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId/assignments', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments', {
             path: request ?? {},
             query: {},
         });
@@ -139,7 +139,7 @@ class DelegatedPermissionsClient {
         return response.json();
     }
     async listPermissions(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions', {
             path: request ?? {},
             query: request?.query ?? {},
         });
@@ -150,7 +150,7 @@ class DelegatedPermissionsClient {
         return response.json();
     }
     async updatePermissionInit(request) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId', {
             path: request ?? {},
             query: {},
         });
@@ -163,7 +163,7 @@ class DelegatedPermissionsClient {
         return challenge;
     }
     async updatePermissionComplete(request, signedChallenge) {
-        const path = (0, url_1.buildPathAndQuery)('/v2/permissions/:permissionId', {
+        const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId', {
             path: request ?? {},
             query: {},
         });

package/generated/permissions/types.d.ts

@@ -6,31 +6,15 @@ export type ArchivePermissionParams = {
 };
 export type ArchivePermissionResponse = {
     id: string;
-    orgId: string;
-    requester: {
-        userId: string;
-        tokenId: string;
-        appId: string;
-    };
-    kind: "Assignment" | "Permission";
-    operationKind: "Create" | "Update" | "Delete";
-    status: "Applied" | "Failed" | "Pending" | "Rejected";
-    entityId: string;
-    dateCreated: Date;
-    dateResolved: Date;
-    body: {
-        id: string;
-        orgId: string;
-        name: string;
-        operations: string[];
-        resourceId?: (string | undefined) | null;
-        status: "Active";
-        predicateIds?: string[] | undefined;
-        isImmutable: boolean;
-        dateCreated?: string | undefined;
-        dateUpdated?: string | undefined;
-        isArchived: boolean;
-    };
+    name: string;
+    operations: string[];
+    resourceId?: (string | undefined) | null;
+    status: "Active";
+    predicateIds?: string[] | undefined;
+    isImmutable: boolean;
+    dateCreated?: string | undefined;
+    dateUpdated?: string | undefined;
+    isArchived: boolean;
 };
 export type ArchivePermissionRequest = ArchivePermissionParams & {
     body: ArchivePermissionBody;
@@ -43,26 +27,11 @@ export type CreateAssignmentParams = {
 };
 export type CreateAssignmentResponse = {
     id: string;
-    orgId: string;
-    requester: {
-        userId: string;
-        tokenId: string;
-        appId: string;
-    };
-    kind: "Assignment" | "Permission";
-    operationKind: "Create" | "Update" | "Delete";
-    status: "Applied" | "Failed" | "Pending" | "Rejected";
-    entityId: string;
-    dateCreated: Date;
-    dateResolved: Date;
-    body: {
-        id: string;
-        permissionId: string;
-        identityId: string;
-        isImmutable: boolean;
-        dateCreated?: string | undefined;
-        dateUpdated?: string | undefined;
-    };
+    permissionId: string;
+    identityId: string;
+    isImmutable: boolean;
+    dateCreated?: string | undefined;
+    dateUpdated?: string | undefined;
 };
 export type CreateAssignmentRequest = CreateAssignmentParams & {
     body: CreateAssignmentBody;
@@ -73,31 +42,15 @@ export type CreatePermissionBody = {
 };
 export type CreatePermissionResponse = {
     id: string;
-    orgId: string;
-    requester: {
-        userId: string;
-        tokenId: string;
-        appId: string;
-    };
-    kind: "Assignment" | "Permission";
-    operationKind: "Create" | "Update" | "Delete";
-    status: "Applied" | "Failed" | "Pending" | "Rejected";
-    entityId: string;
-    dateCreated: Date;
-    dateResolved: Date;
-    body: {
-        id: string;
-        orgId: string;
-        name: string;
-        operations: string[];
-        resourceId?: (string | undefined) | null;
-        status: "Active";
-        predicateIds?: string[] | undefined;
-        isImmutable: boolean;
-        dateCreated?: string | undefined;
-        dateUpdated?: string | undefined;
-        isArchived: boolean;
-    };
+    name: string;
+    operations: string[];
+    resourceId?: (string | undefined) | null;
+    status: "Active";
+    predicateIds?: string[] | undefined;
+    isImmutable: boolean;
+    dateCreated?: string | undefined;
+    dateUpdated?: string | undefined;
+    isArchived: boolean;
 };
 export type CreatePermissionRequest = {
     body: CreatePermissionBody;
@@ -106,36 +59,13 @@ export type DeleteAssignmentParams = {
     permissionId: string;
     assignmentId: string;
 };
-export type DeleteAssignmentResponse = {
-    id: string;
-    orgId: string;
-    requester: {
-        userId: string;
-        tokenId: string;
-        appId: string;
-    };
-    kind: "Assignment" | "Permission";
-    operationKind: "Create" | "Update" | "Delete";
-    status: "Applied" | "Failed" | "Pending" | "Rejected";
-    entityId: string;
-    dateCreated: Date;
-    dateResolved: Date;
-    body: {
-        id: string;
-        permissionId: string;
-        identityId: string;
-        isImmutable: boolean;
-        dateCreated?: string | undefined;
-        dateUpdated?: string | undefined;
-    };
-};
+export type DeleteAssignmentResponse = void | undefined;
 export type DeleteAssignmentRequest = DeleteAssignmentParams;
 export type GetPermissionParams = {
     permissionId: string;
 };
 export type GetPermissionResponse = {
     id: string;
-    orgId: string;
     name: string;
     operations: string[];
     resourceId?: (string | undefined) | null;
@@ -169,7 +99,6 @@ export type ListPermissionsQuery = {
 export type ListPermissionsResponse = {
     items: {
         id: string;
-        orgId: string;
         name: string;
         operations: string[];
         resourceId?: (string | undefined) | null;
@@ -194,31 +123,15 @@ export type UpdatePermissionParams = {
 };
 export type UpdatePermissionResponse = {
     id: string;
-    orgId: string;
-    requester: {
-        userId: string;
-        tokenId: string;
-        appId: string;
-    };
-    kind: "Assignment" | "Permission";
-    operationKind: "Create" | "Update" | "Delete";
-    status: "Applied" | "Failed" | "Pending" | "Rejected";
-    entityId: string;
-    dateCreated: Date;
-    dateResolved: Date;
-    body: {
-        id: string;
-        orgId: string;
-        name: string;
-        operations: string[];
-        resourceId?: (string | undefined) | null;
-        status: "Active";
-        predicateIds?: string[] | undefined;
-        isImmutable: boolean;
-        dateCreated?: string | undefined;
-        dateUpdated?: string | undefined;
-        isArchived: boolean;
-    };
+    name: string;
+    operations: string[];
+    resourceId?: (string | undefined) | null;
+    status: "Active";
+    predicateIds?: string[] | undefined;
+    isImmutable: boolean;
+    dateCreated?: string | undefined;
+    dateUpdated?: string | undefined;
+    isArchived: boolean;
 };
 export type UpdatePermissionRequest = UpdatePermissionParams & {
     body: UpdatePermissionBody;