@sisense/sdk-cli 1.8.0 → 1.9.0

package/dist/commands/helpers.d.ts

@@ -1,5 +1,7 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { DataModel } from '@sisense/sdk-data';
+import { DataSourceField } from '@sisense/sdk-query-client';
+import { DataSourceSchemaDataset } from '../types.js';
 declare function getHttpClient(url: string, username?: string, password?: string, token?: string, wat?: string): HttpClient;
 export declare const handleHttpClientLogin: (httpClient: HttpClient) => Promise<void>;
 /**
@@ -27,4 +29,8 @@ export declare type SupportedOutputFilePathInfo = FilePathInfo & {
     extension: SupportedOutputFileExtension;
 };
 declare function isSupportedOutputFile(filePathInfo: FilePathInfo): filePathInfo is SupportedOutputFilePathInfo;
+/**
+ * Add 'description' property from datasource schema columns to datasource fields
+ */
+export declare function addDescriptionToFields(fields: DataSourceField[], datasets: DataSourceSchemaDataset[]): DataSourceField[];
 export { getHttpClient, createDataModel, rewriteDataModel, writeFile, getFilePathInfo, isSupportedOutputFile, };

package/dist/commands/helpers.js

@@ -1,5 +1,3 @@
-/* eslint-disable max-lines */
-/* eslint-disable max-lines-per-function */
 /* eslint-disable max-params */
 /* eslint-disable @typescript-eslint/restrict-template-expressions */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
@@ -11,7 +9,8 @@ import { HttpClient, getAuthenticator, WatAuthenticator, BearerAuthenticator, }
 import { MetadataTypes } from '@sisense/sdk-data';
 import { writeTypescript, writeJavascript } from '@sisense/sdk-modeling';
 import path from 'path';
-import { DimensionalQueryClient } from '@sisense/sdk-query-client';
+import levenshtein from 'js-levenshtein';
+import { DimensionalQueryClient, } from '@sisense/sdk-query-client';
 import { PKG_VERSION } from '../package-version.js';
 import { trackCliError } from '@sisense/sdk-tracking';
 function getHttpClient(url, username, password, token, wat) {
@@ -39,24 +38,74 @@ export const handleHttpClientLogin = async (httpClient) => {
     }
     return Promise.resolve();
 };
