@backstage/plugin-techdocs-node 1.8.2 → 1.9.0

package/dist/index.d.ts

@@ -64,6 +64,10 @@ type PreparerBase = {
      * @throws `NotModifiedError` when the prepared directory has not been changed since the last build.
      */
     prepare(entity: Entity, options?: PreparerOptions): Promise<PreparerResponse>;
+    /**
+     * Indicates whether the prepared directory should be cleaned after generation.
+     */
+    shouldCleanPreparedDirectory(): boolean;
 };
 /**
  * Definition for a TechDocs preparer builder
@@ -246,16 +250,17 @@ declare class Generators implements GeneratorBuilder {
 }
 
 /**
- * Finds and loads the contents of either an mkdocs.yml or mkdocs.yaml file,
- * depending on which is present (MkDocs supports both as of v1.2.2).
+ * Finds and loads the contents of an mkdocs.yml, mkdocs.yaml file, a file
+ * with a specified name or an ad-hoc created file with minimal config.
  * @public
  *
  * @param inputDir - base dir to be searched for either an mkdocs.yml or mkdocs.yaml file.
- * @param siteOptions - options for the site: `name` property will be used in mkdocs.yml for the
- * required `site_name` property, default value is "Documentation Site"
+ * @param options - name: default mkdocs site_name to be used with a ad hoc file default value is "Documentation Site"
+ *                  mkdocsConfigFileName (optional): a non-default file name to be used as the config
  */
-declare const getMkdocsYml: (inputDir: string, siteOptions?: {
+declare const getMkdocsYml: (inputDir: string, options?: {
     name?: string;
+    mkdocsConfigFileName?: string;
 }) => Promise<{
     path: string;
     content: string;
@@ -267,8 +272,9 @@ declare const getMkdocsYml: (inputDir: string, siteOptions?: {
  * @deprecated
  * Deprecated in favor of getMkdocsYml (lowercase 'd')
  */
-declare const getMkDocsYml: (inputDir: string, siteOptions?: {
+declare const getMkDocsYml: (inputDir: string, options?: {
     name?: string | undefined;
+    mkdocsConfigFileName?: string | undefined;
 } | undefined) => Promise<{
     path: string;
     content: string;
@@ -289,6 +295,8 @@ declare class DirectoryPreparer implements PreparerBase {
      */
     static fromConfig(config: Config, options: PreparerConfig): DirectoryPreparer;
     private constructor();
+    /** {@inheritDoc PreparerBase.shouldCleanPreparedDirectory} */
+    shouldCleanPreparedDirectory(): boolean;
     /** {@inheritDoc PreparerBase.prepare} */
     prepare(entity: Entity, options?: PreparerOptions): Promise<PreparerResponse>;
 }
@@ -306,6 +314,8 @@ declare class UrlPreparer implements PreparerBase {
      */
     static fromConfig(options: PreparerConfig): UrlPreparer;
     private constructor();
+    /** {@inheritDoc PreparerBase.shouldCleanPreparedDirectory} */
+    shouldCleanPreparedDirectory(): boolean;
     /** {@inheritDoc PreparerBase.prepare} */
     prepare(entity: Entity, options?: PreparerOptions): Promise<PreparerResponse>;
 }

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.8.2",
+  "version": "1.9.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -46,13 +46,13 @@
     "@aws-sdk/types": "^3.347.0",
     "@azure/identity": "^3.2.1",
     "@azure/storage-blob": "^12.5.0",
-    "@backstage/backend-common": "^0.19.7",
-    "@backstage/catalog-model": "^1.4.2",
-    "@backstage/config": "^1.1.0",
-    "@backstage/errors": "^1.2.2",
-    "@backstage/integration": "^1.7.0",
-    "@backstage/integration-aws-node": "^0.1.6",
-    "@backstage/plugin-search-common": "^1.2.6",
+    "@backstage/backend-common": "^0.19.8",
+    "@backstage/catalog-model": "^1.4.3",
+    "@backstage/config": "^1.1.1",
+    "@backstage/errors": "^1.2.3",
+    "@backstage/integration": "^1.7.1",
+    "@backstage/integration-aws-node": "^0.1.7",
+    "@backstage/plugin-search-common": "^1.2.7",
     "@google-cloud/storage": "^6.0.0",
     "@trendyol-js/openstack-swift-sdk": "^0.0.6",
     "@types/express": "^4.17.6",
@@ -63,17 +63,16 @@
     "js-yaml": "^4.0.0",
     "json5": "^2.1.3",
     "mime-types": "^2.1.27",
-    "mock-fs": "^5.1.0",
     "p-limit": "^3.1.0",
     "recursive-readdir": "^2.2.2",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.13",
+    "@backstage/backend-test-utils": "^0.2.7",
+    "@backstage/cli": "^0.23.0",
     "@types/fs-extra": "^9.0.5",
     "@types/js-yaml": "^4.0.0",
     "@types/mime-types": "^2.1.0",
-    "@types/mock-fs": "^4.13.0",
     "@types/recursive-readdir": "^2.2.0",
     "@types/supertest": "^2.0.8",
     "aws-sdk-client-mock": "^2.0.0",