Skip to content

Commit a787856

Browse files
sebastianwesselsebastianwessel
committed
doc: update api documentation
1 parent aa6ca0d commit a787856

40 files changed

+1393
-462
lines changed

‎website/doc/api/README.md

+152
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,157 @@ PURISTA API / [Modules](modules.md)
44

55
All notable changes to this project will be documented in this file.
66

7+
## [1.10.6] - 2024-02-15
8+
9+
### Bug Fixes
10+
11+
- Mocked context invoke
12+
13+
## [1.10.5] - 2024-02-15
14+
15+
### Bug Fixes
16+
17+
- Mutable obj issue in context mocks
18+
19+
### Miscellaneous Tasks
20+
21+
- Bump versions to 1.10.5
22+
23+
## [1.10.4] - 2024-02-15
24+
25+
### Bug Fixes
26+
27+
- Mutable issue in createInvokeFunctionProxy
28+
29+
### Miscellaneous Tasks
30+
31+
- Bump versions to 1.10.4
32+
33+
## [1.10.3] - 2024-02-14
34+
35+
### Bug Fixes
36+
37+
- Hono webserver request content type
38+
39+
### Miscellaneous Tasks
40+
41+
- Bump versions to 1.10.3
42+
43+
## [1.10.2] - 2024-02-14
44+
45+
### Miscellaneous Tasks
46+
47+
- Minor fixes and dep updates
48+
- Bump versions to 1.10.2
49+
50+
## [1.10.1] - 2024-02-14
51+
52+
### Bug Fixes
53+
54+
- Hono vars
55+
56+
### Documentation
57+
58+
- Update doc
59+
- Chore update
60+
- Fix analytics
61+
- Update
62+
- Update
63+
64+
### Miscellaneous Tasks
65+
66+
- Bump versions to 1.10.1
67+
68+
## [1.10.0] - 2024-02-11
69+
70+
### Bug Fixes
71+
72+
- Version bump for new packages
73+
- Hono based servers compress issue
74+
- UnhandledError.fromError returns UnhandledError
75+
- Minor code smells
76+
- Keep OT traceId and custom trace id separated
77+
- OpenApi path parameter and add example
78+
- Add missing type params
79+
- Refactor type handling in builders fixes #159
80+
- SafeBind
81+
- Package.json files use dist instead of lib
82+
- Service config type in service builder getInstance
83+
- Test
84+
85+
### Documentation
86+
87+
- Add new packages to api docs
88+
- Migrate to vitepress #152
89+
- Add schema page
90+
- Fix k8s examples
91+
- Minor readme changes
92+
- Update documentation
93+
- Fix api doc generation
94+
- Update doc
95+
- Update doc
96+
97+
### Features
98+
99+
- Add secret store for AWS Secrets Manager #106
100+
- Add cache map to basic config store class
101+
- Add config store for AWS Systems Manager Parameter Store #104
102+
- Add secret star for Azure Key Vault #107
103+
- Add chained invoke functions in commands and subscriptions #149
104+
- Hono based web server #153
105+
- Allow different schema libs #154
106+
- Add schema for custom emit and improve types #158
107+
- Add dynamic route registration to hono server
108+
- Add esm support to cli
109+
- CLI support for ESM, vitest and Biome
110+
- Cli add parameter type and schema per default to subscriptions
111+
112+
### Miscellaneous Tasks
113+
114+
- Minor cleanup
115+
- Bump dependency versions
116+
- Fix typo
117+
- Fix test setup
118+
- Update nvmrc to node 20
119+
- Improve logger
120+
- Add lint rule to force imports with type scope
121+
- Make props available in subclass in HttpClient
122+
- Prepare esm support in purista cli
123+
- Improve imports to use type imports
124+
- Simplify stores and cleanup code
125+
- Refactor code base to ESM #147
126+
- Update vuepress setup
127+
- Bump dependency versions
128+
- Exclude test files from npm packages
129+
- Dev env should use repo typescript version
130+
- Improve error handling
131+
- Bump dependency versions
132+
- Fix lint
133+
- Exclude tests from build
134+
- Improve Hono types
135+
- Add toJSON method to error classes
136+
- Use PatternRouter instead of own implementation
137+
- Remove unused dev dependencies
138+
- Cleanup dependencies
139+
- Bump dependencies to most recent
140+
- Update and fix tests
141+
- Remove deprecated method calls
142+
- Update package-lock.json
143+
- Bump dependencies
144+
- Prevent multiple command endpoint registrations
145+
- Use safeBind instead of bind to keep types
146+
- Minor code improvements
147+
- Minor improvements
148+
- Improve example
149+
- Minor improvements
150+
- Bump dependencies
151+
- Migrate to hono v4
152+
- Minor improvements
153+
- Add static file servering to example
154+
- Improve tests
155+
- Fix build package.json
156+
- Bump versions to 1.10.0
157+
7158
## [1.9.1] - 2024-01-26
8159

