@fluidframework/protocol-base - npm Package Compare versions

Comparing version 0.1040.1000 to 0.1041.1000-154635

dist/packageVersion.d.ts

@@ -8,3 +8,3 @@ /*!
 export declare const pkgName = "@fluidframework/protocol-base";
-export declare const pkgVersion = "0.1040.1000";
+export declare const pkgVersion = "0.1041.1000-154635";
 //# sourceMappingURL=packageVersion.d.ts.map

dist/packageVersion.js

@@ -11,3 +11,3 @@ "use strict";
 exports.pkgName = "@fluidframework/protocol-base";
-exports.pkgVersion = "0.1040.1000";
+exports.pkgVersion = "0.1041.1000-154635";
 //# sourceMappingURL=packageVersion.js.map

dist/protocol.d.ts

@@ -7,2 +7,3 @@ /*!
 import { IQuorumSnapshot, Quorum } from "./quorum";
+export declare const OnlyValidTermValue: 1;
 export interface IScribeProtocolState {
@@ -39,4 +40,3 @@ sequenceNumber: number;
     get quorum(): Quorum;
-    readonly term: number;
-    constructor(minimumSequenceNumber: number, sequenceNumber: number, term: number | undefined, members: [string, ISequencedClient][], proposals: [number, ISequencedProposal, string[]][], values: [string, ICommittedProposal][], sendProposal: (key: string, value: any) => number);
+    constructor(minimumSequenceNumber: number, sequenceNumber: number, members: [string, ISequencedClient][], proposals: [number, ISequencedProposal, string[]][], values: [string, ICommittedProposal][], sendProposal: (key: string, value: any) => number);
     get attributes(): IDocumentAttributes;
@@ -43,0 +43,0 @@ setConnectionState(connected: boolean, clientId: string | undefined): void;

dist/protocol.js

@@ -7,5 +7,7 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProtocolOpHandler = exports.isSystemMessage = void 0;
+exports.ProtocolOpHandler = exports.isSystemMessage = exports.OnlyValidTermValue = void 0;
 const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
 const quorum_1 = require("./quorum");
+// "term" was an experimental feature that is being removed.  The only safe value to use is 1.
+exports.OnlyValidTermValue = 1;
 function isSystemMessage(message) {
@@ -32,6 +34,5 @@ switch (message.type) {
 class ProtocolOpHandler {
-    constructor(minimumSequenceNumber, sequenceNumber, term, members, proposals, values, sendProposal) {
+    constructor(minimumSequenceNumber, sequenceNumber, members, proposals, values, sendProposal) {
         this.minimumSequenceNumber = minimumSequenceNumber;
         this.sequenceNumber = sequenceNumber;
-        this.term = term !== null && term !== void 0 ? term : 1;
         this._quorum = new quorum_1.Quorum(members, proposals, values, sendProposal);
@@ -46,3 +47,3 @@ }
             sequenceNumber: this.sequenceNumber,
-            term: this.term,
+            term: exports.OnlyValidTermValue,
         };
@@ -49,0 +50,0 @@ }

dist/scribeHelper.d.ts

@@ -5,8 +5,8 @@ /*!
  */
+import { ICreateTreeEntry, ITree } from "@fluidframework/gitresources";
 import { ITreeEntry } from "@fluidframework/protocol-definitions";
-import { ICreateTreeEntry, ITree } from "@fluidframework/gitresources";
 import { IQuorumSnapshot } from "./quorum";
-export declare function getQuorumTreeEntries(documentId: string, minimumSequenceNumber: number, sequenceNumber: number, term: number, quorumSnapshot: IQuorumSnapshot): ITreeEntry[];
+export declare function getQuorumTreeEntries(minimumSequenceNumber: number, sequenceNumber: number, quorumSnapshot: IQuorumSnapshot): ITreeEntry[];
 export declare function mergeAppAndProtocolTree(appSummaryTree: ITree, protocolTree: ITree): ICreateTreeEntry[];
 export declare function generateServiceProtocolEntries(deli: string, scribe: string): ITreeEntry[];
 //# sourceMappingURL=scribeHelper.d.ts.map

dist/scribeHelper.js

@@ -9,7 +9,8 @@ "use strict";
 const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
