@backstage/plugin-techdocs 1.6.8 → 1.6.9-next.1

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.
@@ -1,4 +1,4 @@
1
- export { c as TechDocsReaderLayout, b as TechDocsReaderPage } from './index-8bf02c1c.esm.js';
1
+ export { c as TechDocsReaderLayout, b as TechDocsReaderPage } from './index-05858541.esm.js';
2
2
  import '@backstage/core-plugin-api';
3
3
  import '@backstage/errors';
4
4
  import 'event-source-polyfill';
@@ -33,4 +33,4 @@ import '@material-ui/icons/Share';
33
33
  import '@material-ui/styles';
34
34
  import '@material-ui/icons/Star';
35
35
  import '@material-ui/icons/StarBorder';
36
- //# sourceMappingURL=index-13a5f343.esm.js.map
36
+ //# sourceMappingURL=index-85604292.esm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index-85604292.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/dist/index.d.ts CHANGED
@@ -197,7 +197,7 @@ type TechDocsReaderProviderProps = {
197
197
  *
198
198
  * @public
199
199
  */
200
- declare const TechDocsReaderProvider: (props: TechDocsReaderProviderProps) => JSX.Element;
200
+ declare const TechDocsReaderProvider: (props: TechDocsReaderProviderProps) => React__default.JSX.Element;
201
201
 
202
202
  /**
203
203
  * Props for {@link TechDocsReaderLayout}
@@ -217,7 +217,7 @@ type TechDocsReaderLayoutProps = {
217
217
  * Default TechDocs reader page structure composed with a header and content
218
218
  * @public
219
219
  */
220
- declare const TechDocsReaderLayout: (props: TechDocsReaderLayoutProps) => JSX.Element;
220
+ declare const TechDocsReaderLayout: (props: TechDocsReaderLayoutProps) => React__default.JSX.Element;
221
221
  /**
222
222
  * @public
223
223
  */
@@ -243,7 +243,7 @@ type TechDocsReaderPageHeaderProps = PropsWithChildren<{
243
243
  * the Tech Docs add-ons to customize it
244
244
  * @public
245
245
  */
246
- declare const TechDocsReaderPageHeader: (props: TechDocsReaderPageHeaderProps) => JSX.Element | null;
246
+ declare const TechDocsReaderPageHeader: (props: TechDocsReaderPageHeaderProps) => React__default.JSX.Element | null;
247
247
 
248
248
  /**
249
249
  * Props for {@link TechDocsReaderPageContent}
@@ -267,13 +267,13 @@ type TechDocsReaderPageContentProps = {
267
267
  * Renders the reader page content
268
268
  * @public
269
269
  */
270
- declare const TechDocsReaderPageContent: (props: TechDocsReaderPageContentProps) => JSX.Element;
270
+ declare const TechDocsReaderPageContent: (props: TechDocsReaderPageContentProps) => React__default.JSX.Element;
271
271
  /**
272
272
  * Component responsible for rendering TechDocs documentation
273
273
  * @public
274
274
  * @deprecated use `TechDocsReaderPageContent` component instead.
275
275
  */
276
- declare const Reader: (props: TechDocsReaderPageContentProps) => JSX.Element;
276
+ declare const Reader: (props: TechDocsReaderPageContentProps) => React__default.JSX.Element;
277
277
 
278
278
  /**
279
279
  * Renders the reader page subheader.
@@ -282,7 +282,7 @@ declare const Reader: (props: TechDocsReaderPageContentProps) => JSX.Element;
282
282
  */
283
283
  declare const TechDocsReaderPageSubheader: (props: {
284
284
  toolbarProps?: ToolbarProps;
285
- }) => JSX.Element | null;
285
+ }) => React__default.JSX.Element | null;
286
286
 
287
287
  /**
288
288
  * Props for {@link TechDocsSearch}
@@ -299,7 +299,7 @@ type TechDocsSearchProps = {
299
299
  *
300
300
  * @public
301
301
  */
302
- declare const TechDocsSearch: (props: TechDocsSearchProps) => JSX.Element;
302
+ declare const TechDocsSearch: (props: TechDocsSearchProps) => React__default.JSX.Element;
303
303
 
304
304
  /**
305
305
  * Props for {@link EntityListDocsGrid}
@@ -323,7 +323,7 @@ type EntityListDocsGridPageProps = {
323
323
  *
324
324
  * @public
325
325
  */
326
- declare const EntityListDocsGrid: (props: EntityListDocsGridPageProps) => JSX.Element;
326
+ declare const EntityListDocsGrid: (props: EntityListDocsGridPageProps) => React__default.JSX.Element;
327
327
 
328
328
  /**
329
329
  * Props for {@link DocsCardGrid}
@@ -338,7 +338,7 @@ type DocsCardGridProps = {
338
338
  *
339
339
  * @public
340
340
  */
341
- declare const DocsCardGrid: (props: DocsCardGridProps) => JSX.Element | null;
341
+ declare const DocsCardGrid: (props: DocsCardGridProps) => React__default.JSX.Element | null;
342
342
 
