@techdocs/cli 1.5.2 → 1.6.0-next.2

package/CHANGELOG.md

@@ -1,20 +1,43 @@
 # @techdocs/cli
 
-## 1.5.2
+## 1.6.0-next.2
+
+### Minor Changes
+
+- d06b30b050: Add possibility to use a mkdocs config file with a different name than `mkdocs.<yaml|yml> with the serve command using the `--mkdocs-config-file-name` argument
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.19.8-next.2
+  - @backstage/plugin-techdocs-node@1.9.0-next.2
+  - @backstage/catalog-model@1.4.3-next.0
+  - @backstage/cli-common@0.1.13-next.0
+  - @backstage/config@1.1.1-next.0
+
+## 1.5.2-next.1
 
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/backend-common@0.19.7
-  - @backstage/plugin-techdocs-node@1.8.2
+  - @backstage/backend-common@0.19.7-next.1
+  - @backstage/plugin-techdocs-node@1.8.2-next.1
+  - @backstage/config@1.1.0
+  - @backstage/catalog-model@1.4.2
+  - @backstage/cli-common@0.1.13-next.0
 
-## 1.5.1
+## 1.5.2-next.0
 
 ### Patch Changes
 
+- de42eebaaf: Bumped dev dependencies `@types/node` and `mock-fs`.
+- 2b6e572051: Restructured tests.
 - Updated dependencies
-  - @backstage/backend-common@0.19.6
-  - @backstage/plugin-techdocs-node@1.8.1
+  - @backstage/cli-common@0.1.13-next.0
+  - @backstage/backend-common@0.19.7-next.0
+  - @backstage/plugin-techdocs-node@1.8.2-next.0
+  - @backstage/config@1.1.0
+  - @backstage/catalog-model@1.4.2
 
 ## 1.5.0
 

package/README.md

@@ -75,38 +75,3 @@ pip install mkdocs-techdocs-core
 ```
 
 Then run `yarn test`.
-
-#### Cypress (Integration and Visual regression) tests
-
-Running cypress tests requires you to run the CLI locally against our example docs.
-
-Run the local version of techdocs-cli against the example docs:
-
-```sh
-# From the root of this repository run
-# NOTE: This will build the techdocs-cli-embedded-app and copy the output into the cli dist directory
-yarn build --scope @techdocs/cli
-
-# Navigate to the example project
-cd packages/techdocs-cli/src/example-docs
-
-# Now execute the techdocs-cli serve command
-../../bin/techdocs-cli serve
-```
-
-In another shell, run the cypress tests:
-
-```sh
-# From the root of the project, navigate to the techdocs-cli package
-cd packages/techdocs-cli
-
-# Run tests
-yarn test:cypress
-```
-
-This will launch a cypress app where you can run the two different tests:
-
-- `backstage_serve` - will run against the backstage server
-- `mkdocs_serve` - will run test against the mkdocs server
-
-> If its the first time you run Cypress, it will run a "Verifying Cypress can run" step. This step can result in a "Cypress verification timed out" error. If that is the case, let the verification step run and then run the command again and it should succeed.

package/dist/cjs/{mkdocs-582c42fd.cjs.js → mkdocs-571e2dc0.cjs.js}

@@ -2,7 +2,7 @@
 
 var openBrowser = require('react-dev-utils/openBrowser');
 var utility = require('./utility-3c0df5a9.cjs.js');
-var mkdocsServer = require('./mkdocsServer-99ec8af2.cjs.js');
+var mkdocsServer = require('./mkdocsServer-107b8efd.cjs.js');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var fs = require('fs-extra');
 require('winston');
@@ -60,4 +60,4 @@ Starting mkdocs server on ${localAddr}
 }
 
 exports["default"] = serveMkdocs;
-//# sourceMappingURL=mkdocs-582c42fd.cjs.js.map
+//# sourceMappingURL=mkdocs-571e2dc0.cjs.js.map

package/dist/cjs/{mkdocs-582c42fd.cjs.js.map → mkdocs-571e2dc0.cjs.js.map}

