@embeddable.com/sdk-core 3.2.2 → 3.3.1

package/lib/utils.d.ts

@@ -19,3 +19,4 @@ export declare const removeBuildSuccessFlag: () => Promise<void>;
  * Check if the build was successful
  */
 export declare const checkBuildSuccess: () => Promise<boolean>;
+export declare const getPackageVersion: (packageName: string) => any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embeddable.com/sdk-core",
-  "version": "3.2.2",
+  "version": "3.3.1",
   "description": "Core Embeddable SDK module responsible for web-components bundling and publishing.",
   "keywords": [
     "embeddable",
@@ -41,7 +41,7 @@
     "@swc-node/register": "^1.9.0",
     "archiver": "^5.3.1",
     "axios": "^1.7.2",
-    "chokidar": "^3.5.3",
+    "chokidar": "^3.6.0",
     "finalhandler": "^1.2.0",
     "formdata-node": "^6.0.3",
     "minimist": "^1.2.8",

package/src/buildTypes.ts

@@ -32,14 +32,17 @@ async function generate(ctx: any) {
     .concat(optionsFiles)
     .map(
       ([_fileName, filePath]) =>
-        `import './${path
+        `import '../${path
           .relative(ctx.client.rootDir, filePath)
           .replaceAll("\\", "/")}';`,
     )
     .join("\n");
 
   await fs.writeFile(
-    path.resolve(ctx.client.rootDir, ctx.outputOptions.typesEntryPointFilename),
+    path.resolve(
+      ctx.client.buildDir,
+      ctx.outputOptions.typesEntryPointFilename,
+    ),
     typeImports,
   );
 }
