hackmud-script-manager 0.20.4-abe4703 → 0.20.4-ae3052c

package/env.d.ts

@@ -1,7 +1,7 @@
 type Replace<A, B> = Omit<A, keyof B> & B
-type ScriptSuccess<T = object> = { ok: true } & T
+type ScriptSuccess<T = unknown> = { ok: true } & T
 type ScriptFailure = { ok: false, msg?: string }
-type ScriptResponse<T = object> = ScriptSuccess<T> | ScriptFailure
+type ScriptResponse<T = unknown> = ScriptSuccess<T> | ScriptFailure
 type ErrorScripts = Record<string, () => ScriptFailure>
 
 type Subscripts = Record<string, Record<string, (...args: any) => any>> & {
@@ -26,24 +26,25 @@ interface PlayerMidsec {}
 interface PlayerLowsec {}
 interface PlayerNullsec {}
 
-type UpgradeCore = {
+type UpgradeRarityString = "`0noob`" | "`1kiddie`" | "`2h4x0r`" | "`3h4rdc0r3`" | "`4|_|b3|2`" | "`531337`"
+type UpgradeRarityNumber = 0 | 1 | 2 | 3 | 4 | 5
+
+type UpgradeBase = {
 	name: string
 	type: "lock" | "script_space" | "chat" | "script" | "tool" | "bot_brain" | "glam"
 	up_class?: -1 | 0 | 1 | 2 | 3
 	tier: 1 | 2 | 3 | 4
-	rarity: 0 | 1 | 2 | 3 | 4 | 5
+	rarity: UpgradeRarityNumber
 	i: number
 	loaded: boolean
 	sn: string
 	description: string
 }
 
-type Upgrade = UpgradeCore & Record<string, null | boolean | number | string>
+type Upgrade = UpgradeBase & Record<string, null | boolean | number | string>
 
-type CLIUpgrade = Omit<UpgradeCore, `rarity`> & {
-	[x: string]: null | boolean | number | string
-	rarity: "`0noob`" | "`1kiddie`" | "`2h4x0r`" | "`3h4rdc0r3`" | "`4|_|b3|2`" | "`531337`"
-}
+type CliUpgrade = Omit<UpgradeBase, `rarity`> &
+	{ [k: string]: null | boolean | number | string, rarity: UpgradeRarityString }
 
 type UsersTopItem<R> = { rank: R, name: string, last_activity: string, balance: string }
 type CorpsTopItem<R> = { rank: R, name: string, worth: string }
@@ -121,26 +122,25 @@ type Fullsec = Subscripts & PlayerFullsec & {
 	}
 
 	escrow: {
-		/** **FULLSEC** */ charge: (args: {
-			cost: number | string
-			is_unlim?: boolean
-		}) => null | ScriptFailure
-
+		/** **FULLSEC** */ charge: (args: { cost: number | string, is_unlim?: boolean }) => null | ScriptFailure
 		confirm: never
 	}
 
-	gui: {
-		chats: never
-		quiet: never
-		size: never
-		vfx: never
-		vol: never
-	}
+	gui: { chats: never, quiet: never, size: never, vfx: never, vol: never }
 
 	market: {
 		/** **FULLSEC** */ browse: {
 			(args:
-				Partial<{ seller: string, listed_before: number, listed_after: number, cost: number | string } & Omit<CLIUpgrade, "rarity">>
+				Partial<{
+					seller: string | MongoQuerySelector<string>,
+					listed_before: number | MongoQuerySelector<number>,
+					listed_after: number,
+					cost: number | MongoQuerySelector<number> | string,
+					rarity: UpgradeRarityNumber | MongoQuerySelector<UpgradeRarityNumber>,
+					name: string | MongoQuerySelector<string>
+				} & Omit<{
+					[k in keyof CliUpgrade]: CliUpgrade[k] | MongoQuerySelector<CliUpgrade[k]>
+				}, "rarity">>
 			): { i: string, name: string, rarity: Upgrade["rarity"], cost: number }[] | ScriptFailure
 
 			<I extends string>(args: { i: I }): {
@@ -409,17 +409,17 @@ type Fullsec = Subscripts & PlayerFullsec & {
 		upgrades_of_owner: {
 			<F extends Partial<Upgrade & { loaded: boolean }> = object>(args?: { filter?: F, full?: false }): (
 				Omit<
-					Pick<UpgradeCore, "tier" | "rarity" | "name" | "type" | "i" | "loaded">,
+					Pick<UpgradeBase, "tier" | "rarity" | "name" | "type" | "i" | "loaded">,
 					keyof F
 				> & Pick<F, "tier" | "rarity" | "name" | "type" | "i" | "loaded">
 			)[] | ScriptFailure
 
 			<F extends Partial<Upgrade & { loaded: boolean }> = object>(args: { filter?: F, full: true }): (
-				Omit<UpgradeCore, keyof F> & F & Record<string, null | boolean | number | string>
+				Omit<UpgradeBase, keyof F> & F & Record<string, null | boolean | number | string>
 			)[] | ScriptFailure
 
 			<I extends number>(args: { i: I }): (
-				Omit<UpgradeCore, "i"> & { [x: string]: null | boolean | number | string, i: I }
+				Omit<UpgradeBase, "i"> & { [x: string]: null | boolean | number | string, i: I }
 			) | ScriptFailure
 		}
 
@@ -445,7 +445,10 @@ type Highsec = Fullsec & PlayerHighsec & {
 		/** **HIGHSEC**
 		  * @returns GC balance as number if `is_script` is true (default).
 		  * @returns GC balance as string if `is_script` is false. */
-		balance: ((args?: { is_script?: true }) => number) & ((args: { is_script: false }) => string)
+		balance: {
+			(args?: { is_script?: true }): number
+			(args: { is_script: false }): string
+		}
 
 		/** **HIGHSEC**
 		 * @returns Transaction history according to filter.
@@ -496,7 +499,7 @@ type Highsec = Fullsec & PlayerHighsec & {
 		/** **HIGHSEC** */
 		upgrades: {
 			<I extends number>(args: { i: I }): (
-				Omit<UpgradeCore, "i"> & { [x: string]: null | boolean | number | string, i: I }
+				Omit<UpgradeBase, "i"> & { [x: string]: null | boolean | number | string, i: I }
 			) | ScriptFailure
 
 			<F extends Partial<Upgrade & { loaded: boolean }> = object>(args?: {
@@ -504,22 +507,22 @@ type Highsec = Fullsec & PlayerHighsec & {
 				is_script?: true
 				full?: false
 			}): (
-				Omit<Pick<UpgradeCore, "tier" | "rarity" | "name" | "type" | "i" | "loaded">, keyof F> & F &
+				Omit<Pick<UpgradeBase, "tier" | "rarity" | "name" | "type" | "i" | "loaded">, keyof F> & F &
 					Record<string, null | boolean | number | string>
 			)[] | ScriptFailure
 
 			<F extends Partial<Upgrade & { loaded: boolean }> = object>(args?:
 				{ filter?: F, is_script?: true, full: true }
-			): (Omit<UpgradeCore, keyof F> & F & Record<string, null | boolean | number | string>)[] | ScriptFailure
+			): (Omit<UpgradeBase, keyof F> & F & Record<string, null | boolean | number | string>)[] | ScriptFailure
 
 			(args?: { filter?: Partial<Upgrade & { loaded: boolean }>, is_script: false, full?: false }):
 				{ msg: string, upgrades: string[] } | ScriptFailure
 
 			<F extends Partial<Upgrade & { loaded: boolean }> = object>(
 				args?: { filter?: F, is_script: false, full: true }
-			): (Omit<UpgradeCore, keyof F | `rarity`> & F & {
+			): (Omit<UpgradeBase, keyof F | `rarity`> & F & {
 				[x: string]: null | boolean | number | string
-				rarity: "`0noob`" | "`1kiddie`" | "`2h4x0r`" | "`3h4rdc0r3`" | "`4|_|b3|2`" | "`531337`"
+				rarity: UpgradeRarityString
 			})[] | ScriptFailure
 		}
 	}
@@ -615,6 +618,9 @@ type Lowsec = Midsec & PlayerLowsec & {
 			(args: { i: number | number[], to: string, memo?: string }): ScriptResponse
 			(args: { sn: string | string[], to: string, memo?: string }): ScriptResponse
 		}
+		/** **LOWSEC**  */ expose_access_log: (args: { target: string }) => ScriptResponse
+		/** **LOWSEC** */ xfer_gc_from: (args: { target: string, amount: number | string }) => ScriptResponse
+		/** **LOWSEC** */ expose_balance: (args: { target: string }) => ScriptResponse
 	}
 }
 
@@ -699,294 +705,377 @@ type Nullsec = Lowsec & PlayerNullsec & {
 	}
 }
 
-type MongoValue = string | number | boolean | Date | MongoValue[] | { [key: string]: MongoValue } | null
+// database
+type MongoPrimitive = null | boolean | number | Date | string
+type MongoValue = MongoPrimitive | MongoValue[] | MongoObject
+type MongoObject = { [k: string]: MongoValue, [k: `$${string}`]: never }
+type MongoQueryValue = MongoPrimitive | MongoQueryValue[] | MongoQueryObject
+
+type MongoQueryObject =
+	{ [k: string]: MongoQueryValue, [k: `$${string}`]: MongoValue, $type?: keyof MongoTypeStringsToTypes | (string & {}) }
+
+type MongoTypeStringsToTypes = {
+	double: number
+	string: string
+	object: MongoObject
+	array: MongoValue[]
+	objectId: ObjectId
+	bool: boolean
+	date: Date
+	null: null
+	int: number
+	long: number
+}
 
-type MongoCommandValue = string | number | boolean | Date | MongoCommandValue[] | { [key: string]: MongoCommandValue } |
-	null | undefined
+type MongoTypeString = keyof MongoTypeStringsToTypes
+type MongoTypeNumber = -1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 16 | 17 | 18 | 19 | 127
+type MongoId = Exclude<MongoPrimitive, null> | MongoObject
+type MongoQueryId = Exclude<MongoPrimitive, null> | MongoQueryObject
+type MongoDocument = MongoObject & { _id?: MongoId }
+
+type MongoQueryType<TQuery extends MongoQueryObject> = {
+	-readonly [K in keyof TQuery]:
+		TQuery[K] extends MongoPrimitive ?
+			TQuery[K]
+		: TQuery[K] extends { $type: infer TType } ?
+			TType extends keyof MongoTypeStringsToTypes ? MongoTypeStringsToTypes[TType] : unknown
+		: TQuery[K] extends { $in: (infer TIn)[] } ?
+			TIn
+		: keyof TQuery[K] extends `$${string}` ?
+			unknown
+		: TQuery[K] extends { [k: string]: any } ?
+			MongoQueryType<TQuery[K]>
+		: never
+}
+
+type MongoCommandValue = MongoPrimitive | MongoCommandValue[] | { [k: string]: MongoCommandValue }
+type MongoArraySelectors<T extends MongoValue[] = MongoValue[]> = { $all: T, $elemMatch: T, $size: number }
+
+type MongoComparisonSelectors<T extends MongoValue = MongoValue> =
+	{ $eq: T, $gt: T, $gte: T, $in: T[], $lt: T, $lte: T, $ne: T, $nin: T[] }
 
-type Query = { [key: string]: MongoValue | Query } & { _id?: Id, $in?: MongoValue[] }
-type Projection = Record<string, boolean | 0 | 1>
+type MongoElementSelectors = { $exists: boolean, $type: MongoTypeNumber | MongoTypeString }
 
-type MongoCommand = MongoCommandValue & Partial<
-	{ $set: Record<string, MongoCommandValue>, $push: Record<string, MongoCommandValue>, $unset: Record<string, ""> }
+type MongoQuerySelector<T extends MongoValue> = Partial<
+	T extends []
+		? MongoArraySelectors<T> & MongoElementSelectors & MongoComparisonSelectors<T>
+		: MongoElementSelectors & MongoComparisonSelectors<T>
 >
 
-type Id = string | number | boolean | Date | Record<string, MongoValue>
-type MongoDocument = { [key: string]: MongoValue, _id: Id }
+type MongoQuery<T extends MongoObject> = { [K in keyof T]?: T[K] | MongoQuerySelector<T[K]> } & { _id?: MongoId }
+
+type MongoUpdateOperators<T extends MongoObject> = Partial<{
+	/* Universal operators */
+	$set: Partial<Record<string, MongoCommandValue> & T>
+	$setOnInsert: Partial<Record<string, MongoCommandValue> & T>
+	$unset: Partial<Record<string, ""> & T>
+
+	$rename: Partial<Record<string, string> & { [key in keyof T]: string }>
+
+	/* Date & number operators */
+	$inc: Record<string, number> &
+		{ [K in keyof T as T[K] extends number | Date ? K : never]?: T[K] extends number ? number : Date }
+
+	$mul: Record<string, number> & { [K in keyof T as T[K] extends number ? K : never]?: number }
+	$min: Record<string, number> & { [K in keyof T as T[K] extends number ? K : never]?: number }
+	$max: Record<string, number> & { [K in keyof T as T[K] extends number ? K : never]?: number }
+
+	/* Array operators */
+	$pop: Record<string, -1 | 1> & { [K in keyof T as T[K] extends [] ? K : never]?: -1 | 1 }
+
+	$push: Record<string, MongoCommandValue> & {
+		[K in keyof T as T[K] extends [] ? K : never]?: (T[K] extends (infer U)[] ? U : never)
+			| MongoUpdateArrayOperatorModifiers<T[K]>
+	}
+
+	$addToSet: Partial<Record<string, MongoCommandValue> & {
+		[K in keyof T as T[K] extends [] ? K : never]: (T[K] extends (infer U)[] ? U : never)
+			| MongoUpdateArrayOperatorUniversalModifiers<T[K]>
+	}>
+
+	$pull: Partial<Record<string, MongoCommandValue> & {
+		[K in keyof T as T[K] extends [] ? K : never]: (T[K] extends (infer U)[] ? U : never)
+			| MongoQuerySelector<T[K]>
+	}>
+
+	$pullAll: Record<string, MongoCommandValue> & { [K in keyof T as T[K] extends [] ? K : never]?: T[K] }
+}>
+
+type MongoUpdateArrayOperatorUniversalModifiers<T> = { $each?: T extends [] ? T : T[] }
+
+type MongoUpdateArrayOperatorModifiers<T> = MongoUpdateArrayOperatorUniversalModifiers<T> &
+	{ $position?: number, $slice?: number, $sort?: 1 | -1 }
+
+type MongoUpdateCommand<Schema extends MongoObject> = MongoUpdateOperators<Schema>
+
 type SortOrder = { [key: string]: 1 | -1 | SortOrder }
 
-type Cursor = {
-	/** Returns the first document that satisfies the query. */ first: () => MongoDocument | null
-	/** Returns an array of documents that satisfy the query. */ array: () => MongoDocument[]
+type Cursor<T> = {
+	/** Returns the first document that satisfies the query. */ first: () => T | null
+	/** Returns an array of documents that satisfy the query. */ array: () => T[]
 	/** Returns the number of documents that match the query. */ count: () => number
 
 	/** Returns the first document that satisfies the query. Also makes cursor unusable. */
-	first_and_close: () => MongoDocument
+	first_and_close: () => T
 
 	/** Returns an array of documents that satisfy the query. Also makes cursor unusable. */
-	array_and_close: () => MongoDocument[]
+	array_and_close: () => T[]
 
 	/** Returns the number of documents that match the query. Also makes cursor unusable. */
 	count_and_close: () => number
 
 	/** Run `callback` on each document that satisfied the query. */
-	each: (callback: (document: MongoDocument) => void) => null
+	each: (callback: (document: T) => void) => null
 
 	/** Returns a new cursor with documents sorted as specified.
 	  * A value of 1 sorts the property ascending, and -1 descending.
 	  * @param order The way the documents are to be sorted. */
-	sort: (order?: SortOrder) => Cursor
+	sort: (order?: SortOrder) => Cursor<T>
 
 	/** Returns a new cursor without the first number of documents.
 	  * @param count Number of documents to skip. */
-	skip: (count: number) => Cursor
+	skip: (count: number) => Cursor<T>
 
 	/** Returns a new cursor limited to a number of documents as specified.
 	  * @param count Number of documents. */
-	limit: (count: number) => Cursor
+	limit: (count: number) => Cursor<T>
 
-	/** @param key The key of the documents. */ distinct: ((key: string) => MongoValue[]) & ((key: "_id") => Id[])
+	/** @param key The key of the documents. */ distinct: { (key: string): MongoValue[], (key: "_id"): MongoId[] }
 	/** Make cursor unusable. */ close: () => null
 	NumberLong: (number: number) => number
+	// TODO what actually is the type here?
 	ObjectId: () => any
 }
 
-type CLIContext = {
+type CliContext = {
 	/** The name of the user who is calling the script. */ caller: string
 	/** The name of this script. */ this_script: string
 	/** The number of columns in the caller’s terminal. */ cols: number
 	/** The number of rows in the caller’s terminal. */ rows: number
 
 	/** The name of the script that directly called this script, or null if called on the command line or as a
-	  * scriptor. */ calling_script: null
+	  * scriptor. */
+	calling_script: null
+
+	is_scriptor?: undefined
+	is_brain?: undefined
 }
 
-type SubscriptContext = Replace<CLIContext, {
+type SubscriptContext = Replace<CliContext, {
 	/** The name of the script that directly called this script, or null if called on the command line or as a scriptor.
 	  */
 	calling_script: string
 }>
 
-type ScriptorContext = CLIContext & { /** Whether the script is being run as a scriptor. */ is_scriptor: true }
-type BrainContext = CLIContext & { /** Whether the script is being run via a bot brain. */ is_brain: true }
-type Context = CLIContext | SubscriptContext | ScriptorContext | BrainContext
-
-/** Subscript space that can call FULLSEC scripts. */ declare const $fs: Fullsec
-
-/** Subscript space that can call HIGHSEC and above scripts. Makes your script HIGHSEC (overrides FULLSEC). */
-declare const $hs: Highsec
-
-/** Subscript space that can call MIDSEC and above scripts. Makes your script MIDSEC (overrides higher security levels).
-  */
-declare const $ms: Midsec
-
-/** Subscript space that can call LOWSEC and above scripts. Makes your script LOWSEC (overrides higher security levels).
-  */
-declare const $ls: Lowsec
-
-/** Subscript space that can call any script. Makes your script NULLSEC (overrides higher security levels). */
-declare const $ns: Nullsec
-
-/** Subscript space that can call FULLSEC scripts. */ declare const $4s: typeof $fs
-
-/** Subscript space that can call HIGHSEC and above scripts. Makes your script HIGHSEC (overrides FULLSEC). */
-declare const $3s: typeof $hs
-
-/** Subscript space that can call MIDSEC and above scripts. Makes your script MIDSEC (overrides higher security levels).
-  */
-declare const $2s: typeof $ms
-
-/** Subscript space that can call LOWSEC and above scripts. Makes your script LOWSEC (overrides higher security levels).
-  */
-declare const $1s: typeof $ls
-
-/** Subscript space that can call any script. Makes your script NULLSEC (overrides higher security levels). */
-declare const $0s: typeof $ns
-
-/** Subscript space that can call any script. Uses seclevel provided in comment before script (defaults to NULLSEC)
-  * @example
-  * // @ seclevel MIDSEC
-  * // remove the space betwen "@" and "s", there's only a space because otherwise vscode breaks
-  * export function script() {
-  * 	$s.foo.bar() // will be converted to #ms.foo.bar()
-  * } */
-declare const $s: Nullsec
-
-declare const $db: {
-	/** Insert a document or documents into a collection.
-	  * @param documents A document or array of documents to insert into the collection. */
-	i: (documents: object | object[]) => {
-		ok: 1
-		n: number
-		opTime: { ts: "Undefined Conversion", t: number }
-		electionId: "Undefined Conversion"
-		operationTime: "Undefined Conversion"
-		$clusterTime: {
-			clusterTime: "Undefined Conversion"
-			signature: { hash: "Undefined Conversion", keyId: "Undefined Conversion" }
-		}
-	}
+type ScriptorContext = Replace<CliContext, { /** Whether the script is being run as a scriptor. */ is_scriptor: true }>
+type BrainContext = Replace<CliContext, { /** Whether the script is being run via a bot brain. */ is_brain: true }>
+
+// _id is always returned unless _id: false is passed
+// when anyField: true is given, other fields (except _id) are omitted
+
+type MongoProject<TDocument, TProjection> =
+	true extends (1 extends TProjection[keyof TProjection] ? true : TProjection[keyof TProjection]) ?
+		(TProjection extends { _id: false | 0 } ? {} : { _id: TDocument extends { _id: infer TId } ? TId : MongoId }) &
+			{
+				[K in
+					keyof TDocument as K extends keyof TProjection ? TProjection[K] extends true | 1 ? K : never : never
+				]: TDocument[K]
+			} &
+			{
+				-readonly [K in
+					keyof TProjection as TProjection[K] extends true | 1 ? K extends keyof TDocument ? never : K : never
+				]?: MongoValue
+			}
+	: { [k: string]: MongoValue } & { [K in keyof TDocument as K extends keyof TProjection ? never : K]: TDocument[K] }
 
-	/** Remove documents from a collection.
-	  * @param query Specifies deletion criteria using query operators. */
-	r: (query: Query) => {
-		ok: 0 | 1
-		n: number
-		opTime: { ts: "Undefined Conversion", t: number }
-		electionId: "Undefined Conversion"
-		operationTime: "Undefined Conversion"
-		$clusterTime: {
-			clusterTime: "Undefined Conversion"
-			signature: { hash: "Undefined Conversion", keyId: "Undefined Conversion" }
-		}
-	}
+type DeepFreeze<T> = { readonly [P in keyof T]: DeepFreeze<T[P]> }
 
-	/** Find documents in a collection or view and returns a cursor to the selected documents.
-	  * @param query Specifies deletion criteria using query operators.
-	  * @param projection Specifies the fields to return in the documents that match the query filter. */
-	f: (query?: Query, projection?: Projection) => Cursor
-
-	/** Update an existing documents in a collection.
-	  * @param query Specifies deletion criteria using query operators.
-	  * @param command The modifications to apply.
-	  * {@link https://docs.mongodb.com/manual/reference/method/db.collection.update/#parameters} */
-	u: (query: Query | Query[], command: MongoCommand) => {
-		ok: 0 | 1
-		nModified: number
-		n: number
-		opTime: { ts: "Undefined Conversion", t: number }
-		electionId: "Undefined Conversion"
-		operationTime: "Undefined Conversion"
-		$clusterTime: {
-			clusterTime: "Undefined Conversion"
-			signature: { hash: "Undefined Conversion", keyId: "Undefined Conversion" }
-		}
-	}
+declare global {
+	type Scriptor<TArgs extends any[] = any[]> = { name: string, call: (...args: TArgs) => unknown }
+	type Context = CliContext | SubscriptContext | ScriptorContext | BrainContext
+	type ObjectId = { $oid: string }
 
-	/** Updates one document within the collection based on the filter.
-	  * @param query Specifies deletion criteria using query operators.
-	  * @param command The modifications to apply.
-	  * {@link https://docs.mongodb.com/manual/reference/method/db.collection.update/#parameters} */
-	u1: (query: Query | Query[], command: MongoCommand) => {
-		ok: 0 | 1
-		nModified: number
-		n: number
-		opTime: {
-			ts: "Undefined Conversion"
-			t: number
-		}
-		electionId: "Undefined Conversion"
-		operationTime: "Undefined Conversion"
-		$clusterTime: {
-			clusterTime: "Undefined Conversion"
-			signature: {
-				hash: "Undefined Conversion"
-				keyId: "Undefined Conversion"
-			}
-		}
-	}
+	/** Subscript space that can call FULLSEC scripts. */ const $fs: Fullsec
 
-	/** Update or insert or insert document.
-	  * Same as Update, but if no documents match the query, one document will be inserted based on the properties in
-	  * both the query and the command.
-	  * The `$setOnInsert` operator is useful to set defaults.
-	  * @param query Specifies deletion criteria using query operators.
-	  * @param command The modifications to apply.
-	  * {@link https://docs.mongodb.com/manual/reference/method/db.collection.update/#parameters} */
-	us: (query: Query | Query[], command: MongoCommand) => {
-		ok: 0 | 1
-		nModified: number
-		n: number
-		opTime: { ts: "Undefined Conversion", t: number }
-		electionId: "Undefined Conversion"
-		operationTime: "Undefined Conversion"
-		$clusterTime: {
-			clusterTime: "Undefined Conversion"
-			signature: { hash: "Undefined Conversion", keyId: "Undefined Conversion" }
-		}
+	/** Subscript space that can call HIGHSEC and above scripts. Makes your script HIGHSEC (overrides FULLSEC). */
+	const $hs: Highsec
+
+	/** Subscript space that can call MIDSEC and above scripts. Makes your script MIDSEC (overrides higher security levels).
+	  */
+	const $ms: Midsec
+
+	/** Subscript space that can call LOWSEC and above scripts. Makes your script LOWSEC (overrides higher security levels).
+	  */
+	const $ls: Lowsec
+
+	/** Subscript space that can call any script. Makes your script NULLSEC (overrides higher security levels). */
+	const $ns: Nullsec
+
+	/** Subscript space that can call FULLSEC scripts. */ const $4s: typeof $fs
+
+	/** Subscript space that can call HIGHSEC and above scripts. Makes your script HIGHSEC (overrides FULLSEC). */
+	const $3s: typeof $hs
+
+	/** Subscript space that can call MIDSEC and above scripts. Makes your script MIDSEC (overrides higher security levels).
+	  */
+	const $2s: typeof $ms
+
+	/** Subscript space that can call LOWSEC and above scripts. Makes your script LOWSEC (overrides higher security levels).
+	  */
+	const $1s: typeof $ls
+
+	/** Subscript space that can call any script. Makes your script NULLSEC (overrides higher security levels). */
+	const $0s: typeof $ns
+
+	/** Subscript space that can call any script. Uses seclevel provided in comment before script (defaults to NULLSEC)
+	  * @example
+	  * // @​seclevel MIDSEC
+	  * // note, do NOT copy paste the above line because there is a zero-width space inserted between "@" and "s"
+	  * export function script() {
+	  * 	$s.foo.bar() // will be converted to #ms.foo.bar()
+	  * } */
+	const $s: Nullsec
+
+	const $db: {
+		/** Insert a document or documents into a collection.
+		  * @param documents A document or array of documents to insert into the collection. */
+		i: <T extends MongoDocument>(documents: (T & { _id?: MongoId }) | (T & { _id?: MongoId })[]) =>
+			{ n: number, opTime: { t: number }, ok: 0 | 1 }[]
+
+		/** Remove documents from a collection.
+		  * @param query Specifies deletion criteria using query operators. */
+		r: <T extends MongoDocument>(query: MongoQuery<T>) => { n: number, opTime: { t: number }, ok: 0 | 1 }[]
+
+		/** Find documents in a collection or view and returns a cursor to the selected documents.
+		  * @param query Specifies deletion criteria using query operators.
+		  * @param projection Specifies the fields to return in the documents that match the query filter. */
+		f: <
+			const TQuery extends MongoQueryObject & { _id?: MongoQueryId },
+			const TProjection extends { [k: string]: boolean | 0 | 1 } = {}
+		>(query: TQuery, projection?: TProjection) => Cursor<MongoProject<MongoQueryType<TQuery>, TProjection>>
+
+		/** Update existing documents in a collection.
+		  * @param query Specifies deletion criteria using query operators.
+		  * @param command The modifications to apply.
+		  * {@link https://docs.mongodb.com/manual/reference/method/db.collection.update/#parameters} */
+		u: <T extends MongoDocument>(query: MongoQuery<T> | MongoQuery<T>[], command: MongoUpdateCommand<T>) =>
+			{ n: number, opTime: { t: number }, ok: 0 | 1, nModified: number }[]
+
+		/** Updates one document within the collection based on the filter.
+		  * @param query Specifies deletion criteria using query operators.
+		  * @param command The modifications to apply.
+		  * {@link https://docs.mongodb.com/manual/reference/method/db.collection.update/#parameters} */
+		u1: <T extends MongoDocument>(query: MongoQuery<T> | MongoQuery<T>[], command: MongoUpdateCommand<T>) =>
+			{ n: number, ok: 0 | 1, opTime: { t: number }, nModified: number }[]
+
+		/** Update or insert document.
+		  * Same as Update, but if no documents match the query, one document will be inserted based on the properties in
+		  * both the query and the command.
+		  * The `$setOnInsert` operator is useful to set defaults.
+		  * @param query Specifies deletion criteria using query operators.
+		  * @param command The modifications to apply.
+		  * {@link https://docs.mongodb.com/manual/reference/method/db.collection.update/#parameters} */
+		us: <T extends MongoDocument>(query: MongoQuery<T> | MongoQuery<T>[], command: MongoUpdateCommand<T>) =>
+			{ n: number, ok: 0 | 1, opTime: { t: number }, nModified: number }[]
+
+		ObjectId: () => ObjectId
 	}
+
+	/** Debug Log.
+	  *
+	  * If `$D()` is called in a script you own, the `return` value of the top level script is suppressed and instead an
+	  * array of every `$D()`’d entry is printed.
+	  * This lets you use `$D()` like `console.log()`.
+	  *
+	  * `$D()` in scripts not owned by you are not shown but the `return` value always is.
+	  *
+	  * `$D()` returns the first argument so `$D("Hello, World!") evaluates to `"Hello, World!"` as if the `$D` text wasn't
+	  * there.
+	  *
+	  * `$D()`’d items are returned even if the script times out or errors. */
+	function $D<T>(args: T): T
+
+	/** Function Multi-Call Lock.
+	  *
+	  * This is used by escrow to ensure that it is only used once in script execution.
+	  *
+	  * The first time (per-script) `$FMCL` is encountered, it returns `undefined`, every other time it `return`s `true`.
+	  *
+	  * @example
+	  * if ($FMCL)
+	  * 	return { ok: false, msg: "This script can only be used once per script execution." }
+	  *
+	  * // all code here will only run once */
+	const $FMCL: undefined | true
+
+	/** Per-script mutable "global" persistent object that is discarded at the end of top level script execution.
+	  *
+	  * `$G` persists between script calls until the end of the main script run making it useful for caching db entries when
+	  * your script is a subscript.
+	  * @example
+	  * if (!$G.dbCache)
+	  * 	$G.dbCache = $db.f({ whatever: true }).first() */
+	const $G: Record<string | symbol, any>
+
+	/** This contains a JS timestamp (not Date) set immediately before your code begins running.
+	  * @example
+	  * $D(Date.now() - _START) // milliseconds left of run time
+	  */
+	const _START: number
+
+	/** This contains a JS timestamp (not Date) set immediately before your code begins running.
+	  * @example
+	  * $D(Date.now() - _ST) // milliseconds left of run time */
+	const _ST: typeof _START
+
+	/** JavaScript timestamp for the end of the script run (`_START + _TIMEOUT`). */ const _END: number
+
+	/** The number of milliseconds a script can run for. Normally `5000` though it has been known to change. */
+	const _TIMEOUT: number
+
+	/** The number of milliseconds a script can run for. Normally `5000` though it has been known to change. */
+	const _TO: typeof _TIMEOUT
+
+	/** The source code of this script as a string. */ const _SOURCE: string
+	/** A unix timestamp of the date this script was built. */ const _BUILD_DATE: number
+
+	/** The user this script has been uploaded to.
+	  *
+	  * Shorter alternative to `context.this_script.split(".")[0].
+	  *
+	  * In rare cases where it's not known at build time, it's `"UNKNOWN"`. */
+	const _SCRIPT_USER: string
+
+	/** @deprecated Use `_SCRIPT_SUBNAME` instead. */
+	const _SCRIPT_NAME: string
+
+	/** The name of this script excluding the user and `.`.
+	  *
+	  * e.g. in the script `foo.bar`, `_SCRIPT_NAME` is `bar`.
+	  *
+	  * Shorter alternative to `context.this_script.split(".")[1].
+	  *
+	  * In rare cases where it's not known at build time, it's `"UNKNOWN"`. */
+	const _SCRIPT_SUBNAME: string
+
+	/** The full name of this script equivilent to `context.this_script` but should use less characters.
+	  *
+	  * In rare cases where it's not known at build time, it's `"UNKNOWN"`. */
+	const _FULL_SCRIPT_NAME: string
+
+	/** The seclevel of this script as a number.
+	  *
+	  * In rare cases where it's not known at build time, it's `-1`. */
+	const _SECLEVEL: -1 | 0 | 1 | 2 | 3 | 4
+
+	/** Recursively
+	  * [`Object.freeze()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze)
+	  * an object and its properties' objects and its properties' objects and so on.
+	  *
+	  * [Official Hackmud Wiki](https://wiki.hackmud.com/scripting/extensions/deep_freeze) */
+	const DEEP_FREEZE: <T>(value: T) => DeepFreeze<T>
+
+	const _RUN_ID: string
 }
 
-/** Debug Log.
-  *
-  * If `$D()` is called in a script you own, the `return` value of the top level script is suppressed and instead an
-  * array of every `$D()`’d entry is printed.
-  * This lets you use `$D()` like `console.log()`.
-  *
-  * `$D()` in scripts not owned by you are not shown but the `return` value always is.
-  *
-  * `$D()` returns the first argument so `$D("Hello, World!") evaluates to `"Hello, World!"` as if the `$D` text wasn't
-  * there.
-  *
-  * `$D()`’d items are returned even if the script times out or errors. */
-declare function $D<T>(args: T): T
-
-/** Function Multi-Call Lock.
-  *
-  * This is used by escrow to ensure that it is only used once in script execution.
-  *
-  * The first time (per-script) `$FMCL` is encountered, it returns `undefined`, every other time it `return`s `true`.
-  *
-  * @example
-  * if ($FMCL)
-  * 	return { ok: false, msg: "This script can only be used once per script execution." }
-  *
-  * // all code here will only run once */
-declare const $FMCL: undefined | true
-
-/** Per-script mutable "global" persistent object that is discarded at the end of top level script execution.
-  *
-  * `$G` persists between script calls until the end of the main script run making it useful for caching db entries when
-  * your script is a subscript.
-  * @example
-  * if (!$G.dbCache)
-  * 	$G.dbCache = $db.f({ whatever: true }).first() */
-declare const $G: any
-
-/** This contains a JS timestamp (not Date) set immediately before your code begins running.
-  * @example
-  * $D(Date.now() - _START) // milliseconds left of run time
-  */
-declare const _START: number
-
-/** This contains a JS timestamp (not Date) set immediately before your code begins running.
-  * @example
-  * $D(Date.now() - _ST) // milliseconds left of run time */
-declare const _ST: typeof _START
-
-/** JavaScript timestamp for the end of the script run (`_START + _TIMEOUT`). */ declare const _END: number
-
-/** The number of milliseconds a script can run for. Normally `5000` though it has been known to change. */
-declare const _TIMEOUT: number
-
-/** The number of milliseconds a script can run for. Normally `5000` though it has been known to change. */
-declare const _TO: typeof _TIMEOUT
-
-/** The source code of this script as a string. */ declare const _SOURCE: string
-/** A unix timestamp of the date this script was built. */ declare const _BUILD_DATE: number
-
-/** The user this script has been uploaded to.
-  *
-  * Shorter alternative to `context.this_script.split(".")[0].
-  *
-  * In rare cases where it's not known at build time, it's `"UNKNOWN"`. */
-declare const _SCRIPT_USER: string
-
-/** The name of this script excluding the user and `.`.
-  *
-  * e.g. in the script `foo.bar`, `_SCRIPT_NAME` is `bar`.
-  *
-  * Shorter alternative to `context.this_script.split(".")[1].
-  *
-  * In rare cases where it's not known at build time, it's `"UNKNOWN"`. */
-declare const _SCRIPT_NAME: string
-
-/** The full name of this script equivilent to `context.this_script` but should use less characters.
-  *
-  * In rare cases where it's not known at build time, it's `"UNKNOWN"`. */
-declare const _FULL_SCRIPT_NAME: string
-
-/** The seclevel of this script as a number.
-  *
-  * In rare cases where it's not known at build time, it's `-1`. */
-declare const _SECLEVEL: -1 | 0 | 1 | 2 | 3 | 4
+export {}