@cocreate/usage 1.2.1 → 1.3.0

package/.github/workflows/automated.yml

@@ -1,8 +1,10 @@
 name: Automated Workflow
+
 on:
   push:
     branches:
       - master
+
 jobs:
   about:
     runs-on: ubuntu-latest
@@ -18,52 +20,37 @@ jobs:
         with:
           direction: overwrite-github
           githubToken: "${{ secrets.GITHUB }}"
+
   release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/checkout@v4
         with:
-          node-version: 14
-      - name: Semantic Release
-        uses: cycjimmy/semantic-release-action@v3
-        id: semantic
+          fetch-depth: 0 # Required so semantic-release can trace git tags/history
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          extra_plugins: |
-            @semantic-release/changelog
+          node-version: 22
+
+      - name: Install Semantic Release & Plugins
+        # Installs semantic-release and its plugins on the runner
+        run: |
+          npm install -g semantic-release \
+            @semantic-release/changelog \
+            @semantic-release/npm \
+            @semantic-release/github \
             @semantic-release/git
-            @semantic-release/github
+
+      - name: Run Semantic Release (Native)
+        id: semantic
+        # This will automatically pick up your export default config file in the repository root
+        run: npx semantic-release
         env:
-          GITHUB_TOKEN: "${{ secrets.GITHUB }}"
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           NPM_TOKEN: "${{ secrets.NPM_TOKEN }}"
+
     outputs:
       new_release_published: "${{ steps.semantic.outputs.new_release_published }}"
