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

package/README.md

@@ -13,69 +13,19 @@ npm install @unchainedshop/core-languages
 
 ## Usage
 
-```typescript
-import { configureLanguagesModule } from '@unchainedshop/core-languages';
-
-const languagesModule = await configureLanguagesModule({ db });
+The platform initializes this module as `platform.unchainedAPI.modules.languages`.
 
-// Create a language
-const languageId = await languagesModule.create({
-  isoCode: 'en',
-});
-
-// Find languages
-const languages = await languagesModule.findLanguages({ includeInactive: false });
+```typescript
+const { languages } = platform.unchainedAPI.modules;
 
-// Check if language is base language
-const isBase = languagesModule.isBase(language);
+const languageId = await languages.create({ isoCode: 'en', isActive: true });
+const language = await languages.findLanguage({ languageId });
+const activeLanguages = await languages.findLanguages({ includeInactive: false });
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureLanguagesModule` | Configure and return the languages module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findLanguage` | Find language by ID or ISO code |
-| `findLanguages` | Find languages with filtering, sorting, and pagination |
-| `count` | Count languages matching query |
-| `languageExists` | Check if a language exists |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new language |
-| `update` | Update an existing language |
-| `delete` | Soft delete a language |
-
-### Helper Methods
-
-| Method | Description |
-|--------|-------------|
-| `isBase` | Check if language is the base/system language |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `Language` | Language document type |
-| `LanguageQuery` | Query parameters type |
-| `LanguagesModule` | Module interface type |
-
-## Events
+`create` returns a language ID. Product and assortment translations are managed by their respective modules.
 
-| Event | Description |
-|-------|-------------|
-| `LANGUAGE_CREATE` | Emitted when a language is created |
-| `LANGUAGE_UPDATE` | Emitted when a language is updated |
-| `LANGUAGE_REMOVE` | Emitted when a language is removed |
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/languages), [public exports](src/languages-index.ts), and [module implementation](src/module/configureLanguagesModule.ts).
 
 ## License
 

package/lib/db/LanguagesCollection.js

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

package/lib/module/configureLanguagesModule.js

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

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@unchainedshop/core-languages",
   "description": "Language management module for the Unchained Engine",
-  "version": "5.0.0-alpha.1",
+  "version": "5.0.0-alpha.10",
+  "files": [
+    "lib"
+  ],
   "main": "lib/languages-index.js",
   "types": "lib/languages-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"
   }
 }