@oxyhq/contracts 0.20.0 → 0.22.0

package/dist/types/accountGraph.d.ts

@@ -1,11 +1,75 @@
 /**
- * Account graph wire contracts — organization taxonomy and create-account input.
+ * Account graph wire contracts — the account-kind vocabulary, 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';
+/**
+ * Account-graph classification — the ONE authority for the kind vocabulary.
+ *
+ * `personal` is the only kind minted by signup and the only one that carries
+ * its own credentials; every other kind is a child account created under a
+ * parent and operated through `account_members`. The API schema, the Mongoose
+ * model and the SDK all derive from this list rather than restating it, so a
+ * new kind is one edit here instead of four literals that can drift.
+ */
+export type AccountKind = 'personal' | 'organization' | 'project' | 'bot' | 'channel';
+/**
+ * The union is spelled out above and the array proves coverage BOTH ways
+ * (`satisfies` here, the `Gap` alias below) — the same shape this package's
+ * `ORGANIZATION_CATEGORIES` / `TRUST_TIERS` pairs use, and the one
+ * `db/schema/users.ts` mirrors to keep the `users_kind_check` CHECK honest.
+ *
+ * Deriving the union from the array instead would cost nothing here and be paid
+ * by consumers: `kind` travels into `@oxyhq/services` through
+ * `SwitchableAccount`, where an indexed-access type is materially more
+ * expensive to check than a literal union.
+ */
+export declare const ACCOUNT_KINDS: readonly ["personal", "organization", "project", "bot", "channel"];
+/** `never` while `ACCOUNT_KINDS` covers the union. */
+export type AccountKindGap = Exclude<AccountKind, (typeof ACCOUNT_KINDS)[number]>;
+export declare const accountKindSchema: z.ZodEnum<["personal", "organization", "project", "bot", "channel"]>;
+/**
+ * Kinds that may be CREATED as children of another account. Exactly
+ * `ACCOUNT_KINDS` minus `personal`, which is always a tree root.
+ */
+export type ChildAccountKind = Exclude<AccountKind, 'personal'>;
+export declare const CHILD_ACCOUNT_KINDS: readonly ["organization", "project", "bot", "channel"];
+/** `never` while `CHILD_ACCOUNT_KINDS` covers the child union. */
+export type ChildAccountKindGap = Exclude<ChildAccountKind, (typeof CHILD_ACCOUNT_KINDS)[number]>;
+export declare const childAccountKindSchema: z.ZodEnum<["organization", "project", "bot", "channel"]>;
+/**
+ * Whether an operator may ACT AS an account of this kind — switch the whole app
+ * into it (`POST /accounts/:id/switch`) or authorise an app to act as it
+ * (an OAuth delegated subject).
+ *
+ * Two kinds are refused, for opposite reasons:
+ *
+ *  - `personal` is a human login, so assuming it would be impersonation.
+ *  - `channel` is a CONTENT identity, not an operating one. A channel exists so
+ *    that posts can be authored BY it; it is never a seat anybody occupies. Its
+ *    operators act on it through their own membership, and an application
+ *    publishes to it with its own credential. Refusing act-as is what makes
+ *    "no login, ever" structural rather than incidental: no session can be
+ *    minted whose subject is a channel, so no bearer exists that could add an
+ *    auth method to one (every auth-method write resolves its target from the
+ *    authenticated subject, never from a parameter).
+ *
+ * Consumers must gate on this predicate rather than testing `kind === 'personal'`,
+ * which silently admits every kind added after it was written.
+ */
+export declare function isActAsEligibleKind(kind: AccountKind | null | undefined): boolean;
+/**
+ * Narrow an unknown value to an {@link AccountKind}.
+ *
+ * The user-DTO serializers read from structurally-permissive `unknown` sources
+ * (a Drizzle row, a Mongo document, an already-formatted object), so each one
+ * would otherwise hand-roll this check and they would drift on what counts.
+ */
+export declare function isAccountKind(value: unknown): value is AccountKind;
 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"]>;
