@backstage/plugin-techdocs-node 0.0.0-nightly-20240818022051 → 0.0.0-nightly-20240821021909
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -7
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +10 -10
- package/package.json +9 -9
package/dist/index.d.ts
CHANGED
|
@@ -95,7 +95,7 @@ type ParsedLocationAnnotation = {
|
|
|
95
95
|
target: string;
|
|
96
96
|
};
|
|
97
97
|
/**
|
|
98
|
-
* Returns a
|
|
98
|
+
* Returns a parsed locations annotation
|
|
99
99
|
* @public
|
|
100
100
|
* @param annotationName - The name of the annotation in the entity metadata
|
|
101
101
|
* @param entity - A TechDocs entity instance
|
|
@@ -120,7 +120,7 @@ declare const transformDirLocation: (entity: Entity, dirAnnotation: ParsedLocati
|
|
|
120
120
|
target: string;
|
|
121
121
|
};
|
|
122
122
|
/**
|
|
123
|
-
* Returns
|
|
123
|
+
* Returns an entity reference based on the TechDocs annotation type
|
|
124
124
|
* @public
|
|
125
125
|
* @param entity - A TechDocs instance
|
|
126
126
|
* @param scmIntegration - An implementation for SCM integration API
|
|
@@ -543,7 +543,7 @@ interface DocsBuildStrategy {
|
|
|
543
543
|
}
|
|
544
544
|
|
|
545
545
|
/**
|
|
546
|
-
* Extension point type for configuring
|
|
546
|
+
* Extension point type for configuring TechDocs builds.
|
|
547
547
|
*
|
|
548
548
|
* @public
|
|
549
549
|
*/
|
|
@@ -552,13 +552,13 @@ interface TechdocsBuildsExtensionPoint {
|
|
|
552
552
|
setBuildLogTransport(transport: winston.transport): void;
|
|
553
553
|
}
|
|
554
554
|
/**
|
|
555
|
-
* Extension point for configuring
|
|
555
|
+
* Extension point for configuring TechDocs builds.
|
|
556
556
|
*
|
|
557
557
|
* @public
|
|
558
558
|
*/
|
|
559
559
|
declare const techdocsBuildsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsBuildsExtensionPoint>;
|
|
560
560
|
/**
|
|
561
|
-
* Extension point type for configuring a custom
|
|
561
|
+
* Extension point type for configuring a custom TechDocs generator
|
|
562
562
|
*
|
|
563
563
|
* @public
|
|
564
564
|
*/
|
|
@@ -566,13 +566,13 @@ interface TechdocsGeneratorExtensionPoint {
|
|
|
566
566
|
setTechdocsGenerator(generator: TechdocsGenerator): void;
|
|
567
567
|
}
|
|
568
568
|
/**
|
|
569
|
-
* Extension point for configuring a custom
|
|
569
|
+
* Extension point for configuring a custom TechDocs generator
|
|
570
570
|
*
|
|
571
571
|
* @public
|
|
572
572
|
*/
|
|
573
573
|
declare const techdocsGeneratorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsGeneratorExtensionPoint>;
|
|
574
574
|
/**
|
|
575
|
-
* Extension point type for configuring a custom
|
|
575
|
+
* Extension point type for configuring a custom TechDocs preparer
|
|
576
576
|
*
|
|
577
577
|
* @public
|
|
578
578
|
*/
|
|
@@ -580,13 +580,13 @@ interface TechdocsPreparerExtensionPoint {
|
|
|
580
580
|
registerPreparer(protocol: RemoteProtocol, preparer: PreparerBase): void;
|
|
581
581
|
}
|
|
582
582
|
/**
|
|
583
|
-
* Extension point for configuring a custom
|
|
583
|
+
* Extension point for configuring a custom TechDocs preparer
|
|
584
584
|
*
|
|
585
585
|
* @public
|
|
586
586
|
*/
|
|
587
587
|
declare const techdocsPreparerExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsPreparerExtensionPoint>;
|
|
588
588
|
/**
|
|
589
|
-
* Extension point type for configuring a custom
|
|
589
|
+
* Extension point type for configuring a custom TechDocs publisher
|
|
590
590
|
*
|
|
591
591
|
* @public
|
|
592
592
|
*/
|
|
@@ -594,7 +594,7 @@ interface TechdocsPublisherExtensionPoint {
|
|
|
594
594
|
registerPublisher(type: PublisherType, publisher: PublisherBase): void;
|
|
595
595
|
}
|
|
596
596
|
/**
|
|
597
|
-
* Extension point for configuring a custom
|
|
597
|
+
* Extension point for configuring a custom TechDocs publisher
|
|
598
598
|
*
|
|
599
599
|
* @public
|
|
600
600
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-node",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20240821021909",
|
|
4
4
|
"description": "Common node.js functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "node-library",
|
|
@@ -53,15 +53,15 @@
|
|
|
53
53
|
"@aws-sdk/types": "^3.347.0",
|
|
54
54
|
"@azure/identity": "^4.0.0",
|
|
55
55
|
"@azure/storage-blob": "^12.5.0",
|
|
56
|
-
"@backstage/backend-common": "^0.
|
|
57
|
-
"@backstage/backend-plugin-api": "^0.
|
|
58
|
-
"@backstage/catalog-model": "^
|
|
56
|
+
"@backstage/backend-common": "^0.24.0",
|
|
57
|
+
"@backstage/backend-plugin-api": "^0.8.0",
|
|
58
|
+
"@backstage/catalog-model": "^1.6.0",
|
|
59
59
|
"@backstage/config": "^1.2.0",
|
|
60
60
|
"@backstage/errors": "^1.2.4",
|
|
61
|
-
"@backstage/integration": "^
|
|
61
|
+
"@backstage/integration": "^1.14.0",
|
|
62
62
|
"@backstage/integration-aws-node": "^0.1.12",
|
|
63
|
-
"@backstage/plugin-search-common": "^
|
|
64
|
-
"@backstage/plugin-techdocs-common": "^0.
|
|
63
|
+
"@backstage/plugin-search-common": "^1.2.14",
|
|
64
|
+
"@backstage/plugin-techdocs-common": "^0.1.0",
|
|
65
65
|
"@google-cloud/storage": "^7.0.0",
|
|
66
66
|
"@smithy/node-http-handler": "^2.1.7",
|
|
67
67
|
"@trendyol-js/openstack-swift-sdk": "^0.0.7",
|
|
@@ -79,8 +79,8 @@
|
|
|
79
79
|
"winston": "^3.2.1"
|
|
80
80
|
},
|
|
81
81
|
"devDependencies": {
|
|
82
|
-
"@backstage/backend-test-utils": "^0.0.0-nightly-
|
|
83
|
-
"@backstage/cli": "^0.
|
|
82
|
+
"@backstage/backend-test-utils": "^0.0.0-nightly-20240821021909",
|
|
83
|
+
"@backstage/cli": "^0.27.0",
|
|
84
84
|
"@types/fs-extra": "^11.0.0",
|
|
85
85
|
"@types/js-yaml": "^4.0.0",
|
|
86
86
|
"@types/mime-types": "^2.1.0",
|