@techdocs/cli 1.8.25 → 1.9.0-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +2 -1
- package/dist/commands/index.cjs.js +13 -7
- package/dist/commands/index.cjs.js.map +1 -1
- package/dist/embedded-app/.config-schema.json +178 -46
- package/dist/embedded-app/index.html +1 -1
- package/dist/embedded-app/index.html.tmpl +1 -1
- package/dist/embedded-app/static/{124.f02a9318.chunk.js → 124.9c3315bf.chunk.js} +2 -2
- package/dist/embedded-app/static/{124.f02a9318.chunk.js.map → 124.9c3315bf.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{2401.4d69c234.chunk.js → 2401.480d3231.chunk.js} +2 -2
- package/dist/embedded-app/static/{2401.4d69c234.chunk.js.map → 2401.480d3231.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{2420.979e1d31.chunk.js → 2420.02740444.chunk.js} +2 -2
- package/dist/embedded-app/static/{2420.979e1d31.chunk.js.map → 2420.02740444.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{287.e0b65890.chunk.js → 287.0a1ae361.chunk.js} +2 -2
- package/dist/embedded-app/static/{287.e0b65890.chunk.js.map → 287.0a1ae361.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{3182.0ac241c5.chunk.js → 3182.8be35725.chunk.js} +2 -2
- package/dist/embedded-app/static/{3182.0ac241c5.chunk.js.map → 3182.8be35725.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{3632.f343436e.chunk.js → 3632.75f621ce.chunk.js} +2 -2
- package/dist/embedded-app/static/{3632.f343436e.chunk.js.map → 3632.75f621ce.chunk.js.map} +1 -1
- package/dist/embedded-app/static/5470.1a28734c.chunk.js +3 -0
- package/dist/embedded-app/static/5470.1a28734c.chunk.js.map +1 -0
- package/dist/embedded-app/static/{5788.b8d84f8c.chunk.js → 5788.cd9a99f1.chunk.js} +1 -1
- package/dist/embedded-app/static/5788.cd9a99f1.chunk.js.map +1 -0
- package/dist/embedded-app/static/{6271.020ea145.chunk.js → 6271.1007bfa8.chunk.js} +2 -2
- package/dist/embedded-app/static/{6271.020ea145.chunk.js.map → 6271.1007bfa8.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{6415.493349e2.chunk.js → 6415.8cce89fe.chunk.js} +2 -2
- package/dist/embedded-app/static/{6415.493349e2.chunk.js.map → 6415.8cce89fe.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{8307.b0a2a85f.chunk.js → 8307.cf92a830.chunk.js} +2 -2
- package/dist/embedded-app/static/{8307.b0a2a85f.chunk.js.map → 8307.cf92a830.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{8384.b9605cda.chunk.js → 8384.604de781.chunk.js} +2 -2
- package/dist/embedded-app/static/{8384.b9605cda.chunk.js.map → 8384.604de781.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{8803.20e0d00b.chunk.js → 8803.511872f8.chunk.js} +1 -1
- package/dist/embedded-app/static/{8803.20e0d00b.chunk.js.map → 8803.511872f8.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{9652.78fa0c73.chunk.js → 9652.be70f990.chunk.js} +2 -2
- package/dist/embedded-app/static/{9652.78fa0c73.chunk.js.map → 9652.be70f990.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{main.01d08696.js → main.a2e1e30a.js} +27 -27
- package/dist/embedded-app/static/main.a2e1e30a.js.map +1 -0
- package/dist/embedded-app/static/{module-material-table.84f30b2f.js → module-material-table.d6e8d890.js} +2 -2
- package/dist/embedded-app/static/{module-material-table.84f30b2f.js.map → module-material-table.d6e8d890.js.map} +1 -1
- package/dist/embedded-app/static/module-material-ui.b24ef3a3.js +24 -0
- package/dist/embedded-app/static/module-material-ui.b24ef3a3.js.map +1 -0
- package/dist/embedded-app/static/{react-syntax-highlighter_languages_highlight_lisp.4f6018a3.chunk.js → react-syntax-highlighter_languages_highlight_lisp.75c1c83e.chunk.js} +2 -2
- package/dist/embedded-app/static/{react-syntax-highlighter_languages_highlight_lisp.4f6018a3.chunk.js.map → react-syntax-highlighter_languages_highlight_lisp.75c1c83e.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{runtime.01d08696.js → runtime.a2e1e30a.js} +2 -2
- package/dist/embedded-app/static/{runtime.01d08696.js.map → runtime.a2e1e30a.js.map} +1 -1
- package/dist/embedded-app/static/{vendor.01d08696.js → vendor.a2e1e30a.js} +43 -43
- package/dist/embedded-app/static/vendor.a2e1e30a.js.map +1 -0
- package/dist/lib/PublisherConfig.cjs.js +4 -1
- package/dist/lib/PublisherConfig.cjs.js.map +1 -1
- package/dist/package.json.cjs.js +1 -1
- package/package.json +7 -7
- package/dist/embedded-app/static/4487.f04b8beb.chunk.js +0 -3
- package/dist/embedded-app/static/4487.f04b8beb.chunk.js.map +0 -1
- package/dist/embedded-app/static/5788.b8d84f8c.chunk.js.map +0 -1
- package/dist/embedded-app/static/main.01d08696.js.map +0 -1
- package/dist/embedded-app/static/module-material-ui.909829ed.js +0 -24
- package/dist/embedded-app/static/module-material-ui.909829ed.js.map +0 -1
- package/dist/embedded-app/static/vendor.01d08696.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @techdocs/cli
|
|
2
2
|
|
|
3
|
+
## 1.9.0-next.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 8de3d2d: Allow configurable optional retries for publisher AWS S3 operations.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 69f84ac: Internal update to work with dynamic imports.
|
|
12
|
+
- Updated dependencies
|
|
13
|
+
- @backstage/backend-defaults@0.8.0-next.0
|
|
14
|
+
- @backstage/plugin-techdocs-node@1.13.0-next.0
|
|
15
|
+
- @backstage/catalog-model@1.7.3
|
|
16
|
+
- @backstage/cli-common@0.1.15
|
|
17
|
+
- @backstage/config@1.3.2
|
|
18
|
+
|
|
3
19
|
## 1.8.25
|
|
4
20
|
|
|
5
21
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -44,7 +44,8 @@ yarn techdocs-cli:dev [...options]
|
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
46
|
# Prior to executing the techdocs-cli command
|
|
47
|
-
export
|
|
47
|
+
export GLOBAL_AGENT_HTTP_PROXY=${HTTP_PROXY}
|
|
48
|
+
export GLOBAL_AGENT_HTTPS_PROXY=${HTTPS_PROXY}
|
|
48
49
|
export GLOBAL_AGENT_NO_PROXY=${NO_PROXY}
|
|
49
50
|
```
|
|
50
51
|
|
|
@@ -46,7 +46,7 @@ function registerCommands(program) {
|
|
|
46
46
|
"--runAsDefaultUser",
|
|
47
47
|
"Bypass setting the container user as the same user and group id as host for Linux and MacOS",
|
|
48
48
|
false
|
|
49
|
-
).alias("build").action(lazy(() =>
|
|
49
|
+
).alias("build").action(lazy(() => import('./generate/generate.cjs.js'), "default"));
|
|
50
50
|
program.command("migrate").description(
|
|
51
51
|
"Migrate objects with case-sensitive entity triplets to lower-case versions."
|
|
52
52
|
).requiredOption(
|
|
@@ -90,7 +90,7 @@ function registerCommands(program) {
|
|
|
90
90
|
"--concurrency <MAX CONCURRENT REQS>",
|
|
91
91
|
"Optional Controls the number of API requests allowed to be performed simultaneously.",
|
|
92
92
|
"25"
|
|
93
|
-
).option("-v --verbose", "Enable verbose output.", false).action(lazy(() =>
|
|
93
|
+
).option("-v --verbose", "Enable verbose output.", false).action(lazy(() => import('./migrate/migrate.cjs.js'), "default"));
|
|
94
94
|
program.command("publish").description(
|
|
95
95
|
"Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc."
|
|
96
96
|
).requiredOption(
|
|
@@ -127,6 +127,9 @@ function registerCommands(program) {
|
|
|
127
127
|
).option(
|
|
128
128
|
"--awsBucketRootPath <AWS BUCKET ROOT PATH>",
|
|
129
129
|
"Optional sub-directory to store files in Amazon S3"
|
|
130
|
+
).option(
|
|
131
|
+
"--awsMaxAttempts <AWS MAX ATTEMPTS>",
|
|
132
|
+
"Optional maximum number of retries for AWS S3 operations. If not specified, default value of 3 is used."
|
|
130
133
|
).option(
|
|
131
134
|
"--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>",
|
|
132
135
|
"(Required for OpenStack) specify when --publisher-type openStackSwift"
|
|
@@ -146,7 +149,7 @@ function registerCommands(program) {
|
|
|
146
149
|
"--directory <PATH>",
|
|
147
150
|
"Path of the directory containing generated files to publish",
|
|
148
151
|
"./site/"
|
|
149
|
-
).action(lazy(() =>
|
|
152
|
+
).action(lazy(() => import('./publish/publish.cjs.js'), "default"));
|
|
150
153
|
program.command("serve:mkdocs").description("Serve a documentation project locally using MkDocs serve.").option(
|
|
151
154
|
"-i, --docker-image <DOCKER_IMAGE>",
|
|
152
155
|
"The mkdocs docker container to use",
|
|
@@ -164,7 +167,7 @@ function registerCommands(program) {
|
|
|
164
167
|
"--site-name",
|
|
165
168
|
"Name for site when using default MkDocs config",
|
|
166
169
|
"Documentation Site"
|
|
167
|
-
).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() =>
|
|
170
|
+
).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => import('./serve/mkdocs.cjs.js'), "default"));
|
|
168
171
|
program.command("serve").description(
|
|
169
172
|
"Serve a documentation project locally in a Backstage app-like environment"
|
|
170
173
|
).option(
|
|
@@ -212,12 +215,14 @@ function registerCommands(program) {
|
|
|
212
215
|
"--preview-app-port can only be used together with --preview-app-bundle-path"
|
|
213
216
|
);
|
|
214
217
|
}
|
|
215
|
-
}).action(lazy(() =>
|
|
218
|
+
}).action(lazy(() => import('./serve/serve.cjs.js'), "default"));
|
|
216
219
|
}
|
|
217
|
-
function lazy(
|
|
220
|
+
function lazy(moduleLoader, exportName) {
|
|
218
221
|
return async (...args) => {
|
|
219
222
|
try {
|
|
220
|
-
const
|
|
223
|
+
const mod = await moduleLoader();
|
|
224
|
+
const actualModule = mod.default;
|
|
225
|
+
const actionFunc = actualModule[exportName];
|
|
221
226
|
await actionFunc(...args);
|
|
222
227
|
process.exit(0);
|
|
223
228
|
} catch (error) {
|
|
@@ -227,5 +232,6 @@ function lazy(getActionFunc) {
|
|
|
227
232
|
};
|
|
228
233
|
}
|
|
229
234
|
|
|
235
|
+
exports.lazy = lazy;
|
|
230
236
|
exports.registerCommands = registerCommands;
|
|
231
237
|
//# sourceMappingURL=index.cjs.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../../src/commands/index.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 { Command } from 'commander';\nimport { TechdocsGenerator } from '@backstage/plugin-techdocs-node';\n\nconst defaultDockerImage = TechdocsGenerator.defaultDockerImage;\nconst defaultPreviewAppPort = '3000';\n\nexport function registerCommands(program: Command) {\n program\n .command('generate')\n .description('Generate TechDocs documentation site using MkDocs.')\n .option(\n '--source-dir <PATH>',\n 'Source directory containing mkdocs.yml and docs/ directory.',\n '.',\n )\n .option(\n '--output-dir <PATH>',\n 'Output directory containing generated TechDocs site.',\n './site/',\n )\n .option(\n '--docker-image <DOCKER_IMAGE>',\n 'The mkdocs docker container to use',\n defaultDockerImage,\n )\n .option('--no-pull', 'Do not pull the latest docker image')\n .option(\n '--no-docker',\n 'Do not use Docker, use MkDocs executable and plugins in current user environment.',\n )\n .option(\n '--techdocs-ref <HOST_TYPE:URL>',\n 'The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.' +\n '\\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.' +\n '\\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\\n',\n )\n .option(\n '--etag <ETAG>',\n 'A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json.',\n )\n .option(\n '--site-name',\n 'Name for site when using default MkDocs config',\n 'Documentation Site',\n )\n .option('-v --verbose', 'Enable verbose output.', false)\n .option(\n '--omitTechdocsCoreMkdocsPlugin',\n \"Don't patch MkDocs file automatically with techdocs-core plugin.\",\n false,\n )\n .option(\n '--legacyCopyReadmeMdToIndexMd',\n 'Attempt to ensure an index.md exists falling back to using <docs-dir>/README.md or README.md in case a default <docs-dir>/index.md is not provided.',\n false,\n )\n .option(\n '--defaultPlugin [defaultPlugins...]',\n 'Plugins which should be added automatically to the mkdocs.yaml file',\n [],\n )\n .option(\n '--runAsDefaultUser',\n 'Bypass setting the container user as the same user and group id as host for Linux and MacOS',\n false,\n )\n .alias('build')\n .action(lazy(() => import('./generate/generate').then(m => m.default)));\n\n program\n .command('migrate')\n .description(\n 'Migrate objects with case-sensitive entity triplets to lower-case versions.',\n )\n .requiredOption(\n '--publisher-type <TYPE>',\n '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n )\n .requiredOption(\n '--storage-name <BUCKET/CONTAINER NAME>',\n '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n )\n .option(\n '--azureAccountName <AZURE ACCOUNT NAME>',\n '(Required for Azure) specify when --publisher-type azureBlobStorage',\n )\n .option(\n '--azureAccountKey <AZURE ACCOUNT KEY>',\n 'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n )\n .option(\n '--awsRoleArn <AWS ROLE ARN>',\n 'Optional AWS ARN of role to be assumed.',\n )\n .option(\n '--awsEndpoint <AWS ENDPOINT>',\n 'Optional AWS endpoint to send requests to.',\n )\n .option(\n '--awsS3ForcePathStyle',\n 'Optional AWS S3 option to force path style.',\n )\n .option(\n '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--removeOriginal',\n 'Optional Files are copied by default. If flag is set, files are renamed/moved instead.',\n false,\n )\n .option(\n '--concurrency <MAX CONCURRENT REQS>',\n 'Optional Controls the number of API requests allowed to be performed simultaneously.',\n '25',\n )\n .option('-v --verbose', 'Enable verbose output.', false)\n .action(lazy(() => import('./migrate/migrate').then(m => m.default)));\n\n program\n .command('publish')\n .description(\n 'Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc.',\n )\n .requiredOption(\n '--publisher-type <TYPE>',\n '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n )\n .requiredOption(\n '--storage-name <BUCKET/CONTAINER NAME>',\n '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n )\n .requiredOption(\n '--entity <NAMESPACE/KIND/NAME>',\n '(Required always) Entity uid separated by / in namespace/kind/name order (case-sensitive). Example: default/Component/myEntity ',\n )\n .option(\n '--legacyUseCaseSensitiveTripletPaths',\n 'Publishes objects with cased entity triplet prefix when set (e.g. namespace/Kind/name). Only use if your TechDocs backend is configured the same way.',\n false,\n )\n .option(\n '--azureAccountName <AZURE ACCOUNT NAME>',\n '(Required for Azure) specify when --publisher-type azureBlobStorage',\n )\n .option(\n '--azureAccountKey <AZURE ACCOUNT KEY>',\n 'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n )\n .option(\n '--awsRoleArn <AWS ROLE ARN>',\n 'Optional AWS ARN of role to be assumed.',\n )\n .option(\n '--awsEndpoint <AWS ENDPOINT>',\n 'Optional AWS endpoint to send requests to.',\n )\n .option(\n '--awsProxy <HTTPS Proxy>',\n 'Optional Proxy to use for AWS requests.',\n )\n .option('--awsS3sse <AWS SSE>', 'Optional AWS S3 Server Side Encryption.')\n .option(\n '--awsS3ForcePathStyle',\n 'Optional AWS S3 option to force path style.',\n )\n .option(\n '--awsBucketRootPath <AWS BUCKET ROOT PATH>',\n 'Optional sub-directory to store files in Amazon S3',\n )\n .option(\n '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--gcsBucketRootPath <GCS BUCKET ROOT PATH>',\n 'Optional sub-directory to store files in Google cloud storage',\n )\n .option(\n '--directory <PATH>',\n 'Path of the directory containing generated files to publish',\n './site/',\n )\n .action(lazy(() => import('./publish/publish').then(m => m.default)));\n\n program\n .command('serve:mkdocs')\n .description('Serve a documentation project locally using MkDocs serve.')\n .option(\n '-i, --docker-image <DOCKER_IMAGE>',\n 'The mkdocs docker container to use',\n defaultDockerImage,\n )\n .option(\n '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n 'Override the image entrypoint',\n )\n .option(\n '--docker-option <DOCKER_OPTION...>',\n 'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n )\n .option(\n '--no-docker',\n 'Do not use Docker, run `mkdocs serve` in current user environment.',\n )\n .option(\n '--site-name',\n 'Name for site when using default MkDocs config',\n 'Documentation Site',\n )\n .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n .option('-v --verbose', 'Enable verbose output.', false)\n .action(lazy(() => import('./serve/mkdocs').then(m => m.default)));\n\n program\n .command('serve')\n .description(\n 'Serve a documentation project locally in a Backstage app-like environment',\n )\n .option(\n '-i, --docker-image <DOCKER_IMAGE>',\n 'The mkdocs docker container to use',\n defaultDockerImage,\n )\n .option(\n '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n 'Override the image entrypoint',\n )\n .option(\n '--docker-option <DOCKER_OPTION...>',\n 'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n )\n .option(\n '--no-docker',\n 'Do not use Docker, use MkDocs executable in current user environment.',\n )\n .option(\n '--site-name',\n 'Name for site when using default MkDocs config',\n 'Documentation Site',\n )\n .option('--mkdocs-port <PORT>', 'Port for MkDocs server to use', '8000')\n .option('-v --verbose', 'Enable verbose output.', false)\n .option(\n '--preview-app-bundle-path <PATH_TO_BUNDLE>',\n 'Preview documentation using another web app',\n )\n .option(\n '--preview-app-port <PORT>',\n 'Port for the preview app to be served on',\n defaultPreviewAppPort,\n )\n .option(\n '-c, --mkdocs-config-file-name <FILENAME>',\n 'Mkdocs config file name',\n )\n .option(\n '--mkdocs-parameter-clean',\n 'Pass \"--clean\" parameter to mkdocs server running in containerized environment',\n false,\n )\n .option(\n '--mkdocs-parameter-dirtyreload',\n 'Pass \"--dirtyreload\" parameter to mkdocs server running in containerized environment',\n false,\n )\n .option(\n '--mkdocs-parameter-strict',\n 'Pass \"--strict\" parameter to mkdocs server running in containerized environment',\n false,\n )\n .hook('preAction', command => {\n if (\n command.opts().previewAppPort !== defaultPreviewAppPort &&\n !command.opts().previewAppBundlePath\n ) {\n command.error(\n '--preview-app-port can only be used together with --preview-app-bundle-path',\n );\n }\n })\n .action(lazy(() => import('./serve/serve').then(m => m.default)));\n}\n\n// Wraps an action function so that it always exits and handles errors\n// Humbly taken from backstage-cli's registerCommands\nfunction lazy(\n getActionFunc: () => Promise<(...args: any[]) => Promise<void>>,\n): (...args: any[]) => Promise<never> {\n return async (...args: any[]) => {\n try {\n const actionFunc = await getActionFunc();\n await actionFunc(...args);\n process.exit(0);\n } catch (error) {\n // eslint-disable-next-line no-console\n console.error(error.message);\n process.exit(1);\n }\n };\n}\n"],"names":["TechdocsGenerator"],"mappings":";;;;AAmBA,MAAM,qBAAqBA,oCAAkB,CAAA,kBAAA;AAC7C,MAAM,qBAAwB,GAAA,MAAA;AAEvB,SAAS,iBAAiB,OAAkB,EAAA;AACjD,EAAA,OAAA,CACG,OAAQ,CAAA,UAAU,CAClB,CAAA,WAAA,CAAY,oDAAoD,CAChE,CAAA,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,sDAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,WAAa,EAAA,qCAAqC,CACzD,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAID,CAAA,MAAA;AAAA,IACC,eAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CACtD,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,kEAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,qJAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,qEAAA;AAAA,IACA;AAAC,GAEF,CAAA,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA;AAAA,GAED,CAAA,KAAA,CAAM,OAAO,CAAA,CACb,OAAO,IAAK,CAAA,MAAM,oDAAO,4BAAqB,MAAE,IAAK,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAO,CAAC,CAAC,CAAA;AAExE,EACG,OAAA,CAAA,OAAA,CAAQ,SAAS,CACjB,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,kBAAA;AAAA,IACA,wFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,IAED,MAAO,CAAA,cAAA,EAAgB,wBAA0B,EAAA,KAAK,EACtD,MAAO,CAAA,IAAA,CAAK,MAAM,oDAAO,0BAAmB,KAAE,CAAA,IAAA,CAAK,OAAK,CAAE,CAAA,OAAO,CAAC,CAAC,CAAA;AAEtE,EACG,OAAA,CAAA,OAAA,CAAQ,SAAS,CACjB,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,sCAAA;AAAA,IACA,uJAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,sBAAwB,EAAA,yCAAyC,CACxE,CAAA,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,IAAK,CAAA,MAAM,oDAAO,0BAAmB,KAAE,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,CAAC,CAAC,CAAA;AAEtE,EAAA,OAAA,CACG,OAAQ,CAAA,cAAc,CACtB,CAAA,WAAA,CAAY,2DAA2D,CACvE,CAAA,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,OAAO,mBAAqB,EAAA,qCAAA,EAAuC,MAAM,CACzE,CAAA,MAAA,CAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CAAA,CACtD,OAAO,IAAK,CAAA,MAAM,oDAAO,uBAAgB,KAAA,CAAE,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,CAAC,CAAC,CAAA;AAEnE,EACG,OAAA,CAAA,OAAA,CAAQ,OAAO,CACf,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAO,CAAA,sBAAA,EAAwB,+BAAiC,EAAA,MAAM,EACtE,MAAO,CAAA,cAAA,EAAgB,wBAA0B,EAAA,KAAK,CACtD,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,0CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0BAAA;AAAA,IACA,gFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,iFAAA;AAAA,IACA;AAAA,GACF,CACC,IAAK,CAAA,WAAA,EAAa,CAAW,OAAA,KAAA;AAC5B,IACE,IAAA,OAAA,CAAQ,MAAO,CAAA,cAAA,KAAmB,yBAClC,CAAC,OAAA,CAAQ,IAAK,EAAA,CAAE,oBAChB,EAAA;AACA,MAAQ,OAAA,CAAA,KAAA;AAAA,QACN;AAAA,OACF;AAAA;AACF,GACD,CAAA,CACA,MAAO,CAAA,IAAA,CAAK,MAAM,oDAAO,sBAAe,KAAA,CAAE,IAAK,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAO,CAAC,CAAC,CAAA;AACpE;AAIA,SAAS,KACP,aACoC,EAAA;AACpC,EAAA,OAAO,UAAU,IAAgB,KAAA;AAC/B,IAAI,IAAA;AACF,MAAM,MAAA,UAAA,GAAa,MAAM,aAAc,EAAA;AACvC,MAAM,MAAA,UAAA,CAAW,GAAG,IAAI,CAAA;AACxB,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,aACP,KAAO,EAAA;AAEd,MAAQ,OAAA,CAAA,KAAA,CAAM,MAAM,OAAO,CAAA;AAC3B,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA;AAChB,GACF;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../../src/commands/index.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 { Command } from 'commander';\nimport { TechdocsGenerator } from '@backstage/plugin-techdocs-node';\n\nconst defaultDockerImage = TechdocsGenerator.defaultDockerImage;\nconst defaultPreviewAppPort = '3000';\n\nexport function registerCommands(program: Command) {\n program\n .command('generate')\n .description('Generate TechDocs documentation site using MkDocs.')\n .option(\n '--source-dir <PATH>',\n 'Source directory containing mkdocs.yml and docs/ directory.',\n '.',\n )\n .option(\n '--output-dir <PATH>',\n 'Output directory containing generated TechDocs site.',\n './site/',\n )\n .option(\n '--docker-image <DOCKER_IMAGE>',\n 'The mkdocs docker container to use',\n defaultDockerImage,\n )\n .option('--no-pull', 'Do not pull the latest docker image')\n .option(\n '--no-docker',\n 'Do not use Docker, use MkDocs executable and plugins in current user environment.',\n )\n .option(\n '--techdocs-ref <HOST_TYPE:URL>',\n 'The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.' +\n '\\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.' +\n '\\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\\n',\n )\n .option(\n '--etag <ETAG>',\n 'A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json.',\n )\n .option(\n '--site-name',\n 'Name for site when using default MkDocs config',\n 'Documentation Site',\n )\n .option('-v --verbose', 'Enable verbose output.', false)\n .option(\n '--omitTechdocsCoreMkdocsPlugin',\n \"Don't patch MkDocs file automatically with techdocs-core plugin.\",\n false,\n )\n .option(\n '--legacyCopyReadmeMdToIndexMd',\n 'Attempt to ensure an index.md exists falling back to using <docs-dir>/README.md or README.md in case a default <docs-dir>/index.md is not provided.',\n false,\n )\n .option(\n '--defaultPlugin [defaultPlugins...]',\n 'Plugins which should be added automatically to the mkdocs.yaml file',\n [],\n )\n .option(\n '--runAsDefaultUser',\n 'Bypass setting the container user as the same user and group id as host for Linux and MacOS',\n false,\n )\n .alias('build')\n .action(lazy(() => import('./generate/generate'), 'default'));\n\n program\n .command('migrate')\n .description(\n 'Migrate objects with case-sensitive entity triplets to lower-case versions.',\n )\n .requiredOption(\n '--publisher-type <TYPE>',\n '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n )\n .requiredOption(\n '--storage-name <BUCKET/CONTAINER NAME>',\n '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n )\n .option(\n '--azureAccountName <AZURE ACCOUNT NAME>',\n '(Required for Azure) specify when --publisher-type azureBlobStorage',\n )\n .option(\n '--azureAccountKey <AZURE ACCOUNT KEY>',\n 'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n )\n .option(\n '--awsRoleArn <AWS ROLE ARN>',\n 'Optional AWS ARN of role to be assumed.',\n )\n .option(\n '--awsEndpoint <AWS ENDPOINT>',\n 'Optional AWS endpoint to send requests to.',\n )\n .option(\n '--awsS3ForcePathStyle',\n 'Optional AWS S3 option to force path style.',\n )\n .option(\n '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--removeOriginal',\n 'Optional Files are copied by default. If flag is set, files are renamed/moved instead.',\n false,\n )\n .option(\n '--concurrency <MAX CONCURRENT REQS>',\n 'Optional Controls the number of API requests allowed to be performed simultaneously.',\n '25',\n )\n .option('-v --verbose', 'Enable verbose output.', false)\n .action(lazy(() => import('./migrate/migrate'), 'default'));\n\n program\n .command('publish')\n .description(\n 'Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc.',\n )\n .requiredOption(\n '--publisher-type <TYPE>',\n '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n )\n .requiredOption(\n '--storage-name <BUCKET/CONTAINER NAME>',\n '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n )\n .requiredOption(\n '--entity <NAMESPACE/KIND/NAME>',\n '(Required always) Entity uid separated by / in namespace/kind/name order (case-sensitive). Example: default/Component/myEntity ',\n )\n .option(\n '--legacyUseCaseSensitiveTripletPaths',\n 'Publishes objects with cased entity triplet prefix when set (e.g. namespace/Kind/name). Only use if your TechDocs backend is configured the same way.',\n false,\n )\n .option(\n '--azureAccountName <AZURE ACCOUNT NAME>',\n '(Required for Azure) specify when --publisher-type azureBlobStorage',\n )\n .option(\n '--azureAccountKey <AZURE ACCOUNT KEY>',\n 'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n )\n .option(\n '--awsRoleArn <AWS ROLE ARN>',\n 'Optional AWS ARN of role to be assumed.',\n )\n .option(\n '--awsEndpoint <AWS ENDPOINT>',\n 'Optional AWS endpoint to send requests to.',\n )\n .option(\n '--awsProxy <HTTPS Proxy>',\n 'Optional Proxy to use for AWS requests.',\n )\n .option('--awsS3sse <AWS SSE>', 'Optional AWS S3 Server Side Encryption.')\n .option(\n '--awsS3ForcePathStyle',\n 'Optional AWS S3 option to force path style.',\n )\n .option(\n '--awsBucketRootPath <AWS BUCKET ROOT PATH>',\n 'Optional sub-directory to store files in Amazon S3',\n )\n .option(\n '--awsMaxAttempts <AWS MAX ATTEMPTS>',\n 'Optional maximum number of retries for AWS S3 operations. If not specified, default value of 3 is used.',\n )\n .option(\n '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n '(Required for OpenStack) specify when --publisher-type openStackSwift',\n )\n .option(\n '--gcsBucketRootPath <GCS BUCKET ROOT PATH>',\n 'Optional sub-directory to store files in Google cloud storage',\n )\n .option(\n '--directory <PATH>',\n 'Path of the directory containing generated files to publish',\n './site/',\n )\n .action(lazy(() => import('./publish/publish'), 'default'));\n\n program\n .command('serve:mkdocs')\n .description('Serve a documentation project locally using MkDocs serve.')\n .option(\n '-i, --docker-image <DOCKER_IMAGE>',\n 'The mkdocs docker container to use',\n defaultDockerImage,\n )\n .option(\n '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n 'Override the image entrypoint',\n )\n .option(\n '--docker-option <DOCKER_OPTION...>',\n 'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n )\n .option(\n '--no-docker',\n 'Do not use Docker, run `mkdocs serve` in current user environment.',\n )\n .option(\n '--site-name',\n 'Name for site when using default MkDocs config',\n 'Documentation Site',\n )\n .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n .option('-v --verbose', 'Enable verbose output.', false)\n .action(lazy(() => import('./serve/mkdocs'), 'default'));\n\n program\n .command('serve')\n .description(\n 'Serve a documentation project locally in a Backstage app-like environment',\n )\n .option(\n '-i, --docker-image <DOCKER_IMAGE>',\n 'The mkdocs docker container to use',\n defaultDockerImage,\n )\n .option(\n '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n 'Override the image entrypoint',\n )\n .option(\n '--docker-option <DOCKER_OPTION...>',\n 'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n )\n .option(\n '--no-docker',\n 'Do not use Docker, use MkDocs executable in current user environment.',\n )\n .option(\n '--site-name',\n 'Name for site when using default MkDocs config',\n 'Documentation Site',\n )\n .option('--mkdocs-port <PORT>', 'Port for MkDocs server to use', '8000')\n .option('-v --verbose', 'Enable verbose output.', false)\n .option(\n '--preview-app-bundle-path <PATH_TO_BUNDLE>',\n 'Preview documentation using another web app',\n )\n .option(\n '--preview-app-port <PORT>',\n 'Port for the preview app to be served on',\n defaultPreviewAppPort,\n )\n .option(\n '-c, --mkdocs-config-file-name <FILENAME>',\n 'Mkdocs config file name',\n )\n .option(\n '--mkdocs-parameter-clean',\n 'Pass \"--clean\" parameter to mkdocs server running in containerized environment',\n false,\n )\n .option(\n '--mkdocs-parameter-dirtyreload',\n 'Pass \"--dirtyreload\" parameter to mkdocs server running in containerized environment',\n false,\n )\n .option(\n '--mkdocs-parameter-strict',\n 'Pass \"--strict\" parameter to mkdocs server running in containerized environment',\n false,\n )\n .hook('preAction', command => {\n if (\n command.opts().previewAppPort !== defaultPreviewAppPort &&\n !command.opts().previewAppBundlePath\n ) {\n command.error(\n '--preview-app-port can only be used together with --preview-app-bundle-path',\n );\n }\n })\n .action(lazy(() => import('./serve/serve'), 'default'));\n}\n\n// Humbly taken from backstage-cli's registerCommands\ntype ActionFunc = (...args: any[]) => Promise<void>;\ntype ActionExports<TModule extends object> = {\n [KName in keyof TModule as TModule[KName] extends ActionFunc\n ? KName\n : never]: TModule[KName];\n};\n\n// Wraps an action function so that it always exits and handles errors\nexport function lazy<TModule extends object>(\n moduleLoader: () => Promise<TModule>,\n exportName: keyof ActionExports<TModule>,\n): (...args: any[]) => Promise<never> {\n return async (...args: any[]) => {\n try {\n const mod = await moduleLoader();\n const actualModule = (\n mod as unknown as { default: ActionExports<TModule> }\n ).default;\n const actionFunc = actualModule[exportName] as ActionFunc;\n await actionFunc(...args);\n\n process.exit(0);\n } catch (error) {\n console.error(error.message);\n process.exit(1);\n }\n };\n}\n"],"names":["TechdocsGenerator"],"mappings":";;;;AAmBA,MAAM,qBAAqBA,oCAAkB,CAAA,kBAAA;AAC7C,MAAM,qBAAwB,GAAA,MAAA;AAEvB,SAAS,iBAAiB,OAAkB,EAAA;AACjD,EAAA,OAAA,CACG,OAAQ,CAAA,UAAU,CAClB,CAAA,WAAA,CAAY,oDAAoD,CAChE,CAAA,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,sDAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,WAAa,EAAA,qCAAqC,CACzD,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAID,CAAA,MAAA;AAAA,IACC,eAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CACtD,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,kEAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,qJAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,qEAAA;AAAA,IACA;AAAC,GAEF,CAAA,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA;AAAA,GACF,CACC,KAAM,CAAA,OAAO,CACb,CAAA,MAAA,CAAO,IAAK,CAAA,MAAM,OAAO,4BAAqB,CAAG,EAAA,SAAS,CAAC,CAAA;AAE9D,EACG,OAAA,CAAA,OAAA,CAAQ,SAAS,CACjB,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,kBAAA;AAAA,IACA,wFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CAAA,CACtD,MAAO,CAAA,IAAA,CAAK,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EACG,OAAA,CAAA,OAAA,CAAQ,SAAS,CACjB,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,sCAAA;AAAA,IACA,uJAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,sBAAwB,EAAA,yCAAyC,CACxE,CAAA,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GACF,CACC,OAAO,IAAK,CAAA,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EAAA,OAAA,CACG,OAAQ,CAAA,cAAc,CACtB,CAAA,WAAA,CAAY,2DAA2D,CACvE,CAAA,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,IAED,MAAO,CAAA,mBAAA,EAAqB,uCAAuC,MAAM,CAAA,CACzE,OAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CAAA,CACtD,OAAO,IAAK,CAAA,MAAM,OAAO,uBAAgB,CAAA,EAAG,SAAS,CAAC,CAAA;AAEzD,EACG,OAAA,CAAA,OAAA,CAAQ,OAAO,CACf,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAO,CAAA,sBAAA,EAAwB,+BAAiC,EAAA,MAAM,EACtE,MAAO,CAAA,cAAA,EAAgB,wBAA0B,EAAA,KAAK,CACtD,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,0CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0BAAA;AAAA,IACA,gFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,iFAAA;AAAA,IACA;AAAA,GACF,CACC,IAAK,CAAA,WAAA,EAAa,CAAW,OAAA,KAAA;AAC5B,IACE,IAAA,OAAA,CAAQ,MAAO,CAAA,cAAA,KAAmB,yBAClC,CAAC,OAAA,CAAQ,IAAK,EAAA,CAAE,oBAChB,EAAA;AACA,MAAQ,OAAA,CAAA,KAAA;AAAA,QACN;AAAA,OACF;AAAA;AACF,GACD,EACA,MAAO,CAAA,IAAA,CAAK,MAAM,OAAO,sBAAe,CAAG,EAAA,SAAS,CAAC,CAAA;AAC1D;AAWgB,SAAA,IAAA,CACd,cACA,UACoC,EAAA;AACpC,EAAA,OAAO,UAAU,IAAgB,KAAA;AAC/B,IAAI,IAAA;AACF,MAAM,MAAA,GAAA,GAAM,MAAM,YAAa,EAAA;AAC/B,MAAA,MAAM,eACJ,GACA,CAAA,OAAA;AACF,MAAM,MAAA,UAAA,GAAa,aAAa,UAAU,CAAA;AAC1C,MAAM,MAAA,UAAA,CAAW,GAAG,IAAI,CAAA;AAExB,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,aACP,KAAO,EAAA;AACd,MAAQ,OAAA,CAAA,KAAA,CAAM,MAAM,OAAO,CAAA;AAC3B,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA;AAChB,GACF;AACF;;;;;"}
|
|
@@ -1135,6 +1135,52 @@
|
|
|
1135
1135
|
},
|
|
1136
1136
|
"packageName": "@backstage/backend-plugin-api"
|
|
1137
1137
|
},
|
|
1138
|
+
{
|
|
1139
|
+
"path": "../../plugins/auth-backend-module-guest-provider/config.d.ts",
|
|
1140
|
+
"value": {
|
|
1141
|
+
"type": "object",
|
|
1142
|
+
"properties": {
|
|
1143
|
+
"auth": {
|
|
1144
|
+
"description": "Configuration options for the auth plugin",
|
|
1145
|
+
"type": "object",
|
|
1146
|
+
"properties": {
|
|
1147
|
+
"providers": {
|
|
1148
|
+
"type": "object",
|
|
1149
|
+
"properties": {
|
|
1150
|
+
"guest": {
|
|
1151
|
+
"type": "object",
|
|
1152
|
+
"properties": {
|
|
1153
|
+
"userEntityRef": {
|
|
1154
|
+
"description": "The entity reference to use for the guest user.",
|
|
1155
|
+
"default": "user:development/guest",
|
|
1156
|
+
"type": "string"
|
|
1157
|
+
},
|
|
1158
|
+
"ownershipEntityRefs": {
|
|
1159
|
+
"description": "A list of entity references to user for ownership of the guest user if the user\n is not found in the catalog.",
|
|
1160
|
+
"default": "[userEntityRef]",
|
|
1161
|
+
"type": "array",
|
|
1162
|
+
"items": {
|
|
1163
|
+
"type": "string"
|
|
1164
|
+
}
|
|
1165
|
+
},
|
|
1166
|
+
"dangerouslyAllowOutsideDevelopment": {
|
|
1167
|
+
"description": "Allow users to sign in with the guest provider outside of their development environments.",
|
|
1168
|
+
"type": "boolean"
|
|
1169
|
+
}
|
|
1170
|
+
}
|
|
1171
|
+
}
|
|
1172
|
+
}
|
|
1173
|
+
}
|
|
1174
|
+
},
|
|
1175
|
+
"required": [
|
|
1176
|
+
"providers"
|
|
1177
|
+
]
|
|
1178
|
+
}
|
|
1179
|
+
},
|
|
1180
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1181
|
+
},
|
|
1182
|
+
"packageName": "@backstage/plugin-auth-backend-module-guest-provider"
|
|
1183
|
+
},
|
|
1138
1184
|
{
|
|
1139
1185
|
"path": "../../plugins/auth-backend/config.d.ts",
|
|
1140
1186
|
"value": {
|
|
@@ -1393,52 +1439,6 @@
|
|
|
1393
1439
|
},
|
|
1394
1440
|
"packageName": "@backstage/plugin-auth-backend"
|
|
1395
1441
|
},
|
|
1396
|
-
{
|
|
1397
|
-
"path": "../../plugins/auth-backend-module-guest-provider/config.d.ts",
|
|
1398
|
-
"value": {
|
|
1399
|
-
"type": "object",
|
|
1400
|
-
"properties": {
|
|
1401
|
-
"auth": {
|
|
1402
|
-
"description": "Configuration options for the auth plugin",
|
|
1403
|
-
"type": "object",
|
|
1404
|
-
"properties": {
|
|
1405
|
-
"providers": {
|
|
1406
|
-
"type": "object",
|
|
1407
|
-
"properties": {
|
|
1408
|
-
"guest": {
|
|
1409
|
-
"type": "object",
|
|
1410
|
-
"properties": {
|
|
1411
|
-
"userEntityRef": {
|
|
1412
|
-
"description": "The entity reference to use for the guest user.",
|
|
1413
|
-
"default": "user:development/guest",
|
|
1414
|
-
"type": "string"
|
|
1415
|
-
},
|
|
1416
|
-
"ownershipEntityRefs": {
|
|
1417
|
-
"description": "A list of entity references to user for ownership of the guest user if the user\n is not found in the catalog.",
|
|
1418
|
-
"default": "[userEntityRef]",
|
|
1419
|
-
"type": "array",
|
|
1420
|
-
"items": {
|
|
1421
|
-
"type": "string"
|
|
1422
|
-
}
|
|
1423
|
-
},
|
|
1424
|
-
"dangerouslyAllowOutsideDevelopment": {
|
|
1425
|
-
"description": "Allow users to sign in with the guest provider outside of their development environments.",
|
|
1426
|
-
"type": "boolean"
|
|
1427
|
-
}
|
|
1428
|
-
}
|
|
1429
|
-
}
|
|
1430
|
-
}
|
|
1431
|
-
}
|
|
1432
|
-
},
|
|
1433
|
-
"required": [
|
|
1434
|
-
"providers"
|
|
1435
|
-
]
|
|
1436
|
-
}
|
|
1437
|
-
},
|
|
1438
|
-
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1439
|
-
},
|
|
1440
|
-
"packageName": "@backstage/plugin-auth-backend-module-guest-provider"
|
|
1441
|
-
},
|
|
1442
1442
|
{
|
|
1443
1443
|
"path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/core-components/config.d.ts",
|
|
1444
1444
|
"value": {
|
|
@@ -4089,6 +4089,138 @@
|
|
|
4089
4089
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
4090
4090
|
},
|
|
4091
4091
|
"packageName": "@backstage/integration-aws-node"
|
|
4092
|
+
},
|
|
4093
|
+
{
|
|
4094
|
+
"path": "../../node_modules/@backstage/backend-common/node_modules/@backstage/backend-plugin-api/config.d.ts",
|
|
4095
|
+
"value": {
|
|
4096
|
+
"type": "object",
|
|
4097
|
+
"properties": {
|
|
4098
|
+
"backend": {
|
|
4099
|
+
"type": "object",
|
|
4100
|
+
"properties": {
|
|
4101
|
+
"workingDirectory": {
|
|
4102
|
+
"description": "An absolute path to a directory that can be used as a working dir, for\nexample as scratch space for large operations.",
|
|
4103
|
+
"type": "string"
|
|
4104
|
+
}
|
|
4105
|
+
}
|
|
4106
|
+
}
|
|
4107
|
+
},
|
|
4108
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
4109
|
+
},
|
|
4110
|
+
"packageName": "@backstage/backend-plugin-api"
|
|
4111
|
+
},
|
|
4112
|
+
{
|
|
4113
|
+
"path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/frontend-app-api/config.d.ts",
|
|
4114
|
+
"value": {
|
|
4115
|
+
"type": "object",
|
|
4116
|
+
"properties": {
|
|
4117
|
+
"app": {
|
|
4118
|
+
"type": "object",
|
|
4119
|
+
"properties": {
|
|
4120
|
+
"experimental": {
|
|
4121
|
+
"type": "object",
|
|
4122
|
+
"properties": {
|
|
4123
|
+
"packages": {
|
|
4124
|
+
"visibility": "frontend",
|
|
4125
|
+
"deepVisibility": "frontend",
|
|
4126
|
+
"anyOf": [
|
|
4127
|
+
{
|
|
4128
|
+
"type": "object",
|
|
4129
|
+
"properties": {
|
|
4130
|
+
"include": {
|
|
4131
|
+
"type": "array",
|
|
4132
|
+
"items": {
|
|
4133
|
+
"type": "string"
|
|
4134
|
+
}
|
|
4135
|
+
},
|
|
4136
|
+
"exclude": {
|
|
4137
|
+
"type": "array",
|
|
4138
|
+
"items": {
|
|
4139
|
+
"type": "string"
|
|
4140
|
+
}
|
|
4141
|
+
}
|
|
4142
|
+
}
|
|
4143
|
+
},
|
|
4144
|
+
{
|
|
4145
|
+
"const": "all",
|
|
4146
|
+
"type": "string"
|
|
4147
|
+
}
|
|
4148
|
+
]
|
|
4149
|
+
}
|
|
4150
|
+
}
|
|
4151
|
+
},
|
|
4152
|
+
"routes": {
|
|
4153
|
+
"type": "object",
|
|
4154
|
+
"properties": {
|
|
4155
|
+
"bindings": {
|
|
4156
|
+
"description": "Maps external route references to regular route references. Both the\nkey and the value is expected to be on the form `<pluginId>.<routeId>`.\nIf the value is `false`, the route will be disabled even if it has a\ndefault mapping.",
|
|
4157
|
+
"deepVisibility": "frontend",
|
|
4158
|
+
"type": "object",
|
|
4159
|
+
"additionalProperties": {
|
|
4160
|
+
"anyOf": [
|
|
4161
|
+
{
|
|
4162
|
+
"const": false,
|
|
4163
|
+
"type": "boolean"
|
|
4164
|
+
},
|
|
4165
|
+
{
|
|
4166
|
+
"type": "string"
|
|
4167
|
+
}
|
|
4168
|
+
]
|
|
4169
|
+
}
|
|
4170
|
+
}
|
|
4171
|
+
}
|
|
4172
|
+
},
|
|
4173
|
+
"extensions": {
|
|
4174
|
+
"deepVisibility": "frontend",
|
|
4175
|
+
"type": "array",
|
|
4176
|
+
"items": {
|
|
4177
|
+
"anyOf": [
|
|
4178
|
+
{
|
|
4179
|
+
"type": "object",
|
|
4180
|
+
"additionalProperties": {
|
|
4181
|
+
"anyOf": [
|
|
4182
|
+
{
|
|
4183
|
+
"type": "object",
|
|
4184
|
+
"properties": {
|
|
4185
|
+
"attachTo": {
|
|
4186
|
+
"type": "object",
|
|
4187
|
+
"properties": {
|
|
4188
|
+
"id": {
|
|
4189
|
+
"type": "string"
|
|
4190
|
+
},
|
|
4191
|
+
"input": {
|
|
4192
|
+
"type": "string"
|
|
4193
|
+
}
|
|
4194
|
+
},
|
|
4195
|
+
"required": [
|
|
4196
|
+
"id",
|
|
4197
|
+
"input"
|
|
4198
|
+
]
|
|
4199
|
+
},
|
|
4200
|
+
"disabled": {
|
|
4201
|
+
"type": "boolean"
|
|
4202
|
+
},
|
|
4203
|
+
"config": {}
|
|
4204
|
+
}
|
|
4205
|
+
},
|
|
4206
|
+
{
|
|
4207
|
+
"type": "boolean"
|
|
4208
|
+
}
|
|
4209
|
+
]
|
|
4210
|
+
}
|
|
4211
|
+
},
|
|
4212
|
+
{
|
|
4213
|
+
"type": "string"
|
|
4214
|
+
}
|
|
4215
|
+
]
|
|
4216
|
+
}
|
|
4217
|
+
}
|
|
4218
|
+
}
|
|
4219
|
+
}
|
|
4220
|
+
},
|
|
4221
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
4222
|
+
},
|
|
4223
|
+
"packageName": "@backstage/frontend-app-api"
|
|
4092
4224
|
}
|
|
4093
4225
|
],
|
|
4094
4226
|
"backstageConfigSchemaVersion": 1
|
|
@@ -1 +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 source framework 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><meta name="backstage-app-mode" content="public"><script defer="defer" src="/static/runtime.
|
|
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 source framework 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><meta name="backstage-app-mode" content="public"><script defer="defer" src="/static/runtime.a2e1e30a.js"></script><script defer="defer" src="/static/module-material-ui.b24ef3a3.js"></script><script defer="defer" src="/static/module-lodash.aa647045.js"></script><script defer="defer" src="/static/module-date-fns.c633d602.js"></script><script defer="defer" src="/static/module-mui.f702282a.js"></script><script defer="defer" src="/static/module-material-table.d6e8d890.js"></script><script defer="defer" src="/static/module-react-dom.42a304d3.js"></script><script defer="defer" src="/static/module-react-beautiful-dnd.b474cfe9.js"></script><script defer="defer" src="/static/module-zod.4f2eeb8c.js"></script><script defer="defer" src="/static/module-i18next.f50c1612.js"></script><script defer="defer" src="/static/module-remix-run.ba6397c2.js"></script><script defer="defer" src="/static/vendor.a2e1e30a.js"></script><script defer="defer" src="/static/main.a2e1e30a.js"></script></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
color="#5bbad5"
|
|
43
43
|
/>
|
|
44
44
|
<title><%= config.getString('app.title') %></title>
|
|
45
|
-
<meta name="backstage-app-mode" content="public"><meta name="backstage-public-path" content="<%= publicPath %>/"><script defer src="<%= publicPath %>/static/runtime.
|
|
45
|
+
<meta name="backstage-app-mode" content="public"><meta name="backstage-public-path" content="<%= publicPath %>/"><script defer src="<%= publicPath %>/static/runtime.a2e1e30a.js"></script><script defer src="<%= publicPath %>/static/module-material-ui.b24ef3a3.js"></script><script defer src="<%= publicPath %>/static/module-lodash.aa647045.js"></script><script defer src="<%= publicPath %>/static/module-date-fns.c633d602.js"></script><script defer src="<%= publicPath %>/static/module-mui.f702282a.js"></script><script defer src="<%= publicPath %>/static/module-material-table.d6e8d890.js"></script><script defer src="<%= publicPath %>/static/module-react-dom.42a304d3.js"></script><script defer src="<%= publicPath %>/static/module-react-beautiful-dnd.b474cfe9.js"></script><script defer src="<%= publicPath %>/static/module-zod.4f2eeb8c.js"></script><script defer src="<%= publicPath %>/static/module-i18next.f50c1612.js"></script><script defer src="<%= publicPath %>/static/module-remix-run.ba6397c2.js"></script><script defer src="<%= publicPath %>/static/vendor.a2e1e30a.js"></script><script defer src="<%= publicPath %>/static/main.a2e1e30a.js"></script></head>
|
|
46
46
|
<body>
|
|
47
47
|
<noscript>You need to enable JavaScript to run this app.</noscript>
|
|
48
48
|
<div id="root"></div>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
"use strict";(()=>{(self.webpackChunktechdocs_cli_embedded_app=self.webpackChunktechdocs_cli_embedded_app||[]).push([[124],{74616:(W,y,t)=>{var e,p=t(4293),E=t(78920);e={value:!0},y.A=void 0;var d=E(t(14041)),g=p(t(74044)),v=(0,g.default)(d.createElement("path",{d:"M12 4l-1.41 1.41L16.17 11H4v2h12.17l-5.58 5.59L12 20l8-8z"}),"ArrowForward");y.A=v},48514:(W,y,t)=>{t.d(y,{M:()=>C});var e=t(31085),p=t(58837),E=t(71677),d=t(14041),g=t(72501);const v=(0,p.A)({container:{overflow:"visible !important"},typo:{fontSize:"inherit",overflow:"hidden",textOverflow:"ellipsis",display:"-webkit-box","-webkit-line-clamp":({line:c})=>c||1,"-webkit-box-orient":"vertical"}},{name:"BackstageOverflowTooltip"});function C(c){const j=v(c);return(0,e.jsx)(E.Ay,{title:c.title??(c.text||""),placement:c.placement,children:(0,e.jsx)(g.A,{className:j.typo,variant:"inherit",children:c.text})})}},48045:(W,y,t)=>{t.d(y,{n:()=>B});var e=t(31085),p=t(40703),E=t(59469),d=t(48653),g=t(45685),v=t(37197),C=t(58837),c=t(87051),j=t(53373),i=t.n(j),O=t(14041),a=t(10394),m=t(72501),l=t(74616),S=t(72072);const f=(0,C.A)(s=>({root:{maxWidth:"fit-content",padding:s.spacing(2,2,2,2.5)},boxTitle:{margin:0,color:s.palette.textSubtle},arrow:{color:s.palette.textSubtle}}),{name:"BackstageBottomLink"});function x(s){const{link:n,title:r,onClick:T}=s,R=f();return(0,e.jsxs)(a.A,{children:[(0,e.jsx)(v.A,{}),(0,e.jsx)(S.N_,{to:n,onClick:T,underline:"none",children:(0,e.jsxs)(a.A,{display:"flex",alignItems:"center",className:R.root,children:[(0,e.jsx)(a.A,{className:R.boxTitle,fontWeight:"fontWeightBold",m:1,children:(0,e.jsx)(m.A,{children:(0,e.jsx)("strong",{children:r})})}),(0,e.jsx)(l.A,{className:R.arrow})]})})]})}var L=t(73896),u=t(22020),M=t(10315),U=t(87849);const I=s=>{const{slackChannel:n}=s,{t:r}=(0,U.i)(M.O);if(n){if(typeof n=="string")return(0,e.jsx)(m.A,{children:r("errorBoundary.title",{slackChannel:n})});if(!n.href)return(0,e.jsx)(m.A,{children:r("errorBoundary.title",{slackChannel:n.name})})}else return null;return(0,e.jsx)(L.z,{to:n.href,variant:"contained",children:n.name})},o=class extends O.Component{constructor(n){super(n),this.state={error:void 0,errorInfo:void 0}}componentDidCatch(n,r){console.error(`ErrorBoundary, error: ${n}`,{error:n,errorInfo:r}),this.setState({error:n,errorInfo:r})}render(){const{slackChannel:n,children:r}=this.props,{error:T}=this.state;return T?(0,e.jsx)(u.b,{title:"Something Went Wrong",error:T,children:(0,e.jsx)(I,{slackChannel:n})}):r}},D=(0,C.A)(s=>({noPadding:{padding:0,"&:last-child":{paddingBottom:0}},contentAlignBottom:{display:"flex",alignItems:"self-end"},header:{padding:s.spacing(2,2,2,2.5)},headerTitle:{fontWeight:s.typography.fontWeightBold},headerSubheader:{paddingTop:s.spacing(1)},headerAvatar:{},headerAction:{},headerContent:{},subheader:{display:"flex"}}),{name:"BackstageInfoCard"}),V=(0,c.A)(s=>({root:{display:"inline-block",padding:s.spacing(8,8,0,0),float:"right"}}),{name:"BackstageInfoCardCardActionsTopRight"})(E.A),h={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 B(s){const{title:n,subheader:r,divider:T=!0,deepLink:R,slackChannel:P,errorBoundaryProps:N,variant:b,alignContent:H="normal",children:A,headerStyle:z,headerProps:k,icon:F,action:w,actionsClassName:G,actions:J,cardClassName:Z,actionsTopRight:X,className:q,noPadding:_,titleTypographyProps:tt,subheaderTypographyProps:et}=s,K=D();let Y={},$={};b&&b.split(/[\s]+/g).forEach(Q=>{Y={...Y,...h.card[Q]},$={...$,...h.cardContent[Q]}});const nt=()=>!r&&!F?null:(0,e.jsxs)("div",{"data-testid":"info-card-subheader",children:[r&&(0,e.jsx)("div",{className:K.subheader,children:r}),F]}),ot=N||(P?{slackChannel:P}:{});return(0,e.jsx)(p.A,{style:Y,className:q,children:(0,e.jsxs)(o,{...ot,children:[n&&(0,e.jsx)(g.A,{classes:{root:i()(K.header),title:K.headerTitle,subheader:K.headerSubheader,avatar:K.headerAvatar,action:K.headerAction,content:K.headerContent},title:n,subheader:nt(),action:w,style:{...z},titleTypographyProps:tt,subheaderTypographyProps:et,...k}),X&&(0,e.jsx)(V,{children:X}),T&&(0,e.jsx)(v.A,{}),(0,e.jsx)(d.A,{className:i()(Z,{[K.noPadding]:_,[K.contentAlignBottom]:H==="bottom"}),style:$,children:A}),J&&(0,e.jsx)(E.A,{className:G,children:J}),R&&(0,e.jsx)(x,{...R})]})})}},89648:(W,y,t)=>{t.d(y,{s:()=>S});var e=t(31085),p=t(58837),E=t(14041),d=t(51372),g=t(48514),v=t(67871),C=t(90184),c=t(8859),j=t(34428);const i=Object.freeze({createEntityRefColumn(f){const{defaultKind:x}=f;function L(u){return u.metadata?.title||(0,C.S)(u,{defaultKind:x})}return{title:"Name",highlight:!0,customFilterAndSearch(u,M){return L(M).includes(u)},customSort(u,M){return L(u).localeCompare(L(M))},render:u=>(0,e.jsx)(c.z,{entityRef:u,defaultKind:x,title:u.metadata?.title})}},createEntityRelationColumn(f){const{title:x,relation:L,defaultKind:u,filter:M}=f;function U(o){return(0,v.t)(o,L,M)}function I(o){return U(o).map(D=>(0,C.S)(D,{defaultKind:u})).join(", ")}return{title:x,customFilterAndSearch(o,D){return I(D).includes(o)},customSort(o,D){return I(o).localeCompare(I(D))},render:o=>(0,e.jsx)(j.i,{entityRefs:U(o),defaultKind:u})}},createOwnerColumn(){return this.createEntityRelationColumn({title:"Owner",relation:d.vv,defaultKind:"group"})},createDomainColumn(){return this.createEntityRelationColumn({title:"Domain",relation:d.jn,defaultKind:"domain",filter:{kind:"domain"}})},createSystemColumn(){return this.createEntityRelationColumn({title:"System",relation:d.jn,defaultKind:"system",filter:{kind:"system"}})},createMetadataDescriptionColumn(){return{title:"Description",field:"metadata.description",render:f=>(0,e.jsx)(g.M,{text:f.metadata.description,placement:"bottom-start",line:2})}},createSpecLifecycleColumn(){return{title:"Lifecycle",field:"spec.lifecycle"}},createSpecTypeColumn(){return{title:"Type",field:"spec.type"}}}),O=[i.createEntityRefColumn({defaultKind:"system"}),i.createDomainColumn(),i.createOwnerColumn(),i.createMetadataDescriptionColumn()],a=[i.createEntityRefColumn({defaultKind:"component"}),i.createSystemColumn(),i.createOwnerColumn(),i.createSpecTypeColumn(),i.createSpecLifecycleColumn(),i.createMetadataDescriptionColumn()];var m=t(14209);const l=(0,p.A)(f=>({empty:{padding:f.spacing(2),display:"flex",justifyContent:"center"}})),S=f=>{const{entities:x,title:L,emptyContent:u,variant:M="gridItem",columns:U,tableOptions:I={}}=f,o=l(),D={minWidth:"0",width:"100%"};return M==="gridItem"&&(D.height="calc(100% - 10px)"),(0,e.jsx)(m.X,{columns:U,title:L,style:D,emptyContent:u&&(0,e.jsx)("div",{className:o.empty,children:u}),options:{search:!1,paging:!1,actionsColumnIndex:-1,padding:"dense",draggable:!1,...I},data:x})};S.columns=i,S.systemEntityColumns=O,S.componentEntityColumns=a},99538:(W,y,t)=>{t.d(y,{T7:()=>c,TY:()=>O,tN:()=>i});var e=t(31085),p=t(6820),E=t(25862),d=t(43836),g=t(10602),v=t(14041);const C=(0,d.tK)("entity-context"),c=a=>{const{children:m,entity:l,loading:S,error:f,refresh:x}=a,L={entity:l,loading:S,error:f,refresh:x};return(0,e.jsx)(C.Provider,{value:(0,g.B)({1:L}),children:(0,e.jsx)(E.Ig,{attributes:{...l?{entityRef:(0,p.U2)(l)}:void 0},children:m})})},j=a=>_jsx(c,{entity:a.entity,loading:!a.entity,error:void 0,refresh:void 0,children:a.children});function i(){const a=(0,d.qO)("entity-context");if(!a)throw new Error("Entity context is not available");const m=a.atVersion(1);if(!m)throw new Error("EntityContext v1 not available");if(!m.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:m.entity}}function O(){const a=(0,d.qO)("entity-context");if(!a)throw new Error("Entity context is not available");const m=a.atVersion(1);if(!m)throw new Error("EntityContext v1 not available");const{entity:l,loading:S,error:f,refresh:x}=m;return{entity:l,loading:S,error:f,refresh:x}}},90759:(W,y,t)=>{t.d(y,{W:()=>p});var e=t(93184);const p=(0,e.h)({id:"catalog",messages:{indexPage:{title:"{{orgName}} Catalog",createButtonTitle:"Create",supportButtonContent:"All your software catalog entities"},aboutCard:{title:"About",refreshButtonTitle:"Schedule entity refresh",editButtonTitle:"Edit Metadata",createSimilarButtonTitle:"Create something similar",refreshScheduledMessage:"Refresh scheduled",launchTemplate:"Launch Template",viewTechdocs:"View TechDocs",viewSource:"View Source",descriptionField:{label:"Description",value:"No description"},ownerField:{label:"Owner",value:"No Owner"},domainField:{label:"Domain",value:"No Domain"},systemField:{label:"System",value:"No System"},parentComponentField:{label:"Parent Component",value:"No Parent Component"},typeField:{label:"Type"},lifecycleField:{label:"Lifecycle"},tagsField:{label:"Tags",value:"No Tags"},targetsField:{label:"Targets"}},searchResultItem:{lifecycle:"Lifecycle",Owner:"Owner"},catalogTable:{warningPanelTitle:"Could not fetch catalog entities.",viewActionTitle:"View",editActionTitle:"Edit",starActionTitle:"Add to favorites",unStarActionTitle:"Remove from favorites"},dependencyOfComponentsCard:{title:"Dependency of components",emptyMessage:"No component depends on this component"},dependsOnComponentsCard:{title:"Depends on components",emptyMessage:"No component is a dependency of this component"},dependsOnResourcesCard:{title:"Depends on resources",emptyMessage:"No resource is a dependency of this component"},entityContextMenu:{copiedMessage:"Copied!",moreButtonTitle:"More",inspectMenuTitle:"Inspect entity",copyURLMenuTitle:"Copy entity URL",unregisterMenuTitle:"Unregister entity"},entityLabelsCard:{title:"Labels",emptyDescription:"No labels defined for this entity. You can add labels to your entity YAML as shown in the highlighted example below:",readMoreButtonTitle:"Read more"},entityLabels:{warningPanelTitle:"Entity not found",ownerLabel:"Owner",lifecycleLabel:"Lifecycle"},entityLinksCard:{title:"Links",emptyDescription:"No links defined for this entity. You can add links to your entity YAML as shown in the highlighted example below:",readMoreButtonTitle:"Read more"},entityNotFound:{title:"Entity was not found",description:"Want to help us build this? Check out our Getting Started documentation.",docButtonTitle:"DOCS"},deleteEntity:{dialogTitle:"Are you sure you want to delete this entity?",deleteButtonTitle:"Delete",cancelButtonTitle:"Cancel",description:"This entity is not referenced by any location and is therefore not receiving updates. Click here to delete."},entityProcessingErrorsDescription:"The error below originates from",entityRelationWarningDescription:`This entity has relations to other entities, which can't be found in the catalog.
|
|
1
|
+
"use strict";(()=>{(self.webpackChunktechdocs_cli_embedded_app=self.webpackChunktechdocs_cli_embedded_app||[]).push([[124],{52235:(W,y,t)=>{var e,p=t(4293),E=t(78920);e={value:!0},y.A=void 0;var d=E(t(14041)),g=p(t(74044)),v=(0,g.default)(d.createElement("path",{d:"M12 4l-1.41 1.41L16.17 11H4v2h12.17l-5.58 5.59L12 20l8-8z"}),"ArrowForward");y.A=v},48514:(W,y,t)=>{t.d(y,{M:()=>C});var e=t(31085),p=t(58837),E=t(71677),d=t(14041),g=t(72501);const v=(0,p.A)({container:{overflow:"visible !important"},typo:{fontSize:"inherit",overflow:"hidden",textOverflow:"ellipsis",display:"-webkit-box","-webkit-line-clamp":({line:c})=>c||1,"-webkit-box-orient":"vertical"}},{name:"BackstageOverflowTooltip"});function C(c){const j=v(c);return(0,e.jsx)(E.Ay,{title:c.title??(c.text||""),placement:c.placement,children:(0,e.jsx)(g.A,{className:j.typo,variant:"inherit",children:c.text})})}},48045:(W,y,t)=>{t.d(y,{n:()=>B});var e=t(31085),p=t(40703),E=t(59469),d=t(48653),g=t(45685),v=t(37197),C=t(58837),c=t(87051),j=t(53373),i=t.n(j),O=t(14041),a=t(10394),m=t(72501),l=t(52235),S=t(72072);const f=(0,C.A)(s=>({root:{maxWidth:"fit-content",padding:s.spacing(2,2,2,2.5)},boxTitle:{margin:0,color:s.palette.textSubtle},arrow:{color:s.palette.textSubtle}}),{name:"BackstageBottomLink"});function x(s){const{link:n,title:r,onClick:T}=s,R=f();return(0,e.jsxs)(a.A,{children:[(0,e.jsx)(v.A,{}),(0,e.jsx)(S.N_,{to:n,onClick:T,underline:"none",children:(0,e.jsxs)(a.A,{display:"flex",alignItems:"center",className:R.root,children:[(0,e.jsx)(a.A,{className:R.boxTitle,fontWeight:"fontWeightBold",m:1,children:(0,e.jsx)(m.A,{children:(0,e.jsx)("strong",{children:r})})}),(0,e.jsx)(l.A,{className:R.arrow})]})})]})}var L=t(73896),u=t(22020),M=t(10315),U=t(87849);const I=s=>{const{slackChannel:n}=s,{t:r}=(0,U.i)(M.O);if(n){if(typeof n=="string")return(0,e.jsx)(m.A,{children:r("errorBoundary.title",{slackChannel:n})});if(!n.href)return(0,e.jsx)(m.A,{children:r("errorBoundary.title",{slackChannel:n.name})})}else return null;return(0,e.jsx)(L.z,{to:n.href,variant:"contained",children:n.name})},o=class extends O.Component{constructor(n){super(n),this.state={error:void 0,errorInfo:void 0}}componentDidCatch(n,r){console.error(`ErrorBoundary, error: ${n}`,{error:n,errorInfo:r}),this.setState({error:n,errorInfo:r})}render(){const{slackChannel:n,children:r}=this.props,{error:T}=this.state;return T?(0,e.jsx)(u.b,{title:"Something Went Wrong",error:T,children:(0,e.jsx)(I,{slackChannel:n})}):r}},D=(0,C.A)(s=>({noPadding:{padding:0,"&:last-child":{paddingBottom:0}},contentAlignBottom:{display:"flex",alignItems:"self-end"},header:{padding:s.spacing(2,2,2,2.5)},headerTitle:{fontWeight:s.typography.fontWeightBold},headerSubheader:{paddingTop:s.spacing(1)},headerAvatar:{},headerAction:{},headerContent:{},subheader:{display:"flex"}}),{name:"BackstageInfoCard"}),V=(0,c.A)(s=>({root:{display:"inline-block",padding:s.spacing(8,8,0,0),float:"right"}}),{name:"BackstageInfoCardCardActionsTopRight"})(E.A),h={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 B(s){const{title:n,subheader:r,divider:T=!0,deepLink:R,slackChannel:P,errorBoundaryProps:N,variant:b,alignContent:H="normal",children:A,headerStyle:z,headerProps:k,icon:F,action:w,actionsClassName:G,actions:J,cardClassName:Z,actionsTopRight:X,className:q,noPadding:_,titleTypographyProps:tt,subheaderTypographyProps:et}=s,K=D();let Y={},$={};b&&b.split(/[\s]+/g).forEach(Q=>{Y={...Y,...h.card[Q]},$={...$,...h.cardContent[Q]}});const nt=()=>!r&&!F?null:(0,e.jsxs)("div",{"data-testid":"info-card-subheader",children:[r&&(0,e.jsx)("div",{className:K.subheader,children:r}),F]}),ot=N||(P?{slackChannel:P}:{});return(0,e.jsx)(p.A,{style:Y,className:q,children:(0,e.jsxs)(o,{...ot,children:[n&&(0,e.jsx)(g.A,{classes:{root:i()(K.header),title:K.headerTitle,subheader:K.headerSubheader,avatar:K.headerAvatar,action:K.headerAction,content:K.headerContent},title:n,subheader:nt(),action:w,style:{...z},titleTypographyProps:tt,subheaderTypographyProps:et,...k}),X&&(0,e.jsx)(V,{children:X}),T&&(0,e.jsx)(v.A,{}),(0,e.jsx)(d.A,{className:i()(Z,{[K.noPadding]:_,[K.contentAlignBottom]:H==="bottom"}),style:$,children:A}),J&&(0,e.jsx)(E.A,{className:G,children:J}),R&&(0,e.jsx)(x,{...R})]})})}},89648:(W,y,t)=>{t.d(y,{s:()=>S});var e=t(31085),p=t(58837),E=t(14041),d=t(51372),g=t(48514),v=t(67871),C=t(90184),c=t(8859),j=t(34428);const i=Object.freeze({createEntityRefColumn(f){const{defaultKind:x}=f;function L(u){return u.metadata?.title||(0,C.S)(u,{defaultKind:x})}return{title:"Name",highlight:!0,customFilterAndSearch(u,M){return L(M).includes(u)},customSort(u,M){return L(u).localeCompare(L(M))},render:u=>(0,e.jsx)(c.z,{entityRef:u,defaultKind:x,title:u.metadata?.title})}},createEntityRelationColumn(f){const{title:x,relation:L,defaultKind:u,filter:M}=f;function U(o){return(0,v.t)(o,L,M)}function I(o){return U(o).map(D=>(0,C.S)(D,{defaultKind:u})).join(", ")}return{title:x,customFilterAndSearch(o,D){return I(D).includes(o)},customSort(o,D){return I(o).localeCompare(I(D))},render:o=>(0,e.jsx)(j.i,{entityRefs:U(o),defaultKind:u})}},createOwnerColumn(){return this.createEntityRelationColumn({title:"Owner",relation:d.vv,defaultKind:"group"})},createDomainColumn(){return this.createEntityRelationColumn({title:"Domain",relation:d.jn,defaultKind:"domain",filter:{kind:"domain"}})},createSystemColumn(){return this.createEntityRelationColumn({title:"System",relation:d.jn,defaultKind:"system",filter:{kind:"system"}})},createMetadataDescriptionColumn(){return{title:"Description",field:"metadata.description",render:f=>(0,e.jsx)(g.M,{text:f.metadata.description,placement:"bottom-start",line:2})}},createSpecLifecycleColumn(){return{title:"Lifecycle",field:"spec.lifecycle"}},createSpecTypeColumn(){return{title:"Type",field:"spec.type"}}}),O=[i.createEntityRefColumn({defaultKind:"system"}),i.createDomainColumn(),i.createOwnerColumn(),i.createMetadataDescriptionColumn()],a=[i.createEntityRefColumn({defaultKind:"component"}),i.createSystemColumn(),i.createOwnerColumn(),i.createSpecTypeColumn(),i.createSpecLifecycleColumn(),i.createMetadataDescriptionColumn()];var m=t(14209);const l=(0,p.A)(f=>({empty:{padding:f.spacing(2),display:"flex",justifyContent:"center"}})),S=f=>{const{entities:x,title:L,emptyContent:u,variant:M="gridItem",columns:U,tableOptions:I={}}=f,o=l(),D={minWidth:"0",width:"100%"};return M==="gridItem"&&(D.height="calc(100% - 10px)"),(0,e.jsx)(m.X,{columns:U,title:L,style:D,emptyContent:u&&(0,e.jsx)("div",{className:o.empty,children:u}),options:{search:!1,paging:!1,actionsColumnIndex:-1,padding:"dense",draggable:!1,...I},data:x})};S.columns=i,S.systemEntityColumns=O,S.componentEntityColumns=a},99538:(W,y,t)=>{t.d(y,{T7:()=>c,TY:()=>O,tN:()=>i});var e=t(31085),p=t(6820),E=t(25862),d=t(43836),g=t(10602),v=t(14041);const C=(0,d.tK)("entity-context"),c=a=>{const{children:m,entity:l,loading:S,error:f,refresh:x}=a,L={entity:l,loading:S,error:f,refresh:x};return(0,e.jsx)(C.Provider,{value:(0,g.B)({1:L}),children:(0,e.jsx)(E.Ig,{attributes:{...l?{entityRef:(0,p.U2)(l)}:void 0},children:m})})},j=a=>_jsx(c,{entity:a.entity,loading:!a.entity,error:void 0,refresh:void 0,children:a.children});function i(){const a=(0,d.qO)("entity-context");if(!a)throw new Error("Entity context is not available");const m=a.atVersion(1);if(!m)throw new Error("EntityContext v1 not available");if(!m.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:m.entity}}function O(){const a=(0,d.qO)("entity-context");if(!a)throw new Error("Entity context is not available");const m=a.atVersion(1);if(!m)throw new Error("EntityContext v1 not available");const{entity:l,loading:S,error:f,refresh:x}=m;return{entity:l,loading:S,error:f,refresh:x}}},90759:(W,y,t)=>{t.d(y,{W:()=>p});var e=t(93184);const p=(0,e.h)({id:"catalog",messages:{indexPage:{title:"{{orgName}} Catalog",createButtonTitle:"Create",supportButtonContent:"All your software catalog entities"},aboutCard:{title:"About",refreshButtonTitle:"Schedule entity refresh",editButtonTitle:"Edit Metadata",createSimilarButtonTitle:"Create something similar",refreshScheduledMessage:"Refresh scheduled",launchTemplate:"Launch Template",viewTechdocs:"View TechDocs",viewSource:"View Source",descriptionField:{label:"Description",value:"No description"},ownerField:{label:"Owner",value:"No Owner"},domainField:{label:"Domain",value:"No Domain"},systemField:{label:"System",value:"No System"},parentComponentField:{label:"Parent Component",value:"No Parent Component"},typeField:{label:"Type"},lifecycleField:{label:"Lifecycle"},tagsField:{label:"Tags",value:"No Tags"},targetsField:{label:"Targets"}},searchResultItem:{lifecycle:"Lifecycle",Owner:"Owner"},catalogTable:{warningPanelTitle:"Could not fetch catalog entities.",viewActionTitle:"View",editActionTitle:"Edit",starActionTitle:"Add to favorites",unStarActionTitle:"Remove from favorites"},dependencyOfComponentsCard:{title:"Dependency of components",emptyMessage:"No component depends on this component"},dependsOnComponentsCard:{title:"Depends on components",emptyMessage:"No component is a dependency of this component"},dependsOnResourcesCard:{title:"Depends on resources",emptyMessage:"No resource is a dependency of this component"},entityContextMenu:{copiedMessage:"Copied!",moreButtonTitle:"More",inspectMenuTitle:"Inspect entity",copyURLMenuTitle:"Copy entity URL",unregisterMenuTitle:"Unregister entity"},entityLabelsCard:{title:"Labels",emptyDescription:"No labels defined for this entity. You can add labels to your entity YAML as shown in the highlighted example below:",readMoreButtonTitle:"Read more"},entityLabels:{warningPanelTitle:"Entity not found",ownerLabel:"Owner",lifecycleLabel:"Lifecycle"},entityLinksCard:{title:"Links",emptyDescription:"No links defined for this entity. You can add links to your entity YAML as shown in the highlighted example below:",readMoreButtonTitle:"Read more"},entityNotFound:{title:"Entity was not found",description:"Want to help us build this? Check out our Getting Started documentation.",docButtonTitle:"DOCS"},deleteEntity:{dialogTitle:"Are you sure you want to delete this entity?",deleteButtonTitle:"Delete",cancelButtonTitle:"Cancel",description:"This entity is not referenced by any location and is therefore not receiving updates. Click here to delete."},entityProcessingErrorsDescription:"The error below originates from",entityRelationWarningDescription:`This entity has relations to other entities, which can't be found in the catalog.
|
|
2
2
|
Entities not found are: `,hasComponentsCard:{title:"Has components",emptyMessage:"No component is part of this system"},hasResourcesCard:{title:"Has resources",emptyMessage:"No resource is part of this system"},hasSubcomponentsCard:{title:"Has subcomponents",emptyMessage:"No subcomponent is part of this component"},hasSubdomainsCard:{title:"Has subdomains",emptyMessage:"No subdomain is part of this domain"},hasSystemsCard:{title:"Has systems",emptyMessage:"No system is part of this domain"},relatedEntitiesCard:{emptyHelpLinkTitle:"Learn how to change this"},systemDiagramCard:{title:"System Diagram",description:"Use pinch & zoom to move around the diagram.",edgeLabels:{partOf:"part of",provides:"provides",dependsOn:"depends on"}}}})},124:(W,y,t)=>{t.r(y),t.d(y,{DependencyOfComponentsCard:()=>c});var e=t(31085),p=t(51372),E=t(14041),d=t(48105),g=t(59251),v=t(90759),C=t(87849);function c(j){const{t:i}=(0,C.i)(v.W),{variant:O="gridItem",title:a=i("dependencyOfComponentsCard.title"),columns:m=d.mz,tableOptions:l={}}=j;return(0,e.jsx)(g.p,{variant:O,title:a,entityKind:"Component",relationType:p.fT,columns:m,emptyMessage:i("dependencyOfComponentsCard.emptyMessage"),emptyHelpLink:d.e2,asRenderableEntities:d.xJ,tableOptions:l})}},59251:(W,y,t)=>{t.d(y,{p:()=>h});var e=t(31085),p=t(72501),E=t(99538),d=t(6820),g=t(72427),v=t(73466),C=t(7341);function c(B,s){const n=s?.type?.toLocaleLowerCase("en-US"),r=s?.kind?.toLocaleLowerCase("en-US"),T=(0,g.gf)(C.v),{loading:R,value:P,error:N}=(0,v.A)(async()=>{const b=B.relations?.filter(A=>(!n||A.type.toLocaleLowerCase("en-US")===n)&&(!r||(0,d.KU)(A.targetRef).kind===r));if(!b?.length)return[];const{items:H}=await T.getEntitiesByRefs({entityRefs:b.map(A=>A.targetRef)});return H.filter(A=>!!A)},[B,n,r]);return{entities:P,loading:R,error:N}}var j=t(89648),i=t(14041),O=t(48045),a=t(68146),m=t(58837),l=t(37197),S=t(8109),f=t(5951),x=t(77310),L=t(37916),u=t(22020);const M=(0,m.A)(B=>({text:{fontFamily:"monospace",whiteSpace:"pre",overflowX:"auto",marginRight:B.spacing(2)},divider:{margin:B.spacing(2)}}),{name:"BackstageResponseErrorPanel"});function U(B){const{title:s,error:n,defaultExpanded:r}=B,T=M();if(n.name!=="ResponseError")return(0,e.jsx)(u.b,{title:s??n.message,defaultExpanded:r,error:n});const{body:R,cause:P}=n,{request:N,response:b}=R,H=`${b.statusCode}: ${P.name}`,A=N&&`${N.method} ${N.url}`,z=P.message.replace(/\\n/g,`
|
|
3
3
|
`),k=P.stack?.replace(/\\n/g,`
|
|
4
4
|
`),F=JSON.stringify(R,void 0,2);return(0,e.jsxs)(u.b,{title:s??n.message,defaultExpanded:r,error:{name:H,message:z,stack:k},children:[A&&(0,e.jsxs)(S.A,{alignItems:"flex-start",children:[(0,e.jsx)(f.A,{classes:{secondary:T.text},primary:"Request",secondary:N?`${A}`:void 0}),(0,e.jsx)(L.l,{text:A})]}),(0,e.jsxs)(e.Fragment,{children:[(0,e.jsx)(l.A,{component:"li",className:T.divider}),(0,e.jsx)(S.A,{alignItems:"flex-start",children:(0,e.jsx)(f.A,{classes:{secondary:T.text},primary:"Full Error as JSON"})}),(0,e.jsx)(x.z,{language:"json",text:F,showCopyCodeButton:!0})]})]})}var I=t(72072),o=t(48105),D=t(90759),V=t(87849);const h=B=>{const{variant:s="gridItem",title:n,columns:r,entityKind:T,relationType:R,emptyMessage:P,emptyHelpLink:N,asRenderableEntities:b,tableOptions:H={}}=B,{t:A}=(0,V.i)(D.W),{entity:z}=(0,E.tN)(),{entities:k,loading:F,error:w}=c(z,{type:R,kind:T});return F?(0,e.jsx)(O.n,{variant:s,title:n,children:(0,e.jsx)(a.k,{})}):w?(0,e.jsx)(O.n,{variant:s,title:n,children:(0,e.jsx)(U,{error:w})}):(0,e.jsx)(j.s,{title:n,variant:s,emptyContent:(0,e.jsxs)("div",{style:{textAlign:"center"},children:[(0,e.jsx)(p.A,{variant:"body1",children:P}),(0,e.jsx)(p.A,{variant:"body2",children:(0,e.jsx)(I.N_,{to:N,externalLinkIcon:!0,children:A("relatedEntitiesCard.emptyHelpLinkTitle")})})]}),columns:r,entities:b(k||[]),tableOptions:H})};h.componentEntityColumns=o.mz,h.componentEntityHelpLink=o.e2,h.asComponentEntities=o.xJ,h.resourceEntityColumns=o.v9,h.resourceEntityHelpLink=o.nz,h.asResourceEntities=o.eB,h.systemEntityColumns=o.MW,h.systemEntityHelpLink=o.iU,h.asSystemEntities=o.vy,h.domainEntityColums=o.xO,h.domainEntityHelpLink=o.Xr,h.asDomainEntities=o.QS},48105:(W,y,t)=>{t.d(y,{MW:()=>c,QS:()=>m,Xr:()=>a,e2:()=>E,eB:()=>C,iU:()=>j,mz:()=>p,nz:()=>v,v9:()=>g,vy:()=>i,xJ:()=>d,xO:()=>O});var e=t(89648);const p=[e.s.columns.createEntityRefColumn({defaultKind:"component"}),e.s.columns.createOwnerColumn(),e.s.columns.createSpecTypeColumn(),e.s.columns.createSpecLifecycleColumn(),e.s.columns.createMetadataDescriptionColumn()],E="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component",d=l=>l,g=[e.s.columns.createEntityRefColumn({defaultKind:"resource"}),e.s.columns.createOwnerColumn(),e.s.columns.createSpecTypeColumn(),e.s.columns.createSpecLifecycleColumn(),e.s.columns.createMetadataDescriptionColumn()],v="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-resource",C=l=>l,c=[e.s.columns.createEntityRefColumn({defaultKind:"system"}),e.s.columns.createOwnerColumn(),e.s.columns.createMetadataDescriptionColumn()],j="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-system",i=l=>l,O=[e.s.columns.createEntityRefColumn({defaultKind:"domain"}),e.s.columns.createOwnerColumn(),e.s.columns.createMetadataDescriptionColumn()],a="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-domain",m=l=>l}}]);})();
|
|
5
5
|
|
|
6
|
-
//# sourceMappingURL=124.
|
|
6
|
+
//# sourceMappingURL=124.9c3315bf.chunk.js.map
|