Explorar el Código

更新doc for html

gemercheung hace 3 años
padre
commit
086b4e513d
Se han modificado 59 ficheros con 3907 adiciones y 1139 borrados
  1. 0 1
      docs/README.md
  2. 120 0
      docs/assets/highlight.css
  3. 54 0
      docs/assets/main.js
  4. 1 0
      docs/assets/search.js
  5. 1224 0
      docs/assets/style.css
  6. BIN
      docs/assets/widgets.png
  7. BIN
      docs/assets/widgets@2x.png
  8. 282 0
      docs/classes/_medici_core.SDK.html
  9. 0 326
      docs/classes/medici_core.SDK.md
  10. 83 0
      docs/enums/_medici_types.SDKPlatformType.html
  11. 0 43
      docs/enums/medici_types.SDKPlatformType.md
  12. 61 0
      docs/functions/_medici_legacy.init.html
  13. 62 0
      docs/functions/_medici_utils.getGlobalObject.html
  14. 77 0
      docs/functions/_medici_utils.hook.html
  15. 61 0
      docs/functions/_medici_web.init.html
  16. 43 0
      docs/index.html
  17. 108 0
      docs/interfaces/_medici_core.SDKConfigType.html
  18. 80 0
      docs/interfaces/_medici_core.SDKInitConfig.html
  19. 80 0
      docs/interfaces/_medici_types.BrowserTransportOptions.html
  20. 94 0
      docs/interfaces/_medici_types.GlobalEventType.html
  21. 95 0
      docs/interfaces/_medici_types.HistoryEvent.html
  22. 127 0
      docs/interfaces/_medici_types.IBaseAction.html
  23. 117 0
      docs/interfaces/_medici_types.ICustomAction.html
  24. 101 0
      docs/interfaces/_medici_types.SDKconfigType.html
  25. 82 0
      docs/interfaces/_medici_types.TrackActionOption.html
  26. 0 76
      docs/interfaces/medici_core.SDKConfigType.md
  27. 0 32
      docs/interfaces/medici_core.SDKInitConfig.md
  28. 0 32
      docs/interfaces/medici_types.BrowserTransportOptions.md
  29. 0 54
      docs/interfaces/medici_types.GlobalEventType.md
  30. 0 48
      docs/interfaces/medici_types.HistoryEvent.md
  31. 0 81
      docs/interfaces/medici_types.IBaseAction.md
  32. 0 76
      docs/interfaces/medici_types.ICustomAction.md
  33. 0 65
      docs/interfaces/medici_types.SDKconfigType.md
  34. 0 38
      docs/interfaces/medici_types.TrackActionOption.md
  35. 54 0
      docs/modules.html
  36. 0 13
      docs/modules.md
  37. 87 0
      docs/modules/_medici_core.html
  38. 59 0
      docs/modules/_medici_foo.html
  39. 68 0
      docs/modules/_medici_legacy.html
  40. 87 0
      docs/modules/_medici_types.html
  41. 61 0
      docs/modules/_medici_utils.html
  42. 72 0
      docs/modules/_medici_web.html
  43. 0 28
      docs/modules/medici_core.md
  44. 0 19
      docs/modules/medici_foo.md
  45. 0 76
      docs/modules/medici_types.md
  46. 0 64
      docs/modules/medici_utils.md
  47. 0 29
      docs/modules/medici_web.md
  48. 55 0
      docs/types/_medici_core.PlatformType.html
  49. 72 0
      docs/types/_medici_types.Dict.html
  50. 63 0
      docs/types/_medici_types.EventNameEnumType.html
  51. 63 0
      docs/types/_medici_types.EventReturnType.html
  52. 63 0
      docs/types/_medici_types.TrackEventType.html
  53. 52 0
      docs/variables/_medici_foo.meaningOfLife.html
  54. 1 1
      package.json
  55. 20 2
      packages/core/README.md
  56. 14 2
      packages/legacy/README.md
  57. 37 32
      packages/legacy/package.json
  58. 21 0
      packages/web/README.md
  59. 6 1
      packages/web/package.json

+ 0 - 1
docs/README.md

@@ -1 +0,0 @@
-Documentation / [Exports](modules.md)

+ 120 - 0
docs/assets/highlight.css

