@book000/node-utils 1.2.28 → 1.2.29

package/.eslintignore

@@ -0,0 +1,5 @@
+dist
+output
+node_modules
+data
+logs

package/.eslintrc.yml

@@ -0,0 +1,21 @@
+env:
+  es2020: true
+  node: true
+extends:
+  - standard
+  - plugin:@typescript-eslint/recommended
+  - plugin:unicorn/recommended
+  - prettier
+parser: '@typescript-eslint/parser'
+parserOptions:
+  ecmaVersion: latest
+  sourceType: module
+  project: ./tsconfig.json
+plugins:
+  - '@typescript-eslint'
+rules:
+  '@typescript-eslint/no-explicit-any': off
+  '@typescript-eslint/ban-ts-comment': off
+  'unicorn/prefer-top-level-await': off
+  'unicorn/no-null': off
+  'no-console': error

package/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: book000

package/.github/workflows/nodejs-ci.yml

@@ -0,0 +1,18 @@
+# Node.js でビルド・テストを実行する。バージョンは .node-version に記載されているものを利用する
+
+name: Node CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  node-ci:
+    name: Node CI
+    uses: book000/templates/.github/workflows/reusable-nodejs-ci.yml@master

package/.github/workflows/release.yml

@@ -0,0 +1,63 @@
+name: Release
+
+on:
+  pull_request_target:
+    branches:
+      - main
+      - master
+    types:
+      - closed
+
+concurrency:
+  group: ${{ github.workflow }}
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true
+
+    steps:
+      - name: 🛎 Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: 🏗 Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .node-version
+          cache: yarn
+          cache-dependency-path: yarn.lock
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: 👨🏻‍💻 Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: 🏃 Build
+        run: yarn build
+
+      - name: 🏷 Bump version and push tag
+        id: tag-version
+        uses: mathieudutour/github-tag-action@v6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          default_bump: 'minor'
+          custom_release_rules: 'feat:minor:✨ Features,fix:patch:🐛 Fixes,docs:patch:📰 Docs,chore:patch:🎨 Chore,pref:patch:🎈 Performance improvements,refactor:patch:🧹 Refactoring,build:patch:🔍 Build,ci:patch:🔍 CI,revert:patch:⏪ Revert,style:patch:🧹 Style,test:patch:👀 Test,release:major:📦 Release'
+
+      - name: 📦 Publish
+        run: yarn publish --access public --non-interactive --no-git-tag-version --no-git-reset --no-commit-hooks --new-version ${{ steps.tag-version.outputs.new_version }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: 📃 Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.tag-version.outputs.new_tag }}
+          release_name: ${{ steps.tag-version.outputs.new_tag }}
+          body: ${{ steps.tag-version.outputs.changelog }}
+          draft: false
+          prerelease: false

package/.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

package/.node-version

@@ -0,0 +1 @@
+18.16.0

package/.prettierrc.yml

@@ -0,0 +1,12 @@
+printWidth: 80
+tabWidth: 2
+useTabs: false
+semi: false
+quoteProps: 'as-needed'
+singleQuote: true
+jsxSingleQuote: true
+trailingComma: 'es5'
+bracketSpacing: true
+bracketSameLine: true
+arrowParens: 'always'
+endOfLine: lf

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@book000/node-utils",
-  "version": "1.2.28",
+  "version": "1.2.29",
   "description": "Self-Utility library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist/"
+    "dist/",
+    "!dist/examples/"
   ],
   "repository": "git@github.com:book000/node-utils.git",
   "author": "Tomachi <tomachi@tomacheese.com>",

package/renovate.json

@@ -0,0 +1,12 @@
+{
+  "extends": [
+    "config:base"
+  ],
+  "ignorePresets": [
+    ":prHourlyLimit2"
+  ],
+  "timezone": "Asia/Tokyo",
+  "dependencyDashboard": false,
+  "automerge": true,
+  "branchConcurrentLimit": 0
+}

package/src/configuration.ts

