@atscript/moost-mongo 0.0.19 → 0.0.21

package/dist/index.cjs

@@ -59,7 +59,7 @@ let SelectControlDto = class SelectControlDto$1 {};
 _define_property$1(SelectControlDto, "__is_atscript_annotated_type", true);
 _define_property$1(SelectControlDto, "type", {});
 _define_property$1(SelectControlDto, "metadata", new Map());
-(0, __atscript_typescript.defineAnnotatedType)("object", QueryControlsDto).prop("$skip", (0, __atscript_typescript.defineAnnotatedType)().designType("number").tags("positive", "int", "number").annotate("expect.min", 0).annotate("expect.int", true).optional().$type).prop("$limit", (0, __atscript_typescript.defineAnnotatedType)().designType("number").tags("positive", "int", "number").annotate("expect.min", 0).annotate("expect.int", true).optional().$type).prop("$count", (0, __atscript_typescript.defineAnnotatedType)().designType("boolean").tags("boolean").optional().$type).prop("$sort", (0, __atscript_typescript.defineAnnotatedType)().refTo(SortControlDto).optional().$type).prop("$select", (0, __atscript_typescript.defineAnnotatedType)().refTo(SelectControlDto).optional().$type);
+(0, __atscript_typescript.defineAnnotatedType)("object", QueryControlsDto).prop("$skip", (0, __atscript_typescript.defineAnnotatedType)().designType("number").tags("positive", "int", "number").annotate("expect.min", 0).annotate("expect.int", true).optional().$type).prop("$limit", (0, __atscript_typescript.defineAnnotatedType)().designType("number").tags("positive", "int", "number").annotate("expect.min", 0).annotate("expect.int", true).optional().$type).prop("$count", (0, __atscript_typescript.defineAnnotatedType)().designType("boolean").tags("boolean").optional().$type).prop("$sort", (0, __atscript_typescript.defineAnnotatedType)().refTo(SortControlDto).optional().$type).prop("$select", (0, __atscript_typescript.defineAnnotatedType)().refTo(SelectControlDto).optional().$type).prop("$search", (0, __atscript_typescript.defineAnnotatedType)().designType("string").tags("string").optional().$type).prop("$index", (0, __atscript_typescript.defineAnnotatedType)().designType("string").tags("string").optional().$type);
 (0, __atscript_typescript.defineAnnotatedType)("object", PagesControlsDto).prop("$page", (0, __atscript_typescript.defineAnnotatedType)().designType("string").tags("string").annotate("expect.pattern", {
 	pattern: "^\\d+$",
 	flags: "u",
@@ -68,7 +68,7 @@ _define_property$1(SelectControlDto, "metadata", new Map());
 	pattern: "^\\d+$",
 	flags: "u",
 	message: "Expected positive number"
-}, true).optional().$type).prop("$sort", (0, __atscript_typescript.defineAnnotatedType)().refTo(SortControlDto).optional().$type).prop("$select", (0, __atscript_typescript.defineAnnotatedType)().refTo(SelectControlDto).optional().$type);
+}, true).optional().$type).prop("$sort", (0, __atscript_typescript.defineAnnotatedType)().refTo(SortControlDto).optional().$type).prop("$select", (0, __atscript_typescript.defineAnnotatedType)().refTo(SelectControlDto).optional().$type).prop("$search", (0, __atscript_typescript.defineAnnotatedType)().designType("string").tags("string").optional().$type).prop("$index", (0, __atscript_typescript.defineAnnotatedType)().designType("string").tags("string").optional().$type);
 (0, __atscript_typescript.defineAnnotatedType)("object", GetOneControlsDto).prop("$select", (0, __atscript_typescript.defineAnnotatedType)().refTo(SelectControlDto).optional().$type);
 (0, __atscript_typescript.defineAnnotatedType)("object", SortControlDto).propPattern(/./, (0, __atscript_typescript.defineAnnotatedType)("union").item((0, __atscript_typescript.defineAnnotatedType)().designType("number").value(1).$type).item((0, __atscript_typescript.defineAnnotatedType)().designType("number").value(-1).$type).$type);
 (0, __atscript_typescript.defineAnnotatedType)("object", SelectControlDto).propPattern(/./, (0, __atscript_typescript.defineAnnotatedType)("union").item((0, __atscript_typescript.defineAnnotatedType)().designType("number").value(1).$type).item((0, __atscript_typescript.defineAnnotatedType)().designType("number").value(0).$type).$type);
