@topwrite/reader 1.0.21 → 1.0.22-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@topwrite/reader",
-    "version": "1.0.21",
+    "version": "1.0.22-alpha.10+95bc5a4",
     "author": "yunwuxin <tzzhangyajun@qq.com> (https://github.com/yunwuxin)",
     "license": "ISC",
     "types": "types/index.d.ts",
@@ -34,6 +34,7 @@
         "crypto-browserify": "^3.12.0",
         "path-browserify": "^1.0.1",
         "process": "^0.11.10",
+        "query-string": "^7.1.1",
         "rimraf": "^3.0.2",
         "stream-browserify": "^3.0.0",
         "typescript": "^4.3.5",
@@ -52,5 +53,5 @@
             "optional": true
         }
     },
-    "gitHead": "d47b9a938e2e633170b48bc8fe811f36f749f8b8"
+    "gitHead": "95bc5a48adc8b85eddc8e122fc89c9e05d176555"
 }

package/types/components/asset.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    element: 't-attachment' | 'img' | 'video' | 'audio';
+    src?: string;
+}
+export default function Asset({ element, src, ...props }: Props): JSX.Element;
+export {};

package/types/components/breadcrumb.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    className?: string;
+}
+export default function Breadcrumb({ className }: Props): JSX.Element;
+export {};

package/types/components/catalog.d.ts

@@ -1,19 +1,33 @@
-import { ReactElement } from 'react';
+import { ComponentType, FC, ReactElement, ReactNode } from 'react';
 import { SummaryArticle, SummaryPart } from '@topwrite/common';
 interface ItemProps {
     item: SummaryArticle;
     active: boolean;
     activeDescendant: boolean;
     disabled: boolean;
-    children: ReactElement<any, any> | null;
-}
-export interface CatalogProps {
-    renderPart: (props: PartProps) => ReactElement<any, any> | null;
-    renderItem: (props: ItemProps) => ReactElement<any, any> | null;
+    children: ReactNode;
 }
 interface PartProps {
     part: SummaryPart;
-    children: ReactElement<any, any> | null;
+    children: ReactNode;
+}
+interface ItemsProps {
+    part?: SummaryPart;
+    children: ReactNode;
+}
+interface DeprecatedCatalogProps {
+    renderPart?: (props: PartProps) => ReactElement<any, any> | null;
+    renderItem?: (props: ItemProps) => ReactElement<any, any> | null;
+}
+export interface CatalogProps {
+    partComponent: ComponentType<PartProps>;
+    itemComponent: ComponentType<ItemProps>;
+    itemsComponent?: ComponentType<ItemsProps>;
 }
-export default function Catalog({ ...props }: CatalogProps): JSX.Element;
+export declare const CatalogItems: FC<{
+    items: SummaryArticle[];
+    part?: SummaryPart;
+    itemsComponent?: ComponentType<ItemsProps>;
+} & Pick<CatalogProps, 'itemComponent'>>;
+export default function Catalog({ ...props }: CatalogProps & DeprecatedCatalogProps): JSX.Element;
 export {};

package/types/components/html/attachment.d.ts

@@ -1,2 +1,2 @@
 import { AttachmentHTMLAttributes } from 'react';
-export default function Attachment({ src, ...props }: AttachmentHTMLAttributes<HTMLAttachmentElement>): JSX.Element;
+export default function Attachment(props: AttachmentHTMLAttributes<HTMLAttachmentElement>): JSX.Element;

package/types/components/html/audio.d.ts

@@ -1,2 +1,2 @@
 import { AudioHTMLAttributes } from 'react';
-export default function Audio({ src, ...props }: AudioHTMLAttributes<HTMLAudioElement>): JSX.Element;
+export default function Audio(props: AudioHTMLAttributes<HTMLAudioElement>): JSX.Element;

package/types/components/html/img.d.ts

@@ -1,2 +1,2 @@
 import { ImgHTMLAttributes } from 'react';
-export default function Img({ src, ...props }: ImgHTMLAttributes<HTMLImageElement>): JSX.Element;
+export default function Img(props: ImgHTMLAttributes<HTMLImageElement>): JSX.Element;

package/types/components/html/video.d.ts

@@ -1,2 +1,2 @@
 import { VideoHTMLAttributes } from 'react';
-export default function Video({ src, ...props }: VideoHTMLAttributes<HTMLVideoElement>): JSX.Element;
+export default function Video(props: VideoHTMLAttributes<HTMLVideoElement>): JSX.Element;

