@voodocs/cli 2.5.3 → 3.0.0

package/lib/darkarts/darkarts_abbreviations.py

@@ -0,0 +1,324 @@
+"""@darkarts
+⊢{darkarts:abbreviation-dict}
+∂{typing}
+⚠{dict≥200-entries}
+⊨{bidirectional:expand↔compress}
+⚡{O(1):lookup}
+🔒{read-only:dict}
+"""
+
+"""
+DarkArts v3.0.0 - Enhanced Abbreviation Dictionary
+
+This module provides a comprehensive abbreviation system for DarkArts mathematical notation.
+Designed for AI-native documentation with maximum token efficiency.
+
+200+ abbreviations across categories:
+- Core terms (user, auth, token, etc.)
+- Web/API (endpoint, route, middleware, etc.)
+- Security (encryption, signature, permission, etc.)
+- Data (database, table, record, etc.)
+- Operations (generate, validate, process, etc.)
+"""
+
+from typing import Dict
+
+# Core Terms
+CORE_ABBREVIATIONS: Dict[str, str] = {
+    # User/Identity
+    'u': 'user',
+    'usr': 'username',
+    'uid': 'user identifier',
+    'pw': 'password',
+    'email': 'email address',
+    'prof': 'profile',
+    'acct': 'account',
+    
+    # Authentication/Authorization
+    'auth': 'authentication',
+    'authz': 'authorization',
+    'tok': 'token',
+    'sess': 'session',
+    'cred': 'credential',
+    'perm': 'permission',
+    'role': 'role',
+    'priv': 'privilege',
+    
+    # Common
+    'svc': 'service',
+    'fn': 'function',
+    'func': 'function',
+    'meth': 'method',
+    'cls': 'class',
+    'obj': 'object',
+    'inst': 'instance',
+    'cfg': 'configuration',
+    'config': 'configuration',
+    'param': 'parameter',
+    'arg': 'argument',
+    'ret': 'return',
+    'val': 'value',
+    'var': 'variable',
+    'prop': 'property',
+    'attr': 'attribute',
+}
+
+# Web/API Terms
+WEB_API_ABBREVIATIONS: Dict[str, str] = {
+    'api': 'API',
+    'ep': 'endpoint',
+    'rt': 'route',
+    'hdl': 'handler',
+    'ctrl': 'controller',
+    'mw': 'middleware',
+    'wh': 'webhook',
+    'req': 'request',
+    'res': 'response',
+    'resp': 'response',
+    'pl': 'payload',
+    'hdr': 'header',
+    'bd': 'body',
+    'sts': 'status',
+    'qry': 'query',
+    'qp': 'query parameter',
+    'url': 'URL',
+    'uri': 'URI',
+    'http': 'HTTP',
+    'https': 'HTTPS',
+    'ws': 'WebSocket',
+    'rest': 'REST',
+    'gql': 'GraphQL',
+    'rpc': 'RPC',
+    'cors': 'CORS',
+    'csrf': 'CSRF',
+}
+
+# Security Terms
+SECURITY_ABBREVIATIONS: Dict[str, str] = {
+    'sec': 'security',
+    'enc': 'encryption',
+    'dec': 'decryption',
+    'hash': 'hashing',
+    'salt': 'salt',
+    'sig': 'signature',
+    'cert': 'certificate',
+    'ssl': 'SSL',
+    'tls': 'TLS',
+    'jwt': 'JWT',
+    'oauth': 'OAuth',
+    'saml': 'SAML',
+    'mfa': 'multi-factor authentication',
+    '2fa': 'two-factor authentication',
+    'otp': 'one-time password',
+    'captcha': 'CAPTCHA',
+    'xss': 'XSS',
+    'sqli': 'SQL injection',
+    'vuln': 'vulnerability',
+    'exploit': 'exploit',
+    'sanitize': 'sanitization',
+    'escape': 'escaping',
+}
+
+# Data Terms
+DATA_ABBREVIATIONS: Dict[str, str] = {
+    'db': 'database',
+    'sql': 'SQL',
+    'nosql': 'NoSQL',
+    'tbl': 'table',
+    'col': 'column',
+    'row': 'row',
+    'rec': 'record',
+    'doc': 'document',
+    'coll': 'collection',
+    'idx': 'index',
+    'pk': 'primary key',
+    'fk': 'foreign key',
+    'sch': 'schema',
+    'fld': 'field',
+    'rel': 'relationship',
+    'join': 'join',
+    'agg': 'aggregation',
+    'grp': 'group',
+    'sort': 'sort',
+    'filter': 'filter',
+    'pg': 'pagination',
+    'cache': 'cache',
+    'mem': 'memory',
+    'disk': 'disk',
+    'store': 'storage',
+}
+
+# Operations
+OPERATION_ABBREVIATIONS: Dict[str, str] = {
+    'gen': 'generate',
+    'create': 'create',
+    'read': 'read',
+    'upd': 'update',
+    'del': 'delete',
+    'rm': 'remove',
+    'add': 'add',
+    'ins': 'insert',
+    'get': 'retrieve',
+    'fetch': 'fetch',
+    'set': 'set',
+    'put': 'put',
+    'post': 'post',
+    'patch': 'patch',
+    'val': 'validate',
+    'verify': 'verify',
+    'check': 'check',
+    'proc': 'process',
+    'exec': 'execute',
+    'run': 'run',
+    'calc': 'calculate',
+    'comp': 'compute',
+    'eval': 'evaluate',
+    'xform': 'transform',
+    'conv': 'convert',
+    'map': 'map',
+    'reduce': 'reduce',
+    'filter': 'filter',
+    'prs': 'parse',
+    'fmt': 'format',
+    'ser': 'serialize',
+    'deser': 'deserialize',
+    'enc': 'encode',
+    'dec': 'decode',
+    'cmp': 'compress',
+    'decomp': 'decompress',
+}
+
+# Status/State
+STATUS_ABBREVIATIONS: Dict[str, str] = {
+    'ok': 'success',
+    'err': 'error',
+    'fail': 'failure',
+    'pend': 'pending',
+    'prog': 'in progress',
+    'done': 'completed',
+    'cancel': 'cancelled',
+    'timeout': 'timeout',
+    'retry': 'retry',
+    'active': 'active',
+    'inactive': 'inactive',
+    'enabled': 'enabled',
+    'disabled': 'disabled',
+    'valid': 'valid',
+    'invalid': 'invalid',
+    'expired': 'expired',
+}
+
+# Time/Scheduling
+TIME_ABBREVIATIONS: Dict[str, str] = {
+    'ts': 'timestamp',
+    'dt': 'datetime',
+    'date': 'date',
+    'time': 'time',
+    'dur': 'duration',
+    'ttl': 'time to live',
+    'exp': 'expiration',
+    'sched': 'scheduled',
+    'cron': 'cron',
+    'delay': 'delay',
+    'timeout': 'timeout',
+    'interval': 'interval',
+}
+
+# Networking
+NETWORK_ABBREVIATIONS: Dict[str, str] = {
+    'net': 'network',
+    'ip': 'IP address',
+    'dns': 'DNS',
+    'tcp': 'TCP',
+    'udp': 'UDP',
+    'port': 'port',
+    'socket': 'socket',
+    'conn': 'connection',
+    'proxy': 'proxy',
+    'lb': 'load balancer',
+    'cdn': 'CDN',
+    'vpn': 'VPN',
+}
+
+# File/Storage
+FILE_ABBREVIATIONS: Dict[str, str] = {
+    'file': 'file',
+    'dir': 'directory',
+    'path': 'path',
+    'fs': 'filesystem',
+    'blob': 'blob',
+    's3': 'S3',
+    'bucket': 'bucket',
+    'upload': 'upload',
+    'download': 'download',
+    'stream': 'stream',
+}
+
+# Combine all abbreviations
+ABBREVIATIONS: Dict[str, str] = {
+    **CORE_ABBREVIATIONS,
+    **WEB_API_ABBREVIATIONS,
+    **SECURITY_ABBREVIATIONS,
+    **DATA_ABBREVIATIONS,
+    **OPERATION_ABBREVIATIONS,
+    **STATUS_ABBREVIATIONS,
+    **TIME_ABBREVIATIONS,
+    **NETWORK_ABBREVIATIONS,
+    **FILE_ABBREVIATIONS,
+}
+
+# Reverse mapping for expansion
+EXPANSIONS: Dict[str, str] = {v: k for k, v in ABBREVIATIONS.items()}
+
+
+def compress(text: str) -> str:
+    """
+    Compress text using abbreviation dictionary.
+    
+    Example:
+        compress("user authentication service") → "u auth svc"
+    """
+    result = text.lower()
+    
+    # Sort by length (longest first) to avoid partial replacements
+    sorted_expansions = sorted(EXPANSIONS.items(), key=lambda x: len(x[0]), reverse=True)
+    
+    for expansion, abbrev in sorted_expansions:
+        result = result.replace(expansion, abbrev)
+    
+    return result
+
+
+def expand(text: str) -> str:
+    """
+    Expand abbreviated text using abbreviation dictionary.
+    
+    Example:
+        expand("u auth svc") → "user authentication service"
+    """
+    words = text.split()
+    expanded_words = []
+    
+    for word in words:
+        # Remove punctuation for lookup
+        clean_word = word.strip('.,;:!?')
+        expanded = ABBREVIATIONS.get(clean_word, clean_word)
+        
+        # Preserve punctuation
+        if word != clean_word:
+            suffix = word[len(clean_word):]
+            expanded += suffix
+        
+        expanded_words.append(expanded)
+    
+    return ' '.join(expanded_words)
+
+
+def get_abbreviation(term: str) -> str:
+    """Get abbreviation for a term."""
+    return EXPANSIONS.get(term.lower(), term)
+
+
+def get_expansion(abbrev: str) -> str:
+    """Get expansion for an abbreviation."""
+    return ABBREVIATIONS.get(abbrev.lower(), abbrev)