@sitecore/sc-contenthub-webclient-sdk 0.9.7
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/LICENSE +24 -0
- package/dist/api/api-info-resource.d.ts +8 -0
- package/dist/api/api-info-resource.js +42 -0
- package/dist/api/api-info.d.ts +29 -0
- package/dist/api/api-info.js +14 -0
- package/dist/api/api-resource.d.ts +4 -0
- package/dist/api/api-resource.js +16 -0
- package/dist/api/api-routes-dictionary.d.ts +8 -0
- package/dist/api/api-routes-dictionary.js +10 -0
- package/dist/authentication/oauth-grant-base.d.ts +6 -0
- package/dist/authentication/oauth-grant-base.js +42 -0
- package/dist/authentication/oauth-grant-type.d.ts +4 -0
- package/dist/authentication/oauth-grant-type.js +8 -0
- package/dist/authentication/oauth-password-grant.d.ts +8 -0
- package/dist/authentication/oauth-password-grant.js +45 -0
- package/dist/authentication/oauth-refreshtoken-grant.d.ts +7 -0
- package/dist/authentication/oauth-refreshtoken-grant.js +39 -0
- package/dist/authentication/token-info.d.ts +6 -0
- package/dist/authentication/token-info.js +35 -0
- package/dist/base-types.d.ts +56 -0
- package/dist/base-types.js +32 -0
- package/dist/caches/culture-cache.d.ts +8 -0
- package/dist/caches/culture-cache.js +21 -0
- package/dist/caches/entity-definition-cache.d.ts +44 -0
- package/dist/caches/entity-definition-cache.js +96 -0
- package/dist/clients/api-client.d.ts +56 -0
- package/dist/clients/api-client.js +107 -0
- package/dist/clients/commands-client.d.ts +16 -0
- package/dist/clients/commands-client.js +40 -0
- package/dist/clients/content-hub-client.d.ts +75 -0
- package/dist/clients/content-hub-client.js +66 -0
- package/dist/clients/culture-client.d.ts +36 -0
- package/dist/clients/culture-client.js +43 -0
- package/dist/clients/culture-loader.d.ts +41 -0
- package/dist/clients/culture-loader.js +103 -0
- package/dist/clients/entities-client.d.ts +201 -0
- package/dist/clients/entities-client.js +271 -0
- package/dist/clients/entity-definitions-client.d.ts +87 -0
- package/dist/clients/entity-definitions-client.js +354 -0
- package/dist/clients/extended-client.d.ts +11 -0
- package/dist/clients/extended-client.js +2 -0
- package/dist/clients/internal-client.d.ts +46 -0
- package/dist/clients/internal-client.js +240 -0
- package/dist/clients/notifications-client.d.ts +35 -0
- package/dist/clients/notifications-client.js +128 -0
- package/dist/clients/option-list-client.d.ts +49 -0
- package/dist/clients/option-list-client.js +85 -0
- package/dist/clients/pages-client.d.ts +36 -0
- package/dist/clients/pages-client.js +52 -0
- package/dist/clients/policies-client.d.ts +47 -0
- package/dist/clients/policies-client.js +92 -0
- package/dist/clients/querying-client.d.ts +34 -0
- package/dist/clients/querying-client.js +95 -0
- package/dist/clients/raw-client.d.ts +29 -0
- package/dist/clients/raw-client.js +79 -0
- package/dist/clients/request-message.d.ts +25 -0
- package/dist/clients/request-message.js +12 -0
- package/dist/clients/response-handler.d.ts +30 -0
- package/dist/clients/response-handler.js +145 -0
- package/dist/clients/response-message.d.ts +45 -0
- package/dist/clients/response-message.js +34 -0
- package/dist/clients/schema-querying.d.ts +16 -0
- package/dist/clients/schema-querying.js +70 -0
- package/dist/clients/search-client.d.ts +16 -0
- package/dist/clients/search-client.js +36 -0
- package/dist/clients/settings-client.d.ts +37 -0
- package/dist/clients/settings-client.js +126 -0
- package/dist/clients/users-client.d.ts +150 -0
- package/dist/clients/users-client.js +317 -0
- package/dist/clients/web-content-hub-client.d.ts +13 -0
- package/dist/clients/web-content-hub-client.js +2 -0
- package/dist/constants/api.d.ts +130 -0
- package/dist/constants/api.js +133 -0
- package/dist/constants/defaults.d.ts +7 -0
- package/dist/constants/defaults.js +10 -0
- package/dist/constants/definitions.d.ts +62 -0
- package/dist/constants/definitions.js +88 -0
- package/dist/constants/index.d.ts +5 -0
- package/dist/constants/index.js +30 -0
- package/dist/constants/notifications.d.ts +7 -0
- package/dist/constants/notifications.js +10 -0
- package/dist/contracts/base/culture-insensitive-property.d.ts +28 -0
- package/dist/contracts/base/culture-insensitive-property.js +47 -0
- package/dist/contracts/base/culture-sensitive-property.d.ts +49 -0
- package/dist/contracts/base/culture-sensitive-property.js +113 -0
- package/dist/contracts/base/data-type.d.ts +18 -0
- package/dist/contracts/base/data-type.js +24 -0
- package/dist/contracts/base/entity-base.d.ts +65 -0
- package/dist/contracts/base/entity-base.js +362 -0
- package/dist/contracts/base/entity-construction-args.d.ts +15 -0
- package/dist/contracts/base/entity-construction-args.js +16 -0
- package/dist/contracts/base/entity-definition.d.ts +108 -0
- package/dist/contracts/base/entity-definition.js +126 -0
- package/dist/contracts/base/entity.d.ts +237 -0
- package/dist/contracts/base/entity.js +76 -0
- package/dist/contracts/base/index.d.ts +14 -0
- package/dist/contracts/base/index.js +26 -0
- package/dist/contracts/base/json-content-type.d.ts +9 -0
- package/dist/contracts/base/json-content-type.js +13 -0
- package/dist/contracts/base/lazy-loading-manager.d.ts +4 -0
- package/dist/contracts/base/lazy-loading-manager.js +17 -0
- package/dist/contracts/base/member-condition.d.ts +48 -0
- package/dist/contracts/base/member-condition.js +125 -0
- package/dist/contracts/base/member-definition-type.d.ts +13 -0
- package/dist/contracts/base/member-definition-type.js +17 -0
- package/dist/contracts/base/member-definition.d.ts +77 -0
- package/dist/contracts/base/member-definition.js +101 -0
- package/dist/contracts/base/member-group.d.ts +54 -0
- package/dist/contracts/base/member-group.js +61 -0
- package/dist/contracts/base/member.d.ts +32 -0
- package/dist/contracts/base/member.js +26 -0
- package/dist/contracts/base/option-lists/flat-option-list-value.d.ts +4 -0
- package/dist/contracts/base/option-lists/flat-option-list-value.js +9 -0
- package/dist/contracts/base/option-lists/flat-option-list.d.ts +9 -0
- package/dist/contracts/base/option-lists/flat-option-list.js +11 -0
- package/dist/contracts/base/option-lists/hierarchical-option-list.d.ts +9 -0
- package/dist/contracts/base/option-lists/hierarchical-option-list.js +11 -0
- package/dist/contracts/base/option-lists/hierarchical-options-list-value.d.ts +7 -0
- package/dist/contracts/base/option-lists/hierarchical-options-list-value.js +14 -0
- package/dist/contracts/base/option-lists/option-list-base.d.ts +23 -0
- package/dist/contracts/base/option-lists/option-list-base.js +33 -0
- package/dist/contracts/base/option-lists/option-list-type.d.ts +13 -0
- package/dist/contracts/base/option-lists/option-list-type.js +17 -0
- package/dist/contracts/base/option-lists/option-list-value-base.d.ts +7 -0
- package/dist/contracts/base/option-lists/option-list-value-base.js +14 -0
- package/dist/contracts/base/option-lists/option-list-value.d.ts +30 -0
- package/dist/contracts/base/option-lists/option-list-value.js +2 -0
- package/dist/contracts/base/option-lists/option-list.d.ts +40 -0
- package/dist/contracts/base/option-lists/option-list.js +2 -0
- package/dist/contracts/base/property-definition.d.ts +61 -0
- package/dist/contracts/base/property-definition.js +76 -0
- package/dist/contracts/base/property-definitions/boolean-property-definition.d.ts +7 -0
- package/dist/contracts/base/property-definitions/boolean-property-definition.js +33 -0
- package/dist/contracts/base/property-definitions/datetime-property-definition.d.ts +7 -0
- package/dist/contracts/base/property-definitions/datetime-property-definition.js +33 -0
- package/dist/contracts/base/property-definitions/datetimeoffset-property-definition.d.ts +7 -0
- package/dist/contracts/base/property-definitions/datetimeoffset-property-definition.js +33 -0
- package/dist/contracts/base/property-definitions/decimal-property-definition.d.ts +7 -0
- package/dist/contracts/base/property-definitions/decimal-property-definition.js +33 -0
- package/dist/contracts/base/property-definitions/index.d.ts +8 -0
- package/dist/contracts/base/property-definitions/index.js +20 -0
- package/dist/contracts/base/property-definitions/integer-property-definition.d.ts +7 -0
- package/dist/contracts/base/property-definitions/integer-property-definition.js +33 -0
- package/dist/contracts/base/property-definitions/json-property-definition.d.ts +10 -0
- package/dist/contracts/base/property-definitions/json-property-definition.js +38 -0
- package/dist/contracts/base/property-definitions/long-property-definition.d.ts +7 -0
- package/dist/contracts/base/property-definitions/long-property-definition.js +33 -0
- package/dist/contracts/base/property-definitions/string-property-definition.d.ts +33 -0
- package/dist/contracts/base/property-definitions/string-property-definition.js +55 -0
- package/dist/contracts/base/property-manager.d.ts +19 -0
- package/dist/contracts/base/property-manager.js +114 -0
- package/dist/contracts/base/property.d.ts +21 -0
- package/dist/contracts/base/property.js +30 -0
- package/dist/contracts/base/relation-cardinality.d.ts +19 -0
- package/dist/contracts/base/relation-cardinality.js +22 -0
- package/dist/contracts/base/relation-container.d.ts +40 -0
- package/dist/contracts/base/relation-container.js +118 -0
- package/dist/contracts/base/relation-definition.d.ts +123 -0
- package/dist/contracts/base/relation-definition.js +116 -0
- package/dist/contracts/base/relation-manager.d.ts +70 -0
- package/dist/contracts/base/relation-manager.js +197 -0
- package/dist/contracts/base/relation-role.d.ts +14 -0
- package/dist/contracts/base/relation-role.js +17 -0
- package/dist/contracts/base/relation.d.ts +74 -0
- package/dist/contracts/base/relation.js +40 -0
- package/dist/contracts/base/relations/child-to-many-parents-relation.d.ts +27 -0
- package/dist/contracts/base/relations/child-to-many-parents-relation.js +67 -0
- package/dist/contracts/base/relations/child-to-one-parent-relation.d.ts +26 -0
- package/dist/contracts/base/relations/child-to-one-parent-relation.js +74 -0
- package/dist/contracts/base/relations/parent-to-many-children-relation.d.ts +27 -0
- package/dist/contracts/base/relations/parent-to-many-children-relation.js +67 -0
- package/dist/contracts/base/relations/parent-to-one-child-relation.d.ts +29 -0
- package/dist/contracts/base/relations/parent-to-one-child-relation.js +74 -0
- package/dist/contracts/base/relations/to-many-relation.d.ts +16 -0
- package/dist/contracts/base/relations/to-many-relation.js +2 -0
- package/dist/contracts/base/relations/to-one-relation.d.ts +18 -0
- package/dist/contracts/base/relations/to-one-relation.js +2 -0
- package/dist/contracts/base/rendition.d.ts +14 -0
- package/dist/contracts/base/rendition.js +13 -0
- package/dist/contracts/base/resource.d.ts +21 -0
- package/dist/contracts/base/resource.js +2 -0
- package/dist/contracts/base/string-content-type.d.ts +21 -0
- package/dist/contracts/base/string-content-type.js +25 -0
- package/dist/contracts/base/typed-entity.d.ts +11 -0
- package/dist/contracts/base/typed-entity.js +2 -0
- package/dist/contracts/base/users.d.ts +0 -0
- package/dist/contracts/base/users.js +1 -0
- package/dist/contracts/base/view-mode.d.ts +4 -0
- package/dist/contracts/base/view-mode.js +8 -0
- package/dist/contracts/content/asset.d.ts +22 -0
- package/dist/contracts/content/asset.js +67 -0
- package/dist/contracts/content/final-life-cycle-status.d.ts +7 -0
- package/dist/contracts/content/final-life-cycle-status.js +11 -0
- package/dist/contracts/dirty-tracking/dirty-tracking.d.ts +10 -0
- package/dist/contracts/dirty-tracking/dirty-tracking.js +2 -0
- package/dist/contracts/notifications/mail-template.d.ts +44 -0
- package/dist/contracts/notifications/mail-template.js +2 -0
- package/dist/contracts/policies/condition.d.ts +16 -0
- package/dist/contracts/policies/condition.js +10 -0
- package/dist/contracts/policies/member-policy.d.ts +31 -0
- package/dist/contracts/policies/member-policy.js +12 -0
- package/dist/contracts/policies/policy.d.ts +19 -0
- package/dist/contracts/policies/policy.js +11 -0
- package/dist/contracts/policies/rule-type.d.ts +7 -0
- package/dist/contracts/policies/rule-type.js +11 -0
- package/dist/contracts/policies/rule.d.ts +58 -0
- package/dist/contracts/policies/rule.js +19 -0
- package/dist/contracts/policies/user-group-policy.d.ts +10 -0
- package/dist/contracts/policies/user-group-policy.js +17 -0
- package/dist/contracts/policies/user-policy.d.ts +10 -0
- package/dist/contracts/policies/user-policy.js +17 -0
- package/dist/contracts/querying/culture-load-option.d.ts +35 -0
- package/dist/contracts/querying/culture-load-option.js +69 -0
- package/dist/contracts/querying/entity-definition-id-iterator.d.ts +9 -0
- package/dist/contracts/querying/entity-definition-id-iterator.js +30 -0
- package/dist/contracts/querying/entity-definition-id-query-result.d.ts +10 -0
- package/dist/contracts/querying/entity-definition-id-query-result.js +22 -0
- package/dist/contracts/querying/entity-definition-iterator.d.ts +16 -0
- package/dist/contracts/querying/entity-definition-iterator.js +30 -0
- package/dist/contracts/querying/entity-definition-query-result.d.ts +21 -0
- package/dist/contracts/querying/entity-definition-query-result.js +22 -0
- package/dist/contracts/querying/entity-iterator.d.ts +13 -0
- package/dist/contracts/querying/entity-iterator.js +30 -0
- package/dist/contracts/querying/entity-load-configuration-builder.d.ts +76 -0
- package/dist/contracts/querying/entity-load-configuration-builder.js +101 -0
- package/dist/contracts/querying/entity-load-configuration.d.ts +51 -0
- package/dist/contracts/querying/entity-load-configuration.js +67 -0
- package/dist/contracts/querying/entity-load-option.d.ts +35 -0
- package/dist/contracts/querying/entity-load-option.js +94 -0
- package/dist/contracts/querying/entity-query-result.d.ts +23 -0
- package/dist/contracts/querying/entity-query-result.js +33 -0
- package/dist/contracts/querying/filters/comparison-operator.d.ts +11 -0
- package/dist/contracts/querying/filters/comparison-operator.js +15 -0
- package/dist/contracts/querying/filters/composite-filter-operator.d.ts +4 -0
- package/dist/contracts/querying/filters/composite-filter-operator.js +8 -0
- package/dist/contracts/querying/filters/composite-query-filter.d.ts +19 -0
- package/dist/contracts/querying/filters/composite-query-filter.js +49 -0
- package/dist/contracts/querying/filters/createdby-query-filter.d.ts +5 -0
- package/dist/contracts/querying/filters/createdby-query-filter.js +30 -0
- package/dist/contracts/querying/filters/createdon-query-filter.d.ts +19 -0
- package/dist/contracts/querying/filters/createdon-query-filter.js +45 -0
- package/dist/contracts/querying/filters/definition-query-filter.d.ts +34 -0
- package/dist/contracts/querying/filters/definition-query-filter.js +58 -0
- package/dist/contracts/querying/filters/filter-data-type.d.ts +11 -0
- package/dist/contracts/querying/filters/filter-data-type.js +15 -0
- package/dist/contracts/querying/filters/filter-type.d.ts +18 -0
- package/dist/contracts/querying/filters/filter-type.js +22 -0
- package/dist/contracts/querying/filters/id-query-filter.d.ts +25 -0
- package/dist/contracts/querying/filters/id-query-filter.js +49 -0
- package/dist/contracts/querying/filters/identifier-query-filter.d.ts +25 -0
- package/dist/contracts/querying/filters/identifier-query-filter.js +49 -0
- package/dist/contracts/querying/filters/index.d.ts +20 -0
- package/dist/contracts/querying/filters/index.js +32 -0
- package/dist/contracts/querying/filters/modifiedby-query-filter.d.ts +5 -0
- package/dist/contracts/querying/filters/modifiedby-query-filter.js +30 -0
- package/dist/contracts/querying/filters/modifiedon-query-filter.d.ts +19 -0
- package/dist/contracts/querying/filters/modifiedon-query-filter.js +45 -0
- package/dist/contracts/querying/filters/modules-query-filter.d.ts +14 -0
- package/dist/contracts/querying/filters/modules-query-filter.js +43 -0
- package/dist/contracts/querying/filters/not-query-filter.d.ts +14 -0
- package/dist/contracts/querying/filters/not-query-filter.js +39 -0
- package/dist/contracts/querying/filters/property-query-filter.d.ts +38 -0
- package/dist/contracts/querying/filters/property-query-filter.js +63 -0
- package/dist/contracts/querying/filters/query-filter.d.ts +10 -0
- package/dist/contracts/querying/filters/query-filter.js +28 -0
- package/dist/contracts/querying/filters/relation-connection-type.d.ts +15 -0
- package/dist/contracts/querying/filters/relation-connection-type.js +19 -0
- package/dist/contracts/querying/filters/relation-query-filter.d.ts +23 -0
- package/dist/contracts/querying/filters/relation-query-filter.js +48 -0
- package/dist/contracts/querying/filters/secured-ancestors-query-filter.d.ts +24 -0
- package/dist/contracts/querying/filters/secured-ancestors-query-filter.js +53 -0
- package/dist/contracts/querying/filters/user-query-filter.d.ts +37 -0
- package/dist/contracts/querying/filters/user-query-filter.js +61 -0
- package/dist/contracts/querying/id-iterator.d.ts +11 -0
- package/dist/contracts/querying/id-iterator.js +19 -0
- package/dist/contracts/querying/id-query-result.d.ts +17 -0
- package/dist/contracts/querying/id-query-result.js +24 -0
- package/dist/contracts/querying/iterator.d.ts +9 -0
- package/dist/contracts/querying/iterator.js +2 -0
- package/dist/contracts/querying/load-option.d.ts +4 -0
- package/dist/contracts/querying/load-option.js +2 -0
- package/dist/contracts/querying/load-options.d.ts +6 -0
- package/dist/contracts/querying/load-options.js +10 -0
- package/dist/contracts/querying/loading-query-iterator.d.ts +17 -0
- package/dist/contracts/querying/loading-query-iterator.js +57 -0
- package/dist/contracts/querying/member-load-option.d.ts +11 -0
- package/dist/contracts/querying/member-load-option.js +15 -0
- package/dist/contracts/querying/minimal-schema.d.ts +8 -0
- package/dist/contracts/querying/minimal-schema.js +48 -0
- package/dist/contracts/querying/property-data.d.ts +8 -0
- package/dist/contracts/querying/property-data.js +43 -0
- package/dist/contracts/querying/property-load-option.d.ts +30 -0
- package/dist/contracts/querying/property-load-option.js +70 -0
- package/dist/contracts/querying/query-iterator.d.ts +18 -0
- package/dist/contracts/querying/query-iterator.js +54 -0
- package/dist/contracts/querying/query-load-configuration.d.ts +39 -0
- package/dist/contracts/querying/query-load-configuration.js +86 -0
- package/dist/contracts/querying/query-request.d.ts +6 -0
- package/dist/contracts/querying/query-request.js +30 -0
- package/dist/contracts/querying/query-result-paging-manager.d.ts +9 -0
- package/dist/contracts/querying/query-result-paging-manager.js +22 -0
- package/dist/contracts/querying/query-result.d.ts +5 -0
- package/dist/contracts/querying/query-result.js +2 -0
- package/dist/contracts/querying/query-sort-order.d.ts +13 -0
- package/dist/contracts/querying/query-sort-order.js +17 -0
- package/dist/contracts/querying/query.d.ts +23 -0
- package/dist/contracts/querying/query.js +56 -0
- package/dist/contracts/querying/relation-data.d.ts +7 -0
- package/dist/contracts/querying/relation-data.js +38 -0
- package/dist/contracts/querying/relation-load-option.d.ts +31 -0
- package/dist/contracts/querying/relation-load-option.js +74 -0
- package/dist/contracts/querying/relation-specification.d.ts +33 -0
- package/dist/contracts/querying/relation-specification.js +52 -0
- package/dist/contracts/querying/schema-querying.d.ts +20 -0
- package/dist/contracts/querying/schema-querying.js +2 -0
- package/dist/contracts/querying/scroll-request.d.ts +7 -0
- package/dist/contracts/querying/scroll-request.js +33 -0
- package/dist/contracts/querying/skip-take-iterator-base.d.ts +14 -0
- package/dist/contracts/querying/skip-take-iterator-base.js +60 -0
- package/dist/contracts/querying/sort-field-type.d.ts +13 -0
- package/dist/contracts/querying/sort-field-type.js +17 -0
- package/dist/contracts/querying/sorting.d.ts +25 -0
- package/dist/contracts/querying/sorting.js +44 -0
- package/dist/contracts/users/user-group-combine-method.d.ts +4 -0
- package/dist/contracts/users/user-group-combine-method.js +8 -0
- package/dist/contracts/users/user-group-configuration.d.ts +11 -0
- package/dist/contracts/users/user-group-configuration.js +35 -0
- package/dist/contracts/users/user-profile.d.ts +4 -0
- package/dist/contracts/users/user-profile.js +2 -0
- package/dist/contracts/users/user.d.ts +24 -0
- package/dist/contracts/users/user.js +64 -0
- package/dist/converters/api-resource-converter.d.ts +16 -0
- package/dist/converters/api-resource-converter.js +45 -0
- package/dist/converters/file-version-converter.d.ts +22 -0
- package/dist/converters/file-version-converter.js +43 -0
- package/dist/converters/index.d.ts +6 -0
- package/dist/converters/index.js +18 -0
- package/dist/converters/member-condition-converter.d.ts +20 -0
- package/dist/converters/member-condition-converter.js +50 -0
- package/dist/converters/member-condition-resource-converter.d.ts +21 -0
- package/dist/converters/member-condition-resource-converter.js +53 -0
- package/dist/converters/minimal-schema-relation-cardinality-converter.d.ts +11 -0
- package/dist/converters/minimal-schema-relation-cardinality-converter.js +33 -0
- package/dist/converters/page-resource-menus-converter.d.ts +19 -0
- package/dist/converters/page-resource-menus-converter.js +45 -0
- package/dist/converters/page-resource-zones-converter.d.ts +19 -0
- package/dist/converters/page-resource-zones-converter.js +45 -0
- package/dist/converters/relation-map-resource-converter.d.ts +6 -0
- package/dist/converters/relation-map-resource-converter.js +38 -0
- package/dist/converters/relation-resource-converter.d.ts +22 -0
- package/dist/converters/relation-resource-converter.js +51 -0
- package/dist/converters/renditions-converter.d.ts +20 -0
- package/dist/converters/renditions-converter.js +44 -0
- package/dist/converters/string-to-any-map-converter.d.ts +20 -0
- package/dist/converters/string-to-any-map-converter.js +34 -0
- package/dist/culture-info.d.ts +5 -0
- package/dist/culture-info.js +7 -0
- package/dist/dirty-value-calculator.d.ts +7 -0
- package/dist/dirty-value-calculator.js +29 -0
- package/dist/entity-link.d.ts +8 -0
- package/dist/entity-link.js +40 -0
- package/dist/error-messages.d.ts +57 -0
- package/dist/error-messages.js +64 -0
- package/dist/errors/argument-error.d.ts +4 -0
- package/dist/errors/argument-error.js +11 -0
- package/dist/errors/authentication-error.d.ts +5 -0
- package/dist/errors/authentication-error.js +12 -0
- package/dist/errors/bad-request-error.d.ts +5 -0
- package/dist/errors/bad-request-error.js +11 -0
- package/dist/errors/forbidden-error.d.ts +4 -0
- package/dist/errors/forbidden-error.js +11 -0
- package/dist/errors/internal-error.d.ts +4 -0
- package/dist/errors/internal-error.js +11 -0
- package/dist/errors/invalid-operation-error.d.ts +4 -0
- package/dist/errors/invalid-operation-error.js +11 -0
- package/dist/errors/not-found-error.d.ts +5 -0
- package/dist/errors/not-found-error.js +11 -0
- package/dist/errors/not-implemented-error.d.ts +4 -0
- package/dist/errors/not-implemented-error.js +11 -0
- package/dist/errors/not-loaded-error.d.ts +4 -0
- package/dist/errors/not-loaded-error.js +11 -0
- package/dist/errors/not-supported-error.d.ts +4 -0
- package/dist/errors/not-supported-error.js +11 -0
- package/dist/errors/schema-error.d.ts +4 -0
- package/dist/errors/schema-error.js +11 -0
- package/dist/errors/validation-error.d.ts +6 -0
- package/dist/errors/validation-error.js +12 -0
- package/dist/errors/validation-failure.d.ts +7 -0
- package/dist/errors/validation-failure.js +14 -0
- package/dist/errors/web-api-error.d.ts +13 -0
- package/dist/errors/web-api-error.js +13 -0
- package/dist/factories/entity-factory.d.ts +38 -0
- package/dist/factories/entity-factory.js +76 -0
- package/dist/factories/option-list-factory.d.ts +26 -0
- package/dist/factories/option-list-factory.js +22 -0
- package/dist/factories/property-factory.d.ts +10 -0
- package/dist/factories/property-factory.js +54 -0
- package/dist/factories/relation-factory.d.ts +55 -0
- package/dist/factories/relation-factory.js +70 -0
- package/dist/fileversion.d.ts +78 -0
- package/dist/fileversion.js +144 -0
- package/dist/guard.d.ts +29 -0
- package/dist/guard.js +142 -0
- package/dist/http-method.d.ts +9 -0
- package/dist/http-method.js +13 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +22 -0
- package/dist/link-helper.d.ts +209 -0
- package/dist/link-helper.js +371 -0
- package/dist/link.d.ts +9 -0
- package/dist/link.js +78 -0
- package/dist/logging/log-level.d.ts +6 -0
- package/dist/logging/log-level.js +10 -0
- package/dist/logging/logger-base.d.ts +26 -0
- package/dist/logging/logger-base.js +98 -0
- package/dist/logging/logger.d.ts +16 -0
- package/dist/logging/logger.js +2 -0
- package/dist/logging/null-logger.d.ts +7 -0
- package/dist/logging/null-logger.js +13 -0
- package/dist/mappers/api-resource-mapper.d.ts +5 -0
- package/dist/mappers/api-resource-mapper.js +16 -0
- package/dist/mappers/condition-mapper.d.ts +36 -0
- package/dist/mappers/condition-mapper.js +112 -0
- package/dist/mappers/entity-definition-mapper.d.ts +13 -0
- package/dist/mappers/entity-definition-mapper.js +88 -0
- package/dist/mappers/entity-mapper.d.ts +19 -0
- package/dist/mappers/entity-mapper.js +134 -0
- package/dist/mappers/final-life-cycle-status-mapper.d.ts +6 -0
- package/dist/mappers/final-life-cycle-status-mapper.js +51 -0
- package/dist/mappers/load-options-mapper.d.ts +16 -0
- package/dist/mappers/load-options-mapper.js +100 -0
- package/dist/mappers/mapping-utilities.d.ts +7 -0
- package/dist/mappers/mapping-utilities.js +19 -0
- package/dist/mappers/member-condition-mapper.d.ts +12 -0
- package/dist/mappers/member-condition-mapper.js +119 -0
- package/dist/mappers/member-definition-mapper.d.ts +19 -0
- package/dist/mappers/member-definition-mapper.js +266 -0
- package/dist/mappers/member-group-mapper.d.ts +14 -0
- package/dist/mappers/member-group-mapper.js +95 -0
- package/dist/mappers/member-security-mapper.d.ts +34 -0
- package/dist/mappers/member-security-mapper.js +101 -0
- package/dist/mappers/notification-mapper.d.ts +5 -0
- package/dist/mappers/notification-mapper.js +17 -0
- package/dist/mappers/option-list-mapper.d.ts +18 -0
- package/dist/mappers/option-list-mapper.js +131 -0
- package/dist/mappers/policy-mapper.d.ts +29 -0
- package/dist/mappers/policy-mapper.js +124 -0
- package/dist/mappers/property-mapper.d.ts +21 -0
- package/dist/mappers/property-mapper.js +339 -0
- package/dist/mappers/querying-mapper.d.ts +16 -0
- package/dist/mappers/querying-mapper.js +96 -0
- package/dist/mappers/relation-cardinality-mapper.d.ts +5 -0
- package/dist/mappers/relation-cardinality-mapper.js +37 -0
- package/dist/mappers/relation-mapper.d.ts +16 -0
- package/dist/mappers/relation-mapper.js +202 -0
- package/dist/mappers/relation-role-mapper.d.ts +5 -0
- package/dist/mappers/relation-role-mapper.js +29 -0
- package/dist/mappers/rendition-mapper.d.ts +9 -0
- package/dist/mappers/rendition-mapper.js +34 -0
- package/dist/mappers/rule-type-mapper.d.ts +6 -0
- package/dist/mappers/rule-type-mapper.js +33 -0
- package/dist/mappers/rules-mapper.d.ts +35 -0
- package/dist/mappers/rules-mapper.js +123 -0
- package/dist/mappers/typed-entity-creator.d.ts +27 -0
- package/dist/mappers/typed-entity-creator.js +76 -0
- package/dist/models/entity-definition-collection-resource.d.ts +5 -0
- package/dist/models/entity-definition-collection-resource.js +26 -0
- package/dist/models/entity-definition-resource.d.ts +23 -0
- package/dist/models/entity-definition-resource.js +98 -0
- package/dist/models/entity-list-resource.d.ts +5 -0
- package/dist/models/entity-list-resource.js +26 -0
- package/dist/models/entity-resource.d.ts +36 -0
- package/dist/models/entity-resource.js +142 -0
- package/dist/models/list-resource.d.ts +13 -0
- package/dist/models/list-resource.js +50 -0
- package/dist/models/member-condition-resource.d.ts +32 -0
- package/dist/models/member-condition-resource.js +95 -0
- package/dist/models/member-definition-resource.d.ts +15 -0
- package/dist/models/member-definition-resource.js +71 -0
- package/dist/models/member-group-resource.d.ts +14 -0
- package/dist/models/member-group-resource.js +61 -0
- package/dist/models/notifications/distribute-notification-resource.d.ts +7 -0
- package/dist/models/notifications/distribute-notification-resource.js +37 -0
- package/dist/models/notifications/mail-request-broadcast.d.ts +7 -0
- package/dist/models/notifications/mail-request-broadcast.js +18 -0
- package/dist/models/notifications/mail-request-by-id.d.ts +9 -0
- package/dist/models/notifications/mail-request-by-id.js +28 -0
- package/dist/models/notifications/mail-request-by-username.d.ts +9 -0
- package/dist/models/notifications/mail-request-by-username.js +28 -0
- package/dist/models/notifications/mail-request.d.ts +26 -0
- package/dist/models/notifications/mail-request.js +12 -0
- package/dist/models/notifications/notification-level.d.ts +8 -0
- package/dist/models/notifications/notification-level.js +12 -0
- package/dist/models/notifications/realtime-request-broadcast.d.ts +7 -0
- package/dist/models/notifications/realtime-request-broadcast.js +18 -0
- package/dist/models/notifications/realtime-request-by-id.d.ts +9 -0
- package/dist/models/notifications/realtime-request-by-id.js +28 -0
- package/dist/models/notifications/realtime-request-by-username.d.ts +9 -0
- package/dist/models/notifications/realtime-request-by-username.js +28 -0
- package/dist/models/notifications/realtime-request.d.ts +60 -0
- package/dist/models/notifications/realtime-request.js +41 -0
- package/dist/models/notifications/request-by-id.d.ts +13 -0
- package/dist/models/notifications/request-by-id.js +2 -0
- package/dist/models/notifications/request-by-username.d.ts +13 -0
- package/dist/models/notifications/request-by-username.js +2 -0
- package/dist/models/notifications/validators/mail-validator.d.ts +6 -0
- package/dist/models/notifications/validators/mail-validator.js +23 -0
- package/dist/models/notifications/validators/realtime-validator.d.ts +5 -0
- package/dist/models/notifications/validators/realtime-validator.js +14 -0
- package/dist/models/notifications/validators/request-by-id-validator.d.ts +6 -0
- package/dist/models/notifications/validators/request-by-id-validator.js +31 -0
- package/dist/models/notifications/validators/request-by-username-validator.d.ts +6 -0
- package/dist/models/notifications/validators/request-by-username-validator.js +31 -0
- package/dist/models/notifications/validators/validator-base.d.ts +6 -0
- package/dist/models/notifications/validators/validator-base.js +16 -0
- package/dist/models/option-lists/flat-option-list-value.d.ts +4 -0
- package/dist/models/option-lists/flat-option-list-value.js +9 -0
- package/dist/models/option-lists/hierarchical-options-list-value.d.ts +7 -0
- package/dist/models/option-lists/hierarchical-options-list-value.js +14 -0
- package/dist/models/option-lists/option-list-collection-resource.d.ts +6 -0
- package/dist/models/option-lists/option-list-collection-resource.js +32 -0
- package/dist/models/option-lists/option-list-description-resource.d.ts +5 -0
- package/dist/models/option-lists/option-list-description-resource.js +31 -0
- package/dist/models/option-lists/option-list-resource.d.ts +16 -0
- package/dist/models/option-lists/option-list-resource.js +62 -0
- package/dist/models/option-lists/option-list-value-resource.d.ts +6 -0
- package/dist/models/option-lists/option-list-value-resource.js +32 -0
- package/dist/models/pages/component-visualization.d.ts +10 -0
- package/dist/models/pages/component-visualization.js +54 -0
- package/dist/models/pages/language-resource.d.ts +10 -0
- package/dist/models/pages/language-resource.js +47 -0
- package/dist/models/pages/menu-item.d.ts +12 -0
- package/dist/models/pages/menu-item.js +66 -0
- package/dist/models/pages/page-component-resource.d.ts +20 -0
- package/dist/models/pages/page-component-resource.js +87 -0
- package/dist/models/pages/page-resource.d.ts +23 -0
- package/dist/models/pages/page-resource.js +100 -0
- package/dist/models/pages/page-row-settings.d.ts +27 -0
- package/dist/models/pages/page-row-settings.js +119 -0
- package/dist/models/pages/portal-column-resource.d.ts +6 -0
- package/dist/models/pages/portal-column-resource.js +37 -0
- package/dist/models/pages/portal-row-resource.d.ts +7 -0
- package/dist/models/pages/portal-row-resource.js +38 -0
- package/dist/models/pages/portal-section-resource.d.ts +6 -0
- package/dist/models/pages/portal-section-resource.js +37 -0
- package/dist/models/permissions-resource.d.ts +4 -0
- package/dist/models/permissions-resource.js +28 -0
- package/dist/models/policies/condition-resource.d.ts +21 -0
- package/dist/models/policies/condition-resource.js +53 -0
- package/dist/models/policies/member-policy-resource.d.ts +8 -0
- package/dist/models/policies/member-policy-resource.js +43 -0
- package/dist/models/policies/policy-resource.d.ts +50 -0
- package/dist/models/policies/policy-resource.js +89 -0
- package/dist/models/policies/rule-resource.d.ts +49 -0
- package/dist/models/policies/rule-resource.js +78 -0
- package/dist/models/property-definition-resource.d.ts +45 -0
- package/dist/models/property-definition-resource.js +198 -0
- package/dist/models/query-loading-resource.d.ts +4 -0
- package/dist/models/query-loading-resource.js +28 -0
- package/dist/models/query-result-resource.d.ts +9 -0
- package/dist/models/query-result-resource.js +34 -0
- package/dist/models/relation-definition-resource.d.ts +29 -0
- package/dist/models/relation-definition-resource.js +115 -0
- package/dist/models/relation-map-resource.d.ts +6 -0
- package/dist/models/relation-map-resource.js +16 -0
- package/dist/models/relation-resource.d.ts +21 -0
- package/dist/models/relation-resource.js +93 -0
- package/dist/models/resource-containers/entity-definition-resource-container.d.ts +8 -0
- package/dist/models/resource-containers/entity-definition-resource-container.js +2 -0
- package/dist/models/resource-containers/entity-resource-container.d.ts +8 -0
- package/dist/models/resource-containers/entity-resource-container.js +2 -0
- package/dist/models/resource.d.ts +4 -0
- package/dist/models/resource.js +26 -0
- package/dist/models/search/aggregation-request-resource.d.ts +16 -0
- package/dist/models/search/aggregation-request-resource.js +72 -0
- package/dist/models/search/aggregation-response-resource.d.ts +8 -0
- package/dist/models/search/aggregation-response-resource.js +41 -0
- package/dist/models/search/bucket-response-resource.d.ts +8 -0
- package/dist/models/search/bucket-response-resource.js +46 -0
- package/dist/models/search/date-interval.d.ts +10 -0
- package/dist/models/search/date-interval.js +14 -0
- package/dist/models/search/facet-response-resource.d.ts +20 -0
- package/dist/models/search/facet-response-resource.js +98 -0
- package/dist/models/search/field-filter-request-resource.d.ts +16 -0
- package/dist/models/search/field-filter-request-resource.js +76 -0
- package/dist/models/search/field-filter-response-resource.d.ts +17 -0
- package/dist/models/search/field-filter-response-resource.js +84 -0
- package/dist/models/search/field-filter-value-response-resource.d.ts +6 -0
- package/dist/models/search/field-filter-value-response-resource.js +31 -0
- package/dist/models/search/filter-operator.d.ts +86 -0
- package/dist/models/search/filter-operator.js +90 -0
- package/dist/models/search/full-text-response-resource.d.ts +4 -0
- package/dist/models/search/full-text-response-resource.js +27 -0
- package/dist/models/search/group-category.d.ts +6 -0
- package/dist/models/search/group-category.js +35 -0
- package/dist/models/search/group-config.d.ts +4 -0
- package/dist/models/search/group-config.js +27 -0
- package/dist/models/search/group-item.d.ts +10 -0
- package/dist/models/search/group-item.js +44 -0
- package/dist/models/search/grouped-view-response-resource.d.ts +15 -0
- package/dist/models/search/grouped-view-response-resource.js +65 -0
- package/dist/models/search/metric-option-request-resource.d.ts +7 -0
- package/dist/models/search/metric-option-request-resource.js +37 -0
- package/dist/models/search/metric-option-response-resource.d.ts +5 -0
- package/dist/models/search/metric-option-response-resource.js +31 -0
- package/dist/models/search/nested-relation-info.d.ts +11 -0
- package/dist/models/search/nested-relation-info.js +96 -0
- package/dist/models/search/requested-aggregation-type.d.ts +5 -0
- package/dist/models/search/requested-aggregation-type.js +9 -0
- package/dist/models/search/requested-filter-type.d.ts +6 -0
- package/dist/models/search/requested-filter-type.js +10 -0
- package/dist/models/search/search-group-request-resource.d.ts +5 -0
- package/dist/models/search/search-group-request-resource.js +31 -0
- package/dist/models/search/search-request.d.ts +41 -0
- package/dist/models/search/search-request.js +131 -0
- package/dist/models/search/search-response.d.ts +36 -0
- package/dist/models/search/search-response.js +123 -0
- package/dist/models/search/selection-pool-filter-resource.d.ts +7 -0
- package/dist/models/search/selection-pool-filter-resource.js +38 -0
- package/dist/models/search/sorting-request-resource.d.ts +5 -0
- package/dist/models/search/sorting-request-resource.js +32 -0
- package/dist/models/search/sorting-response-resource.d.ts +6 -0
- package/dist/models/search/sorting-response-resource.js +34 -0
- package/dist/models/search-document-resource.d.ts +7 -0
- package/dist/models/search-document-resource.js +33 -0
- package/dist/models/set-password-request-resource.d.ts +5 -0
- package/dist/models/set-password-request-resource.js +31 -0
- package/dist/settings/fetch-setting.d.ts +12 -0
- package/dist/settings/fetch-setting.js +61 -0
- package/dist/settings/super-user-excluded-privileges.d.ts +3 -0
- package/dist/settings/super-user-excluded-privileges.js +27 -0
- package/dist/settings/usage-rights-configuration.d.ts +24 -0
- package/dist/settings/usage-rights-configuration.js +90 -0
- package/dist/type-guards.d.ts +20 -0
- package/dist/type-guards.js +28 -0
- package/package.json +78 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
12
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
13
|
+
};
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.LongPropertyDefinition = void 0;
|
|
16
|
+
const ta_json_1 = require("ta-json");
|
|
17
|
+
const data_type_1 = __importDefault(require("../data-type"));
|
|
18
|
+
const property_definition_1 = require("../property-definition");
|
|
19
|
+
/**
|
|
20
|
+
* Long property definition.
|
|
21
|
+
*/
|
|
22
|
+
let LongPropertyDefinition = class LongPropertyDefinition extends property_definition_1.PropertyDefinition {
|
|
23
|
+
constructor(name, init) {
|
|
24
|
+
super(name, data_type_1.default.Long);
|
|
25
|
+
Object.assign(this, init);
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
LongPropertyDefinition = __decorate([
|
|
29
|
+
ta_json_1.JsonObject(),
|
|
30
|
+
ta_json_1.JsonDiscriminatorValue(data_type_1.default.Long),
|
|
31
|
+
__metadata("design:paramtypes", [String, Object])
|
|
32
|
+
], LongPropertyDefinition);
|
|
33
|
+
exports.LongPropertyDefinition = LongPropertyDefinition;
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { Nullable } from "../../../base-types";
|
|
2
|
+
import { PropertyDefinition } from "../property-definition";
|
|
3
|
+
import { StringContentType } from "../string-content-type";
|
|
4
|
+
/**
|
|
5
|
+
*
|
|
6
|
+
* String property definition.
|
|
7
|
+
*/
|
|
8
|
+
export declare class StringPropertyDefinition extends PropertyDefinition {
|
|
9
|
+
/**
|
|
10
|
+
* Describes how the content should be displayed.
|
|
11
|
+
*/
|
|
12
|
+
contentType: StringContentType;
|
|
13
|
+
/**
|
|
14
|
+
* A regular expression that must match the value of the property. If set to null the value is not checked.
|
|
15
|
+
*/
|
|
16
|
+
validationExpression: Nullable<string>;
|
|
17
|
+
/**
|
|
18
|
+
* The name of the {@link IDataSource} to get possible values from.
|
|
19
|
+
*
|
|
20
|
+
* @remarks
|
|
21
|
+
* Is null when there is no attached datasource.
|
|
22
|
+
*/
|
|
23
|
+
dataSourceName: Nullable<string>;
|
|
24
|
+
/**
|
|
25
|
+
* The name of the {@link IOptionList} to get possible values from.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* Is null when there is no attached option list.
|
|
29
|
+
*/
|
|
30
|
+
get optionListName(): Nullable<string>;
|
|
31
|
+
set optionListName(value: Nullable<string>);
|
|
32
|
+
constructor(name: string, init?: Omit<Partial<StringPropertyDefinition>, "name">);
|
|
33
|
+
}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
12
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
13
|
+
};
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.StringPropertyDefinition = void 0;
|
|
16
|
+
const ta_json_1 = require("ta-json");
|
|
17
|
+
const data_type_1 = __importDefault(require("../data-type"));
|
|
18
|
+
const property_definition_1 = require("../property-definition");
|
|
19
|
+
const string_content_type_1 = require("../string-content-type");
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* String property definition.
|
|
23
|
+
*/
|
|
24
|
+
let StringPropertyDefinition = class StringPropertyDefinition extends property_definition_1.PropertyDefinition {
|
|
25
|
+
constructor(name, init) {
|
|
26
|
+
super(name, data_type_1.default.String);
|
|
27
|
+
Object.assign(this, init);
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* The name of the {@link IOptionList} to get possible values from.
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* Is null when there is no attached option list.
|
|
34
|
+
*/
|
|
35
|
+
get optionListName() {
|
|
36
|
+
return this.dataSourceName;
|
|
37
|
+
}
|
|
38
|
+
set optionListName(value) {
|
|
39
|
+
this.dataSourceName = value;
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
__decorate([
|
|
43
|
+
ta_json_1.JsonProperty("content_type"),
|
|
44
|
+
__metadata("design:type", Number)
|
|
45
|
+
], StringPropertyDefinition.prototype, "contentType", void 0);
|
|
46
|
+
__decorate([
|
|
47
|
+
ta_json_1.JsonProperty("validation_expression"),
|
|
48
|
+
__metadata("design:type", Object)
|
|
49
|
+
], StringPropertyDefinition.prototype, "validationExpression", void 0);
|
|
50
|
+
StringPropertyDefinition = __decorate([
|
|
51
|
+
ta_json_1.JsonObject(),
|
|
52
|
+
ta_json_1.JsonDiscriminatorValue(data_type_1.default.String),
|
|
53
|
+
__metadata("design:paramtypes", [String, Object])
|
|
54
|
+
], StringPropertyDefinition);
|
|
55
|
+
exports.StringPropertyDefinition = StringPropertyDefinition;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Nullable, NullableResultPromise } from "../../base-types";
|
|
2
|
+
import { IContentHubClient } from "../../clients/content-hub-client";
|
|
3
|
+
import { IPropertyLoadOption } from "../querying/property-load-option";
|
|
4
|
+
import { IEntity } from "./entity";
|
|
5
|
+
import { IProperty } from "./property";
|
|
6
|
+
export declare class PropertyManager {
|
|
7
|
+
private readonly _client;
|
|
8
|
+
private readonly _entity;
|
|
9
|
+
private readonly _properties;
|
|
10
|
+
get count(): number;
|
|
11
|
+
constructor(client: IContentHubClient, properties: Array<IProperty>, entity: IEntity);
|
|
12
|
+
getProperty<T extends IProperty = IProperty>(name: string): Nullable<T>;
|
|
13
|
+
getProperties(): Array<IProperty>;
|
|
14
|
+
loadPropertyAsync<T extends IProperty = IProperty>(propertyName: string): NullableResultPromise<T>;
|
|
15
|
+
loadPropertiesAsync(propertyLoadOption: IPropertyLoadOption): Promise<boolean>;
|
|
16
|
+
hasMissingProperties(propertyLoadOption: IPropertyLoadOption): boolean;
|
|
17
|
+
importMissingProperties(entity: Nullable<IEntity>): void;
|
|
18
|
+
private fetchPropertyAsync;
|
|
19
|
+
}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
12
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
13
|
+
};
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.PropertyManager = void 0;
|
|
16
|
+
const base_types_1 = require("../../base-types");
|
|
17
|
+
const guard_1 = __importDefault(require("../../guard"));
|
|
18
|
+
const mapping_utilities_1 = require("../../mappers/mapping-utilities");
|
|
19
|
+
const entity_load_configuration_1 = require("../querying/entity-load-configuration");
|
|
20
|
+
const load_options_1 = require("../querying/load-options");
|
|
21
|
+
const property_load_option_1 = require("../querying/property-load-option");
|
|
22
|
+
const relation_load_option_1 = require("../querying/relation-load-option");
|
|
23
|
+
const lazy_loading_manager_1 = require("./lazy-loading-manager");
|
|
24
|
+
class PropertyManager {
|
|
25
|
+
constructor(client, properties, entity) {
|
|
26
|
+
guard_1.default.notNullOrUndefined(entity);
|
|
27
|
+
guard_1.default.notNullOrUndefined(client);
|
|
28
|
+
guard_1.default.notNullOrUndefined(properties);
|
|
29
|
+
this._client = client;
|
|
30
|
+
this._entity = entity;
|
|
31
|
+
this._properties = new base_types_1.CaseInsensitiveStringMap();
|
|
32
|
+
for (const property of properties) {
|
|
33
|
+
this._properties[property.name] = property;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
get count() {
|
|
37
|
+
return Object.keys(this._properties).length;
|
|
38
|
+
}
|
|
39
|
+
getProperty(name) {
|
|
40
|
+
guard_1.default.stringNotNullOrEmpty(name);
|
|
41
|
+
return this._properties[name] || null;
|
|
42
|
+
}
|
|
43
|
+
getProperties() {
|
|
44
|
+
return [...Object.values(this._properties)];
|
|
45
|
+
}
|
|
46
|
+
loadPropertyAsync(propertyName) {
|
|
47
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
48
|
+
guard_1.default.stringNotNullOrEmpty(propertyName);
|
|
49
|
+
lazy_loading_manager_1.LazyLoadingManager.ensureLazyLoadingIsPossible(this._entity);
|
|
50
|
+
// Check if it is already loaded
|
|
51
|
+
let property = this._properties[propertyName];
|
|
52
|
+
if (property) {
|
|
53
|
+
return property;
|
|
54
|
+
}
|
|
55
|
+
// Load the property
|
|
56
|
+
property = yield this.fetchPropertyAsync(propertyName);
|
|
57
|
+
// Add the property
|
|
58
|
+
if (property != null) {
|
|
59
|
+
this._properties[property.name] = property;
|
|
60
|
+
}
|
|
61
|
+
return property;
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
loadPropertiesAsync(propertyLoadOption) {
|
|
65
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
66
|
+
guard_1.default.notNullOrUndefined(propertyLoadOption);
|
|
67
|
+
lazy_loading_manager_1.LazyLoadingManager.ensureLazyLoadingIsPossible(this._entity);
|
|
68
|
+
if (!this.hasMissingProperties(propertyLoadOption)) {
|
|
69
|
+
return false;
|
|
70
|
+
}
|
|
71
|
+
const cultureLoadOption = mapping_utilities_1.MappingUtilities.culturesToLoadOption([...this._entity.cultures]);
|
|
72
|
+
const loadConfig = new entity_load_configuration_1.EntityLoadConfiguration(cultureLoadOption, propertyLoadOption, relation_load_option_1.RelationLoadOption.None);
|
|
73
|
+
const tempEntity = yield this._client.entities.getAsync(this._entity.id, loadConfig);
|
|
74
|
+
this.importMissingProperties(tempEntity);
|
|
75
|
+
return true;
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
hasMissingProperties(propertyLoadOption) {
|
|
79
|
+
if (propertyLoadOption == null ||
|
|
80
|
+
propertyLoadOption.loadOption === load_options_1.LoadOption.None ||
|
|
81
|
+
propertyLoadOption.properties == null ||
|
|
82
|
+
propertyLoadOption.properties.length === 0) {
|
|
83
|
+
return false;
|
|
84
|
+
}
|
|
85
|
+
if (propertyLoadOption.loadOption === load_options_1.LoadOption.All) {
|
|
86
|
+
// We don't have any info about the definition here. (Same logic as in the C# SDK)
|
|
87
|
+
return true;
|
|
88
|
+
}
|
|
89
|
+
return propertyLoadOption.properties.some(requestedPropertyName => !this._properties[requestedPropertyName]);
|
|
90
|
+
}
|
|
91
|
+
importMissingProperties(entity) {
|
|
92
|
+
guard_1.default.notNullOrUndefined(entity);
|
|
93
|
+
for (const property of entity.properties) {
|
|
94
|
+
this._properties[property.name] = property;
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
fetchPropertyAsync(name) {
|
|
98
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
99
|
+
// Setup load configuration
|
|
100
|
+
const cultureLoadOption = mapping_utilities_1.MappingUtilities.culturesToLoadOption([...this._entity.cultures]);
|
|
101
|
+
const propertyLoadOption = new property_load_option_1.PropertyLoadOption(name);
|
|
102
|
+
const loadConfig = new entity_load_configuration_1.EntityLoadConfiguration(cultureLoadOption, propertyLoadOption, relation_load_option_1.RelationLoadOption.None);
|
|
103
|
+
// Load entity
|
|
104
|
+
const entity = yield this._client.entities.getAsync(this._entity.id, loadConfig);
|
|
105
|
+
if (entity == null) {
|
|
106
|
+
return null;
|
|
107
|
+
}
|
|
108
|
+
// We only loaded this specific property, so we can just take the first one.
|
|
109
|
+
const property = entity.properties[0] || null;
|
|
110
|
+
return property;
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
exports.PropertyManager = PropertyManager;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { PropertyDataType, TypeInfo } from "./data-type";
|
|
2
|
+
import { IMember, MemberBase } from "./member";
|
|
3
|
+
export interface IProperty extends IMember {
|
|
4
|
+
readonly dataType: PropertyDataType | unknown;
|
|
5
|
+
readonly isMultiLanguage: boolean;
|
|
6
|
+
}
|
|
7
|
+
export declare abstract class PropertyBase<T extends PropertyDataType | unknown, B extends boolean> extends MemberBase implements IProperty {
|
|
8
|
+
readonly dataType: T | unknown;
|
|
9
|
+
readonly isMultiValue: B;
|
|
10
|
+
readonly isMultiLanguage: boolean;
|
|
11
|
+
protected constructor(name: string, typeInfo: TypeInfo<T, B>);
|
|
12
|
+
protected abstract getTypeName(): string;
|
|
13
|
+
/**
|
|
14
|
+
* Returns a string representation of the current property instance.
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* Can not be used for serialization. Only useful during debugging or testing.
|
|
18
|
+
* Returned format: \<member format ({@link MemberBase.toString})\> ({@link PropertyDataType})
|
|
19
|
+
*/
|
|
20
|
+
toString(): string;
|
|
21
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.PropertyBase = void 0;
|
|
7
|
+
const guard_1 = __importDefault(require("../../guard"));
|
|
8
|
+
const data_type_1 = require("./data-type");
|
|
9
|
+
const member_1 = require("./member");
|
|
10
|
+
const member_definition_type_1 = require("./member-definition-type");
|
|
11
|
+
class PropertyBase extends member_1.MemberBase {
|
|
12
|
+
constructor(name, typeInfo) {
|
|
13
|
+
super(name, member_definition_type_1.MemberDefinitionType.Property);
|
|
14
|
+
this.isMultiLanguage = false;
|
|
15
|
+
guard_1.default.notNullOrUndefined(typeInfo);
|
|
16
|
+
this.dataType = typeInfo.type;
|
|
17
|
+
this.isMultiValue = typeInfo.isArray;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Returns a string representation of the current property instance.
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* Can not be used for serialization. Only useful during debugging or testing.
|
|
24
|
+
* Returned format: \<member format ({@link MemberBase.toString})\> ({@link PropertyDataType})
|
|
25
|
+
*/
|
|
26
|
+
toString() {
|
|
27
|
+
return `${super.toString()} (${data_type_1.PropertyDataType[this.dataType]})`;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
exports.PropertyBase = PropertyBase;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Describes the cardinality of a relation.
|
|
3
|
+
* All values are from Parent =\> Child.
|
|
4
|
+
*/
|
|
5
|
+
export declare enum RelationCardinality {
|
|
6
|
+
/**
|
|
7
|
+
* One parent to many children.
|
|
8
|
+
*/
|
|
9
|
+
OneToMany = 0,
|
|
10
|
+
/**
|
|
11
|
+
* Many parents to many children.
|
|
12
|
+
*/
|
|
13
|
+
ManyToMany = 1,
|
|
14
|
+
/**
|
|
15
|
+
* One parent to one child.
|
|
16
|
+
*/
|
|
17
|
+
OneToOne = 2
|
|
18
|
+
}
|
|
19
|
+
export declare type RelationCardinalityType = "OneToMany" | "ManyToMany" | "OneToOne";
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RelationCardinality = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Describes the cardinality of a relation.
|
|
6
|
+
* All values are from Parent =\> Child.
|
|
7
|
+
*/
|
|
8
|
+
var RelationCardinality;
|
|
9
|
+
(function (RelationCardinality) {
|
|
10
|
+
/**
|
|
11
|
+
* One parent to many children.
|
|
12
|
+
*/
|
|
13
|
+
RelationCardinality[RelationCardinality["OneToMany"] = 0] = "OneToMany";
|
|
14
|
+
/**
|
|
15
|
+
* Many parents to many children.
|
|
16
|
+
*/
|
|
17
|
+
RelationCardinality[RelationCardinality["ManyToMany"] = 1] = "ManyToMany";
|
|
18
|
+
/**
|
|
19
|
+
* One parent to one child.
|
|
20
|
+
*/
|
|
21
|
+
RelationCardinality[RelationCardinality["OneToOne"] = 2] = "OneToOne";
|
|
22
|
+
})(RelationCardinality = exports.RelationCardinality || (exports.RelationCardinality = {}));
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { IChildRelation, IParentRelation, IRelation } from "./relation";
|
|
2
|
+
import { RelationRole } from "./relation-role";
|
|
3
|
+
export declare class RelationContainer {
|
|
4
|
+
relationName: string;
|
|
5
|
+
private _parentRelation;
|
|
6
|
+
get parentRelation(): IParentRelation;
|
|
7
|
+
private _childRelation;
|
|
8
|
+
get childRelation(): IChildRelation;
|
|
9
|
+
/**
|
|
10
|
+
* Checks if the relation is self-referencing.
|
|
11
|
+
*/
|
|
12
|
+
get isSelfRelation(): boolean;
|
|
13
|
+
/**
|
|
14
|
+
* Checks if this contains any relation.
|
|
15
|
+
*/
|
|
16
|
+
get isEmpty(): boolean;
|
|
17
|
+
constructor(relationName: string);
|
|
18
|
+
/**
|
|
19
|
+
* Checks if this contains any relation.
|
|
20
|
+
*/
|
|
21
|
+
any(): boolean;
|
|
22
|
+
/**
|
|
23
|
+
* Gets the relation. If role is null and the relation is self-referencing, it will throw.
|
|
24
|
+
* Returns null if there are no loaded relations.
|
|
25
|
+
* @param role - Relation role
|
|
26
|
+
*/
|
|
27
|
+
getRelation(role?: RelationRole): IRelation;
|
|
28
|
+
/**
|
|
29
|
+
* Gets an array of all loaded relations.
|
|
30
|
+
*/
|
|
31
|
+
getRelations(): Array<IRelation>;
|
|
32
|
+
/**
|
|
33
|
+
* Checks if the relation with specified role is loaded.
|
|
34
|
+
*/
|
|
35
|
+
relationExists(role: RelationRole): boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Sets the relation on this container.
|
|
38
|
+
*/
|
|
39
|
+
setRelation(relation: IRelation): void;
|
|
40
|
+
}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.RelationContainer = void 0;
|
|
7
|
+
const string_format_1 = __importDefault(require("string-format"));
|
|
8
|
+
const error_messages_1 = __importDefault(require("../../error-messages"));
|
|
9
|
+
const guard_1 = __importDefault(require("../../guard"));
|
|
10
|
+
const relation_1 = require("./relation");
|
|
11
|
+
const relation_role_1 = require("./relation-role");
|
|
12
|
+
class RelationContainer {
|
|
13
|
+
constructor(relationName) {
|
|
14
|
+
guard_1.default.stringNotNullOrEmpty(relationName);
|
|
15
|
+
this.relationName = relationName;
|
|
16
|
+
}
|
|
17
|
+
get parentRelation() {
|
|
18
|
+
return this._parentRelation;
|
|
19
|
+
}
|
|
20
|
+
get childRelation() {
|
|
21
|
+
return this._childRelation;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Checks if the relation is self-referencing.
|
|
25
|
+
*/
|
|
26
|
+
get isSelfRelation() {
|
|
27
|
+
return this.parentRelation != null && this.childRelation != null;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Checks if this contains any relation.
|
|
31
|
+
*/
|
|
32
|
+
get isEmpty() {
|
|
33
|
+
return this.parentRelation == null && this.childRelation == null;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Checks if this contains any relation.
|
|
37
|
+
*/
|
|
38
|
+
any() {
|
|
39
|
+
return this.parentRelation != null || this.childRelation != null;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Gets the relation. If role is null and the relation is self-referencing, it will throw.
|
|
43
|
+
* Returns null if there are no loaded relations.
|
|
44
|
+
* @param role - Relation role
|
|
45
|
+
*/
|
|
46
|
+
getRelation(role) {
|
|
47
|
+
if (role == null) {
|
|
48
|
+
if (this.isSelfRelation) {
|
|
49
|
+
throw new Error(string_format_1.default(error_messages_1.default.Entity.SelfReferencingRelation, this.relationName));
|
|
50
|
+
}
|
|
51
|
+
if (this.parentRelation != null) {
|
|
52
|
+
return this.parentRelation;
|
|
53
|
+
}
|
|
54
|
+
else {
|
|
55
|
+
return this.childRelation;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
else if (role === relation_role_1.RelationRole.Parent) {
|
|
59
|
+
return this.parentRelation;
|
|
60
|
+
}
|
|
61
|
+
else if (role === relation_role_1.RelationRole.Child) {
|
|
62
|
+
return this.childRelation;
|
|
63
|
+
}
|
|
64
|
+
else {
|
|
65
|
+
throw new Error(string_format_1.default(error_messages_1.default.RelationRoleMapper.UnknownRole, role));
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Gets an array of all loaded relations.
|
|
70
|
+
*/
|
|
71
|
+
getRelations() {
|
|
72
|
+
if (this.isSelfRelation) {
|
|
73
|
+
return [this.parentRelation, this.childRelation];
|
|
74
|
+
}
|
|
75
|
+
else if (this.parentRelation != null) {
|
|
76
|
+
return [this.parentRelation];
|
|
77
|
+
}
|
|
78
|
+
else if (this.childRelation != null) {
|
|
79
|
+
return [this.childRelation];
|
|
80
|
+
}
|
|
81
|
+
else {
|
|
82
|
+
return [];
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Checks if the relation with specified role is loaded.
|
|
87
|
+
*/
|
|
88
|
+
relationExists(role) {
|
|
89
|
+
if (role === relation_role_1.RelationRole.Parent) {
|
|
90
|
+
return this.parentRelation != null;
|
|
91
|
+
}
|
|
92
|
+
else if (role === relation_role_1.RelationRole.Child) {
|
|
93
|
+
return this.childRelation != null;
|
|
94
|
+
}
|
|
95
|
+
else {
|
|
96
|
+
throw new Error(string_format_1.default(error_messages_1.default.RelationRoleMapper.UnknownRole, role));
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Sets the relation on this container.
|
|
101
|
+
*/
|
|
102
|
+
setRelation(relation) {
|
|
103
|
+
guard_1.default.notNullOrUndefined(relation);
|
|
104
|
+
if (this.relationName != relation.name) {
|
|
105
|
+
throw new Error(error_messages_1.default.Entity.RelationNameMustMatch);
|
|
106
|
+
}
|
|
107
|
+
if (relation_1.RelationBase.isParentRelation(relation)) {
|
|
108
|
+
this._parentRelation = relation;
|
|
109
|
+
}
|
|
110
|
+
else if (relation_1.RelationBase.isChildRelation(relation)) {
|
|
111
|
+
this._childRelation = relation;
|
|
112
|
+
}
|
|
113
|
+
else {
|
|
114
|
+
throw new Error(string_format_1.default(error_messages_1.default.RelationRoleMapper.UnknownRole, relation.role));
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
exports.RelationContainer = RelationContainer;
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { MapCultureTo } from "../../base-types";
|
|
2
|
+
import { IMemberDefinition, MemberDefinition } from "./member-definition";
|
|
3
|
+
import { MemberDefinitionType } from "./member-definition-type";
|
|
4
|
+
import { RelationCardinality } from "./relation-cardinality";
|
|
5
|
+
import { RelationRole } from "./relation-role";
|
|
6
|
+
/**
|
|
7
|
+
* Represents a data schema / domain model for relations on an {@link IEntityDefinition}.
|
|
8
|
+
*/
|
|
9
|
+
export interface IRelationDefinition extends IMemberDefinition {
|
|
10
|
+
/**
|
|
11
|
+
* Role of the relation on the {@link IEntityDefinition}.
|
|
12
|
+
* Parent and child entity definitions share the same conceptual relation definition.
|
|
13
|
+
*/
|
|
14
|
+
role: RelationRole;
|
|
15
|
+
/**
|
|
16
|
+
* Cardinality of the relation from the parent's point of view.
|
|
17
|
+
*/
|
|
18
|
+
cardinality: RelationCardinality;
|
|
19
|
+
/**
|
|
20
|
+
* Name of the {@link IEntityDefinition} that is linked to the other end ({@link RelationRole}) of this
|
|
21
|
+
* relation definition.
|
|
22
|
+
*/
|
|
23
|
+
associatedEntityDefinitionName: string;
|
|
24
|
+
/**
|
|
25
|
+
* Indicates whether relations of this definition must have at least one child.
|
|
26
|
+
*/
|
|
27
|
+
childIsMandatory: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Indicates whether relations of this definition must have at least one parent.
|
|
30
|
+
*/
|
|
31
|
+
parentIsMandatory: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* Indicates if this relation is used to inherit any security related meta data (parents -\> children).
|
|
34
|
+
*/
|
|
35
|
+
inheritsSecurity: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Indicates whether this relation can be used for navigation to parents or children in the external services
|
|
38
|
+
* (e.g. REST API). This can prevent potentially serious memory intensive operations.
|
|
39
|
+
*/
|
|
40
|
+
allowNavigation: boolean;
|
|
41
|
+
/**
|
|
42
|
+
* Indicates whether the relation allows nesting of properties on the associated entity when accessed via the
|
|
43
|
+
* external services (e.g. REST API).
|
|
44
|
+
*/
|
|
45
|
+
isNested: boolean;
|
|
46
|
+
/**
|
|
47
|
+
* Collection of the property names of the associated entity to be used for nesting.
|
|
48
|
+
*/
|
|
49
|
+
nestedProperties: Array<string>;
|
|
50
|
+
/**
|
|
51
|
+
* Indicates whether permissions are included when nesting this relation in an external service, in similar fashion
|
|
52
|
+
* as with property nesting.
|
|
53
|
+
*/
|
|
54
|
+
nestedPermissions: boolean;
|
|
55
|
+
/**
|
|
56
|
+
* Indicates whether the relation establishes a taxonomy.
|
|
57
|
+
*/
|
|
58
|
+
isTaxonomyRelation: boolean;
|
|
59
|
+
/**
|
|
60
|
+
* Indicates if the relation provides a link between parent and child taxonomy entities of the same entity
|
|
61
|
+
* definition, thus creating a taxonomy hierarchy.
|
|
62
|
+
*/
|
|
63
|
+
isTaxonomyHierarchyRelation: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Indicates if the child of the relation copies full text search content of the ancestors connected via such marked
|
|
66
|
+
* relations into its full text search
|
|
67
|
+
* content.
|
|
68
|
+
*/
|
|
69
|
+
contentIsCopied: boolean;
|
|
70
|
+
/**
|
|
71
|
+
* Indicates whether the child of the relation copies words collection, used for the auto–complete, of the ancestors
|
|
72
|
+
* connected via such marked relations into its collection of words used for the auto-complete functionality.
|
|
73
|
+
*/
|
|
74
|
+
completionIsCopied: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Indicates whether this relation provides a link between a parent entity with
|
|
77
|
+
* {@link IEntityDefinition.isPathEnabledDefinition} or an entity with such an ancestor.
|
|
78
|
+
*/
|
|
79
|
+
isPathRelation: boolean;
|
|
80
|
+
/**
|
|
81
|
+
* Indicates whether this relation provides a link between {@link IEntityDefinition.isPathEnabledDefinition}
|
|
82
|
+
* thus creating a path hierarchy.
|
|
83
|
+
*/
|
|
84
|
+
isPathHierarchyRelation: boolean;
|
|
85
|
+
/**
|
|
86
|
+
* Score given to the relation which is marked as {@link IsPathHierarchyRelation}.
|
|
87
|
+
* If entity has multiple parent hierarchy relations, the paths of entity will be sorted according to this score in
|
|
88
|
+
* ascending way. The first path, if not marked otherwise, will be used as a sole entity path when only one path is
|
|
89
|
+
* required.
|
|
90
|
+
*/
|
|
91
|
+
pathHierarchyScore: string;
|
|
92
|
+
/**
|
|
93
|
+
* Indicates whether this relation can be used to retrieve renditions.
|
|
94
|
+
*/
|
|
95
|
+
isRenditionRelation: boolean;
|
|
96
|
+
/**
|
|
97
|
+
* Collection of the culture specific member labels of the associated relation definition.
|
|
98
|
+
*/
|
|
99
|
+
associatedLabels: MapCultureTo<string>;
|
|
100
|
+
}
|
|
101
|
+
export declare class RelationDefinition extends MemberDefinition implements IRelationDefinition {
|
|
102
|
+
role: RelationRole;
|
|
103
|
+
cardinality: RelationCardinality;
|
|
104
|
+
associatedEntityDefinitionName: string;
|
|
105
|
+
childIsMandatory: boolean;
|
|
106
|
+
parentIsMandatory: boolean;
|
|
107
|
+
inheritsSecurity: boolean;
|
|
108
|
+
allowNavigation: boolean;
|
|
109
|
+
isNested: boolean;
|
|
110
|
+
nestedProperties: Array<string>;
|
|
111
|
+
nestedPermissions: boolean;
|
|
112
|
+
isTaxonomyRelation: boolean;
|
|
113
|
+
isTaxonomyHierarchyRelation: boolean;
|
|
114
|
+
contentIsCopied: boolean;
|
|
115
|
+
completionIsCopied: boolean;
|
|
116
|
+
isPathRelation: boolean;
|
|
117
|
+
isPathHierarchyRelation: boolean;
|
|
118
|
+
pathHierarchyScore: string;
|
|
119
|
+
isRenditionRelation: boolean;
|
|
120
|
+
associatedLabels: MapCultureTo<string>;
|
|
121
|
+
get definitionType(): MemberDefinitionType;
|
|
122
|
+
constructor(name: string, init?: Omit<Partial<RelationDefinition>, "name">);
|
|
123
|
+
}
|