@simpleapps-com/augur-api 2026.10.12 → 2026.10.14
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/{client-XZzK8xkq.d.mts → client-CuHrZyBA.d.mts} +39 -292
- package/dist/{client-XZzK8xkq.d.ts → client-CuHrZyBA.d.ts} +39 -292
- package/dist/index.d.mts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +2788 -564
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2788 -564
- package/dist/index.mjs.map +1 -1
- package/dist/testing.d.mts +1 -1
- package/dist/testing.d.ts +1 -1
- package/package.json +3 -1
|
@@ -104,6 +104,43 @@ interface CallResult {
|
|
|
104
104
|
body: unknown;
|
|
105
105
|
}
|
|
106
106
|
|
|
107
|
+
/** One path or query param of an endpoint. */
|
|
108
|
+
interface EndpointParam {
|
|
109
|
+
/** Where the value goes */
|
|
110
|
+
readonly in: 'path' | 'query';
|
|
111
|
+
/** `integer|integer[]` is one value or a list (sent comma-joined) */
|
|
112
|
+
readonly type: 'string' | 'integer' | 'number' | 'boolean' | 'integer|integer[]';
|
|
113
|
+
readonly required: boolean;
|
|
114
|
+
/** The allowed values, when the spec lists them */
|
|
115
|
+
readonly enum?: readonly (string | number | boolean)[];
|
|
116
|
+
}
|
|
117
|
+
/** One endpoint in the registry. */
|
|
118
|
+
interface EndpointEntry {
|
|
119
|
+
/** `camelCase(service).chain.action`, e.g. `items.invMast.doc.list` */
|
|
120
|
+
readonly id: string;
|
|
121
|
+
/** Kebab wire name, e.g. `open-search` */
|
|
122
|
+
readonly service: string;
|
|
123
|
+
readonly method: 'GET' | 'POST' | 'PUT' | 'DELETE';
|
|
124
|
+
/** Path template, e.g. `/inv-mast/{invMastUid}/doc` */
|
|
125
|
+
readonly path: string;
|
|
126
|
+
/** Path params in URL order */
|
|
127
|
+
readonly pathParams: readonly string[];
|
|
128
|
+
/** Path param → anchored regex its value MUST match; params without one are absent */
|
|
129
|
+
readonly pathPatterns: Readonly<Record<string, string>>;
|
|
130
|
+
readonly queryParams: readonly string[];
|
|
131
|
+
/** Alternative action names; an alias id is `service.chain.alias` */
|
|
132
|
+
readonly aliases: readonly string[];
|
|
133
|
+
readonly hasBody: boolean;
|
|
134
|
+
readonly auth: 'none' | 'site' | 'bearer';
|
|
135
|
+
readonly edgeCache: boolean;
|
|
136
|
+
/** One-line summary from the spec; `''` when it has none */
|
|
137
|
+
readonly summary: string;
|
|
138
|
+
/** Every param by name, path params first (URL order), then query params */
|
|
139
|
+
readonly params: Readonly<Record<string, EndpointParam>>;
|
|
140
|
+
/** Omitted unless set; a read is `readOnly ?? method === 'GET'` */
|
|
141
|
+
readonly readOnly?: boolean;
|
|
142
|
+
}
|
|
143
|
+
|
|
107
144
|
/** A response as text, before any JSON parsing (what `call()` builds its result from). */
|
|
108
145
|
interface RawResponse {
|
|
109
146
|
status: number;
|
|
@@ -264,46 +301,6 @@ type HealthCheckData = v.InferOutput<typeof HealthCheckDataSchema>;
|
|
|
264
301
|
type PingData = v.InferOutput<typeof PingDataSchema>;
|
|
265
302
|
type WhoamiData = v.InferOutput<typeof WhoamiDataSchema>;
|
|
266
303
|
|
|
267
|
-
/**
|
|
268
|
-
* Interface for discovery metadata that AI agents can use to navigate services
|
|
269
|
-
*/
|
|
270
|
-
interface DiscoveryEndpoint$1 {
|
|
271
|
-
/** Complete API path (e.g., api.joomla.users.list) */
|
|
272
|
-
fullPath: string;
|
|
273
|
-
/** Service name (e.g., joomla, items) */
|
|
274
|
-
service: string;
|
|
275
|
-
/** Business domain (e.g., user-management, content-management) */
|
|
276
|
-
domain: string;
|
|
277
|
-
/** HTTP method (GET, POST, PUT, DELETE) */
|
|
278
|
-
method: string;
|
|
279
|
-
/** Endpoint URL path */
|
|
280
|
-
path: string;
|
|
281
|
-
/** Description of what this endpoint does */
|
|
282
|
-
description: string;
|
|
283
|
-
/** Array of search terms for AI navigation */
|
|
284
|
-
searchTerms: string[];
|
|
285
|
-
/** Related endpoints across services */
|
|
286
|
-
relatedEndpoints: string[];
|
|
287
|
-
/** Common usage patterns in natural language */
|
|
288
|
-
commonPatterns: string[];
|
|
289
|
-
/** Reference to data-only method alternative */
|
|
290
|
-
dataMethod?: string;
|
|
291
|
-
/** Whether this endpoint is discoverable by AI agents */
|
|
292
|
-
discoverable: boolean;
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
* Interface for service discovery metadata
|
|
296
|
-
*/
|
|
297
|
-
interface ServiceDiscoveryMetadata {
|
|
298
|
-
/** Service name */
|
|
299
|
-
serviceName: string;
|
|
300
|
-
/** Service description */
|
|
301
|
-
description: string;
|
|
302
|
-
/** Base URL for the service */
|
|
303
|
-
baseUrl: string;
|
|
304
|
-
/** Array of discoverable endpoints */
|
|
305
|
-
endpoints: DiscoveryEndpoint$1[];
|
|
306
|
-
}
|
|
307
304
|
/**
|
|
308
305
|
* HTTP method types for API operations
|
|
309
306
|
*/
|
|
@@ -326,8 +323,6 @@ interface EndpointConfig {
|
|
|
326
323
|
paramsSchema?: v.GenericSchema;
|
|
327
324
|
/** Valibot schema for validating response data */
|
|
328
325
|
responseSchema: v.GenericSchema;
|
|
329
|
-
/** Whether this endpoint requires authentication (default: true) */
|
|
330
|
-
requiresAuth?: boolean;
|
|
331
326
|
}
|
|
332
327
|
/**
|
|
333
328
|
* Standard API response structure - REQUIRED for all services (8-field format)
|
|
@@ -480,42 +475,6 @@ declare abstract class BaseServiceClient {
|
|
|
480
475
|
* ```
|
|
481
476
|
*/
|
|
482
477
|
private buildEndpointPath;
|
|
483
|
-
/**
|
|
484
|
-
* Get discovery metadata for this service client
|
|
485
|
-
*
|
|
486
|
-
* Built from the endpoint registry, so it lists every endpoint this service
|
|
487
|
-
* exposes, including healthCheck, ping and whoami.
|
|
488
|
-
*
|
|
489
|
-
* @returns ServiceDiscoveryMetadata containing service info and endpoint metadata
|
|
490
|
-
*/
|
|
491
|
-
getDiscoveryMetadata(): ServiceDiscoveryMetadata;
|
|
492
|
-
/**
|
|
493
|
-
* Get service description - can be overridden by subclasses
|
|
494
|
-
*/
|
|
495
|
-
protected getServiceDescription(): string;
|
|
496
|
-
}
|
|
497
|
-
|
|
498
|
-
/** One endpoint in the registry. */
|
|
499
|
-
interface EndpointEntry {
|
|
500
|
-
/** `camelCase(service).chain.action`, e.g. `items.invMast.doc.list` */
|
|
501
|
-
readonly id: string;
|
|
502
|
-
/** Kebab wire name, e.g. `open-search` */
|
|
503
|
-
readonly service: string;
|
|
504
|
-
readonly method: 'GET' | 'POST' | 'PUT' | 'DELETE';
|
|
505
|
-
/** Path template, e.g. `/inv-mast/{invMastUid}/doc` */
|
|
506
|
-
readonly path: string;
|
|
507
|
-
/** Path params in URL order */
|
|
508
|
-
readonly pathParams: readonly string[];
|
|
509
|
-
/** Path param → anchored regex its value MUST match; params without one are absent */
|
|
510
|
-
readonly pathPatterns: Readonly<Record<string, string>>;
|
|
511
|
-
readonly queryParams: readonly string[];
|
|
512
|
-
/** Alternative action names; an alias id is `service.chain.alias` */
|
|
513
|
-
readonly aliases: readonly string[];
|
|
514
|
-
readonly hasBody: boolean;
|
|
515
|
-
readonly auth: 'none' | 'site' | 'bearer';
|
|
516
|
-
readonly edgeCache: boolean;
|
|
517
|
-
/** Omitted unless set; a read is `readOnly ?? method === 'GET'` */
|
|
518
|
-
readonly readOnly?: boolean;
|
|
519
478
|
}
|
|
520
479
|
|
|
521
480
|
/**
|
|
@@ -2138,7 +2097,6 @@ declare class JoomlaClient extends BaseServiceClient {
|
|
|
2138
2097
|
readonly usergroupsData: DataOnly<JoomlaClientSpec['usergroups']>;
|
|
2139
2098
|
readonly usersData: DataOnly<JoomlaClientSpec['users']>;
|
|
2140
2099
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
2141
|
-
protected getServiceDescription(): string;
|
|
2142
2100
|
}
|
|
2143
2101
|
|
|
2144
2102
|
/**
|
|
@@ -3363,7 +3321,6 @@ declare class CommerceClient extends BaseServiceClient {
|
|
|
3363
3321
|
readonly cartLineData: DataOnly<CommerceClientSpec['cartLine']>;
|
|
3364
3322
|
readonly checkoutData: DataOnly<CommerceClientSpec['checkout']>;
|
|
3365
3323
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
3366
|
-
protected getServiceDescription(): string;
|
|
3367
3324
|
}
|
|
3368
3325
|
|
|
3369
3326
|
/**
|
|
@@ -4756,7 +4713,6 @@ declare class PricingClient extends BaseServiceClient {
|
|
|
4756
4713
|
readonly taxEngineData: DataOnly<PricingClientSpec['taxEngine']>;
|
|
4757
4714
|
readonly webPricingData: DataOnly<PricingClientSpec['webPricing']>;
|
|
4758
4715
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
4759
|
-
protected getServiceDescription(): string;
|
|
4760
4716
|
}
|
|
4761
4717
|
|
|
4762
4718
|
/**
|
|
@@ -7641,7 +7597,6 @@ declare class VMIClient extends BaseServiceClient {
|
|
|
7641
7597
|
readonly sectionsData: DataOnly<VMIClientSpec['sections']>;
|
|
7642
7598
|
readonly warehouseData: DataOnly<VMIClientSpec['warehouse']>;
|
|
7643
7599
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
7644
|
-
protected getServiceDescription(): string;
|
|
7645
7600
|
}
|
|
7646
7601
|
|
|
7647
7602
|
/**
|
|
@@ -8730,7 +8685,6 @@ declare class OpenSearchClient extends BaseServiceClient {
|
|
|
8730
8685
|
readonly queryStringRedirectData: DataOnly<OpenSearchClientSpec['queryStringRedirect']>;
|
|
8731
8686
|
readonly suggestionsData: DataOnly<OpenSearchClientSpec['suggestions']>;
|
|
8732
8687
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
8733
|
-
protected getServiceDescription(): string;
|
|
8734
8688
|
}
|
|
8735
8689
|
|
|
8736
8690
|
/**
|
|
@@ -15864,7 +15818,6 @@ declare class ItemsClient extends BaseServiceClient {
|
|
|
15864
15818
|
readonly p21Data: DataOnly<ItemsClientSpec['p21']>;
|
|
15865
15819
|
readonly variantsData: DataOnly<ItemsClientSpec['variants']>;
|
|
15866
15820
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
15867
|
-
protected getServiceDescription(): string;
|
|
15868
15821
|
}
|
|
15869
15822
|
|
|
15870
15823
|
/**
|
|
@@ -17262,7 +17215,6 @@ declare class LegacyClient extends BaseServiceClient {
|
|
|
17262
17215
|
readonly itemCategoryData: DataOnly<LegacyClientSpec['itemCategory']>;
|
|
17263
17216
|
readonly legacyData: DataOnly<LegacyClientSpec['legacy']>;
|
|
17264
17217
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
17265
|
-
protected getServiceDescription(): string;
|
|
17266
17218
|
}
|
|
17267
17219
|
|
|
17268
17220
|
/**
|
|
@@ -18866,7 +18818,6 @@ declare class AgrSiteClient extends BaseServiceClient {
|
|
|
18866
18818
|
readonly settingsData: DataOnly<AgrSiteClientSpec['settings']>;
|
|
18867
18819
|
readonly usersData: DataOnly<AgrSiteClientSpec['users']>;
|
|
18868
18820
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
18869
|
-
protected getServiceDescription(): string;
|
|
18870
18821
|
}
|
|
18871
18822
|
|
|
18872
18823
|
/**
|
|
@@ -21608,7 +21559,6 @@ declare class CustomersClient extends BaseServiceClient {
|
|
|
21608
21559
|
readonly contactsUdData: DataOnly<CustomersClientSpec['contactsUd']>;
|
|
21609
21560
|
readonly customerData: DataOnly<CustomersClientSpec['customer']>;
|
|
21610
21561
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
21611
|
-
protected getServiceDescription(): string;
|
|
21612
21562
|
}
|
|
21613
21563
|
|
|
21614
21564
|
/**
|
|
@@ -22750,7 +22700,6 @@ declare class OrdersClient extends BaseServiceClient {
|
|
|
22750
22700
|
readonly poHdrData: DataOnly<OrdersClientSpec['poHdr']>;
|
|
22751
22701
|
readonly poLineData: DataOnly<OrdersClientSpec['poLine']>;
|
|
22752
22702
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
22753
|
-
protected getServiceDescription(): string;
|
|
22754
22703
|
}
|
|
22755
22704
|
|
|
22756
22705
|
/**
|
|
@@ -23805,7 +23754,6 @@ declare class P21PimClient extends BaseServiceClient {
|
|
|
23805
23754
|
readonly itemsData: DataOnly<P21PimClientSpec['items']>;
|
|
23806
23755
|
readonly podcastsData: DataOnly<P21PimClientSpec['podcasts']>;
|
|
23807
23756
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
23808
|
-
protected getServiceDescription(): string;
|
|
23809
23757
|
}
|
|
23810
23758
|
|
|
23811
23759
|
/**
|
|
@@ -25367,7 +25315,6 @@ declare class PaymentsClient extends BaseServiceClient {
|
|
|
25367
25315
|
readonly paytraceData: DataOnly<PaymentsClientSpec['paytrace']>;
|
|
25368
25316
|
readonly unifiedData: DataOnly<PaymentsClientSpec['unified']>;
|
|
25369
25317
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
25370
|
-
protected getServiceDescription(): string;
|
|
25371
25318
|
}
|
|
25372
25319
|
|
|
25373
25320
|
/**
|
|
@@ -26586,7 +26533,6 @@ declare class AgrInfoClient extends BaseServiceClient {
|
|
|
26586
26533
|
readonly sitesData: DataOnly<AgrInfoClientSpec['sites']>;
|
|
26587
26534
|
readonly workflowsData: DataOnly<AgrInfoClientSpec['workflows']>;
|
|
26588
26535
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
26589
|
-
protected getServiceDescription(): string;
|
|
26590
26536
|
}
|
|
26591
26537
|
|
|
26592
26538
|
/**
|
|
@@ -28745,7 +28691,6 @@ declare class AgrIntClient extends BaseServiceClient {
|
|
|
28745
28691
|
readonly rolesData: DataOnly<AgrIntClientSpec['roles']>;
|
|
28746
28692
|
readonly usersData: DataOnly<AgrIntClientSpec['users']>;
|
|
28747
28693
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
28748
|
-
protected getServiceDescription(): string;
|
|
28749
28694
|
}
|
|
28750
28695
|
|
|
28751
28696
|
/**
|
|
@@ -28768,7 +28713,6 @@ declare class AgrIntClient extends BaseServiceClient {
|
|
|
28768
28713
|
|
|
28769
28714
|
declare class AgrWorkClient extends BaseServiceClient {
|
|
28770
28715
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
28771
|
-
protected getServiceDescription(): string;
|
|
28772
28716
|
}
|
|
28773
28717
|
|
|
28774
28718
|
/**
|
|
@@ -28909,7 +28853,6 @@ declare class AvalaraClient extends BaseServiceClient {
|
|
|
28909
28853
|
readonly rates: AvalaraClientSpec['rates'];
|
|
28910
28854
|
readonly ratesData: DataOnly<AvalaraClientSpec['rates']>;
|
|
28911
28855
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
28912
|
-
protected getServiceDescription(): string;
|
|
28913
28856
|
}
|
|
28914
28857
|
|
|
28915
28858
|
/**
|
|
@@ -29150,7 +29093,6 @@ declare class BrandFolderClient extends BaseServiceClient {
|
|
|
29150
29093
|
readonly categories: BrandFolderClientSpec['categories'];
|
|
29151
29094
|
readonly categoriesData: DataOnly<BrandFolderClientSpec['categories']>;
|
|
29152
29095
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
29153
|
-
protected getServiceDescription(): string;
|
|
29154
29096
|
}
|
|
29155
29097
|
|
|
29156
29098
|
/**
|
|
@@ -29259,7 +29201,6 @@ declare class GregorovichClient extends BaseServiceClient {
|
|
|
29259
29201
|
readonly documents: GregorovichClientSpec['documents'];
|
|
29260
29202
|
readonly documentsData: DataOnly<GregorovichClientSpec['documents']>;
|
|
29261
29203
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
29262
|
-
protected getServiceDescription(): string;
|
|
29263
29204
|
}
|
|
29264
29205
|
|
|
29265
29206
|
/**
|
|
@@ -30210,7 +30151,6 @@ declare class LogisticsClient extends BaseServiceClient {
|
|
|
30210
30151
|
readonly speedshipData: DataOnly<LogisticsClientSpec['speedship']>;
|
|
30211
30152
|
readonly upsData: DataOnly<LogisticsClientSpec['ups']>;
|
|
30212
30153
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
30213
|
-
protected getServiceDescription(): string;
|
|
30214
30154
|
}
|
|
30215
30155
|
|
|
30216
30156
|
/**
|
|
@@ -30524,7 +30464,6 @@ declare class P21ApisClient extends BaseServiceClient {
|
|
|
30524
30464
|
readonly transUserData: DataOnly<P21ApisClientSpec['transUser']>;
|
|
30525
30465
|
readonly transWebDisplayTypeData: DataOnly<P21ApisClientSpec['transWebDisplayType']>;
|
|
30526
30466
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
30527
|
-
protected getServiceDescription(): string;
|
|
30528
30467
|
}
|
|
30529
30468
|
|
|
30530
30469
|
/**
|
|
@@ -31474,7 +31413,6 @@ declare class P21CoreClient extends BaseServiceClient {
|
|
|
31474
31413
|
readonly locationData: DataOnly<P21CoreClientSpec['location']>;
|
|
31475
31414
|
readonly paymentTypesData: DataOnly<P21CoreClientSpec['paymentTypes']>;
|
|
31476
31415
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
31477
|
-
protected getServiceDescription(): string;
|
|
31478
31416
|
}
|
|
31479
31417
|
|
|
31480
31418
|
/**
|
|
@@ -32779,7 +32717,6 @@ declare class P21SismClient extends BaseServiceClient {
|
|
|
32779
32717
|
readonly scheduledImportMasterData: DataOnly<P21SismClientSpec['scheduledImportMaster']>;
|
|
32780
32718
|
readonly scheduledImportMetadataData: DataOnly<P21SismClientSpec['scheduledImportMetadata']>;
|
|
32781
32719
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
32782
|
-
protected getServiceDescription(): string;
|
|
32783
32720
|
}
|
|
32784
32721
|
|
|
32785
32722
|
/**
|
|
@@ -32936,7 +32873,6 @@ declare class ShippingClient extends BaseServiceClient {
|
|
|
32936
32873
|
readonly rates: ShippingClientSpec['rates'];
|
|
32937
32874
|
readonly ratesData: DataOnly<ShippingClientSpec['rates']>;
|
|
32938
32875
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
32939
|
-
protected getServiceDescription(): string;
|
|
32940
32876
|
}
|
|
32941
32877
|
|
|
32942
32878
|
/**
|
|
@@ -33118,7 +33054,6 @@ declare class SmartyStreetsClient extends BaseServiceClient {
|
|
|
33118
33054
|
readonly us: SmartyStreetsClientSpec['us'];
|
|
33119
33055
|
readonly usData: DataOnly<SmartyStreetsClientSpec['us']>;
|
|
33120
33056
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
33121
|
-
protected getServiceDescription(): string;
|
|
33122
33057
|
}
|
|
33123
33058
|
|
|
33124
33059
|
/**
|
|
@@ -33253,7 +33188,6 @@ declare class UPSClient extends BaseServiceClient {
|
|
|
33253
33188
|
readonly ratesShop: UPSClientSpec['ratesShop'];
|
|
33254
33189
|
readonly ratesShopData: DataOnly<UPSClientSpec['ratesShop']>;
|
|
33255
33190
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
33256
|
-
protected getServiceDescription(): string;
|
|
33257
33191
|
}
|
|
33258
33192
|
|
|
33259
33193
|
/**
|
|
@@ -34970,40 +34904,8 @@ declare class Basecamp2Client extends BaseServiceClient {
|
|
|
34970
34904
|
readonly todosData: DataOnly<Basecamp2ClientSpec['todos']>;
|
|
34971
34905
|
readonly todosSummaryData: DataOnly<Basecamp2ClientSpec['todosSummary']>;
|
|
34972
34906
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
34973
|
-
protected getServiceDescription(): string;
|
|
34974
34907
|
}
|
|
34975
34908
|
|
|
34976
|
-
/**
|
|
34977
|
-
* Interface for discovery endpoint information - re-export base discovery endpoint
|
|
34978
|
-
*/
|
|
34979
|
-
type DiscoveryEndpoint = DiscoveryEndpoint$1;
|
|
34980
|
-
|
|
34981
|
-
/**
|
|
34982
|
-
* Interface for service discovery results
|
|
34983
|
-
*/
|
|
34984
|
-
interface ServiceMap {
|
|
34985
|
-
/** Service name */
|
|
34986
|
-
serviceName: string;
|
|
34987
|
-
/** Service description */
|
|
34988
|
-
description: string;
|
|
34989
|
-
/** Base URL for the service */
|
|
34990
|
-
baseUrl: string;
|
|
34991
|
-
/** Number of discoverable endpoints */
|
|
34992
|
-
endpointCount: number;
|
|
34993
|
-
/** Array of discoverable endpoints */
|
|
34994
|
-
endpoints: DiscoveryEndpoint[];
|
|
34995
|
-
}
|
|
34996
|
-
/**
|
|
34997
|
-
* Interface for endpoint search results
|
|
34998
|
-
*/
|
|
34999
|
-
interface EndpointSearchResult {
|
|
35000
|
-
/** The matching endpoint */
|
|
35001
|
-
endpoint: DiscoveryEndpoint;
|
|
35002
|
-
/** Relevance score (0-1) */
|
|
35003
|
-
score: number;
|
|
35004
|
-
/** Reason why this endpoint matched */
|
|
35005
|
-
matchReason: string;
|
|
35006
|
-
}
|
|
35007
34909
|
/**
|
|
35008
34910
|
* Main client factory for accessing Augur microservices
|
|
35009
34911
|
*
|
|
@@ -35089,7 +34991,7 @@ declare class AugurAPI {
|
|
|
35089
34991
|
private _commerce?;
|
|
35090
34992
|
private _pricing?;
|
|
35091
34993
|
private _vmi?;
|
|
35092
|
-
private
|
|
34994
|
+
private _openSearch?;
|
|
35093
34995
|
private _items?;
|
|
35094
34996
|
private _legacy?;
|
|
35095
34997
|
private _agrSite?;
|
|
@@ -35179,11 +35081,6 @@ declare class AugurAPI {
|
|
|
35179
35081
|
* Access OpenSearch service endpoints
|
|
35180
35082
|
*/
|
|
35181
35083
|
get openSearch(): OpenSearchClient;
|
|
35182
|
-
/**
|
|
35183
|
-
* Access OpenSearch service endpoints
|
|
35184
|
-
* @deprecated Use `openSearch`, which matches the registry id (`openSearch.…`) and the PHP client.
|
|
35185
|
-
*/
|
|
35186
|
-
get opensearch(): OpenSearchClient;
|
|
35187
35084
|
/**
|
|
35188
35085
|
* Access Items service endpoints
|
|
35189
35086
|
*/
|
|
@@ -35278,156 +35175,6 @@ declare class AugurAPI {
|
|
|
35278
35175
|
* @param siteId New site ID
|
|
35279
35176
|
*/
|
|
35280
35177
|
setSiteId(siteId: string): void;
|
|
35281
|
-
/**
|
|
35282
|
-
* Discover all available services and their capabilities
|
|
35283
|
-
*
|
|
35284
|
-
* Returns a complete service map showing all discoverable endpoints across
|
|
35285
|
-
* all microservices, enabling AI agents to understand the full API topology.
|
|
35286
|
-
*
|
|
35287
|
-
* @returns Promise<ServiceMap[]> Array of service maps with endpoint metadata
|
|
35288
|
-
*
|
|
35289
|
-
* @example
|
|
35290
|
-
* ```typescript
|
|
35291
|
-
* const api = new AugurAPI({ siteId: 'my-site', bearerToken: 'token' });
|
|
35292
|
-
* const services = await api.discover();
|
|
35293
|
-
*
|
|
35294
|
-
* // Find all user-related endpoints
|
|
35295
|
-
* const userEndpoints = services.flatMap(s => s.endpoints)
|
|
35296
|
-
* .filter(e => e.searchTerms.some(term => term.includes('user')));
|
|
35297
|
-
*
|
|
35298
|
-
* // Show service capabilities
|
|
35299
|
-
* services.forEach(service => {
|
|
35300
|
-
* console.log(`${service.serviceName}: ${service.endpointCount} endpoints`);
|
|
35301
|
-
* service.endpoints.forEach(endpoint => {
|
|
35302
|
-
* console.log(` ${endpoint.fullPath} - ${endpoint.description}`);
|
|
35303
|
-
* });
|
|
35304
|
-
* });
|
|
35305
|
-
* ```
|
|
35306
|
-
*/
|
|
35307
|
-
discover(): Promise<ServiceMap[]>;
|
|
35308
|
-
/**
|
|
35309
|
-
* Find endpoints by search term or functionality description
|
|
35310
|
-
*
|
|
35311
|
-
* Searches across all services to find endpoints that match the given search term.
|
|
35312
|
-
* Uses intelligent matching against endpoint descriptions, search terms, domains,
|
|
35313
|
-
* and common usage patterns.
|
|
35314
|
-
*
|
|
35315
|
-
* @param searchTerm The functionality or term to search for
|
|
35316
|
-
* @param options Search options for filtering and ranking
|
|
35317
|
-
* @returns Promise<EndpointSearchResult[]> Array of matching endpoints with relevance scores
|
|
35318
|
-
*
|
|
35319
|
-
* @example
|
|
35320
|
-
* ```typescript
|
|
35321
|
-
* const api = new AugurAPI({ siteId: 'my-site', bearerToken: 'token' });
|
|
35322
|
-
*
|
|
35323
|
-
* // Find user-related endpoints
|
|
35324
|
-
* const userEndpoints = await api.findEndpoint('users');
|
|
35325
|
-
* console.log(`Found ${userEndpoints.length} user-related endpoints`);
|
|
35326
|
-
*
|
|
35327
|
-
* // Find authentication endpoints
|
|
35328
|
-
* const authEndpoints = await api.findEndpoint('authentication');
|
|
35329
|
-
*
|
|
35330
|
-
* // Find inventory management
|
|
35331
|
-
* const inventoryEndpoints = await api.findEndpoint('inventory management');
|
|
35332
|
-
*
|
|
35333
|
-
* // Show results with scores
|
|
35334
|
-
* userEndpoints.forEach(result => {
|
|
35335
|
-
* console.log(`${result.endpoint.fullPath} (${result.score.toFixed(2)}) - ${result.matchReason}`);
|
|
35336
|
-
* });
|
|
35337
|
-
* ```
|
|
35338
|
-
*/
|
|
35339
|
-
findEndpoint(searchTerm: string, options?: {
|
|
35340
|
-
/** Minimum relevance score (0-1, default: 0.1) */
|
|
35341
|
-
minScore?: number;
|
|
35342
|
-
/** Maximum number of results (default: 10) */
|
|
35343
|
-
maxResults?: number;
|
|
35344
|
-
/** Filter by specific service */
|
|
35345
|
-
service?: string;
|
|
35346
|
-
/** Filter by business domain */
|
|
35347
|
-
domain?: string;
|
|
35348
|
-
/** Include only GET endpoints */
|
|
35349
|
-
readOnly?: boolean;
|
|
35350
|
-
}): Promise<EndpointSearchResult[]>;
|
|
35351
|
-
/**
|
|
35352
|
-
* Get endpoints filtered by service, domain, and method options
|
|
35353
|
-
*/
|
|
35354
|
-
private getFilteredEndpoints;
|
|
35355
|
-
/**
|
|
35356
|
-
* Search and score endpoints against search term
|
|
35357
|
-
*/
|
|
35358
|
-
private searchAndScoreEndpoints;
|
|
35359
|
-
/**
|
|
35360
|
-
* Check if endpoint has required fields
|
|
35361
|
-
*/
|
|
35362
|
-
private isValidEndpoint;
|
|
35363
|
-
/**
|
|
35364
|
-
* Calculate final score with domain filter adjustments
|
|
35365
|
-
*/
|
|
35366
|
-
private calculateFinalScore;
|
|
35367
|
-
/**
|
|
35368
|
-
* Calculate relevance score for an endpoint against a search term
|
|
35369
|
-
*/
|
|
35370
|
-
private calculateEndpointRelevance;
|
|
35371
|
-
/**
|
|
35372
|
-
* Process exact matches with appropriate combining logic
|
|
35373
|
-
*/
|
|
35374
|
-
private processExactMatches;
|
|
35375
|
-
/**
|
|
35376
|
-
* Check if match type should be exclusive (no combining)
|
|
35377
|
-
*/
|
|
35378
|
-
private isExclusiveMatch;
|
|
35379
|
-
/**
|
|
35380
|
-
* Check if match type can be combined with partial matches
|
|
35381
|
-
*/
|
|
35382
|
-
private isCombinableMatch;
|
|
35383
|
-
/**
|
|
35384
|
-
* Process fallback matches when no exact match found
|
|
35385
|
-
*/
|
|
35386
|
-
private processFallbackMatches;
|
|
35387
|
-
/**
|
|
35388
|
-
* Calculate exact field matches with high scores
|
|
35389
|
-
*/
|
|
35390
|
-
private calculateExactMatches;
|
|
35391
|
-
/**
|
|
35392
|
-
* Check for path substring matches
|
|
35393
|
-
*/
|
|
35394
|
-
private checkPathSubstringMatch;
|
|
35395
|
-
/**
|
|
35396
|
-
* Check for description substring matches
|
|
35397
|
-
*/
|
|
35398
|
-
private checkDescriptionSubstringMatch;
|
|
35399
|
-
/**
|
|
35400
|
-
* Check for other substring matches (domain, service)
|
|
35401
|
-
*/
|
|
35402
|
-
private checkOtherSubstringMatches;
|
|
35403
|
-
/**
|
|
35404
|
-
* Check for exact field matches
|
|
35405
|
-
*/
|
|
35406
|
-
private checkExactFieldMatches;
|
|
35407
|
-
/**
|
|
35408
|
-
* Check search terms and common patterns
|
|
35409
|
-
*/
|
|
35410
|
-
private checkSearchTermsAndPatterns;
|
|
35411
|
-
/**
|
|
35412
|
-
* Calculate partial word matches with lower scores
|
|
35413
|
-
*/
|
|
35414
|
-
private calculatePartialMatches;
|
|
35415
|
-
/**
|
|
35416
|
-
* Build searchable text from endpoint fields
|
|
35417
|
-
*/
|
|
35418
|
-
private buildSearchableText;
|
|
35419
|
-
/**
|
|
35420
|
-
* Count matching words in text
|
|
35421
|
-
*/
|
|
35422
|
-
private countWordMatches;
|
|
35423
|
-
/**
|
|
35424
|
-
* Build partial match result with score and reason
|
|
35425
|
-
*/
|
|
35426
|
-
private buildPartialMatchResult;
|
|
35427
|
-
/**
|
|
35428
|
-
* Calculate multi-word matches by finding the best match for each word
|
|
35429
|
-
*/
|
|
35430
|
-
private calculateMultiWordMatches;
|
|
35431
35178
|
}
|
|
35432
35179
|
|
|
35433
|
-
export {
|
|
35180
|
+
export { types$e as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, type Envelope as D, type EndpointEntry as E, types$8 as F, GregorovichClient as G, type HealthCheckData as H, HealthCheckDataSchema as I, ItemsClient as J, types$j as K, JoomlaClient as L, types$o as M, type Known as N, LegacyClient as O, types$i as P, LogisticsClient as Q, types$7 as R, OpenSearchClient as S, types$k as T, OrdersClient as U, types$f as V, P21ApisClient as W, types$6 as X, P21CoreClient as Y, types$5 as Z, P21PimClient as _, AgrInfoClient as a, P21SismClient as a0, types$4 as a1, PaginationParamsSchema as a2, PaymentsClient as a3, types$d as a4, type PingData as a5, PricingClient as a6, types$m as a7, type RequestConfig as a8, ShippingClient as a9, types$3 as aa, SmartyStreetsClient as ab, types$2 as ac, UPSClient as ad, types$1 as ae, VMIClient as af, types$l as ag, type WhoamiData as ah, WhoamiDataSchema as ai, AgrIntClient as b, types$b as c, AgrSiteClient as d, types$h as e, AgrWorkClient as f, type AugurAPIConfig as g, type AugurContext as h, type AugurRequestConfig as i, type AugurRequestError as j, type AugurResponse as k, AvalaraClient as l, types$a as m, BaseResponseSchema as n, Basecamp2Client as o, types as p, BrandFolderClient as q, types$9 as r, type CallResult as s, types$c as t, CommerceClient as u, types$n as v, ContextCreationError as w, CustomersClient as x, types$g as y, type EndpointParam as z };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as AugurAPI } from './client-
|
|
2
|
-
export { a as AgrInfoClient, t as AgrInfoTypes, b as AgrIntClient, c as AgrIntTypes, d as AgrSiteClient, e as AgrSiteTypes, f as AgrWorkClient, g as AugurAPIConfig, h as AugurContext, i as AugurRequestConfig, j as AugurRequestError, k as AugurResponse, l as AvalaraClient, m as AvalaraTypes, B as BaseResponse, n as BaseResponseSchema, o as Basecamp2Client, p as Basecamp2Types, q as BrandFolderClient, r as BrandFolderTypes, C as CallArgs, s as CallResult, u as CommerceClient, v as CommerceTypes, w as ContextCreationError, x as CustomersClient, y as CustomersTypes,
|
|
1
|
+
import { A as AugurAPI } from './client-CuHrZyBA.mjs';
|
|
2
|
+
export { a as AgrInfoClient, t as AgrInfoTypes, b as AgrIntClient, c as AgrIntTypes, d as AgrSiteClient, e as AgrSiteTypes, f as AgrWorkClient, g as AugurAPIConfig, h as AugurContext, i as AugurRequestConfig, j as AugurRequestError, k as AugurResponse, l as AvalaraClient, m as AvalaraTypes, B as BaseResponse, n as BaseResponseSchema, o as Basecamp2Client, p as Basecamp2Types, q as BrandFolderClient, r as BrandFolderTypes, C as CallArgs, s as CallResult, u as CommerceClient, v as CommerceTypes, w as ContextCreationError, x as CustomersClient, y as CustomersTypes, E as EndpointEntry, z as EndpointParam, D as Envelope, G as GregorovichClient, F as GregorovichTypes, H as HealthCheckData, I as HealthCheckDataSchema, J as ItemsClient, K as ItemsTypes, L as JoomlaClient, M as JoomlaTypes, N as Known, O as LegacyClient, P as LegacyTypes, Q as LogisticsClient, R as LogisticsTypes, S as OpenSearchClient, T as OpenSearchTypes, U as OrdersClient, V as OrdersTypes, W as P21ApisClient, X as P21ApisTypes, Y as P21CoreClient, Z as P21CoreTypes, _ as P21PimClient, $ as P21PimTypes, a0 as P21SismClient, a1 as P21SismTypes, a2 as PaginationParamsSchema, a3 as PaymentsClient, a4 as PaymentsTypes, a5 as PingData, a6 as PricingClient, a7 as PricingTypes, a8 as RequestConfig, a9 as ShippingClient, aa as ShippingTypes, ab as SmartyStreetsClient, ac as SmartyStreetsTypes, ad as UPSClient, ae as UPSTypes, af as VMIClient, ag as VMITypes, ah as WhoamiData, ai as WhoamiDataSchema } from './client-CuHrZyBA.mjs';
|
|
3
3
|
import 'valibot';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -89,7 +89,7 @@ declare function authenticateUserForSite(params: CrossSiteAuthParams): Promise<C
|
|
|
89
89
|
*/
|
|
90
90
|
declare function createCrossSiteAuthenticator(augurInfoToken: string): (targetSiteId: string, username: string, password: string) => Promise<CrossSiteAuthResult>;
|
|
91
91
|
|
|
92
|
-
/** Validation issue
|
|
92
|
+
/** Validation issue (from a Valibot params check) */
|
|
93
93
|
interface ValidationIssue {
|
|
94
94
|
path: (string | number)[];
|
|
95
95
|
message: string;
|
|
@@ -204,6 +204,6 @@ declare namespace types {
|
|
|
204
204
|
export type { types_AgrWorkClientSpec as AgrWorkClientSpec };
|
|
205
205
|
}
|
|
206
206
|
|
|
207
|
-
declare const VERSION = "2026.10.
|
|
207
|
+
declare const VERSION = "2026.10.14";
|
|
208
208
|
|
|
209
209
|
export { types as AgrWorkTypes, AugurAPI, type AugurAPIError, AugurError, AuthenticationError, type CrossSiteAuthParams, type CrossSiteAuthResult, InvalidArgumentError, NotFoundError, RateLimitError, VERSION, ValidationError, authenticateUserForSite, createCrossSiteAuthenticator };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as AugurAPI } from './client-
|
|
2
|
-
export { a as AgrInfoClient, t as AgrInfoTypes, b as AgrIntClient, c as AgrIntTypes, d as AgrSiteClient, e as AgrSiteTypes, f as AgrWorkClient, g as AugurAPIConfig, h as AugurContext, i as AugurRequestConfig, j as AugurRequestError, k as AugurResponse, l as AvalaraClient, m as AvalaraTypes, B as BaseResponse, n as BaseResponseSchema, o as Basecamp2Client, p as Basecamp2Types, q as BrandFolderClient, r as BrandFolderTypes, C as CallArgs, s as CallResult, u as CommerceClient, v as CommerceTypes, w as ContextCreationError, x as CustomersClient, y as CustomersTypes,
|
|
1
|
+
import { A as AugurAPI } from './client-CuHrZyBA.js';
|
|
2
|
+
export { a as AgrInfoClient, t as AgrInfoTypes, b as AgrIntClient, c as AgrIntTypes, d as AgrSiteClient, e as AgrSiteTypes, f as AgrWorkClient, g as AugurAPIConfig, h as AugurContext, i as AugurRequestConfig, j as AugurRequestError, k as AugurResponse, l as AvalaraClient, m as AvalaraTypes, B as BaseResponse, n as BaseResponseSchema, o as Basecamp2Client, p as Basecamp2Types, q as BrandFolderClient, r as BrandFolderTypes, C as CallArgs, s as CallResult, u as CommerceClient, v as CommerceTypes, w as ContextCreationError, x as CustomersClient, y as CustomersTypes, E as EndpointEntry, z as EndpointParam, D as Envelope, G as GregorovichClient, F as GregorovichTypes, H as HealthCheckData, I as HealthCheckDataSchema, J as ItemsClient, K as ItemsTypes, L as JoomlaClient, M as JoomlaTypes, N as Known, O as LegacyClient, P as LegacyTypes, Q as LogisticsClient, R as LogisticsTypes, S as OpenSearchClient, T as OpenSearchTypes, U as OrdersClient, V as OrdersTypes, W as P21ApisClient, X as P21ApisTypes, Y as P21CoreClient, Z as P21CoreTypes, _ as P21PimClient, $ as P21PimTypes, a0 as P21SismClient, a1 as P21SismTypes, a2 as PaginationParamsSchema, a3 as PaymentsClient, a4 as PaymentsTypes, a5 as PingData, a6 as PricingClient, a7 as PricingTypes, a8 as RequestConfig, a9 as ShippingClient, aa as ShippingTypes, ab as SmartyStreetsClient, ac as SmartyStreetsTypes, ad as UPSClient, ae as UPSTypes, af as VMIClient, ag as VMITypes, ah as WhoamiData, ai as WhoamiDataSchema } from './client-CuHrZyBA.js';
|
|
3
3
|
import 'valibot';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -89,7 +89,7 @@ declare function authenticateUserForSite(params: CrossSiteAuthParams): Promise<C
|
|
|
89
89
|
*/
|
|
90
90
|
declare function createCrossSiteAuthenticator(augurInfoToken: string): (targetSiteId: string, username: string, password: string) => Promise<CrossSiteAuthResult>;
|
|
91
91
|
|
|
92
|
-
/** Validation issue
|
|
92
|
+
/** Validation issue (from a Valibot params check) */
|
|
93
93
|
interface ValidationIssue {
|
|
94
94
|
path: (string | number)[];
|
|
95
95
|
message: string;
|
|
@@ -204,6 +204,6 @@ declare namespace types {
|
|
|
204
204
|
export type { types_AgrWorkClientSpec as AgrWorkClientSpec };
|
|
205
205
|
}
|
|
206
206
|
|
|
207
|
-
declare const VERSION = "2026.10.
|
|
207
|
+
declare const VERSION = "2026.10.14";
|
|
208
208
|
|
|
209
209
|
export { types as AgrWorkTypes, AugurAPI, type AugurAPIError, AugurError, AuthenticationError, type CrossSiteAuthParams, type CrossSiteAuthResult, InvalidArgumentError, NotFoundError, RateLimitError, VERSION, ValidationError, authenticateUserForSite, createCrossSiteAuthenticator };
|