@fluidframework/runtime-utils 2.0.0-rc.1.0.3 → 2.0.0-rc.2.0.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 (117) hide show
  1. package/{.eslintrc.js → .eslintrc.cjs} +4 -1
  2. package/{.mocharc.js → .mocharc.cjs} +1 -1
  3. package/CHANGELOG.md +30 -0
  4. package/{api-extractor-esm.json → api-extractor-cjs.json} +5 -1
  5. package/api-extractor-lint.json +1 -1
  6. package/api-extractor.json +1 -1
  7. package/api-report/runtime-utils.api.md +10 -11
  8. package/dist/index.d.ts +10 -10
  9. package/dist/index.d.ts.map +1 -1
  10. package/dist/index.js +40 -39
  11. package/dist/index.js.map +1 -1
  12. package/dist/package.json +3 -0
  13. package/dist/runtime-utils-alpha.d.ts +5 -3
  14. package/dist/runtime-utils-beta.d.ts +5 -3
  15. package/dist/runtime-utils-public.d.ts +5 -3
  16. package/dist/runtime-utils-untrimmed.d.ts +34 -9
  17. package/dist/summaryUtils.d.ts +18 -8
  18. package/dist/summaryUtils.d.ts.map +1 -1
  19. package/dist/summaryUtils.js +34 -9
  20. package/dist/summaryUtils.js.map +1 -1
  21. package/dist/tsdoc-metadata.json +1 -1
  22. package/dist/utils.d.ts +14 -0
  23. package/dist/utils.d.ts.map +1 -1
  24. package/dist/utils.js +49 -1
  25. package/dist/utils.js.map +1 -1
  26. package/lib/{dataStoreHandleContextUtils.d.mts → dataStoreHandleContextUtils.d.ts} +1 -1
  27. package/lib/dataStoreHandleContextUtils.d.ts.map +1 -0
  28. package/lib/{dataStoreHandleContextUtils.mjs → dataStoreHandleContextUtils.js} +1 -1
  29. package/lib/dataStoreHandleContextUtils.js.map +1 -0
  30. package/lib/{dataStoreHelpers.d.mts → dataStoreHelpers.d.ts} +1 -1
  31. package/lib/dataStoreHelpers.d.ts.map +1 -0
  32. package/lib/{dataStoreHelpers.mjs → dataStoreHelpers.js} +1 -1
  33. package/lib/dataStoreHelpers.js.map +1 -0
  34. package/lib/{handles.d.mts → handles.d.ts} +1 -1
  35. package/lib/handles.d.ts.map +1 -0
  36. package/lib/{handles.mjs → handles.js} +1 -1
  37. package/lib/handles.js.map +1 -0
  38. package/lib/index.d.ts +15 -0
  39. package/lib/index.d.ts.map +1 -0
  40. package/lib/index.js +15 -0
  41. package/lib/index.js.map +1 -0
  42. package/lib/{objectstoragepartition.d.mts → objectstoragepartition.d.ts} +1 -1
  43. package/lib/objectstoragepartition.d.ts.map +1 -0
  44. package/lib/{objectstoragepartition.mjs → objectstoragepartition.js} +1 -1
  45. package/lib/objectstoragepartition.js.map +1 -0
  46. package/lib/{objectstorageutils.d.mts → objectstorageutils.d.ts} +1 -1
  47. package/lib/objectstorageutils.d.ts.map +1 -0
  48. package/lib/{objectstorageutils.mjs → objectstorageutils.js} +1 -1
  49. package/lib/objectstorageutils.js.map +1 -0
  50. package/lib/{requestParser.d.mts → requestParser.d.ts} +5 -1
  51. package/lib/requestParser.d.ts.map +1 -0
  52. package/lib/{requestParser.mjs → requestParser.js} +1 -1
  53. package/lib/requestParser.js.map +1 -0
  54. package/lib/{runtime-utils-alpha.d.mts → runtime-utils-alpha.d.ts} +5 -3
  55. package/lib/{runtime-utils-beta.d.mts → runtime-utils-beta.d.ts} +5 -3
  56. package/lib/{runtime-utils-public.d.mts → runtime-utils-public.d.ts} +5 -3
  57. package/lib/{runtime-utils-untrimmed.d.mts → runtime-utils-untrimmed.d.ts} +34 -9
  58. package/lib/{runtimeFactoryHelper.d.mts → runtimeFactoryHelper.d.ts} +1 -1
  59. package/lib/runtimeFactoryHelper.d.ts.map +1 -0
  60. package/lib/{runtimeFactoryHelper.mjs → runtimeFactoryHelper.js} +1 -1
  61. package/lib/runtimeFactoryHelper.js.map +1 -0
  62. package/lib/{summaryUtils.d.mts → summaryUtils.d.ts} +19 -9
  63. package/lib/summaryUtils.d.ts.map +1 -0
  64. package/lib/{summaryUtils.mjs → summaryUtils.js} +34 -9
  65. package/lib/summaryUtils.js.map +1 -0
  66. package/lib/test/dataStoreHelpers.spec.js +29 -0
  67. package/lib/test/dataStoreHelpers.spec.js.map +1 -0
  68. package/lib/test/requestParser.spec.js +111 -0
  69. package/lib/test/requestParser.spec.js.map +1 -0
  70. package/lib/test/runtimeFactoryHelper.spec.js +44 -0
  71. package/lib/test/runtimeFactoryHelper.spec.js.map +1 -0
  72. package/lib/test/summaryUtils.spec.js +283 -0
  73. package/lib/test/summaryUtils.spec.js.map +1 -0
  74. package/lib/test/types/validateRuntimeUtilsPrevious.generated.js +58 -0
  75. package/lib/test/types/validateRuntimeUtilsPrevious.generated.js.map +1 -0
  76. package/lib/test/utils.spec.js +65 -0
  77. package/lib/test/utils.spec.js.map +1 -0
  78. package/lib/{unpackUsedRoutes.d.mts → unpackUsedRoutes.d.ts} +1 -1
  79. package/lib/unpackUsedRoutes.d.ts.map +1 -0
  80. package/lib/{unpackUsedRoutes.mjs → unpackUsedRoutes.js} +1 -1
  81. package/lib/unpackUsedRoutes.js.map +1 -0
  82. package/lib/utils.d.ts +34 -0
  83. package/lib/utils.d.ts.map +1 -0
  84. package/lib/utils.js +64 -0
  85. package/lib/utils.js.map +1 -0
  86. package/package.json +48 -49
  87. package/src/index.ts +11 -11
  88. package/src/summaryUtils.ts +48 -18
  89. package/src/utils.ts +48 -0
  90. package/tsconfig.cjs.json +7 -0
  91. package/tsconfig.json +2 -5
  92. package/lib/dataStoreHandleContextUtils.d.mts.map +0 -1
  93. package/lib/dataStoreHandleContextUtils.mjs.map +0 -1
  94. package/lib/dataStoreHelpers.d.mts.map +0 -1
  95. package/lib/dataStoreHelpers.mjs.map +0 -1
  96. package/lib/handles.d.mts.map +0 -1
  97. package/lib/handles.mjs.map +0 -1
  98. package/lib/index.d.mts +0 -15
  99. package/lib/index.d.mts.map +0 -1
  100. package/lib/index.mjs +0 -15
  101. package/lib/index.mjs.map +0 -1
  102. package/lib/objectstoragepartition.d.mts.map +0 -1
  103. package/lib/objectstoragepartition.mjs.map +0 -1
  104. package/lib/objectstorageutils.d.mts.map +0 -1
  105. package/lib/objectstorageutils.mjs.map +0 -1
  106. package/lib/requestParser.d.mts.map +0 -1
  107. package/lib/requestParser.mjs.map +0 -1
  108. package/lib/runtimeFactoryHelper.d.mts.map +0 -1
  109. package/lib/runtimeFactoryHelper.mjs.map +0 -1
  110. package/lib/summaryUtils.d.mts.map +0 -1
  111. package/lib/summaryUtils.mjs.map +0 -1
  112. package/lib/unpackUsedRoutes.d.mts.map +0 -1
  113. package/lib/unpackUsedRoutes.mjs.map +0 -1
  114. package/lib/utils.d.mts +0 -20
  115. package/lib/utils.d.mts.map +0 -1
  116. package/lib/utils.mjs +0 -17
  117. package/lib/utils.mjs.map +0 -1
