@embeddable.com/sdk-core 1.0.0 → 2.0.1

package/scripts/build.js

@@ -1,20 +0,0 @@
-const path = require("path");
-const { prepare } = require("./prepare");
-const { generate } = require("./generate");
-const { cleanup } = require("./cleanup");
-const { createContext } = require("./createContext");
-
-async function build(pluginOptions = {}) {
-  const ctx = {
-    ...createContext(path.resolve(__dirname, ".."), process.cwd()),
-    pluginOptions,
-  };
-
-  await prepare(ctx);
-
-  await generate(ctx);
-
-  await cleanup(ctx);
-}
-
-module.exports = { build };

package/scripts/buildTypes.js

@@ -1,61 +0,0 @@
-const fs = require("node:fs/promises");
-const path = require("node:path");
-const vite = require("vite");
-
-const { findEmbFiles } = require("./findEmbFiles");
-
-const EMB_TYPE_FILE_REGEX = /^(.*)\.type\.emb\.[jt]s$/;
-const EMB_OPTIONS_FILE_REGEX = /^(.*)\.options\.emb\.[jt]s$/;
-
-async function buildTypes(ctx) {
-  await generate(ctx);
-
-  await build(ctx);
-
-  await cleanup(ctx);
-}
-
-module.exports = { buildTypes };
-
-async function generate(ctx) {
-  const typeFiles = await findEmbFiles(ctx.client.srcDir, EMB_TYPE_FILE_REGEX);
-  const optionsFiles = await findEmbFiles(
-    ctx.client.srcDir,
-    EMB_OPTIONS_FILE_REGEX,
-  );
-
-  const typeImports = typeFiles
-    .concat(optionsFiles)
-    .map(
-      ([fileName, filePath]) =>
-        `import './${path.relative(ctx.client.rootDir, filePath)}';`,
-    )
-    .join("\n");
-
-  await fs.writeFile(
-    path.resolve(ctx.client.rootDir, ctx.outputOptions.typesEntryPointFilename),
-    typeImports,
-  );
-}
-
-async function build(ctx) {
-  process.chdir(ctx.client.rootDir);
-
-  await vite.build({
-    build: {
-      emptyOutDir: false,
-      lib: {
-        entry: `./${ctx.outputOptions.typesEntryPointFilename}`,
-        formats: ["es"],
-        fileName: "embeddable-types",
-      },
-      outDir: ".embeddable-build/",
-    },
-  });
-}
-
-async function cleanup(ctx) {
-  await fs.rm(
-    path.resolve(ctx.client.rootDir, "embeddable-types-entry-point.js"),
-  );
-}

package/scripts/cleanup.js

@@ -1,27 +0,0 @@
-const fs = require("fs/promises");
-const path = require("path");
-
-async function cleanup(ctx) {
-  await extractBuild(ctx);
-
-  await removeObsoleteDir(ctx.client.buildDir);
-
-  await moveBuildTOBuildDir(ctx);
-}
-
-module.exports = { cleanup };
-
-async function extractBuild(ctx) {
-  await fs.rename(
-    path.resolve(ctx.client.buildDir, ctx.client.stencilBuild),
-    ctx.client.tmpDir,
-  );
-}
-
-async function removeObsoleteDir(dir) {
-  await fs.rm(dir, { recursive: true });
-}
-
-async function moveBuildTOBuildDir(ctx) {
-  await fs.rename(ctx.client.tmpDir, ctx.client.buildDir);
-}

package/scripts/createContext.js

@@ -1,27 +0,0 @@
-const path = require("path");
-
-function createContext(coreRoot, clientRoot) {
-  return {
-    core: {
-      rootDir: coreRoot,
-      templatesDir: path.resolve(coreRoot, "templates"),
-      configsDir: path.resolve(coreRoot, "configs"),
-    },
-    client: {
-      rootDir: clientRoot,
-      buildDir: path.resolve(clientRoot, ".embeddable-build"),
-      srcDir: path.resolve(clientRoot, "src"),
-      tmpDir: path.resolve(clientRoot, ".embeddable-tmp"),
-      componentDir: path.resolve(clientRoot, ".embeddable-build", "component"),
-      stencilBuild: path.resolve(
-        clientRoot,
-        ".embeddable-build",
-        "dist",
-        "embeddable-wrapper",
-      ),
-      archiveFile: path.resolve(clientRoot, "embeddable-build.zip"),
-    },
-  };
-}
-
-module.exports = { createContext };

package/scripts/findEmbFiles.js

