@arkadiuminc/sdk 2.0.1 → 2.2.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,6 +1,6 @@
 import { RpcProvider } from '../../core/rpc';
-import { AnalyticProviderEnum, IAnalyticConfig } from './defs';
-import { DimensionsObject } from './dimensions';
+import { AnalyticsProviderType, IAnalyticConfig } from './defs';
+import { DimensionsObject, Dimension } from './dimensions';
 import { IHost } from '../host';
 interface EnvironmentVersion {
     GameKey: string;
@@ -8,6 +8,10 @@ interface EnvironmentVersion {
     NestVersion: string;
     SdkVersion: string;
 }
+declare type FingerprintData = {
+    [Dimension.fpVisitorId]: string;
+    [Dimension.fpIncognito]: string;
+};
 export interface AnalyticsApiContract {
     setGameVersion(v: string): Promise<void>;
     setNestVersion(v: string): Promise<void>;
@@ -21,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>;
@@ -31,14 +37,19 @@ export declare class AnalyticsApi implements AnalyticsApiContract {
     sendEvent(eventCategory: string, eventAction: string, dimensions: DimensionsObject): Promise<void>;
     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);
+    private setFingerprintData;
     setGameVersion(v: string): Promise<void>;
     setNestVersion(v: string): Promise<void>;
     getEnvVersion(): Promise<EnvironmentVersion>;
@@ -47,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>;
@@ -104,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
@@ -113,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/dimensions.d.ts

@@ -70,5 +70,7 @@ export declare enum Dimension {
     CD1 = "CD1",
     CD2 = "CD2",
     CD3 = "CD3",
-    CD4 = "CD4"
+    CD4 = "CD4",
+    fpVisitorId = "fpVisitorId",
+    fpIncognito = "fpIncognito"
 }

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkadiuminc/sdk",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "",
   "keywords": [],
   "main": "dist/pkg/arkadium-sdk.umd.js",
@@ -35,7 +35,9 @@
     "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 --follow-tags origin $(git branch)"
   },
   "lint-staged": {
     "{src,test}/**/*.ts": [
@@ -78,6 +80,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 +96,9 @@
     "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"
   }
 }