@backstage/frontend-test-utils 0.1.11 → 0.1.12-next.2

package/dist/frontend-app-api/src/tree/readAppExtensionsConfig.esm.js

@@ -0,0 +1,106 @@
+const knownExtensionParameters = ["attachTo", "disabled", "config"];
+function readAppExtensionsConfig(rootConfig) {
+  const arr = rootConfig.getOptional("app.extensions");
+  if (!Array.isArray(arr)) {
+    if (arr === void 0) {
+      return [];
+    }
+    rootConfig.getConfigArray("app.extensions");
+    return [];
+  }
+  return arr.map(
+    (arrayEntry, arrayIndex) => expandShorthandExtensionParameters(arrayEntry, arrayIndex)
+  );
+}
+function expandShorthandExtensionParameters(arrayEntry, arrayIndex) {
+  function errorMsg(msg, key, prop) {
+    return `Invalid extension configuration at app.extensions[${arrayIndex}]${key ? `[${key}]` : ""}${prop ? `.${prop}` : ""}, ${msg}`;
+  }
+  function assertValidId(id2) {
+    if (!id2 || id2 !== id2.trim()) {
+      throw new Error(
+        errorMsg("extension ID must not be empty or contain whitespace")
+      );
+    }
+  }
+  if (typeof arrayEntry === "string") {
+    assertValidId(arrayEntry);
+    return {
+      id: arrayEntry,
+      disabled: false
+    };
+  }
+  if (typeof arrayEntry !== "object" || arrayEntry === null || Array.isArray(arrayEntry)) {
+    throw new Error(errorMsg("must be a string or an object"));
+  }
+  const keys = Object.keys(arrayEntry);
+  if (keys.length !== 1) {
+    const joinedKeys = keys.length ? `'${keys.join("', '")}'` : "none";
+    throw new Error(errorMsg(`must have exactly one key, got ${joinedKeys}`));
+  }
+  const id = String(keys[0]);
+  const value = arrayEntry[id];
+  assertValidId(id);
+  if (value === null) {
+    return {
+      id,
+      disabled: false
+    };
+  }
+  if (typeof value === "boolean") {
+    return {
+      id,
+      disabled: !value
+    };
+  }
+  if (typeof value !== "object" || Array.isArray(value)) {
+    throw new Error(errorMsg("value must be a boolean or object", id));
+  }
+  const attachTo = value.attachTo;
+  const disabled = value.disabled;
+  const config = value.config;
+  if (attachTo !== void 0) {
+    if (attachTo === null || typeof attachTo !== "object" || Array.isArray(attachTo)) {
+      throw new Error(errorMsg("must be an object", id, "attachTo"));
+    }
+    if (typeof attachTo.id !== "string" || attachTo.id === "") {
+      throw new Error(
+        errorMsg("must be a non-empty string", id, "attachTo.id")
+      );
+    }
+    if (typeof attachTo.input !== "string" || attachTo.input === "") {
+      throw new Error(
+        errorMsg("must be a non-empty string", id, "attachTo.input")
+      );
+    }
+  }
+  if (disabled !== void 0 && typeof disabled !== "boolean") {
+    throw new Error(errorMsg("must be a boolean", id, "disabled"));
+  }
+  if (config !== void 0 && (typeof config !== "object" || config === null || Array.isArray(config))) {
+    throw new Error(errorMsg("must be an object", id, "config"));
+  }
+  const unknownKeys = Object.keys(value).filter(
+    (k) => !knownExtensionParameters.includes(k)
+  );
+  if (unknownKeys.length > 0) {
+    throw new Error(
+      errorMsg(
+        `unknown parameter; expected one of '${knownExtensionParameters.join(
+          "', '"
+        )}'`,
+        id,
+        unknownKeys.join(", ")
+      )
+    );
+  }
+  return {
+    id,
+    attachTo,
+    disabled,
+    config
+  };
+}
+
+export { expandShorthandExtensionParameters, readAppExtensionsConfig };
+//# sourceMappingURL=readAppExtensionsConfig.esm.js.map

package/dist/frontend-app-api/src/tree/readAppExtensionsConfig.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readAppExtensionsConfig.esm.js","sources":["../../../../../frontend-app-api/src/tree/readAppExtensionsConfig.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { JsonValue } from '@backstage/types';\n\nexport interface ExtensionParameters {\n  id: string;\n  attachTo?: { id: string; input: string };\n  disabled?: boolean;\n  config?: unknown;\n}\n\nconst knownExtensionParameters = ['attachTo', 'disabled', 'config'];\n\n// Since we'll never merge arrays in config the config reader context\n// isn't too much of a help. Fall back to manual config reading logic\n// as the Config interface makes it quite hard for us otherwise.\n/** @internal */\nexport function readAppExtensionsConfig(\n  rootConfig: Config,\n): ExtensionParameters[] {\n  const arr = rootConfig.getOptional('app.extensions');\n  if (!Array.isArray(arr)) {\n    if (arr === undefined) {\n      return [];\n    }\n    // This will throw, and show which part of config had the wrong type\n    rootConfig.getConfigArray('app.extensions');\n    return [];\n  }\n\n  return arr.map((arrayEntry, arrayIndex) =>\n    expandShorthandExtensionParameters(arrayEntry, arrayIndex),\n  );\n}\n\n/** @internal */\nexport function expandShorthandExtensionParameters(\n  arrayEntry: JsonValue,\n  arrayIndex: number,\n): ExtensionParameters {\n  function errorMsg(msg: string, key?: string, prop?: string) {\n    return `Invalid extension configuration at app.extensions[${arrayIndex}]${\n      key ? `[${key}]` : ''\n    }${prop ? `.${prop}` : ''}, ${msg}`;\n  }\n\n  // NOTE(freben): This check is intentionally not complete and doesn't check\n  // whether letters and digits are used, etc. It's not up to the config reading\n  // logic to decide what constitutes a valid extension ID; that should be\n  // decided by the logic that loads and instantiates the extensions. This check\n  // is just here to catch real mistakes or truly conceptually wrong input.\n  function assertValidId(id: string) {\n    if (!id || id !== id.trim()) {\n      throw new Error(\n        errorMsg('extension ID must not be empty or contain whitespace'),\n      );\n    }\n  }\n\n  // Example YAML:\n  // - entity.card.about\n  if (typeof arrayEntry === 'string') {\n    assertValidId(arrayEntry);\n    return {\n      id: arrayEntry,\n      disabled: false,\n    };\n  }\n\n  // All remaining cases are single-key objects\n  if (\n    typeof arrayEntry !== 'object' ||\n    arrayEntry === null ||\n    Array.isArray(arrayEntry)\n  ) {\n    throw new Error(errorMsg('must be a string or an object'));\n  }\n  const keys = Object.keys(arrayEntry);\n  if (keys.length !== 1) {\n    const joinedKeys = keys.length ? `'${keys.join(\"', '\")}'` : 'none';\n    throw new Error(errorMsg(`must have exactly one key, got ${joinedKeys}`));\n  }\n\n  const id = String(keys[0]);\n  const value = arrayEntry[id];\n  assertValidId(id);\n\n  // This example covers a potentially common mistake in the syntax\n  // Example YAML:\n  // - entity.card.about:\n  if (value === null) {\n    return {\n      id,\n      disabled: false,\n    };\n  }\n\n  // Example YAML:\n  // - catalog.page.cicd: false\n  if (typeof value === 'boolean') {\n    return {\n      id,\n      disabled: !value,\n    };\n  }\n\n  // The remaining case is the generic object. Example YAML:\n  //  - tech-radar.page:\n  //      at: core.router/routes\n  //      disabled: false\n  //      config:\n  //        path: /tech-radar\n  //        width: 1500\n  //        height: 800\n  if (typeof value !== 'object' || Array.isArray(value)) {\n    // We don't mention null here - we don't want people to explicitly enter\n    // - entity.card.about: null\n    throw new Error(errorMsg('value must be a boolean or object', id));\n  }\n\n  const attachTo = value.attachTo as { id: string; input: string } | undefined;\n  const disabled = value.disabled;\n  const config = value.config;\n\n  if (attachTo !== undefined) {\n    if (\n      attachTo === null ||\n      typeof attachTo !== 'object' ||\n      Array.isArray(attachTo)\n    ) {\n      throw new Error(errorMsg('must be an object', id, 'attachTo'));\n    }\n    if (typeof attachTo.id !== 'string' || attachTo.id === '') {\n      throw new Error(\n        errorMsg('must be a non-empty string', id, 'attachTo.id'),\n      );\n    }\n    if (typeof attachTo.input !== 'string' || attachTo.input === '') {\n      throw new Error(\n        errorMsg('must be a non-empty string', id, 'attachTo.input'),\n      );\n    }\n  }\n  if (disabled !== undefined && typeof disabled !== 'boolean') {\n    throw new Error(errorMsg('must be a boolean', id, 'disabled'));\n  }\n  if (\n    config !== undefined &&\n    (typeof config !== 'object' || config === null || Array.isArray(config))\n  ) {\n    throw new Error(errorMsg('must be an object', id, 'config'));\n  }\n\n  const unknownKeys = Object.keys(value).filter(\n    k => !knownExtensionParameters.includes(k),\n  );\n  if (unknownKeys.length > 0) {\n    throw new Error(\n      errorMsg(\n        `unknown parameter; expected one of '${knownExtensionParameters.join(\n          \"', '\",\n        )}'`,\n        id,\n        unknownKeys.join(', '),\n      ),\n    );\n  }\n\n  return {\n    id,\n    attachTo,\n    disabled,\n    config,\n  };\n}\n"],"names":["id"],"mappings":"AA0BA,MAAM,wBAA2B,GAAA,CAAC,UAAY,EAAA,UAAA,EAAY,QAAQ,CAAA,CAAA;AAM3D,SAAS,wBACd,UACuB,EAAA;AACvB,EAAM,MAAA,GAAA,GAAM,UAAW,CAAA,WAAA,CAAY,gBAAgB,CAAA,CAAA;AACnD,EAAA,IAAI,CAAC,KAAA,CAAM,OAAQ,CAAA,GAAG,CAAG,EAAA;AACvB,IAAA,IAAI,QAAQ,KAAW,CAAA,EAAA;AACrB,MAAA,OAAO,EAAC,CAAA;AAAA,KACV;AAEA,IAAA,UAAA,CAAW,eAAe,gBAAgB,CAAA,CAAA;AAC1C,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAA,OAAO,GAAI,CAAA,GAAA;AAAA,IAAI,CAAC,UAAA,EAAY,UAC1B,KAAA,kCAAA,CAAmC,YAAY,UAAU,CAAA;AAAA,GAC3D,CAAA;AACF,CAAA;AAGgB,SAAA,kCAAA,CACd,YACA,UACqB,EAAA;AACrB,EAAS,SAAA,QAAA,CAAS,GAAa,EAAA,GAAA,EAAc,IAAe,EAAA;AAC1D,IAAA,OAAO,CAAqD,kDAAA,EAAA,UAAU,CACpE,CAAA,EAAA,GAAA,GAAM,IAAI,GAAG,CAAA,CAAA,CAAA,GAAM,EACrB,CAAA,EAAG,OAAO,CAAI,CAAA,EAAA,IAAI,CAAK,CAAA,GAAA,EAAE,KAAK,GAAG,CAAA,CAAA,CAAA;AAAA,GACnC;AAOA,EAAA,SAAS,cAAcA,GAAY,EAAA;AACjC,IAAA,IAAI,CAACA,GAAAA,IAAMA,GAAOA,KAAAA,GAAAA,CAAG,MAAQ,EAAA;AAC3B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,SAAS,sDAAsD,CAAA;AAAA,OACjE,CAAA;AAAA,KACF;AAAA,GACF;AAIA,EAAI,IAAA,OAAO,eAAe,QAAU,EAAA;AAClC,IAAA,aAAA,CAAc,UAAU,CAAA,CAAA;AACxB,IAAO,OAAA;AAAA,MACL,EAAI,EAAA,UAAA;AAAA,MACJ,QAAU,EAAA,KAAA;AAAA,KACZ,CAAA;AAAA,GACF;AAGA,EACE,IAAA,OAAO,eAAe,QACtB,IAAA,UAAA,KAAe,QACf,KAAM,CAAA,OAAA,CAAQ,UAAU,CACxB,EAAA;AACA,IAAA,MAAM,IAAI,KAAA,CAAM,QAAS,CAAA,+BAA+B,CAAC,CAAA,CAAA;AAAA,GAC3D;AACA,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AACnC,EAAI,IAAA,IAAA,CAAK,WAAW,CAAG,EAAA;AACrB,IAAM,MAAA,UAAA,GAAa,KAAK,MAAS,GAAA,CAAA,CAAA,EAAI,KAAK,IAAK,CAAA,MAAM,CAAC,CAAM,CAAA,CAAA,GAAA,MAAA,CAAA;AAC5D,IAAA,MAAM,IAAI,KAAM,CAAA,QAAA,CAAS,CAAkC,+BAAA,EAAA,UAAU,EAAE,CAAC,CAAA,CAAA;AAAA,GAC1E;AAEA,EAAA,MAAM,EAAK,GAAA,MAAA,CAAO,IAAK,CAAA,CAAC,CAAC,CAAA,CAAA;AACzB,EAAM,MAAA,KAAA,GAAQ,WAAW,EAAE,CAAA,CAAA;AAC3B,EAAA,aAAA,CAAc,EAAE,CAAA,CAAA;AAKhB,EAAA,IAAI,UAAU,IAAM,EAAA;AAClB,IAAO,OAAA;AAAA,MACL,EAAA;AAAA,MACA,QAAU,EAAA,KAAA;AAAA,KACZ,CAAA;AAAA,GACF;AAIA,EAAI,IAAA,OAAO,UAAU,SAAW,EAAA;AAC9B,IAAO,OAAA;AAAA,MACL,EAAA;AAAA,MACA,UAAU,CAAC,KAAA;AAAA,KACb,CAAA;AAAA,GACF;AAUA,EAAA,IAAI,OAAO,KAAU,KAAA,QAAA,IAAY,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAG,EAAA;AAGrD,IAAA,MAAM,IAAI,KAAA,CAAM,QAAS,CAAA,mCAAA,EAAqC,EAAE,CAAC,CAAA,CAAA;AAAA,GACnE;AAEA,EAAA,MAAM,WAAW,KAAM,CAAA,QAAA,CAAA;AACvB,EAAA,MAAM,WAAW,KAAM,CAAA,QAAA,CAAA;AACvB,EAAA,MAAM,SAAS,KAAM,CAAA,MAAA,CAAA;AAErB,EAAA,IAAI,aAAa,KAAW,CAAA,EAAA;AAC1B,IACE,IAAA,QAAA,KAAa,QACb,OAAO,QAAA,KAAa,YACpB,KAAM,CAAA,OAAA,CAAQ,QAAQ,CACtB,EAAA;AACA,MAAA,MAAM,IAAI,KAAM,CAAA,QAAA,CAAS,mBAAqB,EAAA,EAAA,EAAI,UAAU,CAAC,CAAA,CAAA;AAAA,KAC/D;AACA,IAAA,IAAI,OAAO,QAAS,CAAA,EAAA,KAAO,QAAY,IAAA,QAAA,CAAS,OAAO,EAAI,EAAA;AACzD,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,QAAA,CAAS,4BAA8B,EAAA,EAAA,EAAI,aAAa,CAAA;AAAA,OAC1D,CAAA;AAAA,KACF;AACA,IAAA,IAAI,OAAO,QAAS,CAAA,KAAA,KAAU,QAAY,IAAA,QAAA,CAAS,UAAU,EAAI,EAAA;AAC/D,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,QAAA,CAAS,4BAA8B,EAAA,EAAA,EAAI,gBAAgB,CAAA;AAAA,OAC7D,CAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,IAAI,QAAa,KAAA,KAAA,CAAA,IAAa,OAAO,QAAA,KAAa,SAAW,EAAA;AAC3D,IAAA,MAAM,IAAI,KAAM,CAAA,QAAA,CAAS,mBAAqB,EAAA,EAAA,EAAI,UAAU,CAAC,CAAA,CAAA;AAAA,GAC/D;AACA,EACE,IAAA,MAAA,KAAW,KACV,CAAA,KAAA,OAAO,MAAW,KAAA,QAAA,IAAY,WAAW,IAAQ,IAAA,KAAA,CAAM,OAAQ,CAAA,MAAM,CACtE,CAAA,EAAA;AACA,IAAA,MAAM,IAAI,KAAM,CAAA,QAAA,CAAS,mBAAqB,EAAA,EAAA,EAAI,QAAQ,CAAC,CAAA,CAAA;AAAA,GAC7D;AAEA,EAAA,MAAM,WAAc,GAAA,MAAA,CAAO,IAAK,CAAA,KAAK,CAAE,CAAA,MAAA;AAAA,IACrC,CAAK,CAAA,KAAA,CAAC,wBAAyB,CAAA,QAAA,CAAS,CAAC,CAAA;AAAA,GAC3C,CAAA;AACA,EAAI,IAAA,WAAA,CAAY,SAAS,CAAG,EAAA;AAC1B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,QAAA;AAAA,QACE,uCAAuC,wBAAyB,CAAA,IAAA;AAAA,UAC9D,MAAA;AAAA,SACD,CAAA,CAAA,CAAA;AAAA,QACD,EAAA;AAAA,QACA,WAAA,CAAY,KAAK,IAAI,CAAA;AAAA,OACvB;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,IACA,MAAA;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/frontend-app-api/src/tree/resolveAppNodeSpecs.esm.js

