@sitevision/api 1.0.20 → 1.1.0-alpha.2
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/hidden/javax/jcr/Binary/index.d.ts +86 -0
- package/hidden/javax/jcr/Credentials/index.d.ts +11 -0
- package/hidden/javax/jcr/ImportUUIDBehavior/index.d.ts +11 -0
- package/hidden/javax/jcr/Item/index.d.ts +353 -0
- package/hidden/javax/jcr/ItemVisitor/index.d.ts +41 -0
- package/hidden/javax/jcr/NamespaceRegistry/index.d.ts +100 -0
- package/hidden/javax/jcr/Node/index.d.ts +2808 -0
- package/hidden/javax/jcr/NodeIterator/index.d.ts +18 -0
- package/hidden/javax/jcr/Property/index.d.ts +801 -0
- package/hidden/javax/jcr/PropertyIterator/index.d.ts +17 -0
- package/hidden/javax/jcr/RangeIterator/index.d.ts +75 -0
- package/hidden/javax/jcr/Repository/index.d.ts +318 -0
- package/hidden/javax/jcr/RepositoryFactory/index.d.ts +90 -0
- package/hidden/javax/jcr/Value/index.d.ts +190 -0
- package/hidden/javax/jcr/ValueFactory/index.d.ts +179 -0
- package/hidden/javax/jcr/Workspace/index.d.ts +1061 -0
- package/hidden/javax/jcr/lock/Lock/index.d.ts +142 -0
- package/hidden/javax/jcr/lock/LockManager/index.d.ts +217 -0
- package/hidden/javax/jcr/nodetype/ItemDefinition/index.d.ts +219 -0
- package/hidden/javax/jcr/nodetype/NodeDefinition/index.d.ts +158 -0
- package/hidden/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +74 -0
- package/hidden/javax/jcr/nodetype/NodeType/index.d.ts +349 -0
- package/hidden/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +248 -0
- package/hidden/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +16 -0
- package/hidden/javax/jcr/nodetype/NodeTypeManager/index.d.ts +218 -0
- package/hidden/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +98 -0
- package/hidden/javax/jcr/nodetype/PropertyDefinition/index.d.ts +536 -0
- package/hidden/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +97 -0
- package/hidden/javax/jcr/observation/Event/index.d.ts +133 -0
- package/hidden/javax/jcr/observation/EventIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/observation/EventJournal/index.d.ts +22 -0
- package/hidden/javax/jcr/observation/EventListener/index.d.ts +23 -0
- package/hidden/javax/jcr/observation/EventListenerIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/observation/ObservationManager/index.d.ts +227 -0
- package/hidden/javax/jcr/query/Query/index.d.ts +201 -0
- package/hidden/javax/jcr/query/QueryManager/index.d.ts +73 -0
- package/hidden/javax/jcr/query/QueryResult/index.d.ts +51 -0
- package/hidden/javax/jcr/query/Row/index.d.ts +159 -0
- package/hidden/javax/jcr/query/RowIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/query/qom/And/index.d.ts +26 -0
- package/hidden/javax/jcr/query/qom/BindVariableValue/index.d.ts +15 -0
- package/hidden/javax/jcr/query/qom/ChildNode/index.d.ts +27 -0
- package/hidden/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +27 -0
- package/hidden/javax/jcr/query/qom/Column/index.d.ts +39 -0
- package/hidden/javax/jcr/query/qom/Comparison/index.d.ts +82 -0
- package/hidden/javax/jcr/query/qom/Constraint/index.d.ts +13 -0
- package/hidden/javax/jcr/query/qom/DescendantNode/index.d.ts +31 -0
- package/hidden/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +29 -0
- package/hidden/javax/jcr/query/qom/DynamicOperand/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +41 -0
- package/hidden/javax/jcr/query/qom/FullTextSearch/index.d.ts +89 -0
- package/hidden/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +24 -0
- package/hidden/javax/jcr/query/qom/Join/index.d.ts +36 -0
- package/hidden/javax/jcr/query/qom/JoinCondition/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/Length/index.d.ts +24 -0
- package/hidden/javax/jcr/query/qom/Literal/index.d.ts +18 -0
- package/hidden/javax/jcr/query/qom/LowerCase/index.d.ts +26 -0
- package/hidden/javax/jcr/query/qom/NodeLocalName/index.d.ts +16 -0
- package/hidden/javax/jcr/query/qom/NodeName/index.d.ts +16 -0
- package/hidden/javax/jcr/query/qom/Not/index.d.ts +20 -0
- package/hidden/javax/jcr/query/qom/Operand/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/Or/index.d.ts +30 -0
- package/hidden/javax/jcr/query/qom/Ordering/index.d.ts +53 -0
- package/hidden/javax/jcr/query/qom/PropertyExistence/index.d.ts +24 -0
- package/hidden/javax/jcr/query/qom/PropertyValue/index.d.ts +25 -0
- package/hidden/javax/jcr/query/qom/QueryObjectModel/index.d.ts +64 -0
- package/hidden/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +638 -0
- package/hidden/javax/jcr/query/qom/SameNode/index.d.ts +27 -0
- package/hidden/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +36 -0
- package/hidden/javax/jcr/query/qom/Selector/index.d.ts +35 -0
- package/hidden/javax/jcr/query/qom/Source/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/StaticOperand/index.d.ts +10 -0
- package/hidden/javax/jcr/query/qom/UpperCase/index.d.ts +26 -0
- package/hidden/javax/jcr/retention/Hold/index.d.ts +34 -0
- package/hidden/javax/jcr/retention/RetentionManager/index.d.ts +189 -0
- package/hidden/javax/jcr/retention/RetentionPolicy/index.d.ts +21 -0
- package/hidden/javax/jcr/security/AccessControlEntry/index.d.ts +24 -0
- package/hidden/javax/jcr/security/AccessControlList/index.d.ts +91 -0
- package/hidden/javax/jcr/security/AccessControlManager/index.d.ts +297 -0
- package/hidden/javax/jcr/security/AccessControlPolicy/index.d.ts +11 -0
- package/hidden/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +22 -0
- package/hidden/javax/jcr/security/Privilege/index.d.ts +117 -0
- package/hidden/javax/jcr/version/Version/index.d.ts +121 -0
- package/hidden/javax/jcr/version/VersionHistory/index.d.ts +307 -0
- package/hidden/javax/jcr/version/VersionIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/version/VersionManager/index.d.ts +1082 -0
- package/hidden/senselogic/sitevision/api/base/Builder/index.d.ts +102 -0
- package/hidden/senselogic/sitevision/api/base/Filter/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/base/FilterSplit/index.d.ts +50 -0
- package/hidden/senselogic/sitevision/api/base/Loadable/index.d.ts +15 -0
- package/hidden/senselogic/sitevision/api/base/Resolver/index.d.ts +31 -0
- package/hidden/senselogic/sitevision/api/base/Wrapper/index.d.ts +24 -0
- package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +417 -0
- package/hidden/senselogic/sitevision/api/format/NumericFormatter/index.d.ts +80 -0
- package/hidden/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +100 -0
- package/hidden/senselogic/sitevision/api/i18n/Currency/index.d.ts +120 -0
- package/hidden/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +45 -0
- package/hidden/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts +65 -0
- package/hidden/senselogic/sitevision/api/mail/Mail/index.d.ts +32 -0
- package/hidden/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts +15 -0
- package/hidden/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts +23 -0
- package/hidden/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts +23 -0
- package/hidden/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts +642 -0
- package/hidden/senselogic/sitevision/api/render/BuddyIconRenderer/BuddyIconInfo/index.d.ts +51 -0
- package/hidden/senselogic/sitevision/api/render/ImageScaler/index.d.ts +58 -0
- package/hidden/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts +301 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/ArticleUtilConstants/index.d.ts +85 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/ExceptionSuppressingProxyConstants/index.d.ts +31 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/IndexingUtilConstants/index.d.ts +31 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/LinkPageUtilConstants/index.d.ts +67 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/MathInstanceConstants/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/MimeTypeUtilConstants/index.d.ts +19 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/NodeTypeUtilConstants/index.d.ts +1243 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/OutputUtilConstants/index.d.ts +31 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PageUtilConstants/index.d.ts +91 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PortletContextUtilConstants/index.d.ts +27 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PortletUtilConstants/index.d.ts +19 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/QueryStringUtilConstants/index.d.ts +19 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/SearchHitConstants/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/SearchResultConstants/index.d.ts +37 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/VersionUtilConstants/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts +8 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts +50 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts +89 -0
- package/hidden/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +119 -0
- package/hidden/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts +272 -0
- package/hidden/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts +43 -0
- package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts +94 -0
- package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts +117 -0
- package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +90 -0
- package/hidden/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts +89 -0
- package/hidden/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts +45 -0
- package/hidden/senselogic/sitevision/api/search/SearchHit/index.d.ts +1176 -0
- package/hidden/senselogic/sitevision/api/search/SearchResult/index.d.ts +414 -0
- package/hidden/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts +27 -0
- package/hidden/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts +61 -0
- package/hidden/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts +277 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts +29 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts +35 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts +29 -0
- package/hidden/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts +82 -0
- package/hidden/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts +21 -0
- package/hidden/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts +70 -0
- package/hidden/senselogic/sitevision/api/security/MessageDigester/index.d.ts +50 -0
- package/hidden/senselogic/sitevision/api/security/RoleAssignment/index.d.ts +72 -0
- package/hidden/senselogic/sitevision/api/security/RoleMatcher/index.d.ts +29 -0
- package/hidden/senselogic/sitevision/api/security/SecretStore/index.d.ts +55 -0
- package/hidden/senselogic/sitevision/api/security/UserUtil/index.d.ts +80 -0
- package/hidden/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +36 -0
- package/hidden/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts +32 -0
- package/hidden/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +599 -0
- package/hidden/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts +20 -0
- package/hidden/senselogic/sitevision/api/xml/XmlElement/index.d.ts +55 -0
- package/hidden/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts +17 -0
- package/index.d.ts +103 -4
- package/package.json +2 -4
- package/server/AliasUtil/index.d.ts +25 -0
- package/server/AliasUtil/index.js +10 -0
- package/server/ArchiveUtil/index.d.ts +65 -11
- package/server/ArraysInstance/index.d.ts +1846 -0
- package/server/ArticleUtil/index.d.ts +381 -69
- package/server/AuthenticationUtil/index.d.ts +106 -0
- package/server/BookmarkUtil/index.d.ts +36 -28
- package/server/BuddyIconRenderer/index.d.ts +240 -0
- package/server/ClientUtil/index.d.ts +18 -4
- package/server/CollaborationFactory/index.d.ts +42 -25
- package/server/CollaborationGroupFolderUtil/index.d.ts +40 -29
- package/server/CollaborationGroupTemplateUtil/index.d.ts +71 -39
- package/server/CollaborationGroupUtil/index.d.ts +128 -55
- package/server/CollectionsInstance/index.d.ts +738 -0
- package/server/ColorUtil/index.d.ts +22 -17
- package/server/CompoundAndFilterBuilder/index.d.ts +60 -0
- package/server/CompoundComparatorBuilder/index.d.ts +63 -0
- package/server/CompoundOrFilterBuilder/index.d.ts +59 -0
- package/server/ContentNodeUtil/index.d.ts +76 -0
- package/server/CurrencyFactory/index.d.ts +135 -0
- package/server/DateUtil/index.d.ts +154 -77
- package/server/DecorationUtil/index.d.ts +23 -0
- package/server/DeviceUtil/index.d.ts +36 -0
- package/server/DirectoryUtil/index.d.ts +107 -47
- package/server/DocTypeUtil/index.d.ts +149 -0
- package/server/EndecUtil/index.d.ts +537 -91
- package/server/ExtendedDismaxParserBuilder/index.d.ts +311 -0
- package/server/FileIconRenderer/index.d.ts +346 -0
- package/server/FileUtil/index.d.ts +462 -0
- package/server/FilterBuilder/index.d.ts +120 -0
- package/server/FolderUtil/index.d.ts +161 -0
- package/server/FontUtil/index.d.ts +49 -0
- package/server/FormatterBuilderFactory/index.d.ts +129 -0
- package/server/HighlightBuilder/index.d.ts +194 -0
- package/server/IconUtil/index.d.ts +37 -0
- package/server/ImageLinkRenderer/index.d.ts +134 -0
- package/server/ImageRenderer/index.d.ts +613 -231
- package/server/ImageUtil/index.d.ts +430 -0
- package/server/IndexUtil/index.d.ts +71 -0
- package/server/IndexingUtil/index.d.ts +92 -0
- package/server/InstanceCreatorUtil/index.d.ts +661 -0
- package/server/InstanceTypeUtil/index.d.ts +202 -0
- package/server/JwtUtil/index.d.ts +217 -0
- package/server/LandingPageUtil/index.d.ts +67 -50
- package/server/LinkPageUtil/index.d.ts +468 -0
- package/server/LinkRenderer/index.d.ts +1157 -0
- package/server/LinkTargetBuilder/index.d.ts +146 -0
- package/server/LinkValueBuilder/index.d.ts +129 -52
- package/server/ListWrapper/index.d.ts +172 -0
- package/server/LocaleUtil/index.d.ts +695 -61
- package/server/LogUtil/index.d.ts +118 -77
- package/server/MailBuilder/index.d.ts +238 -0
- package/server/MailUtil/index.d.ts +98 -0
- package/server/MathInstance/index.d.ts +681 -0
- package/server/MessageDigesterFactory/index.d.ts +49 -0
- package/server/MetadataDefinitionUtil/index.d.ts +118 -0
- package/server/MetadataUtil/index.d.ts +524 -79
- package/server/MimeTypeUtil/index.d.ts +316 -0
- package/server/MonitorBuilder/index.d.ts +51 -0
- package/server/NodeComparatorUtil/index.d.ts +397 -0
- package/server/NodeFactoryUtil/index.d.ts +32 -0
- package/server/NodeFilterUtil/index.d.ts +924 -0
- package/server/NodeIteratorUtil/index.d.ts +322 -72
- package/server/NodeResolverUtil/index.d.ts +767 -0
- package/server/NodeTreeUtil/index.d.ts +339 -63
- package/server/NodeTypeUtil/index.d.ts +391 -197
- package/server/OfflineVersionPropertyUtil/index.d.ts +30 -0
- package/server/OnlineVersionPropertyUtil/index.d.ts +30 -0
- package/server/OutputUtil/index.d.ts +641 -0
- package/server/PageUtil/index.d.ts +330 -0
- package/server/PermissionUtil/index.d.ts +650 -0
- package/server/PortletContextUtil/index.d.ts +118 -37
- package/server/PortletContextUtil/index.js +1 -0
- package/server/PortletUtil/index.d.ts +40 -0
- package/server/PrincipalUtil/index.d.ts +51 -0
- package/server/Properties/index.d.ts +185 -38
- package/server/PropertyUtil/index.d.ts +2330 -406
- package/server/PublishingUtil/index.d.ts +385 -49
- package/server/QueryStringUtil/index.d.ts +737 -0
- package/server/RedirectUtil/index.d.ts +98 -0
- package/server/RelatedValueBuilder/index.d.ts +81 -39
- package/server/Requester/index.d.ts +441 -65
- package/server/ResourceLocatorUtil/index.d.ts +483 -227
- package/server/RestApi/index.d.ts +208 -23
- package/server/RestAppInvokerFactory/index.d.ts +73 -0
- package/server/RoleAssignmentBuilder/index.d.ts +60 -0
- package/server/RoleMatcherBuilder/index.d.ts +59 -0
- package/server/RoleUtil/index.d.ts +57 -0
- package/server/ScriptUtil/index.d.ts +625 -143
- package/server/SearchFactory/index.d.ts +133 -0
- package/server/SearchUtil/index.d.ts +164 -0
- package/server/SearcherBuilder/index.d.ts +260 -0
- package/server/Session/index.d.ts +1758 -0
- package/server/SimpleUserUtil/index.d.ts +39 -30
- package/server/SiteCookieUtil/index.d.ts +78 -53
- package/server/SortBuilder/index.d.ts +111 -0
- package/server/SpellCheckBuilder/index.d.ts +68 -0
- package/server/StandardParserBuilder/index.d.ts +112 -0
- package/server/StructureUtil/index.d.ts +167 -0
- package/server/SubscriberUtil/index.d.ts +122 -0
- package/server/SubscriptionUtil/index.d.ts +197 -0
- package/server/SystemUserUtil/index.d.ts +201 -98
- package/server/TagUtil/index.d.ts +193 -0
- package/server/TemplateUtil/index.d.ts +217 -0
- package/server/TemporaryFileNodeBuilder/index.d.ts +63 -0
- package/server/TemporaryNodeBuilder/index.d.ts +241 -0
- package/server/TextModuleRendererBuilder/index.d.ts +68 -0
- package/server/TimestampUtil/index.d.ts +98 -82
- package/server/TranslationUtil/index.d.ts +175 -0
- package/server/TrashcanUtil/index.d.ts +193 -24
- package/server/UserDataUtil/index.d.ts +167 -85
- package/server/UserFactory/index.d.ts +45 -30
- package/server/UserFieldRenderer/index.d.ts +258 -0
- package/server/UserIdentityUtil/index.d.ts +61 -29
- package/server/UserUtil/index.d.ts +69 -28
- package/server/Utils/index.d.ts +870 -12
- package/server/VelocityRenderer/index.d.ts +248 -0
- package/server/VersionUtil/index.d.ts +15 -12
- package/server/WebContentUtil/index.d.ts +644 -0
- package/server/WebResourceFactory/index.d.ts +66 -0
- package/server/XSLTUtil/index.d.ts +49 -10
- package/server/XmlParserUtil/index.d.ts +82 -81
- package/builtins/Binary/index.d.ts +0 -3
- package/builtins/Calendar/index.d.ts +0 -3
- package/builtins/Collection/index.d.ts +0 -3
- package/builtins/Date/index.d.ts +0 -3
- package/builtins/InputStream/index.d.ts +0 -3
- package/builtins/Instant/index.d.ts +0 -3
- package/builtins/List/index.d.ts +0 -3
- package/builtins/LocalDateTime/index.d.ts +0 -3
- package/builtins/Locale/index.d.ts +0 -3
- package/builtins/Node/index.d.ts +0 -3
- package/builtins/NodeIterator/index.d.ts +0 -27
- package/builtins/Property/index.d.ts +0 -3
- package/builtins/Serializable/index.d.ts +0 -3
- package/builtins/Set/index.d.ts +0 -3
- package/builtins/Throwable/index.d.ts +0 -3
- package/builtins/byte/index.d.ts +0 -3
- package/server/CollaborationGroupState/index.d.ts +0 -6
- package/server/CollaborationGroupState/index.js +0 -1
- package/server/CollaborationGroupType/index.d.ts +0 -7
- package/server/CollaborationGroupType/index.js +0 -1
- package/server/CollaborationGroupWrapper/index.d.ts +0 -136
- package/server/CollaborationGroupWrapper/index.js +0 -1
- package/server/DimensionMode/index.d.ts +0 -7
- package/server/DimensionMode/index.js +0 -1
|
@@ -1,66 +1,147 @@
|
|
|
1
|
-
import
|
|
2
|
-
import Node from '../../builtins/Node';
|
|
1
|
+
import Node from "../../hidden/javax/jcr/Node";
|
|
3
2
|
|
|
4
3
|
/**
|
|
5
|
-
* Gets current
|
|
6
|
-
* @
|
|
4
|
+
* Gets current page (i.e. the page node for the currently executing portlet).
|
|
5
|
+
* @return current page <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet or current portlet is not bound to any page)
|
|
7
6
|
*/
|
|
8
|
-
export function
|
|
7
|
+
export function getCurrentPage(): Node;
|
|
9
8
|
|
|
10
9
|
/**
|
|
11
|
-
* Gets current
|
|
12
|
-
* @
|
|
13
|
-
*/
|
|
14
|
-
export function
|
|
10
|
+
* Gets current portlet.
|
|
11
|
+
* @return current portlet as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet)
|
|
12
|
+
*/
|
|
13
|
+
export function getCurrentPortlet(): Node;
|
|
15
14
|
|
|
16
15
|
/**
|
|
17
|
-
* Gets current module element (module element draft or module element).
|
|
18
|
-
* @
|
|
19
|
-
|
|
16
|
+
* Gets current module element (module element draft or module element).
|
|
17
|
+
* @return current module element as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a module element)
|
|
18
|
+
* @since Sitevision 4.2
|
|
19
|
+
*/
|
|
20
20
|
export function getCurrentModuleElement(): Node;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* Gets current
|
|
24
|
-
* @
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Gets current portlet.
|
|
30
|
-
* @returns {Node} current portlet as Node, or null if indeterminable (i.e. this method is not called from within a portlet)
|
|
31
|
-
*/
|
|
32
|
-
export function getCurrentPortlet(): Node;
|
|
23
|
+
* Gets current Locale.
|
|
24
|
+
* @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable
|
|
25
|
+
* @see senselogic.sitevision.api.node.NodeResolverUtil#getLocaleResolver()
|
|
26
|
+
*/
|
|
27
|
+
export function getCurrentLocale(): unknown;
|
|
33
28
|
|
|
34
29
|
/**
|
|
35
|
-
* Gets current user.
|
|
36
|
-
* @
|
|
37
|
-
|
|
30
|
+
* Gets current user.
|
|
31
|
+
* @return current user <code>Node</code>, or <code>null</code> if indeterminable
|
|
32
|
+
* @since Sitevision 2.6
|
|
33
|
+
*/
|
|
38
34
|
export function getCurrentUser(): Node;
|
|
39
35
|
|
|
40
36
|
/**
|
|
41
|
-
* Gets current user identity.
|
|
42
|
-
* @
|
|
43
|
-
|
|
37
|
+
* Gets current user identity.
|
|
38
|
+
* @return current user identity <code>Node</code>, or <code>null</code> if indeterminable
|
|
39
|
+
* @since Sitevision 3.5
|
|
40
|
+
*/
|
|
44
41
|
export function getCurrentUserIdentity(): Node;
|
|
45
42
|
|
|
46
43
|
/**
|
|
47
|
-
* Gets
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
|
|
44
|
+
* Gets current decorated node (applicable during render of a sv:decorationTemplate).
|
|
45
|
+
*
|
|
46
|
+
* <p>
|
|
47
|
+
* This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
|
|
48
|
+
* In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
|
|
49
|
+
* </p>
|
|
50
|
+
* @return the decorated node or null if indeterminable (i.e. the caller is not a part of a decoration template that is being rendered right now)
|
|
51
|
+
* @since Sitevision 5.1
|
|
52
|
+
*/
|
|
53
|
+
export function getCurrentDecoratedNode(): Node;
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Gets current version.
|
|
57
|
+
* @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
|
|
58
|
+
* @since Sitevision 2.6
|
|
59
|
+
* @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion()}
|
|
60
|
+
*/
|
|
61
|
+
export function getCurrentVersion(): number;
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Gets a unique namespace for the specific portlet that is rendering.
|
|
65
|
+
*
|
|
66
|
+
* <p>
|
|
67
|
+
* The namespace is based on the prefix (aPrefix) and the current portlet's id.
|
|
68
|
+
* If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
|
|
69
|
+
* connect a <label> with an <input>. Example in Velocity:
|
|
70
|
+
* </p>
|
|
71
|
+
* <pre><code>
|
|
72
|
+
* #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
|
|
73
|
+
* ...
|
|
74
|
+
* #set ($ns = $portletContextUtil.getPortletNamespace('name'))
|
|
75
|
+
* <label for="$ns">Name: </label><input id="$ns" name="name" type="text" /></code></pre>
|
|
76
|
+
* The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>
|
|
77
|
+
* @param aPrefix the prefix for the namespace (ensure it only contains chars that are valid in an id value if you use it as such)
|
|
78
|
+
* @return a unique prefixed namespace for current portlet, or aPrefix if indeterminable
|
|
79
|
+
*/
|
|
51
80
|
export function getPortletNamespace(aPrefix: string): string;
|
|
52
81
|
|
|
53
|
-
|
|
82
|
+
/**
|
|
83
|
+
* Gets a unique nonce for this request.
|
|
84
|
+
*
|
|
85
|
+
* <p>
|
|
86
|
+
* The nonce should be used for all client-side inline javascript (e.g. <code><script nonce="..."> ... <script></code>).
|
|
87
|
+
* If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
|
|
88
|
+
* (i.e. typically when the CSP has no "unsafe-inline" specified).
|
|
89
|
+
* </p>
|
|
90
|
+
* @return A unique identifier for this request.
|
|
91
|
+
* @since Sitevision 2022.08.1
|
|
92
|
+
*/
|
|
93
|
+
export function getNonce(): string;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Portlet context utility interface.
|
|
97
|
+
*
|
|
98
|
+
* <p>
|
|
99
|
+
* Contains methods for retrieving information about present portlet execution context.
|
|
100
|
+
* </p>
|
|
101
|
+
*
|
|
102
|
+
* <p>
|
|
103
|
+
* An instance of the Sitevision class implementing this interface can be obtained via
|
|
104
|
+
* {@link senselogic.sitevision.api.Utils#getPortletContextUtil()}.
|
|
105
|
+
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
106
|
+
* </p>Gets current page (i.e. the page node for the currently executing portlet).Gets current portlet.Gets current module element (module element draft or module element).Gets current Locale.Gets current user.Gets current user identity.Gets current decorated node (applicable during render of a sv:decorationTemplate).
|
|
107
|
+
*
|
|
108
|
+
* <p>
|
|
109
|
+
* This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
|
|
110
|
+
* In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
|
|
111
|
+
* </p>Gets current version.Gets a unique namespace for the specific portlet that is rendering.
|
|
112
|
+
*
|
|
113
|
+
* <p>
|
|
114
|
+
* The namespace is based on the prefix (aPrefix) and the current portlet's id.
|
|
115
|
+
* If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
|
|
116
|
+
* connect a <label> with an <input>. Example in Velocity:
|
|
117
|
+
* </p>
|
|
118
|
+
* <pre><code>
|
|
119
|
+
* #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
|
|
120
|
+
* ...
|
|
121
|
+
* #set ($ns = $portletContextUtil.getPortletNamespace('name'))
|
|
122
|
+
* <label for="$ns">Name: </label><input id="$ns" name="name" type="text" /></code></pre>
|
|
123
|
+
* The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>Gets a unique nonce for this request.
|
|
124
|
+
*
|
|
125
|
+
* <p>
|
|
126
|
+
* The nonce should be used for all client-side inline javascript (e.g. <code><script nonce="..."> ... <script></code>).
|
|
127
|
+
* If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
|
|
128
|
+
* (i.e. typically when the CSP has no "unsafe-inline" specified).
|
|
129
|
+
* </p>The offline version (i.e. the version used when editing in the Sitevision editor) markerThe online version (i.e. the published version that visitors can access) marker
|
|
130
|
+
* @author Magnus Lövgren
|
|
131
|
+
*/
|
|
132
|
+
declare namespace PortletContextUtil {
|
|
54
133
|
export {
|
|
55
|
-
getCurrentDecoratedNode,
|
|
56
|
-
getCurrentLocale,
|
|
57
|
-
getCurrentModuleElement,
|
|
58
134
|
getCurrentPage,
|
|
59
135
|
getCurrentPortlet,
|
|
136
|
+
getCurrentModuleElement,
|
|
137
|
+
getCurrentLocale,
|
|
60
138
|
getCurrentUser,
|
|
61
139
|
getCurrentUserIdentity,
|
|
140
|
+
getCurrentDecoratedNode,
|
|
141
|
+
getCurrentVersion,
|
|
62
142
|
getPortletNamespace,
|
|
143
|
+
getNonce,
|
|
63
144
|
};
|
|
64
145
|
}
|
|
65
146
|
|
|
66
|
-
export default
|
|
147
|
+
export default PortletContextUtil;
|
|
@@ -12,6 +12,7 @@ var _default = {
|
|
|
12
12
|
getCurrentPortlet: function getCurrentPortlet() {},
|
|
13
13
|
getCurrentUser: function getCurrentUser() {},
|
|
14
14
|
getCurrentUserIdentity: function getCurrentUserIdentity() {},
|
|
15
|
+
getNonce: function getNonce() {},
|
|
15
16
|
getPortletNamespace: function getPortletNamespace() {}
|
|
16
17
|
};
|
|
17
18
|
exports["default"] = _default;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import Node from "../../hidden/javax/jcr/Node";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* <p>Extracts the user specific <code>PortletPreferences</code> for the specified portlet.
|
|
5
|
+
* This method is a complement to the accessor provided by <code>PortletRequest.getPreferences</code>
|
|
6
|
+
* which returns the <code>PortletPreferences</code> for the current user.</p>
|
|
7
|
+
*
|
|
8
|
+
* <p>Note that this method only returns the portlet preferences that are stored. Any
|
|
9
|
+
* local modifications that has not yet been stored will be ignored.</p>
|
|
10
|
+
* @param portlet The <code>Node</code> corresponding to a portlet
|
|
11
|
+
* @param user The <code>Node</code> corresponding to a user
|
|
12
|
+
* @param portletPreferencesType The preferences type <em>(for now, only {@link #PORTLET_PREFERENCES_TYPE_USER} is allowed)</em>
|
|
13
|
+
* @return <code>PortletPreferences</code> that is effective for the provided user for the specified portlet
|
|
14
|
+
*/
|
|
15
|
+
export function getPortletPreferences(
|
|
16
|
+
portlet: Node,
|
|
17
|
+
user: Node,
|
|
18
|
+
portletPreferencesType: number
|
|
19
|
+
): unknown;
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* <p>Portlet utility interface.</p>
|
|
23
|
+
*
|
|
24
|
+
* <p>
|
|
25
|
+
* An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPortletUtil()}.
|
|
26
|
+
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
27
|
+
* </p><p>Extracts the user specific <code>PortletPreferences</code> for the specified portlet.
|
|
28
|
+
* This method is a complement to the accessor provided by <code>PortletRequest.getPreferences</code>
|
|
29
|
+
* which returns the <code>PortletPreferences</code> for the current user.</p>
|
|
30
|
+
*
|
|
31
|
+
* <p>Note that this method only returns the portlet preferences that are stored. Any
|
|
32
|
+
* local modifications that has not yet been stored will be ignored.</p>The personal portlet preferences type.
|
|
33
|
+
* @author Mikael Wikblom
|
|
34
|
+
* @since Sitevision 2.6_06
|
|
35
|
+
*/
|
|
36
|
+
declare namespace PortletUtil {
|
|
37
|
+
export { getPortletPreferences };
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export default PortletUtil;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import Node from "../../hidden/javax/jcr/Node";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Perform work during the login phase as a specified user.
|
|
5
|
+
*
|
|
6
|
+
* <p>
|
|
7
|
+
* <strong>Note!</strong> This method should <em>only</em> be used during the login phase (i.e. in a JAAS login module).
|
|
8
|
+
* Other usages will throw an <code>IllegalStateException</code>.
|
|
9
|
+
* </p>
|
|
10
|
+
* @param aUser the user
|
|
11
|
+
* @param aAction a runnable containing the operations that is to be performed
|
|
12
|
+
* @throws IllegalStateException if this method is not called during the login phase
|
|
13
|
+
*/
|
|
14
|
+
export function doAsDuringLogin(aUser: Node, aAction: unknown): void;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Provides access to a virtual group wrapped as a JCR node given the group name.
|
|
18
|
+
* @param aName the name of the virtual group, may not be null
|
|
19
|
+
* @return the virtual group wrapped in a JCR node, or null if none exists
|
|
20
|
+
* @since Sitevision 3.0
|
|
21
|
+
*/
|
|
22
|
+
export function getVirtualGroupByName(aName: string): Node;
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Provides access to virtual groups wrapped as a JCR node given the group name.
|
|
26
|
+
* @param aNames a list of names, may not be null
|
|
27
|
+
* @return a list of virtual groups wrapped in JCR nodes, or an empty list of none exists
|
|
28
|
+
* @since Sitevision 3.0
|
|
29
|
+
*/
|
|
30
|
+
export function getVirtualGroupsByName(aNames: unknown[]): unknown[];
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* <p>Principal utility interface.</p>
|
|
34
|
+
*
|
|
35
|
+
* <p>
|
|
36
|
+
* An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPrincipalUtil()}.
|
|
37
|
+
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
38
|
+
* </p>Perform work during the login phase as a specified user.
|
|
39
|
+
*
|
|
40
|
+
* <p>
|
|
41
|
+
* <strong>Note!</strong> This method should <em>only</em> be used during the login phase (i.e. in a JAAS login module).
|
|
42
|
+
* Other usages will throw an <code>IllegalStateException</code>.
|
|
43
|
+
* </p>Provides access to a virtual group wrapped as a JCR node given the group name.Provides access to virtual groups wrapped as a JCR node given the group name.
|
|
44
|
+
* @author Mikael Wikblom
|
|
45
|
+
* @since Sitevision 2.6.1_06
|
|
46
|
+
*/
|
|
47
|
+
declare namespace PrincipalUtil {
|
|
48
|
+
export { doAsDuringLogin, getVirtualGroupByName, getVirtualGroupsByName };
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export default PrincipalUtil;
|
|
@@ -1,51 +1,198 @@
|
|
|
1
|
-
import List from '../../builtins/List';
|
|
2
|
-
|
|
3
1
|
/**
|
|
4
|
-
* Gets named properties from a given Node-resolvable object.
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
|
|
2
|
+
* Gets named properties from a given Node-resolvable object.
|
|
3
|
+
*
|
|
4
|
+
* <p>
|
|
5
|
+
* <em>See code examples in the interface description above.</em>
|
|
6
|
+
* </p>
|
|
7
|
+
* @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
|
|
8
|
+
* @param aPropertyNames the names of the properties of interest
|
|
9
|
+
* @return the properties as a native Javascript object
|
|
10
|
+
* @throws Exception if the scripting engine fails to convert property values to a native Javascript object
|
|
11
|
+
* @see #getEscaped(Object, String...)
|
|
12
|
+
*/
|
|
9
13
|
export function get(
|
|
10
|
-
aJcrNodeResolvable:
|
|
11
|
-
|
|
12
|
-
):
|
|
14
|
+
aJcrNodeResolvable: unknown,
|
|
15
|
+
aPropertyNames: string
|
|
16
|
+
): unknown;
|
|
13
17
|
|
|
14
18
|
/**
|
|
15
|
-
* Gets escaped named properties from a given Node-resolvable object.
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* @
|
|
19
|
-
|
|
19
|
+
* Gets escaped named properties from a given Node-resolvable object.
|
|
20
|
+
*
|
|
21
|
+
* <p>
|
|
22
|
+
* This method is equivalent with {@link #get(Object, String...)} except that all string values will be escaped.
|
|
23
|
+
* </p>
|
|
24
|
+
* @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
|
|
25
|
+
* @param aPropertyNames the names of the properties of interest
|
|
26
|
+
* @return the escaped properties as a native Javascript object
|
|
27
|
+
* @throws Exception if the scripting engine fails to convert property values to a native Javascript object
|
|
28
|
+
* @since Sitevision 6.2
|
|
29
|
+
*/
|
|
20
30
|
export function getEscaped(
|
|
21
|
-
aJcrNodeResolvable:
|
|
22
|
-
|
|
23
|
-
):
|
|
31
|
+
aJcrNodeResolvable: unknown,
|
|
32
|
+
aPropertyNames: string
|
|
33
|
+
): unknown;
|
|
24
34
|
|
|
25
35
|
/**
|
|
26
|
-
* Processes an iterable object and returns an array of named properties for each Node-resolvable object that is iterated.
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
36
|
+
* Processes an iterable object and returns an array of named properties for each Node-resolvable object that is iterated.
|
|
37
|
+
*
|
|
38
|
+
* <p>
|
|
39
|
+
* This method is conceptually equivalent with the {@link #get(Object, String...) get} method but
|
|
40
|
+
* the core functionality of this method is to process something that can be iterated in order to handle <em>multiple</em> nodes
|
|
41
|
+
* and deliver properties for them as an array.
|
|
42
|
+
* </p>
|
|
43
|
+
*
|
|
44
|
+
* <p>
|
|
45
|
+
* <em>See code examples in the interface description above.</em>
|
|
46
|
+
* </p>
|
|
47
|
+
* @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
|
|
48
|
+
* @param aPropertyNames the names of the properties of interest
|
|
49
|
+
* @return a native Javascript array with properties
|
|
50
|
+
* @throws Exception if the scripting engine fails to convert property values to a native Javascript object
|
|
51
|
+
* @see senselogic.sitevision.api.node.NodeIteratorUtil
|
|
52
|
+
* @see #getArrayEscaped(Object, String...)
|
|
53
|
+
* @since Sitevision 6.1
|
|
54
|
+
*/
|
|
55
|
+
export function getArray(aIterable: unknown, aPropertyNames: string): unknown;
|
|
35
56
|
|
|
36
|
-
|
|
37
|
-
* Processes an iterable object and returns an array of escaped named properties for each Node-resolvable object that is iterated.
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* @
|
|
41
|
-
|
|
57
|
+
/**
|
|
58
|
+
* Processes an iterable object and returns an array of escaped named properties for each Node-resolvable object that is iterated.
|
|
59
|
+
*
|
|
60
|
+
* <p>
|
|
61
|
+
* This method is equivalent with {@link #getArray(Object, String...)} except that all string values will be escaped.
|
|
62
|
+
* </p>
|
|
63
|
+
* @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
|
|
64
|
+
* @param aPropertyNames the names of the properties of interest
|
|
65
|
+
* @return a native Javascript array with escaped properties
|
|
66
|
+
* @throws Exception if the scripting engine fails to convert property values to a native Javascript object
|
|
67
|
+
* @since Sitevision 6.2
|
|
68
|
+
*/
|
|
42
69
|
export function getArrayEscaped(
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
):
|
|
70
|
+
aIterable: unknown,
|
|
71
|
+
aPropertyNames: string
|
|
72
|
+
): unknown;
|
|
46
73
|
|
|
47
|
-
|
|
74
|
+
/**
|
|
75
|
+
* Utility interface for getting multiple Node property values in server-side Javascript.
|
|
76
|
+
*
|
|
77
|
+
* <p>
|
|
78
|
+
* Extraction of property values from Nodes are typically performed using {@link PropertyUtil}
|
|
79
|
+
* but this utility is less obtrusive to work with in server-side script contexts (WebApps, RESTApps, Script module etc.).
|
|
80
|
+
* </p>
|
|
81
|
+
* <p>
|
|
82
|
+
* <strong>Property value types</strong><br>
|
|
83
|
+
* The value of a JCR Node property can be resolved as different types.
|
|
84
|
+
* For instance a property with primary type {@link javax.jcr.PropertyType#DATE} can be resolved as {@code Calendar} or as {@code String}.
|
|
85
|
+
* This utility returns values with a specific type:
|
|
86
|
+
* </p>
|
|
87
|
+
* <ul>
|
|
88
|
+
* <li>The numerical <em>timestamp</em> will be returned as value for properties of type {@link javax.jcr.PropertyType#DATE}.</li>
|
|
89
|
+
* <li>The Node <em>identifier</em> will be returned as value for properties of type {@link javax.jcr.PropertyType#WEAKREFERENCE}.</li>
|
|
90
|
+
* </ul>
|
|
91
|
+
*
|
|
92
|
+
* <p>
|
|
93
|
+
* <strong>Example</strong><br>
|
|
94
|
+
* Below is an example that demonstrates the behaviour and usage of this utility.
|
|
95
|
+
* </p><pre> <strong>var</strong> properties = require('Properties');
|
|
96
|
+
* <em>...</em>
|
|
97
|
+
*
|
|
98
|
+
* <em><strong>// get examples</strong></em>
|
|
99
|
+
*
|
|
100
|
+
* <em>// Returns the identifier of the given Node, e.g: '4.540818ed12a6539aa3f80001645'</em>
|
|
101
|
+
* pageId = properties.get(pageNode);
|
|
102
|
+
*
|
|
103
|
+
* <em>// Returns the URI property value of the given Node, e.g. '/4.540818ed12a6539aa3f80001645.html'</em>
|
|
104
|
+
* pageUri = properties.get(pageNode, 'URI');
|
|
105
|
+
*
|
|
106
|
+
* <em>// Returns the displayName property value of the given Node, e.g. 'The page'</em>
|
|
107
|
+
* pageName = properties.get(pageNode, 'displayName');
|
|
108
|
+
* pageName = properties.get(pageId, 'displayName');
|
|
109
|
+
* pageName = properties.get(pageUri, 'displayName');
|
|
110
|
+
*
|
|
111
|
+
* <em>// Returns a native script object with given properties (that exist) of the specified Node e.g:
|
|
112
|
+
* // {
|
|
113
|
+
* // URI: '/4.540818ed12a6539aa3f80001645.html',
|
|
114
|
+
* // displayName: 'The page',
|
|
115
|
+
* // published: true,
|
|
116
|
+
* // publishDate: 1227618333142
|
|
117
|
+
* // }</em>
|
|
118
|
+
* pageData = properties.get(pageNode, 'URI', 'displayName', 'published', 'publishDate', 'nameOfNonExistingProperty');
|
|
119
|
+
*
|
|
120
|
+
* <em><strong>// getArray examples</strong></em>
|
|
121
|
+
*
|
|
122
|
+
* <em>// Returns the identifier of the given Node as array, e.g: ['4.540818ed12a6539aa3f80001645']</em>
|
|
123
|
+
* pageIdArray = properties.getArray(pageNode);
|
|
124
|
+
*
|
|
125
|
+
* <em>// Returns the identifier for the children of given Node as array, e.g:
|
|
126
|
+
* // [
|
|
127
|
+
* // '19.540818ed12a6539aa3f80006889',
|
|
128
|
+
* // '4.540818ed12a6539aa3f80001645_pageContent',
|
|
129
|
+
* // ...
|
|
130
|
+
* // ]</em>
|
|
131
|
+
* childIdsArray = properties.getArray(pageNode.getNodes());
|
|
132
|
+
*
|
|
133
|
+
* <em>// Returns the displayName for the nodes of a menu from a given Node as array, e.g:
|
|
134
|
+
* // [
|
|
135
|
+
* // 'The Page',
|
|
136
|
+
* // 'Another Page',
|
|
137
|
+
* // ...
|
|
138
|
+
* // ]</em>
|
|
139
|
+
* menuNamesArray = properties.getArray(nodeIteratorUtil.getMenuItems(pageNode), 'displayName');
|
|
140
|
+
*
|
|
141
|
+
* <em>// Returns the displayName and URI for the hits of a SearchResult as array, e.g:
|
|
142
|
+
* // [
|
|
143
|
+
* // {
|
|
144
|
+
* // displayName: 'Public API'
|
|
145
|
+
* // URI: '/docs/public-api',
|
|
146
|
+
* // },
|
|
147
|
+
* // {
|
|
148
|
+
* // displayName: 'REST API'
|
|
149
|
+
* // URI: '/docs/rest-api',
|
|
150
|
+
* // },
|
|
151
|
+
* // ...
|
|
152
|
+
* // ]</em>
|
|
153
|
+
* hitsDataArray = properties.getArray(searchResult, 'displayName', 'URI');</pre>
|
|
154
|
+
*
|
|
155
|
+
* <p>
|
|
156
|
+
* <strong>Security reminder! All output should always be escaped to prevent XSS!</strong>
|
|
157
|
+
* </p>
|
|
158
|
+
* <ul>
|
|
159
|
+
* <li>
|
|
160
|
+
* When implementing a WebApp, you would typically use {@link #get(Object, String...)} or {@link #getArray(Object, String...)}
|
|
161
|
+
* and output the value with underscore escape (e.g. <code><%- theValueToEscape %></code>).
|
|
162
|
+
* </li>
|
|
163
|
+
* <li>
|
|
164
|
+
* In other server-side scripting contexts (e.g. the Script module) you would typically use {@link #getEscaped(Object, String...)} or
|
|
165
|
+
* {@link #getArrayEscaped(Object, String...)} and output the (already) escaped value using Velocity (e.g. <code>$theEscapedValue</code>).
|
|
166
|
+
* </li>
|
|
167
|
+
* </ul>Gets named properties from a given Node-resolvable object.
|
|
168
|
+
*
|
|
169
|
+
* <p>
|
|
170
|
+
* <em>See code examples in the interface description above.</em>
|
|
171
|
+
* </p>Gets escaped named properties from a given Node-resolvable object.
|
|
172
|
+
*
|
|
173
|
+
* <p>
|
|
174
|
+
* This method is equivalent with {@link #get(Object, String...)} except that all string values will be escaped.
|
|
175
|
+
* </p>Processes an iterable object and returns an array of named properties for each Node-resolvable object that is iterated.
|
|
176
|
+
*
|
|
177
|
+
* <p>
|
|
178
|
+
* This method is conceptually equivalent with the {@link #get(Object, String...) get} method but
|
|
179
|
+
* the core functionality of this method is to process something that can be iterated in order to handle <em>multiple</em> nodes
|
|
180
|
+
* and deliver properties for them as an array.
|
|
181
|
+
* </p>
|
|
182
|
+
*
|
|
183
|
+
* <p>
|
|
184
|
+
* <em>See code examples in the interface description above.</em>
|
|
185
|
+
* </p>Processes an iterable object and returns an array of escaped named properties for each Node-resolvable object that is iterated.
|
|
186
|
+
*
|
|
187
|
+
* <p>
|
|
188
|
+
* This method is equivalent with {@link #getArray(Object, String...)} except that all string values will be escaped.
|
|
189
|
+
* </p>
|
|
190
|
+
* @param <T> native script value
|
|
191
|
+
* @author Magnus Lövgren
|
|
192
|
+
* @since Sitevision 4.5.2
|
|
193
|
+
*/
|
|
194
|
+
declare namespace Properties {
|
|
48
195
|
export { get, getEscaped, getArray, getArrayEscaped };
|
|
49
196
|
}
|
|
50
197
|
|
|
51
|
-
export default
|
|
198
|
+
export default Properties;
|