@embeddable.com/sdk-core 4.3.3 → 4.4.0-next.1

package/lib/defineConfig.d.ts

@@ -12,6 +12,7 @@ export type EmbeddableConfig = {
     })[];
     pushModels?: boolean;
     pushComponents?: boolean;
+    pushEmbeddables?: boolean;
     pushBaseUrl?: string;
     audienceUrl?: string;
     authDomain?: string;
@@ -74,6 +75,7 @@ export type ResolvedEmbeddableConfig = {
     };
     pushModels: boolean;
     pushComponents: boolean;
+    pushEmbeddables: boolean;
     pushBaseUrl: string;
     audienceUrl: string;
     previewBaseUrl: string;
@@ -98,14 +100,19 @@ export type ResolvedEmbeddableConfig = {
             buildName: string;
             componentsEntryPointFilename: string;
         };
+        pluginFlags?: PluginFlags;
     };
 };
+export type PluginFlags = {
+    supportsOnComponentReadyHook: boolean;
+};
 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">]>>;
     starterEmbeddables: z.ZodOptional<z.ZodRecord<z.ZodEnum<["EU", "US", "legacy-US"]>, z.ZodArray<z.ZodString, "many">>>;
     pushModels: z.ZodOptional<z.ZodBoolean>;
     pushComponents: z.ZodOptional<z.ZodBoolean>;
+    pushEmbeddables: z.ZodOptional<z.ZodBoolean>;
     pushBaseUrl: z.ZodOptional<z.ZodString>;
     audienceUrl: z.ZodOptional<z.ZodString>;
     authDomain: z.ZodOptional<z.ZodString>;
