@backstage/plugin-techdocs-backend 0.0.0-nightly-20260414031820 → 0.0.0-nightly-20260416031834
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 +24 -10
- package/dist/service/CachedEntityLoader.cjs.js.map +1 -1
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,21 +1,35 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-backend
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20260416031834
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/errors@0.0.0-nightly-20260416031834
|
|
9
|
+
- @backstage/backend-plugin-api@0.0.0-nightly-20260416031834
|
|
10
|
+
- @backstage/catalog-client@0.0.0-nightly-20260416031834
|
|
11
|
+
- @backstage/catalog-model@0.0.0-nightly-20260416031834
|
|
12
|
+
- @backstage/config@0.0.0-nightly-20260416031834
|
|
13
|
+
- @backstage/integration@0.0.0-nightly-20260416031834
|
|
14
|
+
- @backstage/plugin-catalog-node@0.0.0-nightly-20260416031834
|
|
15
|
+
- @backstage/plugin-techdocs-node@0.0.0-nightly-20260416031834
|
|
16
|
+
- @backstage/types@1.2.2
|
|
17
|
+
|
|
18
|
+
## 2.1.7
|
|
4
19
|
|
|
5
20
|
### Patch Changes
|
|
6
21
|
|
|
7
22
|
- 482ceed: Migrated from `assertError` to `toError` for error handling.
|
|
8
23
|
- 5e32f77: Migrated internal usage of the deprecated `catalogServiceRef` from `@backstage/plugin-catalog-node/alpha` to the stable `catalogServiceRef` from `@backstage/plugin-catalog-node`.
|
|
9
24
|
- Updated dependencies
|
|
10
|
-
- @backstage/backend-plugin-api@
|
|
11
|
-
- @backstage/errors@
|
|
12
|
-
- @backstage/
|
|
13
|
-
- @backstage/plugin-
|
|
14
|
-
- @backstage/
|
|
15
|
-
- @backstage/
|
|
16
|
-
- @backstage/
|
|
17
|
-
- @backstage/config@
|
|
18
|
-
- @backstage/types@1.2.2
|
|
25
|
+
- @backstage/backend-plugin-api@1.9.0
|
|
26
|
+
- @backstage/errors@1.3.0
|
|
27
|
+
- @backstage/catalog-model@1.8.0
|
|
28
|
+
- @backstage/plugin-catalog-node@2.2.0
|
|
29
|
+
- @backstage/plugin-techdocs-node@1.14.5
|
|
30
|
+
- @backstage/catalog-client@1.15.0
|
|
31
|
+
- @backstage/integration@2.0.1
|
|
32
|
+
- @backstage/config@1.3.7
|
|
19
33
|
|
|
20
34
|
## 2.1.7-next.2
|
|
21
35
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CachedEntityLoader.cjs.js","sources":["../../src/service/CachedEntityLoader.ts"],"sourcesContent":["/*\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 {\n BackstageCredentials,\n CacheService,\n} from '@backstage/backend-plugin-api';\nimport {\n Entity,\n CompoundEntityRef,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\n\
|
|
1
|
+
{"version":3,"file":"CachedEntityLoader.cjs.js","sources":["../../src/service/CachedEntityLoader.ts"],"sourcesContent":["/*\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 {\n BackstageCredentials,\n CacheService,\n} from '@backstage/backend-plugin-api';\nimport {\n Entity,\n CompoundEntityRef,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\n\ntype CachedEntityLoaderOptions = {\n catalog: CatalogService;\n cache: CacheService;\n};\n\nexport class CachedEntityLoader {\n private readonly catalog: CatalogService;\n private readonly cache: CacheService;\n private readonly readTimeout = 1000;\n\n constructor({ catalog, cache }: CachedEntityLoaderOptions) {\n this.catalog = catalog;\n this.cache = cache;\n }\n\n async load(\n credentials: BackstageCredentials,\n entityRef: CompoundEntityRef,\n ): Promise<Entity | undefined> {\n const cacheKey = this.getCacheKey(entityRef, credentials);\n let result = await this.getFromCache(cacheKey);\n\n if (result) {\n return result;\n }\n\n result = await this.catalog.getEntityByRef(entityRef, { credentials });\n\n if (result) {\n this.cache.set(cacheKey, result, { ttl: 5000 });\n }\n\n return result;\n }\n\n private async getFromCache(key: string): Promise<Entity | undefined> {\n // Promise.race ensures we don't hang the client for long if the cache is\n // temporarily unreachable.\n return (await Promise.race([\n this.cache.get(key),\n new Promise(cancelAfter => setTimeout(cancelAfter, this.readTimeout)),\n ])) as Entity | undefined;\n }\n\n private getCacheKey(\n entityName: CompoundEntityRef,\n credentials: BackstageCredentials,\n ): string {\n return [\n 'catalog',\n stringifyEntityRef(entityName),\n String(credentials), // these have a well defined toString method\n ].join(':');\n }\n}\n"],"names":["stringifyEntityRef"],"mappings":";;;;AAgCO,MAAM,kBAAA,CAAmB;AAAA,EACb,OAAA;AAAA,EACA,KAAA;AAAA,EACA,WAAA,GAAc,GAAA;AAAA,EAE/B,WAAA,CAAY,EAAE,OAAA,EAAS,KAAA,EAAM,EAA8B;AACzD,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,KAAA,GAAQ,KAAA;AAAA,EACf;AAAA,EAEA,MAAM,IAAA,CACJ,WAAA,EACA,SAAA,EAC6B;AAC7B,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,WAAA,CAAY,SAAA,EAAW,WAAW,CAAA;AACxD,IAAA,IAAI,MAAA,GAAS,MAAM,IAAA,CAAK,YAAA,CAAa,QAAQ,CAAA;AAE7C,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAA,GAAS,MAAM,IAAA,CAAK,OAAA,CAAQ,eAAe,SAAA,EAAW,EAAE,aAAa,CAAA;AAErE,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,IAAA,CAAK,MAAM,GAAA,CAAI,QAAA,EAAU,QAAQ,EAAE,GAAA,EAAK,KAAM,CAAA;AAAA,IAChD;AAEA,IAAA,OAAO,MAAA;AAAA,EACT;AAAA,EAEA,MAAc,aAAa,GAAA,EAA0C;AAGnE,IAAA,OAAQ,MAAM,QAAQ,IAAA,CAAK;AAAA,MACzB,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,GAAG,CAAA;AAAA,MAClB,IAAI,OAAA,CAAQ,CAAA,WAAA,KAAe,WAAW,WAAA,EAAa,IAAA,CAAK,WAAW,CAAC;AAAA,KACrE,CAAA;AAAA,EACH;AAAA,EAEQ,WAAA,CACN,YACA,WAAA,EACQ;AACR,IAAA,OAAO;AAAA,MACL,SAAA;AAAA,MACAA,gCAAmB,UAAU,CAAA;AAAA,MAC7B,OAAO,WAAW;AAAA;AAAA,KACpB,CAAE,KAAK,GAAG,CAAA;AAAA,EACZ;AACF;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-backend",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20260416031834",
|
|
4
4
|
"description": "The Backstage backend plugin that renders technical documentation for your components",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin",
|
|
@@ -75,14 +75,14 @@
|
|
|
75
75
|
"test": "backstage-cli package test"
|
|
76
76
|
},
|
|
77
77
|
"dependencies": {
|
|
78
|
-
"@backstage/backend-plugin-api": "0.0.0-nightly-
|
|
79
|
-
"@backstage/catalog-client": "0.0.0-nightly-
|
|
80
|
-
"@backstage/catalog-model": "0.0.0-nightly-
|
|
81
|
-
"@backstage/config": "0.0.0-nightly-
|
|
82
|
-
"@backstage/errors": "0.0.0-nightly-
|
|
83
|
-
"@backstage/integration": "0.0.0-nightly-
|
|
84
|
-
"@backstage/plugin-catalog-node": "0.0.0-nightly-
|
|
85
|
-
"@backstage/plugin-techdocs-node": "0.0.0-nightly-
|
|
78
|
+
"@backstage/backend-plugin-api": "0.0.0-nightly-20260416031834",
|
|
79
|
+
"@backstage/catalog-client": "0.0.0-nightly-20260416031834",
|
|
80
|
+
"@backstage/catalog-model": "0.0.0-nightly-20260416031834",
|
|
81
|
+
"@backstage/config": "0.0.0-nightly-20260416031834",
|
|
82
|
+
"@backstage/errors": "0.0.0-nightly-20260416031834",
|
|
83
|
+
"@backstage/integration": "0.0.0-nightly-20260416031834",
|
|
84
|
+
"@backstage/plugin-catalog-node": "0.0.0-nightly-20260416031834",
|
|
85
|
+
"@backstage/plugin-techdocs-node": "0.0.0-nightly-20260416031834",
|
|
86
86
|
"@backstage/types": "1.2.2",
|
|
87
87
|
"express": "^4.22.0",
|
|
88
88
|
"express-promise-router": "^4.1.0",
|
|
@@ -92,9 +92,9 @@
|
|
|
92
92
|
"winston": "^3.2.1"
|
|
93
93
|
},
|
|
94
94
|
"devDependencies": {
|
|
95
|
-
"@backstage/backend-defaults": "0.0.0-nightly-
|
|
96
|
-
"@backstage/backend-test-utils": "0.0.0-nightly-
|
|
97
|
-
"@backstage/cli": "0.0.0-nightly-
|
|
95
|
+
"@backstage/backend-defaults": "0.0.0-nightly-20260416031834",
|
|
96
|
+
"@backstage/backend-test-utils": "0.0.0-nightly-20260416031834",
|
|
97
|
+
"@backstage/cli": "0.0.0-nightly-20260416031834",
|
|
98
98
|
"@types/express": "^4.17.6",
|
|
99
99
|
"msw": "^2.0.0",
|
|
100
100
|
"supertest": "^7.0.0"
|