@amxts/core 0.2.0 → 0.2.2

package/README.md

@@ -28,10 +28,10 @@ plugin.
   `player.team == "CT"`, `player.hideHud.push("money")`,
   `entity.renderMode = "additive"`.
 - **Events as in the DOM.** `server.addEventListener("putInServer", ...)`,
-  `game.addEventListener("takeDamage", ...)` for the game's events (reapi's
+  `game.addEventListener("takeDamage", ...)` for the game's events (ReAPI's
   hookchains and Ham Sandwich's functions), with
   `event.preventDefault()` and an answer by `return`.
-- **The editor knows the game.** Every native, reapi field and hookchain
+- **The editor knows the game.** Every native, ReAPI field and hookchain
   comes with its type and a tooltip in English or Russian; a typo is a red
   line, not a runtime error.
 - **No import lines.** `Player`, `server`, `print` and the modules' names are
@@ -54,10 +54,11 @@ On the server:
   `amxts_amxx_i386.so`, both tested on a real server. A plugin is compiled
   for its server's system, which the build reads off the server's folder
   (or `--os`).
-- **ReHLDS with ReGameDLL and reapi** - recommended. amxts is tested on it and
-  on plain HLDS, where entity fields and most game events work through AMX
-  Mod X's own modules, and some of ReGameDLL's events come with less or not at
-  all.
+- **ReHLDS with ReGameDLL and ReAPI** - recommended. amxts is tested on it and
+  on plain HLDS, where the entity fields work through AMX Mod X's own modules
+  and the game events come through Ham Sandwich, the game's log and its
+  messages: most of them after the game has acted, and a few of ReGameDLL's
+  not at all.
 - **AMX Mod X 1.9** or later.
 
 To write plugins: [Node.js](https://nodejs.org) 20.12+. The build runs on

package/README.ru.md

@@ -29,9 +29,9 @@ Mod X рядом с Pawn-плагинами. Они вызывают друг д
   `entity.renderMode = "additive"`.
 - **События как в DOM.** `server.addEventListener("putInServer", ...)`,
   `game.addEventListener("takeDamage", ...)` для событий игры (хукчейнов
-  reapi и функций Ham Sandwich), с
+  ReAPI и функций Ham Sandwich), с
   `event.preventDefault()` и ответом через `return`.
-- **Редактор знает игру.** Каждый натив, поле reapi и хукчейн — с типом и
+- **Редактор знает игру.** Каждый натив, поле ReAPI и хукчейн — с типом и
   подсказкой на русском или английском; опечатка — красная строка, а не
   ошибка на сервере.
 - **Без строк импорта.** `Player`, `server`, `print` и имена модулей
@@ -56,10 +56,11 @@ Mod X рядом с Pawn-плагинами. Они вызывают друг д
   `amxts_amxx_i386.so`, оба проверены на настоящем сервере. Плагин
   компилируется под систему своего сервера, которую сборка узнаёт по папке
   сервера (или по `--os`).
