liwi-mongo 12.0.0 → 13.1.0

package/src/MongoQuerySingleItem.ts

@@ -1,23 +1,23 @@
 import type {
-  QuerySubscription,
-  SubscribeCallback,
-  QueryResult,
-  QueryParams,
+  AllowedKeyValue,
   Changes,
   QueryOptions,
+  QueryParams,
+  QueryResult,
+  QuerySubscription,
+  SubscribeCallback,
   Transformer,
-  AllowedKeyValue,
-} from 'liwi-store';
-import type { Actions } from 'liwi-subscribe-store';
-import { AbstractSubscribableStoreQuery } from 'liwi-subscribe-store';
-import mingo from 'mingo';
+} from "liwi-store";
+import type { Actions } from "liwi-subscribe-store";
+import { AbstractSubscribableStoreQuery } from "liwi-subscribe-store";
+import mingo from "mingo";
 import type {
   MongoBaseModel,
   MongoInsertType,
   MongoKeyPath,
-} from './MongoBaseModel';
-import type MongoCursor from './MongoCursor';
-import type MongoStore from './MongoStore';
+} from "./MongoBaseModel";
+import type MongoCursor from "./MongoCursor";
+import type MongoStore from "./MongoStore";
 
 const identityTransformer = <
   Model extends MongoBaseModel<any>,
@@ -32,7 +32,7 @@ export default class MongoQuerySingleItem<
   Model extends MongoBaseModel<KeyValue>,
   Params extends QueryParams<Params> = never,
   Result extends Record<MongoKeyPath, KeyValue> | null = Model | null,
-  KeyValue extends AllowedKeyValue = Model['_id'],
+  KeyValue extends AllowedKeyValue = Model["_id"],
 > extends AbstractSubscribableStoreQuery<
   MongoKeyPath,
   KeyValue,
