Modify also alpha

Signed-off-by: Alex Eftimie <alex.eftimie@getyourguide.com>
This commit is contained in:
Alex Eftimie
2024-10-09 07:59:34 +02:00
parent 3b527b7ae6
commit 1c9b5545d2
2 changed files with 24 additions and 4 deletions
@@ -5,6 +5,7 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { TechDocsCollatorDocumentTransformer } from '@backstage/plugin-search-backend-module-techdocs';
import { TechDocsCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-techdocs';
// @alpha
@@ -13,6 +14,10 @@ export default _default;
// @alpha (undocumented)
export interface TechDocsCollatorEntityTransformerExtensionPoint {
// (undocumented)
setDocumentTransformer(
transformer: TechDocsCollatorDocumentTransformer,
): void;
// (undocumented)
setTransformer(transformer: TechDocsCollatorEntityTransformer): void;
}
@@ -24,6 +29,7 @@ export const techdocsCollatorEntityTransformerExtensionPoint: ExtensionPoint<Tec
//
// src/alpha.d.ts:3:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorEntityTransformerExtensionPoint".
// src/alpha.d.ts:4:5 - (ae-undocumented) Missing documentation for "setTransformer".
// src/alpha.d.ts:5:5 - (ae-undocumented) Missing documentation for "setDocumentTransformer".
// (No @packageDocumentation comment for this package)
```
@@ -28,6 +28,7 @@ import {
import { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';
import {
DefaultTechDocsCollatorFactory,
TechDocsCollatorDocumentTransformer,
TechDocsCollatorEntityTransformer,
} from '@backstage/plugin-search-backend-module-techdocs';
import { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';
@@ -35,6 +36,9 @@ import { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-back
/** @alpha */
export interface TechDocsCollatorEntityTransformerExtensionPoint {
setTransformer(transformer: TechDocsCollatorEntityTransformer): void;
setDocumentTransformer(
transformer: TechDocsCollatorDocumentTransformer,
): void;
}
/**
@@ -55,18 +59,27 @@ export default createBackendModule({
pluginId: 'search',
moduleId: 'techdocs-collator',
register(env) {
let transformer: TechDocsCollatorEntityTransformer | undefined;
let entityTransformer: TechDocsCollatorEntityTransformer | undefined;
let documentTransformer: TechDocsCollatorDocumentTransformer | undefined;
env.registerExtensionPoint(
techdocsCollatorEntityTransformerExtensionPoint,
{
setTransformer(newTransformer) {
if (transformer) {
if (entityTransformer) {
throw new Error(
'TechDocs collator entity transformer may only be set once',
);
}
transformer = newTransformer;
entityTransformer = newTransformer;
},
setDocumentTransformer(newTransformer) {
if (documentTransformer) {
throw new Error(
'TechDocs collator document transformer may only be set once',
);
}
documentTransformer = newTransformer;
},
},
);
@@ -112,7 +125,8 @@ export default createBackendModule({
httpAuth,
logger,
catalogClient: catalog,
entityTransformer: transformer,
entityTransformer,
documentTransformer,
}),
});
},