9160
### Bug Fixes
@@ -15,6 +166,7 @@ All notable changes to this project will be documented in this file.
15166
### Miscellaneous Tasks
16167

17168
- Lint
169+
- Bump versions to 1.9.1
18170

19171
## [1.9.0] - 2023-11-18
20172

‎website/doc/api/classes/purista_aws_config_store.AWSConfigStore.md

+54-20
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ It will be removed/overwritten on next get request.
7676

7777
#### Defined in
7878

79-
[aws-config-store/src/AWSConfigStore.impl.ts:29](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L29)
79+
[aws-config-store/src/AWSConfigStore.impl.ts:30](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L30)
8080

8181
## Properties
8282

@@ -90,7 +90,7 @@ It will be removed/overwritten on next get request.
9090

9191
#### Defined in
9292

93-
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:12
93+
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:20
9494

9595
___
9696

@@ -100,7 +100,7 @@ ___
100100

101101
#### Defined in
102102

103-
[aws-config-store/src/AWSConfigStore.impl.ts:27](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L27)
103+
[aws-config-store/src/AWSConfigStore.impl.ts:28](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L28)
104104

105105
___
106106

@@ -127,7 +127,7 @@ ___
127127

128128
#### Defined in
129129

130-
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:10
130+
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:18
131131

132132
___
133133

@@ -141,7 +141,7 @@ ___
141141

142142
#### Defined in
143143

144-
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:9
144+
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:17
145145

146146
___
147147

@@ -157,7 +157,7 @@ name of store
157157

158158
#### Defined in
159159

160-
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:11
160+
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:19
161161

162162
## Methods
163163

@@ -177,62 +177,88 @@ disconnects and shuts down the config store
177177

178178
#### Defined in
179179

180-
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:20
180+
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:70
181181

182182
___
183183

184184
### getConfig
185185

