@backstage/plugin-techdocs-node 0.0.0-nightly-20240930023420 → 0.0.0-nightly-20241002023110

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +18 -3
  2. package/dist/index.cjs.js +7 -3
  3. package/dist/index.cjs.js.map +1 -1
  4. package/dist/index.d.ts +11 -1
  5. package/package.json +5 -5
package/dist/index.d.ts CHANGED
@@ -4,6 +4,7 @@ import { Config } from '@backstage/config';
4
4
  import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
5
5
  import { LoggerService, UrlReaderService, DiscoveryService } from '@backstage/backend-plugin-api';
6
6
  import express from 'express';
7
+ import { StorageOptions } from '@google-cloud/storage';
7
8
  import { ScmIntegrationRegistry } from '@backstage/integration';
8
9
  import { IndexableDocument } from '@backstage/plugin-search-common';
9
10
  import { Writable } from 'stream';
@@ -394,7 +395,15 @@ type PublisherFactory = {
394
395
  logger: LoggerService;
395
396
  discovery: DiscoveryService;
396
397
  customPublisher?: PublisherBase | undefined;
398
+ publisherSettings?: PublisherSettings;
397
399
  };
400
+ /**
401
+ * Additional configurations for publishers.
402
+ * @public
403
+ */
404
+ interface PublisherSettings {
405
+ googleGcs?: StorageOptions;
406
+ }
398
407
  /**
399
408
  * Key for all the different types of TechDocs publishers that are supported.
400
409
  * @public
@@ -622,6 +631,7 @@ declare const techdocsPreparerExtensionPoint: _backstage_backend_plugin_api.Exte
622
631
  */
623
632
  interface TechdocsPublisherExtensionPoint {
624
633
  registerPublisher(type: PublisherType, publisher: PublisherBase): void;
634
+ registerPublisherSettings<T extends keyof PublisherSettings>(publisher: T, settings: PublisherSettings[T]): void;
625
635
  }
626
636
  /**
627
637
  * Extension point for configuring a custom TechDocs publisher
@@ -630,4 +640,4 @@ interface TechdocsPublisherExtensionPoint {
630
640
  */
631
641
  declare const techdocsPublisherExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsPublisherExtensionPoint>;
632
642
 
633
- export { DirectoryPreparer, type DocsBuildStrategy, type ETag, type GeneratorBase, type GeneratorBuilder, type GeneratorOptions, type GeneratorRunOptions, Generators, type MigrateRequest, type ParsedLocationAnnotation, type PreparerBase, type PreparerBuilder, type PreparerConfig, type PreparerOptions, type PreparerResponse, Preparers, type PublishRequest, type PublishResponse, Publisher, type PublisherBase, type PublisherBuilder, type PublisherFactory, type PublisherType, type ReadinessResponse, type RemoteProtocol, type SupportedGeneratorKey, type TechDocsContainerRunner, type TechDocsDocument, type TechDocsMetadata, type TechdocsBuildsExtensionPoint, TechdocsGenerator, type TechdocsGeneratorExtensionPoint, type TechdocsPreparerExtensionPoint, type TechdocsPublisherExtensionPoint, UrlPreparer, getDocFilesFromRepository, getLocationForEntity, getMkDocsYml, getMkdocsYml, parseReferenceAnnotation, techdocsBuildsExtensionPoint, techdocsGeneratorExtensionPoint, techdocsPreparerExtensionPoint, techdocsPublisherExtensionPoint, transformDirLocation };
643
+ export { DirectoryPreparer, type DocsBuildStrategy, type ETag, type GeneratorBase, type GeneratorBuilder, type GeneratorOptions, type GeneratorRunOptions, Generators, type MigrateRequest, type ParsedLocationAnnotation, type PreparerBase, type PreparerBuilder, type PreparerConfig, type PreparerOptions, type PreparerResponse, Preparers, type PublishRequest, type PublishResponse, Publisher, type PublisherBase, type PublisherBuilder, type PublisherFactory, type PublisherSettings, type PublisherType, type ReadinessResponse, type RemoteProtocol, type SupportedGeneratorKey, type TechDocsContainerRunner, type TechDocsDocument, type TechDocsMetadata, type TechdocsBuildsExtensionPoint, TechdocsGenerator, type TechdocsGeneratorExtensionPoint, type TechdocsPreparerExtensionPoint, type TechdocsPublisherExtensionPoint, UrlPreparer, getDocFilesFromRepository, getLocationForEntity, getMkDocsYml, getMkdocsYml, parseReferenceAnnotation, techdocsBuildsExtensionPoint, techdocsGeneratorExtensionPoint, techdocsPreparerExtensionPoint, techdocsPublisherExtensionPoint, transformDirLocation };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs-node",
3
- "version": "0.0.0-nightly-20240930023420",
3
+ "version": "0.0.0-nightly-20241002023110",
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,11 +53,11 @@
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-plugin-api": "0.0.0-nightly-20240930023420",
56
+ "@backstage/backend-plugin-api": "0.0.0-nightly-20241002023110",
57
57
  "@backstage/catalog-model": "1.7.0",
58
58
  "@backstage/config": "1.2.0",
59
59
  "@backstage/errors": "1.2.4",
60
- "@backstage/integration": "1.15.0",
60
+ "@backstage/integration": "0.0.0-nightly-20241002023110",
61
61
  "@backstage/integration-aws-node": "0.1.12",
62
62
  "@backstage/plugin-search-common": "1.2.14",
63
63
  "@backstage/plugin-techdocs-common": "0.1.0",
@@ -78,8 +78,8 @@
78
78
  "winston": "^3.2.1"
79
79
  },
80
80
  "devDependencies": {
81
- "@backstage/backend-test-utils": "0.0.0-nightly-20240930023420",
82
- "@backstage/cli": "0.0.0-nightly-20240930023420",
81
+ "@backstage/backend-test-utils": "0.0.0-nightly-20241002023110",
82
+ "@backstage/cli": "0.0.0-nightly-20241002023110",
83
83
  "@types/fs-extra": "^11.0.0",
84
84
  "@types/js-yaml": "^4.0.0",
85
85
  "@types/mime-types": "^2.1.0",