@embeddable.com/sdk-core 0.2.0 → 1.0.0

package/configs/stencil.config.ts

@@ -1,11 +1,11 @@
-import { Config } from '@stencil/core';
+import { Config } from "@stencil/core";
 
 export const config: Config = {
-  namespace: 'embeddable-wrapper',
-  srcDir: 'component',
+  namespace: "embeddable-wrapper",
+  srcDir: "component",
   outputTargets: [
     {
-      type: 'dist'
+      type: "dist",
     },
   ],
-};
+};

package/lib/embedType.d.ts

@@ -1,4 +1,14 @@
-export declare const embedType: (typeName: string, typeConfig: {
+export declare const embedType: (typeName: string, typeConfig: TypeConfig) => void;
+export type TypeConfig = {
     label: string;
+    embeddableDataType?: typeof STRING | typeof NUMBER | typeof BOOLEAN | typeof DATE | typeof DATE_RANGE;
     toString: (_: any) => string;
-}) => void;
+    deserialize?: (_: any) => any;
+    toEmbeddableDataType?: (_: any) => any;
+};
+declare const STRING = "string";
+declare const NUMBER = "number";
+declare const BOOLEAN = "boolean";
+declare const DATE = "date";
+declare const DATE_RANGE = "dateRange";
+export {};

package/lib/index.cjs.js

@@ -1,30 +1,84 @@
 'use strict';
 
-var axios = require('axios');
+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)
+        return undefined;
+    var filtered = entities.filter(filterFn);
+    if (filtered.length === 0)
+        return undefined;
+    return filtered.map(mapFn);
+};
+var getName = function (x) { return x.name; };
+var validateOrderBy = function (orderByParam, dimensions, measures) {
+    var unknownDimensionsOrMeasures = [];
+    var dimensionAndMeasureNames = measures
+        .concat(dimensions)
+        .map(function (x) { return x.name; });
+    for (var _i = 0, orderByParam_1 = orderByParam; _i < orderByParam_1.length; _i++) {
+        var orderBy = orderByParam_1[_i];
+        var name_1 = orderBy.property.name;
+        if (dimensionAndMeasureNames.includes(name_1))
+            continue;
+        unknownDimensionsOrMeasures.push(name_1);
+    }
+    return unknownDimensionsOrMeasures;
+};
 