186-
▸ **getConfig**(`...configNames`): `Promise`\<`Record`\<`string`, `unknown`\>\>
186+
▸ **getConfig**\<`ConfigNames`\>(`...configNames`): `Promise`\<[`ObjectWithKeysFromStringArray`](../modules/purista_core.md#objectwithkeysfromstringarray)\<`ConfigNames`\>\>
187+
188+
Returns the values for given config properties.
189+
This function **SHOULD NOT** be overwritten by store implementation.
190+
For implementation overwrite protected `getConfigImpl`
191+
192+
#### Type parameters
193+
194+
| Name | Type |
195+
| :------ | :------ |
196+
| `ConfigNames` | extends `string`[] |
187197

188198
#### Parameters
189199

190200
| Name | Type |
191201
| :------ | :------ |
192-
| `...configNames` | `string`[] |
202+
| `...configNames` | `ConfigNames` |
193203

194204
#### Returns
195205

196-
`Promise`\<`Record`\<`string`, `unknown`\>\>
206+
`Promise`\<[`ObjectWithKeysFromStringArray`](../modules/purista_core.md#objectwithkeysfromstringarray)\<`ConfigNames`\>\>
207+
208+
an object of { [configName]: value | undefined }
197209

198210
#### Inherited from
199211

200212
[ConfigStoreBaseClass](purista_core.ConfigStoreBaseClass.md).[getConfig](purista_core.ConfigStoreBaseClass.md#getconfig)
201213

202214
#### Defined in
203215

204-
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:15
216+
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:37
205217

206218
___
207219

208220
### getConfigImpl
209221

210-
▸ **getConfigImpl**(`...configNames`): `Promise`\<`Record`\<`string`, `undefined` \| `string`\>\>
222+
▸ **getConfigImpl**\<`ConfigNames`\>(`...configNames`): `Promise`\<[`ObjectWithKeysFromStringArray`](../modules/purista_core.md#objectwithkeysfromstringarray)\<`ConfigNames`\>\>
211223

212-
#### Parameters
224+
This method must be overwritten by actual store implementation.
225+
226+
#### Type parameters
213227

214228
| Name | Type |
215229
| :------ | :------ |
216-
| `...configNames` | `string`[] |
230+
| `ConfigNames` | extends `string`[] |
231+
232+
#### Parameters
233+
234+
| Name | Type | Description |
235+
| :------ | :------ | :------ |
236+
| `...configNames` | `ConfigNames` | list of config items |
217237

218238
#### Returns
219239

220-
`Promise`\<`Record`\<`string`, `undefined` \| `string`\>\>
240+
`Promise`\<[`ObjectWithKeysFromStringArray`](../modules/purista_core.md#objectwithkeysfromstringarray)\<`ConfigNames`\>\>
241+
242+
an object of { [configName]: value | undefined }
221243

222244
#### Overrides
223245

224246
[ConfigStoreBaseClass](purista_core.ConfigStoreBaseClass.md).[getConfigImpl](purista_core.ConfigStoreBaseClass.md#getconfigimpl)
225247

226248
#### Defined in
227249

228-
[aws-config-store/src/AWSConfigStore.impl.ts:34](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L34)
250+
[aws-config-store/src/AWSConfigStore.impl.ts:35](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L35)
229251

230252
___
231253

232254
### removeConfig
233255

234256
▸ **removeConfig**(`configName`): `Promise`\<`void`\>
235257

258+
Removes the config item given by config name.
259+
This function **SHOULD NOT** be overwritten by store implementation.
260+
For implementation overwrite protected `removeConfigImpl`
261+
236262
#### Parameters
237263

238264
| Name | Type |
@@ -249,14 +275,16 @@ ___
249275

250276
#### Defined in
251277

252-
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:17
278+
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:52
253279

254280
___
255281

256282
### removeConfigImpl
257283

258284
▸ **removeConfigImpl**(`configName`): `Promise`\<`void`\>
259285

286+
This method must be overwritten by actual store implementation.
287+
260288
#### Parameters
261289

262290
| Name | Type |
@@ -273,14 +301,18 @@ ___
273301

274302
#### Defined in
275303

276-
[aws-config-store/src/AWSConfigStore.impl.ts:55](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L55)
304+
[aws-config-store/src/AWSConfigStore.impl.ts:58](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L58)
277305

278306
___
279307

280308
### setConfig
281309

282310
▸ **setConfig**(`configName`, `configValue`): `Promise`\<`void`\>
283311

312+
Sets a config value
313+
This function **SHOULD NOT** be overwritten by store implementation.
314+
For implementation overwrite protected `setConfigImpl`
315+
284316
#### Parameters
285317

286318
| Name | Type |
@@ -298,14 +330,16 @@ ___
298330

299331
#### Defined in
300332

301-
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:19
333+
core/dist/commonjs/core/ConfigStore/ConfigStoreBaseClass.impl.d.ts:69
302334

303335
___
304336

305337
### setConfigImpl
306338

307339
▸ **setConfigImpl**(`configName`, `configValue`): `Promise`\<`void`\>
308340

341+
This method must be overwritten by actual store implementation.
342+
309343
#### Parameters
310344

311345
| Name | Type |
@@ -323,4 +357,4 @@ ___
323357

324358
#### Defined in
325359

326-
[aws-config-store/src/AWSConfigStore.impl.ts:63](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L63)
360+
[aws-config-store/src/AWSConfigStore.impl.ts:66](https://github.com/sebastianwessel/purista/blob/master/packages/aws-config-store/src/AWSConfigStore.impl.ts#L66)

0 commit comments

Comments
 (0)