@embeddable.com/sdk-core 3.12.5 → 3.13.0-next.0

package/loader/custom-esm-loader.mjs

@@ -62,9 +62,10 @@ const isWindows = process.platform === "win32";
 
 function cleanWindowsFileURL(url) {
   // Remove any duplicate file:/ prefixes and normalize slashes
-  return url.replace(/file:\/+/g, 'file:///')
-    .replace(/\\/g, '/')
-    .replace(/file:\/+([A-Za-z]:)/, 'file:///$1');
+  return url
+    .replace(/file:\/+/g, "file:///")
+    .replace(/\\/g, "/")
+    .replace(/file:\/+([A-Za-z]:)/, "file:///$1");
 }
 
 export const resolve = async (specifier, context, nextResolve) => {
@@ -86,13 +87,13 @@ export const resolve = async (specifier, context, nextResolve) => {
   if (!context.parentURL) {
     if (isWindows) {
       // Handle the case where the specifier contains both the cwd and the actual path
-      const parts = specifier.split('file:/');
+      const parts = specifier.split("file:/");
       const lastPart = parts[parts.length - 1];
-      
+
       // Convert the path to a proper file URL
-      const cleanPath = lastPart.replace(/^\/+/, '');
+      const cleanPath = lastPart.replace(/^\/+/, "");
       const entryPointPath = pathToFileURL(cleanPath).href;
-      
+
       return {
         format: isTS ? "ts" : undefined,
         url: cleanWindowsFileURL(entryPointPath),
@@ -108,14 +109,18 @@ export const resolve = async (specifier, context, nextResolve) => {
   }
 
   // Handle SDK relative imports
-  if (isWindows && specifier.startsWith('.') && context.parentURL?.includes('embeddable-sdk')) {
+  if (
+    isWindows &&
+    specifier.startsWith(".") &&
+    context.parentURL?.includes("embeddable-sdk")
+  ) {
     const parentPath = fileURLToPath(context.parentURL);
     const parentDir = dirname(parentPath);
     let resolvedPath = join(parentDir, specifier);
-    
+
     // If no extension is provided, try common extensions
     if (!path.extname(resolvedPath)) {
-      const extensions = ['.js', '.mjs', '.cjs', '.ts', '.mts'];
+      const extensions = [".js", ".mjs", ".cjs", ".ts", ".mts"];
       for (const ext of extensions) {
         const pathWithExt = resolvedPath + ext;
         if (fs.existsSync(pathWithExt) && fs.statSync(pathWithExt).isFile()) {
@@ -129,7 +134,7 @@ export const resolve = async (specifier, context, nextResolve) => {
     if (fs.existsSync(resolvedPath) && fs.statSync(resolvedPath).isFile()) {
       return {
         url: pathToFileURL(resolvedPath).href,
-        shortCircuit: true
+        shortCircuit: true,
       };
     }
   }

package/loader/entryPoint.js

@@ -1,4 +1,4 @@
-import { build, defineConfig, dev, login, push } from "../lib/index.js";
+import { build, defineConfig, dev, login, push } from "../lib/index.esm.js";
 import { spawn } from "child_process";
 import path from "path";
 import fs from "fs";

package/loader/entryPoint.test.js

@@ -7,7 +7,7 @@ import path from "path";
 vi.mock("child_process");
 vi.mock("fs");
 vi.mock("path");
-vi.mock("../lib/index.js", () => ({
+vi.mock("../lib/index.esm.js", () => ({
   build: vi.fn().mockResolvedValue(undefined),
   login: vi.fn().mockResolvedValue(undefined),
   push: vi.fn().mockResolvedValue(undefined),

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@embeddable.com/sdk-core",
-  "version": "3.12.5",
+  "version": "3.13.0-next.0",
   "description": "Core Embeddable SDK module responsible for web-components bundling and publishing.",
   "keywords": [
     "embeddable",
     "sdk",
     "web-components"
   ],
-  "main": "lib/index.js",
+  "main": "lib/index.esm.js",
   "module": "lib/index.esm.js",
   "types": "lib/index.d.ts",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/embeddable-hq/embeddable-sdk.git",
@@ -38,11 +39,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@embeddable.com/sdk-utils": "0.6.2",
+    "@embeddable.com/sdk-utils": "0.7.0-next.0",
     "@inquirer/prompts": "^7.2.1",
     "@stencil/core": "^4.23.0",
     "@swc-node/register": "^1.10.9",
-    "archiver": "^5.3.2",
+    "archiver": "^7.0.1",
     "axios": "^1.7.9",
     "chokidar": "^4.0.3",
     "dotenv": "^16.4.7",
@@ -53,7 +54,7 @@
     "open": "^9.1.0",
     "ora": "^8.1.1",
     "serve-static": "^1.16.2",
-    "sorcery": "^0.11.1",
+    "sorcery": "^1.0.0",
     "vite": "^5.4.11",
     "ws": "^8.18.0",
     "yaml": "^2.6.1"
@@ -64,7 +65,10 @@
     ]
   },
   "devDependencies": {
-    "@types/archiver": "^5.3.4",
+    "@types/archiver": "^6.0.3",
+    "@types/finalhandler": "^1.2.3",
+    "@types/minimist": "^1.2.5",
+    "@types/serve-static": "^1.15.7",
     "@types/ws": "^8.5.13"
   }
 }

package/src/build.test.ts

@@ -85,6 +85,8 @@ describe("build", () => {
   });
 
   it("should call reportErrorToRollbar and exit if an error occurs", async () => {
+    const originalConsoleError = console.error;
+    console.error = vi.fn();
     vi.spyOn(process, "exit").mockImplementation(() => null as never);
     vi.spyOn(console, "log").mockImplementation(() => undefined);
     const error = new Error("test error");
@@ -97,5 +99,7 @@ describe("build", () => {
     expect(reportErrorToRollbar).toHaveBeenCalledWith(error);
     expect(console.log).toHaveBeenCalledWith(error);
     expect(process.exit).toHaveBeenCalledWith(1);
+
+    console.error = originalConsoleError;
   });
 });

package/src/build.ts

@@ -22,7 +22,6 @@ export default async () => {
     checkNodeVersion();
     breadcrumbs.push("checkNodeVersion");
     removeBuildSuccessFlag();
-
     const config = await provideConfig();
 
     await validate(config);

package/src/buildTypes.ts

@@ -1,15 +1,13 @@
 import * as fs from "node:fs/promises";
 import * as path from "node:path";
 import * as vite from "vite";
-const oraP = import("ora");
+import ora from "ora";
 import { findFiles, getContentHash } from "@embeddable.com/sdk-utils";
 
 export const EMB_TYPE_FILE_REGEX = /^(.*)\.type\.emb\.[jt]s$/;
 export const EMB_OPTIONS_FILE_REGEX = /^(.*)\.options\.emb\.[jt]s$/;
 
 export default async (ctx: any) => {
-  const ora = (await oraP).default;
-
   const progress = ora("Building types...").start();
 
   await generate(ctx);

package/src/defineConfig.ts

@@ -82,6 +82,8 @@ export default ({
 
   const regionConfig = REGION_CONFIGS[region];
 
+  const __dirname = import.meta.dirname;
+
   const coreRoot = path.resolve(__dirname, "..");
   const clientRoot = process.cwd();
 

package/src/dev.test.ts

@@ -79,7 +79,7 @@ describe("dev command", () => {
     vi.mocked(provideConfig).mockResolvedValue(mockConfig);
     vi.mocked(getToken).mockResolvedValue("mock-token");
     vi.mocked(axios.get).mockResolvedValue({
-      data: "mock-workspace",
+      data: [{ id: "mock-workspace" }],
     });
   });
 
@@ -108,6 +108,8 @@ describe("dev command", () => {
   });
 
   it("should log errors and exit on failure", async () => {
+    const originalConsoleLog = console.log;
+    console.log = vi.fn();
     const error = new Error("Test error");
     const exitSpy = vi.spyOn(process, "exit").mockImplementation(() => {
       throw new Error("process.exit");
@@ -119,11 +121,15 @@ describe("dev command", () => {
 
     await expect(dev()).rejects.toThrow("process.exit");
 
+    expect(console.log).toHaveBeenCalledWith(error);
+
     expect(logError).toHaveBeenCalledWith({
       command: "dev",
       breadcrumbs: ["run dev"],
       error,
     });
     expect(exitSpy).toHaveBeenCalledWith(1);
+
+    console.log = originalConsoleLog;
   });
 });

package/src/dev.ts

@@ -26,21 +26,20 @@ import validate from "./validate";
 import { checkNodeVersion } from "./utils";
 import { createManifest } from "./cleanup";
 import { selectWorkspace } from "./workspaceUtils";
-import * as fs from "fs";
-const minimist = require("minimist");
+import * as fs from "node:fs/promises";
+import minimist from "minimist";
 import { initLogger, logError } from "./logger";
 import fg from "fast-glob";
 import * as dotenv from "dotenv";
-import { pathToFileURL } from "node:url";
-
+import ora from "ora";
+import finalhandler from "finalhandler";
+import serveStatic from "serve-static";
 dotenv.config();
 
-const oraP = import("ora");
 let wss: WSServer;
 let changedFiles: string[] = [];
 let browserWindow: ChildProcess | null = null;
 
-let ora: any;
 let previewWorkspace: string;
 
 const SERVER_PORT = 8926;
@@ -53,7 +52,6 @@ const buildWebComponent = async (config: any) => {
 
 const addToGitingore = async () => {
   try {
-    const fs = require("fs").promises;
     const gitignorePath = path.resolve(process.cwd(), ".gitignore");
     const gitignoreContent = await fs.readFile(gitignorePath, "utf8");
 
@@ -83,8 +81,6 @@ export default async () => {
     checkNodeVersion();
     addToGitingore();
 
-    ora = (await oraP).default;
-
     process.on("warning", (e) => console.warn(e.stack));
 
     const logger = createNodeLogger();
@@ -116,9 +112,6 @@ export default async () => {
     breadcrumbs.push("prepare config");
     await prepare(config);
 
-    const finalhandler = require("finalhandler");
-    const serveStatic = require("serve-static");
-
     const serve = serveStatic(config.client.buildDir);
 
     let workspacePreparation = ora("Preparing workspace...").start();
@@ -149,7 +142,7 @@ export default async () => {
     workspacePreparation.succeed("Workspace is ready");
 
     const server = http.createServer(
-      (request: IncomingMessage, res: ServerResponse) => {
+      async (request: IncomingMessage, res: ServerResponse) => {
         res.setHeader("Access-Control-Allow-Origin", "*");
         res.setHeader(
           "Access-Control-Allow-Methods",
@@ -172,7 +165,7 @@ export default async () => {
         try {
           if (request.url?.endsWith(GLOBAL_CSS)) {
             res.writeHead(200, { "Content-Type": "text/css" });
-            res.end(fs.readFileSync(config.client.globalCss));
+            res.end(await fs.readFile(config.client.globalCss));
             return;
           }
         } catch {}

package/src/generate.ts

@@ -4,7 +4,7 @@ import { createNodeLogger, createNodeSys } from "@stencil/core/sys/node";
 import { createCompiler, loadConfig } from "@stencil/core/compiler";
 import { findFiles, getContentHash } from "@embeddable.com/sdk-utils";
 
-const sorcery = require("sorcery");
+import * as sorcery from "sorcery";
 
 const STYLE_IMPORTS_TOKEN = "{{STYLES_IMPORT}}";
 const RENDER_IMPORT_TOKEN = "{{RENDER_IMPORT}}";

package/src/logger.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect, beforeEach, vi, afterEach } from "vitest";
+import { describe, it, expect, beforeEach, vi } from "vitest";
 import { initLogger, logError, ERROR_LOG_FILE } from "./logger";
 import * as fs from "node:fs/promises";
 
@@ -7,9 +7,24 @@ vi.mock("fs/promises", () => ({
   appendFile: vi.fn(),
   access: vi.fn(),
   mkdir: vi.fn(),
+  stat: vi.fn(),
 }));
 
 describe("Logger", () => {
+  let consoleErrorSpy: ReturnType<typeof vi.spyOn>;
+
+  beforeEach(() => {
+    consoleErrorSpy = vi.spyOn(console, "error").mockImplementation(() => {});
+
+    vi.mocked(fs.stat).mockResolvedValue({
+      size: 100,
+    } as any);
+  });
+
+  afterEach(() => {
+    consoleErrorSpy.mockRestore();
+  });
+
   describe("initLogger", () => {
     it("should create log directory if it does not exist", async () => {
       await initLogger("test");
@@ -24,9 +39,6 @@ describe("Logger", () => {
     });
 
     it("should handle errors when creating log directory", async () => {
-      const consoleErrorSpy = vi
-        .spyOn(console, "error")
-        .mockImplementation(() => {});
       vi.mocked(fs.mkdir).mockRejectedValueOnce(
         new Error("Failed to create directory"),
       );

package/src/login.test.ts

@@ -132,8 +132,8 @@ describe("login", () => {
       "Authentication failed. Please try again.",
     );
 
-    expect(console.log).toHaveBeenCalledWith(
-      new AxiosError("Request failed with status code 500"),
+    expect((console.log as any).mock.calls[0][0]).toMatchInlineSnapshot(
+      `[AxiosError: Request failed with status code 500]`,
     );
   });
 });

package/src/push.test.ts

@@ -1,7 +1,7 @@
 import push from "./push";
 import provideConfig from "./provideConfig";
 import { fileFromPath } from "formdata-node/file-from-path";
-import * as archiver from "archiver";
+import archiver from "archiver";
 import * as fs from "node:fs/promises";
 import * as fsSync from "node:fs";
 import { findFiles } from "@embeddable.com/sdk-utils";
@@ -44,6 +44,8 @@ vi.mock("node:fs/promises", () => ({
   access: vi.fn(),
   rm: vi.fn(),
   mkdir: vi.fn(),
+  stat: vi.fn(),
+  appendFile: vi.fn(),
 }));
 
 vi.mock("node:fs", () => ({
@@ -51,7 +53,13 @@ vi.mock("node:fs", () => ({
 }));
 
 vi.mock("./provideConfig", () => ({
-  default: vi.fn(),
+  default: vi.fn().mockResolvedValue({
+    client: {
+      rootDir: "rootDir",
+      buildDir: "buildDir",
+      archiveFile: "embeddable-build.zip",
+    },
+  }),
 }));
 
 vi.mock("./rollbar.mjs", () => ({
@@ -63,7 +71,9 @@ vi.mock("@embeddable.com/sdk-utils", () => ({
 }));
 
 vi.mock("archiver", () => ({
-  create: vi.fn(),
+  default: {
+    create: vi.fn(),
+  },
 }));
 
 vi.mock("formdata-node/file-from-path", () => ({
@@ -81,6 +91,13 @@ const config = {
 };
 
 describe("push", () => {
+  const archiveMock = {
+    finalize: vi.fn(),
+    pipe: vi.fn(),
+    directory: vi.fn(),
+    file: vi.fn(),
+  };
+
   beforeEach(() => {
     vi.mocked(checkNodeVersion).mockResolvedValue(true);
     vi.mocked(checkBuildSuccess).mockResolvedValue(true);
@@ -90,17 +107,15 @@ describe("push", () => {
     vi.mocked(fs.readFile).mockImplementation(async () =>
       Buffer.from(`{"access_token":"mocked-token"}`),
     );
+    vi.mocked(fs.stat).mockResolvedValue({
+      size: 100,
+    } as any);
 
     vi.mocked(findFiles).mockResolvedValue([["fileName", "filePath"]]);
     vi.mocked(fileFromPath).mockReturnValue(
       new Blob([new ArrayBuffer(8)]) as any,
     );
-    vi.mocked(archiver.create).mockReturnValue({
-      finalize: vi.fn(),
-      pipe: vi.fn(),
-      directory: vi.fn(),
-      file: vi.fn(),
-    } as any);
+    vi.mocked(archiver.create).mockReturnValue(archiveMock as any);
 
     vi.mocked(fsSync.createWriteStream).mockReturnValue({
       on: (event: string, cb: () => void) => {
@@ -128,6 +143,12 @@ describe("push", () => {
       config.client.archiveFile,
     );
 
+    expect(archiveMock.pipe).toHaveBeenCalled();
+    expect(archiveMock.file).toHaveBeenCalledWith("filePath", {
+      name: "filePath",
+    });
+    expect(archiveMock.directory).toHaveBeenCalledWith("buildDir", false);
+    expect(archiveMock.finalize).toHaveBeenCalled();
     // after publishing the file gets removed
     expect(fs.rm).toHaveBeenCalledWith(config.client.archiveFile);
 

package/src/push.ts

@@ -1,8 +1,8 @@
 import * as fs from "node:fs/promises";
 import * as fsSync from "node:fs";
-import * as archiver from "archiver";
+import archiver from "archiver";
 import axios from "axios";
-const oraP = import("ora");
+import ora from "ora";
 import { initLogger, logError } from "./logger";
 import * as path from "path";
 
@@ -21,7 +21,6 @@ export const CUBE_FILES = /^(.*)\.cube\.(ya?ml|js)$/;
 // grab security context and client context files
 export const PRESET_FILES = /^(.*)\.(sc|cc)\.ya?ml$/;
 
-let ora: any;
 export default async () => {
   await initLogger("push");
   const breadcrumbs: string[] = [];
@@ -38,8 +37,6 @@ export default async () => {
       process.exit(1);
     }
 
-    ora = (await oraP).default;
-
     const config = await provideConfig();
 
     if (process.argv.includes("--api-key") || process.argv.includes("-k")) {
@@ -164,25 +161,25 @@ export async function archive(
 ) {
   const output = fsSync.createWriteStream(ctx.client.archiveFile);
 
-  const _archiver = archiver.create("zip", {
+  const archive = archiver.create("zip", {
     zlib: { level: 9 },
   });
 
-  _archiver.pipe(output);
+  archive.pipe(output);
   if (!isDev) {
-    _archiver.directory(ctx.client.buildDir, false);
-    _archiver.file(ctx.client.globalCss, {
+    archive.directory(ctx.client.buildDir, false);
+    archive.file(ctx.client.globalCss, {
       name: "global.css",
     });
   }
 
   for (const fileData of yamlFiles) {
-    _archiver.file(fileData[1], {
+    archive.file(fileData[1], {
       name: fileData[0],
     });
   }
 
-  await _archiver.finalize();
+  await archive.finalize();
 
   return new Promise((resolve, _reject) => {
     output.on("close", resolve);

package/src/types.d.ts

@@ -0,0 +1,3 @@
+declare module "sorcery" {
+  export function load(path: string): Promise<{ write: () => Promise<void> }>;
+}

package/src/utils.test.ts

@@ -40,6 +40,13 @@ vi.mock("fs/promises", () => ({
 describe("utils", () => {
   describe("checkNodeVersion", () => {
     it("should return true if the node version is greater than 14", async () => {
+      vi.mocked(fs.readFile).mockResolvedValue(
+        JSON.stringify({
+          engines: {
+            node: "16.x",
+          },
+        }),
+      );
       const result = await checkNodeVersion();
 
       expect(result).toBe(true);
@@ -51,11 +58,13 @@ describe("utils", () => {
         configurable: true,
       });
 
-      vi.mock("../package.json", () => ({
-        engines: {
-          node: "16.x",
-        },
-      }));
+      vi.mocked(fs.readFile).mockResolvedValue(
+        JSON.stringify({
+          engines: {
+            node: "16.x",
+          },
+        }),
+      );
 
       vi.spyOn(process, "exit").mockImplementation(() => null as never);
 
@@ -66,6 +75,16 @@ describe("utils", () => {
 
       expect(result).toBe(undefined);
     });
+
+    it("should throw an error if the package.json file cannot be read", async () => {
+      vi.spyOn(process, "exit").mockImplementation(() => null as never);
+      vi.mocked(fs.readFile).mockRejectedValue(
+        new Error("Failed to read package.json of core-sdk"),
+      );
+      await expect(checkNodeVersion()).rejects.toThrow(
+        "Failed to read package.json of core-sdk",
+      );
+    });
   });
 
   describe("getArgumentByKey", () => {

package/src/utils.ts

@@ -1,14 +1,24 @@
-const oraP = import("ora");
 import * as fs from "node:fs/promises";
 import { CREDENTIALS_DIR } from "./credentials";
 import path from "node:path";
+import ora from "ora";
 
 export const checkNodeVersion = async () => {
-  const ora = (await oraP).default;
   const spinner = ora("Checking node version...").start();
   const [major, minor] = process.versions.node.split(".").map(Number);
 
-  const packageJson = await import("../package.json");
+  let packageJson;
+  try {
+    packageJson = JSON.parse(
+      await fs.readFile(
+        path.join(import.meta.dirname, "../package.json"),
+        "utf-8",
+      ),
+    );
+  } catch (e) {
+    throw new Error("Failed to read package.json of core-sdk");
+  }
+
   const {
     engines: { node },
   } = packageJson;

package/src/validate.test.ts

@@ -10,6 +10,11 @@ const startMock = {
   fail: vi.fn(),
 };
 
+vi.mock("@embeddable.com/sdk-utils", () => ({
+  errorFormatter: vi.fn(),
+  findFiles: vi.fn(),
+}));
+
 const failMock = vi.fn();
 
 const validYaml = `cubes:

package/src/validate.ts

@@ -2,6 +2,7 @@ import * as fs from "node:fs/promises";
 import * as YAML from "yaml";
 import { errorFormatter, findFiles } from "@embeddable.com/sdk-utils";
 import { z } from "zod";
+import ora from "ora";
 import { checkNodeVersion } from "./utils";
 
 const CUBE_YAML_FILE_REGEX = /^(.*)\.cube\.ya?ml$/;
@@ -10,7 +11,6 @@ const CLIENT_CONTEXT_FILE_REGEX = /^(.*)\.cc\.ya?ml$/;
 
 export default async (ctx: any) => {
   checkNodeVersion();
-  const ora = (await import("ora")).default;
 
   const spinnerValidate = ora("Data model validation...").start();