@bitbybit-dev/base 0.19.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Bit By Bit Developers
+
+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,71 @@
+## Bit By Bit Developers Base Algorithms for CAD library
+
+<img src="https://app.bitbybit.dev/assets/git-cover.png" alt="Picture showing bitbybit.dev platform">
+
+This genericc package contains base algorithms for our CAD platform. It has various helper functions for math, text, lists, vectors, matrix operations. It also contains some base types used accross bitbybit.dev platform on higher levels. This layer should be kept as lightweight as possible and ideally not contain any third-party dependencies as they just add to the weight and complexity.
+
+This package is already used or will be used in these packages:
+
+@bitbybit-dev/occt
+@bitbybit-dev/occt-worker
+@bitbybit-dev/jscad
+@bitbybit-dev/jscad-worker
+@bitbybit-dev/manifold
+@bitbybit-dev/manifold-worker
+@bitbybit-dev/core
+@bitbybit-dev/babylonjs
+@bitbybit-dev/threejs
+
+This package should work in Node and browser based applications and should provide generic layer which could be helpful to all higher-level CAD algorithms and kernels. Algorithms of this base layer are also exposed on our bitbybit.dev Rete, Blockly & Monaco editors.
+
+Visit https://bitbybit.dev to use our full cloud platform.
+
+## Github
+https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/base
+## NPM
+https://www.npmjs.com/package/@bitbybit-dev/base
+
+## THREEJS Example Applications
+Vase   
+https://app-store.bitbybit.dev/vase   
+Github Source Code - https://github.com/bitbybit-dev/app-examples/tree/main/react/threejs/vase   
+
+## Other Example Applications
+Laptop Holder   
+https://app-store.bitbybit.dev/laptop-holder    
+Github Source Code Angular - https://github.com/bitbybit-dev/app-examples/tree/main/angular/laptop-holder   
+Github Source Code React - https://github.com/bitbybit-dev/app-examples/tree/main/react/laptop-holder   
+  
+Cup Configurator    
+https://app-store.bitbybit.dev/cup
+Github Source Code - https://github.com/bitbybit-dev/app-examples/tree/main/react/cup  
+
+## Closed Source Example Applications
+https://app-store.bitbybit.dev/terrace-furniture
+
+## Build package
+npm run build-p
+
+## Run unit tests and generate test coverage
+npm run test-c
+
+## Run live unit tests and generate test coverage on save
+npm run test-c-l
+
+## Unit test coverage report online
+https://tests.bitbybit.dev/threejs
+
+## Media Channels
+Discord: https://discord.gg/GSe3VMe  
+Youtube: https://www.youtube.com/@bitbybitdev?sub_confirmation=1  
+Instagram: https://www.instagram.com/bitbybit.dev  
+Twitter: https://twitter.com/bitbybit_dev  
+LinkedIn: https://lnkd.in/gQjEQA2  
+Facebook: https://www.facebook.com/bitbybitdev  
+Medium: https://bitbybit-dev.medium.com/  
+
+## Principles
+Bit By Bit Developers company will keep these core algorithms that you can find in this repository free and opensource for its users. These algorithms are based on other open-source projects, run and are deployed on the browser, thus there is no point of closing them down from public.
+
+## About Bit By Bit Developers platform
+Bit By Bit Developers web platform allows creators to program geometry through simple visual programming language or choose monaco typescript editor with full intellisense of bitbybit API. This cloud platform can fulfil many practical, educational and artistic needs of its users. Through familiar programming interface used in tools such as Scratch and Blockly.Games we expose powerful 3D algorithms that make it easier to implement various parametric tasks. Our goal is to make it very simple for users to share their ideas and designs. We want to encourage everyone to engage in the future of this tool.

package/babel.config.cjs

@@ -0,0 +1,14 @@
+module.exports = {
+    presets: [
+        [
+            '@babel/preset-env',
+            {
+                targets: {
+                    node: 'current',
+                },
+            },
+        ],
+        '@babel/preset-typescript'
+    ],
+};
+export {};

package/babel.config.d.cts

@@ -0,0 +1,5 @@
+export const presets: (string | (string | {
+    targets: {
+        node: string;
+    };
+})[])[];

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib";

package/index.js

@@ -0,0 +1,4 @@
+/*
+ * Public API Surface of bitbybit-core
+ */
+export * from "./lib";

package/lib/api/index.d.ts

@@ -0,0 +1 @@
+export * from "./services";

package/lib/api/index.js

@@ -0,0 +1 @@
+export * from "./services";

package/lib/api/inputs/base-inputs.d.ts

