shadowly 1.2.0 → 1.3.0

package/README.md

@@ -104,6 +104,26 @@ const items = new Shadowly<typeof import("./array.json")>("./array.json")
 const prices = items.map((item) => item.get("price").value());
 ```
 
+배열에서는 `add`, `insert`, `remove`로 값을 수정할 수도 있습니다.
+
+`add` 함수는 배열의 맨 뒤에 값을 추가합니다.
+
+```typescript
+import Shadowly from 'shadowly';
+
+new Shadowly<typeof import("./array.json")>("./array.json")
+    .add({ name: "apple", price: 1000 });
+```
+
+`insert` 함수는 특정 index에 값을 삽입합니다.
+
+```typescript
+import Shadowly from 'shadowly';
+
+new Shadowly<typeof import("./array.json")>("./array.json")
+    .insert(1, { name: "banana", price: 1500 });
+```
+
 ### JSON에 값 쓰기
 
 `set` 함수는 특정 키에 씁니다.
@@ -130,7 +150,7 @@ new Shadowly("./object.json")
 */
 ```
 
-`remove` 함수는 특정 키를 지웁니다.
+`remove` 함수는 특정 키 또는 배열 index를 지웁니다.
 |파라메터|타입|설명|
 |------|--------|-------|
 |key|string or number|키 이름입니다.|
