@fluidframework/protocol-base - npm Package Compare versions

Comparing version 0.1041.1000-154635 to 1.0.0-169721

dist/index.d.ts

@@ -5,7 +5,5 @@ /*!
  */
-export { addBlobToTree, AttachmentTreeEntry, BlobTreeEntry, buildHierarchy, getGitMode, getGitType, TreeTreeEntry, } from "./blobs";
-export { ILocalSequencedClient, IProtocolHandler, IScribeProtocolState, isSystemMessage, ProtocolOpHandler, } from "./protocol";
+export { buildGitTreeHeirarchy, getGitMode, getGitType } from "./gitHelper";
+export { IProtocolHandler, IScribeProtocolState, ProtocolOpHandler } from "./protocol";
 export { IQuorumSnapshot, Quorum, QuorumClients, QuorumClientsSnapshot, QuorumProposals, QuorumProposalsSnapshot, } from "./quorum";
-export { generateServiceProtocolEntries, getQuorumTreeEntries, mergeAppAndProtocolTree, } from "./scribeHelper";
-export { isServiceMessageType } from "./utils";
 //# sourceMappingURL=index.d.ts.map

dist/index.js

@@ -7,13 +7,8 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isServiceMessageType = exports.mergeAppAndProtocolTree = exports.getQuorumTreeEntries = exports.generateServiceProtocolEntries = exports.QuorumProposals = exports.QuorumClients = exports.Quorum = exports.ProtocolOpHandler = exports.isSystemMessage = exports.TreeTreeEntry = exports.getGitType = exports.getGitMode = exports.buildHierarchy = exports.BlobTreeEntry = exports.AttachmentTreeEntry = exports.addBlobToTree = void 0;
-var blobs_1 = require("./blobs");
-Object.defineProperty(exports, "addBlobToTree", { enumerable: true, get: function () { return blobs_1.addBlobToTree; } });
-Object.defineProperty(exports, "AttachmentTreeEntry", { enumerable: true, get: function () { return blobs_1.AttachmentTreeEntry; } });
-Object.defineProperty(exports, "BlobTreeEntry", { enumerable: true, get: function () { return blobs_1.BlobTreeEntry; } });
-Object.defineProperty(exports, "buildHierarchy", { enumerable: true, get: function () { return blobs_1.buildHierarchy; } });
-Object.defineProperty(exports, "getGitMode", { enumerable: true, get: function () { return blobs_1.getGitMode; } });
-Object.defineProperty(exports, "getGitType", { enumerable: true, get: function () { return blobs_1.getGitType; } });
-Object.defineProperty(exports, "TreeTreeEntry", { enumerable: true, get: function () { return blobs_1.TreeTreeEntry; } });
+exports.QuorumProposals = exports.QuorumClients = exports.Quorum = exports.ProtocolOpHandler = exports.getGitType = exports.getGitMode = exports.buildGitTreeHeirarchy = void 0;
+var gitHelper_1 = require("./gitHelper");
+Object.defineProperty(exports, "buildGitTreeHeirarchy", { enumerable: true, get: function () { return gitHelper_1.buildGitTreeHeirarchy; } });
+Object.defineProperty(exports, "getGitMode", { enumerable: true, get: function () { return gitHelper_1.getGitMode; } });
+Object.defineProperty(exports, "getGitType", { enumerable: true, get: function () { return gitHelper_1.getGitType; } });
 var protocol_1 = require("./protocol");
-Object.defineProperty(exports, "isSystemMessage", { enumerable: true, get: function () { return protocol_1.isSystemMessage; } });
 Object.defineProperty(exports, "ProtocolOpHandler", { enumerable: true, get: function () { return protocol_1.ProtocolOpHandler; } });
@@ -24,8 +19,2 @@ var quorum_1 = require("./quorum");
 Object.defineProperty(exports, "QuorumProposals", { enumerable: true, get: function () { return quorum_1.QuorumProposals; } });
-var scribeHelper_1 = require("./scribeHelper");
-Object.defineProperty(exports, "generateServiceProtocolEntries", { enumerable: true, get: function () { return scribeHelper_1.generateServiceProtocolEntries; } });
-Object.defineProperty(exports, "getQuorumTreeEntries", { enumerable: true, get: function () { return scribeHelper_1.getQuorumTreeEntries; } });
-Object.defineProperty(exports, "mergeAppAndProtocolTree", { enumerable: true, get: function () { return scribeHelper_1.mergeAppAndProtocolTree; } });
-var utils_1 = require("./utils");
-Object.defineProperty(exports, "isServiceMessageType", { enumerable: true, get: function () { return utils_1.isServiceMessageType; } });
 //# sourceMappingURL=index.js.map

dist/protocol.d.ts

