@iveri/contracts 0.54.0 → 0.60.0

package/dist/api/realtime/realtime-resource-type.enum.d.ts

@@ -10,5 +10,11 @@ export declare enum RealtimeResourceType {
     MOBILITY_WORKER = "mobility.worker",
     MOBILITY_DISPATCH = "mobility.dispatch",
     RESTAURANT_BRANCH = "restaurant.branch",
-    RESTAURANT_ORDER = "restaurant.order"
+    RESTAURANT_ORDER = "restaurant.order",
+    /**
+     * One Ezo member's own room. They subscribe to themselves, the one thing they can name before a
+     * message or a like has happened, and the events on it say what became stale.
+     */
+    SOCIAL_MEMBER = "social.member",
+    GYM_BRANCH = "gym.branch"
 }

package/dist/api/realtime/realtime-resource-type.enum.js

@@ -12,4 +12,10 @@ export var RealtimeResourceType;
     RealtimeResourceType["MOBILITY_DISPATCH"] = "mobility.dispatch";
     RealtimeResourceType["RESTAURANT_BRANCH"] = "restaurant.branch";
     RealtimeResourceType["RESTAURANT_ORDER"] = "restaurant.order";
+    /**
+     * One Ezo member's own room. They subscribe to themselves, the one thing they can name before a
+     * message or a like has happened, and the events on it say what became stale.
+     */
+    RealtimeResourceType["SOCIAL_MEMBER"] = "social.member";
+    RealtimeResourceType["GYM_BRANCH"] = "gym.branch";
 })(RealtimeResourceType || (RealtimeResourceType = {}));

package/dist/api/social/index.d.ts

@@ -0,0 +1,20 @@
+export * from './social-account.type.js';
+export * from './social-activity-kind.enum.js';
+export * from './social-activity.type.js';
+export * from './social-appeal-status.enum.js';
+export * from './social-case-decision.enum.js';
+export * from './social-case-status.enum.js';
+export * from './social-conversation.type.js';
+export * from './social-export-status.enum.js';
+export * from './social-follow-state.enum.js';
+export * from './social-image.type.js';
+export * from './social-limits.constant.js';
+export * from './social-member-status.enum.js';
+export * from './social-member.type.js';
+export * from './social-moderation-reason.enum.js';
+export * from './social-moderation.type.js';
+export * from './social-post.type.js';
+export * from './social-refusal.enum.js';
+export * from './social-report-reason.enum.js';
+export * from './social-report-target.enum.js';
+export * from './social-story.type.js';

package/dist/api/social/index.js

@@ -0,0 +1,20 @@
+export * from './social-account.type.js';
+export * from './social-activity-kind.enum.js';
+export * from './social-activity.type.js';
+export * from './social-appeal-status.enum.js';
+export * from './social-case-decision.enum.js';
+export * from './social-case-status.enum.js';
+export * from './social-conversation.type.js';
+export * from './social-export-status.enum.js';
+export * from './social-follow-state.enum.js';
+export * from './social-image.type.js';
+export * from './social-limits.constant.js';
+export * from './social-member-status.enum.js';
+export * from './social-member.type.js';
+export * from './social-moderation-reason.enum.js';
+export * from './social-moderation.type.js';
+export * from './social-post.type.js';
+export * from './social-refusal.enum.js';
+export * from './social-report-reason.enum.js';
+export * from './social-report-target.enum.js';
+export * from './social-story.type.js';

package/dist/api/social/social-account.type.d.ts

@@ -0,0 +1,24 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { SocialExportStatus } from './social-export-status.enum.js';
+export interface SocialDeletionState {
+    deletionScheduledFor: Nullable<IsoDateTime>;
+}
+export interface SocialDataExport {
+    id: UUID;
+    status: SocialExportStatus;
+    requestedAt: IsoDateTime;
+    readyAt: Nullable<IsoDateTime>;
+    expiresAt: Nullable<IsoDateTime>;
+    downloadUrl: Nullable<string>;
+    sizeBytes: Nullable<number>;
+}
+export interface ConfirmSocialEmailRequest {
+    token: string;
+}
+export interface SocialRealtimeGrant {
+    grant: string;
+    expiresAt: IsoDateTime;
+    memberId: UUID;
+}

package/dist/api/social/social-account.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/social/social-activity-kind.enum.d.ts

