@hosterai/types 0.0.23 → 0.0.24

package/README.md

@@ -58,6 +58,7 @@ DTOs define the shape of data that is exchanged between different parts of the s
 - `base-response.dto.ts`: A base structure for API responses.
 - `client-data.dto.ts`: Defines the data structure for a client.
 - `company-data.dto.ts`: Holds all the relevant data for a company.
+- `country.dto.ts`: Represents country metadata (name, ISO code, Europe flag).
 - `error-response.dto.ts`: Defines the structure for error responses.
 - `field.dto.ts`: Represents a generic field for forms or dynamic data.
 - `field-option.dto.ts`: Represents options for form fields (used for checkboxes, radioboxes, and selects).
@@ -113,6 +114,16 @@ Enums provide a set of named constants for common types, preventing errors with
 - `RolesEnum`: Defines user roles.
 - `SetupStatusEnum`: Defines the status of a setup process.
 
+#### Country Helpers
+
+- The canonical ISO-3166 list plus metadata resides in `enums/country.enum.ts` via:
+  - `CountryEnum` with alpha-2 codes.
+  - `EU_EEA_COUNTRIES` / `EUROZONE_COUNTRIES` sets for regional logic.
+  - `BASE_COUNTRY_DATA` and derived `COUNTRY_DATA`, including the `isEurope` flag.
+- Utility helpers in `helpers/country.helper.ts` expose:
+  - `getCountryData`, `getAllCountriesData`, `getEuropeanCountriesData`, `getEurozoneCountriesData`.
+- After editing the enum or country data, rerun `npm run build:schemas` (see **Generating JSON Schemas**) so the OpenAPI bundle reflects the latest list.
+
 ### Interfaces
 
 - `product/product.interface.ts`: Defines the contract for a product module.

package/dist/dtos/country.dto.d.ts

@@ -0,0 +1,6 @@
+import { CountryEnum } from '../enums/country.enum';
+export declare class CountryDto {
+    name: string;
+    code: CountryEnum;
+    isEurope?: boolean;
+}

package/dist/dtos/country.dto.js

@@ -0,0 +1,31 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CountryDto = void 0;
+const class_validator_1 = require("class-validator");
+const country_enum_1 = require("../enums/country.enum");
+class CountryDto {
+}
+exports.CountryDto = CountryDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], CountryDto.prototype, "name", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(country_enum_1.CountryEnum),
+    __metadata("design:type", String)
+], CountryDto.prototype, "code", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Boolean)
+], CountryDto.prototype, "isEurope", void 0);

package/dist/enums/country.enum.d.ts

