@oxyhq/contracts 0.2.1 → 0.3.0

package/dist/esm/identity.js

@@ -0,0 +1,132 @@
+/**
+ * Self-sovereign identity API contracts.
+ *
+ * SINGLE SOURCE OF TRUTH for the wire shape of Oxy's AtProto/Bluesky-flavoured
+ * identity & portability layer: the W3C DID document the API derives on demand,
+ * the signed-record envelope clients sign with their cryptographic key (and the
+ * server verifies), the verified-domain badge, the auth-method ↔ DID
+ * verification-method mapping, and the signed data-export ("credible exit")
+ * bundle. The API validates its OUTPUT against these schemas; every consumer
+ * (the Commons vault app, `@oxyhq/core`'s identity mixin) validates its INPUT
+ * against the same definitions, so producer and consumers cannot drift.
+ *
+ * Design anchors (from the identity-layer plan):
+ *  - DID = `did:web:oxy.so:u:<userId>` — anchored on the stable account id, NOT
+ *    the keypair. The keypair is a *verification method* that maps 1:1 to the
+ *    existing `authMethods[]`. Custodial (password-only) users get a DID
+ *    controlled solely by Oxy (`OXY_DID`); creating a Commons key upgrades them
+ *    to self-sovereign (`controller = [userDid, OXY_DID]`); fully reversible.
+ *  - Verification methods use the secp256k1 `EcdsaSecp256k1VerificationKey2019`
+ *    type with `publicKeyHex` for now (a `Multikey`/`publicKeyMultibase` form may
+ *    be added later — see the plan's open risks).
+ *  - Signed records carry an envelope whose signing input is the canonical-JSON
+ *    of every field EXCEPT `publicKey` and `signature`; `alg` is
+ *    `ES256K-DER-SHA256` (secp256k1 over the SHA-256 of the canonical bytes,
+ *    DER-encoded signature) — the same scheme `SignatureService` uses.
+ *
+ * Explicit-`interface` exports (DidDocument, SignedRecordEnvelope, ExportBundle,
+ * VerifiedDomain, AuthMethodsResponse and their sub-parts) follow the same
+ * rationale as `UserNameResponse` in `./userResponse`: a `z.infer<>` of a nested
+ * object schema can degrade under a consumer's `moduleResolution: "node"`
+ * (node10) resolution, so the load-bearing response shapes are declared as
+ * literal interfaces and the runtime schemas are annotated `z.ZodType<Interface>`
+ * — the emitted `.d.ts` then states the field types verbatim and survives BOTH
+ * `node` and `bundler` resolution. Request schemas (no nested-object hazard) are
+ * inferred via `z.infer<>`.
+ *
+ * Platform-agnostic — zod only, no react/react-native/expo. ESM-safe (no
+ * `require()`).
+ */
+import { z } from 'zod';
+export const verificationMethodSchema = z.object({
+    id: z.string(),
+    type: z.literal('EcdsaSecp256k1VerificationKey2019'),
+    controller: z.string(),
+    publicKeyHex: z.string(),
+});
+export const didServiceSchema = z.object({
+    id: z.string(),
+    type: z.string(),
+    serviceEndpoint: z.string(),
+});
+export const didDocumentSchema = z.object({
+    '@context': z.array(z.string()),
+    id: z.string(),
+    controller: z.array(z.string()),
+    verificationMethod: z.array(verificationMethodSchema),
+    authentication: z.array(z.string()),
+    assertionMethod: z.array(z.string()),
+    alsoKnownAs: z.array(z.string()),
+    service: z.array(didServiceSchema),
+});
+export const signedRecordEnvelopeSchema = z.object({
+    version: z.literal(1),
+    type: z.enum(['identity', 'profile']),
+    subject: z.string(),
+    issuer: z.string(),
+    record: z.record(z.unknown()),
+    issuedAt: z.number(),
+    publicKey: z.string(),
+    alg: z.literal('ES256K-DER-SHA256'),
+    signature: z.string(),
+});
+export const verifiedDomainSchema = z.object({
+    domain: z.string(),
+    verifiedAt: z.union([z.string(), z.date()]),
+    method: z.enum(['dns-txt', 'well-known']),
+});
+/** Request body for `POST /identity/domains` — the domain to start verifying. */
+export const domainVerificationRequestSchema = z.object({
+    domain: z.string().trim().min(1),
+});
+/**
+ * The instructions the API returns when a domain verification is requested. The
+ * caller may prove ownership EITHER by publishing the `dns` TXT record OR by
+ * serving the `wellKnown` file; either path then satisfies
+ * `POST /identity/domains/:domain/verify`.
+ */
+export const domainVerificationInstructionsSchema = z.object({
+    domain: z.string(),
+    token: z.string(),
+    dns: z.object({
+        name: z.string(),
+        value: z.string(),
+    }),
+    wellKnown: z.object({
+        url: z.string(),
+        body: z.string(),
+    }),
+});
+export const authMethodEntrySchema = z.object({
+    type: z.enum(['identity', 'password', 'google', 'apple', 'github']),
+    linkedAt: z.union([z.string(), z.date()]),
+    verificationMethodId: z.string().optional(),
+});
+export const authMethodsResponseSchema = z.object({
+    did: z.string(),
+    methods: z.array(authMethodEntrySchema),
+});
+export const exportAttestationSchema = z.object({
+    issuer: z.string(),
+    publicKey: z.string(),
+    alg: z.literal('ES256K-DER-SHA256'),
+    signature: z.string(),
+    signedAt: z.number(),
+});
+export const exportBundleSchema = z.object({
+    '$schema': z.string(),
+    exportedAt: z.string(),
+    did: z.string(),
+    didDocument: didDocumentSchema,
+    profile: z.record(z.unknown()),
+    verifiedDomains: z.array(verifiedDomainSchema),
+    authMethods: z.array(authMethodEntrySchema),
+    signedRecords: z.array(signedRecordEnvelopeSchema),
+    appData: z.array(z.record(z.unknown())),
+    social: z.object({
+        following: z.array(z.string()),
+        followers: z.array(z.string()),
+    }),
+    attestation: exportAttestationSchema.nullable(),
+    proof: exportAttestationSchema.optional(),
+});

