@fluidframework/protocol-definitions - npm Package Compare versions

Comparing version 0.1025.0-24612 to 0.1025.0-35619

api-extractor.json

@@ -6,8 +6,8 @@ {
     "enabled": true,
-    "reportFolder": "<projectFolder>/../../api-report/"
+    "reportFolder": "<projectFolder>/api-report/"
   },
   "docModel": {
     "enabled": true,
-    "apiJsonFilePath": "<projectFolder>/../../_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
+    "apiJsonFilePath": "<projectFolder>/_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
   }
 }

dist/clients.d.ts

@@ -22,2 +22,6 @@ /*!
     scopes: string[];
+    /**
+     * The time the client connected
+     */
+    timestamp?: number;
 }
@@ -24,0 +28,0 @@ export interface ISequencedClient {

dist/consensus.d.ts

@@ -53,5 +53,13 @@ /*!
 }
-export interface IQuorumEvents extends IErrorEvent {
+/**
+ * Events fired by a Quorum in response to client tracking.
+ */
+export interface IQuorumClientsEvents extends IErrorEvent {
     (event: "addMember", listener: (clientId: string, details: ISequencedClient) => void): any;
     (event: "removeMember", listener: (clientId: string) => void): any;
+}
+/**
+ * Events fired by a Quorum in response to proposal tracking.
+ */
+export interface IQuorumProposalsEvents extends IErrorEvent {
     (event: "addProposal", listener: (proposal: IPendingProposal) => void): any;
@@ -63,5 +71,16 @@ (event: "approveProposal", listener: (sequenceNumber: number, key: string, value: any, approvalSequenceNumber: number) => void): any;
 /**
- * Class representing agreed upon values in a quorum
+ * All events fired by an IQuorum, both client tracking and proposal tracking.
  */
-export interface IQuorum extends IEventProvider<IQuorumEvents>, IDisposable {
+export declare type IQuorumEvents = IQuorumClientsEvents & IQuorumProposalsEvents;
+/**
+ * Interface for tracking clients in the Quorum.
+ */
+export interface IQuorumClients extends IEventProvider<IQuorumClientsEvents>, IDisposable {
+    getMembers(): Map<string, ISequencedClient>;
+    getMember(clientId: string): ISequencedClient | undefined;
+}
+/**
+ * Interface for tracking proposals in the Quorum.
+ */
+export interface IQuorumProposals extends IEventProvider<IQuorumProposalsEvents>, IDisposable {
     propose(key: string, value: any): Promise<void>;
@@ -71,5 +90,8 @@ has(key: string): boolean;
     getApprovalData(key: string): ICommittedProposal | undefined;
-    getMembers(): Map<string, ISequencedClient>;
-    getMember(clientId: string): ISequencedClient | undefined;
 }
+/**
+ * Interface combining tracking of clients as well as proposals in the Quorum.
+ */
+export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off">, IEventProvider<IQuorumEvents> {
+}
 export interface IProtocolState {
@@ -76,0 +98,0 @@ sequenceNumber: number;

dist/protocol.d.ts

@@ -77,2 +77,7 @@ /*!
     timestamp: number;
+    /**
+     * Experimental field for storing the rolling hash at sequence number.
+     * @alpha
+     */
+    expHash1?: string;
 }
@@ -134,3 +139,3 @@ export interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessage {
  */
-export interface ISummaryNack extends IServerError {
+export interface ISummaryNack {
     /**
@@ -140,2 +145,24 @@ * Information about the proposed summary op.
     summaryProposal: ISummaryProposal;
+    /**
+     * Message describing the error.
+     * @deprecated - Use "message" instead. Clients should check for message ?? errorMessage.
+     * Once all servers & clients are all updated, we can remove that errorMessage property
+     */
+    errorMessage: string;
+    /**
+     * An error code number that represents the error. It will be a valid HTTP error code.
+     * 403 errors are non retryable.
+     * 400 errors are always immediately retriable.
+     * 429 errors are retriable or non retriable (depends on type field).
+     */
+    code?: number;
+    /**
+     * A message about the error for debugging/logging/telemetry purposes
+     */
+    message?: string;
+    /**
+     * Optional Retry-After time in seconds.
+     * If specified, the client should wait this many seconds before retrying.8
+     */
+    retryAfter?: number;
 }
@@ -142,0 +169,0 @@ /**

dist/sockets.d.ts

@@ -46,2 +46,8 @@ /*!
     epoch?: string;
+    /**
+     * A list of optional features that client supports.
+     * Features supported might be service specific.
+     * If we have standardized features across all services, they need to be exposed in more structured way.
+     */
+    supportedFeatures?: Record<string, any>;
 }
@@ -112,3 +118,13 @@ /**
     epoch?: string;
+    /**
+     * A list of optional features that ordering service supports.
+     * Features supported might be service specific.
+     * If we have standardized features across all services, they need to be exposed in more structured way.
+     */
+    supportedFeatures?: Record<string, any>;
+    /**
+     * The time the client connected
+     */
+    timestamp?: number;
 }
 //# sourceMappingURL=sockets.d.ts.map

dist/storage.d.ts

@@ -42,3 +42,2 @@ /*!
     id: string;
-    url: string;
 }
@@ -45,0 +44,0 @@ /**

lib/clients.d.ts

@@ -22,2 +22,6 @@ /*!
     scopes: string[];
+    /**
+     * The time the client connected
+     */
+    timestamp?: number;
 }
@@ -24,0 +28,0 @@ export interface ISequencedClient {

lib/consensus.d.ts

@@ -53,5 +53,13 @@ /*!
 }
-export interface IQuorumEvents extends IErrorEvent {
+/**
+ * Events fired by a Quorum in response to client tracking.
+ */
+export interface IQuorumClientsEvents extends IErrorEvent {
     (event: "addMember", listener: (clientId: string, details: ISequencedClient) => void): any;
     (event: "removeMember", listener: (clientId: string) => void): any;
+}
+/**
+ * Events fired by a Quorum in response to proposal tracking.
+ */
+export interface IQuorumProposalsEvents extends IErrorEvent {
     (event: "addProposal", listener: (proposal: IPendingProposal) => void): any;
@@ -63,5 +71,16 @@ (event: "approveProposal", listener: (sequenceNumber: number, key: string, value: any, approvalSequenceNumber: number) => void): any;
 /**
- * Class representing agreed upon values in a quorum
+ * All events fired by an IQuorum, both client tracking and proposal tracking.
  */
-export interface IQuorum extends IEventProvider<IQuorumEvents>, IDisposable {
+export declare type IQuorumEvents = IQuorumClientsEvents & IQuorumProposalsEvents;
+/**
+ * Interface for tracking clients in the Quorum.
+ */
+export interface IQuorumClients extends IEventProvider<IQuorumClientsEvents>, IDisposable {
+    getMembers(): Map<string, ISequencedClient>;
+    getMember(clientId: string): ISequencedClient | undefined;
+}
+/**
+ * Interface for tracking proposals in the Quorum.
+ */
+export interface IQuorumProposals extends IEventProvider<IQuorumProposalsEvents>, IDisposable {
     propose(key: string, value: any): Promise<void>;
@@ -71,5 +90,8 @@ has(key: string): boolean;
     getApprovalData(key: string): ICommittedProposal | undefined;
-    getMembers(): Map<string, ISequencedClient>;
-    getMember(clientId: string): ISequencedClient | undefined;
 }
+/**
+ * Interface combining tracking of clients as well as proposals in the Quorum.
+ */
+export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off">, IEventProvider<IQuorumEvents> {
+}
 export interface IProtocolState {
@@ -76,0 +98,0 @@ sequenceNumber: number;

lib/protocol.d.ts

@@ -77,2 +77,7 @@ /*!
     timestamp: number;
+    /**
+     * Experimental field for storing the rolling hash at sequence number.
+     * @alpha
+     */
+    expHash1?: string;
 }
@@ -134,3 +139,3 @@ export interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessage {
  */
-export interface ISummaryNack extends IServerError {
+export interface ISummaryNack {
     /**
@@ -140,2 +145,24 @@ * Information about the proposed summary op.
     summaryProposal: ISummaryProposal;
+    /**
+     * Message describing the error.
+     * @deprecated - Use "message" instead. Clients should check for message ?? errorMessage.
+     * Once all servers & clients are all updated, we can remove that errorMessage property
+     */
+    errorMessage: string;
+    /**
+     * An error code number that represents the error. It will be a valid HTTP error code.
+     * 403 errors are non retryable.
+     * 400 errors are always immediately retriable.
+     * 429 errors are retriable or non retriable (depends on type field).
+     */
+    code?: number;
+    /**
+     * A message about the error for debugging/logging/telemetry purposes
+     */
+    message?: string;
+    /**
+     * Optional Retry-After time in seconds.
+     * If specified, the client should wait this many seconds before retrying.8
+     */
+    retryAfter?: number;
 }
@@ -142,0 +169,0 @@ /**

lib/sockets.d.ts

@@ -46,2 +46,8 @@ /*!
     epoch?: string;
+    /**
+     * A list of optional features that client supports.
+     * Features supported might be service specific.
+     * If we have standardized features across all services, they need to be exposed in more structured way.
+     */
+    supportedFeatures?: Record<string, any>;
 }
@@ -112,3 +118,13 @@ /**
     epoch?: string;
+    /**
+     * A list of optional features that ordering service supports.
+     * Features supported might be service specific.
+     * If we have standardized features across all services, they need to be exposed in more structured way.
+     */
+    supportedFeatures?: Record<string, any>;
+    /**
+     * The time the client connected
+     */
+    timestamp?: number;
 }
 //# sourceMappingURL=sockets.d.ts.map

lib/storage.d.ts

@@ -42,3 +42,2 @@ /*!
     id: string;
-    url: string;
 }
@@ -45,0 +44,0 @@ /**

package.json

 {
   "name": "@fluidframework/protocol-definitions",
-  "version": "0.1025.0-24612",
+  "version": "0.1025.0-35619",
   "description": "Fluid protocol definitions",
@@ -16,7 +16,10 @@ "homepage": "https://fluidframework.com",
     "build:compile": "concurrently npm:tsc npm:build:esnext",
-    "build:docs": "api-extractor run --local && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../_api-extractor-temp/",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ./node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:full": "npm run build",
     "build:full:compile": "npm run build:compile",
-    "ci:build:docs": "api-extractor run",
+    "ci:build": "npm run build:compile",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ./node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "ci:test": "echo No test for this package",
+    "ci:test:coverage": "echo No test for this package",
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
@@ -33,8 +36,8 @@ "eslint": "eslint --format stylish src",
   "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.0-0"
+    "@fluidframework/common-definitions": "^0.20.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.22.0-0",
+    "@fluidframework/build-common": "^0.22.0",
     "@fluidframework/eslint-config-fluid": "^0.23.0",
-    "@microsoft/api-extractor": "^7.13.1",
+    "@microsoft/api-extractor": "^7.16.1",
     "@typescript-eslint/eslint-plugin": "~4.14.0",
@@ -41,0 +44,0 @@ "@typescript-eslint/parser": "~4.14.0",

src/clients.ts

@@ -26,2 +26,7 @@ /*!
     scopes: string[];
+
+    /**
+     * The time the client connected
+     */
+    timestamp?: number;
 }
@@ -28,0 +33,0 @@

src/consensus.ts

@@ -59,5 +59,14 @@ /*!
 
-export interface IQuorumEvents extends IErrorEvent {
+/**
+ * Events fired by a Quorum in response to client tracking.
+ */
+export interface IQuorumClientsEvents extends IErrorEvent {
     (event: "addMember", listener: (clientId: string, details: ISequencedClient) => void);
     (event: "removeMember", listener: (clientId: string) => void);
+}
+
+/**
+ * Events fired by a Quorum in response to proposal tracking.
+ */
+export interface IQuorumProposalsEvents extends IErrorEvent {
     (event: "addProposal", listener: (proposal: IPendingProposal) => void);
@@ -81,5 +90,19 @@ (
 /**
- * Class representing agreed upon values in a quorum
+ * All events fired by an IQuorum, both client tracking and proposal tracking.
  */
-export interface IQuorum extends IEventProvider<IQuorumEvents>, IDisposable {
+export type IQuorumEvents = IQuorumClientsEvents & IQuorumProposalsEvents;
+
+/**
+ * Interface for tracking clients in the Quorum.
+ */
+export interface IQuorumClients extends IEventProvider<IQuorumClientsEvents>, IDisposable {
+    getMembers(): Map<string, ISequencedClient>;
+
+    getMember(clientId: string): ISequencedClient | undefined;
+}
+
+/**
+ * Interface for tracking proposals in the Quorum.
+ */
+export interface IQuorumProposals extends IEventProvider<IQuorumProposalsEvents>, IDisposable {
     propose(key: string, value: any): Promise<void>;
@@ -92,8 +115,12 @@
     getApprovalData(key: string): ICommittedProposal | undefined;
+}
 
-    getMembers(): Map<string, ISequencedClient>;
+/**
+ * Interface combining tracking of clients as well as proposals in the Quorum.
+ */
+export interface IQuorum extends
+    Omit<IQuorumClients, "on" | "once" | "off">,
+    Omit<IQuorumProposals, "on" | "once" | "off">,
+    IEventProvider<IQuorumEvents> { }
 
-    getMember(clientId: string): ISequencedClient | undefined;
-}
-
 export interface IProtocolState {
@@ -100,0 +127,0 @@ sequenceNumber: number;

src/protocol.ts

@@ -166,2 +166,8 @@ /*!
     timestamp: number;
+
+    /**
+     * Experimental field for storing the rolling hash at sequence number.
+     * @alpha
+     */
+    expHash1?: string;
 }
@@ -248,3 +254,3 @@
  */
-export interface ISummaryNack extends IServerError {
+export interface ISummaryNack {
     /**
@@ -254,2 +260,28 @@ * Information about the proposed summary op.
     summaryProposal: ISummaryProposal;
+
+    /**
+     * Message describing the error.
+     * @deprecated - Use "message" instead. Clients should check for message ?? errorMessage.
+     * Once all servers & clients are all updated, we can remove that errorMessage property
+     */
+    errorMessage: string;
+
+    /**
+     * An error code number that represents the error. It will be a valid HTTP error code.
+     * 403 errors are non retryable.
+     * 400 errors are always immediately retriable.
+     * 429 errors are retriable or non retriable (depends on type field).
+     */
+    code?: number;
+
+    /**
+     * A message about the error for debugging/logging/telemetry purposes
+     */
+    message?: string;
+
+    /**
+     * Optional Retry-After time in seconds.
+     * If specified, the client should wait this many seconds before retrying.8
+     */
+    retryAfter?: number;
 }
@@ -256,0 +288,0 @@

src/sockets.ts

@@ -55,2 +55,9 @@ /*!
     epoch?: string;
+
+    /**
+     * A list of optional features that client supports.
+     * Features supported might be service specific.
+     * If we have standardized features across all services, they need to be exposed in more structured way.
+     */
+    supportedFeatures?: Record<string, any>;
 }
@@ -135,2 +142,14 @@
     epoch?: string;
+
+    /**
+     * A list of optional features that ordering service supports.
+     * Features supported might be service specific.
+     * If we have standardized features across all services, they need to be exposed in more structured way.
+     */
+    supportedFeatures?: Record<string, any>;
+
+    /**
+     * The time the client connected
+     */
+    timestamp?: number;
 }

src/storage.ts

@@ -53,3 +53,2 @@ /*!
     id: string;
-    url: string;
 }
@@ -56,0 +55,0 @@

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

178418

increased by20.15%

Number of package files

108

increased by0.93%

Lines of code

2567

increased by8.73%

Dependency changes

• Updated@fluidframework/common-definitions@^0.20.0