@krizaka/coupons 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,64 @@
-# Temporary Holding Version
+# @krizaka/coupons
 
-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.
+**Discount and credit coupons the admin manages**, for every Krizaka product (decision: [ADR-002](../../docs/adr/ADR-002-coupons.md), design: [coupons.md](../../docs/design/coupons.md)). The product's database is the source of truth; the payment provider applies a discount from immutable terms this module hands it; a credit coupon grants capped credits in `@krizaka/credits`. It evolves what exists: it does not start a second billing system.
+
+> **A free offer is always a capped credit coupon, never a 100 % discount.** A discount stops at 99.99 % and at the admin's `coupons.maxPercentOff`; a fixed amount never runs forever and never exceeds that share of the price; a credit coupon always carries credits, an expiry and what happens when they run out.
+
+Two kinds, one code (letters and digits, read without case, spaces or hyphens: « summer-2026 » is `SUMMER2026`):
+
+- **Discount**: a percentage (basis points) or a fixed amount with its currency, a duration (`once`, `repeating` N months, `forever`), a plan scope and a minimum. Applied at checkout.
+- **Credit**: `credits` granted, optional `capPerDay` / `capPerMonth`, `creditsValidDays`, `onExhausted` (`stop` or `fallback_paid`). Redeemed where the product redeems credits.
+
+Both: `startsAt` / `endsAt`, `maxRedemptions` overall and `maxPerAccount`, `newCustomersOnly`, a purpose (`partner`, `promo`, `demo`, `support`) and, for a partner, the partner who sells with it.
+
+```ts
+import { createCoupons } from "@krizaka/coupons";
+import { readCouponSettings } from "@krizaka/coupons/settings";
+
+const coupons = createCoupons({ clock, settings: () => readCouponSettings((key) => settings.get(key)), audit, rateLimit: limiter, credits, outbox });
+
+// 1. the person types the code in « Code promo » (read-only; counts one attempt on the limiter, before any lookup)
+const v = await coupons.validate(query, typed, { mode: "checkout", accountId, plan: "pro", amountMinor: 3900, currency: "cad", hasPaidBefore });
+//    v = { ok: true, effect: { discountMinor, payableMinor, … } }  or  { ok: false, code: "COUPON_EXPIRED" }
+
+// 2. « Pay »: three steps, NO network call inside a transaction or under the coupon's row lock
+const applied = await transaction(connect, (tx) => coupons.apply(tx, { code: typed, accountId, plan: "pro", amountMinor: 3900, currency: "cad", idempotencyKey: attemptId })); // reserves a use
+const session = await payments.checkout({ …, discount: applied.discount, idempotencyKey: applied.redemptionId, metadata: { redemption_id: applied.redemptionId }, expiresAt }); // @krizaka/payments
+await transaction(connect, (tx) => coupons.attachCheckout(tx, applied.redemptionId, session.checkoutRef, session.expiresAt));
+//    if the session fails: coupons.release(tx, { redemptionId })
+
+// 3. the payment webhook, in the event's transaction (applyOnceInTransaction of @krizaka/payments)
+payment_paid:     (e, tx) => coupons.redeem(tx, { redemptionId: e.metadata.redemption_id, checkoutRef: e.checkoutRef, paymentRef: e.paymentRef ?? e.invoiceRef, amountPaidMinor: e.amountTotal, amountDiscountMinor: e.amountDiscount, currency: e.currency })
+checkout_expired: (e, tx) => coupons.release(tx, { checkoutRef: e.checkoutRef })
+payment_refunded: (e, tx) => coupons.refund(tx, { paymentRef: e.paymentRef, invoiceRef: e.invoiceRef, amountRefunded: e.amountRefunded })
+
+// a credit code: the same rules, then a capped grant in the same transaction
+await transaction(connect, (tx) => coupons.redeemCredit(tx, { code: typed, accountId, idempotencyKey: attemptId }));
+```
+
+## The rules
+
+- **A use is counted by one rule**: a redemption is a use when it is `confirmed` or `revoked` and not `use_restored`, or `reserved` and not past its deadline. A `released` one never counts. The overall and the per-account limits both apply it. « Expired », « exhausted » and « not started » are computed, so no cron is needed.
+- **Reserve, confirm, release.** `apply` locks the coupon row (`SELECT … FOR UPDATE`), re-checks everything, inserts a `reserved` redemption with a deadline (`coupons.reservationMinutes`) and commits: two requests for the last use give it to one (tested on PostgreSQL, 50 rounds). `redeem` runs in the payment event's transaction; its guarded transition (`UPDATE … WHERE status IN ('reserved', 'released')`) and the unique `payment_ref` mean a use is confirmed once whatever the number of deliveries. The webhook finds the reservation by `metadata.redemption_id` even if `attachCheckout` never ran.
+- **A late payment is honoured.** A payment for a released or lapsed reservation is confirmed anyway and flagged `over_limit`: the customer paid the discounted price in good faith. It is audited and shown in the admin.
+- **Refunds** add up (the amount is cumulative) and never change the status. A partial refund keeps the use; a full one gives it back only when `coupons.refundRestoresUse` is on (default off), so a refund cannot reset a single-use code.
+- **Terms are immutable once anyone has used the coupon** (`COUPON_TERMS_LOCKED`): the provider's object is made from them, per `termsVersion`. Dates, limits, plans, status and partner stay editable. When a plan's price changes, `admin.checkPrices(prices)` pauses the fixed-amount coupons that would now exceed the bound.
+- **Taxes are the provider's.** The terms go to `@krizaka/payments`, whose adapter sends the discount together with `automatic_tax`: Stripe Tax computes GST and QST on the discounted amount. The numbers in `effect` are informational. No tax is written here.
+- **Abuse.** `validate`, `apply` and `redeemCredit` each count one attempt on the limiter (`COUPON_ATTEMPT_ACTION`, limits `coupons.attemptsPerAccountPerHour` / `attemptsPerIpPerHour`) before any lookup; past the limit they answer `COUPON_RATE_LIMITED` with `retryAfterSeconds`.
+- **Refusals** are typed (`COUPON_CODE`): `UNKNOWN`, `NOT_STARTED`, `EXPIRED`, `PAUSED`, `EXHAUSTED`, `ACCOUNT_LIMIT`, `NEW_CUSTOMERS_ONLY`, `NOT_FOR_PLAN`, `MINIMUM`, `CURRENCY`, `TOO_LARGE`, `KIND`, `PROVIDER`, `RATE_LIMITED`, `DISABLED`. `CouponError` carries the code and the HTTP `status` (404, 422, 429…).
+
+## Partners (Loi 25)
+
+A partner is a person who sells for us: a display name and an optional e-mail, for one purpose (attributing sales), visible to the admin only. `admin.partners.report` gives, per coupon and currency, the redemptions, the discount given, the revenue (paid minus refunded) and the credits granted, never a customer's identity; every read is audited. `export` returns the record and its aggregates; `erase` blanks the name and the e-mail and keeps the aggregates (the redemptions are accounting records). **Commission is out of scope**: the hook is `evt.coupon.redeemed.v1`, which carries `partnerId`, the amounts and the credits, for a later module to consume from the outbox.
+
+## What you provide, what it gives
+
+- **Dependencies** are structural ports, so this package imports none of them: `audit` (`createAudit` of `@krizaka/audit`), `rateLimit` (`createLimiter` of `@krizaka/rate-limit`), `credits` (`createCredits` of `@krizaka/credits`), `outbox` (`createOutbox` of `@krizaka/outbox`).
+- **Events** through the outbox, in the caller's transaction, ids derived from the fact: `evt.coupon.redeemed.v1`, `evt.coupon.released.v1`, `evt.coupon.refunded.v1`, `evt.coupon.exhausted.v1`, with a JSON Schema each (`COUPON_EVENT_SCHEMAS`).
+- **Settings** (`@krizaka/coupons/settings`, every change audited by the settings service): `coupons.enabled` (off), `reservationMinutes` (60, 40–1440: the provider's session window), `attemptsPerAccountPerHour` (10), `attemptsPerIpPerHour` (30), `minCodeLength` (8), `generatedCodeLength` (10), `maxPercentOff` (50, 1–99: **the default is Oussama's call**, krizaka-ts#61), `refundRestoresUse` (off). `credits.timeZone` is `@krizaka/credits`'. Nothing new in the environment: the provider keys stay `PAYMENTS_*`.
+- **Tables** (`couponsSchema`, Postgres schema `coupons`): `partner`, `coupon`, `redemption`, with CHECKs that repeat the rules (a free discount cannot be stored). A deleted account leaves its redemptions (`ON DELETE SET NULL`).
+- `couponsContract` (`@krizaka/coupons/testkit`) is the contract every store runs; `memoryCouponStore()` is for unit tests (it locks nothing: concurrency is proved on PostgreSQL).
+
+## Going live
+
+The code runs against the provider's test mode only. Turning coupons on in live mode, product by product, is the owner's call (krizaka-ts#61), and so are the retention of the redemption records and the tax status of free credits (krizaka-ts#62, for the accountant): nothing here assumes either.