@fluidframework/protocol-base - npm Package Compare versions

Comparing version 3.0.0-211732 to 3.0.0-220558

api-extractor.json

 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-common-report.json",
-	"apiReport": {
-		"enabled": true,
-		"reportFolder": "<projectFolder>/../../api-report/"
-	},
-	"docModel": {
-		"enabled": true,
-		"apiJsonFilePath": "<projectFolder>/../../_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
+	"extends": "../../api-extractor-build-base.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: Add missing documentation and remove this rule override
+			"ae-undocumented": {
+				"logLevel": "none"
+			}
+		}
 	}
 }

dist/gitHelper.d.ts

@@ -12,2 +12,3 @@ /*!
  * @returns the git mode of summary object
+ * @internal
  */
@@ -20,2 +21,3 @@ export declare function getGitMode(value: SummaryObject): string;
  * @returns the type of summary object
+ * @internal
  */
@@ -31,4 +33,5 @@ export declare function getGitType(value: SummaryObject): "blob" | "tree";
  * @returns the hierarchical tree
+ * @internal
  */
 export declare function buildGitTreeHierarchy(flatTree: git.ITree, blobsShaToPathCache?: Map<string, string>, removeAppTreePrefix?: boolean): ISnapshotTreeEx;
 //# sourceMappingURL=gitHelper.d.ts.map

dist/gitHelper.js

@@ -11,2 +11,3 @@ "use strict";
  * @returns the git mode of summary object
+ * @internal
  */
