@farthershore/farthershore-js 0.8.7 → 0.10.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 +86 -1
- package/README.md +291 -232
- package/dist/bootstrap.d.ts.map +1 -1
- package/dist/bootstrap.js +5 -5
- package/dist/bootstrap.js.map +1 -1
- package/dist/client.d.ts +73 -68
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +30 -79
- package/dist/client.js.map +1 -1
- package/dist/components/app.d.ts +7 -6
- package/dist/components/app.d.ts.map +1 -1
- package/dist/components/app.js +22 -9
- package/dist/components/app.js.map +1 -1
- package/dist/components/auth.js +5 -5
- package/dist/components/auth.js.map +1 -1
- package/dist/components/bill-estimator.js +1 -1
- package/dist/components/bill-estimator.js.map +1 -1
- package/dist/components/billing.d.ts +9 -1
- package/dist/components/billing.d.ts.map +1 -1
- package/dist/components/billing.js +3 -3
- package/dist/components/billing.js.map +1 -1
- package/dist/components/cancel-subscription.js +2 -2
- package/dist/components/cancel-subscription.js.map +1 -1
- package/dist/components/capability-usage-card.js +2 -2
- package/dist/components/capability-usage-card.js.map +1 -1
- package/dist/components/chrome.d.ts +3 -2
- package/dist/components/chrome.d.ts.map +1 -1
- package/dist/components/chrome.js +8 -4
- package/dist/components/chrome.js.map +1 -1
- package/dist/components/credit.js +2 -2
- package/dist/components/credit.js.map +1 -1
- package/dist/components/docs-chrome/language-context.d.ts +4 -0
- package/dist/components/docs-chrome/language-context.d.ts.map +1 -1
- package/dist/components/docs-chrome/language-context.js +9 -1
- package/dist/components/docs-chrome/language-context.js.map +1 -1
- package/dist/components/docs-chrome/language.d.ts +18 -4
- package/dist/components/docs-chrome/language.d.ts.map +1 -1
- package/dist/components/docs-chrome/language.js +34 -11
- package/dist/components/docs-chrome/language.js.map +1 -1
- package/dist/components/docs.css +18 -7
- package/dist/components/index.d.ts +4 -4
- package/dist/components/index.d.ts.map +1 -1
- package/dist/components/index.js +8 -3
- package/dist/components/index.js.map +1 -1
- package/dist/components/keys.js +2 -2
- package/dist/components/keys.js.map +1 -1
- package/dist/components/limit-boundary.d.ts +1 -1
- package/dist/components/limit-boundary.d.ts.map +1 -1
- package/dist/components/limit-boundary.js +1 -1
- package/dist/components/limit-boundary.js.map +1 -1
- package/dist/components/limit-notice.js +1 -1
- package/dist/components/limit-notice.js.map +1 -1
- package/dist/components/monogram.d.ts +0 -1
- package/dist/components/monogram.d.ts.map +1 -1
- package/dist/components/monogram.js +1 -1
- package/dist/components/monogram.js.map +1 -1
- package/dist/components/onboarding-view.js +5 -5
- package/dist/components/onboarding-view.js.map +1 -1
- package/dist/components/org-switcher.js +1 -1
- package/dist/components/org-switcher.js.map +1 -1
- package/dist/components/plans-table.d.ts +11 -1
- package/dist/components/plans-table.d.ts.map +1 -1
- package/dist/components/plans-table.js +14 -5
- package/dist/components/plans-table.js.map +1 -1
- package/dist/components/product-docs/fetch-product-docs.js +1 -1
- package/dist/components/product-docs/fetch-product-docs.js.map +1 -1
- package/dist/components/product-docs/markdown.d.ts +14 -0
- package/dist/components/product-docs/markdown.d.ts.map +1 -1
- package/dist/components/product-docs/markdown.js +16 -0
- package/dist/components/product-docs/markdown.js.map +1 -1
- package/dist/components/product-docs/product-docs-customize.d.ts +4 -6
- package/dist/components/product-docs/product-docs-customize.d.ts.map +1 -1
- package/dist/components/product-docs/product-docs-customize.js +3 -5
- package/dist/components/product-docs/product-docs-customize.js.map +1 -1
- package/dist/components/product-docs/product-docs-mdx.d.ts +4 -3
- package/dist/components/product-docs/product-docs-mdx.d.ts.map +1 -1
- package/dist/components/product-docs/product-docs-mdx.js +97 -27
- package/dist/components/product-docs/product-docs-mdx.js.map +1 -1
- package/dist/components/product-docs/product-docs-shell.d.ts +1 -3
- package/dist/components/product-docs/product-docs-shell.d.ts.map +1 -1
- package/dist/components/product-docs/product-docs-shell.js +2 -9
- package/dist/components/product-docs/product-docs-shell.js.map +1 -1
- package/dist/components/product-docs/product-docs-view.d.ts +2 -3
- package/dist/components/product-docs/product-docs-view.d.ts.map +1 -1
- package/dist/components/product-docs/product-docs-view.js +5 -11
- package/dist/components/product-docs/product-docs-view.js.map +1 -1
- package/dist/components/product-docs/product-docs.d.ts +1 -2
- package/dist/components/product-docs/product-docs.d.ts.map +1 -1
- package/dist/components/product-docs/product-docs.js +2 -4
- package/dist/components/product-docs/product-docs.js.map +1 -1
- package/dist/components/resources-panel.js +3 -3
- package/dist/components/resources-panel.js.map +1 -1
- package/dist/components/root.d.ts +45 -8
- package/dist/components/root.d.ts.map +1 -1
- package/dist/components/root.js +54 -21
- package/dist/components/root.js.map +1 -1
- package/dist/components/spend-cap-control.js +2 -2
- package/dist/components/spend-cap-control.js.map +1 -1
- package/dist/components/styles.css +11 -5
- package/dist/components/team-panel.js +2 -2
- package/dist/components/team-panel.js.map +1 -1
- package/dist/components/theme.d.ts +6 -15
- package/dist/components/theme.d.ts.map +1 -1
- package/dist/components/theme.js +8 -88
- package/dist/components/theme.js.map +1 -1
- package/dist/components/top-up-prompt.d.ts +1 -1
- package/dist/components/top-up-prompt.d.ts.map +1 -1
- package/dist/components/upgrade-prompt.d.ts +1 -1
- package/dist/components/upgrade-prompt.d.ts.map +1 -1
- package/dist/components/upgrade-prompt.js +1 -1
- package/dist/components/upgrade-prompt.js.map +1 -1
- package/dist/components/usage.d.ts +5 -1
- package/dist/components/usage.d.ts.map +1 -1
- package/dist/components/usage.js +20 -4
- package/dist/components/usage.js.map +1 -1
- package/dist/config.d.ts +36 -7
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +45 -10
- package/dist/config.js.map +1 -1
- package/dist/deny-codes.js +2 -2
- package/dist/deny-codes.js.map +1 -1
- package/dist/{errors.d.ts → errors/index.d.ts} +36 -3
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/{errors.js → errors/index.js} +51 -3
- package/dist/errors/index.js.map +1 -0
- package/dist/fetch.d.ts +62 -0
- package/dist/fetch.d.ts.map +1 -0
- package/dist/fetch.js +195 -0
- package/dist/fetch.js.map +1 -0
- package/dist/format/index.d.ts +2 -0
- package/dist/format/index.d.ts.map +1 -0
- package/dist/format/index.js +19 -0
- package/dist/format/index.js.map +1 -0
- package/dist/generated/version.d.ts +2 -2
- package/dist/generated/version.d.ts.map +1 -1
- package/dist/generated/version.js +2 -2
- package/dist/generated/version.js.map +1 -1
- package/dist/http.js +8 -8
- package/dist/http.js.map +1 -1
- package/dist/index.d.ts +19 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +16 -14
- package/dist/index.js.map +1 -1
- package/dist/react/hooks.d.ts +1 -1
- package/dist/react/hooks.d.ts.map +1 -1
- package/dist/react/hooks.js +76 -69
- package/dist/react/hooks.js.map +1 -1
- package/dist/react/index.d.ts +7 -1
- package/dist/react/index.d.ts.map +1 -1
- package/dist/react/index.js +13 -1
- package/dist/react/index.js.map +1 -1
- package/dist/react/organization-context.js +1 -1
- package/dist/react/organization-context.js.map +1 -1
- package/dist/react/query-adapter.d.ts +63 -0
- package/dist/react/query-adapter.d.ts.map +1 -0
- package/dist/react/query-adapter.js +117 -0
- package/dist/react/query-adapter.js.map +1 -0
- package/dist/react/scope.d.ts +41 -0
- package/dist/react/scope.d.ts.map +1 -0
- package/dist/react/scope.js +35 -0
- package/dist/react/scope.js.map +1 -0
- package/dist/react/use-async.d.ts +30 -7
- package/dist/react/use-async.d.ts.map +1 -1
- package/dist/react/use-async.js +23 -10
- package/dist/react/use-async.js.map +1 -1
- package/dist/react/use-limit-status.d.ts +1 -1
- package/dist/react/use-limit-status.d.ts.map +1 -1
- package/dist/react/use-limits.d.ts +1 -1
- package/dist/react/use-limits.d.ts.map +1 -1
- package/dist/react/use-limits.js +2 -2
- package/dist/react/use-limits.js.map +1 -1
- package/dist/react/use-upgrade.d.ts +1 -1
- package/dist/react/use-upgrade.d.ts.map +1 -1
- package/dist/react/use-upgrade.js +1 -1
- package/dist/react/use-upgrade.js.map +1 -1
- package/dist/resources/_shared.d.ts +2 -2
- package/dist/resources/_shared.d.ts.map +1 -1
- package/dist/resources/_shared.js +7 -7
- package/dist/resources/_shared.js.map +1 -1
- package/dist/resources/account.js +17 -17
- package/dist/resources/account.js.map +1 -1
- package/dist/resources/api.js +1 -1
- package/dist/resources/api.js.map +1 -1
- package/dist/resources/auth.js +4 -4
- package/dist/resources/auth.js.map +1 -1
- package/dist/resources/billing.d.ts.map +1 -1
- package/dist/resources/billing.js +22 -21
- package/dist/resources/billing.js.map +1 -1
- package/dist/resources/entitlements.js +5 -5
- package/dist/resources/entitlements.js.map +1 -1
- package/dist/resources/keys.js +10 -10
- package/dist/resources/keys.js.map +1 -1
- package/dist/resources/plans.d.ts +1 -1
- package/dist/resources/plans.d.ts.map +1 -1
- package/dist/resources/plans.js +19 -7
- package/dist/resources/plans.js.map +1 -1
- package/dist/resources/resources.d.ts.map +1 -1
- package/dist/resources/resources.js +4 -4
- package/dist/resources/resources.js.map +1 -1
- package/dist/resources/usage.js +4 -4
- package/dist/resources/usage.js.map +1 -1
- package/dist/retry-throttle.d.ts +1 -1
- package/dist/retry-throttle.d.ts.map +1 -1
- package/dist/retry-throttle.js +1 -1
- package/dist/retry-throttle.js.map +1 -1
- package/dist/test-utils/error-builders.d.ts +29 -0
- package/dist/test-utils/error-builders.d.ts.map +1 -0
- package/dist/test-utils/error-builders.js +36 -0
- package/dist/test-utils/error-builders.js.map +1 -0
- package/dist/test-utils/index.d.ts +4 -0
- package/dist/test-utils/index.d.ts.map +1 -0
- package/dist/test-utils/index.js +15 -0
- package/dist/test-utils/index.js.map +1 -0
- package/dist/test-utils/mock-client.d.ts +37 -0
- package/dist/test-utils/mock-client.d.ts.map +1 -0
- package/dist/test-utils/mock-client.js +351 -0
- package/dist/test-utils/mock-client.js.map +1 -0
- package/dist/test-utils/test-provider.d.ts +25 -0
- package/dist/test-utils/test-provider.d.ts.map +1 -0
- package/dist/test-utils/test-provider.js +22 -0
- package/dist/test-utils/test-provider.js.map +1 -0
- package/dist/top-up.js +1 -1
- package/dist/top-up.js.map +1 -1
- package/dist/types.d.ts +9 -15
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/dist/use-fetch.d.ts +18 -0
- package/dist/use-fetch.d.ts.map +1 -0
- package/dist/use-fetch.js +51 -0
- package/dist/use-fetch.js.map +1 -0
- package/dist/variables-registry.d.ts +56 -0
- package/dist/variables-registry.d.ts.map +1 -0
- package/dist/variables-registry.js +172 -0
- package/dist/variables-registry.js.map +1 -0
- package/dist/vars.d.ts +9 -0
- package/dist/vars.d.ts.map +1 -0
- package/dist/vars.js +29 -0
- package/dist/vars.js.map +1 -0
- package/package.json +12 -2
- package/dist/errors.d.ts.map +0 -1
- package/dist/errors.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,7 +3,92 @@
|
|
|
3
3
|
All notable changes to `@farthershore/farthershore-js` are documented here.
|
|
4
4
|
This project adheres to Semantic Versioning (pre-1.0: minors may break).
|
|
5
5
|
|
|
6
|
-
## [
|
|
6
|
+
## [0.10.0] - 2026-07-02
|
|
7
|
+
|
|
8
|
+
Frontend SDK ergonomics redesign — the headless client + hooks are now the
|
|
9
|
+
default surface and the styled portal is an opt-in layer.
|
|
10
|
+
|
|
11
|
+
### Changed (BREAKING)
|
|
12
|
+
|
|
13
|
+
- **`productId` → `businessId`** across the public surface (config,
|
|
14
|
+
`ClientContext`, resources, hooks, params). No `productId` remains in the
|
|
15
|
+
public API.
|
|
16
|
+
- **Ecosystem hook shape:** every data hook returns
|
|
17
|
+
`{ data, error, isLoading, isError, isSuccess, refetch, queryKey }`. The bare
|
|
18
|
+
`loading` field and `refresh` alias are removed (use `isLoading` / `refetch`).
|
|
19
|
+
- **`/errors` subpath:** the full error taxonomy + parse/predicate helpers moved
|
|
20
|
+
to `@farthershore/farthershore-js/errors`. The root re-exports only
|
|
21
|
+
`FartherShoreError`, `FartherShoreApiError`, `LimitExceededError`,
|
|
22
|
+
`FartherShoreRateLimitedError`, and `FartherShoreConfigError`.
|
|
23
|
+
- **`format` namespace:** the catalog display/derivation helpers are grouped
|
|
24
|
+
under `format` (`import { format } from "@farthershore/farthershore-js"`);
|
|
25
|
+
they are no longer flat root exports.
|
|
26
|
+
- Removed the SSR/`createServerClient` surface (platform is browser-only).
|
|
27
|
+
|
|
28
|
+
### Added
|
|
29
|
+
|
|
30
|
+
- **Zero-config client:** `createFartherShoreClient()` with no args on-platform
|
|
31
|
+
(lazy `window.__FS_CONFIG__`, `businessId` discovered from the portal host);
|
|
32
|
+
manual `{ coreUrl, portalHost, businessId, getToken }` is a documented
|
|
33
|
+
dev/test escape hatch.
|
|
34
|
+
- **`fs.fetch(url, opts)`** drop-in secure fetch with a client-side variable
|
|
35
|
+
registry + `PROVIDER_CATALOG` host inference.
|
|
36
|
+
- **`/react`:** prop-free `<FartherShoreProvider>`; `useReadScope()`;
|
|
37
|
+
`useFetch()`; a TanStack-Query / SWR adapter (`fsQueryOptions`,
|
|
38
|
+
`createFsFetcher`) with no runtime dependency on either library.
|
|
39
|
+
- **Composable components:** data components render under a bare
|
|
40
|
+
`<FartherShoreProvider>` (no forced `FartherShoreRoot`);
|
|
41
|
+
`PlansTable`/`UsageCard` gain `renderRow`, `BillingSummary` gains
|
|
42
|
+
`slots.actions`; themeable z-index via `--fs-*-z` CSS variables.
|
|
43
|
+
- **`FartherShoreRoot`** is now a composition of `FsBootGate` /
|
|
44
|
+
`FsAuthProvider` / `FsThemeProvider` with `skipAuth` / `skipTheme` /
|
|
45
|
+
`skipBootGate` flags.
|
|
46
|
+
- **`/test-utils` subpath:** `createMockFartherShoreClient`,
|
|
47
|
+
`<FartherShoreTestProvider>`, and typed error builders
|
|
48
|
+
(`mockLimitExceeded` / `mockRateLimited` / `mockApiError`).
|
|
49
|
+
|
|
50
|
+
### Fixed
|
|
51
|
+
|
|
52
|
+
- `<OrgSwitcher>` read a non-existent `organizationName` field and showed raw
|
|
53
|
+
organization ids; it now reads the `name` field the platform actually sends.
|
|
54
|
+
- `fs.fetch` variable resolution no longer silently hands a lone host-less
|
|
55
|
+
variable to a call targeting a _different_ recognized provider host (e.g. a
|
|
56
|
+
sole `STRIPE_SECRET_KEY` against `api.openai.com`) — it throws
|
|
57
|
+
`FartherShoreConfigError` on that ambiguity, as documented.
|
|
58
|
+
- `sideEffects` now allowlists `*.css` (was `false`), so webpack-based
|
|
59
|
+
consumers no longer tree-shake away the `./components/styles.css` /
|
|
60
|
+
`./components/docs.css` side-effect imports in production builds.
|
|
61
|
+
|
|
62
|
+
## [0.9.0] - 2026-06-29
|
|
63
|
+
|
|
64
|
+
### Changed (BREAKING)
|
|
65
|
+
|
|
66
|
+
- Removed the no-code theming surface as part of the platform/repo branding
|
|
67
|
+
separation: `FsAppearance` is trimmed to `{ theme, brandColor, variables }`
|
|
68
|
+
(the `fontFamily`/`radius`/`density`/`colorScheme` dimensions and the
|
|
69
|
+
`FsFontFamily`/`FsRadius`/`FsDensity`/`FsColorScheme` types are gone), and
|
|
70
|
+
`BusinessAppearance` + `primaryColor` are dropped from the branding/bootstrap
|
|
71
|
+
types. Theme color is now the hardcoded base token `--fs-color-brand: #6366f1`;
|
|
72
|
+
fonts/radius/density are editable template CSS. Light/dark mode + the
|
|
73
|
+
`variables` escape hatch are unchanged.
|
|
74
|
+
|
|
75
|
+
### Added
|
|
76
|
+
|
|
77
|
+
- `<CodeGroup>` component: a tabbed code block container for the docs surface.
|
|
78
|
+
- Open-languages docs boot: the SDK now accepts and forwards an
|
|
79
|
+
`openLanguages` hint to the docs primitives so the builder's configured
|
|
80
|
+
language tabs open on first load.
|
|
81
|
+
- `docsEnabled` boot bit: bootstrapped `Business` now carries a `docsEnabled`
|
|
82
|
+
flag; the docs surface renders only when this is `true`.
|
|
83
|
+
|
|
84
|
+
## [0.8.7] - 2026-06-28
|
|
85
|
+
|
|
86
|
+
### Fixed
|
|
87
|
+
|
|
88
|
+
- Best-effort authenticated reads (`/me/*` etc.) no longer trip the
|
|
89
|
+
`onUnauthorized` redirect on a transient 401: a `recoverAuth` transport flag
|
|
90
|
+
lets those reads fail soft instead of bouncing the portal through sign-in
|
|
91
|
+
(fixes the dev-portal `/docs` auth loop).
|
|
7
92
|
|
|
8
93
|
## [0.8.6] - 2026-06-28
|
|
9
94
|
|