Merge pull request #20258 from backstage/camilaibs/create-techdocs-search-result-item-extension

[DI] Create `TechDocs` search result item extension

.changeset/fair-frogs-enjoy.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-techdocs': patch
+---
+
+Create an experimental `TechDocsSearchResultItemExtension` for declarative integration with Backstage; it can be accessed via the `/alpha` import.

plugins/techdocs/alpha-api-report.md

@@ -0,0 +1,23 @@
+## API Report File for "@backstage/plugin-techdocs"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { BackstagePlugin } from '@backstage/frontend-plugin-api';
+import { Extension } from '@backstage/frontend-plugin-api';
+
+// @alpha (undocumented)
+const _default: BackstagePlugin;
+export default _default;
+
+// @alpha (undocumented)
+export const TechDocsSearchResultListItemExtension: Extension<{
+  lineClamp: number;
+  noTrack: boolean;
+  asListItem: boolean;
+  asLink: boolean;
+  title?: string | undefined;
+}>;
+
+// (No @packageDocumentation comment for this package)
+```

plugins/techdocs/package.json

@@ -6,9 +6,22 @@
   "types": "src/index.ts",
   "license": "Apache-2.0",
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
+  },
+  "exports": {
+    ".": "./src/index.ts",
+    "./alpha": "./src/alpha.tsx",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "alpha": [
+        "src/alpha.tsx"
+      ],
+      "package.json": [
+        "package.json"
+      ]
+    }
   },
   "backstage": {
     "role": "frontend-plugin"
@@ -39,6 +52,7 @@
     "@backstage/core-components": "workspace:^",
     "@backstage/core-plugin-api": "workspace:^",
     "@backstage/errors": "workspace:^",
+    "@backstage/frontend-plugin-api": "workspace:^",
     "@backstage/integration": "workspace:^",
     "@backstage/integration-react": "workspace:^",
     "@backstage/plugin-catalog-react": "workspace:^",

plugins/techdocs/src/alpha.tsx

@@ -0,0 +1,51 @@
+/*
+ * 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 React from 'react';
+import {
+  createPlugin,
+  createSchemaFromZod,
+} from '@backstage/frontend-plugin-api';
+import { createSearchResultListItemExtension } from '@backstage/plugin-search-react/alpha';
+
+/** @alpha */
+export const TechDocsSearchResultListItemExtension =
+  createSearchResultListItemExtension({
+    id: 'techdocs',
+    configSchema: createSchemaFromZod(z =>
+      z.object({
+        // TODO: Define how the icon can be configurable
+        title: z.string().optional(),
+        lineClamp: z.number().default(5),
+        asLink: z.boolean().default(true),
+        asListItem: z.boolean().default(true),
+        noTrack: z.boolean().default(false),
+      }),
+    ),
+    predicate: result => result.type === 'techdocs',
+    component: async ({ config }) => {
+      const { TechDocsSearchResultListItem } = await import(
+        './search/components/TechDocsSearchResultListItem'
+      );
+      return props => <TechDocsSearchResultListItem {...props} {...config} />;
+    },
+  });
+
+/** @alpha */
+export default createPlugin({
+  id: 'techdocs',
+  extensions: [TechDocsSearchResultListItemExtension],
+});

yarn.lock

@@ -9742,6 +9742,7 @@ __metadata:
     "@backstage/core-plugin-api": "workspace:^"
     "@backstage/dev-utils": "workspace:^"
     "@backstage/errors": "workspace:^"
+    "@backstage/frontend-plugin-api": "workspace:^"
     "@backstage/integration": "workspace:^"
     "@backstage/integration-react": "workspace:^"
     "@backstage/plugin-catalog-react": "workspace:^"