@@ -0,0 +1,166 @@
+import { toInternalExtensionOverrides } from '../../../frontend-plugin-api/src/wiring/createExtensionOverrides.esm.js';
+import { toInternalBackstagePlugin } from '../../../frontend-plugin-api/src/wiring/createPlugin.esm.js';
+import { toInternalExtension } from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition.esm.js';
+
+function resolveAppNodeSpecs(options) {
+  const {
+    builtinExtensions = [],
+    parameters = [],
+    forbidden = /* @__PURE__ */ new Set(),
+    features = []
+  } = options;
+  const plugins = features.filter(
+    (f) => f.$$type === "@backstage/BackstagePlugin"
+  );
+  const overrides = features.filter(
+    (f) => f.$$type === "@backstage/ExtensionOverrides"
+  );
+  const pluginExtensions = plugins.flatMap((source) => {
+    return toInternalBackstagePlugin(source).extensions.map((extension) => ({
+      ...extension,
+      source
+    }));
+  });
+  const overrideExtensions = overrides.flatMap(
+    (override) => toInternalExtensionOverrides(override).extensions
+  );
+  if (pluginExtensions.some(({ id }) => forbidden.has(id))) {
+    const pluginsStr = pluginExtensions.filter(({ id }) => forbidden.has(id)).map(({ source }) => `'${source.id}'`).join(", ");
+    const forbiddenStr = [...forbidden].map((id) => `'${id}'`).join(", ");
+    throw new Error(
+      `It is forbidden to override the following extension(s): ${forbiddenStr}, which is done by the following plugin(s): ${pluginsStr}`
+    );
+  }
+  if (overrideExtensions.some(({ id }) => forbidden.has(id))) {
+    const forbiddenStr = [...forbidden].map((id) => `'${id}'`).join(", ");
+    throw new Error(
+      `It is forbidden to override the following extension(s): ${forbiddenStr}, which is done by one or more extension overrides`
+    );
+  }
+  const overrideExtensionIds = overrideExtensions.map(({ id }) => id);
+  if (overrideExtensionIds.length !== new Set(overrideExtensionIds).size) {
+    const counts = /* @__PURE__ */ new Map();
+    for (const id of overrideExtensionIds) {
+      counts.set(id, (counts.get(id) ?? 0) + 1);
+    }
+    const duplicated = Array.from(counts.entries()).filter(([, count]) => count > 1).map(([id]) => id);
+    throw new Error(
+      `The following extensions had duplicate overrides: ${duplicated.join(
+        ", "
+      )}`
+    );
+  }
+  const configuredExtensions = [
+    ...pluginExtensions.map(({ source, ...extension }) => {
+      const internalExtension = toInternalExtension(extension);
+      return {
+        extension: internalExtension,
+        params: {
+          source,
+          attachTo: internalExtension.attachTo,
+          disabled: internalExtension.disabled,
+          config: void 0
+        }
+      };
+    }),
+    ...builtinExtensions.map((extension) => {
+      const internalExtension = toInternalExtension(extension);
+      return {
+        extension: internalExtension,
+        params: {
+          source: void 0,
+          attachTo: internalExtension.attachTo,
+          disabled: internalExtension.disabled,
+          config: void 0
+        }
+      };
+    })
+  ];
+  for (const extension of overrideExtensions) {
+    const internalExtension = toInternalExtension(extension);
+    const index = configuredExtensions.findIndex(
+      (e) => e.extension.id === extension.id
+    );
+    if (index !== -1) {
+      configuredExtensions[index].extension = internalExtension;
+      configuredExtensions[index].params.attachTo = internalExtension.attachTo;
+      configuredExtensions[index].params.disabled = internalExtension.disabled;
+    } else {
+      configuredExtensions.push({
+        extension: internalExtension,
+        params: {
+          source: void 0,
+          attachTo: internalExtension.attachTo,
+          disabled: internalExtension.disabled,
+          config: void 0
+        }
+      });
+    }
+  }
+  const duplicatedExtensionIds = /* @__PURE__ */ new Set();
+  const duplicatedExtensionData = configuredExtensions.reduce((data, { extension, params }) => {
+    const extensionId = extension.id;
+    const extensionData = data?.[extensionId];
+    if (extensionData) duplicatedExtensionIds.add(extensionId);
+    const pluginId = params.source?.id ?? "internal";
+    const pluginCount = extensionData?.[pluginId] ?? 0;
+    return {
+      ...data,
+      [extensionId]: { ...extensionData, [pluginId]: pluginCount + 1 }
+    };
+  }, {});
+  if (duplicatedExtensionIds.size > 0) {
+    throw new Error(
+      `The following extensions are duplicated: ${Array.from(
+        duplicatedExtensionIds
+      ).map(
+        (extensionId) => `The extension '${extensionId}' was provided ${Object.keys(
+          duplicatedExtensionData[extensionId]
+        ).map(
+          (pluginId) => `${duplicatedExtensionData[extensionId][pluginId]} time(s) by the plugin '${pluginId}'`
+        ).join(" and ")}`
+      ).join(", ")}`
+    );
+  }
+  const order = /* @__PURE__ */ new Map();
+  for (const overrideParam of parameters) {
+    const extensionId = overrideParam.id;
+    if (forbidden.has(extensionId)) {
+      throw new Error(
+        `Configuration of the '${extensionId}' extension is forbidden`
+      );
+    }
+    const existing = configuredExtensions.find(
+      (e) => e.extension.id === extensionId
+    );
+    if (existing) {
+      if (overrideParam.attachTo) {
+        existing.params.attachTo = overrideParam.attachTo;
+      }
+      if (overrideParam.config) {
+        existing.params.config = overrideParam.config;
+      }
+      if (Boolean(existing.params.disabled) !== Boolean(overrideParam.disabled)) {
+        existing.params.disabled = Boolean(overrideParam.disabled);
+      }
+      order.set(extensionId, existing);
+    } else {
+      throw new Error(`Extension ${extensionId} does not exist`);
+    }
+  }
+  const orderedExtensions = [
+    ...order.values(),
+    ...configuredExtensions.filter((e) => !order.has(e.extension.id))
+  ];
+  return orderedExtensions.map((param) => ({
+    id: param.extension.id,
+    attachTo: param.params.attachTo,
+    extension: param.extension,
+    disabled: param.params.disabled,
+    source: param.params.source,
+    config: param.params.config
+  }));
+}
+
+export { resolveAppNodeSpecs };
+//# sourceMappingURL=resolveAppNodeSpecs.esm.js.map

