Release v0.11.3

.github/workflows/publish-to-packages.yml

@@ -1,5 +1,5 @@
 name: publish-to-packages
-run-name: publishing to GitHub Packages
+run-name: publishing to NPM
 on:
   push:
     branches:
@@ -13,10 +13,10 @@ jobs:
         with:
           node-version: '16'
       - run: yarn --version
-      - run: yarn config set npmScopes.sisense.npmRegistryServer https://npm.pkg.github.com
-      - run: yarn config set npmPublishRegistry https://npm.pkg.github.com
-      - run: yarn config set npmAuthToken "${{ secrets.GITHUB_TOKEN }}"
+      - run: yarn config set npmScopes.sisense.npmRegistryServer https://registry.npmjs.org/
+      - run: yarn config set npmPublishRegistry https://registry.npmjs.org/
+      - run: yarn config set npmAuthToken "${{ secrets.NPM_TOKEN }}"
       - run: yarn install --immutable
       - run: yarn build:prod
       - run: ls -lha
-      - run: yarn publish
+      - run: yarn publish --access public

.yarnrc.yml

@@ -7,10 +7,6 @@ changesetIgnorePatterns:
 
 nodeLinker: node-modules
 
-npmScopes:
-  sisense:
-    npmRegistryServer: "https://npm.pkg.github.com"
-
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
     spec: "@yarnpkg/plugin-workspace-tools"

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.11.3] - 2023-10-16
+
+### Changed
+- Switch GitHub CI to publish to NPM instead of GitHub Packages
+- Allow override of breadcrumb position in component `DrilldownWidget`
+
 ## [0.11.2] - 2023-10-12
 
 ### Changed

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE.md",
   "private": true,
@@ -49,6 +49,7 @@
     "@sisense/commitlint-config": "^1.9.9",
     "@sisense/eslint-config": "1.9.12",
     "@sisense/prettier-config": "^1.9.9",
+    "@sisense/typedoc-plugin-markdown": "^4.0.0-next.42",
     "@vitest/coverage-istanbul": "0.34.1",
     "eslint": "^8.40.0",
     "eslint-plugin-tsdoc": "0.2.17",
@@ -59,7 +60,6 @@
     "nyc": "^15.1.0",
     "prettier": "^2.8.8",
     "typedoc": "0.24.8",
-    "typedoc-plugin-markdown": "https://github.com/imtuanpham/typedoc-plugin-markdown#head=compose-sdk-api-doc-md&workspace=typedoc-plugin-markdown",
     "typedoc-plugin-versions": "^0.2.3",
     "vitest": "0.34.1"
   },

packages/sdk-cli/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sisense/sdk-cli",
   "description": "CLI for generating programmatic interface from Sisense data model",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -10,11 +10,11 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "bin": "./dist/index.js",
   "dependencies": {
-    "@sisense/sdk-common": "^0.11.2",
-    "@sisense/sdk-data": "^0.11.2",
-    "@sisense/sdk-modeling": "^0.11.2",
-    "@sisense/sdk-query-client": "^0.11.2",
-    "@sisense/sdk-rest-client": "^0.11.2",
+    "@sisense/sdk-common": "^0.11.3",
+    "@sisense/sdk-data": "^0.11.3",
+    "@sisense/sdk-modeling": "^0.11.3",
+    "@sisense/sdk-query-client": "^0.11.3",
+    "@sisense/sdk-rest-client": "^0.11.3",
     "cross-fetch": "^4.0.0",
     "inquirer": "^8.1.2",
     "yargs": "17.7.1"

packages/sdk-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-common",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "exports": {
     "types": "./dist/index.d.ts",

packages/sdk-data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-data",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
@@ -12,7 +12,7 @@
   "author": "Sisense ",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-rest-client": "^0.11.2",
+    "@sisense/sdk-rest-client": "^0.11.3",
     "guid-typescript": "^1.0.9",
     "numeral": "^2.0.6"
   },

