@ibiz-template/core 0.0.1-alpha.1 → 0.0.1-alpha.4

package/src/utils/namespace/namespace.ts

@@ -0,0 +1,244 @@
+export const defaultNamespace = 'ibiz';
+const statePrefix = 'is-';
+
+/**
+ * css bem 命名规则拼接
+ * _bem('ibiz', 'layout') => ibiz-layout
+ * _bem('ibiz', 'layout', '', 'title') => ibiz-layout__title
+ * _bem('ibiz', 'layout', '', '', 'right') => ibiz-layout--right
+ * _bem('ibiz', 'layout', '', 'title', 'right') => ibiz-layout__title--right
+ * _bem('ibiz', 'layout', 'header', 'title', 'right') => ibiz-layout-header__title--right
+ *
+ * @author chitanda
+ * @date 2022-09-06 11:09:42
+ * @param {string} namespace 命名空间
+ * @param {string} block 块
+ * @param {string} blockSuffix 块后缀
+ * @param {string} element 元素
+ * @param {string} modifier 修饰符
+ * @return {*}  {string}
+ */
+function _bem(
+  namespace: string,
+  block: string,
+  blockSuffix?: string,
+  element?: string,
+  modifier?: string,
+): string {
+  let cls = `${namespace}-${block}`;
+  if (blockSuffix) {
+    cls += `-${blockSuffix}`;
+  }
+  if (element) {
+    cls += `__${element}`;
+  }
+  if (modifier) {
+    cls += `--${modifier}`;
+  }
+  return cls;
+}
+
+/**
+ * 全局样式处理命名空间
+ *
+ * @author chitanda
+ * @date 2022-09-06 11:09:50
+ * @export
+ * @class Namespace
+ */
+export class Namespace {
+  /**
+   * 命名空间
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:01
+   * @type {string}
+   */
+  namespace: string;
+
+  /**
+   * Creates an instance of Namespace.
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:12
+   * @param {string} block 当前命名空间的根模块,例如组件的名称
+   * @param {string} [namespace] 指定命名空间，未指定使用默认值 ibiz
+   */
+  constructor(protected block: string, namespace?: string) {
+    this.namespace = namespace || defaultNamespace;
+  }
+
+  /**
+   * namespace-block
+   * namespace-block-blockSuffix
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:08
+   * @param {string} [blockSuffix='']
+   * @return {*}  {string}
+   */
+  b(blockSuffix: string = ''): string {
+    return _bem(this.namespace, this.block, blockSuffix, '', '');
+  }
+
+  /**
+   * namespace-block__element
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:48
+   * @param {string} [element]
+   * @return {*}  {string}
+   */
+  e(element?: string): string {
+    return element ? _bem(this.namespace, this.block, '', element, '') : '';
+  }
+
+  /**
+   * namespace-block--modifier
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:37
+   * @param {string} [modifier]
+   * @return {*}  {string}
+   */
+  m(modifier?: string): string {
+    return modifier ? _bem(this.namespace, this.block, '', '', modifier) : '';
+  }
+
+  /**
+   * namespace-block-blockSuffix__element
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:52
+   * @param {string} [blockSuffix]
+   * @param {string} [element]
+   * @return {*}  {string}
+   */
+  be(blockSuffix?: string, element?: string): string {
+    return blockSuffix && element
+      ? _bem(this.namespace, this.block, blockSuffix, element, '')
+      : '';
+  }
+
+  /**
+   * namespace-block__element--modifier
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:19
+   * @param {string} [element]
+   * @param {string} [modifier]
+   * @return {*}  {string}
+   */
+  em(element?: string, modifier?: string): string {
+    return element && modifier
+      ? _bem(this.namespace, this.block, '', element, modifier)
+      : '';
+  }
+
+  /**
+   * namespace-block-blockSuffix--modifier
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:59
+   * @param {string} [blockSuffix]
+   * @param {string} [modifier]
+   * @return {*}  {string}
+   */
+  bm(blockSuffix?: string, modifier?: string): string {
+    return blockSuffix && modifier
+      ? _bem(this.namespace, this.block, blockSuffix, '', modifier)
+      : '';
+  }
+
+  /**
+   * namespace-block-blockSuffix__element--modifier
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:37
+   * @param {string} [blockSuffix]
+   * @param {string} [element]
+   * @param {string} [modifier]
+   * @return {*}  {string}
+   */
+  bem(blockSuffix?: string, element?: string, modifier?: string): string {
+    return blockSuffix && element && modifier
+      ? _bem(this.namespace, this.block, blockSuffix, element, modifier)
+      : '';
+  }
+
+  /**
+   * 返回状态 class
+   *
+   * is('loading', false) => '';
+   * is('loading', true) => 'is-loading';
+   *
+   * @author chitanda
+   * @date 2022-09-06 12:09:57
+   * @param {string} name
+   * @param {boolean} [state]
+   * @return {*}  {string}
+   */
+  is(name: string, state?: boolean): string {
+    return name && state ? `${statePrefix}${name}` : '';
+  }
+
+  /**
+   * 生成使用到的 css 变量 style 对象
+   *
+   * @author chitanda
+   * @date 2022-09-06 15:09:41
+   * @param {Record<string, string>} object
+   * @return {*}  {Record<string, string>}
+   */
+  cssVar(object: Record<string, string>): Record<string, string> {
+    const styles: Record<string, string> = {};
+    for (const key in object) {
+      if (object[key]) {
+        styles[this.cssVarName(key)] = object[key];
+      }
+    }
+    return styles;
+  }
+
+  /**
+   * 生成使用到的 css block 变量 style 对象
+   *
+   * @author chitanda
+   * @date 2022-09-06 15:09:03
+   * @param {Record<string, string>} object
+   * @return {*}  {Record<string, string>}
+   */
+  cssVarBlock(object: Record<string, string>): Record<string, string> {
+    const styles: Record<string, string> = {};
+    for (const key in object) {
+      if (object[key]) {
+        styles[this.cssVarBlockName(key)] = object[key];
+      }
+    }
+    return styles;
+  }
+
+  /**
+   * 生成 css var 变量名称
+   *
+   * @author chitanda
+   * @date 2022-09-06 15:09:21
+   * @param {string} name
+   * @return {*}  {string}
+   */
+  cssVarName(name: string): string {
+    return `--${this.namespace}-${name}`;
+  }
+
+  /**
+   * 生成块 css var 变量名称
+   *
+   * @author chitanda
+   * @date 2022-09-06 15:09:35
+   * @param {string} name
+   * @return {*}  {string}
+   */
+  cssVarBlockName(name: string): string {
+    return `--${this.namespace}-${this.block}-${name}`;
+  }
+}

