@fluidframework/odsp-driver-definitions 2.32.0 → 2.33.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 (4) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-report/odsp-driver-definitions.legacy.alpha.api.md +29 -29
  3. package/lib/tsdoc-metadata.json +1 -1
  4. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluidframework/odsp-driver-definitions
2
2
 
3
+ ## 2.33.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.32.0
4
8
 
5
9
  Dependency updates only.
package/api-report/odsp-driver-definitions.legacy.alpha.api.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  ```ts
6
6
 
7
- // @alpha (undocumented)
7
+ // @alpha @legacy (undocumented)
8
8
  export type CacheContentType = "snapshot" | "ops" | "snapshotWithLoadingGroupId";
9
9
 
10
- // @alpha (undocumented)
10
+ // @alpha @legacy (undocumented)
11
11
  export interface HostStoragePolicy {
12
12
  avoidPrefetchSnapshotCache?: boolean;
13
13
  cacheCreateNewSummary?: boolean;
@@ -30,12 +30,12 @@ export interface HostStoragePolicy {
30
30
  snapshotOptions?: ISnapshotOptions;
31
31
  }
32
32
 
33
- // @alpha
33
+ // @alpha @legacy
34
34
  export interface ICacheEntry extends IEntry {
35
35
  file: IFileEntry;
36
36
  }
37
37
 
38
- // @alpha (undocumented)
38
+ // @alpha @legacy (undocumented)
39
39
  export interface ICollabSessionOptions {
40
40
  displayName?: string;
41
41
  // @deprecated
@@ -44,35 +44,35 @@ export interface ICollabSessionOptions {
44
44
  unauthenticatedUserDisplayName?: string;
45
45
  }
46
46
 
47
- // @alpha
47
+ // @alpha @legacy
48
48
  export type IdentityType = "Consumer" | "Enterprise";
49
49
 
50
- // @alpha
50
+ // @alpha @legacy
51
51
  export interface IEntry {
52
52
  key: string;
53
53
  type: CacheContentType;
54
54
  }
55
55
 
56
- // @alpha (undocumented)
56
+ // @alpha @legacy (undocumented)
57
57
  export interface IFileEntry {
58
58
  docId: string;
59
59
  resolvedUrl: IResolvedUrl;
60
60
  }
61
61
 
62
- // @alpha
62
+ // @alpha @legacy
63
63
  export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
64
64
  // (undocumented)
65
65
  readonly errorType: OdspErrorTypes;
66
66
  }
67
67
 
68
- // @alpha (undocumented)
68
+ // @alpha @legacy (undocumented)
69
69
  export interface IOdspErrorAugmentations {
70
70
  facetCodes?: string[];
71
71
  redirectLocation?: string;
72
72
  serverEpoch?: string;
73
73
  }
74
74
 
75
- // @alpha (undocumented)
75
+ // @alpha @legacy (undocumented)
76
76
  export interface IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts {
77
77
  appName?: string;
78
78
  // (undocumented)
@@ -111,7 +111,7 @@ export interface IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts {
111
111
  url: string;
112
112
  }
113
113
 
114
- // @alpha (undocumented)
114
+ // @alpha @legacy (undocumented)
115
115
  export interface IOdspUrlParts {
116
116
  // (undocumented)
117
117
  driveId: string;
@@ -121,39 +121,39 @@ export interface IOdspUrlParts {
121
121
  siteUrl: string;
122
122
  }
123
123
 
124
- // @alpha (undocumented)
124
+ // @alpha @legacy (undocumented)
125
125
  export interface IOpsCachingPolicy {
126
126
  batchSize?: number;
127
127
  timerGranularity?: number;
128
128
  totalOpsToCache?: number;
129
129
  }
130
130
 
131
- // @alpha
131
+ // @alpha @legacy
132
132
  export interface IPersistedCache {
133
133
  get(entry: ICacheEntry): Promise<any>;
134
134
  put(entry: ICacheEntry, value: any): Promise<void>;
135
135
  removeEntries(file: IFileEntry): Promise<void>;
136
136
  }
137
137
 
138
- // @alpha
138
+ // @alpha @legacy
139
139
  export interface IProvideSessionAwareDriverFactory {
140
140
  // (undocumented)
141
141
  readonly IRelaySessionAwareDriverFactory: IRelaySessionAwareDriverFactory;
142
142
  }
143
143
 
144
- // @alpha
144
+ // @alpha @legacy
145
145
  export interface IRelaySessionAwareDriverFactory extends IProvideSessionAwareDriverFactory {
146
146
  // (undocumented)
147
147
  getRelayServiceSessionInfo(resolvedUrl: IResolvedUrl): Promise<ISocketStorageDiscovery | undefined>;
148
148
  }
149
149
 
150
- // @alpha
150
+ // @alpha @legacy
151
151
  export interface ISharingLink extends ISharingLinkKind {
152
152
  // (undocumented)
153
153
  webUrl: string;
154
154
  }
155
155
 
156
- // @alpha
156
+ // @alpha @legacy
157
157
  export interface ISharingLinkKind {
158
158
  // (undocumented)
159
159
  role?: SharingLinkRole;
@@ -161,7 +161,7 @@ export interface ISharingLinkKind {
161
161
  scope: SharingLinkScope;
162
162
  }
163
163
 
164
- // @alpha (undocumented)
164
+ // @alpha @legacy (undocumented)
165
165
  export interface ISnapshotOptions {
166
166
  // (undocumented)
167
167
  blobs?: number;
@@ -174,7 +174,7 @@ export interface ISnapshotOptions {
174
174
  timeout?: number;
175
175
  }
176
176
 
177
- // @alpha
177
+ // @alpha @legacy
178
178
  export interface ISocketStorageDiscovery {
179
179
  // (undocumented)
180
180
  deltaStorageUrl: string;
@@ -192,10 +192,10 @@ export interface ISocketStorageDiscovery {
192
192
  tenantId: string;
193
193
  }
194
194
 
195
- // @alpha (undocumented)
195
+ // @alpha @legacy (undocumented)
196
196
  export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);
197
197
 
198
- // @alpha
198
+ // @alpha @legacy
199
199
  export const OdspErrorTypes: {
200
200
  readonly invalidFileNameError: "invalidFileNameError";
201
201
  readonly snapshotTooBig: "snapshotTooBig";
@@ -224,17 +224,17 @@ export const OdspErrorTypes: {
224
224
  readonly usageError: "usageError";
225
225
  };
226
226
 
227
- // @alpha (undocumented)
227
+ // @alpha @legacy (undocumented)
228
228
  export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes];
229
229
 
230
- // @alpha
230
+ // @alpha @legacy
231
231
  export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
232
232
  driveId?: string;
233
233
  itemId?: string;
234
234
  siteUrl: string;
235
235
  }
236
236
 
237
- // @alpha
237
+ // @alpha @legacy
238
238
  export interface ShareLinkInfoType {
239
239
  createLink?: {
240
240
  link?: ISharingLink;
@@ -244,7 +244,7 @@ export interface ShareLinkInfoType {
244
244
  sharingLinkToRedeem?: string;
245
245
  }
246
246
 
247
- // @alpha
247
+ // @alpha @legacy
248
248
  export enum SharingLinkRole {
249
249
  // (undocumented)
250
250
  edit = "edit",
@@ -252,7 +252,7 @@ export enum SharingLinkRole {
252
252
  view = "view"
253
253
  }
254
254
 
255
- // @alpha
255
+ // @alpha @legacy
256
256
  export enum SharingLinkScope {
257
257
  // (undocumented)
258
258
  anonymous = "anonymous",
@@ -264,10 +264,10 @@ export enum SharingLinkScope {
264
264
  users = "users"
265
265
  }
266
266
 
267
- // @alpha
267
+ // @alpha @legacy
268
268
  export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;
269
269
 
270
- // @alpha
270
+ // @alpha @legacy
271
271
  export interface TokenFetchOptions {
272
272
  claims?: string;
273
273
  refresh: boolean;
@@ -278,7 +278,7 @@ export interface TokenFetchOptions {
278
278
  tenantId?: string;
279
279
  }
280
280
 
281
- // @alpha
281
+ // @alpha @legacy
282
282
  export interface TokenResponse {
283
283
  readonly authorizationHeader?: string;
284
284
  fromCache?: boolean;
package/lib/tsdoc-metadata.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.50.1"
8
+ "packageVersion": "7.52.5"
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.32.0",
3
+ "version": "2.33.0",
4
4
  "description": "Socket storage implementation for SPO and ODC",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -47,7 +47,7 @@
47
47
  "main": "lib/index.js",
48
48
  "types": "lib/public.d.ts",
49
49
  "dependencies": {
50
- "@fluidframework/driver-definitions": "~2.32.0"
50
+ "@fluidframework/driver-definitions": "~2.33.0"
51
51
  },
52
52
  "devDependencies": {
53
53
  "@arethetypeswrong/cli": "^0.17.1",
@@ -56,8 +56,8 @@
56
56
  "@fluidframework/build-common": "^2.0.3",
57
57
  "@fluidframework/build-tools": "^0.55.0",
58
58
  "@fluidframework/eslint-config-fluid": "^5.7.3",
59
- "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.31.0",
60
- "@microsoft/api-extractor": "7.50.1",
59
+ "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.32.0",
60
+ "@microsoft/api-extractor": "7.52.5",
61
61
  "concurrently": "^8.2.1",
62
62
  "copyfiles": "^2.4.1",
63
63
  "cross-env": "^7.0.3",