@dinoconfig/js-sdk 1.0.0
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.
- package/CHANGELOG.md +38 -0
- package/LICENSE +21 -0
- package/README.md +743 -0
- package/index.d.ts +88 -0
- package/index.js +883 -0
- package/lib/cache/cache-manager.d.ts +86 -0
- package/lib/cache/cache.types.d.ts +105 -0
- package/lib/cache/index.d.ts +8 -0
- package/lib/cache/memory-cache.d.ts +86 -0
- package/lib/cache/storage-cache.d.ts +58 -0
- package/lib/config-api.d.ts +111 -0
- package/lib/dinoconfig-js-sdk.d.ts +140 -0
- package/lib/discovery-api.d.ts +174 -0
- package/lib/http-client.d.ts +245 -0
- package/lib/types.d.ts +364 -0
- package/package.json +77 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Initial release of the DinoConfig JavaScript SDK
|
|
12
|
+
- `dinoconfigApi()` factory function for SDK initialization
|
|
13
|
+
- **Configs API** - Retrieve entire configurations or individual values
|
|
14
|
+
- `configs.get(path)` / `configs.get(brand, config)` - Get full config
|
|
15
|
+
- `configs.getValue(path)` / `configs.getValue(brand, config, key)` - Get single value
|
|
16
|
+
- Shorthand dot notation path syntax (`"Brand.Config.Key"`)
|
|
17
|
+
- **Discovery API** - Explore available configurations dynamically
|
|
18
|
+
- `discovery.listBrands()` - List all accessible brands
|
|
19
|
+
- `discovery.listConfigs(brand)` - List configs for a brand
|
|
20
|
+
- `discovery.getSchema(brand, config)` - Get configuration schema
|
|
21
|
+
- `discovery.introspect()` - Full introspection of all brands and configs
|
|
22
|
+
- **Multi-layer caching system**
|
|
23
|
+
- L1 in-memory cache for fast access
|
|
24
|
+
- L2 persistent storage cache (localStorage)
|
|
25
|
+
- Cache management API (`cache.clear()`, `cache.invalidate()`, `cache.prefetch()`, `cache.getStats()`)
|
|
26
|
+
- Configurable TTL and cache size
|
|
27
|
+
- **HTTP Client features**
|
|
28
|
+
- Automatic API key to token exchange
|
|
29
|
+
- Exponential backoff retry logic
|
|
30
|
+
- Configurable request timeouts
|
|
31
|
+
- Custom headers support
|
|
32
|
+
- Full TypeScript support with comprehensive type definitions
|
|
33
|
+
- Zero runtime dependencies (uses native `fetch`)
|
|
34
|
+
- ESM module format
|
|
35
|
+
|
|
36
|
+
### Security
|
|
37
|
+
- Secure token exchange mechanism
|
|
38
|
+
- Authorization header management
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025-present DinoConfig Team
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|