@fluidframework/odsp-driver 2.113.1 → 2.115.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @fluidframework/odsp-driver
 
+## 2.115.0
+
+Dependency updates only.
+
+## 2.114.0
+
+Dependency updates only.
+
 ## 2.113.0
 
 Dependency updates only.

package/api-extractor/api-extractor-lint-legacyAlpha.cjs.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/dist/legacyAlpha.d.ts"
+}

package/api-extractor/api-extractor-lint-legacyAlpha.esm.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/legacyAlpha.d.ts"
+}

package/api-extractor/api-extractor.legacy.json

@@ -1,4 +1,8 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json"
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/legacyAlpha.d.ts",
+	"apiReport": {
+		"reportVariants": ["public", "beta", "alpha"]
+	}
 }

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

@@ -0,0 +1,232 @@
+## Alpha 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
+
+// @beta @legacy
+export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined;
+
+// @beta @legacy
+export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory;
+
+// @beta @legacy
+export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest;
+
+// @beta @legacy
+export function createOdspUrl(l: OdspFluidDataStoreLocator): string;
+
+// @beta @legacy
+export function encodeOdspFluidDataStoreLocator(locator: OdspFluidDataStoreLocator): string;
+
+// @beta @legacy
+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]: RequestInit;
+    }, 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;
+}
+
+// @beta @legacy (undocumented)
+export type FetchType = "blob" | "createBlob" | "createFile" | "joinSession" | "ops" | "test" | "snapshotTree" | "treesLatest" | "uploadSummary" | "push" | "versions" | "renameFile";
+
+// @beta @legacy (undocumented)
+export type FetchTypeInternal = FetchType | "cache";
+
+// @beta @legacy
+export function getHashedDocumentId(driveId: string, itemId: string): Promise<string>;
+
+// @beta @legacy
+export function getLocatorFromOdspUrl(url: URL, requireFluidSignature?: boolean): OdspFluidDataStoreLocator | undefined;
+
+// @alpha @legacy
+export function getOdspPointInTimeDocumentServiceFactory(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy): IPointInTimeDocumentServiceFactory;
+
+// @beta @legacy (undocumented)
+export interface ICacheAndTracker {
+    // (undocumented)
+    cache: IOdspCache;
+    // (undocumented)
+    epochTracker: EpochTracker;
+}
+
+// @beta @legacy
+export interface INonPersistentCache {
+    readonly fileUrlCache: PromiseCache<string, IOdspResolvedUrl>;
+    readonly sessionJoinCache: PromiseCache<string, {
+        entryTime: number;
+        joinSessionResponse: ISocketStorageDiscovery;
+    }>;
+    readonly snapshotPrefetchResultCache: PromiseCache<string, IPrefetchSnapshotContents>;
+}
+
+// @beta @legacy
+export interface IOdspCache extends INonPersistentCache {
+    readonly persistedCache: IPersistedFileCache;
+}
+
+// @beta @legacy (undocumented)
+export interface IOdspResponse<T> {
+    // (undocumented)
+    content: T;
+    // (undocumented)
+    duration: number;
+    // (undocumented)
+    headers: Map<string, string>;
+    // (undocumented)
+    propsToLog: ITelemetryBaseProperties;
+}
+
+// @beta @legacy
+export interface IPersistedFileCache {
+    // (undocumented)
+    get(entry: IEntry): Promise<any>;
+    // (undocumented)
+    put(entry: IEntry, value: any): Promise<void>;
+    // (undocumented)
+    removeEntries(): Promise<void>;
+}
+
+// @alpha @legacy
+export interface IPointInTimeDocumentServiceFactory extends IDocumentServiceFactory {
+    createPointInTimeDocumentService(resolvedUrl: IResolvedUrl, targetSequenceNumber: number, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+// @beta @legacy (undocumented)
+export interface IPrefetchSnapshotContents extends ISnapshot {
+    // (undocumented)
+    fluidEpoch: string;
+    // (undocumented)
+    prefetchStartTime: number;
+}
+
+// @beta @deprecated @legacy (undocumented)
+export interface ISnapshotContents {
+    // (undocumented)
+    blobs: Map<string, ArrayBuffer>;
+    latestSequenceNumber: number | undefined;
+    // (undocumented)
+    ops: ISequencedDocumentMessage[];
+    sequenceNumber: number | undefined;
+    // (undocumented)
+    snapshotTree: ISnapshotTree;
+}
+
+// @beta @legacy
+export function isOdspResolvedUrl(resolvedUrl: IResolvedUrl): resolvedUrl is IOdspResolvedUrl;
+
+// @beta @legacy
+export const locatorQueryParamName = "nav";
+
+// @beta @legacy (undocumented)
+export const OdcApiSiteOrigin = "https://my.microsoftpersonalcontent.com";
+
+// @beta @legacy (undocumented)
+export const OdcFileSiteOrigin = "https://1drv.ms";
+
+// @beta @legacy
+export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
+    constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);
+}
+
+// @beta @legacy
+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: ITelemetryBaseLogger, cacheAndTrackerArg?: ICacheAndTracker, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    getRelayServiceSessionInfo(resolvedUrl: IResolvedUrl): Promise<ISocketStorageDiscovery | undefined>;
+    readonly ILayerCompatDetails?: unknown;
+    // (undocumented)
+    get IRelaySessionAwareDriverFactory(): this;
+    // (undocumented)
+    protected persistedCache: IPersistedCache;
+    // (undocumented)
+    get snapshotPrefetchResultCache(): PromiseCache<string, IPrefetchSnapshotContents>;
+}
+
+// @beta @legacy
+export class OdspDriverUrlResolver implements IUrlResolver {
+    constructor();
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
+    resolve(request: IRequest): Promise<IOdspResolvedUrl>;
+}
+
+// @beta @legacy
+export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
+    constructor(shareLinkFetcherProps?: ShareLinkFetcherProps | undefined, logger?: ITelemetryBaseLogger, appName?: string | undefined, getContext?: ((resolvedUrl: IOdspResolvedUrl, dataStorePath: string) => Promise<string | undefined>) | undefined, containerPackageInfo?: IContainerPackageInfo | undefined);
+    appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined;
+    appendLocatorParams(baseUrl: string, resolvedUrl: IResolvedUrl, dataStorePath: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
+    static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator): string;
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, dataStorePath: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
+    resolve(request: IRequest): Promise<IOdspResolvedUrl>;
+}
+
+// @beta @legacy (undocumented)
+export interface OdspFluidDataStoreLocator extends IOdspUrlParts {
+    // (undocumented)
+    appName?: string | undefined;
+    // (undocumented)
+    containerPackageName?: string | undefined;
+    // (undocumented)
+    context?: string | undefined;
+    // (undocumented)
+    dataStorePath: string;
+    // (undocumented)
+    fileVersion?: string | undefined;
+}
+
+// @beta @legacy
+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>;
+
+// @beta @legacy
+export interface ShareLinkFetcherProps {
+    identityType: IdentityType;
+    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>;
+}
+
+// @beta @legacy
+export enum SnapshotFormatSupportType {
+    // (undocumented)
+    Binary = 1,
+    // (undocumented)
+    Json = 0,
+    // (undocumented)
+    JsonAndBinary = 2
+}
+
+// @beta @legacy
+export function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocator): void;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/getUrlAndHeadersWithAuth.d.ts

