@camstack/addon-agent-ui 1.2.38 → 1.2.39

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/addon.js +128 -1
  2. package/package.json +1 -1
package/dist/addon.js CHANGED
@@ -5917,6 +5917,40 @@ var BaseAddon = class {
5917
5917
  deviceSettingsSchema() {
5918
5918
  return null;
5919
5919
  }
5920
+ /**
5921
+ * INTEGRATION-LEVEL SETTINGS — declare which of this addon's global sections
5922
+ * ARE the configuration of its integration.
5923
+ *
5924
+ * Return the `ConfigSection.id`s, from {@link globalSettingsSchema}, that an
5925
+ * operator should find on the addon's integration page (System →
5926
+ * Integrations → <name>) rather than only in the cluster-wide list of every
5927
+ * addon. Empty (the default) means the addon has no integration-level
5928
+ * settings and no such surface is offered — this is opt-in, because whether
5929
+ * an addon's configuration IS its integration's configuration depends on the
5930
+ * nature of the integration.
5931
+ *
5932
+ * WHAT THIS IS NOT. It is not a scope. The selected sections keep living in
5933
+ * the ONE global schema, in the ONE addon store, written by the ONE
5934
+ * `updateGlobalSettings` path. There is deliberately no
5935
+ * `updateIntegrationSettings`: a second write path is how a surface acquires
5936
+ * a second store key, and this repo has shipped that twice (`btmPath@hub`,
5937
+ * D266). Selecting sections cannot introduce a key that selecting cannot.
5938
+ *
5939
+ * WHY IT IS A LIST OF SECTION IDS AND NOT A MARKER ON THE SECTION.
5940
+ * `ConfigFieldBase` used to carry `scope?: 'device' | 'global'` and it was
5941
+ * removed with the reason recorded at
5942
+ * `packages/types/src/interfaces/config-ui.ts:249` — *"a field's scope is
5943
+ * determined by WHICH schema it lives in, not by a field-level marker."* A
5944
+ * marker sprinkled across sections also has to borrow a field that already
5945
+ * means something else; borrowing `section.tab` put the literal word
5946
+ * "integration" into an operator-facing tab bar, because `tab` means "how to
5947
+ * GROUP this visually" and cannot also mean "where this lives" (D269
5948
+ * supersedes D268). One declaration, in one place, next to the schema whose
5949
+ * ids it names.
5950
+ */
5951
+ integrationSettingSections() {
5952
+ return [];
5953
+ }
5920
5954
  async getGlobalSettings(overlay, cap, nodeId) {
5921
5955
  const schema = this.globalSettingsSchema(cap);
5922
5956
  if (!schema) return { sections: [] };
@@ -5927,6 +5961,55 @@ var BaseAddon = class {
5927
5961
  } : projected);
5928
5962
  }
5929
5963
  /**
5964
+ * The integration-level view of this addon's settings: exactly the sections
5965
+ * named by {@link integrationSettingSections}, hydrated from the SAME store
5966
+ * `getGlobalSettings` reads, and narrowed to cluster-scoped fields.
5967
+ *
5968
+ * Returns `null` when the addon declared nothing — an addon that opts out has
5969
+ * no integration settings surface at all, rather than an empty one that reads
5970
+ * as a failed load.
5971
+ *
5972
+ * Three properties hold BY CONSTRUCTION, which is why they are here in core
5973
+ * and not in whichever UI happens to render this:
5974
+ *
5975
+ * 1. **One key.** The payload is a SUBSET of the global schema, so a field
5976
+ * shown here is the same field, with the same bare key, that the addon's
5977
+ * own page shows. There is no integration-specific writer — callers save
5978
+ * through `updateGlobalSettings` — so a second store key is unreachable,
5979
+ * not merely discouraged.
5980
+ * 2. **No node scope.** `perNode: true` fields are DROPPED. Their store key
5981
+ * is `<key>@<nodeId>` and an integration is not a node; whichever node
5982
+ * such a field silently picked would be a wrong answer for the operator
5983
+ * who opened the page (D266).
5984
+ * 3. **No silent typo.** A declared id that names no section throws. The
5985
+ * alternative — skip it — turns a rename into a surface that quietly
5986
+ * empties, which looks exactly like an addon with nothing to configure.
5987
+ */
5988
+ async getIntegrationSettings(nodeId) {
5989
+ const declared = this.integrationSettingSections();
5990
+ if (declared.length === 0) return null;
5991
+ const schema = this.globalSettingsSchema();
5992
+ if (!schema) throw new Error(`${this.constructor.name}: integrationSettingSections() names [${declared.join(", ")}] but globalSettingsSchema() returns null.`);
5993
+ const byId = new Map(schema.sections.map((section) => [section.id, section]));
5994
+ const sections = [];
5995
+ for (const id of declared) {
5996
+ const section = byId.get(id);
5997
+ if (!section) throw new Error(`${this.constructor.name}: integrationSettingSections() names unknown section "${id}". Known sections: [${[...byId.keys()].join(", ")}].`);
5998
+ const fields = dropPerNodeFields(section.fields);
5999
+ if (fields.length === 0) continue;
6000
+ sections.push({
6001
+ ...section,
6002
+ fields
6003
+ });
6004
+ }
6005
+ if (sections.length === 0) return null;
6006
+ const projected = await this.resolveGlobalStore(nodeId);
6007
+ return hydrateSchema({
6008
+ ...schema,
6009
+ sections
6010
+ }, projected);
6011
+ }
6012
+ /**
5930
6013
  * The raw addon store PROJECTED onto the target node's bare per-node keys:
5931
6014
  * every `perNode: true` field carries THAT node's scoped value on its bare
5932
6015
  * key (absent scoped key ⇒ key absent, so the schema `default` wins — no
@@ -6230,6 +6313,41 @@ var BaseAddon = class {
6230
6313
  * `hydrateSchema` does. Valueless structural fields (separator/info/…)
6231
6314
  * don't declare `perNode` and are excluded by the `in` narrowing.
6232
6315
  */
