@atscript/moost-db 0.1.103 → 0.1.104

package/dist/index.cjs

@@ -980,6 +980,25 @@ const QUERY_CONTROLS = [
 ];
 const PAGES_CONTROLS = ["filter", ...dtoControls(PagesControlsDto)];
 const ONE_CONTROLS = dtoControls(GetOneControlsDto);
+/**
+* Controls accepted by the `/geo` endpoint. No backing DTO — `$center` /
+* `$maxDistance` / `$minDistance` are parsed and validated by the handler.
+*/
+const GEO_CONTROLS = [
+	"filter",
+	"insights",
+	"center",
+	"maxDistance",
+	"minDistance",
+	"index",
+	"select",
+	"skip",
+	"limit",
+	"page",
+	"size",
+	"with",
+	"actions"
+];
 //#endregion
 //#region src/as-db-readable.controller.ts
 let AsDbReadableController = class AsDbReadableController extends AsReadableController {
@@ -1413,6 +1432,82 @@ let AsDbReadableController = class AsDbReadableController extends AsReadableCont
 		};
 	}
 	/**
+	* **GET /geo** — distance-ranked geospatial search (mirrors the search /
+	* vector read endpoints; geo-index spec §7).
+	*
+	* URL controls: `$center=lng,lat` (required), `$maxDistance` / `$minDistance`
+	* (meters), `$index` (geo index name), plus the standard filter / `$select` /
+	* `$with` / pagination syntax. Each row carries a computed `$distance`
+	* (meters). With `$page` / `$size` the response is the `/pages` envelope;
+	* otherwise a plain row array (`$skip` / `$limit` compose).
+	*/
+	async geo(url) {
+		const parsed = this.parseQueryString(url);
+		const controls = parsed.controls;
+		this._coerceActionsControl(controls);
+		const point = this._parseGeoCenter(controls.$center);
+		if (point instanceof _moostjs_event_http.HttpError) return point;
+		for (const key of ["$maxDistance", "$minDistance"]) if (controls[key] !== void 0) {
+			const num = Number(controls[key]);
+			if (!Number.isFinite(num) || num < 0) return new _moostjs_event_http.HttpError(400, `${key} must be a non-negative number of meters`);
+			controls[key] = num;
+		}
+		const indexName = typeof controls.$index === "string" ? controls.$index : void 0;
+		if (parsed.insights) {
+			const insightsError = this.validateInsights(parsed.insights);
+			if (insightsError) return new _moostjs_event_http.HttpError(400, insightsError);
+		}
+		const gateError = this.checkGates(parsed.filter, controls, this._gates);
+		if (gateError) return gateError;
+		const [filter, rawSelect] = await Promise.all([this.transformFilter(parsed.filter), this.transformProjection(controls.$select)]);
+		const select = this.widenPreferredIdProjection(rawSelect);
+		if (select instanceof _moostjs_event_http.HttpError) return select;
+		const paginated = controls.$page !== void 0 || controls.$size !== void 0;
+		const page = Math.max(Number(controls.$page || 1), 1);
+		const size = Math.max(Number(controls.$size || 10), 1);
+		const queryObj = {
+			filter,
+			controls: {
+				...controls,
+				$center: void 0,
+				$index: void 0,
+				$select: select,
+				...paginated ? {
+					$skip: (page - 1) * size,
+					$limit: size
+				} : { $limit: controls.$limit || 1e3 }
+			}
+		};
+		if (paginated) {
+			const result = await this._runReadWithActions(queryObj, controls, select, async (q) => indexName ? this.readable.geoSearchWithCount(indexName, point, q) : this.readable.geoSearchWithCount(point, q));
+			return {
+				data: result.data,
+				page,
+				itemsPerPage: size,
+				pages: Math.ceil(result.count / size),
+				count: result.count
+			};
+		}
+		return (await this._runReadWithActions(queryObj, controls, select, async (q) => ({ data: await (indexName ? this.readable.geoSearch(indexName, point, q) : this.readable.geoSearch(point, q)) }))).data;
+	}
+	/** Parses the `$center` control: `"lng,lat"` string (or tuple) → `[number, number]`. */
+	_parseGeoCenter(raw) {
+		let lng;
+		let lat;
+		if (typeof raw === "string") {
+			const parts = raw.split(",");
+			if (parts.length === 2) {
+				lng = Number(parts[0]);
+				lat = Number(parts[1]);
+			}
+		} else if (Array.isArray(raw) && raw.length === 2) {
+			lng = Number(raw[0]);
+			lat = Number(raw[1]);
+		}
+		if (lng === void 0 || lat === void 0 || !Number.isFinite(lng) || !Number.isFinite(lat)) return new _moostjs_event_http.HttpError(400, "$center is required: $center=lng,lat (GeoJSON order)");
+		return [lng, lat];
+	}
+	/**
 	* **GET /one/:id** — retrieves a single record by ID or unique property.
 	* The id-filter is AND-combined with {@link transformOne} so row-level
 	* read overlays gate `/one` symmetrically with `/query` / `/pages`.
@@ -1486,6 +1581,10 @@ let AsDbReadableController = class AsDbReadableController extends AsReadableCont
 		});
 		const filterableMode = this.readable.type.metadata.get("db.table.filterable") === "manual";
 		const sortableMode = this.readable.type.metadata.get("db.table.sortable") === "manual";
+		const geoIndexedPhysical = /* @__PURE__ */ new Set();
+		if (this.readable.indexes instanceof Map) {
+			for (const index of this.readable.indexes.values()) if (index.type === "geo") for (const f of index.fields) geoIndexedPhysical.add(f.name);
+		}
 		const fields = {};
 		for (const fd of this.readable.fieldDescriptors) {
 			if (fd.ignored) continue;
@@ -1499,10 +1598,13 @@ let AsDbReadableController = class AsDbReadableController extends AsReadableCont
 				sortable: adapterCanSort && (sortableMode ? annotatedSortable : !!fd.isIndexed),
 				filterable: adapterCanFilter && (filterableMode ? annotatedFilterable : true)
 			};
