@asod/field 0.1.0-canary.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 {{ TS_PACKAGE_TEMPLATE }}
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# @asod/field

package/dist/field.d.ts

@@ -0,0 +1,25 @@
+import { type IField, type IOperation, type IOperationValue } from './declarations/index';
+type FieldOperationConfig<TValue extends Primitive | IOperationValue> = {
+    func: IOperation<TValue>;
+    neutralValue: TValue;
+};
+type FieldOperationsConfig<TValue extends Primitive | IOperationValue> = {
+    add: FieldOperationConfig<TValue>;
+    sub: FieldOperationConfig<TValue>;
+    mul: FieldOperationConfig<TValue>;
+    div: FieldOperationConfig<TValue>;
+};
+type FieldConfig<TValue extends Primitive | IOperationValue> = {
+    operations: FieldOperationsConfig<TValue>;
+};
+declare class Field<TValue extends Primitive | IOperationValue> implements IField<TValue> {
+    private readonly _operations;
+    constructor(config: FieldConfig<TValue>);
+    add(a: TValue, b: TValue): TValue;
+    sub(a: TValue, b: TValue): TValue;
+    mul(a: TValue, b: TValue): TValue;
+    div(a: TValue, b: TValue): TValue;
+    private _compare;
+}
+export { Field };
+export default Field;

package/dist/field.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get Field () {
+        return Field;
+    },
+    get default () {
+        return _default;
+    }
+});
+const _compare = require("@asod/compare");
+const _guards = require("./utils/guards");
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+class Field {
+    add(a, b) {
+        const { func, neutralValue } = this._operations.add;
+        if (!this._compare(a, neutralValue)) return b;
+        if (!this._compare(b, neutralValue)) return a;
+        return func(a, b);
+    }
+    sub(a, b) {
+        const { func, neutralValue } = this._operations.sub;
+        if (!this._compare(b, neutralValue)) return a;
+        return func(a, b);
+    }
+    mul(a, b) {
+        const { func, neutralValue } = this._operations.mul;
+        if (!this._compare(a, neutralValue)) return b;
+        if (!this._compare(b, neutralValue)) return a;
+        return func(a, b);
+    }
+    div(a, b) {
+        const { func, neutralValue } = this._operations.div;
+        if (!this._compare(b, neutralValue)) return a;
+        return func(a, b);
+    }
+    _compare(a, b) {
+        if ((0, _guards.isComparable)(a)) return (0, _compare.compare)(a, b, a.comparator);
+        if ((0, _guards.isComparable)(b)) return (0, _compare.compare)(a, b, b.comparator);
+        return (0, _compare.compare)(a, b);
+    }
+    constructor(config){
+        _define_property(this, "_operations", void 0);
+        this._operations = config.operations;
+    }
+}
+const _default = Field;

package/dist/global.d.ts

@@ -0,0 +1 @@
+type Primitive = string | number | bigint | boolean | symbol | null | undefined;

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+/// <reference path="global.d.ts" />
+
+import { type Comparator } from '@asod/compare';
+
+declare const ABSTRACT_OPERATION_ID: unique symbol;
+
+type AbstractOperationId = typeof ABSTRACT_OPERATION_ID;
+
+declare namespace ASOD {
+  /* Common */
+
+  interface IComparable {
+    comparator?: Comparator;
+  }
+
+  /* Operation */
+
+  interface IOperationValue extends IComparable {}
+
+  interface IOperation<TValue extends Primitive | IOperationValue> {
+    (a: TValue, b: TValue): TValue;
+  }
+
+  /* Group */
+
+  interface IGroup<TValue extends Primitive | IOperationValue> {
+    [ABSTRACT_OPERATION_ID]: IOperation<TValue>;
+  }
+
+  /* Ring */
+
+  // prettier-ignore
+  interface IRing<TValue extends Primitive | IOperationValue> extends Omit<IGroup<TValue>, AbstractOperationId> {
+    add: IOperation<TValue>;
+    mul: IOperation<TValue>;
+  }
+
+  /* Field */
+
+  // prettier-ignore
+  interface IField<TValue extends Primitive | IOperationValue> extends Omit<IRing<TValue>, AbstractOperationId> {
+    sub: IOperation<TValue>;
+    div: IOperation<TValue>;
+  }
+}
+
+export = ASOD;
+export as namespace ASOD;

package/dist/utils/guards.d.ts

@@ -0,0 +1,2 @@
+import { IComparable, IOperationValue } from '../declarations/index';
+export declare const isComparable: (value: Primitive | IOperationValue) => value is IComparable;

package/dist/utils/guards.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "isComparable", {
+    enumerable: true,
+    get: function() {
+        return isComparable;
+    }
+});
+const isComparable = (value)=>typeof value === 'object' && value !== null && 'comparable' in value;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@asod/field",
+  "description": "",
+  "version": "0.1.0-canary.0",
+  "license": "MIT",
+  "author": "Oleg Putseiko <oleg.putseiko@gmail.com> (https://github.com/oleg-putseiko)",
+  "keywords": [],
+  "homepage": "https://github.com/asodorg/field",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/asodorg/field"
+  },
+  "bugs": {
+    "url": "https://github.com/asodorg/field/issues"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*"
+  ],
+  "exports": "./dist/index.js",
+  "scripts": {
+    "build": "yarn build:js && yarn build:ts",
+    "build:js": "swc src -d dist --strip-leading-paths --ignore \"node_modules,**/*.test.ts,**/*.d.ts\"",
+    "build:ts": "tsc && find src -name \"*.d.ts\" -exec cp {} dist/ \\;",
+    "lint": "eslint ./src/**/*.ts -c ./eslint.config.mjs",
+    "lint:fix": "yarn lint --fix && yarn format:fix",
+    "lint:strict": "yarn lint --max-warnings=0 && yarn format",
+    "format": "prettier -c .",
+    "format:fix": "prettier -w .",
+    "typecheck": "tsc --noEmit --incremental false",
+    "test": "jest",
+    "prepare": "husky install | chmod +x ./.husky/*",
+    "version:bump": "npm version -m \"build(package): bump the package version to %s\""
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^18.2.0",
+    "@commitlint/config-conventional": "^18.1.0",
+    "@swc/cli": "^0.5.2",
+    "@swc/core": "^1.10.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.10.1",
+    "@typescript-eslint/eslint-plugin": "^8.28.0",
+    "@typescript-eslint/parser": "^8.28.0",
+    "eslint": "^9.16.0",
+    "eslint-config-prettier": "^10.1.1",
+    "husky": "^8.0.3",
+    "jest": "^30.2.0",
+    "lint-staged": "^15.0.2",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.4.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.2"
+  },
+  "volta": {
+    "node": "20.19.5",
+    "yarn": "4.10.3"
+  },
+  "dependencies": {
+    "@asod/compare": "^0.1.1-canary.1"
+  }
+}