@fluidframework/odsp-driver 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

package/.eslintrc.js

@@ -4,15 +4,15 @@
  */
 
 module.exports = {
-    "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid")
-    ],
-    "parserOptions": {
-        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
-    },
-    "rules": {
-        "@typescript-eslint/no-non-null-assertion": "off",
-        "@typescript-eslint/no-use-before-define": "off",
-        "@typescript-eslint/strict-boolean-expressions": "off",
-    }
-}
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+	rules: {
+		"@typescript-eslint/no-non-null-assertion": "off",
+		"@typescript-eslint/no-use-before-define": "off",
+		"@typescript-eslint/strict-boolean-expressions": "off",
+		"@rushstack/no-new-null": "error",
+		"import/no-deprecated": "warn", // This package uses the deprecated ShareLinkTypes type. Once we remove that, we can remove this override. It's set as a warning instead of "off" to serve as a reminder.
+	},
+};

package/.mocharc.js

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/CHANGELOG.md

@@ -0,0 +1,162 @@
+# @fluidframework/odsp-driver
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   routerlicious-driver: remove dead blob aggregation concepts and code [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dead concepts blob aggregation like `aggregateBlobsSmallerThanBytes` and `minBlobSize` have been removed.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+### Minor Changes
+
+-   Upcoming: The type of the logger property/param in various APIs will be changing ([#17350](https://github.com/microsoft/FluidFramework/issues/17350)) [27284bcda3](https://github.com/microsoft/FluidFramework/commits/27284bcda3d63cc4306cf76806f8a075db0db60f)
+
+    -   @fluidframework/runtime-definitions
+        -   `IFluidDataStoreRuntime.logger` will be re-typed as `ITelemetryBaseLogger`
+    -   @fluidframework/odsp-driver
+        -   `protected OdspDocumentServiceFactoryCore.createDocumentServiceCore`'s parameter `odspLogger` will be re-typed as `ITelemetryLoggerExt`
+        -   `protected LocalOdspDocumentServiceFactory.createDocumentServiceCore`'s parameter `odspLogger` will be re-typed as `ITelemetryLoggerExt`
+
+    Additionally, several of @fluidframework/telemetry-utils's exports are being marked as internal and should not be consumed outside of other FF packages.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+### Minor Changes
+
+-   Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
+
+    The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
+    imported from the **@fluidframework/core-interfaces** package:
+
+    -   interface IDisposable
+    -   interface IErrorEvent
+    -   interface IErrorEvent
+    -   interface IEvent
+    -   interface IEventProvider
+    -   interface ILoggingError
+    -   interface ITaggedTelemetryPropertyType
+    -   interface ITelemetryBaseEvent
+    -   interface ITelemetryBaseLogger
+    -   interface ITelemetryErrorEvent
+    -   interface ITelemetryGenericEvent
+    -   interface ITelemetryLogger
+    -   interface ITelemetryPerformanceEvent
+    -   interface ITelemetryProperties
+    -   type ExtendEventProvider
+    -   type IEventThisPlaceHolder
+    -   type IEventTransformer
+    -   type ReplaceIEventThisPlaceHolder
+    -   type ReplaceIEventThisPlaceHolder
+    -   type TelemetryEventCategory
+    -   type TelemetryEventPropertyType
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+### Minor Changes
+
+-   New API getRelaySessionInfo in odsp-driver ([#16300](https://github.com/microsoft/FluidFramework/issues/16300)) [a25789cd37](https://github.com/microsoft/FluidFramework/commits/a25789cd37bf60ebc4a08e1a9f7eaa8c65f4eae2)
+
+    `OdspDocumentServiceFactory` and `OdspDocumentServiceFactoryCore` now provide a new API `getRelaySessionInfo` to surface relay session info from cache.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/README.md

@@ -6,3 +6,59 @@ the client and the ODSP server to retrieve Fluid content and connect to the Flui
 The ODSP Fluid service is not a publicly available service, and currently it is not possible to use this driver
 to connect to it. This driver is present as an illustration of a different Fluid driver implementation.
 Developers should not depend on this driver for their own solutions.
+
+<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
+you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
+Standard `^` and `~` ranges will not work as expected.
+See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
+package for more information including tools to convert between version schemes.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+## ODSP APIs
+
+Documenting some basics about opds-driver specific apis that are relevant for creation or loading of a Fluid file from ODSP.
+
+### /snapshot API
+
+-   Creates a new Fluid file with the contents as the summary provided in the request body.
+-   The creation of file along with the summary is done in a single api call to reduce the number of round trips during new file creation.
+-   Also supports creation of sharing link for the file if appropriate request headers are provided in the api call. This feature was introduced to save the number of round trips that a host app makes while creating a file and then creating a sharing link.
+    1.  Earlier only `&createLinkType=csl` parameter was supported which could create organizational scoped sharing links. Feature is gated by `enableShareLinkWithCreate` provided via `HostStoragePolicy`. (createLinkType is now deprecated, so prefer using option 2 below)
+    1.  Now, providing appropriate values for `&createLinkScope` and `&createLinkRole` request parameters will let you create sharing links with various permission scopes. See `resolvedUrl` definition for more details. Feature is gated by `enableSingleRequestForShareLinkWithCreate ` provided via `HostStoragePolicy`.
+
+### /trees/latest API
+
+-   Fetches the snapshot of an existing Fluid file.
+-   Earlier, application needed to redeem the sharing link of the file before a /trees/latest fetch could be made. To reduce the number of round trips made to ODSP, redemption of the share link now happens along with fetching latest snapshot in the same api request by passing share link in `&sl` request parameter.
+-   This api is also preflight-less, which means it is not preceded by an OPTIONS call in the browsers to reduce the network trips to the server.
+
+<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+}

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.json"
 }

package/api-report/odsp-driver.api.md

@@ -0,0 +1,310 @@
+## API Report File for "@fluidframework/odsp-driver"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { DriverPreCheckInfo } from '@fluidframework/driver-definitions';
+import { HostStoragePolicy } from '@fluidframework/odsp-driver-definitions';
+import { IContainerPackageInfo } from '@fluidframework/driver-definitions';
+import { IdentityType } from '@fluidframework/odsp-driver-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IEntry } from '@fluidframework/odsp-driver-definitions';
+import { IFileEntry } from '@fluidframework/odsp-driver-definitions';
+import { IOdspResolvedUrl } from '@fluidframework/odsp-driver-definitions';
+import { IOdspUrlParts } from '@fluidframework/odsp-driver-definitions';
+import { IPersistedCache } from '@fluidframework/odsp-driver-definitions';
+import { IPrefetchSnapshotContents as IPrefetchSnapshotContents_2 } from './odspCache';
+import { IRelaySessionAwareDriverFactory } from '@fluidframework/odsp-driver-definitions';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharingLinkKind } from '@fluidframework/odsp-driver-definitions';
+import { ISnapshotOptions } from '@fluidframework/odsp-driver-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { ISocketStorageDiscovery } from '@fluidframework/odsp-driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { ITelemetryProperties } from '@fluidframework/core-interfaces';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { OdspResourceTokenFetchOptions } from '@fluidframework/odsp-driver-definitions';
+import { PromiseCache } from '@fluidframework/core-utils';
+import { RateLimiter } from '@fluidframework/driver-utils';
+import { ShareLinkTypes } from '@fluidframework/odsp-driver-definitions';
+import { TokenFetcher } from '@fluidframework/odsp-driver-definitions';
+
+// @alpha
+export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined;
+
+// @internal (undocumented)
+export enum ClpCompliantAppHeader {
+    // (undocumented)
+    isClpCompliantApp = "X-CLP-Compliant-App"
+}
+
+// @alpha (undocumented)
+export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory;
+
+// @alpha
+export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ShareLinkTypes | ISharingLinkKind): IRequest;
+
+// @alpha
+export function createOdspUrl(l: OdspFluidDataStoreLocator): string;
+
+// @alpha
+export function encodeOdspFluidDataStoreLocator(locator: OdspFluidDataStoreLocator): string;
+
+// @alpha
+export class EpochTracker implements IPersistedFileCache {
+    constructor(cache: IPersistedCache, fileEntry: IFileEntry, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean | undefined);
+    // (undocumented)
+    protected readonly cache: IPersistedCache;
+    // (undocumented)
+    protected readonly clientIsSummarizer?: boolean | undefined;
+    fetch(url: string, fetchOptions: RequestInit, fetchType: FetchType, addInBody?: boolean, fetchReason?: string): Promise<IOdspResponse<Response>>;
+    fetchAndParseAsJSON<T>(url: string, fetchOptions: RequestInit, fetchType: FetchType, addInBody?: boolean, fetchReason?: string): Promise<IOdspResponse<T>>;
+    fetchArray(url: string, fetchOptions: {
+        [index: string]: any;
+    }, fetchType: FetchType, addInBody?: boolean, fetchReason?: string): Promise<IOdspResponse<ArrayBuffer>>;
+    // (undocumented)
+    protected readonly fileEntry: IFileEntry;
+    // (undocumented)
+    get fluidEpoch(): string | undefined;
+    // (undocumented)
+    get(entry: IEntry): Promise<any>;
+    // (undocumented)
+    protected readonly logger: ITelemetryLoggerExt;
+    // (undocumented)
+    put(entry: IEntry, value: any): Promise<void>;
+    // (undocumented)
+    readonly rateLimiter: RateLimiter;
+    // (undocumented)
+    removeEntries(): Promise<void>;
+    // (undocumented)
+    setEpoch(epoch: string, fromCache: boolean, fetchType: FetchTypeInternal): void;
+    // (undocumented)
+    validateEpoch(epoch: string | undefined, fetchType: FetchType): Promise<void>;
+    // (undocumented)
+    protected validateEpochFromResponse(epochFromResponse: string | undefined, fetchType: FetchTypeInternal, fromCache?: boolean): void;
+}
+
+// @alpha (undocumented)
+export type FetchType = "blob" | "createBlob" | "createFile" | "joinSession" | "ops" | "test" | "snapshotTree" | "treesLatest" | "uploadSummary" | "push" | "versions";
+
+// @alpha (undocumented)
+export type FetchTypeInternal = FetchType | "cache";
+
+// @internal
+export function getApiRoot(origin: string): string;
+
+// @alpha (undocumented)
+export function getHashedDocumentId(driveId: string, itemId: string): Promise<string>;
+
+// @alpha
+export function getLocatorFromOdspUrl(url: URL, requireFluidSignature?: boolean): OdspFluidDataStoreLocator | undefined;
+
+// @internal
+export function getOdspUrlParts(url: URL): Promise<IOdspUrlParts | undefined>;
+
+// @alpha (undocumented)
+export interface ICacheAndTracker {
+    // (undocumented)
+    cache: IOdspCache;
+    // (undocumented)
+    epochTracker: EpochTracker;
+}
+
+// @internal (undocumented)
+export interface IClpCompliantAppHeader {
+    // (undocumented)
+    [ClpCompliantAppHeader.isClpCompliantApp]: boolean;
+}
+
+// @alpha
+export interface INonPersistentCache {
+    readonly fileUrlCache: PromiseCache<string, IOdspResolvedUrl>;
+    readonly sessionJoinCache: PromiseCache<string, {
+        entryTime: number;
+        joinSessionResponse: ISocketStorageDiscovery;
+    }>;
+    readonly snapshotPrefetchResultCache: PromiseCache<string, IPrefetchSnapshotContents>;
+}
+
+// @alpha
+export interface IOdspCache extends INonPersistentCache {
+    readonly persistedCache: IPersistedFileCache;
+}
+
+// @alpha (undocumented)
+export interface IOdspResponse<T> {
+    // (undocumented)
+    content: T;
+    // (undocumented)
+    duration: number;
+    // (undocumented)
+    headers: Map<string, string>;
+    // (undocumented)
+    propsToLog: ITelemetryProperties;
+}
+
+// @alpha
+export interface IPersistedFileCache {
+    // (undocumented)
+    get(entry: IEntry): Promise<any>;
+    // (undocumented)
+    put(entry: IEntry, value: any): Promise<void>;
+    // (undocumented)
+    removeEntries(): Promise<void>;
+}
+
+// @alpha (undocumented)
+export interface IPrefetchSnapshotContents extends ISnapshotContents {
+    // (undocumented)
+    fluidEpoch: string;
+    // (undocumented)
+    prefetchStartTime: number;
+}
+
+// @internal (undocumented)
+export interface ISharingLinkHeader {
+    // (undocumented)
+    [SharingLinkHeader.isSharingLinkToRedeem]: boolean;
+}
+
+// @alpha (undocumented)
+export interface ISnapshotContents {
+    // (undocumented)
+    blobs: Map<string, ArrayBuffer>;
+    latestSequenceNumber: number | undefined;
+    // (undocumented)
+    ops: ISequencedDocumentMessage[];
+    sequenceNumber: number | undefined;
+    // (undocumented)
+    snapshotTree: ISnapshotTree;
+}
+
+// @internal
+export interface ISnapshotContentsWithProps extends ISnapshotContents {
+    // (undocumented)
+    telemetryProps: Record<string, number>;
+}
+
+// @internal
+export function isOdcOrigin(origin: string): boolean;
+
+// @internal
+export function isOdcUrl(url: string | URL): boolean;
+
+// @internal (undocumented)
+export function isOdspResolvedUrl(resolvedUrl: IResolvedUrl): resolvedUrl is IOdspResolvedUrl;
+
+// @internal
+export function isSpoUrl(url: string): boolean;
+
+// @alpha
+export const locatorQueryParamName = "nav";
+
+// @alpha (undocumented)
+export const OdcApiSiteOrigin = "https://my.microsoftpersonalcontent.com";
+
+// @alpha (undocumented)
+export const OdcFileSiteOrigin = "https://1drv.ms";
+
+// @alpha
+export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
+    constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
+}
+
+// @alpha
+export class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory, IRelaySessionAwareDriverFactory {
+    constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
+    // (undocumented)
+    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    // (undocumented)
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    // (undocumented)
+    protected createDocumentServiceCore(resolvedUrl: IResolvedUrl, odspLogger: ITelemetryLogger, cacheAndTrackerArg?: ICacheAndTracker, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    getRelayServiceSessionInfo(resolvedUrl: IResolvedUrl): Promise<ISocketStorageDiscovery | undefined>;
+    // (undocumented)
+    get IRelaySessionAwareDriverFactory(): this;
+    // (undocumented)
+    protected persistedCache: IPersistedCache;
+    // (undocumented)
+    get snapshotPrefetchResultCache(): PromiseCache<string, IPrefetchSnapshotContents_2>;
+}
+
+// @internal @deprecated (undocumented)
+export class OdspDocumentServiceFactoryWithCodeSplit extends OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
+    constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
+}
+
+// @alpha
+export class OdspDriverUrlResolver implements IUrlResolver {
+    constructor();
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
+    // (undocumented)
+    resolve(request: IRequest): Promise<IOdspResolvedUrl>;
+}
+
+// @alpha
+export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
+    constructor(shareLinkFetcherProps?: ShareLinkFetcherProps | undefined, logger?: ITelemetryBaseLogger, appName?: string | undefined, getContext?: ((resolvedUrl: IOdspResolvedUrl, dataStorePath: string) => Promise<string | undefined>) | undefined);
+    appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined;
+    static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator): string;
+    // @deprecated
+    static createNavParam(locator: OdspFluidDataStoreLocator): string;
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, dataStorePath: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
+    resolve(request: IRequest): Promise<IOdspResolvedUrl>;
+}
+
+// @alpha (undocumented)
+export interface OdspFluidDataStoreLocator extends IOdspUrlParts {
+    // (undocumented)
+    appName?: string;
+    // (undocumented)
+    containerPackageName?: string;
+    // (undocumented)
+    context?: string;
+    // (undocumented)
+    dataStorePath: string;
+    // (undocumented)
+    fileVersion?: string;
+}
+
+// @internal
+export function parseCompactSnapshotResponse(buffer: Uint8Array, logger: ITelemetryLoggerExt): ISnapshotContentsWithProps;
+
+// @alpha
+export function prefetchLatestSnapshot(resolvedUrl: IResolvedUrl, getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, persistedCache: IPersistedCache, forceAccessTokenViaAuthorizationHeader: boolean, logger: ITelemetryBaseLogger, hostSnapshotFetchOptions: ISnapshotOptions | undefined, enableRedeemFallback?: boolean, fetchBinarySnapshotFormat?: boolean, snapshotFormatFetchType?: SnapshotFormatSupportType, odspDocumentServiceFactory?: OdspDocumentServiceFactory): Promise<boolean>;
+
+// @alpha
+export interface ShareLinkFetcherProps {
+    identityType: IdentityType;
+    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>;
+}
+
+// @internal (undocumented)
+export enum SharingLinkHeader {
+    // (undocumented)
+    isSharingLinkToRedeem = "isSharingLinkToRedeem"
+}
+
+// @alpha
+export enum SnapshotFormatSupportType {
+    // (undocumented)
+    Binary = 1,
+    // (undocumented)
+    Json = 0,
+    // (undocumented)
+    JsonAndBinary = 2
+}
+
+// @alpha
+export function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocator): void;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/{ReadBufferUtils.js → ReadBufferUtils.cjs}