package/dist/frontend-app-api/src/tree/resolveAppNodeSpecs.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveAppNodeSpecs.esm.js","sources":["../../../../../frontend-app-api/src/tree/resolveAppNodeSpecs.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  BackstagePlugin,\n  Extension,\n  ExtensionOverrides,\n  FrontendFeature,\n} from '@backstage/frontend-plugin-api';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExtensionOverrides } from '../../../frontend-plugin-api/src/wiring/createExtensionOverrides';\nimport { ExtensionParameters } from './readAppExtensionsConfig';\nimport { AppNodeSpec } from '@backstage/frontend-plugin-api';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalBackstagePlugin } from '../../../frontend-plugin-api/src/wiring/createPlugin';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExtension } from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition';\n\n/** @internal */\nexport function resolveAppNodeSpecs(options: {\n  features?: FrontendFeature[];\n  builtinExtensions?: Extension<unknown>[];\n  parameters?: Array<ExtensionParameters>;\n  forbidden?: Set<string>;\n}): AppNodeSpec[] {\n  const {\n    builtinExtensions = [],\n    parameters = [],\n    forbidden = new Set(),\n    features = [],\n  } = options;\n\n  const plugins = features.filter(\n    (f): f is BackstagePlugin => f.$$type === '@backstage/BackstagePlugin',\n  );\n  const overrides = features.filter(\n    (f): f is ExtensionOverrides =>\n      f.$$type === '@backstage/ExtensionOverrides',\n  );\n\n  const pluginExtensions = plugins.flatMap(source => {\n    return toInternalBackstagePlugin(source).extensions.map(extension => ({\n      ...extension,\n      source,\n    }));\n  });\n  const overrideExtensions = overrides.flatMap(\n    override => toInternalExtensionOverrides(override).extensions,\n  );\n\n  // Prevent core override\n  if (pluginExtensions.some(({ id }) => forbidden.has(id))) {\n    const pluginsStr = pluginExtensions\n      .filter(({ id }) => forbidden.has(id))\n      .map(({ source }) => `'${source.id}'`)\n      .join(', ');\n    const forbiddenStr = [...forbidden].map(id => `'${id}'`).join(', ');\n    throw new Error(\n      `It is forbidden to override the following extension(s): ${forbiddenStr}, which is done by the following plugin(s): ${pluginsStr}`,\n    );\n  }\n\n  if (overrideExtensions.some(({ id }) => forbidden.has(id))) {\n    const forbiddenStr = [...forbidden].map(id => `'${id}'`).join(', ');\n    throw new Error(\n      `It is forbidden to override the following extension(s): ${forbiddenStr}, which is done by one or more extension overrides`,\n    );\n  }\n  const overrideExtensionIds = overrideExtensions.map(({ id }) => id);\n  if (overrideExtensionIds.length !== new Set(overrideExtensionIds).size) {\n    const counts = new Map<string, number>();\n    for (const id of overrideExtensionIds) {\n      counts.set(id, (counts.get(id) ?? 0) + 1);\n    }\n    const duplicated = Array.from(counts.entries())\n      .filter(([, count]) => count > 1)\n      .map(([id]) => id);\n    throw new Error(\n      `The following extensions had duplicate overrides: ${duplicated.join(\n        ', ',\n      )}`,\n    );\n  }\n\n  const configuredExtensions = [\n    ...pluginExtensions.map(({ source, ...extension }) => {\n      const internalExtension = toInternalExtension(extension);\n      return {\n        extension: internalExtension,\n        params: {\n          source,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined as unknown,\n        },\n      };\n    }),\n    ...builtinExtensions.map(extension => {\n      const internalExtension = toInternalExtension(extension);\n      return {\n        extension: internalExtension,\n        params: {\n          source: undefined,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined as unknown,\n        },\n      };\n    }),\n  ];\n\n  // Install all extension overrides\n  for (const extension of overrideExtensions) {\n    const internalExtension = toInternalExtension(extension);\n\n    // Check if our override is overriding an extension that already exists\n    const index = configuredExtensions.findIndex(\n      e => e.extension.id === extension.id,\n    );\n    if (index !== -1) {\n      // Only implementation, attachment point and default disabled status are overridden, the source is kept\n      configuredExtensions[index].extension = internalExtension;\n      configuredExtensions[index].params.attachTo = internalExtension.attachTo;\n      configuredExtensions[index].params.disabled = internalExtension.disabled;\n    } else {\n      // Add the extension as a new one when not overriding an existing one\n      configuredExtensions.push({\n        extension: internalExtension,\n        params: {\n          source: undefined,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined,\n        },\n      });\n    }\n  }\n\n  const duplicatedExtensionIds = new Set<string>();\n  const duplicatedExtensionData = configuredExtensions.reduce<\n    Record<string, Record<string, number>>\n  >((data, { extension, params }) => {\n    const extensionId = extension.id;\n    const extensionData = data?.[extensionId];\n    if (extensionData) duplicatedExtensionIds.add(extensionId);\n    const pluginId = params.source?.id ?? 'internal';\n    const pluginCount = extensionData?.[pluginId] ?? 0;\n    return {\n      ...data,\n      [extensionId]: { ...extensionData, [pluginId]: pluginCount + 1 },\n    };\n  }, {});\n\n  if (duplicatedExtensionIds.size > 0) {\n    throw new Error(\n      `The following extensions are duplicated: ${Array.from(\n        duplicatedExtensionIds,\n      )\n        .map(\n          extensionId =>\n            `The extension '${extensionId}' was provided ${Object.keys(\n              duplicatedExtensionData[extensionId],\n            )\n              .map(\n                pluginId =>\n                  `${duplicatedExtensionData[extensionId][pluginId]} time(s) by the plugin '${pluginId}'`,\n              )\n              .join(' and ')}`,\n        )\n        .join(', ')}`,\n    );\n  }\n\n  const order = new Map<string, (typeof configuredExtensions)[number]>();\n  for (const overrideParam of parameters) {\n    const extensionId = overrideParam.id;\n\n    if (forbidden.has(extensionId)) {\n      throw new Error(\n        `Configuration of the '${extensionId}' extension is forbidden`,\n      );\n    }\n\n    const existing = configuredExtensions.find(\n      e => e.extension.id === extensionId,\n    );\n    if (existing) {\n      if (overrideParam.attachTo) {\n        existing.params.attachTo = overrideParam.attachTo;\n      }\n      if (overrideParam.config) {\n        // TODO: merge config?\n        existing.params.config = overrideParam.config;\n      }\n      if (\n        Boolean(existing.params.disabled) !== Boolean(overrideParam.disabled)\n      ) {\n        existing.params.disabled = Boolean(overrideParam.disabled);\n      }\n      order.set(extensionId, existing);\n    } else {\n      throw new Error(`Extension ${extensionId} does not exist`);\n    }\n  }\n\n  const orderedExtensions = [\n    ...order.values(),\n    ...configuredExtensions.filter(e => !order.has(e.extension.id)),\n  ];\n\n  return orderedExtensions.map(param => ({\n    id: param.extension.id,\n    attachTo: param.params.attachTo,\n    extension: param.extension,\n    disabled: param.params.disabled,\n    source: param.params.source,\n    config: param.params.config,\n  }));\n}\n"],"names":[],"mappings":";;;;AAgCO,SAAS,oBAAoB,OAKlB,EAAA;AAChB,EAAM,MAAA;AAAA,IACJ,oBAAoB,EAAC;AAAA,IACrB,aAAa,EAAC;AAAA,IACd,SAAA,uBAAgB,GAAI,EAAA;AAAA,IACpB,WAAW,EAAC;AAAA,GACV,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,UAAU,QAAS,CAAA,MAAA;AAAA,IACvB,CAAC,CAA4B,KAAA,CAAA,CAAE,MAAW,KAAA,4BAAA;AAAA,GAC5C,CAAA;AACA,EAAA,MAAM,YAAY,QAAS,CAAA,MAAA;AAAA,IACzB,CAAC,CACC,KAAA,CAAA,CAAE,MAAW,KAAA,+BAAA;AAAA,GACjB,CAAA;AAEA,EAAM,MAAA,gBAAA,GAAmB,OAAQ,CAAA,OAAA,CAAQ,CAAU,MAAA,KAAA;AACjD,IAAA,OAAO,yBAA0B,CAAA,MAAM,CAAE,CAAA,UAAA,CAAW,IAAI,CAAc,SAAA,MAAA;AAAA,MACpE,GAAG,SAAA;AAAA,MACH,MAAA;AAAA,KACA,CAAA,CAAA,CAAA;AAAA,GACH,CAAA,CAAA;AACD,EAAA,MAAM,qBAAqB,SAAU,CAAA,OAAA;AAAA,IACnC,CAAA,QAAA,KAAY,4BAA6B,CAAA,QAAQ,CAAE,CAAA,UAAA;AAAA,GACrD,CAAA;AAGA,EAAI,IAAA,gBAAA,CAAiB,IAAK,CAAA,CAAC,EAAE,EAAA,OAAS,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,CAAG,EAAA;AACxD,IAAM,MAAA,UAAA,GAAa,iBAChB,MAAO,CAAA,CAAC,EAAE,EAAG,EAAA,KAAM,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,EACpC,GAAI,CAAA,CAAC,EAAE,MAAA,EAAa,KAAA,CAAA,CAAA,EAAI,OAAO,EAAE,CAAA,CAAA,CAAG,CACpC,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AACZ,IAAA,MAAM,YAAe,GAAA,CAAC,GAAG,SAAS,CAAE,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA,CAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAClE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wDAAA,EAA2D,YAAY,CAAA,4CAAA,EAA+C,UAAU,CAAA,CAAA;AAAA,KAClI,CAAA;AAAA,GACF;AAEA,EAAI,IAAA,kBAAA,CAAmB,IAAK,CAAA,CAAC,EAAE,EAAA,OAAS,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,CAAG,EAAA;AAC1D,IAAA,MAAM,YAAe,GAAA,CAAC,GAAG,SAAS,CAAE,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA,CAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAClE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,2DAA2D,YAAY,CAAA,kDAAA,CAAA;AAAA,KACzE,CAAA;AAAA,GACF;AACA,EAAA,MAAM,uBAAuB,kBAAmB,CAAA,GAAA,CAAI,CAAC,EAAE,EAAA,OAAS,EAAE,CAAA,CAAA;AAClE,EAAA,IAAI,qBAAqB,MAAW,KAAA,IAAI,GAAI,CAAA,oBAAoB,EAAE,IAAM,EAAA;AACtE,IAAM,MAAA,MAAA,uBAAa,GAAoB,EAAA,CAAA;AACvC,IAAA,KAAA,MAAW,MAAM,oBAAsB,EAAA;AACrC,MAAA,MAAA,CAAO,IAAI,EAAK,EAAA,CAAA,MAAA,CAAO,IAAI,EAAE,CAAA,IAAK,KAAK,CAAC,CAAA,CAAA;AAAA,KAC1C;AACA,IAAM,MAAA,UAAA,GAAa,MAAM,IAAK,CAAA,MAAA,CAAO,SAAS,CAAA,CAC3C,OAAO,CAAC,GAAG,KAAK,CAAA,KAAM,QAAQ,CAAC,CAAA,CAC/B,IAAI,CAAC,CAAC,EAAE,CAAA,KAAM,EAAE,CAAA,CAAA;AACnB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,qDAAqD,UAAW,CAAA,IAAA;AAAA,QAC9D,IAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,oBAAuB,GAAA;AAAA,IAC3B,GAAG,iBAAiB,GAAI,CAAA,CAAC,EAAE,MAAQ,EAAA,GAAG,WAAgB,KAAA;AACpD,MAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AACvD,MAAO,OAAA;AAAA,QACL,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAA;AAAA,UACA,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACF,CAAA;AAAA,KACD,CAAA;AAAA,IACD,GAAG,iBAAkB,CAAA,GAAA,CAAI,CAAa,SAAA,KAAA;AACpC,MAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AACvD,MAAO,OAAA;AAAA,QACL,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAQ,EAAA,KAAA,CAAA;AAAA,UACR,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACF,CAAA;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AAGA,EAAA,KAAA,MAAW,aAAa,kBAAoB,EAAA;AAC1C,IAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AAGvD,IAAA,MAAM,QAAQ,oBAAqB,CAAA,SAAA;AAAA,MACjC,CAAK,CAAA,KAAA,CAAA,CAAE,SAAU,CAAA,EAAA,KAAO,SAAU,CAAA,EAAA;AAAA,KACpC,CAAA;AACA,IAAA,IAAI,UAAU,CAAI,CAAA,EAAA;AAEhB,MAAqB,oBAAA,CAAA,KAAK,EAAE,SAAY,GAAA,iBAAA,CAAA;AACxC,MAAA,oBAAA,CAAqB,KAAK,CAAA,CAAE,MAAO,CAAA,QAAA,GAAW,iBAAkB,CAAA,QAAA,CAAA;AAChE,MAAA,oBAAA,CAAqB,KAAK,CAAA,CAAE,MAAO,CAAA,QAAA,GAAW,iBAAkB,CAAA,QAAA,CAAA;AAAA,KAC3D,MAAA;AAEL,MAAA,oBAAA,CAAqB,IAAK,CAAA;AAAA,QACxB,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAQ,EAAA,KAAA,CAAA;AAAA,UACR,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF;AAEA,EAAM,MAAA,sBAAA,uBAA6B,GAAY,EAAA,CAAA;AAC/C,EAAM,MAAA,uBAAA,GAA0B,qBAAqB,MAEnD,CAAA,CAAC,MAAM,EAAE,SAAA,EAAW,QAAa,KAAA;AACjC,IAAA,MAAM,cAAc,SAAU,CAAA,EAAA,CAAA;AAC9B,IAAM,MAAA,aAAA,GAAgB,OAAO,WAAW,CAAA,CAAA;AACxC,IAAI,IAAA,aAAA,EAAsC,sBAAA,CAAA,GAAA,CAAI,WAAW,CAAA,CAAA;AACzD,IAAM,MAAA,QAAA,GAAW,MAAO,CAAA,MAAA,EAAQ,EAAM,IAAA,UAAA,CAAA;AACtC,IAAM,MAAA,WAAA,GAAc,aAAgB,GAAA,QAAQ,CAAK,IAAA,CAAA,CAAA;AACjD,IAAO,OAAA;AAAA,MACL,GAAG,IAAA;AAAA,MACH,CAAC,WAAW,GAAG,EAAE,GAAG,eAAe,CAAC,QAAQ,GAAG,WAAA,GAAc,CAAE,EAAA;AAAA,KACjE,CAAA;AAAA,GACF,EAAG,EAAE,CAAA,CAAA;AAEL,EAAI,IAAA,sBAAA,CAAuB,OAAO,CAAG,EAAA;AACnC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,4CAA4C,KAAM,CAAA,IAAA;AAAA,QAChD,sBAAA;AAAA,OAEC,CAAA,GAAA;AAAA,QACC,CACE,WAAA,KAAA,CAAA,eAAA,EAAkB,WAAW,CAAA,eAAA,EAAkB,MAAO,CAAA,IAAA;AAAA,UACpD,wBAAwB,WAAW,CAAA;AAAA,SAElC,CAAA,GAAA;AAAA,UACC,CAAA,QAAA,KACE,GAAG,uBAAwB,CAAA,WAAW,EAAE,QAAQ,CAAC,2BAA2B,QAAQ,CAAA,CAAA,CAAA;AAAA,SACxF,CACC,IAAK,CAAA,OAAO,CAAC,CAAA,CAAA;AAAA,OACpB,CACC,IAAK,CAAA,IAAI,CAAC,CAAA,CAAA;AAAA,KACf,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,KAAA,uBAAY,GAAmD,EAAA,CAAA;AACrE,EAAA,KAAA,MAAW,iBAAiB,UAAY,EAAA;AACtC,IAAA,MAAM,cAAc,aAAc,CAAA,EAAA,CAAA;AAElC,IAAI,IAAA,SAAA,CAAU,GAAI,CAAA,WAAW,CAAG,EAAA;AAC9B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,yBAAyB,WAAW,CAAA,wBAAA,CAAA;AAAA,OACtC,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,WAAW,oBAAqB,CAAA,IAAA;AAAA,MACpC,CAAA,CAAA,KAAK,CAAE,CAAA,SAAA,CAAU,EAAO,KAAA,WAAA;AAAA,KAC1B,CAAA;AACA,IAAA,IAAI,QAAU,EAAA;AACZ,MAAA,IAAI,cAAc,QAAU,EAAA;AAC1B,QAAS,QAAA,CAAA,MAAA,CAAO,WAAW,aAAc,CAAA,QAAA,CAAA;AAAA,OAC3C;AACA,MAAA,IAAI,cAAc,MAAQ,EAAA;AAExB,QAAS,QAAA,CAAA,MAAA,CAAO,SAAS,aAAc,CAAA,MAAA,CAAA;AAAA,OACzC;AACA,MACE,IAAA,OAAA,CAAQ,SAAS,MAAO,CAAA,QAAQ,MAAM,OAAQ,CAAA,aAAA,CAAc,QAAQ,CACpE,EAAA;AACA,QAAA,QAAA,CAAS,MAAO,CAAA,QAAA,GAAW,OAAQ,CAAA,aAAA,CAAc,QAAQ,CAAA,CAAA;AAAA,OAC3D;AACA,MAAM,KAAA,CAAA,GAAA,CAAI,aAAa,QAAQ,CAAA,CAAA;AAAA,KAC1B,MAAA;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAa,UAAA,EAAA,WAAW,CAAiB,eAAA,CAAA,CAAA,CAAA;AAAA,KAC3D;AAAA,GACF;AAEA,EAAA,MAAM,iBAAoB,GAAA;AAAA,IACxB,GAAG,MAAM,MAAO,EAAA;AAAA,IAChB,GAAG,oBAAqB,CAAA,MAAA,CAAO,CAAK,CAAA,KAAA,CAAC,MAAM,GAAI,CAAA,CAAA,CAAE,SAAU,CAAA,EAAE,CAAC,CAAA;AAAA,GAChE,CAAA;AAEA,EAAO,OAAA,iBAAA,CAAkB,IAAI,CAAU,KAAA,MAAA;AAAA,IACrC,EAAA,EAAI,MAAM,SAAU,CAAA,EAAA;AAAA,IACpB,QAAA,EAAU,MAAM,MAAO,CAAA,QAAA;AAAA,IACvB,WAAW,KAAM,CAAA,SAAA;AAAA,IACjB,QAAA,EAAU,MAAM,MAAO,CAAA,QAAA;AAAA,IACvB,MAAA,EAAQ,MAAM,MAAO,CAAA,MAAA;AAAA,IACrB,MAAA,EAAQ,MAAM,MAAO,CAAA,MAAA;AAAA,GACrB,CAAA,CAAA,CAAA;AACJ;;;;"}

