@fluidframework/datastore-definitions 2.33.0-333010 → 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 (16) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-report/datastore-definitions.legacy.alpha.api.md +23 -14
  3. package/dist/dataStoreRuntime.d.ts +25 -0
  4. package/dist/dataStoreRuntime.d.ts.map +1 -1
  5. package/dist/index.d.ts +1 -1
  6. package/dist/index.d.ts.map +1 -1
  7. package/dist/legacy.d.ts +1 -0
  8. package/lib/dataStoreRuntime.d.ts +25 -0
  9. package/lib/dataStoreRuntime.d.ts.map +1 -1
  10. package/lib/index.d.ts +1 -1
  11. package/lib/index.d.ts.map +1 -1
  12. package/lib/legacy.d.ts +1 -0
  13. package/lib/tsdoc-metadata.json +1 -1
  14. package/package.json +8 -8
  15. package/src/dataStoreRuntime.ts +32 -0
  16. package/src/index.ts +2 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluidframework/datastore-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/datastore-definitions.legacy.alpha.api.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ```ts
6
6
 
7
- // @alpha (undocumented)
7
+ // @alpha @legacy (undocumented)
8
8
  export interface IChannel extends IFluidLoadable {
9
9
  // (undocumented)
10
10
  readonly attributes: IChannelAttributes;
@@ -16,14 +16,14 @@ export interface IChannel extends IFluidLoadable {
16
16
  summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): Promise<ISummaryTreeWithStats>;
17
17
  }
18
18
 
19
- // @alpha
19
+ // @alpha @legacy
20
20
  export interface IChannelAttributes {
21
21
  readonly packageVersion?: string;
22
22
  readonly snapshotFormatVersion: string;
23
23
  readonly type: string;
24
24
  }
25
25
 
26
- // @alpha
26
+ // @alpha @legacy
27
27
  export interface IChannelFactory<out TChannel = unknown> {
28
28
  readonly attributes: IChannelAttributes;
29
29
  create(runtime: IFluidDataStoreRuntime, id: string): TChannel & IChannel;
@@ -31,7 +31,7 @@ export interface IChannelFactory<out TChannel = unknown> {
31
31
  readonly type: string;
32
32
  }
33
33
 
34
- // @alpha
34
+ // @alpha @legacy
35
35
  export interface IChannelServices {
36
36
  // (undocumented)
37
37
  deltaConnection: IDeltaConnection;
@@ -39,14 +39,14 @@ export interface IChannelServices {
39
39
  objectStorage: IChannelStorageService;
40
40
  }
41
41
 
42
- // @alpha
42
+ // @alpha @legacy
43
43
  export interface IChannelStorageService {
44
44
  contains(path: string): Promise<boolean>;
45
45
  list(path: string): Promise<string[]>;
46
46
  readBlob(path: string): Promise<ArrayBufferLike>;
47
47
  }
48
48
 
49
- // @alpha
49
+ // @alpha @legacy
50
50
  export interface IDeltaConnection {
51
51
  attach(handler: IDeltaHandler): void;
52
52
  // (undocumented)
@@ -55,7 +55,7 @@ export interface IDeltaConnection {
55
55
  submit(messageContent: any, localOpMetadata: unknown): void;
56
56
  }
57
57
 
58
- // @alpha
58
+ // @alpha @legacy
59
59
  export interface IDeltaHandler {
60
60
  applyStashedOp(message: any): void;
61
61
  processMessages: (messageCollection: IRuntimeMessageCollection) => void;
@@ -64,10 +64,10 @@ export interface IDeltaHandler {
64
64
  setConnectionState(connected: boolean): void;
65
65
  }
66
66
 
67
- // @alpha
67
+ // @alpha @legacy
68
68
  export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
69
69
 
70
- // @alpha @sealed
70
+ // @alpha @sealed @legacy
71
71
  export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
72
72
  addChannel(channel: IChannel): void;
73
73
  readonly attachState: AttachState;
@@ -91,6 +91,7 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
91
91
  readonly idCompressor: IIdCompressor | undefined;
92
92
  // (undocumented)
93
93
  readonly IFluidHandleContext: IFluidHandleContext;
94
+ readonly isReadOnly: () => boolean;
94
95
  // (undocumented)
95
96
  readonly logger: ITelemetryBaseLogger;
96
97
  // (undocumented)
@@ -104,7 +105,7 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
104
105
  waitAttached(): Promise<void>;
105
106
  }
106
107
 
107
- // @alpha
108
+ // @alpha @legacy
108
109
  export interface IFluidDataStoreRuntimeEvents extends IEvent {
109
110
  // (undocumented)
110
111
  (event: "disconnected", listener: () => void): any;
@@ -120,23 +121,31 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
120
121
  (event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
121
122
  // (undocumented)
122
123
  (event: "connected", listener: (clientId: string) => void): any;
124
+ // (undocumented)
125
+ (event: "readonly", listener: (isReadOnly: boolean) => void): any;
126
+ }
127
+
128
+ // @alpha @sealed @deprecated @legacy (undocumented)
129
+ export interface IFluidDataStoreRuntimeExperimental extends IFluidDataStoreRuntime {
130
+ // (undocumented)
131
+ readonly inStagingMode?: boolean;
123
132
  }
124
133
 
125
- // @alpha (undocumented)
134
+ // @alpha @legacy (undocumented)
126
135
  export interface Internal_InterfaceOfJsonableTypesWith<T> {
127
136
  // (undocumented)
128
137
  [index: string | number]: JsonableTypeWith<T>;
129
138
  }
130
139
 
131
- // @alpha
140
+ // @alpha @legacy
132
141
  export type Jsonable<T, TReplaced = never> = boolean extends (T extends never ? true : false) ? JsonableTypeWith<TReplaced> : unknown extends T ? JsonableTypeWith<TReplaced> : T extends undefined | null | boolean | number | string | TReplaced ? T : Extract<T, Function> extends never ? T extends object ? T extends (infer U)[] ? Jsonable<U, TReplaced>[] : {
133
142
  [K in keyof T]: Extract<K, symbol> extends never ? Jsonable<T[K], TReplaced> : never;
134
143
  } : never : never;
135
144
 
136
- // @alpha
145
+ // @alpha @legacy
137
146
  export type JsonableTypeWith<T> = undefined | null | boolean | number | string | T | Internal_InterfaceOfJsonableTypesWith<T> | ArrayLike<JsonableTypeWith<T>>;
138
147
 
139
- // @alpha
148
+ // @alpha @legacy
140
149
  export type Serializable<T> = Jsonable<T, IFluidHandle>;
141
150
 
142
151
  ```