@@ -0,0 +1,111 @@
+import fs from 'node:fs'
+import { parse } from 'jsonc-parser'
+
+/**
+ * 設定ファイルを管理するフレームワーククラス
+ *
+ * 設定ファイルは JSONC 形式でパースされる。
+ *
+ * @template IConfig 設定ファイルの型
+ */
+export abstract class ConfigFramework<IConfig> {
+  /** 設定ファイルのパス */
+  private path: string
+  private config: IConfig | undefined
+  private validateFailures: string[] = []
+
+  /**
+   * コンストラクタ
+   *
+   * ファイルの読み込みは行わない。{@link load} を呼び出すことで読み込む。
+   *
+   * 原則、以下の環境変数を利用する。値の場所にファイルがあればそれを利用する。
+   * - CONFIG_PATH
+   * - CONFIG_FILE
+   * 環境変数に値が設定されておらず、設定ファイルのパスが path に指定されていてそのファイルがある場合はそのファイルを設定ファイルとして使用する
+   * いずれの方法でもパスを取得できない場合はエラーを投げる
+   *
+   * @param path 設定ファイルのパス
+   * @returns インスタンス
+   */
+  constructor(path?: string) {
+    const paths = [
+      process.env.CONFIG_PATH,
+      process.env.CONFIG_FILE,
+      path,
+    ].filter((p) => p !== undefined && fs.existsSync(p)) as string[]
+    if (paths.length === 0) {
+      throw new Error('Config path not found')
+    }
+    this.path = paths[0]
+  }
+
+  /**
+   * 設定ファイルの検証ルールを定義する
+   *
+   * key には検証ルールの名前を指定する。
+   * value には検証ルールを定義する関数を指定する。
+   *
+   * @returns 検証ルール
+   */
+  protected abstract validates(): {
+    [key: string]: (config: IConfig) => boolean
+  }
+
+  /**
+   * 設定ファイルを読み込む
+   *
+   * 設定ファイルのパスはコンストラクタで指定されたものが利用される。
+   * この関数内ではバリデーションは行わないので、{@link validate} を呼び出す必要がある。
+   */
+  public load(): void {
+    const data = fs.readFileSync(this.path, 'utf8')
+    const json = parse(data) as IConfig
+    this.config = json
+  }
+
+  /**
+   * 設定ファイルのバリデーションを行う
+   *
+   * この関数を呼び出す前に、{@link load} を呼び出して設定ファイルを読み込んでおく必要がある。
+   * バリデーションに失敗した場合は、{@link getValidateFailures} で失敗した項目を取得できる。
+   *
+   * @returns バリデーションに成功した場合は true、失敗した場合は false
+   */
+  public validate(): boolean {
+    if (!this.config) throw new Error('Config not loaded')
+
+    this.validateFailures = []
+    const validates = this.validates()
+    for (const key in validates) {
+      try {
+        if (!validates[key](this.config)) {
+          this.validateFailures.push(key)
+        }
+      } catch {
+        this.validateFailures.push(key)
+      }
+    }
+    return this.validateFailures.length === 0
+  }
+
+  /**
+   * バリデーションに失敗した項目を取得する
+   *
+   * @returns バリデーションに失敗した項目の配列
+   */
+  public getValidateFailures(): string[] {
+    return this.validateFailures
+  }
+
+  /**
+   * 設定の値を取得する
+   *
+   * @param key 設定のキー
+   * @returns 設定の値
+   */
+  public get<T extends keyof IConfig>(key: T): IConfig[T] {
+    if (!this.config) throw new Error('Config not loaded')
+    return this.config[key]
+  }
+}

package/src/cycle.d.ts

@@ -0,0 +1,4 @@
+declare module 'cycle' {
+  export function decycle(object: any): any
+  export function retrocycle(json: any): any
+}

package/src/discord.ts