@@ -31,2 +32,3 @@ function getGitMode(value) {
  * @returns the type of summary object
+ * @internal
  */
@@ -54,2 +56,3 @@ function getGitType(value) {
  * @returns the hierarchical tree
+ * @internal
  */
@@ -56,0 +59,0 @@ function buildGitTreeHierarchy(flatTree, blobsShaToPathCache = new Map(), removeAppTreePrefix = false) {

dist/protocol.d.ts

@@ -7,2 +7,5 @@ /*!
 import { IQuorumSnapshot, Quorum } from "./quorum";
+/**
+ * @internal
+ */
 export interface IScribeProtocolState {
@@ -15,2 +18,5 @@ sequenceNumber: number;
 }
+/**
+ * @internal
+ */
 export interface IProtocolHandler {
@@ -27,2 +33,3 @@ readonly quorum: IQuorum;
  * Handles protocol specific ops.
+ * @internal
  */
@@ -29,0 +36,0 @@ export declare class ProtocolOpHandler implements IProtocolHandler {

dist/protocol.js

@@ -12,2 +12,3 @@ "use strict";
  * Handles protocol specific ops.
+ * @internal
  */
@@ -14,0 +15,0 @@ class ProtocolOpHandler {

dist/quorum.d.ts

@@ -6,5 +6,6 @@ /*!
 import { TypedEventEmitter } from "@fluidframework/common-utils";
-import { ICommittedProposal, IQuorum, IQuorumClients, IQuorumClientsEvents, IQuorumEvents, IQuorumProposals, IQuorumProposalsEvents, ISequencedClient, ISequencedDocumentMessage, ISequencedProposal } from "@fluidframework/protocol-definitions";
+import { ICommittedProposal, IQuorum, IQuorumClients, IQuorumProposals, ISequencedClient, ISequencedDocumentMessage, ISequencedProposal } from "@fluidframework/protocol-definitions";
 /**
  * Snapshot format for a QuorumClients
+ * @alpha
  */
@@ -14,2 +15,3 @@ export declare type QuorumClientsSnapshot = [string, ISequencedClient][];
  * Snapshot format for a QuorumProposals
+ * @alpha
  */
@@ -22,2 +24,3 @@ export declare type QuorumProposalsSnapshot = {
  * Snapshot format for a Quorum
+ * @alpha
  */
@@ -31,4 +34,5 @@ export interface IQuorumSnapshot {
  * The QuorumClients is used to track members joining and leaving the collaboration session.
+ * @internal
  */
-export declare class QuorumClients extends TypedEventEmitter<IQuorumClientsEvents> implements IQuorumClients {
+export declare class QuorumClients extends TypedEventEmitter<IQuorumClients["on"]> implements IQuorumClients {
     private readonly members;
@@ -69,4 +73,5 @@ private isDisposed;
  * clients have seen the proposal.
+ * @internal
  */
-export declare class QuorumProposals extends TypedEventEmitter<IQuorumProposalsEvents> implements IQuorumProposals {
+export declare class QuorumProposals extends TypedEventEmitter<IQuorumProposals["on"]> implements IQuorumProposals {
     private readonly sendProposal;
@@ -124,4 +129,5 @@ private readonly proposals;
  * they have agreed upon and any pending proposals.
+ * @internal
  */
-export declare class Quorum extends TypedEventEmitter<IQuorumEvents> implements IQuorum {
+export declare class Quorum extends TypedEventEmitter<IQuorum["on"]> implements IQuorum {
     private readonly quorumClients;
@@ -128,0 +134,0 @@ private readonly quorumProposals;

dist/quorum.js

@@ -23,2 +23,3 @@ "use strict";
  * The QuorumClients is used to track members joining and leaving the collaboration session.
+ * @internal
  */
@@ -85,2 +86,3 @@ class QuorumClients extends common_utils_1.TypedEventEmitter {
  * clients have seen the proposal.
+ * @internal
  */
@@ -303,2 +305,3 @@ class QuorumProposals extends common_utils_1.TypedEventEmitter {
  * they have agreed upon and any pending proposals.
+ * @internal
  */
@@ -305,0 +308,0 @@ class Quorum extends common_utils_1.TypedEventEmitter {

lib/gitHelper.d.ts

@@ -12,2 +12,3 @@ /*!
  * @returns the git mode of summary object
+ * @internal
  */
@@ -20,2 +21,3 @@ export declare function getGitMode(value: SummaryObject): string;
  * @returns the type of summary object
+ * @internal
  */
@@ -31,4 +33,5 @@ export declare function getGitType(value: SummaryObject): "blob" | "tree";
  * @returns the hierarchical tree
+ * @internal
  */
 export declare function buildGitTreeHierarchy(flatTree: git.ITree, blobsShaToPathCache?: Map<string, string>, removeAppTreePrefix?: boolean): ISnapshotTreeEx;
 //# sourceMappingURL=gitHelper.d.ts.map

lib/gitHelper.js

@@ -8,2 +8,3 @@ import { FileMode, SummaryType, } from "@fluidframework/protocol-definitions";
  * @returns the git mode of summary object
+ * @internal
  */
@@ -27,2 +28,3 @@ export function getGitMode(value) {
  * @returns the type of summary object
+ * @internal
  */
@@ -49,2 +51,3 @@ export function getGitType(value) {
  * @returns the hierarchical tree
+ * @internal
  */
@@ -51,0 +54,0 @@ export function buildGitTreeHierarchy(flatTree, blobsShaToPathCache = new Map(), removeAppTreePrefix = false) {

lib/protocol.d.ts

@@ -7,2 +7,5 @@ /*!
 import { IQuorumSnapshot, Quorum } from "./quorum";
+/**
+ * @internal
+ */
 export interface IScribeProtocolState {
@@ -15,2 +18,5 @@ sequenceNumber: number;
 }
+/**
+ * @internal
+ */
 export interface IProtocolHandler {
@@ -27,2 +33,3 @@ readonly quorum: IQuorum;
  * Handles protocol specific ops.
+ * @internal
  */
@@ -29,0 +36,0 @@ export declare class ProtocolOpHandler implements IProtocolHandler {

lib/protocol.js

@@ -9,2 +9,3 @@ /*!
  * Handles protocol specific ops.
+ * @internal
  */
@@ -11,0 +12,0 @@ export class ProtocolOpHandler {

lib/quorum.d.ts

@@ -6,5 +6,6 @@ /*!
 import { TypedEventEmitter } from "@fluidframework/common-utils";
-import { ICommittedProposal, IQuorum, IQuorumClients, IQuorumClientsEvents, IQuorumEvents, IQuorumProposals, IQuorumProposalsEvents, ISequencedClient, ISequencedDocumentMessage, ISequencedProposal } from "@fluidframework/protocol-definitions";
+import { ICommittedProposal, IQuorum, IQuorumClients, IQuorumProposals, ISequencedClient, ISequencedDocumentMessage, ISequencedProposal } from "@fluidframework/protocol-definitions";
 /**
  * Snapshot format for a QuorumClients
+ * @alpha
  */
@@ -14,2 +15,3 @@ export declare type QuorumClientsSnapshot = [string, ISequencedClient][];
  * Snapshot format for a QuorumProposals
+ * @alpha
  */
@@ -22,2 +24,3 @@ export declare type QuorumProposalsSnapshot = {
  * Snapshot format for a Quorum
+ * @alpha
  */
@@ -31,4 +34,5 @@ export interface IQuorumSnapshot {
  * The QuorumClients is used to track members joining and leaving the collaboration session.
+ * @internal
  */
-export declare class QuorumClients extends TypedEventEmitter<IQuorumClientsEvents> implements IQuorumClients {
+export declare class QuorumClients extends TypedEventEmitter<IQuorumClients["on"]> implements IQuorumClients {
     private readonly members;
@@ -69,4 +73,5 @@ private isDisposed;
  * clients have seen the proposal.
+ * @internal
  */
-export declare class QuorumProposals extends TypedEventEmitter<IQuorumProposalsEvents> implements IQuorumProposals {
+export declare class QuorumProposals extends TypedEventEmitter<IQuorumProposals["on"]> implements IQuorumProposals {
     private readonly sendProposal;
@@ -124,4 +129,5 @@ private readonly proposals;
  * they have agreed upon and any pending proposals.
+ * @internal
  */
-export declare class Quorum extends TypedEventEmitter<IQuorumEvents> implements IQuorum {
+export declare class Quorum extends TypedEventEmitter<IQuorum["on"]> implements IQuorum {
     private readonly quorumClients;
@@ -128,0 +134,0 @@ private readonly quorumProposals;

lib/quorum.js

@@ -20,2 +20,3 @@ /*!
  * The QuorumClients is used to track members joining and leaving the collaboration session.
+ * @internal
  */
@@ -81,2 +82,3 @@ export class QuorumClients extends TypedEventEmitter {
  * clients have seen the proposal.
+ * @internal
  */
@@ -298,2 +300,3 @@ export class QuorumProposals extends TypedEventEmitter {
  * they have agreed upon and any pending proposals.
+ * @internal
  */
@@ -300,0 +303,0 @@ export class Quorum extends TypedEventEmitter {

package.json

 {
 	"name": "@fluidframework/protocol-base",
-	"version": "3.0.0-211732",
+	"version": "3.0.0-220558",
 	"description": "Fluid protocol base",
@@ -24,2 +24,3 @@ "homepage": "https://fluidframework.com",
 		"build:test": "tsc --project ./src/test/tsconfig.json",
+		"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
 		"ci:build:docs": "api-extractor run",
@@ -30,6 +31,6 @@ "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
 		"format": "npm run prettier:fix",
-		"lint": "npm run prettier && npm run eslint",
+		"lint": "npm run prettier && npm run check:release-tags && 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",
+		"prettier": "prettier --check . --cache --ignore-path ../../.prettierignore",
+		"prettier:fix": "prettier --write . --cache --ignore-path ../../.prettierignore",
 		"test": "mocha --recursive \"dist/test/*.spec.js\"",
@@ -64,3 +65,3 @@ "test:coverage": "c8 npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
 		"@fluidframework/common-utils": "^3.0.0",
-		"@fluidframework/gitresources": "3.0.0-211732",
+		"@fluidframework/gitresources": "3.0.0-220558",
 		"@fluidframework/protocol-definitions": "^3.0.0",
@@ -67,0 +68,0 @@ "events": "^3.1.0"

src/gitHelper.ts

@@ -19,2 +19,3 @@ /*!
  * @returns the git mode of summary object
+ * @internal
  */
@@ -39,2 +40,3 @@ export function getGitMode(value: SummaryObject): string {
  * @returns the type of summary object
+ * @internal
  */
@@ -63,2 +65,3 @@ export function getGitType(value: SummaryObject): "blob" | "tree" {
  * @returns the hierarchical tree
+ * @internal
  */
@@ -65,0 +68,0 @@ export function buildGitTreeHierarchy(

src/protocol.ts

@@ -21,2 +21,5 @@ /*!
 
+/**
+ * @internal
+ */
 export interface IScribeProtocolState {
@@ -30,2 +33,5 @@ sequenceNumber: number;
 
+/**
+ * @internal
+ */
 export interface IProtocolHandler {
@@ -45,2 +51,3 @@ readonly quorum: IQuorum;
  * Handles protocol specific ops.
+ * @internal
  */
@@ -47,0 +54,0 @@ export class ProtocolOpHandler implements IProtocolHandler {

src/quorum.ts

@@ -13,6 +13,3 @@ /*!
 	IQuorumClients,
-	IQuorumClientsEvents,
-	IQuorumEvents,
 	IQuorumProposals,
-	IQuorumProposalsEvents,
 	ISequencedClient,
@@ -37,2 +34,3 @@ ISequencedDocumentMessage,
  * Snapshot format for a QuorumClients
+ * @alpha
  */
@@ -43,2 +41,3 @@ export type QuorumClientsSnapshot = [string, ISequencedClient][];
  * Snapshot format for a QuorumProposals
+ * @alpha
  */
@@ -53,2 +52,3 @@ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
  * Snapshot format for a Quorum
+ * @alpha
  */
@@ -63,5 +63,6 @@ export interface IQuorumSnapshot {
  * The QuorumClients is used to track members joining and leaving the collaboration session.
+ * @internal
  */
 export class QuorumClients
-	extends TypedEventEmitter<IQuorumClientsEvents>
+	extends TypedEventEmitter<IQuorumClients["on"]>
 	implements IQuorumClients
@@ -146,5 +147,6 @@ {
  * clients have seen the proposal.
+ * @internal
  */
 export class QuorumProposals
-	extends TypedEventEmitter<IQuorumProposalsEvents>
+	extends TypedEventEmitter<IQuorumProposals["on"]>
 	implements IQuorumProposals
@@ -440,4 +442,5 @@ {
  * they have agreed upon and any pending proposals.
+ * @internal
  */
-export class Quorum extends TypedEventEmitter<IQuorumEvents> implements IQuorum {
+export class Quorum extends TypedEventEmitter<IQuorum["on"]> implements IQuorum {
 	private readonly quorumClients: QuorumClients;
@@ -444,0 +447,0 @@ private readonly quorumProposals: QuorumProposals;

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

205833

increased by3.81%

Number of package files

46

increased by4.55%

Lines of code

2548

increased by2.91%

Dependency changes

• + Added@fluidframework/gitresources@3.0.0-220558(transitive)

• - Removed@fluidframework/gitresources@3.0.0-211732(transitive)

• Updated@fluidframework/gitresources@3.0.0-220558