@tula-tech/contract 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+                                 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,38 @@
-# Temporary Holding Version
+# @tula-tech/contract
 
-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.
+The public contract of [Tula Auth](../../README.md): the Zod schemas of every request and
+response, the flow protocol (the steps a server answers a sign-up, a sign-in or a reset with),
+the error codes, the token claims, the password policy, and the OpenAPI document they are
+published as. The API validates with it and every Tula SDK is generated from it or tested
+against it, so it is the one place the protocol is written down.
+
+```sh
+bun add @tula-tech/contract@latest    # or: npm install @tula-tech/contract@latest
+```
+
+> **Early release (0.x).** The protocol may change from one release to the next, and every `@tula-tech/*` package of a release shares one version, so install them at
+> the same one. Everything else is in the
+> [repository](https://github.com/Tula-Solutions/tula-auth-and-user-management#readme).
+
+Most applications never import it: `@tula-tech/react`, `@tula-tech/nextjs` and `@tula-tech/core` are what an
+app is built on, and they bring it. Import it yourself to check a payload against the
+protocol, or for a constant an SDK does not re-export:
+
+```ts
+import { ERROR_CODES } from '@tula-tech/contract/error-codes'
+import { FlowStepSchema } from '@tula-tech/contract'
+
+const step = FlowStepSchema.parse(await response.json())
+```
+
+## Entry points
+
+| Import | What |
+| --- | --- |
+| `@tula-tech/contract` | Everything, the Zod schemas included. It depends on Zod 4. |
+| `@tula-tech/contract/error-codes`, `/event-types`, `/headers`, `/issuer`, `/password-rules`, `/redirect-url`, `/theme`, `/webhook-signature`, `/custom-claims`, `/device-binding` | The constants and pure functions an SDK needs at run time. None of them imports Zod, so none pulls it into an application's bundle. |
+| `@tula-tech/contract/openapi.json` | The OpenAPI document of the API this version describes. |
+
+The reference of every export is [docs/reference/contract.md](../../docs/reference/contract.md).
+Under a strict Content-Security-Policy (no `'unsafe-eval'`), see
+[docs/releasing.md](../../docs/releasing.md#tula-techcontract-under-a-strict-content-security-policy).

package/dist/custom-claims.d.ts

@@ -0,0 +1,161 @@
+/**
+* The one top-level claim every custom claim is nested under (ADR 0036).
+*
+* An operator's claims never sit beside Tula's own, so a claim Tula adds later cannot collide
+* with a customer's, and a template cannot set a claim Tula's servers or SDKs act on. `ext`
+* ("extension") is three bytes in every token, and is not a registered claim name (IANA's
+* "JSON Web Token Claims" registry, read in October 2026) nor one OpenID Connect defines.
+*
+* @example
+* ```ts
+* const role = payload[CUSTOM_CLAIMS_CLAIM]?.role // payload.ext.role
+* ```
+*/
+declare const CUSTOM_CLAIMS_CLAIM = "ext";
+/**
+* Claim names a custom claim's key may never be: every claim Tula's tokens carry, the
+* registered claims a verifier acts on, `cnf` (reserved for device binding) and the namespace
+* claim itself.
+*
+* A custom claim lives inside {@link CUSTOM_CLAIMS_CLAIM}, so it could not overwrite one of
+* these anyway. They are refused so that nobody reads `claims.ext.sub` as the subject.
+*
+* @example
+* ```ts
+* RESERVED_CLAIM_NAMES.includes('sub') // true
+* ```
+*/
+declare const RESERVED_CLAIM_NAMES: readonly ["iss", "sub", "aud", "exp", "nbf", "iat", "jti", "sid", "pid", "eid", "v", "auth_time", "amr", "sp", "cnf", "ext"];
+/**
+* The most bytes the namespace claim's value may take as JSON (UTF-8), whatever puts claims
+* in it.
+*
+* An access token is sent with every request and `@tula-tech/nextjs` keeps it in a cookie, where a
+* browser allows about 4,096 bytes for the name and the value together. A token without
+* custom claims is about 700 bytes; this cap adds at most 1,366 (base64url), which leaves
+* room for a long issuer URL.
+*/
+declare const MAX_CUSTOM_CLAIMS_BYTES = 1024;
+/** Most JWT templates an environment may define. */
+declare const MAX_JWT_TEMPLATES = 10;
+/** Most claims one JWT template may define. */
+declare const MAX_JWT_TEMPLATE_CLAIMS = 16;
+/** Longest custom claim key, in characters. */
+declare const MAX_CUSTOM_CLAIM_KEY_LENGTH = 32;
+/** Longest string a template may set as a constant, in characters. */
+declare const MAX_CUSTOM_CLAIM_CONSTANT_LENGTH = 256;
+/** What a custom claim's value can be: one string, number or boolean. Never a list or an object. */
+type CustomClaimValue = string | number | boolean;
+/**
+* The custom claims of a verified session, as an SDK hands them to an application: a frozen
+* map from claim key to value.
+*
+* The values are typed `unknown` because only the operator knows what their template puts
+* under each key: narrow before use. At run time each is a string, a number or a boolean.
+*
+* @example
+* ```ts
+* const { customClaims } = await auth()
+* const isAdmin = customClaims.role === 'admin' // a missing claim is `undefined`: "no"
+* ```
+*/
+type CustomClaims = Readonly<Record<string, unknown>>;
+/**
+* Whether a string can be the key of a custom claim: ASCII letters, digits and underscores,
+* not starting with a digit, at most {@link MAX_CUSTOM_CLAIM_KEY_LENGTH} characters, and none
+* of {@link RESERVED_CLAIM_NAMES}, `__proto__`, `constructor` or `prototype`.
+*
+* @param key - The candidate.
+* @returns `true` when it can be a key.
+*
+* @example
+* ```ts
+* isCustomClaimKey('role') // true
+* isCustomClaimKey('sub') // false: reserved
+* isCustomClaimKey('my-claim') // false: a hyphen
+* ```
+*/
+declare function isCustomClaimKey(key: unknown): key is string;
+/**
+* Whether a value can be a custom claim's: a string, a boolean, or a number JSON can hold.
+*
+* @param value - The candidate.
+* @returns `true` for a string, a boolean and a finite number.
+*
+* @example
+* ```ts
+* isCustomClaimValue('admin') // true
+* isCustomClaimValue(['admin']) // false
+* ```
+*/
+declare function isCustomClaimValue(value: unknown): value is CustomClaimValue;
+/**
+* How many bytes custom claims take in a token: the UTF-8 length of their JSON, which is what
+* {@link MAX_CUSTOM_CLAIMS_BYTES} caps.
+*
+* @param claims - The value of the namespace claim.
+* @returns The byte count.
+*
+* @example
+* ```ts
+* customClaimsBytes({ role: 'admin' }) // 16: {"role":"admin"}
+* ```
+*/
+declare function customClaimsBytes(claims: Readonly<Record<string, CustomClaimValue>>): number;
+/**
+* What {@link checkCustomClaims} found: the claims, or why they are not claims.
+*
+* - `invalid`: not a plain object, a key that fails {@link isCustomClaimKey} (a reserved
+*   name and `__proto__` among them), or a value that is not one string, number or boolean.
+* - `too_large`: every claim is fine and together they are over
+*   {@link MAX_CUSTOM_CLAIMS_BYTES}.
+*/
+type CustomClaimsCheck = {
+	claims: Record<string, CustomClaimValue>;
+} | {
+	problem: "invalid" | "too_large";
+};
+/**
+* Judge claims that did not come from the environment's settings (a hook's answer), **whole**:
+* either every one of them can be issued under the namespace claim, or none is.
+*
+* Nothing is repaired and nothing is left out: one bad key makes the whole value `invalid`.
+* Give it the value as it was parsed (`JSON.parse`), not one a schema library has rebuilt:
+* the keys are read as the object's **own** keys, so a `__proto__` key a parser kept is seen
+* and refused, where a library that copies objects would have dropped it silently. An empty
+* object is fine and means no claims.
+*
+* @param value - The candidate claims.
+* @returns A copy of the claims (own keys only, no prototype reachable), or the problem.
+*
+* @example
+* ```ts
+* checkCustomClaims({ role: 'admin' }) // { claims: { role: 'admin' } }
+* checkCustomClaims({ sub: 'someone-else' }) // { problem: 'invalid' }
+* ```
+*/
+declare function checkCustomClaims(value: unknown): CustomClaimsCheck;
+/**
+* Read the custom claims out of a session's claims, for an SDK to hand to an application.
+*
+* Call it only with claims that were **verified** (a token's signature and issuer, or the
+* API's own answer): this checks a shape, not where the claims came from.
+*
+* The namespace claim is returned only when it is exactly what a Tula server issues: a plain
+* object, not empty, at most {@link MAX_CUSTOM_CLAIMS_BYTES} as JSON, whose every key passes
+* {@link isCustomClaimKey} and whose every value is a string, a boolean or a finite number.
+* Anything else is **absent as a whole**, never passed through and never repaired: an
+* application must not be handed an object of a shape it did not expect under a name it
+* trusts. Treat an absent claim as "no".
+*
+* @param claims - A session's verified claims.
+* @returns A frozen copy of the custom claims, or `null` when there are none.
+*
+* @example
+* ```ts
+* readCustomClaims({ sub: 'u1', ext: { role: 'admin' } }) // { role: 'admin' }
+* readCustomClaims({ sub: 'u1', ext: ['admin'] }) // null
+* ```
+*/
+declare function readCustomClaims(claims: unknown): CustomClaims | null;
+export { CUSTOM_CLAIMS_CLAIM, CustomClaimValue, CustomClaims, CustomClaimsCheck, MAX_CUSTOM_CLAIMS_BYTES, MAX_CUSTOM_CLAIM_CONSTANT_LENGTH, MAX_CUSTOM_CLAIM_KEY_LENGTH, MAX_JWT_TEMPLATES, MAX_JWT_TEMPLATE_CLAIMS, RESERVED_CLAIM_NAMES, checkCustomClaims, customClaimsBytes, isCustomClaimKey, isCustomClaimValue, readCustomClaims };

package/dist/custom-claims.js

@@ -0,0 +1,28 @@
+import {
+  CUSTOM_CLAIMS_CLAIM2,
+  RESERVED_CLAIM_NAMES2,
+  MAX_CUSTOM_CLAIMS_BYTES2,
+  MAX_JWT_TEMPLATES2,
+  MAX_JWT_TEMPLATE_CLAIMS2,
+  MAX_CUSTOM_CLAIM_KEY_LENGTH2,
+  MAX_CUSTOM_CLAIM_CONSTANT_LENGTH2,
+  isCustomClaimKey2,
+  isCustomClaimValue2,
+  customClaimsBytes2,
+  checkCustomClaims2,
+  readCustomClaims2
+} from "./shared/chunk-4rb5jsfz.js";
+export {
+  CUSTOM_CLAIMS_CLAIM2 as CUSTOM_CLAIMS_CLAIM,
+  MAX_CUSTOM_CLAIMS_BYTES2 as MAX_CUSTOM_CLAIMS_BYTES,
+  MAX_CUSTOM_CLAIM_CONSTANT_LENGTH2 as MAX_CUSTOM_CLAIM_CONSTANT_LENGTH,
+  MAX_CUSTOM_CLAIM_KEY_LENGTH2 as MAX_CUSTOM_CLAIM_KEY_LENGTH,
+  MAX_JWT_TEMPLATES2 as MAX_JWT_TEMPLATES,
+  MAX_JWT_TEMPLATE_CLAIMS2 as MAX_JWT_TEMPLATE_CLAIMS,
+  RESERVED_CLAIM_NAMES2 as RESERVED_CLAIM_NAMES,
+  checkCustomClaims2 as checkCustomClaims,
+  customClaimsBytes2 as customClaimsBytes,
+  isCustomClaimKey2 as isCustomClaimKey,
+  isCustomClaimValue2 as isCustomClaimValue,
+  readCustomClaims2 as readCustomClaims
+};

package/dist/device-binding.d.ts

@@ -0,0 +1,217 @@
+/**
+* Request header carrying the proof: one DPoP proof JWT (RFC 9449), made for this one request.
+* Sent when an attempt starts, to bind the session it ends in, and on every refresh of a bound
+* session.
+*
+* @example
+* ```ts
+* headers[DPOP_HEADER] = await createDpopProof(key, { method: 'POST', url, nonce })
+* ```
+*/
+declare const DPOP_HEADER = "DPoP";
+/**
+* Response header carrying the server's nonce: on the answer that asks for one
+* (`device.nonce_required`), on every refresh of a bound session and on every start that
+* brought a proof. A client keeps the newest one and puts it in its next proof.
+*
+* @example
+* ```ts
+* const nonce = response.headers.get(DPOP_NONCE_HEADER)
+* ```
+*/
+declare const DPOP_NONCE_HEADER = "DPoP-Nonce";
+/**
+* The `typ` of a proof's header. A token of any other type is not a proof.
+*
+* @example
+* ```ts
+* header.typ === DPOP_PROOF_TYPE // 'dpop+jwt'
+* ```
+*/
+declare const DPOP_PROOF_TYPE = "dpop+jwt";
+/**
+* The signature algorithms a proof may use: a closed list, and `ES256` alone. It is what the
+* Secure Enclave and StrongBox sign with (ECDSA over P-256 with SHA-256); a later algorithm is
+* added here on purpose, never accepted because a proof names it.
+*
+* @example
+* ```ts
+* DPOP_ALGORITHMS.includes(header.alg) // only 'ES256'
+* ```
+*/
+declare const DPOP_ALGORITHMS: readonly ["ES256"];
+/** One of {@link DPOP_ALGORITHMS}. */
+type DpopAlgorithm = (typeof DPOP_ALGORITHMS)[number];
+/**
+* Longest proof the server reads, in characters. A proof is a small header, six short claims
+* and a 64-byte signature: about 500 characters. Anything longer is refused unread.
+*
+* @example
+* ```ts
+* proof.length <= MAX_DPOP_PROOF_LENGTH
+* ```
+*/
+declare const MAX_DPOP_PROOF_LENGTH = 2048;
+/**
+* The public half of a device key, as a proof's header carries it: a P-256 point and nothing
+* else. No private member (`d`), no key id, no other field.
+*
+* @example
+* ```ts
+* const jwk: DevicePublicJwk = { kty: 'EC', crv: 'P-256', x: '…', y: '…' }
+* ```
+*/
+interface DevicePublicJwk {
+	kty: "EC";
+	crv: "P-256";
+	/** The point's x coordinate: 32 bytes, base64url without padding. */
+	x: string;
+	/** The point's y coordinate: 32 bytes, base64url without padding. */
+	y: string;
+}
+/**
+* A key a session can be bound to: its public half, and a way to sign with the private half
+* that never hands the private half out. A native SDK backs it with the Secure Enclave or
+* StrongBox; {@link generateSoftwareDeviceKey} backs it with WebCrypto, for tests and for
+* platforms with no hardware key.
+*
+* @example
+* ```ts
+* const key: DeviceKey = await generateSoftwareDeviceKey()
+* const proof = await createDpopProof(key, { method: 'POST', url, nonce })
+* ```
+*/
+interface DeviceKey {
+	/** The public key, sent in every proof's header. */
+	publicJwk: DevicePublicJwk;
+	/**
+	* Sign with ECDSA over P-256 and SHA-256.
+	*
+	* @param data - The bytes to sign (a proof's `header.payload`).
+	* @returns The signature in the JWS form: `r` then `s`, 32 bytes each (64 bytes). A platform
+	*   that produces a DER signature converts it before returning.
+	*/
+	sign(data: Uint8Array): Promise<Uint8Array>;
+	/**
+	* A unique id for one proof (its `jti`), for a runtime whose `crypto.getRandomValues`
+	* cannot be counted on (a native app’s JavaScript engine). Left out, 16 random bytes of
+	* the runtime’s own. The id is not a secret: the server only refuses one it has seen, so
+	* it has to be new every time and need not be unguessable.
+	*
+	* @returns An id no other proof of this key carries.
+	*/
+	proofId?(): string;
+}
+/** What a proof is made for. */
+interface DpopProofInput {
+	/** The request's method, e.g. `POST`: the proof's `htm`. */
+	method: string;
+	/**
+	* The request's address **as the API knows itself**: its public URL and the route's
+	* path. The proof's `htu`. Never the address of a proxy or of an app's own route handler
+	* in front of the API.
+	*
+	* It has one spelling: `http` or `https`, `://`, the host, an optional `:port` in digits,
+	* then a path that starts with `/`, in printable ASCII. A host may hold letters, digits,
+	* dots, hyphens and underscores, or be an IPv6 address in brackets. The server compares
+	* it, as text, with what a URL parser makes of its own public URL, so write it that way:
+	* the host as the server's public URL is written once lower-cased (letters outside ASCII
+	* in their `xn--` form, no dot added or removed at the end); an IPv6 host compressed and
+	* in brackets (`[::1]`); the port without leading zeros and left out when it is the
+	* scheme's default; the path exactly as the route's. The server forgives the case of the
+	* scheme and of the host and a default port written out (`:443`, `:80`), and nothing
+	* else. It **refuses** an address with a backslash, a `.` or `..` path segment, a percent
+	* sign, a query or a fragment (an empty one too), user info (`user@`), or a space, a tab
+	* or a line break. It is signed as given: this module does not rewrite it, so a client
+	* with a URL parser passes the API's URL through it first.
+	*/
+	url: string;
+	/** The server's nonce, once the client has one ({@link DPOP_NONCE_HEADER}). */
+	nonce?: string;
+	/**
+	* The proof's unique id. Left out, the key's own `proofId()`, or 16 random bytes where the
+	* key has none. A proof is accepted once.
+	*/
+	jti?: string;
+	/** When the proof is made, in milliseconds since the epoch. Left out, now. */
+	now?: number;
+}
+/**
+* Whether a value is the public half of a device key and nothing more: exactly the four
+* members of {@link DevicePublicJwk}, each coordinate 32 bytes in its one canonical
+* base64url spelling (so that a key has one thumbprint). A key with a private member
+* (`d`) or any other field is refused: a client that sends its private key has none.
+*
+* It does not check that the point is on the curve; importing the key does.
+*
+* @param value - What a proof's header holds under `jwk`.
+* @returns `true` for a well-formed public P-256 key.
+* @example
+* ```ts
+* isDevicePublicJwk({ kty: 'EC', crv: 'P-256', x, y }) // true
+* isDevicePublicJwk({ kty: 'EC', crv: 'P-256', x, y, d }) // false
+* ```
+*/
+declare function isDevicePublicJwk(value: unknown): value is DevicePublicJwk;
+/**
+* Whether a value has the shape of a key thumbprint: 43 base64url characters (a SHA-256).
+*
+* @param value - A stored or received thumbprint.
+* @returns `true` for a well-formed one.
+* @example
+* ```ts
+* isKeyThumbprint(claims.cnf?.jkt)
+* ```
+*/
+declare function isKeyThumbprint(value: unknown): value is string;
+/**
+* The thumbprint of a device key (RFC 7638, SHA-256, base64url): what a bound session stores
+* and what its access token carries as `cnf.jkt`. Two keys have the same thumbprint only when
+* they are the same key.
+*
+* @param jwk - The public key.
+* @returns 43 base64url characters.
+* @example
+* ```ts
+* const jkt = await jwkThumbprint(key.publicJwk)
+* ```
+*/
+declare function jwkThumbprint(jwk: DevicePublicJwk): Promise<string>;
+/**
+* Make a proof for one request: a JWT of type `dpop+jwt`, signed by the device key, carrying
+* the key's public half in its header and the request's method (`htm`), the API's address
+* (`htu`), the time (`iat`), a unique id (`jti`) and the server's nonce.
+*
+* A proof is good for one request: make a new one every time, never keep or reuse one.
+*
+* @param key - The device key.
+* @param input - The request the proof is for, and the server's nonce.
+* @returns The compact JWT for the {@link DPOP_HEADER} header.
+* @example
+* ```ts
+* const proof = await createDpopProof(key, {
+*   method: 'POST',
+*   url: 'https://auth.example.com/v1/client/sessions/refresh',
+*   nonce,
+* })
+* ```
+*/
+declare function createDpopProof(key: DeviceKey, input: DpopProofInput): Promise<string>;
+/**
+* Make a device key in software, with WebCrypto: a fresh P-256 key pair whose private half is
+* **not extractable**, so the page or process that holds it can sign with it and cannot read
+* it. It lives in memory only; a client that wants it to outlive the process keeps the
+* `CryptoKey` where its platform allows (IndexedDB stores one without exposing it).
+*
+* This is what tests and the conformance runner bind with. It proves nothing about hardware:
+* a native SDK supplies its own {@link DeviceKey} backed by the Secure Enclave or StrongBox.
+*
+* @returns A key whose `sign` uses the private half.
+* @example
+* ```ts
+* const deviceKey = await generateSoftwareDeviceKey()
+* const tula = createTulaClient({ publishableKey, baseUrl, client: 'ios', deviceKey })
+* ```
+*/
+declare function generateSoftwareDeviceKey(): Promise<DeviceKey>;
+export { DPOP_ALGORITHMS, DPOP_HEADER, DPOP_NONCE_HEADER, DPOP_PROOF_TYPE, DeviceKey, DevicePublicJwk, DpopAlgorithm, DpopProofInput, MAX_DPOP_PROOF_LENGTH, createDpopProof, generateSoftwareDeviceKey, isDevicePublicJwk, isKeyThumbprint, jwkThumbprint };

package/dist/device-binding.js

@@ -0,0 +1,24 @@
+import {
+  DPOP_HEADER2,
+  DPOP_NONCE_HEADER2,
+  DPOP_PROOF_TYPE2,
+  DPOP_ALGORITHMS2,
+  MAX_DPOP_PROOF_LENGTH2,
+  isDevicePublicJwk2,
+  isKeyThumbprint2,
+  jwkThumbprint2,
+  createDpopProof2,
+  generateSoftwareDeviceKey2
+} from "./shared/chunk-4stpmame.js";
+export {
+  DPOP_ALGORITHMS2 as DPOP_ALGORITHMS,
+  DPOP_HEADER2 as DPOP_HEADER,
+  DPOP_NONCE_HEADER2 as DPOP_NONCE_HEADER,
+  DPOP_PROOF_TYPE2 as DPOP_PROOF_TYPE,
+  MAX_DPOP_PROOF_LENGTH2 as MAX_DPOP_PROOF_LENGTH,
+  createDpopProof2 as createDpopProof,
+  generateSoftwareDeviceKey2 as generateSoftwareDeviceKey,
+  isDevicePublicJwk2 as isDevicePublicJwk,
+  isKeyThumbprint2 as isKeyThumbprint,
+  jwkThumbprint2 as jwkThumbprint
+};