@zanii/residency 0.1.0

package/LICENSE

@@ -0,0 +1,159 @@
+                                 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; 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.
+
+   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.
+
+   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.
+
+   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.
+
+   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.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Zanii
+
+   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,39 @@
+# @zanii/residency
+
+**Did my data leave the country?** Bind a **region attestation** to each data touch,
+confirm it's inside a declared jurisdiction, and emit a receipt when it crosses a border.
+Answers the 2026 sovereignty fear: *"prove it never left the UAE / the EU."*
+
+```sh
+npm install @zanii/residency @zanii/core
+```
+
+```ts
+import { buildResidencyClaim, verifyResidency, detectCrossings, JURISDICTION_PRESETS } from '@zanii/residency';
+
+const claim = buildResidencyClaim({ jurisdiction: 'UAE',
+  regionAttestation: { region: 'me-central-1', source: 'aws:instance-identity', evidence }, ts: now });
+await zanii.record(claim);
+
+// verify: your injected geo verifier authenticates the region, then it must be in the allow-set
+const r = await verifyResidency(claim.payload, { allowedRegions: JURISDICTION_PRESETS.UAE, verifyRegion });
+r.ok; r.crossed;   // crossed = the region left the declared jurisdiction — a border crossing
+
+detectCrossings(sequence, JURISDICTION_PRESETS.UAE);   // exit/return points across a history
+```
+
+Python: `from zanii.residency import build_residency_claim, verify_residency, detect_crossings, ...`
+
+## Injected geo verification & declared jurisdictions
+
+We can't derive where a server ran — the region signal comes from the cloud provider or a
+TEE's attested geolocation, authenticated by **your** `verifyRegion` (the `@zanii/attest`
+discipline). And jurisdiction is **declared, not assumed**: you pass an explicit
+`allowedRegions` set — your compliance team owns it. Presets (`UAE`, `GCC`, `EU`) are
+convenience only.
+
+## The limit, stated up front
+
+Only as strong as the region attestation source. A claim proves "a signal your verifier
+trusts said this ran in region R, and R is in your declared jurisdiction." Bind a signal
+you verify.

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+/** A raw region signal — the shape your `verifyRegion` authenticates. Contents are yours. */
+export interface RegionAttestation {
+    /** Region/country code, e.g. `AE`, `me-central-1`, `eu-central-1`. */
+    region: string;
+    /** Where the signal came from, e.g. `aws:instance-identity`, `tee:geo`, `azure:imds`. */
+    source: string;
+    /** Opaque provider evidence your verifier checks (a signed doc, a quote). */
+    evidence?: string;
+}
+/** Injected: authenticate a region signal, return the trusted region + source, or null. */
+export type RegionVerifier = (attestation: RegionAttestation) => Promise<{
+    region: string;
+    source: string;
+} | null> | {
+    region: string;
+    source: string;
+} | null;
+/** Convenience presets — extend or replace with your own compliance-owned lists. */
+export declare const JURISDICTION_PRESETS: Record<string, string[]>;
+export interface ResidencyClaim {
+    v: 1;
+    type: 'residency.claim';
+    /** Optional data-object ref (`@zanii/data-custody`) this residency applies to. */
+    ref?: string;
+    /** The declared jurisdiction name (informational — the allow-set is the real check). */
+    jurisdiction: string;
+    /** The region signal, verified by the injected verifier at check time. */
+    region_attestation: RegionAttestation;
+    ts: string;
+}
+export interface ResidencyInput {
+    jurisdiction: string;
+    regionAttestation: RegionAttestation;
+    ts: string;
+    ref?: string;
+}
+/** Build a residency claim for a touch. Record it (or attach to a `@zanii/data-custody` touch). */
+export declare function buildResidencyClaim(input: ResidencyInput): {
+    target: string;
+    payload: Record<string, unknown>;
+};
+export declare function claimHash(claim: ResidencyClaim): string;
+export interface ResidencyCheck {
+    ok: boolean;
+    reasons: string[];
+    /** The verified region (from the injected verifier), when it authenticated. */
+    region: string | null;
+    /** true when the region is outside the declared allow-set — a border crossing. */
+    crossed: boolean;
+}
+/**
+ * Verify a residency claim: the injected verifier must authenticate the region signal,
+ * AND the returned region must be in `allowedRegions`. A region outside the set is a
+ * **border crossing** (`crossed: true`) — not silently ignored.
+ */
+export declare function verifyResidency(claim: ResidencyClaim, opts: {
+    allowedRegions: string[];
+    verifyRegion: RegionVerifier;
+}): Promise<ResidencyCheck>;
+/**
+ * Across an ordered sequence of verified regions (each `{ ts, region }`, oldest first),
+ * find every point where the region left the declared allow-set. Each crossing names the
+ * ts and the region it moved to — the evidence for "when did it leave, and to where."
+ */
+export declare function detectCrossings(sequence: Array<{
+    ts: string;
+    region: string;
+}>, allowedRegions: string[]): Array<{
+    ts: string;
+    region: string;
+    direction: 'exit' | 'return';
+}>;
+/** Does an agent's scope permit acting in this region? (`residency.<region>` targets, reusing core.) */
+export declare function residencyAllowed(effectiveScopes: string[], region: string): boolean;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA6BA,6FAA6F;AAC7F,MAAM,WAAW,iBAAiB;IAChC,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC;IACf,yFAAyF;IACzF,MAAM,EAAE,MAAM,CAAC;IACf,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,2FAA2F;AAC3F,MAAM,MAAM,cAAc,GAAG,CAAC,WAAW,EAAE,iBAAiB,KAAK,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC;AAEhK,oFAAoF;AACpF,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAIzD,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,CAAC,EAAE,CAAC,CAAC;IACL,IAAI,EAAE,iBAAiB,CAAC;IACxB,kFAAkF;IAClF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wFAAwF;IACxF,YAAY,EAAE,MAAM,CAAC;IACrB,0EAA0E;IAC1E,kBAAkB,EAAE,iBAAiB,CAAC;IACtC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,mGAAmG;AACnG,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAa/G;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAEvD;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,+EAA+E;IAC/E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,kFAAkF;IAClF,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,cAAc,EACrB,IAAI,EAAE;IAAE,cAAc,EAAE,MAAM,EAAE,CAAC;IAAC,YAAY,EAAE,cAAc,CAAA;CAAE,GAC/D,OAAO,CAAC,cAAc,CAAC,CAYzB;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,KAAK,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,EAC/C,cAAc,EAAE,MAAM,EAAE,GACvB,KAAK,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAC,CAYrE;AAED,wGAAwG;AACxG,wBAAgB,gBAAgB,CAAC,eAAe,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnF"}

