common-types npm local module

Author: Resul Avan

common-types/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "common-types",
+  "version": "1.0.0",
+  "description": "Common types between backend and frontend",
+  "main": "./lib/cjs/index.js",
+  "typings": "./lib/cjs/index.d.ts",
+  "scripts": {
+    "prebuild": "npm run lint && rm -rf ./lib",
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
+    "lint": "tslint --project tsconfig.json",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "resul avan <[email protected]>",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/pluralize": "0.0.29",
+    "prettier": "^2.0.5",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.9.7"
+  }
+}

common-types/src/index.ts

@@ -0,0 +1,196 @@
+export interface Image {
+  src: string;
+  alt: string;
+  name?: string;
+  default?: boolean;
+}
+
+export enum ProviderType {
+  PASSWORD = "password",
+  GOOGLE = "google.com",
+  TWITTER = "twitter.com",
+  FACEBOOK = "facebook.com",
+}
+
+export interface ProviderData {
+  providerType: ProviderType,
+  displayName?: string,
+  email?: string,
+  phoneNumber?: string,
+  photoURL?: string,
+  uid?: string
+}
+
+export interface AuthUser {
+  name: string;
+  email?: string;
+  profilePhoto?: Image;
+  userId: string;
+  username: string;
+  verified: boolean;
+  providers: ProviderData[];
+}
+
+export enum FirebaseClaimKey {
+  USER_ID = "user_id",
+  USERNAME = "username",
+  NAME = "name",
+  EMAIL = "email",
+  EMAIL_VERIFIED = "email_verified",
+  PICTURE = "picture",
+  FIREBASE = "firebase",
+}
+
+export interface FirebaseClaims {
+  [FirebaseClaimKey.USERNAME]: string;
+}
+
+export const ApiConfig = {
+  healthy: "/healthy",
+  auth: {
+    verify: "/auth/verify",
+    claims: "/auth/claims",
+  },
+  notification: {
+    notify: {
+      context: "/notification/notify/:notificationId",
+      params: {
+        notificationId: ":notificationId",
+      },
+    },
+  },
+};
+
+export enum ApiErrorCode {
+  INTERNAL_ERROR = "Internal Error",
+  FORBIDDEN = "Forbidden",
+  BAD_REQUEST = "Bad Request",
+}
+
+export enum AppCookie {
+  TOKEN = '__session',
+  REMEMBER_ME = 'rememberMe'
+}
+
+export enum AppHeader {
+  SESSION_ID = 'ns-session-id',
+  REQUEST_ID = 'ns-request-id'
+}
+
+export const AppTokenType = 'Bearer'
+export const AuthHeaderValuePrefix = `${AppTokenType} `
+
+export enum PrivacyType {
+  PRIVATE = 'private',
+  PUBLIC = 'public'
+}
+
+/**
+ * FIRESTORE types
+ */
+export enum FirebaseQueryOperator {
+  LT = "<",
+  LE = "<=",
+  EQ = "==",
+  GE = ">=",
+  GT = ">",
+  IN = "in",
+  ARRAY_CONTAINS = "array-contains",
+  ARRAY_CONTAINS_ANY = "array-contains-any",
+}
+
+export interface WhereClause {
+  field: string;
+  operator: FirebaseQueryOperator;
+  value: any;
+}
+
+export interface OrderBy {
+  field: string,
+  direction: 'asc'|'desc'
+}
+
+export const orderByName: OrderBy = {
+  field: 'name',
+  direction: 'asc'
+}
+
+export enum collection {
+  USER = "user",
+  FOLLOWING = "following",
+  NOTIFICATION = "notification",
+  USER_DEVICE = "userDevice",
+}
+
+export const CollectionField = {
+  BASE: {
+    id: "id",
+    createdAt: "createdAt",
+  },
+  USER: {
+    username: "username",
+    privacy: "privacy",
+    name: "name",
+  },
+  USER_DEVICE: {
+    userId: "userId",
+    deviceToken: "deviceToken",
+  },
+  FOLLOWING: {
+    follower: "follower",
+    following: "following",
+  },
+  NOTIFICATION: {
+    from: "from",
+    to: "to",
+    status: "status",
+  },
+};
+
+export enum PushNotificationType {
+  FOLLOW = "follow",
+}
+
+export enum PushNotificationStatus {
+  NEW = "new",
+  READ = "read",
+  DELETED = "deleted",
+  IGNORED = "ignored",
+}
+
+export interface BaseModel {
+  id?: string
+  createdAt?: Date
+  createdBy?: string
+  updatedAt?: Date
+  updatedBy?: string
+}
+
+export interface User extends BaseModel {
+  username?: string
+  name?: string
+  surname?: string
+  email?: string
+  profilePhoto?: Image
+  coverPhoto?: Image
+  privacy?: PrivacyType
+  followersPrivacy?: PrivacyType
+  followingPrivacy?: PrivacyType
+}
+
+export interface PushNotification extends BaseModel {
+  from: string
+  to: string
+  notificationType: PushNotificationType
+  status: PushNotificationStatus
+}
+
+export interface UserDevice extends BaseModel {
+  userId: string
+  deviceToken: string
+}
+
+export interface Following extends BaseModel {
+  follower: string,
+  following: string,
+}

common-types/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "incremental": true,
+    "target": "ES2015",
+    "module": "ES2020",
+    "declaration": true,
+    "outDir": "./lib",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": [
+    "./src"
+  ]
+}