@africanies/angular-web-sdk 0.1.4 → 0.1.6

package/.nx/cache/3064561615116090625/dist/libs/africanies-storage/types/africanies-africanies-storage.d.ts

@@ -1,210 +0,0 @@
-import * as i0 from '@angular/core';
-import { EnvironmentProviders, InjectionToken } from '@angular/core';
-
-/**
- * Browser key-value persistence abstraction used by theme, shipping mode,
- * and auth token flows.
- *
- * Implementations JSON-serialize values so callers work with typed objects
- * rather than raw strings. Prefer injecting via {@link STORAGE_TOKEN} so
- * tests can swap in an in-memory fake.
- */
-declare abstract class StorageService {
-    /**
-     * Reads and deserializes a previously stored value.
-     *
-     * @typeParam T - Expected value type after JSON parse.
-     * @param key - Storage key.
-     * @returns The parsed value, or `null` when the key is missing or empty.
-     * @throws {DOMException} When storage is inaccessible (e.g. private browsing
-     *   with storage disabled) or when reading fails for security reasons.
-     * @throws {SyntaxError} When stored content is not valid JSON.
-     */
-    abstract get<T>(key: string): T | null;
-    /**
-     * Serializes and writes a value under `key`.
-     *
-     * @typeParam T - Value type to persist (must be JSON-serializable).
-     * @param key - Storage key.
-     * @param value - Value to serialize with `JSON.stringify`.
-     * @throws {DOMException} `QuotaExceededError` when the storage quota is
-     *   exceeded, or when storage is disabled (private browsing).
-     * @throws {TypeError} When `value` cannot be serialized to JSON
-     *   (e.g. circular structures).
-     */
-    abstract set<T>(key: string, value: T): void;
-    /**
-     * Removes a single key if present.
-     *
-     * @param key - Storage key to delete.
-     * @throws {DOMException} When storage is inaccessible.
-     */
-    abstract remove(key: string): void;
-    /**
-     * Removes all keys in this storage partition.
-     *
-     * @throws {DOMException} When storage is inaccessible.
-     */
-    abstract clear(): void;
-}
-
-/**
- * `localStorage`-backed {@link StorageService}.
- *
- * Default root implementation behind {@link STORAGE_TOKEN}. Values survive
- * browser restarts for the origin.
- *
- * @example
- * ```ts
- * const storage = inject(LocalStorageService);
- * try {
- *   storage.set('user', { id: 1 });
- * } catch (err) {
- *   // QuotaExceededError or private-browsing denial
- *   console.warn('persist failed', err);
- * }
- * ```
- */
-declare class LocalStorageService extends StorageService {
-    /**
-     * @inheritdoc
-     * @throws {DOMException} Quota exceeded or storage disabled in private browsing.
-     * @throws {SyntaxError} Stored value is not valid JSON.
-     */
-    get<T>(key: string): T | null;
-    /**
-     * @inheritdoc
-     * @throws {DOMException} Quota exceeded or storage disabled in private browsing.
-     * @throws {TypeError} Value is not JSON-serializable.
-     */
-    set<T>(key: string, value: T): void;
-    /**
-     * @inheritdoc
-     * @throws {DOMException} When storage is inaccessible.
-     */
-    remove(key: string): void;
-    /**
-     * @inheritdoc
-     * @throws {DOMException} When storage is inaccessible.
-     */
-    clear(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LocalStorageService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<LocalStorageService>;
-}
-
-/**
- * Explicitly binds {@link STORAGE_TOKEN} to {@link LocalStorageService}.
- *
- * Redundant with the token's root factory, but useful when an app previously
- * registered session storage and needs to switch back, or for clarity in
- * `app.config.ts`.
- *
- * @returns Environment providers wiring `STORAGE_TOKEN` → localStorage.
- *
- * @example
- * ```ts
- * bootstrapApplication(App, {
- *   providers: [provideLocalStorage()],
- * });
- * ```
- */
-declare function provideLocalStorage(): EnvironmentProviders;
-/**
- * Binds {@link STORAGE_TOKEN} to {@link SessionStorageService}.
- *
- * Prefer this when SDK consumers (theme, auth token) should persist only
- * for the current tab rather than across sessions.
- *
- * Shipping mode always uses {@link SessionStorageService} directly and is
- * unaffected by this override.
- *
- * @returns Environment providers wiring `STORAGE_TOKEN` → sessionStorage.
- *
- * @example
- * ```ts
- * bootstrapApplication(App, {
- *   providers: [provideSessionStorage()],
- * });
- * ```
- */
-declare function provideSessionStorage(): EnvironmentProviders;
-
-/**
- * `sessionStorage`-backed {@link StorageService}.
- *
- * Scope is limited to the current tab/window lifetime — use when values must
- * not outlive the session (e.g. ephemeral UI flags). Register via
- * {@link provideSessionStorage} to bind {@link STORAGE_TOKEN} to this class.
- *
- * @example
- * ```ts
- * // app.config.ts
- * providers: [provideSessionStorage()]
- *
- * // elsewhere
- * const storage = inject(STORAGE_TOKEN);
- * try {
- *   storage.set('wizard.step', 2);
- * } catch (err) {
- *   // QuotaExceededError or private-browsing denial
- * }
- * ```
- */
-declare class SessionStorageService extends StorageService {
-    /**
-     * @inheritdoc
-     * @throws {DOMException} Quota exceeded or storage disabled in private browsing.
-     * @throws {SyntaxError} Stored value is not valid JSON.
-     */
-    get<T>(key: string): T | null;
-    /**
-     * @inheritdoc
-     * @throws {DOMException} Quota exceeded or storage disabled in private browsing.
-     * @throws {TypeError} Value is not JSON-serializable.
-     */
-    set<T>(key: string, value: T): void;
-    /**
-     * @inheritdoc
-     * @throws {DOMException} When storage is inaccessible.
-     */
-    remove(key: string): void;
-    /**
-     * @inheritdoc
-     * @throws {DOMException} When storage is inaccessible.
-     */
-    clear(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SessionStorageService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<SessionStorageService>;
-}
-
-/**
- * Well-known local/session storage keys used across AFRICANIES SDK packages.
- *
- * Centralizing these avoids typos between theme, shipping-mode, and
- * auth persistence layers that all go through {@link StorageService}.
- */
-/** Persisted UI theme preference (`'light' | 'dark'` or equivalent). */
-declare const AFRICANIES_THEME_KEY = "africanies.theme";
-/** Tab-scoped shipping mode (`'stn' | 'sfn'`) — {@link SessionStorageService}. */
-declare const AFRICANIES_SHIPPING_MODE_KEY = "africanies.shippingMode";
-/** Cached public mode-config payload (mapped {@link ModeConfigDataModel}). */
-declare const AFRICANIES_MODE_CONFIG_KEY = "africanies.modeConfig";
-/** Persisted bearer access token for authenticated SDK HTTP calls. */
-declare const AFRICANIES_ACCESS_TOKEN_KEY = "africanies.accessToken";
-
-/**
- * DI token for the active {@link StorageService} implementation.
- *
- * Defaults to {@link LocalStorageService} via `providedIn: 'root'`. Override
- * in tests or at bootstrap with {@link provideSessionStorage} /
- * {@link provideLocalStorage}.
- *
- * @example
- * ```ts
- * const storage = inject(STORAGE_TOKEN);
- * storage.set('prefs', { dense: true });
- * ```
- */
-declare const STORAGE_TOKEN: InjectionToken<StorageService>;
-
-export { AFRICANIES_ACCESS_TOKEN_KEY, AFRICANIES_MODE_CONFIG_KEY, AFRICANIES_SHIPPING_MODE_KEY, AFRICANIES_THEME_KEY, LocalStorageService, STORAGE_TOKEN, SessionStorageService, StorageService, provideLocalStorage, provideSessionStorage };

package/.nx/cache/4011892767661954819/dist/libs/africanies-core/README.md

@@ -1,85 +0,0 @@
-# @africanies/africanies-core
-
-API and app-wiring layer for the AFRICANIES Web SDK: SDK config, HTTP client,
-shipping mode, mode-region metadata, TanStack Query default helpers, and
-route-driven overlay registration.
-
-## Install peers
-
-```bash
-# Published from GitHub Packages (@africanies scope)
-npm install @africanies/africanies-core @africanies/africanies-models @africanies/africanies-storage
-```
-
-Peer dependencies: `@angular/common`, `@angular/core`, `@angular/router`,
-`rxjs`, `@africanies/africanies-models`, `@africanies/africanies-storage`.
-
-## Quick start
-
-```ts
-import { ApplicationConfig } from '@angular/core';
-import {
-  provideAfricaniesSdk,
-  provideAfricaniesHttpClient,
-  provideOverlayRoutes,
-  createAfricaniesQueryClientDefaults,
-} from '@africanies/africanies-core';
-
-export const appConfig: ApplicationConfig = {
-  providers: [
-    provideAfricaniesSdk({ baseUrl: 'https://api.example.com', timeout: 30_000 }),
-    provideAfricaniesHttpClient(),
-    // optional extras:
-    // provideAfricaniesHttpClient({ interceptors: [correlationInterceptor] }),
-    // optional: provideOverlayRoutes([{ paramKey: 'modal', routes: { ... } }]),
-  ],
-};
-
-// TanStack Query (app dependency — pin exact experimental version):
-// new QueryClient({ defaultOptions: createAfricaniesQueryClientDefaults() })
-```
-
-## Modules
-
-| Area | Exports |
-|------|---------|
-| Config | `provideAfricaniesSdk`, `AFRICANIES_SDK_CONFIG`, `httpToasts` (`'off'` \| `'errors'` \| `'all'`) |
-| Auth | `AuthService` (`forgot`), `isValidEmail`, `AuthTokenService` (`set` / `clear` / `get`) |
-| Shipping | `ShippingModeService` (tab-scoped via `sessionStorage`), `shipmentModeInterceptor`, per-request `ApiRequestOptions.shippingMode` / `withShippingMode` |
-| HTTP | `provideAfricaniesHttpClient`, `ApiClient` (auto-tags `withToast` from config / `ApiRequestOptions.toast`; optional `shippingMode` per call; HTTP failures → `Error` with formatted `.message`), `withToast`, `withShippingMode`, `httpToastInterceptor`, `normalize` (lifts Laravel validation bags into `errors` + joined `message`), `formatApiErrorMessage` (used internally; rare for hosts), `fieldErrorsMap`, `authInterceptor` |
-| Query | `createAfricaniesQueryClientDefaults`, `provideAfricaniesQueryDefaults`, `listFetchKind` (body loader on first load / STN↔SFN; keep rows on focus / Refresh / pager) |
-| Mode | `ModeConfigService`, `provideModeConfig`, `MODE_CONFIG_PATH` |
-| Country | `CountryService`, `countryFlagUrl` / `mapCountrySelectOptions` (flagcdn.com), `COUNTRY_READ_PATH`, mappers |
-| Service | `ServiceService` (`readPage` / `readAll` / `readById`), `SERVICE_READ_PATH` (`/public/service/read`), mappers |
-| Document | `DocumentService` (`readPage` / `readAll` / `readById`), `DOCUMENT_READ_PATH` (`/public/document/read`) — preview via `file_ref` on by-id |
-| Plan | `PlanService` (`readPage` / `readAll` / `readById`), `PLAN_READ_PATH` (`/public/plan/read`), mappers |
-| Currency | `CurrencyService` (`readPage` / `readAll` / `readById`, `create` / `update` / `remove`), `CURRENCY_*_PATH`, mappers |
-| Payment method | `PaymentMethodService` (`readPage` / `readAll` / `readById`, `update`), `PAYMENT_METHOD_READ_PATH` / `PAYMENT_METHOD_UPDATE_PATH`, mappers |
-| Shipment method | `ShipmentMethodService` (`readPage` / `readAll` / `readById`), `SHIPMENT_METHOD_READ_PATH`, mappers |
-| Warehouse | `WarehouseService` (`readPage` / `readAll` / `readById`), `WAREHOUSE_READ_PATH`, mappers |
-| Zone | `ZoneService` (`readPage` / `readAll` / `readById`), `ZONE_READ_PATH`, mappers |
-| Product | `ProductService` (`readPage` / `readAll` / `readById`), `PRODUCT_READ_PATH`, mappers |
-| User | `UserService` (`me`, `changePassword`, `logoutFromAllSessions`), `USER_PATH`, `mapUser` (bare `/user` body; needs `AuthTokenService.set`) |
-| Notification | `NotificationService` (`readPage` / `readAll` / `readOne`), `NOTIFICATION_READ_PATH`, `mapNotification` / `mapNotificationInboxItem` |
-| File | `FileService` (`read` / `readMultiple` → `POST /file/read`), `FILE_READ_PATH`, `mapFileRead` / `mapFileReadList` |
-| Overlay | `provideOverlayRoutes`, `RouteOverlayService`, `MODAL_SERVICE`, `DRAWER_SERVICE` |
-| Filters | `FilterOptionsResolver` (`resolveField` lazy in drawer), `mergeFilterOptionLists`, warehouse/method mappers |
-| Browser | `copyToClipboard`, `downloadCsv` / `csvCell` (UTF-8 CSV download) |
-
-List-style GETs follow `ResourceId`: `null` (paginated), `'all'` (full dump), `number` (single).
-
-| Filter `optionsSource` | SDK resolver |
-|------------------------|--------------|
-| `warehouses` | Lazy `FilterOptionsResolver.resolveField` → `WarehouseService.readAll()` |
-| `shipmentMethods` | Lazy `FilterOptionsResolver.resolveField` → `ShipmentMethodService.readAll()` |
-| `shipmentManifests` | Host `optionLists` (no built-in service yet) |
-
-`MODAL_SERVICE` / `DRAWER_SERVICE` are tokens only — implementations ship in
-`@africanies/africanies-ui` to avoid circular dependencies.
-
-## Build / test
-
-```bash
-npx nx build africanies-core
-npx nx test africanies-core
-```