@@ -1 +1 @@
-{"version":3,"file":"mkdocs-582c42fd.cjs.js","sources":["../../src/commands/serve/mkdocs.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { createLogger } from '../../lib/utility';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\n\nexport default async function serveMkdocs(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const dockerAddr = `http://0.0.0.0:${opts.port}`;\n  const localAddr = `http://127.0.0.1:${opts.port}`;\n  const expectedDevAddr = opts.docker ? dockerAddr : localAddr;\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    './',\n    opts.siteName,\n  );\n\n  // We want to open browser only once based on a log.\n  let boolOpenBrowserTriggered = false;\n\n  const logFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line in between\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      // Logs from container is verbose.\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !boolOpenBrowserTriggered &&\n        line.includes(`Serving on ${expectedDevAddr}`)\n      ) {\n        // Always open the local address, since 0.0.0.0 belongs to docker\n        logger.info(`\\nStarting mkdocs server on ${localAddr}\\n`);\n        openBrowser(localAddr);\n        boolOpenBrowserTriggered = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n\n  // Commander stores --no-docker in cmd.docker variable\n  const childProcess = await runMkdocsServer({\n    port: opts.port,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    stdoutLogFunc: logFunc,\n    stderrLogFunc: logFunc,\n  });\n\n  // Keep waiting for user to cancel the process\n  await waitForSignal([childProcess]);\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["createLogger","getMkdocsYml","openBrowser","runMkdocsServer","waitForSignal","fs"],"mappings":";;;;;;;;;;;;;;;;;AAwBA,eAA8B,YAAY,IAAoB,EAAA;AAC5D,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAErD,EAAM,MAAA,UAAA,GAAa,CAAkB,eAAA,EAAA,IAAA,CAAK,IAAI,CAAA,CAAA,CAAA;AAC9C,EAAM,MAAA,SAAA,GAAY,CAAoB,iBAAA,EAAA,IAAA,CAAK,IAAI,CAAA,CAAA,CAAA;AAC/C,EAAM,MAAA,eAAA,GAAkB,IAAK,CAAA,MAAA,GAAS,UAAa,GAAA,SAAA,CAAA;AAEnD,EAAA,MAAM,EAAE,IAAA,EAAM,aAAe,EAAA,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,IAAA;AAAA,IACA,IAAK,CAAA,QAAA;AAAA,GACP,CAAA;AAGA,EAAA,IAAI,wBAA2B,GAAA,KAAA,CAAA;AAE/B,EAAA,MAAM,UAAmB,CAAQ,IAAA,KAAA;AAE/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,EAAA,CAAE,MAAM,IAAI,CAAA,CAAA;AAC3C,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,MAAA,GAAS,iBAAoB,GAAA,UAAA,CAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AACvB,MAAA,IAAI,SAAS,EAAI,EAAA;AACf,QAAA,OAAA;AAAA,OACF;AAGA,MAAA,MAAA,CAAO,OAAQ,CAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA,CAAA;AAGrC,MAAA,IACE,CAAC,wBACD,IAAA,IAAA,CAAK,SAAS,CAAc,WAAA,EAAA,eAAe,EAAE,CAC7C,EAAA;AAEA,QAAA,MAAA,CAAO,IAAK,CAAA,CAAA;AAAA,0BAAA,EAA+B,SAAS,CAAA;AAAA,CAAI,CAAA,CAAA;AACxD,QAAAC,+BAAA,CAAY,SAAS,CAAA,CAAA;AACrB,QAA2B,wBAAA,GAAA,IAAA,CAAA;AAAA,OAC7B;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAMA,EAAM,MAAA,YAAA,GAAe,MAAMC,4BAAgB,CAAA;AAAA,IACzC,MAAM,IAAK,CAAA,IAAA;AAAA,IACX,aAAa,IAAK,CAAA,WAAA;AAAA,IAClB,kBAAkB,IAAK,CAAA,gBAAA;AAAA,IACvB,eAAe,IAAK,CAAA,YAAA;AAAA,IACpB,WAAW,IAAK,CAAA,MAAA;AAAA,IAChB,aAAe,EAAA,OAAA;AAAA,IACf,aAAe,EAAA,OAAA;AAAA,GAChB,CAAA,CAAA;AAGD,EAAM,MAAAC,0BAAA,CAAc,CAAC,YAAY,CAAC,CAAA,CAAA;AAElC,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGC,sBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA,CAAA;AAAA,KAC5B,CAAA,CAAA;AAAA,GACH;AACF;;;;"}
+{"version":3,"file":"mkdocs-571e2dc0.cjs.js","sources":["../../src/commands/serve/mkdocs.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { createLogger } from '../../lib/utility';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\n\nexport default async function serveMkdocs(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const dockerAddr = `http://0.0.0.0:${opts.port}`;\n  const localAddr = `http://127.0.0.1:${opts.port}`;\n  const expectedDevAddr = opts.docker ? dockerAddr : localAddr;\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    './',\n    opts.siteName,\n  );\n\n  // We want to open browser only once based on a log.\n  let boolOpenBrowserTriggered = false;\n\n  const logFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line in between\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      // Logs from container is verbose.\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !boolOpenBrowserTriggered &&\n        line.includes(`Serving on ${expectedDevAddr}`)\n      ) {\n        // Always open the local address, since 0.0.0.0 belongs to docker\n        logger.info(`\\nStarting mkdocs server on ${localAddr}\\n`);\n        openBrowser(localAddr);\n        boolOpenBrowserTriggered = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n\n  // Commander stores --no-docker in cmd.docker variable\n  const childProcess = await runMkdocsServer({\n    port: opts.port,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    stdoutLogFunc: logFunc,\n    stderrLogFunc: logFunc,\n  });\n\n  // Keep waiting for user to cancel the process\n  await waitForSignal([childProcess]);\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["createLogger","getMkdocsYml","openBrowser","runMkdocsServer","waitForSignal","fs"],"mappings":";;;;;;;;;;;;;;;;;AAwBA,eAA8B,YAAY,IAAoB,EAAA;AAC5D,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAErD,EAAM,MAAA,UAAA,GAAa,CAAkB,eAAA,EAAA,IAAA,CAAK,IAAI,CAAA,CAAA,CAAA;AAC9C,EAAM,MAAA,SAAA,GAAY,CAAoB,iBAAA,EAAA,IAAA,CAAK,IAAI,CAAA,CAAA,CAAA;AAC/C,EAAM,MAAA,eAAA,GAAkB,IAAK,CAAA,MAAA,GAAS,UAAa,GAAA,SAAA,CAAA;AAEnD,EAAA,MAAM,EAAE,IAAA,EAAM,aAAe,EAAA,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,IAAA;AAAA,IACA,IAAK,CAAA,QAAA;AAAA,GACP,CAAA;AAGA,EAAA,IAAI,wBAA2B,GAAA,KAAA,CAAA;AAE/B,EAAA,MAAM,UAAmB,CAAQ,IAAA,KAAA;AAE/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,EAAA,CAAE,MAAM,IAAI,CAAA,CAAA;AAC3C,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,MAAA,GAAS,iBAAoB,GAAA,UAAA,CAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AACvB,MAAA,IAAI,SAAS,EAAI,EAAA;AACf,QAAA,OAAA;AAAA,OACF;AAGA,MAAA,MAAA,CAAO,OAAQ,CAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA,CAAA;AAGrC,MAAA,IACE,CAAC,wBACD,IAAA,IAAA,CAAK,SAAS,CAAc,WAAA,EAAA,eAAe,EAAE,CAC7C,EAAA;AAEA,QAAA,MAAA,CAAO,IAAK,CAAA,CAAA;AAAA,0BAAA,EAA+B,SAAS,CAAA;AAAA,CAAI,CAAA,CAAA;AACxD,QAAAC,+BAAA,CAAY,SAAS,CAAA,CAAA;AACrB,QAA2B,wBAAA,GAAA,IAAA,CAAA;AAAA,OAC7B;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAMA,EAAM,MAAA,YAAA,GAAe,MAAMC,4BAAgB,CAAA;AAAA,IACzC,MAAM,IAAK,CAAA,IAAA;AAAA,IACX,aAAa,IAAK,CAAA,WAAA;AAAA,IAClB,kBAAkB,IAAK,CAAA,gBAAA;AAAA,IACvB,eAAe,IAAK,CAAA,YAAA;AAAA,IACpB,WAAW,IAAK,CAAA,MAAA;AAAA,IAChB,aAAe,EAAA,OAAA;AAAA,IACf,aAAe,EAAA,OAAA;AAAA,GAChB,CAAA,CAAA;AAGD,EAAM,MAAAC,0BAAA,CAAc,CAAC,YAAY,CAAC,CAAA,CAAA;AAElC,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGC,sBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA,CAAA;AAAA,KAC5B,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/cjs/{mkdocsServer-99ec8af2.cjs.js → mkdocsServer-107b8efd.cjs.js}

@@ -77,7 +77,8 @@ const runMkdocsServer = async (options) => {
         dockerImage,
         "serve",
         "--dev-addr",
-        `0.0.0.0:${port}`
+        `0.0.0.0:${port}`,
+        ...options.mkdocsConfigFileName ? ["--config-file", options.mkdocsConfigFileName] : []
       ],
       {
         stdoutLogFunc: options.stdoutLogFunc,
@@ -85,12 +86,21 @@ const runMkdocsServer = async (options) => {
       }
     );
   }
-  return await run("mkdocs", ["serve", "--dev-addr", `127.0.0.1:${port}`], {
-    stdoutLogFunc: options.stdoutLogFunc,
-    stderrLogFunc: options.stderrLogFunc
-  });
+  return await run(
+    "mkdocs",
+    [
+      "serve",
+      "--dev-addr",
+      `127.0.0.1:${port}`,
+      ...options.mkdocsConfigFileName ? ["--config-file", options.mkdocsConfigFileName] : []
+    ],
+    {
+      stdoutLogFunc: options.stdoutLogFunc,
+      stderrLogFunc: options.stderrLogFunc
+    }
+  );
 };
 
 exports.runMkdocsServer = runMkdocsServer;
 exports.waitForSignal = waitForSignal;
-//# sourceMappingURL=mkdocsServer-99ec8af2.cjs.js.map
+//# sourceMappingURL=mkdocsServer-107b8efd.cjs.js.map

package/dist/cjs/mkdocsServer-107b8efd.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mkdocsServer-107b8efd.cjs.js","sources":["../../src/lib/run.ts","../../src/lib/mkdocsServer.ts"],"sourcesContent":["/*\n * Copyright 2020 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 */\nimport { spawn, SpawnOptions, ChildProcess } from 'child_process';\n\nexport type LogFunc = (data: Buffer | string) => void;\ntype SpawnOptionsPartialEnv = Omit<SpawnOptions, 'env'> & {\n  env?: Partial<NodeJS.ProcessEnv>;\n  // Pipe stdout to this log function\n  stdoutLogFunc?: LogFunc;\n  // Pipe stderr to this log function\n  stderrLogFunc?: LogFunc;\n};\n\n// TODO: Accept log functions to pipe logs with.\n// Runs a child command, returning the child process instance.\n// Use it along with waitForSignal to run a long running process e.g. mkdocs serve\nexport const run = async (\n  name: string,\n  args: string[] = [],\n  options: SpawnOptionsPartialEnv = {},\n): Promise<ChildProcess> => {\n  const { stdoutLogFunc, stderrLogFunc } = options;\n\n  const env: NodeJS.ProcessEnv = {\n    ...process.env,\n    FORCE_COLOR: 'true',\n    ...(options.env ?? {}),\n  };\n\n  // Refer: https://nodejs.org/api/child_process.html#child_process_subprocess_stdio\n  const stdio = [\n    'inherit',\n    stdoutLogFunc ? 'pipe' : 'inherit',\n    stderrLogFunc ? 'pipe' : 'inherit',\n  ] as ('inherit' | 'pipe')[];\n\n  const childProcess = spawn(name, args, {\n    stdio: stdio,\n    ...options,\n    env,\n  });\n\n  if (stdoutLogFunc && childProcess.stdout) {\n    childProcess.stdout.on('data', stdoutLogFunc);\n  }\n  if (stderrLogFunc && childProcess.stderr) {\n    childProcess.stderr.on('data', stderrLogFunc);\n  }\n\n  return childProcess;\n};\n\n// Block indefinitely and wait for a signal to stop the child process(es)\n// Throw error if any child process errors\n// Resolves only when all processes exit with status code 0\nexport async function waitForSignal(\n  childProcesses: Array<ChildProcess>,\n): Promise<void> {\n  const promises: Array<Promise<void>> = [];\n\n  for (const signal of ['SIGINT', 'SIGTERM'] as const) {\n    process.on(signal, () => {\n      childProcesses.forEach(childProcess => {\n        childProcess.kill();\n      });\n    });\n  }\n\n  childProcesses.forEach(childProcess => {\n    if (typeof childProcess.exitCode === 'number') {\n      if (childProcess.exitCode) {\n        throw new Error(`Non zero exit code from child process`);\n      }\n      return;\n    }\n\n    promises.push(\n      new Promise<void>((resolve, reject) => {\n        childProcess.once('error', reject);\n        childProcess.once('exit', resolve);\n      }),\n    );\n  });\n\n  await Promise.all(promises);\n}\n","/*\n * Copyright 2020 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 { ChildProcess } from 'child_process';\nimport { run, LogFunc } from './run';\n\nexport const runMkdocsServer = async (options: {\n  port?: string;\n  useDocker?: boolean;\n  dockerImage?: string;\n  dockerEntrypoint?: string;\n  dockerOptions?: string[];\n  stdoutLogFunc?: LogFunc;\n  stderrLogFunc?: LogFunc;\n  mkdocsConfigFileName?: string;\n}): Promise<ChildProcess> => {\n  const port = options.port ?? '8000';\n  const useDocker = options.useDocker ?? true;\n  const dockerImage = options.dockerImage ?? 'spotify/techdocs';\n\n  if (useDocker) {\n    return await run(\n      'docker',\n      [\n        'run',\n        '--rm',\n        '-w',\n        '/content',\n        '-v',\n        `${process.cwd()}:/content`,\n        '-p',\n        `${port}:${port}`,\n        '-it',\n        ...(options.dockerEntrypoint\n          ? ['--entrypoint', options.dockerEntrypoint]\n          : []),\n        ...(options.dockerOptions || []),\n        dockerImage,\n        'serve',\n        '--dev-addr',\n        `0.0.0.0:${port}`,\n        ...(options.mkdocsConfigFileName\n          ? ['--config-file', options.mkdocsConfigFileName]\n          : []),\n      ],\n      {\n        stdoutLogFunc: options.stdoutLogFunc,\n        stderrLogFunc: options.stderrLogFunc,\n      },\n    );\n  }\n\n  return await run(\n    'mkdocs',\n    [\n      'serve',\n      '--dev-addr',\n      `127.0.0.1:${port}`,\n      ...(options.mkdocsConfigFileName\n        ? ['--config-file', options.mkdocsConfigFileName]\n        : []),\n    ],\n    {\n      stdoutLogFunc: options.stdoutLogFunc,\n      stderrLogFunc: options.stderrLogFunc,\n    },\n  );\n};\n"],"names":["spawn"],"mappings":";;;;AA6Ba,MAAA,GAAA,GAAM,OACjB,IACA,EAAA,IAAA,GAAiB,EACjB,EAAA,OAAA,GAAkC,EACR,KAAA;AAjC5B,EAAA,IAAA,EAAA,CAAA;AAkCE,EAAM,MAAA,EAAE,aAAe,EAAA,aAAA,EAAkB,GAAA,OAAA,CAAA;AAEzC,EAAA,MAAM,GAAyB,GAAA;AAAA,IAC7B,GAAG,OAAQ,CAAA,GAAA;AAAA,IACX,WAAa,EAAA,MAAA;AAAA,IACb,GAAI,CAAA,EAAA,GAAA,OAAA,CAAQ,GAAR,KAAA,IAAA,GAAA,EAAA,GAAe,EAAC;AAAA,GACtB,CAAA;AAGA,EAAA,MAAM,KAAQ,GAAA;AAAA,IACZ,SAAA;AAAA,IACA,gBAAgB,MAAS,GAAA,SAAA;AAAA,IACzB,gBAAgB,MAAS,GAAA,SAAA;AAAA,GAC3B,CAAA;AAEA,EAAM,MAAA,YAAA,GAAeA,mBAAM,CAAA,IAAA,EAAM,IAAM,EAAA;AAAA,IACrC,KAAA;AAAA,IACA,GAAG,OAAA;AAAA,IACH,GAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAA,aAAA,IAAiB,aAAa,MAAQ,EAAA;AACxC,IAAa,YAAA,CAAA,MAAA,CAAO,EAAG,CAAA,MAAA,EAAQ,aAAa,CAAA,CAAA;AAAA,GAC9C;AACA,EAAI,IAAA,aAAA,IAAiB,aAAa,MAAQ,EAAA;AACxC,IAAa,YAAA,CAAA,MAAA,CAAO,EAAG,CAAA,MAAA,EAAQ,aAAa,CAAA,CAAA;AAAA,GAC9C;AAEA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA,CAAA;AAKA,eAAsB,cACpB,cACe,EAAA;AACf,EAAA,MAAM,WAAiC,EAAC,CAAA;AAExC,EAAA,KAAA,MAAW,MAAU,IAAA,CAAC,QAAU,EAAA,SAAS,CAAY,EAAA;AACnD,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AACvB,MAAA,cAAA,CAAe,QAAQ,CAAgB,YAAA,KAAA;AACrC,QAAA,YAAA,CAAa,IAAK,EAAA,CAAA;AAAA,OACnB,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AAEA,EAAA,cAAA,CAAe,QAAQ,CAAgB,YAAA,KAAA;AACrC,IAAI,IAAA,OAAO,YAAa,CAAA,QAAA,KAAa,QAAU,EAAA;AAC7C,MAAA,IAAI,aAAa,QAAU,EAAA;AACzB,QAAM,MAAA,IAAI,MAAM,CAAuC,qCAAA,CAAA,CAAA,CAAA;AAAA,OACzD;AACA,MAAA,OAAA;AAAA,KACF;AAEA,IAAS,QAAA,CAAA,IAAA;AAAA,MACP,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAW,KAAA;AACrC,QAAa,YAAA,CAAA,IAAA,CAAK,SAAS,MAAM,CAAA,CAAA;AACjC,QAAa,YAAA,CAAA,IAAA,CAAK,QAAQ,OAAO,CAAA,CAAA;AAAA,OAClC,CAAA;AAAA,KACH,CAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAM,MAAA,OAAA,CAAQ,IAAI,QAAQ,CAAA,CAAA;AAC5B;;AC/Ea,MAAA,eAAA,GAAkB,OAAO,OAST,KAAA;AA5B7B,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA6BE,EAAM,MAAA,IAAA,GAAA,CAAO,EAAQ,GAAA,OAAA,CAAA,IAAA,KAAR,IAAgB,GAAA,EAAA,GAAA,MAAA,CAAA;AAC7B,EAAM,MAAA,SAAA,GAAA,CAAY,EAAQ,GAAA,OAAA,CAAA,SAAA,KAAR,IAAqB,GAAA,EAAA,GAAA,IAAA,CAAA;AACvC,EAAM,MAAA,WAAA,GAAA,CAAc,EAAQ,GAAA,OAAA,CAAA,WAAA,KAAR,IAAuB,GAAA,EAAA,GAAA,kBAAA,CAAA;AAE3C,EAAA,IAAI,SAAW,EAAA;AACb,IAAA,OAAO,MAAM,GAAA;AAAA,MACX,QAAA;AAAA,MACA;AAAA,QACE,KAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,UAAA;AAAA,QACA,IAAA;AAAA,QACA,CAAA,EAAG,OAAQ,CAAA,GAAA,EAAK,CAAA,SAAA,CAAA;AAAA,QAChB,IAAA;AAAA,QACA,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACf,KAAA;AAAA,QACA,GAAI,QAAQ,gBACR,GAAA,CAAC,gBAAgB,OAAQ,CAAA,gBAAgB,IACzC,EAAC;AAAA,QACL,GAAI,OAAQ,CAAA,aAAA,IAAiB,EAAC;AAAA,QAC9B,WAAA;AAAA,QACA,OAAA;AAAA,QACA,YAAA;AAAA,QACA,WAAW,IAAI,CAAA,CAAA;AAAA,QACf,GAAI,QAAQ,oBACR,GAAA,CAAC,iBAAiB,OAAQ,CAAA,oBAAoB,IAC9C,EAAC;AAAA,OACP;AAAA,MACA;AAAA,QACE,eAAe,OAAQ,CAAA,aAAA;AAAA,QACvB,eAAe,OAAQ,CAAA,aAAA;AAAA,OACzB;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAA,OAAO,MAAM,GAAA;AAAA,IACX,QAAA;AAAA,IACA;AAAA,MACE,OAAA;AAAA,MACA,YAAA;AAAA,MACA,aAAa,IAAI,CAAA,CAAA;AAAA,MACjB,GAAI,QAAQ,oBACR,GAAA,CAAC,iBAAiB,OAAQ,CAAA,oBAAoB,IAC9C,EAAC;AAAA,KACP;AAAA,IACA;AAAA,MACE,eAAe,OAAQ,CAAA,aAAA;AAAA,MACvB,eAAe,OAAQ,CAAA,aAAA;AAAA,KACzB;AAAA,GACF,CAAA;AACF;;;;;"}

package/dist/cjs/{serve-552eaafd.cjs.js → serve-bf2ff8e3.cjs.js}

@@ -7,7 +7,7 @@ var serveHandler = require('serve-handler');
 var http = require('http');
 var httpProxy = require('http-proxy');
 var utility = require('./utility-3c0df5a9.cjs.js');
-var mkdocsServer = require('./mkdocsServer-99ec8af2.cjs.js');
+var mkdocsServer = require('./mkdocsServer-107b8efd.cjs.js');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var fs = require('fs-extra');
 require('winston');
@@ -121,10 +121,12 @@ async function serve(opts) {
   const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;
   const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;
   const mkdocsExpectedDevAddr = opts.docker ? mkdocsDockerAddr : mkdocsLocalAddr;
-  const { path: mkdocsYmlPath, configIsTemporary } = await pluginTechdocsNode.getMkdocsYml(
-    "./",
-    opts.siteName
-  );
+  const mkdocsConfigFileName = opts.mkdocsConfigFileName;
+  const siteName = opts.siteName;
+  const { path: mkdocsYmlPath, configIsTemporary } = await pluginTechdocsNode.getMkdocsYml("./", {
+    name: siteName,
+    mkdocsConfigFileName
+  });
   let mkdocsServerHasStarted = false;
   const mkdocsLogFunc = (data) => {
     const logLines = data.toString().split("\n");
@@ -147,7 +149,8 @@ async function serve(opts) {
     dockerOptions: opts.dockerOption,
     useDocker: opts.docker,
     stdoutLogFunc: mkdocsLogFunc,
-    stderrLogFunc: mkdocsLogFunc
+    stderrLogFunc: mkdocsLogFunc,
+    mkdocsConfigFileName: mkdocsYmlPath
   });
   for (let attempt = 0; attempt < 30; attempt++) {
     await new Promise((r) => setTimeout(r, 3e3));
@@ -189,4 +192,4 @@ Opening browser.`
 }
 
 exports["default"] = serve;
-//# sourceMappingURL=serve-552eaafd.cjs.js.map
+//# sourceMappingURL=serve-bf2ff8e3.cjs.js.map

package/dist/cjs/serve-bf2ff8e3.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve-bf2ff8e3.cjs.js","sources":["../../src/lib/httpServer.ts","../../src/commands/serve/serve.ts"],"sourcesContent":["/*\n * Copyright 2020 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 serveHandler from 'serve-handler';\nimport http from 'http';\nimport httpProxy from 'http-proxy';\nimport { createLogger } from './utility';\n\nexport default class HTTPServer {\n  private readonly proxyEndpoint: string;\n  private readonly backstageBundleDir: string;\n  private readonly backstagePort: number;\n  private readonly mkdocsTargetAddress: string;\n  private readonly verbose: boolean;\n\n  constructor(\n    backstageBundleDir: string,\n    backstagePort: number,\n    mkdocsTargetAddress: string,\n    verbose: boolean,\n  ) {\n    this.proxyEndpoint = '/api/techdocs/';\n    this.backstageBundleDir = backstageBundleDir;\n    this.backstagePort = backstagePort;\n    this.mkdocsTargetAddress = mkdocsTargetAddress;\n    this.verbose = verbose;\n  }\n\n  // Create a Proxy for mkdocs server\n  private createProxy() {\n    const proxy = httpProxy.createProxyServer({\n      target: this.mkdocsTargetAddress,\n    });\n\n    return (request: http.IncomingMessage): [httpProxy, string] => {\n      // If the request path is prefixed with this.proxyEndpoint, remove it.\n      const proxyEndpointPath = new RegExp(`^${this.proxyEndpoint}`, 'i');\n      const forwardPath = request.url?.replace(proxyEndpointPath, '') || '';\n\n      return [proxy, forwardPath];\n    };\n  }\n\n  public async serve(): Promise<http.Server> {\n    return new Promise<http.Server>((resolve, reject) => {\n      const proxyHandler = this.createProxy();\n      const server = http.createServer(\n        (request: http.IncomingMessage, response: http.ServerResponse) => {\n          if (request.url?.startsWith(this.proxyEndpoint)) {\n            const [proxy, forwardPath] = proxyHandler(request);\n\n            proxy.on('error', (error: Error) => {\n              reject(error);\n            });\n\n            response.setHeader('Access-Control-Allow-Origin', '*');\n            response.setHeader('Access-Control-Allow-Methods', 'GET, OPTIONS');\n\n            request.url = forwardPath;\n            proxy.web(request, response);\n            return;\n          }\n\n          // This endpoint is used by the frontend to detect where the backend is running.\n          if (request.url === '/.detect') {\n            response.setHeader('Content-Type', 'text/plain');\n            response.end('techdocs-cli-server');\n            return;\n          }\n\n          serveHandler(request, response, {\n            public: this.backstageBundleDir,\n            trailingSlash: true,\n            rewrites: [{ source: '**', destination: 'index.html' }],\n          });\n        },\n      );\n\n      const logger = createLogger({ verbose: false });\n      server.listen(this.backstagePort, () => {\n        if (this.verbose) {\n          logger.info(\n            `[techdocs-preview-bundle] Running local version of Backstage at http://localhost:${this.backstagePort}`,\n          );\n        }\n        resolve(server);\n      });\n\n      server.on('error', (error: Error) => {\n        reject(error);\n      });\n    });\n  }\n}\n","/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport path from 'path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findPaths } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { createLogger } from '../../lib/utility';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\n\nfunction findPreviewBundlePath(): string {\n  try {\n    return path.join(\n      path.dirname(require.resolve('techdocs-cli-embedded-app/package.json')),\n      'dist',\n    );\n  } catch {\n    // If the techdocs-cli-embedded-app package is not available it means we're\n    // running a published package. For published packages the preview bundle is\n    // copied to dist/embedded-app be the prepack script.\n    //\n    // This can be tested by running `yarn pack` and extracting the resulting tarball into a directory.\n    // Within the extracted directory, run `npm install --only=prod`.\n    // Once that's done you can test the CLI in any directory using `node <tmp-dir>/package <command>`.\n    // eslint-disable-next-line no-restricted-syntax\n    return findPaths(__dirname).resolveOwn('dist/embedded-app');\n  }\n}\n\nfunction getPreviewAppPath(opts: OptionValues): string {\n  return opts.previewAppBundlePath ?? findPreviewBundlePath();\n}\n\nexport default async function serve(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  // Determine if we want to run in local dev mode or not\n  // This will run the backstage http server on a different port and only used\n  // for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)\n  const isDevMode = Object.keys(process.env).includes('TECHDOCS_CLI_DEV_MODE')\n    ? true\n    : false;\n\n  const backstageBackendPort = 7007;\n\n  const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;\n  const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;\n  const mkdocsExpectedDevAddr = opts.docker\n    ? mkdocsDockerAddr\n    : mkdocsLocalAddr;\n  const mkdocsConfigFileName = opts.mkdocsConfigFileName;\n  const siteName = opts.siteName;\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml('./', {\n    name: siteName,\n    mkdocsConfigFileName,\n  });\n\n  let mkdocsServerHasStarted = false;\n  const mkdocsLogFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !mkdocsServerHasStarted &&\n        line.includes(`Serving on ${mkdocsExpectedDevAddr}`)\n      ) {\n        mkdocsServerHasStarted = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n  logger.info('Starting mkdocs server.');\n  const mkdocsChildProcess = await runMkdocsServer({\n    port: opts.mkdocsPort,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    stdoutLogFunc: mkdocsLogFunc,\n    stderrLogFunc: mkdocsLogFunc,\n    mkdocsConfigFileName: mkdocsYmlPath,\n  });\n\n  // Wait until mkdocs server has started so that Backstage starts with docs loaded\n  // Takes 1-5 seconds\n  for (let attempt = 0; attempt < 30; attempt++) {\n    await new Promise(r => setTimeout(r, 3000));\n    if (mkdocsServerHasStarted) {\n      break;\n    }\n    logger.info('Waiting for mkdocs server to start...');\n  }\n\n  if (!mkdocsServerHasStarted) {\n    logger.error(\n      'mkdocs server did not start. Exiting. Try re-running command with -v option for more details.',\n    );\n  }\n\n  const port = isDevMode ? backstageBackendPort : opts.previewAppPort;\n  const previewAppPath = getPreviewAppPath(opts);\n  const httpServer = new HTTPServer(\n    previewAppPath,\n    port,\n    mkdocsExpectedDevAddr,\n    opts.verbose,\n  );\n\n  httpServer\n    .serve()\n    .catch(err => {\n      logger.error('Failed to start HTTP server', err);\n      mkdocsChildProcess.kill();\n      process.exit(1);\n    })\n    .then(() => {\n      // The last three things default/component/local/ don't matter. They can be anything.\n      openBrowser(`http://localhost:${port}/docs/default/component/local/`);\n      logger.info(\n        `Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/\\nOpening browser.`,\n      );\n    });\n\n  await waitForSignal([mkdocsChildProcess]);\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["httpProxy","http","serveHandler","createLogger","path","findPaths","getMkdocsYml","runMkdocsServer","openBrowser","waitForSignal","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqBA,MAAqB,UAAW,CAAA;AAAA,EAO9B,WACE,CAAA,kBAAA,EACA,aACA,EAAA,mBAAA,EACA,OACA,EAAA;AAXF,IAAiB,aAAA,CAAA,IAAA,EAAA,eAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,oBAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,eAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,qBAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AAQf,IAAA,IAAA,CAAK,aAAgB,GAAA,gBAAA,CAAA;AACrB,IAAA,IAAA,CAAK,kBAAqB,GAAA,kBAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,aAAgB,GAAA,aAAA,CAAA;AACrB,IAAA,IAAA,CAAK,mBAAsB,GAAA,mBAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AAAA,GACjB;AAAA;AAAA,EAGQ,WAAc,GAAA;AACpB,IAAM,MAAA,KAAA,GAAQA,8BAAU,iBAAkB,CAAA;AAAA,MACxC,QAAQ,IAAK,CAAA,mBAAA;AAAA,KACd,CAAA,CAAA;AAED,IAAA,OAAO,CAAC,OAAuD,KAAA;AA/CnE,MAAA,IAAA,EAAA,CAAA;AAiDM,MAAA,MAAM,oBAAoB,IAAI,MAAA,CAAO,IAAI,IAAK,CAAA,aAAa,IAAI,GAAG,CAAA,CAAA;AAClE,MAAA,MAAM,gBAAc,EAAQ,GAAA,OAAA,CAAA,GAAA,KAAR,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,CAAQ,mBAAmB,EAAO,CAAA,KAAA,EAAA,CAAA;AAEnE,MAAO,OAAA,CAAC,OAAO,WAAW,CAAA,CAAA;AAAA,KAC5B,CAAA;AAAA,GACF;AAAA,EAEA,MAAa,KAA8B,GAAA;AACzC,IAAA,OAAO,IAAI,OAAA,CAAqB,CAAC,OAAA,EAAS,MAAW,KAAA;AACnD,MAAM,MAAA,YAAA,GAAe,KAAK,WAAY,EAAA,CAAA;AACtC,MAAA,MAAM,SAASC,wBAAK,CAAA,YAAA;AAAA,QAClB,CAAC,SAA+B,QAAkC,KAAA;AA5D1E,UAAA,IAAA,EAAA,CAAA;AA6DU,UAAA,IAAA,CAAI,EAAQ,GAAA,OAAA,CAAA,GAAA,KAAR,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,UAAA,CAAW,KAAK,aAAgB,CAAA,EAAA;AAC/C,YAAA,MAAM,CAAC,KAAA,EAAO,WAAW,CAAA,GAAI,aAAa,OAAO,CAAA,CAAA;AAEjD,YAAM,KAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AAClC,cAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,aACb,CAAA,CAAA;AAED,YAAS,QAAA,CAAA,SAAA,CAAU,+BAA+B,GAAG,CAAA,CAAA;AACrD,YAAS,QAAA,CAAA,SAAA,CAAU,gCAAgC,cAAc,CAAA,CAAA;AAEjE,YAAA,OAAA,CAAQ,GAAM,GAAA,WAAA,CAAA;AACd,YAAM,KAAA,CAAA,GAAA,CAAI,SAAS,QAAQ,CAAA,CAAA;AAC3B,YAAA,OAAA;AAAA,WACF;AAGA,UAAI,IAAA,OAAA,CAAQ,QAAQ,UAAY,EAAA;AAC9B,YAAS,QAAA,CAAA,SAAA,CAAU,gBAAgB,YAAY,CAAA,CAAA;AAC/C,YAAA,QAAA,CAAS,IAAI,qBAAqB,CAAA,CAAA;AAClC,YAAA,OAAA;AAAA,WACF;AAEA,UAAAC,gCAAA,CAAa,SAAS,QAAU,EAAA;AAAA,YAC9B,QAAQ,IAAK,CAAA,kBAAA;AAAA,YACb,aAAe,EAAA,IAAA;AAAA,YACf,UAAU,CAAC,EAAE,QAAQ,IAAM,EAAA,WAAA,EAAa,cAAc,CAAA;AAAA,WACvD,CAAA,CAAA;AAAA,SACH;AAAA,OACF,CAAA;AAEA,MAAA,MAAM,MAAS,GAAAC,oBAAA,CAAa,EAAE,OAAA,EAAS,OAAO,CAAA,CAAA;AAC9C,MAAO,MAAA,CAAA,MAAA,CAAO,IAAK,CAAA,aAAA,EAAe,MAAM;AACtC,QAAA,IAAI,KAAK,OAAS,EAAA;AAChB,UAAO,MAAA,CAAA,IAAA;AAAA,YACL,CAAA,iFAAA,EAAoF,KAAK,aAAa,CAAA,CAAA;AAAA,WACxG,CAAA;AAAA,SACF;AACA,QAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAAA,OACf,CAAA,CAAA;AAED,MAAO,MAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AACnC,QAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,OACb,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;AC/EA,SAAS,qBAAgC,GAAA;AACvC,EAAI,IAAA;AACF,IAAA,OAAOC,wBAAK,CAAA,IAAA;AAAA,MACVA,wBAAK,CAAA,OAAA,CAAQ,OAAQ,CAAA,OAAA,CAAQ,wCAAwC,CAAC,CAAA;AAAA,MACtE,MAAA;AAAA,KACF,CAAA;AAAA,GACM,CAAA,MAAA;AASN,IAAA,OAAOC,mBAAU,CAAA,SAAS,CAAE,CAAA,UAAA,CAAW,mBAAmB,CAAA,CAAA;AAAA,GAC5D;AACF,CAAA;AAEA,SAAS,kBAAkB,IAA4B,EAAA;AA9CvD,EAAA,IAAA,EAAA,CAAA;AA+CE,EAAO,OAAA,CAAA,EAAA,GAAA,IAAA,CAAK,oBAAL,KAAA,IAAA,GAAA,EAAA,GAA6B,qBAAsB,EAAA,CAAA;AAC5D,CAAA;AAEA,eAA8B,MAAM,IAAoB,EAAA;AACtD,EAAA,MAAM,SAASF,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAKrD,EAAM,MAAA,SAAA,GAAY,OAAO,IAAK,CAAA,OAAA,CAAQ,GAAG,CAAE,CAAA,QAAA,CAAS,uBAAuB,CAAA,GACvE,IACA,GAAA,KAAA,CAAA;AAEJ,EAAA,MAAM,oBAAuB,GAAA,IAAA,CAAA;AAE7B,EAAM,MAAA,gBAAA,GAAmB,CAAkB,eAAA,EAAA,IAAA,CAAK,UAAU,CAAA,CAAA,CAAA;AAC1D,EAAM,MAAA,eAAA,GAAkB,CAAoB,iBAAA,EAAA,IAAA,CAAK,UAAU,CAAA,CAAA,CAAA;AAC3D,EAAM,MAAA,qBAAA,GAAwB,IAAK,CAAA,MAAA,GAC/B,gBACA,GAAA,eAAA,CAAA;AACJ,EAAA,MAAM,uBAAuB,IAAK,CAAA,oBAAA,CAAA;AAClC,EAAA,MAAM,WAAW,IAAK,CAAA,QAAA,CAAA;AAEtB,EAAA,MAAM,EAAE,IAAM,EAAA,aAAA,EAAe,mBAAsB,GAAA,MAAMG,gCAAa,IAAM,EAAA;AAAA,IAC1E,IAAM,EAAA,QAAA;AAAA,IACN,oBAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAA,IAAI,sBAAyB,GAAA,KAAA,CAAA;AAC7B,EAAA,MAAM,gBAAyB,CAAQ,IAAA,KAAA;AAErC,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,EAAA,CAAE,MAAM,IAAI,CAAA,CAAA;AAC3C,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,MAAA,GAAS,iBAAoB,GAAA,UAAA,CAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AACvB,MAAA,IAAI,SAAS,EAAI,EAAA;AACf,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAA,CAAO,OAAQ,CAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA,CAAA;AAGrC,MAAA,IACE,CAAC,sBACD,IAAA,IAAA,CAAK,SAAS,CAAc,WAAA,EAAA,qBAAqB,EAAE,CACnD,EAAA;AACA,QAAyB,sBAAA,GAAA,IAAA,CAAA;AAAA,OAC3B;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAIA,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA,CAAA;AACrC,EAAM,MAAA,kBAAA,GAAqB,MAAMC,4BAAgB,CAAA;AAAA,IAC/C,MAAM,IAAK,CAAA,UAAA;AAAA,IACX,aAAa,IAAK,CAAA,WAAA;AAAA,IAClB,kBAAkB,IAAK,CAAA,gBAAA;AAAA,IACvB,eAAe,IAAK,CAAA,YAAA;AAAA,IACpB,WAAW,IAAK,CAAA,MAAA;AAAA,IAChB,aAAe,EAAA,aAAA;AAAA,IACf,aAAe,EAAA,aAAA;AAAA,IACf,oBAAsB,EAAA,aAAA;AAAA,GACvB,CAAA,CAAA;AAID,EAAA,KAAA,IAAS,OAAU,GAAA,CAAA,EAAG,OAAU,GAAA,EAAA,EAAI,OAAW,EAAA,EAAA;AAC7C,IAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,CAAA,KAAK,UAAW,CAAA,CAAA,EAAG,GAAI,CAAC,CAAA,CAAA;AAC1C,IAAA,IAAI,sBAAwB,EAAA;AAC1B,MAAA,MAAA;AAAA,KACF;AACA,IAAA,MAAA,CAAO,KAAK,uCAAuC,CAAA,CAAA;AAAA,GACrD;AAEA,EAAA,IAAI,CAAC,sBAAwB,EAAA;AAC3B,IAAO,MAAA,CAAA,KAAA;AAAA,MACL,+FAAA;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,IAAA,GAAO,SAAY,GAAA,oBAAA,GAAuB,IAAK,CAAA,cAAA,CAAA;AACrD,EAAM,MAAA,cAAA,GAAiB,kBAAkB,IAAI,CAAA,CAAA;AAC7C,EAAA,MAAM,aAAa,IAAI,UAAA;AAAA,IACrB,cAAA;AAAA,IACA,IAAA;AAAA,IACA,qBAAA;AAAA,IACA,IAAK,CAAA,OAAA;AAAA,GACP,CAAA;AAEA,EACG,UAAA,CAAA,KAAA,EACA,CAAA,KAAA,CAAM,CAAO,GAAA,KAAA;AACZ,IAAO,MAAA,CAAA,KAAA,CAAM,+BAA+B,GAAG,CAAA,CAAA;AAC/C,IAAA,kBAAA,CAAmB,IAAK,EAAA,CAAA;AACxB,IAAA,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA;AAAA,GACf,CACA,CAAA,IAAA,CAAK,MAAM;AAEV,IAAYC,+BAAA,CAAA,CAAA,iBAAA,EAAoB,IAAI,CAAgC,8BAAA,CAAA,CAAA,CAAA;AACpE,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,iDAAiD,IAAI,CAAA;AAAA,gBAAA,CAAA;AAAA,KACvD,CAAA;AAAA,GACD,CAAA,CAAA;AAEH,EAAM,MAAAC,0BAAA,CAAc,CAAC,kBAAkB,CAAC,CAAA,CAAA;AAExC,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGC,sBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA,CAAA;AAAA,KAC5B,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/embedded-app/.config-schema.json

@@ -368,54 +368,6 @@
         "$schema": "http://json-schema.org/draft-07/schema#"
       }
     },
-    {
-      "path": "../../plugins/techdocs/config.d.ts",
-      "value": {
-        "type": "object",
-        "properties": {
-          "techdocs": {
-            "description": "Configuration options for the techdocs plugin",
-            "type": "object",
-            "properties": {
-              "builder": {
-                "description": "Documentation building process depends on the builder attr",
-                "visibility": "frontend",
-                "enum": [
-                  "external",
-                  "local"
-                ],
-                "type": "string"
-              },
-              "legacyUseCaseSensitiveTripletPaths": {
-                "description": "Allows fallback to case-sensitive triplets in case of migration issues.",
-                "visibility": "frontend",
-                "type": "boolean"
-              },
-              "sanitizer": {
-                "type": "object",
-                "properties": {
-                  "allowedIframeHosts": {
-                    "description": "Allows iframe tag only for listed hosts\nExample:\n allowedIframeHosts: [\"example.com\"]\n this will allow all iframes with the host `example.com` in the src attribute",
-                    "visibility": "frontend",
-                    "type": "array",
-                    "items": {
-                      "type": "string"
-                    }
-                  }
-                }
-              }
-            },
-            "required": [
-              "builder"
-            ]
-          }
-        },
-        "required": [
-          "techdocs"
-        ],
-        "$schema": "http://json-schema.org/draft-07/schema#"
-      }
-    },
     {
       "path": "../integration/config.d.ts",
       "value": {
@@ -445,7 +397,7 @@
                     },
                     "credential": {
                       "description": "The credential to use for requests.\n\nIf no credential is specified anonymous access is used.",
-                      "visibility": "secret",
+                      "deepVisibility": "secret",
                       "deprecated": "Use `credentials` instead.",
                       "type": "object",
                       "properties": {
@@ -465,7 +417,7 @@
                     },
                     "credentials": {
                       "description": "The credentials to use for requests. If multiple credentials are specified the first one that matches the organization is used.\nIf not organization matches the first credential without an organization is used.\n\nIf no credentials are specified at all, either a default credential (for Azure DevOps) or anonymous access (for Azure DevOps Server) is used.",
-                      "visibility": "secret",
+                      "deepVisibility": "secret",
                       "type": "array",
                       "items": {
                         "type": "object",
@@ -828,6 +780,101 @@
         "$schema": "http://json-schema.org/draft-07/schema#"
       }
     },
+    {
+      "path": "../../plugins/techdocs/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "techdocs": {
+            "description": "Configuration options for the techdocs plugin",
+            "type": "object",
+            "properties": {
+              "builder": {
+                "description": "Documentation building process depends on the builder attr",
+                "visibility": "frontend",
+                "enum": [
+                  "external",
+                  "local"
+                ],
+                "type": "string"
+              },
+              "legacyUseCaseSensitiveTripletPaths": {
+                "description": "Allows fallback to case-sensitive triplets in case of migration issues.",
+                "visibility": "frontend",
+                "type": "boolean"
+              },
+              "sanitizer": {
+                "type": "object",
+                "properties": {
+                  "allowedIframeHosts": {
+                    "description": "Allows iframe tag only for listed hosts\nExample:\n allowedIframeHosts: [\"example.com\"]\n this will allow all iframes with the host `example.com` in the src attribute",
+                    "visibility": "frontend",
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "builder"
+            ]
+          }
+        },
+        "required": [
+          "techdocs"
+        ],
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      }
+    },
+    {
+      "path": "../frontend-app-api/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "app": {
+            "type": "object",
+            "properties": {
+              "extensions": {
+                "deepVisibility": "frontend",
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "additionalProperties": {
+                      "anyOf": [
+                        {
+                          "type": "object",
+                          "properties": {
+                            "at": {
+                              "type": "string"
+                            },
+                            "extension": {
+                              "type": "string"
+                            },
+                            "config": {}
+                          }
+                        },
+                        {
+                          "type": [
+                            "string",
+                            "boolean"
+                          ]
+                        }
+                      ]
+                    }
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      }
+    },
     {
       "path": "../backend-common/config.d.ts",
       "value": {
@@ -925,9 +972,7 @@
                     }
                   },
                   {
-                    "enum": [
-                      true
-                    ],
+                    "const": true,
                     "type": "boolean"
                   }
                 ]
@@ -1052,9 +1097,7 @@
                     "properties": {
                       "store": {
                         "type": "string",
-                        "enum": [
-                          "memory"
-                        ]
+                        "const": "memory"
                       }
                     },
                     "required": [
@@ -1066,9 +1109,7 @@
                     "properties": {
                       "store": {
                         "type": "string",
-                        "enum": [
-                          "redis"
-                        ]
+                        "const": "redis"
                       },
                       "connection": {
                         "description": "A redis connection string in the form `redis://user:pass@host:port`.",
@@ -1086,9 +1127,7 @@
                     "properties": {
                       "store": {
                         "type": "string",
-                        "enum": [
-                          "memcache"
-                        ]
+                        "const": "memcache"
                       },
                       "connection": {
                         "description": "A memcache connection string in the form `user:pass@host:port`.",
@@ -1213,9 +1252,7 @@
                       }
                     },
                     {
-                      "enum": [
-                        false
-                      ],
+                      "const": false,
                       "type": "boolean"
                     }
                   ]
@@ -1227,7 +1264,20 @@
               "database",
               "listen"
             ]
-          },
+          }
+        },
+        "required": [
+          "app",
+          "backend"
+        ],
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      }
+    },
+    {
+      "path": "../backend-app-api/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
           "discovery": {
             "description": "Discovery options.",
             "type": "object",
@@ -1281,10 +1331,6 @@
             ]
           }
         },
