@oxyhq/contracts 0.13.1 → 0.13.2

package/dist/types/accountGraph.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Account graph wire contracts — organization taxonomy and create-account input.
+ *
+ * `organizationCategory` classifies `kind: 'organization'` accounts (agency,
+ * cooperative, landlord, …) without polluting `User.kind`. Meaningful only when
+ * `kind === 'organization'`.
+ */
+import { z } from 'zod';
+export declare const ORGANIZATION_CATEGORIES: readonly ["agency", "cooperative", "landlord", "other"];
+export type OrganizationCategory = (typeof ORGANIZATION_CATEGORIES)[number];
+export declare const organizationCategorySchema: z.ZodEnum<["agency", "cooperative", "landlord", "other"]>;
+/**
+ * POST /accounts — create a non-personal account under the caller's tree.
+ * `organizationCategory` is accepted only when `kind` is `organization`.
+ */
+export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
+    parentAccountId: z.ZodOptional<z.ZodString>;
+    kind: z.ZodEnum<["organization", "project", "bot"]>;
+    username: z.ZodString;
+    name: z.ZodOptional<z.ZodObject<{
+        first: z.ZodOptional<z.ZodString>;
+        last: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        first?: string | undefined;
+        last?: string | undefined;
+    }, {
+        first?: string | undefined;
+        last?: string | undefined;
+    }>>;
+    bio: z.ZodOptional<z.ZodString>;
+    avatar: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
+}, "strip", z.ZodTypeAny, {
+    kind: "organization" | "project" | "bot";
+    username: string;
+    parentAccountId?: string | undefined;
+    name?: {
+        first?: string | undefined;
+        last?: string | undefined;
+    } | undefined;
+    bio?: string | undefined;
+    avatar?: string | undefined;
+    description?: string | undefined;
+    organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
+}, {
+    kind: "organization" | "project" | "bot";
+    username: string;
+    parentAccountId?: string | undefined;
+    name?: {
+        first?: string | undefined;
+        last?: string | undefined;
+    } | undefined;
+    bio?: string | undefined;
+    avatar?: string | undefined;
+    description?: string | undefined;
+    organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
+}>, {
+    kind: "organization" | "project" | "bot";
+    username: string;
+    parentAccountId?: string | undefined;
+    name?: {
+        first?: string | undefined;
+        last?: string | undefined;
+    } | undefined;
+    bio?: string | undefined;
+    avatar?: string | undefined;
+    description?: string | undefined;
+    organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
+}, {
+    kind: "organization" | "project" | "bot";
+    username: string;
+    parentAccountId?: string | undefined;
+    name?: {
+        first?: string | undefined;
+        last?: string | undefined;
+    } | undefined;
+    bio?: string | undefined;
+    avatar?: string | undefined;
+    description?: string | undefined;
+    organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
+}>;
+export type CreateAccountRequest = z.infer<typeof createAccountRequestSchema>;

package/dist/types/identity.d.ts

@@ -82,13 +82,13 @@ export declare const verificationMethodSchema: z.ZodDiscriminatedUnion<"type", [
     controller: z.ZodString;
     publicKeyHex: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    id: string;
     type: "EcdsaSecp256k1VerificationKey2019";
+    id: string;
     controller: string;
     publicKeyHex: string;
 }, {
-    id: string;
     type: "EcdsaSecp256k1VerificationKey2019";
+    id: string;
     controller: string;
     publicKeyHex: string;
 }>, z.ZodObject<{
@@ -97,13 +97,13 @@ export declare const verificationMethodSchema: z.ZodDiscriminatedUnion<"type", [
     controller: z.ZodString;
     publicKeyMultibase: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    id: string;
     type: "Multikey";
+    id: string;
     controller: string;
     publicKeyMultibase: string;
 }, {
-    id: string;
     type: "Multikey";
+    id: string;
     controller: string;
     publicKeyMultibase: string;
 }>]>;

package/dist/types/index.d.ts

@@ -9,6 +9,8 @@
  * Platform-agnostic — zod is the only runtime dependency. No react/react-native/
  * expo, no `require()` in the ESM build.
  */