@@ -0,0 +1,219 @@
+import axios from 'axios'
+import FormData from 'form-data'
+
+interface DiscordBotOptions {
+  token: string
+  channelId: string
+}
+
+interface DiscordWebhookOptions {
+  webhookUrl: string
+}
+
+export type DiscordOptions = DiscordBotOptions | DiscordWebhookOptions
+export interface DiscordEmbedFooter {
+  text: string
+  icon_url?: string
+  proxy_icon_url?: string
+}
+
+export interface DiscordEmbedImage {
+  url?: string
+  proxy_url?: string
+  height?: number
+  width?: number
+}
+
+export interface DiscordEmbedThumbnail {
+  url?: string
+  proxy_url?: string
+  height?: number
+  width?: number
+}
+
+export interface DiscordEmbedVideo {
+  url?: string
+  proxy_url?: string
+  height?: number
+  width?: number
+}
+
+export interface DiscordEmbedProvider {
+  name?: string
+  url?: string
+}
+
+export interface DiscordEmbedAuthor {
+  name?: string
+  url?: string
+  icon_url?: string
+  proxy_icon_url?: string
+}
+
+export interface DiscordEmbedField {
+  name: string
+  value: string
+  inline?: boolean
+}
+
+export interface DiscordEmbed {
+  title?: string
+  type?: 'rich' | 'image' | 'video' | 'gifv' | 'article' | 'link'
+  description?: string
+  url?: string
+  timestamp?: string
+  color?: number
+  footer?: DiscordEmbedFooter
+  image?: DiscordEmbedImage
+  thumbnail?: DiscordEmbedThumbnail
+  video?: DiscordEmbedVideo
+  provider?: DiscordEmbedProvider
+  author?: DiscordEmbedAuthor
+  fields?: DiscordEmbedField[]
+}
+
+interface DiscordNormalMessage {
+  content: string
+}
+
+interface DiscordEmbedMessage {
+  embeds: DiscordEmbed[]
+}
+
+interface DiscordFile {
+  name: string
+  file: ArrayBuffer
+  contentType?: string
+  isSpoiler?: boolean
+}
+
+interface DiscordFileMessage {
+  file: DiscordFile
+}
+
+export type DiscordMessage =
+  | DiscordNormalMessage
+  | DiscordEmbedMessage
+  | DiscordFileMessage
+
+export class Discord {
+  private options: DiscordOptions
+
+  constructor(options: DiscordOptions) {
+    // token があれば Bot として動作する
+    // webhookUrl と channelId があれば Webhook として動作する
+    // どちらもなければエラーを投げる
+
+    if (this.isDiscordBotOptions(options)) {
+      this.options = options
+    } else if (this.isDiscordWebhookOptions(options)) {
+      this.options = options
+    } else {
+      throw new Error('Invalid options')
+    }
+  }
+
+  public static get validations(): {
+    [key: string]: (options: any) => boolean
+  } {
+    return {
+      'token or webhookUrl and channelId': (options: any) =>
+        'token' in options ||
+        ('webhookUrl' in options && 'channelId' in options),
+      'token is valid': (options: any) => typeof options.token === 'string',
+      'webhookUrl is valid': (options: any) =>
+        typeof options.webhookUrl === 'string',
+      'channelId is valid': (options: any) =>
+        typeof options.channelId === 'string',
+    }
+  }
+
+  public async sendMessage(message: string | DiscordMessage): Promise<void> {
+    const formData = new FormData()
+
+    if (typeof message === 'string') {
+      formData.append('payload_json', JSON.stringify({ content: message }))
+    } else {
+      formData.append(
+        'payload_json',
+        JSON.stringify({
+          content: 'content' in message ? message.content : undefined,
+          embeds: 'embeds' in message ? message.embeds : undefined,
+        })
+      )
+
+      if ('file' in message) {
+        formData.append('file', message.file.file, {
+          filename: `${message.file.isSpoiler === true ? 'SPOILER_' : ''}${
+            message.file.name
+          }`,
+          contentType: message.file.contentType,
+        })
+      }
+    }
+
+    await (this.isDiscordBotOptions(this.options)
+      ? this.sendBot(formData)
+      : this.sendWebhook(formData))
+  }
+
+  private async sendBot(formData: FormData): Promise<void> {
+    if (!this.isDiscordBotOptions(this.options)) {
+      throw new Error('Invalid bot options')
+    }
+
+    const response = await axios.post(
+      `https://discord.com/api/channels/${this.options}/messages`,
+      formData,
+      {
+        headers: {
+          ...formData.getHeaders(),
+          Authorization: `Bot ${this.options.token}`,
+        },
+        validateStatus: () => true,
+      }
+    )
+    if (response.status !== 200) {
+      throw new Error(`Discord API returned ${response.status}`)
+    }
+  }
+
+  private async sendWebhook(formData: FormData): Promise<void> {
+    if (!this.isDiscordWebhookOptions(this.options)) {
+      throw new Error('Invalid webhook options')
+    }
+
+    const response = await axios.post(this.options.webhookUrl, formData, {
+      headers: {
+        ...formData.getHeaders(),
+      },
+      validateStatus: () => true,
+    })
+    if (response.status !== 200 && response.status !== 204) {
+      throw new Error(`Discord API returned ${response.status}`)
+    }
+  }
+
+  private isDiscordBotOptions(
+    options: DiscordOptions
+  ): options is DiscordBotOptions {
+    return (
+      'token' in options &&
+      typeof options.token === 'string' &&
+      options.token.length > 0 &&
+      'channelId' in options &&
+      typeof options.channelId === 'string' &&
+      options.channelId.length > 0
+    )
+  }
+
+  private isDiscordWebhookOptions(
+    options: DiscordOptions
+  ): options is DiscordWebhookOptions {
+    return (
+      'webhookUrl' in options &&
+      typeof options.webhookUrl === 'string' &&
+      options.webhookUrl.length > 0
+    )
+  }
+}

