@fluidframework/debugger 2.0.0-dev.6.4.0.192049 → 2.0.0-dev.7.2.0.203917

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 (44) hide show
  1. package/CHANGELOG.md +52 -0
  2. package/api-extractor.json +1 -1
  3. package/api-report/debugger.api.md +156 -0
  4. package/dist/debugger-alpha.d.ts +190 -0
  5. package/dist/debugger-beta.d.ts +190 -0
  6. package/dist/debugger-public.d.ts +190 -0
  7. package/dist/debugger-untrimmed.d.ts +190 -0
  8. package/dist/fluidDebugger.d.ts +3 -0
  9. package/dist/fluidDebugger.d.ts.map +1 -1
  10. package/dist/fluidDebugger.js +4 -1
  11. package/dist/fluidDebugger.js.map +1 -1
  12. package/dist/fluidDebuggerController.d.ts +6 -1
  13. package/dist/fluidDebuggerController.d.ts.map +1 -1
  14. package/dist/fluidDebuggerController.js +6 -3
  15. package/dist/fluidDebuggerController.js.map +1 -1
  16. package/dist/fluidDebuggerUi.d.ts +9 -0
  17. package/dist/fluidDebuggerUi.d.ts.map +1 -1
  18. package/dist/fluidDebuggerUi.js +25 -22
  19. package/dist/fluidDebuggerUi.js.map +1 -1
  20. package/dist/sanitizer.d.ts.map +1 -1
  21. package/dist/sanitizer.js +8 -2
  22. package/dist/sanitizer.js.map +1 -1
  23. package/dist/tsdoc-metadata.json +1 -1
  24. package/lib/fluidDebugger.d.ts +3 -0
  25. package/lib/fluidDebugger.d.ts.map +1 -1
  26. package/lib/fluidDebugger.js +3 -0
  27. package/lib/fluidDebugger.js.map +1 -1
  28. package/lib/fluidDebuggerController.d.ts +6 -1
  29. package/lib/fluidDebuggerController.d.ts.map +1 -1
  30. package/lib/fluidDebuggerController.js +6 -3
  31. package/lib/fluidDebuggerController.js.map +1 -1
  32. package/lib/fluidDebuggerUi.d.ts +9 -0
  33. package/lib/fluidDebuggerUi.d.ts.map +1 -1
  34. package/lib/fluidDebuggerUi.js +25 -22
  35. package/lib/fluidDebuggerUi.js.map +1 -1
  36. package/lib/sanitizer.d.ts.map +1 -1
  37. package/lib/sanitizer.js +3 -1
  38. package/lib/sanitizer.js.map +1 -1
  39. package/lib/test/types/validateDebuggerPrevious.generated.js.map +1 -1
  40. package/package.json +17 -18
  41. package/src/fluidDebugger.ts +3 -0
  42. package/src/fluidDebuggerController.ts +10 -5
  43. package/src/fluidDebuggerUi.ts +9 -0
  44. package/src/sanitizer.ts +2 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/debugger",
3
- "version": "2.0.0-dev.6.4.0.192049",
3
+ "version": "2.0.0-dev.7.2.0.203917",
4
4
  "description": "Fluid Debugger - a tool to play through history of a file",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -15,26 +15,25 @@
15
15
  "module": "lib/index.js",
16
16
  "types": "dist/index.d.ts",
17
17
  "dependencies": {
18
- "@fluidframework/core-utils": "2.0.0-dev.6.4.0.192049",
19
- "@fluidframework/driver-definitions": "2.0.0-dev.6.4.0.192049",
20
- "@fluidframework/driver-utils": "2.0.0-dev.6.4.0.192049",
21
- "@fluidframework/protocol-definitions": "^1.1.0",
22
- "@fluidframework/replay-driver": "2.0.0-dev.6.4.0.192049",
18
+ "@fluidframework/core-utils": "2.0.0-dev.7.2.0.203917",
19
+ "@fluidframework/driver-definitions": "2.0.0-dev.7.2.0.203917",
20
+ "@fluidframework/driver-utils": "2.0.0-dev.7.2.0.203917",
21
+ "@fluidframework/protocol-definitions": "^3.0.0",
22
+ "@fluidframework/replay-driver": "2.0.0-dev.7.2.0.203917",
23
23
  "jsonschema": "^1.2.6"
24
24
  },
25
25
  "devDependencies": {
26
- "@fluid-tools/build-cli": "^0.22.0",
27
- "@fluidframework/build-common": "^2.0.0",
28
- "@fluidframework/build-tools": "^0.22.0",
29
- "@fluidframework/debugger-previous": "npm:@fluidframework/debugger@2.0.0-internal.6.3.0",
30
- "@fluidframework/eslint-config-fluid": "^2.1.0",
31
- "@microsoft/api-extractor": "^7.34.4",
26
+ "@fluid-tools/build-cli": "0.26.0-203096",
27
+ "@fluidframework/build-common": "^2.0.2",
28
+ "@fluidframework/build-tools": "0.26.0-203096",
29
+ "@fluidframework/debugger-previous": "npm:@fluidframework/debugger@2.0.0-internal.7.1.0",
30
+ "@fluidframework/eslint-config-fluid": "^3.0.0",
31
+ "@microsoft/api-extractor": "^7.37.0",
32
32
  "@types/node": "^16.18.38",
33
- "copyfiles": "^2.4.1",
34
- "eslint": "~8.6.0",
35
- "prettier": "~2.6.2",
33
+ "eslint": "~8.50.0",
34
+ "prettier": "~3.0.3",
36
35
  "rimraf": "^4.4.0",
37
- "typescript": "~4.5.5"
36
+ "typescript": "~5.1.6"
38
37
  },
