activitypub.ts

import {createMutation, createQueryWithId} from '../utils/api/hooks';
import {JSONObject} from './config';

export type ActivityPubContext = string | (string | JSONObject)[];

export type ActivityPubAttachment = {
    type: string;
    mediaType?: string;
    name?: string;
    url: string;
};

export type ObjectMetadata = {
    ghostAuthors?: Array<{
        name: string;
        profile_image: string;
    }>;
};

export type FollowItem = {
    id: string;
    preferredUsername: string;
};

export type ObjectProperties = {
    '@context': ActivityPubContext;
    id: string;
    type: 'Article' | 'Link' | 'Note' | 'Tombstone';
    name: string;
    content: string | null;
    summary: string | null;
    url?: string | undefined;
    attributedTo?: ActorProperties | string | ActorProperties[] | JSONObject | JSONObject[];
    image?: string | {
        url: string;
        mediaType?: string;
        type?: string;
    };
    attachment?: ActivityPubAttachment | ActivityPubAttachment[];
    published?: string;
    createdAt?: string;
    preview?: {type: string, content: string | null};
    replyCount: number;
    likeCount: number;
    liked?: boolean;
    reposted?: boolean;
    repostCount: number;
    authored: boolean;
    metadata?: ObjectMetadata;
}

export type ActorProperties = {
    '@context': ActivityPubContext;
    attachment?: {
        type: string;
        name: string;
        value: string;
    }[];
    discoverable: boolean;
    featured: string;
    followers: string;
    following: string;
    id: string | null;
    image: {
        url: string;
    };
    icon: {
        url: string;
    };
    inbox: string;
    manuallyApprovesFollowers: boolean;
    name: string;
    outbox: string;
    preferredUsername: string;
    handle?: string;
    followedByMe?: boolean;
    followsMe?: boolean;
    followingCount?: number;
    followerCount?: number;
    bio?: string;
    avatarUrl?: string | null;
    publicKey: {
        id: string;
        owner: string;
        publicKeyPem: string;
    };
    published: string;
    summary: string;
    type: 'Person';
    url: string;
}

export type Activity = {
    '@context': string;
    id: string;
    type: string;
    actor: ActorProperties;
    object: ObjectProperties;
    to: string;
}

export type InboxResponseData = {
    '@context': string;
    id: string;
    summary: string;
    type: 'OrderedCollection';
    totalItems: number;
    items: Activity[];
}

export type FollowingResponseData = {
    '@context': string;
    id: string;
    summary: string;
    type: string;
    totalItems: number;
    items: FollowItem[];
}

type FollowRequestProps = {
    username: string
}

export const useFollow = createMutation<object, FollowRequestProps>({
    method: 'POST',
    useActivityPub: true,
    path: data => `/actions/follow/${data.username}`
});

export const useUnfollow = createMutation<object, FollowRequestProps>({
    method: 'POST',
    useActivityPub: true,
    path: data => `/actions/unfollow/${data.username}`
});

// This is a frontend root, not using the Ghost admin API
export const useBrowseInboxForUser = createQueryWithId<InboxResponseData>({
    dataType: 'InboxResponseData',
    useActivityPub: true,
    headers: {
        Accept: 'application/activity+json'
    },
    path: id => `/reader/${id}`
});

// This is a frontend root, not using the Ghost admin API
export const useBrowseFollowingForUser = createQueryWithId<FollowingResponseData>({
    dataType: 'FollowingResponseData',
    useActivityPub: true,
    headers: {
        Accept: 'application/activity+json'
    },
    path: id => `/following/${id}`
});

// This is a frontend root, not using the Ghost admin API
export const useBrowseFollowersForUser = createQueryWithId<FollowingResponseData>({
    dataType: 'FollowingResponseData',
    useActivityPub: true,
    headers: {
        Accept: 'application/activity+json'
    },
    path: id => `/followers/${id}`
});