updated logs and settings services

pocketbase · Aug 21, 2022 · c9cf870 · c9cf870
1 parent c7e6e2f
commit c9cf870
Show file tree

Hide file tree

Showing 14 changed files with 138 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -329,7 +329,7 @@ const client = new PocketBase(
 | 🔐`client.users.delete(id, queryParams = {})`                                                                                                                                                      | Deletes an existing user by its id.                                                                   |
 | **[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).            |
+| 🔓`client.realtime.unsubscribe(subscription = "")`                                                                                                                                                 | Unsubscribe from a subscription (if empty - unsubscribe from all registered subscriptions).           |
 | **[Collections](https://pocketbase.io/docs/api-collections)**                                                                                                                                     |                                                                                                       |
 | 🔐`client.collections.getList(page = 1, perPage = 30, queryParams = {})`                                                                                                                           | Returns paginated collections list.                                                                   |
 | 🔐`client.collections.getFullList(batchSize = 100, queryParams = {})`                                                                                                                              | Returns a list with all collections batch fetched at once.                                            |
@@ -352,6 +352,8 @@ const client = new PocketBase(
 | **[Settings](https://pocketbase.io/docs/api-records)**                                                                                                                                            |                                                                                                       |
 | 🔐`client.settings.getAll(queryParams = {})`                                                                                                                                                       | Fetch all available app settings.                                                                     |
 | 🔐`client.settings.update(bodyParams = {}, queryParams = {})`                                                                                                                                      | Bulk updates app settings.                                                                            |
+| 🔐`client.settings.testS3(queryParams = {})`                                                                                                                                                       | Performs a S3 storage connection test.                                                                |
+| 🔐`client.settings.testEmail(toEmail, emailTemplate, queryParams = {})`                                                                                                                            | Sends a test email.                                                                                   |
 
 
 ## Development

diff --git a/dist/pocketbase.cjs.d.ts b/dist/pocketbase.cjs.d.ts
@@ -115,6 +115,19 @@ declare class Settings extends BaseService {
     update(bodyParams?: {}, queryParams?: {}): Promise<{
         [key: string]: any;
     }>;
+    /**
+     * Performs a S3 storage connection test.
+     */
+    testS3(queryParams?: {}): Promise<boolean>;
+    /**
+     * Sends a test email.
+     *
+     * The possible `emailTemplate` values are:
+     * - verification
+     * - password-reset
+     * - email-change
+     */
+    testEmail(toEmail: string, emailTemplate: string, queryParams?: {}): Promise<boolean>;
 }
 declare class ListResult<M extends BaseModel> {
     page: number;
@@ -424,7 +437,8 @@ declare class LogRequest extends BaseModel {
     method: string;
     status: number;
     auth: string;
-    ip: string;
+    remoteIp: string;
+    userIp: string;
     referer: string;
     userAgent: string;
     meta: null | {

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
@@ -115,6 +115,19 @@ declare class Settings extends BaseService {
     update(bodyParams?: {}, queryParams?: {}): Promise<{
         [key: string]: any;
     }>;
+    /**
+     * Performs a S3 storage connection test.
+     */
+    testS3(queryParams?: {}): Promise<boolean>;
+    /**
+     * Sends a test email.
+     *
+     * The possible `emailTemplate` values are:
+     * - verification
+     * - password-reset
+     * - email-change
+     */
+    testEmail(toEmail: string, emailTemplate: string, queryParams?: {}): Promise<boolean>;
 }
 declare class ListResult<M extends BaseModel> {
     page: number;
@@ -424,7 +437,8 @@ declare class LogRequest extends BaseModel {
     method: string;
     status: number;
     auth: string;
-    ip: string;
+    remoteIp: string;
+    userIp: string;
     referer: string;
     userAgent: string;
     meta: null | {

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
@@ -115,6 +115,19 @@ declare class Settings extends BaseService {
     update(bodyParams?: {}, queryParams?: {}): Promise<{
         [key: string]: any;
     }>;
+    /**
+     * Performs a S3 storage connection test.
+     */
+    testS3(queryParams?: {}): Promise<boolean>;
+    /**
+     * Sends a test email.
+     *
+     * The possible `emailTemplate` values are:
+     * - verification
+     * - password-reset
+     * - email-change
+     */
+    testEmail(toEmail: string, emailTemplate: string, queryParams?: {}): Promise<boolean>;
 }
 declare class ListResult<M extends BaseModel> {
     page: number;
@@ -424,7 +437,8 @@ declare class LogRequest extends BaseModel {
     method: string;
     status: number;
     auth: string;
-    ip: string;
+    remoteIp: string;
+    userIp: string;
     referer: string;
     userAgent: string;
     meta: null | {

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
@@ -115,6 +115,19 @@ declare class Settings extends BaseService {
     update(bodyParams?: {}, queryParams?: {}): Promise<{
         [key: string]: any;
     }>;
+    /**
+     * Performs a S3 storage connection test.
+     */
+    testS3(queryParams?: {}): Promise<boolean>;
+    /**
+     * Sends a test email.
+     *
+     * The possible `emailTemplate` values are:
+     * - verification
+     * - password-reset
+     * - email-change
+     */
+    testEmail(toEmail: string, emailTemplate: string, queryParams?: {}): Promise<boolean>;
 }
 declare class ListResult<M extends BaseModel> {
     page: number;
@@ -424,7 +437,8 @@ declare class LogRequest extends BaseModel {
     method: string;
     status: number;
     auth: string;
-    ip: string;
+    remoteIp: string;
+    userIp: string;
     referer: string;
     userAgent: string;
     meta: null | {

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.4.1",
+    "version": "0.5.0",
     "name": "pocketbase",
     "description": "PocketBase JavaScript SDK",
     "author": "Gani Georgiev",

diff --git a/src/models/LogRequest.ts b/src/models/LogRequest.ts
@@ -5,7 +5,8 @@ export default class LogRequest extends BaseModel {
     method!:    string;
     status!:    number;
     auth!:      string;
-    ip!:        string;
+    remoteIp!:  string;
+    userIp!:    string;
     referer!:   string;
     userAgent!: string;
     meta!:      null|{ [key: string]: any };
@@ -16,11 +17,15 @@ export default class LogRequest extends BaseModel {
     load(data: { [key: string]: any }) {
         super.load(data);
 
+        // fallback to the ip field for backward compatability
+        data.remoteIp = data.remoteIp || data.ip;
+
         this.url       = typeof data.url === 'string' ? data.url : '';
         this.method    = typeof data.method === 'string' ? data.method : 'GET';
         this.status    = typeof data.status === 'number' ? data.status : 200;
         this.auth      = typeof data.auth === 'string' ? data.auth : 'guest';
-        this.ip        = typeof data.ip === 'string' ? data.ip : '';
+        this.remoteIp  = typeof data.remoteIp === 'string' ? data.remoteIp : '';
+        this.userIp    = typeof data.userIp === 'string' ? data.userIp : '';
         this.referer   = typeof data.referer === 'string' ? data.referer : '';
         this.userAgent = typeof data.userAgent === 'string' ? data.userAgent : '';
         this.meta      = typeof data.meta === 'object' && data.meta !== null ? data.meta : {};

diff --git a/src/services/Settings.ts b/src/services/Settings.ts
@@ -21,4 +21,35 @@ export default class Settings extends BaseService {
             'body':   bodyParams,
         }).then((responseData) => responseData || {});
     }
+
+    /**
+     * Performs a S3 storage connection test.
+     */
+    testS3(queryParams = {}): Promise<boolean> {
+        return this.client.send('/api/settings/test/s3', {
+            'method': 'POST',
+            'params': queryParams,
+        }).then(() => true);
+    }
+
+    /**
+     * Sends a test email.
+     *
+     * The possible `emailTemplate` values are:
+     * - verification
+     * - password-reset
+     * - email-change
+     */
+    testEmail(toEmail: string, emailTemplate: string, queryParams = {}): Promise<boolean> {
+        const bodyParams = {
+            'email':    toEmail,
+            'template': emailTemplate,
+        };
+
+        return this.client.send('/api/settings/test/email', {
+            'method': 'POST',
+            'params': queryParams,
+            'body':   bodyParams,
+        }).then(() => true);
+    }
 }
diff --git a/tests/services/Settings.spec.ts b/tests/services/Settings.spec.ts
@@ -50,4 +50,35 @@ describe('Settings', function () {
             assert.deepEqual(result, { 'test': 'abc' });
         });
     });
+
+    describe('testS3()', function () {
+        it('Should send S3 connection test request', async function () {
+            fetchMock.on({
+                method: 'POST',
+                url: service.client.buildUrl('/api/settings/test/s3')+ '?q1=123',
+                replyCode: 204,
+                replyBody: true,
+            });
+
+            const result = await service.testS3({ 'q1': 123 });
+
+            assert.isTrue(result);
+        });
+    });
+
+    describe('testEmail()', function () {
+        it('Should send a test email request', async function () {
+            fetchMock.on({
+                method: 'POST',
+                url: service.client.buildUrl('/api/settings/test/email')+ '?q1=123',
+                body: { 'template': "abc", "email": "[email protected]" },
+                replyCode: 204,
+                replyBody: true,
+            });
+
+            const result = await service.testEmail("[email protected]", "abc", { "q1": 123 });
+
+            assert.isTrue(result);
+        });
+    });
 });