package/dist/frontend-app-api/src/tree/resolveAppTree.esm.js

@@ -0,0 +1,91 @@
+function indent(str) {
+  return str.replace(/^/gm, "  ");
+}
+class SerializableAppNode {
+  spec;
+  edges = {
+    attachedTo: void 0,
+    attachments: /* @__PURE__ */ new Map()
+  };
+  instance;
+  constructor(spec) {
+    this.spec = spec;
+  }
+  setParent(parent) {
+    const input = this.spec.attachTo.input;
+    this.edges.attachedTo = { node: parent, input };
+    const parentInputEdges = parent.edges.attachments.get(input);
+    if (parentInputEdges) {
+      parentInputEdges.push(this);
+    } else {
+      parent.edges.attachments.set(input, [this]);
+    }
+  }
+  toJSON() {
+    const dataRefs = this.instance && [...this.instance.getDataRefs()];
+    return {
+      id: this.spec.id,
+      output: dataRefs && dataRefs.length > 0 ? dataRefs.map((ref) => ref.id) : void 0,
+      attachments: this.edges.attachments.size > 0 ? Object.fromEntries(this.edges.attachments) : void 0
+    };
+  }
+  toString() {
+    const dataRefs = this.instance && [...this.instance.getDataRefs()];
+    const out = dataRefs && dataRefs.length > 0 ? ` out=[${[...dataRefs].map((r) => r.id).join(", ")}]` : "";
+    if (this.edges.attachments.size === 0) {
+      return `<${this.spec.id}${out} />`;
+    }
+    return [
+      `<${this.spec.id}${out}>`,
+      ...[...this.edges.attachments.entries()].map(
+        ([k, v]) => indent([`${k} [`, ...v.map((e) => indent(e.toString())), `]`].join("\n"))
+      ),
+      `</${this.spec.id}>`
+    ].join("\n");
+  }
+}
+function resolveAppTree(rootNodeId, specs) {
+  const nodes = /* @__PURE__ */ new Map();
+  let rootNode = void 0;
+  const orphansByParent = /* @__PURE__ */ new Map();
+  for (const spec of specs) {
+    if (nodes.has(spec.id)) {
+      throw new Error(`Unexpected duplicate extension id '${spec.id}'`);
+    }
+    const node = new SerializableAppNode(spec);
+    nodes.set(spec.id, node);
+    if (spec.id === rootNodeId) {
+      rootNode = node;
+    } else {
+      const parent = nodes.get(spec.attachTo.id);
+      if (parent) {
+        node.setParent(parent);
+      } else {
+        const orphanNodesForParent = orphansByParent.get(spec.attachTo.id);
+        if (orphanNodesForParent) {
+          orphanNodesForParent.push(node);
+        } else {
+          orphansByParent.set(spec.attachTo.id, [node]);
+        }
+      }
+    }
+    const orphanedChildren = orphansByParent.get(spec.id);
+    if (orphanedChildren) {
+      orphansByParent.delete(spec.id);
+      for (const orphan of orphanedChildren) {
+        orphan.setParent(node);
+      }
+    }
+  }
+  if (!rootNode) {
+    throw new Error(`No root node with id '${rootNodeId}' found in app tree`);
+  }
+  return {
+    root: rootNode,
+    nodes,
+    orphans: Array.from(orphansByParent.values()).flat()
+  };
+}
+
+export { resolveAppTree };
+//# sourceMappingURL=resolveAppTree.esm.js.map

