rotion 0.4.0 → 1.0.0

package/dist/ui/types.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactNode } from 'react';
-import { ListBlockChildrenResponse, BulletedListItemBlockObjectResponse, NumberedListItemBlockObjectResponse, TableBlockObjectResponse, ToggleBlockObjectResponse, ColumnListBlockObjectResponse, ChildPageBlockObjectResponse, ChildDatabaseBlockObjectResponse, BookmarkBlockObjectResponse, RichTextItemResponse, CalloutBlockObjectResponse, ImageBlockObjectResponse, VideoBlockObjectResponse, EmbedBlockObjectResponse, TextRichTextItemResponse, EquationRichTextItemResponse, ParagraphBlockObjectResponse, BreadcrumbBlockObjectResponse, FileBlockObjectResponse, PdfBlockObjectResponse, SyncedBlockBlockObjectResponse, Heading1BlockObjectResponse, Heading2BlockObjectResponse, Heading3BlockObjectResponse, QuoteBlockObjectResponse, ToDoBlockObjectResponse, TemplateBlockObjectResponse, EquationBlockObjectResponse, CodeBlockObjectResponse, DividerBlockObjectResponse, TableOfContentsBlockObjectResponse, ColumnBlockObjectResponse, LinkToPageBlockObjectResponse, TableRowBlockObjectResponse, AudioBlockObjectResponse, LinkPreviewBlockObjectResponse, UnsupportedBlockObjectResponse, PageObjectResponse, GetPagePropertyResponse, DatabaseObjectResponse, QueryDatabaseResponse, MentionRichTextItemResponse, GetSelfResponse } from '@notionhq/client/build/src/api-endpoints.js';
+import { ListBlockChildrenResponse, BulletedListItemBlockObjectResponse, NumberedListItemBlockObjectResponse, TableBlockObjectResponse, ToggleBlockObjectResponse, ColumnListBlockObjectResponse, ChildPageBlockObjectResponse, ChildDatabaseBlockObjectResponse, BookmarkBlockObjectResponse, RichTextItemResponse, CalloutBlockObjectResponse, ImageBlockObjectResponse, VideoBlockObjectResponse, EmbedBlockObjectResponse, TextRichTextItemResponse, EquationRichTextItemResponse, ParagraphBlockObjectResponse, BreadcrumbBlockObjectResponse, FileBlockObjectResponse, PdfBlockObjectResponse, SyncedBlockBlockObjectResponse, Heading1BlockObjectResponse, Heading2BlockObjectResponse, Heading3BlockObjectResponse, QuoteBlockObjectResponse, ToDoBlockObjectResponse, TemplateBlockObjectResponse, EquationBlockObjectResponse, CodeBlockObjectResponse, DividerBlockObjectResponse, TableOfContentsBlockObjectResponse, ColumnBlockObjectResponse, LinkToPageBlockObjectResponse, TableRowBlockObjectResponse, AudioBlockObjectResponse, LinkPreviewBlockObjectResponse, UnsupportedBlockObjectResponse, PageObjectResponse, GetPagePropertyResponse, DatabaseObjectResponse, QueryDatabaseResponse, MentionRichTextItemResponse, GetSelfResponse, GetPageResponse } from '@notionhq/client/build/src/api-endpoints.js';
 import { ParsedUrlQueryInput } from 'node:querystring';
 import { UrlObject } from 'node:url';
 
@@ -356,37 +356,61 @@ interface Link extends React.FC<{
 }> {
 }
 
+interface GalleryPreviewOptions {
+    preview?: 'cover' | 'content';
+    size?: 'small' | 'medium' | 'large';
+    fit?: boolean;
+    height?: {
+        small: string;
+        medium: string;
+        large: string;
+    } | string;
+}
+
 interface GalleryProps {
     keys: string[];
     db: FetchDatabaseRes;
-    href?: string;
+    options?: GalleryOptions;
+}
+interface GalleryOptions {
+    href?: {
+        [key: string]: string;
+    };
     link?: Link;
     query?: ParsedUrlQueryInput;
-    preview?: 'cover' | 'content';
-    size?: 'small' | 'medium' | 'large';
-    fit?: boolean;
+    image?: GalleryPreviewOptions;
+    prefix?: {
+        [key: string]: string;
+    };
+    suffix?: {
+        [key: string]: string;
+    };
 }
 
