RC3.0: Make using API trimming optional (#21285)

[AB#8158](https://dev.azure.com/fluidframework/internal/_workitems/edit/8158)
microsoft · Jun 4, 2024 · 23c2373 · 23c2373
1 parent 00fe19a
commit 23c2373
Show file tree

Hide file tree

Showing 65 changed files with 2,552 additions and 180 deletions.
diff --git a/azure/packages/azure-service-utils/package.json b/azure/packages/azure-service-utils/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/common/lib/protocol-definitions/package.json b/common/lib/protocol-definitions/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/common/container-definitions/package.json b/packages/common/container-definitions/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/...on/container-definitions/src/test/types/validateContainerDefinitionsPrevious.generated.ts b/...on/container-definitions/src/test/types/validateContainerDefinitionsPrevious.generated.ts
@@ -902,6 +902,30 @@ declare function use_old_InterfaceDeclaration_IFluidPackageEnvironment(
 use_old_InterfaceDeclaration_IFluidPackageEnvironment(
     get_current_InterfaceDeclaration_IFluidPackageEnvironment());
 
+/*
+* Validate forward compat by using old type in place of current type
+* If breaking change required, add in package.json under typeValidation.broken:
+* "InterfaceDeclaration_IGenericError": {"forwardCompat": false}
+*/
+declare function get_old_InterfaceDeclaration_IGenericError():
+    TypeOnly<old.IGenericError>;
+declare function use_current_InterfaceDeclaration_IGenericError(
+    use: TypeOnly<current.IGenericError>): void;
+use_current_InterfaceDeclaration_IGenericError(
+    get_old_InterfaceDeclaration_IGenericError());
+
+/*
+* Validate back compat by using current type in place of old type
+* If breaking change required, add in package.json under typeValidation.broken:
+* "InterfaceDeclaration_IGenericError": {"backCompat": false}
+*/
+declare function get_current_InterfaceDeclaration_IGenericError():
+    TypeOnly<current.IGenericError>;
+declare function use_old_InterfaceDeclaration_IGenericError(
+    use: TypeOnly<old.IGenericError>): void;
+use_old_InterfaceDeclaration_IGenericError(
+    get_current_InterfaceDeclaration_IGenericError());
+
 /*
 * Validate forward compat by using old type in place of current type
 * If breaking change required, add in package.json under typeValidation.broken:
@@ -1214,6 +1238,54 @@ declare function use_old_InterfaceDeclaration_ISnapshotTreeWithBlobContents(
 use_old_InterfaceDeclaration_ISnapshotTreeWithBlobContents(
     get_current_InterfaceDeclaration_ISnapshotTreeWithBlobContents());
 
+/*
+* Validate forward compat by using old type in place of current type
+* If breaking change required, add in package.json under typeValidation.broken:
+* "InterfaceDeclaration_IThrottlingWarning": {"forwardCompat": false}
+*/
+declare function get_old_InterfaceDeclaration_IThrottlingWarning():
+    TypeOnly<old.IThrottlingWarning>;
+declare function use_current_InterfaceDeclaration_IThrottlingWarning(
+    use: TypeOnly<current.IThrottlingWarning>): void;
+use_current_InterfaceDeclaration_IThrottlingWarning(
+    get_old_InterfaceDeclaration_IThrottlingWarning());
+
+/*
+* Validate back compat by using current type in place of old type
+* If breaking change required, add in package.json under typeValidation.broken:
+* "InterfaceDeclaration_IThrottlingWarning": {"backCompat": false}
+*/
+declare function get_current_InterfaceDeclaration_IThrottlingWarning():
+    TypeOnly<current.IThrottlingWarning>;
+declare function use_old_InterfaceDeclaration_IThrottlingWarning(
+    use: TypeOnly<old.IThrottlingWarning>): void;
+use_old_InterfaceDeclaration_IThrottlingWarning(
+    get_current_InterfaceDeclaration_IThrottlingWarning());
+
+/*
+* Validate forward compat by using old type in place of current type
+* If breaking change required, add in package.json under typeValidation.broken:
+* "InterfaceDeclaration_IUsageError": {"forwardCompat": false}
+*/
+declare function get_old_InterfaceDeclaration_IUsageError():
+    TypeOnly<old.IUsageError>;
+declare function use_current_InterfaceDeclaration_IUsageError(
+    use: TypeOnly<current.IUsageError>): void;
+use_current_InterfaceDeclaration_IUsageError(
+    get_old_InterfaceDeclaration_IUsageError());
+
+/*
+* Validate back compat by using current type in place of old type
+* If breaking change required, add in package.json under typeValidation.broken:
+* "InterfaceDeclaration_IUsageError": {"backCompat": false}
+*/
+declare function get_current_InterfaceDeclaration_IUsageError():
+    TypeOnly<current.IUsageError>;
+declare function use_old_InterfaceDeclaration_IUsageError(
+    use: TypeOnly<old.IUsageError>): void;
+use_old_InterfaceDeclaration_IUsageError(
+    get_current_InterfaceDeclaration_IUsageError());
+
 /*
 * Validate forward compat by using old type in place of current type
 * If breaking change required, add in package.json under typeValidation.broken:

diff --git a/packages/common/core-interfaces/package.json b/packages/common/core-interfaces/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/common/core-utils/package.json b/packages/common/core-utils/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/common/driver-definitions/package.json b/packages/common/driver-definitions/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/dds/cell/package.json b/packages/dds/cell/package.json
@@ -14,12 +14,20 @@
 	"type": "module",
 	"exports": {
 		".": {
+			"trimmedAPI": {
+				"import": {
+					"types": "./lib/public.d.ts"
+				},
+				"require": {
+					"types": "./dist/public.d.ts"
+				}
+			},
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -35,7 +43,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/dds/counter/package.json b/packages/dds/counter/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/dds/map/package.json b/packages/dds/map/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/dds/matrix/package.json b/packages/dds/matrix/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/dds/merge-tree/package.json b/packages/dds/merge-tree/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -57,7 +57,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/dds/ordered-collection/package.json b/packages/dds/ordered-collection/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",

diff --git a/packages/dds/register-collection/package.json b/packages/dds/register-collection/package.json
@@ -15,11 +15,11 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./lib/public.d.ts",
+				"types": "./lib/index.d.ts",
 				"default": "./lib/index.js"
 			},
 			"require": {
-				"types": "./dist/public.d.ts",
+				"types": "./dist/index.d.ts",
 				"default": "./dist/index.js"
 			}
 		},
@@ -45,7 +45,7 @@
 		}
 	},
 	"main": "lib/index.js",
-	"types": "lib/public.d.ts",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"api": "fluid-build . --task api",
 		"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",