@ampsec/platform-client 6.0.0 → 8.0.0

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 (7) hide show
  1. package/build/src/dto/base.dto.d.ts +1 -1
  2. package/build/src/services/data.service.d.ts +2 -2
  3. package/build/src/services/entity.service.d.ts +8 -8
  4. package/package.json +1 -1
  5. package/src/dto/base.dto.ts +1 -1
  6. package/src/services/data.service.ts +2 -2
  7. package/src/services/entity.service.ts +8 -8
package/build/src/dto/base.dto.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export type BaseUpsertDto = {
2
2
  /** Unique Row Identifier. Populated for entity updates. */
3
- id?: number;
3
+ id?: string;
4
4
  };
5
5
  export type BaseDto = {
6
6
  /** Unique Row Identifier */
package/build/src/services/data.service.d.ts CHANGED
@@ -3,7 +3,7 @@ import { FilterCriteria } from '../FilterCriteria';
3
3
  import { RestClient, RestRequest } from './rest';
4
4
  export interface AmpDataService<ReadT extends BaseDto> {
5
5
  list(_filter: FilterCriteria): Promise<Page<ReadT>>;
6
- getById(_id: number): Promise<Page<ReadT>>;
6
+ getById(_id: string): Promise<Page<ReadT>>;
7
7
  }
8
8
  export interface ErrorHandler<T> {
9
9
  (_error: unknown): T;
@@ -19,5 +19,5 @@ export declare class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDat
19
19
  protected call<T>(req: RestRequest, errorHandler: ErrorHandler<T>): Promise<T>;
20
20
  protected getPage(req: RestRequest): Promise<Page<ReadT>>;
21
21
  list(filter: FilterCriteria): Promise<Page<ReadT>>;
22
- getById(id: number): Promise<Page<ReadT>>;
22
+ getById(id: string): Promise<Page<ReadT>>;
23
23
  }
package/build/src/services/entity.service.d.ts CHANGED
@@ -4,31 +4,31 @@ import { RestClient } from './rest';
4
4
  export interface AmpEntityService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
5
5
  create(_model: WriteT): Promise<Page<ReadT>>;
6
6
  update(_model: WriteT): Promise<Page<ReadT>>;
7
- delete(_id: number): Promise<Page<ReadT>>;
7
+ delete(_id: string): Promise<Page<ReadT>>;
8
8
  }
9
9
  export interface AmpGlobalEntityService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
10
10
  create(_model: WriteT): Promise<Page<ReadT>>;
11
11
  update(_model: WriteT): Promise<Page<ReadT>>;
12
- delete(_id: number): Promise<Page<ReadT>>;
13
- getLookupIds(_tid: number): Promise<ExtKeyMap>;
12
+ delete(_id: string): Promise<Page<ReadT>>;
13
+ getLookupIds(_tid: string): Promise<ExtKeyMap>;
14
14
  }
15
15
  export interface AmpSaaSEntityService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
16
16
  create(_model: WriteT): Promise<Page<ReadT>>;
17
17
  update(_model: WriteT): Promise<Page<ReadT>>;
18
- delete(_id: number): Promise<Page<ReadT>>;
19
- getLookupIds(_cid: number): Promise<ExtKeyMap>;
18
+ delete(_id: string): Promise<Page<ReadT>>;
19
+ getLookupIds(_cid: string): Promise<ExtKeyMap>;
20
20
  }
21
21
  export declare class AmpEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataServiceImpl<ReadT> implements AmpEntityService<WriteT, ReadT> {
22
22
  constructor(rest: RestClient, kind: string, targetApi?: TargetApi);
23
23
  create(model: WriteT): Promise<Page<ReadT>>;
24
24
  update(model: WriteT): Promise<Page<ReadT>>;
25
- delete(id: number): Promise<Page<ReadT>>;
25
+ delete(id: string): Promise<Page<ReadT>>;
26
26
  }
27
27
  export declare class AmpGlobalEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpEntityServiceImpl<WriteT, ReadT> implements AmpGlobalEntityService<WriteT, ReadT> {
28
28
  constructor(rest: RestClient, kind: string, targetApi?: TargetApi);
29
- getLookupIds(tid: number): Promise<ExtKeyMap>;
29
+ getLookupIds(tid: string): Promise<ExtKeyMap>;
30
30
  }
