@vxil/sdk 0.35.0 → 0.35.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +27 -0
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -321,6 +321,33 @@ export interface FeatureConfig {
321
321
  feature: string;
322
322
  version: number;
323
323
  manifest: Record<string, unknown>;
324
+ /** cms writes only (PUT /v1/config/cms): what the write changed in
325
+ * `features.cms.rules[]` (the App builder apps' rules). */
326
+ rules_summary?: ConfigRulesSummary;
327
+ }
328
+ /** One rules[] entry as a cms config write reports it. */
329
+ export interface ConfigRuleLine {
330
+ app: string;
331
+ kind: string;
332
+ collection: string;
333
+ sentence: string;
334
+ /** server: cms enforces it for every writer but the owner's server key; app: only writes through that App builder app are checked */
335
+ enforced_by: 'app' | 'server';
336
+ /** an added capacity / no_overlap rule only: the `list.field` keys the app's page does not provably write */
337
+ unwritten_keys?: string[];
338
+ }
339
+ /** `rules_summary` of a cms config write. */
340
+ export interface ConfigRulesSummary {
341
+ added: ConfigRuleLine[];
342
+ removed: ConfigRuleLine[];
343
+ /** w43: the rules that were waiting for Apply (their write had not landed
344
+ * yet) that this write's rules[] left out — dropped, never committed later.
345
+ * Absent when none. `quote` is the brief's own words for the rule. */
346
+ dropped_waiting?: Array<{
347
+ kind: string;
348
+ collection: string;
349
+ quote: string;
350
+ }>;
324
351
  }
325
352
  /** The failure-alert digest settings (`webhooks.alerts`, guide ch. 12). The
326
353
  * digest mails the project's owner accounts; `chatWebhook` (ALERT-CHAT-DEST)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vxil/sdk",
3
- "version": "0.35.0",
3
+ "version": "0.35.1",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "Typed client for the Vxil REST API (notifications, auth, jobs, files, cms, comments, webhooks, realtime, orgs, rate-limits).",