@arkadiuminc/sdk 2.1.0 → 2.3.0

package/README.md

@@ -29,24 +29,6 @@ async function main() {
 main();
 ```
 
-## using the sandbox with a local game sdk
-
-```
-cd arkadium-sdk
-http-server . -p 8080 -c-1 --cors
-npm run build-fast
-
-cd arkadium-dev-portal
-# in the sandbox.tsx file, change SDK_PATH to 'http://localhost:8080/dist/arena/arena-sdk.umd.js'
-npm run start
-# visit the dev portal sandbox page: http://localhost:3511/sandbox
-```
-
-set the following fields:
-- gameId: arkadium-sdk-test-game
-- gameURL: http://localhost:8080/example/simple/analytics.html
-
-
 ## Reference documents
 
 - Analytics

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

@@ -1,5 +1,5 @@
 import { RpcProvider } from '../../core/rpc';
-import { AnalyticProviderEnum, IAnalyticConfig } from './defs';
+import { AnalyticsProviderType, IAnalyticConfig } from './defs';
 import { DimensionsObject, Dimension } from './dimensions';
 import { IHost } from '../host';
 interface EnvironmentVersion {
@@ -25,8 +25,10 @@ export declare class AnalyticsApi implements AnalyticsApiContract {
     private host;
     private rpcProvider;
     private providers;
-    private activeProvidersTypes;
+    private configuredProviders;
+    private disabledProviders;
     private info;
+    providersTypes: typeof AnalyticsProviderType;
     constructor(host: IHost, rpcProvider: RpcProvider);
     getEnvVersion(): Promise<EnvironmentVersion>;
     setGameVersion(v: string): Promise<void>;
@@ -36,12 +38,14 @@ export declare class AnalyticsApi implements AnalyticsApiContract {
     sendPageView(pageName: string, dimensions: DimensionsObject): Promise<void>;
     trackException(exception: Error): Promise<void>;
     setFingerprintData(fingerprintData: FingerprintData): Promise<any>;
+    enableProvider(providerType: AnalyticsProviderType): void;
+    disableProvider(providerType: AnalyticsProviderType): void;
 }
 export declare class AnalyticsApiProxy implements AnalyticsApiContract {
     private rpcProvider;
-    CONSOLE: AnalyticProviderEnum;
-    APP_INSIGHTS: AnalyticProviderEnum;
-    GOOGLE: AnalyticProviderEnum;
+    CONSOLE: AnalyticsProviderType;
+    APP_INSIGHTS: AnalyticsProviderType;
+    GOOGLE: AnalyticsProviderType;
     private dimensionValues;
     private fingerprintData;
     constructor(rpcProvider: RpcProvider);
@@ -54,7 +58,7 @@ export declare class AnalyticsApiProxy implements AnalyticsApiContract {
      * Low level method to report an analytics event
      * Likely you can use the helper methods for common events instead.
      * @param eventCategory {Event}
-     * @param eventAction {string} optional action. values depend on the event category
+     * @param eventAction optional action. values depend on the event category
      * @param dimensions record with dimensions to report
      */
     sendEvent(eventCategory: string, eventAction: string, dimensions: DimensionsObject): Promise<void>;
@@ -111,7 +115,7 @@ export declare class AnalyticsApiProxy implements AnalyticsApiContract {
     /**
      * actions:
      * - Finished - User successfully finished the Round (Level). First round is Round 1 (not 0) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
-     * - Not_Finished - User didn't finish the Round (Level) successfully OR leaves the game OR skips the round OR Quit (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)  {if possible several lose scenarios, add reason dimension}
+     * - Not_Finished - User didn't finish the Round (Level) successfully OR leaves the game OR skips the round OR Quit (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay. If possible several lose scenarios, add reason dimension)
      *
      * dimensions:
      * - reason: No_Moves | Time_Out
@@ -120,12 +124,12 @@ export declare class AnalyticsApiProxy implements AnalyticsApiContract {
     /**
      * actions:
      *
-     * Win - User ended game because he wins ({Round} in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
-     * Lose -User ended game because he loses or faces "No More Moves' situation ({Round} in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
-     * Time_Out - User ended game because he runs of time ({Round} in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
-     * New_Game - User ends game because he starts a new game: click on 'New Game', then click on 'Yes' ({Round} in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
-     * Quit - User ends game because he quits a new game: click on 'Quit', then click on 'Yes' ({Round} in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
-     * Restart - User starts the same game from the beginning again (mostly for Solitaire games): click on 'Restart', then click on 'Yes' ({Round} in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
+     * Win - User ended game because he wins (Round in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
+     * Lose -User ended game because he loses or faces "No More Moves' situation (Round in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
+     * Time_Out - User ended game because he runs of time (Round in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
+     * New_Game - User ends game because he starts a new game: click on 'New Game', then click on 'Yes' (Round in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
+     * Quit - User ends game because he quits a new game: click on 'Quit', then click on 'Yes' (Round in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
+     * Restart - User starts the same game from the beginning again (mostly for Solitaire games): click on 'Restart', then click on 'Yes' (Round in Label only if game has it) (applicable for games with evergreen logic, not infinite games - before Nest changes to gameplay)
      */
     sendGameEndEvent(action: 'Win' | 'Lose' | 'Time_Out' | 'New_Game' | 'Quit' | 'Restart', dimensions?: DimensionsObject): void;
     /**

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

@@ -1,10 +1,11 @@
-export declare enum AnalyticProviderEnum {
+export declare enum AnalyticsProviderType {
     CONSOLE = 1,
     GOOGLE = 2,
-    APP_INSIGHTS = 3
+    APP_INSIGHTS = 3,
+    ALL = 1000
 }
 export interface IAnalyticConfig {
     appId: string;
-    provider: AnalyticProviderEnum;
+    provider: AnalyticsProviderType;
     providerConfig?: any;
 }

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

@@ -1,17 +1,19 @@
 import { DimensionsObject } from "../dimensions";
+import { IAnalyticConfig } from '../defs';
 declare type EventArr = [string, string, DimensionsObject];
 declare type PageViewArr = [string, DimensionsObject];
 export declare abstract class AnalyticsProvider {
-    protected config: any;
+    protected config: IAnalyticConfig;
     protected isReady: boolean;
     protected unsentEvents: EventArr[];
     protected unsentPageViews: PageViewArr[];
     protected unsentExceptions: Error[];
-    constructor(config: any);
+    constructor(config: IAnalyticConfig);
     protected setup(): Promise<void>;
     protected handleUnsent(): void;
     sendEvent(eventCategory: string, eventAction: string, dimensions: DimensionsObject): void;
     sendPageView(pageName: string, dimensions: DimensionsObject): void;
     trackException(exception: Error): void;
+    getProviderType(): import("../defs").AnalyticsProviderType;
 }
 export {};

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

@@ -2,7 +2,8 @@ import { ApiGateway as UserApiGateway } from '@arkadium/eagle-user-client';
 import { UserGameDataApi } from '@arkadium/eagle-user-client/dist/types/api/v1/user-game-data.api';
 export declare enum ApiEnv {
     DEV = "DEV",
-    PROD = "PROD"
+    PROD = "PROD",
+    STAGING = "STAGING"
 }
 export declare enum PaymentsApiEnv {
     DEV = "https://arenacloud.cdn.arkadiumhosted.com/eagle-payment-api-dev/",
@@ -16,7 +17,7 @@ export declare class Backend {
     uiOpenRequest: import("../../utils/observable").Observable<boolean>;
     authStatus: import("../../utils/observable").Observable<boolean>;
     addEventListener(event: number, cb: () => void): void;
-    init(e: ApiEnv, isGameSide: boolean, sessionStorage?: SessionStorageType | null): Promise<void>;
+    init(env: ApiEnv, isGameSide: boolean, sessionStorage?: SessionStorageType | null): Promise<void>;
     getSessionStorage(): import("@arkadium/eagle-user-client/dist/types/session-storage").SessionStorage | undefined;
     checkAuth(): void;
     isUserAuthorized(): boolean;

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

@@ -18,10 +18,12 @@ export declare class ArkadiumGameSdk {
     private timeoutTester;
     persistence: PersistenceGame;
     version: string;
+    private currentEnv;
     private arenaPingSender;
     private arenaPingListener;
     constructor(rpcProvider: RpcProvider, backendApi: Backend, host: HostGame, lifecycle: GameLifecycleContract, ads: GameAdsContract, auth: Auth, analytics: AnalyticsApiContract, timeoutTester: TimeoutTesterContract, persistence: PersistenceGame);
     initialize(env: ApiEnv, isGameSide: boolean, sessionStorage?: SessionStorageType | null): Promise<void>;
+    getEnv(): ApiEnv;
     updateWinReference(target: any): void;
     debugMode(enabled: boolean): void;
 }

package/dist/pkg/arkadium-sdk.mjs

@@ -1,17 +1,21 @@
-const d = "https://developers.arkadium.com/cdn/sdk/v2/sdk.js", a = "https://developers.arkadium.com/cdn/sdk/dev/v2/sdk.js";
-var i = /* @__PURE__ */ ((e) => (e.DEV = "DEV", e.PROD = "PROD", e))(i || {});
+const r = "https://developers.arkadium.com/cdn/sdk/v2/sdk.js", i = "https://developers.arkadium.com/cdn/sdk/dev/v2/sdk.js";
+var a = /* @__PURE__ */ ((e) => (e.DEV = "DEV", e.PROD = "PROD", e.STAGING = "STAGING", e))(a || {});
 let n, t;
 function m(e) {
   return t ? Promise.resolve(t) : (n || (n = new Promise((o) => {
-    const s = document.createElement("script"), r = e === "PROD" ? d : a;
-    s.src = r, s.onload = () => {
-      globalThis.__GameApi__.getInstance(e).then((c) => {
-        t = c, o(t);
+    const c = [
+      "STAGING",
+      "PROD"
+      /* PROD */
+    ].includes(e) ? r : i, s = document.createElement("script");
+    s.src = c, s.onload = () => {
+      globalThis.__GameApi__.getInstance(e).then((d) => {
+        t = d, o(t);
       });
     }, (document.head || document.body).appendChild(s);
   })), n);
 }
 export {
-  i as Env,
+  a as Env,
   m as getInstance
 };

package/dist/pkg/arkadium-sdk.umd.js

@@ -1 +1 @@
-(function(e,n){typeof exports=="object"&&typeof module<"u"?n(exports):typeof define=="function"&&define.amd?define(["exports"],n):(e=typeof globalThis<"u"?globalThis:e||self,n(e.ArkadiumSdk={}))})(this,function(e){"use strict";const n="https://developers.arkadium.com/cdn/sdk/v2/sdk.js",c="https://developers.arkadium.com/cdn/sdk/dev/v2/sdk.js";var i=(t=>(t.DEV="DEV",t.PROD="PROD",t))(i||{});let d,s;function r(t){return s?Promise.resolve(s):(d||(d=new Promise(u=>{const o=document.createElement("script"),a=t==="PROD"?n:c;o.src=a,o.onload=()=>{globalThis.__GameApi__.getInstance(t).then(m=>{s=m,u(s)})},(document.head||document.body).appendChild(o)})),d)}e.Env=i,e.getInstance=r,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});
+(function(e,n){typeof exports=="object"&&typeof module<"u"?n(exports):typeof define=="function"&&define.amd?define(["exports"],n):(e=typeof globalThis<"u"?globalThis:e||self,n(e.ArkadiumSdk={}))})(this,function(e){"use strict";const n="https://developers.arkadium.com/cdn/sdk/v2/sdk.js",c="https://developers.arkadium.com/cdn/sdk/dev/v2/sdk.js";var i=(t=>(t.DEV="DEV",t.PROD="PROD",t.STAGING="STAGING",t))(i||{});let d,s;function r(t){return s?Promise.resolve(s):(d||(d=new Promise(u=>{const a=["STAGING","PROD"].includes(t)?n:c,o=document.createElement("script");o.src=a,o.onload=()=>{globalThis.__GameApi__.getInstance(t).then(l=>{s=l,u(s)})},(document.head||document.body).appendChild(o)})),d)}e.Env=i,e.getInstance=r,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});

package/dist/pkg/loader.d.ts

@@ -2,7 +2,8 @@ import { ArkadiumGameSdk } from './arkadium-game-sdk';
 declare type API = ArkadiumGameSdk;
 export declare enum Env {
     DEV = "DEV",
-    PROD = "PROD"
+    PROD = "PROD",
+    STAGING = "STAGING"
 }
 export declare function getInstance(env: Env): Promise<API>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkadiuminc/sdk",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "",
   "keywords": [],
   "main": "dist/pkg/arkadium-sdk.umd.js",
@@ -35,7 +35,10 @@
     "commit": "git-cz",
     "semantic-release": "semantic-release",
     "semantic-release-prepare": "ts-node tools/semantic-release-prepare",
-    "precommit": "lint-staged"
+    "precommit": "lint-staged",
+    "release": "standard-version --skip.tag",
+    "ci-release": "standard-version && git push origin && git push origin $(git tag --sort=creatordate | tail -n 1)",
+    "prepare": "husky"
   },
   "lint-staged": {
     "{src,test}/**/*.ts": [
@@ -59,8 +62,8 @@
   "devDependencies": {
     "@arkadium/eagle-payments-api-client": "^0.0.35",
     "@arkadium/eagle-user-client": "^0.0.90",
-    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^17.0.3",
+    "@commitlint/cli": "^17.8.1",
+    "@commitlint/config-conventional": "^17.8.1",
     "@types/jest": "^28.1.6",
     "@types/node": "^18.0.6",
     "colors": "^1.4.0",
@@ -68,7 +71,7 @@
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "happy-dom": "^14.0.0",
-    "husky": "^8.0.1",
+    "husky": "^9.0.11",
     "lint-staged": "^13.0.3",
     "lodash.camelcase": "^4.3.0",
     "prettier": "^2.7.1",
@@ -78,6 +81,7 @@
     "semantic-release": "^19.0.3",
     "semantic-release-ado": "^1.4.0",
     "shelljs": "^0.8.5",
+    "standard-version": "^9.5.0",
     "ts-node": "^10.9.1",
     "tslint": "^5.20.1",
     "tslint-config-prettier": "^1.18.0",
@@ -93,5 +97,10 @@
     "jsonpack": "^1.1.5",
     "nanoid": "^5.0.4",
     "vite-plugin-string-replace": "^1.1.2"
+  },
+  "standard-version": {
+    "commitUrlFormat": "https://arkadiumarena.visualstudio.com/Tech%20Services/_git/arkadium-sdk/commit/{{hash}}",
+    "compareUrlFormat": "https://arkadiumarena.visualstudio.com/Tech%20Services/_git/arkadium-sdk/branchCompare?baseVersion=GT{{previousTag}}&targetVersion=GT{{currentTag}}&_a=files",
+    "releaseCommitMessageFormat": "chore(release): {{currentTag}} [skip ci]"
   }
 }