@oxy.so/contracts 2.0.0 → 2.2.0

package/dist/types/inference/streamEvents.d.ts

@@ -77,16 +77,16 @@ export declare const inferenceStreamDeltaEventSchema: z.ZodObject<{
     channel: z.ZodEnum<["output_text", "reasoning", "refusal"]>;
     text: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    channel: "reasoning" | "refusal" | "output_text";
     type: "delta";
+    channel: "reasoning" | "refusal" | "output_text";
     schemaVersion: 1;
     requestId: string;
     text: string;
     sequence: number;
     outputIndex: number;
 }, {
-    channel: "reasoning" | "refusal" | "output_text";
     type: "delta";
+    channel: "reasoning" | "refusal" | "output_text";
     schemaVersion: 1;
     requestId: string;
     text: string;
@@ -421,14 +421,14 @@ export declare const inferenceStreamErrorEventSchema: z.ZodObject<{
             message: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
         }, "strict", z.ZodTypeAny, {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         }, {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         }>>;
     }, "strip", z.ZodTypeAny, {
         code: "cancelled" | "invalid_request" | "authentication_failed" | "permission_denied" | "insufficient_scope" | "model_not_found" | "unsupported_modality" | "context_length_exceeded" | "request_too_large" | "output_limit_exceeded" | "idempotency_conflict" | "insufficient_balance" | "spending_limit_exceeded" | "quota_exceeded" | "byok_credential_invalid" | "policy_violation" | "commercial_permission_denied" | "no_route_available" | "upstream_content_filtered" | "rate_limited" | "deployment_unavailable" | "provider_error" | "provider_timeout" | "provider_overloaded" | "provider_credential_invalid" | "provider_billing_refused" | "service_unavailable" | "internal_error";
@@ -441,9 +441,9 @@ export declare const inferenceStreamErrorEventSchema: z.ZodObject<{
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     }, {
         code: "cancelled" | "invalid_request" | "authentication_failed" | "permission_denied" | "insufficient_scope" | "model_not_found" | "unsupported_modality" | "context_length_exceeded" | "request_too_large" | "output_limit_exceeded" | "idempotency_conflict" | "insufficient_balance" | "spending_limit_exceeded" | "quota_exceeded" | "byok_credential_invalid" | "policy_violation" | "commercial_permission_denied" | "no_route_available" | "upstream_content_filtered" | "rate_limited" | "deployment_unavailable" | "provider_error" | "provider_timeout" | "provider_overloaded" | "provider_credential_invalid" | "provider_billing_refused" | "service_unavailable" | "internal_error";
@@ -456,9 +456,9 @@ export declare const inferenceStreamErrorEventSchema: z.ZodObject<{
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     }>, {
         code: "cancelled" | "invalid_request" | "authentication_failed" | "permission_denied" | "insufficient_scope" | "model_not_found" | "unsupported_modality" | "context_length_exceeded" | "request_too_large" | "output_limit_exceeded" | "idempotency_conflict" | "insufficient_balance" | "spending_limit_exceeded" | "quota_exceeded" | "byok_credential_invalid" | "policy_violation" | "commercial_permission_denied" | "no_route_available" | "upstream_content_filtered" | "rate_limited" | "deployment_unavailable" | "provider_error" | "provider_timeout" | "provider_overloaded" | "provider_credential_invalid" | "provider_billing_refused" | "service_unavailable" | "internal_error";
@@ -471,9 +471,9 @@ export declare const inferenceStreamErrorEventSchema: z.ZodObject<{
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     }, {
         code: "cancelled" | "invalid_request" | "authentication_failed" | "permission_denied" | "insufficient_scope" | "model_not_found" | "unsupported_modality" | "context_length_exceeded" | "request_too_large" | "output_limit_exceeded" | "idempotency_conflict" | "insufficient_balance" | "spending_limit_exceeded" | "quota_exceeded" | "byok_credential_invalid" | "policy_violation" | "commercial_permission_denied" | "no_route_available" | "upstream_content_filtered" | "rate_limited" | "deployment_unavailable" | "provider_error" | "provider_timeout" | "provider_overloaded" | "provider_credential_invalid" | "provider_billing_refused" | "service_unavailable" | "internal_error";
@@ -486,9 +486,9 @@ export declare const inferenceStreamErrorEventSchema: z.ZodObject<{
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
@@ -506,9 +506,9 @@ export declare const inferenceStreamErrorEventSchema: z.ZodObject<{
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     };
     sequence: number;
@@ -527,9 +527,9 @@ export declare const inferenceStreamErrorEventSchema: z.ZodObject<{
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     };
     sequence: number;
@@ -626,16 +626,16 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
     channel: z.ZodEnum<["output_text", "reasoning", "refusal"]>;
     text: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    channel: "reasoning" | "refusal" | "output_text";
     type: "delta";
+    channel: "reasoning" | "refusal" | "output_text";
     schemaVersion: 1;
     requestId: string;
     text: string;
     sequence: number;
     outputIndex: number;
 }, {
-    channel: "reasoning" | "refusal" | "output_text";
     type: "delta";
+    channel: "reasoning" | "refusal" | "output_text";
     schemaVersion: 1;
     requestId: string;
     text: string;
@@ -851,14 +851,14 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
             message: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
         }, "strict", z.ZodTypeAny, {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         }, {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         }>>;
     }, "strip", z.ZodTypeAny, {
         code: "cancelled" | "invalid_request" | "authentication_failed" | "permission_denied" | "insufficient_scope" | "model_not_found" | "unsupported_modality" | "context_length_exceeded" | "request_too_large" | "output_limit_exceeded" | "idempotency_conflict" | "insufficient_balance" | "spending_limit_exceeded" | "quota_exceeded" | "byok_credential_invalid" | "policy_violation" | "commercial_permission_denied" | "no_route_available" | "upstream_content_filtered" | "rate_limited" | "deployment_unavailable" | "provider_error" | "provider_timeout" | "provider_overloaded" | "provider_credential_invalid" | "provider_billing_refused" | "service_unavailable" | "internal_error";
@@ -871,9 +871,9 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     }, {
         code: "cancelled" | "invalid_request" | "authentication_failed" | "permission_denied" | "insufficient_scope" | "model_not_found" | "unsupported_modality" | "context_length_exceeded" | "request_too_large" | "output_limit_exceeded" | "idempotency_conflict" | "insufficient_balance" | "spending_limit_exceeded" | "quota_exceeded" | "byok_credential_invalid" | "policy_violation" | "commercial_permission_denied" | "no_route_available" | "upstream_content_filtered" | "rate_limited" | "deployment_unavailable" | "provider_error" | "provider_timeout" | "provider_overloaded" | "provider_credential_invalid" | "provider_billing_refused" | "service_unavailable" | "internal_error";
@@ -886,9 +886,9 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     }>, {
         code: "cancelled" | "invalid_request" | "authentication_failed" | "permission_denied" | "insufficient_scope" | "model_not_found" | "unsupported_modality" | "context_length_exceeded" | "request_too_large" | "output_limit_exceeded" | "idempotency_conflict" | "insufficient_balance" | "spending_limit_exceeded" | "quota_exceeded" | "byok_credential_invalid" | "policy_violation" | "commercial_permission_denied" | "no_route_available" | "upstream_content_filtered" | "rate_limited" | "deployment_unavailable" | "provider_error" | "provider_timeout" | "provider_overloaded" | "provider_credential_invalid" | "provider_billing_refused" | "service_unavailable" | "internal_error";
@@ -901,9 +901,9 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     }, {
         code: "cancelled" | "invalid_request" | "authentication_failed" | "permission_denied" | "insufficient_scope" | "model_not_found" | "unsupported_modality" | "context_length_exceeded" | "request_too_large" | "output_limit_exceeded" | "idempotency_conflict" | "insufficient_balance" | "spending_limit_exceeded" | "quota_exceeded" | "byok_credential_invalid" | "policy_violation" | "commercial_permission_denied" | "no_route_available" | "upstream_content_filtered" | "rate_limited" | "deployment_unavailable" | "provider_error" | "provider_timeout" | "provider_overloaded" | "provider_credential_invalid" | "provider_billing_refused" | "service_unavailable" | "internal_error";
@@ -916,9 +916,9 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
@@ -936,9 +936,9 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     };
     sequence: number;
@@ -957,9 +957,9 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
         upstreamCategory?: "unknown" | "authentication" | "invalid_request" | "rate_limit" | "quota" | "timeout" | "overloaded" | "server_error" | "content_filter" | undefined;
         providerError?: {
             provider: string;
+            status?: number | undefined;
             code?: string | undefined;
             message?: string | undefined;
-            status?: number | undefined;
         } | undefined;
     };
     sequence: number;

package/dist/types/keyRecovery.d.ts

@@ -62,17 +62,17 @@ export declare const encryptedBackupEnvelopeSchema: z.ZodObject<{
     version: number;
     createdAt: string;
     nonce: string;
-    ciphertext: string;
     algorithm: "xchacha20poly1305";
     kdfInfo: string;
+    ciphertext: string;
     publicKeyHint: string;
 }, {
     version: number;
     createdAt: string;
     nonce: string;
-    ciphertext: string;
     algorithm: "xchacha20poly1305";
     kdfInfo: string;
+    ciphertext: string;
     publicKeyHint: string;
 }>;
 export type EncryptedBackupEnvelope = z.infer<typeof encryptedBackupEnvelopeSchema>;
@@ -101,18 +101,18 @@ export declare const backupUploadRequestSchema: z.ZodObject<{
     version: number;
     createdAt: string;
     nonce: string;
-    ciphertext: string;
     algorithm: "xchacha20poly1305";
     kdfInfo: string;
+    ciphertext: string;
     publicKeyHint: string;
     lookupId: string;
 }, {
     version: number;
     createdAt: string;
     nonce: string;
-    ciphertext: string;
     algorithm: "xchacha20poly1305";
     kdfInfo: string;
+    ciphertext: string;
     publicKeyHint: string;
     lookupId: string;
 }>;

package/dist/types/linkedAccounts.d.ts

@@ -339,3 +339,36 @@ export type ServiceLinkedAccountListResponse = z.infer<typeof serviceLinkedAccou
  */
 export declare const LINKED_ACCOUNT_CALLBACK_ERRORS: readonly ["access_denied", "verification_failed", "provider_unavailable"];
 export type LinkedAccountCallbackError = (typeof LINKED_ACCOUNT_CALLBACK_ERRORS)[number];
+/**
+ * Why `POST /linked-accounts/:network/start` refused, as `details.reason` on
+ * its 400 (`{ error: 'BAD_REQUEST', message, details: { reason } }`). The
+ * message is for logs; show the user a text chosen from the reason.
+ *
+ * - `instance_invalid`: the ActivityPub `instance` is not a server name.
+ * - `instance_unreachable`: the server does not resolve to a public address, or
+ *   could not be connected to.
+ * - `handle_unresolvable`: the atproto handle or DID does not resolve to an
+ *   account. The only reason that means "check what you typed".
+ * - `provider_rejected`: the other network answered and refused Oxy's
+ *   request — for atproto an authorization-server error such as
+ *   `invalid_client_metadata`; for a Mastodon-API server a refused app
+ *   registration (often: not a Mastodon-compatible server). Nothing the user
+ *   typed is wrong.
+ * - `provider_unavailable`: the other network could not be asked right now
+ *   (its OAuth metadata did not load, a 5xx, a timeout). Try again later.
+ *
+ * A refusal with no `details.reason` (a bad `returnTo`, a missing field) is a
+ * client bug, not something to show.
+ */
+export declare const LINKED_ACCOUNT_START_ERROR_REASONS: readonly ["instance_invalid", "instance_unreachable", "handle_unresolvable", "provider_rejected", "provider_unavailable"];
+export type LinkedAccountStartErrorReason = (typeof LINKED_ACCOUNT_START_ERROR_REASONS)[number];
+export declare const linkedAccountStartErrorReasonSchema: z.ZodEnum<["instance_invalid", "instance_unreachable", "handle_unresolvable", "provider_rejected", "provider_unavailable"]>;
+/** The `details` of a start refusal. */
+export declare const linkedAccountStartErrorDetailsSchema: z.ZodObject<{
+    reason: z.ZodEnum<["instance_invalid", "instance_unreachable", "handle_unresolvable", "provider_rejected", "provider_unavailable"]>;
+}, "strict", z.ZodTypeAny, {
+    reason: "provider_unavailable" | "instance_invalid" | "instance_unreachable" | "handle_unresolvable" | "provider_rejected";
+}, {
+    reason: "provider_unavailable" | "instance_invalid" | "instance_unreachable" | "handle_unresolvable" | "provider_rejected";
+}>;
+export type LinkedAccountStartErrorDetails = z.infer<typeof linkedAccountStartErrorDetailsSchema>;

package/dist/types/notifications.d.ts

@@ -91,3 +91,29 @@ export declare const createOxyNotificationRequestSchema: z.ZodEffects<z.ZodObjec
     title?: string | undefined;
 }>;
 export type CreateOxyNotificationRequest = z.infer<typeof createOxyNotificationRequestSchema>;
+/**
+ * Android notification channel a `system` notification is pushed on — a wire
+ * contract, because Android 8+ silently drops a push whose channel the app has
+ * not created. Created by the vault (Commons) before it registers its token.
+ */
+export declare const OXY_ACCOUNT_PUSH_CHANNEL = "account";
+/** Runtime type discriminator of the push that announces a `system` notification. */
+export declare const OXY_SYSTEM_NOTIFICATION_PUSH_TYPE = "oxy_system_notification";
+/**
+ * The ONLY data a `system` notification's push carries: its id. The title and
+ * message ride as the push's own title and body; the deep link does NOT travel,
+ * because a push payload is untrusted at the receiver. On a tap the vault
+ * re-reads the notification from Oxy by id (scoped to the signed-in recipient)
+ * and opens the `url` stored there.
+ */
+export declare const oxySystemNotificationPushDataSchema: z.ZodObject<{
+    type: z.ZodLiteral<"oxy_system_notification">;
+    notificationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "oxy_system_notification";
+    notificationId: string;
+}, {
+    type: "oxy_system_notification";
+    notificationId: string;
+}>;
+export type OxySystemNotificationPushData = z.infer<typeof oxySystemNotificationPushDataSchema>;

package/dist/types/sessionStatus.d.ts

@@ -179,6 +179,7 @@ export declare const sessionStatusSchema: z.ZodObject<{
     openedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     status: string;
+    purpose?: "device_sign_in" | "oauth_authorization" | undefined;
     expiresAt?: string | undefined;
     publicKey?: string | null | undefined;
     userId?: string | null | undefined;
@@ -199,11 +200,11 @@ export declare const sessionStatusSchema: z.ZodObject<{
         termsUrl?: string | undefined;
         developerName?: string | undefined;
     } | null | undefined;
-    purpose?: "device_sign_in" | "oauth_authorization" | undefined;
     pushSentAt?: string | null | undefined;
     openedAt?: string | null | undefined;
 }, {
     status: string;
+    purpose?: "device_sign_in" | "oauth_authorization" | undefined;
     expiresAt?: string | undefined;
     publicKey?: string | null | undefined;
     userId?: string | null | undefined;
@@ -224,7 +225,6 @@ export declare const sessionStatusSchema: z.ZodObject<{
         termsUrl?: string | undefined;
         developerName?: string | undefined;
     } | null | undefined;
-    purpose?: "device_sign_in" | "oauth_authorization" | undefined;
     pushSentAt?: string | null | undefined;
     openedAt?: string | null | undefined;
 }>;

package/dist/types/userResponse.d.ts

@@ -969,8 +969,9 @@ export declare const currentUserResponseSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     data: {
         name: UserNameResponse;
-        kind?: "bot" | "personal" | "organization" | "project" | "channel" | undefined;
+        email?: string | undefined;
         username?: string | undefined;
+        kind?: "bot" | "personal" | "organization" | "project" | "channel" | undefined;
         avatar?: string | null | undefined;
         color?: string | null | undefined;
         accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "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;
@@ -980,7 +981,6 @@ export declare const currentUserResponseSchema: z.ZodObject<{
         did?: string | undefined;
         verifiedDomains?: import("./identity").VerifiedDomain[] | undefined;
         _id?: string | undefined;
-        email?: string | undefined;
         phone?: string | undefined;
         address?: string | undefined;
         birthday?: string | undefined;
@@ -995,8 +995,9 @@ export declare const currentUserResponseSchema: z.ZodObject<{
 }, {
     data: {
         name: UserNameResponse;
-        kind?: "bot" | "personal" | "organization" | "project" | "channel" | undefined;
+        email?: string | undefined;
         username?: string | undefined;
+        kind?: "bot" | "personal" | "organization" | "project" | "channel" | undefined;
         avatar?: string | null | undefined;
         color?: string | null | undefined;
         accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "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;
@@ -1006,7 +1007,6 @@ export declare const currentUserResponseSchema: z.ZodObject<{
         did?: string | undefined;
         verifiedDomains?: import("./identity").VerifiedDomain[] | undefined;
         _id?: string | undefined;
-        email?: string | undefined;
         phone?: string | undefined;
         address?: string | undefined;
         birthday?: string | undefined;