@accelbyte/sdk 0.2.0-beta.13 → 0.2.0-beta.16

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.2.0-beta.16 - 2023-02-22
+
+- Add Runtime Checking for Service Versions
+
 ### 0.2.0-beta.13 - 2023-02-22
 
 - Enable tree-shaking for @accelbyte/sdk

package/dist/cjs/node/index.js

@@ -1130,7 +1130,7 @@ class DlcApi {
 }
 
 /*
- * Copyright (c) 2022 AccelByte Inc. All Rights Reserved
+ * Copyright (c) 2022-2023 AccelByte Inc. All Rights Reserved
  * This is licensed software from AccelByte Inc, for limitations
  * and restrictions contact your company contract manager.
  */
@@ -1172,12 +1172,7 @@ const AvailablePlatform = [
         arch: [ARCH.X64],
         targetPlatform: [BUILDINFO_PLATFORM_ID.WIN64, BUILDINFO_PLATFORM_ID.WINDOWS, BUILDINFO_PLATFORM_ID.WIN32]
     }
-];
-exports.LogLevel = void 0;
-(function (LogLevel) {
-    LogLevel["DEBUG"] = "DEBUG";
-    LogLevel["INFO"] = "INFO";
-})(exports.LogLevel || (exports.LogLevel = {}));
+];
 
 /*
  * Copyright (c) 2022-2023 AccelByte Inc. All Rights Reserved
@@ -9695,28 +9690,149 @@ const injectErrorInterceptors = (baseUrl, onUserEligibilityChange, onError) => {
     });
 };
 
-var version="x.y.z";var build="x.y.z";var timestamp="x.y.z";var buildInfo = {version:version,build:build,timestamp:timestamp};
+/*
+ * Copyright (c) 2023 AccelByte Inc. All Rights Reserved
+ * This is licensed software from AccelByte Inc, for limitations
+ * and restrictions contact your company contract manager.
+ */
+var BasicVersion = {
+    title: 'basic',
+    name: 'justice-basic-service',
+    version: '2.6.0',
+    buildDate: '2023-02-22T00:53:23.199Z'
+};
 
 /*
- * Copyright (c) 2022-2023 AccelByte Inc. All Rights Reserved
+ * Copyright (c) 2023 AccelByte Inc. All Rights Reserved
  * This is licensed software from AccelByte Inc, for limitations
  * and restrictions contact your company contract manager.
  */
-/**
- * This is the main SDK class
- * ----------------
- * const sdk = await Accelbyte.SDK(..)
- *
- * // provide custom axios args
- * const options = { baseUrl: 'http://service.url', headers: {  customHeader1: 'dummy1' } }
- *
- * // obtain the service
- * const {response, error} = sdk.iam.getUser(options)
- * const {response, error} = sdk.iam.postWhatever(options)
- * ----------------
+var BuildinfoVersion = {
+    title: 'buildinfo',
+    name: 'justice-buildinfo-service',
+    version: '3.28.2',
+    buildDate: '2023-02-22T00:53:23.199Z'
+};
+
+/*
+ * Copyright (c) 2023 AccelByte Inc. All Rights Reserved
+ * This is licensed software from AccelByte Inc, for limitations
+ * and restrictions contact your company contract manager.
  */