package/dist/esm/index.js

@@ -23,3 +23,6 @@ fedcmTokenPayloadSchema, } from './fedcmToken.js';
 export { 
 // Schemas
 recommendationExcludeTypeSchema, recommendationBoostSchema, recommendationSignalWeightsSchema, recommendationRequestSchema, recommendationCountSchema, recommendationItemSchema, recommendationResponseSchema, appEndorsementInputSchema, appInterestInputSchema, appUserSignalIngestSchema, } from './recommendations.js';
+export { 
+// Schemas
+verificationMethodSchema, didServiceSchema, didDocumentSchema, signedRecordEnvelopeSchema, verifiedDomainSchema, domainVerificationRequestSchema, domainVerificationInstructionsSchema, authMethodEntrySchema, authMethodsResponseSchema, exportAttestationSchema, exportBundleSchema, } from './identity.js';

package/dist/esm/userResponse.js

@@ -31,6 +31,7 @@
  * `require()`).
  */
 import { z } from 'zod';
+import { verifiedDomainSchema } from './identity.js';
 export const userNameSchema = z
     .object({
     first: z.string().optional(),
@@ -63,6 +64,9 @@ export const userResponseSchema = z
     publicKey: z.string().optional(),
     username: z.string().optional(),
     email: z.string().optional(),
+    phone: z.string().optional(),
+    address: z.string().optional(),
+    birthday: z.string().optional(),
     /** Avatar file id (string) or null. */
     avatar: z.string().nullable().optional(),
     /** Named Bloom color preset (e.g. `"blue"`) or null. */
@@ -70,6 +74,17 @@ export const userResponseSchema = z
     name: userNameSchema,
     verified: z.boolean().optional(),
     language: z.string().optional(),
+    /**
+     * The account's self-sovereign identifier
+     * (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
+     * virtual; present on formatted DTOs once the identity layer is live.
+     */
+    did: z.string().optional(),
+    /**
+     * Proven domain-ownership badges. Each is a {@link verifiedDomainSchema}
+     * entry; present only when the account has verified at least one domain.
+     */
+    verifiedDomains: z.array(verifiedDomainSchema).optional(),
 })
     .passthrough();
 export const userProfileUpdateSchema = z
@@ -86,6 +101,9 @@ export const userProfileUpdateSchema = z
     color: z.string().nullable().optional(),
     bio: z.string().optional(),
     description: z.string().optional(),
+    phone: z.string().optional(),
+    address: z.string().optional(),
+    birthday: z.string().optional(),
     location: z.string().optional(),
     locations: z.array(z.unknown()).optional(),
     links: z.array(z.string()).optional(),