@embeddable.com/sdk-core 4.0.0-next.0 → 4.0.0-next.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embeddable.com/sdk-core",
-  "version": "4.0.0-next.0",
+  "version": "4.0.0-next.2",
   "description": "Core Embeddable SDK module responsible for web-components bundling and publishing.",
   "keywords": [
     "embeddable",
@@ -41,7 +41,7 @@
   "license": "MIT",
   "dependencies": {
     "@embeddable.com/core": "2.10.4",
-    "@embeddable.com/sdk-utils": "0.8.0",
+    "@embeddable.com/sdk-utils": "0.8.1-next.0",
     "@inquirer/prompts": "^7.2.1",
     "@stencil/core": "^4.23.0",
     "@swc-node/register": "^1.10.9",

package/src/dev.ts

@@ -55,7 +55,8 @@ let previewWorkspace: string;
 
 const SERVER_PORT = 8926;
 const BUILD_DEV_DIR = ".embeddable-dev-build";
-const CUSTOM_CANVAS_CSS = "/custom-canvas.css";
+// NOTE: for backward compatibility, keep the file name as global.css
+const CUSTOM_CANVAS_CSS = "/global.css";
 
 export const buildWebComponent = async (config: any) => {
   await generate(config, "sdk-react");

package/src/push.test.ts

@@ -151,7 +151,7 @@ describe("push", () => {
 
     expect(archiveMock.pipe).toHaveBeenCalled();
     expect(archiveMock.file).toHaveBeenCalledWith("src/custom-canvas.css", {
-      name: "custom-canvas.css",
+      name: "global.css",
     });
     expect(archiveMock.directory).toHaveBeenCalledWith("buildDir", false);
     expect(archiveMock.finalize).toHaveBeenCalled();
@@ -248,10 +248,10 @@ describe("push", () => {
 
       // Should include component build directory
       expect(mockArchiver.directory).toHaveBeenCalled();
-      // Should not include model files (except custom-canvas.css which is part of components)
+      // Should not include model files (except global.css which is part of components)
       expect(mockArchiver.file).toHaveBeenCalledTimes(2);
       expect(mockArchiver.file).toHaveBeenCalledWith(expect.anything(), {
-        name: "custom-canvas.css",
+        name: "global.css",
       });
     });
   });
@@ -452,11 +452,11 @@ describe("push", () => {
         testConfig.client.buildDir,
         false
       );
-      // Should include custom-canvas.css
+      // Should include global.css
       expect(mockArchiver.file).toHaveBeenCalledWith(
         testConfig.client.customCanvasCss,
         {
-          name: "custom-canvas.css",
+          name: "global.css",
         }
       );
       // Should include all model files
@@ -505,11 +505,11 @@ describe("push", () => {
         testConfig.client.buildDir,
         false
       );
-      // Should include custom-canvas.css
+      // Should include global.css
       expect(mockArchiver.file).toHaveBeenCalledWith(
         testConfig.client.customCanvasCss,
         {
-          name: "custom-canvas.css",
+          name: "global.css",
         }
       );
       // Should only find client context files

package/src/push.ts

@@ -36,7 +36,7 @@ export default async () => {
 
     if (!isBuildSuccess && config.pushComponents) {
       console.error(
-        "Build failed or not completed. Please run `embeddable:build` first."
+        "Build failed or not completed. Please run `embeddable:build` first.",
       );
       process.exit(1);
     }
@@ -52,7 +52,7 @@ export default async () => {
             `Authentication failure. Server responded with: "${error.response?.data?.errorMessage}".
 Ensure that your API key is valid for the region specified in the embeddable.config.ts|js file.
 You are using the following region: ${config.region.replace("legacy-", "")} (${config.previewBaseUrl.replace("https://", "")} via ${config.pushBaseUrl})
-Read more about deployment regions at https://docs.embeddable.com/deployment/deployment-regions`
+Read more about deployment regions at https://docs.embeddable.com/deployment/deployment-regions`,
           );
           process.exit(1);
         }
@@ -76,7 +76,7 @@ Read more about deployment regions at https://docs.embeddable.com/deployment/dep
     const { workspaceId, name: workspaceName } = await selectWorkspace(
       ora,
       config,
-      token
+      token,
     );
 
     const workspacePreviewUrl = `${config.previewBaseUrl}/workspace/${workspaceId}`;
@@ -85,7 +85,7 @@ Read more about deployment regions at https://docs.embeddable.com/deployment/dep
     breadcrumbs.push("build archive");
     await buildArchive(config);
     spinnerPushing.info(
-      `Publishing to ${workspaceName} using ${workspacePreviewUrl}...`
+      `Publishing to ${workspaceName} using ${workspacePreviewUrl}...`,
     );
 
     breadcrumbs.push("send build");
@@ -93,7 +93,7 @@ Read more about deployment regions at https://docs.embeddable.com/deployment/dep
 
     publishedSectionFeedback(config, spinnerPushing);
     spinnerPushing.succeed(
-      `Published to ${workspaceName} using ${workspacePreviewUrl}`
+      `Published to ${workspaceName} using ${workspacePreviewUrl}`,
     );
   } catch (error: any) {
     spinnerPushing?.fail("Publishing failed");
@@ -106,7 +106,7 @@ Read more about deployment regions at https://docs.embeddable.com/deployment/dep
 
 const publishedSectionFeedback = (
   config: ResolvedEmbeddableConfig,
-  spinnerPushing: Ora
+  spinnerPushing: Ora,
 ) => {
   config.pushModels && spinnerPushing.succeed("Models published");
   config.pushComponents && spinnerPushing.succeed("Components published");
@@ -115,7 +115,7 @@ const publishedSectionFeedback = (
 async function pushByApiKey(
   config: ResolvedEmbeddableConfig,
   spinner: any,
-  cubeVersion?: string
+  cubeVersion?: string,
 ) {
   const apiKey = getArgumentByKey(["--api-key", "-k"]);
 
@@ -128,7 +128,7 @@ async function pushByApiKey(
 
   if (!email || !/\S+@\S+\.\S+/.test(email)) {
     spinner.fail(
-      "Invalid email provided. Please provide a valid email using --email (-e) flag"
+      "Invalid email provided. Please provide a valid email using --email (-e) flag",
     );
     process.exit(1);
   }
@@ -172,7 +172,7 @@ export async function buildArchive(config: ResolvedEmbeddableConfig) {
 
   if (!config.pushModels && !config.pushComponents) {
     spinnerArchive.fail(
-      "Cannot push: both pushModels and pushComponents are disabled"
+      "Cannot push: both pushModels and pushComponents are disabled",
     );
     process.exit(1);
   }
@@ -182,12 +182,12 @@ export async function buildArchive(config: ResolvedEmbeddableConfig) {
   if (config.pushModels) {
     const cubeFilesList = await findFiles(
       config.client.modelsSrc || config.client.srcDir,
-      CUBE_FILES
+      CUBE_FILES,
     );
 
     const securityContextFilesList = await findFiles(
       config.client.presetsSrc || config.client.srcDir,
-      SECURITY_CONTEXT_FILES
+      SECURITY_CONTEXT_FILES,
     );
 
     filesList.push(
@@ -199,21 +199,21 @@ export async function buildArchive(config: ResolvedEmbeddableConfig) {
       ...securityContextFilesList.map((entry): [string, string] => [
         path.basename(entry[1]),
         entry[1],
-      ])
+      ]),
     );
   }
 
   if (config.pushComponents) {
     const clientContextFilesList = await findFiles(
       config.client.presetsSrc || config.client.srcDir,
-      CLIENT_CONTEXT_FILES
+      CLIENT_CONTEXT_FILES,
     );
 
     filesList.push(
       ...clientContextFilesList.map((entry): [string, string] => [
         path.basename(entry[1]),
         entry[1],
-      ])
+      ]),
     );
   }
 
@@ -240,8 +240,9 @@ export async function archive(args: {
   archive.pipe(output);
   if (!isDev) {
     archive.directory(ctx.client.buildDir, false);
+    // NOTE: for backward compatibility, keep the file name as global.css
     archive.file(ctx.client.customCanvasCss, {
-      name: "custom-canvas.css",
+      name: "global.css",
     });
   }
 
@@ -260,7 +261,7 @@ export async function archive(args: {
 
 export async function createFormData(
   filePath: string,
-  metadata: Record<string, any>
+  metadata: Record<string, any>,
 ) {
   const { FormData, Blob } = await import("formdata-node");
   const { fileFromPath } = await import("formdata-node/file-from-path");
@@ -284,7 +285,7 @@ export async function sendBuildByApiKey(
     email,
     message,
     cubeVersion,
-  }: { apiKey: string; email: string; message?: string; cubeVersion?: string }
+  }: { apiKey: string; email: string; message?: string; cubeVersion?: string },
 ) {
   const form = await createFormData(ctx.client.archiveFile, {
     pushModels: ctx.pushModels,
@@ -297,7 +298,7 @@ export async function sendBuildByApiKey(
   const response = await uploadFile(
     form,
     `${ctx.pushBaseUrl}/api/v1/bundle/upload`,
-    apiKey
+    apiKey,
   );
   await fs.rm(ctx.client.archiveFile);
 
@@ -316,7 +317,7 @@ export async function sendBuild(
     token: string;
     message?: string;
     cubeVersion?: string;
-  }
+  },
 ) {
   const form = await createFormData(ctx.client.archiveFile, {
     pushModels: ctx.pushModels,
@@ -329,7 +330,7 @@ export async function sendBuild(
   await uploadFile(
     form,
     `${ctx.pushBaseUrl}/bundle/${workspaceId}/upload`,
-    token
+    token,
   );
 
   await fs.rm(ctx.client.archiveFile);