@@ -1,32 +0,0 @@
-const fs = require("fs/promises");
-const path = require("path");
-
-async function findEmbFiles(initialSrcDir, regex) {
-  const filesList = [];
-
-  async function findEmbFilesRec(srcDir) {
-    const allFiles = await fs.readdir(srcDir);
-
-    for (const file of allFiles) {
-      const filePath = path.join(srcDir, file);
-
-      const status = await fs.lstat(filePath);
-
-      if (status.isDirectory()) {
-        await findEmbFilesRec(filePath);
-      }
-
-      const fileName = file.match(regex);
-
-      if (fileName) {
-        filesList.push([fileName[1], filePath]);
-      }
-    }
-  }
-
-  await findEmbFilesRec(initialSrcDir);
-
-  return filesList;
-}
-
-module.exports = { findEmbFiles };

package/scripts/generate.js

@@ -1,72 +0,0 @@
-const fs = require("fs/promises");
-const path = require("path");
-
-const stencilNodeApi = require("@stencil/core/sys/node");
-const stencil = require("@stencil/core/cli");
-
-const STYLE_IMPORTS_TOKEN = "{{STYLES_IMPORT}}";
-const RENDER_IMPORT_TOKEN = "{{RENDER_IMPORT}}";
-
-const NODE_LOGGER = stencilNodeApi.createNodeLogger({ process: process });
-const NODE_SYS = stencilNodeApi.createNodeSys({
-  process: process,
-  logger: NODE_LOGGER,
-});
-
-async function generate(ctx) {
-  await injectCSS(ctx);
-
-  await injectBundleRender(ctx);
-
-  await runStencil(ctx);
-}
-
-module.exports = { generate };
-
-async function injectCSS(ctx) {
-  const CUSTOMER_BUILD = path.resolve(
-    ctx.client.buildDir,
-    ctx.pluginOptions.outDir,
-  );
-  const allFiles = await fs.readdir(CUSTOMER_BUILD);
-
-  const cssFilesImportsStr = allFiles
-    .filter((fileName) => fileName.endsWith(".css"))
-    .map((fileName) => `@import '../${ctx.pluginOptions.outDir}/${fileName}';`)
-    .join("\n");
-
-  const content = await fs.readFile(
-    path.resolve(ctx.core.templatesDir, "style.css.template"),
-    "utf8",
-  );
-
-  await fs.writeFile(
-    path.resolve(ctx.client.componentDir, "style.css"),
-    content.replace(STYLE_IMPORTS_TOKEN, cssFilesImportsStr),
-  );
-}
-
-async function injectBundleRender(ctx) {
-  const importStr = `import render from '../${ctx.pluginOptions.outDir}/${ctx.pluginOptions.renderFunctionFileName}';`;
-
-  const content = await fs.readFile(
-    path.resolve(ctx.core.templatesDir, "component.tsx.template"),
-    "utf8",
-  );
-
-  await fs.writeFile(
-    path.resolve(ctx.client.componentDir, "component.tsx"),
-    content.replace(RENDER_IMPORT_TOKEN, importStr),
-  );
-}
-
-async function runStencil(ctx) {
-  process.chdir(ctx.client.buildDir);
-
-  await stencil.run({
-    args: ["build"],
-    logger: NODE_LOGGER,
-    sys: NODE_SYS,
-    checkVersion: stencilNodeApi.checkVersion,
-  });
-}

package/scripts/globalCleanup.js

@@ -1,13 +0,0 @@
-const fsP = require("node:fs/promises");
-const fs = require("node:fs")
-const path = require("node:path");
-async function globalCleanup(ctx) {
-    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);
-}
-
-module.exports = { globalCleanup };

package/scripts/index.js

@@ -1,17 +0,0 @@
-const { build } = require("./build");
-const { buildTypes } = require("./buildTypes");
-const { findEmbFiles } = require("./findEmbFiles");
-const { login } = require("./login");
-const { push } = require("./push");
-const { validate } = require("./validate");
-const { globalCleanup } = require("./globalCleanup");
-
-module.exports = {
-  build,
-  buildTypes,
-  findEmbFiles,
-  login,
-  push,
-  validate,
-  globalCleanup,
-};

package/scripts/login.js