-- **ReHLDS с ReGameDLL и reapi** — рекомендуется. amxts проверяется на нём и
-  на обычном HLDS, где поля сущностей и большинство событий игры работают через
-  собственные модули AMX Mod X, а часть событий ReGameDLL приходит с меньшим
-  или не приходит вовсе.
+- **ReHLDS с ReGameDLL и ReAPI** — рекомендуется. amxts проверяется на нём и
+  на обычном HLDS, где поля сущностей работают через собственные модули AMX
+  Mod X, а события игры приходят через Ham Sandwich, лог игры и её сообщения:
+  большинство — когда игра уже сделала своё, а некоторые события ReGameDLL не
+  приходят вовсе.
 - **AMX Mod X 1.9** или новее.
 
 Для разработки плагинов: [Node.js](https://nodejs.org) 20.12+. Сборка работает

package/as/events.ts

@@ -68,7 +68,7 @@ export class ServerChangelevelEvent {
 }
 
 /**
- * Every config has been read and every plugin is loaded: the moment to read cvars and to create forwards other plugins listen to.
+ * Every plugin has started: the moment to create forwards other plugins listen to. The configs run after it: read cvars in `"configsExecuted"`.
  *
  * Note: When this forward is called, most plugins should have registered their cvars and commands already.
  *
@@ -2255,7 +2255,7 @@ export interface ServerEventMap {
 	 */
 	changeLevel: ServerChangelevelEvent;
 	/**
-	 * Every config has been read and every plugin is loaded: the moment to read cvars and to create forwards other plugins listen to.
+	 * Every plugin has started: the moment to create forwards other plugins listen to. The configs run after it: read cvars in `"configsExecuted"`.
 	 *
 	 * Pawn: `plugin_cfg`
 	 */

package/as/tsconfig.json

@@ -3,6 +3,7 @@
 	"compilerOptions": {
 		"target": "es2015",
 		"moduleDetection": "force",
+		"useUnknownInCatchVariables": false,
 		"module": "esnext",
 		"moduleResolution": "bundler",
 		"paths": {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@amxts/core",
 	"type": "module",
-	"version": "0.2.0",
+	"version": "0.2.2",
 	"description": "Counter-Strike 1.6 plugins in TypeScript: compiled ahead of time and run inside AMX Mod X, next to Pawn plugins.",
 	"author": {
 		"name": "kukson777",
@@ -104,12 +104,12 @@
 		"assemblyscript": "0.28.20"
 	},
 	"optionalDependencies": {
-		"@amxts/wamrc-linux-x64": "^0.2.0",
-		"@amxts/wamrc-win32-x64": "^0.2.0"
+		"@amxts/wamrc-linux-x64": "^0.2.2",
+		"@amxts/wamrc-win32-x64": "^0.2.2"
 	},
 	"devDependencies": {
-		"@amxts/config-core": "^0.1.1",
-		"@amxts/menu-core": "^0.2.0",
+		"@amxts/config-core": "^0.1.2",
+		"@amxts/menu-core": "^0.2.1",
 		"@e18e/eslint-plugin": "^0.8.1",
 		"@eslint-community/eslint-plugin-eslint-comments": "^4.8.1",
 		"@stylistic/eslint-plugin": "^5.10.0",

package/scripts/compile-cache.ts

@@ -1,7 +1,8 @@
 // Compiles kept on disk, reused while what they read is the same.
 //
 // A compile is keyed by everything that is not a file it read - the
-// compiler, the hood's scripts, the flags, the project and its config - and
+// compiler, the hood's scripts, the version the core builds as (a plugin
+// carries it in its ABI), the flags, the project and its config - and
 // stored with every file read it made (scripts/tracked-fs.ts): the entry, what
 // it imports, the facade and the generated API, the module packages. It is
 // taken again only while each of those reads sees the same thing it saw, so a
@@ -15,6 +16,7 @@ import type { Reads } from './tracked-fs';
 import { existsSync, mkdirSync, readdirSync, readFileSync, renameSync, rmSync, statSync, writeFileSync } from 'node:fs';
 import { dirname, join, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
+import { coreVersion } from './build-identity';
 import { listIncludes } from './includes';
 import { currentProjectDir, loadProject } from './project';
 import { hashOf, recordReads, unchanged } from './tracked-fs';
@@ -118,7 +120,7 @@ export function diskCache(dir: string | null, code: () => string, ownIncludes: s
 	let identity: string | null = null;
 	const fileOf = (parts: unknown[]) => {
 		identity ??= hashOf(`${FORMAT}\n${code()}`);
-		return join(dir!, `${hashOf(JSON.stringify([identity, projectIdentity(ownIncludes), ...parts]))}.json`);
+		return join(dir!, `${hashOf(JSON.stringify([identity, coreVersion(), projectIdentity(ownIncludes), ...parts]))}.json`);
 	};
 
 	let pruned = false;

package/scripts/docs/events.ts

@@ -53,8 +53,8 @@ export const EVENTS: Record<string, EventDoc> = {
 	},
 	plugin_cfg: {
 		summary: {
-			en: `Every config has been read and every plugin is loaded: the moment to read cvars and to create forwards other plugins listen to.`,
-			ru: `Все конфиги прочитаны, все плагины загружены: момент читать квары и создавать форварды для других плагинов.`,
+			en: `Every plugin has started: the moment to create forwards other plugins listen to. The configs run after it: read cvars in \`"configsExecuted"\`.`,
+			ru: `Все плагины запустились: момент создавать форварды для других плагинов. Конфиги выполняются после него: квары читайте в \`"configsExecuted"\`.`,
 		},
 	},
 	plugin_end: {

package/scripts/prepare.ts

@@ -115,6 +115,9 @@ const tsconfig = {
 		// plugin declares is its own, never a global another plugin's name
 		// collides with.
 		moduleDetection: 'force',
+		// `catch (error)` reads `error.message` as the compiler takes it: the
+		// base config's strict mode would make the caught value `unknown`.
+		useUnknownInCatchVariables: false,
 		paths,
 	},
 	include: [

package/scripts/upgrade.ts

@@ -30,11 +30,12 @@ import type { Kind } from './upgrade-names';
 // with its title (scripts/upgrade-menus.ts). What is rewritten no longer
 // matches, so a second run changes nothing.
 import { existsSync, readdirSync, readFileSync, writeFileSync } from 'node:fs';
-import { join, relative, resolve } from 'node:path';
+import { basename, dirname, join, relative, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import ts from 'typescript';
 import { MESSAGE_NAMES } from './client-messages';
 import { CORE_ENTRIES, CORE_PLUGINS, loadProject } from './project';
+import { apiFiles, serverFolder } from './system';
 import { c, log } from './ui';
 import { upgradeMenus } from './upgrade-menus';
 import { COMMON, EVENTS, FLAG_NAMES, GAME_EVENT_FIELDS, HIDDEN, HIDDEN_EVENTS, JOIN_OPTIONS, RENAMED, SERVER_EVENT_CLASSES, SERVER_EVENT_FIELDS, SERVER_EVENTS, SERVER_EVENTS_BY_HAND, SERVER_FIELD_CLASSES, SERVER_GAME_EVENTS } from './upgrade-names';
@@ -774,15 +775,41 @@ export function upgradeFlags(file: string, text: string): { text: string; change
 /** Folders that are not the project's code: what is installed, built or generated. */
 const SKIP = new Set(['node_modules', 'dist', '.amxts', '.git']);
 
+/** A server's addons/amxts: the module's files, written over on every start. */
+const SERVER_FOLDER = /[\\/]addons[\\/]amxts$/i;
+
 /** The project's TypeScript files: its plugins, its tests and fixtures, a module's sources. */
 function codeFiles(dir: string, skip: Set<string>): string[] {
 	return readdirSync(dir, { withFileTypes: true }).flatMap((entry) => {
 		const path = join(dir, entry.name);
-		if (entry.isDirectory()) return SKIP.has(entry.name) || skip.has(path) || entry.name.startsWith('.') ? [] : codeFiles(path, skip);
+		if (entry.isDirectory()) return SKIP.has(entry.name) || skip.has(path) || entry.name.startsWith('.') || SERVER_FOLDER.test(path) ? [] : codeFiles(path, skip);
 		return /\.(?:ts|mts|cts)$/.test(entry.name) ? [path] : [];
 	});
 }
 
+/** The server's addons/amxts that AMXTS_SERVER names, or '' when it names none. */
+function serverDir(): string {
+	try {
+		const dir = serverFolder(process.env.AMXTS_SERVER ?? '');
+		return dir && resolve(dir);
+	} catch {
+		return '';
+	}
+}
+
+/**
+ * The project's code to upgrade. The module's own files - the API a server
+ * writes beside its plugins, at the core's version it runs - are not, in the
+ * server's folder or a copy of one; a file of that name in the plugins
+ * folder is the author's.
+ */
+function projectFiles(dir: string, pluginsDir: string, outDir: string): string[] {
+	// The API at the top of as/, and the editor's globals: what the module
+	// writes beside the plugins (scripts/server-files.ts).
+	const theirs = new Set([...apiFiles(), 'imports.d.ts']);
+	return codeFiles(dir, new Set([outDir, serverDir()])).filter(file => !theirs.has(basename(file)) || dirname(file) === pluginsDir);
+}
+
 /** Rewrites the project in `dir`: every change, in the order of the files, and what is left to do by hand. `write: false` only lists them. */
 export function upgradeProject(dir: string, { write = true } = {}): { changes: Change[]; left: Left[] } {
 	const project = loadProject(dir);
@@ -790,7 +817,7 @@ export function upgradeProject(dir: string, { write = true } = {}): { changes: C
 	const renames = renamesFor(project.modules, place => ownFolder && existsSync(join(project.pluginsDir, place)));
 	const changes: Change[] = [];
 	const left: Left[] = [];
-	for (const file of codeFiles(project.dir, new Set([project.outDir]))) {
+	for (const file of projectFiles(project.dir, resolve(project.pluginsDir), project.outDir)) {
 		const text = readFileSync(file, 'utf8');
 		const name = relative(project.dir, file).replace(/\\/g, '/');
 		const http = dropHttpImports(name, text);

package/src/testing/index.ts

@@ -26,7 +26,8 @@ export { constant } from './tables';
 
 /**
  * Compiles a plugin (once per test run), loads it into a new fake server and
- * starts the map: its top level runs, then plugin_init and plugin_cfg.
+ * starts the map: its top level runs, then plugin_init, plugin_cfg and
+ * OnConfigsExecuted.
  *
  * Several plugins go into one server as an array - they hear each other's
  * forwards and natives, as on a real one.

package/src/testing/server.ts

@@ -826,11 +826,17 @@ export class FakeServer {
 		return plugin;
 	}
 
-	/** plugin_precache, plugin_init and plugin_cfg, as a map start sends them. */
+	/**
+	 * What a map start sends, in AMX Mod X's order: plugin_precache,
+	 * plugin_init, plugin_cfg, then OnAutoConfigsBuffered and
+	 * OnConfigsExecuted, once the server has run its configs.
+	 */
 	start(): void {
 		this.fire('plugin_precache');
 		this.fire('plugin_init');
 		this.fire('plugin_cfg');
+		this.fire('OnAutoConfigsBuffered');
+		this.fire('OnConfigsExecuted');
 	}
 
 	// ------------------------------------------------------------ what a test reads

package/src/testing/setup.ts

@@ -27,7 +27,7 @@ export interface SetupOptions extends ServerOptions {
 	 * `["welcome"]` - in this order; all of them when left out, none for `[]`.
 	 */
 	plugins?: string[];
-	/** Starts the map - plugin_init, then plugin_cfg - once everything is loaded. True when left out. */
+	/** Starts the map - plugin_init, plugin_cfg, then OnConfigsExecuted - once everything is loaded. True when left out. */
 	start?: boolean;
 }