jordy 0.12.0

package/libs/validate/fn.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 값이 비어있지 않은지 여부를 확인한다.
+ * undefined, null 여부도 확인하며, 값이 'undefined', 'null' 이라는 문자열로 된 것인지도 확인 한다.
+ *
+ * @param val
+ * @returns 비어있지 않다면 true, 아니면 false.
+ */
+declare function required(val: string): boolean;
+/**
+ * 이메일 유효성을 검증한다.
+ * 좌측에 숫자/문자/ 언더바(_) 및 하이픈(-) 만 허용한다.
+ * 내부적으로 validLength 를 수행하여 7~100 자 까지 인지를 함께 검증한다.
+ * @param val
+ */
+declare function email(val: string): boolean;
+/**
+ * 비밀번호의 유효성을 체크한다. - 약한 버전 - -
+ * 숫자, 영문 각각 1자 이상 포함되고
+ * 총 길이가 6자~20자 까지 인지를 확인한다.
+ * @param val
+ */
+declare function passwordWeak(val: string): boolean;
+/**
+ * 비밀번호의 유효성을 체크한다. - 강력 버전 - -
+ * 숫자, 영문 대/소문자 및 특수문자가 모두 최소 1자 이상 포함되고
+ * 총 길이가 6자~32자 까지 인지를 확인한다.
+ * @param val
+ */
+declare function password(val: string): boolean;
+/**
+ * 소문자가 존재하는지 체크한다.
+ * @param val
+ */
+declare function lowercase(val: string): boolean;
+/**
+ * 대문자가 존재하는지 체크한다.
+ * @param val
+ */
+declare function uppercase(val: string): boolean;
+/**
+ * 숫자가 존재하는지 체크한다.
+ * @param val
+ */
+declare function numbers(val: string): boolean;
+/**
+ * 특수문자가 존재하는지 체크한다.
+ * @param val
+ */
+declare function symbols(val: string): boolean;
+/**
+ * 한글 또는 영문으로 2글자 이상, 100글자 이하인지 확인한다.
+ * @param val 확인할 값
+ */
+declare function korAndEng(val: string): boolean;
+/**
+ * 번호 유효성을 체크 한다.
+ * 값은 번호만 이뤄져 있어야 하며 앞이 0으로 채워져 있어도 유효하다.
+ * @param val 확인할 값
+ */
+declare function numberOnly(val: string): boolean;
+/**
+ * 특정범위의 값인지 여부를 확인한다.
+ * ```ts
+ * const checker = validate.fn.range(10, 100);
+ *
+ * checker(50); // true
+ * checker(9); // false
+ * checker(101); // false
+ * ```
+ * @param min
+ * @param max
+ * @returns
+ */
+declare function range(min: number, max: number): (val: string | number) => boolean;
+/**
+ * 전화번호 유효성을 체크 한다.
+ *
+ * 중간에 dash (-) 가 있어야 한다.
+ * @param val 확인할 값
+ */
+declare function phoneWithDash(val: string): boolean;
+/**
+ * 전화번호 유효성을 체크 한다.
+ * 숫자로만 이뤄져 있어야하며, 최소 8자리, 최대 11자리 까지 허용 된다.
+ *
+ * @param val 확인할 값
+ */
+declare function phone(val: string): boolean;
+/**
+ * 사업자 등록번호 유효성을 검증한다.
+ * @param val
+ */
+declare function companyRegNumber(val: string): boolean;
+declare const _default: {
+    required: typeof required;
+    email: typeof email;
+    passwordWeak: typeof passwordWeak;
+    password: typeof password;
+    lowercase: typeof lowercase;
+    uppercase: typeof uppercase;
+    numbers: typeof numbers;
+    symbols: typeof symbols;
+    korAndEng: typeof korAndEng;
+    numberOnly: typeof numberOnly;
+    range: typeof range;
+    phoneWithDash: typeof phoneWithDash;
+    phone: typeof phone;
+    companyRegNumber: typeof companyRegNumber;
+    length: (min: number, max: number) => (val: string) => boolean;
+};
+export default _default;

package/libs/validate/index.d.ts