package/dist/index.js

@@ -0,0 +1,98 @@
+/**
+ * @zanii/residency — did my data leave the country?
+ *
+ * The biggest 2026 sovereignty fear (EU localization, UAE PDPL residency, GCC rules) is
+ * that nothing proves where data *physically* went. This binds a **region attestation**
+ * to each data touch: confirm the attested region is inside a declared jurisdiction, and
+ * emit a receipt the moment it crosses a border.
+ *
+ * ## Injected geo verification (the `@zanii/attest` discipline)
+ *
+ * We cannot derive where a server ran — the region signal comes from the cloud provider
+ * (an AWS/Azure region identity, an instance-identity document) or a TEE's attested
+ * geolocation. You pass a `verifyRegion` that authenticates that signal and returns the
+ * region. **We verify the binding; you supply the geo trust root.**
+ *
+ * ## Jurisdiction is declared, not assumed
+ *
+ * We do not maintain a geopolitical database of "what is in the EU." You declare a
+ * jurisdiction as an explicit **allow-set of regions** (`allowedRegions`) — your compliance
+ * team owns that list. A couple of presets are provided as convenience, nothing more.
+ *
+ * ## The limit, stated up front
+ *
+ * The proof is only as strong as the region attestation source. A residency claim proves
+ * "a signal your verifier trusts said this touch ran in region R, and R is in your declared
+ * jurisdiction." It cannot prove residency your geo source can't — bind a signal you verify.
+ */
+import { jcsHash, scopesAllow } from '@zanii/core';
+/** Convenience presets — extend or replace with your own compliance-owned lists. */
+export const JURISDICTION_PRESETS = {
+    UAE: ['AE', 'me-central-1', 'me-south-1'],
+    GCC: ['AE', 'SA', 'BH', 'KW', 'OM', 'QA', 'me-central-1', 'me-south-1'],
+    EU: ['AT', 'BE', 'BG', 'HR', 'CY', 'CZ', 'DK', 'EE', 'FI', 'FR', 'DE', 'GR', 'HU', 'IE', 'IT', 'LV', 'LT', 'LU', 'MT', 'NL', 'PL', 'PT', 'RO', 'SK', 'SI', 'ES', 'SE', 'eu-central-1', 'eu-west-1', 'eu-west-3', 'eu-north-1'],
+};
+/** Build a residency claim for a touch. Record it (or attach to a `@zanii/data-custody` touch). */
+export function buildResidencyClaim(input) {
+    if (!input.jurisdiction)
+        throw new Error('jurisdiction is required');
+    if (!input.regionAttestation?.region)
+        throw new Error('regionAttestation.region is required');
+    if (Number.isNaN(Date.parse(input.ts)))
+        throw new Error('ts must be an ISO timestamp');
+    const claim = {
+        v: 1,
+        type: 'residency.claim',
+        jurisdiction: input.jurisdiction,
+        region_attestation: input.regionAttestation,
+        ts: input.ts,
+    };
+    if (input.ref !== undefined)
+        claim.ref = input.ref;
+    return { target: 'residency.claim', payload: claim };
+}
+export function claimHash(claim) {
+    return jcsHash(claim);
+}
+/**
+ * Verify a residency claim: the injected verifier must authenticate the region signal,
+ * AND the returned region must be in `allowedRegions`. A region outside the set is a
+ * **border crossing** (`crossed: true`) — not silently ignored.
+ */
+export async function verifyResidency(claim, opts) {
+    const reasons = [];
+    if (claim?.v !== 1 || claim.type !== 'residency.claim') {
+        return { ok: false, reasons: ['not a residency claim (v1)'], region: null, crossed: false };
+    }
+    const verified = await opts.verifyRegion(claim.region_attestation);
+    if (!verified) {
+        return { ok: false, reasons: ['region signal failed the injected verifier'], region: null, crossed: false };
+    }
+    const inside = opts.allowedRegions.includes(verified.region);
+    if (!inside)
+        reasons.push(`region ${verified.region} is OUTSIDE the declared jurisdiction (${opts.allowedRegions.join(', ')}) — border crossed`);
+    return { ok: inside, reasons, region: verified.region, crossed: !inside };
+}
+/**
+ * Across an ordered sequence of verified regions (each `{ ts, region }`, oldest first),
+ * find every point where the region left the declared allow-set. Each crossing names the
+ * ts and the region it moved to — the evidence for "when did it leave, and to where."
+ */
+export function detectCrossings(sequence, allowedRegions) {
+    const crossings = [];
+    let inside = null;
+    const ordered = [...sequence].sort((a, b) => Date.parse(a.ts) - Date.parse(b.ts));
+    for (const s of ordered) {
+        const now = allowedRegions.includes(s.region);
+        if (inside !== null && now !== inside) {
+            crossings.push({ ts: s.ts, region: s.region, direction: now ? 'return' : 'exit' });
+        }
+        inside = now;
+    }
+    return crossings;
+}
+/** Does an agent's scope permit acting in this region? (`residency.<region>` targets, reusing core.) */
+export function residencyAllowed(effectiveScopes, region) {
+    return scopesAllow(effectiveScopes, `residency.${region}`);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAenD,oFAAoF;AACpF,MAAM,CAAC,MAAM,oBAAoB,GAA6B;IAC5D,GAAG,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,YAAY,CAAC;IACzC,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,YAAY,CAAC;IACvE,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC;CAC/N,CAAC;AAqBF,mGAAmG;AACnG,MAAM,UAAU,mBAAmB,CAAC,KAAqB;IACvD,IAAI,CAAC,KAAK,CAAC,YAAY;QAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IACrE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC9F,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACvF,MAAM,KAAK,GAAmB;QAC5B,CAAC,EAAE,CAAC;QACJ,IAAI,EAAE,iBAAiB;QACvB,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,kBAAkB,EAAE,KAAK,CAAC,iBAAiB;QAC3C,EAAE,EAAE,KAAK,CAAC,EAAE;KACb,CAAC;IACF,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS;QAAE,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;IACnD,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,KAA2C,EAAE,CAAC;AAC7F,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAqB;IAC7C,OAAO,OAAO,CAAC,KAA2C,CAAC,CAAC;AAC9D,CAAC;AAWD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,KAAqB,EACrB,IAAgE;IAEhE,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QACvD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,4BAA4B,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC9F,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACnE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,4CAA4C,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC9G,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7D,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,IAAI,CAAC,UAAU,QAAQ,CAAC,MAAM,0CAA0C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjJ,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;AAC5E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,QAA+C,EAC/C,cAAwB;IAExB,MAAM,SAAS,GAAwE,EAAE,CAAC;IAC1F,IAAI,MAAM,GAAmB,IAAI,CAAC;IAClC,MAAM,OAAO,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClF,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,MAAM,GAAG,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,MAAM,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;YACtC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACrF,CAAC;QACD,MAAM,GAAG,GAAG,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,gBAAgB,CAAC,eAAyB,EAAE,MAAc;IACxE,OAAO,WAAW,CAAC,eAAe,EAAE,aAAa,MAAM,EAAE,CAAC,CAAC;AAC7D,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@zanii/residency",
+  "version": "0.1.0",
+  "description": "Prove where an agent's data physically stayed - bind a region attestation to each data touch, confirm the attested region is inside a declared jurisdiction, and emit a receipt the moment it crosses a border. Answers 'prove it never left the UAE / the EU.' The region signal is INJECTED (cloud-provider region / TEE geolocation) - we verify the binding, you supply the geo trust root; the proof is only as strong as that source.",
+  "license": "Apache-2.0",
+  "homepage": "https://ledger.zanii.agency",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@types/node": "^26.1.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
+  },
+  "dependencies": {
+    "@zanii/core": "0.4.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/src/index.ts

@@ -0,0 +1,145 @@
+/**
+ * @zanii/residency — did my data leave the country?
+ *
+ * The biggest 2026 sovereignty fear (EU localization, UAE PDPL residency, GCC rules) is
+ * that nothing proves where data *physically* went. This binds a **region attestation**
+ * to each data touch: confirm the attested region is inside a declared jurisdiction, and
+ * emit a receipt the moment it crosses a border.
+ *
+ * ## Injected geo verification (the `@zanii/attest` discipline)
+ *
+ * We cannot derive where a server ran — the region signal comes from the cloud provider
+ * (an AWS/Azure region identity, an instance-identity document) or a TEE's attested
+ * geolocation. You pass a `verifyRegion` that authenticates that signal and returns the
+ * region. **We verify the binding; you supply the geo trust root.**
+ *
+ * ## Jurisdiction is declared, not assumed
+ *
+ * We do not maintain a geopolitical database of "what is in the EU." You declare a
+ * jurisdiction as an explicit **allow-set of regions** (`allowedRegions`) — your compliance
+ * team owns that list. A couple of presets are provided as convenience, nothing more.
+ *
+ * ## The limit, stated up front
+ *
+ * The proof is only as strong as the region attestation source. A residency claim proves
+ * "a signal your verifier trusts said this touch ran in region R, and R is in your declared
+ * jurisdiction." It cannot prove residency your geo source can't — bind a signal you verify.
+ */
+import { jcsHash, scopesAllow } from '@zanii/core';
+
+/** A raw region signal — the shape your `verifyRegion` authenticates. Contents are yours. */
+export interface RegionAttestation {
+  /** Region/country code, e.g. `AE`, `me-central-1`, `eu-central-1`. */
+  region: string;
+  /** Where the signal came from, e.g. `aws:instance-identity`, `tee:geo`, `azure:imds`. */
+  source: string;
+  /** Opaque provider evidence your verifier checks (a signed doc, a quote). */
+  evidence?: string;
+}
+
+/** Injected: authenticate a region signal, return the trusted region + source, or null. */
+export type RegionVerifier = (attestation: RegionAttestation) => Promise<{ region: string; source: string } | null> | { region: string; source: string } | null;
+
+/** Convenience presets — extend or replace with your own compliance-owned lists. */
+export const JURISDICTION_PRESETS: Record<string, string[]> = {
+  UAE: ['AE', 'me-central-1', 'me-south-1'],
+  GCC: ['AE', 'SA', 'BH', 'KW', 'OM', 'QA', 'me-central-1', 'me-south-1'],
+  EU: ['AT', 'BE', 'BG', 'HR', 'CY', 'CZ', 'DK', 'EE', 'FI', 'FR', 'DE', 'GR', 'HU', 'IE', 'IT', 'LV', 'LT', 'LU', 'MT', 'NL', 'PL', 'PT', 'RO', 'SK', 'SI', 'ES', 'SE', 'eu-central-1', 'eu-west-1', 'eu-west-3', 'eu-north-1'],
+};
+
+export interface ResidencyClaim {
+  v: 1;
+  type: 'residency.claim';
+  /** Optional data-object ref (`@zanii/data-custody`) this residency applies to. */
+  ref?: string;
+  /** The declared jurisdiction name (informational — the allow-set is the real check). */
+  jurisdiction: string;
+  /** The region signal, verified by the injected verifier at check time. */
+  region_attestation: RegionAttestation;
+  ts: string;
+}
+
+export interface ResidencyInput {
+  jurisdiction: string;
+  regionAttestation: RegionAttestation;
+  ts: string;
+  ref?: string;
+}
+
+/** Build a residency claim for a touch. Record it (or attach to a `@zanii/data-custody` touch). */
+export function buildResidencyClaim(input: ResidencyInput): { target: string; payload: Record<string, unknown> } {
+  if (!input.jurisdiction) throw new Error('jurisdiction is required');
+  if (!input.regionAttestation?.region) throw new Error('regionAttestation.region is required');
+  if (Number.isNaN(Date.parse(input.ts))) throw new Error('ts must be an ISO timestamp');
+  const claim: ResidencyClaim = {
+    v: 1,
+    type: 'residency.claim',
+    jurisdiction: input.jurisdiction,
+    region_attestation: input.regionAttestation,
+    ts: input.ts,
+  };
+  if (input.ref !== undefined) claim.ref = input.ref;
+  return { target: 'residency.claim', payload: claim as unknown as Record<string, unknown> };
+}
+
+export function claimHash(claim: ResidencyClaim): string {
+  return jcsHash(claim as unknown as Record<string, unknown>);
+}
+
+export interface ResidencyCheck {
+  ok: boolean;
+  reasons: string[];
+  /** The verified region (from the injected verifier), when it authenticated. */
+  region: string | null;
+  /** true when the region is outside the declared allow-set — a border crossing. */
+  crossed: boolean;
+}
+
+/**
+ * Verify a residency claim: the injected verifier must authenticate the region signal,
+ * AND the returned region must be in `allowedRegions`. A region outside the set is a
+ * **border crossing** (`crossed: true`) — not silently ignored.
+ */
+export async function verifyResidency(
+  claim: ResidencyClaim,
+  opts: { allowedRegions: string[]; verifyRegion: RegionVerifier },
+): Promise<ResidencyCheck> {
+  const reasons: string[] = [];
+  if (claim?.v !== 1 || claim.type !== 'residency.claim') {
+    return { ok: false, reasons: ['not a residency claim (v1)'], region: null, crossed: false };
+  }
+  const verified = await opts.verifyRegion(claim.region_attestation);
+  if (!verified) {
+    return { ok: false, reasons: ['region signal failed the injected verifier'], region: null, crossed: false };
+  }
+  const inside = opts.allowedRegions.includes(verified.region);
+  if (!inside) reasons.push(`region ${verified.region} is OUTSIDE the declared jurisdiction (${opts.allowedRegions.join(', ')}) — border crossed`);
+  return { ok: inside, reasons, region: verified.region, crossed: !inside };
+}
+
+/**
+ * Across an ordered sequence of verified regions (each `{ ts, region }`, oldest first),
+ * find every point where the region left the declared allow-set. Each crossing names the
+ * ts and the region it moved to — the evidence for "when did it leave, and to where."
+ */
+export function detectCrossings(
+  sequence: Array<{ ts: string; region: string }>,
+  allowedRegions: string[],
+): Array<{ ts: string; region: string; direction: 'exit' | 'return' }> {
+  const crossings: Array<{ ts: string; region: string; direction: 'exit' | 'return' }> = [];
+  let inside: boolean | null = null;
+  const ordered = [...sequence].sort((a, b) => Date.parse(a.ts) - Date.parse(b.ts));
+  for (const s of ordered) {
+    const now = allowedRegions.includes(s.region);
+    if (inside !== null && now !== inside) {
+      crossings.push({ ts: s.ts, region: s.region, direction: now ? 'return' : 'exit' });
+    }
+    inside = now;
+  }
+  return crossings;
+}
+
+/** Does an agent's scope permit acting in this region? (`residency.<region>` targets, reusing core.) */
+export function residencyAllowed(effectiveScopes: string[], region: string): boolean {
+  return scopesAllow(effectiveScopes, `residency.${region}`);
+}