+var EventVersion = {
+    title: 'event',
+    name: 'justice-event-log-service',
+    version: undefined,
+    buildDate: '2023-02-22T00:53:23.199Z'
+};
+
+/*
+ * Copyright (c) 2023 AccelByte Inc. All Rights Reserved
+ * This is licensed software from AccelByte Inc, for limitations
+ * and restrictions contact your company contract manager.
+ */
+var GdprVersion = {
+    title: 'gdpr',
+    name: 'justice-gdpr-service',
+    version: '1.19.1',
+    buildDate: '2023-02-22T00:53:23.199Z'
+};
+
+/*
+ * Copyright (c) 2023 AccelByte Inc. All Rights Reserved
+ * This is licensed software from AccelByte Inc, for limitations
+ * and restrictions contact your company contract manager.
+ */
+var IamVersion = {
+    title: 'iam',
+    name: 'justice-iam-service',
+    version: '5.28.0',
+    buildDate: '2023-02-22T00:53:23.199Z'
+};
+
+/*
+ * Copyright (c) 2023 AccelByte Inc. All Rights Reserved
+ * This is licensed software from AccelByte Inc, for limitations
+ * and restrictions contact your company contract manager.
+ */
+var LegalVersion = {
+    title: 'legal',
+    name: 'justice-legal-service',
+    version: '1.27.0',
+    buildDate: '2023-02-22T00:53:23.199Z'
+};
+
+/*
+ * Copyright (c) 2023 AccelByte Inc. All Rights Reserved
+ * This is licensed software from AccelByte Inc, for limitations
+ * and restrictions contact your company contract manager.
+ */
+var OdinConfigVersion = {
+    title: 'odin-config',
+    name: 'config-service-app',
+    version: 'dev',
+    buildDate: '2023-02-22T00:53:23.199Z'
+};
+
+/*
+ * Copyright (c) 2023 AccelByte Inc. All Rights Reserved
+ * This is licensed software from AccelByte Inc, for limitations
+ * and restrictions contact your company contract manager.
+ */
+var PlatformVersion = {
+    title: 'platform',
+    name: 'justice-platform-service',
+    version: '4.24.0',
+    buildDate: '2023-02-22T00:53:23.199Z'
+};
+
+/*
+ * Copyright (c) 2022-2023 AccelByte Inc. All Rights Reserved
+ * This is licensed software from AccelByte Inc, for limitations
+ * and restrictions contact your company contract manager.
+ */
+const TIMEOUT_TO_DIAGNOSTICS = 1000; // 1 sec
 class AccelbyteSDKFactory {
     constructor(options, config, events) {
+        /**
+         * Diagnose all services by comparing them with the sdk codegen versions and raise a WARN log if mismatch
+         */
+        this.doVersionDiagnostics = () => {
+            const mapServices = {
+                [IamVersion.name]: IamVersion,
+                [BuildinfoVersion.name]: BuildinfoVersion,
+                [PlatformVersion.name]: PlatformVersion,
+                [GdprVersion.name]: GdprVersion,
+                [EventVersion.name]: EventVersion
+            };
+            /* Call /<service-name>/version to pull service version
+              GET https://development.accelbyte.io/iam/version
+              {
+                "buildDate": "2023-02-22T04:12:23+00:00",
+                "gitHash": "abc",
+                "name": "justice-iam-service",
+                "realm": "dev",
+                "version": "5.28.0"
+              }
+             */
+            const axiosRequest = service_ => Network.create(this.config).get(`/${service_.title}/version`);
+            Promise.all([
+                axiosRequest(IamVersion),
+                axiosRequest(BuildinfoVersion),
+                axiosRequest(BasicVersion),
+                axiosRequest(PlatformVersion),
+                axiosRequest(GdprVersion),
+                axiosRequest(EventVersion)
+            ]).then(values => {
+                values.forEach(res => {
+                    const remoteService = res.data;
+                    const sdkService = mapServices[remoteService.name];
+                    if (sdkService?.version !== remoteService.version) {
+                        console.log(`WARN: SDK(${sdkService.title}) v${sdkService.version} doesn't match service version ${remoteService.version}`);
+                    }
+                });
+            });
+        };
         this.getRefreshToken = () => this.refreshToken;
         this.getConfig = () => this.config;
         this.mergeConfigs = (configOverride) => {
@@ -9744,7 +9860,6 @@ class AccelbyteSDKFactory {
             }
         };
         this.options = {
-            loglevel: 'INFO',
             cache: false,
             ...options
         };
@@ -9759,14 +9874,13 @@ class AccelbyteSDKFactory {
                 ...config?.headers
             }
         };
-        if (options.loglevel === exports.LogLevel.DEBUG) {
-            Logger.info('Accelbyte-SDK initialized with config', this.config);
-        }
+        // Logger.info('Accelbyte-SDK initialized with config', this.config)
     }
     init() {
         const { baseURL, clientId } = this.options;
         injectAuthInterceptors(clientId, this.getConfig, this.events?.onSessionExpired, this.events?.onGetUserSession, this.getRefreshToken);
         injectErrorInterceptors(baseURL, this.events?.onUserEligibilityChange, this.events?.onError);
+        setTimeout(() => this.doVersionDiagnostics, TIMEOUT_TO_DIAGNOSTICS);
         return {
             refreshTokens: (accessToken, refreshToken) => this.refreshTokensImpl(accessToken, refreshToken),
             IAM: {
@@ -9775,18 +9889,21 @@ class AccelbyteSDKFactory {
                 OAuth: (overrides) => ApiFactory.oauthApi(this.config, this.options, this.options.namespace, this.override(overrides)),
                 InputValidations: (overrides) => ApiFactory.inputValidationsApi(this.config, this.options.namespace, this.override(overrides)),
                 ThirdPartyCredential: (overrides) => ApiFactory.thirdPartyCredentialApi(this.config, this.options.namespace, this.override(overrides)),
-                TwoFA: (overrides) => ApiFactory.twoFAApi(this.config, this.options.namespace, this.override(overrides))
+                TwoFA: (overrides) => ApiFactory.twoFAApi(this.config, this.options.namespace, this.override(overrides)),
+                version: IamVersion
             },
             BuildInfo: {
                 Downloader: (overrides) => ApiFactory.downloaderApi(this.config, this.options.namespace, this.override(overrides)),
                 Caching: (overrides) => ApiFactory.cachingApi(this.config, this.options.namespace, this.override(overrides)),
-                DLC: (overrides) => ApiFactory.dlcApi(this.config, this.options.namespace, this.override(overrides))
+                DLC: (overrides) => ApiFactory.dlcApi(this.config, this.options.namespace, this.override(overrides)),
+                version: BuildinfoVersion
             },
             Basic: {
                 Misc: (overrides) => ApiFactory.miscApi(this.config, this.options.namespace, this.override(overrides)),
                 UserProfile: (overrides) => ApiFactory.userProfileApi(this.config, this.options.namespace, this.override(overrides)),
                 FileUpload: (overrides) => ApiFactory.fileUploadApi(this.config, this.options.namespace, this.override(overrides)),
-                Namespace: (overrides) => ApiFactory.namespaceApi(this.config, this.options.namespace, this.override(overrides))
+                Namespace: (overrides) => ApiFactory.namespaceApi(this.config, this.options.namespace, this.override(overrides)),
+                version: BasicVersion
             },
             Platform: {
                 Currency: (overrides) => ApiFactory.currencyApi(this.config, this.options.namespace, this.override(overrides)),
@@ -9796,35 +9913,35 @@ class AccelbyteSDKFactory {
                 Order: (overrides) => ApiFactory.orderApi(this.config, this.options.namespace, this.override(overrides)),
                 Payment: (overrides) => ApiFactory.paymentApi(this.config, this.options.namespace, this.override(overrides)),
                 Subscription: (overrides) => ApiFactory.subscriptionApi(this.config, this.options.namespace, this.override(overrides)),
-                Wallet: (overrides) => ApiFactory.walletApi(this.config, this.options.namespace, this.override(overrides))
+                Wallet: (overrides) => ApiFactory.walletApi(this.config, this.options.namespace, this.override(overrides)),
+                version: PlatformVersion
             },
             Legal: {
                 Eligibilities: (overrides) => ApiFactory.eligibillitiesApi(this.config, this.options.namespace, this.override(overrides)),
                 Agreement: (overrides) => ApiFactory.agreementApi(this.config, this.options.namespace, this.override(overrides)),
                 Policies: (overrides) => ApiFactory.policiesApi(this.config, this.options.namespace, this.override(overrides)),
-                LocalizedPolicyVersions: (overrides) => ApiFactory.localizedPolicyVersionsApi(this.config, this.options.namespace, this.override(overrides))
+                LocalizedPolicyVersions: (overrides) => ApiFactory.localizedPolicyVersionsApi(this.config, this.options.namespace, this.override(overrides)),
+                version: LegalVersion
             },
             GDPR: {
                 DataDeletion: (overrides) => ApiFactory.dataDeletionApi(this.config, this.options.namespace, this.override(overrides)),
-                DataRetrieval: (overrides) => ApiFactory.dataRetrievalApi(this.config, this.options.namespace, this.override(overrides))
+                DataRetrieval: (overrides) => ApiFactory.dataRetrievalApi(this.config, this.options.namespace, this.override(overrides)),
+                version: GdprVersion
             },
             Event: {
-                Event: (overrides) => ApiFactory.eventApi(this.config, this.options.namespace, this.override(overrides))
+                Event: (overrides) => ApiFactory.eventApi(this.config, this.options.namespace, this.override(overrides)),
+                version: EventVersion
             },
             AccelbyteConfig: {
-                PublicTemplate: (overrides) => ApiFactory.publicTemplateApi(this.config, this.options.namespace, this.override(overrides))
+                PublicTemplate: (overrides) => ApiFactory.publicTemplateApi(this.config, this.options.namespace, this.override(overrides)),
+                version: OdinConfigVersion
             }
         };
     }
 }
 const sdkInit = ({ options, config, onEvents }) => {
-    if (options.loglevel === exports.LogLevel.DEBUG) {
-        Logger.info('Accelbyte-SDK instantiated:', options);
-    }
+    Logger.info('Accelbyte-SDK instantiated:', options);
     const sdkFactory = new AccelbyteSDKFactory(options, config, onEvents);
-    if (options.loglevel === exports.LogLevel.DEBUG) {
-        Logger.info(`Accelbyte-SDK version: ${buildInfo.version} \nBuild: ${buildInfo.build} \nTimestamp: ${new Date(buildInfo.timestamp)}`);
-    }
     return sdkFactory.init();
 };
 // ts-prune-ignore-next