@@ -0,0 +1,58 @@
+import { validate } from './validate';
+import fn from './fn';
+declare type ValidationCheckerType = typeof validate & {
+    fn: typeof fn;
+};
+/**
+ * @description
+ * 유효성 여부를 한번에 확인 한다.
+ *
+ * @example
+ * ```ts
+ *  import { validate } from 'ts-fe-toolkit';
+ *
+    interface UserModel {
+      name: string;
+      phone: string;
+      password: string;
+    }
+
+    function execValidation(user: UserModel) {
+      const result = validate(user, {
+        // 한가지 검증일 땐 객체로 넘겨준다.
+        name: {
+          // check 가 false 일 때 알려줄 메시지
+          message: '이름을 채워주세요.',
+          // 유효성 검사. 결과가 true 면 유효성이 검증된 것이다.
+          check: val => validate.fn.empty(val),
+        },
+        // phone 이 필수가 아니라면 생략한다.
+        
+        // 여러가지 형태를 검증하고 메시지를 다르게 주고 싶을 땐 배열로 넘겨준다.
+        password: [
+          {
+            message: '비밀번호를 입력하세요',
+            check: val => validate.fn.empty(val),
+          },
+          {
+            message: '비밀번호가 유효하지 않습니다.',
+            check: val => validate.fn.password(val),
+          },
+        ]
+      });
+
+      console.log(result.isValid); // true 면 모든 유효성 통과.
+      console.log(result.firstMessage); // 검증 중 가장 첫번째로 나타난 에러 메시지
+      console.log(result.results); // 각 필드별 결과
+      // 자세한건 `ValidateBulkResultModel` 참고
+    }
+ * ```
+ * @param state 유효성 체크 할 값이 모여있는 객체.
+ * @param opt 유효성 체크 옵션.
+ *
+ * @see ValidateBulkResultModel
+ */
+declare const validateFn: ValidationCheckerType;
+export default validateFn;
+export * from './mergeValidates';
+export * from './validate.type';

package/libs/validate/mergeValidates.d.ts

@@ -0,0 +1,21 @@
+import { ValidateBulkResultModel } from './validate.type';
+/**
+ * 유효성 검증 결과 여러개를 하나의 결과로 병합한다.
+ *
+ * 병합후엔 하나의 {ValidateBulkResultModel} 타입으로 만들어진다.
+ *
+ * @example
+ * ```ts
+ * const result: ValidateBulkResultModel = mergeValidates(
+ *   validate(dataA, { someAttr: val => isSomeCondition(val) }),
+ *   validate(dataB, { otherProps: val => isMyCondition(val) }),
+ *   validate(dataC, { anotherName: val => hasSomeValues(val) }),
+ * );
+ *
+ * console.log(result.isValid); // 유효할 경우 true
+ * ```
+ *
+ * @param args 하나로
+ * @returns {ValidateBulkResultModel}
+ */
+export declare function mergeValidates(...args: ValidateBulkResultModel[]): ValidateBulkResultModel;

package/libs/validate/validate.d.ts

@@ -0,0 +1,2 @@
+import { ValidateBulkOptionType, ValidateBulkResultModel } from './validate.type';
+export declare function validate<T>(state: T, opt: ValidateBulkOptionType<T>): ValidateBulkResultModel;