@@ -4,7 +4,10 @@
4
4
  */
5
5
 
6
6
  module.exports = {
7
- extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
7
+ extends: [
8
+ require.resolve("@fluidframework/eslint-config-fluid/minimal-deprecated"),
9
+ "prettier",
10
+ ],
8
11
  parserOptions: {
9
12
  project: ["./tsconfig.json", "./src/test/tsconfig.json"],
10
13
  },
@@ -5,7 +5,7 @@
5
5
 
6
6
  "use strict";
7
7
 
8
- const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
8
+ const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
9
9
 
10
10
  const packageDir = __dirname;
11
11
  const config = getFluidTestMochaConfig(packageDir);
package/CHANGELOG.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # @fluidframework/runtime-utils
2
2
 
3
+ ## 2.0.0-rc.2.0.0
4
+
5
+ ### Minor Changes
6
+
7
+ - container-runtime: New feature: ID compression for DataStores & DDSs ([#19859](https://github.com/microsoft/FluidFramework/issues/19859)) [51f0d3db73](https://github.com/microsoft/FluidFramework/commits/51f0d3db737800e1c30ea5e3952d38ff30ffc7da)
8
+
9
+ ### Key changes
10
+
11
+ 1. A new API IContainerRuntimeBase.generateDocumentUniqueId() is exposed. This API will opportunistically generate IDs in short format (non-negative numbers). If it can't achieve that, it will return UUID strings. UUIDs generated will have low entropy in groups and will compress well. It can be leveraged anywhere in container where container unique IDs are required. I.e. any place that uses uuid() and stores data in container is likely candidate to start leveraging this API.
12
+ 2. Data store internal IDs (IDs that are auto generated by FF system) will opportunistically be generated in shorter form. Data stores created in detached container will always have short IDs, data stores created in attached container will opportunistically be short (by using newly added IContainerRuntimeBase.generateDocumentUniqueId() capability)
13
+ 3. Similar DDS names will be opportunistically short (same considerations for detached DDS vs. attached DDS)
14
+
15
+ ### Implementation details
16
+
17
+ 1. Container level ID Compressor can now be enabled with delay. With such setting, only new IContainerRuntimeBase.generateDocumentUniqueId() is exposed (ID Compressor is not exposed in such case, as leveraging any of its other capabilities requires future container sessions to load ID Compressor on container load, for correctness reasons). Once Container establishes connection and any changes are made in container, newly added API will start generating more compact IDs (in most cases).
18
+
19
+ ### Breaking changes
20
+
21
+ 1. DDS names can no longer start with "\_" symbol - this is reserved for FF needs. I've validated that's not an issue for AzureClient (it only creates root object by name, everything else is referred by handle). Our main internal partners almost never use named DDSs (I can find only 4 instances in Loop).
22
+
23
+ ### Backward compatibility considerations
24
+
25
+ 1. Data store internal IDs could collide with earlier used names data stores. Earlier versions of FF framework (before DataStore aliasing feature was added) allowed customers to supply IDs for data stores. And thus, files created with earlier versions of framework could have data store IDs that will be similar to names FF will use for newly created data stores ("A", ... "Z", "a"..."z", "AA", etc.). While such collision is possible, it's very unlikely (almost impossible) if user-provided names were at least 4-5 characters long.
26
+ 2. If application runs to these problems, or wants to reduce risks, consider disabling ID compressor via IContainerRuntimeOptions.enableRuntimeIdCompressor = "off".
27
+
28
+ ### Minor changes
29
+
30
+ 1. IContainerRuntime.createDetachedRootDataStore() is removed. Please use IContainerRuntime.createDetachedDataStore and IDataStore.trySetAlias() instead
31
+ 2. IContainerRuntimeOptions.enableRuntimeIdCompressor has been changes from boolean to tri-state.
32
+
3
33
  ## 2.0.0-rc.1.0.0
4
34
 
5
35
  ### Minor Changes
@@ -1,4 +1,8 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base-esm.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
4
+ // CJS is actually secondary; so, no report.
5
+ "apiReport": {
6
+ "enabled": false
7
+ }
4
8
  }
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-lint.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
4
4
  }
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
4
4
  }
@@ -28,7 +28,7 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
28
28
  import { ITree } from '@fluidframework/protocol-definitions';
29
29
  import { SummaryObject } from '@fluidframework/protocol-definitions';
30
30
  import { SummaryType } from '@fluidframework/protocol-definitions';
31
- import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
31
+ import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
32
32
 
33
33
  // @internal (undocumented)
34
34
  export function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
@@ -36,9 +36,6 @@ export function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, co
36
36
  // @internal (undocumented)
37
37
  export function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
38
38
 
