@commercelayer/sdk 6.0.0-beta.15 → 6.0.0-beta.16

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.
Files changed (3) hide show
  1. package/lib/index.d.mts +5 -5
  2. package/lib/index.d.ts +5 -5
  3. package/package.json +1 -1
package/lib/index.d.mts CHANGED
@@ -86,7 +86,7 @@ type QueryArrayFields<R extends Resource> = Array<QueryResourceFields<QueryResTy
86
86
  type QueryRecordFields = {
87
87
  [key in keyof ResourceFields]?: Array<(QueryResourceFields<key>)>;
88
88
  };
89
- interface QueryParamsRetrieve<R extends Resource = Resource> {
89
+ interface QueryParamsRetrieve<R extends Resource> {
90
90
  include?: QueryInclude;
91
91
  fields?: QueryArrayFields<R> | QueryRecordFields;
92
92
  }
@@ -98,13 +98,13 @@ type QueryRecordSortable<R extends Resource> = Partial<Record<keyof QueryResourc
98
98
  type QueryFilter = Record<string, string | number | boolean | object | Array<string | number>>;
99
99
  type QueryPageNumber = number;
100
100
  type QueryPageSize = PositiveNumberRange<25>;
101
- interface QueryParamsList<R extends Resource = Resource> extends QueryParamsRetrieve<R> {
101
+ interface QueryParamsList<R extends Resource> extends QueryParamsRetrieve<R> {
102
102
  sort?: QueryArraySortable<R> | QueryRecordSortable<R>;
103
103
  filters?: QueryFilter;
104
104
  pageNumber?: QueryPageNumber;
105
105
  pageSize?: QueryPageSize;
106
106
  }
107
- type QueryParams<R extends Resource = Resource> = QueryParamsRetrieve<R> | QueryParamsList<R>;
107
+ type QueryParams<R extends Resource> = QueryParamsRetrieve<R> | QueryParamsList<R>;
108
108
 
109
109
  declare const isParamsList: <R extends Resource>(params: any) => params is QueryParamsList<R>;
110
110
  type QueryStringParams = Record<string, string>;
@@ -182,7 +182,7 @@ declare abstract class ApiResourceBase<R extends Resource> {
182
182
  protected relationshipOneToOne<RR extends ResourceRel>(id: string | ResourceId | null): RR;
183
183
  protected relationshipOneToMany<RR extends ResourceRel>(...ids: string[]): RR[];
184
184
  abstract type(): ResourceTypeLock;
185
- update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
185
+ update(resource: ResourceUpdate, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
186
186
  }
187
187
  declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
188
188
  retrieve(id: string | ResourceId, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
@@ -190,7 +190,7 @@ declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R
190
190
  count(filter?: QueryFilter | QueryParamsList<R>, options?: ResourcesConfig): Promise<number>;
191
191
  }
192
192
  declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
193
- retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
193
+ retrieve(params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
194
194
  }
195
195
 
196
196
  type TagType = 'tags';
package/lib/index.d.ts CHANGED
@@ -86,7 +86,7 @@ type QueryArrayFields<R extends Resource> = Array<QueryResourceFields<QueryResTy
86
86
  type QueryRecordFields = {
87
87
  [key in keyof ResourceFields]?: Array<(QueryResourceFields<key>)>;
88
88
  };
89
- interface QueryParamsRetrieve<R extends Resource = Resource> {
89
+ interface QueryParamsRetrieve<R extends Resource> {
90
90
  include?: QueryInclude;
91
91
  fields?: QueryArrayFields<R> | QueryRecordFields;
92
92
  }
@@ -98,13 +98,13 @@ type QueryRecordSortable<R extends Resource> = Partial<Record<keyof QueryResourc
98
98
  type QueryFilter = Record<string, string | number | boolean | object | Array<string | number>>;
99
99
  type QueryPageNumber = number;
100
100
  type QueryPageSize = PositiveNumberRange<25>;
101
- interface QueryParamsList<R extends Resource = Resource> extends QueryParamsRetrieve<R> {
101
+ interface QueryParamsList<R extends Resource> extends QueryParamsRetrieve<R> {
102
102
  sort?: QueryArraySortable<R> | QueryRecordSortable<R>;
103
103
  filters?: QueryFilter;
104
104
  pageNumber?: QueryPageNumber;
105
105
  pageSize?: QueryPageSize;
106
106
  }
107
- type QueryParams<R extends Resource = Resource> = QueryParamsRetrieve<R> | QueryParamsList<R>;
107
+ type QueryParams<R extends Resource> = QueryParamsRetrieve<R> | QueryParamsList<R>;
108
108
 
109
109
  declare const isParamsList: <R extends Resource>(params: any) => params is QueryParamsList<R>;
110
110
  type QueryStringParams = Record<string, string>;
@@ -182,7 +182,7 @@ declare abstract class ApiResourceBase<R extends Resource> {
182
182
  protected relationshipOneToOne<RR extends ResourceRel>(id: string | ResourceId | null): RR;
183
183
  protected relationshipOneToMany<RR extends ResourceRel>(...ids: string[]): RR[];
184
184
  abstract type(): ResourceTypeLock;
185
- update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
185
+ update(resource: ResourceUpdate, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
186
186
  }
187
187
  declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
188
188
  retrieve(id: string | ResourceId, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
@@ -190,7 +190,7 @@ declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R
190
190
  count(filter?: QueryFilter | QueryParamsList<R>, options?: ResourcesConfig): Promise<number>;
191
191
  }
192
192
  declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
193
- retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
193
+ retrieve(params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
194
194
  }
195
195
 
196
196
  type TagType = 'tags';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@commercelayer/sdk",
3
- "version": "6.0.0-beta.15",
3
+ "version": "6.0.0-beta.16",
4
4
  "main": "lib/index.js",
5
5
  "types": "lib/index.d.ts",
6
6
  "module": "lib/index.mjs",