@embeddable.com/sdk-core 3.1.4 → 3.1.6

package/lib/push.d.ts

@@ -2,6 +2,11 @@ export declare const YAML_OR_JS_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 sendBuildByApiKey(ctx: any, { apiKey, email, message }: any): Promise<{
+    bundleId: any;
+    email: any;
+    message: any;
+}>;
 export declare function sendBuild(ctx: any, { workspaceId, token }: {
     workspaceId: string;
     token: string;

package/lib/utils.d.ts

@@ -1 +1,8 @@
 export declare const checkNodeVersion: () => Promise<void>;
+/**
+ *  Get the value of a process argument by key
+ *  Example: getArgumentByKey("--email") or getArgumentByKey(["--email", "-e"])
+ * @param key  The key to search for in the process arguments
+ * @returns
+ */
+export declare const getArgumentByKey: (key: string | string[]) => string | undefined;

package/package.json

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

package/src/push.ts

@@ -10,7 +10,7 @@ import reportErrorToRollbar from "./rollbar.mjs";
 
 import { findFiles } from "@embeddable.com/sdk-utils";
 import { getToken } from "./login";
-import { checkNodeVersion } from "./utils";
+import { checkNodeVersion, getArgumentByKey } from "./utils";
 
 // grab .cube.yml|js and .sc.yml|js files
 export const YAML_OR_JS_FILES = /^(.*)\.(cube|sc)\.(ya?ml|js)$/;
@@ -27,34 +27,73 @@ export default async () => {
 
     const token = await verify(config);
 
+    if (process.argv.includes("--api-key") || process.argv.includes("-k")) {
+      spinnerPushing = ora("Using API key...").start();
+      await pushByApiKey(config, spinnerPushing);
+
+      spinnerPushing.succeed("Published using API key");
+
+      return;
+    }
+
     const { workspaceId, name: workspaceName } = await selectWorkspace(
       config,
       token,
     );
 
-    const spinnerArchive = ora("Building...").start();
-
-    const filesList = await findFiles(config.client.srcDir, YAML_OR_JS_FILES);
-
-    await archive(config, filesList);
-    spinnerArchive.succeed("Bundling completed");
+    const workspacePreviewUrl = `${config.previewBaseUrl}/workspace/${workspaceId}`
 
+    await buildArchive(config);
     spinnerPushing = ora(
-      `Publishing to ${workspaceName} using ${config.pushBaseUrl}...`,
+      `Publishing to ${workspaceName} using ${workspacePreviewUrl}...`,
     ).start();
 
     await sendBuild(config, { workspaceId, token });
     spinnerPushing.succeed(
-      `Published to ${workspaceName} using ${config.pushBaseUrl}`,
+      `Published to ${workspaceName} using ${workspacePreviewUrl}`,
     );
   } catch (error: any) {
     spinnerPushing?.fail("Publishing failed");
-    console.error(error.response?.data || error?.message || error);
+    if (error.response?.statusText === "Unauthorized") {
+      console.error("Unauthorized. Please check your credentials.");
+    } else {
+      console.error(error.response?.data || error?.message || error);
+    }
+
     await reportErrorToRollbar(error);
     process.exit(1);
   }
 };
 
+async function pushByApiKey(config: any, spinner: any) {
+  const apiKey = getArgumentByKey(["--api-key", "-k"]);
+
+  if (!apiKey) {
+    spinner.fail("No API key provided");
+    process.exit(1);
+  }
+
+  const email = getArgumentByKey(["--email", "-e"]);
+
+  if (!email || !/\S+@\S+\.\S+/.test(email)) {
+    spinner.fail(
+      "Invalid email provided. Please provide a valid email using --email (-e) flag",
+    );
+    process.exit(1);
+  }
+
+  // message is optional
+  const message = getArgumentByKey(["--message", "-m"]);
+
+  await buildArchive(config);
+
+  return sendBuildByApiKey(config, {
+    apiKey,
+    email,
+    message,
+  });
+}
+
 async function selectWorkspace(ctx: any, token: string) {
   const workspaceSpinner = ora({
     text: `Fetching workspaces using ${ctx.pushBaseUrl}...`,
@@ -112,6 +151,15 @@ async function verify(ctx: any) {
   return token;
 }
 
+async function buildArchive(config: any) {
+  const spinnerArchive = ora("Building...").start();
+
+  const filesList = await findFiles(config.client.srcDir, YAML_OR_JS_FILES);
+
+  await archive(config, filesList);
+  return spinnerArchive.succeed("Bundling completed");
+}
+
 export async function archive(
   ctx: any,
   yamlFiles: [string, string][],
@@ -143,6 +191,37 @@ export async function archive(
   });
 }
 
+export async function sendBuildByApiKey(
+  ctx: any,
+  { apiKey, email, message }: any,
+) {
+  const { FormData, Blob } = 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");
+
+  const metadataBlob = new Blob(
+    [JSON.stringify({ authorEmail: email, description: message })],
+    { type: "application/json" },
+  );
+  form.set("metadata", metadataBlob, "metadata.json");
+
+  const response = await uploadFile(
+    form,
+    `${ctx.pushBaseUrl}/api/v1/bundle/upload`,
+    apiKey,
+  );
+  await fs.rm(ctx.client.archiveFile);
+
+  return { bundleId: response.data?.bundleId, email, message };
+}
+
 export async function sendBuild(
   ctx: any,
   { workspaceId, token }: { workspaceId: string; token: string },
@@ -158,7 +237,17 @@ export async function sendBuild(
   const form = new FormData();
   form.set("file", file, "embeddable-build.zip");
 
-  await axios.post(`${ctx.pushBaseUrl}/bundle/${workspaceId}/upload`, form, {
+  await uploadFile(
+    form,
+    `${ctx.pushBaseUrl}/bundle/${workspaceId}/upload`,
+    token,
+  );
+
+  await fs.rm(ctx.client.archiveFile);
+}
+
+async function uploadFile(formData: any, url: string, token: string) {
+  return axios.post(url, formData, {
     headers: {
       "Content-Type": "multipart/form-data",
       Authorization: `Bearer ${token}`,
@@ -166,8 +255,6 @@ export async function sendBuild(
     maxContentLength: Infinity,
     maxBodyLength: Infinity,
   });
-
-  await fs.rm(ctx.client.archiveFile);
 }
 
 async function getWorkspaces(ctx: any, token: string, workspaceSpinner: any) {

package/src/utils.ts

@@ -22,3 +22,25 @@ export const checkNodeVersion = async () => {
     process.exit(1);
   }
 };
+
+/**
+ *  Get the value of a process argument by key
+ *  Example: getArgumentByKey("--email") or getArgumentByKey(["--email", "-e"])
+ * @param key  The key to search for in the process arguments
+ * @returns
+ */
+export const getArgumentByKey = (key: string | string[]) => {
+  if (Array.isArray(key)) {
+    for (const k of key) {
+      if (process.argv.includes(k)) {
+        const index = process.argv.indexOf(k);
+        return index !== -1 ? process.argv[index + 1] : undefined;
+      }
+    }
+
+    return undefined;
+  }
+
+  const index = process.argv.indexOf(key);
+  return index !== -1 ? process.argv[index + 1] : undefined;
+};

package/src/validate.ts

@@ -75,9 +75,21 @@ export async function dataModelsValidation(filesList: [string, string][]) {
 
     const cube = YAML.parse(fileContentRaw);
 
-    const safeParse = cubeModelSchema.safeParse(cube);
-    if (!safeParse.success) {
-      errorFormatter(safeParse.error.issues).forEach((error) => {
+    if (!cube?.cubes && !cube?.views) {
+      return [`${filePath}: At least one cubes or views must be defined`];
+    }
+
+    const cubeModelSafeParse = cubeModelSchema.safeParse(cube);
+    const viewModelSafeParse = viewModelSchema.safeParse(cube);
+  
+    if (cube.cubes && !cubeModelSafeParse.success) {
+      errorFormatter(cubeModelSafeParse.error.issues).forEach((error) => {
+        errors.push(`${filePath}: ${error}`);
+      });
+    }
+    
+    if (cube.views && !viewModelSafeParse.success) {
+      errorFormatter(viewModelSafeParse.error.issues).forEach((error) => {
         errors.push(`${filePath}: ${error}`);
       });
     }
@@ -172,6 +184,19 @@ const cubeModelSchema = z
     },
   );
 
+const viewModelSchema = z.object({
+  views: z.object({
+    name: z.string(),
+    cubes: z
+      .object({
+        join_path: z.string(),
+      })
+      .array()
+  })
+    .array()
+    .min(1),
+});
+
 const securityContextSchema = z.array(
   z.object({
     name: z.string(),