@@ -0,0 +1,13 @@
+/** What happened, for one line of a member's activity. */
+export declare enum SocialActivityKind {
+    POST_LIKED = "post-liked",
+    COMMENT_LIKED = "comment-liked",
+    POST_COMMENTED = "post-commented",
+    COMMENT_REPLIED = "comment-replied",
+    MENTIONED = "mentioned",
+    FOLLOWED = "followed",
+    FOLLOW_REQUESTED = "follow-requested",
+    FOLLOW_ACCEPTED = "follow-accepted",
+    /** Staff decided something about this member or what they posted. */
+    MODERATION_NOTICE = "moderation-notice"
+}

package/dist/api/social/social-activity-kind.enum.js

@@ -0,0 +1,14 @@
+/** What happened, for one line of a member's activity. */
+export var SocialActivityKind;
+(function (SocialActivityKind) {
+    SocialActivityKind["POST_LIKED"] = "post-liked";
+    SocialActivityKind["COMMENT_LIKED"] = "comment-liked";
+    SocialActivityKind["POST_COMMENTED"] = "post-commented";
+    SocialActivityKind["COMMENT_REPLIED"] = "comment-replied";
+    SocialActivityKind["MENTIONED"] = "mentioned";
+    SocialActivityKind["FOLLOWED"] = "followed";
+    SocialActivityKind["FOLLOW_REQUESTED"] = "follow-requested";
+    SocialActivityKind["FOLLOW_ACCEPTED"] = "follow-accepted";
+    /** Staff decided something about this member or what they posted. */
+    SocialActivityKind["MODERATION_NOTICE"] = "moderation-notice";
+})(SocialActivityKind || (SocialActivityKind = {}));

package/dist/api/social/social-activity.type.d.ts

@@ -0,0 +1,26 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { SocialActivityKind } from './social-activity-kind.enum.js';
+import type { SocialMemberCard } from './social-member.type.js';
+/** One line of activity, which can stand for many people doing the same thing. */
+export interface SocialActivityItem {
+    id: UUID;
+    kind: SocialActivityKind;
+    /** The most recent few, for drawing faces and names. */
+    actors: SocialMemberCard[];
+    actorCount: number;
+    postId: Nullable<UUID>;
+    postThumbnailUrl: Nullable<string>;
+    commentId: Nullable<UUID>;
+    excerpt: Nullable<string>;
+    /** For a moderation notice, the decision it announces. */
+    noticeId: Nullable<UUID>;
+    latestAt: IsoDateTime;
+    isRead: boolean;
+}
+export interface SocialUnreadCounts {
+    activity: number;
+    messages: number;
+    followRequests: number;
+}

package/dist/api/social/social-activity.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/social/social-appeal-status.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum SocialAppealStatus {
+    PENDING = "pending",
+    /** The decision stands. */
+    UPHELD = "upheld",
+    /** The decision was wrong, and what it did has been undone. */
+    REVERSED = "reversed"
+}

package/dist/api/social/social-appeal-status.enum.js

@@ -0,0 +1,8 @@
+export var SocialAppealStatus;
+(function (SocialAppealStatus) {
+    SocialAppealStatus["PENDING"] = "pending";
+    /** The decision stands. */
+    SocialAppealStatus["UPHELD"] = "upheld";
+    /** The decision was wrong, and what it did has been undone. */
+    SocialAppealStatus["REVERSED"] = "reversed";
+})(SocialAppealStatus || (SocialAppealStatus = {}));

package/dist/api/social/social-case-decision.enum.d.ts

@@ -0,0 +1,13 @@
+/** What a moderator decided about a case. */
+export declare enum SocialCaseDecision {
+    /** Nothing was wrong. */
+    DISMISS = "dismiss",
+    /** The content comes down and the member is told why. */
+    REMOVE = "remove",
+    /** The content comes down and it goes on the member's record as a warning. */
+    WARN = "warn",
+    /** The content comes down and the member cannot use Ezo until a date. */
+    SUSPEND = "suspend",
+    /** The content comes down and the member cannot use Ezo at all. */
+    BAN = "ban"
+}

package/dist/api/social/social-case-decision.enum.js

