@arkadiuminc/sdk 2.13.0 → 2.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/pkg/api/core/rpc.d.ts +1 -0
- package/dist/pkg/api/core/timeout-tester.d.ts +2 -0
- package/dist/pkg/api/features/ads/__mocks__/display-ad.d.ts +1 -0
- package/dist/pkg/api/features/ads/__mocks__/video-ad.d.ts +1 -0
- package/dist/pkg/api/features/ads/display-ad.d.ts +1 -0
- package/dist/pkg/api/features/ads/index.d.ts +2 -0
- package/dist/pkg/api/features/ads/video-ad.d.ts +1 -0
- package/dist/pkg/api/features/analytics/analytics.api.d.ts +1 -0
- package/dist/pkg/api/features/analytics/providers/AppInsightsProvider.d.ts +3 -0
- package/dist/pkg/api/features/analytics/providers/ConsoleProvider.d.ts +1 -0
- package/dist/pkg/api/features/backend/backend.api.d.ts +2 -0
- package/dist/pkg/api/features/game-lifecycle/game-lifecycle.api.d.ts +5 -1
- package/dist/pkg/api/features/host/index.d.ts +6 -1
- package/dist/pkg/api/features/persistence/index.d.ts +1 -0
- package/dist/pkg/api/utils/deferred.d.ts +1 -0
- package/dist/pkg/api/utils/observable.d.ts +3 -0
- package/dist/pkg/arkadium-arena-sdk.d.ts +4 -2
- package/dist/pkg/ping.module.d.ts +2 -0
- package/package.json +2 -2
- package/dist/pkg/api/features/analytics/providers/GoogleTagManagerProvider.d.ts +0 -21
- /package/dist/pkg/api/features/{analytics/providers/GoogleTagManagerProvider.test.d.ts → game-lifecycle/game-lifecycle.api.test.d.ts} +0 -0
|
@@ -3,10 +3,12 @@ import { RpcProvider } from './rpc';
|
|
|
3
3
|
export interface TimeoutTesterContract {
|
|
4
4
|
timeout(): Promise<void>;
|
|
5
5
|
}
|
|
6
|
+
/** @hidden */
|
|
6
7
|
export declare class TimeoutTester {
|
|
7
8
|
constructor(rpcProvider: RpcProvider);
|
|
8
9
|
timeout(): Promise<void>;
|
|
9
10
|
}
|
|
11
|
+
/** @hidden */
|
|
10
12
|
export declare class TimeoutTesterProxy {
|
|
11
13
|
private rpcProvider;
|
|
12
14
|
constructor(rpcProvider: RpcProvider);
|
|
@@ -2,6 +2,7 @@ import { RpcProvider } from '../../core/rpc';
|
|
|
2
2
|
import { ApiEnv } from '../backend/backend.api';
|
|
3
3
|
import { Auth } from '../auth/';
|
|
4
4
|
|
|
5
|
+
/** @hidden */
|
|
5
6
|
export interface GameAdsContract {
|
|
6
7
|
showPrerollAd?(options: {
|
|
7
8
|
duration?: number;
|
|
@@ -29,6 +30,7 @@ export declare enum AdTypes {
|
|
|
29
30
|
AD_468x60 = "AD_468x60",
|
|
30
31
|
AD_160x600 = "AD_160x600"
|
|
31
32
|
}
|
|
33
|
+
/** @hidden */
|
|
32
34
|
export declare class GameAds implements GameAdsContract {
|
|
33
35
|
private interstitial;
|
|
34
36
|
private rewarded;
|
|
@@ -22,6 +22,7 @@ export interface AnalyticsApiContract {
|
|
|
22
22
|
sendPageView(pageName: string, dimensions: DimensionsObject): Promise<void>;
|
|
23
23
|
trackException(exception: Error): Promise<void>;
|
|
24
24
|
}
|
|
25
|
+
/** @hidden */
|
|
25
26
|
export declare class AnalyticsApi implements AnalyticsApiContract {
|
|
26
27
|
private host;
|
|
27
28
|
private rpcProvider;
|
|
@@ -16,11 +16,13 @@ declare global {
|
|
|
16
16
|
* https://www.npmjs.com/package/@microsoft/applicationinsights-web
|
|
17
17
|
* https://js.monitor.azure.com/scripts/b/ai.3.gbl.min.js
|
|
18
18
|
*/
|
|
19
|
+
/** @hidden */
|
|
19
20
|
export interface IAppInsightConfig {
|
|
20
21
|
configUrl?: string;
|
|
21
22
|
defaultSamplingPercentage?: number;
|
|
22
23
|
selectedDomainsSamplingPercentage?: number;
|
|
23
24
|
}
|
|
25
|
+
/** @hidden */
|
|
24
26
|
export interface ICloudAppInsightConfig {
|
|
25
27
|
description: string;
|
|
26
28
|
instrumentationKey: string;
|
|
@@ -28,6 +30,7 @@ export interface ICloudAppInsightConfig {
|
|
|
28
30
|
selectedDomains: string[];
|
|
29
31
|
selectedDomainsSamplingPercentage: number;
|
|
30
32
|
}
|
|
33
|
+
/** @hidden */
|
|
31
34
|
export declare class AppInsightsProvider extends AnalyticsProvider {
|
|
32
35
|
private _aiTracker;
|
|
33
36
|
private _config;
|
|
@@ -4,6 +4,7 @@ import { AnalyticsProvider } from './AnalyticsProvider';
|
|
|
4
4
|
/**
|
|
5
5
|
* based on game-core-monorepo/packages/engine/src/Analytics/Provider/ConsoleAnalytic.ts
|
|
6
6
|
*/
|
|
7
|
+
/** @hidden */
|
|
7
8
|
export declare class ConsoleProvider extends AnalyticsProvider {
|
|
8
9
|
protected setup(): Promise<void>;
|
|
9
10
|
sendEvent(eventCategory: string, eventAction: string, dimensions: DimensionsObject): void;
|
|
@@ -10,7 +10,9 @@ export declare enum PaymentsApiEnv {
|
|
|
10
10
|
DEV = "https://arenacloud.cdn.arkadiumhosted.com/eagle-payment-api-dev/",
|
|
11
11
|
PROD = "https://arenacloud.cdn.arkadiumhosted.com/eagle-payment-api-prod/"
|
|
12
12
|
}
|
|
13
|
+
/** @hidden */
|
|
13
14
|
export declare type SessionStorageType = ReturnType<typeof UserApiGateway.prototype.getSessionStorage>;
|
|
15
|
+
/** @hidden */
|
|
14
16
|
export declare class Backend {
|
|
15
17
|
user: Awaited<ReturnType<typeof UserApiGateway.prototype.getAuthApi>> | null;
|
|
16
18
|
private userGateway;
|
|
@@ -22,9 +22,9 @@ export interface GameLifecycleContract {
|
|
|
22
22
|
onGameEnd(): Promise<void>;
|
|
23
23
|
subscribe(fn: LifecycleFn): void;
|
|
24
24
|
}
|
|
25
|
+
/** @hidden */
|
|
25
26
|
export declare class GameLifecycle implements GameLifecycleContract {
|
|
26
27
|
private rpcProvider;
|
|
27
|
-
private cb;
|
|
28
28
|
private subscribers;
|
|
29
29
|
constructor(rpcProvider: RpcProvider);
|
|
30
30
|
private processLifecycleEvent;
|
|
@@ -43,6 +43,10 @@ export declare class GameLifecycleProxy implements GameLifecycleContract {
|
|
|
43
43
|
constructor(rpcProvider: RpcProvider);
|
|
44
44
|
onTestReady(): Promise<void>;
|
|
45
45
|
onGameStart(): Promise<void>;
|
|
46
|
+
/** @hidden */
|
|
47
|
+
/**
|
|
48
|
+
* @deprecated The method should not be used
|
|
49
|
+
*/
|
|
46
50
|
onInteract(): Promise<void>;
|
|
47
51
|
onChangeScore(score: number): Promise<void>;
|
|
48
52
|
onGameEnd(): Promise<void>;
|
|
@@ -24,6 +24,7 @@ declare class WebEnvironmentDetails {
|
|
|
24
24
|
constructor(siteName?: string, siteDomain?: string, referrer?: string, activeLocale?: string, devEnvironment?: string, darkMode?: boolean);
|
|
25
25
|
clone(p: Partial<WebEnvironmentDetails>): WebEnvironmentDetails;
|
|
26
26
|
}
|
|
27
|
+
/** @hidden */
|
|
27
28
|
export declare class HostArena implements IHost {
|
|
28
29
|
private rpcProvider;
|
|
29
30
|
private gameIdOverride;
|
|
@@ -52,7 +53,11 @@ export declare class HostGame implements IHost {
|
|
|
52
53
|
constructor(rpcProvider: RpcProvider);
|
|
53
54
|
getQueryParameter(key: string): Promise<string | null>;
|
|
54
55
|
getGameId(): Promise<string>;
|
|
55
|
-
|
|
56
|
+
/** @hidden */
|
|
57
|
+
/**
|
|
58
|
+
* @deprecated The method should not be used
|
|
59
|
+
*/
|
|
60
|
+
setGameId(id: string): void;
|
|
56
61
|
getDetails(): Promise<WebEnvironmentDetails>;
|
|
57
62
|
openPurchaseForm(r: PurchaseRequest): Promise<void>;
|
|
58
63
|
onPurchaseFormStateChange(observer: any): () => void;
|
|
@@ -12,6 +12,7 @@ export interface IPersistence {
|
|
|
12
12
|
setRemoteStorageItem?(key: string, value: RemoteStorageValueType): Promise<void>;
|
|
13
13
|
removeRemoteStorageItem?(key: string): Promise<boolean>;
|
|
14
14
|
}
|
|
15
|
+
/** @hidden */
|
|
15
16
|
export declare class PersistenceArena implements IPersistence {
|
|
16
17
|
private ls;
|
|
17
18
|
/**
|
|
@@ -1,7 +1,10 @@
|
|
|
1
|
+
/** @hidden */
|
|
1
2
|
export declare type ObserverFn<T> = (data: T) => void;
|
|
3
|
+
/** @hidden */
|
|
2
4
|
export interface ReadonlyObservable<T> {
|
|
3
5
|
subscribe: (observer: ObserverFn<T>) => any;
|
|
4
6
|
}
|
|
7
|
+
/** @hidden */
|
|
5
8
|
export declare class Observable<T> {
|
|
6
9
|
private lastValue;
|
|
7
10
|
private observers;
|
|
@@ -9,7 +9,8 @@ import { TimeoutTesterContract } from './api/core/timeout-tester';
|
|
|
9
9
|
import { PersistenceArena } from './api/features/persistence';
|
|
10
10
|
import { HostArena } from './api/features/host';
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
/** @hidden */
|
|
13
|
+
export declare class ArkadiumArenaSdk {
|
|
13
14
|
private rpcProvider;
|
|
14
15
|
backendApi: Backend;
|
|
15
16
|
host: HostArena;
|
|
@@ -35,10 +36,11 @@ export declare class ArkadiumGameSdk {
|
|
|
35
36
|
dispose(): void;
|
|
36
37
|
}
|
|
37
38
|
export { ApiEnv };
|
|
39
|
+
/** @hidden */
|
|
38
40
|
export declare class ArenaApi {
|
|
39
41
|
static version: string;
|
|
40
42
|
private static sdk;
|
|
41
43
|
static onGameSDKLoaded(target: any, callback: any): void;
|
|
42
44
|
static dispose(): void;
|
|
43
|
-
static getInstance(env: ApiEnv, deferInit?: boolean): Promise<
|
|
45
|
+
static getInstance(env: ApiEnv, deferInit?: boolean): Promise<ArkadiumArenaSdk>;
|
|
44
46
|
}
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { RpcProvider } from './api/core/rpc';
|
|
2
2
|
|
|
3
|
+
/** @hidden */
|
|
3
4
|
export declare class PingModule {
|
|
4
5
|
constructor(rpcProvider: RpcProvider);
|
|
5
6
|
$ping: import('./api/utils/observable').Observable<number>;
|
|
6
7
|
ping(): boolean;
|
|
7
8
|
}
|
|
9
|
+
/** @hidden */
|
|
8
10
|
export declare class PingModuleProxy {
|
|
9
11
|
private rpcProvider;
|
|
10
12
|
constructor(rpcProvider: RpcProvider);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkadiuminc/sdk",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.14.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"keywords": [],
|
|
6
6
|
"main": "dist/pkg/arkadium-sdk.umd.js",
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"files": [
|
|
10
10
|
"dist/pkg"
|
|
11
11
|
],
|
|
12
|
-
"author": "
|
|
12
|
+
"author": "Arkadium",
|
|
13
13
|
"repository": {
|
|
14
14
|
"type": "git",
|
|
15
15
|
"url": "git@ssh.dev.azure.com:v3/ArkadiumArena/Arena-Arkadium%20Modularization/arkadium-sdk"
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import { DimensionsObject, Dimension } from '../dimensions';
|
|
2
|
-
import { AnalyticsProvider } from './AnalyticsProvider';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* based on game-core-monorepo/packages/engine/src/Analytics/Provider/GoogleAnalytic.ts
|
|
6
|
-
*/
|
|
7
|
-
declare global {
|
|
8
|
-
interface Window {
|
|
9
|
-
dataLayer?: any[];
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
export declare class GoogleTagManagerProvider extends AnalyticsProvider {
|
|
13
|
-
protected setup(): Promise<void>;
|
|
14
|
-
sendEvent(eventCategory: string, eventAction: string, dimensions: DimensionsObject): void;
|
|
15
|
-
mapDimensions(_dimensions: DimensionsObject): Partial<Record<Dimension, string | number>>;
|
|
16
|
-
computeLabel(eventCategory: string, eventAction: string, dimensions: DimensionsObject): string;
|
|
17
|
-
sendPageView(pageName: string, dimensions: DimensionsObject): void;
|
|
18
|
-
trackException(exception: Error): void;
|
|
19
|
-
private getDataLayer;
|
|
20
|
-
private gtag;
|
|
21
|
-
}
|