@backstage/plugin-techdocs 0.0.0-nightly-20231213021616 → 0.0.0-nightly-20231215021624

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,23 +1,24 @@
1
1
  # @backstage/plugin-techdocs
2
2
 
3
- ## 0.0.0-nightly-20231213021616
3
+ ## 0.0.0-nightly-20231215021624
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - 03d0b6d: The `convertLegacyRouteRef` utility used by the alpha exports is now imported from `@backstage/core-compat-api`.
8
8
  - a1227cc: Wrap `/alpha` export extension elements in backwards compatibility wrapper.
9
+ - 5814122: Updated `/alpha` exports to fit new naming patterns.
9
10
  - 36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.
10
11
  - Updated dependencies
11
- - @backstage/core-compat-api@0.0.0-nightly-20231213021616
12
- - @backstage/core-plugin-api@0.0.0-nightly-20231213021616
13
- - @backstage/frontend-plugin-api@0.0.0-nightly-20231213021616
14
- - @backstage/plugin-catalog-react@0.0.0-nightly-20231213021616
15
- - @backstage/core-components@0.0.0-nightly-20231213021616
16
- - @backstage/theme@0.0.0-nightly-20231213021616
17
- - @backstage/plugin-search-react@0.0.0-nightly-20231213021616
18
- - @backstage/integration@0.0.0-nightly-20231213021616
19
- - @backstage/integration-react@0.0.0-nightly-20231213021616
20
- - @backstage/plugin-techdocs-react@0.0.0-nightly-20231213021616
12
+ - @backstage/core-compat-api@0.0.0-nightly-20231215021624
13
+ - @backstage/core-plugin-api@0.0.0-nightly-20231215021624
14
+ - @backstage/frontend-plugin-api@0.0.0-nightly-20231215021624
15
+ - @backstage/plugin-catalog-react@0.0.0-nightly-20231215021624
16
+ - @backstage/core-components@0.0.0-nightly-20231215021624
17
+ - @backstage/theme@0.0.0-nightly-20231215021624
18
+ - @backstage/plugin-search-react@0.0.0-nightly-20231215021624
19
+ - @backstage/integration@0.0.0-nightly-20231215021624
20
+ - @backstage/integration-react@0.0.0-nightly-20231215021624
21
+ - @backstage/plugin-techdocs-react@0.0.0-nightly-20231215021624
21
22
  - @backstage/catalog-model@1.4.3
22
23
  - @backstage/config@1.1.1
23
24
  - @backstage/errors@1.2.3
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs",
3
- "version": "0.0.0-nightly-20231213021616",
3
+ "version": "0.0.0-nightly-20231215021624",
4
4
  "main": "../dist/alpha.esm.js",
5
5
  "module": "../dist/alpha.esm.js",
6
6
  "types": "../dist/alpha.d.ts"
package/dist/alpha.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
2
2
 
3
3
  /** @alpha */
