@nighthawk.hq/macro-sdk 0.1.3 → 0.2.0

package/build/index.js

@@ -8,11 +8,23 @@ const MANIFEST = JSON.parse(readFileSync(join(HERE, '..', 'runtime-manifest.json
 const SPECIFIER = '@nighthawk.hq/macro-sdk';
 const MAX_BYTES = 256 * 1024;
 
+// Manifest values are spliced into generated shim code — refuse anything that
+// isn't a plain identifier / integer rather than trust the file blindly.
+if (!Number.isInteger(MANIFEST.protocol)) {
+  throw new Error('runtime-manifest.json: protocol must be an integer');
+}
+for (const n of MANIFEST.exports) {
+  if (!/^[A-Za-z_$][\w$]*$/.test(n)) {
+    throw new Error(`runtime-manifest.json: invalid export name ${JSON.stringify(n)}`);
+  }
+}
+
 function externalSdkPlugin() {
   const shim =
     'const s = globalThis.__nhSdk;\n' +
     "if (!s) throw new Error('Nighthawk SDK runtime not present in this realm');\n" +
-    MANIFEST.map((n) => `export const ${n} = s.${n};`).join('\n') +
+    `if (s.SDK_PROTOCOL !== ${MANIFEST.protocol}) throw new Error('macro built for SDK protocol ${MANIFEST.protocol}, host provides ' + s.SDK_PROTOCOL + ' — rebuild with the current macro-sdk');\n` +
+    MANIFEST.exports.map((n) => `export const ${n} = s.${n};`).join('\n') +
     '\n';
   return {
     name: 'nighthawk-sdk-external',
@@ -36,6 +48,9 @@ export async function buildMacro({ id, entry, outDir, minify = false }) {
     platform: 'neutral',
     minify,
     outfile,
+    // Protocol stamp: the host reads this before evaluating the bundle.
+    // banner is applied to the output verbatim, so it survives minify.
+    banner: { js: `/*! nh-sdk-protocol:${MANIFEST.protocol} */` },
     plugins: [externalSdkPlugin()],
     logLevel: 'info',
   });

package/lib/index.d.ts

@@ -1,3 +1,4 @@
+export { SDK_PROTOCOL } from './protocol';
 export { Macro, OnStart, OnStop, OnTick, Action, Panel, Overlay } from './decorators';
 export type { ActionOptions } from './decorators';
 export { MacroBase } from './macro-base';
@@ -16,4 +17,4 @@ export { struct, f } from './process/struct';
 export type { StructSpec } from './process/struct';
 export type { ProcessAccess } from './process/process-access';
 export type { Point, Region, RegionRatio, ColorRGB } from './geometry';
-export type { ScriptCtx, Target, GameId, WindowTarget, ProcessTarget, PackageDeclaration, PixelReadout, MouseButton, } from './types';
+export type { ScriptCtx, Target, GameId, ProcessTarget, PackageDeclaration, MouseButton, } from './types';

package/lib/protocol.d.ts

@@ -0,0 +1 @@
+export declare const SDK_PROTOCOL = 1;

package/lib/types.d.ts

@@ -3,9 +3,6 @@ import type { PanelDeclaration, Widget } from './panel-types';
 import type { ProcessAccess } from './process/process-access';
 import type { RobloxOffsets } from './roblox/offsets';
 import type { SettingMap } from './settings';
-export type PixelReadout = ColorRGB & {
-    hex: string;
-};
 export type MouseButton = 'left' | 'right' | 'middle';
 export type ScriptCtx = {
     settings: Record<string, unknown>;
@@ -17,29 +14,6 @@ export type ScriptCtx = {
     sleep(ms: number): Promise<void>;
     /** Wall-clock time in milliseconds (host-mediated; equivalent to `Date.now()`). */
     now(): number;
-    screen: {
-        captureRegion(name: string): Promise<Buffer>;
-        pixelAt(name: string): Promise<PixelReadout>;
-        pixelAtPoint(point: Point): Promise<PixelReadout>;
-        pixelAtRatio(rx: number, ry: number): Promise<PixelReadout>;
-        pixelMatches(settingName: string): Promise<boolean>;
-        pixelMatches(name: string, hex: string, tolerance?: number): Promise<boolean>;
-        pixelMatchesAt(point: Point, hex: string, tolerance?: number): Promise<boolean>;
-        findColor(settingName: string): Promise<Array<{
-            x: number;
-            y: number;
-            distance: number;
-        }>>;
-        findColor(regionName: string, hex: string, opts?: {
-            tolerance?: number;
-            limit?: number;
-            step?: number;
-        }): Promise<Array<{
-            x: number;
-            y: number;
-            distance: number;
-        }>>;
-    };
     input: {
         click(name: string, button?: MouseButton): Promise<void>;
         clickAt(point: Point, button?: MouseButton): Promise<void>;
@@ -74,14 +48,6 @@ export type ScriptCtx = {
 /** Identifies which game an offset set belongs to, so the runtime knows which
  * table to fetch and inject as `ctx.offsets`. Roblox is the only game today. */
 export type GameId = 'roblox';
-export type WindowTarget = {
-    kind: 'window';
-    titlePattern: RegExp;
-    referenceSize: {
-        w: number;
-        h: number;
-    };
-};
 export type ProcessTarget = {
     kind: 'process';
     processName?: string;
@@ -89,7 +55,7 @@ export type ProcessTarget = {
     expectedVersion?: string;
     game?: GameId;
 };
-export type Target = WindowTarget | ProcessTarget;
+export type Target = ProcessTarget;
 export type PackageDeclaration = {
     schemaVersion: number;
     target?: Target;

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@nighthawk.hq/macro-sdk",
-  "version": "0.1.3",
+  "version": "0.2.0",
+  "packageManager": "pnpm@10.34.1",
   "description": "Nighthawk macro author SDK — types only. Runtime is provided by the host.",
   "type": "module",
   "repository": {
@@ -14,6 +15,7 @@
   },
   "files": ["lib/**/*.d.ts", "stub.js", "build/index.js", "runtime-manifest.json"],
   "scripts": {
+    "generate": "node scripts/generate.mjs",
     "test": "node --test test/shim.test.mjs"
   },
   "dependencies": {

package/runtime-manifest.json

@@ -1,37 +1,41 @@
-[
-  "Action",
-  "Address",
-  "Button",
-  "Chip",
-  "Divider",
-  "Group",
-  "Image",
-  "Instance",
-  "Macro",
-  "MacroBase",
-  "Meter",
-  "OnStart",
-  "OnStop",
-  "OnTick",
-  "Overlay",
-  "Panel",
-  "Roblox",
-  "Row",
-  "Stat",
-  "Text",
-  "boolean",
-  "color",
-  "defaultsOf",
-  "f",
-  "findColor",
-  "number",
-  "offsetsFromDump",
-  "pixelColor",
-  "point",
-  "ratio",
-  "region",
-  "robloxTarget",
-  "select",
-  "string",
-  "struct"
-]
+{
+  "protocol": 1,
+  "exports": [
+    "Action",
+    "Address",
+    "Button",
+    "Chip",
+    "Divider",
+    "Group",
+    "Image",
+    "Instance",
+    "Macro",
+    "MacroBase",
+    "Meter",
+    "OnStart",
+    "OnStop",
+    "OnTick",
+    "Overlay",
+    "Panel",
+    "Roblox",
+    "Row",
+    "SDK_PROTOCOL",
+    "Stat",
+    "Text",
+    "boolean",
+    "color",
+    "defaultsOf",
+    "f",
+    "findColor",
+    "number",
+    "offsetsFromDump",
+    "pixelColor",
+    "point",
+    "ratio",
+    "region",
+    "robloxTarget",
+    "select",
+    "string",
+    "struct"
+  ]
+}