@nocobase/sdk 1.2.13-alpha → 1.3.0-alpha.20240710084543

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/sdk",
-  "version": "1.2.13-alpha",
+  "version": "1.3.0-alpha.20240710084543",
   "license": "AGPL-3.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -11,5 +11,5 @@
   "devDependencies": {
     "axios-mock-adapter": "^1.20.0"
   },
-  "gitHead": "b6a1c2ee330b47c2581ea2ce15ee46210e6220f2"
+  "gitHead": "07a8b596fc64a9779a194cb9b0dc2ca7570ed9d4"
 }

package/lib/APIClient.d.ts

@@ -1,133 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-import { AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
-export interface ActionParams {
-    filterByTk?: any;
-    [key: string]: any;
-}
-type ResourceActionOptions<P = any> = {
-    resource?: string;
-    resourceOf?: any;
-    action?: string;
-    params?: P;
-};
-type ResourceAction = (params?: ActionParams) => Promise<any>;
-export type IResource = {
-    [key: string]: ResourceAction;
-};
-export declare class Auth {
-    protected api: APIClient;
-    get storagePrefix(): string;
-    get KEYS(): {
-        locale: string;
-        role: string;
-        token: string;
-        authenticator: string;
-        theme: string;
-    };
-    protected options: {
-        locale: any;
-        role: any;
-        authenticator: any;
-        token: any;
-    };
-    constructor(api: APIClient);
-    get locale(): string;
-    set locale(value: string);
-    get role(): string;
-    set role(value: string);
-    get token(): string;
-    set token(value: string);
-    get authenticator(): string;
-    set authenticator(value: string);
-    /**
-     * @internal
-     */
-    getOption(key: string): string;
-    /**
-     * @internal
-     */
-    setOption(key: string, value?: string): void;
-    /**
-     * @internal
-     * use {@link Auth#locale} instead
-     */
-    getLocale(): string;
-    /**
-     * @internal
-     * use {@link Auth#locale} instead
-     */
-    setLocale(locale: string): void;
-    /**
-     * @internal
-     * use {@link Auth#role} instead
-     */
-    getRole(): string;
-    /**
-     * @internal
-     * use {@link Auth#role} instead
-     */
-    setRole(role: string): void;
-    /**
-     * @internal
-     * use {@link Auth#token} instead
-     */
-    getToken(): string;
-    /**
-     * @internal
-     * use {@link Auth#token} instead
-     */
-    setToken(token: string): void;
-    /**
-     * @internal
-     * use {@link Auth#authenticator} instead
-     */
-    getAuthenticator(): string;
-    /**
-     * @internal
-     * use {@link Auth#authenticator} instead
-     */
-    setAuthenticator(authenticator: string): void;
-    middleware(config: AxiosRequestConfig): AxiosRequestConfig<any>;
-    signIn(values: any, authenticator?: string): Promise<AxiosResponse<any>>;
-    signUp(values: any, authenticator?: string): Promise<AxiosResponse<any>>;
-    signOut(): Promise<AxiosResponse<any, any>>;
-}
-export declare 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 declare class MemoryStorage extends Storage {
-    items: Map<any, any>;
-    clear(): void;
-    getItem(key: string): any;
-    setItem(key: string, value: string): Map<any, any>;
-    removeItem(key: string): boolean;
-}
-interface ExtendedOptions {
-    authClass?: any;
-    storageClass?: any;
-    storagePrefix?: string;
-}
-export type APIClientOptions = AxiosInstance | (AxiosRequestConfig & ExtendedOptions);
-export declare class APIClient {
-    axios: AxiosInstance;
-    auth: Auth;
-    storage: Storage;
-    storagePrefix: string;
-    getHeaders(): {};
-    constructor(instance?: APIClientOptions);
-    private initStorage;
-    interceptors(): void;
-    request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D> | ResourceActionOptions): Promise<R>;
-    resource(name: string, of?: any, headers?: AxiosRequestHeaders): IResource;
-}
-export {};

package/lib/APIClient.js

