Skip to content

Commit bce2df8

Browse files
committed
feat: update ExO plain client getMany return types [DX-1016]
1 parent 187e1e6 commit bce2df8

6 files changed

Lines changed: 18 additions & 17 deletions

File tree

lib/common-types.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ import type {
168168
DataAssemblyProps,
169169
DataAssemblyQueryOptions,
170170
UpdateDataAssemblyProps,
171+
DataAssemblyCollection,
171172
} from './entities/data-assembly'
172173
import type {
173174
CreateEnvironmentTemplateProps,
@@ -1683,7 +1684,7 @@ export type MRActions = {
16831684
ComponentType: {
16841685
getMany: {
16851686
params: GetSpaceEnvironmentParams & { query: ComponentTypeQueryOptions }
1686-
return: CursorPaginatedCollectionProp<ComponentTypeProps>
1687+
return: ExoCursorPaginatedCollectionProp<ComponentTypeProps>
16871688
}
16881689
get: {
16891690
params: GetComponentTypeParams
@@ -1829,11 +1830,11 @@ export type MRActions = {
18291830
DataAssembly: {
18301831
getMany: {
18311832
params: GetSpaceEnvironmentParams & { query: DataAssemblyQueryOptions }
1832-
return: CursorPaginatedCollectionProp<DataAssemblyProps>
1833+
return: DataAssemblyCollection
18331834
}
18341835
getManyPublished: {
18351836
params: GetSpaceEnvironmentParams & { query: DataAssemblyQueryOptions }
1836-
return: CursorPaginatedCollectionProp<DataAssemblyProps>
1837+
return: DataAssemblyCollection
18371838
}
18381839
getPublished: {
18391840
params: GetDataAssemblyParams
@@ -2669,7 +2670,7 @@ export type MRActions = {
26692670
Fragment: {
26702671
getMany: {
26712672
params: GetSpaceEnvironmentParams & { query: FragmentQueryOptions }
2672-
return: CursorPaginatedCollectionProp<FragmentProps>
2673+
return: ExoCursorPaginatedCollectionProp<FragmentProps>
26732674
}
26742675
get: {
26752676
params: GetFragmentParams
@@ -2701,7 +2702,7 @@ export type MRActions = {
27012702
Template: {
27022703
getMany: {
27032704
params: GetSpaceEnvironmentParams & { query: TemplateQueryOptions }
2704-
return: CursorPaginatedCollectionProp<TemplateProps>
2705+
return: ExoCursorPaginatedCollectionProp<TemplateProps>
27052706
}
27062707
get: {
27072708
params: GetTemplateParams
@@ -2776,7 +2777,7 @@ export type MRActions = {
27762777
Experience: {
27772778
getMany: {
27782779
params: GetSpaceEnvironmentParams & { query: ExperienceQueryOptions }
2779-
return: CursorPaginatedCollectionProp<ExperienceProps>
2780+
return: ExoCursorPaginatedCollectionProp<ExperienceProps>
27802781
}
27812782
get: {
27822783
params: GetExperienceParams

lib/plain/entities/component-type.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type {
22
GetSpaceEnvironmentParams,
33
GetComponentTypeParams,
4-
CursorPaginatedCollectionProp,
4+
ExoCursorPaginatedCollectionProp,
55
} from '../../common-types'
66
import type {
77
ComponentTypeQueryOptions,
@@ -34,7 +34,7 @@ export type ComponentTypePlainClientAPI = {
3434
*/
3535
getMany(
3636
params: OptionalDefaults<GetSpaceEnvironmentParams & { query: ComponentTypeQueryOptions }>,
37-
): Promise<CursorPaginatedCollectionProp<ComponentTypeProps>>
37+
): Promise<ExoCursorPaginatedCollectionProp<ComponentTypeProps>>
3838

3939
/**
4040
* Fetches a single component type by ID

lib/plain/entities/data-assembly.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import type { RawAxiosRequestHeaders } from 'axios'
22
import type {
3-
CursorPaginatedCollectionProp,
43
GetDataAssemblyParams,
54
GetSpaceEnvironmentParams,
65
} from '../../common-types'
@@ -9,6 +8,7 @@ import type {
98
DataAssemblyProps,
109
DataAssemblyQueryOptions,
1110
UpdateDataAssemblyProps,
11+
DataAssemblyCollection,
1212
} from '../../entities/data-assembly'
1313
import type { OptionalDefaults } from '../wrappers/wrap'
1414

@@ -32,7 +32,7 @@ export type DataAssemblyPlainClientAPI = {
3232
*/
3333
getMany(
3434
params: OptionalDefaults<GetSpaceEnvironmentParams & { query: DataAssemblyQueryOptions }>,
35-
): Promise<CursorPaginatedCollectionProp<DataAssemblyProps>>
35+
): Promise<DataAssemblyCollection>
3636

3737
/**
3838
* Fetches a single data assembly by ID
@@ -183,7 +183,7 @@ export type DataAssemblyPlainClientAPI = {
183183
*/
184184
getManyPublished(
185185
params: OptionalDefaults<GetSpaceEnvironmentParams & { query: DataAssemblyQueryOptions }>,
186-
): Promise<CursorPaginatedCollectionProp<DataAssemblyProps>>
186+
): Promise<DataAssemblyCollection>
187187

188188
/**
189189
* Fetches a single published data assembly by ID

lib/plain/entities/experience.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type {
2-
CursorPaginatedCollectionProp,
2+
ExoCursorPaginatedCollectionProp,
33
GetSpaceEnvironmentParams,
44
GetExperienceParams,
55
} from '../../common-types'
@@ -32,7 +32,7 @@ export type ExperiencePlainClientAPI = {
3232
*/
3333
getMany(
3434
params: OptionalDefaults<GetSpaceEnvironmentParams & { query: ExperienceQueryOptions }>,
35-
): Promise<CursorPaginatedCollectionProp<ExperienceProps>>
35+
): Promise<ExoCursorPaginatedCollectionProp<ExperienceProps>>
3636

3737
/**
3838
* Fetches a single experience by ID

lib/plain/entities/fragment.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type {
2-
CursorPaginatedCollectionProp,
2+
ExoCursorPaginatedCollectionProp,
33
GetFragmentParams,
44
GetSpaceEnvironmentParams,
55
} from '../../common-types'
@@ -31,7 +31,7 @@ export type FragmentPlainClientAPI = {
3131
*/
3232
getMany(
3333
params: OptionalDefaults<GetSpaceEnvironmentParams & { query: FragmentQueryOptions }>,
34-
): Promise<CursorPaginatedCollectionProp<FragmentProps>>
34+
): Promise<ExoCursorPaginatedCollectionProp<FragmentProps>>
3535

3636
/**
3737
* Fetches a single fragment by ID

lib/plain/entities/template.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type {
2-
CursorPaginatedCollectionProp,
2+
ExoCursorPaginatedCollectionProp,
33
GetSpaceEnvironmentParams,
44
GetTemplateParams,
55
} from '../../common-types'
@@ -31,7 +31,7 @@ export type TemplatePlainClientAPI = {
3131
*/
3232
getMany(
3333
params: OptionalDefaults<GetSpaceEnvironmentParams & { query: TemplateQueryOptions }>,
34-
): Promise<CursorPaginatedCollectionProp<TemplateProps>>
34+
): Promise<ExoCursorPaginatedCollectionProp<TemplateProps>>
3535

3636
/**
3737
* Fetches a single template by ID

0 commit comments

Comments
 (0)