39
- // @internal (undocumented)
40
- export function addTreeToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
41
-
42
39
  // @internal (undocumented)
43
40
  export function calculateStats(summary: SummaryObject): ISummaryStats;
44
41
 
@@ -65,6 +62,9 @@ export function createResponseError(status: number, value: string, request: IReq
65
62
  [key: string]: any;
66
63
  }): IResponse;
67
64
 
65
+ // @internal
66
+ export function encodeCompactIdToString(idArg: number | string, prefix?: string): string;
67
+
68
68
  // @internal (undocumented)
69
69
  export function exceptionToResponse(err: any): IResponse;
70
70
 
@@ -128,6 +128,9 @@ export class ObjectStoragePartition implements IChannelStorageService {
128
128
  readBlob(path: string): Promise<ArrayBufferLike>;
129
129
  }
130
130
 
131
+ // @internal
132
+ export function processAttachMessageGCData(snapshot: ITree | null, addedGCOutboundRoute: (fromNodeId: string, toPath: string) => void): boolean;
133
+
131
134
  // @internal
132
135
  export type ReadAndParseBlob = <T>(id: string) => Promise<T>;
133
136
 
@@ -191,14 +194,10 @@ export class SummaryTreeBuilder implements ISummaryTreeWithStats {
191
194
 
192
195
  // @internal (undocumented)
193
196
  export class TelemetryContext implements ITelemetryContext {
194
- // (undocumented)
195
- get(prefix: string, property: string): TelemetryEventPropertyType;
196
- // (undocumented)
197
+ get(prefix: string, property: string): TelemetryBaseEventPropertyType;
197
198
  serialize(): string;
198
- // (undocumented)
199
- set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
200
- // (undocumented)
201
- setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
199
+ set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
200
+ setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
202
201
  }
203
202
 
204
203
  // @internal
package/dist/index.d.ts CHANGED
@@ -2,14 +2,14 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export { generateHandleContextPath } from "./dataStoreHandleContextUtils";
6
- export { create404Response, createDataStoreFactory, createResponseError, exceptionToResponse, Factory, responseToException, } from "./dataStoreHelpers";
7
- export { ISerializedHandle, isSerializedHandle } from "./handles";
8
- export { ObjectStoragePartition } from "./objectstoragepartition";
9
- export { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from "./objectstorageutils";
10
- export { RequestParser } from "./requestParser";
11
- export { RuntimeFactoryHelper } from "./runtimeFactoryHelper";
12
- export { addBlobToSummary, addSummarizeResultToSummary, addTreeToSummary, calculateStats, convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, convertToSummaryTree, convertToSummaryTreeWithStats, GCDataBuilder, getBlobSize, mergeStats, SummaryTreeBuilder, TelemetryContext, utf8ByteLength, } from "./summaryUtils";
13
- export { unpackChildNodesUsedRoutes } from "./unpackUsedRoutes";
14
- export { ReadAndParseBlob, seqFromTree } from "./utils";
5
+ export { generateHandleContextPath } from "./dataStoreHandleContextUtils.js";
6
+ export { create404Response, createDataStoreFactory, createResponseError, exceptionToResponse, Factory, responseToException, } from "./dataStoreHelpers.js";
7
+ export { ISerializedHandle, isSerializedHandle } from "./handles.js";
8
+ export { ObjectStoragePartition } from "./objectstoragepartition.js";
9
+ export { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from "./objectstorageutils.js";
10
+ export { RequestParser } from "./requestParser.js";
11
+ export { RuntimeFactoryHelper } from "./runtimeFactoryHelper.js";
12
+ export { addBlobToSummary, addSummarizeResultToSummary, calculateStats, convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, convertToSummaryTree, convertToSummaryTreeWithStats, GCDataBuilder, getBlobSize, mergeStats, processAttachMessageGCData, SummaryTreeBuilder, TelemetryContext, utf8ByteLength, } from "./summaryUtils.js";
13
+ export { unpackChildNodesUsedRoutes } from "./unpackUsedRoutes.js";
14
+ export { ReadAndParseBlob, seqFromTree, encodeCompactIdToString } from "./utils.js";
15
15
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,OAAO,EACP,mBAAmB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,gBAAgB,EAChB,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,aAAa,EACb,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EACN,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,OAAO,EACP,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnG,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,aAAa,EACb,WAAW,EACX,UAAU,EACV,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC"}
package/dist/index.js CHANGED
@@ -4,43 +4,44 @@
4
4
  * Licensed under the MIT License.
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.seqFromTree = exports.unpackChildNodesUsedRoutes = exports.utf8ByteLength = exports.TelemetryContext = exports.SummaryTreeBuilder = exports.mergeStats = exports.getBlobSize = exports.GCDataBuilder = exports.convertToSummaryTreeWithStats = exports.convertToSummaryTree = exports.convertSummaryTreeToITree = exports.convertSnapshotTreeToSummaryTree = exports.calculateStats = exports.addTreeToSummary = exports.addSummarizeResultToSummary = exports.addBlobToSummary = exports.RuntimeFactoryHelper = exports.RequestParser = exports.listBlobsAtTreePath = exports.getNormalizedObjectStoragePathParts = exports.ObjectStoragePartition = exports.isSerializedHandle = exports.responseToException = exports.exceptionToResponse = exports.createResponseError = exports.createDataStoreFactory = exports.create404Response = exports.generateHandleContextPath = void 0;
8
- var dataStoreHandleContextUtils_1 = require("./dataStoreHandleContextUtils");
9
- Object.defineProperty(exports, "generateHandleContextPath", { enumerable: true, get: function () { return dataStoreHandleContextUtils_1.generateHandleContextPath; } });
10
- var dataStoreHelpers_1 = require("./dataStoreHelpers");
11
- Object.defineProperty(exports, "create404Response", { enumerable: true, get: function () { return dataStoreHelpers_1.create404Response; } });
12
- Object.defineProperty(exports, "createDataStoreFactory", { enumerable: true, get: function () { return dataStoreHelpers_1.createDataStoreFactory; } });
13
- Object.defineProperty(exports, "createResponseError", { enumerable: true, get: function () { return dataStoreHelpers_1.createResponseError; } });
14
- Object.defineProperty(exports, "exceptionToResponse", { enumerable: true, get: function () { return dataStoreHelpers_1.exceptionToResponse; } });
15
- Object.defineProperty(exports, "responseToException", { enumerable: true, get: function () { return dataStoreHelpers_1.responseToException; } });
16
- var handles_1 = require("./handles");
17
- Object.defineProperty(exports, "isSerializedHandle", { enumerable: true, get: function () { return handles_1.isSerializedHandle; } });
18
- var objectstoragepartition_1 = require("./objectstoragepartition");
19
- Object.defineProperty(exports, "ObjectStoragePartition", { enumerable: true, get: function () { return objectstoragepartition_1.ObjectStoragePartition; } });
20
- var objectstorageutils_1 = require("./objectstorageutils");
21
- Object.defineProperty(exports, "getNormalizedObjectStoragePathParts", { enumerable: true, get: function () { return objectstorageutils_1.getNormalizedObjectStoragePathParts; } });
22
- Object.defineProperty(exports, "listBlobsAtTreePath", { enumerable: true, get: function () { return objectstorageutils_1.listBlobsAtTreePath; } });
23
- var requestParser_1 = require("./requestParser");
24
- Object.defineProperty(exports, "RequestParser", { enumerable: true, get: function () { return requestParser_1.RequestParser; } });
25
- var runtimeFactoryHelper_1 = require("./runtimeFactoryHelper");
26
- Object.defineProperty(exports, "RuntimeFactoryHelper", { enumerable: true, get: function () { return runtimeFactoryHelper_1.RuntimeFactoryHelper; } });
27
- var summaryUtils_1 = require("./summaryUtils");
28
- Object.defineProperty(exports, "addBlobToSummary", { enumerable: true, get: function () { return summaryUtils_1.addBlobToSummary; } });
29
- Object.defineProperty(exports, "addSummarizeResultToSummary", { enumerable: true, get: function () { return summaryUtils_1.addSummarizeResultToSummary; } });
30
- Object.defineProperty(exports, "addTreeToSummary", { enumerable: true, get: function () { return summaryUtils_1.addTreeToSummary; } });
31
- Object.defineProperty(exports, "calculateStats", { enumerable: true, get: function () { return summaryUtils_1.calculateStats; } });
32
- Object.defineProperty(exports, "convertSnapshotTreeToSummaryTree", { enumerable: true, get: function () { return summaryUtils_1.convertSnapshotTreeToSummaryTree; } });
33
- Object.defineProperty(exports, "convertSummaryTreeToITree", { enumerable: true, get: function () { return summaryUtils_1.convertSummaryTreeToITree; } });
34
- Object.defineProperty(exports, "convertToSummaryTree", { enumerable: true, get: function () { return summaryUtils_1.convertToSummaryTree; } });
35
- Object.defineProperty(exports, "convertToSummaryTreeWithStats", { enumerable: true, get: function () { return summaryUtils_1.convertToSummaryTreeWithStats; } });
36
- Object.defineProperty(exports, "GCDataBuilder", { enumerable: true, get: function () { return summaryUtils_1.GCDataBuilder; } });
37
- Object.defineProperty(exports, "getBlobSize", { enumerable: true, get: function () { return summaryUtils_1.getBlobSize; } });
38
- Object.defineProperty(exports, "mergeStats", { enumerable: true, get: function () { return summaryUtils_1.mergeStats; } });
39
- Object.defineProperty(exports, "SummaryTreeBuilder", { enumerable: true, get: function () { return summaryUtils_1.SummaryTreeBuilder; } });
40
- Object.defineProperty(exports, "TelemetryContext", { enumerable: true, get: function () { return summaryUtils_1.TelemetryContext; } });
41
- Object.defineProperty(exports, "utf8ByteLength", { enumerable: true, get: function () { return summaryUtils_1.utf8ByteLength; } });
42
- var unpackUsedRoutes_1 = require("./unpackUsedRoutes");
43
- Object.defineProperty(exports, "unpackChildNodesUsedRoutes", { enumerable: true, get: function () { return unpackUsedRoutes_1.unpackChildNodesUsedRoutes; } });
44
- var utils_1 = require("./utils");
45
- Object.defineProperty(exports, "seqFromTree", { enumerable: true, get: function () { return utils_1.seqFromTree; } });
7
+ exports.encodeCompactIdToString = exports.seqFromTree = exports.unpackChildNodesUsedRoutes = exports.utf8ByteLength = exports.TelemetryContext = exports.SummaryTreeBuilder = exports.processAttachMessageGCData = exports.mergeStats = exports.getBlobSize = exports.GCDataBuilder = exports.convertToSummaryTreeWithStats = exports.convertToSummaryTree = exports.convertSummaryTreeToITree = exports.convertSnapshotTreeToSummaryTree = exports.calculateStats = exports.addSummarizeResultToSummary = exports.addBlobToSummary = exports.RuntimeFactoryHelper = exports.RequestParser = exports.listBlobsAtTreePath = exports.getNormalizedObjectStoragePathParts = exports.ObjectStoragePartition = exports.isSerializedHandle = exports.responseToException = exports.exceptionToResponse = exports.createResponseError = exports.createDataStoreFactory = exports.create404Response = exports.generateHandleContextPath = void 0;
8
+ var dataStoreHandleContextUtils_js_1 = require("./dataStoreHandleContextUtils.js");
9
+ Object.defineProperty(exports, "generateHandleContextPath", { enumerable: true, get: function () { return dataStoreHandleContextUtils_js_1.generateHandleContextPath; } });
10
+ var dataStoreHelpers_js_1 = require("./dataStoreHelpers.js");
11
+ Object.defineProperty(exports, "create404Response", { enumerable: true, get: function () { return dataStoreHelpers_js_1.create404Response; } });
12
+ Object.defineProperty(exports, "createDataStoreFactory", { enumerable: true, get: function () { return dataStoreHelpers_js_1.createDataStoreFactory; } });
13
+ Object.defineProperty(exports, "createResponseError", { enumerable: true, get: function () { return dataStoreHelpers_js_1.createResponseError; } });
14
+ Object.defineProperty(exports, "exceptionToResponse", { enumerable: true, get: function () { return dataStoreHelpers_js_1.exceptionToResponse; } });
15
+ Object.defineProperty(exports, "responseToException", { enumerable: true, get: function () { return dataStoreHelpers_js_1.responseToException; } });
16
+ var handles_js_1 = require("./handles.js");
17
+ Object.defineProperty(exports, "isSerializedHandle", { enumerable: true, get: function () { return handles_js_1.isSerializedHandle; } });
18
+ var objectstoragepartition_js_1 = require("./objectstoragepartition.js");
19
+ Object.defineProperty(exports, "ObjectStoragePartition", { enumerable: true, get: function () { return objectstoragepartition_js_1.ObjectStoragePartition; } });
20
+ var objectstorageutils_js_1 = require("./objectstorageutils.js");
21
+ Object.defineProperty(exports, "getNormalizedObjectStoragePathParts", { enumerable: true, get: function () { return objectstorageutils_js_1.getNormalizedObjectStoragePathParts; } });
22
+ Object.defineProperty(exports, "listBlobsAtTreePath", { enumerable: true, get: function () { return objectstorageutils_js_1.listBlobsAtTreePath; } });
23
+ var requestParser_js_1 = require("./requestParser.js");
24
+ Object.defineProperty(exports, "RequestParser", { enumerable: true, get: function () { return requestParser_js_1.RequestParser; } });
25
+ var runtimeFactoryHelper_js_1 = require("./runtimeFactoryHelper.js");
26
+ Object.defineProperty(exports, "RuntimeFactoryHelper", { enumerable: true, get: function () { return runtimeFactoryHelper_js_1.RuntimeFactoryHelper; } });
27
+ var summaryUtils_js_1 = require("./summaryUtils.js");
28
+ Object.defineProperty(exports, "addBlobToSummary", { enumerable: true, get: function () { return summaryUtils_js_1.addBlobToSummary; } });
29
+ Object.defineProperty(exports, "addSummarizeResultToSummary", { enumerable: true, get: function () { return summaryUtils_js_1.addSummarizeResultToSummary; } });
30
+ Object.defineProperty(exports, "calculateStats", { enumerable: true, get: function () { return summaryUtils_js_1.calculateStats; } });
31
+ Object.defineProperty(exports, "convertSnapshotTreeToSummaryTree", { enumerable: true, get: function () { return summaryUtils_js_1.convertSnapshotTreeToSummaryTree; } });
32
+ Object.defineProperty(exports, "convertSummaryTreeToITree", { enumerable: true, get: function () { return summaryUtils_js_1.convertSummaryTreeToITree; } });
33
+ Object.defineProperty(exports, "convertToSummaryTree", { enumerable: true, get: function () { return summaryUtils_js_1.convertToSummaryTree; } });
34
+ Object.defineProperty(exports, "convertToSummaryTreeWithStats", { enumerable: true, get: function () { return summaryUtils_js_1.convertToSummaryTreeWithStats; } });
35
+ Object.defineProperty(exports, "GCDataBuilder", { enumerable: true, get: function () { return summaryUtils_js_1.GCDataBuilder; } });
36
+ Object.defineProperty(exports, "getBlobSize", { enumerable: true, get: function () { return summaryUtils_js_1.getBlobSize; } });
37
+ Object.defineProperty(exports, "mergeStats", { enumerable: true, get: function () { return summaryUtils_js_1.mergeStats; } });
38
+ Object.defineProperty(exports, "processAttachMessageGCData", { enumerable: true, get: function () { return summaryUtils_js_1.processAttachMessageGCData; } });
39
+ Object.defineProperty(exports, "SummaryTreeBuilder", { enumerable: true, get: function () { return summaryUtils_js_1.SummaryTreeBuilder; } });
40
+ Object.defineProperty(exports, "TelemetryContext", { enumerable: true, get: function () { return summaryUtils_js_1.TelemetryContext; } });
41
+ Object.defineProperty(exports, "utf8ByteLength", { enumerable: true, get: function () { return summaryUtils_js_1.utf8ByteLength; } });
42
+ var unpackUsedRoutes_js_1 = require("./unpackUsedRoutes.js");
43
+ Object.defineProperty(exports, "unpackChildNodesUsedRoutes", { enumerable: true, get: function () { return unpackUsedRoutes_js_1.unpackChildNodesUsedRoutes; } });
44
+ var utils_js_1 = require("./utils.js");
45
+ Object.defineProperty(exports, "seqFromTree", { enumerable: true, get: function () { return utils_js_1.seqFromTree; } });
46
+ Object.defineProperty(exports, "encodeCompactIdToString", { enumerable: true, get: function () { return utils_js_1.encodeCompactIdToString; } });
46
47
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6EAA0E;AAAjE,wIAAA,yBAAyB,OAAA;AAClC,uDAO4B;AAN3B,qHAAA,iBAAiB,OAAA;AACjB,0HAAA,sBAAsB,OAAA;AACtB,uHAAA,mBAAmB,OAAA;AACnB,uHAAA,mBAAmB,OAAA;AAEnB,uHAAA,mBAAmB,OAAA;AAEpB,qCAAkE;AAAtC,6GAAA,kBAAkB,OAAA;AAC9C,mEAAkE;AAAzD,gIAAA,sBAAsB,OAAA;AAC/B,2DAAgG;AAAvF,yIAAA,mCAAmC,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AACjE,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,+DAA8D;AAArD,4HAAA,oBAAoB,OAAA;AAC7B,+CAewB;AAdvB,gHAAA,gBAAgB,OAAA;AAChB,2HAAA,2BAA2B,OAAA;AAC3B,gHAAA,gBAAgB,OAAA;AAChB,8GAAA,cAAc,OAAA;AACd,gIAAA,gCAAgC,OAAA;AAChC,yHAAA,yBAAyB,OAAA;AACzB,oHAAA,oBAAoB,OAAA;AACpB,6HAAA,6BAA6B,OAAA;AAC7B,6GAAA,aAAa,OAAA;AACb,2GAAA,WAAW,OAAA;AACX,0GAAA,UAAU,OAAA;AACV,kHAAA,kBAAkB,OAAA;AAClB,gHAAA,gBAAgB,OAAA;AAChB,8GAAA,cAAc,OAAA;AAEf,uDAAgE;AAAvD,8HAAA,0BAA0B,OAAA;AACnC,iCAAwD;AAA7B,oGAAA,WAAW,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { generateHandleContextPath } from \"./dataStoreHandleContextUtils\";\nexport {\n\tcreate404Response,\n\tcreateDataStoreFactory,\n\tcreateResponseError,\n\texceptionToResponse,\n\tFactory,\n\tresponseToException,\n} from \"./dataStoreHelpers\";\nexport { ISerializedHandle, isSerializedHandle } from \"./handles\";\nexport { ObjectStoragePartition } from \"./objectstoragepartition\";\nexport { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from \"./objectstorageutils\";\nexport { RequestParser } from \"./requestParser\";\nexport { RuntimeFactoryHelper } from \"./runtimeFactoryHelper\";\nexport {\n\taddBlobToSummary,\n\taddSummarizeResultToSummary,\n\taddTreeToSummary,\n\tcalculateStats,\n\tconvertSnapshotTreeToSummaryTree,\n\tconvertSummaryTreeToITree,\n\tconvertToSummaryTree,\n\tconvertToSummaryTreeWithStats,\n\tGCDataBuilder,\n\tgetBlobSize,\n\tmergeStats,\n\tSummaryTreeBuilder,\n\tTelemetryContext,\n\tutf8ByteLength,\n} from \"./summaryUtils\";\nexport { unpackChildNodesUsedRoutes } from \"./unpackUsedRoutes\";\nexport { ReadAndParseBlob, seqFromTree } from \"./utils\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mFAA6E;AAApE,2IAAA,yBAAyB,OAAA;AAClC,6DAO+B;AAN9B,wHAAA,iBAAiB,OAAA;AACjB,6HAAA,sBAAsB,OAAA;AACtB,0HAAA,mBAAmB,OAAA;AACnB,0HAAA,mBAAmB,OAAA;AAEnB,0HAAA,mBAAmB,OAAA;AAEpB,2CAAqE;AAAzC,gHAAA,kBAAkB,OAAA;AAC9C,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAC/B,iEAAmG;AAA1F,4IAAA,mCAAmC,OAAA;AAAE,4HAAA,mBAAmB,OAAA;AACjE,uDAAmD;AAA1C,iHAAA,aAAa,OAAA;AACtB,qEAAiE;AAAxD,+HAAA,oBAAoB,OAAA;AAC7B,qDAe2B;AAd1B,mHAAA,gBAAgB,OAAA;AAChB,8HAAA,2BAA2B,OAAA;AAC3B,iHAAA,cAAc,OAAA;AACd,mIAAA,gCAAgC,OAAA;AAChC,4HAAA,yBAAyB,OAAA;AACzB,uHAAA,oBAAoB,OAAA;AACpB,gIAAA,6BAA6B,OAAA;AAC7B,gHAAA,aAAa,OAAA;AACb,8GAAA,WAAW,OAAA;AACX,6GAAA,UAAU,OAAA;AACV,6HAAA,0BAA0B,OAAA;AAC1B,qHAAA,kBAAkB,OAAA;AAClB,mHAAA,gBAAgB,OAAA;AAChB,iHAAA,cAAc,OAAA;AAEf,6DAAmE;AAA1D,iIAAA,0BAA0B,OAAA;AACnC,uCAAoF;AAAzD,uGAAA,WAAW,OAAA;AAAE,mHAAA,uBAAuB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { generateHandleContextPath } from \"./dataStoreHandleContextUtils.js\";\nexport {\n\tcreate404Response,\n\tcreateDataStoreFactory,\n\tcreateResponseError,\n\texceptionToResponse,\n\tFactory,\n\tresponseToException,\n} from \"./dataStoreHelpers.js\";\nexport { ISerializedHandle, isSerializedHandle } from \"./handles.js\";\nexport { ObjectStoragePartition } from \"./objectstoragepartition.js\";\nexport { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from \"./objectstorageutils.js\";\nexport { RequestParser } from \"./requestParser.js\";\nexport { RuntimeFactoryHelper } from \"./runtimeFactoryHelper.js\";\nexport {\n\taddBlobToSummary,\n\taddSummarizeResultToSummary,\n\tcalculateStats,\n\tconvertSnapshotTreeToSummaryTree,\n\tconvertSummaryTreeToITree,\n\tconvertToSummaryTree,\n\tconvertToSummaryTreeWithStats,\n\tGCDataBuilder,\n\tgetBlobSize,\n\tmergeStats,\n\tprocessAttachMessageGCData,\n\tSummaryTreeBuilder,\n\tTelemetryContext,\n\tutf8ByteLength,\n} from \"./summaryUtils.js\";\nexport { unpackChildNodesUsedRoutes } from \"./unpackUsedRoutes.js\";\nexport { ReadAndParseBlob, seqFromTree, encodeCompactIdToString } from \"./utils.js\";\n"]}
@@ -0,0 +1,3 @@
1
+ {
2
+ "type": "commonjs"
3
+ }
@@ -22,14 +22,12 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
22
22
  import { ITree } from '@fluidframework/protocol-definitions';
23
23
  import { SummaryObject } from '@fluidframework/protocol-definitions';
24
24
  import { SummaryType } from '@fluidframework/protocol-definitions';
25
- import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
25
+ import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
26
26
 
27
27
  /* Excluded from this release type: addBlobToSummary */
28
28
 
29
29
  /* Excluded from this release type: addSummarizeResultToSummary */
30
30
 
31
- /* Excluded from this release type: addTreeToSummary */
32
-
33
31
  /* Excluded from this release type: calculateStats */
34
32
 
35
33
  /* Excluded from this release type: convertSnapshotTreeToSummaryTree */
@@ -52,6 +50,8 @@ export declare function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?
52
50
 
53
51
  /* Excluded from this release type: createResponseError */
54
52
 
53
+ /* Excluded from this release type: encodeCompactIdToString */
54
+
55
55
  /* Excluded from this release type: exceptionToResponse */
56
56
 
57
57
  /* Excluded from this release type: Factory */
@@ -74,6 +74,8 @@ export declare function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?
74
74
 
75
75
  /* Excluded from this release type: ObjectStoragePartition */
76
76
 
77
+ /* Excluded from this release type: processAttachMessageGCData */
78
+
77
79
  /* Excluded from this release type: ReadAndParseBlob */
78
80
 
79
81
  /**
@@ -22,14 +22,12 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
22
22
  import { ITree } from '@fluidframework/protocol-definitions';
23
23
  import { SummaryObject } from '@fluidframework/protocol-definitions';
24
24
  import { SummaryType } from '@fluidframework/protocol-definitions';
25
- import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
25
+ import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
26
26
 
27
27
  /* Excluded from this release type: addBlobToSummary */
28
28
 
29
29
  /* Excluded from this release type: addSummarizeResultToSummary */
30
30
 
31
- /* Excluded from this release type: addTreeToSummary */
32
-
33
31
  /* Excluded from this release type: calculateStats */
34
32
 
35
33
  /* Excluded from this release type: convertSnapshotTreeToSummaryTree */
@@ -46,6 +44,8 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
46
44
 
47
45
  /* Excluded from this release type: createResponseError */
48
46
 
47
+ /* Excluded from this release type: encodeCompactIdToString */
48
+
49
49
  /* Excluded from this release type: exceptionToResponse */
50
50
 
51
51
  /* Excluded from this release type: Factory */
@@ -86,6 +86,8 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
86
86
 
87
87
  /* Excluded from this release type: ObjectStoragePartition */
88
88
 
89
+ /* Excluded from this release type: processAttachMessageGCData */
90
+
89
91
  /* Excluded from this release type: ReadAndParseBlob */
90
92
 
91
93
  /* Excluded from this release type: RequestParser */
@@ -22,14 +22,12 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
22
22
  import { ITree } from '@fluidframework/protocol-definitions';
23
23
  import { SummaryObject } from '@fluidframework/protocol-definitions';
24
24
  import { SummaryType } from '@fluidframework/protocol-definitions';
25
- import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
25
+ import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
26
26
 
27
27
  /* Excluded from this release type: addBlobToSummary */
28
28
 
29
29
  /* Excluded from this release type: addSummarizeResultToSummary */
30
30
 
31
- /* Excluded from this release type: addTreeToSummary */
32
-
33
31
  /* Excluded from this release type: calculateStats */
34
32
 
35
33
  /* Excluded from this release type: convertSnapshotTreeToSummaryTree */
@@ -46,6 +44,8 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
46
44
 
47
45
  /* Excluded from this release type: createResponseError */
48
46
 
47
+ /* Excluded from this release type: encodeCompactIdToString */
48
+
49
49
  /* Excluded from this release type: exceptionToResponse */
50
50
 
51
51
  /* Excluded from this release type: Factory */
@@ -86,6 +86,8 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
86
86
 
87
87
  /* Excluded from this release type: ObjectStoragePartition */
88
88
 
89
+ /* Excluded from this release type: processAttachMessageGCData */
90
+
89
91
  /* Excluded from this release type: ReadAndParseBlob */
90
92
 
91
93
  /* Excluded from this release type: RequestParser */
@@ -22,7 +22,7 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
22
22
  import { ITree } from '@fluidframework/protocol-definitions';
23
23
  import { SummaryObject } from '@fluidframework/protocol-definitions';
24
24
  import { SummaryType } from '@fluidframework/protocol-definitions';
25
- import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
25
+ import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
26
26
 
27
27
  /**
28
28
  * @internal
@@ -34,11 +34,6 @@ export declare function addBlobToSummary(summary: ISummaryTreeWithStats, key: st
34
34
  */
35
35
  export declare function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
36
36
 
37
- /**
38
- * @internal
39
- */
40
- export declare function addTreeToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
41
-
42
37
  /**
43
38
  * @internal
44
39
  */
@@ -92,6 +87,21 @@ export declare function createResponseError(status: number, value: string, reque
92
87
  [key: string]: any;
93
88
  }): IResponse;
