@block_factory/lib 0.0.2 → 0.0.4

package/tsconfig.types.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "outDir": "_types",
+    "rootDir": ".",
+    "declaration": true,
+    "declarationMap": true
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["node_modules", "_types"]
+}

package/index.d.ts

@@ -1,20 +0,0 @@
-import { MathUtils } from "./util/Math";
-import { Signal } from "./util/Signal";
-import { Vec2, Vec3 } from "./util/Vector";
-import { RawText } from "./util/RawText";
-import { Command } from "./util/Command";
-import { Form } from "./util/Form";
-import { ActionFormCtor, IButtonOptions, IActionFormResponse, IActionFormData } from "./util/FormAction";
-
-export { MathUtils, Signal, Vec2, Vec3, RawText, Command, Form, ActionFormCtor, IButtonOptions, IActionFormResponse, IActionFormData }
-
-export declare const BlockFactory: {
-    MathUtils: typeof MathUtils;
-    Signal: typeof Signal;
-    Vec2: typeof Vec2;
-    Vec3: typeof Vec3;
-    RawText: typeof RawText;
-    Command: typeof Command;
-    Form: typeof Form;
-    IActionFormData: typeof IActionFormData;
-};

package/util/Command.d.ts

@@ -1,23 +0,0 @@
-import type {
-    CustomCommand,
-    CommandPermissionLevel,
-    CustomCommandParameter,
-    CustomCommandOrigin,
-    CustomCommandResult
-} from "@minecraft/server";
-
-export declare namespace Command {
-    export abstract class ICustomCommand implements CustomCommand {
-        public abstract description: string;
-        public abstract name: string;
-        public abstract permissionLevel: CommandPermissionLevel;
-        public cheatsRequired?: boolean;
-        public mandatoryParameters?: CustomCommandParameter[];
-        public optionalParameters?: CustomCommandParameter[];
-        public abstract execute(origin: CustomCommandOrigin, ...args: any[]): CustomCommandResult | undefined;
-    }
-
-    export const customCommands: ICustomCommand[];
-
-    export function RegisterCustomCommand<T extends { new(): ICustomCommand }>(customCommand: T): void;
-}

package/util/Form.d.ts

@@ -1,10 +0,0 @@
-import { Player, RawMessage } from "@minecraft/server";
-
-export declare abstract class Form {
-    private static readonly occupiedPlayers: Set<string>;
-    static returnText: RawMessage | string;
-
-    static isOccupied(player: Player): boolean;
-
-    protected setOccupied(player: Player, occupied: boolean): void;
-}

package/util/Form.ts

@@ -1,15 +0,0 @@
-import { Player, RawMessage } from "@minecraft/server";
-
-export abstract class Form {
-    private static readonly occupiedPlayers: Set<string> = new Set();
-    public static returnText: RawMessage | string = "Back";
-
-    public static isOccupied(player: Player): boolean {
-        return Form.occupiedPlayers.has(player.id);
-    }
-
-    protected setOccupied(player: Player, occupied: boolean): void {
-        if (occupied) Form.occupiedPlayers.add(player.id);
-        else Form.occupiedPlayers.delete(player.id);
-    }
-}

package/util/FormAction.d.ts

@@ -1,41 +0,0 @@
-import { Form } from "@block_factory/lib/util/Form";
-import { Player, RawMessage } from "@minecraft/server";
-import { ActionFormData, FormCancelationReason } from "@minecraft/server-ui";
-
-export declare type ActionFormCtor<T extends IActionFormData = IActionFormData> = new () => T;
-
-export declare interface IButtonOptions {
-    id?: string | number;
-    iconPath?: string;
-    subForm?: ActionFormCtor;
-    allowReturn?: boolean;
-}
-
-export declare interface IActionFormResponse {
-    readonly cancelationReason?: FormCancelationReason;
-    readonly canceled: boolean;
-    readonly selection?: number;
-    readonly id?: string | number;
-}
-
-export declare abstract class IActionFormData extends Form {
-    protected form: ActionFormData;
-
-    protected abstract build(player: Player): void;
-
-    protected abstract onSubmit(player: Player, response: IActionFormResponse): void;
-
-    protected onCancel?(player: Player, response: IActionFormResponse): void;
-
-    title(titleText: RawMessage | string): this;
-    body(bodyText: RawMessage | string): this;
-    divider(): this;
-    header(text: RawMessage | string): this;
-    label(text: RawMessage | string): this;
-
-    button(text: RawMessage | string, options?: IButtonOptions): this;
-
-    show(player: Player): Promise<IActionFormResponse>;
-
-    protected _showChained(player: Player, returnStack: ActionFormCtor[]): Promise<IActionFormResponse>;
-}

