@sonoransoftware/sonoran.js 1.0.34 → 1.0.36

package/.github/workflows/auto-pr-on-branch-push.yml

@@ -0,0 +1,89 @@
+name: Auto PR for new branch (trigger Codex)
+
+on:
+  push:
+    branches:
+      - 'feat/**'
+      - 'fix/**'
+      - 'tweak/**'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  ensure-pr:
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      BRANCH: ${{ github.ref_name }}
+    steps:
+      - uses: actions/checkout@v4
+        with: { fetch-depth: 0 }
+
+      - name: Auth gh
+        run: gh auth status || true
+
+      - name: Ensure PR exists
+        id: pr
+        run: |
+          PR_NUMBER=$(gh pr list --head "$BRANCH" --state open --json number --jq '.[0].number')
+          if [ -n "$PR_NUMBER" ]; then
+            echo "PR exists: #$PR_NUMBER"
+            echo "number=$PR_NUMBER" >> "$GITHUB_OUTPUT"
+            echo "created=false" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          TITLE="Auto Review: $BRANCH"
+          BODY_FILE="$(mktemp)"
+          {
+            echo "Auto-created to trigger Codex code review for branch **$BRANCH** targeting \`staging\`."
+            echo
+            echo "Codex instructions: .github/codex_instructions.md"
+          } > "$BODY_FILE"
+
+          gh pr create \
+            --head "$BRANCH" \
+            --base "staging" \
+            --title "$TITLE" \
+            --body-file "$BODY_FILE" \
+            --draft
+          PR_NUMBER=$(gh pr list --head "$BRANCH" --state open --json number --jq '.[0].number')
+          if [ -z "$PR_NUMBER" ]; then
+            echo "Failed to determine PR number after creation" >&2
+            exit 1
+          fi
+          echo "number=$PR_NUMBER" >> "$GITHUB_OUTPUT"
+          echo "created=true" >> "$GITHUB_OUTPUT"
+
+      - name: Ensure auto-review label exists
+        if: steps.pr.outputs.number
+        run: |
+          if ! gh label list --json name --limit 100 | jq -e '.[] | select(.name == "auto-review")' > /dev/null; then
+            gh label create "auto-review" --color "0E8A16" --description "PRs ready for Codex auto review"
+          fi
+
+      - name: Label PR (optional)
+        if: steps.pr.outputs.number
+        run: |
+          gh pr edit "${{ steps.pr.outputs.number }}" --add-label "auto-review"
+
+      - name: Mark PR ready for review
+        if: steps.pr.outputs.created == 'true'
+        run: gh pr ready "${{ steps.pr.outputs.number }}"
+
+      - name: Trigger initial Codex review
+        if: steps.pr.outputs.created == 'true'
+        env:
+          PR: ${{ steps.pr.outputs.number }}
+          GH_TOKEN: ${{ secrets.CODEX_TRIGGER_TOKEN }}
+        run: |
+          TMP=$(mktemp)
+          {
+            echo "@codex review"
+            echo
+            echo "instructions: .github/codex_instructions.md"
+          } > "$TMP"
+
+          gh pr comment "$PR" --body-file "$TMP"

package/.github/workflows/codex_instructions.md

