@embeddable.com/sdk-core 3.7.0 → 3.7.2

package/lib/push.d.ts

@@ -1,7 +1,8 @@
 export declare const YAML_OR_JS_FILES: RegExp;
+export declare const SELF_SERVE_CUSTOM_FILES: RegExp;
 declare const _default: () => Promise<void>;
 export default _default;
-export declare function archive(ctx: any, yamlFiles: [string, string][], includeBuild?: boolean): Promise<unknown>;
+export declare function archive(ctx: any, yamlFiles: [string, string][], selfServeFiles?: [string, string][], includeBuild?: boolean): Promise<unknown>;
 export declare function sendBuildByApiKey(ctx: any, { apiKey, email, message }: any): Promise<{
     bundleId: any;
     email: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embeddable.com/sdk-core",
-  "version": "3.7.0",
+  "version": "3.7.2",
   "description": "Core Embeddable SDK module responsible for web-components bundling and publishing.",
   "keywords": [
     "embeddable",

package/src/defineConfig.test.ts

@@ -56,6 +56,7 @@ describe("defineConfig", () => {
           "modelsSrc": "/embeddable-sdk/packages/core-sdk",
           "rollupOptions": {},
           "rootDir": "/embeddable-sdk/packages/core-sdk",
+          "selfServeCustomizationDir": "/embeddable-sdk/packages/core-sdk",
           "srcDir": "/embeddable-sdk/packages/core-sdk",
           "stencilBuild": "/embeddable-sdk/packages/core-sdk",
           "tmpDir": "/embeddable-sdk/packages/core-sdk",

package/src/defineConfig.ts

@@ -19,6 +19,7 @@ export type EmbeddableConfig = {
   previewBaseUrl?: string;
   componentsSrc?: string;
   modelsSrc?: string;
+  selfServeCustomizationSrc?: string;
   viteConfig?: {
     resolve?: {
       alias?: Record<string, string>;
@@ -39,6 +40,7 @@ export default ({
   previewBaseUrl,
   modelsSrc = "src",
   componentsSrc = "src",
+  selfServeCustomizationSrc = "src/self-serve-customization",
   viteConfig = {},
   rollupOptions = {},
 }: EmbeddableConfig) => {
@@ -75,6 +77,10 @@ export default ({
       modelsSrc: modelsSrc ? path.resolve(clientRoot, modelsSrc) : undefined,
       buildDir: path.resolve(clientRoot, ".embeddable-build"),
       tmpDir: path.resolve(clientRoot, ".embeddable-tmp"),
+      selfServeCustomizationDir: path.resolve(
+        clientRoot,
+        selfServeCustomizationSrc,
+      ),
       componentDir: path.resolve(clientRoot, ".embeddable-build", "component"),
       stencilBuild: path.resolve(
         clientRoot,

package/src/dev.ts

@@ -36,6 +36,7 @@ let previewWorkspace: string;
 
 const SERVER_PORT = 8926;
 const BUILD_DEV_DIR = ".embeddable-dev-build";
+const SELF_SERVE_CUSTOMIZATION_REQUEST_URL = "/self-serve-customization";
 
 const buildWebComponent = async (config: any) => {
   await generate(config, "sdk-react");
@@ -93,6 +94,7 @@ export default async () => {
   const serveStatic = require("serve-static");
 
   const serve = serveStatic(config.client.buildDir);
+  const serveSelfeServe = serveStatic(config.client.selfServeCustomizationDir);
 
   const workspacePreparation = ora("Preparing workspace...").start();
 
@@ -125,7 +127,19 @@ export default async () => {
       }
 
       const done = finalhandler(request, res);
-      serve(request, res, done);
+
+      const selectedServe = request.url?.startsWith(
+        SELF_SERVE_CUSTOMIZATION_REQUEST_URL,
+      )
+        ? serveSelfeServe
+        : serve;
+
+      request.url = request.url?.replace(
+        SELF_SERVE_CUSTOMIZATION_REQUEST_URL,
+        "",
+      );
+
+      selectedServe(request, res, done);
     },
   );
   wss = new WebSocketServer({ server });
@@ -165,7 +179,10 @@ export default async () => {
 
     const dataModelAndSecurityContextWatch =
       dataModelAndSecurityContextWatcher(config);
+
+    const customSelfServeWatch = customSelfServeWatcher(config);
     watchers.push(dataModelAndSecurityContextWatch);
+    watchers.push(customSelfServeWatch);
   });
 };
 
@@ -237,6 +254,24 @@ const dataModelAndSecurityContextWatcher = (ctx: any): FSWatcher => {
   return fsWatcher;
 };
 
+const customSelfServeWatcher = (ctx: any): FSWatcher => {
+  const fsWatcher = chokidar.watch(
+    [
+      path.resolve(ctx.client.selfServeCustomizationDir, "style.css"),
+      path.resolve(ctx.client.selfServeCustomizationDir, "*.svg"),
+    ],
+    {
+      ignoreInitial: true,
+    },
+  );
+
+  fsWatcher.on("all", async () => {
+    sendMessage("customSelfServeUpdateSuccess");
+  });
+
+  return fsWatcher;
+};
+
 const sendDataModelsAndSecurityContextsChanges = async (ctx: any) => {
   sendMessage("dataModelsAndOrSecurityContextUpdateStart");
   const isValid = await validate(ctx, false);
@@ -253,7 +288,7 @@ const sendDataModelsAndSecurityContextsChanges = async (ctx: any) => {
       path.resolve(ctx.client.buildDir, "embeddable-manifest.json"),
     ]);
 
-    await archive(ctx, filesList, false);
+    await archive(ctx, filesList, [], false);
     await sendBuild(ctx, { workspaceId: previewWorkspace, token });
     sending.succeed(`Data models and/or security context synchronized`);
     sendMessage("dataModelsAndOrSecurityContextUpdateSuccess");

package/src/push.ts

@@ -15,6 +15,11 @@ import { checkBuildSuccess, checkNodeVersion, getArgumentByKey } from "./utils";
 // grab .cube.yml|js and .sc.yml|js files
 export const YAML_OR_JS_FILES = /^(.*)\.(cube|sc)\.(ya?ml|js)$/;
 
+// grab all files in self-serve-customization folder
+export const SELF_SERVE_CUSTOM_FILES = /^(style\.css|.*\.svg)$/;
+
+const customSelfServeFolder = "self-serve-customization/";
+
 let ora: any;
 export default async () => {
   let spinnerPushing;
@@ -170,13 +175,25 @@ async function buildArchive(config: any) {
     YAML_OR_JS_FILES,
   );
 
-  await archive(config, filesList);
+  let selfServeFiles: [string, string][] = [];
+
+  // check existance of self-serve-customization folder
+  try {
+    await fs.access(config.client.selfServeCustomizationDir);
+    selfServeFiles = await findFiles(
+      `${config.client.selfServeCustomizationDir}`,
+      SELF_SERVE_CUSTOM_FILES,
+    );
+  } catch (e: any) {}
+
+  await archive(config, filesList, selfServeFiles);
   return spinnerArchive.succeed("Bundling completed");
 }
 
 export async function archive(
   ctx: any,
   yamlFiles: [string, string][],
+  selfServeFiles: [string, string][] = [],
   includeBuild: boolean = true,
 ) {
   const output = fsSync.createWriteStream(ctx.client.archiveFile);
@@ -198,6 +215,16 @@ export async function archive(
     });
   }
 
+  if (selfServeFiles.length > 0) {
+    for (const fileData of selfServeFiles) {
+      const fileName = fileData[1].split("/").pop();
+
+      _archiver.file(fileData[1], {
+        name: `${customSelfServeFolder}${fileName!}`,
+      });
+    }
+  }
+
   await _archiver.finalize();
 
   return new Promise((resolve, _reject) => {