@red-hat-developer-hub/backstage-plugin-catalog-techdoc-url-reader-backend 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# @red-hat-developer-hub/backstage-plugin-catalog-techdoc-url-reader-backend
+
+## 0.3.0
+
+### Minor Changes
+
+- 986f8ad: Backstage version bump to v1.42.5
+
+## 0.2.2
+
+### Patch Changes
+
+- 551bffa: remove backend catalog dependency
+
+## 0.2.1
+
+### Patch Changes
+
+- 237c394: removing temporary duplicate code for model catalog bridge config now that 'catalog-backend-module-model-config' exposes the requisite types/methods
+
+## 0.2.0
+
+### Minor Changes
+
+- 7dc735d: a new backstage plugin, a sevice factory, is delivered to provide a URLReader that interacts with the model catalog bridges techdoc/model card endpoint; the catalog backend module is also updated so that the bridge configration information is exported and reusable by the techdoc plugin

package/README.md

@@ -0,0 +1,37 @@
+# catalog-techdoc-url-reader
+
+This plugin backend provides implementations around the [URL Readers](https://backstage.io/docs/backend-system/core-services/url-reader) extension point of Backstage's Core Services. We introduce the extension via a Backstage service factory, per the documentation.
+
+Our new URL Reader here allows for TechDoc generation to access a REST API provided by the RHDH Model Catalog Bridge. This allows AI Platform Engineers to leverage AI Model Cards provided by Red Hat OpenShift AI (RHOAI) as the TechDocs for the AI Models that the RHDH Model Catalog Bridge imports into the Backstage Catalog included with RHDH.
+
+Coupled with our `URLReaderService` implementation is also an customized implementation of the Backstage `UrlReaderServiceReadTreeResponse` interface. This implemenation both
+facilitates customization of how the Model Catalog Bridge REST APIs for TechDocs are accessed, and allows for future customization of the final TechDoc compilation, in the event we want to augment the RHOAI Model Cards to leverage the varioud Backstage TechDoc extensions and addons.
+
+## Installation
+
+This plugin is installed via the `@@red-hat-developer-hub/backstage-plugin-catalog-techdoc-url-reader-backend` package. To install it to your backend package, run the following command:
+
+```bash
+# From your root directory
+yarn --cwd packages/backend add @@red-hat-developer-hub/backstage-plugin-catalog-techdoc-url-reader-backend
+```
+
+Then add the plugin to your backend in `packages/backend/src/index.ts`:
+
+```ts
+const backend = createBackend();
+// ...
+backend.add(
+  import(
+    '@@red-hat-developer-hub/backstage-plugin-catalog-techdoc-url-reader-backend'
+  ),
+);
+```
+
+## Development
+
+This plugin backend can be started in a standalone mode from directly in this
+package with `yarn start`. It is a limited setup that is most convenient when
+developing the plugin backend itself.
+
+If you want to run the entire project, including the frontend, run `yarn dev` from the root directory.

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var plugin = require('./plugin.cjs.js');
+
+
+
+exports.default = plugin.catalogTechdocUrlReaderPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { ReaderFactory } from '@backstage/backend-defaults/urlReader';
+
+/**
+ * catalogTechdocUrlReaderPlugin define the factory for the ModelCatalogBridgeUrlReader service
+ *
+ * @public
+ */
+declare const catalogTechdocUrlReaderPlugin: _backstage_backend_plugin_api.ServiceFactory<ReaderFactory, "plugin", "multiton">;
+
+export { catalogTechdocUrlReaderPlugin as default };

package/dist/plugin.cjs.js

@@ -0,0 +1,164 @@
+'use strict';
+
+var urlReader = require('@backstage/backend-defaults/urlReader');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var errors = require('@backstage/errors');
+var fs = require('fs');
+var platformPath = require('path');
+var os = require('os');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var platformPath__default = /*#__PURE__*/_interopDefaultCompat(platformPath);
+var os__default = /*#__PURE__*/_interopDefaultCompat(os);
+
+class ModelCatalogBridgeUrlReaderServiceReadTreeResponse {
+  constructor(workDir, etag, buffer, logger) {
+    this.workDir = workDir;
+    this.etag = etag;
+    this.buffer = buffer;
+    this.logger = logger;
+    this.logger = logger.child({
+      source: 'ModelCatalogBridgeUrlReaderServiceReadTreeResponse"'
+    });
+  }
+  async files() {
+    throw new Error(
+      "ModelCatalogBridgeUrlReaderServiceReadTreeResponse does not implement files"
+    );
+  }
+  async archive() {
+    throw new Error(
+      "ModelCatalogBridgeUrlReaderServiceReadTreeResponse does not implement archive"
+    );
+  }
+  async dir(options) {
+    const dir = options?.targetDir ?? await fs__default.default.promises.mkdtemp(
+      platformPath__default.default.join(this.workDir, "backstage-")
+    );
+    const subDir = platformPath__default.default.join(dir, "docs");
+    const filePath = platformPath__default.default.join(subDir, "index.md");
+    try {
+      fs__default.default.mkdirSync(subDir);
+      const buf = await this.buffer;
+      await fs__default.default.promises.writeFile(filePath, buf);
+    } catch (error) {
+      this.logger.error(`Error writing to file ${filePath}:`, error);
+    }
+    return dir;
+  }
+}
+function readBridgeConfigs(config) {
+  const configs = config.getOptionalConfig("catalog.providers.modelCatalog");
+  if (!configs) {
+    return [];
+  }
+  return configs.keys().map((id) => readBridgeConfig(id, configs.getConfig(id)));
+}
+function readBridgeConfig(id, config) {
+  const url = config.getString("baseUrl");
+  return { id, baseUrl: url };
+}
+class ModeCatalogBridgeTechdocUrlReader {
+  workDir;
+  logger;
+  bridgeConfigs;
+  static factory = ({ config, logger }) => {
+    const reader = new ModeCatalogBridgeTechdocUrlReader(config, logger);
+    const predicate = (url) => reader.bridgePredicate(url);
+    return [{ reader, predicate }];
+  };
+  constructor(config, logger) {
+    this.logger = logger.child({
+      source: 'ModeCatalogBridgeTechdocUrlReader"'
+    });
+    this.bridgeConfigs = readBridgeConfigs(config);
+    this.workDir = os__default.default.tmpdir();
+    const bkend = config.getOptionalString("backend.workingDirectory");
+    if (bkend) {
+      this.workDir = bkend;
+    }
+  }
+  bridgePredicate = (url) => {
+    for (let index = 0; index < this.bridgeConfigs.length; index++) {
+      const bc = this.bridgeConfigs[index];
+      const bcUrl = new URL(bc.baseUrl);
+      if (url.hostname === bcUrl.hostname && url.port === bcUrl.port && url.pathname.startsWith("/modelcard")) {
+        return true;
+      }
+    }
+    if (url.hostname === "localhost" && url.port === "9090" && url.pathname.startsWith("/modelcard")) {
+      return true;
+    }
+    return false;
+  };
+  async readUrl(url, options) {
+    this.logger.info(`ModelCatalogBridgeTechdocUrlReader.readUrl of ${url}`);
+    let response;
+    try {
+      response = await fetch(url, {
+        signal: options?.signal
+      });
+    } catch (e) {
+      throw new Error(`Unable to read ${url}, ${e}`);
+    }
+    if (response.ok) {
+      return urlReader.ReadUrlResponseFactory.fromResponse(response);
+    }
+    const message = `could not read ${url}, ${response.status} ${response.statusText}`;
+    if (response.status === 404) {
+      throw new errors.NotFoundError(message);
+    }
+    if (response.status === 304) {
+      throw new errors.NotModifiedError();
+    }
+    throw new Error(message);
+  }
+  async search(url, options) {
+    this.logger.info(
+      `ModelCatalogBridgeTechdocUrlReader.search of ${url} with options ${JSON.stringify(
+        options
+      )}`
+    );
+    throw new Error(
+      "ModeCatalogBridgeTechdocUrlReader does not implement search"
+    );
+  }
+  async readTree(url, options) {
+    this.logger.info(`ModelCatalogBridgeTechdocUrlReader.readTree of ${url}`);
+    const data = await this.readUrl(url, options);
+    const et = options?.etag;
+    if (!et) {
+      return await new ModelCatalogBridgeUrlReaderServiceReadTreeResponse(
+        this.workDir,
+        "",
+        data.buffer(),
+        this.logger
+      );
+    }
+    return await new ModelCatalogBridgeUrlReaderServiceReadTreeResponse(
+      this.workDir,
+      et,
+      data.buffer(),
+      this.logger
+    );
+  }
+}
+const catalogTechdocUrlReaderPlugin = backendPluginApi.createServiceFactory({
+  service: urlReader.urlReaderFactoriesServiceRef,
+  deps: {
+    logger: backendPluginApi.coreServices.logger
+  },
+  async factory({ logger }) {
+    logger.child({ source: 'catalogTechdocUrlReaderPlugin"' }).info("Registering the model catalog bridge URL reader ");
+    return ModeCatalogBridgeTechdocUrlReader.factory;
+  }
+});
+
+exports.ModeCatalogBridgeTechdocUrlReader = ModeCatalogBridgeTechdocUrlReader;
+exports.ModelCatalogBridgeUrlReaderServiceReadTreeResponse = ModelCatalogBridgeUrlReaderServiceReadTreeResponse;
+exports.catalogTechdocUrlReaderPlugin = catalogTechdocUrlReaderPlugin;
+exports.readBridgeConfig = readBridgeConfig;
+exports.readBridgeConfigs = readBridgeConfigs;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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  ReaderFactory,\n  ReadUrlResponseFactory,\n  urlReaderFactoriesServiceRef,\n} from '@backstage/backend-defaults/urlReader';\nimport {\n  coreServices,\n  createServiceFactory,\n  UrlReaderService,\n  UrlReaderServiceReadUrlOptions,\n  UrlReaderServiceSearchOptions,\n  UrlReaderServiceSearchResponse,\n  UrlReaderServiceReadUrlResponse,\n  UrlReaderServiceReadTreeOptions,\n  UrlReaderServiceReadTreeResponse,\n  UrlReaderServiceReadTreeResponseFile,\n  UrlReaderServiceReadTreeResponseDirOptions,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { NotFoundError, NotModifiedError } from '@backstage/errors';\nimport { Readable } from 'stream';\nimport fs from 'fs';\nimport platformPath from 'path';\nimport os from 'os';\n\nexport class ModelCatalogBridgeUrlReaderServiceReadTreeResponse\n  implements UrlReaderServiceReadTreeResponse\n{\n  constructor(\n    private readonly workDir: string,\n    public readonly etag: string,\n    private readonly buffer: Promise<Buffer>,\n    private readonly logger: LoggerService,\n  ) {\n    this.logger = logger.child({\n      source: 'ModelCatalogBridgeUrlReaderServiceReadTreeResponse\"',\n    });\n  }\n  async files(): Promise<UrlReaderServiceReadTreeResponseFile[]> {\n    throw new Error(\n      'ModelCatalogBridgeUrlReaderServiceReadTreeResponse does not implement files',\n    );\n  }\n  async archive(): Promise<Readable> {\n    throw new Error(\n      'ModelCatalogBridgeUrlReaderServiceReadTreeResponse does not implement archive',\n    );\n  }\n\n  async dir(\n    options?: UrlReaderServiceReadTreeResponseDirOptions,\n  ): Promise<string> {\n    const dir =\n      options?.targetDir ??\n      (await fs.promises.mkdtemp(\n        platformPath.join(this.workDir, 'backstage-'),\n      ));\n\n    const subDir = platformPath.join(dir, 'docs');\n    const filePath = platformPath.join(subDir, 'index.md');\n    try {\n      fs.mkdirSync(subDir);\n      const buf = await this.buffer;\n      await fs.promises.writeFile(filePath, buf);\n    } catch (error) {\n      this.logger.error(`Error writing to file ${filePath}:`, error);\n    }\n\n    return dir;\n  }\n}\n\nexport type BridgeConfig = {\n  id: string;\n  baseUrl: string;\n};\n\nexport function readBridgeConfigs(config: Config): BridgeConfig[] {\n  const configs = config.getOptionalConfig('catalog.providers.modelCatalog');\n  if (!configs) {\n    return [];\n  }\n  return configs.keys().map(id => readBridgeConfig(id, configs.getConfig(id)));\n}\n\nexport function readBridgeConfig(id: string, config: Config): BridgeConfig {\n  const url = config.getString('baseUrl');\n  return { id, baseUrl: url };\n}\n\nexport class ModeCatalogBridgeTechdocUrlReader implements UrlReaderService {\n  private readonly workDir: string;\n  private readonly logger: LoggerService;\n  private readonly bridgeConfigs: BridgeConfig[];\n\n  static factory: ReaderFactory = ({ config, logger }) => {\n    const reader = new ModeCatalogBridgeTechdocUrlReader(config, logger);\n    const predicate = (url: URL) => reader.bridgePredicate(url);\n\n    return [{ reader, predicate }];\n  };\n\n  constructor(config: Config, logger: LoggerService) {\n    this.logger = logger.child({\n      source: 'ModeCatalogBridgeTechdocUrlReader\"',\n    });\n    this.bridgeConfigs = readBridgeConfigs(config);\n    this.workDir = os.tmpdir();\n\n    const bkend = config.getOptionalString('backend.workingDirectory');\n    if (bkend) {\n      this.workDir = bkend;\n    }\n  }\n\n  bridgePredicate = (url: URL): boolean => {\n    for (let index = 0; index < this.bridgeConfigs.length; index++) {\n      const bc = this.bridgeConfigs[index];\n      const bcUrl = new URL(bc.baseUrl);\n      if (\n        url.hostname === bcUrl.hostname &&\n        url.port === bcUrl.port &&\n        url.pathname.startsWith('/modelcard')\n      ) {\n        return true;\n      }\n    }\n    if (\n      url.hostname === 'localhost' &&\n      url.port === '9090' &&\n      url.pathname.startsWith('/modelcard')\n    ) {\n      return true;\n    }\n    return false;\n  };\n\n  async readUrl(\n    url: string,\n    options?: UrlReaderServiceReadUrlOptions,\n  ): Promise<UrlReaderServiceReadUrlResponse> {\n    this.logger.info(`ModelCatalogBridgeTechdocUrlReader.readUrl of ${url}`);\n    let response: Response;\n    try {\n      response = await fetch(url, {\n        signal: options?.signal as any,\n      });\n    } catch (e) {\n      throw new Error(`Unable to read ${url}, ${e}`);\n    }\n\n    if (response.ok) {\n      return ReadUrlResponseFactory.fromResponse(response);\n    }\n\n    const message = `could not read ${url}, ${response.status} ${response.statusText}`;\n    if (response.status === 404) {\n      throw new NotFoundError(message);\n    }\n    if (response.status === 304) {\n      throw new NotModifiedError();\n    }\n    throw new Error(message);\n  }\n\n  async search(\n    url: string,\n    options?: UrlReaderServiceSearchOptions,\n  ): Promise<UrlReaderServiceSearchResponse> {\n    this.logger.info(\n      `ModelCatalogBridgeTechdocUrlReader.search of ${url} with options ${JSON.stringify(\n        options,\n      )}`,\n    );\n\n    throw new Error(\n      'ModeCatalogBridgeTechdocUrlReader does not implement search',\n    );\n    // const { pathname } = new URL(url);\n\n    // if (pathname.match(/[*?]/)) {\n    //   throw new Error('Unsupported search pattern URL');\n    // }\n\n    // try {\n    //   const data = await this.readUrl(url, options);\n\n    //   return {\n    //     files: [\n    //       {\n    //         url: url,\n    //         content: data.buffer,\n    //         lastModifiedAt: data.lastModifiedAt,\n    //       },\n    //     ],\n    //     etag: data.etag ?? '',\n    //   };\n    // } catch (error) {\n    //   assertError(error);\n    //   if (error.name === 'NotFoundError') {\n    //     return {\n    //       files: [],\n    //       etag: '',\n    //     };\n    //   }\n    //   throw error;\n    // }\n  }\n\n  async readTree(\n    url: string,\n    options?: UrlReaderServiceReadTreeOptions,\n  ): Promise<UrlReaderServiceReadTreeResponse> {\n    this.logger.info(`ModelCatalogBridgeTechdocUrlReader.readTree of ${url}`);\n    const data = await this.readUrl(url, options);\n\n    const et = options?.etag;\n    if (!et) {\n      return await new ModelCatalogBridgeUrlReaderServiceReadTreeResponse(\n        this.workDir,\n        '',\n        data.buffer(),\n        this.logger,\n      );\n    }\n    return await new ModelCatalogBridgeUrlReaderServiceReadTreeResponse(\n      this.workDir,\n      et,\n      data.buffer(),\n      this.logger,\n    );\n  }\n}\n\n/**\n * catalogTechdocUrlReaderPlugin define the factory for the ModelCatalogBridgeUrlReader service\n *\n * @public\n */\nexport const catalogTechdocUrlReaderPlugin = createServiceFactory({\n  service: urlReaderFactoriesServiceRef,\n  deps: {\n    logger: coreServices.logger,\n  },\n  async factory({ logger }) {\n    logger\n      .child({ source: 'catalogTechdocUrlReaderPlugin\"' })\n      .info('Registering the model catalog bridge URL reader ');\n\n    return ModeCatalogBridgeTechdocUrlReader.factory;\n  },\n});\n"],"names":["fs","platformPath","os","ReadUrlResponseFactory","NotFoundError","NotModifiedError","createServiceFactory","urlReaderFactoriesServiceRef","coreServices"],"mappings":";;;;;;;;;;;;;;;AA0CO,MAAM,kDAEb,CAAA;AAAA,EACE,WACmB,CAAA,OAAA,EACD,IACC,EAAA,MAAA,EACA,MACjB,EAAA;AAJiB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA;AACD,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AACC,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAEjB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAQ,EAAA;AAAA,KACT,CAAA;AAAA;AACH,EACA,MAAM,KAAyD,GAAA;AAC7D,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF,EACA,MAAM,OAA6B,GAAA;AACjC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AACF,EAEA,MAAM,IACJ,OACiB,EAAA;AACjB,IAAA,MAAM,GACJ,GAAA,OAAA,EAAS,SACR,IAAA,MAAMA,oBAAG,QAAS,CAAA,OAAA;AAAA,MACjBC,6BAAa,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,YAAY;AAAA,KAC9C;AAEF,IAAA,MAAM,MAAS,GAAAA,6BAAA,CAAa,IAAK,CAAA,GAAA,EAAK,MAAM,CAAA;AAC5C,IAAA,MAAM,QAAW,GAAAA,6BAAA,CAAa,IAAK,CAAA,MAAA,EAAQ,UAAU,CAAA;AACrD,IAAI,IAAA;AACF,MAAAD,mBAAA,CAAG,UAAU,MAAM,CAAA;AACnB,MAAM,MAAA,GAAA,GAAM,MAAM,IAAK,CAAA,MAAA;AACvB,MAAA,MAAMA,mBAAG,CAAA,QAAA,CAAS,SAAU,CAAA,QAAA,EAAU,GAAG,CAAA;AAAA,aAClC,KAAO,EAAA;AACd,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAyB,sBAAA,EAAA,QAAQ,KAAK,KAAK,CAAA;AAAA;AAG/D,IAAO,OAAA,GAAA;AAAA;AAEX;AAOO,SAAS,kBAAkB,MAAgC,EAAA;AAChE,EAAM,MAAA,OAAA,GAAU,MAAO,CAAA,iBAAA,CAAkB,gCAAgC,CAAA;AACzE,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAA,OAAO,EAAC;AAAA;AAEV,EAAO,OAAA,OAAA,CAAQ,IAAK,EAAA,CAAE,GAAI,CAAA,CAAA,EAAA,KAAM,gBAAiB,CAAA,EAAA,EAAI,OAAQ,CAAA,SAAA,CAAU,EAAE,CAAC,CAAC,CAAA;AAC7E;AAEgB,SAAA,gBAAA,CAAiB,IAAY,MAA8B,EAAA;AACzE,EAAM,MAAA,GAAA,GAAM,MAAO,CAAA,SAAA,CAAU,SAAS,CAAA;AACtC,EAAO,OAAA,EAAE,EAAI,EAAA,OAAA,EAAS,GAAI,EAAA;AAC5B;AAEO,MAAM,iCAA8D,CAAA;AAAA,EACxD,OAAA;AAAA,EACA,MAAA;AAAA,EACA,aAAA;AAAA,EAEjB,OAAO,OAAyB,GAAA,CAAC,EAAE,MAAA,EAAQ,QAAa,KAAA;AACtD,IAAA,MAAM,MAAS,GAAA,IAAI,iCAAkC,CAAA,MAAA,EAAQ,MAAM,CAAA;AACnE,IAAA,MAAM,SAAY,GAAA,CAAC,GAAa,KAAA,MAAA,CAAO,gBAAgB,GAAG,CAAA;AAE1D,IAAA,OAAO,CAAC,EAAE,MAAQ,EAAA,SAAA,EAAW,CAAA;AAAA,GAC/B;AAAA,EAEA,WAAA,CAAY,QAAgB,MAAuB,EAAA;AACjD,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAQ,EAAA;AAAA,KACT,CAAA;AACD,IAAK,IAAA,CAAA,aAAA,GAAgB,kBAAkB,MAAM,CAAA;AAC7C,IAAK,IAAA,CAAA,OAAA,GAAUE,oBAAG,MAAO,EAAA;AAEzB,IAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA;AACjE,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,IAAA,CAAK,OAAU,GAAA,KAAA;AAAA;AACjB;AACF,EAEA,eAAA,GAAkB,CAAC,GAAsB,KAAA;AACvC,IAAA,KAAA,IAAS,QAAQ,CAAG,EAAA,KAAA,GAAQ,IAAK,CAAA,aAAA,CAAc,QAAQ,KAAS,EAAA,EAAA;AAC9D,MAAM,MAAA,EAAA,GAAK,IAAK,CAAA,aAAA,CAAc,KAAK,CAAA;AACnC,MAAA,MAAM,KAAQ,GAAA,IAAI,GAAI,CAAA,EAAA,CAAG,OAAO,CAAA;AAChC,MAAA,IACE,GAAI,CAAA,QAAA,KAAa,KAAM,CAAA,QAAA,IACvB,GAAI,CAAA,IAAA,KAAS,KAAM,CAAA,IAAA,IACnB,GAAI,CAAA,QAAA,CAAS,UAAW,CAAA,YAAY,CACpC,EAAA;AACA,QAAO,OAAA,IAAA;AAAA;AACT;AAEF,IACE,IAAA,GAAA,CAAI,QAAa,KAAA,WAAA,IACjB,GAAI,CAAA,IAAA,KAAS,UACb,GAAI,CAAA,QAAA,CAAS,UAAW,CAAA,YAAY,CACpC,EAAA;AACA,MAAO,OAAA,IAAA;AAAA;AAET,IAAO,OAAA,KAAA;AAAA,GACT;AAAA,EAEA,MAAM,OACJ,CAAA,GAAA,EACA,OAC0C,EAAA;AAC1C,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAiD,8CAAA,EAAA,GAAG,CAAE,CAAA,CAAA;AACvE,IAAI,IAAA,QAAA;AACJ,IAAI,IAAA;AACF,MAAW,QAAA,GAAA,MAAM,MAAM,GAAK,EAAA;AAAA,QAC1B,QAAQ,OAAS,EAAA;AAAA,OAClB,CAAA;AAAA,aACM,CAAG,EAAA;AACV,MAAA,MAAM,IAAI,KAAM,CAAA,CAAA,eAAA,EAAkB,GAAG,CAAA,EAAA,EAAK,CAAC,CAAE,CAAA,CAAA;AAAA;AAG/C,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAO,OAAAC,gCAAA,CAAuB,aAAa,QAAQ,CAAA;AAAA;AAGrD,IAAM,MAAA,OAAA,GAAU,kBAAkB,GAAG,CAAA,EAAA,EAAK,SAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA,CAAA;AAChF,IAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,MAAM,MAAA,IAAIC,qBAAc,OAAO,CAAA;AAAA;AAEjC,IAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,MAAA,MAAM,IAAIC,uBAAiB,EAAA;AAAA;AAE7B,IAAM,MAAA,IAAI,MAAM,OAAO,CAAA;AAAA;AACzB,EAEA,MAAM,MACJ,CAAA,GAAA,EACA,OACyC,EAAA;AACzC,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAA,6CAAA,EAAgD,GAAG,CAAA,cAAA,EAAiB,IAAK,CAAA,SAAA;AAAA,QACvE;AAAA,OACD,CAAA;AAAA,KACH;AAEA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AA8BF,EAEA,MAAM,QACJ,CAAA,GAAA,EACA,OAC2C,EAAA;AAC3C,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAkD,+CAAA,EAAA,GAAG,CAAE,CAAA,CAAA;AACxE,IAAA,MAAM,IAAO,GAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,IAAA,MAAM,KAAK,OAAS,EAAA,IAAA;AACpB,IAAA,IAAI,CAAC,EAAI,EAAA;AACP,MAAA,OAAO,MAAM,IAAI,kDAAA;AAAA,QACf,IAAK,CAAA,OAAA;AAAA,QACL,EAAA;AAAA,QACA,KAAK,MAAO,EAAA;AAAA,QACZ,IAAK,CAAA;AAAA,OACP;AAAA;AAEF,IAAA,OAAO,MAAM,IAAI,kDAAA;AAAA,MACf,IAAK,CAAA,OAAA;AAAA,MACL,EAAA;AAAA,MACA,KAAK,MAAO,EAAA;AAAA,MACZ,IAAK,CAAA;AAAA,KACP;AAAA;AAEJ;AAOO,MAAM,gCAAgCC,qCAAqB,CAAA;AAAA,EAChE,OAAS,EAAAC,sCAAA;AAAA,EACT,IAAM,EAAA;AAAA,IACJ,QAAQC,6BAAa,CAAA;AAAA,GACvB;AAAA,EACA,MAAM,OAAA,CAAQ,EAAE,MAAA,EAAU,EAAA;AACxB,IAAA,MAAA,CACG,MAAM,EAAE,MAAA,EAAQ,kCAAkC,CAAA,CAClD,KAAK,kDAAkD,CAAA;AAE1D,IAAA,OAAO,iCAAkC,CAAA,OAAA;AAAA;AAE7C,CAAC;;;;;;;;"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@red-hat-developer-hub/backstage-plugin-catalog-techdoc-url-reader-backend",
+  "version": "0.3.0",
+  "license": "Apache-2.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/redhat-developer/rhdh-plugins",
+    "directory": "workspaces/ai-integrations/plugins/catalog-techdoc-url-reader-backend"
+  },
+  "backstage": {
+    "role": "backend-plugin",
+    "pluginId": "catalog-techdoc-url-reader-backend",
+    "pluginPackages": [
+      "@red-hat-developer-hub/backstage-plugin-catalog-techdoc-url-reader-backend"
+    ],
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-defaults": "^0.12.0",
+    "@backstage/backend-plugin-api": "^1.4.2",
+    "@backstage/catalog-client": "^1.11.0",
+    "@backstage/config": "^1.3.3",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-catalog-node": "^1.18.0",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^1.8.0",
+    "@backstage/cli": "^0.34.1",
+    "@types/express": "^4.17.6",
+    "@types/supertest": "^2.0.12",
+    "supertest": "^6.2.4",
+    "tmp": "^0.2.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}