@camstack/addon-provider-amcrest 0.2.37 → 0.2.39

package/dist/addon.js

@@ -5921,6 +5921,40 @@ var BaseAddon = class {
 	deviceSettingsSchema() {
 		return null;
 	}
+	/**
+	* INTEGRATION-LEVEL SETTINGS — declare which of this addon's global sections
+	* ARE the configuration of its integration.
+	*
+	* Return the `ConfigSection.id`s, from {@link globalSettingsSchema}, that an
+	* operator should find on the addon's integration page (System →
+	* Integrations → <name>) rather than only in the cluster-wide list of every
+	* addon. Empty (the default) means the addon has no integration-level
+	* settings and no such surface is offered — this is opt-in, because whether
+	* an addon's configuration IS its integration's configuration depends on the
+	* nature of the integration.
+	*
+	* WHAT THIS IS NOT. It is not a scope. The selected sections keep living in
+	* the ONE global schema, in the ONE addon store, written by the ONE
+	* `updateGlobalSettings` path. There is deliberately no
+	* `updateIntegrationSettings`: a second write path is how a surface acquires
+	* a second store key, and this repo has shipped that twice (`btmPath@hub`,
+	* D266). Selecting sections cannot introduce a key that selecting cannot.
+	*
+	* WHY IT IS A LIST OF SECTION IDS AND NOT A MARKER ON THE SECTION.
+	* `ConfigFieldBase` used to carry `scope?: 'device' | 'global'` and it was
+	* removed with the reason recorded at
+	* `packages/types/src/interfaces/config-ui.ts:249` — *"a field's scope is
+	* determined by WHICH schema it lives in, not by a field-level marker."* A
+	* marker sprinkled across sections also has to borrow a field that already
+	* means something else; borrowing `section.tab` put the literal word
+	* "integration" into an operator-facing tab bar, because `tab` means "how to
+	* GROUP this visually" and cannot also mean "where this lives" (D269
+	* supersedes D268). One declaration, in one place, next to the schema whose
+	* ids it names.
+	*/
+	integrationSettingSections() {
+		return [];
+	}
 	async getGlobalSettings(overlay, cap, nodeId) {
 		const schema = this.globalSettingsSchema(cap);
 		if (!schema) return { sections: [] };
@@ -5931,6 +5965,55 @@ var BaseAddon = class {
 		} : projected);
 	}
 	/**
+	* The integration-level view of this addon's settings: exactly the sections
+	* named by {@link integrationSettingSections}, hydrated from the SAME store
+	* `getGlobalSettings` reads, and narrowed to cluster-scoped fields.
+	*
+	* Returns `null` when the addon declared nothing — an addon that opts out has
+	* no integration settings surface at all, rather than an empty one that reads
+	* as a failed load.
+	*
+	* Three properties hold BY CONSTRUCTION, which is why they are here in core
+	* and not in whichever UI happens to render this:
+	*
+	*  1. **One key.** The payload is a SUBSET of the global schema, so a field
+	*     shown here is the same field, with the same bare key, that the addon's
+	*     own page shows. There is no integration-specific writer — callers save
+	*     through `updateGlobalSettings` — so a second store key is unreachable,
+	*     not merely discouraged.
+	*  2. **No node scope.** `perNode: true` fields are DROPPED. Their store key
+	*     is `<key>@<nodeId>` and an integration is not a node; whichever node
+	*     such a field silently picked would be a wrong answer for the operator
+	*     who opened the page (D266).
+	*  3. **No silent typo.** A declared id that names no section throws. The
+	*     alternative — skip it — turns a rename into a surface that quietly
+	*     empties, which looks exactly like an addon with nothing to configure.
+	*/
+	async getIntegrationSettings(nodeId) {
+		const declared = this.integrationSettingSections();
+		if (declared.length === 0) return null;
+		const schema = this.globalSettingsSchema();
+		if (!schema) throw new Error(`${this.constructor.name}: integrationSettingSections() names [${declared.join(", ")}] but globalSettingsSchema() returns null.`);
+		const byId = new Map(schema.sections.map((section) => [section.id, section]));
+		const sections = [];
+		for (const id of declared) {
+			const section = byId.get(id);
+			if (!section) throw new Error(`${this.constructor.name}: integrationSettingSections() names unknown section "${id}". Known sections: [${[...byId.keys()].join(", ")}].`);
+			const fields = dropPerNodeFields(section.fields);
+			if (fields.length === 0) continue;
+			sections.push({
+				...section,
+				fields
+			});
+		}
+		if (sections.length === 0) return null;
+		const projected = await this.resolveGlobalStore(nodeId);
+		return hydrateSchema({
+			...schema,
+			sections
+		}, projected);
+	}
+	/**
 	* The raw addon store PROJECTED onto the target node's bare per-node keys:
 	* every `perNode: true` field carries THAT node's scoped value on its bare
 	* key (absent scoped key ⇒ key absent, so the schema `default` wins — no
@@ -6234,6 +6317,41 @@ var BaseAddon = class {
 * `hydrateSchema` does. Valueless structural fields (separator/info/…)
 * don't declare `perNode` and are excluded by the `in` narrowing.
 */
