@fluidframework/container-definitions - npm Package Compare versions

Comparing version 0.35.0-16170 to 0.35.0-16887

dist/deltas.d.ts

@@ -6,3 +6,3 @@ /*!
 import { IDisposable, IEventProvider, IEvent, IErrorEvent } from "@fluidframework/common-definitions";
-import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage, IProcessMessageResult, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims, MessageType } from "@fluidframework/protocol-definitions";
+import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
 /**
@@ -36,3 +36,3 @@ * Contract representing the result of a newly established connection to the server for syncing deltas
      */
-    process: (message: ISequencedDocumentMessage) => IProcessMessageResult;
+    process: (message: ISequencedDocumentMessage) => void;
     /**
@@ -56,11 +56,2 @@ * Processes the signal.
     /**
-     * Submits the given delta returning the client sequence number for the message. Contents is the actual
-     * contents of the message. appData is optional metadata that can be attached to the op by the app.
-     *
-     * If batch is set to true then the submit will be batched - and as a result guaranteed to be ordered sequentially
-     * in the global sequencing space. The batch will be flushed either when flush is called or when a non-batched
-     * op is submitted.
-     */
-    submit(type: MessageType, contents: any, batch: boolean, metadata: any): number;
-    /**
      * Flush all pending messages through the outbound queue
@@ -125,4 +116,6 @@ */
      * and do not know if user has write access to a file.
+     * @deprecated - use readOnlyInfo
      */
     readonly readonly?: boolean;
+    readonly readOnlyInfo: ReadOnlyInfo;
     /** Terminate the connection to storage */
@@ -172,2 +165,13 @@ close(): void;
 }
+export declare type ReadOnlyInfo = {
+    readonly readonly: false | undefined;
+} | {
+    readonly readonly: true;
+    /** read-only because forceReadOnly() was called */
+    readonly forced: boolean;
+    /** read-only because client does not have write permissions for document */
+    readonly permissions: boolean | undefined;
+    /** read-only with no delta stream connection */
+    readonly storageOnly: boolean;
+};
 //# sourceMappingURL=deltas.d.ts.map

dist/error.d.ts

@@ -20,3 +20,7 @@ /*!
      */
-    dataCorruptionError = "dataCorruptionError"
+    dataCorruptionError = "dataCorruptionError",
+    /**
+     * Error encountered when processing an operation. May correlate with data corruption.
+     */
+    dataProcessingError = "dataProcessingError"
 }
@@ -23,0 +27,0 @@ /**

dist/error.js

@@ -25,3 +25,7 @@ "use strict";
     ContainerErrorType["dataCorruptionError"] = "dataCorruptionError";
+    /**
+     * Error encountered when processing an operation. May correlate with data corruption.
+     */
+    ContainerErrorType["dataProcessingError"] = "dataProcessingError";
 })(ContainerErrorType = exports.ContainerErrorType || (exports.ContainerErrorType = {}));
 //# sourceMappingURL=error.js.map

dist/loader.d.ts

@@ -76,2 +76,3 @@ /*!
     (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
+    (event: "dirty" | "saved", listener: (dirty: boolean) => void): any;
 }
@@ -108,2 +109,8 @@ /**
     /**
+     * Returns true if the container is dirty, i.e. there are user changes that has not been saved
+     * Closing container in this state results in data loss for user.
+     * Container usually gets into this situation due to loss of connectivity.
+     */
+    readonly isDirty: boolean;
+    /**
      * Closes the container
@@ -110,0 +117,0 @@ */

dist/runtime.d.ts

@@ -85,3 +85,3 @@ /*!
     readonly clientDetails: IClientDetails;
-    readonly storage: IDocumentStorageService | undefined | null;
+    readonly storage: IDocumentStorageService | undefined;
     readonly connected: boolean;
@@ -116,2 +116,3 @@ readonly baseSnapshot: ISnapshotTree | undefined;
     getLoadedFromVersion(): IVersion | undefined;
+    updateDirtyContainerState(dirty: boolean): void;
 }
@@ -118,0 +119,0 @@ export declare const IRuntimeFactory: keyof IProvideRuntimeFactory;

lib/deltas.d.ts

@@ -6,3 +6,3 @@ /*!
 import { IDisposable, IEventProvider, IEvent, IErrorEvent } from "@fluidframework/common-definitions";
-import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage, IProcessMessageResult, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims, MessageType } from "@fluidframework/protocol-definitions";
+import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
 /**
@@ -36,3 +36,3 @@ * Contract representing the result of a newly established connection to the server for syncing deltas
      */