package/dist/dataStoreRuntime.d.ts CHANGED
@@ -23,6 +23,7 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
23
23
  (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
24
24
  (event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
25
25
  (event: "connected", listener: (clientId: string) => void): any;
26
+ (event: "readonly", listener: (isReadOnly: boolean) => void): any;
26
27
  }
27
28
  /**
28
29
  * Manages the transmission of ops between the runtime and storage.
@@ -46,6 +47,11 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
46
47
  readonly deltaManager: IDeltaManagerErased;
47
48
  readonly clientId: string | undefined;
48
49
  readonly connected: boolean;
50
+ /**
51
+ * Get the current readonly state.
52
+ * @returns true if read-only, otherwise false
53
+ */
54
+ readonly isReadOnly: () => boolean;
49
55
  readonly logger: ITelemetryBaseLogger;
50
56
  /**
51
57
  * Indicates the attachment state of the data store to a host service.
@@ -111,4 +117,23 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
111
117
  */
112
118
  readonly entryPoint: IFluidHandle<FluidObject>;
113
119
  }
120
+ /**
121
+ * @experimental
122
+ * @deprecated - These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
123
+ * @legacy
124
+ * @alpha
125
+ * @sealed
126
+ */
127
+ export interface IFluidDataStoreRuntimeExperimental extends IFluidDataStoreRuntime {
128
+ readonly inStagingMode?: boolean;
129
+ }
130
+ /**
131
+ * Internal configs possibly implemented by IFuidDataStoreRuntimes, for use only within the runtime layer.
132
+ * For example, temporary layer compatibility details
133
+ *
134
+ * @internal
135
+ */
136
+ export interface IFluidDataStoreRuntimeInternalConfig {
137
+ readonly submitMessagesWithoutEncodingHandles?: boolean;
138
+ }
114
139
  //# sourceMappingURL=dataStoreRuntime.d.ts.map