package/src/utils/net/http-response.ts

@@ -0,0 +1,113 @@
+import { AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders } from 'axios';
+
+/**
+ * Http请求返回接口
+ *
+ * @author chitanda
+ * @date 2022-08-21 17:08:06
+ * @export
+ * @interface IHttpResponse
+ * @extends {AxiosResponse}
+ * @template T
+ */
+export interface IHttpResponse<T = IData> extends AxiosResponse {
+  /**
+   * 是否请求成功
+   *
+   * @description 当状态码为 200-299 时认为成功
+   * @author chitanda
+   * @date 2022-07-14 16:07:59
+   * @type {boolean}
+   */
+  ok: boolean;
+  /**
+   * 是否为本地仿造响应
+   *
+   * @description 只有当值为 true 时, 才认为是本地仿造响应
+   * @author chitanda
+   * @date 2022-08-18 15:08:44
+   * @type {boolean}
+   */
+  local?: boolean;
+
+  data: T;
+
+  /**
+   * 当前页
+   */
+  page?: number;
+
+  /**
+   * 分页条数
+   */
+  size?: number;
+
+  /**
+   * 总条数
+   */
+  total?: number;
+}
+
+/**
+ * 本地请求仿造响应
+ *
+ * @author chitanda
+ * @date 2022-08-21 17:08:00
+ * @export
+ * @class HttpResponse
+ * @implements {IHttpResponse<T>}
+ * @template T
+ */
+export class HttpResponse<T = IData> implements IHttpResponse<T> {
+  /**
+   * 本地仿造响应
+   *
+   * @author chitanda
+   * @date 2022-08-18 15:08:06
+   */
+  local = true;
+
+  ok = false;
+
+  data: T;
+
+  status: number;
+
+  statusText: string;
+
+  /**
+   * header 本地仿造时值为空
+   *
+   * @author chitanda
+   * @date 2022-08-18 15:08:46
+   * @type {AxiosResponseHeaders}
+   */
+  headers: AxiosResponseHeaders = {};
+
+  /**
+   * AxiosResponse 本地仿造时值为空
+   *
+   * @author chitanda
+   * @date 2022-08-18 15:08:22
+   * @type {AxiosRequestConfig<IData>}
+   */
+  config: AxiosRequestConfig<IData> = {};
+
+  /**
+   * Creates an instance of HttpResponse.
+   *
+   * @author chitanda
+   * @date 2022-08-18 15:08:11
+   * @param {unknown} [data] 返回的数据
+   * @param {number} [status] 状态码 (默认为 200)
+   * @param {string} [statusText] 状态描述 (默认为空字符)
+   */
+  constructor(data?: unknown, status?: number, statusText?: string) {
+    this.data = data as T;
+    this.status = status || 200;
+    this.statusText = statusText || '';
+    if (this.status >= 200 && this.status < 300) {
+      this.ok = true;
+    }
+  }
+}

package/src/utils/net/net.ts

@@ -1,27 +1,7 @@
 import axios, { AxiosRequestHeaders, AxiosResponse } from 'axios';
 import { stringify } from 'qs';
 import { notNilEmpty } from 'qx-util';
