@sisense/sdk-modeling 1.4.1 → 1.5.0

package/dist/typescript/utils/format-code.d.ts

@@ -0,0 +1,2 @@
+export declare type CodeType = 'ts' | 'js';
+export declare function formatCode(code: string, codeType: CodeType): Promise<string>;

package/dist/typescript/utils/format-code.js

@@ -0,0 +1,25 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as prettier from 'prettier';
+const prettierConfig = {
+    semi: true,
+    trailingComma: 'all',
+    endOfLine: 'lf',
+    singleQuote: true,
+    printWidth: 100,
+    tabWidth: 4,
+    arrowParens: 'always',
+};
+export function formatCode(code, codeType) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const parser = codeType === 'ts' ? 'typescript' : 'babel';
+        return prettier.format(code, Object.assign(Object.assign({}, prettierConfig), { parser }));
+    });
+}

package/dist/typescript/writer.js

@@ -20,7 +20,10 @@ import { DimensionWriter, DateDimensionWriter } from './writers/dimensions.js';
 import { NEWLINE } from './writers/base.js';
 import { createInMemoryDuplexStream } from './utils/create-in-memory-duplex-stream.js';
 import { compileTsCode } from './utils/compile-ts-code.js';
-function getWriter(item) {
+import { formatCode } from './utils/format-code.js';
+import { DataSourceWriter } from './writers/datasource.js';
+import { ImportsWriter } from './writers/imports.js';
+function getMetadataWriter(item) {
     if (MetadataTypes.isDateDimension(item.type)) {
         return new DateDimensionWriter(item, false);
     }
@@ -42,17 +45,14 @@ function fillStreamWithTsCode(stream, json, config) {
     // generating a dimensional data model from the input json
     const dm = DimensionalDataModel.fromConfig(json);
     const writers = [];
-    for (let i = 0; i < dm.metadata.length; i++) {
-        writers.push(getWriter(dm.metadata[i]));
+    writers.push(new ImportsWriter(dm.dataSource, config.datamodule));
+    writers.push(new DataSourceWriter(dm.dataSource));
+    for (const metadataItem of dm.metadata) {
+        writers.push(getMetadataWriter(metadataItem));
     }
-    // writing imports
-    const datamodule = config.datamodule || '@sisense/sdk-data';
-    stream.write(`import type { Dimension, DateDimension, Attribute } from '${datamodule}';${NEWLINE}
-import { createAttribute, createDateDimension, createDimension } from '${datamodule}';${NEWLINE}${NEWLINE}`);
-    stream.write(`export const DataSource = '${dm.dataSource}';${NEWLINE}`);
-    for (let i = 0; i < writers.length; i++) {
+    for (const writer of writers) {
         stream.write(NEWLINE);
-        writers[i].write(stream, 0);
+        writer.write(stream, 0);
         stream.write(NEWLINE);
     }
     return stream;
@@ -65,9 +65,12 @@ export function writeTypescript(json, config) {
         const filePath = path.join(config.dir || '', `${config.filename}.ts`);
         const fileStream = createWriteStream(filePath, { encoding: 'utf-8' });
         const tsCodeStream = createInMemoryDuplexStream();
-        tsCodeStream.pipe(fileStream);
         fillStreamWithTsCode(tsCodeStream, json, config);
         tsCodeStream.end();
+        const unformattedTsCode = tsCodeStream.getStringData();
+        const tsCode = yield formatCode(unformattedTsCode, 'ts');
+        fileStream.write(tsCode);
+        fileStream.end();
         return new Promise((resolve) => {
             fileStream.on('finish', () => {
                 resolve();
@@ -88,7 +91,11 @@ export function writeJavascript(json, config) {
         fillStreamWithTsCode(tsCodeStream, json, config);
         tsCodeStream.end();
         const tsCode = tsCodeStream.getStringData();
-        const { jsCode, typeDefs } = compileTsCode(tsCode);
+        const { jsCode: unformattedJsCode, typeDefs: unformattedTypeDefs } = compileTsCode(tsCode);
+        const [jsCode, typeDefs] = yield Promise.all([
+            formatCode(unformattedJsCode, 'js'),
+            formatCode(unformattedTypeDefs, 'ts'),
+        ]);
         jsFileStream.write(jsCode);
         dtsFileStream.write(typeDefs);
         jsFileStream.end();

package/dist/typescript/writers/base.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="node" resolution-mode="require"/>
+import { Writer } from './interfaces.js';
 export declare const NEWLINE = "\n";
 export declare function writeIndented(stream: NodeJS.WritableStream, s: string, idnt: number): void;
 export declare function template(strings: TemplateStringsArray, ...keys: string[]): any;
 export declare function rnt(idnt: number): string;
 export declare function indent(ident: number): string;
-export declare abstract class BaseWriter<T> {
+export declare abstract class ElementWriter<T> implements Writer {
     readonly element: T;
     readonly name: string;
     constructor(element: T, name: string);

package/dist/typescript/writers/base.js

@@ -30,7 +30,7 @@ export function indent(ident) {
     // use two whitespaces for indentation
     return '  '.repeat(ident);
 }
-export class BaseWriter {
+export class ElementWriter {
     constructor(element, name) {
         this.element = element;
         this.name = name;

package/dist/typescript/writers/datasource.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" resolution-mode="require"/>
+import { DataSource } from '@sisense/sdk-data';
+import { Writer } from './interfaces.js';
+export declare class DataSourceWriter implements Writer {
+    private dataSource;
+    constructor(dataSource: DataSource);
+    write(stream: NodeJS.WritableStream): void;
+}

package/dist/typescript/writers/datasource.js

@@ -0,0 +1,20 @@
+import { NEWLINE } from './base.js';
+export class DataSourceWriter {
+    constructor(dataSource) {
+        this.dataSource = dataSource;
+    }
+    write(stream) {
+        if (isDataSourceInfo(this.dataSource)) {
+            stream.write(`export const DataSource: DataSourceInfo = ${JSON.stringify(this.dataSource)};${NEWLINE}`);
+        }
+        else {
+            stream.write(`export const DataSource = '${this.dataSource}';${NEWLINE}`);
+        }
+    }
+}
+/**
+ * Function to check if the provided data source is a data source info object
+ */
+function isDataSourceInfo(dataSource) {
+    return typeof dataSource === 'object' && 'type' in dataSource && 'title' in dataSource;
+}

package/dist/typescript/writers/dimensions.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import { Dimension, DateDimension, Attribute, LevelAttribute } from '@sisense/sdk-data';
-import { BaseWriter } from './base.js';
-export declare class DimensionWriter extends BaseWriter<Dimension> {
+import { ElementWriter } from './base.js';
+export declare class DimensionWriter extends ElementWriter<Dimension> {
     readonly isMultiAtts: boolean;
     readonly isCompound: boolean;
     readonly attributes: AttributeWriter[];
@@ -14,7 +14,7 @@ export declare class DimensionWriter extends BaseWriter<Dimension> {
     writeDef(stream: NodeJS.WritableStream, ident: number): void;
     write(stream: NodeJS.WritableStream, ident: number): any;
 }
-export declare class DateDimensionWriter extends BaseWriter<DateDimension> {
+export declare class DateDimensionWriter extends ElementWriter<DateDimension> {
     readonly isNested: boolean;
     private levels;
     constructor(dimension: DateDimension, isNested: boolean);
@@ -24,11 +24,11 @@ export declare class DateDimensionWriter extends BaseWriter<DateDimension> {
     writeDef(stream: NodeJS.WritableStream, ident: number): void;
     write(stream: NodeJS.WritableStream, ident: number): any;
 }
-export declare class AttributeWriter extends BaseWriter<Attribute> {
+export declare class AttributeWriter extends ElementWriter<Attribute> {
     constructor(attribute: Attribute);
     write(stream: NodeJS.WritableStream, ident: number): any;
 }
-export declare class LevelWriter extends BaseWriter<LevelAttribute> {
+export declare class LevelWriter extends ElementWriter<LevelAttribute> {
     constructor(level: LevelAttribute);
     write(stream: NodeJS.WritableStream, ident: number): any;
 }

package/dist/typescript/writers/dimensions.js

@@ -1,8 +1,8 @@
 /* eslint-disable @typescript-eslint/no-use-before-define */
 /* eslint-disable max-lines */
 import { MetadataTypes, DateLevels, normalizeName, } from '@sisense/sdk-data';
-import { NEWLINE, rnt, writeIndented, BaseWriter } from './base.js';
-export class DimensionWriter extends BaseWriter {
+import { ElementWriter, NEWLINE, rnt, writeIndented } from './base.js';
+export class DimensionWriter extends ElementWriter {
     constructor(dimension, isNested) {
         super(dimension, normalizeName(dimension.name));
         this.isNested = isNested;
@@ -67,7 +67,7 @@ export class DimensionWriter extends BaseWriter {
         this.writeDef(stream, ident);
     }
 }
-export class DateDimensionWriter extends BaseWriter {
+export class DateDimensionWriter extends ElementWriter {
     constructor(dimension, isNested) {
         super(dimension, normalizeName(dimension.name));
         this.isNested = isNested;
@@ -112,7 +112,7 @@ export class DateDimensionWriter extends BaseWriter {
         this.writeDef(stream, ident);
     }
 }
-export class AttributeWriter extends BaseWriter {
+export class AttributeWriter extends ElementWriter {
     constructor(attribute) {
         super(attribute, normalizeName(attribute.name));
     }
@@ -124,7 +124,7 @@ ${rnt(ident + 2)}expression: '${this.element.expression}',\
 ${rnt(ident + 1)}}),`, ident);
     }
 }
-export class LevelWriter extends BaseWriter {
+export class LevelWriter extends ElementWriter {
     constructor(level) {
         super(level, normalizeName(level.name));
     }

package/dist/typescript/writers/imports.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" resolution-mode="require"/>
+import { DataSource } from '@sisense/sdk-data';
+import { Writer } from './interfaces.js';
+export declare class ImportsWriter implements Writer {
+    private dataSource;
+    private dataModule;
+    constructor(dataSource: DataSource, dataModule?: string);
+    write(stream: NodeJS.WritableStream): void;
+}

package/dist/typescript/writers/imports.js

@@ -0,0 +1,16 @@
+import { isDataSourceInfo } from '@sisense/sdk-data';
+import { NEWLINE } from './base.js';
+export class ImportsWriter {
+    constructor(dataSource, dataModule = '@sisense/sdk-data') {
+        this.dataSource = dataSource;
+        this.dataModule = dataModule;
+    }
+    write(stream) {
+        const typesToImport = ['Dimension', 'DateDimension', 'Attribute'];
+        if (isDataSourceInfo(this.dataSource)) {
+            typesToImport.push('DataSourceInfo');
+        }
+        stream.write(`import type { ${typesToImport.join(', ')} } from '${this.dataModule}';${NEWLINE}${NEWLINE}`);
+        stream.write(`import { createAttribute, createDateDimension, createDimension } from '${this.dataModule}';${NEWLINE}${NEWLINE}`);
+    }
+}

package/dist/typescript/writers/interfaces.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" resolution-mode="require"/>
+export interface Writer {
+    write(stream: NodeJS.WritableStream, ident: number): any;
+}

package/dist/typescript/writers/interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/typescript/writers/measures.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import { BaseMeasure, MeasureTemplate } from '@sisense/sdk-data';
-import { BaseWriter } from './base.js';
-export declare abstract class MeasureWriter<T> extends BaseWriter<T> {
+import { ElementWriter } from './base.js';
+export declare abstract class MeasureWriter<T> extends ElementWriter<T> {
     readonly isNested: boolean;
     constructor(measure: T, isNested: boolean);
     abstract writeDef(stream: NodeJS.WritableStream, ident: number): void;

package/dist/typescript/writers/measures.js

@@ -3,8 +3,8 @@
 /* eslint-disable @typescript-eslint/no-useless-constructor */
 /* eslint-disable sonarjs/no-nested-template-literals */
 import { normalizeName } from '@sisense/sdk-data';
-import { NEWLINE, rnt, writeIndented, BaseWriter } from './base.js';
-export class MeasureWriter extends BaseWriter {
+import { NEWLINE, rnt, writeIndented, ElementWriter } from './base.js';
+export class MeasureWriter extends ElementWriter {
     constructor(measure, isNested) {
         super(measure, normalizeName(measure.name));
         this.isNested = isNested;
@@ -27,7 +27,11 @@ export class BaseMeasureWriter extends MeasureWriter {
         writeIndented(stream, `<BaseMeasure>createMeasure({\
                 ${rnt(idnt + 1)}name: "${this.name}", \
                 ${rnt(idnt + 1)}expression: "${this.element.attribute.expression}", \
-                ${rnt(idnt + 1)}agg: "${this.element.aggregation}"${this.element.getFormat() ? `,${rnt(idnt + 1)}format:"${this.element.getFormat()}"` : ''}${this.element.description ? `,${rnt(idnt + 1)}description:"${this.element.description}"` : ''}})`, idnt);
+                ${rnt(idnt + 1)}agg: "${this.element.aggregation}"${this.element.getFormat()
+            ? `,${rnt(idnt + 1)}format:"${this.element.getFormat()}"`
+            : ''}${this.element.description
+            ? `,${rnt(idnt + 1)}description:"${this.element.description}"`
+            : ''}})`, idnt);
     }
 }
 // class SCalculatedMeasure extends SMeasure{
@@ -48,7 +52,9 @@ export class MeasureTemplateWriter extends MeasureWriter {
         writeIndented(stream, `<MeasureTemplate>createMeasure({\
                 ${rnt(ident + 1)}name: "${this.name}", \
                 ${rnt(ident + 1)}expression: "${this.element.attribute.expression}", \
-                ${rnt(ident + 1)}agg: "*"${this.element.getFormat() ? `,${rnt(ident + 1)}format:"${this.element.getFormat()}"` : ''}${this.element.description
+                ${rnt(ident + 1)}agg: "*"${this.element.getFormat()
+            ? `,${rnt(ident + 1)}format:"${this.element.getFormat()}"`
+            : ''}${this.element.description
             ? `,${rnt(ident + 1)}description:"${this.element.description}"`
             : ''}})`, ident);
     }

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.4.1",
+  "version": "1.5.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",
@@ -20,7 +20,8 @@
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@sisense/sdk-data": "^1.4.1",
+    "@sisense/sdk-data": "^1.5.0",
+    "prettier": "^3.2.5",
     "typescript": "4.8.4"
   },
   "scripts": {
@@ -42,8 +43,7 @@
   ],
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
-    "eslint": "^8.40.0",
-    "prettier": "2.8.4"
+    "eslint": "^8.40.0"
   },
   "volta": {
     "extends": "../../package.json"