+/**
+* The same fields with every `perNode: true` one removed, recursing into layout
+* containers exactly as {@link collectPerNodeFieldKeys} does. A container left
+* with no child is dropped rather than rendered empty.
+*
+* Used by `getIntegrationSettings`: an integration is not a node, so a field
+* whose store key is `<key>@<nodeId>` has no node to belong to there.
+*/
+function dropPerNodeFields(fields) {
+	const kept = [];
+	for (const field of fields) {
+		if (field.type === "group") {
+			const inner = dropPerNodeFields(field.fields);
+			if (inner.length > 0) kept.push({
+				...field,
+				fields: inner
+			});
+			continue;
+		}
+		if (field.type === "sub-tabs") {
+			const tabs = field.tabs.map((tab) => ({
+				...tab,
+				fields: dropPerNodeFields(tab.fields)
+			})).filter((tab) => tab.fields.length > 0);
+			if (tabs.length > 0) kept.push({
+				...field,
+				tabs
+			});
+			continue;
+		}
+		if ("perNode" in field && field.perNode === true) continue;
+		kept.push(field);
+	}
+	return kept;
+}
 function collectPerNodeFieldKeys(fields) {
 	const collected = [];
 	for (const field of fields) {
@@ -9391,6 +9509,9 @@ method(object({
 	kind: "mutation",
 	auth: "admin"
 }), method(object({
+	addonId: string(),
+	nodeId: string().optional()
+}), SettingsSchemaWithValuesSchema.nullable()), method(object({
 	addonId: string(),
 	deviceId: number(),
 	nodeId: string().optional()
@@ -32080,6 +32201,12 @@ Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"addonSettings.getIntegrationSettings": {
+		capName: "addon-settings",
+		capScope: "system",
+		addonId: null,
+		access: "view"
+	},
 	"addonSettings.updateDeviceSettings": {
 		capName: "addon-settings",
 		capScope: "system",

package/dist/addon.mjs

@@ -5922,6 +5922,40 @@ var BaseAddon = class {
 	deviceSettingsSchema() {
 		return null;
 	}
+	/**
+	* INTEGRATION-LEVEL SETTINGS — declare which of this addon's global sections
+	* ARE the configuration of its integration.
+	*
+	* Return the `ConfigSection.id`s, from {@link globalSettingsSchema}, that an
+	* operator should find on the addon's integration page (System →
+	* Integrations → <name>) rather than only in the cluster-wide list of every
+	* addon. Empty (the default) means the addon has no integration-level
+	* settings and no such surface is offered — this is opt-in, because whether
+	* an addon's configuration IS its integration's configuration depends on the
+	* nature of the integration.
+	*
+	* WHAT THIS IS NOT. It is not a scope. The selected sections keep living in
+	* the ONE global schema, in the ONE addon store, written by the ONE
+	* `updateGlobalSettings` path. There is deliberately no
+	* `updateIntegrationSettings`: a second write path is how a surface acquires
+	* a second store key, and this repo has shipped that twice (`btmPath@hub`,
+	* D266). Selecting sections cannot introduce a key that selecting cannot.
+	*
+	* WHY IT IS A LIST OF SECTION IDS AND NOT A MARKER ON THE SECTION.
+	* `ConfigFieldBase` used to carry `scope?: 'device' | 'global'` and it was
+	* removed with the reason recorded at
+	* `packages/types/src/interfaces/config-ui.ts:249` — *"a field's scope is
+	* determined by WHICH schema it lives in, not by a field-level marker."* A
+	* marker sprinkled across sections also has to borrow a field that already
+	* means something else; borrowing `section.tab` put the literal word
+	* "integration" into an operator-facing tab bar, because `tab` means "how to
+	* GROUP this visually" and cannot also mean "where this lives" (D269
+	* supersedes D268). One declaration, in one place, next to the schema whose
+	* ids it names.
+	*/
+	integrationSettingSections() {
+		return [];
+	}
 	async getGlobalSettings(overlay, cap, nodeId) {
 		const schema = this.globalSettingsSchema(cap);
 		if (!schema) return { sections: [] };
@@ -5932,6 +5966,55 @@ var BaseAddon = class {
 		} : projected);
 	}
 	/**
+	* The integration-level view of this addon's settings: exactly the sections
+	* named by {@link integrationSettingSections}, hydrated from the SAME store
+	* `getGlobalSettings` reads, and narrowed to cluster-scoped fields.
+	*
+	* Returns `null` when the addon declared nothing — an addon that opts out has
+	* no integration settings surface at all, rather than an empty one that reads
+	* as a failed load.
+	*
+	* Three properties hold BY CONSTRUCTION, which is why they are here in core
+	* and not in whichever UI happens to render this:
+	*
+	*  1. **One key.** The payload is a SUBSET of the global schema, so a field
+	*     shown here is the same field, with the same bare key, that the addon's
+	*     own page shows. There is no integration-specific writer — callers save
+	*     through `updateGlobalSettings` — so a second store key is unreachable,
+	*     not merely discouraged.
+	*  2. **No node scope.** `perNode: true` fields are DROPPED. Their store key
+	*     is `<key>@<nodeId>` and an integration is not a node; whichever node
+	*     such a field silently picked would be a wrong answer for the operator
+	*     who opened the page (D266).
+	*  3. **No silent typo.** A declared id that names no section throws. The
+	*     alternative — skip it — turns a rename into a surface that quietly
+	*     empties, which looks exactly like an addon with nothing to configure.
+	*/
+	async getIntegrationSettings(nodeId) {
+		const declared = this.integrationSettingSections();
+		if (declared.length === 0) return null;
+		const schema = this.globalSettingsSchema();
+		if (!schema) throw new Error(`${this.constructor.name}: integrationSettingSections() names [${declared.join(", ")}] but globalSettingsSchema() returns null.`);
+		const byId = new Map(schema.sections.map((section) => [section.id, section]));
+		const sections = [];
+		for (const id of declared) {
+			const section = byId.get(id);
+			if (!section) throw new Error(`${this.constructor.name}: integrationSettingSections() names unknown section "${id}". Known sections: [${[...byId.keys()].join(", ")}].`);
+			const fields = dropPerNodeFields(section.fields);
+			if (fields.length === 0) continue;
+			sections.push({
+				...section,
+				fields
+			});
+		}
+		if (sections.length === 0) return null;
+		const projected = await this.resolveGlobalStore(nodeId);
+		return hydrateSchema({
+			...schema,
+			sections
+		}, projected);
+	}
+	/**
 	* The raw addon store PROJECTED onto the target node's bare per-node keys:
 	* every `perNode: true` field carries THAT node's scoped value on its bare
 	* key (absent scoped key ⇒ key absent, so the schema `default` wins — no
@@ -6235,6 +6318,41 @@ var BaseAddon = class {
 * `hydrateSchema` does. Valueless structural fields (separator/info/…)
 * don't declare `perNode` and are excluded by the `in` narrowing.
 */
+/**
+* The same fields with every `perNode: true` one removed, recursing into layout
+* containers exactly as {@link collectPerNodeFieldKeys} does. A container left
+* with no child is dropped rather than rendered empty.
+*
+* Used by `getIntegrationSettings`: an integration is not a node, so a field
+* whose store key is `<key>@<nodeId>` has no node to belong to there.
+*/
+function dropPerNodeFields(fields) {
+	const kept = [];
+	for (const field of fields) {
+		if (field.type === "group") {
+			const inner = dropPerNodeFields(field.fields);
+			if (inner.length > 0) kept.push({
+				...field,
+				fields: inner
+			});
+			continue;
+		}
+		if (field.type === "sub-tabs") {
+			const tabs = field.tabs.map((tab) => ({
+				...tab,
+				fields: dropPerNodeFields(tab.fields)
+			})).filter((tab) => tab.fields.length > 0);
+			if (tabs.length > 0) kept.push({
+				...field,
+				tabs
+			});
+			continue;
+		}
+		if ("perNode" in field && field.perNode === true) continue;
+		kept.push(field);
+	}
+	return kept;
+}
 function collectPerNodeFieldKeys(fields) {
 	const collected = [];
 	for (const field of fields) {
@@ -9392,6 +9510,9 @@ method(object({
 	kind: "mutation",
 	auth: "admin"
 }), method(object({
+	addonId: string(),
+	nodeId: string().optional()
+}), SettingsSchemaWithValuesSchema.nullable()), method(object({
 	addonId: string(),
 	deviceId: number(),
 	nodeId: string().optional()
@@ -32081,6 +32202,12 @@ Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"addonSettings.getIntegrationSettings": {
+		capName: "addon-settings",
+		capScope: "system",
+		addonId: null,
+		access: "view"
+	},
 	"addonSettings.updateDeviceSettings": {
 		capName: "addon-settings",
 		capScope: "system",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/addon-provider-amcrest",
-  "version": "0.2.37",
+  "version": "0.2.39",
   "description": "Amcrest/Dahua camera device provider addon for CamStack — Dahua CGI over HTTP(S) with digest auth (snapshot, RTSP catalog, PTZ, image/day-night config)",
   "keywords": [
     "camstack",