@recursive-robot/react-jsx-parser 1.42.0 → 2.0.1

package/dist/components/JsxParser.d.ts

@@ -1,32 +1,34 @@
-import React, { ComponentType, ExoticComponent } from 'react';
-export declare type TProps = {
-    allowUnknownElements?: boolean;
-    autoCloseVoidElements?: boolean;
-    bindings?: {
-        [key: string]: unknown;
-    };
-    blacklistedAttrs?: Array<string | RegExp>;
-    blacklistedTags?: string[];
-    className?: string;
-    components?: Record<string, ComponentType | ExoticComponent>;
-    componentsOnly?: boolean;
-    disableFragments?: boolean;
-    disableKeyGeneration?: boolean;
-    jsx?: string;
-    onError?: (error: Error) => void;
-    showWarnings?: boolean;
-    renderError?: (props: {
-        error: string;
-    }) => JSX.Element | null;
-    renderInWrapper?: boolean;
-    renderUnrecognized?: (tagName: string) => JSX.Element | null;
-};
-export default class JsxParser extends React.Component<TProps> {
-    #private;
-    static displayName: string;
-    static defaultProps: TProps;
-    private ParsedChildren;
-    private lastAttributeName;
-    jsx: string;
-    render: () => JSX.Element;
-}
+import { default as React, ComponentType, ExoticComponent } from 'react';
+import { JsxParserError } from '../helpers/errorUtilities';
+export type TProps = {
+    allowUnknownElements?: boolean;
+    autoCloseVoidElements?: boolean;
+    bindings?: {
+        [key: string]: unknown;
+    };
+    blacklistedAttrs?: Array<string | RegExp>;
+    blacklistedTags?: string[];
+    className?: string;
+    components?: Record<string, ComponentType | ExoticComponent>;
+    componentsOnly?: boolean;
+    disableFragments?: boolean;
+    disableKeyGeneration?: boolean;
+    fileName?: string;
+    jsx?: string;
+    onError?: (error: JsxParserError) => void;
+    showWarnings?: boolean;
+    renderError?: (props: {
+        error: string;
+    }) => React.JSX.Element | null;
+    renderInWrapper?: boolean;
+    renderUnrecognized?: (tagName: string) => React.JSX.Element | null;
+};
+export default class JsxParser extends React.Component<TProps> {
+    #private;
+    static displayName: string;
+    static defaultProps: TProps;
+    private ParsedChildren;
+    private lastAttributeName;
+    jsx: string;
+    render: () => React.JSX.Element;
+}

package/dist/constants/attributeNames.d.ts

@@ -1,2 +1,2 @@
-declare const _default: Record<string, string>;
-export default _default;
+declare const _default: Record<string, string>;
+export default _default;

package/dist/constants/specialTags.d.ts

@@ -1,4 +1,4 @@
-declare const VOID_ELEMENTS: string[];
-export default VOID_ELEMENTS;
-export declare function canHaveChildren(tagName: string): boolean;
-export declare function canHaveWhitespace(tagName: string): boolean;
+declare const VOID_ELEMENTS: string[];
+export default VOID_ELEMENTS;
+export declare function canHaveChildren(tagName: string): boolean;
+export declare function canHaveWhitespace(tagName: string): boolean;

package/dist/helpers/camelCase.d.ts

@@ -1,7 +1,7 @@
-/**
- * Converts a string from other cases to camelCase
- * @param string the value to camelCase
- * @example
- * camelCase('foo-bar') // 'fooBar'
- */
-export declare const camelCase: (string: string) => string;
+/**
+ * Converts a string from other cases to camelCase
+ * @param string the value to camelCase
+ * @example
+ * camelCase('foo-bar') // 'fooBar'
+ */
+export declare const camelCase: (string: string) => string;

package/dist/helpers/errorUtilities.d.ts

@@ -0,0 +1,43 @@
+export type JsxParserErrorType = 'parse' | 'unsupported-function' | 'function-parse' | 'function-runtime' | 'call' | 'chain' | 'member-access' | 'blacklisted-tag' | 'unrecognized-component' | 'unrecognized-tag';
+export interface JsxParserErrorLocation {
+    line: number;
+    column?: number;
+    startOffset?: number;
+    endOffset?: number;
+}
+export declare class JsxParserError extends Error {
+    type: JsxParserErrorType;
+    location?: JsxParserErrorLocation;
+    fileName?: string;
+    snippet?: string;
+    source?: string;
+    cause?: unknown;
+    constructor(message: string, fields: {
+        type: JsxParserErrorType;
+        location?: JsxParserErrorLocation;
+        fileName?: string;
+        snippet?: string;
+        source?: string;
+        cause?: unknown;
+    });
+}
+export declare function trimExcessLeadingWhitespaceFromCodeLines(lines: string[]): string[];
+export declare function buildErrorFromOffsets({ type, message, source, start, end, fileName, cause }: {
+    type: JsxParserErrorType;
+    message: string;
+    source: string;
+    start: number;
+    end: number;
+    fileName?: string;
+    cause?: unknown;
+}): JsxParserError;
+export declare function buildErrorFromLine(opts: {
+    type: JsxParserErrorType;
+    message: string;
+    bodyLines: string[];
+    line: number;
+    functionName?: string;
+    fileName?: string;
+    cause?: unknown;
+}): JsxParserError;
+export declare function sanitizeHtml(html: string): string;

package/dist/helpers/functionProxy.d.ts

