Migrate from tsc to rollup for the build process

package.json

@@ -1,9 +1,9 @@
 {
   "name": "@yext/chat-core",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Typescript Networking Library for the Yext Chat API",
   "main": "./dist/commonjs/index.js",
-  "module": "./dist/esm/index.js",
+  "module": "./dist/esm/index.mjs",
   "types": "./dist/esm/index.d.ts",
   "sideEffects": false,
   "keywords": [
@@ -26,12 +26,12 @@
   "scripts": {
     "test": "jest --config=jest.config.json",
     "lint": "prettier --write . && eslint --fix --max-warnings=0 .",
-    "tsc-cjs": "tsc -p tsconfig.cjs.json",
-    "tsc-esm": "tsc -p tsconfig.esm.json",
-    "dev": "npm run tsc-esm -- --watch",
+    "tsc": "tsc -p tsconfig.json",
+    "dev": "npm run tsc -- --watch",
     "generate-notices": "generate-license-file --input package.json --output THIRD-PARTY-NOTICES --overwrite",
     "generate-docs": "api-extractor run --local --verbose && api-documenter markdown --input-folder temp --output-folder docs && rm -rf temp",
-    "build": "rm -rf dist/** && npm run tsc-esm && npm run tsc-cjs && npm run generate-docs && npm run generate-notices"
+    "build:js": "rollup --config rollup.config.mjs",
+    "build": "rm -rf dist/** && npm run build:js && npm run generate-docs && npm run generate-notices"
   },
   "repository": {
     "type": "git",
@@ -60,6 +60,8 @@
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
     "prettier": "^2.8.8",
+    "rollup": "^3.29.0",
+    "rollup-plugin-typescript2": "^0.35.0",
     "typescript": "^5.0.4"
   }
 }

rollup.config.mjs

@@ -0,0 +1,42 @@
+/**
+ * \@rollup/plugin-typescript had issue with "export type":
+ * [!] RollupError: Unexpected token (Note that you need plugins to import files that are not JavaScript)
+ * Switched over to a fork rollup-plugin-typescript2 resolved the issue.
+ */
+import typescript from "rollup-plugin-typescript2";
+import { defineConfig } from "rollup";
+
+export default defineConfig({
+  input: "src/index.ts",
+  output: [
+    {
+      dir: "./dist/esm",
+      /**
+       * use mjs extension so NodeJS will recognize the bundle as ES modules
+       * https://nodejs.org/api/packages.html#determining-module-system
+       */
+      entryFileNames: "[name].mjs",
+      format: "esm",
+      /** preserve original module files instead of compressing all to one file */
+      preserveModules: true,
+      sourcemap: true,
+      /**
+       * set to "auto" to follow TypeScript's esModuleInterop behavior to ensures compatibility
+       * of default, namespace, and dynamic imports from external deps (e.g. react-textarea-autosize).
+       */
+      interop: "auto",
+    },
+    {
+      dir: "./dist/commonjs",
+      format: "cjs",
+      preserveModules: true,
+      sourcemap: true,
+      interop: "auto",
+    },
+  ],
+  plugins: [
+    typescript({
+      tsconfig: "./tsconfig.json",
+    }),
+  ],
+});

src/infra/ChatCoreImpl.ts

@@ -9,11 +9,9 @@ import {
   MessageRequest,
   MessageResponse,
   Endpoints,
-  ChatPrompt
+  ChatPrompt,
 } from "../models";
-import {
-  ApiMessageRequest,
-} from "../models/endpoints/MessageRequest";
+import { ApiMessageRequest } from "../models/endpoints/MessageRequest";
 import { ApiResponse } from "../models/http/ApiResponse";
 import { QueryParams } from "../models/http/params";
 import { ApiResponseValidator } from "../validation/ApiResponseValidator";

src/models/ChatCore.ts

@@ -1,10 +1,10 @@
-import { StreamResponse } from "../infra/StreamResponse"
-import { MessageRequest } from "./endpoints/MessageRequest"
-import { MessageResponse } from "./endpoints/MessageResponse"
+import { StreamResponse } from "../infra/StreamResponse";
+import { MessageRequest } from "./endpoints/MessageRequest";
+import { MessageResponse } from "./endpoints/MessageResponse";
 
 /**
  * Provide methods for interacting with Chat API.
- * 
+ *
  * @public
  */
 export interface ChatCore {
@@ -16,7 +16,7 @@ export interface ChatCore {
    *
    * @param request - request to get next message
    */
-  getNextMessage(request: MessageRequest): Promise<MessageResponse>
+  getNextMessage(request: MessageRequest): Promise<MessageResponse>;
   /**
    * Make a request to Chat streaming API to generate the next message
    * and consume its tokens via server-sent events.
@@ -28,5 +28,5 @@ export interface ChatCore {
    *
    * @param request - request to get next message
    */
-  streamNextMessage(request: MessageRequest): Promise<StreamResponse>
-}
+  streamNextMessage(request: MessageRequest): Promise<StreamResponse>;
+}

src/models/InternalConfig.ts

@@ -4,7 +4,7 @@
  * package and subsequently moved into "stable" after performance and
  * reliability are verified. It is STRONGLY recommended not to use
  * "nightly" in production Chat bots.
- * 
+ *
  * @internal
  */
 export type ChatPrompt = "stable" | "nightly";

src/models/endpoints/MessageResponse.ts

@@ -9,7 +9,7 @@ import { MessageNotes } from "./MessageNotes";
 export interface MessageResponse {
   /**
    * The id corresponds to the current conversation.
-   * 
+   *
    * @remarks
    * This is undefined only when it's an initial bot response without any user message present.
    */

src/models/index.ts

@@ -1,6 +1,6 @@
-export { ChatCore } from "./ChatCore"
+export { ChatCore } from "./ChatCore";
 export { ChatConfig } from "./ChatConfig";
-export { InternalConfig, ChatPrompt } from "./InternalConfig"
+export { InternalConfig, ChatPrompt } from "./InternalConfig";
 
 export { Endpoints } from "./endpoints/Endpoints";
 export { Environment } from "./endpoints/Environment";

test-browser-esm/src/script.js

@@ -1,13 +1,13 @@
-import { ChatCore, StreamEventName } from "@yext/chat-core";
+import { StreamEventName, provideChatCore } from "@yext/chat-core";
 
-let chatCore = new ChatCore({
+let chatCore = provideChatCore({
   // will be replace with actual env value during rollup build process
   apiKey: process.env.TEST_BOT_API_KEY || "API_KEY_PLACEHOLDER",
   botId: process.env.TEST_BOT_ID,
   endpoints: {
     chat: `https://liveapi-dev.yext.com/v2/accounts/me/chat/${process.env.TEST_BOT_ID}/message`,
     chatStream: `https://liveapi-dev.yext.com/v2/accounts/me/chat/${process.env.TEST_BOT_ID}/message/streaming`,
-  }
+  },
 });
 
 window.getNextMessage = async () => {

test-node-cjs/node.ts

@@ -1,18 +1,21 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import http from "http";
-import { ChatCore, StreamEventName } from "@yext/chat-core";
+import { ChatConfig, StreamEventName, provideChatCore } from "@yext/chat-core";
 import dotenv from "dotenv";
 
 dotenv.config();
 
-const config = {
+const config: ChatConfig = {
   apiKey: process.env["TEST_BOT_API_KEY"] || "API_KEY_PLACEHOLDER",
   botId: process.env["TEST_BOT_ID"] || "BOT_ID_PLACEHOLDER",
-  apiDomain: "liveapi-dev.yext.com",
+  endpoints: {
+    chat: `https://liveapi-dev.yext.com/v2/accounts/me/chat/${process.env.TEST_BOT_ID}/message`,
+    chatStream: `https://liveapi-dev.yext.com/v2/accounts/me/chat/${process.env.TEST_BOT_ID}/message/streaming`,
+  },
 };
 
 async function stream(res: any) {
-  const chatCore = new ChatCore(config);
+  const chatCore = provideChatCore(config);
   const stream = await chatCore.streamNextMessage({
     messages: [
       {
@@ -39,7 +42,7 @@ const server = http.createServer(async (req: any, res: any) => {
   if (req.url === "/streaming") {
     stream(res);
   } else {
-    const chatCore = new ChatCore(config);
+    const chatCore = provideChatCore(config);
     const reply = await chatCore.getNextMessage({
       messages: [],
     });