package/libs/validate/validate.type.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 유효성 검사 결과 데이터.
+ */
+export interface ValidateResultModel {
+    /**
+     * 유효성 체크 결과.
+     * true면 통과, false 면 통과 못했음
+     */
+    result: boolean;
+    /**
+     * 사용자에게 보여줄 메시지.
+     * result 가 false 일 때만 값이 포함되어 있다.
+     */
+    message: string;
+}
+/**
+ * 오류 메시지가 모여진 데이터.
+ *
+ * 스토어 상태에 에러 메시지 항목을 추가 할 때 쓰인다.
+ */
+export interface ErrorMessagesModel {
+    /**
+     * 휴효하지 못했던 키와 그에 대한 메시지를 모아둔 자료.
+     *
+     * KVP 로써 지정된 필드에 값이 없다면 에러가 아닌 것으로 간주될 수 있다.
+     *
+     * reducer 에 곧바로 응용할 때 유용하다.
+     */
+    errorMessages: Record<string, string>;
+}
+/**
+ * 유효성 여부를 한번에 확인 후 받아볼 수 있는 결과 데이터
+ */
+export interface ValidateBulkResultModel extends ErrorMessagesModel {
+    /**
+     * 전체 유효성 검증 통과 여부. true 면 통과, false 면 아님
+     */
+    isValid: boolean;
+    /**
+     * 각 필드별 결과. key 로 접근할 수 있다.
+     */
+    results: Record<string, ValidateResultModel>;
+    /**
+     * 유효했던 키 목록
+     */
+    validKeys: string[];
+    /**
+     * 유효성 실패된 키 목록
+     */
+    invalidKeys: string[];
+    /**
+     * 여러 유효성 메시지 중 가장 첫번째 것을 담고 있다.
+     */
+    firstMessage: string;
+}
+/**
+ * 유효성 체크 요청에 쓰이는 모델.
+ */
+export interface ValidateCheckModel<T> {
+    /**
+     * 해당 유효성 체크를 무시하는 조건.
+     *
+     * 설정하여 그 결과값이 true 라면 해당 필드의 모든 유효성 체크를 무시한다.
+     *
+     * 설정 시 가장 첫번째 유효성 체크 설정에만 유효하다.
+     */
+    ignore?: ((val: T) => boolean) | boolean;
+    /**
+     * 유효성 체크에 실패 했을 때 출력될 메시지
+     */
+    message: string;
+    /**
+     * 유효성 체크 수행 함수.
+     *
+     * 결과가 false 면 유효성 체크에 실패 한 것으로 간주한다.
+     */
+    check: (val: T) => boolean;
+}
+/**
+ * 유효성 체크를 한번에 실시 할 때 쓰이는 모델. key : value 로 이뤄져 있다.
+ */
+export declare type ValidateBulkOptionType<T extends Record<string, any>> = {
+    [key in keyof T]?: ValidateCheckModel<T[key]> | ValidateCheckModel<T[key]>[] | ((value: T[key]) => ValidateBulkResultModel);
+};

package/libs/validate/validateSubUtils.d.ts

@@ -0,0 +1,12 @@
+import { ValidateBulkResultModel, ValidateCheckModel, ValidateResultModel } from './validate.type';
+declare function createValidateBulkResultModel(): ValidateBulkResultModel;
+declare function validateSingle<T>(val: T, { check, message }: ValidateCheckModel<T>): ValidateResultModel;
+declare function checkIgnore<T>(ignore: undefined | boolean | ((val: T) => boolean), val: T): boolean;
+declare function validateBulk<T>(val: T, opt: ValidateCheckModel<T> | ValidateCheckModel<T>[] | ((value: T) => ValidateBulkResultModel)): ValidateResultModel;
+export declare const validateSubUtils: {
+    createValidateBulkResultModel: typeof createValidateBulkResultModel;
+    validateSingle: typeof validateSingle;
+    validateBulk: typeof validateBulk;
+    checkIgnore: typeof checkIgnore;
+};
+export {};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "jordy",
+  "version": "0.12.0",
+  "description": "typescript based frontend toolkit",
+  "main": "./esm5/index.js",
+  "module": "./esm5/index.js",
+  "types": "./libs/index.d.ts",
+  "scripts": {
+    "compile:esm5": "tsc -b tsconfig.esm5.json",
+    "compile:types": "tsc -b tsconfig.types.json",
+    "clean": "rimraf cjs esm5 types libs",
+    "build": "npm-run-all clean compile:esm5 compile:types",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "prettier": "prettier './packages/**/*.ts'",
+    "lint": "eslint 'packages/**'"
+  },
+  "keywords": [
+    "typescript",
+    "frontend",
+    "toolkit"
+  ],
+  "author": "Theson",
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/preset-env": "^7.15.8",
+    "@babel/preset-typescript": "^7.15.0",
+    "@reduxjs/toolkit": "^1.6.1",
+    "@types/lodash-es": "^4.17.6",
+    "@types/react": "^17.0.24",
+    "@types/react-router-dom": "^5.3.0",
+    "@typescript-eslint/eslint-plugin": "^4.32.0",
+    "@typescript-eslint/parser": "^4.32.0",
+    "@vitejs/plugin-legacy": "^2.0.0",
+    "@vitejs/plugin-react": "^2.0.0",
+    "axios": "^0.21.4",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-react": "^7.26.0",
+    "lodash-es": "^4.17.21",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.4.1",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-router-dom": "^5.3.0",
+    "redux": "^4.1.1",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.3.0",
+    "tslib": "^2.3.1",
+    "typescript": "^4.7.4",
+    "vite": "^3.0.2",
+    "vitest": "^0.18.1"
+  },
+  "files": [
+    "esm5/**/*.js",
+    "libs/**/*.d.ts"
+  ]
+}