@plasius/economy 0.1.0

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2025 Plasius LTD
+
+                                 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

@@ -0,0 +1,181 @@
+# `@plasius/economy`
+
+Provider-neutral TypeScript contracts and deterministic invariants for the
+Plasius sitewide Token economy.
+
+This package models exact TokenSubunit amounts, immutable double-entry journal
+transactions, source lots, family gameplay reservations, early-backer basis,
+future spend requests, acquisition contracts, projections, and persistence
+ports. It intentionally contains no HTTP, authentication, provider SDK,
+database driver, secret, or Azure implementation.
+
+## Product boundary
+
+- 1 public Token = 1,000 TokenSubunits.
+- The nominal product reference is 1 Token = £0.10; it is not a redemption,
+  transfer, investment, or cash-equivalence promise.
+- Amounts use `bigint` internally and canonical base-10 strings in contracts.
+- Tokens have no cash-redemption value and do not replace PP, ESP, TIS, or DIS.
+- Gameplay conversion, spending, and subscriptions are policy decisions owned
+  by consuming services and are disabled in the baseline product.
+
+## Requirements
+
+- Node.js 24 or later
+- TypeScript with NodeNext-compatible module resolution
+
+## Install
+
+```bash
+npm install @plasius/economy
+```
+
+## Exact amounts
+
+```ts
+import {
+  parseTokenSubunits,
+  serializeTokenSubunits,
+  wholeTokensToSubunits,
+} from "@plasius/economy";
+
+const packGrant = wholeTokensToSubunits(50n);
+const wireAmount = serializeTokenSubunits(packGrant); // "50000"
+const restored = parseTokenSubunits(wireAmount); // 50000n
+```
+
+Non-canonical values such as `"01"`, decimals, exponent notation, and values
+outside signed PostgreSQL `bigint` range are rejected.
+
+## Baseline GBP catalog
+
+`BASELINE_GBP_REFERENCE_RATE` is versioned product-copy metadata with
+`cashRedemptionAllowed: false`. `assertFlatTokenCatalog()` proves that a catalog
+uses the declared flat nominal ratio. The initial immutable catalog facts are:
+
+| Pack ID | Price | Grant |
+|---|---:|---:|
+| `gbp_5_50_v1` | £5 | 50 Tokens |
+| `gbp_10_100_v1` | £10 | 100 Tokens |
+| `gbp_25_250_v1` | £25 | 250 Tokens |
+| `gbp_50_500_v1` | £50 | 500 Tokens |
+
+The default server ceilings are £50 per order and £100 per payer and household
+over 30 days. A consuming service may apply a lower household control but must
+not raise these defaults without a separately versioned policy decision.
+
+## Balanced journal transactions
+
+```ts
+import {
+  assertBalancedTransaction,
+  canonicalTransactionPayload,
+  serializeTokenSubunits,
+  type LedgerTransactionV1,
+} from "@plasius/economy";
+
+const transaction: LedgerTransactionV1 = {
+  schemaVersion: "1",
+  transactionId: "txn:purchase:1",
+  activityType: "purchase",
+  status: "settled",
+  idempotencyKey: "intent:1:paid",
+  effectiveAt: "2026-07-15T10:00:00.000Z",
+  recordedAt: "2026-07-15T10:00:01.000Z",
+  metadata: { catalogVersion: "gbp-v1" },
+  postings: [
+    {
+      schemaVersion: "1",
+      postingId: "post:1",
+      transactionId: "txn:purchase:1",
+      accountId: "account:purchase-clearing",
+      amount: serializeTokenSubunits(-50_000n),
+    },
+    {
+      schemaVersion: "1",
+      postingId: "post:2",
+      transactionId: "txn:purchase:1",
+      accountId: "account:household-treasury",
+      lotId: "lot:shopify:1",
+      amount: serializeTokenSubunits(50_000n),
+    },
+  ],
+};
+
+assertBalancedTransaction(transaction);
+const payloadForApprovedHashAdapter = canonicalTransactionPayload(transaction);
+```
+
+The package produces canonical bytes but deliberately leaves SHA-256/HSM
+signing to an approved infrastructure adapter.
+
+## Source-lot policy and allocations
+
+`selectSourceLots()` selects spendable slices in credited-time/lot-ID order and
+enforces `household-allocatable`, `same-user-only`, and `non-transferable`
+policies. `createGameplayAllocation()`, `boostGameplayAllocation()`, and
+`reclaimGameplayAllocation()` require exact whole Tokens and return new
+immutable states.
+
+Selection is only a deterministic proposal. The persistence adapter must lock
+the source rows, revalidate them, append the balanced transaction, update the
+projection, save idempotency evidence, and append the outbox event within one
+serializable database transaction.
+
+## Early backers
+
+`evaluateEarlyBacker()` calculates provisional `pre_utility_backer_v1` status
+from net retained paid lots. It uses an inclusive public launch and exclusive
+first-public-spend cutoff. It does not express or promise a reward entitlement.
+
+## Acquisition and future contracts
+
+Purchase intents bind payer, receiving household/wallet, pack, catalog,
+expected GBP price, grant, and an expiry. `assertOpenPurchaseIntent()` is for
+checkout creation; a late provider webhook must instead be reconciled against
+the immutable purchase facts and provider purchase time.
+
+Reward conversion contracts retain signed provider-event IDs, server rate/FX
+versions, exact payout values, and beneficiary/wallet IDs. ayeT and BitLabs lots
+are structurally restricted to `same-user-only`; changing a provider-earned lot
+to household-allocatable is rejected.
+
+`BASELINE_MONTHLY_SUBSCRIPTION_PLAN` preserves the provider-neutral future £10
+monthly/100 Token shape with `enabled: false`. Spend-request contracts likewise
+exist for future use but this package does not enable their creation.
+
+## Persistence ports
+
+Implement `EconomyPersistencePort` in the authoritative service. Runtime roles
+should execute approved posting procedures but must not update or delete journal
+rows directly. The adapter is responsible for:
+
+- serializable row locking and optimistic versions;
+- unique transaction, idempotency, and provider-event constraints;
+- same-transaction projection and source-lot updates;
+- transactional outbox append;
+- managed identity and least-privilege database access; and
+- immutable audit/integrity evidence outside this package.
+
+## Development
+
+```bash
+npm ci
+npm run lint
+npm run typecheck
+npm run build
+npm run test:coverage
+npm run pack:check
+```
+
+Coverage must remain at least 80%, and every changed source file must appear in
+LCOV. Generated property tests cover exact arithmetic, double-entry balance,
+projection rebuilds, idempotency, reversals, lot isolation, and allocation
+non-negativity. npm publication is performed only by the approved GitHub CD
+workflow.
+
+## Security
+
+Do not include raw payment details, personal data, provider callback bodies, or
+secrets in contracts, metadata, tests, examples, or logs. Report vulnerabilities
+privately according to [SECURITY.md](./SECURITY.md).