@drayman/elements 1.79.0 → 1.81.0

package/dist/types/superset/src/app/models/superset-options.d.ts

@@ -0,0 +1,38 @@
+export interface DraymanSuperset {
+    /**
+     * Superset instance URL, including protocol.
+     */
+    supersetDomain: string;
+    /**
+     * Embed identifier generated by the Superset embedding UI.
+     */
+    embedId: string;
+    /**
+     * Called by the element when Superset needs a guest token.
+     */
+    onFetchGuestToken: ElementEvent<{}>;
+    /**
+     * Dashboard UI configuration passed to the Superset Embedded SDK.
+     */
+    dashboardUiConfig?: {
+        hideTitle?: boolean;
+        hideTab?: boolean;
+        hideChartControls?: boolean;
+        filters?: {
+            [key: string]: boolean | undefined;
+            visible?: boolean;
+            expanded?: boolean;
+        };
+        urlParams?: {
+            [key: string]: string | number | boolean;
+        };
+    };
+    /**
+     * Additional iframe sandbox permissions.
+     */
+    iframeSandboxExtras?: string[];
+    /**
+     * Referrer policy applied to the embedded iframe request.
+     */
+    referrerPolicy?: ReferrerPolicy;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drayman/elements",
-  "version": "1.79.0",
+  "version": "1.81.0",
   "description": "A collection of web components for Drayman.",
   "license": "MIT",
   "keywords": [
@@ -12,7 +12,7 @@
     "build:types": "tsc -p ./tsconfig.types.json",
     "typedoc": "npm run build:types && typedoc --tsconfig ./tsconfig.types.json",
     "lint": "ng lint",
-    "build": "npm run build:calendar && npm run build:code-editor && npm run build:button && npm run build:text-field && npm run build:claviz-charts && npm run build:file-uploader && npm run build:number-field && npm run build:select && npm run build:table && npm run build:checkbox && npm run build:slider && npm run build:textarea-field && npm run build:radio-group && npm run build:datepicker && npm run build:timepicker && npm run build:pdf-viewer && npm run build:ngx-charts && npm run build:menu && npm run build:ngx-graph && npm run build:youtube-player && npm run build:nebula && npm run build:grid && npm run build:gauge && npm run build:year-calendar && npm run typedoc",
+    "build": "npm run build:calendar && npm run build:code-editor && npm run build:button && npm run build:text-field && npm run build:claviz-charts && npm run build:file-uploader && npm run build:number-field && npm run build:select && npm run build:table && npm run build:checkbox && npm run build:slider && npm run build:textarea-field && npm run build:radio-group && npm run build:datepicker && npm run build:timepicker && npm run build:pdf-viewer && npm run build:ngx-charts && npm run build:menu && npm run build:ngx-graph && npm run build:youtube-player && npm run build:nebula && npm run build:superset && npm run build:grid && npm run build:gauge && npm run build:year-calendar && npm run typedoc",
     "build:code-editor": "ng build code-editor --extra-webpack-config webpack.partial.js --configuration production --single-bundle --output-hashing=none",
     "build:calendar": "ng build calendar --configuration production --single-bundle --output-hashing=none",
     "build:button": "ng build button --configuration production --single-bundle --output-hashing=none",
@@ -24,6 +24,7 @@
     "build:grid": "ng build grid --configuration production --single-bundle --output-hashing=none",
     "build:youtube-player": "ng build youtube-player --configuration production --single-bundle --output-hashing=none",
     "build:nebula": "ng build nebula --configuration production --single-bundle --output-hashing=none",
+    "build:superset": "ng build superset --configuration production --single-bundle --output-hashing=none",
     "build:table": "ng build table --configuration production --single-bundle --output-hashing=none",
     "build:checkbox": "ng build checkbox --configuration production --single-bundle --output-hashing=none",
     "build:slider": "ng build slider --configuration production --single-bundle --output-hashing=none",
@@ -78,6 +79,9 @@
       "drayman-nebula": {
         "script": "./dist/nebula/main.js"
       },
+      "drayman-superset": {
+        "script": "./dist/superset/main.js"
+      },
       "drayman-table": {
         "script": "./dist/table/main.js"
       },
@@ -143,6 +147,7 @@
     "@nebula.js/stardust": "5.11.0",
     "@ngneat/spectator": "5.13.2",
     "@qlik/api": "^1.29.0",
+    "@superset-ui/embedded-sdk": "^0.3.0",
     "@swimlane/ngx-charts": "16.0.0",
     "@swimlane/ngx-graph": "8.0.0",
     "@types/jest": "26.0.13",
@@ -197,4 +202,4 @@
     "typescript-json-schema": "0.43.0",
     "zone.js": "~0.11.4"
   }
-}
+}

package/types/index.d.ts

@@ -18,6 +18,7 @@ import { DraymanTextareaField } from '../dist/types/textarea-field/src/app/model
 import { DraymanTimepicker } from '../dist/types/timepicker/src/app/models/timepicker-options';
 import { DraymanYoutubePlayer } from '../dist/types/youtube-player/src/app/models/youtube-player-options';
 import { DraymanNebula } from '../dist/types/nebula/src/app/models/nebula-options';
+import { DraymanSuperset } from '../dist/types/superset/src/app/models/superset-options';
 import { DraymanGrid } from '../dist/types/grid/src/app/models/grid-options';
 import { DraymanCodeEditor } from '../dist/types/code-editor/src/app/models/code-editor-options';
 import { DraymanCalendar } from '../dist/types/calendar/src/app/models/calendar-options';
@@ -1296,6 +1297,43 @@ declare global {
      * ```
      */
     interface DraymanNebulaProps extends DraymanNebula, DraymanElementsProps { }
+    /**
+     * # <drayman-superset \/>
+     *
+     * Apache Superset dashboard integration element powered by the
+     * [Superset Embedded SDK](https://www.npmjs.com/package/@superset-ui/embedded-sdk).
+     *
+     * ## Example of usage
+     *
+     * ```typescript
+     * export const component: DraymanComponent = async ({ forceUpdate }) => {
+     * 
+     *     return () => {
+     *         const dashboardUiConfig = {
+     *             hideTitle: true,
+     *             hideTab: true,
+     *             hideChartControls: false,
+     *             filters: {
+     *                 visible: true,
+     *                 expanded: false,
+     *             },
+     *         };
+     * 
+     *         return (
+     *             <drayman-superset
+     *                 supersetDomain="http://superset"
+     *                 embedId="01879ce0-6016-4332-b535-f5f1950f9364"
+     *                 onFetchGuestToken={async () => {
+     *                     return `token`;
+     *                 }}
+     *                 dashboardUiConfig={dashboardUiConfig}
+     *             />
+     *         );
+     *     }
+     * }
+     * ```
+     */
+    interface DraymanSupersetProps extends DraymanSuperset, DraymanElementsProps { }
 
     namespace JSX {
         export interface IntrinsicElements {
@@ -1317,6 +1355,7 @@ declare global {
             'drayman-timepicker': DraymanTimepickerProps;
             'drayman-youtube-player': DraymanYoutubePlayerProps;
             'drayman-nebula': DraymanNebulaProps;
+            'drayman-superset': DraymanSupersetProps;
             'drayman-grid': DraymanGridProps;
             'drayman-code-editor': DraymanCodeEditorProps;
             'drayman-calendar': DraymanCalendarProps;
@@ -1324,4 +1363,4 @@ declare global {
     }
 }
 
-export { };
+export { };