package/util/RawText.d.ts

@@ -1,33 +0,0 @@
-import type { RawMessage } from "@minecraft/server";
-
-export declare namespace RawText {
-    export const TEXT: (value: string) => RawMessage;
-    export const TRANSLATE: (key: string, ...params: string[]) => RawMessage;
-    export const SCORE: (name: string, objective: string) => RawMessage;
-    export const MESSAGE: (...rawText: RawMessage[]) => RawMessage;
-    export const FORMAT: {
-        DarkRed: RawMessage;
-        Red: RawMessage;
-        Gold: RawMessage;
-        Yellow: RawMessage;
-        Green: RawMessage;
-        Lime: RawMessage;
-        Aqua: RawMessage;
-        Cyan: RawMessage;
-        DarkBlue: RawMessage;
-        Blue: RawMessage;
-        Magenta: RawMessage;
-        Purple: RawMessage;
-        White: RawMessage;
-        Gray: RawMessage;
-        DarkGray: RawMessage;
-        Black: RawMessage;
-        Obfuscated: RawMessage;
-        Bold: RawMessage;
-        StrikeThrough: RawMessage;
-        Italic: RawMessage;
-        Reset: RawMessage;
-        NewLine: RawMessage;
-    };
-}
-//# sourceMappingURL=RawText.d.ts.map

package/util/RawText.ts

@@ -1,76 +0,0 @@
-import { RawMessage } from '@minecraft/server';
-
-/**
- * Utility helpers for building rawtext messages.
- */
-export namespace RawText {
-    /**
-     * Creates a simple text component.
-     * @param value - The text value.
-     * @returns Text component object.
-     */
-    export const TEXT = (value: string): RawMessage => ({
-        text: value
-    });
-
-    /**
-     * Creates a translation component with optional 'with' parameters.
-     * @param key - The translation key.
-     * @param params - The optional parameters for translation.
-     * @returns Translation component object.
-     */
-    export const TRANSLATE = (key: string, ...params: string[]): RawMessage => ({
-        translate: key,
-        with: params.length ? params : undefined
-    });
-
-    /**
-     * Creates a score component.
-     * @param name - The entity's name whose score is being displayed.
-     * @param objective - The name of the score objective.
-     * @returns Score component object.
-     */
-    export const SCORE = (name: string, objective: string): RawMessage => ({
-        score: {
-            name: name,
-            objective: objective
-        }
-    });
-
-    /**
-     * Wraps various text components into a rawtext structure.
-     * @param rawText - The raw text components.
-     * @returns Raw text object.
-     */
-    export const MESSAGE = (...rawText: RawMessage[]): RawMessage => ({
-        rawtext: rawText
-    });
-
-    /**
-     * Common formatting and color codes.
-     */
-    export const FORMAT = {
-        DarkRed: TEXT('§4'),
-        Red: TEXT('§c'),
-        Gold: TEXT('§6'),
-        Yellow: TEXT('§e'),
-        Green: TEXT('§2'),
-        Lime: TEXT('§a'),
-        Aqua: TEXT('§b'),
-        Cyan: TEXT('§3'),
-        DarkBlue: TEXT('§1'),
-        Blue: TEXT('§9'),
-        Magenta: TEXT('§d'),
-        Purple: TEXT('§5'),
-        White: TEXT('§f'),
-        Gray: TEXT('§7'),
-        DarkGray: TEXT('§8'),
-        Black: TEXT('§0'),
-        Obfuscated: TEXT('§k'),
-        Bold: TEXT('§l'),
-        StrikeThrough: TEXT('§m'),
-        Italic: TEXT('§o'),
-        Reset: TEXT('§r'),
-        NewLine: TEXT('\n')
-    }
-}

package/util/Signal.d.ts

@@ -1,9 +0,0 @@
-export type Callback<T = void> = (data: T) => void;
-export declare class Signal<T = void> {
-    private listeners;
-    connect(callback: Callback<T>): void;
-    disconnect(callback?: Callback<T>): boolean;
-    once(callback: Callback<T>): void;
-    emit(data: T): void;
-}
-//# sourceMappingURL=Signal.d.ts.map

package/util/Signal.ts

