@samatawy/rules-world 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# @samatawy/rules-world
+
+World and geography-oriented function providers for [@samatawy/rules](https://www.npmjs.com/package/@samatawy/rules).
+
+This package is designed as an optional plugin. It keeps geography and country-data helpers outside the core rules engine package while still integrating through the same `FunctionFactory.registerProvider(...)` API.
+
+It currently exposes `42` country-related functions (2 of which are aliases). Data is available for `250` countries.
+
+To report incorrect data or behaviour, or to request additional features, use [the Github issue tracker](https://github.com/samatawy/rules-world/issues).
+
+This package can be used by:
+
+- Node.js and browser runtimes
+- ESM and CommonJS consumers
+
+## Installation
+
+```bash
+npm install @samatawy/rules @samatawy/rules-world
+```
+
+`@samatawy/rules` is a peer dependency, so your application provides the core engine version.
+
+## Usage
+
+```ts
+import { FunctionFactory, Workspace } from '@samatawy/rules';
+import { CommonGeographyFunctionsProvider } from '@samatawy/rules-world';
+
+FunctionFactory.registerProvider(CommonGeographyFunctionsProvider);
+
+const workspace = new Workspace();
+workspace.addRule('if country_name("CA") = "Canada" then result.country = true');
+workspace.addRule('if country_has_tld("CA", ".ca") then result.local = true');
+```
+
+You can also register the provider through the package helper:
+
+```ts
+import { registerWorldProviders } from '@samatawy/rules-world';
+
+registerWorldProviders();
+```
+
+The same package entry works in both Node.js and browser builds, with ESM and CommonJS output generated from the same source.
+
+## Included Provider
+
+- `CommonGeographyFunctionsProvider`
+
+## Included Data
+
+- `Countries`
+- `CountryCodes`
+- `CurrencyCodes`
+- `Languages`
+- `Continents`
+- `Timezones`
+
+## Example Geography Functions
+
+- `country_codes()`
+- `country_code(value)`
+- `country_name(code)`
+- `official_country_name(code)`
+- `country_calling_codes(code)`
+- `country_top_level_domains(code)`
+- `country_languages(code)`
+- `country_timezones(code)`
+- `countries_in_continent(continent)`
+- `countries_in_subregion(subregion)`
+- `countries_using_currency(currency)`
+- `country_has_tld(code, tld)`
+- `country_has_calling_code(code, callingCode)`
+- `country_speaks_language(code, language)`
+- `country_in_timezone(code, timezone)`