@signpostmarv/intermediary-number 0.6.2 → 0.6.3

package/README.md

@@ -9,17 +9,14 @@ Intermediary Number classes & utilities for the [Production Calculator](https://
 
 ### Requirements
 
--   Docker
-    -   vscode recommended to use devcontainer support
+- Docker
+    - vscode recommended to use devcontainer support
 
 ### Setup
 
 1. Checkout locally
 1. Load in devcontainer-supporting IDE
-    - devcontainer setup should automatically run `make install`
-    - `NODE_OPTIONS` env var may require opening a fresh terminal if you
-      receieve an error along the lines of
-      `TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts"`
+    - devcontainer setup should automatically run `npm install`
 1. Run `make generate`
 
 ## Documentation
@@ -30,5 +27,5 @@ Please refer to the tests in the meantime.
 
 ## Issues
 
--   Issue tracker for all the related projects except Docs.json.ts are [available on GitHub](https://github.com/orgs/satisfactory-dev/projects/1).
--   [Issues with Docs.json.ts currently need to be viewed separately](https://github.com/satisfactory-dev/Docs.json.ts/issues).
+- Issue tracker for all the related projects except Docs.json.ts are [available on GitHub](https://github.com/orgs/satisfactory-dev/projects/1).
+- [Issues with Docs.json.ts currently need to be viewed separately](https://github.com/satisfactory-dev/Docs.json.ts/issues).

package/package.json

@@ -12,20 +12,18 @@
 	"types": "./index.d.ts",
 	"devDependencies": {
 		"@satisfactory-dev/custom-assert": "^0.2.3",
-		"@signpostmarv/eslint-config": "^0.2.0",
-		"@types/eslint": "^9.6.0",
-		"@types/node": "^20.14.2",
-		"c8": "^10.1.2",
-		"eslint": "^9.9.1",
-		"glob": "^10.4.1",
-		"prettier": "^3.3.2",
-		"ts-node": "^10.9.2",
-		"typescript": "~5.5.2",
-		"typescript-eslint": "^8.2.0"
+		"@signpostmarv/eslint-config": "^0.5.0",
+		"@types/eslint": "^9.6.1",
+		"@types/node": "^24.10.4",
+		"c8": "^10.1.3",
+		"eslint": "^9.39.2",
+		"prettier": "^3.7.4",
+		"typescript": "~5.9.2",
+		"typescript-eslint": "^8.50.0"
 	},
 	"dependencies": {
 		"bignumber.js": "^9.1.2",
 		"fraction.js": "^4.3.7"
 	},
-	"version": "0.6.2"
+	"version": "0.6.3"
 }

package/index.d.ts

@@ -1,4 +0,0 @@
-export * from './lib/IntermediaryNumber';
-export * from './lib/IntermediaryNumberTypes';
-export * from './lib/Numbers';
-export * from './lib/NumberStrings';

package/index.js

@@ -1,4 +0,0 @@
-export * from './lib/IntermediaryNumber';
-export * from './lib/IntermediaryNumberTypes';
-export * from './lib/Numbers';
-export * from './lib/NumberStrings';

package/lib/Docs.json.d.ts

@@ -1,7 +0,0 @@
-export declare class NotAnAmountString extends Error {
-}
-export type StringPassedRegExp<pattern extends string, T extends string = string> = T & {
-    [pseudo_key in pattern]: never;
-};
-export type integer_string__type = StringPassedRegExp<'^\\d+$'>;
-export declare function is_string(maybe: unknown): maybe is string;

package/lib/Docs.json.js

@@ -1,6 +0,0 @@
-// exports from Docs.json.ts not really warranting their own package
-export class NotAnAmountString extends Error {
-}
-export function is_string(maybe) {
-    return 'string' === typeof maybe;
-}

package/lib/IntermediaryNumber.d.ts

@@ -1,221 +0,0 @@
-import BigNumber from 'bignumber.js';
-import Fraction from 'fraction.js';
-import { amount_string } from './NumberStrings';
-import type { input_types, type_property_types, value_types } from './IntermediaryNumberTypes';
-export type math_types = operand_types | input_types;
-export declare const regex_recurring_number: RegExp;
-export type CanDoMath_result_types = IntermediaryNumber | IntermediaryCalculation | TokenScan;
-export type operation_types = '+' | '-' | '*' | 'x' | '/' | '%';
-export type operand_type_property_types = type_property_types | 'IntermediaryCalculation' | 'TokenScan';
-export type CanConvertTypeJson = {
-    type: 'IntermediaryNumber';
-    value: string;
-} | {
-    type: 'IntermediaryCalculation';
-    left: CanConvertTypeJson;
-    operation: operation_types;
-    right: CanConvertTypeJson;
-} | {
-    type: 'TokenScan';
-    value: string;
-};
-export type CanDoMathWithDispose_operator_types = 'divide' | 'minus' | 'modulo' | 'plus' | 'times';
-export type operand_types = IntermediaryNumber | IntermediaryCalculation | TokenScan;
-type TokenSpan_types = 'ignore' | 'nesting_open' | 'nesting_close' | 'numeric' | 'operation' | 'Infinity';
-type TokenSpan_types_part_baked = Exclude<TokenSpan_types, 'ignore'>;
-type TokenScan_internals = {
-    parsed: IntermediaryNumber | IntermediaryCalculation | undefined;
-    tokens: (TokenSpan<TokenSpan_types_part_baked>[]) | undefined;
-    valid: boolean | undefined;
-};
-type TokenScan_parsing_value = Omit<TokenScan, 'is_valid' | 'parsed'>;
-type TokenScan_tokenizer_operand_buffer = IntermediaryNumber | IntermediaryCalculation | undefined;
-type incomplete_operation = {
-    left_operand: Exclude<TokenScan_tokenizer_operand_buffer, undefined>;
-    operation: operation_types;
-};
-type TokenScan_tokenizer = {
-    outter_stack: (incomplete_operation | TokenSpan<'nesting_open'>)[];
-    left_operand: TokenScan_tokenizer_operand_buffer;
-    right_operand: TokenScan_tokenizer_operand_buffer;
-    operation: '' | operation_types;
-    operand_mode: 'left' | 'right';
-};
-interface HasType {
-    get type(): operand_type_property_types;
-}
-interface CanDoMath<ResultType extends CanDoMath_result_types = CanDoMath_result_types, ResolveString extends string = type_property_types> extends HasType {
-    get resolve_type(): ResolveString;
-    compare(value: math_types): -1 | 0 | 1;
-    divide(value: math_types): ResultType;
-    minus(value: math_types): ResultType;
-    modulo(value: math_types): ResultType;
-    plus(value: math_types): ResultType;
-    times(value: math_types): ResultType;
-    abs(): (operand_types);
-    max(first: math_types, ...remaining: math_types[]): operand_types;
-    min(first: math_types, ...remaining: math_types[]): operand_types;
-}
-interface CanResolveMath<T extends CanDoMath_result_types = CanDoMath_result_types> extends CanDoMath<T, string> {
-    resolve(): IntermediaryNumber;
-}
-export interface CanConvertType extends HasType {
-    toAmountString(): amount_string;
-    toBigNumber(): BigNumber;
-    toBigNumberOrFraction(): BigNumber | Fraction;
-    toFraction(): Fraction;
-    toString(): string;
-    isLessThan(value: math_types): boolean;
-    isGreaterThan(value: math_types): boolean;
-    isOne(): boolean;
-    isZero(): boolean;
-    toJSON(): CanConvertTypeJson;
-}
-interface CanDoMathWithDispose<ResultType extends CanDoMath_result_types = CanDoMath_result_types, ResolveString extends string = type_property_types> extends CanConvertType, CanDoMath<ResultType, ResolveString> {
-    do_math_then_dispose(operator: CanDoMathWithDispose_operator_types, right_operand: math_types): ResultType;
-}
-interface CanResolveMathWithDispose<T extends CanDoMath_result_types = CanDoMath_result_types> extends CanResolveMath<T>, CanDoMathWithDispose<T, string> {
-}
-export declare function dispose(value: operand_types): void;
-export declare function is_operation_value(maybe: string): asserts maybe is operation_types;
-export declare class IntermediaryNumber implements CanDoMathWithDispose {
-    private readonly value;
-    static readonly One: IntermediaryNumber;
-    static readonly Zero: IntermediaryNumber;
-    protected constructor(value: value_types);
-    get resolve_type(): type_property_types;
-    get type(): type_property_types;
-    abs(): operand_types;
-    compare(value: math_types): 0 | 1 | -1;
-    divide(value: math_types): operand_types;
-    do_math_then_dispose(operator: CanDoMathWithDispose_operator_types, right_operand: math_types): CanDoMath_result_types;
-    isGreaterThan(value: math_types): boolean;
-    isLessThan(value: math_types): boolean;
-    isOne(): boolean;
-    isZero(): boolean;
-    max(first: math_types, ...remaining: math_types[]): operand_types;
-    min(first: math_types, ...remaining: math_types[]): operand_types;
-    minus(value: math_types): operand_types;
-    modulo(value: math_types): operand_types;
-    plus(value: math_types): operand_types;
-    times(value: math_types): operand_types;
-    toAmountString(): amount_string;
-    toBigNumber(): BigNumber;
-    toBigNumberOrFraction(): BigNumber | Fraction;
-    toFraction(): Fraction;
-    toJSON(): CanConvertTypeJson;
-    toString(): string;
-    toStringCalculation(): string;
-    static create(input: input_types): IntermediaryNumber;
-    static create_if_valid(input: string): operand_types | NotValid;
-    static fromJson(json: CanConvertTypeJson): CanDoMath_result_types;
-    static reuse_or_create(input: operand_types | input_types): operand_types;
-}
-export declare class IntermediaryNumberInfinity extends IntermediaryNumber {
-    static readonly One: IntermediaryNumberInfinity;
-    static readonly Zero: IntermediaryNumberInfinity;
-    isOne(): boolean;
-    isZero(): boolean;
-    toFraction(): Fraction;
-    toString(): string;
-    toStringCalculation(): string;
-}
-export declare class NotValid extends Error {
-    readonly reason: unknown;
-    readonly value: string;
-    constructor(not_valid: string, reason: unknown);
-}
-export declare class IntermediaryCalculation implements CanResolveMathWithDispose {
-    readonly left_operand: operand_types;
-    readonly operation: operation_types;
-    readonly right_operand: operand_types;
-    constructor(left: operand_types, operation: operation_types, right: operand_types);
-    get has_infinity(): boolean;
-    get left_type(): operand_type_property_types;
-    get resolve_type(): string;
-    get right_type(): operand_type_property_types;
-    get type(): operand_type_property_types;
-    abs(): operand_types;
-    compare(value: math_types): 0 | 1 | -1;
-    divide(value: math_types): operand_types;
-    do_math_then_dispose(operator: CanDoMathWithDispose_operator_types, right_operand: math_types): CanDoMath_result_types;
-    isGreaterThan(value: math_types): boolean;
-    isLessThan(value: math_types): boolean;
-    isOne(): boolean;
-    isZero(): boolean;
-    max(first: math_types, ...remaining: math_types[]): operand_types;
-    min(first: math_types, ...remaining: math_types[]): operand_types;
-    minus(value: math_types): operand_types;
-    modulo(value: math_types): operand_types;
-    plus(value: math_types): operand_types;
-    resolve(): IntermediaryNumber;
-    times(value: math_types): operand_types;
-    toAmountString(): amount_string;
-    toBigNumber(): BigNumber;
-    toBigNumberOrFraction(): BigNumber | Fraction;
-    toFraction(): Fraction;
-    toJSON(): CanConvertTypeJson;
-    toString(): string;
-    toStringCalculation(): string;
-    private operand_to_IntermediaryNumber;
-    static fromString(input: Exclude<string, ''>): IntermediaryNumber | IntermediaryCalculation;
-    static is(maybe: unknown): maybe is IntermediaryCalculation;
-    static maybe_reduce_operands(left: operand_types, operation: operation_types, right: operand_types): IntermediaryNumber | TokenScan;
-    static require_is(maybe: unknown): asserts maybe is IntermediaryCalculation;
-    private static maybe_short_circuit;
-}
-declare class TokenSpan<T = TokenSpan_types> {
-    readonly from: number;
-    readonly to: number;
-    readonly type: T;
-    constructor(from: number, to: number, type: T);
-}
-export declare class TokenScanError extends Error {
-}
-export declare class TokenScanParseError extends Error {
-    readonly current?: TokenSpan<TokenSpan_types>;
-    readonly scan: TokenScan_parsing_value;
-    readonly state?: TokenScan_tokenizer;
-    constructor(message: string, scan: TokenScan_parsing_value, state: TokenScan_tokenizer, current?: TokenSpan<TokenSpan_types>);
-}
-export declare class TokenScan implements CanResolveMathWithDispose {
-    #private;
-    private readonly internal;
-    readonly value: string | [TokenScan, operation_types, math_types];
-    private constructor();
-    get parsed(): Exclude<TokenScan_internals['parsed'], undefined>;
-    get resolve_type(): string;
-    get tokens(): Exclude<TokenScan_internals['tokens'], undefined>;
-    get type(): operand_type_property_types;
-    get valid(): boolean;
-    abs(): operand_types;
-    compare(value: math_types): 0 | 1 | -1;
-    divide(value: math_types): TokenScan;
-    do_math_then_dispose(operator: CanDoMathWithDispose_operator_types, right_operand: math_types): CanDoMath_result_types;
-    isGreaterThan(value: math_types): boolean;
-    isLessThan(value: math_types): boolean;
-    isOne(): boolean;
-    isZero(): boolean;
-    max(first: math_types, ...remaining: math_types[]): operand_types;
-    min(first: math_types, ...remaining: math_types[]): operand_types;
-    minus(value: math_types): TokenScan;
-    modulo(value: math_types): TokenScan;
-    plus(value: math_types): TokenScan;
-    resolve(): IntermediaryNumber;
-    times(value: math_types): TokenScan;
-    toAmountString(): amount_string;
-    toBigNumber(): BigNumber;
-    toBigNumberOrFraction(): BigNumber | Fraction;
-    toFraction(): Fraction;
-    toJSON(): CanConvertTypeJson;
-    toString(): string;
-    toStringCalculation(): string;
-    static create(value: string): TokenScan;
-    static is(maybe: unknown): maybe is TokenScan;
-    static require_is(maybe: unknown): asserts maybe is TokenScan;
-    private static determine_tokens_from_scan;
-    private static massage_part_baked_tokens;
-    private static parse_scan;
-    private static reduce;
-}
-export {};