@@ -15,9 +15,2 @@ /*!
 }
-export declare function isSystemMessage(message: ISequencedDocumentMessage): boolean;
-export interface ILocalSequencedClient extends ISequencedClient {
-    /**
-     * True if the client should have left the quorum, false otherwise
-     */
-    shouldHaveLeft?: boolean;
-}
 export interface IProtocolHandler {
@@ -24,0 +17,0 @@ readonly quorum: IQuorum;

dist/protocol.js

@@ -7,3 +7,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProtocolOpHandler = exports.isSystemMessage = exports.OnlyValidTermValue = void 0;
+exports.ProtocolOpHandler = exports.OnlyValidTermValue = void 0;
 const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
@@ -13,19 +13,2 @@ const quorum_1 = require("./quorum");
 exports.OnlyValidTermValue = 1;
-function isSystemMessage(message) {
-    switch (message.type) {
-        case protocol_definitions_1.MessageType.ClientJoin:
-        case protocol_definitions_1.MessageType.ClientLeave:
-        case protocol_definitions_1.MessageType.Propose:
-        case protocol_definitions_1.MessageType.Reject:
-        case protocol_definitions_1.MessageType.NoOp:
-        case protocol_definitions_1.MessageType.NoClient:
-        case protocol_definitions_1.MessageType.Summarize:
-        case protocol_definitions_1.MessageType.SummaryAck:
-        case protocol_definitions_1.MessageType.SummaryNack:
-            return true;
-        default:
-            return false;
-    }
-}
-exports.isSystemMessage = isSystemMessage;
 /**
@@ -32,0 +15,0 @@ * Handles protocol specific ops.

lib/index.d.ts

@@ -5,7 +5,5 @@ /*!
  */
-export { addBlobToTree, AttachmentTreeEntry, BlobTreeEntry, buildHierarchy, getGitMode, getGitType, TreeTreeEntry, } from "./blobs";
-export { ILocalSequencedClient, IProtocolHandler, IScribeProtocolState, isSystemMessage, ProtocolOpHandler, } from "./protocol";
+export { buildGitTreeHeirarchy, getGitMode, getGitType } from "./gitHelper";
+export { IProtocolHandler, IScribeProtocolState, ProtocolOpHandler } from "./protocol";
 export { IQuorumSnapshot, Quorum, QuorumClients, QuorumClientsSnapshot, QuorumProposals, QuorumProposalsSnapshot, } from "./quorum";
-export { generateServiceProtocolEntries, getQuorumTreeEntries, mergeAppAndProtocolTree, } from "./scribeHelper";
-export { isServiceMessageType } from "./utils";
 //# sourceMappingURL=index.d.ts.map

lib/index.js

@@ -5,7 +5,5 @@ /*!
  */
-export { addBlobToTree, AttachmentTreeEntry, BlobTreeEntry, buildHierarchy, getGitMode, getGitType, TreeTreeEntry, } from "./blobs";
-export { isSystemMessage, ProtocolOpHandler, } from "./protocol";
+export { buildGitTreeHeirarchy, getGitMode, getGitType } from "./gitHelper";
+export { ProtocolOpHandler } from "./protocol";
 export { Quorum, QuorumClients, QuorumProposals, } from "./quorum";
-export { generateServiceProtocolEntries, getQuorumTreeEntries, mergeAppAndProtocolTree, } from "./scribeHelper";
-export { isServiceMessageType } from "./utils";
 //# sourceMappingURL=index.js.map

lib/protocol.d.ts

@@ -15,9 +15,2 @@ /*!
 }
-export declare function isSystemMessage(message: ISequencedDocumentMessage): boolean;
-export interface ILocalSequencedClient extends ISequencedClient {
-    /**
-     * True if the client should have left the quorum, false otherwise
-     */
-    shouldHaveLeft?: boolean;
-}
 export interface IProtocolHandler {
@@ -24,0 +17,0 @@ readonly quorum: IQuorum;

lib/protocol.js

@@ -9,18 +9,2 @@ /*!
 export const OnlyValidTermValue = 1;
-export function isSystemMessage(message) {
-    switch (message.type) {
-        case MessageType.ClientJoin:
-        case MessageType.ClientLeave:
-        case MessageType.Propose:
-        case MessageType.Reject:
-        case MessageType.NoOp:
-        case MessageType.NoClient:
-        case MessageType.Summarize:
-        case MessageType.SummaryAck:
-        case MessageType.SummaryNack:
-            return true;
-        default:
-            return false;
-    }
-}
 /**
@@ -27,0 +11,0 @@ * Handles protocol specific ops.

package.json

 {
 	"name": "@fluidframework/protocol-base",
-	"version": "0.1041.1000-154635",
+	"version": "1.0.0-169721",
 	"description": "Fluid protocol base",
@@ -18,3 +18,3 @@ "homepage": "https://fluidframework.com",
 	"scripts": {
-		"build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
+		"build": "concurrently npm:build:compile npm:lint && npm run build:docs",
 		"build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
@@ -24,5 +24,2 @@ "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
 		"build:esnext": "tsc --project ./tsconfig.esnext.json",
-		"build:full": "npm run build",
-		"build:full:compile": "npm run build:compile",
-		"build:genver": "gen-version",
 		"build:test": "tsc --project ./src/test/tsconfig.json",
@@ -67,11 +64,10 @@ "ci:build:docs": "api-extractor run",
 		"@fluidframework/common-utils": "^1.1.1",
-		"@fluidframework/gitresources": "0.1041.1000-154635",
+		"@fluidframework/gitresources": "1.0.0-169721",
 		"@fluidframework/protocol-definitions": "^1.1.0",
-		"events": "^3.1.0",
-		"lodash": "^4.17.21"
+		"events": "^3.1.0"
 	},
 	"devDependencies": {
-		"@fluid-tools/build-cli": "^0.15.0",
-		"@fluidframework/build-common": "^1.1.0",
-		"@fluidframework/build-tools": "^0.15.0",
+		"@fluid-tools/build-cli": "^0.19.0-165129",
+		"@fluidframework/build-common": "^1.2.0",
+		"@fluidframework/build-tools": "^0.19.0-165129",
 		"@fluidframework/eslint-config-fluid": "^2.0.0",
@@ -96,2 +92,46 @@ "@fluidframework/protocol-base-previous": "npm:@fluidframework/protocol-base@0.1040.1000",
 				"backCompat": false
+			},
+			"RemovedVariableDeclaration_isServiceMessageType": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedFunctionDeclaration_generateServiceProtocolEntries": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedFunctionDeclaration_getQuorumTreeEntries": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedFunctionDeclaration_mergeAppAndProtocolTree": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedFunctionDeclaration_addBlobToTree": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedFunctionDeclaration_buildHierarchy": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedFunctionDeclaration_isSystemMessage": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedInterfaceDeclaration_ILocalSequencedClient": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedClassDeclaration_AttachmentTreeEntry": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedClassDeclaration_BlobTreeEntry": {
+				"forwardCompat": false,
+				"backCompat": false
+			},
+			"RemovedClassDeclaration_TreeTreeEntry": {
+				"forwardCompat": false,
+				"backCompat": false
 			}
@@ -98,0 +138,0 @@ }

README.md

 # @fluidframework/protocol-base
 
-Shared protocol code for client and service to share. Manages the lifetime of Quorum and proposals that needs to be
-consistent across client and service. It also provides utilities for facilitating summary creation.
+## Purpose
 
+The purpose of @fluidframework/protocol-base is:
+
+1. Manage the lifetime of Quorum and proposals that needs to be consistent across client and service.
+1. Manage git implementation which takes in a summary object and returns it mode/type.
+
 ## Quorum and Proposal
@@ -7,0 +11,0 @@

src/index.ts

@@ -6,19 +6,5 @@ /*!
 
+export { buildGitTreeHeirarchy, getGitMode, getGitType } from "./gitHelper";
+export { IProtocolHandler, IScribeProtocolState, ProtocolOpHandler } from "./protocol";
 export {
-	addBlobToTree,
-	AttachmentTreeEntry,
-	BlobTreeEntry,
-	buildHierarchy,
-	getGitMode,
-	getGitType,
-	TreeTreeEntry,
-} from "./blobs";
-export {
-	ILocalSequencedClient,
-	IProtocolHandler,
-	IScribeProtocolState,
-	isSystemMessage,
-	ProtocolOpHandler,
-} from "./protocol";
-export {
 	IQuorumSnapshot,
@@ -31,7 +17,1 @@ Quorum,
 } from "./quorum";
-export {
-	generateServiceProtocolEntries,
-	getQuorumTreeEntries,
-	mergeAppAndProtocolTree,
-} from "./scribeHelper";
-export { isServiceMessageType } from "./utils";

src/protocol.ts

@@ -32,26 +32,2 @@ /*!
 
-export function isSystemMessage(message: ISequencedDocumentMessage) {
-	switch (message.type) {
-		case MessageType.ClientJoin:
-		case MessageType.ClientLeave:
-		case MessageType.Propose:
-		case MessageType.Reject:
-		case MessageType.NoOp:
-		case MessageType.NoClient:
-		case MessageType.Summarize:
-		case MessageType.SummaryAck:
-		case MessageType.SummaryNack:
-			return true;
-		default:
-			return false;
-	}
-}
-
-export interface ILocalSequencedClient extends ISequencedClient {
-	/**
-	 * True if the client should have left the quorum, false otherwise
-	 */
-	shouldHaveLeft?: boolean;
-}
-
 export interface IProtocolHandler {
@@ -58,0 +34,0 @@ readonly quorum: IQuorum;

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

Dependency count

4

decreased by-20%

Number of lines in readme file

18

increased by28.57%

Worsened metrics

Total package byte prevSize

195027

decreased by-21.59%

Number of package files

44

decreased by-38.03%

Lines of code

2416

decreased by-26.18%

Dependency changes

• + Added@fluidframework/gitresources@1.0.0-169721(transitive)

• - Removedlodash@^4.17.21

• - Removed@fluidframework/gitresources@0.1041.1000-154635(transitive)

• Updated@fluidframework/gitresources@1.0.0-169721