@unchainedshop/core-countries 5.0.0-alpha.1 → 5.0.0-alpha.10

package/README.md

@@ -13,72 +13,25 @@ npm install @unchainedshop/core-countries
 
 ## Usage
 
-```typescript
-import { configureCountriesModule } from '@unchainedshop/core-countries';
+The platform initializes this module as `platform.unchainedAPI.modules.countries`.
 
-const countriesModule = await configureCountriesModule({ db });
+```typescript
+const { countries } = platform.unchainedAPI.modules;
 
-// Create a country
-const countryId = await countriesModule.create({
+const countryId = await countries.create({
   isoCode: 'CH',
   defaultCurrencyCode: 'CHF',
+  isActive: true,
 });
-
-// Find countries
-const countries = await countriesModule.findCountries({ includeInactive: false });
-
-// Get localized country name
-const name = countriesModule.name(country, new Intl.Locale('en'));
+const country = await countries.findCountry({ countryId });
+if (country) {
+  const name = countries.name(country, new Intl.Locale('en'));
+}
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureCountriesModule` | Configure and return the countries module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findCountry` | Find country by ID or ISO code |
-| `findCountries` | Find countries with filtering, sorting, and pagination |
-| `count` | Count countries matching query |
-| `countryExists` | Check if a country exists |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new country |
-| `update` | Update an existing country |
-| `delete` | Soft delete a country |
-
-### Helper Methods
-
-| Method | Description |
-|--------|-------------|
-| `name` | Get localized country name using Intl.DisplayNames |
-| `flagEmoji` | Get flag emoji for a country |
-| `isBase` | Check if country is the base/system country |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `Country` | Country document type |
-| `CountryQuery` | Query parameters type |
-| `CountriesModule` | Module interface type |
-
-## Events
+`create` returns a country ID. Configure currencies separately before assigning them to countries.
 
-| Event | Description |
-|-------|-------------|
-| `COUNTRY_CREATE` | Emitted when a country is created |
-| `COUNTRY_UPDATE` | Emitted when a country is updated |
-| `COUNTRY_REMOVE` | Emitted when a country is removed |
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/countries), [public exports](src/countries-index.ts), and [module implementation](src/module/configureCountriesModule.ts) for queries, helpers, and events.
 
 ## License
 

package/lib/db/CountriesCollection.js

@@ -1,20 +1,18 @@
-import { mongodb, buildDbIndexes, isDocumentDBCompatModeEnabled } from '@unchainedshop/mongodb';
+import { mongodb, buildDbIndexes } from '@unchainedshop/mongodb';
 export const CountriesCollection = async (db) => {
     const Countries = db.collection('countries');
-    if (!isDocumentDBCompatModeEnabled()) {
-        await buildDbIndexes(Countries, [
-            {
-                index: { isoCode: 'text', _id: 'text' },
-                options: {
-                    weights: {
-                        _id: 8,
-                        isoCode: 6,
-                    },
-                    name: 'countries_fulltext_search',
+    await buildDbIndexes(Countries, [
+        {
+            index: { isoCode: 'text', _id: 'text' },
+            options: {
+                weights: {
+                    _id: 8,
+                    isoCode: 6,
                 },
+                name: 'countries_fulltext_search',
             },
-        ]);
-    }
+        },
+    ]);
     await buildDbIndexes(Countries, [
         { index: { isoCode: 1 }, options: { unique: true } },
         {

package/lib/module/configureCountriesModule.js

@@ -1,4 +1,4 @@
-import { mongodb, assertDocumentDBCompatMode, } from '@unchainedshop/mongodb';
+import { mongodb } from '@unchainedshop/mongodb';
 import { emit, registerEvents } from '@unchainedshop/events';
 import { generateDbFilterById, buildSortOptions, generateDbObjectId } from '@unchainedshop/mongodb';
 import { SortDirection } from '@unchainedshop/utils';
@@ -14,7 +14,6 @@ export const buildFindSelector = ({ includeInactive = false, queryString = '', i
         selector.isoCode = { $in: isoCodes };
     }
     if (queryString) {
-        assertDocumentDBCompatMode();
         selector.$text = { $search: queryString };
     }
     return selector;

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@unchainedshop/core-countries",
   "description": "Country management module for the Unchained Engine",
-  "version": "5.0.0-alpha.1",
+  "version": "5.0.0-alpha.10",
+  "files": [
+    "lib"
+  ],
   "main": "lib/countries-index.js",
   "types": "lib/countries-index.d.ts",
   "type": "module",
@@ -35,11 +38,12 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^5.0.0-alpha.1",
-    "@unchainedshop/utils": "^5.0.0-alpha.1"
+    "@unchainedshop/events": "^5.0.0-alpha.10",
+    "@unchainedshop/mongodb": "^5.0.0-alpha.10",
+    "@unchainedshop/utils": "^5.0.0-alpha.10"
   },
   "devDependencies": {
-    "@types/node": "^25.0.0",
-    "typescript": "^5.8.3"
+    "@types/node": "^26.2.0",
+    "typescript": "^6.0.3"
   }
 }