6316
+ /**
6317
+ * The same fields with every `perNode: true` one removed, recursing into layout
6318
+ * containers exactly as {@link collectPerNodeFieldKeys} does. A container left
6319
+ * with no child is dropped rather than rendered empty.
6320
+ *
6321
+ * Used by `getIntegrationSettings`: an integration is not a node, so a field
6322
+ * whose store key is `<key>@<nodeId>` has no node to belong to there.
6323
+ */
6324
+ function dropPerNodeFields(fields) {
6325
+ const kept = [];
6326
+ for (const field of fields) {
6327
+ if (field.type === "group") {
6328
+ const inner = dropPerNodeFields(field.fields);
6329
+ if (inner.length > 0) kept.push({
6330
+ ...field,
6331
+ fields: inner
6332
+ });
6333
+ continue;
6334
+ }
6335
+ if (field.type === "sub-tabs") {
6336
+ const tabs = field.tabs.map((tab) => ({
6337
+ ...tab,
6338
+ fields: dropPerNodeFields(tab.fields)
6339
+ })).filter((tab) => tab.fields.length > 0);
6340
+ if (tabs.length > 0) kept.push({
6341
+ ...field,
6342
+ tabs
6343
+ });
6344
+ continue;
6345
+ }
6346
+ if ("perNode" in field && field.perNode === true) continue;
6347
+ kept.push(field);
6348
+ }
6349
+ return kept;
6350
+ }
6233
6351
  function collectPerNodeFieldKeys(fields) {
6234
6352
  const collected = [];
6235
6353
  for (const field of fields) {
@@ -9401,6 +9519,9 @@ method(object({
9401
9519
  kind: "mutation",
9402
9520
  auth: "admin"
9403
9521
  }), method(object({
9522
+ addonId: string(),
9523
+ nodeId: string().optional()
9524
+ }), SettingsSchemaWithValuesSchema.nullable()), method(object({
9404
9525
  addonId: string(),
9405
9526
  deviceId: number(),
9406
9527
  nodeId: string().optional()
@@ -27795,6 +27916,12 @@ Object.freeze({
27795
27916
  addonId: null,
27796
27917
  access: "view"
27797
27918
  },
27919
+ "addonSettings.getIntegrationSettings": {
27920
+ capName: "addon-settings",
27921
+ capScope: "system",
27922
+ addonId: null,
27923
+ access: "view"
27924
+ },
27798
27925
  "addonSettings.updateDeviceSettings": {
27799
27926
  capName: "addon-settings",
27800
27927
  capScope: "system",
@@ -35670,7 +35797,7 @@ var AgentUIAddon = class extends BaseAddon {
35670
35797
  capability: adminUiCapability,
35671
35798
  provider: {
35672
35799
  getStaticDir: async () => ({ staticDir: path.resolve(__dirname) }),
35673
- getVersion: async () => ({ version: "1.2.38" })
35800
+ getVersion: async () => ({ version: "1.2.39" })
35674
35801
  }
35675
35802
  }];
35676
35803
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camstack/addon-agent-ui",
3
- "version": "1.2.38",
3
+ "version": "1.2.39",
4
4
  "description": "Agent UI — lightweight status dashboard served by every agent node",
5
5
  "keywords": [
6
6
  "camstack",