@fluidframework/odsp-driver-definitions 2.0.0-internal.3.0.2 → 2.0.0-internal.3.2.0

package/src/resolvedUrl.ts

@@ -6,55 +6,55 @@
 import { IFluidResolvedUrl } from "@fluidframework/driver-definitions";
 
 export interface IOdspUrlParts {
-    siteUrl: string;
-    driveId: string;
-    itemId: string;
+	siteUrl: string;
+	driveId: string;
+	itemId: string;
 }
 
 /**
  * @deprecated Use ISharingLinkKind type instead.
  * Type of shareLink requested/created when creating the file for the first time.
-*/
+ */
 export enum ShareLinkTypes {
-    csl = "csl",
+	csl = "csl",
 }
 
 /**
  * Sharing scope of the share links created for a file.
-*/
+ */
 export enum SharingLinkScope {
-    organization = "organization",
-    users = "users",
-    anonymous = "anonymous",
-    default = "default",
+	organization = "organization",
+	users = "users",
+	anonymous = "anonymous",
+	default = "default",
 }
 
 /**
  * View/edit permission role for a sharing link.
  */
 export enum SharingLinkRole {
-    view = "view",
-    edit = "edit",
+	view = "view",
+	edit = "edit",
 }
 
 /**
  * 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.
-*/
+ */
 export interface ISharingLinkKind {
-    scope: SharingLinkScope;
-    /*
-     * If this parameter is not provided, the API will default to "edit" links (provided
-     * a valid createLinkScope setting is given).
-    */
-    role?: SharingLinkRole;
+	scope: SharingLinkScope;
+	/*
+	 * If this parameter is not provided, the API will default to "edit" links (provided
+	 * a valid createLinkScope setting is given).
+	 */
+	role?: SharingLinkRole;
 }
 
 /**
  * Sharing link data received from the /snapshot api response.
  */
 export interface ISharingLink extends ISharingLinkKind {
-    webUrl: string;
+	webUrl: string;
 }
 
 /**
@@ -63,84 +63,82 @@ export interface ISharingLink extends ISharingLinkKind {
  * a redeemable share link created when loading an existing file
  */
 export interface ShareLinkInfoType {
-
-    /**
-     * We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to
-     * create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature
-     * where we can create a share link along with creating a file by passing a query parameter called
-     * createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information
-     * from the /snapshot api response.
-     */
-    createLink?: {
-        /**
-         * @deprecated
-         * Type of shareLink requested/created when creating the file for the first time. The 'type' property here
-         * represents the type of sharing link requested.
-         * Will be deprecated soon. Type of sharing link will be present in the link:ISharingLink property below.
-        */
-        type?: ShareLinkTypes | ISharingLinkKind;
-
-        /**
-         * Share link created when the file is created for the first time with /snapshot api call.
-         */
-        link?: string | ISharingLink;
-
-        /**
-         * Error message if creation of sharing link fails with /snapshot api call
-         */
-        error?: any;
-
-        shareId?: string;
-
-    };
-
-    /**
-     * This is used to save the network calls while doing trees/latest call as if the client does not have
-     * permission then this link can be redeemed for the permissions in the same network call.
-     */
-    sharingLinkToRedeem?: string;
+	/**
+	 * We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to
+	 * create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature
+	 * where we can create a share link along with creating a file by passing a query parameter called
+	 * createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information
+	 * from the /snapshot api response.
+	 */
+	createLink?: {
+		/**
+		 * @deprecated
+		 * Type of shareLink requested/created when creating the file for the first time. The 'type' property here
+		 * represents the type of sharing link requested.
+		 * Will be deprecated soon. Type of sharing link will be present in the link:ISharingLink property below.
+		 */
+		type?: ShareLinkTypes | ISharingLinkKind;
+
+		/**
+		 * Share link created when the file is created for the first time with /snapshot api call.
+		 */
+		link?: string | ISharingLink;
+
+		/**
+		 * Error message if creation of sharing link fails with /snapshot api call
+		 */
+		error?: any;
+
+		shareId?: string;
+	};
+
+	/**
+	 * This is used to save the network calls while doing trees/latest call as if the client does not have
+	 * permission then this link can be redeemed for the permissions in the same network call.
+	 */
+	sharingLinkToRedeem?: string;
 }
 export interface IOdspResolvedUrl extends IFluidResolvedUrl, IOdspUrlParts {
-    type: "fluid";
-    odspResolvedUrl: true;
+	type: "fluid";
+	odspResolvedUrl: true;
 
-    // URL to send to fluid, contains the documentId and the path
-    url: string;
+	// URL to send to fluid, contains the documentId and the path
+	url: string;
 
-    // A hashed identifier that is unique to this document
-    hashedDocumentId: string;
+	// A hashed identifier that is unique to this document
+	hashedDocumentId: string;
 
-    endpoints: {
-        snapshotStorageUrl: string;
-        attachmentPOSTStorageUrl: string;
-        attachmentGETStorageUrl: string;
-        deltaStorageUrl: string;
-    };
+	endpoints: {
+		snapshotStorageUrl: string;
+		attachmentPOSTStorageUrl: string;
+		attachmentGETStorageUrl: string;
+		deltaStorageUrl: string;
+	};
 
-    // Tokens are not obtained by the ODSP driver using the resolve flow, the app must provide them.
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    tokens: {};
+	// Tokens are not obtained by the ODSP driver using the resolve flow, the app must provide them.
+	// eslint-disable-next-line @typescript-eslint/ban-types
+	tokens: {};
 
-    fileName: string;
+	fileName: string;
 
-    summarizer: boolean;
+	summarizer: boolean;
 
-    codeHint?: {
-        // containerPackageName is used for adding the package name to the request headers.
-        // This may be used for preloading the container package when loading Fluid content.
-        containerPackageName?: string;
-    };
+	codeHint?: {
+		// containerPackageName is used for adding the package name to the request headers.
+		// This may be used for preloading the container package when loading Fluid content.
+		containerPackageName?: string;
+	};
 
-    fileVersion: string | undefined;
+	fileVersion: string | undefined;
 
-    dataStorePath?: string;
+	dataStorePath?: string;
 
-    /**
-     * 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
-     */
-    shareLinkInfo?: ShareLinkInfoType;
+	/**
+	 * 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
+	 */
+	shareLinkInfo?: ShareLinkInfoType;
 
-    isClpCompliantApp?: boolean;
+	isClpCompliantApp?: boolean;
 }

