@gooddata/sdk-model 11.36.0-alpha.2 → 11.36.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/index.d.ts +1 -1
- package/esm/index.js +1 -1
- package/esm/insight/index.d.ts +8 -0
- package/esm/insight/index.js +11 -0
- package/esm/pluggableApplication/index.d.ts +8 -0
- package/esm/sdk-model.d.ts +17 -0
- package/package.json +3 -3
package/esm/index.d.ts
CHANGED
|
@@ -35,7 +35,7 @@ export { type IExecutionDefinition, type IExecutionConfig, type IMeasureDefiniti
|
|
|
35
35
|
export { type IInsightParameterValue } from "./execution/parameter/index.js";
|
|
36
36
|
export { newDefForItems, newDefForBuckets, newDefForInsight, defWithDimensions, defWithSorting, defWithPostProcessing, defWithBuckets, defWithDateFormat, defWithExecConfig, defaultDimensionsGenerator, emptyDef, } from "./execution/executionDefinition/factory.js";
|
|
37
37
|
export { type GuidType, type RgbType, type IRgbColorValue, type IColor, type IColorPalette, type IColorPaletteItem, type IColorFromPalette, type IRgbColor, type IColorPaletteMetadataObject, type IColorPaletteDefinition, isColorFromPalette, isRgbColor, isColorPaletteItem, colorPaletteItemToRgb, colorPaletteToColors, } from "./colors/index.js";
|
|
38
|
-
export { type IInsight, type IInsightDefinition, type IVisualizationClass, type IVisualizationClassBody, type VisualizationProperties, type IAttributeFilterConfigs, type IAttributeFilterConfig, type IColorMappingItem, type GeoLayerType, type GeoVisualizationType, type InsightDisplayFormUsage, type IInsightLayerDefinition, geoLayerTypeFromVisualizationType, GeoLayerTypes, GeoVisualizationTypes, isGeoLayerType, isInsight, isColorMappingItem, insightRef, insightId, insightItems, insightMeasures, insightHasMeasures, insightAttributes, insightHasAttributes, insightHasDataDefined, insightProperties, insightBuckets, insightSorts, insightBucket, insightTags, insightSummary, insightTitle, insightUri, insightIsLocked, insightCreated, insightCreatedBy, insightUpdated, insightUpdatedBy, insightTotals, insightFilters, insightAttributeFilterConfigs, insightVisualizationUrl, insightVisualizationType, insightSetFilters, insightSetBuckets, insightSetProperties, insightSetSorts, insightParameters, insightSetParameters, insightModifyItems, insightReduceItems, insightDisplayFormUsage, insightLayers, insightSetLayers, visClassUrl, visClassId, visClassUri, isInsightLayerDefinition, } from "./insight/index.js";
|
|
38
|
+
export { type IInsight, type IInsightDefinition, type IVisualizationClass, type IVisualizationClassBody, type VisualizationProperties, type IAttributeFilterConfigs, type IAttributeFilterConfig, type IColorMappingItem, type GeoLayerType, type GeoVisualizationType, type InsightDisplayFormUsage, type IInsightLayerDefinition, geoLayerTypeFromVisualizationType, GeoLayerTypes, GeoVisualizationTypes, isGeoLayerType, isInsight, isColorMappingItem, insightRef, insightId, insightItems, insightMeasures, insightHasMeasures, insightAttributes, insightHasAttributes, insightHasDataDefined, insightProperties, insightBuckets, insightSorts, insightBucket, insightTags, insightSummary, insightTitle, insightUri, insightIsLocked, insightIsHidden, insightCreated, insightCreatedBy, insightUpdated, insightUpdatedBy, insightTotals, insightFilters, insightAttributeFilterConfigs, insightVisualizationUrl, insightVisualizationType, insightSetFilters, insightSetBuckets, insightSetProperties, insightSetSorts, insightParameters, insightSetParameters, insightModifyItems, insightReduceItems, insightDisplayFormUsage, insightLayers, insightSetLayers, visClassUrl, visClassId, visClassUri, isInsightLayerDefinition, } from "./insight/index.js";
|
|
39
39
|
export { insightCreatedComparator, insightCreatedByComparator, insightTitleComparator, insightUpdatedComparator, insightUpdatedByComparator, } from "./insight/comparators.js";
|
|
40
40
|
export { type InsightModifications, newInsightDefinition, InsightDefinitionBuilder, } from "./insight/factory.js";
|
|
41
41
|
export { insightSanitize, sanitizeBucketTotals } from "./insight/sanitization.js";
|
package/esm/index.js
CHANGED
|
@@ -34,7 +34,7 @@ export { bucketItemLocalId } from "./execution/buckets/bucketItem.js";
|
|
|
34
34
|
export { defWithFilters, defFingerprint, defSetDimensions, defSetSorts, defSetBuckets, defTotals, defSetExecConfig, defSetPostProcessing, } from "./execution/executionDefinition/index.js";
|
|
35
35
|
export { newDefForItems, newDefForBuckets, newDefForInsight, defWithDimensions, defWithSorting, defWithPostProcessing, defWithBuckets, defWithDateFormat, defWithExecConfig, defaultDimensionsGenerator, emptyDef, } from "./execution/executionDefinition/factory.js";
|
|
36
36
|
export { isColorFromPalette, isRgbColor, isColorPaletteItem, colorPaletteItemToRgb, colorPaletteToColors, } from "./colors/index.js";
|
|
37
|
-
export { geoLayerTypeFromVisualizationType, GeoLayerTypes, GeoVisualizationTypes, isGeoLayerType, isInsight, isColorMappingItem, insightRef, insightId, insightItems, insightMeasures, insightHasMeasures, insightAttributes, insightHasAttributes, insightHasDataDefined, insightProperties, insightBuckets, insightSorts, insightBucket, insightTags, insightSummary, insightTitle, insightUri, insightIsLocked, insightCreated, insightCreatedBy, insightUpdated, insightUpdatedBy, insightTotals, insightFilters, insightAttributeFilterConfigs, insightVisualizationUrl, insightVisualizationType, insightSetFilters, insightSetBuckets, insightSetProperties, insightSetSorts, insightParameters, insightSetParameters, insightModifyItems, insightReduceItems, insightDisplayFormUsage, insightLayers, insightSetLayers, visClassUrl, visClassId, visClassUri, isInsightLayerDefinition, } from "./insight/index.js";
|
|
37
|
+
export { geoLayerTypeFromVisualizationType, GeoLayerTypes, GeoVisualizationTypes, isGeoLayerType, isInsight, isColorMappingItem, insightRef, insightId, insightItems, insightMeasures, insightHasMeasures, insightAttributes, insightHasAttributes, insightHasDataDefined, insightProperties, insightBuckets, insightSorts, insightBucket, insightTags, insightSummary, insightTitle, insightUri, insightIsLocked, insightIsHidden, insightCreated, insightCreatedBy, insightUpdated, insightUpdatedBy, insightTotals, insightFilters, insightAttributeFilterConfigs, insightVisualizationUrl, insightVisualizationType, insightSetFilters, insightSetBuckets, insightSetProperties, insightSetSorts, insightParameters, insightSetParameters, insightModifyItems, insightReduceItems, insightDisplayFormUsage, insightLayers, insightSetLayers, visClassUrl, visClassId, visClassUri, isInsightLayerDefinition, } from "./insight/index.js";
|
|
38
38
|
export { insightCreatedComparator, insightCreatedByComparator, insightTitleComparator, insightUpdatedComparator, insightUpdatedByComparator, } from "./insight/comparators.js";
|
|
39
39
|
export { newInsightDefinition, InsightDefinitionBuilder, } from "./insight/factory.js";
|
|
40
40
|
export { insightSanitize, sanitizeBucketTotals } from "./insight/sanitization.js";
|
package/esm/insight/index.d.ts
CHANGED
|
@@ -583,6 +583,14 @@ export declare function insightUpdatedBy(insight: IInsight): IUser | undefined;
|
|
|
583
583
|
* @public
|
|
584
584
|
*/
|
|
585
585
|
export declare function insightIsLocked(insight: IInsight): boolean;
|
|
586
|
+
/**
|
|
587
|
+
* Checks if insight is hidden
|
|
588
|
+
*
|
|
589
|
+
* @param insight - insight
|
|
590
|
+
* @returns boolean
|
|
591
|
+
* @alpha
|
|
592
|
+
*/
|
|
593
|
+
export declare function insightIsHidden(insight: IInsight): boolean;
|
|
586
594
|
/**
|
|
587
595
|
* Gets a new insight that 'inherits' all data from the provided insight but has different properties.
|
|
588
596
|
*
|
package/esm/insight/index.js
CHANGED
|
@@ -407,6 +407,17 @@ export function insightIsLocked(insight) {
|
|
|
407
407
|
invariant(insight, "insight must be specified");
|
|
408
408
|
return insight.insight.isLocked || false;
|
|
409
409
|
}
|
|
410
|
+
/**
|
|
411
|
+
* Checks if insight is hidden
|
|
412
|
+
*
|
|
413
|
+
* @param insight - insight
|
|
414
|
+
* @returns boolean
|
|
415
|
+
* @alpha
|
|
416
|
+
*/
|
|
417
|
+
export function insightIsHidden(insight) {
|
|
418
|
+
invariant(insight, "insight must be specified");
|
|
419
|
+
return insight.insight.isHidden || false;
|
|
420
|
+
}
|
|
410
421
|
/**
|
|
411
422
|
* Gets a new insight that 'inherits' all data from the provided insight but has different properties.
|
|
412
423
|
*
|
|
@@ -401,8 +401,16 @@ export interface IExternalUrlPluggableApplicationModule {
|
|
|
401
401
|
/**
|
|
402
402
|
* URL of the external application.
|
|
403
403
|
*
|
|
404
|
+
* May contain the placeholder `{workspaceId}` which the host substitutes with the
|
|
405
|
+
* id of the currently active workspace at navigation time. The placeholder is the
|
|
406
|
+
* only supported variable; other tokens are left untouched. If no workspace is
|
|
407
|
+
* active when the URL is composed, the placeholder is substituted with an empty
|
|
408
|
+
* string.
|
|
409
|
+
*
|
|
404
410
|
* @example
|
|
405
411
|
* https://google.com
|
|
412
|
+
* @example
|
|
413
|
+
* /dashboards/#/project/\{workspaceId\}
|
|
406
414
|
*/
|
|
407
415
|
url: string;
|
|
408
416
|
}
|
package/esm/sdk-model.d.ts
CHANGED
|
@@ -6301,8 +6301,16 @@ export declare interface IExternalUrlPluggableApplicationModule {
|
|
|
6301
6301
|
/**
|
|
6302
6302
|
* URL of the external application.
|
|
6303
6303
|
*
|
|
6304
|
+
* May contain the placeholder `{workspaceId}` which the host substitutes with the
|
|
6305
|
+
* id of the currently active workspace at navigation time. The placeholder is the
|
|
6306
|
+
* only supported variable; other tokens are left untouched. If no workspace is
|
|
6307
|
+
* active when the URL is composed, the placeholder is substituted with an empty
|
|
6308
|
+
* string.
|
|
6309
|
+
*
|
|
6304
6310
|
* @example
|
|
6305
6311
|
* https://google.com
|
|
6312
|
+
* @example
|
|
6313
|
+
* /dashboards/#/project/\{workspaceId\}
|
|
6306
6314
|
*/
|
|
6307
6315
|
url: string;
|
|
6308
6316
|
}
|
|
@@ -9451,6 +9459,15 @@ export declare function insightHasMeasures(insight: IInsightDefinition): boolean
|
|
|
9451
9459
|
*/
|
|
9452
9460
|
export declare function insightId(insight: IInsight): string;
|
|
9453
9461
|
|
|
9462
|
+
/**
|
|
9463
|
+
* Checks if insight is hidden
|
|
9464
|
+
*
|
|
9465
|
+
* @param insight - insight
|
|
9466
|
+
* @returns boolean
|
|
9467
|
+
* @alpha
|
|
9468
|
+
*/
|
|
9469
|
+
export declare function insightIsHidden(insight: IInsight): boolean;
|
|
9470
|
+
|
|
9454
9471
|
/**
|
|
9455
9472
|
* Checks if insight is locked
|
|
9456
9473
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-model",
|
|
3
|
-
"version": "11.36.0-alpha.
|
|
3
|
+
"version": "11.36.0-alpha.3",
|
|
4
4
|
"description": "GoodData Model definitions used by UI components and Backend SPI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "GoodData",
|
|
@@ -57,8 +57,8 @@
|
|
|
57
57
|
"oxlint-tsgolint": "0.11.4",
|
|
58
58
|
"typescript": "5.9.3",
|
|
59
59
|
"vitest": "4.1.0",
|
|
60
|
-
"@gooddata/
|
|
61
|
-
"@gooddata/
|
|
60
|
+
"@gooddata/oxlint-config": "11.36.0-alpha.3",
|
|
61
|
+
"@gooddata/eslint-config": "11.36.0-alpha.3"
|
|
62
62
|
},
|
|
63
63
|
"scripts": {
|
|
64
64
|
"_phase:build": "npm run build",
|