@fluidframework/protocol-definitions - npm Package Compare versions

Comparing version 0.1028.2000-68027 to 0.1028.2000

.eslintrc.js

@@ -11,6 +11,3 @@ /*!
     rules: {
-        "@typescript-eslint/no-use-before-define": "off",
-        "@typescript-eslint/strict-boolean-expressions": "off",
-        "no-case-declarations": "off"
     }
 }

api-report/protocol-definitions.api.md

@@ -411,3 +411,3 @@ ## API Report File for "@fluidframework/protocol-definitions"
 
-// @public (undocumented)
+// @public
 export interface ISummaryAttachment {
@@ -430,3 +430,3 @@ // (undocumented)
 
-// @public (undocumented)
+// @public
 export interface ISummaryBlob {
@@ -477,7 +477,5 @@ // (undocumented)
 
-// @public (undocumented)
+// @public
 export interface ISummaryHandle {
-    // (undocumented)
     handle: string;
-    // (undocumented)
     handleType: SummaryTypeNoHandle;
@@ -511,3 +509,3 @@ // (undocumented)
 
-// @public (undocumented)
+// @public
 export interface ISummaryTree {
@@ -671,3 +669,3 @@ // (undocumented)
 
-// @public (undocumented)
+// @public
 export namespace SummaryType {
@@ -682,10 +680,6 @@ // (undocumented)
     export type Tree = 1;
-    const // (undocumented)
-    Tree: Tree;
-    const // (undocumented)
-    Blob: Blob;
-    const // (undocumented)
-    Handle: Handle;
-    const // (undocumented)
-    Attachment: Attachment;
+    const Tree: Tree;
+    const Blob: Blob;
+    const Handle: Handle;
+    const Attachment: Attachment;
 }
@@ -692,0 +686,0 @@

dist/summary.d.ts

@@ -17,2 +17,5 @@ /*!
 }
+/**
+ *  Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.
+ */
 export declare namespace SummaryType {
@@ -23,5 +26,21 @@ type Tree = 1;
     type Attachment = 4;
+    /**
+     *  Represents a sub-tree in the summary.
+     */
     const Tree: Tree;
+    /**
+     * Represents a blob of data that is added to the summary.
+     * Such as the user data that is added to the DDS or metadata added by runtime
+     * such as data store / channel attributes.
+     */
     const Blob: Blob;
+    /**
+     * Path to a summary tree object from the last successful summary.
+     */
     const Handle: Handle;
+    /**
+     * Unique identifier to larger blobs uploaded outside of the summary.
+     * Ex. DDS has large images or video that will be uploaded by the BlobManager and
+     * receive an Id that can be used in the summary.
+     */
     const Attachment: Attachment;
@@ -31,7 +50,27 @@ }
 export declare type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
+/**
+ * Path to a summary tree object from the last successful summary indicating the summary object hasn't
+ * changed since it was uploaded.
+ * To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the
+ * entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS.
+ * An example of handle would be: '/<DataStoreId>/<DDSId>'.
+ */
 export interface ISummaryHandle {
     type: SummaryType.Handle;
+    /**
+     * Type of Summary Handle (SummaryType.Handle is not supported).
+     */
     handleType: SummaryTypeNoHandle;
+    /**
+     * Unique path that identifies the corresponding sub-tree in a previous summary.
+     */
     handle: string;
 }
+/**
+ * String or Binary data to be uploaded to the server as part of the container's Summary.
+ * Note: Already uploaded blobs would be referenced by a ISummaryAttachment.
+ * Additional information can be found here: https://github.com/microsoft/FluidFramework/issues/6568
+ * Ex. "content": "\{ \"pkg\":\"[\\\"OfficeRootComponent\\\",\\\"LastEditedComponent\\\"]\",
+ *                    \"summaryFormatVersion\":2,\"isRootDataStore\":false \}"
+ */
 export interface ISummaryBlob {
@@ -41,2 +80,9 @@ type: SummaryType.Blob;
 }
+/**
+ * Unique identifier for blobs uploaded outside of the summary. Attachment Blobs are uploaded and
+ * downloaded separately and do not take part of the snapshot payload.
+ * The id gets returned from the backend after the attachment has been uploaded.
+ * Additional information can be found here: https://github.com/microsoft/FluidFramework/issues/6374
+ * Ex. "id": "bQAQKARDdMdTgqICmBa_ZB86YXwGP"
+ */
 export interface ISummaryAttachment {
@@ -46,2 +92,6 @@ type: SummaryType.Attachment;
 }
