@s2script/sdk 0.5.0 → 0.5.1

package/admin.d.ts

@@ -7,26 +7,43 @@
 
 /** SourceMod-parity admin flag bitmask constants (SM bit values). */
 export declare const ADMFLAG: {
+  /** Reserved-slot access (`1<<0` = 1). */
   readonly RESERVATION: number;
+  /** Generic admin — the baseline "is an admin" flag (`1<<1` = 2). */
   readonly GENERIC:     number;
+  /** May kick players (`1<<2` = 4). */
   readonly KICK:        number;
+  /** May ban players (`1<<3` = 8). */
   readonly BAN:         number;
+  /** May remove bans (`1<<4` = 16). */
   readonly UNBAN:       number;
+  /** May slay/slap players (`1<<5` = 32). */
   readonly SLAY:        number;
+  /** May change the map (`1<<6` = 64). */
   readonly CHANGEMAP:   number;
+  /** May change most convars (`1<<7` = 128). */
   readonly CONVARS:     number;
+  /** May execute config files (`1<<8` = 256). */
   readonly CONFIG:      number;
+  /** Admin-chat and other special chat privileges (`1<<9` = 512). */
   readonly CHAT:        number;
+  /** May start votes (`1<<10` = 1024). */
   readonly VOTE:        number;
+  /** May set the server password (`1<<11` = 2048). */
   readonly PASSWORD:    number;
+  /** May use rcon commands (`1<<12` = 4096). */
   readonly RCON:        number;
+  /** May change cheat convars and use cheat commands (`1<<13` = 8192). */
   readonly CHEATS:      number;
+  /** Full access — implicitly satisfies every flag (`1<<14` = 16384). See {@link AdminInfo.hasFlags}. */
   readonly ROOT:        number;
 };
 
 /** An admin entry: their SteamID64, their combined flag mask, and a helper to check flags. */
 export interface AdminInfo {
+  /** This admin's SteamID64 (decimal string). */
   readonly steamId: string;
+  /** Combined flag mask (union of file + runtime tiers and group flags) — test against {@link ADMFLAG} bits. */
   readonly flags:   number;
   /** Immunity level (0 = none). A lower-immunity admin cannot target a higher one. */
   readonly immunity: number;
@@ -38,13 +55,23 @@ export interface AdminInfo {
 
 /** A resolved admin group (from admin_groups.json): its flags, immunity, and per-command overrides. */
 export interface AdminGroup {
+  /** The group's name (its key in admin_groups.json). */
   readonly name: string;
+  /** Flag mask granted to every member — {@link ADMFLAG} bits. */
   readonly flags: number;
+  /** Immunity level conferred by membership (0 = none). */
   readonly immunity: number;
+  /** Per-command access overrides, keyed by command name: `public` opens it to all, `mask` is the required flags. */
   readonly overrides: Readonly<Record<string, { public: boolean; mask: number }>>;
 }
 
-/** The admin API: add/remove runtime admins, look up by SteamID or slot, reload from file. */
+/**
+ * The admin API: add/remove runtime admins, look up by SteamID or slot, reload from file.
+ * @example
+ * import { Admin, ADMFLAG } from "@s2script/sdk/admin";
+ * const a = Admin.forSlot(p.slot);
+ * const adminStr = a ? "yes(flags=0x" + a.flags.toString(16) + ")" : "no";
+ */
 export declare const Admin: {
   /** Add (or overwrite) a runtime admin. Not persisted to admins.json. */
   add(steamId: string, flags: number, immunity?: number): void;

package/bans.d.ts

@@ -29,7 +29,14 @@ export interface BanEntry {
   reason: string;
 }
 
-/** The ban API: add/remove bans, look up by SteamID64, list, and reload from bans.json. */
+/**
+ * The ban API: add/remove bans, look up by SteamID64, list, and reload from bans.json.
+ * @example
+ * import { Bans } from "@s2script/sdk/bans";
+ * // Connect-time enforcement inside a Clients.onConnect handler.
+ * const b = Bans.get(c.steamId);
+ * if (b && (b.until === 0 || b.until > Date.now() / 1000)) c.kickWithReason(b.reason);
+ */
 export declare const Bans: {
   /** Add (or overwrite) a ban and persist it to bans.json. `minutes <= 0` = permanent. */
   add(steamId: string, minutes: number, reason?: string): void;

package/chat.d.ts

@@ -1,5 +1,12 @@
 /** @s2script/chat — print messages to player chat. NO runtime code (injected at load). */
 
+/**
+ * Print messages to player chat (SayText2), with a caller-owned {@link Chat.color} prefix.
+ * @example
+ * import { Chat } from "@s2script/sdk/chat";
+ * Chat.toAll("[Vote] Result: " + winner);
+ * Chat.toSlot(slot, "Usage: @@<target> <message>");
+ */
 export declare const Chat: {
   /**
    * An opaque prefix prepended to every chat message (NOT rcon/console replies). Color is content the

package/clients.d.ts

@@ -2,8 +2,10 @@
  * @s2script/clients — engine-generic client handle + lifecycle events.
  * Resolved at runtime via globalThis.__s2pkg_clients. Import: import { Client, Clients } from "./clients";
  */
+
 /** A connected client, identified by its 0-based slot (CPlayerSlot). Slot-backed; getters read live. */
 export declare class Client {
+  /** The client's 0-based engine slot (`CPlayerSlot`) — the handle's stable identity for its connection. */
   readonly slot: number;
   /** True while a client occupies this slot. */
   isValid(): boolean;
@@ -35,9 +37,15 @@ export declare class Client {
    */
   voiceMuted: boolean;
 }
+/**
+ * Look up connected clients by slot or enumerate them all.
+ * @example
+ * import { Clients } from "@s2script/sdk/clients";
+ * console.log(`onLoad — all()=${Clients.all().length} clients`);
+ */
 export declare const Clients: {
   /** The client in `slot`, or null if the slot is empty. */
   fromSlot(slot: number): Client | null;
-  /** Every currently-connected client. */
+  /** Every currently-connected client (bots included). */
   all(): Client[];
 };

package/commands.d.ts

@@ -1,4 +1,9 @@
 /** @s2script/commands — register server commands. NO runtime code (injected at load). */
+
+/**
+ * The parsed invocation handed to a command callback: who called it, its arguments (multiple typed
+ * accessors), and a caller-appropriate `reply` channel. Valid only for the duration of the callback.
+ */
 export interface CommandInvocation {
   /** 0-based caller slot, or -1 for the server console. */
   readonly callerSlot: number;
@@ -32,6 +37,14 @@ export interface ChatTrigger {
   readonly argString: string;
 }
 
+/**
+ * Command-registry utilities: dispatch by name, parse/route chat triggers, and enumerate the global
+ * registry. Commands themselves are registered through the plugin context (`ctx.commands.register*`).
+ * @example
+ * import { Commands } from "@s2script/sdk/commands";
+ * // sm_help backend: every registered command + its required admin flag mask.
+ * const cmds = Commands.list().slice().sort((a, b) => (a.name < b.name ? -1 : 1));
+ */
 export declare const Commands: {
   /** Invoke a registered command by name in THIS plugin (applying its gating). Returns true if it exists. */
   dispatch(name: string, slot: number, argString: string): boolean;

package/config.d.ts

@@ -1,11 +1,23 @@
 /** @s2script/config — typed access to the plugin's materialized config. NO runtime code. */
 /** A materialized config value: a scalar, or a nested section object of further values. */
 export type ConfigValue = string | number | boolean | { [k: string]: ConfigValue };
+/** The whole materialized config: top-level keys to {@link ConfigValue}s. Passed to `ctx.config.onChange`. */
 export type Config = Record<string, ConfigValue>;
+/**
+ * Typed access to this plugin's materialized config values (declared under `s2script.config` in the manifest).
+ * @example
+ * import { config } from "@s2script/sdk/config";
+ * // plugins/antiflood/src/plugin.ts:31 — re-read on live-reload
+ * const maxTokens = config.getInt("max_tokens");
+ */
 export declare const config: {
+  /** A config value as a string. `""` if the key is absent. */
   getString(key: string): string;
+  /** A config value as an integer. `0` if the key is absent or non-numeric. */
   getInt(key: string): number;
+  /** A config value as a float. `0` if the key is absent or non-numeric. */
   getFloat(key: string): number;
+  /** A config value as a boolean. `false` if the key is absent. */
   getBool(key: string): boolean;
   /** Read a raw file from the configs dir (name includes its extension, e.g. "maplist.txt"). null if absent. */
   readFile(name: string): string | null;

package/console.d.ts

@@ -5,8 +5,17 @@
 
 /** Engine-provided console (log/error/warn/info). Also available as the global `console`. */
 export declare const console: {
+  /**
+   * Write a line to the server console (and the log). Arguments are stringified and space-joined.
+   * @example
+   * import { console } from "@s2script/sdk/console";
+   * console.log("[antiflood] onLoad — chat flood protection active");
+   */
   log(...data: any[]): void;
+  /** Write a line at error severity. */
   error(...data: any[]): void;
+  /** Write a line at warning severity. */
   warn(...data: any[]): void;
+  /** Write a line at info severity. */
   info(...data: any[]): void;
 };

package/cookies.d.ts

@@ -1,10 +1,43 @@
 /** @s2script/cookies — SM-parity client preference cookies. NO runtime code (injected as __s2pkg_cookies). */
 import type { Client } from "./clients";
-export enum CookieAccess { Public, Protected, Private }
-export interface Cookie { readonly name: string; readonly access: CookieAccess; readonly default: string; }
-export interface CookieOptions { description?: string; access?: CookieAccess; default?: string; }
+
+/** SM-parity access level carried as metadata on a {@link Cookie} definition (client cookie-menu visibility/editability). */
+export enum CookieAccess {
+  /** Visible and editable by the client in the cookie menu. */
+  Public,
+  /** Visible to the client but not editable. */
+  Protected,
+  /** Hidden from the client; plugin-only. */
+  Private,
+}
+/** A registered cookie definition — the handle passed to {@link Cookies.get}/{@link Cookies.set}. */
+export interface Cookie {
+  /** Unique cookie name (the DB key). */
+  readonly name: string;
+  /** Client visibility/editability, per {@link CookieAccess}. */
+  readonly access: CookieAccess;
+  /** Value returned by {@link Cookies.get} when the client has no stored value. */
+  readonly default: string;
+}
+/** Options for {@link Cookies.register}. */
+export interface CookieOptions {
+  /** Human-readable description (shown in a cookie menu). */
+  description?: string;
+  /** Client visibility/editability. @defaultValue {@link CookieAccess.Public} */
+  access?: CookieAccess;
+  /** Fallback value when the client has no stored value. @defaultValue `""` */
+  default?: string;
+}
+/** Entry point for registering and reading/writing client preference cookies. */
 export declare const Cookies: {
-  /** Register (or return an existing) cookie definition. */
+  /**
+   * Register (or return an existing) cookie definition. Idempotent per plugin context — the same name
+   * returns the already-registered {@link Cookie}.
+   * @example
+   * import { Cookies } from "@s2script/sdk/cookies";
+   * const boots = Cookies.register("demo_boots", { default: "0" });
+   * const n = parseInt(Cookies.get(client, boots), 10);
+   */
   register(name: string, opts?: CookieOptions): Cookie;
   /** Cache value for this client (a stored "" is a real value), else the cookie's default. Default for bots. */
   get(client: Client, cookie: Cookie): string;

package/damage.d.ts

@@ -4,7 +4,13 @@
  */
 import type { EntityRef } from "./entity";
 
-/** A block-scoped view of the current damage event (valid only inside a Damage.onPre handler). */
+/**
+ * A block-scoped view of the current damage event (valid only inside a Damage.onPre handler).
+ * @example
+ * import type { DamageInfo } from "@s2script/sdk/damage";
+ * // plugins/basecommands/src/plugin.ts:81 — halve the damage (assign 0 to block it entirely)
+ * ctx.entities.onDamage((info: DamageInfo) => { info.damage = info.damage / 2; });
+ */
 export interface DamageInfo {
   /** The damage amount (m_flDamage). Assigning MODIFIES the live damage; set to 0 to block. */
   damage: number;

package/db.d.ts

@@ -1,26 +1,64 @@
 /** @s2script/db — engine-generic async SQLite database. NO runtime code (injected as __s2pkg_db). */
+
+/** A value bindable as a SQL parameter or returned in a {@link Row}. */
 export type SqlValue = string | number | boolean | null;
+/** One query result row — a column-name→{@link SqlValue} map. */
 export type Row = Record<string, SqlValue>;
-export interface ExecuteResult { changes: number; lastInsertId: number; }
+/** The outcome of a non-SELECT statement run via {@link Database.execute}. */
+export interface ExecuteResult {
+  /** Rows affected by the statement (INSERT/UPDATE/DELETE). */
+  changes: number;
+  /** Rowid of the last inserted row (0 if the statement inserted nothing). */
+  lastInsertId: number;
+}
 
+/** A driver-owned connection — what a {@link Driver} hands back from {@link Driver.connect}. */
 export interface DriverConnection {
+  /** Run a SELECT and resolve every result {@link Row}; `params` bind `?` placeholders. */
   query(sql: string, params?: SqlValue[]): Promise<Row[]>;
+  /** Run a non-SELECT statement and resolve its {@link ExecuteResult}; `params` bind `?` placeholders. */
   execute(sql: string, params?: SqlValue[]): Promise<ExecuteResult>;
+  /** Close the underlying connection. */
   close(): Promise<void>;
 }
-export interface ConnectionConfig { driver: string; name: string; [k: string]: unknown; }
+/** Named-connection config resolved by {@link Database.open} and passed to {@link Driver.connect}. */
+export interface ConnectionConfig {
+  /** Driver name to connect with (e.g. `"sqlite"`). */
+  driver: string;
+  /** The connection's configured name. */
+  name: string;
+  /** Driver-specific options (path, host, credentials, …). */
+  [k: string]: unknown;
+}
+/** A registered database backend; register a custom one via {@link Database.registerDriver}. */
 export interface Driver {
+  /** The driver's name, matched against {@link ConnectionConfig.driver}. */
   readonly name: string;
+  /** Open a connection for `config`, resolving a {@link DriverConnection}. */
   connect(config: ConnectionConfig): Promise<DriverConnection>;
 }
 /** A live database connection (delegates to its driver). */
 export interface Database {
+  /** Run a SELECT and resolve every result {@link Row}; `params` bind `?` placeholders. */
   query(sql: string, params?: SqlValue[]): Promise<Row[]>;
+  /** Run a non-SELECT statement and resolve its {@link ExecuteResult}; `params` bind `?` placeholders. */
   execute(sql: string, params?: SqlValue[]): Promise<ExecuteResult>;
+  /** Close the connection. */
   close(): Promise<void>;
 }
+/** Entry point for opening databases and registering drivers. */
 export declare const Database: {
-  /** Open a connection by name (default "default"). Resolves the driver + config, then connects. */
+  /**
+   * Open a connection by name (default `"default"`). Resolves the driver + config, then connects.
+   * @param name - Connection name from config; omit for `"default"`.
+   * @returns Resolves the connected {@link Database} handle.
+   * @throws Rejects if the name is unknown or the driver fails to connect.
+   * @example
+   * import { Database } from "@s2script/sdk/db";
+   * const db = await Database.open("clientprefs");
+   * await db.execute("CREATE TABLE IF NOT EXISTS cookies (steamid TEXT, name TEXT, value TEXT)");
+   * const rows = await db.query("SELECT value FROM cookies WHERE steamid = ?", ["76561199999999999"]);
+   */
   open(name?: string): Promise<Database>;
   /** Register a custom driver (per-plugin context). SQLite is built in. */
   registerDriver(driver: Driver): void;