+			if (fd.encrypted) fields[fd.path].encrypted = true;
+			if (geoIndexedPhysical.has(fd.physicalName)) fields[fd.path].geo = true;
 		}
 		return {
 			searchable: this.readable.isSearchable(),
 			vectorSearchable: this.readable.isVectorSearchable(),
+			geoSearchable: this._isGeoSearchable(),
 			searchIndexes: this.readable.getSearchIndexes(),
 			primaryKeys: [...this.readable.primaryKeys],
 			preferredId: [...this.readable.preferredId],
@@ -1519,9 +1621,17 @@ let AsDbReadableController = class AsDbReadableController extends AsReadableCont
 			...super.buildCrud(),
 			query: [...QUERY_CONTROLS],
 			pages: [...PAGES_CONTROLS],
-			one: [...ONE_CONTROLS]
+			one: [...ONE_CONTROLS],
+			...this._isGeoSearchable() ? { geo: [...GEO_CONTROLS] } : {}
 		};
 	}
+	/** Adapter supports geo search AND the table declares at least one geo index. */
+	_isGeoSearchable() {
+		if (typeof this.readable.isGeoSearchable !== "function" || !this.readable.isGeoSearchable()) return false;
+		if (!(this.readable.indexes instanceof Map)) return false;
+		for (const index of this.readable.indexes.values()) if (index.type === "geo") return true;
+		return false;
+	}
 };
 __decorate([
 	(0, _moostjs_event_http.Get)("query"),
@@ -1537,6 +1647,13 @@ __decorate([
 	__decorateMetadata("design:paramtypes", [String]),
 	__decorateMetadata("design:returntype", Promise)
 ], AsDbReadableController.prototype, "pages", null);
+__decorate([
+	(0, _moostjs_event_http.Get)("geo"),
+	__decorateParam(0, (0, _moostjs_event_http.Url)()),
+	__decorateMetadata("design:type", Function),
+	__decorateMetadata("design:paramtypes", [String]),
+	__decorateMetadata("design:returntype", Promise)
+], AsDbReadableController.prototype, "geo", null);
 __decorate([
 	(0, _moostjs_event_http.Get)("one/:id"),
 	__decorateParam(0, (0, moost.Param)("id")),

package/dist/index.d.cts

@@ -263,6 +263,25 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
     pages: number;
     count: number;
   } | HttpError>;
+  /**
+   * **GET /geo** — distance-ranked geospatial search (mirrors the search /
+   * vector read endpoints; geo-index spec §7).
+   *
+   * URL controls: `$center=lng,lat` (required), `$maxDistance` / `$minDistance`
+   * (meters), `$index` (geo index name), plus the standard filter / `$select` /
+   * `$with` / pagination syntax. Each row carries a computed `$distance`
+   * (meters). With `$page` / `$size` the response is the `/pages` envelope;
+   * otherwise a plain row array (`$skip` / `$limit` compose).
+   */
+  geo(url: string): Promise<DataType[] | {
+    data: DataType[];
+    page: number;
+    itemsPerPage: number;
+    pages: number;
+    count: number;
+  } | HttpError>;
+  /** Parses the `$center` control: `"lng,lat"` string (or tuple) → `[number, number]`. */
+  private _parseGeoCenter;
   /**
    * **GET /one/:id** — retrieves a single record by ID or unique property.
    * The id-filter is AND-combined with {@link transformOne} so row-level
@@ -285,6 +304,8 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
    */
   protected buildMetaResponse(): TMetaResponse;
   protected buildCrud(): TCrudPermissions$1;
+  /** Adapter supports geo search AND the table declares at least one geo index. */
+  private _isGeoSearchable;
 }
 //#endregion
 //#region src/as-db.controller.d.ts

package/dist/index.d.mts

@@ -263,6 +263,25 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
     pages: number;
     count: number;
   } | HttpError>;
+  /**
+   * **GET /geo** — distance-ranked geospatial search (mirrors the search /
+   * vector read endpoints; geo-index spec §7).
+   *
+   * URL controls: `$center=lng,lat` (required), `$maxDistance` / `$minDistance`
+   * (meters), `$index` (geo index name), plus the standard filter / `$select` /
+   * `$with` / pagination syntax. Each row carries a computed `$distance`
+   * (meters). With `$page` / `$size` the response is the `/pages` envelope;
+   * otherwise a plain row array (`$skip` / `$limit` compose).
+   */
+  geo(url: string): Promise<DataType[] | {
+    data: DataType[];
+    page: number;
+    itemsPerPage: number;
+    pages: number;
+    count: number;
+  } | HttpError>;
+  /** Parses the `$center` control: `"lng,lat"` string (or tuple) → `[number, number]`. */
+  private _parseGeoCenter;
   /**
    * **GET /one/:id** — retrieves a single record by ID or unique property.
    * The id-filter is AND-combined with {@link transformOne} so row-level
@@ -285,6 +304,8 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
    */
   protected buildMetaResponse(): TMetaResponse;
   protected buildCrud(): TCrudPermissions$1;
+  /** Adapter supports geo search AND the table declares at least one geo index. */
+  private _isGeoSearchable;
 }
 //#endregion
 //#region src/as-db.controller.d.ts