package/types/components/logo.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 interface LogoProps {
     className?: string;
     size?: number;

package/types/components/main.d.ts

@@ -1,2 +1 @@
-/// <reference types="react" />
-export default function Main(): JSX.Element;
+export default function Main(): JSX.Element | null;

package/types/components/page.d.ts

@@ -0,0 +1 @@
+export default function Page(): JSX.Element;

package/types/components/powered-by.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 interface PoweredByProps {
     className?: string;
 }

package/types/components/to-first-article.d.ts

@@ -0,0 +1,2 @@
+import { PropsWithChildren } from 'react';
+export default function ToFirstArticle({ children }: PropsWithChildren<any>): any;

package/types/index.d.ts

@@ -4,6 +4,7 @@ export * from '@topwrite/common';
 export { default as bootstrap } from './lib/bootstrap';
 export { history } from './lib/history';
 export { default as useTitle } from './lib/use-title';
+export { default as useFile } from './lib/use-file';
 export { default as useArticle, usePrevArticle, useNextArticle } from './lib/use-article';
 export { default as useWindowSize, windowSizes } from './lib/use-window-size';
 export { default as useLockBodyScroll } from './lib/use-lock-body-scroll';
@@ -12,8 +13,9 @@ export { default as Logo } from './components/logo';
 export { default as Link } from './components/link';
 export { default as Anchor } from './components/anchor';
 export { default as Article } from './components/article';
-export { default as Catalog } from './components/catalog';
-export type { CatalogProps } from './components/catalog';
+export { default as Catalog, type CatalogProps, CatalogItems } from './components/catalog';
 export { default as Markdown } from './components/markdown';
+export { default as Breadcrumb } from './components/breadcrumb';
+export { default as ToFirstArticle } from './components/to-first-article';
 export { Helmet } from 'react-helmet-async';
 export type { SearchHandler, SearchResult } from './models/search';

package/types/lib/history.d.ts

@@ -2,7 +2,14 @@ import { History as H, Listener, To } from 'history';
 export declare class History {
     history: H;
     constructor();
-    get location(): import("history").Location;
+    get location(): {
+        toString(): string;
+        state: any;
+        key: string;
+        pathname: string;
+        search: string;
+        hash: string;
+    };
     listen(listener: Listener): void;
     replace(location: To): void;
     push(location: To): void;

package/types/lib/use-article.d.ts

@@ -4,3 +4,4 @@ export declare const ArticleContext: import("react").Context<SummaryArticle | un
 export default function useArticle(): SummaryArticle | undefined;
 export declare function useNextArticle(): SummaryArticle | undefined;
 export declare function usePrevArticle(): SummaryArticle | undefined;
+export declare function usePart(article: SummaryArticle): void;

package/types/models/index.d.ts

@@ -1,4 +1,3 @@
 export { book } from './book';
-export { file } from './file';
 export { page } from './page';
 export { search } from './search';

package/types/models/page.d.ts

@@ -1,16 +1,28 @@
-import { ActionsType, Model } from '@topwrite/common';
+import { ActionsType, File, Model, RequestConfig, RequestInstance } from '@topwrite/common';
 interface PageState {
     loading: boolean;
     error?: Error;
+    request: RequestInstance;
+    config: RequestConfig;
+    file?: File;
+    lfs?: {
+        url: string;
+        files: {
+            [index: string]: string;
+        };
+    };
 }
+declare type Interceptors = RequestInstance['interceptors'];
 declare class Page extends Model<PageState> {
     initialState: {
         loading: boolean;
+        request: import("axios").AxiosInstance;
+        config: {};
     };
-    subscription({ fetch }: ActionsType<Page>): void;
-    fetch(pathname: string): AsyncGenerator<import("redux").AnyAction | Generator<import("redux").AnyAction, import("@topwrite/common").OptionsStateType, unknown>, any, {
-        search: any;
-    }>;
+    subscription({ fetch }: ActionsType<Page>, state: any): void;
+    fetch(pathname: string): AsyncGenerator<import("redux").AnyAction, void, unknown>;
+    intercept(handler: (interceptors: Interceptors) => void): Generator<import("redux").AnyAction, void, unknown>;
+    updateConfig(updater: (config: RequestConfig) => void): Generator<import("redux").AnyAction, void, unknown>;
 }
 export declare const page: Page;
 export {};

package/types/typings.d.ts

@@ -10,17 +10,11 @@ declare module '@topwrite/common' {
     }
     interface ComponentsMap {
         app: ComponentDescriptorType;
-        'article:before': ComponentDescriptorType;
-        'article:after': ComponentDescriptorType;
+        'page:article:before': ComponentDescriptorType;
+        'page:article:after': ComponentDescriptorType;
+        'page:asset': ComponentDescriptorType;
     }
     interface OptionsStateType {
-        lfs?: {
-            url: string;
-            files: {
-                [index: string]: string;
-            };
-        };
-        search: string;
     }
 }
 export {};

package/types/lib/use-lfs.d.ts

@@ -1 +0,0 @@
-export default function useLfs(src?: string): string | undefined;

package/types/models/file.d.ts

@@ -1,7 +0,0 @@
-import { ActionsType, Model, File as FileType } from '@topwrite/common';
-declare class File extends Model<FileType> {
-    onAction(action: GeneratorFunction, type: string, { update }: ActionsType<File>): any;
-    update(article: FileType): Generator<import("redux").AnyAction, void, unknown>;
-}
-export declare const file: File;
-export {};