hackmud-script-manager 0.20.4-23a791c → 0.20.4-34f0749

package/env.d.ts

@@ -1,19 +1,9 @@
-type Replace<T, R> = Omit<T, Extract<keyof R, keyof T>> & R
+type Replace<A, B> = Omit<A, keyof B> & B
 type ScriptSuccess<T = object> = { ok: true } & T
 type ScriptFailure = { ok: false, msg?: string }
 type ScriptResponse<T = object> = ScriptSuccess<T> | ScriptFailure
 type ErrorScripts = Record<string, () => ScriptFailure>
-
-type AllOptional<T> = {
-	[K in keyof T]-?: {} extends Pick<T, K> ? true : false
-}[keyof T]
-
-type Scriptor<Args = unknown, Ret = unknown> = {
-	name: string,
-	call: AllOptional<Args> extends true
-		? (args?: Args) => Ret
-		: (args: Args) => Ret
-}
+type Scriptor<TArgs extends any[] = any[]> = { name: string, call: (...args: TArgs) => unknown }
 
 type Subscripts = Record<string, Record<string, (...args: any) => any>> & {
 	accts: ErrorScripts
@@ -41,7 +31,7 @@ type UpgradeRarityString = "`0noob`" | "`1kiddie`" | "`2h4x0r`" | "`3h4rdc0r3`"
 type UpgradeRarityNumber = 0 | 1 | 2 | 3 | 4 | 5;
 type UpgradeRarity = UpgradeRarityString | UpgradeRarityNumber;
 
-type UpgradeCore = {
+type UpgradeBase = {
 	name: string
 	type: "lock" | "script_space" | "chat" | "script" | "tool" | "bot_brain" | "glam"
 	up_class?: -1 | 0 | 1 | 2 | 3
@@ -53,9 +43,9 @@ type UpgradeCore = {
 	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`> & {
+type CliUpgrade = Omit<UpgradeBase, `rarity`> & {
 	[x: string]: null | boolean | number | string
 	rarity: UpgradeRarityString
 }
@@ -155,7 +145,16 @@ type Fullsec = Subscripts & PlayerFullsec & {
 	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 }): {
@@ -357,7 +356,7 @@ type Fullsec = Subscripts & PlayerFullsec & {
 			  * const arr = [ 1, 2, 2, 3, 2 ]
 			  *
 			  * $D(uniq(arr)) // [ 1, 2, 3, 2 ] */
-			uniq: (array: T[]) => T[]
+			uniq: <T>(array: T[]) => T[]
 
 			/** Sorts an array of numbers or number-coercible strings in descending order. */
 			u_sort_num_arr_desc: <T>(array: T[]) => T[]
@@ -424,17 +423,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
 		}
 
@@ -511,7 +510,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?: {
@@ -519,20 +518,20 @@ 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: UpgradeRarityString
 			})[] | ScriptFailure
@@ -714,10 +713,50 @@ type Nullsec = Lowsec & PlayerNullsec & {
 	}
 }
 
+type MongoTypeString = "minKey" | "double" | "string" | "object" | "array" | "binData" | "undefined" | "objectId" |
+	"bool" | "date" | "null" | "regex" | "dbPointer" | "javascript" | "symbol" | "int" | "timestamp" | "long" | "decimal" | "maxKey";
+type MongoTypeNumber = -1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 16 | 17 | 18 | 19 | 127;
+
 type MongoValue = string | number | boolean | Date | MongoValue[] | { [key: string]: MongoValue } | null
 
 type MongoCommandValue = string | number | boolean | Date | MongoCommandValue[] | { [key: string]: MongoCommandValue } |
-	null | undefined
+null | undefined
+
+/**
+ * Currently unused
+ */
+type MongoLogicalSelectors<T extends MongoValue = MongoValue> = {
+	$not: T | MongoComparisonSelectors<T> | MongoLogicalSelectors<T>
+	$nor: T[]
+	$or: T[]
+	$and: T[]
+}
+
+type MongoArraySelectors<T extends Array<MongoValue> = Array<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 MongoElementSelectors = {
+	$exists: boolean
+	$type: MongoTypeNumber | MongoTypeString
+}
+
+type MongoQuerySelector<T extends MongoValue = MongoValue> = Partial<T extends MongoValue[] ?
+	(MongoArraySelectors<T> & MongoElementSelectors & MongoComparisonSelectors<T>) :
+	(MongoElementSelectors & MongoComparisonSelectors<T>)>
 
 type Query = { [key: string]: MongoValue | Query } & { _id?: Id, $in?: MongoValue[] }
 type Projection = Record<string, boolean | 0 | 1>
@@ -766,7 +805,7 @@ type Cursor = {
 	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
@@ -774,17 +813,23 @@ type 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: 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
+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 }>
+
+type Context = CliContext | SubscriptContext | ScriptorContext | BrainContext
 
 /** Subscript space that can call FULLSEC scripts. */ declare const $fs: Fullsec
 
@@ -827,6 +872,8 @@ declare const $0s: typeof $ns
   * } */
 declare const $s: Nullsec
 
+type ObjectId = { $oid: string }
+
 declare const $db: {
 	/** Insert a document or documents into a collection.
 	  * @param documents A document or array of documents to insert into the collection. */
@@ -920,6 +967,8 @@ declare const $db: {
 			signature: { hash: "Undefined Conversion", keyId: "Undefined Conversion" }
 		}
 	}
+
+	ObjectId: () => ObjectId
 }
 
 /** Debug Log.
@@ -956,7 +1005,7 @@ declare const $FMCL: undefined | true
   * @example
   * if (!$G.dbCache)
   * 	$G.dbCache = $db.f({ whatever: true }).first() */
-declare const $G: any
+declare const $G: Record<string | symbol, any>
 
 /** This contains a JS timestamp (not Date) set immediately before your code begins running.
   * @example
@@ -1005,3 +1054,14 @@ declare const _FULL_SCRIPT_NAME: string
   *
   * In rare cases where it's not known at build time, it's `-1`. */
 declare const _SECLEVEL: -1 | 0 | 1 | 2 | 3 | 4
+
+type DeepFreeze<T> = { readonly [P in keyof T]: DeepFreeze<T[P]> }
+
+/** 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) */
+declare const DEEP_FREEZE: <T>(value: T) => DeepFreeze<T>
+
+declare const _RUN_ID: string

package/generateTypeDeclaration.js

@@ -1,5 +1,6 @@
 import { readDirectoryWithStats } from "@samual/lib/readDirectoryWithStats"
 import { basename, resolve } from "path"
+import * as PathPosix from "path/posix"
 async function generateTypeDeclaration(sourceDirectory, hackmudPath) {
 	const users = new Set()
 	if (hackmudPath)
@@ -29,7 +30,7 @@ async function generateTypeDeclaration(sourceDirectory, hackmudPath) {
 			}
 		})
 	)
-	sourceDirectory = resolve(sourceDirectory)
+	sourceDirectory = PathPosix.resolve(sourceDirectory)
 	let o = ""
 	for (const script of wildScripts) o += `type $${script}$ = typeof import("${sourceDirectory}/${script}").default\n`
 	o += "\n"

package/index.js

@@ -7,6 +7,7 @@ export { syncMacros } from "./syncMacros.js"
 export { watch } from "./watch.js"
 import "@samual/lib/readDirectoryWithStats"
 import "path"
+import "path/posix"
 import "@babel/generator"
 import "@babel/parser"
 import "@babel/plugin-proposal-decorators"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hackmud-script-manager",
-  "version": "0.20.4-23a791c",
+  "version": "0.20.4-34f0749",
   "description": "Script manager for game hackmud, with minification, TypeScript support, and player script type definition generation.",
   "keywords": [
     "api",

package/processScript/index.js

@@ -323,7 +323,7 @@ async function processScript(
 			trailingComma: "none"
 		})
 	}
-	code = postprocess(code, seclevel, uniqueId)
+	code = postprocess(code, uniqueId)
 	if (includesIllegalString(code))
 		throw Error(
 			'you found a weird edge case where I wasn\'t able to replace illegal strings like "SC$", please report thx'

package/processScript/minify.js

@@ -43,15 +43,6 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 			)
 		}
 	}
-	const hashGReferencePaths = getReferencePathsToGlobal(`$${uniqueId}$GLOBAL$`, program)
-	if (hashGReferencePaths.length > 3) {
-		for (const path of hashGReferencePaths) path.replaceWith(t.identifier(`_${uniqueId}_G_`))
-		mainFunctionPath.node.body.body.unshift(
-			t.variableDeclaration("let", [
-				t.variableDeclarator(t.identifier(`_${uniqueId}_G_`), t.identifier(`$${uniqueId}$GLOBAL$`))
-			])
-		)
-	}
 	const jsonValues = []
 	let scriptBeforeJSONValueReplacement,
 		comment,
@@ -61,7 +52,7 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 		traverse(fileBeforeJSONValueReplacement, {
 			MemberExpression({ node: memberExpression }) {
 				if (!memberExpression.computed) {
-					assert("Identifier" == memberExpression.property.type, "src/processScript/minify.ts:127:60")
+					assert("Identifier" == memberExpression.property.type, "src/processScript/minify.ts:115:60")
 					if ("prototype" == memberExpression.property.name) {
 						memberExpression.computed = !0
 						memberExpression.property = t.identifier(`_${uniqueId}_PROTOTYPE_PROPERTY_`)
@@ -173,7 +164,7 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 					},
 					MemberExpression({ node: memberExpression }) {
 						if (!memberExpression.computed) {
-							assert("Identifier" == memberExpression.property.type, "src/processScript/minify.ts:261:62")
+							assert("Identifier" == memberExpression.property.type, "src/processScript/minify.ts:249:62")
 							if (!(memberExpression.property.name.length < 3)) {
 								memberExpression.computed = !0
 								memberExpression.property = t.stringLiteral(memberExpression.property.name)
@@ -247,7 +238,7 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 		})
 		await Promise.all(promises)
 		const functionDeclaration = file.program.body[0]
-		assert("FunctionDeclaration" == functionDeclaration.type, "src/processScript/minify.ts:366:61")
+		assert("FunctionDeclaration" == functionDeclaration.type, "src/processScript/minify.ts:354:61")
 		if (jsonValues.length) {
 			hasComment = !0
 			if (1 == jsonValues.length)
@@ -259,7 +250,10 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 								t.memberExpression(
 									t.taggedTemplateExpression(
 										t.memberExpression(
-											t.callExpression(t.identifier(`$${uniqueId}$SUBSCRIPT$scripts$quine$`), []),
+											t.callExpression(
+												t.identifier(`$${uniqueId}$4$SUBSCRIPT$scripts$quine$`),
+												[]
+											),
 											t.identifier("split")
 										),
 										t.templateLiteral([t.templateElement({ raw: "\t", cooked: "\t" }, !0)], [])
@@ -283,7 +277,7 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 							t.memberExpression(
 								t.taggedTemplateExpression(
 									t.memberExpression(
-										t.callExpression(t.identifier(`$${uniqueId}$SUBSCRIPT$scripts$quine$`), []),
+										t.callExpression(t.identifier(`$${uniqueId}$4$SUBSCRIPT$scripts$quine$`), []),
 										t.identifier("split")
 									),
 									t.templateLiteral([t.templateElement({ raw: "\t", cooked: "\t" }, !0)], [])
@@ -308,7 +302,7 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 							t.memberExpression(
 								t.taggedTemplateExpression(
 									t.memberExpression(
-										t.callExpression(t.identifier(`$${uniqueId}$SUBSCRIPT$scripts$quine$`), []),
+										t.callExpression(t.identifier(`$${uniqueId}$4$SUBSCRIPT$scripts$quine$`), []),
 										t.identifier("split")
 									),
 									t.templateLiteral([t.templateElement({ raw: "\t", cooked: "\t" }, !0)], [])
@@ -364,7 +358,7 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 		)
 	}
 	if (1 == forceQuineCheats) return code
-	assert(scriptBeforeJSONValueReplacement, "src/processScript/minify.ts:497:43")
+	assert(scriptBeforeJSONValueReplacement, "src/processScript/minify.ts:485:43")
 	return (
 			countHackmudCharacters(scriptBeforeJSONValueReplacement) <=
 				countHackmudCharacters(code) + Number(hasComment)
@@ -380,7 +374,7 @@ function parseObjectExpression(node, o) {
 			"Identifier" == property.key.type ||
 				"NumericLiteral" == property.key.type ||
 				"StringLiteral" == property.key.type,
-			"src/processScript/minify.ts:519:4"
+			"src/processScript/minify.ts:507:4"
 		)
 		if ("ArrayExpression" == property.value.type) {
 			const childArray = []

package/processScript/postprocess.d.ts

@@ -1 +1 @@
-export declare const postprocess: (code: string, seclevel: number, uniqueId: string) => string;
+export declare const postprocess: (code: string, uniqueId: string) => string;

package/processScript/postprocess.js

@@ -1,12 +1,12 @@
-const postprocess = (code, seclevel, uniqueId) =>
+const postprocess = (code, uniqueId) =>
 	code
-		.replace(/^function\s*\w+\(/, "function(")
+		.replace(/^function\s*[\w$]+\(/, "function(")
 		.replace(RegExp(`\\$${uniqueId}\\$\\\\(?:\\\\)?\\$SC_DOLLAR\\$`, "g"), "S\\C$")
 		.replace(RegExp(`\\$${uniqueId}\\$\\\\(?:\\\\)?\\$DB_DOLLAR\\$`, "g"), "D\\B$")
 		.replace(RegExp(`\\$${uniqueId}\\$\\\\(?:\\\\)?\\$D\\$`, "g"), "_\\_D_S")
 		.replace(RegExp(`\\$${uniqueId}\\$\\\\(?:\\\\)?\\$FMCL\\$`, "g"), "_\\_FMCL_")
 		.replace(RegExp(`\\$${uniqueId}\\$\\\\(?:\\\\)?\\$G\\$`, "g"), "_\\_G_")
-		.replace(RegExp(`\\$${uniqueId}\\$SUBSCRIPT\\$(\\w+)\\$(\\w+)\\$`, "g"), `#${"nlmhf"[seclevel]}s.$1.$2`)
+		.replace(RegExp(`\\$${uniqueId}\\$(\\d)\\$SUBSCRIPT\\$(\\w+)\\$(\\w+)\\$`, "g"), "#$1s.$2.$3")
 		.replace(RegExp(`\\$${uniqueId}\\$DEBUG\\$`, "g"), "#D")
 		.replace(RegExp(`\\$${uniqueId}\\$FMCL\\$`, "g"), "#FMCL")
 		.replace(RegExp(`\\$${uniqueId}\\$GLOBAL\\$`, "g"), "#G")

package/processScript/preprocess.js

@@ -98,8 +98,10 @@ async function preprocess(code, { uniqueId = "00000000000" } = {}) {
 				t.stringLiteral(resolve("proxy-polyfill/src/proxy.js", import.meta.url).slice(7))
 			)
 		)
-	return 1 == program.node.body.length && "FunctionDeclaration" == program.node.body[0].type ?
-			{ code: "export default " + generate(file).code }
-		:	{ code: generate(file).code }
+	if (1 == program.node.body.length && "FunctionDeclaration" == program.node.body[0].type)
+		throw Error(
+			"Scripts that only contain a single function declaration are no longer supported.\nPrefix the function declaration with `export default`."
+		)
+	return { code: generate(file).code }
 }
 export { preprocess }