@embeddable.com/sdk-core 1.0.0 → 2.0.0

package/lib/index.esm.js

@@ -1,3 +1,5 @@
+import path from 'node:path';
+
 var normalizeEntities = function (entities, _a) {
     var _b = _a.mapFn, mapFn = _b === void 0 ? function (x) { return x; } : _b, _c = _a.filterFn, filterFn = _c === void 0 ? Boolean : _c;
     if (!entities)
@@ -67,6 +69,32 @@ var loadData = function (requestParams) { return ({
     dataLoader: executeDataRequest,
 }); };
 
+var defineConfig = function (_a) {
+    var plugins = _a.plugins;
+    var coreRoot = path.resolve(__dirname, "..");
+    var clientRoot = process.cwd();
+    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"),
+        },
+        outputOptions: {
+            typesEntryPointFilename: "embeddable-types-entry-point.js",
+        },
+        plugins: plugins,
+    };
+};
+
 var getOperationObject = function (operation, value) { return ({
     operation: operation,
     value: value,
@@ -124,25 +152,22 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 };
 
 var embedType = function (typeName, typeConfig) {
-    // @ts-ignore
-    window.__EMBEDDABLE__ = window.__EMBEDDABLE__ || {};
-    // @ts-ignore
-    window.__EMBEDDABLE__.types = window.__EMBEDDABLE__.types || {};
-    // @ts-ignore
-    window.__EMBEDDABLE__.types[typeName] = __assign({ name: typeName }, typeConfig);
+    globalThis.__EMBEDDABLE__ = globalThis.__EMBEDDABLE__ || {};
+    globalThis.__EMBEDDABLE__.types = globalThis.__EMBEDDABLE__.types || {};
+    globalThis.__EMBEDDABLE__.types[typeName] = __assign({ name: typeName }, typeConfig);
+    return {
+        toString: function () { return typeName; },
+        typeConfig: typeConfig,
+    };
 };
 
 var embedOption = function (typeName, option) {
-    // @ts-ignore
-    window.__EMBEDDABLE__ = window.__EMBEDDABLE__ || {};
-    // @ts-ignore
-    if (!window.__EMBEDDABLE__.types[typeName])
+    globalThis.__EMBEDDABLE__ = globalThis.__EMBEDDABLE__ || {};
+    if (!globalThis.__EMBEDDABLE__.types[typeName])
         return;
-    // @ts-ignore
-    window.__EMBEDDABLE__.types[typeName].options =
-        window.__EMBEDDABLE__.types[typeName].options || [];
-    // @ts-ignore
-    window.__EMBEDDABLE__.types[typeName].options.push(option);
+    globalThis.__EMBEDDABLE__.types[typeName].options =
+        globalThis.__EMBEDDABLE__.types[typeName].options || [];
+    globalThis.__EMBEDDABLE__.types[typeName].options.push(option);
 };
 
-export { Value, embedOption, embedType, isLoadDataParams, loadData, setValue };
+export { Value, defineConfig, embedOption, embedType, isLoadDataParams, loadData, setValue };

package/lib/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
-    typeof define === 'function' && define.amd ? define(['exports'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.embeddableSdk = {}));
-})(this, (function (exports) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('node:path')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'node:path'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.embeddableSdk = {}, global.path));
+})(this, (function (exports, path) { 'use strict';
 
     var normalizeEntities = function (entities, _a) {
         var _b = _a.mapFn, mapFn = _b === void 0 ? function (x) { return x; } : _b, _c = _a.filterFn, filterFn = _c === void 0 ? Boolean : _c;
@@ -73,6 +73,32 @@
         dataLoader: executeDataRequest,
     }); };
 
+    var defineConfig = function (_a) {
+        var plugins = _a.plugins;
+        var coreRoot = path.resolve(__dirname, "..");
+        var clientRoot = process.cwd();
+        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"),
+            },
+            outputOptions: {
+                typesEntryPointFilename: "embeddable-types-entry-point.js",
+            },
+            plugins: plugins,
+        };
+    };
+
     var getOperationObject = function (operation, value) { return ({
         operation: operation,
         value: value,
@@ -130,28 +156,26 @@
     };
 
     var embedType = function (typeName, typeConfig) {
-        // @ts-ignore
-        window.__EMBEDDABLE__ = window.__EMBEDDABLE__ || {};
-        // @ts-ignore
-        window.__EMBEDDABLE__.types = window.__EMBEDDABLE__.types || {};
-        // @ts-ignore
-        window.__EMBEDDABLE__.types[typeName] = __assign({ name: typeName }, typeConfig);
+        globalThis.__EMBEDDABLE__ = globalThis.__EMBEDDABLE__ || {};
+        globalThis.__EMBEDDABLE__.types = globalThis.__EMBEDDABLE__.types || {};
+        globalThis.__EMBEDDABLE__.types[typeName] = __assign({ name: typeName }, typeConfig);
+        return {
+            toString: function () { return typeName; },
+            typeConfig: typeConfig,
+        };
     };
 
     var embedOption = function (typeName, option) {
-        // @ts-ignore
-        window.__EMBEDDABLE__ = window.__EMBEDDABLE__ || {};
-        // @ts-ignore
-        if (!window.__EMBEDDABLE__.types[typeName])
+        globalThis.__EMBEDDABLE__ = globalThis.__EMBEDDABLE__ || {};
+        if (!globalThis.__EMBEDDABLE__.types[typeName])
             return;
-        // @ts-ignore
-        window.__EMBEDDABLE__.types[typeName].options =
-            window.__EMBEDDABLE__.types[typeName].options || [];
-        // @ts-ignore
-        window.__EMBEDDABLE__.types[typeName].options.push(option);
+        globalThis.__EMBEDDABLE__.types[typeName].options =
+            globalThis.__EMBEDDABLE__.types[typeName].options || [];
+        globalThis.__EMBEDDABLE__.types[typeName].options.push(option);
     };
 
     exports.Value = Value;
+    exports.defineConfig = defineConfig;
     exports.embedOption = embedOption;
     exports.embedType = embedType;
     exports.isLoadDataParams = isLoadDataParams;

package/lib/loadData.d.ts

@@ -1,18 +1,22 @@
-declare const cubeType: {
+declare const cubeNativeType: {
     readonly string: "string";
     readonly number: "number";
     readonly time: "time";
 };
-export type CubeType = keyof typeof cubeType;
+export type NativeType = keyof typeof cubeNativeType;
 export type Dimension = {
     name: string;
     title: string;
-    type: CubeType;
+    nativeType: NativeType;
+    description?: string;
+    meta?: object;
 };
 export type Measure = {
     name: string;
     title: string;
-    type: string;
+    nativeType: NativeType;
+    description?: string;
+    meta?: object;
 };
 export type DimensionOrMeasure = Dimension | Measure;
 declare const timeDimensionGranularity: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embeddable.com/sdk-core",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Core Embeddable SDK module responsible for web-components bundling and publishing.",
   "keywords": [
     "embeddable",
@@ -21,8 +21,8 @@
   },
   "author": "Oleg Kapustin <oleg@trevor.io>",
   "files": [
+    "dist/",
     "lib/",
-    "scripts/",
     "templates/",
     "configs/"
   ],
@@ -31,6 +31,7 @@
   },
   "license": "MIT",
   "dependencies": {
+    "@embeddable.com/sdk-utils": "*",
     "@stencil/core": "^4.0.0",
     "archiver": "^5.3.1",
     "axios": "^1.4.0",
@@ -42,5 +43,8 @@
     "*.{js,ts,json}": [
       "prettier --write"
     ]
+  },
+  "devDependencies": {
+    "@types/archiver": "^5.3.4"
   }
 }

package/templates/component.tsx.template

@@ -22,6 +22,10 @@ export class EmbeddableComponent {
     this.handlePops();
   }
 
+  disconnectedCallback() {
+    this.rootElement.dispatchEvent(new CustomEvent('EMBEDDABLE_COMPONENT:UNMOUNT'));
+  }
+
   componentWillUpdate() {
     const event = new CustomEvent('embeddable-event:update-props', {
       bubbles: false,

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);
-}