+/**
+ * Tree Node data structure with children that are nodes of SummaryObject type:
+ * Blob, Handle, Attachment or another Tree.
+ */
 export interface ISummaryTree {
@@ -48,0 +98,0 @@ type: SummaryType.Tree;

dist/summary.js

@@ -8,9 +8,29 @@ "use strict";
 exports.SummaryType = void 0;
+/**
+ *  Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.
+ */
+// eslint-disable-next-line @typescript-eslint/no-namespace
 var SummaryType;
 (function (SummaryType) {
+    /**
+     *  Represents a sub-tree in the summary.
+     */
     SummaryType.Tree = 1;
+    /**
+     * Represents a blob of data that is added to the summary.
+     * Such as the user data that is added to the DDS or metadata added by runtime
+     * such as data store / channel attributes.
+     */
     SummaryType.Blob = 2;
+    /**
+     * Path to a summary tree object from the last successful summary.
+     */
     SummaryType.Handle = 3;
+    /**
+     * Unique identifier to larger blobs uploaded outside of the summary.
+     * Ex. DDS has large images or video that will be uploaded by the BlobManager and
+     * receive an Id that can be used in the summary.
+     */
     SummaryType.Attachment = 4;
 })(SummaryType = exports.SummaryType || (exports.SummaryType = {}));
 //# sourceMappingURL=summary.js.map

lib/summary.d.ts

@@ -17,2 +17,5 @@ /*!
 }
+/**
+ *  Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.
+ */
 export declare namespace SummaryType {
@@ -23,5 +26,21 @@ type Tree = 1;
     type Attachment = 4;
+    /**
+     *  Represents a sub-tree in the summary.
+     */
     const Tree: Tree;
+    /**
+     * Represents a blob of data that is added to the summary.
+     * Such as the user data that is added to the DDS or metadata added by runtime
+     * such as data store / channel attributes.
+     */
     const Blob: Blob;
+    /**
+     * Path to a summary tree object from the last successful summary.
+     */
     const Handle: Handle;
+    /**
+     * Unique identifier to larger blobs uploaded outside of the summary.
+     * Ex. DDS has large images or video that will be uploaded by the BlobManager and
+     * receive an Id that can be used in the summary.
+     */
     const Attachment: Attachment;
@@ -31,7 +50,27 @@ }
 export declare type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
+/**
+ * Path to a summary tree object from the last successful summary indicating the summary object hasn't
+ * changed since it was uploaded.
+ * To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the
+ * entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS.
+ * An example of handle would be: '/<DataStoreId>/<DDSId>'.
+ */
 export interface ISummaryHandle {
     type: SummaryType.Handle;
+    /**
+     * Type of Summary Handle (SummaryType.Handle is not supported).
+     */
     handleType: SummaryTypeNoHandle;
+    /**
+     * Unique path that identifies the corresponding sub-tree in a previous summary.
+     */
     handle: string;
 }
+/**
+ * String or Binary data to be uploaded to the server as part of the container's Summary.
+ * Note: Already uploaded blobs would be referenced by a ISummaryAttachment.
+ * Additional information can be found here: https://github.com/microsoft/FluidFramework/issues/6568
+ * Ex. "content": "\{ \"pkg\":\"[\\\"OfficeRootComponent\\\",\\\"LastEditedComponent\\\"]\",
+ *                    \"summaryFormatVersion\":2,\"isRootDataStore\":false \}"
+ */
 export interface ISummaryBlob {
@@ -41,2 +80,9 @@ type: SummaryType.Blob;
 }
+/**
+ * Unique identifier for blobs uploaded outside of the summary. Attachment Blobs are uploaded and
+ * downloaded separately and do not take part of the snapshot payload.
+ * The id gets returned from the backend after the attachment has been uploaded.
+ * Additional information can be found here: https://github.com/microsoft/FluidFramework/issues/6374
+ * Ex. "id": "bQAQKARDdMdTgqICmBa_ZB86YXwGP"
+ */
 export interface ISummaryAttachment {
@@ -46,2 +92,6 @@ type: SummaryType.Attachment;
 }
+/**
+ * Tree Node data structure with children that are nodes of SummaryObject type:
+ * Blob, Handle, Attachment or another Tree.
+ */
 export interface ISummaryTree {
@@ -48,0 +98,0 @@ type: SummaryType.Tree;

lib/summary.js

@@ -5,9 +5,29 @@ /*!
  */
+/**
+ *  Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.
+ */
+// eslint-disable-next-line @typescript-eslint/no-namespace
 export var SummaryType;
 (function (SummaryType) {
+    /**
+     *  Represents a sub-tree in the summary.
+     */
     SummaryType.Tree = 1;
+    /**
+     * Represents a blob of data that is added to the summary.
+     * Such as the user data that is added to the DDS or metadata added by runtime
+     * such as data store / channel attributes.
+     */
     SummaryType.Blob = 2;
+    /**
+     * Path to a summary tree object from the last successful summary.
+     */
     SummaryType.Handle = 3;
+    /**
+     * Unique identifier to larger blobs uploaded outside of the summary.
+     * Ex. DDS has large images or video that will be uploaded by the BlobManager and
+     * receive an Id that can be used in the summary.
+     */
     SummaryType.Attachment = 4;
 })(SummaryType || (SummaryType = {}));
 //# sourceMappingURL=summary.js.map

package.json

 {
   "name": "@fluidframework/protocol-definitions",
-  "version": "0.1028.2000-68027",
+  "version": "0.1028.2000",
   "description": "Fluid protocol definitions",
@@ -45,3 +45,3 @@ "homepage": "https://fluidframework.com",
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.66793",
+    "@fluidframework/build-tools": "^0.2.70857",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
@@ -60,2 +60,3 @@ "@fluidframework/protocol-definitions-previous": "npm:@fluidframework/protocol-definitions@0.1028.1000",
     "eslint-plugin-jest": "~26.1.3",
+    "eslint-plugin-jsdoc": "~39.3.0",
     "eslint-plugin-mocha": "~10.0.3",
@@ -66,2 +67,3 @@ "eslint-plugin-promise": "~6.0.0",
     "eslint-plugin-unicorn": "~40.0.0",
+    "eslint-plugin-unused-imports": "~2.0.0",
     "rimraf": "^2.6.2",
@@ -68,0 +70,0 @@ "typescript": "~4.5.5",

src/summary.ts

@@ -24,2 +24,6 @@ /*!
 
+/**
+ *  Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.
+ */
+// eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace SummaryType {
@@ -31,6 +35,25 @@ export type Tree = 1;
 
-    export const Tree: Tree = 1 as const;
-    export const Blob: Blob = 2 as const;
-    export const Handle: Handle = 3 as const;
-    export const Attachment: Attachment = 4 as const;
+    /**
+     *  Represents a sub-tree in the summary.
+     */
+     export const Tree: Tree = 1 as const;
+
+     /**
+      * Represents a blob of data that is added to the summary.
+      * Such as the user data that is added to the DDS or metadata added by runtime
+      * such as data store / channel attributes.
+      */
+     export const Blob: Blob = 2 as const;
+
+     /**
+      * Path to a summary tree object from the last successful summary.
+      */
+     export const Handle: Handle = 3 as const;
+
+     /**
+      * Unique identifier to larger blobs uploaded outside of the summary.
+      * Ex. DDS has large images or video that will be uploaded by the BlobManager and
+      * receive an Id that can be used in the summary.
+      */
+     export const Attachment: Attachment = 4 as const;
 }
@@ -41,12 +64,30 @@ export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
 
+/**
+ * Path to a summary tree object from the last successful summary indicating the summary object hasn't
+ * changed since it was uploaded.
+ * To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the
+ * entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS.
+ * An example of handle would be: '/<DataStoreId>/<DDSId>'.
+ */
 export interface ISummaryHandle {
     type: SummaryType.Handle;
 
-    // No handles, all other SummaryType are Ok
+    /**
+     * Type of Summary Handle (SummaryType.Handle is not supported).
+     */
     handleType: SummaryTypeNoHandle;
 
-    // Stored handle reference
+    /**
+     * Unique path that identifies the corresponding sub-tree in a previous summary.
+     */
     handle: string;
 }
 
+/**
+ * String or Binary data to be uploaded to the server as part of the container's Summary.
+ * Note: Already uploaded blobs would be referenced by a ISummaryAttachment.
+ * Additional information can be found here: https://github.com/microsoft/FluidFramework/issues/6568
+ * Ex. "content": "\{ \"pkg\":\"[\\\"OfficeRootComponent\\\",\\\"LastEditedComponent\\\"]\",
+ *                    \"summaryFormatVersion\":2,\"isRootDataStore\":false \}"
+ */
 export interface ISummaryBlob {
@@ -57,2 +98,9 @@ type: SummaryType.Blob;
 
+/**
+ * Unique identifier for blobs uploaded outside of the summary. Attachment Blobs are uploaded and
+ * downloaded separately and do not take part of the snapshot payload.
+ * The id gets returned from the backend after the attachment has been uploaded.
+ * Additional information can be found here: https://github.com/microsoft/FluidFramework/issues/6374
+ * Ex. "id": "bQAQKARDdMdTgqICmBa_ZB86YXwGP"
+ */
 export interface ISummaryAttachment {
@@ -63,2 +111,6 @@ type: SummaryType.Attachment;
 
+/**
+ * Tree Node data structure with children that are nodes of SummaryObject type:
+ * Blob, Handle, Attachment or another Tree.
+ */
 export interface ISummaryTree {
@@ -65,0 +117,0 @@ type: SummaryType.Tree;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

308709

increased by4.46%

Lines of code

2964

increased by6.7%

Worsened metrics

Dev dependency count

25

increased by8.7%

No dependency changes