@jsonkit/db 2.0.1 → 3.0.1

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

@@ -0,0 +1,38 @@
+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/files.d.ts

@@ -1,4 +1,4 @@
-import type { FileMeta } from '../types';
+import type { FileMeta } from '../common/types';
 type ListOptions = {
     depth?: number;
     stripBasepath?: string;

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

@@ -1,4 +1,4 @@
-import { Identifiable, DeleteManyOutput, Promisable, PredicateFn, JsonEntryParser, MultiEntryFileDbOptions, MultiEntryDb } from '../types';
+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;
@@ -8,21 +8,13 @@ export declare class MultiEntryFileDb<T extends Identifiable> extends MultiEntry
     constructor(dirpath: string, options?: MultiEntryFileDbOptions<T>);
     create(entry: T): Promise<T>;
     getById(id: T['id']): Promise<T | null>;
-    getByIdOrThrow(id: T['id']): Promise<T>;
-    getWhere(predicate: PredicateFn<T>, max?: number): Promise<T[]>;
-    getAll(whereIds?: T['id'][]): Promise<T[]>;
-    getAllIds(): Promise<T['id'][]>;
     update(id: T['id'], updater: (entry: T) => Promisable<Partial<T>>): Promise<T>;
-    delete(id: T['id']): Promise<boolean>;
+    deleteById(id: T['id']): Promise<boolean>;
     deleteByIds(ids: T['id'][]): Promise<DeleteManyOutput>;
-    deleteWhere(predicate: PredicateFn<T>): Promise<DeleteManyOutput>;
     destroy(): Promise<void>;
-    exists(id: T['id']): Promise<boolean>;
-    countAll(): Promise<number>;
-    countWhere(predicate: PredicateFn<T>): Promise<number>;
     protected getFilePath(id: T['id']): string;
-    protected readEntry(id: T['id']): Promise<T | null>;
     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,6 +1,6 @@
-import { JsonEntryParser, Promisable, SingleEntryDb } from '../types';
+import { JsonEntryParser, Promisable } from '../common/types';
 import { Files } from './files';
-export declare class SingleEntryFileDb<T> extends SingleEntryDb<T> {
+export declare class SingleEntryFileDb<T> {
     protected readonly filepath: string;
     protected readonly parser: JsonEntryParser<T>;
     protected readonly files: Files;

package/dist/types/index.d.ts

@@ -2,4 +2,4 @@ export * from './file/multiEntryFileDb';
 export * from './file/singleEntryFileDb';
 export * from './memory/multiEntryMemDb';
 export * from './memory/singleEntryMemDb';
-export * from './types';
+export * from './common/types';

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

@@ -1,19 +1,11 @@
-import { Identifiable, DeleteManyOutput, Promisable, PredicateFn, MultiEntryDb } from '../types';
+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>;
-    getByIdOrThrow(id: T['id']): Promise<T>;
-    getWhere(predicate: PredicateFn<T>, max?: number): Promise<T[]>;
-    getAll(whereIds?: T['id'][]): Promise<T[]>;
-    getAllIds(): Promise<T['id'][]>;
     update(id: T['id'], updater: (entry: T) => Promisable<Partial<T>>): Promise<T>;
-    delete(id: T['id']): Promise<boolean>;
-    deleteByIds(ids: T['id'][]): Promise<DeleteManyOutput>;
-    deleteWhere(predicate: PredicateFn<T>): Promise<DeleteManyOutput>;
+    deleteById(id: T['id']): Promise<boolean>;
     destroy(): Promise<void>;
-    exists(id: T['id']): Promise<boolean>;
-    countAll(): Promise<number>;
-    countWhere(predicate: PredicateFn<T>): Promise<number>;
     protected iterEntries(): AsyncGenerator<T, void, unknown>;
+    protected iterIds(): AsyncGenerator<T["id"], void, unknown>;
 }

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

@@ -1,9 +1,8 @@
-import { Promisable, SingleEntryDb } from '../types';
-export declare class SingleEntryMemDb<T> extends SingleEntryDb<T> {
+export declare class SingleEntryMemDb<T> {
     protected entry: T | null;
     constructor(initialEntry?: T | null);
-    isInited(): Promise<boolean>;
-    read(): Promise<T & {}>;
-    write(updaterOrEntry: T | ((entry: T) => Promisable<Partial<T>>)): Promise<T>;
-    delete(): Promise<void>;
+    isInited(): boolean;
+    read(): T;
+    write(updaterOrEntry: T | ((entry: T) => Partial<T>)): T;
+    delete(): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonkit/db",
-  "version": "2.0.1",
+  "version": "3.0.1",
   "description": "Simple database using JSON and your local filesystem",
   "license": "MIT",
   "author": "taennan <taennan.dev@protonmail.com>",

package/dist/types/types.d.ts

@@ -1,55 +0,0 @@
-export type Identifiable = {
-    id: Id;
-};
-export type Id = string;
-export type Promisable<T> = T | Promise<T>;
-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"
-}
-export declare abstract class SingleEntryDb<T> {
-    abstract isInited(): Promise<boolean>;
-    abstract read(): Promise<T>;
-    abstract write(updaterOrEntry: T | ((entry: T) => Promisable<Partial<T>>)): Promise<T>;
-    abstract delete(): Promise<void>;
-}
-export declare abstract class MultiEntryDb<T extends Identifiable> {
-    abstract create(entry: T): Promise<T>;
-    abstract getById(id: T['id']): Promise<T | null>;
-    abstract getByIdOrThrow(id: T['id']): Promise<T>;
-    abstract getWhere(predicate: PredicateFn<T>, max?: number): Promise<T[]>;
-    abstract getAll(whereIds?: T['id'][]): Promise<T[]>;
-    abstract getAllIds(): Promise<T['id'][]>;
-    abstract update(id: T['id'], updater: (entry: T) => Promisable<Partial<T>>): Promise<T>;
-    abstract delete(id: T['id']): Promise<boolean>;
-    abstract deleteByIds(ids: T['id'][]): Promise<DeleteManyOutput>;
-    abstract deleteWhere(predicate: PredicateFn<T>): Promise<DeleteManyOutput>;
-    abstract destroy(): Promise<void>;
-    abstract exists(id: T['id']): Promise<boolean>;
-    abstract countAll(): Promise<number>;
-    abstract countWhere(predicate: PredicateFn<T>): Promise<number>;
-}