@farthershore/client 0.3.0 → 0.5.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 +16 -0
- package/README.md +10 -2
- package/dist/index.js +221 -111
- package/dist/types/api.generated.d.ts +18 -38
- package/dist/types/credentials.d.ts +6 -2
- package/dist/types/envelope.d.ts +2 -0
- package/dist/types/errors.d.ts +13 -0
- package/dist/types/generated/schemas.d.ts +71 -28
- package/dist/types/helpers/refs.d.ts +2 -2
- package/dist/types/index.d.ts +1 -1
- package/dist/types/operations/agents.d.ts +9 -9
- package/dist/types/operations/agreements.d.ts +7 -7
- package/dist/types/operations/analytics.d.ts +5 -5
- package/dist/types/operations/audit-notifications.d.ts +6 -6
- package/dist/types/operations/auth.d.ts +4 -4
- package/dist/types/operations/backends.d.ts +8 -11
- package/dist/types/operations/billing.d.ts +3 -10
- package/dist/types/operations/businesses.d.ts +29 -30
- package/dist/types/operations/change-sets.d.ts +6 -6
- package/dist/types/operations/consumers.d.ts +13 -13
- package/dist/types/operations/define.d.ts +13 -3
- package/dist/types/operations/environments.d.ts +5 -4
- package/dist/types/operations/frontend.d.ts +2 -2
- package/dist/types/operations/index.d.ts +307 -220
- package/dist/types/operations/maker-tokens.d.ts +9 -9
- package/dist/types/operations/organizations.d.ts +19 -31
- package/dist/types/operations/personas.d.ts +8 -8
- package/dist/types/operations/plans-usage.d.ts +3 -3
- package/dist/types/operations/platform.d.ts +18 -18
- package/dist/types/operations/portal.d.ts +11 -11
- package/dist/types/operations/promo-codes.d.ts +15 -5
- package/dist/types/operations/variables.d.ts +22 -8
- package/dist/types/operations/webhooks.d.ts +107 -14
- package/dist/types/surface-types.d.ts +16 -10
- package/dist/types/types.d.ts +4 -1
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,9 +1,25 @@
|
|
|
1
1
|
# Changelog — @farthershore/client
|
|
2
2
|
|
|
3
|
+
## [0.5.0] - 2026-11-09
|
|
4
|
+
|
|
5
|
+
- **Breaking:** `businesses.rollback` takes `publishId` and returns
|
|
6
|
+
`rollbackPublishId`; `businesses.publish` returns `publishId`. Requires the
|
|
7
|
+
matching platform release.
|
|
8
|
+
|
|
9
|
+
- **Breaking:** Removed business deletion, organization deletion, ownership transfer and Stripe disconnection methods. These actions require a person in the dashboard after fresh sign-in and typed-name confirmation. Owner-target membership changes are also dashboard-only; non-owner membership operations remain available.
|
|
10
|
+
|
|
3
11
|
All notable changes to the API client are documented here. This package
|
|
4
12
|
versions independently from the CLI and the other SDKs. Pre-1.0: minor versions
|
|
5
13
|
may include breaking changes.
|
|
6
14
|
|
|
15
|
+
## [0.4.0] - 2026-10-28
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
|
|
19
|
+
- **Breaking:** `organizations.overview.read` → `OrganizationOverview.organization.stripeConnected`
|
|
20
|
+
is renamed **`billingConnected`** (generated `Schemas["OrganizationOverview"]`
|
|
21
|
+
too). Requires the matching platform release.
|
|
22
|
+
|
|
7
23
|
## [0.3.0] - 2026-10-14
|
|
8
24
|
|
|
9
25
|
### Added
|
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ 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.
|
|
8
|
+
> **Status: `0.5.0`.** Pre-1.0: minor releases may include breaking changes.
|
|
9
9
|
> Every response is typed. All but the publish-rollback receipt 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.
|
|
@@ -54,6 +54,12 @@ Every operation is a method `fs.<namespace>.<method>(input, options?)`:
|
|
|
54
54
|
`DRY_RUN_NOT_SUPPORTED` before sending anything. `retry: "none"` makes a
|
|
55
55
|
single attempt.
|
|
56
56
|
|
|
57
|
+
On preview-capable methods, literal `{ dryRun: true }` resolves to
|
|
58
|
+
`DryRunPreview<W>` (`{ dryRun: true, wouldHave: W }`), while omitted options or
|
|
59
|
+
`{ dryRun: false }` resolve to the write result. A `CallOptions` variable
|
|
60
|
+
resolves to the union, so check `"dryRun" in result` before using the result.
|
|
61
|
+
`W` is the preview payload, which can differ from the write result.
|
|
62
|
+
|
|
57
63
|
The namespace path comes from the operation key (`runtime_token.revoke` →
|
|
58
64
|
`fs.runtimeTokens.revoke`). The namespaces:
|
|
59
65
|
|
|
@@ -76,7 +82,7 @@ The namespace path comes from the operation key (`runtime_token.revoke` →
|
|
|
76
82
|
| `fs.knowledge` | Knowledge index (guide, business) |
|
|
77
83
|
| `fs.makerTokens` | Organization maker tokens and their approvals |
|
|
78
84
|
| `fs.notifications` | Notification preferences |
|
|
79
|
-
| `fs.organizations` | Organizations, roles, members, invitations,
|
|
85
|
+
| `fs.organizations` | Organizations, roles, non-owner members, invitations, overview |
|
|
80
86
|
| `fs.personas` | Test personas and local-preview sign-in |
|
|
81
87
|
| `fs.plans` | Compiled plans (read) |
|
|
82
88
|
| `fs.platform` | Denial explanations, dependents, resource counts, workflow replay/rollback previews |
|
|
@@ -251,3 +257,5 @@ a successful read whose JSON body is malformed rejects with the parser's
|
|
|
251
257
|
`SyntaxError` (it is not retried), and a request `body` that `JSON.stringify`
|
|
252
258
|
cannot serialize (a `BigInt`, a cycle) throws its `TypeError` before anything
|
|
253
259
|
is sent.
|
|
260
|
+
|
|
261
|
+
Human-only actions have no client methods: business or organization deletion, ownership transfer, and Stripe disconnection. The API also refuses delegated credentials for owner removal or demotion. Use the dashboard after fresh sign-in and typed-name confirmation.
|