@embeddable.com/sdk-core 3.9.4 → 3.9.5

package/lib/defineConfig.d.ts

@@ -16,6 +16,7 @@ export type EmbeddableConfig = {
     previewBaseUrl?: string;
     componentsSrc?: string;
     modelsSrc?: string;
+    presetsSrc?: string;
     globalCss?: string;
     viteConfig?: {
         resolve?: {
@@ -24,7 +25,7 @@ export type EmbeddableConfig = {
     };
     rollupOptions?: RollupOptions;
 };
-declare const _default: ({ plugins, pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc, componentsSrc, globalCss, viteConfig, rollupOptions, }: EmbeddableConfig) => {
+declare const _default: ({ plugins, pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc, presetsSrc, componentsSrc, globalCss, viteConfig, rollupOptions, }: EmbeddableConfig) => {
     core: {
         rootDir: string;
         templatesDir: string;
@@ -34,6 +35,7 @@ declare const _default: ({ plugins, pushBaseUrl, audienceUrl, authDomain, authCl
         rootDir: string;
         srcDir: string;
         modelsSrc: string | undefined;
+        presetsSrc: string | undefined;
         buildDir: string;
         tmpDir: string;
         globalCss: string;

package/lib/index.esm.js

@@ -4989,13 +4989,15 @@ var z = /*#__PURE__*/Object.freeze({
 
 const CUBE_YAML_FILE_REGEX = /^(.*)\.cube\.ya?ml$/;
 const SECURITY_CONTEXT_FILE_REGEX = /^(.*)\.sc\.ya?ml$/;
+const CLIENT_CONTEXT_FILE_REGEX = /^(.*)\.cc\.ya?ml$/;
 var validate = async (ctx, exitIfInvalid = true) => {
     checkNodeVersion();
     const ora = (await import('ora')).default;
     const spinnerValidate = ora("Data model validation...").start();
-    const filesList = await findFiles(ctx.client.srcDir, CUBE_YAML_FILE_REGEX);
-    const securityContextFilesList = await findFiles(ctx.client.modelsSrc || ctx.client.srcDir, SECURITY_CONTEXT_FILE_REGEX);
-    const dataModelErrors = await dataModelsValidation(filesList);
+    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);
+    const dataModelErrors = await dataModelsValidation(cubeFilesList);
     if (dataModelErrors.length) {
         spinnerValidate.fail("One or more cube.yaml files are invalid:");
         dataModelErrors.forEach((errorMessage) => spinnerValidate.info(errorMessage));
@@ -5005,6 +5007,7 @@ var validate = async (ctx, exitIfInvalid = true) => {
     }
     spinnerValidate.succeed("Data model validation completed");
     const securityContextErrors = await securityContextValidation(securityContextFilesList);
+    const clientContextErrors = await clientContextValidation(clientContextFilesList);
     if (securityContextErrors.length) {
         spinnerValidate.fail("One or more security context files are invalid:");
         securityContextErrors.forEach((errorMessage) => spinnerValidate.info(errorMessage));
@@ -5012,7 +5015,16 @@ var validate = async (ctx, exitIfInvalid = true) => {
             process.exit(1);
         }
     }
-    return dataModelErrors.length === 0 && securityContextErrors.length === 0;
+    if (clientContextErrors.length) {
+        spinnerValidate.fail("One or more client context files are invalid:");
+        clientContextErrors.forEach((errorMessage) => spinnerValidate.info(errorMessage));
+        if (exitIfInvalid) {
+            process.exit(1);
+        }
+    }
+    return (dataModelErrors.length === 0 &&
+        securityContextErrors.length === 0 &&
+        clientContextErrors.length === 0);
 };
 async function dataModelsValidation(filesList) {
     const errors = [];
@@ -5065,6 +5077,29 @@ async function securityContextValidation(filesList) {
     }
     return errors;
 }
+async function clientContextValidation(filesList) {
+    const errors = [];
+    const nameSet = new Set();
+    for (const [_, filePath] of filesList) {
+        const fileContentRaw = await fs.readFile(filePath, "utf8");
+        const cube = YAML.parse(fileContentRaw);
+        cube.forEach((item) => {
+            if (nameSet.has(item.name)) {
+                errors.push(`${filePath}: client context with name "${item.name}" already exists`);
+            }
+            else {
+                nameSet.add(item.name);
+            }
+        });
+        const safeParse = clientContextSchema.safeParse(cube);
+        if (!safeParse.success) {
+            errorFormatter(safeParse.error.issues).forEach((error) => {
+                errors.push(`${filePath}: ${error}`);
+            });
+        }
+    }
+    return errors;
+}
 var MeasureTypeEnum;
 (function (MeasureTypeEnum) {
     MeasureTypeEnum["string"] = "string";
@@ -5131,6 +5166,10 @@ const securityContextSchema = z.array(z.object({
     name: z.string(),
     securityContext: z.object({}), // can be any object
 }));
+const clientContextSchema = z.array(z.object({
+    name: z.string(),
+    clientContext: z.object({}), // can be any object
+}));
 
 var provideConfig = async () => {
     const configFilePath = `${process.cwd()}/embeddable.config.js`;
@@ -21473,8 +21512,10 @@ async function selectWorkspace(ora, ctx, token) {
 }
 
 const oraP$1 = import('ora');
-// grab .cube.yml|js and .sc.yml|js files
-const YAML_OR_JS_FILES = /^(.*)\.(cube|sc)\.(ya?ml|js)$/;
+// grab cube files
+const CUBE_FILES = /^(.*)\.cube\.(ya?ml|js)$/;
+// grab security context and client context files
+const PRESET_FILES = /^(.*)\.(sc|cc)\.ya?ml$/;
 let ora$1;
 var push = async () => {
     await initLogger("push");
@@ -21557,8 +21598,9 @@ async function verify(ctx) {
 }
 async function buildArchive(config) {
     const spinnerArchive = ora$1("Building...").start();
-    const filesList = await findFiles(config.client.modelsSrc || config.client.srcDir, YAML_OR_JS_FILES);
-    await archive(config, filesList);
+    const cubeFilesList = await findFiles(config.client.modelsSrc || config.client.srcDir, CUBE_FILES);
+    const contextFilesList = await findFiles(config.client.presetsSrc || config.client.srcDir, PRESET_FILES);
+    await archive(config, [...cubeFilesList, ...contextFilesList]);
     return spinnerArchive.succeed("Bundling completed");
 }
 async function archive(ctx, yamlFiles, isDev = false) {
@@ -21737,7 +21779,7 @@ var dev = async () => {
                 metaFileName: "embeddable-components-meta.js",
                 editorsMetaFileName: "embeddable-editors-meta.js",
             });
-            await sendDataModelsAndSecurityContextsChanges(config);
+            await sendDataModelsAndContextsChanges(config);
             for (const getPlugin of config.plugins) {
                 const plugin = getPlugin();
                 breadcrumbs.push("validate plugin");
@@ -21806,9 +21848,12 @@ const onBundleBuildEnd = async (ctx) => {
     }
 };
 const dataModelAndSecurityContextWatcher = (ctx) => {
-    const fsWatcher = chokidar.watch([path$1.resolve(ctx.client.modelsSrc, "**/*.{cube,sc}.{yaml,yml,js}")], chokidarWatchOptions);
+    const fsWatcher = chokidar.watch([
+        path$1.resolve(ctx.client.modelsSrc, "**/*.{cube}.{yaml,yml,js}"),
+        path$1.resolve(ctx.client.presetsSrc, "**/*.{sc,cc}.{yaml,yml}"),
+    ], chokidarWatchOptions);
     fsWatcher.on("all", async () => {
-        await sendDataModelsAndSecurityContextsChanges(ctx);
+        await sendDataModelsAndContextsChanges(ctx);
     });
     return fsWatcher;
 };
@@ -21819,13 +21864,15 @@ const globalCssWatcher = (ctx) => {
     });
     return fsWatcher;
 };
-const sendDataModelsAndSecurityContextsChanges = async (ctx) => {
+const sendDataModelsAndContextsChanges = async (ctx) => {
     sendMessage("dataModelsAndOrSecurityContextUpdateStart");
     const isValid = await validate(ctx, false);
     if (isValid) {
         const token = await getToken();
         const sending = ora("Synchronising data models and/or security contexts...").start();
-        const filesList = await findFiles(ctx.client.modelsSrc, YAML_OR_JS_FILES);
+        const cubeFilesList = await findFiles(ctx.client.modelsSrc, CUBE_FILES);
+        const contextFilesList = await findFiles(ctx.client.presetsSrc, PRESET_FILES);
+        const filesList = [...cubeFilesList, ...contextFilesList];
         // add manifest to the archive
         filesList.push([
             "embeddable-manifest",
@@ -21888,7 +21935,7 @@ const getPreviewWorkspace = async (startedOra, ctx) => {
     }
 };
 
-var defineConfig = ({ plugins, pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc = "src", componentsSrc = "src", globalCss = "src/global.css", viteConfig = {}, rollupOptions = {}, }) => {
+var defineConfig = ({ plugins, pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc = "src", presetsSrc = "src", componentsSrc = "src", globalCss = "src/global.css", viteConfig = {}, rollupOptions = {}, }) => {
     const coreRoot = path.resolve(__dirname, "..");
     const clientRoot = process.cwd();
     if (!path.isAbsolute(componentsSrc)) {
@@ -21903,6 +21950,12 @@ var defineConfig = ({ plugins, pushBaseUrl, audienceUrl, authDomain, authClientI
             throw new Error(`modelsSrc directory ${modelsSrc} does not exist`);
         }
     }
+    if (presetsSrc && !path.isAbsolute(presetsSrc)) {
+        presetsSrc = path.resolve(clientRoot, presetsSrc);
+        if (!existsSync(presetsSrc)) {
+            throw new Error(`presetsSrc directory ${presetsSrc} does not exist`);
+        }
+    }
     return {
         core: {
             rootDir: coreRoot,
@@ -21913,6 +21966,7 @@ var defineConfig = ({ plugins, pushBaseUrl, audienceUrl, authDomain, authClientI
             rootDir: clientRoot,
             srcDir: path.resolve(clientRoot, componentsSrc),
             modelsSrc: modelsSrc ? path.resolve(clientRoot, modelsSrc) : undefined,
+            presetsSrc: presetsSrc ? path.resolve(clientRoot, presetsSrc) : undefined,
             buildDir: path.resolve(clientRoot, ".embeddable-build"),
             tmpDir: path.resolve(clientRoot, ".embeddable-tmp"),
             globalCss: path.resolve(clientRoot, globalCss),
@@ -21941,7 +21995,7 @@ var defineConfig = ({ plugins, pushBaseUrl, audienceUrl, authDomain, authClientI
 };
 
 var name = "@embeddable.com/sdk-core";
-var version = "3.9.4";
+var version = "3.9.5";
 var description = "Core Embeddable SDK module responsible for web-components bundling and publishing.";
 var keywords = [
 	"embeddable",