@@ -206,6 +206,14 @@ var AsMongoController = class {
 		return projection;
 	}
 	/**
+	* Allows subclasses to transform or modify the filter before querying.
+	*
+	* @param filter - The original filter object.
+	* @returns The transformed filter object (may return `Promise`).
+	*/ transformFilter(filter) {
+		return filter;
+	}
+	/**
 	* Builds MongoDB `FindOptions` object out of URLQL controls.
 	*
 	* @param controls - Parsed `controls` object.
@@ -218,6 +226,25 @@ var AsMongoController = class {
 		};
 	}
 	/**
+	* Prepares a MongoDB $search stage for text-based searching.
+	*
+	* @param searchTerm - The text string to search for. If not provided, no search is performed.
+	* @param indexName - The name of the Atlas Search index to use. If not provided, the default index is used.
+	* @returns A $search pipeline stage or an error string if the index is not found. Returns undefined if no searchTerm is provided.
+	*/ prepareSearch(searchTerm, indexName) {
+		if (!searchTerm) return undefined;
+		const index = this.asCollection.getSearchIndex(indexName);
+		if (!index) return indexName ? `Search index "${indexName}" does not exist` : "No search index found";
+		if (!index.key) return `Invalid index definition: missing index key`;
+		return { $search: {
+			index: index.key,
+			text: {
+				query: searchTerm,
+				path: { wildcard: "*" }
+			}
+		} };
+	}
+	/**
 	* **GET /query** – returns an array of documents or a count depending on
 	* presence of `$count` control.
 	*
@@ -228,7 +255,19 @@ var AsMongoController = class {
 		const parsed = (0, urlql.parseUrlql)(query);
 		const error = await this.validateUrlql(parsed, "query");
 		if (error) return error;
-		return parsed.controls.$count ? this.asCollection.collection.countDocuments(parsed.filter) : this.asCollection.collection.find(parsed.filter, this.prepareQueryOptions(parsed.controls)).toArray();
+		if (parsed.controls.$count) return this.asCollection.collection.countDocuments(parsed.filter);
+		const search = this.prepareSearch(parsed.controls.$search, parsed.controls.$index);
+		if (typeof search === "string") return new __moostjs_event_http.HttpError(400, search);
+		const { projection, sort, limit, skip } = this.prepareQueryOptions(parsed.controls);
+		const pipeline = [];
+		if (search) pipeline.push(search);
+		pipeline.push({ $match: this.transformFilter(parsed.filter) });
+		if (sort) pipeline.push({ $sort: sort });
+		if (skip) pipeline.push({ $skip: skip });
+		if (limit) pipeline.push({ $limit: limit });
+else pipeline.push({ $limit: 1e3 });
+		if (projection) pipeline.push({ $project: projection });
+		return this.asCollection.collection.aggregate(pipeline).toArray();
 	}
 	/**
 	* **GET /pages** – returns paginated documents plus basic pagination meta.
@@ -240,19 +279,24 @@ var AsMongoController = class {
 		const parsed = (0, urlql.parseUrlql)(query);
 		const error = await this.validateUrlql(parsed, "pages");
 		if (error) return error;
+		const search = this.prepareSearch(parsed.controls.$search, parsed.controls.$index);
+		if (typeof search === "string") return new __moostjs_event_http.HttpError(400, search);
 		const controls = parsed.controls;
 		const page = Math.max(Number(controls.$page || 1), 1);
 		const size = Math.max(Number(controls.$size || 10), 1);
 		const skip = (page - 1) * size;
-		const result = await this.asCollection.collection.aggregate([{ $match: parsed.filter }, { $facet: {
+		const pipeline = [];
+		if (search) pipeline.push(search);
+		pipeline.push({ $match: this.transformFilter(parsed.filter) }, { $facet: {
 			documents: [
 				controls.$sort ? { $sort: controls.$sort } : undefined,
 				{ $skip: skip },
 				{ $limit: size },
-				controls.$select ? { $project: controls.$select } : undefined
+				controls.$select ? { $project: this.transformProjection(controls.$select) } : undefined
 			].filter(Boolean),
 			meta: [{ $count: "count" }]
-		} }]).toArray();
+		} });
+		const result = await this.asCollection.collection.aggregate(pipeline).toArray();
 		const totalDocuments = result[0].meta[0].count;
 		return {
 			documents: result[0].documents,

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { TConsoleBase, Moost } from 'moost';
 import { UrlqlQuery } from 'urlql';
 import { AsMongo, AsCollection } from '@atscript/mongo';
 import { TAtscriptAnnotatedTypeConstructor, ValidatorError } from '@atscript/typescript';
-import { WithId, InsertOneResult, InsertManyResult, UpdateResult, DeleteResult, DeleteOptions, ObjectId, OptionalUnlessRequiredId, InsertOneOptions, BulkWriteOptions, WithoutId, ReplaceOptions, UpdateFilter, UpdateOptions } from 'mongodb';
+import { Document, WithId, InsertOneResult, InsertManyResult, UpdateResult, DeleteResult, DeleteOptions, ObjectId, OptionalUnlessRequiredId, InsertOneOptions, BulkWriteOptions, WithoutId, ReplaceOptions, UpdateFilter, UpdateOptions } from 'mongodb';
 
 /**
  * Generic **Moost** controller that exposes a full REST‑style CRUD surface over a
@@ -106,6 +106,13 @@ declare class AsMongoController<T extends TAtscriptAnnotatedTypeConstructor> {
      * @returns Adjusted projection (may return `Promise`).
      */
     protected transformProjection(projection?: Record<string, 0 | 1>): Record<string, 1> | Record<string, 0> | undefined | Promise<Record<string, 1> | Record<string, 0> | undefined>;