@@ -1,5 +1,5 @@
-export declare type ScopedFunction = Function & {
-    scope?: Record<string, any>;
-};
-export declare type FunctionProxy = ProxyHandler<ScopedFunction>;
-export declare function createFunctionProxy(fn: ScopedFunction, scope: Record<string, any>): FunctionProxy;
+export type ScopedFunction = Function & {
+    scope?: Record<string, any>;
+};
+export type FunctionProxy = ProxyHandler<ScopedFunction>;
+export declare function createFunctionProxy(fn: ScopedFunction, scope: Record<string, any>): FunctionProxy;

package/dist/helpers/functionUtilities.d.ts

@@ -1,7 +1,8 @@
-import * as AcornJSX from 'acorn-jsx';
-export declare function isSpreadElement(node: AcornJSX.BaseExpression): node is AcornJSX.SpreadElement;
-export declare function getClosureBindings(fullExpression: AcornJSX.Expression): string[];
-export declare function getRenderFunction(jsx: string, bindings: Record<string, any>, parseExpression: (body: string, exp: AcornJSX.Expression, scope?: Record<string, any>) => any): (args: Record<string, any>) => any;
-export declare function getAllJsxElements(code: string): (AcornJSX.JSXElement | AcornJSX.JSXFragment)[];
-export declare function transpileFunctionBody(body: string, bindings: Record<string, any>, parseExpression: (jsx: string, exp: AcornJSX.Expression, scope?: Record<string, any>) => any): [string, Record<string, any>];
-export declare function constructFunction(paramNames: string[], body: string, name?: string, onError?: (error: any) => void): (...args: any[]) => any;
+import { JsxParserError } from './errorUtilities';
+import * as AcornJSX from 'acorn-jsx';
+export declare function isSpreadElement(node: AcornJSX.BaseExpression): node is AcornJSX.SpreadElement;
+export declare function getClosureBindings(fullExpression: AcornJSX.Expression): string[];
+export declare function getRenderFunction(jsx: string, bindings: Record<string, any>, parseExpression: (body: string, exp: AcornJSX.Expression, scope?: Record<string, any>) => any): (args: Record<string, any>) => any;
+export declare function getAllJsxElements(code: string): (AcornJSX.JSXElement | AcornJSX.JSXFragment)[];
+export declare function transpileFunctionBody(body: string, bindings: Record<string, any>, parseExpression: (jsx: string, exp: AcornJSX.Expression, scope?: Record<string, any>) => any): [string, Record<string, any>];
+export declare function constructFunction(paramNames: string[], body: string, name?: string, onError?: (error: JsxParserError) => void, fileName?: string): (...args: any[]) => any;

package/dist/helpers/hash.d.ts

@@ -1,10 +1,10 @@
-/**
- * Hashes a value
- * @param value the value to hash
- * @param radix the base-n to hash into (default 16)
- */
-export declare const hash: (value?: string, radix?: number) => string;
-/**
- * Hashes a Math.random() value, returning it in base16
- */
-export declare const randomHash: () => string;
+/**
+ * Hashes a value
+ * @param value the value to hash
+ * @param radix the base-n to hash into (default 16)
+ */
+export declare const hash: (value?: string, radix?: number) => string;
+/**
+ * Hashes a Math.random() value, returning it in base16
+ */
+export declare const randomHash: () => string;

package/dist/helpers/parseStyle.d.ts

@@ -1,8 +1,8 @@
-declare type Style = string | Partial<CSSStyleDeclaration>;
-/**
- * Converts a CSS Style string
- * @param {string | Partial<CSSStyleDeclaration>} style A string to convert, or object to return
- * @returns {Partial<CSSStyleDeclaration>} a partial CSSStyleDeclaration
- */
-export declare const parseStyle: (style: Style) => Partial<CSSStyleDeclaration> | undefined;
-export {};
+type Style = string | Partial<CSSStyleDeclaration>;
+/**
+ * Converts a CSS Style string
+ * @param {string | Partial<CSSStyleDeclaration>} style A string to convert, or object to return
+ * @returns {Partial<CSSStyleDeclaration>} a partial CSSStyleDeclaration
+ */
+export declare const parseStyle: (style: Style) => Partial<CSSStyleDeclaration> | undefined;
+export {};

package/dist/helpers/resolvePath.d.ts

@@ -1,9 +1,9 @@
-/**
- * Returns the result of a path query from an object
- * @param {any} object the object to search
- * @param {string} path the path, whose value will be retrieved
- * @returns {any} the value (undefined if the path doesn't exist)
- * @example
- * resolvePath({ foo: { bar: { baz: 3 } } }, 'foo.bar.baz') // 3
- */
-export declare const resolvePath: (object: any, path: string) => any;
+/**
+ * Returns the result of a path query from an object
+ * @param {any} object the object to search
+ * @param {string} path the path, whose value will be retrieved
+ * @returns {any} the value (undefined if the path doesn't exist)
+ * @example
+ * resolvePath({ foo: { bar: { baz: 3 } } }, 'foo.bar.baz') // 3
+ */
+export declare const resolvePath: (object: any, path: string) => any;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-/** This file exists solely to build the index.d.ts file */
-import JsxParser from './components/JsxParser';
-export type { TProps } from './components/JsxParser';
-export type { ScopedFunction, FunctionProxy } from './helpers/functionProxy';
-export default JsxParser;
+import { default as JsxParser } from './components/JsxParser';
+export type { TProps } from './components/JsxParser';
+export type { ScopedFunction, FunctionProxy } from './helpers/functionProxy';
+export { JsxParserError } from './helpers/errorUtilities';
+export type { JsxParserErrorType, JsxParserErrorLocation } from './helpers/errorUtilities';
+export default JsxParser;