@fluidframework/protocol-definitions - npm Package Compare versions

Comparing version 3.1.0-220363 to 3.1.0-223007

api-extractor-lint.json

 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../build/build-common/api-extractor-lint.json"
 }

api-report/protocol-definitions.api.md

@@ -7,3 +7,3 @@ ## API Report File for "@fluidframework/protocol-definitions"
 
-// @alpha
+// @public
 export type ConnectionMode = "write" | "read";
@@ -46,3 +46,3 @@
 
-// @alpha
+// @public
 export interface IBranchOrigin {
@@ -54,3 +54,3 @@ id: string;
 
-// @alpha
+// @public
 export interface ICapabilities {
@@ -60,3 +60,3 @@ interactive: boolean;
 
-// @alpha
+// @public
 export interface IClient {
@@ -72,3 +72,3 @@ details: IClientDetails;
 
-// @alpha
+// @public
 export interface IClientConfiguration {
@@ -81,3 +81,3 @@ blockSize: number;
 
-// @alpha
+// @public
 export interface IClientDetails {
@@ -151,3 +151,3 @@ capabilities: ICapabilities;
 
-// @alpha
+// @public
 export interface IDocumentMessage {
@@ -221,3 +221,3 @@ clientSequenceNumber: number;
 
-// @alpha
+// @public
 export interface IQuorumClients {
@@ -288,3 +288,3 @@ // (undocumented)
 
-// @alpha
+// @public
 export interface ISequencedClient {
@@ -301,3 +301,3 @@ client: IClient;
 
-// @alpha
+// @public
 export interface ISequencedDocumentMessage {
@@ -353,3 +353,3 @@ clientId: string | null;
 
-// @alpha
+// @public
 export interface ISignalMessage extends ISignalMessageBase {
@@ -359,3 +359,3 @@ clientId: string | null;
 
-// @alpha
+// @public
 export interface ISignalMessageBase {
@@ -402,3 +402,3 @@ clientConnectionNumber?: number;
 
-// @alpha
+// @public
 export interface ISummaryAttachment {
@@ -411,3 +411,3 @@ // (undocumented)
 
-// @alpha
+// @public
 export interface ISummaryBlob {
@@ -429,3 +429,3 @@ // (undocumented)
 
-// @alpha
+// @public
 export interface ISummaryHandle {
@@ -461,3 +461,3 @@ handle: string;
 
-// @alpha
+// @public
 export interface ISummaryTree {
@@ -473,3 +473,3 @@ // (undocumented)
 
-// @alpha
+// @public
 export interface ITokenClaims {
@@ -497,3 +497,3 @@ documentId: string;
 
-// @alpha
+// @public
 export interface ITrace {
@@ -533,3 +533,3 @@ action: string;
 
-// @alpha
+// @public
 export interface IUser {
@@ -571,3 +571,3 @@ id: string;
 
-// @internal
+// @alpha
 export enum ScopeType {
@@ -585,3 +585,3 @@ DocRead = "doc:read",
 
-// @alpha
+// @public
 export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
@@ -592,3 +592,3 @@
 
-// @alpha
+// @public
 export namespace SummaryType {
@@ -609,6 +609,6 @@ // @internal (undocumented)
 
-// @alpha
+// @public
 export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
 
-// @alpha
+// @public
 export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
@@ -615,0 +615,0 @@

CHANGELOG.md

@@ -5,4 +5,12 @@ # @fluidframework/protocol-definitions Changelog
 
-`ISequencedDocumentMessage` properties `compression` and `expHash1` are deprecated. They have been extracted into a separate interface `ISequencedDocumentMessageExperimental` and should be used from there instead.
+### Deprecated properties on ISequencedDocumentMessage
 
+`ISequencedDocumentMessage` properties `compression` and `expHash1` are deprecated. They have been extracted into a
+separate interface `ISequencedDocumentMessageExperimental` and should be used from there instead.
+
+### Package now works properly with TypeScript's node16 moduleResolution
+
+The package now has an "exports" field in its package.json so node16 moduleResolution will work
+for both CJS and ESM.
+
 ## [3.0.0](https://github.com/microsoft/FluidFramework/releases/tag/protocol-definitions_v3.0.0)
@@ -9,0 +17,0 @@

dist/clients.d.ts

@@ -13,9 +13,9 @@ /*!
  * E.g. a user with read-only permissions will not be allowed a "write" connection mode.
- * @alpha
+ * @public
  */
-export declare type ConnectionMode = "write" | "read";
+export type ConnectionMode = "write" | "read";
 /**
  * Capabilities of a Client.
  * In particular, whether or not the client is {@link ICapabilities.interactive}.
- * @alpha
+ * @public
  */
@@ -36,3 +36,3 @@ export interface ICapabilities {
  * {@link IClient} connection / environment metadata.
- * @alpha
+ * @public
  */
@@ -61,3 +61,3 @@ export interface IClientDetails {
  * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.
- * @alpha
+ * @public
  */
@@ -89,3 +89,3 @@ export interface IClient {
  * A {@link IClient} that has been acknowledged by the sequencer.
- * @alpha
+ * @public
  */
@@ -92,0 +92,0 @@ export interface ISequencedClient {

dist/config.d.ts

@@ -7,3 +7,3 @@ /*!
  * Key value store of service configuration properties provided to the client as part of connection.
- * @alpha
+ * @public
  */
@@ -10,0 +10,0 @@ export interface IClientConfiguration {

dist/consensus.d.ts

@@ -29,3 +29,3 @@ /*!
  */
-export declare type ISequencedProposal = {
+export type ISequencedProposal = {
     sequenceNumber: number;
@@ -37,3 +37,3 @@ } & IProposal;
  */
-export declare type IApprovedProposal = {
+export type IApprovedProposal = {
     approvalSequenceNumber: number;
@@ -45,3 +45,3 @@ } & ISequencedProposal;
  */
-export declare type ICommittedProposal = {
+export type ICommittedProposal = {
     commitSequenceNumber: number;
@@ -75,6 +75,6 @@ } & IApprovedProposal;
  */
-export declare type IQuorumEvents = IQuorumClientsEvents & IQuorumProposalsEvents;
+export type IQuorumEvents = IQuorumClientsEvents & IQuorumProposalsEvents;
 /**
  * Interface for tracking clients in the Quorum.
- * @alpha
+ * @public
  */
@@ -81,0 +81,0 @@ export interface IQuorumClients {

dist/date.d.ts

@@ -9,3 +9,3 @@ /*!
  */
-export declare type IsoDate = string;
+export type IsoDate = string;
 //# sourceMappingURL=date.d.ts.map

dist/protocol.d.ts

@@ -80,3 +80,3 @@ /*!
  * Messages to track latency trace.
- * @alpha
+ * @public
  */
@@ -116,3 +116,3 @@ export interface ITrace {
  * Document-specific message.
- * @alpha
+ * @public
  */
@@ -163,3 +163,3 @@ export interface IDocumentMessage {
  * Branch origin information.
- * @alpha
+ * @public
  */
@@ -182,3 +182,3 @@ export interface IBranchOrigin {
  * Sequenced message for a distributed document.
- * @alpha
+ * @public
  */
@@ -258,3 +258,3 @@ export interface ISequencedDocumentMessage {
  */
-export declare type ISequencedDocumentMessageExperimental = Omit<ISequencedDocumentMessage, "expHash1" | "compression"> & {
+export type ISequencedDocumentMessageExperimental = Omit<ISequencedDocumentMessage, "expHash1" | "compression"> & {
     /**
@@ -283,3 +283,3 @@ * Stores the rolling hash at sequence number.
  * Common interface between incoming and outgoing signals.
- * @alpha
+ * @public
  */
@@ -306,3 +306,3 @@ export interface ISignalMessageBase {
  * Interface for signals sent by the server to clients.
- * @alpha
+ * @public
  */
@@ -309,0 +309,0 @@ export interface ISignalMessage extends ISignalMessageBase {

dist/scopes.d.ts

@@ -7,3 +7,3 @@ /*!
  * Defines scope access for a Container/Document.
- * @internal
+ * @alpha
  */
@@ -10,0 +10,0 @@ export declare enum ScopeType {

dist/storage.d.ts

@@ -58,3 +58,3 @@ /*!
  */
-export declare type ITreeEntry = {
+export type ITreeEntry = {
     /**
@@ -61,0 +61,0 @@ * Path to the object

dist/summary.d.ts

@@ -10,5 +10,5 @@ /*!
  * If any particular node is an {@link ISummaryTree}, it can contain additional `SummaryObject`s as its children.
- * @alpha
+ * @public
  */
-export declare type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
+export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
 /**
@@ -18,6 +18,6 @@ * The root of the summary tree.
  */
-export declare type SummaryTree = ISummaryTree | ISummaryHandle;
+export type SummaryTree = ISummaryTree | ISummaryHandle;
 /**
  * Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.
- * @alpha
+ * @public
  */
@@ -43,3 +43,3 @@ export declare namespace SummaryType {
      * Represents a sub-tree in the summary.
-     * @alpha
+     * @public
      */
@@ -51,3 +51,3 @@ const Tree: Tree;
      * such as data store / channel attributes.
-     * @alpha
+     * @public
      */
@@ -57,3 +57,3 @@ const Blob: Blob;
      * Path to a summary tree object from the last successful summary.
-     * @alpha
+     * @public
      */
@@ -65,3 +65,3 @@ const Handle: Handle;
      * receive an Id that can be used in the summary.
-     * @alpha
+     * @public
      */
@@ -72,5 +72,5 @@ const Attachment: Attachment;
  * {@inheritDoc (SummaryType:namespace)}
- * @alpha
+ * @public
  */
-export declare type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
+export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
 /**
@@ -82,5 +82,5 @@ * Summary type that {@link ISummaryHandle} points to.
  * the need to re-send the entire subtree if summary object has not changed.
- * @alpha
+ * @public
  */
-export declare type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
+export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
 /**
@@ -94,3 +94,3 @@ * Path to a summary tree object from the last successful summary indicating the summary object hasn't
  * An example of handle would be: '/<DataStoreId>/<DDSId>'.
- * @alpha
+ * @public
  */
@@ -118,3 +118,3 @@ export interface ISummaryHandle {
  *                    \"summaryFormatVersion\":2,\"isRootDataStore\":false \}"
- * @alpha
+ * @public
  */
@@ -136,3 +136,3 @@ export interface ISummaryBlob {
  * "id": "bQAQKARDdMdTgqICmBa_ZB86YXwGP"
- * @alpha
+ * @public
  */
@@ -146,3 +146,3 @@ export interface ISummaryAttachment {
  * Blob, Handle, Attachment or another Tree.
- * @alpha
+ * @public
  */
@@ -149,0 +149,0 @@ export interface ISummaryTree {

dist/tokens.d.ts

@@ -10,3 +10,3 @@ /*!
  * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}
- * @alpha
+ * @public
  */
@@ -13,0 +13,0 @@ export interface ITokenClaims {

dist/users.d.ts

@@ -7,3 +7,3 @@ /*!
  * Base user definition. It is valid to extend this interface when adding new details to the user object.
- * @alpha
+ * @public
  */
@@ -10,0 +10,0 @@ export interface IUser {

package.json

 {
   "name": "@fluidframework/protocol-definitions",
-  "version": "3.1.0-220363",
+  "version": "3.1.0-223007",
   "description": "Fluid protocol definitions",
@@ -14,11 +14,24 @@ "homepage": "https://fluidframework.com",
   "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "lib/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "lib/index.mjs",
   "types": "dist/index.d.ts",
   "dependencies": {},
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.13.3",
     "@fluid-tools/build-cli": "^0.26.1",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.26.1",
-    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@fluidframework/eslint-config-fluid": "^3.1.0",
     "@fluidframework/protocol-definitions-previous": "npm:@fluidframework/protocol-definitions@2.0.0",
@@ -28,22 +41,11 @@ "@microsoft/api-extractor": "^7.38.3",
     "copyfiles": "^2.4.1",
-    "eslint": "~8.6.0",
+    "eslint": "~8.55.0",
     "eslint-config-prettier": "~9.0.0",
     "prettier": "~3.0.3",
+    "renamer": "^4.0.0",
     "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "tsc-multi": "^1.1.0",
+    "typescript": "~5.1.6"
   },
   "packageManager": "pnpm@7.32.3+sha512.c28d73f0d82a6c4712a40b91aa43d7397e119b16f35e5e75fe9b7e8fd4f2fc6dfbb68bb3ffac3473a958bbafa7888b79ec384ad122537378089a3a2a19b9900e",
-  "fluidBuild": {
-    "branchReleaseTypes": {
-      "main": "minor",
-      "release/**": "patch"
-    },
-    "tasks": {
-      "tsc": [
-        "...",
-        "typetests:gen"
-      ]
-    }
-  },
   "typeValidation": {
@@ -53,6 +55,10 @@ "broken": {}
   "scripts": {
+    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:esnext": "copyfiles -u 1 \"dist/**/*-@(alpha|beta|public|untrimmed).d.ts\" lib",
     "build": "npm run build:compile && concurrently npm:lint npm:build:docs",
     "build:compile": "concurrently npm:typetests:gen npm:tsc npm:build:esnext",
-    "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:docs": "npm run api-extractor:commonjs && npm run api-extractor:esnext",
+    "build:esnext": "tsc-multi --config ../../build/build-common/tsc-multi.esm.json && npm run build:rename-types",
+    "build:rename-types": "renamer \"lib/**\" -f .d.ts -r .d.mts --force",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
@@ -67,8 +73,7 @@ "ci:build": "npm run build:compile",
     "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint && npm run check:are-the-types-wrong",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
-    "tsc": "tsc",
-    "tsc:watch": "tsc --watch",
+    "tsc": "tsc-multi --config ../../build/build-common/tsc-multi.cjs.json",
     "typetests:gen": "fluid-type-test-generator",
@@ -75,0 +80,0 @@ "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"

src/clients.ts

@@ -15,3 +15,3 @@ /*!
  * E.g. a user with read-only permissions will not be allowed a "write" connection mode.
- * @alpha
+ * @public
  */
@@ -23,3 +23,3 @@ export type ConnectionMode = "write" | "read";
  * In particular, whether or not the client is {@link ICapabilities.interactive}.
- * @alpha
+ * @public
  */
@@ -41,3 +41,3 @@ export interface ICapabilities {
  * {@link IClient} connection / environment metadata.
- * @alpha
+ * @public
  */
@@ -69,3 +69,3 @@ export interface IClientDetails {
  * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.
- * @alpha
+ * @public
  */
@@ -103,3 +103,3 @@ export interface IClient {
  * A {@link IClient} that has been acknowledged by the sequencer.
- * @alpha
+ * @public
  */
@@ -106,0 +106,0 @@ export interface ISequencedClient {

src/config.ts

@@ -8,3 +8,3 @@ /*!
  * Key value store of service configuration properties provided to the client as part of connection.
- * @alpha
+ * @public
  */
@@ -11,0 +11,0 @@ export interface IClientConfiguration {

src/consensus.ts

@@ -89,3 +89,3 @@ /*!
  * Interface for tracking clients in the Quorum.
- * @alpha
+ * @public
  */
@@ -92,0 +92,0 @@ export interface IQuorumClients {

src/protocol.ts

@@ -96,3 +96,3 @@ /*!
  * Messages to track latency trace.
- * @alpha
+ * @public
  */
@@ -138,3 +138,3 @@ export interface ITrace {
  * Document-specific message.
- * @alpha
+ * @public
  */
@@ -194,3 +194,3 @@ export interface IDocumentMessage {
  * Branch origin information.
- * @alpha
+ * @public
  */
@@ -216,3 +216,3 @@ export interface IBranchOrigin {
  * Sequenced message for a distributed document.
- * @alpha
+ * @public
  */
@@ -339,3 +339,3 @@ export interface ISequencedDocumentMessage {
  * Common interface between incoming and outgoing signals.
- * @alpha
+ * @public
  */
@@ -366,3 +366,3 @@ export interface ISignalMessageBase {
  * Interface for signals sent by the server to clients.
- * @alpha
+ * @public
  */
@@ -369,0 +369,0 @@ export interface ISignalMessage extends ISignalMessageBase {

src/scopes.ts

@@ -8,3 +8,3 @@ /*!
  * Defines scope access for a Container/Document.
- * @internal
+ * @alpha
  */
@@ -11,0 +11,0 @@ export enum ScopeType {

src/storage.ts

@@ -46,2 +46,3 @@ /*!
 	 */
+	// eslint-disable-next-line unicorn/text-encoding-identifier-case
 	encoding: "utf-8" | "base64";
@@ -48,0 +49,0 @@ }

src/summary.ts

@@ -11,3 +11,3 @@ /*!
  * If any particular node is an {@link ISummaryTree}, it can contain additional `SummaryObject`s as its children.
- * @alpha
+ * @public
  */
@@ -24,3 +24,3 @@ export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
  * Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.
- * @alpha
+ * @public
  */
@@ -48,3 +48,3 @@ // eslint-disable-next-line @typescript-eslint/no-namespace
 	 * Represents a sub-tree in the summary.
-	 * @alpha
+	 * @public
 	 */
@@ -57,3 +57,3 @@ export const Tree: Tree = 1 as const;
 	 * such as data store / channel attributes.
-	 * @alpha
+	 * @public
 	 */
@@ -64,3 +64,3 @@ export const Blob: Blob = 2 as const;
 	 * Path to a summary tree object from the last successful summary.
-	 * @alpha
+	 * @public
 	 */
@@ -73,3 +73,3 @@ export const Handle: Handle = 3 as const;
 	 * receive an Id that can be used in the summary.
-	 * @alpha
+	 * @public
 	 */
@@ -81,3 +81,3 @@ export const Attachment: Attachment = 4 as const;
  * {@inheritDoc (SummaryType:namespace)}
- * @alpha
+ * @public
  */
@@ -96,3 +96,3 @@ export type SummaryType =
  * the need to re-send the entire subtree if summary object has not changed.
- * @alpha
+ * @public
  */
@@ -109,3 +109,3 @@ export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
  * An example of handle would be: '/<DataStoreId>/<DDSId>'.
- * @alpha
+ * @public
  */
@@ -136,3 +136,3 @@ export interface ISummaryHandle {
  *                    \"summaryFormatVersion\":2,\"isRootDataStore\":false \}"
- * @alpha
+ * @public
  */
@@ -155,3 +155,3 @@ export interface ISummaryBlob {
  * "id": "bQAQKARDdMdTgqICmBa_ZB86YXwGP"
- * @alpha
+ * @public
  */
@@ -166,3 +166,3 @@ export interface ISummaryAttachment {
  * Blob, Handle, Attachment or another Tree.
- * @alpha
+ * @public
  */
@@ -169,0 +169,0 @@ export interface ISummaryTree {

src/tokens.ts

@@ -12,3 +12,3 @@ /*!
  * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}
- * @alpha
+ * @public
  */
@@ -15,0 +15,0 @@ export interface ITokenClaims {

src/users.ts

@@ -8,3 +8,3 @@ /*!
  * Base user definition. It is valid to extend this interface when adding new details to the user object.
- * @alpha
+ * @public
  */
@@ -11,0 +11,0 @@ export interface IUser {

tsconfig.json

 {
-	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"extends": [
+		"../../build/build-common/tsconfig.base.json",
+		"../../build/build-common/tsconfig.cjs.json",
+	],
 	"exclude": ["dist", "node_modules"],
@@ -4,0 +7,0 @@ "compilerOptions": {

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

377177

Worsened metrics

Dev dependency count

16

increased by14.29%

Number of package files

125

decreased by-0.79%

Lines of code

3475

decreased by-28.14%

No dependency changes