@@ -1,73 +0,0 @@
-export type Callback<T = void> = (data: T) => void;
-
-/**
- * Signal class for event handling.
- * Allows connecting, disconnecting, and emitting events to listeners.
- *
- * @template T - Type of data passed to listeners.
- *
- * @example
- * ```typescript
- * import { Signal } from "./_lib/signal";
- *
- * interface ExampleEvent {
- *   n: number;
- *   s: string;
- *   b: boolean;
- * }
- *
- * class TestObject {
- *   example = new Signal<ExampleEvent>();
- * }
- *
- * const tstObject = new TestObject();
- * tstObject.example.connect(({n, s, b}) => console.warn(`n: ${n}, s: ${s}, b: ${b}`));
- *
- * for (let i = 0; i < 4; i++) {
- *   let n: number = 1;
- *   let s: string = "example";
- *   let b: boolean = true;
- *   tstObject.example.emit({n, s, b});
- *   if (i === 3) { // Disconnect after 4th emit
- *     tstObject.example.disconnect();
- *     tstObject.example.emit({n, s, b});
- *   }
- * }
- * ```
- */
-
-export class Signal<T = void> {
-    private listeners: Set<Callback<T>> = new Set();
-
-    /** Connect a listener */
-    public connect(callback: Callback<T>): void {
-        this.listeners.add(callback);
-    }
-
-    /** Disconnect a listener */
-    public disconnect(callback?: Callback<T>): boolean {
-        if (callback) {
-            this.listeners.delete(callback);
-            return true;
-        } else {
-            this.listeners.clear();
-            return false;
-        }
-    }
-
-    /** Connect a listener that runs only once */
-    public once(callback: Callback<T>) {
-        const wrapper: Callback<T> = (data) => {
-            this.disconnect(wrapper);
-            callback(data);
-        };
-        this.connect(wrapper);
-    }
-
-    /** Emit signal to all listeners */
-    public emit(data: T) {
-        for (const cb of [...this.listeners]) {
-            cb(data);
-        }
-    }
-}

package/util/Vector.d.ts

@@ -1,60 +0,0 @@
-export declare class Vec2 {
-    x: number;
-    y: number;
-    static ZERO: Vec2;
-    static UP: Vec2;
-    static DOWN: Vec2;
-    static LEFT: Vec2;
-    static RIGHT: Vec2;
-    constructor(x: number, y: number);
-    static add(a: Vec2, b: Vec2 | number): Vec2;
-    static subtract(a: Vec2, b: Vec2 | number): Vec2;
-    static multiply(a: Vec2, b: Vec2 | number): Vec2;
-    static divide(a: Vec2, b: Vec2 | number): Vec2;
-    static lerp(a: Vec2, b: Vec2, t: number): Vec2;
-    static clamp(v: Vec2, min: Vec2, max: Vec2): Vec2;
-    static dot(a: Vec2, b: Vec2): number;
-    static magnitude(a: Vec2): number;
-    static normalize(a: Vec2): Vec2;
-    static distance(a: Vec2, b: Vec2): number;
-    static negate(a: Vec2): Vec2;
-    static equals(a: Vec2, b: Vec2): boolean;
-    static approxEquals(a: Vec2, b: Vec2, epsilon?: number): boolean;
-    static angle(a: Vec2, b: Vec2): number;
-    static perpendicular(a: Vec2): Vec2;
-}
-export declare class Vec3 {
-    x: number;
-    y: number;
-    z: number;
-    static ZERO: Vec3;
-    static UP: Vec3;
-    static DOWN: Vec3;
-    static LEFT: Vec3;
-    static RIGHT: Vec3;
-    static FORWARD: Vec3;
-    static BACK: Vec3;
-    static WEST: Vec3;
-    static EAST: Vec3;
-    static NORTH: Vec3;
-    static SOUTH: Vec3;
-    constructor(x: number, y: number, z: number);
-    static add(a: Vec3, b: Vec3 | number): Vec3;
-    static subtract(a: Vec3, b: Vec3 | number): Vec3;
-    static multiply(a: Vec3, b: Vec3 | number): Vec3;
-    static divide(a: Vec3, b: Vec3 | number): Vec3;
-    static lerp(a: Vec3, b: Vec3, t: number): Vec3;
-    static clamp(v: Vec3, min: Vec3, max: Vec3): Vec3;
-    static dot(a: Vec3, b: Vec3): number;
-    static cross(a: Vec3, b: Vec3): Vec3;
-    static magnitude(a: Vec3): number;
-    static normalize(a: Vec3): Vec3;
-    static distance(a: Vec3, b: Vec3): number;
-    static negate(a: Vec3): Vec3;
-    static equals(a: Vec3, b: Vec3): boolean;
-    static approxEquals(a: Vec3, b: Vec3, epsilon?: number): boolean;
-    static angle(a: Vec3, b: Vec3): number;
-    static project(a: Vec3, onto: Vec3): Vec3;
-    static cartesian(radius: number, theta: number, phi: number): Vec3;
-}
-//# sourceMappingURL=Vector.d.ts.map