@@ -0,0 +1,120 @@
+:root {
+    --light-hl-0: #AF00DB;
+    --dark-hl-0: #C586C0;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #0000FF;
+    --dark-hl-2: #569CD6;
+    --light-hl-3: #001080;
+    --dark-hl-3: #9CDCFE;
+    --light-hl-4: #A31515;
+    --dark-hl-4: #CE9178;
+    --light-hl-5: #0070C1;
+    --dark-hl-5: #4FC1FF;
+    --light-hl-6: #795E26;
+    --dark-hl-6: #DCDCAA;
+    --light-hl-7: #008000;
+    --dark-hl-7: #6A9955;
+    --light-hl-8: #267F99;
+    --dark-hl-8: #4EC9B0;
+    --light-hl-9: #800000;
+    --dark-hl-9: #808080;
+    --light-hl-10: #800000;
+    --dark-hl-10: #569CD6;
+    --light-hl-11: #000000FF;
+    --dark-hl-11: #D4D4D4;
+    --light-hl-12: #FF0000;
+    --dark-hl-12: #9CDCFE;
+    --light-hl-13: #0000FF;
+    --dark-hl-13: #CE9178;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --hl-13: var(--light-hl-13);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --hl-13: var(--dark-hl-13);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --hl-13: var(--light-hl-13);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --hl-13: var(--dark-hl-13);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
+.hl-12 { color: var(--hl-12); }
+.hl-13 { color: var(--hl-13); }
+pre, code { background: var(--code-background); }

La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 54 - 0
docs/assets/main.js


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 1 - 0
docs/assets/search.js


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 1224 - 0
docs/assets/style.css


BIN
docs/assets/widgets.png


BIN
docs/assets/widgets@2x.png


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 282 - 0
docs/classes/_medici_core.SDK.html


+ 0 - 326
docs/classes/medici_core.SDK.md

@@ -1,326 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / [@medici/core](../modules/medici_core.md) / SDK
-
-# Class: SDK
-
-[@medici/core](../modules/medici_core.md).SDK
-
-## Hierarchy
-
-- `BaseTrack`
-
-  ↳ **`SDK`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](medici_core.SDK.md#constructor)
-
-### Properties
-
-- [\_appId](medici_core.SDK.md#_appid)
-- [\_config](medici_core.SDK.md#_config)
-- [\_endPoint](medici_core.SDK.md#_endpoint)
-- [\_history](medici_core.SDK.md#_history)
-- [\_platform](medici_core.SDK.md#_platform)
-- [\_trackEndPoint](medici_core.SDK.md#_trackendpoint)
-- [eventer](medici_core.SDK.md#eventer)
-
-### Methods
-
-- [endTrack](medici_core.SDK.md#endtrack)
-- [sendEvent](medici_core.SDK.md#sendevent)
-- [setConfig](medici_core.SDK.md#setconfig)
-- [startTrack](medici_core.SDK.md#starttrack)
-- [track](medici_core.SDK.md#track)
-- [trackEvent](medici_core.SDK.md#trackevent)
-- [trackView](medici_core.SDK.md#trackview)
-
-## Constructors
-
-### constructor
-
-• **new SDK**(`params`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `params` | [`SDKConfigType`](../interfaces/medici_core.SDKConfigType.md) |
-
-#### 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`](../interfaces/medici_core.SDKInitConfig.md)
-
-#### 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`](../modules/medici_core.md#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`](../interfaces/medici_core.SDKInitConfig.md) |
-
-#### 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

La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 83 - 0
docs/enums/_medici_types.SDKPlatformType.html


+ 0 - 43
docs/enums/medici_types.SDKPlatformType.md

@@ -1,43 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / [@medici/types](../modules/medici_types.md) / SDKPlatformType
-
-# Enumeration: SDKPlatformType
-
-[@medici/types](../modules/medici_types.md).SDKPlatformType
-
-## Table of contents
-
-### Enumeration Members
-
-- [miniApp](medici_types.SDKPlatformType.md#miniapp)
-- [web](medici_types.SDKPlatformType.md#web)
-- [webview](medici_types.SDKPlatformType.md#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

La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 61 - 0
docs/functions/_medici_legacy.init.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 62 - 0
docs/functions/_medici_utils.getGlobalObject.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 77 - 0
docs/functions/_medici_utils.hook.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 61 - 0
docs/functions/_medici_web.init.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 43 - 0
docs/index.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 108 - 0
docs/interfaces/_medici_core.SDKConfigType.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 80 - 0
docs/interfaces/_medici_core.SDKInitConfig.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 80 - 0
docs/interfaces/_medici_types.BrowserTransportOptions.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 94 - 0
docs/interfaces/_medici_types.GlobalEventType.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 95 - 0
docs/interfaces/_medici_types.HistoryEvent.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 127 - 0
docs/interfaces/_medici_types.IBaseAction.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 117 - 0
docs/interfaces/_medici_types.ICustomAction.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 101 - 0
docs/interfaces/_medici_types.SDKconfigType.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 82 - 0
docs/interfaces/_medici_types.TrackActionOption.html


+ 0 - 76
docs/interfaces/medici_core.SDKConfigType.md

@@ -1,76 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / [@medici/core](../modules/medici_core.md) / SDKConfigType
-
-# Interface: SDKConfigType
-
-[@medici/core](../modules/medici_core.md).SDKConfigType
-
-## Table of contents
-
-### Properties
-
-- [appId](medici_core.SDKConfigType.md#appid)
-- [autoTrack](medici_core.SDKConfigType.md#autotrack)
-- [config](medici_core.SDKConfigType.md#config)
-- [endPoint](medici_core.SDKConfigType.md#endpoint)
-- [platform](medici_core.SDKConfigType.md#platform)
-- [trackEndPoint](medici_core.SDKConfigType.md#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`](medici_core.SDKInitConfig.md)
-
-#### Defined in
-
-core/src/sdk.ts:18
-
-___
-
-### endPoint
-
-• **endPoint**: `string`
-
-#### Defined in
-
-core/src/sdk.ts:14
-
-___
-
-### platform
-
-• `Optional` **platform**: [`PlatformType`](../modules/medici_core.md#platformtype)
-
-#### Defined in
-
-core/src/sdk.ts:16
-
-___
-
-### trackEndPoint
-
-• `Optional` **trackEndPoint**: `string`
-
-#### Defined in
-
-core/src/sdk.ts:19

+ 0 - 32
docs/interfaces/medici_core.SDKInitConfig.md

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

+ 0 - 32
docs/interfaces/medici_types.BrowserTransportOptions.md

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

+ 0 - 54
docs/interfaces/medici_types.GlobalEventType.md

@@ -1,54 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / [@medici/types](../modules/medici_types.md) / GlobalEventType
-
-# Interface: GlobalEventType
-
-[@medici/types](../modules/medici_types.md).GlobalEventType
-
-## Table of contents
-
-### Properties
-
-- [eventName](medici_types.GlobalEventType.md#eventname)
-- [eventVariable](medici_types.GlobalEventType.md#eventvariable)
-- [id](medici_types.GlobalEventType.md#id)
-- [triggerTime](medici_types.GlobalEventType.md#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

+ 0 - 48
docs/interfaces/medici_types.HistoryEvent.md

@@ -1,48 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / [@medici/types](../modules/medici_types.md) / HistoryEvent
-
-# Interface: HistoryEvent
-
-[@medici/types](../modules/medici_types.md).HistoryEvent
-
-## Table of contents
-
-### Methods
-
-- [addEvent](medici_types.HistoryEvent.md#addevent)
-- [handlePushState](medici_types.HistoryEvent.md#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

+ 0 - 81
docs/interfaces/medici_types.IBaseAction.md

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

+ 0 - 76
docs/interfaces/medici_types.ICustomAction.md

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

+ 0 - 65
docs/interfaces/medici_types.SDKconfigType.md

@@ -1,65 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / [@medici/types](../modules/medici_types.md) / SDKconfigType
-
-# Interface: SDKconfigType
-
-[@medici/types](../modules/medici_types.md).SDKconfigType
-
-## Table of contents
-
-### Properties
-
-- [Platform](medici_types.SDKconfigType.md#platform)
-- [appId](medici_types.SDKconfigType.md#appid)
-- [from](medici_types.SDKconfigType.md#from)
-- [user](medici_types.SDKconfigType.md#user)
-- [version](medici_types.SDKconfigType.md#version)
-
-## Properties
-
-### Platform
-
-• **Platform**: [`SDKPlatformType`](../enums/medici_types.SDKPlatformType.md)
-
-#### 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

+ 0 - 38
docs/interfaces/medici_types.TrackActionOption.md

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

La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 54 - 0
docs/modules.html


+ 0 - 13
docs/modules.md

@@ -1,13 +0,0 @@
-[Documentation](README.md) / Exports
-
-# Documentation
-
-## Table of contents
-
-### Modules
-
-- [@medici/core](modules/medici_core.md)
-- [@medici/foo](modules/medici_foo.md)
-- [@medici/types](modules/medici_types.md)
-- [@medici/utils](modules/medici_utils.md)
-- [@medici/web](modules/medici_web.md)

La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 87 - 0
docs/modules/_medici_core.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 59 - 0
docs/modules/_medici_foo.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 68 - 0
docs/modules/_medici_legacy.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 87 - 0
docs/modules/_medici_types.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 61 - 0
docs/modules/_medici_utils.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 72 - 0
docs/modules/_medici_web.html


+ 0 - 28
docs/modules/medici_core.md

@@ -1,28 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / @medici/core
-
-# Module: @medici/core
-
-## Table of contents
-
-### Classes
-
-- [SDK](../classes/medici_core.SDK.md)
-
-### Interfaces
-
-- [SDKConfigType](../interfaces/medici_core.SDKConfigType.md)
-- [SDKInitConfig](../interfaces/medici_core.SDKInitConfig.md)
-
-### Type Aliases
-
-- [PlatformType](medici_core.md#platformtype)
-
-## Type Aliases
-
-### PlatformType
-
-Ƭ **PlatformType**: ``"web"`` \| ``"miniApp"``
-
-#### Defined in
-
-core/src/sdk.ts:7

+ 0 - 19
docs/modules/medici_foo.md

@@ -1,19 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / @medici/foo
-
-# Module: @medici/foo
-
-## Table of contents
-
-### Variables
-
-- [meaningOfLife](medici_foo.md#meaningoflife)
-
-## Variables
-
-### meaningOfLife
-
-• `Const` **meaningOfLife**: ``42``
-
-#### Defined in
-
-foo/src/index.ts:1

+ 0 - 76
docs/modules/medici_types.md

@@ -1,76 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / @medici/types
-
-# Module: @medici/types
-
-## Table of contents
-
-### Enumerations
-
-- [SDKPlatformType](../enums/medici_types.SDKPlatformType.md)
-
-### Interfaces
-
-- [BrowserTransportOptions](../interfaces/medici_types.BrowserTransportOptions.md)
-- [GlobalEventType](../interfaces/medici_types.GlobalEventType.md)
-- [HistoryEvent](../interfaces/medici_types.HistoryEvent.md)
-- [IBaseAction](../interfaces/medici_types.IBaseAction.md)
-- [ICustomAction](../interfaces/medici_types.ICustomAction.md)
-- [SDKconfigType](../interfaces/medici_types.SDKconfigType.md)
-- [TrackActionOption](../interfaces/medici_types.TrackActionOption.md)
-
-### Type Aliases
-
-- [Dict](medici_types.md#dict)
-- [EventNameEnumType](medici_types.md#eventnameenumtype)
-- [EventReturnType](medici_types.md#eventreturntype)
-- [TrackEventType](medici_types.md#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

+ 0 - 64
docs/modules/medici_utils.md

@@ -1,64 +0,0 @@
-[Documentation](../README.md) / [Exports](../modules.md) / @medici/utils
-
-# Module: @medici/utils
-
-## Table of contents
-
-### Functions
-
-- [getGlobalObject](medici_utils.md#getglobalobject)
-- [hook](medici_utils.md#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

+ 0 - 29
docs/modules/medici_web.md

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

La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 55 - 0
docs/types/_medici_core.PlatformType.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 72 - 0
docs/types/_medici_types.Dict.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 63 - 0
docs/types/_medici_types.EventNameEnumType.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 63 - 0
docs/types/_medici_types.EventReturnType.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 63 - 0
docs/types/_medici_types.TrackEventType.html


La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 52 - 0
docs/variables/_medici_foo.meaningOfLife.html


+ 1 - 1
package.json

@@ -14,7 +14,7 @@
         "test": "pnpm run -r test",
         "lint": "eslint --fix --ext js,ts,tsx .",
         "publish": "pnpm publish --filter @medici/core @medici/web @medici/types @medici/utils",
-        "docs": "pnpm typedoc --plugin typedoc-plugin-markdown --entryPointStrategy packages ."
+        "docs": "pnpm typedoc --plugin none --lightHighlightTheme light-plus --entryPointStrategy packages ."
     },
     "devDependencies": {
         "@changesets/cli": "^2.24.3",

+ 20 - 2
packages/core/README.md

@@ -1,5 +1,23 @@
 # @medici/core
+> The medici track system core module
+## installation
+
+> core module provide Main SDK class, All details are revived by @medici/web module
 
 ```js
-npm install @medici/core
-```
+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;
+
+
+```

+ 14 - 2
packages/legacy/README.md

@@ -1,2 +1,14 @@
-# Legacy
-Umd 版本
+# @medici/legacy
+
+> The medici legacy module for normal script.  一般 script使用.
+
+
+```html
+
+   <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>
+```

+ 37 - 32
packages/legacy/package.json

@@ -1,34 +1,39 @@
 {
-  "name": "@medici/legacy",
-  "version": "0.0.4",
-  "main": "dist/index",
-  "types": "dist/index",
-  "files": [
-    "dist"
-  ],
-  "author": {
-    "name": "gemercheung",
-    "email": "gemercheung@gmail.com",
-    "url": "http://gemer.xyz/"
-  },
-  "scripts": {
-    "build": "pnpm run clean && pnpm run compile",
-    "clean": "rimraf -rf ./dist",
-    "compile": "rollup -c",
-    "prepublishOnly": "pnpm run build"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^22.0.2",
-    "@rollup/plugin-node-resolve": "^13.3.0",
-    "@rollup/plugin-typescript": "~8.3.4",
-    "rimraf": "~3.0.2",
-    "rollup": "~2.77.3",
-    "rollup-plugin-terser": "^7.0.2",
-    "tslib": "^2.4.0",
-    "typescript": "~4.7.4"
-  },
-  "dependencies": {
-    "@medici/core": "workspace:^0.0.6",
-    "@medici/utils": "workspace:^0.0.3"
-  }
+    "name": "@medici/legacy",
+    "version": "0.0.4",
+    "main": "dist/index",
+    "types": "dist/index",
+    "files": [
+        "dist"
+    ],
+    "author": {
+        "name": "gemercheung",
+        "email": "gemercheung@gmail.com",
+        "url": "http://gemer.xyz/"
+    },
+    "scripts": {
+        "build": "pnpm run clean && pnpm run compile",
+        "clean": "rimraf -rf ./dist",
+        "compile": "rollup -c",
+        "prepublishOnly": "pnpm run build"
+    },
+    "devDependencies": {
+        "@rollup/plugin-commonjs": "^22.0.2",
+        "@rollup/plugin-node-resolve": "^13.3.0",
+        "@rollup/plugin-typescript": "~8.3.4",
+        "rimraf": "~3.0.2",
+        "rollup": "~2.77.3",
+        "rollup-plugin-terser": "^7.0.2",
+        "tslib": "^2.4.0",
+        "typescript": "~4.7.4"
+    },
+    "dependencies": {
+        "@medici/core": "workspace:^0.0.6",
+        "@medici/utils": "workspace:^0.0.3"
+    },
+    "typedoc": {
+        "entryPoint": "./src/index.ts",
+        "readmeFile": "./README.md",
+        "displayName": "@medici/legacy"
+    }
 }

+ 21 - 0
packages/web/README.md

@@ -0,0 +1,21 @@
+# @medici/web
+> The medici track system core module
+## installation
+
+```js
+
+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;
+```

+ 6 - 1
packages/web/package.json

@@ -23,5 +23,10 @@
   },
   "dependencies": {
     "@medici/core": "workspace:^0.0.6"
-  }
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "./README.md",
+    "displayName": "@medici/web"
+}
 }