package/dist/index.mjs

@@ -979,6 +979,25 @@ const QUERY_CONTROLS = [
 ];
 const PAGES_CONTROLS = ["filter", ...dtoControls(PagesControlsDto)];
 const ONE_CONTROLS = dtoControls(GetOneControlsDto);
+/**
+* Controls accepted by the `/geo` endpoint. No backing DTO — `$center` /
+* `$maxDistance` / `$minDistance` are parsed and validated by the handler.
+*/
+const GEO_CONTROLS = [
+	"filter",
+	"insights",
+	"center",
+	"maxDistance",
+	"minDistance",
+	"index",
+	"select",
+	"skip",
+	"limit",
+	"page",
+	"size",
+	"with",
+	"actions"
+];
 //#endregion
 //#region src/as-db-readable.controller.ts
 let AsDbReadableController = class AsDbReadableController extends AsReadableController {
@@ -1412,6 +1431,82 @@ let AsDbReadableController = class AsDbReadableController extends AsReadableCont
 		};
 	}
 	/**
+	* **GET /geo** — distance-ranked geospatial search (mirrors the search /
+	* vector read endpoints; geo-index spec §7).
+	*
+	* URL controls: `$center=lng,lat` (required), `$maxDistance` / `$minDistance`
+	* (meters), `$index` (geo index name), plus the standard filter / `$select` /
+	* `$with` / pagination syntax. Each row carries a computed `$distance`
+	* (meters). With `$page` / `$size` the response is the `/pages` envelope;
+	* otherwise a plain row array (`$skip` / `$limit` compose).
+	*/
+	async geo(url) {
+		const parsed = this.parseQueryString(url);
+		const controls = parsed.controls;
+		this._coerceActionsControl(controls);
+		const point = this._parseGeoCenter(controls.$center);
+		if (point instanceof HttpError) return point;
+		for (const key of ["$maxDistance", "$minDistance"]) if (controls[key] !== void 0) {
+			const num = Number(controls[key]);
+			if (!Number.isFinite(num) || num < 0) return new HttpError(400, `${key} must be a non-negative number of meters`);
+			controls[key] = num;
+		}
+		const indexName = typeof controls.$index === "string" ? controls.$index : void 0;
+		if (parsed.insights) {
+			const insightsError = this.validateInsights(parsed.insights);
+			if (insightsError) return new HttpError(400, insightsError);
+		}
+		const gateError = this.checkGates(parsed.filter, controls, this._gates);
+		if (gateError) return gateError;
+		const [filter, rawSelect] = await Promise.all([this.transformFilter(parsed.filter), this.transformProjection(controls.$select)]);
+		const select = this.widenPreferredIdProjection(rawSelect);
+		if (select instanceof HttpError) return select;
+		const paginated = controls.$page !== void 0 || controls.$size !== void 0;
+		const page = Math.max(Number(controls.$page || 1), 1);
+		const size = Math.max(Number(controls.$size || 10), 1);
+		const queryObj = {
+			filter,
+			controls: {
+				...controls,
+				$center: void 0,
+				$index: void 0,
+				$select: select,
+				...paginated ? {
+					$skip: (page - 1) * size,
+					$limit: size
+				} : { $limit: controls.$limit || 1e3 }
+			}
+		};
+		if (paginated) {
+			const result = await this._runReadWithActions(queryObj, controls, select, async (q) => indexName ? this.readable.geoSearchWithCount(indexName, point, q) : this.readable.geoSearchWithCount(point, q));
+			return {
+				data: result.data,
+				page,
+				itemsPerPage: size,
+				pages: Math.ceil(result.count / size),
+				count: result.count
+			};
+		}
+		return (await this._runReadWithActions(queryObj, controls, select, async (q) => ({ data: await (indexName ? this.readable.geoSearch(indexName, point, q) : this.readable.geoSearch(point, q)) }))).data;
+	}
+	/** Parses the `$center` control: `"lng,lat"` string (or tuple) → `[number, number]`. */
+	_parseGeoCenter(raw) {
+		let lng;
+		let lat;
+		if (typeof raw === "string") {
+			const parts = raw.split(",");
+			if (parts.length === 2) {
+				lng = Number(parts[0]);
+				lat = Number(parts[1]);
+			}
+		} else if (Array.isArray(raw) && raw.length === 2) {
+			lng = Number(raw[0]);
+			lat = Number(raw[1]);
+		}
+		if (lng === void 0 || lat === void 0 || !Number.isFinite(lng) || !Number.isFinite(lat)) return new HttpError(400, "$center is required: $center=lng,lat (GeoJSON order)");
+		return [lng, lat];
+	}
+	/**
 	* **GET /one/:id** — retrieves a single record by ID or unique property.
 	* The id-filter is AND-combined with {@link transformOne} so row-level
 	* read overlays gate `/one` symmetrically with `/query` / `/pages`.
@@ -1485,6 +1580,10 @@ let AsDbReadableController = class AsDbReadableController extends AsReadableCont
 		});
 		const filterableMode = this.readable.type.metadata.get("db.table.filterable") === "manual";
 		const sortableMode = this.readable.type.metadata.get("db.table.sortable") === "manual";
+		const geoIndexedPhysical = /* @__PURE__ */ new Set();
+		if (this.readable.indexes instanceof Map) {
+			for (const index of this.readable.indexes.values()) if (index.type === "geo") for (const f of index.fields) geoIndexedPhysical.add(f.name);
+		}
 		const fields = {};
 		for (const fd of this.readable.fieldDescriptors) {
 			if (fd.ignored) continue;
@@ -1498,10 +1597,13 @@ let AsDbReadableController = class AsDbReadableController extends AsReadableCont
 				sortable: adapterCanSort && (sortableMode ? annotatedSortable : !!fd.isIndexed),
 				filterable: adapterCanFilter && (filterableMode ? annotatedFilterable : true)
 			};
