@camstack/addon-decoder-nodeav 1.2.35 → 1.2.37

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