@datapos/datapos-shared 0.3.154 → 0.3.157

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +46 -63
  2. package/dist/datapos-development.es.js +2222 -178
  3. package/dist/types/src/component/informer/document.d.ts +1 -1
  4. package/dist/types/src/index.d.ts +5 -4
  5. package/dist/types/src/module/configSchema.d.ts +47 -0
  6. package/package.json +4 -3
package/README.md CHANGED
@@ -31,95 +31,78 @@ registry=https://registry.npmjs.org/
31
31
 
32
32
  ## Declarations
33
33
 
34
+ This package provides composables, constants, errors, types/interfaces and utilities used by Data Positioning modules.
35
+
34
36
  ### Modules
35
37
 
36
38
  The Data Positioning solution consists of the following modules. All modules, except `App`, extend the base type `Module`.
37
39
 
38
40
  | Type | Dynamic | Notes |
39
41
  | --------- | :-----: | --------------------------------------------------------------- |
40
- | App | | Implements the Data Positioning web application. |
42
+ | App | | Implements the data positioning web application. |
41
43
  | Engine | ✔ | Implements the data positioning engine. |
42
- | Connector | ✔ | Implements a connector which supports one or more connections. |
44
+ | Connector | ✔ | Implements a connector which handles one or more connections. |
43
45
  | Context | ✔ | Implements a context which defines one or more models. |
44
46
  | Informer | ✔ | Implements an informer which renders one or more documents. |
45
47
  | Presenter | ✔ | Implements a presenter which renders one or more presentations. |
46
48
 
47
- The modules implement the following components. All components extend the base type `Component`.
48
-
49
- | Module Type | Component Type |
50
- | ----------- | --------------------------------- |
51
- | Connector | connector |
52
- | | connectorConnection |
53
- | Context | context |
54
- | | contextModelGroup |
55
- | | contextModel |
56
- | | contextModelDimensionGroup |
57
- | | contextModelDimension |
58
- | | contextModelDimensionHierarchy |
59
- | | contextModelEntityGroup |
60
- | | contextModelEntity |
61
- | | contextModelEntityDataItem |
62
- | | contextModelEntityEvent |
63
- | | contextModelEntityPrimaryMeasure |
64
- | | contextModelSecondaryMeasureGroup |
65
- | | contextModelSecondaryMeasure |
66
- | | dataView |
67
- | | dimension |
68
- | | eventQuery |
69
- | Presenter | presenter |
70
- | | presenterPresentation |
71
- | Informer | informer |
72
- | | informerDocument |
73
-
74
- ### Base Components
75
-
76
- | Item | Notes |
77
- | ------------------------------------- | ------------------------------------------------------------ |
78
- | [Component Types](./src/component.ts) | The Component type serves as a base type for all components. |
79
- | ComponentRef | |
80
- | ComponentStatus | |
81
- | ComponentStatusId | |
82
- | ComponentTypeId | |
83
- | StatusColorId | |
84
-
85
- ### Engine Module Components
86
-
87
- | Item | Notes |
88
- | ---- | ----- |
89
- | | |
90
-
91
- ### Connector Module Components
49
+ ### Components
50
+
51
+ Each module implements a set of components. All module component types extend the base component types.
52
+
53
+ | Types | Notes |
54
+ | ------------------------------- | ------------------------------------------------------------ |
55
+ | [Component](./src/component.ts) | The Component type serves as a base type for all components. |
56
+ | ComponentRef | |
57
+ | ComponentStatus | |
58
+ | ComponentStatusId | |
59
+ | ComponentTypeId | |
60
+ | StatusColorId | |
61
+
62
+ #### Connector Module Components
92
63
 
93
64
  | Item | Notes |
94
65
  | --------------------------------------- | ----------------------------------------------------------------- |
95
66
  | [Connector Types](./src/connector.ts) | Connector types. The Connector type extends the Component type. |
96
67
  | [Connection Types](./src/connection.ts) | Connection types. The Connection type extends the Component type. |
97
68
 
98
- ### Context Module Components
69
+ #### Context Module Components
70
+
71
+ | Item | Notes |
72
+ | ---------------------------------------- | ------------------------------------------------------------------- |
73
+ | [Context Types](./src/context.ts) | Context types. The Context type extends the Component type. |
74
+ | [Data View Types](./src/dataView.ts) | DataView types. The DataView type extends the Component type. |
75
+ | [Dimension Types](./src/dimension.ts) | Dimension types. The Dimension type extends the Component type. |
76
+ | [Engine Types](./src/dimension.ts) | Engine types. |
77
+ | [Event Query Types](./src/eventQuery.ts) | Event Query types. The Event Query type extends the Component type. |
78
+
79
+ #### Engine Module Components
80
+
81
+ | Item | Notes |
82
+ | ---------------------------------- | ------------- |
83
+ | [Engine Types](./src/dimension.ts) | Engine types. |
84
+
85
+ #### Informer Module Components
99
86
 
100
87
  | Item | Notes |
101
88
  | ------------------------------------------- | --------------------------------------------------------------------- |
102
- | [Context Types](./src/context.ts) | Context types. The Context type extends the Component type. |
103
- | [Data View Types](./src/dataView.ts) | DataView types. The DataView type extends the Component type. |
104
- | [Dimension Types](./src/dimension.ts) | Dimension types. The Dimension type extends the Component type. |
105
- | [Engine Types](./src/dimension.ts) | Engine types. |
106
- | [Event Query Types](./src/eventQuery.ts) | Event Query types. The Event Query type extends the Component type. |
107
89
  | [Presenter Types](./src/presenter.ts) | Presenter types. The Presenter type extends the Component type. |
108
90
  | [Presentation Types](./src/presentation.ts) | Presentation types. The Presentation type extends the Component type. |
109
- | [Informer Types](./src/informer.ts) | Informer types. The Informer type extends the Component type. |
110
- | [Recipe Types](./src/recipe.ts) | Recipe types. The Recipe type extends the Component type. |
111
91
 
112
- ### Informer Module Components
92
+ #### Presenter Module Components
93
+
94
+ | Item | Notes |
95
+ | ----------------------------------- | ------------------------------------------------------------- |
96
+ | [Informer Types](./src/informer.ts) | Informer types. The Informer type extends the Component type. |
97
+ | [Recipe Types](./src/recipe.ts) | Recipe types. The Recipe type extends the Component type. |
98
+
99
+ ### Composables
113
100
 
114
- | Item | Notes |
115
- | ---- | ----- |
116
- | | |
101
+ ### Constants
117
102
 
118
- ### Presenter Module Components
103
+ ### Errors
119
104
 
120
- | Item | Notes |
121
- | ---- | ----- |
122
- | | |
105
+ ### Utilities
123
106
 
124
107
  ## Usage
125
108