@siredvin/hopper-ts 0.1.0

package/index.d.ts

@@ -0,0 +1,120 @@
+/** @noSelfInFile **/
+
+declare class HopperTransferRecord {
+    commandName?: string;
+    transferred: number;
+    from: string;
+    to: string;
+    name: string;
+    displayName?: string;
+    nbt?: string;
+    type: "i" | "f" | "e";
+}
+
+declare interface HopperOptions {
+    name: string;
+}
+
+declare interface HopperCommand {
+    options: HopperOptions;
+}
+
+declare interface HopperCommandFinishedInfo {
+    command: HopperCommand;
+    execution_time: number;
+}
+
+declare interface HopperTimeInfo {
+    look: number;
+    reset_limits: number;
+    scan: number;
+    mark: number;
+    sort: number;
+    transfer: number;
+}
+
+/** @noSelf **/
+declare class Callbacks {
+    transferred?: (record: HopperTransferRecord) => void;
+    command_finished?: (command: HopperCommandFinishedInfo) => void;
+    time_tracking?: (info: {
+        name: string;
+        times: LuaTable<string, number>;
+    }) => void;
+}
+
+declare interface HopperTagFilter {
+    tag: string;
+}
+
+declare interface HopperItemFilter {
+    name: string;
+}
+
+declare interface HopperFilterInformation {
+    chest_name: string;
+    chest_size: number | null; // output of .size() if such a method exists
+    slot_number: number; // 0 if there's none
+    name: string;
+    nbt: string; // "" if there's no nbt data or if the data is unknown and assumed to be none
+    count: number;
+    type: "i" | "f" | "e"; // item, fluid, energy
+    tags: { [tag: string]: true }; // result of getItemDetail(...).tags
+}
+
+declare type HopperFilterFunction = (info: HopperFilterInformation) => boolean;
+
+export type HopperFilter =
+    | string
+    | HopperItemFilter
+    | HopperTagFilter
+    | HopperFilterFunction;
+
+declare interface HopperLimit {
+    type: "from" | "to" | "transfer";
+    dir?: "max" | "min";
+    limit: number;
+    per_chest?: boolean;
+    per_item?: boolean;
+    per_nbt?: boolean;
+    per_slot?: boolean;
+    count_all?: boolean;
+}
+
+declare interface HopperSlotInfo {
+    from_priority: number;
+    count: number;
+    voided?: number;
+    chest_name: string;
+    slot_number: number;
+    name: string;
+}
+
+declare interface HopperTableInstruction {
+    name?: string;
+    from: string;
+    to: string;
+    filters?: HopperFilter[];
+    limits?: HopperLimit[];
+    once?: boolean;
+    forever?: boolean;
+    from_slot?: number | number[] | number[][];
+    to_slot?: number | number[] | number[][];
+    min_batch?: number;
+    batch_multiple?: number;
+    sleep?: number;
+    scan_threads?: number;
+    negate?: boolean;
+    energy?: boolean;
+    condition?: () => boolean;
+    from_sorting?: (a: HopperSlotInfo, b: HopperSlotInfo) => boolean;
+}
+
+export type HopperInstruction = string | HopperTableInstruction;
+
+export function hopper(
+    instruction: HopperInstruction | HopperInstruction[],
+    callbacks?: Callbacks
+): number;
+export function alias(alias: string, name: string);
+export function list(filter: string): LuaTable<string, number>;

package/index.lua

@@ -0,0 +1,11 @@
+package.path = package.path .. ";/?.lua;/?/init.lua"
+
+local tweaked_require = require
+
+local hopper = tweaked_require("hopper")
+
+return {
+  hopper = hopper,
+  list = hopper.list,
+  alias = function(a, b) hopper("-alias " .. a .. " " .. b) end
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+    "name": "@siredvin/hopper-ts",
+    "version": "0.1.0",
+    "description": "Redistribution of Hopper.lua by umnikos",
+    "types": "./index.d.ts",
+    "files": [
+        "./index.d.ts",
+        "./index.lua"
+    ],
+    "main": "index",
+    "author": "umnikos",
+    "license": "MIT",
+    "scripts": {
+        "lint": "eslint . --ext .ts,.js",
+        "depcheck": "depcheck"
+    },
+    "nx": {
+        "targets": {
+            "lint": {
+                "executor": "@nx/linter:eslint",
+                "outputs": [
+                    "{options.outputFile}"
+                ],
+                "options": {
+                    "lintFilePatterns": [
+                        "packages/api-types/**/*.{ts,tsx,js,jsx}"
+                    ]
+                }
+            },
+            "depcheck": {
+                "executor": "nx:run-commands",
+                "options": {
+                    "command": "depcheck",
+                    "cwd": "packages/api-types"
+                }
+            }
+        }
+    }
+}