@forumulate/sdk 0.10.0 → 0.11.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 +30 -1
- package/README.md +1 -1
- package/dist/http.d.ts +1 -1
- package/dist/http.js +1 -1
- package/dist/operations.gen.d.ts +221 -42
- package/dist/operations.gen.js +79 -72
- package/dist/schema.d.ts +2 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,7 +3,36 @@
|
|
|
3
3
|
Releases of `@forumulate/sdk`. Earlier versions are described in the git history of
|
|
4
4
|
`packages/sdk` (`release(sdk): …` commits).
|
|
5
5
|
|
|
6
|
-
## 0.
|
|
6
|
+
## 0.11.0
|
|
7
|
+
|
|
8
|
+
Every settings object writable by PATCH, site-level settings, a whole site from one manifest, and stable method names.
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- `PATCH` beside every org, space, site and provider settings object, with `?dryRun` (the diff, nothing written) and `?prune` where the write merges: for example `spaceSettings.patchSeo`, `patchHomePage`, `patchVisitorAuth`, `patchPreset` (and `getPreset`), `org.patchSiem`, `orgPayments.patch`, `aiProvider.patch`, `ssoAdmin.patch`, `samlAdmin.patch`, `mailProvider.patch`, `edgeProvider.patch` / `getOne`, `sdkPublishing.getRegistry` / `patchRegistry`, the course, blog, events, status, consent and policy-gate settings. A read of an unset object now round-trips into a write.
|
|
13
|
+
- `siteSettings.*`, `siteReaderPolicy.*` (legal gate, reader identity), `siteReaderAuth.*`, `siteConsent.*` and `siteBrand.patch`, `siteFrontPage.patch`, `siteLabels.labels`: a site sets everything a space does (SEO, analytics, comments, discovery, AI, reader themes, visitor auth, consent), and `siteSettings.themeOrigins` / `removeThemeOrigin` / `restoreThemeOrigin` manage the origins its theme discovers. `siteConsentPublic.resolved` reads the consent a reader sees.
|
|
14
|
+
- `seoReport.forSpace()` / `forSite()`: what the reader's `<head>` states and where each value came from. `objectSchema.site()` / `space()`: the JSON Schema of one object's configuration.
|
|
15
|
+
- `Manifest_apply` (`PUT /orgs/{orgId}/manifest`) now carries `posts`, `authors`, `topics`, `openapi`, `homeDoc`, `translationOverrides` and `orgSettings`, plus publisher units: space languages, SEO, translations, front door, contact form and About, pages from Markdown with locale twins, and sites. Strict settings: an unknown key is named, not dropped. `contact.replaceForm()` (`Contact_replaceForm`) and `policySources.putFields()` complete the set.
|
|
16
|
+
- `spaces.labels.labels()` and `integrations.customProviders.get()` / `patch()`.
|
|
17
|
+
|
|
18
|
+
### Changed
|
|
19
|
+
|
|
20
|
+
- **Breaking: renamed operationIds and generated methods.** The nine routes the generator had numbered `[0]`, `[1]`, ... now have stable names (the numbering depended on registration order):
|
|
21
|
+
- `courses.packageFiles.file[0]` ... `file[9]` are `file`, `fileDepth2` ... `fileDepth10`.
|
|
22
|
+
- `delivery.entries`: `types[1]`, `list[1]`, `query[1]`, `one[1]`, `global[1]`, `schema[1]`, `openapi[1]` (the `/k/{keyId}` routes) are `typesByKey`, `listByKey`, `queryByKey`, `oneByKey`, `globalByKey`, `schemaByKey`, `openapiByKey`; the `[0]` forms lose the suffix.
|
|
23
|
+
- `delivery.site`: `routes`, `resolve`, `redirects`, `sitemap`, `search` the same way (`routesByKey`, ...).
|
|
24
|
+
- `integrations.githubWebhook`: `receive[0]` is `receive`, `receive[1]` is `receiveGithub`.
|
|
25
|
+
Anything that called `client.request('DeliveryEntries_list[0]')` or the bracketed property must use the new name.
|
|
26
|
+
- The generated default `Forumulate-Version` is now `2027-02-01` (was `2027-01-01`). From that version a search door (docs, reader, site, organization, chat and public forum search) answers an empty `q` with 422 `validation.failed` instead of 200 with no hits. A short term still answers 200 with `minQueryLength`. Pass `apiVersion: '2027-01-01'` to keep the old answer.
|
|
27
|
+
- An unknown dated `Forumulate-Version` rounds down to the newest released one and says so; the bad-version 400 suggests the newest.
|
|
28
|
+
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
31
|
+
- Unset settings objects (reader auth, consent) read as unset rather than blank, and PATCH-after-GET round-trips.
|
|
32
|
+
- The embed manifest's tenant budget is measured in UTF-8 bytes, not characters.
|
|
33
|
+
- Translation and author maps in manifests keep their shape when the value schema comes from another copy of zod.
|
|
34
|
+
|
|
35
|
+
## 0.10.0
|
|
7
36
|
|
|
8
37
|
Cache, trash and destroy under their own names; publish runs; the token, named.
|
|
9
38
|
|
package/README.md
CHANGED
|
@@ -293,7 +293,7 @@ Each call also takes `headers`, `signal` (an `AbortSignal`) and `maxRetries`.
|
|
|
293
293
|
new ForumulateClient({
|
|
294
294
|
baseUrl: 'https://forumulate.com/api',
|
|
295
295
|
token,
|
|
296
|
-
apiVersion: '
|
|
296
|
+
apiVersion: '2027-02-01', // Forumulate-Version for every request (default: generated methods only)
|
|
297
297
|
maxRetries: 2, // 0 turns retries off
|
|
298
298
|
autoIdempotencyKey: true, // generated Idempotency-Key on POST/PATCH
|
|
299
299
|
userAgent: 'my-app/1.0', // default forumulate-sdk-js/<version> outside a browser
|
package/dist/http.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* and not another.
|
|
7
7
|
*/
|
|
8
8
|
/** Kept in step with package.json by `coverage.test.ts`. */
|
|
9
|
-
export declare const SDK_VERSION = "0.
|
|
9
|
+
export declare const SDK_VERSION = "0.11.0";
|
|
10
10
|
/** The API's error envelope: `{ error: { code, message, details? }, requestId? }`. */
|
|
11
11
|
export interface ForumulateErrorInit {
|
|
12
12
|
/** Field-level detail, e.g. `{ title: ['Required'] }` for `validation.failed`. */
|
package/dist/http.js
CHANGED
|
@@ -11,7 +11,7 @@ exports.ForumulateError = exports.SDK_VERSION = void 0;
|
|
|
11
11
|
exports.retryDelayMs = retryDelayMs;
|
|
12
12
|
exports.send = send;
|
|
13
13
|
/** Kept in step with package.json by `coverage.test.ts`. */
|
|
14
|
-
exports.SDK_VERSION = '0.
|
|
14
|
+
exports.SDK_VERSION = '0.11.0';
|
|
15
15
|
/**
|
|
16
16
|
* Thrown for any non-2xx API response, and for a network failure that
|
|
17
17
|
* outlived its retries (`status: 0`, `code: 'network.error'`). Mirrors the
|