@@ -157,6 +164,7 @@ export declare const embeddableConfigSchema: z.ZodObject<{
     starterEmbeddables?: Partial<Record<"EU" | "US" | "legacy-US", string[]>> | undefined;
     pushModels?: boolean | undefined;
     pushComponents?: boolean | undefined;
+    pushEmbeddables?: boolean | undefined;
     pushBaseUrl?: string | undefined;
     audienceUrl?: string | undefined;
     authDomain?: string | undefined;
@@ -188,6 +196,7 @@ export declare const embeddableConfigSchema: z.ZodObject<{
     starterEmbeddables?: Partial<Record<"EU" | "US" | "legacy-US", string[]>> | undefined;
     pushModels?: boolean | undefined;
     pushComponents?: boolean | undefined;
+    pushEmbeddables?: boolean | undefined;
     pushBaseUrl?: string | undefined;
     audienceUrl?: string | undefined;
     authDomain?: string | undefined;
@@ -257,6 +266,7 @@ declare const _default: (config: EmbeddableConfig) => {
     starterEmbeddables: Partial<Record<Region, string[]>> | undefined;
     pushModels: boolean;
     pushComponents: boolean;
+    pushEmbeddables: boolean;
     pushBaseUrl: string;
     audienceUrl: string;
     previewBaseUrl: string;

package/lib/index.d.ts

@@ -4,4 +4,4 @@ export { default as push } from "./push";
 export { default as dev } from "./dev";
 export { default as defineConfig } from "./defineConfig";
 export { default as buildPackage } from "./buildPackage";
-export type { ResolvedEmbeddableConfig } from "./defineConfig";
+export type { ResolvedEmbeddableConfig, PluginFlags } from "./defineConfig";

package/lib/index.esm.js

@@ -609,6 +609,7 @@ async function createComponentDir(dir) {
 
 const STYLE_IMPORTS_TOKEN = "{{STYLES_IMPORT}}";
 const RENDER_IMPORT_TOKEN = "{{RENDER_IMPORT}}";
+const PLUGIN_FLAGS_TOKEN = "{{PLUGIN_FLAGS}}";
 // stencil doesn't support dynamic component tag name, so we need to replace it manually
 const COMPONENT_TAG_TOKEN = "replace-this-with-component-name";
 let triggeredBuildCount = 0;
@@ -697,16 +698,18 @@ async function injectCSS(ctx, pluginName) {
     await fs.writeFile(path$1.resolve(ctx.client.componentDir, "style.css"), content.replace(STYLE_IMPORTS_TOKEN, cssFilesImportsStr));
 }
 async function injectBundleRender(ctx, pluginName) {
-    var _a;
+    var _a, _b;
     const importFilePath = path$1
         .relative(ctx.client.componentDir, path$1.resolve(ctx.client.buildDir, ctx[pluginName].outputOptions.buildName))
         .replaceAll("\\", "/");
     const importStr = `import render from '${importFilePath}/${ctx[pluginName].outputOptions.fileName}';`;
+    const pluginFlags = (_a = ctx[pluginName].pluginFlags) !== null && _a !== void 0 ? _a : {};
+    const pluginFlagsStr = `const pluginFlags: Partial<PluginFlags> = ${JSON.stringify(pluginFlags)}`;
     let content = await fs.readFile(path$1.resolve(ctx.core.templatesDir, "component.tsx.template"), "utf8");
-    if (!!((_a = ctx.dev) === null || _a === void 0 ? void 0 : _a.watch)) {
+    if (!!((_b = ctx.dev) === null || _b === void 0 ? void 0 : _b.watch)) {
         content = content.replace(COMPONENT_TAG_TOKEN, "embeddable-component");
     }
-    await fs.writeFile(path$1.resolve(ctx.client.componentDir, "component.tsx"), content.replace(RENDER_IMPORT_TOKEN, importStr));
+    await fs.writeFile(path$1.resolve(ctx.client.componentDir, "component.tsx"), content.replace(RENDER_IMPORT_TOKEN, importStr).replace(PLUGIN_FLAGS_TOKEN, pluginFlagsStr));
 }
 async function injectEmptyCSS(ctx) {
     await fs.writeFile(path$1.resolve(ctx.client.componentDir, "style.css"), "");
@@ -715,7 +718,7 @@ async function injectBundleRenderStub(ctx) {
     const stubStr = `const render = (..._args: any[]) => {};`;
     let content = await fs.readFile(path$1.resolve(ctx.core.templatesDir, "component.tsx.template"), "utf8");
     content = content.replace(COMPONENT_TAG_TOKEN, "embeddable-component");
-    await fs.writeFile(path$1.resolve(ctx.client.componentDir, "component.tsx"), content.replace(RENDER_IMPORT_TOKEN, stubStr));
+    await fs.writeFile(path$1.resolve(ctx.client.componentDir, "component.tsx"), content.replace(RENDER_IMPORT_TOKEN, stubStr).replace(PLUGIN_FLAGS_TOKEN, "const pluginFlags: Partial<PluginFlags> = {}"));
 }
 async function addComponentTagName(filePath, bundleHash) {
     // find entry file with a name *.entry.js
@@ -21447,6 +21450,7 @@ async function selectWorkspace(ora, ctx, token) {
 const CUBE_FILES = /^(.*)\.cube\.(ya?ml|js)$/;
 const CLIENT_CONTEXT_FILES = /^(.*)\.cc\.ya?ml$/;
 const SECURITY_CONTEXT_FILES = /^(.*)\.sc\.ya?ml$/;
+const EMBEDDABLE_FILES = /^(.*)\.embeddable\.ya?ml$/;
 var push = async () => {
     var _a, _b, _c, _d, _f, _g;
     await initLogger("push");
@@ -21512,6 +21516,7 @@ Read more about deployment regions at https://docs.embeddable.com/deployment/dep
 const publishedSectionFeedback = (config, spinnerPushing) => {
     config.pushModels && spinnerPushing.succeed("Models published");
     config.pushComponents && spinnerPushing.succeed("Components published");
+    config.pushEmbeddables && spinnerPushing.succeed("Embeddables published");
 };
 async function pushByApiKey(config, spinner, cubeVersion) {
     const apiKey = getArgumentByKey(["--api-key", "-k"]);
@@ -21554,8 +21559,8 @@ async function verify(ctx) {
 }
 async function buildArchive(config) {
     const spinnerArchive = ora("Building...").start();
-    if (!config.pushModels && !config.pushComponents) {
-        spinnerArchive.fail("Cannot push: both pushModels and pushComponents are disabled");
+    if (!config.pushModels && !config.pushComponents && !config.pushEmbeddables) {
+        spinnerArchive.fail("Cannot push: pushModels, pushComponents, and pushEmbeddables are all disabled");
         process.exit(1);
     }
     const filesList = [];
@@ -21577,6 +21582,13 @@ async function buildArchive(config) {
             entry[1],
         ]));
     }
+    if (config.pushEmbeddables) {
+        const embeddableFilesList = await findFiles(config.client.srcDir, EMBEDDABLE_FILES);
+        filesList.push(...embeddableFilesList.map((entry) => [
+            path.basename(entry[1]),
+            entry[1],
+        ]));
+    }
     await archive({
         ctx: config,
         filesList,
@@ -21632,6 +21644,7 @@ async function sendBuildByApiKey(ctx, { apiKey, email, message, cubeVersion, })
     const form = await createFormData(ctx.client.archiveFile, {
         pushModels: ctx.pushModels,
         pushComponents: ctx.pushComponents,
+        pushEmbeddables: ctx.pushEmbeddables,
         starterEmbeddableIds: (_a = ctx.starterEmbeddables) === null || _a === void 0 ? void 0 : _a[ctx.region],
         authorEmail: email,
         description: message,
@@ -21647,6 +21660,7 @@ async function sendBuild(ctx, { workspaceId, token, message, cubeVersion, }) {
     const form = await createFormData(ctx.client.archiveFile, {
         pushModels: ctx.pushModels,
         pushComponents: ctx.pushComponents,
+        pushEmbeddables: ctx.pushEmbeddables,
         starterEmbeddableIds: (_a = ctx.starterEmbeddables) === null || _a === void 0 ? void 0 : _a[ctx.region],
         authorEmail: "",
         description: message,
@@ -22111,6 +22125,13 @@ const cubeSecurityContextAndClientContextWatcher = async (ctx) => {
         ]);
         filesToWatch = [...filesToWatch, ...cubeFiles, ...securityContextFiles];
     }
+    if (ctx.pushEmbeddables) {
+        const embeddableFiles = await fg("**/*.embeddable.{yaml,yml}", {
+            cwd: ctx.client.srcDir,
+            absolute: true,
+        });
+        filesToWatch = [...filesToWatch, ...embeddableFiles];
+    }
     const fsWatcher = chokidar.watch(filesToWatch, chokidarWatchOptions);
     fsWatcher.on("all", () => sendBuildChanges(ctx));
     return fsWatcher;
@@ -22129,7 +22150,7 @@ const sendBuildChanges = async (ctx) => {
         return sendMessage("dataModelsAndOrSecurityContextUpdateError");
     }
     sendMessage("dataModelsAndOrSecurityContextUpdateStart");
-    const sending = ora("Synchronising data models and/or security contexts...").start();
+    const sending = ora("Synchronising data models and/or security contexts and/or embeddables...").start();
     let filesList = [];
     if (ctx.pushComponents) {
         const clientContextFilesList = await findFiles(ctx.client.presetsSrc, CLIENT_CONTEXT_FILES);
@@ -22154,6 +22175,16 @@ const sendBuildChanges = async (ctx) => {
         ].map((entry) => [path.basename(entry[1]), entry[1]]);
         filesList = [...filesList, ...cubeAndSecurityContextFileList];
     }
+    if (ctx.pushEmbeddables) {
+        const embeddableFilesList = await findFiles(ctx.client.srcDir, EMBEDDABLE_FILES);
+        filesList = [
+            ...filesList,
+            ...embeddableFilesList.map((entry) => [
+                path.basename(entry[1]),
+                entry[1],
+            ]),
+        ];
+    }
     try {
         const token = await getToken();
         await archive({
@@ -22165,10 +22196,10 @@ const sendBuildChanges = async (ctx) => {
     }
     catch (e) {
         const errorMessage = (_d = (_c = (_b = (_a = e.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.errorMessage) !== null && _c !== void 0 ? _c : e.message) !== null && _d !== void 0 ? _d : "Unknown error";
-        sending.fail(`Data models and/or security context synchronization failed with error: ${errorMessage}`);
+        sending.fail(`Data models and/or security context and/or embeddables synchronization failed with error: ${errorMessage}`);
         return sendMessage("dataModelsAndOrSecurityContextUpdateError", { error: errorMessage });
     }
-    sending.succeed(`Data models and/or security context synchronized`);
+    sending.succeed(`Data models and/or security context and/or embeddables synchronized`);
     sendMessage("dataModelsAndOrSecurityContextUpdateSuccess");
 };
 const onClose = async (server, sys, watchers, config) => {
@@ -22206,6 +22237,7 @@ const getPreviewWorkspace = async (startedOra, ctx) => {
             instanceUrl,
             pushModels: ctx.pushModels,
             pushComponents: ctx.pushComponents,
+            pushEmbeddables: ctx.pushEmbeddables,
         }, {
             headers: {
                 Authorization: `Bearer ${token}`,
@@ -22297,6 +22329,7 @@ const embeddableConfigSchema = objectType({
     starterEmbeddables: recordType(enumType(["EU", "US", "legacy-US"]), arrayType(stringType().uuid())).optional(),
     pushModels: booleanType().optional(),
     pushComponents: booleanType().optional(),
+    pushEmbeddables: booleanType().optional(),
     pushBaseUrl: stringType().optional(),
     audienceUrl: stringType().optional(),
     authDomain: stringType().optional(),
@@ -22334,7 +22367,7 @@ var defineConfig = (config) => {
     if (errors.length > 0) {
         throw new Error(`Invalid Embeddable Configuration: ${errors.join("\n")}}`);
     }
-    let { plugins, region = "legacy-US", pushModels = true, starterEmbeddables, pushComponents = true, pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc = "src", presetsSrc = "src", componentsSrc = "src", customCanvasCss = "src/custom-canvas.css", viteConfig = {}, rollupOptions = {}, componentLibraries = [], customizationFile = "embeddable.theme.ts", lifecycleHooksFile = "lifecycle.config.ts", } = config;
+    let { plugins, region = "legacy-US", pushModels = true, starterEmbeddables, pushComponents = true, pushEmbeddables = true, pushBaseUrl, audienceUrl, authDomain, authClientId, errorFallbackComponent, applicationEnvironment, rollbarAccessToken, previewBaseUrl, modelsSrc = "src", presetsSrc = "src", componentsSrc = "src", customCanvasCss = "src/custom-canvas.css", viteConfig = {}, rollupOptions = {}, componentLibraries = [], customizationFile = "embeddable.theme.ts", lifecycleHooksFile = "lifecycle.config.ts", } = config;
     const regionConfig = REGION_CONFIGS[region];
     const __dirname = import.meta.dirname;
     const coreRoot = path$1.resolve(__dirname, "..");
@@ -22398,6 +22431,7 @@ var defineConfig = (config) => {
         starterEmbeddables,
         pushModels,
         pushComponents,
+        pushEmbeddables,
         pushBaseUrl: pushBaseUrl !== null && pushBaseUrl !== void 0 ? pushBaseUrl : regionConfig.pushBaseUrl,
         audienceUrl: audienceUrl !== null && audienceUrl !== void 0 ? audienceUrl : regionConfig.audienceUrl,
         previewBaseUrl: previewBaseUrl !== null && previewBaseUrl !== void 0 ? previewBaseUrl : regionConfig.previewBaseUrl,