@fluidframework/runtime-utils 2.0.0-dev-rc.5.0.0.267932 → 2.0.0-dev-rc.5.0.0.268409

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 (4) hide show
  1. package/api-report/{runtime-utils.api.md → runtime-utils.alpha.api.md} +1 -128
  2. package/api-report/runtime-utils.beta.api.md +44 -0
  3. package/api-report/runtime-utils.public.api.md +44 -0
  4. package/package.json +14 -14
package/api-report/{runtime-utils.api.md → runtime-utils.alpha.api.md} RENAMED
@@ -1,4 +1,4 @@
1
- ## API Report File for "@fluidframework/runtime-utils"
1
+ ## Alpha API Report File for "@fluidframework/runtime-utils"
2
2
 
3
3
  > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
4
 
@@ -39,47 +39,12 @@ import { SummaryObject } from '@fluidframework/driver-definitions';
39
39
  import { SummaryType } from '@fluidframework/driver-definitions';
40
40
  import type { TelemetryEventPropertyTypeExt } from '@fluidframework/telemetry-utils/internal';
41
41
 
42
- // @internal (undocumented)
43
- export function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
44
-
45
- // @internal (undocumented)
46
- export function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
47
-
48
- // @internal (undocumented)
49
- export function calculateStats(summary: SummaryObject): ISummaryStats;
50
-
51
- // @internal
52
- export function convertSnapshotTreeToSummaryTree(snapshot: ISnapshotTreeWithBlobContents): ISummaryTreeWithStats;
53
-
54
- // @internal
55
- export function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree;
56
-
57
- // @internal
58
- export function convertToSummaryTree(snapshot: ITree, fullTree?: boolean): ISummarizeResult;
59
-
60
42
  // @alpha
61
43
  export function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
62
44
 
63
45
  // @alpha (undocumented)
64
46
  export const create404Response: (request: IRequest) => IResponse;
65
47
 
66
- // @internal (undocumented)
67
- export function createDataStoreFactory(type: string, factory: Factory | Promise<Factory>): IFluidDataStoreFactory & IFluidDataStoreRegistry;
68
-
69
- // @internal (undocumented)
70
- export function createResponseError(status: number, value: string, request: IRequest, headers?: {
71
- [key: string]: any;
72
- }): IResponse;
73
-
74
- // @internal
75
- export function encodeCompactIdToString(idArg: number | string, prefix?: string): string;
76
-
77
- // @internal (undocumented)
78
- export function exceptionToResponse(err: any): IResponse;
79
-
80
- // @internal (undocumented)
81
- export type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;
82
-
83
48
  // @alpha
