@fluidframework/devtools-core 2.70.0-361248 → 2.70.0

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.
Files changed (49) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +2 -0
  3. package/api-extractor/api-extractor-lint-beta.cjs.json +5 -0
  4. package/api-extractor/api-extractor-lint-beta.esm.json +5 -0
  5. package/api-report/devtools-core.alpha.api.md +11 -11
  6. package/api-report/devtools-core.beta.api.md +31 -0
  7. package/beta.d.ts +11 -0
  8. package/dist/ContainerDevtools.d.ts +5 -3
  9. package/dist/ContainerDevtools.d.ts.map +1 -1
  10. package/dist/ContainerDevtools.js.map +1 -1
  11. package/dist/ContainerRuntimeDevtools.d.ts +3 -2
  12. package/dist/ContainerRuntimeDevtools.d.ts.map +1 -1
  13. package/dist/ContainerRuntimeDevtools.js.map +1 -1
  14. package/dist/FluidDevtools.d.ts +7 -5
  15. package/dist/FluidDevtools.d.ts.map +1 -1
  16. package/dist/FluidDevtools.js +2 -2
  17. package/dist/FluidDevtools.js.map +1 -1
  18. package/dist/IFluidDevtools.d.ts +1 -1
  19. package/dist/IFluidDevtools.js.map +1 -1
  20. package/dist/alpha.d.ts +4 -7
  21. package/dist/beta.d.ts +42 -0
  22. package/dist/packageVersion.d.ts +1 -1
  23. package/dist/packageVersion.d.ts.map +1 -1
  24. package/dist/packageVersion.js +1 -1
  25. package/dist/packageVersion.js.map +1 -1
  26. package/lib/ContainerDevtools.d.ts +5 -3
  27. package/lib/ContainerDevtools.d.ts.map +1 -1
  28. package/lib/ContainerDevtools.js.map +1 -1
  29. package/lib/ContainerRuntimeDevtools.d.ts +3 -2
  30. package/lib/ContainerRuntimeDevtools.d.ts.map +1 -1
  31. package/lib/ContainerRuntimeDevtools.js.map +1 -1
  32. package/lib/FluidDevtools.d.ts +7 -5
  33. package/lib/FluidDevtools.d.ts.map +1 -1
  34. package/lib/FluidDevtools.js +2 -2
  35. package/lib/FluidDevtools.js.map +1 -1
  36. package/lib/IFluidDevtools.d.ts +1 -1
  37. package/lib/IFluidDevtools.js.map +1 -1
  38. package/lib/alpha.d.ts +4 -7
  39. package/lib/beta.d.ts +42 -0
  40. package/lib/packageVersion.d.ts +1 -1
  41. package/lib/packageVersion.d.ts.map +1 -1
  42. package/lib/packageVersion.js +1 -1
  43. package/lib/packageVersion.js.map +1 -1
  44. package/package.json +35 -23
  45. package/src/ContainerDevtools.ts +5 -3
  46. package/src/ContainerRuntimeDevtools.ts +3 -2
  47. package/src/FluidDevtools.ts +7 -5
  48. package/src/IFluidDevtools.ts +1 -1
  49. package/src/packageVersion.ts +1 -1
