@sonoransoftware/sonoran.js 1.0.34 → 1.0.36

package/dist/managers/CMSManager.d.ts

@@ -15,6 +15,10 @@ export declare class CMSManager extends BaseManager {
     servers: CMSServerManager | undefined;
     constructor(instance: Instance);
     protected buildManager(instance: Instance): Promise<void>;
+    /**
+     * Retrieves the community's CMS subscription version.
+     */
+    getSubscriptionVersion(): Promise<number>;
     /**
      * Verifies the whitelist of a given account with the given parameters to search of said account.
      * @param {Object | string} data The object or [accId | apiId as a string] that contains data to get a community account to verify if it has whitelist to the specified server. *If given as a string it will default to the set or default cms server id (1).
@@ -170,12 +174,86 @@ export declare class CMSManager extends BaseManager {
         discordId?: string;
         uniqueId?: string;
     }): Promise<globalTypes.CMSForceSyncPromiseResult>;
+    /**
+     * Triggers promotion flows for the specified users.
+     */
+    triggerPromotionFlows(flows: globalTypes.CMSTriggerPromotionFlowPayload[]): Promise<globalTypes.CMSTriggerPromotionFlowsPromiseResult>;
+    /**
+     * Retrieves the available promotion flows configured in CMS.
+     */
+    getPromotionFlows(): Promise<globalTypes.CMSGetPromotionFlowsPromiseResult>;
     /**
      * Gets a list of online ERLC players for the given roblox join code.
      * @param {string} robloxJoinCode The roblox join code to get the online players for.
      * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed and the list of online players if successful.
      */
     erlcGetOnlinePlayers(robloxJoinCode: string): Promise<globalTypes.CMSERLCGetOnlinePlayersPromiseResult>;
+    /**
+     * Toggles RSVP for the provided event and account.
+     */
+    rsvp(eventId: string, params?: {
+        apiId?: string;
+        username?: string;
+        accId?: string;
+        discord?: string;
+        uniqueId?: string;
+    }): Promise<globalTypes.CMSRsvpPromiseResult>;
+    /**
+     * Updates the stage of a form for the specified account.
+     */
+    changeFormStage(params: {
+        accId?: string;
+        formId: number;
+        newStageId: string;
+        apiId?: string;
+        username?: string;
+        discord?: string;
+        uniqueId: number;
+    }): Promise<globalTypes.CMSChangeFormStagePromiseResult>;
+    /**
+     * Retrieves submissions for a specific form template.
+     */
+    getFormSubmissions<T = unknown>(templateId: number, options?: {
+        skip?: number;
+        take?: number;
+    }): Promise<globalTypes.CMSGetFormSubmissionsPromiseResult<T>>;
+    /**
+     * Updates profile fields for the specified account.
+     */
+    editAccountProfileFields(params: {
+        apiId?: string;
+        username?: string;
+        accId?: string;
+        discord?: string;
+        uniqueId?: string;
+        profileFields: globalTypes.CMSProfileFieldUpdate[];
+    }): Promise<globalTypes.CMSEditAccountProfileFieldsPromiseResult>;
+    /**
+     * Gets the current clock in entry for a community member.
+     * @param {Object} params Identification parameters for the account.
+     */
+    getCurrentClockIn(params: {
+        accId?: string;
+        apiId?: string;
+        username?: string;
+        discord?: string;
+        uniqueId?: string;
+    }): Promise<globalTypes.CMSGetCurrentClockInPromiseResult>;
+    /**
+     * Retrieves community accounts using optional pagination and status filters.
+     */
+    getAccounts(options?: {
+        skip?: number;
+        take?: number;
+        sysStatus?: boolean;
+        comStatus?: boolean;
+        banned?: boolean;
+        archived?: boolean;
+    }): Promise<globalTypes.CMSGetAccountsPromiseResult>;
+    /**
+     * Retrieves configured profile fields for the community.
+     */
+    getProfileFields(): Promise<globalTypes.CMSGetProfileFieldsPromiseResult>;
     /**
      * Gets the current ERLC player queue count for the provided roblox join code.
      * @param {string} robloxJoinCode The roblox join code to get the player queue size for.

package/dist/managers/CMSManager.js

@@ -41,11 +41,9 @@ class CMSManager extends BaseManager_1.BaseManager {
         this.buildManager(instance);
     }
     async buildManager(instance) {
-        var _a;
         const mutableThis = this;
         try {
-            const versionResp = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_SUB_VERSION'));
-            const version = Number.parseInt(versionResp.replace(/(^\d+)(.+$)/i, '$1'));
+            const version = await this.getSubscriptionVersion();
             if (version >= globalTypes.CMSSubscriptionVersionEnum.STANDARD) {
                 this.servers = new CMSServerManager_1.CMSServerManager(instance, this);
             }
@@ -60,6 +58,15 @@ class CMSManager extends BaseManager_1.BaseManager {
             throw err;
         }
     }
+    /**
+     * Retrieves the community's CMS subscription version.
+     */
+    async getSubscriptionVersion() {
+        var _a;
+        const versionResp = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_SUB_VERSION'));
+        const versionString = String(versionResp);
+        return Number.parseInt(versionString.replace(/(^\d+)(.+$)/i, '$1'), 10);
+    }
     /**
      * Verifies the whitelist of a given account with the given parameters to search of said account.
      * @param {Object | string} data The object or [accId | apiId as a string] that contains data to get a community account to verify if it has whitelist to the specified server. *If given as a string it will default to the set or default cms server id (1).
@@ -373,6 +380,49 @@ class CMSManager extends BaseManager_1.BaseManager {
             }
         });
     }
+    /**
+     * Triggers promotion flows for the specified users.
+     */
+    async triggerPromotionFlows(flows) {
+        if (!Array.isArray(flows) || flows.length === 0) {
+            throw new Error('flows array must include at least one promotion flow payload.');
+        }
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('TRIGGER_PROMOTION_FLOWS', flows));
+                resolve({ success: true, data: response });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
+    /**
+     * Retrieves the available promotion flows configured in CMS.
+     */
+    async getPromotionFlows() {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_PROMOTION_FLOWS'));
+                resolve({ success: true, data: response });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
     /**
      * Gets a list of online ERLC players for the given roblox join code.
      * @param {string} robloxJoinCode The roblox join code to get the online players for.
@@ -395,6 +445,166 @@ class CMSManager extends BaseManager_1.BaseManager {
             }
         });
     }
+    /**
+     * Toggles RSVP for the provided event and account.
+     */
+    async rsvp(eventId, params = {}) {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('RSVP', eventId, params.apiId, params.accId, params.discord, params.uniqueId));
+                if (typeof response === 'string') {
+                    resolve({ success: true, status: response });
+                }
+                else {
+                    resolve({ success: true, data: response });
+                }
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
+    /**
+     * Updates the stage of a form for the specified account.
+     */
+    async changeFormStage(params) {
+        if (!params.formId || !params.newStageId) {
+            throw new Error('formId and newStageId are required to change a form stage.');
+        }
+        if (params.uniqueId === undefined || Number.isNaN(Number(params.uniqueId))) {
+            throw new Error('uniqueId is required to change a form stage.');
+        }
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('CHANGE_FORM_STAGE', params.accId, params.formId, params.newStageId, params.apiId, params.username, params.discord, params.uniqueId));
+                resolve({ success: true, data: response });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
+    /**
+     * Retrieves submissions for a specific form template.
+     */
+    async getFormSubmissions(templateId, options = {}) {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_FORM_TEMPLATE_SUBMISSIONS', templateId, options.skip, options.take));
+                resolve({ success: true, data: response });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
+    /**
+     * Updates profile fields for the specified account.
+     */
+    async editAccountProfileFields(params) {
+        if (!params.profileFields || params.profileFields.length === 0) {
+            throw new Error('profileFields array must include at least one value.');
+        }
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('EDIT_ACC_PROFLIE_FIELDS', params.apiId, params.username, params.accId, params.discord, params.uniqueId, params.profileFields));
+                resolve({ success: true, data: response });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
+    /**
+     * Gets the current clock in entry for a community member.
+     * @param {Object} params Identification parameters for the account.
+     */
+    async getCurrentClockIn(params) {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_CURRENT_CLOCK_IN', params.apiId, params.username, params.accId, params.discord, params.uniqueId));
+                if (typeof response === 'string') {
+                    resolve({ success: true, reason: response, data: null });
+                }
+                else {
+                    resolve({ success: true, data: response });
+                }
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
+    /**
+     * Retrieves community accounts using optional pagination and status filters.
+     */
+    async getAccounts(options = {}) {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_ACCOUNTS', options));
+                resolve({ success: true, data: response });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
+    /**
+     * Retrieves configured profile fields for the community.
+     */
+    async getProfileFields() {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_PROFILE_FIELDS'));
+                resolve({ success: true, data: response });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
     /**
      * Gets the current ERLC player queue count for the provided roblox join code.
      * @param {string} robloxJoinCode The roblox join code to get the player queue size for.

package/dist/managers/CMSServerManager.d.ts

@@ -1,8 +1,16 @@
 import { Instance } from '../instance/Instance';
 import { CMSServerAPIStruct } from '../libs/rest/src';
+import * as globalTypes from '../constants';
 import { CMSServer } from '../structures/CMSServer';
 import { CacheManager } from './CacheManager';
 import { CMSManager } from './CMSManager';
 export declare class CMSServerManager extends CacheManager<number, CMSServer, CMSServerAPIStruct> {
+    private readonly manager;
     constructor(instance: Instance, manager: CMSManager);
+    /**
+     * Retrieves the CMS game servers belonging to the community.
+     */
+    getGameServers(): Promise<CMSServerAPIStruct[]>;
+    private initialize;
+    setGameServers(servers: globalTypes.CMSSetGameServerStruct[]): Promise<globalTypes.CMSSetGameServersPromiseResult>;
 }

package/dist/managers/CMSServerManager.js

@@ -1,34 +1,77 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CMSServerManager = void 0;
+const src_1 = require("../libs/rest/src");
 const CMSServer_1 = require("../structures/CMSServer");
 const CacheManager_1 = require("./CacheManager");
 class CMSServerManager extends CacheManager_1.CacheManager {
     constructor(instance, manager) {
         super(instance, CMSServer_1.CMSServer, []);
-        (async () => {
+        this.manager = manager;
+        void this.initialize();
+    }
+    /**
+     * Retrieves the CMS game servers belonging to the community.
+     */
+    async getGameServers() {
+        var _a;
+        const serversRes = await ((_a = this.manager.rest) === null || _a === void 0 ? void 0 : _a.request('GET_GAME_SERVERS'));
+        const parsed = typeof serversRes === 'string' ? JSON.parse(serversRes) : serversRes;
+        const servers = Array.isArray(parsed === null || parsed === void 0 ? void 0 : parsed.servers) ? parsed.servers : [];
+        return servers;
+    }
+    async initialize() {
+        const managerRef = this.manager;
+        while (!managerRef.ready) {
+            await new Promise((resolve) => {
+                setTimeout(resolve, 100);
+            });
+        }
+        try {
+            const servers = await this.getGameServers();
+            servers.forEach((server) => {
+                const serverStruct = {
+                    id: server.id,
+                    config: server
+                };
+                this._add(serverStruct, true, server.id);
+            });
+            console.log(`Found ${servers.length} servers`);
+        }
+        catch (err) {
+            throw new Error(String(err));
+        }
+    }
+    async setGameServers(servers) {
+        if (!Array.isArray(servers) || servers.length === 0) {
+            throw new Error('servers array must include at least one server configuration.');
+        }
+        return new Promise(async (resolve, reject) => {
             var _a;
-            while (!manager.ready) {
-                await new Promise((resolve) => {
-                    setTimeout(resolve, 100);
-                });
-            }
             try {
-                const serversRes = await ((_a = manager.rest) === null || _a === void 0 ? void 0 : _a.request('GET_GAME_SERVERS'));
-                const servers = serversRes.servers;
-                servers.forEach((server) => {
-                    const serverStruct = {
-                        id: server.id,
-                        config: server
-                    };
-                    this._add(serverStruct, true, server.id);
-                });
-                console.log(`Found ${servers.length} servers`);
+                const response = await ((_a = this.manager.rest) === null || _a === void 0 ? void 0 : _a.request('SET_GAME_SERVERS', servers));
+                const updatedServers = (Array.isArray(response === null || response === void 0 ? void 0 : response.data) ? response.data : []);
+                if (updatedServers.length > 0) {
+                    this.cache.clear();
+                    updatedServers.forEach((server) => {
+                        const serverStruct = {
+                            id: server.id,
+                            config: server
+                        };
+                        this._add(serverStruct, true, server.id);
+                    });
+                }
+                resolve({ success: true, data: updatedServers });
             }
             catch (err) {
-                throw new Error(String(err));
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
             }
-        })();
+        });
     }
 }
 exports.CMSServerManager = CMSServerManager;

package/dist/managers/RadioManager.d.ts

@@ -0,0 +1,55 @@
+import { Instance } from '../instance/Instance';
+import { REST } from '../libs/rest/src';
+import { BaseManager } from './BaseManager';
+import * as globalTypes from '../constants';
+/**
+ * Manages all Sonoran Radio API interactions.
+ */
+export declare class RadioManager extends BaseManager {
+    readonly ready: boolean;
+    readonly failReason: unknown;
+    rest: REST | undefined;
+    constructor(instance: Instance);
+    protected buildManager(instance: Instance): Promise<void>;
+    /**
+     * Retrieves the configured community channel groups and channels.
+     */
+    getCommunityChannels(): Promise<globalTypes.RadioGetCommunityChannelsPromiseResult>;
+    /**
+     * Retrieves all connected users for the community.
+     */
+    getConnectedUsers(): Promise<globalTypes.RadioGetConnectedUsersPromiseResult>;
+    /**
+     * Retrieves a specific connected user by room id and identity.
+     * @param {number} roomId Multi-server room id.
+     * @param {string} identity User account UUID.
+     */
+    getConnectedUser(roomId: number, identity: string): Promise<globalTypes.RadioGetConnectedUserPromiseResult>;
+    /**
+     * Updates a user's transmit and scanned channel configuration.
+     * @param {string} identity The user's UUID.
+     * @param {RadioSetUserChannelsOptions} options Transmit and scan channel configuration.
+     */
+    setUserChannels(identity: string, options?: globalTypes.RadioSetUserChannelsOptions): Promise<globalTypes.RadioSetUserChannelsPromiseResult>;
+    /**
+     * Updates a user's display name.
+     * @param {string} accId The user's account UUID.
+     * @param {string} displayName The new display name.
+     */
+    setUserDisplayName(accId: string, displayName: string): Promise<globalTypes.RadioSetUserDisplayNamePromiseResult>;
+    /**
+     * Retrieves the community subscription level determined by the calling server's IP.
+     */
+    getServerSubscriptionFromIp(): Promise<globalTypes.RadioGetServerSubscriptionFromIpPromiseResult>;
+    /**
+     * Sets the push event URL for the community.
+     * @param {string} pushUrl The server push URL.
+     */
+    setServerIp(pushUrl: string): Promise<globalTypes.RadioSetServerIpPromiseResult>;
+    /**
+     * Sets the available in-game speaker locations for tone dispatching.
+     * @param {RadioSpeakerLocation[]} locations Collection of speaker locations.
+     * @param {string} [token] Optional bearer token for authorization. Defaults to the community API key.
+     */
+    setInGameSpeakerLocations(locations: globalTypes.RadioSpeakerLocation[], token?: string): Promise<globalTypes.RadioSetInGameSpeakerLocationsPromiseResult>;
+}