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

package/src/contracts.ts

@@ -7,75 +7,33 @@ import * as api from "@fluidframework/protocol-definitions";
 import { HostStoragePolicy } from "@fluidframework/odsp-driver-definitions";
 import { ISnapshotContents } from "./odspPublicUtils";
 
-/** https://portal.microsofticm.com/imp/v3/incidents/details/308931013/home
- * The commits property was removed from protocol-definitions but in order to support back compat, we will
- * temporarily add back in this local structure in order to upload the snapshot to support rolling back to 0.58.
- * Notice this entire interface will be removed once the backward compatibility is not required anymore.
-*/
-export interface ISnapshotTreeEx {
-    id?: string;
-    blobs: { [path: string]: string; };
-    commits: { [path: string]: string; };
-    trees: { [path: string]: ISnapshotTreeEx; };
-    // Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.
-    unreferenced?: true;
-}
-
-/**
- * Socket storage discovery api response
- */
-export interface ISocketStorageDiscovery {
-    // The id of the web socket
-    id: string;
-
-    // SPO gives us runtimeTenantId, we remap it to tenantId
-    // See getSocketStorageDiscovery
-    runtimeTenantId?: string;
-    tenantId: string;
-
-    snapshotStorageUrl: string;
-    deltaStorageUrl: string;
-
-    /**
-     * PUSH URL
-     */
-    deltaStreamSocketUrl: string;
-
-    /**
-     * The access token for PushChannel. Optionally returned, depending on implementation.
-     * OneDrive for Consumer implementation returns it and OneDrive for Business implementation
-     * does not return it and instead expects token to be returned via `getWebsocketToken` callback
-     * passed as a parameter to `OdspDocumentService.create()` factory.
-     */
-    socketToken?: string;
-
-    /**
-     * This is the time within which client has to refresh the session on (ODSP) relay service.
-     */
-    refreshSessionDurationSeconds?: number;
-}
-
 /**
  * Interface for error responses for the WebSocket connection
  */
 export interface IOdspSocketError {
-    /**
-     * An error code number for the error that occurred
-     * It will be a valid HTTP status code
-     */
-    code: number;
-
-    /**
-     * A message about the error that occurred for debugging / logging purposes
-     * This should not be displayed to the user directly
-     */
-    message: string;
-
-    /**
-     * Optional Retry-After time in seconds
-     * The client should wait this many seconds before retrying its request
-     */
-    retryAfter?: number;
+	/**
+	 * An error code number for the error that occurred
+	 * It will be a valid HTTP status code
+	 */
+	code: number;
+
+	/**
+	 * A message about the error that occurred for debugging / logging purposes
+	 * This should not be displayed to the user directly
+	 */
+	message: string;
+
+	/**
+	 * Optional Retry-After time in seconds
+	 * The client should wait this many seconds before retrying its request
+	 */
+	retryAfter?: number;
+
+	/**
+	 * Any error supplied by the socket containing codes and inner errors with further
+	 * details about the error.
+	 */
+	error?: any;
 }
 
 /**
@@ -83,20 +41,20 @@ export interface IOdspSocketError {
  * Contains either SequencedDocumentMessages or SequencedDeltaOpMessage.
  */
 export interface IDeltaStorageGetResponse {
-    value: api.ISequencedDocumentMessage[] | ISequencedDeltaOpMessage[];
+	value: api.ISequencedDocumentMessage[] | ISequencedDeltaOpMessage[];
 }
 
 export interface ISequencedDeltaOpMessage {
-    op: api.ISequencedDocumentMessage;
-    sequenceNumber: number;
+	op: api.ISequencedDocumentMessage;
+	sequenceNumber: number;
 }
 
 export interface IDocumentStorageGetVersionsResponse {
-    value: IDocumentStorageVersion[];
+	value: IDocumentStorageVersion[];
 }
 
 export interface IDocumentStorageVersion {
-    id: string;
+	id: string;
 }
 
 /**
@@ -106,44 +64,44 @@ export interface IDocumentStorageVersion {
  */
 
 export interface IOdspSummaryPayload {
-    type: "container" | "channel";
-    message: string;
-    sequenceNumber: number;
-    entries: OdspSummaryTreeEntry[];
+	type: "container" | "channel";
+	message: string;
+	sequenceNumber: number;
+	entries: OdspSummaryTreeEntry[];
 }
 
 export interface IWriteSummaryResponse {
-    id: string;
+	id: string;
 }
 
 export type OdspSummaryTreeEntry = IOdspSummaryTreeValueEntry | IOdspSummaryTreeHandleEntry;
 
 export interface IOdspSummaryTreeBaseEntry {
-    path: string;
-    type: "blob" | "tree" | "commit";
+	path: string;
+	type: "blob" | "tree" | "commit";
 }
 
 export interface IOdspSummaryTreeValueEntry extends IOdspSummaryTreeBaseEntry {
-    value: OdspSummaryTreeValue;
-    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.
-    unreferenced?: true;
+	value: OdspSummaryTreeValue;
+	// Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.
+	unreferenced?: true;
 }
 
 export interface IOdspSummaryTreeHandleEntry extends IOdspSummaryTreeBaseEntry {
-    id: string;
+	id: string;
 }
 
 export type OdspSummaryTreeValue = IOdspSummaryTree | IOdspSummaryBlob;
 
 export interface IOdspSummaryTree {
-    type: "tree";
-    entries?: OdspSummaryTreeEntry[];
+	type: "tree";
+	entries?: OdspSummaryTreeEntry[];
 }
 
 export interface IOdspSummaryBlob {
-    type: "blob";
-    content: string;
-    encoding: "base64" | "utf-8";
+	type: "blob";
+	content: string;
+	encoding: "base64" | "utf-8";
 }
 
 /**
@@ -153,52 +111,52 @@ export interface IOdspSummaryBlob {
  */
 
 export interface IOdspSnapshotTreeEntryTree {
-    path: string;
-    type: "tree";
-    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.
-    unreferenced?: true;
+	path: string;
+	type: "tree";
+	// Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.
+	unreferenced?: true;
 }
 
 export interface IOdspSnapshotTreeEntryCommit {
-    id: string;
-    path: string;
-    type: "commit";
+	id: string;
+	path: string;
+	type: "commit";
 }
 
 export interface IOdspSnapshotTreeEntryBlob {
-    id: string;
-    path: string;
-    type: "blob";
+	id: string;
+	path: string;
+	type: "blob";
 }
 
 export type IOdspSnapshotTreeEntry =
