@nocobase/sdk 0.11.1-alpha.5 → 0.12.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/sdk",
-  "version": "0.11.1-alpha.5",
+  "version": "0.12.0-alpha.1",
   "license": "Apache-2.0",
   "main": "lib",
   "module": "es/index.js",
@@ -12,5 +12,5 @@
   "devDependencies": {
     "axios-mock-adapter": "^1.20.0"
   },
-  "gitHead": "1dcfd15a7d95a40b0a2f60e1de19ec574066fb20"
+  "gitHead": "543dcc0216b7b1451b552b0f685bc3e0682f9d59"
 }

package/src/APIClient.ts

@@ -1,321 +0,0 @@
-import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import qs from 'qs';
-import getSubAppName from './getSubAppName';
-
-export interface ActionParams {
-  filterByTk?: any;
-  [key: string]: any;
-}
-
-type ResourceActionOptions<P = any> = {
-  resource?: string;
-  resourceOf?: any;
-  action?: string;
-  params?: P;
-};
-
-export interface IResource {
-  list?: (params?: ActionParams) => Promise<any>;
-  get?: (params?: ActionParams) => Promise<any>;
-  create?: (params?: ActionParams) => Promise<any>;
-  update?: (params?: ActionParams) => Promise<any>;
-  destroy?: (params?: ActionParams) => Promise<any>;
-  [key: string]: (params?: ActionParams) => Promise<any>;
-}
-
-export class Auth {
-  protected api: APIClient;
-
-  protected KEYS = {
-    locale: 'NOCOBASE_LOCALE',
-    role: 'NOCOBASE_ROLE',
-    token: 'NOCOBASE_TOKEN',
-    authenticator: 'NOCOBASE_AUTH',
-    theme: 'NOCOBASE_THEME',
-  };
-
-  protected options = {
-    locale: null,
-    role: null,
-    authenticator: null,
-    token: null,
-  };
-
-  constructor(api: APIClient) {
-    this.api = api;
-    this.initKeys();
-    this.api.axios.interceptors.request.use(this.middleware.bind(this));
-  }
-
-  initKeys() {
-    if (!window) {
-      return;
-    }
-    const appName = getSubAppName();
-    if (!appName) {
-      return;
-    }
-    this.KEYS['role'] = `${appName.toUpperCase()}_` + this.KEYS['role'];
-    this.KEYS['locale'] = `${appName.toUpperCase()}_` + this.KEYS['locale'];
-  }
-
-  get locale() {
-    return this.getLocale();
-  }
-
-  set locale(value: string) {
-    this.setLocale(value);
-  }
-
-  get role() {
-    return this.getRole();
-  }
-
-  set role(value: string) {
-    this.setRole(value);
-  }
-
-  get token() {
-    return this.getToken();
-  }
-
-  set token(value: string) {
-    this.setToken(value);
-  }
-
-  get authenticator() {
-    return this.getAuthenticator();
-  }
-
-  set authenticator(value: string) {
-    this.setAuthenticator(value);
-  }
-
-  getOption(key: string) {
-    if (!this.KEYS[key]) {
-      return;
-    }
-    return this.api.storage.getItem(this.KEYS[key]);
-  }
-
-  setOption(key: string, value?: string) {
-    if (!this.KEYS[key]) {
-      return;
-    }
-    this.options[key] = value;
-    return this.api.storage.setItem(this.KEYS[key], value || '');
-  }
-
-  getLocale() {
-    return this.getOption('locale');
-  }
-
-  setLocale(locale: string) {
-    this.setOption('locale', locale);
-  }
-
-  getRole() {
-    return this.getOption('role');
-  }
-
-  setRole(role: string) {
-    this.setOption('role', role);
-  }
-
-  getToken() {
-    return this.getOption('token');
-  }
-
-  setToken(token: string) {
-    this.setOption('token', token);
-  }
-
-  getAuthenticator() {
-    return this.getOption('authenticator');
-  }
-
-  setAuthenticator(authenticator: string) {
-    this.setOption('authenticator', authenticator);
-  }
-
-  middleware(config: AxiosRequestConfig) {
-    if (this.locale) {
-      config.headers['X-Locale'] = this.locale;
-    }
-    if (this.role) {
-      config.headers['X-Role'] = this.role;
-    }
-    if (this.authenticator && !config.headers['X-Authenticator']) {
-      config.headers['X-Authenticator'] = this.authenticator;
-    }
-    if (this.token) {
-      config.headers['Authorization'] = `Bearer ${this.token}`;
-    }
-    return config;
-  }
-
-  async signIn(values: any, authenticator?: string): Promise<AxiosResponse<any>> {
-    const response = await this.api.request({
-      method: 'post',
-      url: 'auth:signIn',
-      data: values,
-      headers: {
-        'X-Authenticator': authenticator,
-      },
-    });
-    const data = response?.data?.data;
-    this.setToken(data?.token);
-    this.setAuthenticator(authenticator);
-    return response;
-  }
-
-  async signUp(values: any, authenticator?: string): Promise<AxiosResponse<any>> {
-    return await this.api.request({
-      method: 'post',
-      url: 'auth:signUp',
-      data: values,
-      headers: {
-        'X-Authenticator': authenticator,
-      },
-    });
-  }
-
-  async signOut() {
-    const response = await this.api.request({
-      method: 'post',
-      url: 'auth:signOut',
-    });
-    this.setToken(null);
-    this.setRole(null);
-    this.setAuthenticator(null);
-    return response;
-  }
-}
-
-export abstract class Storage {
-  abstract clear(): void;
-  abstract getItem(key: string): string | null;
-  abstract removeItem(key: string): void;
-  abstract setItem(key: string, value: string): void;
-}
-
-export class MemoryStorage extends Storage {
-  items = new Map();
-
-  clear() {
-    this.items.clear();
-  }
-
-  getItem(key: string) {
-    return this.items.get(key);
-  }
-
-  setItem(key: string, value: string) {
-    return this.items.set(key, value);
-  }
-
-  removeItem(key: string) {
-    return this.items.delete(key);
-  }
-}
-
-interface ExtendedOptions {
-  authClass?: any;
-  storageClass?: any;
-}
-
-export type APIClientOptions = AxiosInstance | (AxiosRequestConfig & ExtendedOptions);
-
-export class APIClient {
-  axios: AxiosInstance;
-  auth: Auth;
-  storage: Storage;
-
-  constructor(instance?: APIClientOptions) {
-    if (typeof instance === 'function') {
-      this.axios = instance;
-    } else {
-      const { authClass, storageClass, ...others } = instance || {};
-      this.axios = axios.create(others);
-      this.initStorage(storageClass);
-      if (authClass) {
-        this.auth = new authClass(this);
-      }
-    }
-    if (!this.storage) {
-      this.initStorage();
-    }
-    if (!this.auth) {
-      this.auth = new Auth(this);
-    }
-    this.interceptors();
-  }
-
-  private initStorage(storage?: any) {
-    if (storage) {
-      this.storage = new storage(this);
-    } else if (typeof localStorage !== 'undefined') {
-      this.storage = localStorage;
-    } else {
-      this.storage = new MemoryStorage();
-    }
-  }
-
-  interceptors() {
-    this.axios.interceptors.request.use((config) => {
-      config.paramsSerializer = (params) => {
-        return qs.stringify(params, {
-          strictNullHandling: true,
-          arrayFormat: 'brackets',
-        });
-      };
-      return config;
-    });
-  }
-
-  request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D> | ResourceActionOptions): Promise<R> {
-    const { resource, resourceOf, action, params } = config as any;
-    if (resource) {
-      return this.resource(resource, resourceOf)[action](params);
-    }
-    return this.axios.request<T, R, D>(config);
-  }
-
-  resource(name: string, of?: any): IResource {
-    const target = {};
-    const handler = {
-      get: (_: any, actionName: string) => {
-        let url = name.split('.').join(`/${of || '_'}/`);
-        url += `:${actionName}`;
-        const config: AxiosRequestConfig = { url };
-        if (['get', 'list'].includes(actionName)) {
-          config['method'] = 'get';
-        } else {
-          config['method'] = 'post';
-        }
-        return async (params?: ActionParams, opts?: any) => {
-          const { values, filter, ...others } = params || {};
-          config['params'] = others;
-          if (filter) {
-            if (typeof filter === 'string') {
-              config['params']['filter'] = filter;
-            } else {
-              if (filter['*']) {
-                delete filter['*'];
-              }
-              config['params']['filter'] = JSON.stringify(filter);
-            }
-          }
-          if (config.method !== 'get') {
-            config['data'] = values || {};
-          }
-          return await this.request({
-            ...config,
-            ...opts,
-          });
-        };
-      },
-    };
-    return new Proxy(target, handler);
-  }
-}

