@microbt/environment 0.2.0

package/README.md

@@ -0,0 +1,235 @@
+# @microbt/environment 使用文档
+
+## 安装和使用
+
+### 安装
+
+```bash
+pnpm add @microbt/environment
+```
+
+### 使用
+
+```typescript
+import { environment, baseUrl, getLocale } from '@microbt/environment';
+const env = environment();
+const url = baseUrl();
+const locale = getLocale();
+```
+
+## 环境相关函数
+
+### `environment()`
+
+获取当前运行的环境。
+
+**返回值**: `string` - 环境名称（local, dev, test, pre, gray, prod, unknown）
+
+**示例**:
+
+```typescript
+const env = environment();
+console.log(env); // 输出: 'prod'
+```
+
+### `isAWSDomain()`
+
+判断当前域名是否为 AWS 环境。
+
+**返回值**: `boolean` - 如果是 AWS 环境返回 `true`，否则返回 `false`
+
+**示例**:
+
+```typescript
+const isAWS = isAWSDomain();
+console.log(isAWS); // 输出: true 或 false
+```
+
+### `region()`
+
+获取当前区域代码。
+
+**返回值**: `string` - 区域代码（如 'cn', 'us' 等）
+
+**示例**:
+
+```typescript
+const regionCode = region();
+console.log(regionCode); // 输出: 'cn'
+```
+
+## 网关相关函数
+
+### `baseUrl()`
+
+获取 API 的基础 URL。
+
+**返回值**: `string | undefined` - 根据环境返回相应的 API 基础 URL，如果是本地或未知环境则返回 `undefined`
+
+**示例**:
+
+```typescript
+const url = baseUrl();
+console.log(url); // 输出: '//api-cn-prod.superacme.com'
+```
+
+## 混合应用相关函数
+
+### `bridgeCall(method: string, params: Record<string, string>, callback: (resp: string) => void)`
+
+调用原生桥接方法。
+
+**参数**:
+
+- `method`: `string` - 要调用的方法名
+- `params`: `Record<string, string>` - 方法参数
+- `callback`: `(resp: string) => void` - 回调函数
+
+**示例**:
+
+```typescript
+bridgeCall('getUserInfo', { userId: '123' }, (resp) => {
+console.log(resp);
+```
+
+### `bridgeBootstrap()`
+
+初始化桥接环境。
+
+**示例**:
+
+```typescript
+bridgeBootstrap();
+```
+
+### `inSuperAcme()`
+
+判断当前是否在 SuperAcme 应用中。
+
+**返回值**: `boolean` - 如果在 SuperAcme 应用中返回 `true`，否则返回 `false`
+
+**示例**:
+
+```typescript
+const isInApp = inSuperAcme();
+console.log(isInApp); // 输出: true 或 false
+```
+
+### `superAcmeVersion()`
+
+获取 SuperAcme 应用的版本号。
+
+**返回值**: `string | undefined` - 返回 SuperAcme 应用的版本号，如果不在应用中则返回 `undefined`
+
+**示例**:
+
+```typescript
+const version = superAcmeVersion();
+console.log(version); // 输出: '1.2.3'
+```
+
+## 平台相关函数
+
+### `iOSWebview`
+
+判断当前是否为 iOS Webview 环境。
+
+**类型**: `boolean`
+
+**示例**:
+
+```typescript
+if (iOSWebview) {
+  console.log('当前为 iOS Webview 环境');
+}
+```
+
+### `androidWebView`
+
+判断当前是否为 Android Webview 环境。
+
+**类型**: `boolean`
+
+**示例**:
+
+```typescript
+if (androidWebView) {
+  console.log('当前为 Android Webview 环境');
+}
+```
+
+## 本地化相关函数
+
+### `getLocale(defaultLocal = 'zh-CN')`
+
+获取当前语言环境。
+
+**参数**:
+
+- `defaultLocal`: `string` - 默认语言环境，默认为 'zh-CN'
+
+**返回值**: `string` - 当前语言环境
+
+**示例**:
+
+```typescript
+const locale = getLocale();
+console.log(locale); // 输出: 'zh-CN' 或 'en-US'
+```
+
+## Cookie 相关函数
+
+### `getCookie(name: string)`
+
+获取指定名称的 Cookie 值。
+
+**参数**:
+
+- `name`: `string` - 要获取的 Cookie 名称
+
+**返回值**: `string | null` - 返回指定名称的 Cookie 值，如果不存在或解析失败则返回 `null`
+
+**功能描述**:
+
+- 使用正则表达式匹配指定名称的 Cookie 值。
+- 如果匹配成功，返回解码后的 Cookie 值。
+- 如果匹配失败或解码过程中发生错误，返回 `null`。
+
+**示例**:
+
+```typescript
+const userToken = getCookie('token');
+if (userToken) {
+  console.log(`User token: ${userToken}`);
+} else {
+  console.log('Token not found or invalid');
+}
+```
+
+**注意事项**:
+
+- 函数会对 Cookie 值进行解码，如果解码失败会捕获错误并返回 `null`。
+- 确保传入的 `name` 参数是合法的 Cookie 名称。
+
+## ARMS 模块
+
+`arms` 模块封装了阿里云 ARMS（应用实时监控服务）的前端监控功能，提供了一系列 API 用于上报性能数据、错误信息、用户行为等。
+
+### 可用 API
+
+以下是 `arms` 模块中提供的 API 列表：
+
+- **`api(params)`**: 上报 API 请求数据。
+- **`error(e, pos)`**: 上报错误信息。
+- **`sum(key, value)`**: 上报累加指标。
+- **`avg(key, value)`**: 上报平均值指标。
+- **`reportBehavior()`**: 上报用户行为数据。
+- **`performance(params)`**: 上报性能数据。
+- **`setConfig(params)`**: 设置 ARMS 配置。
+- **`setPage(page, sendPv)`**: 设置当前页面信息，并可选择是否发送页面访问数据（PV）。
+- **`setCommonInfo(params)`**: 设置通用信息。
+- **`addBehavior(data, page)`**: 添加用户行为数据。
+
+### 参考链接
+
+- [阿里云 ARMS 文档 - API 参考](https://help.aliyun.com/zh/arms/browser-monitoring/developer-reference/api-reference)

package/dist/esm/arms.d.ts

@@ -0,0 +1,39 @@
+declare const api: (params: {
+    api: string;
+    success: boolean;
+    time: number;
+    code?: string | number;
+    msg?: string;
+    begin?: number;
+    traceId?: string;
+    sid?: string;
+}) => void;
+export declare const arms: {
+    api: (params: {
+        api: string;
+        success: boolean;
+        time: number;
+        code?: string | number;
+        msg?: string;
+        begin?: number;
+        traceId?: string;
+        sid?: string;
+    }) => void;
+    error: (e: Error, pos: {
+        filename: string;
+        lineno: number;
+        colno: number;
+    }) => void;
+    sum: (key: string, value: number) => void;
+    avg: (key: string, value: number) => void;
+    reportBehavior: () => void;
+    performance: (params: unknown) => void;
+    setConfig: (params: unknown) => void;
+    setPage: (page: string, sendPv: boolean) => void;
+    setCommonInfo: (params: unknown) => void;
+    addBehavior: (data: {
+        name: string;
+        message: string;
+    }, page: string) => void;
+};
+export {};

package/dist/esm/cookie.d.ts

@@ -0,0 +1 @@
+export declare function getCookie(name: string): string | null;

package/dist/esm/environment.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 获取当前运行的环境
+ * @returns {string} 环境名称（local, dev, test, pre, gray, prod, unknown）
+ */
+export declare const environment: () => string;
+/**
+ * 获取当前运行的区域
+ * @returns {string} 区域名称（如 cn, us 等）
+ */
+export declare const region: () => string;
+/**
+ * 判断当前域名是否为 AWS 域名
+ * @returns {boolean} 是否为 AWS 域名
+ */
+export declare function isAWSDomain(): boolean;

package/dist/esm/gateway.d.ts

@@ -0,0 +1 @@
+export declare function baseUrl(): string | undefined;

package/dist/esm/global.d.ts

@@ -0,0 +1,44 @@
+declare global {
+  interface Window {
+    SuperAcme?: {
+      call: (
+        method: string,
+        params: Record<string, string>,
+        callback: (resp: string) => void,
+      ) => void;
+    };
+    WKWVJBCallbacks?: {
+      push: (item: () => void) => void;
+    };
+    webkit?: {
+      messageHandlers: {
+        iOS_Native_InjectJavascript: {
+          postMessage: (p: null) => void;
+        };
+      };
+    };
+    __bl?: {
+      api(params: {
+        api: string;
+        success: boolean;
+        time: number;
+        code?: string | number;
+        msg?: string;
+        begin?: number;
+        traceId?: string;
+        sid?: string;
+      }): void;
+      error(e: Error, pos: { filename: string; lineno: number; colno: number }): void;
+      sum(key: string, value: number): void;
+      avg(key: string, value: number): void;
+      reportBehavior(): void;
+      performance(params: unknown): void;
+      setConfig(params: unknown): void;
+      setPage(page: string, sendPv: boolean): void;
+      setCommonInfo(params: unknown): void;
+      addBehavior(data: { name: string; message: string }, page: string): void;
+    };
+  }
+}
+
+export {};

package/dist/esm/hybrid.d.ts

@@ -0,0 +1,11 @@
+export declare function bridgeCall(method: string, params: Record<string, string>, callback: (resp: string) => void): void;
+export declare function bridgeBootstrap(): void;
+export declare function inSuperAcme(): boolean;
+export declare function superAcmeVersion(): {
+    version: string;
+} | {
+    version: string;
+    major: number;
+    minor: number;
+    patch: number;
+};

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+export * from './arms';
+export * from './cookie';
+export * from './environment';
+export * from './gateway';
+export * from './hybrid';
+export * from './local';
+export * from './platform';

package/dist/esm/index.js

@@ -0,0 +1,8 @@
+// src/index.ts
+export * from "./arms";
+export * from "./cookie";
+export * from "./environment";
+export * from "./gateway";
+export * from "./hybrid";
+export * from "./local";
+export * from "./platform";

package/dist/esm/local.d.ts

@@ -0,0 +1 @@
+export declare function getLocale(defaultLocal?: string): string;

package/dist/esm/platform.d.ts

@@ -0,0 +1,2 @@
+export declare const iOSWebview: boolean;
+export declare const androidWebView: boolean;

package/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'jest-environment-jsdom',
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@microbt/environment",
+  "version": "0.2.0",
+  "description": "microbt app library for environment",
+  "keywords": [],
+  "license": "MIT",
+  "main": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "scripts": {
+    "build": "father build",
+    "build:deps": "father prebundle",
+    "dev": "father dev",
+    "format": "prettier --cache --write .",
+    "lint": "eslint . --fix ",
+    "prepare": "husky install",
+    "prepublishOnly": "father doctor && npm run build",
+    "postpublish": "cnpm sync @microbt/environment",
+    "test": "jest"
+  },
+  "lint-staged": {
+    "*.{md,json}": [
+      "prettier --cache --write"
+    ],
+    "*.{js,jsx}": [
+      "eslint --fix",
+      "prettier --cache --write"
+    ],
+    "*.ts?(x)": [
+      "eslint --fix",
+      "prettier --cache --parser=typescript --write"
+    ]
+  },
+  "dependencies": {
+    "alife-logger": "^1.8.30"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@types/jest": "^29.5.14",
+    "@typescript-eslint/eslint-plugin": "^5.54.1",
+    "@typescript-eslint/parser": "^5.54.1",
+    "eslint": "^8.36.0",
+    "father": "^4.1.0",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "lint-staged": "^13.2.0",
+    "prettier": "^2.8.4",
+    "prettier-plugin-organize-imports": "^3.2.2",
+    "prettier-plugin-packagejson": "^2.4.3",
+    "ts-jest": "^29.2.5"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "authors": []
+}