-    | IOdspSnapshotTreeEntryTree
-    | IOdspSnapshotTreeEntryCommit
-    | IOdspSnapshotTreeEntryBlob;
+	| IOdspSnapshotTreeEntryTree
+	| IOdspSnapshotTreeEntryCommit
+	| IOdspSnapshotTreeEntryBlob;
 
 export interface IOdspSnapshotCommit {
-    entries: IOdspSnapshotTreeEntry[];
-    id: string;
-    sequenceNumber: number;
+	entries: IOdspSnapshotTreeEntry[];
+	id: string;
+	sequenceNumber: number;
 }
 
 /**
  * Blob content, represents blobs in downloaded snapshot.
  */
 export interface IOdspSnapshotBlob {
-    content: string;
-    // SPO only uses "base64" today for download.
-    // We are adding undefined too, as temp way to roundtrip strings unchanged.
-    encoding: "base64" | undefined;
-    id: string;
-    size: number;
+	content: string;
+	// SPO only uses "base64" today for download.
+	// We are adding undefined too, as temp way to roundtrip strings unchanged.
+	encoding: "base64" | undefined;
+	id: string;
+	size: number;
 }
 
 export interface IOdspSnapshot {
-    id: string;
-    trees: IOdspSnapshotCommit[];
-    blobs?: IOdspSnapshotBlob[];
-    ops?: ISequencedDeltaOpMessage[];
+	id: string;
+	trees: IOdspSnapshotCommit[];
+	blobs?: IOdspSnapshotBlob[];
+	ops?: ISequencedDeltaOpMessage[];
 }
 
 /**
@@ -206,48 +164,50 @@ export interface IOdspSnapshot {
  * All fields should be optional.
  */
 export interface HostStoragePolicyInternal extends HostStoragePolicy {
-    summarizerClient?: boolean;
+	summarizerClient?: boolean;
 }
 
 export interface ICreateFileResponse {
-    "@odata.context": string;
-    driveId: string;
-    id: string;
-    itemId: string;
-    itemUrl: string;
-    sequenceNumber: number;
-    sharingLink?: string;
-    sharingLinkErrorReason?: string;
+	"@odata.context": string;
+	"driveId": string;
+	"id": string;
+	"itemId": string;
+	"itemUrl": string;
+	"sequenceNumber": number;
+	// sharing object contains shareId, sharingLink data or error in the response
+	"sharing"?: any;
+	"sharingLink"?: string;
+	"sharingLinkErrorReason"?: string;
 }
 
 export interface IVersionedValueWithEpoch {
-    value: any;
-    fluidEpoch: string;
-    // This is same as "persistedCacheValueVersion" below. This represents the version of data stored in cache.
-    version: 3;
+	value: any;
+	fluidEpoch: string;
+	// This is same as "persistedCacheValueVersion" below. This represents the version of data stored in cache.
+	version: 3;
 }
 
 export const persistedCacheValueVersion = 3;
 
 export interface IGetOpsResponse {
-    nonce: string;
-    code: number;
-    /** Time in seconds. Currently never set by PUSH */
-    retryAfter?: number;
-    messages?: api.ISequencedDocumentMessage[];
+	nonce: string;
+	code: number;
+	/** Time in seconds. Currently never set by PUSH */
+	retryAfter?: number;
+	messages?: api.ISequencedDocumentMessage[];
 }
 
 export interface IFlushOpsResponse {
-    nonce: string;
-    code: number;
-    /** Time in seconds */
-    retryAfter?: number;
-    lastPersistedSequenceNumber?: number;
+	nonce: string;
+	code: number;
+	/** Time in seconds */
+	retryAfter?: number;
+	lastPersistedSequenceNumber?: number;
 }
 
 /**
  * Represents the cached snapshot value.
  */
 export interface ISnapshotCachedEntry extends ISnapshotContents {
-    cacheEntryTime: number;
+	cacheEntryTime: number;
 }

