@fluidframework/odsp-driver-definitions 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

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 (65) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/api-extractor-lint.json +13 -0
  3. package/api-extractor.json +3 -3
  4. package/api-report/odsp-driver-definitions.api.md +36 -36
  5. package/dist/errors.cjs +2 -0
  6. package/dist/errors.cjs.map +1 -1
  7. package/dist/errors.d.ts +12 -0
  8. package/dist/errors.d.ts.map +1 -1
  9. package/dist/factory.cjs.map +1 -1
  10. package/dist/factory.d.ts +12 -0
  11. package/dist/factory.d.ts.map +1 -1
  12. package/dist/odsp-driver-definitions-alpha.d.ts +475 -0
  13. package/dist/odsp-driver-definitions-beta.d.ts +81 -0
  14. package/dist/odsp-driver-definitions-public.d.ts +81 -0
  15. package/dist/odsp-driver-definitions-untrimmed.d.ts +652 -0
  16. package/dist/odspCache.cjs +2 -0
  17. package/dist/odspCache.cjs.map +1 -1
  18. package/dist/odspCache.d.ts +11 -0
  19. package/dist/odspCache.d.ts.map +1 -1
  20. package/dist/resolvedUrl.cjs +3 -0
  21. package/dist/resolvedUrl.cjs.map +1 -1
  22. package/dist/resolvedUrl.d.ts +12 -0
  23. package/dist/resolvedUrl.d.ts.map +1 -1
  24. package/dist/sessionProvider.cjs.map +1 -1
  25. package/dist/sessionProvider.d.ts +3 -0
  26. package/dist/sessionProvider.d.ts.map +1 -1
  27. package/dist/tokenFetch.cjs +2 -0
  28. package/dist/tokenFetch.cjs.map +1 -1
  29. package/dist/tokenFetch.d.ts +10 -0
  30. package/dist/tokenFetch.d.ts.map +1 -1
  31. package/lib/errors.d.ts +12 -4
  32. package/lib/errors.d.ts.map +1 -1
  33. package/lib/errors.mjs +2 -0
  34. package/lib/errors.mjs.map +1 -1
  35. package/lib/factory.d.ts +12 -0
  36. package/lib/factory.d.ts.map +1 -1
  37. package/lib/factory.mjs.map +1 -1
  38. package/lib/index.d.ts +6 -6
  39. package/lib/index.d.ts.map +1 -1
  40. package/lib/odsp-driver-definitions-alpha.d.ts +475 -0
  41. package/lib/odsp-driver-definitions-beta.d.ts +81 -0
  42. package/lib/odsp-driver-definitions-public.d.ts +81 -0
  43. package/lib/odsp-driver-definitions-untrimmed.d.ts +652 -0
  44. package/lib/odspCache.d.ts +11 -0
  45. package/lib/odspCache.d.ts.map +1 -1
  46. package/lib/odspCache.mjs +2 -0
  47. package/lib/odspCache.mjs.map +1 -1
  48. package/lib/resolvedUrl.d.ts +12 -0
  49. package/lib/resolvedUrl.d.ts.map +1 -1
  50. package/lib/resolvedUrl.mjs +3 -0
  51. package/lib/resolvedUrl.mjs.map +1 -1
  52. package/lib/sessionProvider.d.ts +3 -0
  53. package/lib/sessionProvider.d.ts.map +1 -1
  54. package/lib/sessionProvider.mjs.map +1 -1
  55. package/lib/tokenFetch.d.ts +10 -0
  56. package/lib/tokenFetch.d.ts.map +1 -1
  57. package/lib/tokenFetch.mjs +2 -0
  58. package/lib/tokenFetch.mjs.map +1 -1
  59. package/package.json +25 -6
  60. package/src/errors.ts +12 -0
  61. package/src/factory.ts +12 -0
  62. package/src/odspCache.ts +11 -0
  63. package/src/resolvedUrl.ts +12 -0
  64. package/src/sessionProvider.ts +3 -0
  65. package/src/tokenFetch.ts +10 -0
package/src/tokenFetch.ts CHANGED
@@ -5,6 +5,7 @@
5
5
 
6
6
  /**
7
7
  * Represents token response
8
+ * @alpha
8
9
  */
9
10
  export interface TokenResponse {
10
11
  /** Token value */
@@ -16,6 +17,7 @@ export interface TokenResponse {
16
17
 
17
18
  /**
18
19
  * Represents access token fetch options
20
+ * @alpha
19
21
  */
20
22
  export interface TokenFetchOptions {
21
23
  /**
@@ -40,6 +42,7 @@ export interface TokenFetchOptions {
40
42
 
41
43
  /**
42
44
  * Represents access token fetch options for ODSP resource
45
+ * @alpha
43
46
  */
44
47
  export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
45
48
  /** Site url representing ODSP resource location */
@@ -58,6 +61,7 @@ export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
58
61
  * @returns If successful, TokenResponse object representing token value along with flag indicating
59
62
  * whether token came from cache. Legacy implementation may return a string for token value;
60
63
  * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.
64
+ * @alpha
61
65
  */
62
66
  export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;
63
67
 
@@ -65,6 +69,7 @@ export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | n
65
69
  * Helper method which transforms return value for TokenFetcher method to token string
66
70
  * @param tokenResponse - return value for TokenFetcher method
67
71
  * @returns Token value
72
+ * @internal
68
73
  */
69
74
  export const tokenFromResponse = (
70
75
  tokenResponse: string | TokenResponse | null | undefined,
@@ -80,6 +85,7 @@ export const tokenFromResponse = (
80
85
  * @param tokenResponse - return value for TokenFetcher method
81
86
  * @returns Value indicating whether response came from cache.
82
87
  * Undefined is returned when we could not determine the source of token.
88
+ * @internal
83
89
  */
84
90
  export const isTokenFromCache = (
85
91
  tokenResponse: string | TokenResponse | null,
@@ -92,9 +98,13 @@ export const isTokenFromCache = (
92
98
  * Identity types supported by ODSP driver.
93
99
  * `Consumer` represents user authenticated with Microsoft Account (MSA).
94
100
  * `Enterprise` represents user authenticated with M365 tenant account.
101
+ * @internal
95
102
  */
96
103
  export type IdentityType = "Consumer" | "Enterprise";
97
104
 
105
+ /**
106
+ * @internal
107
+ */
98
108
  export type InstrumentedStorageTokenFetcher = (
99
109
  options: TokenFetchOptions,
100
110
  name: string,