@@ -5,12 +5,15 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadBuffer = void 0;
-const common_utils_1 = require("@fluidframework/common-utils");
+const core_utils_1 = require("@fluidframework/core-utils");
 /**
  * Buffer class, used to sequentially read data.
  * Used by tree code to reconstruct a tree from binary representation.
  */
 class ReadBuffer {
+    get buffer() {
+        return this.data;
+    }
     constructor(data) {
         this.data = data;
         this.index = 0;
@@ -19,12 +22,15 @@ class ReadBuffer {
         // catastrophic result and will be really hard to investigate.
         Object.freeze(data.buffer);
     }
-    get buffer() {
-        return this.data;
+    get eof() {
+        return this.index === this.data.length;
+    }
+    get pos() {
+        return this.index;
+    }
+    get length() {
+        return this.data.length;
     }
-    get eof() { return this.index === this.data.length; }
-    get pos() { return this.index; }
-    get length() { return this.data.length; }
     slice(start, end) {
         return this.data.slice(start, end);
     }
@@ -36,7 +42,7 @@ class ReadBuffer {
         let multiplier = 1;
         let length = lengthArg;
         while (length > 0) {
-            (0, common_utils_1.assert)(!this.eof, 0x223 /* "unexpected end of buffer" */);
+            (0, core_utils_1.assert)(!this.eof, 0x223 /* "unexpected end of buffer" */);
             res += this.data[this.index] * multiplier;
             this.index++;
             multiplier *= 256;
@@ -45,9 +51,10 @@ class ReadBuffer {
         return res;
     }
     skip(length) {
-        (0, common_utils_1.assert)(length >= 0, 0x224 /* "Skip length should be positive" */);
+        (0, core_utils_1.assert)(length >= 0, 0x224 /* "Skip length should be positive" */);
         this.index += length;
+        (0, core_utils_1.assert)(this.index <= this.data.length, 0x3dc /* skipping past size of buffer */);
     }
 }
 exports.ReadBuffer = ReadBuffer;
-//# sourceMappingURL=ReadBufferUtils.js.map
+//# sourceMappingURL=ReadBufferUtils.cjs.map

package/dist/ReadBufferUtils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadBufferUtils.cjs","sourceRoot":"","sources":["../src/ReadBufferUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAEpD;;;GAGG;AACH,MAAa,UAAU;IAGtB,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAED,YAA+B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;QANrC,UAAK,GAAG,CAAC,CAAC;QAOnB,4DAA4D;QAC5D,+DAA+D;QAC/D,8DAA8D;QAC9D,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED,IAAW,GAAG;QACb,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACxC,CAAC;IACD,IAAW,GAAG;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IACD,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,KAAa,EAAE,GAAW;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK;QACX,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;IAChB,CAAC;IAEM,IAAI,CAAC,SAAS,GAAG,CAAC;QACxB,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,IAAI,MAAM,GAAG,SAAS,CAAC;QACvB,OAAO,MAAM,GAAG,CAAC,EAAE;YAClB,IAAA,mBAAM,EAAC,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;YAC1D,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC;YAC1C,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,UAAU,IAAI,GAAG,CAAC;YAClB,MAAM,EAAE,CAAC;SACT;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;IAEM,IAAI,CAAC,MAAc;QACzB,IAAA,mBAAM,EAAC,MAAM,IAAI,CAAC,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC;QACrB,IAAA,mBAAM,EAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAClF,CAAC;CACD;AAnDD,gCAmDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\n\n/**\n * Buffer class, used to sequentially read data.\n * Used by tree code to reconstruct a tree from binary representation.\n */\nexport class ReadBuffer {\n\tprotected index = 0;\n\n\tpublic get buffer() {\n\t\treturn this.data;\n\t}\n\n\tconstructor(protected readonly data: Uint8Array) {\n\t\t// BlobShallowCopy will return to users parts of this array.\n\t\t// We need to ensure that nobody can change it, as it will have\n\t\t// catastrophic result and will be really hard to investigate.\n\t\tObject.freeze(data.buffer);\n\t}\n\n\tpublic get eof() {\n\t\treturn this.index === this.data.length;\n\t}\n\tpublic get pos() {\n\t\treturn this.index;\n\t}\n\tpublic get length() {\n\t\treturn this.data.length;\n\t}\n\n\tpublic slice(start: number, end: number) {\n\t\treturn this.data.slice(start, end);\n\t}\n\n\tpublic reset() {\n\t\tthis.index = 0;\n\t}\n\n\tpublic read(lengthArg = 1): number {\n\t\tlet res = 0;\n\t\tlet multiplier = 1;\n\t\tlet length = lengthArg;\n\t\twhile (length > 0) {\n\t\t\tassert(!this.eof, 0x223 /* \"unexpected end of buffer\" */);\n\t\t\tres += this.data[this.index] * multiplier;\n\t\t\tthis.index++;\n\t\t\tmultiplier *= 256;\n\t\t\tlength--;\n\t\t}\n\t\treturn res;\n\t}\n\n\tpublic skip(length: number) {\n\t\tassert(length >= 0, 0x224 /* \"Skip length should be positive\" */);\n\t\tthis.index += length;\n\t\tassert(this.index <= this.data.length, 0x3dc /* skipping past size of buffer */);\n\t}\n}\n"]}

package/dist/ReadBufferUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ReadBufferUtils.d.ts","sourceRoot":"","sources":["../src/ReadBufferUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;GAGG;AACH,qBAAa,UAAU;IAOP,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU;IAN/C,SAAS,CAAC,KAAK,SAAK;IAEpB,IAAW,MAAM,eAEhB;gBAE8B,IAAI,EAAE,UAAU;IAO/C,IAAW,GAAG,YAA8C;IAC5D,IAAW,GAAG,WAAyB;IACvC,IAAW,MAAM,WAA+B;IAEzC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAIhC,KAAK;IAIL,IAAI,CAAC,SAAS,SAAI,GAAG,MAAM;IAc3B,IAAI,CAAC,MAAM,EAAE,MAAM;CAI7B"}
+{"version":3,"file":"ReadBufferUtils.d.ts","sourceRoot":"","sources":["../src/ReadBufferUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;GAGG;AACH,qBAAa,UAAU;IAOV,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU;IAN/C,SAAS,CAAC,KAAK,SAAK;IAEpB,IAAW,MAAM,eAEhB;gBAE8B,IAAI,EAAE,UAAU;IAO/C,IAAW,GAAG,YAEb;IACD,IAAW,GAAG,WAEb;IACD,IAAW,MAAM,WAEhB;IAEM,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAIhC,KAAK;IAIL,IAAI,CAAC,SAAS,SAAI,GAAG,MAAM;IAc3B,IAAI,CAAC,MAAM,EAAE,MAAM;CAK1B"}