@africanies/angular-web-sdk 0.1.5 → 0.1.7

package/.nx/cache/5741611231803799383/dist/libs/africanies-ui/package.json

@@ -1,36 +0,0 @@
-{
-  "name": "@africanies/africanies-ui",
-  "version": "0.0.2",
-  "peerDependencies": {
-    "@angular/common": "^22.0.0",
-    "@angular/core": "^22.0.0",
-    "@angular/cdk": "^22.0.0",
-    "@angular/forms": "^22.0.0",
-    "@angular/router": "^22.0.0",
-    "rxjs": "^7.8.0",
-    "@africanies/africanies-models": "^0.0.2",
-    "@africanies/africanies-icons": "^0.0.1",
-    "@africanies/africanies-core": "^0.0.2",
-    "@africanies/africanies-theme": "^0.0.1"
-  },
-  "sideEffects": false,
-  "publishConfig": {
-    "registry": "https://npm.pkg.github.com",
-    "access": "restricted"
-  },
-  "module": "fesm2022/africanies-africanies-ui.mjs",
-  "typings": "types/africanies-africanies-ui.d.ts",
-  "exports": {
-    "./package.json": {
-      "default": "./package.json"
-    },
-    ".": {
-      "types": "./types/africanies-africanies-ui.d.ts",
-      "default": "./fesm2022/africanies-africanies-ui.mjs"
-    }
-  },
-  "type": "module",
-  "dependencies": {
-    "tslib": "^2.3.0"
-  }
-}

package/.nx/cache/6372470950255467653/dist/libs/africanies-models/README.md

@@ -1,60 +0,0 @@
-# @africanies/africanies-models
-
-Shared TypeScript **domain models** for the AFRICANIES Web SDK — API envelopes,
-utility payloads (countries, shipment methods), shipping/mode config, filters,
-and async UI snapshots. Types only: no Angular runtime, so apps and tooling can
-import them safely.
-
-## Naming
-
-Domain interfaces use a `*Model` suffix (`CountryModel`, `ApiResponseModel`,
-`ModeConfigDataModel`, `FilterStateModel`, …). Literal unions and small helper
-types (e.g. `ShippingMode`, `ResourceId`, `FilterFieldType`) stay without the
-suffix.
-
-## Domains
-
-- **api** — `ApiResponseModel`, `PaginationMetaModel`, `PaginationQueryParamsModel`, `ResourceId`, `ApiJsonValue`
-- **country** — `CountryModel`, `CountryStateModel` for public country utility reads
-- **service** — `ServiceModel` for `GET /public/service/read` (App Settings catalog)
-- **document** — `DocumentModel` for `GET /public/document/read` (by-id preview on nested `file_ref`)
-- **plan** — `PlanModel`, `PlanPackageModel` for `GET /public/plan/read`
-- **currency** — `CurrencyModel`, `CurrencyPaymentMethodModel` for `/currency/read`; `CurrencyCreateRequestModel` / `CurrencyUpdateRequestModel` / `CurrencyDeleteRequestModel` for App Settings writes
-- **payment-method** — `PaymentMethodModel`, `PaymentMethodCurrencyModel` for `/payment_method/read`; `PaymentMethodUpdateRequestModel` for App Settings active toggle (`PUT /payment_method/update`). No create/delete models.
-- **shipment-method** — `ShipmentMethodModel`, zone link/page models for carriers
-- **warehouse** — `WarehouseModel`, `WarehouseStateModel` (nested `CountryModel`)
-- **zone** — `ZoneModel` for `/zone/read/records` utility reads
-- **auth** — `ForgotPasswordRequestModel` for email-only `POST /auth/forgot/password`
-- **user** — `UserModel` (+ nested business account / plan / subscription) for bare `GET /user` (auth); `ChangePasswordRequestModel` for first-login `POST /user/change/password`
-- **notification** — `NotificationModel`, `NotificationPayloadModel`, inbox helpers for `GET /user/notifications/read/{id?}`
-- **filters** — `ModuleFilterConfigModel`, `FilterStateModel`, `FilterTransport`, `toFilterParams` / `fromFilterParams` / `hasFilterParams`
-- **mode** — `ModeConfigDataModel`, region/currency/unit config for STN and SFN
-- **shipping** — `ShippingMode` (`'stn' | 'sfn'`)
-- **async** — `AsyncQueryStateModel` for UI async wrappers
-
-API wire models use **snake_case** field names to match server payloads. Filter/async
-UI models stay camelCase.
-
-## Usage
-
-```ts
-import type {
-  ApiResponseModel,
-  CountryModel,
-  CurrencyModel,
-  DocumentModel,
-  ModeConfigDataModel,
-  PaymentMethodModel,
-  PlanModel,
-  ServiceModel,
-  ShipmentMethodModel,
-  ShippingMode,
-  WarehouseModel,
-  ZoneModel,
-  UserModel,
-} from '@africanies/africanies-models';
-```
-
-## Tests
-
-Run `nx test africanies-models` (type-only library; specs optional).

