@africanies/angular-web-sdk 0.1.6 → 0.1.8

package/.nx/cache/{17491371155400585077 → 13466509747676776487}/dist/libs/africanies-core/types/africanies-africanies-core.d.ts

@@ -484,7 +484,8 @@ interface ApiRequestOptions {
  * - HTTP failures rethrown as `Error` whose `.message` is already
  *   user-facing ({@link formatApiErrorMessage}) — consumers do not need to
  *   parse `HttpErrorResponse` bodies
- * - Exponential-backoff retry (max 1) for **GET only**
+ * - **No automatic retry** — fail fast so UIs can show Select / table /
+ *   error-state Retry instead of a stuck loading spinner
  * - Optional per-GET TTL cache via `cacheTtlMs`
  *
  * @example
@@ -1066,8 +1067,8 @@ declare function listFetchKind(options: {
  * (no caret/tilde): TanStack marks the Angular adapter experimental and
  * breaking changes land without major bumps.
  *
- * Retry/backoff here mirrors {@link ApiClient}'s GET retry (max 3,
- * exponential) so HTTP-layer and query-layer behavior stay aligned.
+ * Query retries default to **0** to match {@link ApiClient} (fail fast;
+ * screens use manual Retry). Apps can override per `QueryClient` if needed.
  */
 /**
  * Shape compatible with TanStack `QueryClient` `defaultOptions` without
@@ -1079,9 +1080,9 @@ interface AfricaniesQueryClientDefaults {
         staleTime: number;
         /** Unused-query garbage-collection time (ms). */
         gcTime: number;
-        /** Max failed-fetch retries for queries. */
+        /** Max failed-fetch retries for queries (default 0 — fail fast). */
         retry: number;
-        /** Exponential delay matching ApiClient GET backoff. */
+        /** Delay between retries when {@link AfricaniesQueryClientDefaults.queries.retry} > 0. */
         retryDelay: (attemptIndex: number) => number;
     };
     mutations: {
@@ -2240,13 +2241,15 @@ declare class NotificationService {
     static ɵprov: i0.ɵɵInjectableDeclaration<NotificationService>;
 }
 
+/** Signed export downloads and other hosts that must not be rewritten in-app. */
+declare function isNotificationExternalLink(link: string): boolean;
 /**
- * Rewrite a notification portal URL for the active {@link ShippingMode}.
+ * Rewrite a notification href for the active {@link ShippingMode}.
  *
- * Swaps `-export` / `-import` host segments and sets `shipment_app` to
- * `shipfromnaija` (SFN) or `shiptonaija` (STN).
- * @param link
- * @param mode
+ * - Export / download URLs (S3, spreadsheets) pass through unchanged (no `shipment_app`).
+ * - Legacy portal hosts become relative `/portal/...` paths with query preserved.
+ * - When the notification already includes `shipment_app`, it is kept as-is.
+ * - Otherwise classic host / `shipment_app` rewriting applies for portal URLs.
  */
 declare function resolveNotificationLinkForMode(link: string | null | undefined, mode: ShippingMode): string;
 
@@ -2736,5 +2739,5 @@ declare function toCsvString(options: Pick<DownloadCsvOptions, 'headers' | 'rows
  */
 declare function downloadCsv(options: DownloadCsvOptions): boolean;
 
-export { AFRICANIES_HTTP_TOAST, AFRICANIES_SDK_CONFIG, AUTH_FORGOT_PASSWORD_PATH, ApiClient, AuthService, AuthTokenService, COUNTRY_FLAG_CDN_BASE, COUNTRY_READ_PATH, CURRENCY_CREATE_PATH, CURRENCY_DELETE_PATH, CURRENCY_READ_PATH, CURRENCY_UPDATE_PATH, CountryService, CurrencyService, DOCUMENT_READ_PATH, DRAWER_SERVICE, DocumentService, FILE_READ_MULTIPLE_PARAM, FILE_READ_PATH, FileService, FilterOptionsResolver, HttpResponseCache, MODAL_SERVICE, MODE_CONFIG_PATH, ModeConfigService, NOTIFICATION_READ_PATH, NOTIFICATION_UPDATE_PATH, NotificationService, OVERLAY_ROUTE_CONFIGS, PAYMENT_METHOD_READ_PATH, PAYMENT_METHOD_UPDATE_PATH, PLAN_READ_PATH, PRODUCT_READ_PATH, PaymentMethodService, PlanService, ProductService, RouteOverlayService, SERVICE_READ_PATH, SHIPMENT_METHOD_READ_PATH, SHIPPING_MODE_OVERRIDE, ServiceService, ShipmentMethodService, ShippingModeService, TOAST_HTTP_OPTIONS, USER_CHANGE_PASSWORD_PATH, USER_LOGOUT_FROM_ALL_SESSIONS_PATH, USER_PATH, UserService, WAREHOUSE_READ_PATH, WarehouseService, ZONE_READ_PATH, ZoneService, asArray, asBoolean, asNullableBoolean, asNullableFlag01, asNullableNumber, asNullableString, asNumber, asRecord, asShippingMode, asString, authInterceptor, buildResourcePath, buildResourceQueryParams, collectFilterOptionsSources, collectResolvableSelectFields, copyToClipboard, countryFlagUrl, createAfricaniesQueryClientDefaults, csvCell, downloadCsv, fieldErrorsMap, formatApiErrorMessage, httpToastInterceptor, isLaravelValidationBag, isValidEmail, joinApiErrorMessages, listFetchKind, mapApiJsonList, mapApiJsonValue, mapArray, mapCountry, mapCountryList, mapCountrySelectOptions, mapCountryState, mapCurrency, mapCurrencyList, mapCurrencyPaymentMethod, mapCurrencyPaymentMethodPivot, mapDocument, mapDocumentList, mapFileRead, mapFileReadList, mapLaravelValidationBag, mapList, mapModeConfigData, mapNotification, mapNotificationInboxItem, mapNotificationList, mapNotificationPayload, mapPaymentMethod, mapPaymentMethodCurrency, mapPaymentMethodList, mapPlan, mapPlanList, mapPlanPackage, mapProduct, mapProductList, mapResourcePayload, mapService, mapServiceList, mapShipmentMethod, mapShipmentMethodFilterOptions, mapShipmentMethodList, mapShipmentMethodZoneLink, mapShipmentMethodZonePage, mapShipmentZone, mapUser, mapUserAccountManager, mapUserBusinessAccount, mapUserCountry, mapUserCountryState, mapUserGatewayPayload, mapUserPaymentPayload, mapUserPlan, mapUserPlanPackage, mapUserStateLabel, mapUserSubscription, mapWarehouse, mapWarehouseCountry, mapWarehouseFilterOptions, mapWarehouseList, mapWarehouseState, mapZone, mapZoneList, mergeFilterOptionLists, normalize, normalizePagination, provideAfricaniesHttpClient, provideAfricaniesQueryDefaults, provideAfricaniesSdk, provideModeConfig, provideOverlayRoutes, resolveModeRegionConfig, resolveNotificationLinkForMode, resourceCacheTtlMs, shipmentModeInterceptor, toCsvString, toCurrencyCreateBody, toCurrencyDeleteBody, toCurrencyFlag01, toCurrencyUpdateBody, toFlag01, toPaymentMethodFlag01, toPaymentMethodUpdateBody, unwrapLaravelPaginator, withShippingMode, withToast };
+export { AFRICANIES_HTTP_TOAST, AFRICANIES_SDK_CONFIG, AUTH_FORGOT_PASSWORD_PATH, ApiClient, AuthService, AuthTokenService, COUNTRY_FLAG_CDN_BASE, COUNTRY_READ_PATH, CURRENCY_CREATE_PATH, CURRENCY_DELETE_PATH, CURRENCY_READ_PATH, CURRENCY_UPDATE_PATH, CountryService, CurrencyService, DOCUMENT_READ_PATH, DRAWER_SERVICE, DocumentService, FILE_READ_MULTIPLE_PARAM, FILE_READ_PATH, FileService, FilterOptionsResolver, HttpResponseCache, MODAL_SERVICE, MODE_CONFIG_PATH, ModeConfigService, NOTIFICATION_READ_PATH, NOTIFICATION_UPDATE_PATH, NotificationService, OVERLAY_ROUTE_CONFIGS, PAYMENT_METHOD_READ_PATH, PAYMENT_METHOD_UPDATE_PATH, PLAN_READ_PATH, PRODUCT_READ_PATH, PaymentMethodService, PlanService, ProductService, RouteOverlayService, SERVICE_READ_PATH, SHIPMENT_METHOD_READ_PATH, SHIPPING_MODE_OVERRIDE, ServiceService, ShipmentMethodService, ShippingModeService, TOAST_HTTP_OPTIONS, USER_CHANGE_PASSWORD_PATH, USER_LOGOUT_FROM_ALL_SESSIONS_PATH, USER_PATH, UserService, WAREHOUSE_READ_PATH, WarehouseService, ZONE_READ_PATH, ZoneService, asArray, asBoolean, asNullableBoolean, asNullableFlag01, asNullableNumber, asNullableString, asNumber, asRecord, asShippingMode, asString, authInterceptor, buildResourcePath, buildResourceQueryParams, collectFilterOptionsSources, collectResolvableSelectFields, copyToClipboard, countryFlagUrl, createAfricaniesQueryClientDefaults, csvCell, downloadCsv, fieldErrorsMap, formatApiErrorMessage, httpToastInterceptor, isLaravelValidationBag, isNotificationExternalLink, isValidEmail, joinApiErrorMessages, listFetchKind, mapApiJsonList, mapApiJsonValue, mapArray, mapCountry, mapCountryList, mapCountrySelectOptions, mapCountryState, mapCurrency, mapCurrencyList, mapCurrencyPaymentMethod, mapCurrencyPaymentMethodPivot, mapDocument, mapDocumentList, mapFileRead, mapFileReadList, mapLaravelValidationBag, mapList, mapModeConfigData, mapNotification, mapNotificationInboxItem, mapNotificationList, mapNotificationPayload, mapPaymentMethod, mapPaymentMethodCurrency, mapPaymentMethodList, mapPlan, mapPlanList, mapPlanPackage, mapProduct, mapProductList, mapResourcePayload, mapService, mapServiceList, mapShipmentMethod, mapShipmentMethodFilterOptions, mapShipmentMethodList, mapShipmentMethodZoneLink, mapShipmentMethodZonePage, mapShipmentZone, mapUser, mapUserAccountManager, mapUserBusinessAccount, mapUserCountry, mapUserCountryState, mapUserGatewayPayload, mapUserPaymentPayload, mapUserPlan, mapUserPlanPackage, mapUserStateLabel, mapUserSubscription, mapWarehouse, mapWarehouseCountry, mapWarehouseFilterOptions, mapWarehouseList, mapWarehouseState, mapZone, mapZoneList, mergeFilterOptionLists, normalize, normalizePagination, provideAfricaniesHttpClient, provideAfricaniesQueryDefaults, provideAfricaniesSdk, provideModeConfig, provideOverlayRoutes, resolveModeRegionConfig, resolveNotificationLinkForMode, resourceCacheTtlMs, shipmentModeInterceptor, toCsvString, toCurrencyCreateBody, toCurrencyDeleteBody, toCurrencyFlag01, toCurrencyUpdateBody, toFlag01, toPaymentMethodFlag01, toPaymentMethodUpdateBody, unwrapLaravelPaginator, withShippingMode, withToast };
 export type { AfricaniesHttpClientOptions, AfricaniesHttpToastHandler, AfricaniesQueryClientDefaults, AfricaniesSdkConfig, AfricaniesSdkHttpToasts, ApiRequestOptions, CountryFlagFormat, CountryFlagUrlOptions, CountrySelectOption, CsvCellValue, DownloadCsvOptions, FilterOptionLists, FilterSelectOption, ListFetchKind, ListFetchReason, OverlayHandle, OverlayOpener, OverlayRouteConfig, OverlayRouteEntry, ResourceQueryParams, ShippingModeChangeGuard, ToastHttpOptions };