39
38
  "fluidBuild": {
40
39
  "tasks": {
@@ -50,9 +49,9 @@
50
49
  "scripts": {
51
50
  "build": "fluid-build . --task build",
52
51
  "build:compile": "fluid-build . --task compile",
53
- "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
52
+ "build:docs": "api-extractor run --local",
54
53
  "build:esnext": "tsc --project ./tsconfig.esnext.json",
55
- "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
54
+ "ci:build:docs": "api-extractor run",
56
55
  "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp'",
57
56
  "eslint": "eslint --format stylish src",
58
57
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -8,6 +8,9 @@ import { ReplayDocumentService, ReplayDocumentServiceFactory } from "@fluidframe
8
8
  import { DebugReplayController } from "./fluidDebuggerController";
9
9
  import { DebuggerUI } from "./fluidDebuggerUi";
10
10
 
11
+ /**
12
+ * @public
13
+ */
11
14
  // eslint-disable-next-line @typescript-eslint/no-namespace
12
15
  export namespace FluidDebugger {
13
16
  /**
@@ -26,18 +26,21 @@ import {
26
26
  import { IDebuggerController, IDebuggerUI } from "./fluidDebuggerUi";
27
27
  import { Sanitizer } from "./sanitizer";
28
28
 
29
+ /**
30
+ * @public
31
+ */
32
+ // eslint-disable-next-line @rushstack/no-new-null
29
33
  export type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
30
34
 
31
35
  /**
32
36
  * Replay controller that uses pop-up window to control op playback
37
+ *
38
+ * @public
33
39
  */
34
40
  export class DebugReplayController extends ReplayController implements IDebuggerController {
41
+ // eslint-disable-next-line @rushstack/no-new-null
35
42
  public static create(createUi: debuggerUIFactory): DebugReplayController | null {
36
- if (
37
- typeof localStorage === "object" &&
38
- localStorage !== null &&
39
- localStorage.FluidDebugger
40
- ) {
43
+ if (typeof localStorage === "object" && localStorage?.FluidDebugger) {
41
44
  const controller = new DebugReplayController();
42
45
  const ui = createUi(controller);
43
46
  if (ui) {
@@ -275,6 +278,7 @@ export class DebugReplayController extends ReplayController implements IDebugger
275
278
  throw new Error("Reading blob before storage is setup properly");
276
279
  }
277
280
 
281
+ // eslint-disable-next-line @rushstack/no-new-null
278
282
  public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
279
283
  if (this.storage !== undefined) {
280
284
  return this.storage.getVersions(versionId, count);
@@ -282,6 +286,7 @@ export class DebugReplayController extends ReplayController implements IDebugger
282
286
  throw new Error("initStorage() was not called!");
283
287
  }
284
288
 
289
+ // eslint-disable-next-line @rushstack/no-new-null
285
290
  public async getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null> {
286
291
  if (this.storage !== undefined) {
287
292
  return this.storage.getSnapshotTree(versionRequested);
@@ -6,6 +6,9 @@
6
6
  import { assert } from "@fluidframework/core-utils";
7
7
  import { ISequencedDocumentMessage, IVersion } from "@fluidframework/protocol-definitions";
8
8
 
9
+ /**
10
+ * @public
11
+ */
9
12
  export interface IDebuggerUI {
10
13
  /**
11
14
  * Version information is provided.
@@ -56,6 +59,9 @@ export interface IDebuggerUI {
56
59
  updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
57
60
  }
58
61
 
62
+ /**
63
+ * @public
64
+ */
59
65
  export interface IDebuggerController {
60
66
  /**
61
67
  * Initialization. UI layers calls into controller to connect the two.
@@ -132,6 +138,9 @@ Step to move: <input type='number' id='steps' value='1' min='1' style='width:50p
132
138
  <button type='button' id='downloadOps'>Download ops</button>
133
139
  </body>`;
134
140
 
141
+ /**
142
+ * @public
143
+ */
135
144
  export class DebuggerUI {
136
145
  public static create(controller: IDebuggerController): DebuggerUI | null {
137
146
  if (
package/src/sanitizer.ts CHANGED
@@ -331,8 +331,10 @@ export class Sanitizer {
331
331
  * @param excludedKeys - object keys for which to skip replacement when not in fullScrub
332
332
  */
333
333
  replaceObject(
334
+ // eslint-disable-next-line @rushstack/no-new-null
334
335
  input: object | null,
335
336
  excludedKeys: Set<string> = this.defaultExcludedKeys,
337
+ // eslint-disable-next-line @rushstack/no-new-null
336
338
  ): object | null {
337
339
  // File might contain actual nulls
338
340
  if (input === null || input === undefined) {