@@ -0,0 +1,35 @@
+export declare namespace Base {
+    type Color = string;
+    type ColorRGB = {
+        r: number;
+        g: number;
+        b: number;
+    };
+    type Material = any;
+    type Point2 = [number, number];
+    type Vector2 = [number, number];
+    type Point3 = [number, number, number];
+    type Vector3 = [number, number, number];
+    type Line2 = {
+        start: Base.Point2;
+        end: Base.Point2;
+    };
+    type Line3 = {
+        start: Base.Point3;
+        end: Base.Point3;
+    };
+    type Polyline3 = {
+        points: Base.Point3[];
+        isClosed?: boolean;
+        color?: number[];
+    };
+    type Polyline2 = {
+        points: Base.Point2[];
+        isClosed?: boolean;
+        color?: number[];
+    };
+    type TransformMatrix3x3 = [number, number, number, number, number, number, number, number, number];
+    type TransformMatrixes3x3 = TransformMatrix3x3[];
+    type TransformMatrix = [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number];
+    type TransformMatrixes = TransformMatrix[];
+}

package/lib/api/inputs/base-inputs.js

@@ -0,0 +1 @@
+export {};

package/lib/api/inputs/color-inputs.d.ts

@@ -0,0 +1,122 @@
+import { Base } from "./base-inputs";
+export declare namespace Color {
+    class HexDto {
+        constructor(color?: Base.Color);
+        /**
+         * Color hex
+         * @default #0000ff
+         */
+        color: Base.Color;
+    }
+    class InvertHexDto {
+        constructor(color?: Base.Color);
+        /**
+         * Color hex
+         * @default #0000ff
+         */
+        color: Base.Color;
+        /**
+         * Choose to invert the color to black and white (useful for text color)
+         */
+        blackAndWhite: boolean;
+    }
+    class HexDtoMapped {
+        constructor(color?: Base.Color, from?: number, to?: number);
+        /**
+         * Color hex
+         * @default #0000ff
+         */
+        color: Base.Color;
+        /**
+         * From min bound
+         * @default 0
+         * @minimum -Infinity
+         * @maximum Infinity
+         * @step 1
+         */
+        from: number;
+        /**
+         * To max bound
+         * @default 255
+         * @minimum -Infinity
+         * @maximum Infinity
+         * @step 1
+         */
+        to: number;
+    }
+    class RGBObjectMaxDto {
+        constructor(rgb?: Base.ColorRGB, max?: number);
+        /**
+         * Red value component
+         * @default undefined
+         */
+        rgb: Base.ColorRGB;
+        /**
+         * Min value of the range
+         * @default 0
+         * @minimum 0
+         * @maximum 255
+         * @step 0.1
+         */
+        min: number;
+        /**
+         * Max value, it would automatically be remapped to whatever is needed if lower comes in
+         * @default 255
+         * @minimum 0
+         * @maximum 255
+         * @step 0.1
+         */
+        max: number;
+    }
+    class RGBMinMaxDto {
+        constructor(r?: number, g?: number, b?: number, min?: number, max?: number);
+        /**
+         * Red value component
+         * @default 255
+         * @minimum 0
+         * @maximum 255
+         * @step 1
+         */
+        r: number;
+        /**
+         * Green value component
+         * @default 255
+         * @minimum 0
+         * @maximum 255
+         * @step 1
+         */
+        g: number;
+        /**
+        * Blue value component
+        * @default 255
+        * @minimum 0
+        * @maximum 255
+        * @step 1
+        */
+        b: number;
+        /**
+         * Min value of the range
+         * @default 0
+         * @minimum 0
+         * @maximum 255
+         * @step 0.1
+         */
+        min: number;
+        /**
+         * Max value of the range
+         * @default 255
+         * @minimum 0
+         * @maximum 255
+         * @step 0.1
+         */
+        max: number;
+    }
+    class RGBObjectDto {
+        constructor(rgb?: Base.ColorRGB);
+        /**
+         * Red value component
+         * @default undefined
+         */
+        rgb: Base.ColorRGB;
+    }
+}

package/lib/api/inputs/color-inputs.js

