@ptkl/sdk 1.3.1 → 1.3.2

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 (61) hide show
  1. package/dist/index.0.10.js +30 -0
  2. package/dist/package.json +1 -1
  3. package/dist/v0.10/api/component.d.ts +26 -0
  4. package/dist/v0.10/index.cjs.js +30 -0
  5. package/dist/v0.10/index.esm.js +30 -0
  6. package/package.json +1 -1
  7. package/dist/v0.10/api/integrations/serbiaUtil.d.ts +0 -12
  8. package/dist/v0.10/api/integrations/vpfr.d.ts +0 -4
  9. package/dist/v0.10/apiUser.d.ts +0 -9
  10. package/dist/v0.10/apps.d.ts +0 -8
  11. package/dist/v0.10/baseClient.d.ts +0 -6
  12. package/dist/v0.10/component.d.ts +0 -128
  13. package/dist/v0.10/componentUtils.d.ts +0 -7
  14. package/dist/v0.10/config.d.ts +0 -14
  15. package/dist/v0.10/forge.d.ts +0 -7
  16. package/dist/v0.10/functions.d.ts +0 -23
  17. package/dist/v0.10/index.d.ts +0 -21
  18. package/dist/v0.10/integrations/dms.d.ts +0 -469
  19. package/dist/v0.10/integrations/invoicing.d.ts +0 -6
  20. package/dist/v0.10/integrations/minimax.d.ts +0 -289
  21. package/dist/v0.10/integrations/payments.d.ts +0 -40
  22. package/dist/v0.10/integrations/serbiaUtil.d.ts +0 -10
  23. package/dist/v0.10/integrations/vpfr.d.ts +0 -4
  24. package/dist/v0.10/integrations.d.ts +0 -22
  25. package/dist/v0.10/integrationsBaseClient.d.ts +0 -11
  26. package/dist/v0.10/platform.d.ts +0 -34
  27. package/dist/v0.10/platformBaseClient.d.ts +0 -27
  28. package/dist/v0.10/project.d.ts +0 -146
  29. package/dist/v0.10/ratchet.d.ts +0 -196
  30. package/dist/v0.10/sandbox.d.ts +0 -14
  31. package/dist/v0.10/system.d.ts +0 -4
  32. package/dist/v0.10/thunder.d.ts +0 -13
  33. package/dist/v0.10/types/integrations/serbiaUtits.d.ts +0 -37
  34. package/dist/v0.10/users.d.ts +0 -69
  35. package/dist/v0.10/workflow.d.ts +0 -5
  36. package/dist/v0.9/apiUser.d.ts +0 -9
  37. package/dist/v0.9/apps.d.ts +0 -8
  38. package/dist/v0.9/baseClient.d.ts +0 -6
  39. package/dist/v0.9/component.d.ts +0 -128
  40. package/dist/v0.9/componentUtils.d.ts +0 -7
  41. package/dist/v0.9/config.d.ts +0 -14
  42. package/dist/v0.9/forge.d.ts +0 -7
  43. package/dist/v0.9/functions.d.ts +0 -23
  44. package/dist/v0.9/index.d.ts +0 -21
  45. package/dist/v0.9/integrations/dms.d.ts +0 -469
  46. package/dist/v0.9/integrations/invoicing.d.ts +0 -6
  47. package/dist/v0.9/integrations/minimax.d.ts +0 -289
  48. package/dist/v0.9/integrations/payments.d.ts +0 -40
  49. package/dist/v0.9/integrations/serbiaUtil.d.ts +0 -10
  50. package/dist/v0.9/integrations/vpfr.d.ts +0 -4
  51. package/dist/v0.9/integrations.d.ts +0 -22
  52. package/dist/v0.9/integrationsBaseClient.d.ts +0 -11
  53. package/dist/v0.9/platform.d.ts +0 -34
  54. package/dist/v0.9/platformBaseClient.d.ts +0 -27
  55. package/dist/v0.9/project.d.ts +0 -146
  56. package/dist/v0.9/ratchet.d.ts +0 -196
  57. package/dist/v0.9/sandbox.d.ts +0 -14
  58. package/dist/v0.9/system.d.ts +0 -4
  59. package/dist/v0.9/thunder.d.ts +0 -13
  60. package/dist/v0.9/users.d.ts +0 -69
  61. package/dist/v0.9/workflow.d.ts +0 -5