packages/sdk-modeling/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-modeling",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",
@@ -9,7 +9,7 @@
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@sisense/sdk-data": "^0.11.2",
+    "@sisense/sdk-data": "^0.11.3",
     "typescript": "4.8.4"
   },
   "scripts": {

packages/sdk-query-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-query-client",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -9,8 +9,8 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-data": "^0.11.2",
-    "@sisense/sdk-rest-client": "^0.11.2",
+    "@sisense/sdk-data": "^0.11.3",
+    "@sisense/sdk-rest-client": "^0.11.3",
     "@sisense/task-manager": "^0.1.0",
     "numeral": "^2.0.6",
     "uuid": "^9.0.0"

packages/sdk-rest-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-rest-client",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",

packages/sdk-ui-angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui-angular",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "main": "./dist/index.d.ts",
   "module": "./dist/index.d.ts",

packages/sdk-ui-preact/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui-preact",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "exports": {
     ".": {
@@ -14,7 +14,7 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-ui": "^0.11.2",
+    "@sisense/sdk-ui": "^0.11.3",
     "preact": "^10.13.2"
   },
   "scripts": {

packages/sdk-ui-vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui-vue",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",

packages/sdk-ui/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -13,9 +13,9 @@
     "@emotion/styled": "^11.10.5",
     "@mui/material": "^5.11.6",
     "@sisense/sdk-common": "workspace:^",
-    "@sisense/sdk-data": "^0.11.2",
-    "@sisense/sdk-query-client": "^0.11.2",
-    "@sisense/sdk-rest-client": "^0.11.2",
+    "@sisense/sdk-data": "^0.11.3",
+    "@sisense/sdk-query-client": "^0.11.3",
+    "@sisense/sdk-rest-client": "^0.11.3",
     "@sisense/sisense-charts": "5.1.0-alpha-04052758.0",
     "classnames": "^2.3.2",
     "colorjs.io": "^0.4.3",

packages/sdk-ui/src/__demo__/pages/drilldown-widget-demo.tsx

@@ -6,6 +6,7 @@ import { ExecuteQuery } from '../../query-execution/execute-query';
 import { DataPoint } from '../../types';
 import { Chart } from '../../chart';
 import { PlotlyDotChart } from './plotly-dot-chart';
+import { DrilldownBreadcrumbs } from '../../widgets/common/drilldown-breadcrumbs';
 
 const dataOptions = {
   category: [DM.Category.Category],
@@ -22,8 +23,18 @@ export const DrilldownWidgetDemo = () => (
         <DrilldownWidget
           drilldownDimensions={[DM.Commerce.AgeRange, DM.Commerce.Gender, DM.Commerce.Condition]}
           initialDimension={dataOptions.category[0]}
+          config={{
+            isBreadcrumbsDetached: true,
+            breadcrumbsComponent: DrilldownBreadcrumbs,
+          }}
         >
-          {({ drilldownFilters, drilldownDimension, onDataPointsSelected, onContextMenu }) => {
+          {({
+            drilldownFilters,
+            drilldownDimension,
+            onDataPointsSelected,
+            onContextMenu,
+            breadcrumbsComponent,
+          }) => {
             const onPointsSelected = (points: DataPoint[], nativeEvent: MouseEvent) => {
               onDataPointsSelected(points, nativeEvent);
               onContextMenu({
@@ -41,16 +52,19 @@ export const DrilldownWidgetDemo = () => (
             };
 
             return (
-              <Chart
-                chartType={'column'}
-                dataOptions={{
-                  ...dataOptions,
-                  category: [drilldownDimension],
-                }}
-                filters={drilldownFilters}
-                onDataPointsSelected={onPointsSelected}
-                onDataPointContextMenu={onPointClick}
-              />
+              <>
+                <Chart
+                  chartType={'column'}
+                  dataOptions={{
+                    ...dataOptions,
+                    category: [drilldownDimension],
+                  }}
+                  filters={drilldownFilters}
+                  onDataPointsSelected={onPointsSelected}
+                  onDataPointContextMenu={onPointClick}
+                />
+                <div>{breadcrumbsComponent}</div>
+              </>
             );
           }}
         </DrilldownWidget>

packages/sdk-ui/src/props.tsx

@@ -25,7 +25,7 @@ import {
   MenuItemSection,
 } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
-import { PropsWithChildren, ReactNode } from 'react';
+import { ComponentType, PropsWithChildren, ReactNode } from 'react';
 import {
   IndicatorDataOptions,
   ScatterChartDataOptions,
@@ -950,6 +950,32 @@ export type DrilldownBreadcrumbsProps = {
   sliceDrilldownSelections: (i: number) => void;
 };
 
+/**
+ * An object that allows users to pass advanced configuration options as a prop for the {@link DrilldownWidget} component
+ */
+export type DrilldownWidgetConfig = {
+  /**
+   * Boolean to override default breadcrumbs location and instead only return them as a property of the 'children' function
+   *
+   * @category Widget
+   */
+  isBreadcrumbsDetached?: boolean;
+  /**
+   * React component to be rendered as breadcrumbs
+   *
+   * {@link DrilldownBreadcrumbs} will be used if not provided
+   *
+   * @category Widget
+   */
+  breadcrumbsComponent?: ComponentType<DrilldownBreadcrumbsProps>;
+  /**
+   * Boolean to override default breadcrumbs location and instead only return them as a property of the 'children' function
+   *
+   * @category Widget
+   */
+  contextMenuComponent?: (contextMenuProps: ContextMenuProps) => JSX.Element;
+};
+
 /**
  * Props for the {@link DrilldownWidget} component
  */
@@ -967,26 +993,17 @@ export type DrilldownWidgetProps = {
    */
   initialDimension: Attribute;
   /**
-   * React component to be rendered as breadcrumbs
-   *
-   * {@link DrilldownBreadcrumbs} will be used if not provided
+   * An object that allows users to pass advanced configuration options as a prop for the {@link DrilldownWidget} component
    *
    * @category Widget
    */
-  breadcrumbsComponent?: (drilldownBreadcrumbProps: DrilldownBreadcrumbsProps) => JSX.Element;
+  config?: DrilldownWidgetConfig;
   /**
    * React component to be rendered as context menu
    *
    * {@link ContextMenu} will be used if not provided
    *
    * @category Widget
    */
-  contextMenuComponent?: (contextMenuProps: ContextMenuProps) => JSX.Element;
-  /**
-   * A function that allows to pass calculated drilldown filters
-   * and new dimension to a ReactNode to be rendered (custom chart)
-   *
-   * @category Widget
-   */
   children: (customDrilldownResult: CustomDrilldownResult) => ReactNode;
 };

packages/sdk-ui/src/types.ts

@@ -816,4 +816,8 @@ export type CustomDrilldownResult = {
    * Callback to open context menu
    */
   onContextMenu: (menuPosition: MenuPosition) => void;
+  /**
+   * Breadcrumbs that only allow for selection slicing, clearing, & navigation
+   */
+  breadcrumbsComponent?: JSX.Element;
 };