31
31
  export declare class AmpSaaSEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpEntityServiceImpl<WriteT, ReadT> implements AmpSaaSEntityService<WriteT, ReadT> {
32
32
  constructor(rest: RestClient, kind: string, targetApi?: TargetApi);
33
- getLookupIds(cid: number): Promise<ExtKeyMap>;
33
+ getLookupIds(cid: string): Promise<ExtKeyMap>;
34
34
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ampsec/platform-client",
3
- "version": "6.0.0",
3
+ "version": "8.0.0",
4
4
  "description": "",
5
5
  "main": "build/src/index.js",
6
6
  "scripts": {
package/src/dto/base.dto.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export type BaseUpsertDto = {
2
2
  /** Unique Row Identifier. Populated for entity updates. */
3
- id?: number;
3
+ id?: string;
4
4
  };
5
5
 
6
6
  export type BaseDto = {
package/src/services/data.service.ts CHANGED
@@ -4,7 +4,7 @@ import {RestClient, RestRequest} from './rest';
4
4
 
5
5
  export interface AmpDataService<ReadT extends BaseDto> {
6
6
  list(_filter: FilterCriteria): Promise<Page<ReadT>>;
7
- getById(_id: number): Promise<Page<ReadT>>;
7
+ getById(_id: string): Promise<Page<ReadT>>;
8
8
  }
9
9
 
10
10
  export interface ErrorHandler<T> {
@@ -60,7 +60,7 @@ export class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService
60
60
  });
61
61
  }
62
62
 
63
- getById(id: number): Promise<Page<ReadT>> {
63
+ getById(id: string): Promise<Page<ReadT>> {
64
64
  return this.getPage({
65
65
  url: `/${this.targetApi}/v1/${this.kind}/${id}`,
66
66
  method: 'GET',
package/src/services/entity.service.ts CHANGED
@@ -5,19 +5,19 @@ import {RestClient, RestRequest} from './rest';
5
5
  export interface AmpEntityService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
6
6
  create(_model: WriteT): Promise<Page<ReadT>>;
7
7
  update(_model: WriteT): Promise<Page<ReadT>>;
8
- delete(_id: number): Promise<Page<ReadT>>;
8
+ delete(_id: string): Promise<Page<ReadT>>;
9
9
  }
10
10
  export interface AmpGlobalEntityService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
11
11
  create(_model: WriteT): Promise<Page<ReadT>>;
12
12
  update(_model: WriteT): Promise<Page<ReadT>>;
13
- delete(_id: number): Promise<Page<ReadT>>;
14
- getLookupIds(_tid: number): Promise<ExtKeyMap>;
13
+ delete(_id: string): Promise<Page<ReadT>>;
14
+ getLookupIds(_tid: string): Promise<ExtKeyMap>;
15
15
  }
16
16
  export interface AmpSaaSEntityService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
17
17
  create(_model: WriteT): Promise<Page<ReadT>>;
18
18
  update(_model: WriteT): Promise<Page<ReadT>>;
19
- delete(_id: number): Promise<Page<ReadT>>;
20
- getLookupIds(_cid: number): Promise<ExtKeyMap>;
19
+ delete(_id: string): Promise<Page<ReadT>>;
20
+ getLookupIds(_cid: string): Promise<ExtKeyMap>;
21
21
  }
22
22
 
23
23
  export class AmpEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataServiceImpl<ReadT> implements AmpEntityService<WriteT, ReadT> {
@@ -41,7 +41,7 @@ export class AmpEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends Ba
41
41
  });
42
42
  }
43
43
 
44
- async delete(id: number): Promise<Page<ReadT>> {
44
+ async delete(id: string): Promise<Page<ReadT>> {
45
45
  const res = await this.getById(id);
46
46
  if (res.data.length === 1) {
47
47
  const req: RestRequest = {
@@ -76,7 +76,7 @@ export class AmpGlobalEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT exte
76
76
  constructor(rest: RestClient, kind: string, targetApi: TargetApi = TARGET_API_AGENT) {
77
77
  super(rest, kind, targetApi);
78
78
  }
79
- getLookupIds(tid: number): Promise<ExtKeyMap> {
79
+ getLookupIds(tid: string): Promise<ExtKeyMap> {
80
80
  const req: RestRequest = {
81
81
  url: `/${this.targetApi}/v1/${this.kind}/ext_key_map`,
82
82
  method: 'GET',
@@ -93,7 +93,7 @@ export class AmpSaaSEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extend
93
93
  constructor(rest: RestClient, kind: string, targetApi: TargetApi = TARGET_API_AGENT) {
94
94
  super(rest, kind, targetApi);
95
95
  }
96
- getLookupIds(cid: number): Promise<ExtKeyMap> {
96
+ getLookupIds(cid: string): Promise<ExtKeyMap> {
97
97
  const req: RestRequest = {
98
98
  url: `/${this.targetApi}/v1/${this.kind}/ext_key_map`,
99
99
  method: 'GET',