-    process: (message: ISequencedDocumentMessage) => IProcessMessageResult;
+    process: (message: ISequencedDocumentMessage) => void;
     /**
@@ -56,11 +56,2 @@ * Processes the signal.
     /**
-     * Submits the given delta returning the client sequence number for the message. Contents is the actual
-     * contents of the message. appData is optional metadata that can be attached to the op by the app.
-     *
-     * If batch is set to true then the submit will be batched - and as a result guaranteed to be ordered sequentially
-     * in the global sequencing space. The batch will be flushed either when flush is called or when a non-batched
-     * op is submitted.
-     */
-    submit(type: MessageType, contents: any, batch: boolean, metadata: any): number;
-    /**
      * Flush all pending messages through the outbound queue
@@ -125,4 +116,6 @@ */
      * and do not know if user has write access to a file.
+     * @deprecated - use readOnlyInfo
      */
     readonly readonly?: boolean;
+    readonly readOnlyInfo: ReadOnlyInfo;
     /** Terminate the connection to storage */
@@ -172,2 +165,13 @@ close(): void;
 }
+export declare type ReadOnlyInfo = {
+    readonly readonly: false | undefined;
+} | {
+    readonly readonly: true;
+    /** read-only because forceReadOnly() was called */
+    readonly forced: boolean;
+    /** read-only because client does not have write permissions for document */
+    readonly permissions: boolean | undefined;
+    /** read-only with no delta stream connection */
+    readonly storageOnly: boolean;
+};
 //# sourceMappingURL=deltas.d.ts.map

lib/error.d.ts

@@ -20,3 +20,7 @@ /*!
      */
-    dataCorruptionError = "dataCorruptionError"
+    dataCorruptionError = "dataCorruptionError",
+    /**
+     * Error encountered when processing an operation. May correlate with data corruption.
+     */
+    dataProcessingError = "dataProcessingError"
 }
@@ -23,0 +27,0 @@ /**

lib/error.js

@@ -22,3 +22,7 @@ /*!
     ContainerErrorType["dataCorruptionError"] = "dataCorruptionError";
+    /**
+     * Error encountered when processing an operation. May correlate with data corruption.
+     */
+    ContainerErrorType["dataProcessingError"] = "dataProcessingError";
 })(ContainerErrorType || (ContainerErrorType = {}));
 //# sourceMappingURL=error.js.map

lib/loader.d.ts

@@ -76,2 +76,3 @@ /*!
     (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
+    (event: "dirty" | "saved", listener: (dirty: boolean) => void): any;
 }
@@ -108,2 +109,8 @@ /**
     /**
+     * Returns true if the container is dirty, i.e. there are user changes that has not been saved
+     * Closing container in this state results in data loss for user.
+     * Container usually gets into this situation due to loss of connectivity.
+     */
+    readonly isDirty: boolean;
+    /**
      * Closes the container
@@ -110,0 +117,0 @@ */

lib/runtime.d.ts

@@ -85,3 +85,3 @@ /*!
     readonly clientDetails: IClientDetails;
-    readonly storage: IDocumentStorageService | undefined | null;
+    readonly storage: IDocumentStorageService | undefined;
     readonly connected: boolean;
@@ -116,2 +116,3 @@ readonly baseSnapshot: ISnapshotTree | undefined;
     getLoadedFromVersion(): IVersion | undefined;
+    updateDirtyContainerState(dirty: boolean): void;
 }
@@ -118,0 +119,0 @@ export declare const IRuntimeFactory: keyof IProvideRuntimeFactory;

package.json

 {
   "name": "@fluidframework/container-definitions",
-  "version": "0.35.0-16170",
+  "version": "0.35.0-16887",
   "description": "Fluid container definitions",
@@ -32,4 +32,4 @@ "homepage": "https://fluidframework.com",
     "@fluidframework/common-definitions": "^0.19.1",
-    "@fluidframework/core-interfaces": "0.35.0-16170",
-    "@fluidframework/driver-definitions": "0.35.0-16170",
+    "@fluidframework/core-interfaces": "0.35.0-16887",
+    "@fluidframework/driver-definitions": "0.35.0-16887",
     "@fluidframework/protocol-definitions": "^0.1019.0-0"
@@ -39,3 +39,3 @@ },
     "@fluidframework/build-common": "^0.20.0-0",
-    "@fluidframework/eslint-config-fluid": "^0.22.1-0",
+    "@fluidframework/eslint-config-fluid": "^0.23.0-0",
     "@microsoft/api-extractor": "^7.7.2",
@@ -42,0 +42,0 @@ "@types/node": "^10.17.24",

src/deltas.ts

@@ -12,3 +12,2 @@ /*!
     IDocumentMessage,
-    IProcessMessageResult,
     ISequencedDocumentMessage,
@@ -18,3 +17,2 @@ ISignalClient,
     ITokenClaims,
-    MessageType,
 } from "@fluidframework/protocol-definitions";
@@ -51,3 +49,3 @@
      */
