mongoku/src/lib/types.ts

[](https://github.com/huggingface/Mongoku/actions/workflows/ci.yml)

export interface MongoDocument {
	_id?: {
		$type: string;
		$value: string;
	};
	[key: string]: unknown;
}

export interface SearchParams {
	query: string;
	sort: string;
	project: string;
	limit: number;
	skip: number;
	mode: "query" | "distinct" | "aggregation";
	field?: string;
}

/**
 * Database stats as returned by the db.stats() method
 *
 * Type not exposed by MongoDB
 */
export interface DatabaseStats {
	db: string;
	collections: number;
	views: number;
	objects: number;
	avgObjSize: number;
	dataSize: number;
	storageSize: number;
	indexes: number;
	indexSize: number;
	totalSize: number;
	fsUsedSize: number;
	fsTotalSize: number;
	ok: number;
}

export interface CollectionJSON {
	name: string;
	size: number;
	dataSize: number;
	count: number;
	avgObjSize: number;
	storageSize: number;
	capped: boolean;
	nIndexes: number;
	totalIndexSize: number;
	indexSizes: {
		[name: string]: number;
	};
	indexes: Array<{
		name: string;
		key?: Record<string, number>;
		size: number;
	}>;
}

export const ALLOWED_AGGREGATION_STAGES = new Set([
	"$addFields",
	"$bucket",
	"$bucketAuto",
	"$collStats",
	"$count",
	"$densify",
	"$documents",
	"$facet",
	"$fill",
	"$geoNear",
	"$graphLookup",
	"$group",
	"$indexStats",
	"$limit",
	"$listClusterCatalog",
	"$listSampledQueries",
	"$listSearchIndexes",
	"$listSessions",
	"$lookup",
	"$match",
	"$project",
	"$querySettings",
	"$queryStats",
	"$rankFusion",
	"$redact",
	"$replaceRoot",
	"$replaceWith",
	"$sample",
	"$search",
	"$searchMeta",
	"$set",
	"$setWindowFields",
	"$skip",
	"$sort",
	"$sortByCount",
	"$unionWith",
	"$unset",
	"$unwind",
	"$vectorSearch",
]);

/**
 * A single mapping target - defines either a collection lookup or URL template
 */
export type MappingTarget =
	| {
			type: "document";
			collection: string;
			on: string;
	  }
	| {
			type: "url";
			template: string;
	  }
	// Legacy format (backwards compatibility) - treated as type: "document"
	| {
			collection: string;
			on: string;
	  };

export type Mappings = Record<string, MappingTarget[] | MappingTarget>;

/**
 * Collection mappings document structure as stored in mongoku.mappings
 */
export interface CollectionMappings {
	_id: string; // collection name
	mappings: Mappings;
}