94
89
 
90
+ /**
91
+ * Encode compact ID (returned by IContainerRuntime.generateDocumentUniqueId()) to a compact string representation.
92
+ * While this is the main usage pattern, it works with any non-negative integer or a string.
93
+ * Strings are retured as is, and assumed to be UUIDs, i.e. unique enough to never overlap with
94
+ * numbers encoded as strings by this function. Any other strings are likely to run into collisions and should not be used!
95
+ * This function is useful in places where we serialize resulting ID as string and use them as strings, thus we are not
96
+ * gaining any efficiency from having a number type.
97
+ * We do not provide a decode function, so this API is only useful only result is stored and there is no need to go back to origianl form.
98
+ * @param idArg - input - either a non-negative integer or a string. Strings are returned as is, while numbers are encoded in compat form
99
+ * @param prefix - optinal string prefix
100
+ * @returns A string - representation of an input
101
+ * @internal
102
+ */
103
+ export declare function encodeCompactIdToString(idArg: number | string, prefix?: string): string;
104
+
95
105
  /**
96
106
  * @internal
97
107
  */
@@ -191,6 +201,21 @@ export declare class ObjectStoragePartition implements IChannelStorageService {
191
201
  list(path: string): Promise<string[]>;
192
202
  }
193
203
 
204
+ /**
205
+ * Looks in the given attach message snapshot for the .gcdata blob, which would
206
+ * contain the initial GC Data for the node being attached.
207
+ * If it finds it, it notifies GC of all the new outbound routes being added by the attach.
208
+ *
209
+ * @param snapshot - The snapshot from the attach message
210
+ * @param addedGCOutboundRoute - Callback to notify GC of a new outbound route.
211
+ * IMPORTANT: addedGCOutboundRoute's param nodeId is "/" for the attaching node itself, or "/<id>" for its children.
212
+ *
213
+ * @returns true if it found/processed GC Data, false otherwise
214
+ *
215
+ * @internal
216
+ */
217
+ export declare function processAttachMessageGCData(snapshot: ITree | null, addedGCOutboundRoute: (fromNodeId: string, toPath: string) => void): boolean;
218
+
194
219
  /**
195
220
  * Reads a blob from storage and parses it from JSON.
196
221
  *
@@ -290,15 +315,15 @@ export declare class TelemetryContext implements ITelemetryContext {
290
315
  /**
291
316
  * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.set}
292
317
  */