@@ -0,0 +1,14 @@
+/** What a moderator decided about a case. */
+export var SocialCaseDecision;
+(function (SocialCaseDecision) {
+    /** Nothing was wrong. */
+    SocialCaseDecision["DISMISS"] = "dismiss";
+    /** The content comes down and the member is told why. */
+    SocialCaseDecision["REMOVE"] = "remove";
+    /** The content comes down and it goes on the member's record as a warning. */
+    SocialCaseDecision["WARN"] = "warn";
+    /** The content comes down and the member cannot use Ezo until a date. */
+    SocialCaseDecision["SUSPEND"] = "suspend";
+    /** The content comes down and the member cannot use Ezo at all. */
+    SocialCaseDecision["BAN"] = "ban";
+})(SocialCaseDecision || (SocialCaseDecision = {}));

package/dist/api/social/social-case-status.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum SocialCaseStatus {
+    OPEN = "open",
+    RESOLVED = "resolved"
+}

package/dist/api/social/social-case-status.enum.js

@@ -0,0 +1,5 @@
+export var SocialCaseStatus;
+(function (SocialCaseStatus) {
+    SocialCaseStatus["OPEN"] = "open";
+    SocialCaseStatus["RESOLVED"] = "resolved";
+})(SocialCaseStatus || (SocialCaseStatus = {}));

package/dist/api/social/social-conversation.type.d.ts

@@ -0,0 +1,45 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { SocialImage } from './social-image.type.js';
+import type { SocialMemberCard } from './social-member.type.js';
+export interface SocialMessagePreview {
+    excerpt: Nullable<string>;
+    hasImage: boolean;
+    isOwn: boolean;
+    sentAt: IsoDateTime;
+}
+export interface SocialConversation {
+    id: UUID;
+    /** Null once the other person has left Ezo. */
+    other: Nullable<SocialMemberCard>;
+    /** Waiting for this member to accept it. */
+    isRequest: boolean;
+    unreadCount: number;
+    lastMessage: Nullable<SocialMessagePreview>;
+    /** Whether this member can send here now: false after a block or when the other has left. */
+    canSend: boolean;
+    /** Up to where the other person has read. Absent while a request is unanswered. */
+    otherReadAt: Nullable<IsoDateTime>;
+}
+export interface SocialMessage {
+    id: UUID;
+    conversationId: UUID;
+    /** Null once the sender has left Ezo. */
+    senderId: Nullable<UUID>;
+    body: Nullable<string>;
+    image: Nullable<SocialImage>;
+    isOwn: boolean;
+    /** The sender took it back. */
+    isDeleted: boolean;
+    sentAt: IsoDateTime;
+}
+export interface StartSocialConversationRequest {
+    memberId: UUID;
+}
+export interface SendSocialMessageRequest {
+    /** Chosen by the client per message, so a retry cannot send it twice. */
+    clientId: UUID;
+    body?: Nullable<string>;
+    mediaId?: Nullable<UUID>;
+}

package/dist/api/social/social-conversation.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/social/social-export-status.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum SocialExportStatus {
+    PENDING = "pending",
+    READY = "ready",
+    FAILED = "failed",
+    EXPIRED = "expired"
+}

package/dist/api/social/social-export-status.enum.js

@@ -0,0 +1,7 @@
+export var SocialExportStatus;
+(function (SocialExportStatus) {
+    SocialExportStatus["PENDING"] = "pending";
+    SocialExportStatus["READY"] = "ready";
+    SocialExportStatus["FAILED"] = "failed";
+    SocialExportStatus["EXPIRED"] = "expired";
+})(SocialExportStatus || (SocialExportStatus = {}));

package/dist/api/social/social-follow-state.enum.d.ts

@@ -0,0 +1,7 @@
+/** One direction of the follow graph, as one member sees it. */
+export declare enum SocialFollowState {
+    NONE = "none",
+    /** Waiting for a private account to answer. */
+    REQUESTED = "requested",
+    FOLLOWING = "following"
+}

package/dist/api/social/social-follow-state.enum.js

@@ -0,0 +1,8 @@
+/** One direction of the follow graph, as one member sees it. */
+export var SocialFollowState;
+(function (SocialFollowState) {
+    SocialFollowState["NONE"] = "none";
+    /** Waiting for a private account to answer. */
+    SocialFollowState["REQUESTED"] = "requested";
+    SocialFollowState["FOLLOWING"] = "following";
+})(SocialFollowState || (SocialFollowState = {}));

package/dist/api/social/social-image.type.d.ts