-      new_release_version: "${{ steps.semantic.outputs.new_release_version }}"
-  upload:
-    runs-on: ubuntu-latest
-    needs: release
-    if: needs.release.outputs.new_release_published == 'true'
-    env:
-      VERSION: "${{ needs.release.outputs.new_release_version }}"
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - name: Set npm registry auth
-        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
-      - name: Install dependencies
-        run: yarn install
-      
-      - name: Set Environment Variables
-        run: |
-          echo "organization_id=${{ secrets.COCREATE_ORGANIZATION_ID }}" >> $GITHUB_ENV
-          echo "key=${{ secrets.COCREATE_KEY }}" >> $GITHUB_ENV
-          echo "host=${{ secrets.COCREATE_HOST }}" >> $GITHUB_ENV
-      - name: CoCreate Upload
-        run: coc upload
-
+      new_release_version: "${{ steps.semantic.outputs.new_release_version }}"

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [1.3.0](https://github.com/CoCreate-app/CoCreate-usage/compare/v1.2.2...v1.3.0) (2026-07-17)
+
+
+### Features
+
+* update automated workflow and release configuration for improved semantic release handling ([47aa8c2](https://github.com/CoCreate-app/CoCreate-usage/commit/47aa8c2941f8393a0ca55cbf6f66ae4df1172dea))
+
+## [1.2.2](https://github.com/CoCreate-app/CoCreate-usage/compare/v1.2.1...v1.2.2) (2026-07-14)
+
+
+### Bug Fixes
+
+* remove unnecessary console logs in init function for cleaner output ([af5f039](https://github.com/CoCreate-app/CoCreate-usage/commit/af5f03958fa5e84008411e99186bcdea438e7087))
+* removed post install ([933f2b6](https://github.com/CoCreate-app/CoCreate-usage/commit/933f2b6b9a7a551afb7e2723bfd02de9a72f2019))
+* semantic version handling. Reorganize .gitignore for improved clarity and structure ([9d67031](https://github.com/CoCreate-app/CoCreate-usage/commit/9d67031f6144a5b767ff0a2b6d487b14cbbd33aa))
+* update module export to ES6 syntax in release.config.js ([8908cb7](https://github.com/CoCreate-app/CoCreate-usage/commit/8908cb7ea61ceb65d1151909e8706c0a54046903))
+* update organization ID reference and host variable in sendUsageUpdate function ([4f4cc11](https://github.com/CoCreate-app/CoCreate-usage/commit/4f4cc11f9d0757b27c71f180ce83895fb2c436cd))
+* update package.json to use ESM and restructure entry points ([c96c5db](https://github.com/CoCreate-app/CoCreate-usage/commit/c96c5db22a621d2af2a151d2173ffaa265c03f6e))
+
 ## [1.2.1](https://github.com/CoCreate-app/CoCreate-usage/compare/v1.2.0...v1.2.1) (2025-05-01)
 
 

package/package.json

@@ -1,18 +1,10 @@
 {
   "name": "@cocreate/usage",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "CoCreate-usage",
   "keywords": [
     "cocreate-usage",
-    "cocreate",
-    "low-code-framework",
-    "no-code-framework",
-    "cocreatejs",
-    "cocreatejs-component",
-    "cocreate-framework",
-    "no-code",
     "low-code",
-    "collaborative-framework",
     "realtime",
     "realtime-framework",
     "collaboration",
@@ -20,6 +12,7 @@
     "html5-framework",
     "javascript-framework"
   ],
+  "type": "module",
   "main": "./src/index.js",
   "publishConfig": {
     "access": "public"
@@ -36,7 +29,6 @@
   "homepage": "https://cocreate.app/docs/CoCreate-usage",
   "scripts": {
     "demo": "PORT=5000 node demo/server.js",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "postinstall": "node -e \"const { execSync } = require('child_process'); try { execSync('coc --version', { stdio: 'ignore' }); } catch (error) { try { execSync('npm install -g @cocreate/cli', { stdio: 'inherit' }); console.log('Installed \"@cocreate/cli\" globally.'); } catch (error) { console.error('Failed to install \"@cocreate/cli\" globally:', error); } }\""
+    "test": "echo \"Error: no test specified\" && exit 1"
   }
 }

package/release.config.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   dryRun: false,
   branches: ["master"],
   plugins: [
@@ -10,12 +10,20 @@ module.exports = {
         changelogFile: "CHANGELOG.md",
       },
     ],
-    "@semantic-release/npm",
-    "@semantic-release/github",
+    "@semantic-release/npm", 
     [
-      "@semantic-release/git",
+      "@semantic-release/github", 
       {
+        successComment: false,
+        failTitle: false,
+      },
+    ],
+    [
+      "@semantic-release/git", 
+      {
+        // Only stage and commit the changelog and package.json
         assets: ["CHANGELOG.md", "package.json"],
+        message: "chore(release): ${nextRelease.version} [skip ci]",
       },
     ],
   ],

package/src/index.js

@@ -1,208 +1,244 @@
-class CoCreateUsage {
-    constructor(crud) {
-        this.wsManager = crud.wsManager;
-        this.crud = crud;
-        this.init();
-        this.organizations = new Map()
-    }
-
-    init() {
-        if (this.wsManager) {
-            this.wsManager.on('setBandwidth', (data) => this.setBandwidth(data));
-        }
-    }
+/********************************************************************************
+ * Copyright (C) 2023 CoCreate and Contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ ********************************************************************************/
+
+// Commercial Licensing Information:
+// For commercial use of this software without the copyleft provisions of the AGPLv3,
+// you must obtain a commercial license from CoCreate LLC.
+// For details, visit <https://cocreate.app/licenses/> or contact us at sales@cocreate.app.
+
+import server from '@cocreate/server';
+
+// ==========================================
+// Module-Level Sandbox State (ESM Singleton Container)
+// ==========================================
+const organizations = new Map();
+
+/**
+ * Normalizes input data types and calculates payload sizing in bytes.
+ */
+function getBytes(data) {
+    if (typeof data === 'number')
+        return data;
+    else if (data instanceof Buffer)
+        return data.byteLength || 0;
+    else if (data instanceof String || typeof data === 'string')
+        return Buffer.byteLength(data, 'utf8') || 0;
+    else if (typeof data === 'object' && data !== null)
+        return Buffer.byteLength(JSON.stringify(data), 'utf8') || 0;
+    else return 0;
+}
 
+/**
+ * Determines pricing tier rates based on aggregate historical usage indicators.
+ */
+function getRate(totalUsage = 0) {
+    const tiers = [
+        { limit: 1, rate: 10 },
+        { limit: 10, rate: 5 },
+        { limit: 100, rate: 2.5 },
+        { limit: 1000, rate: 1.125 },
+        { limit: 10000, rate: 0.562 },
+        { limit: 100000, rate: 0.281 },
+        { limit: 1000000, rate: 0.145 }
+    ];
+
+    const matchingTier = tiers.find(tier => totalUsage < tier.limit);
+    return matchingTier ? matchingTier.rate : 0.12;
+}
 
-    async setBandwidth({ type, data, organization_id }) {
-        try {
-            let dataTransfered = this.getBytes(data)
-
-            if (!dataTransfered || !organization_id)
-                return
-            // TODO: set duration 
-            let org = this.organizations.get(organization_id)
-            if (!org) {
-                let self = this
-
-                org = {}
-                org.debounce = setTimeout(() => {
-                    self.send(org, organization_id, data.host); // Call the callback to display the count
-                    self.organizations.delete(organization_id)
-                }, 60000);
-
-                org.dataTransferedIn = 0;
-                org.dataTransferedInCount = 0;
-                org.dataTransferedOut = 0;
-                org.dataTransferedOutCount = 0;
-
-                this.organizations.set(organization_id, org)
-            }
-
-            if (type === 'in') {
-                org.dataTransferedIn = dataTransfered;
-                org.dataTransferedInCount++
-            } else if (type === 'out') {
-                org.dataTransferedOut = dataTransfered;
-                org.dataTransferedOutCount++
-            } else {
-                console.log('else')
-            }
-
-        } catch (error) {
-            console.log('Usage error', error)
+/**
+ * Calculates and writes final bandwidth depletion transactions to the platform database.
+ */
+async function sendUsageUpdate(org, organization_id, host) {
+    if (!server || !server.crud) return;
+    delete org.debounce;
+
+    org.dataTransferedOut += 250;
+    org.dataTransferedOutCount++;
+
+    const platformOrganization = server.organization_id;
+    let organization = await server.crud.send({
+        method: 'object.read',
+        // host: server.host,
+        array: 'organizations',
+        object: { _id: organization_id },
+        organization_id: platformOrganization
+    });
+
+    org.dataTransferedIn += getBytes(platformOrganization);
+    org.dataTransferedInCount++;
+
+    if (organization && organization.object && organization.object[0]) {
+        organization = organization.object[0];
+    } else return;
+
+    if (server.wsManager && server.wsManager.organizations.has(organization_id)) {
+        const socketOrg = server.wsManager.organizations.get(organization_id);
+        if (organization.balance <= 0) {
+            socketOrg.status = false;
+            socketOrg.organizationBalance = false;
+            socketOrg.error = 'Your balance has fallen below 0';
+        } else {
+            socketOrg.status = true;
+            socketOrg.organizationBalance = true;
+            socketOrg.error = '';
         }
     }
 
+    let timeStamp = new Date(new Date().toISOString());
+    let isExpired = false;
+    if (organization.lastDeposit) {
+        let lastDeposit = new Date(organization.lastDeposit);
+        isExpired = lastDeposit <= timeStamp.setFullYear(timeStamp.getFullYear() - 1);
+    }
 
-    async send(org, organization_id, host) {
-        delete org.debounce
-
-        org.dataTransferedOut += 250
-        org.dataTransferedOutCount++
-
-        const platformOrganization = this.crud.config.organization_id
-        let organization = await this.crud.send({
-            method: 'object.read',
-            host: this.crud.config.host,
-            array: 'organizations',
-            object: { _id: organization_id },
-            organization_id: platformOrganization
-        })
-
-        org.dataTransferedIn += this.getBytes(platformOrganization)
-        org.dataTransferedInCount++
-
-        if (organization && organization.object && organization.object[0]) {
-            organization = organization.object[0]
-        } else return
-
-        //TODO: if (organization.transactionInterval) // set in global map to use with timeout 1 sec intervals to 3600 sec
-        if (this.wsManager.organizations.has(organization_id)) {
-            if (organization.balance <= 0) {
-                this.wsManager.organizations.get(organization_id).status = false
-                this.wsManager.organizations.get(organization_id).organizationBalance = false
-                this.wsManager.organizations.get(organization_id).error = 'Your balance has fallen bellow 0'
-
-            } else {
-                this.wsManager.organizations.get(organization_id).status = true
-                this.wsManager.organizations.get(organization_id).organizationBalance = true
-                this.wsManager.organizations.get(organization_id).error = ''
-            }
-        }
-
-        let timeStamp = new Date(new Date().toISOString());
-        let isExpired = false
-        if (organization.lastDeposit) {
-            let lastDeposit = new Date(organization.lastDeposit)
-            isExpired = lastDeposit <= timeStamp.setFullYear(timeStamp.getFullYear() - 1)
+    let isResetDataTransfer = false;
+    if (organization.modified && organization.modified.on) {
+        let previousTimeStamp = new Date(organization.modified.on);
+        if (previousTimeStamp.getMonth() !== timeStamp.getMonth()) {
+            isResetDataTransfer = true;
+            server.crud.send({
+                method: 'object.create',
+                // host: server.host,
+                array: 'transactions',
+                object: {
+                    organization_id,
+                    type: "withdrawal",
+                    dataTransfered: organization.dataTransfered,
+                    previousTimeStamp
+                },
+                organization_id: platformOrganization,
+                timeStamp
+            });
+            organization.dataTransfered = 0;
         }
+    }
 
-        let isResetDataTransfer = false
-        if (organization.modified && organization.modified.on) {
-            let previousTimeStamp = new Date(organization.modified.on)
-            if (previousTimeStamp.getMonth() !== timeStamp.getMonth()) {
-                isResetDataTransfer = true
-                this.crud.send({
-                    method: 'object.create',
-                    host: this.crud.config.host,
-                    array: 'transactions',
-                    object: {
-                        organization_id,
-                        type: "withdrawal", // deposit, credit, withdrawal, debit
-                        dataTransfered: organization.dataTransfered,
-                        previousTimeStamp
-                    },
-                    organization_id: platformOrganization,
-                    timeStamp
-                });
-                organization.dataTransfered = 0
-            }
-        }
+    let dataTransfered = org.dataTransferedIn + org.dataTransferedOut;
+    dataTransfered = dataTransfered / 1073741824;
+    dataTransfered = dataTransfered.toFixed(32);
+    dataTransfered = parseFloat(dataTransfered);
+
+    let rate = getRate(organization.dataTransfered);
+    let amount = dataTransfered * rate;
+    amount = -amount;
+    amount = amount.toFixed(32);
+    amount = parseFloat(amount);
+
+    let balanceUpdate = {
+        method: 'object.update',
+        // host: server.host,
+        array: 'organizations',
+        object: { _id: organization_id },
+        organization_id: platformOrganization,
+        timeStamp
+    };
+
+    if (isExpired)
+        balanceUpdate.object['balance'] = 0;
+    else
+        balanceUpdate.object.$inc = { balance: amount };
+
+    if (isResetDataTransfer)
+        balanceUpdate.object['dataTransfered'] = 0;
+    else if (!balanceUpdate.object.$inc)
+        balanceUpdate.object.$inc = { dataTransfered };
+    else
+        balanceUpdate.object.$inc.dataTransfered = dataTransfered;
+
+    server.crud.send(balanceUpdate);
+
+    let transaction = {
+        method: 'object.create',
+        host,
+        array: 'transactions',
+        object: {
+            organization_id,
+            type: "withdrawal",
+            amount,
+            rate,
+            dataTransfered,
+            ...org
+        },
+        organization_id,
+        timeStamp
+    };
+
+    server.crud.send(transaction);
+}
 
-        let dataTransfered = org.dataTransferedIn + org.dataTransferedOut
-        dataTransfered = dataTransfered / 1073741824;
-        dataTransfered = dataTransfered.toFixed(32);
-        dataTransfered = parseFloat(dataTransfered);
-
-        let rate = this.getRate(organization.dataTransfered)
-        let amount = dataTransfered * rate
-        amount = -amount
-        amount = amount.toFixed(32)
-        amount = parseFloat(amount)
-
-        let balanceUpdate = {
-            method: 'object.update',
-            host: this.crud.config.host,
-            array: 'organizations',
-            object: { _id: organization_id },
-            organization_id: platformOrganization,
-            timeStamp
+/**
+ * Event-driven handler that accumulates payload footprints and manages write debouncing.
+ */
+async function setBandwidth({ type, data, organization_id }) {
+    try {
+        let dataTransfered = getBytes(data);
+
+        if (!dataTransfered || !organization_id)
+            return;
+
+        let org = organizations.get(organization_id);
+        if (!org) {
+            org = {};
+            org.debounce = setTimeout(() => {
+                sendUsageUpdate(org, organization_id, data.host);
+                organizations.delete(organization_id);
+            }, 60000);
+
+            org.dataTransferedIn = 0;
+            org.dataTransferedInCount = 0;
+            org.dataTransferedOut = 0;
+            org.dataTransferedOutCount = 0;
+
+            organizations.set(organization_id, org);
         }
 
-        if (isExpired)
-            balanceUpdate.object['balance'] = 0
-        else
-            balanceUpdate.object.$inc = { balance: amount }
-
-        if (isResetDataTransfer)
-            balanceUpdate.object['dataTransfered'] = 0
-        else if (!balanceUpdate.object.$inc)
-            balanceUpdate.object.$inc = { dataTransfered }
-        else
-            balanceUpdate.object.$inc.dataTransfered = dataTransfered
-
-        // console.log('balanceUpdate: ', balanceUpdate)
-
-        this.crud.send(balanceUpdate)
-
-        let transaction = {
-            method: 'object.create',
-            host,
-            array: 'transactions',
-            object: {
-                organization_id,
-                type: "withdrawal", // deposit, credit, withdrawal, debit
-                amount,
-                rate,
-                dataTransfered,
-                ...org
-            },
-            organization_id,
-            timeStamp
+        if (type === 'in') {
+            org.dataTransferedIn = dataTransfered;
+            org.dataTransferedInCount++;
+        } else if (type === 'out') {
+            org.dataTransferedOut = dataTransfered;
+            org.dataTransferedOutCount++;
+        } else {
+            console.log('else');
         }
 
-        this.crud.send(transaction);
-
-    }
-
-    getBytes(data) {
-        if (typeof data === 'number')
-            return data;
-        else if (data instanceof Buffer)
-            return data.byteLength || 0;
-        else if (data instanceof String || typeof data === 'string')
-            return Buffer.byteLength(data, 'utf8') || 0;
-        else if (typeof data === 'object')
-            return Buffer.byteLength(JSON.stringify(data), 'utf8') || 0;
-        else return 0
+    } catch (error) {
+        console.log('Usage error', error);
     }
+}
 
-    getRate(totalUsage = 0) {
-        const tiers = [
-            { limit: 1, rate: 10 },
-            { limit: 10, rate: 5 },
-            { limit: 100, rate: 2.5 },
-            { limit: 1000, rate: 1.125 },
-            { limit: 10000, rate: 0.562 },
-            { limit: 100000, rate: 0.281 },
-            { limit: 1000000, rate: 0.145 }
-        ];
-
-        const matchingTier = tiers.find(tier => totalUsage < tier.limit);
-
-        return matchingTier ? matchingTier.rate : 0.12;
+/**
+ * Auto-initialization loop.
+ * Silently polls to verify that the unified server orchestrator is fully loaded,
+ * and that both the database (crud) and socket manager (wsManager) have completed
+ * their initial handshakes, then attaches active bandwidth monitoring triggers.
+ */
+function init() {
+    if (server && server.isInitialized && server.crud && server.wsManager) {
+        server.wsManager.on('setBandwidth', (data) => setBandwidth(data));
+    } else {
+        // If the server and WebSocket managers are not yet ready, retry in 500ms
+        setTimeout(init, 500);
     }
-
 }
 
-module.exports = CoCreateUsage;
+// Auto-execute initialization upon module load
+init();
+
+export default init;