@fluidframework/odsp-driver-definitions 2.0.0-dev.7.4.0.217212 → 2.0.0-dev.7.4.0.221926

package/src/resolvedUrl.ts

@@ -6,7 +6,7 @@
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
 
 /**
- * @internal
+ * @alpha
  */
 export interface IOdspUrlParts {
 	siteUrl: string;
@@ -17,7 +17,7 @@ export interface IOdspUrlParts {
 /**
  * @deprecated Use ISharingLinkKind type instead.
  * Type of shareLink requested/created when creating the file for the first time.
- * @internal
+ * @alpha
  */
 export enum ShareLinkTypes {
 	csl = "csl",
@@ -25,7 +25,7 @@ export enum ShareLinkTypes {
 
 /**
  * Sharing scope of the share links created for a file.
- * @internal
+ * @alpha
  */
 export enum SharingLinkScope {
 	organization = "organization",
@@ -36,7 +36,7 @@ export enum SharingLinkScope {
 
 /**
  * View/edit permission role for a sharing link.
- * @internal
+ * @alpha
  */
 export enum SharingLinkRole {
 	view = "view",
@@ -46,7 +46,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.
- * @internal
+ * @alpha
  */
 export interface ISharingLinkKind {
 	scope: SharingLinkScope;
@@ -59,7 +59,7 @@ export interface ISharingLinkKind {
 
 /**
  * Sharing link data received from the /snapshot api response.
- * @internal
+ * @alpha
  */
 export interface ISharingLink extends ISharingLinkKind {
 	webUrl: string;
@@ -69,7 +69,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
- * @internal
+ * @alpha
  */
 export interface ShareLinkInfoType {
 	/**
@@ -108,7 +108,7 @@ export interface ShareLinkInfoType {
 	sharingLinkToRedeem?: string;
 }
 /**
- * @internal
+ * @alpha
  */
 export interface IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts {
 	type: "fluid";

package/src/sessionProvider.ts

@@ -7,7 +7,7 @@ import { IResolvedUrl } from "@fluidframework/driver-definitions";
 
 /**
  * Socket storage discovery api response
- * @internal
+ * @alpha
  */
 export interface ISocketStorageDiscovery {
 	// The id of the web socket
@@ -43,7 +43,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.
- * @internal
+ * @alpha
  */
 export interface IProvideSessionAwareDriverFactory {
 	readonly IRelaySessionAwareDriverFactory: IRelaySessionAwareDriverFactory;
@@ -52,7 +52,7 @@ export interface IProvideSessionAwareDriverFactory {
 /**
  * An interface that allows a concrete instance of a driver factory to call the `getRelayServiceSessionInfo`
  * function if it session aware.
- * @internal
+ * @alpha
  */
 export interface IRelaySessionAwareDriverFactory extends IProvideSessionAwareDriverFactory {
 	getRelayServiceSessionInfo(

package/src/tokenFetch.ts

@@ -5,7 +5,7 @@
 
 /**
  * Represents token response
- * @internal
+ * @alpha
  */
 export interface TokenResponse {
 	/** Token value */
@@ -17,7 +17,7 @@ export interface TokenResponse {
 
 /**
  * Represents access token fetch options
- * @internal
+ * @alpha
  */
 export interface TokenFetchOptions {
 	/**
@@ -42,7 +42,7 @@ export interface TokenFetchOptions {
 
 /**
  * Represents access token fetch options for ODSP resource
- * @internal
+ * @alpha
  */
 export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
 	/** Site url representing ODSP resource location */
@@ -61,7 +61,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.
- * @internal
+ * @alpha
  */
 export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;