@embeddable.com/sdk-core 3.13.0-next.1 → 3.13.0-next.3

package/lib/defineConfig.d.ts

@@ -1,4 +1,5 @@
 import { RollupOptions } from "rollup";
+import { z } from "zod";
 export type Region = "EU" | "US" | "legacy-US";
 export type EmbeddableConfig = {
     plugins: (() => {
@@ -7,6 +8,8 @@ export type EmbeddableConfig = {
         cleanup: (config: EmbeddableConfig) => Promise<unknown>;
         validate: (config: EmbeddableConfig) => Promise<unknown>;
     })[];
+    pushModels?: boolean;
+    pushComponents?: boolean;
     pushBaseUrl?: string;
     audienceUrl?: string;
     authDomain?: string;
@@ -27,7 +30,129 @@ export type EmbeddableConfig = {
     rollupOptions?: RollupOptions;
     region?: Region;
 };
-declare const _default: ({ plugins, region, pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc, presetsSrc, componentsSrc, globalCss, viteConfig, rollupOptions, }: EmbeddableConfig) => {
+export type ResolvedEmbeddableConfig = {
+    core: {
+        rootDir: string;
+        templatesDir: string;
+        configsDir: string;
+    };
+    client: {
+        rootDir: string;
+        srcDir: string;
+        modelsSrc?: string;
+        presetsSrc?: string;
+        buildDir: string;
+        tmpDir: string;
+        globalCss: string;
+        componentDir: string;
+        stencilBuild: string;
+        archiveFile: string;
+        errorFallbackComponent?: string;
+        bundleHash?: string;
+        viteConfig: {
+            resolve?: {
+                alias?: Record<string, string>;
+            };
+        };
+        rollupOptions: RollupOptions;
+    };
+    outputOptions: {
+        typesEntryPointFilename: string;
+    };
+    pushModels: boolean;
+    pushComponents: boolean;
+    pushBaseUrl: string;
+    audienceUrl: string;
+    previewBaseUrl: string;
+    authDomain: string;
+    authClientId: string;
+    applicationEnvironment: string;
+    rollbarAccessToken: string;
+    plugins: EmbeddableConfig["plugins"];
+};
+export declare const embeddableConfigSchema: z.ZodObject<{
+    plugins: z.ZodArray<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>, "many">;
+    region: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"EU">, z.ZodLiteral<"US">, z.ZodLiteral<"legacy-US">]>>;
+    pushModels: z.ZodOptional<z.ZodBoolean>;
+    pushComponents: z.ZodOptional<z.ZodBoolean>;
+    pushBaseUrl: z.ZodOptional<z.ZodString>;
+    audienceUrl: z.ZodOptional<z.ZodString>;
+    authDomain: z.ZodOptional<z.ZodString>;
+    authClientId: z.ZodOptional<z.ZodString>;
+    errorFallbackComponent: z.ZodOptional<z.ZodString>;
+    applicationEnvironment: z.ZodOptional<z.ZodString>;
+    rollbarAccessToken: z.ZodOptional<z.ZodString>;
+    previewBaseUrl: z.ZodOptional<z.ZodString>;
+    modelsSrc: z.ZodOptional<z.ZodString>;
+    presetsSrc: z.ZodOptional<z.ZodString>;
+    componentsSrc: z.ZodOptional<z.ZodString>;
+    globalCss: z.ZodOptional<z.ZodString>;
+    viteConfig: z.ZodOptional<z.ZodObject<{
+        resolve: z.ZodOptional<z.ZodObject<{
+            alias: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            alias: Record<string, string>;
+        }, {
+            alias: Record<string, string>;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        resolve?: {
+            alias: Record<string, string>;
+        } | undefined;
+    }, {
+        resolve?: {
+            alias: Record<string, string>;
+        } | undefined;
+    }>>;
+    rollupOptions: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+}, "strict", z.ZodTypeAny, {
+    plugins: ((...args: unknown[]) => unknown)[];
+    region?: "EU" | "US" | "legacy-US" | undefined;
+    pushModels?: boolean | undefined;
+    pushComponents?: boolean | undefined;
+    pushBaseUrl?: string | undefined;
+    audienceUrl?: string | undefined;
+    authDomain?: string | undefined;
+    authClientId?: string | undefined;
+    errorFallbackComponent?: string | undefined;
+    applicationEnvironment?: string | undefined;
+    rollbarAccessToken?: string | undefined;
+    previewBaseUrl?: string | undefined;
+    modelsSrc?: string | undefined;
+    presetsSrc?: string | undefined;
+    componentsSrc?: string | undefined;
+    globalCss?: string | undefined;
+    viteConfig?: {
+        resolve?: {
+            alias: Record<string, string>;
+        } | undefined;
+    } | undefined;
+    rollupOptions?: {} | undefined;
+}, {
+    plugins: ((...args: unknown[]) => unknown)[];
+    region?: "EU" | "US" | "legacy-US" | undefined;
+    pushModels?: boolean | undefined;
+    pushComponents?: boolean | undefined;
+    pushBaseUrl?: string | undefined;
+    audienceUrl?: string | undefined;
+    authDomain?: string | undefined;
+    authClientId?: string | undefined;
+    errorFallbackComponent?: string | undefined;
+    applicationEnvironment?: string | undefined;
+    rollbarAccessToken?: string | undefined;
+    previewBaseUrl?: string | undefined;
+    modelsSrc?: string | undefined;
+    presetsSrc?: string | undefined;
+    componentsSrc?: string | undefined;
+    globalCss?: string | undefined;
+    viteConfig?: {
+        resolve?: {
+            alias: Record<string, string>;
+        } | undefined;
+    } | undefined;
+    rollupOptions?: {} | undefined;
+}>;
+declare const _default: (config: EmbeddableConfig) => {
     core: {
         rootDir: string;
         templatesDir: string;
@@ -56,6 +181,8 @@ declare const _default: ({ plugins, region, pushBaseUrl, audienceUrl, authDomain
     outputOptions: {
         typesEntryPointFilename: string;
     };
+    pushModels: boolean;
+    pushComponents: boolean;
     pushBaseUrl: string;
     audienceUrl: string;
     previewBaseUrl: string;

package/lib/index.esm.js

@@ -3,7 +3,7 @@ import { readdir, lstat } from 'node:fs/promises';
 import * as path from 'node:path';
 import path__default, { join } from 'node:path';
 import * as vite from 'vite';
-import ora from 'ora';
+import ora$1 from 'ora';
 import 'node:child_process';
 import * as crypto from 'node:crypto';
 import * as fs$1 from 'node:fs';
@@ -19,7 +19,8 @@ import require$$1 from 'os';
 import require$$3 from 'http';
 import require$$4 from 'https';
 import require$$0$1 from 'url';
-import require$$2$1, { createReadStream } from 'fs';
+import * as require$$2$1 from 'fs';
+import require$$2__default, { createReadStream } from 'fs';
 import * as path$1 from 'path';
 import path__default$1, { basename } from 'path';
 import axios from 'axios';
@@ -28,11 +29,8 @@ import { select } from '@inquirer/prompts';
 import * as http from 'node:http';
 import { WebSocketServer } from 'ws';
 import * as chokidar from 'chokidar';
-import minimist from 'minimist';
 import fg from 'fast-glob';
 import * as dotenv from 'dotenv';
-import finalhandler from 'finalhandler';
-import serveStatic from 'serve-static';
 import { stat } from 'fs/promises';
 
 var findFiles = async (initialSrcDir, regex) => {
@@ -374,7 +372,7 @@ const getContentHash = (contentString) => {
 const EMB_TYPE_FILE_REGEX = /^(.*)\.type\.emb\.[jt]s$/;
 const EMB_OPTIONS_FILE_REGEX = /^(.*)\.options\.emb\.[jt]s$/;
 var buildTypes = async (ctx) => {
-    const progress = ora("Building types...").start();
+    const progress = ora$1("Building types...").start();
     await generate$1(ctx);
     await build$1(ctx);
     await cleanup$1(ctx);
@@ -563,7 +561,7 @@ const CREDENTIALS_DIR = path.resolve(os.homedir(), ".embeddable");
 const CREDENTIALS_FILE = path.resolve(CREDENTIALS_DIR, "credentials");
 
 const checkNodeVersion = async () => {
-    const spinner = ora("Checking node version...").start();
+    const spinner = ora$1("Checking node version...").start();
     const [major, minor] = process.versions.node.split(".").map(Number);
     let packageJson;
     try {
@@ -4991,7 +4989,7 @@ const SECURITY_CONTEXT_FILE_REGEX = /^(.*)\.sc\.ya?ml$/;
 const CLIENT_CONTEXT_FILE_REGEX = /^(.*)\.cc\.ya?ml$/;
 var validate = async (ctx) => {
     checkNodeVersion();
-    const spinnerValidate = ora("Data model validation...").start();
+    const spinnerValidate = ora$1("Data model validation...").start();
     const cubeFilesList = await findFiles(ctx.client.modelsSrc || ctx.client.srcDir, CUBE_YAML_FILE_REGEX);
     const securityContextFilesList = await findFiles(ctx.client.presetsSrc || ctx.client.srcDir, SECURITY_CONTEXT_FILE_REGEX);
     const clientContextFilesList = await findFiles(ctx.client.presetsSrc || ctx.client.srcDir, CLIENT_CONTEXT_FILE_REGEX);
@@ -17914,7 +17912,7 @@ function requireStackTrace () {
 	hasRequiredStackTrace = 1;
 	var SourceMapConsumer = requireSourceMap().SourceMapConsumer;
 	var path = path__default$1;
-	var fs = require$$2$1;
+	var fs = require$$2__default;
 
 	/**
 	 * Uses Node source-map to map transpiled JS stack locations to original
@@ -18122,7 +18120,7 @@ function requireParser () {
 
 		var logger = requireLogger();
 		var async = require$$0;
-		var fs = require$$2$1;
+		var fs = require$$2__default;
 		var lru = requireLruCache();
 		var util = require$$4$1;
 		var stackTrace = requireStackTrace();
@@ -21377,13 +21375,13 @@ var build = async () => {
     }
 };
 
-const oraP = import('ora');
+const oraP$1 = import('ora');
 const openP = import('open');
 var login = async () => {
     var _a;
     await initLogger("login");
     const breadcrumbs = [];
-    const ora = (await oraP).default;
+    const ora = (await oraP$1).default;
     const authenticationSpinner = ora("Waiting for code verification...").start();
     try {
         const open = (await openP).default;
@@ -21544,7 +21542,7 @@ var push = async () => {
         }
         const config = await provideConfig();
         if (process.argv.includes("--api-key") || process.argv.includes("-k")) {
-            spinnerPushing = ora("Using API key...").start();
+            spinnerPushing = ora$1("Using API key...").start();
             breadcrumbs.push("push by api key");
             await pushByApiKey(config, spinnerPushing);
             spinnerPushing.succeed("Published using API key");
@@ -21552,11 +21550,11 @@ var push = async () => {
         }
         breadcrumbs.push("push by standard login");
         const token = await verify(config);
-        spinnerPushing = ora()
+        spinnerPushing = ora$1()
             .start()
             .info("No API Key provided. Standard login will be used.");
         breadcrumbs.push("select workspace");
-        const { workspaceId, name: workspaceName } = await selectWorkspace(ora, config, token);
+        const { workspaceId, name: workspaceName } = await selectWorkspace(ora$1, config, token);
         const workspacePreviewUrl = `${config.previewBaseUrl}/workspace/${workspaceId}`;
         breadcrumbs.push("build archive");
         await buildArchive(config);
@@ -21610,27 +21608,45 @@ async function verify(ctx) {
     return token;
 }
 async function buildArchive(config) {
-    const spinnerArchive = ora("Building...").start();
-    const cubeFilesList = await findFiles(config.client.modelsSrc || config.client.srcDir, CUBE_FILES);
-    const contextFilesList = await findFiles(config.client.presetsSrc || config.client.srcDir, PRESET_FILES);
-    // Map the files to include their full filenames
-    const filesList = [...cubeFilesList, ...contextFilesList].map((entry) => [path$1.basename(entry[1]), entry[1]]);
-    await archive(config, filesList);
+    const spinnerArchive = ora$1("Building...").start();
+    if (!config.pushModels && !config.pushComponents) {
+        spinnerArchive.fail("Cannot push: both pushModels and pushComponents are disabled");
+        process.exit(1);
+    }
+    const filesList = [];
+    if (config.pushModels) {
+        const cubeFilesList = await findFiles(config.client.modelsSrc || config.client.srcDir, CUBE_FILES);
+        const contextFilesList = await findFiles(config.client.presetsSrc || config.client.srcDir, PRESET_FILES);
+        filesList.push(...cubeFilesList.map((entry) => [
+            path$1.basename(entry[1]),
+            entry[1],
+        ]), ...contextFilesList.map((entry) => [
+            path$1.basename(entry[1]),
+            entry[1],
+        ]));
+    }
+    await archive({
+        ctx: config,
+        filesList,
+        isDev: false,
+        includeComponents: config.pushComponents,
+    });
     return spinnerArchive.succeed("Bundling completed");
 }
-async function archive(ctx, yamlFiles, isDev = false) {
+async function archive(args) {
+    const { ctx, filesList, isDev, includeComponents } = args;
     const output = fs$1.createWriteStream(ctx.client.archiveFile);
     const archive = archiver.create("zip", {
         zlib: { level: 9 },
     });
     archive.pipe(output);
-    if (!isDev) {
+    if (!isDev && includeComponents) {
         archive.directory(ctx.client.buildDir, false);
         archive.file(ctx.client.globalCss, {
             name: "global.css",
         });
     }
-    for (const fileData of yamlFiles) {
+    for (const fileData of filesList) {
         archive.file(fileData[1], {
             name: fileData[0],
         });
@@ -21640,7 +21656,7 @@ async function archive(ctx, yamlFiles, isDev = false) {
         output.on("close", resolve);
     });
 }
-async function sendBuildByApiKey(ctx, { apiKey, email, message }) {
+async function sendBuildByApiKey(ctx, { apiKey, email, message, }) {
     var _a;
     const { FormData, Blob } = await import('formdata-node');
     const { fileFromPath } = await Promise.resolve().then(function () { return fileFromPath$1; });
@@ -21673,10 +21689,13 @@ async function uploadFile(formData, url, token) {
     });
 }
 
+const minimist = require("minimist");
 dotenv.config();
+const oraP = import('ora');
 let wss;
 let changedFiles = [];
 let browserWindow = null;
+let ora;
 let previewWorkspace;
 const SERVER_PORT = 8926;
 const BUILD_DEV_DIR = ".embeddable-dev-build";
@@ -21686,6 +21705,7 @@ const buildWebComponent = async (config) => {
 };
 const addToGitingore = async () => {
     try {
+        const fs = require("fs").promises;
         const gitignorePath = path$1.resolve(process.cwd(), ".gitignore");
         const gitignoreContent = await fs.readFile(gitignorePath, "utf8");
         if (!gitignoreContent.includes(BUILD_DEV_DIR)) {
@@ -21712,6 +21732,7 @@ var dev = async () => {
         breadcrumbs.push("run dev");
         checkNodeVersion();
         addToGitingore();
+        ora = (await oraP).default;
         process.on("warning", (e) => console.warn(e.stack));
         const logger = createNodeLogger();
         const sys = createNodeSys({ process });
@@ -21734,6 +21755,8 @@ var dev = async () => {
         };
         breadcrumbs.push("prepare config");
         await prepare(config);
+        const finalhandler = require("finalhandler");
+        const serveStatic = require("serve-static");
         const serve = serveStatic(config.client.buildDir);
         let workspacePreparation = ora("Preparing workspace...").start();
         breadcrumbs.push("get preview workspace");
@@ -21753,7 +21776,7 @@ var dev = async () => {
             }
         }
         workspacePreparation.succeed("Workspace is ready");
-        const server = http.createServer(async (request, res) => {
+        const server = http.createServer((request, res) => {
             var _a;
             res.setHeader("Access-Control-Allow-Origin", "*");
             res.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS");
@@ -21768,7 +21791,7 @@ var dev = async () => {
             try {
                 if ((_a = request.url) === null || _a === void 0 ? void 0 : _a.endsWith(GLOBAL_CSS)) {
                     res.writeHead(200, { "Content-Type": "text/css" });
-                    res.end(await fs.readFile(config.client.globalCss));
+                    res.end(require$$2$1.readFileSync(config.client.globalCss));
                     return;
                 }
             }
@@ -21901,7 +21924,12 @@ const sendDataModelsAndContextsChanges = async (ctx) => {
             "embeddable-manifest.json",
             path$1.resolve(ctx.client.buildDir, "embeddable-manifest.json"),
         ]);
-        await archive(ctx, filesList, true);
+        await archive({
+            ctx,
+            filesList,
+            isDev: true,
+            includeComponents: false,
+        });
         await sendBuild(ctx, { workspaceId: previewWorkspace, token });
         sending.succeed(`Data models and/or security context synchronized`);
         sendMessage("dataModelsAndOrSecurityContextUpdateSuccess");
@@ -21985,10 +22013,50 @@ const REGION_CONFIGS = {
         authClientId: "dygrSUmI6HmgY5ymVbEAoLDEBxIOyr1V",
     },
 };
-var defineConfig = ({ plugins, region = "legacy-US", pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc = "src", presetsSrc = "src", componentsSrc = "src", globalCss = "src/global.css", viteConfig = {}, rollupOptions = {}, }) => {
-    if (region && !REGION_CONFIGS[region]) {
-        throw new Error(`Unsupported region: ${region}. Supported regions are: ${Object.keys(REGION_CONFIGS).join(", ")}`);
+const embeddableConfigSchema = z
+    .object({
+    plugins: z.array(z.function()),
+    region: z
+        .union([z.literal("EU"), z.literal("US"), z.literal("legacy-US")])
+        .optional(),
+    pushModels: z.boolean().optional(),
+    pushComponents: z.boolean().optional(),
+    pushBaseUrl: z.string().optional(),
+    audienceUrl: z.string().optional(),
+    authDomain: z.string().optional(),
+    authClientId: z.string().optional(),
+    errorFallbackComponent: z.string().optional(),
+    applicationEnvironment: z.string().optional(),
+    rollbarAccessToken: z.string().optional(),
+    previewBaseUrl: z.string().optional(),
+    modelsSrc: z.string().optional(),
+    presetsSrc: z.string().optional(),
+    componentsSrc: z.string().optional(),
+    globalCss: z.string().optional(),
+    viteConfig: z
+        .object({
+        resolve: z
+            .object({
+            alias: z.record(z.string()),
+        })
+            .optional(),
+    })
+        .optional(),
+    rollupOptions: z.object({}).optional(),
+})
+    .strict();
+var defineConfig = (config) => {
+    const safeParse = embeddableConfigSchema.safeParse(config);
+    const errors = [];
+    if (!safeParse.success) {
+        errorFormatter(safeParse.error.issues).forEach((error) => {
+            errors.push(`${error}`);
+        });
+    }
+    if (errors.length > 0) {
+        throw new Error(`Invalid Embeddable Configuration: ${errors.join("\n")}}`);
     }
+    let { plugins, region = "legacy-US", pushModels = true, pushComponents = true, pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc = "src", presetsSrc = "src", componentsSrc = "src", globalCss = "src/global.css", viteConfig = {}, rollupOptions = {}, } = config;
     const regionConfig = REGION_CONFIGS[region];
     const __dirname = import.meta.dirname;
     const coreRoot = path.resolve(__dirname, "..");
@@ -22038,6 +22106,8 @@ var defineConfig = ({ plugins, region = "legacy-US", pushBaseUrl, audienceUrl, a
         outputOptions: {
             typesEntryPointFilename: "embeddable-types-entry-point.js",
         },
+        pushModels,
+        pushComponents,
         pushBaseUrl: pushBaseUrl !== null && pushBaseUrl !== undefined ? pushBaseUrl : regionConfig.pushBaseUrl,
         audienceUrl: audienceUrl !== null && audienceUrl !== undefined ? audienceUrl : regionConfig.audienceUrl,
         previewBaseUrl: previewBaseUrl !== null && previewBaseUrl !== undefined ? previewBaseUrl : regionConfig.previewBaseUrl,