-function getQuorumTreeEntries(documentId, minimumSequenceNumber, sequenceNumber, term, quorumSnapshot) {
+const protocol_1 = require("./protocol");
+function getQuorumTreeEntries(minimumSequenceNumber, sequenceNumber, quorumSnapshot) {
     const documentAttributes = {
         minimumSequenceNumber,
         sequenceNumber,
-        term,
+        term: protocol_1.OnlyValidTermValue,
     };
@@ -16,0 +17,0 @@ const entries = [

lib/packageVersion.d.ts

@@ -8,3 +8,3 @@ /*!
 export declare const pkgName = "@fluidframework/protocol-base";
-export declare const pkgVersion = "0.1040.1000";
+export declare const pkgVersion = "0.1041.1000-154635";
 //# sourceMappingURL=packageVersion.d.ts.map

lib/packageVersion.js

@@ -8,3 +8,3 @@ /*!
 export const pkgName = "@fluidframework/protocol-base";
-export const pkgVersion = "0.1040.1000";
+export const pkgVersion = "0.1041.1000-154635";
 //# sourceMappingURL=packageVersion.js.map

lib/protocol.d.ts

@@ -7,2 +7,3 @@ /*!
 import { IQuorumSnapshot, Quorum } from "./quorum";
+export declare const OnlyValidTermValue: 1;
 export interface IScribeProtocolState {
@@ -39,4 +40,3 @@ sequenceNumber: number;
     get quorum(): Quorum;
-    readonly term: number;
-    constructor(minimumSequenceNumber: number, sequenceNumber: number, term: number | undefined, members: [string, ISequencedClient][], proposals: [number, ISequencedProposal, string[]][], values: [string, ICommittedProposal][], sendProposal: (key: string, value: any) => number);
+    constructor(minimumSequenceNumber: number, sequenceNumber: number, members: [string, ISequencedClient][], proposals: [number, ISequencedProposal, string[]][], values: [string, ICommittedProposal][], sendProposal: (key: string, value: any) => number);
     get attributes(): IDocumentAttributes;
@@ -43,0 +43,0 @@ setConnectionState(connected: boolean, clientId: string | undefined): void;

lib/protocol.js

@@ -7,2 +7,4 @@ /*!
 import { Quorum } from "./quorum";
+// "term" was an experimental feature that is being removed.  The only safe value to use is 1.
+export const OnlyValidTermValue = 1;
 export function isSystemMessage(message) {
@@ -28,6 +30,5 @@ switch (message.type) {
 export class ProtocolOpHandler {
-    constructor(minimumSequenceNumber, sequenceNumber, term, members, proposals, values, sendProposal) {
+    constructor(minimumSequenceNumber, sequenceNumber, members, proposals, values, sendProposal) {
         this.minimumSequenceNumber = minimumSequenceNumber;
         this.sequenceNumber = sequenceNumber;
-        this.term = term !== null && term !== void 0 ? term : 1;
         this._quorum = new Quorum(members, proposals, values, sendProposal);
@@ -42,3 +43,3 @@ }
             sequenceNumber: this.sequenceNumber,
-            term: this.term,
+            term: OnlyValidTermValue,
         };
@@ -45,0 +46,0 @@ }

lib/scribeHelper.d.ts

@@ -5,8 +5,8 @@ /*!
  */
+import { ICreateTreeEntry, ITree } from "@fluidframework/gitresources";
 import { ITreeEntry } from "@fluidframework/protocol-definitions";
-import { ICreateTreeEntry, ITree } from "@fluidframework/gitresources";
 import { IQuorumSnapshot } from "./quorum";
-export declare function getQuorumTreeEntries(documentId: string, minimumSequenceNumber: number, sequenceNumber: number, term: number, quorumSnapshot: IQuorumSnapshot): ITreeEntry[];
+export declare function getQuorumTreeEntries(minimumSequenceNumber: number, sequenceNumber: number, quorumSnapshot: IQuorumSnapshot): ITreeEntry[];
 export declare function mergeAppAndProtocolTree(appSummaryTree: ITree, protocolTree: ITree): ICreateTreeEntry[];
 export declare function generateServiceProtocolEntries(deli: string, scribe: string): ITreeEntry[];
 //# sourceMappingURL=scribeHelper.d.ts.map

lib/scribeHelper.js

@@ -6,7 +6,8 @@ /*!
 import { FileMode, TreeEntry, } from "@fluidframework/protocol-definitions";
-export function getQuorumTreeEntries(documentId, minimumSequenceNumber, sequenceNumber, term, quorumSnapshot) {
+import { OnlyValidTermValue } from "./protocol";
+export function getQuorumTreeEntries(minimumSequenceNumber, sequenceNumber, quorumSnapshot) {
     const documentAttributes = {
         minimumSequenceNumber,
         sequenceNumber,
-        term,
+        term: OnlyValidTermValue,
     };
@@ -13,0 +14,0 @@ const entries = [

package.json

 {
 	"name": "@fluidframework/protocol-base",
-	"version": "0.1040.1000",
+	"version": "0.1041.1000-154635",
 	"description": "Fluid protocol base",
@@ -19,3 +19,3 @@ "homepage": "https://fluidframework.com",
 		"build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-		"build:commonjs": "npm run tsc && npm run build:test",
+		"build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
 		"build:compile": "concurrently npm:build:commonjs npm:build:esnext",
@@ -33,10 +33,12 @@ "build:docs": "api-extractor run --local && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../_api-extractor-temp/",
 		"format": "npm run prettier:fix",
-		"lint": "npm run eslint",
-		"lint:fix": "npm run eslint:fix",
+		"lint": "npm run prettier && npm run eslint",
+		"lint:fix": "npm run prettier:fix && npm run eslint:fix",
 		"prettier": "prettier --check . --ignore-path ../../.prettierignore",
 		"prettier:fix": "prettier --write . --ignore-path ../../.prettierignore",
-		"test": "mocha --recursive dist/test --unhandled-rejections=strict",
+		"test": "mocha --recursive dist/test/*.spec.js --unhandled-rejections=strict",
 		"test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
 		"tsc": "tsc",
-		"tsc:watch": "tsc --watch"
+		"tsc:watch": "tsc --watch",
+		"typetests:gen": "fluid-type-test-generator",
+		"typetests:prepare": "flub generate typetests --prepare --dir . --pin"
 	},
@@ -65,3 +67,3 @@ "nyc": {
 		"@fluidframework/common-utils": "^1.1.1",
-		"@fluidframework/gitresources": "^0.1040.1000",
+		"@fluidframework/gitresources": "0.1041.1000-154635",
 		"@fluidframework/protocol-definitions": "^1.1.0",
@@ -72,6 +74,7 @@ "events": "^3.1.0",
 	"devDependencies": {
-		"@fluid-tools/build-cli": "^0.13.1",
+		"@fluid-tools/build-cli": "^0.15.0",
 		"@fluidframework/build-common": "^1.1.0",
-		"@fluidframework/build-tools": "^0.13.1",
+		"@fluidframework/build-tools": "^0.15.0",
 		"@fluidframework/eslint-config-fluid": "^2.0.0",
+		"@fluidframework/protocol-base-previous": "npm:@fluidframework/protocol-base@0.1040.1000",
 		"@microsoft/api-extractor": "^7.34.4",
@@ -89,3 +92,10 @@ "@types/assert": "^1.5.1",
 		"typescript": "~4.5.5"
+	},
+	"typeValidation": {
+		"broken": {
+			"ClassDeclaration_ProtocolOpHandler": {
+				"backCompat": false
+			}
+		}
 	}
 }

src/packageVersion.ts

@@ -9,2 +9,2 @@ /*!
 export const pkgName = "@fluidframework/protocol-base";
-export const pkgVersion = "0.1040.1000";
+export const pkgVersion = "0.1041.1000-154635";

src/protocol.ts

@@ -21,2 +21,5 @@ /*!
 
+// "term" was an experimental feature that is being removed.  The only safe value to use is 1.
+export const OnlyValidTermValue = 1 as const;
+
 export interface IScribeProtocolState {
@@ -75,8 +78,5 @@ sequenceNumber: number;
 
-	public readonly term: number;
-
 	constructor(
 		public minimumSequenceNumber: number,
 		public sequenceNumber: number,
-		term: number | undefined,
 		members: [string, ISequencedClient][],
@@ -87,3 +87,2 @@ proposals: [number, ISequencedProposal, string[]][],
 	) {
-		this.term = term ?? 1;
 		this._quorum = new Quorum(members, proposals, values, sendProposal);
@@ -96,3 +95,3 @@ }
 			sequenceNumber: this.sequenceNumber,
-			term: this.term,
+			term: OnlyValidTermValue,
 		};
@@ -99,0 +98,0 @@ }

src/scribeHelper.ts

@@ -6,2 +6,3 @@ /*!
 
+import { ICreateTreeEntry, ITree } from "@fluidframework/gitresources";
 import {
@@ -13,10 +14,8 @@ IDocumentAttributes,
 } from "@fluidframework/protocol-definitions";
-import { ICreateTreeEntry, ITree } from "@fluidframework/gitresources";
+import { OnlyValidTermValue } from "./protocol";
 import { IQuorumSnapshot } from "./quorum";
 
 export function getQuorumTreeEntries(
-	documentId: string,
 	minimumSequenceNumber: number,
 	sequenceNumber: number,
-	term: number,
 	quorumSnapshot: IQuorumSnapshot,
@@ -27,3 +26,3 @@ ): ITreeEntry[] {
 		sequenceNumber,
-		term,
+		term: OnlyValidTermValue,
 	};
@@ -30,0 +29,0 @@

No alert changes

Improved metrics

Total package byte prevSize

248732

increased by0.32%

Lines of code

3273

increased by0.06%

Worsened metrics

Dev dependency count

17

increased by6.25%

Dependency changes

• + Added@fluidframework/gitresources@0.1041.1000-154635(transitive)

• - Removed@fluidframework/gitresources@0.1040.1000(transitive)

• Updated@fluidframework/gitresources@0.1041.1000-154635