@stackoverflow/backstage-stack-overflow-teams-collator 1.5.0 → 1.6.3

package/README.md

@@ -1,7 +1,7 @@
 
-# Stack Overflow for Teams Search Backend Module
+# Stack Internal Search Backend Module
 
-This module for the search plugin is an enhanced version of the original [Stack Overflow collator](https://github.com/backstage/backstage/tree/master/plugins/search-backend-module-stack-overflow-collator). It provides additional information while coded to work specifically with Stack Overflow for Teams API Version 3.
+This module for the search plugin is an enhanced version of the original [Stack Overflow Internal collator](https://github.com/backstage/backstage/tree/master/plugins/search-backend-module-stack-overflow-collator). It provides additional information while coded to work specifically with Stack Internal API Version 3.
 
 ## Getting started
 
@@ -13,24 +13,24 @@ To use any of the functionality this plugin provides, you need to start by confi
 
 ```yaml
 stackoverflow:
-  baseUrl: https://api.stackoverflowteams.com # alternative: your Stack Overflow Enterprise site
+  baseUrl: https://api.stackoverflowteams.com # alternative: your Stack Internal Enterprise site
   teamName: $STACK_OVERFLOW_TEAM_NAME # optional if you are on Enterprise
   apiAccessToken: $STACK_OVERFLOW_API_ACCESS_TOKEN
 ```
 
-### Stack Overflow for Teams
+### Stack Internal
 
-If you have a private Stack Overflow instance and/or a private Stack Overflow Team you will need to supply a Personal Access Token. You can read more about how to set this up by going to [Stack Overflow's Help Page](https://stackoverflowteams.help/en/articles/7913768-stack-overflow-for-teams-api-v3).
+If you have a private Stack Overflow Internal instance and/or a private Stack Overflow Internal Team you will need to supply a Personal Access Token. You can read more about how to set this up by going to [Stack Overflow Internal's Help Page](https://stackoverflowteams.help/en/articles/7913768-stack-overflow-for-teams-api-v3).
 
 ## Areas of Responsibility
 
-This stack overflow backend plugin is primarily responsible for the following:
+This Stack Overflow Internal backend plugin is primarily responsible for the following:
 
-- Provides a `StackOverflowQuestionsCollatorFactory`, which can be used in the search backend to index stack overflow questions to your Backstage Search.
+- Provides a `StackOverflowQuestionsCollatorFactory`, which can be used in the search backend to index Stack Overflow Internal questions to your Backstage Search.
 
-### Index Stack Overflow Questions to search
+### Index Stack Overflow Internal Questions to search
 
-Before you are able to start index stack overflow questions to search, you need to go through the [search getting started guide](https://backstage.io/docs/features/search/getting-started).
+Before you are able to start index Stack Overflow Internal questions to search, you need to go through the [search getting started guide](https://backstage.io/docs/features/search/getting-started).
 
 When you have your `packages/backend/src/plugins/search.ts` file ready to make modifications, add the following code snippet to add the `StackOverflowQuestionsCollatorFactory`. Note that you can optionally modify the `requestParams`, otherwise it will defaults to `{ order: 'desc', sort: 'activity' }`.
 
@@ -49,7 +49,7 @@ indexBuilder.addCollator({
 
 ## New Backend System
 
-This package exports a module that extends the search backend to also indexing the questions exposed by the [`Stack Overflow for Teams API version 3`](https://stackoverflowteams.help/en/articles/7913768-stack-overflow-for-teams-api-v3).
+This package exports a module that extends the search backend to also indexing the questions exposed by the [`Stack Internal API version 3`](https://stackoverflowteams.help/en/articles/7913768-stack-overflow-for-teams-api-v3).
 
 ### Installation
 

package/config.d.ts

@@ -16,22 +16,22 @@
 
 export interface Config {
     /**
-     * Configuration options for the stack overflow plugin
+     * Configuration options for the Stack Overflow Internal plugin
      */
     stackoverflow?: {
       /**
-       * The base url of the Stack Overflow API used for the plugin, if no BaseUrl is provided it will default to https://api.stackoverflowteams.com
+       * The base url of the Stack Overflow Internal API used for the plugin, if no BaseUrl is provided it will default to https://api.stackoverflowteams.com
        */
       baseUrl?: string;
   
       /**
-       * The API Access Token to authenticate to Stack Overflow API Version 3
+       * The API Access Token to authenticate to Stack Overflow Internal API Version 3
        * @visibility secret
        */
       apiAccessToken: string;
   
       /**
-       * The name of the team for a Stack Overflow for Teams account. When teamName is provided baseUrl will always be https://api.stackoverflowteams.com
+       * The name of the team for a Stack Internal account. When teamName is provided baseUrl will always be https://api.stackoverflowteams.com
        */
       teamName?: string;
   

package/dist/collators/StackOverflowQuestionsCollatorFactory.cjs.js

@@ -0,0 +1,118 @@
+'use strict';
+
+var stream = require('stream');
+var qs = require('qs');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var qs__default = /*#__PURE__*/_interopDefaultCompat(qs);
+
+class StackOverflowQuestionsCollatorFactory {
+  requestParams;
+  baseUrl;
+  apiAccessToken;
+  teamName;
+  logger;
+  referrer = "Backstage_Plugin";
+  type = "stack-overflow";
+  stackOverflowTeamsAPI = "https://api.stackoverflowteams.com";
+  forceOriginUrl = (baseUrl) => `${new URL(baseUrl).origin}`;
+  constructor(options) {
+    this.baseUrl = this.forceOriginUrl(options.baseUrl || this.stackOverflowTeamsAPI);
+    this.apiAccessToken = options.apiAccessToken;
+    this.teamName = options.teamName;
+    this.logger = options.logger.child({ documentType: this.type });
+    this.requestParams = {
+      order: "desc",
+      sort: "creation",
+      ...options.requestParams ?? {}
+    };
+  }
+  static fromConfig(config, options) {
+    const apiAccessToken = config.getString("stackoverflow.apiAccessToken");
+    const teamName = config.getOptionalString("stackoverflow.teamName");
+    const baseUrl = config.getOptionalString("stackoverflow.baseUrl");
+    const requestParams = config.getOptionalConfig("stackoverflow.requestParams")?.get();
+    return new StackOverflowQuestionsCollatorFactory({
+      baseUrl,
+      apiAccessToken,
+      teamName,
+      requestParams,
+      ...options
+    });
+  }
+  async getCollator() {
+    return stream.Readable.from(this.execute());
+  }
+  // Error logging and debugging
+  async *execute() {
+    this.logger.info(`Retrieving data using Stack Overflow Internal API Version 3`);
+    if (!this.baseUrl && this.teamName) {
+      this.logger.info(
+        `Connecting to the Teams API at https://api.stackoverflowteams.com`
+      );
+    }
+    if (!this.baseUrl && !this.teamName) {
+      this.logger.error(
+        `No stackoverflow.teamName has been provided while trying to connect to the Teams API.`
+      );
+    }
+    const params = qs__default.default.stringify(this.requestParams, {
+      arrayFormat: "comma",
+      addQueryPrefix: true
+    });
+    let requestUrl;
+    if (this.teamName) {
+      requestUrl = `${this.stackOverflowTeamsAPI}/v3/teams/${this.teamName}/questions${params}`;
+    } else {
+      requestUrl = `${this.baseUrl}/api/v3/questions${params}`;
+    }
+    let page = 1;
+    let totalPages = 1;
+    const pageSize = this.requestParams.pageSize || 50;
+    this.logger.warn(
+      "Starting collating Stack Internal questions, wait for the success message"
+    );
+    while (page <= totalPages) {
+      const res = await fetch(
+        `${requestUrl}&page=${page}&pageSize=${pageSize}`,
+        {
+          headers: {
+            Authorization: `Bearer ${this.apiAccessToken}`
+          }
+        }
+      );
+      const data = await res.json();
+      totalPages = data.totalPages;
+      for (const question of data.items ?? []) {
+        const tags = question.tags?.map((tag) => ({
+          id: tag.id,
+          description: tag.description,
+          location: tag.webUrl,
+          name: tag.name
+        })) || [];
+        yield {
+          title: question.title,
+          location: `${question.webUrl}?r=${this.referrer}`,
+          text: question.owner?.name || "Deleted user",
+          userReputation: question.owner?.reputation,
+          avatar: question.owner?.avatarUrl,
+          userProfile: question.owner?.webUrl,
+          userRole: question.owner?.role,
+          tags,
+          answers: question.answerCount,
+          score: question.score,
+          viewCount: question.viewCount,
+          isAnswered: question.isAnswered,
+          bounty: question.bounty,
+          creationDate: question.creationDate,
+          lastActivityDate: question.lastActivityDate
+        };
+      }
+      page++;
+    }
+  }
+}
+
+exports.StackOverflowQuestionsCollatorFactory = StackOverflowQuestionsCollatorFactory;
+//# sourceMappingURL=StackOverflowQuestionsCollatorFactory.cjs.js.map

package/dist/collators/StackOverflowQuestionsCollatorFactory.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StackOverflowQuestionsCollatorFactory.cjs.js","sources":["../../src/collators/StackOverflowQuestionsCollatorFactory.ts"],"sourcesContent":["/*\n * This component is a modified version of https://github.com/backstage/backstage/blob/master/plugins/search-backend-module-stack-overflow-collator/src/collators/StackOverflowQuestionsCollatorFactory.ts \n *\n * Copyright 2023 The Backstage Authors\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  DocumentCollatorFactory,\n  IndexableDocument,\n} from '@backstage/plugin-search-common';\nimport { Config } from '@backstage/config';\nimport { Readable } from 'stream';\n\nimport qs from 'qs';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { Tag } from '../types';\n\n/**\n * Extended IndexableDocument with stack overflow specific properties\n *\n * @public\n */\nexport interface StackOverflowDocument extends IndexableDocument {\n  answers: number;\n  userReputation: number;\n  avatar: string;\n  userProfile: string;\n  userRole: string;\n  tags: object[];\n  score: number;\n  viewCount: number;\n  isAnswered: boolean;\n  bounty: {} | null;\n  creationDate: string;\n  lastActivityDate: string;\n}\n\n/**\n * Type representing the request parameters accepted by the {@link StackOverflowQuestionsCollatorFactory}\n *\n * @public\n */\nexport type StackOverflowQuestionsRequestParams = {\n  [key: string]: string | string[] | number;\n};\n\n/**\n * Options for {@link StackOverflowQuestionsCollatorFactory}\n *\n * @public\n */\nexport type StackOverflowQuestionsCollatorFactoryOptions = {\n  apiAccessToken?: string;\n  teamName?: string;\n  requestParams?: StackOverflowQuestionsRequestParams;\n  logger: LoggerService;\n};\n\n/**\n * Search collator responsible for collecting stack overflow questions to index.\n *\n * @public\n */\nexport class StackOverflowQuestionsCollatorFactory\n  implements DocumentCollatorFactory\n{\n  protected requestParams: StackOverflowQuestionsRequestParams;\n  private readonly baseUrl: string;\n  private readonly apiAccessToken: string | undefined;\n  private readonly teamName: string | undefined;\n  private readonly logger: LoggerService;\n  private readonly referrer: string = 'Backstage_Plugin';\n  public readonly type: string = 'stack-overflow';\n  public readonly stackOverflowTeamsAPI: string =\n    'https://api.stackoverflowteams.com';\n\n  private forceOriginUrl = (baseUrl: string): string =>\n    `${new URL(baseUrl).origin}`;\n\n  private constructor(options: StackOverflowQuestionsCollatorFactoryOptions & { baseUrl?: string }) {\n    this.baseUrl = this.forceOriginUrl(options.baseUrl || this.stackOverflowTeamsAPI);\n    this.apiAccessToken = options.apiAccessToken;\n    this.teamName = options.teamName;\n    this.logger = options.logger.child({ documentType: this.type });\n\n    // Sets the same default request parameters as the official API documentation\n    // See https://api.stackexchange.com/docs/questions\n    this.requestParams = {\n      order: 'desc',\n      sort: 'creation',\n      ...(options.requestParams ?? {}),\n    };\n  }\n\n  static fromConfig(\n    config: Config,\n    options: StackOverflowQuestionsCollatorFactoryOptions,\n  ) {\n    const apiAccessToken = config.getString('stackoverflow.apiAccessToken');\n    const teamName = config.getOptionalString('stackoverflow.teamName');\n    const baseUrl = config.getOptionalString('stackoverflow.baseUrl');\n    const requestParams = config\n      .getOptionalConfig('stackoverflow.requestParams')\n      ?.get<StackOverflowQuestionsRequestParams>();\n\n    return new StackOverflowQuestionsCollatorFactory({\n      baseUrl,\n      apiAccessToken,\n      teamName,\n      requestParams,\n      ...options,\n    });\n  }\n\n  async getCollator() {\n    return Readable.from(this.execute());\n  }\n\n  // Error logging and debugging\n\n  async *execute(): AsyncGenerator<StackOverflowDocument> {\n    this.logger.info(`Retrieving data using Stack Overflow Internal API Version 3`);\n\n    if (!this.baseUrl && this.teamName) {\n      this.logger.info(\n        `Connecting to the Teams API at https://api.stackoverflowteams.com`,\n      );\n    }\n\n    if (!this.baseUrl && !this.teamName) {\n      this.logger.error(\n        `No stackoverflow.teamName has been provided while trying to connect to the Teams API.`\n      )\n    }\n\n    const params = qs.stringify(this.requestParams, {\n      arrayFormat: 'comma',\n      addQueryPrefix: true,\n    });\n\n    let requestUrl;\n\n    if (this.teamName) {\n      requestUrl = `${this.stackOverflowTeamsAPI}/v3/teams/${this.teamName}/questions${params}`;\n    } else {\n      requestUrl = `${this.baseUrl}/api/v3/questions${params}`;\n    }\n\n    // The code below has been commented, it has potential compatiblity with Enterprise Private Teams but I haven't tested it and since Private Teams is not widely used I've decided to change the logic to prioritise the support for the Basic and Business Teams.\n\n    // if (this.teamName) {\n    //   const basePath =\n    //     this.baseUrl === this.stackOverflowTeamsAPI ? '/v3' : '/api/v3';\n    //   requestUrl = `${this.baseUrl}${basePath}/teams/${this.teamName}/questions${params}`;\n    // } else {\n    //   requestUrl = `${this.baseUrl}/api/v3/questions${params}`;\n    // }\n\n    let page = 1;\n    let totalPages = 1;\n    const pageSize = this.requestParams.pageSize || 50;\n    this.logger.warn(\n      'Starting collating Stack Internal questions, wait for the success message',\n    );\n    while (page <= totalPages) {\n      const res = await fetch(\n        `${requestUrl}&page=${page}&pageSize=${pageSize}`,\n        {\n          headers: {\n            Authorization: `Bearer ${this.apiAccessToken}`,\n          },\n        },\n      );\n\n      const data = await res.json();\n      totalPages = data.totalPages;\n\n      for (const question of data.items ?? []) {\n        const tags =\n          question.tags?.map((tag: Tag) => ({\n            id: tag.id,\n            description: tag.description,\n            location: tag.webUrl,\n            name: tag.name,\n          })) || [];\n\n        yield {\n          title: question.title,\n          location: `${question.webUrl}?r=${this.referrer}`,\n          text: question.owner?.name || 'Deleted user',\n          userReputation: question.owner?.reputation,\n          avatar: question.owner?.avatarUrl,\n          userProfile: question.owner?.webUrl,\n          userRole: question.owner?.role,\n          tags: tags,\n          answers: question.answerCount,\n          score: question.score,\n          viewCount: question.viewCount,\n          isAnswered: question.isAnswered,\n          bounty: question.bounty,\n          creationDate: question.creationDate,\n          lastActivityDate: question.lastActivityDate,\n        };\n      }\n      page++;\n    }\n  }\n}\n"],"names":["Readable","qs"],"mappings":";;;;;;;;;AA2EO,MAAM,qCAAA,CAEb;AAAA,EACY,aAAA;AAAA,EACO,OAAA;AAAA,EACA,cAAA;AAAA,EACA,QAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA,GAAmB,kBAAA;AAAA,EACpB,IAAA,GAAe,gBAAA;AAAA,EACf,qBAAA,GACd,oCAAA;AAAA,EAEM,cAAA,GAAiB,CAAC,OAAA,KACxB,CAAA,EAAG,IAAI,GAAA,CAAI,OAAO,EAAE,MAAM,CAAA,CAAA;AAAA,EAEpB,YAAY,OAAA,EAA8E;AAChG,IAAA,IAAA,CAAK,UAAU,IAAA,CAAK,cAAA,CAAe,OAAA,CAAQ,OAAA,IAAW,KAAK,qBAAqB,CAAA;AAChF,IAAA,IAAA,CAAK,iBAAiB,OAAA,CAAQ,cAAA;AAC9B,IAAA,IAAA,CAAK,WAAW,OAAA,CAAQ,QAAA;AACxB,IAAA,IAAA,CAAK,MAAA,GAAS,QAAQ,MAAA,CAAO,KAAA,CAAM,EAAE,YAAA,EAAc,IAAA,CAAK,MAAM,CAAA;AAI9D,IAAA,IAAA,CAAK,aAAA,GAAgB;AAAA,MACnB,KAAA,EAAO,MAAA;AAAA,MACP,IAAA,EAAM,UAAA;AAAA,MACN,GAAI,OAAA,CAAQ,aAAA,IAAiB;AAAC,KAChC;AAAA,EACF;AAAA,EAEA,OAAO,UAAA,CACL,MAAA,EACA,OAAA,EACA;AACA,IAAA,MAAM,cAAA,GAAiB,MAAA,CAAO,SAAA,CAAU,8BAA8B,CAAA;AACtE,IAAA,MAAM,QAAA,GAAW,MAAA,CAAO,iBAAA,CAAkB,wBAAwB,CAAA;AAClE,IAAA,MAAM,OAAA,GAAU,MAAA,CAAO,iBAAA,CAAkB,uBAAuB,CAAA;AAChE,IAAA,MAAM,aAAA,GAAgB,MAAA,CACnB,iBAAA,CAAkB,6BAA6B,GAC9C,GAAA,EAAyC;AAE7C,IAAA,OAAO,IAAI,qCAAA,CAAsC;AAAA,MAC/C,OAAA;AAAA,MACA,cAAA;AAAA,MACA,QAAA;AAAA,MACA,aAAA;AAAA,MACA,GAAG;AAAA,KACJ,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,WAAA,GAAc;AAClB,IAAA,OAAOA,eAAA,CAAS,IAAA,CAAK,IAAA,CAAK,OAAA,EAAS,CAAA;AAAA,EACrC;AAAA;AAAA,EAIA,OAAO,OAAA,GAAiD;AACtD,IAAA,IAAA,CAAK,MAAA,CAAO,KAAK,CAAA,2DAAA,CAA6D,CAAA;AAE9E,IAAA,IAAI,CAAC,IAAA,CAAK,OAAA,IAAW,IAAA,CAAK,QAAA,EAAU;AAClC,MAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,QACV,CAAA,iEAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,IAAA,CAAK,OAAA,IAAW,CAAC,KAAK,QAAA,EAAU;AACnC,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA;AAAA,QACV,CAAA,qFAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,MAAA,GAASC,mBAAA,CAAG,SAAA,CAAU,IAAA,CAAK,aAAA,EAAe;AAAA,MAC9C,WAAA,EAAa,OAAA;AAAA,MACb,cAAA,EAAgB;AAAA,KACjB,CAAA;AAED,IAAA,IAAI,UAAA;AAEJ,IAAA,IAAI,KAAK,QAAA,EAAU;AACjB,MAAA,UAAA,GAAa,GAAG,IAAA,CAAK,qBAAqB,aAAa,IAAA,CAAK,QAAQ,aAAa,MAAM,CAAA,CAAA;AAAA,IACzF,CAAA,MAAO;AACL,MAAA,UAAA,GAAa,CAAA,EAAG,IAAA,CAAK,OAAO,CAAA,iBAAA,EAAoB,MAAM,CAAA,CAAA;AAAA,IACxD;AAYA,IAAA,IAAI,IAAA,GAAO,CAAA;AACX,IAAA,IAAI,UAAA,GAAa,CAAA;AACjB,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,aAAA,CAAc,QAAA,IAAY,EAAA;AAChD,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,MACV;AAAA,KACF;AACA,IAAA,OAAO,QAAQ,UAAA,EAAY;AACzB,MAAA,MAAM,MAAM,MAAM,KAAA;AAAA,QAChB,CAAA,EAAG,UAAU,CAAA,MAAA,EAAS,IAAI,aAAa,QAAQ,CAAA,CAAA;AAAA,QAC/C;AAAA,UACE,OAAA,EAAS;AAAA,YACP,aAAA,EAAe,CAAA,OAAA,EAAU,IAAA,CAAK,cAAc,CAAA;AAAA;AAC9C;AACF,OACF;AAEA,MAAA,MAAM,IAAA,GAAO,MAAM,GAAA,CAAI,IAAA,EAAK;AAC5B,MAAA,UAAA,GAAa,IAAA,CAAK,UAAA;AAElB,MAAA,KAAA,MAAW,QAAA,IAAY,IAAA,CAAK,KAAA,IAAS,EAAC,EAAG;AACvC,QAAA,MAAM,IAAA,GACJ,QAAA,CAAS,IAAA,EAAM,GAAA,CAAI,CAAC,GAAA,MAAc;AAAA,UAChC,IAAI,GAAA,CAAI,EAAA;AAAA,UACR,aAAa,GAAA,CAAI,WAAA;AAAA,UACjB,UAAU,GAAA,CAAI,MAAA;AAAA,UACd,MAAM,GAAA,CAAI;AAAA,SACZ,CAAE,KAAK,EAAC;AAEV,QAAA,MAAM;AAAA,UACJ,OAAO,QAAA,CAAS,KAAA;AAAA,UAChB,UAAU,CAAA,EAAG,QAAA,CAAS,MAAM,CAAA,GAAA,EAAM,KAAK,QAAQ,CAAA,CAAA;AAAA,UAC/C,IAAA,EAAM,QAAA,CAAS,KAAA,EAAO,IAAA,IAAQ,cAAA;AAAA,UAC9B,cAAA,EAAgB,SAAS,KAAA,EAAO,UAAA;AAAA,UAChC,MAAA,EAAQ,SAAS,KAAA,EAAO,SAAA;AAAA,UACxB,WAAA,EAAa,SAAS,KAAA,EAAO,MAAA;AAAA,UAC7B,QAAA,EAAU,SAAS,KAAA,EAAO,IAAA;AAAA,UAC1B,IAAA;AAAA,UACA,SAAS,QAAA,CAAS,WAAA;AAAA,UAClB,OAAO,QAAA,CAAS,KAAA;AAAA,UAChB,WAAW,QAAA,CAAS,SAAA;AAAA,UACpB,YAAY,QAAA,CAAS,UAAA;AAAA,UACrB,QAAQ,QAAA,CAAS,MAAA;AAAA,UACjB,cAAc,QAAA,CAAS,YAAA;AAAA,UACvB,kBAAkB,QAAA,CAAS;AAAA,SAC7B;AAAA,MACF;AACA,MAAA,IAAA,EAAA;AAAA,IACF;AAAA,EACF;AACF;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var StackOverflowQuestionsCollatorFactory = require('./collators/StackOverflowQuestionsCollatorFactory.cjs.js');
+var SearchStackOverflowCollatorModule = require('./module/SearchStackOverflowCollatorModule.cjs.js');
+
+
+
+exports.StackOverflowQuestionsCollatorFactory = StackOverflowQuestionsCollatorFactory.StackOverflowQuestionsCollatorFactory;
+exports.default = SearchStackOverflowCollatorModule.searchStackOverflowCollatorModule;
+//# 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,73 @@
+import { IndexableDocument, DocumentCollatorFactory } from '@backstage/plugin-search-common';
+import { Config } from '@backstage/config';
+import { Readable } from 'stream';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { LoggerService } from '@backstage/backend-plugin-api';
+
+/**
+ * Extended IndexableDocument with stack overflow specific properties
+ *
+ * @public
+ */
+interface StackOverflowDocument extends IndexableDocument {
+    answers: number;
+    userReputation: number;
+    avatar: string;
+    userProfile: string;
+    userRole: string;
+    tags: object[];
+    score: number;
+    viewCount: number;
+    isAnswered: boolean;
+    bounty: {} | null;
+    creationDate: string;
+    lastActivityDate: string;
+}
+/**
+ * Type representing the request parameters accepted by the {@link StackOverflowQuestionsCollatorFactory}
+ *
+ * @public
+ */
+type StackOverflowQuestionsRequestParams = {
+    [key: string]: string | string[] | number;
+};
+/**
+ * Options for {@link StackOverflowQuestionsCollatorFactory}
+ *
+ * @public
+ */
+type StackOverflowQuestionsCollatorFactoryOptions = {
+    apiAccessToken?: string;
+    teamName?: string;
+    requestParams?: StackOverflowQuestionsRequestParams;
+    logger: LoggerService;
+};
+/**
+ * Search collator responsible for collecting stack overflow questions to index.
+ *
+ * @public
+ */
+declare class StackOverflowQuestionsCollatorFactory implements DocumentCollatorFactory {
+    protected requestParams: StackOverflowQuestionsRequestParams;
+    private readonly baseUrl;
+    private readonly apiAccessToken;
+    private readonly teamName;
+    private readonly logger;
+    private readonly referrer;
+    readonly type: string;
+    readonly stackOverflowTeamsAPI: string;
+    private forceOriginUrl;
+    private constructor();
+    static fromConfig(config: Config, options: StackOverflowQuestionsCollatorFactoryOptions): StackOverflowQuestionsCollatorFactory;
+    getCollator(): Promise<Readable>;
+    execute(): AsyncGenerator<StackOverflowDocument>;
+}
+
+/**
+ * @public
+ * Search backend module for the Stack Overflow Internal index.
+ */
+declare const searchStackOverflowCollatorModule: _backstage_backend_plugin_api.BackendFeature;
+
+export { StackOverflowQuestionsCollatorFactory, searchStackOverflowCollatorModule as default };
+export type { StackOverflowDocument, StackOverflowQuestionsCollatorFactoryOptions, StackOverflowQuestionsRequestParams };

package/dist/module/SearchStackOverflowCollatorModule.cjs.js

@@ -0,0 +1,40 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-search-backend-node/alpha');
+var StackOverflowQuestionsCollatorFactory = require('../collators/StackOverflowQuestionsCollatorFactory.cjs.js');
+
+const searchStackOverflowCollatorModule = backendPluginApi.createBackendModule({
+  pluginId: "search",
+  moduleId: "stack-overflow-collator",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger,
+        discovery: backendPluginApi.coreServices.discovery,
+        scheduler: backendPluginApi.coreServices.scheduler,
+        indexRegistry: alpha.searchIndexRegistryExtensionPoint
+      },
+      async init({ config, logger, scheduler, indexRegistry }) {
+        const defaultSchedule = {
+          frequency: { minutes: 10 },
+          timeout: { minutes: 15 },
+          initialDelay: { seconds: 3 }
+        };
+        const schedule = config.has("stackoverflow.schedule") ? backendPluginApi.readSchedulerServiceTaskScheduleDefinitionFromConfig(
+          config.getConfig("stackoverflow.schedule")
+        ) : defaultSchedule;
+        indexRegistry.addCollator({
+          schedule: scheduler.createScheduledTaskRunner(schedule),
+          factory: StackOverflowQuestionsCollatorFactory.StackOverflowQuestionsCollatorFactory.fromConfig(config, {
+            logger
+          })
+        });
+      }
+    });
+  }
+});
+
+exports.searchStackOverflowCollatorModule = searchStackOverflowCollatorModule;
+//# sourceMappingURL=SearchStackOverflowCollatorModule.cjs.js.map

package/dist/module/SearchStackOverflowCollatorModule.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchStackOverflowCollatorModule.cjs.js","sources":["../../src/module/SearchStackOverflowCollatorModule.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\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 { readSchedulerServiceTaskScheduleDefinitionFromConfig } from '@backstage/backend-plugin-api';\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { StackOverflowQuestionsCollatorFactory } from '../collators';\n\n/**\n * @public\n * Search backend module for the Stack Overflow Internal index.\n */\nexport const searchStackOverflowCollatorModule = createBackendModule({\n  pluginId: 'search',\n  moduleId: 'stack-overflow-collator',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        discovery: coreServices.discovery,\n        scheduler: coreServices.scheduler,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n      },\n      async init({ config, logger, scheduler, indexRegistry }) {\n        const defaultSchedule = {\n          frequency: { minutes: 10 },\n          timeout: { minutes: 15 },\n          initialDelay: { seconds: 3 },\n        };\n\n        const schedule = config.has('stackoverflow.schedule')\n          ? readSchedulerServiceTaskScheduleDefinitionFromConfig(\n              config.getConfig('stackoverflow.schedule'),\n            )\n          : defaultSchedule;\n\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(schedule),\n          factory: StackOverflowQuestionsCollatorFactory.fromConfig(config, {\n            logger,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","coreServices","searchIndexRegistryExtensionPoint","readSchedulerServiceTaskScheduleDefinitionFromConfig","StackOverflowQuestionsCollatorFactory"],"mappings":";;;;;;AA4BO,MAAM,oCAAoCA,oCAAA,CAAoB;AAAA,EACnE,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,EAAU,yBAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,QAAQC,6BAAA,CAAa,UAAA;AAAA,QACrB,QAAQA,6BAAA,CAAa,MAAA;AAAA,QACrB,WAAWA,6BAAA,CAAa,SAAA;AAAA,QACxB,WAAWA,6BAAA,CAAa,SAAA;AAAA,QACxB,aAAA,EAAeC;AAAA,OACjB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,QAAQ,MAAA,EAAQ,SAAA,EAAW,eAAc,EAAG;AACvD,QAAA,MAAM,eAAA,GAAkB;AAAA,UACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAA,EAAG;AAAA,UACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAA,EAAG;AAAA,UACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAA;AAAE,SAC7B;AAEA,QAAA,MAAM,QAAA,GAAW,MAAA,CAAO,GAAA,CAAI,wBAAwB,CAAA,GAChDC,qEAAA;AAAA,UACE,MAAA,CAAO,UAAU,wBAAwB;AAAA,SAC3C,GACA,eAAA;AAEJ,QAAA,aAAA,CAAc,WAAA,CAAY;AAAA,UACxB,QAAA,EAAU,SAAA,CAAU,yBAAA,CAA0B,QAAQ,CAAA;AAAA,UACtD,OAAA,EAASC,2EAAA,CAAsC,UAAA,CAAW,MAAA,EAAQ;AAAA,YAChE;AAAA,WACD;AAAA,SACF,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@stackoverflow/backstage-stack-overflow-teams-collator",
-  "version": "1.5.0",
-  "description": "A module for the search backend that exports stack overflow for teams modules",
+  "version": "1.6.3",
+  "description": "A module for the search backend that exports Stack Internal modules",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "search",
-    "pluginPackage": "@backstage/plugin-search-backend"
+    "pluginPackage": "@backstage/plugin-search-backend",
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
   },
-  "main": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
   },
   "repository": {
     "type": "git",
@@ -47,5 +48,12 @@
     "@backstage/cli": "^0.34.4",
     "msw": "^1.2.1",
     "typescript": "^5.8.2"
+  },
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
   }
 }