Initial Commit
This commit is contained in:
275
FOLDERS.md
Normal file
275
FOLDERS.md
Normal file
@@ -0,0 +1,275 @@
|
||||
# Package Categories
|
||||
|
||||
> One-word category folders for `packages/`. No hyphens. Every `@suaveplan/*` package lives in exactly one category.
|
||||
|
||||
## api
|
||||
|
||||
API framework, gateway, shared utilities, and domain-agnostic plugins.
|
||||
|
||||
**Existing:** `api-schemas`
|
||||
|
||||
**Pending:** `api` · `api-gateway` · `api-plugin-admin` · `api-plugin-analytics` · `api-plugin-audit` · `api-plugin-auth` · `api-plugin-campaigns` · `api-plugin-cms` · `api-plugin-database` · `api-plugin-events` · `api-plugin-export` · `api-plugin-file-upload` · `api-plugin-graphql` · `api-plugin-import` · `api-plugin-rate-limit` · `api-plugin-search` · `api-plugin-site` · `api-plugin-social` · `api-plugin-sse` · `api-plugin-tenant` · `api-plugin-user` · `api-plugin-webhook` · `api-shared`
|
||||
|
||||
## audio
|
||||
|
||||
Audio engines, effects, controllers, DMX lighting, sprite packing, metadata, and fingerprinting.
|
||||
|
||||
**Existing:** `audio-metadata` · `voice`
|
||||
|
||||
**Pending:** `audio-controllers` · `audio-engine` · `audio-plugins-fx` · `audio-sprite-packer` · `dmx` · `python-audio-fingerprint` · `r3f-audio` · `r3f-dmx` · `react-audio` · `react-audio-fingerprint` · `react-audio-player` · `react-audio-stream`
|
||||
|
||||
## auth
|
||||
|
||||
Authentication, authorization, identity, and tenant-scoped credential management.
|
||||
|
||||
**Existing:** `auth` · `jwt-tenant` · `macos-keychain` · `oauth-client` · `permissions` · `webauthn`
|
||||
|
||||
**Pending:** `react-auth` · `react-auth-whitelabel` · `react-permissions`
|
||||
|
||||
## barcode
|
||||
|
||||
Barcode and QR code generation, parsing, and validation.
|
||||
|
||||
**Existing:** `barcode` · `qrcode`
|
||||
|
||||
## bitpacker
|
||||
|
||||
Bit-level binary packing family. Dedicated folder because the ecosystem is large and vertically integrated.
|
||||
|
||||
**Existing:** `bitpacker` · `bitpacker-compressed` · `bitpacker-crypto` · `bitpacker-delta` · `bitpacker-game` · `bitpacker-network` · `bitpacker-schema` · `bitpacker-strategies` · `bitpacker-streaming` · `bitpacker-validation`
|
||||
|
||||
**Pending:** `packer-browser`
|
||||
|
||||
## commerce
|
||||
|
||||
Payments, currency, banking, and booking.
|
||||
|
||||
**Pending:** `api-plugin-asset-register` · `api-plugin-bank` · `api-plugin-banking` · `api-plugin-payment` · `bank` · `banking` · `booking` · `currency` · `currency-providers` · `money` · `payment` · `payment-providers` · `react-bank`
|
||||
|
||||
## contacts
|
||||
|
||||
Contact and group management, address books, and macOS Contacts integration.
|
||||
|
||||
**Pending:** `api-plugin-contacts` · `contacts` · `macos-contacts` · `react-contacts`
|
||||
|
||||
## core
|
||||
|
||||
Core primitives and utilities that the rest of the monorepo builds on: configuration, environment, errors, schemas, types, and shared utilities.
|
||||
|
||||
**Existing:** `config` · `env` · `error` · `schema-registry` · `types` · `typescript-config` · `utils`
|
||||
|
||||
## crypto
|
||||
|
||||
Cryptographic primitives, protocols, and credential tooling. Ciphers, curves, hashes, signing, key exchange, and the crypto vault layer.
|
||||
|
||||
**Existing:** `crypto` · `crypto-bin` · `crypto-browser` · `crypto-cipher` · `crypto-cli` · `crypto-core` · `crypto-curve` · `crypto-hash` · `crypto-rsa` · `crypto-sodium` · `crypto-utils` · `crypto-vault`
|
||||
|
||||
**Pending:** `api-plugin-vault` · `cryptocurrency` · `keys` · `react-crypto`
|
||||
|
||||
## data
|
||||
|
||||
Data manipulation and transformation: byte utilities, deduplication, diffing, JSON, MIME, packing, pagination, serialization, templates, and validation.
|
||||
|
||||
**Existing:** `bytes` · `data-masking` · `dedup` · `diff` · `json` · `mime` · `packer` · `pagination` · `serialize` · `templates` · `validation`
|
||||
|
||||
## database
|
||||
|
||||
Relational and NoSQL adapters, migration tooling, and seeding.
|
||||
|
||||
**Existing:** `db` · `db-sqlite` · `migration` · `surrealdb`
|
||||
|
||||
**Pending:** `seed`
|
||||
|
||||
## docs
|
||||
|
||||
Documents, sitemaps, PDF generation, and documentation site generators.
|
||||
|
||||
**Existing:** `compress-svg` · `sitemap`
|
||||
|
||||
**Pending:** `api-docs` · `docs` · `pdf` · `react-docs` · `react-pdf` · `react-rich-text`
|
||||
|
||||
## drive
|
||||
|
||||
Virtual filesystem, P2P mesh, transport layers, and sharing plugins.
|
||||
|
||||
**Existing:** `drive` · `drive-mesh` · `drive-mesh-protocol` · `drive-plugin-chunks` · `drive-react-sharing` · `drive-sharing` · `drive-template` · `drive-transport-https` · `drive-transport-webrtc` · `drive-webrtc`
|
||||
|
||||
## emails
|
||||
|
||||
Email delivery, templates, DMARC, and suppression lists.
|
||||
|
||||
**Existing:** `dmarc` · `domain-normalizer` · `suppression`
|
||||
|
||||
**Pending:** `email-processing` · `email-templates` · `emailer`
|
||||
|
||||
## events
|
||||
|
||||
Typed event bus, transport bridges, schema validation, OTel companions, and event sourcing.
|
||||
|
||||
**Existing:** `event-sourcing` · `events` · `events-metrics` · `events-otel` · `events-schema` · `events-transport`
|
||||
|
||||
**Pending:** `broadcast-channel` · `message-bridge`
|
||||
|
||||
## flow
|
||||
|
||||
Control flow, caching, queues, scheduling, rate limiting, retry, rules engines, and streams.
|
||||
|
||||
**Existing:** `cache` · `cbor` · `crdt` · `idempotency` · `job-scheduler` · `queue` · `queue-distribution` · `queue-distribution-http` · `queue-distribution-worker-thread` · `rate-limiter` · `retry` · `rules` · `rules-hono` · `streams` · `undo`
|
||||
|
||||
## fonts
|
||||
|
||||
Font compression, conversion, subsetting, decompression, and React font loading hooks.
|
||||
|
||||
**Existing:** `font-compress` · `font-convert` · `font-subset`
|
||||
|
||||
**Pending:** `font-decompress` · `react-font-decompress`
|
||||
|
||||
## forms
|
||||
|
||||
Form components, builders, wizards, file uploads, date pickers, and color pickers.
|
||||
|
||||
**Existing:** `react-forms`
|
||||
|
||||
**Pending:** `form-builder` · `react-admin-forms` · `react-calendar` · `react-color-picker` · `react-file-upload` · `react-wizard`
|
||||
|
||||
## games
|
||||
|
||||
Game engine systems, simulation, mechanics, AI, progression, and world building.
|
||||
|
||||
**Pending:** `animation-events` · `api-plugin-anticheat` · `api-plugin-game-persistence` · `api-plugin-game-server` · `api-plugin-matchmaking` · `behavior-tree` · `bone-mapping` · `building` · `character-physics` · `character-vehicle-picker` · `chat` · `combat` · `controller` · `crafting` · `day-night` · `destructibles` · `dialogue` · `economy` · `ecs` · `emotes` · `fauna` · `fruit-machine` · `game-loop` · `game-persistence` · `game-server` · `game-state-schemas` · `heightmap-tiles` · `hitbox` · `ik-solver` · `leaderboard` · `lobby` · `mixamo` · `npc` · `osm-buildings` · `party` · `progression` · `quest` · `react-controller` · `react-crafting` · `react-dialogue` · `react-game-hud` · `react-game-map` · `react-game-settings` · `react-social-game` · `vehicle-physics` · `weapons` · `weather`
|
||||
|
||||
## geo
|
||||
|
||||
Geospatial geometry, planetary models, Earth utilities, solar system, stars, and tides.
|
||||
|
||||
**Existing:** `geo` · `geo-earth` · `geo-planet` · `solar-system` · `stars` · `tides` · `universe`
|
||||
|
||||
## gtap
|
||||
|
||||
Global Trade Automation Platform integration. Import/export licenses, tariff classification, sanctioned-party screening, certificates of origin, PTA eligibility, and AEO status.
|
||||
|
||||
**Pending:** `api-plugin-gtap`
|
||||
|
||||
## i18n
|
||||
|
||||
Internationalization core, backends, detectors, formatters, locale data, and shared helpers.
|
||||
|
||||
**Existing:** `i18n` · `i18n-backend-chained` · `i18n-backend-fs-multifile` · `i18n-backend-http` · `i18n-backend-memory` · `i18n-backend-storage` · `i18n-detector` · `i18n-formatter-collator` · `i18n-formatter-currency` · `i18n-formatter-date` · `i18n-formatter-display-name` · `i18n-formatter-list` · `i18n-formatter-number` · `i18n-formatter-relative-time` · `i18n-formatter-segmenter` · `i18n-icu-parser` · `i18n-shared` · `locale-data` · `react-i18n`
|
||||
|
||||
## image
|
||||
|
||||
Image processing, compression, EXIF, metadata, quantisation, and sprite tools.
|
||||
|
||||
**Existing:** `compress-image` · `exif`
|
||||
|
||||
**Pending:** `caddy-imgproxy` · `emblem-solver` · `image` · `image-quantisation` · `react-image`
|
||||
|
||||
## logistics
|
||||
|
||||
Supply chain operations: shipments, carriers, ports, customs, delivery tracking, warehousing, and procurement.
|
||||
|
||||
**Pending:** `api-plugin-customs` · `api-plugin-logistics` · `api-plugin-port-tracking` · `api-plugin-procurement` · `api-plugin-warehouse-ops` · `customs` · `delivery-tracking` · `logistics` · `port-tracking` · `ports` · `procurement` · `react-port-tracking` · `warehouse-ops`
|
||||
|
||||
## messaging
|
||||
|
||||
SMS, chat bots, push notifications, and social messaging.
|
||||
|
||||
**Existing:** `elevenlabs`
|
||||
|
||||
**Pending:** `api-plugin-messaging` · `api-plugin-notifications` · `discord-client` · `imessage-adapter` · `react-notifications` · `slack-client` · `sms` · `sms-providers` · `telegram-client`
|
||||
|
||||
## monitor
|
||||
|
||||
Observability, audit logging, and structured logging.
|
||||
|
||||
**Existing:** `audit-logging` · `logger` · `opentelemetry`
|
||||
|
||||
## network
|
||||
|
||||
Mesh networking, transports, discovery strategies, peer registries, protocol plugins, gateways, and service discovery.
|
||||
|
||||
**Existing:** `network` · `network-bootstrap` · `network-discovery-crdt` · `network-discovery-gundb` · `network-discovery-hybrid` · `network-discovery-peerjs` · `network-discovery-trystero` · `network-discovery-webtorrent` · `network-gundb-server` · `network-libp2p-server` · `network-plugin-assignment` · `network-plugin-audit-mesh` · `network-plugin-auth` · `network-plugin-circuit-breaker` · `network-plugin-content-delivery` · `network-plugin-crypto-messages` · `network-plugin-devtools` · `network-plugin-failover` · `network-plugin-governance` · `network-plugin-intra-relay` · `network-plugin-middleware` · `network-plugin-migration` · `network-plugin-monitor` · `network-plugin-partition` · `network-plugin-protocol` · `network-plugin-qos` · `network-plugin-registry` · `network-plugin-relay` · `network-plugin-server-bridge` · `network-plugin-session` · `network-plugin-simulation` · `network-plugin-state` · `network-plugin-topology` · `network-plugin-transport-manager` · `network-testing` · `network-transport-hyperswarm` · `network-transport-libp2p` · `network-transport-standby` · `network-transport-webrtc` · `network-transport-websockets` · `network-trystero-server` · `react-network-libp2p-demo` · `service-discovery` · `websocket-gateway`
|
||||
|
||||
**Pending:** `network-observability` · `network-quality`
|
||||
|
||||
## platform
|
||||
|
||||
Backend platform services: caching, search, ETL, webhooks, audit, logging, observability, feature flags, rules, workflows, health checks, PWA, and operational security.
|
||||
|
||||
**Existing:** `etl` · `feature-flags` · `search` · `webhook-client`
|
||||
|
||||
**Pending:** `analytics-browser` · `audience-rules` · `campaigns` · `health-check` · `notification-channel` · `pwa`
|
||||
|
||||
## r3f
|
||||
|
||||
React Three Fiber rendering, physics, animation, audio, UI-in-3D, XR, and game-system visualisation layers.
|
||||
|
||||
**Existing:** `r3f-networking`
|
||||
|
||||
**Pending:** `r3f-animation` · `r3f-booking` · `r3f-building` · `r3f-buildings` · `r3f-camera` · `r3f-character` · `r3f-character-vehicle` · `r3f-character-vehicle-picker` · `r3f-combat` · `r3f-controller` · `r3f-earth` · `r3f-emulator` · `r3f-environment` · `r3f-lod` · `r3f-minimap` · `r3f-npc` · `r3f-number-plate` · `r3f-parallax` · `r3f-particles` · `r3f-pathfinding` · `r3f-performance` · `r3f-physics-cascade` · `r3f-physics-core` · `r3f-physics-rapier` · `r3f-shaders` · `r3f-terrain` · `r3f-ui` · `r3f-vegetation` · `r3f-vehicle` · `r3f-water` · `r3f-weather` · `r3f-world` · `r3f-xr`
|
||||
|
||||
## random
|
||||
|
||||
Randomness, noise functions, finite-state machines, and seeded PRNGs.
|
||||
|
||||
**Existing:** `fsm` · `noise` · `pseudo-random` · `random`
|
||||
|
||||
## react
|
||||
|
||||
General-purpose React components, hooks, and UI primitives that do not map to a more specific domain category.
|
||||
|
||||
**Existing:** `react-ui`
|
||||
|
||||
**Pending:** `react-campaigns` · `react-charts` · `react-command-palette` · `react-consent-overlay` · `react-data-table` · `react-dnd` · `react-error-boundary` · `react-hotkeys` · `react-infinite-scroll` · `react-iphone` · `react-kanban` · `react-loading` · `react-modal` · `react-skeleton` · `react-social` · `react-timeline` · `react-tour` · `react-tree-view` · `react-ui-social` · `react-virtual`
|
||||
|
||||
## security
|
||||
|
||||
Security tooling, password management, breach checking, signing formats, certificates, and vaults.
|
||||
|
||||
**Existing:** `hibp` · `jws` · `otp` · `password-formats` · `password-generator` · `password-strength` · `security-codes` · `slsa` · `srp` · `tpm-struct` · `vault` · `vault-sync` · `x509`
|
||||
|
||||
## storage
|
||||
|
||||
Key-value and file-system storage abstractions.
|
||||
|
||||
**Existing:** `storage` · `storage-browser-indexeddb` · `storage-browser-localstorage` · `storage-browser-opfs` · `storage-file` · `storage-s3`
|
||||
|
||||
**Pending:** `cache-browser` · `cache-memory` · `cache-redis`
|
||||
|
||||
## store
|
||||
|
||||
E-commerce, inventory, subscriptions, and virtual currency.
|
||||
|
||||
**Pending:** `api-plugin-inventory` · `api-plugin-store` · `api-plugin-subscription` · `api-plugin-virtual-currency` · `r3f-inventory` · `react-store` · `store` · `subscription` · `virtual-currency`
|
||||
|
||||
## testing
|
||||
|
||||
Test runners, DOM utilities, E2E helpers, integration fixtures, and Storybook test utils.
|
||||
|
||||
**Existing:** `ab-testing` · `testing` · `testing-dom` · `testing-e2e` · `testing-integration` · `testing-integration-garage-s3` · `testing-integration-mailpit` · `testing-integration-postgres` · `testing-integration-redis` · `testing-integration-step-ca` · `testing-integration-surrealdb` · `testing-integration-typesense`
|
||||
|
||||
## timing
|
||||
|
||||
Time utilities, cron expressions, and scheduling primitives.
|
||||
|
||||
**Existing:** `cron` · `datetime` · `timing`
|
||||
|
||||
## tooling
|
||||
|
||||
CLI frameworks, developer tools, installers, and agent skills.
|
||||
|
||||
**Existing:** `cli` · `install-agent-skills` · `installer` · `readline`
|
||||
|
||||
**Pending:** `electrobun` · `license` · `linter` · `overview` · `profiler` · `sandbox` · `server-keys` · `test-vite` · `wip`
|
||||
|
||||
## vatdash
|
||||
|
||||
VAT return preparation, transaction tagging, rate lookups, and digital tax reporting.
|
||||
|
||||
**Pending:** `api-plugin-vatdash-bridge`
|
||||
|
||||
## video
|
||||
|
||||
Video metadata, thumbnails, and format handling.
|
||||
|
||||
**Pending:** `react-video` · `video` · `video-thumbnails`
|
||||
Reference in New Issue
Block a user