@wicklib/pro 0.0.0-stage → 0.11.0

package/LICENSE

@@ -0,0 +1,93 @@
+WICKLIB COMMERCIAL LICENSE AGREEMENT
+
+Version 1.0 — Phase 1 template. Have legal counsel review before selling.
+
+This Commercial License Agreement ("Agreement") governs use of the Wicklib Pro
+software and associated documentation ("Software") made available by the Licensor.
+By installing, copying, or using the Software, the Licensee agrees to this Agreement.
+
+1. DEFINITIONS
+
+"Licensor" means the owner and publisher of Wicklib.
+"Licensee" means the individual or legal entity that has purchased a license.
+"Order Form" means the quotation, invoice, or online checkout that specifies the
+plan, seats, domains, term, and fees.
+"License Key" means the signed token issued by the Licensor that activates the
+Software for the licensed scope.
+"Application" means a software product owned and operated by the Licensee.
+
+2. GRANT OF LICENSE
+
+Subject to payment of the applicable fees and compliance with this Agreement, the
+Licensor grants the Licensee a non-exclusive, non-transferable, non-sublicensable,
+worldwide license to install and use the Software solely to build and operate the
+number of Applications permitted by the Order Form, for the number of seats and
+domains stated there.
+
+3. LICENSE KEYS
+
+3.1 The Licensee must not circumvent, disable, or alter the license verification
+mechanism.
+3.2 The Licensee must not publish, share, or resell License Keys.
+3.3 The Licensee is responsible for keeping License Keys confidential.
+3.4 A License Key may be validated offline. The Software does not require the
+transmission of usage data to function.
+
+4. RESTRICTIONS
+
+The Licensee must not:
+(a) redistribute, sublicense, sell, lease, or otherwise make the Software available
+    to third parties, except as embedded in a permitted Application;
+(b) use the Software to build a competing charting library or charting software
+    development kit;
+(c) remove or obscure copyright, license, or attribution notices;
+(d) reverse engineer the Software except to the extent permitted by applicable law;
+(e) use the Software after termination of this Agreement.
+
+5. OWNERSHIP
+
+The Software is licensed, not sold. The Licensor retains all right, title, and
+interest in the Software, including all intellectual property rights. No rights are
+granted except as expressly stated in this Agreement.
+
+6. SUPPORT AND UPDATES
+
+Support and updates are provided only if and to the extent stated in the Order Form.
+The Licensor may publish new versions and may stop supporting older versions after a
+documented deprecation period.
+
+7. FEES AND TERM
+
+Fees, term, and renewal terms are stated in the Order Form. Licenses are valid until
+the expiration date encoded in the License Key unless terminated earlier.
+
+8. TERMINATION
+
+This Agreement terminates automatically if the Licensee materially breaches it and
+fails to cure the breach within thirty (30) days of notice. On termination, the
+Licensee must stop using the Software and remove all copies. Sections 4, 5, 9, 10,
+and 11 survive termination.
+
+9. WARRANTY DISCLAIMER
+
+THE SOFTWARE IS PROVIDED "AS IS" AND "AS AVAILABLE", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE, TITLE, AND NON-INFRINGEMENT. THE LICENSOR DOES NOT WARRANT THAT THE SOFTWARE
+WILL BE ERROR-FREE OR UNINTERRUPTED.
+
+10. LIMITATION OF LIABILITY
+
+TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE LICENSOR'S TOTAL LIABILITY UNDER THIS
+AGREEMENT WILL NOT EXCEED THE FEES PAID BY THE LICENSEE IN THE TWELVE (12) MONTHS
+PRECEDING THE CLAIM. THE LICENSOR IS NOT LIABLE FOR INDIRECT, INCIDENTAL, SPECIAL,
+CONSEQUENTIAL, OR PUNITIVE DAMAGES, OR FOR LOSS OF PROFITS, DATA, OR BUSINESS.
+
+11. GOVERNING LAW
+
+This Agreement is governed by the laws of [JURISDICTION], without regard to conflict
+of law rules. The parties submit to the exclusive jurisdiction of the courts of
+[JURISDICTION].
+
+12. CONTACT
+
+Licensing enquiries: licensing@wicklib.com

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# @wicklib/pro
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Wicklib's commercial add-on. Requires a valid license key at runtime.
+
+**Status: Phase 3 — analytics.** Licensing and registration are complete. License-gated
+volume-profile calculation/rendering, trade-tick footprint aggregation/streaming, L2 depth
+aggregation, absorption detection, price-alert evaluation, strategy backtesting, and
+script-to-strategy adaptation are implemented.
+
+The package consumes `@wicklib/core` through its published entrypoint only. The
+`exports` map blocks deep imports, and CI fails if any appear.
+
+## Volume profile
+
+`computeVolumeProfile(context, bars, options)` requires the `volume-profile` feature and
+returns price bins, point of control, and value area. It supports uniform or close-based
+volume distribution and fixed/automatic price ranges.
+
+`addVolumeProfileOverlay(context, chart, bars, options)` computes the profile and registers
+a clipped core overlay. The overlay draws the histogram on the extension layer, below
+drawings and crosshair.
+
+`computeFootprint(context, trades, options)` aggregates buy/sell trade ticks into time and
+price buckets with per-level delta and imbalance detection.
+
+`FootprintAggregator` performs the same aggregation incrementally. It enforces non-decreasing
+trade times, updates the active bucket, and supports batch replay or live streaming through
+one state path.
+
+`computeDepth()` and `DepthAggregator` aggregate complete L2 bid/ask snapshots by price
+bucket, with totals, delta, book imbalance, latest-snapshot lookup, and streaming order
+validation.
+
+`detectAbsorption()` compares aggressive footprint volume against passive depth at the same
+price level. It reports buys absorbed by ask liquidity and sells absorbed by bid liquidity
+using a configurable aggression-to-depth ratio.
+
+`AlertEngine` and `evaluateAlerts()` provide offline, deterministic price alerts on closed
+bars. Rules trigger on transitions and support close/high/low sources.
+
+## License
+
+Proprietary. See [LICENSE](../../LICENSE).
+
+`runBacktest()` evaluates a target-position strategy against closed bars. Signals are filled
+at the next bar open, with configurable fees and slippage, fully invested sizing, equity
+marking, and max drawdown. Requires the `strategy` license feature.
+
+`runScriptBacktest()` adapts a compiled WickScript replay to the strategy engine. Configure a
+signal plot whose values are `-1`, `0`, `1`, or `null`, and receive the backtest plus the
+script's bar-bound alerts. It accepts the compiled script structurally, so Pro has no runtime
+dependency on `@wicklib/script`.