Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rich text renderer refactoring #661

Merged
merged 6 commits into from
Jan 3, 2024
Merged

rich text renderer refactoring #661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
abe81ca
refactor: extract react-richtext-renderer package
matej21 Dec 11, 2023
7d46c47
tests: replace react-test-renderer with @testing-library/react
matej21 Jan 3, 2024
ae2e8ff
refactor(react-richtext-renderer): major package refactoring
matej21 Dec 12, 2023
6a98103
docs(react-richtext-renderer): add readme
matej21 Jan 3, 2024
5a27fcb
chore: ae up
matej21 Dec 11, 2023
5404a85
chore: fix peer deps
matej21 Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
262 changes: 1 addition & 261 deletions build/api/react-client.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

```ts

import { ComponentType } from 'react';
import { Context } from 'react';
import type { FileUploader } from '@contember/client';
import type { FileUploadError } from '@contember/client';
Expand All @@ -13,8 +12,6 @@ import type { GraphQlClientFailedRequestMetadata } from '@contember/client';
import type { GraphQlClientRequestOptions } from '@contember/client';
import type { GraphQlClientVariables } from '@contember/client';
import { NamedExoticComponent } from 'react';
import { ReactElement } from 'react';
import { ReactNode } from 'react';

// @public (undocumented)
export const ApiBaseUrlContext: Context<string | undefined>;
Expand Down Expand Up @@ -59,12 +56,6 @@ export type ApiRequestState<SuccessData> = {
data: GraphQlClientFailedRequestMetadata;
};

// @public (undocumented)
export type BuiltinElements<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> = RichTextAnchorElement<CustomElements, CustomLeaves> | RichTextHeadingElement<CustomElements, CustomLeaves> | RichTextHorizontalRuleElement<CustomElements, CustomLeaves> | RichTextListItemElement<CustomElements, CustomLeaves> | RichTextOrderedListElement<CustomElements, CustomLeaves> | RichTextParagraphElement<CustomElements, CustomLeaves> | RichTextReferenceElement<CustomElements, CustomLeaves> | RichTextScrollTargetElement<CustomElements, CustomLeaves> | RichTextTableCellElement<CustomElements, CustomLeaves> | RichTextTableElement<CustomElements, CustomLeaves> | RichTextTableRowElement<CustomElements, CustomLeaves> | RichTextUnorderedListElement<CustomElements, CustomLeaves>;

// @public (undocumented)
export type BuiltinLeaves = RichTextBoldLeaf & RichTextCodeLeaf & RichTextHighlightLeaf & RichTextItalicLeaf & RichTextStrikeThroughLeaf & RichTextUnderlineLeaf;

// @public (undocumented)
export class ClientError extends Error {
}
Expand Down Expand Up @@ -151,258 +142,6 @@ export const ProjectSlugContext: Context<string | undefined>;
// @public (undocumented)
export type PurgeUpload = (files: Iterable<FileId | File>) => void;

// @public (undocumented)
export type ReferenceRenderer<Reference extends RichTextReference = RichTextReference, CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> = (props: ReferenceRendererProps<Reference, CustomElements, CustomLeaves>) => ReactNode;

// @public (undocumented)
export type ReferenceRendererProps<Reference extends RichTextReference = RichTextReference, CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> = {
element: CustomElements | BuiltinElements<CustomElements, CustomLeaves>;
children: ReactElement;
} & {
[Prop in keyof RichTextElementMetadata<CustomElements, CustomLeaves, Reference>]: Exclude<RichTextElementMetadata<CustomElements, CustomLeaves, Reference>[Prop], undefined>;
};

// @public (undocumented)
export interface RenderChildrenOptions<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> {
// (undocumented)
attributeNamePrefix?: string;
// (undocumented)
renderElement?: RenderElement<CustomElements, CustomLeaves>;
// (undocumented)
renderLeaf?: RenderLeaf<CustomLeaves>;
}

// @public (undocumented)
export type RenderElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never, Reference extends RichTextReference = RichTextReference> = ComponentType<{
element: CustomElements | BuiltinElements<CustomElements, CustomLeaves>;
children: ReactElement;
fallback: ReactElement;
renderChildren: (children: CustomElements | BuiltinElements<CustomElements, CustomLeaves> | CustomLeaves | BuiltinLeaves | Array<CustomElements | BuiltinElements<CustomElements, CustomLeaves> | CustomLeaves | BuiltinLeaves>, options: RenderChildrenOptions<CustomElements, CustomLeaves>) => ReactElement;
renderChildrenOptions: RenderChildrenOptions<CustomElements, CustomLeaves>;
} & RichTextElementMetadata<CustomElements, CustomLeaves, Reference>>;

// @public (undocumented)
export type RenderLeaf<CustomLeaves extends RichTextLeaf> = ComponentType<{
leaf: CustomLeaves | BuiltinLeaves;
fallback: ReactElement;
} & RichTextLeafMetadata>;

// @public (undocumented)
export interface RichTextAnchorElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
href: string;
// (undocumented)
type: 'anchor';
}

// @public (undocumented)
export type RichTextBlock = Readonly<Record<string, unknown>>;

// @public (undocumented)
export interface RichTextBoldLeaf extends RichTextLeaf {
// (undocumented)
isBold?: boolean;
}

// @public (undocumented)
export interface RichTextCodeLeaf extends RichTextLeaf {
// (undocumented)
isCode?: boolean;
}

// @public (undocumented)
export interface RichTextElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> {
// (undocumented)
children: RichTextElement<CustomElements, CustomLeaves>[] | Array<CustomLeaves | RichTextLeaf>;
// (undocumented)
referenceId?: string;
// (undocumented)
type: string;
}

// @public (undocumented)
export interface RichTextElementMetadata<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never, Reference extends RichTextReference = RichTextReference> {
// (undocumented)
formatVersion: number;
// (undocumented)
reference: Reference | undefined;
// (undocumented)
referenceRenderer: ReferenceRenderer<Reference, CustomElements, CustomLeaves> | undefined;
// (undocumented)
referenceType: string | undefined;
}

// @public (undocumented)
export interface RichTextHeadingElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
isNumbered?: boolean;
// (undocumented)
level: 1 | 2 | 3 | 4 | 5 | 6;
// (undocumented)
type: 'heading';
}

// @public (undocumented)
export interface RichTextHighlightLeaf extends RichTextLeaf {
// (undocumented)
isHighlighted?: boolean;
}

// @public (undocumented)
export interface RichTextHorizontalRuleElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
type: 'horizontalRule';
}

// @public (undocumented)
export interface RichTextItalicLeaf extends RichTextLeaf {
// (undocumented)
isItalic?: boolean;
}

// @public (undocumented)
export interface RichTextLeaf {
// (undocumented)
text: string;
}

// @public (undocumented)
export interface RichTextLeafMetadata {
// (undocumented)
formatVersion: number;
}

// @public (undocumented)
export interface RichTextListItemElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
type: 'listItem';
}

// @public (undocumented)
export interface RichTextOrderedListElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
type: 'orderedList';
}

// @public (undocumented)
export interface RichTextParagraphElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
isNumbered?: boolean;
// (undocumented)
type: 'paragraph';
}

// @public (undocumented)
export interface RichTextReference {
// (undocumented)
id: string;
}

// @public (undocumented)
export interface RichTextReferenceElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
referenceId: string;
// (undocumented)
type: 'reference';
}

// @public (undocumented)
export const RichTextRenderer: <CustomElements extends RichTextElement<never, never> = never, CustomLeaves extends RichTextLeaf = never>(props: RichTextRendererProps<CustomElements, CustomLeaves>) => ReactElement;

// @public (undocumented)
export interface RichTextRendererBlockProps<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> {
// (undocumented)
blocks: readonly RichTextBlock[];
// (undocumented)
referenceDiscriminationField?: string;
// (undocumented)
referenceRenderers?: Record<string, ReferenceRenderer<any, CustomElements, CustomLeaves>>;
// (undocumented)
referencesField?: string;
// (undocumented)
sourceField?: string;
}

// @public (undocumented)
export class RichTextRendererError extends Error {
}

// @public (undocumented)
export interface RichTextRendererFieldProps {
// (undocumented)
source: string | null;
}

// @public (undocumented)
export type RichTextRendererProps<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> = {
deserialize?: (source: string) => RootEditorNode<CustomElements, CustomLeaves>;
renderElement?: RenderElement<CustomElements, CustomLeaves>;
renderLeaf?: RenderLeaf<CustomLeaves>;
attributeNamePrefix?: string;
renderBlock?: ComponentType<{
block: unknown;
children?: ReactNode;
}>;
} & (RichTextRendererFieldProps | RichTextRendererBlockProps<CustomElements, CustomLeaves>);

// @public (undocumented)
export interface RichTextScrollTargetElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
identifier: string;
// (undocumented)
type: 'scrollTarget';
}

// @public (undocumented)
export interface RichTextStrikeThroughLeaf extends RichTextLeaf {
// (undocumented)
isStruckThrough?: boolean;
}

// @public (undocumented)
export interface RichTextTableCellElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
headerScope?: 'row';
// (undocumented)
justify?: 'start' | 'center' | 'end';
// (undocumented)
type: 'tableCell';
}

// @public (undocumented)
export interface RichTextTableElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
type: 'table';
}

// @public (undocumented)
export interface RichTextTableRowElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
headerScope?: 'table';
// (undocumented)
type: 'tableRow';
}

// @public (undocumented)
export interface RichTextUnderlineLeaf extends RichTextLeaf {
// (undocumented)
isUnderlined?: boolean;
}

// @public (undocumented)
export interface RichTextUnorderedListElement<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> extends RichTextElement<CustomElements, CustomLeaves> {
// (undocumented)
type: 'unorderedList';
}

// @public (undocumented)
export interface RootEditorNode<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> {
// (undocumented)
children: Array<BuiltinElements<CustomElements, CustomLeaves> | CustomElements | BuiltinLeaves | CustomLeaves>;
// (undocumented)
formatVersion: number;
}

// @public (undocumented)
export const SessionTokenContext: Context<SessionTokenContextValue>;

Expand Down Expand Up @@ -526,6 +265,7 @@ export const useTenantGraphQlClient: () => GraphQlClient;


export * from "@contember/client";
export * from "@contember/react-richtext-renderer";

// (No @packageDocumentation comment for this package)

Expand Down
Loading
Loading