@africanies/angular-web-sdk 0.1.11 → 0.1.13

package/.nx/cache/{13466509747676776487 → 13293303228070520113}/dist/libs/africanies-core/fesm2022/africanies-africanies-core.mjs

@@ -48,6 +48,9 @@ const DEFAULT_MODE = 'sfn';
  * console.log(shipping.mode()); // 'stn'
  * ```
  */
+/**
+ * Signal-based holder for the active {@link ShippingMode}.
+ */
 class ShippingModeService {
     storage = inject(SessionStorageService);
     injector = inject(Injector);
@@ -970,6 +973,9 @@ function mapResourcePayload(id, raw, mapOne, mapMany) {
  * });
  * ```
  */
+/**
+ * Endpoint-agnostic HTTP façade over Angular {@link HttpClient}.
+ */
 class ApiClient {
     http = inject(HttpClient);
     config = inject(AFRICANIES_SDK_CONFIG);
@@ -1295,6 +1301,9 @@ function resolveModeRegionConfig(config, mode, countryCode) {
  * }
  * ```
  */
+/**
+ * Source of truth for region currency and measurement units (STN / SFN).
+ */
 class ModeConfigService {
     api = inject(ApiClient);
     storage = inject(STORAGE_TOKEN);
@@ -1456,6 +1465,9 @@ const AUTH_FORGOT_PASSWORD_PATH = '/auth/forgot/password';
  * });
  * ```
  */
+/**
+ * Unauthenticated auth endpoints (`POST /auth/…`).
+ */
 class AuthService {
     api = inject(ApiClient);
     /**
@@ -1502,6 +1514,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.0.8", ngImpor
  * });
  * ```
  */
+/**
+ * Holds the bearer access token used by {@link authInterceptor}.
+ */
 class AuthTokenService {
     storage = inject(STORAGE_TOKEN);
     api = inject(ApiClient);
@@ -1914,6 +1929,9 @@ const COUNTRY_CACHE_TTL_MS = 5 * 60_000;
  * countries.readById(1).subscribe((res) => console.log(res.data?.name));
  * ```
  */
+/**
+ * Public country utility reads (`GET /public/country/read/{id?}`).
+ */
 class CountryService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -2117,6 +2135,9 @@ const DOCUMENT_CACHE_TTL_MS = 5 * 60_000;
  * });
  * ```
  */
+/**
+ * Public document catalog reads (`GET /public/document/read/{id?}`).
+ */
 class DocumentService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -2240,6 +2261,9 @@ const PLAN_CACHE_TTL_MS = 5 * 60_000;
  * });
  * ```
  */
+/**
+ * Public subscription-plan reads (`GET /public/plan/read/{id?}`).
+ */
 class PlanService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -2337,6 +2361,9 @@ const SERVICE_CACHE_TTL_MS = 5 * 60_000;
  * services.readById(3).subscribe((res) => console.log(res.data?.name));
  * ```
  */
+/**
+ * Public subscription-service reads (`GET /public/service/read/{id?}`).
+ */
 class ServiceService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -2539,6 +2566,9 @@ const CURRENCY_CACHE_TTL_MS = 5 * 60_000;
  * currencies.readById(5).subscribe((res) => console.log(res.data?.name));
  * ```
  */
+/**
+ * Currency App Settings API (`GET /currency/read/{id?}` plus create / update / delete).
+ */
 class CurrencyService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -2741,6 +2771,9 @@ const PAYMENT_METHOD_CACHE_TTL_MS = 5 * 60_000;
  * });
  * ```
  */
+/**
+ * Payment-method App Settings API (`GET /payment_method/read/{id?}` plus update).
+ */
 class PaymentMethodService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -2944,6 +2977,9 @@ const SHIPMENT_METHOD_CACHE_TTL_MS = 5 * 60_000;
  * methods.readById(12).subscribe((res) => console.log(res.data?.name));
  * ```
  */
+/**
+ * Shipment method / carrier utility reads (`GET /shipment_method/read/{id?}`).
+ */
 class ShipmentMethodService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -3085,6 +3121,9 @@ const WAREHOUSE_CACHE_TTL_MS = 5 * 60_000;
  * warehouses.readById(37).subscribe((res) => console.log(res.data?.name));
  * ```
  */
+/**
+ * Warehouse utility reads (`GET /warehouse/read/{id?}`).
+ */
 class WarehouseService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -3180,6 +3219,9 @@ const ZONE_CACHE_TTL_MS = 5 * 60_000;
  * zones.readById(1).subscribe((res) => console.log(res.data?.name));
  * ```
  */
+/**
+ * Zone utility reads (`GET /zone/read/records/{id?}`).
+ */
 class ZoneService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -3552,6 +3594,9 @@ function mapUser(raw) {
  * });
  * ```
  */
+/**
+ * Current authenticated user (`GET /user`).
+ */
 class UserService {
     api = inject(ApiClient);
     /**
@@ -3692,6 +3737,9 @@ function mapNotificationInboxItem(notification) {
  * });
  * ```
  */
+/**
+ * Authenticated user notifications (`GET /user/notifications/read/{id?}`).
+ */
 class NotificationService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -3767,7 +3815,10 @@ const SHIPMENT_APP_BY_MODE = {
 };
 const QUERY_SHIPMENT_APP = 'shipment_app';
 const LEGACY_PORTAL_HOST = /^(?:test-)?(?:admin|customer)-(?:export|import)\.africaniestest\.com$/i;
-/** Signed export downloads and other hosts that must not be rewritten in-app. */
+/**
+ * Signed export downloads and other hosts that must not be rewritten in-app.
+ * @param link
+ */
 function isNotificationExternalLink(link) {
     const trimmed = decodeNotificationLink(link).trim();
     if (!trimmed) {
@@ -3794,6 +3845,8 @@ function isNotificationExternalLink(link) {
  * - 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.
+ * @param link
+ * @param mode
  */
 function resolveNotificationLinkForMode(link, mode) {
     const trimmed = decodeNotificationLink(asString(link)).trim();
@@ -3952,6 +4005,9 @@ function isLegacyPortalHost(hostname) {
  * });
  * ```
  */
+/**
+ * File utility reads (`POST /file/read`).
+ */
 class FileService {
     api = inject(ApiClient);
     /**
@@ -4085,6 +4141,9 @@ const PRODUCT_CACHE_TTL_MS = 5 * 60_000;
  * products.readById(6280).subscribe((res) => console.log(res.data?.name));
  * ```
  */
+/**
+ * Product utility reads (`GET /product/read/{id?}`).
+ */
 class ProductService {
     api = inject(ApiClient);
     read(id = null, params) {
@@ -4223,6 +4282,9 @@ const SDK_FILTER_OPTIONS_SOURCES = new Set([
  * });
  * ```
  */
+/**
+ * Resolves filter drawer select options from built-in SDK catalog services.
+ */
 class FilterOptionsResolver {
     warehouses = inject(WarehouseService);
     shipmentMethods = inject(ShipmentMethodService);
@@ -4342,6 +4404,9 @@ const OVERLAY_ROUTE_CONFIGS = new InjectionToken('AFRICANIES_OVERLAY_ROUTE_CONFI
  * Modal/drawer implementations live in `@africanies/africanies-ui` and are injected through
  * {@link MODAL_SERVICE} / {@link DRAWER_SERVICE} to avoid a circular dependency.
  */
+/**
+ * Keeps query-param state in sync with modal/drawer overlays.
+ */
 class RouteOverlayService {
     route = inject(ActivatedRoute);
     router = inject(Router);