use alpha exports

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
Co-authored-by: Camila Loiola <camilaibs@gmail.com>

plugins/search-backend-node/package.json

@@ -6,9 +6,22 @@
   "types": "src/index.ts",
   "license": "Apache-2.0",
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
+  },
+  "exports": {
+    ".": "./src/index.ts",
+    "./alpha": "./src/alpha.ts",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "alpha": [
+        "src/alpha.ts"
+      ],
+      "package.json": [
+        "package.json"
+      ]
+    }
   },
   "backstage": {
     "role": "node-library"

plugins/search-backend-node/src/alpha.ts

@@ -15,19 +15,42 @@
  */
 
 import { Logger } from 'winston';
+
 import {
   createServiceRef,
   createServiceFactory,
   coreServices,
 } from '@backstage/backend-plugin-api';
-import { DocumentTypeInfo } from '@backstage/plugin-search-common';
+import { loggerToWinstonLogger } from '@backstage/backend-common';
+import {
+  DocumentTypeInfo,
+  SearchEngine,
+} from '@backstage/plugin-search-common';
+import { createExtensionPoint } from '@backstage/backend-plugin-api';
+
+import {
+  RegisterCollatorParameters,
+  RegisterDecoratorParameters,
+} from './types';
+
 import { IndexBuilder } from './IndexBuilder';
 import { Scheduler } from './Scheduler';
-import {
-  IndexBuilderServiceBuildOptions,
-  SearchIndexBuilderService,
-} from './types';
-import { loggerToWinstonLogger } from '@backstage/backend-common';
+
+export interface SearchIndexBuilderService {
+  build(options: IndexBuilderServiceBuildOptions): Promise<{
+    scheduler: Scheduler;
+  }>;
+  getDocumentTypes(): Record<string, DocumentTypeInfo>;
+}
+
+export interface SearchIndexRegistryExtensionPoint {
+  addCollator(options: RegisterCollatorParameters): void;
+  addDecorator(options: RegisterDecoratorParameters): void;
+}
+
+export interface SearchEngineRegistryExtensionPoint {
+  setSearchEngine(searchEngine: SearchEngine): void;
+}
 
 type DefaultSearchIndexBuilderServiceOptions = {
   logger: Logger;
@@ -85,3 +108,19 @@ export const searchIndexBuilderService =
         },
       }),
   });
+
+export const searchEngineRegistryExtensionPoint =
+  createExtensionPoint<SearchEngineRegistryExtensionPoint>({
+    id: 'search.engine.registry',
+  });
+
+export const searchIndexRegistryExtensionPoint =
+  createExtensionPoint<SearchIndexRegistryExtensionPoint>({
+    id: 'search.index.registry',
+  });
+
+export type IndexBuilderServiceBuildOptions = {
+  searchEngine: SearchEngine;
+  collators: RegisterCollatorParameters[];
+  decorators: RegisterDecoratorParameters[];
+};

plugins/search-backend-node/src/engines/LunrSearchEngine.ts

@@ -30,7 +30,7 @@ import {
   coreServices,
   createBackendModule,
 } from '@backstage/backend-plugin-api';
-import { searchEngineRegistryExtensionPoint } from '../extensions';
+import { searchEngineRegistryExtensionPoint } from '../alpha';
 import { loggerToWinstonLogger } from '@backstage/backend-common';
 
 /**

plugins/search-backend-node/src/extensions.ts

@@ -1,31 +0,0 @@
-/*
- * Copyright 2023 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { createExtensionPoint } from '@backstage/backend-plugin-api';
-import {
-  SearchEngineRegistryExtensionPoint,
-  SearchIndexRegistryExtensionPoint,
-} from './types';
-
-export const searchEngineRegistryExtensionPoint =
-  createExtensionPoint<SearchEngineRegistryExtensionPoint>({
-    id: 'search.engine.registry',
-  });
-
-export const searchIndexRegistryExtensionPoint =
-  createExtensionPoint<SearchIndexRegistryExtensionPoint>({
-    id: 'search.index.registry',
-  });

plugins/search-backend-node/src/index.ts

@@ -33,15 +33,9 @@ export type {
   IndexBuilderOptions,
   RegisterCollatorParameters,
   RegisterDecoratorParameters,
-  SearchIndexRegistryExtensionPoint,
-  SearchEngineRegistryExtensionPoint,
 } from './types';
 export * from './errors';
 export * from './indexing';
 export * from './test-utils';
 
 export type { ScheduleTaskParameters } from './Scheduler';
-
-// TODO: export as alfa subpath
-export * from './services';
-export * from './extensions';

plugins/search-backend-node/src/types.ts

@@ -18,11 +18,9 @@ import { TaskRunner } from '@backstage/backend-tasks';
 import {
   DocumentCollatorFactory,
   DocumentDecoratorFactory,
-  DocumentTypeInfo,
   SearchEngine,
 } from '@backstage/plugin-search-common';
 import { Logger } from 'winston';
-import { Scheduler } from './Scheduler';
 
 /**
  * Options required to instantiate the index builder.
@@ -59,24 +57,3 @@ export interface RegisterDecoratorParameters {
    */
   factory: DocumentDecoratorFactory;
 }
-
-export type IndexBuilderServiceBuildOptions = {
-  searchEngine: SearchEngine;
-  collators: RegisterCollatorParameters[];
-  decorators: RegisterDecoratorParameters[];
-};
-export interface SearchIndexBuilderService {
-  build(options: IndexBuilderServiceBuildOptions): Promise<{
-    scheduler: Scheduler;
-  }>;
-  getDocumentTypes(): Record<string, DocumentTypeInfo>;
-}
-
-export interface SearchIndexRegistryExtensionPoint {
-  addCollator(options: RegisterCollatorParameters): void;
-  addDecorator(options: RegisterDecoratorParameters): void;
-}
-
-export interface SearchEngineRegistryExtensionPoint {
-  setSearchEngine(searchEngine: SearchEngine): void;
-}