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

package/README.md

@@ -13,81 +13,23 @@ npm install @unchainedshop/core-warehousing
 
 ## Usage
 
-```typescript
-import { configureWarehousingModule, WarehousingProviderType } from '@unchainedshop/core-warehousing';
+The platform initializes this module as `platform.unchainedAPI.modules.warehousing`. Register a warehousing plugin before platform startup; the base preset includes the Store adapter.
 
-const warehousingModule = await configureWarehousingModule({ db });
+```typescript
+import { WarehousingProviderType } from '@unchainedshop/core-warehousing';
 
-// Create a warehousing provider
-const providerId = await warehousingModule.create({
+const { warehousing } = platform.unchainedAPI.modules;
+const provider = await warehousing.create({
   type: WarehousingProviderType.PHYSICAL,
-  adapterKey: 'shop.unchained.warehousing.inventory',
+  adapterKey: 'shop.unchained.warehousing.store',
+  configuration: [],
 });
-
-// Find providers
-const providers = await warehousingModule.findProviders({});
+const tokens = await warehousing.findTokensForUser({ userId: 'user-123' });
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureWarehousingModule` | Configure and return the warehousing module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findProvider` | Find provider by ID |
-| `findProviders` | Find providers with filtering |
-| `count` | Count providers |
-| `providerExists` | Check if provider exists |
-| `findSupported` | Find providers for product context |
-| `findInterface` | Get provider interface definition |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new warehousing provider |
-| `update` | Update provider configuration |
-| `delete` | Soft delete a provider |
-
-### Token Surrogates
-
-For tokenized products (NFTs):
-
-| Method | Description |
-|--------|-------------|
-| `findTokenSurrogate` | Find token surrogate |
-| `createTokenSurrogate` | Create token surrogate |
-| `updateTokenSurrogate` | Update token surrogate |
-| `deleteTokenSurrogate` | Delete token surrogate |
-| `invalidateTokenSurrogates` | Invalidate surrogates for product |
-
-### Constants
-
-| Export | Description |
-|--------|-------------|
-| `WarehousingProviderType` | Provider types (PHYSICAL, VIRTUAL) |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `WarehousingProvider` | Provider document type |
-| `TokenSurrogate` | Token surrogate document type |
-| `WarehousingModule` | Module interface type |
-
-## Events
+Provider records and tokens live in this module. Registered warehousing adapters implement stock and availability; `unchainedAPI.services.products` exposes inventory and dispatch simulations, and `unchainedAPI.services.warehousing` provides token helpers.
 
-| Event | Description |
-|-------|-------------|
-| `WAREHOUSING_PROVIDER_CREATE` | Provider created |
-| `WAREHOUSING_PROVIDER_UPDATE` | Provider updated |
-| `WAREHOUSING_PROVIDER_REMOVE` | Provider deleted |
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/warehousing), [public exports](src/warehousing-index.ts), and [module implementation](src/module/configureWarehousingModule.ts).
 
 ## License
 

package/lib/db/TokenSurrogateCollection.js

@@ -1,4 +1,4 @@
-import { buildDbIndexes, isDocumentDBCompatModeEnabled } from '@unchainedshop/mongodb';
+import { buildDbIndexes } from '@unchainedshop/mongodb';
 export const TokenStatus = {
     CENTRALIZED: 'CENTRALIZED',
     EXPORTING: 'EXPORTING',
@@ -6,53 +6,36 @@ export const TokenStatus = {
 };
 export const TokenSurrogateCollection = async (db) => {
     const TokenSurrogates = db.collection('token_surrogates');
-    if (!isDocumentDBCompatModeEnabled()) {
-        await buildDbIndexes(TokenSurrogates, [
-            {
-                index: {
-                    tokenSerialNumber: 'text',
-                    userId: 'text',
-                    productId: 'text',
-                    _id: 'text',
-                    walletAddress: 'text',
-                    contractAddress: 'text',
-                },
-                options: {
-                    weights: {
-                        _id: 9,
-                        tokenSerialNumber: 8,
-                        userId: 3,
-                        productId: 6,
-                        contractAddress: 5,
-                        walletAddress: 4,
-                        status: 1,
-                    },
-                    name: 'token_fulltext_search',
-                },
-            },
-        ], { rebuild: true });
-    }
     await buildDbIndexes(TokenSurrogates, [
         {
             index: {
-                tokenSerialNumber: 1,
-            },
-        },
-        {
-            index: {
-                userId: 1,
-            },
-        },
-        {
-            index: {
-                productId: 1,
+                tokenSerialNumber: 'text',
+                userId: 'text',
+                productId: 'text',
+                _id: 'text',
+                walletAddress: 'text',
+                contractAddress: 'text',
             },
-        },
-        {
-            index: {
-                orderPositionId: 1,
+            options: {
+                weights: {
+                    _id: 9,
+                    tokenSerialNumber: 8,
+                    userId: 3,
+                    productId: 6,
+                    contractAddress: 5,
+                    walletAddress: 4,
+                    status: 1,
+                },
+                name: 'token_fulltext_search',
             },
         },
+    ], { rebuild: true });
+    await buildDbIndexes(TokenSurrogates, [
+        { index: { tokenSerialNumber: 1 } },
+        { index: { userId: 1 } },
+        { index: { orderPositionId: 1 } },
+        { index: { walletAddress: 1 }, options: { sparse: true } },
+        { index: { productId: 1, 'meta.cancelled': 1 }, options: { sparse: true } },
     ]);
     return TokenSurrogates;
 };

package/lib/db/WarehousingProvidersCollection.js

@@ -6,21 +6,8 @@ export const WarehousingProviderType = {
 export const WarehousingProvidersCollection = async (db) => {
     const WarehousingProviders = db.collection('warehousing-providers');
     await buildDbIndexes(WarehousingProviders, [
-        {
-            index: {
-                type: 1,
-            },
-        },
-        {
-            index: {
-                created: 1,
-            },
-        },
-        {
-            index: {
-                deleted: 1,
-            },
-        },
+        { index: { deleted: 1, type: 1 } },
+        { index: { deleted: 1, created: 1 } },
     ]);
     return WarehousingProviders;
 };

package/lib/module/configureWarehousingModule.d.ts

@@ -31,9 +31,7 @@ export declare const configureWarehousingModule: ({ db }: ModuleInput<Record<str
         walletAddresses: string[];
     }, options?: mongodb.FindOptions) => Promise<TokenSurrogate[]>;
     findProviders: (query?: WarehousingProviderQuery, options?: mongodb.FindOptions) => Promise<WarehousingProvider[]>;
-    allProviders: (() => Promise<mongodb.WithId<WarehousingProvider>[]>) & {
-        clear: () => void;
-    };
+    allProviders: import("@unchainedshop/utils/lib/memoize-with-ttl.js").MemoizedWithTTL<[], mongodb.WithId<WarehousingProvider>[]>;
     providerExists: ({ warehousingProviderId, }: {
         warehousingProviderId: string;
     }) => Promise<boolean>;
@@ -45,7 +43,7 @@ export declare const configureWarehousingModule: ({ db }: ModuleInput<Record<str
         walletAddress: string;
     }) => Promise<mongodb.WithId<TokenSurrogate> | null>;
     invalidateToken: (tokenId: string) => Promise<mongodb.WithId<TokenSurrogate> | null>;
-    buildAccessKeyForToken: (tokenId: string) => Promise<string | null>;
+    buildAccessKeyFromToken: (token: TokenSurrogate) => Promise<string>;
     create: (doc: Omit<WarehousingProvider, "_id" | "created"> & Pick<Partial<WarehousingProvider>, "_id">) => Promise<WarehousingProvider>;
     update: (warehousingProviderId: string, doc: Partial<WarehousingProvider>) => Promise<mongodb.WithId<WarehousingProvider> | null>;
     delete: (providerId: string) => Promise<mongodb.WithId<WarehousingProvider> | null>;

package/lib/module/configureWarehousingModule.js

@@ -1,5 +1,5 @@
 import { emit, registerEvents } from '@unchainedshop/events';
-import { generateDbFilterById, generateDbObjectId, escapeRegexString, assertDocumentDBCompatMode, } from '@unchainedshop/mongodb';
+import { generateDbFilterById, generateDbObjectId, escapeRegexString, } from '@unchainedshop/mongodb';
 import { WarehousingProvidersCollection, } from "../db/WarehousingProvidersCollection.js";
 import { TokenSurrogateCollection } from "../db/TokenSurrogateCollection.js";
 import { memoizeWithTTL } from '@unchainedshop/utils';
@@ -10,7 +10,6 @@ const WAREHOUSING_PROVIDER_EVENTS = [
     'TOKEN_OWNERSHIP_CHANGED',
     'TOKEN_INVALIDATED',
 ];
-const allProvidersTtlMs = process.env.NODE_ENV === 'production' ? 60000 : 1;
 export const buildFindSelector = ({ includeDeleted = false, queryString, warehousingProviderIds, type, } = {}) => {
     const selector = includeDeleted ? {} : { deleted: null };
     if (warehousingProviderIds) {
@@ -28,7 +27,6 @@ export const buildFindSelector = ({ includeDeleted = false, queryString, warehou
 export const buildTokenFindSelector = ({ queryString, walletAddressExists, ...rest }) => {
     const selector = { ...(rest || {}) };
     if (queryString) {
-        assertDocumentDBCompatMode();
         selector.$text = { $search: queryString };
     }
     if (walletAddressExists !== undefined) {
@@ -39,10 +37,8 @@ export const buildTokenFindSelector = ({ queryString, walletAddressExists, ...re
 export const configureWarehousingModule = async ({ db }) => {
     registerEvents(WAREHOUSING_PROVIDER_EVENTS);
     const WarehousingProviders = await WarehousingProvidersCollection(db);
+    const allProviders = memoizeWithTTL(async () => WarehousingProviders.find({ deleted: null }, { sort: { created: 1, _id: 1 } }).toArray(), { ttl: process.env.NODE_ENV === 'production' ? 60000 : 1 });
     const TokenSurrogates = await TokenSurrogateCollection(db);
-    const allProviders = memoizeWithTTL(async function () {
-        return WarehousingProviders.find({ deleted: null }, { sort: { created: 1 } }).toArray();
-    }, allProvidersTtlMs);
     return {
         count: async (query = {}) => {
             const providerCount = await WarehousingProviders.countDocuments(buildFindSelector(query));
@@ -81,7 +77,7 @@ export const configureWarehousingModule = async ({ db }) => {
             const userTokens = await TokenSurrogates.find(selector, options).toArray();
             return userTokens;
         },
-        findProviders: async (query = {}, options = { sort: { created: 1 } }) => {
+        findProviders: async (query = {}, options = { sort: { created: 1, _id: 1 } }) => {
             const providers = WarehousingProviders.find(buildFindSelector(query), options);
             return providers.toArray();
         },
@@ -129,10 +125,7 @@ export const configureWarehousingModule = async ({ db }) => {
             await emit('TOKEN_INVALIDATED', { token });
             return token;
         },
-        buildAccessKeyForToken: async (tokenId) => {
-            const token = await TokenSurrogates.findOne(generateDbFilterById(tokenId));
-            if (!token)
-                return null;
+        buildAccessKeyFromToken: async (token) => {
             const payload = [
                 token._id,
                 token.walletAddress || token.userId,

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@unchainedshop/core-warehousing",
   "description": "Inventory and stock management module for the Unchained Engine",
-  "version": "5.0.0-alpha.1",
+  "version": "5.0.0-alpha.10",
+  "files": [
+    "lib"
+  ],
   "main": "lib/warehousing-index.js",
   "types": "lib/warehousing-index.d.ts",
   "type": "module",
@@ -35,12 +38,12 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^5.0.0-alpha.1",
-    "@unchainedshop/logger": "^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"
   }
 }