Merge pull request #64 from Palbahngmiyine/master

SOLAPI 5.4.0-beta.0

Author: Palbahngmiyine

.eslintrc

@@ -1,3 +1,7 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-3.2.3.cjs
+yarnPath: .yarn/releases/yarn-4.6.0.cjs

.yarn/releases/yarn-3.2.3.cjs

@@ -1,7 +1,7 @@
 MIT License
 -----------
 
-Copyright (c) 2022~ Nurigo Inc (https://solapi.com)
+Copyright (c) 2022~ SOLAPI Inc (https://solapi.com)
 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

.yarn/releases/yarn-4.6.0.cjs

@@ -0,0 +1,57 @@
+import typescriptEslintEslintPlugin from '@typescript-eslint/eslint-plugin';
+import tsdoc from 'eslint-plugin-tsdoc';
+import unusedImports from 'eslint-plugin-unused-imports';
+import globals from 'globals';
+import tsParser from '@typescript-eslint/parser';
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+import js from '@eslint/js';
+import {FlatCompat} from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  {
+    ignores: ['dist/**/*', 'examples/**/*', 'debug/**/*', 'docs/**/*'],
+  },
+  ...compat.extends('plugin:@typescript-eslint/recommended'),
+  {
+    plugins: {
+      '@typescript-eslint': typescriptEslintEslintPlugin,
+      tsdoc,
+      'unused-imports': unusedImports,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+      parser: tsParser,
+      ecmaVersion: 2018,
+      sourceType: 'module',
+    },
+
+    rules: {
+      quotes: ['error', 'single'],
+      semi: [2, 'always'],
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/no-explicit-any': 1,
+
+      '@typescript-eslint/no-inferrable-types': [
+        'warn',
+        {
+          ignoreParameters: true,
+        },
+      ],
+
+      '@typescript-eslint/no-unused-vars': 'warn',
+      'unused-imports/no-unused-imports': 'warn',
+    },
+  },
+];

.yarnrc.yml

@@ -1,11 +1,7 @@
 {
   "name": "solapi",
-  "version": "5.3.1",
+  "version": "5.4.0-beta.0",
   "description": "SOLAPI SDK for Node.js(Server Side Only)",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/solapi/solapi-nodejs.git"
-  },
   "keywords": [
     "solapi",
     "sms",
@@ -15,56 +11,76 @@
     "sdk",
     "korean sms"
   ],
+  "homepage": "https://solapi.com",
+  "bugs": {
+    "url": "https://github.com/solapi/solapi-nodejs/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/solapi/solapi-nodejs.git"
+  },
+  "license": "MIT",
   "author": {
-    "name": "Nurigo Team",
-    "email": "contact@nurigo.net"
+    "name": "SOLAPI Team",
+    "email": "contact@solapi.com"
   },
+  "type": "commonjs",
   "source": "src/solapi.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/solapi/solapi-nodejs/issues"
-  },
-  "homepage": "https://solapi.github.io/solapi-nodejs",
+  "module": "dist/index.module.js",
+  "files": [
+    "/dist"
+  ],
   "scripts": {
+    "build": "yarn clean && yarn lint && parcel build",
     "clean": "rimraf dist",
-    "build": "yarn clean && parcel build --no-source-maps",
-    "watch": "parcel watch",
-    "docs": "typedoc --entryPointStrategy expand ./src"
-  },
-  "engines": {
-    "node": ">=14",
-    "parcel": "2.x"
+    "docs": "typedoc --entryPointStrategy expand ./src",
+    "format": "prettier ./**/*.ts ./**/*.js ./**/*.mjs",
+    "lint": "eslint .",
+    "watch": "parcel watch"
   },
   "dependencies": {
-    "cross-fetch": "^3.1.5",
-    "crypto-js": "^4.1.1",
-    "date-fns": "^2.29.3",
+    "date-fns": "^4.1.0",
     "image-to-base64": "^2.2.0",
-    "nanoid": "^3.3.4",
-    "qs": "^6.11.0"
+    "qs": "^6.14.0"
   },
   "devDependencies": {
-    "@parcel/packager-ts": "2.8.1",
-    "@parcel/transformer-typescript-types": "2.8.1",
-    "@types/crypto-js": "^4.1.1",
-    "@types/image-to-base64": "^2.1.0",
-    "@types/node": "^18.11.13",
-    "@types/qs": "^6.9.7",
-    "@typescript-eslint/eslint-plugin": "^5.46.1",
-    "@typescript-eslint/parser": "^5.46.1",
-    "eslint": "^8.29.0",
-    "eslint-plugin-tsdoc": "^0.2.17",
-    "eslint-plugin-unused-imports": "^2.0.0",
-    "parcel": "^2.8.1",
-    "prettier": "^2.8.1",
-    "rimraf": "^3.0.2",
-    "typedoc": "^0.23.22",
-    "typescript": "^4.9.4"
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.21.0",
+    "@parcel/packager-ts": "^2.13.3",
+    "@parcel/transformer-typescript-tsc": "^2.13.3",
+    "@parcel/transformer-typescript-types": "^2.13.3",
+    "@parcel/validator-typescript": "^2.13.3",
+    "@types/crypto-js": "^4.2.2",
+    "@types/image-to-base64": "^2.1.2",
+    "@types/node": "^22.13.5",
+    "@types/qs": "^6.9.18",
+    "@typescript-eslint/eslint-plugin": "^8.25.0",
+    "@typescript-eslint/parser": "^8.25.0",
+    "eslint": "^9.21.0",
+    "eslint-plugin-tsdoc": "^0.4.0",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "globals": "^16.0.0",
+    "parcel": "^2.13.3",
+    "prettier": "^3.5.2",
+    "rimraf": "^6.0.1",
+    "typedoc": "^0.27.9",
+    "typescript": "^5.7.3"
   },