@@ -1,369 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var APIClient_exports = {};
-__export(APIClient_exports, {
-  APIClient: () => APIClient,
-  Auth: () => Auth,
-  MemoryStorage: () => MemoryStorage,
-  Storage: () => Storage
-});
-module.exports = __toCommonJS(APIClient_exports);
-var import_axios = __toESM(require("axios"));
-var import_qs = __toESM(require("qs"));
-const _Auth = class _Auth {
-  api;
-  get storagePrefix() {
-    return this.api.storagePrefix;
-  }
-  get KEYS() {
-    var _a, _b;
-    const defaults = {
-      locale: this.storagePrefix + "LOCALE",
-      role: this.storagePrefix + "ROLE",
-      token: this.storagePrefix + "TOKEN",
-      authenticator: this.storagePrefix + "AUTH",
-      theme: this.storagePrefix + "THEME"
-    };
-    if (this.api["app"]) {
-      const appName = (_b = (_a = this.api["app"]) == null ? void 0 : _a.getName) == null ? void 0 : _b.call(_a);
-      if (appName) {
-        defaults["role"] = `${appName.toUpperCase()}_` + defaults["role"];
-        defaults["locale"] = `${appName.toUpperCase()}_` + defaults["locale"];
-      }
-    }
-    return defaults;
-  }
-  options = {
-    locale: null,
-    role: null,
-    authenticator: null,
-    token: null
-  };
-  constructor(api) {
-    this.api = api;
-    this.api.axios.interceptors.request.use(this.middleware.bind(this));
-  }
-  get locale() {
-    return this.getLocale();
-  }
-  set locale(value) {
-    this.setLocale(value);
-  }
-  get role() {
-    return this.getRole();
-  }
-  set role(value) {
-    this.setRole(value);
-  }
-  get token() {
-    return this.getToken();
-  }
-  set token(value) {
-    this.setToken(value);
-  }
-  get authenticator() {
-    return this.getAuthenticator();
-  }
-  set authenticator(value) {
-    this.setAuthenticator(value);
-  }
-  /**
-   * @internal
-   */
-  getOption(key) {
-    if (!this.KEYS[key]) {
-      return;
-    }
-    return this.api.storage.getItem(this.KEYS[key]);
-  }
-  /**
-   * @internal
-   */
-  setOption(key, value) {
-    if (!this.KEYS[key]) {
-      return;
-    }
-    this.options[key] = value;
-    return this.api.storage.setItem(this.KEYS[key], value || "");
-  }
-  /**
-   * @internal
-   * use {@link Auth#locale} instead
-   */
-  getLocale() {
-    return this.getOption("locale");
-  }
-  /**
-   * @internal
-   * use {@link Auth#locale} instead
-   */
-  setLocale(locale) {
-    this.setOption("locale", locale);
-  }
-  /**
-   * @internal
-   * use {@link Auth#role} instead
-   */
-  getRole() {
-    return this.getOption("role");
-  }
-  /**
-   * @internal
-   * use {@link Auth#role} instead
-   */
-  setRole(role) {
-    this.setOption("role", role);
-  }
-  /**
-   * @internal
-   * use {@link Auth#token} instead
-   */
-  getToken() {
-    return this.getOption("token");
-  }
-  /**
-   * @internal
-   * use {@link Auth#token} instead
-   */
-  setToken(token) {
-    this.setOption("token", token);
-  }
-  /**
-   * @internal
-   * use {@link Auth#authenticator} instead
-   */
-  getAuthenticator() {
-    return this.getOption("authenticator");
-  }
-  /**
-   * @internal
-   * use {@link Auth#authenticator} instead
-   */
-  setAuthenticator(authenticator) {
-    this.setOption("authenticator", authenticator);
-  }
-  middleware(config) {
-    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, authenticator) {
-    var _a;
-    const response = await this.api.request({
-      method: "post",
-      url: "auth:signIn",
-      data: values,
-      headers: {
-        "X-Authenticator": authenticator
-      }
-    });
-    const data = (_a = response == null ? void 0 : response.data) == null ? void 0 : _a.data;
-    this.setToken(data == null ? void 0 : data.token);
-    this.setAuthenticator(authenticator);
-    return response;
-  }
-  async signUp(values, authenticator) {
-    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;
-  }
-};
-__name(_Auth, "Auth");
-let Auth = _Auth;
-const _Storage = class _Storage {
-};
-__name(_Storage, "Storage");
-let Storage = _Storage;
-const _MemoryStorage = class _MemoryStorage extends Storage {
-  items = /* @__PURE__ */ new Map();
-  clear() {
-    this.items.clear();
-  }
-  getItem(key) {
-    return this.items.get(key);
-  }
-  setItem(key, value) {
-    return this.items.set(key, value);
-  }
-  removeItem(key) {
-    return this.items.delete(key);
-  }
-};
-__name(_MemoryStorage, "MemoryStorage");
-let MemoryStorage = _MemoryStorage;
-const _APIClient = class _APIClient {
-  axios;
-  auth;
-  storage;
-  storagePrefix = "NOCOBASE_";
-  getHeaders() {
-    const headers = {};
-    if (this.auth.locale) {
-      headers["X-Locale"] = this.auth.locale;
-    }
-    if (this.auth.role) {
-      headers["X-Role"] = this.auth.role;
-    }
-    if (this.auth.authenticator) {
-      headers["X-Authenticator"] = this.auth.authenticator;
-    }
-    if (this.auth.token) {
-      headers["Authorization"] = `Bearer ${this.auth.token}`;
-    }
-    return headers;
-  }
-  constructor(instance) {
-    if (typeof instance === "function") {
-      this.axios = instance;
-    } else {
-      const { authClass, storageClass, storagePrefix = "NOCOBASE_", ...others } = instance || {};
-      this.storagePrefix = storagePrefix;
-      this.axios = import_axios.default.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();
-  }
-  initStorage(storage) {
-    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 import_qs.default.stringify(params, {
-          strictNullHandling: true,
-          arrayFormat: "brackets"
-        });
-      };
-      return config;
-    });
-  }
-  request(config) {
-    const { resource, resourceOf, action, params, headers } = config;
-    if (resource) {
-      return this.resource(resource, resourceOf, headers)[action](params);
-    }
-    return this.axios.request(config);
-  }
-  resource(name, of, headers) {
-    const target = {};
-    const handler = {
-      get: (_, actionName) => {
-        let url = name.split(".").join(`/${encodeURIComponent(of) || "_"}/`);
-        url += `:${actionName}`;
-        const config = { url };
-        if (["get", "list"].includes(actionName)) {
-          config["method"] = "get";
-        } else {
-          config["method"] = "post";
-        }
-        return async (params, opts) => {
-          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,
-            headers
-          });
-        };
-      }
-    };
-    return new Proxy(target, handler);
-  }
-};
-__name(_APIClient, "APIClient");
-let APIClient = _APIClient;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  APIClient,
-  Auth,
-  MemoryStorage,
-  Storage
-});

