@bitbybit-dev/base 1.0.0-rc.2 → 1.0.1

package/README.md

@@ -1,75 +1,97 @@
-## Bit By Bit Developers Base Algorithms for CAD library
+# @bitbybit-dev/base
 
-Visit [bitbybit.dev](https://bitbybit.dev) to use our full cloud platform.   
-Best way to support us - [Silver or Gold plan subscription](https://bitbybit.dev/auth/pick-plan)    
-Buy unique products from our [Crafts shop](https://crafts.bitbybit.dev) all designed with Bitbybit algorithms       
-Check out [3D Bits app for Shopify](https://apps.shopify.com/3d-bits-1) also used in our Crafts shop   
+Base algorithms for [Bitbybit](https://bitbybit.dev) CAD platform - math, vectors, matrices, lists, text utilities, and shared types used across all higher-level packages.
 
 <img src="https://app.bitbybit.dev/assets/git-cover.png" alt="Picture showing bitbybit.dev platform">
 
-This 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.
+## Overview
 
+This package provides the foundational layer for all Bitbybit CAD packages. It includes helper functions for math, text, lists, vectors, and matrix operations, along with base types used throughout the platform. This layer is kept lightweight with zero third-party dependencies.
 
-This package is already used or will be used in these packages:
+Works in both **Node.js** and **browser** environments.
 
-[@bitbybit-dev/babylonjs](https://www.npmjs.com/package/@bitbybit-dev/babylonjs)   
-[@bitbybit-dev/threejs](https://www.npmjs.com/package/@bitbybit-dev/threejs)   
-[@bitbybit-dev/core](https://www.npmjs.com/package/@bitbybit-dev/core)   
-[@bitbybit-dev/jscad](https://www.npmjs.com/package/@bitbybit-dev/jscad)   
-[@bitbybit-dev/jscad-worker](https://www.npmjs.com/package/@bitbybit-dev/jscad-worker)   
-[@bitbybit-dev/manifold](https://www.npmjs.com/package/@bitbybit-dev/manifold)   
-[@bitbybit-dev/manifold-worker](https://www.npmjs.com/package/@bitbybit-dev/manifold-worker)   
-[@bitbybit-dev/occt](https://www.npmjs.com/package/@bitbybit-dev/occt)   
-[@bitbybit-dev/occt-worker](https://www.npmjs.com/package/@bitbybit-dev/occt-worker)   
+## Used By
 
-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.
+This package is a dependency of all higher-level Bitbybit packages:
 
-## Github
-https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/base
-## NPM
-https://www.npmjs.com/package/@bitbybit-dev/base
+- [@bitbybit-dev/occt](https://www.npmjs.com/package/@bitbybit-dev/occt) - OpenCascade CAD kernel  
+- [@bitbybit-dev/occt-worker](https://www.npmjs.com/package/@bitbybit-dev/occt-worker) - OCCT via WebWorker  
+- [@bitbybit-dev/manifold](https://www.npmjs.com/package/@bitbybit-dev/manifold) - Manifold mesh booleans  
+- [@bitbybit-dev/manifold-worker](https://www.npmjs.com/package/@bitbybit-dev/manifold-worker) - Manifold via WebWorker  
+- [@bitbybit-dev/jscad](https://www.npmjs.com/package/@bitbybit-dev/jscad) - JSCAD solid modeling  
+- [@bitbybit-dev/jscad-worker](https://www.npmjs.com/package/@bitbybit-dev/jscad-worker) - JSCAD via WebWorker  
+- [@bitbybit-dev/core](https://www.npmjs.com/package/@bitbybit-dev/core) - Core assembly layer  
+- [@bitbybit-dev/babylonjs](https://www.npmjs.com/package/@bitbybit-dev/babylonjs) - BabylonJS integration  
+- [@bitbybit-dev/threejs](https://www.npmjs.com/package/@bitbybit-dev/threejs) - Three.js integration  
+- [@bitbybit-dev/playcanvas](https://www.npmjs.com/package/@bitbybit-dev/playcanvas) - PlayCanvas integration  
 
-## 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   
+## Quick Start
 
-## 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  
+The fastest way to start a project using Bitbybit packages:
 
-## Closed Source Example Applications
-https://app-store.bitbybit.dev/terrace-furniture
+```bash
+npx @bitbybit-dev/create-app my-project
+```
 
-## Build package
+This scaffolds a complete Vite + TypeScript project with all CAD kernels pre-configured. [Learn more about the CLI](https://learn.bitbybit.dev/learn/npm-packages/intro).
+
+## Links
+
+| Resource | URL |
+|----------|-----|
+| **GitHub** | https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/base |
+| **Monorepo** | https://github.com/bitbybit-dev/bitbybit |
+| **NPM** | https://www.npmjs.com/package/@bitbybit-dev/base |
+| **Documentation** | https://learn.bitbybit.dev/learn/npm-packages/intro |
+| **Unit Test Coverage** | https://tests.bitbybit.dev/base |
+
+## Example Applications
+
+| App | Source Code |
+|-----|-------------|
+| [Hex Shell](https://learn.bitbybit.dev/learn/npm-packages/threejs/advanced-parametric-3d-model) | [GitHub](https://github.com/bitbybit-dev/bitbybit/tree/master/examples/vite/threejs/hex-shell) |
+| [Cup Configurator](https://app-store.bitbybit.dev/cup) | [GitHub](https://github.com/bitbybit-dev/bitbybit/tree/master/examples/vite/threejs/cup) |
+| [Terrace Furniture](https://app-store.bitbybit.dev/terrace-furniture) (BabylonJS) | Closed source |
+
+## Development
+
+```bash
+# Build package
 npm run build-p
 
-## Run unit tests and generate test coverage
+# Run unit tests with coverage
 npm run test-c
 
-## Run live unit tests and generate test coverage on save
+# Run live unit tests with coverage on save
 npm run test-c-l
+```
+
+## Bitbybit Platform
+
+Beyond NPM packages, Bitbybit offers:
+
+- **[Visual Programming Editors](https://bitbybit.dev)** - Rete & Blockly drag-and-drop 3D modeling, plus a Monaco TypeScript editor  
+- **[CAD Cloud API](https://learn.bitbybit.dev/api/cloud-api)** - Build full [pipelines](https://learn.bitbybit.dev/api/sdk/typescript/pipelines) that compose all Bitbybit algorithms, where each step can reference outputs of previous steps. Supports parametric model generation, STEP-to-glTF conversion, and complex CAD workflows via HTTP  
+- **[Bitbybit Studio](https://studio.bitbybit.dev)** - A growing visual dashboard where API Key users can generate models, convert files, build [pipelines with a GUI](https://learn.bitbybit.dev/api/studio/intro), inspect tasks, and preview 3D results  
+- **[3D Bits for Shopify](https://apps.shopify.com/3d-bits-1)** - Interactive 3D product configurators for e-commerce  
+- **[Script Runners](https://learn.bitbybit.dev/learn/runners/intro)** - Execute visual scripts directly on your website  
+- **[AI-Assisted Development](https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/intro)** - Context files for GitHub Copilot, Claude, and ChatGPT  
+- **[Business & Enterprise](https://bitbybit.dev/b2b)** - We help businesses and enterprises develop custom applications and spin up optimized CAD tenant workflows on our managed servers  
+
+## Support the Project
+
+This package is part of the open-source Bitbybit ecosystem. Your subscription helps fund continued development.
+
+⭐ **[Subscribe - Silver or Gold plan](https://bitbybit.dev/auth/pick-plan)** | **[Get API Key for CAD Cloud](https://bitbybit.dev/auth/pick-plan?api-keys=true)**
 
-## Unit test coverage report online
-https://tests.bitbybit.dev/threejs
+## Community
 
-## 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/  
+- [Discord](https://discord.gg/GSe3VMe)  
+- [YouTube](https://www.youtube.com/@bitbybitdev?sub_confirmation=1)  
+- [LinkedIn](https://www.linkedin.com/company/bitbybit-dev)  
+- [X (Twitter)](https://x.com/bitbybit_dev)  
+- [Blog](https://learn.bitbybit.dev/blog)  
 
-## 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.
+## License
 
-## 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.
+MIT © [Bit By Bit Developers](https://bitbybit.dev)

package/lib/api/GlobalCDNProvider.js

@@ -1,3 +1,3 @@
 export class GlobalCDNProvider {
 }
-GlobalCDNProvider.BITBYBIT_CDN_URL = "https://git-cdn.bitbybit.dev/v1.0.0-rc.2";
+GlobalCDNProvider.BITBYBIT_CDN_URL = "https://git-cdn.bitbybit.dev/v1.0.1";

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

@@ -466,7 +466,7 @@ export declare namespace Math {
         constructor(expression?: string);
         /**
          * Arithmetic expression containing numbers, +, -, *, /, and parentheses
-         * @default "1+1"
+         * @default 1+1
          */
         expression: string;
     }

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

@@ -609,7 +609,7 @@ export var Math;
         constructor(expression) {
             /**
              * Arithmetic expression containing numbers, +, -, *, /, and parentheses
-             * @default "1+1"
+             * @default 1+1
              */
             this.expression = "1+1";
             if (expression !== undefined) {

package/lib/api/services/math.d.ts

@@ -465,7 +465,7 @@ export declare class MathBitByBit {
      * Safely evaluates a simple arithmetic expression containing only
      * numbers, +, -, *, /, parentheses, and whitespace.
      * Uses the shunting-yard algorithm — no eval/Function.
-     * Example: "(3+2)*4" → 20, "10/3" → 3.3333...
+     * Example: '(3+2)*4' → 20, '10/3' → 3.3333...
      * @param inputs arithmetic expression string
      * @returns evaluated result
      * @group operations

package/lib/api/services/math.js

@@ -664,7 +664,7 @@ export class MathBitByBit {
      * Safely evaluates a simple arithmetic expression containing only
      * numbers, +, -, *, /, parentheses, and whitespace.
      * Uses the shunting-yard algorithm — no eval/Function.
-     * Example: "(3+2)*4" → 20, "10/3" → 3.3333...
+     * Example: '(3+2)*4' → 20, '10/3' → 3.3333...
      * @param inputs arithmetic expression string
      * @returns evaluated result
      * @group operations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitbybit-dev/base",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.1",
   "description": "Bit By Bit Developers Base CAD Library to Program Geometry",
   "main": "index.js",
   "repository": {
@@ -55,6 +55,10 @@
   },
   "author": "Bit by bit developers",
   "license": "MIT",
+  "funding": {
+    "type": "corporate",
+    "url": "https://bitbybit.dev/auth/pick-plan"
+  },
   "types": "./index.d.ts",
   "type": "module",
   "dependencies": {},
@@ -62,14 +66,14 @@
     "shx":"0.4.0",
     "@testing-library/jest-dom": "6.9.1",
     "mvdir": "1.0.22",
-    "jest": "30.2.0",
+    "jest": "30.4.2",
     "ts-node": "10.9.2",
-    "ts-jest": "29.4.6",
+    "ts-jest": "29.4.10",
     "typescript": "5.9.3",
     "@types/jest": "30.0.0",
-    "babel-jest": "30.2.0",
-    "@babel/core": "7.28.6",
-    "@babel/preset-env": "7.28.6",
+    "babel-jest": "30.4.1",
+    "@babel/core": "7.29.0",
+    "@babel/preset-env": "7.29.5",
     "@babel/preset-typescript": "7.28.5",
     "jest-html-reporters": "3.1.7"
   },