@xpadev-net/niconicomments 0.2.32 → 0.2.34

package/README.en.md

@@ -0,0 +1,41 @@
+# [niconicomments](https://xpadev.net/niconicomments/)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/xpadev-net/niconicomments/blob/master/LICENSE)
+
+[[日本語](https://github.com/xpadev-net/niconicomments/blob/develop/README.md)]
+
+Comment rendering library that is somewhat compatible with the official Nico Nico Douga player  
+Reference： https://xpadev-net.github.io/niconicomments/  
+Github： https://github.com/xpadev-net/niconicomments  
+npm： https://www.npmjs.com/package/@xpadev-net/niconicomments
+
+## For users who use this library for domestic use in Japan
+This library may infringe on Dwango's patents depending on how it is used  
+Please carefully review the following applicable patents and case law before using this library with caution.  
+[JP,2006-333851](https://www.j-platpat.inpit.go.jp/c1800/PU/JP-2006-333851/7294651F33633E1EBF3DEC66FAE0ECAD878D19E1829C378FC81D26BBD0A4263B/10/en)  
+[JP,2010-267283](https://www.j-platpat.inpit.go.jp/c1800/PU/JP-4734471/9085C128B7ED7D57F6C2F09D9BE4FCB496E638331DB9EC7ADE1E3A44999A3878/15/en)  
+[JP,2018-202475](https://www.j-platpat.inpit.go.jp/c1800/PU/JP-6526304/D8AF77CFB92D96C785FEECBD690C53E2F9023F1739E7A5BBDAB588E2ECAC5316/15/en)  
+[2018: Case No. Heisei 28 (wa) 38565, Patent Infringement Injunction, etc. Patent Right Civil Litigation](https://www.courts.go.jp/app/files/hanrei_jp/073/088073_hanrei.pdf)  
+[2022: Heisei 30 (ne) 10077 Appeal for Patent Infringement Injunction, etc. Patent Right Civil Litigation](https://www.courts.go.jp/app/files/hanrei_jp/418/091418_hanrei.pdf)  
+
+## Installation
+```html
+<script src="https://cdn.jsdelivr.net/npm/@xpadev-net/niconicomments@latest/dist/bundle.min.js"></script>
+```
+or
+```
+npm i @xpadev-net/niconicomments
+```
+
+## Examples
+```javascript
+const canvas = document.getElementById("canvas");
+const video = document.getElementById("video");
+const req = await fetch("sample.json");
+const res = await req.json();
+const niconiComments = new NiconiComments(canvas, res);
+//If video.ontimeupdate is used, the comments will be choppy due to the small number of calls.
+setInterval(() => niconiComments.drawCanvas(Math.floor(video.currentTime * 100)), 10);
+```
+
+## Sample
+[Sample](https://xpadev-net.github.io/niconicomments/sample/)  

package/README.md

@@ -1,7 +1,7 @@
 # [niconicomments](https://xpadev.net/niconicomments/)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/xpadev-net/niconicomments/blob/master/LICENSE)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/xpadev-net/niconicomments.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/xpadev-net/niconicomments/alerts/)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/xpadev-net/niconicomments.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/xpadev-net/niconicomments/context:javascript)
+
+[[English](https://github.com/xpadev-net/niconicomments/blob/develop/README.en.md)]
 
 ニコニコ動画の公式プレイヤー互換の高パフォーマンスなコメント描画ライブラリ   
 High peformance High compatibility comment drawing library  
@@ -39,4 +39,3 @@ setInterval(() => niconiComments.drawCanvas(Math.floor(video.currentTime * 100))
 
 ## Sample
 [サンプル](https://xpadev-net.github.io/niconicomments/sample/)  
-[CodePen](https://codepen.io/xpadev-net/pen/mdBdQmX)  

package/dist/bundle.d.ts

@@ -3,6 +3,7 @@ declare class FlashComment implements IComment {
     readonly comment: formattedCommentWithSize;
     private readonly _globalScale;
     private scale;
+    private scaleX;
     posY: number;
     image?: HTMLCanvasElement | null;
     constructor(comment: formattedComment, context: CanvasRenderingContext2D);
@@ -43,7 +44,6 @@ declare class HTML5Comment implements IComment {
     get owner(): boolean;
     get mail(): string[];
     get lineCount(): number;
-    parseCommand(comment: formattedComment): parsedCommand;
     parseCommandAndNicoscript(comment: formattedComment): formattedCommentWithFont;
     measureText(comment: measureTextInput): measureTextResult;
     getCommentSize(parsedData: formattedCommentWithFont): formattedCommentWithSize;
@@ -61,11 +61,6 @@ declare let imageCache: {
 declare const resetImageCache: () => void;
 
 
-declare let canvas: HTMLCanvasElement;
-declare let context: CanvasRenderingContext2D;
-declare const initCanvas: () => void;
-
-
 declare let nicoScripts: nicoScript;
 declare const resetNicoScripts: () => void;
 
@@ -245,8 +240,8 @@ type Config = {
   canvasWidth: number;
   collisionRange: { [key in "left" | "right"]: number };
   colors: { [key: string]: string };
-  commentDrawPadding: configItem<number>;
-  commentDrawRange: configItem<number>;
+  commentDrawPadding: number;
+  commentDrawRange: number;
   commentScale: configItem<number>;
   commentStageSize: configItem<commentStageSize>;
   commentYMarginBottom: configSizeItem<number>;
@@ -273,6 +268,8 @@ type Config = {
   sameCAGap: number;
   sameCAMinScore: number;
   sameCARange: number;
+  letterSpacing: number;
+  scriptCharOffset: number;
 };
 
 type ConfigNullable = Partial<Config>;
@@ -608,7 +605,7 @@ declare class NiconiComments {
 
 declare const getLineHeight: (fontSize: commentSize, isFlash: boolean, resized?: boolean) => number;
 declare const getCharSize: (fontSize: commentSize, isFlash: boolean) => number;
-declare const measure: (comment: measureInput) => {
+declare const measure: (comment: measureInput, context: CanvasRenderingContext2D) => {
     height: number;
     width: number;
     lineWidth: number[];
@@ -646,7 +643,7 @@ declare const typeGuard: {
         comments: (i: unknown) => i is ownerComment[];
     };
     v1: {
-        comment: (i: unknown) => i is apiThread;
+        comment: (i: unknown) => i is v1Comment;
         thread: (i: unknown) => i is v1Thread;
         threads: (i: unknown) => i is v1Thread[];
     };
@@ -679,7 +676,7 @@ declare const getPosY: (currentPos: number, targetComment: IComment, collision:
     isChanged: boolean;
     isBreak: boolean;
 };
-declare const getPosX: (width: number, vpos: number, long: number, isFlash: boolean) => number;
+declare const getPosX: (width: number, vpos: number, long: number) => number;
 declare const parseFont: (font: commentFont, size: string | number) => string;
 declare const arrayPush: (array: {
     [key: number]: number[];
@@ -689,6 +686,7 @@ declare const replaceAll: (string: string, target: string, replace: string) => s
 declare const changeCALayer: (rawData: formattedComment[]) => formattedComment[];
 declare const getConfig: <T>(input: configItem<T>, isFlash?: boolean) => T;
 declare const isFlashComment: (comment: formattedComment) => boolean;
+declare const parseCommandAndNicoScript: (comment: formattedComment) => formattedCommentWithFont;
 
 
 export default NiconiComments;