@fluidframework/runtime-utils 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.0

package/src/index.ts

@@ -21,7 +21,10 @@ export {
 	FluidHandleBase,
 } from "./handles.js";
 export { ObjectStoragePartition } from "./objectstoragepartition.js";
-export { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from "./objectstorageutils.js";
+export {
+	getNormalizedObjectStoragePathParts,
+	listBlobsAtTreePath,
+} from "./objectstorageutils.js";
 export { RequestParser } from "./requestParser.js";
 export { RuntimeFactoryHelper } from "./runtimeFactoryHelper.js";
 export {

package/src/objectstoragepartition.ts

@@ -4,7 +4,7 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
-import { IChannelStorageService } from "@fluidframework/datastore-definitions";
+import { IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
 
 /**
  * Returns a new IChannelStorageService that resolves the given `path` as root.

package/src/objectstorageutils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ITree } from "@fluidframework/protocol-definitions";
+import { ITree } from "@fluidframework/driver-definitions/internal";
 
 /**
  * @internal

package/src/snapshotUtils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { ISnapshotTree } from "@fluidframework/protocol-definitions";
+import type { ISnapshotTree } from "@fluidframework/driver-definitions/internal";
 
 /**
  * Utility function to check if any blobs under a snapshot tree is missing and if so, then return

package/src/summaryUtils.ts

@@ -10,29 +10,29 @@ import {
 	fromBase64ToUtf8,
 } from "@fluid-internal/client-utils";
 import { ISnapshotTreeWithBlobContents } from "@fluidframework/container-definitions/internal";
-import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
-import {
-	AttachmentTreeEntry,
-	BlobTreeEntry,
-	TreeTreeEntry,
-} from "@fluidframework/driver-utils/internal";
 import {
 	ISummaryBlob,
 	ISummaryTree,
-	ITree,
-	ITreeEntry,
 	SummaryObject,
 	SummaryType,
-	TreeEntry,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions";
+import { ITree, ITreeEntry, TreeEntry } from "@fluidframework/driver-definitions/internal";
+import {
+	AttachmentTreeEntry,
+	BlobTreeEntry,
+	TreeTreeEntry,
+} from "@fluidframework/driver-utils/internal";
 import {
-	IGarbageCollectionData,
 	ISummaryStats,
 	ISummaryTreeWithStats,
 	ITelemetryContext,
-} from "@fluidframework/runtime-definitions";
-import { ISummarizeResult } from "@fluidframework/runtime-definitions/internal";
+	IGarbageCollectionData,
+	ISummarizeResult,
+	ITelemetryContextExt,
+	gcDataBlobKey,
+} from "@fluidframework/runtime-definitions/internal";
+import type { TelemetryEventPropertyTypeExt } from "@fluidframework/telemetry-utils/internal";
 
 /**
  * Combines summary stats by adding their totals together.
@@ -229,9 +229,7 @@ export function convertToSummaryTreeWithStats(
 			case TreeEntry.Blob: {
 				const blob = entry.value;
 				const content =
-					blob.encoding === "base64"
-						? IsoBuffer.from(blob.contents, "base64")
-						: blob.contents;
+					blob.encoding === "base64" ? IsoBuffer.from(blob.contents, "base64") : blob.contents;
 				builder.addBlob(entry.path, content);
 				break;
 			}
@@ -267,7 +265,10 @@ export function convertToSummaryTreeWithStats(
  * @param fullTree - true to never use handles, even if id is specified
  * @internal
  */
-export function convertToSummaryTree(snapshot: ITree, fullTree: boolean = false): ISummarizeResult {
+export function convertToSummaryTree(
+	snapshot: ITree,
+	fullTree: boolean = false,
+): ISummarizeResult {
 	// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
 	if (snapshot.id && !fullTree) {
 		const stats = mergeStats();
@@ -387,7 +388,7 @@ export function processAttachMessageGCData(
 	snapshot: ITree | null,
 	addedGCOutboundRoute: (fromNodeId: string, toPath: string) => void,
 ): boolean {
-	const gcDataEntry = snapshot?.entries.find((e) => e.path === ".gcdata");
+	const gcDataEntry = snapshot?.entries.find((e) => e.path === gcDataBlobKey);
 
 	// Old attach messages won't have GC Data
 	// (And REALLY old DataStore Attach messages won't even have a snapshot!)
@@ -412,13 +413,13 @@ export function processAttachMessageGCData(
 /**
  * @internal
  */
-export class TelemetryContext implements ITelemetryContext {
-	private readonly telemetry = new Map<string, TelemetryBaseEventPropertyType>();
+export class TelemetryContext implements ITelemetryContext, ITelemetryContextExt {
+	private readonly telemetry = new Map<string, TelemetryEventPropertyTypeExt>();
 
 	/**
 	 * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.set}
 	 */
-	set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void {
+	set(prefix: string, property: string, value: TelemetryEventPropertyTypeExt): void {
 		this.telemetry.set(`${prefix}${property}`, value);
 	}
 
@@ -428,7 +429,7 @@ export class TelemetryContext implements ITelemetryContext {
 	setMultiple(
 		prefix: string,
 		property: string,
-		values: Record<string, TelemetryBaseEventPropertyType>,
+		values: Record<string, TelemetryEventPropertyTypeExt>,
 	): void {
 		// Set the values individually so that they are logged as a flat list along with other properties.
 		for (const key of Object.keys(values)) {
@@ -439,7 +440,7 @@ export class TelemetryContext implements ITelemetryContext {
 	/**
 	 * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.get}
 	 */
-	get(prefix: string, property: string): TelemetryBaseEventPropertyType {
+	get(prefix: string, property: string): TelemetryEventPropertyTypeExt {
 		return this.telemetry.get(`${prefix}${property}`);
 	}
 

package/src/utils.ts

@@ -4,7 +4,10 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
-import { IDocumentAttributes, ISnapshotTree } from "@fluidframework/protocol-definitions";
+import {
+	IDocumentAttributes,
+	ISnapshotTree,
+} from "@fluidframework/driver-definitions/internal";
 
 /**
  * Reads a blob from storage and parses it from JSON.

package/tsconfig.json

@@ -5,5 +5,7 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
+		"noUncheckedIndexedAccess": false,
+		"exactOptionalPropertyTypes": false,
 	},
 }

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"extends": ["../../../common/build/build-common/tsdoc-base.json"]
+}

package/api-report/runtime-utils.api.md

@@ -1,254 +0,0 @@
-## API Report File for "@fluidframework/runtime-utils"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { fluidHandleSymbol } from '@fluidframework/core-interfaces';
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IContainerContext } from '@fluidframework/container-definitions/internal';
-import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
-import type { IDeltaManager } from '@fluidframework/container-definitions/internal';
-import type { IDeltaManagerErased } from '@fluidframework/datastore-definitions';
-import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IFluidHandle } from '@fluidframework/core-interfaces';
-import { IFluidHandleContext } from '@fluidframework/core-interfaces';
-import type { IFluidHandleErased } from '@fluidframework/core-interfaces/internal';
-import type { IFluidHandleInternal } from '@fluidframework/core-interfaces/internal';
-import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
-import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { IRuntime } from '@fluidframework/container-definitions/internal';
-import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
-import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISnapshotTreeWithBlobContents } from '@fluidframework/container-definitions/internal';
-import { ISummarizeResult } from '@fluidframework/runtime-definitions/internal';
-import { ISummaryBlob } from '@fluidframework/protocol-definitions';
-import { ISummaryStats } from '@fluidframework/runtime-definitions';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { ITelemetryContext } from '@fluidframework/runtime-definitions';
-import { ITree } from '@fluidframework/protocol-definitions';
-import { SummaryObject } from '@fluidframework/protocol-definitions';
-import { SummaryType } from '@fluidframework/protocol-definitions';
-import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
-
-// @internal (undocumented)
-export function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
-
-// @internal (undocumented)
-export function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
-
-// @internal (undocumented)
-export function calculateStats(summary: SummaryObject): ISummaryStats;
-
-// @internal
-export function convertSnapshotTreeToSummaryTree(snapshot: ISnapshotTreeWithBlobContents): ISummaryTreeWithStats;
-
-// @internal
-export function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree;
-
-// @internal
-export function convertToSummaryTree(snapshot: ITree, fullTree?: boolean): ISummarizeResult;
-
-// @alpha
-export function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
-
-// @alpha (undocumented)
-export const create404Response: (request: IRequest) => IResponse;
-
-// @internal (undocumented)
-export function createDataStoreFactory(type: string, factory: Factory | Promise<Factory>): IFluidDataStoreFactory & IFluidDataStoreRegistry;
-
-// @internal (undocumented)
-export function createResponseError(status: number, value: string, request: IRequest, headers?: {
-    [key: string]: any;
-}): IResponse;
-
-// @internal
-export function encodeCompactIdToString(idArg: number | string, prefix?: string): string;
-
-// @internal (undocumented)
-export function exceptionToResponse(err: any): IResponse;
-
-// @internal (undocumented)
-export type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;
-
-// @alpha
-export abstract class FluidHandleBase<T> implements IFluidHandleInternal<T> {
-    // (undocumented)
-    get [fluidHandleSymbol](): IFluidHandleErased<T>;
-    // (undocumented)
-    abstract absolutePath: string;
-    // (undocumented)
-    abstract attachGraph(): void;
-    // (undocumented)
-    abstract bind(handle: IFluidHandleInternal): void;
-    // (undocumented)
-    abstract get(): Promise<T>;
-    get IFluidHandle(): IFluidHandleInternal;
-    // (undocumented)
-    abstract readonly isAttached: boolean;
-}
-
-// @internal
-export class GCDataBuilder implements IGarbageCollectionData {
-    // (undocumented)
-    addNode(id: string, outboundRoutes: string[]): void;
-    // (undocumented)
-    addNodes(gcNodes: {
-        [id: string]: string[];
-    }): void;
-    addRouteToAllNodes(outboundRoute: string): void;
-    // (undocumented)
-    get gcNodes(): {
-        [id: string]: string[];
-    };
-    // (undocumented)
-    getGCData(): IGarbageCollectionData;
-    prefixAndAddNodes(prefixId: string, gcNodes: {
-        [id: string]: string[];
-    }): void;
-}
-
-// @internal
-export function generateHandleContextPath(path: string, routeContext?: IFluidHandleContext): string;
-
-// @internal (undocumented)
-export function getBlobSize(content: ISummaryBlob["content"]): number;
-
-// @internal (undocumented)
-export function getNormalizedObjectStoragePathParts(path: string): string[];
-
-// @internal
-export interface ISerializedHandle {
-    // (undocumented)
-    type: "__fluid_handle__";
-    // (undocumented)
-    url: string;
-}
-
-// @internal
-export function isFluidHandle(value: unknown): value is IFluidHandle;
-
-// @internal
-export const isSerializedHandle: (value: any) => value is ISerializedHandle;
-
-// @internal
-export function isSnapshotFetchRequiredForLoadingGroupId(snapshotTree: ISnapshotTree, blobContents: Map<string, ArrayBuffer>): boolean;
-
-// @internal (undocumented)
-export function listBlobsAtTreePath(inputTree: ITree | undefined, path: string): Promise<string[]>;
-
-// @internal
-export function mergeStats(...stats: ISummaryStats[]): ISummaryStats;
-
-// @internal
-export class ObjectStoragePartition implements IChannelStorageService {
-    constructor(storage: IChannelStorageService, path: string);
-    // (undocumented)
-    contains(path: string): Promise<boolean>;
-    // (undocumented)
-    list(path: string): Promise<string[]>;
-    // (undocumented)
-    readBlob(path: string): Promise<ArrayBufferLike>;
-}
-
-// @internal
-export function processAttachMessageGCData(snapshot: ITree | null, addedGCOutboundRoute: (fromNodeId: string, toPath: string) => void): boolean;
-
-// @internal
-export type ReadAndParseBlob = <T>(id: string) => Promise<T>;
-
-// @alpha
-export class RequestParser implements IRequest {
-    protected constructor(request: Readonly<IRequest>);
-    // (undocumented)
-    static create(request: Readonly<IRequest>): RequestParser;
-    createSubRequest(startingPathIndex: number): IRequest;
-    static getPathParts(url: string): readonly string[];
-    // (undocumented)
-    get headers(): IRequestHeader | undefined;
-    isLeaf(elements: number): boolean;
-    get pathParts(): readonly string[];
-    // (undocumented)
-    readonly query: string;
-    // (undocumented)
-    get url(): string;
-}
-
-// @internal (undocumented)
-export function responseToException(response: IResponse, request: IRequest): Error;
-
-// @alpha (undocumented)
-export abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {
-    // (undocumented)
-    hasInitialized(_runtime: T): Promise<void>;
-    // (undocumented)
-    instantiateFirstTime(_runtime: T): Promise<void>;
-    // (undocumented)
-    instantiateFromExisting(_runtime: T): Promise<void>;
-    // (undocumented)
-    instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
-    // (undocumented)
-    get IRuntimeFactory(): this;
-    // (undocumented)
-    abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
-}
-
-// @internal
-export function seqFromTree(tree: ISnapshotTree, readAndParseBlob: ReadAndParseBlob): Promise<number>;
-
-// @alpha (undocumented)
-export class SummaryTreeBuilder implements ISummaryTreeWithStats {
-    constructor();
-    // (undocumented)
-    addAttachment(id: string): void;
-    // (undocumented)
-    addBlob(key: string, content: string | Uint8Array): void;
-    // (undocumented)
-    addHandle(key: string, handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment, handle: string): void;
-    // (undocumented)
-    addWithStats(key: string, summarizeResult: ISummarizeResult): void;
-    // (undocumented)
-    getSummaryTree(): ISummaryTreeWithStats;
-    // (undocumented)
-    get stats(): Readonly<ISummaryStats>;
-    // (undocumented)
-    get summary(): ISummaryTree;
-}
-
-// @internal (undocumented)
-export class TelemetryContext implements ITelemetryContext {
-    get(prefix: string, property: string): TelemetryBaseEventPropertyType;
-    serialize(): string;
-    set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
-    setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
-}
-
-// @internal
-export function toDeltaManagerErased(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>): IDeltaManagerErased;
-
-// @alpha
-export function toDeltaManagerInternal(deltaManager: IDeltaManagerErased): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
-
-// @alpha
-export function toFluidHandleErased<T>(handle: IFluidHandleInternal<T>): IFluidHandleErased<T>;
-
-// @alpha
-export function toFluidHandleInternal<T>(handle: IFluidHandle<T>): IFluidHandleInternal<T>;
-
-// @internal
-export function unpackChildNodesUsedRoutes(usedRoutes: readonly string[]): Map<string, string[]>;
-
-// @internal (undocumented)
-export function utf8ByteLength(str: string): number;
-
-// (No @packageDocumentation comment for this package)
-
-```