@excali-boards/boards-api-client 1.1.1-dev.6 → 1.1.1-dev.7

package/dist/classes/invites.d.ts

@@ -1,18 +1,35 @@
+import { BulkViewPermissionsQuery, ViewPermissionsQuery } from './permissions';
 import { BoardRole, CategoryRole, GroupRole } from '../external/vars';
 import { GrantedRoles } from '../external/types';
+import { Invite } from '../../prisma/generated';
 import { BoardsManager } from '../core/manager';
 export declare class APIInvites {
     private web;
     constructor(web: BoardsManager);
-    getInvites({ auth }: InvitesFunctionsInput['getInvites']): Promise<import("..").WebResponse<GetInvitesOutput>>;
+    getUserInvites({ auth }: InvitesFunctionsInput['getUserInvites']): Promise<import("..").WebResponse<GetUserInvitesOutput>>;
+    getResourceInvites({ auth, query }: InvitesFunctionsInput['getResourceInvites']): Promise<import("..").WebResponse<GetResourceInvitesOutput>>;
+    bulkGetResourceInvites({ auth, query }: InvitesFunctionsInput['bulkGetResourceInvites']): Promise<import("..").WebResponse<GetResourceInvitesOutput>>;
+    getInviteDetails({ auth, code }: InvitesFunctionsInput['getInviteDetails']): Promise<import("..").WebResponse<InviteDetails>>;
     createInvite({ auth, body }: InvitesFunctionsInput['createInvite']): Promise<import("..").WebResponse<CreateInviteOutput>>;
     useInvite({ auth, code }: InvitesFunctionsInput['useInvite']): Promise<import("..").WebResponse<UseInviteOutput>>;
     revokeInvite({ auth, code }: InvitesFunctionsInput['revokeInvite']): Promise<import("..").WebResponse<string>>;
 }
 export type InvitesFunctionsInput = {
-    'getInvites': {
+    'getUserInvites': {
         auth: string;
     };
+    'getResourceInvites': {
+        auth: string;
+        query: ViewPermissionsQuery;
+    };
+    'bulkGetResourceInvites': {
+        auth: string;
+        query: BulkViewPermissionsQuery;
+    };
+    'getInviteDetails': {
+        auth: string;
+        code: string;
+    };
     'createInvite': {
         auth: string;
         body: CreateInviteInput;
@@ -41,21 +58,8 @@ export type CreateInviteOutput = {
     expiresAt: string;
     maxUses: number;
 };
-export type GetInvitesOutput = {
-    dbId: string;
-    code: string;
-    createdBy: string;
-    expiresAt: string | null;
-    maxUses: number | null;
-    currentUses: number;
-    groupIds: string[];
-    categoryIds: string[];
-    boardIds: string[];
-    groupRole: GroupRole | null;
-    categoryRole: CategoryRole | null;
-    boardRole: BoardRole | null;
-    createdAt: string;
-}[];
+export type GetUserInvitesOutput = Invite[];
+export type GetResourceInvitesOutput = InviteData[];
 export type UseInviteOutput = {
     granted: GrantedRoles;
     details: {
@@ -75,3 +79,20 @@ export type UseInviteOutput = {
         }[];
     };
 };
+export type InviteDetails = Pick<Invite, 'code' | 'expiresAt' | 'maxUses' | 'currentUses'>;
+export type InviteData = Pick<Invite, 'code' | 'expiresAt' | 'maxUses' | 'currentUses' | 'boardRole' | 'categoryRole' | 'groupRole'> & {
+    groups: {
+        groupId: string;
+        name: string;
+    }[];
+    categories: {
+        categoryId: string;
+        name: string;
+        groupId: string;
+    }[];
+    boards: {
+        boardId: string;
+        name: string;
+        categoryId: string;
+    }[];
+};

package/dist/classes/invites.js

@@ -8,12 +8,30 @@ class APIInvites {
         this.web = web;
     }
     // Methods.
-    async getInvites({ auth }) {
+    async getUserInvites({ auth }) {
         return await this.web.request({
             method: 'GET', auth,
             endpoint: this.web.qp('/invites'),
         });
     }
+    async getResourceInvites({ auth, query }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp('/invites/view', query),
+        });
+    }
+    async bulkGetResourceInvites({ auth, query }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp('/invites/view-bulk', query),
+        });
+    }
+    async getInviteDetails({ auth, code }) {
+        return await this.web.request({
+            method: 'GET', auth,
+            endpoint: this.web.qp(`/invites/${code}`),
+        });
+    }
     async createInvite({ auth, body }) {
         return await this.web.request({
             method: 'POST', auth, body,

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.1.1-dev.6",
+	"version": "1.1.1-dev.7",
 	"name": "@excali-boards/boards-api-client",
 	"description": "A simple API client for the Boards API.",
 	"repository": "https://github.com/Excali-Boards/boards-api-client",