rcf-protocol 1.1.0 → 1.1.1
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.
- package/LICENSE +184 -0
- package/README.md +35 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/package.json +3 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
RESTRICTED CORRELATION FRAMEWORK PROTOCOL LICENSE
|
|
2
|
+
Version 1.1, Effective Date: 2026
|
|
3
|
+
|
|
4
|
+
Copyright (c) 2026 [Author Name]
|
|
5
|
+
All rights reserved.
|
|
6
|
+
|
|
7
|
+
================================================================================
|
|
8
|
+
PREAMBLE
|
|
9
|
+
================================================================================
|
|
10
|
+
|
|
11
|
+
This License governs the use of the Restricted Correlation Framework (RCF)
|
|
12
|
+
Protocol and any works protected under this License. RCF establishes a new
|
|
13
|
+
category of intellectual property protection that distinguishes between
|
|
14
|
+
visibility rights and usage rights.
|
|
15
|
+
|
|
16
|
+
By accessing, viewing, or otherwise engaging with any RCF-protected work,
|
|
17
|
+
you acknowledge and agree to be bound by the terms of this License.
|
|
18
|
+
|
|
19
|
+
================================================================================
|
|
20
|
+
DEFINITIONS
|
|
21
|
+
================================================================================
|
|
22
|
+
|
|
23
|
+
"RCF Protocol" means the licensing framework, specifications, and
|
|
24
|
+
methodologies described in the RCF specification documents.
|
|
25
|
+
|
|
26
|
+
"Protected Work" means any software, documentation, methodology, or other
|
|
27
|
+
intellectual property bearing RCF notices or markers.
|
|
28
|
+
|
|
29
|
+
"Author" means the creator or owner of the Protected Work who has elected
|
|
30
|
+
to apply RCF protection.
|
|
31
|
+
|
|
32
|
+
"Visibility" means the act of reading, viewing, or manually examining the
|
|
33
|
+
Protected Work without automated assistance.
|
|
34
|
+
|
|
35
|
+
"Automated Extraction" means any use of software, scripts, AI/ML systems,
|
|
36
|
+
or other automated means to analyze, process, extract, or replicate
|
|
37
|
+
elements of the Protected Work.
|
|
38
|
+
|
|
39
|
+
"Correlation Methodology" means the specific techniques, algorithms,
|
|
40
|
+
patterns, or logic used to analyze, correlate, or derive insights from data.
|
|
41
|
+
|
|
42
|
+
================================================================================
|
|
43
|
+
GRANTED RIGHTS — VISIBILITY
|
|
44
|
+
================================================================================
|
|
45
|
+
|
|
46
|
+
Subject to compliance with this License, the Author grants you a limited,
|
|
47
|
+
non-exclusive, non-transferable right to:
|
|
48
|
+
|
|
49
|
+
1. MANUAL VIEWING
|
|
50
|
+
— Read and manually examine the Protected Work
|
|
51
|
+
— Study the Protected Work for personal education and research
|
|
52
|
+
— Create mental models and personal notes (non-automated)
|
|
53
|
+
|
|
54
|
+
2. RESPONSIBLE DISCLOSURE
|
|
55
|
+
— Report security vulnerabilities or bugs to the Author
|
|
56
|
+
— Follow responsible disclosure practices
|
|
57
|
+
|
|
58
|
+
3. REFERENCE AND CITATION
|
|
59
|
+
— Cite the Protected Work in academic or professional publications
|
|
60
|
+
— Reference the Protected Work with proper attribution
|
|
61
|
+
|
|
62
|
+
================================================================================
|
|
63
|
+
PROHIBITED ACTIVITIES — USAGE RESTRICTIONS
|
|
64
|
+
================================================================================
|
|
65
|
+
|
|
66
|
+
WITHOUT EXPRESS WRITTEN AUTHORIZATION, you MAY NOT:
|
|
67
|
+
|
|
68
|
+
1. AI/ML TRAINING AND DATASET GENERATION
|
|
69
|
+
— Use the Protected Work to train artificial intelligence or machine
|
|
70
|
+
learning models
|
|
71
|
+
— Include the Protected Work in training datasets
|
|
72
|
+
— Use AI/ML systems to analyze or replicate the Protected Work's
|
|
73
|
+
methodologies
|
|
74
|
+
|
|
75
|
+
2. AUTOMATED EXTRACTION
|
|
76
|
+
— Employ scripts, bots, scrapers, or automated tools to extract content
|
|
77
|
+
— Perform mass downloading, mirroring, or archiving
|
|
78
|
+
— Use static or dynamic analysis tools for automated comprehension
|
|
79
|
+
|
|
80
|
+
3. METHODOLOGY REPLICATION
|
|
81
|
+
— Reproduce, reimplement, or recreate the Correlation Methodology
|
|
82
|
+
— Create derivative works based on the Protected Work's unique approaches
|
|
83
|
+
— Document or publish the internal logic of the Protected Work
|
|
84
|
+
|
|
85
|
+
4. COMMERCIAL EXPLOITATION
|
|
86
|
+
— Use the Protected Work for commercial purposes, including but not limited
|
|
87
|
+
to: SaaS offerings, consulting services, paid integrations, or
|
|
88
|
+
commercial products
|
|
89
|
+
— Monetize access to or use of the Protected Work
|
|
90
|
+
— Bundle the Protected Work with commercial offerings
|
|
91
|
+
|
|
92
|
+
5. MASS OPERATIONS
|
|
93
|
+
— Perform mass scanning, scraping, or automated access
|
|
94
|
+
— Distribute tools designed to circumvent RCF protections
|
|
95
|
+
— Enable third parties to violate this License
|
|
96
|
+
|
|
97
|
+
================================================================================
|
|
98
|
+
SELF-ENFORCEMENT CLAUSE
|
|
99
|
+
================================================================================
|
|
100
|
+
|
|
101
|
+
This License is SELF-ENFORCING. Any violation automatically and immediately
|
|
102
|
+
terminates all rights granted under this License, without requirement for
|
|
103
|
+
prior notice or warning.
|
|
104
|
+
|
|
105
|
+
Upon termination:
|
|
106
|
+
- All access rights are revoked retroactively
|
|
107
|
+
- Any copies in your possession must be destroyed
|
|
108
|
+
- Legal remedies under applicable intellectual property law may be pursued
|
|
109
|
+
|
|
110
|
+
The Author reserves the right to pursue all available legal remedies
|
|
111
|
+
without limitation.
|
|
112
|
+
|
|
113
|
+
================================================================================
|
|
114
|
+
RESEARCH AND EDUCATIONAL EXCEPTIONS
|
|
115
|
+
================================================================================
|
|
116
|
+
|
|
117
|
+
Research and educational use is PERMITTED subject to the following
|
|
118
|
+
conditions:
|
|
119
|
+
|
|
120
|
+
1. The use is genuinely non-commercial and academic
|
|
121
|
+
2. No automated extraction or AI/ML processing is employed
|
|
122
|
+
3. The Correlation Methodology is not replicated or published
|
|
123
|
+
4. Proper attribution is provided
|
|
124
|
+
5. The research does not enable violations by third parties
|
|
125
|
+
|
|
126
|
+
Institutional review board (IRB) approval or equivalent ethical review
|
|
127
|
+
is recommended for research involving Protected Works.
|
|
128
|
+
|
|
129
|
+
================================================================================
|
|
130
|
+
TECHNICAL COMPLIANCE
|
|
131
|
+
================================================================================
|
|
132
|
+
|
|
133
|
+
Protected Works MAY implement technical measures to enforce this License,
|
|
134
|
+
including but not limited to:
|
|
135
|
+
|
|
136
|
+
- Rate limiting and access controls
|
|
137
|
+
- Behavioral analysis for automation detection
|
|
138
|
+
- Code obfuscation or dynamic loading
|
|
139
|
+
- Watermarking and fingerprinting
|
|
140
|
+
|
|
141
|
+
Circumvention of technical measures constitutes License violation.
|
|
142
|
+
|
|
143
|
+
================================================================================
|
|
144
|
+
JURISDICTION AND GOVERNING LAW
|
|
145
|
+
================================================================================
|
|
146
|
+
|
|
147
|
+
This License shall be governed by and construed in accordance with the laws
|
|
148
|
+
of [Jurisdiction TBD], without regard to conflict of law principles.
|
|
149
|
+
|
|
150
|
+
Disputes shall be resolved through binding arbitration in [Location TBD]
|
|
151
|
+
unless otherwise agreed in writing.
|
|
152
|
+
|
|
153
|
+
================================================================================
|
|
154
|
+
MISCELLANEOUS
|
|
155
|
+
================================================================================
|
|
156
|
+
|
|
157
|
+
SEVERABILITY: If any provision is unenforceable, remaining provisions
|
|
158
|
+
continue in effect.
|
|
159
|
+
|
|
160
|
+
NO WAIVER: Failure to enforce any provision does not constitute waiver
|
|
161
|
+
of future enforcement.
|
|
162
|
+
|
|
163
|
+
ENTIRE AGREEMENT: This License constitutes the entire agreement between
|
|
164
|
+
parties concerning the Protected Work.
|
|
165
|
+
|
|
166
|
+
================================================================================
|
|
167
|
+
CONTACT AND AUTHORIZATION REQUESTS
|
|
168
|
+
================================================================================
|
|
169
|
+
|
|
170
|
+
For authorization requests, licensing inquiries, or compliance questions:
|
|
171
|
+
|
|
172
|
+
[Contact Information TBD]
|
|
173
|
+
|
|
174
|
+
================================================================================
|
|
175
|
+
|
|
176
|
+
BY ACCESSING ANY RCF-PROTECTED WORK, YOU ACKNOWLEDGE THAT YOU HAVE READ,
|
|
177
|
+
UNDERSTOOD, AND AGREE TO BE BOUND BY THIS LICENSE.
|
|
178
|
+
|
|
179
|
+
IF YOU DO NOT AGREE, YOU MUST IMMEDIATELY CEASE ALL ACCESS AND DESTROY
|
|
180
|
+
ANY COPIES IN YOUR POSSESSION.
|
|
181
|
+
|
|
182
|
+
================================================================================
|
|
183
|
+
Copyright (c) 2026 Aladdin Aliyev. All rights reserved.
|
|
184
|
+
RCF Protocol License Version 1.1
|
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# RCF Protocol - TypeScript SDK
|
|
2
|
+
|
|
3
|
+
The official TypeScript SDK and Command Line Interface for the RCF (Requirement Compliance Framework) Protocol.
|
|
4
|
+
This SDK provides tooling for extracting and validating compliance metadata from source code using the RCF standard.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
# Install the SDK in your project
|
|
10
|
+
npm install rcf-protocol
|
|
11
|
+
|
|
12
|
+
# Or install globally to use the CLI anywhere
|
|
13
|
+
npm install -g rcf-protocol
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Features
|
|
17
|
+
|
|
18
|
+
- **Standardized Markers**: Identify strict RCF specification requirements directly in code.
|
|
19
|
+
- **RCF Parser**: Programmatic API for parsing `.rcf` requirements maps.
|
|
20
|
+
- **Compliance Validation CLI**: Enforce implementations against requirements mechanically.
|
|
21
|
+
- **TypeScript Native**: Full typing support out of the box.
|
|
22
|
+
|
|
23
|
+
## Core concepts
|
|
24
|
+
|
|
25
|
+
- `@rcf[RequirementID]:` - Embedded directly into comments to link implementation blocks.
|
|
26
|
+
- `RCF Map` - The central source of truth for all requirements, mapped to files/lines.
|
|
27
|
+
|
|
28
|
+
## CLI Usage
|
|
29
|
+
|
|
30
|
+
The `rcf-cli` binary allows for quick validation or map extraction straight from your terminal.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# Validates the current directory against the specification
|
|
34
|
+
rcf-cli validate ./src
|
|
35
|
+
```
|
package/dist/index.d.ts
CHANGED
|
@@ -2,4 +2,4 @@ export { MarkerParser } from './core/MarkerParser';
|
|
|
2
2
|
export { ComplianceValidator } from './core/ComplianceValidator';
|
|
3
3
|
export { RCF_MARKERS, MARKER_REGEX } from './core/constants';
|
|
4
4
|
export { RCFMarker, RCFMarkerType, ParseResult } from './core/types';
|
|
5
|
-
export declare const VERSION = "1.1
|
|
5
|
+
export declare const VERSION = "1.1";
|
package/dist/index.js
CHANGED
|
@@ -8,4 +8,4 @@ Object.defineProperty(exports, "ComplianceValidator", { enumerable: true, get: f
|
|
|
8
8
|
var constants_1 = require("./core/constants");
|
|
9
9
|
Object.defineProperty(exports, "RCF_MARKERS", { enumerable: true, get: function () { return constants_1.RCF_MARKERS; } });
|
|
10
10
|
Object.defineProperty(exports, "MARKER_REGEX", { enumerable: true, get: function () { return constants_1.MARKER_REGEX; } });
|
|
11
|
-
exports.VERSION = '1.1
|
|
11
|
+
exports.VERSION = '1.1';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rcf-protocol",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "RCF Protocol SDK for TypeScript/JavaScript",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"type": "git",
|
|
16
16
|
"url": "git+https://github.com/aliyevaladddin/rcf-protocol.git"
|
|
17
17
|
},
|
|
18
|
-
"license": "
|
|
18
|
+
"license": "SEE LICENSE IN LICENSE",
|
|
19
19
|
"scripts": {
|
|
20
20
|
"build": "tsc",
|
|
21
21
|
"dev": "ts-node src/cli/index.ts",
|
|
@@ -33,4 +33,4 @@
|
|
|
33
33
|
"ts-node": "^10.9.0",
|
|
34
34
|
"typescript": "^5.3.0"
|
|
35
35
|
}
|
|
36
|
-
}
|
|
36
|
+
}
|