@atscript/moost-db 0.1.41 → 0.1.43

package/dist/index.cjs

@@ -203,9 +203,11 @@ let AsDbReadableController = class AsDbReadableController {
 	_serializedType;
 	/** Cached search index list (static, computed once). */
 	_searchIndexes;
+	/** Cached full meta response (computed lazily on first meta() call). */
+	_metaResponse;
 	constructor(readable, app) {
 		this.readable = readable;
-		this._serializedType = (0, _atscript_typescript_utils.serializeAnnotatedType)(readable.type);
+		this._serializedType = (0, _atscript_typescript_utils.serializeAnnotatedType)(readable.type, this.getSerializeOptions());
 		this._searchIndexes = readable.getSearchIndexes();
 		this.logger = app.getLogger(`db [${readable.tableName}]`);
 		this.logger.info(`Initializing ${readable.isView ? "view" : "table"} controller`);
@@ -223,6 +225,32 @@ let AsDbReadableController = class AsDbReadableController {
 	* One-time initialization hook. Override to seed data, register watchers, etc.
 	*/
 	init() {}
+	/**
+	* Returns serialization options for the `/meta` endpoint's type field.
+	* Default: whitelist — keeps `meta.*`, `expect.*`, and `db.rel.*` annotations,
+	* strips all other `db.*` annotations (table, column, index, default, etc.).
+	* Override in subclass to customise what annotations are exposed to clients.
+	*/
+	getSerializeOptions() {
+		return { processAnnotation: ({ key, value }) => {
+			if (key.startsWith("meta.") || key.startsWith("expect.") || key.startsWith("db.rel.")) return {
+				key,
+				value
+			};
+			if (key.startsWith("db.")) return;
+			return {
+				key,
+				value
+			};
+		} };
+	}
+	/**
+	* Whether this controller is read-only (no write endpoints).
+	* Returns `true` for readable/view controllers, overridden to `false` in AsDbController.
+	*/
+	_isReadOnly() {
+		return true;
+	}
 	_queryControlsValidator;
 	_pagesControlsValidator;
 	_getOneControlsValidator;
@@ -457,12 +485,32 @@ let AsDbReadableController = class AsDbReadableController {
 	* **GET /meta** — returns table/view metadata for UI.
 	*/
 	meta() {
-		return {
+		if (this._metaResponse) return this._metaResponse;
+		const relations = [];
+		for (const [name, rel] of this.readable.relations) relations.push({
+			name,
+			direction: rel.direction,
+			isArray: rel.isArray
+		});
+		const fields = {};
+		for (const fd of this.readable.fieldDescriptors) {
+			if (fd.ignored) continue;
+			fields[fd.path] = {
+				sortable: !!fd.isIndexed,
+				filterable: true
+			};
+		}
+		this._metaResponse = {
 			searchable: this.readable.isSearchable(),
 			vectorSearchable: this.readable.isVectorSearchable(),
 			searchIndexes: this._searchIndexes,
+			primaryKeys: [...this.readable.primaryKeys],
+			readOnly: this._isReadOnly(),
+			relations,
+			fields,
 			type: this._serializedType
 		};
+		return this._metaResponse;
 	}
 };
 __decorate([
@@ -517,6 +565,9 @@ let AsDbController = class AsDbController extends AsDbReadableController {
 	constructor(table, app) {
 		super(table, app);
 	}
+	_isReadOnly() {
+		return false;
+	}
 	/**
 	* Intercepts write operations. Return `undefined` to abort.
 	*/

package/dist/index.d.cts

@@ -1,8 +1,6 @@
 import * as _uniqu_url0 from "@uniqu/url";
-import * as _atscript_db0 from "@atscript/db";
+import { TAtscriptAnnotatedType, TAtscriptDataType, TSerializeOptions, Validator, serializeAnnotatedType } from "@atscript/typescript/utils";
 import { AtscriptDbReadable, AtscriptDbTable, FilterExpr, Uniquery, UniqueryControls } from "@atscript/db";
-import * as _atscript_typescript_utils0 from "@atscript/typescript/utils";
-import { TAtscriptAnnotatedType, TAtscriptDataType, Validator } from "@atscript/typescript/utils";
 import { HttpError } from "@moostjs/event-http";
 import * as moost from "moost";
 import { Moost, TConsoleBase } from "moost";
@@ -24,11 +22,25 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
   private _serializedType;
   /** Cached search index list (static, computed once). */
   private _searchIndexes;
+  /** Cached full meta response (computed lazily on first meta() call). */
+  private _metaResponse?;
   constructor(readable: AtscriptDbReadable<T>, app: Moost);
   /**
    * One-time initialization hook. Override to seed data, register watchers, etc.
    */
   protected init(): void | Promise<void>;
+  /**
+   * Returns serialization options for the `/meta` endpoint's type field.
+   * Default: whitelist — keeps `meta.*`, `expect.*`, and `db.rel.*` annotations,
+   * strips all other `db.*` annotations (table, column, index, default, etc.).
+   * Override in subclass to customise what annotations are exposed to clients.
+   */
+  protected getSerializeOptions(): TSerializeOptions;
+  /**
+   * Whether this controller is read-only (no write endpoints).
+   * Returns `true` for readable/view controllers, overridden to `false` in AsDbController.
+   */
+  protected _isReadOnly(): boolean;
   private _queryControlsValidator?;
   private _pagesControlsValidator?;
   private _getOneControlsValidator?;
@@ -88,8 +100,19 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
   meta(): {
     searchable: boolean;
     vectorSearchable: boolean;
-    searchIndexes: _atscript_db0.TSearchIndexInfo[];
-    type: _atscript_typescript_utils0.TSerializedAnnotatedType;
+    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>;
   };
 }
 //#endregion
@@ -108,6 +131,7 @@ declare class AsDbController<T extends TAtscriptAnnotatedType = TAtscriptAnnotat
   /** Reference to the underlying table (typed for write access). */
   protected get table(): AtscriptDbTable<T>;
   constructor(table: AtscriptDbTable<T>, app: Moost);
+  protected _isReadOnly(): boolean;
   /**
    * Intercepts write operations. Return `undefined` to abort.
    */

package/dist/index.d.mts

@@ -1,10 +1,8 @@
-import * as _atscript_typescript_utils0 from "@atscript/typescript/utils";
-import { TAtscriptAnnotatedType, TAtscriptDataType, Validator } from "@atscript/typescript/utils";
+import { TAtscriptAnnotatedType, TAtscriptDataType, TSerializeOptions, Validator, serializeAnnotatedType } 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 * as _atscript_db0 from "@atscript/db";
 import { AtscriptDbReadable, AtscriptDbTable, FilterExpr, Uniquery, UniqueryControls } from "@atscript/db";
 
 //#region src/as-db-readable.controller.d.ts
@@ -24,11 +22,25 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
   private _serializedType;
   /** Cached search index list (static, computed once). */
   private _searchIndexes;
+  /** Cached full meta response (computed lazily on first meta() call). */
+  private _metaResponse?;
   constructor(readable: AtscriptDbReadable<T>, app: Moost);
   /**
    * One-time initialization hook. Override to seed data, register watchers, etc.
    */
   protected init(): void | Promise<void>;
+  /**
+   * Returns serialization options for the `/meta` endpoint's type field.
+   * Default: whitelist — keeps `meta.*`, `expect.*`, and `db.rel.*` annotations,
+   * strips all other `db.*` annotations (table, column, index, default, etc.).
+   * Override in subclass to customise what annotations are exposed to clients.
+   */
+  protected getSerializeOptions(): TSerializeOptions;
+  /**
+   * Whether this controller is read-only (no write endpoints).
+   * Returns `true` for readable/view controllers, overridden to `false` in AsDbController.
+   */
+  protected _isReadOnly(): boolean;
   private _queryControlsValidator?;
   private _pagesControlsValidator?;
   private _getOneControlsValidator?;
@@ -88,8 +100,19 @@ declare class AsDbReadableController<T extends TAtscriptAnnotatedType = TAtscrip
   meta(): {
     searchable: boolean;
     vectorSearchable: boolean;
-    searchIndexes: _atscript_db0.TSearchIndexInfo[];
-    type: _atscript_typescript_utils0.TSerializedAnnotatedType;
+    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>;
   };
 }
 //#endregion
@@ -108,6 +131,7 @@ declare class AsDbController<T extends TAtscriptAnnotatedType = TAtscriptAnnotat
   /** Reference to the underlying table (typed for write access). */
   protected get table(): AtscriptDbTable<T>;
   constructor(table: AtscriptDbTable<T>, app: Moost);
+  protected _isReadOnly(): boolean;
   /**
    * Intercepts write operations. Return `undefined` to abort.
    */

package/dist/index.mjs

@@ -202,9 +202,11 @@ let AsDbReadableController = class AsDbReadableController {
 	_serializedType;
 	/** Cached search index list (static, computed once). */
 	_searchIndexes;
+	/** Cached full meta response (computed lazily on first meta() call). */
+	_metaResponse;
 	constructor(readable, app) {
 		this.readable = readable;
-		this._serializedType = serializeAnnotatedType(readable.type);
+		this._serializedType = serializeAnnotatedType(readable.type, this.getSerializeOptions());
 		this._searchIndexes = readable.getSearchIndexes();
 		this.logger = app.getLogger(`db [${readable.tableName}]`);
 		this.logger.info(`Initializing ${readable.isView ? "view" : "table"} controller`);
@@ -222,6 +224,32 @@ let AsDbReadableController = class AsDbReadableController {
 	* One-time initialization hook. Override to seed data, register watchers, etc.
 	*/
 	init() {}
+	/**
+	* Returns serialization options for the `/meta` endpoint's type field.
+	* Default: whitelist — keeps `meta.*`, `expect.*`, and `db.rel.*` annotations,
+	* strips all other `db.*` annotations (table, column, index, default, etc.).
+	* Override in subclass to customise what annotations are exposed to clients.
+	*/
+	getSerializeOptions() {
+		return { processAnnotation: ({ key, value }) => {
+			if (key.startsWith("meta.") || key.startsWith("expect.") || key.startsWith("db.rel.")) return {
+				key,
+				value
+			};
+			if (key.startsWith("db.")) return;
+			return {
+				key,
+				value
+			};
+		} };
+	}
+	/**
+	* Whether this controller is read-only (no write endpoints).
+	* Returns `true` for readable/view controllers, overridden to `false` in AsDbController.
+	*/
+	_isReadOnly() {
+		return true;
+	}
 	_queryControlsValidator;
 	_pagesControlsValidator;
 	_getOneControlsValidator;
@@ -456,12 +484,32 @@ let AsDbReadableController = class AsDbReadableController {
 	* **GET /meta** — returns table/view metadata for UI.
 	*/
 	meta() {
-		return {
+		if (this._metaResponse) return this._metaResponse;
+		const relations = [];
+		for (const [name, rel] of this.readable.relations) relations.push({
+			name,
+			direction: rel.direction,
+			isArray: rel.isArray
+		});
+		const fields = {};
+		for (const fd of this.readable.fieldDescriptors) {
+			if (fd.ignored) continue;
+			fields[fd.path] = {
+				sortable: !!fd.isIndexed,
+				filterable: true
+			};
+		}
+		this._metaResponse = {
 			searchable: this.readable.isSearchable(),
 			vectorSearchable: this.readable.isVectorSearchable(),
 			searchIndexes: this._searchIndexes,
+			primaryKeys: [...this.readable.primaryKeys],
+			readOnly: this._isReadOnly(),
+			relations,
+			fields,
 			type: this._serializedType
 		};
+		return this._metaResponse;
 	}
 };
 __decorate([
@@ -516,6 +564,9 @@ let AsDbController = class AsDbController extends AsDbReadableController {
 	constructor(table, app) {
 		super(table, app);
 	}
+	_isReadOnly() {
+		return false;
+	}
 	/**
 	* Intercepts write operations. Return `undefined` to abort.
 	*/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atscript/moost-db",
-  "version": "0.1.41",
+  "version": "0.1.43",
   "description": "Generic database controller for Moost with Atscript.",
   "keywords": [
     "annotations",
@@ -41,19 +41,19 @@
     "@uniqu/url": "^0.1.2"
   },
   "devDependencies": {
-    "@atscript/core": "^0.1.39",
-    "@atscript/typescript": "^0.1.39",
+    "@atscript/core": "^0.1.41",
+    "@atscript/typescript": "^0.1.41",
     "@moostjs/event-http": "^0.6.2",
     "@uniqu/core": "^0.1.2",
     "moost": "^0.6.2",
-    "unplugin-atscript": "^0.1.39"
+    "unplugin-atscript": "^0.1.41"
   },
   "peerDependencies": {
-    "@atscript/typescript": "^0.1.39",
+    "@atscript/typescript": "^0.1.41",
     "@moostjs/event-http": "^0.6.2",
     "@uniqu/core": "^0.1.2",
     "moost": "^0.6.2",
-    "@atscript/db": "^0.1.41"
+    "@atscript/db": "^0.1.43"
   },
   "scripts": {
     "postinstall": "asc -f dts",