package/dist/dataStoreRuntime.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EACX,YAAY,EACZ,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAE1F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC9C,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACzC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC1C,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC9B,UAAU,CAAC,kGAAkG,CAAC,CAAC;AAEhH;;;;;GAKG;AACH,MAAM,WAAW,sBAChB,SAAQ,cAAc,CAAC,4BAA4B,CAAC,EACnD,WAAW;IACZ,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAEpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/C,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAE3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CACT,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhF;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAC/C"}
1
+ {"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EACX,YAAY,EACZ,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAE1F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC9C,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACzC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC1C,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAK3D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,OAAE;CAC7D;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC9B,UAAU,CAAC,kGAAkG,CAAC,CAAC;AAEhH;;;;;GAKG;AACH,MAAM,WAAW,sBAChB,SAAQ,cAAc,CAAC,4BAA4B,CAAC,EACnD,WAAW;IACZ,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAEpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/C,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAE3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,OAAO,CAAC;IAEnC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CACT,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhF;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kCAAmC,SAAQ,sBAAsB;IACjF,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,oCAAoC;IACpD,QAAQ,CAAC,oCAAoC,CAAC,EAAE,OAAO,CAAC;CACxD"}
package/dist/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  * @packageDocumentation
10
10
  */
11
11
  export type { IChannel, IChannelFactory, IChannelServices, IChannelStorageService, IDeltaConnection, IDeltaHandler, } from "./channel.js";
12
- export type { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents, IDeltaManagerErased, } from "./dataStoreRuntime.js";
12
+ export type { IFluidDataStoreRuntime, IFluidDataStoreRuntimeExperimental, IFluidDataStoreRuntimeEvents, IFluidDataStoreRuntimeInternalConfig, IDeltaManagerErased, } from "./dataStoreRuntime.js";
13
13
  export type { Jsonable, JsonableTypeWith, Internal_InterfaceOfJsonableTypesWith, } from "./jsonable.js";
14
14
  export type { Serializable } from "./serializable.js";
