@arkadiuminc/sdk 2.13.0 → 2.14.1

package/README.md

@@ -33,7 +33,6 @@ main();
 
 - Analytics
     - [App Insights](TODO)
-    - [Google Tag manager](TODO)
     - [Standardized Spec for every game](https://arkadium.atlassian.net/wiki/spaces/DepartmentBusinessOperations/pages/23675756/Standardized+Spec+for+every+game+-+GA+AppInsights)
     - [AppInsight stamper](https://arkadium.atlassian.net/wiki/spaces/PhoenixGames/pages/23993424/AppInsight+stamper)
     - [Adaptive Sampling Implementation](https://arkadium.atlassian.net/wiki/spaces/PhoenixGames/pages/23897949/Adaptive+Sampling+Implementation)

package/dist/pkg/api/core/rpc.d.ts

@@ -33,6 +33,7 @@ declare class RpcSubscriber {
     private sendError;
 }
 export declare function shouldSubscribe(name: string, value: any): boolean;
+/** @hidden */
 export declare class RpcProvider {
     rpcPublisher: RpcPublisher;
     rpcSubscriber: RpcSubscriber;

package/dist/pkg/api/core/timeout-tester.d.ts

@@ -3,10 +3,12 @@ import { RpcProvider } from './rpc';
 export interface TimeoutTesterContract {
     timeout(): Promise<void>;
 }
+/** @hidden */
 export declare class TimeoutTester {
     constructor(rpcProvider: RpcProvider);
     timeout(): Promise<void>;
 }
+/** @hidden */
 export declare class TimeoutTesterProxy {
     private rpcProvider;
     constructor(rpcProvider: RpcProvider);

package/dist/pkg/api/features/ads/__mocks__/display-ad.d.ts

@@ -1,3 +1,4 @@
+/** @hidden */
 export declare class DisplayAd {
     static getInstance(): DisplayAd;
     protected _scriptLoaded: Promise<void>;

package/dist/pkg/api/features/ads/__mocks__/video-ad.d.ts

@@ -1,5 +1,6 @@
 import { ApiEnv } from '../../backend/backend.api';
 
+/** @hidden */
 export declare class VideoAd {
     static getInstance(): VideoAd;
     protected _scriptLoaded: Promise<void>;

package/dist/pkg/api/features/ads/display-ad.d.ts

@@ -1,3 +1,4 @@
+/** @hidden */
 export declare class DisplayAd {
     static domain: string;
     static getInstance(domain?: string): DisplayAd;

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

@@ -2,6 +2,7 @@ import { RpcProvider } from '../../core/rpc';
 import { ApiEnv } from '../backend/backend.api';
 import { Auth } from '../auth/';
 
+/** @hidden */
 export interface GameAdsContract {
     showPrerollAd?(options: {
         duration?: number;
@@ -29,6 +30,7 @@ export declare enum AdTypes {
     AD_468x60 = "AD_468x60",
     AD_160x600 = "AD_160x600"
 }
+/** @hidden */
 export declare class GameAds implements GameAdsContract {
     private interstitial;
     private rewarded;

package/dist/pkg/api/features/ads/video-ad.d.ts

@@ -1,5 +1,6 @@
 import { ApiEnv } from '../backend/backend.api';
 
+/** @hidden */
 export declare class VideoAd {
     static domain: string;
     static getInstance(domain?: string): VideoAd;

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

@@ -22,6 +22,7 @@ export interface AnalyticsApiContract {
     sendPageView(pageName: string, dimensions: DimensionsObject): Promise<void>;
     trackException(exception: Error): Promise<void>;
 }
+/** @hidden */
 export declare class AnalyticsApi implements AnalyticsApiContract {
     private host;
     private rpcProvider;

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

@@ -16,11 +16,13 @@ declare global {
  * https://www.npmjs.com/package/@microsoft/applicationinsights-web
  * https://js.monitor.azure.com/scripts/b/ai.3.gbl.min.js
  */
+/** @hidden */
 export interface IAppInsightConfig {
     configUrl?: string;
     defaultSamplingPercentage?: number;
     selectedDomainsSamplingPercentage?: number;
 }
+/** @hidden */
 export interface ICloudAppInsightConfig {
     description: string;
     instrumentationKey: string;
@@ -28,6 +30,7 @@ export interface ICloudAppInsightConfig {
     selectedDomains: string[];
     selectedDomainsSamplingPercentage: number;
 }
+/** @hidden */
 export declare class AppInsightsProvider extends AnalyticsProvider {
     private _aiTracker;
     private _config;

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

@@ -4,6 +4,7 @@ import { AnalyticsProvider } from './AnalyticsProvider';
 /**
  * based on game-core-monorepo/packages/engine/src/Analytics/Provider/ConsoleAnalytic.ts
  */
+/** @hidden */
 export declare class ConsoleProvider extends AnalyticsProvider {
     protected setup(): Promise<void>;
     sendEvent(eventCategory: string, eventAction: string, dimensions: DimensionsObject): void;

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

@@ -10,7 +10,9 @@ export declare enum PaymentsApiEnv {
     DEV = "https://arenacloud.cdn.arkadiumhosted.com/eagle-payment-api-dev/",
     PROD = "https://arenacloud.cdn.arkadiumhosted.com/eagle-payment-api-prod/"
 }
+/** @hidden */
 export declare type SessionStorageType = ReturnType<typeof UserApiGateway.prototype.getSessionStorage>;
+/** @hidden */
 export declare class Backend {
     user: Awaited<ReturnType<typeof UserApiGateway.prototype.getAuthApi>> | null;
     private userGateway;

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

@@ -22,9 +22,9 @@ export interface GameLifecycleContract {
     onGameEnd(): Promise<void>;
     subscribe(fn: LifecycleFn): void;
 }
+/** @hidden */
 export declare class GameLifecycle implements GameLifecycleContract {
     private rpcProvider;
-    private cb;
     private subscribers;
     constructor(rpcProvider: RpcProvider);
     private processLifecycleEvent;
@@ -43,6 +43,10 @@ export declare class GameLifecycleProxy implements GameLifecycleContract {
     constructor(rpcProvider: RpcProvider);
     onTestReady(): Promise<void>;
     onGameStart(): Promise<void>;
+    /** @hidden */
+    /**
+    * @deprecated The method should not be used
+    */
     onInteract(): Promise<void>;
     onChangeScore(score: number): Promise<void>;
     onGameEnd(): Promise<void>;

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

@@ -24,6 +24,7 @@ declare class WebEnvironmentDetails {
     constructor(siteName?: string, siteDomain?: string, referrer?: string, activeLocale?: string, devEnvironment?: string, darkMode?: boolean);
     clone(p: Partial<WebEnvironmentDetails>): WebEnvironmentDetails;
 }
+/** @hidden */
 export declare class HostArena implements IHost {
     private rpcProvider;
     private gameIdOverride;
@@ -52,7 +53,11 @@ export declare class HostGame implements IHost {
     constructor(rpcProvider: RpcProvider);
     getQueryParameter(key: string): Promise<string | null>;
     getGameId(): Promise<string>;
-    setGameId(id: string): Promise<any>;
+    /** @hidden */
+    /**
+    * @deprecated The method should not be used
+    */
+    setGameId(id: string): void;
     getDetails(): Promise<WebEnvironmentDetails>;
     openPurchaseForm(r: PurchaseRequest): Promise<void>;
     onPurchaseFormStateChange(observer: any): () => void;

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

@@ -12,6 +12,7 @@ export interface IPersistence {
     setRemoteStorageItem?(key: string, value: RemoteStorageValueType): Promise<void>;
     removeRemoteStorageItem?(key: string): Promise<boolean>;
 }
+/** @hidden */
 export declare class PersistenceArena implements IPersistence {
     private ls;
     /**
@@ -33,11 +34,12 @@ export declare class PersistenceGame implements IPersistence {
      */
     constructor(rpcProvider: RpcProvider, host: IHost, backend: Backend);
     getCookie(cookieName: string): Promise<string>;
+    private getPrefixedLocalStorageKey;
     getLocalStorageItem(key: string): Promise<string | null>;
     setLocalStorageItem(key: string, value: string): Promise<void>;
     removeLocalStorageItem(key: string): Promise<void>;
     private getCollection;
-    private getRemoteToLocalStorageCollection;
+    private getRemoteToLocalStorageKey;
     private isRemoteStorageBlacklisted;
     getRemoteStorageItem(key: string): Promise<RemoteStorageValueType | null>;
     setRemoteStorageItem(key: string, value: RemoteStorageValueType): Promise<void>;

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

@@ -1,3 +1,4 @@
+/** @hidden */
 export declare class Deferred<T> {
     promise: Promise<T>;
     resolve: (options: T) => void;

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

@@ -1,7 +1,10 @@
+/** @hidden */
 export declare type ObserverFn<T> = (data: T) => void;
+/** @hidden */
 export interface ReadonlyObservable<T> {
     subscribe: (observer: ObserverFn<T>) => any;
 }
+/** @hidden */
 export declare class Observable<T> {
     private lastValue;
     private observers;

package/dist/pkg/arkadium-arena-sdk.d.ts

@@ -9,7 +9,8 @@ import { TimeoutTesterContract } from './api/core/timeout-tester';
 import { PersistenceArena } from './api/features/persistence';
 import { HostArena } from './api/features/host';
 
-export declare class ArkadiumGameSdk {
+/** @hidden */
+export declare class ArkadiumArenaSdk {
     private rpcProvider;
     backendApi: Backend;
     host: HostArena;
@@ -35,10 +36,11 @@ export declare class ArkadiumGameSdk {
     dispose(): void;
 }
 export { ApiEnv };
+/** @hidden */
 export declare class ArenaApi {
     static version: string;
     private static sdk;
     static onGameSDKLoaded(target: any, callback: any): void;
     static dispose(): void;
-    static getInstance(env: ApiEnv, deferInit?: boolean): Promise<ArkadiumGameSdk>;
+    static getInstance(env: ApiEnv, deferInit?: boolean): Promise<ArkadiumArenaSdk>;
 }

package/dist/pkg/ping.module.d.ts

@@ -1,10 +1,12 @@
 import { RpcProvider } from './api/core/rpc';
 
+/** @hidden */
 export declare class PingModule {
     constructor(rpcProvider: RpcProvider);
     $ping: import('./api/utils/observable').Observable<number>;
     ping(): boolean;
 }
+/** @hidden */
 export declare class PingModuleProxy {
     private rpcProvider;
     constructor(rpcProvider: RpcProvider);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkadiuminc/sdk",
-  "version": "2.13.0",
+  "version": "2.14.1",
   "description": "",
   "keywords": [],
   "main": "dist/pkg/arkadium-sdk.umd.js",
@@ -9,7 +9,7 @@
   "files": [
     "dist/pkg"
   ],
-  "author": "pavel.orlov <pavel.orlov@arkadium.com>",
+  "author": "Arkadium",
   "repository": {
     "type": "git",
     "url": "git@ssh.dev.azure.com:v3/ArkadiumArena/Arena-Arkadium%20Modularization/arkadium-sdk"

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

@@ -1,21 +0,0 @@
-import { DimensionsObject, Dimension } from '../dimensions';
-import { AnalyticsProvider } from './AnalyticsProvider';
-
-/**
- * based on game-core-monorepo/packages/engine/src/Analytics/Provider/GoogleAnalytic.ts
- */
-declare global {
-    interface Window {
-        dataLayer?: any[];
-    }
-}
-export declare class GoogleTagManagerProvider extends AnalyticsProvider {
-    protected setup(): Promise<void>;
-    sendEvent(eventCategory: string, eventAction: string, dimensions: DimensionsObject): void;
-    mapDimensions(_dimensions: DimensionsObject): Partial<Record<Dimension, string | number>>;
-    computeLabel(eventCategory: string, eventAction: string, dimensions: DimensionsObject): string;
-    sendPageView(pageName: string, dimensions: DimensionsObject): void;
-    trackException(exception: Error): void;
-    private getDataLayer;
-    private gtag;
-}