@percayso/identity-contracts 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

@@ -0,0 +1,108 @@
+# `@percayso/identity-contracts`
+
+The published vocabulary of **Percayso ID**: identifiers, closed lifecycle states, the
+closed refusal union, the evidence vocabulary, and a thin read-only client.
+
+Wire types and decoders only. There is no server, no policy engine and no verifier
+here — this package describes what crosses the wire, and nothing that decides.
+
+> **`0.x`, and it means it.** The shape may change between minor versions while the
+> API it describes is still being built. Pin the exact version.
+
+## What is in it
+
+| Module         | What it publishes                                                                                                                                                                    |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ids`          | Branded identifiers — Citizen ID, Application, Verification Case, Deployment, Piper Platform subject, Handle (canonical and display), Community email address, correlation reference |
+| `application`  | Application states and the transitions permitted between them                                                                                                                        |
+| `citizen`      | Citizen status, the Citizen record, a Citizen's names, and the `Personhood` union                                                                                                    |
+| `evidence`     | Evidence facts, the outcome union, and the rule that a verification method never claims more than its facts support                                                                  |
+| `provisioning` | Provisioning-coordination states and Cayso's confirmation                                                                                                                            |
+| `refusal`      | The closed refusal union, whether a refusal is appealable, and `ContractResult`                                                                                                      |
+| `assertion`    | The operations, the scope, the request an issuer is asked for, and the issuance record                                                                                               |
+| `client`       | Five reads over the routes above, at `@percayso/identity-contracts/client`                                                                                                           |
+
+```ts
+import {
+  parseCitizenId,
+  type ContractResult,
+  type Personhood,
+} from "@percayso/identity-contracts";
+import { createIdentityClient } from "@percayso/identity-contracts/client";
+```
+
+Every invariant here is enforced **twice**: once as a shape that cannot be expressed,
+and once as a value a decoder refuses. A type cannot police JSON that arrived from a
+caller nobody controls, and a decoder cannot stop a programmer writing the wrong
+identifier into the right field.
+
+## The dependency shape, and why
+
+Assertion, assurance and operation types are **imported from `@cayso/contracts`**,
+never restated — and this package has **no runtime dependencies**. Those two
+requirements pull in opposite directions, so the resolution is written down rather
+than left to whoever reads the manifest.
+
+`@cayso/contracts` is declared as a **`peerDependency` and a `devDependency`**, both
+pinned exactly to `0.6.1`. It is **never** a `dependency`.
+
+- **Why not `dependencies`.** That would make it a runtime dependency — installed
+  transitively, resolvable to a second copy, and present in the dependency tree of
+  every consumer that only wanted a type.
+- **Why not `devDependencies` alone.** Every Cayso type this package re-exposes
+  appears in its published `.d.ts` files. A consumer without `@cayso/contracts`
+  installed would get a typecheck failure at a name they never wrote. A peer
+  declaration says so at install time, where it will be read.
+- **Why also `devDependencies`.** A peer range is not installed for this package's own
+  build and test run.
+- **Why exact.** A range on a contract package is a contract that changes without a
+  version bump.
+
+**Nothing is imported in value position.** Every `@cayso/contracts` import is
+`import type`, and the packaging suite unpacks the real `npm pack` tarball and asserts
+that no emitted `.js` module imports or requires it. Install this package with no peer
+present and the JavaScript still runs; only the types go missing, which is exactly
+what a peer declaration promises.
+
+The cost is that a handful of Cayso runtime values are written out by hand — the
+verification methods, the contract operations, the evidence-to-method rule. Each is
+pinned to the sibling's by a test, in both directions, so a value added upstream fails
+this package's test run rather than passing through it silently.
+
+## Licensing
+
+This package is **Apache-2.0** and carries its own `LICENSE`.
+
+**The grant covers this package's own files and nothing else.** It is not a licence to
+the repository this package is built from, which is private and separately licensed.
+Read it as covering what is in this tarball, because that is what it covers.
+
+## What it deliberately does not contain
+
+- **No server, no policy engine, no verifier.** Wire types, closed unions and a thin
+  client. A verifier here would be a second implementation of a rule that belongs to
+  the service that owns it.
+- **No write methods.** The client reads. A method posting to a route nobody serves
+  yet would look like a commitment.
+- **No figures.** No Handle length bound, no assertion lifetime ceiling, no rate-limit
+  limit, no grant amount. The assertion decoder refuses an expiry that is not after
+  issuance and says nothing about how much after.
+- **No authenticator policy.** No authenticator type, no "onboarding complete"
+  predicate, and no field that would carry one — so nothing here can declare onboarding
+  complete, and no fixture works by assuming a rule that has not been set.
+- **No evidence-supplier vocabulary.** `EvidenceRoute` and `EvidencePolicyVersion` are
+  opaque versioned identifiers rather than closed unions, so no supplier's selection
+  identifier is shipped into every consumer.
+- **No password, anywhere.** No password field, no reset path, no email-and-password
+  fallback — not behind a flag and not in a fixture. A test asserts that no published
+  name could hold one and that a closed record refuses one on the wire.
+- **No rate-limit policy.** This package is the caller's side of a conversation. The
+  service that exposes these routes declares its own limits.
+
+## Publishing
+
+Published manually, never on merge, and dry run by default.
+
+---
+
+Percayso Communities Limited

package/dist/application.d.ts

@@ -0,0 +1,156 @@
+/**
+ * The Application: its closed lifecycle, its transitions, and the one state that
+ * creates a Citizen.
+ *
+ * §5.2 is the canon here, and it says three things this file has to make true rather
+ * than merely describe. "The Application and the Citizen are different records." "An
+ * Applicant must exist before a Citizen can, and **approval is the only transition
+ * that creates one**." "A retry creates a **new** Application linked to its
+ * predecessor. Evidence and decision history are never rewritten."
+ *
+ * ENFORCED TWICE, IN BOTH DIRECTIONS.
+ *
+ * The lifecycle is a closed union, so no state outside §5.2's diagram can be
+ * written; and `parseApplicationState` refuses any string outside the same list, so
+ * no state outside §5.2's diagram can arrive. §15 singles out one of those in
+ * particular — `applications` must not hold "a generic `pending` state" — and
+ * because `pending` is the state a reader most expects to find, `contract.test.ts`
+ * names it directly on both sides: it is not assignable, and it is refused.
+ *
+ * `ApprovedApplication` is the other half. It is a separate type whose `state` is
+ * the literal `"approved"` rather than an `ApplicationState`, which makes it
+ * unforgeable by widening: a `draft` Application is not assignable to it, so a
+ * function that creates a Citizen can ask for one and get §14.4's "No route, script,
+ * production fixture or flag creates a Citizen outside an Application" from the
+ * compiler. `parseApprovedApplication` is the runtime twin, and refuses every other
+ * state by name.
+ *
+ * WHAT THIS FILE DELIBERATELY DOES NOT CARRY.
+ *
+ * No transition performs anything. This package publishes the vocabulary, and the
+ * approval transaction belongs to the service — the one that commits the
+ * Application, Citizen, profile, Handle, email assignment, authenticators,
+ * provenance, document signal and coordination row together or not at all.
+ * `isApplicationTransitionPermitted` answers a question
+ * about the diagram; it does not move anything, and a consumer that treats a `true`
+ * from it as authority to transition has skipped the transaction §15 requires.
+ *
+ * No timers, no expiry figures. `draft --> expired` is in the diagram; how long a
+ * draft lives is not, and a figure invented here would become the one every
+ * consumer inherited.
+ */
+import type { Millis } from "@cayso/contracts";
+import { type ApplicationId, type CorrelationReference, type VerificationCaseId } from "./ids.js";
+/**
+ * The Application lifecycle of §5.2, one member per node in its state diagram.
+ *
+ * There is no `pending`, and its absence is the point: §15 forbids `applications` a
+ * generic `pending` state, because "pending" collapses "nobody has submitted this
+ * yet", "a machine is looking at it" and "a Reviewer is looking at it" into one word
+ * that no Citizen-facing status text can honestly expand.
+ */
+export type ApplicationState = "draft" | "submitted" | "automated_review" | "manual_review" | "approved" | "rejected" | "under_appeal" | "cancelled" | "expired";
+/** Every Application state, in §5.2's order. A test that must cover them all reads this. */
+export declare const APPLICATION_STATES: readonly ApplicationState[];
+/**
+ * §5.2's diagram, transcribed edge for edge — and no edge that is not drawn there.
+ *
+ * The omissions carry the weight. `approved` has no outgoing edge, so an approved
+ * Application cannot be reopened, re-reviewed or quietly returned to `draft` to be
+ * decided again; whatever happens to the person afterwards happens to their Citizen
+ * record, under §5.3, and not by rewriting the decision that created it. `cancelled`
+ * and `expired` have none either: §5.2 gives a retry "a **new** Application linked
+ * to its predecessor", so the route out of a dead Application is a successor record
+ * and never a resurrection of this one. `rejected --> under_appeal` is the single
+ * exception, because an appeal is §8.6's designed route rather than a re-run.
+ */
+export declare const APPLICATION_TRANSITIONS: Readonly<Record<ApplicationState, readonly ApplicationState[]>>;
+/**
+ * Whether §5.2 draws this edge.
+ *
+ * A state with no outgoing edge is terminal for THIS Application, which is not the
+ * same as terminal for the person: `isRetryable` says which terminal states §5.2
+ * permits a successor from.
+ */
+export declare const isApplicationTransitionPermitted: (from: ApplicationState, to: ApplicationState) => boolean;
+/** Whether §5.2 draws no edge out of this state. */
+export declare const isTerminalApplicationState: (state: ApplicationState) => boolean;
+/**
+ * Whether a person whose Application reached this state may hold a successor one.
+ *
+ * `approved` is excluded, and that exclusion is CONTEXT.md's "One human, one
+ * Citizen" seen from the Application side: a successor to an approved Application
+ * would be a second road to a second Citizen record for the same human. §5.1's
+ * "Rejected, cancelled and expired people remain associated with their Application"
+ * names the other three exactly.
+ */
+export declare const isRetryable: (state: ApplicationState) => boolean;
+/** A state name from a wire value, or a refusal. */
+export declare const parseApplicationState: (value: unknown, field?: string) => ApplicationState;
+/**
+ * What a caller may be told about an Application.
+ *
+ * Every field is here because §15's `applications` row lists it: the closed
+ * lifecycle, "predecessor link for retries", "continuation state and expiry", and
+ * the "opaque local-subject correlation". Its "must not hold" column is enforced by
+ * what is absent — there is no legal-identity field, no name, no document number and
+ * no evidence, so a browser-visible Application view has nowhere to put one, and
+ * `readClosedRecord` refuses a caller that invents somewhere.
+ *
+ * There is no `citizenId`, and that absence is §5.1's "They do not become Citizens,
+ * and they are not partial ones" in the type system. An Applicant with a Citizen ID
+ * field that happens to be null is a partial Citizen; an Applicant with no such
+ * field cannot be mistaken for one, and no consumer can read one out of an
+ * Application "just in case it is approved". The approved Application is a witness
+ * that a Citizen may be created (`ApprovedApplication`), never a Citizen record.
+ */
+export interface ApplicationSummary {
+    readonly applicationId: ApplicationId;
+    readonly state: ApplicationState;
+    /**
+     * The Application this one retries, or `null` for a first attempt. §5.2: a retry
+     * is a new record linked to its predecessor, so the link points backwards and the
+     * predecessor is never edited.
+     */
+    readonly predecessorApplicationId: ApplicationId | null;
+    /**
+     * The opaque correlation reference of §15, or `null`. It correlates this
+     * Application with the local Piper Platform surface that started it. It is not a
+     * Piper Platform subject, is never an assertion subject, and carries no authority
+     * — which is why it is a `CorrelationReference` and not either identifier type.
+     */
+    readonly correlationReference: CorrelationReference | null;
+    /** When continuation stops being possible, if this state has such a moment. */
+    readonly expiresAt: Millis | null;
+}
+/** An `ApplicationSummary` from a wire value, or a refusal. */
+export declare const parseApplicationSummary: (value: unknown, field?: string) => ApplicationSummary;
+/**
+ * An Application that reached `approved`, and the only thing that permits a Citizen
+ * record to exist.
+ *
+ * `state` is the literal `"approved"` rather than an `ApplicationState`. That single
+ * difference is what makes the type unforgeable by widening: a value typed as
+ * `ApplicationSummary` is not assignable here even when its state happens to be
+ * approved at runtime, so the only routes in are this parser and a literal written
+ * by hand — and a literal written by hand in production code is a reviewable line
+ * that says `state: "approved"` next to an Application nobody approved.
+ *
+ * It carries the `VerificationCaseId` because §15's `citizens` row requires an
+ * `approved_verification_case_id`: the Citizen record must be able to name the
+ * evidence case that justified it, and a witness that omitted it would let a Citizen
+ * be created with nothing to point at.
+ */
+export interface ApprovedApplication {
+    readonly applicationId: ApplicationId;
+    readonly state: "approved";
+    readonly verificationCaseId: VerificationCaseId;
+}
+/**
+ * An `ApprovedApplication` from a wire value, or a refusal.
+ *
+ * Every other lifecycle state is refused here, including the ones a reader might
+ * think are nearly approved: `manual_review` is a Reviewer still looking, and
+ * `under_appeal` is §8.6's route that has not concluded. Neither creates a Citizen.
+ */
+export declare const parseApprovedApplication: (value: unknown, field?: string) => ApprovedApplication;

package/dist/application.js

@@ -0,0 +1,170 @@
+/**
+ * The Application: its closed lifecycle, its transitions, and the one state that
+ * creates a Citizen.
+ *
+ * §5.2 is the canon here, and it says three things this file has to make true rather
+ * than merely describe. "The Application and the Citizen are different records." "An
+ * Applicant must exist before a Citizen can, and **approval is the only transition
+ * that creates one**." "A retry creates a **new** Application linked to its
+ * predecessor. Evidence and decision history are never rewritten."
+ *
+ * ENFORCED TWICE, IN BOTH DIRECTIONS.
+ *
+ * The lifecycle is a closed union, so no state outside §5.2's diagram can be
+ * written; and `parseApplicationState` refuses any string outside the same list, so
+ * no state outside §5.2's diagram can arrive. §15 singles out one of those in
+ * particular — `applications` must not hold "a generic `pending` state" — and
+ * because `pending` is the state a reader most expects to find, `contract.test.ts`
+ * names it directly on both sides: it is not assignable, and it is refused.
+ *
+ * `ApprovedApplication` is the other half. It is a separate type whose `state` is
+ * the literal `"approved"` rather than an `ApplicationState`, which makes it
+ * unforgeable by widening: a `draft` Application is not assignable to it, so a
+ * function that creates a Citizen can ask for one and get §14.4's "No route, script,
+ * production fixture or flag creates a Citizen outside an Application" from the
+ * compiler. `parseApprovedApplication` is the runtime twin, and refuses every other
+ * state by name.
+ *
+ * WHAT THIS FILE DELIBERATELY DOES NOT CARRY.
+ *
+ * No transition performs anything. This package publishes the vocabulary, and the
+ * approval transaction belongs to the service — the one that commits the
+ * Application, Citizen, profile, Handle, email assignment, authenticators,
+ * provenance, document signal and coordination row together or not at all.
+ * `isApplicationTransitionPermitted` answers a question
+ * about the diagram; it does not move anything, and a consumer that treats a `true`
+ * from it as authority to transition has skipped the transaction §15 requires.
+ *
+ * No timers, no expiry figures. `draft --> expired` is in the diagram; how long a
+ * draft lives is not, and a figure invented here would become the one every
+ * consumer inherited.
+ */
+import { parseCorrelationReference, readApplicationId, readVerificationCaseId, } from "./ids.js";
+import { readClosedRecord, readMember, refuseValue } from "./parse.js";
+/** Every Application state, in §5.2's order. A test that must cover them all reads this. */
+export const APPLICATION_STATES = Object.freeze([
+    "draft",
+    "submitted",
+    "automated_review",
+    "manual_review",
+    "approved",
+    "rejected",
+    "under_appeal",
+    "cancelled",
+    "expired",
+]);
+/**
+ * §5.2's diagram, transcribed edge for edge — and no edge that is not drawn there.
+ *
+ * The omissions carry the weight. `approved` has no outgoing edge, so an approved
+ * Application cannot be reopened, re-reviewed or quietly returned to `draft` to be
+ * decided again; whatever happens to the person afterwards happens to their Citizen
+ * record, under §5.3, and not by rewriting the decision that created it. `cancelled`
+ * and `expired` have none either: §5.2 gives a retry "a **new** Application linked
+ * to its predecessor", so the route out of a dead Application is a successor record
+ * and never a resurrection of this one. `rejected --> under_appeal` is the single
+ * exception, because an appeal is §8.6's designed route rather than a re-run.
+ */
+export const APPLICATION_TRANSITIONS = Object.freeze({
+    draft: Object.freeze(["submitted", "expired"]),
+    submitted: Object.freeze(["automated_review", "cancelled"]),
+    automated_review: Object.freeze([
+        "manual_review",
+        "approved",
+        "rejected",
+    ]),
+    manual_review: Object.freeze(["approved", "rejected"]),
+    rejected: Object.freeze(["under_appeal"]),
+    under_appeal: Object.freeze(["approved", "rejected"]),
+    approved: Object.freeze([]),
+    cancelled: Object.freeze([]),
+    expired: Object.freeze([]),
+});
+/**
+ * Whether §5.2 draws this edge.
+ *
+ * A state with no outgoing edge is terminal for THIS Application, which is not the
+ * same as terminal for the person: `isRetryable` says which terminal states §5.2
+ * permits a successor from.
+ */
+export const isApplicationTransitionPermitted = (from, to) => APPLICATION_TRANSITIONS[from].includes(to);
+/** Whether §5.2 draws no edge out of this state. */
+export const isTerminalApplicationState = (state) => APPLICATION_TRANSITIONS[state].length === 0;
+/**
+ * Whether a person whose Application reached this state may hold a successor one.
+ *
+ * `approved` is excluded, and that exclusion is CONTEXT.md's "One human, one
+ * Citizen" seen from the Application side: a successor to an approved Application
+ * would be a second road to a second Citizen record for the same human. §5.1's
+ * "Rejected, cancelled and expired people remain associated with their Application"
+ * names the other three exactly.
+ */
+export const isRetryable = (state) => state === "rejected" || state === "cancelled" || state === "expired";
+/** A state name from a wire value, or a refusal. */
+export const parseApplicationState = (value, field = "state") => {
+    if (typeof value !== "string" ||
+        !APPLICATION_STATES.includes(value)) {
+        refuseValue(field, `must be one of the ${APPLICATION_STATES.length} Application states of §5.2`);
+    }
+    return value;
+};
+const APPLICATION_SUMMARY_FIELDS = Object.freeze([
+    "applicationId",
+    "state",
+    "predecessorApplicationId",
+    "correlationReference",
+    "expiresAt",
+]);
+const readOptionalMillis = (record, field, key) => {
+    const value = record[key];
+    if (value === null) {
+        return null;
+    }
+    if (typeof value !== "number" || !Number.isSafeInteger(value) || value < 0) {
+        refuseValue(`${field}.${key}`, "must be null or a non-negative integer count of milliseconds");
+    }
+    return value;
+};
+/** An `ApplicationSummary` from a wire value, or a refusal. */
+export const parseApplicationSummary = (value, field = "application") => {
+    const record = readClosedRecord(value, field, APPLICATION_SUMMARY_FIELDS);
+    const predecessor = record["predecessorApplicationId"];
+    const correlation = record["correlationReference"];
+    return {
+        applicationId: readApplicationId(record, field, "applicationId"),
+        state: readMember(record, field, "state", APPLICATION_STATES),
+        predecessorApplicationId: predecessor === null
+            ? null
+            : readApplicationId(record, field, "predecessorApplicationId"),
+        correlationReference: correlation === null
+            ? null
+            : parseCorrelationReference(typeof correlation === "string"
+                ? correlation
+                : refuseValue(`${field}.correlationReference`, "must be null or a string"), `${field}.correlationReference`),
+        expiresAt: readOptionalMillis(record, field, "expiresAt"),
+    };
+};
+const APPROVED_APPLICATION_FIELDS = Object.freeze([
+    "applicationId",
+    "state",
+    "verificationCaseId",
+]);
+/**
+ * An `ApprovedApplication` from a wire value, or a refusal.
+ *
+ * Every other lifecycle state is refused here, including the ones a reader might
+ * think are nearly approved: `manual_review` is a Reviewer still looking, and
+ * `under_appeal` is §8.6's route that has not concluded. Neither creates a Citizen.
+ */
+export const parseApprovedApplication = (value, field = "approvedApplication") => {
+    const record = readClosedRecord(value, field, APPROVED_APPLICATION_FIELDS);
+    const state = readMember(record, field, "state", APPLICATION_STATES);
+    if (state !== "approved") {
+        refuseValue(`${field}.state`, "must be approved. Approval is the only transition that creates a Citizen (§5.2)");
+    }
+    return {
+        applicationId: readApplicationId(record, field, "applicationId"),
+        state: "approved",
+        verificationCaseId: readVerificationCaseId(record, field, "verificationCaseId"),
+    };
+};