+    /**
+     * Allows subclasses to transform or modify the filter before querying.
+     *
+     * @param filter - The original filter object.
+     * @returns The transformed filter object (may return `Promise`).
+     */
+    protected transformFilter(filter: Document): Document;
     /**
      * Builds MongoDB `FindOptions` object out of URLQL controls.
      *
@@ -117,6 +124,14 @@ declare class AsMongoController<T extends TAtscriptAnnotatedTypeConstructor> {
         limit: number | undefined;
         skip: number | undefined;
     };
+    /**
+     * Prepares a MongoDB $search stage for text-based searching.
+     *
+     * @param searchTerm - The text string to search for. If not provided, no search is performed.
+     * @param indexName - The name of the Atlas Search index to use. If not provided, the default index is used.
+     * @returns A $search pipeline stage or an error string if the index is not found. Returns undefined if no searchTerm is provided.
+     */
+    protected prepareSearch(searchTerm?: string, indexName?: string): string | undefined | Document;
     /**
      * **GET /query** – returns an array of documents or a count depending on
      * presence of `$count` control.
@@ -162,19 +177,19 @@ declare class AsMongoController<T extends TAtscriptAnnotatedTypeConstructor> {
      *
      * @param payload - Raw request body to be inserted.
      */
-    insert(payload: any): Promise<HttpError | InsertOneResult | InsertManyResult>;
+    insert(payload: Parameters<AsCollection<T>['prepareInsert']>[0]): Promise<HttpError | InsertOneResult | InsertManyResult>;
     /**
      * **PUT /** – fully replaces a document matched by `_id`.
      *
      * @param payload - Object containing `_id` plus full replacement document.
      */
-    replace(payload: any): Promise<HttpError | UpdateResult<InstanceType<T>>>;
+    replace(payload: Parameters<AsCollection<T>['prepareReplace']>[0]): Promise<HttpError | UpdateResult<InstanceType<T>>>;
     /**
      * **PATCH /** – updates one document using MongoDB update operators.
      *
      * @param payload - Update payload produced by `asCollection.prepareUpdate`.
      */
