@arkadiuminc/sdk 2.78.8 → 2.79.1

package/dist/pkg/api/core/config-service.d.ts

@@ -15,7 +15,8 @@ export declare enum GameConfigProperty {
     hasEagle = "hasEagle",
     slug = "slug",
     gameServerSettings = "gameServerSettings",
-    debugMenu = "debugMenu"
+    debugMenu = "debugMenu",
+    version = "version"
 }
 export declare type DebugMenuConfig = {
     isEnabled: boolean;
@@ -38,6 +39,12 @@ declare type GamePlatformFilterEntry = {
 };
 declare type LifecycleBlacklistEntry = GamePlatformFilterEntry;
 export declare type AdBlockerDetectionEntry = GamePlatformFilterEntry;
+export declare type MonitoringConfig = {
+    isEnabled: boolean;
+    tracesSampleRate: number;
+    messagesSampleRate: number;
+    exceptionsSampleRate: number;
+};
 declare type LifecycleEventConfig = {
     blacklists: LifecycleBlacklistEntry[];
 };
@@ -72,6 +79,7 @@ export interface ConfigSchema {
         }>;
         adBlockerDetection: AdBlockerDetectionEntry[];
     };
+    monitoring: MonitoringConfig;
 }
 export { defaultConfigJson };
 export declare const schema: {
@@ -290,6 +298,25 @@ export declare const schema: {
             required: string[];
             additionalProperties: boolean;
         };
+        monitoring: {
+            type: string;
+            properties: {
+                isEnabled: {
+                    type: string;
+                };
+                tracesSampleRate: {
+                    type: string;
+                };
+                messagesSampleRate: {
+                    type: string;
+                };
+                exceptionsSampleRate: {
+                    type: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
     };
     required: string[];
     additionalProperties: boolean;

package/dist/pkg/api/core/monitoring-provider.d.ts

@@ -0,0 +1,77 @@
+import { BrowserClient, Span, Scope } from '@sentry/browser';
+import { ApiEnv } from '../../arkadium-arena-sdk';
+import { HostArena } from '../features/host';
+
+declare global {
+    interface Window {
+        __ark_sentry?: {
+            createIsolatedClient: (options: IsolatedSentryClientOptionsType) => IsolatedSentryClientHandleType;
+        };
+    }
+}
+export declare enum MonitoringSource {
+    GAME = "game",
+    SDK = "sdk"
+}
+export declare enum MonitoringMetricType {
+    GAUGE = "gauge",
+    COUNT = "count",
+    DISTRIBUTION = "distribution"
+}
+declare type IsolatedSentryClientOptionsType = {
+    dsn: string;
+    release?: string;
+    environment?: string;
+    tracesSampleRate?: number;
+    tags?: Record<string, string>;
+};
+export declare type IsolatedSentrySpanOptionsType = {
+    name: string;
+    op?: string;
+    attributes?: Record<string, string | number | boolean>;
+};
+export declare type IsolatedSentryInactiveSpanOptionsType = {
+    name: string;
+    op?: string;
+    parentSpan?: Span;
+};
+export declare type IsolatedSentryMetricOptionsType = {
+    unit?: string;
+    attributes?: Record<string, string | number | boolean>;
+};
+export declare type IsolatedSentryMetricsType = {
+    count: (name: string, value?: number, metric?: IsolatedSentryMetricOptionsType) => void;
+    gauge: (name: string, value: number, metric?: IsolatedSentryMetricOptionsType) => void;
+    distribution: (name: string, value: number, metric?: IsolatedSentryMetricOptionsType) => void;
+};
+export declare type IsolatedSentrySpanType = Span & {
+    setMeasurement: (name: string, value: number, unit: string) => void;
+    startInactiveSpan: (span: IsolatedSentryInactiveSpanOptionsType) => IsolatedSentrySpanType;
+};
+declare type IsolatedSentryClientHandleType = {
+    client: BrowserClient;
+    scope: Scope;
+    setTag: (key: string, value: string) => void;
+    setTags: (tags: Record<string, string>) => void;
+    captureException: (error: unknown) => string;
+    captureMessage: (message: string) => string;
+    metrics: IsolatedSentryMetricsType;
+    startSpan: <T>(span: IsolatedSentrySpanOptionsType, callback: () => T) => T;
+    startInactiveSpan: (span: IsolatedSentryInactiveSpanOptionsType) => IsolatedSentrySpanType;
+    close: (timeout?: number) => PromiseLike<boolean>;
+};
+export declare class MonitoringProvider {
+    private static _instance;
+    private host;
+    private isInited;
+    private sentryProxy;
+    private constructor();
+    init(env: ApiEnv, host: HostArena): void;
+    static get Instance(): MonitoringProvider;
+    private setDefaultTags;
+    captureMessage(message: string, source: MonitoringSource): void;
+    captureException(error: unknown, source: MonitoringSource): void;
+    sendMetric(name: string, value: number, metricType: MonitoringMetricType): void;
+    sendMetrics(metrics: Record<string, number>, metricType: MonitoringMetricType): void;
+}
+export {};

package/dist/pkg/api/core/monitoring-provider.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/pkg/api/features/analytics/analytics.api.d.ts

@@ -6,6 +6,27 @@ import { DebugProvider } from '../../core/debug-provider';
 import { AuthArena } from '../auth';
 import { PersistenceArena } from '../persistence';
 
+export declare enum AnalyticsDataCallbackType {
+    GAME_STATE = "gameState",
+    PERFORMANCE_METRICS = "performanceMetrics"
+}
+export declare const MAX_GAME_STATE_SIZE = 1024;
+/**
+ * Full callback signature per {@link AnalyticsDataCallbackType}.
+ * Add new enum members here with their args and return type in one place.
+ */
+export interface AnalyticsDataCallbacks {
+    [AnalyticsDataCallbackType.GAME_STATE]: () => Record<string, string>;
+    [AnalyticsDataCallbackType.PERFORMANCE_METRICS]: () => PerformanceMetricsData;
+}
+export declare type AnalyticsDataCallback<T extends AnalyticsDataCallbackType> = AnalyticsDataCallbacks[T];
+export declare type AnalyticsDataCallbackResult<T extends AnalyticsDataCallbackType> = ReturnType<AnalyticsDataCallbacks[T]>;
+export declare type PerformanceMetricsData = {
+    "fps": number;
+    "fps_total_drops": number;
+    "memory_used": number;
+    "memory_total": number;
+};
 interface EnvironmentVersion {
     GameKey: string;
     GameVersion: string;
@@ -62,6 +83,7 @@ export declare class AnalyticsApiProxy implements AnalyticsApiContract {
     GOOGLE: AnalyticsProviderType;
     private dimensionValues;
     private fingerprintData;
+    private dataCallbacks;
     constructor(rpcProvider: RpcProvider);
     getFingerprintVisitorId(): string;
     private setFingerprintData;
@@ -227,5 +249,7 @@ export declare class AnalyticsApiProxy implements AnalyticsApiContract {
      */
     sendQuitConfirmedPageView(dimensions?: DimensionsObject): void;
     clearProviders(): void;
+    registerDataCallback<T extends AnalyticsDataCallbackType>(type: T, callback: AnalyticsDataCallback<T>): void;
+    fetchDataFromCallback<T extends AnalyticsDataCallbackType>(type: T): AnalyticsDataCallbackResult<T> | undefined;
 }
 export {};

package/dist/pkg/api/features/auth/index.d.ts

@@ -1,5 +1,5 @@
 import { Backend } from '../backend/backend.api';
-import { createStore } from '../../utils/observable';
+import { createStore, UnsubscribeFn } from '../../utils/observable';
 import { RpcProvider } from '../../core/rpc';
 import { IHost } from '../host';
 import { PersistenceArena } from '../persistence';
@@ -29,7 +29,7 @@ export declare abstract class Auth {
     isUserAuthorized(): Promise<boolean>;
     getToken(): Promise<string | undefined>;
     abstract getUserProfile(): Promise<UserProfile | null>;
-    onAuthStatusChange(observer: AuthStatusObserver): () => void;
+    onAuthStatusChange(observer: AuthStatusObserver): UnsubscribeFn;
     openAuthForm(): Promise<void>;
     closeAuthForm(): Promise<void>;
     onOpenAuthForm(observer: AuthFormObserver): void | undefined;

package/dist/pkg/api/features/game-lifecycle/game-lifecycle.api.d.ts

@@ -1,6 +1,7 @@
 import { RpcProvider } from '../../core/rpc';
 import { IHost } from '../host';
 import { VirtualItemsApiProvider } from '../wallet';
+import { AnalyticsApiProxy } from '../analytics/analytics.api';
 
 export declare enum LifecycleEvent {
     TEST_READY = 1,
@@ -53,10 +54,11 @@ export declare class GameLifecycleArena {
 }
 export declare class GameLifecycleGame {
     private rpcProvider;
+    private analyticsProvider;
     private eventCallbacks;
     private sentEvents;
     LifecycleEvent: typeof LifecycleEvent;
-    constructor(rpcProvider: RpcProvider);
+    constructor(rpcProvider: RpcProvider, analyticsProvider: AnalyticsApiProxy);
     private onEvent;
     private getExecutionTimeLimitMs;
     dispatchEvent(event: LifecycleEvent, payload?: any): Promise<any>;

package/dist/pkg/api/features/host/index.d.ts

@@ -1,6 +1,6 @@
 import { DebugProvider } from '../../core/debug-provider';
 import { RpcProvider } from '../../core/rpc';
-import { ObserverFn } from '../../utils/observable';
+import { ObserverFn, UnsubscribeFn } from '../../utils/observable';
 import { ArenaType } from './arena-type';
 
 export { ArenaType } from './arena-type';
@@ -62,7 +62,7 @@ export declare class HostArena implements IHost {
     getDetails(): Promise<WebEnvironmentDetails>;
     setDetails(p: Partial<WebEnvironmentDetails>): void;
     openPurchaseForm(pr: PurchaseRequest): Promise<void>;
-    onOpenPurchaseForm(observer: any): () => void;
+    onOpenPurchaseForm(observer: ObserverFn<PurchaseRequest | undefined>): UnsubscribeFn;
     purchaseFormClosed(madePurchase: boolean): Promise<void>;
     getArenaName(): Promise<string>;
     getArenaNameSync(): string;
@@ -81,6 +81,10 @@ export declare class HostArena implements IHost {
     isEagleSupported(): Promise<boolean>;
     isAuthSupported(): Promise<boolean>;
 }
+export declare type ShopWindowNotification = {
+    opened: boolean;
+    madePurchase: boolean;
+};
 export declare class HostGame implements IHost {
     private rpcProvider;
     private purchaseFormState;
@@ -98,7 +102,7 @@ export declare class HostGame implements IHost {
     setGameId(id: string): void;
     getDetails(): Promise<WebEnvironmentDetails>;
     openPurchaseForm(r?: PurchaseRequest): Promise<void>;
-    onPurchaseFormStateChange(observer: any): () => void;
+    onPurchaseFormStateChange(observer: ObserverFn<ShopWindowNotification | undefined>): UnsubscribeFn;
     private purchaseFormClosed;
     getArenaName(): Promise<string>;
     getArenaType(): Promise<ArenaType>;

package/dist/pkg/api/utils/observable.d.ts

@@ -2,14 +2,15 @@
 export declare type ObserverFn<T> = (data: T) => void;
 /** @hidden */
 export interface ReadonlyObservable<T> {
-    subscribe: (observer: ObserverFn<T>) => any;
+    subscribe: (observer: ObserverFn<T>) => UnsubscribeFn;
 }
+export declare type UnsubscribeFn = () => void;
 /** @hidden */
 export declare class Observable<T> {
     private lastValue;
     private observers;
     constructor(initialValue: T);
-    subscribe(observer: ObserverFn<T>): () => void;
+    subscribe(observer: ObserverFn<T>): UnsubscribeFn;
     update(data: T): void;
 }
 export declare function createStore<T>(initialValue: T): Observable<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkadiuminc/sdk",
-  "version": "2.78.8",
+  "version": "2.79.1",
   "description": "",
   "keywords": [],
   "main": "dist/pkg/arkadium-sdk.umd.js",
@@ -88,6 +88,7 @@
     "@arkadium/eagle-virtual-items-api-client": "^0.1.4",
     "@commitlint/cli": "^17.8.1",
     "@commitlint/config-conventional": "^17.8.1",
+    "@sentry/browser": "^10.78.0",
     "@types/jest": "^29.5.11",
     "@types/node": "^18.0.6",
     "@vitest/coverage-v8": "^1.6.0",