package/lib/getSubAppName.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-declare const getSubAppName: (publicPath?: string) => string;
-export default getSubAppName;

package/lib/getSubAppName.js

@@ -1,42 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var getSubAppName_exports = {};
-__export(getSubAppName_exports, {
-  default: () => getSubAppName_default
-});
-module.exports = __toCommonJS(getSubAppName_exports);
-const getSubAppName = /* @__PURE__ */ __name((publicPath = "/") => {
-  const prefix = `${publicPath}apps/`;
-  if (!window.location.pathname.startsWith(prefix)) {
-    return;
-  }
-  const pathname = window.location.pathname.substring(prefix.length);
-  const args = pathname.split("/", 1);
-  return args[0] || "";
-}, "getSubAppName");
-var getSubAppName_default = getSubAppName;

package/lib/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-export * from './APIClient';
-export { default as getSubAppName } from './getSubAppName';

package/lib/index.js

@@ -1,49 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var src_exports = {};
-__export(src_exports, {
-  getSubAppName: () => import_getSubAppName.default
-});
-module.exports = __toCommonJS(src_exports);
-__reExport(src_exports, require("./APIClient"), module.exports);
-var import_getSubAppName = __toESM(require("./getSubAppName"));
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getSubAppName,
-  ...require("./APIClient")
-});