293
- set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
318
+ set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
294
319
  /**
295
320
  * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.setMultiple}
296
321
  */
297
- setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
322
+ setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
298
323
  /**
299
324
  * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.get}
300
325
  */
301
- get(prefix: string, property: string): TelemetryEventPropertyType;
326
+ get(prefix: string, property: string): TelemetryBaseEventPropertyType;
302
327
  /**
303
328
  * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.serialize}
304
329
  */
@@ -2,7 +2,7 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { TelemetryEventPropertyType } from "@fluidframework/core-interfaces";
5
+ import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
6
6
  import { ITree, SummaryType, ISummaryTree, SummaryObject, ISummaryBlob } from "@fluidframework/protocol-definitions";
7
7
  import { ISummaryStats, ISummarizeResult, ISummaryTreeWithStats, ITelemetryContext, IGarbageCollectionData } from "@fluidframework/runtime-definitions";
8
8
  import { ISnapshotTreeWithBlobContents } from "@fluidframework/container-definitions";
@@ -29,10 +29,6 @@ export declare function calculateStats(summary: SummaryObject): ISummaryStats;
29
29
  * @internal
30
30
  */
31
31
  export declare function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
32
- /**
33
- * @internal
34
- */
35
- export declare function addTreeToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
36
32
  /**
37
33
  * @internal
38
34
  */