@@ -0,0 +1,28 @@
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+/** Addresses of one photograph. Signed, and only good for about two hours after the response. */
+export interface SocialImageUrls {
+    /** 320 wide. */
+    small: string;
+    /** 800 wide. */
+    medium: string;
+    /** 1600 wide. */
+    large: string;
+}
+export interface SocialImage {
+    id: UUID;
+    width: number;
+    height: number;
+    /** A solid colour to paint while the photograph loads. */
+    placeholderColor: string;
+    altText: Nullable<string>;
+    urls: SocialImageUrls;
+}
+/** What an upload answers, before anything has used it. */
+export interface SocialMediaUpload {
+    id: UUID;
+    width: number;
+    height: number;
+    placeholderColor: string;
+    previewUrl: string;
+}

package/dist/api/social/social-image.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/social/social-limits.constant.d.ts

@@ -0,0 +1,23 @@
+/** Limits a form and the API have to agree on. */
+export declare const SOCIAL_LIMITS: {
+    readonly HANDLE_MIN: 3;
+    readonly HANDLE_MAX: 30;
+    readonly DISPLAY_NAME_MAX: 60;
+    readonly BIO_MAX: 300;
+    readonly WEBSITE_MAX: 300;
+    readonly CAPTION_MAX: 2200;
+    readonly COMMENT_MAX: 1000;
+    readonly STORY_CAPTION_MAX: 200;
+    readonly MESSAGE_MAX: 2000;
+    readonly ALT_TEXT_MAX: 500;
+    readonly POST_IMAGES_MAX: 10;
+    readonly REPORT_DETAIL_MAX: 1000;
+    readonly APPEAL_STATEMENT_MAX: 2000;
+    readonly MODERATION_NOTE_MAX: 2000;
+    readonly IMAGE_BYTES_MAX: number;
+    readonly MINIMUM_AGE: 16;
+};
+/** The characters a handle may use, in the form they are stored. */
+export declare const SOCIAL_HANDLE_PATTERN: RegExp;
+/** The version of the terms a new member accepts. A placeholder until the real terms exist. */
+export declare const SOCIAL_TERMS_VERSION = "2026-11-draft";

package/dist/api/social/social-limits.constant.js

@@ -0,0 +1,23 @@
+/** Limits a form and the API have to agree on. */
+export const SOCIAL_LIMITS = {
+    HANDLE_MIN: 3,
+    HANDLE_MAX: 30,
+    DISPLAY_NAME_MAX: 60,
+    BIO_MAX: 300,
+    WEBSITE_MAX: 300,
+    CAPTION_MAX: 2200,
+    COMMENT_MAX: 1000,
+    STORY_CAPTION_MAX: 200,
+    MESSAGE_MAX: 2000,
+    ALT_TEXT_MAX: 500,
+    POST_IMAGES_MAX: 10,
+    REPORT_DETAIL_MAX: 1000,
+    APPEAL_STATEMENT_MAX: 2000,
+    MODERATION_NOTE_MAX: 2000,
+    IMAGE_BYTES_MAX: 15 * 1024 * 1024,
+    MINIMUM_AGE: 16,
+};
+/** The characters a handle may use, in the form they are stored. */
+export const SOCIAL_HANDLE_PATTERN = /^[a-z0-9](?:[a-z0-9._]*[a-z0-9])?$/;
+/** The version of the terms a new member accepts. A placeholder until the real terms exist. */
+export const SOCIAL_TERMS_VERSION = '2026-11-draft';

package/dist/api/social/social-member-status.enum.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Whether a member can use Ezo.
+ *
+ * `deleting` is the grace period after somebody asks to leave: the account is already invisible to
+ * everyone else, and signing in during it cancels the request.
+ */
+export declare enum SocialMemberStatus {
+    ACTIVE = "active",
+    SUSPENDED = "suspended",
+    BANNED = "banned",
+    DELETING = "deleting"
+}

package/dist/api/social/social-member-status.enum.js

@@ -0,0 +1,13 @@
+/**
+ * Whether a member can use Ezo.
+ *
+ * `deleting` is the grace period after somebody asks to leave: the account is already invisible to
+ * everyone else, and signing in during it cancels the request.
+ */
+export var SocialMemberStatus;
+(function (SocialMemberStatus) {
+    SocialMemberStatus["ACTIVE"] = "active";
+    SocialMemberStatus["SUSPENDED"] = "suspended";
+    SocialMemberStatus["BANNED"] = "banned";
+    SocialMemberStatus["DELETING"] = "deleting";
+})(SocialMemberStatus || (SocialMemberStatus = {}));

package/dist/api/social/social-member.type.d.ts