-declare const Gallery: ({ keys, db, href, link, query, preview, size, fit }: GalleryProps) => React.JSX.Element;
+declare const Gallery: ({ keys, db, options }: GalleryProps) => React.JSX.Element;
 
 interface GalleryCardProps {
     keys: string[];
     page: PageObjectResponseEx;
-    href: string;
+    options?: GalleryOptions;
+}
+
+declare const GalleryCard: ({ keys, page, options }: GalleryCardProps) => React.JSX.Element;
+
+interface GalleryPropertyOptions {
+    pathname?: string;
     link?: Link;
     query?: ParsedUrlQueryInput;
-    preview?: 'cover' | 'content';
-    size: 'small' | 'medium' | 'large';
-    fit: boolean;
+    prefix?: string;
+    suffix?: string;
 }
 
-declare const GalleryCard: ({ keys, page, href, link, query, preview, size, fit }: GalleryCardProps) => React.JSX.Element;
-
 interface GalleryCheckboxFieldProps {
     checked: boolean;
+    options?: GalleryPropertyOptions;
 }
 
-declare const GalleryCheckboxField: ({ checked }: GalleryCheckboxFieldProps) => React.JSX.Element;
+declare const GalleryCheckboxField: ({ checked, options }: GalleryCheckboxFieldProps) => React.JSX.Element;
 
 interface GalleryDateFieldProps {
     date: DateResponse | null;
@@ -396,18 +420,24 @@ declare const GalleryDateField: ({ date }: GalleryDateFieldProps) => React.JSX.E
 
 interface GalleryMultiSelectFieldProps {
     multiSelect: SelectPropertyResponse[];
-    path: string;
-    link?: Link;
-    query?: ParsedUrlQueryInput;
+    options?: GalleryPropertyOptions;
 }
 
-declare const GalleryMultiSelectField: ({ multiSelect, path, link, query }: GalleryMultiSelectFieldProps) => React.JSX.Element;
+declare const GalleryMultiSelectField$1: ({ multiSelect, options }: GalleryMultiSelectFieldProps) => React.JSX.Element;
+
+interface GallerySelectFieldProps {
+    select: SelectPropertyResponse;
+    options?: GalleryPropertyOptions;
+}
+
+declare const GalleryMultiSelectField: ({ select, options }: GallerySelectFieldProps) => React.JSX.Element;
 
 interface GalleryNumberFieldProps {
     number: number | null;
+    options?: GalleryPropertyOptions;
 }
 
-declare const GalleryNumberField: ({ number }: GalleryNumberFieldProps) => React.JSX.Element;
+declare const GalleryNumberField: ({ number, options }: GalleryNumberFieldProps) => React.JSX.Element;
 
 interface GalleryRichTextFieldProps {
     textObjects: RichTextItemResponseEx[] | RichTextItemResponse[];
@@ -428,22 +458,49 @@ interface GalleryUrlFieldProps {
 
 declare const GalleryUrlField: ({ url }: GalleryUrlFieldProps) => React.JSX.Element;
 
+interface GalleryFormulaFieldProps {
+    number: number | null;
+    options?: GalleryPropertyOptions;
+}
+
+declare const GalleryFormulaField: ({ number, options }: GalleryFormulaFieldProps) => React.JSX.Element;
+
 interface ListProps {
     keys: string[];
     db: QueryDatabaseResponseEx;
-    href: string;
+    children?: ReactNode;
+    options?: ListOptions;
+}
+interface ListOptions {
+    href?: {
+        [key: string]: string;
+    };
     link?: Link;
     query?: ParsedUrlQueryInput;
-    children?: ReactNode;
+    suffix?: {
+        [key: string]: string;
+    };
+    prefix?: {
+        [key: string]: string;
+    };
 }
 
-declare const List: ({ keys, db, href, link, query }: ListProps) => React.JSX.Element;
+declare const List: ({ keys, db, options }: ListProps) => React.JSX.Element;
+
+interface ListPropertyOptions {
+    pathname?: string;
+    link?: Link;
+    query?: ParsedUrlQueryInput;
+    suffix?: string;
+    prefix?: string;
+}
 
 interface ListCheckboxFieldProps {
     checked: boolean;
+    options?: ListPropertyOptions;
 }
 
-declare const ListCheckboxField: ({ checked }: ListCheckboxFieldProps) => React.JSX.Element;
+declare const ListCheckboxField: ({ checked, options }: ListCheckboxFieldProps) => React.JSX.Element;
 
 interface ListDateFieldProps {
     date: DateResponse | null;
@@ -453,18 +510,24 @@ declare const ListDateField: ({ date }: ListDateFieldProps) => React.JSX.Element
 
 interface ListMultiSelectFieldProps {
     multiSelect: SelectPropertyResponse[];
-    path: string;
-    link?: Link;
-    query?: ParsedUrlQueryInput;
+    options?: ListPropertyOptions;
 }
 
-declare const ListMultiSelectField: ({ multiSelect, path, link, query }: ListMultiSelectFieldProps) => React.JSX.Element;
+declare const ListMultiSelectField: ({ multiSelect, options }: ListMultiSelectFieldProps) => React.JSX.Element;
+
+interface ListSelectFieldProps {
+    select: SelectPropertyResponse;
+    options?: ListPropertyOptions;
+}
+
+declare const ListSelectField: ({ select, options }: ListSelectFieldProps) => React.JSX.Element;
 
 interface ListNumberFieldProps {
     number: number | null;
+    options?: ListPropertyOptions;
 }
 
-declare const ListNumberField: ({ number }: ListNumberFieldProps) => React.JSX.Element;
+declare const ListNumberField: ({ number, options }: ListNumberFieldProps) => React.JSX.Element;
 
 interface ListRichTextFieldProps {
     textObjects: RichTextItemResponseEx[] | RichTextItemResponse[];
@@ -474,13 +537,10 @@ declare const ListRichTextField: ({ textObjects }: ListRichTextFieldProps) => Re
 
 interface ListTitleFieldProps {
     textObjects: RichTextItemResponseEx[] | RichTextItemResponse[];
-    path: string;
-    slug: string;
-    link?: Link;
-    query?: ParsedUrlQueryInput;
+    options?: ListPropertyOptions;
 }
 
-declare const ListTitleField: ({ textObjects, path, slug, link, query }: ListTitleFieldProps) => React.JSX.Element;
+declare const ListTitleField: ({ textObjects, options }: ListTitleFieldProps) => React.JSX.Element;
 
 interface ListUrlFieldProps {
     url: string | null;
@@ -488,22 +548,50 @@ interface ListUrlFieldProps {
 
 declare const ListUrlField: ({ url }: ListUrlFieldProps) => React.JSX.Element;
 
+interface ListFormulaFieldProps {
+    number: number | null;
+    options?: ListPropertyOptions;
+}
+
+declare const ListFormulaField: ({ number, options }: ListFormulaFieldProps) => React.JSX.Element;
+
 interface TableProps {
     keys: string[];
     db: QueryDatabaseResponseEx;
-    href?: string;
+    children?: ReactNode;
+    options?: TableOptions;
+}
+interface TableOptions {
+    href?: {
+        [key: string]: string;
+    };
     link?: Link;
     query?: ParsedUrlQueryInput;
-    children?: ReactNode;
+    prefix?: {
+        [key: string]: string;
+    };
+    suffix?: {
+        [key: string]: string;
+    };
+    verticalLines?: boolean;
 }
 
-declare const Table: ({ keys, db, href, link, query }: TableProps) => React.JSX.Element;
+declare const Table: ({ keys, db, options }: TableProps) => React.JSX.Element;
+
+interface TablePropertyOptions {
+    pathname?: string;
+    link?: Link;
+    query?: ParsedUrlQueryInput;
+    suffix?: string;
+    prefix?: string;
+}
 
 interface TableCheckboxFieldProps {
     checked: boolean;
+    options?: TablePropertyOptions;
 }
 
-declare const TableCheckboxField: ({ checked }: TableCheckboxFieldProps) => React.JSX.Element;
+declare const TableCheckboxField: ({ checked, options }: TableCheckboxFieldProps) => React.JSX.Element;
 
 interface TableDateFieldProps {
     date: DateResponse | null;
@@ -520,18 +608,17 @@ declare const TableIcon: ({ type, className }: TableIconProps) => React.JSX.Elem
 
 interface TableMultiSelectFieldProps {
     multiSelect: SelectPropertyResponse[];
-    path?: string;
-    link?: Link;
-    query?: ParsedUrlQueryInput;
+    options?: TablePropertyOptions;
 }
 
-declare const TableMultiSelectField: ({ multiSelect, path, link, query }: TableMultiSelectFieldProps) => React.JSX.Element;
+declare const TableMultiSelectField: ({ multiSelect, options }: TableMultiSelectFieldProps) => React.JSX.Element;
 
 interface TableNumberFieldProps {
     number: number | null;
+    options?: TablePropertyOptions;
 }
 
-declare const TableNumberField: ({ number }: TableNumberFieldProps) => React.JSX.Element;
+declare const TableNumberField: ({ number, options }: TableNumberFieldProps) => React.JSX.Element;
 
 interface TableRichTextFieldProps {
     textObjects: RichTextItemResponseEx[] | RichTextItemResponse[];
@@ -541,22 +628,17 @@ declare const TableRichTextField: ({ textObjects }: TableRichTextFieldProps) =>
 
 interface TableSelectFieldProps {
     select: SelectPropertyResponse;
-    path?: string;
-    link?: Link;
-    query?: ParsedUrlQueryInput;
+    options?: TablePropertyOptions;
 }
 
-declare const TableSelectField: ({ select, path, link, query }: TableSelectFieldProps) => React.JSX.Element;
+declare const TableSelectField: ({ select, options }: TableSelectFieldProps) => React.JSX.Element;
 
 interface TableTitleFieldProps {
     textObjects: RichTextItemResponseEx[] | RichTextItemResponse[];
-    path?: string;
-    slug?: string;
-    link?: Link;
-    query?: ParsedUrlQueryInput;
+    options?: TablePropertyOptions;
 }
 
-declare const TableTitleField: ({ textObjects, path, slug, link, query }: TableTitleFieldProps) => React.JSX.Element;
+declare const TableTitleField: ({ textObjects, options }: TableTitleFieldProps) => React.JSX.Element;
 
 interface TableUrlFieldProps {
     url: string | null;
@@ -564,6 +646,13 @@ interface TableUrlFieldProps {
 
 declare const TableUrlField: ({ url }: TableUrlFieldProps) => React.JSX.Element;
 
+interface TableFormulaFieldProps {
+    number: number | null;
+    options?: TablePropertyOptions;
+}
+
+declare const TableFormulaField: ({ number, options }: TableFormulaFieldProps) => React.JSX.Element;
+
 interface PageProps {
     blocks: ListBlockChildrenResponseEx;
     href?: string;
@@ -685,14 +774,6 @@ interface NumberedListBlockProps {
 
 declare const NumberedListBlock: ({ block, href, link, query }: NumberedListBlockProps) => React.JSX.Element;
 
-interface IconProps {
-    name: 'figma' | 'slack' | 'github' | 'file' | 'link';
-    width?: string;
-    height?: string;
-    className?: string;
-}
-declare const Icon: ({ name, width, height, className }: IconProps) => React.JSX.Element;
-
 interface PdfBlockProps {
     block: PdfBlockObjectResponseEx;
 }
@@ -724,14 +805,6 @@ interface TextBlockProps {
 
 declare const TextBlock: ({ tag, block }: TextBlockProps) => React.JSX.Element;
 
-interface RichTextProps {
-    textObject?: RichTextItemResponseEx | RichTextItemResponse;
-    key?: string;
-    children?: ReactNode;
-}
-
-declare const RichText: ({ textObject }: RichTextProps) => React.JSX.Element;
-
 type ToDoBlockProps = {
     block: ToDoBlockObjectResponse;
 };
@@ -750,12 +823,37 @@ interface VideoBlockProps {
 
 declare const VideoBlock: ({ block }: VideoBlockProps) => React.JSX.Element;
 
+interface IconProps {
+    name: 'figma' | 'slack' | 'github' | 'file' | 'link';
+    width?: string;
+    height?: string;
+    className?: string;
+}
+declare const Icon: ({ name, width, height, className }: IconProps) => React.JSX.Element;
+
+interface RichTextProps {
+    textObject?: RichTextItemResponseEx | RichTextItemResponse;
+    key?: string;
+    children?: ReactNode;
+}
+
+declare const RichText: ({ textObject }: RichTextProps) => React.JSX.Element;
+
+interface PrefixSuffixProps {
+    prefix?: string;
+    suffix?: string;
+    children?: ReactNode;
+}
+
+declare const PrefixSuffix: ({ prefix, suffix, children }: PrefixSuffixProps) => React.JSX.Element;
+
 declare const Checkbox: ({ bool }: {
     bool: boolean;
 }) => React.JSX.Element;
 
 declare function queryToString(q: ParsedUrlQueryInput | undefined): string;
 declare const getLinkPathAndLinkKey: (link: string) => [string, string];
+declare function getSlug(key: string, page: GetPageResponse): string;
 declare function UsePagination<T>(pages: T[], perPage: number): {
     currentData(): T[];
     next(): void;
@@ -773,4 +871,4 @@ declare function splitUrl(url: string): {
     omittedPath: string;
 };
 
-export { BookmarkBlock, BreadcrumbBlock, Breadcrumbs, BuildPlainTextByPage, BulletedListBlock, CalloutBlock, Checkbox, ChildDatabaseBlock, ChildPageBlock, CodeBlock, ColumnListBlock, EmbedBlock, EquationBlock, FileBlock, Gallery, GalleryCard, GalleryCheckboxField, GalleryDateField, GalleryMultiSelectField, GalleryNumberField, GalleryRichTextField, GalleryTitleField, GalleryUrlField, Icon, ImageBlock, type Link, LinkPreviewBlock, List, ListCheckboxField, ListDateField, ListMultiSelectField, ListNumberField, ListRichTextField, ListTitleField, ListUrlField, NumberedListBlock, Page, PdfBlock, RichText, SyncedBlock, Table, TableBlock, TableCheckboxField, TableDateField, TableIcon, TableMultiSelectField, TableNumberField, TableOfContentsBlock, TableRichTextField, TableSelectField, TableTitleField, TableUrlField, TextBlock, ToDoBlock, ToggleBlock, UsePagination, VideoBlock, getDatetimeFormat, getLinkPathAndLinkKey, pathBasename, queryToString, splitUrl };
+export { BookmarkBlock, BreadcrumbBlock, Breadcrumbs, BuildPlainTextByPage, BulletedListBlock, CalloutBlock, Checkbox, ChildDatabaseBlock, ChildPageBlock, CodeBlock, ColumnListBlock, EmbedBlock, EquationBlock, FileBlock, Gallery, GalleryCard, GalleryCheckboxField, GalleryDateField, GalleryFormulaField, GalleryMultiSelectField$1 as GalleryMultiSelectField, GalleryNumberField, GalleryRichTextField, GalleryMultiSelectField as GallerySelectField, GalleryTitleField, GalleryUrlField, Icon, ImageBlock, type Link, LinkPreviewBlock, List, ListCheckboxField, ListDateField, ListFormulaField, ListMultiSelectField, ListNumberField, ListRichTextField, ListSelectField, ListTitleField, ListUrlField, NumberedListBlock, Page, PdfBlock, PrefixSuffix, RichText, SyncedBlock, Table, TableBlock, TableCheckboxField, TableDateField, TableFormulaField, TableIcon, TableMultiSelectField, TableNumberField, TableOfContentsBlock, TableRichTextField, TableSelectField, TableTitleField, TableUrlField, TextBlock, ToDoBlock, ToggleBlock, UsePagination, VideoBlock, getDatetimeFormat, getLinkPathAndLinkKey, getSlug, pathBasename, queryToString, splitUrl };