formula-store - npm Package Compare versions

Comparing version 0.0.0-beta to 1.0.0

package.json

 {
   "name": "formula-store",
-  "version": "0.0.0-beta",
   "description": " A package to handle formula calculations and dependency management",
+  "version": "1.0.0",
   "main": "lib/index.js",
@@ -10,3 +10,3 @@ "types": "lib/index.d.ts",
   ],
-  "repository": "[e-mail]:diogofcunha/package-template.git",
+  "repository": "[e-mail]:diogofcunha/formula-store.git",
   "author": "Diogo Cunha",
@@ -24,3 +24,5 @@ "license": "MIT",
   },
-  "dependencies": {},
+  "dependencies": {
+    "fast-graph": "^1.5.0"
+  },
   "devDependencies": {
@@ -74,3 +76,31 @@ "@tsconfig/recommended": "^1.0.1",
     ]
+  },
+  "keywords": [
+    "formula",
+    "formula-store",
+    "formula fields",
+    "computation",
+    "calculation",
+    "dependency management",
+    "reactive programming",
+    "state management",
+    "data modeling",
+    "math",
+    "computational",
+    "data-driven",
+    "dynamic calculations",
+    "formulas",
+    "store",
+    "dependency graph",
+    "stateful",
+    "reactive",
+    "algorithm",
+    "data processing"
+  ],
+  "release": {
+    "branches": [
+      "main",
+      "next"
+    ]
   }
 }

README.md

@@ -1,2 +0,137 @@
-# package-template
+# formula-store
 
+[![CircleCI](https://circleci.com/gh/diogofcunha/formula-store.svg?style=svg)](https://circleci.com/gh/diogofcunha/formula-store)
+[![npm package][npm-badge]][npm]
+
+[npm-badge]: https://img.shields.io/npm/v/formula-store.png?style=flat-square
+[npm]: https://www.npmjs.com/package/formula-store
+
+A versatile and efficient package for managing and calculating formula fields in a store.
+
+## Description
+
+🧮 `formula-store` is a TypeScript library designed to provide a flexible solution for handling formula fields. It enables you to manage dependencies, calculate values, and receive updates seamlessly. This package is well-suited for scenarios where dynamic formula-based computations are crucial and performance and robust api design matters.
+
+## Install
+
+```bash
+yarn add formula-store
+```
+
+```bash
+npm install formula-store
+```
+
+## Usage
+
+### 1. Create Formula Store
+
+Initialize a `FormulaStore` to manage and update formula fields.
+
+```typescript
+import { createFormulaStore } from "formula-store";
+
+// Example Usage:
+const store = createFormulaStore({
+  onChange: updates => {
+    // Handle updates when formula fields change.
+  }
+});
+```
+
+### 2. Define Formula Fields
+
+Create instances of `FormulaField` representing the formula fields you want to manage in your store.
+
+```typescript
+import { FormulaField, FormulaStore } from "formula-store";
+
+// Example Usage:
+const myFormulaField: FormulaField<number> = {
+  id: "uniqueId",
+  value: 42,
+  dependencies: ["dependencyA", "dependencyB"],
+  calculate: (dependencyA, dependencyB) => dependencyA + dependencyB
+};
+```
+
+### 3. Use Formula Store
+
+Utilize the store to manage formula fields and receive updates.
+
+```typescript
+// Example Usage:
+// Add fields for dependencies.
+store.addField({
+  dependencies: [],
+  id: "a",
+  value: 1
+});
+
+store.addField({
+  dependencies: [],
+  id: "b",
+  value: 3
+});
+
+store.addField({
+  dependencies: ["a", "b"],
+  id: "c",
+  value: 0,
+  calculate: (a, b) => a + b
+});
+
+// Update the values of formula fields in the store.
+store.updateFieldsValue([
+  { id: "a", value: 2 }
+  // Add more updates as needed.
+]);
+
+// Remove a formula field from the store.
+const affectedFields = store.removeField("a");
+console.log("Affected Fields: ", affectedFields);
+```
+
+## API Reference
+
+### `FormulaField<T>`
+
+Represents a field that is either a direct formula or a field that will be used inside another formula.
+
+- `id`: Unique identifier for the formula field.
+- `value`: The current value of the formula field.
+- `dependencies`: An array of other formula field ids representing the dependencies of the formula field.
+- `calculate`: A function that calculates the new value based on the provided dependencies. (Optional)
+
+### `FormulaUpdate`
+
+Represents an update for a formula field in the store.
+
+- `id`: Unique identifier for the formula field to be updated.
+- `value`: The new value for the formula field.
+
+### `FormulaStoreInput`
+
+Represents the input configuration for the FormulaStore.
+
+- `onChange`: A callback function to be called when formula fields are updated.
+
+### `FormulaStore`
+
+Represents a store for managing formula fields.
+
+- `addField`: Adds a new formula field to the store.
+- `removeField`: Removes a formula field from the store based on its identifier.
+- `updateFieldsValue`: Updates the values of multiple formula fields in the store.
+
+## Contributing
+
+Contributions are welcome! Please submit a pull request with any improvements or bug fixes. Make sure to add tests for any new features and bug fixes, and ensure that the existing tests pass.
+
+## License
+
+This project is licensed under the MIT License.
+
+## Contact
+
+If you need help or have questions, feel free to open an issue in the GitHub repository.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

47710

increased by2514.25%

Number of package files

10

increased by400%

Lines of code

237

increased byInfinity%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

138

increased by4500%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedfast-graph@^1.5.0

• + Addedfast-graph@1.5.0(transitive)