@git-diff-view/react 0.0.20 → 0.0.21

package/index.d.ts

@@ -9,7 +9,7 @@ declare class Cache$1<K, V> extends Map<K, V> {
 }
 declare class File$1 {
 	readonly raw: string;
-	readonly lang: string;
+	readonly lang: DiffHighlighterLang | string;
 	readonly fileName?: string;
 	ast?: DiffAST;
 	rawFile: Record<number, string>;
@@ -22,7 +22,8 @@ declare class File$1 {
 	highlighterType?: DiffHighlighter["type"];
 	maxLineNumber: number;
 	static createInstance(data: File$1): File$1;
-	constructor(raw: string, lang: string, fileName?: string);
+	constructor(row: string, lang: DiffHighlighterLang, fileName?: string);
+	constructor(row: string, lang: string, fileName?: string);
 	doSyntax({ registerHighlighter, theme, }: {
 		registerHighlighter?: Omit<DiffHighlighter, "getHighlighterEngine">;
 		theme?: "light" | "dark";
@@ -48,10 +49,10 @@ export declare class DiffFile {
 	_version_: string;
 	_oldFileName: string;
 	_oldFileContent: string;
-	_oldFileLang: string;
+	_oldFileLang: DiffHighlighterLang | string;
 	_newFileName: string;
 	_newFileContent: string;
-	_newFileLang: string;
+	_newFileLang: DiffHighlighterLang | string;
 	_diffList: string[];
 	diffLineLength: number;
 	splitLineLength: number;
@@ -60,7 +61,9 @@ export declare class DiffFile {
 	hasExpandSplitAll: boolean;
 	hasExpandUnifiedAll: boolean;
 	hasSomeLineCollapsed: boolean;
-	static createInstance(data: FileData, bundle?: ReturnType<DiffFile["getBundle"] | DiffFile["_getFullBundle"]>): DiffFile;
+	static createInstance(data: FileData_1, bundle?: ReturnType<DiffFile["getBundle"] | DiffFile["_getFullBundle"]>): DiffFile;
+	static createInstance(data: FileData_2, bundle?: ReturnType<DiffFile["getBundle"] | DiffFile["_getFullBundle"]>): DiffFile;
+	constructor(_oldFileName: string, _oldFileContent: string, _newFileName: string, _newFileContent: string, _diffList: string[], _oldFileLang?: DiffHighlighterLang, _newFileLang?: DiffHighlighterLang, uuid?: string);
 	constructor(_oldFileName: string, _oldFileContent: string, _newFileName: string, _newFileContent: string, _diffList: string[], _oldFileLang?: string, _newFileLang?: string, uuid?: string);
 	initId(): void;
 	getId(): string;
@@ -352,7 +355,6 @@ export declare const getDiffRange: (additions: DiffLine[], deletions: DiffLine[]
 	getAdditionRaw: (lineNumber: number) => string;
 	getDeletionRaw: (lineNumber: number) => string;
 }) => void;
-export declare const getFile: (raw: string, lang: string, theme: "light" | "dark", fileName?: string, uuid?: string) => File$1;
 export declare const getLang: (fileName: string) => string;
 export declare const getSplitContentLines: (diffFile: DiffFile) => DiffSplitContentLineItem[];
 export declare const getSplitLines: (diffFile: DiffFile) => DiffSplitLineItem[];
@@ -405,13 +407,18 @@ export declare enum NewLineSymbol {
 	CR = 2,
 	LF = 3,
 	NEWLINE = 4,
-	NORMAL = 5
+	NORMAL = 5,
+	NULL = 6
 }
+export declare function _getAST(raw: string, fileName?: string, lang?: DiffHighlighterLang, theme?: "light" | "dark"): DiffAST;
+export declare function _getAST(raw: string, fileName?: string, lang?: string, theme?: "light" | "dark"): DiffAST;
 export declare function assertNever(_: never, message: string): never;
 export declare function diffChanges(addition: DiffLine, deletion: DiffLine): {
 	addRange: DiffRange;
 	delRange: DiffRange;
 };
+export declare function getFile(raw: string, lang: DiffHighlighterLang, theme: "light" | "dark", fileName?: string, uuid?: string): File$1;
+export declare function getFile(raw: string, lang: string, theme: "light" | "dark", fileName?: string, uuid?: string): File$1;
 /**
  * Calculates whether or not a hunk header can be expanded up, down, both, or if
  * the space represented by the hunk header is short and expansion there would
@@ -518,7 +525,7 @@ export type DiffHighlighter = {
 	setMaxLineToIgnoreSyntax: (v: number) => void;
 	ignoreSyntaxHighlightList: (string | RegExp)[];
 	setIgnoreSyntaxHighlightList: (v: (string | RegExp)[]) => void;
-	getAST: (raw: string, fileName?: string, lang?: string, theme?: "light" | "dark") => DiffAST;
+	getAST: typeof _getAST;
 	processAST: (ast: DiffAST) => {
 		syntaxFileObject: Record<number, SyntaxLine>;
 		syntaxFileLineNumber: number;
@@ -526,6 +533,7 @@ export type DiffHighlighter = {
 	hasRegisteredCurrentLang: (lang: string) => boolean;
 	getHighlighterEngine: () => typeof lowlight;
 };
+export type DiffHighlighterLang = "arduino" | "bash" | "c" | "cpp" | "csharp" | "css" | "diff" | "go" | "graphql" | "ini" | "java" | "javascript" | "js" | "jsx" | "json" | "kotlin" | "less" | "lua" | "makefile" | "markdown" | "objectivec" | "perl" | "php" | "php-template" | "plaintext" | "python" | "python-repl" | "r" | "ruby" | "rust" | "scss" | "shell" | "sql" | "swift" | "typescript" | "ts" | "tsx" | "vbnet" | "wasm" | "xml" | "yaml" | "abnf" | "accesslog" | "actionscript" | "ada" | "angelscript" | "apache" | "applescript" | "arcade" | "armasm" | "asciidoc" | "aspectj" | "autohotkey" | "autoit" | "avrasm" | "awk" | "axapta" | "basic" | "bnf" | "brainfuck" | "cal" | "capnproto" | "ceylon" | "clean" | "clojure" | "clojure-repl" | "cmake" | "coffeescript" | "coq" | "cos" | "crmsh" | "crystal" | "csp" | "d" | "dart" | "delphi" | "django" | "dns" | "dockerfile" | "dos" | "dsconfig" | "dts" | "dust" | "ebnf" | "elixir" | "elm" | "erb" | "erlang" | "erlang-repl" | "excel" | "fix" | "flix" | "fortran" | "fsharp" | "gams" | "gauss" | "gcode" | "gherkin" | "glsl" | "gml" | "golo" | "gradle" | "groovy" | "haml" | "handlebars" | "haskell" | "haxe" | "hsp" | "http" | "hy" | "inform7" | "irpf90" | "isbl" | "jboss-cli" | "julia" | "julia-repl" | "lasso" | "latex" | "ldif" | "leaf" | "lisp" | "livecodeserver" | "livescript" | "llvm" | "lsl" | "mathematica" | "matlab" | "maxima" | "mel" | "mercury" | "mipsasm" | "mizar" | "mojolicious" | "monkey" | "moonscript" | "n1ql" | "nestedtext" | "nginx" | "nim" | "nix" | "node-repl" | "nsis" | "ocaml" | "openscad" | "oxygene" | "parser3" | "pf" | "pgsql" | "pony" | "powershell" | "processing" | "profile" | "prolog" | "properties" | "protobuf" | "puppet" | "purebasic" | "q" | "qml" | "reasonml" | "rib" | "roboconf" | "routeros" | "rsl" | "ruleslanguage" | "sas" | "scala" | "scheme" | "scilab" | "smali" | "smalltalk" | "sml" | "sqf" | "stan" | "stata" | "step21" | "stylus" | "subunit" | "taggerscript" | "tap" | "tcl" | "thrift" | "tp" | "twig" | "vala" | "vbscript" | "vbscript-html" | "verilog" | "vhdl" | "vim" | "wren" | "x86asm" | "xl" | "xquery" | "zephi" | "vue" | "vue-html";
 export type DiffSplitContentLineItem = {
 	type: DiffFileLineType.content;
 	index: number;
@@ -551,7 +559,20 @@ export type DiffUnifiedLineItem = {
 	index: number;
 	lineNumber: number;
 };
-export type FileData = {
+export type FileData_1 = {
+	oldFile?: {
+		fileName?: string | null;
+		fileLang?: DiffHighlighterLang | null;
+		content?: string | null;
+	};
+	newFile?: {
+		fileName?: string | null;
+		fileLang?: DiffHighlighterLang | null;
+		content?: string | null;
+	};
+	hunks?: string[];
+};
+export type FileData_2 = {
 	oldFile?: {
 		fileName?: string | null;
 		fileLang?: string | null;
@@ -727,12 +748,12 @@ export type DiffViewProps<T> = {
 	data?: {
 		oldFile?: {
 			fileName?: string | null;
-			fileLang?: string | null;
+			fileLang?: DiffHighlighterLang | string | null;
 			content?: string | null;
 		};
 		newFile?: {
 			fileName?: string | null;
-			fileLang?: string | null;
+			fileLang?: DiffHighlighterLang | string | null;
 			content?: string | null;
 		};
 		hunks: string[];
@@ -774,13 +795,49 @@ export type DiffViewProps<T> = {
 	}) => ReactNode;
 	onAddWidgetClick?: (lineNumber: number, side: SplitSide) => void;
 };
-export declare const DiffView: (<T>(props: DiffViewProps<T> & {
+export type DiffViewProps_1<T> = Omit<DiffViewProps<T>, "data"> & {
+	data?: {
+		oldFile?: {
+			fileName?: string | null;
+			fileLang?: DiffHighlighterLang | null;
+			content?: string | null;
+		};
+		newFile?: {
+			fileName?: string | null;
+			fileLang?: DiffHighlighterLang | null;
+			content?: string | null;
+		};
+		hunks: string[];
+	};
+};
+export type DiffViewProps_2<T> = Omit<DiffViewProps<T>, "data"> & {
+	data?: {
+		oldFile?: {
+			fileName?: string | null;
+			fileLang?: string | null;
+			content?: string | null;
+		};
+		newFile?: {
+			fileName?: string | null;
+			fileLang?: string | null;
+			content?: string | null;
+		};
+		hunks: string[];
+	};
+};
+export declare function DiffView<T>(props: DiffViewProps_1<T> & {
 	ref?: ForwardedRef<{
 		getDiffFileInstance: () => DiffFile;
 	}>;
-}) => ReactNode) & {
-	displayName?: string;
-};
+}): ReactNode;
+export declare function DiffView<T>(props: DiffViewProps_2<T> & {
+	ref?: ForwardedRef<{
+		getDiffFileInstance: () => DiffFile;
+	}>;
+}): ReactNode;
+export declare namespace DiffView {
+	var displayName: string;
+}
 export declare const version: string;
 
 export {

package/package.json

@@ -3,7 +3,7 @@
   "description": "@git-diff-view/react",
   "author": "MrWangJustToDo",
   "license": "MIT",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
@@ -33,6 +33,7 @@
         {
           "dir": "./dist",
           "entryFileNames": "esm/index.mjs",
+          "banner": "'use client';",
           "format": "esm",
           "sourcemap": true
         }
@@ -46,6 +47,7 @@
           "entryFileNames": "cjs/index.js",
           "format": "cjs",
           "type": true,
+          "banner": "'use client';",
           "multiple": true,
           "sourcemap": true
         }
@@ -57,12 +59,12 @@
     "react diff component"
   ],
   "dependencies": {
-    "@git-diff-view/core": "^0.0.20",
+    "@git-diff-view/core": "^0.0.21",
     "@types/hast": "^3.0.0",
     "fast-diff": "^1.3.0",
-    "highlight.js": "^11.9.0",
-    "lowlight": "^3.1.0",
-    "reactivity-store": "^0.3.7",
+    "highlight.js": "^11.10.0",
+    "lowlight": "^3.2.0",
+    "reactivity-store": "^0.3.8",
     "use-sync-external-store": "^1.2.2"
   },
   "devDependencies": {

package/readme.md

@@ -73,6 +73,12 @@ const diffFile = DiffFile.createInstance(data || {}, bundle);
 <DiffView diffFile={diffFile} {...props} />;
 ```
 
+### Screen Shot
+
+![Screenshot](https://raw.githubusercontent.com/MrWangJustToDo/git-diff-view/aa2e918498270f737d28e7531eab08fa3f1b8831/1.png)
+![Screenshot](https://raw.githubusercontent.com/MrWangJustToDo/git-diff-view/69c801e5eb5fcabc9c9655825eb1228f18dc1e0c/5.png)
+![Screenshot](https://raw.githubusercontent.com/MrWangJustToDo/git-diff-view/aa2e918498270f737d28e7531eab08fa3f1b8831/theme.png)
+
 ### Props
 
 | Props  | Description  |
@@ -90,6 +96,8 @@ const diffFile = DiffFile.createInstance(data || {}, bundle);
 | diffViewAddWidget| enable `addWidget` button, type: boolean |
 | onAddWidgetClick | when the `addWidget` button clicked, type: `({ side: "old" | "new", lineNumber: number }) => void` |
 
-### example repo
+### example
 
-[react-example](https://github.com/MrWangJustToDo/git-diff-view/tree/main/ui/react-example)
+#### [react-example](https://github.com/MrWangJustToDo/git-diff-view/tree/main/ui/react-example)
+#### [react-ssr-example](https://github.com/MrWangJustToDo/git-diff-view/tree/main/ui/next-page-example)
+#### [react-rsc-example](https://github.com/MrWangJustToDo/git-diff-view/tree/main/ui/next-app-example)