-
-/**
- * 返回值扩展
- *
- * @author chitanda
- * @date 2022-07-14 16:07:50
- * @export
- * @interface NetResponse
- * @extends {AxiosResponse}
- */
-export interface NetResponse extends AxiosResponse {
-  /**
-   * 是否请求成功
-   *
-   * @description 当状态码为 200-299 时认为成功
-   * @author chitanda
-   * @date 2022-07-14 16:07:59
-   * @type {boolean}
-   */
-  ok: boolean;
-}
+import { IHttpResponse } from './http-response';
 
 /**
  * 全局请求工具类
@@ -40,7 +20,11 @@ export class Net {
    * @protected
    * @type {string}
    */
-  protected prefix: string = '';
+  protected _prefix: string = '';
+
+  get prefix(): string {
+    return this._prefix || ibiz.env.baseUrl;
+  }
 
   /**
    * Creates an instance of Net.
@@ -51,7 +35,7 @@ export class Net {
    */
   constructor(prefix?: string) {
     if (prefix) {
-      this.prefix = prefix;
+      this._prefix = prefix;
     }
   }
 
@@ -62,14 +46,14 @@ export class Net {
    * @date 2022-07-14 15:07:01
    * @param {string} url
    * @param {IParams} [params={}]
-   * @return {*}  {Promise<NetResponse>}
+   * @return {*}  {Promise<IHttpResponse>}
    */
   async post(
     url: string,
     data: IData,
     params: IParams = {},
     headers: AxiosRequestHeaders = {},
-  ): Promise<NetResponse> {
+  ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     const response = await axios({
       method: 'post',
@@ -91,19 +75,20 @@ export class Net {
    * @date 2022-07-14 15:07:08
    * @param {string} url
    * @param {IParams} [params={}]
-   * @return {*}  {Promise<NetResponse>}
+   * @return {*}  {Promise<IHttpResponse>}
    */
   async get(
     url: string,
     params: IParams = {},
     headers: AxiosRequestHeaders = {},
-  ): Promise<NetResponse> {
+    option: IParams = {},
+  ): Promise<IHttpResponse> {
     // if (params.srfparentdata) {
     //   Object.assign(params, params.srfparentdata);
     //   delete params.srfparentdata;
     // }
     url = this.attachUrlParam(url, params);
-    const response = await axios.get(url, { headers });
+    const response = await axios.get(url, { headers, ...option });
     return this.doResponseResult(response);
   }
 
@@ -114,13 +99,13 @@ export class Net {
    * @date 2022-07-14 15:07:43
    * @param {string} url
    * @param {IParams} [params]
-   * @return {*}  {Promise<NetResponse>}
+   * @return {*}  {Promise<IHttpResponse>}
    */
   async delete(
     url: string,
     params?: IParams,
     headers: AxiosRequestHeaders = {},
-  ): Promise<NetResponse> {
+  ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     const response = await axios.delete(url, { headers });
     return this.doResponseResult(response);
@@ -132,16 +117,17 @@ export class Net {
    * @author chitanda
    * @date 2022-07-14 15:07:49
    * @param {string} url
-   * @param {IParams} params
-   * @return {*}  {Promise<NetResponse>}
+   * @param {IData} data
+   * @return {*}  {Promise<IHttpResponse>}
    */
   async put(
     url: string,
-    params: IParams,
+    data: IData,
+    params: IParams = {},
     headers: AxiosRequestHeaders = {},
-  ): Promise<NetResponse> {
+  ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
-    const response = await axios.put(url, params, { headers });
+    const response = await axios.put(url, data, { headers });
     return this.doResponseResult(response);
   }
 
@@ -152,12 +138,12 @@ export class Net {
    * @date 2022-07-14 15:07:15
    * @param {string} url
    * @param {AxiosRequestHeaders} [headers={}]
-   * @return {*}  {Promise<NetResponse>}
+   * @return {*}  {Promise<IHttpResponse>}
    */
   async getModel(
     url: string,
     headers: AxiosRequestHeaders = {},
-  ): Promise<NetResponse> {
+  ): Promise<IHttpResponse> {
     const response = await axios.get(url, {
       headers,
     });
@@ -171,10 +157,10 @@ export class Net {
    * @date 2022-07-14 16:07:23
    * @private
    * @param {AxiosResponse} response
-   * @return {*}  {NetResponse}
+   * @return {*}  {IHttpResponse}
    */
-  private doResponseResult(response: AxiosResponse): NetResponse {
-    const res = response as NetResponse;
+  private doResponseResult(response: AxiosResponse): IHttpResponse {
+    const res = response as IHttpResponse;
     if (res.status >= 200 && res.status <= 299) {
       res.ok = true;
     }

package/src/utils/plural/plural.ts

@@ -0,0 +1,27 @@
+import pluralize from 'pluralize';
+
+/**
+ * 英文转复数写法
+ *
+ * @author chitanda
+ * @date 2022-08-25 18:08:41
+ * @export
+ * @param {string} key
+ * @return {*}  {string}
+ */
+export function plural(key: string): string {
+  return pluralize(key);
+}
+
+/**
+ * 英文转复数写法并转全小写
+ *
+ * @author chitanda
+ * @date 2022-08-25 18:08:23
+ * @export
+ * @param {string} key
+ * @return {*}  {string}
+ */
+export function pluralLower(key: string): string {
+  return plural(key).toLowerCase();
+}