rcf-protocol 1.2.1 → 1.2.3

package/README.md

@@ -21,6 +21,8 @@ npm install -D rcf-protocol
 - **Standardized Markers Check**: Identify `[RCF:PUBLIC]`, `[RCF:PROTECTED]`, `[RCF:RESTRICTED]`, and `[RCF:NOTICE]` markers in your codebase.
 - **Header Validation**: Ensure files have the required `NOTICE: This file is protected under RCF-PL v1.1` header.
 - **Automated Scanning**: Quickly scan projects for compliance.
+- **RCF-Audit (Premium)**: Generate cryptographically signed compliance reports for enterprise auditing.
+
 
 ## CLI Usage
 
@@ -32,6 +34,9 @@ rcf-cli .
 
 # Scan with custom ignore list (in addition to .rcfignore)
 rcf-cli . --ignore node_modules,dist,.git
+
+# Generate an RCF-Audit Report (Requires License)
+rcf-cli audit . --license-key YOUR_RCF_AUDIT_KEY
 ```
 
 ## Markers Reference

package/dist/core/ComplianceValidator.d.ts

@@ -2,6 +2,10 @@ import { ParseResult, ValidationError } from './types';
 interface ValidatorOptions {
     strict?: boolean;
 }
+/**
+ * [RCF:RESTRICTED]
+ * The ComplianceValidator class enforces strict adherence to RCF specification standards.
+ */
 export declare class ComplianceValidator {
     private strict;
     constructor(options?: ValidatorOptions);

package/dist/core/ComplianceValidator.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComplianceValidator = void 0;
+/**
+ * [RCF:RESTRICTED]
+ * The ComplianceValidator class enforces strict adherence to RCF specification standards.
+ */
 class ComplianceValidator {
     constructor(options = {}) {
         this.strict = options.strict || false;

package/dist/core/constants.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MARKER_REGEX = exports.RCF_MARKERS = void 0;
+// [RCF:PUBLIC]
 exports.RCF_MARKERS = {
     PUBLIC: {
         name: '[RCF:PUBLIC]',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rcf-protocol",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "RCF Protocol SDK for TypeScript/JavaScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/cli/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/cli/index.js

@@ -1,121 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const chalk_1 = __importDefault(require("chalk"));
-const MarkerParser_1 = require("../core/MarkerParser");
-const ComplianceValidator_1 = require("../core/ComplianceValidator");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const crypto_1 = require("crypto");
-const pkg = JSON.parse((0, fs_1.readFileSync)((0, path_1.resolve)(__dirname, '../../package.json'), 'utf-8'));
-const program = new commander_1.Command();
-program
-    .name('rcf-cli')
-    .description('RCF Protocol CLI')
-    .version(pkg.version);
-program
-    .command('scan [directory]')
-    .description('Scan directory for RCF markers')
-    .option('-f, --format <type>', 'output format', 'pretty')
-    .option('--summary', 'show summary only')
-    .action(async (directory = '.', options) => {
-    const parser = new MarkerParser_1.MarkerParser();
-    const results = await parser.scan(directory);
-    if (options.summary) {
-        printSummary(results);
-    }
-    else {
-        printResults(results, options.format);
-    }
-});
-program
-    .command('validate [directory]')
-    .description('Validate RCF compliance')
-    .option('--strict', 'strict mode')
-    .action(async (directory = '.', options) => {
-    const parser = new MarkerParser_1.MarkerParser();
-    const results = await parser.scan(directory);
-    const validator = new ComplianceValidator_1.ComplianceValidator({ strict: options.strict });
-    const status = await validator.validate(results);
-    if (status.valid) {
-        console.log(chalk_1.default.green('✅ RCF compliance validated'));
-    }
-    else {
-        console.log(chalk_1.default.red('❌ RCF compliance failed'));
-        status.errors.forEach(e => console.log(chalk_1.default.red(`  • ${e.file}:${e.line} - ${e.message}`)));
-        process.exit(1);
-    }
-});
-program
-    .command('audit [directory]')
-    .description('Generate an RCF Audit Report (Premium Feature)')
-    .option('-k, --license-key <key>', 'RCF Audit License Key')
-    .action(async (directory = '.', options) => {
-    const licenseKey = options.licenseKey || process.env.RCF_LICENSE_KEY;
-    const uuidRegex = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/;
-    if (!licenseKey || !licenseKey.startsWith('RCF-AUDIT-') || !uuidRegex.test(licenseKey.replace('RCF-AUDIT-', ''))) {
-        console.log(chalk_1.default.red("❌ RCF-PL ERROR: The 'audit' command is a premium feature."));
-        console.log(chalk_1.default.yellow("   Please provide a valid RCF-AUDIT license key via -k/--license-key or RCF_LICENSE_KEY env variable."));
-        console.log(chalk_1.default.blue("   Visit https://rcf.aliyev.site to obtain a license."));
-        process.exit(1);
-    }
-    const parser = new MarkerParser_1.MarkerParser();
-    const results = await parser.scan(directory);
-    const auditReport = {
-        timestamp: new Date().toISOString(),
-        audit_type: "RCF-Audit as a Service",
-        protected_assets: []
-    };
-    for (const res of results) {
-        if (res.markers && res.markers.length > 0) {
-            try {
-                const fileBuffer = (0, fs_1.readFileSync)(res.file);
-                const fileHash = (0, crypto_1.createHash)('sha256').update(fileBuffer).digest('hex');
-                const uniqueMarkers = Array.from(new Set(res.markers.map((m) => m.type)));
-                const relPath = (0, path_1.relative)((0, path_1.resolve)(directory), res.file);
-                auditReport.protected_assets.push({
-                    file: relPath,
-                    markers: uniqueMarkers,
-                    sha256: fileHash
-                });
-            }
-            catch (e) {
-                // ignore
-            }
-        }
-    }
-    const reportPath = (0, path_1.resolve)(directory, 'RCF-AUDIT-REPORT.json');
-    (0, fs_1.writeFileSync)(reportPath, JSON.stringify(auditReport, null, 2));
-    console.log(chalk_1.default.green(`✅ RCF-Audit Complete. Generated ${reportPath}`));
-    console.log(chalk_1.default.cyan(`🔒 Encrypted snapshot of ${auditReport.protected_assets.length} protected assets created.`));
-});
-function printSummary(results) {
-    const stats = { PUBLIC: 0, PROTECTED: 0, RESTRICTED: 0, NOTICE: 0 };
-    results.forEach(r => r.markers.forEach((m) => stats[m.type]++));
-    console.log(chalk_1.default.bold('\n📊 RCF Markers Summary:'));
-    console.log(`  ${chalk_1.default.green('[RCF:PUBLIC]')}: ${stats.PUBLIC}`);
-    console.log(`  ${chalk_1.default.yellow('[RCF:PROTECTED]')}: ${stats.PROTECTED}`);
-    console.log(`  ${chalk_1.default.red('[RCF:RESTRICTED]')}: ${stats.RESTRICTED}`);
-    console.log(`  ${chalk_1.default.blue('[RCF:NOTICE]')}: ${stats.NOTICE}`);
-    console.log(`  Total files: ${results.length}\n`);
-}
-function printResults(results, format) {
-    if (format === 'json') {
-        console.log(JSON.stringify(results, null, 2));
-        return;
-    }
-    results.forEach(({ file, markers }) => {
-        console.log(chalk_1.default.bold(`\n📄 ${file}`));
-        markers.forEach((m) => {
-            const color = m.type === 'PUBLIC' ? 'green' :
-                m.type === 'PROTECTED' ? 'yellow' :
-                    m.type === 'RESTRICTED' ? 'red' : 'blue';
-            console.log(`  ${chalk_1.default[color](m.marker.name)} Line ${m.line}: ${m.context.substring(0, 50)}...`);
-        });
-    });
-}
-program.parse();