AeThex-OS/aethex-docs/packages/core/README.md
MrPiglr a15b5b1015 feat: integrate AeThex Language across entire OS ecosystem
Major Features:
- Custom .aethex programming language with cross-platform compilation
- Compiles to JavaScript, Lua (Roblox), Verse (UEFN), and C# (Unity)
- Built-in COPPA compliance and PII detection for safe metaverse development

Integration Points:
1. Terminal Integration
   - Added 'aethex' command for in-terminal compilation
   - Support for all compilation targets with --target flag
   - Real-time error reporting and syntax highlighting

2. IDE Integration
   - Native .aethex file support in Monaco editor
   - One-click compilation with target selector
   - Download compiled code functionality
   - Two example files: hello.aethex and auth.aethex

3. Curriculum Integration
   - New "AeThex Language" section in Foundry tech tree
   - Three modules: Realities & Journeys, Cross-Platform Sync, COPPA Compliance
   - Certification path for students

4. Documentation Site
   - Complete docs at /docs route (client/src/pages/aethex-docs.tsx)
   - Searchable documentation with sidebar navigation
   - Language guide, standard library reference, and examples
   - Ready for deployment to aethex.dev

5. npm Package Publishing
   - @aethex.os/core@1.0.0 - Standard library (published)
   - @aethex.os/cli@1.0.1 - Command line compiler (published)
   - Both packages live on npm and globally installable

Domain Configuration:
- DNS setup for 29+ domains (aethex.app, aethex.co, etc.)
- nginx reverse proxy configuration
- CORS configuration for cross-domain requests
- OAuth redirect fixes for hash-based routing

Standard Library Features:
- Passport: Universal identity across platforms
- DataSync: Cross-platform data synchronization
- SafeInput: PII detection (phone, email, SSN, credit cards)
- Compliance: COPPA/FERPA age gates and audit logging

Documentation Package:
- Created aethex-dev-docs.zip with complete documentation
- Ready for static site deployment
- Includes examples, API reference, and quickstart guide

Technical Improvements:
- Fixed OAuth blank page issue (hash routing)
- Added .gitignore rules for temp files
- Cleaned up build artifacts and temporary files
- Updated all package references to @aethex.os namespace

Co-Authored-By: Claude <noreply@anthropic.com>
2026-02-11 22:28:05 -07:00

99 lines
2.3 KiB
Markdown

# @aethex.os/core
AeThex Language Standard Library - Cross-platform utilities for authentication, data sync, and compliance.
## Installation
```bash
npm install @aethex.os/core
```
## Features
- **Passport** - Universal identity across platforms
- **DataSync** - Cross-platform data synchronization
- **SafeInput** - PII detection and scrubbing (CRITICAL for CODEX)
- **Compliance** - COPPA/FERPA compliance checks
## Usage
### Passport - Universal Identity
```javascript
const { Passport } = require('@aethex/core');
const passport = new Passport('user123', 'PlayerOne');
await passport.verify();
await passport.syncAcross(['roblox', 'web']);
```
### SafeInput - PII Detection
```javascript
const { SafeInput } = require('@aethex/core');
// Detect PII
const detected = SafeInput.detectPII('Call me at 555-1234');
// Returns: ['phone']
// Scrub PII
const clean = SafeInput.scrub('My email is user@example.com');
// Returns: 'My email is [EMAIL_REDACTED]'
// Validate input
const result = SafeInput.validate('PlayerName123');
if (result.valid) {
console.log('Safe to use');
}
```
### Compliance - COPPA Checks
```javascript
const { Compliance } = require('@aethex/core');
// Age gate
if (Compliance.isCOPPACompliant(userAge)) {
// User is 13+
}
// Log compliance check
Compliance.logCheck(userId, 'leaderboard_submission', true);
```
## API Reference
### Passport
- `new Passport(userId, username)` - Create passport
- `verify()` - Verify identity
- `syncAcross(platforms)` - Sync across platforms
- `toJSON()` - Export as JSON
### DataSync
- `DataSync.sync(data, platforms)` - Sync data
- `DataSync.pull(userId, platform)` - Pull data
### SafeInput
- `SafeInput.detectPII(input)` - Returns array of detected PII types
- `SafeInput.scrub(input)` - Returns scrubbed string
- `SafeInput.validate(input, allowedTypes?)` - Returns validation result
### Compliance
- `Compliance.isCOPPACompliant(age)` - Check if 13+
- `Compliance.requiresParentConsent(age)` - Check if <13
- `Compliance.canCollectData(user)` - Check data collection permission
- `Compliance.logCheck(userId, checkType, result)` - Log audit trail
## License
MIT © AeThex Foundation
## Links
- [Documentation](https://aethex.dev/lang)
- [GitHub](https://github.com/aethex/aethex-lang)
- [Issues](https://github.com/aethex/aethex-lang/issues)