@@ -0,0 +1,79 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { SocialFollowState } from './social-follow-state.enum.js';
+import type { SocialMemberStatus } from './social-member-status.enum.js';
+/** The smallest face of a person: what appears beside a post, a comment or a message. */
+export interface SocialMemberCard {
+    id: UUID;
+    handle: string;
+    displayName: string;
+    avatarUrl: Nullable<string>;
+    isPrivate: boolean;
+}
+export interface SocialRelationship {
+    /** Whether the viewer follows this member. */
+    following: SocialFollowState;
+    /** Whether this member follows the viewer. */
+    followedBy: SocialFollowState;
+    isMuted: boolean;
+    isBlocked: boolean;
+}
+export interface SocialProfile extends SocialMemberCard {
+    bio: Nullable<string>;
+    websiteUrl: Nullable<string>;
+    followerCount: number;
+    followingCount: number;
+    postCount: number;
+    joinedAt: IsoDateTime;
+    isSelf: boolean;
+    /** Absent for your own profile and for a visitor with no account. */
+    relationship: Nullable<SocialRelationship>;
+    /** False for a private account the viewer does not follow, whose posts stay out of reach. */
+    canViewContent: boolean;
+    hasStory: boolean;
+}
+/** A member reading about themselves. */
+export interface SocialMe extends SocialProfile {
+    status: SocialMemberStatus;
+    suspendedUntil: Nullable<IsoDateTime>;
+    /** The day this member turns 18. Absent for an adult. */
+    minorUntil: Nullable<string>;
+    isEmailConfirmed: boolean;
+    deletionScheduledFor: Nullable<IsoDateTime>;
+    acceptedTermsVersion: string;
+    unreadActivityCount: number;
+    unreadMessageCount: number;
+}
+export interface CreateSocialProfileRequest {
+    handle: string;
+    displayName: string;
+    /** `YYYY-MM-DD`. Checked and not stored. */
+    birthDate: string;
+    acceptedTermsVersion: string;
+}
+export interface UpdateSocialProfileRequest {
+    handle?: string;
+    displayName?: string;
+    bio?: Nullable<string>;
+    websiteUrl?: Nullable<string>;
+    isPrivate?: boolean;
+}
+export interface SocialHandleAvailability {
+    handle: string;
+    isAvailable: boolean;
+}
+/** One line of a followers list, a following list or a follow-request list. */
+export interface SocialMemberListItem {
+    member: SocialMemberCard;
+    relationship: Nullable<SocialRelationship>;
+    since: IsoDateTime;
+}
+export interface SocialPreferences {
+    emailOnMessage: boolean;
+    emailOnFollow: boolean;
+    emailOnMention: boolean;
+    emailOnComment: boolean;
+    /** Whether somebody you do not follow can start a conversation at all. */
+    allowMessageRequests: boolean;
+}

package/dist/api/social/social-member.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/social/social-moderation-reason.enum.d.ts

@@ -0,0 +1,13 @@
+/** The rule a moderator says was broken. Shown to the member in their own language. */
+export declare enum SocialModerationReason {
+    SPAM = "spam",
+    HARASSMENT = "harassment",
+    HATE = "hate",
+    VIOLENCE = "violence",
+    NUDITY = "nudity",
+    CHILD_SAFETY = "child-safety",
+    SELF_HARM = "self-harm",
+    IMPERSONATION = "impersonation",
+    ILLEGAL = "illegal",
+    OTHER = "other"
+}

package/dist/api/social/social-moderation-reason.enum.js

@@ -0,0 +1,14 @@
+/** The rule a moderator says was broken. Shown to the member in their own language. */
+export var SocialModerationReason;
+(function (SocialModerationReason) {
+    SocialModerationReason["SPAM"] = "spam";
+    SocialModerationReason["HARASSMENT"] = "harassment";
+    SocialModerationReason["HATE"] = "hate";
+    SocialModerationReason["VIOLENCE"] = "violence";
+    SocialModerationReason["NUDITY"] = "nudity";
+    SocialModerationReason["CHILD_SAFETY"] = "child-safety";
+    SocialModerationReason["SELF_HARM"] = "self-harm";
+    SocialModerationReason["IMPERSONATION"] = "impersonation";
+    SocialModerationReason["ILLEGAL"] = "illegal";
+    SocialModerationReason["OTHER"] = "other";
+})(SocialModerationReason || (SocialModerationReason = {}));