@xpadev-net/niconicomments 0.2.23 → 0.2.25

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 xpadev-net
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 xpadev-net
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,42 +1,42 @@
-# [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  
-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/master/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/)  
-[CodePen](https://codepen.io/xpadev-net/pen/mdBdQmX)  
+# [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  
+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/master/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/)  
+[CodePen](https://codepen.io/xpadev-net/pen/mdBdQmX)  

package/dist/bundle.d.ts

@@ -0,0 +1,368 @@
+declare const colors: {
+    [key: string]: string;
+};
+declare const commentYPaddingTop = 0.08;
+declare const commentYMarginBottom = 0.24;
+declare const fontSize: typeFontSize;
+declare const lineHeight: typeFontSize;
+declare const doubleResizeMaxWidth: typeDoubleResizeMaxWidth;
+declare const defaultOptions: Options;
+declare const fpsInterval = 500;
+declare const cacheAge = 2000;
+declare const canvasWidth = 1920;
+declare const canvasHeight = 1080;
+declare const commentDrawRange = 1450;
+declare const commentDrawPadding: number;
+declare const collisionRange: {
+    left: number;
+    right: number;
+};
+declare const sameCARange = 3600;
+declare const sameCAGap = 100;
+declare const sameCAMinScore = 10;
+
+//# sourceMappingURL=definition.d.ts.map
+type inputFormatType =
+  | "niconicome"
+  | "formatted"
+  | "legacy"
+  | "legacyOwner"
+  | "owner"
+  | "v1"
+  | "default";
+type InitOptions = {
+  useLegacy?: boolean;
+  formatted?: boolean;
+  format?: inputFormatType;
+  video?: HTMLVideoElement | undefined;
+  showCollision?: boolean;
+  showFPS?: boolean;
+  showCommentCount?: boolean;
+  drawAllImageOnLoad?: boolean;
+  debug?: boolean;
+  enableLegacyPiP?: boolean;
+  keepCA?: boolean;
+};
+type Options = {
+  useLegacy: boolean;
+  formatted: boolean;
+  format: inputFormatType;
+  video: HTMLVideoElement | undefined;
+  showCollision: boolean;
+  showFPS: boolean;
+  showCommentCount: boolean;
+  drawAllImageOnLoad: boolean;
+  debug: boolean;
+  enableLegacyPiP: boolean;
+  keepCA: boolean;
+};
+type rawApiResponse = {
+  [key: string]: apiPing | apiThread | apiLeaf | apiGlobalNumRes | apiChat;
+};
+type apiPing = {
+  content: string;
+};
+type apiThread = {
+  resultcode: number;
+  thread: string;
+  server_time: number;
+  ticket: string;
+  revision: number;
+};
+type apiLeaf = {
+  thread: string;
+  count: number;
+};
+type apiGlobalNumRes = {
+  thread: string;
+  num_res: number;
+};
+type apiChat = {
+  thread: string;
+  no: number;
+  vpos: number;
+  date: number;
+  date_usec: number;
+  nicoru: number;
+  premium: number;
+  anonymity: number;
+  user_id: string;
+  mail: string;
+  content: string;
+  deleted: number;
+};
+type formattedComment = {
+  id: number;
+  vpos: number;
+  content: string;
+  date: number;
+  date_usec: number;
+  owner: boolean;
+  premium: boolean;
+  mail: string[];
+  user_id: number;
+  layer: number;
+};
+type formattedLegacyComment = {
+  id: number;
+  vpos: number;
+  content: string;
+  date: number;
+  date_usec: number;
+  owner: boolean;
+  premium: boolean;
+  mail: string[];
+};
+type formattedCommentWithFont = formattedComment & {
+  loc: commentLoc;
+  size: commentSize;
+  fontSize: number;
+  font: commentFont;
+  color: string;
+  full: boolean;
+  ender: boolean;
+  _live: boolean;
+  long: number;
+  invisible: boolean;
+};
+type formattedCommentWithSize = formattedCommentWithFont & {
+  height: number;
+  width: number;
+  width_max: number;
+  width_min: number;
+  lineHeight: number;
+};
+type parsedComment = formattedCommentWithSize & {
+  posY: number;
+  image?: HTMLCanvasElement | boolean;
+};
+type groupedResult = formattedCommentWithFont & {
+  index: number;
+};
+type groupedComments = {
+  [key in commentFont]: { [key: string]: groupedResult[] };
+};
+type commentFont = "defont" | "mincho" | "gothic";
+type commentSize = "big" | "medium" | "small";
+type commentLoc = "ue" | "naka" | "shita";
+type collision = { [key in collisionPos]: collisionItem };
+type collisionPos = "ue" | "shita" | "right" | "left";
+type collisionItem = { [p: number]: number[] };
+type nicoScript = {
+  reverse: nicoScriptReverse[];
+  ban: nicoScriptBan[];
+  default: nicoScriptDefault[];
+  replace: nicoScriptReplace[];
+};
+type nicoScriptReverse = {
+  target: nicoScriptReverseTarget;
+  start: number;
+  end: number;
+};
+type nicoScriptReverseTarget = "コメ" | "投コメ" | "全";
+type nicoScriptReplace = {
+  start: number;
+  long: number | undefined;
+  keyword: string;
+  replace: string;
+  range: nicoScriptReplaceRange;
+  target: nicoScriptReplaceTarget;
+  condition: nicoScriptReplaceCondition;
+  color: string | undefined;
+  size: commentSize | undefined;
+  font: commentFont | undefined;
+  loc: commentLoc | undefined;
+  no: number;
+};
+type nicoScriptReplaceRange = "単" | "全";
+type nicoScriptReplaceTarget = "コメ" | "投コメ" | "全" | "含まない" | "含む";
+type nicoScriptReplaceCondition = "完全一致" | "部分一致";
+type nicoScriptBan = {
+  start: number;
+  end: number;
+};
+type nicoScriptDefault = {
+  start: number;
+  long: number | undefined;
+  color: string | undefined;
+  size: commentSize | undefined;
+  font: commentFont | undefined;
+  loc: commentLoc | undefined;
+};
+type measureTextResult = {
+  width: number;
+  width_max: number;
+  width_min: number;
+  height: number;
+  resized: boolean;
+  fontSize: number;
+  lineHeight: number;
+};
+type parsedCommand = {
+  loc: commentLoc | undefined;
+  size: commentSize | undefined;
+  fontSize: number | undefined;
+  color: string | undefined;
+  font: commentFont | undefined;
+  full: boolean;
+  ender: boolean;
+  _live: boolean;
+  invisible: boolean;
+  long: number | undefined;
+};
+type typeFontSize = {
+  [key in commentSize]: {
+    default: number;
+    resized: number;
+  };
+};
+type typeDoubleResizeMaxWidth = {
+  [key in "full" | "normal"]: {
+    legacy: number;
+    default: number;
+  };
+};
+type v1Thread = {
+  id: string;
+  fork: string;
+  commentCount: number;
+  comments: { [key: string]: v1Comment };
+};
+type v1Comment = {
+  id: string;
+  no: number;
+  vposMs: number;
+  body: string;
+  commands: string[];
+  userId: string;
+  isPremium: boolean;
+  score: number;
+  postedAt: string;
+  nicoruCount: number;
+  nicoruId: undefined;
+  source: string;
+  isMyPost: boolean;
+};
+type ownerComment = {
+  time: string;
+  command: string;
+  comment: string;
+};
+
+declare const convert2formattedComment: (data: unknown, type: inputFormatType) => formattedComment[];
+
+//# sourceMappingURL=inputParser.d.ts.map
+declare class NiconiComments {
+    enableLegacyPiP: boolean;
+    showCollision: boolean;
+    showFPS: boolean;
+    showCommentCount: boolean;
+    video: HTMLVideoElement | undefined;
+    private data;
+    private fps;
+    private fpsCount;
+    private lastVpos;
+    private readonly cacheIndex;
+    private readonly canvas;
+    private readonly collision;
+    private readonly context;
+    private readonly keepCA;
+    private readonly nicoScripts;
+    private readonly timeline;
+    private readonly useLegacy;
+    constructor(canvas: HTMLCanvasElement, data: (rawApiResponse | formattedComment)[], initOptions?: InitOptions);
+    preRendering(rawData: formattedComment[], drawAll: boolean): void;
+    getFont(parsedData: formattedComment[]): formattedCommentWithFont[];
+    getCommentSize(parsedData: formattedCommentWithFont[]): formattedCommentWithSize[];
+    getCommentPos(data: parsedComment[]): parsedComment[];
+    sortComment(parsedData: parsedComment[]): parsedComment[];
+    measureText(comment: {
+        content: string;
+        resized?: boolean;
+        ender: boolean;
+        size: commentSize;
+        fontSize: number;
+        resizedY?: boolean;
+        resizedX?: boolean;
+        font: commentFont;
+        loc: commentLoc;
+        full: boolean;
+        lineHeight?: number;
+    }): measureTextResult;
+    drawText(comment: parsedComment, vpos: number): void;
+    getTextImage(i: number, preRendering?: boolean): void;
+    parseCommand(comment: formattedComment): parsedCommand;
+    parseCommandAndNicoscript(comment: formattedComment): formattedCommentWithFont;
+    drawCanvas(vpos: number, forceRendering?: boolean): void;
+    clear(): void;
+}
+
+//# sourceMappingURL=main.d.ts.map
+declare const typeGuard: {
+    formatted: {
+        comment: (i: unknown) => i is formattedComment;
+        comments: (i: unknown) => i is formattedComment[];
+        legacyComment: (i: unknown) => i is formattedLegacyComment;
+        legacyComments: (i: unknown) => i is formattedLegacyComment[];
+    };
+    legacy: {
+        rawApiResponses: (i: unknown) => i is rawApiResponse[];
+        apiChat: (i: unknown) => i is apiChat;
+        apiGlobalNumRes: (i: unknown) => i is apiGlobalNumRes;
+        apiLeaf: (i: unknown) => i is apiLeaf;
+        apiPing: (i: unknown) => i is apiPing;
+        apiThread: (i: unknown) => i is apiThread;
+    };
+    niconicome: {
+        xmlDocument: (i: unknown) => i is XMLDocument;
+    };
+    legacyOwner: {
+        comments: (i: unknown) => i is string;
+    };
+    owner: {
+        comment: (i: unknown) => i is ownerComment;
+        comments: (i: unknown) => i is ownerComment[];
+    };
+    v1: {
+        comment: (i: unknown) => i is apiThread;
+        thread: (i: unknown) => i is v1Thread;
+        threads: (i: unknown) => i is v1Thread[];
+    };
+    nicoScript: {
+        range: {
+            target: (i: unknown) => i is nicoScriptReverseTarget;
+        };
+        replace: {
+            range: (i: unknown) => i is nicoScriptReplaceRange;
+            target: (i: unknown) => i is nicoScriptReplaceTarget;
+            condition: (i: unknown) => i is nicoScriptReplaceCondition;
+        };
+    };
+    comment: {
+        font: (i: unknown) => i is commentFont;
+        loc: (i: unknown) => i is commentLoc;
+        size: (i: unknown) => i is commentSize;
+        command: {
+            key: (i: unknown) => i is "full" | "ender" | "_live" | "invisible";
+        };
+    };
+};
+
+//# sourceMappingURL=typeGuard.d.ts.map
+declare const groupBy: (array: formattedCommentWithFont[]) => groupedComments;
+declare const getPosY: (currentPos: number, targetComment: parsedComment, collision: number[] | undefined, data: parsedComment[]) => {
+    currentPos: number;
+    isChanged: boolean;
+    isBreak: boolean;
+};
+declare const getPosX: (width: number, vpos: number, long: number) => number;
+declare const parseFont: (font: commentFont, size: string | number, useLegacy: boolean) => string;
+declare const arrayPush: (array: {
+    [key: number]: number[];
+}, key: string | number, push: number) => void;
+declare const hex2rgb: (hex: string) => number[];
+declare const replaceAll: (string: string, target: string, replace: string) => string;
+declare const changeCALayer: (rawData: formattedComment[]) => formattedComment[];
+
+//# sourceMappingURL=util.d.ts.map
+export default NiconiComments;