package/.nx/cache/6372470950255467653/dist/libs/africanies-models/fesm2022/africanies-africanies-models.mjs

@@ -1,599 +0,0 @@
-/**
- * Allowed page sizes for list pagination (`size` query param).
- */
-const PAGINATION_PAGE_SIZES = [5, 15, 30];
-/** Default `size` on paginated resource GETs. */
-const DEFAULT_PAGE_SIZE = 15;
-/** Inbox / notification list page size. */
-const NOTIFICATION_PAGE_SIZE = 30;
-
-/**
- * Hardcoded inbound delivery vendor slugs — same values as legacy portal forms (no API).
- */
-const DELIVERY_VENDORS = [
-    { id: 'amazon', name: 'Amazon' },
-    { id: 'dhl', name: 'DHL' },
-    { id: 'fedex', name: 'FedEx' },
-    { id: 'usps', name: 'USPS' },
-    { id: 'ups', name: 'UPS' },
-    { id: 'others', name: 'Others' },
-];
-/** Export box editor only — not used on inbound receive/edit forms. */
-const EXPORT_DELIVERY_VENDORS = [
-    ...DELIVERY_VENDORS,
-    { id: 'walk-in', name: 'Walk-In' },
-];
-/** @deprecated Prefer {@link DELIVERY_VENDORS}. */
-const DELIVERY_VENDOR_OPTIONS = DELIVERY_VENDORS.map((row) => ({
-    value: row.id,
-    label: row.name,
-}));
-/** @deprecated Prefer {@link EXPORT_DELIVERY_VENDORS}. */
-const BOX_DELIVERY_VENDORS = EXPORT_DELIVERY_VENDORS;
-const VENDOR_LABELS = Object.fromEntries(DELIVERY_VENDORS.map((row) => [row.id, row.name]));
-/**
- *
- * @param value
- */
-function normalizeDeliveryVendor(value) {
-    return value.trim().toLowerCase();
-}
-/**
- *
- * @param value
- */
-function isKnownDeliveryVendor(value) {
-    const normalized = normalizeDeliveryVendor(value ?? '');
-    if (!normalized) {
-        return false;
-    }
-    return DELIVERY_VENDORS.some((vendor) => vendor.id === normalized);
-}
-/**
- * Lowercase known ids; keep raw string for legacy/custom stored values.
- * @param value
- */
-function normalizeDeliveryVendorForForm(value) {
-    const raw = value?.trim() ?? '';
-    if (!raw) {
-        return '';
-    }
-    const normalized = normalizeDeliveryVendor(raw);
-    if (isKnownDeliveryVendor(normalized)) {
-        return normalized;
-    }
-    return raw;
-}
-/**
- *
- * @param value
- */
-function deliveryVendorLabel(value) {
-    const normalized = normalizeDeliveryVendor(value);
-    if (!normalized || normalized === 'others') {
-        return '';
-    }
-    return VENDOR_LABELS[normalized] ?? value.trim();
-}
-
-/**
- * Schema-driven list filter contracts for AFRICANIES modules.
- *
- * Modules declare a {@link ModuleFilterConfigModel}; the UI drawer renders from
- * it and {@link toFilterParams} / {@link fromFilterParams} speak to the API.
- */
-/**
- * Backend wire format for filter query serialization.
- *
- * Use {@link resolveFilterTransport} when reading `config.transport` — omit the
- * property on {@link ModuleFilterConfigModel} to default to legacy-parallel.
- */
-const FilterTransport = {
-    /** Laravel-style `filterColumn` + `filterValue` CSV pairs (default). */
-    LegacyParallel: 'legacy-parallel',
-    /** Each {@link FilterFieldModel.key} is its own query param. */
-    Named: 'named',
-};
-/** Default when {@link ModuleFilterConfigModel.transport} is omitted. */
-const DEFAULT_FILTER_TRANSPORT = FilterTransport.LegacyParallel;
-/**
- * Resolved transport for a module config (defaults to {@link DEFAULT_FILTER_TRANSPORT}).
- * @param config
- */
-function resolveFilterTransport(config) {
-    return config.transport ?? DEFAULT_FILTER_TRANSPORT;
-}
-
-/**
- * Track shipments — payment / shipment status chips + tracking number.
- * Transport: legacy `filterColumn` / `filterValue`.
- */
-const trackShipmentsFilterConfig = {
-    id: 'track-shipments',
-    route: ['portal', 'shipment', 'track-shipments'],
-    transport: 'legacy-parallel',
-    pagination: { pageParam: 'page', sizeParam: 'size' },
-    search: {
-        param: 'search',
-        label: 'Shipment ID',
-        placeholder: 'Search',
-    },
-    date: {
-        rangeParams: { from: 'from', to: 'to' },
-        fieldParam: 'date',
-        fields: [{ value: 'created_at', label: 'Date Created' }],
-    },
-    sort: {
-        param: 'order',
-        options: [
-            { value: 'asc', label: 'Ascending' },
-            { value: 'desc', label: 'Descending' },
-        ],
-    },
-    fields: [
-        {
-            key: 'payment_status',
-            label: 'Payment Status',
-            type: 'enum',
-            exclusive: true,
-            options: [
-                { value: 'paid', label: 'Paid', color: '#25945c' },
-                { value: 'unpaid', label: 'Unpaid', color: '#f48220' },
-            ],
-        },
-        {
-            key: 'shipment_status',
-            label: 'Shipment Status',
-            type: 'enum',
-            exclusive: true,
-            options: [
-                { value: 'pending', label: 'Pending', color: '#DBB316' },
-                { value: 'in-process', label: 'In Process', color: '#3B82F6' },
-                { value: 'completed', label: 'Completed', color: '#25945c' },
-            ],
-        },
-        {
-            key: 'tracking_number',
-            label: 'Tracking Number',
-            type: 'text',
-            placeholder: 'Search',
-        },
-    ],
-};
-/**
- * Update shipments — richest legacy filter set (enums + entity selects + booleans).
- */
-const updateShipmentsFilterConfig = {
-    id: 'update-shipments',
-    route: ['portal', 'shipment', 'update-shipments'],
-    transport: 'legacy-parallel',
-    pagination: { pageParam: 'page', sizeParam: 'size' },
-    search: {
-        param: 'search',
-        label: 'Shipment ID',
-        placeholder: 'Search',
-    },
-    date: {
-        rangeParams: { from: 'from', to: 'to' },
-        fieldParam: 'date',
-        fields: [
-            { value: 'created_at', label: 'Date Created' },
-            { value: 'paid_at', label: 'Date of Payment' },
-            { value: 'packaged_at', label: 'Date Packaged' },
-            { value: 'shipment_processed_at', label: 'Date Processed' },
-        ],
-    },
-    sort: {
-        param: 'order',
-        options: [
-            { value: 'asc', label: 'Ascending' },
-            { value: 'desc', label: 'Descending' },
-        ],
-    },
-    fields: [
-        {
-            key: 'payment_status',
-            label: 'Payment Status',
-            type: 'enum',
-            exclusive: true,
-            options: [
-                { value: 'paid', label: 'Paid', color: '#25945c' },
-                { value: 'unpaid', label: 'Unpaid', color: '#f48220' },
-            ],
-        },
-        {
-            key: 'shipment_status',
-            label: 'Shipment Status',
-            type: 'enum',
-            exclusive: true,
-            options: [
-                { value: 'pending', label: 'Pending', color: '#DBB316' },
-                { value: 'in-process', label: 'In Process', color: '#3B82F6' },
-                { value: 'completed', label: 'Completed', color: '#25945c' },
-            ],
-        },
-        {
-            key: 'type',
-            label: 'Shipment Type',
-            type: 'enum',
-            exclusive: true,
-            options: [
-                { value: 'shipment', label: 'Shipment', color: '#3B82F6' },
-                { value: 'etw_shipment', label: 'ETW Shipment', color: '#8B5CF6' },
-            ],
-        },
-        {
-            key: 'shipment_method_id',
-            label: 'Shipment Carrier',
-            type: 'select',
-            optionsSource: 'shipmentMethods',
-            placeholder: 'Shipment Methods',
-        },
-        {
-            key: 'type_of_user',
-            label: 'User Type',
-            type: 'select',
-            optionsSource: 'static',
-            options: [
-                { value: 'individual', label: 'Individual' },
-                { value: 'business', label: 'Business' },
-            ],
-            placeholder: 'User Type',
-        },
-        {
-            key: 'warehouse_id',
-            label: 'Warehouse',
-            type: 'select',
-            optionsSource: 'warehouses',
-            placeholder: 'Warehouse',
-        },
-        {
-            key: 'shipment_manifest_id',
-            label: 'Shipment Manifest',
-            type: 'select',
-            optionsSource: 'shipmentManifests',
-            placeholder: 'Shipment Manifest',
-        },
-        {
-            key: 'api_request',
-            label: 'API Request',
-            type: 'boolean',
-            options: [
-                { value: '1', label: 'Yes' },
-                { value: '0', label: 'No' },
-            ],
-        },
-        {
-            key: 'is_insured',
-            label: 'Insured',
-            type: 'boolean',
-            options: [
-                { value: '1', label: 'Yes' },
-                { value: '0', label: 'No' },
-            ],
-        },
-    ],
-};
-/**
- * Users (customer list) — performed_action chips + user type select.
- */
-const usersFilterConfig = {
-    id: 'users',
-    route: ['portal', 'customer', 'all'],
-    transport: 'legacy-parallel',
-    pagination: { pageParam: 'page', sizeParam: 'size' },
-    search: {
-        param: 'search',
-        label: 'Search',
-        placeholder: 'Search',
-    },
-    date: {
-        rangeParams: { from: 'from', to: 'to' },
-        fieldParam: 'date',
-        fields: [{ value: 'created_at', label: 'Date Created' }],
-    },
-    sort: {
-        param: 'order',
-        options: [
-            { value: 'asc', label: 'Ascending' },
-            { value: 'desc', label: 'Descending' },
-        ],
-    },
-    fields: [
-        {
-            key: 'performed_action',
-            label: 'Performed Action',
-            type: 'enum',
-            exclusive: true,
-            options: [
-                { value: 'pending', label: 'Pending', color: '#DBB316' },
-                { value: 'approved', label: 'Approved', color: '#25945c' },
-                { value: 'rejected', label: 'Rejected', color: '#FF001C' },
-            ],
-        },
-        {
-            key: 'type',
-            label: 'User Type',
-            type: 'select',
-            optionsSource: 'static',
-            options: [
-                { value: 'individual', label: 'Individual' },
-                { value: 'business', label: 'Business' },
-            ],
-            placeholder: 'User Type',
-        },
-    ],
-};
-/**
- * Named-transport example — newer endpoints with direct query keys.
- */
-const shipmentTrackingItemFilterConfig = {
-    id: 'shipment-tracking-item-list',
-    transport: FilterTransport.Named,
-    pagination: { pageParam: 'page', sizeParam: 'size' },
-    search: {
-        param: 'search',
-        label: 'Search',
-        placeholder: 'Search',
-    },
-    date: {
-        rangeParams: { from: 'from', to: 'to' },
-        fieldParam: 'date',
-        fields: [{ value: 'created_at', label: 'Date Created' }],
-    },
-    fields: [
-        {
-            key: 'claim_status',
-            label: 'Claim Status',
-            type: 'enum',
-            exclusive: true,
-            options: [
-                { value: 'open', label: 'Open', color: '#25945c' },
-                { value: 'closed', label: 'Closed', color: '#667185' },
-                { value: 'pending', label: 'Pending', color: '#DBB316' },
-            ],
-        },
-    ],
-};
-/** Seed registry — look up config by module id. */
-const FILTER_CONFIGS = {
-    'track-shipments': trackShipmentsFilterConfig,
-    'update-shipments': updateShipmentsFilterConfig,
-    users: usersFilterConfig,
-    'shipment-tracking-item-list': shipmentTrackingItemFilterConfig,
-};
-
-/**
- * Empty filter state — safe default before hydrate / after reset.
- *
- * Sort defaults to descending (`desc`) so list screens match the usual
- * “newest first” API contract without an explicit Apply.
- *
- * @returns A state with an empty `values` map and `order: 'desc'`.
- */
-function emptyFilterState() {
-    return { values: {}, order: 'desc' };
-}
-/**
- * Clone state so drawer edits do not mutate the host until Apply.
- *
- * @param state - Current filter state (or undefined).
- * @returns A shallow copy safe to mutate in the drawer.
- */
-function cloneFilterState(state) {
-    if (state == null) {
-        return emptyFilterState();
-    }
-    return {
-        search: state.search,
-        from: state.from,
-        to: state.to,
-        date: state.date,
-        order: state.order,
-        page: state.page,
-        size: state.size,
-        values: { ...state.values },
-    };
-}
-/**
- * Serialize {@link FilterStateModel} for URL query strings and list API calls.
- *
- * - `legacy-parallel`: emits `filterColumn` / `filterValue` as aligned CSV.
- * - `named`: each selected field key is its own query param.
- *
- * Empty strings and undefined field values are omitted.
- *
- * @param state - Current filter map state.
- * @param config - Module schema (controls transport + shared params).
- * @returns Flat query / API bag ready for HttpParams or the router.
- */
-function toFilterParams(state, config) {
-    const params = {};
-    if (state.search != null && state.search !== '') {
-        params[config.search?.param ?? 'search'] = state.search;
-    }
-    if (state.from) {
-        params[config.date?.rangeParams.from ?? 'from'] = state.from;
-    }
-    if (state.to) {
-        params[config.date?.rangeParams.to ?? 'to'] = state.to;
-    }
-    if (state.date) {
-        params[config.date?.fieldParam ?? 'date'] = state.date;
-    }
-    if (state.order) {
-        params[config.sort?.param ?? 'order'] = state.order;
-    }
-    if (state.page != null) {
-        params[config.pagination?.pageParam ?? 'page'] = state.page;
-    }
-    if (state.size != null) {
-        params[config.pagination?.sizeParam ?? 'size'] = state.size;
-    }
-    if (resolveFilterTransport(config) === FilterTransport.Named) {
-        for (const field of config.fields) {
-            const v = state.values[field.key];
-            if (v != null && v !== '') {
-                params[field.key] = v;
-            }
-        }
-        return params;
-    }
-    // legacy-parallel — only fields that have a value
-    const columns = [];
-    const values = [];
-    for (const field of config.fields) {
-        const v = state.values[field.key];
-        if (v === undefined || v === '') {
-            continue;
-        }
-        columns.push(field.key);
-        values.push(String(v));
-    }
-    if (columns.length) {
-        params['filterColumn'] = columns.join(',');
-        params['filterValue'] = values.join(',');
-    }
-    return params;
-}
-/**
- * Hydrate {@link FilterStateModel} from a flat query / API bag.
- *
- * For `legacy-parallel`, zips `filterColumn` + `filterValue` CSV pairs.
- * Unknown column keys are still restored into `values` so round-trips survive
- * config drift.
- *
- * @param params - Router query params or API query object (stringish values).
- * @param config - Module schema.
- * @returns Hydrated {@link FilterStateModel}.
- */
-function fromFilterParams(params, config) {
-    const state = emptyFilterState();
-    const read = (key) => queryBagValue(params[key]);
-    state.search = read(config.search?.param ?? 'search');
-    state.from = read(config.date?.rangeParams.from ?? 'from');
-    state.to = read(config.date?.rangeParams.to ?? 'to');
-    state.date = read(config.date?.fieldParam ?? 'date');
-    state.order = read(config.sort?.param ?? 'order');
-    const pageRaw = read(config.pagination?.pageParam ?? 'page');
-    const sizeRaw = read(config.pagination?.sizeParam ?? 'size');
-    if (pageRaw != null) {
-        const n = Number(pageRaw);
-        if (!Number.isNaN(n)) {
-            state.page = n;
-        }
-    }
-    if (sizeRaw != null) {
-        const n = Number(sizeRaw);
-        if (!Number.isNaN(n)) {
-            state.size = n;
-        }
-    }
-    if (resolveFilterTransport(config) === FilterTransport.Named) {
-        for (const field of config.fields) {
-            const v = read(field.key);
-            if (v != null) {
-                state.values[field.key] = v;
-            }
-        }
-        return state;
-    }
-    const columns = (read('filterColumn') ?? '')
-        .split(',')
-        .map((s) => s.trim())
-        .filter(Boolean);
-    const values = (read('filterValue') ?? '')
-        .split(',')
-        .map((s) => s.trim());
-    columns.forEach((key, i) => {
-        const v = values[i];
-        if (v != null && v !== '') {
-            state.values[key] = v;
-        }
-    });
-    return state;
-}
-/**
- * Query keys this config reads and writes (`search`, `page`, `size`, field
- * keys or `filterColumn` / `filterValue`, etc.).
- *
- * @param config - Module schema.
- * @returns Deduped list of query param names.
- */
-function filterQueryKeys(config) {
-    const keys = [
-        config.search?.param ?? 'search',
-        config.date?.rangeParams.from ?? 'from',
-        config.date?.rangeParams.to ?? 'to',
-        config.date?.fieldParam ?? 'date',
-        config.sort?.param ?? 'order',
-        config.pagination?.pageParam ?? 'page',
-        config.pagination?.sizeParam ?? 'size',
-    ];
-    if (resolveFilterTransport(config) === FilterTransport.Named) {
-        keys.push(...config.fields.map((field) => field.key));
-    }
-    else {
-        keys.push('filterColumn', 'filterValue');
-    }
-    return [...new Set(keys)];
-}
-/**
- * True when the bag contains any list-filter / pagination key this config
- * understands. Used to decide whether to hydrate from the URL.
- *
- * @param params - Router query params or API query object.
- * @param config - Module schema.
- * @returns Whether at least one relevant non-empty param is present.
- */
-function hasFilterParams(params, config) {
-    return filterQueryKeys(config).some((key) => queryBagValue(params[key]) != null);
-}
-/**
- * @param raw - One query-bag value.
- * @returns First non-empty string, or undefined.
- */
-function queryBagValue(raw) {
-    if (raw == null) {
-        return undefined;
-    }
-    if (Array.isArray(raw)) {
-        return raw[0] != null && String(raw[0]) !== '' ? String(raw[0]) : undefined;
-    }
-    const value = String(raw);
-    return value === '' ? undefined : value;
-}
-/**
- * Drop one field value (column deselected / section clear).
- *
- * @param state - Mutable or immutable state to copy.
- * @param key - {@link FilterFieldModel.key} to clear.
- * @returns Cloned state without that field value.
- */
-function clearFilterField(state, key) {
-    const next = cloneFilterState(state);
-    delete next.values[key];
-    return next;
-}
-/**
- * Reset to empty values while optionally keeping pagination.
- *
- * @param keepPagination - When true, preserve `page` / `size`.
- * @param state - Optional prior state for pagination retention.
- * @returns Empty filter state, optionally retaining pagination.
- */
-function resetFilterState(keepPagination = false, state) {
-    const next = emptyFilterState();
-    if (keepPagination && state) {
-        next.page = state.page;
-        next.size = state.size;
-    }
-    return next;
-}
-
-/**
- * Generated bundle index. Do not edit.
- */
-
-export { BOX_DELIVERY_VENDORS, DEFAULT_FILTER_TRANSPORT, DEFAULT_PAGE_SIZE, DELIVERY_VENDORS, DELIVERY_VENDOR_OPTIONS, EXPORT_DELIVERY_VENDORS, FILTER_CONFIGS, FilterTransport, NOTIFICATION_PAGE_SIZE, PAGINATION_PAGE_SIZES, clearFilterField, cloneFilterState, deliveryVendorLabel, emptyFilterState, filterQueryKeys, fromFilterParams, hasFilterParams, isKnownDeliveryVendor, normalizeDeliveryVendor, normalizeDeliveryVendorForForm, resetFilterState, resolveFilterTransport, shipmentTrackingItemFilterConfig, toFilterParams, trackShipmentsFilterConfig, updateShipmentsFilterConfig, usersFilterConfig };
-//# sourceMappingURL=africanies-africanies-models.mjs.map