@select-org/select-post-builder 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -0,0 +1,287 @@
+import { default as default_2 } from 'react';
+import { JSONContent } from '@tiptap/react';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+declare type AppUserPayload = {
+    users: Array<UserPayload>;
+    background: string;
+    username: string;
+    relationship: 2;
+    refresh_token: string;
+    name: string;
+    new_user: boolean;
+    longitude: number;
+    latitude: number;
+    jwtoken: string;
+    id: string;
+    gender: string;
+    birthday: string;
+    avatar: string;
+    avatarPlaceholder: string;
+    highResolutionAvatar: string;
+    twitterUsername: string;
+    email: string;
+    description: string;
+    email_verified: boolean;
+    featured_groups: string[];
+};
+
+declare type BasePollOptionItem = {
+    key: string;
+    option_id: string;
+    option_color: string;
+};
+
+declare interface ImageInfo {
+    width: number;
+    height: number;
+    url: string;
+    isBase64: boolean;
+}
+
+declare enum MediaItemType {
+    MEDIA_ITEM = "mediaItem",
+    IMAGE_ITEM = "imageItem"
+}
+
+declare type MentionData = {
+    id: string;
+    selectId: string;
+    matchStartPosition: number;
+    name: string;
+    avatar: string;
+    type: MentionType;
+    inThisThread: number;
+    from?: PostType;
+    isCrossExposureEnable?: boolean;
+};
+
+declare enum MentionType {
+    User = "mention",
+    Group = "hashtag"
+}
+
+declare type PollChoiceItem = PollPostTextOptionItem | PollPostMediaOptionItem;
+
+declare type PollPostMediaOptionItem = BasePollOptionItem & PostCreationMediaItem;
+
+declare type PollPostTextOptionItem = BasePollOptionItem & {
+    type: PollType;
+    text: string;
+};
+
+declare enum PollType {
+    POLL_TEXT_ITEM = "pollTextItem",
+    POLL_IMAGE_ITEM = "pollImageItem",
+    POLL_MEDIA_ITEM = "pollMediaItem"
+}
+
+export declare interface PostBuilderConfig {
+    children: ReactNode;
+    apiBaseURL: {
+        core: string;
+        mfs: string;
+        fileStore: string;
+    };
+    authToken: string;
+    toI18N: (key: string) => string;
+    i18nKeys?: PostBuilderI18nKeys;
+}
+
+export declare const PostBuilderEditor: default_2.FC<PostBuilderEditorProps>;
+
+declare type PostBuilderEditorProps = {
+    groupId?: string;
+    postId?: string;
+    user?: AppUserPayload;
+    hideGroupSelector?: boolean;
+    showModal?: boolean;
+    isSubmitting?: boolean;
+    onCreatePost: (params: {
+        payload: Partial<PostCreationData>;
+        html: string;
+        json: JSONContent;
+        text: string;
+    }) => void;
+    clearOnSuccess?: boolean;
+};
+
+declare interface PostBuilderI18nKeys {
+    addImageKey: string;
+    boldMarkKey: string;
+    italicMarkKey: string;
+}
+
+export declare const PostBuilderProvider: ({ children, apiBaseURL, authToken, toI18N, i18nKeys, }: PostBuilderConfig) => JSX_2.Element;
+
+declare type PostCreationData = {
+    body: string;
+    htmlBody?: string;
+    items: Array<PostCreationMediaItem | PollChoiceItem>;
+    mentionData: MentionData[];
+    specialType: SpecialType;
+    sendCrossMention?: boolean;
+    type: string;
+    postId: string;
+    timestamp: number;
+};
+
+declare type PostCreationMediaItem = {
+    key: string;
+    type: MediaItemType | PollType;
+    imageType: string;
+    compressVideoPath?: string;
+    playableDuration?: number | null;
+    preloadUrl?: boolean;
+    size?: number;
+    searchFrom?: string | null;
+    sources: {
+        original: ImageInfo;
+        thumbnail: ImageInfo;
+        placeholder?: ImageInfo;
+    };
+};
+
+declare enum PostType {
+    Post = "post",
+    Comment = "comment"
+}
+
+declare enum SpecialType {
+    POST = 0,
+    FEATURED_POST = 1
+}
+
+declare type UserPayload = {
+    id: string;
+    username: string;
+    name: string;
+    avatar: string;
+    avatarPlaceholder: string;
+    highResolutionAvatar: string;
+    gender: string;
+    birthday: string;
+    description?: string;
+    type?: string;
+    latitude?: number;
+    longitude?: number;
+    relationship?: number;
+    interactionIds?: Array<string>;
+};
+
+export { }
+
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        media: {
+            /**
+             * Insert a media node (image, video, or audio)
+             */
+            insertMedia: (options: MediaAttrs) => ReturnType;
+            /**
+             * Update media node attributes by uid
+             */
+            updateMediaByUid: (uid: string, attrs: Partial<MediaAttrs>) => ReturnType;
+            /**
+             * Delete media node by uid
+             */
+            deleteMediaByUid: (uid: string) => ReturnType;
+            /**
+             * Update media upload progress by uid
+             */
+            updateMediaProgress: (uid: string, progress: number) => ReturnType;
+        };
+    }
+}
+
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        poll: {
+            insertPoll: (attrs: {
+                choices: PollChoiceItem[];
+            }) => ReturnType;
+        };
+    }
+}
+
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        customLink: {
+            /**
+             * Insert a new link mark with preview
+             */
+            insertLink: (attrs: LinkMarkAttrs) => ReturnType;
+            /**
+             * Update an existing link mark with its preview
+             */
+            updateLink: (uid: string, attrs: Partial<Omit<LinkMarkAttrs, 'uid'>>) => ReturnType;
+            /**
+             * Update media node attributes by uid
+             */
+            updateLinkByUid: (uid: string, attrs: Partial<LinkMarkAttrs>) => ReturnType;
+            /**
+             * Delete link preview node by uid
+             */
+            deleteLinkByUid: (uid: string) => ReturnType;
+        };
+    }
+}
+
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        iframe: {
+            /**
+             * Insert an iframe node into the document
+             */
+            setIframe: (options: {
+                src: string;
+                width?: string;
+                height?: string;
+            }) => ReturnType;
+        };
+    }
+}
+
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        smartMediaUpload: {
+            insertMediaWithUpload: (params: {
+                source: File | Blob | string;
+                type: MediaNodeTypes;
+                mediaType?: MediaItemType;
+                caption?: string;
+                searchFrom?: ImageSearchFrom;
+            }) => ReturnType;
+        };
+    }
+}
+
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        linkPreview: {
+            /**
+             * Insert a new link preview node
+             */
+            setLinkPreview: (attributes: LinkPreviewAttributes) => ReturnType;
+            /**
+             * Update an existing link preview node
+             */
+            updateLinkPreview: (attributes: LinkPreviewAttributes) => ReturnType;
+            /**
+             * Update media node attributes by uid
+             */
+            updateLinkPreviewByUid: (uid: string, attrs: Partial<LinkPreviewAttributes>) => ReturnType;
+            /**
+             * Delete link preview node by uid
+             */
+            deleteLinkPreviewByUid: (uid: string) => ReturnType;
+        };
+    }
+}