@@ -15,65 +79,72 @@ export declare const organizationCategorySchema: z.ZodEnum<["agency", "cooperati
  */
 export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
     parentAccountId: z.ZodOptional<z.ZodString>;
-    kind: z.ZodEnum<["organization", "project", "bot"]>;
+    kind: z.ZodEnum<["organization", "project", "bot", "channel"]>;
     username: z.ZodString;
     name: z.ZodOptional<z.ZodObject<{
         first: z.ZodOptional<z.ZodString>;
         last: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         first?: string | undefined;
         last?: string | undefined;
+        displayName?: string | undefined;
     }, {
         first?: string | undefined;
         last?: string | undefined;
+        displayName?: 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";
+    kind: "organization" | "project" | "bot" | "channel";
     username: string;
     parentAccountId?: string | undefined;
     name?: {
         first?: string | undefined;
         last?: string | undefined;
+        displayName?: string | undefined;
     } | undefined;
     bio?: string | undefined;
     avatar?: string | undefined;
     description?: string | undefined;
     organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
 }, {
-    kind: "organization" | "project" | "bot";
+    kind: "organization" | "project" | "bot" | "channel";
     username: string;
     parentAccountId?: string | undefined;
     name?: {
         first?: string | undefined;
         last?: string | undefined;
+        displayName?: string | undefined;
     } | undefined;
     bio?: string | undefined;
     avatar?: string | undefined;
     description?: string | undefined;
     organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
 }>, {
-    kind: "organization" | "project" | "bot";
+    kind: "organization" | "project" | "bot" | "channel";
     username: string;
     parentAccountId?: string | undefined;
     name?: {
         first?: string | undefined;
         last?: string | undefined;
+        displayName?: string | undefined;
     } | undefined;
     bio?: string | undefined;
     avatar?: string | undefined;
     description?: string | undefined;
     organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
 }, {
-    kind: "organization" | "project" | "bot";
+    kind: "organization" | "project" | "bot" | "channel";
     username: string;
     parentAccountId?: string | undefined;
     name?: {
         first?: string | undefined;
         last?: string | undefined;
+        displayName?: string | undefined;
     } | undefined;
     bio?: string | undefined;
     avatar?: string | undefined;

package/dist/types/index.d.ts

@@ -9,8 +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 { ACCOUNT_KINDS, accountKindSchema, CHILD_ACCOUNT_KINDS, childAccountKindSchema, isAccountKind, isActAsEligibleKind, ORGANIZATION_CATEGORIES, organizationCategorySchema, createAccountRequestSchema, } from './accountGraph';
+export type { AccountKind, ChildAccountKind, OrganizationCategory, CreateAccountRequest, } from './accountGraph';
 export { userNameSchema, userRelationshipSchema, themePreferenceSchema, userResponseSchema, userProfileUpdateSchema, currentUserResponseSchema, deviceLinkedSessionSchema, deviceLinkedSessionsResponseSchema, resolveUserId, safeParseContract, } from './userResponse';
 export type { UserNameResponse, UserRelationship, ThemePreference, UserResponse, UserProfileUpdate, CurrentUserResponseContract, DeviceLinkedSessionResponse, DeviceLinkedSessionsResponseContract, } from './userResponse';
 export { applicationTypeSchema, publicApplicationSchema, sessionStatusSchema, } from './sessionStatus';
@@ -19,6 +19,8 @@ export { COMMONS_DENY_REASONS, commonsDenyReasonSchema, IDENTITY_APPROVAL_PUSH_C
 export type { CommonsDenyReason } from './commonsSignIn';
 export { INBOX_EMAIL_PUSH_CHANNEL, INBOX_EMAIL_PUSH_TYPE, inboxEmailPushDataSchema, } from './inboxPush';
 export type { InboxEmailPushData } from './inboxPush';
+export { OXY_USER_INVALIDATION_CHANNEL, OXY_USER_CHANGE_REASONS, OXY_PUBLISHED_USER_CHANGE_REASONS, isPublishedOxyUserChangeReason, oxyUserInvalidationEventSchema, } from './userInvalidation';
+export type { OxyUserChangeReason, PublishedOxyUserChangeReason, OxyUserInvalidationEvent, } from './userInvalidation';
 export { recommendationExcludeTypeSchema, recommendationBoostSchema, recommendationSignalWeightsSchema, recommendationRequestSchema, recommendationCountSchema, recommendationItemSchema, recommendationResponseSchema, appEndorsementInputSchema, appInterestInputSchema, appUserSignalIngestSchema, appAffinityEventTypeSchema, appAffinityEventSchema, appAffinityEventsIngestSchema, } from './recommendations';
 export type { RecommendationExcludeType, RecommendationBoost, RecommendationSignalWeights, RecommendationRequest, RecommendationCount, RecommendationItem, RecommendationResponse, AppEndorsementInput, AppInterestInput, AppUserSignalIngest, AppAffinityEventType, AppAffinityEvent, AppAffinityEventsIngest, } from './recommendations';
 export { verificationMethodSchema, didServiceSchema, didDocumentSchema, signedRecordEnvelopeSchema, verifiedDomainSchema, domainVerificationRequestSchema, domainVerificationInstructionsSchema, authMethodEntrySchema, authMethodsResponseSchema, exportAttestationSchema, exportBundleSchema, } from './identity';
@@ -31,6 +33,8 @@ export { publicCardSchema, signedPublicCardSchema, realLifeAttestationRecordSche
 export type { CardTrustTier, PersonhoodStatus, PublicCard, SignedPublicCard, RealLifeAttestationRecord, RealLifeAttestationResult, ValidationVerdict, ValidationRequestStatus, ValidationVerdictRecord, ValidationOpenRequest, ValidationOpenResult, ValidationRequestSummary, ValidationVoteResult, PersonhoodVouchRecord, PersonhoodBreakdown, PersonhoodStatusResult, VouchResult, CredentialStatus, CredentialRecord, VerifiableCredentialResponse, CredentialIssueResult, CredentialListResult, CredentialVerifyResult, } from './civic';
 export { REPUTATION_CATEGORIES, REPUTATION_TRANSACTION_STATUSES, TRUST_TIERS, REPUTATION_TARGET_ENTITY_TYPES, REPUTATION_DISPUTE_STATUSES, REPUTATION_INFLUENCE_CONTEXTS, reputationCategorySchema, reputationTransactionStatusSchema, trustTierSchema, reputationTargetEntityTypeSchema, reputationDisputeStatusSchema, reputationInfluenceContextSchema, reputationTransactionSchema, reputationBalanceBreakdownSchema, reputationInfluenceSchema, reputationReliabilitySchema, reputationBalanceSummarySchema, reputationBalanceSchema, reputationDisputeSchema, reputationRuleSchema, reputationLeaderboardUserSchema, reputationLeaderboardEntrySchema, reputationInfluenceResultSchema, reverseReputationTransactionResultSchema, awardReputationSchema, createReputationDisputeSchema, resolveReputationDisputeSchema, upsertReputationRuleSchema, reverseReputationTransactionSchema, isFullReputationBalance, } from './reputation';
 export type { ReputationCategory, ReputationTransactionStatus, TrustTier, ReputationTargetEntityType, ReputationDisputeStatus, ReputationInfluenceContext, ReputationTransaction, ReputationBalanceBreakdown, ReputationInfluence, ReputationReliability, ReputationBalanceSummary, ReputationBalance, ReputationBalanceView, ReputationDispute, ReputationRule, ReputationLeaderboardUser, ReputationLeaderboardEntry, ReputationInfluenceResult, ReverseReputationTransactionResult, AwardReputationInput, CreateReputationDisputeInput, ResolveReputationDisputeInput, UpsertReputationRuleInput, UpsertReputationRuleRequest, ReverseReputationTransactionInput, } from './reputation';
+export { MODERATION_SEVERITIES, MODERATION_FINDING_SCOPES, MODERATION_ATTRIBUTIONS, MODERATION_DECISION_STATUSES, MODERATION_EFFECT_TYPES, MODERATION_EFFECT_STATUSES, MODERATION_EFFECT_SKIP_REASONS, CONDUCT_STRIKE_STATUSES, CONDUCT_STANDINGS, CONTRIBUTION_TIERS, PERSONHOOD_STATUSES, IDENTITY_BINDING_TYPES, IDENTITY_BINDING_STATUSES, APPLICATION_MODERATION_STANDINGS, moderationSeveritySchema, moderationFindingScopeSchema, moderationAttributionSchema, moderationDecisionStatusSchema, moderationEffectTypeSchema, moderationEffectStatusSchema, moderationEffectSkipReasonSchema, conductStrikeStatusSchema, conductStandingSchema, contributionTierSchema, personhoodStatusSchema, identityBindingTypeSchema, identityBindingStatusSchema, applicationModerationStandingSchema, moderationFindingSchema, moderationDecisionEventSubjectSchema, moderationPolicyVersionsSchema, moderationDecisionEventSchema, finalizeModerationDecisionSchema, reverseModerationEffectSchema, moderationEffectSchema, applyModerationDecisionResultSchema, reverseModerationEffectResultSchema, registerIdentityBindingSchema, identityBindingSchema, reputationPersonhoodSchema, reputationContributionSchema, reputationConductSchema, reputationReportingSchema, reputationReviewingSchema, reputationContextualInfluenceSchema, applicationModerationTrustSchema, } from './moderationReputation';
+export type { ModerationSeverity, ModerationFindingScope, ModerationAttribution, ModerationDecisionStatus, ModerationEffectType, ModerationEffectStatus, ModerationEffectSkipReason, ConductStrikeStatus, ConductStanding, ContributionTier, PersonhoodStatusValue, IdentityBindingType, IdentityBindingStatus, ApplicationModerationStanding, ModerationFinding, ModerationDecisionEventSubject, ModerationPolicyVersions, ModerationDecisionEvent, FinalizeModerationDecisionInput, ReverseModerationEffectInput, ModerationEffect, ApplyModerationDecisionResult, ReverseModerationEffectResult, RegisterIdentityBindingInput, IdentityBinding, ReputationPersonhood, ReputationContribution, ReputationConduct, ReputationReporting, ReputationReviewing, ReputationContextualInfluence, ApplicationModerationTrust, } from './moderationReputation';
 export { linkPreviewSchema, linkPreviewBatchRequestSchema, linkPreviewBatchResponseSchema, linkPreviewResponseSchema, } from './links';
 export type { LinkPreviewStatus, LinkPreview, LinkPreviewBatchRequest, LinkPreviewBatchResponse, } from './links';
 export { sessionAccountSchema, deviceSessionStateSchema, activeTokenSchema, deviceSessionSyncSchema, deviceTokenMintRequestSchema, deviceTokenMintResponseSchema, deviceBackgroundCredentialResponseSchema, deviceBackgroundTokenRequestSchema, deviceBackgroundTokenResponseSchema, SESSION_ACCOUNTS_CHANGED_EVENT, sessionAccountsChangedReasonSchema, sessionAccountsChangedEventSchema, } from './deviceSession';