@degenerate/generic 0.2.4 → 0.2.6

package/LICENSE.md

@@ -0,0 +1,63 @@
+# LICENSE
+
+## Open-Source License: Apache License 2.0
+
+Copyright (c) [2024], [Degenerateiinc.ca]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at:
+
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+## Additional Terms for Proprietary Extensions and Features
+
+The SAFE Platform includes features and functionalities that may extend beyond the open-source scope of this license, including but not limited to:
+
+1. **Advanced Enterprise Features**:
+   - Modules and tools tailored for enterprise-level scalability, security, and analytics.
+   - Customizable AI-driven extensions designed for high-volume data processing and decision-making.
+   - Separate licensing agreements are required for accessing these features.
+
+2. **Marketplace Components**:
+   - Extensions, plugins, and templates available through the SAFE Marketplace may include specific licensing terms.
+   - Revenue-sharing agreements apply for developers contributing paid components to the Marketplace.
+   - Use of these components may require additional payments or subscription plans.
+
+3. **Partnered Integrations**:
+   - SAFE Platform offers pre-integrated solutions with third-party platforms such as CRM systems, payment gateways, or cloud services.
+   - These integrations may require accepting additional terms from the third-party providers.
+   - Usage is governed by both this License and the third-party terms where applicable.
+
+4. **Subscription-Based Analytics**:
+   - Advanced analytics features, including real-time data insights, AI model performance metrics, and user behavior analysis.
+   - These are provided through subscription services managed under proprietary agreements.
+   - Subscriptions may include tiered pricing based on data volume, number of users, or access levels.
+
+5. **Industry-Specific Solutions**:
+   - SAFE Platform provides pre-configured templates and rules tailored for industries such as finance, healthcare, and logistics.
+   - These solutions include proprietary intellectual property that is not covered by the open-source license.
+   - Licensing agreements specify terms for usage and redistribution of these industry-specific components.
+
+By using the SAFE Platform, you agree to abide by these additional terms where applicable. For more details, contact [Your Organization's Contact Information].
+
+## Contribution and Use
+
+1. **Community Contributions**:
+   - Contributions to the SAFE Platform's open-source repository are governed by the Apache License 2.0.
+   - By submitting a contribution, you agree that your work will be licensed under this license.
+   - Contributions must adhere to the project's coding standards and submission guidelines.
+
+2. **Proprietary Extensions**:
+   - Contributions extending into proprietary areas require pre-approval by the administrators in the .
+   - These contributions may be subject to separate agreements defining revenue sharing, ownership rights, and maintenance responsibilities.
+
+## Notices
+
+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

@@ -1,3 +1,20 @@
-# @Degenerate/generic Package
+[Back to @degenerate documentation](../../README.md)
+[Back to @degenerate packages documentation](../README.md)
+
+# <p align="center" style="color:#2589BD; font-size:36px;"><b>@degenerate/generic Package</b></p>
+
+The `@degenerate/generic` package package contains all the generic functions and models for use in the SAFE ecosystem. The package is used to provide common functionality across the different services in the SAFE environment.
+
+## Contents
+
+1. [Installation](#installation)
+
+
+## Installation
+
+To install the `@degenerate/generic` package, use the following command:
+
+```bash
+npm install @degenerate/generic
+```
 
-This package contains generic functions and models for use in the SAFE ecosystem. The package is used to provide common functionality across the different services in the SAFE environment.

package/dist/models/events/share-event-models.d.ts

@@ -1,7 +1,4 @@
 import { z } from 'zod';
-/**
- * This contains the interfaces for all event data types that can be run on the network.
- */
 /**
  * This is the types of events that can be run on the network.
  */
@@ -105,7 +102,7 @@ export declare const ShareDataEventSchema: z.ZodObject<{
     eventSource: z.ZodString;
     eventSourceTruthType: z.ZodEnum<["Crypto", "Oauth", "ShareBlock"]>;
     eventSourceTruthProofType: z.ZodEnum<["Hash", "Signature"]>;
-    eventSourceTruthProof: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodType<Buffer<ArrayBuffer>, z.ZodTypeDef, Buffer<ArrayBuffer>>]>;
+    EventSourceTruthProof: z.ZodString;
     triggerCondition: z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodBoolean>;
     shareDataEventInformation: z.ZodArray<z.ZodObject<{
         shareData: z.ZodArray<z.ZodObject<{
@@ -150,7 +147,7 @@ export declare const ShareDataEventSchema: z.ZodObject<{
     eventSource: string;
     eventSourceTruthType: "Crypto" | "Oauth" | "ShareBlock";
     eventSourceTruthProofType: "Hash" | "Signature";
-    eventSourceTruthProof: string | number | Buffer<ArrayBuffer>;
+    EventSourceTruthProof: string;
     triggerCondition: (args_0: any, ...args: unknown[]) => boolean;
     shareDataEventInformation: {
         shareData: {
@@ -169,7 +166,7 @@ export declare const ShareDataEventSchema: z.ZodObject<{
     eventSource: string;
     eventSourceTruthType: "Crypto" | "Oauth" | "ShareBlock";
     eventSourceTruthProofType: "Hash" | "Signature";
-    eventSourceTruthProof: string | number | Buffer<ArrayBuffer>;
+    EventSourceTruthProof: string;
     triggerCondition: (args_0: any, ...args: unknown[]) => boolean;
     shareDataEventInformation: {
         shareData: {

package/dist/models/events/share-event-models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"share-event-models.d.ts","sourceRoot":"","sources":["../../../src/models/events/share-event-models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AAIH;;GAEG;AACH,oBAAY,cAAc;IACtB,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,SAAS,cAAc;CAC1B;AAED,eAAO,MAAM,oBAAoB,uDAI/B,CAAC;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC5B,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,UAAU,eAAe;CAC5B;AAED,eAAO,MAAM,0BAA0B,8CAIrC,CAAC;AAEH;;GAEG;AACH,oBAAY,yBAAyB;IACjC,IAAI,SAAS;IACb,SAAS,cAAc;CAC1B;AAED,eAAO,MAAM,+BAA+B,kCAG1C,CAAC;AAEH;;GAEG;AACH,oBAAY,4BAA4B;IACpC,QAAQ,aAAa;IACrB,MAAM,WAAW;CACpB;AAED,eAAO,MAAM,kCAAkC,mCAG7C,CAAC;AAIH;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;EAK1C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAEzF;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;GAEG;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAW/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}
+{"version":3,"file":"share-event-models.d.ts","sourceRoot":"","sources":["../../../src/models/events/share-event-models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAuB,MAAM,KAAK,CAAC;AAoB7C;;GAEG;AACH,oBAAY,cAAc;IACtB,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,SAAS,cAAc;CAC1B;AAED,eAAO,MAAM,oBAAoB,uDAI/B,CAAC;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC5B,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,UAAU,eAAe;CAC5B;AAED,eAAO,MAAM,0BAA0B,8CAIrC,CAAC;AAEH;;GAEG;AACH,oBAAY,yBAAyB;IACjC,IAAI,SAAS;IACb,SAAS,cAAc;CAC1B;AAED,eAAO,MAAM,+BAA+B,kCAG1C,CAAC;AAEH;;GAEG;AACH,oBAAY,4BAA4B;IACpC,QAAQ,aAAa;IACrB,MAAM,WAAW;CACpB;AAED,eAAO,MAAM,kCAAkC,mCAG7C,CAAC;AAIH;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;EAK1C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAEzF;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;GAEG;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAY/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/models/events/share-event-models.js

@@ -5,6 +5,16 @@ const zod_1 = require("zod");
 /**
  * This contains the interfaces for all event data types that can be run on the network.
  */
+//#region CustomTypes
+/**
+ * This is the custom type for the buffer required for zod.
+ */
+const BufferSchema = zod_1.z.custom((data) => {
+    return Buffer.isBuffer(data);
+}, {
+    message: "Invalid buffer",
+});
+//#endregion CustomTypes
 //#region Share Event Data Enums
 /**
  * This is the types of events that can be run on the network.
@@ -85,7 +95,8 @@ exports.ShareDataEventSchema = zod_1.z.object({
     eventSource: zod_1.z.string(),
     eventSourceTruthType: exports.EventSourceTruthTypeSchema,
     eventSourceTruthProofType: exports.EventSourceTruthProofTypeSchema,
-    eventSourceTruthProof: zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.instanceof(Buffer)]),
+    EventSourceTruthProof: zod_1.z.string(),
+    // eventSourceTruthProof: z.union([z.string(), BufferSchema]),
     triggerCondition: zod_1.z.function().args(zod_1.z.any()).returns(zod_1.z.boolean()),
     shareDataEventInformation: zod_1.z.array(exports.IShareDataEventSchema),
     eventContext: zod_1.z.record(zod_1.z.any()),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@degenerate/generic",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "This contains the generic information needed for the ShareData Adaptive Framework Ecosystem (SAFE) network",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -37,7 +37,7 @@
     "jsonwebtoken": "^9.0.2",
     "zod": "^3.24.1"
   },
-  "gitHead": "b4650f64e893661657b8495a29e510fd4ca2e7df",
+  "gitHead": "a1ef457f3b707fb642b2e3296239c74bd75614b8",
   "devDependencies": {
     "@eslint/js": "^9.17.0",
     "@types/eslint__js": "^8.42.3",

package/LICENCE.md

@@ -1,15 +0,0 @@
-ISC License
-
-Copyright (c) [2024] [Degenerateiinc.ca]
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.