84
49
  export abstract class FluidHandleBase<T> implements IFluidHandleInternal<T> {
85
50
  // (undocumented)
@@ -97,75 +62,6 @@ export abstract class FluidHandleBase<T> implements IFluidHandleInternal<T> {
97
62
  abstract readonly isAttached: boolean;
98
63
  }
99
64
 
100
- // @internal
101
- export class GCDataBuilder implements IGarbageCollectionData {
102
- // (undocumented)
103
- addNode(id: string, outboundRoutes: string[]): void;
104
- // (undocumented)
105
- addNodes(gcNodes: {
106
- [id: string]: string[];
107
- }): void;
108
- addRouteToAllNodes(outboundRoute: string): void;
109
- // (undocumented)
110
- get gcNodes(): {
111
- [id: string]: string[];
112
- };
113
- // (undocumented)
114
- getGCData(): IGarbageCollectionData;
115
- prefixAndAddNodes(prefixId: string, gcNodes: {
116
- [id: string]: string[];
117
- }): void;
118
- }
119
-
120
- // @internal
121
- export function generateHandleContextPath(path: string, routeContext?: IFluidHandleContext): string;
122
-
123
- // @internal (undocumented)
124
- export function getBlobSize(content: ISummaryBlob["content"]): number;
125
-
126
- // @internal (undocumented)
127
- export function getNormalizedObjectStoragePathParts(path: string): string[];
128
-
129
- // @internal
130
- export interface ISerializedHandle {
131
- // (undocumented)
132
- type: "__fluid_handle__";
133
- // (undocumented)
134
- url: string;
135
- }
136
-
137
- // @internal
138
- export function isFluidHandle(value: unknown): value is IFluidHandle;
139
-
140
- // @internal
141
- export const isSerializedHandle: (value: any) => value is ISerializedHandle;
142
-
143
- // @internal
144
- export function isSnapshotFetchRequiredForLoadingGroupId(snapshotTree: ISnapshotTree, blobContents: Map<string, ArrayBuffer>): boolean;
145
-
146
- // @internal (undocumented)
147
- export function listBlobsAtTreePath(inputTree: ITree | undefined, path: string): Promise<string[]>;
148
-
149
- // @internal
150
- export function mergeStats(...stats: ISummaryStats[]): ISummaryStats;
151
-
152
- // @internal
153
- export class ObjectStoragePartition implements IChannelStorageService {
154
- constructor(storage: IChannelStorageService, path: string);
155
- // (undocumented)
156
- contains(path: string): Promise<boolean>;
157
- // (undocumented)
158
- list(path: string): Promise<string[]>;
159
- // (undocumented)
160
- readBlob(path: string): Promise<ArrayBufferLike>;
161
- }
162
-
163
- // @internal
164
- export function processAttachMessageGCData(snapshot: ITree | null, addedGCOutboundRoute: (fromNodeId: string, toPath: string) => void): boolean;
165
-
166
- // @internal
167
- export type ReadAndParseBlob = <T>(id: string) => Promise<T>;
168
-
169
65
  // @alpha
170
66
  export class RequestParser implements IRequest {
171
67
  protected constructor(request: Readonly<IRequest>);
@@ -183,9 +79,6 @@ export class RequestParser implements IRequest {
183
79
  get url(): string;
184
80
  }
185
81
 
186
- // @internal (undocumented)
187
- export function responseToException(response: IResponse, request: IRequest): Error;
188
-
189
82
  // @alpha (undocumented)
190
83
  export abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {
191
84
  // (undocumented)
@@ -202,9 +95,6 @@ export abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRu
202
95
  abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
203
96
  }
204
97
 
205
- // @internal
206
- export function seqFromTree(tree: ISnapshotTree, readAndParseBlob: ReadAndParseBlob): Promise<number>;
207
-
208
98
  // @alpha (undocumented)
209
99
  export class SummaryTreeBuilder implements ISummaryTreeWithStats {
210
100
  constructor();
@@ -224,17 +114,6 @@ export class SummaryTreeBuilder implements ISummaryTreeWithStats {
224
114
  get summary(): ISummaryTree;
225
115
  }
226
116
 
227
- // @internal (undocumented)
228
- export class TelemetryContext implements ITelemetryContext, ITelemetryContextExt {
229
- get(prefix: string, property: string): TelemetryEventPropertyTypeExt;
230
- serialize(): string;
231
- set(prefix: string, property: string, value: TelemetryEventPropertyTypeExt): void;
232
- setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyTypeExt>): void;
233
- }
234
-
235
- // @internal
236
- export function toDeltaManagerErased(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>): IDeltaManagerErased;
237
-
238
117
  // @alpha
239
118
  export function toDeltaManagerInternal(deltaManager: IDeltaManagerErased): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
240
119
 
@@ -244,12 +123,6 @@ export function toFluidHandleErased<T>(handle: IFluidHandleInternal<T>): IFluidH
244
123
  // @alpha
245
124
  export function toFluidHandleInternal<T>(handle: IFluidHandle<T>): IFluidHandleInternal<T>;
246
125
 
247
- // @internal
248
- export function unpackChildNodesUsedRoutes(usedRoutes: readonly string[]): Map<string, string[]>;
249
-
250
- // @internal (undocumented)
251
- export function utf8ByteLength(str: string): number;
252
-
253
126
  // (No @packageDocumentation comment for this package)
254
127
 
255
128
  ```
package/api-report/runtime-utils.beta.api.md ADDED
@@ -0,0 +1,44 @@
1
+ ## Beta API Report File for "@fluidframework/runtime-utils"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { fluidHandleSymbol } from '@fluidframework/core-interfaces';
8
+ import { IChannelStorageService } from '@fluidframework/datastore-definitions/internal';
9
+ import { IContainerContext } from '@fluidframework/container-definitions/internal';
10
+ import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
11
+ import type { IDeltaManager } from '@fluidframework/container-definitions/internal';
12
+ import type { IDeltaManagerErased } from '@fluidframework/datastore-definitions/internal';
13
+ import type { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
14
+ import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
15
+ import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
16
+ import { IFluidHandle } from '@fluidframework/core-interfaces';
17
+ import { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
18
+ import type { IFluidHandleErased } from '@fluidframework/core-interfaces';
19
+ import type { IFluidHandleInternal } from '@fluidframework/core-interfaces/internal';
20
+ import { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
21
+ import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
22
+ import { IRequest } from '@fluidframework/core-interfaces';
23
+ import { IRequestHeader } from '@fluidframework/core-interfaces';
24
+ import { IResponse } from '@fluidframework/core-interfaces';
25
+ import { IRuntime } from '@fluidframework/container-definitions/internal';
26
+ import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
27
+ import type { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
28
+ import { ISnapshotTree } from '@fluidframework/driver-definitions/internal';
29
+ import { ISnapshotTreeWithBlobContents } from '@fluidframework/container-definitions/internal';
30
+ import { ISummarizeResult } from '@fluidframework/runtime-definitions/internal';
31
+ import { ISummaryBlob } from '@fluidframework/driver-definitions';
32
+ import { ISummaryStats } from '@fluidframework/runtime-definitions/internal';
33
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
34
+ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
35
+ import { ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
36
+ import { ITelemetryContextExt } from '@fluidframework/runtime-definitions/internal';
37
+ import { ITree } from '@fluidframework/driver-definitions/internal';
38
+ import { SummaryObject } from '@fluidframework/driver-definitions';
39
+ import { SummaryType } from '@fluidframework/driver-definitions';
40
+ import type { TelemetryEventPropertyTypeExt } from '@fluidframework/telemetry-utils/internal';
41
+
42
+ // (No @packageDocumentation comment for this package)
43
+
44
+ ```
package/api-report/runtime-utils.public.api.md ADDED
@@ -0,0 +1,44 @@
1
+ ## Public API Report File for "@fluidframework/runtime-utils"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { fluidHandleSymbol } from '@fluidframework/core-interfaces';
8
+ import { IChannelStorageService } from '@fluidframework/datastore-definitions/internal';
9
+ import { IContainerContext } from '@fluidframework/container-definitions/internal';
10
+ import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
11
+ import type { IDeltaManager } from '@fluidframework/container-definitions/internal';
12
+ import type { IDeltaManagerErased } from '@fluidframework/datastore-definitions/internal';
13
+ import type { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
14
+ import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
15
+ import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
16
+ import { IFluidHandle } from '@fluidframework/core-interfaces';
17
+ import { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
18
+ import type { IFluidHandleErased } from '@fluidframework/core-interfaces';
19
+ import type { IFluidHandleInternal } from '@fluidframework/core-interfaces/internal';
20
+ import { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
21
+ import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
22
+ import { IRequest } from '@fluidframework/core-interfaces';
23
+ import { IRequestHeader } from '@fluidframework/core-interfaces';
24
+ import { IResponse } from '@fluidframework/core-interfaces';
25
+ import { IRuntime } from '@fluidframework/container-definitions/internal';
26
+ import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
27
+ import type { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
28
+ import { ISnapshotTree } from '@fluidframework/driver-definitions/internal';
29
+ import { ISnapshotTreeWithBlobContents } from '@fluidframework/container-definitions/internal';
30
+ import { ISummarizeResult } from '@fluidframework/runtime-definitions/internal';
31
+ import { ISummaryBlob } from '@fluidframework/driver-definitions';
32
+ import { ISummaryStats } from '@fluidframework/runtime-definitions/internal';
33
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
34
+ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
35
+ import { ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
36
+ import { ITelemetryContextExt } from '@fluidframework/runtime-definitions/internal';
37
+ import { ITree } from '@fluidframework/driver-definitions/internal';
38
+ import { SummaryObject } from '@fluidframework/driver-definitions';
39
+ import { SummaryType } from '@fluidframework/driver-definitions';
40
+ import type { TelemetryEventPropertyTypeExt } from '@fluidframework/telemetry-utils/internal';
41
+
42
+ // (No @packageDocumentation comment for this package)
43
+
44
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/runtime-utils",
3
- "version": "2.0.0-dev-rc.5.0.0.267932",
3
+ "version": "2.0.0-dev-rc.5.0.0.268409",
4
4
  "description": "Collection of utility functions for Fluid Runtime",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -67,25 +67,25 @@
67
67
  "temp-directory": "nyc/.nyc_output"
68
68
  },
69
69
  "dependencies": {
70
- "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.267932",
71
- "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.267932",
72
- "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.5.0.0.267932",
73
- "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.267932",
74
- "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.267932",
75
- "@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.267932",
76
- "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.267932",
77
- "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.267932",
78
- "@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.267932",
79
- "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.267932"
70
+ "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.268409",
71
+ "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.268409",
72
+ "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.5.0.0.268409",
73
+ "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.268409",
74
+ "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.268409",
75
+ "@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.268409",
76
+ "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.268409",
77
+ "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.268409",
78
+ "@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.268409",
79
+ "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.268409"
80
80
  },
81
81
  "devDependencies": {
82
82
  "@arethetypeswrong/cli": "^0.15.2",
83
- "@biomejs/biome": "^1.6.2",
84
- "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.267932",
83
+ "@biomejs/biome": "^1.7.3",
84
+ "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.268409",
85
85
  "@fluid-tools/build-cli": "^0.39.0-264124",
86
86
  "@fluidframework/build-common": "^2.0.3",
87
87
  "@fluidframework/build-tools": "^0.39.0-264124",
88
- "@fluidframework/eslint-config-fluid": "^5.1.0",
88
+ "@fluidframework/eslint-config-fluid": "^5.3.0",
89
89
  "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0-rc.4.0.0",
90
90
  "@microsoft/api-extractor": "^7.45.1",
91
91
  "@types/mocha": "^9.1.1",