@esri/hub-common 12.31.1 → 12.33.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.
|
@@ -9,17 +9,19 @@ import { getFamilyTypes } from "../content/get-family";
|
|
|
9
9
|
export function dotifyString(i18nScope) {
|
|
10
10
|
return i18nScope && i18nScope.slice(-1) !== "." ? `${i18nScope}.` : i18nScope;
|
|
11
11
|
}
|
|
12
|
-
/** Get a single catalog based on the name, entity type and optional requests
|
|
12
|
+
/** Get a single catalog based on the catalog name, entity type and optional requests
|
|
13
13
|
* @param i18nScope Translation scope to be interpolated into the catalog
|
|
14
14
|
* @param name Name of the catalog requested
|
|
15
15
|
* @param entityType
|
|
16
16
|
* @param options An opitional IGetWellKnownCatalogOptions definition JSON object
|
|
17
17
|
* @returns An IHubCatalog definition JSON object
|
|
18
18
|
*/
|
|
19
|
-
export function getWellKnownCatalog(i18nScope,
|
|
19
|
+
export function getWellKnownCatalog(i18nScope, catalogName, entityType, options) {
|
|
20
20
|
switch (entityType) {
|
|
21
21
|
case "item":
|
|
22
|
-
return getWellknownItemCatalog(i18nScope,
|
|
22
|
+
return getWellknownItemCatalog(i18nScope, catalogName, options);
|
|
23
|
+
case "group":
|
|
24
|
+
return getWellknownGroupCatalog(i18nScope, catalogName, options);
|
|
23
25
|
/* Add other entity handlers here, e.g. getWellknownEventCatalog */
|
|
24
26
|
default:
|
|
25
27
|
throw new Error(`Wellknown catalog not implemented for "${entityType}"`);
|
|
@@ -29,60 +31,117 @@ export function getWellKnownCatalog(i18nScope, name, entityType, options) {
|
|
|
29
31
|
* Build an IHubCatalog definition JSON object based on the
|
|
30
32
|
* catalog name, predicates and collections we want to use for each catalog
|
|
31
33
|
* @param i18nScope
|
|
32
|
-
* @param
|
|
34
|
+
* @param catalogName
|
|
33
35
|
* @param predicates Predicates for the catalog
|
|
34
36
|
* @param collections Collections to include for the catalog
|
|
35
37
|
* @returns An IHubCatalog definition JSON object
|
|
36
38
|
*/
|
|
37
|
-
function buildCatalog(i18nScope,
|
|
39
|
+
function buildCatalog(i18nScope, catalogName, predicates, collections, entityType) {
|
|
40
|
+
let scopes;
|
|
41
|
+
switch (entityType) {
|
|
42
|
+
case "item":
|
|
43
|
+
scopes = {
|
|
44
|
+
item: {
|
|
45
|
+
targetEntity: "item",
|
|
46
|
+
filters: [{ predicates }],
|
|
47
|
+
},
|
|
48
|
+
};
|
|
49
|
+
break;
|
|
50
|
+
case "group":
|
|
51
|
+
scopes = {
|
|
52
|
+
group: {
|
|
53
|
+
targetEntity: "group",
|
|
54
|
+
filters: [{ predicates }],
|
|
55
|
+
},
|
|
56
|
+
};
|
|
57
|
+
break;
|
|
58
|
+
}
|
|
38
59
|
return {
|
|
39
60
|
schemaVersion: 1,
|
|
40
|
-
title: `{{${i18nScope}catalog.${
|
|
41
|
-
scopes
|
|
42
|
-
item: {
|
|
43
|
-
targetEntity: "item",
|
|
44
|
-
filters: [{ predicates }],
|
|
45
|
-
},
|
|
46
|
-
},
|
|
61
|
+
title: `{{${i18nScope}catalog.${catalogName}:translate}}`,
|
|
62
|
+
scopes,
|
|
47
63
|
collections,
|
|
48
64
|
};
|
|
49
65
|
}
|
|
50
66
|
/**
|
|
51
67
|
* Check if user is available in the passed options, throw an error if not
|
|
52
|
-
* @param
|
|
68
|
+
* @param catalogName
|
|
53
69
|
* @param options Options that contains user
|
|
54
70
|
*/
|
|
55
|
-
function
|
|
71
|
+
function validateUserExistence(catalogName, options) {
|
|
56
72
|
if (!options || !options.user) {
|
|
57
|
-
throw new Error(`User needed to get "${
|
|
73
|
+
throw new Error(`User needed to get "${catalogName}" catalog`);
|
|
58
74
|
}
|
|
59
75
|
}
|
|
60
76
|
/**
|
|
61
77
|
* Get an ITEM catalog based on the name and optional requests
|
|
62
78
|
* @param i18nScope Translation scope to be interpolated into the catalog
|
|
63
|
-
* @param
|
|
79
|
+
* @param catalogName Name of the catalog requested
|
|
64
80
|
* @param options An opitional IGetWellKnownCatalogOptions definition JSON object
|
|
65
81
|
* @returns An ITEM IHubCatalog definition JSON object
|
|
66
82
|
*/
|
|
67
|
-
function getWellknownItemCatalog(i18nScope,
|
|
83
|
+
function getWellknownItemCatalog(i18nScope, catalogName, options) {
|
|
68
84
|
i18nScope = dotifyString(i18nScope);
|
|
69
85
|
let catalog;
|
|
70
86
|
const collections = getWellknownCollections(i18nScope, "item", options === null || options === void 0 ? void 0 : options.collectionNames);
|
|
71
|
-
switch (
|
|
87
|
+
switch (catalogName) {
|
|
72
88
|
case "myContent":
|
|
73
|
-
|
|
74
|
-
catalog = buildCatalog(i18nScope,
|
|
89
|
+
validateUserExistence(catalogName, options);
|
|
90
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ owner: options.user.username }], collections, "item");
|
|
75
91
|
break;
|
|
76
92
|
case "favorites":
|
|
77
|
-
|
|
78
|
-
catalog = buildCatalog(i18nScope,
|
|
93
|
+
validateUserExistence(catalogName, options);
|
|
94
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ group: options.user.favGroupId }], collections, "item");
|
|
79
95
|
break;
|
|
80
96
|
case "organization":
|
|
81
|
-
|
|
82
|
-
catalog = buildCatalog(i18nScope,
|
|
97
|
+
validateUserExistence(catalogName, options);
|
|
98
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ orgid: options.user.orgId }], collections, "item");
|
|
83
99
|
break;
|
|
84
100
|
case "world":
|
|
85
|
-
catalog = buildCatalog(i18nScope,
|
|
101
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ type: { not: ["code attachment"] } }], collections, "item");
|
|
102
|
+
break;
|
|
103
|
+
}
|
|
104
|
+
return catalog;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Get a group catalog based on the name and optional requests
|
|
108
|
+
* @param i18nScope Translation scope to be interpolated into the catalog
|
|
109
|
+
* @param catalogName Name of the catalog requested
|
|
110
|
+
* @param options An opitional IGetWellKnownCatalogOptions definition JSON object
|
|
111
|
+
* @returns A group IHubCatalog definition JSON object
|
|
112
|
+
*/
|
|
113
|
+
function getWellknownGroupCatalog(i18nScope, catalogName, options) {
|
|
114
|
+
i18nScope = dotifyString(i18nScope);
|
|
115
|
+
let catalog;
|
|
116
|
+
// because collections are needed in arcgis-hub-catalog and
|
|
117
|
+
// "searchGroups" allows 'q: "*"', we use this as the collection
|
|
118
|
+
const collections = [
|
|
119
|
+
{
|
|
120
|
+
targetEntity: "group",
|
|
121
|
+
key: catalogName,
|
|
122
|
+
label: catalogName,
|
|
123
|
+
scope: {
|
|
124
|
+
targetEntity: "group",
|
|
125
|
+
filters: [
|
|
126
|
+
{
|
|
127
|
+
predicates: [{ q: "*" }],
|
|
128
|
+
},
|
|
129
|
+
],
|
|
130
|
+
},
|
|
131
|
+
},
|
|
132
|
+
];
|
|
133
|
+
switch (catalogName) {
|
|
134
|
+
case "editGroups":
|
|
135
|
+
validateUserExistence(catalogName, options);
|
|
136
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ capabilities: ["updateitemcontrol"] }], collections, "group");
|
|
137
|
+
break;
|
|
138
|
+
case "viewGroups":
|
|
139
|
+
validateUserExistence(catalogName, options);
|
|
140
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ capabilities: { not: ["updateitemcontrol"] } }], collections, "group");
|
|
141
|
+
break;
|
|
142
|
+
case "allGroups":
|
|
143
|
+
validateUserExistence(catalogName, options);
|
|
144
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ capabilities: [""] }], collections, "group");
|
|
86
145
|
break;
|
|
87
146
|
}
|
|
88
147
|
return catalog;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"wellKnownCatalog.js","sourceRoot":"","sources":["../../../src/search/wellKnownCatalog.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"wellKnownCatalog.js","sourceRoot":"","sources":["../../../src/search/wellKnownCatalog.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAsCvD;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,SAAiB;IAC5C,OAAO,SAAS,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;AAChF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,SAAiB,EACjB,WAA6B,EAC7B,UAAsB,EACtB,OAAqC;IAErC,QAAQ,UAAU,EAAE;QAClB,KAAK,MAAM;YACT,OAAO,uBAAuB,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAClE,KAAK,OAAO;YACV,OAAO,wBAAwB,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACnE,mEAAmE;QACnE;YACE,MAAM,IAAI,KAAK,CAAC,0CAA0C,UAAU,GAAG,CAAC,CAAC;KAC5E;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,YAAY,CACnB,SAAiB,EACjB,WAA6B,EAC7B,UAAiB,EACjB,WAA6B,EAC7B,UAAsB;IAEtB,IAAI,MAAM,CAAC;IACX,QAAQ,UAAU,EAAE;QAClB,KAAK,MAAM;YACT,MAAM,GAAG;gBACP,IAAI,EAAE;oBACJ,YAAY,EAAE,MAAoB;oBAClC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;iBAC1B;aACF,CAAC;YACF,MAAM;QACR,KAAK,OAAO;YACV,MAAM,GAAG;gBACP,KAAK,EAAE;oBACL,YAAY,EAAE,OAAqB;oBACnC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;iBAC1B;aACF,CAAC;YACF,MAAM;KACT;IACD,OAAO;QACL,aAAa,EAAE,CAAC;QAChB,KAAK,EAAE,KAAK,SAAS,WAAW,WAAW,cAAc;QACzD,MAAM;QACN,WAAW;KACZ,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,qBAAqB,CAC5B,WAA6B,EAC7B,OAAoC;IAEpC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,uBAAuB,WAAW,WAAW,CAAC,CAAC;KAChE;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,uBAAuB,CAC9B,SAAiB,EACjB,WAA6B,EAC7B,OAAqC;IAErC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACpC,IAAI,OAAO,CAAC;IACZ,MAAM,WAAW,GAAG,uBAAuB,CACzC,SAAS,EACT,MAAM,EACN,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,CACzB,CAAC;IACF,QAAQ,WAAW,EAAE;QACnB,KAAK,WAAW;YACd,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAClC,WAAW,EACX,MAAM,CACP,CAAC;YACF,MAAM;QACR,KAAK,WAAW;YACd,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EACpC,WAAW,EACX,MAAM,CACP,CAAC;YACF,MAAM;QACR,KAAK,cAAc;YACjB,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAC/B,WAAW,EACX,MAAM,CACP,CAAC;YACF,MAAM;QACR,KAAK,OAAO;YACV,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,CAAC,EACxC,WAAW,EACX,MAAM,CACP,CAAC;YACF,MAAM;KACT;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAC/B,SAAiB,EACjB,WAA6B,EAC7B,OAAqC;IAErC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACpC,IAAI,OAAO,CAAC;IACZ,2DAA2D;IAC3D,gEAAgE;IAChE,MAAM,WAAW,GAAG;QAClB;YACE,YAAY,EAAE,OAAqB;YACnC,GAAG,EAAE,WAAW;YAChB,KAAK,EAAE,WAAW;YAClB,KAAK,EAAE;gBACL,YAAY,EAAE,OAAqB;gBACnC,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC;qBACzB;iBACF;aACF;SACF;KACF,CAAC;IAEF,QAAQ,WAAW,EAAE;QACnB,KAAK,YAAY;YACf,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,YAAY,EAAE,CAAC,mBAAmB,CAAC,EAAE,CAAC,EACzC,WAAW,EACX,OAAO,CACR,CAAC;YACF,MAAM;QACR,KAAK,YAAY;YACf,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,CAAC,mBAAmB,CAAC,EAAE,EAAE,CAAC,EAClD,WAAW,EACX,OAAO,CACR,CAAC;YACF,MAAM;QACR,KAAK,WAAW;YACd,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACxB,WAAW,EACX,OAAO,CACR,CAAC;YACF,MAAM;KACT;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,SAAiB,EAAE,UAAsB;IACrE,OAAO;QACL,SAAS,EAAE;YACT,GAAG,EAAE,WAAW;YAChB,KAAK,EAAE,KAAK,SAAS,oCAAoC;YACzD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;6BAC3D;yBACF;qBACF;iBACF;aACF;SACgB;QACnB,OAAO,EAAE;YACP,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,KAAK,SAAS,gCAAgC;YACrD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;aACjE;SACgB;QACnB,QAAQ,EAAE;YACR,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,KAAK,SAAS,kCAAkC;YACvD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;aAClE;SACgB;QACnB,QAAQ,EAAE;YACR,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,KAAK,SAAS,iCAAiC;YACtD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;aAClE;SACgB;QACnB,IAAI,EAAE;YACJ,GAAG,EAAE,MAAM;YACX,KAAK,EAAE,KAAK,SAAS,8BAA8B;YACnD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC;6BAC7B;yBACF;qBACF;iBACF;aACF;SACgB;QACnB,QAAQ,EAAE;YACR,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,KAAK,SAAS,kCAAkC;YACvD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC;6BACjC;yBACF;qBACF;iBACF;aACF;SACgB;KACpB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,yBAAyB;IAChC,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,uBAAuB,CACrC,SAAiB,EACjB,UAAsB,EACtB,eAAuC;IAEvC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IAEpC,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEtE,MAAM,sBAAsB,GAAG,yBAAyB,EAAE,CAAC;IAE3D,mEAAmE;IACnE,wCAAwC;IACxC,MAAM,KAAK,GAAG,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM,EACnC,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,sBAAsB,CAAC;IAC3B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;SACrC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAAiB,EACjB,UAAsB,EACtB,cAAmC;IAEnC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACpC,OAAO,oBAAoB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,cAAc,CAAC,CAAC;AACrE,CAAC"}
|
|
@@ -13,17 +13,19 @@ function dotifyString(i18nScope) {
|
|
|
13
13
|
return i18nScope && i18nScope.slice(-1) !== "." ? `${i18nScope}.` : i18nScope;
|
|
14
14
|
}
|
|
15
15
|
exports.dotifyString = dotifyString;
|
|
16
|
-
/** Get a single catalog based on the name, entity type and optional requests
|
|
16
|
+
/** Get a single catalog based on the catalog name, entity type and optional requests
|
|
17
17
|
* @param i18nScope Translation scope to be interpolated into the catalog
|
|
18
18
|
* @param name Name of the catalog requested
|
|
19
19
|
* @param entityType
|
|
20
20
|
* @param options An opitional IGetWellKnownCatalogOptions definition JSON object
|
|
21
21
|
* @returns An IHubCatalog definition JSON object
|
|
22
22
|
*/
|
|
23
|
-
function getWellKnownCatalog(i18nScope,
|
|
23
|
+
function getWellKnownCatalog(i18nScope, catalogName, entityType, options) {
|
|
24
24
|
switch (entityType) {
|
|
25
25
|
case "item":
|
|
26
|
-
return getWellknownItemCatalog(i18nScope,
|
|
26
|
+
return getWellknownItemCatalog(i18nScope, catalogName, options);
|
|
27
|
+
case "group":
|
|
28
|
+
return getWellknownGroupCatalog(i18nScope, catalogName, options);
|
|
27
29
|
/* Add other entity handlers here, e.g. getWellknownEventCatalog */
|
|
28
30
|
default:
|
|
29
31
|
throw new Error(`Wellknown catalog not implemented for "${entityType}"`);
|
|
@@ -34,60 +36,117 @@ exports.getWellKnownCatalog = getWellKnownCatalog;
|
|
|
34
36
|
* Build an IHubCatalog definition JSON object based on the
|
|
35
37
|
* catalog name, predicates and collections we want to use for each catalog
|
|
36
38
|
* @param i18nScope
|
|
37
|
-
* @param
|
|
39
|
+
* @param catalogName
|
|
38
40
|
* @param predicates Predicates for the catalog
|
|
39
41
|
* @param collections Collections to include for the catalog
|
|
40
42
|
* @returns An IHubCatalog definition JSON object
|
|
41
43
|
*/
|
|
42
|
-
function buildCatalog(i18nScope,
|
|
44
|
+
function buildCatalog(i18nScope, catalogName, predicates, collections, entityType) {
|
|
45
|
+
let scopes;
|
|
46
|
+
switch (entityType) {
|
|
47
|
+
case "item":
|
|
48
|
+
scopes = {
|
|
49
|
+
item: {
|
|
50
|
+
targetEntity: "item",
|
|
51
|
+
filters: [{ predicates }],
|
|
52
|
+
},
|
|
53
|
+
};
|
|
54
|
+
break;
|
|
55
|
+
case "group":
|
|
56
|
+
scopes = {
|
|
57
|
+
group: {
|
|
58
|
+
targetEntity: "group",
|
|
59
|
+
filters: [{ predicates }],
|
|
60
|
+
},
|
|
61
|
+
};
|
|
62
|
+
break;
|
|
63
|
+
}
|
|
43
64
|
return {
|
|
44
65
|
schemaVersion: 1,
|
|
45
|
-
title: `{{${i18nScope}catalog.${
|
|
46
|
-
scopes
|
|
47
|
-
item: {
|
|
48
|
-
targetEntity: "item",
|
|
49
|
-
filters: [{ predicates }],
|
|
50
|
-
},
|
|
51
|
-
},
|
|
66
|
+
title: `{{${i18nScope}catalog.${catalogName}:translate}}`,
|
|
67
|
+
scopes,
|
|
52
68
|
collections,
|
|
53
69
|
};
|
|
54
70
|
}
|
|
55
71
|
/**
|
|
56
72
|
* Check if user is available in the passed options, throw an error if not
|
|
57
|
-
* @param
|
|
73
|
+
* @param catalogName
|
|
58
74
|
* @param options Options that contains user
|
|
59
75
|
*/
|
|
60
|
-
function
|
|
76
|
+
function validateUserExistence(catalogName, options) {
|
|
61
77
|
if (!options || !options.user) {
|
|
62
|
-
throw new Error(`User needed to get "${
|
|
78
|
+
throw new Error(`User needed to get "${catalogName}" catalog`);
|
|
63
79
|
}
|
|
64
80
|
}
|
|
65
81
|
/**
|
|
66
82
|
* Get an ITEM catalog based on the name and optional requests
|
|
67
83
|
* @param i18nScope Translation scope to be interpolated into the catalog
|
|
68
|
-
* @param
|
|
84
|
+
* @param catalogName Name of the catalog requested
|
|
69
85
|
* @param options An opitional IGetWellKnownCatalogOptions definition JSON object
|
|
70
86
|
* @returns An ITEM IHubCatalog definition JSON object
|
|
71
87
|
*/
|
|
72
|
-
function getWellknownItemCatalog(i18nScope,
|
|
88
|
+
function getWellknownItemCatalog(i18nScope, catalogName, options) {
|
|
73
89
|
i18nScope = dotifyString(i18nScope);
|
|
74
90
|
let catalog;
|
|
75
91
|
const collections = getWellknownCollections(i18nScope, "item", options === null || options === void 0 ? void 0 : options.collectionNames);
|
|
76
|
-
switch (
|
|
92
|
+
switch (catalogName) {
|
|
77
93
|
case "myContent":
|
|
78
|
-
|
|
79
|
-
catalog = buildCatalog(i18nScope,
|
|
94
|
+
validateUserExistence(catalogName, options);
|
|
95
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ owner: options.user.username }], collections, "item");
|
|
80
96
|
break;
|
|
81
97
|
case "favorites":
|
|
82
|
-
|
|
83
|
-
catalog = buildCatalog(i18nScope,
|
|
98
|
+
validateUserExistence(catalogName, options);
|
|
99
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ group: options.user.favGroupId }], collections, "item");
|
|
84
100
|
break;
|
|
85
101
|
case "organization":
|
|
86
|
-
|
|
87
|
-
catalog = buildCatalog(i18nScope,
|
|
102
|
+
validateUserExistence(catalogName, options);
|
|
103
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ orgid: options.user.orgId }], collections, "item");
|
|
88
104
|
break;
|
|
89
105
|
case "world":
|
|
90
|
-
catalog = buildCatalog(i18nScope,
|
|
106
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ type: { not: ["code attachment"] } }], collections, "item");
|
|
107
|
+
break;
|
|
108
|
+
}
|
|
109
|
+
return catalog;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Get a group catalog based on the name and optional requests
|
|
113
|
+
* @param i18nScope Translation scope to be interpolated into the catalog
|
|
114
|
+
* @param catalogName Name of the catalog requested
|
|
115
|
+
* @param options An opitional IGetWellKnownCatalogOptions definition JSON object
|
|
116
|
+
* @returns A group IHubCatalog definition JSON object
|
|
117
|
+
*/
|
|
118
|
+
function getWellknownGroupCatalog(i18nScope, catalogName, options) {
|
|
119
|
+
i18nScope = dotifyString(i18nScope);
|
|
120
|
+
let catalog;
|
|
121
|
+
// because collections are needed in arcgis-hub-catalog and
|
|
122
|
+
// "searchGroups" allows 'q: "*"', we use this as the collection
|
|
123
|
+
const collections = [
|
|
124
|
+
{
|
|
125
|
+
targetEntity: "group",
|
|
126
|
+
key: catalogName,
|
|
127
|
+
label: catalogName,
|
|
128
|
+
scope: {
|
|
129
|
+
targetEntity: "group",
|
|
130
|
+
filters: [
|
|
131
|
+
{
|
|
132
|
+
predicates: [{ q: "*" }],
|
|
133
|
+
},
|
|
134
|
+
],
|
|
135
|
+
},
|
|
136
|
+
},
|
|
137
|
+
];
|
|
138
|
+
switch (catalogName) {
|
|
139
|
+
case "editGroups":
|
|
140
|
+
validateUserExistence(catalogName, options);
|
|
141
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ capabilities: ["updateitemcontrol"] }], collections, "group");
|
|
142
|
+
break;
|
|
143
|
+
case "viewGroups":
|
|
144
|
+
validateUserExistence(catalogName, options);
|
|
145
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ capabilities: { not: ["updateitemcontrol"] } }], collections, "group");
|
|
146
|
+
break;
|
|
147
|
+
case "allGroups":
|
|
148
|
+
validateUserExistence(catalogName, options);
|
|
149
|
+
catalog = buildCatalog(i18nScope, catalogName, [{ capabilities: [""] }], collections, "group");
|
|
91
150
|
break;
|
|
92
151
|
}
|
|
93
152
|
return catalog;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"wellKnownCatalog.js","sourceRoot":"","sources":["../../../src/search/wellKnownCatalog.ts"],"names":[],"mappings":";;;AACA,sDAAuD;
|
|
1
|
+
{"version":3,"file":"wellKnownCatalog.js","sourceRoot":"","sources":["../../../src/search/wellKnownCatalog.ts"],"names":[],"mappings":";;;AACA,sDAAuD;AAsCvD;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,SAAiB;IAC5C,OAAO,SAAS,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;AAChF,CAAC;AAFD,oCAEC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,SAAiB,EACjB,WAA6B,EAC7B,UAAsB,EACtB,OAAqC;IAErC,QAAQ,UAAU,EAAE;QAClB,KAAK,MAAM;YACT,OAAO,uBAAuB,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAClE,KAAK,OAAO;YACV,OAAO,wBAAwB,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACnE,mEAAmE;QACnE;YACE,MAAM,IAAI,KAAK,CAAC,0CAA0C,UAAU,GAAG,CAAC,CAAC;KAC5E;AACH,CAAC;AAfD,kDAeC;AAED;;;;;;;;GAQG;AACH,SAAS,YAAY,CACnB,SAAiB,EACjB,WAA6B,EAC7B,UAAiB,EACjB,WAA6B,EAC7B,UAAsB;IAEtB,IAAI,MAAM,CAAC;IACX,QAAQ,UAAU,EAAE;QAClB,KAAK,MAAM;YACT,MAAM,GAAG;gBACP,IAAI,EAAE;oBACJ,YAAY,EAAE,MAAoB;oBAClC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;iBAC1B;aACF,CAAC;YACF,MAAM;QACR,KAAK,OAAO;YACV,MAAM,GAAG;gBACP,KAAK,EAAE;oBACL,YAAY,EAAE,OAAqB;oBACnC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;iBAC1B;aACF,CAAC;YACF,MAAM;KACT;IACD,OAAO;QACL,aAAa,EAAE,CAAC;QAChB,KAAK,EAAE,KAAK,SAAS,WAAW,WAAW,cAAc;QACzD,MAAM;QACN,WAAW;KACZ,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,qBAAqB,CAC5B,WAA6B,EAC7B,OAAoC;IAEpC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,uBAAuB,WAAW,WAAW,CAAC,CAAC;KAChE;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,uBAAuB,CAC9B,SAAiB,EACjB,WAA6B,EAC7B,OAAqC;IAErC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACpC,IAAI,OAAO,CAAC;IACZ,MAAM,WAAW,GAAG,uBAAuB,CACzC,SAAS,EACT,MAAM,EACN,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,CACzB,CAAC;IACF,QAAQ,WAAW,EAAE;QACnB,KAAK,WAAW;YACd,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAClC,WAAW,EACX,MAAM,CACP,CAAC;YACF,MAAM;QACR,KAAK,WAAW;YACd,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EACpC,WAAW,EACX,MAAM,CACP,CAAC;YACF,MAAM;QACR,KAAK,cAAc;YACjB,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAC/B,WAAW,EACX,MAAM,CACP,CAAC;YACF,MAAM;QACR,KAAK,OAAO;YACV,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,CAAC,EACxC,WAAW,EACX,MAAM,CACP,CAAC;YACF,MAAM;KACT;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAC/B,SAAiB,EACjB,WAA6B,EAC7B,OAAqC;IAErC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACpC,IAAI,OAAO,CAAC;IACZ,2DAA2D;IAC3D,gEAAgE;IAChE,MAAM,WAAW,GAAG;QAClB;YACE,YAAY,EAAE,OAAqB;YACnC,GAAG,EAAE,WAAW;YAChB,KAAK,EAAE,WAAW;YAClB,KAAK,EAAE;gBACL,YAAY,EAAE,OAAqB;gBACnC,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC;qBACzB;iBACF;aACF;SACF;KACF,CAAC;IAEF,QAAQ,WAAW,EAAE;QACnB,KAAK,YAAY;YACf,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,YAAY,EAAE,CAAC,mBAAmB,CAAC,EAAE,CAAC,EACzC,WAAW,EACX,OAAO,CACR,CAAC;YACF,MAAM;QACR,KAAK,YAAY;YACf,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,CAAC,mBAAmB,CAAC,EAAE,EAAE,CAAC,EAClD,WAAW,EACX,OAAO,CACR,CAAC;YACF,MAAM;QACR,KAAK,WAAW;YACd,qBAAqB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,GAAG,YAAY,CACpB,SAAS,EACT,WAAW,EACX,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACxB,WAAW,EACX,OAAO,CACR,CAAC;YACF,MAAM;KACT;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,SAAiB,EAAE,UAAsB;IACrE,OAAO;QACL,SAAS,EAAE;YACT,GAAG,EAAE,WAAW;YAChB,KAAK,EAAE,KAAK,SAAS,oCAAoC;YACzD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,CAAC,GAAG,2BAAc,CAAC,KAAK,CAAC,EAAE,GAAG,2BAAc,CAAC,KAAK,CAAC,CAAC;6BAC3D;yBACF;qBACF;iBACF;aACF;SACgB;QACnB,OAAO,EAAE;YACP,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,KAAK,SAAS,gCAAgC;YACrD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,2BAAc,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;aACjE;SACgB;QACnB,QAAQ,EAAE;YACR,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,KAAK,SAAS,kCAAkC;YACvD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,2BAAc,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;aAClE;SACgB;QACnB,QAAQ,EAAE;YACR,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,KAAK,SAAS,iCAAiC;YACtD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,2BAAc,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;aAClE;SACgB;QACnB,IAAI,EAAE;YACJ,GAAG,EAAE,MAAM;YACX,KAAK,EAAE,KAAK,SAAS,8BAA8B;YACnD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,2BAAc,CAAC,MAAM,CAAC;6BAC7B;yBACF;qBACF;iBACF;aACF;SACgB;QACnB,QAAQ,EAAE;YACR,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,KAAK,SAAS,kCAAkC;YACvD,YAAY,EAAE,UAAU;YACxB,OAAO,EAAE,EAAE;YACX,KAAK,EAAE;gBACL,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,2BAAc,CAAC,UAAU,CAAC;6BACjC;yBACF;qBACF;iBACF;aACF;SACgB;KACpB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,yBAAyB;IAChC,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CACrC,SAAiB,EACjB,UAAsB,EACtB,eAAuC;IAEvC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IAEpC,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEtE,MAAM,sBAAsB,GAAG,yBAAyB,EAAE,CAAC;IAE3D,mEAAmE;IACnE,wCAAwC;IACxC,MAAM,KAAK,GAAG,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM,EACnC,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,sBAAsB,CAAC;IAC3B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;SACrC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAtBD,0DAsBC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACpC,SAAiB,EACjB,UAAsB,EACtB,cAAmC;IAEnC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACpC,OAAO,oBAAoB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,cAAc,CAAC,CAAC;AACrE,CAAC;AAPD,wDAOC"}
|
|
@@ -5,7 +5,7 @@ import { EntityType, IHubCatalog, IHubCollection } from "./types";
|
|
|
5
5
|
* This is used to determine what IHubCatalog definition JSON object
|
|
6
6
|
* can be created
|
|
7
7
|
*/
|
|
8
|
-
export declare type WellKnownCatalog = "myContent" | "
|
|
8
|
+
export declare type WellKnownCatalog = "myContent" | "favorites" | "organization" | "world" | "editGroups" | "viewGroups" | "allGroups";
|
|
9
9
|
/**
|
|
10
10
|
* This is used to determine what IHubCollection definition JSON object
|
|
11
11
|
* can be created. We use HubFamily here to define most of the collections
|
|
@@ -30,14 +30,14 @@ export interface IGetWellKnownCatalogOptions {
|
|
|
30
30
|
* @returns i18nScope with a "." at the end if it is defined
|
|
31
31
|
*/
|
|
32
32
|
export declare function dotifyString(i18nScope: string): string;
|
|
33
|
-
/** Get a single catalog based on the name, entity type and optional requests
|
|
33
|
+
/** Get a single catalog based on the catalog name, entity type and optional requests
|
|
34
34
|
* @param i18nScope Translation scope to be interpolated into the catalog
|
|
35
35
|
* @param name Name of the catalog requested
|
|
36
36
|
* @param entityType
|
|
37
37
|
* @param options An opitional IGetWellKnownCatalogOptions definition JSON object
|
|
38
38
|
* @returns An IHubCatalog definition JSON object
|
|
39
39
|
*/
|
|
40
|
-
export declare function getWellKnownCatalog(i18nScope: string,
|
|
40
|
+
export declare function getWellKnownCatalog(i18nScope: string, catalogName: WellKnownCatalog, entityType: EntityType, options?: IGetWellKnownCatalogOptions): IHubCatalog;
|
|
41
41
|
/**
|
|
42
42
|
* Get a list of collections based on the entity type and an optional
|
|
43
43
|
* list of collection names, will return a list of default collections if none passed
|