@unchainedshop/mongodb 3.0.0-alpha3 → 3.0.0-alpha5

package/lib/mongodb-index.d.ts

@@ -35,4 +35,23 @@ export interface Contact {
     telNumber?: string;
     emailAddress?: string;
 }
+export interface Migration<Context = unknown> {
+    id: number;
+    name: string;
+    up: (params: {
+        logger: any | Console;
+        unchainedAPI: Context;
+    }) => Promise<void>;
+}
+export interface MigrationRepository<Context = unknown> {
+    db: mongodb.Db;
+    migrations: Map<number, Migration<Context>>;
+    register: (migration: Migration<Context>) => void;
+    allMigrations: () => Array<Migration<Context>>;
+}
+export interface ModuleInput<Options extends Record<string, any>> {
+    db: mongodb.Db;
+    migrationRepository?: MigrationRepository;
+    options?: Options;
+}
 //# sourceMappingURL=mongodb-index.d.ts.map

package/lib/mongodb-index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mongodb-index.d.ts","sourceRoot":"","sources":["../src/mongodb-index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAEnC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAMtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,KAAK,CAAC;QACT,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;CACJ,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}
+{"version":3,"file":"mongodb-index.d.ts","sourceRoot":"","sources":["../src/mongodb-index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAEnC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAMtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,KAAK,CAAC;QACT,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;CACJ,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS,CAAC,OAAO,GAAG,OAAO;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACjF;AAED,MAAM,WAAW,mBAAmB,CAAC,OAAO,GAAG,OAAO;IACpD,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC;IACf,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5C,QAAQ,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAClD,aAAa,EAAE,MAAM,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,WAAW,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC9D,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC;IACf,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/mongodb",
-  "version": "3.0.0-alpha3",
+  "version": "3.0.0-alpha5",
   "description": "MongoDB provider for unchained platform",
   "main": "lib/mongodb-index.js",
   "exports": {
@@ -31,18 +31,18 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/utils": "^3.0.0-alpha3"
+    "@unchainedshop/utils": "^3.0.0-alpha4"
   },
   "peerDependencies": {
     "@mongodb-js/zstd": "^1.2.2",
-    "mongodb": "^6.9.0"
+    "mongodb": "^6.10.0"
   },
   "optionalDependencies": {
     "mongodb-memory-server": "^10.0.0"
   },
   "devDependencies": {
-    "@types/node": "^22.5.5",
+    "@types/node": "^22.8.1",
     "jest": "^29.7.0",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.3"
   }
 }

package/src/mongodb-index.test.ts

@@ -1,41 +1,38 @@
 import { SortDirection } from '@unchainedshop/utils';
-import {
-  buildSortOptions,
-  generateDbObjectId,
-} from './mongodb-index.js';
+import { buildSortOptions, generateDbObjectId } from './mongodb-index.js';
 
 describe('Mongo', () => {
-  it('Init', async () => {
-    expect(true).toBeTruthy()
+  it('Init', () => {
+    expect(true).toBeTruthy();
   });
 
   describe('buildSortOptions', () => {
     it('should return the correct db sort format', () => {
-      const sort = [    { key: 'name', value: SortDirection.ASC },    { key: 'age', value: SortDirection.DESC },  ];
+      const sort = [
+        { key: 'name', value: SortDirection.ASC },
+        { key: 'age', value: SortDirection.DESC },
+      ];
       expect(buildSortOptions(sort)).toEqual({ name: 1, age: -1 });
-    })
-    
+    });
   });
-  
+
   describe('generateDbObjectId', () => {
-  it('generateDbObjectId with default digits', () => {
-    const result = generateDbObjectId();
-    expect(typeof result).toBe('string');
-    expect(result.length).toBe(24);
-  });
-  
-  it('generateDbObjectId with odd digits', () => {
-    const result = generateDbObjectId(23);
-    expect(typeof result).toBe('string');
-    expect(result.length).toBe(23);
-  });
-  
-  it('generateDbObjectId with even digits', () => {
-    const result = generateDbObjectId(24);
-    expect(typeof result).toBe('string');
-    expect(result.length).toBe(24);
+    it('generateDbObjectId with default digits', () => {
+      const result = generateDbObjectId();
+      expect(typeof result).toBe('string');
+      expect(result.length).toBe(24);
+    });
+
+    it('generateDbObjectId with odd digits', () => {
+      const result = generateDbObjectId(23);
+      expect(typeof result).toBe('string');
+      expect(result.length).toBe(23);
+    });
+
+    it('generateDbObjectId with even digits', () => {
+      const result = generateDbObjectId(24);
+      expect(typeof result).toBe('string');
+      expect(result.length).toBe(24);
+    });
   });
-  
-  })
 });
-

package/src/mongodb-index.ts

@@ -46,3 +46,22 @@ export interface Contact {
   telNumber?: string;
   emailAddress?: string;
 }
+
+export interface Migration<Context = unknown> {
+  id: number;
+  name: string;
+  up: (params: { logger: any | Console; unchainedAPI: Context }) => Promise<void>;
+}
+
+export interface MigrationRepository<Context = unknown> {
+  db: mongodb.Db;
+  migrations: Map<number, Migration<Context>>;
+  register: (migration: Migration<Context>) => void;
+  allMigrations: () => Array<Migration<Context>>;
+}
+
+export interface ModuleInput<Options extends Record<string, any>> {
+  db: mongodb.Db;
+  migrationRepository?: MigrationRepository;
+  options?: Options;
+}