-    process: (message: ISequencedDocumentMessage) => IProcessMessageResult;
+    process: (message: ISequencedDocumentMessage) => void;
 
@@ -76,12 +74,2 @@ /**
     /**
-     * Submits the given delta returning the client sequence number for the message. Contents is the actual
-     * contents of the message. appData is optional metadata that can be attached to the op by the app.
-     *
-     * If batch is set to true then the submit will be batched - and as a result guaranteed to be ordered sequentially
-     * in the global sequencing space. The batch will be flushed either when flush is called or when a non-batched
-     * op is submitted.
-     */
-    submit(type: MessageType, contents: any, batch: boolean, metadata: any): number;
-
-    /**
      * Flush all pending messages through the outbound queue
@@ -161,5 +149,8 @@ */
      * and do not know if user has write access to a file.
+     * @deprecated - use readOnlyInfo
      */
     readonly readonly?: boolean;
 
+    readonly readOnlyInfo: ReadOnlyInfo;
+
     /** Terminate the connection to storage */
@@ -218,1 +209,13 @@ close(): void;
 }
+
+export type ReadOnlyInfo = {
+    readonly readonly: false | undefined;
+} | {
+    readonly readonly: true;
+    /** read-only because forceReadOnly() was called */
+    readonly forced: boolean;
+    /** read-only because client does not have write permissions for document */
+    readonly permissions: boolean | undefined;
+    /** read-only with no delta stream connection */
+    readonly storageOnly: boolean;
+};

src/error.ts

@@ -24,2 +24,7 @@ /*!
     dataCorruptionError = "dataCorruptionError",
+
+    /**
+     * Error encountered when processing an operation. May correlate with data corruption.
+     */
+    dataProcessingError = "dataProcessingError",
 }
@@ -26,0 +31,0 @@

src/loader.ts

@@ -96,2 +96,3 @@ /*!
     (event: "op", listener: (message: ISequencedDocumentMessage) => void);
+    (event: "dirty" | "saved", listener: (dirty: boolean) => void);
 }
@@ -136,2 +137,9 @@
     /**
+     * Returns true if the container is dirty, i.e. there are user changes that has not been saved
+     * Closing container in this state results in data loss for user.
+     * Container usually gets into this situation due to loss of connectivity.
+     */
+    readonly isDirty: boolean;
+
+    /**
      * Closes the container
@@ -138,0 +146,0 @@ */

src/runtime.ts

@@ -117,3 +117,3 @@ /*!
     readonly clientDetails: IClientDetails;
-    readonly storage: IDocumentStorageService | undefined | null;
+    readonly storage: IDocumentStorageService | undefined;
     readonly connected: boolean;
@@ -154,2 +154,3 @@ readonly baseSnapshot: ISnapshotTree | undefined;
 
+    updateDirtyContainerState(dirty: boolean): void;
 }
@@ -156,0 +157,0 @@

No alert changes

Improved metrics

Total package byte prevSize

204234

increased by1.67%

Lines of code

2616

increased by2.11%

Dependency changes

• + Added@fluidframework/core-interfaces@0.35.0-16887(transitive)

• + Added@fluidframework/driver-definitions@0.35.0-16887(transitive)

• - Removed@fluidframework/core-interfaces@0.35.0-16170(transitive)

• - Removed@fluidframework/driver-definitions@0.35.0-16170(transitive)

• Updated@fluidframework/core-interfaces@0.35.0-16887

• Updated@fluidframework/driver-definitions@0.35.0-16887