@@ -78,7 +78,7 @@ export default class MongoQuerySingleItem<
     await cursor.limit(1);
     return cursor.toArray().then((result: Model[]) => {
       const item: Result =
-        result.length === 0 ? (null as Result) : this.transformer(result[0]);
+        result.length === 0 ? (null as Result) : this.transformer(result[0]!);
       return onFulfilled({
         result: item,
         meta: { total: result === null ? 0 : 1 },
@@ -101,7 +101,7 @@ export default class MongoQuerySingleItem<
       ? this.fetch(({ result, meta, info }: QueryResult<Result>) => {
           callback(null, [
             {
-              type: 'initial',
+              type: "initial",
               initial: result,
               queryInfo: info,
               meta,
@@ -113,27 +113,27 @@ export default class MongoQuerySingleItem<
     const unsubscribe = store.subscribe(async (action: Actions<Model>) => {
       const changes: Changes<KeyValue, Result> = [];
       switch (action.type) {
-        case 'inserted': {
+        case "inserted": {
           const filtered = action.next.filter(testCriteria);
           if (filtered.length > 0) {
             changes.push({
-              type: 'updated',
-              result: this.transformer(filtered[0]),
+              type: "updated",
+              result: this.transformer(filtered[0]!),
             });
           }
           break;
         }
-        case 'deleted': {
+        case "deleted": {
           const filtered = action.prev.filter(testCriteria);
           if (filtered.length > 0) {
             changes.push({
-              type: 'deleted',
+              type: "deleted",
               keys: filtered.map((object) => object[this.store.keyPath]),
             });
           }
           break;
         }
-        case 'updated': {
+        case "updated": {
           const filtered = action.changes.filter(([prev, next]) =>
             testCriteria(prev),
           );
@@ -141,17 +141,17 @@ export default class MongoQuerySingleItem<
             if (this.options.sort) {
               const { result } = await this.fetch((res) => res);
               changes.push({
-                type: 'updated',
+                type: "updated",
                 result,
               });
             } else if (filtered.length !== 1) {
               throw new Error(
-                'should not match more than 1, use sort if you can have multiple match',
+                "should not match more than 1, use sort if you can have multiple match",
               );
             } else {
-              const [, next] = filtered[0];
+              const [, next] = filtered[0]!;
               changes.push({
-                type: 'updated',
+                type: "updated",
                 result: testCriteria(next) ? this.transformer(next) : null!,
               });
             }
@@ -160,7 +160,7 @@ export default class MongoQuerySingleItem<
           break;
         }
         default:
-          throw new Error('Unsupported type');
+          throw new Error("Unsupported type");
       }
 
       if (changes.length === 0) return;
@@ -184,6 +184,7 @@ export default class MongoQuerySingleItem<
     const cursor = await this.store.cursor(
       this.options.criteria,
       this.options.sort,
+      this.options.fields,
     );
 
     if (this.options.limit) {

package/src/MongoStore.ts

@@ -1,34 +1,33 @@
-/* eslint-disable max-lines */
 import type {
-  UpsertResult,
-  SubscribableStore,
-  QueryParams,
-  UpsertPartialObject,
+  AllowedKeyValue,
+  CreateQueryOptions,
   Criteria,
+  Fields,
+  OptionalBaseModelKeysForInsert,
+  QueryParams,
   Sort,
+  SubscribableStore,
   Update,
-  QueryOptions,
-  Transformer,
-  AllowedKeyValue,
-  OptionalBaseModelKeysForInsert,
-} from 'liwi-store';
+  UpsertPartialObject,
+  UpsertResult,
+} from "liwi-store";
 import type {
   Collection,
   Filter,
   FindCursor,
   MongoClient,
   UpdateFilter,
-} from 'mongodb';
-import mongodb from 'mongodb';
+} from "mongodb";
+import mongodb from "mongodb";
 import type {
   MongoBaseModel,
-  MongoKeyPath,
   MongoInsertType,
-} from './MongoBaseModel';
-import type MongoConnection from './MongoConnection';
-import MongoCursor from './MongoCursor';
-import MongoQueryCollection from './MongoQueryCollection';
-import MongoQuerySingleItem from './MongoQuerySingleItem';
+  MongoKeyPath,
+} from "./MongoBaseModel.ts";
+import type MongoConnection from "./MongoConnection.ts";
+import MongoCursor from "./MongoCursor.ts";
+import MongoQueryCollection from "./MongoQueryCollection.ts";
+import MongoQuerySingleItem from "./MongoQuerySingleItem.ts";
 
 export interface MongoUpsertResult<
   KeyValue extends AllowedKeyValue,
@@ -41,16 +40,14 @@ export interface MongoUpsertResult<
 export default class MongoStore<
   Model extends MongoBaseModel<KeyValue>,
   KeyValue extends AllowedKeyValue = Model[MongoKeyPath],
-> implements
-    SubscribableStore<
-      MongoKeyPath,
-      KeyValue,
-      Model,
-      MongoInsertType<Model>,
-      MongoConnection
-    >
-{
-  readonly keyPath: MongoKeyPath = '_id';
+> implements SubscribableStore<
+  MongoKeyPath,
+  KeyValue,
+  Model,
+  MongoInsertType<Model>,
+  MongoConnection
+> {
+  readonly keyPath: MongoKeyPath = "_id";
 
   readonly connection: MongoConnection;
 
@@ -77,7 +74,7 @@ export default class MongoStore<
 
   get collection(): Promise<Collection<Model>> {
     if (this.connection.connectionFailed) {
-      return Promise.reject(new Error('MongoDB connection failed'));
+      return Promise.reject(new Error("MongoDB connection failed"));
     }
 
     return Promise.resolve(this._collection);
@@ -86,10 +83,15 @@ export default class MongoStore<
   createQuerySingleItem<
     Result extends Record<MongoKeyPath, KeyValue> = Model,
     Params extends QueryParams<Params> = never,
-  >(
-    options: QueryOptions<Model>,
-    transformer?: Transformer<Model, Result>,
-  ): MongoQuerySingleItem<Model, Params, Result, KeyValue> {
+  >({
+    transformer,
+    ...options
+  }: CreateQueryOptions<Model, Result>): MongoQuerySingleItem<
+    Model,
+    Params,
+    Result,
+    KeyValue
+  > {
     return new MongoQuerySingleItem<Model, Params, Result, KeyValue>(
       this,
       options,
@@ -100,10 +102,15 @@ export default class MongoStore<
   createQueryCollection<
     Item extends Record<MongoKeyPath, KeyValue> = Model,
     Params extends QueryParams<Params> = never,
-  >(
-    options: QueryOptions<Model>,
-    transformer?: Transformer<Model, Item>,
-  ): MongoQueryCollection<Model, Params, Model['_id'], Item> {
+  >({
+    transformer,
+    ...options
+  }: CreateQueryOptions<Model, Item>): MongoQueryCollection<
+    Model,
+    Params,
+    Model["_id"],
+    Item
+  > {
     return new MongoQueryCollection<Model, Params, KeyValue, Item>(
       this,
       options,
@@ -113,7 +120,7 @@ export default class MongoStore<
 
   async insertOne(object: MongoInsertType<Model>): Promise<Model> {
     if (!object._id) {
-      object._id = new mongodb.ObjectId().toString() as Model['_id'];
+      object._id = new mongodb.ObjectId().toString() as Model["_id"];
     }
 
     if (!object.created) object.created = new Date();
@@ -125,7 +132,7 @@ export default class MongoStore<
       object as any,
     );
     if (!isAcknowledged) {
-      throw new Error('Fail to insert');
+      throw new Error("Fail to insert");
     }
 
     return object as Model;
@@ -146,7 +153,7 @@ export default class MongoStore<
     >,
   >(
     object: UpsertPartialObject<MongoKeyPath, KeyValue, Model, K>,
-    setOnInsertPartialObject?: Update<Model>['$setOnInsert'],
+    setOnInsertPartialObject?: Update<Model>["$setOnInsert"],
   ): Promise<Model> {
     const result = await this.upsertOneWithInfo(
       object,
@@ -162,9 +169,9 @@ export default class MongoStore<
     >,
   >(
     object: UpsertPartialObject<MongoKeyPath, KeyValue, Model, K>,
-    setOnInsertPartialObject?: Update<Model>['$setOnInsert'],
+    setOnInsertPartialObject?: Update<Model>["$setOnInsert"],
   ): Promise<MongoUpsertResult<KeyValue, Model>> {
-    const $setOnInsert: Update<Model>['$setOnInsert'] = {
+    const $setOnInsert: Update<Model>["$setOnInsert"] = {
       // @ts-expect-error -- created is Date as set in BaseModel
       created: object.created || new Date(),
       ...setOnInsertPartialObject,
@@ -208,7 +215,7 @@ export default class MongoStore<
     );
     if (!commandResult.acknowledged) {
       console.error(commandResult);
-      throw new Error('Update failed');
+      throw new Error("Update failed");
     }
     const object = await this.findByKey(key);
     return object!;
@@ -261,12 +268,14 @@ export default class MongoStore<
   async cursor<Result extends Partial<Model> = Model>(
     filter?: Criteria<Model>,
     sort?: Sort<Model>,
+    fields?: Fields<Model>,
   ): Promise<MongoCursor<Model, Result, KeyValue>> {
     const collection = await this.collection;
     const findCursor = filter
       ? collection.find<Result>(filter as Filter<Model>)
       : (collection.find() as unknown as FindCursor<Result>);
     if (sort) findCursor.sort(sort);
+    if (fields) findCursor.project(fields);
     return new MongoCursor<Model, Result, KeyValue>(this, findCursor);
   }
 

package/src/createMongoSubscribeStore.ts

@@ -1,12 +1,12 @@
-import type { AllowedKeyValue } from 'liwi-store';
-import { SubscribeStore } from 'liwi-subscribe-store';
+import type { AllowedKeyValue } from "liwi-store";
+import { SubscribeStore } from "liwi-subscribe-store";
 import type {
   MongoBaseModel,
   MongoInsertType,
   MongoKeyPath,
-} from './MongoBaseModel';
-import type MongoConnection from './MongoConnection';
-import type MongoStore from './MongoStore';
+} from "./MongoBaseModel";
+import type MongoConnection from "./MongoConnection";
+import type MongoStore from "./MongoStore";
 
 export default function createMongoSubscribeStore<
   Model extends MongoBaseModel<KeyValue>,
@@ -23,3 +23,5 @@ export default function createMongoSubscribeStore<
 > {
   return new SubscribeStore(mongoStore);
 }
+
+export { type SubscribeStore } from "liwi-subscribe-store";

package/src/index.ts

@@ -2,10 +2,16 @@ export type {
   MongoBaseModel,
   MongoKeyPath,
   MongoInsertType,
-} from './MongoBaseModel';
+} from "./MongoBaseModel";
 
-export type { Update } from 'liwi-store';
+export type { Update } from "liwi-store";
 
-export { default as MongoStore } from './MongoStore';
-export { default as MongoConnection } from './MongoConnection';
-export { default as createMongoSubscribeStore } from './createMongoSubscribeStore';
+export { default as MongoStore } from "./MongoStore.ts";
+export {
+  default as MongoConnection,
+  type MongoConfig,
+} from "./MongoConnection.ts";
+export {
+  default as createMongoSubscribeStore,
+  type SubscribeStore,
+} from "./createMongoSubscribeStore.ts";