skapi-js 1.0.19 → 1.0.21

package/js/main/skapi.d.ts

@@ -40,18 +40,25 @@ export default class Skapi {
     connectRealtime(cb: (rt: {
         status: 'message' | 'error' | 'success' | 'close' | 'notice';
         message: any;
-    }) => Promise<void>): any;
+        sender?: string;
+    }) => Promise<WebSocket>): any;
     closeRealtime(): Promise<void>;
     getRealtimeUsers(params: {
         group: string;
         user_id?: string;
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<string[]>>;
+    getRealtimeGroups(params?: {
+        searchFor: 'group' | 'number_of_users';
+        value: string | number;
+        condition?: '>' | '>=' | '=' | '<' | '<=' | '!=' | 'gt' | 'gte' | 'eq' | 'lt' | 'lte' | 'ne';
+        range?: string | number;
+    } | null, fetchOptions?: FetchOptions): Promise<DatabaseResponse<{
+        group: string;
+        number_of_users: number;
+    }>>;
     postRealtime(message: any, recipient: string): Promise<{
         status: 'success';
         message: 'Message sent.';
-    } | {
-        status: 'error';
-        message: 'Realtime connection is not open.';
     }>;
     joinRealtime(params: {
         group: string | null;

package/js/main/skapi.js

@@ -7,7 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import SkapiError from './error';
 import validator from '../utils/validator';
 import { getRecords, postRecord, deleteRecords, getTables, getIndexes, getTags, uploadFiles, getFile, grantPrivateRecordAccess, removePrivateRecordAccess, listPrivateRecordAccess, requestPrivateRecordAccessKey, deleteFiles, normalizeRecord } from '../methods/database';
-import { connectRealtime, joinRealtime, postRealtime, closeRealtime, getRealtimeUsers } from '../methods/realtime';
+import { connectRealtime, joinRealtime, postRealtime, closeRealtime, getRealtimeUsers, getRealtimeGroups } from '../methods/realtime';
 import { request, secureRequest, mock, getFormResponse, formHandler, getConnection } from '../methods/request';
 import { subscribe, unsubscribe, blockSubscriber, unblockSubscriber, getSubscriptions, subscribeNewsletter, getNewsletters, unsubscribeNewsletter, getNewsletterSubscription } from '../methods/subscription';
 import { checkAdmin, getProfile, logout, recoverAccount, resendSignupConfirmation, authentication, login, signup, disableAccount, resetPassword, verifyEmail, verifyPhoneNumber, forgotPassword, changePassword, updateProfile, getUsers, setUserPool, userPool, lastVerifiedEmail, requestUsernameChange } from '../methods/user';
@@ -23,7 +23,7 @@ export default class Skapi {
     set user(value) {
     }
     constructor(service, owner, options) {
-        this.version = '1.0.19';
+        this.version = '1.0.21';
         this.session = null;
         this.connection = null;
         this.host = 'skapi';
@@ -200,6 +200,9 @@ export default class Skapi {
     getRealtimeUsers(params, fetchOptions) {
         return getRealtimeUsers.bind(this)(params, fetchOptions);
     }
+    getRealtimeGroups(params, fetchOptions) {
+        return getRealtimeGroups.bind(this)(params, fetchOptions);
+    }
     postRealtime(message, recipient) {
         return postRealtime.bind(this)(message, recipient);
     }
@@ -308,6 +311,9 @@ export default class Skapi {
 __decorate([
     formHandler()
 ], Skapi.prototype, "getRealtimeUsers", null);
+__decorate([
+    formHandler()
+], Skapi.prototype, "getRealtimeGroups", null);
 __decorate([
     formHandler()
 ], Skapi.prototype, "postRealtime", null);

package/js/methods/realtime.d.ts

@@ -1,18 +1,14 @@
 import { DatabaseResponse, FetchOptions } from '../Types';
-type RealTimeCallback = (rt: {
+type RealtimeCallback = (rt: {
     status: 'message' | 'error' | 'success' | 'close' | 'notice';
-    message: string | {
-        [key: string]: any;
-    };
+    message: any;
+    sender?: string;
 }) => void;
 export declare function closeRealtime(): Promise<void>;
-export declare function connectRealtime(cb: RealTimeCallback, delay?: number): Promise<void>;
+export declare function connectRealtime(cb: RealtimeCallback, delay?: number): Promise<WebSocket>;
 export declare function postRealtime(message: any, recipient: string): Promise<{
     status: 'success';
     message: 'Message sent.';
-} | {
-    status: 'error';
-    message: 'Realtime connection is not open.';
 }>;
 export declare function joinRealtime(params: {
     group?: string | null;
@@ -24,4 +20,13 @@ export declare function getRealtimeUsers(params: {
     group: string;
     user_id?: string;
 }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<string[]>>;
+export declare function getRealtimeGroups(params?: {
+    searchFor: 'group' | 'number_of_users';
+    value?: string | number;
+    condition?: '>' | '>=' | '=' | '<' | '<=' | '!=' | 'gt' | 'gte' | 'eq' | 'lt' | 'lte' | 'ne';
+    range?: string | number;
+} | null, fetchOptions?: FetchOptions): Promise<DatabaseResponse<{
+    group: string;
+    number_of_users: number;
+}>>;
 export {};

package/js/methods/realtime.js

@@ -43,12 +43,14 @@ export function connectRealtime(cb, delay = 0) {
                 };
                 socket.onmessage = event => {
                     let data = JSON.parse(decodeURI(event.data));
-                    if (data?.['#notice']) {
-                        cb({ status: 'notice', message: data['#notice'] });
+                    let ret = { status: 'message', message: data?.['#message'] || null };
+                    if (data?.['#user_id']) {
+                        ret.sender = data['#user_id'];
                     }
-                    else {
-                        cb({ status: 'message', message: data });
+                    if (data?.['#notice']) {
+                        Object.assign(ret, { status: 'notice', message: data['#notice'] });
                     }
+                    cb(ret);
                 };
                 socket.onclose = event => {
                     if (event.wasClean) {
@@ -113,7 +115,7 @@ export async function postRealtime(message, recipient) {
         }
         return { status: 'success', message: 'Message sent.' };
     }
-    return { status: 'error', message: 'Realtime connection is not open.' };
+    throw new SkapiError('Realtime connection is not open. Try reconnecting with connectRealtime().', { code: 'INVALID_REQUEST' });
 }
 export async function joinRealtime(params) {
     let socket = this.__socket ? await this.__socket : this.__socket;
@@ -157,3 +159,52 @@ export async function getRealtimeUsers(params, fetchOptions) {
     }
     return res;
 }
+export async function getRealtimeGroups(params, fetchOptions) {
+    await this.__connection;
+    if (!params) {
+        params = { searchFor: 'group' };
+    }
+    params = validator.Params(params, {
+        searchFor: ['group', 'number_of_users', () => 'group'],
+        value: ['string', 'number', () => {
+                if (params?.searchFor && params?.searchFor === 'number_of_users') {
+                    return 0;
+                }
+                return ' ';
+            }],
+        condition: ['>', '>=', '=', '<', '<=', '!=', 'gt', 'gte', 'eq', 'lt', 'lte', 'ne'],
+        range: ['string', 'number']
+    });
+    if (!params.condition) {
+        if (params.value === ' ' || !params.value) {
+            params.condition = '>';
+        }
+        else {
+            params.condition = '=';
+        }
+    }
+    if (params.range && params.condition) {
+        delete params.condition;
+    }
+    if (params.searchFor === 'number_of_users' && typeof params.value !== 'number') {
+        throw new SkapiError(`"value" must be a number.`, { code: 'INVALID_PARAMETER' });
+    }
+    if (params.searchFor === 'group' && typeof params.value !== 'string') {
+        throw new SkapiError(`"value" must be a string.`, { code: 'INVALID_PARAMETER' });
+    }
+    if (params.hasOwnProperty('range') && typeof params.range !== typeof params.value) {
+        throw new SkapiError(`"range" must be a ${typeof params.value}.`, { code: 'INVALID_PARAMETER' });
+    }
+    let res = await request.bind(this)('get-ws-group', params, {
+        fetchOptions,
+        auth: true,
+        method: 'post'
+    });
+    res.list = res.list.map((v) => {
+        return {
+            group: v.rid.split('#')[1],
+            number_of_users: v.cnt
+        };
+    });
+    return res;
+}

package/js/methods/request.js

@@ -50,9 +50,6 @@ export async function request(url, data = null, options) {
             switch (dest) {
                 case 'get-newsletters':
                 case 'get-public-newsletters':
-                case 'delete-newsletter':
-                case 'block-account':
-                case 'register-service':
                 case 'get-users':
                 case 'post-userdata':
                 case 'remove-account':
@@ -63,18 +60,11 @@ export async function request(url, data = null, options) {
                 case 'confirm-signup':
                 case 'recover-account':
                 case 'mock':
-                case 'get-services':
                 case 'service':
                 case 'grant-access':
                 case 'last-verified-email':
                 case 'get-newsletter-subscription':
                 case 'request-username-change':
-                case 'register-subdomain':
-                case 'list-host-directory':
-                case 'refresh-cdn':
-                case 'request-newsletter-sender':
-                case 'set-404':
-                case 'subdomain-info':
                     return {
                         public: admin.admin_public,
                         private: admin.admin_private
@@ -87,7 +77,6 @@ export async function request(url, data = null, options) {
                 case 'get-table':
                 case 'get-tag':
                 case 'get-index':
-                case 'storage-info':
                 case 'get-signed-url':
                 case 'grant-private-access':
                 case 'request-private-access-key':

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skapi-js",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "description": "Javascript library for Skapi: Complete JAM Stack, front-end driven serverless backend API service.",
   "main": "./dist/skapi.module.js",
   "types": "./js/Main.d.ts",