onecore 0.5.4 → 0.5.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onecore",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "description": "onecore",
   "main": "./lib/index.js",
   "types": "./src/index.ts",

package/src/db.ts

@@ -17,9 +17,9 @@ interface StringMap {
 export interface Executor {
   driver: string;
   param(i: number): string;
-  exec(sql: string, args?: any[], ctx?: Transaction): Promise<number>;
-  execBatch(statements: Statement[], firstSuccess?: boolean, ctx?: Transaction): Promise<number>;
-  query<T>(sql: string, args?: any[], m?: StringMap, bools?: Attribute[], ctx?: Transaction): Promise<T[]>;
+  execute(sql: string, args?: any[], ctx?: any): Promise<number>
+  executeBatch(statements: Statement[], firstSuccess?: boolean, ctx?: any): Promise<number>
+  query<T>(sql: string, args?: any[], m?: StringMap, bools?: Attribute[], ctx?: any): Promise<T[]>
 }
 export interface Transaction extends Executor {
   commit(): Promise<void>
@@ -33,25 +33,25 @@ export interface DB extends Executor {
 export interface ViewRepository<T, ID> {
   metadata?(): Attributes|undefined;
   keys?(): string[];
-  load(id: ID, ctx?: Transaction): Promise<T|null>;
+  load(id: ID, tx?: Transaction): Promise<T | null>;
 }
 export interface SearchRepository<T, F extends Filter> {
-  search(s: F, limit: number, offset?: number|string, fields?: string[], ctx?: Transaction): Promise<SearchResult<T>>;
+  search(s: F, limit: number, offset?: number|string, fields?: string[], tx?: Transaction): Promise<SearchResult<T>>;
 }
 export interface ViewSearchRepository<T, ID, F extends Filter>
   extends ViewRepository<T, ID>, SearchRepository<T, F> {
 }
 export interface GenericRepository<T, ID> extends ViewRepository<T, ID> {
-  create(obj: T, ctx?: Transaction): Promise<number>;
-  update(obj: T, ctx?: Transaction): Promise<number>;
-  patch(obj: Partial<T>, ctx?: Transaction): Promise<number>;
-  delete(id: ID, ctx?: Transaction): Promise<number>;
+  create(obj: T, tx?: Transaction): Promise<number>;
+  update(obj: T, tx?: Transaction): Promise<number>;
+  patch(obj: Partial<T>, tx?: Transaction): Promise<number>;
+  delete(id: ID, tx?: Transaction): Promise<number>;
 }
 export interface CRUDRepository<T, ID> extends ViewRepository<T, ID> {
-  create(obj: T, ctx?: Transaction): Promise<number>;
-  update(obj: T, ctx?: Transaction): Promise<number>;
-  patch(obj: Partial<T>, ctx?: Transaction): Promise<number>;
-  delete(id: ID, ctx?: Transaction): Promise<number>;
+  create(obj: T, tx?: Transaction): Promise<number>;
+  update(obj: T, tx?: Transaction): Promise<number>;
+  patch(obj: Partial<T>, tx?: Transaction): Promise<number>;
+  delete(id: ID, tx?: Transaction): Promise<number>;
 }
 export interface Repository<T, ID, F extends Filter>
   extends GenericRepository<T, ID>, SearchRepository<T, F> {
@@ -59,3 +59,46 @@ export interface Repository<T, ID, F extends Filter>
 export interface GenericSearchRepository<T, ID, F extends Filter>
   extends GenericRepository<T, ID>, SearchRepository<T, F> {
 }
+export interface ApproversRepository {
+  getApprovers(tx?: Transaction): Promise<string[]>
+}
+export interface HistoryRepository<T> {
+  create(id: string, author: string, action: string, data: T, tx?: Transaction): Promise<number>
+}
+
+
+export interface ViewPort<T, ID> {
+  metadata?(): Attributes | undefined;
+  keys?(): string[];
+  load(id: ID, tx?: Transaction): Promise<T | null>;
+}
+export interface SearchPort<T, F extends Filter> {
+  search(s: F, limit: number, offset?: number|string, fields?: string[], tx?: Transaction): Promise<SearchResult<T>>;
+}
+export interface ViewSearchPort<T, ID, F extends Filter>
+  extends ViewPort<T, ID>, SearchPort<T, F> {
+}
+export interface GenericPort<T, ID> extends ViewPort<T, ID> {
+  create(obj: T, tx?: Transaction): Promise<number>;
+  update(obj: T, tx?: Transaction): Promise<number>;
+  patch(obj: Partial<T>, tx?: Transaction): Promise<number>;
+  delete(id: ID, tx?: Transaction): Promise<number>;
+}
+export interface CRUDPort<T, ID> extends ViewPort<T, ID> {
+  create(obj: T, tx?: Transaction): Promise<number>;
+  update(obj: T, tx?: Transaction): Promise<number>;
+  patch(obj: Partial<T>, tx?: Transaction): Promise<number>;
+  delete(id: ID, tx?: Transaction): Promise<number>;
+}
+export interface Port<T, ID, F extends Filter>
+  extends GenericPort<T, ID>, SearchPort<T, F> {
+}
+export interface GenericSearchPort<T, ID, F extends Filter>
+  extends GenericPort<T, ID>, SearchPort<T, F> {
+}
+export interface ApproversPort {
+  getApprovers(tx?: Transaction): Promise<string[]>
+}
+export interface HistoryPort<T> {
+  create(id: string, author: string, action: string, data: T, tx?: Transaction): Promise<number>
+}

package/src/index.ts

@@ -41,11 +41,27 @@ export type Log = (msg: string) => void;
 export type LogFunc = Log;
 
 import { Attributes } from './metadata';
-import { ErrorMessage, Filter, SearchResult } from './model';
+import { Filter, SearchResult } from './model';
 
 export type Search<T, F> = (s: F, limit: number, page?: number | string, fields?: string[]) => Promise<SearchResult<T>>;
 export type SearchFunc<T, F> = Search<T, F>;
 
+export interface Notification {
+  id?: string
+  sender: string
+  receiver: string
+  url?: string
+  message: string
+}
+export interface NotificationPort {
+  push(notification: Notification): Promise<number>
+  pushNotifications(notifications: Notification[]): Promise<number>
+}
+export interface NotificationRepository {
+  push(notification: Notification): Promise<number>
+  pushNotifications(notifications: Notification[]): Promise<number>
+}
+
 export interface KeypairResult {
   rsaEncrypted: string;
   data: {

package/src/model.ts

@@ -20,10 +20,17 @@ export interface ModuleLoader {
   load(): Promise<Module[]>;
 }
 export interface Tracking {
-  createdAt?: Date;
-  createdBy?: string;
-  updatedAt?: Date;
-  updatedBy?: string;
+  createdBy: string
+  createdAt?: Date
+  updatedBy: string
+  updatedAt?: Date
+}
+export interface Approving {
+  submittedBy: string
+  submittedAt?: Date
+  approvedBy?: string
+  approvedAt?: Date
+
 }
 export interface Version {
   version?: number;