+export { ORGANIZATION_CATEGORIES, organizationCategorySchema, createAccountRequestSchema, } from './accountGraph';
+export type { OrganizationCategory, CreateAccountRequest, } from './accountGraph';
 export { userNameSchema, userResponseSchema, userProfileUpdateSchema, currentUserResponseSchema, deviceLinkedSessionSchema, deviceLinkedSessionsResponseSchema, resolveUserId, safeParseContract, } from './userResponse';
 export type { UserNameResponse, UserResponse, UserProfileUpdate, CurrentUserResponseContract, DeviceLinkedSessionResponse, DeviceLinkedSessionsResponseContract, } from './userResponse';
 export { applicationTypeSchema, publicApplicationSchema, sessionStatusSchema, } from './sessionStatus';

package/dist/types/sessionStatus.d.ts

@@ -68,9 +68,9 @@ export declare const publicApplicationSchema: z.ZodObject<{
     scopes: z.ZodArray<z.ZodString, "many">;
     developerName: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    id: string;
     type: "first_party" | "third_party" | "internal" | "system";
     name: string;
+    id: string;
     isOfficial: boolean;
     isInternal: boolean;
     scopes: string[];
@@ -81,9 +81,9 @@ export declare const publicApplicationSchema: z.ZodObject<{
     termsUrl?: string | undefined;
     developerName?: string | undefined;
 }, {
-    id: string;
     type: "first_party" | "third_party" | "internal" | "system";
     name: string;
+    id: string;
     isOfficial: boolean;
     isInternal: boolean;
     scopes: string[];
@@ -132,9 +132,9 @@ export declare const sessionStatusSchema: z.ZodObject<{
         scopes: z.ZodArray<z.ZodString, "many">;
         developerName: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        id: string;
         type: "first_party" | "third_party" | "internal" | "system";
         name: string;
+        id: string;
         isOfficial: boolean;
         isInternal: boolean;
         scopes: string[];
@@ -145,9 +145,9 @@ export declare const sessionStatusSchema: z.ZodObject<{
         termsUrl?: string | undefined;
         developerName?: string | undefined;
     }, {
-        id: string;
         type: "first_party" | "third_party" | "internal" | "system";
         name: string;
+        id: string;
         isOfficial: boolean;
         isInternal: boolean;
         scopes: string[];
@@ -171,9 +171,9 @@ export declare const sessionStatusSchema: z.ZodObject<{
     authorized?: boolean | undefined;
     sessionToken?: string | undefined;
     application?: {
-        id: string;
         type: "first_party" | "third_party" | "internal" | "system";
         name: string;
+        id: string;
         isOfficial: boolean;
         isInternal: boolean;
         scopes: string[];
@@ -193,9 +193,9 @@ export declare const sessionStatusSchema: z.ZodObject<{
     authorized?: boolean | undefined;
     sessionToken?: string | undefined;
     application?: {
-        id: string;
         type: "first_party" | "third_party" | "internal" | "system";
         name: string;
+        id: string;
         isOfficial: boolean;
         isInternal: boolean;
         scopes: string[];

package/dist/types/userResponse.d.ts

@@ -107,6 +107,11 @@ export declare const userResponseSchema: z.ZodObject<{
      * entry; present only when the account has verified at least one domain.
      */
     verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+    /**
+     * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+     * Absent on personal, project, and bot accounts.
+     */
+    organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
 }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
     /** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
     id: z.ZodOptional<z.ZodString>;
@@ -136,6 +141,11 @@ export declare const userResponseSchema: z.ZodObject<{
      * entry; present only when the account has verified at least one domain.
      */
     verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+    /**
+     * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+     * Absent on personal, project, and bot accounts.
+     */
+    organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
 }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
     /** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
     id: z.ZodOptional<z.ZodString>;
@@ -165,6 +175,11 @@ export declare const userResponseSchema: z.ZodObject<{
      * entry; present only when the account has verified at least one domain.
      */
     verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+    /**
+     * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+     * Absent on personal, project, and bot accounts.
+     */
+    organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
 }, z.ZodTypeAny, "passthrough">>;
 export type UserResponse = z.infer<typeof userResponseSchema>;
 export declare const userProfileUpdateSchema: z.ZodObject<{
@@ -197,14 +212,14 @@ export declare const userProfileUpdateSchema: z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         url: string;
-        id?: string | undefined;
         description?: string | undefined;
+        id?: string | undefined;
         title?: string | undefined;
         image?: string | undefined;
     }, {
         url: string;
-        id?: string | undefined;
         description?: string | undefined;
+        id?: string | undefined;
         title?: string | undefined;
         image?: string | undefined;
     }>, "many">>;
@@ -243,14 +258,14 @@ export declare const userProfileUpdateSchema: z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         url: string;
-        id?: string | undefined;
         description?: string | undefined;
+        id?: string | undefined;
         title?: string | undefined;
         image?: string | undefined;
     }, {
         url: string;
-        id?: string | undefined;
         description?: string | undefined;
+        id?: string | undefined;
         title?: string | undefined;
         image?: string | undefined;
     }>, "many">>;
@@ -289,14 +304,14 @@ export declare const userProfileUpdateSchema: z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         url: string;
-        id?: string | undefined;
         description?: string | undefined;
+        id?: string | undefined;
         title?: string | undefined;
         image?: string | undefined;
     }, {
         url: string;
-        id?: string | undefined;
         description?: string | undefined;
+        id?: string | undefined;
         title?: string | undefined;
         image?: string | undefined;
     }>, "many">>;
@@ -348,6 +363,11 @@ export declare const currentUserResponseSchema: z.ZodObject<{
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
         /** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
         id: z.ZodOptional<z.ZodString>;
@@ -377,6 +397,11 @@ export declare const currentUserResponseSchema: z.ZodObject<{
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
         /** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
         id: z.ZodOptional<z.ZodString>;
@@ -406,17 +431,23 @@ export declare const currentUserResponseSchema: z.ZodObject<{
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough">>;
 }, "strip", z.ZodTypeAny, {
     data: {
         name: UserNameResponse;
+        username?: string | undefined;
+        avatar?: string | null | undefined;
+        organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
         id?: string | undefined;
         publicKey?: string | undefined;
         did?: string | undefined;
         verifiedDomains?: import("./identity").VerifiedDomain[] | undefined;
         verified?: boolean | undefined;
-        username?: string | undefined;
-        avatar?: string | null | undefined;
         _id?: string | undefined;
         email?: string | undefined;
         phone?: string | undefined;
@@ -430,13 +461,14 @@ export declare const currentUserResponseSchema: z.ZodObject<{
 }, {
     data: {
         name: UserNameResponse;
+        username?: string | undefined;
+        avatar?: string | null | undefined;
+        organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
         id?: string | undefined;
         publicKey?: string | undefined;
         did?: string | undefined;
         verifiedDomains?: import("./identity").VerifiedDomain[] | undefined;
         verified?: boolean | undefined;
-        username?: string | undefined;
-        avatar?: string | null | undefined;
         _id?: string | undefined;
         email?: string | undefined;
         phone?: string | undefined;
@@ -487,6 +519,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
         /** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
         id: z.ZodOptional<z.ZodString>;
@@ -516,6 +553,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
         /** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
         id: z.ZodOptional<z.ZodString>;
@@ -545,6 +587,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough">>>>;
 }, "strip", z.ZodTypeAny, {
     sessionId: string;
@@ -577,6 +624,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough"> | null | undefined;
     isCurrent?: boolean | undefined;
 }, {
@@ -610,6 +662,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough"> | null | undefined;
     isCurrent?: boolean | undefined;
 }>;
@@ -647,6 +704,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
         /** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
         id: z.ZodOptional<z.ZodString>;
@@ -676,6 +738,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
         /** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
         id: z.ZodOptional<z.ZodString>;
@@ -705,6 +772,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough">>>>;
 }, "strip", z.ZodTypeAny, {
     sessionId: string;
@@ -737,6 +809,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough"> | null | undefined;
     isCurrent?: boolean | undefined;
 }, {
@@ -770,6 +847,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
          * entry; present only when the account has verified at least one domain.
          */
         verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
+        /**
+         * Real-estate / team taxonomy for `kind: 'organization'` accounts.
+         * Absent on personal, project, and bot accounts.
+         */
+        organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
     }, z.ZodTypeAny, "passthrough"> | null | undefined;
     isCurrent?: boolean | undefined;
 }>, "many">;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxyhq/contracts",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "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",