@sisense/sdk-modeling 1.8.0 → 1.9.0

package/dist/typescript/utils/prepare-description.d.ts

@@ -0,0 +1 @@
+export declare function prepareDescription(description: string): string;

package/dist/typescript/utils/prepare-description.js

@@ -0,0 +1,3 @@
+export function prepareDescription(description) {
+    return '`' + description.replace(/\\/g, '\\\\').replace(/`/g, '\\`') + '`';
+}

package/dist/typescript/writers/dimensions.js

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-use-before-define */
-/* eslint-disable max-lines */
 import { MetadataTypes, DateLevels, normalizeName, } from '@sisense/sdk-data';
 import { ElementWriter, NEWLINE, rnt, writeIndented } from './base.js';
+import { prepareDescription } from '../utils/prepare-description.js';
 export class DimensionWriter extends ElementWriter {
     constructor(dimension, isNested) {
         super(dimension, normalizeName(dimension.name));
@@ -96,6 +96,9 @@ export class DateDimensionWriter extends ElementWriter {
         writeIndented(stream, `createDateDimension({${NEWLINE}`, 0);
         writeIndented(stream, `name: '${this.element.name}',${NEWLINE}`, ident + 1);
         writeIndented(stream, `expression: '${this.element.expression}',`, ident + 1);
+        if (this.element.description) {
+            writeIndented(stream, `description: ${prepareDescription(this.element.description)},`, ident + 1);
+        }
         stream.write(NEWLINE);
         writeIndented(stream, `}),`, ident);
         if (!this.isNested) {
@@ -121,6 +124,7 @@ export class AttributeWriter extends ElementWriter {
 ${rnt(ident + 2)}name: '${this.element.name}',\
 ${rnt(ident + 2)}type: '${this.element.type}',\
 ${rnt(ident + 2)}expression: '${this.element.expression}',\
+${this.element.description ? `${rnt(ident + 2)}description: ${prepareDescription(this.element.description)},` : ''}\
 ${rnt(ident + 1)}}),`, ident);
     }
 }

package/dist/typescript/writers/measures.js

@@ -4,6 +4,7 @@
 /* eslint-disable sonarjs/no-nested-template-literals */
 import { normalizeName } from '@sisense/sdk-data';
 import { NEWLINE, rnt, writeIndented, ElementWriter } from './base.js';
+import { prepareDescription } from '../utils/prepare-description.js';
 export class MeasureWriter extends ElementWriter {
     constructor(measure, isNested) {
         super(measure, normalizeName(measure.name));
@@ -30,7 +31,7 @@ export class BaseMeasureWriter extends MeasureWriter {
                 ${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}"`
+            ? `,${rnt(idnt + 1)}description: ${prepareDescription(this.element.description)}`
             : ''}})`, idnt);
     }
 }
@@ -55,7 +56,7 @@ export class MeasureTemplateWriter extends MeasureWriter {
                 ${rnt(ident + 1)}agg: "*"${this.element.getFormat()
             ? `,${rnt(ident + 1)}format:"${this.element.getFormat()}"`
             : ''}${this.element.description
-            ? `,${rnt(ident + 1)}description:"${this.element.description}"`
+            ? `,${rnt(ident + 1)}description: ${prepareDescription(this.element.description)}`
             : ''}})`, ident);
     }
 }

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.8.0",
+  "version": "1.9.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",
@@ -20,7 +20,7 @@
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@sisense/sdk-data": "^1.8.0",
+    "@sisense/sdk-data": "^1.9.0",
     "prettier": "^3.2.5",
     "typescript": "4.8.4"
   },