-  "files": [
-    "/dist"
-  ],
-  "packageManager": "yarn@3.2.3"
+  "packageManager": "yarn@4.6.0",
+  "engines": {
+    "node": ">=18",
+    "parcel": "2.x"
+  },
+  "targets": {
+    "main": {
+      "outputFormat": "commonjs",
+      "optimize": true
+    },
+    "module": {
+      "outputFormat": "esmodule",
+      "optimize": true
+    }
+  }
 }

LICENSE

@@ -1,6 +1,5 @@
-import {customAlphabet} from 'nanoid';
 import {formatISO} from 'date-fns';
-import {HmacSHA256} from 'crypto-js';
+import {createHmac, randomBytes} from 'node:crypto';
 import {ApiKeyError} from '../errors/defaultError';
 
 enum AuthenticateType {
@@ -12,6 +11,20 @@ export type AuthenticationParameter = {
   apiSecret?: string;
 };
 
+/**
+ * 특정 사이즈의 텍스트를 생성합니다.
+ * @param alphabet 지정할 알파벳/숫자 문자열
+ * @param size 지정할 문자 길이
+ */
+function genCustomText(alphabet: string, size: number): string {
+  const bytes = randomBytes(size);
+  let genRandomText = '';
+  for (let i = 0; i < size; i++) {
+    genRandomText += alphabet[bytes[i] % alphabet.length];
+  }
+  return genRandomText;
+}
+
 /**
  * Get Authenticate Information for SOLAPI Requests
  * @param authenticationParameter
@@ -26,16 +39,18 @@ export default function getAuthInfo(
   switch (authType) {
     case AuthenticateType.API_KEY:
     default:
-      const salt = customAlphabet(
+      const salt = genCustomText(
         '1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
         32,
-      )();
+      );
       const date = formatISO(new Date());
       const hmacData = date + salt;
       if (!apiKey || !apiSecret || apiKey === '' || apiSecret === '') {
         throw new ApiKeyError('Invalid API Key Error');
       }
-      const signature = HmacSHA256(hmacData, apiSecret).toString();
+      const genHmac = createHmac('sha256', apiSecret);
+      genHmac.update(hmacData);
+      const signature = genHmac.digest('hex');
       return `HMAC-SHA256 apiKey=${apiKey}, date=${date}, salt=${salt}, signature=${signature}`;
   }
 }

eslint.config.mjs

@@ -1,5 +1,4 @@
 import getAuthInfo, {AuthenticationParameter} from './authenticator';
-import fetch from 'cross-fetch';
 import {DefaultError, ErrorResponse} from '../errors/defaultError';
 
 type DefaultRequest = {
@@ -36,11 +35,12 @@ export default async function defaultFetcher<T, R>(
       );
     } else if (res.status >= 500) {
       const responseText = await res.text();
-      throw new DefaultError('UnknownException', responseText);
+      throw new DefaultError('UnknownError', responseText);
     }
     try {
       return res.json();
     } catch (exception) {
+      console.error(exception);
       throw new Error(await res.text());
     }
   });

package.json

@@ -1,14 +1,5 @@
 import {KakaoButton} from './kakaoButton';
-
-export type kakaoOptionRequest = {
-  pfId: string;
-  templateId?: string;
-  variables?: Record<string, string>;
-  disableSms?: boolean;
-  adFlag?: boolean;
-  buttons?: Array<KakaoButton>;
-  imageId?: string;
-};
+import {kakaoOptionRequest} from '../../requests/kakao/kakaoOptionRequest';
 
 export class KakaoOption {
   pfId: string;