@sitevision/api 2025.1.2 → 2025.3.1

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitevision/api",
3
- "version": "2025.1.2",
3
+ "version": "2025.3.1",
4
4
  "author": "Sitevision AB",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -30,5 +30,5 @@
30
30
  "access": "public",
31
31
  "directory": "dist"
32
32
  },
33
- "gitHead": "fad9ce2f6b699279e49c3bf5fb234b0f37605dc8"
33
+ "gitHead": "bbf94aa279c6aa74316f75eab9093a265acf169b"
34
34
  }
@@ -244,7 +244,7 @@ export interface ArticleUtil extends ArticleUtilConstants {
244
244
  * </ul>
245
245
  *
246
246
  * <p>The article content is specified using the
247
- * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the articel and values containing the
247
+ * content map containing keys corresponding to layout names (e.g. "Huvudinnehåll") on the article and values containing the
248
248
  * HTML used to generate a portlet structure in the layout. The provided content is converted to
249
249
  * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
250
250
  * layout should be created. For more information about the HTML to portlet mapping can be found in the
@@ -722,6 +722,18 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
722
722
  */
723
723
  SCRIPT_FIELD_TYPE: "sv:scriptField";
724
724
 
725
+ /**
726
+ * The primary node type name for the semantic index type.
727
+ * @since Sitevision 2025.03.1
728
+ */
729
+ SEMANTIC_INDEX_TYPE: "sv:semanticIndex";
730
+
731
+ /**
732
+ * The primary node type name for the semantic index repository type.
733
+ * @since Sitevision 2025.03.1
734
+ */
735
+ SEMANTIC_INDEX_REPOSITORY_TYPE: "sv:semanticIndexRepository";
736
+
725
737
  /**
726
738
  * The primary node type name for the simple user type.
727
739
  * @see #isSimpleUser(Node)
@@ -321,7 +321,7 @@ export interface OutputUtil extends OutputUtilConstants {
321
321
  * <em>
322
322
  * <strong>Note!</strong> This method is intended for debugging purposes during development ONLY!
323
323
  * Important: Only the types and properties that are officially specified on the
324
- * <a href="http://help.sitevision.se/nodetypes">Sitevision developer web</a>
324
+ * <a href="https://developer.sitevision.se/nodetypes">Sitevision developer web</a>
325
325
  * can be relied upon and used in production. All other types and properties should
326
326
  * be considered volatile. Output produced by this method is not indexed by the Sitevision indexer.
327
327
  * </em>
@@ -343,7 +343,7 @@ export interface OutputUtil extends OutputUtilConstants {
343
343
  * <em>
344
344
  * <strong>Note!</strong> This method is intended for debugging purposes during development ONLY!
345
345
  * Important: Only the types and properties that are officially specified on the
346
- * <a href="http://help.sitevision.se/nodetypes">Sitevision developer web</a>
346
+ * <a href="https://developer.sitevision.se/nodetypes">Sitevision developer web</a>
347
347
  * can be relied upon and used in production. All other types and properties should
348
348
  * be considered volatile. Output produced by this method is not indexed by the Sitevision indexer.
349
349
  * </em>
@@ -237,7 +237,7 @@ export interface PageUtil extends PageUtilConstants {
237
237
  * </ul>
238
238
  *
239
239
  * <p>The page content is specified using the
240
- * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the page and values containing the
240
+ * content map containing keys corresponding to layout names (e.g. "Huvudinnehåll") on the page and values containing the
241
241
  * HTML used to generate a portlet structure in the layout. The provided content is converted to
242
242
  * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
243
243
  * layout should be created. For more information about the HTML to portlet mapping can be found in the
@@ -488,6 +488,13 @@ export interface ResourceLocatorUtil {
488
488
  * @since Sitevision 2024.09.2
489
489
  */
490
490
  getTargetAudienceRepository(): Node;
491
+
492
+ /**
493
+ * Gets the semantic index repository (sv:semanticIndexRepository) for the site of current node.
494
+ * @return the semantic index repository, or null if indeterminable.
495
+ * @since Sitevision 2025.03.1
496
+ */
497
+ getSemanticIndexRepository(): Node;
491
498
  }
492
499
 
493
500
  declare namespace ResourceLocatorUtil {}
@@ -51,5 +51,6 @@ var _default = exports["default"] = {
51
51
  getWorkStatusTemplateRepository: function getWorkStatusTemplateRepository() {},
52
52
  getCssRuleRepository: function getCssRuleRepository() {},
53
53
  getLlmConfigurationRepository: function getLlmConfigurationRepository() {},
54
- getTargetAudienceRepository: function getTargetAudienceRepository() {}
54
+ getTargetAudienceRepository: function getTargetAudienceRepository() {},
55
+ getSemanticIndexRepository: function getSemanticIndexRepository() {}
55
56
  };
@@ -74,10 +74,10 @@ export interface SearchUtil {
74
74
  * out.print("&lt;a href=\"" + hit.getField('uri') + "\" title=\"\"&gt;");
75
75
  * out.print(hit.getField('title'));
76
76
  * out.print("&lt;/a&gt;");
77
- * out.println("&lt;br/&gt;");
77
+ * out.println("&lt;br&gt;");
78
78
  * }
79
79
  * } else {
80
- * out.println("No hits for query = '" + result.getQuery() + "'&lt;br/&gt;");
80
+ * out.println("No hits for query = '" + result.getQuery() + "'&lt;br&gt;");
81
81
  * }
