@camstack/addon-remote-storage 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/s3.addon.js CHANGED
@@ -2,7 +2,7 @@ Object.defineProperties(exports, {
2
2
  __esModule: { value: true },
3
3
  [Symbol.toStringTag]: { value: "Module" }
4
4
  });
5
- const require_shared = require("./shared-CWzgutnW.js");
5
+ const require_shared = require("./shared-OO8jwvqy.js");
6
6
  let node_stream = require("node:stream");
7
7
  let _aws_sdk_client_s3 = require("@aws-sdk/client-s3");
8
8
  let _aws_sdk_lib_storage = require("@aws-sdk/lib-storage");
package/dist/s3.addon.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { c as BaseAddon, i as rearmIdleAbort, n as getOptionalBasePath, o as scheduleIdleAbort, s as storageProviderCapability, t as createSessionId } from "./shared-AzvwyoO3.mjs";
1
+ import { c as BaseAddon, i as rearmIdleAbort, n as getOptionalBasePath, o as scheduleIdleAbort, s as storageProviderCapability, t as createSessionId } from "./shared-Bo03e3ba.mjs";
2
2
  import { PassThrough } from "node:stream";
3
3
  import { DeleteObjectCommand, GetObjectCommand, HeadBucketCommand, HeadObjectCommand, ListObjectsV2Command, PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
4
4
  import { Upload } from "@aws-sdk/lib-storage";
@@ -2,7 +2,7 @@ Object.defineProperties(exports, {
2
2
  __esModule: { value: true },
3
3
  [Symbol.toStringTag]: { value: "Module" }
4
4
  });
5
- const require_shared = require("./shared-CWzgutnW.js");
5
+ const require_shared = require("./shared-OO8jwvqy.js");
6
6
  let ssh2 = require("ssh2");
7
7
  let node_path = require("node:path");
8
8
  node_path = require_shared.__toESM(node_path);
@@ -1,4 +1,4 @@
1
- import { a as safeJoinRemotePath, c as BaseAddon, i as rearmIdleAbort, o as scheduleIdleAbort, r as getRequiredBasePath, s as storageProviderCapability, t as createSessionId } from "./shared-AzvwyoO3.mjs";
1
+ import { a as safeJoinRemotePath, c as BaseAddon, i as rearmIdleAbort, o as scheduleIdleAbort, r as getRequiredBasePath, s as storageProviderCapability, t as createSessionId } from "./shared-Bo03e3ba.mjs";
2
2
  import { Client } from "ssh2";
3
3
  import * as path from "node:path";
4
4
  //#region src/providers/sftp/sftp-config-schema.ts
@@ -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) {
@@ -9383,6 +9501,9 @@ method(object({
9383
9501
  kind: "mutation",
9384
9502
  auth: "admin"
9385
9503
  }), method(object({
9504
+ addonId: string(),
9505
+ nodeId: string().optional()
9506
+ }), SettingsSchemaWithValuesSchema.nullable()), method(object({
9386
9507
  addonId: string(),
9387
9508
  deviceId: number(),
9388
9509
  nodeId: string().optional()
@@ -27837,6 +27958,12 @@ Object.freeze({
27837
27958
  addonId: null,
27838
27959
  access: "view"
27839
27960
  },
27961
+ "addonSettings.getIntegrationSettings": {
27962
+ capName: "addon-settings",
27963
+ capScope: "system",
27964
+ addonId: null,
27965
+ access: "view"
27966
+ },
27840
27967
  "addonSettings.updateDeviceSettings": {
27841
27968
  capName: "addon-settings",
27842
27969
  capScope: "system",
@@ -5940,6 +5940,40 @@ var BaseAddon = class {
5940
5940
  deviceSettingsSchema() {
5941
5941
  return null;
5942
5942
  }
5943
+ /**
5944
+ * INTEGRATION-LEVEL SETTINGS — declare which of this addon's global sections
5945
+ * ARE the configuration of its integration.
5946
+ *
5947
+ * Return the `ConfigSection.id`s, from {@link globalSettingsSchema}, that an
5948
+ * operator should find on the addon's integration page (System →
5949
+ * Integrations → <name>) rather than only in the cluster-wide list of every
5950
+ * addon. Empty (the default) means the addon has no integration-level
5951
+ * settings and no such surface is offered — this is opt-in, because whether
5952
+ * an addon's configuration IS its integration's configuration depends on the
5953
+ * nature of the integration.
5954
+ *
5955
+ * WHAT THIS IS NOT. It is not a scope. The selected sections keep living in
5956
+ * the ONE global schema, in the ONE addon store, written by the ONE
5957
+ * `updateGlobalSettings` path. There is deliberately no
5958
+ * `updateIntegrationSettings`: a second write path is how a surface acquires
5959
+ * a second store key, and this repo has shipped that twice (`btmPath@hub`,
5960
+ * D266). Selecting sections cannot introduce a key that selecting cannot.
5961
+ *
5962
+ * WHY IT IS A LIST OF SECTION IDS AND NOT A MARKER ON THE SECTION.
5963
+ * `ConfigFieldBase` used to carry `scope?: 'device' | 'global'` and it was
5964
+ * removed with the reason recorded at
5965
+ * `packages/types/src/interfaces/config-ui.ts:249` — *"a field's scope is
5966
+ * determined by WHICH schema it lives in, not by a field-level marker."* A
5967
+ * marker sprinkled across sections also has to borrow a field that already
5968
+ * means something else; borrowing `section.tab` put the literal word
5969
+ * "integration" into an operator-facing tab bar, because `tab` means "how to
5970
+ * GROUP this visually" and cannot also mean "where this lives" (D269
5971
+ * supersedes D268). One declaration, in one place, next to the schema whose
5972
+ * ids it names.
5973
+ */
5974
+ integrationSettingSections() {
5975
+ return [];
5976
+ }
5943
5977
  async getGlobalSettings(overlay, cap, nodeId) {
5944
5978
  const schema = this.globalSettingsSchema(cap);
5945
5979
  if (!schema) return { sections: [] };
@@ -5950,6 +5984,55 @@ var BaseAddon = class {
5950
5984
  } : projected);
5951
5985
  }
5952
5986
  /**
5987
+ * The integration-level view of this addon's settings: exactly the sections
5988
+ * named by {@link integrationSettingSections}, hydrated from the SAME store
5989
+ * `getGlobalSettings` reads, and narrowed to cluster-scoped fields.
5990
+ *
5991
+ * Returns `null` when the addon declared nothing — an addon that opts out has
5992
+ * no integration settings surface at all, rather than an empty one that reads
5993
+ * as a failed load.
5994
+ *
5995
+ * Three properties hold BY CONSTRUCTION, which is why they are here in core
5996
+ * and not in whichever UI happens to render this:
5997
+ *
5998
+ * 1. **One key.** The payload is a SUBSET of the global schema, so a field
5999
+ * shown here is the same field, with the same bare key, that the addon's
6000
+ * own page shows. There is no integration-specific writer — callers save
6001
+ * through `updateGlobalSettings` — so a second store key is unreachable,
6002
+ * not merely discouraged.
6003
+ * 2. **No node scope.** `perNode: true` fields are DROPPED. Their store key
6004
+ * is `<key>@<nodeId>` and an integration is not a node; whichever node
6005
+ * such a field silently picked would be a wrong answer for the operator
6006
+ * who opened the page (D266).
6007
+ * 3. **No silent typo.** A declared id that names no section throws. The
6008
+ * alternative — skip it — turns a rename into a surface that quietly
6009
+ * empties, which looks exactly like an addon with nothing to configure.
6010
+ */
6011
+ async getIntegrationSettings(nodeId) {
6012
+ const declared = this.integrationSettingSections();
6013
+ if (declared.length === 0) return null;
6014
+ const schema = this.globalSettingsSchema();
6015
+ if (!schema) throw new Error(`${this.constructor.name}: integrationSettingSections() names [${declared.join(", ")}] but globalSettingsSchema() returns null.`);
6016
+ const byId = new Map(schema.sections.map((section) => [section.id, section]));
6017
+ const sections = [];
6018
+ for (const id of declared) {
6019
+ const section = byId.get(id);
6020
+ if (!section) throw new Error(`${this.constructor.name}: integrationSettingSections() names unknown section "${id}". Known sections: [${[...byId.keys()].join(", ")}].`);
6021
+ const fields = dropPerNodeFields(section.fields);
6022
+ if (fields.length === 0) continue;
6023
+ sections.push({
6024
+ ...section,
6025
+ fields
6026
+ });
6027
+ }
6028
+ if (sections.length === 0) return null;
6029
+ const projected = await this.resolveGlobalStore(nodeId);
6030
+ return hydrateSchema({
6031
+ ...schema,
6032
+ sections
6033
+ }, projected);
6034
+ }
6035
+ /**
5953
6036
  * The raw addon store PROJECTED onto the target node's bare per-node keys:
5954
6037
  * every `perNode: true` field carries THAT node's scoped value on its bare
5955
6038
  * key (absent scoped key ⇒ key absent, so the schema `default` wins — no
@@ -6253,6 +6336,41 @@ var BaseAddon = class {
6253
6336
  * `hydrateSchema` does. Valueless structural fields (separator/info/…)
6254
6337
  * don't declare `perNode` and are excluded by the `in` narrowing.
6255
6338
  */
6339
+ /**
6340
+ * The same fields with every `perNode: true` one removed, recursing into layout
6341
+ * containers exactly as {@link collectPerNodeFieldKeys} does. A container left
6342
+ * with no child is dropped rather than rendered empty.
6343
+ *
6344
+ * Used by `getIntegrationSettings`: an integration is not a node, so a field
6345
+ * whose store key is `<key>@<nodeId>` has no node to belong to there.
6346
+ */
6347
+ function dropPerNodeFields(fields) {
6348
+ const kept = [];
6349
+ for (const field of fields) {
6350
+ if (field.type === "group") {
6351
+ const inner = dropPerNodeFields(field.fields);
6352
+ if (inner.length > 0) kept.push({
6353
+ ...field,
6354
+ fields: inner
6355
+ });
6356
+ continue;
6357
+ }
6358
+ if (field.type === "sub-tabs") {
6359
+ const tabs = field.tabs.map((tab) => ({
6360
+ ...tab,
6361
+ fields: dropPerNodeFields(tab.fields)
6362
+ })).filter((tab) => tab.fields.length > 0);
6363
+ if (tabs.length > 0) kept.push({
6364
+ ...field,
6365
+ tabs
6366
+ });
6367
+ continue;
6368
+ }
6369
+ if ("perNode" in field && field.perNode === true) continue;
6370
+ kept.push(field);
6371
+ }
6372
+ return kept;
6373
+ }
6256
6374
  function collectPerNodeFieldKeys(fields) {
6257
6375
  const collected = [];
6258
6376
  for (const field of fields) {
@@ -9406,6 +9524,9 @@ method(object({
9406
9524
  kind: "mutation",
9407
9525
  auth: "admin"
9408
9526
  }), method(object({
9527
+ addonId: string(),
9528
+ nodeId: string().optional()
9529
+ }), SettingsSchemaWithValuesSchema.nullable()), method(object({
9409
9530
  addonId: string(),
9410
9531
  deviceId: number(),
9411
9532
  nodeId: string().optional()
@@ -27860,6 +27981,12 @@ Object.freeze({
27860
27981
  addonId: null,
27861
27982
  access: "view"
27862
27983
  },
27984
+ "addonSettings.getIntegrationSettings": {
27985
+ capName: "addon-settings",
27986
+ capScope: "system",
27987
+ addonId: null,
27988
+ access: "view"
27989
+ },
27863
27990
  "addonSettings.updateDeviceSettings": {
27864
27991
  capName: "addon-settings",
27865
27992
  capScope: "system",
@@ -2,7 +2,7 @@ Object.defineProperties(exports, {
2
2
  __esModule: { value: true },
3
3
  [Symbol.toStringTag]: { value: "Module" }
4
4
  });
5
- const require_shared = require("./shared-CWzgutnW.js");
5
+ const require_shared = require("./shared-OO8jwvqy.js");
6
6
  let node_stream = require("node:stream");
7
7
  let webdav = require("webdav");
8
8
  //#region src/providers/webdav/webdav-config-schema.ts
@@ -1,4 +1,4 @@
1
- import { a as safeJoinRemotePath, c as BaseAddon, i as rearmIdleAbort, o as scheduleIdleAbort, r as getRequiredBasePath, s as storageProviderCapability, t as createSessionId } from "./shared-AzvwyoO3.mjs";
1
+ import { a as safeJoinRemotePath, c as BaseAddon, i as rearmIdleAbort, o as scheduleIdleAbort, r as getRequiredBasePath, s as storageProviderCapability, t as createSessionId } from "./shared-Bo03e3ba.mjs";
2
2
  import { PassThrough } from "node:stream";
3
3
  import { AuthType, createClient } from "webdav";
4
4
  //#region src/providers/webdav/webdav-config-schema.ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camstack/addon-remote-storage",
3
- "version": "1.2.35",
3
+ "version": "1.2.37",
4
4
  "description": "Remote storage providers (SFTP, S3, WebDAV) — unifies remote backends behind the storage-provider cap",
5
5
  "keywords": [
6
6
  "camstack",