@@ -1,5 +1,7 @@
+import { CountryDto } from "../dtos/country.dto";
 export declare enum CountryEnum {
     AFGHANISTAN = "AF",
+    ALAND_ISLANDS = "AX",
     ALBANIA = "AL",
     ALGERIA = "DZ",
     AMERICAN_SAMOA = "AS",
@@ -248,284 +250,11 @@ export declare enum CountryEnum {
     TONGA = "TO",
     TRINIDAD_AND_TOBAGO = "TT"
 }
-export declare const country_name: {
-    AF: string;
-    AX: string;
-    AL: string;
-    DZ: string;
-    AS: string;
-    AD: string;
-    AO: string;
-    AI: string;
-    AQ: string;
-    AG: string;
-    AR: string;
-    AM: string;
-    AW: string;
-    AU: string;
-    AT: string;
-    AZ: string;
-    BS: string;
-    BH: string;
-    BD: string;
-    BB: string;
-    BY: string;
-    BE: string;
-    BZ: string;
-    BJ: string;
-    BM: string;
-    BT: string;
-    BO: string;
-    BQ: string;
-    BA: string;
-    BW: string;
-    BV: string;
-    BR: string;
-    IO: string;
-    BN: string;
-    BG: string;
-    BF: string;
-    BI: string;
-    KH: string;
-    CM: string;
-    CA: string;
-    CV: string;
-    KY: string;
-    CF: string;
-    TD: string;
-    CL: string;
-    CN: string;
-    CX: string;
-    CC: string;
-    CO: string;
-    KM: string;
-    CG: string;
-    CD: string;
-    CK: string;
-    CR: string;
-    CI: string;
-    HR: string;
-    CU: string;
-    CW: string;
-    CY: string;
-    CZ: string;
-    DK: string;
-    DJ: string;
-    DM: string;
-    DO: string;
-    EC: string;
-    EG: string;
-    SV: string;
-    GQ: string;
-    ER: string;
-    EE: string;
-    ET: string;
-    FK: string;
-    FO: string;
-    FJ: string;
-    FI: string;
-    FR: string;
-    GF: string;
-    PF: string;
-    TF: string;
-    GA: string;
-    GM: string;
-    GE: string;
-    DE: string;
-    GH: string;
-    GI: string;
-    GR: string;
-    GL: string;
-    GD: string;
-    GP: string;
-    GU: string;
-    GT: string;
-    GG: string;
-    GN: string;
-    GW: string;
-    GY: string;
-    HT: string;
-    HM: string;
-    VA: string;
-    HN: string;
-    HK: string;
-    HU: string;
-    IS: string;
-    IN: string;
-    ID: string;
-    IR: string;
-    IQ: string;
-    IE: string;
-    IM: string;
-    IL: string;
-    IT: string;
-    JM: string;
-    JP: string;
-    JE: string;
-    JO: string;
-    KZ: string;
-    KE: string;
-    KI: string;
-    KP: string;
-    KR: string;
-    KW: string;
-    KG: string;
-    LA: string;
-    LV: string;
-    LB: string;
-    LS: string;
-    LR: string;
-    LY: string;
-    LI: string;
-    LT: string;
-    LU: string;
-    MO: string;
-    MK: string;
-    MG: string;
-    MW: string;
-    MY: string;
-    MV: string;
-    ML: string;
-    MT: string;
-    MH: string;
-    MQ: string;
-    MR: string;
-    MU: string;
-    YT: string;
-    MX: string;
-    FM: string;
-    MD: string;
-    MC: string;
-    MN: string;
-    ME: string;
-    MS: string;
-    MA: string;
-    MZ: string;
-    MM: string;
-    NA: string;
-    NR: string;
-    NP: string;
-    NL: string;
-    AN: string;
-    NC: string;
-    NZ: string;
-    NI: string;
-    NE: string;
-    NG: string;
-    NU: string;
-    NF: string;
-    MP: string;
-    NO: string;
-    OM: string;
-    PK: string;
-    PW: string;
-    PS: string;
-    PA: string;
-    PG: string;
-    PY: string;
-    PE: string;
-    PH: string;
-    PN: string;
-    PL: string;
-    PT: string;
-    PR: string;
-    QA: string;
-    RE: string;
-    RO: string;
-    RU: string;
-    RW: string;
-    BL: string;
-    SH: string;
-    KN: string;
-    LC: string;
-    MF: string;
-    PM: string;
-    VC: string;
-    WS: string;
-    SM: string;
-    ST: string;
-    SA: string;
-    SN: string;
-    RS: string;
-    SC: string;
-    SL: string;
-    SG: string;
-    SX: string;
-    SK: string;
-    SI: string;
-    SB: string;
-    SO: string;
-    ZA: string;
-    GS: string;
-    SS: string;
-    ES: string;
-    LK: string;
-    SD: string;
-    SR: string;
-    SJ: string;
-    SZ: string;
-    SE: string;
-    CH: string;
-    SY: string;
-    TW: string;
-    TJ: string;
-    TZ: string;
-    TH: string;
-    TL: string;
-    TG: string;
-    TK: string;
-    TO: string;
-    TT: string;
-    TN: string;
-    TR: string;
-    TM: string;
-    TC: string;
-    TV: string;
-    UG: string;
-    UA: string;
-    AE: string;
-    GB: string;
-    US: string;
-    UM: string;
-    UY: string;
-    UZ: string;
-    VU: string;
-    VE: string;
-    VN: string;
-    VG: string;
-    VI: string;
-    WF: string;
-    EH: string;
-    YE: string;
-    ZM: string;
-    ZW: string;
-};
-export declare const europe: {
-    AT: string;
-    BE: string;
-    BG: string;
-    HR: string;
-    CY: string;
-    CZ: string;
-    DK: string;
-    EE: string;
-    FI: string;
-    FR: string;
-    DE: string;
-    GR: string;
-    HU: string;
-    IE: string;
-    IT: string;
-    LV: string;
-    LT: string;
-    LU: string;
-    MT: string;
-    NL: string;
-    PL: string;
-    PT: string;
-    RO: string;
-    SK: string;
-    SI: string;
-    ES: string;
-    SE: string;
-};
+export declare const EU_EEA_COUNTRIES: Set<CountryEnum>;
+export declare const EUROZONE_COUNTRIES: Set<CountryEnum>;
+export declare const BASE_COUNTRY_DATA: Record<CountryEnum, {
+    name: string;
+    code: CountryEnum;
+    isEurope?: boolean;
+}>;
+export declare const COUNTRY_DATA: Record<CountryEnum, CountryDto>;