-        "required": [
-          "app",
-          "backend"
-        ],
         "$schema": "http://json-schema.org/draft-07/schema#"
       }
     },

package/dist/embedded-app/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Backstage is an open platform for building developer portals"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"/><link rel="icon" href="/favicon.ico"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"/><title>Techdocs Preview App</title><script defer="defer" src="/static/runtime.04af2edd.js"></script><script defer="defer" src="/static/module-material-ui.1b712255.js"></script><script defer="defer" src="/static/module-lodash.8166f005.js"></script><script defer="defer" src="/static/module-date-fns.b8b6c380.js"></script><script defer="defer" src="/static/module-material-table.0f5635dd.js"></script><script defer="defer" src="/static/module-react-dom.07625e59.js"></script><script defer="defer" src="/static/module-react-router.8e9755f1.js"></script><script defer="defer" src="/static/module-react-router-dom.a0f835fd.js"></script><script defer="defer" src="/static/module-zod.c74c6842.js"></script><script defer="defer" src="/static/module-i18next.db8a27ed.js"></script><script defer="defer" src="/static/module-react-beautiful-dnd.62627182.js"></script><script defer="defer" src="/static/vendor.04af2edd.js"></script><script defer="defer" src="/static/main.04af2edd.js"></script></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Backstage is an open platform for building developer portals"/><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"/><link rel="icon" href="/favicon.ico"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"/><title>Techdocs Preview App</title><script defer="defer" src="/static/runtime.a4e3d2e1.js"></script><script defer="defer" src="/static/module-material-ui.bdbd8daa.js"></script><script defer="defer" src="/static/module-lodash.adfd55fe.js"></script><script defer="defer" src="/static/module-date-fns.b8b6c380.js"></script><script defer="defer" src="/static/module-material-table.0f5635dd.js"></script><script defer="defer" src="/static/module-react-dom.07625e59.js"></script><script defer="defer" src="/static/module-react-router.652daaf3.js"></script><script defer="defer" src="/static/module-react-router-dom.65ce4c09.js"></script><script defer="defer" src="/static/module-zod.9e0f365e.js"></script><script defer="defer" src="/static/module-i18next.db8a27ed.js"></script><script defer="defer" src="/static/module-react-beautiful-dnd.62627182.js"></script><script defer="defer" src="/static/vendor.a4e3d2e1.js"></script><script defer="defer" src="/static/main.a4e3d2e1.js"></script></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>