package/dist/frontend-app-api/src/tree/resolveAppTree.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveAppTree.esm.js","sources":["../../../../../frontend-app-api/src/tree/resolveAppTree.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  AppTree,\n  AppNode,\n  AppNodeInstance,\n  AppNodeSpec,\n} from '@backstage/frontend-plugin-api';\n\nfunction indent(str: string) {\n  return str.replace(/^/gm, '  ');\n}\n\n/** @internal */\nclass SerializableAppNode implements AppNode {\n  public readonly spec: AppNodeSpec;\n  public readonly edges = {\n    attachedTo: undefined as { node: AppNode; input: string } | undefined,\n    attachments: new Map<string, SerializableAppNode[]>(),\n  };\n  public readonly instance?: AppNodeInstance;\n\n  constructor(spec: AppNodeSpec) {\n    this.spec = spec;\n  }\n\n  setParent(parent: SerializableAppNode) {\n    const input = this.spec.attachTo.input;\n\n    this.edges.attachedTo = { node: parent, input };\n\n    const parentInputEdges = parent.edges.attachments.get(input);\n    if (parentInputEdges) {\n      parentInputEdges.push(this);\n    } else {\n      parent.edges.attachments.set(input, [this]);\n    }\n  }\n\n  toJSON() {\n    const dataRefs = this.instance && [...this.instance.getDataRefs()];\n    return {\n      id: this.spec.id,\n      output:\n        dataRefs && dataRefs.length > 0\n          ? dataRefs.map(ref => ref.id)\n          : undefined,\n      attachments:\n        this.edges.attachments.size > 0\n          ? Object.fromEntries(this.edges.attachments)\n          : undefined,\n    };\n  }\n\n  toString(): string {\n    const dataRefs = this.instance && [...this.instance.getDataRefs()];\n    const out =\n      dataRefs && dataRefs.length > 0\n        ? ` out=[${[...dataRefs].map(r => r.id).join(', ')}]`\n        : '';\n\n    if (this.edges.attachments.size === 0) {\n      return `<${this.spec.id}${out} />`;\n    }\n\n    return [\n      `<${this.spec.id}${out}>`,\n      ...[...this.edges.attachments.entries()].map(([k, v]) =>\n        indent([`${k} [`, ...v.map(e => indent(e.toString())), `]`].join('\\n')),\n      ),\n      `</${this.spec.id}>`,\n    ].join('\\n');\n  }\n}\n\n/**\n * Build the app tree by iterating through all node specs and constructing the app\n * tree with all attachments in the same order as they appear in the input specs array.\n * @internal\n */\nexport function resolveAppTree(\n  rootNodeId: string,\n  specs: AppNodeSpec[],\n): AppTree {\n  const nodes = new Map<string, SerializableAppNode>();\n\n  // A node with the provided rootNodeId must be found in the tree, and it must not be attached to anything\n  let rootNode: AppNode | undefined = undefined;\n\n  // While iterating through the inputs specs we keep track of all nodes that were created\n  // before their parent, and attach them later when the parent is created.\n  // As we find the parents and attach the children, we remove them from this map. This means\n  // that after iterating through all input specs, this will be a map for each root node.\n  const orphansByParent = new Map<\n    string /* parentId */,\n    SerializableAppNode[]\n  >();\n\n  for (const spec of specs) {\n    // The main check with a more helpful error message happens in resolveAppNodeSpecs\n    if (nodes.has(spec.id)) {\n      throw new Error(`Unexpected duplicate extension id '${spec.id}'`);\n    }\n\n    const node = new SerializableAppNode(spec);\n    nodes.set(spec.id, node);\n\n    // TODO: For now we simply ignore the attachTo spec of the root node, but it'd be cleaner if we could avoid defining it\n    if (spec.id === rootNodeId) {\n      rootNode = node;\n    } else {\n      const parent = nodes.get(spec.attachTo.id);\n      if (parent) {\n        node.setParent(parent);\n      } else {\n        const orphanNodesForParent = orphansByParent.get(spec.attachTo.id);\n        if (orphanNodesForParent) {\n          orphanNodesForParent.push(node);\n        } else {\n          orphansByParent.set(spec.attachTo.id, [node]);\n        }\n      }\n    }\n\n    const orphanedChildren = orphansByParent.get(spec.id);\n    if (orphanedChildren) {\n      orphansByParent.delete(spec.id);\n      for (const orphan of orphanedChildren) {\n        orphan.setParent(node);\n      }\n    }\n  }\n\n  if (!rootNode) {\n    throw new Error(`No root node with id '${rootNodeId}' found in app tree`);\n  }\n\n  return {\n    root: rootNode,\n    nodes,\n    orphans: Array.from(orphansByParent.values()).flat(),\n  };\n}\n"],"names":[],"mappings":"AAuBA,SAAS,OAAO,GAAa,EAAA;AAC3B,EAAO,OAAA,GAAA,CAAI,OAAQ,CAAA,KAAA,EAAO,IAAI,CAAA,CAAA;AAChC,CAAA;AAGA,MAAM,mBAAuC,CAAA;AAAA,EAC3B,IAAA,CAAA;AAAA,EACA,KAAQ,GAAA;AAAA,IACtB,UAAY,EAAA,KAAA,CAAA;AAAA,IACZ,WAAA,sBAAiB,GAAmC,EAAA;AAAA,GACtD,CAAA;AAAA,EACgB,QAAA,CAAA;AAAA,EAEhB,YAAY,IAAmB,EAAA;AAC7B,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GACd;AAAA,EAEA,UAAU,MAA6B,EAAA;AACrC,IAAM,MAAA,KAAA,GAAQ,IAAK,CAAA,IAAA,CAAK,QAAS,CAAA,KAAA,CAAA;AAEjC,IAAA,IAAA,CAAK,KAAM,CAAA,UAAA,GAAa,EAAE,IAAA,EAAM,QAAQ,KAAM,EAAA,CAAA;AAE9C,IAAA,MAAM,gBAAmB,GAAA,MAAA,CAAO,KAAM,CAAA,WAAA,CAAY,IAAI,KAAK,CAAA,CAAA;AAC3D,IAAA,IAAI,gBAAkB,EAAA;AACpB,MAAA,gBAAA,CAAiB,KAAK,IAAI,CAAA,CAAA;AAAA,KACrB,MAAA;AACL,MAAA,MAAA,CAAO,MAAM,WAAY,CAAA,GAAA,CAAI,KAAO,EAAA,CAAC,IAAI,CAAC,CAAA,CAAA;AAAA,KAC5C;AAAA,GACF;AAAA,EAEA,MAAS,GAAA;AACP,IAAM,MAAA,QAAA,GAAW,KAAK,QAAY,IAAA,CAAC,GAAG,IAAK,CAAA,QAAA,CAAS,aAAa,CAAA,CAAA;AACjE,IAAO,OAAA;AAAA,MACL,EAAA,EAAI,KAAK,IAAK,CAAA,EAAA;AAAA,MACd,MAAA,EACE,QAAY,IAAA,QAAA,CAAS,MAAS,GAAA,CAAA,GAC1B,SAAS,GAAI,CAAA,CAAA,GAAA,KAAO,GAAI,CAAA,EAAE,CAC1B,GAAA,KAAA,CAAA;AAAA,MACN,WAAA,EACE,IAAK,CAAA,KAAA,CAAM,WAAY,CAAA,IAAA,GAAO,CAC1B,GAAA,MAAA,CAAO,WAAY,CAAA,IAAA,CAAK,KAAM,CAAA,WAAW,CACzC,GAAA,KAAA,CAAA;AAAA,KACR,CAAA;AAAA,GACF;AAAA,EAEA,QAAmB,GAAA;AACjB,IAAM,MAAA,QAAA,GAAW,KAAK,QAAY,IAAA,CAAC,GAAG,IAAK,CAAA,QAAA,CAAS,aAAa,CAAA,CAAA;AACjE,IAAA,MAAM,MACJ,QAAY,IAAA,QAAA,CAAS,SAAS,CAC1B,GAAA,CAAA,MAAA,EAAS,CAAC,GAAG,QAAQ,CAAE,CAAA,GAAA,CAAI,OAAK,CAAE,CAAA,EAAE,EAAE,IAAK,CAAA,IAAI,CAAC,CAChD,CAAA,CAAA,GAAA,EAAA,CAAA;AAEN,IAAA,IAAI,IAAK,CAAA,KAAA,CAAM,WAAY,CAAA,IAAA,KAAS,CAAG,EAAA;AACrC,MAAA,OAAO,CAAI,CAAA,EAAA,IAAA,CAAK,IAAK,CAAA,EAAE,GAAG,GAAG,CAAA,GAAA,CAAA,CAAA;AAAA,KAC/B;AAEA,IAAO,OAAA;AAAA,MACL,CAAI,CAAA,EAAA,IAAA,CAAK,IAAK,CAAA,EAAE,GAAG,GAAG,CAAA,CAAA,CAAA;AAAA,MACtB,GAAG,CAAC,GAAG,IAAA,CAAK,MAAM,WAAY,CAAA,OAAA,EAAS,CAAE,CAAA,GAAA;AAAA,QAAI,CAAC,CAAC,CAAA,EAAG,CAAC,CAAA,KACjD,OAAO,CAAC,CAAA,EAAG,CAAC,CAAA,EAAA,CAAA,EAAM,GAAG,CAAA,CAAE,IAAI,CAAK,CAAA,KAAA,MAAA,CAAO,CAAE,CAAA,QAAA,EAAU,CAAC,GAAG,CAAG,CAAA,CAAA,CAAA,CAAE,IAAK,CAAA,IAAI,CAAC,CAAA;AAAA,OACxE;AAAA,MACA,CAAA,EAAA,EAAK,IAAK,CAAA,IAAA,CAAK,EAAE,CAAA,CAAA,CAAA;AAAA,KACnB,CAAE,KAAK,IAAI,CAAA,CAAA;AAAA,GACb;AACF,CAAA;AAOgB,SAAA,cAAA,CACd,YACA,KACS,EAAA;AACT,EAAM,MAAA,KAAA,uBAAY,GAAiC,EAAA,CAAA;AAGnD,EAAA,IAAI,QAAgC,GAAA,KAAA,CAAA,CAAA;AAMpC,EAAM,MAAA,eAAA,uBAAsB,GAG1B,EAAA,CAAA;AAEF,EAAA,KAAA,MAAW,QAAQ,KAAO,EAAA;AAExB,IAAA,IAAI,KAAM,CAAA,GAAA,CAAI,IAAK,CAAA,EAAE,CAAG,EAAA;AACtB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAsC,mCAAA,EAAA,IAAA,CAAK,EAAE,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,KAClE;AAEA,IAAM,MAAA,IAAA,GAAO,IAAI,mBAAA,CAAoB,IAAI,CAAA,CAAA;AACzC,IAAM,KAAA,CAAA,GAAA,CAAI,IAAK,CAAA,EAAA,EAAI,IAAI,CAAA,CAAA;AAGvB,IAAI,IAAA,IAAA,CAAK,OAAO,UAAY,EAAA;AAC1B,MAAW,QAAA,GAAA,IAAA,CAAA;AAAA,KACN,MAAA;AACL,MAAA,MAAM,MAAS,GAAA,KAAA,CAAM,GAAI,CAAA,IAAA,CAAK,SAAS,EAAE,CAAA,CAAA;AACzC,MAAA,IAAI,MAAQ,EAAA;AACV,QAAA,IAAA,CAAK,UAAU,MAAM,CAAA,CAAA;AAAA,OAChB,MAAA;AACL,QAAA,MAAM,oBAAuB,GAAA,eAAA,CAAgB,GAAI,CAAA,IAAA,CAAK,SAAS,EAAE,CAAA,CAAA;AACjE,QAAA,IAAI,oBAAsB,EAAA;AACxB,UAAA,oBAAA,CAAqB,KAAK,IAAI,CAAA,CAAA;AAAA,SACzB,MAAA;AACL,UAAA,eAAA,CAAgB,IAAI,IAAK,CAAA,QAAA,CAAS,EAAI,EAAA,CAAC,IAAI,CAAC,CAAA,CAAA;AAAA,SAC9C;AAAA,OACF;AAAA,KACF;AAEA,IAAA,MAAM,gBAAmB,GAAA,eAAA,CAAgB,GAAI,CAAA,IAAA,CAAK,EAAE,CAAA,CAAA;AACpD,IAAA,IAAI,gBAAkB,EAAA;AACpB,MAAgB,eAAA,CAAA,MAAA,CAAO,KAAK,EAAE,CAAA,CAAA;AAC9B,MAAA,KAAA,MAAW,UAAU,gBAAkB,EAAA;AACrC,QAAA,MAAA,CAAO,UAAU,IAAI,CAAA,CAAA;AAAA,OACvB;AAAA,KACF;AAAA,GACF;AAEA,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAA,MAAM,IAAI,KAAA,CAAM,CAAyB,sBAAA,EAAA,UAAU,CAAqB,mBAAA,CAAA,CAAA,CAAA;AAAA,GAC1E;AAEA,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,QAAA;AAAA,IACN,KAAA;AAAA,IACA,SAAS,KAAM,CAAA,IAAA,CAAK,gBAAgB,MAAO,EAAC,EAAE,IAAK,EAAA;AAAA,GACrD,CAAA;AACF;;;;"}

package/dist/frontend-plugin-api/src/wiring/createExtension.esm.js

@@ -1,3 +1,6 @@
+import 'zod';
+import 'zod-to-json-schema';
+
 function toInternalExtensionDefinition(overrides) {
   const internal = overrides;
   if (internal.$$type !== "@backstage/ExtensionDefinition") {
@@ -5,9 +8,10 @@ function toInternalExtensionDefinition(overrides) {
       `Invalid extension definition instance, bad type '${internal.$$type}'`
     );
   }
-  if (internal.version !== "v1") {
+  const version = internal.version;
+  if (version !== "v1" && version !== "v2") {
     throw new Error(
-      `Invalid extension definition instance, bad version '${internal.version}'`
+      `Invalid extension definition instance, bad version '${version}'`
     );
   }
   return internal;

package/dist/frontend-plugin-api/src/wiring/createExtension.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"createExtension.esm.js","sources":["../../../../../frontend-plugin-api/src/wiring/createExtension.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { AppNode } from '../apis';\nimport { PortableSchema } from '../schema';\nimport { Expand } from '../types';\nimport { ExtensionDataRef } from './createExtensionDataRef';\nimport { ExtensionInput } from './createExtensionInput';\n\n/** @public */\nexport type AnyExtensionDataMap = {\n  [name in string]: ExtensionDataRef<unknown, { optional?: true }>;\n};\n\n/** @public */\nexport type AnyExtensionInputMap = {\n  [inputName in string]: ExtensionInput<\n    AnyExtensionDataMap,\n    { optional: boolean; singleton: boolean }\n  >;\n};\n\n/**\n * Converts an extension data map into the matching concrete data values type.\n * @public\n */\nexport type ExtensionDataValues<TExtensionData extends AnyExtensionDataMap> = {\n  [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends {\n    optional: true;\n  }\n    ? never\n    : DataName]: TExtensionData[DataName]['T'];\n} & {\n  [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends {\n    optional: true;\n  }\n    ? DataName\n    : never]?: TExtensionData[DataName]['T'];\n};\n\n/**\n * Convert a single extension input into a matching resolved input.\n * @public\n */\nexport type ResolvedExtensionInput<TExtensionData extends AnyExtensionDataMap> =\n  {\n    node: AppNode;\n    output: ExtensionDataValues<TExtensionData>;\n  };\n\n/**\n * Converts an extension input map into a matching collection of resolved inputs.\n * @public\n */\nexport type ResolvedExtensionInputs<\n  TInputs extends { [name in string]: ExtensionInput<any, any> },\n> = {\n  [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton']\n    ? Array<Expand<ResolvedExtensionInput<TInputs[InputName]['extensionData']>>>\n    : false extends TInputs[InputName]['config']['optional']\n    ? Expand<ResolvedExtensionInput<TInputs[InputName]['extensionData']>>\n    : Expand<\n        ResolvedExtensionInput<TInputs[InputName]['extensionData']> | undefined\n      >;\n};\n\n/** @public */\nexport interface CreateExtensionOptions<\n  TOutput extends AnyExtensionDataMap,\n  TInputs extends AnyExtensionInputMap,\n  TConfig,\n> {\n  kind?: string;\n  namespace?: string;\n  name?: string;\n  attachTo: { id: string; input: string };\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: TOutput;\n  configSchema?: PortableSchema<TConfig>;\n  factory(options: {\n    node: AppNode;\n    config: TConfig;\n    inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n  }): Expand<ExtensionDataValues<TOutput>>;\n}\n\n/** @public */\nexport interface ExtensionDefinition<TConfig> {\n  $$type: '@backstage/ExtensionDefinition';\n  readonly kind?: string;\n  readonly namespace?: string;\n  readonly name?: string;\n  readonly attachTo: { id: string; input: string };\n  readonly disabled: boolean;\n  readonly configSchema?: PortableSchema<TConfig>;\n}\n\n/** @internal */\nexport interface InternalExtensionDefinition<TConfig>\n  extends ExtensionDefinition<TConfig> {\n  readonly version: 'v1';\n  readonly inputs: AnyExtensionInputMap;\n  readonly output: AnyExtensionDataMap;\n  factory(options: {\n    node: AppNode;\n    config: TConfig;\n    inputs: ResolvedExtensionInputs<any>;\n  }): ExtensionDataValues<any>;\n}\n\n/** @internal */\nexport function toInternalExtensionDefinition<TConfig>(\n  overrides: ExtensionDefinition<TConfig>,\n): InternalExtensionDefinition<TConfig> {\n  const internal = overrides as InternalExtensionDefinition<TConfig>;\n  if (internal.$$type !== '@backstage/ExtensionDefinition') {\n    throw new Error(\n      `Invalid extension definition instance, bad type '${internal.$$type}'`,\n    );\n  }\n  if (internal.version !== 'v1') {\n    throw new Error(\n      `Invalid extension definition instance, bad version '${internal.version}'`,\n    );\n  }\n  return internal;\n}\n\n/** @public */\nexport function createExtension<\n  TOutput extends AnyExtensionDataMap,\n  TInputs extends AnyExtensionInputMap,\n  TConfig = never,\n>(\n  options: CreateExtensionOptions<TOutput, TInputs, TConfig>,\n): ExtensionDefinition<TConfig> {\n  return {\n    $$type: '@backstage/ExtensionDefinition',\n    version: 'v1',\n    kind: options.kind,\n    namespace: options.namespace,\n    name: options.name,\n    attachTo: options.attachTo,\n    disabled: options.disabled ?? false,\n    inputs: options.inputs ?? {},\n    output: options.output,\n    configSchema: options.configSchema,\n    factory({ inputs, ...rest }) {\n      // TODO: Simplify this, but TS wouldn't infer the input type for some reason\n      return options.factory({\n        inputs: inputs as Expand<ResolvedExtensionInputs<TInputs>>,\n        ...rest,\n      });\n    },\n    toString() {\n      const parts: string[] = [];\n      if (options.kind) {\n        parts.push(`kind=${options.kind}`);\n      }\n      if (options.namespace) {\n        parts.push(`namespace=${options.namespace}`);\n      }\n      if (options.name) {\n        parts.push(`name=${options.name}`);\n      }\n      parts.push(`attachTo=${options.attachTo.id}@${options.attachTo.input}`);\n      return `ExtensionDefinition{${parts.join(',')}}`;\n    },\n  } as InternalExtensionDefinition<TConfig>;\n}\n"],"names":[],"mappings":"AA6HO,SAAS,8BACd,SACsC,EAAA;AACtC,EAAA,MAAM,QAAW,GAAA,SAAA,CAAA;AACjB,EAAI,IAAA,QAAA,CAAS,WAAW,gCAAkC,EAAA;AACxD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,iDAAA,EAAoD,SAAS,MAAM,CAAA,CAAA,CAAA;AAAA,KACrE,CAAA;AAAA,GACF;AACA,EAAI,IAAA,QAAA,CAAS,YAAY,IAAM,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,oDAAA,EAAuD,SAAS,OAAO,CAAA,CAAA,CAAA;AAAA,KACzE,CAAA;AAAA,GACF;AACA,EAAO,OAAA,QAAA,CAAA;AACT;;;;"}
+{"version":3,"file":"createExtension.esm.js","sources":["../../../../../frontend-plugin-api/src/wiring/createExtension.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { AppNode } from '../apis';\nimport { PortableSchema, createSchemaFromZod } from '../schema';\nimport { Expand } from '../types';\nimport {\n  AnyExtensionDataRef,\n  ExtensionDataRef,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { ExtensionInput, LegacyExtensionInput } from './createExtensionInput';\nimport { z } from 'zod';\n\n/**\n * @public\n * @deprecated Extension data maps will be removed.\n */\nexport type AnyExtensionDataMap = {\n  [name in string]: AnyExtensionDataRef;\n};\n\n/**\n * @public\n * @deprecated This type will be removed.\n */\nexport type AnyExtensionInputMap = {\n  [inputName in string]: LegacyExtensionInput<\n    AnyExtensionDataMap,\n    { optional: boolean; singleton: boolean }\n  >;\n};\n\n/**\n * Converts an extension data map into the matching concrete data values type.\n * @public\n * @deprecated Extension data maps will be removed.\n */\nexport type ExtensionDataValues<TExtensionData extends AnyExtensionDataMap> = {\n  [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends {\n    optional: true;\n  }\n    ? never\n    : DataName]: TExtensionData[DataName]['T'];\n} & {\n  [DataName in keyof TExtensionData as TExtensionData[DataName]['config'] extends {\n    optional: true;\n  }\n    ? DataName\n    : never]?: TExtensionData[DataName]['T'];\n};\n\n/** @public */\nexport type ExtensionDataContainer<UExtensionData extends AnyExtensionDataRef> =\n  {\n    get<TId extends UExtensionData['id']>(\n      ref: ExtensionDataRef<any, TId, any>,\n    ): UExtensionData extends ExtensionDataRef<infer IData, TId, infer IConfig>\n      ? IConfig['optional'] extends true\n        ? IData | undefined\n        : IData\n      : never;\n  };\n\n/**\n * Convert a single extension input into a matching resolved input.\n * @public\n */\nexport type ResolvedExtensionInput<\n  TExtensionInput extends ExtensionInput<any, any>,\n> = TExtensionInput['extensionData'] extends Array<AnyExtensionDataRef>\n  ? {\n      node: AppNode;\n    } & ExtensionDataContainer<TExtensionInput['extensionData'][number]>\n  : TExtensionInput['extensionData'] extends AnyExtensionDataMap\n  ? {\n      node: AppNode;\n      output: ExtensionDataValues<TExtensionInput['extensionData']>;\n    }\n  : never;\n\n/**\n * Converts an extension input map into a matching collection of resolved inputs.\n * @public\n */\nexport type ResolvedExtensionInputs<\n  TInputs extends {\n    [name in string]: ExtensionInput<any, any> | LegacyExtensionInput<any, any>;\n  },\n> = {\n  [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton']\n    ? Array<Expand<ResolvedExtensionInput<TInputs[InputName]>>>\n    : false extends TInputs[InputName]['config']['optional']\n    ? Expand<ResolvedExtensionInput<TInputs[InputName]>>\n    : Expand<ResolvedExtensionInput<TInputs[InputName]> | undefined>;\n};\n\n/**\n * @public\n * @deprecated This way of structuring the options is deprecated, this type will be removed in the future\n */\nexport interface LegacyCreateExtensionOptions<\n  TOutput extends AnyExtensionDataMap,\n  TInputs extends AnyExtensionInputMap,\n  TConfig,\n  TConfigInput,\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n> {\n  kind?: string;\n  namespace?: string;\n  name?: string;\n  attachTo: { id: string; input: string };\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: TOutput;\n  /** @deprecated - use `config.schema` instead */\n  configSchema?: PortableSchema<TConfig, TConfigInput>;\n  config?: {\n    schema: TConfigSchema;\n  };\n  factory(context: {\n    node: AppNode;\n    config: TConfig &\n      (string extends keyof TConfigSchema\n        ? {}\n        : {\n            [key in keyof TConfigSchema]: z.infer<\n              ReturnType<TConfigSchema[key]>\n            >;\n          });\n    inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n  }): Expand<ExtensionDataValues<TOutput>>;\n}\n\n/** @ignore */\nexport type VerifyExtensionFactoryOutput<\n  UDeclaredOutput extends AnyExtensionDataRef,\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = (\n  UDeclaredOutput extends any\n    ? UDeclaredOutput['config']['optional'] extends true\n      ? never\n      : UDeclaredOutput['id']\n    : never\n) extends infer IRequiredOutputIds\n  ? [IRequiredOutputIds] extends [UFactoryOutput['id']]\n    ? [UFactoryOutput['id']] extends [UDeclaredOutput['id']]\n      ? {}\n      : {\n          'Error: The extension factory has undeclared output(s)': Exclude<\n            UFactoryOutput['id'],\n            UDeclaredOutput['id']\n          >;\n        }\n    : {\n        'Error: The extension factory is missing the following output(s)': Exclude<\n          IRequiredOutputIds,\n          UFactoryOutput['id']\n        >;\n      }\n  : never;\n\n/** @public */\nexport type CreateExtensionOptions<\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfig,\n  TConfigInput,\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = {\n  kind?: string;\n  namespace?: string;\n  name?: string;\n  attachTo: { id: string; input: string };\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: Array<UOutput>;\n  /** @deprecated - use `config.schema` instead */\n  configSchema?: PortableSchema<TConfig, TConfigInput>;\n  config?: {\n    schema: TConfigSchema;\n  };\n  factory(context: {\n    node: AppNode;\n    config: TConfig &\n      (string extends keyof TConfigSchema\n        ? {}\n        : {\n            [key in keyof TConfigSchema]: z.infer<\n              ReturnType<TConfigSchema[key]>\n            >;\n          });\n    inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n  }): Iterable<UFactoryOutput>;\n} & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>;\n\n/** @public */\nexport interface ExtensionDefinition<TConfig, TConfigInput = TConfig> {\n  $$type: '@backstage/ExtensionDefinition';\n  readonly kind?: string;\n  readonly namespace?: string;\n  readonly name?: string;\n  readonly attachTo: { id: string; input: string };\n  readonly disabled: boolean;\n  readonly configSchema?: PortableSchema<TConfig, TConfigInput>;\n}\n\n/** @internal */\nexport type InternalExtensionDefinition<TConfig, TConfigInput> =\n  ExtensionDefinition<TConfig, TConfigInput> &\n    (\n      | {\n          readonly version: 'v1';\n          readonly inputs: AnyExtensionInputMap;\n          readonly output: AnyExtensionDataMap;\n          factory(context: {\n            node: AppNode;\n            config: TConfig;\n            inputs: ResolvedExtensionInputs<AnyExtensionInputMap>;\n          }): ExtensionDataValues<any>;\n        }\n      | {\n          readonly version: 'v2';\n          readonly inputs: {\n            [inputName in string]: ExtensionInput<\n              AnyExtensionDataRef,\n              { optional: boolean; singleton: boolean }\n            >;\n          };\n          readonly output: Array<AnyExtensionDataRef>;\n          factory(context: {\n            node: AppNode;\n            config: TConfig;\n            inputs: ResolvedExtensionInputs<{\n              [inputName in string]: ExtensionInput<\n                AnyExtensionDataRef,\n                { optional: boolean; singleton: boolean }\n              >;\n            }>;\n          }): Iterable<ExtensionDataValue<any, any>>;\n        }\n    );\n\n/** @internal */\nexport function toInternalExtensionDefinition<TConfig, TConfigInput>(\n  overrides: ExtensionDefinition<TConfig, TConfigInput>,\n): InternalExtensionDefinition<TConfig, TConfigInput> {\n  const internal = overrides as InternalExtensionDefinition<\n    TConfig,\n    TConfigInput\n  >;\n  if (internal.$$type !== '@backstage/ExtensionDefinition') {\n    throw new Error(\n      `Invalid extension definition instance, bad type '${internal.$$type}'`,\n    );\n  }\n  const version = internal.version;\n  if (version !== 'v1' && version !== 'v2') {\n    throw new Error(\n      `Invalid extension definition instance, bad version '${version}'`,\n    );\n  }\n  return internal;\n}\n\n/** @public */\nexport function createExtension<\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfig,\n  TConfigInput,\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n>(\n  options: CreateExtensionOptions<\n    UOutput,\n    TInputs,\n    TConfig,\n    TConfigInput,\n    TConfigSchema,\n    UFactoryOutput\n  >,\n): ExtensionDefinition<\n  TConfig &\n    (string extends keyof TConfigSchema\n      ? {}\n      : {\n          [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n        }),\n  TConfigInput &\n    (string extends keyof TConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n          }>\n        >)\n>;\n/**\n * @public\n * @deprecated - use the array format of `output` instead, see TODO-doc-link\n */\nexport function createExtension<\n  TOutput extends AnyExtensionDataMap,\n  TInputs extends AnyExtensionInputMap,\n  TConfig,\n  TConfigInput,\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n>(\n  options: LegacyCreateExtensionOptions<\n    TOutput,\n    TInputs,\n    TConfig,\n    TConfigInput,\n    TConfigSchema\n  >,\n): ExtensionDefinition<\n  TConfig &\n    (string extends keyof TConfigSchema\n      ? {}\n      : {\n          [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n        }),\n  TConfigInput &\n    (string extends keyof TConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n          }>\n        >)\n>;\nexport function createExtension<\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TLegacyInputs extends AnyExtensionInputMap,\n  TConfig,\n  TConfigInput,\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n>(\n  options:\n    | CreateExtensionOptions<\n        UOutput,\n        TInputs,\n        TConfig,\n        TConfigInput,\n        TConfigSchema,\n        UFactoryOutput\n      >\n    | LegacyCreateExtensionOptions<\n        AnyExtensionDataMap,\n        TLegacyInputs,\n        TConfig,\n        TConfigInput,\n        TConfigSchema\n      >,\n): ExtensionDefinition<\n  TConfig &\n    (string extends keyof TConfigSchema\n      ? {}\n      : {\n          [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n        }),\n  TConfigInput &\n    (string extends keyof TConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n          }>\n        >)\n> {\n  const newConfigSchema = options.config?.schema;\n  if (newConfigSchema && options.configSchema) {\n    throw new Error(`Cannot provide both configSchema and config.schema`);\n  }\n  const configSchema = newConfigSchema\n    ? createSchemaFromZod(innerZ =>\n        innerZ.object(\n          Object.fromEntries(\n            Object.entries(newConfigSchema).map(([k, v]) => [k, v(innerZ)]),\n          ),\n        ),\n      )\n    : options.configSchema;\n\n  return {\n    $$type: '@backstage/ExtensionDefinition',\n    version: Symbol.iterator in options.output ? 'v2' : 'v1',\n    kind: options.kind,\n    namespace: options.namespace,\n    name: options.name,\n    attachTo: options.attachTo,\n    disabled: options.disabled ?? false,\n    inputs: options.inputs ?? {},\n    output: options.output,\n    configSchema,\n    factory: options.factory,\n    toString() {\n      const parts: string[] = [];\n      if (options.kind) {\n        parts.push(`kind=${options.kind}`);\n      }\n      if (options.namespace) {\n        parts.push(`namespace=${options.namespace}`);\n      }\n      if (options.name) {\n        parts.push(`name=${options.name}`);\n      }\n      parts.push(`attachTo=${options.attachTo.id}@${options.attachTo.input}`);\n      return `ExtensionDefinition{${parts.join(',')}}`;\n    },\n  } as InternalExtensionDefinition<\n    TConfig &\n      (string extends keyof TConfigSchema\n        ? {}\n        : {\n            [key in keyof TConfigSchema]: z.infer<\n              ReturnType<TConfigSchema[key]>\n            >;\n          }),\n    TConfigInput &\n      (string extends keyof TConfigSchema\n        ? {}\n        : z.input<\n            z.ZodObject<{\n              [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n            }>\n          >)\n  >;\n}\n"],"names":[],"mappings":";;;AAuQO,SAAS,8BACd,SACoD,EAAA;AACpD,EAAA,MAAM,QAAW,GAAA,SAAA,CAAA;AAIjB,EAAI,IAAA,QAAA,CAAS,WAAW,gCAAkC,EAAA;AACxD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,iDAAA,EAAoD,SAAS,MAAM,CAAA,CAAA,CAAA;AAAA,KACrE,CAAA;AAAA,GACF;AACA,EAAA,MAAM,UAAU,QAAS,CAAA,OAAA,CAAA;AACzB,EAAI,IAAA,OAAA,KAAY,IAAQ,IAAA,OAAA,KAAY,IAAM,EAAA;AACxC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uDAAuD,OAAO,CAAA,CAAA,CAAA;AAAA,KAChE,CAAA;AAAA,GACF;AACA,EAAO,OAAA,QAAA,CAAA;AACT;;;;"}

package/dist/frontend-plugin-api/src/wiring/createExtensionOverrides.esm.js

@@ -0,0 +1,20 @@
+import 'zod';
+import 'zod-to-json-schema';
+
+function toInternalExtensionOverrides(overrides) {
+  const internal = overrides;
+  if (internal.$$type !== "@backstage/ExtensionOverrides") {
+    throw new Error(
+      `Invalid extension overrides instance, bad type '${internal.$$type}'`
+    );
+  }
+  if (internal.version !== "v1") {
+    throw new Error(
+      `Invalid extension overrides instance, bad version '${internal.version}'`
+    );
+  }
+  return internal;
+}
+
+export { toInternalExtensionOverrides };
+//# sourceMappingURL=createExtensionOverrides.esm.js.map

package/dist/frontend-plugin-api/src/wiring/createExtensionOverrides.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createExtensionOverrides.esm.js","sources":["../../../../../frontend-plugin-api/src/wiring/createExtensionOverrides.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ExtensionDefinition } from './createExtension';\nimport {\n  Extension,\n  resolveExtensionDefinition,\n} from './resolveExtensionDefinition';\nimport { ExtensionOverrides, FeatureFlagConfig } from './types';\n\n/** @public */\nexport interface ExtensionOverridesOptions {\n  extensions: ExtensionDefinition<any, any>[];\n  featureFlags?: FeatureFlagConfig[];\n}\n\n/** @internal */\nexport interface InternalExtensionOverrides extends ExtensionOverrides {\n  readonly version: 'v1';\n  readonly extensions: Extension<unknown>[];\n  readonly featureFlags: FeatureFlagConfig[];\n}\n\n/** @public */\nexport function createExtensionOverrides(\n  options: ExtensionOverridesOptions,\n): ExtensionOverrides {\n  const extensions = options.extensions.map(def =>\n    resolveExtensionDefinition(def),\n  );\n  const featureFlags = options.featureFlags ?? [];\n  return {\n    $$type: '@backstage/ExtensionOverrides',\n    version: 'v1',\n    extensions,\n    featureFlags,\n    toString() {\n      const ex = extensions.map(String).join(',');\n      const ff = featureFlags.map(f => f.name).join(',');\n      return `ExtensionOverrides{extensions=[${ex}],featureFlags=[${ff}]}`;\n    },\n  } as InternalExtensionOverrides;\n}\n\n/** @internal */\nexport function toInternalExtensionOverrides(\n  overrides: ExtensionOverrides,\n): InternalExtensionOverrides {\n  const internal = overrides as InternalExtensionOverrides;\n  if (internal.$$type !== '@backstage/ExtensionOverrides') {\n    throw new Error(\n      `Invalid extension overrides instance, bad type '${internal.$$type}'`,\n    );\n  }\n  if (internal.version !== 'v1') {\n    throw new Error(\n      `Invalid extension overrides instance, bad version '${internal.version}'`,\n    );\n  }\n  return internal;\n}\n"],"names":[],"mappings":";;;AA0DO,SAAS,6BACd,SAC4B,EAAA;AAC5B,EAAA,MAAM,QAAW,GAAA,SAAA,CAAA;AACjB,EAAI,IAAA,QAAA,CAAS,WAAW,+BAAiC,EAAA;AACvD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,gDAAA,EAAmD,SAAS,MAAM,CAAA,CAAA,CAAA;AAAA,KACpE,CAAA;AAAA,GACF;AACA,EAAI,IAAA,QAAA,CAAS,YAAY,IAAM,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,mDAAA,EAAsD,SAAS,OAAO,CAAA,CAAA,CAAA;AAAA,KACxE,CAAA;AAAA,GACF;AACA,EAAO,OAAA,QAAA,CAAA;AACT;;;;"}

package/dist/frontend-plugin-api/src/wiring/createPlugin.esm.js

@@ -0,0 +1,18 @@
+import 'zod';
+import 'zod-to-json-schema';
+
+function toInternalBackstagePlugin(plugin) {
+  const internal = plugin;
+  if (internal.$$type !== "@backstage/BackstagePlugin") {
+    throw new Error(`Invalid plugin instance, bad type '${internal.$$type}'`);
+  }
+  if (internal.version !== "v1") {
+    throw new Error(
+      `Invalid plugin instance, bad version '${internal.version}'`
+    );
+  }
+  return internal;
+}
+
+export { toInternalBackstagePlugin };
+//# sourceMappingURL=createPlugin.esm.js.map

package/dist/frontend-plugin-api/src/wiring/createPlugin.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPlugin.esm.js","sources":["../../../../../frontend-plugin-api/src/wiring/createPlugin.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ExtensionDefinition } from './createExtension';\nimport {\n  Extension,\n  resolveExtensionDefinition,\n} from './resolveExtensionDefinition';\nimport {\n  AnyExternalRoutes,\n  AnyRoutes,\n  BackstagePlugin,\n  FeatureFlagConfig,\n} from './types';\n\n/** @public */\nexport interface PluginOptions<\n  Routes extends AnyRoutes,\n  ExternalRoutes extends AnyExternalRoutes,\n> {\n  id: string;\n  routes?: Routes;\n  externalRoutes?: ExternalRoutes;\n  extensions?: ExtensionDefinition<any, any>[];\n  featureFlags?: FeatureFlagConfig[];\n}\n\n/** @public */\nexport interface InternalBackstagePlugin<\n  Routes extends AnyRoutes = AnyRoutes,\n  ExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes,\n> extends BackstagePlugin<Routes, ExternalRoutes> {\n  readonly version: 'v1';\n  readonly extensions: Extension<unknown>[];\n  readonly featureFlags: FeatureFlagConfig[];\n}\n\n/** @public */\nexport function createPlugin<\n  Routes extends AnyRoutes = {},\n  ExternalRoutes extends AnyExternalRoutes = {},\n>(\n  options: PluginOptions<Routes, ExternalRoutes>,\n): BackstagePlugin<Routes, ExternalRoutes> {\n  const extensions = (options.extensions ?? []).map(def =>\n    resolveExtensionDefinition(def, { namespace: options.id }),\n  );\n\n  const extensionIds = extensions.map(e => e.id);\n  if (extensionIds.length !== new Set(extensionIds).size) {\n    const duplicates = Array.from(\n      new Set(\n        extensionIds.filter((id, index) => extensionIds.indexOf(id) !== index),\n      ),\n    );\n    // TODO(Rugvip): This could provide some more information about the kind + name of the extensions\n    throw new Error(\n      `Plugin '${options.id}' provided duplicate extensions: ${duplicates.join(\n        ', ',\n      )}`,\n    );\n  }\n\n  return {\n    $$type: '@backstage/BackstagePlugin',\n    version: 'v1',\n    id: options.id,\n    routes: options.routes ?? ({} as Routes),\n    externalRoutes: options.externalRoutes ?? ({} as ExternalRoutes),\n    featureFlags: options.featureFlags ?? [],\n    extensions,\n    toString() {\n      return `Plugin{id=${options.id}}`;\n    },\n  } as InternalBackstagePlugin<Routes, ExternalRoutes>;\n}\n\n/** @internal */\nexport function toInternalBackstagePlugin(\n  plugin: BackstagePlugin,\n): InternalBackstagePlugin {\n  const internal = plugin as InternalBackstagePlugin;\n  if (internal.$$type !== '@backstage/BackstagePlugin') {\n    throw new Error(`Invalid plugin instance, bad type '${internal.$$type}'`);\n  }\n  if (internal.version !== 'v1') {\n    throw new Error(\n      `Invalid plugin instance, bad version '${internal.version}'`,\n    );\n  }\n  return internal;\n}\n"],"names":[],"mappings":";;;AA2FO,SAAS,0BACd,MACyB,EAAA;AACzB,EAAA,MAAM,QAAW,GAAA,MAAA,CAAA;AACjB,EAAI,IAAA,QAAA,CAAS,WAAW,4BAA8B,EAAA;AACpD,IAAA,MAAM,IAAI,KAAA,CAAM,CAAsC,mCAAA,EAAA,QAAA,CAAS,MAAM,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GAC1E;AACA,EAAI,IAAA,QAAA,CAAS,YAAY,IAAM,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,SAAS,OAAO,CAAA,CAAA,CAAA;AAAA,KAC3D,CAAA;AAAA,GACF;AACA,EAAO,OAAA,QAAA,CAAA;AACT;;;;"}

package/dist/frontend-plugin-api/src/wiring/resolveExtensionDefinition.esm.js

@@ -1,5 +1,18 @@
 import { toInternalExtensionDefinition } from './createExtension.esm.js';
 
+function toInternalExtension(overrides) {
+  const internal = overrides;
+  if (internal.$$type !== "@backstage/Extension") {
+    throw new Error(
+      `Invalid extension instance, bad type '${internal.$$type}'`
+    );
+  }
+  const version = internal.version;
+  if (version !== "v1" && version !== "v2") {
+    throw new Error(`Invalid extension instance, bad version '${version}'`);
+  }
+  return internal;
+}
 function resolveExtensionDefinition(definition, context) {
   const internalDefinition = toInternalExtensionDefinition(definition);
   const { name, kind, namespace: _, ...rest } = internalDefinition;
@@ -14,7 +27,7 @@ function resolveExtensionDefinition(definition, context) {
   return {
     ...rest,
     $$type: "@backstage/Extension",
-    version: "v1",
+    version: internalDefinition.version,
     id,
     toString() {
       return `Extension{id=${id}}`;
@@ -22,5 +35,5 @@ function resolveExtensionDefinition(definition, context) {
   };
 }
 
-export { resolveExtensionDefinition };
+export { resolveExtensionDefinition, toInternalExtension };
 //# sourceMappingURL=resolveExtensionDefinition.esm.js.map

package/dist/frontend-plugin-api/src/wiring/resolveExtensionDefinition.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolveExtensionDefinition.esm.js","sources":["../../../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { AppNode } from '../apis';\nimport {\n  AnyExtensionDataMap,\n  AnyExtensionInputMap,\n  ExtensionDataValues,\n  ExtensionDefinition,\n  ResolvedExtensionInputs,\n  toInternalExtensionDefinition,\n} from './createExtension';\nimport { PortableSchema } from '../schema';\n\n/** @public */\nexport interface Extension<TConfig> {\n  $$type: '@backstage/Extension';\n  readonly id: string;\n  readonly attachTo: { id: string; input: string };\n  readonly disabled: boolean;\n  readonly configSchema?: PortableSchema<TConfig>;\n}\n\n/** @internal */\nexport interface InternalExtension<TConfig> extends Extension<TConfig> {\n  readonly version: 'v1';\n  readonly inputs: AnyExtensionInputMap;\n  readonly output: AnyExtensionDataMap;\n  factory(options: {\n    node: AppNode;\n    config: TConfig;\n    inputs: ResolvedExtensionInputs<any>;\n  }): ExtensionDataValues<any>;\n}\n\n/** @internal */\nexport function toInternalExtension<TConfig>(\n  overrides: Extension<TConfig>,\n): InternalExtension<TConfig> {\n  const internal = overrides as InternalExtension<TConfig>;\n  if (internal.$$type !== '@backstage/Extension') {\n    throw new Error(\n      `Invalid extension instance, bad type '${internal.$$type}'`,\n    );\n  }\n  if (internal.version !== 'v1') {\n    throw new Error(\n      `Invalid extension instance, bad version '${internal.version}'`,\n    );\n  }\n  return internal;\n}\n\n/** @internal */\nexport function resolveExtensionDefinition<TConfig>(\n  definition: ExtensionDefinition<TConfig>,\n  context?: { namespace?: string },\n): Extension<TConfig> {\n  const internalDefinition = toInternalExtensionDefinition(definition);\n  const { name, kind, namespace: _, ...rest } = internalDefinition;\n  const namespace = internalDefinition.namespace ?? context?.namespace;\n\n  const namePart =\n    name && namespace ? `${namespace}/${name}` : namespace || name;\n  if (!namePart) {\n    throw new Error(\n      `Extension must declare an explicit namespace or name as it could not be resolved from context, kind=${kind} namespace=${namespace} name=${name}`,\n    );\n  }\n\n  const id = kind ? `${kind}:${namePart}` : namePart;\n\n  return {\n    ...rest,\n    $$type: '@backstage/Extension',\n    version: 'v1',\n    id,\n    toString() {\n      return `Extension{id=${id}}`;\n    },\n  } as Extension<TConfig>;\n}\n"],"names":[],"mappings":";;AAmEgB,SAAA,0BAAA,CACd,YACA,OACoB,EAAA;AACpB,EAAM,MAAA,kBAAA,GAAqB,8BAA8B,UAAU,CAAA,CAAA;AACnE,EAAA,MAAM,EAAE,IAAM,EAAA,IAAA,EAAM,WAAW,CAAG,EAAA,GAAG,MAAS,GAAA,kBAAA,CAAA;AAC9C,EAAM,MAAA,SAAA,GAAY,kBAAmB,CAAA,SAAA,IAAa,OAAS,EAAA,SAAA,CAAA;AAE3D,EAAM,MAAA,QAAA,GACJ,QAAQ,SAAY,GAAA,CAAA,EAAG,SAAS,CAAI,CAAA,EAAA,IAAI,KAAK,SAAa,IAAA,IAAA,CAAA;AAC5D,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAuG,oGAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,SAAS,IAAI,CAAA,CAAA;AAAA,KACjJ,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,KAAK,IAAO,GAAA,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAK,CAAA,GAAA,QAAA,CAAA;AAE1C,EAAO,OAAA;AAAA,IACL,GAAG,IAAA;AAAA,IACH,MAAQ,EAAA,sBAAA;AAAA,IACR,OAAS,EAAA,IAAA;AAAA,IACT,EAAA;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,gBAAgB,EAAE,CAAA,CAAA,CAAA,CAAA;AAAA,KAC3B;AAAA,GACF,CAAA;AACF;;;;"}
+{"version":3,"file":"resolveExtensionDefinition.esm.js","sources":["../../../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { AppNode } from '../apis';\nimport {\n  AnyExtensionDataMap,\n  AnyExtensionInputMap,\n  ExtensionDataValues,\n  ExtensionDefinition,\n  ResolvedExtensionInputs,\n  toInternalExtensionDefinition,\n} from './createExtension';\nimport { PortableSchema } from '../schema';\nimport { ExtensionInput } from './createExtensionInput';\nimport {\n  AnyExtensionDataRef,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\n\n/** @public */\nexport interface Extension<TConfig, TConfigInput = TConfig> {\n  $$type: '@backstage/Extension';\n  readonly id: string;\n  readonly attachTo: { id: string; input: string };\n  readonly disabled: boolean;\n  readonly configSchema?: PortableSchema<TConfig, TConfigInput>;\n}\n\n/** @internal */\nexport type InternalExtension<TConfig, TConfigInput> = Extension<\n  TConfig,\n  TConfigInput\n> &\n  (\n    | {\n        readonly version: 'v1';\n        readonly inputs: AnyExtensionInputMap;\n        readonly output: AnyExtensionDataMap;\n        factory(options: {\n          node: AppNode;\n          config: TConfig;\n          inputs: ResolvedExtensionInputs<AnyExtensionInputMap>;\n        }): ExtensionDataValues<any>;\n      }\n    | {\n        readonly version: 'v2';\n        readonly inputs: {\n          [inputName in string]: ExtensionInput<\n            AnyExtensionDataRef,\n            { optional: boolean; singleton: boolean }\n          >;\n        };\n        readonly output: Array<AnyExtensionDataRef>;\n        factory(options: {\n          node: AppNode;\n          config: TConfig;\n          inputs: ResolvedExtensionInputs<{\n            [inputName in string]: ExtensionInput<\n              AnyExtensionDataRef,\n              { optional: boolean; singleton: boolean }\n            >;\n          }>;\n        }): Iterable<ExtensionDataValue<any, any>>;\n      }\n  );\n\n/** @internal */\nexport function toInternalExtension<TConfig, TConfigInput>(\n  overrides: Extension<TConfig, TConfigInput>,\n): InternalExtension<TConfig, TConfigInput> {\n  const internal = overrides as InternalExtension<TConfig, TConfigInput>;\n  if (internal.$$type !== '@backstage/Extension') {\n    throw new Error(\n      `Invalid extension instance, bad type '${internal.$$type}'`,\n    );\n  }\n  const version = internal.version;\n  if (version !== 'v1' && version !== 'v2') {\n    throw new Error(`Invalid extension instance, bad version '${version}'`);\n  }\n  return internal;\n}\n\n/** @internal */\nexport function resolveExtensionDefinition<TConfig, TConfigInput>(\n  definition: ExtensionDefinition<TConfig, TConfigInput>,\n  context?: { namespace?: string },\n): Extension<TConfig, TConfigInput> {\n  const internalDefinition = toInternalExtensionDefinition(definition);\n  const { name, kind, namespace: _, ...rest } = internalDefinition;\n  const namespace = internalDefinition.namespace ?? context?.namespace;\n\n  const namePart =\n    name && namespace ? `${namespace}/${name}` : namespace || name;\n  if (!namePart) {\n    throw new Error(\n      `Extension must declare an explicit namespace or name as it could not be resolved from context, kind=${kind} namespace=${namespace} name=${name}`,\n    );\n  }\n\n  const id = kind ? `${kind}:${namePart}` : namePart;\n\n  return {\n    ...rest,\n    $$type: '@backstage/Extension',\n    version: internalDefinition.version,\n    id,\n    toString() {\n      return `Extension{id=${id}}`;\n    },\n  } as InternalExtension<TConfig, TConfigInput>;\n}\n"],"names":[],"mappings":";;AAgFO,SAAS,oBACd,SAC0C,EAAA;AAC1C,EAAA,MAAM,QAAW,GAAA,SAAA,CAAA;AACjB,EAAI,IAAA,QAAA,CAAS,WAAW,sBAAwB,EAAA;AAC9C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,SAAS,MAAM,CAAA,CAAA,CAAA;AAAA,KAC1D,CAAA;AAAA,GACF;AACA,EAAA,MAAM,UAAU,QAAS,CAAA,OAAA,CAAA;AACzB,EAAI,IAAA,OAAA,KAAY,IAAQ,IAAA,OAAA,KAAY,IAAM,EAAA;AACxC,IAAA,MAAM,IAAI,KAAA,CAAM,CAA4C,yCAAA,EAAA,OAAO,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACxE;AACA,EAAO,OAAA,QAAA,CAAA;AACT,CAAA;AAGgB,SAAA,0BAAA,CACd,YACA,OACkC,EAAA;AAClC,EAAM,MAAA,kBAAA,GAAqB,8BAA8B,UAAU,CAAA,CAAA;AACnE,EAAA,MAAM,EAAE,IAAM,EAAA,IAAA,EAAM,WAAW,CAAG,EAAA,GAAG,MAAS,GAAA,kBAAA,CAAA;AAC9C,EAAM,MAAA,SAAA,GAAY,kBAAmB,CAAA,SAAA,IAAa,OAAS,EAAA,SAAA,CAAA;AAE3D,EAAM,MAAA,QAAA,GACJ,QAAQ,SAAY,GAAA,CAAA,EAAG,SAAS,CAAI,CAAA,EAAA,IAAI,KAAK,SAAa,IAAA,IAAA,CAAA;AAC5D,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAuG,oGAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,SAAS,IAAI,CAAA,CAAA;AAAA,KACjJ,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,KAAK,IAAO,GAAA,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAK,CAAA,GAAA,QAAA,CAAA;AAE1C,EAAO,OAAA;AAAA,IACL,GAAG,IAAA;AAAA,IACH,MAAQ,EAAA,sBAAA;AAAA,IACR,SAAS,kBAAmB,CAAA,OAAA;AAAA,IAC5B,EAAA;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,gBAAgB,EAAE,CAAA,CAAA,CAAA,CAAA;AAAA,KAC3B;AAAA,GACF,CAAA;AACF;;;;"}