package/src/__tests__/api-client.test.ts

@@ -1,124 +0,0 @@
-import { AxiosResponse } from 'axios';
-import MockAdapter from 'axios-mock-adapter';
-import { APIClient, Storage } from '../';
-import { Auth } from '../APIClient';
-
-describe('api-client', () => {
-  test('instance', async () => {
-    const api = new APIClient({
-      baseURL: 'https://localhost:8000/api',
-    });
-    const mock = new MockAdapter(api.axios);
-    mock.onGet('users:get').reply(200, {
-      data: { id: 1, name: 'John Smith' },
-    });
-    const response = await api.request({ url: 'users:get' });
-    expect(response.status).toBe(200);
-    expect(response.data).toMatchObject({
-      data: { id: 1, name: 'John Smith' },
-    });
-  });
-
-  test('signIn', async () => {
-    const api = new APIClient({
-      baseURL: 'https://localhost:8000/api',
-    });
-    const mock = new MockAdapter(api.axios);
-    mock.onPost('auth:signIn').reply(200, {
-      data: { id: 1, name: 'John Smith', token: '123' },
-    });
-    const response = await api.auth.signIn({}, 'basic');
-    expect(response.status).toBe(200);
-    expect(api.auth.getToken()).toBe('123');
-    const token = localStorage.getItem('NOCOBASE_TOKEN');
-    expect(token).toBe('123');
-    const auth = localStorage.getItem('NOCOBASE_AUTH');
-    expect(auth).toBe('basic');
-  });
-
-  test('resource action', async () => {
-    const api = new APIClient({
-      baseURL: 'https://localhost:8000/api',
-    });
-    const mock = new MockAdapter(api.axios);
-    mock.onPost('users:test').reply(200, {
-      data: { id: 1, name: 'John Smith', token: '123' },
-    });
-    const response = await api.resource('users').test();
-    expect(response.status).toBe(200);
-    expect(response.data).toMatchObject({
-      data: { id: 1, name: 'John Smith', token: '123' },
-    });
-  });
-
-  test('custom storage', async () => {
-    const items = new Map();
-
-    class TestStorage extends Storage {
-      clear() {
-        items.clear();
-      }
-      getItem(key: string) {
-        return items.get(key);
-      }
-      setItem(key: string, value: string) {
-        return items.set(key, value);
-      }
-      removeItem(key: string) {
-        return items.delete(key);
-      }
-    }
-
-    const api = new APIClient({
-      baseURL: 'https://localhost:8000/api',
-      storageClass: TestStorage,
-    });
-
-    const mock = new MockAdapter(api.axios);
-    mock.onPost('auth:signIn').reply(200, {
-      data: { id: 1, name: 'John Smith', token: '123' },
-    });
-
-    const response = await api.auth.signIn({});
-    expect(response.status).toBe(200);
-    expect(api.auth.getToken()).toBe('123');
-    const token = items.get('NOCOBASE_TOKEN');
-    expect(token).toBe('123');
-  });
-
-  test('custom auth', async () => {
-    class TestAuth extends Auth {
-      async signIn(values: any): Promise<AxiosResponse<any, any>> {
-        const response = await this.api.request({
-          method: 'post',
-          url: 'auth:test',
-          data: values,
-        });
-        const data = response?.data?.data;
-        this.setAuthenticator('test');
-        this.setToken(data?.token);
-        return response;
-      }
-    }
-
-    const api = new APIClient({
-      baseURL: 'https://localhost:8000/api',
-      authClass: TestAuth,
-    });
-
-    expect(api.auth).toBeInstanceOf(TestAuth);
-
-    const mock = new MockAdapter(api.axios);
-    mock.onPost('auth:test').reply(200, {
-      data: { id: 1, name: 'John Smith', token: '123' },
-    });
-
-    const response = await api.auth.signIn({});
-    expect(response.status).toBe(200);
-    expect(api.auth.getToken()).toBe('123');
-    const token = localStorage.getItem('NOCOBASE_TOKEN');
-    expect(token).toBe('123');
-    const auth = localStorage.getItem('NOCOBASE_AUTH');
-    expect(auth).toBe('test');
-  });
-});

package/src/getSubAppName.ts

@@ -1,9 +0,0 @@
-const getSubAppName = () => {
-  const match = window.location.pathname.match(/^\/apps\/([^/]*)\//);
-  if (!match) {
-    return '';
-  }
-  return match[1].toUpperCase();
-};
-
-export default getSubAppName;

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './APIClient';
-export { default as getSubAppName } from './getSubAppName';
-