@@ -151,6 +171,14 @@ new Shadowly("./object.json")
 */
 ```
 
+```typescript
+import Shadowly from 'shadowly';
+
+// 배열의 1번 index 요소를 지웁니다.
+new Shadowly<typeof import("./array.json")>("./array.json")
+    .remove(1);
+```
+
 ### 그 외
 
 `back` 함수는 한 번 뒤로 갑니다.

package/dist/index.d.ts

@@ -53,6 +53,19 @@ export default class Shadowly<TRoot, TNode = TRoot> {
      * @returns 찾은 요소들로 이동한 Shadowly 인스턴스 배열
      */
     findAll(predicate: ArrayPredicate<TNode>, thisArg?: any): Shadowly<TRoot, ArrayElement<TNode>>[];
+    /**
+     * 배열의 맨 뒤에 값을 추가합니다.
+     * @param value 추가할 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    add(value: ArrayElement<TNode>): this;
+    /**
+     * 배열의 특정 index에 값을 삽입합니다.
+     * @param index 삽입할 위치
+     * @param value 삽입할 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    insert(index: number, value: ArrayElement<TNode>): this;
     /**
      * 현재 key에 값을 씁니다.
      * @param value 쓸 값
@@ -60,8 +73,8 @@ export default class Shadowly<TRoot, TNode = TRoot> {
      */
     set(value: TNode): this;
     /**
-     * key를 삭제합니다.
-     * @param key 삭제할 key
+     * key 또는 배열 index를 삭제합니다.
+     * @param key 삭제할 key 또는 index
      * @returns 작업 수행 후 Shadowly 인스턴스
      */
     remove<K extends RemoveKey<TNode>>(key: K): this;

package/dist/index.js

@@ -1,39 +1,4 @@
-"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"));
+import * as fs from "node:fs";
 class ShadowlyError extends Error {
     code;
     constructor(code, message) {
@@ -54,7 +19,7 @@ function isValidJson(text) {
         return false;
     }
 }
-class Shadowly {
+export default class Shadowly {
     DB_PATH;
     path;
     content;
@@ -151,6 +116,34 @@ class Shadowly {
         }
         return result;
     }
+    /**
+     * 배열의 맨 뒤에 값을 추가합니다.
+     * @param value 추가할 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    add(value) {
+        if (!Array.isArray(this.content))
+            throw new ShadowlyError("ETYPE", "Current value is not an array.");
+        this.content.push(value);
+        this.persist();
+        return this;
+    }
+    /**
+     * 배열의 특정 index에 값을 삽입합니다.
+     * @param index 삽입할 위치
+     * @param value 삽입할 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    insert(index, value) {
+        if (!Array.isArray(this.content))
+            throw new ShadowlyError("ETYPE", "Current value is not an array.");
+        const array = this.content;
+        if (!Number.isInteger(index) || index < 0 || index > array.length)
+            throw new ShadowlyError("ERANGE", "Index is out of range.");
+        array.splice(index, 0, value);
+        this.persist();
+        return this;
+    }
     /**
      * 현재 key에 값을 씁니다.
      * @param value 쓸 값
@@ -165,8 +158,8 @@ class Shadowly {
         return this;
     }
     /**
-     * key를 삭제합니다.
-     * @param key 삭제할 key
+     * key 또는 배열 index를 삭제합니다.
+     * @param key 삭제할 key 또는 index
      * @returns 작업 수행 후 Shadowly 인스턴스
      */
     remove(key) {
@@ -221,4 +214,3 @@ class Shadowly {
         fs.writeFileSync(r.DB_PATH, JSON.stringify(r.content, null, 2), "utf-8");
     }
 }
-exports.default = Shadowly;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "shadowly",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "TypeScript JSON Database",
     "keywords": [
         "database",
@@ -20,6 +20,14 @@
     "author": "Pro203S",
     "type": "module",
     "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "default": "./dist/index.js"
+        }
+    },
     "scripts": {
         "build": "tsc"
     },

package/src/index.ts

@@ -169,11 +169,11 @@ export default class Shadowly<TRoot, TNode = TRoot> {
      * @param thisArg callback의 this로 사용할 값
      * @returns 찾은 요소들로 이동한 Shadowly 인스턴스 배열
      */
-    findAll(
-        predicate: ArrayPredicate<TNode>,
-        thisArg?: any
-    ): Shadowly<TRoot, ArrayElement<TNode>>[] {
-        if (!Array.isArray(this.content))
+    findAll(
+        predicate: ArrayPredicate<TNode>,
+        thisArg?: any
+    ): Shadowly<TRoot, ArrayElement<TNode>>[] {
+        if (!Array.isArray(this.content))
             throw new ShadowlyError("ETYPE", "Current value is not an array.");
 
         const callback = predicate as (
@@ -193,14 +193,47 @@ export default class Shadowly<TRoot, TNode = TRoot> {
                 this.get(index as GetKey<TNode>) as Shadowly<TRoot, ArrayElement<TNode>>
             );
         }
-
-        return result;
-    }
-
-    /**
-     * 현재 key에 값을 씁니다.
-     * @param value 쓸 값
-     * @returns 작업 수행 후 Shadowly 인스턴스
+
+        return result;
+    }
+
+    /**
+     * 배열의 맨 뒤에 값을 추가합니다.
+     * @param value 추가할 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    add(value: ArrayElement<TNode>): this {
+        if (!Array.isArray(this.content))
+            throw new ShadowlyError("ETYPE", "Current value is not an array.");
+
+        (this.content as ArrayElement<TNode>[]).push(value);
+        this.persist();
+        return this;
+    }
+
+    /**
+     * 배열의 특정 index에 값을 삽입합니다.
+     * @param index 삽입할 위치
+     * @param value 삽입할 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    insert(index: number, value: ArrayElement<TNode>): this {
+        if (!Array.isArray(this.content))
+            throw new ShadowlyError("ETYPE", "Current value is not an array.");
+
+        const array = this.content as ArrayElement<TNode>[];
+        if (!Number.isInteger(index) || index < 0 || index > array.length)
+            throw new ShadowlyError("ERANGE", "Index is out of range.");
+
+        array.splice(index, 0, value);
+        this.persist();
+        return this;
+    }
+
+    /**
+     * 현재 key에 값을 씁니다.
+     * @param value 쓸 값
+     * @returns 작업 수행 후 Shadowly 인스턴스
      */
     set(value: TNode): this {
         this.content = value;
@@ -214,13 +247,13 @@ export default class Shadowly<TRoot, TNode = TRoot> {
     }
 
     /**
-     * key를 삭제합니다.
-     * @param key 삭제할 key
-     * @returns 작업 수행 후 Shadowly 인스턴스
-     */
-    remove<K extends RemoveKey<TNode>>(key: K): this {
-        const cur: any = this.content;
-
+     * key 또는 배열 index를 삭제합니다.
+     * @param key 삭제할 key 또는 index
+     * @returns 작업 수행 후 Shadowly 인스턴스
+     */
+    remove<K extends RemoveKey<TNode>>(key: K): this {
+        const cur: any = this.content;
+
         if (Array.isArray(cur)) {
             const idx = key as unknown as number;
             if (Number.isInteger(idx) && idx >= 0 && idx < cur.length) cur.splice(idx, 1);

package/tsconfig.json

@@ -1,10 +1,11 @@
 {
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "CommonJS",
-    "rootDir": "src",
-    "outDir": "dist",
-    "declaration": true,
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "rootDir": "src",
+    "outDir": "dist",
+    "declaration": true,
     "strict": true,
     "esModuleInterop": true,
     "resolveJsonModule": true,