@robosystems/client 2.2.0 → 2.2.1
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/README.md +0 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,16 +21,6 @@ Official TypeScript client for the RoboSystems financial intelligence platform
|
|
|
21
21
|
npm install @robosystems/client
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
## Versioning
|
|
25
|
-
|
|
26
|
-
This client is `1.x` and follows semantic versioning, with one distinction worth knowing before you pin.
|
|
27
|
-
|
|
28
|
-
The **stable surface** is the facade clients and their subpath exports (`/clients`, `/ledger`, `/investor`, `/library`, `/query`, `/operations`, `/client`), the React hooks, the error classes, the auth configuration, and the types those signatures expose through `/types`. It is frozen for the life of `1.x`; breaking any of it costs a major version.
|
|
29
|
-
|
|
30
|
-
The **generated surface** — `/sdk`, which publishes the code generated from the platform's OpenAPI spec — tracks that spec. Operations there can be added, renamed, or removed on a minor release, and every such removal is named in that release's notes. `/sdk` is exported for convenience, not promised; anything that earns a compatibility promise is surfaced through a facade first.
|
|
31
|
-
|
|
32
|
-
So `^1` is the right pin if you build on the facades. If you import from `/sdk`, either pin a minor range (`~1.7`) and read the release notes when you widen, or open an issue to have the operation surfaced through a facade.
|
|
33
|
-
|
|
34
24
|
## Resources
|
|
35
25
|
|
|
36
26
|
- [RoboSystems Platform](https://robosystems.ai)
|