@arkyn/templates 3.0.1-beta.99 → 3.0.2

package/LICENSE.txt

@@ -0,0 +1,207 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 - Arkyn | Lucas Eduardo Gonçalves
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+For more information or to contribute, visit:
+https://github.com/Lucas-Eduardo-Goncalves

package/README.md

@@ -1,22 +1,35 @@
 # @arkyn/templates
 
-Ready-to-use data templates and constants for international and Brazilian applications. Provides comprehensive country data, Brazilian states, currency information, and locale configurations to accelerate your development workflow.
+Ready-to-use static data for international and Brazilian applications — country lists, phone masks, Brazilian states, and currency/locale metadata — so you don't have to source and maintain this data yourself.
 
 [![npm version](https://img.shields.io/npm/v/@arkyn/templates.svg)](https://www.npmjs.com/package/@arkyn/templates)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
 
+## 🎯 What it solves
+
+Building phone inputs, address forms, or currency formatters usually means sourcing and hand-maintaining reference data: every country's dialing code and phone mask, all Brazilian states, and locale/currency pairs for `Intl.NumberFormat`. `@arkyn/templates` ships that data as typed, ready-to-import constants, so `@arkyn/components` (phone/currency inputs, address selects) and `@arkyn/shared` (currency formatting) — or your own app — can consume it directly without any setup, network calls, or extra dependencies.
+
 ## ✨ Features
 
-- 🌍 **Global Countries Data** - Complete list of 195+ countries with flags, codes, and phone masks
-- 🇧🇷 **Brazilian States** - All 26 states plus Federal District with codes and names
-- 💱 **Currency Information** - Country-specific currency data and formatting rules
-- 📊 **Locale Configurations** - Maximum fraction digits for different currencies
-- 🎯 **TypeScript Support** - Fully typed data structures
-- 📱 **Phone Number Masks** - Country-specific phone formatting patterns
+- 🌍 **Countries Data** - 245 countries with name, ISO code, dialing code, flag URL, and phone input mask
+- 🇧🇷 **Brazilian States** - All 26 states plus the Federal District, as `{ label, value }` pairs
+- 💱 **Country Currencies** - Currency code → locale/currency pairs ready for `Intl.NumberFormat`
+- 📊 **Fraction Digits Constant** - The default number of decimal places used across the Arkyn ecosystem
+- 🎯 **Fully Typed** - Every export ships its own TypeScript type
+- 📦 **Zero Runtime Dependencies** - Pure static data, no peer dependencies required
+
+## 📋 Prerequisites
+
+- Node.js `>=18.0.0`
+- Bun `>=1.0.0` (only if building/developing the monorepo itself)
+
+This package has no runtime dependencies and no peer dependencies — it can be installed standalone.
 
 ## 📦 Installation
 
+> **ESM only.** This package ships as native ES modules with no CommonJS build — use `import`, not `require()`.
+
 ```bash
 npm install @arkyn/templates
 ```
@@ -28,367 +41,113 @@ import {
   countries,
   brazilianStates,
   countryCurrencies,
+  maximumFractionDigits,
 } from "@arkyn/templates";
 
 // Find a specific country
 const brazil = countries.find((country) => country.iso === "BR");
 console.log(brazil);
 // {
-//   name: "Brazil",
+//   name: "Brasil",
 //   code: "+55",
-//   prefix: null,
 //   iso: "BR",
 //   flag: "https://cdn.kcak11.com/CountryFlags/countries/br.svg",
-//   mask: "(__) _____-____"
+//   mask: ["(__) _____-____", "(__) ____-____"]
 // }
 
-// Get Brazilian states
-const saoPaulo = brazilianStates.find((state) => state.code === "SP");
-console.log(saoPaulo); // { code: 'SP', name: 'São Paulo' }
+// Get a Brazilian state
+const saoPaulo = brazilianStates.find((state) => state.value === "SP");
+console.log(saoPaulo); // { label: "São Paulo", value: "SP" }
+
+// Get locale/currency info for Intl.NumberFormat
+console.log(countryCurrencies.BRL); // { countryLanguage: "pt-BR", countryCurrency: "BRL" }
 
-// Access currency data
-console.log(countryCurrencies.USD); // Currency information for USD
+// Default decimal places used across Arkyn's currency formatting
+console.log(maximumFractionDigits); // 2
 ```
 
-## 📋 API Reference
+## 📖 API Reference
 
-### 🌍 Countries Data
+### 🌍 `countries`
 
-The `countries` array contains comprehensive data for all world countries:
+An array of 245 countries, typed as `CountryType[]`:
 
 ```typescript
-interface Country {
-  name: string; // Country name in English
-  code: string; // International dialing code (e.g., "+55")
-  prefix: string | null; // Additional prefix for specific regions
-  iso: string; // ISO 3166-1 alpha-2 country code
-  flag: string; // URL to country flag SVG
-  mask: string; // Phone number formatting mask
-}
+type CountryType = {
+  name: string; // Country name
+  code: string; // International dialing code (e.g. "+55")
+  iso: string; // ISO 3166-1 alpha-2 code (e.g. "BR")
+  flag: string; // URL to an SVG flag icon
+  mask: string | string[]; // Phone input mask(s); some countries have more than one valid mask
+};
 ```
 
-#### Usage Examples
-
 ```typescript
-import { countries } from "@arkyn/templates";
-
-// Get all countries
-console.log(countries.length); // 195+
+import { countries, type CountryType } from "@arkyn/templates";
 
-// Find by ISO code
 const usa = countries.find((country) => country.iso === "US");
-
-// Find by country code
-const brazilianCountries = countries.filter(
-  (country) => country.code === "+55"
-);
-
-// Get all European countries (you'll need additional logic)
-const europeanCountries = countries.filter((country) =>
-  ["FR", "DE", "IT", "ES", "PT"].includes(country.iso)
-);
-
-// Create a phone input selector
-function CountrySelector() {
-  return (
-    <select>
-      {countries.map((country) => (
-        <option key={country.iso} value={country.code}>
-          <img src={country.flag} alt={country.name} />
-          {country.name} ({country.code})
-        </option>
-      ))}
-    </select>
-  );
-}
+const brazilianOptions = countries.filter((country) => country.code === "+55");
 ```
 
-### 🇧🇷 Brazilian States
+Used internally by `@arkyn/components`' `PhoneInput` to render the country selector and apply the correct input mask.
 
-The `brazilianStates` array contains all Brazilian states and the Federal District:
+### 🇧🇷 `brazilianStates`
+
+An array of the 26 Brazilian states plus the Federal District:
 
 ```typescript
-interface BrazilianState {
-  code: string; // Two-letter state code (e.g., "SP", "RJ")
-  name: string; // State name in Portuguese (e.g., "São Paulo")
-}
+type BrazilianState = { label: string; value: string };
 ```
 
-#### Usage Examples
-
 ```typescript
 import { brazilianStates } from "@arkyn/templates";
 
-// Get all states
-console.log(brazilianStates.length); // 27 (26 states + Federal District)
-
-// Find specific state
-const rioDeJaneiro = brazilianStates.find((state) => state.code === "RJ");
-console.log(rioDeJaneiro); // { code: 'RJ', name: 'Rio de Janeiro' }
-
-// Create a state selector
-function StateSelector() {
-  return (
-    <select>
-      {brazilianStates.map((state) => (
-        <option key={state.code} value={state.code}>
-          {state.name}
-        </option>
-      ))}
-    </select>
-  );
-}
-
-// Validate state code
-function isValidState(stateCode: string): boolean {
-  return brazilianStates.some((state) => state.code === stateCode);
-}
+console.log(brazilianStates.length); // 27
+const rio = brazilianStates.find((state) => state.value === "RJ");
+// { label: "Rio de Janeiro", value: "RJ" }
 ```
 
-### 💱 Country Currencies
+The `{ label, value }` shape maps directly onto `@arkyn/components`' `Select` / `MultiSelect` `options` prop.
+
+### 💱 `countryCurrencies`
 
-The `countryCurrencies` object provides currency information mapped by currency codes:
+A record keyed by ISO 4217 currency code, mapping each currency to the locale/currency pair `Intl.NumberFormat` expects:
 
 ```typescript
-interface CountryCurrency {
-  [currencyCode: string]: {
-    symbol: string;
-    name: string;
-    countries: string[];
-  };
-}
+type CountryCurrencies = Record<
+  string,
+  { countryLanguage: string; countryCurrency: string }
+>;
 ```
 
-#### Usage Examples
-
 ```typescript
 import { countryCurrencies } from "@arkyn/templates";
 
-// Get USD information
-console.log(countryCurrencies.USD);
-// {
-//   symbol: '$',
-//   name: 'US Dollar',
-//   countries: ['US', 'EC', 'SV', ...]
-// }
-
-// Get Brazilian Real
-console.log(countryCurrencies.BRL);
-// {
-//   symbol: 'R$',
-//   name: 'Brazilian Real',
-//   countries: ['BR']
-// }
-
-// Find all countries using EUR
-const euroCountries = countryCurrencies.EUR.countries;
-
-// Get currency by country
-function getCurrencyByCountry(countryCode: string): string | null {
-  for (const [currency, data] of Object.entries(countryCurrencies)) {
-    if (data.countries.includes(countryCode)) {
-      return currency;
-    }
-  }
-  return null;
-}
+const { countryLanguage, countryCurrency } = countryCurrencies.BRL;
+// { countryLanguage: "pt-BR", countryCurrency: "BRL" }
 
-const brazilCurrency = getCurrencyByCountry("BR"); // 'BRL'
+new Intl.NumberFormat(countryLanguage, {
+  style: "currency",
+  currency: countryCurrency,
+}).format(1234.56); // "R$ 1.234,56"
 ```
 
-### 📊 Maximum Fraction Digits
-
-The `maximumFractionDigits` object provides locale-specific decimal place configurations:
+This is exactly what `@arkyn/shared`'s `formatToCurrency` uses under the hood to resolve a currency code into a locale-aware formatter.
 
-```typescript
-interface MaximumFractionDigits {
-  [locale: string]: number;
-}
-```
+### 📊 `maximumFractionDigits`
 
-#### Usage Examples
+A single constant (`2`) representing the default number of decimal places used for currency values across the Arkyn ecosystem.
 
 ```typescript
 import { maximumFractionDigits } from "@arkyn/templates";
 
-// Get maximum decimal places for different locales
-console.log(maximumFractionDigits["pt-BR"]); // 2 (for Brazilian Real)
-console.log(maximumFractionDigits["en-US"]); // 2 (for US Dollar)
-console.log(maximumFractionDigits["ja-JP"]); // 0 (for Japanese Yen)
-
-// Format currency with correct decimal places
-function formatCurrency(amount: number, locale: string): string {
-  const fractionDigits = maximumFractionDigits[locale] || 2;
-
-  return new Intl.NumberFormat(locale, {
-    style: "currency",
-    currency: getCurrencyForLocale(locale),
-    maximumFractionDigits: fractionDigits,
-    minimumFractionDigits: fractionDigits,
-  }).format(amount);
-}
+console.log(maximumFractionDigits); // 2
 ```
 
-## 🔧 Advanced Usage
+## 📚 Documentation
 
-### International Phone Input
-
-```typescript
-import { countries } from "@arkyn/templates";
-
-function InternationalPhoneInput() {
-  const [selectedCountry, setSelectedCountry] = useState(countries[0]);
-  const [phoneNumber, setPhoneNumber] = useState("");
-
-  const formatPhoneNumber = (number: string) => {
-    let formatted = number;
-    const mask = selectedCountry.mask;
-
-    // Apply mask logic here
-    return formatted;
-  };
-
-  return (
-    <div className="phone-input">
-      <select
-        value={selectedCountry.iso}
-        onChange={(e) => {
-          const country = countries.find((c) => c.iso === e.target.value);
-          setSelectedCountry(country);
-        }}
-      >
-        {countries.map((country) => (
-          <option key={country.iso} value={country.iso}>
-            <img src={country.flag} alt="" />
-            {country.name} ({country.code})
-          </option>
-        ))}
-      </select>
-
-      <input
-        type="tel"
-        value={phoneNumber}
-        onChange={(e) => setPhoneNumber(formatPhoneNumber(e.target.value))}
-        placeholder={selectedCountry.mask.replace(/_/g, "0")}
-      />
-    </div>
-  );
-}
-```
-
-### Multi-Currency Calculator
-
-```typescript
-import { countryCurrencies, maximumFractionDigits } from "@arkyn/templates";
-
-class CurrencyCalculator {
-  private exchangeRates: Record<string, number> = {};
-
-  setExchangeRates(rates: Record<string, number>) {
-    this.exchangeRates = rates;
-  }
-
-  convert(amount: number, fromCurrency: string, toCurrency: string): number {
-    if (!this.exchangeRates[fromCurrency] || !this.exchangeRates[toCurrency]) {
-      throw new Error("Exchange rate not available");
-    }
-
-    const usdAmount = amount / this.exchangeRates[fromCurrency];
-    return usdAmount * this.exchangeRates[toCurrency];
-  }
-
-  format(amount: number, currency: string, locale: string): string {
-    const fractionDigits = maximumFractionDigits[locale] || 2;
-    const currencyInfo = countryCurrencies[currency];
-
-    return new Intl.NumberFormat(locale, {
-      style: "currency",
-      currency: currency,
-      maximumFractionDigits: fractionDigits,
-    }).format(amount);
-  }
-}
-```
-
-### Address Form with Brazilian States
-
-```typescript
-import { brazilianStates } from "@arkyn/templates";
-
-function AddressForm() {
-  const [address, setAddress] = useState({
-    street: "",
-    city: "",
-    state: "",
-    zipCode: "",
-  });
-
-  return (
-    <form>
-      <input
-        type="text"
-        placeholder="Street Address"
-        value={address.street}
-        onChange={(e) => setAddress({ ...address, street: e.target.value })}
-      />
-
-      <input
-        type="text"
-        placeholder="City"
-        value={address.city}
-        onChange={(e) => setAddress({ ...address, city: e.target.value })}
-      />
-
-      <select
-        value={address.state}
-        onChange={(e) => setAddress({ ...address, state: e.target.value })}
-      >
-        <option value="">Select State</option>
-        {brazilianStates.map((state) => (
-          <option key={state.code} value={state.code}>
-            {state.name}
-          </option>
-        ))}
-      </select>
-
-      <input
-        type="text"
-        placeholder="ZIP Code"
-        value={address.zipCode}
-        onChange={(e) => setAddress({ ...address, zipCode: e.target.value })}
-      />
-    </form>
-  );
-}
-```
-
-## 🧪 Development
-
-```bash
-# Install dependencies
-bun install
-
-# Build the package
-bun run build
-
-# Type check
-bun run typecheck
-```
-
-## 🤝 Contributing
-
-Contributions are welcome! Please read our contributing guidelines and submit pull requests to help improve the package.
+For more context on how this data is consumed across the ecosystem, see the [full documentation](https://docs.arkyn.dev/docs/templates/introduction).
 
 ## 📄 License
 
-This project is licensed under the Apache 2.0 License - see the [LICENSE](./LICENSE.txt) file for details.
-
-## 🔗 Links
-
-- [GitHub Repository](https://github.com/Lucas-Eduardo-Goncalves/arkyn)
-- [NPM Package](https://www.npmjs.com/package/@arkyn/templates)
-- [Full Documentation](https://github.com/Lucas-Eduardo-Goncalves/arkyn#readme)
-
----
-
-Made with ❤️ by the Arkyn team
+This project is licensed under the Apache 2.0 License — see the [LICENSE](./LICENSE.txt) file for details.