@simpleapps-com/augur-api 2026.10.31 → 2026.11.1
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 +84 -33
- package/SKILL.md +25 -24
- package/dist/client.d.ts +334 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +179 -0
- package/dist/core/base-client.d.ts.map +1 -0
- package/dist/core/call-rules.d.ts +73 -0
- package/dist/core/call-rules.d.ts.map +1 -0
- package/dist/core/call.d.ts +48 -0
- package/dist/core/call.d.ts.map +1 -0
- package/dist/core/client.d.ts +112 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/common-schemas.d.ts +522 -0
- package/dist/core/common-schemas.d.ts.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/encoded-segment.d.ts +23 -0
- package/dist/core/encoded-segment.d.ts.map +1 -0
- package/dist/core/errors.d.ts +91 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/http-rules.d.ts +64 -0
- package/dist/core/http-rules.d.ts.map +1 -0
- package/dist/core/path-validation.d.ts +28 -0
- package/dist/core/path-validation.d.ts.map +1 -0
- package/dist/core/proxy-rules.d.ts +21 -0
- package/dist/core/proxy-rules.d.ts.map +1 -0
- package/dist/core/registry-rules.d.ts +15 -0
- package/dist/core/registry-rules.d.ts.map +1 -0
- package/dist/core/registry-tables.d.ts +3 -0
- package/dist/core/registry-tables.d.ts.map +1 -0
- package/dist/core/registry.d.ts +54 -0
- package/dist/core/registry.d.ts.map +1 -0
- package/dist/core/response-rules.d.ts +19 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +70 -0
- package/dist/core/schemas.d.ts.map +1 -0
- package/dist/core/service-proxy.d.ts +81 -0
- package/dist/core/service-proxy.d.ts.map +1 -0
- package/dist/core/site-id-check.d.ts +6 -0
- package/dist/core/site-id-check.d.ts.map +1 -0
- package/dist/core/site-id.d.ts +15 -0
- package/dist/core/site-id.d.ts.map +1 -0
- package/dist/index.d.ts +71 -236
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19875 -18513
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19874 -18513
- package/dist/index.mjs.map +1 -1
- package/dist/services/agr-info/client.d.ts +71 -0
- package/dist/services/agr-info/client.d.ts.map +1 -0
- package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-info/generated/schemas.d.ts +297 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1093 -0
- package/dist/services/agr-info/generated/types.d.ts.map +1 -0
- package/dist/services/agr-info/index.d.ts +2 -0
- package/dist/services/agr-info/index.d.ts.map +1 -0
- package/dist/services/agr-int/client.d.ts +100 -0
- package/dist/services/agr-int/client.d.ts.map +1 -0
- package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-int/generated/schemas.d.ts +595 -0
- package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-int/generated/types.d.ts +1984 -0
- package/dist/services/agr-int/generated/types.d.ts.map +1 -0
- package/dist/services/agr-int/index.d.ts +2 -0
- package/dist/services/agr-int/index.d.ts.map +1 -0
- package/dist/services/agr-site/client.d.ts +112 -0
- package/dist/services/agr-site/client.d.ts.map +1 -0
- package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-site/generated/schemas.d.ts +537 -0
- package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-site/generated/types.d.ts +1732 -0
- package/dist/services/agr-site/generated/types.d.ts.map +1 -0
- package/dist/services/agr-site/index.d.ts +2 -0
- package/dist/services/agr-site/index.d.ts.map +1 -0
- package/dist/services/agr-work/client.d.ts +23 -0
- package/dist/services/agr-work/client.d.ts.map +1 -0
- package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-work/generated/schemas.d.ts +21 -0
- package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-work/generated/types.d.ts +19 -0
- package/dist/services/agr-work/generated/types.d.ts.map +1 -0
- package/dist/services/agr-work/index.d.ts +2 -0
- package/dist/services/agr-work/index.d.ts.map +1 -0
- package/dist/services/avalara/client.d.ts +33 -0
- package/dist/services/avalara/client.d.ts.map +1 -0
- package/dist/services/avalara/generated/endpoints.d.ts +41 -0
- package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
- package/dist/services/avalara/generated/schemas.d.ts +22 -0
- package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
- package/dist/services/avalara/generated/types.d.ts +103 -0
- package/dist/services/avalara/generated/types.d.ts.map +1 -0
- package/dist/services/avalara/index.d.ts +2 -0
- package/dist/services/avalara/index.d.ts.map +1 -0
- package/dist/services/basecamp2/client.d.ts +92 -0
- package/dist/services/basecamp2/client.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
- package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/types.d.ts +1587 -0
- package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
- package/dist/services/basecamp2/index.d.ts +2 -0
- package/dist/services/basecamp2/index.d.ts.map +1 -0
- package/dist/services/brand-folder/client.d.ts +37 -0
- package/dist/services/brand-folder/client.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
- package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/types.d.ts +195 -0
- package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
- package/dist/services/brand-folder/index.d.ts +2 -0
- package/dist/services/brand-folder/index.d.ts.map +1 -0
- package/dist/services/commerce/client.d.ts +57 -0
- package/dist/services/commerce/client.d.ts.map +1 -0
- package/dist/services/commerce/generated/endpoints.d.ts +42 -0
- package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
- package/dist/services/commerce/generated/schemas.d.ts +319 -0
- package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
- package/dist/services/commerce/generated/types.d.ts +1134 -0
- package/dist/services/commerce/generated/types.d.ts.map +1 -0
- package/dist/services/commerce/index.d.ts +2 -0
- package/dist/services/commerce/index.d.ts.map +1 -0
- package/dist/services/customers/client.d.ts +162 -0
- package/dist/services/customers/client.d.ts.map +1 -0
- package/dist/services/customers/generated/endpoints.d.ts +42 -0
- package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
- package/dist/services/customers/generated/schemas.d.ts +1970 -0
- package/dist/services/customers/generated/schemas.d.ts.map +1 -0
- package/dist/services/customers/generated/types.d.ts +3849 -0
- package/dist/services/customers/generated/types.d.ts.map +1 -0
- package/dist/services/customers/index.d.ts +2 -0
- package/dist/services/customers/index.d.ts.map +1 -0
- package/dist/services/goog-mc/client.d.ts +44 -0
- package/dist/services/goog-mc/client.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/types.d.ts +361 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
- package/dist/services/goog-mc/index.d.ts +2 -0
- package/dist/services/goog-mc/index.d.ts.map +1 -0
- package/dist/services/gregorovich/client.d.ts +34 -0
- package/dist/services/gregorovich/client.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
- package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/types.d.ts +70 -0
- package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
- package/dist/services/gregorovich/index.d.ts +2 -0
- package/dist/services/gregorovich/index.d.ts.map +1 -0
- package/dist/services/items/client.d.ts +453 -0
- package/dist/services/items/client.d.ts.map +1 -0
- package/dist/services/items/generated/endpoints.d.ts +42 -0
- package/dist/services/items/generated/endpoints.d.ts.map +1 -0
- package/dist/services/items/generated/schemas.d.ts +4636 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -0
- package/dist/services/items/generated/types.d.ts +10513 -0
- package/dist/services/items/generated/types.d.ts.map +1 -0
- package/dist/services/items/index.d.ts +2 -0
- package/dist/services/items/index.d.ts.map +1 -0
- package/dist/services/joomla/client.d.ts +74 -0
- package/dist/services/joomla/client.d.ts.map +1 -0
- package/dist/services/joomla/generated/endpoints.d.ts +41 -0
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
- package/dist/services/joomla/generated/schemas.d.ts +546 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1489 -0
- package/dist/services/joomla/generated/types.d.ts.map +1 -0
- package/dist/services/joomla/index.d.ts +2 -0
- package/dist/services/joomla/index.d.ts.map +1 -0
- package/dist/services/legacy/client.d.ts +75 -0
- package/dist/services/legacy/client.d.ts.map +1 -0
- package/dist/services/legacy/generated/endpoints.d.ts +41 -0
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
- package/dist/services/legacy/generated/schemas.d.ts +567 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
- package/dist/services/legacy/generated/types.d.ts +1454 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -0
- package/dist/services/legacy/index.d.ts +2 -0
- package/dist/services/legacy/index.d.ts.map +1 -0
- package/dist/services/logistics/client.d.ts +64 -0
- package/dist/services/logistics/client.d.ts.map +1 -0
- package/dist/services/logistics/generated/endpoints.d.ts +41 -0
- package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
- package/dist/services/logistics/generated/schemas.d.ts +375 -0
- package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
- package/dist/services/logistics/generated/types.d.ts +925 -0
- package/dist/services/logistics/generated/types.d.ts.map +1 -0
- package/dist/services/logistics/index.d.ts +2 -0
- package/dist/services/logistics/index.d.ts.map +1 -0
- package/dist/services/markets/client.d.ts +47 -0
- package/dist/services/markets/client.d.ts.map +1 -0
- package/dist/services/markets/generated/endpoints.d.ts +41 -0
- package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/markets/generated/schemas.d.ts +180 -0
- package/dist/services/markets/generated/schemas.d.ts.map +1 -0
- package/dist/services/markets/generated/types.d.ts +405 -0
- package/dist/services/markets/generated/types.d.ts.map +1 -0
- package/dist/services/markets/index.d.ts +2 -0
- package/dist/services/markets/index.d.ts.map +1 -0
- package/dist/services/notifications/client.d.ts +58 -0
- package/dist/services/notifications/client.d.ts.map +1 -0
- package/dist/services/notifications/generated/endpoints.d.ts +41 -0
- package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
- package/dist/services/notifications/generated/schemas.d.ts +247 -0
- package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
- package/dist/services/notifications/generated/types.d.ts +666 -0
- package/dist/services/notifications/generated/types.d.ts.map +1 -0
- package/dist/services/notifications/index.d.ts +2 -0
- package/dist/services/notifications/index.d.ts.map +1 -0
- package/dist/services/open-search/client.d.ts +69 -0
- package/dist/services/open-search/client.d.ts.map +1 -0
- package/dist/services/open-search/generated/endpoints.d.ts +42 -0
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
- package/dist/services/open-search/generated/schemas.d.ts +363 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
- package/dist/services/open-search/generated/types.d.ts +983 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -0
- package/dist/services/open-search/index.d.ts +2 -0
- package/dist/services/open-search/index.d.ts.map +1 -0
- package/dist/services/orders/client.d.ts +180 -0
- package/dist/services/orders/client.d.ts.map +1 -0
- package/dist/services/orders/generated/endpoints.d.ts +42 -0
- package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
- package/dist/services/orders/generated/schemas.d.ts +2479 -0
- package/dist/services/orders/generated/schemas.d.ts.map +1 -0
- package/dist/services/orders/generated/types.d.ts +4717 -0
- package/dist/services/orders/generated/types.d.ts.map +1 -0
- package/dist/services/orders/index.d.ts +2 -0
- package/dist/services/orders/index.d.ts.map +1 -0
- package/dist/services/p21-apis/client.d.ts +59 -0
- package/dist/services/p21-apis/client.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
- package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/types.d.ts +246 -0
- package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
- package/dist/services/p21-apis/index.d.ts +2 -0
- package/dist/services/p21-apis/index.d.ts.map +1 -0
- package/dist/services/p21-core/client.d.ts +131 -0
- package/dist/services/p21-core/client.d.ts.map +1 -0
- package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
- package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-core/generated/types.d.ts +2718 -0
- package/dist/services/p21-core/generated/types.d.ts.map +1 -0
- package/dist/services/p21-core/index.d.ts +2 -0
- package/dist/services/p21-core/index.d.ts.map +1 -0
- package/dist/services/p21-pim/client.d.ts +75 -0
- package/dist/services/p21-pim/client.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
- package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/types.d.ts +933 -0
- package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
- package/dist/services/p21-pim/index.d.ts +2 -0
- package/dist/services/p21-pim/index.d.ts.map +1 -0
- package/dist/services/p21-sism/client.d.ts +432 -0
- package/dist/services/p21-sism/client.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
- package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/types.d.ts +6977 -0
- package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
- package/dist/services/p21-sism/index.d.ts +37 -0
- package/dist/services/p21-sism/index.d.ts.map +1 -0
- package/dist/services/payments/client.d.ts +77 -0
- package/dist/services/payments/client.d.ts.map +1 -0
- package/dist/services/payments/generated/endpoints.d.ts +42 -0
- package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
- package/dist/services/payments/generated/schemas.d.ts +1015 -0
- package/dist/services/payments/generated/schemas.d.ts.map +1 -0
- package/dist/services/payments/generated/types.d.ts +1432 -0
- package/dist/services/payments/generated/types.d.ts.map +1 -0
- package/dist/services/payments/index.d.ts +2 -0
- package/dist/services/payments/index.d.ts.map +1 -0
- package/dist/services/pricing/client.d.ts +216 -0
- package/dist/services/pricing/client.d.ts.map +1 -0
- package/dist/services/pricing/generated/endpoints.d.ts +42 -0
- package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
- package/dist/services/pricing/generated/schemas.d.ts +2048 -0
- package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
- package/dist/services/pricing/generated/types.d.ts +4257 -0
- package/dist/services/pricing/generated/types.d.ts.map +1 -0
- package/dist/services/pricing/index.d.ts +2 -0
- package/dist/services/pricing/index.d.ts.map +1 -0
- package/dist/services/shipping/client.d.ts +33 -0
- package/dist/services/shipping/client.d.ts.map +1 -0
- package/dist/services/shipping/generated/endpoints.d.ts +41 -0
- package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
- package/dist/services/shipping/generated/schemas.d.ts +29 -0
- package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
- package/dist/services/shipping/generated/types.d.ts +116 -0
- package/dist/services/shipping/generated/types.d.ts.map +1 -0
- package/dist/services/shipping/index.d.ts +2 -0
- package/dist/services/shipping/index.d.ts.map +1 -0
- package/dist/services/smarty-streets/client.d.ts +33 -0
- package/dist/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/types.d.ts +145 -0
- package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
- package/dist/services/smarty-streets/index.d.ts +2 -0
- package/dist/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/services/ups/client.d.ts +32 -0
- package/dist/services/ups/client.d.ts.map +1 -0
- package/dist/services/ups/generated/endpoints.d.ts +40 -0
- package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
- package/dist/services/ups/generated/schemas.d.ts +51 -0
- package/dist/services/ups/generated/schemas.d.ts.map +1 -0
- package/dist/services/ups/generated/types.d.ts +98 -0
- package/dist/services/ups/generated/types.d.ts.map +1 -0
- package/dist/services/ups/index.d.ts +2 -0
- package/dist/services/ups/index.d.ts.map +1 -0
- package/dist/services/vendors/client.d.ts +38 -0
- package/dist/services/vendors/client.d.ts.map +1 -0
- package/dist/services/vendors/generated/endpoints.d.ts +41 -0
- package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vendors/generated/schemas.d.ts +350 -0
- package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
- package/dist/services/vendors/generated/types.d.ts +470 -0
- package/dist/services/vendors/generated/types.d.ts.map +1 -0
- package/dist/services/vendors/index.d.ts +2 -0
- package/dist/services/vendors/index.d.ts.map +1 -0
- package/dist/services/vmi/client.d.ts +129 -0
- package/dist/services/vmi/client.d.ts.map +1 -0
- package/dist/services/vmi/generated/endpoints.d.ts +41 -0
- package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vmi/generated/schemas.d.ts +723 -0
- package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
- package/dist/services/vmi/generated/types.d.ts +2620 -0
- package/dist/services/vmi/generated/types.d.ts.map +1 -0
- package/dist/services/vmi/index.d.ts +2 -0
- package/dist/services/vmi/index.d.ts.map +1 -0
- package/dist/testing.d.ts +9 -13
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +7 -17
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +7 -17
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts +88 -0
- package/dist/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +34 -47
- package/dist/client-TPJa269Y.d.mts +0 -58610
- package/dist/client-TPJa269Y.d.ts +0 -58610
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
import type { HTTPClient } from "./client";
|
|
2
|
+
import { type HealthCheckData, type PingData, type WhoamiData } from "./schemas";
|
|
3
|
+
import * as v from "valibot";
|
|
4
|
+
/**
|
|
5
|
+
* HTTP method types for API operations
|
|
6
|
+
*/
|
|
7
|
+
export type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE";
|
|
8
|
+
/**
|
|
9
|
+
* Configuration for API endpoint operations
|
|
10
|
+
*/
|
|
11
|
+
export interface EndpointConfig {
|
|
12
|
+
/** HTTP method for the request */
|
|
13
|
+
method: HTTPMethod;
|
|
14
|
+
/** Endpoint path (will be prefixed with baseUrl) */
|
|
15
|
+
path: string;
|
|
16
|
+
/**
|
|
17
|
+
* Path param → anchored regex its value MUST match (the endpoint's registry
|
|
18
|
+
* `pathPatterns`, shared/REGISTRY.md). A param without one only has to be
|
|
19
|
+
* non-empty and well-formed.
|
|
20
|
+
*/
|
|
21
|
+
pathPatterns?: Readonly<Record<string, string>>;
|
|
22
|
+
/** Valibot schema for validating request parameters */
|
|
23
|
+
paramsSchema?: v.GenericSchema;
|
|
24
|
+
/** Valibot schema for validating response data */
|
|
25
|
+
responseSchema: v.GenericSchema;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Standard API response structure - REQUIRED for all services (8-field format)
|
|
29
|
+
* This is the ONLY acceptable response format for all APIs
|
|
30
|
+
*/
|
|
31
|
+
export interface BaseResponse<T> {
|
|
32
|
+
/** Number of items in current response */
|
|
33
|
+
count: number;
|
|
34
|
+
/** Response data of type T */
|
|
35
|
+
data: T;
|
|
36
|
+
/** Response message */
|
|
37
|
+
message: string;
|
|
38
|
+
/** Additional options for the response */
|
|
39
|
+
options: unknown[] | Record<string, unknown>;
|
|
40
|
+
/** Parameters used in the request */
|
|
41
|
+
params: unknown[] | Record<string, unknown>;
|
|
42
|
+
/** HTTP status code */
|
|
43
|
+
status: number;
|
|
44
|
+
/** Total items in dataset */
|
|
45
|
+
total: number;
|
|
46
|
+
/** Total results available */
|
|
47
|
+
totalResults: number;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Abstract base class for all service clients
|
|
51
|
+
*
|
|
52
|
+
* Provides standardized error handling, validation, and request processing
|
|
53
|
+
* to eliminate boilerplate code across service implementations.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```typescript
|
|
57
|
+
* class MyServiceClient extends BaseServiceClient {
|
|
58
|
+
* constructor(http: HTTPClient, baseUrl?: string) {
|
|
59
|
+
* super('myservice', http, baseUrl || 'https://myservice.augur-api.com');
|
|
60
|
+
* }
|
|
61
|
+
*
|
|
62
|
+
* // Simple method using executeRequest
|
|
63
|
+
* async getUser(id: number) {
|
|
64
|
+
* return this.executeRequest({
|
|
65
|
+
* method: 'GET',
|
|
66
|
+
* path: `/users/${id}`,
|
|
67
|
+
* responseSchema: UserResponseSchema
|
|
68
|
+
* });
|
|
69
|
+
* }
|
|
70
|
+
*
|
|
71
|
+
* // Method with parameters
|
|
72
|
+
* async listUsers(params?: UserListParams) {
|
|
73
|
+
* return this.executeRequest({
|
|
74
|
+
* method: 'GET',
|
|
75
|
+
* path: '/users',
|
|
76
|
+
* paramsSchema: UserListParamsSchema,
|
|
77
|
+
* responseSchema: UserListResponseSchema
|
|
78
|
+
* }, params);
|
|
79
|
+
* }
|
|
80
|
+
* }
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
export declare abstract class BaseServiceClient {
|
|
84
|
+
protected readonly serviceName: string;
|
|
85
|
+
protected readonly http: HTTPClient;
|
|
86
|
+
protected readonly baseUrl: string;
|
|
87
|
+
/** GET /health-check: service health (x-site-id, no Bearer) */
|
|
88
|
+
readonly healthCheck: {
|
|
89
|
+
get: () => Promise<BaseResponse<HealthCheckData>>;
|
|
90
|
+
};
|
|
91
|
+
/** GET /health-check, unwrapped to `.data` */
|
|
92
|
+
readonly healthCheckData: {
|
|
93
|
+
get: () => Promise<HealthCheckData>;
|
|
94
|
+
};
|
|
95
|
+
/** GET /ping: liveness check (no auth) */
|
|
96
|
+
readonly ping: {
|
|
97
|
+
get: () => Promise<BaseResponse<PingData>>;
|
|
98
|
+
};
|
|
99
|
+
/** GET /ping, unwrapped to `.data` */
|
|
100
|
+
readonly pingData: {
|
|
101
|
+
get: () => Promise<PingData>;
|
|
102
|
+
};
|
|
103
|
+
/** GET /whoami: decoded JWT claims (x-site-id + Bearer) */
|
|
104
|
+
readonly whoami: {
|
|
105
|
+
get: () => Promise<BaseResponse<WhoamiData>>;
|
|
106
|
+
};
|
|
107
|
+
/** GET /whoami, unwrapped to `.data` */
|
|
108
|
+
readonly whoamiData: {
|
|
109
|
+
get: () => Promise<WhoamiData>;
|
|
110
|
+
};
|
|
111
|
+
/**
|
|
112
|
+
* Create a new service client instance
|
|
113
|
+
* @param serviceName Name of the service (used for error reporting)
|
|
114
|
+
* @param http Configured HTTPClient instance
|
|
115
|
+
* @param baseUrl Base URL for the service API
|
|
116
|
+
*/
|
|
117
|
+
constructor(serviceName: string, http: HTTPClient, baseUrl: string);
|
|
118
|
+
/**
|
|
119
|
+
* Execute a standardized API request with automatic validation and error handling
|
|
120
|
+
*
|
|
121
|
+
* This method handles all the common patterns:
|
|
122
|
+
* - Parameter validation with Valibot schemas
|
|
123
|
+
* - HTTP request execution
|
|
124
|
+
* - Response validation
|
|
125
|
+
* - Consistent error handling and reporting
|
|
126
|
+
*
|
|
127
|
+
* @param config Endpoint configuration including method, path, and schemas
|
|
128
|
+
* @param params Optional request parameters (query params for GET, body for POST/PUT)
|
|
129
|
+
* @param pathParams Optional path parameters for URL substitution
|
|
130
|
+
* @returns Promise resolving to the validated response data
|
|
131
|
+
* @throws ValidationError When parameters or response validation fails
|
|
132
|
+
* @throws AugurError For HTTP errors (handled by HTTPClient interceptors)
|
|
133
|
+
*/
|
|
134
|
+
protected executeRequest<TParams = unknown, TResponse = unknown>(config: EndpointConfig, params?: TParams, pathParams?: Record<string, string | number>, query?: unknown): Promise<TResponse>;
|
|
135
|
+
/**
|
|
136
|
+
* GET one of the parameterless base endpoints (health-check, ping, whoami)
|
|
137
|
+
*/
|
|
138
|
+
private getBaseEndpoint;
|
|
139
|
+
/**
|
|
140
|
+
* Validate request parameters using the provided schema
|
|
141
|
+
*/
|
|
142
|
+
private validateParameters;
|
|
143
|
+
/**
|
|
144
|
+
* Execute HTTP request based on the configured method
|
|
145
|
+
*
|
|
146
|
+
* For GET, `validatedParams` IS the query string. For POST/PUT it is the
|
|
147
|
+
* request body, and `query` carries the query string alongside it — the API
|
|
148
|
+
* declares query params on write methods too, and DELETE previously dropped
|
|
149
|
+
* them entirely.
|
|
150
|
+
*/
|
|
151
|
+
private executeHttpRequest;
|
|
152
|
+
/**
|
|
153
|
+
* Create a validation error for invalid params or an unexpected response.
|
|
154
|
+
*
|
|
155
|
+
* @ensures result.endpoint = config.path (the template; the filled path can hold param values)
|
|
156
|
+
* @ensures result.message holds no param values (issues name fields; valibot issue messages
|
|
157
|
+
* describe the expected type, and `received` is not copied)
|
|
158
|
+
*/
|
|
159
|
+
private createValidationError;
|
|
160
|
+
/**
|
|
161
|
+
* Build endpoint path with optional path parameter substitution.
|
|
162
|
+
* Each value is validated against its placeholder's pattern, then
|
|
163
|
+
* percent-encoded per segment (`encodePathSegment`).
|
|
164
|
+
*
|
|
165
|
+
* @param pathTemplate Path template with {param} placeholders
|
|
166
|
+
* @param pathParams Object containing parameter values
|
|
167
|
+
* @param pathPatterns Placeholder name → anchored regex its value MUST match
|
|
168
|
+
* @returns Processed endpoint path
|
|
169
|
+
*
|
|
170
|
+
* @example
|
|
171
|
+
* ```typescript
|
|
172
|
+
* buildEndpointPath('/users/{id}', { id: '123' }) // returns '/users/123'
|
|
173
|
+
* buildEndpointPath('/bins/{bin}', { bin: 'D/S' }) // returns '/bins/D%2FS'
|
|
174
|
+
* buildEndpointPath('/health-check') // returns '/health-check'
|
|
175
|
+
* ```
|
|
176
|
+
*/
|
|
177
|
+
private buildEndpointPath;
|
|
178
|
+
}
|
|
179
|
+
//# sourceMappingURL=base-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"base-client.d.ts","sourceRoot":"","sources":["../../src/core/base-client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAS3C,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,QAAQ,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACjF,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kCAAkC;IAClC,MAAM,EAAE,UAAU,CAAC;IACnB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAChD,uDAAuD;IACvD,YAAY,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC;IAC/B,kDAAkD;IAClD,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,IAAI,EAAE,CAAC,CAAC;IACR,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7C,qCAAqC;IACrC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5C,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,8BAAsB,iBAAiB;IACrC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IACvC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IACpC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAKnC,+DAA+D;IAC/D,QAAQ,CAAC,WAAW;mBACT,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;MAE/C;IAEF,8CAA8C;IAC9C,QAAQ,CAAC,eAAe;mBACP,OAAO,CAAC,eAAe,CAAC;MACvC;IAEF,0CAA0C;IAC1C,QAAQ,CAAC,IAAI;mBACF,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;MAExC;IAEF,sCAAsC;IACtC,QAAQ,CAAC,QAAQ;mBACA,OAAO,CAAC,QAAQ,CAAC;MAChC;IAEF,2DAA2D;IAC3D,QAAQ,CAAC,MAAM;mBACJ,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;MAE1C;IAEF,wCAAwC;IACxC,QAAQ,CAAC,UAAU;mBACF,OAAO,CAAC,UAAU,CAAC;MAClC;IAEF;;;;;OAKG;gBACS,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM;IAMlE;;;;;;;;;;;;;;;OAeG;cACa,cAAc,CAAC,OAAO,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,EACnE,MAAM,EAAE,cAAc,EACtB,MAAM,CAAC,EAAE,OAAO,EAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAC5C,KAAK,CAAC,EAAE,OAAO,GACd,OAAO,CAAC,SAAS,CAAC;IAiBrB;;OAEG;IACH,OAAO,CAAC,eAAe;IAOvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAmB1B;;;;;;;OAOG;YACW,kBAAkB;IAwBhC;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAuB7B;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,iBAAiB;CAuC1B"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A query key is allowed when the entry declares it, or it is `edgeCache` on an edge-cached
|
|
3
|
+
* entry.
|
|
4
|
+
*
|
|
5
|
+
* @ensures exactly the model's QueryKeyAllowed
|
|
6
|
+
*/
|
|
7
|
+
export declare function isQueryKeyAllowed(declared: boolean, edgeCache: boolean, key: string): boolean;
|
|
8
|
+
/**
|
|
9
|
+
* A body (not undefined or null) is refused where the entry takes none.
|
|
10
|
+
*
|
|
11
|
+
* @ensures exactly the model's BodyRefused
|
|
12
|
+
*/
|
|
13
|
+
export declare function isBodyRefused(given: boolean, hasBody: boolean): boolean;
|
|
14
|
+
/**
|
|
15
|
+
* Where call() sends a request: the service's own host.
|
|
16
|
+
*
|
|
17
|
+
* @ensures exactly the model's ServiceUrl
|
|
18
|
+
*/
|
|
19
|
+
export declare function serviceUrl(service: string, path: string): string;
|
|
20
|
+
/**
|
|
21
|
+
* Missing path params (names joined).
|
|
22
|
+
*
|
|
23
|
+
* @ensures exactly the model's MissingPathMessage
|
|
24
|
+
*/
|
|
25
|
+
export declare function missingPathMessage(id: string, names: string): string;
|
|
26
|
+
/**
|
|
27
|
+
* Unknown keys of one kind (keys joined).
|
|
28
|
+
*
|
|
29
|
+
* @ensures exactly the model's UnknownMessage
|
|
30
|
+
*/
|
|
31
|
+
export declare function unknownMessage(kind: string, id: string, keys: string): string;
|
|
32
|
+
/**
|
|
33
|
+
* A body on an entry that takes none.
|
|
34
|
+
*
|
|
35
|
+
* @ensures exactly the model's NoBodyMessage
|
|
36
|
+
*/
|
|
37
|
+
export declare function noBodyMessage(id: string): string;
|
|
38
|
+
/**
|
|
39
|
+
* An id the registry doesn't know.
|
|
40
|
+
*
|
|
41
|
+
* @ensures exactly the model's UnknownIdMessage
|
|
42
|
+
*/
|
|
43
|
+
export declare function unknownIdMessage(id: string): string;
|
|
44
|
+
/** What is wrong with a path value, if anything (path-validation.ts). */
|
|
45
|
+
export type PathProblem = "ok" | "pattern" | "empty" | "malformed";
|
|
46
|
+
/**
|
|
47
|
+
* A path value's problem, in the code's order: the registry pattern (`matches`: no pattern,
|
|
48
|
+
* or the wrapper's `RegExp` test passed), then empty, then lone surrogates (`malformed`,
|
|
49
|
+
* utils `hasLoneSurrogate`).
|
|
50
|
+
*
|
|
51
|
+
* @ensures exactly the model's PathValueProblem — proved in the link
|
|
52
|
+
*/
|
|
53
|
+
export declare function pathProblemOf(value: string, matches: boolean, malformed: boolean): PathProblem;
|
|
54
|
+
/**
|
|
55
|
+
* The problem's text: the registry's pattern, never the value (values may be card data or PII).
|
|
56
|
+
*
|
|
57
|
+
* @ensures exactly the model's PathProblemText — proved in the link
|
|
58
|
+
*/
|
|
59
|
+
export declare function pathProblemText(problem: PathProblem, pattern: string): string;
|
|
60
|
+
/**
|
|
61
|
+
* The error for a refused path value: the param's name and the problem.
|
|
62
|
+
*
|
|
63
|
+
* @ensures exactly the model's InvalidPathMessage
|
|
64
|
+
*/
|
|
65
|
+
export declare function invalidPathMessage(name: string, problem: string): string;
|
|
66
|
+
/**
|
|
67
|
+
* A template with every `{placeholder}` filled with an encoded segment (utils `replaceText`:
|
|
68
|
+
* `split/join`, never a string replacer, which would expand `$&` in the segment).
|
|
69
|
+
*
|
|
70
|
+
* @ensures exactly the model's FillPlaceholder — proved in the link
|
|
71
|
+
*/
|
|
72
|
+
export declare function placeholderFilled(path: string, placeholder: string, segment: string): string;
|
|
73
|
+
//# sourceMappingURL=call-rules.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"call-rules.d.ts","sourceRoot":"","sources":["../../src/core/call-rules.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAI7F;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAIvE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAIhE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI7E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAIhD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAInD;AAED,yEAAyE;AACzE,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC;AAEnE;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,GAAG,WAAW,CAK9F;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAK7E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAIxE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAG5F"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { AugurAPIConfig } from "./config";
|
|
2
|
+
import { type EndpointEntry } from "./registry";
|
|
3
|
+
/** What `call()` sends. Keys are sent as given; there is no case renaming. */
|
|
4
|
+
export interface CallArgs {
|
|
5
|
+
/** Exactly the entry's `pathParams` */
|
|
6
|
+
pathParams?: Record<string, string | number>;
|
|
7
|
+
/** A subset of the entry's `queryParams`, plus `edgeCache` where the entry allows it */
|
|
8
|
+
query?: Record<string, unknown>;
|
|
9
|
+
/** Only for entries with `hasBody` */
|
|
10
|
+
body?: unknown;
|
|
11
|
+
}
|
|
12
|
+
/** The standard 8-key response envelope. Values are passed through unchecked. */
|
|
13
|
+
export interface Envelope {
|
|
14
|
+
count: unknown;
|
|
15
|
+
data: unknown;
|
|
16
|
+
message: unknown;
|
|
17
|
+
options: unknown;
|
|
18
|
+
params: unknown;
|
|
19
|
+
status: unknown;
|
|
20
|
+
total: unknown;
|
|
21
|
+
totalResults: unknown;
|
|
22
|
+
}
|
|
23
|
+
/** A 2xx response. */
|
|
24
|
+
export interface CallResult {
|
|
25
|
+
httpStatus: number;
|
|
26
|
+
/** Set when `body` is an object with all 8 envelope keys, otherwise `null` */
|
|
27
|
+
envelope: Envelope | null;
|
|
28
|
+
/** Parsed JSON, or the raw text when the body isn't JSON (`''` when empty) */
|
|
29
|
+
body: unknown;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* The entry's path with each `{name}` replaced by its validated, percent-encoded value. Every
|
|
33
|
+
* value goes through `validatePathSegment` and then `encodePathSegment`; `renderPath` accepts only
|
|
34
|
+
* the `EncodedSegment`s that produces.
|
|
35
|
+
*/
|
|
36
|
+
export declare function fillPath(entry: EndpointEntry, pathParams: Record<string, string | number>): string;
|
|
37
|
+
/**
|
|
38
|
+
* Call the endpoint `id` (a canonical or alias id) with `args`.
|
|
39
|
+
*
|
|
40
|
+
* @requires config.siteId ≠ '' (assumed, not checked: neither this nor the AugurAPI constructor
|
|
41
|
+
* validates it; an empty siteId goes out as an empty x-site-id, which the API rejects)
|
|
42
|
+
* @ensures (resolves) ⇒ result.httpStatus ∈ [200, 300) (non-2xx throws through the shared status switch)
|
|
43
|
+
* @ensures result.envelope ≠ null ⇒ result.body is an object with all 8 envelope keys
|
|
44
|
+
* @throws InvalidArgumentError before any I/O when the id is unknown or `args` break checkArgs
|
|
45
|
+
* @throws AugurError subclasses for non-2xx and network failures, with `endpoint` = entry.path
|
|
46
|
+
*/
|
|
47
|
+
export declare function callEndpoint(config: AugurAPIConfig, id: string, args?: CallArgs): Promise<CallResult>;
|
|
48
|
+
//# sourceMappingURL=call.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"call.d.ts","sourceRoot":"","sources":["../../src/core/call.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAK/C,OAAO,EAAmB,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAEjE,8EAA8E;AAC9E,MAAM,WAAW,QAAQ;IACvB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAC7C,wFAAwF;IACxF,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,sCAAsC;IACtC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,iFAAiF;AACjF,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,sBAAsB;AACtB,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,8EAA8E;IAC9E,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,8EAA8E;IAC9E,IAAI,EAAE,OAAO,CAAC;CACf;AA8DD;;;;GAIG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,aAAa,EACpB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAC1C,MAAM,CAQR;AAcD;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,cAAc,EACtB,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,QAAa,GAClB,OAAO,CAAC,UAAU,CAAC,CAiBrB"}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { type AugurAPIConfig, type RequestConfig } from "./config";
|
|
2
|
+
/** A response as text, before any JSON parsing (what `call()` builds its result from). */
|
|
3
|
+
export interface RawResponse {
|
|
4
|
+
status: number;
|
|
5
|
+
contentType: string;
|
|
6
|
+
text: string;
|
|
7
|
+
}
|
|
8
|
+
/** JSON-parse `text`, or report that it isn't JSON (`undefined`, no text, isn't). Never throws. */
|
|
9
|
+
export declare function parseJson(text: string | undefined): {
|
|
10
|
+
json: true;
|
|
11
|
+
value: unknown;
|
|
12
|
+
} | {
|
|
13
|
+
json: false;
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* Generates a unique key for request deduplication
|
|
17
|
+
* @param method HTTP method
|
|
18
|
+
* @param url Request URL
|
|
19
|
+
* @param params Query parameters or request body
|
|
20
|
+
* @returns Unique string key for this request
|
|
21
|
+
*/
|
|
22
|
+
export declare function generateRequestKey(method: string, url: string, params?: unknown): string;
|
|
23
|
+
export declare class HTTPClient {
|
|
24
|
+
private config;
|
|
25
|
+
private serviceName;
|
|
26
|
+
private inflightRequests;
|
|
27
|
+
constructor(serviceName: string, config: AugurAPIConfig);
|
|
28
|
+
/**
|
|
29
|
+
* Build request headers with auth
|
|
30
|
+
*/
|
|
31
|
+
private buildRequestHeaders;
|
|
32
|
+
/**
|
|
33
|
+
* Handle non-ok fetch response: parse error, call hook, throw
|
|
34
|
+
*/
|
|
35
|
+
private handleFetchError;
|
|
36
|
+
/**
|
|
37
|
+
* Handle successful fetch response: parse, call hook, return data
|
|
38
|
+
*/
|
|
39
|
+
private handleFetchSuccess;
|
|
40
|
+
/**
|
|
41
|
+
* Read a successful response as text, for `raw()`. Never parses JSON.
|
|
42
|
+
*/
|
|
43
|
+
private readRaw;
|
|
44
|
+
/**
|
|
45
|
+
* Core request method using native fetch. `read` turns a 2xx response into
|
|
46
|
+
* the result, inside the same error handling and timeout as the fetch.
|
|
47
|
+
*/
|
|
48
|
+
private request;
|
|
49
|
+
/** The request's timeout: per request, else the client's, else the default (timeoutOf). */
|
|
50
|
+
private timeoutFor;
|
|
51
|
+
/** The request as the `onRequest` hook receives it. */
|
|
52
|
+
private baseRequest;
|
|
53
|
+
/**
|
|
54
|
+
* Merge two AbortSignals — aborts when either fires
|
|
55
|
+
*/
|
|
56
|
+
private mergeSignals;
|
|
57
|
+
/**
|
|
58
|
+
* The one status-to-error switch, shared by typed methods and `call()`.
|
|
59
|
+
*
|
|
60
|
+
* @ensures 400 → ValidationError, 401 → AuthenticationError, 404 → NotFoundError,
|
|
61
|
+
* 429 → RateLimitError, any other status → AugurError (the class follows the status alone)
|
|
62
|
+
* @ensures thrown.endpoint = endpoint (callers pass the path template, so no param values leak)
|
|
63
|
+
*/
|
|
64
|
+
private handleHttpError;
|
|
65
|
+
/**
|
|
66
|
+
* Re-throw known error types or wrap as network error
|
|
67
|
+
*/
|
|
68
|
+
private rethrowOrWrapError;
|
|
69
|
+
private handleNetworkError;
|
|
70
|
+
/**
|
|
71
|
+
* Executes a single request attempt
|
|
72
|
+
*/
|
|
73
|
+
private executeAttempt;
|
|
74
|
+
/**
|
|
75
|
+
* Executes a request with retry logic
|
|
76
|
+
*/
|
|
77
|
+
private executeWithRetry;
|
|
78
|
+
/**
|
|
79
|
+
* Transform edgeCache parameter to Cloudflare's cacheSiteId format
|
|
80
|
+
*
|
|
81
|
+
* Cloudflare expects cacheSiteId{suffix}=<siteId> where suffix indicates duration:
|
|
82
|
+
* - '30s', '1m', '5m' for sub-hour caches
|
|
83
|
+
* - 1, 2, 3, 4, 5, 8 for hourly caches
|
|
84
|
+
*
|
|
85
|
+
* Examples:
|
|
86
|
+
* - edgeCache: '30s' → cacheSiteId30s: <siteId>
|
|
87
|
+
* - edgeCache: '1m' → cacheSiteId1m: <siteId>
|
|
88
|
+
* - edgeCache: '5m' → cacheSiteId5m: <siteId>
|
|
89
|
+
* - edgeCache: 1 → cacheSiteId1: <siteId>
|
|
90
|
+
* - edgeCache: 8 → cacheSiteId8: <siteId>
|
|
91
|
+
*
|
|
92
|
+
* @param params Original request parameters
|
|
93
|
+
* @returns Parameters with edgeCache transformed to cacheSiteId{suffix}
|
|
94
|
+
*/
|
|
95
|
+
private transformEdgeCacheParams;
|
|
96
|
+
get<T>(url: string, params?: unknown, config?: RequestConfig): Promise<T>;
|
|
97
|
+
post<T>(url: string, data?: unknown, params?: unknown, config?: RequestConfig): Promise<T>;
|
|
98
|
+
put<T>(url: string, data?: unknown, params?: unknown, config?: RequestConfig): Promise<T>;
|
|
99
|
+
delete<T>(url: string, params?: unknown, config?: RequestConfig): Promise<T>;
|
|
100
|
+
/**
|
|
101
|
+
* Send a request and return the 2xx response as text, with no schema
|
|
102
|
+
* validation and no JSON assumption. Non-2xx responses throw through the same
|
|
103
|
+
* status switch as the typed methods. GET retries like `get()` (without its
|
|
104
|
+
* in-flight deduplication); other methods make one attempt, like `post()`.
|
|
105
|
+
*/
|
|
106
|
+
raw(method: string, url: string, options?: {
|
|
107
|
+
params?: unknown;
|
|
108
|
+
data?: unknown;
|
|
109
|
+
config?: RequestConfig;
|
|
110
|
+
}): Promise<RawResponse>;
|
|
111
|
+
}
|
|
112
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/core/client.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,cAAc,EAKnB,KAAK,aAAa,EACnB,MAAM,UAAU,CAAC;AAoBlB,0FAA0F;AAC1F,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AASD,mGAAmG;AACnG,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,GAAG,SAAS,GACvB;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,CAMlD;AAyCD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAIxF;AA4FD,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,gBAAgB,CAA4C;gBAExD,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc;IAKvD;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAe3B;;OAEG;YACW,gBAAgB;IA+B9B;;OAEG;YACW,kBAAkB;IAsBhC;;OAEG;YACW,OAAO;IAqBrB;;;OAGG;YACW,OAAO;IAwCrB,2FAA2F;IAC3F,OAAO,CAAC,UAAU;IAYlB,uDAAuD;IACvD,OAAO,CAAC,WAAW;IAgBnB;;OAEG;IACH,OAAO,CAAC,YAAY;IAgBpB;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAevB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,kBAAkB;IAU1B;;OAEG;YACW,cAAc;IAuB5B;;OAEG;YACW,gBAAgB;IAO9B;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,wBAAwB;IA4C1B,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IA6BzE,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAQ1F,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAQzF,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAOlF;;;;;OAKG;IACG,GAAG,CACP,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,aAAa,CAAA;KAAO,GACzE,OAAO,CAAC,WAAW,CAAC;CAUxB"}
|