@@ -18,13 +18,15 @@ import {
18
18
 
19
19
  /**
20
20
  * Properties for registering a {@link @fluidframework/container-definitions#IContainer} with the Devtools.
21
- * @alpha
21
+ * @beta
22
+ * @input
23
+ * @sealed
22
24
  */
23
25
  export interface ContainerDevtoolsProps extends HasContainerKey {
24
26
  /**
25
27
  * The Container to register with the Devtools.
26
28
  */
27
- container: IContainer;
29
+ readonly container: IContainer;
28
30
 
29
31
  /**
30
32
  * (optional) Distributed Data Structures (DDSs) associated with the
@@ -39,7 +41,7 @@ export interface ContainerDevtoolsProps extends HasContainerKey {
39
41
  *
40
42
  * @privateRemarks TODO: rename this to make it more clear that this data does not *belong* to the Container.
41
43
  */
42
- containerData?: Record<string, IFluidLoadable>;
44
+ readonly containerData?: Record<string, IFluidLoadable>;
43
45
 
44
46
  // TODO: Add ability for customers to specify custom visualizer overrides
45
47
  }
@@ -23,7 +23,8 @@ import type { InboundHandlers } from "./messaging/index.js";
23
23
 
24
24
  /**
25
25
  * Properties for registering a container runtime with the Devtools.
26
- * @alpha
26
+ * @beta
27
+ * @sealed
27
28
  * @input
28
29
  */
29
30
  export interface ContainerRuntimeProps {
@@ -35,7 +36,7 @@ export interface ContainerRuntimeProps {
35
36
  /**
36
37
  * Optional label for the container runtime replacing the guid generated by {@link @fluidframework/container-runtime#IContainerRuntime.generateDocumentUniqueId}.
37
38
  */
38
- label?: string;
39
+ readonly label?: string;
39
40
  }
40
41
 
41
42
  /**
@@ -77,7 +77,9 @@ export function getContainerAlreadyRegisteredErrorText(containerKey: ContainerKe
77
77
 
78
78
  /**
79
79
  * Properties for configuring the Devtools.
80
- * @alpha
80
+ * @beta
81
+ * @input
82
+ * @sealed
81
83
  */
82
84
  export interface FluidDevtoolsProps {
83
85
  /**
@@ -90,14 +92,14 @@ export interface FluidDevtoolsProps {
90
92
  * This is provided to the Devtools instance strictly to enable communicating supported / desired functionality with
91
93
  * external listeners.
92
94
  */
93
- logger?: IDevtoolsLogger;
95
+ readonly logger?: IDevtoolsLogger;
94
96
 
95
97
  /**
96
98
  * (optional) List of Containers to initialize the devtools with.
97
99
  *
98
100
  * @remarks Additional Containers can be registered with the Devtools via {@link IFluidDevtools.registerContainerDevtools}.
99
101
  */
100
- initialContainers?: ContainerDevtoolsProps[];
102
+ readonly initialContainers?: ContainerDevtoolsProps[];
101
103
 
102
104
  // TODO: Add ability for customers to specify custom data visualizer overrides
103
105
  }
@@ -517,7 +519,7 @@ export class FluidDevtools implements IFluidDevtools {
517
519
  *
518
520
  * It is automatically disposed on webpage unload, but it can be closed earlier by calling `dispose`
519
521
  * on the returned handle.
520
- * @alpha
522
+ * @beta
521
523
  */
522
524
  export function initializeDevtools(props?: FluidDevtoolsProps): IFluidDevtools {
523
525
  return FluidDevtools.initialize(props);
@@ -525,7 +527,7 @@ export function initializeDevtools(props?: FluidDevtoolsProps): IFluidDevtools {
525
527
 
526
528
  /**
527
529
  * Gets the Devtools singleton if it has been {@link initializeDevtools | initialized}, otherwise returns `undefined`.
528
- * @alpha
530
+ * @beta
529
531
  */
530
532
  export function tryGetFluidDevtools(): IFluidDevtools | undefined {
531
533
  return FluidDevtools.tryGet();
@@ -21,7 +21,7 @@ import type { ContainerRuntimeProps } from "./ContainerRuntimeDevtools.js";
21
21
  * The lifetime of the associated singleton is bound by that of the Window (globalThis), and it will be automatically
22
22
  * disposed of on Window unload.
23
23
  * If you wish to dispose of it earlier, you may call its {@link @fluidframework/core-interfaces#IDisposable.dispose} method.
24
- * @alpha
24
+ * @beta
25
25
  * @sealed
26
26
  */
27
27
  export interface IFluidDevtools extends IDisposable {
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/devtools-core";
9
- export const pkgVersion = "2.70.0-361248";
9
+ export const pkgVersion = "2.70.0";