@degenerate/rules 0.2.4 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE.md +60 -12
  2. package/README.md +27 -24
  3. package/package.json +3 -3
package/LICENSE.md CHANGED
@@ -1,15 +1,63 @@
1
- ISC License
1
+ # LICENSE
2
2
 
3
- Copyright (c) [2024] [Degenerateiinc.ca]
3
+ ## Open-Source License: Apache License 2.0
4
4
 
5
- Permission to use, copy, modify, and/or distribute this software for any
6
- purpose with or without fee is hereby granted, provided that the above
7
- copyright notice and this permission notice appear in all copies.
5
+ Copyright (c) [2024], [Degenerateiinc.ca]
8
6
 
9
- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
10
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11
- AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
12
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
14
- OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15
- PERFORMANCE OF THIS SOFTWARE.
7
+ Licensed under the Apache License, Version 2.0 (the "License");
8
+ you may not use this file except in compliance with the License.
9
+ You may obtain a copy of the License at:
10
+
11
+ [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
12
+
13
+ Unless required by applicable law or agreed to in writing, software
14
+ distributed under the License is distributed on an "AS IS" BASIS,
15
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ See the License for the specific language governing permissions and
17
+ limitations under the License.
18
+
19
+ ## Additional Terms for Proprietary Extensions and Features
20
+
21
+ The SAFE Platform includes features and functionalities that may extend beyond the open-source scope of this license, including but not limited to:
22
+
23
+ 1. **Advanced Enterprise Features**:
24
+ - Modules and tools tailored for enterprise-level scalability, security, and analytics.
25
+ - Customizable AI-driven extensions designed for high-volume data processing and decision-making.
26
+ - Separate licensing agreements are required for accessing these features.
27
+
28
+ 2. **Marketplace Components**:
29
+ - Extensions, plugins, and templates available through the SAFE Marketplace may include specific licensing terms.
30
+ - Revenue-sharing agreements apply for developers contributing paid components to the Marketplace.
31
+ - Use of these components may require additional payments or subscription plans.
32
+
33
+ 3. **Partnered Integrations**:
34
+ - SAFE Platform offers pre-integrated solutions with third-party platforms such as CRM systems, payment gateways, or cloud services.
35
+ - These integrations may require accepting additional terms from the third-party providers.
36
+ - Usage is governed by both this License and the third-party terms where applicable.
37
+
38
+ 4. **Subscription-Based Analytics**:
39
+ - Advanced analytics features, including real-time data insights, AI model performance metrics, and user behavior analysis.
40
+ - These are provided through subscription services managed under proprietary agreements.
41
+ - Subscriptions may include tiered pricing based on data volume, number of users, or access levels.
42
+
43
+ 5. **Industry-Specific Solutions**:
44
+ - SAFE Platform provides pre-configured templates and rules tailored for industries such as finance, healthcare, and logistics.
45
+ - These solutions include proprietary intellectual property that is not covered by the open-source license.
46
+ - Licensing agreements specify terms for usage and redistribution of these industry-specific components.
47
+
48
+ By using the SAFE Platform, you agree to abide by these additional terms where applicable. For more details, contact [Your Organization's Contact Information].
49
+
50
+ ## Contribution and Use
51
+
52
+ 1. **Community Contributions**:
53
+ - Contributions to the SAFE Platform's open-source repository are governed by the Apache License 2.0.
54
+ - By submitting a contribution, you agree that your work will be licensed under this license.
55
+ - Contributions must adhere to the project's coding standards and submission guidelines.
56
+
57
+ 2. **Proprietary Extensions**:
58
+ - Contributions extending into proprietary areas require pre-approval by the administrators in the .
59
+ - These contributions may be subject to separate agreements defining revenue sharing, ownership rights, and maintenance responsibilities.
60
+
61
+ ## Notices
62
+
63
+ This license file is intended to reflect a hybrid open-source and proprietary model for the SAFE Platform. It provides clarity for both community contributors and commercial users. For specific questions or legal inquiries, contact [Your Organization's Contact Information].
package/README.md CHANGED
@@ -1,13 +1,18 @@
1
- [Back to @degenerate documentation](../../README.md)
1
+ <span style="font-size: 12px;">[*Back to @degenerate documentation*](../../README.md)</span><br/>
2
+ <span style="font-size: 12px;">[*Back to @degenerate packages documentation*](../README.md)</span><br/>
2
3
 
3
- # @degenerate/rules Package
4
+ # <p align="center" style="color:#2589BD; font-size:36px;"><b>@degenerate/rules Package</b></p>
4
5
 
5
6
  The `@degenerate/rules` package is a core component of the SAFE system, responsible for defining and enforcing various rules and policies within the system. This package provides a set of utilities and functions to manage and validate rules, ensuring that the system operates within the defined constraints and policies.
6
7
 
8
+ For detailed information in the rules framework, see the [Rules Framework](./documentation/rules-framework.md) documentation.
7
9
 
8
10
  # Contents
9
11
 
10
- 1. [Rules Framework](./documentation/RULES-Framework.md)
12
+ 1. [Major Components](#major-components)
13
+ 1. [Rule Creation](#rule-creation)
14
+ 2. [Rule Evaluation](#rule-evaluation)
15
+ 3. [Rule Validation](#rule-validation)
11
16
  2. [Installation](#installation)
12
17
  3. [Usage](#usage)
13
18
  4. [Test Data](#test-data)
@@ -15,28 +20,35 @@ The `@degenerate/rules` package is a core component of the SAFE system, responsi
15
20
  6. [License](#license)
16
21
  7. [Support](#support)
17
22
 
18
- ## Features
23
+ ## Major Components
19
24
 
20
- - **Rule Creation**: Allows the creation and management of rules that govern the behavior of the system.
25
+ The degenerate/rules package is divided into three major components:
21
26
 
22
- Rule creation contains the functions and services to create rules that will be accepted into the SAFE Network. The `@degenerate/rules` package provides a set of utilities and functions to create and manage rules, ensuring that the system operates within the defined constraints and policies.
27
+ ### Rule Creation
28
+
29
+ Enables the creation and management of rules that govern the behavior of the system.
30
+
31
+ Rule creation contains the functions and services to create rules that that are designed and meet the criteria to be published to the SAFE ecosystem.
23
32
 
24
33
  [Rule Creation Directory](./src/create/)
25
34
 
26
- - **Rule Evaluation**: Provides utilities to take the existing data, proposed data changes and rule sets and evalute whether the proposed changes are valid.
35
+ ### Rule Evaluation
36
+
37
+ Provides utilities to take the existing data, proposed data changes and rule sets and evaluate whether the proposed changes are valid.
27
38
 
28
39
  Rule evaluation contains the functions and services to evaluate the proposed data to ensure that the share data objects are consistent and maintain integrity in the SAFE Network. The `@degenerate/rules` package provides a set of utilities and functions to evaluate rules, ensuring that the system operates within the defined constraints and policies.
29
40
 
30
41
  [Rule Evaluation Directory](./src/evaluation/)
31
42
 
32
- - **Rule Validation**: Provides utilities to validate rules, shapes and data coming into the SAFE network.
43
+ ### Rule Validation
44
+
45
+ Provides utilities to validate rules, shapes and data coming into the SAFE network.
33
46
 
34
47
  Rule Validation ensures that all data and operations within the system adhere to the established rules and policies and will be valid in the SAFE network. The `@degenerate/rules` package provides a set of utilities and functions to manage and validate rules, ensuring that the system operates within the defined constraints and policies.
35
48
 
36
49
  [Rule Evaluation Directory](./src/evaluation/)
37
50
 
38
-
39
- [Back To Top](#contents)
51
+ <span style="font-size: 10px;">[*back to contents*](#contents)</span>
40
52
 
41
53
  ## Installation
42
54
 
@@ -46,9 +58,7 @@ To install the `@degenerate/rules` package, use the following command:
46
58
  npm install @degenerate/rules
47
59
  ```
48
60
 
49
- [Back To Top](#contents)
50
-
51
- ## Usage
61
+ <span style="font-size: 10px;">[*back to contents*](#contents)</span>
52
62
 
53
63
  ## Test Data
54
64
 
@@ -56,26 +66,19 @@ Test data is provided in the `__testdata__` directory. This data is used to test
56
66
 
57
67
  [Test Data Directory](./__testdata__/)
58
68
 
59
- [Back To Top](#contents)
69
+ <span style="font-size: 10px;">[*back to contents*](#contents)</span>
60
70
 
61
71
  ## Contributing
62
72
  Contributions to the @degenerate/rules package are welcome. Please follow the guidelines outlined in the CONTRIBUTING.md file.
63
73
 
64
- [Back To Top](#contents)
74
+ <span style="font-size: 10px;">[*back to contents*](#contents)</span>
65
75
 
66
76
  ## License
67
77
  This package is licensed under the ISC License. See the [LICENSE](./LICENSE.md) file for more information.
68
78
 
69
- [Back To Top](#contents)
79
+ <span style="font-size: 10px;">[*back to contents*](#contents)</span>
70
80
 
71
81
  ## Support
72
82
  For support and questions, please open an issue on the GitHub repository.
73
83
 
74
- [Back To Top](#contents)
75
-
76
-
77
- | Rule Component | Function | Directory |
78
- | ----- | ----- | ----- |
79
- | **Creation** | Allows the creation and management of rules that govern the behaviour of the system. | [Create](./src/create/) |
80
- | **Evaluation** | Provides utilities to take the existing data, proposed data changes and rule sets and evaluate whether the proposed changes are valid. | ./src/evaluation/ |
81
- | **Validation** | Provides utilities to validate rules, shapes and data coming into the SAFE network. | ./src/validation/ |
84
+ <span style="font-size: 10px;">[*back to contents*](#contents)</span>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@degenerate/rules",
3
3
  "description": "This contains the rules information needed for the ShareData Adaptive Framework Ecosystem (SAFE) network.",
4
- "version": "0.2.4",
4
+ "version": "0.2.5",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "devDependencies": {
@@ -35,9 +35,9 @@
35
35
  "homepage": "https://github.com/syncrude/safe#readme",
36
36
  "author": "Degenerate Inc.",
37
37
  "license": "ISC",
38
- "gitHead": "b4650f64e893661657b8495a29e510fd4ca2e7df",
38
+ "gitHead": "419f7ddf66a429c148bc5d52e00495e896d5e5b4",
39
39
  "dependencies": {
40
- "@degenerate/generic": "^0.2.4",
40
+ "@degenerate/generic": "^0.2.5",
41
41
  "zod": "^3.24.1"
42
42
  }
43
43
  }