@atscript/moost-db 0.1.51 → 0.1.53

package/dist/index.cjs

@@ -329,12 +329,14 @@ let AsDbReadableController = class AsDbReadableController {
 	}
 	/**
 	* Transform filter before querying. Override to add tenant filtering, etc.
+	* May return a Promise for async lookups (session, permissions).
 	*/
 	transformFilter(filter) {
 		return filter;
 	}
 	/**
 	* Transform projection before querying.
+	* May return a Promise for async lookups.
 	*/
 	transformProjection(projection) {
 		return projection;
@@ -393,7 +395,7 @@ let AsDbReadableController = class AsDbReadableController {
 				const insightsError = this.validateInsights(parsed.insights);
 				if (insightsError) return new _moostjs_event_http.HttpError(400, insightsError);
 			}
-			const filter = this.transformFilter(parsed.filter);
+			const filter = await this.transformFilter(parsed.filter);
 			return this.readable.aggregate({
 				filter,
 				controls,
@@ -402,8 +404,7 @@ let AsDbReadableController = class AsDbReadableController {
 		}
 		const error = this.validateParsed(parsed, "query");
 		if (error) return error;
-		const filter = this.transformFilter(parsed.filter);
-		const select = this.transformProjection(controls.$select);
+		const [filter, select] = await Promise.all([this.transformFilter(parsed.filter), this.transformProjection(controls.$select)]);
 		if (controls.$count) return this.readable.count({
 			filter,
 			controls: {
@@ -443,8 +444,7 @@ let AsDbReadableController = class AsDbReadableController {
 		const page = Math.max(Number(controls.$page || 1), 1);
 		const size = Math.max(Number(controls.$size || 10), 1);
 		const skip = (page - 1) * size;
-		const filter = this.transformFilter(parsed.filter);
-		const select = this.transformProjection(controls.$select);
+		const [filter, select] = await Promise.all([this.transformFilter(parsed.filter), this.transformProjection(controls.$select)]);
 		const searchTerm = controls.$search;
 		const indexName = controls.$index;
 		const vectorField = controls.$vector;
@@ -482,7 +482,7 @@ let AsDbReadableController = class AsDbReadableController {
 		if (Object.keys(parsed.filter).length > 0) return new _moostjs_event_http.HttpError(400, "Filtering is not allowed for \"one\" endpoint");
 		const error = this.validateParsed(parsed, "getOne");
 		if (error) return error;
-		const select = this.transformProjection(parsed.controls.$select);
+		const select = await this.transformProjection(parsed.controls.$select);
 		const controls = {
 			...parsed.controls,
 			$select: select
@@ -497,7 +497,7 @@ let AsDbReadableController = class AsDbReadableController {
 		const idObj = this.extractCompositeId(query);
 		if (idObj instanceof _moostjs_event_http.HttpError) return idObj;
 		const parsed = this.parseQueryString(url);
-		const select = this.transformProjection(parsed.controls.$select);
+		const select = await this.transformProjection(parsed.controls.$select);
 		const controls = {
 			...parsed.controls,
 			$select: select
@@ -506,6 +506,11 @@ let AsDbReadableController = class AsDbReadableController {
 	}
 	/**
 	* **GET /meta** — returns table/view metadata for UI.
+	*
+	* The return type includes `Promise<...>` so subclasses can override with an
+	* async implementation (e.g. to enrich the payload from an external source).
+	* The base cache only covers the base payload — async overrides must cache
+	* their own enrichment if needed.
 	*/
 	meta() {
 		if (this._metaResponse) return this._metaResponse;
@@ -523,7 +528,7 @@ let AsDbReadableController = class AsDbReadableController {
 				filterable: true
 			};
 		}
-		this._metaResponse = {
+		const response = {
 			searchable: this.readable.isSearchable(),
 			vectorSearchable: this.readable.isVectorSearchable(),
 			searchIndexes: this.readable.getSearchIndexes(),
@@ -533,7 +538,8 @@ let AsDbReadableController = class AsDbReadableController {
 			fields,
 			type: this.getSerializedType()
 		};
-		return this._metaResponse;
+		this._metaResponse = response;
+		return response;
 	}
 };
 __decorate([
@@ -570,7 +576,7 @@ __decorate([
 	(0, _moostjs_event_http.Get)("meta"),
 	__decorateMetadata("design:type", Function),
 	__decorateMetadata("design:paramtypes", []),
-	__decorateMetadata("design:returntype", void 0)
+	__decorateMetadata("design:returntype", Object)
 ], AsDbReadableController.prototype, "meta", null);
 AsDbReadableController = __decorate([
 	UseValidationErrorTransform(),
@@ -593,12 +599,14 @@ let AsDbController = class AsDbController extends AsDbReadableController {
 	}
 	/**
 	* Intercepts write operations. Return `undefined` to abort.
+	* May be async (e.g. to enrich payloads from session / permissions).
 	*/
 	onWrite(action, data) {
 		return data;
 	}
 	/**
 	* Intercepts delete operations. Return `undefined` to abort.
+	* May be async (e.g. to resolve composite ids from external state).
 	*/
 	onRemove(id) {
 		return id;

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import * as _atscript_typescript_utils0 from "@atscript/typescript/utils";
-import { TAtscriptAnnotatedType, TAtscriptDataType, TSerializeOptions, Validator, serializeAnnotatedType } from "@atscript/typescript/utils";
+import { TAtscriptAnnotatedType, TAtscriptDataType, TSerializeOptions, Validator } from "@atscript/typescript/utils";
 import * as _uniqu_url0 from "@uniqu/url";
-import { AtscriptDbReadable, AtscriptDbTable, FilterExpr, Uniquery, UniqueryControls } from "@atscript/db";
+import { AtscriptDbReadable, AtscriptDbTable, FilterExpr, TMetaResponse, Uniquery, UniqueryControls } from "@atscript/db";
 import { HttpError } from "@moostjs/event-http";
 import * as moost from "moost";
 import { Moost, TConsoleBase } from "moost";
@@ -63,12 +63,14 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
   protected computeEmbedding(_search: string, _fieldName?: string): Promise<number[]>;
   /**
    * Transform filter before querying. Override to add tenant filtering, etc.
+   * May return a Promise for async lookups (session, permissions).
    */
-  protected transformFilter(filter: FilterExpr): FilterExpr;
+  protected transformFilter(filter: FilterExpr): FilterExpr | Promise<FilterExpr>;
   /**
    * Transform projection before querying.
+   * May return a Promise for async lookups.
    */
-  protected transformProjection(projection?: UniqueryControls["$select"]): UniqueryControls["$select"] | undefined;
+  protected transformProjection(projection?: UniqueryControls["$select"]): UniqueryControls["$select"] | undefined | Promise<UniqueryControls["$select"] | undefined>;
   protected parseQueryString(url: string): _uniqu_url0.UrlQuery;
   protected returnOne(result: Promise<DataType | null>): Promise<DataType | HttpError>;
   /**
@@ -101,24 +103,13 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
   getOneComposite(query: Record<string, string>, url: string): Promise<DataType | HttpError>;
   /**
    * **GET /meta** — returns table/view metadata for UI.
+   *
+   * The return type includes `Promise<...>` so subclasses can override with an
+   * async implementation (e.g. to enrich the payload from an external source).
+   * The base cache only covers the base payload — async overrides must cache
+   * their own enrichment if needed.
    */
-  meta(): {
-    searchable: boolean;
-    vectorSearchable: boolean;
-    searchIndexes: ReturnType<AtscriptDbReadable<T>["getSearchIndexes"]>;
-    primaryKeys: string[];
-    readOnly: boolean;
-    relations: Array<{
-      name: string;
-      direction: string;
-      isArray: boolean;
-    }>;
-    fields: Record<string, {
-      sortable: boolean;
-      filterable: boolean;
-    }>;
-    type: ReturnType<typeof serializeAnnotatedType>;
-  };
+  meta(): TMetaResponse | Promise<TMetaResponse>;
 }
 //#endregion
 //#region src/as-db.controller.d.ts
@@ -139,10 +130,12 @@ declare class AsDbController<T extends TAtscriptAnnotatedType = TAtscriptAnnotat
   protected _isReadOnly(): boolean;
   /**
    * Intercepts write operations. Return `undefined` to abort.
+   * May be async (e.g. to enrich payloads from session / permissions).
    */
   protected onWrite(action: "insert" | "insertMany" | "replace" | "replaceMany" | "update" | "updateMany", data: unknown): unknown;
   /**
    * Intercepts delete operations. Return `undefined` to abort.
+   * May be async (e.g. to resolve composite ids from external state).
    */
   protected onRemove(id: unknown): unknown;
   /**

package/dist/index.d.mts

@@ -1,10 +1,10 @@
 import * as _atscript_typescript_utils0 from "@atscript/typescript/utils";
-import { TAtscriptAnnotatedType, TAtscriptDataType, TSerializeOptions, Validator, serializeAnnotatedType } from "@atscript/typescript/utils";
+import { TAtscriptAnnotatedType, TAtscriptDataType, TSerializeOptions, Validator } from "@atscript/typescript/utils";
 import { HttpError } from "@moostjs/event-http";
 import * as moost from "moost";
 import { Moost, TConsoleBase } from "moost";
 import * as _uniqu_url0 from "@uniqu/url";
-import { AtscriptDbReadable, AtscriptDbTable, FilterExpr, Uniquery, UniqueryControls } from "@atscript/db";
+import { AtscriptDbReadable, AtscriptDbTable, FilterExpr, TMetaResponse, Uniquery, UniqueryControls } from "@atscript/db";
 
 //#region src/as-db-readable.controller.d.ts
 /**
@@ -63,12 +63,14 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
   protected computeEmbedding(_search: string, _fieldName?: string): Promise<number[]>;
   /**
    * Transform filter before querying. Override to add tenant filtering, etc.
+   * May return a Promise for async lookups (session, permissions).
    */
-  protected transformFilter(filter: FilterExpr): FilterExpr;
+  protected transformFilter(filter: FilterExpr): FilterExpr | Promise<FilterExpr>;
   /**
    * Transform projection before querying.
+   * May return a Promise for async lookups.
    */
-  protected transformProjection(projection?: UniqueryControls["$select"]): UniqueryControls["$select"] | undefined;
+  protected transformProjection(projection?: UniqueryControls["$select"]): UniqueryControls["$select"] | undefined | Promise<UniqueryControls["$select"] | undefined>;
   protected parseQueryString(url: string): _uniqu_url0.UrlQuery;
   protected returnOne(result: Promise<DataType | null>): Promise<DataType | HttpError>;
   /**
@@ -101,24 +103,13 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
   getOneComposite(query: Record<string, string>, url: string): Promise<DataType | HttpError>;
   /**
    * **GET /meta** — returns table/view metadata for UI.
+   *
+   * The return type includes `Promise<...>` so subclasses can override with an
+   * async implementation (e.g. to enrich the payload from an external source).
+   * The base cache only covers the base payload — async overrides must cache
+   * their own enrichment if needed.
    */
-  meta(): {
-    searchable: boolean;
-    vectorSearchable: boolean;
-    searchIndexes: ReturnType<AtscriptDbReadable<T>["getSearchIndexes"]>;
-    primaryKeys: string[];
-    readOnly: boolean;
-    relations: Array<{
-      name: string;
-      direction: string;
-      isArray: boolean;
-    }>;
-    fields: Record<string, {
-      sortable: boolean;
-      filterable: boolean;
-    }>;
-    type: ReturnType<typeof serializeAnnotatedType>;
-  };
+  meta(): TMetaResponse | Promise<TMetaResponse>;
 }
 //#endregion
 //#region src/as-db.controller.d.ts
@@ -139,10 +130,12 @@ declare class AsDbController<T extends TAtscriptAnnotatedType = TAtscriptAnnotat
   protected _isReadOnly(): boolean;
   /**
    * Intercepts write operations. Return `undefined` to abort.
+   * May be async (e.g. to enrich payloads from session / permissions).
    */
   protected onWrite(action: "insert" | "insertMany" | "replace" | "replaceMany" | "update" | "updateMany", data: unknown): unknown;
   /**
    * Intercepts delete operations. Return `undefined` to abort.
+   * May be async (e.g. to resolve composite ids from external state).
    */
   protected onRemove(id: unknown): unknown;
   /**

package/dist/index.mjs

@@ -328,12 +328,14 @@ let AsDbReadableController = class AsDbReadableController {
 	}
 	/**
 	* Transform filter before querying. Override to add tenant filtering, etc.
+	* May return a Promise for async lookups (session, permissions).
 	*/
 	transformFilter(filter) {
 		return filter;
 	}
 	/**
 	* Transform projection before querying.
+	* May return a Promise for async lookups.
 	*/
 	transformProjection(projection) {
 		return projection;
@@ -392,7 +394,7 @@ let AsDbReadableController = class AsDbReadableController {
 				const insightsError = this.validateInsights(parsed.insights);
 				if (insightsError) return new HttpError(400, insightsError);
 			}
-			const filter = this.transformFilter(parsed.filter);
+			const filter = await this.transformFilter(parsed.filter);
 			return this.readable.aggregate({
 				filter,
 				controls,
@@ -401,8 +403,7 @@ let AsDbReadableController = class AsDbReadableController {
 		}
 		const error = this.validateParsed(parsed, "query");
 		if (error) return error;
-		const filter = this.transformFilter(parsed.filter);
-		const select = this.transformProjection(controls.$select);
+		const [filter, select] = await Promise.all([this.transformFilter(parsed.filter), this.transformProjection(controls.$select)]);
 		if (controls.$count) return this.readable.count({
 			filter,
 			controls: {
@@ -442,8 +443,7 @@ let AsDbReadableController = class AsDbReadableController {
 		const page = Math.max(Number(controls.$page || 1), 1);
 		const size = Math.max(Number(controls.$size || 10), 1);
 		const skip = (page - 1) * size;
-		const filter = this.transformFilter(parsed.filter);
-		const select = this.transformProjection(controls.$select);
+		const [filter, select] = await Promise.all([this.transformFilter(parsed.filter), this.transformProjection(controls.$select)]);
 		const searchTerm = controls.$search;
 		const indexName = controls.$index;
 		const vectorField = controls.$vector;
@@ -481,7 +481,7 @@ let AsDbReadableController = class AsDbReadableController {
 		if (Object.keys(parsed.filter).length > 0) return new HttpError(400, "Filtering is not allowed for \"one\" endpoint");
 		const error = this.validateParsed(parsed, "getOne");
 		if (error) return error;
-		const select = this.transformProjection(parsed.controls.$select);
+		const select = await this.transformProjection(parsed.controls.$select);
 		const controls = {
 			...parsed.controls,
 			$select: select
@@ -496,7 +496,7 @@ let AsDbReadableController = class AsDbReadableController {
 		const idObj = this.extractCompositeId(query);
 		if (idObj instanceof HttpError) return idObj;
 		const parsed = this.parseQueryString(url);
-		const select = this.transformProjection(parsed.controls.$select);
+		const select = await this.transformProjection(parsed.controls.$select);
 		const controls = {
 			...parsed.controls,
 			$select: select
@@ -505,6 +505,11 @@ let AsDbReadableController = class AsDbReadableController {
 	}
 	/**
 	* **GET /meta** — returns table/view metadata for UI.
+	*
+	* The return type includes `Promise<...>` so subclasses can override with an
+	* async implementation (e.g. to enrich the payload from an external source).
+	* The base cache only covers the base payload — async overrides must cache
+	* their own enrichment if needed.
 	*/
 	meta() {
 		if (this._metaResponse) return this._metaResponse;
@@ -522,7 +527,7 @@ let AsDbReadableController = class AsDbReadableController {
 				filterable: true
 			};
 		}
-		this._metaResponse = {
+		const response = {
 			searchable: this.readable.isSearchable(),
 			vectorSearchable: this.readable.isVectorSearchable(),
 			searchIndexes: this.readable.getSearchIndexes(),
@@ -532,7 +537,8 @@ let AsDbReadableController = class AsDbReadableController {
 			fields,
 			type: this.getSerializedType()
 		};
-		return this._metaResponse;
+		this._metaResponse = response;
+		return response;
 	}
 };
 __decorate([
@@ -569,7 +575,7 @@ __decorate([
 	Get("meta"),
 	__decorateMetadata("design:type", Function),
 	__decorateMetadata("design:paramtypes", []),
-	__decorateMetadata("design:returntype", void 0)
+	__decorateMetadata("design:returntype", Object)
 ], AsDbReadableController.prototype, "meta", null);
 AsDbReadableController = __decorate([
 	UseValidationErrorTransform(),
@@ -592,12 +598,14 @@ let AsDbController = class AsDbController extends AsDbReadableController {
 	}
 	/**
 	* Intercepts write operations. Return `undefined` to abort.
+	* May be async (e.g. to enrich payloads from session / permissions).
 	*/
 	onWrite(action, data) {
 		return data;
 	}
 	/**
 	* Intercepts delete operations. Return `undefined` to abort.
+	* May be async (e.g. to resolve composite ids from external state).
 	*/
 	onRemove(id) {
 		return id;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atscript/moost-db",
-  "version": "0.1.51",
+  "version": "0.1.53",
   "description": "Generic database controller for Moost with Atscript.",
   "keywords": [
     "annotations",
@@ -38,22 +38,22 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniqu/url": "^0.1.4"
+    "@uniqu/url": "^0.1.5"
   },
   "devDependencies": {
     "@atscript/core": "^0.1.48",
     "@atscript/typescript": "^0.1.48",
     "@moostjs/event-http": "^0.6.7",
-    "@uniqu/core": "^0.1.4",
+    "@uniqu/core": "^0.1.5",
     "moost": "^0.6.7",
     "unplugin-atscript": "^0.1.48"
   },
   "peerDependencies": {
     "@atscript/typescript": "^0.1.48",
     "@moostjs/event-http": "^0.6.7",
-    "@uniqu/core": "^0.1.4",
+    "@uniqu/core": "^0.1.5",
     "moost": "^0.6.7",
-    "@atscript/db": "^0.1.51"
+    "@atscript/db": "^0.1.53"
   },
   "scripts": {
     "postinstall": "asc -f dts",