+async function retrieveDataSource(queryClient, dataSourceTitle) {
+    console.log('Getting data source... ');
+    const dataSourceList = await queryClient.getDataSourceList();
+    let minDistance = Number.MAX_SAFE_INTEGER;
+    let minDistanceDataSource = { title: dataSourceTitle, live: false };
+    dataSourceList.forEach((dataSource) => {
+        const title = dataSource.title;
+        if (title === dataSourceTitle) {
+            minDistanceDataSource = dataSource;
+            minDistance = 0;
+        }
+        else {
+            // get the most matching data source by comparing levenshtein distance on the title
+            const distance = levenshtein(dataSourceTitle, title);
+            if (distance < minDistance) {
+                minDistance = distance;
+                minDistanceDataSource = dataSource;
+            }
+        }
+    });
+    if (minDistance === 0) {
+        console.log('OK!\r\n');
+        return minDistanceDataSource;
+    }
+    throw new Error(`Data source '${dataSourceTitle}' not found. ${minDistance <= 3 ? `Did you mean '${minDistanceDataSource.title}'?` : ''}`);
+}
+async function retrieveDataFields(queryClient, dataSourceTitle) {
+    console.log('Getting fields... ');
+    const fields = await queryClient.getDataSourceFields(dataSourceTitle);
+    try {
+        // get the schema of the data source to add descriptions to the fields
+        const dataSourceSchema = await queryClient.getDataSourceSchema(dataSourceTitle);
+        return addDescriptionToFields(fields, dataSourceSchema.datasets);
+    }
+    catch (error) {
+        if (error.status === '403') {
+            // the caller may not have permission to access this data source
+            console.log(`Note: Field descriptions are omitted from the data model due to restricted role of your account`);
+        }
+        else {
+            throw error;
+        }
+    }
+    finally {
+        console.log('OK!\r\n');
+    }
+    return fields;
+}
+function combineDataSourceAndDataFields(dataSource, dataFields) {
+    return {
+        name: dataSource.title,
+        dataSource: {
+            title: dataSource.title,
+            type: dataSource.live ? 'live' : 'elasticube',
+        },
+        metadata: dataFields,
+    };
+}
 /**
  * Create a data model for a Sisense data source
  */
 async function createDataModel(httpClient, dataSourceTitle) {
     const queryClient = new DimensionalQueryClient(httpClient);
-    console.log('Getting fields... ');
     try {
-        const [fields, dataSourceInfo] = await Promise.all([
-            queryClient.getDataSourceFields(dataSourceTitle),
-            queryClient.getDataSourceInfo(dataSourceTitle),
-        ]);
-        console.log('OK!\r\n');
-        const dataModel = {
-            name: dataSourceTitle,
-            dataSource: dataSourceInfo,
-            metadata: fields,
-        };
-        return rewriteDataModel(dataModel);
+        const dataSource = await retrieveDataSource(queryClient, dataSourceTitle);
+        const dataFields = await retrieveDataFields(queryClient, dataSourceTitle);
+        const rawDataModel = combineDataSourceAndDataFields(dataSource, dataFields);
+        return rewriteDataModel(rawDataModel);
     }
     catch (err) {
         trackCliError({
@@ -78,6 +127,7 @@ function rewriteDataModel(dataModel) {
             expression: item.id,
             type: MetadataTypes.Dimension,
             group: undefined,
+            description: item.description,
         };
         result.group = item.table;
         switch (item.dimtype) {
@@ -165,4 +215,22 @@ function getFullFilePath(filePathInfo) {
 function isSupportedOutputFile(filePathInfo) {
     return ['.ts', '.js'].includes(filePathInfo.extension);
 }
+/**
+ * Add 'description' property from datasource schema columns to datasource fields
+ */
+export function addDescriptionToFields(fields, datasets) {
+    const schemaDataDescriptionsMap = datasets.reduce((map, dataset) => {
+        dataset.schema.tables.forEach((table) => {
+            map[table.name] = {};
+            table.columns.forEach((column) => {
+                map[table.name][column.name] = column.description;
+            });
+        });
+        return map;
+    }, {});
+    return fields.map((field) => ({
+        ...field,
+        description: schemaDataDescriptionsMap[field.table]?.[field.column] || '',
+    }));
+}
 export { getHttpClient, createDataModel, rewriteDataModel, writeFile, getFilePathInfo, isSupportedOutputFile, };

package/dist/package-version.d.ts

@@ -1 +1 @@
-export declare const PKG_VERSION = "1.8.0";
+export declare const PKG_VERSION = "1.9.0";

package/dist/package-version.js

@@ -1 +1 @@
-export const PKG_VERSION = "1.8.0";
+export const PKG_VERSION = "1.9.0";

package/dist/types.d.ts

@@ -19,4 +19,26 @@ export declare type GetApiTokenOptions = {
     username: string;
     password: string | undefined;
 };
+/**
+ * Data source schema table
+ *
+ * @internal
+ */
+export declare type DataSourceSchemaTable = {
+    name: string;
+    columns: {
+        name: string;
+        description: string | null;
+    }[];
+};
+/**
+ * Data source schema table
+ *
+ * @internal
+ */
+export declare type DataSourceSchemaDataset = {
+    schema: {
+        tables: DataSourceSchemaTable[];
+    };
+};
 export {};

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.8.0",
+  "version": "1.9.0",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -20,14 +20,15 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "bin": "./dist/index.js",
   "dependencies": {
-    "@sisense/sdk-common": "^1.8.0",
-    "@sisense/sdk-data": "^1.8.0",
-    "@sisense/sdk-modeling": "^1.8.0",
-    "@sisense/sdk-query-client": "^1.8.0",
-    "@sisense/sdk-rest-client": "^1.8.0",
-    "@sisense/sdk-tracking": "^1.8.0",
+    "@sisense/sdk-common": "^1.9.0",
+    "@sisense/sdk-data": "^1.9.0",
+    "@sisense/sdk-modeling": "^1.9.0",
+    "@sisense/sdk-query-client": "^1.9.0",
+    "@sisense/sdk-rest-client": "^1.9.0",
+    "@sisense/sdk-tracking": "^1.9.0",
     "cross-fetch": "^4.0.0",
     "inquirer": "^8.1.2",
+    "js-levenshtein": "^1.1.6",
     "node-window-polyfill": "^1.0.2",
     "yargs": "17.7.1"
   },
@@ -54,6 +55,7 @@
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
     "@types/inquirer": "8.2.6",
+    "@types/js-levenshtein": "^1.1.3",
     "@types/yargs": "^17.0.22",
     "eslint": "^8.40.0",
     "msw": "2.2.1",