15
15
  export type { IChannelAttributes } from "./storage.js";
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,YAAY,EACX,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EACX,sBAAsB,EACtB,4BAA4B,EAC5B,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACX,QAAQ,EACR,gBAAgB,EAChB,qCAAqC,GACrC,MAAM,eAAe,CAAC;AACvB,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,YAAY,EACX,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EACX,sBAAsB,EACtB,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACX,QAAQ,EACR,gBAAgB,EAChB,qCAAqC,GACrC,MAAM,eAAe,CAAC;AACvB,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}
package/dist/legacy.d.ts CHANGED
@@ -27,6 +27,7 @@ export {
27
27
  IDeltaManagerErased,
28
28
  IFluidDataStoreRuntime,
29
29
  IFluidDataStoreRuntimeEvents,
30
+ IFluidDataStoreRuntimeExperimental,
30
31
  Internal_InterfaceOfJsonableTypesWith,
31
32
  Jsonable,
32
33
  JsonableTypeWith,
package/lib/dataStoreRuntime.d.ts CHANGED
@@ -23,6 +23,7 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
23
23
  (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
24
24
  (event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
25
25
  (event: "connected", listener: (clientId: string) => void): any;
26
+ (event: "readonly", listener: (isReadOnly: boolean) => void): any;
26
27
  }
27
28
  /**
28
29
  * Manages the transmission of ops between the runtime and storage.
@@ -46,6 +47,11 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
46
47
  readonly deltaManager: IDeltaManagerErased;
47
48
  readonly clientId: string | undefined;
48
49
  readonly connected: boolean;
50
+ /**
51
+ * Get the current readonly state.
52
+ * @returns true if read-only, otherwise false
53
+ */
54
+ readonly isReadOnly: () => boolean;
49
55
  readonly logger: ITelemetryBaseLogger;
50
56
  /**
51
57
  * Indicates the attachment state of the data store to a host service.
@@ -111,4 +117,23 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
111
117
  */
112
118
  readonly entryPoint: IFluidHandle<FluidObject>;
113
119
  }
120
+ /**
121
+ * @experimental
122
+ * @deprecated - These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
123
+ * @legacy
124
+ * @alpha
125
+ * @sealed
126
+ */
127
+ export interface IFluidDataStoreRuntimeExperimental extends IFluidDataStoreRuntime {
128
+ readonly inStagingMode?: boolean;
129
+ }
130
+ /**
131
+ * Internal configs possibly implemented by IFuidDataStoreRuntimes, for use only within the runtime layer.
132
+ * For example, temporary layer compatibility details
133
+ *
134
+ * @internal
135
+ */
136
+ export interface IFluidDataStoreRuntimeInternalConfig {
137
+ readonly submitMessagesWithoutEncodingHandles?: boolean;
138
+ }
114
139
  //# sourceMappingURL=dataStoreRuntime.d.ts.map
package/lib/dataStoreRuntime.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EACX,YAAY,EACZ,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAE1F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC9C,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACzC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC1C,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC9B,UAAU,CAAC,kGAAkG,CAAC,CAAC;AAEhH;;;;;GAKG;AACH,MAAM,WAAW,sBAChB,SAAQ,cAAc,CAAC,4BAA4B,CAAC,EACnD,WAAW;IACZ,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAEpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/C,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAE3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CACT,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhF;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAC/C"}
1
+ {"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EACX,YAAY,EACZ,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAE1F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC9C,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACzC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC1C,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAK3D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,OAAE;CAC7D;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC9B,UAAU,CAAC,kGAAkG,CAAC,CAAC;AAEhH;;;;;GAKG;AACH,MAAM,WAAW,sBAChB,SAAQ,cAAc,CAAC,4BAA4B,CAAC,EACnD,WAAW;IACZ,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAEpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/C,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAE3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,OAAO,CAAC;IAEnC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CACT,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhF;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kCAAmC,SAAQ,sBAAsB;IACjF,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,oCAAoC;IACpD,QAAQ,CAAC,oCAAoC,CAAC,EAAE,OAAO,CAAC;CACxD"}
package/lib/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  * @packageDocumentation
10
10
  */
11
11
  export type { IChannel, IChannelFactory, IChannelServices, IChannelStorageService, IDeltaConnection, IDeltaHandler, } from "./channel.js";
12
- export type { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents, IDeltaManagerErased, } from "./dataStoreRuntime.js";
12
+ export type { IFluidDataStoreRuntime, IFluidDataStoreRuntimeExperimental, IFluidDataStoreRuntimeEvents, IFluidDataStoreRuntimeInternalConfig, IDeltaManagerErased, } from "./dataStoreRuntime.js";
13
13
  export type { Jsonable, JsonableTypeWith, Internal_InterfaceOfJsonableTypesWith, } from "./jsonable.js";
14
14
  export type { Serializable } from "./serializable.js";
15
15
  export type { IChannelAttributes } from "./storage.js";
package/lib/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,YAAY,EACX,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EACX,sBAAsB,EACtB,4BAA4B,EAC5B,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACX,QAAQ,EACR,gBAAgB,EAChB,qCAAqC,GACrC,MAAM,eAAe,CAAC;AACvB,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,YAAY,EACX,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EACX,sBAAsB,EACtB,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACX,QAAQ,EACR,gBAAgB,EAChB,qCAAqC,GACrC,MAAM,eAAe,CAAC;AACvB,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}
package/lib/legacy.d.ts CHANGED
@@ -27,6 +27,7 @@ export {
27
27
  IDeltaManagerErased,
28
28
  IFluidDataStoreRuntime,
29
29
  IFluidDataStoreRuntimeEvents,
30
+ IFluidDataStoreRuntimeExperimental,
30
31
  Internal_InterfaceOfJsonableTypesWith,
31
32
  Jsonable,
32
33
  JsonableTypeWith,
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/datastore-definitions",
3
- "version": "2.33.0-333010",
3
+ "version": "2.33.0",
4
4
  "description": "Fluid data store definitions",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -41,11 +41,11 @@
41
41
  "main": "",
42
42
  "types": "lib/public.d.ts",
43
43
  "dependencies": {
44
- "@fluidframework/container-definitions": "2.33.0-333010",
45
- "@fluidframework/core-interfaces": "2.33.0-333010",
46
- "@fluidframework/driver-definitions": "2.33.0-333010",
47
- "@fluidframework/id-compressor": "2.33.0-333010",
48
- "@fluidframework/runtime-definitions": "2.33.0-333010"
44
+ "@fluidframework/container-definitions": "~2.33.0",
45
+ "@fluidframework/core-interfaces": "~2.33.0",
46
+ "@fluidframework/driver-definitions": "~2.33.0",
47
+ "@fluidframework/id-compressor": "~2.33.0",
48
+ "@fluidframework/runtime-definitions": "~2.33.0"
49
49
  },
50
50
  "devDependencies": {
51
51
  "@arethetypeswrong/cli": "^0.17.1",
@@ -53,9 +53,9 @@
53
53
  "@fluid-tools/build-cli": "^0.55.0",
54
54
  "@fluidframework/build-common": "^2.0.3",
55
55
  "@fluidframework/build-tools": "^0.55.0",
56
- "@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.31.0",
56
+ "@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.32.0",
57
57
  "@fluidframework/eslint-config-fluid": "^5.7.3",
58
- "@microsoft/api-extractor": "7.50.1",
58
+ "@microsoft/api-extractor": "7.52.5",
59
59
  "concurrently": "^8.2.1",
60
60
  "copyfiles": "^2.4.1",
61
61
  "eslint": "~8.55.0",
package/src/dataStoreRuntime.ts CHANGED
@@ -34,6 +34,11 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
34
34
  (event: "op", listener: (message: ISequencedDocumentMessage) => void);
35
35
  (event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void);
36
36
  (event: "connected", listener: (clientId: string) => void);
37
+ /*
38
+ * The readonly event is fired when the readonly state of the datastore runtime changes.
39
+ * The isReadOnly param will express the new readonly state.
40
+ */
41
+ (event: "readonly", listener: (isReadOnly: boolean) => void);
37
42
  }
38
43
 
39
44
  /**
@@ -69,6 +74,12 @@ export interface IFluidDataStoreRuntime
69
74
 
70
75
  readonly connected: boolean;
71
76
 
77
+ /**
78
+ * Get the current readonly state.
79
+ * @returns true if read-only, otherwise false
80
+ */
81
+ readonly isReadOnly: () => boolean;
82
+
72
83
  readonly logger: ITelemetryBaseLogger;
73
84
 
74
85
  /**
@@ -150,3 +161,24 @@ export interface IFluidDataStoreRuntime
150
161
  */
151
162
  readonly entryPoint: IFluidHandle<FluidObject>;
152
163
  }
164
+
165
+ /**
166
+ * @experimental
167
+ * @deprecated - These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
168
+ * @legacy
169
+ * @alpha
170
+ * @sealed
171
+ */
172
+ export interface IFluidDataStoreRuntimeExperimental extends IFluidDataStoreRuntime {
173
+ readonly inStagingMode?: boolean;
174
+ }
175
+
176
+ /**
177
+ * Internal configs possibly implemented by IFuidDataStoreRuntimes, for use only within the runtime layer.
178
+ * For example, temporary layer compatibility details
179
+ *
180
+ * @internal
181
+ */
182
+ export interface IFluidDataStoreRuntimeInternalConfig {
183
+ readonly submitMessagesWithoutEncodingHandles?: boolean;
184
+ }
package/src/index.ts CHANGED
@@ -20,7 +20,9 @@ export type {
20
20
  } from "./channel.js";
21
21
  export type {
22
22
  IFluidDataStoreRuntime,
23
+ IFluidDataStoreRuntimeExperimental,
23
24
  IFluidDataStoreRuntimeEvents,
25
+ IFluidDataStoreRuntimeInternalConfig,
24
26
  IDeltaManagerErased,
25
27
  } from "./dataStoreRuntime.js";
26
28
  export type {