@simpleapps-com/augur-api 2026.10.12 → 2026.10.13
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-B10M0T65.d.mts} +24 -286
- package/dist/{client-XZzK8xkq.d.ts → client-B10M0T65.d.ts} +24 -286
- package/dist/index.d.mts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +12 -547
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +12 -547
- package/dist/index.mjs.map +1 -1
- package/dist/testing.d.mts +1 -1
- package/dist/testing.d.ts +1 -1
- package/package.json +1 -1
|
@@ -104,6 +104,29 @@ interface CallResult {
|
|
|
104
104
|
body: unknown;
|
|
105
105
|
}
|
|
106
106
|
|
|
107
|
+
/** One endpoint in the registry. */
|
|
108
|
+
interface EndpointEntry {
|
|
109
|
+
/** `camelCase(service).chain.action`, e.g. `items.invMast.doc.list` */
|
|
110
|
+
readonly id: string;
|
|
111
|
+
/** Kebab wire name, e.g. `open-search` */
|
|
112
|
+
readonly service: string;
|
|
113
|
+
readonly method: 'GET' | 'POST' | 'PUT' | 'DELETE';
|
|
114
|
+
/** Path template, e.g. `/inv-mast/{invMastUid}/doc` */
|
|
115
|
+
readonly path: string;
|
|
116
|
+
/** Path params in URL order */
|
|
117
|
+
readonly pathParams: readonly string[];
|
|
118
|
+
/** Path param → anchored regex its value MUST match; params without one are absent */
|
|
119
|
+
readonly pathPatterns: Readonly<Record<string, string>>;
|
|
120
|
+
readonly queryParams: readonly string[];
|
|
121
|
+
/** Alternative action names; an alias id is `service.chain.alias` */
|
|
122
|
+
readonly aliases: readonly string[];
|
|
123
|
+
readonly hasBody: boolean;
|
|
124
|
+
readonly auth: 'none' | 'site' | 'bearer';
|
|
125
|
+
readonly edgeCache: boolean;
|
|
126
|
+
/** Omitted unless set; a read is `readOnly ?? method === 'GET'` */
|
|
127
|
+
readonly readOnly?: boolean;
|
|
128
|
+
}
|
|
129
|
+
|
|
107
130
|
/** A response as text, before any JSON parsing (what `call()` builds its result from). */
|
|
108
131
|
interface RawResponse {
|
|
109
132
|
status: number;
|
|
@@ -264,46 +287,6 @@ type HealthCheckData = v.InferOutput<typeof HealthCheckDataSchema>;
|
|
|
264
287
|
type PingData = v.InferOutput<typeof PingDataSchema>;
|
|
265
288
|
type WhoamiData = v.InferOutput<typeof WhoamiDataSchema>;
|
|
266
289
|
|
|
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
290
|
/**
|
|
308
291
|
* HTTP method types for API operations
|
|
309
292
|
*/
|
|
@@ -326,8 +309,6 @@ interface EndpointConfig {
|
|
|
326
309
|
paramsSchema?: v.GenericSchema;
|
|
327
310
|
/** Valibot schema for validating response data */
|
|
328
311
|
responseSchema: v.GenericSchema;
|
|
329
|
-
/** Whether this endpoint requires authentication (default: true) */
|
|
330
|
-
requiresAuth?: boolean;
|
|
331
312
|
}
|
|
332
313
|
/**
|
|
333
314
|
* Standard API response structure - REQUIRED for all services (8-field format)
|
|
@@ -480,42 +461,6 @@ declare abstract class BaseServiceClient {
|
|
|
480
461
|
* ```
|
|
481
462
|
*/
|
|
482
463
|
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
464
|
}
|
|
520
465
|
|
|
521
466
|
/**
|
|
@@ -2138,7 +2083,6 @@ declare class JoomlaClient extends BaseServiceClient {
|
|
|
2138
2083
|
readonly usergroupsData: DataOnly<JoomlaClientSpec['usergroups']>;
|
|
2139
2084
|
readonly usersData: DataOnly<JoomlaClientSpec['users']>;
|
|
2140
2085
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
2141
|
-
protected getServiceDescription(): string;
|
|
2142
2086
|
}
|
|
2143
2087
|
|
|
2144
2088
|
/**
|
|
@@ -3363,7 +3307,6 @@ declare class CommerceClient extends BaseServiceClient {
|
|
|
3363
3307
|
readonly cartLineData: DataOnly<CommerceClientSpec['cartLine']>;
|
|
3364
3308
|
readonly checkoutData: DataOnly<CommerceClientSpec['checkout']>;
|
|
3365
3309
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
3366
|
-
protected getServiceDescription(): string;
|
|
3367
3310
|
}
|
|
3368
3311
|
|
|
3369
3312
|
/**
|
|
@@ -4756,7 +4699,6 @@ declare class PricingClient extends BaseServiceClient {
|
|
|
4756
4699
|
readonly taxEngineData: DataOnly<PricingClientSpec['taxEngine']>;
|
|
4757
4700
|
readonly webPricingData: DataOnly<PricingClientSpec['webPricing']>;
|
|
4758
4701
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
4759
|
-
protected getServiceDescription(): string;
|
|
4760
4702
|
}
|
|
4761
4703
|
|
|
4762
4704
|
/**
|
|
@@ -7641,7 +7583,6 @@ declare class VMIClient extends BaseServiceClient {
|
|
|
7641
7583
|
readonly sectionsData: DataOnly<VMIClientSpec['sections']>;
|
|
7642
7584
|
readonly warehouseData: DataOnly<VMIClientSpec['warehouse']>;
|
|
7643
7585
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
7644
|
-
protected getServiceDescription(): string;
|
|
7645
7586
|
}
|
|
7646
7587
|
|
|
7647
7588
|
/**
|
|
@@ -8730,7 +8671,6 @@ declare class OpenSearchClient extends BaseServiceClient {
|
|
|
8730
8671
|
readonly queryStringRedirectData: DataOnly<OpenSearchClientSpec['queryStringRedirect']>;
|
|
8731
8672
|
readonly suggestionsData: DataOnly<OpenSearchClientSpec['suggestions']>;
|
|
8732
8673
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
8733
|
-
protected getServiceDescription(): string;
|
|
8734
8674
|
}
|
|
8735
8675
|
|
|
8736
8676
|
/**
|
|
@@ -15864,7 +15804,6 @@ declare class ItemsClient extends BaseServiceClient {
|
|
|
15864
15804
|
readonly p21Data: DataOnly<ItemsClientSpec['p21']>;
|
|
15865
15805
|
readonly variantsData: DataOnly<ItemsClientSpec['variants']>;
|
|
15866
15806
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
15867
|
-
protected getServiceDescription(): string;
|
|
15868
15807
|
}
|
|
15869
15808
|
|
|
15870
15809
|
/**
|
|
@@ -17262,7 +17201,6 @@ declare class LegacyClient extends BaseServiceClient {
|
|
|
17262
17201
|
readonly itemCategoryData: DataOnly<LegacyClientSpec['itemCategory']>;
|
|
17263
17202
|
readonly legacyData: DataOnly<LegacyClientSpec['legacy']>;
|
|
17264
17203
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
17265
|
-
protected getServiceDescription(): string;
|
|
17266
17204
|
}
|
|
17267
17205
|
|
|
17268
17206
|
/**
|
|
@@ -18866,7 +18804,6 @@ declare class AgrSiteClient extends BaseServiceClient {
|
|
|
18866
18804
|
readonly settingsData: DataOnly<AgrSiteClientSpec['settings']>;
|
|
18867
18805
|
readonly usersData: DataOnly<AgrSiteClientSpec['users']>;
|
|
18868
18806
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
18869
|
-
protected getServiceDescription(): string;
|
|
18870
18807
|
}
|
|
18871
18808
|
|
|
18872
18809
|
/**
|
|
@@ -21608,7 +21545,6 @@ declare class CustomersClient extends BaseServiceClient {
|
|
|
21608
21545
|
readonly contactsUdData: DataOnly<CustomersClientSpec['contactsUd']>;
|
|
21609
21546
|
readonly customerData: DataOnly<CustomersClientSpec['customer']>;
|
|
21610
21547
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
21611
|
-
protected getServiceDescription(): string;
|
|
21612
21548
|
}
|
|
21613
21549
|
|
|
21614
21550
|
/**
|
|
@@ -22750,7 +22686,6 @@ declare class OrdersClient extends BaseServiceClient {
|
|
|
22750
22686
|
readonly poHdrData: DataOnly<OrdersClientSpec['poHdr']>;
|
|
22751
22687
|
readonly poLineData: DataOnly<OrdersClientSpec['poLine']>;
|
|
22752
22688
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
22753
|
-
protected getServiceDescription(): string;
|
|
22754
22689
|
}
|
|
22755
22690
|
|
|
22756
22691
|
/**
|
|
@@ -23805,7 +23740,6 @@ declare class P21PimClient extends BaseServiceClient {
|
|
|
23805
23740
|
readonly itemsData: DataOnly<P21PimClientSpec['items']>;
|
|
23806
23741
|
readonly podcastsData: DataOnly<P21PimClientSpec['podcasts']>;
|
|
23807
23742
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
23808
|
-
protected getServiceDescription(): string;
|
|
23809
23743
|
}
|
|
23810
23744
|
|
|
23811
23745
|
/**
|
|
@@ -25367,7 +25301,6 @@ declare class PaymentsClient extends BaseServiceClient {
|
|
|
25367
25301
|
readonly paytraceData: DataOnly<PaymentsClientSpec['paytrace']>;
|
|
25368
25302
|
readonly unifiedData: DataOnly<PaymentsClientSpec['unified']>;
|
|
25369
25303
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
25370
|
-
protected getServiceDescription(): string;
|
|
25371
25304
|
}
|
|
25372
25305
|
|
|
25373
25306
|
/**
|
|
@@ -26586,7 +26519,6 @@ declare class AgrInfoClient extends BaseServiceClient {
|
|
|
26586
26519
|
readonly sitesData: DataOnly<AgrInfoClientSpec['sites']>;
|
|
26587
26520
|
readonly workflowsData: DataOnly<AgrInfoClientSpec['workflows']>;
|
|
26588
26521
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
26589
|
-
protected getServiceDescription(): string;
|
|
26590
26522
|
}
|
|
26591
26523
|
|
|
26592
26524
|
/**
|
|
@@ -28745,7 +28677,6 @@ declare class AgrIntClient extends BaseServiceClient {
|
|
|
28745
28677
|
readonly rolesData: DataOnly<AgrIntClientSpec['roles']>;
|
|
28746
28678
|
readonly usersData: DataOnly<AgrIntClientSpec['users']>;
|
|
28747
28679
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
28748
|
-
protected getServiceDescription(): string;
|
|
28749
28680
|
}
|
|
28750
28681
|
|
|
28751
28682
|
/**
|
|
@@ -28768,7 +28699,6 @@ declare class AgrIntClient extends BaseServiceClient {
|
|
|
28768
28699
|
|
|
28769
28700
|
declare class AgrWorkClient extends BaseServiceClient {
|
|
28770
28701
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
28771
|
-
protected getServiceDescription(): string;
|
|
28772
28702
|
}
|
|
28773
28703
|
|
|
28774
28704
|
/**
|
|
@@ -28909,7 +28839,6 @@ declare class AvalaraClient extends BaseServiceClient {
|
|
|
28909
28839
|
readonly rates: AvalaraClientSpec['rates'];
|
|
28910
28840
|
readonly ratesData: DataOnly<AvalaraClientSpec['rates']>;
|
|
28911
28841
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
28912
|
-
protected getServiceDescription(): string;
|
|
28913
28842
|
}
|
|
28914
28843
|
|
|
28915
28844
|
/**
|
|
@@ -29150,7 +29079,6 @@ declare class BrandFolderClient extends BaseServiceClient {
|
|
|
29150
29079
|
readonly categories: BrandFolderClientSpec['categories'];
|
|
29151
29080
|
readonly categoriesData: DataOnly<BrandFolderClientSpec['categories']>;
|
|
29152
29081
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
29153
|
-
protected getServiceDescription(): string;
|
|
29154
29082
|
}
|
|
29155
29083
|
|
|
29156
29084
|
/**
|
|
@@ -29259,7 +29187,6 @@ declare class GregorovichClient extends BaseServiceClient {
|
|
|
29259
29187
|
readonly documents: GregorovichClientSpec['documents'];
|
|
29260
29188
|
readonly documentsData: DataOnly<GregorovichClientSpec['documents']>;
|
|
29261
29189
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
29262
|
-
protected getServiceDescription(): string;
|
|
29263
29190
|
}
|
|
29264
29191
|
|
|
29265
29192
|
/**
|
|
@@ -30210,7 +30137,6 @@ declare class LogisticsClient extends BaseServiceClient {
|
|
|
30210
30137
|
readonly speedshipData: DataOnly<LogisticsClientSpec['speedship']>;
|
|
30211
30138
|
readonly upsData: DataOnly<LogisticsClientSpec['ups']>;
|
|
30212
30139
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
30213
|
-
protected getServiceDescription(): string;
|
|
30214
30140
|
}
|
|
30215
30141
|
|
|
30216
30142
|
/**
|
|
@@ -30524,7 +30450,6 @@ declare class P21ApisClient extends BaseServiceClient {
|
|
|
30524
30450
|
readonly transUserData: DataOnly<P21ApisClientSpec['transUser']>;
|
|
30525
30451
|
readonly transWebDisplayTypeData: DataOnly<P21ApisClientSpec['transWebDisplayType']>;
|
|
30526
30452
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
30527
|
-
protected getServiceDescription(): string;
|
|
30528
30453
|
}
|
|
30529
30454
|
|
|
30530
30455
|
/**
|
|
@@ -31474,7 +31399,6 @@ declare class P21CoreClient extends BaseServiceClient {
|
|
|
31474
31399
|
readonly locationData: DataOnly<P21CoreClientSpec['location']>;
|
|
31475
31400
|
readonly paymentTypesData: DataOnly<P21CoreClientSpec['paymentTypes']>;
|
|
31476
31401
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
31477
|
-
protected getServiceDescription(): string;
|
|
31478
31402
|
}
|
|
31479
31403
|
|
|
31480
31404
|
/**
|
|
@@ -32779,7 +32703,6 @@ declare class P21SismClient extends BaseServiceClient {
|
|
|
32779
32703
|
readonly scheduledImportMasterData: DataOnly<P21SismClientSpec['scheduledImportMaster']>;
|
|
32780
32704
|
readonly scheduledImportMetadataData: DataOnly<P21SismClientSpec['scheduledImportMetadata']>;
|
|
32781
32705
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
32782
|
-
protected getServiceDescription(): string;
|
|
32783
32706
|
}
|
|
32784
32707
|
|
|
32785
32708
|
/**
|
|
@@ -32936,7 +32859,6 @@ declare class ShippingClient extends BaseServiceClient {
|
|
|
32936
32859
|
readonly rates: ShippingClientSpec['rates'];
|
|
32937
32860
|
readonly ratesData: DataOnly<ShippingClientSpec['rates']>;
|
|
32938
32861
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
32939
|
-
protected getServiceDescription(): string;
|
|
32940
32862
|
}
|
|
32941
32863
|
|
|
32942
32864
|
/**
|
|
@@ -33118,7 +33040,6 @@ declare class SmartyStreetsClient extends BaseServiceClient {
|
|
|
33118
33040
|
readonly us: SmartyStreetsClientSpec['us'];
|
|
33119
33041
|
readonly usData: DataOnly<SmartyStreetsClientSpec['us']>;
|
|
33120
33042
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
33121
|
-
protected getServiceDescription(): string;
|
|
33122
33043
|
}
|
|
33123
33044
|
|
|
33124
33045
|
/**
|
|
@@ -33253,7 +33174,6 @@ declare class UPSClient extends BaseServiceClient {
|
|
|
33253
33174
|
readonly ratesShop: UPSClientSpec['ratesShop'];
|
|
33254
33175
|
readonly ratesShopData: DataOnly<UPSClientSpec['ratesShop']>;
|
|
33255
33176
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
33256
|
-
protected getServiceDescription(): string;
|
|
33257
33177
|
}
|
|
33258
33178
|
|
|
33259
33179
|
/**
|
|
@@ -34970,40 +34890,8 @@ declare class Basecamp2Client extends BaseServiceClient {
|
|
|
34970
34890
|
readonly todosData: DataOnly<Basecamp2ClientSpec['todos']>;
|
|
34971
34891
|
readonly todosSummaryData: DataOnly<Basecamp2ClientSpec['todosSummary']>;
|
|
34972
34892
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
34973
|
-
protected getServiceDescription(): string;
|
|
34974
34893
|
}
|
|
34975
34894
|
|
|
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
34895
|
/**
|
|
35008
34896
|
* Main client factory for accessing Augur microservices
|
|
35009
34897
|
*
|
|
@@ -35278,156 +35166,6 @@ declare class AugurAPI {
|
|
|
35278
35166
|
* @param siteId New site ID
|
|
35279
35167
|
*/
|
|
35280
35168
|
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
35169
|
}
|
|
35432
35170
|
|
|
35433
|
-
export {
|
|
35171
|
+
export { P21SismClient as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, types$8 as D, type EndpointEntry as E, HealthCheckDataSchema as F, GregorovichClient as G, type HealthCheckData as H, ItemsClient as I, types$j as J, JoomlaClient as K, types$o as L, type Known as M, LegacyClient as N, types$i as O, LogisticsClient as P, types$7 as Q, OpenSearchClient as R, types$k as S, OrdersClient as T, types$f as U, P21ApisClient as V, types$6 as W, P21CoreClient as X, types$5 as Y, P21PimClient as Z, types$e as _, AgrInfoClient as a, types$4 as a0, PaginationParamsSchema as a1, PaymentsClient as a2, types$d as a3, type PingData as a4, PricingClient as a5, types$m as a6, type RequestConfig as a7, ShippingClient as a8, types$3 as a9, SmartyStreetsClient as aa, types$2 as ab, UPSClient as ac, types$1 as ad, VMIClient as ae, types$l as af, type WhoamiData as ag, WhoamiDataSchema as ah, 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 Envelope as z };
|