4
- declare const TechDocsSearchResultListItemExtension: _backstage_frontend_plugin_api.ExtensionDefinition<{
4
+ declare const techDocsSearchResultListItemExtension: _backstage_frontend_plugin_api.ExtensionDefinition<{
5
5
  lineClamp: number;
6
6
  noTrack: boolean;
7
7
  asListItem: boolean;
@@ -19,4 +19,4 @@ declare const _default: _backstage_frontend_plugin_api.BackstagePlugin<{
19
19
  entityContent: _backstage_frontend_plugin_api.RouteRef<undefined>;
20
20
  }, {}>;
21
21
 
22
- export { TechDocsSearchResultListItemExtension, _default as default };
22
+ export { _default as default, techDocsSearchResultListItemExtension };
package/dist/alpha.esm.js CHANGED
@@ -10,7 +10,7 @@ import { createEntityContentExtension } from '@backstage/plugin-catalog-react/al
10
10
  import '@backstage/errors';
11
11
  import 'event-source-polyfill';
12
12
 
13
- const techDocsStorage = createApiExtension({
13
+ const techDocsStorageApi = createApiExtension({
14
14
  factory: createApiFactory({
15
15
  api: techdocsStorageApiRef,
16
16
  deps: {
@@ -27,7 +27,7 @@ const techDocsStorage = createApiExtension({
27
27
  })
28
28
  })
29
29
  });
30
- const techDocsClient = createApiExtension({
30
+ const techDocsClientApi = createApiExtension({
31
31
  factory: createApiFactory({
32
32
  api: techdocsApiRef,
33
33
  deps: {
@@ -42,7 +42,7 @@ const techDocsClient = createApiExtension({
42
42
  })
43
43
  })
44
44
  });
45
- const TechDocsSearchResultListItemExtension = createSearchResultListItemExtension({
45
+ const techDocsSearchResultListItemExtension = createSearchResultListItemExtension({
46
46
  configSchema: createSchemaFromZod(
47
47
  (z) => z.object({
48
48
  // TODO: Define how the icon can be configurable
@@ -59,14 +59,14 @@ const TechDocsSearchResultListItemExtension = createSearchResultListItemExtensio
59
59
  return (props) => compatWrapper(/* @__PURE__ */ React.createElement(TechDocsSearchResultListItem, { ...props, ...config }));
60
60
  }
61
61
  });
62
- const TechDocsIndexPage = createPageExtension({
62
+ const techDocsPage = createPageExtension({
63
63
  defaultPath: "/docs",
64
64
  routeRef: convertLegacyRouteRef(rootRouteRef),
65
65
  loader: () => import('./esm/TechDocsIndexPage-a43a1a1c.esm.js').then(function (n) { return n.d; }).then(
66
66
  (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.TechDocsIndexPage, null))
67
67
  )
68
68
  });
69
- const TechDocsReaderPage = createPageExtension({
69
+ const techDocsReaderPage = createPageExtension({
70
70
  name: "reader",
71
71
  defaultPath: "/docs/:namespace/:kind/:name",
72
72
  routeRef: convertLegacyRouteRef(rootDocsRouteRef),
@@ -74,12 +74,12 @@ const TechDocsReaderPage = createPageExtension({
74
74
  (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.TechDocsReaderPage, null))
75
75
  )
76
76
  });
77
- const TechDocsEntityContent = createEntityContentExtension({
77
+ const techDocsEntityContent = createEntityContentExtension({
78
78
  defaultPath: "docs",
79
79
  defaultTitle: "TechDocs",
80
80
  loader: () => import('./esm/Router-4dd3c907.esm.js').then(function (n) { return n.f; }).then((m) => compatWrapper(/* @__PURE__ */ React.createElement(m.EmbeddedDocsRouter, null)))
81
81
  });
82
- const TechDocsNavItem = createNavItemExtension({
82
+ const techDocsNavItem = createNavItemExtension({
83
83
  icon: LibraryBooks,
84
84
  title: "Docs",
85
85
  routeRef: convertLegacyRouteRef(rootRouteRef)
@@ -87,13 +87,13 @@ const TechDocsNavItem = createNavItemExtension({
87
87
  var alpha = createPlugin({
88
88
  id: "techdocs",
89
89
  extensions: [
90
- techDocsClient,
91
- techDocsStorage,
92
- TechDocsNavItem,
93
- TechDocsIndexPage,
94
- TechDocsReaderPage,
95
- TechDocsEntityContent,
96
- TechDocsSearchResultListItemExtension
90
+ techDocsClientApi,
91
+ techDocsStorageApi,
92
+ techDocsNavItem,
93
+ techDocsPage,
94
+ techDocsReaderPage,
95
+ techDocsEntityContent,
96
+ techDocsSearchResultListItemExtension
97
97
  ],
98
98
  routes: {
99
99
  root: convertLegacyRouteRef(rootRouteRef),
@@ -102,5 +102,5 @@ var alpha = createPlugin({
102
102
  }
103
103
  });
104
104
 
105
- export { TechDocsSearchResultListItemExtension, alpha as default };
105
+ export { alpha as default, techDocsSearchResultListItemExtension };
106
106
  //# sourceMappingURL=alpha.esm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"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 React from 'react';\nimport LibraryBooks from '@material-ui/icons/LibraryBooks';\nimport {\n createPlugin,\n createSchemaFromZod,\n createApiExtension,\n createPageExtension,\n createNavItemExtension,\n} from '@backstage/frontend-plugin-api';\nimport { createSearchResultListItemExtension } from '@backstage/plugin-search-react/alpha';\nimport {\n configApiRef,\n createApiFactory,\n discoveryApiRef,\n fetchApiRef,\n identityApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n compatWrapper,\n convertLegacyRouteRef,\n} from '@backstage/core-compat-api';\nimport {\n techdocsApiRef,\n techdocsStorageApiRef,\n} from '@backstage/plugin-techdocs-react';\nimport { TechDocsClient, TechDocsStorageClient } from './client';\nimport {\n rootCatalogDocsRouteRef,\n rootDocsRouteRef,\n rootRouteRef,\n} from './routes';\nimport { createEntityContentExtension } from '@backstage/plugin-catalog-react/alpha';\n\n/** @alpha */\nconst techDocsStorage = createApiExtension({\n factory: createApiFactory({\n api: techdocsStorageApiRef,\n deps: {\n configApi: configApiRef,\n discoveryApi: discoveryApiRef,\n identityApi: identityApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ configApi, discoveryApi, identityApi, fetchApi }) =>\n new TechDocsStorageClient({\n configApi,\n discoveryApi,\n identityApi,\n fetchApi,\n }),\n }),\n});\n\n/** @alpha */\nconst techDocsClient = createApiExtension({\n factory: createApiFactory({\n api: techdocsApiRef,\n deps: {\n configApi: configApiRef,\n discoveryApi: discoveryApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ configApi, discoveryApi, fetchApi }) =>\n new TechDocsClient({\n configApi,\n discoveryApi,\n fetchApi,\n }),\n }),\n});\n\n/** @alpha */\nexport const TechDocsSearchResultListItemExtension =\n createSearchResultListItemExtension({\n configSchema: createSchemaFromZod(z =>\n z.object({\n // TODO: Define how the icon can be configurable\n title: z.string().optional(),\n lineClamp: z.number().default(5),\n asLink: z.boolean().default(true),\n asListItem: z.boolean().default(true),\n noTrack: z.boolean().default(false),\n }),\n ),\n predicate: result => result.type === 'techdocs',\n component: async ({ config }) => {\n const { TechDocsSearchResultListItem } = await import(\n './search/components/TechDocsSearchResultListItem'\n );\n return props =>\n compatWrapper(<TechDocsSearchResultListItem {...props} {...config} />);\n },\n });\n\n/**\n * Responsible for rendering the provided router element\n *\n * @alpha\n */\nconst TechDocsIndexPage = createPageExtension({\n defaultPath: '/docs',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n loader: () =>\n import('./home/components/TechDocsIndexPage').then(m =>\n compatWrapper(<m.TechDocsIndexPage />),\n ),\n});\n\n/**\n * Component responsible for composing a TechDocs reader page experience\n *\n * @alpha\n */\nconst TechDocsReaderPage = createPageExtension({\n name: 'reader',\n defaultPath: '/docs/:namespace/:kind/:name',\n routeRef: convertLegacyRouteRef(rootDocsRouteRef),\n loader: () =>\n import('./reader/components/TechDocsReaderPage').then(m =>\n compatWrapper(<m.TechDocsReaderPage />),\n ),\n});\n\n/**\n * Component responsible for rendering techdocs on entity pages\n *\n * @alpha\n */\nconst TechDocsEntityContent = createEntityContentExtension({\n defaultPath: 'docs',\n defaultTitle: 'TechDocs',\n loader: () =>\n import('./Router').then(m => compatWrapper(<m.EmbeddedDocsRouter />)),\n});\n\n/** @alpha */\nconst TechDocsNavItem = createNavItemExtension({\n icon: LibraryBooks,\n title: 'Docs',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n});\n\n/** @alpha */\nexport default createPlugin({\n id: 'techdocs',\n extensions: [\n techDocsClient,\n techDocsStorage,\n TechDocsNavItem,\n TechDocsIndexPage,\n TechDocsReaderPage,\n TechDocsEntityContent,\n TechDocsSearchResultListItemExtension,\n ],\n routes: {\n root: convertLegacyRouteRef(rootRouteRef),\n docRoot: convertLegacyRouteRef(rootDocsRouteRef),\n entityContent: convertLegacyRouteRef(rootCatalogDocsRouteRef),\n },\n});\n"],"names":[],"mappings":";;;;;;;;;;;;AAkDA,MAAM,kBAAkB,kBAAmB,CAAA;AAAA,EACzC,SAAS,gBAAiB,CAAA;AAAA,IACxB,GAAK,EAAA,qBAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,SAAW,EAAA,YAAA;AAAA,MACX,YAAc,EAAA,eAAA;AAAA,MACd,WAAa,EAAA,cAAA;AAAA,MACb,QAAU,EAAA,WAAA;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,WAAa,EAAA,QAAA,EAChD,KAAA,IAAI,qBAAsB,CAAA;AAAA,MACxB,SAAA;AAAA,MACA,YAAA;AAAA,MACA,WAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA;AAAA,GACJ,CAAA;AACH,CAAC,CAAA,CAAA;AAGD,MAAM,iBAAiB,kBAAmB,CAAA;AAAA,EACxC,SAAS,gBAAiB,CAAA;AAAA,IACxB,GAAK,EAAA,cAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,SAAW,EAAA,YAAA;AAAA,MACX,YAAc,EAAA,eAAA;AAAA,MACd,QAAU,EAAA,WAAA;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAS,EAAA,KAC5C,IAAI,cAAe,CAAA;AAAA,MACjB,SAAA;AAAA,MACA,YAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA;AAAA,GACJ,CAAA;AACH,CAAC,CAAA,CAAA;AAGM,MAAM,wCACX,mCAAoC,CAAA;AAAA,EAClC,YAAc,EAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA;AAAA,MAEP,KAAO,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,MAC3B,SAAW,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,CAAC,CAAA;AAAA,MAC/B,MAAQ,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,IAAI,CAAA;AAAA,MAChC,UAAY,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,IAAI,CAAA;AAAA,MACpC,OAAS,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,KAAK,CAAA;AAAA,KACnC,CAAA;AAAA,GACH;AAAA,EACA,SAAA,EAAW,CAAU,MAAA,KAAA,MAAA,CAAO,IAAS,KAAA,UAAA;AAAA,EACrC,SAAW,EAAA,OAAO,EAAE,MAAA,EAAa,KAAA;AAC/B,IAAA,MAAM,EAAE,4BAAA,EAAiC,GAAA,MAAM,OAC7C,oDACF,CAAA,CAAA;AACA,IAAO,OAAA,CAAA,KAAA,KACL,8BAAe,KAAA,CAAA,aAAA,CAAA,4BAAA,EAAA,EAA8B,GAAG,KAAQ,EAAA,GAAG,QAAQ,CAAE,CAAA,CAAA;AAAA,GACzE;AACF,CAAC,EAAA;AAOH,MAAM,oBAAoB,mBAAoB,CAAA;AAAA,EAC5C,WAAa,EAAA,OAAA;AAAA,EACb,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,EAC5C,MAAQ,EAAA,MACN,OAAO,yCAAqC,oCAAE,CAAA,IAAA;AAAA,IAAK,OACjD,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,iBAAA,EAAF,IAAoB,CAAE,CAAA;AAAA,GACvC;AACJ,CAAC,CAAA,CAAA;AAOD,MAAM,qBAAqB,mBAAoB,CAAA;AAAA,EAC7C,IAAM,EAAA,QAAA;AAAA,EACN,WAAa,EAAA,8BAAA;AAAA,EACb,QAAA,EAAU,sBAAsB,gBAAgB,CAAA;AAAA,EAChD,MAAQ,EAAA,MACN,OAAO,6BAAwC,CAAE,CAAA,IAAA;AAAA,IAAK,OACpD,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,kBAAA,EAAF,IAAqB,CAAE,CAAA;AAAA,GACxC;AACJ,CAAC,CAAA,CAAA;AAOD,MAAM,wBAAwB,4BAA6B,CAAA;AAAA,EACzD,WAAa,EAAA,MAAA;AAAA,EACb,YAAc,EAAA,UAAA;AAAA,EACd,MAAQ,EAAA,MACN,OAAO,8BAAU,oCAAE,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,aAAA,iBAAe,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,kBAAF,EAAA,IAAqB,CAAE,CAAC,CAAA;AACxE,CAAC,CAAA,CAAA;AAGD,MAAM,kBAAkB,sBAAuB,CAAA;AAAA,EAC7C,IAAM,EAAA,YAAA;AAAA,EACN,KAAO,EAAA,MAAA;AAAA,EACP,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAC9C,CAAC,CAAA,CAAA;AAGD,YAAe,YAAa,CAAA;AAAA,EAC1B,EAAI,EAAA,UAAA;AAAA,EACJ,UAAY,EAAA;AAAA,IACV,cAAA;AAAA,IACA,eAAA;AAAA,IACA,eAAA;AAAA,IACA,iBAAA;AAAA,IACA,kBAAA;AAAA,IACA,qBAAA;AAAA,IACA,qCAAA;AAAA,GACF;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,IAAA,EAAM,sBAAsB,YAAY,CAAA;AAAA,IACxC,OAAA,EAAS,sBAAsB,gBAAgB,CAAA;AAAA,IAC/C,aAAA,EAAe,sBAAsB,uBAAuB,CAAA;AAAA,GAC9D;AACF,CAAC,CAAA;;;;"}
1
+ {"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"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 React from 'react';\nimport LibraryBooks from '@material-ui/icons/LibraryBooks';\nimport {\n createPlugin,\n createSchemaFromZod,\n createApiExtension,\n createPageExtension,\n createNavItemExtension,\n} from '@backstage/frontend-plugin-api';\nimport { createSearchResultListItemExtension } from '@backstage/plugin-search-react/alpha';\nimport {\n configApiRef,\n createApiFactory,\n discoveryApiRef,\n fetchApiRef,\n identityApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n compatWrapper,\n convertLegacyRouteRef,\n} from '@backstage/core-compat-api';\nimport {\n techdocsApiRef,\n techdocsStorageApiRef,\n} from '@backstage/plugin-techdocs-react';\nimport { TechDocsClient, TechDocsStorageClient } from './client';\nimport {\n rootCatalogDocsRouteRef,\n rootDocsRouteRef,\n rootRouteRef,\n} from './routes';\nimport { createEntityContentExtension } from '@backstage/plugin-catalog-react/alpha';\n\n/** @alpha */\nconst techDocsStorageApi = createApiExtension({\n factory: createApiFactory({\n api: techdocsStorageApiRef,\n deps: {\n configApi: configApiRef,\n discoveryApi: discoveryApiRef,\n identityApi: identityApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ configApi, discoveryApi, identityApi, fetchApi }) =>\n new TechDocsStorageClient({\n configApi,\n discoveryApi,\n identityApi,\n fetchApi,\n }),\n }),\n});\n\n/** @alpha */\nconst techDocsClientApi = createApiExtension({\n factory: createApiFactory({\n api: techdocsApiRef,\n deps: {\n configApi: configApiRef,\n discoveryApi: discoveryApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ configApi, discoveryApi, fetchApi }) =>\n new TechDocsClient({\n configApi,\n discoveryApi,\n fetchApi,\n }),\n }),\n});\n\n/** @alpha */\nexport const techDocsSearchResultListItemExtension =\n createSearchResultListItemExtension({\n configSchema: createSchemaFromZod(z =>\n z.object({\n // TODO: Define how the icon can be configurable\n title: z.string().optional(),\n lineClamp: z.number().default(5),\n asLink: z.boolean().default(true),\n asListItem: z.boolean().default(true),\n noTrack: z.boolean().default(false),\n }),\n ),\n predicate: result => result.type === 'techdocs',\n component: async ({ config }) => {\n const { TechDocsSearchResultListItem } = await import(\n './search/components/TechDocsSearchResultListItem'\n );\n return props =>\n compatWrapper(<TechDocsSearchResultListItem {...props} {...config} />);\n },\n });\n\n/**\n * Responsible for rendering the provided router element\n *\n * @alpha\n */\nconst techDocsPage = createPageExtension({\n defaultPath: '/docs',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n loader: () =>\n import('./home/components/TechDocsIndexPage').then(m =>\n compatWrapper(<m.TechDocsIndexPage />),\n ),\n});\n\n/**\n * Component responsible for composing a TechDocs reader page experience\n *\n * @alpha\n */\nconst techDocsReaderPage = createPageExtension({\n name: 'reader',\n defaultPath: '/docs/:namespace/:kind/:name',\n routeRef: convertLegacyRouteRef(rootDocsRouteRef),\n loader: () =>\n import('./reader/components/TechDocsReaderPage').then(m =>\n compatWrapper(<m.TechDocsReaderPage />),\n ),\n});\n\n/**\n * Component responsible for rendering techdocs on entity pages\n *\n * @alpha\n */\nconst techDocsEntityContent = createEntityContentExtension({\n defaultPath: 'docs',\n defaultTitle: 'TechDocs',\n loader: () =>\n import('./Router').then(m => compatWrapper(<m.EmbeddedDocsRouter />)),\n});\n\n/** @alpha */\nconst techDocsNavItem = createNavItemExtension({\n icon: LibraryBooks,\n title: 'Docs',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n});\n\n/** @alpha */\nexport default createPlugin({\n id: 'techdocs',\n extensions: [\n techDocsClientApi,\n techDocsStorageApi,\n techDocsNavItem,\n techDocsPage,\n techDocsReaderPage,\n techDocsEntityContent,\n techDocsSearchResultListItemExtension,\n ],\n routes: {\n root: convertLegacyRouteRef(rootRouteRef),\n docRoot: convertLegacyRouteRef(rootDocsRouteRef),\n entityContent: convertLegacyRouteRef(rootCatalogDocsRouteRef),\n },\n});\n"],"names":[],"mappings":";;;;;;;;;;;;AAkDA,MAAM,qBAAqB,kBAAmB,CAAA;AAAA,EAC5C,SAAS,gBAAiB,CAAA;AAAA,IACxB,GAAK,EAAA,qBAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,SAAW,EAAA,YAAA;AAAA,MACX,YAAc,EAAA,eAAA;AAAA,MACd,WAAa,EAAA,cAAA;AAAA,MACb,QAAU,EAAA,WAAA;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,WAAa,EAAA,QAAA,EAChD,KAAA,IAAI,qBAAsB,CAAA;AAAA,MACxB,SAAA;AAAA,MACA,YAAA;AAAA,MACA,WAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA;AAAA,GACJ,CAAA;AACH,CAAC,CAAA,CAAA;AAGD,MAAM,oBAAoB,kBAAmB,CAAA;AAAA,EAC3C,SAAS,gBAAiB,CAAA;AAAA,IACxB,GAAK,EAAA,cAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,SAAW,EAAA,YAAA;AAAA,MACX,YAAc,EAAA,eAAA;AAAA,MACd,QAAU,EAAA,WAAA;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAS,EAAA,KAC5C,IAAI,cAAe,CAAA;AAAA,MACjB,SAAA;AAAA,MACA,YAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA;AAAA,GACJ,CAAA;AACH,CAAC,CAAA,CAAA;AAGM,MAAM,wCACX,mCAAoC,CAAA;AAAA,EAClC,YAAc,EAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA;AAAA,MAEP,KAAO,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,MAC3B,SAAW,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,CAAC,CAAA;AAAA,MAC/B,MAAQ,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,IAAI,CAAA;AAAA,MAChC,UAAY,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,IAAI,CAAA;AAAA,MACpC,OAAS,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,KAAK,CAAA;AAAA,KACnC,CAAA;AAAA,GACH;AAAA,EACA,SAAA,EAAW,CAAU,MAAA,KAAA,MAAA,CAAO,IAAS,KAAA,UAAA;AAAA,EACrC,SAAW,EAAA,OAAO,EAAE,MAAA,EAAa,KAAA;AAC/B,IAAA,MAAM,EAAE,4BAAA,EAAiC,GAAA,MAAM,OAC7C,oDACF,CAAA,CAAA;AACA,IAAO,OAAA,CAAA,KAAA,KACL,8BAAe,KAAA,CAAA,aAAA,CAAA,4BAAA,EAAA,EAA8B,GAAG,KAAQ,EAAA,GAAG,QAAQ,CAAE,CAAA,CAAA;AAAA,GACzE;AACF,CAAC,EAAA;AAOH,MAAM,eAAe,mBAAoB,CAAA;AAAA,EACvC,WAAa,EAAA,OAAA;AAAA,EACb,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,EAC5C,MAAQ,EAAA,MACN,OAAO,yCAAqC,oCAAE,CAAA,IAAA;AAAA,IAAK,OACjD,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,iBAAA,EAAF,IAAoB,CAAE,CAAA;AAAA,GACvC;AACJ,CAAC,CAAA,CAAA;AAOD,MAAM,qBAAqB,mBAAoB,CAAA;AAAA,EAC7C,IAAM,EAAA,QAAA;AAAA,EACN,WAAa,EAAA,8BAAA;AAAA,EACb,QAAA,EAAU,sBAAsB,gBAAgB,CAAA;AAAA,EAChD,MAAQ,EAAA,MACN,OAAO,6BAAwC,CAAE,CAAA,IAAA;AAAA,IAAK,OACpD,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,kBAAA,EAAF,IAAqB,CAAE,CAAA;AAAA,GACxC;AACJ,CAAC,CAAA,CAAA;AAOD,MAAM,wBAAwB,4BAA6B,CAAA;AAAA,EACzD,WAAa,EAAA,MAAA;AAAA,EACb,YAAc,EAAA,UAAA;AAAA,EACd,MAAQ,EAAA,MACN,OAAO,8BAAU,oCAAE,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,aAAA,iBAAe,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,kBAAF,EAAA,IAAqB,CAAE,CAAC,CAAA;AACxE,CAAC,CAAA,CAAA;AAGD,MAAM,kBAAkB,sBAAuB,CAAA;AAAA,EAC7C,IAAM,EAAA,YAAA;AAAA,EACN,KAAO,EAAA,MAAA;AAAA,EACP,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAC9C,CAAC,CAAA,CAAA;AAGD,YAAe,YAAa,CAAA;AAAA,EAC1B,EAAI,EAAA,UAAA;AAAA,EACJ,UAAY,EAAA;AAAA,IACV,iBAAA;AAAA,IACA,kBAAA;AAAA,IACA,eAAA;AAAA,IACA,YAAA;AAAA,IACA,kBAAA;AAAA,IACA,qBAAA;AAAA,IACA,qCAAA;AAAA,GACF;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,IAAA,EAAM,sBAAsB,YAAY,CAAA;AAAA,IACxC,OAAA,EAAS,sBAAsB,gBAAgB,CAAA;AAAA,IAC/C,aAAA,EAAe,sBAAsB,uBAAuB,CAAA;AAAA,GAC9D;AACF,CAAC,CAAA;;;;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs",
3
3
  "description": "The Backstage plugin that renders technical documentation for your components",
4
- "version": "0.0.0-nightly-20231213021616",
4
+ "version": "0.0.0-nightly-20231215021624",
5
5
  "main": "./dist/index.esm.js",
6
6
  "types": "./dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -47,18 +47,18 @@
47
47
  "dependencies": {
48
48
  "@backstage/catalog-model": "^1.4.3",
49
49
  "@backstage/config": "^1.1.1",
50
- "@backstage/core-compat-api": "^0.0.0-nightly-20231213021616",
51
- "@backstage/core-components": "^0.0.0-nightly-20231213021616",
52
- "@backstage/core-plugin-api": "^0.0.0-nightly-20231213021616",
50
+ "@backstage/core-compat-api": "^0.0.0-nightly-20231215021624",
51
+ "@backstage/core-components": "^0.0.0-nightly-20231215021624",
52
+ "@backstage/core-plugin-api": "^0.0.0-nightly-20231215021624",
53
53
  "@backstage/errors": "^1.2.3",
54
- "@backstage/frontend-plugin-api": "^0.0.0-nightly-20231213021616",
55
- "@backstage/integration": "^0.0.0-nightly-20231213021616",
56
- "@backstage/integration-react": "^0.0.0-nightly-20231213021616",
57
- "@backstage/plugin-catalog-react": "^0.0.0-nightly-20231213021616",
54
+ "@backstage/frontend-plugin-api": "^0.0.0-nightly-20231215021624",
55
+ "@backstage/integration": "^0.0.0-nightly-20231215021624",
56
+ "@backstage/integration-react": "^0.0.0-nightly-20231215021624",
57
+ "@backstage/plugin-catalog-react": "^0.0.0-nightly-20231215021624",
58
58
  "@backstage/plugin-search-common": "^1.2.8",
59
- "@backstage/plugin-search-react": "^0.0.0-nightly-20231213021616",
60
- "@backstage/plugin-techdocs-react": "^0.0.0-nightly-20231213021616",
61
- "@backstage/theme": "^0.0.0-nightly-20231213021616",
59
+ "@backstage/plugin-search-react": "^0.0.0-nightly-20231215021624",
60
+ "@backstage/plugin-techdocs-react": "^0.0.0-nightly-20231215021624",
61
+ "@backstage/theme": "^0.0.0-nightly-20231215021624",
62
62
  "@material-ui/core": "^4.12.2",
63
63
  "@material-ui/icons": "^4.9.1",
64
64
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -78,11 +78,11 @@
78
78
  "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
79
79
  },
80
80
  "devDependencies": {
81
- "@backstage/cli": "^0.0.0-nightly-20231213021616",
82
- "@backstage/core-app-api": "^0.0.0-nightly-20231213021616",
83
- "@backstage/dev-utils": "^0.0.0-nightly-20231213021616",
84
- "@backstage/plugin-techdocs-module-addons-contrib": "^0.0.0-nightly-20231213021616",
85
- "@backstage/test-utils": "^0.0.0-nightly-20231213021616",
81
+ "@backstage/cli": "^0.0.0-nightly-20231215021624",
82
+ "@backstage/core-app-api": "^0.0.0-nightly-20231215021624",
83
+ "@backstage/dev-utils": "^0.0.0-nightly-20231215021624",
84
+ "@backstage/plugin-techdocs-module-addons-contrib": "^0.0.0-nightly-20231215021624",
85
+ "@backstage/test-utils": "^0.0.0-nightly-20231215021624",
86
86
  "@testing-library/dom": "^9.0.0",
87
87
  "@testing-library/jest-dom": "^6.0.0",
88
88
  "@testing-library/react": "^14.0.0",