package/util/_Form.ts

@@ -1,246 +0,0 @@
-/*  
-**************************************************
- Copyright (c) Block Factory - All rights reserved.
-**************************************************
- Author: Donthedev <https://github.com/voxeldon> 
-**************************************************
-*/
-import { Player, RawMessage } from "@minecraft/server";
-import { ActionFormData, ActionFormResponse, ModalFormData, ModalFormDataDropdownOptions, ModalFormDataSliderOptions, ModalFormDataTextFieldOptions, ModalFormDataToggleOptions, ModalFormResponse } from "@minecraft/server-ui";
-
-const occupiedPlayers: Set<string> = new Set();
-
-class Form {
-    public readonly isOccupied = ((player: Player): boolean => {
-        return occupiedPlayers.has(player.id);
-    })
-}
-
-export interface Button {
-    indexId: string | number;
-    text: string | RawMessage;
-    iconPath?: string;
-}
-
-export interface FormActionData {
-    response: ActionFormResponse;
-    indexId?: string | number;
-}
-
-export class ActionForm extends Form {
-    private readonly actionForm: ActionFormData = new ActionFormData();
-    private buttonMap: Map<number, string | number> = new Map<number, string | number>();
-    private buttons: Button[] = [];
-    private titleText: string | RawMessage | undefined;
-    private bodyText: string | RawMessage | undefined;
-
-    public title(title: string | RawMessage): void {
-        this.titleText = title;
-    }
-
-    public body(body: string | RawMessage): void {
-        this.bodyText = body;
-    }
-
-    public button(indexId: string, text: string | RawMessage, iconPath?: string): void {
-        this.buttons.push({ indexId, text, iconPath });
-    }
-
-    public async showForm(player: Player): Promise<FormActionData> {
-        if (this.titleText === undefined || this.bodyText === undefined) {
-            throw Error('Title and body must be set before showing the form');
-        }
-        this.actionForm.title(this.titleText);
-        this.actionForm.body(this.bodyText);
-        this.generateButtons();
-
-        occupiedPlayers.add(player.id);
-
-        const response: ActionFormResponse = await this.actionForm.show(player).finally(() => {
-            occupiedPlayers.delete(player.id);
-        });
-
-        const return_data: FormActionData = {
-            response: response,
-            indexId: undefined
-        };
-        if (response.selection !== undefined && response.selection !== null) {
-            const selection: string | number | undefined = this.buttonMap.get(response.selection);
-            return_data.indexId = selection;
-        }
-
-        return return_data;
-    }
-
-    private generateButtons() {
-        let buttonIndex: number = 0;
-        this.buttons.forEach(button => {
-            if (button.iconPath) {
-                this.actionForm.button(button.text, button.iconPath);
-            } else {
-                this.actionForm.button(button.text);
-            }
-            this.buttonMap.set(buttonIndex, button.indexId);
-            buttonIndex++;
-        });
-    }
-}
-
-enum WidgetType {
-    TextField = 'textField',
-    Dropdown = 'dropdown',
-    Slider = 'slider',
-    Toggle = 'toggle'
-}
-
-interface Widget {
-    typeId: string,
-    widget: any
-};
-
-export interface TextField {
-    indexId: string,
-    label: string | RawMessage,
-    placeholder: string | RawMessage,
-    defaultValue?: string
-}
-
-export interface Dropdown {
-    indexId: string,
-    label: string | RawMessage,
-    options: string[],
-    defaultValueIndex?: number
-}
-
-export interface Slider {
-    indexId: string,
-    label: string | RawMessage,
-    min: number,
-    max: number,
-    step: number,
-    defaultValue?: number
-}
-
-export interface Toggle {
-    indexId: string,
-    label: string | RawMessage,
-    defaultValue?: boolean
-}
-
-export type FormValue = string | boolean | number | undefined;
-
-export interface FormModalData {
-    response: ModalFormResponse;
-    indexMap?: Map<string, FormValue>;
-}
-
-export class ModalForm extends Form {
-    private readonly modalForm: ModalFormData = new ModalFormData();
-    private widgitMap: Map<number, string> = new Map<number, string>();
-    private indexMap: Map<string, FormValue> = new Map<string, FormValue>();
-    private widgets: Widget[] = [];
-
-    public title(title: string | RawMessage): void {
-        this.modalForm.title(title);
-    }
-
-    public label(label: string | RawMessage): void {
-        this.modalForm.label(label);
-    }
-
-    public header(header: string | RawMessage): void {
-        this.modalForm.header(header);
-    }
-
-    public divider(): void {
-        this.modalForm.divider();
-    }
-
-    public textField(indexId: string, label: string | RawMessage, placeholder: string | RawMessage, defaultValue?: string): void {
-        this.widgets.push({ typeId: WidgetType.TextField, widget: { indexId, label, placeholder, defaultValue } });
-    }
-    public dropdown(indexId: string, label: string | RawMessage, options: string[], defaultValueIndex?: number): void {
-        this.widgets.push({ typeId: WidgetType.Dropdown, widget: { indexId, label, options, defaultValueIndex } });
-    }
-
-    public slider(indexId: string, label: string | RawMessage, min: number, max: number, step: number, defaultValue?: number): void {
-        this.widgets.push({ typeId: WidgetType.Slider, widget: { indexId, label, min, max, step, defaultValue } });
-    }
-
-    public toggle(indexId: string, label: string | RawMessage, defaultValue?: boolean): void {
-        this.widgets.push({ typeId: WidgetType.Toggle, widget: { indexId, label, defaultValue } });
-    }
-
-    public async showForm(player: Player): Promise<FormModalData> {
-        this.processWidgets();
-        occupiedPlayers.add(player.id);
-
-        const response: ModalFormResponse = await this.modalForm.show(player).finally(() => {
-            occupiedPlayers.delete(player.id);
-        });
-
-        const return_data: FormModalData = {
-            response: response,
-            indexMap: undefined
-        }
-
-        if (response.formValues !== null && response.formValues !== undefined) {
-            this.processValues(response.formValues);
-            return_data.indexMap = this.indexMap;
-        }
-
-        return return_data;
-    }
-
-    private processWidgets(): void {
-        let widgitIndex: number = 0;
-
-        for (const widget of this.widgets) {
-            if (widget.typeId === WidgetType.TextField) {
-                const textField: TextField = widget.widget;
-                const options: ModalFormDataTextFieldOptions = {
-                    defaultValue: textField?.defaultValue
-                };
-                this.modalForm.textField(textField.label, textField.placeholder, options);
-                this.widgitMap.set(widgitIndex, textField.indexId);
-            }
-            else if (widget.typeId === WidgetType.Dropdown) {
-                const dropdown: Dropdown = widget.widget;
-                const options: ModalFormDataDropdownOptions = {
-                    defaultValueIndex: dropdown?.defaultValueIndex
-                };
-                this.modalForm.dropdown(dropdown.label, dropdown.options, options);
-                this.widgitMap.set(widgitIndex, dropdown.indexId);
-
-            }
-            else if (widget.typeId === WidgetType.Slider) {
-                const slider: Slider = widget.widget;
-                const options: ModalFormDataSliderOptions = {
-                    defaultValue: slider?.defaultValue,
-                    valueStep: slider.step
-                };
-                this.modalForm.slider(slider.label, slider.min, slider.max, options);
-                this.widgitMap.set(widgitIndex, slider.indexId);
-            }
-            else if (widget.typeId === WidgetType.Toggle) {
-                const toggle: Toggle = widget.widget;
-                const options: ModalFormDataToggleOptions = {
-                    defaultValue: toggle?.defaultValue
-                }
-                this.modalForm.toggle(toggle.label, options);
-                this.widgitMap.set(widgitIndex, toggle.indexId);
-            }
-            widgitIndex += 1;
-        }
-    }
-
-    private processValues(formValues: FormValue[]): void {
-        let widgitIndex: number = 0;
-        for (const i of formValues) {
-            const value: FormValue = i?.valueOf();
-            const indexId: string | undefined = this.widgitMap.get(widgitIndex);
-            if (indexId) this.indexMap.set(indexId, value);
-            widgitIndex++;
-        }
-    }
-}