@growi/sdk-typescript 1.7.0 → 1.8.0

package/src/utils/v3/axios-instance.test.ts

@@ -1,4 +1,4 @@
-import type { AxiosRequestConfig, AxiosResponse } from 'axios';
+import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 import Axios from 'axios';
 /**
  * Tests for v3/axios-instance.ts
@@ -7,15 +7,15 @@ import Axios from 'axios';
  * including automatic base URL configuration (with v3 suffix), cancellation capability, and request configuration merging.
  */
 import { type MockedFunction, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { AXIOS_DEFAULT } from '../axios-default-instance.js';
+import { axiosInstanceManager } from '../axios-instance-manager.js';
 import { customInstance } from './axios-instance.js';
 
 // Mock Axios
 vi.mock('axios');
-vi.mock('../axios-default-instance.js');
+vi.mock('../axios-instance-manager.js');
 
 const mockedAxios = vi.mocked(Axios);
-const mockedAXIOS_DEFAULT = vi.mocked(AXIOS_DEFAULT);
+const mockedAxiosInstanceManager = vi.mocked(axiosInstanceManager);
 
 // Type for the promise returned by customInstance with cancel functionality
 type CancellablePromise<T> = Promise<T> & {
@@ -51,9 +51,9 @@ describe('v3 customInstance', () => {
       config: {},
     } as AxiosResponse<{ result: string }>);
 
-    // Mock for AXIOS_DEFAULT
-    mockedAXIOS_DEFAULT.instance = mockAxiosInstance as unknown as typeof AXIOS_DEFAULT.instance;
-    Object.defineProperty(mockedAXIOS_DEFAULT.instance, 'defaults', {
+    // Create a mock AxiosInstance with defaults
+    const mockInstance = mockAxiosInstance as unknown as AxiosInstance;
+    Object.defineProperty(mockInstance, 'defaults', {
       value: {
         baseURL: 'http://localhost',
         headers: {
@@ -69,6 +69,9 @@ describe('v3 customInstance', () => {
       writable: true,
       configurable: true,
     });
+
+    // Mock for axiosInstanceManager
+    mockedAxiosInstanceManager.getAxiosInstance.mockReturnValue(mockInstance);
   });
 
   afterEach(() => {
@@ -81,7 +84,7 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
 
       // Act
-      await customInstance(config);
+      await customInstance(config, { appName: 'testApp' });
 
       // Assert
       expect(mockAxiosInstance).toHaveBeenCalledWith(
@@ -98,7 +101,7 @@ describe('v3 customInstance', () => {
       const options: AxiosRequestConfig = { baseURL: 'https://custom.example.com' };
 
       // Act
-      await customInstance(config, options);
+      await customInstance(config, { appName: 'testApp', axiosOptions: options });
 
       // Assert
       expect(mockAxiosInstance).toHaveBeenCalledWith(
@@ -117,7 +120,7 @@ describe('v3 customInstance', () => {
       };
 
       // Act
-      await customInstance(config);
+      await customInstance(config, { appName: 'testApp' });
 
       // Assert
       expect(mockAxiosInstance).toHaveBeenCalledWith(
@@ -129,11 +132,18 @@ describe('v3 customInstance', () => {
 
     it('should set only _api/v3 when baseURL is empty string', async () => {
       // Arrange
-      mockedAXIOS_DEFAULT.instance.defaults.baseURL = '';
+      const mockInstance = mockAxiosInstance as unknown as AxiosInstance;
+      Object.defineProperty(mockInstance, 'defaults', {
+        value: { baseURL: '' },
+        writable: true,
+        configurable: true,
+      });
+      mockedAxiosInstanceManager.getAxiosInstance.mockReturnValue(mockInstance);
+
       const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
 
       // Act
-      await customInstance(config);
+      await customInstance(config, { appName: 'testApp' });
 
       // Assert
       expect(mockAxiosInstance).toHaveBeenCalledWith(
@@ -158,7 +168,7 @@ describe('v3 customInstance', () => {
       };
 
       // Act
-      await customInstance(config, options);
+      await customInstance(config, { appName: 'testApp', axiosOptions: options });
 
       // Assert
       expect(mockAxiosInstance).toHaveBeenCalledWith(
@@ -187,7 +197,7 @@ describe('v3 customInstance', () => {
       };
 
       // Act
-      await customInstance(config, options);
+      await customInstance(config, { appName: 'testApp', axiosOptions: options });
 
       // Assert
       expect(mockAxiosInstance).toHaveBeenCalledWith(
@@ -221,7 +231,7 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'GET', url: '/pages' };
 
       // Act
-      const result = await customInstance(config);
+      const result = await customInstance(config, { appName: 'testApp' });
 
       // Assert
       expect(result).toEqual(expectedData);
@@ -241,7 +251,7 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'DELETE', url: '/pages/1' };
 
       // Act
-      const result = await customInstance(config);
+      const result = await customInstance(config, { appName: 'testApp' });
 
       // Assert
       expect(result).toBeNull();
@@ -254,7 +264,7 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
 
       // Act
-      const promise = customInstance(config) as CancellablePromise<unknown>;
+      const promise = customInstance(config, { appName: 'testApp' }) as CancellablePromise<unknown>;
 
       // Assert
       expect(promise).toHaveProperty('cancel');
@@ -269,7 +279,7 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
 
       // Act
-      const promise = customInstance(config) as CancellablePromise<unknown>;
+      const promise = customInstance(config, { appName: 'testApp' }) as CancellablePromise<unknown>;
       promise.cancel();
 
       // Assert
@@ -281,8 +291,8 @@ describe('v3 customInstance', () => {
 
     it('should allow cancellation during request execution', async () => {
       // Arrange
-      let resolveRequest: (value: unknown) => void = () => {};
-      const requestPromise = new Promise((resolve) => {
+      let resolveRequest: (value: AxiosResponse<unknown>) => void = () => {};
+      const requestPromise = new Promise<AxiosResponse<unknown>>((resolve) => {
         resolveRequest = resolve;
       });
 
@@ -291,7 +301,7 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'GET', url: '/long-request' };
 
       // Act
-      const promise = customInstance(config) as CancellablePromise<unknown>;
+      const promise = customInstance(config, { appName: 'testApp' }) as CancellablePromise<unknown>;
       promise.cancel();
 
       // Assert
@@ -299,7 +309,7 @@ describe('v3 customInstance', () => {
 
       // cleanup
       if (resolveRequest) {
-        resolveRequest({ data: 'test' });
+        resolveRequest({ data: 'test' } as AxiosResponse<unknown>);
       }
       await promise;
     });
@@ -314,7 +324,7 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'GET', url: '/invalid' };
 
       // Act & Assert
-      await expect(customInstance(config)).rejects.toThrow('API v3 endpoint not found');
+      await expect(customInstance(config, { appName: 'testApp' })).rejects.toThrow('API v3 endpoint not found');
     });
 
     it('should handle network errors appropriately', async () => {
@@ -326,7 +336,15 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
 
       // Act & Assert
-      await expect(customInstance(config)).rejects.toThrow('Network Error');
+      await expect(customInstance(config, { appName: 'testApp' })).rejects.toThrow('Network Error');
+    });
+
+    it('should throw error when appName is not provided', () => {
+      // Arrange
+      const config: AxiosRequestConfig = { method: 'GET', url: '/test' };
+
+      // Act & Assert
+      expect(() => customInstance(config)).toThrow('appName is required');
     });
   });
 
@@ -356,7 +374,7 @@ describe('v3 customInstance', () => {
       const config: AxiosRequestConfig = { method: 'GET', url: '/user/1' };
 
       // Act
-      const result = await customInstance<User>(config);
+      const result = await customInstance<User>(config, { appName: 'testApp' });
 
       // Assert
       expect(result).toEqual(expectedUser);

package/src/utils/v3/axios-instance.ts

@@ -1,15 +1,22 @@
 import Axios, { type AxiosRequestConfig } from 'axios';
-import { AXIOS_DEFAULT } from '../axios-default-instance.js';
+import { axiosInstanceManager } from '../axios-instance-manager.js';
+import type { CustomInstanceOptions } from '../types/custom-instance.js';
+
+export const customInstance = <T>(config: AxiosRequestConfig, options?: CustomInstanceOptions): Promise<T> => {
+  const { appName, axiosOptions } = options ?? {};
+
+  if (appName == null) {
+    throw new Error('appName is required');
+  }
 
-export const customInstance = <T>(config: AxiosRequestConfig, options?: AxiosRequestConfig): Promise<T> => {
   const source = Axios.CancelToken.source();
 
-  const defaultInstance = AXIOS_DEFAULT.instance;
-  const baseURL = `${options?.baseURL ?? config?.baseURL ?? defaultInstance.defaults.baseURL ?? ''}/_api/v3`;
+  const instance = axiosInstanceManager.getAxiosInstance(appName);
+  const baseURL = `${axiosOptions?.baseURL ?? config?.baseURL ?? instance.defaults.baseURL ?? ''}/_api/v3`;
 
-  const promise = AXIOS_DEFAULT.instance({
+  const promise = instance({
     ...config,
-    ...options,
+    ...axiosOptions,
     baseURL,
     cancelToken: source.token,
   }).then(({ data }) => data);

package/dist/utils/axios-default-instance.d.ts

@@ -1,14 +0,0 @@
-export declare const AXIOS_DEFAULT: {
-    instance: import("axios").AxiosInstance;
-    /**
-     * Set the base URL for the default Axios instance.
-     * @param baseURL The base URL to set for the Axios instance.
-     */
-    setBaseURL: (baseURL: string) => void;
-    /**
-     * Set the Authorization header for the default Axios instance.
-     * @param token The authentication token to set in the Authorization header.
-     */
-    setAuthorizationHeader: (token: string) => void;
-};
-//# sourceMappingURL=axios-default-instance.d.ts.map

package/dist/utils/axios-default-instance.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"axios-default-instance.d.ts","sourceRoot":"","sources":["../../src/utils/axios-default-instance.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa;;IAExB;;;OAGG;0BACmB,MAAM,KAAG,IAAI;IAGnC;;;OAGG;oCAC6B,MAAM,KAAG,IAAI;CAG9C,CAAC"}

package/dist/utils/axios-default-instance.js

@@ -1,22 +0,0 @@
-import Axios from 'axios';
-const DEFAULT_AXIOS_INSTANCE = Axios.create({
-    baseURL: 'http://localhost', // set baseURL if you need
-});
-export const AXIOS_DEFAULT = {
-    instance: DEFAULT_AXIOS_INSTANCE,
-    /**
-     * Set the base URL for the default Axios instance.
-     * @param baseURL The base URL to set for the Axios instance.
-     */
-    setBaseURL: (baseURL) => {
-        DEFAULT_AXIOS_INSTANCE.defaults.baseURL = baseURL;
-    },
-    /**
-     * Set the Authorization header for the default Axios instance.
-     * @param token The authentication token to set in the Authorization header.
-     */
-    setAuthorizationHeader: (token) => {
-        DEFAULT_AXIOS_INSTANCE.defaults.headers.common.Authorization = `Bearer ${token}`;
-    },
-};
-//# sourceMappingURL=axios-default-instance.js.map

package/dist/utils/axios-default-instance.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"axios-default-instance.js","sourceRoot":"","sources":["../../src/utils/axios-default-instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAkC,MAAM,OAAO,CAAC;AAEvD,MAAM,sBAAsB,GAAG,KAAK,CAAC,MAAM,CAAC;IAC1C,OAAO,EAAE,kBAAkB,EAAE,0BAA0B;CACxD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,QAAQ,EAAE,sBAAsB;IAChC;;;OAGG;IACH,UAAU,EAAE,CAAC,OAAe,EAAQ,EAAE;QACpC,sBAAsB,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IACpD,CAAC;IACD;;;OAGG;IACH,sBAAsB,EAAE,CAAC,KAAa,EAAQ,EAAE;QAC9C,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAC;IACnF,CAAC;CACF,CAAC"}

package/src/utils/axios-default-instance.test.ts

@@ -1,108 +0,0 @@
-import type { AxiosInstance } from 'axios';
-/**
- * Tests for axios-default-instance.ts
- *
- * This file manages the default Axios instance for GROWI SDK,
- * providing functionality to configure base URL and authentication headers.
- */
-import { beforeEach, describe, expect, it, vi } from 'vitest';
-import { AXIOS_DEFAULT } from './axios-default-instance.js';
-
-describe('AXIOS_DEFAULT', () => {
-  beforeEach(() => {
-    // Reset the instance before each test
-    AXIOS_DEFAULT.instance.defaults.baseURL = 'http://localhost';
-    AXIOS_DEFAULT.instance.defaults.headers.common.Authorization = undefined;
-  });
-
-  describe('setBaseURL', () => {
-    it('should update base URL when setting a valid URL', () => {
-      // Arrange
-      const newBaseURL = 'https://api.example.com';
-
-      // Act
-      AXIOS_DEFAULT.setBaseURL(newBaseURL);
-
-      // Assert
-      expect(AXIOS_DEFAULT.instance.defaults.baseURL).toBe(newBaseURL);
-    });
-
-    it('should set base URL to empty string when empty string is provided', () => {
-      // Arrange
-      const emptyURL = '';
-
-      // Act
-      AXIOS_DEFAULT.setBaseURL(emptyURL);
-
-      // Assert
-      expect(AXIOS_DEFAULT.instance.defaults.baseURL).toBe(emptyURL);
-    });
-
-    it('should use the last value when called multiple times', () => {
-      // Arrange
-      const firstURL = 'https://first.example.com';
-      const secondURL = 'https://second.example.com';
-
-      // Act
-      AXIOS_DEFAULT.setBaseURL(firstURL);
-      AXIOS_DEFAULT.setBaseURL(secondURL);
-
-      // Assert
-      expect(AXIOS_DEFAULT.instance.defaults.baseURL).toBe(secondURL);
-    });
-  });
-
-  describe('setAuthorizationHeader', () => {
-    it('should set authorization header in Bearer token format when valid token is provided', () => {
-      // Arrange
-      const token = 'test-token-123';
-      const expectedHeader = `Bearer ${token}`;
-
-      // Act
-      AXIOS_DEFAULT.setAuthorizationHeader(token);
-
-      // Assert
-      expect(AXIOS_DEFAULT.instance.defaults.headers.common.Authorization).toBe(expectedHeader);
-    });
-
-    it('should set Bearer header with empty string when empty token is provided', () => {
-      // Arrange
-      const emptyToken = '';
-      const expectedHeader = 'Bearer ';
-
-      // Act
-      AXIOS_DEFAULT.setAuthorizationHeader(emptyToken);
-
-      // Assert
-      expect(AXIOS_DEFAULT.instance.defaults.headers.common.Authorization).toBe(expectedHeader);
-    });
-
-    it('should use the last token when called multiple times', () => {
-      // Arrange
-      const firstToken = 'first-token';
-      const secondToken = 'second-token';
-      const expectedHeader = `Bearer ${secondToken}`;
-
-      // Act
-      AXIOS_DEFAULT.setAuthorizationHeader(firstToken);
-      AXIOS_DEFAULT.setAuthorizationHeader(secondToken);
-
-      // Assert
-      expect(AXIOS_DEFAULT.instance.defaults.headers.common.Authorization).toBe(expectedHeader);
-    });
-  });
-
-  describe('instance', () => {
-    it('should have default base URL set to localhost', () => {
-      // Assert
-      expect(AXIOS_DEFAULT.instance.defaults.baseURL).toBe('http://localhost');
-    });
-
-    it('should have Axios instance properly created', () => {
-      // Assert
-      expect(AXIOS_DEFAULT.instance).toBeDefined();
-      expect(typeof AXIOS_DEFAULT.instance).toBe('function');
-      expect(AXIOS_DEFAULT.instance.defaults).toBeDefined();
-    });
-  });
-});

package/src/utils/axios-default-instance.ts

@@ -1,23 +0,0 @@
-import Axios, { type AxiosRequestConfig } from 'axios';
-
-const DEFAULT_AXIOS_INSTANCE = Axios.create({
-  baseURL: 'http://localhost', // set baseURL if you need
-});
-
-export const AXIOS_DEFAULT = {
-  instance: DEFAULT_AXIOS_INSTANCE,
-  /**
-   * Set the base URL for the default Axios instance.
-   * @param baseURL The base URL to set for the Axios instance.
-   */
-  setBaseURL: (baseURL: string): void => {
-    DEFAULT_AXIOS_INSTANCE.defaults.baseURL = baseURL;
-  },
-  /**
-   * Set the Authorization header for the default Axios instance.
-   * @param token The authentication token to set in the Authorization header.
-   */
-  setAuthorizationHeader: (token: string): void => {
-    DEFAULT_AXIOS_INSTANCE.defaults.headers.common.Authorization = `Bearer ${token}`;
-  },
-};