@@ -1,93 +0,0 @@
-const path = require("path");
-const os = require("os");
-const fs = require("fs/promises");
-const axios = require("axios");
-const oraP = import("ora");
-const openP = import("open");
-
-const CREDENTIALS_DIR = path.resolve(os.homedir(), ".embeddable");
-const CREDENTIALS_FILE = path.resolve(CREDENTIALS_DIR, "credentials");
-
-const AUTH0_DOMAIN = "embeddable-dev.eu.auth0.com";
-const AUTH0_CLIENT_ID = "xOKco5ztFCpWn54bJbFkAcT8mV4LLcpG";
-
-async function login() {
-  const ora = (await oraP).default;
-  const open = (await openP).default
-
-  await resolveFiles();
-
-  const deviceCodePayload = {
-    client_id: AUTH0_CLIENT_ID,
-    audience: "https://api.embeddable.com/",
-  };
-
-  const deviceCodeResponse = await axios.post(
-    `https://${AUTH0_DOMAIN}/oauth/device/code`,
-    deviceCodePayload,
-  );
-
-  const tokenPayload = {
-    grant_type: "urn:ietf:params:oauth:grant-type:device_code",
-    device_code: deviceCodeResponse.data["device_code"],
-    client_id: AUTH0_CLIENT_ID,
-  };
-
-  const authenticationSpinner = ora("waiting for code verification...").start();
-
-  await open(deviceCodeResponse.data["verification_uri_complete"]);
-
-  /**
-   * This is a recommended way to poll, since it take some time for a user to enter a `user_code` in a browser.
-   * deviceCodeResponse.data['interval'] is a recommended/calculated polling interval specified in seconds.
-   */
-  while (true) {
-    try {
-      const tokenResponse = await axios.post(
-        `https://${AUTH0_DOMAIN}/oauth/token`,
-        tokenPayload,
-      );
-      await fs.writeFile(CREDENTIALS_FILE, JSON.stringify(tokenResponse.data));
-      authenticationSpinner.succeed("you are successfully authenticated now!");
-      break;
-    } catch (e) {
-      if (e.response.data?.error !== "authorization_pending") {
-        authenticationSpinner.fail("authentication failed. please try again.");
-        process.exit(1);
-      }
-
-      await sleep(deviceCodeResponse.data["interval"] * 1000);
-    }
-  }
-}
-
-async function getToken() {
-  try {
-    const rawCredentials = await fs.readFile(CREDENTIALS_FILE, "utf-8");
-    const credentials = JSON.parse(rawCredentials.toString());
-
-    return credentials?.access_token ?? "";
-  } catch (_e) {
-    return "";
-  }
-}
-
-module.exports = { login, getToken };
-
-function sleep(ms) {
-  return new Promise((res) => setTimeout(res, ms));
-}
-
-async function resolveFiles() {
-  try {
-    await fs.access(CREDENTIALS_DIR);
-  } catch (_e) {
-    await fs.mkdir(CREDENTIALS_DIR);
-  }
-
-  try {
-    await fs.access(CREDENTIALS_FILE);
-  } catch (e) {
-    await fs.writeFile(CREDENTIALS_FILE, "");
-  }
-}

package/scripts/prepare.js

@@ -1,27 +0,0 @@
-const fsSync = require("fs");
-const fs = require("fs/promises");
-
-async function prepare(ctx) {
-  await removeIfExists(ctx);
-
-  await copyStencilConfigsToClient(ctx);
-
-  await createComponentDir(ctx.client.componentDir);
-}
-
-module.exports = { prepare };
-
-async function removeIfExists(ctx) {
-  if (ctx.pluginOptions) return;
-
-  if (fsSync.existsSync(ctx.client.buildDir))
-    await fs.rm(ctx.client.buildDir, { recursive: true });
-}
-
-async function copyStencilConfigsToClient(ctx) {
-  await fs.cp(ctx.core.configsDir, ctx.client.buildDir, { recursive: true });
-}
-
-async function createComponentDir(dir) {
-  await fs.mkdir(dir);
-}

package/scripts/push.js

@@ -1,153 +0,0 @@
-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 inquirerSelect = import("@inquirer/select");
-
-const { findEmbFiles } = require("./findEmbFiles");
-const { createContext } = require("./createContext");
-const { getToken } = require("./login");
-
-const EMB_YAML_FILE_REGEX = /^(.*)\.emb\.ya?ml$/;
-
-let ora;
-async function push() {
-  ora = (await oraP).default;
-
-  const ctx = createContext(path.resolve(__dirname, ".."), process.cwd());
-
-  const token = await verify(ctx);
-
-  const { workspaceId, workspaceName } = await selectWorkspace(token);
-
-  const spinnerArchive = ora("archivation...").start();
-
-  const filesList = await findEmbFiles(ctx.client.srcDir, EMB_YAML_FILE_REGEX);
-
-  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 };
-
-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;
-}
-
-function archive(ctx, yamlFiles) {
-  const output = fsSync.createWriteStream(ctx.client.archiveFile);
-  const _archiver = archiver("zip", {
-    zlib: { level: 9 },
-  });
-
-  _archiver.pipe(output);
-  _archiver.directory(ctx.client.buildDir, false);
-
-  for (const fileData of yamlFiles) {
-    _archiver.file(fileData[1], { name: `${fileData[0]}.emb.yaml` });
-  }
-
-  _archiver.finalize();
-
-  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 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

@@ -1,66 +0,0 @@
-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;
-}