@@ -405,6 +405,21 @@ var ProtokolSDK010 = (function (exports, axios) {
405
405
  async revisions(uuid) {
406
406
  return await this.client.get(`/v3/system/component/${this.ref}/model/${uuid}/revisions`);
407
407
  }
408
+ /**
409
+ * Get a single extension by name from the component
410
+ *
411
+ * @param name - The name of the extension to retrieve
412
+ * @param version - The component version
413
+ * @returns The extension object
414
+ *
415
+ * @example
416
+ * ```typescript
417
+ * const extension = await component.getExtension('shipping_tracker', '0.1.0')
418
+ * ```
419
+ */
420
+ async getExtension(name, version) {
421
+ return await this.client.get(`/v4/system/component/${this.ref}/${version}/extensions/${name}`);
422
+ }
408
423
  /**
409
424
  * Install a new extension on the component
410
425
  *
@@ -459,6 +474,21 @@ var ProtokolSDK010 = (function (exports, axios) {
459
474
  async deleteExtension(name, version) {
460
475
  return await this.client.delete(`/v4/system/component/${this.ref}/${version}/extensions/${name}`);
461
476
  }
477
+ /**
478
+ * Get a single policy by name from the component
479
+ *
480
+ * @param name - The name of the policy to retrieve
481
+ * @param version - The component version
482
+ * @returns The policy object
483
+ *
484
+ * @example
485
+ * ```typescript
486
+ * const policy = await component.getPolicy('restrict_email', '0.1.0')
487
+ * ```
488
+ */
489
+ async getPolicy(name, version) {
490
+ return await this.client.get(`/v4/system/component/${this.ref}/${version}/policies/${name}`);
491
+ }
462
492
  /**
463
493
  * Install a new policy on the component
464
494
  *
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ptkl/sdk",
3
- "version": "1.3.0",
3
+ "version": "1.3.2",
4
4
  "scripts": {
5
5
  "build": "rollup -c",
6
6
  "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",
@@ -161,6 +161,19 @@ export default class Component extends PlatformBaseClient {
161
161
  workflow(event: string, input: any): Promise<AxiosResponse<any, any>>;
162
162
  function(name: string, input: any): Promise<AxiosResponse<any, any>>;
163
163
  revisions(uuid: string): Promise<AxiosResponse<any, any>>;
164
+ /**
165
+ * Get a single extension by name from the component
166
+ *
167
+ * @param name - The name of the extension to retrieve
168
+ * @param version - The component version
169
+ * @returns The extension object
170
+ *
171
+ * @example
172
+ * ```typescript
173
+ * const extension = await component.getExtension('shipping_tracker', '0.1.0')
174
+ * ```
175
+ */
176
+ getExtension(name: string, version: string): Promise<AxiosResponse<any, any>>;
164
177
  /**
165
178
  * Install a new extension on the component
166
179
  *
@@ -209,6 +222,19 @@ export default class Component extends PlatformBaseClient {
209
222
  * ```
210
223
  */
211
224
  deleteExtension(name: string, version: string): Promise<AxiosResponse<any, any>>;
225
+ /**
226
+ * Get a single policy by name from the component
227
+ *
228
+ * @param name - The name of the policy to retrieve
229
+ * @param version - The component version
230
+ * @returns The policy object
231
+ *
232
+ * @example
233
+ * ```typescript
234
+ * const policy = await component.getPolicy('restrict_email', '0.1.0')
235
+ * ```
236
+ */
237
+ getPolicy(name: string, version: string): Promise<AxiosResponse<any, any>>;
212
238
  /**
213
239
  * Install a new policy on the component
214
240
  *
@@ -19371,6 +19371,21 @@ class Component extends PlatformBaseClient {
19371
19371
  async revisions(uuid) {
19372
19372
  return await this.client.get(`/v3/system/component/${this.ref}/model/${uuid}/revisions`);
19373
19373
  }
19374
+ /**
19375
+ * Get a single extension by name from the component
19376
+ *
19377
+ * @param name - The name of the extension to retrieve
19378
+ * @param version - The component version
19379
+ * @returns The extension object
19380
+ *
19381
+ * @example
19382
+ * ```typescript
19383
+ * const extension = await component.getExtension('shipping_tracker', '0.1.0')
19384
+ * ```
19385
+ */
19386
+ async getExtension(name, version) {
19387
+ return await this.client.get(`/v4/system/component/${this.ref}/${version}/extensions/${name}`);
19388
+ }
19374
19389
  /**
19375
19390
  * Install a new extension on the component
19376
19391
  *
@@ -19425,6 +19440,21 @@ class Component extends PlatformBaseClient {
19425
19440
  async deleteExtension(name, version) {
19426
19441
  return await this.client.delete(`/v4/system/component/${this.ref}/${version}/extensions/${name}`);
19427
19442
  }
19443
+ /**
19444
+ * Get a single policy by name from the component
19445
+ *
19446
+ * @param name - The name of the policy to retrieve
19447
+ * @param version - The component version
19448
+ * @returns The policy object
19449
+ *
19450
+ * @example
19451
+ * ```typescript
19452
+ * const policy = await component.getPolicy('restrict_email', '0.1.0')
19453
+ * ```
19454
+ */
19455
+ async getPolicy(name, version) {
19456
+ return await this.client.get(`/v4/system/component/${this.ref}/${version}/policies/${name}`);
19457
+ }
19428
19458
  /**
19429
19459
  * Install a new policy on the component
19430
19460
  *
@@ -404,6 +404,21 @@ class Component extends PlatformBaseClient {
404
404
  async revisions(uuid) {
405
405
  return await this.client.get(`/v3/system/component/${this.ref}/model/${uuid}/revisions`);
406
406
  }
407
+ /**
408
+ * Get a single extension by name from the component
409
+ *
410
+ * @param name - The name of the extension to retrieve
411
+ * @param version - The component version
412
+ * @returns The extension object
413
+ *
414
+ * @example
415
+ * ```typescript
416
+ * const extension = await component.getExtension('shipping_tracker', '0.1.0')
417
+ * ```
418
+ */
419
+ async getExtension(name, version) {
420
+ return await this.client.get(`/v4/system/component/${this.ref}/${version}/extensions/${name}`);
421
+ }
407
422
  /**
408
423
  * Install a new extension on the component
409
424
  *
@@ -458,6 +473,21 @@ class Component extends PlatformBaseClient {
458
473
  async deleteExtension(name, version) {
459
474
  return await this.client.delete(`/v4/system/component/${this.ref}/${version}/extensions/${name}`);
460
475
  }
476
+ /**
477
+ * Get a single policy by name from the component
478
+ *
479
+ * @param name - The name of the policy to retrieve
480
+ * @param version - The component version
481
+ * @returns The policy object
482
+ *
483
+ * @example
484
+ * ```typescript
485
+ * const policy = await component.getPolicy('restrict_email', '0.1.0')
486
+ * ```
487
+ */
488
+ async getPolicy(name, version) {
489
+ return await this.client.get(`/v4/system/component/${this.ref}/${version}/policies/${name}`);
490
+ }
461
491
  /**
462
492
  * Install a new policy on the component
463
493
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ptkl/sdk",
3
- "version": "1.3.1",
3
+ "version": "1.3.2",
4
4
  "scripts": {
5
5
  "build": "rollup -c",
6
6
  "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",
@@ -1,12 +0,0 @@
1
- import IntegrationsBaseClient from "../integrationsBaseClient";
2
- import { AxiosResponse } from "axios";
3
- import { GenerateIPSQrCodeRequest, IPSQrCodeResponse } from "../../types/integrations/serbiaUtits";
4
- export default class SerbiaUtil extends IntegrationsBaseClient {
5
- nbsSearch(params: any): Promise<AxiosResponse<any, any>>;
6
- getNbsIpsQrCode(code: GenerateIPSQrCodeRequest, size: number, lang?: string): Promise<AxiosResponse<IPSQrCodeResponse>>;
7
- validateNbsIpsQrCode(qrCodeString: string, lang?: string): Promise<AxiosResponse<IPSQrCodeResponse>>;
8
- getReceiptFromUrl(url: string, source: string): Promise<AxiosResponse<any, any>>;
9
- getContoList(): Promise<AxiosResponse<any, any>>;
10
- services(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
11
- request(method: string, endpoint: string, params: any): Promise<AxiosResponse<any, any>>;
12
- }
@@ -1,4 +0,0 @@
1
- import IntegrationsBaseClient from "../integrationsBaseClient";
2
- export default class VPFR extends IntegrationsBaseClient {
3
- request(method: string, endpoint: string, params?: any): Promise<import("axios").AxiosResponse<any, any>>;
4
- }
@@ -1,9 +0,0 @@
1
- import PlatformBaseClient from "./platformBaseClient";
2
- export default class APIUser extends PlatformBaseClient {
3
- auth(username: string, password: string, project: string): Promise<import("axios").AxiosResponse<any, any>>;
4
- newSecret(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
5
- revokeSecret(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
6
- edit(uuid: string, roles: string[]): Promise<import("axios").AxiosResponse<any, any>>;
7
- list(): Promise<any>;
8
- get(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
9
- }
@@ -1,8 +0,0 @@
1
- import PlatformBaseClient from "./platformBaseClient";
2
- export default class Apps extends PlatformBaseClient {
3
- private appType;
4
- constructor(appType?: string);
5
- updateSettings(updateValues: any, ref: string): Promise<any>;
6
- download(ref: string, version: string): Promise<any>;
7
- upload(formData: FormData): Promise<any>;
8
- }
@@ -1,6 +0,0 @@
1
- import { AxiosInstance } from "axios";
2
- export default class BaseClient {
3
- client: AxiosInstance;
4
- constructor(client: AxiosInstance);
5
- setClient(client: AxiosInstance): this;
6
- }
@@ -1,128 +0,0 @@
1
- import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, StreamHandler, AggregateChainable, ComponentOptions } from "./types/component";
2
- import PlatformBaseClient from "./platformBaseClient";
3
- import { AxiosResponse } from "axios";
4
- export default class Component extends PlatformBaseClient {
5
- private ref;
6
- private version;
7
- constructor(ref?: string | null, options?: ComponentOptions);
8
- /**
9
- * Get the base path for component API calls
10
- * @private
11
- */
12
- private getComponentPath;
13
- /**
14
- * Find method to search for models
15
- *
16
- * @param {FindParams} filters - The filters to apply to the search
17
- * @param {FindOptions} opts - The options to apply to the search
18
- *
19
- * @returns {Promise<FindResponse>} - The result of the search
20
- *
21
- * @example
22
- * platform.component(name).find({
23
- * currentPage: 1,
24
- * perPage: 10,
25
- * })
26
- *
27
- * // advanced search
28
- * platform.component(name).find({
29
- * $adv: {
30
- * name: "John Doe",
31
- * }
32
- * )
33
- **/
34
- find(filters: FindParams, opts?: FindOptions): Promise<AxiosResponse<FindResponse>>;
35
- /**
36
- * FindOne method to search for a single model
37
- *
38
- * @param {FindAdvancedParams} filter - The filters to apply to the search
39
- * @param {FindOptions} opts - The options to apply to the search
40
- *
41
- * @returns {Promise<?Model>} - The result of the search
42
- *
43
- * @example
44
- * platform.component(name).findOne({
45
- * name: "John Doe",
46
- * })
47
- **/
48
- findOne(filter: FindAdvancedParams, opts: FindOptions): Promise<Model | null>;
49
- /**
50
- * Get model by uuid
51
- *
52
- * @param uuid string - The uuid of the model
53
- * @returns (Promise<Model>)
54
- */
55
- get(uuid: string): Promise<AxiosResponse<Model>>;
56
- /**
57
- * Update model by uuid
58
- *
59
- * @param uuid string - The uuid of the model
60
- * @param data
61
- * @returns
62
- */
63
- update(uuid: string, data: Record<string, any>, options: UpdateOptions): Promise<AxiosResponse<any, any>>;
64
- /**
65
- * Update many models
66
- *
67
- * @param data
68
- * @param options
69
- * @returns
70
- */
71
- updateMany(data: Record<string, any>[], options: UpdateOptions): Promise<AxiosResponse<any, any>>;
72
- /**
73
- * Modify models by filters
74
- *
75
- * @param data
76
- * @param options
77
- * @returns
78
- */
79
- modify(filters: Record<string, any>, data: Record<string, any>, options: ModifyOptions): Promise<AxiosResponse<any, any>>;
80
- /**
81
- * Concurrent update model by uuid
82
- *
83
- * @param uuid string - The uuid of the model
84
- * @param version number - The version of the model
85
- * @param data
86
- * @returns
87
- */
88
- concurrentUpdate(uuid: string, version: number, data: Record<string, any>, options: UpdateOptions): Promise<AxiosResponse<any, any>>;
89
- create(model: Record<string, any>): Promise<AxiosResponse<any, any>>;
90
- delete(uuid: string): Promise<AxiosResponse<any, any>>;
91
- /**
92
- * Execute aggregate pipeline with optional streaming support
93
- *
94
- * Returns a chainable object that allows both buffered and streaming modes.
95
- * Call .onData() to enable streaming mode, or await directly for buffered mode.
96
- *
97
- * @param {FindAggregateParams} pipeline - MongoDB aggregation pipeline
98
- *
99
- * @returns {AggregateChainable} Chainable object with streaming methods and Promise interface
100
- *
101
- * @example
102
- * ```typescript
103
- * // Buffered response (default, up to 5K documents)
104
- * const result = await component.aggregate([{ $match: { status: 'active' } }]);
105
- * console.log(result.data); // All results at once
106
- *
107
- * // Streaming response (up to 25K documents)
108
- * await component.aggregate([{ $match: { status: 'active' } }])
109
- * .onData((doc) => console.log('Received:', doc))
110
- * .onError((err) => console.error('Error:', err))
111
- * .onEnd(() => console.log('Stream complete'));
112
- * ```
113
- */
114
- aggregate(pipeline: FindAggregateParams): AggregateChainable;
115
- settings(): Promise<AxiosResponse<any, any>>;
116
- saveSettings(settings: any, version: string): Promise<AxiosResponse<any, any>>;
117
- saveTemplatesDist(version: string, sdkVersion: string, engine: string, dist: Record<string, string>): Promise<any>;
118
- workflow(event: string, input: any): Promise<AxiosResponse<any, any>>;
119
- function(name: string, input: any): Promise<AxiosResponse<any, any>>;
120
- revisions(uuid: string): Promise<AxiosResponse<any, any>>;
121
- /**
122
- * Internal method to handle NDJSON streaming responses
123
- *
124
- * @private
125
- */
126
- private _streamNDJSON;
127
- }
128
- export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, StreamHandler, AggregateChainable, ComponentOptions, };
@@ -1,7 +0,0 @@
1
- import { AxiosResponse } from "axios";
2
- import { ComponentListResponse } from "./types/component";
3
- import PlatformBaseClient from "./platformBaseClient";
4
- export default class ComponentUtils extends PlatformBaseClient {
5
- list(): Promise<AxiosResponse<ComponentListResponse>>;
6
- create(data: any): Promise<AxiosResponse<any, any>>;
7
- }
@@ -1,14 +0,0 @@
1
- import PlatformBaseClient from "./platformBaseClient";
2
- import { AxiosResponse } from "axios";
3
- import { ConfigUpdateRequest, UserConfig } from './types/config';
4
- export default class Config extends PlatformBaseClient {
5
- /**
6
- * Get user configuration
7
- */
8
- getUserConfig(): Promise<AxiosResponse<UserConfig>>;
9
- /**
10
- * Update user configuration
11
- * @param config Configuration data
12
- */
13
- updateUserConfig(config: ConfigUpdateRequest): Promise<AxiosResponse<any>>;
14
- }
@@ -1,7 +0,0 @@
1
- import PlatformBaseClient from "./platformBaseClient";
2
- export default class Forge extends PlatformBaseClient {
3
- bundleUpload(buffer: Buffer): Promise<any>;
4
- getWorkspaceApps(): Promise<any>;
5
- removeVersion(ref: string, version: string): Promise<any>;
6
- list(): Promise<any>;
7
- }
@@ -1,23 +0,0 @@
1
- import PlatformBaseClient from "./platformBaseClient";
2
- export default class Functions extends PlatformBaseClient {
3
- list(): Promise<any>;
4
- get(ref: string): Promise<any>;
5
- update(uuid: string, update: any): Promise<any>;
6
- /**
7
- * Run platform function
8
- *
9
- * @param id - Function ID
10
- * @param input - Input data
11
- * @param query - Query parameters
12
- * @returns - Function result
13
- *
14
- * @example
15
- * const result = await platform.function().run("myFunction", {input: { foo: "bar" }})
16
- */
17
- run(id: string, d: {
18
- input?: Record<string, any>;
19
- query?: Record<string, string>;
20
- headers?: Record<string, string>;
21
- }): Promise<any>;
22
- generateSignature(ref: string, env: string): Promise<import("axios").AxiosResponse<any, any>>;
23
- }
@@ -1,21 +0,0 @@
1
- export { default as Component } from './component';
2
- export { default as Platform } from './platform';
3
- export { default as Functions } from './functions';
4
- export { default as APIUser } from './apiUser';
5
- export { default as Users } from './users';
6
- export { default as Apps } from './apps';
7
- export { default as ComponentUtils } from './componentUtils';
8
- export { default as Thunder } from './thunder';
9
- export { default as Ratchet } from './ratchet';
10
- export { default as Sandbox } from './sandbox';
11
- export { default as System } from './system';
12
- export { default as Workflow } from './workflow';
13
- export { default as Forge } from './forge';
14
- export { default as Project } from './project';
15
- export { default as Config } from './config';
16
- export { default as Integrations } from './integrations';
17
- export { default as Payments } from './integrations/payments';
18
- export { default as Invoicing } from './integrations/invoicing';
19
- export { default as DMS } from './integrations/dms';
20
- export { default as SerbiaUtil } from './integrations/serbiaUtil';
21
- export { default as VPFR } from './integrations/vpfr';