package/src/tokenFetch.ts

@@ -7,49 +7,49 @@
  * Represents token response
  */
 export interface TokenResponse {
-    /** Token value */
-    token: string;
+	/** Token value */
+	token: string;
 
-    /** Flag indicating whether token was obtained from local cache */
-    fromCache?: boolean;
+	/** Flag indicating whether token was obtained from local cache */
+	fromCache?: boolean;
 }
 
 /**
  * Represents access token fetch options
  */
 export interface TokenFetchOptions {
-    /**
-     * Value indicating whether fresh token has to be returned.
-     * If false then it is okay to return cached unexpired token if available.
-     */
-    refresh: boolean;
+	/**
+	 * Value indicating whether fresh token has to be returned.
+	 * If false then it is okay to return cached unexpired token if available.
+	 */
+	refresh: boolean;
 
-    /**
-     * Claims that have to be passed with token fetch request.
-     * These can be used to specify additional information that must be passed to token authority.
-     */
-    claims?: string;
+	/**
+	 * Claims that have to be passed with token fetch request.
+	 * These can be used to specify additional information that must be passed to token authority.
+	 */
+	claims?: string;
 
-    /**
-     * Tenant id of authority that must be handling token fetch.
-     * If it is not specified then it is up to token fetching logic to determine which tenant authority
-     * to use to issue access token.
-     */
-    tenantId?: string;
+	/**
+	 * Tenant id of authority that must be handling token fetch.
+	 * If it is not specified then it is up to token fetching logic to determine which tenant authority
+	 * to use to issue access token.
+	 */
+	tenantId?: string;
 }
 
 /**
  * Represents access token fetch options for ODSP resource
  */
 export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
-    /** Site url representing ODSP resource location */
-    siteUrl: string;
+	/** Site url representing ODSP resource location */
+	siteUrl: string;
 
-    /** ODSP drive id where resource resides. Optional, used only when fetching token to access ODSP file */
-    driveId?: string;
+	/** ODSP drive id where resource resides. Optional, used only when fetching token to access ODSP file */
+	driveId?: string;
 
-    /** ODSP item id representing resource. Optional, used only when fetching token to access ODSP file */
-    itemId?: string;
+	/** ODSP item id representing resource. Optional, used only when fetching token to access ODSP file */
+	itemId?: string;
 }
 
 /**
@@ -66,10 +66,14 @@ export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | n
  * @param tokenResponse - return value for TokenFetcher method
  * @returns Token value
  */
-export const tokenFromResponse = (tokenResponse: string | TokenResponse | null | undefined): string | null =>
-    tokenResponse === null || typeof tokenResponse === "string"
-        ? tokenResponse
-        : tokenResponse === undefined ? null : tokenResponse.token;
+export const tokenFromResponse = (
+	tokenResponse: string | TokenResponse | null | undefined,
+): string | null =>
+	tokenResponse === null || typeof tokenResponse === "string"
+		? tokenResponse
+		: tokenResponse === undefined
+		? null
+		: tokenResponse.token;
 
 /**
  * Helper method which returns flag indicating whether token response comes from local cache
@@ -77,10 +81,12 @@ export const tokenFromResponse = (tokenResponse: string | TokenResponse | null |
  * @returns Value indicating whether response came from cache.
  * Undefined is returned when we could not determine the source of token.
  */
-export const isTokenFromCache = (tokenResponse: string | TokenResponse | null): boolean | undefined =>
-    tokenResponse === null || typeof tokenResponse === "string"
-        ? undefined
-        : tokenResponse.fromCache;
+export const isTokenFromCache = (
+	tokenResponse: string | TokenResponse | null,
+): boolean | undefined =>
+	tokenResponse === null || typeof tokenResponse === "string"
+		? undefined
+		: tokenResponse.fromCache;
 
 /**
  * Identity types supported by ODSP driver.
@@ -90,6 +96,7 @@ export const isTokenFromCache = (tokenResponse: string | TokenResponse | null):
 export type IdentityType = "Consumer" | "Enterprise";
 
 export type InstrumentedStorageTokenFetcher = (
-    options: TokenFetchOptions,
-    name: string,
-    alwaysRecordTokenFetchTelemetry?: boolean) => Promise<string | null>;
+	options: TokenFetchOptions,
+	name: string,
+	alwaysRecordTokenFetchTelemetry?: boolean,
+) => Promise<string | null>;

package/tsconfig.esnext.json

@@ -1,7 +1,7 @@
 {
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "module": "esnext"
-    },
-}
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}

package/tsconfig.json

@@ -1,14 +1,10 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "src/test/**/*"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "composite": true
-    },
-    "include": [
-        "src/**/*"
-    ]
-}
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"composite": true,
+	},
+	"include": ["src/**/*"],
+}

package/.editorconfig

@@ -1,7 +0,0 @@
-[*]
-indent_size = 4
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[package.json]
-indent_size = 2