@farthershore/client 0.5.0 → 0.7.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 +15 -0
- package/LICENSE +21 -0
- package/README.md +8 -4
- package/dist/index.js +275 -222
- package/dist/types/api.generated.d.ts +82 -62
- package/dist/types/generated/schemas.d.ts +168 -284
- package/dist/types/operations/audit-notifications.d.ts +4 -0
- package/dist/types/operations/auth.d.ts +175 -0
- package/dist/types/operations/billing.d.ts +4 -4
- package/dist/types/operations/businesses.d.ts +107 -17
- package/dist/types/operations/consumers.d.ts +145 -0
- package/dist/types/operations/index.d.ts +504 -209
- package/dist/types/operations/organizations.d.ts +7 -0
- package/dist/types/operations/platform.d.ts +6 -6
- package/dist/types/operations/portal.d.ts +43 -0
- package/dist/types/operations/webhooks.d.ts +2 -2
- package/dist/types/transport.d.ts +2 -0
- package/dist/types/types.d.ts +34 -34
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
- package/dist/types/operations/agreements.d.ts +0 -174
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# Changelog — @farthershore/client
|
|
2
2
|
|
|
3
|
+
## [0.7.0] - 2026-11-20
|
|
4
|
+
|
|
5
|
+
- Add `organizations.sellerDetails.read`: the seller details (legal name, support email, postal address and optional support URL) every business in the organization shows its customers, read from the organization's Stripe account, and where they stand (`not_connected`, `incomplete` or `complete`).
|
|
6
|
+
- Add `personalData.export` to download your own personal data as JSON, and `account.erasure.read` to follow your account deletion through to completion. Deleting the account itself stays a dashboard action.
|
|
7
|
+
- Add `consumers.data.export` to export one customer's data for a business as JSON, and `consumers.data.erasure.read` to read the status of that customer's data erasure.
|
|
8
|
+
- Add `platform.legal.read` to read whether the platform's current legal documents have been accepted.
|
|
9
|
+
|
|
10
|
+
## [0.6.0] - 2026-11-18
|
|
11
|
+
|
|
12
|
+
- Use `/agent/v1/whoami` for credential validation; the retired `/management/whoami` endpoint is no longer supported.
|
|
13
|
+
|
|
14
|
+
- **Breaking:** Removed `businesses.rollback`; the retired publish workflow cannot produce a valid rollback target. Recover a Business contract through a reviewed repository fix and a new release.
|
|
15
|
+
|
|
16
|
+
- Stop frontend build waits on supersession and keep the awaited build identity fixed, including when it is missing from a status response.
|
|
17
|
+
|
|
3
18
|
## [0.5.0] - 2026-11-09
|
|
4
19
|
|
|
5
20
|
- **Breaking:** `businesses.rollback` takes `publishId` and returns
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Farther Shore
|
|
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.
|
package/README.md
CHANGED
|
@@ -5,8 +5,8 @@ namespaced, typed operation surface (`fs.runtimeTokens.revoke(…)`) over an
|
|
|
5
5
|
authenticated `fetch` transport with exact retry and outcome semantics,
|
|
6
6
|
pluggable credential sources, and typed errors.
|
|
7
7
|
|
|
8
|
-
> **Status: `0.
|
|
9
|
-
> Every response is typed.
|
|
8
|
+
> **Status: `0.7.0`.** Pre-1.0: minor releases may include breaking changes.
|
|
9
|
+
> Every response is typed. Responses are generated
|
|
10
10
|
> from the platform's zod schemas (through the API's OpenAPI components), so a
|
|
11
11
|
> field exists in a type exactly when the server sends it.
|
|
12
12
|
|
|
@@ -66,7 +66,6 @@ The namespace path comes from the operation key (`runtime_token.revoke` →
|
|
|
66
66
|
| Namespace | Covers |
|
|
67
67
|
| -------------------- | --------------------------------------------------------------------------------------- |
|
|
68
68
|
| `fs.agents` | Operating agents: list, status, runs, enable, disable |
|
|
69
|
-
| `fs.agreements` | Economic agreements: read, preview, create, amend, subject pins |
|
|
70
69
|
| `fs.analytics` | Event analytics: `timeseries`, `latency`, `top`, `log`, `query` |
|
|
71
70
|
| `fs.auditLogs` | Organization and business audit logs, CSV export |
|
|
72
71
|
| `fs.auth` | `context.read` (who am I), `context.issue`, `listOrganizations`, `selectedOrganization` |
|
|
@@ -74,7 +73,7 @@ The namespace path comes from the operation key (`runtime_token.revoke` →
|
|
|
74
73
|
| `fs.backends` | Backends: read, create, bind, delete |
|
|
75
74
|
| `fs.billing` | `stripe` (status, disconnect) and `taxSettings` |
|
|
76
75
|
| `fs.bulletin` | Business bulletin: list, read, ack, resolve |
|
|
77
|
-
| `fs.businesses` | Businesses, publish/
|
|
76
|
+
| `fs.businesses` | Businesses, publish/status, `brand`, `docs`, `previewEnv`, `cors`, `rbac`, … |
|
|
78
77
|
| `fs.changeSets` | Governed ChangeSet proposals and the apply `timeline` |
|
|
79
78
|
| `fs.consumers` | Subscribers: read, block, remove, migrate, roles, RBAC, API keys |
|
|
80
79
|
| `fs.environments` | Preview environments: read, create, delete |
|
|
@@ -164,6 +163,11 @@ const build = await waitForFrontendBuild(fs, {
|
|
|
164
163
|
});
|
|
165
164
|
```
|
|
166
165
|
|
|
166
|
+
The wait keeps the selected build's identity fixed. `FAILED`, `CANCELLED`, and
|
|
167
|
+
`SUPERSEDED` return immediately with `timedOut: false`; inspect `status` and
|
|
168
|
+
`error` before treating the result as success. A successful build is ready only
|
|
169
|
+
once that exact build is active.
|
|
170
|
+
|
|
167
171
|
`paginate` fails with `PAGINATION_NOT_ADVANCING` rather than looping when a
|
|
168
172
|
page does not advance. A starting `offset` or `limit` may be a number or a
|
|
169
173
|
numeric string (`"50"`); anything else fails with `INVALID_PAGE_PARAMETER`
|