shadowly 0.0.0 → 1.0.3

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2025 Pro203S
-
-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.
-
+Copyright 2025 Pro203S
+
+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,4 +1,166 @@
 # Shadowly
 
-Json 기반 데이터베이스  
+TypeScript로 만든 체이닝 JSON 데이터베이스 모듈  
 
+## 시작하기
+
+- 패키지 설치
+> npm i shadowly
+
+## 사용법
+
+### 새 JSON 만들기
+
+`generateNewJson` 함수로 JSON을 새로 만들 수 있습니다.  
+|파라메터|타입|설명|
+|------|--------|-------|
+|path|string|만들 파일 경로|
+|isArray|boolean?|true면 배열 형식으로 생성|
+
+```typescript
+import Shadowly from 'shadowly';
+
+// example.json을 Object 형식으로 새로 만듭니다. (파일 내용: {})
+Shadowly.generateNewJson("./object.json");
+
+// array.json을 Array 형식으로 새로 만듭니다. (파일 내용: [])
+Shadowly.generateNewJson("./array.json", true);
+```
+
+### Shadowly 인스턴스 만들기
+
+`new Shadowly()`로 Shadowly의 인스턴스를 새로 만들 수 있습니다. 
+|파라메터|타입|설명|
+|------|--------|-------|
+|path|string|JSON 파일 경로|
+
+```typescript
+import Shadowly from 'shadowly';
+
+// object.json을 읽어들여 Shadowly의 인스턴스를 새로 만듭니다.
+new Shadowly("./object.json");
+
+// JSON의 타입 정의를 할 수 있습니다.
+new Shadowly<typeof import("./array.json")>("./array.json");
+```
+
+### JSON의 값 가져오기
+
+`get` 함수는 특정 키로 이동합니다.
+|파라메터|타입|설명|
+|------|--------|-------|
+|key|string or number|키 이름입니다.|
+
+```typescript
+import Shadowly from 'shadowly';
+
+// key -> key2로 이동합니다.
+new Shadowly("./object.json")
+    .get("key")
+    .get("key2");
+```
+
+`value` 함수는 이동한 키의 값을 가져옵니다.
+
+```typescript
+import Shadowly from 'shadowly';
+
+// key의 값을 가져옵니다.
+new Shadowly("./object.json")
+    .get("key")
+    .value();
+```
+
+### JSON에 값 쓰기
+
+`set` 함수는 특정 키에 씁니다.
+|파라메터|타입|설명|
+|------|--------|-------|
+|value|any|쓸 값입니다.|
+
+```typescript
+import Shadowly from 'shadowly';
+
+// key 안에 있는 key2에 value2를 씁니다.
+new Shadowly("./object.json")
+    .get("key")
+    .get("key2")
+    .set("value2");
+
+/*
+결과:
+{
+    "key": {
+        "key2": "value2"
+    }
+}
+*/
+```
+
+`remove` 함수는 특정 키를 지웁니다.
+|파라메터|타입|설명|
+|------|--------|-------|
+|key|string or number|키 이름입니다.|
+
+```typescript
+import Shadowly from 'shadowly';
+
+// key 안에 있는 key2를 지웁니다.
+new Shadowly("./object.json")
+    .get("key")
+    .remove("key2");
+
+/*
+결과:
+{
+    "key": {}
+}
+*/
+```
+
+### 그 외
+
+`back` 함수는 한 번 뒤로 갑니다.
+
+```typescript
+import Shadowly from 'shadowly';
+
+// key 안에 있는 값을 가져옵니다.
+// key에서 key2로 이동 후 뒤로가기 한 다음 값 가져오기
+new Shadowly("./object.json")
+    .get("key")
+    .get("key2")
+    .back()
+    .value();
+```
+
+`up` 함수는 여러 번 뒤로 갑니다.
+|파라메터|타입|설명|
+|------|--------|-------|
+|steps|number?|뒤로 갈 횟수입니다.|
+
+```typescript
+import Shadowly from 'shadowly';
+
+// JSON 데이터를 가져옵니다.
+// key에서 key2로 이동 후 뒤로 2번 이동 한 다음 값 가져오기
+new Shadowly("./object.json")
+    .get("key")
+    .get("key2")
+    .up(2)
+    .value();
+```
+
+`root` 함수는 루트로 이동합니다.
+
+```typescript
+import Shadowly from 'shadowly';
+
+// JSON 데이터를 가져옵니다.
+// key에서 key2로 이동 후 루트로 이동 한 다음 값 가져오기
+new Shadowly("./object.json")
+    .get("key")
+    .get("key2")
+    .root()
+    .value();
+```

package/package.json

@@ -1,11 +1,12 @@
 {
     "name": "shadowly",
-    "version": "0.0.0",
+    "version": "1.0.3",
     "description": "TypeScript JSON Database",
     "keywords": [
         "database",
         "json",
-        "typescript"
+        "typescript",
+        "cli"
     ],
     "homepage": "https://github.com/Pro203S/Shadowly#readme",
     "bugs": {
@@ -17,8 +18,8 @@
     },
     "license": "MIT",
     "author": "Pro203S",
-    "type": "module",
-    "main": "src/index.ts",
+    "type": "commonjs",
+    "main": "./dist/index.js",
     "scripts": {
         "build": "tsc"
     },
@@ -28,4 +29,4 @@
     "peerDependencies": {
         "typescript": "^5"
     }
-}
+}

package/tsconfig.json

@@ -1,29 +1,13 @@
 {
   "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
+    "target": "ES2022",
+    "module": "CommonJS",
+    "rootDir": "src",
+    "outDir": "dist",
+    "declaration": true,
     "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  },
+  "exclude": ["tests/", "dist/"]
 }

package/bun.lock

@@ -1,26 +0,0 @@
-{
-  "lockfileVersion": 1,
-  "configVersion": 1,
-  "workspaces": {
-    "": {
-      "name": "shadowly",
-      "devDependencies": {
-        "@types/bun": "latest",
-      },
-      "peerDependencies": {
-        "typescript": "^5",
-      },
-    },
-  },
-  "packages": {
-    "@types/bun": ["@types/bun@1.3.6", "", { "dependencies": { "bun-types": "1.3.6" } }, "sha512-uWCv6FO/8LcpREhenN1d1b6fcspAB+cefwD7uti8C8VffIv0Um08TKMn98FynpTiU38+y2dUO55T11NgDt8VAA=="],
-
-    "@types/node": ["@types/node@25.0.10", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-zWW5KPngR/yvakJgGOmZ5vTBemDoSqF3AcV/LrO5u5wTWyEAVVh+IT39G4gtyAkh3CtTZs8aX/yRM82OfzHJRg=="],
-
-    "bun-types": ["bun-types@1.3.6", "", { "dependencies": { "@types/node": "*" } }, "sha512-OlFwHcnNV99r//9v5IIOgQ9Uk37gZqrNMCcqEaExdkVq3Avwqok1bJFmvGMCkCE0FqzdY8VMOZpfpR3lwI+CsQ=="],
-
-    "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
-
-    "undici-types": ["undici-types@7.16.0", "", {}, "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw=="],
-  }
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export class Shadowly {
-    
-}