@fluidframework/odsp-driver-definitions 2.53.1 → 2.61.0-355054

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-report/{odsp-driver-definitions.legacy.alpha.api.md → odsp-driver-definitions.legacy.beta.api.md} +32 -32
  3. package/dist/errors.d.ts +5 -9
  4. package/dist/errors.d.ts.map +1 -1
  5. package/dist/errors.js +1 -1
  6. package/dist/errors.js.map +1 -1
  7. package/dist/factory.d.ts +4 -4
  8. package/dist/factory.js.map +1 -1
  9. package/dist/legacy.d.ts +2 -1
  10. package/dist/odspCache.d.ts +5 -10
  11. package/dist/odspCache.d.ts.map +1 -1
  12. package/dist/odspCache.js.map +1 -1
  13. package/dist/resolvedUrl.d.ts +7 -7
  14. package/dist/resolvedUrl.js +2 -2
  15. package/dist/resolvedUrl.js.map +1 -1
  16. package/dist/sessionProvider.d.ts +5 -10
  17. package/dist/sessionProvider.d.ts.map +1 -1
  18. package/dist/sessionProvider.js.map +1 -1
  19. package/dist/tokenFetch.d.ts +5 -5
  20. package/dist/tokenFetch.js.map +1 -1
  21. package/internal.d.ts +1 -1
  22. package/legacy.d.ts +1 -1
  23. package/lib/errors.d.ts +5 -9
  24. package/lib/errors.d.ts.map +1 -1
  25. package/lib/errors.js +1 -1
  26. package/lib/errors.js.map +1 -1
  27. package/lib/factory.d.ts +4 -4
  28. package/lib/factory.js.map +1 -1
  29. package/lib/legacy.d.ts +2 -1
  30. package/lib/odspCache.d.ts +5 -10
  31. package/lib/odspCache.d.ts.map +1 -1
  32. package/lib/odspCache.js.map +1 -1
  33. package/lib/resolvedUrl.d.ts +7 -7
  34. package/lib/resolvedUrl.js +2 -2
  35. package/lib/resolvedUrl.js.map +1 -1
  36. package/lib/sessionProvider.d.ts +5 -10
  37. package/lib/sessionProvider.d.ts.map +1 -1
  38. package/lib/sessionProvider.js.map +1 -1
  39. package/lib/tokenFetch.d.ts +5 -5
  40. package/lib/tokenFetch.js.map +1 -1
  41. package/lib/tsdoc-metadata.json +1 -1
  42. package/package.json +9 -9
  43. package/src/errors.ts +5 -5
  44. package/src/factory.ts +4 -4
  45. package/src/odspCache.ts +5 -10
  46. package/src/resolvedUrl.ts +7 -7
  47. package/src/sessionProvider.ts +5 -10
  48. package/src/tokenFetch.ts +5 -5