-    update(payload: any): Promise<HttpError | UpdateResult>;
+    update(payload: Parameters<AsCollection<T>['prepareUpdate']>[0]): Promise<HttpError | UpdateResult>;
     /**
      * **DELETE /:id** – removes a single document by `_id`.
      *

package/dist/index.mjs

@@ -35,7 +35,7 @@ let SelectControlDto = class SelectControlDto$1 {};
 _define_property$1(SelectControlDto, "__is_atscript_annotated_type", true);
 _define_property$1(SelectControlDto, "type", {});
 _define_property$1(SelectControlDto, "metadata", new Map());
-defineAnnotatedType("object", QueryControlsDto).prop("$skip", defineAnnotatedType().designType("number").tags("positive", "int", "number").annotate("expect.min", 0).annotate("expect.int", true).optional().$type).prop("$limit", defineAnnotatedType().designType("number").tags("positive", "int", "number").annotate("expect.min", 0).annotate("expect.int", true).optional().$type).prop("$count", defineAnnotatedType().designType("boolean").tags("boolean").optional().$type).prop("$sort", defineAnnotatedType().refTo(SortControlDto).optional().$type).prop("$select", defineAnnotatedType().refTo(SelectControlDto).optional().$type);
+defineAnnotatedType("object", QueryControlsDto).prop("$skip", defineAnnotatedType().designType("number").tags("positive", "int", "number").annotate("expect.min", 0).annotate("expect.int", true).optional().$type).prop("$limit", defineAnnotatedType().designType("number").tags("positive", "int", "number").annotate("expect.min", 0).annotate("expect.int", true).optional().$type).prop("$count", defineAnnotatedType().designType("boolean").tags("boolean").optional().$type).prop("$sort", defineAnnotatedType().refTo(SortControlDto).optional().$type).prop("$select", defineAnnotatedType().refTo(SelectControlDto).optional().$type).prop("$search", defineAnnotatedType().designType("string").tags("string").optional().$type).prop("$index", defineAnnotatedType().designType("string").tags("string").optional().$type);
 defineAnnotatedType("object", PagesControlsDto).prop("$page", defineAnnotatedType().designType("string").tags("string").annotate("expect.pattern", {
 	pattern: "^\\d+$",
 	flags: "u",
@@ -44,7 +44,7 @@ defineAnnotatedType("object", PagesControlsDto).prop("$page", defineAnnotatedTyp
 	pattern: "^\\d+$",
 	flags: "u",
 	message: "Expected positive number"
-}, true).optional().$type).prop("$sort", defineAnnotatedType().refTo(SortControlDto).optional().$type).prop("$select", defineAnnotatedType().refTo(SelectControlDto).optional().$type);
+}, true).optional().$type).prop("$sort", defineAnnotatedType().refTo(SortControlDto).optional().$type).prop("$select", defineAnnotatedType().refTo(SelectControlDto).optional().$type).prop("$search", defineAnnotatedType().designType("string").tags("string").optional().$type).prop("$index", defineAnnotatedType().designType("string").tags("string").optional().$type);
 defineAnnotatedType("object", GetOneControlsDto).prop("$select", defineAnnotatedType().refTo(SelectControlDto).optional().$type);
 defineAnnotatedType("object", SortControlDto).propPattern(/./, defineAnnotatedType("union").item(defineAnnotatedType().designType("number").value(1).$type).item(defineAnnotatedType().designType("number").value(-1).$type).$type);
 defineAnnotatedType("object", SelectControlDto).propPattern(/./, defineAnnotatedType("union").item(defineAnnotatedType().designType("number").value(1).$type).item(defineAnnotatedType().designType("number").value(0).$type).$type);
@@ -182,6 +182,14 @@ var AsMongoController = class {
 		return projection;
 	}
 	/**
+	* Allows subclasses to transform or modify the filter before querying.
+	*
+	* @param filter - The original filter object.
+	* @returns The transformed filter object (may return `Promise`).
+	*/ transformFilter(filter) {
+		return filter;
+	}
+	/**
 	* Builds MongoDB `FindOptions` object out of URLQL controls.
 	*
 	* @param controls - Parsed `controls` object.
@@ -194,6 +202,25 @@ var AsMongoController = class {
 		};
 	}
 	/**
+	* Prepares a MongoDB $search stage for text-based searching.
+	*
+	* @param searchTerm - The text string to search for. If not provided, no search is performed.
+	* @param indexName - The name of the Atlas Search index to use. If not provided, the default index is used.
+	* @returns A $search pipeline stage or an error string if the index is not found. Returns undefined if no searchTerm is provided.
+	*/ prepareSearch(searchTerm, indexName) {
+		if (!searchTerm) return undefined;
+		const index = this.asCollection.getSearchIndex(indexName);
+		if (!index) return indexName ? `Search index "${indexName}" does not exist` : "No search index found";
+		if (!index.key) return `Invalid index definition: missing index key`;
+		return { $search: {
+			index: index.key,
+			text: {
+				query: searchTerm,
+				path: { wildcard: "*" }
+			}
+		} };
+	}
+	/**
 	* **GET /query** – returns an array of documents or a count depending on
 	* presence of `$count` control.
 	*
@@ -204,7 +231,19 @@ var AsMongoController = class {
 		const parsed = parseUrlql(query);
 		const error = await this.validateUrlql(parsed, "query");
 		if (error) return error;
-		return parsed.controls.$count ? this.asCollection.collection.countDocuments(parsed.filter) : this.asCollection.collection.find(parsed.filter, this.prepareQueryOptions(parsed.controls)).toArray();
+		if (parsed.controls.$count) return this.asCollection.collection.countDocuments(parsed.filter);
+		const search = this.prepareSearch(parsed.controls.$search, parsed.controls.$index);
+		if (typeof search === "string") return new HttpError(400, search);
+		const { projection, sort, limit, skip } = this.prepareQueryOptions(parsed.controls);
+		const pipeline = [];
+		if (search) pipeline.push(search);
+		pipeline.push({ $match: this.transformFilter(parsed.filter) });
+		if (sort) pipeline.push({ $sort: sort });
+		if (skip) pipeline.push({ $skip: skip });
+		if (limit) pipeline.push({ $limit: limit });
+else pipeline.push({ $limit: 1e3 });
+		if (projection) pipeline.push({ $project: projection });
+		return this.asCollection.collection.aggregate(pipeline).toArray();
 	}
 	/**
 	* **GET /pages** – returns paginated documents plus basic pagination meta.
@@ -216,19 +255,24 @@ var AsMongoController = class {
 		const parsed = parseUrlql(query);
 		const error = await this.validateUrlql(parsed, "pages");
 		if (error) return error;
+		const search = this.prepareSearch(parsed.controls.$search, parsed.controls.$index);
+		if (typeof search === "string") return new HttpError(400, search);
 		const controls = parsed.controls;
 		const page = Math.max(Number(controls.$page || 1), 1);
 		const size = Math.max(Number(controls.$size || 10), 1);
 		const skip = (page - 1) * size;
-		const result = await this.asCollection.collection.aggregate([{ $match: parsed.filter }, { $facet: {
+		const pipeline = [];
+		if (search) pipeline.push(search);
+		pipeline.push({ $match: this.transformFilter(parsed.filter) }, { $facet: {
 			documents: [
 				controls.$sort ? { $sort: controls.$sort } : undefined,
 				{ $skip: skip },
 				{ $limit: size },
-				controls.$select ? { $project: controls.$select } : undefined
+				controls.$select ? { $project: this.transformProjection(controls.$select) } : undefined
 			].filter(Boolean),
 			meta: [{ $count: "count" }]
-		} }]).toArray();
+		} });
+		const result = await this.asCollection.collection.aggregate(pipeline).toArray();
 		const totalDocuments = result[0].meta[0].count;
 		return {
 			documents: result[0].documents,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atscript/moost-mongo",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "Atscript Mongo for Moost.",
   "type": "module",
   "main": "dist/index.mjs",
@@ -44,8 +44,8 @@
     "@moostjs/event-http": "^0.5.31",
     "mongodb": "^6.17.0",
     "moost": "^0.5.31",
-    "@atscript/mongo": "^0.0.19",
-    "@atscript/typescript": "^0.0.19"
+    "@atscript/mongo": "^0.0.21",
+    "@atscript/typescript": "^0.0.21"
   },
   "scripts": {
     "pub": "pnpm publish --access public",