@backstage/plugin-techdocs-node 1.6.1-next.1 → 1.6.1-next.3

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-techdocs-node
 
+## 1.6.1-next.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.3.0-next.0
+  - @backstage/backend-common@0.18.4-next.2
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+  - @backstage/integration@1.4.4-next.0
+  - @backstage/integration-aws-node@0.1.2
+  - @backstage/plugin-search-common@1.2.3-next.0
+
+## 1.6.1-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.18.4-next.2
+  - @backstage/catalog-model@1.2.1
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+  - @backstage/integration@1.4.4-next.0
+  - @backstage/integration-aws-node@0.1.2
+  - @backstage/plugin-search-common@1.2.3-next.0
+
 ## 1.6.1-next.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -12,12 +12,12 @@ import { Writable } from 'stream';
  * A unique identifier of the tree blob, usually the commit SHA or etag from the target.
  * @public
  */
-declare type ETag = string;
+type ETag = string;
 /**
  * Options for building preparers
  * @public
  */
-declare type PreparerConfig = {
+type PreparerConfig = {
     logger: Logger;
     reader: UrlReader;
 };
@@ -25,7 +25,7 @@ declare type PreparerConfig = {
  * Options for configuring the content preparation process.
  * @public
  */
-declare type PreparerOptions = {
+type PreparerOptions = {
     /**
      * An instance of the logger
      */
@@ -39,7 +39,7 @@ declare type PreparerOptions = {
  * Result of the preparation step.
  * @public
  */
-declare type PreparerResponse = {
+type PreparerResponse = {
     /**
      * The path to directory where the tree is downloaded.
      */
@@ -53,7 +53,7 @@ declare type PreparerResponse = {
  * Definition of a TechDocs preparer
  * @public
  */
-declare type PreparerBase = {
+type PreparerBase = {
     /**
      * Given an Entity definition from the Software Catalog, go and prepare a directory
      * with contents from the location in temporary storage and return the path.
@@ -69,7 +69,7 @@ declare type PreparerBase = {
  * Definition for a TechDocs preparer builder
  * @public
  */
-declare type PreparerBuilder = {
+type PreparerBuilder = {
     register(protocol: RemoteProtocol, preparer: PreparerBase): void;
     get(entity: Entity): PreparerBase;
 };
@@ -77,13 +77,13 @@ declare type PreparerBuilder = {
  * Location where documentation files are stored
  * @public
  */
-declare type RemoteProtocol = 'url' | 'dir';
+type RemoteProtocol = 'url' | 'dir';
 
 /**
  * Parsed location annotation
  * @public
  */
-declare type ParsedLocationAnnotation = {
+type ParsedLocationAnnotation = {
     type: RemoteProtocol;
     target: string;
 };
@@ -135,7 +135,7 @@ declare const getDocFilesFromRepository: (reader: UrlReader, entity: Entity, opt
  * Options for building generators
  * @public
  */
-declare type GeneratorOptions = {
+type GeneratorOptions = {
     containerRunner?: ContainerRunner;
     logger: Logger;
 };
@@ -151,7 +151,7 @@ declare type GeneratorOptions = {
  * @param logStream - A log stream that can send raw log messages to the caller to be displayed outside of the backend.
  * @param siteOptions - Options for the site: The `name` property will be used in mkdocs.yml config for the required `site_name` property, default value is "Documentation Site"
  */
-declare type GeneratorRunOptions = {
+type GeneratorRunOptions = {
     inputDir: string;
     outputDir: string;
     parsedLocationAnnotation?: ParsedLocationAnnotation;
@@ -166,7 +166,7 @@ declare type GeneratorRunOptions = {
  * Generates documentation files
  * @public
  */
-declare type GeneratorBase = {
+type GeneratorBase = {
     /**
      * Runs the generator with the values
      * @public
@@ -177,12 +177,12 @@ declare type GeneratorBase = {
  * List of supported generator options
  * @public
  */
-declare type SupportedGeneratorKey = 'techdocs' | string;
+type SupportedGeneratorKey = 'techdocs' | string;
 /**
  * The generator builder holds the generator ready for run time
  * @public
  */
-declare type GeneratorBuilder = {
+type GeneratorBuilder = {
     register(protocol: SupportedGeneratorKey, generator: GeneratorBase): void;
     get(entity: Entity): GeneratorBase;
 };
@@ -341,7 +341,7 @@ declare class Preparers implements PreparerBuilder {
  * Options for building publishers
  * @public
  */
-declare type PublisherFactory = {
+type PublisherFactory = {
     logger: Logger;
     discovery: PluginEndpointDiscovery;
 };
@@ -349,12 +349,12 @@ declare type PublisherFactory = {
  * Key for all the different types of TechDocs publishers that are supported.
  * @public
  */
-declare type PublisherType = 'local' | 'googleGcs' | 'awsS3' | 'azureBlobStorage' | 'openStackSwift';
+type PublisherType = 'local' | 'googleGcs' | 'awsS3' | 'azureBlobStorage' | 'openStackSwift';
 /**
  * Request publish definition
  * @public
  */
-declare type PublishRequest = {
+type PublishRequest = {
     entity: Entity;
     directory: string;
 };
@@ -363,7 +363,7 @@ declare type PublishRequest = {
  * have been published or updated.
  * @public
  */
-declare type PublishResponse = {
+type PublishResponse = {
     /**
      * The URL which serves files from the local publisher's static directory.
      */
@@ -379,7 +379,7 @@ declare type PublishResponse = {
  * Result for the validation check.
  * @public
  */
-declare type ReadinessResponse = {
+type ReadinessResponse = {
     /** If true, the publisher is able to interact with the backing storage. */
     isAvailable: boolean;
 };
@@ -388,7 +388,7 @@ declare type ReadinessResponse = {
  * @param etag - ETag of the resource used to generate the site. Usually the latest commit sha of the source repository.
  * @public
  */
-declare type TechDocsMetadata = {
+type TechDocsMetadata = {
     site_name: string;
     site_description: string;
     etag: string;
@@ -399,7 +399,7 @@ declare type TechDocsMetadata = {
  * TechDocs entity triplet migration request
  * @public
  */
-declare type MigrateRequest = {
+type MigrateRequest = {
     /**
      * Whether or not to remove the source file. Defaults to false (acting like a
      * copy instead of a move).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-techdocs-node",
   "description": "Common node.js functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli",
-  "version": "1.6.1-next.1",
+  "version": "1.6.1-next.3",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -46,8 +46,8 @@
     "@aws-sdk/types": "^3.208.0",
     "@azure/identity": "^2.1.0",
     "@azure/storage-blob": "^12.5.0",
-    "@backstage/backend-common": "^0.18.4-next.1",
-    "@backstage/catalog-model": "^1.2.1",
+    "@backstage/backend-common": "^0.18.4-next.2",
+    "@backstage/catalog-model": "^1.3.0-next.0",
     "@backstage/config": "^1.0.7",
     "@backstage/errors": "^1.1.5",
     "@backstage/integration": "^1.4.4-next.0",
@@ -69,7 +69,7 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.6-next.1",
+    "@backstage/cli": "^0.22.6-next.3",
     "@types/fs-extra": "^9.0.5",
     "@types/js-yaml": "^4.0.0",
     "@types/mime-types": "^2.1.0",