|
| 1 | +## Alpha API Report File for "@fluidframework/odsp-driver" |
| 2 | + |
| 3 | +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
| 4 | +
|
| 5 | +```ts |
| 6 | + |
| 7 | +// @beta @legacy |
| 8 | +export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined; |
| 9 | + |
| 10 | +// @beta @legacy |
| 11 | +export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory; |
| 12 | + |
| 13 | +// @beta @legacy |
| 14 | +export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest; |
| 15 | + |
| 16 | +// @beta @legacy |
| 17 | +export function createOdspUrl(l: OdspFluidDataStoreLocator): string; |
| 18 | + |
| 19 | +// @beta @legacy |
| 20 | +export function encodeOdspFluidDataStoreLocator(locator: OdspFluidDataStoreLocator): string; |
| 21 | + |
| 22 | +// @beta @legacy |
| 23 | +export class EpochTracker implements IPersistedFileCache { |
| 24 | + constructor(cache: IPersistedCache, fileEntry: IFileEntry, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean | undefined); |
| 25 | + // (undocumented) |
| 26 | + protected readonly cache: IPersistedCache; |
| 27 | + // (undocumented) |
| 28 | + protected readonly clientIsSummarizer?: boolean | undefined; |
| 29 | + fetch(url: string, fetchOptions: RequestInit, fetchType: FetchType, addInBody?: boolean, fetchReason?: string): Promise<IOdspResponse<Response>>; |
| 30 | + fetchAndParseAsJSON<T>(url: string, fetchOptions: RequestInit, fetchType: FetchType, addInBody?: boolean, fetchReason?: string): Promise<IOdspResponse<T>>; |
| 31 | + fetchArray(url: string, fetchOptions: { |
| 32 | + [index: string]: RequestInit; |
| 33 | + }, fetchType: FetchType, addInBody?: boolean, fetchReason?: string): Promise<IOdspResponse<ArrayBuffer>>; |
| 34 | + // (undocumented) |
| 35 | + protected readonly fileEntry: IFileEntry; |
| 36 | + // (undocumented) |
| 37 | + get fluidEpoch(): string | undefined; |
| 38 | + // (undocumented) |
| 39 | + get(entry: IEntry): Promise<any>; |
| 40 | + // (undocumented) |
| 41 | + protected readonly logger: ITelemetryLoggerExt; |
| 42 | + // (undocumented) |
| 43 | + put(entry: IEntry, value: any): Promise<void>; |
| 44 | + // (undocumented) |
| 45 | + readonly rateLimiter: RateLimiter; |
| 46 | + // (undocumented) |
| 47 | + removeEntries(): Promise<void>; |
| 48 | + // (undocumented) |
| 49 | + setEpoch(epoch: string, fromCache: boolean, fetchType: FetchTypeInternal): void; |
| 50 | + // (undocumented) |
| 51 | + validateEpoch(epoch: string | undefined, fetchType: FetchType): Promise<void>; |
| 52 | + // (undocumented) |
| 53 | + protected validateEpochFromResponse(epochFromResponse: string | undefined, fetchType: FetchTypeInternal, fromCache?: boolean): void; |
| 54 | +} |
| 55 | + |
| 56 | +// @beta @legacy (undocumented) |
| 57 | +export type FetchType = "blob" | "createBlob" | "createFile" | "joinSession" | "ops" | "test" | "snapshotTree" | "treesLatest" | "uploadSummary" | "push" | "versions" | "renameFile"; |
| 58 | + |
| 59 | +// @beta @legacy (undocumented) |
| 60 | +export type FetchTypeInternal = FetchType | "cache"; |
| 61 | + |
| 62 | +// @beta @legacy |
| 63 | +export function getHashedDocumentId(driveId: string, itemId: string): Promise<string>; |
| 64 | + |
| 65 | +// @beta @legacy |
| 66 | +export function getLocatorFromOdspUrl(url: URL, requireFluidSignature?: boolean): OdspFluidDataStoreLocator | undefined; |
| 67 | + |
| 68 | +// @beta @legacy (undocumented) |
| 69 | +export interface ICacheAndTracker { |
| 70 | + // (undocumented) |
| 71 | + cache: IOdspCache; |
| 72 | + // (undocumented) |
| 73 | + epochTracker: EpochTracker; |
| 74 | +} |
| 75 | + |
| 76 | +// @beta @legacy |
| 77 | +export interface INonPersistentCache { |
| 78 | + readonly fileUrlCache: PromiseCache<string, IOdspResolvedUrl>; |
| 79 | + readonly sessionJoinCache: PromiseCache<string, { |
| 80 | + entryTime: number; |
| 81 | + joinSessionResponse: ISocketStorageDiscovery; |
| 82 | + }>; |
| 83 | + readonly snapshotPrefetchResultCache: PromiseCache<string, IPrefetchSnapshotContents>; |
| 84 | +} |
| 85 | + |
| 86 | +// @beta @legacy |
| 87 | +export interface IOdspCache extends INonPersistentCache { |
| 88 | + readonly persistedCache: IPersistedFileCache; |
| 89 | +} |
| 90 | + |
| 91 | +// @beta @legacy (undocumented) |
| 92 | +export interface IOdspResponse<T> { |
| 93 | + // (undocumented) |
| 94 | + content: T; |
| 95 | + // (undocumented) |
| 96 | + duration: number; |
| 97 | + // (undocumented) |
| 98 | + headers: Map<string, string>; |
| 99 | + // (undocumented) |
| 100 | + propsToLog: ITelemetryBaseProperties; |
| 101 | +} |
| 102 | + |
| 103 | +// @beta @legacy |
| 104 | +export interface IPersistedFileCache { |
| 105 | + // (undocumented) |
| 106 | + get(entry: IEntry): Promise<any>; |
| 107 | + // (undocumented) |
| 108 | + put(entry: IEntry, value: any): Promise<void>; |
| 109 | + // (undocumented) |
| 110 | + removeEntries(): Promise<void>; |
| 111 | +} |
| 112 | + |
| 113 | +// @beta @legacy (undocumented) |
| 114 | +export interface IPrefetchSnapshotContents extends ISnapshot { |
| 115 | + // (undocumented) |
| 116 | + fluidEpoch: string; |
| 117 | + // (undocumented) |
| 118 | + prefetchStartTime: number; |
| 119 | +} |
| 120 | + |
| 121 | +// @beta @deprecated @legacy (undocumented) |
| 122 | +export interface ISnapshotContents { |
| 123 | + // (undocumented) |
| 124 | + blobs: Map<string, ArrayBuffer>; |
| 125 | + latestSequenceNumber: number | undefined; |
| 126 | + // (undocumented) |
| 127 | + ops: ISequencedDocumentMessage[]; |
| 128 | + sequenceNumber: number | undefined; |
| 129 | + // (undocumented) |
| 130 | + snapshotTree: ISnapshotTree; |
| 131 | +} |
| 132 | + |
| 133 | +// @beta @legacy |
| 134 | +export function isOdspResolvedUrl(resolvedUrl: IResolvedUrl): resolvedUrl is IOdspResolvedUrl; |
| 135 | + |
| 136 | +// @beta @legacy |
| 137 | +export const locatorQueryParamName = "nav"; |
| 138 | + |
| 139 | +// @beta @legacy (undocumented) |
| 140 | +export const OdcApiSiteOrigin = "https://my.microsoftpersonalcontent.com"; |
| 141 | + |
| 142 | +// @beta @legacy (undocumented) |
| 143 | +export const OdcFileSiteOrigin = "https://1drv.ms"; |
| 144 | + |
| 145 | +// @beta @legacy |
| 146 | +export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore { |
| 147 | + constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy); |
| 148 | +} |
| 149 | + |
| 150 | +// @beta @legacy |
| 151 | +export class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory, IRelaySessionAwareDriverFactory { |
| 152 | + constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy); |
| 153 | + // (undocumented) |
| 154 | + createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>; |
| 155 | + // (undocumented) |
| 156 | + createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>; |
| 157 | + // (undocumented) |
| 158 | + protected createDocumentServiceCore(resolvedUrl: IResolvedUrl, odspLogger: ITelemetryBaseLogger, cacheAndTrackerArg?: ICacheAndTracker, clientIsSummarizer?: boolean): Promise<IDocumentService>; |
| 159 | + getRelayServiceSessionInfo(resolvedUrl: IResolvedUrl): Promise<ISocketStorageDiscovery | undefined>; |
| 160 | + readonly ILayerCompatDetails?: unknown; |
| 161 | + // (undocumented) |
| 162 | + get IRelaySessionAwareDriverFactory(): this; |
| 163 | + // (undocumented) |
| 164 | + protected persistedCache: IPersistedCache; |
| 165 | + // (undocumented) |
| 166 | + get snapshotPrefetchResultCache(): PromiseCache<string, IPrefetchSnapshotContents>; |
| 167 | +} |
| 168 | + |
| 169 | +// @beta @legacy |
| 170 | +export class OdspDriverUrlResolver implements IUrlResolver { |
| 171 | + constructor(); |
| 172 | + getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>; |
| 173 | + resolve(request: IRequest): Promise<IOdspResolvedUrl>; |
| 174 | +} |
| 175 | + |
| 176 | +// @beta @legacy |
| 177 | +export class OdspDriverUrlResolverForShareLink implements IUrlResolver { |
| 178 | + constructor(shareLinkFetcherProps?: ShareLinkFetcherProps | undefined, logger?: ITelemetryBaseLogger, appName?: string | undefined, getContext?: ((resolvedUrl: IOdspResolvedUrl, dataStorePath: string) => Promise<string | undefined>) | undefined, containerPackageInfo?: IContainerPackageInfo | undefined); |
| 179 | + appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined; |
| 180 | + appendLocatorParams(baseUrl: string, resolvedUrl: IResolvedUrl, dataStorePath: string, packageInfoSource?: IContainerPackageInfo): Promise<string>; |
| 181 | + static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator): string; |
| 182 | + getAbsoluteUrl(resolvedUrl: IResolvedUrl, dataStorePath: string, packageInfoSource?: IContainerPackageInfo): Promise<string>; |
| 183 | + resolve(request: IRequest): Promise<IOdspResolvedUrl>; |
| 184 | +} |
| 185 | + |
| 186 | +// @beta @legacy (undocumented) |
| 187 | +export interface OdspFluidDataStoreLocator extends IOdspUrlParts { |
| 188 | + // (undocumented) |
| 189 | + appName?: string | undefined; |
| 190 | + // (undocumented) |
| 191 | + containerPackageName?: string | undefined; |
| 192 | + // (undocumented) |
| 193 | + context?: string | undefined; |
| 194 | + // (undocumented) |
| 195 | + dataStorePath: string; |
| 196 | + // (undocumented) |
| 197 | + fileVersion?: string | undefined; |
| 198 | +} |
| 199 | + |
| 200 | +// @alpha @legacy |
| 201 | +export class OdspPointInTimeDocumentServiceFactory extends OdspDocumentServiceFactoryCore { |
| 202 | + constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy); |
| 203 | + createPointInTimeDocumentService(resolvedUrl: IResolvedUrl, targetSequenceNumber: number, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>; |
| 204 | +} |
| 205 | + |
| 206 | +// @beta @legacy |
| 207 | +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>; |
| 208 | + |
| 209 | +// @beta @legacy |
| 210 | +export interface ShareLinkFetcherProps { |
| 211 | + identityType: IdentityType; |
| 212 | + tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>; |
| 213 | +} |
| 214 | + |
| 215 | +// @beta @legacy |
| 216 | +export enum SnapshotFormatSupportType { |
| 217 | + // (undocumented) |
| 218 | + Binary = 1, |
| 219 | + // (undocumented) |
| 220 | + Json = 0, |
| 221 | + // (undocumented) |
| 222 | + JsonAndBinary = 2 |
| 223 | +} |
| 224 | + |
| 225 | +// @beta @legacy |
| 226 | +export function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocator): void; |
| 227 | + |
| 228 | +// (No @packageDocumentation comment for this package) |
| 229 | + |
| 230 | +``` |
0 commit comments