@@ -2,6 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/**
+ * Builds the request headers carrying the given Authorization header value.
+ * @internal
+ */
 export declare function getHeadersWithAuth(authHeader: string | null): {
     [index: string]: string;
 };

package/dist/getUrlAndHeadersWithAuth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getUrlAndHeadersWithAuth.d.ts","sourceRoot":"","sources":["../src/getUrlAndHeadersWithAuth.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,wBAAgB,kBAAkB,CAEjC,UAAU,EAAE,MAAM,GAAG,IAAI,GACvB;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAM7B"}
+{"version":3,"file":"getUrlAndHeadersWithAuth.d.ts","sourceRoot":"","sources":["../src/getUrlAndHeadersWithAuth.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;GAGG;AACH,wBAAgB,kBAAkB,CAEjC,UAAU,EAAE,MAAM,GAAG,IAAI,GACvB;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAM7B"}

package/dist/getUrlAndHeadersWithAuth.js

@@ -6,6 +6,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getHeadersWithAuth = void 0;
 const internal_1 = require("@fluidframework/core-utils/internal");
+/**
+ * Builds the request headers carrying the given Authorization header value.
+ * @internal
+ */
 function getHeadersWithAuth(
 // eslint-disable-next-line @rushstack/no-new-null
 authHeader) {

package/dist/getUrlAndHeadersWithAuth.js.map

@@ -1 +1 @@
-{"version":3,"file":"getUrlAndHeadersWithAuth.js","sourceRoot":"","sources":["../src/getUrlAndHeadersWithAuth.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAE7D,SAAgB,kBAAkB;AACjC,kDAAkD;AAClD,UAAyB;IAEzB,IAAA,iBAAM,EAAC,CAAC,CAAC,UAAU,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAEzE,OAAO;QACN,aAAa,EAAE,UAAU;KACzB,CAAC;AACH,CAAC;AATD,gDASC","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/internal\";\n\nexport function getHeadersWithAuth(\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tauthHeader: string | null,\n): { [index: string]: string } {\n\tassert(!!authHeader, 0x936 /* authHeader should not be null or empty */);\n\n\treturn {\n\t\tAuthorization: authHeader,\n\t};\n}\n"]}
+{"version":3,"file":"getUrlAndHeadersWithAuth.js","sourceRoot":"","sources":["../src/getUrlAndHeadersWithAuth.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAE7D;;;GAGG;AACH,SAAgB,kBAAkB;AACjC,kDAAkD;AAClD,UAAyB;IAEzB,IAAA,iBAAM,EAAC,CAAC,CAAC,UAAU,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAEzE,OAAO;QACN,aAAa,EAAE,UAAU;KACzB,CAAC;AACH,CAAC;AATD,gDASC","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/internal\";\n\n/**\n * Builds the request headers carrying the given Authorization header value.\n * @internal\n */\nexport function getHeadersWithAuth(\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tauthHeader: string | null,\n): { [index: string]: string } {\n\tassert(!!authHeader, 0x936 /* authHeader should not be null or empty */);\n\n\treturn {\n\t\tAuthorization: authHeader,\n\t};\n}\n"]}

package/dist/index.d.ts

@@ -7,11 +7,12 @@ export { ClpCompliantAppHeader, type IClpCompliantAppHeader, type ISharingLinkHe
 export { checkUrl } from "./checkUrl.js";
 export { createOdspUrl } from "./createOdspUrl.js";
 export { getHashedDocumentId, type ISnapshotContents } from "./odspPublicUtils.js";
-export { getOdspUrlParts, isOdcUrl, isSpoUrl } from "./odspUrlHelper.js";
+export { getApiRoot, getOdspUrlParts, isOdcUrl, isSpoUrl } from "./odspUrlHelper.js";
+export { getHeadersWithAuth } from "./getUrlAndHeadersWithAuth.js";
 export { prefetchLatestSnapshot } from "./prefetchLatestSnapshot.js";
 export { createLocalOdspDocumentServiceFactory, OdspDocumentServiceFactory, } from "./odspDocumentServiceFactory.js";
 export { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore.js";
-export { OdspPointInTimeDocumentServiceFactory } from "./pointInTimeDriver/odspPointInTimeDocumentServiceFactory.js";
+export { getOdspPointInTimeDocumentServiceFactory, type IPointInTimeDocumentServiceFactory, } from "./pointInTimeDriver/odspPointInTimeDocumentServiceFactory.js";
 export { createOdspCreateContainerRequest } from "./createOdspCreateContainerRequest.js";
 export { OdspDriverUrlResolver } from "./odspDriverUrlResolver.js";
 export { OdspDriverUrlResolverForShareLink, type ShareLinkFetcherProps, } from "./odspDriverUrlResolverForShareLink.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAErE,OAAO,EACN,qBAAqB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,iBAAiB,GACjB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAGzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAGrE,OAAO,EACN,qCAAqC,EACrC,0BAA0B,GAC1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAErF,OAAO,EAAE,qCAAqC,EAAE,MAAM,8DAA8D,CAAC;AAGrH,OAAO,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AAGzF,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EACN,iCAAiC,EACjC,KAAK,qBAAqB,GAC1B,MAAM,wCAAwC,CAAC;AAGhD,OAAO,EACN,+BAA+B,EAC/B,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,GACrB,MAAM,wBAAwB,CAAC;AAEhC,YAAY,EACX,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,GACzB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACX,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACT,iBAAiB,GACjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,KAAK,aAAa,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EACN,KAAK,0BAA0B,EAC/B,4BAA4B,GAC5B,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EAAE,gCAAgC,EAAE,MAAM,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAErE,OAAO,EACN,qBAAqB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,iBAAiB,GACjB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAGnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAGrE,OAAO,EACN,qCAAqC,EACrC,0BAA0B,GAC1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAErF,OAAO,EACN,wCAAwC,EACxC,KAAK,kCAAkC,GACvC,MAAM,8DAA8D,CAAC;AAItE,OAAO,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AAGzF,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EACN,iCAAiC,EACjC,KAAK,qBAAqB,GAC1B,MAAM,wCAAwC,CAAC;AAGhD,OAAO,EACN,+BAA+B,EAC/B,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,GACrB,MAAM,wBAAwB,CAAC;AAEhC,YAAY,EACX,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,GACzB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACX,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACT,iBAAiB,GACjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,KAAK,aAAa,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EACN,KAAK,0BAA0B,EAC/B,4BAA4B,GAC5B,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EAAE,gCAAgC,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/index.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.odspDriverCompatDetailsForLoader = exports.parseCompactSnapshotResponse = exports.SnapshotFormatSupportType = exports.isOdspResolvedUrl = exports.storeLocatorInOdspUrl = exports.locatorQueryParamName = exports.getLocatorFromOdspUrl = exports.encodeOdspFluidDataStoreLocator = exports.OdspDriverUrlResolverForShareLink = exports.OdspDriverUrlResolver = exports.createOdspCreateContainerRequest = exports.OdspPointInTimeDocumentServiceFactory = exports.OdspDocumentServiceFactoryCore = exports.OdspDocumentServiceFactory = exports.createLocalOdspDocumentServiceFactory = exports.prefetchLatestSnapshot = exports.isSpoUrl = exports.isOdcUrl = exports.getOdspUrlParts = exports.getHashedDocumentId = exports.createOdspUrl = exports.checkUrl = exports.SharingLinkHeader = exports.ClpCompliantAppHeader = exports.OdcFileSiteOrigin = exports.OdcApiSiteOrigin = void 0;
+exports.odspDriverCompatDetailsForLoader = exports.parseCompactSnapshotResponse = exports.SnapshotFormatSupportType = exports.isOdspResolvedUrl = exports.storeLocatorInOdspUrl = exports.locatorQueryParamName = exports.getLocatorFromOdspUrl = exports.encodeOdspFluidDataStoreLocator = exports.OdspDriverUrlResolverForShareLink = exports.OdspDriverUrlResolver = exports.createOdspCreateContainerRequest = exports.getOdspPointInTimeDocumentServiceFactory = exports.OdspDocumentServiceFactoryCore = exports.OdspDocumentServiceFactory = exports.createLocalOdspDocumentServiceFactory = exports.prefetchLatestSnapshot = exports.getHeadersWithAuth = exports.isSpoUrl = exports.isOdcUrl = exports.getOdspUrlParts = exports.getApiRoot = exports.getHashedDocumentId = exports.createOdspUrl = exports.checkUrl = exports.SharingLinkHeader = exports.ClpCompliantAppHeader = exports.OdcFileSiteOrigin = exports.OdcApiSiteOrigin = void 0;
 // Constants
 var constants_js_1 = require("./constants.js");
 Object.defineProperty(exports, "OdcApiSiteOrigin", { enumerable: true, get: function () { return constants_js_1.OdcApiSiteOrigin; } });
@@ -20,9 +20,12 @@ Object.defineProperty(exports, "createOdspUrl", { enumerable: true, get: functio
 var odspPublicUtils_js_1 = require("./odspPublicUtils.js");
 Object.defineProperty(exports, "getHashedDocumentId", { enumerable: true, get: function () { return odspPublicUtils_js_1.getHashedDocumentId; } });
 var odspUrlHelper_js_1 = require("./odspUrlHelper.js");
+Object.defineProperty(exports, "getApiRoot", { enumerable: true, get: function () { return odspUrlHelper_js_1.getApiRoot; } });
 Object.defineProperty(exports, "getOdspUrlParts", { enumerable: true, get: function () { return odspUrlHelper_js_1.getOdspUrlParts; } });
 Object.defineProperty(exports, "isOdcUrl", { enumerable: true, get: function () { return odspUrlHelper_js_1.isOdcUrl; } });
 Object.defineProperty(exports, "isSpoUrl", { enumerable: true, get: function () { return odspUrlHelper_js_1.isSpoUrl; } });
+var getUrlAndHeadersWithAuth_js_1 = require("./getUrlAndHeadersWithAuth.js");
+Object.defineProperty(exports, "getHeadersWithAuth", { enumerable: true, get: function () { return getUrlAndHeadersWithAuth_js_1.getHeadersWithAuth; } });
 // prefetch latest snapshot before container load
 var prefetchLatestSnapshot_js_1 = require("./prefetchLatestSnapshot.js");
 Object.defineProperty(exports, "prefetchLatestSnapshot", { enumerable: true, get: function () { return prefetchLatestSnapshot_js_1.prefetchLatestSnapshot; } });
@@ -32,9 +35,10 @@ Object.defineProperty(exports, "createLocalOdspDocumentServiceFactory", { enumer
 Object.defineProperty(exports, "OdspDocumentServiceFactory", { enumerable: true, get: function () { return odspDocumentServiceFactory_js_1.OdspDocumentServiceFactory; } });
 var odspDocumentServiceFactoryCore_js_1 = require("./odspDocumentServiceFactoryCore.js");
 Object.defineProperty(exports, "OdspDocumentServiceFactoryCore", { enumerable: true, get: function () { return odspDocumentServiceFactoryCore_js_1.OdspDocumentServiceFactoryCore; } });
-// eslint-disable-next-line import-x/no-internal-modules
+/* eslint-disable import-x/no-internal-modules */
 var odspPointInTimeDocumentServiceFactory_js_1 = require("./pointInTimeDriver/odspPointInTimeDocumentServiceFactory.js");
-Object.defineProperty(exports, "OdspPointInTimeDocumentServiceFactory", { enumerable: true, get: function () { return odspPointInTimeDocumentServiceFactory_js_1.OdspPointInTimeDocumentServiceFactory; } });
+Object.defineProperty(exports, "getOdspPointInTimeDocumentServiceFactory", { enumerable: true, get: function () { return odspPointInTimeDocumentServiceFactory_js_1.getOdspPointInTimeDocumentServiceFactory; } });
+/* eslint-enable import-x/no-internal-modules */
 // File creation
 var createOdspCreateContainerRequest_js_1 = require("./createOdspCreateContainerRequest.js");
 Object.defineProperty(exports, "createOdspCreateContainerRequest", { enumerable: true, get: function () { return createOdspCreateContainerRequest_js_1.createOdspCreateContainerRequest; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,YAAY;AACZ,+CAAqE;AAA5D,gHAAA,gBAAgB,OAAA;AAAE,iHAAA,iBAAiB,OAAA;AAE5C,2DAM8B;AAL7B,2HAAA,qBAAqB,OAAA;AAIrB,uHAAA,iBAAiB,OAAA;AAGlB,eAAe;AACf,6CAAyC;AAAhC,uGAAA,QAAQ,OAAA;AACjB,uDAAmD;AAA1C,iHAAA,aAAa,OAAA;AACtB,2DAAmF;AAA1E,yHAAA,mBAAmB,OAAA;AAC5B,uDAAyE;AAAhE,mHAAA,eAAe,OAAA;AAAE,4GAAA,QAAQ,OAAA;AAAE,4GAAA,QAAQ,OAAA;AAE5C,iDAAiD;AACjD,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAE/B,UAAU;AACV,iFAGyC;AAFxC,sJAAA,qCAAqC,OAAA;AACrC,2IAAA,0BAA0B,OAAA;AAE3B,yFAAqF;AAA5E,mJAAA,8BAA8B,OAAA;AACvC,wDAAwD;AACxD,yHAAqH;AAA5G,iKAAA,qCAAqC,OAAA;AAE9C,gBAAgB;AAChB,6FAAyF;AAAhF,uJAAA,gCAAgC,OAAA;AAEzC,6CAA6C;AAC7C,uEAAmE;AAA1D,iIAAA,qBAAqB,OAAA;AAC9B,+FAGgD;AAF/C,yJAAA,iCAAiC,OAAA;AAIlC,oEAAoE;AACpE,+DAKgC;AAJ/B,uIAAA,+BAA+B,OAAA;AAC/B,6HAAA,qBAAqB,OAAA;AACrB,6HAAA,qBAAqB,OAAA;AACrB,6HAAA,qBAAqB,OAAA;AAetB,+CAAuE;AAA1C,iHAAA,iBAAiB,OAAA;AAC9C,uDAA+D;AAAtD,6HAAA,yBAAyB,OAAA;AAClC,uEAGoC;AADnC,wIAAA,4BAA4B,OAAA;AAG7B,uBAAuB;AACvB,qEAA6E;AAApE,2IAAA,gCAAgC,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// Constants\nexport { OdcApiSiteOrigin, OdcFileSiteOrigin } from \"./constants.js\";\n\nexport {\n\tClpCompliantAppHeader,\n\ttype IClpCompliantAppHeader,\n\ttype ISharingLinkHeader,\n\ttype OdspFluidDataStoreLocator,\n\tSharingLinkHeader,\n} from \"./contractsPublic.js\";\n\n// public utils\nexport { checkUrl } from \"./checkUrl.js\";\nexport { createOdspUrl } from \"./createOdspUrl.js\";\nexport { getHashedDocumentId, type ISnapshotContents } from \"./odspPublicUtils.js\";\nexport { getOdspUrlParts, isOdcUrl, isSpoUrl } from \"./odspUrlHelper.js\";\n\n// prefetch latest snapshot before container load\nexport { prefetchLatestSnapshot } from \"./prefetchLatestSnapshot.js\";\n\n// Factory\nexport {\n\tcreateLocalOdspDocumentServiceFactory,\n\tOdspDocumentServiceFactory,\n} from \"./odspDocumentServiceFactory.js\";\nexport { OdspDocumentServiceFactoryCore } from \"./odspDocumentServiceFactoryCore.js\";\n// eslint-disable-next-line import-x/no-internal-modules\nexport { OdspPointInTimeDocumentServiceFactory } from \"./pointInTimeDriver/odspPointInTimeDocumentServiceFactory.js\";\n\n// File creation\nexport { createOdspCreateContainerRequest } from \"./createOdspCreateContainerRequest.js\";\n\n// URI Resolver functionality, URI management\nexport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver.js\";\nexport {\n\tOdspDriverUrlResolverForShareLink,\n\ttype ShareLinkFetcherProps,\n} from \"./odspDriverUrlResolverForShareLink.js\";\n\n// It's used by URL resolve code, but also has some public functions\nexport {\n\tencodeOdspFluidDataStoreLocator,\n\tgetLocatorFromOdspUrl,\n\tlocatorQueryParamName,\n\tstoreLocatorInOdspUrl,\n} from \"./odspFluidFileLink.js\";\n\nexport type {\n\tIOdspCache,\n\tIPersistedFileCache,\n\tINonPersistentCache,\n\tIPrefetchSnapshotContents,\n} from \"./odspCache.js\";\nexport type {\n\tICacheAndTracker,\n\tEpochTracker,\n\tFetchType,\n\tFetchTypeInternal,\n} from \"./epochTracker.js\";\nexport { type IOdspResponse, isOdspResolvedUrl } from \"./odspUtils.js\";\nexport { SnapshotFormatSupportType } from \"./fetchSnapshot.js\";\nexport {\n\ttype ISnapshotContentsWithProps,\n\tparseCompactSnapshotResponse,\n} from \"./compactSnapshotParser.js\";\n\n// Layer Compat details\nexport { odspDriverCompatDetailsForLoader } from \"./odspLayerCompatState.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,YAAY;AACZ,+CAAqE;AAA5D,gHAAA,gBAAgB,OAAA;AAAE,iHAAA,iBAAiB,OAAA;AAE5C,2DAM8B;AAL7B,2HAAA,qBAAqB,OAAA;AAIrB,uHAAA,iBAAiB,OAAA;AAGlB,eAAe;AACf,6CAAyC;AAAhC,uGAAA,QAAQ,OAAA;AACjB,uDAAmD;AAA1C,iHAAA,aAAa,OAAA;AACtB,2DAAmF;AAA1E,yHAAA,mBAAmB,OAAA;AAC5B,uDAAqF;AAA5E,8GAAA,UAAU,OAAA;AAAE,mHAAA,eAAe,OAAA;AAAE,4GAAA,QAAQ,OAAA;AAAE,4GAAA,QAAQ,OAAA;AACxD,6EAAmE;AAA1D,iIAAA,kBAAkB,OAAA;AAE3B,iDAAiD;AACjD,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAE/B,UAAU;AACV,iFAGyC;AAFxC,sJAAA,qCAAqC,OAAA;AACrC,2IAAA,0BAA0B,OAAA;AAE3B,yFAAqF;AAA5E,mJAAA,8BAA8B,OAAA;AACvC,iDAAiD;AACjD,yHAGsE;AAFrE,oKAAA,wCAAwC,OAAA;AAGzC,gDAAgD;AAEhD,gBAAgB;AAChB,6FAAyF;AAAhF,uJAAA,gCAAgC,OAAA;AAEzC,6CAA6C;AAC7C,uEAAmE;AAA1D,iIAAA,qBAAqB,OAAA;AAC9B,+FAGgD;AAF/C,yJAAA,iCAAiC,OAAA;AAIlC,oEAAoE;AACpE,+DAKgC;AAJ/B,uIAAA,+BAA+B,OAAA;AAC/B,6HAAA,qBAAqB,OAAA;AACrB,6HAAA,qBAAqB,OAAA;AACrB,6HAAA,qBAAqB,OAAA;AAetB,+CAAuE;AAA1C,iHAAA,iBAAiB,OAAA;AAC9C,uDAA+D;AAAtD,6HAAA,yBAAyB,OAAA;AAClC,uEAGoC;AADnC,wIAAA,4BAA4B,OAAA;AAG7B,uBAAuB;AACvB,qEAA6E;AAApE,2IAAA,gCAAgC,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// Constants\nexport { OdcApiSiteOrigin, OdcFileSiteOrigin } from \"./constants.js\";\n\nexport {\n\tClpCompliantAppHeader,\n\ttype IClpCompliantAppHeader,\n\ttype ISharingLinkHeader,\n\ttype OdspFluidDataStoreLocator,\n\tSharingLinkHeader,\n} from \"./contractsPublic.js\";\n\n// public utils\nexport { checkUrl } from \"./checkUrl.js\";\nexport { createOdspUrl } from \"./createOdspUrl.js\";\nexport { getHashedDocumentId, type ISnapshotContents } from \"./odspPublicUtils.js\";\nexport { getApiRoot, getOdspUrlParts, isOdcUrl, isSpoUrl } from \"./odspUrlHelper.js\";\nexport { getHeadersWithAuth } from \"./getUrlAndHeadersWithAuth.js\";\n\n// prefetch latest snapshot before container load\nexport { prefetchLatestSnapshot } from \"./prefetchLatestSnapshot.js\";\n\n// Factory\nexport {\n\tcreateLocalOdspDocumentServiceFactory,\n\tOdspDocumentServiceFactory,\n} from \"./odspDocumentServiceFactory.js\";\nexport { OdspDocumentServiceFactoryCore } from \"./odspDocumentServiceFactoryCore.js\";\n/* eslint-disable import-x/no-internal-modules */\nexport {\n\tgetOdspPointInTimeDocumentServiceFactory,\n\ttype IPointInTimeDocumentServiceFactory,\n} from \"./pointInTimeDriver/odspPointInTimeDocumentServiceFactory.js\";\n/* eslint-enable import-x/no-internal-modules */\n\n// File creation\nexport { createOdspCreateContainerRequest } from \"./createOdspCreateContainerRequest.js\";\n\n// URI Resolver functionality, URI management\nexport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver.js\";\nexport {\n\tOdspDriverUrlResolverForShareLink,\n\ttype ShareLinkFetcherProps,\n} from \"./odspDriverUrlResolverForShareLink.js\";\n\n// It's used by URL resolve code, but also has some public functions\nexport {\n\tencodeOdspFluidDataStoreLocator,\n\tgetLocatorFromOdspUrl,\n\tlocatorQueryParamName,\n\tstoreLocatorInOdspUrl,\n} from \"./odspFluidFileLink.js\";\n\nexport type {\n\tIOdspCache,\n\tIPersistedFileCache,\n\tINonPersistentCache,\n\tIPrefetchSnapshotContents,\n} from \"./odspCache.js\";\nexport type {\n\tICacheAndTracker,\n\tEpochTracker,\n\tFetchType,\n\tFetchTypeInternal,\n} from \"./epochTracker.js\";\nexport { type IOdspResponse, isOdspResolvedUrl } from \"./odspUtils.js\";\nexport { SnapshotFormatSupportType } from \"./fetchSnapshot.js\";\nexport {\n\ttype ISnapshotContentsWithProps,\n\tparseCompactSnapshotResponse,\n} from \"./compactSnapshotParser.js\";\n\n// Layer Compat details\nexport { odspDriverCompatDetailsForLoader } from \"./odspLayerCompatState.js\";\n"]}

package/dist/legacy.d.ts

@@ -5,7 +5,7 @@
 
 /*
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outDir ./dist" in @fluid-tools/build-cli.
+ * Generated by "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./dist" in @fluid-tools/build-cli.
  */
 
 export {

package/dist/legacyAlpha.d.ts

@@ -0,0 +1,49 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./dist" in @fluid-tools/build-cli.
+ */
+
+export {
+	// #region @legacyBeta APIs
+	EpochTracker, 
+	FetchType, 
+	FetchTypeInternal, 
+	ICacheAndTracker, 
+	INonPersistentCache, 
+	IOdspCache, 
+	IOdspResponse, 
+	IPersistedFileCache, 
+	IPrefetchSnapshotContents, 
+	ISnapshotContents, 
+	OdcApiSiteOrigin, 
+	OdcFileSiteOrigin, 
+	OdspDocumentServiceFactory, 
+	OdspDocumentServiceFactoryCore, 
+	OdspDriverUrlResolver, 
+	OdspDriverUrlResolverForShareLink, 
+	OdspFluidDataStoreLocator, 
+	ShareLinkFetcherProps, 
+	SnapshotFormatSupportType, 
+	checkUrl, 
+	createLocalOdspDocumentServiceFactory, 
+	createOdspCreateContainerRequest, 
+	createOdspUrl, 
+	encodeOdspFluidDataStoreLocator, 
+	getHashedDocumentId, 
+	getLocatorFromOdspUrl, 
+	isOdspResolvedUrl, 
+	locatorQueryParamName, 
+	prefetchLatestSnapshot, 
+	storeLocatorInOdspUrl,
+	// #endregion
+ 
+	// #region @legacyAlpha APIs
+	IPointInTimeDocumentServiceFactory, 
+	getOdspPointInTimeDocumentServiceFactory
+	// #endregion
+} from "./index.js";

package/dist/odspVersionManager/odspFileVersionFetcher.d.ts

@@ -5,7 +5,46 @@
 import type { IOdspUrlParts, InstrumentedStorageTokenFetcher } from "@fluidframework/odsp-driver-definitions/internal";
 import type { TelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 import type { EpochTracker } from "../epochTracker.js";
-import type { IOdspFileVersionFetcher } from "./odspVersionManager.js";
+/**
+ * A single ODSP file version, as listed by the file's version history.
+ */
+export interface OdspFileVersionRef {
+    /**
+     * The version's label (e.g. `"42.0"`), used to address the version when fetching it.
+     */
+    readonly versionId: string;
+    /**
+     * Last-modified timestamp of this version, ISO-8601.
+     */
+    readonly lastModifiedDateTime: string;
+}
+/**
+ * Provides a file's versions and resolves each version's Fluid sequence number. Injected into
+ * the version manager so the selection logic does not depend on how versions are fetched.
+ */
+export interface IOdspFileVersionFetcher {
+    /**
+     * Enumerate the file's versions, newest-first.
+     */
+    listFileVersions(): Promise<OdspFileVersionRef[]>;
+    /**
+     * Resolve a single version's Fluid sequence number. Throws on failure rather than returning a
+     * wrong value.
+     */
+    resolveSequenceNumber(versionId: string): Promise<number>;
+    /**
+     * Read the live document's current ODSP epoch (`x-fluid-epoch`), or `undefined`. Epoch identifies
+     * the file's binary lineage and changes on a version restore or download-then-reupload; compared
+     * with {@link IOdspFileVersionFetcher.getRecoverableVersionEpoch} to confirm a base is on the live
+     * document's lineage.
+     */
+    getLiveDocumentEpoch(): Promise<string | undefined>;
+    /**
+     * Read the ODSP epoch of a specific file version, or `undefined`. See
+     * {@link IOdspFileVersionFetcher.getLiveDocumentEpoch}.
+     */
+    getRecoverableVersionEpoch(versionId: string): Promise<string | undefined>;
+}
 /**
  * Inputs needed to make authenticated requests against a specific ODSP file.
  */

package/dist/odspVersionManager/odspFileVersionFetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspFileVersionFetcher.d.ts","sourceRoot":"","sources":["../../src/odspVersionManager/odspFileVersionFetcher.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,KAAK,EACX,aAAa,EACb,+BAA+B,EAC/B,MAAM,kDAAkD,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAInF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMvD,OAAO,KAAK,EAAsB,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAmB3F;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC3C,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,+BAA+B,CAAC;IACxD,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;CACpC;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC3C,KAAK,EAAE,2BAA2B,GAChC,uBAAuB,CA6EzB"}
+{"version":3,"file":"odspFileVersionFetcher.d.ts","sourceRoot":"","sources":["../../src/odspVersionManager/odspFileVersionFetcher.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAaH,OAAO,KAAK,EACX,aAAa,EACb,+BAA+B,EAC/B,MAAM,kDAAkD,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAInF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAClD;;;OAGG;IACH,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D;;;;;OAKG;IACH,oBAAoB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACpD;;;OAGG;IACH,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC3E;AAmBD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC3C,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,+BAA+B,CAAC;IACxD,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;CACpC;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC3C,KAAK,EAAE,2BAA2B,GAChC,uBAAuB,CA+HzB"}

package/dist/odspVersionManager/odspFileVersionFetcher.js

@@ -5,11 +5,22 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createOdspFileVersionFetcher = void 0;
+/*
+ * An {@link IOdspFileVersionFetcher} backed by the ODSP REST APIs:
+ * - GET /_api/v2.1/.../versions -- enumerate the file's versions.
+ * - GET /_api/v2.1/.../versions/{label}/opStream/snapshots/trees/latest?blobs=2 -- fetch a version's
+ *   snapshot and read its sequence number, parsed with the driver's snapshot parser.
+ * - GET /_api/v2.1/.../[versions/{label}/]opStream/snapshots/trees/latest?blobs=0 -- read a version's
+ *   or the live document's ODSP epoch (`x-fluid-epoch`) to compare their lineage.
+ */
+const internal_1 = require("@fluidframework/driver-utils/internal");
+const internal_2 = require("@fluidframework/odsp-driver-definitions/internal");
 const compactSnapshotParser_js_1 = require("../compactSnapshotParser.js");
 const getUrlAndHeadersWithAuth_js_1 = require("../getUrlAndHeadersWithAuth.js");
 const odspSnapshotParser_js_1 = require("../odspSnapshotParser.js");
 const odspUrlHelper_js_1 = require("../odspUrlHelper.js");
 const odspUtils_js_1 = require("../odspUtils.js");
+const packageVersion_js_1 = require("../packageVersion.js");
 /**
  * Create an {@link IOdspFileVersionFetcher} that talks to a specific ODSP file.
  */
@@ -41,18 +52,14 @@ function createOdspFileVersionFetcher(props) {
         return versions;
     });
     const resolveSequenceNumber = async (versionId) => (0, odspUtils_js_1.getWithRetryForTokenRefresh)(async (options) => {
-        // A file version's sequence number lives inside that version's snapshot, so fetch the snapshot
-        // from the version-scoped endpoint. `blobs=2` inlines blob contents so the `.protocol/attributes`
-        // blob (which carries the sequence number) is included; `deltas=1` is intentionally omitted, as
-        // it would bundle the op stream and its op-level sequence numbers.
+        // The sequence number lives in the version snapshot's `.protocol/attributes` blob, so fetch the
+        // version-scoped snapshot with `blobs=2` to inline it. No op stream needed.
         const url = `${(0, odspUrlHelper_js_1.getApiRoot)(new URL(siteUrl))}/drives/${driveId}/items/${itemId}/versions/${encodeURIComponent(versionId)}/opStream/snapshots/trees/latest?blobs=2`;
         const method = "GET";
         const token = await getAuthHeader({ ...options, request: { url, method } }, "FileVersionSnapshot");
         const headers = (0, getUrlAndHeadersWithAuth_js_1.getHeadersWithAuth)(token);
-        // The server can return the snapshot in one of two equivalent framings: verbose JSON, or
-        // "ms-fluid" — ODSP's compact binary encoding of the same snapshot. Advertise both, and pin the
-        // binary format version (as the driver's own snapshot fetch does) so the server cannot hand back
-        // a binary version this code's parser does not understand.
+        // The snapshot comes back as JSON or "ms-fluid" (ODSP's compact binary form). Accept both and
+        // pin the binary version (as the driver's snapshot fetch does) so the parser can read it.
         headers.accept = `application/json, application/ms-fluid; v=${compactSnapshotParser_js_1.currentReadVersion}`;
         const response = await epochTracker.fetch(url, { method, headers }, "treesLatest");
         const contentType = response.headers.get("content-type") ?? "";
@@ -63,19 +70,50 @@ function createOdspFileVersionFetcher(props) {
             sequenceNumber =
                 (0, odspSnapshotParser_js_1.convertOdspSnapshotToSnapshotTreeAndBlobs)(snapshotJson).sequenceNumber;
         }
-        else {
+        else if (contentType.includes("application/ms-fluid")) {
             // ms-fluid framing: the compact binary form; read it with the driver's compact-snapshot parser.
             const bytes = new Uint8Array(await response.content.arrayBuffer());
             sequenceNumber = (0, compactSnapshotParser_js_1.parseCompactSnapshotResponse)(bytes, logger).sequenceNumber;
         }
-        // A version's snapshot must carry a sequence number; a missing one is surfaced as an error
-        // naming the version, rather than returning a wrong value.
-        if (sequenceNumber === undefined) {
-            throw new Error(`ODSP file version ${versionId} snapshot is missing a sequenceNumber`);
+        else {
+            // Neither framing (e.g. an HTML error page). Throw the driver's typed bad-response error
+            // (like fetchSnapshot.ts): canRetry=false stops the loader re-driving, while the
+            // incorrectServerResponse errorType still earns one wire-retry from getWithRetryForTokenRefresh.
+            throw new internal_1.NonRetryableError(`ODSP file version ${versionId} snapshot returned an unexpected content-type`, internal_2.OdspErrorTypes.incorrectServerResponse, { driverVersion: packageVersion_js_1.pkgVersion, contentType, accept: headers.accept });
+        }
+        // The sequence number must be a non-negative integer; a missing or malformed one throws the same
+        // typed error as above rather than feeding a wrong value into base selection.
+        if (!(typeof sequenceNumber === "number" &&
+            Number.isInteger(sequenceNumber) &&
+            sequenceNumber >= 0)) {
+            throw new internal_1.NonRetryableError(`ODSP file version ${versionId} snapshot has a missing or invalid sequenceNumber (${String(sequenceNumber)})`, internal_2.OdspErrorTypes.incorrectServerResponse, { driverVersion: packageVersion_js_1.pkgVersion, contentType, accept: headers.accept });
         }
         return sequenceNumber;
     });
-    return { listFileVersions, resolveSequenceNumber };
+    const itemRoot = `${(0, odspUrlHelper_js_1.getApiRoot)(new URL(siteUrl))}/drives/${driveId}/items/${itemId}`;
+    // Reads the `x-fluid-epoch` header from `url`. Deliberately uses the raw fetch helper instead of
+    // `epochTracker.fetch`: the whole point is to COMPARE the base version's epoch against the live
+    // document's epoch, but the shared EpochTracker pins to the first epoch it sees and throws on the
+    // second (divergent) read - so it could never yield two epochs to compare. `fetchArray` also lets
+    // the body (JSON or ms-fluid binary) be consumed and discarded; only the header is needed.
+    const readEpoch = async (url, scenarioName) => (0, odspUtils_js_1.getWithRetryForTokenRefresh)(async (options) => {
+        const method = "GET";
+        const token = await getAuthHeader({ ...options, request: { url, method } }, scenarioName);
+        const headers = (0, getUrlAndHeadersWithAuth_js_1.getHeadersWithAuth)(token);
+        const response = await (0, odspUtils_js_1.fetchArray)(url, { method, headers });
+        return response.headers.get("x-fluid-epoch") ?? undefined;
+    });
+    const getLiveDocumentEpoch = async () => 
+    // The (unversioned) live snapshot endpoint is a current-file read, so its epoch is the live
+    // document's epoch. `blobs=0` keeps the response to the tree metadata.
+    readEpoch(`${itemRoot}/opStream/snapshots/trees/latest?blobs=0`, "LiveEpoch");
+    const getRecoverableVersionEpoch = async (versionId) => readEpoch(`${itemRoot}/versions/${encodeURIComponent(versionId)}/opStream/snapshots/trees/latest?blobs=0`, "FileVersionEpoch");
+    return {
+        listFileVersions,
+        resolveSequenceNumber,
+        getLiveDocumentEpoch,
+        getRecoverableVersionEpoch,
+    };
 }
 exports.createOdspFileVersionFetcher = createOdspFileVersionFetcher;
 //# sourceMappingURL=odspFileVersionFetcher.js.map