@backstage/plugin-catalog-backend-module-scaffolder-entity-model 0.2.0 → 0.2.1-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 +22 -0
- package/dist/index.cjs.js +4 -71
- package/dist/index.cjs.js.map +1 -1
- package/dist/module.cjs.js +23 -0
- package/dist/module.cjs.js.map +1 -0
- package/dist/processor/ScaffolderEntitiesProcessor.cjs.js +59 -0
- package/dist/processor/ScaffolderEntitiesProcessor.cjs.js.map +1 -0
- package/package.json +9 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-scaffolder-entity-model
|
|
2
2
|
|
|
3
|
+
## 0.2.1-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/plugin-catalog-node@1.13.1-next.1
|
|
9
|
+
- @backstage/backend-plugin-api@1.0.1-next.1
|
|
10
|
+
- @backstage/catalog-model@1.7.0
|
|
11
|
+
- @backstage/plugin-catalog-common@1.1.0
|
|
12
|
+
- @backstage/plugin-scaffolder-common@1.5.6
|
|
13
|
+
|
|
14
|
+
## 0.2.1-next.0
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- Updated dependencies
|
|
19
|
+
- @backstage/backend-plugin-api@1.0.1-next.0
|
|
20
|
+
- @backstage/catalog-model@1.7.0
|
|
21
|
+
- @backstage/plugin-catalog-common@1.1.0
|
|
22
|
+
- @backstage/plugin-catalog-node@1.13.1-next.0
|
|
23
|
+
- @backstage/plugin-scaffolder-common@1.5.6
|
|
24
|
+
|
|
3
25
|
## 0.2.0
|
|
4
26
|
|
|
5
27
|
### Minor Changes
|
package/dist/index.cjs.js
CHANGED
|
@@ -2,78 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
|
-
var
|
|
6
|
-
var
|
|
7
|
-
var pluginScaffolderCommon = require('@backstage/plugin-scaffolder-common');
|
|
8
|
-
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
9
|
-
var alpha = require('@backstage/plugin-catalog-node/alpha');
|
|
5
|
+
var ScaffolderEntitiesProcessor = require('./processor/ScaffolderEntitiesProcessor.cjs.js');
|
|
6
|
+
var module$1 = require('./module.cjs.js');
|
|
10
7
|
|
|
11
|
-
class ScaffolderEntitiesProcessor {
|
|
12
|
-
getProcessorName() {
|
|
13
|
-
return "ScaffolderEntitiesProcessor";
|
|
14
|
-
}
|
|
15
|
-
validators = [pluginScaffolderCommon.templateEntityV1beta3Validator];
|
|
16
|
-
async validateEntityKind(entity) {
|
|
17
|
-
for (const validator of this.validators) {
|
|
18
|
-
if (await validator.check(entity)) {
|
|
19
|
-
return true;
|
|
20
|
-
}
|
|
21
|
-
}
|
|
22
|
-
return false;
|
|
23
|
-
}
|
|
24
|
-
async postProcessEntity(entity, _location, emit) {
|
|
25
|
-
const selfRef = catalogModel.getCompoundEntityRef(entity);
|
|
26
|
-
if (entity.apiVersion === "scaffolder.backstage.io/v1beta3" && entity.kind === "Template") {
|
|
27
|
-
const template = entity;
|
|
28
|
-
const target = template.spec.owner;
|
|
29
|
-
if (target) {
|
|
30
|
-
const targetRef = catalogModel.parseEntityRef(target, {
|
|
31
|
-
defaultKind: "Group",
|
|
32
|
-
defaultNamespace: selfRef.namespace
|
|
33
|
-
});
|
|
34
|
-
emit(
|
|
35
|
-
pluginCatalogNode.processingResult.relation({
|
|
36
|
-
source: selfRef,
|
|
37
|
-
type: catalogModel.RELATION_OWNED_BY,
|
|
38
|
-
target: {
|
|
39
|
-
kind: targetRef.kind,
|
|
40
|
-
namespace: targetRef.namespace,
|
|
41
|
-
name: targetRef.name
|
|
42
|
-
}
|
|
43
|
-
})
|
|
44
|
-
);
|
|
45
|
-
emit(
|
|
46
|
-
pluginCatalogNode.processingResult.relation({
|
|
47
|
-
source: {
|
|
48
|
-
kind: targetRef.kind,
|
|
49
|
-
namespace: targetRef.namespace,
|
|
50
|
-
name: targetRef.name
|
|
51
|
-
},
|
|
52
|
-
type: catalogModel.RELATION_OWNER_OF,
|
|
53
|
-
target: selfRef
|
|
54
|
-
})
|
|
55
|
-
);
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
return entity;
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
8
|
|
|
62
|
-
const catalogModuleScaffolderEntityModel = backendPluginApi.createBackendModule({
|
|
63
|
-
pluginId: "catalog",
|
|
64
|
-
moduleId: "scaffolder-entity-model",
|
|
65
|
-
register(env) {
|
|
66
|
-
env.registerInit({
|
|
67
|
-
deps: {
|
|
68
|
-
catalog: alpha.catalogProcessingExtensionPoint
|
|
69
|
-
},
|
|
70
|
-
async init({ catalog }) {
|
|
71
|
-
catalog.addProcessor(new ScaffolderEntitiesProcessor());
|
|
72
|
-
}
|
|
73
|
-
});
|
|
74
|
-
}
|
|
75
|
-
});
|
|
76
9
|
|
|
77
|
-
exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
|
|
78
|
-
exports.default = catalogModuleScaffolderEntityModel;
|
|
10
|
+
exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor.ScaffolderEntitiesProcessor;
|
|
11
|
+
exports.default = module$1.catalogModuleScaffolderEntityModel;
|
|
79
12
|
//# sourceMappingURL=index.cjs.js.map
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":[
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
4
|
+
var alpha = require('@backstage/plugin-catalog-node/alpha');
|
|
5
|
+
var ScaffolderEntitiesProcessor = require('./processor/ScaffolderEntitiesProcessor.cjs.js');
|
|
6
|
+
|
|
7
|
+
const catalogModuleScaffolderEntityModel = backendPluginApi.createBackendModule({
|
|
8
|
+
pluginId: "catalog",
|
|
9
|
+
moduleId: "scaffolder-entity-model",
|
|
10
|
+
register(env) {
|
|
11
|
+
env.registerInit({
|
|
12
|
+
deps: {
|
|
13
|
+
catalog: alpha.catalogProcessingExtensionPoint
|
|
14
|
+
},
|
|
15
|
+
async init({ catalog }) {
|
|
16
|
+
catalog.addProcessor(new ScaffolderEntitiesProcessor.ScaffolderEntitiesProcessor());
|
|
17
|
+
}
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
exports.catalogModuleScaffolderEntityModel = catalogModuleScaffolderEntityModel;
|
|
23
|
+
//# sourceMappingURL=module.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"module.cjs.js","sources":["../src/module.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 { createBackendModule } from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { ScaffolderEntitiesProcessor } from './processor';\n\n/**\n * Registers support for the scaffolder specific entity model (e.g. the Template\n * kind) to the catalog backend plugin.\n *\n * @public\n */\nexport const catalogModuleScaffolderEntityModel = createBackendModule({\n pluginId: 'catalog',\n moduleId: 'scaffolder-entity-model',\n register(env) {\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n },\n async init({ catalog }) {\n catalog.addProcessor(new ScaffolderEntitiesProcessor());\n },\n });\n },\n});\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","ScaffolderEntitiesProcessor"],"mappings":";;;;;;AA0BO,MAAM,qCAAqCA,oCAAoB,CAAA;AAAA,EACpE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,yBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,OAAA,EAAW,EAAA;AACtB,QAAQ,OAAA,CAAA,YAAA,CAAa,IAAIC,uDAAA,EAA6B,CAAA,CAAA;AAAA,OACxD;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var catalogModel = require('@backstage/catalog-model');
|
|
4
|
+
var pluginCatalogNode = require('@backstage/plugin-catalog-node');
|
|
5
|
+
var pluginScaffolderCommon = require('@backstage/plugin-scaffolder-common');
|
|
6
|
+
|
|
7
|
+
class ScaffolderEntitiesProcessor {
|
|
8
|
+
getProcessorName() {
|
|
9
|
+
return "ScaffolderEntitiesProcessor";
|
|
10
|
+
}
|
|
11
|
+
validators = [pluginScaffolderCommon.templateEntityV1beta3Validator];
|
|
12
|
+
async validateEntityKind(entity) {
|
|
13
|
+
for (const validator of this.validators) {
|
|
14
|
+
if (await validator.check(entity)) {
|
|
15
|
+
return true;
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
return false;
|
|
19
|
+
}
|
|
20
|
+
async postProcessEntity(entity, _location, emit) {
|
|
21
|
+
const selfRef = catalogModel.getCompoundEntityRef(entity);
|
|
22
|
+
if (entity.apiVersion === "scaffolder.backstage.io/v1beta3" && entity.kind === "Template") {
|
|
23
|
+
const template = entity;
|
|
24
|
+
const target = template.spec.owner;
|
|
25
|
+
if (target) {
|
|
26
|
+
const targetRef = catalogModel.parseEntityRef(target, {
|
|
27
|
+
defaultKind: "Group",
|
|
28
|
+
defaultNamespace: selfRef.namespace
|
|
29
|
+
});
|
|
30
|
+
emit(
|
|
31
|
+
pluginCatalogNode.processingResult.relation({
|
|
32
|
+
source: selfRef,
|
|
33
|
+
type: catalogModel.RELATION_OWNED_BY,
|
|
34
|
+
target: {
|
|
35
|
+
kind: targetRef.kind,
|
|
36
|
+
namespace: targetRef.namespace,
|
|
37
|
+
name: targetRef.name
|
|
38
|
+
}
|
|
39
|
+
})
|
|
40
|
+
);
|
|
41
|
+
emit(
|
|
42
|
+
pluginCatalogNode.processingResult.relation({
|
|
43
|
+
source: {
|
|
44
|
+
kind: targetRef.kind,
|
|
45
|
+
namespace: targetRef.namespace,
|
|
46
|
+
name: targetRef.name
|
|
47
|
+
},
|
|
48
|
+
type: catalogModel.RELATION_OWNER_OF,
|
|
49
|
+
target: selfRef
|
|
50
|
+
})
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
return entity;
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
|
|
59
|
+
//# sourceMappingURL=ScaffolderEntitiesProcessor.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ScaffolderEntitiesProcessor.cjs.js","sources":["../../src/processor/ScaffolderEntitiesProcessor.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 {\n Entity,\n getCompoundEntityRef,\n parseEntityRef,\n RELATION_OWNED_BY,\n RELATION_OWNER_OF,\n} from '@backstage/catalog-model';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n processingResult,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n TemplateEntityV1beta3,\n templateEntityV1beta3Validator,\n} from '@backstage/plugin-scaffolder-common';\n\n/**\n * Adds support for scaffolder specific entity kinds to the catalog.\n *\n * @public\n */\nexport class ScaffolderEntitiesProcessor implements CatalogProcessor {\n getProcessorName(): string {\n return 'ScaffolderEntitiesProcessor';\n }\n\n private readonly validators = [templateEntityV1beta3Validator];\n\n async validateEntityKind(entity: Entity): Promise<boolean> {\n for (const validator of this.validators) {\n if (await validator.check(entity)) {\n return true;\n }\n }\n\n return false;\n }\n\n async postProcessEntity(\n entity: Entity,\n _location: LocationSpec,\n emit: CatalogProcessorEmit,\n ): Promise<Entity> {\n const selfRef = getCompoundEntityRef(entity);\n\n if (\n entity.apiVersion === 'scaffolder.backstage.io/v1beta3' &&\n entity.kind === 'Template'\n ) {\n const template = entity as TemplateEntityV1beta3;\n\n const target = template.spec.owner;\n if (target) {\n const targetRef = parseEntityRef(target, {\n defaultKind: 'Group',\n defaultNamespace: selfRef.namespace,\n });\n emit(\n processingResult.relation({\n source: selfRef,\n type: RELATION_OWNED_BY,\n target: {\n kind: targetRef.kind,\n namespace: targetRef.namespace,\n name: targetRef.name,\n },\n }),\n );\n emit(\n processingResult.relation({\n source: {\n kind: targetRef.kind,\n namespace: targetRef.namespace,\n name: targetRef.name,\n },\n type: RELATION_OWNER_OF,\n target: selfRef,\n }),\n );\n }\n }\n\n return entity;\n }\n}\n"],"names":["templateEntityV1beta3Validator","getCompoundEntityRef","parseEntityRef","processingResult","RELATION_OWNED_BY","RELATION_OWNER_OF"],"mappings":";;;;;;AAuCO,MAAM,2BAAwD,CAAA;AAAA,EACnE,gBAA2B,GAAA;AACzB,IAAO,OAAA,6BAAA,CAAA;AAAA,GACT;AAAA,EAEiB,UAAA,GAAa,CAACA,qDAA8B,CAAA,CAAA;AAAA,EAE7D,MAAM,mBAAmB,MAAkC,EAAA;AACzD,IAAW,KAAA,MAAA,SAAA,IAAa,KAAK,UAAY,EAAA;AACvC,MAAA,IAAI,MAAM,SAAA,CAAU,KAAM,CAAA,MAAM,CAAG,EAAA;AACjC,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAAA,KACF;AAEA,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,iBAAA,CACJ,MACA,EAAA,SAAA,EACA,IACiB,EAAA;AACjB,IAAM,MAAA,OAAA,GAAUC,kCAAqB,MAAM,CAAA,CAAA;AAE3C,IAAA,IACE,MAAO,CAAA,UAAA,KAAe,iCACtB,IAAA,MAAA,CAAO,SAAS,UAChB,EAAA;AACA,MAAA,MAAM,QAAW,GAAA,MAAA,CAAA;AAEjB,MAAM,MAAA,MAAA,GAAS,SAAS,IAAK,CAAA,KAAA,CAAA;AAC7B,MAAA,IAAI,MAAQ,EAAA;AACV,QAAM,MAAA,SAAA,GAAYC,4BAAe,MAAQ,EAAA;AAAA,UACvC,WAAa,EAAA,OAAA;AAAA,UACb,kBAAkB,OAAQ,CAAA,SAAA;AAAA,SAC3B,CAAA,CAAA;AACD,QAAA,IAAA;AAAA,UACEC,mCAAiB,QAAS,CAAA;AAAA,YACxB,MAAQ,EAAA,OAAA;AAAA,YACR,IAAM,EAAAC,8BAAA;AAAA,YACN,MAAQ,EAAA;AAAA,cACN,MAAM,SAAU,CAAA,IAAA;AAAA,cAChB,WAAW,SAAU,CAAA,SAAA;AAAA,cACrB,MAAM,SAAU,CAAA,IAAA;AAAA,aAClB;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AACA,QAAA,IAAA;AAAA,UACED,mCAAiB,QAAS,CAAA;AAAA,YACxB,MAAQ,EAAA;AAAA,cACN,MAAM,SAAU,CAAA,IAAA;AAAA,cAChB,WAAW,SAAU,CAAA,SAAA;AAAA,cACrB,MAAM,SAAU,CAAA,IAAA;AAAA,aAClB;AAAA,YACA,IAAM,EAAAE,8BAAA;AAAA,YACN,MAAQ,EAAA,OAAA;AAAA,WACT,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-scaffolder-entity-model",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1-next.1",
|
|
4
4
|
"description": "Adds support for the scaffolder specific entity model (e.g. the Template kind) to the catalog backend plugin.",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
"license": "Apache-2.0",
|
|
19
19
|
"exports": {
|
|
20
20
|
".": {
|
|
21
|
+
"backstage": "@backstage/BackendFeature",
|
|
21
22
|
"require": "./dist/index.cjs.js",
|
|
22
23
|
"types": "./dist/index.d.ts",
|
|
23
24
|
"default": "./dist/index.cjs.js"
|
|
@@ -39,14 +40,14 @@
|
|
|
39
40
|
"test": "backstage-cli package test"
|
|
40
41
|
},
|
|
41
42
|
"dependencies": {
|
|
42
|
-
"@backstage/backend-plugin-api": "
|
|
43
|
-
"@backstage/catalog-model": "
|
|
44
|
-
"@backstage/plugin-catalog-common": "
|
|
45
|
-
"@backstage/plugin-catalog-node": "
|
|
46
|
-
"@backstage/plugin-scaffolder-common": "
|
|
43
|
+
"@backstage/backend-plugin-api": "1.0.1-next.1",
|
|
44
|
+
"@backstage/catalog-model": "1.7.0",
|
|
45
|
+
"@backstage/plugin-catalog-common": "1.1.0",
|
|
46
|
+
"@backstage/plugin-catalog-node": "1.13.1-next.1",
|
|
47
|
+
"@backstage/plugin-scaffolder-common": "1.5.6"
|
|
47
48
|
},
|
|
48
49
|
"devDependencies": {
|
|
49
|
-
"@backstage/backend-test-utils": "
|
|
50
|
-
"@backstage/cli": "
|
|
50
|
+
"@backstage/backend-test-utils": "1.0.1-next.2",
|
|
51
|
+
"@backstage/cli": "0.28.0-next.2"
|
|
51
52
|
}
|
|
52
53
|
}
|