测试文档

.eslintignore

@@ -1,7 +1,8 @@
-node_modules
-!.*
-dist
-build
-
-
-examples/cra-ejected-babel
+node_modules
+!.*
+dist
+build
+docs
+
+
+examples/cra-ejected-babel

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/@medici.core.SDK.md

@@ -0,0 +1,324 @@
+# Class: SDK
+
+[@medici/core](../wiki/@medici.core).SDK
+
+## Hierarchy
+
+- `BaseTrack`
+
+  ↳ **`SDK`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](../wiki/@medici.core.SDK#constructor)
+
+### Properties
+
+- [\_appId](../wiki/@medici.core.SDK#_appid)
+- [\_config](../wiki/@medici.core.SDK#_config)
+- [\_endPoint](../wiki/@medici.core.SDK#_endpoint)
+- [\_history](../wiki/@medici.core.SDK#_history)
+- [\_platform](../wiki/@medici.core.SDK#_platform)
+- [\_trackEndPoint](../wiki/@medici.core.SDK#_trackendpoint)
+- [eventer](../wiki/@medici.core.SDK#eventer)
+
+### Methods
+
+- [endTrack](../wiki/@medici.core.SDK#endtrack)
+- [sendEvent](../wiki/@medici.core.SDK#sendevent)
+- [setConfig](../wiki/@medici.core.SDK#setconfig)
+- [startTrack](../wiki/@medici.core.SDK#starttrack)
+- [track](../wiki/@medici.core.SDK#track)
+- [trackEvent](../wiki/@medici.core.SDK#trackevent)
+- [trackView](../wiki/@medici.core.SDK#trackview)
+
+## Constructors
+
+### constructor
+
+• **new SDK**(`params`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`SDKConfigType`](../wiki/@medici.core.SDKConfigType) |
+
+#### Overrides
+
+BaseTrack.constructor
+
+#### Defined in
+
+core/src/sdk.ts:28
+
+## Properties
+
+### \_appId
+
+• `Protected` **\_appId**: `string`
+
+#### Inherited from
+
+BaseTrack.\_appId
+
+#### Defined in
+
+core/src/basicTrack.ts:11
+
+___
+
+### \_config
+
+• `Protected` **\_config**: [`SDKInitConfig`](../wiki/@medici.core.SDKInitConfig)
+
+#### Overrides
+
+BaseTrack.\_config
+
+#### Defined in
+
+core/src/sdk.ts:23
+
+___
+
+### \_endPoint
+
+• `Protected` **\_endPoint**: `string`
+
+#### Inherited from
+
+BaseTrack.\_endPoint
+
+#### Defined in
+
+core/src/basicTrack.ts:9
+
+___
+
+### \_history
+
+• **\_history**: `IHistory`
+
+#### Overrides
+
+BaseTrack.\_history
+
+#### Defined in
+
+core/src/sdk.ts:26
+
+___
+
+### \_platform
+
+• `Protected` **\_platform**: [`PlatformType`](../wiki/@medici.core#platformtype)
+
+#### Overrides
+
+BaseTrack.\_platform
+
+#### Defined in
+
+core/src/sdk.ts:22
+
+___
+
+### \_trackEndPoint
+
+• `Protected` **\_trackEndPoint**: `string`
+
+#### Inherited from
+
+BaseTrack.\_trackEndPoint
+
+#### Defined in
+
+core/src/basicTrack.ts:10
+
+___
+
+### eventer
+
+• **eventer**: `Eventer`
+
+#### Defined in
+
+core/src/sdk.ts:25
+
+## Methods
+
+### endTrack
+
+▸ **endTrack**(`trackActionName`, `trackActionOption?`): `Promise`<`XMLHttpRequestResponseType`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `trackActionName` | `string` |
+| `trackActionOption?` | `TrackActionOption` |
+
+#### Returns
+
+`Promise`<`XMLHttpRequestResponseType`\>
+
+#### Inherited from
+
+BaseTrack.endTrack
+
+#### Defined in
+
+core/src/basicTrack.ts:84
+
+___
+
+### sendEvent
+
+▸ **sendEvent**(`value`, `type`, `url?`, `uuid?`): `Promise`<`XMLHttpRequestResponseType`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+| `type` | `string` |
+| `url?` | `string` |
+| `uuid?` | `string` |
+
+#### Returns
+
+`Promise`<`XMLHttpRequestResponseType`\>
+
+#### Inherited from
+
+BaseTrack.sendEvent
+
+#### Defined in
+
+core/src/basicTrack.ts:47
+
+___
+
+### setConfig
+
+▸ **setConfig**(`config`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `config` | [`SDKInitConfig`](../wiki/@medici.core.SDKInitConfig) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+core/src/sdk.ts:34
+
+___
+
+### startTrack
+
+▸ **startTrack**(`trackActionName`, `trackActionOption?`): `Promise`<`XMLHttpRequestResponseType`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `trackActionName` | `string` |
+| `trackActionOption?` | `TrackActionOption` |
+
+#### Returns
+
+`Promise`<`XMLHttpRequestResponseType`\>
+
+#### Inherited from
+
+BaseTrack.startTrack
+
+#### Defined in
+
+core/src/basicTrack.ts:69
+
+___
+
+### track
+
+▸ **track**(`trackActionName`, `trackActionOption?`): `Promise`<`XMLHttpRequestResponseType`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `trackActionName` | `string` |
+| `trackActionOption?` | `TrackActionOption` |
+
+#### Returns
+
+`Promise`<`XMLHttpRequestResponseType`\>
+
+#### Inherited from
+
+BaseTrack.track
+
+#### Defined in
+
+core/src/basicTrack.ts:59
+
+___
+
+### trackEvent
+
+▸ **trackEvent**(`event_name`, `event_data`, `url?`, `uuid?`): `Promise`<`XMLHttpRequestResponseType`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event_name` | `string` |
+| `event_data` | `string` |
+| `url?` | `string` |
+| `uuid?` | `string` |
+
+#### Returns
+
+`Promise`<`XMLHttpRequestResponseType`\>
+
+#### Inherited from
+
+BaseTrack.trackEvent
+
+#### Defined in
+
+core/src/basicTrack.ts:33
+
+___
+
+### trackView
+
+▸ **trackView**(`url`, `referrer`, `uuid`): `Promise`<`XMLHttpRequestResponseType`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+| `referrer` | `string` |
+| `uuid` | `string` |
+
+#### Returns
+
+`Promise`<`XMLHttpRequestResponseType`\>
+
+#### Inherited from
+
+BaseTrack.trackView
+
+#### Defined in
+
+core/src/basicTrack.ts:21

docs/@medici.core.SDKConfigType.md

@@ -0,0 +1,74 @@
+# Interface: SDKConfigType
+
+[@medici/core](../wiki/@medici.core).SDKConfigType
+
+## Table of contents
+
+### Properties
+
+- [appId](../wiki/@medici.core.SDKConfigType#appid)
+- [autoTrack](../wiki/@medici.core.SDKConfigType#autotrack)
+- [config](../wiki/@medici.core.SDKConfigType#config)
+- [endPoint](../wiki/@medici.core.SDKConfigType#endpoint)
+- [platform](../wiki/@medici.core.SDKConfigType#platform)
+- [trackEndPoint](../wiki/@medici.core.SDKConfigType#trackendpoint)
+
+## Properties
+
+### appId
+
+• **appId**: `string`
+
+#### Defined in
+
+core/src/sdk.ts:15
+
+___
+
+### autoTrack
+
+• `Optional` **autoTrack**: `boolean`
+
+#### Defined in
+
+core/src/sdk.ts:17
+
+___
+
+### config
+
+• `Optional` **config**: [`SDKInitConfig`](../wiki/@medici.core.SDKInitConfig)
+
+#### Defined in
+
+core/src/sdk.ts:18
+
+___
+
+### endPoint
+
+• **endPoint**: `string`
+
+#### Defined in
+
+core/src/sdk.ts:14
+
+___
+
+### platform
+
+• `Optional` **platform**: [`PlatformType`](../wiki/@medici.core#platformtype)
+
+#### Defined in
+
+core/src/sdk.ts:16
+
+___
+
+### trackEndPoint
+
+• `Optional` **trackEndPoint**: `string`
+
+#### Defined in
+
+core/src/sdk.ts:19

docs/@medici.core.SDKInitConfig.md

@@ -0,0 +1,30 @@
+# Interface: SDKInitConfig
+
+[@medici/core](../wiki/@medici.core).SDKInitConfig
+
+## Table of contents
+
+### Properties
+
+- [user](../wiki/@medici.core.SDKInitConfig#user)
+- [version](../wiki/@medici.core.SDKInitConfig#version)
+
+## Properties
+
+### user
+
+• `Optional` **user**: `string`
+
+#### Defined in
+
+core/src/sdk.ts:10
+
+___
+
+### version
+
+• `Optional` **version**: `string`
+
+#### Defined in
+
+core/src/sdk.ts:11

docs/@medici.core.md

@@ -0,0 +1,26 @@
+# Module: @medici/core
+
+## Table of contents
+
+### Classes
+
+- [SDK](../wiki/@medici.core.SDK)
+
+### Interfaces
+
+- [SDKConfigType](../wiki/@medici.core.SDKConfigType)
+- [SDKInitConfig](../wiki/@medici.core.SDKInitConfig)
+
+### Type Aliases
+
+- [PlatformType](../wiki/@medici.core#platformtype)
+
+## Type Aliases
+
+### PlatformType
+
+Ƭ **PlatformType**: ``"web"`` \| ``"miniApp"``
+
+#### Defined in
+
+core/src/sdk.ts:7

docs/@medici.foo.md

@@ -0,0 +1,17 @@
+# Module: @medici/foo
+
+## Table of contents
+
+### Variables
+
+- [meaningOfLife](../wiki/@medici.foo#meaningoflife)
+
+## Variables
+
+### meaningOfLife
+
+• `Const` **meaningOfLife**: ``42``
+
+#### Defined in
+
+foo/src/index.ts:1

docs/@medici.types.BrowserTransportOptions.md

@@ -0,0 +1,30 @@
+# Interface: BrowserTransportOptions
+
+[@medici/types](../wiki/@medici.types).BrowserTransportOptions
+
+## Table of contents
+
+### Properties
+
+- [data](../wiki/@medici.types.BrowserTransportOptions#data)
+- [url](../wiki/@medici.types.BrowserTransportOptions#url)
+
+## Properties
+
+### data
+
+• **data**: `any`
+
+#### Defined in
+
+types/src/browser.ts:3
+
+___
+
+### url
+
+• **url**: `string`
+
+#### Defined in
+
+types/src/browser.ts:2

docs/@medici.types.GlobalEventType.md

@@ -0,0 +1,52 @@
+# Interface: GlobalEventType
+
+[@medici/types](../wiki/@medici.types).GlobalEventType
+
+## Table of contents
+
+### Properties
+
+- [eventName](../wiki/@medici.types.GlobalEventType#eventname)
+- [eventVariable](../wiki/@medici.types.GlobalEventType#eventvariable)
+- [id](../wiki/@medici.types.GlobalEventType#id)
+- [triggerTime](../wiki/@medici.types.GlobalEventType#triggertime)
+
+## Properties
+
+### eventName
+
+• **eventName**: `string`
+
+#### Defined in
+
+types/src/event.ts:6
+
+___
+
+### eventVariable
+
+• **eventVariable**: `string`
+
+#### Defined in
+
+types/src/event.ts:7
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+types/src/event.ts:5
+
+___
+
+### triggerTime
+
+• **triggerTime**: `number`
+
+#### Defined in
+
+types/src/event.ts:8

docs/@medici.types.HistoryEvent.md

@@ -0,0 +1,46 @@
+# Interface: HistoryEvent
+
+[@medici/types](../wiki/@medici.types).HistoryEvent
+
+## Table of contents
+
+### Methods
+
+- [addEvent](../wiki/@medici.types.HistoryEvent#addevent)
+- [handlePushState](../wiki/@medici.types.HistoryEvent#handlepushstate)
+
+## Methods
+
+### addEvent
+
+▸ **addEvent**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+types/src/history.ts:3
+
+___
+
+### handlePushState
+
+▸ **handlePushState**(`state`, `title`, `url`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | `string` |
+| `title` | `string` |
+| `url` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+types/src/history.ts:2

docs/@medici.types.IBaseAction.md

@@ -0,0 +1,79 @@
+# Interface: IBaseAction
+
+[@medici/types](../wiki/@medici.types).IBaseAction
+
+## Table of contents
+
+### Methods
+
+- [sendEvent](../wiki/@medici.types.IBaseAction#sendevent)
+- [trackEvent](../wiki/@medici.types.IBaseAction#trackevent)
+- [trackView](../wiki/@medici.types.IBaseAction#trackview)
+
+## Methods
+
+### sendEvent
+
+▸ **sendEvent**(`value`, `type`, `url?`, `uuid?`): [`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+| `type` | `string` |
+| `url?` | `string` |
+| `uuid?` | `string` |
+
+#### Returns
+
+[`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Defined in
+
+types/src/event.ts:20
+
+___
+
+### trackEvent
+
+▸ **trackEvent**(`event_name`, `event_data`, `url?`, `uuid?`): [`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event_name` | `string` |
+| `event_data` | `string` |
+| `url?` | `string` |
+| `uuid?` | `string` |
+
+#### Returns
+
+[`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Defined in
+
+types/src/event.ts:19
+
+___
+
+### trackView
+
+▸ **trackView**(`url`, `referrer`, `uuid`): [`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+| `referrer` | `string` |
+| `uuid` | `string` |
+
+#### Returns
+
+[`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Defined in
+
+types/src/event.ts:18

docs/@medici.types.ICustomAction.md

@@ -0,0 +1,74 @@
+# Interface: ICustomAction
+
+[@medici/types](../wiki/@medici.types).ICustomAction
+
+## Table of contents
+
+### Methods
+
+- [endTrack](../wiki/@medici.types.ICustomAction#endtrack)
+- [startTrack](../wiki/@medici.types.ICustomAction#starttrack)
+- [track](../wiki/@medici.types.ICustomAction#track)
+
+## Methods
+
+### endTrack
+
+▸ **endTrack**(`trackActionName`, `trackActionOption?`): [`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `trackActionName` | `string` |
+| `trackActionOption?` | [`TrackActionOption`](../wiki/@medici.types.TrackActionOption) |
+
+#### Returns
+
+[`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Defined in
+
+types/src/event.ts:26
+
+___
+
+### startTrack
+
+▸ **startTrack**(`trackActionName`, `trackActionOption?`): [`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `trackActionName` | `string` |
+| `trackActionOption?` | [`TrackActionOption`](../wiki/@medici.types.TrackActionOption) |
+
+#### Returns
+
+[`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Defined in
+
+types/src/event.ts:25
+
+___
+
+### track
+
+▸ **track**(`trackActionName`, `trackActionOption?`): [`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `trackActionName` | `string` |
+| `trackActionOption?` | [`TrackActionOption`](../wiki/@medici.types.TrackActionOption) |
+
+#### Returns
+
+[`EventReturnType`](../wiki/@medici.types#eventreturntype)
+
+#### Defined in
+
+types/src/event.ts:24

docs/@medici.types.SDKPlatformType.md

@@ -0,0 +1,41 @@
+# Enumeration: SDKPlatformType
+
+[@medici/types](../wiki/@medici.types).SDKPlatformType
+
+## Table of contents
+
+### Enumeration Members
+
+- [miniApp](../wiki/@medici.types.SDKPlatformType#miniapp)
+- [web](../wiki/@medici.types.SDKPlatformType#web)
+- [webview](../wiki/@medici.types.SDKPlatformType#webview)
+
+## Enumeration Members
+
+### miniApp
+
+• **miniApp** = ``1``
+
+#### Defined in
+
+types/src/sdk.ts:3
+
+___
+
+### web
+
+• **web** = ``0``
+
+#### Defined in
+
+types/src/sdk.ts:2
+
+___
+
+### webview
+
+• **webview** = ``2``
+
+#### Defined in
+
+types/src/sdk.ts:4

docs/@medici.types.SDKconfigType.md

@@ -0,0 +1,63 @@
+# Interface: SDKconfigType
+
+[@medici/types](../wiki/@medici.types).SDKconfigType
+
+## Table of contents
+
+### Properties
+
+- [Platform](../wiki/@medici.types.SDKconfigType#platform)
+- [appId](../wiki/@medici.types.SDKconfigType#appid)
+- [from](../wiki/@medici.types.SDKconfigType#from)
+- [user](../wiki/@medici.types.SDKconfigType#user)
+- [version](../wiki/@medici.types.SDKconfigType#version)
+
+## Properties
+
+### Platform
+
+• **Platform**: [`SDKPlatformType`](../wiki/@medici.types.SDKPlatformType)
+
+#### Defined in
+
+types/src/sdk.ts:9
+
+___
+
+### appId
+
+• **appId**: `string`
+
+#### Defined in
+
+types/src/sdk.ts:11
+
+___
+
+### from
+
+• `Optional` **from**: `string`
+
+#### Defined in
+
+types/src/sdk.ts:10
+
+___
+
+### user
+
+• **user**: `string`
+
+#### Defined in
+
+types/src/sdk.ts:7
+
+___
+
+### version
+
+• **version**: `string`
+
+#### Defined in
+
+types/src/sdk.ts:8

docs/@medici.types.TrackActionOption.md

@@ -0,0 +1,36 @@
+# Interface: TrackActionOption
+
+[@medici/types](../wiki/@medici.types).TrackActionOption
+
+## Hierarchy
+
+- [`Dict`](../wiki/@medici.types#dict)<`any`\>
+
+  ↳ **`TrackActionOption`**
+
+## Table of contents
+
+### Properties
+
+- [eventType](../wiki/@medici.types.TrackActionOption#eventtype)
+- [maxWaitTime](../wiki/@medici.types.TrackActionOption#maxwaittime)
+
+## Properties
+
+### eventType
+
+• **eventType**: `string`
+
+#### Defined in
+
+types/src/event.ts:12
+
+___
+
+### maxWaitTime
+
+• `Optional` **maxWaitTime**: `number`
+
+#### Defined in
+
+types/src/event.ts:13

docs/@medici.types.md

@@ -0,0 +1,74 @@
+# Module: @medici/types
+
+## Table of contents
+
+### Enumerations
+
+- [SDKPlatformType](../wiki/@medici.types.SDKPlatformType)
+
+### Interfaces
+
+- [BrowserTransportOptions](../wiki/@medici.types.BrowserTransportOptions)
+- [GlobalEventType](../wiki/@medici.types.GlobalEventType)
+- [HistoryEvent](../wiki/@medici.types.HistoryEvent)
+- [IBaseAction](../wiki/@medici.types.IBaseAction)
+- [ICustomAction](../wiki/@medici.types.ICustomAction)
+- [SDKconfigType](../wiki/@medici.types.SDKconfigType)
+- [TrackActionOption](../wiki/@medici.types.TrackActionOption)
+
+### Type Aliases
+
+- [Dict](../wiki/@medici.types#dict)
+- [EventNameEnumType](../wiki/@medici.types#eventnameenumtype)
+- [EventReturnType](../wiki/@medici.types#eventreturntype)
+- [TrackEventType](../wiki/@medici.types#trackeventtype)
+
+## Type Aliases
+
+### Dict
+
+Ƭ **Dict**<`T`\>: `Object`
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Index signature
+
+▪ [key: `string`]: `T`
+
+#### Defined in
+
+types/src/event.ts:2
+
+___
+
+### EventNameEnumType
+
+Ƭ **EventNameEnumType**: ``"pageview"`` \| ``""``
+
+#### Defined in
+
+types/src/event.ts:1
+
+___
+
+### EventReturnType
+
+Ƭ **EventReturnType**: `Promise`<`XMLHttpRequestResponseType`\>
+
+#### Defined in
+
+types/src/event.ts:16
+
+___
+
+### TrackEventType
+
+Ƭ **TrackEventType**: ``"click"`` \| ``"menu"``
+
+#### Defined in
+
+types/src/event.ts:10

docs/@medici.utils.md

@@ -0,0 +1,62 @@
+# Module: @medici/utils
+
+## Table of contents
+
+### Functions
+
+- [getGlobalObject](../wiki/@medici.utils#getglobalobject)
+- [hook](../wiki/@medici.utils#hook)
+
+## Functions
+
+### getGlobalObject
+
+▸ **getGlobalObject**<`T`\>(): `T`
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Returns
+
+`T`
+
+#### Defined in
+
+utils/src/global.ts:3
+
+___
+
+### hook
+
+▸ **hook**(`_this`, `method`, `callback`): (...`args`: `any`[]) => `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `_this` | `any` |
+| `method` | `string` |
+| `callback` | `CallbackType` |
+
+#### Returns
+
+`fn`
+
+▸ (...`args`): `any`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `...args` | `any`[] |
+
+##### Returns
+
+`any`
+
+#### Defined in
+
+utils/src/hook.ts:3

docs/@medici.web.md

@@ -0,0 +1,27 @@
+# Module: @medici/web
+
+## Table of contents
+
+### Functions
+
+- [init](../wiki/@medici.web#init)
+
+## Functions
+
+### init
+
+▸ **init**(`initParams`): `SDK`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `initParams` | `SDKConfigType` |
+
+#### Returns
+
+`SDK`
+
+#### Defined in
+
+web/src/init.ts:3

docs/Exports.md

@@ -0,0 +1,11 @@
+# Documentation
+
+## Table of contents
+
+### Modules
+
+- [@medici/core](../wiki/@medici.core)
+- [@medici/foo](../wiki/@medici.foo)
+- [@medici/types](../wiki/@medici.types)
+- [@medici/utils](../wiki/@medici.utils)
+- [@medici/web](../wiki/@medici.web)

docs/Home.md

@@ -0,0 +1 @@
+

docs/_Sidebar.md

@@ -0,0 +1,12 @@
+## Documentation
+
+- [Home](../wiki/Home)
+- [Exports](../wiki/Exports)
+
+### Modules
+
+- [@medici/core](../wiki/@medici.core)
+- [@medici/foo](../wiki/@medici.foo)
+- [@medici/types](../wiki/@medici.types)
+- [@medici/utils](../wiki/@medici.utils)
+- [@medici/web](../wiki/@medici.web)

package.json

@@ -8,13 +8,13 @@
         "examples/*"
     ],
     "scripts": {
-        "docs": "doctoc --title '**Table of content**' README.md",
         "dev": "pnpm -C play dev",
         "clean": "pnpm run -r clean",
         "build": "pnpm run -r build",
         "test": "pnpm run -r test",
         "lint": "eslint --fix --ext js,ts,tsx .",
-        "publish": "pnpm publish --filter @medici/core @medici/web @medici/types @medici/utils"
+        "publish": "pnpm publish --filter @medici/core @medici/web @medici/types @medici/utils",
+        "docs": "pnpm typedoc --theme github-wiki --entryPointStrategy packages ."
     },
     "devDependencies": {
         "@changesets/cli": "^2.24.3",
@@ -26,6 +26,9 @@
         "eslint-plugin-import": "~2.26.0",
         "eslint-plugin-prettier": "^4.2.1",
         "prettier": "^2.7.1",
+        "typedoc": "^0.23.10",
+        "typedoc-github-wiki-theme": "^1.0.1",
+        "typedoc-plugin-markdown": "^3.13.4",
         "typescript": "~4.7.4"
     },
     "pnpm": {

packages/core/README.md

@@ -0,0 +1,5 @@
+# @medici/core
+
+```js
+npm install @medici/core
+```

packages/core/package.json

@@ -30,5 +30,10 @@
     "tslib": "^2.4.0",
     "rollup-plugin-terser": "^7.0.2",
     "typescript": "~4.7.4"
-  }
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "./README.md",
+    "displayName": "@medici/core"
+}
 }

play/index.html

@@ -5,12 +5,12 @@
         <link rel="icon" type="image/svg+xml" href="/vite.svg" />
         <meta name="viewport" content="width=device-width, initial-scale=1.0" />
         <title>Medici SDK</title>
-        <!-- <script async defer
+        <script async defer
          data-app-id="7b5958d5-1ae6-4ad5-8a87-5fc8a4b92999" 
          data-url="http://192.168.0.186:3000/api/collect" 
          data-track-url="http://192.168.0.186:3000/api/track" 
          src="https://allreally.oss-cn-shenzhen.aliyuncs.com/wasm/test_legacy/medici.js">
-        </script> -->
+        </script>
 
         <!-- <script async defer data-website-id="7b5958d5-1ae6-4ad5-8a87-5fc8a4b92999" src="http://192.168.0.186:3000/medici.js"></script> -->
     </head>

play/src/App.vue

@@ -2,20 +2,20 @@
 // This starter template is using Vue 3 <script setup> SFCs
 // Check out https://vuejs.org/api/sfc-script-setup.html#script-setup
 import HelloWorld from './components/HelloWorld.vue';
-import * as Medici from '@medici/web';
+// import * as Medici from '@medici/web';
 
-const medici = Medici.init({
-    platform: 'web',
-    appId: '7b5958d5-1ae6-4ad5-8a87-5fc8a4b92999',
-    endPoint: 'http://192.168.0.186:3000/api/collect', //服务器
-    trackEndPoint: 'http://192.168.0.186:3000/api/track',
-    config: {
-        user: 'testUser',
-        version: '1',
-    },
-});
-console.log('medici', medici);
-(window as any).medici = medici;
+// const medici = Medici.init({
+//     platform: 'web',
+//     appId: '7b5958d5-1ae6-4ad5-8a87-5fc8a4b92999',
+//     endPoint: 'http://192.168.0.186:3000/api/collect', //服务器
+//     trackEndPoint: 'http://192.168.0.186:3000/api/track',
+//     config: {
+//         user: 'testUser',
+//         version: '1',
+//     },
+// });
+// console.log('medici', medici);
+// (window as any).medici = medici;
 
 
 

pnpm-lock.yaml

@@ -13,6 +13,9 @@ importers:
       eslint-plugin-import: ~2.26.0
       eslint-plugin-prettier: ^4.2.1
       prettier: ^2.7.1
+      typedoc: ^0.23.10
+      typedoc-github-wiki-theme: ^1.0.1
+      typedoc-plugin-markdown: ^3.13.4
       typescript: ~4.7.4
     devDependencies:
       '@changesets/cli': 2.24.3
@@ -24,6 +27,9 @@ importers:
       eslint-plugin-import: 2.26.0_w6hyi6a46houmo6i7chjqdbh2e
       eslint-plugin-prettier: 4.2.1_7uxdfn2xinezdgvmbammh6ev5i
       prettier: 2.7.1
+      typedoc: 0.23.10_typescript@4.7.4
+      typedoc-github-wiki-theme: 1.0.1_e6antoqkoip4fafe7ecefzcrwu
+      typedoc-plugin-markdown: 3.13.4_typedoc@0.23.10
       typescript: 4.7.4
 
   packages/core:
@@ -998,6 +1004,12 @@ packages:
       concat-map: 0.0.1
     dev: true
 
+  /brace-expansion/2.0.1:
+    resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==}
+    dependencies:
+      balanced-match: 1.0.2
+    dev: true
+
   /braces/3.0.2:
     resolution: {integrity: sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==}
     engines: {node: '>=8'}
@@ -2079,6 +2091,19 @@ packages:
     resolution: {integrity: sha512-bzh50DW9kTPM00T8y4o8vQg89Di9oLJVLW/KaOGIXJWP/iqCN6WKYkbNOF04vFLJhwcpYUh9ydh/+5vpOqV4YQ==}
     dev: true
 
+  /handlebars/4.7.7:
+    resolution: {integrity: sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==}
+    engines: {node: '>=0.4.7'}
+    hasBin: true
+    dependencies:
+      minimist: 1.2.6
+      neo-async: 2.6.2
+      source-map: 0.6.1
+      wordwrap: 1.0.0
+    optionalDependencies:
+      uglify-js: 3.17.0
+    dev: true
+
   /hard-rejection/2.1.0:
     resolution: {integrity: sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==}
     engines: {node: '>=6'}
@@ -2420,6 +2445,10 @@ packages:
       minimist: 1.2.6
     dev: true
 
+  /jsonc-parser/3.1.0:
+    resolution: {integrity: sha512-DRf0QjnNeCUds3xTjKlQQ3DpJD51GvDjJfnxUVWg6PZTo2otSm+slzNAxU/35hF8/oJIKoG9slq30JYOsF2azg==}
+    dev: true
+
   /jsonfile/4.0.0:
     resolution: {integrity: sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==}
     optionalDependencies:
@@ -2498,6 +2527,10 @@ packages:
       yallist: 4.0.0
     dev: true
 
+  /lunr/2.3.9:
+    resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==}
+    dev: true
+
   /magic-string/0.25.9:
     resolution: {integrity: sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==}
     dependencies:
@@ -2519,6 +2552,12 @@ packages:
       repeat-string: 1.6.1
     dev: true
 
+  /marked/4.0.19:
+    resolution: {integrity: sha512-rgQF/OxOiLcvgUAj1Q1tAf4Bgxn5h5JZTp04Fx4XUkVhs7B+7YA9JEWJhJpoO8eJt8MkZMwqLCNeNqj1bCREZQ==}
+    engines: {node: '>= 12'}
+    hasBin: true
+    dev: true
+
   /mdast-util-find-and-replace/1.1.1:
     resolution: {integrity: sha512-9cKl33Y21lyckGzpSmEQnIDjEfeeWelN5s1kUW1LwdB0Fkuq2u+4GdqcGEygYxJE8GVqCl0741bYXHgamfWAZA==}
     dependencies:
@@ -2727,6 +2766,13 @@ packages:
       brace-expansion: 1.1.11
     dev: true
 
+  /minimatch/5.1.0:
+    resolution: {integrity: sha512-9TPBGGak4nHfGZsPBohm9AWg6NoT7QTCehS3BIJABslyZbzxfV78QM2Y6+i741OPZIafFAaiiEMh5OyIrJPgtg==}
+    engines: {node: '>=10'}
+    dependencies:
+      brace-expansion: 2.0.1
+    dev: true
+
   /minimist-options/4.1.0:
     resolution: {integrity: sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==}
     engines: {node: '>= 6'}
@@ -2766,6 +2812,10 @@ packages:
     resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==}
     dev: true
 
+  /neo-async/2.6.2:
+    resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==}
+    dev: true
+
   /normalize-package-data/2.5.0:
     resolution: {integrity: sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==}
     dependencies:
@@ -3233,6 +3283,14 @@ packages:
     engines: {node: '>=8'}
     dev: true
 
+  /shiki/0.10.1:
+    resolution: {integrity: sha512-VsY7QJVzU51j5o1+DguUd+6vmCmZ5v/6gYu4vyYAhzjuNQU6P/vmSy4uQaOhvje031qQMiW0d2BwgMH52vqMng==}
+    dependencies:
+      jsonc-parser: 3.1.0
+      vscode-oniguruma: 1.6.2
+      vscode-textmate: 5.2.0
+    dev: true
+
   /side-channel/1.0.4:
     resolution: {integrity: sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==}
     dependencies:
@@ -3506,12 +3564,53 @@ packages:
     engines: {node: '>=8'}
     dev: true
 
+  /typedoc-github-wiki-theme/1.0.1_e6antoqkoip4fafe7ecefzcrwu:
+    resolution: {integrity: sha512-FaO7fENGK6IJLpkddbNXxJfNbooF9KBC7xfk7Lj4uqG5SCC7YQFPTLDyNmbpJKO93QEenRYgqBwI5E5d/bKrHw==}
+    peerDependencies:
+      typedoc: '>=0.22.9'
+      typedoc-plugin-markdown: '>=3.11.10'
+    dependencies:
+      typedoc: 0.23.10_typescript@4.7.4
+      typedoc-plugin-markdown: 3.13.4_typedoc@0.23.10
+    dev: true
+
+  /typedoc-plugin-markdown/3.13.4_typedoc@0.23.10:
+    resolution: {integrity: sha512-E/EBBmu6ARtnbswZGtBVBB/BfukZiGMOlqPc0RXCI/NFitONBahFqbCAF5fKQlijlcfipJj5pw5AMFH3NytrAw==}
+    peerDependencies:
+      typedoc: '>=0.23.0'
+    dependencies:
+      handlebars: 4.7.7
+      typedoc: 0.23.10_typescript@4.7.4
+    dev: true
+
+  /typedoc/0.23.10_typescript@4.7.4:
+    resolution: {integrity: sha512-03EUiu/ZuScUBMnY6p0lY+HTH8SwhzvRE3gImoemdPDWXPXlks83UGTx++lyquWeB1MTwm9D9Ca8RIjkK3AFfQ==}
+    engines: {node: '>= 14.14'}
+    hasBin: true
+    peerDependencies:
+      typescript: 4.6.x || 4.7.x
+    dependencies:
+      lunr: 2.3.9
+      marked: 4.0.19
+      minimatch: 5.1.0
+      shiki: 0.10.1
+      typescript: 4.7.4
+    dev: true
+
   /typescript/4.7.4:
     resolution: {integrity: sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==}
     engines: {node: '>=4.2.0'}
     hasBin: true
     dev: true
 
+  /uglify-js/3.17.0:
+    resolution: {integrity: sha512-aTeNPVmgIMPpm1cxXr2Q/nEbvkmV8yq66F3om7X3P/cvOXQ0TMQ64Wk63iyT1gPlmdmGzjGpyLh1f3y8MZWXGg==}
+    engines: {node: '>=0.8.0'}
+    hasBin: true
+    requiresBuild: true
+    dev: true
+    optional: true
+
   /unbox-primitive/1.0.2:
     resolution: {integrity: sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==}
     dependencies:
@@ -3528,6 +3627,7 @@ packages:
   /unified/9.2.2:
     resolution: {integrity: sha512-Sg7j110mtefBD+qunSLO1lqOEKdrwBFBrR6Qd8f4uwkhWNlbkaqwHse6e7QvD3AP/MNoJdEDLaf8OxYyoWgorQ==}
     dependencies:
+      '@types/unist': 2.0.6
       bail: 1.0.5
       extend: 3.0.2
       is-buffer: 2.0.5
@@ -3634,6 +3734,14 @@ packages:
       fsevents: 2.3.2
     dev: true
 
+  /vscode-oniguruma/1.6.2:
+    resolution: {integrity: sha512-KH8+KKov5eS/9WhofZR8M8dMHWN2gTxjMsG4jd04YhpbPR91fUj7rYQ2/XjeHCJWbg7X++ApRIU9NUwM2vTvLA==}
+    dev: true
+
+  /vscode-textmate/5.2.0:
+    resolution: {integrity: sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==}
+    dev: true
+
   /vue-router/4.1.4_vue@3.2.37:
     resolution: {integrity: sha512-UgYen33gOtwT3cOG1+yRen+Brk9py8CSlC9LEa3UjvKZ4EAoSo8NjZPDeDnmNerfazorHIJG1NC7qdi1SuQJnQ==}
     peerDependencies:
@@ -3710,6 +3818,10 @@ packages:
     engines: {node: '>=0.10.0'}
     dev: true
 
+  /wordwrap/1.0.0:
+    resolution: {integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==}
+    dev: true
+
   /wrap-ansi/6.2.0:
     resolution: {integrity: sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==}
     engines: {node: '>=8'}