@@ -0,0 +1,24 @@
+# Codex Review Instructions
+
+## Context
+- Branch naming: feat/*, fix/*, tweak/*
+- Target: merge to `staging` after preview validation
+
+## What to prioritize
+1. Security pitfalls (injection, authz, secret handling)
+2. Reliability & edge cases
+3. Breaking changes / migration notes
+4. Performance hotspots (N+1, O(n^2), heavy I/O)
+5. Code style & maintainability (prefer actionable diffs)
+6. Any new English words, phrases, or sentences should be added as an i18n key
+
+## Project-specific rules
+- Backend: Prefer async handlers for network I/O.
+- Frontend: Avoid blocking renders; use Suspense on data boundaries.
+- Infra: Terraform modules must be idempotent and tagged.
+
+## Test expectations
+- New endpoints/components: at least 1 direct test.
+- Bug fixes: a regression test.
+
+> If you recommend changes, include concrete diffs.

package/.github/workflows/push-pr-nudge-codex.yml

@@ -0,0 +1,50 @@
+name: Nudge Codex on push
+
+on:
+  push:
+    branches:
+      - 'feat/**'
+      - 'fix/**'
+      - 'tweak/**'
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  nudge:
+    if: ${{ !github.event.created }}
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      BRANCH: ${{ github.ref_name }}
+    steps:
+      - uses: actions/checkout@v4
+        with: { fetch-depth: 0 }
+
+      - name: Auth gh
+        run: gh auth status || true
+
+      - name: Find PR for this branch
+        id: pr
+        run: |
+          PR_NUMBER=$(gh pr list --head "$BRANCH" --state open --json number --jq '.[0].number')
+          if [ -z "$PR_NUMBER" ]; then
+            echo "No open PR for $BRANCH"; exit 0
+          fi
+          echo "pr=$PR_NUMBER" >> "$GITHUB_OUTPUT"
+
+      - name: Post Codex trigger comment with instructions
+        if: steps.pr.outputs.pr
+        env:
+          PR: ${{ steps.pr.outputs.pr }}
+          GH_TOKEN: ${{ secrets.CODEX_TRIGGER_TOKEN }}
+        run: |
+          TMP=$(mktemp)
+          {
+            echo "@codex review"
+            echo
+            echo "instructions: .github/codex_instructions.md"
+          } > "$TMP"
+
+          gh pr comment "$PR" --body-file "$TMP"

package/dist/constants.d.ts

@@ -5,7 +5,8 @@ import { CADActiveUnitsManager } from './managers/CADActiveUnitsManager';
 import { CADActiveUnit } from './structures/CADActiveUnit';
 export declare enum productEnums {
     CAD = 0,
-    CMS = 1
+    CMS = 1,
+    RADIO = 2
 }
 export interface CADNewDispatchBuilderOptions {
     serverId?: number;
@@ -231,6 +232,32 @@ export interface CMSSetAccountNamePromiseResult {
     data?: string;
     reason?: string;
 }
+export interface CADSetClockTimePromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: unknown;
+}
+export interface CADJoinCommunityPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: unknown;
+}
+export interface CADLeaveCommunityPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: unknown;
+}
+export interface CADStandardResponse<T = unknown> {
+    success: boolean;
+    data?: T;
+    reason?: unknown;
+}
+export interface CMSProfileField {
+    id: string;
+    type: string;
+    label: string;
+    options: unknown;
+}
 export interface CMSKickAccountPromiseResult {
     success: boolean;
     reason?: string;
@@ -243,6 +270,110 @@ export interface CMSForceSyncPromiseResult {
     success: boolean;
     reason?: string;
 }
+export interface CMSGetCurrentClockInPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: clockInOutRequest | null;
+}
+export interface CMSAccountSummary {
+    accId: string;
+    accName: string;
+    activeApiIds: string[];
+    discordId?: string;
+    sysStatus: boolean;
+    comStatus: boolean;
+    archived: boolean;
+    banned: boolean;
+    [key: string]: unknown;
+}
+export interface CMSAccountsPage {
+    total: number;
+    skip: number;
+    take: number;
+    accounts: CMSAccountSummary[];
+}
+export interface CMSGetAccountsPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: CMSAccountsPage;
+}
+export interface CMSGetProfileFieldsPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: CMSProfileField[];
+}
+export interface CMSProfileFieldUpdate {
+    id: string;
+    value: unknown;
+}
+export interface CMSEditAccountProfileFieldsPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: CMSProfileFieldUpdate[];
+}
+export interface CMSRsvpPromiseResult {
+    success: boolean;
+    reason?: string;
+    status?: string;
+    data?: unknown;
+}
+export interface CMSChangeFormStagePromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: unknown;
+}
+export interface CMSSetGameServerStruct {
+    id?: number;
+    name: string;
+    description?: string;
+    ip?: string;
+    port?: string;
+    allowedRanks?: string[];
+    blockedRanks?: string[];
+    [key: string]: unknown;
+}
+export interface CMSSetGameServersPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: CMSSetGameServerStruct[];
+}
+export interface CMSExecuteRankPromotionResult {
+    users: string[];
+    flow: string;
+    promote: boolean;
+    succeeded: boolean;
+    message?: string;
+}
+export interface CMSTriggerPromotionFlowPayload {
+    userId: string;
+    flowId: string;
+    users: string[];
+    promote: boolean;
+}
+export interface CMSPromotionFlow {
+    id: string;
+    communityUuid: string;
+    labelFrom: string;
+    labelTo: string;
+    ranksToAdd: string[];
+    ranksToRemove: string[];
+    actions: unknown[];
+}
+export interface CMSTriggerPromotionFlowsPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: CMSExecuteRankPromotionResult[];
+}
+export interface CMSGetPromotionFlowsPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: CMSPromotionFlow[];
+}
+export interface CMSGetFormSubmissionsPromiseResult<T = unknown> {
+    success: boolean;
+    reason?: string;
+    data?: T[];
+}
 export interface CMSERLCGetOnlinePlayersPromiseResult {
     success: boolean;
     reason?: string;
@@ -263,3 +394,113 @@ export interface CMSERLCAddNewRecordPromiseResult {
     reason?: string;
     logId?: string;
 }
+export interface RadioChannelGroup {
+    id: number;
+    name: string;
+    orderIndex: number;
+}
+export interface RadioChannel {
+    id: number;
+    groupId: number;
+    displayName: string;
+    recvFreqMajor: number;
+    recvFreqMinor: number;
+    xmitFreqMajor: number;
+    xmitFreqMinor: number;
+    repeatsXmit: boolean;
+    status: boolean;
+    orderIndex: number;
+    talkoverProtection: boolean;
+    [key: string]: unknown;
+}
+export interface RadioConnectedUserMetadataScanList {
+    id: number;
+    name: string;
+    channelIds: number[];
+    [key: string]: unknown;
+}
+export interface RadioConnectedUserMetadataState {
+    primaryChId?: number;
+    scannedChIds?: number[];
+    scanLists?: RadioConnectedUserMetadataScanList[];
+    spec?: number;
+    [key: string]: unknown;
+}
+export interface RadioConnectedUserMetadata {
+    sonrad?: boolean;
+    state?: RadioConnectedUserMetadataState;
+    [key: string]: unknown;
+}
+export interface RadioConnectedUser {
+    identity: string;
+    name: string;
+    roomId?: number;
+    metadata: RadioConnectedUserMetadata;
+    [key: string]: unknown;
+}
+export interface RadioSpeakerLocation {
+    label: string;
+    id: string;
+}
+export interface RadioSetUserChannelsOptions {
+    transmit?: number;
+    scan?: number[];
+}
+export type RadioSubscriptionLevel = 0 | 1 | 2;
+export interface RadioGetCommunityChannelsPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: {
+        result: string;
+        groups: RadioChannelGroup[];
+        channels: RadioChannel[];
+        [key: string]: unknown;
+    };
+}
+export interface RadioGetConnectedUsersPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: {
+        result: string;
+        connectedUsers: RadioConnectedUser[];
+        [key: string]: unknown;
+    };
+}
+export interface RadioGetConnectedUserPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: {
+        result: string;
+        data: RadioConnectedUser;
+        [key: string]: unknown;
+    };
+}
+export interface RadioSetUserChannelsPromiseResult {
+    success: boolean;
+    reason?: string;
+    result?: string;
+}
+export interface RadioSetUserDisplayNamePromiseResult {
+    success: boolean;
+    reason?: string;
+    result?: string;
+}
+export interface RadioGetServerSubscriptionFromIpPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: {
+        result: string;
+        subscription: RadioSubscriptionLevel;
+        [key: string]: unknown;
+    };
+}
+export interface RadioSetServerIpPromiseResult {
+    success: boolean;
+    reason?: string;
+    result?: string;
+}
+export interface RadioSetInGameSpeakerLocationsPromiseResult {
+    success: boolean;
+    reason?: string;
+    result?: string;
+}

package/dist/constants.js

@@ -5,6 +5,7 @@ var productEnums;
 (function (productEnums) {
     productEnums[productEnums["CAD"] = 0] = "CAD";
     productEnums[productEnums["CMS"] = 1] = "CMS";
+    productEnums[productEnums["RADIO"] = 2] = "RADIO";
 })(productEnums = exports.productEnums || (exports.productEnums = {}));
 var CADSubscriptionVersionEnum;
 (function (CADSubscriptionVersionEnum) {

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from './instance/Instance';
 export * from './builders';
 export * from './libs/rest/src';
-export { productEnums, CADNewDispatchBuilderOptions, CADSubscriptionVersionEnum, CMSSubscriptionVersionEnum } from './constants';
+export { productEnums, CADNewDispatchBuilderOptions, CADSubscriptionVersionEnum, CMSSubscriptionVersionEnum, RadioSubscriptionLevel, RadioSetUserChannelsOptions, RadioChannel, RadioChannelGroup, RadioConnectedUser, RadioSpeakerLocation, RadioGetCommunityChannelsPromiseResult, RadioGetConnectedUsersPromiseResult, RadioGetConnectedUserPromiseResult, RadioSetUserChannelsPromiseResult, RadioSetUserDisplayNamePromiseResult, RadioGetServerSubscriptionFromIpPromiseResult, RadioSetServerIpPromiseResult, RadioSetInGameSpeakerLocationsPromiseResult, CADSetClockTimePromiseResult, CADJoinCommunityPromiseResult, CADLeaveCommunityPromiseResult, CADStandardResponse, CMSProfileField, CMSGetCurrentClockInPromiseResult, CMSAccountsPage, CMSAccountSummary, CMSGetAccountsPromiseResult, CMSGetProfileFieldsPromiseResult, CMSProfileFieldUpdate, CMSEditAccountProfileFieldsPromiseResult, CMSRsvpPromiseResult, CMSChangeFormStagePromiseResult, CMSSetGameServerStruct, CMSSetGameServersPromiseResult, CMSExecuteRankPromotionResult, CMSTriggerPromotionFlowPayload, CMSPromotionFlow, CMSTriggerPromotionFlowsPromiseResult, CMSGetPromotionFlowsPromiseResult, CMSGetFormSubmissionsPromiseResult } from './constants';

package/dist/instance/Instance.d.ts

@@ -3,6 +3,7 @@ import EventEmitter from 'events';
 import * as InstanceTypes from './instance.types';
 import { CADManager } from '../managers/CADManager';
 import { CMSManager } from '../managers/CMSManager';
+import { RadioManager } from '../managers/RadioManager';
 export declare class Instance extends EventEmitter {
     cadCommunityId: string | undefined;
     cadApiKey: string | undefined;
@@ -14,8 +15,13 @@ export declare class Instance extends EventEmitter {
     cmsApiUrl: string;
     cmsDefaultServerId: number;
     isCMSSuccessful: boolean;
+    radioCommunityId: string | undefined;
+    radioApiKey: string | undefined;
+    radioApiUrl: string;
+    isRadioSuccessful: boolean;
     cad: CADManager | undefined;
     cms: CMSManager | undefined;
+    radio: RadioManager | undefined;
     debug: boolean;
     apiHeaders: HeadersInit;
     constructor(options: InstanceTypes.InstanceOptions);

package/dist/instance/Instance.js

@@ -31,6 +31,7 @@ const events_1 = __importDefault(require("events"));
 const globalTypes = __importStar(require("../constants"));
 const CADManager_1 = require("../managers/CADManager");
 const CMSManager_1 = require("../managers/CMSManager");
+const RadioManager_1 = require("../managers/RadioManager");
 const utils_1 = require("../utils");
 class Instance extends events_1.default {
     constructor(options) {
@@ -41,6 +42,8 @@ class Instance extends events_1.default {
         this.cmsApiUrl = 'https://api.sonorancms.com';
         this.cmsDefaultServerId = 1;
         this.isCMSSuccessful = false;
+        this.radioApiUrl = 'https://api.sonoranradio.com';
+        this.isRadioSuccessful = false;
         this.debug = false;
         this.apiHeaders = {};
         if (options.debug) {
@@ -81,6 +84,17 @@ class Instance extends events_1.default {
                         this.initialize();
                         break;
                     }
+                    case globalTypes.productEnums.RADIO: {
+                        this.radioCommunityId = options.communityId;
+                        this.radioApiKey = options.apiKey;
+                        if (Object.prototype.hasOwnProperty.call(options, 'radioApiUrl') && typeof options.radioApiUrl === 'string') {
+                            this._debugLog(`Overriding Radio API URL... ${options.radioApiUrl}`);
+                            this.radioApiUrl = options.radioApiUrl;
+                        }
+                        this._debugLog('About to initialize instance.');
+                        this.initialize();
+                        break;
+                    }
                     default: {
                         throw new Error('Invalid product enum given for constructor.');
                     }
@@ -95,6 +109,8 @@ class Instance extends events_1.default {
             this.cadApiKey = options.cadApiKey;
             this.cmsCommunityId = options.cmsCommunityId;
             this.cmsApiKey = options.cmsApiKey;
+            this.radioCommunityId = options.radioCommunityId;
+            this.radioApiKey = options.radioApiKey;
             if (options.cadDefaultServerId !== undefined) {
                 this._debugLog(`Overriding default CAD server id... ${options.serverId}`);
                 this.cadDefaultServerId = options.cadDefaultServerId;
@@ -111,6 +127,10 @@ class Instance extends events_1.default {
                 this._debugLog(`Overriding CMS API URL... ${options.cmsApiUrl}`);
                 this.cmsApiUrl = options.cmsApiUrl;
             }
+            if (Object.prototype.hasOwnProperty.call(options, 'radioApiUrl') && typeof options.radioApiUrl === 'string') {
+                this._debugLog(`Overriding Radio API URL... ${options.radioApiUrl}`);
+                this.radioApiUrl = options.radioApiUrl;
+            }
             this.initialize();
         }
     }
@@ -129,6 +149,13 @@ class Instance extends events_1.default {
         else {
             this._debugLog('Not initializing CMS Manager due to a missing community id, api key, or api url.');
         }
+        if (this.radioCommunityId && this.radioApiKey && this.radioApiUrl) {
+            this._debugLog('About to initialize Radio Manager');
+            this.radio = new RadioManager_1.RadioManager(this);
+        }
+        else {
+            this._debugLog('Not initializing Radio Manager due to a missing community id, api key, or api url.');
+        }
     }
     _debugLog(message) {
         if (this.debug) {

package/dist/instance/instance.types.d.ts

@@ -12,6 +12,9 @@ export type InstanceOptions = {
     cmsApiKey?: string;
     cmsApiUrl?: string;
     cmsDefaultServerId?: number;
+    radioCommunityId?: string;
+    radioApiKey?: string;
+    radioApiUrl?: string;
     debug?: boolean;
     apiHeaders?: HeadersInit;
 };

package/dist/libs/rest/src/lib/REST.d.ts

@@ -10,6 +10,7 @@ import type { RequestInit, Response } from 'node-fetch';
 import { Instance } from '../../../../instance/Instance';
 import { CADManager } from '../../../../managers/CADManager';
 import { CMSManager } from '../../../../managers/CMSManager';
+import { RadioManager } from '../../../../managers/RadioManager';
 /**
  * Options to be passed when creating the REST instance
  */
@@ -86,7 +87,7 @@ export interface REST {
     off: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
     removeAllListeners: (<K extends keyof RestEvents>(event?: K) => this) & (<S extends string | symbol>(event?: Exclude<S, keyof RestEvents>) => this);
 }
-export type RestManagerTypes = CADManager | CMSManager;
+export type RestManagerTypes = CADManager | CMSManager | RadioManager;
 export declare class REST extends EventEmitter {
     readonly requestManager: RequestManager;
     readonly instance: Instance;