@oxyhq/contracts 0.2.0 → 0.3.0

package/dist/cjs/identity.js

@@ -0,0 +1,135 @@
+"use strict";
+/**
+ * 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()`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportBundleSchema = exports.exportAttestationSchema = exports.authMethodsResponseSchema = exports.authMethodEntrySchema = exports.domainVerificationInstructionsSchema = exports.domainVerificationRequestSchema = exports.verifiedDomainSchema = exports.signedRecordEnvelopeSchema = exports.didDocumentSchema = exports.didServiceSchema = exports.verificationMethodSchema = void 0;
+const zod_1 = require("zod");
+exports.verificationMethodSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    type: zod_1.z.literal('EcdsaSecp256k1VerificationKey2019'),
+    controller: zod_1.z.string(),
+    publicKeyHex: zod_1.z.string(),
+});
+exports.didServiceSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    type: zod_1.z.string(),
+    serviceEndpoint: zod_1.z.string(),
+});
+exports.didDocumentSchema = zod_1.z.object({
+    '@context': zod_1.z.array(zod_1.z.string()),
+    id: zod_1.z.string(),
+    controller: zod_1.z.array(zod_1.z.string()),
+    verificationMethod: zod_1.z.array(exports.verificationMethodSchema),
+    authentication: zod_1.z.array(zod_1.z.string()),
+    assertionMethod: zod_1.z.array(zod_1.z.string()),
+    alsoKnownAs: zod_1.z.array(zod_1.z.string()),
+    service: zod_1.z.array(exports.didServiceSchema),
+});
+exports.signedRecordEnvelopeSchema = zod_1.z.object({
+    version: zod_1.z.literal(1),
+    type: zod_1.z.enum(['identity', 'profile']),
+    subject: zod_1.z.string(),
+    issuer: zod_1.z.string(),
+    record: zod_1.z.record(zod_1.z.unknown()),
+    issuedAt: zod_1.z.number(),
+    publicKey: zod_1.z.string(),
+    alg: zod_1.z.literal('ES256K-DER-SHA256'),
+    signature: zod_1.z.string(),
+});
+exports.verifiedDomainSchema = zod_1.z.object({
+    domain: zod_1.z.string(),
+    verifiedAt: zod_1.z.union([zod_1.z.string(), zod_1.z.date()]),
+    method: zod_1.z.enum(['dns-txt', 'well-known']),
+});
+/** Request body for `POST /identity/domains` — the domain to start verifying. */
+exports.domainVerificationRequestSchema = zod_1.z.object({
+    domain: zod_1.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`.
+ */
+exports.domainVerificationInstructionsSchema = zod_1.z.object({
+    domain: zod_1.z.string(),
+    token: zod_1.z.string(),
+    dns: zod_1.z.object({
+        name: zod_1.z.string(),
+        value: zod_1.z.string(),
+    }),
+    wellKnown: zod_1.z.object({
+        url: zod_1.z.string(),
+        body: zod_1.z.string(),
+    }),
+});
+exports.authMethodEntrySchema = zod_1.z.object({
+    type: zod_1.z.enum(['identity', 'password', 'google', 'apple', 'github']),
+    linkedAt: zod_1.z.union([zod_1.z.string(), zod_1.z.date()]),
+    verificationMethodId: zod_1.z.string().optional(),
+});
+exports.authMethodsResponseSchema = zod_1.z.object({
+    did: zod_1.z.string(),
+    methods: zod_1.z.array(exports.authMethodEntrySchema),
+});
+exports.exportAttestationSchema = zod_1.z.object({
+    issuer: zod_1.z.string(),
+    publicKey: zod_1.z.string(),
+    alg: zod_1.z.literal('ES256K-DER-SHA256'),
+    signature: zod_1.z.string(),
+    signedAt: zod_1.z.number(),
+});
+exports.exportBundleSchema = zod_1.z.object({
+    '$schema': zod_1.z.string(),
+    exportedAt: zod_1.z.string(),
+    did: zod_1.z.string(),
+    didDocument: exports.didDocumentSchema,
+    profile: zod_1.z.record(zod_1.z.unknown()),
+    verifiedDomains: zod_1.z.array(exports.verifiedDomainSchema),
+    authMethods: zod_1.z.array(exports.authMethodEntrySchema),
+    signedRecords: zod_1.z.array(exports.signedRecordEnvelopeSchema),
+    appData: zod_1.z.array(zod_1.z.record(zod_1.z.unknown())),
+    social: zod_1.z.object({
+        following: zod_1.z.array(zod_1.z.string()),
+        followers: zod_1.z.array(zod_1.z.string()),
+    }),
+    attestation: exports.exportAttestationSchema.nullable(),
+    proof: exports.exportAttestationSchema.optional(),
+});

package/dist/cjs/index.js

@@ -11,7 +11,7 @@
  * expo, no `require()` in the ESM build.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.appUserSignalIngestSchema = exports.appInterestInputSchema = exports.appEndorsementInputSchema = exports.recommendationResponseSchema = exports.recommendationItemSchema = exports.recommendationCountSchema = exports.recommendationRequestSchema = exports.recommendationSignalWeightsSchema = exports.recommendationBoostSchema = exports.recommendationExcludeTypeSchema = exports.fedcmTokenPayloadSchema = exports.sessionStatusSchema = exports.publicApplicationSchema = exports.applicationTypeSchema = exports.safeParseContract = exports.resolveUserId = exports.deviceSessionsResponseSchema = exports.deviceSessionAccountSchema = exports.currentUserResponseSchema = exports.refreshAllResponseSchema = exports.refreshAllAccountSchema = exports.userProfileUpdateSchema = exports.userResponseSchema = exports.userNameSchema = void 0;
+exports.exportBundleSchema = exports.exportAttestationSchema = exports.authMethodsResponseSchema = exports.authMethodEntrySchema = exports.domainVerificationInstructionsSchema = exports.domainVerificationRequestSchema = exports.verifiedDomainSchema = exports.signedRecordEnvelopeSchema = exports.didDocumentSchema = exports.didServiceSchema = exports.verificationMethodSchema = exports.appUserSignalIngestSchema = exports.appInterestInputSchema = exports.appEndorsementInputSchema = exports.recommendationResponseSchema = exports.recommendationItemSchema = exports.recommendationCountSchema = exports.recommendationRequestSchema = exports.recommendationSignalWeightsSchema = exports.recommendationBoostSchema = exports.recommendationExcludeTypeSchema = exports.fedcmTokenPayloadSchema = exports.sessionStatusSchema = exports.publicApplicationSchema = exports.applicationTypeSchema = exports.safeParseContract = exports.resolveUserId = exports.deviceSessionsResponseSchema = exports.deviceSessionAccountSchema = exports.currentUserResponseSchema = exports.refreshAllResponseSchema = exports.refreshAllAccountSchema = exports.userProfileUpdateSchema = exports.userResponseSchema = exports.userNameSchema = void 0;
 var userResponse_1 = require("./userResponse");
 // Schemas
 Object.defineProperty(exports, "userNameSchema", { enumerable: true, get: function () { return userResponse_1.userNameSchema; } });
@@ -45,3 +45,16 @@ Object.defineProperty(exports, "recommendationResponseSchema", { enumerable: tru
 Object.defineProperty(exports, "appEndorsementInputSchema", { enumerable: true, get: function () { return recommendations_1.appEndorsementInputSchema; } });
 Object.defineProperty(exports, "appInterestInputSchema", { enumerable: true, get: function () { return recommendations_1.appInterestInputSchema; } });
 Object.defineProperty(exports, "appUserSignalIngestSchema", { enumerable: true, get: function () { return recommendations_1.appUserSignalIngestSchema; } });
+var identity_1 = require("./identity");
+// Schemas
+Object.defineProperty(exports, "verificationMethodSchema", { enumerable: true, get: function () { return identity_1.verificationMethodSchema; } });
+Object.defineProperty(exports, "didServiceSchema", { enumerable: true, get: function () { return identity_1.didServiceSchema; } });
+Object.defineProperty(exports, "didDocumentSchema", { enumerable: true, get: function () { return identity_1.didDocumentSchema; } });
+Object.defineProperty(exports, "signedRecordEnvelopeSchema", { enumerable: true, get: function () { return identity_1.signedRecordEnvelopeSchema; } });
+Object.defineProperty(exports, "verifiedDomainSchema", { enumerable: true, get: function () { return identity_1.verifiedDomainSchema; } });
+Object.defineProperty(exports, "domainVerificationRequestSchema", { enumerable: true, get: function () { return identity_1.domainVerificationRequestSchema; } });
+Object.defineProperty(exports, "domainVerificationInstructionsSchema", { enumerable: true, get: function () { return identity_1.domainVerificationInstructionsSchema; } });
+Object.defineProperty(exports, "authMethodEntrySchema", { enumerable: true, get: function () { return identity_1.authMethodEntrySchema; } });
+Object.defineProperty(exports, "authMethodsResponseSchema", { enumerable: true, get: function () { return identity_1.authMethodsResponseSchema; } });
+Object.defineProperty(exports, "exportAttestationSchema", { enumerable: true, get: function () { return identity_1.exportAttestationSchema; } });
+Object.defineProperty(exports, "exportBundleSchema", { enumerable: true, get: function () { return identity_1.exportBundleSchema; } });

package/dist/cjs/userResponse.js

@@ -36,17 +36,7 @@ exports.deviceSessionsResponseSchema = exports.deviceSessionAccountSchema = expo
 exports.resolveUserId = resolveUserId;
 exports.safeParseContract = safeParseContract;
 const zod_1 = require("zod");
-/**
- * Structured human name subdocument. Mirrors `User.name` (`NameSchema`).
- *
- * - `first` / `last` default to `''` in Mongo, so they are optional on the wire.
- * - `full` is a Mongoose virtual — absent unless the query materialised
- *   virtuals or the serializer composed it.
- * - `displayName` is the required canonical app-facing display string.
- *
- * `.passthrough()` is intentional: it tolerates additive name fields without a
- * coordinated contract bump, while the three known keys stay strongly typed.
- */
+const identity_1 = require("./identity");
 exports.userNameSchema = zod_1.z
     .object({
     first: zod_1.z.string().optional(),
@@ -79,6 +69,9 @@ exports.userResponseSchema = zod_1.z
     publicKey: zod_1.z.string().optional(),
     username: zod_1.z.string().optional(),
     email: zod_1.z.string().optional(),
+    phone: zod_1.z.string().optional(),
+    address: zod_1.z.string().optional(),
+    birthday: zod_1.z.string().optional(),
     /** Avatar file id (string) or null. */
     avatar: zod_1.z.string().nullable().optional(),
     /** Named Bloom color preset (e.g. `"blue"`) or null. */
@@ -86,6 +79,17 @@ exports.userResponseSchema = zod_1.z
     name: exports.userNameSchema,
     verified: zod_1.z.boolean().optional(),
     language: zod_1.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: zod_1.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: zod_1.z.array(identity_1.verifiedDomainSchema).optional(),
 })
     .passthrough();
 exports.userProfileUpdateSchema = zod_1.z
@@ -102,6 +106,9 @@ exports.userProfileUpdateSchema = zod_1.z
     color: zod_1.z.string().nullable().optional(),
     bio: zod_1.z.string().optional(),
     description: zod_1.z.string().optional(),
+    phone: zod_1.z.string().optional(),
+    address: zod_1.z.string().optional(),
+    birthday: zod_1.z.string().optional(),
     location: zod_1.z.string().optional(),
     locations: zod_1.z.array(zod_1.z.unknown()).optional(),
     links: zod_1.z.array(zod_1.z.string()).optional(),