@@ -51,7 +54,7 @@ async function build(ctx: any) {
       emptyOutDir: false,
       lib: {
         entry: path.resolve(
-          ctx.client.rootDir,
+          ctx.client.buildDir,
           ctx.outputOptions.typesEntryPointFilename,
         ),
         formats: ["es"],
@@ -71,6 +74,6 @@ async function build(ctx: any) {
 
 async function cleanup(ctx: any) {
   await fs.rm(
-    path.resolve(ctx.client.rootDir, "embeddable-types-entry-point.js"),
+    path.resolve(ctx.client.buildDir, "embeddable-types-entry-point.js"),
   );
 }

package/src/cleanup.ts

@@ -1,6 +1,7 @@
 import { findFiles } from "@embeddable.com/sdk-utils";
 import * as fs from "node:fs/promises";
 import * as path from "node:path";
+import { getPackageVersion } from "./utils";
 
 export default async (ctx: any) => {
   await extractBuild(ctx);
@@ -10,6 +11,75 @@ export default async (ctx: any) => {
   await moveBuildTOBuildDir(ctx);
 };
 
+type ManifestArgs = {
+  ctx: any;
+  typesFileName: string;
+  metaFileName: string;
+  editorsMetaFileName: string;
+  stencilWrapperFileName: string;
+};
+
+async function createManifest({
+  ctx,
+  typesFileName,
+  metaFileName,
+  editorsMetaFileName,
+  stencilWrapperFileName,
+}: ManifestArgs) {
+  const packageNames = [
+    "@embeddable.com/core",
+    "@embeddable.com/react",
+    "@embeddable.com/sdk-core",
+    "@embeddable.com/sdk-react",
+    "@embeddable.com/sdk-utils",
+  ];
+
+  const sdkVersions = packageNames.reduce<Record<string, string>>(
+    (acc, packageName) => {
+      const version = getPackageVersion(packageName);
+      if (version) {
+        acc[packageName] = version;
+      }
+      return acc;
+    },
+    {},
+  );
+  // identify user's package manager and its version
+  let packageManager = "npm";
+  if (process.env.npm_config_user_agent?.includes("yarn")) {
+    packageManager = "yarn";
+  }
+  if (process.env.npm_config_user_agent?.includes("pnpm")) {
+    packageManager = "pnpm";
+  }
+
+  const packageManagerVersion =
+    process.env.npm_config_user_agent?.match(/(\d+\.\d+\.\d+)/)?.[0] ||
+    "unknown";
+
+  // write manifest file with files with hash
+  const manifest = {
+    entryFiles: {
+      "embeddable-types.js": typesFileName,
+      "embeddable-components-meta.js": metaFileName,
+      "embeddable-editors-meta.js": editorsMetaFileName,
+      "embeddable-wrapper.esm.js": stencilWrapperFileName,
+    },
+    metadata: {
+      nodeVersion: process.version,
+      platform: process.platform,
+      sdkVersions,
+      packageManager,
+      packageManagerVersion,
+    },
+  };
+
+  await fs.writeFile(
+    path.join(ctx.client.tmpDir, "embeddable-manifest.json"),
+    JSON.stringify(manifest),
+  );
+}
+
 async function extractBuild(ctx: any) {
   const [[, stencilWrapperFilePath]] = await findFiles(
     ctx.client.stencilBuild,
@@ -47,20 +117,13 @@ async function extractBuild(ctx: any) {
     path.join(ctx.client.tmpDir, editorsMetaFileName),
   );
 
-  // write manifest file with files with hash
-  const manifest = {
-    entryFiles: {
-      "embeddable-types.js": typesFileName,
-      "embeddable-components-meta.js": metaFileName,
-      "embeddable-editors-meta.js": editorsMetaFileName,
-      "embeddable-wrapper.esm.js": stencilWrapperFileName,
-    },
-  };
-
-  await fs.writeFile(
-    path.join(ctx.client.tmpDir, "embeddable-manifest.json"),
-    JSON.stringify(manifest),
-  );
+  await createManifest({
+    ctx,
+    typesFileName,
+    metaFileName,
+    editorsMetaFileName,
+    stencilWrapperFileName,
+  });
 }
 
 async function removeObsoleteDir(dir: string) {

package/src/dev.ts

@@ -34,13 +34,29 @@ let ora: any;
 let previewWorkspace: string;
 
 const SERVER_PORT = 8926;
+const BUILD_DEV_DIR = ".embeddable-dev-build";
 
 const buildWebComponent = async (config: any) => {
   await generate(config, "sdk-react");
 };
 
+const addToGitingore = async () => {
+  try {
+    const fs = require("fs").promises;
+    const gitignorePath = path.resolve(process.cwd(), ".gitignore");
+    const gitignoreContent = await fs.readFile(gitignorePath, "utf8");
+
+    if (!gitignoreContent.includes(BUILD_DEV_DIR)) {
+      await fs.appendFile(gitignorePath, `\n${BUILD_DEV_DIR}\n`);
+    }
+  } catch (e) {
+    // ignore
+  }
+};
+
 export default async () => {
   checkNodeVersion();
+  addToGitingore();
 
   const http = require("http");
   ora = (await oraP).default;
@@ -50,13 +66,27 @@ export default async () => {
   const logger = createNodeLogger({ process });
   const sys = createNodeSys({ process });
 
+  const defaultConfig = await provideConfig();
+
+  const buildDir = path.resolve(
+    defaultConfig.client.rootDir,
+    ".embeddable-dev-build",
+  );
+
   const config = {
+    ...defaultConfig,
     dev: {
       watch: true,
       logger,
       sys,
     },
-    ...(await provideConfig()),
+    client: {
+      ...defaultConfig.client,
+      buildDir: buildDir,
+      componentDir: path.resolve(buildDir, "component"),
+      stencilBuild: path.resolve(buildDir, "dist", "embeddable-wrapper"),
+      tmpDir: path.resolve(defaultConfig.client.rootDir, ".embeddable-dev-tmp"),
+    },
   };
 
   await prepare(config);

package/src/globalCleanup.ts

@@ -1,19 +1,7 @@
 import * as fsP from "node:fs/promises";
 import * as fs from "node:fs";
-import * as path from "node:path";
 
 export default async (ctx: any) => {
-  const componentsEntryPath = path.resolve(
-    ctx.client.rootDir,
-    ctx.outputOptions.componentsEntryPointFilename,
-  );
-  const typesEntryPath = path.resolve(
-    ctx.client.rootDir,
-    ctx.outputOptions.typesEntryPointFilename,
-  );
-
   if (fs.existsSync(ctx.client.buildDir))
     await fsP.rm(ctx.client.buildDir, { recursive: true });
-  if (fs.existsSync(componentsEntryPath)) await fsP.rm(componentsEntryPath);
-  if (fs.existsSync(typesEntryPath)) await fsP.rm(typesEntryPath);
 };

package/src/utils.ts

@@ -1,6 +1,7 @@
 const oraP = import("ora");
 import * as fs from "node:fs/promises";
 import { CREDENTIALS_DIR } from "./credentials";
+import path from "node:path";
 
 let ora: any;
 export const checkNodeVersion = async () => {
@@ -82,3 +83,18 @@ export const checkBuildSuccess = async () => {
     return false;
   }
 };
+
+export const getPackageVersion = (packageName: string) => {
+  const packageJsonPath = path.join(
+    process.cwd(),
+    "node_modules",
+    packageName,
+    "package.json",
+  );
+  try {
+    const packageJson = require(packageJsonPath);
+    return packageJson.version;
+  } catch (e) {
+    return undefined;
+  }
+};