package/src/contractsPublic.ts

@@ -5,35 +5,50 @@
 
 import { IOdspUrlParts } from "@fluidframework/odsp-driver-definitions";
 
+/**
+ * @alpha
+ */
 export interface OdspFluidDataStoreLocator extends IOdspUrlParts {
-    dataStorePath: string;
-    appName?: string;
-    containerPackageName?: string;
-    fileVersion?: string;
-    context?: string;
+	dataStorePath: string;
+	appName?: string;
+	containerPackageName?: string;
+	fileVersion?: string;
+	context?: string;
 }
 
+/**
+ * @internal
+ */
 export enum SharingLinkHeader {
-    // Can be used in request made to resolver, to tell the resolver that the passed in URL is a sharing link
-    // which can be redeemed at server to get permissions.
-    isSharingLinkToRedeem = "isSharingLinkToRedeem",
+	// Can be used in request made to resolver, to tell the resolver that the passed in URL is a sharing link
+	// which can be redeemed at server to get permissions.
+	isSharingLinkToRedeem = "isSharingLinkToRedeem",
 }
 
+/**
+ * @internal
+ */
 export interface ISharingLinkHeader {
-    [SharingLinkHeader.isSharingLinkToRedeem]: boolean;
+	[SharingLinkHeader.isSharingLinkToRedeem]: boolean;
 }
-
+/**
+ * @internal
+ */
 export enum ClpCompliantAppHeader {
-    // Can be used in request made to resolver, to tell the resolver that the host app is CLP compliant.
-    // Odsp will not return Classified, labeled, or protected documents if the host app cannot support them.
-    isClpCompliantApp = "X-CLP-Compliant-App",
+	// Can be used in request made to resolver, to tell the resolver that the host app is CLP compliant.
+	// Odsp will not return Classified, labeled, or protected documents if the host app cannot support them.
+	isClpCompliantApp = "X-CLP-Compliant-App",
 }
 
+/**
+ * @internal
+ */
 export interface IClpCompliantAppHeader {
-    [ClpCompliantAppHeader.isClpCompliantApp]: boolean;
+	[ClpCompliantAppHeader.isClpCompliantApp]: boolean;
 }
 
 declare module "@fluidframework/core-interfaces" {
-    // eslint-disable-next-line @typescript-eslint/no-empty-interface
-    export interface IRequestHeader extends Partial<ISharingLinkHeader>, Partial<IClpCompliantAppHeader> { }
+	export interface IRequestHeader
+		extends Partial<ISharingLinkHeader>,
+			Partial<IClpCompliantAppHeader> {}
 }