shadowly 0.0.0 → 1.0.1

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/dist/class.d.ts

@@ -0,0 +1,63 @@
+type GetKey<T> = T extends readonly any[] ? number : T extends object ? keyof T : never;
+type GetValue<T, K> = T extends readonly (infer U)[] ? U : T extends Record<PropertyKey, any> ? (K extends keyof T ? T[K] : never) : never;
+type RemoveKey<T> = T extends readonly any[] ? number : T extends object ? keyof T : never;
+export default class Shadowly<TRoot, TNode = TRoot> {
+    readonly DB_PATH: string;
+    private readonly path;
+    private content;
+    private parent?;
+    private parentKey?;
+    /**
+     * Shadowly의 새 인스턴스를 만듭니다.
+     * @param path JSON 파일 경로
+     */
+    constructor(path: string);
+    /**
+     * 새 JSON을 만듭니다.
+     * @param path JSON 파일 경로
+     * @param isArray true면 []를 쓰고, false면 {}를 씁니다.
+     */
+    static generateNewJson(path: string, isArray?: boolean): void;
+    private static create;
+    /**
+     * key로 이동합니다.
+     * @param key 이동할 키 이름
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    get<K extends GetKey<TNode>>(key: K): Shadowly<TRoot, GetValue<TNode, K>>;
+    /**
+     * 현재 key의 value를 반환합니다.
+     * @returns 현재 key의 value
+     */
+    value(): TNode;
+    /**
+     * 현재 key에 값을 씁니다.
+     * @param value 쓸 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    set(value: TNode): this;
+    /**
+     * key를 삭제합니다.
+     * @param key 삭제할 key
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    remove<K extends RemoveKey<TNode>>(key: K): this;
+    /**
+     * 한 번 뒤로 이동합니다.
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    back(): Shadowly<TRoot, any>;
+    /**
+     * steps만큼 뒤로 이동합니다.
+     * @param steps 이동할 횟수
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    up(steps?: number): Shadowly<TRoot, any>;
+    /**
+     * JSON의 루트로 이동합니다.
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    root(): Shadowly<TRoot, TRoot>;
+    private persist;
+}
+export {};

package/dist/class.js

@@ -0,0 +1,172 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("node:fs"));
+const error_1 = require("./error");
+function isValidJson(text) {
+    if (typeof text !== "string")
+        return false;
+    try {
+        JSON.parse(text);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+class Shadowly {
+    DB_PATH;
+    path;
+    content;
+    parent;
+    parentKey;
+    /**
+     * Shadowly의 새 인스턴스를 만듭니다.
+     * @param path JSON 파일 경로
+     */
+    constructor(path) {
+        this.path = path;
+        this.DB_PATH = path;
+        if (!fs.existsSync(path))
+            throw new error_1.ShadowlyError("ENOTFOUND", path + " not found.");
+        const file = fs.readFileSync(path, "utf-8");
+        if (!isValidJson(file))
+            throw new error_1.ShadowlyError("EINVALID", path + " is not valid.");
+        this.content = JSON.parse(file);
+    }
+    /**
+     * 새 JSON을 만듭니다.
+     * @param path JSON 파일 경로
+     * @param isArray true면 []를 쓰고, false면 {}를 씁니다.
+     */
+    static generateNewJson(path, isArray) {
+        fs.writeFileSync(path, isArray ? "[]" : "{}", "utf-8");
+    }
+    static create(DB_PATH, path, content, parent, parentKey) {
+        const inst = Object.create(Shadowly.prototype);
+        inst.DB_PATH = DB_PATH;
+        inst.path = path;
+        inst.content = content;
+        inst.parent = parent;
+        inst.parentKey = parentKey;
+        return inst;
+    }
+    /**
+     * key로 이동합니다.
+     * @param key 이동할 키 이름
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    get(key) {
+        const nextContent = this.content[key];
+        return Shadowly.create(this.DB_PATH, this.path, nextContent, this, key);
+    }
+    /**
+     * 현재 key의 value를 반환합니다.
+     * @returns 현재 key의 value
+     */
+    value() {
+        return this.content;
+    }
+    /**
+     * 현재 key에 값을 씁니다.
+     * @param value 쓸 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    set(value) {
+        this.content = value;
+        if (this.parent && this.parentKey !== undefined) {
+            this.parent.content[this.parentKey] = value;
+        }
+        this.persist();
+        return this;
+    }
+    /**
+     * key를 삭제합니다.
+     * @param key 삭제할 key
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    remove(key) {
+        const cur = this.content;
+        if (Array.isArray(cur)) {
+            const idx = key;
+            if (Number.isInteger(idx) && idx >= 0 && idx < cur.length)
+                cur.splice(idx, 1);
+        }
+        else if (cur && typeof cur === "object") {
+            delete cur[key];
+        }
+        else {
+            throw new error_1.ShadowlyError("ETYPE", "Current value is not an object/array.");
+        }
+        this.persist();
+        return this;
+    }
+    /**
+     * 한 번 뒤로 이동합니다.
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    back() {
+        return this.parent ?? this;
+    }
+    /**
+     * steps만큼 뒤로 이동합니다.
+     * @param steps 이동할 횟수
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    up(steps = 1) {
+        let cur = this;
+        for (let i = 0; i < steps; i++) {
+            if (!cur.parent)
+                break;
+            cur = cur.parent;
+        }
+        return cur;
+    }
+    /**
+     * JSON의 루트로 이동합니다.
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    root() {
+        let cur = this;
+        while (cur.parent)
+            cur = cur.parent;
+        return cur;
+    }
+    persist() {
+        const r = this.root();
+        fs.writeFileSync(r.DB_PATH, JSON.stringify(r.content, null, 2), "utf-8");
+    }
+}
+exports.default = Shadowly;

package/dist/error.d.ts

@@ -0,0 +1,4 @@
+export declare class ShadowlyError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}

package/dist/error.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShadowlyError = void 0;
+class ShadowlyError extends Error {
+    code;
+    constructor(code, message) {
+        super(code + ": " + message);
+        this.name = "Shadowly";
+        this.code = code;
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+exports.ShadowlyError = ShadowlyError;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import Shadowly from "./class";
+export default Shadowly;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const class_1 = __importDefault(require("./class"));
+exports.default = class_1.default;

package/package.json

@@ -1,11 +1,12 @@
 {
     "name": "shadowly",
-    "version": "0.0.0",
+    "version": "1.0.1",
     "description": "TypeScript JSON Database",
     "keywords": [
         "database",
         "json",
-        "typescript"
+        "typescript",
+        "cli"
     ],
     "homepage": "https://github.com/Pro203S/Shadowly#readme",
     "bugs": {
@@ -18,7 +19,7 @@
     "license": "MIT",
     "author": "Pro203S",
     "type": "module",
-    "main": "src/index.ts",
+    "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 {
-    
-}