@@ -1 +1 @@
1
- {"version":3,"file":"tokenFetch.js","sourceRoot":"","sources":["../src/tokenFetch.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsFH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAChC,aAAwD,EACxC,EAAE,CAClB,aAAa,KAAK,IAAI,IAAI,OAAO,aAAa,KAAK,QAAQ;IAC1D,CAAC,CAAC,aAAa;IACf,CAAC,CAAC,aAAa,KAAK,SAAS;QAC5B,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC;AAEzB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAC1C,aAAwD,EACxC,EAAE;IAClB,IAAI,OAAO,aAAa,KAAK,QAAQ,IAAI,aAAa,EAAE,mBAAmB,KAAK,SAAS,EAAE,CAAC;QAC3F,OAAO,aAAa,CAAC,mBAAmB,CAAC;IAC1C,CAAC;IACD,MAAM,KAAK,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC/C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,UAAU,KAAK,EAAE,CAAC;IAC1B,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC/B,aAA4C,EACtB,EAAE,CACxB,aAAa,KAAK,IAAI,IAAI,OAAO,aAAa,KAAK,QAAQ;IAC1D,CAAC,CAAC,SAAS;IACX,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Represents token response\n * @legacy\n * @alpha\n */\nexport interface TokenResponse {\n\t/** Token value */\n\ttoken: string;\n\n\t/**\n\t * Authorization header value will be used verbatim when making network call that requires the token.\n\t * If not provided, the token value will be assumed to be a Bearer token and will be used to generate the\n\t * Authorization header value in the following format: `Bearer ${token}`.\n\t */\n\treadonly authorizationHeader?: string;\n\n\t/**\n\t * Whether or not the token was obtained from local cache.\n\t * @remarks `undefined` indicates that it could not be determined whether or not the token was obtained this way.\n\t */\n\tfromCache?: boolean;\n}\n\n/**\n * Represents access token fetch options\n * @legacy\n * @alpha\n */\nexport interface TokenFetchOptions {\n\t/**\n\t * Value indicating whether fresh token has to be returned.\n\t * If false then it is okay to return cached unexpired token if available.\n\t */\n\trefresh: boolean;\n\n\t/**\n\t * Claims that have to be passed with token fetch request.\n\t * These can be used to specify additional information that must be passed to token authority.\n\t */\n\tclaims?: string;\n\n\t/**\n\t * Tenant id of authority that must be handling token fetch.\n\t * If it is not specified then it is up to token fetching logic to determine which tenant authority\n\t * to use to issue access token.\n\t */\n\ttenantId?: string;\n\n\t/**\n\t * Request that will be made using the fetched token.\n\t * - url: full request url, including query params\n\t * - method: method type\n\t * Request info may be encoded into the returned token that the receiver can use to validate that caller is allowed to make specific call.\n\t */\n\treadonly request?: { url: string; method: \"GET\" | \"POST\" | \"PATCH\" | \"DELETE\" | \"PUT\" };\n}\n\n/**\n * Represents access token fetch options for ODSP resource\n * @legacy\n * @alpha\n */\nexport interface OdspResourceTokenFetchOptions extends TokenFetchOptions {\n\t/** Site url representing ODSP resource location */\n\tsiteUrl: string;\n\n\t/** ODSP drive id where resource resides. Optional, used only when fetching token to access ODSP file */\n\tdriveId?: string;\n\n\t/** ODSP item id representing resource. Optional, used only when fetching token to access ODSP file */\n\titemId?: string;\n}\n\n/**\n * Method signature for callback method used to fetch access token\n * @param options - token fetch options\n * @returns If successful, TokenResponse object representing token value along with flag indicating\n * whether token came from cache. Legacy implementation may return a string for token value;\n * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.\n * @legacy\n * @alpha\n */\nexport type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;\n\n/**\n * Helper method which transforms return value for TokenFetcher method to token string\n * @param tokenResponse - return value for TokenFetcher method\n * @returns Token value\n * @internal\n */\nexport const tokenFromResponse = (\n\ttokenResponse: string | TokenResponse | null | undefined,\n): string | null =>\n\ttokenResponse === null || typeof tokenResponse === \"string\"\n\t\t? tokenResponse\n\t\t: tokenResponse === undefined\n\t\t\t? null\n\t\t\t: tokenResponse.token;\n\n/**\n * Helper method which transforms return value for TokenFetcher method to Authorization header value\n * @param tokenResponse - return value for TokenFetcher method\n * @returns Authorization header value\n * @internal\n */\nexport const authHeaderFromTokenResponse = (\n\ttokenResponse: string | TokenResponse | null | undefined,\n): string | null => {\n\tif (typeof tokenResponse === \"object\" && tokenResponse?.authorizationHeader !== undefined) {\n\t\treturn tokenResponse.authorizationHeader;\n\t}\n\tconst token = tokenFromResponse(tokenResponse);\n\tif (token !== null) {\n\t\treturn `Bearer ${token}`;\n\t}\n\treturn null;\n};\n\n/**\n * Helper method which returns flag indicating whether token response comes from local cache\n * @param tokenResponse - return value for TokenFetcher method\n * @returns Value indicating whether response came from cache.\n * Undefined is returned when we could not determine the source of token.\n * @internal\n */\nexport const isTokenFromCache = (\n\ttokenResponse: string | TokenResponse | null,\n): boolean | undefined =>\n\ttokenResponse === null || typeof tokenResponse === \"string\"\n\t\t? undefined\n\t\t: tokenResponse.fromCache;\n\n/**\n * Identity types supported by ODSP driver.\n * `Consumer` represents user authenticated with Microsoft Account (MSA).\n * `Enterprise` represents user authenticated with M365 tenant account.\n * @legacy\n * @alpha\n */\nexport type IdentityType = \"Consumer\" | \"Enterprise\";\n\n/**\n * @returns Authorization header value\n * @internal\n */\nexport type InstrumentedStorageTokenFetcher = (\n\toptions: TokenFetchOptions,\n\tname: string,\n\talwaysRecordTokenFetchTelemetry?: boolean,\n) => Promise<string>;\n\n/**\n * @internal\n */\nexport type InstrumentedTokenFetcher = (\n\toptions: TokenFetchOptions,\n\tname: string,\n\talwaysRecordTokenFetchTelemetry?: boolean,\n) => Promise<string | null>;\n"]}
1
+ {"version":3,"file":"tokenFetch.js","sourceRoot":"","sources":["../src/tokenFetch.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsFH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAChC,aAAwD,EACxC,EAAE,CAClB,aAAa,KAAK,IAAI,IAAI,OAAO,aAAa,KAAK,QAAQ;IAC1D,CAAC,CAAC,aAAa;IACf,CAAC,CAAC,aAAa,KAAK,SAAS;QAC5B,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC;AAEzB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAC1C,aAAwD,EACxC,EAAE;IAClB,IAAI,OAAO,aAAa,KAAK,QAAQ,IAAI,aAAa,EAAE,mBAAmB,KAAK,SAAS,EAAE,CAAC;QAC3F,OAAO,aAAa,CAAC,mBAAmB,CAAC;IAC1C,CAAC;IACD,MAAM,KAAK,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC/C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,UAAU,KAAK,EAAE,CAAC;IAC1B,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC/B,aAA4C,EACtB,EAAE,CACxB,aAAa,KAAK,IAAI,IAAI,OAAO,aAAa,KAAK,QAAQ;IAC1D,CAAC,CAAC,SAAS;IACX,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Represents token response\n * @legacy\n * @beta\n */\nexport interface TokenResponse {\n\t/** Token value */\n\ttoken: string;\n\n\t/**\n\t * Authorization header value will be used verbatim when making network call that requires the token.\n\t * If not provided, the token value will be assumed to be a Bearer token and will be used to generate the\n\t * Authorization header value in the following format: `Bearer ${token}`.\n\t */\n\treadonly authorizationHeader?: string;\n\n\t/**\n\t * Whether or not the token was obtained from local cache.\n\t * @remarks `undefined` indicates that it could not be determined whether or not the token was obtained this way.\n\t */\n\tfromCache?: boolean;\n}\n\n/**\n * Represents access token fetch options\n * @legacy\n * @beta\n */\nexport interface TokenFetchOptions {\n\t/**\n\t * Value indicating whether fresh token has to be returned.\n\t * If false then it is okay to return cached unexpired token if available.\n\t */\n\trefresh: boolean;\n\n\t/**\n\t * Claims that have to be passed with token fetch request.\n\t * These can be used to specify additional information that must be passed to token authority.\n\t */\n\tclaims?: string;\n\n\t/**\n\t * Tenant id of authority that must be handling token fetch.\n\t * If it is not specified then it is up to token fetching logic to determine which tenant authority\n\t * to use to issue access token.\n\t */\n\ttenantId?: string;\n\n\t/**\n\t * Request that will be made using the fetched token.\n\t * - url: full request url, including query params\n\t * - method: method type\n\t * Request info may be encoded into the returned token that the receiver can use to validate that caller is allowed to make specific call.\n\t */\n\treadonly request?: { url: string; method: \"GET\" | \"POST\" | \"PATCH\" | \"DELETE\" | \"PUT\" };\n}\n\n/**\n * Represents access token fetch options for ODSP resource\n * @legacy\n * @beta\n */\nexport interface OdspResourceTokenFetchOptions extends TokenFetchOptions {\n\t/** Site url representing ODSP resource location */\n\tsiteUrl: string;\n\n\t/** ODSP drive id where resource resides. Optional, used only when fetching token to access ODSP file */\n\tdriveId?: string;\n\n\t/** ODSP item id representing resource. Optional, used only when fetching token to access ODSP file */\n\titemId?: string;\n}\n\n/**\n * Method signature for callback method used to fetch access token\n * @param options - token fetch options\n * @returns If successful, TokenResponse object representing token value along with flag indicating\n * whether token came from cache. Legacy implementation may return a string for token value;\n * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.\n * @legacy\n * @beta\n */\nexport type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;\n\n/**\n * Helper method which transforms return value for TokenFetcher method to token string\n * @param tokenResponse - return value for TokenFetcher method\n * @returns Token value\n * @internal\n */\nexport const tokenFromResponse = (\n\ttokenResponse: string | TokenResponse | null | undefined,\n): string | null =>\n\ttokenResponse === null || typeof tokenResponse === \"string\"\n\t\t? tokenResponse\n\t\t: tokenResponse === undefined\n\t\t\t? null\n\t\t\t: tokenResponse.token;\n\n/**\n * Helper method which transforms return value for TokenFetcher method to Authorization header value\n * @param tokenResponse - return value for TokenFetcher method\n * @returns Authorization header value\n * @internal\n */\nexport const authHeaderFromTokenResponse = (\n\ttokenResponse: string | TokenResponse | null | undefined,\n): string | null => {\n\tif (typeof tokenResponse === \"object\" && tokenResponse?.authorizationHeader !== undefined) {\n\t\treturn tokenResponse.authorizationHeader;\n\t}\n\tconst token = tokenFromResponse(tokenResponse);\n\tif (token !== null) {\n\t\treturn `Bearer ${token}`;\n\t}\n\treturn null;\n};\n\n/**\n * Helper method which returns flag indicating whether token response comes from local cache\n * @param tokenResponse - return value for TokenFetcher method\n * @returns Value indicating whether response came from cache.\n * Undefined is returned when we could not determine the source of token.\n * @internal\n */\nexport const isTokenFromCache = (\n\ttokenResponse: string | TokenResponse | null,\n): boolean | undefined =>\n\ttokenResponse === null || typeof tokenResponse === \"string\"\n\t\t? undefined\n\t\t: tokenResponse.fromCache;\n\n/**\n * Identity types supported by ODSP driver.\n * `Consumer` represents user authenticated with Microsoft Account (MSA).\n * `Enterprise` represents user authenticated with M365 tenant account.\n * @legacy\n * @beta\n */\nexport type IdentityType = \"Consumer\" | \"Enterprise\";\n\n/**\n * @returns Authorization header value\n * @internal\n */\nexport type InstrumentedStorageTokenFetcher = (\n\toptions: TokenFetchOptions,\n\tname: string,\n\talwaysRecordTokenFetchTelemetry?: boolean,\n) => Promise<string>;\n\n/**\n * @internal\n */\nexport type InstrumentedTokenFetcher = (\n\toptions: TokenFetchOptions,\n\tname: string,\n\talwaysRecordTokenFetchTelemetry?: boolean,\n) => Promise<string | null>;\n"]}
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.52.8"
8
+ "packageVersion": "7.52.11"
9
9
  }
