@accelbyte/sdk 0.0.0-dev-20240828055251 → 0.0.0-dev-20240904033042

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 import { AxiosRequestConfig, InternalAxiosRequestConfig, AxiosResponse, AxiosInstance, AxiosError } from 'axios';
-import { z, ZodError } from 'zod';
+import { ZodTypeAny, z, ZodError } from 'zod';
 
 type MakeOptional<Type, UnionKeys extends keyof Type> = Omit<Type, UnionKeys> & Partial<Pick<Type, UnionKeys>>;
 type MakeRequired<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
-};
+};
+declare function isType<T extends ZodTypeAny>(schema: T, data: unknown): data is z.infer<T>;
 
 interface CoreConfig {
     /**
@@ -56,6 +57,10 @@ interface SdkSetConfigParam {
 type ApiError = {
     errorCode: number | string;
     errorMessage: string;
+};
+type TokenConfig = {
+    accessToken?: string;
+    refreshToken?: string;
 };
 
 declare const AccelByte: {
@@ -65,6 +70,7 @@ declare class AccelByteSDK {
     private coreConfig;
     private axiosConfig;
     private axiosInstance;
+    private token;
     constructor({ coreConfig, axiosConfig }: SdkConstructorParam);
     assembly(): {
         axiosInstance: AxiosInstance;
@@ -78,6 +84,9 @@ declare class AccelByteSDK {
     removeInterceptors(): AccelByteSDK;
     removeInterceptors(filterCallback: (interceptor: Interceptor) => boolean): AccelByteSDK;
     setConfig({ coreConfig, axiosConfig }: SdkSetConfigParam): this;
+    setToken(token: TokenConfig): void;
+    removeToken(): void;
+    getToken(): TokenConfig;
 }
 
 declare enum IamErrorCode {
@@ -105,32 +114,32 @@ declare const ERROR_USER_BANNED = 10134;
 
 declare const TokenWithDeviceCookieResponseV3: z.ZodObject<{
     access_token: z.ZodString;
-    auth_trust_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    bans: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+    auth_trust_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    bans: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         ban: z.ZodString;
-        disabledDate: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        disabledDate: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         enabled: z.ZodBoolean;
         endDate: z.ZodString;
         targetedNamespace: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        disabledDate?: string | null | undefined;
         ban: string;
         enabled: boolean;
         endDate: string;
         targetedNamespace: string;
-    }, {
         disabledDate?: string | null | undefined;
+    }, {
         ban: string;
         enabled: boolean;
         endDate: string;
         targetedNamespace: string;
+        disabledDate?: string | null | undefined;
     }>, "many">>>;
-    display_name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     expires_in: z.ZodNumber;
-    is_comply: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
-    jflgs: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    is_comply: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    jflgs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     namespace: z.ZodString;
-    namespace_roles: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+    namespace_roles: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         namespace: z.ZodString;
         roleId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -143,42 +152,54 @@ declare const TokenWithDeviceCookieResponseV3: z.ZodObject<{
     permissions: z.ZodArray<z.ZodObject<{
         action: z.ZodNumber;
         resource: z.ZodString;
-        schedAction: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-        schedCron: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        schedRange: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+        schedAction: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        schedCron: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        schedRange: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
     }, "strip", z.ZodTypeAny, {
+        action: number;
+        resource: string;
         schedAction?: number | null | undefined;
         schedCron?: string | null | undefined;
         schedRange?: string[] | null | undefined;
+    }, {
         action: number;
         resource: string;
-    }, {
         schedAction?: number | null | undefined;
         schedCron?: string | null | undefined;
         schedRange?: string[] | null | undefined;
-        action: number;
-        resource: string;
     }>, "many">;
-    platform_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    platform_user_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    refresh_expires_in: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-    refresh_token: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    roles: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    platform_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    platform_user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    refresh_expires_in: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    refresh_token: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    roles: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
     scope: z.ZodString;
-    simultaneous_platform_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    simultaneous_platform_user_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    simultaneous_platform_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    simultaneous_platform_user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     token_type: z.ZodString;
-    unique_display_name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    user_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    xuid: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    unique_display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    xuid: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
+    namespace: string;
+    access_token: string;
+    expires_in: number;
+    permissions: {
+        action: number;
+        resource: string;
+        schedAction?: number | null | undefined;
+        schedCron?: string | null | undefined;
+        schedRange?: string[] | null | undefined;
+    }[];
+    scope: string;
+    token_type: string;
     auth_trust_id?: string | null | undefined;
     bans?: {
-        disabledDate?: string | null | undefined;
         ban: string;
         enabled: boolean;
         endDate: string;
         targetedNamespace: string;
+        disabledDate?: string | null | undefined;
     }[] | null | undefined;
     display_name?: string | null | undefined;
     is_comply?: boolean | null | undefined;
@@ -197,26 +218,26 @@ declare const TokenWithDeviceCookieResponseV3: z.ZodObject<{
     unique_display_name?: string | null | undefined;
     user_id?: string | null | undefined;
     xuid?: string | null | undefined;
+}, {
     namespace: string;
     access_token: string;
     expires_in: number;
     permissions: {
+        action: number;
+        resource: string;
         schedAction?: number | null | undefined;
         schedCron?: string | null | undefined;
         schedRange?: string[] | null | undefined;
-        action: number;
-        resource: string;
     }[];
     scope: string;
     token_type: string;
-}, {
     auth_trust_id?: string | null | undefined;
     bans?: {
-        disabledDate?: string | null | undefined;
         ban: string;
         enabled: boolean;
         endDate: string;
         targetedNamespace: string;
+        disabledDate?: string | null | undefined;
     }[] | null | undefined;
     display_name?: string | null | undefined;
     is_comply?: boolean | null | undefined;
@@ -235,18 +256,6 @@ declare const TokenWithDeviceCookieResponseV3: z.ZodObject<{
     unique_display_name?: string | null | undefined;
     user_id?: string | null | undefined;
     xuid?: string | null | undefined;
-    namespace: string;
-    access_token: string;
-    expires_in: number;
-    permissions: {
-        schedAction?: number | null | undefined;
-        schedCron?: string | null | undefined;
-        schedRange?: string[] | null | undefined;
-        action: number;
-        resource: string;
-    }[];
-    scope: string;
-    token_type: string;
 }>;
 interface TokenWithDeviceCookieResponseV3 extends z.TypeOf<typeof TokenWithDeviceCookieResponseV3> {
 }
@@ -273,17 +282,89 @@ declare class DecodeError extends Error {
     });
 }
 
+declare enum GrantTokenUrls {
+    GRANT_TOKEN = "/iam/v3/oauth/token",
+    GRANT_TOKEN_V4 = "/iam/v4/oauth/token"
+}
+type GrantTokenUrlString = `${GrantTokenUrls}`;
 type RefreshArgs = {
     axiosConfig: AxiosRequestConfig;
     refreshToken?: string;
     clientId: string;
+    tokenUrl?: GrantTokenUrlString;
 };
-declare const refreshWithLock: ({ axiosConfig, refreshToken, clientId }: RefreshArgs) => Promise<Partial<TokenWithDeviceCookieResponseV3> | false>;
-declare const doRefreshSession: ({ axiosConfig, clientId, refreshToken }: RefreshArgs) => () => Promise<false | TokenWithDeviceCookieResponseV3>;
+declare const refreshWithLock: ({ axiosConfig, refreshToken, clientId, tokenUrl }: RefreshArgs) => Promise<Partial<TokenWithDeviceCookieResponseV3> | false>;
+declare const doRefreshSession: ({ axiosConfig, clientId, refreshToken, tokenUrl }: RefreshArgs) => () => Promise<false | TokenWithDeviceCookieResponseV3>;
 /**
- * Not sure if we can separate the auth error interceptor from the response interceptor
+ * If there's any config change between interceptors,
+ * The interceptors should be placed sequentially.
+ * For example, if session expired depend on the new config from get-session,
+ * the interceptors should placed like this:
+ * - refresh-session
+ * - get-session
+ * - session-expired
+ *
+ * @see: https://github.com/axios/axios#multiple-interceptors
  */
-declare const AuthInterceptors: Array<Interceptor>;
+type RefreshSessioNInterceptorOptions = {
+    /**
+     * The URL endpoint for obtaining a new token. Defaults to `'/iam/v3/oauth/token'`.
+     */
+    tokenUrl?: GrantTokenUrlString;
+};
+declare const createRefreshSessionInterceptor: (options?: RefreshSessioNInterceptorOptions) => Interceptor;
+type GetSessionInterceptorOptions = {
+    /**
+     * The URL endpoint for obtaining a new token. Defaults to `'/iam/v3/oauth/token'`.
+     */
+    tokenUrl?: GrantTokenUrlString;
+    /**
+     * A callback function triggered when successfully get new session.
+     */
+    onGetUserSession: (accessToken: string, refreshToken: string) => void;
+};
+declare const createGetSessionInterceptor: ({ tokenUrl, onGetUserSession }: GetSessionInterceptorOptions) => Interceptor;
+type SessionExpiredInterceptorOptions = {
+    /**
+     * The client ID used by the SDK, obtained from the Admin Portal under OAuth Clients.
+     */
+    clientId: string;
+    /**
+     * A callback function triggered when the session has expired.
+     */
+    onSessionExpired: () => void;
+    /**
+     * An optional array of URLs that should be ignored when handling session expiration.
+     * Default to `['/iam/v3/oauth/token', '/iam/v4/oauth/token', '/iam/v3/oauth/revoke']`
+     */
+    expectedErrorUrls?: string[];
+    /**
+     * A callback function that retrieves the current refresh token.
+     */
+    getRefreshToken: () => string | undefined;
+    /**
+     * The URL endpoint for obtaining a new token. Defaults to `'/iam/v3/oauth/token'`.
+     */
+    tokenUrl?: GrantTokenUrlString;
+};
+declare const createSessionExpiredInterceptor: ({ clientId, onSessionExpired, expectedErrorUrls, getRefreshToken, tokenUrl }: SessionExpiredInterceptorOptions) => Interceptor;
+
+declare const BASE_PATHS: readonly ["/achievement", "/basic", "/buildinfo", "/chat", "/cloudsave", "/content-management", "/differ", "/dsmcontroller", "/event", "/game-telemetry", "/gdpr", "/group", "/iam", "/leaderboard", "/agreement", "/lobby", "/match2", "/matchmaking", "/odin-config", "/platform", "/qosm", "/reporting", "/seasonpass", "/session", "/sessionbrowser", "/social", "/ugc", "/config"];
+type BasePath = (typeof BASE_PATHS)[number] | (string & {});
+
+type CreateCustomPathInterceptorOptions = {
+    /**
+     * A list of objects specifying which service base paths should be replaced.
+     * For example, providing `{'/iam': '/iam-test'}` will redirect all `'/iam'` requests to `'/iam-test'`.
+     */
+    basePath: Partial<Record<BasePath, string>>;
+    /**
+     * Indicates whether to use the internal AccelByte network. This should only be used in a server environment.
+     * When set to true, requests will be made to `http://{service-name}/{path}` instead of the `baseURL`.
+     */
+    isInternalNetwork?: boolean;
+};
+declare const createCustomPathInterceptor: ({ basePath, isInternalNetwork }: CreateCustomPathInterceptorOptions) => Interceptor;
 
 declare const ErrorInterceptors: Array<Interceptor>;
 
@@ -352,4 +433,4 @@ declare class UrlHelper {
     static removeQueryParam(fullUrlString: string, param: string): string;
 }
 
-export { AccelByte, AccelByteSDK, type ApiError, ApiUtils, AuthInterceptors, type AxiosConfig, BrowserHelper, CodeGenUtil, type CoreConfig, DecodeError, DesktopChecker, ERROR_CODE_LINK_DELETION_ACCOUNT, ERROR_CODE_TOKEN_EXPIRED, ERROR_LINK_ANOTHER_3RD_PARTY_ACCOUNT, ERROR_USER_BANNED, ErrorInterceptors, IamErrorCode, type Interceptor, Network, RefreshSession, type Response, type ResponseError, type SdkConstructorParam, SdkDevice, type SdkSetConfigParam, UrlHelper, Validate, doRefreshSession, refreshWithLock };
+export { AccelByte, AccelByteSDK, type ApiError, ApiUtils, type AxiosConfig, BrowserHelper, CodeGenUtil, type CoreConfig, DecodeError, DesktopChecker, ERROR_CODE_LINK_DELETION_ACCOUNT, ERROR_CODE_TOKEN_EXPIRED, ERROR_LINK_ANOTHER_3RD_PARTY_ACCOUNT, ERROR_USER_BANNED, ErrorInterceptors, IamErrorCode, type Interceptor, type MakeOptional, type MakeRequired, Network, RefreshSession, type Response, type ResponseError, type SdkConstructorParam, SdkDevice, type SdkSetConfigParam, type TokenConfig, UrlHelper, Validate, createCustomPathInterceptor, createGetSessionInterceptor, createRefreshSessionInterceptor, createSessionExpiredInterceptor, doRefreshSession, isType, refreshWithLock };

package/package.json

@@ -1,9 +1,21 @@
 {
   "name": "@accelbyte/sdk",
-  "version": "0.0.0-dev-20240828055251",
+  "version": "0.0.0-dev-20240904033042",
   "author": "AccelByte Inc",
   "license": "SEE LICENSE IN LICENSE",
-  "main": "./src/index.ts",
+  "main": "./dist/cjs/node/index.cjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "node": {
+        "import": "./dist/es/node/index.node.js",
+        "default": "./dist/cjs/node/index.cjs"
+      },
+      "default": "./dist/es/browser/index.browser.js"
+    },
+    "./package.json": "./package.json"
+  },
   "type": "module",
   "repository": {
     "type": "git",
@@ -13,18 +25,20 @@
     "build": "tsup && yarn build:dts",
     "build:dts": "tsup src/index.ts --no-config  --dts-only --format esm",
     "test": "yarn test:unit",
-    "test:unit": "vitest",
+    "test:unit": "vitest --testTimeout=15000",
     "test:e2e": "playwright test",
     "clean": "npx rimraf dist && npx rimraf node_modules"
   },
   "devDependencies": {
+    "@anatine/zod-mock": "3.13.4",
+    "@faker-js/faker": "8.4.1",
     "@playwright/test": "1.28.0",
     "@types/crypto-js": "4.1.0",
     "@types/node": "22.3.0",
     "@types/platform": "1.3.4",
     "@types/uuid": "8.3.4",
     "happy-dom": "8.2.6",
-    "msw": "0.48.2",
+    "msw": "2.4.1",
     "rimraf": "4.1.2",
     "rollup": "3.29.4",
     "tslib": "2.4.0",
@@ -33,7 +47,7 @@
     "vitest": "2.0.5"
   },
   "dependencies": {
-    "@accelbyte/validator": "0.0.0-dev-20240828055251",
+    "@accelbyte/validator": "0.0.0-dev-20240904033042",
     "axios": "1.3.6",
     "buffer": "6.0.3",
     "crypto-js": "4.1.1",
@@ -42,7 +56,7 @@
     "query-string": "7.1.1",
     "uuid": "8.3.2",
     "validator": "13.7.0",
-    "zod": "3.17.3"
+    "zod": "3.23.8"
   },
   "sideEffects": [
     "src/polyfills/browser.ts",