+			if (fd.encrypted) fields[fd.path].encrypted = true;
+			if (geoIndexedPhysical.has(fd.physicalName)) fields[fd.path].geo = true;
 		}
 		return {
 			searchable: this.readable.isSearchable(),
 			vectorSearchable: this.readable.isVectorSearchable(),
+			geoSearchable: this._isGeoSearchable(),
 			searchIndexes: this.readable.getSearchIndexes(),
 			primaryKeys: [...this.readable.primaryKeys],
 			preferredId: [...this.readable.preferredId],
@@ -1518,9 +1620,17 @@ let AsDbReadableController = class AsDbReadableController extends AsReadableCont
 			...super.buildCrud(),
 			query: [...QUERY_CONTROLS],
 			pages: [...PAGES_CONTROLS],
-			one: [...ONE_CONTROLS]
+			one: [...ONE_CONTROLS],
+			...this._isGeoSearchable() ? { geo: [...GEO_CONTROLS] } : {}
 		};
 	}
+	/** Adapter supports geo search AND the table declares at least one geo index. */
+	_isGeoSearchable() {
+		if (typeof this.readable.isGeoSearchable !== "function" || !this.readable.isGeoSearchable()) return false;
+		if (!(this.readable.indexes instanceof Map)) return false;
+		for (const index of this.readable.indexes.values()) if (index.type === "geo") return true;
+		return false;
+	}
 };
 __decorate([
 	Get("query"),
@@ -1536,6 +1646,13 @@ __decorate([
 	__decorateMetadata("design:paramtypes", [String]),
 	__decorateMetadata("design:returntype", Promise)
 ], AsDbReadableController.prototype, "pages", null);
+__decorate([
+	Get("geo"),
+	__decorateParam(0, Url()),
+	__decorateMetadata("design:type", Function),
+	__decorateMetadata("design:paramtypes", [String]),
+	__decorateMetadata("design:returntype", Promise)
+], AsDbReadableController.prototype, "geo", null);
 __decorate([
 	Get("one/:id"),
 	__decorateParam(0, Param("id")),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atscript/moost-db",
-  "version": "0.1.103",
+  "version": "0.1.104",
   "description": "Generic database controller for Moost with Atscript.",
   "keywords": [
     "annotations",
@@ -58,7 +58,7 @@
     "@wooksjs/event-core": "^0.7.19",
     "@wooksjs/http-body": "^0.7.19",
     "moost": "^0.6.26",
-    "@atscript/db": "^0.1.103"
+    "@atscript/db": "^0.1.104"
   },
   "scripts": {
     "postinstall": "asc -f dts",