10
10
  ]
11
11
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/odsp-driver-definitions",
3
- "version": "2.53.1",
3
+ "version": "2.61.0-355054",
4
4
  "description": "Socket storage implementation for SPO and ODC",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -47,17 +47,17 @@
47
47
  "main": "lib/index.js",
48
48
  "types": "lib/public.d.ts",
49
49
  "dependencies": {
50
- "@fluidframework/driver-definitions": "~2.53.1"
50
+ "@fluidframework/driver-definitions": "2.61.0-355054"
51
51
  },
52
52
  "devDependencies": {
53
53
  "@arethetypeswrong/cli": "^0.17.1",
54
54
  "@biomejs/biome": "~1.9.3",
55
- "@fluid-tools/build-cli": "^0.57.0",
55
+ "@fluid-tools/build-cli": "^0.58.2",
56
56
  "@fluidframework/build-common": "^2.0.3",
57
- "@fluidframework/build-tools": "^0.57.0",
58
- "@fluidframework/eslint-config-fluid": "^5.7.4",
59
- "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.53.0",
60
- "@microsoft/api-extractor": "7.52.8",
57
+ "@fluidframework/build-tools": "^0.58.2",
58
+ "@fluidframework/eslint-config-fluid": "^6.0.0",
59
+ "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.60.0",
60
+ "@microsoft/api-extractor": "7.52.11",
61
61
  "concurrently": "^8.2.1",
62
62
  "copyfiles": "^2.4.1",
63
63
  "cross-env": "^7.0.3",
@@ -71,8 +71,8 @@
71
71
  },
