chore: clean up script and public only defs

Author: nbbeeken

packages/compass-web/api-extractor.json

@@ -1,6 +1,7 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
   "mainEntryPointFilePath": "./dist/index.d.ts",
+  "newlineKind": "lf",
   "bundledPackages": [
     "@mongodb-js/*",
     "@mongodb-js/mdb-experiment-js",
@@ -25,7 +26,8 @@
   },
   "dtsRollup": {
     "enabled": true,
-    "untrimmedFilePath": "./dist/index.untrimmed.d.ts"
+    "untrimmedFilePath": "",
+    "publicTrimmedFilePath": "./dist/<unscopedPackageName>.d.ts"
   },
   "apiReport": {
     "enabled": false

packages/compass-web/package.json

@@ -33,16 +33,16 @@
     ".": "./src/index.tsx",
     "./package.json": "./package.json"
   },
-  "types": "./dist/index.d.ts",
+  "types": "./dist/compass-web.d.ts",
   "scripts": {
     "prepublishOnly": "npm run compile && compass-scripts check-exports-exist",
     "compile": "npm run webpack -- --mode production",
     "webpack": "webpack-compass",
-    "postcompile": "npm run typescript && npm run api-extractor && npm run bundle-types",
+    "postcompile": "npm run typescript",
     "typescript": "tsc -p tsconfig-build.json --emitDeclarationOnly",
+    "posttypescript": "npm run api-extractor",
     "api-extractor": "api-extractor run --local",
-    "bundle-types": "cp dist/index.bundled.d.ts dist/index.d.ts && rm -f dist/index.bundled.d.ts && node scripts/cleanup-bundled-types.js",
-    "check-external-deps": "echo 'External dependencies that consumers will need:' && grep '^import.*from.*' dist/index.d.ts | grep -v '\\./\\|@mongodb-js\\|compass-preferences-model' | grep -v 'stream\\|events\\|https\\|http\\|tls\\|net\\|dns' | sort | uniq",
+    "postapi-extractor": "node scripts/clean-dts.mjs",
     "test-types": "cd test/types && npm install && npm test",
     "prestart": "npm run compile -w @mongodb-js/webpack-config-compass",
     "start": "electron ./scripts/electron-proxy.js",

packages/compass-web/scripts/clean-dts.mjs

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+//@ts-check
+
+import fs from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+
+const distDir = path.join(process.cwd(), 'dist');
+const keepFiles = new Set(['compass-web.d.ts', 'compass-web.d.ts.map']);
+
+for (const file of fs.readdirSync(distDir)) {
+  if (
+    (file.endsWith('.d.ts') || file.endsWith('.d.ts.map')) &&
+    !keepFiles.has(file)
+  ) {
+    fs.unlinkSync(path.join(distDir, file));
+    console.log(`Deleted: ${file}`);
+  }
+}

packages/compass-web/scripts/cleanup-bundled-types.js

@@ -67,6 +67,7 @@ import {
   CompassAssistantProvider,
 } from '@mongodb-js/compass-assistant';
 
+/** @public */
 export type TrackFunction = (
   event: string,
   properties: Record<string, any>
@@ -95,6 +96,7 @@ type CompassWorkspaceProps = Pick<
     'onOpenConnectViaModal'
   >;
 
+/** @public */
 export type CompassWebProps = {
   /**
    * App name to be passed with the connection string when connection to a
@@ -264,6 +266,7 @@ const connectedContainerStyles = css({
   display: 'flex',
 });
 
+/** @public */
 const CompassWeb = ({
   appName,
   orgId,

packages/compass-web/src/entrypoint.tsx

@@ -1,9 +1,14 @@
 export { CompassWeb } from './entrypoint';
-export type { CompassWebProps } from './entrypoint';
+export type { CompassWebProps, TrackFunction } from './entrypoint';
 export * from './url-builder';
 export type {
   OpenWorkspaceOptions,
   WorkspaceTab,
 } from '@mongodb-js/compass-workspaces';
 
 export { CompassExperimentationProvider } from '@mongodb-js/compass-telemetry';
+
+export type { CollectionTabInfo } from '@mongodb-js/compass-workspaces';
+export type { AllPreferences } from 'compass-preferences-model/provider';
+export type { AtlasClusterMetadata } from '@mongodb-js/connection-info';
+export type { LogFunction, LogMessage, DebugFunction } from './logger';

packages/compass-web/src/index.tsx

@@ -4,6 +4,7 @@ import type { Writable } from 'stream';
 import { mongoLogId } from '@mongodb-js/compass-logging/provider';
 import { useRef } from 'react';
 
+/** @public */
 export type LogMessage = {
   id: number;
   t: { $date: string };
@@ -13,8 +14,11 @@ export type LogMessage = {
   msg: string;
   attr?: any;
 };
+
+/** @public */
 export type LogFunction = (message: LogMessage) => void;
 
+/** @public */
 export type DebugFunction = (...args: any[]) => void;
 
 type Debugger = Logger['debug'];

packages/compass-web/src/logger.tsx

@@ -49,6 +49,7 @@ function getRouteFromCollectionSubTab(subTab: CollectionSubtab): string {
   }
 }
 
+/** @public */
 export function getWorkspaceTabFromRoute(
   route: string
 ): OpenWorkspaceOptions | null {
@@ -85,6 +86,7 @@ function buildAbsoluteURL(...parts: string[]) {
   );
 }
 
+/** @public */
 export function getRouteFromWorkspaceTab(tab: WorkspaceTab | null) {
   let route: string;
   switch (tab?.type) {