added external-auths endpoints

LordLingham · Sep 2, 2022 · f1f5089 · f1f5089
1 parent dcf0be8
commit f1f5089
Show file tree

Hide file tree

Showing 15 changed files with 178 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -527,6 +527,8 @@ const client = new PocketBase(
 | 🔐`client.users.create(bodyParams = {}, queryParams = {})`                                                                                                                                         | Creates a new user.                                                                                   |
 | 🔐`client.users.update(id, bodyParams = {}, queryParams = {})`                                                                                                                                     | Updates an existing user by its id.                                                                   |
 | 🔐`client.users.delete(id, queryParams = {})`                                                                                                                                                      | Deletes an existing user by its id.                                                                   |
+| 🔐`client.users.listExternalAuths(id, queryParams = {})`                                                                                                                                           | Lists all linked external auth providers for the specified user.                                      |
+| 🔐`client.users.unlinkExternalAuth(id, provider, queryParams = {})`                                                                                                                                | Unlink a single external auth provider from the specified user.                                       |
 | **[Realtime](https://pocketbase.io/docs/api-realtime)** <br/> _(for node environments you'll have to install an EventSource polyfill beforehand, eg. https://github.com/EventSource/eventsource)_ |                                                                                                       |
 | 🔓`client.realtime.subscribe(subscription, callback)`                                                                                                                                              | Inits the sse connection (if not already) and register the subscription.                              |
 | 🔓`client.realtime.unsubscribe(subscription = "")`                                                                                                                                                 | Unsubscribe from a subscription (if empty - unsubscribe from all registered subscriptions).           |

diff --git a/dist/pocketbase.cjs.d.ts b/dist/pocketbase.cjs.d.ts
@@ -278,6 +278,17 @@ declare class Admins extends CrudService<Admin> {
      */
     confirmPasswordReset(passwordResetToken: string, password: string, passwordConfirm: string, bodyParams?: {}, queryParams?: {}): Promise<AdminAuthResponse>;
 }
+declare class ExternalAuth extends BaseModel {
+    userId: string;
+    provider: string;
+    providerId: string;
+    /**
+     * @inheritdoc
+     */
+    load(data: {
+        [key: string]: any;
+    }): void;
+}
 type UserAuthResponse = {
     [key: string]: any;
     token: string;
@@ -365,6 +376,14 @@ declare class Users extends CrudService<User> {
      * Confirms user new email address.
      */
     confirmEmailChange(emailChangeToken: string, password: string, bodyParams?: {}, queryParams?: {}): Promise<UserAuthResponse>;
+    /**
+     * Lists all linked external auth providers for the specified user.
+     */
+    listExternalAuths(userId: string, queryParams?: {}): Promise<Array<ExternalAuth>>;
+    /**
+     * Unlink a single external auth provider from the specified user.
+     */
+    unlinkExternalAuth(userId: string, provider: string, queryParams?: {}): Promise<boolean>;
 }
 declare class SchemaField {
     id: string;

diff --git a/dist/pocketbase.cjs.js b/dist/pocketbase.cjs.js
diff --git a/dist/pocketbase.es.d.mts b/dist/pocketbase.es.d.mts
@@ -278,6 +278,17 @@ declare class Admins extends CrudService<Admin> {
      */
     confirmPasswordReset(passwordResetToken: string, password: string, passwordConfirm: string, bodyParams?: {}, queryParams?: {}): Promise<AdminAuthResponse>;
 }
+declare class ExternalAuth extends BaseModel {
+    userId: string;
+    provider: string;
+    providerId: string;
+    /**
+     * @inheritdoc
+     */
+    load(data: {
+        [key: string]: any;
+    }): void;
+}
 type UserAuthResponse = {
     [key: string]: any;
     token: string;
@@ -365,6 +376,14 @@ declare class Users extends CrudService<User> {
      * Confirms user new email address.
      */
     confirmEmailChange(emailChangeToken: string, password: string, bodyParams?: {}, queryParams?: {}): Promise<UserAuthResponse>;
+    /**
+     * Lists all linked external auth providers for the specified user.
+     */
+    listExternalAuths(userId: string, queryParams?: {}): Promise<Array<ExternalAuth>>;
+    /**
+     * Unlink a single external auth provider from the specified user.
+     */
+    unlinkExternalAuth(userId: string, provider: string, queryParams?: {}): Promise<boolean>;
 }
 declare class SchemaField {
     id: string;
@@ -745,4 +764,4 @@ declare class LocalAuthStore extends BaseAuthStore {
      */
     private _storageRemove;
 }
-export { Client as default, ClientResponseError, BaseAuthStore, LocalAuthStore, User, Admin, Collection, Record, LogRequest, SchemaField };
+export { Client as default, ClientResponseError, BaseAuthStore, LocalAuthStore, ExternalAuth, User, Admin, Collection, Record, LogRequest, SchemaField };
diff --git a/dist/pocketbase.es.mjs b/dist/pocketbase.es.mjs
diff --git a/dist/pocketbase.es.mjs.map b/dist/pocketbase.es.mjs.map
diff --git a/dist/pocketbase.iife.d.ts b/dist/pocketbase.iife.d.ts
@@ -278,6 +278,17 @@ declare class Admins extends CrudService<Admin> {
      */
     confirmPasswordReset(passwordResetToken: string, password: string, passwordConfirm: string, bodyParams?: {}, queryParams?: {}): Promise<AdminAuthResponse>;
 }
+declare class ExternalAuth extends BaseModel {
+    userId: string;
+    provider: string;
+    providerId: string;
+    /**
+     * @inheritdoc
+     */
+    load(data: {
+        [key: string]: any;
+    }): void;
+}
 type UserAuthResponse = {
     [key: string]: any;
     token: string;
@@ -365,6 +376,14 @@ declare class Users extends CrudService<User> {
      * Confirms user new email address.
      */
     confirmEmailChange(emailChangeToken: string, password: string, bodyParams?: {}, queryParams?: {}): Promise<UserAuthResponse>;
+    /**
+     * Lists all linked external auth providers for the specified user.
+     */
+    listExternalAuths(userId: string, queryParams?: {}): Promise<Array<ExternalAuth>>;
+    /**
+     * Unlink a single external auth provider from the specified user.
+     */
+    unlinkExternalAuth(userId: string, provider: string, queryParams?: {}): Promise<boolean>;
 }
 declare class SchemaField {
     id: string;

diff --git a/dist/pocketbase.iife.js b/dist/pocketbase.iife.js
diff --git a/dist/pocketbase.umd.d.ts b/dist/pocketbase.umd.d.ts
@@ -278,6 +278,17 @@ declare class Admins extends CrudService<Admin> {
      */
     confirmPasswordReset(passwordResetToken: string, password: string, passwordConfirm: string, bodyParams?: {}, queryParams?: {}): Promise<AdminAuthResponse>;
 }
+declare class ExternalAuth extends BaseModel {
+    userId: string;
+    provider: string;
+    providerId: string;
+    /**
+     * @inheritdoc
+     */
+    load(data: {
+        [key: string]: any;
+    }): void;
+}
 type UserAuthResponse = {
     [key: string]: any;
     token: string;
@@ -365,6 +376,14 @@ declare class Users extends CrudService<User> {
      * Confirms user new email address.
      */
     confirmEmailChange(emailChangeToken: string, password: string, bodyParams?: {}, queryParams?: {}): Promise<UserAuthResponse>;
+    /**
+     * Lists all linked external auth providers for the specified user.
+     */
+    listExternalAuths(userId: string, queryParams?: {}): Promise<Array<ExternalAuth>>;
+    /**
+     * Unlink a single external auth provider from the specified user.
+     */
+    unlinkExternalAuth(userId: string, provider: string, queryParams?: {}): Promise<boolean>;
 }
 declare class SchemaField {
     id: string;

diff --git a/dist/pocketbase.umd.js b/dist/pocketbase.umd.js
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-    "version": "0.6.2",
+    "version": "0.7.0",
     "name": "pocketbase",
     "description": "PocketBase JavaScript SDK",
     "author": "Gani Georgiev",

diff --git a/src/index.ts b/src/index.ts
@@ -2,6 +2,7 @@ import Client              from '@/Client';
 import ClientResponseError from '@/ClientResponseError';
 import BaseAuthStore       from '@/stores/BaseAuthStore';
 import LocalAuthStore      from '@/stores/LocalAuthStore';
+import ExternalAuth        from '@/models/ExternalAuth';
 import User                from '@/models/User';
 import Admin               from '@/models/Admin';
 import Collection          from '@/models/Collection';
@@ -13,6 +14,7 @@ export {
     ClientResponseError,
     BaseAuthStore,
     LocalAuthStore,
+    ExternalAuth,
     User,
     Admin,
     Collection,

diff --git a/src/models/ExternalAuth.ts b/src/models/ExternalAuth.ts
@@ -0,0 +1,18 @@
+import BaseModel from '@/models/utils/BaseModel';
+
+export default class ExternalAuth extends BaseModel {
+    userId!:     string;
+    provider!:   string;
+    providerId!: string;
+
+    /**
+     * @inheritdoc
+     */
+    load(data: { [key: string]: any }) {
+        super.load(data);
+
+        this.userId     = typeof data.userId === 'string'     ? data.userId     : '';
+        this.provider   = typeof data.provider === 'string'   ? data.provider   : '';
+        this.providerId = typeof data.providerId === 'string' ? data.providerId : '';
+    }
+}
diff --git a/src/services/Users.ts b/src/services/Users.ts
@@ -1,5 +1,6 @@
-import CrudService from '@/services/utils/CrudService';
-import User        from '@/models/User';
+import CrudService  from '@/services/utils/CrudService';
+import User         from '@/models/User';
+import ExternalAuth from '@/models/ExternalAuth';
 
 export type UserAuthResponse = {
     [key: string]: any,
@@ -266,4 +267,41 @@ export default class Users extends CrudService<User> {
             'body':   bodyParams,
         }).then(this.authResponse.bind(this));
     }
+
+    /**
+     * Lists all linked external auth providers for the specified user.
+     */
+    listExternalAuths(
+        userId: string,
+        queryParams = {}
+    ): Promise<Array<ExternalAuth>> {
+        return this.client.send(this.baseCrudPath() + '/' + encodeURIComponent(userId) + '/external-auths', {
+            'method': 'GET',
+            'params': queryParams,
+        }).then((responseData) => {
+            const items: Array<ExternalAuth> = [];
+
+            if (Array.isArray(responseData)) {
+                for (const item of responseData) {
+                    items.push(new ExternalAuth(item));
+                }
+            }
+
+            return items;
+        });
+    }
+
+    /**
+     * Unlink a single external auth provider from the specified user.
+     */
+    unlinkExternalAuth(
+        userId: string,
+        provider: string,
+        queryParams = {}
+    ): Promise<boolean> {
+        return this.client.send(this.baseCrudPath() + '/' + encodeURIComponent(userId) + '/external-auths/' + encodeURIComponent(provider), {
+            'method': 'DELETE',
+            'params': queryParams,
+        }).then(() => true);
+    }
 }
diff --git a/tests/services/Users.spec.ts b/tests/services/Users.spec.ts
@@ -260,10 +260,42 @@ describe('Users', function() {
                 },
             });
 
-
             const result = await service.confirmEmailChange('test', '1234', { 'b1': 123 }, { 'q1': 456 });
 
             authResponseCheck(result, 'token_email_change_confirm', service.decode({ 'id': 'id_email_change_confirm' }));
         });
     });
+
+    describe('listExternalAuths()', function() {
+        it('Should send a list external auths request', async function() {
+            fetchMock.on({
+                method: 'GET',
+                url: service.client.buildUrl('/api/users/' + encodeURIComponent('@test_id') + '/external-auths') + '?q1=456',
+                replyCode: 200,
+                replyBody: [
+                    { id: '1', provider: 'google' },
+                    { id: '2', provider: 'github' },
+                ],
+            });
+
+            const result = await service.listExternalAuths('@test_id', { 'q1': 456 });
+            assert.equal(result.length, 2);
+            assert.equal(result[0].provider, 'google');
+            assert.equal(result[1].provider, 'github');
+        });
+    });
+
+    describe('unlinkExternalAuth()', function() {
+        it('Should send a unlinkExternalAuth request', async function() {
+            fetchMock.on({
+                method: 'DELETE',
+                url: service.client.buildUrl('/api/users/' + encodeURIComponent("@test_id") + "/external-auths/" + encodeURIComponent("@test_provider")) + '?q1=456',
+                replyCode: 204,
+                replyBody: true,
+            });
+
+            const result = await service.unlinkExternalAuth('@test_id', '@test_provider', { 'q1': 456 });
+            assert.isTrue(result);
+        });
+    });
 });