package/dist/embedded-app/static/1032.d8d4547a.chunk.js

@@ -0,0 +1,5 @@
+"use strict";(()=>{(self.webpackChunktechdocs_cli_embedded_app=self.webpackChunktechdocs_cli_embedded_app||[]).push([[1032],{27597:function(z,g,t){var e,T=t(71600),x=t(34590);e={value:!0},g.Z=void 0;var c=x(t(2784)),f=T(t(50175)),L=(0,f.default)(c.createElement("path",{d:"M12 4l-1.41 1.41L16.17 11H4v2h12.17l-5.58 5.59L12 20l8-8z"}),"ArrowForward");g.Z=L},29862:function(z,g,t){t.d(g,{t:function(){return T}});var e=t(2784);function T(x){x===void 0&&(x=!1);var c=(0,e.useRef)(x),f=(0,e.useCallback)(function(){return c.current},[]);return(0,e.useEffect)(function(){return c.current=!0,function(){c.current=!1}},[]),f}},15277:function(z,g,t){var e,T,x;(function(c,f){if(!0)T=[g,t(2784),t(13980)],e=f,x=typeof e=="function"?e.apply(g,T):e,x!==void 0&&(z.exports=x);else var L})(void 0,function(c,f,L){"use strict";Object.defineProperty(c,"__esModule",{value:!0}),c.default=void 0;var M=Z(f),d=Z(L);function Z(a){return a&&a.__esModule?a:{default:a}}function l(a){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?l=function(r){return typeof r}:l=function(r){return r&&typeof Symbol=="function"&&r.constructor===Symbol&&r!==Symbol.prototype?"symbol":typeof r},l(a)}function R(a,o){if(a==null)return{};var r=h(a,o),n,i;if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(a);for(i=0;i<s.length;i++)n=s[i],!(o.indexOf(n)>=0)&&Object.prototype.propertyIsEnumerable.call(a,n)&&(r[n]=a[n])}return r}function h(a,o){if(a==null)return{};var r={},n=Object.keys(a),i,s;for(s=0;s<n.length;s++)i=n[s],!(o.indexOf(i)>=0)&&(r[i]=a[i]);return r}function j(a,o){if(!(a instanceof o))throw new TypeError("Cannot call a class as a function")}function W(a,o){for(var r=0;r<o.length;r++){var n=o[r];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(a,n.key,n)}}function B(a,o,r){return o&&W(a.prototype,o),r&&W(a,r),a}function y(a,o){return o&&(l(o)==="object"||typeof o=="function")?o:O(a)}function D(a){return D=Object.setPrototypeOf?Object.getPrototypeOf:function(r){return r.__proto__||Object.getPrototypeOf(r)},D(a)}function O(a){if(a===void 0)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return a}function C(a,o){if(typeof o!="function"&&o!==null)throw new TypeError("Super expression must either be null or a function");a.prototype=Object.create(o&&o.prototype,{constructor:{value:a,writable:!0,configurable:!0}}),o&&p(a,o)}function p(a,o){return p=Object.setPrototypeOf||function(n,i){return n.__proto__=i,n},p(a,o)}function b(a,o,r){return o in a?Object.defineProperty(a,o,{value:r,enumerable:!0,configurable:!0,writable:!0}):a[o]=r,a}var $=1e-4,I=function(o,r){return Math.abs(o-r)<$},m=function(a){C(o,a);function o(){var r,n;j(this,o);for(var i=arguments.length,s=new Array(i),P=0;P<i;P++)s[P]=arguments[P];return n=y(this,(r=D(o)).call.apply(r,[this].concat(s))),b(O(n),"onResize",function(){n.rafId&&window.cancelAnimationFrame(n.rafId),n.rafId=window.requestAnimationFrame(n.update.bind(O(n)))}),b(O(n),"onToggled",function(E){typeof n.props.onToggled=="function"&&setTimeout(function(){return n.props.onToggled(E)},0)}),b(O(n),"onTruncated",function(){typeof n.props.onTruncated=="function"&&setTimeout(function(){return n.props.onTruncated()},0)}),b(O(n),"onCalculated",function(){typeof n.props.onCalculated=="function"&&setTimeout(function(){return n.props.onCalculated()},0)}),b(O(n),"update",function(){var E=window.getComputedStyle(n.scope),K=[E["font-weight"],E["font-style"],E["font-size"],E["font-family"],E["letter-spacing"]].join(" ");n.canvas.font=K,n.forceUpdate()}),n}return B(o,[{key:"componentDidMount",value:function(){var n=document.createElement("canvas"),i=document.createDocumentFragment(),s=window.getComputedStyle(this.scope),P=[s["font-weight"],s["font-style"],s["font-size"],s["font-family"]].join(" ");i.appendChild(n),this.canvas=n.getContext("2d"),this.canvas.font=P,this.forceUpdate(),window.addEventListener("resize",this.onResize)}},{key:"componentWillUnmount",value:function(){window.removeEventListener("resize",this.onResize),this.rafId&&window.cancelAnimationFrame(this.rafId)}},{key:"measureWidth",value:function(n){return this.canvas.measureText(n).width}},{key:"getRenderText",value:function(){var n=this.props,i=n.containerClassName,s=n.element,P=n.line,E=n.onCalculated,K=n.onTruncated,w=n.onToggled,u=n.text,F=n.textElement,S=n.textTruncateChild,J=n.truncateText,tt=n.maxCalculateTimes,V=R(n,["containerClassName","element","line","onCalculated","onTruncated","onToggled","text","textElement","textTruncateChild","truncateText","maxCalculateTimes"]),H=this.scope.getBoundingClientRect().width;if(H===0)return null;var q=this.measureWidth(u);if(H>q||I(H,q))return this.onToggled(!1),(0,f.createElement)(F,V,u);var G="";if(S&&typeof S.type=="string"){var _=S.type;(_.indexOf("span")>=0||_.indexOf("a")>=0)&&(G=S.props.children)}for(var v=1,N=u.length,A="",k=0,U=0,X=P,Y=0,Q=!1,rt=!1,et=0,nt=-1,ot="",at=0;X-- >0;){for(ot=X?"":J+(G?" "+G:"");v<=N;)if(A=u.substr(U,v),Y=this.measureWidth(A+ot),Y<H)k=u.indexOf(" ",v+1),k===-1?(v+=1,Q=!1):(Q=!0,v=k);else{do{if(at++>=tt)break;A=u.substr(U,v),X||v--,A[A.length-1]===" "&&(A=u.substr(U,v-1)),Q?(nt=A.lastIndexOf(" "),nt>-1?(v=nt,X&&v++,A=u.substr(U,v)):(v--,A=u.substr(U,v))):(v--,A=u.substr(U,v)),Y=this.measureWidth(A+ot)}while((Y>H||I(Y,H))&&A.length>0);U+=v;break}if(v>=N){U=N;break}Q&&!rt&&u.substr(et,v).indexOf(" ")===-1&&(rt=u.substr(et,v).indexOf(" ")===-1,X--),et=v+1}return U===N?(this.onToggled(!1),(0,f.createElement)(F,V,u)):(this.onTruncated(),this.onToggled(!0),M.default.createElement("span",V,(0,f.createElement)(F,V,u.substr(0,U)+J+" "),S))}},{key:"render",value:function(){var n=this,i=this.props,s=i.element,P=i.text,E=i.style,K=E===void 0?{}:E,w=i.containerClassName,u=i.line,F=i.onCalculated,S=i.onTruncated,J=i.onToggled,tt=i.textElement,V=i.textTruncateChild,H=i.truncateText,q=i.maxCalculateTimes,G=R(i,["element","text","style","containerClassName","line","onCalculated","onTruncated","onToggled","textElement","textTruncateChild","truncateText","maxCalculateTimes"]),_=K.fontWeight,v=K.fontStyle,N=K.fontSize,A=K.fontFamily,k=this.scope&&u?this.getRenderText():(0,f.createElement)(tt,G,P),U={ref:function(Y){n.scope=Y},className:w,style:{overflow:"hidden",fontWeight:_,fontStyle:v,fontSize:N,fontFamily:A}};return this.scope&&this.onCalculated(),(0,f.createElement)(s,U,k)}}]),o}(f.Component);b(m,"propTypes",{containerClassName:d.default.string,element:d.default.string,line:d.default.oneOfType([d.default.number,d.default.bool]),onCalculated:d.default.func,onTruncated:d.default.func,onToggled:d.default.func,text:d.default.string,textElement:d.default.elementType,textTruncateChild:d.default.node,truncateText:d.default.string,maxCalculateTimes:d.default.number}),b(m,"defaultProps",{element:"div",line:1,text:"",textElement:"span",truncateText:"\u2026",maxCalculateTimes:10}),c.default=m,z.exports=c.default})},59119:function(z,g,t){t.d(g,{O:function(){return Z}});var e=t(52322),T=t(79692),x=t(80030),c=t(2784),f=t(15277),L=t.n(f),M=t(29862);const d=(0,T.Z)({container:{overflow:"visible !important"}},{name:"BackstageOverflowTooltip"});function Z(l){const[R,h]=(0,c.useState)(!1),j=(0,M.t)(),W=d(),B=D=>{j()&&h(D)};var y;return(0,e.jsx)(x.ZP,{title:(y=l.title)!==null&&y!==void 0?y:l.text||"",placement:l.placement,disableHoverListener:!R,children:(0,e.jsx)(L(),{text:l.text,line:l.line,onToggled:B,containerClassName:W.container})})}},1546:function(z,g,t){t.d(g,{r:function(){return a}});var e=t(52322),T=t(94339),x=t(14503),c=t(24579),f=t(32552),L=t(85256),M=t(79692),d=t(15459),Z=t(72779),l=t.n(Z),R=t(2784),h=t(62774),j=t(90436),W=t(27597),B=t(98864);const y=(0,M.Z)(o=>({root:{maxWidth:"fit-content",padding:o.spacing(2,2,2,2.5)},boxTitle:{margin:0,color:o.palette.textSubtle},arrow:{color:o.palette.textSubtle}}),{name:"BackstageBottomLink"});function D(o){const{link:r,title:n,onClick:i}=o,s=y();return(0,e.jsxs)(h.Z,{children:[(0,e.jsx)(L.Z,{}),(0,e.jsx)(B.rU,{to:r,onClick:i,underline:"none",children:(0,e.jsxs)(h.Z,{display:"flex",alignItems:"center",className:s.root,children:[(0,e.jsx)(h.Z,{className:s.boxTitle,fontWeight:"fontWeightBold",m:1,children:(0,e.jsx)(j.Z,{children:(0,e.jsx)("strong",{children:n})})}),(0,e.jsx)(W.Z,{className:s.arrow})]})})]})}var O=t(15929),C=t(74359);const p=o=>{const{slackChannel:r}=o;if(r){if(typeof r=="string")return(0,e.jsxs)(j.Z,{children:["Please contact ",r," for help."]});if(!r.href)return(0,e.jsxs)(j.Z,{children:["Please contact ",r.name," for help."]})}else return null;return(0,e.jsx)(O.Q,{to:r.href,variant:"contained",children:r.name})},b=class extends R.Component{componentDidCatch(r,n){console.error(`ErrorBoundary, error: ${r}, info: ${n}`),this.setState({error:r,errorInfo:n})}render(){const{slackChannel:r,children:n}=this.props,{error:i}=this.state;return i?(0,e.jsx)(C.y,{title:"Something Went Wrong",error:i,children:(0,e.jsx)(p,{slackChannel:r})}):n}constructor(r){super(r),this.state={error:void 0,errorInfo:void 0}}},$=(0,M.Z)(o=>({noPadding:{padding:0,"&:last-child":{paddingBottom:0}},header:{padding:o.spacing(2,2,2,2.5)},headerTitle:{fontWeight:o.typography.fontWeightBold},headerSubheader:{paddingTop:o.spacing(1)},headerAvatar:{},headerAction:{},headerContent:{},subheader:{display:"flex"}}),{name:"BackstageInfoCard"}),I=(0,d.Z)(o=>({root:{display:"inline-block",padding:o.spacing(8,8,0,0),float:"right"}}),{name:"BackstageInfoCardCardActionsTopRight"})(x.Z),m={card:{flex:{display:"flex",flexDirection:"column"},fullHeight:{display:"flex",flexDirection:"column",height:"100%"},gridItem:{display:"flex",flexDirection:"column",height:"calc(100% - 10px)",marginBottom:"10px",breakInside:"avoid-page","@media print":{height:"auto"}}},cardContent:{fullHeight:{flex:1},gridItem:{flex:1}}};function a(o){const{title:r,subheader:n,divider:i=!0,deepLink:s,slackChannel:P,errorBoundaryProps:E,variant:K,children:w,headerStyle:u,headerProps:F,icon:S,action:J,actionsClassName:tt,actions:V,cardClassName:H,actionsTopRight:q,className:G,noPadding:_,titleTypographyProps:v}=o,N=$();let A={},k={};K&&K.split(/[\s]+/g).forEach(Q=>{A={...A,...m.card[Q]},k={...k,...m.cardContent[Q]}});const U=()=>!n&&!S?null:(0,e.jsxs)("div",{className:N.headerSubheader,"data-testid":"info-card-subheader",children:[n&&(0,e.jsx)("div",{className:N.subheader,children:n}),S]}),X=E||(P?{slackChannel:P}:{});return(0,e.jsx)(T.Z,{style:A,className:G,children:(0,e.jsxs)(b,{...X,children:[r&&(0,e.jsx)(f.Z,{classes:{root:N.header,title:N.headerTitle,subheader:N.headerSubheader,avatar:N.headerAvatar,action:N.headerAction,content:N.headerContent},title:r,subheader:U(),action:J,style:{...u},titleTypographyProps:v,...F}),q&&(0,e.jsx)(I,{children:q}),i&&(0,e.jsx)(L.Z,{}),(0,e.jsx)(c.Z,{className:l()(H,{[N.noPadding]:_}),style:k,children:w}),V&&(0,e.jsx)(x.Z,{className:tt,children:V}),s&&(0,e.jsx)(D,{...s})]})})}},48283:function(z,g,t){t.d(g,{u:function(){return B}});var e=t(52322),T=t(79692),x=t(2784),c=t(8709),f=t(59119),L=t(75435),M=t(86540),d=t(41748),Z=t(68138);const l=Object.freeze({createEntityRefColumn(y){const{defaultKind:D}=y;function O(C){var p;return((p=C.metadata)===null||p===void 0?void 0:p.title)||(0,M.$)(C,{defaultKind:D})}return{title:"Name",highlight:!0,customFilterAndSearch(C,p){return O(p).includes(C)},customSort(C,p){return O(C).localeCompare(O(p))},render:C=>{var p;return(0,e.jsx)(d.d,{entityRef:C,defaultKind:D,title:(p=C.metadata)===null||p===void 0?void 0:p.title})}}},createEntityRelationColumn(y){const{title:D,relation:O,defaultKind:C,filter:p}=y;function b(I){return(0,L.h)(I,O,p)}function $(I){return b(I).map(m=>(0,M.$)(m,{defaultKind:C})).join(", ")}return{title:D,customFilterAndSearch(I,m){return $(m).includes(I)},customSort(I,m){return $(I).localeCompare($(m))},render:I=>(0,e.jsx)(Z.r,{entityRefs:b(I),defaultKind:C})}},createOwnerColumn(){return this.createEntityRelationColumn({title:"Owner",relation:c.S4,defaultKind:"group"})},createDomainColumn(){return this.createEntityRelationColumn({title:"Domain",relation:c.cz,defaultKind:"domain",filter:{kind:"domain"}})},createSystemColumn(){return this.createEntityRelationColumn({title:"System",relation:c.cz,defaultKind:"system",filter:{kind:"system"}})},createMetadataDescriptionColumn(){return{title:"Description",field:"metadata.description",render:y=>(0,e.jsx)(f.O,{text:y.metadata.description,placement:"bottom-start",line:2})}},createSpecLifecycleColumn(){return{title:"Lifecycle",field:"spec.lifecycle"}},createSpecTypeColumn(){return{title:"Type",field:"spec.type"}}}),R=[l.createEntityRefColumn({defaultKind:"system"}),l.createDomainColumn(),l.createOwnerColumn(),l.createMetadataDescriptionColumn()],h=[l.createEntityRefColumn({defaultKind:"component"}),l.createSystemColumn(),l.createOwnerColumn(),l.createSpecTypeColumn(),l.createSpecLifecycleColumn(),l.createMetadataDescriptionColumn()];var j=t(84462);const W=(0,T.Z)(y=>({empty:{padding:y.spacing(2),display:"flex",justifyContent:"center"}})),B=y=>{const{entities:D,title:O,emptyContent:C,variant:p="gridItem",columns:b,tableOptions:$={}}=y,I=W(),m={minWidth:"0",width:"100%"};return p==="gridItem"&&(m.height="calc(100% - 10px)"),(0,e.jsx)(j.i,{columns:b,title:O,style:m,emptyContent:C&&(0,e.jsx)("div",{className:I.empty,children:C}),options:{search:!1,paging:!1,actionsColumnIndex:-1,padding:"dense",draggable:!1,...$},data:D})};B.columns=l,B.systemEntityColumns=R,B.componentEntityColumns=h},96641:function(z,g,t){t.d(g,{X2:function(){return l},h$:function(){return d}});var e=t(52322),T=t(74314),x=t(72388),c=t(29651),f=t(68993),L=t(2784);const M=(0,c.CT)("entity-context"),d=h=>{const{children:j,entity:W,loading:B,error:y,refresh:D}=h,O={entity:W,loading:B,error:y,refresh:D};return(0,e.jsx)(M.Provider,{value:(0,f.E)({1:O}),children:(0,e.jsx)(x.fC,{attributes:{...W?{entityRef:(0,T.eE)(W)}:void 0},children:j})})},Z=h=>_jsx(d,{entity:h.entity,loading:!Boolean(h.entity),error:void 0,refresh:void 0,children:h.children});function l(){const h=(0,c.Vt)("entity-context");if(!h)throw new Error("Entity context is not available");const j=h.atVersion(1);if(!j)throw new Error("EntityContext v1 not available");if(!j.entity)throw new Error("useEntity hook is being called outside of an EntityLayout where the entity has not been loaded. If this is intentional, please use useAsyncEntity instead.");return{entity:j.entity}}function R(){const h=useVersionedContext("entity-context");if(!h)throw new Error("Entity context is not available");const j=h.atVersion(1);if(!j)throw new Error("EntityContext v1 not available");const{entity:W,loading:B,error:y,refresh:D}=j;return{entity:W,loading:B,error:y,refresh:D}}},81032:function(z,g,t){t.r(g),t.d(g,{DependsOnResourcesCard:function(){return L}});var e=t(52322),T=t(8709),x=t(2784),c=t(19431),f=t(30083);function L(M){const{variant:d="gridItem",title:Z="Depends on resources",columns:l=c.xp,tableOptions:R={}}=M;return(0,e.jsx)(f.f,{variant:d,title:Z,entityKind:"Resource",relationType:T.nP,columns:l,emptyMessage:"No resource is a dependency of this component",emptyHelpLink:c.AE,asRenderableEntities:c.$c,tableOptions:R})}},30083:function(z,g,t){t.d(g,{f:function(){return I}});var e=t(52322),T=t(90436),x=t(96641),c=t(74314),f=t(44394),L=t(64279),M=t(88624);function d(m,a){var o,r;const n=a==null||(o=a.type)===null||o===void 0?void 0:o.toLocaleLowerCase("en-US"),i=a==null||(r=a.kind)===null||r===void 0?void 0:r.toLocaleLowerCase("en-US"),s=(0,f.h_)(M.A),{loading:P,value:E,error:K}=(0,L.default)(async()=>{var w;const u=(w=m.relations)===null||w===void 0?void 0:w.filter(S=>(!n||S.type.toLocaleLowerCase("en-US")===n)&&(!i||(0,c.of)(S.targetRef).kind===i));if(!(u!=null&&u.length))return[];const{items:F}=await s.getEntitiesByRefs({entityRefs:u.map(S=>S.targetRef)});return F.filter(S=>Boolean(S))},[m,n,i]);return{entities:E,loading:P,error:K}}var Z=t(48283),l=t(2784),R=t(1546),h=t(55015),j=t(79692),W=t(85256),B=t(38402),y=t(49378),D=t(9791),O=t(58033),C=t(74359);const p=(0,j.Z)(m=>({text:{fontFamily:"monospace",whiteSpace:"pre",overflowX:"auto",marginRight:m.spacing(2)},divider:{margin:m.spacing(2)}}),{name:"BackstageResponseErrorPanel"});function b(m){var a;const{title:o,error:r,defaultExpanded:n}=m,i=p();if(r.name!=="ResponseError")return(0,e.jsx)(C.y,{title:o!=null?o:r.message,defaultExpanded:n,error:r});const{body:s,cause:P}=r,{request:E,response:K}=s,w=`${K.statusCode}: ${P.name}`,u=E&&`${E.method} ${E.url}`,F=P.message.replace(/\\n/g,`
+`),S=(a=P.stack)===null||a===void 0?void 0:a.replace(/\\n/g,`
+`),J=JSON.stringify(s,void 0,2);return(0,e.jsxs)(C.y,{title:o!=null?o:r.message,defaultExpanded:n,error:{name:w,message:F,stack:S},children:[u&&(0,e.jsxs)(B.Z,{alignItems:"flex-start",children:[(0,e.jsx)(y.Z,{classes:{secondary:i.text},primary:"Request",secondary:E?`${u}`:void 0}),(0,e.jsx)(O.b,{text:u})]}),(0,e.jsxs)(e.Fragment,{children:[(0,e.jsx)(W.Z,{component:"li",className:i.divider}),(0,e.jsx)(B.Z,{alignItems:"flex-start",children:(0,e.jsx)(y.Z,{classes:{secondary:i.text},primary:"Full Error as JSON"})}),(0,e.jsx)(D.O,{language:"json",text:J,showCopyCodeButton:!0})]})]})}var $=t(98864);function I(m){const{variant:a="gridItem",title:o,columns:r,entityKind:n,relationType:i,emptyMessage:s,emptyHelpLink:P,asRenderableEntities:E,tableOptions:K={}}=m,{entity:w}=(0,x.X2)(),{entities:u,loading:F,error:S}=d(w,{type:i,kind:n});return F?(0,e.jsx)(R.r,{variant:a,title:o,children:(0,e.jsx)(h.E,{})}):S?(0,e.jsx)(R.r,{variant:a,title:o,children:(0,e.jsx)(b,{error:S})}):(0,e.jsx)(Z.u,{title:o,variant:a,emptyContent:(0,e.jsxs)("div",{style:{textAlign:"center"},children:[(0,e.jsx)(T.Z,{variant:"body1",children:s}),(0,e.jsx)(T.Z,{variant:"body2",children:(0,e.jsx)($.rU,{to:P,children:"Learn how to change this."})})]}),columns:r,entities:E(u||[]),tableOptions:K})}},19431:function(z,g,t){t.d(g,{$c:function(){return M},AE:function(){return x},D:function(){return c},G5:function(){return Z},Uc:function(){return L},_v:function(){return d},el:function(){return l},we:function(){return T},xp:function(){return f}});var e=t(48283);const T=[e.u.columns.createEntityRefColumn({defaultKind:"component"}),e.u.columns.createOwnerColumn(),e.u.columns.createSpecTypeColumn(),e.u.columns.createSpecLifecycleColumn(),e.u.columns.createMetadataDescriptionColumn()],x="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component",c=R=>R,f=[e.u.columns.createEntityRefColumn({defaultKind:"resource"}),e.u.columns.createOwnerColumn(),e.u.columns.createSpecTypeColumn(),e.u.columns.createSpecLifecycleColumn(),e.u.columns.createMetadataDescriptionColumn()],L="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-resource",M=R=>R,d=[e.u.columns.createEntityRefColumn({defaultKind:"system"}),e.u.columns.createOwnerColumn(),e.u.columns.createMetadataDescriptionColumn()],Z="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-system",l=R=>R}}]);})();
+
+//# sourceMappingURL=1032.d8d4547a.chunk.js.map