@@ -0,0 +1,164 @@
+// tslint:disable-next-line: no-namespace
+export var Color;
+(function (Color) {
+    class HexDto {
+        constructor(color) {
+            /**
+             * Color hex
+             * @default #0000ff
+             */
+            this.color = "#0000ff";
+            if (color !== undefined) {
+                this.color = color;
+            }
+        }
+    }
+    Color.HexDto = HexDto;
+    class InvertHexDto {
+        constructor(color) {
+            /**
+             * Color hex
+             * @default #0000ff
+             */
+            this.color = "#0000ff";
+            /**
+             * Choose to invert the color to black and white (useful for text color)
+             */
+            this.blackAndWhite = false;
+            if (color !== undefined) {
+                this.color = color;
+            }
+        }
+    }
+    Color.InvertHexDto = InvertHexDto;
+    class HexDtoMapped {
+        constructor(color, from, to) {
+            /**
+             * Color hex
+             * @default #0000ff
+             */
+            this.color = "#0000ff";
+            /**
+             * From min bound
+             * @default 0
+             * @minimum -Infinity
+             * @maximum Infinity
+             * @step 1
+             */
+            this.from = 0;
+            /**
+             * To max bound
+             * @default 255
+             * @minimum -Infinity
+             * @maximum Infinity
+             * @step 1
+             */
+            this.to = 255;
+            if (color !== undefined) {
+                this.color = color;
+            }
+            if (from !== undefined) {
+                this.from = from;
+            }
+            if (to !== undefined) {
+                this.to = to;
+            }
+        }
+    }
+    Color.HexDtoMapped = HexDtoMapped;
+    class RGBObjectMaxDto {
+        constructor(rgb, max) {
+            /**
+             * Min value of the range
+             * @default 0
+             * @minimum 0
+             * @maximum 255
+             * @step 0.1
+             */
+            this.min = 0;
+            /**
+             * Max value, it would automatically be remapped to whatever is needed if lower comes in
+             * @default 255
+             * @minimum 0
+             * @maximum 255
+             * @step 0.1
+             */
+            this.max = 255;
+            if (rgb !== undefined) {
+                this.rgb = rgb;
+            }
+            if (max !== undefined) {
+                this.max = max;
+            }
+        }
+    }
+    Color.RGBObjectMaxDto = RGBObjectMaxDto;
+    class RGBMinMaxDto {
+        constructor(r, g, b, min, max) {
+            /**
+             * Red value component
+             * @default 255
+             * @minimum 0
+             * @maximum 255
+             * @step 1
+             */
+            this.r = 255;
+            /**
+             * Green value component
+             * @default 255
+             * @minimum 0
+             * @maximum 255
+             * @step 1
+             */
+            this.g = 255;
+            /**
+            * Blue value component
+            * @default 255
+            * @minimum 0
+            * @maximum 255
+            * @step 1
+            */
+            this.b = 255;
+            /**
+             * Min value of the range
+             * @default 0
+             * @minimum 0
+             * @maximum 255
+             * @step 0.1
+             */
+            this.min = 0;
+            /**
+             * Max value of the range
+             * @default 255
+             * @minimum 0
+             * @maximum 255
+             * @step 0.1
+             */
+            this.max = 255;
+            if (r !== undefined) {
+                this.r = r;
+            }
+            if (g !== undefined) {
+                this.g = g;
+            }
+            if (b !== undefined) {
+                this.b = b;
+            }
+            if (min !== undefined) {
+                this.min = min;
+            }
+            if (max !== undefined) {
+                this.max = max;
+            }
+        }
+    }
+    Color.RGBMinMaxDto = RGBMinMaxDto;
+    class RGBObjectDto {
+        constructor(rgb) {
+            if (rgb !== undefined) {
+                this.rgb = rgb;
+            }
+        }
+    }
+    Color.RGBObjectDto = RGBObjectDto;
+})(Color || (Color = {}));

package/lib/api/inputs/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./color-inputs";
+export * from "./lists-inputs";
+export * from "./logic-inputs";
+export * from "./math-inputs";
+export * from "./point-inputs";
+export * from "./text-inputs";
+export * from "./vector-inputs";
+export * from "./transforms-inputs";

package/lib/api/inputs/index.js

@@ -0,0 +1,8 @@
+export * from "./color-inputs";
+export * from "./lists-inputs";
+export * from "./logic-inputs";
+export * from "./math-inputs";
+export * from "./point-inputs";
+export * from "./text-inputs";
+export * from "./vector-inputs";
+export * from "./transforms-inputs";

package/lib/api/inputs/inputs.d.ts

@@ -0,0 +1,10 @@
+export * from "./color-inputs";
+export * from "./lists-inputs";
+export * from "./logic-inputs";
+export * from "./math-inputs";
+export * from "./point-inputs";
+export * from "./text-inputs";
+export * from "./base-inputs";
+export * from "./text-inputs";
+export * from "./vector-inputs";
+export * from "./transforms-inputs";

package/lib/api/inputs/inputs.js

@@ -0,0 +1,10 @@
+export * from "./color-inputs";
+export * from "./lists-inputs";
+export * from "./logic-inputs";
+export * from "./math-inputs";
+export * from "./point-inputs";
+export * from "./text-inputs";
+export * from "./base-inputs";
+export * from "./text-inputs";
+export * from "./vector-inputs";
+export * from "./transforms-inputs";