@jsonkit/db 3.0.1 → 3.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonkit/db",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Simple database using JSON and your local filesystem",
   "license": "MIT",
   "author": "taennan <taennan.dev@protonmail.com>",
@@ -15,28 +15,29 @@
     "filesystem"
   ],
   "type": "module",
-  "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
+  "main": "dist/cjs/index.cjs",
+  "types": "dist/index.d.ts",
   "exports": {
+    "./package.json": "./package.json",
     ".": {
       "import": {
-        "types": "./dist/types/index.d.ts",
-        "default": "./dist/esm/index.js"
+        "default": "./dist/esm/index.js",
+        "types": "./dist/index.d.ts"
       },
       "require": {
-        "types": "./dist/types/index.d.ts",
-        "default": "./dist/cjs/index.cjs"
+        "default": "./dist/cjs/index.cjs",
+        "types": "./dist/index.d.ts"
       }
     }
   },
   "scripts": {
-    "build": "npm run clean && npm run build:bundle && npm run build:types",
+    "build": "npm run clean && npm run build:bundle",
     "clean": "rm -rf dist",
-    "check": "tsc --noEmit",
-    "build:bundle": "npx rollup -c --bundleConfigAsCjs",
-    "build:types": "tsc -p tsconfig.json",
-    "fmt": "prettier --write .",
+    "build:bundle": "npx rollup -c",
+    "fix": "npm run fix:types && npm run fix:format",
+    "fix:types": "tsc --noEmit",
+    "fix:format": "prettier --write . --config ../../.prettierrc --ignore-path ../../.prettierignore",
     "test": "jest"
   },
   "files": [

package/dist/types/common/index.d.ts

@@ -1,2 +0,0 @@
-export * from './multiEntryDb';
-export * from './types';

package/dist/types/common/multiEntryDb.d.ts

@@ -1,19 +0,0 @@
-import type { Identifiable, DeleteManyOutput, PaginationInput, PredicateFn, Promisable } from './types';
-export declare abstract class MultiEntryDb<T extends Identifiable> {
-    abstract create(entry: T): Promise<T>;
-    abstract getById(id: T['id']): Promise<T | null>;
-    abstract update(id: T['id'], updater: (entry: T) => Promisable<Partial<T>>): Promise<T>;
-    abstract deleteById(id: T['id']): Promise<boolean>;
-    abstract destroy(): Promise<void>;
-    protected abstract iterEntries(): AsyncIterable<T>;
-    protected abstract iterIds(): AsyncIterable<T['id']>;
-    getByIdOrThrow(id: T['id']): Promise<T>;
-    getWhere(predicate: PredicateFn<T>, pagination?: PaginationInput): Promise<T[]>;
-    getAll(): Promise<T[]>;
-    getAllIds(): Promise<T['id'][]>;
-    deleteByIds(ids: T['id'][]): Promise<DeleteManyOutput>;
-    deleteWhere(predicate: PredicateFn<T>): Promise<DeleteManyOutput>;
-    exists(id: T['id']): Promise<boolean>;
-    countAll(): Promise<number>;
-    countWhere(predicate: PredicateFn<T>, pagination?: PaginationInput): Promise<number>;
-}

package/dist/types/common/types.d.ts

@@ -1,38 +0,0 @@
-export type Identifiable = {
-    id: Id;
-};
-export type Id = string;
-export type Promisable<T> = T | Promise<T>;
-export type PaginationInput = {
-    take: number;
-    page: number;
-    skip?: number | undefined | null;
-};
-export type DeleteManyOutput = {
-    deletedIds: Id[];
-    ignoredIds: Id[];
-};
-export type PredicateFn<T extends Identifiable> = (entry: T) => boolean;
-export type JsonEntryParser<T> = {
-    parse: (text: string) => T;
-};
-export type MultiEntryFileDbOptions<T> = {
-    noPathlikeIds?: boolean;
-    parser?: JsonEntryParser<T>;
-};
-export type FileMeta = {
-    path: string;
-    size: number;
-    created: Date;
-    modified: Date;
-    accessed: Date;
-} & ({
-    type: FileType.File;
-} | {
-    type: FileType.Directory;
-    children: FileMeta[];
-});
-export declare enum FileType {
-    File = "file",
-    Directory = "directory"
-}

package/dist/types/file/__tests__/multiEntryFileDb.test.d.ts

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

package/dist/types/file/__tests__/singleEntryFileDb.test.d.ts

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

package/dist/types/file/files.d.ts

@@ -1,44 +0,0 @@
-import type { FileMeta } from '../common/types';
-type ListOptions = {
-    depth?: number;
-    stripBasepath?: string;
-};
-type DeleteOptions = {
-    force?: boolean;
-    recursive?: boolean;
-};
-type WriteOptions = {
-    encoding?: BufferEncoding;
-};
-type ReadOptions = {
-    encoding?: BufferEncoding;
-    lines?: number;
-};
-type CopyOptions = {
-    recursive?: boolean;
-    overwrite?: boolean;
-};
-export declare class Files {
-    move(oldPath: string, newPath: string): Promise<void>;
-    copy(sourcePath: string, destinationPath: string, options?: CopyOptions): Promise<void>;
-    copyRecursive(sourcePath: string, destinationPath: string): Promise<void>;
-    mkdir(filepath: string): Promise<void>;
-    protected mkdirUnsafe(filepath: string): Promise<void>;
-    write(filepath: string, content: string, options?: WriteOptions): Promise<void>;
-    touch(filepath: string): Promise<void>;
-    read(filepath: string, options?: ReadOptions): Promise<string>;
-    delete(filepath: string, options?: DeleteOptions): Promise<void>;
-    exists(filepath: string): Promise<boolean>;
-    isDir(filepath: string): Promise<boolean>;
-    isFile(filepath: string): Promise<boolean>;
-    isSymlink(filepath: string): Promise<boolean>;
-    getMeta(filepath: string, options?: ListOptions): Promise<FileMeta>;
-    list(dirpath: string, options?: ListOptions): Promise<string[]>;
-    listRead(dirpath: string, options?: ListOptions): AsyncGenerator<{
-        filepath: string;
-        content: string;
-    }, void, unknown>;
-    protected listRecursive(dirpath: string, maxDepth: number, currentDepth: number, stripBasepath: string | undefined): Promise<string[]>;
-    protected stripBasepath(original: string, pathToStrip: string | undefined): string;
-}
-export {};

package/dist/types/file/multiEntryFileDb.d.ts

@@ -1,20 +0,0 @@
-import { Identifiable, DeleteManyOutput, Promisable, JsonEntryParser, MultiEntryFileDbOptions, MultiEntryDb } from '../common';
-import { Files } from './files';
-export declare class MultiEntryFileDb<T extends Identifiable> extends MultiEntryDb<T> {
-    protected readonly dirpath: string;
-    protected readonly files: Files;
-    protected readonly parser: JsonEntryParser<T>;
-    readonly noPathlikeIds: boolean;
-    constructor(dirpath: string, options?: MultiEntryFileDbOptions<T>);
-    create(entry: T): Promise<T>;
-    getById(id: T['id']): Promise<T | null>;
-    update(id: T['id'], updater: (entry: T) => Promisable<Partial<T>>): Promise<T>;
-    deleteById(id: T['id']): Promise<boolean>;
-    deleteByIds(ids: T['id'][]): Promise<DeleteManyOutput>;
-    destroy(): Promise<void>;
-    protected getFilePath(id: T['id']): string;
-    protected writeEntry(entry: T): Promise<void>;
-    isIdValid(id: T['id']): boolean;
-    protected iterEntries(): AsyncGenerator<T, void, unknown>;
-    protected iterIds(): AsyncGenerator<string, void, unknown>;
-}

package/dist/types/file/singleEntryFileDb.d.ts

@@ -1,13 +0,0 @@
-import { JsonEntryParser, Promisable } from '../common/types';
-import { Files } from './files';
-export declare class SingleEntryFileDb<T> {
-    protected readonly filepath: string;
-    protected readonly parser: JsonEntryParser<T>;
-    protected readonly files: Files;
-    constructor(filepath: string, parser?: JsonEntryParser<T>);
-    path(): string;
-    isInited(): Promise<boolean>;
-    read(): Promise<T>;
-    write(updaterOrEntry: T | ((entry: T) => Promisable<Partial<T>>)): Promise<T>;
-    delete(): Promise<void>;
-}

package/dist/types/index.d.ts

@@ -1,5 +0,0 @@
-export * from './file/multiEntryFileDb';
-export * from './file/singleEntryFileDb';
-export * from './memory/multiEntryMemDb';
-export * from './memory/singleEntryMemDb';
-export * from './common/types';

package/dist/types/memory/__tests__/multiEntryMemDb.test.d.ts

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

package/dist/types/memory/__tests__/singleEntryMemDb.test.d.ts

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

package/dist/types/memory/multiEntryMemDb.d.ts

@@ -1,11 +0,0 @@
-import { Identifiable, Promisable, MultiEntryDb } from '../common';
-export declare class MultiEntryMemDb<T extends Identifiable> extends MultiEntryDb<T> {
-    protected entries: Map<T['id'], T>;
-    create(entry: T): Promise<T>;
-    getById(id: T['id']): Promise<T | null>;
-    update(id: T['id'], updater: (entry: T) => Promisable<Partial<T>>): Promise<T>;
-    deleteById(id: T['id']): Promise<boolean>;
-    destroy(): Promise<void>;
-    protected iterEntries(): AsyncGenerator<T, void, unknown>;
-    protected iterIds(): AsyncGenerator<T["id"], void, unknown>;
-}

package/dist/types/memory/singleEntryMemDb.d.ts

@@ -1,8 +0,0 @@
-export declare class SingleEntryMemDb<T> {
-    protected entry: T | null;
-    constructor(initialEntry?: T | null);
-    isInited(): boolean;
-    read(): T;
-    write(updaterOrEntry: T | ((entry: T) => Partial<T>)): T;
-    delete(): void;
-}