@uipath/uipath-typescript 1.0.0-beta.11 → 1.0.0-beta.13
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/dist/index.d.ts +3902 -15
- package/dist/index.esm.js +5278 -0
- package/dist/index.js +5343 -19
- package/package.json +11 -4
- package/dist/core/auth/service.d.ts +0 -72
- package/dist/core/auth/service.d.ts.map +0 -1
- package/dist/core/auth/service.js +0 -244
- package/dist/core/auth/service.js.map +0 -1
- package/dist/core/auth/token-manager.d.ts +0 -82
- package/dist/core/auth/token-manager.d.ts.map +0 -1
- package/dist/core/auth/token-manager.js +0 -248
- package/dist/core/auth/token-manager.js.map +0 -1
- package/dist/core/auth/types.d.ts +0 -20
- package/dist/core/auth/types.d.ts.map +0 -1
- package/dist/core/auth/types.js +0 -2
- package/dist/core/auth/types.js.map +0 -1
- package/dist/core/config/config-utils.d.ts +0 -4
- package/dist/core/config/config-utils.d.ts.map +0 -1
- package/dist/core/config/config-utils.js +0 -13
- package/dist/core/config/config-utils.js.map +0 -1
- package/dist/core/config/config.d.ts +0 -48
- package/dist/core/config/config.d.ts.map +0 -1
- package/dist/core/config/config.js +0 -22
- package/dist/core/config/config.js.map +0 -1
- package/dist/core/config/sdk-config.d.ts +0 -33
- package/dist/core/config/sdk-config.d.ts.map +0 -1
- package/dist/core/config/sdk-config.js +0 -9
- package/dist/core/config/sdk-config.js.map +0 -1
- package/dist/core/context/execution.d.ts +0 -35
- package/dist/core/context/execution.d.ts.map +0 -1
- package/dist/core/context/execution.js +0 -55
- package/dist/core/context/execution.js.map +0 -1
- package/dist/core/errors/authentication.d.ts +0 -13
- package/dist/core/errors/authentication.d.ts.map +0 -1
- package/dist/core/errors/authentication.js +0 -19
- package/dist/core/errors/authentication.js.map +0 -1
- package/dist/core/errors/authorization.d.ts +0 -13
- package/dist/core/errors/authorization.d.ts.map +0 -1
- package/dist/core/errors/authorization.js +0 -19
- package/dist/core/errors/authorization.js.map +0 -1
- package/dist/core/errors/base.d.ts +0 -41
- package/dist/core/errors/base.d.ts.map +0 -1
- package/dist/core/errors/base.js +0 -37
- package/dist/core/errors/base.js.map +0 -1
- package/dist/core/errors/constants.d.ts +0 -57
- package/dist/core/errors/constants.d.ts.map +0 -1
- package/dist/core/errors/constants.js +0 -66
- package/dist/core/errors/constants.js.map +0 -1
- package/dist/core/errors/error-factory.d.ts +0 -17
- package/dist/core/errors/error-factory.d.ts.map +0 -1
- package/dist/core/errors/error-factory.js +0 -57
- package/dist/core/errors/error-factory.js.map +0 -1
- package/dist/core/errors/guards.d.ts +0 -48
- package/dist/core/errors/guards.d.ts.map +0 -1
- package/dist/core/errors/guards.js +0 -76
- package/dist/core/errors/guards.js.map +0 -1
- package/dist/core/errors/index.d.ts +0 -11
- package/dist/core/errors/index.d.ts.map +0 -1
- package/dist/core/errors/index.js +0 -15
- package/dist/core/errors/index.js.map +0 -1
- package/dist/core/errors/network.d.ts +0 -14
- package/dist/core/errors/network.d.ts.map +0 -1
- package/dist/core/errors/network.js +0 -20
- package/dist/core/errors/network.js.map +0 -1
- package/dist/core/errors/not-found.d.ts +0 -13
- package/dist/core/errors/not-found.d.ts.map +0 -1
- package/dist/core/errors/not-found.js +0 -19
- package/dist/core/errors/not-found.js.map +0 -1
- package/dist/core/errors/parser.d.ts +0 -29
- package/dist/core/errors/parser.d.ts.map +0 -1
- package/dist/core/errors/parser.js +0 -152
- package/dist/core/errors/parser.js.map +0 -1
- package/dist/core/errors/rate-limit.d.ts +0 -12
- package/dist/core/errors/rate-limit.d.ts.map +0 -1
- package/dist/core/errors/rate-limit.js +0 -18
- package/dist/core/errors/rate-limit.js.map +0 -1
- package/dist/core/errors/server.d.ts +0 -17
- package/dist/core/errors/server.d.ts.map +0 -1
- package/dist/core/errors/server.js +0 -27
- package/dist/core/errors/server.js.map +0 -1
- package/dist/core/errors/types.d.ts +0 -94
- package/dist/core/errors/types.d.ts.map +0 -1
- package/dist/core/errors/types.js +0 -28
- package/dist/core/errors/types.js.map +0 -1
- package/dist/core/errors/validation.d.ts +0 -13
- package/dist/core/errors/validation.d.ts.map +0 -1
- package/dist/core/errors/validation.js +0 -19
- package/dist/core/errors/validation.js.map +0 -1
- package/dist/core/http/api-client.d.ts +0 -30
- package/dist/core/http/api-client.d.ts.map +0 -1
- package/dist/core/http/api-client.js +0 -131
- package/dist/core/http/api-client.js.map +0 -1
- package/dist/core/telemetry/client.d.ts +0 -34
- package/dist/core/telemetry/client.d.ts.map +0 -1
- package/dist/core/telemetry/client.js +0 -189
- package/dist/core/telemetry/client.js.map +0 -1
- package/dist/core/telemetry/constants.d.ts +0 -19
- package/dist/core/telemetry/constants.d.ts.map +0 -1
- package/dist/core/telemetry/constants.js +0 -24
- package/dist/core/telemetry/constants.js.map +0 -1
- package/dist/core/telemetry/index.d.ts +0 -7
- package/dist/core/telemetry/index.d.ts.map +0 -1
- package/dist/core/telemetry/index.js +0 -7
- package/dist/core/telemetry/index.js.map +0 -1
- package/dist/core/telemetry/track.d.ts +0 -26
- package/dist/core/telemetry/track.d.ts.map +0 -1
- package/dist/core/telemetry/track.js +0 -67
- package/dist/core/telemetry/track.js.map +0 -1
- package/dist/core/telemetry/types.d.ts +0 -18
- package/dist/core/telemetry/types.d.ts.map +0 -1
- package/dist/core/telemetry/types.js +0 -5
- package/dist/core/telemetry/types.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/models/action-center/index.d.ts +0 -3
- package/dist/models/action-center/index.d.ts.map +0 -1
- package/dist/models/action-center/index.js +0 -3
- package/dist/models/action-center/index.js.map +0 -1
- package/dist/models/action-center/tasks.constants.d.ts +0 -12
- package/dist/models/action-center/tasks.constants.d.ts.map +0 -1
- package/dist/models/action-center/tasks.constants.js +0 -18
- package/dist/models/action-center/tasks.constants.js.map +0 -1
- package/dist/models/action-center/tasks.internal-types.d.ts +0 -13
- package/dist/models/action-center/tasks.internal-types.d.ts.map +0 -1
- package/dist/models/action-center/tasks.internal-types.js +0 -2
- package/dist/models/action-center/tasks.internal-types.js.map +0 -1
- package/dist/models/action-center/tasks.models.d.ts +0 -79
- package/dist/models/action-center/tasks.models.d.ts.map +0 -1
- package/dist/models/action-center/tasks.models.js +0 -60
- package/dist/models/action-center/tasks.models.js.map +0 -1
- package/dist/models/action-center/tasks.types.d.ts +0 -180
- package/dist/models/action-center/tasks.types.d.ts.map +0 -1
- package/dist/models/action-center/tasks.types.js +0 -40
- package/dist/models/action-center/tasks.types.js.map +0 -1
- package/dist/models/common/index.d.ts +0 -3
- package/dist/models/common/index.d.ts.map +0 -1
- package/dist/models/common/index.js +0 -3
- package/dist/models/common/index.js.map +0 -1
- package/dist/models/common/request-spec.d.ts +0 -89
- package/dist/models/common/request-spec.d.ts.map +0 -1
- package/dist/models/common/request-spec.js +0 -2
- package/dist/models/common/request-spec.js.map +0 -1
- package/dist/models/common/types.d.ts +0 -43
- package/dist/models/common/types.d.ts.map +0 -1
- package/dist/models/common/types.js +0 -16
- package/dist/models/common/types.js.map +0 -1
- package/dist/models/data-fabric/entities.constants.d.ts +0 -32
- package/dist/models/data-fabric/entities.constants.d.ts.map +0 -1
- package/dist/models/data-fabric/entities.constants.js +0 -46
- package/dist/models/data-fabric/entities.constants.js.map +0 -1
- package/dist/models/data-fabric/entities.internal-types.d.ts +0 -12
- package/dist/models/data-fabric/entities.internal-types.d.ts.map +0 -1
- package/dist/models/data-fabric/entities.internal-types.js +0 -2
- package/dist/models/data-fabric/entities.internal-types.js.map +0 -1
- package/dist/models/data-fabric/entities.models.d.ts +0 -213
- package/dist/models/data-fabric/entities.models.d.ts.map +0 -1
- package/dist/models/data-fabric/entities.models.js +0 -43
- package/dist/models/data-fabric/entities.models.js.map +0 -1
- package/dist/models/data-fabric/entities.types.d.ts +0 -264
- package/dist/models/data-fabric/entities.types.d.ts.map +0 -1
- package/dist/models/data-fabric/entities.types.js +0 -63
- package/dist/models/data-fabric/entities.types.js.map +0 -1
- package/dist/models/data-fabric/index.d.ts +0 -3
- package/dist/models/data-fabric/index.d.ts.map +0 -1
- package/dist/models/data-fabric/index.js +0 -3
- package/dist/models/data-fabric/index.js.map +0 -1
- package/dist/models/index.d.ts +0 -6
- package/dist/models/index.d.ts.map +0 -1
- package/dist/models/index.js +0 -11
- package/dist/models/index.js.map +0 -1
- package/dist/models/maestro/index.d.ts +0 -5
- package/dist/models/maestro/index.d.ts.map +0 -1
- package/dist/models/maestro/index.js +0 -8
- package/dist/models/maestro/index.js.map +0 -1
- package/dist/models/maestro/process-instances.constants.d.ts +0 -13
- package/dist/models/maestro/process-instances.constants.d.ts.map +0 -1
- package/dist/models/maestro/process-instances.constants.js +0 -17
- package/dist/models/maestro/process-instances.constants.js.map +0 -1
- package/dist/models/maestro/process-instances.models.d.ts +0 -210
- package/dist/models/maestro/process-instances.models.d.ts.map +0 -1
- package/dist/models/maestro/process-instances.models.js +0 -38
- package/dist/models/maestro/process-instances.models.js.map +0 -1
- package/dist/models/maestro/process-instances.types.d.ts +0 -78
- package/dist/models/maestro/process-instances.types.d.ts.map +0 -1
- package/dist/models/maestro/process-instances.types.js +0 -6
- package/dist/models/maestro/process-instances.types.js.map +0 -1
- package/dist/models/maestro/processes.models.d.ts +0 -31
- package/dist/models/maestro/processes.models.d.ts.map +0 -1
- package/dist/models/maestro/processes.models.js +0 -6
- package/dist/models/maestro/processes.models.js.map +0 -1
- package/dist/models/maestro/processes.types.d.ts +0 -42
- package/dist/models/maestro/processes.types.d.ts.map +0 -1
- package/dist/models/maestro/processes.types.js +0 -6
- package/dist/models/maestro/processes.types.js.map +0 -1
- package/dist/models/orchestrator/assets.constants.d.ts +0 -7
- package/dist/models/orchestrator/assets.constants.d.ts.map +0 -1
- package/dist/models/orchestrator/assets.constants.js +0 -8
- package/dist/models/orchestrator/assets.constants.js.map +0 -1
- package/dist/models/orchestrator/assets.models.d.ts +0 -55
- package/dist/models/orchestrator/assets.models.d.ts.map +0 -1
- package/dist/models/orchestrator/assets.models.js +0 -2
- package/dist/models/orchestrator/assets.models.js.map +0 -1
- package/dist/models/orchestrator/assets.types.d.ts +0 -65
- package/dist/models/orchestrator/assets.types.d.ts.map +0 -1
- package/dist/models/orchestrator/assets.types.js +0 -24
- package/dist/models/orchestrator/assets.types.js.map +0 -1
- package/dist/models/orchestrator/buckets.constants.d.ts +0 -7
- package/dist/models/orchestrator/buckets.constants.d.ts.map +0 -1
- package/dist/models/orchestrator/buckets.constants.js +0 -9
- package/dist/models/orchestrator/buckets.constants.js.map +0 -1
- package/dist/models/orchestrator/buckets.models.d.ts +0 -144
- package/dist/models/orchestrator/buckets.models.d.ts.map +0 -1
- package/dist/models/orchestrator/buckets.models.js +0 -2
- package/dist/models/orchestrator/buckets.models.js.map +0 -1
- package/dist/models/orchestrator/buckets.types.d.ts +0 -176
- package/dist/models/orchestrator/buckets.types.d.ts.map +0 -1
- package/dist/models/orchestrator/buckets.types.js +0 -8
- package/dist/models/orchestrator/buckets.types.js.map +0 -1
- package/dist/models/orchestrator/index.d.ts +0 -9
- package/dist/models/orchestrator/index.d.ts.map +0 -1
- package/dist/models/orchestrator/index.js +0 -13
- package/dist/models/orchestrator/index.js.map +0 -1
- package/dist/models/orchestrator/processes.constants.d.ts +0 -7
- package/dist/models/orchestrator/processes.constants.d.ts.map +0 -1
- package/dist/models/orchestrator/processes.constants.js +0 -17
- package/dist/models/orchestrator/processes.constants.js.map +0 -1
- package/dist/models/orchestrator/processes.models.d.ts +0 -87
- package/dist/models/orchestrator/processes.models.d.ts.map +0 -1
- package/dist/models/orchestrator/processes.models.js +0 -2
- package/dist/models/orchestrator/processes.models.js.map +0 -1
- package/dist/models/orchestrator/processes.types.d.ts +0 -293
- package/dist/models/orchestrator/processes.types.d.ts.map +0 -1
- package/dist/models/orchestrator/processes.types.js +0 -110
- package/dist/models/orchestrator/processes.types.js.map +0 -1
- package/dist/models/orchestrator/queues.constants.d.ts +0 -7
- package/dist/models/orchestrator/queues.constants.d.ts.map +0 -1
- package/dist/models/orchestrator/queues.constants.js +0 -9
- package/dist/models/orchestrator/queues.constants.js.map +0 -1
- package/dist/models/orchestrator/queues.models.d.ts +0 -61
- package/dist/models/orchestrator/queues.models.d.ts.map +0 -1
- package/dist/models/orchestrator/queues.models.js +0 -2
- package/dist/models/orchestrator/queues.models.js.map +0 -1
- package/dist/models/orchestrator/queues.types.d.ts +0 -39
- package/dist/models/orchestrator/queues.types.d.ts.map +0 -1
- package/dist/models/orchestrator/queues.types.js +0 -2
- package/dist/models/orchestrator/queues.types.js.map +0 -1
- package/dist/services/action-center/index.d.ts +0 -2
- package/dist/services/action-center/index.d.ts.map +0 -1
- package/dist/services/action-center/index.js +0 -2
- package/dist/services/action-center/index.js.map +0 -1
- package/dist/services/action-center/tasks.d.ts +0 -254
- package/dist/services/action-center/tasks.d.ts.map +0 -1
- package/dist/services/action-center/tasks.js +0 -446
- package/dist/services/action-center/tasks.js.map +0 -1
- package/dist/services/base.d.ts +0 -49
- package/dist/services/base.d.ts.map +0 -1
- package/dist/services/base.js +0 -183
- package/dist/services/base.js.map +0 -1
- package/dist/services/data-fabric/entities.d.ts +0 -180
- package/dist/services/data-fabric/entities.d.ts.map +0 -1
- package/dist/services/data-fabric/entities.js +0 -326
- package/dist/services/data-fabric/entities.js.map +0 -1
- package/dist/services/data-fabric/index.d.ts +0 -2
- package/dist/services/data-fabric/index.d.ts.map +0 -1
- package/dist/services/data-fabric/index.js +0 -2
- package/dist/services/data-fabric/index.js.map +0 -1
- package/dist/services/folder-scoped.d.ts +0 -21
- package/dist/services/folder-scoped.d.ts.map +0 -1
- package/dist/services/folder-scoped.js +0 -36
- package/dist/services/folder-scoped.js.map +0 -1
- package/dist/services/index.d.ts +0 -6
- package/dist/services/index.d.ts.map +0 -1
- package/dist/services/index.js +0 -6
- package/dist/services/index.js.map +0 -1
- package/dist/services/maestro/index.d.ts +0 -3
- package/dist/services/maestro/index.d.ts.map +0 -1
- package/dist/services/maestro/index.js +0 -3
- package/dist/services/maestro/index.js.map +0 -1
- package/dist/services/maestro/maestro-processes.d.ts +0 -35
- package/dist/services/maestro/maestro-processes.d.ts.map +0 -1
- package/dist/services/maestro/maestro-processes.js +0 -47
- package/dist/services/maestro/maestro-processes.js.map +0 -1
- package/dist/services/maestro/process-instances.d.ts +0 -96
- package/dist/services/maestro/process-instances.d.ts.map +0 -1
- package/dist/services/maestro/process-instances.js +0 -190
- package/dist/services/maestro/process-instances.js.map +0 -1
- package/dist/services/orchestrator/assets.d.ts +0 -63
- package/dist/services/orchestrator/assets.d.ts.map +0 -1
- package/dist/services/orchestrator/assets.js +0 -110
- package/dist/services/orchestrator/assets.js.map +0 -1
- package/dist/services/orchestrator/buckets.d.ts +0 -186
- package/dist/services/orchestrator/buckets.d.ts.map +0 -1
- package/dist/services/orchestrator/buckets.js +0 -436
- package/dist/services/orchestrator/buckets.js.map +0 -1
- package/dist/services/orchestrator/index.d.ts +0 -5
- package/dist/services/orchestrator/index.d.ts.map +0 -1
- package/dist/services/orchestrator/index.js +0 -5
- package/dist/services/orchestrator/index.js.map +0 -1
- package/dist/services/orchestrator/processes.d.ts +0 -96
- package/dist/services/orchestrator/processes.d.ts.map +0 -1
- package/dist/services/orchestrator/processes.js +0 -172
- package/dist/services/orchestrator/processes.js.map +0 -1
- package/dist/services/orchestrator/queues.d.ts +0 -72
- package/dist/services/orchestrator/queues.d.ts.map +0 -1
- package/dist/services/orchestrator/queues.js +0 -117
- package/dist/services/orchestrator/queues.js.map +0 -1
- package/dist/uipath.d.ts +0 -65
- package/dist/uipath.d.ts.map +0 -1
- package/dist/uipath.js +0 -146
- package/dist/uipath.js.map +0 -1
- package/dist/utils/constants/common.d.ts +0 -84
- package/dist/utils/constants/common.d.ts.map +0 -1
- package/dist/utils/constants/common.js +0 -84
- package/dist/utils/constants/common.js.map +0 -1
- package/dist/utils/constants/endpoints.d.ts +0 -96
- package/dist/utils/constants/endpoints.d.ts.map +0 -1
- package/dist/utils/constants/endpoints.js +0 -96
- package/dist/utils/constants/endpoints.js.map +0 -1
- package/dist/utils/constants/headers.d.ts +0 -27
- package/dist/utils/constants/headers.d.ts.map +0 -1
- package/dist/utils/constants/headers.js +0 -27
- package/dist/utils/constants/headers.js.map +0 -1
- package/dist/utils/http/headers.d.ts +0 -37
- package/dist/utils/http/headers.d.ts.map +0 -1
- package/dist/utils/http/headers.js +0 -51
- package/dist/utils/http/headers.js.map +0 -1
- package/dist/utils/http/params.d.ts +0 -27
- package/dist/utils/http/params.d.ts.map +0 -1
- package/dist/utils/http/params.js +0 -35
- package/dist/utils/http/params.js.map +0 -1
- package/dist/utils/object.d.ts +0 -32
- package/dist/utils/object.d.ts.map +0 -1
- package/dist/utils/object.js +0 -50
- package/dist/utils/object.js.map +0 -1
- package/dist/utils/pagination/constants.d.ts +0 -18
- package/dist/utils/pagination/constants.d.ts.map +0 -1
- package/dist/utils/pagination/constants.js +0 -23
- package/dist/utils/pagination/constants.js.map +0 -1
- package/dist/utils/pagination/helpers.d.ts +0 -62
- package/dist/utils/pagination/helpers.d.ts.map +0 -1
- package/dist/utils/pagination/helpers.js +0 -254
- package/dist/utils/pagination/helpers.js.map +0 -1
- package/dist/utils/pagination/index.d.ts +0 -3
- package/dist/utils/pagination/index.d.ts.map +0 -1
- package/dist/utils/pagination/index.js +0 -3
- package/dist/utils/pagination/index.js.map +0 -1
- package/dist/utils/pagination/internal-types.d.ts +0 -184
- package/dist/utils/pagination/internal-types.d.ts.map +0 -1
- package/dist/utils/pagination/internal-types.js +0 -9
- package/dist/utils/pagination/internal-types.js.map +0 -1
- package/dist/utils/pagination/pagination-manager.d.ts +0 -17
- package/dist/utils/pagination/pagination-manager.d.ts.map +0 -1
- package/dist/utils/pagination/pagination-manager.js +0 -76
- package/dist/utils/pagination/pagination-manager.js.map +0 -1
- package/dist/utils/pagination/types.d.ts +0 -68
- package/dist/utils/pagination/types.d.ts.map +0 -1
- package/dist/utils/pagination/types.js +0 -2
- package/dist/utils/pagination/types.js.map +0 -1
- package/dist/utils/platform.d.ts +0 -8
- package/dist/utils/platform.d.ts.map +0 -1
- package/dist/utils/platform.js +0 -8
- package/dist/utils/platform.js.map +0 -1
- package/dist/utils/transform.d.ts +0 -240
- package/dist/utils/transform.d.ts.map +0 -1
- package/dist/utils/transform.js +0 -334
- package/dist/utils/transform.js.map +0 -1
package/dist/utils/object.js
DELETED
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Collection of utility functions for working with objects
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* Filters out undefined values from an object
|
|
6
|
-
* @param obj The source object
|
|
7
|
-
* @returns A new object without undefined values
|
|
8
|
-
*
|
|
9
|
-
* @example
|
|
10
|
-
* ```typescript
|
|
11
|
-
* // Object with undefined values
|
|
12
|
-
* const options = {
|
|
13
|
-
* name: 'test',
|
|
14
|
-
* count: 5,
|
|
15
|
-
* prefix: undefined,
|
|
16
|
-
* suffix: null
|
|
17
|
-
* };
|
|
18
|
-
* const result = filterUndefined(options);
|
|
19
|
-
* // result = { name: 'test', count: 5, suffix: null }
|
|
20
|
-
* ```
|
|
21
|
-
*/
|
|
22
|
-
export function filterUndefined(obj) {
|
|
23
|
-
const result = {};
|
|
24
|
-
for (const [key, value] of Object.entries(obj)) {
|
|
25
|
-
if (value !== undefined) {
|
|
26
|
-
result[key] = value;
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
return result;
|
|
30
|
-
}
|
|
31
|
-
/**
|
|
32
|
-
* Helper function for OData responses that ALWAYS return 200 with array indication
|
|
33
|
-
* Empty array = success, Non-empty array = error
|
|
34
|
-
* Used for task assignment APIs that don't use HTTP status codes for errors
|
|
35
|
-
*/
|
|
36
|
-
export function processODataArrayResponse(oDataResponse, successData) {
|
|
37
|
-
// Empty array = success
|
|
38
|
-
if (oDataResponse.value.length === 0) {
|
|
39
|
-
return {
|
|
40
|
-
success: true,
|
|
41
|
-
data: successData
|
|
42
|
-
};
|
|
43
|
-
}
|
|
44
|
-
// Non-empty array = error details
|
|
45
|
-
return {
|
|
46
|
-
success: false,
|
|
47
|
-
data: oDataResponse.value
|
|
48
|
-
};
|
|
49
|
-
}
|
|
50
|
-
//# sourceMappingURL=object.js.map
|
package/dist/utils/object.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/utils/object.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,eAAe,CAAgC,GAAM;IACnE,MAAM,MAAM,GAAe,EAAE,CAAC;IAE9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,GAAc,CAAC,GAAG,KAAK,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,aAAsC,EACtC,WAAkB;IAElB,wBAAwB;IACxB,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO;YACL,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,WAAW;SAClB,CAAC;IACJ,CAAC;IAED,kCAAkC;IAClC,OAAO;QACL,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,aAAa,CAAC,KAAK;KAC1B,CAAC;AACJ,CAAC"}
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Constants used throughout the pagination system
|
|
3
|
-
*/
|
|
4
|
-
/** Maximum number of items that can be requested in a single page */
|
|
5
|
-
export declare const MAX_PAGE_SIZE = 1000;
|
|
6
|
-
/** Default page size when jumpToPage is used without specifying pageSize */
|
|
7
|
-
export declare const DEFAULT_PAGE_SIZE = 50;
|
|
8
|
-
/** Default field name for items in a paginated response */
|
|
9
|
-
export declare const DEFAULT_ITEMS_FIELD = "value";
|
|
10
|
-
/** Default field name for total count in a paginated response */
|
|
11
|
-
export declare const DEFAULT_TOTAL_COUNT_FIELD = "@odata.count";
|
|
12
|
-
/**
|
|
13
|
-
* Limits the page size to the maximum allowed value
|
|
14
|
-
* @param pageSize - Requested page size
|
|
15
|
-
* @returns Limited page size value
|
|
16
|
-
*/
|
|
17
|
-
export declare function getLimitedPageSize(pageSize?: number): number;
|
|
18
|
-
//# sourceMappingURL=constants.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/utils/pagination/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,qEAAqE;AACrE,eAAO,MAAM,aAAa,OAAO,CAAC;AAElC,4EAA4E;AAC5E,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,2DAA2D;AAC3D,eAAO,MAAM,mBAAmB,UAAU,CAAC;AAE3C,iEAAiE;AACjE,eAAO,MAAM,yBAAyB,iBAAiB,CAAC;AAExD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAK5D"}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Constants used throughout the pagination system
|
|
3
|
-
*/
|
|
4
|
-
/** Maximum number of items that can be requested in a single page */
|
|
5
|
-
export const MAX_PAGE_SIZE = 1000;
|
|
6
|
-
/** Default page size when jumpToPage is used without specifying pageSize */
|
|
7
|
-
export const DEFAULT_PAGE_SIZE = 50;
|
|
8
|
-
/** Default field name for items in a paginated response */
|
|
9
|
-
export const DEFAULT_ITEMS_FIELD = 'value';
|
|
10
|
-
/** Default field name for total count in a paginated response */
|
|
11
|
-
export const DEFAULT_TOTAL_COUNT_FIELD = '@odata.count';
|
|
12
|
-
/**
|
|
13
|
-
* Limits the page size to the maximum allowed value
|
|
14
|
-
* @param pageSize - Requested page size
|
|
15
|
-
* @returns Limited page size value
|
|
16
|
-
*/
|
|
17
|
-
export function getLimitedPageSize(pageSize) {
|
|
18
|
-
if (pageSize === undefined || pageSize === null) {
|
|
19
|
-
return DEFAULT_PAGE_SIZE;
|
|
20
|
-
}
|
|
21
|
-
return Math.max(1, Math.min(pageSize, MAX_PAGE_SIZE));
|
|
22
|
-
}
|
|
23
|
-
//# sourceMappingURL=constants.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/utils/pagination/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,qEAAqE;AACrE,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC;AAElC,4EAA4E;AAC5E,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC,2DAA2D;AAC3D,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAE3C,iEAAiE;AACjE,MAAM,CAAC,MAAM,yBAAyB,GAAG,cAAc,CAAC;AAExD;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAiB;IAClD,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;AACxD,CAAC"}
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
import { PaginatedResponse, PaginationCursor, PaginationOptions, HasPaginationOptions, NonPaginatedResponse } from './types';
|
|
2
|
-
import { InternalPaginationOptions, CursorData, PaginationType, GetAllPaginatedParams, GetAllNonPaginatedParams, GetAllConfig } from './internal-types';
|
|
3
|
-
/**
|
|
4
|
-
* Helper functions for pagination that can be used across services
|
|
5
|
-
*/
|
|
6
|
-
export declare class PaginationHelpers {
|
|
7
|
-
/**
|
|
8
|
-
* Checks if any pagination parameters are provided
|
|
9
|
-
*
|
|
10
|
-
* @param options - The options object to check
|
|
11
|
-
* @returns True if any pagination parameter is defined, false otherwise
|
|
12
|
-
*/
|
|
13
|
-
static hasPaginationParameters(options?: Record<string, any>): boolean;
|
|
14
|
-
/**
|
|
15
|
-
* Parse a pagination cursor string into cursor data
|
|
16
|
-
*/
|
|
17
|
-
static parseCursor(cursorString: string): CursorData;
|
|
18
|
-
/**
|
|
19
|
-
* Validates cursor format and structure
|
|
20
|
-
*
|
|
21
|
-
* @param paginationOptions - The pagination options containing the cursor
|
|
22
|
-
* @param paginationType - Optional pagination type to validate against
|
|
23
|
-
*/
|
|
24
|
-
static validateCursor(paginationOptions: {
|
|
25
|
-
cursor?: PaginationCursor;
|
|
26
|
-
}, paginationType?: PaginationType): void;
|
|
27
|
-
/**
|
|
28
|
-
* Comprehensive validation for pagination options
|
|
29
|
-
*
|
|
30
|
-
* @param options - The pagination options to validate
|
|
31
|
-
* @param paginationType - The pagination type these options will be used with
|
|
32
|
-
* @returns Processed pagination parameters ready for use
|
|
33
|
-
*/
|
|
34
|
-
static validatePaginationOptions(options: PaginationOptions, paginationType: PaginationType): InternalPaginationOptions;
|
|
35
|
-
/**
|
|
36
|
-
* Convert a unified pagination options to service-specific parameters
|
|
37
|
-
*/
|
|
38
|
-
static getRequestParameters(options: PaginationOptions): InternalPaginationOptions;
|
|
39
|
-
/**
|
|
40
|
-
* Helper method for paginated resource retrieval
|
|
41
|
-
*
|
|
42
|
-
* @param params - Parameters for pagination
|
|
43
|
-
* @returns Promise resolving to a paginated result
|
|
44
|
-
*/
|
|
45
|
-
static getAllPaginated<T, R = T>(params: GetAllPaginatedParams<T, R>): Promise<PaginatedResponse<R>>;
|
|
46
|
-
/**
|
|
47
|
-
* Helper method for non-paginated resource retrieval
|
|
48
|
-
*
|
|
49
|
-
* @param params - Parameters for non-paginated resource retrieval
|
|
50
|
-
* @returns Promise resolving to an object with data and totalCount
|
|
51
|
-
*/
|
|
52
|
-
static getAllNonPaginated<T, R = T>(params: GetAllNonPaginatedParams<T, R>): Promise<NonPaginatedResponse<R>>;
|
|
53
|
-
/**
|
|
54
|
-
* Centralized getAll implementation that handles both paginated and non-paginated requests
|
|
55
|
-
*
|
|
56
|
-
* @param config - Configuration for the getAll operation
|
|
57
|
-
* @param options - Request options including pagination parameters
|
|
58
|
-
* @returns Promise resolving to either paginated or non-paginated response based on options
|
|
59
|
-
*/
|
|
60
|
-
static getAll<TOptions extends Record<string, any>, TRaw, TTransformed = TRaw>(config: GetAllConfig<TRaw, TTransformed>, options?: TOptions): Promise<TOptions extends HasPaginationOptions<TOptions> ? PaginatedResponse<TTransformed> : NonPaginatedResponse<TTransformed>>;
|
|
61
|
-
}
|
|
62
|
-
//# sourceMappingURL=helpers.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/utils/pagination/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAC7H,OAAO,EACL,yBAAyB,EACzB,UAAU,EACV,cAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,YAAY,EACb,MAAM,kBAAkB,CAAC;AAQ1B;;GAEG;AACH,qBAAa,iBAAiB;IAC5B;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAAC,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,GAAG,OAAO;IAK1E;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU;IAWpD;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CACnB,iBAAiB,EAAE;QAAE,MAAM,CAAC,EAAE,gBAAgB,CAAA;KAAE,EAChD,cAAc,CAAC,EAAE,cAAc,GAC9B,IAAI;IAkCP;;;;;;OAMG;IACH,MAAM,CAAC,yBAAyB,CAC9B,OAAO,EAAE,iBAAiB,EAC1B,cAAc,EAAE,cAAc,GAC7B,yBAAyB;IAuB5B;;OAEG;IACH,MAAM,CAAC,oBAAoB,CACzB,OAAO,EAAE,iBAAiB,GACzB,yBAAyB;IAmC5B;;;;;OAKG;WACU,eAAe,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EACnC,MAAM,EAAE,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC,GAClC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IA0ChC;;;;;OAKG;WACU,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EACtC,MAAM,EAAE,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC,GACrC,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;IA4CnC;;;;;;OAMG;WACU,MAAM,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI,EACjF,MAAM,EAAE,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,EACxC,OAAO,CAAC,EAAE,QAAQ,GACjB,OAAO,CACR,QAAQ,SAAS,oBAAoB,CAAC,QAAQ,CAAC,GAC3C,iBAAiB,CAAC,YAAY,CAAC,GAC/B,oBAAoB,CAAC,YAAY,CAAC,CACvC;CA4DF"}
|
|
@@ -1,254 +0,0 @@
|
|
|
1
|
-
import { PaginationType, } from './internal-types';
|
|
2
|
-
import { createHeaders } from '../http/headers';
|
|
3
|
-
import { FOLDER_ID } from '../constants/headers';
|
|
4
|
-
import { ODATA_PREFIX } from '../constants/common';
|
|
5
|
-
import { addPrefixToKeys } from '../transform';
|
|
6
|
-
import { DEFAULT_ITEMS_FIELD, DEFAULT_TOTAL_COUNT_FIELD } from './constants';
|
|
7
|
-
import { filterUndefined } from '../object';
|
|
8
|
-
/**
|
|
9
|
-
* Helper functions for pagination that can be used across services
|
|
10
|
-
*/
|
|
11
|
-
export class PaginationHelpers {
|
|
12
|
-
/**
|
|
13
|
-
* Checks if any pagination parameters are provided
|
|
14
|
-
*
|
|
15
|
-
* @param options - The options object to check
|
|
16
|
-
* @returns True if any pagination parameter is defined, false otherwise
|
|
17
|
-
*/
|
|
18
|
-
static hasPaginationParameters(options = {}) {
|
|
19
|
-
const { cursor, pageSize, jumpToPage } = options;
|
|
20
|
-
return cursor !== undefined || pageSize !== undefined || jumpToPage !== undefined;
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* Parse a pagination cursor string into cursor data
|
|
24
|
-
*/
|
|
25
|
-
static parseCursor(cursorString) {
|
|
26
|
-
try {
|
|
27
|
-
const cursorData = JSON.parse(Buffer.from(cursorString, 'base64').toString('utf-8'));
|
|
28
|
-
return cursorData;
|
|
29
|
-
}
|
|
30
|
-
catch (error) {
|
|
31
|
-
throw new Error('Invalid pagination cursor');
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* Validates cursor format and structure
|
|
36
|
-
*
|
|
37
|
-
* @param paginationOptions - The pagination options containing the cursor
|
|
38
|
-
* @param paginationType - Optional pagination type to validate against
|
|
39
|
-
*/
|
|
40
|
-
static validateCursor(paginationOptions, paginationType) {
|
|
41
|
-
if (paginationOptions.cursor !== undefined) {
|
|
42
|
-
if (!paginationOptions.cursor || typeof paginationOptions.cursor.value !== 'string' || !paginationOptions.cursor.value) {
|
|
43
|
-
throw new Error('cursor must contain a valid cursor string');
|
|
44
|
-
}
|
|
45
|
-
try {
|
|
46
|
-
// Try to parse the cursor to validate it
|
|
47
|
-
const cursorData = PaginationHelpers.parseCursor(paginationOptions.cursor.value);
|
|
48
|
-
// If type is provided, validate cursor contains expected type information
|
|
49
|
-
if (paginationType) {
|
|
50
|
-
if (!cursorData.type) {
|
|
51
|
-
throw new Error('Invalid cursor: missing pagination type');
|
|
52
|
-
}
|
|
53
|
-
// Check pagination type compatibility
|
|
54
|
-
if (cursorData.type !== paginationType) {
|
|
55
|
-
throw new Error(`Pagination type mismatch: cursor is for ${cursorData.type} but service uses ${paginationType}`);
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
catch (error) {
|
|
60
|
-
if (error instanceof Error) {
|
|
61
|
-
// If it's already our error with specific message, pass it through
|
|
62
|
-
if (error.message.startsWith('Invalid cursor') ||
|
|
63
|
-
error.message.startsWith('Pagination type mismatch')) {
|
|
64
|
-
throw error;
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
throw new Error('Invalid pagination cursor format');
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
/**
|
|
72
|
-
* Comprehensive validation for pagination options
|
|
73
|
-
*
|
|
74
|
-
* @param options - The pagination options to validate
|
|
75
|
-
* @param paginationType - The pagination type these options will be used with
|
|
76
|
-
* @returns Processed pagination parameters ready for use
|
|
77
|
-
*/
|
|
78
|
-
static validatePaginationOptions(options, paginationType) {
|
|
79
|
-
// Validate pageSize
|
|
80
|
-
if (options.pageSize !== undefined && options.pageSize <= 0) {
|
|
81
|
-
throw new Error('pageSize must be a positive number');
|
|
82
|
-
}
|
|
83
|
-
// Validate jumpToPage
|
|
84
|
-
if (options.jumpToPage !== undefined && options.jumpToPage <= 0) {
|
|
85
|
-
throw new Error('jumpToPage must be a positive number');
|
|
86
|
-
}
|
|
87
|
-
// Validate cursor
|
|
88
|
-
PaginationHelpers.validateCursor(options, paginationType);
|
|
89
|
-
// Validate service compatibility
|
|
90
|
-
if (options.jumpToPage !== undefined && paginationType === PaginationType.TOKEN) {
|
|
91
|
-
throw new Error('jumpToPage is not supported for token-based pagination. Use cursor-based navigation instead.');
|
|
92
|
-
}
|
|
93
|
-
// Get processed parameters
|
|
94
|
-
return PaginationHelpers.getRequestParameters(options);
|
|
95
|
-
}
|
|
96
|
-
/**
|
|
97
|
-
* Convert a unified pagination options to service-specific parameters
|
|
98
|
-
*/
|
|
99
|
-
static getRequestParameters(options) {
|
|
100
|
-
// Handle jumpToPage
|
|
101
|
-
if (options.jumpToPage !== undefined) {
|
|
102
|
-
const jumpToPageOptions = {
|
|
103
|
-
pageSize: options.pageSize,
|
|
104
|
-
pageNumber: options.jumpToPage
|
|
105
|
-
};
|
|
106
|
-
return filterUndefined(jumpToPageOptions);
|
|
107
|
-
}
|
|
108
|
-
// If no cursor is provided, it's a first page request
|
|
109
|
-
if (!options.cursor) {
|
|
110
|
-
const firstPageOptions = {
|
|
111
|
-
pageSize: options.pageSize,
|
|
112
|
-
pageNumber: 1
|
|
113
|
-
};
|
|
114
|
-
return filterUndefined(firstPageOptions);
|
|
115
|
-
}
|
|
116
|
-
// Parse the cursor
|
|
117
|
-
try {
|
|
118
|
-
const cursorData = PaginationHelpers.parseCursor(options.cursor.value);
|
|
119
|
-
const cursorBasedOptions = {
|
|
120
|
-
pageSize: cursorData.pageSize || options.pageSize,
|
|
121
|
-
pageNumber: cursorData.pageNumber,
|
|
122
|
-
continuationToken: cursorData.continuationToken,
|
|
123
|
-
type: cursorData.type,
|
|
124
|
-
};
|
|
125
|
-
return filterUndefined(cursorBasedOptions);
|
|
126
|
-
}
|
|
127
|
-
catch (error) {
|
|
128
|
-
throw new Error('Invalid pagination cursor');
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
/**
|
|
132
|
-
* Helper method for paginated resource retrieval
|
|
133
|
-
*
|
|
134
|
-
* @param params - Parameters for pagination
|
|
135
|
-
* @returns Promise resolving to a paginated result
|
|
136
|
-
*/
|
|
137
|
-
static async getAllPaginated(params) {
|
|
138
|
-
const { serviceAccess, getEndpoint, folderId, paginationParams, additionalParams, transformFn, options = {} } = params;
|
|
139
|
-
const endpoint = getEndpoint(folderId);
|
|
140
|
-
const headers = folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {};
|
|
141
|
-
const paginatedResponse = await serviceAccess.requestWithPagination('GET', endpoint, paginationParams, {
|
|
142
|
-
headers,
|
|
143
|
-
params: additionalParams,
|
|
144
|
-
pagination: {
|
|
145
|
-
paginationType: options.paginationType || PaginationType.OFFSET,
|
|
146
|
-
itemsField: options.itemsField || DEFAULT_ITEMS_FIELD,
|
|
147
|
-
totalCountField: options.totalCountField || DEFAULT_TOTAL_COUNT_FIELD,
|
|
148
|
-
continuationTokenField: options.continuationTokenField,
|
|
149
|
-
paginationParams: options.paginationParams
|
|
150
|
-
}
|
|
151
|
-
});
|
|
152
|
-
// Transform items only if a transform function is provided
|
|
153
|
-
const transformedItems = transformFn
|
|
154
|
-
? paginatedResponse.items.map(transformFn)
|
|
155
|
-
: paginatedResponse.items;
|
|
156
|
-
return {
|
|
157
|
-
...paginatedResponse,
|
|
158
|
-
items: transformedItems
|
|
159
|
-
};
|
|
160
|
-
}
|
|
161
|
-
/**
|
|
162
|
-
* Helper method for non-paginated resource retrieval
|
|
163
|
-
*
|
|
164
|
-
* @param params - Parameters for non-paginated resource retrieval
|
|
165
|
-
* @returns Promise resolving to an object with data and totalCount
|
|
166
|
-
*/
|
|
167
|
-
static async getAllNonPaginated(params) {
|
|
168
|
-
const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, additionalParams, transformFn, options = {} } = params;
|
|
169
|
-
// Set default field names
|
|
170
|
-
const itemsField = options.itemsField || DEFAULT_ITEMS_FIELD;
|
|
171
|
-
const totalCountField = options.totalCountField || DEFAULT_TOTAL_COUNT_FIELD;
|
|
172
|
-
// Determine endpoint and headers based on folderId
|
|
173
|
-
const endpoint = folderId ? getByFolderEndpoint : getAllEndpoint;
|
|
174
|
-
const headers = folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {};
|
|
175
|
-
// Make the API call
|
|
176
|
-
const response = await serviceAccess.get(endpoint, {
|
|
177
|
-
params: additionalParams,
|
|
178
|
-
headers
|
|
179
|
-
});
|
|
180
|
-
// Extract data
|
|
181
|
-
const items = response.data?.[itemsField] || [];
|
|
182
|
-
// Transform items if a transform function is provided
|
|
183
|
-
const data = transformFn
|
|
184
|
-
? items.map(transformFn)
|
|
185
|
-
: items;
|
|
186
|
-
const totalCount = response.data?.[totalCountField];
|
|
187
|
-
return {
|
|
188
|
-
items: data,
|
|
189
|
-
totalCount
|
|
190
|
-
};
|
|
191
|
-
}
|
|
192
|
-
/**
|
|
193
|
-
* Centralized getAll implementation that handles both paginated and non-paginated requests
|
|
194
|
-
*
|
|
195
|
-
* @param config - Configuration for the getAll operation
|
|
196
|
-
* @param options - Request options including pagination parameters
|
|
197
|
-
* @returns Promise resolving to either paginated or non-paginated response based on options
|
|
198
|
-
*/
|
|
199
|
-
static async getAll(config, options) {
|
|
200
|
-
const optionsWithDefaults = options || {};
|
|
201
|
-
const { folderId, ...restOptions } = optionsWithDefaults;
|
|
202
|
-
const cursor = options?.cursor;
|
|
203
|
-
const pageSize = options?.pageSize;
|
|
204
|
-
const jumpToPage = options?.jumpToPage;
|
|
205
|
-
// Determine if pagination is requested
|
|
206
|
-
const isPaginationRequested = PaginationHelpers.hasPaginationParameters(options || {});
|
|
207
|
-
// Process parameters (custom processing if provided, otherwise default)
|
|
208
|
-
let processedOptions = restOptions;
|
|
209
|
-
if (config.processParametersFn) {
|
|
210
|
-
processedOptions = config.processParametersFn(restOptions, folderId);
|
|
211
|
-
}
|
|
212
|
-
// Apply ODATA prefix to keys (excluding specified keys)
|
|
213
|
-
const excludeKeys = config.excludeFromPrefix || [];
|
|
214
|
-
const keysToPrefix = Object.keys(processedOptions).filter(k => !excludeKeys.includes(k));
|
|
215
|
-
const prefixedOptions = addPrefixToKeys(processedOptions, ODATA_PREFIX, keysToPrefix);
|
|
216
|
-
// Default pagination options
|
|
217
|
-
const paginationOptions = {
|
|
218
|
-
paginationType: PaginationType.OFFSET,
|
|
219
|
-
itemsField: DEFAULT_ITEMS_FIELD,
|
|
220
|
-
totalCountField: DEFAULT_TOTAL_COUNT_FIELD,
|
|
221
|
-
...config.pagination
|
|
222
|
-
};
|
|
223
|
-
// Paginated flow
|
|
224
|
-
if (isPaginationRequested) {
|
|
225
|
-
return PaginationHelpers.getAllPaginated({
|
|
226
|
-
serviceAccess: config.serviceAccess,
|
|
227
|
-
getEndpoint: config.getEndpoint,
|
|
228
|
-
folderId,
|
|
229
|
-
paginationParams: cursor ? { cursor, pageSize } : jumpToPage ? { jumpToPage, pageSize } : { pageSize },
|
|
230
|
-
additionalParams: prefixedOptions,
|
|
231
|
-
transformFn: config.transformFn,
|
|
232
|
-
options: {
|
|
233
|
-
...paginationOptions,
|
|
234
|
-
paginationParams: config.pagination?.paginationParams
|
|
235
|
-
}
|
|
236
|
-
}); // Type assertion needed due to conditional return
|
|
237
|
-
}
|
|
238
|
-
// Non-paginated flow
|
|
239
|
-
const byFolderEndpoint = config.getByFolderEndpoint || config.getEndpoint(folderId);
|
|
240
|
-
return PaginationHelpers.getAllNonPaginated({
|
|
241
|
-
serviceAccess: config.serviceAccess,
|
|
242
|
-
getAllEndpoint: config.getEndpoint(),
|
|
243
|
-
getByFolderEndpoint: byFolderEndpoint,
|
|
244
|
-
folderId,
|
|
245
|
-
additionalParams: prefixedOptions,
|
|
246
|
-
transformFn: config.transformFn,
|
|
247
|
-
options: {
|
|
248
|
-
itemsField: paginationOptions.itemsField,
|
|
249
|
-
totalCountField: paginationOptions.totalCountField
|
|
250
|
-
}
|
|
251
|
-
});
|
|
252
|
-
}
|
|
253
|
-
}
|
|
254
|
-
//# sourceMappingURL=helpers.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/utils/pagination/helpers.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,cAAc,GAIf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAC5B;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAAC,UAA+B,EAAE;QAC9D,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QACjD,OAAO,MAAM,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,YAAoB;QACrC,IAAI,CAAC;YACH,MAAM,UAAU,GAAe,IAAI,CAAC,KAAK,CACvC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CACtD,CAAC;YACF,OAAO,UAAU,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CACnB,iBAAgD,EAChD,cAA+B;QAE/B,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC3C,IAAI,CAAC,iBAAiB,CAAC,MAAM,IAAI,OAAO,iBAAiB,CAAC,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBACvH,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAC/D,CAAC;YAED,IAAI,CAAC;gBACH,yCAAyC;gBACzC,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAEjF,0EAA0E;gBAC1E,IAAI,cAAc,EAAE,CAAC;oBACnB,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;wBACrB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;oBAC7D,CAAC;oBAED,sCAAsC;oBACtC,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;wBACvC,MAAM,IAAI,KAAK,CAAC,2CAA2C,UAAU,CAAC,IAAI,qBAAqB,cAAc,EAAE,CAAC,CAAC;oBACnH,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;oBAC3B,mEAAmE;oBACnE,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;wBAC1C,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC;wBACzD,MAAM,KAAK,CAAC;oBACd,CAAC;gBACH,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,yBAAyB,CAC9B,OAA0B,EAC1B,cAA8B;QAE9B,oBAAoB;QACpB,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QAED,sBAAsB;QACtB,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,kBAAkB;QAClB,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAE1D,iCAAiC;QACjC,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,cAAc,KAAK,cAAc,CAAC,KAAK,EAAE,CAAC;YAChF,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC;QAClH,CAAC;QAED,2BAA2B;QAC3B,OAAO,iBAAiB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oBAAoB,CACzB,OAA0B;QAE1B,oBAAoB;QACpB,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,iBAAiB,GAA8B;gBACnD,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;aAC/B,CAAC;YACF,OAAO,eAAe,CAAC,iBAAiB,CAAC,CAAC;QAC5C,CAAC;QAED,sDAAsD;QACtD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,gBAAgB,GAA8B;gBAClD,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,UAAU,EAAE,CAAC;aACd,CAAC;YACF,OAAO,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAC3C,CAAC;QAED,mBAAmB;QACnB,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAEvE,MAAM,kBAAkB,GAA8B;gBACpD,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ;gBACjD,UAAU,EAAE,UAAU,CAAC,UAAU;gBACjC,iBAAiB,EAAE,UAAU,CAAC,iBAAiB;gBAC/C,IAAI,EAAE,UAAU,CAAC,IAAI;aACtB,CAAC;YACF,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,eAAe,CAC1B,MAAmC;QAEnC,MAAM,EACJ,aAAa,EACb,WAAW,EACX,QAAQ,EACR,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,OAAO,GAAG,EAAE,EACb,GAAG,MAAM,CAAC;QAEX,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzE,MAAM,iBAAiB,GAAG,MAAM,aAAa,CAAC,qBAAqB,CACjE,KAAK,EACL,QAAQ,EACR,gBAAgB,EAChB;YACE,OAAO;YACP,MAAM,EAAE,gBAAgB;YACxB,UAAU,EAAE;gBACV,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,cAAc,CAAC,MAAM;gBAC/D,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,mBAAmB;gBACrD,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,yBAAyB;gBACrE,sBAAsB,EAAE,OAAO,CAAC,sBAAsB;gBACtD,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;aAC3C;SACF,CACF,CAAC;QAEF,2DAA2D;QAC3D,MAAM,gBAAgB,GAAG,WAAW;YAClC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC;YAC1C,CAAC,CAAC,iBAAiB,CAAC,KAAuB,CAAC;QAE9C,OAAO;YACL,GAAG,iBAAiB;YACpB,KAAK,EAAE,gBAAgB;SACxB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,MAAsC;QAEtC,MAAM,EACJ,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACR,gBAAgB,EAChB,WAAW,EACX,OAAO,GAAG,EAAE,EACb,GAAG,MAAM,CAAC;QAEX,0BAA0B;QAC1B,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,mBAAmB,CAAC;QAC7D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,yBAAyB,CAAC;QAE7E,mDAAmD;QACnD,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,cAAc,CAAC;QACjE,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzE,oBAAoB;QACpB,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,GAAG,CACtC,QAAQ,EACR;YACE,MAAM,EAAE,gBAAgB;YACxB,OAAO;SACR,CACF,CAAC;QAEF,eAAe;QACf,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAEhD,sDAAsD;QACtD,MAAM,IAAI,GAAG,WAAW;YACtB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC;YACxB,CAAC,CAAC,KAAuB,CAAC;QAE5B,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC;QAEpD,OAAO;YACL,KAAK,EAAE,IAAI;YACX,UAAU;SACX,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,MAAwC,EACxC,OAAkB;QAMlB,MAAM,mBAAmB,GAAG,OAAO,IAAI,EAAS,CAAC;QACjD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,GAAG,mBAAmB,CAAC;QACzD,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;QAC/B,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;QACnC,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,CAAC;QAEvC,uCAAuC;QACvC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QAEvF,wEAAwE;QACxE,IAAI,gBAAgB,GAAG,WAAW,CAAC;QACnC,IAAI,MAAM,CAAC,mBAAmB,EAAE,CAAC;YAC/B,gBAAgB,GAAG,MAAM,CAAC,mBAAmB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACvE,CAAC;QAED,wDAAwD;QACxD,MAAM,WAAW,GAAG,MAAM,CAAC,iBAAiB,IAAI,EAAE,CAAC;QACnD,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACzF,MAAM,eAAe,GAAG,eAAe,CAAC,gBAAgB,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAEtF,6BAA6B;QAC7B,MAAM,iBAAiB,GAAG;YACxB,cAAc,EAAE,cAAc,CAAC,MAAM;YACrC,UAAU,EAAE,mBAAmB;YAC/B,eAAe,EAAE,yBAAyB;YAC1C,GAAG,MAAM,CAAC,UAAU;SACrB,CAAC;QAEF,iBAAiB;QACjB,IAAI,qBAAqB,EAAE,CAAC;YAC1B,OAAO,iBAAiB,CAAC,eAAe,CAAqB;gBAC3D,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,QAAQ;gBACR,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE;gBACtG,gBAAgB,EAAE,eAAe;gBACjC,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,OAAO,EAAE;oBACP,GAAG,iBAAiB;oBACpB,gBAAgB,EAAE,MAAM,CAAC,UAAU,EAAE,gBAAgB;iBACtD;aACF,CAAQ,CAAC,CAAC,kDAAkD;QAC/D,CAAC;QAED,qBAAqB;QACrB,MAAM,gBAAgB,GAAG,MAAM,CAAC,mBAAmB,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACpF,OAAO,iBAAiB,CAAC,kBAAkB,CAAqB;YAC9D,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,cAAc,EAAE,MAAM,CAAC,WAAW,EAAE;YACpC,mBAAmB,EAAE,gBAAgB;YACrC,QAAQ;YACR,gBAAgB,EAAE,eAAe;YACjC,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,OAAO,EAAE;gBACP,UAAU,EAAE,iBAAiB,CAAC,UAAU;gBACxC,eAAe,EAAE,iBAAiB,CAAC,eAAe;aACnD;SACF,CAAQ,CAAC;IACZ,CAAC;CACF"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/pagination/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/pagination/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC"}
|
|
@@ -1,184 +0,0 @@
|
|
|
1
|
-
import { PaginationOptions, PaginatedResponse, PaginationMethodUnion } from './types';
|
|
2
|
-
import { RequestSpec } from '../../models/common/request-spec';
|
|
3
|
-
/**
|
|
4
|
-
* Cursor data structure for tracking pagination state
|
|
5
|
-
*/
|
|
6
|
-
export interface CursorData {
|
|
7
|
-
/** The type of pagination used by this service */
|
|
8
|
-
type: PaginationType;
|
|
9
|
-
/** For OData and Entity pagination */
|
|
10
|
-
pageNumber?: number;
|
|
11
|
-
/** For token-based pagination */
|
|
12
|
-
continuationToken?: string;
|
|
13
|
-
/** Common parameters */
|
|
14
|
-
pageSize?: number;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* Pagination options used by the pagination implementation
|
|
18
|
-
*/
|
|
19
|
-
export type InternalPaginationOptions = {
|
|
20
|
-
/** Size of the page to fetch (items per page) */
|
|
21
|
-
pageSize?: number;
|
|
22
|
-
/** Current page number (1-based) */
|
|
23
|
-
pageNumber?: number;
|
|
24
|
-
/** Token for continuing pagination */
|
|
25
|
-
continuationToken?: string;
|
|
26
|
-
/** Pagination type */
|
|
27
|
-
type?: any;
|
|
28
|
-
} & PaginationMethodUnion;
|
|
29
|
-
/**
|
|
30
|
-
* Pagination types supported by the SDK
|
|
31
|
-
*/
|
|
32
|
-
export declare enum PaginationType {
|
|
33
|
-
OFFSET = "offset",
|
|
34
|
-
TOKEN = "token"
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* Interface for service access methods needed by pagination helpers
|
|
38
|
-
*/
|
|
39
|
-
export interface PaginationServiceAccess {
|
|
40
|
-
get<T>(path: string, options?: any): Promise<{
|
|
41
|
-
data: T;
|
|
42
|
-
}>;
|
|
43
|
-
requestWithPagination<T>(method: string, path: string, paginationOptions: PaginationOptions, options: RequestWithPaginationOptions): Promise<PaginatedResponse<T>>;
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* Interface for getAllPaginated parameters
|
|
47
|
-
*/
|
|
48
|
-
export interface GetAllPaginatedParams<T, R = T> {
|
|
49
|
-
serviceAccess: PaginationServiceAccess;
|
|
50
|
-
getEndpoint: (folderId?: number) => string;
|
|
51
|
-
folderId?: number;
|
|
52
|
-
paginationParams: PaginationOptions;
|
|
53
|
-
additionalParams: Record<string, any>;
|
|
54
|
-
/**
|
|
55
|
-
* Optional function to transform API response items.
|
|
56
|
-
*/
|
|
57
|
-
transformFn?: (item: T) => R;
|
|
58
|
-
options?: {
|
|
59
|
-
paginationType?: PaginationType;
|
|
60
|
-
itemsField?: string;
|
|
61
|
-
totalCountField?: string;
|
|
62
|
-
continuationTokenField?: string;
|
|
63
|
-
paginationParams?: {
|
|
64
|
-
pageSizeParam?: string;
|
|
65
|
-
offsetParam?: string;
|
|
66
|
-
tokenParam?: string;
|
|
67
|
-
countParam?: string;
|
|
68
|
-
};
|
|
69
|
-
};
|
|
70
|
-
}
|
|
71
|
-
/**
|
|
72
|
-
* Interface for getAllNonPaginated parameters
|
|
73
|
-
*/
|
|
74
|
-
export interface GetAllNonPaginatedParams<T, R = T> {
|
|
75
|
-
serviceAccess: PaginationServiceAccess;
|
|
76
|
-
getAllEndpoint: string;
|
|
77
|
-
getByFolderEndpoint: string;
|
|
78
|
-
folderId?: number;
|
|
79
|
-
additionalParams: Record<string, any>;
|
|
80
|
-
/**
|
|
81
|
-
* Optional function to transform API response items.
|
|
82
|
-
*/
|
|
83
|
-
transformFn?: (item: T) => R;
|
|
84
|
-
options?: {
|
|
85
|
-
itemsField?: string;
|
|
86
|
-
totalCountField?: string;
|
|
87
|
-
};
|
|
88
|
-
}
|
|
89
|
-
/**
|
|
90
|
-
* Information about a page of results
|
|
91
|
-
*/
|
|
92
|
-
export interface PageInfo {
|
|
93
|
-
/** Whether there are more pages available */
|
|
94
|
-
hasMore: boolean;
|
|
95
|
-
/** Total count of items (if available) */
|
|
96
|
-
totalCount?: number;
|
|
97
|
-
/** Current page number (for page-based pagination) */
|
|
98
|
-
currentPage?: number;
|
|
99
|
-
/** Page size */
|
|
100
|
-
pageSize?: number;
|
|
101
|
-
/** Continuation token (for token-based pagination) */
|
|
102
|
-
continuationToken?: string;
|
|
103
|
-
}
|
|
104
|
-
/**
|
|
105
|
-
* Common parameters for creating pagination cursors and responses.
|
|
106
|
-
*/
|
|
107
|
-
export interface PaginationInfo {
|
|
108
|
-
pageInfo: PageInfo;
|
|
109
|
-
type: PaginationType;
|
|
110
|
-
}
|
|
111
|
-
/**
|
|
112
|
-
* Field names for extracting data from paginated responses.
|
|
113
|
-
*/
|
|
114
|
-
export interface PaginationFieldNames {
|
|
115
|
-
itemsField?: string;
|
|
116
|
-
totalCountField?: string;
|
|
117
|
-
continuationTokenField?: string;
|
|
118
|
-
}
|
|
119
|
-
/**
|
|
120
|
-
* Options for the requestWithPagination method in BaseService.
|
|
121
|
-
*/
|
|
122
|
-
export interface RequestWithPaginationOptions extends RequestSpec {
|
|
123
|
-
pagination: PaginationFieldNames & {
|
|
124
|
-
paginationType: PaginationType;
|
|
125
|
-
paginationParams?: {
|
|
126
|
-
pageSizeParam?: string;
|
|
127
|
-
offsetParam?: string;
|
|
128
|
-
tokenParam?: string;
|
|
129
|
-
countParam?: string;
|
|
130
|
-
};
|
|
131
|
-
};
|
|
132
|
-
}
|
|
133
|
-
/**
|
|
134
|
-
* Information needed to determine if more pages are available.
|
|
135
|
-
*/
|
|
136
|
-
export interface PaginationDetectionInfo {
|
|
137
|
-
totalCount?: number;
|
|
138
|
-
pageSize?: number;
|
|
139
|
-
currentPage: number;
|
|
140
|
-
itemsCount: number;
|
|
141
|
-
continuationToken?: string;
|
|
142
|
-
}
|
|
143
|
-
/**
|
|
144
|
-
* Configuration for pagination options
|
|
145
|
-
*/
|
|
146
|
-
export interface PaginationConfig {
|
|
147
|
-
paginationType?: PaginationType;
|
|
148
|
-
itemsField?: string;
|
|
149
|
-
totalCountField?: string;
|
|
150
|
-
continuationTokenField?: string;
|
|
151
|
-
/** Parameter names for different pagination types */
|
|
152
|
-
paginationParams?: {
|
|
153
|
-
/** Parameter name for page size */
|
|
154
|
-
pageSizeParam?: string;
|
|
155
|
-
/** Parameter name for page offset/skip */
|
|
156
|
-
offsetParam?: string;
|
|
157
|
-
/** Parameter name for continuation token (TOKEN type only) */
|
|
158
|
-
tokenParam?: string;
|
|
159
|
-
/** Parameter name for count inclusion (ODATA type only) */
|
|
160
|
-
countParam?: string;
|
|
161
|
-
};
|
|
162
|
-
}
|
|
163
|
-
/**
|
|
164
|
-
* Configuration for centralized getAll implementations
|
|
165
|
-
*/
|
|
166
|
-
export interface GetAllConfig<TRaw, TTransformed = TRaw> {
|
|
167
|
-
/** Service access for making API calls */
|
|
168
|
-
serviceAccess: PaginationServiceAccess;
|
|
169
|
-
/** Endpoint function for getting all items (takes optional folderId) */
|
|
170
|
-
getEndpoint: (folderId?: number) => string;
|
|
171
|
-
/** Alternative endpoint for folder-specific queries (optional) */
|
|
172
|
-
getByFolderEndpoint?: string;
|
|
173
|
-
/**
|
|
174
|
-
* Optional function to transform raw API items to client format.
|
|
175
|
-
*/
|
|
176
|
-
transformFn?: (item: TRaw) => TTransformed;
|
|
177
|
-
/** Pagination configuration */
|
|
178
|
-
pagination?: PaginationConfig;
|
|
179
|
-
/** Custom parameter processing function */
|
|
180
|
-
processParametersFn?: (options: Record<string, any>, folderId?: number) => Record<string, any>;
|
|
181
|
-
/** Keys to exclude from ODATA prefix transformation */
|
|
182
|
-
excludeFromPrefix?: string[];
|
|
183
|
-
}
|
|
184
|
-
//# sourceMappingURL=internal-types.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"internal-types.d.ts","sourceRoot":"","sources":["../../../src/utils/pagination/internal-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACtF,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,kDAAkD;IAClD,IAAI,EAAE,cAAc,CAAC;IAErB,sCAAsC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,iCAAiC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,sCAAsC;IACtC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,sBAAsB;IACtB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,GAAG,qBAAqB,CAAC;AAE1B;;GAEG;AACH,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;IAC1D,qBAAqB,CAAC,CAAC,EACrB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,iBAAiB,EACpC,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;IAC7C,aAAa,EAAE,uBAAuB,CAAC;IACvC,WAAW,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,iBAAiB,CAAC;IACpC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAChC,gBAAgB,CAAC,EAAE;YACjB,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;IAChD,aAAa,EAAE,uBAAuB,CAAC;IACvC,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,6CAA6C;IAC7C,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,cAAc,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,WAAW;IAC/D,UAAU,EAAE,oBAAoB,GAAG;QACjC,cAAc,EAAE,cAAc,CAAC;QAC/B,gBAAgB,CAAC,EAAE;YACjB,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,qDAAqD;IACrD,gBAAgB,CAAC,EAAE;QACjB,mCAAmC;QACnC,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,0CAA0C;QAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,8DAA8D;QAC9D,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,2DAA2D;QAC3D,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IACrD,0CAA0C;IAC1C,aAAa,EAAE,uBAAuB,CAAC;IAEvC,wEAAwE;IACxE,WAAW,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAE3C,kEAAkE;IAClE,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,YAAY,CAAC;IAE3C,+BAA+B;IAC/B,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAE9B,2CAA2C;IAC3C,mBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/F,uDAAuD;IACvD,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B"}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pagination types supported by the SDK
|
|
3
|
-
*/
|
|
4
|
-
export var PaginationType;
|
|
5
|
-
(function (PaginationType) {
|
|
6
|
-
PaginationType["OFFSET"] = "offset";
|
|
7
|
-
PaginationType["TOKEN"] = "token";
|
|
8
|
-
})(PaginationType || (PaginationType = {}));
|
|
9
|
-
//# sourceMappingURL=internal-types.js.map
|