@sitevision/api 2025.2.1 → 2025.4.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/index.d.ts +1 -0
- package/package.json +2 -2
- package/server/ChannelUtil/index.d.ts +1 -1
- package/server/CollaborationGroupFolderUtil/index.d.ts +22 -0
- package/server/CollaborationGroupFolderUtil/index.js +2 -1
- package/server/DirectMessageUtil/index.d.ts +45 -0
- package/server/DirectMessageUtil/index.js +10 -0
- package/server/DocType/index.d.ts +10 -7
- package/server/DocTypeUtil/index.d.ts +66 -55
- package/server/MessagesFactory/index.d.ts +10 -2
- package/server/MessagesFactory/index.js +2 -1
- package/server/NodeTypeUtil/index.d.ts +12 -0
- package/server/PermissionUtil.Permission/index.d.ts +1 -0
- package/server/PermissionUtil.Permission/index.js +1 -0
- package/server/ResourceLocatorUtil/index.d.ts +7 -0
- package/server/ResourceLocatorUtil/index.js +2 -1
- package/server/SearchUtil/index.d.ts +2 -2
- package/server/Utils/index.d.ts +2 -2
- package/types/senselogic/sitevision/api/message/ChannelWrapper/index.d.ts +4 -4
- package/types/senselogic/sitevision/api/portlet/GenericConfigPortlet/index.d.ts +1 -0
- package/types/senselogic/sitevision/api/portlet/GenericSiteVisionPortlet/index.d.ts +1 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +19 -5
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +3 -1
package/index.d.ts
CHANGED
|
@@ -25,6 +25,7 @@ import './server/DateUtil';
|
|
|
25
25
|
import './server/DecorationUtil';
|
|
26
26
|
import './server/DeviceUtil';
|
|
27
27
|
import './server/DimensionMode';
|
|
28
|
+
import './server/DirectMessageUtil';
|
|
28
29
|
import './server/DirectoryUtil';
|
|
29
30
|
import './server/DocType';
|
|
30
31
|
import './server/DocTypeUtil';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sitevision/api",
|
|
3
|
-
"version": "2025.
|
|
3
|
+
"version": "2025.4.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": "
|
|
33
|
+
"gitHead": "685a5b71ce767337f6f5d8cf0ff10dadafda91d6"
|
|
34
34
|
}
|
|
@@ -11,7 +11,7 @@ import type { Node } from "../../types/javax/jcr/Node";
|
|
|
11
11
|
* See {@link MessagesFactory} for how to obtain an instance of the <code>MessagesFactory</code> interface.
|
|
12
12
|
* </p>
|
|
13
13
|
* @author Elias Abrache
|
|
14
|
-
* @since Sitevision 2024.05.
|
|
14
|
+
* @since Sitevision 2024.05.1
|
|
15
15
|
*/
|
|
16
16
|
export interface ChannelUtil {
|
|
17
17
|
/**
|
|
@@ -36,6 +36,28 @@ export interface CollaborationGroupFolderUtil {
|
|
|
36
36
|
aCollaborationGroupFolder: Node,
|
|
37
37
|
aGroupName: String | string
|
|
38
38
|
): boolean;
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Creates a collaboration group folder.
|
|
42
|
+
*
|
|
43
|
+
* <p>
|
|
44
|
+
* <em>Permission note!</em> Current user must have
|
|
45
|
+
* {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_COLLABORATION_GROUP_FOLDER}
|
|
46
|
+
* on the parent where the collaboration group folder is created.
|
|
47
|
+
* </p>
|
|
48
|
+
* @param aParent the parent node of the sv:collaborationGroupFolder. May not be null
|
|
49
|
+
* @param aGroupFolderName the name of the collaboration group folder. May not be null or whitespace-only
|
|
50
|
+
* @return The created collaboration group folder (sv:collaborationGroupFolder)
|
|
51
|
+
* @throws java.lang.NullPointerException if aParent or aGroupFolderName is null
|
|
52
|
+
* @throws java.lang.IllegalArgumentException if aGroupFolderName is whitespace only
|
|
53
|
+
* @throws ConstraintViolationException if social collaboration is not enabled on the site of aParent,
 if aParent is of invalid type, or if current user is not authorized to create the collaboration group folder
|
|
54
|
+
* @throws RepositoryException if something else goes wrong
|
|
55
|
+
* @since Sitevision 2025.04.1
|
|
56
|
+
*/
|
|
57
|
+
createCollaborationGroupFolder(
|
|
58
|
+
aParent: Node,
|
|
59
|
+
aGroupFolderName: String | string
|
|
60
|
+
): Node;
|
|
39
61
|
}
|
|
40
62
|
|
|
41
63
|
declare namespace CollaborationGroupFolderUtil {}
|
|
@@ -6,5 +6,6 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _default = exports["default"] = {
|
|
8
8
|
getDefaultCollaborationGroupFolder: function getDefaultCollaborationGroupFolder() {},
|
|
9
|
-
containsCollaborationGroup: function containsCollaborationGroup() {}
|
|
9
|
+
containsCollaborationGroup: function containsCollaborationGroup() {},
|
|
10
|
+
createCollaborationGroupFolder: function createCollaborationGroupFolder() {}
|
|
10
11
|
};
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import type { Collection } from "../../types/java/util/Collection";
|
|
2
|
+
import type { Node } from "../../types/javax/jcr/Node";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Direct Message utility interface.
|
|
6
|
+
*
|
|
7
|
+
* <p>
|
|
8
|
+
* An instance of the Sitevision class implementing this interface can be obtained via
|
|
9
|
+
* {@link MessagesFactory#getDirectMessageUtil()}.
|
|
10
|
+
* See {@link MessagesFactory} for how to obtain an instance of the <code>MessagesFactory</code> interface.
|
|
11
|
+
* </p>
|
|
12
|
+
* @author Elias Abrache
|
|
13
|
+
* @since Sitevision 2025.04.1
|
|
14
|
+
*/
|
|
15
|
+
export interface DirectMessageUtil {
|
|
16
|
+
/**
|
|
17
|
+
* Retrieves an existing direct message conversation for the current user identity
|
|
18
|
+
* that includes the specified members.
|
|
19
|
+
* The current user identity is always included in the conversation.
|
|
20
|
+
* @param aMembers array of sv:userIdentity nodes representing other participants
 in the conversation (including or excluding current user identity, who is always implicitly included as member anyway).
|
|
21
|
+
* @return a sv:directMessageConversation node representing the direct message conversation for the current user identity,
 or null if no matching conversation is found.
|
|
22
|
+
* @throws ConstraintViolationException if social collaboration is not enabled on the site.
|
|
23
|
+
* @throws IllegalStateException if current user doesn't have a user identity.
|
|
24
|
+
* @throws IllegalArgumentException if aMembers is null or empty. Or if any of the specified members is not
 a valid conversation participant.
|
|
25
|
+
*/
|
|
26
|
+
getConversation(aMembers: Collection | unknown[]): Node;
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Creates a new direct message conversation for the current user identity with the specified members.
|
|
30
|
+
* If an existing conversation with the same participants (including the current user identity) exists,
|
|
31
|
+
* it will be returned instead of creating a new one.
|
|
32
|
+
* @param aMembers array of sv:userIdentity nodes representing other participants
 in the conversation (including or excluding current user identity, who is always implicitly included as member anyway).
|
|
33
|
+
* @return a sv:directMessageConversation node representing the newly created or retrieved direct message conversation
 for the current user identity.
|
|
34
|
+
* @throws ConstraintViolationException if social collaboration is not enabled on the site or
 if the conversation could not be created.
|
|
35
|
+
* @throws IllegalStateException if current user doesn't have a user identity.
|
|
36
|
+
* @throws IllegalArgumentException if aMembers is null or empty. Or if any of the specified members is not
 a valid conversation participant.
|
|
37
|
+
*/
|
|
38
|
+
createConversation(aMembers: Collection | unknown[]): Node;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
declare namespace DirectMessageUtil {}
|
|
42
|
+
|
|
43
|
+
declare var directMessageUtil: DirectMessageUtil;
|
|
44
|
+
|
|
45
|
+
export default directMessageUtil;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports["default"] = void 0;
|
|
7
|
+
var _default = exports["default"] = {
|
|
8
|
+
getConversation: function getConversation() {},
|
|
9
|
+
createConversation: function createConversation() {}
|
|
10
|
+
};
|
|
@@ -1,19 +1,22 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Defines
|
|
2
|
+
* Defines html DOCTYPE's.
|
|
3
3
|
*
|
|
4
4
|
* <p>
|
|
5
|
+
* <strong>Note! Sitevision pages are always served as {@link #HTML5}!</strong>
|
|
6
|
+
* </p>
|
|
7
|
+
* <p>
|
|
5
8
|
* Example of how to get the {@link #HTML5} type:
|
|
6
9
|
* </p>
|
|
7
10
|
* <ul>
|
|
8
11
|
* <li>
|
|
9
|
-
* Using <strong>
|
|
10
|
-
*
|
|
11
|
-
* #set ($enumClassName = 'senselogic.sitevision.api.webresource.doctype.DocType')
|
|
12
|
-
* #set ($html5Enum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'HTML5'))</code></pre>
|
|
12
|
+
* Using server-side <strong>JavaScript:</strong><pre><code>
|
|
13
|
+
* const html5Enum = require('DocType.HTML5');</code></pre>
|
|
13
14
|
* </li>
|
|
14
15
|
* <li>
|
|
15
|
-
* Using
|
|
16
|
-
*
|
|
16
|
+
* Using <strong>Velocity:</strong><pre><code>
|
|
17
|
+
* #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
|
|
18
|
+
* #set ($enumClassName = 'senselogic.sitevision.api.webresource.doctype.DocType')
|
|
19
|
+
* #set ($html5Enum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'HTML5'))</code></pre>
|
|
17
20
|
* </li>
|
|
18
21
|
* </ul>
|
|
19
22
|
* @author Magnus Lövgren
|
|
@@ -2,135 +2,146 @@ import type { Node } from "../../types/javax/jcr/Node";
|
|
|
2
2
|
import type DocType from "../DocType";
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
* A
|
|
5
|
+
* A deprecated DOCTYPE utility interface.
|
|
6
6
|
*
|
|
7
7
|
* <p>
|
|
8
|
-
*
|
|
9
|
-
*
|
|
8
|
+
* <strong>NOTE! This interface is deprecated and should typically not be used!
|
|
9
|
+
* All methods have a fixed behaviour, i.e. always returns <code>true</code> or <code>false</code>
|
|
10
|
+
* since all Sitevision pages use HTML5.</strong>
|
|
11
|
+
* </p>
|
|
12
|
+
*
|
|
13
|
+
* <p>
|
|
14
|
+
* An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDocTypeUtil()}.
|
|
15
|
+
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
10
16
|
* </p>
|
|
11
17
|
* @author Magnus Lövgren
|
|
12
18
|
* @since Sitevision 3.0
|
|
19
|
+
* @deprecated This interface is deprecated due to obsolete functionality - pages are always HTML5.
 Last remaining legacy setting to use other type was removed in Sitevision 2025.04.1.
|
|
13
20
|
*/
|
|
14
21
|
export interface DocTypeUtil {
|
|
15
22
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* @
|
|
19
|
-
* @see DocType#HTML5
|
|
23
|
+
* This method always return true since all pages are always HTML5.
|
|
24
|
+
* <p style="text-decoration:line-through">Checks if the doctype for current page is HTML 4.01 Transitional or HTML5.</p>
|
|
25
|
+
* @return true
|
|
20
26
|
*/
|
|
21
27
|
isHtml(): boolean;
|
|
22
28
|
|
|
23
29
|
/**
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* @
|
|
27
|
-
* @
|
|
28
|
-
* @see DocType#HTML5
|
|
30
|
+
* This method always return true since all pages are always HTML5.
|
|
31
|
+
* <p style="text-decoration:line-through">Checks if the doctype for a certain page is HTML 4.01 Transitional or HTML5.</p>
|
|
32
|
+
* @param aPageNode this argument will be completely ignored
|
|
33
|
+
* @return true
|
|
29
34
|
*/
|
|
30
35
|
isHtml(aPageNode: Node): boolean;
|
|
31
36
|
|
|
32
37
|
/**
|
|
33
|
-
*
|
|
34
|
-
*
|
|
38
|
+
* This method always return false since all pages are always HTML5.
|
|
39
|
+
* <p style="text-decoration:line-through">Checks if the doctype for current page is HTML 4.01 Transitional.</p>
|
|
40
|
+
* @return false
|
|
35
41
|
* @see DocType#HTML4_TRANSITIONAL
|
|
36
42
|
*/
|
|
37
43
|
isHtml4(): boolean;
|
|
38
44
|
|
|
39
45
|
/**
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* @
|
|
43
|
-
* @
|
|
46
|
+
* This method always return false since all pages are always HTML5.
|
|
47
|
+
* <p style="text-decoration:line-through">Checks if the doctype for a certain page is HTML 4.01 Transitional.</p>
|
|
48
|
+
* @param aPageNode this argument will be completely ignored
|
|
49
|
+
* @return false
|
|
44
50
|
*/
|
|
45
51
|
isHtml4(aPageNode: Node): boolean;
|
|
46
52
|
|
|
47
53
|
/**
|
|
48
|
-
*
|
|
49
|
-
*
|
|
54
|
+
* This method always return true since all pages are always HTML5.
|
|
55
|
+
* <p style="text-decoration:line-through">Checks if the doctype for current page is HTML5.</p>
|
|
56
|
+
* @return true
|
|
50
57
|
* @see DocType#HTML5
|
|
51
58
|
*/
|
|
52
59
|
isHtml5(): boolean;
|
|
53
60
|
|
|
54
61
|
/**
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* @
|
|
58
|
-
* @
|
|
62
|
+
* This method always return true since all pages are always HTML5.
|
|
63
|
+
* <p style="text-decoration:line-through">Checks if the doctype for a certain page is HTML5.</p>
|
|
64
|
+
* @param aPageNode this argument will be completely ignored
|
|
65
|
+
* @return true
|
|
59
66
|
*/
|
|
60
67
|
isHtml5(aPageNode: Node): boolean;
|
|
61
68
|
|
|
62
69
|
/**
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* @
|
|
66
|
-
* @see DocType#XHTML1_STRICT
|
|
70
|
+
* This method always return false since all pages are always HTML5.
|
|
71
|
+
* <p style="text-decoration:line-through">Checks if the doctype for current page is XHTML 1.0 Transitional or XHTML 1.0 Strict.</p>
|
|
72
|
+
* @return false
|
|
67
73
|
*/
|
|
68
74
|
isXhtml(): boolean;
|
|
69
75
|
|
|
70
76
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* @
|
|
74
|
-
* @
|
|
75
|
-
* @see DocType#XHTML1_STRICT
|
|
77
|
+
* This method always return false since all pages are always HTML5.
|
|
78
|
+
* <p style="text-decoration:line-through">Checks if the doctype for a certain page is XHTML 1.0 Transitional or XHTML 1.0 Strict.</p>
|
|
79
|
+
* @param aPageNode this argument will be completely ignored
|
|
80
|
+
* @return false
|
|
76
81
|
*/
|
|
77
82
|
isXhtml(aPageNode: Node): boolean;
|
|
78
83
|
|
|
79
84
|
/**
|
|
80
|
-
*
|
|
81
|
-
*
|
|
85
|
+
* This method always return false since all pages are always HTML5.
|
|
86
|
+
* <p style="text-decoration:line-through">Checks if the doctype for current page is XHTML 1.0 Transitional.</p>
|
|
87
|
+
* @return false
|
|
82
88
|
* @see DocType#XHTML1_TRANSITIONAL
|
|
83
89
|
*/
|
|
84
90
|
isXhtmlTransitional(): boolean;
|
|
85
91
|
|
|
86
92
|
/**
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
* @
|
|
90
|
-
* @
|
|
93
|
+
* This method always return false since all pages are always HTML5.
|
|
94
|
+
* <p style="text-decoration:line-through">Checks if the doctype for a certain page is XHTML 1.0 Transitional.</p>
|
|
95
|
+
* @param aPageNode this argument will be completely ignored
|
|
96
|
+
* @return false
|
|
91
97
|
*/
|
|
92
98
|
isXhtmlTransitional(aPageNode: Node): boolean;
|
|
93
99
|
|
|
94
100
|
/**
|
|
95
|
-
*
|
|
96
|
-
*
|
|
101
|
+
* This method always return false since all pages are always HTML5.
|
|
102
|
+
* <p style="text-decoration:line-through">Checks if the doctype for current page is XHTML 1.0 Strict.</p>
|
|
103
|
+
* @return false
|
|
97
104
|
* @see DocType#XHTML1_STRICT
|
|
98
105
|
*/
|
|
99
106
|
isXhtmlStrict(): boolean;
|
|
100
107
|
|
|
101
108
|
/**
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
* @
|
|
105
|
-
* @
|
|
109
|
+
* This method always return false since all pages are always HTML5.
|
|
110
|
+
* <p style="text-decoration:line-through">Checks if the doctype for a certain page is XHTML 1.0 Strict.</p>
|
|
111
|
+
* @param aPageNode this argument will be completely ignored
|
|
112
|
+
* @return false
|
|
106
113
|
*/
|
|
107
114
|
isXhtmlStrict(aPageNode: Node): boolean;
|
|
108
115
|
|
|
109
116
|
/**
|
|
110
|
-
*
|
|
111
|
-
*
|
|
117
|
+
* This method always return {@link DocType#HTML5} since all pages are always HTML5.
|
|
118
|
+
* <p style="text-decoration:line-through">Gets the doctype for current page.</p>
|
|
119
|
+
* @return {@link DocType#HTML5}
|
|
112
120
|
*/
|
|
113
121
|
getDocType(): DocType;
|
|
114
122
|
|
|
115
123
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
* @
|
|
124
|
+
* This method always return {@link DocType#HTML5} since all pages are always HTML5.
|
|
125
|
+
* <p style="text-decoration:line-through">Gets the doctype for a certain page.</p>
|
|
126
|
+
* @param aPageNode this argument will be completely ignored
|
|
127
|
+
* @return {@link DocType#HTML5}
|
|
119
128
|
*/
|
|
120
129
|
getDocType(aPageNode: Node): DocType;
|
|
121
130
|
|
|
122
131
|
/**
|
|
123
|
-
*
|
|
132
|
+
* This method always return true if the aDocType argument is {@link DocType#HTML5}.
|
|
133
|
+
* <p style="text-decoration:line-through">Checks if the doctype for current page matches a certain DocType.</p>
|
|
124
134
|
* @param aDocType the doctype to check against
|
|
125
|
-
* @return
|
|
135
|
+
* @return true if aDocType is {@link DocType#HTML5}, false otherwise
|
|
126
136
|
*/
|
|
127
137
|
isDocType(aDocType: DocType): boolean;
|
|
128
138
|
|
|
129
139
|
/**
|
|
130
|
-
*
|
|
131
|
-
*
|
|
140
|
+
* This method always return true if the aDocType argument is {@link DocType#HTML5}.
|
|
141
|
+
* <p style="text-decoration:line-through">Checks if the doctype for a certain page matches a certain DocType.</p>
|
|
142
|
+
* @param aPageNode this argument will be completely ignored
|
|
132
143
|
* @param aDocType the doctype to check against
|
|
133
|
-
* @return
|
|
144
|
+
* @return true if aDocType is {@link DocType#HTML5}, false otherwise
|
|
134
145
|
*/
|
|
135
146
|
isDocType(aPageNode: Node, aDocType: DocType): boolean;
|
|
136
147
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { ChannelUtil } from "../ChannelUtil";
|
|
2
2
|
import type { Node } from "../../types/javax/jcr/Node";
|
|
3
3
|
import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/message/ChannelWrapper";
|
|
4
|
+
import type { DirectMessageUtil } from "../DirectMessageUtil";
|
|
4
5
|
|
|
5
6
|
/**
|
|
6
7
|
* Factory for creating messages-related instances.
|
|
@@ -11,13 +12,13 @@ import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/messa
|
|
|
11
12
|
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
12
13
|
* </p>
|
|
13
14
|
* @author Elias Abrache
|
|
14
|
-
* @since Sitevision 2024.03.
|
|
15
|
+
* @since Sitevision 2024.03.1
|
|
15
16
|
*/
|
|
16
17
|
export interface MessagesFactory {
|
|
17
18
|
/**
|
|
18
19
|
* Gets an instance of a channel utility class.
|
|
19
20
|
* @return a channel utility class
|
|
20
|
-
* @since Sitevision 2024.05.
|
|
21
|
+
* @since Sitevision 2024.05.1
|
|
21
22
|
*/
|
|
22
23
|
getChannelUtil(): ChannelUtil;
|
|
23
24
|
|
|
@@ -27,6 +28,13 @@ export interface MessagesFactory {
|
|
|
27
28
|
* @return a channel wrapper for <code>aChannel</code>, or <code>null</code> if <code>aChannel</code>
 isn't a channel, is archived, Social Collaboration isn't activated or operating user doesn't have a social user identity.
|
|
28
29
|
*/
|
|
29
30
|
getChannelWrapper(aChannel: Node): ChannelWrapper;
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Gets an instance of a direct message utility class.
|
|
34
|
+
* @return a direct message utility class
|
|
35
|
+
* @since Sitevision 2025.04.1
|
|
36
|
+
*/
|
|
37
|
+
getDirectMessageUtil(): DirectMessageUtil;
|
|
30
38
|
}
|
|
31
39
|
|
|
32
40
|
declare namespace MessagesFactory {}
|
|
@@ -6,5 +6,6 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _default = exports["default"] = {
|
|
8
8
|
getChannelUtil: function getChannelUtil() {},
|
|
9
|
-
getChannelWrapper: function getChannelWrapper() {}
|
|
9
|
+
getChannelWrapper: function getChannelWrapper() {},
|
|
10
|
+
getDirectMessageUtil: function getDirectMessageUtil() {}
|
|
10
11
|
};
|
|
@@ -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)
|
|
@@ -13,6 +13,7 @@ var _default = exports["default"] = {
|
|
|
13
13
|
DELETE: "DELETE",
|
|
14
14
|
CREATE_ARCHIVE: "CREATE_ARCHIVE",
|
|
15
15
|
CREATE_COLLABORATION_GROUP: "CREATE_COLLABORATION_GROUP",
|
|
16
|
+
CREATE_COLLABORATION_GROUP_FOLDER: "CREATE_COLLABORATION_GROUP_FOLDER",
|
|
16
17
|
CREATE_FOLDER: "CREATE_FOLDER",
|
|
17
18
|
CREATE_LAYOUT: "CREATE_LAYOUT",
|
|
18
19
|
CREATE_PAGE: "CREATE_PAGE",
|
|
@@ -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("<a href=\"" + hit.getField('uri') + "\" title=\"\">");
|
|
75
75
|
* out.print(hit.getField('title'));
|
|
76
76
|
* out.print("</a>");
|
|
77
|
-
* out.println("<br
|
|
77
|
+
* out.println("<br>");
|
|
78
78
|
* }
|
|
79
79
|
* } else {
|
|
80
|
-
* out.println("No hits for query = '" + result.getQuery() + "'<br
|
|
80
|
+
* out.println("No hits for query = '" + result.getQuery() + "'<br>");
|
|
81
81
|
* }
|
|
82
82
|
* </code></pre>
|
|
83
83
|
*
|
package/server/Utils/index.d.ts
CHANGED
|
@@ -499,8 +499,8 @@ export interface Utils {
|
|
|
499
499
|
getMimeTypeUtil(): MimeTypeUtil;
|
|
500
500
|
|
|
501
501
|
/**
|
|
502
|
-
* Gets an instance of a DOCTYPE utility class
|
|
503
|
-
* @return a DOCTYPE utility class
|
|
502
|
+
* Gets an instance of a deprecated DOCTYPE utility class
|
|
503
|
+
* @return a deprecated DOCTYPE utility class
|
|
504
504
|
* @since Sitevision 3.0
|
|
505
505
|
*/
|
|
506
506
|
getDocTypeUtil(): DocTypeUtil;
|
|
@@ -16,7 +16,7 @@ import type { Wrapper } from "../../base/Wrapper";
|
|
|
16
16
|
* See {@link MessagesFactory} for how to obtain an instance of the MessagesFactory interface.
|
|
17
17
|
* </p>
|
|
18
18
|
* @author Elias Abrache
|
|
19
|
-
* @since Sitevision 2024.03.
|
|
19
|
+
* @since Sitevision 2024.03.1
|
|
20
20
|
*/
|
|
21
21
|
export type ChannelWrapper = Wrapper & {
|
|
22
22
|
/**
|
|
@@ -95,7 +95,7 @@ export type ChannelWrapper = Wrapper & {
|
|
|
95
95
|
* Checks if a user identity is a member of the wrapped channel.
|
|
96
96
|
* @param aUserIdentity a user identity (or user)
|
|
97
97
|
* @return true if aUserIdentity is a member of the wrapped channel, false otherwise.
 false is always returned if aUserIdentity is null.
|
|
98
|
-
* @since Sitevision 2024.05.
|
|
98
|
+
* @since Sitevision 2024.05.1
|
|
99
99
|
*/
|
|
100
100
|
isMember(aUserIdentity: Node): boolean;
|
|
101
101
|
|
|
@@ -112,7 +112,7 @@ export type ChannelWrapper = Wrapper & {
|
|
|
112
112
|
* </p>
|
|
113
113
|
* @param aChannelName the new name of the channel
|
|
114
114
|
* @return true if channel could be renamed to aChannelName, false otherwise.
|
|
115
|
-
* @since Sitevision 2024.05.
|
|
115
|
+
* @since Sitevision 2024.05.1
|
|
116
116
|
*/
|
|
117
117
|
renameChannel(aChannelName: String | string): boolean;
|
|
118
118
|
|
|
@@ -125,7 +125,7 @@ export type ChannelWrapper = Wrapper & {
|
|
|
125
125
|
* </p>
|
|
126
126
|
* @param aChannelDescription the new description of the channel
|
|
127
127
|
* @return true if channel description was set to aChannelDescription, false otherwise.
|
|
128
|
-
* @since Sitevision 2024.05.
|
|
128
|
+
* @since Sitevision 2024.05.1
|
|
129
129
|
*/
|
|
130
130
|
setChannelDescription(aChannelDescription: String | string): boolean;
|
|
131
131
|
};
|
|
@@ -86,6 +86,7 @@ import type { String } from "../../../../../java/lang/String";
|
|
|
86
86
|
* </portlet-app></code></pre></div>
|
|
87
87
|
* @author Magnus Lövgren
|
|
88
88
|
* @since Sitevision 3.0
|
|
89
|
+
* @deprecated portlet applications are the legacy way of extending Sitevision. WebApp/RESTApp technique should be used instead as of Sitevision 5.
 This class will be removed in a future version of Sitevision.
|
|
89
90
|
*/
|
|
90
91
|
export type GenericConfigPortlet = GenericSiteVisionPortlet & {
|
|
91
92
|
/**
|
|
@@ -7,6 +7,7 @@ import type { PrintWriter } from "../../../../../java/io/PrintWriter";
|
|
|
7
7
|
* This class that can be extended when creating GenericPortlet-based portlets that needs easy access to the Sitevision API.
|
|
8
8
|
* @author Magnus Lövgren
|
|
9
9
|
* @since Sitevision 3.0
|
|
10
|
+
* @deprecated portlet applications are the legacy way of extending Sitevision. WebApp/RESTApp technique should be used instead as of Sitevision 5.
 This class will be removed in a future version of Sitevision.
|
|
10
11
|
*/
|
|
11
12
|
export type GenericSiteVisionPortlet = {
|
|
12
13
|
/**
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
};
|