# cloud-analyse-sdk

> 埋点分析sdk

Latest version **0.0.4** (published 2022-09-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install cloud-analyse-sdk
pnpm add cloud-analyse-sdk
yarn add cloud-analyse-sdk
bun add cloud-analyse-sdk
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2022-09-14 |
| First published | 2022-09-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 681.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rain9 |
| Maintainers | rain9 |

## Links

- npm: https://www.npmjs.com/package/cloud-analyse-sdk
- npm.io page: https://npm.io/package/cloud-analyse-sdk

## Recent versions

- 0.0.4 (latest) — 2022-09-14
- 0.0.3 — 2022-09-14
- 0.0.2 — 2022-09-14
- 0.0.1 — 2022-09-13

## README

# cloud-analyse-sdk

## 技术

### 依赖包

- @microsoft/api-extractor：汇总产物中的类型定义
- @rollup/plugin-typescript：用于构建阶段TS的转换
- core-js：用于js polyfill支持
- tslib：为TS提供一些辅助方法，Runtime - library for TypeScript helper functions
- eslint：代码规范
- vite：开发阶段测试，与库的最终构建（Rollup提供构建能力）
- rimraf：替代rm -rf指令用于清理不需要的资源
- typescript：TS支持

### 文件目录

- 文件 src/index.ts：主要用于模块内容的导出
- 目录 src/lib：主要用于存放库的核心源码
- 目录 src/types：TS定义文件
- 目录 src/constants：常量
- 目录 src/utils：工具方法

### 产物 dist

- *.cjs.js：构建工具引用
- *.es.js：支持ESM的构建工具使用
- index.min.js：CDN引入使用，其中UMD兼容AMD，commonJS，全局引用等等方式

### CDN资源

- https://unpkg.com/cloud-analyse-sdk@0.0.1/dist/index.min.js

### 使用说明

#### npm

```sh
# npm
npm i cloud-analyse-sdk

# yarn
yarn add cloud-analyse-sdk

# pnpm
pnpm add cloud-analyse-sdk
```

```js
// 日志中心自己埋点
import cloudAnalyseSDK from 'cloud-analyse-sdk'

const cloudLog = (options: {}) => {
  // if (process.env.NODE_ENV !== 'production') return
  var userInfo = JSON.parse(localStorage.getItem('userInfo') || '{}')
  // console.log('userInfo', userInfo)
  const cloudOption = {
    appid: process.env.NODE_ENV === 'production' ? '1005116' : '1014745',
    projectId: 'logcenter',
    date: new Date(),
    userId: userInfo.workcode,
    username: userInfo.realname,
    pageId: document.title,
    department: userInfo.department,
    interactive: { // 交互日志
      open: true
    },
    pv: { // 展现日志
      open: false
    },
    sys: { // 系统日志
      open: false
    },
    all: { // 合并日志
      open: false
    }
  }
  cloudAnalyseSDK(Object)  
}

// vue2版本
Vue.prototype.$cloudLog = cloudLog

// 具体交互埋点
this.$cloudLog({
    eventId: 'log-access', // 事件ID 规则详见wiki
    params: {} // 自定义参数
})

// vue3
app.config.globalProperties.$cloudLog = cloudLog

// js 中使用方式
import { getCurrentInstance } from 'vue'

export default {
  setup () {
    const { proxy } = getCurrentInstance()
    proxy.$cloudLog({
        eventId: 'log-access', // 事件ID 规则详见wiki
        params: {} // 自定义参数
    })
  }
}
```

#### cdn

```js
<script src="https://unpkg.com/cloud-analyse-sdk@0.0.1/dist/index.min.js"></script>
<script>
    cloudAnalyseSDK(options)
</script>
```

---
_Source: https://npm.io/package/cloud-analyse-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._