hackmud-script-manager 0.20.4-7caccd9 → 0.20.4-9d6d467

package/README.md

@@ -1,5 +1,5 @@
 # Hackmud Script Manager
-Command made for [hackmud-environment](https://github.com/samualtnorman/hackmud-environment), which is a scripting environment for hackmud with minification, autocompletes / intellisense, and TypeScript support.
+Command made for [Hackmud Scripting Environment](https://github.com/samualtnorman/hackmud-environment), which is a scripting environment for hackmud with minification, autocompletes / intellisense, and TypeScript support.
 
 [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R6R0XN5CX)
 

package/bin/hsm.js

@@ -12,7 +12,7 @@ import { pull } from "../pull.js"
 import { syncMacros } from "../syncMacros.js"
 import "@samual/lib/readDirectoryWithStats"
 import "@samual/lib/copyFilePersistent"
-const version = "0.20.4-7caccd9",
+const version = "0.20.4-9d6d467",
 	options = new Map(),
 	commands = [],
 	userColours = new Cache(user => {
@@ -119,16 +119,25 @@ switch (commands[0]) {
 				logHelp()
 				break
 			}
-			const { push } = await pushModule
-			;(
-				await push(sourcePath, hackmudPath, {
+			const { push, MissingSourceFolderError, MissingHackmudFolderError, NoUsersError } = await pushModule,
+				infos = await push(sourcePath, hackmudPath, {
 					scripts,
 					onPush: info => logInfo(info, hackmudPath),
 					minify: shouldMinify,
 					mangleNames: shouldMangleNames,
 					forceQuineCheats: shouldforceQuineCheats
 				})
-			).length || logError("Could not find any scripts to push")
+			if (infos instanceof Error) {
+				logError(infos.message)
+				if (infos instanceof MissingSourceFolderError || infos instanceof NoUsersError) {
+					console.log()
+					logHelp()
+				} else
+					infos instanceof MissingHackmudFolderError &&
+						log(
+							`If this is not where your hackmud folder is, you can specify it with the\n${colourN("--hackmud-path")}=${colourB("<path>")} option or ${colourN("HSM_HACKMUD_PATH")} environment variable`
+						)
+			} else infos.length || logError("Could not find any scripts to push")
 		}
 		break
 	case "dev":
@@ -245,7 +254,7 @@ switch (commands[0]) {
 				typeDeclaration = await generateTypeDeclaration(sourcePath, getHackmudPath())
 			let typeDeclarationPath = resolve(outputPath)
 			await writeFile(typeDeclarationPath, typeDeclaration).catch(error => {
-				assert(error instanceof Error, "src/bin/hsm.ts:327:35")
+				assert(error instanceof Error, "src/bin/hsm.ts:340:35")
 				if ("EISDIR" != error.code) throw error
 				typeDeclarationPath = resolve(typeDeclarationPath, "player.d.ts")
 				return writeFile(typeDeclarationPath, typeDeclaration)

package/env.d.ts

@@ -1,18 +1,14 @@
-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 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
+	name: string
+	call: AllOptional<Args> extends true ? (args?: Args) => Ret : (args: Args) => Ret
 }
 
 type Subscripts = Record<string, Record<string, (...args: any) => any>> & {
@@ -41,7 +37,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 +49,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 +151,7 @@ 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, listed_before: number, listed_after: number, cost: number | string } & Omit<CliUpgrade, "rarity">>
 			): { i: string, name: string, rarity: Upgrade["rarity"], cost: number }[] | ScriptFailure
 
 			<I extends string>(args: { i: I }): {
@@ -357,7 +353,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 +420,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 +507,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 +515,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
@@ -766,7 +762,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 +770,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 +829,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 +924,8 @@ declare const $db: {
 			signature: { hash: "Undefined Conversion", keyId: "Undefined Conversion" }
 		}
 	}
+
+	ObjectId: () => ObjectId
 }
 
 /** Debug Log.
@@ -956,7 +962,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 +1011,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hackmud-script-manager",
-  "version": "0.20.4-7caccd9",
+  "version": "0.20.4-9d6d467",
   "description": "Script manager for game hackmud, with minification, TypeScript support, and player script type definition generation.",
   "keywords": [
     "api",
@@ -20,7 +20,11 @@
   "homepage": "https://github.com/samualtnorman/hackmud-script-manager#readme",
   "bugs": "https://github.com/samualtnorman/hackmud-script-manager/issues",
   "license": "MIT",
-  "author": "Samual Norman",
+  "author": "Samual Norman <me@samual.uk> (https://samual.uk/)",
+  "contributors": [
+    "Daniel Swann (https://github.com/danswann)",
+    "Longboyy"
+  ],
   "main": "index.js",
   "repository": {
     "type": "git",

package/processScript/minify.js

@@ -136,7 +136,8 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 		const promises = []
 		traverse(file, {
 			FunctionDeclaration(path) {
-				path.traverse({
+				const body = path.get("body")
+				body.traverse({
 					Function(path) {
 						"CallExpression" != path.parent.type && "callee" != path.parentKey && path.skip()
 					},
@@ -152,7 +153,7 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 							path.replaceWith(t.identifier(`_${uniqueId}_JSON_VALUE_${jsonValues.push(o) - 1}_`))
 					}
 				})
-				path.traverse({
+				body.traverse({
 					TemplateLiteral(path) {
 						if ("TaggedTemplateExpression" == path.parent.type) return
 						const templateLiteral = path.node
@@ -172,7 +173,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:259:62")
+							assert("Identifier" == memberExpression.property.type, "src/processScript/minify.ts:261:62")
 							if (!(memberExpression.property.name.length < 3)) {
 								memberExpression.computed = !0
 								memberExpression.property = t.stringLiteral(memberExpression.property.name)
@@ -246,7 +247,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:364:61")
+		assert("FunctionDeclaration" == functionDeclaration.type, "src/processScript/minify.ts:366:61")
 		if (jsonValues.length) {
 			hasComment = !0
 			if (1 == jsonValues.length)
@@ -363,7 +364,7 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 		)
 	}
 	if (1 == forceQuineCheats) return code
-	assert(scriptBeforeJSONValueReplacement, "src/processScript/minify.ts:495:43")
+	assert(scriptBeforeJSONValueReplacement, "src/processScript/minify.ts:497:43")
 	return (
 			countHackmudCharacters(scriptBeforeJSONValueReplacement) <=
 				countHackmudCharacters(code) + Number(hasComment)
@@ -379,7 +380,7 @@ function parseObjectExpression(node, o) {
 			"Identifier" == property.key.type ||
 				"NumericLiteral" == property.key.type ||
 				"StringLiteral" == property.key.type,
-			"src/processScript/minify.ts:517:4"
+			"src/processScript/minify.ts:519:4"
 		)
 		if ("ArrayExpression" == property.value.type) {
 			const childArray = []

package/processScript/transform.js

@@ -631,7 +631,9 @@ function transform(file, sourceCode, { uniqueId = "00000000000", scriptUser, scr
 		VariableDeclaration({ node: variableDeclaration }) {
 			"const" == variableDeclaration.kind && (variableDeclaration.kind = "let")
 		},
-		ThisExpression: path => path.replaceWith(t.identifier("undefined")),
+		ThisExpression: path => {
+			path.replaceWith(t.identifier("undefined"))
+		},
 		BigIntLiteral(path) {
 			const bigIntAsNumber = Number(path.node.value)
 			path.replaceWith(
@@ -661,23 +663,23 @@ function transform(file, sourceCode, { uniqueId = "00000000000", scriptUser, scr
 	}
 	function processFakeSubscriptObject(fakeSubscriptObjectName) {
 		for (const referencePath of getReferencePathsToGlobal(fakeSubscriptObjectName, program)) {
-			assert("MemberExpression" == referencePath.parent.type, "src/processScript/transform.ts:783:60")
+			assert("MemberExpression" == referencePath.parent.type, "src/processScript/transform.ts:785:60")
 			assert("Identifier" == referencePath.parent.property.type)
 			assert(
 				"MemberExpression" == referencePath.parentPath.parentPath?.node.type,
-				"src/processScript/transform.ts:785:81"
+				"src/processScript/transform.ts:787:81"
 			)
 			assert(
 				"Identifier" == referencePath.parentPath.parentPath.node.property.type,
-				"src/processScript/transform.ts:786:83"
+				"src/processScript/transform.ts:788:83"
 			)
 			assert(
 				/^[_a-z][\d_a-z]{0,24}$/.test(referencePath.parent.property.name),
-				`src/processScript/transform.ts:790:8 invalid user "${referencePath.parent.property.name}" in subscript`
+				`src/processScript/transform.ts:792:8 invalid user "${referencePath.parent.property.name}" in subscript`
 			)
 			assert(
 				/^[_a-z][\d_a-z]{0,24}$/.test(referencePath.parentPath.parentPath.node.property.name),
-				`src/processScript/transform.ts:795:8 invalid script name "${referencePath.parentPath.parentPath.node.property.name}" in subscript`
+				`src/processScript/transform.ts:797:8 invalid script name "${referencePath.parentPath.parentPath.node.property.name}" in subscript`
 			)
 			if ("CallExpression" == referencePath.parentPath.parentPath.parentPath?.type)
 				referencePath.parentPath.parentPath.replaceWith(

package/push.d.ts

@@ -18,6 +18,14 @@ export type PushOptions = LaxPartial<{
       */
     forceQuineCheats: boolean;
 }>;
+export declare class MissingSourceFolderError extends Error {
+}
+export declare class MissingHackmudFolderError extends Error {
+}
+export declare class NoUsersError extends Error {
+}
+export declare class NoScriptsError extends Error {
+}
 /** Push scripts from a source directory to the hackmud directory.
   *
   * Pushes files directly in the source folder to all users
@@ -25,4 +33,4 @@ export type PushOptions = LaxPartial<{
   * @param hackmudPath directory created by hackmud containing user data including scripts
   * @param options {@link PushOptions details}
   * @returns array of info on pushed scripts */
-export declare function push(sourcePath: string, hackmudPath: string, { scripts, onPush, minify, mangleNames, forceQuineCheats }?: PushOptions): Promise<Info[]>;
+export declare function push(sourcePath: string, hackmudPath: string, { scripts, onPush, minify, mangleNames, forceQuineCheats }?: PushOptions): Promise<MissingSourceFolderError | MissingHackmudFolderError | NoUsersError | NoScriptsError | Info[]>;

package/push.js

@@ -42,32 +42,54 @@ import "./processScript/preprocess.js"
 import "import-meta-resolve"
 import "./processScript/transform.js"
 import "@samual/lib/clearObject"
+class MissingSourceFolderError extends Error {}
+Object.defineProperty(MissingSourceFolderError.prototype, "name", { value: "MissingSourceFolderError" })
+class MissingHackmudFolderError extends Error {}
+Object.defineProperty(MissingHackmudFolderError.prototype, "name", { value: "MissingHackmudFolderError" })
+class NoUsersError extends Error {}
+Object.defineProperty(NoUsersError.prototype, "name", { value: "NoUsersError" })
+class NoScriptsError extends Error {}
+Object.defineProperty(NoScriptsError.prototype, "name", { value: "NoScriptsError" })
 async function push(
 	sourcePath,
 	hackmudPath,
 	{ scripts = ["*.*"], onPush = () => {}, minify = !0, mangleNames = !1, forceQuineCheats } = {}
 ) {
 	const [sourceFolder, hackmudFolder] = await Promise.all([
-			readDirectoryWithStats(sourcePath),
-			readDirectoryWithStats(hackmudPath)
-		]),
-		sourceFolderFolders = sourceFolder.filter(({ stats }) => stats.isDirectory()),
+		readDirectoryWithStats(sourcePath).catch(error => {
+			if (error && "ENOENT" == error.code)
+				return new MissingSourceFolderError("There is no folder at " + sourcePath)
+			throw error
+		}),
+		readDirectoryWithStats(hackmudPath).catch(error => {
+			if (error && "ENOENT" == error.code)
+				return new MissingHackmudFolderError("There is no folder at " + hackmudPath)
+			throw error
+		})
+	])
+	if (sourceFolder instanceof Error) return sourceFolder
+	if (hackmudFolder instanceof Error) return hackmudFolder
+	const sourceFolderFolders = sourceFolder.filter(({ stats }) => stats.isDirectory()),
 		allUsers = new Set([
 			...scripts
-				.map(scriptName => ensure(scriptName.split(".")[0], "src/push.ts:52:65"))
+				.map(scriptName => ensure(scriptName.split(".")[0], "src/push.ts:82:65"))
 				.filter(name => "*" != name),
 			...sourceFolderFolders.map(({ name }) => name),
 			...hackmudFolder.filter(({ stats }) => stats.isDirectory()).map(({ name }) => name),
 			...hackmudFolder
 				.filter(({ stats, name }) => stats.isFile() && name.endsWith(".key"))
 				.map(({ name }) => name.slice(0, -4))
-		]),
-		usersToScriptsToPush = new Cache(_user => new Map()),
+		])
+	if (!allUsers.size)
+		return new NoUsersError(
+			"Could not find any users. Either provide the names of your users or log into a user in hackmud"
+		)
+	const usersToScriptsToPush = new Cache(_user => new Map()),
 		scriptNamesToUsers = new Cache(_scriptName => new Set())
 	for (const script of scripts) {
 		const [user, scriptName] = script.split(".")
-		assert(user, "src/push.ts:69:16")
-		assert(scriptName, "src/push.ts:70:22")
+		assert(user, "src/push.ts:105:16")
+		assert(scriptName, "src/push.ts:106:22")
 		"*" == user ? scriptNamesToUsers.set(scriptName, allUsers) : scriptNamesToUsers.get(scriptName).add(user)
 	}
 	const sourceFolderFiles = sourceFolder.filter(({ stats }) => stats.isFile()),
@@ -98,7 +120,7 @@ async function push(
 	for (const [scriptName, users] of scriptNamesToUsers)
 		for (const user of users)
 			if (!usersToScriptsToPush.get(user).has(scriptName))
-				throw Error(`Could not find script ${user}.${scriptName} to push`)
+				return new NoScriptsError(`Could not find script ${user}.${scriptName} to push`)
 	const pathsToUsers = new Cache(_path => new Set())
 	for (const [user, scriptsToPush] of usersToScriptsToPush)
 		for (const path of scriptsToPush.values()) pathsToUsers.get(path).add(user)
@@ -135,4 +157,4 @@ async function push(
 	)
 	return allInfo
 }
-export { push }
+export { MissingHackmudFolderError, MissingSourceFolderError, NoScriptsError, NoUsersError, push }