@fluidframework/odsp-driver-definitions 2.1.0-274160 → 2.1.0-276326

package/src/errors.ts

@@ -12,6 +12,7 @@ import {
 /**
  * ODSP Error types.
  * Different error types that may be thrown by the ODSP driver.
+ * @legacy
  * @alpha
  */
 export const OdspErrorTypes = {
@@ -63,11 +64,13 @@ export const OdspErrorTypes = {
 	blockedIPAddress: "blockedIPAddress",
 } as const;
 /**
+ * @legacy
  * @alpha
  */
 export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes];
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IOdspErrorAugmentations {
@@ -92,6 +95,7 @@ export interface IOdspErrorAugmentations {
 /**
  * Base interface for all errors and warnings
  * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
+ * @legacy
  * @alpha
  */
 export interface IOdspError
@@ -101,6 +105,7 @@ export interface IOdspError
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);

package/src/factory.ts

@@ -4,6 +4,7 @@
  */
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ISnapshotOptions {
@@ -29,6 +30,7 @@ export interface ISnapshotOptions {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IOpsCachingPolicy {
@@ -60,10 +62,12 @@ export interface IOpsCachingPolicy {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ICollabSessionOptions {
 	/**
+	 * @deprecated starting in 2.0-RC3. No longer needed.
 	 * Value indicating the display name for session that admits unauthenticated user.
 	 * This name will be used in attribution associated with edits made by such user.
 	 */
@@ -82,6 +86,7 @@ export interface ICollabSessionOptions {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface HostStoragePolicy {

package/src/index.ts

@@ -37,6 +37,7 @@ export {
 	OdspResourceTokenFetchOptions,
 	TokenFetcher,
 	TokenFetchOptions,
+	authHeaderFromTokenResponse,
 	tokenFromResponse,
 	TokenResponse,
 } from "./tokenFetch.js";

package/src/odspCache.ts

@@ -21,6 +21,7 @@ export const maximumCacheDurationMs: FiveDaysMs = 432_000_000; // 5 days in ms
  */
 export const snapshotKey = "snapshot";
 /**
+ * @legacy
  * @alpha
  */
 export type CacheContentType = "snapshot" | "ops";
@@ -31,6 +32,7 @@ export type CacheContentType = "snapshot" | "ops";
  * to implement storage / identify files.
  */
 /**
+ * @legacy
  * @alpha
  */
 export interface IFileEntry {
@@ -50,6 +52,7 @@ export interface IFileEntry {
 
 /**
  * Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
+ * @legacy
  * @alpha
  */
 export interface IEntry {
@@ -73,6 +76,7 @@ export interface IEntry {
 
 /**
  * Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
+ * @legacy
  * @alpha
  */
 export interface ICacheEntry extends IEntry {
@@ -88,6 +92,7 @@ export interface ICacheEntry extends IEntry {
  * cache implementation that does not survive across sessions. Snapshot entires stored in the
  * IPersistedCache will be considered stale and removed after 2 days. Read the README for more
  * information.
+ * @legacy
  * @alpha
  */
 export interface IPersistedCache {

package/src/resolvedUrl.ts

@@ -6,6 +6,7 @@
 import { IResolvedUrl } from "@fluidframework/driver-definitions/internal";
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IOdspUrlParts {
@@ -16,6 +17,7 @@ export interface IOdspUrlParts {
 
 /**
  * Sharing scope of the share links created for a file.
+ * @legacy
  * @alpha
  */
 export enum SharingLinkScope {
@@ -27,6 +29,7 @@ export enum SharingLinkScope {
 
 /**
  * View/edit permission role for a sharing link.
+ * @legacy
  * @alpha
  */
 export enum SharingLinkRole {
@@ -37,6 +40,7 @@ export enum SharingLinkRole {
 /**
  * Defines the permissions scope for a share link requested to be created during the creation the file in ODSP.
  * Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.
+ * @legacy
  * @alpha
  */
 export interface ISharingLinkKind {
@@ -50,6 +54,7 @@ export interface ISharingLinkKind {
 
 /**
  * Sharing link data received from the /snapshot api response.
+ * @legacy
  * @alpha
  */
 export interface ISharingLink extends ISharingLinkKind {
@@ -60,6 +65,7 @@ export interface ISharingLink extends ISharingLinkKind {
  * Sharing link data created for the ODSP item.
  * Contains information about either sharing link created while creating a new file or
  * a redeemable share link created when loading an existing file
+ * @legacy
  * @alpha
  */
 export interface ShareLinkInfoType {
@@ -91,6 +97,7 @@ export interface ShareLinkInfoType {
 	sharingLinkToRedeem?: string;
 }
 /**
+ * @legacy
  * @alpha
  */
 export interface IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts {

package/src/sessionProvider.ts

@@ -7,6 +7,7 @@ import { IResolvedUrl } from "@fluidframework/driver-definitions/internal";
 
 /**
  * Socket storage discovery api response
+ * @legacy
  * @alpha
  */
 export interface ISocketStorageDiscovery {
@@ -50,6 +51,7 @@ export interface ISocketStorageDiscovery {
 /**
  * An interface that allows a concrete instance of a driver factory to interrogate itself
  * to find out if it is session aware.
+ * @legacy
  * @alpha
  */
 export interface IProvideSessionAwareDriverFactory {
@@ -59,6 +61,7 @@ export interface IProvideSessionAwareDriverFactory {
 /**
  * An interface that allows a concrete instance of a driver factory to call the `getRelayServiceSessionInfo`
  * function if it session aware.
+ * @legacy
  * @alpha
  */
 export interface IRelaySessionAwareDriverFactory extends IProvideSessionAwareDriverFactory {

package/src/tokenFetch.ts

@@ -5,12 +5,20 @@
 
 /**
  * Represents token response
+ * @legacy
  * @alpha
  */
 export interface TokenResponse {
 	/** Token value */
 	token: string;
 
+	/**
+	 * Authorization header value will be used verbatim when making network call that requires the token.
+	 * If not returned the token value will be assumed to be a Bearer token and will be used to generate the
+	 * Authorization header value in the following format: `Bearer ${token}`.
+	 */
+	readonly authorizationHeader?: string;
+
 	/**
 	 * Whether or not the token was obtained from local cache.
 	 * @remarks `undefined` indicates that it could not be determined whether or not the token was obtained this way.
@@ -20,6 +28,7 @@ export interface TokenResponse {
 
 /**
  * Represents access token fetch options
+ * @legacy
  * @alpha
  */
 export interface TokenFetchOptions {
@@ -41,10 +50,19 @@ export interface TokenFetchOptions {
 	 * to use to issue access token.
 	 */
 	tenantId?: string;
+
+	/**
+	 * Request that will be made using the fetched token.
+	 * - url: full request url, including query params
+	 * - method: method type
+	 * Request info may be encoded into the returned token that the receiver can use to validate that caller is allowed to make specific call.
+	 */
+	readonly request?: { url: string; method: "GET" | "POST" | "PATCH" | "DELETE" | "PUT" };
 }
 
 /**
  * Represents access token fetch options for ODSP resource
+ * @legacy
  * @alpha
  */
 export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
@@ -64,6 +82,7 @@ export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
  * @returns If successful, TokenResponse object representing token value along with flag indicating
  * whether token came from cache. Legacy implementation may return a string for token value;
  * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.
+ * @legacy
  * @alpha
  */
 export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;
@@ -83,6 +102,25 @@ export const tokenFromResponse = (
 			? null
 			: tokenResponse.token;
 
+/**
+ * Helper method which transforms return value for TokenFetcher method to Authorization header value
+ * @param tokenResponse - return value for TokenFetcher method
+ * @returns Authorization header value
+ * @internal
+ */
+export const authHeaderFromTokenResponse = (
+	tokenResponse: string | TokenResponse | null | undefined,
+): string | null => {
+	if (typeof tokenResponse === "object" && tokenResponse?.authorizationHeader !== undefined) {
+		return tokenResponse.authorizationHeader;
+	}
+	const token = tokenFromResponse(tokenResponse);
+	if (token !== null) {
+		return `Bearer ${token}`;
+	}
+	return null;
+};
+
 /**
  * Helper method which returns flag indicating whether token response comes from local cache
  * @param tokenResponse - return value for TokenFetcher method
@@ -101,11 +139,13 @@ export const isTokenFromCache = (
  * Identity types supported by ODSP driver.
  * `Consumer` represents user authenticated with Microsoft Account (MSA).
  * `Enterprise` represents user authenticated with M365 tenant account.
+ * @legacy
  * @alpha
  */
 export type IdentityType = "Consumer" | "Enterprise";
 
 /**
+ * @returns Authorization header value
  * @internal
  */
 export type InstrumentedStorageTokenFetcher = (