@xpadev-net/niconicomments 0.2.31 → 0.2.33

package/README.ja.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)
+
+[English](https://github.com/xpadev-net/niconicomments/blob/develop/README.md)
+
+ニコニコ動画の公式プレイヤー互換の高パフォーマンスなコメント描画ライブラリ   
+High peformance High compatibility comment drawing library  
+Reference： https://xpadev-net.github.io/niconicomments/  
+Github： https://github.com/xpadev-net/niconicomments  
+npm： https://www.npmjs.com/package/@xpadev-net/niconicomments
+
+## [重要]このライブラリを使用される方へ
+ニコニコ運営が画面にコメントを流すアドオンを特許侵害だと騒ぎ立てて潰して回っているようです  
+このライブラリ本体は描画部分のみのため特許侵害に当たるとは考えていませんが、ニコニコ動画運営(とその近辺の人)に叩かれる可能性があります  
+(名前は出しませんがすでにいくつかのOSSに被害が出ています)  
+また、このライブラリを使用するかどうかに関わらず、リアルタイムでコメントを取得、画面を描画、コメントの投稿という一連の流れを実装した場合、ニコニコの特許を侵害する可能性があります  
+詳しくはこちら[ニコニコが保有する特許について](https://github.com/xpadev-net/niconicomments/blob/develop/ABOUT_PATENT.md)を参照してください  
+**※当ライブラリを削除する予定は一切ありません**
+
+## 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);
+//video.ontimeupdateを使用すると、呼び出し回数の関係でコメントカクつく
+setInterval(() => niconiComments.drawCanvas(Math.floor(video.currentTime * 100)), 10);
+```
+
+## Sample
+[サンプル](https://xpadev-net.github.io/niconicomments/sample/)  

package/README.md

@@ -1,21 +1,21 @@
 # [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)
 
-ニコニコ動画の公式プレイヤー互換の高パフォーマンスなコメント描画ライブラリ   
-High peformance High compatibility comment drawing library  
+[日本語](https://github.com/xpadev-net/niconicomments/blob/develop/README.ja.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
 
-## [重要]このライブラリを使用される方へ
-ニコニコ運営が画面にコメントを流すアドオンを特許侵害だと騒ぎ立てて潰して回っているようです  
-このライブラリ本体は描画部分のみのため特許侵害に当たるとは考えていませんが、ニコニコ動画運営(とその近辺の人)に叩かれる可能性があります  
-(名前は出しませんがすでにいくつかのOSSに被害が出ています)  
-また、このライブラリを使用するかどうかに関わらず、リアルタイムでコメントを取得、画面を描画、コメントの投稿という一連の流れを実装した場合、ニコニコの特許を侵害する可能性があります  
-詳しくはこちら[ニコニコが保有する特許について](https://github.com/xpadev-net/niconicomments/blob/develop/ABOUT_PATENT.md)を参照してください  
-**※当ライブラリを削除する予定は一切ありません**
+## 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
@@ -33,10 +33,9 @@ const video = document.getElementById("video");
 const req = await fetch("sample.json");
 const res = await req.json();
 const niconiComments = new NiconiComments(canvas, res);
-//video.ontimeupdateを使用すると、呼び出し回数の関係でコメントカクつく
+//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
-[サンプル](https://xpadev-net.github.io/niconicomments/sample/)  
-[CodePen](https://codepen.io/xpadev-net/pen/mdBdQmX)  
+[Sample](https://xpadev-net.github.io/niconicomments/sample/)  

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;
@@ -216,66 +216,68 @@ declare const fonts: {
 };
 
 
-type configItem<T> = T | { html5: T; flash: T };
-type configSizeItem<T> = { big: T; medium: T; small: T };
-type configResizedItem<T> = { default: T; resized: T };
-
-type commentStageSize = { width: number; fullWidth: number; height: number };
-
-type flashCharList = {
-  [key in "simsunStrong" | "simsunWeak" | "gulim" | "gothic"]: string;
-};
-type flashMode = "xp" | "vista";
-type flashScriptChar = {
-  [key in "super" | "sub"]: string;
-};
-type fontList = {
-  [key in "gulim" | "simsun"]: string;
-};
-type lineCounts = {
-  [key in "default" | "resized" | "doubleResized"]: configSizeItem<number>;
-};
-type typeDoubleResizeMaxWidth = {
-  [key in "full" | "normal"]: number;
-};
-
-type Config = {
-  cacheAge: number;
-  canvasHeight: number;
-  canvasWidth: number;
-  collisionRange: { [key in "left" | "right"]: number };
-  colors: { [key: string]: string };
-  commentDrawPadding: configItem<number>;
-  commentDrawRange: configItem<number>;
-  commentScale: configItem<number>;
-  commentStageSize: configItem<commentStageSize>;
-  commentYMarginBottom: configSizeItem<number>;
-  commentYOffset: configSizeItem<configResizedItem<number>>;
-  commentYPaddingTop: configResizedItem<number>;
-  contextFillLiveOpacity: number;
-  contextLineWidth: number;
-  contextStrokeColor: string;
-  contextStrokeInversionColor: string;
-  contextStrokeOpacity: number;
-  doubleResizeMaxWidth: configItem<typeDoubleResizeMaxWidth>;
-  flashChar: flashCharList;
-  flashMode: flashMode;
-  flashScriptChar: flashScriptChar;
-  flashThreshold: number;
-  font: fontList;
-  fonts: platformFont;
-  fontSize: configItem<configSizeItem<configResizedItem<number>>>;
-  fpsInterval: number;
-  hiResCommentCorrection: number;
-  lineCounts: configItem<lineCounts>;
-  lineHeight: configItem<configSizeItem<configResizedItem<number>>>;
-  minFontSize: number;
-  sameCAGap: number;
-  sameCAMinScore: number;
-  sameCARange: number;
-};
-
-type ConfigNullable = Partial<Config>;
+type configItem<T> = T | { html5: T; flash: T };
+type configSizeItem<T> = { big: T; medium: T; small: T };
+type configResizedItem<T> = { default: T; resized: T };
+
+type commentStageSize = { width: number; fullWidth: number; height: number };
+
+type flashCharList = {
+  [key in "simsunStrong" | "simsunWeak" | "gulim" | "gothic"]: string;
+};
+type flashMode = "xp" | "vista";
+type flashScriptChar = {
+  [key in "super" | "sub"]: string;
+};
+type fontList = {
+  [key in "gulim" | "simsun"]: string;
+};
+type lineCounts = {
+  [key in "default" | "resized" | "doubleResized"]: configSizeItem<number>;
+};
+type typeDoubleResizeMaxWidth = {
+  [key in "full" | "normal"]: number;
+};
+
+type Config = {
+  cacheAge: number;
+  canvasHeight: number;
+  canvasWidth: number;
+  collisionRange: { [key in "left" | "right"]: number };
+  colors: { [key: string]: string };
+  commentDrawPadding: number;
+  commentDrawRange: number;
+  commentScale: configItem<number>;
+  commentStageSize: configItem<commentStageSize>;
+  commentYMarginBottom: configSizeItem<number>;
+  commentYOffset: configSizeItem<configResizedItem<number>>;
+  commentYPaddingTop: configResizedItem<number>;
+  contextFillLiveOpacity: number;
+  contextLineWidth: number;
+  contextStrokeColor: string;
+  contextStrokeInversionColor: string;
+  contextStrokeOpacity: number;
+  doubleResizeMaxWidth: configItem<typeDoubleResizeMaxWidth>;
+  flashChar: flashCharList;
+  flashMode: flashMode;
+  flashScriptChar: flashScriptChar;
+  flashThreshold: number;
+  font: fontList;
+  fonts: platformFont;
+  fontSize: configItem<configSizeItem<configResizedItem<number>>>;
+  fpsInterval: number;
+  hiResCommentCorrection: number;
+  lineCounts: configItem<lineCounts>;
+  lineHeight: configItem<configSizeItem<configResizedItem<number>>>;
+  minFontSize: number;
+  sameCAGap: number;
+  sameCAMinScore: number;
+  sameCARange: number;
+  letterSpacing: number;
+  scriptCharOffset: number;
+};
+
+type ConfigNullable = Partial<Config>;
 
 type platform =
   | "win7"
@@ -400,39 +402,39 @@ interface IComment {
   draw: (vpos: number, showCollision: boolean, isDebug: boolean) => void;
 }
 
-type inputFormatType =
-  | "niconicome"
-  | "formatted"
-  | "legacy"
-  | "legacyOwner"
-  | "owner"
-  | "v1"
-  | "default";
-type inputFormat =
-  | XMLDocument
-  | formattedComment[]
-  | formattedLegacyComment[]
-  | rawApiResponse[]
-  | ownerComment[]
-  | v1Thread[]
-  | string;
-type modeType = "default" | "html5" | "flash";
-type Options = {
-  config: ConfigNullable;
-  debug: boolean;
-  enableLegacyPiP: boolean;
-  format: inputFormatType;
-  formatted: boolean;
-  keepCA: boolean;
-  mode: modeType;
-  scale: number;
-  showCollision: boolean;
-  showCommentCount: boolean;
-  showFPS: boolean;
-  useLegacy: boolean;
-  video: HTMLVideoElement | undefined;
-};
-type InitOptions = Partial<Options>;
+type inputFormatType =
+  | "niconicome"
+  | "formatted"
+  | "legacy"
+  | "legacyOwner"
+  | "owner"
+  | "v1"
+  | "default";
+type inputFormat =
+  | XMLDocument
+  | formattedComment[]
+  | formattedLegacyComment[]
+  | rawApiResponse[]
+  | ownerComment[]
+  | v1Thread[]
+  | string;
+type modeType = "default" | "html5" | "flash";
+type Options = {
+  config: ConfigNullable;
+  debug: boolean;
+  enableLegacyPiP: boolean;
+  format: inputFormatType;
+  formatted: boolean;
+  keepCA: boolean;
+  mode: modeType;
+  scale: number;
+  showCollision: boolean;
+  showCommentCount: boolean;
+  showFPS: boolean;
+  useLegacy: boolean;
+  video: HTMLVideoElement | undefined;
+};
+type InitOptions = Partial<Options>;
 
 type formattedCommentWithFont = {
   id: number;
@@ -597,7 +599,7 @@ declare class NiconiComments {
     private readonly collision;
     private readonly context;
     private readonly timeline;
-    constructor(canvas: HTMLCanvasElement, data: inputFormat[], initOptions?: InitOptions);
+    constructor(canvas: HTMLCanvasElement, data: inputFormat, initOptions?: InitOptions);
     preRendering(rawData: formattedComment[]): void;
     getCommentPos(data: IComment[]): IComment[];
     sortComment(parsedData: IComment[]): IComment[];
@@ -646,7 +648,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 +681,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 +691,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;