@backstage/plugin-app-backend 0.3.36 → 0.3.37-next.1
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 +23 -0
- package/alpha/package.json +6 -0
- package/dist/index.alpha.d.ts +105 -0
- package/dist/index.beta.d.ts +62 -0
- package/dist/index.cjs.js +34 -0
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +17 -5
- package/package.json +16 -11
- package/LICENSE +0 -201
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# @backstage/plugin-app-backend
|
|
2
2
|
|
|
3
|
+
## 0.3.37-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/backend-common@0.15.2-next.1
|
|
9
|
+
- @backstage/backend-plugin-api@0.1.3-next.1
|
|
10
|
+
- @backstage/config@1.0.3-next.1
|
|
11
|
+
- @backstage/config-loader@1.1.5-next.1
|
|
12
|
+
- @backstage/types@1.0.0
|
|
13
|
+
|
|
14
|
+
## 0.3.37-next.0
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- 11c9e0ad33: Added alpha plugin implementation for the new backend system. Available at `@backstage/plugin-app-backend/alpha`.
|
|
19
|
+
- Updated dependencies
|
|
20
|
+
- @backstage/backend-plugin-api@0.1.3-next.0
|
|
21
|
+
- @backstage/backend-common@0.15.2-next.0
|
|
22
|
+
- @backstage/config@1.0.3-next.0
|
|
23
|
+
- @backstage/config-loader@1.1.5-next.0
|
|
24
|
+
- @backstage/types@1.0.0
|
|
25
|
+
|
|
3
26
|
## 0.3.36
|
|
4
27
|
|
|
5
28
|
### Patch Changes
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A Backstage backend plugin that serves the Backstage frontend app
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
8
|
+
import { Config } from '@backstage/config';
|
|
9
|
+
import express from 'express';
|
|
10
|
+
import { Logger } from 'winston';
|
|
11
|
+
import { PluginDatabaseManager } from '@backstage/backend-common';
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* The App plugin is responsible for serving the frontend app bundle and static assets.
|
|
15
|
+
* @alpha
|
|
16
|
+
*/
|
|
17
|
+
export declare const appPlugin: (options: AppPluginOptions) => BackendFeature;
|
|
18
|
+
|
|
19
|
+
/** @alpha */
|
|
20
|
+
export declare type AppPluginOptions = {
|
|
21
|
+
/**
|
|
22
|
+
* The name of the app package (in most Backstage repositories, this is the
|
|
23
|
+
* "name" field in `packages/app/package.json`) that content should be served
|
|
24
|
+
* from. The same app package should be added as a dependency to the backend
|
|
25
|
+
* package in order for it to be accessible at runtime.
|
|
26
|
+
*
|
|
27
|
+
* In a typical setup with a single app package, this will default to 'app'.
|
|
28
|
+
*/
|
|
29
|
+
appPackageName?: string;
|
|
30
|
+
/**
|
|
31
|
+
* A request handler to handle requests for static content that are not present in the app bundle.
|
|
32
|
+
*
|
|
33
|
+
* This can be used to avoid issues with clients on older deployment versions trying to access lazy
|
|
34
|
+
* loaded content that is no longer present. Typically the requests would fall back to a long-term
|
|
35
|
+
* object store where all recently deployed versions of the app are present.
|
|
36
|
+
*
|
|
37
|
+
* Another option is to provide a `database` that will take care of storing the static assets instead.
|
|
38
|
+
*
|
|
39
|
+
* If both `database` and `staticFallbackHandler` are provided, the `database` will attempt to serve
|
|
40
|
+
* static assets first, and if they are not found, the `staticFallbackHandler` will be called.
|
|
41
|
+
*/
|
|
42
|
+
staticFallbackHandler?: express.Handler;
|
|
43
|
+
/**
|
|
44
|
+
* Disables the configuration injection. This can be useful if you're running in an environment
|
|
45
|
+
* with a read-only filesystem, or for some other reason don't want configuration to be injected.
|
|
46
|
+
*
|
|
47
|
+
* Note that this will cause the configuration used when building the app bundle to be used, unless
|
|
48
|
+
* a separate configuration loading strategy is set up.
|
|
49
|
+
*
|
|
50
|
+
* This also disables configuration injection though `APP_CONFIG_` environment variables.
|
|
51
|
+
*/
|
|
52
|
+
disableConfigInjection?: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* By default the app backend plugin will cache previously deployed static assets in the database.
|
|
55
|
+
* If you disable this, it is recommended to set a `staticFallbackHandler` instead.
|
|
56
|
+
*/
|
|
57
|
+
disableStaticFallbackCache?: boolean;
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
/** @public */
|
|
61
|
+
export declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
62
|
+
|
|
63
|
+
/** @public */
|
|
64
|
+
export declare interface RouterOptions {
|
|
65
|
+
config: Config;
|
|
66
|
+
logger: Logger;
|
|
67
|
+
/**
|
|
68
|
+
* If a database is provided it will be used to cache previously deployed static assets.
|
|
69
|
+
*
|
|
70
|
+
* This is a built-in alternative to using a `staticFallbackHandler`.
|
|
71
|
+
*/
|
|
72
|
+
database?: PluginDatabaseManager;
|
|
73
|
+
/**
|
|
74
|
+
* The name of the app package that content should be served from. The same app package should be
|
|
75
|
+
* added as a dependency to the backend package in order for it to be accessible at runtime.
|
|
76
|
+
*
|
|
77
|
+
* In a typical setup with a single app package this would be set to 'app'.
|
|
78
|
+
*/
|
|
79
|
+
appPackageName: string;
|
|
80
|
+
/**
|
|
81
|
+
* A request handler to handle requests for static content that are not present in the app bundle.
|
|
82
|
+
*
|
|
83
|
+
* This can be used to avoid issues with clients on older deployment versions trying to access lazy
|
|
84
|
+
* loaded content that is no longer present. Typically the requests would fall back to a long-term
|
|
85
|
+
* object store where all recently deployed versions of the app are present.
|
|
86
|
+
*
|
|
87
|
+
* Another option is to provide a `database` that will take care of storing the static assets instead.
|
|
88
|
+
*
|
|
89
|
+
* If both `database` and `staticFallbackHandler` are provided, the `database` will attempt to serve
|
|
90
|
+
* static assets first, and if they are not found, the `staticFallbackHandler` will be called.
|
|
91
|
+
*/
|
|
92
|
+
staticFallbackHandler?: express.Handler;
|
|
93
|
+
/**
|
|
94
|
+
* Disables the configuration injection. This can be useful if you're running in an environment
|
|
95
|
+
* with a read-only filesystem, or for some other reason don't want configuration to be injected.
|
|
96
|
+
*
|
|
97
|
+
* Note that this will cause the configuration used when building the app bundle to be used, unless
|
|
98
|
+
* a separate configuration loading strategy is set up.
|
|
99
|
+
*
|
|
100
|
+
* This also disables configuration injection though `APP_CONFIG_` environment variables.
|
|
101
|
+
*/
|
|
102
|
+
disableConfigInjection?: boolean;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export { }
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A Backstage backend plugin that serves the Backstage frontend app
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
8
|
+
import { Config } from '@backstage/config';
|
|
9
|
+
import express from 'express';
|
|
10
|
+
import { Logger } from 'winston';
|
|
11
|
+
import { PluginDatabaseManager } from '@backstage/backend-common';
|
|
12
|
+
|
|
13
|
+
/* Excluded from this release type: appPlugin */
|
|
14
|
+
|
|
15
|
+
/* Excluded from this release type: AppPluginOptions */
|
|
16
|
+
|
|
17
|
+
/** @public */
|
|
18
|
+
export declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
19
|
+
|
|
20
|
+
/** @public */
|
|
21
|
+
export declare interface RouterOptions {
|
|
22
|
+
config: Config;
|
|
23
|
+
logger: Logger;
|
|
24
|
+
/**
|
|
25
|
+
* If a database is provided it will be used to cache previously deployed static assets.
|
|
26
|
+
*
|
|
27
|
+
* This is a built-in alternative to using a `staticFallbackHandler`.
|
|
28
|
+
*/
|
|
29
|
+
database?: PluginDatabaseManager;
|
|
30
|
+
/**
|
|
31
|
+
* The name of the app package that content should be served from. The same app package should be
|
|
32
|
+
* added as a dependency to the backend package in order for it to be accessible at runtime.
|
|
33
|
+
*
|
|
34
|
+
* In a typical setup with a single app package this would be set to 'app'.
|
|
35
|
+
*/
|
|
36
|
+
appPackageName: string;
|
|
37
|
+
/**
|
|
38
|
+
* A request handler to handle requests for static content that are not present in the app bundle.
|
|
39
|
+
*
|
|
40
|
+
* This can be used to avoid issues with clients on older deployment versions trying to access lazy
|
|
41
|
+
* loaded content that is no longer present. Typically the requests would fall back to a long-term
|
|
42
|
+
* object store where all recently deployed versions of the app are present.
|
|
43
|
+
*
|
|
44
|
+
* Another option is to provide a `database` that will take care of storing the static assets instead.
|
|
45
|
+
*
|
|
46
|
+
* If both `database` and `staticFallbackHandler` are provided, the `database` will attempt to serve
|
|
47
|
+
* static assets first, and if they are not found, the `staticFallbackHandler` will be called.
|
|
48
|
+
*/
|
|
49
|
+
staticFallbackHandler?: express.Handler;
|
|
50
|
+
/**
|
|
51
|
+
* Disables the configuration injection. This can be useful if you're running in an environment
|
|
52
|
+
* with a read-only filesystem, or for some other reason don't want configuration to be injected.
|
|
53
|
+
*
|
|
54
|
+
* Note that this will cause the configuration used when building the app bundle to be used, unless
|
|
55
|
+
* a separate configuration loading strategy is set up.
|
|
56
|
+
*
|
|
57
|
+
* This also disables configuration injection though `APP_CONFIG_` environment variables.
|
|
58
|
+
*/
|
|
59
|
+
disableConfigInjection?: boolean;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export { }
|
package/dist/index.cjs.js
CHANGED
|
@@ -12,6 +12,7 @@ var configLoader = require('@backstage/config-loader');
|
|
|
12
12
|
var luxon = require('luxon');
|
|
13
13
|
var partition = require('lodash/partition');
|
|
14
14
|
var globby = require('globby');
|
|
15
|
+
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
15
16
|
|
|
16
17
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
17
18
|
|
|
@@ -272,5 +273,38 @@ async function createRouter(options) {
|
|
|
272
273
|
return router;
|
|
273
274
|
}
|
|
274
275
|
|
|
276
|
+
const appPlugin = backendPluginApi.createBackendPlugin({
|
|
277
|
+
id: "app",
|
|
278
|
+
register(env, options) {
|
|
279
|
+
env.registerInit({
|
|
280
|
+
deps: {
|
|
281
|
+
logger: backendPluginApi.loggerServiceRef,
|
|
282
|
+
config: backendPluginApi.configServiceRef,
|
|
283
|
+
database: backendPluginApi.databaseServiceRef,
|
|
284
|
+
httpRouter: backendPluginApi.httpRouterServiceRef
|
|
285
|
+
},
|
|
286
|
+
async init({ logger, config, database, httpRouter }) {
|
|
287
|
+
const {
|
|
288
|
+
appPackageName,
|
|
289
|
+
staticFallbackHandler,
|
|
290
|
+
disableConfigInjection,
|
|
291
|
+
disableStaticFallbackCache
|
|
292
|
+
} = options;
|
|
293
|
+
const winstonLogger = backendPluginApi.loggerToWinstonLogger(logger);
|
|
294
|
+
const router = await createRouter({
|
|
295
|
+
logger: winstonLogger,
|
|
296
|
+
config,
|
|
297
|
+
database: disableStaticFallbackCache ? void 0 : database,
|
|
298
|
+
appPackageName: appPackageName != null ? appPackageName : "app",
|
|
299
|
+
staticFallbackHandler,
|
|
300
|
+
disableConfigInjection
|
|
301
|
+
});
|
|
302
|
+
httpRouter.use(router);
|
|
303
|
+
}
|
|
304
|
+
});
|
|
305
|
+
}
|
|
306
|
+
});
|
|
307
|
+
|
|
308
|
+
exports.appPlugin = appPlugin;
|
|
275
309
|
exports.createRouter = createRouter;
|
|
276
310
|
//# sourceMappingURL=index.cjs.js.map
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/lib/config.ts","../src/lib/assets/StaticAssetsStore.ts","../src/lib/assets/findStaticAssets.ts","../src/lib/headers.ts","../src/lib/assets/createStaticAssetMiddleware.ts","../src/service/router.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 fs from 'fs-extra';\nimport { resolve as resolvePath } from 'path';\nimport { Logger } from 'winston';\nimport { AppConfig, Config } from '@backstage/config';\nimport { JsonObject } from '@backstage/types';\nimport { loadConfigSchema, readEnvConfig } from '@backstage/config-loader';\n\ntype InjectOptions = {\n appConfigs: AppConfig[];\n // Directory of the static JS files to search for file to inject\n staticDir: string;\n logger: Logger;\n};\n\n/**\n * Injects configs into the app bundle, replacing any existing injected config.\n */\nexport async function injectConfig(options: InjectOptions) {\n const { staticDir, logger, appConfigs } = options;\n\n const files = await fs.readdir(staticDir);\n const jsFiles = files.filter(file => file.endsWith('.js'));\n\n const escapedData = JSON.stringify(appConfigs).replace(/(\"|'|\\\\)/g, '\\\\$1');\n const injected = `/*__APP_INJECTED_CONFIG_MARKER__*/\"${escapedData}\"/*__INJECTED_END__*/`;\n\n for (const jsFile of jsFiles) {\n const path = resolvePath(staticDir, jsFile);\n\n const content = await fs.readFile(path, 'utf8');\n if (content.includes('__APP_INJECTED_RUNTIME_CONFIG__')) {\n logger.info(`Injecting env config into ${jsFile}`);\n\n const newContent = content.replace(\n '\"__APP_INJECTED_RUNTIME_CONFIG__\"',\n injected,\n );\n await fs.writeFile(path, newContent, 'utf8');\n return;\n } else if (content.includes('__APP_INJECTED_CONFIG_MARKER__')) {\n logger.info(`Replacing injected env config in ${jsFile}`);\n\n const newContent = content.replace(\n /\\/\\*__APP_INJECTED_CONFIG_MARKER__\\*\\/.*\\/\\*__INJECTED_END__\\*\\//,\n injected,\n );\n await fs.writeFile(path, newContent, 'utf8');\n return;\n }\n }\n logger.info('Env config not injected');\n}\n\ntype ReadOptions = {\n env: { [name: string]: string | undefined };\n appDistDir: string;\n config: Config;\n};\n\n/**\n * Read config from environment and process the backend config using the\n * schema that is embedded in the frontend build.\n */\nexport async function readConfigs(options: ReadOptions): Promise<AppConfig[]> {\n const { env, appDistDir, config } = options;\n\n const appConfigs = readEnvConfig(env);\n\n const schemaPath = resolvePath(appDistDir, '.config-schema.json');\n if (await fs.pathExists(schemaPath)) {\n const serializedSchema = await fs.readJson(schemaPath);\n\n try {\n const schema = await loadConfigSchema({ serialized: serializedSchema });\n\n const frontendConfigs = await schema.process(\n [{ data: config.get() as JsonObject, context: 'app' }],\n { visibility: ['frontend'], withDeprecatedKeys: true },\n );\n appConfigs.push(...frontendConfigs);\n } catch (error) {\n throw new Error(\n 'Invalid app bundle schema. If this error is unexpected you need to run `yarn build` in the app. ' +\n `If that doesn't help you should make sure your config schema is correct and rebuild the app bundle again. ` +\n `Caused by the following schema error, ${error}`,\n );\n }\n }\n\n return appConfigs;\n}\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n PluginDatabaseManager,\n resolvePackagePath,\n} from '@backstage/backend-common';\nimport { Knex } from 'knex';\nimport { Logger } from 'winston';\nimport { DateTime } from 'luxon';\nimport partition from 'lodash/partition';\nimport { StaticAsset, StaticAssetInput, StaticAssetProvider } from './types';\n\nconst migrationsDir = resolvePackagePath(\n '@backstage/plugin-app-backend',\n 'migrations',\n);\n\ninterface StaticAssetRow {\n path: string;\n content: Buffer;\n last_modified_at: Date;\n}\n\n/** @internal */\nexport interface StaticAssetsStoreOptions {\n database: PluginDatabaseManager;\n logger: Logger;\n}\n\n/**\n * A storage for static assets that are assumed to be immutable.\n *\n * @internal\n */\nexport class StaticAssetsStore implements StaticAssetProvider {\n #db: Knex;\n #logger: Logger;\n\n static async create(options: StaticAssetsStoreOptions) {\n const { database } = options;\n const client = await database.getClient();\n\n if (!database.migrations?.skip) {\n await client.migrate.latest({\n directory: migrationsDir,\n });\n }\n\n return new StaticAssetsStore(client, options.logger);\n }\n\n private constructor(client: Knex, logger: Logger) {\n this.#db = client;\n this.#logger = logger;\n }\n\n /**\n * Store the provided assets.\n *\n * If an asset for a given path already exists the modification time will be\n * updated, but the contents will not.\n */\n async storeAssets(assets: StaticAssetInput[]) {\n const existingRows = await this.#db<StaticAssetRow>(\n 'static_assets_cache',\n ).whereIn(\n 'path',\n assets.map(a => a.path),\n );\n const existingAssetPaths = new Set(existingRows.map(r => r.path));\n\n const [modified, added] = partition(assets, asset =>\n existingAssetPaths.has(asset.path),\n );\n\n this.#logger.info(\n `Storing ${modified.length} updated assets and ${added.length} new assets`,\n );\n\n await this.#db('static_assets_cache')\n .update({\n last_modified_at: this.#db.fn.now(),\n })\n .whereIn(\n 'path',\n modified.map(a => a.path),\n );\n\n for (const asset of added) {\n // We ignore conflicts with other nodes, it doesn't matter if someone else\n // added the same asset just before us.\n await this.#db('static_assets_cache')\n .insert({\n path: asset.path,\n content: await asset.content(),\n })\n .onConflict('path')\n .ignore();\n }\n }\n\n /**\n * Retrieve an asset from the store with the given path.\n */\n async getAsset(path: string): Promise<StaticAsset | undefined> {\n const [row] = await this.#db<StaticAssetRow>('static_assets_cache').where({\n path,\n });\n if (!row) {\n return undefined;\n }\n return {\n path: row.path,\n content: row.content,\n lastModifiedAt:\n typeof row.last_modified_at === 'string'\n ? DateTime.fromSQL(row.last_modified_at, { zone: 'UTC' }).toJSDate()\n : row.last_modified_at,\n };\n }\n\n /**\n * Delete any assets from the store whose modification time is older than the max age.\n */\n async trimAssets(options: { maxAgeSeconds: number }) {\n const { maxAgeSeconds } = options;\n await this.#db<StaticAssetRow>('static_assets_cache')\n .where(\n 'last_modified_at',\n '<=',\n this.#db.client.config.client.includes('sqlite3')\n ? this.#db.raw(`datetime('now', ?)`, [`-${maxAgeSeconds} seconds`])\n : this.#db.raw(`now() + interval '${-maxAgeSeconds} seconds'`),\n )\n .delete();\n }\n}\n","/*\n * Copyright 2021 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 fs from 'fs-extra';\nimport globby from 'globby';\nimport { StaticAssetInput } from './types';\nimport { resolveSafeChildPath } from '@backstage/backend-common';\n\n/**\n * Finds all static assets within a directory\n *\n * @internal\n */\nexport async function findStaticAssets(\n staticDir: string,\n): Promise<StaticAssetInput[]> {\n const assetPaths = await globby('**/*', {\n ignore: ['**/*.map'], // Ignore source maps since they're quite large\n cwd: staticDir,\n dot: true,\n });\n\n return assetPaths.map(path => ({\n path,\n content: async () => fs.readFile(resolveSafeChildPath(staticDir, path)),\n }));\n}\n","/*\n * Copyright 2021 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\nexport const CACHE_CONTROL_NO_CACHE = 'no-store, max-age=0';\nexport const CACHE_CONTROL_MAX_CACHE = 'public, max-age=1209600'; // 14 days\n","/*\n * Copyright 2021 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 { extname } from 'path';\nimport { RequestHandler } from 'express';\nimport { StaticAssetProvider } from './types';\nimport { CACHE_CONTROL_MAX_CACHE } from '../headers';\n\n/**\n * Creates a middleware that serves static assets from a static asset provider\n *\n * @internal\n */\nexport function createStaticAssetMiddleware(\n store: StaticAssetProvider,\n): RequestHandler {\n return (req, res, next) => {\n if (req.method !== 'GET' && req.method !== 'HEAD') {\n next();\n return;\n }\n\n // Let's not assume we're in promise-router\n Promise.resolve(\n (async () => {\n // Drop leading slashes from the incoming path\n const path = req.path.startsWith('/') ? req.path.slice(1) : req.path;\n\n const asset = await store.getAsset(path);\n if (!asset) {\n next();\n return;\n }\n\n // Set the Content-Type header, falling back to octet-stream\n const ext = extname(asset.path);\n if (ext) {\n res.type(ext);\n } else {\n res.type('bin');\n }\n\n // Same as our express.static override\n res.setHeader('Cache-Control', CACHE_CONTROL_MAX_CACHE);\n res.setHeader('Last-Modified', asset.lastModifiedAt.toUTCString());\n\n res.send(asset.content);\n })(),\n ).catch(next);\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 {\n notFoundHandler,\n PluginDatabaseManager,\n resolvePackagePath,\n} from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport helmet from 'helmet';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport fs from 'fs-extra';\nimport { resolve as resolvePath } from 'path';\nimport { Logger } from 'winston';\nimport { injectConfig, readConfigs } from '../lib/config';\nimport {\n StaticAssetsStore,\n findStaticAssets,\n createStaticAssetMiddleware,\n} from '../lib/assets';\nimport {\n CACHE_CONTROL_MAX_CACHE,\n CACHE_CONTROL_NO_CACHE,\n} from '../lib/headers';\n\n// express uses mime v1 while we only have types for mime v2\ntype Mime = { lookup(arg0: string): string };\n\n/** @public */\nexport interface RouterOptions {\n config: Config;\n logger: Logger;\n\n /**\n * If a database is provided it will be used to cache previously deployed static assets.\n *\n * This is a built-in alternative to using a `staticFallbackHandler`.\n */\n database?: PluginDatabaseManager;\n\n /**\n * The name of the app package that content should be served from. The same app package should be\n * added as a dependency to the backend package in order for it to be accessible at runtime.\n *\n * In a typical setup with a single app package this would be set to 'app'.\n */\n appPackageName: string;\n\n /**\n * A request handler to handle requests for static content that are not present in the app bundle.\n *\n * This can be used to avoid issues with clients on older deployment versions trying to access lazy\n * loaded content that is no longer present. Typically the requests would fall back to a long-term\n * object store where all recently deployed versions of the app are present.\n *\n * Another option is to provide a `database` that will take care of storing the static assets instead.\n *\n * If both `database` and `staticFallbackHandler` are provided, the `database` will attempt to serve\n * static assets first, and if they are not found, the `staticFallbackHandler` will be called.\n */\n staticFallbackHandler?: express.Handler;\n\n /**\n * Disables the configuration injection. This can be useful if you're running in an environment\n * with a read-only filesystem, or for some other reason don't want configuration to be injected.\n *\n * Note that this will cause the configuration used when building the app bundle to be used, unless\n * a separate configuration loading strategy is set up.\n *\n * This also disables configuration injection though `APP_CONFIG_` environment variables.\n */\n disableConfigInjection?: boolean;\n}\n\n/** @public */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { config, logger, appPackageName, staticFallbackHandler } = options;\n\n const appDistDir = resolvePackagePath(appPackageName, 'dist');\n const staticDir = resolvePath(appDistDir, 'static');\n\n if (!(await fs.pathExists(staticDir))) {\n logger.warn(\n `Can't serve static app content from ${staticDir}, directory doesn't exist`,\n );\n\n return Router();\n }\n\n logger.info(`Serving static app content from ${appDistDir}`);\n\n if (!options.disableConfigInjection) {\n const appConfigs = await readConfigs({\n config,\n appDistDir,\n env: process.env,\n });\n\n await injectConfig({ appConfigs, logger, staticDir });\n }\n\n const router = Router();\n\n router.use(helmet.frameguard({ action: 'deny' }));\n\n // Use a separate router for static content so that a fallback can be provided by backend\n const staticRouter = Router();\n staticRouter.use(\n express.static(resolvePath(appDistDir, 'static'), {\n setHeaders: res => {\n res.setHeader('Cache-Control', CACHE_CONTROL_MAX_CACHE);\n },\n }),\n );\n\n if (options.database) {\n const store = await StaticAssetsStore.create({\n logger,\n database: options.database,\n });\n\n const assets = await findStaticAssets(staticDir);\n await store.storeAssets(assets);\n // Remove any assets that are older than 7 days\n await store.trimAssets({ maxAgeSeconds: 60 * 60 * 24 * 7 });\n\n staticRouter.use(createStaticAssetMiddleware(store));\n }\n\n if (staticFallbackHandler) {\n staticRouter.use(staticFallbackHandler);\n }\n staticRouter.use(notFoundHandler());\n\n router.use('/static', staticRouter);\n router.use(\n express.static(appDistDir, {\n setHeaders: (res, path) => {\n // The Cache-Control header instructs the browser to not cache html files since it might\n // link to static assets from recently deployed versions.\n if (\n (express.static.mime as unknown as Mime).lookup(path) === 'text/html'\n ) {\n res.setHeader('Cache-Control', CACHE_CONTROL_NO_CACHE);\n }\n },\n }),\n );\n router.get('/*', (_req, res) => {\n res.sendFile(resolvePath(appDistDir, 'index.html'), {\n headers: {\n // The Cache-Control header instructs the browser to not cache the index.html since it might\n // link to static assets from recently deployed versions.\n 'cache-control': CACHE_CONTROL_NO_CACHE,\n },\n });\n });\n\n return router;\n}\n"],"names":["fs","path","resolvePath","readEnvConfig","loadConfigSchema","resolvePackagePath","partition","DateTime","globby","resolveSafeChildPath","extname","Router","helmet","express","notFoundHandler"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAiCA,eAAsB,aAAa,OAAwB,EAAA;AACzD,EAAA,MAAM,EAAE,SAAA,EAAW,MAAQ,EAAA,UAAA,EAAe,GAAA,OAAA,CAAA;AAE1C,EAAA,MAAM,KAAQ,GAAA,MAAMA,sBAAG,CAAA,OAAA,CAAQ,SAAS,CAAA,CAAA;AACxC,EAAA,MAAM,UAAU,KAAM,CAAA,MAAA,CAAO,UAAQ,IAAK,CAAA,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AAEzD,EAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,UAAU,CAAE,CAAA,OAAA,CAAQ,aAAa,MAAM,CAAA,CAAA;AAC1E,EAAA,MAAM,WAAW,CAAsC,mCAAA,EAAA,WAAA,CAAA,qBAAA,CAAA,CAAA;AAEvD,EAAA,KAAA,MAAW,UAAU,OAAS,EAAA;AAC5B,IAAM,MAAAC,MAAA,GAAOC,YAAY,CAAA,SAAA,EAAW,MAAM,CAAA,CAAA;AAE1C,IAAA,MAAM,OAAU,GAAA,MAAMF,sBAAG,CAAA,QAAA,CAASC,QAAM,MAAM,CAAA,CAAA;AAC9C,IAAI,IAAA,OAAA,CAAQ,QAAS,CAAA,iCAAiC,CAAG,EAAA;AACvD,MAAO,MAAA,CAAA,IAAA,CAAK,6BAA6B,MAAQ,CAAA,CAAA,CAAA,CAAA;AAEjD,MAAA,MAAM,aAAa,OAAQ,CAAA,OAAA;AAAA,QACzB,mCAAA;AAAA,QACA,QAAA;AAAA,OACF,CAAA;AACA,MAAA,MAAMD,sBAAG,CAAA,SAAA,CAAUC,MAAM,EAAA,UAAA,EAAY,MAAM,CAAA,CAAA;AAC3C,MAAA,OAAA;AAAA,KACS,MAAA,IAAA,OAAA,CAAQ,QAAS,CAAA,gCAAgC,CAAG,EAAA;AAC7D,MAAO,MAAA,CAAA,IAAA,CAAK,oCAAoC,MAAQ,CAAA,CAAA,CAAA,CAAA;AAExD,MAAA,MAAM,aAAa,OAAQ,CAAA,OAAA;AAAA,QACzB,kEAAA;AAAA,QACA,QAAA;AAAA,OACF,CAAA;AACA,MAAA,MAAMD,sBAAG,CAAA,SAAA,CAAUC,MAAM,EAAA,UAAA,EAAY,MAAM,CAAA,CAAA;AAC3C,MAAA,OAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA,CAAA;AACvC,CAAA;AAYA,eAAsB,YAAY,OAA4C,EAAA;AAC5E,EAAA,MAAM,EAAE,GAAA,EAAK,UAAY,EAAA,MAAA,EAAW,GAAA,OAAA,CAAA;AAEpC,EAAM,MAAA,UAAA,GAAaE,2BAAc,GAAG,CAAA,CAAA;AAEpC,EAAM,MAAA,UAAA,GAAaD,YAAY,CAAA,UAAA,EAAY,qBAAqB,CAAA,CAAA;AAChE,EAAA,IAAI,MAAMF,sBAAA,CAAG,UAAW,CAAA,UAAU,CAAG,EAAA;AACnC,IAAA,MAAM,gBAAmB,GAAA,MAAMA,sBAAG,CAAA,QAAA,CAAS,UAAU,CAAA,CAAA;AAErD,IAAI,IAAA;AACF,MAAA,MAAM,SAAS,MAAMI,6BAAA,CAAiB,EAAE,UAAA,EAAY,kBAAkB,CAAA,CAAA;AAEtE,MAAM,MAAA,eAAA,GAAkB,MAAM,MAAO,CAAA,OAAA;AAAA,QACnC,CAAC,EAAE,IAAM,EAAA,MAAA,CAAO,KAAqB,EAAA,OAAA,EAAS,OAAO,CAAA;AAAA,QACrD,EAAE,UAAY,EAAA,CAAC,UAAU,CAAA,EAAG,oBAAoB,IAAK,EAAA;AAAA,OACvD,CAAA;AACA,MAAW,UAAA,CAAA,IAAA,CAAK,GAAG,eAAe,CAAA,CAAA;AAAA,aAC3B,KAAP,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAE2C,kPAAA,EAAA,KAAA,CAAA,CAAA;AAAA,OAC7C,CAAA;AAAA,KACF;AAAA,GACF;AAEA,EAAO,OAAA,UAAA,CAAA;AACT;;;;;;;;;;;;;;;;;;;;AC1GA,IAAA,GAAA,EAAA,OAAA,CAAA;AA0BA,MAAM,aAAgB,GAAAC,gCAAA;AAAA,EACpB,+BAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAmBO,MAAM,qBAAN,MAAuD;AAAA,EAiBpD,WAAA,CAAY,QAAc,MAAgB,EAAA;AAhBlD,IAAA,YAAA,CAAA,IAAA,EAAA,GAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAgBE,IAAA,YAAA,CAAA,IAAA,EAAK,GAAM,EAAA,MAAA,CAAA,CAAA;AACX,IAAA,YAAA,CAAA,IAAA,EAAK,OAAU,EAAA,MAAA,CAAA,CAAA;AAAA,GACjB;AAAA,EAhBA,aAAa,OAAO,OAAmC,EAAA;AApDzD,IAAA,IAAA,EAAA,CAAA;AAqDI,IAAM,MAAA,EAAE,UAAa,GAAA,OAAA,CAAA;AACrB,IAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA,CAAA;AAExC,IAAA,IAAI,EAAC,CAAA,EAAA,GAAA,QAAA,CAAS,UAAT,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqB,IAAM,CAAA,EAAA;AAC9B,MAAM,MAAA,MAAA,CAAO,QAAQ,MAAO,CAAA;AAAA,QAC1B,SAAW,EAAA,aAAA;AAAA,OACZ,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,OAAO,IAAI,kBAAA,CAAkB,MAAQ,EAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAAA,GACrD;AAAA,EAaA,MAAM,YAAY,MAA4B,EAAA;AAC5C,IAAA,MAAM,YAAe,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,GAAA,CAAA,CAAL,WACzB,qBACA,CAAA,CAAA,OAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAO,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,IAAI,CAAA;AAAA,KACxB,CAAA;AACA,IAAM,MAAA,kBAAA,GAAqB,IAAI,GAAI,CAAA,YAAA,CAAa,IAAI,CAAK,CAAA,KAAA,CAAA,CAAE,IAAI,CAAC,CAAA,CAAA;AAEhE,IAAM,MAAA,CAAC,QAAU,EAAA,KAAK,CAAI,GAAAC,6BAAA;AAAA,MAAU,MAAA;AAAA,MAAQ,CAC1C,KAAA,KAAA,kBAAA,CAAmB,GAAI,CAAA,KAAA,CAAM,IAAI,CAAA;AAAA,KACnC,CAAA;AAEA,IAAA,YAAA,CAAA,IAAA,EAAK,OAAQ,CAAA,CAAA,IAAA;AAAA,MACX,CAAA,QAAA,EAAW,QAAS,CAAA,MAAA,CAAA,oBAAA,EAA6B,KAAM,CAAA,MAAA,CAAA,WAAA,CAAA;AAAA,KACzD,CAAA;AAEA,IAAA,MAAM,YAAK,CAAA,IAAA,EAAA,GAAA,CAAA,CAAL,IAAS,CAAA,IAAA,EAAA,qBAAA,CAAA,CACZ,MAAO,CAAA;AAAA,MACN,gBAAkB,EAAA,YAAA,CAAA,IAAA,EAAK,GAAI,CAAA,CAAA,EAAA,CAAG,GAAI,EAAA;AAAA,KACnC,CACA,CAAA,OAAA;AAAA,MACC,MAAA;AAAA,MACA,QAAS,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,IAAI,CAAA;AAAA,KAC1B,CAAA;AAEF,IAAA,KAAA,MAAW,SAAS,KAAO,EAAA;AAGzB,MAAA,MAAM,YAAK,CAAA,IAAA,EAAA,GAAA,CAAA,CAAL,IAAS,CAAA,IAAA,EAAA,qBAAA,CAAA,CACZ,MAAO,CAAA;AAAA,QACN,MAAM,KAAM,CAAA,IAAA;AAAA,QACZ,OAAA,EAAS,MAAM,KAAA,CAAM,OAAQ,EAAA;AAAA,OAC9B,CAAA,CACA,UAAW,CAAA,MAAM,EACjB,MAAO,EAAA,CAAA;AAAA,KACZ;AAAA,GACF;AAAA,EAKA,MAAM,SAAS,IAAgD,EAAA;AAC7D,IAAM,MAAA,CAAC,GAAG,CAAI,GAAA,MAAM,mBAAK,GAAL,CAAA,CAAA,IAAA,CAAA,IAAA,EAAyB,uBAAuB,KAAM,CAAA;AAAA,MACxE,IAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,CAAC,GAAK,EAAA;AACR,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AACA,IAAO,OAAA;AAAA,MACL,MAAM,GAAI,CAAA,IAAA;AAAA,MACV,SAAS,GAAI,CAAA,OAAA;AAAA,MACb,gBACE,OAAO,GAAA,CAAI,gBAAqB,KAAA,QAAA,GAC5BC,eAAS,OAAQ,CAAA,GAAA,CAAI,gBAAkB,EAAA,EAAE,MAAM,KAAM,EAAC,CAAE,CAAA,QAAA,KACxD,GAAI,CAAA,gBAAA;AAAA,KACZ,CAAA;AAAA,GACF;AAAA,EAKA,MAAM,WAAW,OAAoC,EAAA;AACnD,IAAM,MAAA,EAAE,eAAkB,GAAA,OAAA,CAAA;AAC1B,IAAM,MAAA,YAAA,CAAA,IAAA,EAAK,GAAL,CAAA,CAAA,IAAA,CAAA,IAAA,EAAyB,qBAC5B,CAAA,CAAA,KAAA;AAAA,MACC,kBAAA;AAAA,MACA,IAAA;AAAA,MACA,YAAA,CAAA,IAAA,EAAK,KAAI,MAAO,CAAA,MAAA,CAAO,OAAO,QAAS,CAAA,SAAS,CAC5C,GAAA,YAAA,CAAA,IAAA,EAAK,GAAI,CAAA,CAAA,GAAA,CAAI,sBAAsB,CAAC,CAAA,CAAA,EAAI,uBAAuB,CAAC,CAAA,GAChE,mBAAK,GAAI,CAAA,CAAA,GAAA,CAAI,CAAqB,kBAAA,EAAA,CAAC,aAAwB,CAAA,SAAA,CAAA,CAAA;AAAA,MAEhE,MAAO,EAAA,CAAA;AAAA,GACZ;AACF,CAAA,CAAA;AAtGO,IAAM,iBAAN,GAAA,kBAAA,CAAA;AACL,GAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,OAAA,GAAA,IAAA,OAAA,EAAA;;ACxBF,eAAsB,iBACpB,SAC6B,EAAA;AAC7B,EAAM,MAAA,UAAA,GAAa,MAAMC,0BAAA,CAAO,MAAQ,EAAA;AAAA,IACtC,MAAA,EAAQ,CAAC,UAAU,CAAA;AAAA,IACnB,GAAK,EAAA,SAAA;AAAA,IACL,GAAK,EAAA,IAAA;AAAA,GACN,CAAA,CAAA;AAED,EAAO,OAAA,UAAA,CAAW,IAAI,CAAS,IAAA,MAAA;AAAA,IAC7B,IAAA;AAAA,IACA,SAAS,YAAYR,sBAAA,CAAG,SAASS,kCAAqB,CAAA,SAAA,EAAW,IAAI,CAAC,CAAA;AAAA,GACtE,CAAA,CAAA,CAAA;AACJ;;ACvBO,MAAM,sBAAyB,GAAA,qBAAA,CAAA;AAC/B,MAAM,uBAA0B,GAAA,yBAAA;;ACShC,SAAS,4BACd,KACgB,EAAA;AAChB,EAAO,OAAA,CAAC,GAAK,EAAA,GAAA,EAAK,IAAS,KAAA;AACzB,IAAA,IAAI,GAAI,CAAA,MAAA,KAAW,KAAS,IAAA,GAAA,CAAI,WAAW,MAAQ,EAAA;AACjD,MAAK,IAAA,EAAA,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAGA,IAAQ,OAAA,CAAA,OAAA;AAAA,MAAA,CACL,YAAY;AAEX,QAAM,MAAAR,MAAA,GAAO,GAAI,CAAA,IAAA,CAAK,UAAW,CAAA,GAAG,CAAI,GAAA,GAAA,CAAI,IAAK,CAAA,KAAA,CAAM,CAAC,CAAA,GAAI,GAAI,CAAA,IAAA,CAAA;AAEhE,QAAA,MAAM,KAAQ,GAAA,MAAM,KAAM,CAAA,QAAA,CAASA,MAAI,CAAA,CAAA;AACvC,QAAA,IAAI,CAAC,KAAO,EAAA;AACV,UAAK,IAAA,EAAA,CAAA;AACL,UAAA,OAAA;AAAA,SACF;AAGA,QAAM,MAAA,GAAA,GAAMS,YAAQ,CAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAC9B,QAAA,IAAI,GAAK,EAAA;AACP,UAAA,GAAA,CAAI,KAAK,GAAG,CAAA,CAAA;AAAA,SACP,MAAA;AACL,UAAA,GAAA,CAAI,KAAK,KAAK,CAAA,CAAA;AAAA,SAChB;AAGA,QAAI,GAAA,CAAA,SAAA,CAAU,iBAAiB,uBAAuB,CAAA,CAAA;AACtD,QAAA,GAAA,CAAI,SAAU,CAAA,eAAA,EAAiB,KAAM,CAAA,cAAA,CAAe,aAAa,CAAA,CAAA;AAEjE,QAAI,GAAA,CAAA,IAAA,CAAK,MAAM,OAAO,CAAA,CAAA;AAAA,OACrB,GAAA;AAAA,KACL,CAAE,MAAM,IAAI,CAAA,CAAA;AAAA,GACd,CAAA;AACF;;AC0BA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,cAAA,EAAgB,uBAA0B,GAAA,OAAA,CAAA;AAElE,EAAM,MAAA,UAAA,GAAaL,gCAAmB,CAAA,cAAA,EAAgB,MAAM,CAAA,CAAA;AAC5D,EAAM,MAAA,SAAA,GAAYH,YAAY,CAAA,UAAA,EAAY,QAAQ,CAAA,CAAA;AAElD,EAAA,IAAI,CAAE,MAAMF,sBAAG,CAAA,UAAA,CAAW,SAAS,CAAI,EAAA;AACrC,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,CAAuC,oCAAA,EAAA,SAAA,CAAA,yBAAA,CAAA;AAAA,KACzC,CAAA;AAEA,IAAA,OAAOW,0BAAO,EAAA,CAAA;AAAA,GAChB;AAEA,EAAO,MAAA,CAAA,IAAA,CAAK,mCAAmC,UAAY,CAAA,CAAA,CAAA,CAAA;AAE3D,EAAI,IAAA,CAAC,QAAQ,sBAAwB,EAAA;AACnC,IAAM,MAAA,UAAA,GAAa,MAAM,WAAY,CAAA;AAAA,MACnC,MAAA;AAAA,MACA,UAAA;AAAA,MACA,KAAK,OAAQ,CAAA,GAAA;AAAA,KACd,CAAA,CAAA;AAED,IAAA,MAAM,YAAa,CAAA,EAAE,UAAY,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAAA,GACtD;AAEA,EAAA,MAAM,SAASA,0BAAO,EAAA,CAAA;AAEtB,EAAA,MAAA,CAAO,IAAIC,0BAAO,CAAA,UAAA,CAAW,EAAE,MAAQ,EAAA,MAAA,EAAQ,CAAC,CAAA,CAAA;AAGhD,EAAA,MAAM,eAAeD,0BAAO,EAAA,CAAA;AAC5B,EAAa,YAAA,CAAA,GAAA;AAAA,IACXE,2BAAQ,CAAA,MAAA,CAAOX,YAAY,CAAA,UAAA,EAAY,QAAQ,CAAG,EAAA;AAAA,MAChD,YAAY,CAAO,GAAA,KAAA;AACjB,QAAI,GAAA,CAAA,SAAA,CAAU,iBAAiB,uBAAuB,CAAA,CAAA;AAAA,OACxD;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AAEA,EAAA,IAAI,QAAQ,QAAU,EAAA;AACpB,IAAM,MAAA,KAAA,GAAQ,MAAM,iBAAA,CAAkB,MAAO,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA,UAAU,OAAQ,CAAA,QAAA;AAAA,KACnB,CAAA,CAAA;AAED,IAAM,MAAA,MAAA,GAAS,MAAM,gBAAA,CAAiB,SAAS,CAAA,CAAA;AAC/C,IAAM,MAAA,KAAA,CAAM,YAAY,MAAM,CAAA,CAAA;AAE9B,IAAM,MAAA,KAAA,CAAM,WAAW,EAAE,aAAA,EAAe,KAAK,EAAK,GAAA,EAAA,GAAK,GAAG,CAAA,CAAA;AAE1D,IAAa,YAAA,CAAA,GAAA,CAAI,2BAA4B,CAAA,KAAK,CAAC,CAAA,CAAA;AAAA,GACrD;AAEA,EAAA,IAAI,qBAAuB,EAAA;AACzB,IAAA,YAAA,CAAa,IAAI,qBAAqB,CAAA,CAAA;AAAA,GACxC;AACA,EAAa,YAAA,CAAA,GAAA,CAAIY,+BAAiB,CAAA,CAAA;AAElC,EAAO,MAAA,CAAA,GAAA,CAAI,WAAW,YAAY,CAAA,CAAA;AAClC,EAAO,MAAA,CAAA,GAAA;AAAA,IACLD,2BAAA,CAAQ,OAAO,UAAY,EAAA;AAAA,MACzB,UAAA,EAAY,CAAC,GAAA,EAAK,IAAS,KAAA;AAGzB,QAAA,IACGA,4BAAQ,MAAO,CAAA,IAAA,CAAyB,MAAO,CAAA,IAAI,MAAM,WAC1D,EAAA;AACA,UAAI,GAAA,CAAA,SAAA,CAAU,iBAAiB,sBAAsB,CAAA,CAAA;AAAA,SACvD;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AACA,EAAA,MAAA,CAAO,GAAI,CAAA,IAAA,EAAM,CAAC,IAAA,EAAM,GAAQ,KAAA;AAC9B,IAAA,GAAA,CAAI,QAAS,CAAAX,YAAA,CAAY,UAAY,EAAA,YAAY,CAAG,EAAA;AAAA,MAClD,OAAS,EAAA;AAAA,QAGP,eAAiB,EAAA,sBAAA;AAAA,OACnB;AAAA,KACD,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AAED,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/lib/config.ts","../src/lib/assets/StaticAssetsStore.ts","../src/lib/assets/findStaticAssets.ts","../src/lib/headers.ts","../src/lib/assets/createStaticAssetMiddleware.ts","../src/service/router.ts","../src/service/appPlugin.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 fs from 'fs-extra';\nimport { resolve as resolvePath } from 'path';\nimport { Logger } from 'winston';\nimport { AppConfig, Config } from '@backstage/config';\nimport { JsonObject } from '@backstage/types';\nimport { loadConfigSchema, readEnvConfig } from '@backstage/config-loader';\n\ntype InjectOptions = {\n appConfigs: AppConfig[];\n // Directory of the static JS files to search for file to inject\n staticDir: string;\n logger: Logger;\n};\n\n/**\n * Injects configs into the app bundle, replacing any existing injected config.\n */\nexport async function injectConfig(options: InjectOptions) {\n const { staticDir, logger, appConfigs } = options;\n\n const files = await fs.readdir(staticDir);\n const jsFiles = files.filter(file => file.endsWith('.js'));\n\n const escapedData = JSON.stringify(appConfigs).replace(/(\"|'|\\\\)/g, '\\\\$1');\n const injected = `/*__APP_INJECTED_CONFIG_MARKER__*/\"${escapedData}\"/*__INJECTED_END__*/`;\n\n for (const jsFile of jsFiles) {\n const path = resolvePath(staticDir, jsFile);\n\n const content = await fs.readFile(path, 'utf8');\n if (content.includes('__APP_INJECTED_RUNTIME_CONFIG__')) {\n logger.info(`Injecting env config into ${jsFile}`);\n\n const newContent = content.replace(\n '\"__APP_INJECTED_RUNTIME_CONFIG__\"',\n injected,\n );\n await fs.writeFile(path, newContent, 'utf8');\n return;\n } else if (content.includes('__APP_INJECTED_CONFIG_MARKER__')) {\n logger.info(`Replacing injected env config in ${jsFile}`);\n\n const newContent = content.replace(\n /\\/\\*__APP_INJECTED_CONFIG_MARKER__\\*\\/.*\\/\\*__INJECTED_END__\\*\\//,\n injected,\n );\n await fs.writeFile(path, newContent, 'utf8');\n return;\n }\n }\n logger.info('Env config not injected');\n}\n\ntype ReadOptions = {\n env: { [name: string]: string | undefined };\n appDistDir: string;\n config: Config;\n};\n\n/**\n * Read config from environment and process the backend config using the\n * schema that is embedded in the frontend build.\n */\nexport async function readConfigs(options: ReadOptions): Promise<AppConfig[]> {\n const { env, appDistDir, config } = options;\n\n const appConfigs = readEnvConfig(env);\n\n const schemaPath = resolvePath(appDistDir, '.config-schema.json');\n if (await fs.pathExists(schemaPath)) {\n const serializedSchema = await fs.readJson(schemaPath);\n\n try {\n const schema = await loadConfigSchema({ serialized: serializedSchema });\n\n const frontendConfigs = await schema.process(\n [{ data: config.get() as JsonObject, context: 'app' }],\n { visibility: ['frontend'], withDeprecatedKeys: true },\n );\n appConfigs.push(...frontendConfigs);\n } catch (error) {\n throw new Error(\n 'Invalid app bundle schema. If this error is unexpected you need to run `yarn build` in the app. ' +\n `If that doesn't help you should make sure your config schema is correct and rebuild the app bundle again. ` +\n `Caused by the following schema error, ${error}`,\n );\n }\n }\n\n return appConfigs;\n}\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n PluginDatabaseManager,\n resolvePackagePath,\n} from '@backstage/backend-common';\nimport { Knex } from 'knex';\nimport { Logger } from 'winston';\nimport { DateTime } from 'luxon';\nimport partition from 'lodash/partition';\nimport { StaticAsset, StaticAssetInput, StaticAssetProvider } from './types';\n\nconst migrationsDir = resolvePackagePath(\n '@backstage/plugin-app-backend',\n 'migrations',\n);\n\ninterface StaticAssetRow {\n path: string;\n content: Buffer;\n last_modified_at: Date;\n}\n\n/** @internal */\nexport interface StaticAssetsStoreOptions {\n database: PluginDatabaseManager;\n logger: Logger;\n}\n\n/**\n * A storage for static assets that are assumed to be immutable.\n *\n * @internal\n */\nexport class StaticAssetsStore implements StaticAssetProvider {\n #db: Knex;\n #logger: Logger;\n\n static async create(options: StaticAssetsStoreOptions) {\n const { database } = options;\n const client = await database.getClient();\n\n if (!database.migrations?.skip) {\n await client.migrate.latest({\n directory: migrationsDir,\n });\n }\n\n return new StaticAssetsStore(client, options.logger);\n }\n\n private constructor(client: Knex, logger: Logger) {\n this.#db = client;\n this.#logger = logger;\n }\n\n /**\n * Store the provided assets.\n *\n * If an asset for a given path already exists the modification time will be\n * updated, but the contents will not.\n */\n async storeAssets(assets: StaticAssetInput[]) {\n const existingRows = await this.#db<StaticAssetRow>(\n 'static_assets_cache',\n ).whereIn(\n 'path',\n assets.map(a => a.path),\n );\n const existingAssetPaths = new Set(existingRows.map(r => r.path));\n\n const [modified, added] = partition(assets, asset =>\n existingAssetPaths.has(asset.path),\n );\n\n this.#logger.info(\n `Storing ${modified.length} updated assets and ${added.length} new assets`,\n );\n\n await this.#db('static_assets_cache')\n .update({\n last_modified_at: this.#db.fn.now(),\n })\n .whereIn(\n 'path',\n modified.map(a => a.path),\n );\n\n for (const asset of added) {\n // We ignore conflicts with other nodes, it doesn't matter if someone else\n // added the same asset just before us.\n await this.#db('static_assets_cache')\n .insert({\n path: asset.path,\n content: await asset.content(),\n })\n .onConflict('path')\n .ignore();\n }\n }\n\n /**\n * Retrieve an asset from the store with the given path.\n */\n async getAsset(path: string): Promise<StaticAsset | undefined> {\n const [row] = await this.#db<StaticAssetRow>('static_assets_cache').where({\n path,\n });\n if (!row) {\n return undefined;\n }\n return {\n path: row.path,\n content: row.content,\n lastModifiedAt:\n typeof row.last_modified_at === 'string'\n ? DateTime.fromSQL(row.last_modified_at, { zone: 'UTC' }).toJSDate()\n : row.last_modified_at,\n };\n }\n\n /**\n * Delete any assets from the store whose modification time is older than the max age.\n */\n async trimAssets(options: { maxAgeSeconds: number }) {\n const { maxAgeSeconds } = options;\n await this.#db<StaticAssetRow>('static_assets_cache')\n .where(\n 'last_modified_at',\n '<=',\n this.#db.client.config.client.includes('sqlite3')\n ? this.#db.raw(`datetime('now', ?)`, [`-${maxAgeSeconds} seconds`])\n : this.#db.raw(`now() + interval '${-maxAgeSeconds} seconds'`),\n )\n .delete();\n }\n}\n","/*\n * Copyright 2021 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 fs from 'fs-extra';\nimport globby from 'globby';\nimport { StaticAssetInput } from './types';\nimport { resolveSafeChildPath } from '@backstage/backend-common';\n\n/**\n * Finds all static assets within a directory\n *\n * @internal\n */\nexport async function findStaticAssets(\n staticDir: string,\n): Promise<StaticAssetInput[]> {\n const assetPaths = await globby('**/*', {\n ignore: ['**/*.map'], // Ignore source maps since they're quite large\n cwd: staticDir,\n dot: true,\n });\n\n return assetPaths.map(path => ({\n path,\n content: async () => fs.readFile(resolveSafeChildPath(staticDir, path)),\n }));\n}\n","/*\n * Copyright 2021 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\nexport const CACHE_CONTROL_NO_CACHE = 'no-store, max-age=0';\nexport const CACHE_CONTROL_MAX_CACHE = 'public, max-age=1209600'; // 14 days\n","/*\n * Copyright 2021 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 { extname } from 'path';\nimport { RequestHandler } from 'express';\nimport { StaticAssetProvider } from './types';\nimport { CACHE_CONTROL_MAX_CACHE } from '../headers';\n\n/**\n * Creates a middleware that serves static assets from a static asset provider\n *\n * @internal\n */\nexport function createStaticAssetMiddleware(\n store: StaticAssetProvider,\n): RequestHandler {\n return (req, res, next) => {\n if (req.method !== 'GET' && req.method !== 'HEAD') {\n next();\n return;\n }\n\n // Let's not assume we're in promise-router\n Promise.resolve(\n (async () => {\n // Drop leading slashes from the incoming path\n const path = req.path.startsWith('/') ? req.path.slice(1) : req.path;\n\n const asset = await store.getAsset(path);\n if (!asset) {\n next();\n return;\n }\n\n // Set the Content-Type header, falling back to octet-stream\n const ext = extname(asset.path);\n if (ext) {\n res.type(ext);\n } else {\n res.type('bin');\n }\n\n // Same as our express.static override\n res.setHeader('Cache-Control', CACHE_CONTROL_MAX_CACHE);\n res.setHeader('Last-Modified', asset.lastModifiedAt.toUTCString());\n\n res.send(asset.content);\n })(),\n ).catch(next);\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 {\n notFoundHandler,\n PluginDatabaseManager,\n resolvePackagePath,\n} from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport helmet from 'helmet';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport fs from 'fs-extra';\nimport { resolve as resolvePath } from 'path';\nimport { Logger } from 'winston';\nimport { injectConfig, readConfigs } from '../lib/config';\nimport {\n StaticAssetsStore,\n findStaticAssets,\n createStaticAssetMiddleware,\n} from '../lib/assets';\nimport {\n CACHE_CONTROL_MAX_CACHE,\n CACHE_CONTROL_NO_CACHE,\n} from '../lib/headers';\n\n// express uses mime v1 while we only have types for mime v2\ntype Mime = { lookup(arg0: string): string };\n\n/** @public */\nexport interface RouterOptions {\n config: Config;\n logger: Logger;\n\n /**\n * If a database is provided it will be used to cache previously deployed static assets.\n *\n * This is a built-in alternative to using a `staticFallbackHandler`.\n */\n database?: PluginDatabaseManager;\n\n /**\n * The name of the app package that content should be served from. The same app package should be\n * added as a dependency to the backend package in order for it to be accessible at runtime.\n *\n * In a typical setup with a single app package this would be set to 'app'.\n */\n appPackageName: string;\n\n /**\n * A request handler to handle requests for static content that are not present in the app bundle.\n *\n * This can be used to avoid issues with clients on older deployment versions trying to access lazy\n * loaded content that is no longer present. Typically the requests would fall back to a long-term\n * object store where all recently deployed versions of the app are present.\n *\n * Another option is to provide a `database` that will take care of storing the static assets instead.\n *\n * If both `database` and `staticFallbackHandler` are provided, the `database` will attempt to serve\n * static assets first, and if they are not found, the `staticFallbackHandler` will be called.\n */\n staticFallbackHandler?: express.Handler;\n\n /**\n * Disables the configuration injection. This can be useful if you're running in an environment\n * with a read-only filesystem, or for some other reason don't want configuration to be injected.\n *\n * Note that this will cause the configuration used when building the app bundle to be used, unless\n * a separate configuration loading strategy is set up.\n *\n * This also disables configuration injection though `APP_CONFIG_` environment variables.\n */\n disableConfigInjection?: boolean;\n}\n\n/** @public */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { config, logger, appPackageName, staticFallbackHandler } = options;\n\n const appDistDir = resolvePackagePath(appPackageName, 'dist');\n const staticDir = resolvePath(appDistDir, 'static');\n\n if (!(await fs.pathExists(staticDir))) {\n logger.warn(\n `Can't serve static app content from ${staticDir}, directory doesn't exist`,\n );\n\n return Router();\n }\n\n logger.info(`Serving static app content from ${appDistDir}`);\n\n if (!options.disableConfigInjection) {\n const appConfigs = await readConfigs({\n config,\n appDistDir,\n env: process.env,\n });\n\n await injectConfig({ appConfigs, logger, staticDir });\n }\n\n const router = Router();\n\n router.use(helmet.frameguard({ action: 'deny' }));\n\n // Use a separate router for static content so that a fallback can be provided by backend\n const staticRouter = Router();\n staticRouter.use(\n express.static(resolvePath(appDistDir, 'static'), {\n setHeaders: res => {\n res.setHeader('Cache-Control', CACHE_CONTROL_MAX_CACHE);\n },\n }),\n );\n\n if (options.database) {\n const store = await StaticAssetsStore.create({\n logger,\n database: options.database,\n });\n\n const assets = await findStaticAssets(staticDir);\n await store.storeAssets(assets);\n // Remove any assets that are older than 7 days\n await store.trimAssets({ maxAgeSeconds: 60 * 60 * 24 * 7 });\n\n staticRouter.use(createStaticAssetMiddleware(store));\n }\n\n if (staticFallbackHandler) {\n staticRouter.use(staticFallbackHandler);\n }\n staticRouter.use(notFoundHandler());\n\n router.use('/static', staticRouter);\n router.use(\n express.static(appDistDir, {\n setHeaders: (res, path) => {\n // The Cache-Control header instructs the browser to not cache html files since it might\n // link to static assets from recently deployed versions.\n if (\n (express.static.mime as unknown as Mime).lookup(path) === 'text/html'\n ) {\n res.setHeader('Cache-Control', CACHE_CONTROL_NO_CACHE);\n }\n },\n }),\n );\n router.get('/*', (_req, res) => {\n res.sendFile(resolvePath(appDistDir, 'index.html'), {\n headers: {\n // The Cache-Control header instructs the browser to not cache the index.html since it might\n // link to static assets from recently deployed versions.\n 'cache-control': CACHE_CONTROL_NO_CACHE,\n },\n });\n });\n\n return router;\n}\n","/*\n * Copyright 2022 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 express from 'express';\nimport {\n configServiceRef,\n createBackendPlugin,\n databaseServiceRef,\n loggerServiceRef,\n loggerToWinstonLogger,\n httpRouterServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './router';\n\n/** @alpha */\nexport type AppPluginOptions = {\n /**\n * The name of the app package (in most Backstage repositories, this is the\n * \"name\" field in `packages/app/package.json`) that content should be served\n * from. The same app package should be added as a dependency to the backend\n * package in order for it to be accessible at runtime.\n *\n * In a typical setup with a single app package, this will default to 'app'.\n */\n appPackageName?: string;\n\n /**\n * A request handler to handle requests for static content that are not present in the app bundle.\n *\n * This can be used to avoid issues with clients on older deployment versions trying to access lazy\n * loaded content that is no longer present. Typically the requests would fall back to a long-term\n * object store where all recently deployed versions of the app are present.\n *\n * Another option is to provide a `database` that will take care of storing the static assets instead.\n *\n * If both `database` and `staticFallbackHandler` are provided, the `database` will attempt to serve\n * static assets first, and if they are not found, the `staticFallbackHandler` will be called.\n */\n staticFallbackHandler?: express.Handler;\n\n /**\n * Disables the configuration injection. This can be useful if you're running in an environment\n * with a read-only filesystem, or for some other reason don't want configuration to be injected.\n *\n * Note that this will cause the configuration used when building the app bundle to be used, unless\n * a separate configuration loading strategy is set up.\n *\n * This also disables configuration injection though `APP_CONFIG_` environment variables.\n */\n disableConfigInjection?: boolean;\n\n /**\n * By default the app backend plugin will cache previously deployed static assets in the database.\n * If you disable this, it is recommended to set a `staticFallbackHandler` instead.\n */\n disableStaticFallbackCache?: boolean;\n};\n\n/**\n * The App plugin is responsible for serving the frontend app bundle and static assets.\n * @alpha\n */\nexport const appPlugin = createBackendPlugin({\n id: 'app',\n register(env, options: AppPluginOptions) {\n env.registerInit({\n deps: {\n logger: loggerServiceRef,\n config: configServiceRef,\n database: databaseServiceRef,\n httpRouter: httpRouterServiceRef,\n },\n async init({ logger, config, database, httpRouter }) {\n const {\n appPackageName,\n staticFallbackHandler,\n disableConfigInjection,\n disableStaticFallbackCache,\n } = options;\n const winstonLogger = loggerToWinstonLogger(logger);\n\n const router = await createRouter({\n logger: winstonLogger,\n config,\n database: disableStaticFallbackCache ? undefined : database,\n appPackageName: appPackageName ?? 'app',\n staticFallbackHandler,\n disableConfigInjection,\n });\n httpRouter.use(router);\n },\n });\n },\n});\n"],"names":["fs","path","resolvePath","readEnvConfig","loadConfigSchema","resolvePackagePath","partition","DateTime","globby","resolveSafeChildPath","extname","Router","helmet","express","notFoundHandler","createBackendPlugin","loggerServiceRef","configServiceRef","databaseServiceRef","httpRouterServiceRef","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,eAAsB,aAAa,OAAwB,EAAA;AACzD,EAAA,MAAM,EAAE,SAAA,EAAW,MAAQ,EAAA,UAAA,EAAe,GAAA,OAAA,CAAA;AAE1C,EAAA,MAAM,KAAQ,GAAA,MAAMA,sBAAG,CAAA,OAAA,CAAQ,SAAS,CAAA,CAAA;AACxC,EAAA,MAAM,UAAU,KAAM,CAAA,MAAA,CAAO,UAAQ,IAAK,CAAA,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AAEzD,EAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,UAAU,CAAE,CAAA,OAAA,CAAQ,aAAa,MAAM,CAAA,CAAA;AAC1E,EAAA,MAAM,WAAW,CAAsC,mCAAA,EAAA,WAAA,CAAA,qBAAA,CAAA,CAAA;AAEvD,EAAA,KAAA,MAAW,UAAU,OAAS,EAAA;AAC5B,IAAM,MAAAC,MAAA,GAAOC,YAAY,CAAA,SAAA,EAAW,MAAM,CAAA,CAAA;AAE1C,IAAA,MAAM,OAAU,GAAA,MAAMF,sBAAG,CAAA,QAAA,CAASC,QAAM,MAAM,CAAA,CAAA;AAC9C,IAAI,IAAA,OAAA,CAAQ,QAAS,CAAA,iCAAiC,CAAG,EAAA;AACvD,MAAO,MAAA,CAAA,IAAA,CAAK,6BAA6B,MAAQ,CAAA,CAAA,CAAA,CAAA;AAEjD,MAAA,MAAM,aAAa,OAAQ,CAAA,OAAA;AAAA,QACzB,mCAAA;AAAA,QACA,QAAA;AAAA,OACF,CAAA;AACA,MAAA,MAAMD,sBAAG,CAAA,SAAA,CAAUC,MAAM,EAAA,UAAA,EAAY,MAAM,CAAA,CAAA;AAC3C,MAAA,OAAA;AAAA,KACS,MAAA,IAAA,OAAA,CAAQ,QAAS,CAAA,gCAAgC,CAAG,EAAA;AAC7D,MAAO,MAAA,CAAA,IAAA,CAAK,oCAAoC,MAAQ,CAAA,CAAA,CAAA,CAAA;AAExD,MAAA,MAAM,aAAa,OAAQ,CAAA,OAAA;AAAA,QACzB,kEAAA;AAAA,QACA,QAAA;AAAA,OACF,CAAA;AACA,MAAA,MAAMD,sBAAG,CAAA,SAAA,CAAUC,MAAM,EAAA,UAAA,EAAY,MAAM,CAAA,CAAA;AAC3C,MAAA,OAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA,CAAA;AACvC,CAAA;AAYA,eAAsB,YAAY,OAA4C,EAAA;AAC5E,EAAA,MAAM,EAAE,GAAA,EAAK,UAAY,EAAA,MAAA,EAAW,GAAA,OAAA,CAAA;AAEpC,EAAM,MAAA,UAAA,GAAaE,2BAAc,GAAG,CAAA,CAAA;AAEpC,EAAM,MAAA,UAAA,GAAaD,YAAY,CAAA,UAAA,EAAY,qBAAqB,CAAA,CAAA;AAChE,EAAA,IAAI,MAAMF,sBAAA,CAAG,UAAW,CAAA,UAAU,CAAG,EAAA;AACnC,IAAA,MAAM,gBAAmB,GAAA,MAAMA,sBAAG,CAAA,QAAA,CAAS,UAAU,CAAA,CAAA;AAErD,IAAI,IAAA;AACF,MAAA,MAAM,SAAS,MAAMI,6BAAA,CAAiB,EAAE,UAAA,EAAY,kBAAkB,CAAA,CAAA;AAEtE,MAAM,MAAA,eAAA,GAAkB,MAAM,MAAO,CAAA,OAAA;AAAA,QACnC,CAAC,EAAE,IAAM,EAAA,MAAA,CAAO,KAAqB,EAAA,OAAA,EAAS,OAAO,CAAA;AAAA,QACrD,EAAE,UAAY,EAAA,CAAC,UAAU,CAAA,EAAG,oBAAoB,IAAK,EAAA;AAAA,OACvD,CAAA;AACA,MAAW,UAAA,CAAA,IAAA,CAAK,GAAG,eAAe,CAAA,CAAA;AAAA,aAC3B,KAAP,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAE2C,kPAAA,EAAA,KAAA,CAAA,CAAA;AAAA,OAC7C,CAAA;AAAA,KACF;AAAA,GACF;AAEA,EAAO,OAAA,UAAA,CAAA;AACT;;;;;;;;;;;;;;;;;;;;AC1GA,IAAA,GAAA,EAAA,OAAA,CAAA;AA0BA,MAAM,aAAgB,GAAAC,gCAAA;AAAA,EACpB,+BAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAmBO,MAAM,qBAAN,MAAuD;AAAA,EAiBpD,WAAA,CAAY,QAAc,MAAgB,EAAA;AAhBlD,IAAA,YAAA,CAAA,IAAA,EAAA,GAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAgBE,IAAA,YAAA,CAAA,IAAA,EAAK,GAAM,EAAA,MAAA,CAAA,CAAA;AACX,IAAA,YAAA,CAAA,IAAA,EAAK,OAAU,EAAA,MAAA,CAAA,CAAA;AAAA,GACjB;AAAA,EAhBA,aAAa,OAAO,OAAmC,EAAA;AApDzD,IAAA,IAAA,EAAA,CAAA;AAqDI,IAAM,MAAA,EAAE,UAAa,GAAA,OAAA,CAAA;AACrB,IAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA,CAAA;AAExC,IAAA,IAAI,EAAC,CAAA,EAAA,GAAA,QAAA,CAAS,UAAT,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqB,IAAM,CAAA,EAAA;AAC9B,MAAM,MAAA,MAAA,CAAO,QAAQ,MAAO,CAAA;AAAA,QAC1B,SAAW,EAAA,aAAA;AAAA,OACZ,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,OAAO,IAAI,kBAAA,CAAkB,MAAQ,EAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAAA,GACrD;AAAA,EAaA,MAAM,YAAY,MAA4B,EAAA;AAC5C,IAAA,MAAM,YAAe,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,GAAA,CAAA,CAAL,WACzB,qBACA,CAAA,CAAA,OAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAO,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,IAAI,CAAA;AAAA,KACxB,CAAA;AACA,IAAM,MAAA,kBAAA,GAAqB,IAAI,GAAI,CAAA,YAAA,CAAa,IAAI,CAAK,CAAA,KAAA,CAAA,CAAE,IAAI,CAAC,CAAA,CAAA;AAEhE,IAAM,MAAA,CAAC,QAAU,EAAA,KAAK,CAAI,GAAAC,6BAAA;AAAA,MAAU,MAAA;AAAA,MAAQ,CAC1C,KAAA,KAAA,kBAAA,CAAmB,GAAI,CAAA,KAAA,CAAM,IAAI,CAAA;AAAA,KACnC,CAAA;AAEA,IAAA,YAAA,CAAA,IAAA,EAAK,OAAQ,CAAA,CAAA,IAAA;AAAA,MACX,CAAA,QAAA,EAAW,QAAS,CAAA,MAAA,CAAA,oBAAA,EAA6B,KAAM,CAAA,MAAA,CAAA,WAAA,CAAA;AAAA,KACzD,CAAA;AAEA,IAAA,MAAM,YAAK,CAAA,IAAA,EAAA,GAAA,CAAA,CAAL,IAAS,CAAA,IAAA,EAAA,qBAAA,CAAA,CACZ,MAAO,CAAA;AAAA,MACN,gBAAkB,EAAA,YAAA,CAAA,IAAA,EAAK,GAAI,CAAA,CAAA,EAAA,CAAG,GAAI,EAAA;AAAA,KACnC,CACA,CAAA,OAAA;AAAA,MACC,MAAA;AAAA,MACA,QAAS,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,IAAI,CAAA;AAAA,KAC1B,CAAA;AAEF,IAAA,KAAA,MAAW,SAAS,KAAO,EAAA;AAGzB,MAAA,MAAM,YAAK,CAAA,IAAA,EAAA,GAAA,CAAA,CAAL,IAAS,CAAA,IAAA,EAAA,qBAAA,CAAA,CACZ,MAAO,CAAA;AAAA,QACN,MAAM,KAAM,CAAA,IAAA;AAAA,QACZ,OAAA,EAAS,MAAM,KAAA,CAAM,OAAQ,EAAA;AAAA,OAC9B,CAAA,CACA,UAAW,CAAA,MAAM,EACjB,MAAO,EAAA,CAAA;AAAA,KACZ;AAAA,GACF;AAAA,EAKA,MAAM,SAAS,IAAgD,EAAA;AAC7D,IAAM,MAAA,CAAC,GAAG,CAAI,GAAA,MAAM,mBAAK,GAAL,CAAA,CAAA,IAAA,CAAA,IAAA,EAAyB,uBAAuB,KAAM,CAAA;AAAA,MACxE,IAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,CAAC,GAAK,EAAA;AACR,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AACA,IAAO,OAAA;AAAA,MACL,MAAM,GAAI,CAAA,IAAA;AAAA,MACV,SAAS,GAAI,CAAA,OAAA;AAAA,MACb,gBACE,OAAO,GAAA,CAAI,gBAAqB,KAAA,QAAA,GAC5BC,eAAS,OAAQ,CAAA,GAAA,CAAI,gBAAkB,EAAA,EAAE,MAAM,KAAM,EAAC,CAAE,CAAA,QAAA,KACxD,GAAI,CAAA,gBAAA;AAAA,KACZ,CAAA;AAAA,GACF;AAAA,EAKA,MAAM,WAAW,OAAoC,EAAA;AACnD,IAAM,MAAA,EAAE,eAAkB,GAAA,OAAA,CAAA;AAC1B,IAAM,MAAA,YAAA,CAAA,IAAA,EAAK,GAAL,CAAA,CAAA,IAAA,CAAA,IAAA,EAAyB,qBAC5B,CAAA,CAAA,KAAA;AAAA,MACC,kBAAA;AAAA,MACA,IAAA;AAAA,MACA,YAAA,CAAA,IAAA,EAAK,KAAI,MAAO,CAAA,MAAA,CAAO,OAAO,QAAS,CAAA,SAAS,CAC5C,GAAA,YAAA,CAAA,IAAA,EAAK,GAAI,CAAA,CAAA,GAAA,CAAI,sBAAsB,CAAC,CAAA,CAAA,EAAI,uBAAuB,CAAC,CAAA,GAChE,mBAAK,GAAI,CAAA,CAAA,GAAA,CAAI,CAAqB,kBAAA,EAAA,CAAC,aAAwB,CAAA,SAAA,CAAA,CAAA;AAAA,MAEhE,MAAO,EAAA,CAAA;AAAA,GACZ;AACF,CAAA,CAAA;AAtGO,IAAM,iBAAN,GAAA,kBAAA,CAAA;AACL,GAAA,GAAA,IAAA,OAAA,EAAA,CAAA;AACA,OAAA,GAAA,IAAA,OAAA,EAAA;;ACxBF,eAAsB,iBACpB,SAC6B,EAAA;AAC7B,EAAM,MAAA,UAAA,GAAa,MAAMC,0BAAA,CAAO,MAAQ,EAAA;AAAA,IACtC,MAAA,EAAQ,CAAC,UAAU,CAAA;AAAA,IACnB,GAAK,EAAA,SAAA;AAAA,IACL,GAAK,EAAA,IAAA;AAAA,GACN,CAAA,CAAA;AAED,EAAO,OAAA,UAAA,CAAW,IAAI,CAAS,IAAA,MAAA;AAAA,IAC7B,IAAA;AAAA,IACA,SAAS,YAAYR,sBAAA,CAAG,SAASS,kCAAqB,CAAA,SAAA,EAAW,IAAI,CAAC,CAAA;AAAA,GACtE,CAAA,CAAA,CAAA;AACJ;;ACvBO,MAAM,sBAAyB,GAAA,qBAAA,CAAA;AAC/B,MAAM,uBAA0B,GAAA,yBAAA;;ACShC,SAAS,4BACd,KACgB,EAAA;AAChB,EAAO,OAAA,CAAC,GAAK,EAAA,GAAA,EAAK,IAAS,KAAA;AACzB,IAAA,IAAI,GAAI,CAAA,MAAA,KAAW,KAAS,IAAA,GAAA,CAAI,WAAW,MAAQ,EAAA;AACjD,MAAK,IAAA,EAAA,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAGA,IAAQ,OAAA,CAAA,OAAA;AAAA,MAAA,CACL,YAAY;AAEX,QAAM,MAAAR,MAAA,GAAO,GAAI,CAAA,IAAA,CAAK,UAAW,CAAA,GAAG,CAAI,GAAA,GAAA,CAAI,IAAK,CAAA,KAAA,CAAM,CAAC,CAAA,GAAI,GAAI,CAAA,IAAA,CAAA;AAEhE,QAAA,MAAM,KAAQ,GAAA,MAAM,KAAM,CAAA,QAAA,CAASA,MAAI,CAAA,CAAA;AACvC,QAAA,IAAI,CAAC,KAAO,EAAA;AACV,UAAK,IAAA,EAAA,CAAA;AACL,UAAA,OAAA;AAAA,SACF;AAGA,QAAM,MAAA,GAAA,GAAMS,YAAQ,CAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAC9B,QAAA,IAAI,GAAK,EAAA;AACP,UAAA,GAAA,CAAI,KAAK,GAAG,CAAA,CAAA;AAAA,SACP,MAAA;AACL,UAAA,GAAA,CAAI,KAAK,KAAK,CAAA,CAAA;AAAA,SAChB;AAGA,QAAI,GAAA,CAAA,SAAA,CAAU,iBAAiB,uBAAuB,CAAA,CAAA;AACtD,QAAA,GAAA,CAAI,SAAU,CAAA,eAAA,EAAiB,KAAM,CAAA,cAAA,CAAe,aAAa,CAAA,CAAA;AAEjE,QAAI,GAAA,CAAA,IAAA,CAAK,MAAM,OAAO,CAAA,CAAA;AAAA,OACrB,GAAA;AAAA,KACL,CAAE,MAAM,IAAI,CAAA,CAAA;AAAA,GACd,CAAA;AACF;;AC0BA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,cAAA,EAAgB,uBAA0B,GAAA,OAAA,CAAA;AAElE,EAAM,MAAA,UAAA,GAAaL,gCAAmB,CAAA,cAAA,EAAgB,MAAM,CAAA,CAAA;AAC5D,EAAM,MAAA,SAAA,GAAYH,YAAY,CAAA,UAAA,EAAY,QAAQ,CAAA,CAAA;AAElD,EAAA,IAAI,CAAE,MAAMF,sBAAG,CAAA,UAAA,CAAW,SAAS,CAAI,EAAA;AACrC,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,CAAuC,oCAAA,EAAA,SAAA,CAAA,yBAAA,CAAA;AAAA,KACzC,CAAA;AAEA,IAAA,OAAOW,0BAAO,EAAA,CAAA;AAAA,GAChB;AAEA,EAAO,MAAA,CAAA,IAAA,CAAK,mCAAmC,UAAY,CAAA,CAAA,CAAA,CAAA;AAE3D,EAAI,IAAA,CAAC,QAAQ,sBAAwB,EAAA;AACnC,IAAM,MAAA,UAAA,GAAa,MAAM,WAAY,CAAA;AAAA,MACnC,MAAA;AAAA,MACA,UAAA;AAAA,MACA,KAAK,OAAQ,CAAA,GAAA;AAAA,KACd,CAAA,CAAA;AAED,IAAA,MAAM,YAAa,CAAA,EAAE,UAAY,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAAA,GACtD;AAEA,EAAA,MAAM,SAASA,0BAAO,EAAA,CAAA;AAEtB,EAAA,MAAA,CAAO,IAAIC,0BAAO,CAAA,UAAA,CAAW,EAAE,MAAQ,EAAA,MAAA,EAAQ,CAAC,CAAA,CAAA;AAGhD,EAAA,MAAM,eAAeD,0BAAO,EAAA,CAAA;AAC5B,EAAa,YAAA,CAAA,GAAA;AAAA,IACXE,2BAAQ,CAAA,MAAA,CAAOX,YAAY,CAAA,UAAA,EAAY,QAAQ,CAAG,EAAA;AAAA,MAChD,YAAY,CAAO,GAAA,KAAA;AACjB,QAAI,GAAA,CAAA,SAAA,CAAU,iBAAiB,uBAAuB,CAAA,CAAA;AAAA,OACxD;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AAEA,EAAA,IAAI,QAAQ,QAAU,EAAA;AACpB,IAAM,MAAA,KAAA,GAAQ,MAAM,iBAAA,CAAkB,MAAO,CAAA;AAAA,MAC3C,MAAA;AAAA,MACA,UAAU,OAAQ,CAAA,QAAA;AAAA,KACnB,CAAA,CAAA;AAED,IAAM,MAAA,MAAA,GAAS,MAAM,gBAAA,CAAiB,SAAS,CAAA,CAAA;AAC/C,IAAM,MAAA,KAAA,CAAM,YAAY,MAAM,CAAA,CAAA;AAE9B,IAAM,MAAA,KAAA,CAAM,WAAW,EAAE,aAAA,EAAe,KAAK,EAAK,GAAA,EAAA,GAAK,GAAG,CAAA,CAAA;AAE1D,IAAa,YAAA,CAAA,GAAA,CAAI,2BAA4B,CAAA,KAAK,CAAC,CAAA,CAAA;AAAA,GACrD;AAEA,EAAA,IAAI,qBAAuB,EAAA;AACzB,IAAA,YAAA,CAAa,IAAI,qBAAqB,CAAA,CAAA;AAAA,GACxC;AACA,EAAa,YAAA,CAAA,GAAA,CAAIY,+BAAiB,CAAA,CAAA;AAElC,EAAO,MAAA,CAAA,GAAA,CAAI,WAAW,YAAY,CAAA,CAAA;AAClC,EAAO,MAAA,CAAA,GAAA;AAAA,IACLD,2BAAA,CAAQ,OAAO,UAAY,EAAA;AAAA,MACzB,UAAA,EAAY,CAAC,GAAA,EAAK,IAAS,KAAA;AAGzB,QAAA,IACGA,4BAAQ,MAAO,CAAA,IAAA,CAAyB,MAAO,CAAA,IAAI,MAAM,WAC1D,EAAA;AACA,UAAI,GAAA,CAAA,SAAA,CAAU,iBAAiB,sBAAsB,CAAA,CAAA;AAAA,SACvD;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AACA,EAAA,MAAA,CAAO,GAAI,CAAA,IAAA,EAAM,CAAC,IAAA,EAAM,GAAQ,KAAA;AAC9B,IAAA,GAAA,CAAI,QAAS,CAAAX,YAAA,CAAY,UAAY,EAAA,YAAY,CAAG,EAAA;AAAA,MAClD,OAAS,EAAA;AAAA,QAGP,eAAiB,EAAA,sBAAA;AAAA,OACnB;AAAA,KACD,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AAED,EAAO,OAAA,MAAA,CAAA;AACT;;ACpGO,MAAM,YAAYa,oCAAoB,CAAA;AAAA,EAC3C,EAAI,EAAA,KAAA;AAAA,EACJ,QAAA,CAAS,KAAK,OAA2B,EAAA;AACvC,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAAC,iCAAA;AAAA,QACR,MAAQ,EAAAC,iCAAA;AAAA,QACR,QAAU,EAAAC,mCAAA;AAAA,QACV,UAAY,EAAAC,qCAAA;AAAA,OACd;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,MAAQ,EAAA,QAAA,EAAU,YAAc,EAAA;AACnD,QAAM,MAAA;AAAA,UACJ,cAAA;AAAA,UACA,qBAAA;AAAA,UACA,sBAAA;AAAA,UACA,0BAAA;AAAA,SACE,GAAA,OAAA,CAAA;AACJ,QAAM,MAAA,aAAA,GAAgBC,uCAAsB,MAAM,CAAA,CAAA;AAElD,QAAM,MAAA,MAAA,GAAS,MAAM,YAAa,CAAA;AAAA,UAChC,MAAQ,EAAA,aAAA;AAAA,UACR,MAAA;AAAA,UACA,QAAA,EAAU,6BAA6B,KAAY,CAAA,GAAA,QAAA;AAAA,UACnD,gBAAgB,cAAkB,IAAA,IAAA,GAAA,cAAA,GAAA,KAAA;AAAA,UAClC,qBAAA;AAAA,UACA,sBAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAA,UAAA,CAAW,IAAI,MAAM,CAAA,CAAA;AAAA,OACvB;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,24 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* A Backstage backend plugin that serves the Backstage frontend app
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BackendFeature } from '@backstage/backend-plugin-api';
|
|
2
8
|
import { Config } from '@backstage/config';
|
|
3
9
|
import express from 'express';
|
|
4
10
|
import { Logger } from 'winston';
|
|
11
|
+
import { PluginDatabaseManager } from '@backstage/backend-common';
|
|
12
|
+
|
|
13
|
+
/* Excluded from this release type: appPlugin */
|
|
14
|
+
|
|
15
|
+
/* Excluded from this release type: AppPluginOptions */
|
|
16
|
+
|
|
17
|
+
/** @public */
|
|
18
|
+
export declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
5
19
|
|
|
6
20
|
/** @public */
|
|
7
|
-
interface RouterOptions {
|
|
21
|
+
export declare interface RouterOptions {
|
|
8
22
|
config: Config;
|
|
9
23
|
logger: Logger;
|
|
10
24
|
/**
|
|
@@ -44,7 +58,5 @@ interface RouterOptions {
|
|
|
44
58
|
*/
|
|
45
59
|
disableConfigInjection?: boolean;
|
|
46
60
|
}
|
|
47
|
-
/** @public */
|
|
48
|
-
declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
49
61
|
|
|
50
|
-
export {
|
|
62
|
+
export { }
|
package/package.json
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-app-backend",
|
|
3
3
|
"description": "A Backstage backend plugin that serves the Backstage frontend app",
|
|
4
|
-
"version": "0.3.
|
|
4
|
+
"version": "0.3.37-next.1",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
8
8
|
"publishConfig": {
|
|
9
9
|
"access": "public",
|
|
10
10
|
"main": "dist/index.cjs.js",
|
|
11
|
-
"types": "dist/index.d.ts"
|
|
11
|
+
"types": "dist/index.d.ts",
|
|
12
|
+
"alphaTypes": "dist/index.alpha.d.ts"
|
|
12
13
|
},
|
|
13
14
|
"backstage": {
|
|
14
15
|
"role": "backend-plugin"
|
|
@@ -24,7 +25,7 @@
|
|
|
24
25
|
],
|
|
25
26
|
"scripts": {
|
|
26
27
|
"start": "backstage-cli package start",
|
|
27
|
-
"build": "backstage-cli package build",
|
|
28
|
+
"build": "backstage-cli package build --experimental-type-build",
|
|
28
29
|
"lint": "backstage-cli package lint",
|
|
29
30
|
"test": "backstage-cli package test",
|
|
30
31
|
"prepack": "backstage-cli package prepack",
|
|
@@ -32,9 +33,10 @@
|
|
|
32
33
|
"clean": "backstage-cli package clean"
|
|
33
34
|
},
|
|
34
35
|
"dependencies": {
|
|
35
|
-
"@backstage/backend-common": "^0.15.1",
|
|
36
|
-
"@backstage/
|
|
37
|
-
"@backstage/config
|
|
36
|
+
"@backstage/backend-common": "^0.15.2-next.1",
|
|
37
|
+
"@backstage/backend-plugin-api": "^0.1.3-next.1",
|
|
38
|
+
"@backstage/config": "^1.0.3-next.1",
|
|
39
|
+
"@backstage/config-loader": "^1.1.5-next.1",
|
|
38
40
|
"@backstage/types": "^1.0.0",
|
|
39
41
|
"@types/express": "^4.17.6",
|
|
40
42
|
"express": "^4.17.1",
|
|
@@ -49,18 +51,21 @@
|
|
|
49
51
|
"yn": "^4.0.0"
|
|
50
52
|
},
|
|
51
53
|
"devDependencies": {
|
|
52
|
-
"@backstage/backend-
|
|
53
|
-
"@backstage/
|
|
54
|
+
"@backstage/backend-app-api": "^0.2.2-next.1",
|
|
55
|
+
"@backstage/backend-test-utils": "^0.1.29-next.1",
|
|
56
|
+
"@backstage/cli": "^0.20.0-next.1",
|
|
54
57
|
"@backstage/types": "^1.0.0",
|
|
55
58
|
"@types/supertest": "^2.0.8",
|
|
59
|
+
"get-port": "^6.1.2",
|
|
56
60
|
"mock-fs": "^5.1.0",
|
|
57
61
|
"msw": "^0.47.0",
|
|
62
|
+
"node-fetch": "^2.6.7",
|
|
58
63
|
"supertest": "^6.1.3"
|
|
59
64
|
},
|
|
60
65
|
"files": [
|
|
61
66
|
"dist",
|
|
67
|
+
"alpha",
|
|
62
68
|
"migrations/**/*.{js,d.ts}",
|
|
63
69
|
"static"
|
|
64
|
-
]
|
|
65
|
-
|
|
66
|
-
}
|
|
70
|
+
]
|
|
71
|
+
}
|
package/LICENSE
DELETED
|
@@ -1,201 +0,0 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
Version 2.0, January 2004
|
|
3
|
-
http://www.apache.org/licenses/
|
|
4
|
-
|
|
5
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
-
|
|
7
|
-
1. Definitions.
|
|
8
|
-
|
|
9
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
-
|
|
12
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
-
the copyright owner that is granting the License.
|
|
14
|
-
|
|
15
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
-
other entities that control, are controlled by, or are under common
|
|
17
|
-
control with that entity. For the purposes of this definition,
|
|
18
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
-
direction or management of such entity, whether by contract or
|
|
20
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
-
|
|
23
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
-
exercising permissions granted by this License.
|
|
25
|
-
|
|
26
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
-
including but not limited to software source code, documentation
|
|
28
|
-
source, and configuration files.
|
|
29
|
-
|
|
30
|
-
"Object" form shall mean any form resulting from mechanical
|
|
31
|
-
transformation or translation of a Source form, including but
|
|
32
|
-
not limited to compiled object code, generated documentation,
|
|
33
|
-
and conversions to other media types.
|
|
34
|
-
|
|
35
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
-
Object form, made available under the License, as indicated by a
|
|
37
|
-
copyright notice that is included in or attached to the work
|
|
38
|
-
(an example is provided in the Appendix below).
|
|
39
|
-
|
|
40
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
-
form, that is based on (or derived from) the Work and for which the
|
|
42
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
-
of this License, Derivative Works shall not include works that remain
|
|
45
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
-
the Work and Derivative Works thereof.
|
|
47
|
-
|
|
48
|
-
"Contribution" shall mean any work of authorship, including
|
|
49
|
-
the original version of the Work and any modifications or additions
|
|
50
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
-
means any form of electronic, verbal, or written communication sent
|
|
55
|
-
to the Licensor or its representatives, including but not limited to
|
|
56
|
-
communication on electronic mailing lists, source code control systems,
|
|
57
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
-
excluding communication that is conspicuously marked or otherwise
|
|
60
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
-
|
|
62
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
-
subsequently incorporated within the Work.
|
|
65
|
-
|
|
66
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
-
Work and such Derivative Works in Source or Object form.
|
|
72
|
-
|
|
73
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
-
(except as stated in this section) patent license to make, have made,
|
|
77
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
-
where such license applies only to those patent claims licensable
|
|
79
|
-
by such Contributor that are necessarily infringed by their
|
|
80
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
-
institute patent litigation against any entity (including a
|
|
83
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
-
or contributory patent infringement, then any patent licenses
|
|
86
|
-
granted to You under this License for that Work shall terminate
|
|
87
|
-
as of the date such litigation is filed.
|
|
88
|
-
|
|
89
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
-
modifications, and in Source or Object form, provided that You
|
|
92
|
-
meet the following conditions:
|
|
93
|
-
|
|
94
|
-
(a) You must give any other recipients of the Work or
|
|
95
|
-
Derivative Works a copy of this License; and
|
|
96
|
-
|
|
97
|
-
(b) You must cause any modified files to carry prominent notices
|
|
98
|
-
stating that You changed the files; and
|
|
99
|
-
|
|
100
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
-
that You distribute, all copyright, patent, trademark, and
|
|
102
|
-
attribution notices from the Source form of the Work,
|
|
103
|
-
excluding those notices that do not pertain to any part of
|
|
104
|
-
the Derivative Works; and
|
|
105
|
-
|
|
106
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
-
distribution, then any Derivative Works that You distribute must
|
|
108
|
-
include a readable copy of the attribution notices contained
|
|
109
|
-
within such NOTICE file, excluding those notices that do not
|
|
110
|
-
pertain to any part of the Derivative Works, in at least one
|
|
111
|
-
of the following places: within a NOTICE text file distributed
|
|
112
|
-
as part of the Derivative Works; within the Source form or
|
|
113
|
-
documentation, if provided along with the Derivative Works; or,
|
|
114
|
-
within a display generated by the Derivative Works, if and
|
|
115
|
-
wherever such third-party notices normally appear. The contents
|
|
116
|
-
of the NOTICE file are for informational purposes only and
|
|
117
|
-
do not modify the License. You may add Your own attribution
|
|
118
|
-
notices within Derivative Works that You distribute, alongside
|
|
119
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
-
that such additional attribution notices cannot be construed
|
|
121
|
-
as modifying the License.
|
|
122
|
-
|
|
123
|
-
You may add Your own copyright statement to Your modifications and
|
|
124
|
-
may provide additional or different license terms and conditions
|
|
125
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
-
the conditions stated in this License.
|
|
129
|
-
|
|
130
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
-
this License, without any additional terms or conditions.
|
|
134
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
-
the terms of any separate license agreement you may have executed
|
|
136
|
-
with Licensor regarding such Contributions.
|
|
137
|
-
|
|
138
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
-
except as required for reasonable and customary use in describing the
|
|
141
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
-
|
|
143
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
-
implied, including, without limitation, any warranties or conditions
|
|
148
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
-
appropriateness of using or redistributing the Work and assume any
|
|
151
|
-
risks associated with Your exercise of permissions under this License.
|
|
152
|
-
|
|
153
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
-
unless required by applicable law (such as deliberate and grossly
|
|
156
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
-
liable to You for damages, including any direct, indirect, special,
|
|
158
|
-
incidental, or consequential damages of any character arising as a
|
|
159
|
-
result of this License or out of the use or inability to use the
|
|
160
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
-
other commercial damages or losses), even if such Contributor
|
|
163
|
-
has been advised of the possibility of such damages.
|
|
164
|
-
|
|
165
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
-
or other liability obligations and/or rights consistent with this
|
|
169
|
-
License. However, in accepting such obligations, You may act only
|
|
170
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
-
defend, and hold each Contributor harmless for any liability
|
|
173
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
-
of your accepting any such warranty or additional liability.
|
|
175
|
-
|
|
176
|
-
END OF TERMS AND CONDITIONS
|
|
177
|
-
|
|
178
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
-
|
|
180
|
-
To apply the Apache License to your work, attach the following
|
|
181
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
-
replaced with your own identifying information. (Don't include
|
|
183
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
-
comment syntax for the file format. We also recommend that a
|
|
185
|
-
file or class name and description of purpose be included on the
|
|
186
|
-
same "printed page" as the copyright notice for easier
|
|
187
|
-
identification within third-party archives.
|
|
188
|
-
|
|
189
|
-
Copyright 2020 The Backstage Authors
|
|
190
|
-
|
|
191
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
-
you may not use this file except in compliance with the License.
|
|
193
|
-
You may obtain a copy of the License at
|
|
194
|
-
|
|
195
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
-
|
|
197
|
-
Unless required by applicable law or agreed to in writing, software
|
|
198
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
-
See the License for the specific language governing permissions and
|
|
201
|
-
limitations under the License.
|