@sandvichxyz/pecans 1.1.2 → 1.1.4

package/dist/generated/types.d.ts

@@ -0,0 +1,956 @@
+export type ThreadListResponse = TCResponse & {
+    name: string;
+    totalThreads: number;
+    category: string;
+    canCreate: boolean;
+    threads: ForumThread[];
+};
+export type ViewPostsResponse = TCResponse & {
+    posts: ForumPost[];
+    numPostsBefore: number;
+    numPostsAfter: number;
+    jumpTo: number;
+    thread: ViewThread;
+};
+export type ForumSearchResponse = TCResponse & {
+    results: ForumSearchResult[];
+};
+export type GetQuoteTextResponse = TCResponse & {
+    /**
+     * The raw text of the post being quoted.
+     */
+    originalText: string;
+    /**
+     * Username of the post's author.
+     */
+    user: string;
+};
+export type NewThreadResponse = TCResponse & {
+    /**
+     * Id of the newly created thread.
+     */
+    threadId: number;
+};
+/**
+ * A newly-created forum thread.
+ */
+export type ForumThreadFeedItem = FeedItemBase & {
+    type: "forum.thread";
+    data: {
+        /**
+         * First line(s) of the thread's opening post.
+         */
+        preview: string;
+    };
+};
+/**
+ * A newly-asked Q&A question.
+ */
+export type QaNewQuestionFeedItem = FeedItemBase & {
+    type: "qa.newquestion";
+    data: {
+        /**
+         * First line(s) of the question body.
+         */
+        preview: string;
+    };
+};
+/**
+ * An account being registered.
+ */
+export type AccountRegisterFeedItem = FeedItemBase & {
+    type: "account.register";
+    data: unknown[];
+};
+export type FeedResponse = TCResponse & {
+    /**
+     * Server-side cursor for pagination.
+     */
+    feedId: string;
+    /**
+     * The first page of feed items, newest first.
+     */
+    items: FeedItem[];
+};
+export type FeedItem = ForumThreadFeedItem | QaNewQuestionFeedItem | AccountRegisterFeedItem;
+export type FeedScrollResponse = TCResponse & {
+    /**
+     * The next page of items; absent once the feed is exhausted.
+     */
+    items?: FeedItem[];
+    /**
+     * True when there are no more items to load.
+     */
+    end?: boolean;
+};
+export type FolderViewResponse = TCResponse & {
+    hasMore: boolean;
+    hasPrevious: boolean;
+    messages: MessagePreview[];
+};
+export type MessageViewResponse = TCResponse & {
+    messages: Message[];
+    header: MessageThreadHeader;
+    /**
+     * Whether older pages exist beyond this one. Page 1 holds the most recent
+     * messages; higher page numbers are progressively older.
+     */
+    hasMore: boolean;
+};
+export type FolderListResponse = TCResponse & {
+    folders: Folder[];
+};
+export type SaveDrawingResponse = TCResponse & {
+    /**
+     * Id of the newly-created image, e.g. `img45790`.
+     */
+    newImageId: string;
+};
+export type ViewDrawingDataResponse = TCResponse & {
+    /**
+     * The raw pixel data: a flat hex string, 32×32, RGB, 6 hex chars per pixel, row-major.
+     */
+    data: string;
+};
+export type ImageBatchGetResponse = TCResponse & {
+    /**
+     * The requested images, in no guaranteed order.
+     */
+    items: ImageData[];
+};
+export type ImageGalleryListResponse = TCResponse & {
+    /**
+     * Ids of the images on this page.
+     */
+    images: ImageRef[];
+    /**
+     * Whether further pages exist beyond this one.
+     */
+    hasMore: boolean;
+};
+export type ImageInfoResponse = TCResponse & {
+    imageId: string;
+    /**
+     * Username of the image's owner.
+     */
+    owner: string;
+    /**
+     * Whether the active account owns this image.
+     */
+    isYours: boolean;
+};
+export type NotifySyncResponse = TCResponse & {
+    count: number;
+};
+export type WhosOnlineResponse = TCResponse & {
+    users: TruncatedUser[];
+};
+export type LoginResponse = TCResponse & {
+    success: boolean;
+    authToken: string;
+    yourId: string;
+};
+export type ExistingCookieResponse = TCResponse & {
+    success: boolean;
+    yourId: string;
+};
+export type LogoutResponse = TCResponse & {
+    success: boolean;
+    ripToken: string;
+    user: string;
+};
+export type AnswerReplyResponse = TCResponse & {
+    id: number;
+    time: number;
+    text: string;
+};
+/**
+ * A question on Two Cans & String.
+ */
+export type Question = TCResponse & {
+    id: number;
+    /**
+     * Unix time the question was asked.
+     */
+    time: number;
+    /**
+     * The question body text (UCP markup).
+     */
+    text: string;
+};
+/**
+ * A question viewed on the Answer page.
+ */
+export type AnswerQuestion = Question & {
+    /**
+     * Username of the asker, present only when the question is public.
+     */
+    author?: string;
+    poll?: Poll1;
+};
+export type SavedQuestionsResponse = TCResponse & {
+    questions: SavedQuestion[];
+};
+export type ListDataResponse = TCResponse & {
+    /**
+     * Question headers, without their body text.
+     */
+    questions: QuestionMetadata[];
+};
+export type QuestionTextResponse = TCResponse & {
+    /**
+     * Question bodies, keyed by id.
+     */
+    questions: QuestionText[];
+};
+/**
+ * A single question as seen on its public view page.
+ */
+export type ViewQuestionResponse = Question & {
+    /**
+     * Whether the question was asked publicly (non-anonymously).
+     */
+    isPublic: boolean;
+    /**
+     * Number of responses the question has received.
+     */
+    responseCount: number;
+    /**
+     * Username of the asker, present only when the question is public.
+     */
+    user?: string;
+    /**
+     * Whether the current user is the asker.
+     */
+    isYours: boolean;
+};
+/**
+ * A page of answers to a question you asked.
+ */
+export type AnswersResponse = TCResponse & {
+    answers: QuestionAnswer[];
+    /**
+     * Whether more answers exist beyond this page.
+     */
+    hasMore: boolean;
+    /**
+     * Cursor id for fetching the next page.
+     */
+    nextId: number;
+};
+/**
+ * The result of pinning or unpinning a question.
+ */
+export type PinToggleResponse = TCResponse & {
+    /**
+     * The question's new pinned state.
+     */
+    status: boolean;
+};
+/**
+ * The result of bumping a question.
+ */
+export type BumpQuestionResponse = TCResponse & {
+    /**
+     * The question's new expiry (inactive) time.
+     */
+    expireTime: number;
+};
+/**
+ * One answer/response, fetched by its answer id.
+ */
+export type GetResponseResponse = TCResponse & {
+    /**
+     * Id of the question this answers.
+     */
+    questionId: number;
+    /**
+     * The answer body text (UCP markup).
+     */
+    text: string;
+    /**
+     * Id of the conversation spawned from this answer, if any.
+     */
+    convoHeaderId?: number;
+};
+export type ProfileGetResponse = TCResponse & {
+    /**
+     * The looked-up user's id. `ok` is false with error `NOT_FOUND` if no such user.
+     */
+    id: string;
+};
+export type ProfileDetailsResponse = TCResponse & {
+    /**
+     * Echoes back the requested field name.
+     */
+    type: string;
+    /**
+     * The field's value; a string for text fields, a number for counts like `followers`.
+     */
+    value: {
+        [k: string]: unknown;
+    };
+};
+/**
+ * An entry in your followers list; adds block state.
+ */
+export type FollowerEntry = FollowEntry & {
+    /**
+     * True if you have blocked this follower.
+     */
+    blocked: boolean;
+};
+export type ListFollowersResponse = TCResponse & {
+    followers: FollowerEntry[];
+};
+export type ListFollowsResponse = TCResponse & {
+    follows: FollowEntry[];
+};
+export type QaGetPinnedResponse = TCResponse & {
+    /**
+     * The questions the user has pinned to their profile.
+     */
+    pinned: PinnedQuestion[];
+};
+export type NavbarGetResponse = TCResponse & {
+    /**
+     * The navigation items, in display order.
+     */
+    nav: NavItem[];
+};
+export type DashboardResponse = TCResponse & {
+    /**
+     * The most recently asked questions across the site.
+     */
+    recentQuestions: DashboardQuestion[];
+    /**
+     * The most recent forum posts across the site.
+     */
+    recentForumPosts: DashboardForumPost[];
+    pointlessNums: DashboardPointlessNums1;
+};
+export type SettingsGetResponse = TCResponse & {
+    /**
+     * The account's email address.
+     */
+    email: string;
+    /**
+     * Whether to send notifications for new private messages.
+     */
+    msgNotify: boolean;
+    /**
+     * Whether to hide the sender identity on anonymous messages.
+     */
+    msgHideAnon: boolean;
+};
+export type StoriesViewListResponse = TCResponse & {
+    stories: Story[];
+};
+export type FerrytellCreateResponse = TCResponse & {
+    /**
+     * Id of the newly created story.
+     */
+    storyId: number;
+};
+export interface TCFollowInfo {
+    in: number;
+    out: number;
+}
+export interface TCProfile {
+    id: string;
+    name: string;
+    online: number;
+    avatar: string;
+    subs: TCFollowInfo;
+}
+export interface TCResponse {
+    ok: boolean;
+    error?: string;
+    profiles?: TCProfile[];
+}
+export interface TCUser {
+    id?: string;
+    anon?: boolean;
+}
+/**
+ * An RGB color, normalized from whatever encoded form the Twocans API uses.
+ */
+export interface Rgb {
+    r: number;
+    g: number;
+    b: number;
+}
+export interface ForumCategory {
+    id: string;
+    name: string;
+    description: string;
+    threads: number;
+    posts: number;
+    newThreads: number;
+}
+export interface ForumCategoriesResponse {
+    categories: ForumCategory[];
+}
+export interface ThreadListPost {
+    id: number;
+    author: string;
+    text: string;
+    time: number;
+    category: string;
+    thread: number;
+}
+export interface ForumThread {
+    id: number;
+    views: number;
+    replies: number;
+    title: string;
+    category: string;
+    new: boolean;
+    firstPost: ThreadListPost;
+    lastPost: ThreadListPost;
+}
+export interface ForumPost {
+    id: number;
+    user: string;
+    text: string;
+    ucpText: string;
+    ucpEnabled: boolean;
+    time: number;
+    new: boolean;
+}
+export interface ViewThread {
+    id: number;
+    lastPostId: number;
+    title: string;
+    locked: boolean;
+}
+export interface ForumSearchResult {
+    post: ThreadListPost;
+    threadTitle: string;
+}
+export interface FeedItemBase {
+    id: number;
+    /**
+     * Unix time the activity happened.
+     */
+    time: number;
+    /**
+     * Username of the account the item belongs to.
+     */
+    owner: string;
+    /**
+     * Relative path to the item on the site, e.g. `/forum/blogs/11894`.
+     */
+    url: string;
+    /**
+     * Display title for the item (may be empty for questions).
+     */
+    title: string;
+}
+export interface MessagePreview {
+    id: string;
+    subject: string;
+    preview: string;
+    time: number;
+    users: TCUser[];
+    new?: boolean;
+}
+export interface Message {
+    id: number;
+    member: number;
+    time: number;
+    type: string;
+    html: string;
+    new?: boolean;
+}
+export interface MessageFolder {
+    id: string;
+    name: string;
+}
+export interface MessageThreadMember {
+    mid: number;
+    anon?: boolean;
+    readTo: number;
+    id?: string;
+    you?: boolean;
+}
+export interface MessageThreadHeader {
+    title: string;
+    members: MessageThreadMember[];
+    folder: MessageFolder;
+}
+export interface Folder {
+    id: string;
+    name: string;
+}
+export interface ImageData {
+    /**
+     * Image id, e.g. `img45788`.
+     */
+    id: string;
+    /**
+     * Base64-encoded PNG, prefixed with the literal string `B64`.
+     */
+    data: string;
+}
+export interface ImageRef {
+    /**
+     * Image id, e.g. `img45788`.
+     */
+    id: string;
+}
+export interface TruncatedUser {
+    id: string;
+}
+export interface PollOption {
+    text: string;
+    color: string;
+    votes?: number;
+    yours?: boolean;
+}
+export interface Poll {
+    options: PollOption[];
+    answered: boolean;
+}
+/**
+ * The attached poll, if this is a poll-type question.
+ */
+export interface Poll1 {
+    options: PollOption[];
+    answered: boolean;
+}
+/**
+ * A question the user has saved for later, as shown on the
+ * Saved Questions page.
+ */
+export interface SavedQuestion {
+    /**
+     * The question id.
+     */
+    id: number;
+    /**
+     * Short preview of the question body.
+     */
+    preview: string;
+}
+export interface PollOptionRaw {
+    /**
+     * Number of votes this option has received.
+     */
+    n: number;
+    /**
+     * Option index or choice id.
+     */
+    c: number;
+}
+export interface PollMetadataRaw {
+    id: number;
+    options: PollOptionRaw[];
+}
+/**
+ * The header for one question: everything except the question body itself.
+ * Returned by `listData`; the body is fetched separately via `qtext`.
+ */
+export interface QuestionMetadata {
+    id: number;
+    /**
+     * Whether the question is still activate.
+     */
+    isActive: boolean;
+    /**
+     * Total number of replies.
+     */
+    replyCount: number;
+    /**
+     * Total number of new replies (not yet marked as read).
+     */
+    newReplyCount: number;
+    /**
+     * Unix time at which the question closes.
+     */
+    expireTime: number;
+    /**
+     * Unix time at which the question was asked.
+     */
+    creationTime: number;
+    /**
+     * Whether the question was asked publicly (non-anonymously).
+     */
+    isPublic: boolean;
+    /**
+     * Whether this is a free-text question or a poll.
+     */
+    questionType: "text" | "poll";
+}
+export interface QuestionText {
+    id: number;
+    /**
+     * The question's body text.
+     */
+    text: string;
+}
+/**
+ * One answer to a question you asked, as returned by `getAnswers`.
+ */
+export interface QuestionAnswer {
+    id: number;
+    /**
+     * The answer body text (UCP markup).
+     */
+    body: string;
+    /**
+     * Unix time the answer was posted.
+     */
+    time: number;
+    /**
+     * Id of the question this answers.
+     */
+    questionId: number;
+    /**
+     * Id of the conversation spawned from this answer, or 0 if none.
+     */
+    convoId: number;
+    /**
+     * Whether the answer is unread.
+     */
+    unread: boolean;
+}
+/**
+ * A fully populated question with metadata and body text.
+ */
+export interface QuestionData {
+    /**
+     * The question's body text.
+     */
+    body: string;
+    header: QuestionMetadata1;
+}
+/**
+ * The header for one question: everything except the question body itself.
+ * Returned by `listData`; the body is fetched separately via `qtext`.
+ */
+export interface QuestionMetadata1 {
+    id: number;
+    /**
+     * Whether the question is still activate.
+     */
+    isActive: boolean;
+    /**
+     * Total number of replies.
+     */
+    replyCount: number;
+    /**
+     * Total number of new replies (not yet marked as read).
+     */
+    newReplyCount: number;
+    /**
+     * Unix time at which the question closes.
+     */
+    expireTime: number;
+    /**
+     * Unix time at which the question was asked.
+     */
+    creationTime: number;
+    /**
+     * Whether the question was asked publicly (non-anonymously).
+     */
+    isPublic: boolean;
+    /**
+     * Whether this is a free-text question or a poll.
+     */
+    questionType: "text" | "poll";
+}
+/**
+ * One choice in a new poll question.
+ */
+export interface NewPollChoice {
+    /**
+     * Display label for the choice.
+     */
+    label: string;
+    /**
+     * 6-digit hex color (no leading `#`), e.g. "ff0000", or the name of a color.
+     */
+    color: string;
+}
+/**
+ * The poll attached to a new poll-type question.
+ */
+export interface NewPoll {
+    choices: NewPollChoice[];
+}
+/**
+ * The body of a new question, serialized as JSON into the legacy askapi's
+ * `rawEmbeddedJsonLolInternalTechDebt` field.
+ */
+export interface PostQuestionBody {
+    /**
+     * The question text.
+     */
+    text: string;
+    /**
+     * Whether the question was asked publicly (non-anonymously).
+     */
+    isPublic: boolean;
+    /**
+     * Whether the question carries a poll.
+     */
+    hasPoll: boolean;
+    poll?: NewPoll1;
+}
+/**
+ * The poll attached to a new poll-type question.
+ */
+export interface NewPoll1 {
+    choices: NewPollChoice[];
+}
+/**
+ * One entry in a follower/following list.
+ */
+export interface FollowEntry {
+    /**
+     * The other user's id.
+     */
+    id: string;
+    /**
+     * True if the follow relationship is reciprocated.
+     */
+    mutual: boolean;
+}
+export interface PinnedQuestion {
+    id: number;
+    /**
+     * First line(s) of the question body.
+     */
+    preview: string;
+    /**
+     * Unix time the question was asked.
+     */
+    time: number;
+}
+export interface NavItem {
+    /**
+     * Stable id for the destination, e.g. `feed`, `forum`.
+     */
+    id: string;
+    /**
+     * Path the item links to, e.g. `/forum`.
+     */
+    url: string;
+    /**
+     * Human-readable label, e.g. `Home Feed`.
+     */
+    label: string;
+    /**
+     * Image id for the item's icon.
+     */
+    icon: string;
+    /**
+     * Notification feature key to badge this item against, if any.
+     */
+    notify?: string;
+}
+export interface DashboardQuestion {
+    id: number;
+    /**
+     * Unix time the question was asked.
+     */
+    time: number;
+    /**
+     * First line(s) of the question body.
+     */
+    preview: string;
+}
+/**
+ * The forum category a recent post belongs to.
+ */
+export interface DashboardForumCategory {
+    /**
+     * Category slug, e.g. `games`.
+     */
+    key: string;
+    /**
+     * Human-readable category name.
+     */
+    name: string;
+    /**
+     * Relative path to the category, e.g. `/forum/games`.
+     */
+    url: string;
+}
+/**
+ * The thread a recent post belongs to.
+ */
+export interface DashboardForumThread {
+    /**
+     * Thread title.
+     */
+    name: string;
+    /**
+     * Relative path to the thread, e.g. `/forum/games/5753`.
+     */
+    url: string;
+}
+/**
+ * A recent forum post shown on the dashboard.
+ */
+export interface DashboardForumPost {
+    id: number;
+    /**
+     * First line(s) of the post body.
+     */
+    preview: string;
+    /**
+     * Relative path that jumps to the post, e.g. `/forum/games/gotopost/1347214/#post1347214`.
+     */
+    url: string;
+    /**
+     * Username of the post's author.
+     */
+    user: string;
+    thread: DashboardForumThread1;
+    category: DashboardForumCategory1;
+}
+/**
+ * The thread a recent post belongs to.
+ */
+export interface DashboardForumThread1 {
+    /**
+     * Thread title.
+     */
+    name: string;
+    /**
+     * Relative path to the thread, e.g. `/forum/games/5753`.
+     */
+    url: string;
+}
+/**
+ * The forum category a recent post belongs to.
+ */
+export interface DashboardForumCategory1 {
+    /**
+     * Category slug, e.g. `games`.
+     */
+    key: string;
+    /**
+     * Human-readable category name.
+     */
+    name: string;
+    /**
+     * Relative path to the category, e.g. `/forum/games`.
+     */
+    url: string;
+}
+/**
+ * Site-wide vanity counters shown on the dashboard.
+ */
+export interface DashboardPointlessNums {
+    /**
+     * Total number of registered users.
+     */
+    usersRegistered: number;
+    /**
+     * Total number of questions and answers ever posted.
+     */
+    questionsAndAnswers: number;
+}
+/**
+ * Site-wide vanity counters shown on the dashboard.
+ */
+export interface DashboardPointlessNums1 {
+    /**
+     * Total number of registered users.
+     */
+    usersRegistered: number;
+    /**
+     * Total number of questions and answers ever posted.
+     */
+    questionsAndAnswers: number;
+}
+/**
+ * One line of text on a story. The color is normalized to an `Rgb` struct in
+ * both directions, though the wire form is asymmetric: a packed 0xRRGGBB
+ * integer when creating a story, an `[r, g, b]` tuple when reading one back.
+ */
+export interface StoryLine {
+    /**
+     * The line's text content.
+     */
+    value: string;
+    color: Rgb1;
+}
+/**
+ * An RGB color, normalized from whatever encoded form the Twocans API uses.
+ */
+export interface Rgb1 {
+    r: number;
+    g: number;
+    b: number;
+}
+/**
+ * The three lines of text composing a story.
+ */
+export interface StoryText {
+    top: StoryLine;
+    middle: StoryLine;
+    bottom: StoryLine;
+}
+/**
+ * The background of a story, as sent when creating one.
+ */
+export interface StoryBackgroundInput {
+    /**
+     * Background kind, e.g. "image".
+     */
+    type: string;
+    /**
+     * Image id, present when `type` is "image".
+     */
+    image?: string;
+}
+/**
+ * The background of a story, as returned by the view list.
+ */
+export interface StoryBackground {
+    /**
+     * True when the background is an image rather than a solid color.
+     */
+    isImage: boolean;
+    /**
+     * Image id, present when `isImage` is true.
+     */
+    imageId?: string;
+}
+/**
+ * A story shown in the stories tray.
+ */
+export interface Story {
+    /**
+     * Id of the user whose story this is.
+     */
+    userId: string;
+    background: StoryBackground1;
+    text: StoryText1;
+}
+/**
+ * The background of a story, as returned by the view list.
+ */
+export interface StoryBackground1 {
+    /**
+     * True when the background is an image rather than a solid color.
+     */
+    isImage: boolean;
+    /**
+     * Image id, present when `isImage` is true.
+     */
+    imageId?: string;
+}
+/**
+ * The three lines of text composing a story.
+ */
+export interface StoryText1 {
+    top: StoryLine;
+    middle: StoryLine;
+    bottom: StoryLine;
+}
+//# sourceMappingURL=types.d.ts.map