343
343
  /**
344
344
  * Generic representing the metadata structure for a docs table row.
@@ -370,7 +370,7 @@ type EntityListDocsTableProps = {
370
370
  * @public
371
371
  */
372
372
  declare const EntityListDocsTable: {
373
- (props: EntityListDocsTableProps): JSX.Element;
373
+ (props: EntityListDocsTableProps): React__default.JSX.Element;
374
374
  columns: {
375
375
  createNameColumn(): TableColumn<DocsTableRow>;
376
376
  createOwnerColumn(): TableColumn<DocsTableRow>;
@@ -378,7 +378,7 @@ declare const EntityListDocsTable: {
378
378
  };
379
379
  actions: {
380
380
  createCopyDocsUrlAction(copyToClipboard: Function): (row: DocsTableRow) => {
381
- icon: () => JSX.Element;
381
+ icon: () => React__default.JSX.Element;
382
382
  tooltip: string;
383
383
  onClick: () => any;
384
384
  };
@@ -386,7 +386,7 @@ declare const EntityListDocsTable: {
386
386
  cellStyle: {
387
387
  paddingLeft: string;
388
388
  };
389
- icon: () => JSX.Element;
389
+ icon: () => React__default.JSX.Element;
390
390
  tooltip: string;
391
391
  onClick: () => any;
392
392
  };
@@ -412,7 +412,7 @@ type DocsTableProps = {
412
412
  * @public
413
413
  */
414
414
  declare const DocsTable: {
415
- (props: DocsTableProps): JSX.Element | null;
415
+ (props: DocsTableProps): React__default.JSX.Element | null;
416
416
  columns: {
417
417
  createNameColumn(): TableColumn<DocsTableRow>;
418
418
  createOwnerColumn(): TableColumn<DocsTableRow>;
@@ -420,7 +420,7 @@ declare const DocsTable: {
420
420
  };
421
421
  actions: {
422
422
  createCopyDocsUrlAction(copyToClipboard: Function): (row: DocsTableRow) => {
423
- icon: () => JSX.Element;
423
+ icon: () => React__default.JSX.Element;
424
424
  tooltip: string;
425
425
  onClick: () => any;
426
426
  };
@@ -428,7 +428,7 @@ declare const DocsTable: {
428
428
  cellStyle: {
429
429
  paddingLeft: string;
430
430
  };
431
- icon: () => JSX.Element;
431
+ icon: () => React__default.JSX.Element;
432
432
  tooltip: string;
433
433
  onClick: () => any;
434
434
  };
@@ -458,7 +458,7 @@ type DefaultTechDocsHomeProps = TechDocsIndexPageProps;
458
458
  *
459
459
  * @public
460
460
  */
461
- declare const DefaultTechDocsHome: (props: TechDocsIndexPageProps) => JSX.Element;
461
+ declare const DefaultTechDocsHome: (props: TechDocsIndexPageProps) => React__default.JSX.Element;
462
462
 
463
463
  /**
464
464
  * Available panel types
@@ -515,7 +515,7 @@ type TechDocsPageWrapperProps = {
515
515
  *
516
516
  * @public
517
517
  */
518
- declare const TechDocsPageWrapper: (props: TechDocsPageWrapperProps) => JSX.Element;
518
+ declare const TechDocsPageWrapper: (props: TechDocsPageWrapperProps) => React__default.JSX.Element;
519
519
 
520
520
  /**
521
521
  * Component responsible for updating TechDocs filters
@@ -559,7 +559,7 @@ declare const techdocsPlugin: _backstage_core_plugin_api.BackstagePlugin<{
559
559
  *
560
560
  * @public
561
561
  */
562
- declare const TechdocsPage: () => JSX.Element;
562
+ declare const TechdocsPage: () => React.JSX.Element;
563
563
  /**
564
564
  * Routable extension used to render docs on Entity page
565
565
  *
@@ -567,25 +567,25 @@ declare const TechdocsPage: () => JSX.Element;
567
567
  */
568
568
  declare const EntityTechdocsContent: (props: {
569
569
  children?: React.ReactNode;
570
- }) => JSX.Element | null;
570
+ }) => React.JSX.Element | null;
571
571
  /**
572
572
  * Component which takes a custom tabs config object and renders a documentation landing page.
573
573
  *
574
574
  * @public
575
575
  */
576
- declare const TechDocsCustomHome: (props: TechDocsCustomHomeProps) => JSX.Element;
576
+ declare const TechDocsCustomHome: (props: TechDocsCustomHomeProps) => React.JSX.Element;
577
577
  /**
578
578
  * Responsible for rendering the provided router element
579
579
  *
580
580
  * @public
581
581
  */
582
- declare const TechDocsIndexPage: (props: TechDocsIndexPageProps) => JSX.Element;
582
+ declare const TechDocsIndexPage: (props: TechDocsIndexPageProps) => React.JSX.Element;
583
583
  /**
584
584
  * Component responsible for composing a TechDocs reader page experience
585
585
  *
586
586
  * @public
587
587
  */
588
- declare const TechDocsReaderPage: (props: TechDocsReaderPageProps) => JSX.Element;
588
+ declare const TechDocsReaderPage: (props: TechDocsReaderPageProps) => React.JSX.Element;
589
589
  /**
590
590
  * React extension used to render results on Search page or modal
591
591
  *
@@ -604,13 +604,13 @@ declare const isTechDocsAvailable: (entity: Entity) => boolean;
604
604
  *
605
605
  * @public
606
606
  */
607
- declare const Router: () => JSX.Element;
607
+ declare const Router: () => React__default.JSX.Element;
608
608
  /**
609
609
  * Responsible for registering route to view docs on Entity page
610
610
  *
611
611
  * @public
612
612
  */
613
- declare const EmbeddedDocsRouter: (props: PropsWithChildren<{}>) => JSX.Element | null;
613
+ declare const EmbeddedDocsRouter: (props: PropsWithChildren<{}>) => React__default.JSX.Element | null;
614
614
 
615
615
  /**
616
616
  * The Backstage plugin that renders technical documentation for your components
package/dist/index.esm.js CHANGED
@@ -1,4 +1,4 @@
1
- export { u as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, y as EmbeddedDocsRouter, r as EntityListDocsGrid, s as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, x as Router, k as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, o as TechDocsReaderPageContent, n as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, m as TechDocsReaderProvider, q as TechDocsSearch, h as TechDocsSearchResultListItem, l as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, j as techdocsApiRef, t as techdocsPlugin, i as techdocsStorageApiRef } from './esm/index-8bf02c1c.esm.js';
1
+ export { u as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, y as EmbeddedDocsRouter, r as EntityListDocsGrid, s as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, x as Router, k as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, o as TechDocsReaderPageContent, n as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, m as TechDocsReaderProvider, q as TechDocsSearch, h as TechDocsSearchResultListItem, l as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, j as techdocsApiRef, t as techdocsPlugin, i as techdocsStorageApiRef } from './esm/index-05858541.esm.js';
2
2
  import '@backstage/core-plugin-api';
3
3
  import '@backstage/errors';
4
4
  import 'event-source-polyfill';
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": "1.6.8",
4
+ "version": "1.6.9-next.1",
5
5
  "main": "dist/index.esm.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -33,17 +33,17 @@
33
33
  "clean": "backstage-cli package clean"
34
34
  },
35
35
  "dependencies": {
36
- "@backstage/catalog-model": "^1.4.1",
37
- "@backstage/config": "^1.0.8",
38
- "@backstage/core-components": "^0.13.4",
39
- "@backstage/core-plugin-api": "^1.5.3",
36
+ "@backstage/catalog-model": "^1.4.2-next.0",
37
+ "@backstage/config": "^1.1.0-next.0",
38
+ "@backstage/core-components": "^0.13.5-next.1",
39
+ "@backstage/core-plugin-api": "^1.6.0-next.1",
40
40
  "@backstage/errors": "^1.2.1",
41
- "@backstage/integration": "^1.6.2",
42
- "@backstage/integration-react": "^1.1.18",
43
- "@backstage/plugin-catalog-react": "^1.8.3",
44
- "@backstage/plugin-search-common": "^1.2.5",
45
- "@backstage/plugin-search-react": "^1.6.4",
46
- "@backstage/plugin-techdocs-react": "^1.1.9",
41
+ "@backstage/integration": "^1.7.0-next.1",
42
+ "@backstage/integration-react": "^1.1.19-next.1",
43
+ "@backstage/plugin-catalog-react": "^1.8.4-next.1",
44
+ "@backstage/plugin-search-common": "^1.2.6-next.0",
45
+ "@backstage/plugin-search-react": "^1.7.0-next.1",
46
+ "@backstage/plugin-techdocs-react": "^1.1.10-next.1",
47
47
  "@backstage/theme": "^0.4.1",
48
48
  "@material-ui/core": "^4.12.2",
49
49
  "@material-ui/icons": "^4.9.1",
@@ -64,11 +64,11 @@
64
64
  "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
65
65
  },
66
66
  "devDependencies": {
67
- "@backstage/cli": "^0.22.12",
68
- "@backstage/core-app-api": "^1.9.1",
69
- "@backstage/dev-utils": "^1.0.20",
70
- "@backstage/plugin-techdocs-module-addons-contrib": "^1.0.18",
71
- "@backstage/test-utils": "^1.4.2",
67
+ "@backstage/cli": "^0.22.13-next.1",
68
+ "@backstage/core-app-api": "^1.10.0-next.1",
69
+ "@backstage/dev-utils": "^1.0.21-next.1",
70
+ "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.0-next.1",
71
+ "@backstage/test-utils": "^1.4.3-next.1",
72
72
  "@testing-library/dom": "^8.0.0",
73
73
  "@testing-library/jest-dom": "^5.10.1",
74
74
  "@testing-library/react": "^12.1.3",
@@ -1 +0,0 @@
1
- {"version":3,"file":"index-13a5f343.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}