-var executeDataRequest = function (request, variables) {
-    var _a, _b, _c;
+var LOAD_DATA_EVENT = "embeddable-event:load-data";
+var isLoadDataParams = function (ldp) {
+    return typeof ldp === "object" && "requestParams" in ldp && "dataLoader" in ldp;
+};
+var executeDataRequest = function (request, componentId, propertyName) {
+    var _a;
     if (!request.from)
-        return Promise.reject('No dataset selected');
-    var dimensions = (_a = request.dimensions) === null || _a === void 0 ? void 0 : _a.filter(Boolean);
-    var measures = (_b = request.measures) === null || _b === void 0 ? void 0 : _b.filter(Boolean);
-    var timeDimensions = (_c = request.timeDimensions) === null || _c === void 0 ? void 0 : _c.filter(function (d) { return d.dimension; });
+        return "No dataset selected";
+    var dimensions = normalizeEntities(request.dimensions, { mapFn: getName });
+    var measures = normalizeEntities(request.measures, { mapFn: getName });
+    var timeDimensions = normalizeEntities(request.timeDimensions, {
+        // @ts-expect-error
+        filterFn: getName,
+    });
+    var dimensionsOrMeasuresDefined = dimensions || measures || timeDimensions;
+    if (!dimensionsOrMeasuresDefined)
+        return "At least a dimension or a measure should be selected.";
+    var unknownDimensionsOrMeasures = validateOrderBy((_a = request.orderBy) !== null && _a !== void 0 ? _a : [], dimensions !== null && dimensions !== void 0 ? dimensions : [], measures !== null && measures !== void 0 ? measures : []);
+    if (unknownDimensionsOrMeasures.length) {
+        return "Cannot order by ".concat(unknownDimensionsOrMeasures.join(", "), " as no such ").concat(unknownDimensionsOrMeasures.length === 1 ? "property" : "properties", " has been loaded.");
+    }
     var query = {
         datasetId: request.from.datasetId,
-        dimensions: (dimensions === null || dimensions === void 0 ? void 0 : dimensions.length) ? dimensions : undefined,
-        measures: (measures === null || measures === void 0 ? void 0 : measures.length) ? measures : undefined,
-        timeDimensions: (timeDimensions === null || timeDimensions === void 0 ? void 0 : timeDimensions.length) ? timeDimensions : undefined,
-        variableValues: variables
+        embeddableId: request.from.embeddableId,
+        dimensions: dimensions,
+        measures: measures,
+        timeDimensions: timeDimensions,
+        offset: request.offset,
+        limit: request.limit,
     };
-    if (!query.dimensions && !query.timeDimensions)
-        return Promise.reject('No dimension selected');
-    return axios.post("".concat("https://api.embeddable.com", "/data-modeling/query"), query);
+    window.dispatchEvent(new CustomEvent(LOAD_DATA_EVENT, {
+        bubbles: false,
+        detail: {
+            query: query,
+            componentId: componentId,
+            propertyName: propertyName,
+        },
+    }));
 };
 var loadData = function (requestParams) { return ({
     requestParams: requestParams,
-    dataLoader: executeDataRequest
+    dataLoader: executeDataRequest,
 }); };
 
+var getOperationObject = function (operation, value) { return ({
+    operation: operation,
+    value: value,
+    __embeddableVariableMeta: true,
+}); };
+var Value = {
+    noFilter: function () { return getOperationObject("NO_FILTER"); },
+    of: function (value) { return getOperationObject("VALUE", value); },
+};
+
 var UPDATE_VALUE_EVENT = "embeddable:value:changed";
 var setValue = function (value, componentId, eventName) {
     var event = new CustomEvent(UPDATE_VALUE_EVENT, {
@@ -32,7 +86,7 @@ var setValue = function (value, componentId, eventName) {
         detail: {
             componentId: componentId,
             value: value,
-            eventName: eventName
+            eventName: eventName,
         },
     });
     window.dispatchEvent(event);
@@ -87,12 +141,15 @@ var embedOption = function (typeName, option) {
     if (!window.__EMBEDDABLE__.types[typeName])
         return;
     // @ts-ignore
-    window.__EMBEDDABLE__.types[typeName].options = window.__EMBEDDABLE__.types[typeName].options || [];
+    window.__EMBEDDABLE__.types[typeName].options =
+        window.__EMBEDDABLE__.types[typeName].options || [];
     // @ts-ignore
     window.__EMBEDDABLE__.types[typeName].options.push(option);
 };
 
+exports.Value = Value;
 exports.embedOption = embedOption;
 exports.embedType = embedType;
+exports.isLoadDataParams = isLoadDataParams;
 exports.loadData = loadData;
 exports.setValue = setValue;

package/lib/index.d.ts

@@ -1,4 +1,5 @@
-export * from './loadData';
-export { setValue } from './setValue';
-export { embedType } from './embedType';
-export { embedOption } from './embedOption';
+export * from "./loadData";
+export { Value } from "./operations";
+export { setValue } from "./setValue";
+export { embedType } from "./embedType";
+export { embedOption } from "./embedOption";

package/lib/index.esm.js

@@ -1,28 +1,82 @@
-import axios from 'axios';
+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)
+        return undefined;
+    var filtered = entities.filter(filterFn);
+    if (filtered.length === 0)
+        return undefined;
+    return filtered.map(mapFn);
+};
+var getName = function (x) { return x.name; };
+var validateOrderBy = function (orderByParam, dimensions, measures) {
+    var unknownDimensionsOrMeasures = [];
+    var dimensionAndMeasureNames = measures
+        .concat(dimensions)
+        .map(function (x) { return x.name; });
+    for (var _i = 0, orderByParam_1 = orderByParam; _i < orderByParam_1.length; _i++) {
+        var orderBy = orderByParam_1[_i];
+        var name_1 = orderBy.property.name;
+        if (dimensionAndMeasureNames.includes(name_1))
+            continue;
+        unknownDimensionsOrMeasures.push(name_1);
+    }
+    return unknownDimensionsOrMeasures;
+};
 
-var executeDataRequest = function (request, variables) {
-    var _a, _b, _c;
+var LOAD_DATA_EVENT = "embeddable-event:load-data";
+var isLoadDataParams = function (ldp) {
+    return typeof ldp === "object" && "requestParams" in ldp && "dataLoader" in ldp;
+};
+var executeDataRequest = function (request, componentId, propertyName) {
+    var _a;
     if (!request.from)
-        return Promise.reject('No dataset selected');
-    var dimensions = (_a = request.dimensions) === null || _a === void 0 ? void 0 : _a.filter(Boolean);
-    var measures = (_b = request.measures) === null || _b === void 0 ? void 0 : _b.filter(Boolean);
-    var timeDimensions = (_c = request.timeDimensions) === null || _c === void 0 ? void 0 : _c.filter(function (d) { return d.dimension; });
+        return "No dataset selected";
+    var dimensions = normalizeEntities(request.dimensions, { mapFn: getName });
+    var measures = normalizeEntities(request.measures, { mapFn: getName });
+    var timeDimensions = normalizeEntities(request.timeDimensions, {
+        // @ts-expect-error
+        filterFn: getName,
+    });
+    var dimensionsOrMeasuresDefined = dimensions || measures || timeDimensions;
+    if (!dimensionsOrMeasuresDefined)
+        return "At least a dimension or a measure should be selected.";
+    var unknownDimensionsOrMeasures = validateOrderBy((_a = request.orderBy) !== null && _a !== void 0 ? _a : [], dimensions !== null && dimensions !== void 0 ? dimensions : [], measures !== null && measures !== void 0 ? measures : []);
+    if (unknownDimensionsOrMeasures.length) {
+        return "Cannot order by ".concat(unknownDimensionsOrMeasures.join(", "), " as no such ").concat(unknownDimensionsOrMeasures.length === 1 ? "property" : "properties", " has been loaded.");
+    }
     var query = {
         datasetId: request.from.datasetId,
-        dimensions: (dimensions === null || dimensions === void 0 ? void 0 : dimensions.length) ? dimensions : undefined,
-        measures: (measures === null || measures === void 0 ? void 0 : measures.length) ? measures : undefined,
-        timeDimensions: (timeDimensions === null || timeDimensions === void 0 ? void 0 : timeDimensions.length) ? timeDimensions : undefined,
-        variableValues: variables
+        embeddableId: request.from.embeddableId,
+        dimensions: dimensions,
+        measures: measures,
+        timeDimensions: timeDimensions,
+        offset: request.offset,
+        limit: request.limit,
     };
-    if (!query.dimensions && !query.timeDimensions)
-        return Promise.reject('No dimension selected');
-    return axios.post("".concat("https://api.embeddable.com", "/data-modeling/query"), query);
+    window.dispatchEvent(new CustomEvent(LOAD_DATA_EVENT, {
+        bubbles: false,
+        detail: {
+            query: query,
+            componentId: componentId,
+            propertyName: propertyName,
+        },
+    }));
 };
 var loadData = function (requestParams) { return ({
     requestParams: requestParams,
-    dataLoader: executeDataRequest
+    dataLoader: executeDataRequest,
 }); };
 
+var getOperationObject = function (operation, value) { return ({
+    operation: operation,
+    value: value,
+    __embeddableVariableMeta: true,
+}); };
+var Value = {
+    noFilter: function () { return getOperationObject("NO_FILTER"); },
+    of: function (value) { return getOperationObject("VALUE", value); },
+};
+
 var UPDATE_VALUE_EVENT = "embeddable:value:changed";
 var setValue = function (value, componentId, eventName) {
     var event = new CustomEvent(UPDATE_VALUE_EVENT, {
@@ -30,7 +84,7 @@ var setValue = function (value, componentId, eventName) {
         detail: {
             componentId: componentId,
             value: value,
-            eventName: eventName
+            eventName: eventName,
         },
     });
     window.dispatchEvent(event);
@@ -85,9 +139,10 @@ var embedOption = function (typeName, option) {
     if (!window.__EMBEDDABLE__.types[typeName])
         return;
     // @ts-ignore
-    window.__EMBEDDABLE__.types[typeName].options = window.__EMBEDDABLE__.types[typeName].options || [];
+    window.__EMBEDDABLE__.types[typeName].options =
+        window.__EMBEDDABLE__.types[typeName].options || [];
     // @ts-ignore
     window.__EMBEDDABLE__.types[typeName].options.push(option);
 };
 
-export { embedOption, embedType, loadData, setValue };
+export { Value, embedOption, embedType, isLoadDataParams, loadData, setValue };

package/lib/index.umd.js

@@ -1,32 +1,88 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('axios')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'axios'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.embeddableSdk = {}, global.axios));
-})(this, (function (exports, axios) { 'use strict';
+    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';
 
-    var executeDataRequest = function (request, variables) {
-        var _a, _b, _c;
+    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)
+            return undefined;
+        var filtered = entities.filter(filterFn);
+        if (filtered.length === 0)
+            return undefined;
+        return filtered.map(mapFn);
+    };
+    var getName = function (x) { return x.name; };
+    var validateOrderBy = function (orderByParam, dimensions, measures) {
+        var unknownDimensionsOrMeasures = [];
+        var dimensionAndMeasureNames = measures
+            .concat(dimensions)
+            .map(function (x) { return x.name; });
+        for (var _i = 0, orderByParam_1 = orderByParam; _i < orderByParam_1.length; _i++) {
+            var orderBy = orderByParam_1[_i];
+            var name_1 = orderBy.property.name;
+            if (dimensionAndMeasureNames.includes(name_1))
+                continue;
+            unknownDimensionsOrMeasures.push(name_1);
+        }
+        return unknownDimensionsOrMeasures;
+    };
+
+    var LOAD_DATA_EVENT = "embeddable-event:load-data";
+    var isLoadDataParams = function (ldp) {
+        return typeof ldp === "object" && "requestParams" in ldp && "dataLoader" in ldp;
+    };
+    var executeDataRequest = function (request, componentId, propertyName) {
+        var _a;
         if (!request.from)
-            return Promise.reject('No dataset selected');
-        var dimensions = (_a = request.dimensions) === null || _a === void 0 ? void 0 : _a.filter(Boolean);
-        var measures = (_b = request.measures) === null || _b === void 0 ? void 0 : _b.filter(Boolean);
-        var timeDimensions = (_c = request.timeDimensions) === null || _c === void 0 ? void 0 : _c.filter(function (d) { return d.dimension; });
+            return "No dataset selected";
+        var dimensions = normalizeEntities(request.dimensions, { mapFn: getName });
+        var measures = normalizeEntities(request.measures, { mapFn: getName });
+        var timeDimensions = normalizeEntities(request.timeDimensions, {
+            // @ts-expect-error
+            filterFn: getName,
+        });
+        var dimensionsOrMeasuresDefined = dimensions || measures || timeDimensions;
+        if (!dimensionsOrMeasuresDefined)
+            return "At least a dimension or a measure should be selected.";
+        var unknownDimensionsOrMeasures = validateOrderBy((_a = request.orderBy) !== null && _a !== void 0 ? _a : [], dimensions !== null && dimensions !== void 0 ? dimensions : [], measures !== null && measures !== void 0 ? measures : []);
+        if (unknownDimensionsOrMeasures.length) {
+            return "Cannot order by ".concat(unknownDimensionsOrMeasures.join(", "), " as no such ").concat(unknownDimensionsOrMeasures.length === 1 ? "property" : "properties", " has been loaded.");
+        }
         var query = {
             datasetId: request.from.datasetId,
-            dimensions: (dimensions === null || dimensions === void 0 ? void 0 : dimensions.length) ? dimensions : undefined,
-            measures: (measures === null || measures === void 0 ? void 0 : measures.length) ? measures : undefined,
-            timeDimensions: (timeDimensions === null || timeDimensions === void 0 ? void 0 : timeDimensions.length) ? timeDimensions : undefined,
-            variableValues: variables
+            embeddableId: request.from.embeddableId,
+            dimensions: dimensions,
+            measures: measures,
+            timeDimensions: timeDimensions,
+            offset: request.offset,
+            limit: request.limit,
         };
-        if (!query.dimensions && !query.timeDimensions)
-            return Promise.reject('No dimension selected');
-        return axios.post("".concat("https://api.embeddable.com", "/data-modeling/query"), query);
+        window.dispatchEvent(new CustomEvent(LOAD_DATA_EVENT, {
+            bubbles: false,
+            detail: {
+                query: query,
+                componentId: componentId,
+                propertyName: propertyName,
+            },
+        }));
     };
     var loadData = function (requestParams) { return ({
         requestParams: requestParams,
-        dataLoader: executeDataRequest
+        dataLoader: executeDataRequest,
     }); };
 
+    var getOperationObject = function (operation, value) { return ({
+        operation: operation,
+        value: value,
+        __embeddableVariableMeta: true,
+    }); };
+    var Value = {
+        noFilter: function () { return getOperationObject("NO_FILTER"); },
+        of: function (value) { return getOperationObject("VALUE", value); },
+    };
+
     var UPDATE_VALUE_EVENT = "embeddable:value:changed";
     var setValue = function (value, componentId, eventName) {
         var event = new CustomEvent(UPDATE_VALUE_EVENT, {
@@ -34,7 +90,7 @@
             detail: {
                 componentId: componentId,
                 value: value,
-                eventName: eventName
+                eventName: eventName,
             },
         });
         window.dispatchEvent(event);
@@ -89,13 +145,16 @@
         if (!window.__EMBEDDABLE__.types[typeName])
             return;
         // @ts-ignore
-        window.__EMBEDDABLE__.types[typeName].options = window.__EMBEDDABLE__.types[typeName].options || [];
+        window.__EMBEDDABLE__.types[typeName].options =
+            window.__EMBEDDABLE__.types[typeName].options || [];
         // @ts-ignore
         window.__EMBEDDABLE__.types[typeName].options.push(option);
     };
 
+    exports.Value = Value;
     exports.embedOption = embedOption;
     exports.embedType = embedType;
+    exports.isLoadDataParams = isLoadDataParams;
     exports.loadData = loadData;
     exports.setValue = setValue;
 

package/lib/loadData.d.ts

@@ -1,22 +1,70 @@
-import axios from 'axios';
-export type TimeDimensions = {
-    dimension: string;
-    granularity: string;
+declare const cubeType: {
+    readonly string: "string";
+    readonly number: "number";
+    readonly time: "time";
+};
+export type CubeType = keyof typeof cubeType;
+export type Dimension = {
+    name: string;
+    title: string;
+    type: CubeType;
+};
+export type Measure = {
+    name: string;
+    title: string;
+    type: string;
+};
+export type DimensionOrMeasure = Dimension | Measure;
+declare const timeDimensionGranularity: {
+    second: string;
+    minute: string;
+    hour: string;
+    day: string;
+    week: string;
+    month: string;
+    quarter: string;
+    year: string;
+};
+export type Granularity = keyof typeof timeDimensionGranularity;
+export type TimeDimension = {
+    name: string;
+    granularity: Granularity;
+};
+export type OrderDirection = "asc" | "desc";
+export type OrderBy = {
+    property: DimensionOrMeasure;
+    direction: OrderDirection;
+};
+export type LoadDataEvent = {
+    query: QueryRequest;
+    componentId: string;
+    propertyName: string;
+};
+type QueryRequest = {
+    embeddableId: string;
+    datasetId: string;
+    dimensions: string[];
+    measures?: string[];
+    timeDimensions?: TimeDimension[];
 };
 export type Dataset = {
+    embeddableId: string;
     datasetId: string;
 };
 export type LoadDataRequest = {
     from: Dataset;
-    measures?: string[];
-    dimensions: string[];
-    timeDimensions?: TimeDimensions[];
-    orderBy?: string[];
+    measures?: Measure[];
+    dimensions?: Dimension[];
+    timeDimensions?: TimeDimension[];
+    orderBy?: OrderBy[];
+    limit?: number;
+    offset?: number;
 };
 export type LoadDataParams = {
     requestParams: LoadDataRequest;
     dataLoader: typeof executeDataRequest;
 };
-declare const executeDataRequest: (request: LoadDataRequest, variables?: Record<string, any>) => Promise<axios.AxiosResponse<any, any>>;
+export declare const isLoadDataParams: (ldp: unknown) => ldp is LoadDataParams;
+declare const executeDataRequest: (request: LoadDataRequest, componentId: string, propertyName: string) => string;
 export declare const loadData: (requestParams: LoadDataRequest) => LoadDataParams;
 export {};

package/lib/operations.d.ts

@@ -0,0 +1,11 @@
+type OperationType = "NO_FILTER" | "VALUE";
+type Operation = {
+    operation: OperationType;
+    value?: unknown;
+};
+export type ValueOperationType = {
+    noFilter: () => Operation;
+    of: (value: unknown) => Operation;
+};
+export declare const Value: ValueOperationType;
+export {};

package/lib/untils.d.ts

@@ -0,0 +1,9 @@
+import { Dimension, Measure, OrderBy } from "./loadData";
+export declare const normalizeEntities: <T>(entities: T[], { mapFn, filterFn, }: {
+    mapFn?: (_: T) => any;
+    filterFn?: (_: T) => boolean;
+}) => any[];
+export declare const getName: <T extends {
+    name: string;
+}>(x: T) => string;
+export declare const validateOrderBy: (orderByParam: OrderBy[], dimensions: Dimension[], measures: Measure[]) => any[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embeddable.com/sdk-core",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "Core Embeddable SDK module responsible for web-components bundling and publishing.",
   "keywords": [
     "embeddable",
@@ -35,7 +35,12 @@
     "archiver": "^5.3.1",
     "axios": "^1.4.0",
     "formdata-node": "^5.0.1",
-    "prompt": "^1.3.0",
-    "ora": "^6.3.1"
+    "open": "^9.1.0",
+    "yaml": "^2.3.3"
+  },
+  "lint-staged": {
+    "*.{js,ts,json}": [
+      "prettier --write"
+    ]
   }
 }

package/scripts/build.js

@@ -5,16 +5,16 @@ const { cleanup } = require("./cleanup");
 const { createContext } = require("./createContext");
 
 async function build(pluginOptions = {}) {
-    const ctx = {
-        ...createContext(path.resolve(__dirname, '..'), process.cwd()),
-        pluginOptions
-    };
+  const ctx = {
+    ...createContext(path.resolve(__dirname, ".."), process.cwd()),
+    pluginOptions,
+  };
 
-    await prepare(ctx);
+  await prepare(ctx);
 
-    await generate(ctx);
+  await generate(ctx);
 
-    await cleanup(ctx);
+  await cleanup(ctx);
 }
 
 module.exports = { build };