package/src/examples/example-configuration.ts

@@ -0,0 +1,33 @@
+import { ConfigFramework, Logger } from '..'
+
+export interface Configuration {
+  foo: string
+  bar: number
+}
+
+class ExampleConfiguration extends ConfigFramework<Configuration> {
+  protected validates(): { [key: string]: (config: Configuration) => boolean } {
+    return {
+      // ...Discord.validations, // When using a message transmission to Discord
+      'foo is required': (config) => config.foo !== undefined,
+      'foo is string': (config) => typeof config.foo === 'string',
+      'foo is 3 or more characters': (config) => config.foo.length >= 3,
+      'bar is required': (config) => config.bar !== undefined,
+      'bar is number': (config) => typeof config.bar === 'number',
+    }
+  }
+}
+
+export function exampleConfiguration() {
+  const logger = Logger.configure('exampleConfiguration')
+  const config = new ExampleConfiguration()
+  config.load()
+  if (!config.validate()) {
+    logger.error('Configuration validation failed')
+    logger.error(config.getValidateFailures().join(', '))
+    return
+  }
+
+  logger.info(`foo: ${config.get('foo')}`)
+  logger.info(`bar: ${config.get('bar')}`)
+}

package/src/examples/example-discord.ts

@@ -0,0 +1,28 @@
+import { Discord, Logger } from '..'
+
+export async function exampleDiscord() {
+  const logger = Logger.configure('exampleDiscord')
+
+  const discordWebhookUrl = process.env.DISCORD_WEBHOOK_URL
+  if (!discordWebhookUrl) {
+    logger.error('DISCORD_WEBHOOK_URL are required')
+    return
+  }
+
+  const discord = new Discord({
+    webhookUrl: discordWebhookUrl,
+  })
+
+  await discord.sendMessage('Hello world!')
+
+  await discord.sendMessage({
+    embeds: [
+      {
+        title: 'Hello world!',
+        description:
+          'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
+        color: 0x00_ff_00,
+      },
+    ],
+  })
+}

package/src/examples/example-logger.ts

@@ -0,0 +1,6 @@
+import { Logger } from '..'
+
+export function exampleLogger() {
+  const logger = Logger.configure('exampleLogger')
+  logger.info('Hello world!')
+}