@@ -80,6 +76,20 @@ export declare function convertSnapshotTreeToSummaryTree(snapshot: ISnapshotTree
80
76
  * @internal
81
77
  */
82
78
  export declare function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree;
79
+ /**
80
+ * Looks in the given attach message snapshot for the .gcdata blob, which would
81
+ * contain the initial GC Data for the node being attached.
82
+ * If it finds it, it notifies GC of all the new outbound routes being added by the attach.
83
+ *
84
+ * @param snapshot - The snapshot from the attach message
85
+ * @param addedGCOutboundRoute - Callback to notify GC of a new outbound route.
86
+ * IMPORTANT: addedGCOutboundRoute's param nodeId is "/" for the attaching node itself, or "/<id>" for its children.
87
+ *
88
+ * @returns true if it found/processed GC Data, false otherwise
89
+ *
90
+ * @internal
91
+ */
92
+ export declare function processAttachMessageGCData(snapshot: ITree | null, addedGCOutboundRoute: (fromNodeId: string, toPath: string) => void): boolean;
83
93
  /**
84
94
  * @internal
85
95
  */
@@ -88,15 +98,15 @@ export declare class TelemetryContext implements ITelemetryContext {
88
98
  /**
89
99
  * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.set}
90
100
  */
91
- set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
101
+ set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
92
102
  /**
93
103
  * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.setMultiple}
94
104
  */
95
- setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
105
+ setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
96
106
  /**
97
107
  * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.get}
98
108
  */
99
- get(prefix: string, property: string): TelemetryEventPropertyType;
109
+ get(prefix: string, property: string): TelemetryBaseEventPropertyType;
100
110
  /**
101
111
  * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.serialize}
102
112
  */
@@ -1 +1 @@
1
- {"version":3,"file":"summaryUtils.d.ts","sourceRoot":"","sources":["../src/summaryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAS7E,OAAO,EACN,KAAK,EACL,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EAGZ,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACN,aAAa,EACb,gBAAgB,EAChB,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAEtF;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,KAAK,EAAE,aAAa,EAAE,GAAG,aAAa,CAgBnE;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAelD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,MAAM,CAEpE;AAyBD;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CAIpE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,GAAG,UAAU,GAC1B,IAAI,CAQN;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,GAC/B,IAAI,CAGN;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAC1C,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,GAC/B,IAAI,CAGN;AAED;;GAEG;AACH,qBAAa,kBAAmB,YAAW,qBAAqB;IAC/D,OAAO,CAAC,iBAAiB,CAAa;IAEtC,IAAW,OAAO,IAAI,YAAY,CAKjC;IAED,IAAW,KAAK,IAAI,QAAQ,CAAC,aAAa,CAAC,CAE1C;;IAOD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;IACrE,OAAO,CAAC,YAAY,CAAgB;IAE7B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAexD,SAAS,CACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,EACxE,MAAM,EAAE,MAAM,GACZ,IAAI;IASA,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,GAAG,IAAI;IAKlE,aAAa,CAAC,EAAE,EAAE,MAAM;IAIxB,cAAc,IAAI,qBAAqB;CAG9C;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC5C,QAAQ,EAAE,KAAK,EACf,QAAQ,GAAE,OAAe,GACvB,qBAAqB,CAoCvB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,GAAE,OAAe,GAAG,gBAAgB,CAgBjG;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC/C,QAAQ,EAAE,6BAA6B,GACrC,qBAAqB,CA2BvB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,YAAY,GAAG,KAAK,CAuC1E;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,iBAAiB;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiD;IAE3E;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B,GAAG,IAAI;IAI9E;;OAEG;IACH,WAAW,CACV,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,GAChD,IAAI;IAOP;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,0BAA0B;IAIjE;;OAEG;IACH,SAAS,IAAI,MAAM;CAOnB;AAoBD;;;GAGG;AACH,qBAAa,aAAc,YAAW,sBAAsB;IAC3D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqC;IAChE,IAAW,OAAO,IAAI;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAM/C;IAEM,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE;IAInD;;;;;OAKG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE;IAevE,QAAQ,CAAC,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE;IAMnD;;OAEG;IACI,kBAAkB,CAAC,aAAa,EAAE,MAAM;IAMxC,SAAS,IAAI,sBAAsB;CAK1C"}
1
+ {"version":3,"file":"summaryUtils.d.ts","sourceRoot":"","sources":["../src/summaryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AAStF,OAAO,EACN,KAAK,EACL,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EAGZ,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACN,aAAa,EACb,gBAAgB,EAChB,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAEtF;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,KAAK,EAAE,aAAa,EAAE,GAAG,aAAa,CAgBnE;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAelD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,MAAM,CAEpE;AAyBD;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CAIpE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,GAAG,UAAU,GAC1B,IAAI,CAQN;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAC1C,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,GAC/B,IAAI,CAGN;AAED;;GAEG;AACH,qBAAa,kBAAmB,YAAW,qBAAqB;IAC/D,OAAO,CAAC,iBAAiB,CAAa;IAEtC,IAAW,OAAO,IAAI,YAAY,CAKjC;IAED,IAAW,KAAK,IAAI,QAAQ,CAAC,aAAa,CAAC,CAE1C;;IAOD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;IACrE,OAAO,CAAC,YAAY,CAAgB;IAE7B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAexD,SAAS,CACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,EACxE,MAAM,EAAE,MAAM,GACZ,IAAI;IASA,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,GAAG,IAAI;IAKlE,aAAa,CAAC,EAAE,EAAE,MAAM;IAIxB,cAAc,IAAI,qBAAqB;CAG9C;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC5C,QAAQ,EAAE,KAAK,EACf,QAAQ,GAAE,OAAe,GACvB,qBAAqB,CAqCvB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,GAAE,OAAe,GAAG,gBAAgB,CAgBjG;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC/C,QAAQ,EAAE,6BAA6B,GACrC,qBAAqB,CA4BvB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,YAAY,GAAG,KAAK,CAwC1E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,0BAA0B,CACzC,QAAQ,EAAE,KAAK,GAAG,IAAI,EACtB,oBAAoB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAChE,OAAO,CAqBT;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,iBAAiB;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqD;IAE/E;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,8BAA8B,GAAG,IAAI;IAIlF;;OAEG;IACH,WAAW,CACV,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,GACpD,IAAI;IAOP;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,8BAA8B;IAIrE;;OAEG;IACH,SAAS,IAAI,MAAM;CAOnB;AAoBD;;;GAGG;AACH,qBAAa,aAAc,YAAW,sBAAsB;IAC3D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqC;IAChE,IAAW,OAAO,IAAI;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAM/C;IAEM,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE;IAInD;;;;;OAKG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE;IAevE,QAAQ,CAAC,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE;IAMnD;;OAEG;IACI,kBAAkB,CAAC,aAAa,EAAE,MAAM;IAMxC,SAAS,IAAI,sBAAsB;CAK1C"}