dogu-utils 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,17 @@
+# Dogu-Utils
+
+Dogu-Utils is a utility library for TypeScript and JavaScript. The name "Dogu" (도구) is a Korean word that translates to "tool" in English. This library aims to be a useful tool for developers, providing a collection of utility features.
+
+## Features
+
+- TypeScript support
+- React hooks
+- Utility functions
+
+## Installation
+
+To install Dogu-Utils, run the following command:
+
+```sh
+npm install dogu-utils
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./react";

package/dist/index.js

@@ -0,0 +1,41 @@
+import { useState, useCallback, createContext, useContext } from 'react';
+import { jsx } from 'react/jsx-runtime';
+
+var useOpenCloseState = function useOpenCloseState(initialState) {
+  if (initialState === void 0) {
+    initialState = false;
+  }
+  var _a = useState(initialState),
+    isOpen = _a[0],
+    setIsOpen = _a[1];
+  var open = useCallback(function () {
+    return setIsOpen(true);
+  }, []);
+  var close = useCallback(function () {
+    return setIsOpen(false);
+  }, []);
+  return [isOpen, open, close];
+};
+
+var createSafeContext = function createSafeContext(defaultValue) {
+  var Context = /*#__PURE__*/createContext(defaultValue !== null && defaultValue !== void 0 ? defaultValue : null);
+  var Provider = function Provider(_a) {
+    var children = _a.children,
+      value = _a.value;
+    return jsx(Context.Provider, {
+      value: value,
+      children: children
+    });
+  };
+  var useSafeContext = function useSafeContext() {
+    var context = useContext(Context);
+    if (context === null) {
+      throw new Error("useSafeContext must be used within a Provider, or give it a default value.");
+    }
+    return context;
+  };
+  return [Provider, useSafeContext];
+};
+
+export { createSafeContext, useOpenCloseState };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/react/hooks/useOpenCloseState.ts","../src/react/utils/createSafeContext.tsx"],"sourcesContent":["import { useCallback, useState } from \"react\"\n\nexport const useOpenCloseState = (initialState = false) => {\n  const [isOpen, setIsOpen] = useState(initialState)\n\n  const open = useCallback(() => setIsOpen(true), [])\n  const close = useCallback(() => setIsOpen(false), [])\n\n  return [isOpen, open, close] as const\n}\n","import { ReactNode, createContext, useContext } from \"react\"\n\ntype ProviderProps<Value> = {\n  children: ReactNode\n  value: Value\n}\n\nexport const createSafeContext = <Value,>(defaultValue?: Value) => {\n  const Context = createContext<Value | null>(defaultValue ?? null)\n\n  const Provider = ({ children, value }: ProviderProps<Value>) => {\n    return <Context.Provider value={value}>{children}</Context.Provider>\n  }\n\n  const useSafeContext = () => {\n    const context = useContext(Context)\n    if (context === null) {\n      throw new Error(\n        \"useSafeContext must be used within a Provider, or give it a default value.\"\n      )\n    }\n    return context\n  }\n\n  return [Provider, useSafeContext] as const\n}\n"],"names":["useOpenCloseState","initialState","_a","useState","isOpen","setIsOpen","open","useCallback","close","createSafeContext","defaultValue","Context","createContext","Provider","children","value","_jsx","useSafeContext","context","useContext","Error"],"mappings":";;;IAEaA,iBAAiB,GAAG,SAApBA,iBAAiBA,CAAIC,YAAoB,EAAA;AAApB,EAAA,IAAAA,YAAA,KAAA,KAAA,CAAA,EAAA;AAAAA,IAAAA,YAAoB,GAAA,KAAA;AAAA;AAC9C,EAAA,IAAAC,EAAA,GAAsBC,QAAQ,CAACF,YAAY,CAAC;AAA3CG,IAAAA,MAAM,GAAAF,EAAA,CAAA,CAAA,CAAA;AAAEG,IAAAA,SAAS,GAAAH,EAAA,CAAA,CAAA,CAA0B;AAElD,EAAA,IAAMI,IAAI,GAAGC,WAAW,CAAC;IAAM,OAAAF,SAAS,CAAC,IAAI,CAAC;GAAA,EAAE,EAAE,CAAC;AACnD,EAAA,IAAMG,KAAK,GAAGD,WAAW,CAAC;IAAM,OAAAF,SAAS,CAAC,KAAK,CAAC;GAAA,EAAE,EAAE,CAAC;AAErD,EAAA,OAAO,CAACD,MAAM,EAAEE,IAAI,EAAEE,KAAK,CAAU;AACvC;;ICFaC,iBAAiB,GAAG,SAApBA,iBAAiBA,CAAYC,YAAoB,EAAA;AAC5D,EAAA,IAAMC,OAAO,gBAAGC,aAAa,CAAeF,YAAY,KAAA,IAAA,IAAZA,YAAY,KAAA,KAAA,CAAA,GAAZA,YAAY,GAAI,IAAI,CAAC;AAEjE,EAAA,IAAMG,QAAQ,GAAG,SAAXA,QAAQA,CAAIX,EAAyC,EAAA;QAAvCY,QAAQ,GAAAZ,EAAA,CAAAY,QAAA;MAAEC,KAAK,GAAAb,EAAA,CAAAa,KAAA;AACjC,IAAA,OAAOC,GAAA,CAACL,OAAO,CAACE,QAAQ,EAAA;AAACE,MAAAA,KAAK,EAAEA,KAAK;AAAAD,MAAAA,QAAA,EAAGA;AAAQ,KAAA,CAAoB;GACrE;AAED,EAAA,IAAMG,cAAc,GAAG,SAAjBA,cAAcA,GAAG;AACrB,IAAA,IAAMC,OAAO,GAAGC,UAAU,CAACR,OAAO,CAAC;IACnC,IAAIO,OAAO,KAAK,IAAI,EAAE;AACpB,MAAA,MAAM,IAAIE,KAAK,CACb,4EAA4E,CAC7E;AACH;AACA,IAAA,OAAOF,OAAO;GACf;AAED,EAAA,OAAO,CAACL,QAAQ,EAAEI,cAAc,CAAU;AAC5C;;;;"}

package/dist/react/hooks/useOpenCloseState.d.ts

@@ -0,0 +1 @@
+export declare const useOpenCloseState: (initialState?: boolean) => readonly [boolean, () => void, () => void];

package/dist/react/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./hooks/useOpenCloseState";
+export * from "./utils/createSafeContext";

package/dist/react/utils/createSafeContext.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from "react";
+type ProviderProps<Value> = {
+    children: ReactNode;
+    value: Value;
+};
+export declare const createSafeContext: <Value>(defaultValue?: Value) => readonly [({ children, value }: ProviderProps<Value>) => import("react/jsx-runtime").JSX.Element, () => Value & ({} | undefined)];
+export {};

package/dist/utils/EarlyReturn.d.ts

@@ -0,0 +1,8 @@
+type Callback<T> = (...params: unknown[]) => T;
+export declare class EarlyReturn<T> {
+    returnValue: T | undefined;
+    case(condition: boolean, func: Callback<T>): EarlyReturn<T>;
+    default(func: Callback<T>): T;
+    isAlreadyReturned<T>(returnValue: T | undefined): returnValue is T & ({} | null);
+}
+export {};

package/dist/utils/EarlyReturn.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from "./EarlyReturn";

package/package.json

@@ -1,19 +1,9 @@
 {
   "name": "dogu-utils",
-  "version": "0.0.1",
-  "description": "A utility library for TypeScript, JavaScript",
-  "type": "module",
+  "version": "0.0.3",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "rollup -c",
-    "watch": "rollup -cw"
-  },
-  "keywords": [],
-  "author": "Jeon Jaewon <wksk3249@gmail.com>",
-  "repository": "https://github.com/JeonJaewon/dogu-utils.git",
-  "license": "ISC",
+  "type": "module",
   "devDependencies": {
     "@babel/core": "^7.24.4",
     "@babel/preset-env": "^7.24.4",
@@ -23,12 +13,14 @@
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/react": "^18.2.74",
     "@types/react-dom": "^18.2.24",
-    "eslint": "^9.0.0",
-    "prettier": "^3.2.5",
-    "tslib": "^2.6.2",
-    "typescript": "^5.4.4"
+    "vitest": "^2.1.5"
   },
   "peerDependencies": {
     "react": "^18.2.0"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "watch": "rollup -cw",
+    "test": "vitest"
   }
-}
+}

package/rollup.config.js

@@ -1,12 +1,12 @@
-import babel from "@rollup/plugin-babel";
-import typescript from "@rollup/plugin-typescript";
+import babel from "@rollup/plugin-babel"
+import typescript from "@rollup/plugin-typescript"
 
 export default {
   input: "./src/index.ts",
   output: {
     file: "./dist/index.js",
     format: "es",
-    sourcemap: true,
+    sourcemap: true
   },
   plugins: [
     babel({
@@ -14,10 +14,10 @@ export default {
       presets: [
         "@babel/preset-env",
         "@babel/preset-react",
-        "@babel/preset-typescript",
+        "@babel/preset-typescript"
       ],
-      extensions: [".js", ".jsx", ".ts", ".tsx"],
+      extensions: [".js", ".jsx", ".ts", ".tsx"]
     }),
-    typescript(),
-  ],
-};
+    typescript()
+  ]
+}

package/src/utils/EarlyReturn.spec.ts

@@ -0,0 +1,36 @@
+import { describe, it, expect } from "vitest"
+import { EarlyReturn } from "./EarlyReturn"
+
+describe("EarlyReturn", () => {
+  it("should return value when condition is true", () => {
+    const earlyReturn = new EarlyReturn<number>()
+    const result = earlyReturn.case(true, () => 42).default(() => 0)
+    expect(result).toBe(42)
+  })
+
+  it("should not override return value if already set", () => {
+    const earlyReturn = new EarlyReturn<number>()
+    const result = earlyReturn
+      .case(true, () => 42)
+      .case(true, () => 24)
+      .default(() => 0)
+    expect(result).toBe(42)
+  })
+
+  it("should return default value if no case matches", () => {
+    const earlyReturn = new EarlyReturn<number>()
+    const result = earlyReturn
+      .case(false, () => 42)
+      .case(false, () => 24)
+      .default(() => 0)
+    expect(result).toBe(0)
+  })
+
+  it("should return undefined if no case matches and no default is provided", () => {
+    const earlyReturn = new EarlyReturn<number>()
+    const result = earlyReturn
+      .case(false, () => 42)
+      .case(false, () => 24).returnValue
+    expect(result).toBeUndefined()
+  })
+})

package/src/utils/EarlyReturn.ts

@@ -0,0 +1,29 @@
+type Callback<T> = (...params: unknown[]) => T
+
+export class EarlyReturn<T> {
+  returnValue: T | undefined
+
+  case(condition: boolean, func: Callback<T>): EarlyReturn<T> {
+    if (this.isAlreadyReturned(this.returnValue)) {
+      return this
+    }
+
+    if (condition) {
+      this.returnValue = func()
+      return this
+    }
+
+    return this
+  }
+
+  default(func: Callback<T>): T {
+    if (this.isAlreadyReturned(this.returnValue)) {
+      return this.returnValue
+    }
+    return func()
+  }
+
+  isAlreadyReturned<T>(returnValue: T | undefined) {
+    return returnValue !== undefined
+  }
+}

package/src/utils/index.ts

@@ -0,0 +1 @@
+export * from "./EarlyReturn"

package/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vitest/config"
+
+export default defineConfig({
+  test: {
+    include: ["**/*.spec.ts?(x)"]
+  }
+})

package/.eslintrc

@@ -1,13 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "node": true
-  },
-  "extends": ["eslint:recommended"],
-  "parserOptions": {
-    "ecmaVersion": 2021
-  },
-  "rules": {
-    // Add your custom rules here
-  }
-}

package/.prettierrc

@@ -1,10 +0,0 @@
-{
-  "printWidth": 80,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": false,
-  "singleQuote": false,
-  "trailingComma": "none",
-  "bracketSpacing": true,
-  "arrowParens": "avoid"
-}

package/src/Hello.tsx

@@ -1,6 +0,0 @@
-import React from "react"
-import ReactDOM from "react-dom"
-
-export const Hello = () => {
-  return <div>Hello World!</div>
-}