82
82
  * </code></pre>
83
83
  *
@@ -225,7 +225,7 @@ export interface WebContentUtil {
225
225
  *
226
226
  * <p>
227
227
  * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified using the
228
- * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the page and values containing the
228
+ * content map containing keys corresponding to layout names (e.g. "Huvudinnehåll") on the page and values containing the
229
229
  * HTML used to generate a portlet structure in the layout. The provided content is converted to
230
230
  * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
231
231
  * layout should be created.
@@ -349,7 +349,7 @@ export interface WebContentUtil {
349
349
  *
350
350
  * <p>
351
351
  * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified using the
352
- * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the page and values containing the
352
+ * content map containing keys corresponding to layout names (e.g. "Huvudinnehåll") on the page and values containing the
353
353
  * HTML used to generate a portlet structure in the layout. The provided content is converted to
354
354
  * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
355
355
  * layout should be created.
@@ -494,7 +494,7 @@ export interface WebContentUtil {
494
494
  * <em>This method is typically called to clear all content before adding new content via {@link #updateContent(Node, Map)}</em>
495
495
  * </p>
496
496
  * @param aPageNode the node that will be altered, typically a node with primary node type sv:page or sv:article.&#xA; May not be null and may not be the site page
497
- * @param aRootLayoutName the name of the root layout of aPageNode to remove content from (e.g. "Mittenspalt")
497
+ * @param aRootLayoutName the name of the root layout of aPageNode to remove content from (e.g. "Huvudinnehåll")
498
498
  * @throws NullPointerException if aPageNode or aRootLayoutName is null
499
499
  * @throws IllegalArgumentException if aPageNode is of invalid type or if there are no root layout named aRootLayoutName
500
500
  * @throws ConstraintViolationException if current user is not allowed to alter aPageNode
@@ -1377,35 +1377,49 @@ export type NodeTypeUtilConstants = {
1377
1377
  /**
1378
1378
  * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SINGLE_TARGET_AUDIENCE_DEFINITION_TYPE}.
1379
1379
  * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SINGLE_TARGET_AUDIENCE_DEFINITION_TYPE}
1380
- * @since SiteVision 2024.09.2
1380
+ * @since Sitevision 2024.09.2
1381
1381
  */
1382
1382
  getMETADATA_SINGLE_TARGET_AUDIENCE_DEFINITION_TYPE(): string;
1383
1383
 
1384
1384
  /**
1385
1385
  * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE}.
1386
1386
  * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE}
1387
- * @since SiteVision 2024.09.2
1387
+ * @since Sitevision 2024.09.2
1388
1388
  */
1389
1389
  getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE(): string;
1390
1390
 
1391
1391
  /**
1392
1392
  * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#GEOLOCATION_TYPE}.
1393
1393
  * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#GEOLOCATION_TYPE}
1394
- * @since SiteVision 2024.10.1
1394
+ * @since Sitevision 2024.10.1
1395
1395
  */
1396
1396
  getGEOLOCATION_TYPE(): string;
1397
1397
 
1398
1398
  /**
1399
1399
  * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_GEOLOCATION_DEFINITION_TYPE}.
1400
1400
  * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_GEOLOCATION_DEFINITION_TYPE}
1401
- * @since SiteVision 2024.10.1
1401
+ * @since Sitevision 2024.10.1
1402
1402
  */
1403
1403
  getMETADATA_GEOLOCATION_DEFINITION_TYPE(): string;
1404
1404
 
1405
1405
  /**
1406
1406
  * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_MODULE_DEFINITION_TYPE}.
1407
1407
  * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_MODULE_DEFINITION_TYPE}
1408
- * @since SiteVision 2025.01.1
1408
+ * @since Sitevision 2025.01.1
1409
1409
  */
1410
1410
  getMETADATA_MODULE_DEFINITION_TYPE(): string;
1411
+
1412
+ /**
1413
+ * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#SEMANTIC_INDEX_TYPE}.
1414
+ * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#SEMANTIC_INDEX_TYPE}
1415
+ * @since Sitevision 2025.03.1
1416
+ */
1417
+ getSEMANTIC_INDEX_TYPE(): string;
1418
+
1419
+ /**
1420
+ * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#SEMANTIC_INDEX_REPOSITORY_TYPE}.
1421
+ * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#SEMANTIC_INDEX_REPOSITORY_TYPE}
1422
+ * @since Sitevision 2025.03.1
1423
+ */
1424
+ getSEMANTIC_INDEX_REPOSITORY_TYPE(): string;
1411
1425
  };
@@ -208,5 +208,7 @@ var _default = exports["default"] = {
208
208
  getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE: function getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE() {},
209
209
  getGEOLOCATION_TYPE: function getGEOLOCATION_TYPE() {},
210
210
  getMETADATA_GEOLOCATION_DEFINITION_TYPE: function getMETADATA_GEOLOCATION_DEFINITION_TYPE() {},
211
- getMETADATA_MODULE_DEFINITION_TYPE: function getMETADATA_MODULE_DEFINITION_TYPE() {}
211
+ getMETADATA_MODULE_DEFINITION_TYPE: function getMETADATA_MODULE_DEFINITION_TYPE() {},
212
+ getSEMANTIC_INDEX_TYPE: function getSEMANTIC_INDEX_TYPE() {},
213
+ getSEMANTIC_INDEX_REPOSITORY_TYPE: function getSEMANTIC_INDEX_REPOSITORY_TYPE() {}
212
214
  };