@jsonkit/db 1.0.0 → 2.0.1

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

@@ -0,0 +1,13 @@
+import { JsonEntryParser, Promisable, SingleEntryDb } from '../types';
+import { Files } from './files';
+export declare class SingleEntryFileDb<T> extends SingleEntryDb<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,3 +1,5 @@
-export * from './multiEntryFileDb';
-export * from './singleEntryFileDb';
+export * from './file/multiEntryFileDb';
+export * from './file/singleEntryFileDb';
+export * from './memory/multiEntryMemDb';
+export * from './memory/singleEntryMemDb';
 export * from './types';

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

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

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

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

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

@@ -0,0 +1,19 @@
+import { Identifiable, DeleteManyOutput, Promisable, PredicateFn, MultiEntryDb } from '../types';
+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>;
+    destroy(): Promise<void>;
+    exists(id: T['id']): Promise<boolean>;
+    countAll(): Promise<number>;
+    countWhere(predicate: PredicateFn<T>): Promise<number>;
+    protected iterEntries(): AsyncGenerator<T, void, unknown>;
+}

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

@@ -0,0 +1,9 @@
+import { Promisable, SingleEntryDb } from '../types';
+export declare class SingleEntryMemDb<T> extends SingleEntryDb<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>;
+}

package/dist/types/types.d.ts

@@ -8,6 +8,13 @@ export type DeleteManyOutput = {
     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;
@@ -24,3 +31,25 @@ 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>;
+}

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@jsonkit/db",
-  "version": "1.0.0",
+  "version": "2.0.1",
   "description": "Simple database using JSON and your local filesystem",
   "license": "MIT",
   "author": "taennan <taennan.dev@protonmail.com>",
-  "repository": "https://github.com/taennan/jsonkit",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/taennan/jsonkit.git"
+  },
   "keywords": [
     "typescript",
     "json",
@@ -38,8 +41,5 @@
   },
   "files": [
     "dist"
-  ],
-  "dependencies": {
-    "@jsonkit/tools": "file:///Users/taennanrickman/Programming/Projects/@jsonkit/tools"
-  }
+  ]
 }

package/dist/types/singleEntryFileDb.d.ts

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