@simpleapps-com/augur-api 0.1.4 → 0.1.5
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/README.md +2004 -405
- package/dist/cjs/core/client.d.ts +1 -0
- package/dist/cjs/core/client.d.ts.map +1 -1
- package/dist/cjs/core/client.js +5 -1
- package/dist/cjs/core/client.js.map +1 -1
- package/dist/cjs/core/common-schemas.d.ts +2 -2
- package/dist/cjs/core/config.d.ts +2 -0
- package/dist/cjs/core/config.d.ts.map +1 -1
- package/dist/cjs/core/config.js.map +1 -1
- package/dist/cjs/core/response-capturer.d.ts +58 -0
- package/dist/cjs/core/response-capturer.d.ts.map +1 -0
- package/dist/cjs/core/response-capturer.js +167 -0
- package/dist/cjs/core/response-capturer.js.map +1 -0
- package/dist/cjs/core/schema-factories.d.ts +4 -4
- package/dist/cjs/core/schemas.d.ts +4 -4
- package/dist/cjs/index.d.ts +1 -0
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +5 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/services/agr-site/client.d.ts +2 -2
- package/dist/cjs/services/agr-site/schemas/ai.d.ts +2 -2
- package/dist/cjs/services/agr-site/schemas/content.d.ts +2 -2
- package/dist/cjs/services/agr-site/schemas/settings.d.ts +2 -2
- package/dist/cjs/services/commerce/client.d.ts +2 -2
- package/dist/cjs/services/commerce/schemas/cart.d.ts +4 -4
- package/dist/cjs/services/commerce/schemas/checkout.d.ts +6 -6
- package/dist/cjs/services/commerce/schemas/recommendations.d.ts +2 -2
- package/dist/cjs/services/customers/client.d.ts +361 -199
- package/dist/cjs/services/customers/client.d.ts.map +1 -1
- package/dist/cjs/services/customers/schemas/addresses.d.ts +408 -186
- package/dist/cjs/services/customers/schemas/addresses.d.ts.map +1 -1
- package/dist/cjs/services/customers/schemas/addresses.js +35 -20
- package/dist/cjs/services/customers/schemas/addresses.js.map +1 -1
- package/dist/cjs/services/customers/schemas/contacts.d.ts +10 -10
- package/dist/cjs/services/customers/schemas/customers.d.ts +605 -524
- package/dist/cjs/services/customers/schemas/customers.d.ts.map +1 -1
- package/dist/cjs/services/customers/schemas/customers.js +75 -57
- package/dist/cjs/services/customers/schemas/customers.js.map +1 -1
- package/dist/cjs/services/customers/schemas/index.d.ts +1 -0
- package/dist/cjs/services/customers/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/customers/schemas/index.js +1 -0
- package/dist/cjs/services/customers/schemas/index.js.map +1 -1
- package/dist/cjs/services/customers/schemas/invoices.d.ts +643 -343
- package/dist/cjs/services/customers/schemas/invoices.d.ts.map +1 -1
- package/dist/cjs/services/customers/schemas/invoices.js +58 -24
- package/dist/cjs/services/customers/schemas/invoices.js.map +1 -1
- package/dist/cjs/services/customers/schemas/orders.d.ts +1784 -172
- package/dist/cjs/services/customers/schemas/orders.d.ts.map +1 -1
- package/dist/cjs/services/customers/schemas/orders.js +134 -10
- package/dist/cjs/services/customers/schemas/orders.js.map +1 -1
- package/dist/cjs/services/customers/schemas/purchased-items.d.ts +122 -0
- package/dist/cjs/services/customers/schemas/purchased-items.d.ts.map +1 -0
- package/dist/cjs/services/customers/schemas/purchased-items.js +32 -0
- package/dist/cjs/services/customers/schemas/purchased-items.js.map +1 -0
- package/dist/cjs/services/customers/schemas/quotes.d.ts +1925 -331
- package/dist/cjs/services/customers/schemas/quotes.d.ts.map +1 -1
- package/dist/cjs/services/customers/schemas/quotes.js +113 -23
- package/dist/cjs/services/customers/schemas/quotes.js.map +1 -1
- package/dist/cjs/services/joomla/client.d.ts +38 -26
- package/dist/cjs/services/joomla/client.d.ts.map +1 -1
- package/dist/cjs/services/joomla/client.js +22 -0
- package/dist/cjs/services/joomla/client.js.map +1 -1
- package/dist/cjs/services/joomla/schemas/content.d.ts +6 -6
- package/dist/cjs/services/joomla/schemas/groups.d.ts +25 -2
- package/dist/cjs/services/joomla/schemas/groups.d.ts.map +1 -1
- package/dist/cjs/services/joomla/schemas/groups.js +3 -1
- package/dist/cjs/services/joomla/schemas/groups.js.map +1 -1
- package/dist/cjs/services/joomla/schemas/users.d.ts +455 -441
- package/dist/cjs/services/joomla/schemas/users.d.ts.map +1 -1
- package/dist/cjs/services/joomla/schemas/users.js +82 -58
- package/dist/cjs/services/joomla/schemas/users.js.map +1 -1
- package/dist/cjs/services/legacy/client.d.ts +2 -2
- package/dist/cjs/services/legacy/schemas/states.d.ts +8 -8
- package/dist/cjs/services/nexus/client.d.ts +6 -6
- package/dist/cjs/services/nexus/schemas/bin-transfers.d.ts +2 -2
- package/dist/cjs/services/nexus/schemas/receiving.d.ts +4 -4
- package/dist/cjs/services/nexus/schemas/transfers.d.ts +6 -6
- package/dist/cjs/services/open-search/client.d.ts +2 -2
- package/dist/cjs/services/open-search/schemas/attributes.d.ts +2 -2
- package/dist/cjs/services/open-search/schemas/items.d.ts +2 -2
- package/dist/cjs/services/open-search/schemas/search.d.ts +2 -2
- package/dist/cjs/services/orders/client.d.ts +15 -15
- package/dist/cjs/services/orders/schemas/orders.d.ts +48 -48
- package/dist/cjs/services/orders/schemas/purchase-orders.d.ts +32 -32
- package/dist/cjs/services/orders/schemas/salesrep.d.ts +12 -12
- package/dist/cjs/services/p21-pim/client.d.ts +2 -2
- package/dist/cjs/services/p21-pim/schemas/inventory.d.ts +2 -2
- package/dist/cjs/services/p21-pim/schemas/podcasts.d.ts +2 -2
- package/dist/cjs/services/payments/client.d.ts +1 -1
- package/dist/cjs/services/payments/schemas/element.d.ts +4 -4
- package/dist/cjs/services/payments/schemas/unified.d.ts +16 -16
- package/dist/cjs/services/pricing/client.d.ts +1 -1
- package/dist/cjs/services/pricing/schemas/job-pricing.d.ts +4 -4
- package/dist/cjs/services/pricing/schemas/pricing.d.ts +2 -2
- package/dist/cjs/services/pricing/schemas/tax.d.ts +6 -6
- package/dist/cjs/services/vmi/client.d.ts +6 -6
- package/dist/cjs/services/vmi/schemas/products.d.ts +6 -6
- package/dist/cjs/services/vmi/schemas/profiles.d.ts +4 -4
- package/dist/cjs/services/vmi/schemas/restock.d.ts +2 -2
- package/dist/cjs/services/vmi/schemas/warehouse.d.ts +6 -6
- package/dist/cjs/utils/cross-site-auth.d.ts +88 -0
- package/dist/cjs/utils/cross-site-auth.d.ts.map +1 -0
- package/dist/cjs/utils/cross-site-auth.js +107 -0
- package/dist/cjs/utils/cross-site-auth.js.map +1 -0
- package/dist/esm/core/client.d.ts +1 -0
- package/dist/esm/core/client.d.ts.map +1 -1
- package/dist/esm/core/client.js +5 -1
- package/dist/esm/core/client.js.map +1 -1
- package/dist/esm/core/common-schemas.d.ts +2 -2
- package/dist/esm/core/config.d.ts +2 -0
- package/dist/esm/core/config.d.ts.map +1 -1
- package/dist/esm/core/config.js.map +1 -1
- package/dist/esm/core/response-capturer.d.ts +58 -0
- package/dist/esm/core/response-capturer.d.ts.map +1 -0
- package/dist/esm/core/response-capturer.js +130 -0
- package/dist/esm/core/response-capturer.js.map +1 -0
- package/dist/esm/core/schema-factories.d.ts +4 -4
- package/dist/esm/core/schemas.d.ts +4 -4
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +2 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/services/agr-site/client.d.ts +2 -2
- package/dist/esm/services/agr-site/schemas/ai.d.ts +2 -2
- package/dist/esm/services/agr-site/schemas/content.d.ts +2 -2
- package/dist/esm/services/agr-site/schemas/settings.d.ts +2 -2
- package/dist/esm/services/commerce/client.d.ts +2 -2
- package/dist/esm/services/commerce/schemas/cart.d.ts +4 -4
- package/dist/esm/services/commerce/schemas/checkout.d.ts +6 -6
- package/dist/esm/services/commerce/schemas/recommendations.d.ts +2 -2
- package/dist/esm/services/customers/client.d.ts +361 -199
- package/dist/esm/services/customers/client.d.ts.map +1 -1
- package/dist/esm/services/customers/schemas/addresses.d.ts +408 -186
- package/dist/esm/services/customers/schemas/addresses.d.ts.map +1 -1
- package/dist/esm/services/customers/schemas/addresses.js +34 -19
- package/dist/esm/services/customers/schemas/addresses.js.map +1 -1
- package/dist/esm/services/customers/schemas/contacts.d.ts +10 -10
- package/dist/esm/services/customers/schemas/customers.d.ts +605 -524
- package/dist/esm/services/customers/schemas/customers.d.ts.map +1 -1
- package/dist/esm/services/customers/schemas/customers.js +74 -56
- package/dist/esm/services/customers/schemas/customers.js.map +1 -1
- package/dist/esm/services/customers/schemas/index.d.ts +1 -0
- package/dist/esm/services/customers/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/customers/schemas/index.js +1 -0
- package/dist/esm/services/customers/schemas/index.js.map +1 -1
- package/dist/esm/services/customers/schemas/invoices.d.ts +643 -343
- package/dist/esm/services/customers/schemas/invoices.d.ts.map +1 -1
- package/dist/esm/services/customers/schemas/invoices.js +58 -24
- package/dist/esm/services/customers/schemas/invoices.js.map +1 -1
- package/dist/esm/services/customers/schemas/orders.d.ts +1784 -172
- package/dist/esm/services/customers/schemas/orders.d.ts.map +1 -1
- package/dist/esm/services/customers/schemas/orders.js +133 -10
- package/dist/esm/services/customers/schemas/orders.js.map +1 -1
- package/dist/esm/services/customers/schemas/purchased-items.d.ts +122 -0
- package/dist/esm/services/customers/schemas/purchased-items.d.ts.map +1 -0
- package/dist/esm/services/customers/schemas/purchased-items.js +29 -0
- package/dist/esm/services/customers/schemas/purchased-items.js.map +1 -0
- package/dist/esm/services/customers/schemas/quotes.d.ts +1925 -331
- package/dist/esm/services/customers/schemas/quotes.d.ts.map +1 -1
- package/dist/esm/services/customers/schemas/quotes.js +113 -23
- package/dist/esm/services/customers/schemas/quotes.js.map +1 -1
- package/dist/esm/services/joomla/client.d.ts +38 -26
- package/dist/esm/services/joomla/client.d.ts.map +1 -1
- package/dist/esm/services/joomla/client.js +23 -1
- package/dist/esm/services/joomla/client.js.map +1 -1
- package/dist/esm/services/joomla/schemas/content.d.ts +6 -6
- package/dist/esm/services/joomla/schemas/groups.d.ts +25 -2
- package/dist/esm/services/joomla/schemas/groups.d.ts.map +1 -1
- package/dist/esm/services/joomla/schemas/groups.js +2 -0
- package/dist/esm/services/joomla/schemas/groups.js.map +1 -1
- package/dist/esm/services/joomla/schemas/users.d.ts +455 -441
- package/dist/esm/services/joomla/schemas/users.d.ts.map +1 -1
- package/dist/esm/services/joomla/schemas/users.js +82 -58
- package/dist/esm/services/joomla/schemas/users.js.map +1 -1
- package/dist/esm/services/legacy/client.d.ts +2 -2
- package/dist/esm/services/legacy/schemas/states.d.ts +8 -8
- package/dist/esm/services/nexus/client.d.ts +6 -6
- package/dist/esm/services/nexus/schemas/bin-transfers.d.ts +2 -2
- package/dist/esm/services/nexus/schemas/receiving.d.ts +4 -4
- package/dist/esm/services/nexus/schemas/transfers.d.ts +6 -6
- package/dist/esm/services/open-search/client.d.ts +2 -2
- package/dist/esm/services/open-search/schemas/attributes.d.ts +2 -2
- package/dist/esm/services/open-search/schemas/items.d.ts +2 -2
- package/dist/esm/services/open-search/schemas/search.d.ts +2 -2
- package/dist/esm/services/orders/client.d.ts +15 -15
- package/dist/esm/services/orders/schemas/orders.d.ts +48 -48
- package/dist/esm/services/orders/schemas/purchase-orders.d.ts +32 -32
- package/dist/esm/services/orders/schemas/salesrep.d.ts +12 -12
- package/dist/esm/services/p21-pim/client.d.ts +2 -2
- package/dist/esm/services/p21-pim/schemas/inventory.d.ts +2 -2
- package/dist/esm/services/p21-pim/schemas/podcasts.d.ts +2 -2
- package/dist/esm/services/payments/client.d.ts +1 -1
- package/dist/esm/services/payments/schemas/element.d.ts +4 -4
- package/dist/esm/services/payments/schemas/unified.d.ts +16 -16
- package/dist/esm/services/pricing/client.d.ts +1 -1
- package/dist/esm/services/pricing/schemas/job-pricing.d.ts +4 -4
- package/dist/esm/services/pricing/schemas/pricing.d.ts +2 -2
- package/dist/esm/services/pricing/schemas/tax.d.ts +6 -6
- package/dist/esm/services/vmi/client.d.ts +6 -6
- package/dist/esm/services/vmi/schemas/products.d.ts +6 -6
- package/dist/esm/services/vmi/schemas/profiles.d.ts +4 -4
- package/dist/esm/services/vmi/schemas/restock.d.ts +2 -2
- package/dist/esm/services/vmi/schemas/warehouse.d.ts +6 -6
- package/dist/esm/utils/cross-site-auth.d.ts +88 -0
- package/dist/esm/utils/cross-site-auth.d.ts.map +1 -0
- package/dist/esm/utils/cross-site-auth.js +103 -0
- package/dist/esm/utils/cross-site-auth.js.map +1 -0
- package/dist/types/core/client.d.ts +1 -0
- package/dist/types/core/client.d.ts.map +1 -1
- package/dist/types/core/common-schemas.d.ts +2 -2
- package/dist/types/core/config.d.ts +2 -0
- package/dist/types/core/config.d.ts.map +1 -1
- package/dist/types/core/response-capturer.d.ts +58 -0
- package/dist/types/core/response-capturer.d.ts.map +1 -0
- package/dist/types/core/schema-factories.d.ts +4 -4
- package/dist/types/core/schemas.d.ts +4 -4
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/services/agr-site/client.d.ts +2 -2
- package/dist/types/services/agr-site/schemas/ai.d.ts +2 -2
- package/dist/types/services/agr-site/schemas/content.d.ts +2 -2
- package/dist/types/services/agr-site/schemas/settings.d.ts +2 -2
- package/dist/types/services/commerce/client.d.ts +2 -2
- package/dist/types/services/commerce/schemas/cart.d.ts +4 -4
- package/dist/types/services/commerce/schemas/checkout.d.ts +6 -6
- package/dist/types/services/commerce/schemas/recommendations.d.ts +2 -2
- package/dist/types/services/customers/client.d.ts +361 -199
- package/dist/types/services/customers/client.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/addresses.d.ts +408 -186
- package/dist/types/services/customers/schemas/addresses.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/contacts.d.ts +10 -10
- package/dist/types/services/customers/schemas/customers.d.ts +605 -524
- package/dist/types/services/customers/schemas/customers.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/index.d.ts +1 -0
- package/dist/types/services/customers/schemas/index.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/invoices.d.ts +643 -343
- package/dist/types/services/customers/schemas/invoices.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/orders.d.ts +1784 -172
- package/dist/types/services/customers/schemas/orders.d.ts.map +1 -1
- package/dist/types/services/customers/schemas/purchased-items.d.ts +122 -0
- package/dist/types/services/customers/schemas/purchased-items.d.ts.map +1 -0
- package/dist/types/services/customers/schemas/quotes.d.ts +1925 -331
- package/dist/types/services/customers/schemas/quotes.d.ts.map +1 -1
- package/dist/types/services/joomla/client.d.ts +38 -26
- package/dist/types/services/joomla/client.d.ts.map +1 -1
- package/dist/types/services/joomla/schemas/content.d.ts +6 -6
- package/dist/types/services/joomla/schemas/groups.d.ts +25 -2
- package/dist/types/services/joomla/schemas/groups.d.ts.map +1 -1
- package/dist/types/services/joomla/schemas/users.d.ts +455 -441
- package/dist/types/services/joomla/schemas/users.d.ts.map +1 -1
- package/dist/types/services/legacy/client.d.ts +2 -2
- package/dist/types/services/legacy/schemas/states.d.ts +8 -8
- package/dist/types/services/nexus/client.d.ts +6 -6
- package/dist/types/services/nexus/schemas/bin-transfers.d.ts +2 -2
- package/dist/types/services/nexus/schemas/receiving.d.ts +4 -4
- package/dist/types/services/nexus/schemas/transfers.d.ts +6 -6
- package/dist/types/services/open-search/client.d.ts +2 -2
- package/dist/types/services/open-search/schemas/attributes.d.ts +2 -2
- package/dist/types/services/open-search/schemas/items.d.ts +2 -2
- package/dist/types/services/open-search/schemas/search.d.ts +2 -2
- package/dist/types/services/orders/client.d.ts +15 -15
- package/dist/types/services/orders/schemas/orders.d.ts +48 -48
- package/dist/types/services/orders/schemas/purchase-orders.d.ts +32 -32
- package/dist/types/services/orders/schemas/salesrep.d.ts +12 -12
- package/dist/types/services/p21-pim/client.d.ts +2 -2
- package/dist/types/services/p21-pim/schemas/inventory.d.ts +2 -2
- package/dist/types/services/p21-pim/schemas/podcasts.d.ts +2 -2
- package/dist/types/services/payments/client.d.ts +1 -1
- package/dist/types/services/payments/schemas/element.d.ts +4 -4
- package/dist/types/services/payments/schemas/unified.d.ts +16 -16
- package/dist/types/services/pricing/client.d.ts +1 -1
- package/dist/types/services/pricing/schemas/job-pricing.d.ts +4 -4
- package/dist/types/services/pricing/schemas/pricing.d.ts +2 -2
- package/dist/types/services/pricing/schemas/tax.d.ts +6 -6
- package/dist/types/services/vmi/client.d.ts +6 -6
- package/dist/types/services/vmi/schemas/products.d.ts +6 -6
- package/dist/types/services/vmi/schemas/profiles.d.ts +4 -4
- package/dist/types/services/vmi/schemas/restock.d.ts +2 -2
- package/dist/types/services/vmi/schemas/warehouse.d.ts +6 -6
- package/dist/types/utils/cross-site-auth.d.ts +88 -0
- package/dist/types/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +3 -2
|
@@ -16,7 +16,7 @@ export declare const PriceEngineParamsSchema: z.ZodObject<{
|
|
|
16
16
|
customerId: number;
|
|
17
17
|
itemId: string;
|
|
18
18
|
cacheTtl: number;
|
|
19
|
-
edgeCache?: 3 |
|
|
19
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
20
20
|
limit?: number | undefined;
|
|
21
21
|
offset?: number | undefined;
|
|
22
22
|
quantity?: number | undefined;
|
|
@@ -26,7 +26,7 @@ export declare const PriceEngineParamsSchema: z.ZodObject<{
|
|
|
26
26
|
}, {
|
|
27
27
|
customerId: number;
|
|
28
28
|
itemId: string;
|
|
29
|
-
edgeCache?: 3 |
|
|
29
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
30
30
|
limit?: number | undefined;
|
|
31
31
|
offset?: number | undefined;
|
|
32
32
|
quantity?: number | undefined;
|
|
@@ -6,13 +6,13 @@ export declare const TaxEngineAddressSchema: z.ZodObject<{
|
|
|
6
6
|
postal_code: z.ZodString;
|
|
7
7
|
}, "strip", z.ZodTypeAny, {
|
|
8
8
|
state: string;
|
|
9
|
-
city: string;
|
|
10
9
|
street: string;
|
|
10
|
+
city: string;
|
|
11
11
|
postal_code: string;
|
|
12
12
|
}, {
|
|
13
13
|
state: string;
|
|
14
|
-
city: string;
|
|
15
14
|
street: string;
|
|
15
|
+
city: string;
|
|
16
16
|
postal_code: string;
|
|
17
17
|
}>;
|
|
18
18
|
export declare const TaxEngineItemSchema: z.ZodObject<{
|
|
@@ -57,13 +57,13 @@ export declare const TaxEngineRequestSchema: z.ZodObject<{
|
|
|
57
57
|
postal_code: z.ZodString;
|
|
58
58
|
}, "strip", z.ZodTypeAny, {
|
|
59
59
|
state: string;
|
|
60
|
-
city: string;
|
|
61
60
|
street: string;
|
|
61
|
+
city: string;
|
|
62
62
|
postal_code: string;
|
|
63
63
|
}, {
|
|
64
64
|
state: string;
|
|
65
|
-
city: string;
|
|
66
65
|
street: string;
|
|
66
|
+
city: string;
|
|
67
67
|
postal_code: string;
|
|
68
68
|
}>;
|
|
69
69
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -77,8 +77,8 @@ export declare const TaxEngineRequestSchema: z.ZodObject<{
|
|
|
77
77
|
}[];
|
|
78
78
|
ship_to_address: {
|
|
79
79
|
state: string;
|
|
80
|
-
city: string;
|
|
81
80
|
street: string;
|
|
81
|
+
city: string;
|
|
82
82
|
postal_code: string;
|
|
83
83
|
};
|
|
84
84
|
}, {
|
|
@@ -92,8 +92,8 @@ export declare const TaxEngineRequestSchema: z.ZodObject<{
|
|
|
92
92
|
}[];
|
|
93
93
|
ship_to_address: {
|
|
94
94
|
state: string;
|
|
95
|
-
city: string;
|
|
96
95
|
street: string;
|
|
96
|
+
city: string;
|
|
97
97
|
postal_code: string;
|
|
98
98
|
};
|
|
99
99
|
}>;
|
|
@@ -106,7 +106,7 @@ export declare class VMIClient extends BaseServiceClient {
|
|
|
106
106
|
* ```
|
|
107
107
|
*/
|
|
108
108
|
list: (params?: {
|
|
109
|
-
edgeCache?: 3 |
|
|
109
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
110
110
|
limit?: number | undefined;
|
|
111
111
|
offset?: number | undefined;
|
|
112
112
|
q?: string | undefined;
|
|
@@ -448,7 +448,7 @@ export declare class VMIClient extends BaseServiceClient {
|
|
|
448
448
|
*/
|
|
449
449
|
list: (params?: {
|
|
450
450
|
customerId: number;
|
|
451
|
-
edgeCache?: 3 |
|
|
451
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
452
452
|
limit?: number | undefined;
|
|
453
453
|
offset?: number | undefined;
|
|
454
454
|
statusCd?: number | undefined;
|
|
@@ -630,7 +630,7 @@ export declare class VMIClient extends BaseServiceClient {
|
|
|
630
630
|
list: (params?: {
|
|
631
631
|
customerId: number;
|
|
632
632
|
distributorsUid: number;
|
|
633
|
-
edgeCache?: 3 |
|
|
633
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
634
634
|
limit?: number | undefined;
|
|
635
635
|
offset?: number | undefined;
|
|
636
636
|
q?: string | undefined;
|
|
@@ -811,7 +811,7 @@ export declare class VMIClient extends BaseServiceClient {
|
|
|
811
811
|
*/
|
|
812
812
|
list: (params?: {
|
|
813
813
|
customerId: number;
|
|
814
|
-
edgeCache?: 3 |
|
|
814
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
815
815
|
limit?: number | undefined;
|
|
816
816
|
offset?: number | undefined;
|
|
817
817
|
} | undefined) => Promise<{
|
|
@@ -1038,7 +1038,7 @@ export declare class VMIClient extends BaseServiceClient {
|
|
|
1038
1038
|
* ```
|
|
1039
1039
|
*/
|
|
1040
1040
|
list: (params?: {
|
|
1041
|
-
edgeCache?: 3 |
|
|
1041
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
1042
1042
|
limit?: number | undefined;
|
|
1043
1043
|
offset?: number | undefined;
|
|
1044
1044
|
distributorsUid?: number | undefined;
|
|
@@ -1183,7 +1183,7 @@ export declare class VMIClient extends BaseServiceClient {
|
|
|
1183
1183
|
*/
|
|
1184
1184
|
list: (params?: {
|
|
1185
1185
|
customerId: number;
|
|
1186
|
-
edgeCache?: 3 |
|
|
1186
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
1187
1187
|
limit?: number | undefined;
|
|
1188
1188
|
offset?: number | undefined;
|
|
1189
1189
|
statusCd?: number | undefined;
|
|
@@ -42,10 +42,10 @@ export declare const DistributorListParamsSchema: z.ZodObject<{
|
|
|
42
42
|
offset: number;
|
|
43
43
|
customerId: number;
|
|
44
44
|
statusCd: number;
|
|
45
|
-
edgeCache?: 3 |
|
|
45
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
46
46
|
}, {
|
|
47
47
|
customerId: number;
|
|
48
|
-
edgeCache?: 3 |
|
|
48
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
49
49
|
limit?: number | undefined;
|
|
50
50
|
offset?: number | undefined;
|
|
51
51
|
statusCd?: number | undefined;
|
|
@@ -302,13 +302,13 @@ export declare const ProductListParamsSchema: z.ZodObject<{
|
|
|
302
302
|
customerId: number;
|
|
303
303
|
statusCd: number;
|
|
304
304
|
distributorsUid: number;
|
|
305
|
-
edgeCache?: 3 |
|
|
305
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
306
306
|
q?: string | undefined;
|
|
307
307
|
prefix?: string | undefined;
|
|
308
308
|
}, {
|
|
309
309
|
customerId: number;
|
|
310
310
|
distributorsUid: number;
|
|
311
|
-
edgeCache?: 3 |
|
|
311
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
312
312
|
limit?: number | undefined;
|
|
313
313
|
offset?: number | undefined;
|
|
314
314
|
q?: string | undefined;
|
|
@@ -325,13 +325,13 @@ export declare const ProductFindParamsSchema: z.ZodObject<{
|
|
|
325
325
|
prefix: z.ZodOptional<z.ZodString>;
|
|
326
326
|
}, "strip", z.ZodTypeAny, {
|
|
327
327
|
customerId: number;
|
|
328
|
-
edgeCache?: 3 |
|
|
328
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
329
329
|
limit?: number | undefined;
|
|
330
330
|
offset?: number | undefined;
|
|
331
331
|
prefix?: string | undefined;
|
|
332
332
|
}, {
|
|
333
333
|
customerId: number;
|
|
334
|
-
edgeCache?: 3 |
|
|
334
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
335
335
|
limit?: number | undefined;
|
|
336
336
|
offset?: number | undefined;
|
|
337
337
|
prefix?: string | undefined;
|
|
@@ -65,10 +65,10 @@ export declare const InvProfileHdrListParamsSchema: z.ZodObject<{
|
|
|
65
65
|
limit: number;
|
|
66
66
|
offset: number;
|
|
67
67
|
customerId: number;
|
|
68
|
-
edgeCache?: 3 |
|
|
68
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
69
69
|
}, {
|
|
70
70
|
customerId: number;
|
|
71
|
-
edgeCache?: 3 |
|
|
71
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
72
72
|
limit?: number | undefined;
|
|
73
73
|
offset?: number | undefined;
|
|
74
74
|
}>;
|
|
@@ -80,9 +80,9 @@ export declare const InvProfileLineListParamsSchema: z.ZodObject<{
|
|
|
80
80
|
}, "strip", z.ZodTypeAny, {
|
|
81
81
|
limit: number;
|
|
82
82
|
offset: number;
|
|
83
|
-
edgeCache?: 3 |
|
|
83
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
84
84
|
}, {
|
|
85
|
-
edgeCache?: 3 |
|
|
85
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
86
86
|
limit?: number | undefined;
|
|
87
87
|
offset?: number | undefined;
|
|
88
88
|
}>;
|
|
@@ -271,11 +271,11 @@ export declare const RestockHdrListParamsSchema: z.ZodObject<{
|
|
|
271
271
|
}, "strip", z.ZodTypeAny, {
|
|
272
272
|
limit: number;
|
|
273
273
|
offset: number;
|
|
274
|
-
edgeCache?: 3 |
|
|
274
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
275
275
|
distributorsUid?: number | undefined;
|
|
276
276
|
warehouseUid?: number | undefined;
|
|
277
277
|
}, {
|
|
278
|
-
edgeCache?: 3 |
|
|
278
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
279
279
|
limit?: number | undefined;
|
|
280
280
|
offset?: number | undefined;
|
|
281
281
|
distributorsUid?: number | undefined;
|
|
@@ -42,12 +42,12 @@ export declare const WarehouseListParamsSchema: z.ZodObject<{
|
|
|
42
42
|
offset: number;
|
|
43
43
|
orderBy: string;
|
|
44
44
|
statusCd: number;
|
|
45
|
-
edgeCache?: 3 |
|
|
45
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
46
46
|
q?: string | undefined;
|
|
47
47
|
customerId?: number | undefined;
|
|
48
48
|
usersId?: number | undefined;
|
|
49
49
|
}, {
|
|
50
|
-
edgeCache?: 3 |
|
|
50
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
51
51
|
limit?: number | undefined;
|
|
52
52
|
offset?: number | undefined;
|
|
53
53
|
q?: string | undefined;
|
|
@@ -254,10 +254,10 @@ export declare const WarehouseUserListParamsSchema: z.ZodObject<{
|
|
|
254
254
|
}, "strip", z.ZodTypeAny, {
|
|
255
255
|
limit: number;
|
|
256
256
|
offset: number;
|
|
257
|
-
edgeCache?: 3 |
|
|
257
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
258
258
|
statusCdList?: string | undefined;
|
|
259
259
|
}, {
|
|
260
|
-
edgeCache?: 3 |
|
|
260
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
261
261
|
limit?: number | undefined;
|
|
262
262
|
offset?: number | undefined;
|
|
263
263
|
statusCdList?: string | undefined;
|
|
@@ -430,10 +430,10 @@ export declare const SectionListParamsSchema: z.ZodObject<{
|
|
|
430
430
|
offset: number;
|
|
431
431
|
customerId: number;
|
|
432
432
|
statusCd: number;
|
|
433
|
-
edgeCache?: 3 |
|
|
433
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
434
434
|
}, {
|
|
435
435
|
customerId: number;
|
|
436
|
-
edgeCache?: 3 |
|
|
436
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
437
437
|
limit?: number | undefined;
|
|
438
438
|
offset?: number | undefined;
|
|
439
439
|
statusCd?: number | undefined;
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { AugurAPI } from '../client';
|
|
2
|
+
/**
|
|
3
|
+
* Cross-site authentication utility
|
|
4
|
+
* @description Streamlined utility for authenticating users across different Augur sites
|
|
5
|
+
* using augur_info privileges
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Parameters for cross-site authentication
|
|
9
|
+
*/
|
|
10
|
+
export interface CrossSiteAuthParams {
|
|
11
|
+
/** Target site ID to authenticate against */
|
|
12
|
+
targetSiteId: string;
|
|
13
|
+
/** Username or email */
|
|
14
|
+
username: string;
|
|
15
|
+
/** User password */
|
|
16
|
+
password: string;
|
|
17
|
+
/** JWT token with augur_info admin privileges */
|
|
18
|
+
augurInfoToken: string;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Result of cross-site authentication
|
|
22
|
+
*/
|
|
23
|
+
export interface CrossSiteAuthResult {
|
|
24
|
+
/** Whether authentication was successful */
|
|
25
|
+
success: boolean;
|
|
26
|
+
/** User ID if authentication succeeded */
|
|
27
|
+
userId?: string;
|
|
28
|
+
/** Username if authentication succeeded */
|
|
29
|
+
username?: string;
|
|
30
|
+
/** Email if authentication succeeded */
|
|
31
|
+
email?: string;
|
|
32
|
+
/** JWT token scoped to target site if authentication succeeded */
|
|
33
|
+
token?: string;
|
|
34
|
+
/** Target site ID */
|
|
35
|
+
targetSiteId: string;
|
|
36
|
+
/** Error message if authentication failed */
|
|
37
|
+
error?: string;
|
|
38
|
+
/** API client configured for target site (only if authentication succeeded) */
|
|
39
|
+
targetSiteAPI?: AugurAPI;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Authenticate a user against a target site using augur_info privileges
|
|
43
|
+
* @description This utility function simplifies cross-site authentication by:
|
|
44
|
+
* 1. Creating an augur_info API client with admin privileges
|
|
45
|
+
* 2. Using verifyPassword with the target siteId in the request body
|
|
46
|
+
* 3. Returning a ready-to-use API client for the target site on success
|
|
47
|
+
*
|
|
48
|
+
* @param params Cross-site authentication parameters
|
|
49
|
+
* @returns Promise resolving to authentication result with optional target site API client
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```typescript
|
|
53
|
+
* const result = await authenticateUserForSite({
|
|
54
|
+
* targetSiteId: 'tenant_site_1',
|
|
55
|
+
* username: 'user@tenant.com',
|
|
56
|
+
* password: 'userpassword',
|
|
57
|
+
* augurInfoToken: 'admin-jwt-token'
|
|
58
|
+
* });
|
|
59
|
+
*
|
|
60
|
+
* if (result.success) {
|
|
61
|
+
* // Use the pre-configured API client
|
|
62
|
+
* const userData = await result.targetSiteAPI!.joomla.users.get(result.userId!);
|
|
63
|
+
* console.log('User data:', userData);
|
|
64
|
+
* } else {
|
|
65
|
+
* console.error('Authentication failed:', result.error);
|
|
66
|
+
* }
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
export declare function authenticateUserForSite(params: CrossSiteAuthParams): Promise<CrossSiteAuthResult>;
|
|
70
|
+
/**
|
|
71
|
+
* Create a cross-site authentication function bound to specific augur_info credentials
|
|
72
|
+
* @description Factory function for creating a reusable cross-site authenticator
|
|
73
|
+
*
|
|
74
|
+
* @param augurInfoToken JWT token with augur_info admin privileges
|
|
75
|
+
* @returns Function that can authenticate users for any target site
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```typescript
|
|
79
|
+
* // Create reusable authenticator
|
|
80
|
+
* const crossSiteAuth = createCrossSiteAuthenticator('admin-jwt-token');
|
|
81
|
+
*
|
|
82
|
+
* // Use it for multiple sites
|
|
83
|
+
* const result1 = await crossSiteAuth('tenant_site_1', 'user1@tenant.com', 'pass1');
|
|
84
|
+
* const result2 = await crossSiteAuth('tenant_site_2', 'user2@tenant.com', 'pass2');
|
|
85
|
+
* ```
|
|
86
|
+
*/
|
|
87
|
+
export declare function createCrossSiteAuthenticator(augurInfoToken: string): (targetSiteId: string, username: string, password: string) => Promise<CrossSiteAuthResult>;
|
|
88
|
+
//# sourceMappingURL=cross-site-auth.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cross-site-auth.d.ts","sourceRoot":"","sources":["../../../src/utils/cross-site-auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGrC;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CA+C9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,4BAA4B,CAAC,cAAc,EAAE,MAAM,IAE/D,cAAc,MAAM,EACpB,UAAU,MAAM,EAChB,UAAU,MAAM,KACf,OAAO,CAAC,mBAAmB,CAAC,CAQhC"}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.authenticateUserForSite = authenticateUserForSite;
|
|
4
|
+
exports.createCrossSiteAuthenticator = createCrossSiteAuthenticator;
|
|
5
|
+
const client_1 = require("../client");
|
|
6
|
+
/**
|
|
7
|
+
* Authenticate a user against a target site using augur_info privileges
|
|
8
|
+
* @description This utility function simplifies cross-site authentication by:
|
|
9
|
+
* 1. Creating an augur_info API client with admin privileges
|
|
10
|
+
* 2. Using verifyPassword with the target siteId in the request body
|
|
11
|
+
* 3. Returning a ready-to-use API client for the target site on success
|
|
12
|
+
*
|
|
13
|
+
* @param params Cross-site authentication parameters
|
|
14
|
+
* @returns Promise resolving to authentication result with optional target site API client
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* const result = await authenticateUserForSite({
|
|
19
|
+
* targetSiteId: 'tenant_site_1',
|
|
20
|
+
* username: 'user@tenant.com',
|
|
21
|
+
* password: 'userpassword',
|
|
22
|
+
* augurInfoToken: 'admin-jwt-token'
|
|
23
|
+
* });
|
|
24
|
+
*
|
|
25
|
+
* if (result.success) {
|
|
26
|
+
* // Use the pre-configured API client
|
|
27
|
+
* const userData = await result.targetSiteAPI!.joomla.users.get(result.userId!);
|
|
28
|
+
* console.log('User data:', userData);
|
|
29
|
+
* } else {
|
|
30
|
+
* console.error('Authentication failed:', result.error);
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
async function authenticateUserForSite(params) {
|
|
35
|
+
const { targetSiteId, username, password, augurInfoToken } = params;
|
|
36
|
+
try {
|
|
37
|
+
// Create augur_info API client with admin privileges
|
|
38
|
+
const augurInfoAPI = new client_1.AugurAPI({
|
|
39
|
+
siteId: 'augur_info',
|
|
40
|
+
bearerToken: augurInfoToken,
|
|
41
|
+
});
|
|
42
|
+
// Perform cross-site authentication using existing verifyPassword method
|
|
43
|
+
const authResponse = await augurInfoAPI.joomla.users.verifyPassword({
|
|
44
|
+
username,
|
|
45
|
+
password,
|
|
46
|
+
siteId: targetSiteId, // This tells the API to authenticate against the target site
|
|
47
|
+
});
|
|
48
|
+
if (authResponse.data.isVerified) {
|
|
49
|
+
// Create API client for target site with the returned token
|
|
50
|
+
const targetSiteAPI = new client_1.AugurAPI({
|
|
51
|
+
siteId: targetSiteId,
|
|
52
|
+
bearerToken: authResponse.data.token,
|
|
53
|
+
});
|
|
54
|
+
return {
|
|
55
|
+
success: true,
|
|
56
|
+
userId: authResponse.data.id?.toString(),
|
|
57
|
+
username: authResponse.data.username,
|
|
58
|
+
email: authResponse.data.email,
|
|
59
|
+
token: authResponse.data.token,
|
|
60
|
+
targetSiteId,
|
|
61
|
+
targetSiteAPI,
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
else {
|
|
65
|
+
return {
|
|
66
|
+
success: false,
|
|
67
|
+
targetSiteId,
|
|
68
|
+
error: 'Invalid username or password',
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
catch (error) {
|
|
73
|
+
return {
|
|
74
|
+
success: false,
|
|
75
|
+
targetSiteId,
|
|
76
|
+
error: error instanceof Error ? error.message : 'Authentication failed',
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Create a cross-site authentication function bound to specific augur_info credentials
|
|
82
|
+
* @description Factory function for creating a reusable cross-site authenticator
|
|
83
|
+
*
|
|
84
|
+
* @param augurInfoToken JWT token with augur_info admin privileges
|
|
85
|
+
* @returns Function that can authenticate users for any target site
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```typescript
|
|
89
|
+
* // Create reusable authenticator
|
|
90
|
+
* const crossSiteAuth = createCrossSiteAuthenticator('admin-jwt-token');
|
|
91
|
+
*
|
|
92
|
+
* // Use it for multiple sites
|
|
93
|
+
* const result1 = await crossSiteAuth('tenant_site_1', 'user1@tenant.com', 'pass1');
|
|
94
|
+
* const result2 = await crossSiteAuth('tenant_site_2', 'user2@tenant.com', 'pass2');
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
function createCrossSiteAuthenticator(augurInfoToken) {
|
|
98
|
+
return async (targetSiteId, username, password) => {
|
|
99
|
+
return authenticateUserForSite({
|
|
100
|
+
targetSiteId,
|
|
101
|
+
username,
|
|
102
|
+
password,
|
|
103
|
+
augurInfoToken,
|
|
104
|
+
});
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
//# sourceMappingURL=cross-site-auth.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cross-site-auth.js","sourceRoot":"","sources":["../../../src/utils/cross-site-auth.ts"],"names":[],"mappings":";;AAyEA,0DAiDC;AAmBD,oEAaC;AA1JD,sCAAqC;AA6CrC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,uBAAuB,CAC3C,MAA2B;IAE3B,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;IAEpE,IAAI,CAAC;QACH,qDAAqD;QACrD,MAAM,YAAY,GAAG,IAAI,iBAAQ,CAAC;YAChC,MAAM,EAAE,YAAY;YACpB,WAAW,EAAE,cAAc;SAC5B,CAAC,CAAC;QAEH,yEAAyE;QACzE,MAAM,YAAY,GAA2B,MAAM,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;YAC1F,QAAQ;YACR,QAAQ;YACR,MAAM,EAAE,YAAY,EAAE,6DAA6D;SACpF,CAAC,CAAC;QAEH,IAAI,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACjC,4DAA4D;YAC5D,MAAM,aAAa,GAAG,IAAI,iBAAQ,CAAC;gBACjC,MAAM,EAAE,YAAY;gBACpB,WAAW,EAAE,YAAY,CAAC,IAAI,CAAC,KAAe;aAC/C,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE;gBACxC,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,QAAQ;gBACpC,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK;gBAC9B,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,KAAe;gBACxC,YAAY;gBACZ,aAAa;aACd,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,YAAY;gBACZ,KAAK,EAAE,8BAA8B;aACtC,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,KAAK;YACd,YAAY;YACZ,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB;SACxE,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,4BAA4B,CAAC,cAAsB;IACjE,OAAO,KAAK,EACV,YAAoB,EACpB,QAAgB,EAChB,QAAgB,EACc,EAAE;QAChC,OAAO,uBAAuB,CAAC;YAC7B,YAAY;YACZ,QAAQ;YACR,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/core/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAkB,aAAa,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/core/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAkB,aAAa,EAAE,MAAM,UAAU,CAAC;AAIzE,qBAAa,UAAU;IACrB,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,gBAAgB,CAAmB;gBAE/B,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc;IAevD,OAAO,CAAC,iBAAiB;IAiDzB,OAAO,CAAC,eAAe;IAqCvB,OAAO,CAAC,kBAAkB;IAUpB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAsBzE,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAKxE,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAKvE,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAKhE,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAInC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAGhC"}
|
package/dist/esm/core/client.js
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import axios from 'axios';
|
|
2
2
|
import { DEFAULT_CONFIG } from './config';
|
|
3
3
|
import { AugurError, AuthenticationError, NotFoundError, RateLimitError } from './errors';
|
|
4
|
+
import { ResponseCapturer } from './response-capturer';
|
|
4
5
|
export class HTTPClient {
|
|
5
6
|
constructor(serviceName, config) {
|
|
6
7
|
this.serviceName = serviceName;
|
|
7
8
|
this.config = { ...DEFAULT_CONFIG, ...config };
|
|
9
|
+
this.responseCapturer = new ResponseCapturer(this.config.captureResponses, this.config.capturePath);
|
|
8
10
|
this.axios = axios.create({
|
|
9
11
|
timeout: this.config.timeout,
|
|
10
12
|
});
|
|
@@ -29,7 +31,9 @@ export class HTTPClient {
|
|
|
29
31
|
return config;
|
|
30
32
|
}, error => Promise.reject(error));
|
|
31
33
|
// Response interceptor
|
|
32
|
-
this.axios.interceptors.response.use(response => {
|
|
34
|
+
this.axios.interceptors.response.use(async (response) => {
|
|
35
|
+
// Capture response if enabled
|
|
36
|
+
await this.responseCapturer.captureResponse(response, this.serviceName);
|
|
33
37
|
if (this.config.onResponse) {
|
|
34
38
|
return this.config.onResponse(response);
|
|
35
39
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/core/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAoD,MAAM,OAAO,CAAC;AACzE,OAAO,EAAkB,cAAc,EAAiB,MAAM,UAAU,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/core/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAoD,MAAM,OAAO,CAAC;AACzE,OAAO,EAAkB,cAAc,EAAiB,MAAM,UAAU,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1F,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,MAAM,OAAO,UAAU;IAMrB,YAAY,WAAmB,EAAE,MAAsB;QACrD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC;QAC/C,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,CAC1C,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAC5B,IAAI,CAAC,MAAM,CAAC,WAAW,CACxB,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;YACxB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;SAC7B,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAEO,iBAAiB;QACvB,sBAAsB;QACtB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CACjC,KAAK,EAAC,MAAM,EAAC,EAAE;YACb,8BAA8B;YAC9B,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YAEjD,kDAAkD;YAClD,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;YAC5D,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC9C,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YACxE,CAAC;YAED,mCAAmC;YACnC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;gBAC1B,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAC3D,8CAA8C;gBAC9C,OAAO,cAA4C,CAAC;YACtD,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC,EACD,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAC/B,CAAC;QAEF,uBAAuB;QACvB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAClC,KAAK,EAAC,QAAQ,EAAC,EAAE;YACf,8BAA8B;YAC9B,MAAM,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;gBAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC,EACD,KAAK,EAAC,KAAK,EAAC,EAAE;YACZ,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC;YACrC,MAAM,QAAQ,GAAG,eAAe,EAAE,GAAG,IAAI,SAAS,CAAC;YAEnD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACjD,CAAC;YAED,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC3C,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,eAAe,CAAC,QAAiB,EAAE,QAAgB;QACzD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,QAGxB,CAAC;QAEF,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,GAAG;gBACN,MAAM,IAAI,mBAAmB,CAAC;oBAC5B,OAAO,EAAE,IAAI,EAAE,OAAO,IAAI,uBAAuB;oBACjD,OAAO,EAAE,IAAI,CAAC,WAAW;oBACzB,QAAQ;iBACT,CAAC,CAAC;YACL,KAAK,GAAG;gBACN,MAAM,IAAI,aAAa,CAAC;oBACtB,OAAO,EAAE,IAAI,EAAE,OAAO,IAAI,oBAAoB;oBAC9C,OAAO,EAAE,IAAI,CAAC,WAAW;oBACzB,QAAQ;iBACT,CAAC,CAAC;YACL,KAAK,GAAG;gBACN,MAAM,IAAI,cAAc,CAAC;oBACvB,OAAO,EAAE,IAAI,EAAE,OAAO,IAAI,qBAAqB;oBAC/C,OAAO,EAAE,IAAI,CAAC,WAAW;oBACzB,QAAQ;iBACT,CAAC,CAAC;YACL;gBACE,MAAM,IAAI,UAAU,CAAC;oBACnB,OAAO,EAAE,IAAI,EAAE,OAAO,IAAI,8BAA8B,MAAM,EAAE;oBAChE,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,WAAW;oBAC/B,UAAU,EAAE,MAAM;oBAClB,OAAO,EAAE,IAAI,CAAC,WAAW;oBACzB,QAAQ;oBACR,SAAS,EAAE,IAAI,EAAE,SAAS;iBAC3B,CAAC,CAAC;QACP,CAAC;IACH,CAAC;IAEO,kBAAkB,CAAC,KAAc,EAAE,QAAgB;QACzD,MAAM,IAAI,UAAU,CAAC;YACnB,OAAO,EAAG,KAA8B,CAAC,OAAO,IAAI,eAAe;YACnE,IAAI,EAAE,eAAe;YACrB,UAAU,EAAE,CAAC;YACb,OAAO,EAAE,IAAI,CAAC,WAAW;YACzB,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,MAAgB,EAAE,MAAsB;QAChE,MAAM,UAAU,GACd,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAE,MAAkC,CAAC,CAAC,CAAC,EAAE,CAAC;QAElF,6DAA6D;QAC7D,MAAM,cAAc,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC;QAEzC,yEAAyE;QACzE,IAAI,UAAU,CAAC,SAAS,IAAI,OAAO,UAAU,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YACrE,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC;YACxC,cAAc,CAAC,cAAc,UAAU,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YAChE,+DAA+D;YAC/D,OAAO,cAAc,CAAC,SAAS,CAAC;QAClC,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAI,GAAG,EAAE;YAC5C,MAAM,EAAE,cAAc;YACtB,GAAG,MAAM;SACV,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,IAAI,CAAI,GAAW,EAAE,IAAc,EAAE,MAAsB;QAC/D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAI,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC7D,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,IAAc,EAAE,MAAsB;QAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAI,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5D,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,MAAM,CAAI,GAAW,EAAE,MAAsB;QACjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAI,GAAG,EAAE,MAAM,CAAC,CAAC;QACzD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,cAAc,CAAC,KAAa;QAC1B,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;IAClC,CAAC;IAED,SAAS,CAAC,MAAc;QACtB,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IAC9B,CAAC;CACF"}
|
|
@@ -97,9 +97,9 @@ export declare const SearchablePaginationParamsSchema: z.ZodObject<{
|
|
|
97
97
|
export declare const EdgeCacheParamsSchema: z.ZodObject<{
|
|
98
98
|
edgeCache: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<8>]>>;
|
|
99
99
|
}, "strip", z.ZodTypeAny, {
|
|
100
|
-
edgeCache?: 3 |
|
|
100
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
101
101
|
}, {
|
|
102
|
-
edgeCache?: 3 |
|
|
102
|
+
edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
|
|
103
103
|
}>;
|
|
104
104
|
export declare const BooleanResponseSchema: z.ZodObject<{
|
|
105
105
|
status: z.ZodNumber;
|
|
@@ -7,6 +7,8 @@ export interface AugurAPIConfig {
|
|
|
7
7
|
timeout?: number;
|
|
8
8
|
retries?: number;
|
|
9
9
|
retryDelay?: number;
|
|
10
|
+
captureResponses?: boolean;
|
|
11
|
+
capturePath?: string;
|
|
10
12
|
onRequest?: (config: AxiosRequestConfig) => AxiosRequestConfig | Promise<AxiosRequestConfig>;
|
|
11
13
|
onResponse?: <T = unknown>(response: AxiosResponse<T>) => AxiosResponse<T> | Promise<AxiosResponse<T>>;
|
|
12
14
|
onError?: (error: AxiosError) => void | Promise<void>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/core/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAEtE,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7F,UAAU,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,EACvB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KACvB,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;CACzD;AAED,eAAO,MAAM,cAAc;;;;CAI1B,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB"}
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/core/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAEtE,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7F,UAAU,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,EACvB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KACvB,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;CACzD;AAED,eAAO,MAAM,cAAc;;;;CAI1B,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/core/config.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/core/config.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,KAAK,EAAE,aAAa;IAC7B,OAAO,EAAE,CAAC;IACV,UAAU,EAAE,IAAI,EAAE,WAAW;CAC9B,CAAC"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { AxiosResponse } from 'axios';
|
|
2
|
+
/**
|
|
3
|
+
* Metadata for captured API responses
|
|
4
|
+
*/
|
|
5
|
+
export interface CapturedResponse {
|
|
6
|
+
timestamp: string;
|
|
7
|
+
service: string;
|
|
8
|
+
method: string;
|
|
9
|
+
url: string;
|
|
10
|
+
status: number;
|
|
11
|
+
headers: Record<string, string>;
|
|
12
|
+
response: unknown;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Utility class for capturing API responses to disk for schema validation improvement
|
|
16
|
+
*
|
|
17
|
+
* This utility helps developers capture real API responses to improve Zod schema definitions
|
|
18
|
+
* by providing visibility into actual response structures that may differ from documentation.
|
|
19
|
+
*/
|
|
20
|
+
export declare class ResponseCapturer {
|
|
21
|
+
private readonly enabled;
|
|
22
|
+
private readonly capturePath;
|
|
23
|
+
/**
|
|
24
|
+
* Create a new ResponseCapturer instance
|
|
25
|
+
* @param enabled Whether response capture is enabled
|
|
26
|
+
* @param capturePath Directory path where responses should be saved
|
|
27
|
+
*/
|
|
28
|
+
constructor(enabled?: boolean, capturePath?: string);
|
|
29
|
+
/**
|
|
30
|
+
* Capture an API response to disk if capture is enabled
|
|
31
|
+
* @param response Axios response object
|
|
32
|
+
* @param serviceName Name of the service making the request
|
|
33
|
+
*/
|
|
34
|
+
captureResponse(response: AxiosResponse, serviceName: string): Promise<void>;
|
|
35
|
+
/**
|
|
36
|
+
* Generate a safe filename for the captured response
|
|
37
|
+
* @param capturedData The captured response data
|
|
38
|
+
* @returns A filesystem-safe filename
|
|
39
|
+
*/
|
|
40
|
+
private generateFilename;
|
|
41
|
+
/**
|
|
42
|
+
* Sanitize endpoint URL to create a safe filename component
|
|
43
|
+
* @param url The API endpoint URL
|
|
44
|
+
* @returns A filesystem-safe string representing the endpoint
|
|
45
|
+
*/
|
|
46
|
+
private sanitizeEndpoint;
|
|
47
|
+
/**
|
|
48
|
+
* Extract relevant headers from the response
|
|
49
|
+
* @param response Axios response object
|
|
50
|
+
* @returns Simplified headers object
|
|
51
|
+
*/
|
|
52
|
+
private extractHeaders;
|
|
53
|
+
/**
|
|
54
|
+
* Ensure the capture directory exists
|
|
55
|
+
*/
|
|
56
|
+
private ensureCaptureDirectory;
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=response-capturer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"response-capturer.d.ts","sourceRoot":"","sources":["../../../src/core/response-capturer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAItC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IAErC;;;;OAIG;gBACS,OAAO,GAAE,OAAe,EAAE,WAAW,CAAC,EAAE,MAAM;IAS1D;;;;OAIG;IACG,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BlF;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAcxB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAuBxB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAwBtB;;OAEG;IACH,OAAO,CAAC,sBAAsB;CAU/B"}
|