@oxy.so/contracts 1.0.1 → 1.1.1

package/dist/types/userResponse.d.ts

@@ -812,6 +812,7 @@ export declare const currentUserResponseSchema: z.ZodObject<{
         accountCategories?: ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
         id?: string | undefined;
         publicKey?: string | undefined;
+        verified?: boolean | undefined;
         did?: string | undefined;
         verifiedDomains?: import("./identity").VerifiedDomain[] | undefined;
         _id?: string | undefined;
@@ -819,7 +820,6 @@ export declare const currentUserResponseSchema: z.ZodObject<{
         phone?: string | undefined;
         address?: string | undefined;
         birthday?: string | undefined;
-        verified?: boolean | undefined;
         languages?: string[] | undefined;
         relationship?: UserRelationship | undefined;
         themePreference?: ThemePreference | undefined;
@@ -836,6 +836,7 @@ export declare const currentUserResponseSchema: z.ZodObject<{
         accountCategories?: ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
         id?: string | undefined;
         publicKey?: string | undefined;
+        verified?: boolean | undefined;
         did?: string | undefined;
         verifiedDomains?: import("./identity").VerifiedDomain[] | undefined;
         _id?: string | undefined;
@@ -843,7 +844,6 @@ export declare const currentUserResponseSchema: z.ZodObject<{
         phone?: string | undefined;
         address?: string | undefined;
         birthday?: string | undefined;
-        verified?: boolean | undefined;
         languages?: string[] | undefined;
         relationship?: UserRelationship | undefined;
         themePreference?: ThemePreference | undefined;

package/dist/types/webauthn.d.ts

@@ -3,7 +3,7 @@
  *
  * These schemas describe ONLY the outer Oxy envelope that wraps a WebAuthn
  * ceremony request — the username the client is registering/authenticating as,
- * plus the device-session options every first-party sign-in accepts. The browser
+ * plus non-authoritative device metadata. The browser
  * `RegistrationResponseJSON` / `AuthenticationResponseJSON` payloads are NOT
  * mirrored here: they are validated by `@simplewebauthn/server` inside the route
  * (`verifyRegistrationResponse` / `verifyAuthenticationResponse`), which is the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxy.so/contracts",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "OxyHQ API contracts — single source of truth for request/response Zod schemas and inferred types, shared by the backend and the client SDKs",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/dist/cjs/links.js

@@ -1,68 +0,0 @@
-"use strict";
-/**
- * Link-preview / unfurl API contracts.
- *
- * SINGLE SOURCE OF TRUTH for the wire shape of Oxy's link-preview ("unfurl")
- * resolution surface: the single `GET` lookup and the `POST` batch lookup that
- * every app calls through the SDK so apps stop duplicating their own
- * link-metadata fetching. The API validates its OUTPUT against these schemas;
- * every consumer (`@oxy.so/core`'s link mixin and the apps that call it)
- * validates its INPUT against the same definitions, so producer and consumers
- * cannot drift.
- *
- * Design anchors:
- *  - Oxy owns resolution. The `image` (and `favicon`) URLs a preview carries are
- *    re-hosted on Oxy media (`cloud.oxy.so/<fileId>`), never raw remote URLs —
- *    apps render them directly with no per-app proxy.
- *  - Resolution is best-effort and asynchronous. A preview is `'resolved'` once
- *    metadata is materialised, `'pending'` while a first-seen URL is being
- *    fetched in the background, or `'empty'` when the target yielded no usable
- *    metadata. `resolvedAt` (ISO datetime) is present only once `'resolved'`.
- *  - The batch response is keyed by the REQUESTED url (the exact string the
- *    caller sent), not the canonical/final URL, so a caller can always look its
- *    own input back up; the canonical URL lives on `LinkPreview.url`.
- *
- * The `LinkPreview` / `LinkPreviewBatchResponse` exports are declared as explicit
- * `interface`s (with their runtime schemas annotated `z.ZodType<Interface>`),
- * following the same rationale as `UserNameResponse` in `./userResponse`: a
- * `z.infer<>` of a nested-object schema can degrade to `{}` under a consumer's
- * `moduleResolution: "node"` (node10) resolution. A literal interface emits the
- * field types verbatim in the `.d.ts` and survives BOTH `node` and `bundler`
- * resolution. The flat batch-request schema (no nested-object hazard) is inferred
- * via `z.infer<>`.
- *
- * Platform-agnostic — zod only, no react/react-native/expo. ESM-safe (no
- * `require()`).
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.linkPreviewResponseSchema = exports.linkPreviewBatchResponseSchema = exports.linkPreviewBatchRequestSchema = exports.linkPreviewSchema = void 0;
-const zod_1 = require("zod");
-exports.linkPreviewSchema = zod_1.z.object({
-    url: zod_1.z.string(),
-    status: zod_1.z.enum(['resolved', 'pending', 'empty']),
-    title: zod_1.z.string().optional(),
-    description: zod_1.z.string().optional(),
-    image: zod_1.z.string().optional(),
-    siteName: zod_1.z.string().optional(),
-    favicon: zod_1.z.string().optional(),
-    resolvedAt: zod_1.z.string().optional(),
-});
-/* -------------------------------------------------------------------------- */
-/*  Batch request / response                                                  */
-/* -------------------------------------------------------------------------- */
-/**
- * Request body for the batch unfurl endpoint. Between 1 and 50 URLs per call;
- * the server resolves each (returning a `'pending'` placeholder for any URL it
- * has not seen before and is fetching in the background).
- */
-exports.linkPreviewBatchRequestSchema = zod_1.z.object({
-    urls: zod_1.z.array(zod_1.z.string().max(2048)).min(1).max(50),
-});
-exports.linkPreviewBatchResponseSchema = zod_1.z.object({
-    data: zod_1.z.record(zod_1.z.string(), exports.linkPreviewSchema),
-});
-/**
- * Wire shape of the single-URL unfurl lookup (`GET`) — a bare
- * {@link LinkPreview}.
- */
-exports.linkPreviewResponseSchema = exports.linkPreviewSchema;

package/dist/esm/links.js

@@ -1,65 +0,0 @@
-/**
- * Link-preview / unfurl API contracts.
- *
- * SINGLE SOURCE OF TRUTH for the wire shape of Oxy's link-preview ("unfurl")
- * resolution surface: the single `GET` lookup and the `POST` batch lookup that
- * every app calls through the SDK so apps stop duplicating their own
- * link-metadata fetching. The API validates its OUTPUT against these schemas;
- * every consumer (`@oxy.so/core`'s link mixin and the apps that call it)
- * validates its INPUT against the same definitions, so producer and consumers
- * cannot drift.
- *
- * Design anchors:
- *  - Oxy owns resolution. The `image` (and `favicon`) URLs a preview carries are
- *    re-hosted on Oxy media (`cloud.oxy.so/<fileId>`), never raw remote URLs —
- *    apps render them directly with no per-app proxy.
- *  - Resolution is best-effort and asynchronous. A preview is `'resolved'` once
- *    metadata is materialised, `'pending'` while a first-seen URL is being
- *    fetched in the background, or `'empty'` when the target yielded no usable
- *    metadata. `resolvedAt` (ISO datetime) is present only once `'resolved'`.
- *  - The batch response is keyed by the REQUESTED url (the exact string the
- *    caller sent), not the canonical/final URL, so a caller can always look its
- *    own input back up; the canonical URL lives on `LinkPreview.url`.
- *
- * The `LinkPreview` / `LinkPreviewBatchResponse` exports are declared as explicit
- * `interface`s (with their runtime schemas annotated `z.ZodType<Interface>`),
- * following the same rationale as `UserNameResponse` in `./userResponse`: a
- * `z.infer<>` of a nested-object schema can degrade to `{}` under a consumer's
- * `moduleResolution: "node"` (node10) resolution. A literal interface emits the
- * field types verbatim in the `.d.ts` and survives BOTH `node` and `bundler`
- * resolution. The flat batch-request schema (no nested-object hazard) is inferred
- * via `z.infer<>`.
- *
- * Platform-agnostic — zod only, no react/react-native/expo. ESM-safe (no
- * `require()`).
- */
-import { z } from 'zod';
-export const linkPreviewSchema = z.object({
-    url: z.string(),
-    status: z.enum(['resolved', 'pending', 'empty']),
-    title: z.string().optional(),
-    description: z.string().optional(),
-    image: z.string().optional(),
-    siteName: z.string().optional(),
-    favicon: z.string().optional(),
-    resolvedAt: z.string().optional(),
-});
-/* -------------------------------------------------------------------------- */
-/*  Batch request / response                                                  */
-/* -------------------------------------------------------------------------- */
-/**
- * Request body for the batch unfurl endpoint. Between 1 and 50 URLs per call;
- * the server resolves each (returning a `'pending'` placeholder for any URL it
- * has not seen before and is fetching in the background).
- */
-export const linkPreviewBatchRequestSchema = z.object({
-    urls: z.array(z.string().max(2048)).min(1).max(50),
-});
-export const linkPreviewBatchResponseSchema = z.object({
-    data: z.record(z.string(), linkPreviewSchema),
-});
-/**
- * Wire shape of the single-URL unfurl lookup (`GET`) — a bare
- * {@link LinkPreview}.
- */
-export const linkPreviewResponseSchema = linkPreviewSchema;

package/dist/types/links.d.ts

@@ -1,96 +0,0 @@
-/**
- * Link-preview / unfurl API contracts.
- *
- * SINGLE SOURCE OF TRUTH for the wire shape of Oxy's link-preview ("unfurl")
- * resolution surface: the single `GET` lookup and the `POST` batch lookup that
- * every app calls through the SDK so apps stop duplicating their own
- * link-metadata fetching. The API validates its OUTPUT against these schemas;
- * every consumer (`@oxy.so/core`'s link mixin and the apps that call it)
- * validates its INPUT against the same definitions, so producer and consumers
- * cannot drift.
- *
- * Design anchors:
- *  - Oxy owns resolution. The `image` (and `favicon`) URLs a preview carries are
- *    re-hosted on Oxy media (`cloud.oxy.so/<fileId>`), never raw remote URLs —
- *    apps render them directly with no per-app proxy.
- *  - Resolution is best-effort and asynchronous. A preview is `'resolved'` once
- *    metadata is materialised, `'pending'` while a first-seen URL is being
- *    fetched in the background, or `'empty'` when the target yielded no usable
- *    metadata. `resolvedAt` (ISO datetime) is present only once `'resolved'`.
- *  - The batch response is keyed by the REQUESTED url (the exact string the
- *    caller sent), not the canonical/final URL, so a caller can always look its
- *    own input back up; the canonical URL lives on `LinkPreview.url`.
- *
- * The `LinkPreview` / `LinkPreviewBatchResponse` exports are declared as explicit
- * `interface`s (with their runtime schemas annotated `z.ZodType<Interface>`),
- * following the same rationale as `UserNameResponse` in `./userResponse`: a
- * `z.infer<>` of a nested-object schema can degrade to `{}` under a consumer's
- * `moduleResolution: "node"` (node10) resolution. A literal interface emits the
- * field types verbatim in the `.d.ts` and survives BOTH `node` and `bundler`
- * resolution. The flat batch-request schema (no nested-object hazard) is inferred
- * via `z.infer<>`.
- *
- * Platform-agnostic — zod only, no react/react-native/expo. ESM-safe (no
- * `require()`).
- */
-import { z } from 'zod';
-/**
- * Resolution state of a {@link LinkPreview}.
- *
- * - `resolved` — metadata materialised; `resolvedAt` is present.
- * - `pending`  — a first-seen URL is being fetched in the background; metadata
- *   fields and `resolvedAt` may be absent. The caller may re-fetch shortly.
- * - `empty`    — the target yielded no usable metadata (e.g. a bare binary, a
- *   404, or an opted-out host); the negative result is cached.
- */
-export type LinkPreviewStatus = 'resolved' | 'pending' | 'empty';
-/**
- * A single resolved (or in-flight) link preview.
- *
- * `url` is the canonical / final resolved URL (after redirects). The optional
- * metadata fields are present on a best-effort basis once `status` is
- * `'resolved'`. `image` and `favicon` are absolute Oxy-hosted
- * (`cloud.oxy.so/<fileId>`) URLs — render them directly, never proxy them.
- */
-export interface LinkPreview {
-    /** Canonical / final resolved URL (after following redirects). */
-    url: string;
-    status: LinkPreviewStatus;
-    title?: string;
-    description?: string;
-    /** Absolute Oxy-hosted (`cloud.oxy.so`) image URL. */
-    image?: string;
-    siteName?: string;
-    /** Absolute Oxy-hosted (`cloud.oxy.so`) favicon URL. */
-    favicon?: string;
-    /** ISO 8601 datetime of resolution; absent while `status` is `'pending'`. */
-    resolvedAt?: string;
-}
-export declare const linkPreviewSchema: z.ZodType<LinkPreview>;
-/**
- * Request body for the batch unfurl endpoint. Between 1 and 50 URLs per call;
- * the server resolves each (returning a `'pending'` placeholder for any URL it
- * has not seen before and is fetching in the background).
- */
-export declare const linkPreviewBatchRequestSchema: z.ZodObject<{
-    urls: z.ZodArray<z.ZodString, "many">;
-}, "strip", z.ZodTypeAny, {
-    urls: string[];
-}, {
-    urls: string[];
-}>;
-export type LinkPreviewBatchRequest = z.infer<typeof linkPreviewBatchRequestSchema>;
-/**
- * Batch unfurl response. `data` is keyed by the REQUESTED url (the exact string
- * the caller sent in `urls`), so a caller can always look its own input back up;
- * the canonical/final URL is on each {@link LinkPreview}'s `url` field.
- */
-export interface LinkPreviewBatchResponse {
-    data: Record<string, LinkPreview>;
-}
-export declare const linkPreviewBatchResponseSchema: z.ZodType<LinkPreviewBatchResponse>;
-/**
- * Wire shape of the single-URL unfurl lookup (`GET`) — a bare
- * {@link LinkPreview}.
- */
-export declare const linkPreviewResponseSchema: z.ZodType<LinkPreview, z.ZodTypeDef, LinkPreview>;