72
72
  "scripts": {
73
73
  "api": "fluid-build . --task api",
74
- "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
75
- "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
74
+ "api-extractor:commonjs": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./dist",
75
+ "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
76
76
  "build": "fluid-build . --task build",
77
77
  "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
78
78
  "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
package/src/errors.ts CHANGED
@@ -13,7 +13,7 @@ import {
13
13
  * ODSP Error types.
14
14
  * Different error types that may be thrown by the ODSP driver.
15
15
  * @legacy
16
- * @alpha
16
+ * @beta
17
17
  */
18
18
  export const OdspErrorTypes = {
19
19
  // Inherit base driver error types
@@ -65,13 +65,13 @@ export const OdspErrorTypes = {
65
65
  } as const;
66
66
  /**
67
67
  * @legacy
68
- * @alpha
68
+ * @beta
69
69
  */
70
70
  export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes];
71
71
 
72
72
  /**
73
73
  * @legacy
74
- * @alpha
74
+ * @beta
75
75
  */
76
76
  export interface IOdspErrorAugmentations {
77
77
  /**
@@ -96,7 +96,7 @@ export interface IOdspErrorAugmentations {
96
96
  * Base interface for all errors and warnings
97
97
  * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
98
98
  * @legacy
99
- * @alpha
99
+ * @beta
100
100
  */
101
101
  export interface IOdspError
102
102
  extends Omit<IDriverErrorBase, "errorType">,
@@ -106,6 +106,6 @@ export interface IOdspError
106
106
 
107
107
  /**
108
108
  * @legacy
109
- * @alpha
109
+ * @beta
110
110
  */
111
111
  export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);
package/src/factory.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /**
7
7
  * @legacy
8
- * @alpha
8
+ * @beta
9
9
  */
10
10
  export interface ISnapshotOptions {
11
11
  blobs?: number;
@@ -31,7 +31,7 @@ export interface ISnapshotOptions {
31
31
 
32
32
  /**
33
33
  * @legacy
34
- * @alpha
34
+ * @beta
35
35
  */
36
36
  export interface IOpsCachingPolicy {
37
37
  /**
@@ -63,7 +63,7 @@ export interface IOpsCachingPolicy {
63
63
 
64
64
  /**
65
65
  * @legacy
66
- * @alpha
66
+ * @beta
67
67
  */
68
68
  export interface ICollabSessionOptions {
69
69
  /**
@@ -94,7 +94,7 @@ export interface ICollabSessionOptions {
94
94
 
95
95
  /**
96
96
  * @legacy
97
- * @alpha
97
+ * @beta
98
98
  */
99
99
  export interface HostStoragePolicy {
100
100
  snapshotOptions?: ISnapshotOptions;
package/src/odspCache.ts CHANGED
@@ -28,8 +28,7 @@ export const snapshotKey = "snapshot";
28
28
  export const snapshotWithLoadingGroupIdKey = "snapshotWithLoadingGroupId";
29
29
 
30
30
  /**
31
- * @legacy
32
- * @alpha
31
+ * @legacy @beta
33
32
  */
34
33
  export type CacheContentType = "snapshot" | "ops" | "snapshotWithLoadingGroupId";
35
34
 
@@ -39,8 +38,7 @@ export type CacheContentType = "snapshot" | "ops" | "snapshotWithLoadingGroupId"
39
38
  * to implement storage / identify files.
40
39
  */
41
40
  /**
42
- * @legacy
43
- * @alpha
41
+ * @legacy @beta
44
42
  */
45
43
  export interface IFileEntry {
46
44
  /**
@@ -59,8 +57,7 @@ export interface IFileEntry {
59
57
 
60
58
  /**
61
59
  * Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
62
- * @legacy
63
- * @alpha
60
+ * @legacy @beta
64
61
  */
65
62
  export interface IEntry {
66
63
  /**
@@ -83,8 +80,7 @@ export interface IEntry {
83
80
 
84
81
  /**
85
82
  * Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
86
- * @legacy
87
- * @alpha
83
+ * @legacy @beta
88
84
  */
89
85
  export interface ICacheEntry extends IEntry {
90
86
  /**
@@ -99,8 +95,7 @@ export interface ICacheEntry extends IEntry {
99
95
  * cache implementation that does not survive across sessions. Snapshot entires stored in the
100
96
  * IPersistedCache will be considered stale and removed after 2 days. Read the README for more
101
97
  * information.
102
- * @legacy
103
- * @alpha
98
+ * @legacy @beta
104
99
  */
105
100
  export interface IPersistedCache {
106
101
  /**
@@ -7,7 +7,7 @@ import { IResolvedUrl } from "@fluidframework/driver-definitions/internal";
7
7
 
8
8
  /**
9
9
  * @legacy
10
- * @alpha
10
+ * @beta
11
11
  */
12
12
  export interface IOdspUrlParts {
13
13
  siteUrl: string;
@@ -18,7 +18,7 @@ export interface IOdspUrlParts {
18
18
  /**
19
19
  * Sharing scope of the share links created for a file.
20
20
  * @legacy
21
- * @alpha
21
+ * @beta
22
22
  */
23
23
  export enum SharingLinkScope {
24
24
  organization = "organization",
@@ -30,7 +30,7 @@ export enum SharingLinkScope {
30
30
  /**
31
31
  * View/edit permission role for a sharing link.
32
32
  * @legacy
33
- * @alpha
33
+ * @beta
34
34
  */
35
35
  export enum SharingLinkRole {
36
36
  view = "view",
@@ -41,7 +41,7 @@ export enum SharingLinkRole {
41
41
  * Defines the permissions scope for a share link requested to be created during the creation the file in ODSP.
42
42
  * Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.
43
43
  * @legacy
44
- * @alpha
44
+ * @beta
45
45
  */
46
46
  export interface ISharingLinkKind {
47
47
  scope: SharingLinkScope;
@@ -55,7 +55,7 @@ export interface ISharingLinkKind {
55
55
  /**
56
56
  * Sharing link data received from the /snapshot api response.
57
57
  * @legacy
58
- * @alpha
58
+ * @beta
59
59
  */
60
60
  export interface ISharingLink extends ISharingLinkKind {
61
61
  webUrl: string;
@@ -66,7 +66,7 @@ export interface ISharingLink extends ISharingLinkKind {
66
66
  * Contains information about either sharing link created while creating a new file or
67
67
  * a redeemable share link created when loading an existing file
68
68
  * @legacy
69
- * @alpha
69
+ * @beta
70
70
  */
71
71
  export interface ShareLinkInfoType {
72
72
  /**
@@ -106,7 +106,7 @@ export interface ShareLinkInfoType {
106
106
  }
107
107
  /**
108
108
  * @legacy
109
- * @alpha
109
+ * @beta
110
110
  */
111
111
  export interface IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts {
112
112
  type: "fluid";
@@ -7,8 +7,7 @@ import { IResolvedUrl } from "@fluidframework/driver-definitions/internal";
7
7
 
8
8
  /**
9
9
  * Socket storage discovery api response
10
- * @legacy
11
- * @alpha
10
+ * @legacy @beta
12
11
  */
13
12
  export interface ISocketStorageDiscovery {
14
13
  // The id of the web socket
@@ -50,8 +49,7 @@ export interface ISocketStorageDiscovery {
50
49
 
51
50
  /**
52
51
  * Sensitivity labels information for a file, part of the socket storage discovery response.
53
- * @legacy
54
- * @alpha
52
+ * @legacy @beta
55
53
  */
56
54
  export interface ISensitivityLabelsInfo {
57
55
  /** ISO format timestamp when the label info snapshot was generated. */
@@ -62,8 +60,7 @@ export interface ISensitivityLabelsInfo {
62
60
 
63
61
  /**
64
62
  * A single sensitivity label applied to a document, part of the socket storage discovery response.
65
- * @legacy
66
- * @alpha
63
+ * @legacy @beta
67
64
  */
68
65
  export interface ISensitivityLabel {
69
66
  /** Unique identifier of the sensitivity label. */
@@ -79,8 +76,7 @@ export interface ISensitivityLabel {
79
76
  /**
80
77
  * An interface that allows a concrete instance of a driver factory to interrogate itself
81
78
  * to find out if it is session aware.
82
- * @legacy
83
- * @alpha
79
+ * @legacy @beta
84
80
  */
85
81
  export interface IProvideSessionAwareDriverFactory {
86
82
  readonly IRelaySessionAwareDriverFactory: IRelaySessionAwareDriverFactory;
@@ -89,8 +85,7 @@ export interface IProvideSessionAwareDriverFactory {
89
85
  /**
90
86
  * An interface that allows a concrete instance of a driver factory to call the `getRelayServiceSessionInfo`
91
87
  * function if it session aware.
92
- * @legacy
93
- * @alpha
88
+ * @legacy @beta
94
89
  */
95
90
  export interface IRelaySessionAwareDriverFactory extends IProvideSessionAwareDriverFactory {
96
91
  getRelayServiceSessionInfo(
package/src/tokenFetch.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  /**
7
7
  * Represents token response
8
8
  * @legacy
9
- * @alpha
9
+ * @beta
10
10
  */
11
11
  export interface TokenResponse {
12
12
  /** Token value */
@@ -29,7 +29,7 @@ export interface TokenResponse {
29
29
  /**
30
30
  * Represents access token fetch options
31
31
  * @legacy
32
- * @alpha
32
+ * @beta
33
33
  */
34
34
  export interface TokenFetchOptions {
35
35
  /**
@@ -63,7 +63,7 @@ export interface TokenFetchOptions {
63
63
  /**
64
64
  * Represents access token fetch options for ODSP resource
65
65
  * @legacy
66
- * @alpha
66
+ * @beta
67
67
  */
68
68
  export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
69
69
  /** Site url representing ODSP resource location */
@@ -83,7 +83,7 @@ export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
83
83
  * whether token came from cache. Legacy implementation may return a string for token value;
84
84
  * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.
85
85
  * @legacy
86
- * @alpha
86
+ * @beta
87
87
  */
88
88
  export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;
89
89
 
@@ -140,7 +140,7 @@ export const isTokenFromCache = (
140
140
  * `Consumer` represents user authenticated with Microsoft Account (MSA).
141
141
  * `Enterprise` represents user authenticated with M365 tenant account.
142
142
  * @legacy
143
- * @alpha
143
+ * @beta
144
144
  */
145
145
  export type IdentityType = "Consumer" | "Enterprise";
146
146