feat(package): Adds required types, interfaces, and classes.

Author: ryasmi

package-lock.json

@@ -21,7 +21,9 @@
     "lines": 100,
     "check-coverage": true
   },
-  "dependencies": {},
+  "dependencies": {
+    "make-error": "^1.3.0"
+  },
   "devDependencies": {
     "@ht2-labs/typescript-project": "1.0.0",
     "@ht2-labs/semantic-release": "1.0.9",

package.json

@@ -0,0 +1,19 @@
+import CountEntities from './signatures/CountEntities';
+import CreateEntity from './signatures/CreateEntity';
+import GetEntities from './signatures/GetEntities';
+import GetEntity from './signatures/GetEntity';
+import OverwriteEntity from './signatures/OverwriteEntity';
+import PatchEntity from './signatures/PatchEntity';
+import RemoveEntities from './signatures/RemoveEntities';
+import RemoveEntity from './signatures/RemoveEntity';
+
+export default interface Facade<Id, Entity> {
+  readonly getEntity: GetEntity<Id, Entity>;
+  readonly createEntity: CreateEntity<Entity>;
+  readonly overwriteEntity: OverwriteEntity<Id, Entity>;
+  readonly patchEntity: PatchEntity<Id, Entity>;
+  readonly removeEntity: RemoveEntity<Id>;
+  readonly getEntities: GetEntities<Entity>;
+  readonly countEntities: CountEntities<Entity>;
+  readonly removeEntities: RemoveEntities<Entity>;
+}

src/Facade.ts

@@ -0,0 +1,8 @@
+// tslint:disable:no-class
+import { BaseError } from 'make-error';
+
+export default class ConflictingEntityError<Id> extends BaseError {
+  constructor(public entityName: string, public entityId: Id) {
+    super();
+  }
+}

src/errors/ConflictingEntityError.ts

@@ -0,0 +1,8 @@
+// tslint:disable:no-class
+import { BaseError } from 'make-error';
+
+export default class MissingEntityError<Id> extends BaseError {
+  constructor(public entityName: string, public entityId: Id) {
+    super();
+  }
+}

src/errors/MissingEntityError.ts

@@ -0,0 +1,13 @@
+import Filter from '../types/Filter';
+
+export interface Opts<Entity> {
+  readonly filter: Filter<Entity>;
+}
+
+export interface Result {
+  readonly count: number;
+}
+
+export type Signature<Entity> = (opts: Opts<Entity>) => Promise<Result>;
+
+export default Signature;

src/signatures/CountEntities.ts

@@ -0,0 +1,11 @@
+export interface Opts<Entity> {
+  readonly entity: Entity;
+}
+
+export interface Result<Entity> {
+  readonly entity: Entity;
+}
+
+export type Signature<Entity> = (opts: Opts<Entity>) => Promise<Result<Entity>>;
+
+export default Signature;

src/signatures/CreateEntity.ts

@@ -0,0 +1,20 @@
+import Cursor from '../types/Cursor';
+import Filter from '../types/Filter';
+import Pagination from '../types/Pagination';
+import Sort from '../types/Sort';
+
+export interface Opts<Entity> {
+  readonly filter: Filter<Entity>;
+  readonly sort: Sort<Entity>;
+  readonly pagination: Pagination;
+}
+
+export interface Result<Entity> {
+  readonly entities: Entity[];
+  readonly nextCursor: Cursor;
+  readonly previousCursor: Cursor;
+}
+
+export type Signature<Entity> = (opts: Opts<Entity>) => Promise<Result<Entity>>;
+
+export default Signature;

src/signatures/GetEntities.ts

@@ -0,0 +1,11 @@
+export interface Opts<Id> {
+  readonly id: Id;
+}
+
+export interface Result<Entity> {
+  readonly entity: Entity;
+}
+
+export type Signature<Id, Entity> = (opts: Opts<Id>) => Promise<Result<Entity>>;
+
+export default Signature;

src/signatures/GetEntity.ts

@@ -0,0 +1,12 @@
+export interface Opts<Id, Entity> {
+  readonly id: Id;
+  readonly entity: Entity;
+}
+
+export interface Result<Entity> {
+  readonly entity: Entity;
+}
+
+export type Signature<Id, Entity> = (opts: Opts<Id, Entity>) => Promise<Result<Entity>>;
+
+export default Signature;

src/signatures/OverwriteEntity.ts

@@ -0,0 +1,12 @@
+export interface Opts<Id, Entity> {
+  readonly id: Id;
+  readonly patch: Partial<Entity>;
+}
+
+export interface Result<Entity> {
+  readonly entity: Entity;
+}
+
+export type Signature<Id, Entity> = (opts: Opts<Id, Entity>) => Promise<Result<Entity>>;
+
+export default Signature;

src/signatures/PatchEntity.ts

@@ -0,0 +1,11 @@
+import Filter from '../types/Filter';
+
+export interface Opts<Entity> {
+  readonly filter: Filter<Entity>;
+}
+
+export type Result = void;
+
+export type Signature<Entity> = (opts: Opts<Entity>) => Promise<Result>;
+
+export default Signature;

src/signatures/RemoveEntities.ts

@@ -0,0 +1,9 @@
+export interface Opts<Id> {
+  readonly id: Id;
+}
+
+export type Result = void;
+
+export type Signature<Id> = (opts: Opts<Id>) => Promise<Result>;
+
+export default Signature;

src/signatures/RemoveEntity.ts

@@ -0,0 +1,3 @@
+type Cursor = string | undefined;
+
+export default Cursor;

src/types/Cursor.ts

@@ -0,0 +1,36 @@
+export type GreaterFilter<Prop> = { readonly $gt: Prop } | { readonly $gte: Prop };
+export type LesserFilter<Prop> = { readonly $lt: Prop } | { readonly $lte: Prop };
+export type InFilter<Prop> = { readonly $in: Prop[] } | { readonly $nin: Prop[] };
+export type EqualityFilter<Prop> = { readonly $eq: Prop } | { readonly $ne: Prop };
+
+export type PropFilter<Prop> = (
+  GreaterFilter<Prop> |
+  LesserFilter<Prop> |
+  InFilter<Prop> |
+  EqualityFilter<Prop>
+);
+
+export type EntityFilter<Entity> = {
+  readonly [P in keyof Entity]?: Entity[P] | PropFilter<Entity[P]>;
+};
+
+export interface AndFilter<Entity> {
+  readonly $and: Filter<Entity>[];
+}
+
+export interface OrFilter<Entity> {
+  readonly $or: Filter<Entity>[];
+}
+
+export interface NotFilter<Entity> {
+  readonly $not: Filter<Entity>[];
+}
+
+export type Filter<Entity> = (
+  EntityFilter<Entity> |
+  AndFilter<Entity> |
+  OrFilter<Entity> |
+  NotFilter<Entity>
+);
+
+export default Filter;

src/types/Filter.ts

@@ -0,0 +1,7 @@
+import Cursor from './Cursor';
+
+export default interface Pagination {
+  readonly cursor: Cursor;
+  readonly forward: boolean;
+  readonly limit: number;
+}

src/types/Pagination.ts

@@ -0,0 +1,5 @@
+type Sort<Entity> = {
+  readonly [P in keyof Entity]: boolean | undefined;
+};
+
+export default Sort;