@embeddable.com/sdk-core 0.2.0 → 1.0.0

package/scripts/push.js

@@ -1,97 +1,153 @@
-const fs= require("fs/promises");
-const fsSync= require("fs");
+const fs = require("fs/promises");
+const fsSync = require("fs");
 const path = require("path");
-const archiver = require('archiver');
-const axios = require('axios');
-const oraP = import('ora');
+const archiver = require("archiver");
+const axios = require("axios");
+const oraP = import("ora");
+const inquirerSelect = import("@inquirer/select");
 
-const { findEmbFiles } = require('./findEmbFiles');
+const { findEmbFiles } = require("./findEmbFiles");
 const { createContext } = require("./createContext");
-const { getToken } = require('./login');
+const { getToken } = require("./login");
 
 const EMB_YAML_FILE_REGEX = /^(.*)\.emb\.ya?ml$/;
 
-async function push () {
-    const ora = (await oraP).default;
+let ora;
+async function push() {
+  ora = (await oraP).default;
 
-    const ctx = createContext(path.resolve(__dirname, '..'), process.cwd());
+  const ctx = createContext(path.resolve(__dirname, ".."), process.cwd());
 
-    const token = await verify(ctx);
+  const token = await verify(ctx);
 
-    const spinnerArchive = ora("archivation...").start();
+  const { workspaceId, workspaceName } = await selectWorkspace(token);
 
-    const filesList = await findEmbFiles(ctx.client.srcDir, EMB_YAML_FILE_REGEX);
+  const spinnerArchive = ora("archivation...").start();
 
-    await archive(ctx, filesList);
-    spinnerArchive.succeed("archivation competed");
+  const filesList = await findEmbFiles(ctx.client.srcDir, EMB_YAML_FILE_REGEX);
 
-    const spinnerPushing = ora("publishing...").start();
-    await sendBuild(ctx, token);
-    spinnerPushing.succeed("published!");
+  await archive(ctx, filesList);
+  spinnerArchive.succeed("archivation competed");
+
+  const spinnerPushing = ora("publishing...").start();
+
+  await sendBuild(ctx, { workspaceId, token });
+  spinnerPushing.succeed(`published to ${workspaceName}`);
 }
 
-module.exports = { push }
+module.exports = { push };
+
+async function selectWorkspace(token) {
+  const workspaceSpinner = ora({
+    text: "Fetching workspaces...",
+    color: "green",
+    discardStdin: false,
+  }).start();
+
+  const availableWorkspaces = await getWorkspaces(token);
+
+  let selectedWorkspace;
+
+  if (availableWorkspaces.length === 0) {
+    workspaceSpinner.fail("No workspaces found");
+    process.exit(1);
+  }
+
+  workspaceSpinner.info(`Found ${availableWorkspaces.length} workspace(s)`);
+
+  if (availableWorkspaces.length === 1) {
+    selectedWorkspace = availableWorkspaces[0];
+  } else {
+    const select = (await inquirerSelect).default;
+    selectedWorkspace = await select({
+      message: "Select workspace to push changes",
+      choices: availableWorkspaces.map((workspace) => ({
+        name: `${workspace.name} (${workspace.workspaceId})`,
+        value: workspace,
+      })),
+    });
+  }
+
+  workspaceSpinner.succeed(`Workspace: ${selectedWorkspace.name} (${selectedWorkspace.workspaceId})`);
+
+  return selectedWorkspace;
+}
 
 async function verify(ctx) {
-    try {
-        await fs.access(ctx.client.buildDir);
-    } catch (_e) {
-        console.error('No embeddable build was produced.');
-        process.exit(1);
-    }
-
-    // TODO: initiate login if no/invalid token.
-    const token = await getToken();
-
-    if (!token) {
-        console.error('Expired token. Please login again.');
-        process.exit(1);
-    }
-
-    return token;
+  try {
+    await fs.access(ctx.client.buildDir);
+  } catch (_e) {
+    console.error("No embeddable build was produced.");
+    process.exit(1);
+  }
+
+  // TODO: initiate login if no/invalid token.
+  const token = await getToken();
+
+  if (!token) {
+    console.error("Expired token. Please login again.");
+    process.exit(1);
+  }
+
+  return token;
 }
 
 function archive(ctx, yamlFiles) {
-    const output = fsSync.createWriteStream(ctx.client.archiveFile);
-    const _archiver = archiver('zip', {
-        zlib: { level: 9 }
-    });
+  const output = fsSync.createWriteStream(ctx.client.archiveFile);
+  const _archiver = archiver("zip", {
+    zlib: { level: 9 },
+  });
+
+  _archiver.pipe(output);
+  _archiver.directory(ctx.client.buildDir, false);
 
-    _archiver.pipe(output);
-    _archiver.directory(ctx.client.buildDir, false);
+  for (const fileData of yamlFiles) {
+    _archiver.file(fileData[1], { name: `${fileData[0]}.emb.yaml` });
+  }
 
-    for (const fileData of yamlFiles) {
-        _archiver.file(fileData[1], { name: `${fileData[0]}.emb.yaml` })
-    }
+  _archiver.finalize();
 
-    _archiver.finalize();
+  return new Promise((resolve, _reject) => {
+    output.on("close", resolve);
+  });
+}
 
-    return new Promise((resolve, _reject) => {
-        output.on('close', resolve);
-    })
+async function sendBuild(ctx, { workspaceId, token }) {
+  const { FormData } = await import("formdata-node");
+  const { fileFromPath } = await import("formdata-node/file-from-path");
+
+  const file = await fileFromPath(
+    ctx.client.archiveFile,
+    "embeddable-build.zip",
+  );
+
+  const form = new FormData();
+  form.set("file", file, "embeddable-build.zip");
+  form.set("workspaceId", workspaceId);
+
+  await axios.post("https://metadata.embeddable.com/sdk/upload-files", form, {
+    headers: {
+      "Content-Type": "multipart/form-data",
+      Authorization: `Bearer ${token}`,
+    },
+    maxContentLength: Infinity,
+    maxBodyLength: Infinity,
+  });
+
+  await fs.rm(ctx.client.archiveFile);
 }
 
-async function sendBuild(ctx, token) {
-    const {FormData} = await import("formdata-node");
-    const {fileFromPath} = await import("formdata-node/file-from-path");
-
-    const file = await fileFromPath(ctx.client.archiveFile, "embeddable-build.zip");
-
-    const form = new FormData();
-    form.set('file', file, 'embeddable-build.zip');
-
-    await axios.post(
-        'https://metadata.embeddable.com/sdk/upload-files',
-        form,
-        {
-            headers: {
-                "Content-Type": "multipart/form-data",
-                "Authorization" : `Bearer ${token}`
-            },
-            maxContentLength: Infinity,
-            maxBodyLength: Infinity
-        }
-    );
-
-    await fs.rm(ctx.client.archiveFile);
-}
+async function getWorkspaces(token) {
+  try {
+    return axios
+      .get("https://api.embeddable.com/workspace", {
+        headers: {
+          Authorization: `Bearer ${token}`,
+        },
+      })
+      .then((res) => res.data);
+  } catch (e) {
+    console.error(e);
+    return [];
+  }
+}

package/scripts/validate.js

@@ -0,0 +1,66 @@
+const fs = require("node:fs/promises");
+const oraP = import("ora");
+const YAML = require("yaml");
+const { findEmbFiles } = require("./findEmbFiles");
+
+const EMB_YAML_FILE_REGEX = /^(.*)\.emb\.ya?ml$/;
+
+async function validate(ctx) {
+  const ora = (await oraP).default;
+
+  const spinnerValidate = ora("validation...").start();
+
+  const filesList = await findEmbFiles(ctx.client.srcDir, EMB_YAML_FILE_REGEX);
+
+  const componentConfigErrors = await componentConfigValidation(filesList);
+
+  if (componentConfigErrors.length) {
+    spinnerValidate.fail("One or more component.emb.yaml files are invalid:");
+
+    componentConfigErrors.forEach((errorMessage) =>
+      spinnerValidate.info(errorMessage),
+    );
+
+    process.exit(1);
+  }
+
+  spinnerValidate.succeed("validation completed");
+}
+
+module.exports = { validate };
+
+async function componentConfigValidation(filesList) {
+  const ARRAY_ALLOWED_TYPES = ["Dimension", "Measure"];
+  const errors = [];
+
+  for (const [fileName, filePath] of filesList) {
+    if (!fileName.endsWith(".component")) continue;
+
+    const fileContentRaw = await fs.readFile(filePath, "utf8");
+
+    const config = YAML.parse(fileContentRaw);
+
+    if (!("inputs" in config) || config.inputs.length === 0) continue;
+
+    config.inputs
+      .filter((inputConfig) => inputConfig?.array)
+      .forEach((inputConfig) => {
+        if (!ARRAY_ALLOWED_TYPES.includes(inputConfig?.type)) {
+          const errorMessage = `${fileName} contains invalid type value for \x1b[33m${
+            inputConfig.name
+          }\x1b[0m input.
+\x1b[33m${
+            inputConfig.name
+          }\x1b[0m is marked as \x1b[33marray\x1b[0m. Inputs marked as array support the following types: ${ARRAY_ALLOWED_TYPES.join(
+            ", ",
+          )}.
+Specified \x1b[33m${inputConfig?.type}\x1b[0m type is not supported.
+Please check the following file: \x1b[33m${filePath}\x1b[0m\n`;
+
+          errors.push(errorMessage);
+        }
+      });
+  }
+
+  return errors;
+}