@housebookgroup/shared-types 1.0.0

package/dist/authTypes.d.ts

@@ -0,0 +1,8 @@
+export interface SignupData {
+    email: string;
+    password: string;
+    first_name: string;
+    last_name: string;
+    phone: string;
+    userType: "admin" | "owner";
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from 'authTypes';
+export * from 'onboardingTypes';
+export * from 'propertyTypes';
+export * from 'userTypes';

package/dist/onboardingTypes.d.ts

@@ -0,0 +1,28 @@
+export interface OwnerData {
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone: string;
+}
+export interface FormData {
+    propertyName: string;
+    propertyDescription: string;
+    address: string;
+    floorPlans: File[];
+    buildingPlans: File[];
+}
+export interface AssetFeature {
+    name: string;
+    value: string;
+}
+export interface AssetInt {
+    typeId: string;
+    name: string;
+    description: string;
+    features: AssetFeature[];
+}
+export interface SpaceInt {
+    type: string;
+    name: string;
+    assets: AssetInt[];
+}

package/dist/propertyTypes.d.ts

@@ -0,0 +1,27 @@
+export type Property = {
+    property_id: string;
+    address: string;
+    description: string;
+    pin: string;
+    name: string;
+    type: string;
+    status: string;
+    lastUpdated: string;
+    completionStatus: number;
+    totalFloorArea?: number;
+    spaces?: Space[];
+    images?: string[];
+    created_at: string;
+    splash_image?: string;
+};
+export type Space = {
+    space_id: string;
+    name: string;
+    type: string;
+    assets: Asset[];
+};
+export type Asset = {
+    asset_id: string;
+    type: string;
+    description: string;
+};

package/dist/userTypes.d.ts

@@ -0,0 +1,6 @@
+export type Owner = {
+    owner_id: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@housebookgroup/shared-types",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "private": false,
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SSIEK-unimelb/housebook-shared-types.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/SSIEK-unimelb/housebook-shared-types/issues"
+  },
+  "homepage": "https://github.com/SSIEK-unimelb/housebook-shared-types#readme"
+}

package/src/authTypes.ts

@@ -0,0 +1,8 @@
+export interface SignupData {
+  email: string;
+  password: string;
+  first_name: string;
+  last_name: string;
+  phone: string;
+  userType: "admin" | "owner";
+};

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from 'authTypes';
+export * from 'onboardingTypes';
+export * from 'propertyTypes';
+export * from 'userTypes';

package/src/onboardingTypes.ts

@@ -0,0 +1,36 @@
+export interface OwnerData {
+  firstName: string,
+  lastName: string,
+  email: string,
+  phone: string
+}
+
+// Setting what FormData looks like
+export interface FormData {
+    // Basic Information
+    propertyName: string,
+    propertyDescription: string,
+    address: string,
+    // Plans & Documents
+    floorPlans: File[],
+    buildingPlans: File[]
+}
+
+// Setting what an Asset or Space looks like
+export interface AssetFeature {
+  name: string;
+  value: string;
+}
+
+export interface AssetInt {
+  typeId: string;
+  name: string;  // Only to display in the frontend, name is not stored in database
+  description: string; // description is stored in database
+  features: AssetFeature[];
+}
+
+export interface SpaceInt {
+  type: string;
+  name: string;
+  assets: AssetInt[];
+}

package/src/propertyTypes.ts

@@ -0,0 +1,29 @@
+export type Property = { 
+  property_id: string;
+  address: string; 
+  description: string; 
+  pin: string; 
+  name: string; 
+  type: string; 
+  status: string; 
+  lastUpdated: string; 
+  completionStatus: number; 
+  totalFloorArea?: number;
+  spaces?: Space[];
+  images?: string[];
+  created_at: string;
+  splash_image?: string;
+};
+
+export type Space = {
+  space_id: string;
+  name: string;
+  type: string;
+  assets: Asset[];
+};
+
+export type Asset = {
+  asset_id: string;
+  type: string;
+  description: string;
+};

package/src/userTypes.ts

@@ -0,0 +1,6 @@
+export type Owner = {
+  owner_id: string;
+  first_name: string;
+  last_name: string;
+  email: string;
+};

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "./dist",
+    "strict": true,
+    "module": "ESNext",
+    "target": "ESNext"
+  },
+  "include": ["src"]
+}