@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,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Interface for member policies.
|
|
3
|
+
*/
|
|
4
|
+
export interface IMemberPolicy {
|
|
5
|
+
/**
|
|
6
|
+
* Gets or sets the name of the definition that contains the target.
|
|
7
|
+
*/
|
|
8
|
+
definitionName: string;
|
|
9
|
+
/**
|
|
10
|
+
* Gets or sets the member on the definition where the canRead and canWrite properties apply on.
|
|
11
|
+
*/
|
|
12
|
+
target: string;
|
|
13
|
+
/**
|
|
14
|
+
* Gets or sets whether the user(group) that has this policy can read the target.
|
|
15
|
+
*/
|
|
16
|
+
canRead: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* Gets or sets whether the user(group) that has this policy can write to the target.
|
|
19
|
+
*/
|
|
20
|
+
canWrite: boolean;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* A member policy.
|
|
24
|
+
*/
|
|
25
|
+
export declare class MemberPolicy implements IMemberPolicy {
|
|
26
|
+
definitionName: string;
|
|
27
|
+
target: string;
|
|
28
|
+
canRead: boolean;
|
|
29
|
+
canWrite: boolean;
|
|
30
|
+
constructor(init?: Partial<MemberPolicy>);
|
|
31
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.MemberPolicy = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* A member policy.
|
|
6
|
+
*/
|
|
7
|
+
class MemberPolicy {
|
|
8
|
+
constructor(init) {
|
|
9
|
+
Object.assign(this, init);
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
exports.MemberPolicy = MemberPolicy;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Nullable } from "../../base-types";
|
|
2
|
+
import { IMemberPolicy } from "../../contracts/policies/member-policy";
|
|
3
|
+
import { IRule } from "../../contracts/policies/rule";
|
|
4
|
+
export interface IPolicy {
|
|
5
|
+
readonly rules: Array<IRule>;
|
|
6
|
+
readonly memberSecurity: Array<IMemberPolicy>;
|
|
7
|
+
readonly memberGroupSecurity: Array<IMemberPolicy>;
|
|
8
|
+
getRelatedId(): Nullable<number>;
|
|
9
|
+
}
|
|
10
|
+
export declare abstract class Policy implements IPolicy {
|
|
11
|
+
rules: Array<IRule>;
|
|
12
|
+
memberSecurity: Array<IMemberPolicy>;
|
|
13
|
+
memberGroupSecurity: Array<IMemberPolicy>;
|
|
14
|
+
createdBy?: Nullable<number>;
|
|
15
|
+
createdOn?: Nullable<Date>;
|
|
16
|
+
modifiedBy?: Nullable<number>;
|
|
17
|
+
modifiedOn?: Nullable<Date>;
|
|
18
|
+
abstract getRelatedId(): Nullable<number>;
|
|
19
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RuleType = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Type of rule.
|
|
6
|
+
*/
|
|
7
|
+
var RuleType;
|
|
8
|
+
(function (RuleType) {
|
|
9
|
+
RuleType[RuleType["Regular"] = 0] = "Regular";
|
|
10
|
+
RuleType[RuleType["BuiltIn"] = 1] = "BuiltIn";
|
|
11
|
+
})(RuleType = exports.RuleType || (exports.RuleType = {}));
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { Nullable } from "../../base-types";
|
|
2
|
+
import { ICondition } from "./condition";
|
|
3
|
+
import { RuleType } from "./rule-type";
|
|
4
|
+
/**
|
|
5
|
+
* Describes a rule.
|
|
6
|
+
*/
|
|
7
|
+
export interface IRule {
|
|
8
|
+
/**
|
|
9
|
+
* Non null collection entity definition names which define the entity definitions to which this policy applies.
|
|
10
|
+
*/
|
|
11
|
+
definitionNames: Array<string>;
|
|
12
|
+
/**
|
|
13
|
+
* Unique identifier of the rule, usually GUID string.
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* This identifier is automatically generated by the system.
|
|
17
|
+
*/
|
|
18
|
+
identifier: Nullable<string>;
|
|
19
|
+
/**
|
|
20
|
+
* Non null collection of conditions which need to be fulfilled uniformly in order to trigger this rule
|
|
21
|
+
* (i.e. conditions are combined with "AND" logical operator).
|
|
22
|
+
*/
|
|
23
|
+
conditions: Array<ICondition>;
|
|
24
|
+
/**
|
|
25
|
+
* Non null collection of permissions this rule grands.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* The permissions are simple string constants recognized by the system.
|
|
29
|
+
*/
|
|
30
|
+
permissions: Array<string>;
|
|
31
|
+
/**
|
|
32
|
+
* If set to true, this rule only applies to entities created by the logged on user.
|
|
33
|
+
*/
|
|
34
|
+
createdByLoggedOnUser: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* The type of the rule.
|
|
37
|
+
*/
|
|
38
|
+
type: RuleType;
|
|
39
|
+
/**
|
|
40
|
+
* Indicates if this object is owned by the system and cannot be updated by users.
|
|
41
|
+
*/
|
|
42
|
+
isSystemOwned: boolean;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* {@inheritDoc}
|
|
46
|
+
*/
|
|
47
|
+
export declare class Rule implements IRule {
|
|
48
|
+
private _identifier;
|
|
49
|
+
definitionNames: Array<string>;
|
|
50
|
+
get identifier(): Nullable<string>;
|
|
51
|
+
conditions: Array<ICondition>;
|
|
52
|
+
permissions: Array<string>;
|
|
53
|
+
createdByLoggedOnUser: boolean;
|
|
54
|
+
type: RuleType;
|
|
55
|
+
isSystemOwned: boolean;
|
|
56
|
+
constructor(init?: Partial<IRule>);
|
|
57
|
+
setIdentifier(guid: Nullable<string>): void;
|
|
58
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Rule = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* {@inheritDoc}
|
|
6
|
+
*/
|
|
7
|
+
class Rule {
|
|
8
|
+
constructor(init) {
|
|
9
|
+
this._identifier = null;
|
|
10
|
+
Object.assign(this, init);
|
|
11
|
+
}
|
|
12
|
+
get identifier() {
|
|
13
|
+
return this._identifier;
|
|
14
|
+
}
|
|
15
|
+
setIdentifier(guid) {
|
|
16
|
+
this._identifier = guid;
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
exports.Rule = Rule;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { IPolicy, Policy } from "./policy";
|
|
2
|
+
export interface IUserGroupPolicy extends IPolicy {
|
|
3
|
+
readonly userGroupId: number;
|
|
4
|
+
}
|
|
5
|
+
export declare class UserGroupPolicy extends Policy implements IUserGroupPolicy {
|
|
6
|
+
userGroupId: number;
|
|
7
|
+
constructor(init?: Partial<UserGroupPolicy>);
|
|
8
|
+
getRelatedId(): number;
|
|
9
|
+
static isUserGroupPolicy(obj: any): obj is IUserGroupPolicy;
|
|
10
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.UserGroupPolicy = void 0;
|
|
4
|
+
const policy_1 = require("./policy");
|
|
5
|
+
class UserGroupPolicy extends policy_1.Policy {
|
|
6
|
+
constructor(init) {
|
|
7
|
+
super();
|
|
8
|
+
Object.assign(this, init);
|
|
9
|
+
}
|
|
10
|
+
getRelatedId() {
|
|
11
|
+
return this.userGroupId;
|
|
12
|
+
}
|
|
13
|
+
static isUserGroupPolicy(obj) {
|
|
14
|
+
return obj.hasOwnProperty("userGroupId") && typeof obj.userGroupId === "number";
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
exports.UserGroupPolicy = UserGroupPolicy;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { IPolicy, Policy } from "./policy";
|
|
2
|
+
export interface IUserPolicy extends IPolicy {
|
|
3
|
+
readonly userId: number;
|
|
4
|
+
}
|
|
5
|
+
export declare class UserPolicy extends Policy implements IUserPolicy {
|
|
6
|
+
userId: number;
|
|
7
|
+
constructor(init?: Partial<UserPolicy>);
|
|
8
|
+
getRelatedId(): number;
|
|
9
|
+
static isUserPolicy(obj: any): obj is IUserPolicy;
|
|
10
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.UserPolicy = void 0;
|
|
4
|
+
const policy_1 = require("./policy");
|
|
5
|
+
class UserPolicy extends policy_1.Policy {
|
|
6
|
+
constructor(init) {
|
|
7
|
+
super();
|
|
8
|
+
Object.assign(this, init);
|
|
9
|
+
}
|
|
10
|
+
getRelatedId() {
|
|
11
|
+
return this.userId;
|
|
12
|
+
}
|
|
13
|
+
static isUserPolicy(obj) {
|
|
14
|
+
return obj.hasOwnProperty("userId") && typeof obj.userId === "number";
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
exports.UserPolicy = UserPolicy;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import CultureInfo from "../../culture-info";
|
|
2
|
+
import { ILoadOption } from "./load-option";
|
|
3
|
+
import { LoadOption } from "./load-options";
|
|
4
|
+
/**
|
|
5
|
+
* Specifies which cultures to load.
|
|
6
|
+
*/
|
|
7
|
+
export interface ICultureLoadOption extends ILoadOption {
|
|
8
|
+
/**
|
|
9
|
+
* Gets a list of cultures names that need to be loaded.
|
|
10
|
+
* This is only useful when {@link LoadOption} is {@link LoadOption.Custom}.
|
|
11
|
+
*/
|
|
12
|
+
cultures: Array<CultureInfo>;
|
|
13
|
+
/**
|
|
14
|
+
* Creates a deep clone of this instance.
|
|
15
|
+
*/
|
|
16
|
+
deepClone(): ICultureLoadOption;
|
|
17
|
+
}
|
|
18
|
+
export declare class CultureLoadOption implements ICultureLoadOption {
|
|
19
|
+
/**
|
|
20
|
+
* Load no cultures.
|
|
21
|
+
*/
|
|
22
|
+
static readonly None: Readonly<ICultureLoadOption>;
|
|
23
|
+
/**
|
|
24
|
+
* Load the default culture.
|
|
25
|
+
*/
|
|
26
|
+
static readonly Default: Readonly<ICultureLoadOption>;
|
|
27
|
+
/**
|
|
28
|
+
* Load all cultures.
|
|
29
|
+
*/
|
|
30
|
+
static readonly All: Readonly<ICultureLoadOption>;
|
|
31
|
+
loadOption: LoadOption;
|
|
32
|
+
cultures: Array<CultureInfo>;
|
|
33
|
+
constructor(param?: LoadOption | Array<CultureInfo> | Partial<ICultureLoadOption> | CultureLoadOption);
|
|
34
|
+
deepClone(): ICultureLoadOption;
|
|
35
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
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 CultureLoadOption_1;
|
|
12
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
+
exports.CultureLoadOption = void 0;
|
|
14
|
+
const ta_json_1 = require("ta-json");
|
|
15
|
+
const load_options_1 = require("./load-options");
|
|
16
|
+
let CultureLoadOption = CultureLoadOption_1 = class CultureLoadOption {
|
|
17
|
+
constructor(param) {
|
|
18
|
+
var _a;
|
|
19
|
+
this.loadOption = load_options_1.LoadOption.None;
|
|
20
|
+
this.cultures = [];
|
|
21
|
+
if (param == null) {
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
else if (param instanceof CultureLoadOption_1) {
|
|
25
|
+
this.cultures = [...param.cultures];
|
|
26
|
+
this.loadOption = param.loadOption;
|
|
27
|
+
}
|
|
28
|
+
else if (param instanceof Array) {
|
|
29
|
+
this.cultures = [...param];
|
|
30
|
+
this.loadOption = this.cultures.length ? load_options_1.LoadOption.Custom : load_options_1.LoadOption.None;
|
|
31
|
+
}
|
|
32
|
+
else if (typeof param === "object") {
|
|
33
|
+
this.cultures = [...((_a = param.cultures) !== null && _a !== void 0 ? _a : [])];
|
|
34
|
+
this.loadOption = param.loadOption != null ? param.loadOption : load_options_1.LoadOption.Custom;
|
|
35
|
+
}
|
|
36
|
+
else {
|
|
37
|
+
this.loadOption = param;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
deepClone() {
|
|
41
|
+
return new CultureLoadOption_1({ cultures: [...this.cultures], loadOption: this.loadOption });
|
|
42
|
+
}
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* Load no cultures.
|
|
46
|
+
*/
|
|
47
|
+
CultureLoadOption.None = new CultureLoadOption_1(load_options_1.LoadOption.None);
|
|
48
|
+
/**
|
|
49
|
+
* Load the default culture.
|
|
50
|
+
*/
|
|
51
|
+
CultureLoadOption.Default = new CultureLoadOption_1(load_options_1.LoadOption.Default);
|
|
52
|
+
/**
|
|
53
|
+
* Load all cultures.
|
|
54
|
+
*/
|
|
55
|
+
CultureLoadOption.All = new CultureLoadOption_1(load_options_1.LoadOption.All);
|
|
56
|
+
__decorate([
|
|
57
|
+
ta_json_1.JsonProperty("load_option"),
|
|
58
|
+
__metadata("design:type", Number)
|
|
59
|
+
], CultureLoadOption.prototype, "loadOption", void 0);
|
|
60
|
+
__decorate([
|
|
61
|
+
ta_json_1.JsonProperty("cultures"),
|
|
62
|
+
ta_json_1.JsonElementType(String),
|
|
63
|
+
__metadata("design:type", Array)
|
|
64
|
+
], CultureLoadOption.prototype, "cultures", void 0);
|
|
65
|
+
CultureLoadOption = CultureLoadOption_1 = __decorate([
|
|
66
|
+
ta_json_1.JsonObject(),
|
|
67
|
+
__metadata("design:paramtypes", [Object])
|
|
68
|
+
], CultureLoadOption);
|
|
69
|
+
exports.CultureLoadOption = CultureLoadOption;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { IContentHubClient } from "../../clients/content-hub-client";
|
|
2
|
+
import { IIdIterator } from "./id-iterator";
|
|
3
|
+
import { IIdQueryResult } from "./id-query-result";
|
|
4
|
+
import { SkipTakeIteratorBase } from "./skip-take-iterator-base";
|
|
5
|
+
export declare class EntityDefinitionIdIterator extends SkipTakeIteratorBase<IIdQueryResult> implements IIdIterator {
|
|
6
|
+
private readonly _client;
|
|
7
|
+
constructor(client: IContentHubClient, param: number | IIdQueryResult);
|
|
8
|
+
getResultAsync(skip: number, take: number): Promise<IIdQueryResult>;
|
|
9
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
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.EntityDefinitionIdIterator = void 0;
|
|
16
|
+
const guard_1 = __importDefault(require("../../guard"));
|
|
17
|
+
const skip_take_iterator_base_1 = require("./skip-take-iterator-base");
|
|
18
|
+
class EntityDefinitionIdIterator extends skip_take_iterator_base_1.SkipTakeIteratorBase {
|
|
19
|
+
constructor(client, param) {
|
|
20
|
+
super(param);
|
|
21
|
+
guard_1.default.notNullOrUndefined(client);
|
|
22
|
+
this._client = client;
|
|
23
|
+
}
|
|
24
|
+
getResultAsync(skip, take) {
|
|
25
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
26
|
+
return yield this._client.entityDefinitions.getRangeIdsAsync(skip, take);
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
exports.EntityDefinitionIdIterator = EntityDefinitionIdIterator;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { IContentHubClient } from "../../clients/content-hub-client";
|
|
2
|
+
import { QueryResultBase } from "./entity-query-result";
|
|
3
|
+
import { IIdIterator } from "./id-iterator";
|
|
4
|
+
import { IIdQueryResult } from "./id-query-result";
|
|
5
|
+
export declare class EntityDefinitionIdQueryResult extends QueryResultBase<number> implements IIdQueryResult {
|
|
6
|
+
private readonly _client;
|
|
7
|
+
items: Array<number>;
|
|
8
|
+
constructor(client: IContentHubClient, items: Array<number>, totalItems: number, offset: number);
|
|
9
|
+
createIterator(): IIdIterator;
|
|
10
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
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.EntityDefinitionIdQueryResult = void 0;
|
|
7
|
+
const guard_1 = __importDefault(require("../../guard"));
|
|
8
|
+
const entity_definition_id_iterator_1 = require("./entity-definition-id-iterator");
|
|
9
|
+
const entity_query_result_1 = require("./entity-query-result");
|
|
10
|
+
class EntityDefinitionIdQueryResult extends entity_query_result_1.QueryResultBase {
|
|
11
|
+
constructor(client, items, totalItems, offset) {
|
|
12
|
+
super(totalItems, offset);
|
|
13
|
+
guard_1.default.notNullOrUndefined(client);
|
|
14
|
+
guard_1.default.notNullOrUndefined(items);
|
|
15
|
+
this._client = client;
|
|
16
|
+
this.items = items;
|
|
17
|
+
}
|
|
18
|
+
createIterator() {
|
|
19
|
+
return new entity_definition_id_iterator_1.EntityDefinitionIdIterator(this._client, this);
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
exports.EntityDefinitionIdQueryResult = EntityDefinitionIdQueryResult;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { Nullable } from "../../base-types";
|
|
2
|
+
import { IContentHubClient } from "../../clients/content-hub-client";
|
|
3
|
+
import { IEntityDefinitionQueryResult } from "./entity-definition-query-result";
|
|
4
|
+
import { IQueryIterator } from "./query-iterator";
|
|
5
|
+
import { SkipTakeIteratorBase } from "./skip-take-iterator-base";
|
|
6
|
+
/**
|
|
7
|
+
* An iterator for iterating over IEntityDefinition query results.
|
|
8
|
+
*/
|
|
9
|
+
export interface IEntityDefinitionIterator extends IQueryIterator<IEntityDefinitionQueryResult> {
|
|
10
|
+
}
|
|
11
|
+
export declare class EntityDefinitionIterator extends SkipTakeIteratorBase<IEntityDefinitionQueryResult> implements IEntityDefinitionIterator {
|
|
12
|
+
private readonly _client;
|
|
13
|
+
current: Nullable<IEntityDefinitionQueryResult>;
|
|
14
|
+
constructor(client: IContentHubClient, param: number | IEntityDefinitionQueryResult);
|
|
15
|
+
getResultAsync(skip: number, take: number): Promise<IEntityDefinitionQueryResult>;
|
|
16
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
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.EntityDefinitionIterator = void 0;
|
|
16
|
+
const guard_1 = __importDefault(require("../../guard"));
|
|
17
|
+
const skip_take_iterator_base_1 = require("./skip-take-iterator-base");
|
|
18
|
+
class EntityDefinitionIterator extends skip_take_iterator_base_1.SkipTakeIteratorBase {
|
|
19
|
+
constructor(client, param) {
|
|
20
|
+
super(param);
|
|
21
|
+
guard_1.default.notNullOrUndefined(client);
|
|
22
|
+
this._client = client;
|
|
23
|
+
}
|
|
24
|
+
getResultAsync(skip, take) {
|
|
25
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
26
|
+
return yield this._client.entityDefinitions.getRangeAsync(skip, take);
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
exports.EntityDefinitionIterator = EntityDefinitionIterator;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { IContentHubClient } from "../../clients/content-hub-client";
|
|
2
|
+
import { IEntityDefinition } from "../base";
|
|
3
|
+
import { IEntityDefinitionIterator } from "./entity-definition-iterator";
|
|
4
|
+
import { QueryResultBase } from "./entity-query-result";
|
|
5
|
+
import { IQueryResult } from "./query-result";
|
|
6
|
+
/**
|
|
7
|
+
* Query result containing {@link IEntityDefinition}s.
|
|
8
|
+
*/
|
|
9
|
+
export interface IEntityDefinitionQueryResult extends IQueryResult<IEntityDefinition> {
|
|
10
|
+
/**
|
|
11
|
+
* Creates an iterator you can easily iterate over the query results.
|
|
12
|
+
* The iterator can go back and forth all pages/batches of the query result.
|
|
13
|
+
*/
|
|
14
|
+
createIterator(): IEntityDefinitionIterator;
|
|
15
|
+
}
|
|
16
|
+
export declare class EntityDefinitionQueryResult extends QueryResultBase<IEntityDefinition> implements IEntityDefinitionQueryResult {
|
|
17
|
+
private readonly _client;
|
|
18
|
+
items: Array<IEntityDefinition>;
|
|
19
|
+
constructor(client: IContentHubClient, items: Array<IEntityDefinition>, totalItems: number, offset: number);
|
|
20
|
+
createIterator(): IEntityDefinitionIterator;
|
|
21
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
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.EntityDefinitionQueryResult = void 0;
|
|
7
|
+
const guard_1 = __importDefault(require("../../guard"));
|
|
8
|
+
const entity_definition_iterator_1 = require("./entity-definition-iterator");
|
|
9
|
+
const entity_query_result_1 = require("./entity-query-result");
|
|
10
|
+
class EntityDefinitionQueryResult extends entity_query_result_1.QueryResultBase {
|
|
11
|
+
constructor(client, items, totalItems, offset) {
|
|
12
|
+
super(totalItems, offset);
|
|
13
|
+
guard_1.default.notNullOrUndefined(client);
|
|
14
|
+
guard_1.default.notNullOrUndefined(items);
|
|
15
|
+
this._client = client;
|
|
16
|
+
this.items = items;
|
|
17
|
+
}
|
|
18
|
+
createIterator() {
|
|
19
|
+
return new entity_definition_iterator_1.EntityDefinitionIterator(this._client, this);
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
exports.EntityDefinitionQueryResult = EntityDefinitionQueryResult;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { IContentHubClient } from "../../clients/content-hub-client";
|
|
2
|
+
import { IEntityLoadConfiguration } from "./entity-load-configuration";
|
|
3
|
+
import { IEntityQueryResult } from "./entity-query-result";
|
|
4
|
+
import { LoadingQueryIteratorBase } from "./loading-query-iterator";
|
|
5
|
+
import { Query } from "./query";
|
|
6
|
+
import { IQueryIterator } from "./query-iterator";
|
|
7
|
+
export interface IEntityIterator extends IQueryIterator<IEntityQueryResult> {
|
|
8
|
+
}
|
|
9
|
+
export declare class EntityIterator extends LoadingQueryIteratorBase<IEntityQueryResult> implements IEntityIterator {
|
|
10
|
+
private readonly _client;
|
|
11
|
+
constructor(client: IContentHubClient, query: Query, loadConfiguration: IEntityLoadConfiguration, result?: IEntityQueryResult);
|
|
12
|
+
getResultAsync(query: Query, loadConfiguration: IEntityLoadConfiguration): Promise<IEntityQueryResult>;
|
|
13
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
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.EntityIterator = void 0;
|
|
16
|
+
const guard_1 = __importDefault(require("../../guard"));
|
|
17
|
+
const loading_query_iterator_1 = require("./loading-query-iterator");
|
|
18
|
+
class EntityIterator extends loading_query_iterator_1.LoadingQueryIteratorBase {
|
|
19
|
+
constructor(client, query, loadConfiguration, result) {
|
|
20
|
+
super(query, loadConfiguration, result);
|
|
21
|
+
guard_1.default.notNullOrUndefined(client);
|
|
22
|
+
this._client = client;
|
|
23
|
+
}
|
|
24
|
+
getResultAsync(query, loadConfiguration) {
|
|
25
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
26
|
+
return this._client.querying.queryAsync(query, loadConfiguration);
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
exports.EntityIterator = EntityIterator;
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { RelationRole } from "../../contracts/base";
|
|
2
|
+
import CultureInfo from "../../culture-info";
|
|
3
|
+
import { IEntityLoadConfiguration } from "./entity-load-configuration";
|
|
4
|
+
import { LoadOption } from "./load-options";
|
|
5
|
+
import { IRelationSpecification } from "./relation-specification";
|
|
6
|
+
/**
|
|
7
|
+
* An interface for a builder for instances of {@link IEntityLoadConfiguration}.
|
|
8
|
+
*/
|
|
9
|
+
export interface IEntityLoadConfigurationBuilder {
|
|
10
|
+
/**
|
|
11
|
+
* Indicates that entities should be loaded in the cultures specified by the load option.
|
|
12
|
+
* @param loadOption - The load option
|
|
13
|
+
*/
|
|
14
|
+
inCultures(loadOption: LoadOption): IEntityLoadConfigurationBuilder;
|
|
15
|
+
/**
|
|
16
|
+
* Indicates that entities should be loaded in the specified cultures.
|
|
17
|
+
* @param culture - The cultures
|
|
18
|
+
*/
|
|
19
|
+
inCultures(cultures: Array<CultureInfo>): IEntityLoadConfigurationBuilder;
|
|
20
|
+
/**
|
|
21
|
+
* Indicates that entities should be loaded in the specified culture.
|
|
22
|
+
* @param culture - The culture
|
|
23
|
+
*/
|
|
24
|
+
inCulture(culture: CultureInfo): IEntityLoadConfigurationBuilder;
|
|
25
|
+
/**
|
|
26
|
+
* Indicates that entities should be loaded with the properties specified by the load option.
|
|
27
|
+
* @param loadOption - The load option
|
|
28
|
+
*/
|
|
29
|
+
withProperties(loadOption: LoadOption): IEntityLoadConfigurationBuilder;
|
|
30
|
+
/**
|
|
31
|
+
* Indicates that entities should be loaded with the specified properties.
|
|
32
|
+
* @param properties - The properties
|
|
33
|
+
*/
|
|
34
|
+
withProperties(properties: Array<string>): IEntityLoadConfigurationBuilder;
|
|
35
|
+
/**
|
|
36
|
+
* Indicates that entities should be loaded with the specified property.
|
|
37
|
+
* @param property - The name of the property
|
|
38
|
+
*/
|
|
39
|
+
withProperty(property: string): IEntityLoadConfigurationBuilder;
|
|
40
|
+
/**
|
|
41
|
+
* Indicates that entities should be loaded with the relations specified by the load option.
|
|
42
|
+
* @param loadOption - The load option
|
|
43
|
+
*/
|
|
44
|
+
withRelations(loadOption: LoadOption): IEntityLoadConfigurationBuilder;
|
|
45
|
+
/**
|
|
46
|
+
* Indicates that entities should be loaded with the specified relations.
|
|
47
|
+
* @param relations - The relations
|
|
48
|
+
*/
|
|
49
|
+
withRelations(relations: Array<string>): IEntityLoadConfigurationBuilder;
|
|
50
|
+
/**
|
|
51
|
+
* Indicates that entities should be loaded with the specified relation specifications.
|
|
52
|
+
* @param specifications - The relation specifications
|
|
53
|
+
*/
|
|
54
|
+
withRelations(specifications: Array<IRelationSpecification>): IEntityLoadConfigurationBuilder;
|
|
55
|
+
/**
|
|
56
|
+
* Indicates that entities should be loaded with the specified relation in the specified role.
|
|
57
|
+
* @param relation - The name of the relation
|
|
58
|
+
* @param role - The role of the relation
|
|
59
|
+
*/
|
|
60
|
+
withRelation(relation: string, role?: RelationRole): IEntityLoadConfigurationBuilder;
|
|
61
|
+
/**
|
|
62
|
+
* Gets the resulting instance of {@link IEntityLoadConfiguration}.
|
|
63
|
+
*/
|
|
64
|
+
build(): IEntityLoadConfiguration;
|
|
65
|
+
}
|
|
66
|
+
export declare class EntityLoadConfigurationBuilder implements IEntityLoadConfigurationBuilder {
|
|
67
|
+
private readonly _entityLoadConfiguration;
|
|
68
|
+
constructor(entityLoadConfiguration?: IEntityLoadConfiguration);
|
|
69
|
+
inCultures(option: LoadOption | Array<CultureInfo>): IEntityLoadConfigurationBuilder;
|
|
70
|
+
inCulture(culture: CultureInfo): IEntityLoadConfigurationBuilder;
|
|
71
|
+
withProperties(option: LoadOption | Array<string>): IEntityLoadConfigurationBuilder;
|
|
72
|
+
withProperty(property: string): IEntityLoadConfigurationBuilder;
|
|
73
|
+
withRelations(option: LoadOption | Array<string | IRelationSpecification>): IEntityLoadConfigurationBuilder;
|
|
74
|
+
withRelation(relation: string, role?: RelationRole): IEntityLoadConfigurationBuilder;
|
|
75
|
+
build(): Readonly<IEntityLoadConfiguration>;
|
|
76
|
+
}
|