@gooddata/sdk-ui-catalog 11.68.0-alpha.8 → 11.68.0
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/NOTICE +47 -378
- package/esm/catalogDetail/CatalogDetailContent.d.ts.map +1 -1
- package/esm/catalogDetail/CatalogDetailContent.js +2 -3
- package/esm/catalogDetail/hooks/useCatalogItemLoad.d.ts.map +1 -1
- package/esm/catalogDetail/hooks/useCatalogItemLoad.js +6 -2
- package/esm/catalogItem/catalogBackend.test.utils.d.ts.map +1 -1
- package/esm/catalogItem/catalogBackend.test.utils.js +2 -0
- package/esm/catalogItem/converter.d.ts +4 -3
- package/esm/catalogItem/converter.d.ts.map +1 -1
- package/esm/catalogItem/converter.js +24 -1
- package/esm/catalogItem/guards.d.ts +5 -1
- package/esm/catalogItem/guards.d.ts.map +1 -1
- package/esm/catalogItem/guards.js +6 -0
- package/esm/catalogItem/permission.d.ts.map +1 -1
- package/esm/catalogItem/permission.js +5 -1
- package/esm/catalogItem/query.d.ts +10 -1
- package/esm/catalogItem/query.d.ts.map +1 -1
- package/esm/catalogItem/query.js +60 -0
- package/esm/catalogItem/types.d.ts +13 -1
- package/esm/catalogItem/types.d.ts.map +1 -1
- package/esm/catalogItem/useCatalogEndpoints.d.ts +12 -5
- package/esm/catalogItem/useCatalogEndpoints.d.ts.map +1 -1
- package/esm/catalogItem/useCatalogEndpoints.js +37 -20
- package/esm/catalogItem/useCatalogItemFeed.d.ts +1 -0
- package/esm/catalogItem/useCatalogItemFeed.d.ts.map +1 -1
- package/esm/catalogItem/useCatalogItemFeed.js +4 -1
- package/esm/catalogItem/useCatalogItemSemanticSearch.d.ts.map +1 -1
- package/esm/catalogItem/useCatalogItemSemanticSearch.js +18 -6
- package/esm/document/gate.d.ts +6 -0
- package/esm/document/gate.d.ts.map +1 -0
- package/esm/document/gate.js +13 -0
- package/esm/document/scope.d.ts +18 -0
- package/esm/document/scope.d.ts.map +1 -0
- package/esm/document/scope.js +36 -0
- package/esm/header/CreateObjectButton.d.ts.map +1 -1
- package/esm/header/CreateObjectButton.js +5 -1
- package/esm/index.d.ts +2 -2
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -1
- package/esm/localization/bundles/de-DE.localization-bundle.js +2 -2
- package/esm/localization/bundles/en-US.localization-bundle.d.ts +8 -0
- package/esm/localization/bundles/en-US.localization-bundle.d.ts.map +1 -1
- package/esm/localization/bundles/en-US.localization-bundle.js +8 -0
- package/esm/localization/translations.d.ts.map +1 -1
- package/esm/localization/translations.js +3 -4
- package/esm/objectType/ObjectTypeIcon.d.ts.map +1 -1
- package/esm/objectType/ObjectTypeIcon.js +1 -1
- package/esm/objectType/ObjectTypeSelect.d.ts.map +1 -1
- package/esm/objectType/ObjectTypeSelect.js +2 -0
- package/esm/objectType/constants.d.ts +7 -3
- package/esm/objectType/constants.d.ts.map +1 -1
- package/esm/objectType/constants.js +3 -1
- package/esm/objectType/labels.d.ts.map +1 -1
- package/esm/objectType/labels.js +1 -0
- package/esm/objectType/types.d.ts +2 -2
- package/esm/objectType/types.d.ts.map +1 -1
- package/esm/parameter/parameterCompletions.d.ts.map +1 -1
- package/esm/parameter/parameterCompletions.js +14 -2
- package/esm/quality/gate.d.ts +9 -0
- package/esm/quality/gate.d.ts.map +1 -1
- package/esm/quality/gate.js +18 -0
- package/esm/sdk-ui-catalog.d.ts +16 -3
- package/esm/tabs/useTrendingItems.js +1 -1
- package/package.json +15 -15
- package/styles/css/detail.css +3 -0
- package/styles/css/detail.css.map +1 -1
- package/styles/css/main.css +4 -1
- package/styles/css/main.css.map +1 -1
- package/styles/css/objectType.css +3 -0
- package/styles/css/objectType.css.map +1 -1
- package/styles/scss/main.scss +1 -1
- package/styles/scss/objectType.scss +4 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"catalogBackend.test.utils.d.ts","sourceRoot":"","sources":["../../src/catalogItem/catalogBackend.test.utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,IAAI,EAAM,MAAM,QAAQ,CAAC;AAEvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAIpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;;;;;;GASG;AAEH,8FAA8F;AAC9F,MAAM,WAAW,SAAS;IACtB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;CACd;AAED,UAAU,aAAa;IACnB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,kGAAkG;AAClG,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,SAAS,CAgB5D;AAED,uFAAuF;AACvF,wBAAgB,SAAS,IAAI,SAAS,CAErC;
|
|
1
|
+
{"version":3,"file":"catalogBackend.test.utils.d.ts","sourceRoot":"","sources":["../../src/catalogItem/catalogBackend.test.utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,IAAI,EAAM,MAAM,QAAQ,CAAC;AAEvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAIpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;;;;;;GASG;AAEH,8FAA8F;AAC9F,MAAM,WAAW,SAAS;IACtB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;CACd;AAED,UAAU,aAAa;IACnB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,kGAAkG;AAClG,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,SAAS,CAgB5D;AAED,uFAAuF;AACvF,wBAAgB,SAAS,IAAI,SAAS,CAErC;AA8CD,6FAA6F;AAC7F,wBAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAEnE;AAED,6FAA6F;AAC7F,QAAA,MAAM,uBAAuB,YACzB,UAAU,EACV,UAAU,EACV,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,YAAY,CACN,CAAC;AAEX,2FAA2F;AAC3F,QAAA,MAAM,wBAAwB,YAC1B,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,8BAA8B,EAC9B,iBAAiB,EACjB,iBAAiB,CACX,CAAC;AAEX,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG;IAAE,KAAK,EAAE,IAAI,CAAA;CAAE,CAAC;AAE/F,KAAK,kBAAkB,GAAG,gBAAgB,CAAC,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AACrF,KAAK,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AA2BvF,gEAAgE;AAChE,UAAU,2BAA2B;IACjC,OAAO,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/B,aAAa,EAAE,OAAO,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,kBAAkB,CAAC;IAC5B,wFAAwF;IACxF,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAClC,2FAA2F;IAC3F,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACjD,sFAAsF;IACtF,mBAAmB,EAAE,IAAI,CAAC;IAC1B,qBAAqB,EAAE,mBAAmB,CAAC;IAC3C,4FAA4F;IAC5F,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IACnE,oFAAoF;IACpF,yBAAyB,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,2BAA2B,CAAC,GAAG,IAAI,CAAC;CACvF;AAED,wBAAgB,wBAAwB,IAAI,mBAAmB,CA4C9D"}
|
|
@@ -59,6 +59,7 @@ const ENTITY_FACTORIES = {
|
|
|
59
59
|
[ObjectTypes.ATTRIBUTE]: (id) => metadataEntity(id, "attribute"),
|
|
60
60
|
[ObjectTypes.FACT]: (id) => metadataEntity(id, "fact"),
|
|
61
61
|
[ObjectTypes.DATASET]: (id) => metadataEntity(id, "dataSet"),
|
|
62
|
+
[ObjectTypes.DOCUMENT]: (id) => ({ ref: idRef(id, "document"), title: id, version: "2" }),
|
|
62
63
|
};
|
|
63
64
|
function metadataEntity(id, type) {
|
|
64
65
|
// `isMetadataObject` requires both `type` and `ref`.
|
|
@@ -106,6 +107,7 @@ const QUERY_SERVICES = {
|
|
|
106
107
|
[ObjectTypes.ATTRIBUTE]: ["attributes", "getAttributesQuery"],
|
|
107
108
|
[ObjectTypes.FACT]: ["facts", "getFactsQuery"],
|
|
108
109
|
[ObjectTypes.DATASET]: ["datasets", "getDatasetsQuery"],
|
|
110
|
+
[ObjectTypes.DOCUMENT]: ["publisherV2", "getDocumentsQuery"],
|
|
109
111
|
};
|
|
110
112
|
export function createCatalogBackendStub() {
|
|
111
113
|
const pageSources = {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import type { IAnalyticsCatalogTrendingObject } from "@gooddata/sdk-backend-spi";
|
|
1
|
+
import type { IAnalyticsCatalogTrendingObject, IPublisherDocumentSummaryV2 } from "@gooddata/sdk-backend-spi";
|
|
2
2
|
import { type IAttributeMetadataObject, type IComputedAttributeMetadataObject, type IDashboard, type IDataSetMetadataObject, type IFactMetadataObject, type IInsight, type IListedDashboard, type IMeasureMetadataObject, type IParameterMetadataObject, type IUser } from "@gooddata/sdk-model";
|
|
3
|
-
import type { ICatalogItem, ICatalogItemAttribute, ICatalogItemComputedAttribute, ICatalogItemDashboard, ICatalogItemDataSet, ICatalogItemFact, ICatalogItemInsight, ICatalogItemMeasure, ICatalogItemParameter } from "./types.js";
|
|
4
|
-
export declare function convertEntityToCatalogItem(entity: IInsight | IListedDashboard | IMeasureMetadataObject | IParameterMetadataObject | IComputedAttributeMetadataObject | IFactMetadataObject | IAttributeMetadataObject | IDataSetMetadataObject | undefined): ICatalogItem;
|
|
3
|
+
import type { ICatalogItem, ICatalogItemAttribute, ICatalogItemComputedAttribute, ICatalogItemDashboard, ICatalogItemDataSet, ICatalogItemDocument, ICatalogItemFact, ICatalogItemInsight, ICatalogItemMeasure, ICatalogItemParameter } from "./types.js";
|
|
4
|
+
export declare function convertEntityToCatalogItem(entity: IInsight | IListedDashboard | IMeasureMetadataObject | IParameterMetadataObject | IComputedAttributeMetadataObject | IFactMetadataObject | IAttributeMetadataObject | IDataSetMetadataObject | IPublisherDocumentSummaryV2 | undefined): ICatalogItem;
|
|
5
5
|
export declare function convertDashboardToCatalogItem(dashboard: IDashboard | IListedDashboard): ICatalogItemDashboard;
|
|
6
6
|
export declare function convertInsightToCatalogItem({ insight }: IInsight): ICatalogItemInsight;
|
|
7
7
|
export declare function convertMeasureToCatalogItem(measure: IMeasureMetadataObject): ICatalogItemMeasure;
|
|
@@ -10,6 +10,7 @@ export declare function convertParameterToCatalogItem(parameter: IParameterMetad
|
|
|
10
10
|
export declare function convertComputedAttributeToCatalogItem(computedAttribute: IComputedAttributeMetadataObject): ICatalogItemComputedAttribute;
|
|
11
11
|
export declare function convertAttributeToCatalogItem(attribute: IAttributeMetadataObject): ICatalogItemAttribute;
|
|
12
12
|
export declare function convertDataSetToCatalogItem(dataSet: IDataSetMetadataObject): ICatalogItemDataSet;
|
|
13
|
+
export declare function convertDocumentToCatalogItem(document: IPublisherDocumentSummaryV2): ICatalogItemDocument;
|
|
13
14
|
export declare function getDisplayName(user?: IUser | null): string;
|
|
14
15
|
export declare function convertTrendingObjectToCatalogItem(obj: IAnalyticsCatalogTrendingObject): ICatalogItem;
|
|
15
16
|
//# sourceMappingURL=converter.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"converter.d.ts","sourceRoot":"","sources":["../../src/catalogItem/converter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,2BAA2B,CAAC;
|
|
1
|
+
{"version":3,"file":"converter.d.ts","sourceRoot":"","sources":["../../src/catalogItem/converter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,+BAA+B,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AAC9G,OAAO,EAEH,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,UAAU,EACf,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAE3B,KAAK,wBAAwB,EAC7B,KAAK,KAAK,EAWb,MAAM,qBAAqB,CAAC;AAK7B,OAAO,KAAK,EACR,YAAY,EACZ,qBAAqB,EACrB,6BAA6B,EAC7B,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EAExB,MAAM,YAAY,CAAC;AAEpB,wBAAgB,0BAA0B,CACtC,MAAM,EACA,QAAQ,GACR,gBAAgB,GAChB,sBAAsB,GACtB,wBAAwB,GACxB,gCAAgC,GAChC,mBAAmB,GACnB,wBAAwB,GACxB,sBAAsB,GACtB,2BAA2B,GAC3B,SAAS,GAChB,YAAY,CA6Bd;AAED,wBAAgB,6BAA6B,CACzC,SAAS,EAAE,UAAU,GAAG,gBAAgB,GACzC,qBAAqB,CAiBvB;AAED,wBAAgB,2BAA2B,CAAC,EAAE,OAAO,EAAE,EAAE,QAAQ,GAAG,mBAAmB,CAmBtF;AAED,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,sBAAsB,GAAG,mBAAmB,CAwBhG;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,mBAAmB,GAAG,gBAAgB,CAgBpF;AAED,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,wBAAwB,GAAG,qBAAqB,CAiBxG;AAED,wBAAgB,qCAAqC,CACjD,iBAAiB,EAAE,gCAAgC,GACpD,6BAA6B,CAiB/B;AAED,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,wBAAwB,GAAG,qBAAqB,CAgBxG;AAED,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,sBAAsB,GAAG,mBAAmB,CAehG;AAED,wBAAgB,4BAA4B,CAAC,QAAQ,EAAE,2BAA2B,GAAG,oBAAoB,CAgBxG;AAOD,wBAAgB,cAAc,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,GAAG,MAAM,CAW1D;AAcD,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,+BAA+B,GAAG,YAAY,CAuBrG"}
|
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
// (C) 2025-2026 GoodData Corporation
|
|
2
|
-
import { isAttributeMetadataObject, isComputedAttributeMetadataObject, isDashboard, isDataSetMetadataObject, isFactMetadataObject, isInsight, isListedDashboard, isMeasureMetadataObject, isParameterMetadataObject, } from "@gooddata/sdk-model";
|
|
2
|
+
import { isAttributeMetadataObject, isComputedAttributeMetadataObject, isDashboard, isDataSetMetadataObject, isFactMetadataObject, isIdentifierRef, isInsight, isListedDashboard, isMeasureMetadataObject, isParameterMetadataObject, } from "@gooddata/sdk-model";
|
|
3
3
|
import { mapObjectType } from "../objectType/mapping.js";
|
|
4
4
|
import { parseBackendDate } from "../utils/date.js";
|
|
5
5
|
export function convertEntityToCatalogItem(entity) {
|
|
6
|
+
if (isDocumentSummary(entity)) {
|
|
7
|
+
return convertDocumentToCatalogItem(entity);
|
|
8
|
+
}
|
|
6
9
|
if (isInsight(entity)) {
|
|
7
10
|
return convertInsightToCatalogItem(entity);
|
|
8
11
|
}
|
|
@@ -174,6 +177,26 @@ export function convertDataSetToCatalogItem(dataSet) {
|
|
|
174
177
|
dataSet: dataSet,
|
|
175
178
|
};
|
|
176
179
|
}
|
|
180
|
+
export function convertDocumentToCatalogItem(document) {
|
|
181
|
+
const updatedAt = document.updated || document.created;
|
|
182
|
+
return {
|
|
183
|
+
identifier: isIdentifierRef(document.ref) ? document.ref.identifier : document.ref.uri,
|
|
184
|
+
type: "document",
|
|
185
|
+
title: document.title,
|
|
186
|
+
description: document.description ?? "",
|
|
187
|
+
tags: document.tags ?? [],
|
|
188
|
+
createdBy: getDisplayName(document.createdBy),
|
|
189
|
+
createdAt: document.created ? parseBackendDate(document.created) : null,
|
|
190
|
+
updatedBy: getDisplayName(document.updatedBy),
|
|
191
|
+
updatedAt: updatedAt ? parseBackendDate(updatedAt) : null,
|
|
192
|
+
isLocked: document.isLocked ?? false,
|
|
193
|
+
isEditable: false,
|
|
194
|
+
};
|
|
195
|
+
}
|
|
196
|
+
function isDocumentSummary(entity) {
|
|
197
|
+
const ref = entity?.ref;
|
|
198
|
+
return isIdentifierRef(ref) && ref.type === "document";
|
|
199
|
+
}
|
|
177
200
|
export function getDisplayName(user) {
|
|
178
201
|
if (user?.fullName) {
|
|
179
202
|
return user.fullName;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ICatalogItem, ICatalogItemAttribute, ICatalogItemComputedAttribute, ICatalogItemDashboard, ICatalogItemDataSet, ICatalogItemFact, ICatalogItemHidable, ICatalogItemInsight, ICatalogItemMeasure, ICatalogItemParameter, ICatalogItemRef, ICatalogItemTextGenerable, ICatalogItemWithPermissions, VisualizationType } from "./types.js";
|
|
1
|
+
import type { ICatalogItem, ICatalogItemAttribute, ICatalogItemComputedAttribute, ICatalogItemDashboard, ICatalogItemDataSet, ICatalogItemDocument, ICatalogItemFact, ICatalogItemHidable, ICatalogItemInsight, ICatalogItemMeasure, ICatalogItemParameter, ICatalogItemRef, ICatalogItemTextGenerable, ICatalogItemWithPermissions, VisualizationType } from "./types.js";
|
|
2
2
|
/**
|
|
3
3
|
* @internal
|
|
4
4
|
*/
|
|
@@ -31,6 +31,10 @@ export declare function isCatalogItemFact(item: ICatalogItem | undefined | null)
|
|
|
31
31
|
* @internal
|
|
32
32
|
*/
|
|
33
33
|
export declare function isCatalogItemDataSet(item: ICatalogItem | undefined | null): item is ICatalogItemDataSet;
|
|
34
|
+
/**
|
|
35
|
+
* @internal
|
|
36
|
+
*/
|
|
37
|
+
export declare function isCatalogItemDocument(item: ICatalogItem | undefined | null): item is ICatalogItemDocument;
|
|
34
38
|
/**
|
|
35
39
|
* Returns whether a catalog item supports the `isHidden` flag.
|
|
36
40
|
* @internal
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../src/catalogItem/guards.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,YAAY,EACZ,qBAAqB,EACrB,6BAA6B,EAC7B,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,iBAAiB,EACpB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,qBAAqB,CAE3G;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,mBAAmB,CAEvG;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,mBAAmB,CAEvG;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,qBAAqB,CAE3G;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC1C,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GACtC,IAAI,IAAI,6BAA6B,CAEvC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,qBAAqB,CAE3G;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,gBAAgB,CAEjG;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,mBAAmB,CAEvG;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,mBAAmB,CAOvG;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CACxC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GACtC,IAAI,IAAI,2BAA2B,CAErC;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACtC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GACtC,IAAI,IAAI,yBAAyB,CAQnC;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAC/B,IAAI,EAAE,eAAe,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GACxD,IAAI,IAAI,YAAY,CAEtB;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,iBAAiB,GAAG,SAAS,CAEzG"}
|
|
1
|
+
{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../src/catalogItem/guards.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,YAAY,EACZ,qBAAqB,EACrB,6BAA6B,EAC7B,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,iBAAiB,EACpB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,qBAAqB,CAE3G;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,mBAAmB,CAEvG;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,mBAAmB,CAEvG;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,qBAAqB,CAE3G;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC1C,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GACtC,IAAI,IAAI,6BAA6B,CAEvC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,qBAAqB,CAE3G;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,gBAAgB,CAEjG;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,mBAAmB,CAEvG;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,oBAAoB,CAEzG;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,IAAI,mBAAmB,CAOvG;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CACxC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GACtC,IAAI,IAAI,2BAA2B,CAErC;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACtC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GACtC,IAAI,IAAI,yBAAyB,CAQnC;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAC/B,IAAI,EAAE,eAAe,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GACxD,IAAI,IAAI,YAAY,CAEtB;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,iBAAiB,GAAG,SAAS,CAEzG"}
|
|
@@ -47,6 +47,12 @@ export function isCatalogItemFact(item) {
|
|
|
47
47
|
export function isCatalogItemDataSet(item) {
|
|
48
48
|
return item?.type === "dataSet";
|
|
49
49
|
}
|
|
50
|
+
/**
|
|
51
|
+
* @internal
|
|
52
|
+
*/
|
|
53
|
+
export function isCatalogItemDocument(item) {
|
|
54
|
+
return item?.type === "document";
|
|
55
|
+
}
|
|
50
56
|
/**
|
|
51
57
|
* Returns whether a catalog item supports the `isHidden` flag.
|
|
52
58
|
* @internal
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"permission.d.ts","sourceRoot":"","sources":["../../src/catalogItem/permission.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,SAAS,EACd,KAAK,qBAAqB,EAK7B,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"permission.d.ts","sourceRoot":"","sources":["../../src/catalogItem/permission.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,SAAS,EACd,KAAK,qBAAqB,EAK7B,MAAM,qBAAqB,CAAC;AAa7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,wBAAgB,kBAAkB,CAC9B,oBAAoB,CAAC,EAAE,qBAAqB,EAC5C,IAAI,CAAC,EAAE,YAAY,GAAG,IAAI,EAC1B,QAAQ,CAAC,EAAE,SAAS,WAgDvB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAC/B,oBAAoB,CAAC,EAAE,qBAAqB,EAC5C,IAAI,CAAC,EAAE,YAAY,GAAG,IAAI,EAC1B,QAAQ,CAAC,EAAE,SAAS,WAkCvB"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// (C) 2025-2026 GoodData Corporation
|
|
2
2
|
import { canEditMetric, canEditVisualization, canShareMetric, canShareVisualization, } from "@gooddata/sdk-model";
|
|
3
3
|
import { COMPUTED_ATTRIBUTE_FEATURE_FLAG } from "../computedAttribute/gate.js";
|
|
4
|
-
import { isCatalogItemAttribute, isCatalogItemComputedAttribute, isCatalogItemDashboard, isCatalogItemFact, isCatalogItemInsight, isCatalogItemMeasure, } from "./guards.js";
|
|
4
|
+
import { isCatalogItemAttribute, isCatalogItemComputedAttribute, isCatalogItemDashboard, isCatalogItemDocument, isCatalogItemFact, isCatalogItemInsight, isCatalogItemMeasure, } from "./guards.js";
|
|
5
5
|
export function canEditCatalogItem(workspacePermissions, item, settings) {
|
|
6
6
|
// If the workspace permissions or the item is not provided, the user cannot update it.
|
|
7
7
|
if (!workspacePermissions || !item) {
|
|
@@ -11,6 +11,10 @@ export function canEditCatalogItem(workspacePermissions, item, settings) {
|
|
|
11
11
|
if (item.isLocked) {
|
|
12
12
|
return false;
|
|
13
13
|
}
|
|
14
|
+
// Documents are edited in the Reports app only.
|
|
15
|
+
if (isCatalogItemDocument(item)) {
|
|
16
|
+
return false;
|
|
17
|
+
}
|
|
14
18
|
// If the user has WS.Manage project permission, they can update the item no matter what
|
|
15
19
|
// type of item it is.
|
|
16
20
|
if (workspacePermissions.canManageProject) {
|
|
@@ -1,10 +1,19 @@
|
|
|
1
|
-
import type { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
|
|
1
|
+
import type { IAnalyticalBackend, IPublisherDocumentsQueryResultV2 } from "@gooddata/sdk-backend-spi";
|
|
2
2
|
import { type IAttributeDisplayFormMetadataObject, type IMeasureMetadataObject, type IMeasureMetadataObjectDefinition, type IParameterMetadataObjectDefinition, type ObjRef } from "@gooddata/sdk-model";
|
|
3
3
|
import type { ICatalogItem, ICatalogItemMeasure, ICatalogItemQueryOptions } from "./types.js";
|
|
4
4
|
export declare function getDashboardsQuery({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, isHidden, certification, pageSize, }: ICatalogItemQueryOptions): import("@gooddata/sdk-backend-spi").IDashboardsQuery;
|
|
5
5
|
export declare function getInsightsQuery({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, isHidden, certification, pageSize, loadVisualizationPermissions, }: ICatalogItemQueryOptions): import("@gooddata/sdk-backend-spi").IInsightsQuery;
|
|
6
6
|
export declare function getMetricsQuery({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, isHidden, certification, pageSize, loadPermissions, }: ICatalogItemQueryOptions): import("@gooddata/sdk-backend-spi").IMeasuresQuery;
|
|
7
7
|
export declare function getParametersQuery({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, pageSize, }: ICatalogItemQueryOptions): import("@gooddata/sdk-backend-spi").IParametersQuery;
|
|
8
|
+
/**
|
|
9
|
+
* The documents the user sees, as Reports shows them; see `getDocumentOwner`.
|
|
10
|
+
*/
|
|
11
|
+
export declare function queryDocuments({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, isHidden, certification, pageSize, }: ICatalogItemQueryOptions, owner: string | undefined): Promise<IPublisherDocumentsQueryResultV2>;
|
|
12
|
+
/**
|
|
13
|
+
* One document the user sees, as {@link queryDocuments} lists it. Loads the user's permissions itself, so
|
|
14
|
+
* the detail can open before the catalog has them.
|
|
15
|
+
*/
|
|
16
|
+
export declare function getDocumentCatalogItem(backend: IAnalyticalBackend, workspace: string, id: string): Promise<ICatalogItem>;
|
|
8
17
|
export declare function getComputedAttributesQuery({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, certification, pageSize, }: ICatalogItemQueryOptions): import("@gooddata/sdk-backend-spi").IComputedAttributesQuery;
|
|
9
18
|
export declare function getAttributesQuery({ backend, workspace, search, origin, id, excludeId, tags, excludeTags, isHidden, pageSize, }: ICatalogItemQueryOptions): import("@gooddata/sdk-backend-spi").IAttributesQuery;
|
|
10
19
|
export declare function getFactsQuery({ backend, workspace, search, origin, id, excludeId, tags, excludeTags, isHidden, pageSize, }: ICatalogItemQueryOptions): import("@gooddata/sdk-backend-spi").IFactsQuery;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../src/catalogItem/query.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../src/catalogItem/query.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,kBAAkB,EAElB,gCAAgC,EACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACH,KAAK,mCAAmC,EACxC,KAAK,sBAAsB,EAC3B,KAAK,gCAAgC,EACrC,KAAK,kCAAkC,EACvC,KAAK,MAAM,EAEd,MAAM,qBAAqB,CAAC;AAM7B,OAAO,KAAK,EACR,YAAY,EAOZ,mBAAmB,EAEnB,wBAAwB,EAE3B,MAAM,YAAY,CAAC;AAIpB,wBAAgB,kBAAkB,CAAC,EAC/B,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,aAAa,EACb,QAAoB,GACvB,EAAE,wBAAwB,wDAuB1B;AAED,wBAAgB,gBAAgB,CAAC,EAC7B,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,aAAa,EACb,QAAoB,EACpB,4BAAoC,GACvC,EAAE,wBAAwB,sDAwB1B;AAED,wBAAgB,eAAe,CAAC,EAC5B,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,aAAa,EACb,QAAoB,EACpB,eAAuB,GAC1B,EAAE,wBAAwB,sDA0B1B;AAED,wBAAgB,kBAAkB,CAAC,EAC/B,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,IAAI,EACJ,WAAW,EACX,QAAoB,GACvB,EAAE,wBAAwB,wDAoB1B;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC1B,EACI,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,aAAa,EACb,QAAoB,GACvB,EAAE,wBAAwB,EAC3B,KAAK,EAAE,MAAM,GAAG,SAAS,GAC1B,OAAO,CAAC,gCAAgC,CAAC,CAyB3C;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,CACxC,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,MAAM,GACX,OAAO,CAAC,YAAY,CAAC,CAevB;AAgBD,wBAAgB,0BAA0B,CAAC,EACvC,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,IAAI,EACJ,WAAW,EACX,aAAa,EACb,QAAoB,GACvB,EAAE,wBAAwB,gEAqB1B;AAED,wBAAgB,kBAAkB,CAAC,EAC/B,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,QAAoB,GACvB,EAAE,wBAAwB,wDAwB1B;AAED,wBAAgB,aAAa,CAAC,EAC1B,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,QAAoB,GACvB,EAAE,wBAAwB,mDAsB1B;AAED,wBAAgB,oBAAoB,CAAC,EACjC,OAAO,EACP,SAAS,EACT,MAAM,EACN,MAAM,EACN,EAAE,EACF,SAAS,EACT,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,QAAoB,GACvB,EAAE,wBAAwB,sDAuB1B;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,ogBAqBnG;AAuCD,wBAAgB,mCAAmC,CAC/C,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,mBAAmB,mCAS5B;AAED,wBAAgB,iCAAiC,CAC7C,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,mCAAmC,gDAW7C;AAiED,wBAAsB,0BAA0B,CAC5C,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,kCAAkC,mEAGhD;AAkBD,wBAAgB,0BAA0B,CACtC,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,kCAAkC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,mEAYlE;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,iBAErG;AAkBD,wBAAgB,wBAAwB,CACpC,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gCAAgC,EACzC,eAAe,UAAQ,mCAG1B;AAED,wBAAgB,wBAAwB,CACpC,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,sBAAsB,mCAGlC;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,iBAEnG;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,mCAEhG;AAED,wBAAgB,8BAA8B,CAC1C,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY,GAAG,eAAe,CAAC,iBAmBpE"}
|
package/esm/catalogItem/query.js
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
// (C) 2025-2026 GoodData Corporation
|
|
2
2
|
import { idRef, } from "@gooddata/sdk-model";
|
|
3
|
+
import { NotFoundSdkError } from "@gooddata/sdk-ui";
|
|
4
|
+
import { getDocumentOwner, scopeDocumentFilter } from "../document/scope.js";
|
|
5
|
+
import { convertDocumentToCatalogItem } from "./converter.js";
|
|
3
6
|
const PAGE_SIZE = 50;
|
|
4
7
|
export function getDashboardsQuery({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, isHidden, certification, pageSize = PAGE_SIZE, }) {
|
|
5
8
|
return backend
|
|
@@ -96,6 +99,63 @@ export function getParametersQuery({ backend, workspace, search, origin, id, exc
|
|
|
96
99
|
})
|
|
97
100
|
.withMethod("POST");
|
|
98
101
|
}
|
|
102
|
+
/**
|
|
103
|
+
* The documents the user sees, as Reports shows them; see `getDocumentOwner`.
|
|
104
|
+
*/
|
|
105
|
+
export function queryDocuments({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, isHidden, certification, pageSize = PAGE_SIZE, }, owner) {
|
|
106
|
+
const scoped = scopeDocumentFilter({ origin, createdBy, excludeCreatedBy }, owner);
|
|
107
|
+
if (!scoped) {
|
|
108
|
+
return Promise.resolve(emptyPage(pageSize));
|
|
109
|
+
}
|
|
110
|
+
return backend
|
|
111
|
+
.workspace(workspace)
|
|
112
|
+
.publisherV2()
|
|
113
|
+
.getDocumentsQuery()
|
|
114
|
+
.withPage(0)
|
|
115
|
+
.withSize(pageSize)
|
|
116
|
+
.withSorting(["title,asc"])
|
|
117
|
+
.withOrigin(scoped.origin)
|
|
118
|
+
.withFilter({
|
|
119
|
+
search,
|
|
120
|
+
id,
|
|
121
|
+
excludeId,
|
|
122
|
+
tags,
|
|
123
|
+
excludeTags,
|
|
124
|
+
createdBy: scoped.createdBy,
|
|
125
|
+
excludeCreatedBy: scoped.excludeCreatedBy,
|
|
126
|
+
isHidden,
|
|
127
|
+
certification,
|
|
128
|
+
})
|
|
129
|
+
.query();
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* One document the user sees, as {@link queryDocuments} lists it. Loads the user's permissions itself, so
|
|
133
|
+
* the detail can open before the catalog has them.
|
|
134
|
+
*/
|
|
135
|
+
export async function getDocumentCatalogItem(backend, workspace, id) {
|
|
136
|
+
const [user, permissions] = await Promise.all([
|
|
137
|
+
backend.currentUser().getUser(),
|
|
138
|
+
backend.workspace(workspace).permissions().getPermissionsForCurrentUser(),
|
|
139
|
+
]);
|
|
140
|
+
const { items: [document], } = await queryDocuments({ backend, workspace, origin: "ALL", id: [id], pageSize: 1 }, getDocumentOwner(user, permissions));
|
|
141
|
+
if (!document) {
|
|
142
|
+
throw new NotFoundSdkError(`Document ${id} not found`);
|
|
143
|
+
}
|
|
144
|
+
return convertDocumentToCatalogItem(document);
|
|
145
|
+
}
|
|
146
|
+
function emptyPage(limit) {
|
|
147
|
+
const page = {
|
|
148
|
+
items: [],
|
|
149
|
+
limit,
|
|
150
|
+
offset: 0,
|
|
151
|
+
totalCount: 0,
|
|
152
|
+
next: () => Promise.resolve(page),
|
|
153
|
+
goTo: () => Promise.resolve(page),
|
|
154
|
+
all: () => Promise.resolve([]),
|
|
155
|
+
allSorted: () => Promise.resolve([]),
|
|
156
|
+
};
|
|
157
|
+
return page;
|
|
158
|
+
}
|
|
99
159
|
export function getComputedAttributesQuery({ backend, workspace, search, origin, id, excludeId, createdBy, excludeCreatedBy, tags, excludeTags, certification, pageSize = PAGE_SIZE, }) {
|
|
100
160
|
return backend
|
|
101
161
|
.workspace(workspace)
|
|
@@ -38,7 +38,7 @@ export interface ICatalogItemBase extends ICatalogItemRef {
|
|
|
38
38
|
* `visualizationType`, `dataSet`, `definition`, `format`, or `metricType`.
|
|
39
39
|
* @public
|
|
40
40
|
*/
|
|
41
|
-
export type ICatalogItem = ICatalogItemDashboard | ICatalogItemInsight | ICatalogItemMeasure | ICatalogItemParameter | ICatalogItemComputedAttribute | ICatalogItemAttribute | ICatalogItemFact | ICatalogItemDataSet;
|
|
41
|
+
export type ICatalogItem = ICatalogItemDashboard | ICatalogItemInsight | ICatalogItemMeasure | ICatalogItemParameter | ICatalogItemComputedAttribute | ICatalogItemAttribute | ICatalogItemFact | ICatalogItemDataSet | ICatalogItemDocument;
|
|
42
42
|
/**
|
|
43
43
|
* Catalog item for analytical dashboards.
|
|
44
44
|
* @public
|
|
@@ -127,6 +127,13 @@ export interface ICatalogItemDataSet extends ICatalogItemBase {
|
|
|
127
127
|
type: "dataSet";
|
|
128
128
|
dataSet: IDataSetMetadataObject;
|
|
129
129
|
}
|
|
130
|
+
/**
|
|
131
|
+
* Catalog item for Reports documents. Read-only in the catalog.
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export interface ICatalogItemDocument extends ICatalogItemBase {
|
|
135
|
+
type: "document";
|
|
136
|
+
}
|
|
130
137
|
/**
|
|
131
138
|
* Catalog items that support the `isHidden` flag.
|
|
132
139
|
* @internal
|
|
@@ -167,6 +174,11 @@ export interface ICatalogItemQueryOptions {
|
|
|
167
174
|
loadPermissions?: boolean;
|
|
168
175
|
/** Ask for each visualization's object-level permissions, kept on ICatalogItemInsight.permissions. */
|
|
169
176
|
loadVisualizationPermissions?: boolean;
|
|
177
|
+
/** The quality filter: objects with these issue ids, or with `isInverted` objects without them. */
|
|
178
|
+
qualityIds?: {
|
|
179
|
+
values: string[];
|
|
180
|
+
isInverted: boolean;
|
|
181
|
+
};
|
|
170
182
|
}
|
|
171
183
|
export interface ICatalogItemSemanticSearchOptions {
|
|
172
184
|
queryOptions: ICatalogItemQueryOptions;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/catalogItem/types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,6CAA6C,EAC7C,kBAAkB,EACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACR,wBAAwB,EACxB,mBAAmB,EACnB,mCAAmC,EACnC,sBAAsB,EACtB,oBAAoB,EACpB,8BAA8B,EAC9B,aAAa,EACb,UAAU,EACV,YAAY,EACf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAClD,IAAI,EAAE,UAAU,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE;QACZ,MAAM,EAAE,mBAAmB,CAAC;QAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;QAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,6BAA6B,GAC7B,qBAAqB,GACrB,gBAAgB,GAChB,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/catalogItem/types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,6CAA6C,EAC7C,kBAAkB,EACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACR,wBAAwB,EACxB,mBAAmB,EACnB,mCAAmC,EACnC,sBAAsB,EACtB,oBAAoB,EACpB,8BAA8B,EAC9B,aAAa,EACb,UAAU,EACV,YAAY,EACf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAClD,IAAI,EAAE,UAAU,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE;QACZ,MAAM,EAAE,mBAAmB,CAAC;QAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;QAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,6BAA6B,GAC7B,qBAAqB,GACrB,gBAAgB,GAChB,mBAAmB,GACnB,oBAAoB,CAAC;AAE3B;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC3D,IAAI,EAAE,qBAAqB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,SAAS,CAAC;IAChB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,yFAAyF;IACzF,WAAW,CAAC,EAAE,wBAAwB,EAAE,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACvB,SAAS,GACT,OAAO,GACP,MAAM,GACN,OAAO,GACP,UAAU,GACV,QAAQ,GACR,MAAM,GACN,SAAS,GACT,SAAS,GACT,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,KAAK,GACL,KAAK,GACL,OAAO,GACP,QAAQ,GACR,WAAW,GACX,iBAAiB,GACjB,QAAQ,GACR,SAAS,GACT,UAAU,CAAC;AAEjB;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,SAAS,CAAC;IAChB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,yFAAyF;IACzF,WAAW,CAAC,EAAE,wBAAwB,EAAE,CAAC;IACzC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,8BAA8B,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC3D,IAAI,EAAE,WAAW,CAAC;IAClB,UAAU,EAAE,oBAAoB,CAAC;CACpC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACnE,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC3D,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,CAAC,EAAE,sBAAsB,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,mCAAmC,EAAE,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,sBAAsB,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IACzD,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,sBAAsB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC1D,IAAI,EAAE,UAAU,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACrC,YAAY,EACZ;IAAE,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,MAAM,CAAA;CAAE,CACzD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAC3C,YAAY,EACZ;IAAE,IAAI,EAAE,6CAA6C,CAAA;CAAE,CAC1D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC,YAAY,EAAE;IAAE,IAAI,EAAE,SAAS,GAAG,SAAS,CAAA;CAAE,CAAC,CAAC;AAEjG,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,wBAAwB,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAC;AAExF,MAAM,WAAW,wBAAwB;IACrC,OAAO,EAAE,kBAAkB,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+FAA+F;IAC/F,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,sGAAsG;IACtG,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,mGAAmG;IACnG,UAAU,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE,CAAC;CAC1D;AAED,MAAM,WAAW,iCAAiC;IAC9C,YAAY,EAAE,wBAAwB,CAAC;IACvC,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;IACpB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import type { IAttributesQueryResult, IComputedAttributesQueryResult, IDashboardsQueryResult, IDatasetsQueryResult, IFactsQueryResult, IInsightsQueryResult, IMeasuresQueryResult, IParametersQueryResult } from "@gooddata/sdk-backend-spi";
|
|
1
|
+
import type { IAttributesQueryResult, IComputedAttributesQueryResult, IDashboardsQueryResult, IDatasetsQueryResult, IFactsQueryResult, IInsightsQueryResult, IMeasuresQueryResult, IParametersQueryResult, IPublisherDocumentsQueryResultV2 } from "@gooddata/sdk-backend-spi";
|
|
2
2
|
import type { IFeatureFlags, Identifier, ObjectOrigin } from "@gooddata/sdk-model";
|
|
3
3
|
import { type ObjectType } from "../objectType/types.js";
|
|
4
4
|
import type { ICatalogItemFeedOptions, ICatalogItemQueryOptions } from "./types.js";
|
|
5
|
-
export type EndpointResult = IMeasuresQueryResult | IDashboardsQueryResult | IFactsQueryResult | IInsightsQueryResult | IAttributesQueryResult | IDatasetsQueryResult | IParametersQueryResult | IComputedAttributesQueryResult;
|
|
5
|
+
export type EndpointResult = IMeasuresQueryResult | IDashboardsQueryResult | IFactsQueryResult | IInsightsQueryResult | IAttributesQueryResult | IDatasetsQueryResult | IParametersQueryResult | IComputedAttributesQueryResult | IPublisherDocumentsQueryResultV2;
|
|
6
6
|
export type FeedEndpoint = {
|
|
7
7
|
type: ObjectType;
|
|
8
8
|
query: () => Promise<EndpointResult>;
|
|
@@ -23,13 +23,20 @@ export interface ICatalogQueryFilterInputs {
|
|
|
23
23
|
export declare function useCatalogQueryOptions(feedOptions: ICatalogItemFeedOptions, filterInputs: ICatalogQueryFilterInputs): ICatalogItemQueryOptions;
|
|
24
24
|
export interface ICatalogEndpoint {
|
|
25
25
|
type: ObjectType;
|
|
26
|
-
query: (opts: ICatalogItemQueryOptions) => Promise<EndpointResult>;
|
|
26
|
+
query: (opts: ICatalogItemQueryOptions, context: ICatalogEndpointContext) => Promise<EndpointResult>;
|
|
27
27
|
gatedBy?: readonly (keyof IFeatureFlags)[];
|
|
28
28
|
cannotFilterBy?: readonly FilterSlot[];
|
|
29
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* What the endpoints need to know about the user.
|
|
32
|
+
*/
|
|
33
|
+
export interface ICatalogEndpointContext {
|
|
34
|
+
/** Whose documents the user sees; undefined means all. */
|
|
35
|
+
documentOwner?: string;
|
|
36
|
+
}
|
|
30
37
|
type FilterSlot = "createdBy" | "excludeCreatedBy" | "certification";
|
|
31
|
-
export declare function useCatalogEndpoints(types: ObjectType[], queryOptions: ICatalogItemQueryOptions, flags: IFeatureFlags | undefined): FeedEndpoint[];
|
|
38
|
+
export declare function useCatalogEndpoints(types: ObjectType[], queryOptions: ICatalogItemQueryOptions, flags: IFeatureFlags | undefined, documentOwner?: string): FeedEndpoint[];
|
|
32
39
|
export declare function useEnabledObjectTypes(): ObjectType[];
|
|
33
|
-
export declare function selectCatalogEndpoints(types: readonly ObjectType[], options: ICatalogItemQueryOptions, flags: IFeatureFlags | undefined, endpoints?: readonly ICatalogEndpoint[]): FeedEndpoint[];
|
|
40
|
+
export declare function selectCatalogEndpoints(types: readonly ObjectType[], options: ICatalogItemQueryOptions, flags: IFeatureFlags | undefined, endpoints?: readonly ICatalogEndpoint[], context?: ICatalogEndpointContext): FeedEndpoint[];
|
|
34
41
|
export {};
|
|
35
42
|
//# sourceMappingURL=useCatalogEndpoints.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useCatalogEndpoints.d.ts","sourceRoot":"","sources":["../../src/catalogItem/useCatalogEndpoints.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACR,sBAAsB,EACtB,8BAA8B,EAC9B,sBAAsB,EACtB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,
|
|
1
|
+
{"version":3,"file":"useCatalogEndpoints.d.ts","sourceRoot":"","sources":["../../src/catalogItem/useCatalogEndpoints.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACR,sBAAsB,EACtB,8BAA8B,EAC9B,sBAAsB,EACtB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,gCAAgC,EACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAInF,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAezD,OAAO,KAAK,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAEpF,MAAM,MAAM,cAAc,GACpB,oBAAoB,GACpB,sBAAsB,GACtB,iBAAiB,GACjB,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,sBAAsB,GACtB,8BAA8B,GAC9B,gCAAgC,CAAC;AAEvC,MAAM,MAAM,YAAY,GAAG;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;CACxC,CAAC;AAEF,UAAU,YAAY,CAAC,CAAC;IACpB,MAAM,EAAE,CAAC,CAAC;IACV,UAAU,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAClC,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7B,UAAU,EAAE,YAAY,CAAC,UAAU,EAAE,CAAC,GAAG,SAAS,CAAC;IACnD,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,aAAa,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC;AAED,wBAAgB,sBAAsB,CAClC,WAAW,EAAE,uBAAuB,EACpC,YAAY,EAAE,yBAAyB,GACxC,wBAAwB,CAwC1B;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,uBAAuB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACrG,OAAO,CAAC,EAAE,SAAS,CAAC,MAAM,aAAa,CAAC,EAAE,CAAC;IAC3C,cAAc,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,0DAA0D;IAC1D,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,KAAK,UAAU,GAAG,WAAW,GAAG,kBAAkB,GAAG,eAAe,CAAC;AAgDrE,wBAAgB,mBAAmB,CAC/B,KAAK,EAAE,UAAU,EAAE,EACnB,YAAY,EAAE,wBAAwB,EACtC,KAAK,EAAE,aAAa,GAAG,SAAS,EAChC,aAAa,CAAC,EAAE,MAAM,GACvB,YAAY,EAAE,CAKhB;AAID,wBAAgB,qBAAqB,IAAI,UAAU,EAAE,CAMpD;AAED,wBAAgB,sBAAsB,CAClC,KAAK,EAAE,SAAS,UAAU,EAAE,EAC5B,OAAO,EAAE,wBAAwB,EACjC,KAAK,EAAE,aAAa,GAAG,SAAS,EAChC,SAAS,GAAE,SAAS,gBAAgB,EAAc,EAClD,OAAO,GAAE,uBAAoC,GAC9C,YAAY,EAAE,CAuBhB"}
|
|
@@ -4,7 +4,8 @@ import { COMPUTED_ATTRIBUTE_FEATURE_FLAG } from "../computedAttribute/gate.js";
|
|
|
4
4
|
import { ObjectTypes } from "../objectType/constants.js";
|
|
5
5
|
import {} from "../objectType/types.js";
|
|
6
6
|
import { useFeatureFlag, useFeatureFlags } from "../permission/PermissionsContext.js";
|
|
7
|
-
import {
|
|
7
|
+
import { isQualityReported } from "../quality/gate.js";
|
|
8
|
+
import { getAttributesQuery, getComputedAttributesQuery, getDashboardsQuery, getDateDatasetsQuery, getFactsQuery, getInsightsQuery, getMetricsQuery, getParametersQuery, queryDocuments, } from "./query.js";
|
|
8
9
|
export function useCatalogQueryOptions(feedOptions, filterInputs) {
|
|
9
10
|
const { backend, workspace, id, pageSize } = feedOptions;
|
|
10
11
|
const { search, origin, createdBy, tags, qualityIds, isHidden, certification } = filterInputs;
|
|
@@ -12,23 +13,13 @@ export function useCatalogQueryOptions(feedOptions, filterInputs) {
|
|
|
12
13
|
const loadPermissions = useFeatureFlag("enableMetricPermissions");
|
|
13
14
|
const loadVisualizationPermissions = useFeatureFlag("enableVisualizationPermissions");
|
|
14
15
|
return useMemo(() => {
|
|
15
|
-
let includeIds = id;
|
|
16
|
-
let excludeIds = undefined;
|
|
17
|
-
if (qualityIds) {
|
|
18
|
-
if (qualityIds.isInverted) {
|
|
19
|
-
excludeIds = qualityIds.values;
|
|
20
|
-
}
|
|
21
|
-
else {
|
|
22
|
-
includeIds = [...new Set([...qualityIds.values, ...(id ?? [])])];
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
16
|
return {
|
|
26
17
|
backend,
|
|
27
18
|
workspace,
|
|
28
19
|
search,
|
|
29
20
|
origin,
|
|
30
|
-
id
|
|
31
|
-
|
|
21
|
+
id,
|
|
22
|
+
qualityIds,
|
|
32
23
|
createdBy: createdBy.isInverted ? undefined : createdBy.values,
|
|
33
24
|
excludeCreatedBy: createdBy.isInverted ? createdBy.values : undefined,
|
|
34
25
|
tags: tags.isInverted ? undefined : tags.values,
|
|
@@ -60,6 +51,12 @@ const ENDPOINTS = [
|
|
|
60
51
|
type: ObjectTypes.DASHBOARD,
|
|
61
52
|
query: (opts) => getDashboardsQuery(opts).query(),
|
|
62
53
|
},
|
|
54
|
+
{
|
|
55
|
+
type: ObjectTypes.DOCUMENT,
|
|
56
|
+
query: (opts, { documentOwner }) => queryDocuments(opts, documentOwner),
|
|
57
|
+
gatedBy: ["enableBusinessBriefingReportsApp", "enablePublisherV2", "enableCatalogDocuments"],
|
|
58
|
+
cannotFilterBy: ["certification"],
|
|
59
|
+
},
|
|
63
60
|
{
|
|
64
61
|
type: ObjectTypes.VISUALIZATION,
|
|
65
62
|
query: (opts) => getInsightsQuery(opts).query(),
|
|
@@ -94,17 +91,15 @@ const ENDPOINTS = [
|
|
|
94
91
|
cannotFilterBy: ["createdBy", "excludeCreatedBy", "certification"],
|
|
95
92
|
},
|
|
96
93
|
];
|
|
97
|
-
export function useCatalogEndpoints(types, queryOptions, flags) {
|
|
98
|
-
return useMemo(() => selectCatalogEndpoints(types, queryOptions, flags), [flags, queryOptions, types]);
|
|
94
|
+
export function useCatalogEndpoints(types, queryOptions, flags, documentOwner) {
|
|
95
|
+
return useMemo(() => selectCatalogEndpoints(types, queryOptions, flags, ENDPOINTS, { documentOwner }), [flags, queryOptions, types, documentOwner]);
|
|
99
96
|
}
|
|
97
|
+
const NO_CONTEXT = {};
|
|
100
98
|
export function useEnabledObjectTypes() {
|
|
101
99
|
const flags = useFeatureFlags();
|
|
102
100
|
return useMemo(() => ENDPOINTS.filter((endpoint) => isEndpointEnabled(endpoint, flags)).map(({ type }) => type), [flags]);
|
|
103
101
|
}
|
|
104
|
-
export function selectCatalogEndpoints(types, options, flags, endpoints = ENDPOINTS) {
|
|
105
|
-
if (options.id?.length === 0) {
|
|
106
|
-
return [];
|
|
107
|
-
}
|
|
102
|
+
export function selectCatalogEndpoints(types, options, flags, endpoints = ENDPOINTS, context = NO_CONTEXT) {
|
|
108
103
|
const result = [];
|
|
109
104
|
for (const endpoint of endpoints) {
|
|
110
105
|
// types rule: empty = all
|
|
@@ -119,7 +114,12 @@ export function selectCatalogEndpoints(types, options, flags, endpoints = ENDPOI
|
|
|
119
114
|
if (endpoint.cannotFilterBy?.some((slot) => isSlotActive[slot](options))) {
|
|
120
115
|
continue;
|
|
121
116
|
}
|
|
122
|
-
|
|
117
|
+
// quality rule: the quality filter narrows the ids, and an empty id list matches nothing
|
|
118
|
+
const endpointOptions = applyQualityIds(options, endpoint.type);
|
|
119
|
+
if (!endpointOptions || endpointOptions.id?.length === 0) {
|
|
120
|
+
continue;
|
|
121
|
+
}
|
|
122
|
+
result.push({ type: endpoint.type, query: () => endpoint.query(endpointOptions, context) });
|
|
123
123
|
}
|
|
124
124
|
return result;
|
|
125
125
|
}
|
|
@@ -131,3 +131,20 @@ const isSlotActive = {
|
|
|
131
131
|
excludeCreatedBy: (options) => (options.excludeCreatedBy?.length ?? 0) > 0,
|
|
132
132
|
certification: (options) => Boolean(options.certification),
|
|
133
133
|
};
|
|
134
|
+
/**
|
|
135
|
+
* The options with the quality filter folded into the ids, or undefined when no object of the type can match.
|
|
136
|
+
* Objects outside the quality report have no issues: "with issues" matches none, "without issues" all.
|
|
137
|
+
*/
|
|
138
|
+
function applyQualityIds(options, type) {
|
|
139
|
+
const { qualityIds } = options;
|
|
140
|
+
if (!qualityIds) {
|
|
141
|
+
return options;
|
|
142
|
+
}
|
|
143
|
+
if (!isQualityReported(type)) {
|
|
144
|
+
return qualityIds.isInverted ? options : undefined;
|
|
145
|
+
}
|
|
146
|
+
if (qualityIds.isInverted) {
|
|
147
|
+
return { ...options, excludeId: qualityIds.values };
|
|
148
|
+
}
|
|
149
|
+
return { ...options, id: [...new Set([...qualityIds.values, ...(options.id ?? [])])] };
|
|
150
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useCatalogItemFeed.d.ts","sourceRoot":"","sources":["../../src/catalogItem/useCatalogItemFeed.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"useCatalogItemFeed.d.ts","sourceRoot":"","sources":["../../src/catalogItem/useCatalogItemFeed.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAKzD,OAAO,KAAK,EAAE,YAAY,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAKzF,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,uBAAuB;;;;;;;;;;;;;;;;;;;;uBAyDxD,YAAY;uBAIZ,eAAe;8BAZf,UAAU;EA8BxB"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// (C) 2025-2026 GoodData Corporation
|
|
2
2
|
import { useCallback, useMemo } from "react";
|
|
3
3
|
import { areObjRefsEqual } from "@gooddata/sdk-model";
|
|
4
|
+
import { useDocumentOwner } from "../document/scope.js";
|
|
4
5
|
import { useFilterState, useQualityFilter } from "../filter/FilterContext.js";
|
|
5
6
|
import { ObjectTypes } from "../objectType/constants.js";
|
|
6
7
|
import {} from "../objectType/types.js";
|
|
@@ -24,7 +25,8 @@ export function useCatalogItemFeed(feedOptions) {
|
|
|
24
25
|
isHidden,
|
|
25
26
|
certification,
|
|
26
27
|
});
|
|
27
|
-
const
|
|
28
|
+
const documentOwner = useDocumentOwner();
|
|
29
|
+
const endpoints = useCatalogEndpoints(types, queryOptions, flags, documentOwner);
|
|
28
30
|
const paginator = useEndpointPaginator(endpoints, convertEntityToCatalogItem);
|
|
29
31
|
const { items, status, error, totalCount, totalCounts, hasNext, next, refetch, updateWhere, removeWhere, } = paginator;
|
|
30
32
|
const { relatedItems, relatedItemsStatus, relatedHasNext } = useCatalogItemSemanticSearch({
|
|
@@ -72,6 +74,7 @@ function getTotalCountByType(endpoints, totalCounts) {
|
|
|
72
74
|
[ObjectTypes.DATASET]: 0,
|
|
73
75
|
[ObjectTypes.PARAMETER]: 0,
|
|
74
76
|
[ObjectTypes.COMPUTED_ATTRIBUTE]: 0,
|
|
77
|
+
[ObjectTypes.DOCUMENT]: 0,
|
|
75
78
|
};
|
|
76
79
|
endpoints.forEach((endpoint, idx) => {
|
|
77
80
|
base[endpoint.type] = totalCounts[idx] ?? 0;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useCatalogItemSemanticSearch.d.ts","sourceRoot":"","sources":["../../src/catalogItem/useCatalogItemSemanticSearch.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"useCatalogItemSemanticSearch.d.ts","sourceRoot":"","sources":["../../src/catalogItem/useCatalogItemSemanticSearch.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAOrD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAGvF,wBAAgB,4BAA4B,CAAC,EACzC,YAAY,EACZ,KAAK,EACL,MAAM,EACN,KAAK,EACL,MAAM,GACT,EAAE,iCAAiC;;;;EAyEnC"}
|
|
@@ -4,16 +4,23 @@ import {} from "@gooddata/sdk-model";
|
|
|
4
4
|
import { useCancelablePromise } from "@gooddata/sdk-ui";
|
|
5
5
|
import { useSemanticSearch } from "@gooddata/sdk-ui-semantic-search";
|
|
6
6
|
import {} from "../async/types.js";
|
|
7
|
+
import { useDocumentOwner } from "../document/scope.js";
|
|
7
8
|
import { mapGenAIObjectType } from "../objectType/mapping.js";
|
|
8
9
|
import { useFeatureFlags } from "../permission/PermissionsContext.js";
|
|
9
10
|
import { convertEntityToCatalogItem } from "./converter.js";
|
|
10
11
|
import {} from "./types.js";
|
|
11
|
-
import { useCatalogEndpoints } from "./useCatalogEndpoints.js";
|
|
12
|
+
import { useCatalogEndpoints, useEnabledObjectTypes } from "./useCatalogEndpoints.js";
|
|
12
13
|
export function useCatalogItemSemanticSearch({ queryOptions, items, status, types, search, }) {
|
|
13
14
|
const flags = useFeatureFlags();
|
|
14
|
-
const
|
|
15
|
+
const enabledTypes = useEnabledObjectTypes();
|
|
16
|
+
const objectTypes = useMemo(() => convertTypesToGenAiTypes(types, enabledTypes), [types, enabledTypes]);
|
|
15
17
|
const isSemanticSearchEnabled = Boolean(flags?.enableCatalogSmartSearchResults);
|
|
16
|
-
const isSemanticSearchPossible = isSemanticSearchEnabled &&
|
|
18
|
+
const isSemanticSearchPossible = isSemanticSearchEnabled &&
|
|
19
|
+
objectTypes.length &&
|
|
20
|
+
search &&
|
|
21
|
+
!queryOptions.id &&
|
|
22
|
+
// search results replace the ids, so they cannot narrow to the objects with quality issues
|
|
23
|
+
!(queryOptions.qualityIds && !queryOptions.qualityIds.isInverted);
|
|
17
24
|
const { searchStatus, searchResults } = useSemanticSearch({
|
|
18
25
|
searchTerm: isSemanticSearchPossible ? search : "",
|
|
19
26
|
backend: queryOptions.backend,
|
|
@@ -27,7 +34,8 @@ export function useCatalogItemSemanticSearch({ queryOptions, items, status, type
|
|
|
27
34
|
search: undefined,
|
|
28
35
|
};
|
|
29
36
|
}, [queryOptions, searchResults]);
|
|
30
|
-
const
|
|
37
|
+
const documentOwner = useDocumentOwner();
|
|
38
|
+
const endpoints = useCatalogEndpoints(types, updateQueryOptions, flags, documentOwner);
|
|
31
39
|
const { status: promiseStatus, result: promiseItems } = useCancelablePromise({
|
|
32
40
|
promise: async () => {
|
|
33
41
|
if (!isSemanticSearchEnabled || searchStatus !== "success") {
|
|
@@ -62,9 +70,10 @@ export function useCatalogItemSemanticSearch({ queryOptions, items, status, type
|
|
|
62
70
|
relatedHasNext,
|
|
63
71
|
};
|
|
64
72
|
}
|
|
65
|
-
function convertTypesToGenAiTypes(types) {
|
|
73
|
+
function convertTypesToGenAiTypes(types, enabledTypes) {
|
|
74
|
+
const documents = enabledTypes.includes("document") ? ["document"] : [];
|
|
66
75
|
if (!types.length) {
|
|
67
|
-
return ["fact", "attribute", "dashboard", "metric", "visualization", "dataset", "date"];
|
|
76
|
+
return ["fact", "attribute", "dashboard", "metric", "visualization", "dataset", "date", ...documents];
|
|
68
77
|
}
|
|
69
78
|
return types
|
|
70
79
|
.map((a) => {
|
|
@@ -72,6 +81,9 @@ function convertTypesToGenAiTypes(types) {
|
|
|
72
81
|
if (a === "parameter" || a === "computedAttribute") {
|
|
73
82
|
return null;
|
|
74
83
|
}
|
|
84
|
+
if (a === "document" && !documents.length) {
|
|
85
|
+
return null;
|
|
86
|
+
}
|
|
75
87
|
return mapGenAIObjectType(a);
|
|
76
88
|
})
|
|
77
89
|
.filter(Boolean);
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Whether the user may create a Reports document from the catalog: the catalog lists documents and the
|
|
3
|
+
* user holds the create grant. False until the permissions load.
|
|
4
|
+
*/
|
|
5
|
+
export declare function useCanCreateDocument(): boolean;
|
|
6
|
+
//# sourceMappingURL=gate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"gate.d.ts","sourceRoot":"","sources":["../../src/document/gate.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAI9C"}
|