heartraite 1.0.1

package/.github/workflows/publish-package.yml

@@ -0,0 +1,34 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Increment version
+        run: node version-bump.js
+
+      - name: Authenticate with npm
+        run: npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
+
+      - name: Build TypeScript
+        run: npm run build
+
+      - name: Publish to npm
+        run: npm publish --access public

package/README.md

@@ -0,0 +1,3 @@
+# heartraite-npm
+
+NPM package containing common functionality for Heartraite

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "heartraite",
+  "version": "1.0.1",
+  "description": "Heartraite npm package for common functionality",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "rootDir": "src",
+  "scripts": {
+    "build": "rm -rf ./dist && tsc",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/agottfredsson/heartraite-npm.git"
+  },
+  "author": "Anton Gottfredsson",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/agottfredsson/heartraite-npm/issues"
+  },
+  "homepage": "https://github.com/agottfredsson/heartraite-npm#readme",
+  "peerDependencies": {
+    "firebase": "^11.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.9.0",
+    "typescript": "^5.6.3",
+    "firebase": "^11.0.1"
+  }
+}

package/src/enum/ai-verification-status.enum.ts

@@ -0,0 +1,6 @@
+export enum AiVerificationStatus {
+  PENDING = "pending",
+  ERROR = "error",
+  SUCCESS = "success",
+  ACTION_REQUIRED = "action required",
+}

package/src/enum/app-route.enum.ts

@@ -0,0 +1,30 @@
+export enum AppRoute {
+  START = "start",
+  LOGIN = "login",
+  REGISTER = "register",
+  DISCOVER = "discover",
+  PROFILE = "profile",
+  MATCH = "match",
+  MESSAGES = "messages",
+  MATCHES = "matches",
+  SETTINGS = "settings",
+  ACOUNT_SETTINGS = "account_settings",
+  MATCH_SETTINGS = "match_settings",
+  MEMBERSHIP = "membership",
+  USER_PROFILE = "user_profile",
+  BLOG = "blog",
+  QUESTIONS = "questions",
+  CHAT = "chat",
+  SUBSCRIPTIONS = "membership",
+  NOTIFICATIONS = "notifications",
+  QUESTION = "question",
+  IMAGES = "images",
+  IMAGES_MODAL = "image_modal",
+  ADVANCED_MATCH = "advanced_match",
+  SUPPORT = "common_questions",
+  IMAGE_MODAL_REGISTRATION = "image_modal_registration",
+  GENERAL = "general",
+  MATCH_SCANNER = "match_scanner",
+  MATCH_CHECK = "match_check",
+  PROFILE_INPUT = "profile_input",
+}

package/src/enum/cloudfunction.enum.ts

@@ -0,0 +1,34 @@
+export enum CloudFunction {
+  CREATE_ASSESSMENT = "assessment/create-assessment",
+  GET_ASSESSMENT = "assessment/get-assessment",
+  GET_ASSESSMENTS = "assessment/get-assessments",
+  CREATE_SUBMISSION = "assessment/create-submission",
+  GET_SUBMISSION = "assessment/get-submission",
+  UPDATE_ANSWER = "assessment/update-answer",
+  SUBMIT_CATEGORY_FEEDBACK = "assessment/submit-category-feedback",
+  AUTHENTICATE_BANKID = "bankid/authenticate",
+  COLLECT_BANKID = "bankid/collect",
+  CREATE_LIKE = "like/create-like",
+  GET_LIKES = "like/get-likes",
+  HANDLE_LIKE_SEEN = "like/handle-like-seen",
+  GET_MATCH = "match/get-match",
+  HANDLE_MATCH_SEEN = "match/handle-match-seen",
+  GET_MATCHES = "match/get-matches",
+  GET_MATCH_CHECK = "match/get-match-check",
+  REMOVE_MATCH = "match/remove-match",
+  GET_MATCHABLE_USER = "match/get-matchable-user",
+  GET_MATCHABLE_USERS = "match/get-matchable-users",
+  SEND_MESSAGE = "message/send-message",
+  GET_MESSAGES = "message/get-messages",
+  CREATE_PLS = "pls/create-pls",
+  UPDATE_QUESTIONS = "rating/update-quesitons",
+  CREATE_REPORT = "report/create-report",
+  ADD_IMAGES = "storage/add-images",
+  GET_PRODUCTS = "stripe/get-products",
+  STRIPE_WEBWOOK = "stripe/webhook",
+  CREATE_BILLING_PORTAL = "stripe/create-billing-portal",
+  CREATE_CHECKOUT_SESSION = "stripe/create-checkout-session",
+  REGISTER_USER = "user/register-user",
+  UPDATE_USER = "user/update-user",
+  GET_CURRENT_USER = "user/get-current-user",
+}

package/src/enum/evaluation.enum.ts

@@ -0,0 +1,6 @@
+export enum FeedbackAgreement {
+  YES = "yes",
+  NO = "no",
+  PARTIAL = "partial",
+  UNKNOWN = "unknown",
+}

package/src/enum/gender.enum.ts

@@ -0,0 +1,4 @@
+export enum Gender {
+  MALE = "male",
+  FEMALE = "female",
+}

package/src/enum/index.ts

@@ -0,0 +1,8 @@
+export * from "./cloudfunction.enum";
+export * from "./like.enum";
+export * from "./match.enum";
+export * from "./app-route.enum";
+export * from "./ai-verification-status.enum";
+export * from "./evaluation.enum";
+export * from "./report.enum";
+export * from "./gender.enum";

package/src/enum/like.enum.ts

@@ -0,0 +1,6 @@
+export enum LikeType {
+  LIKE = "like",
+  DISLIKE = "dislike",
+  PULSE = "pulse",
+  REVERTED = "reverted",
+}

package/src/enum/match.enum.ts

@@ -0,0 +1,6 @@
+export enum AdvancedMatchStatus {
+  INITIAL = "initial",
+  LOADING = "loading",
+  ERROR = "error",
+  SUCCESS = "success",
+}

package/src/enum/report.enum.ts

@@ -0,0 +1,12 @@
+export enum ReportReason {
+  OFFENSIVE_CONTENT = "offensive_content",
+  FAKE_PROFILE = "fake_profile",
+  INAPPROPRIATE_MESSAGES = "inappropriate_messages",
+  UNDER_AGED = "underaged",
+  OTHER = "other",
+}
+
+export enum ReportStatus {
+  UNRESOLVED = "unresolved",
+  RESOLVED = "resolved",
+}

package/src/firebase/function.caller.ts

@@ -0,0 +1,25 @@
+import { Functions, httpsCallable } from "firebase/functions";
+import { CloudFunctionTypes } from "../types";
+
+// Define the type of parameters for the generic function
+interface Params<T extends keyof CloudFunctionTypes> {
+  functionName: T;
+  functions: Functions;
+  payload?: CloudFunctionTypes[T]["payload"];
+}
+
+// Generic function to call any Firebase Cloud Function
+export const callCloudFunction = async <T extends keyof CloudFunctionTypes>({
+  payload,
+  functions,
+  functionName,
+}: Params<T>): Promise<CloudFunctionTypes[T]["response"]> => {
+  const fn = httpsCallable<
+    CloudFunctionTypes[T]["payload"],
+    CloudFunctionTypes[T]["response"]
+  >(functions, functionName);
+
+  const res = payload ? await fn(payload) : await fn();
+
+  return res.data;
+};

package/src/firebase/index.ts

@@ -0,0 +1 @@
+export * from "./function.caller";

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./enum";
+export * from "./firebase";
+export * from "./types";

package/src/types/assessment.types.ts

@@ -0,0 +1,13 @@
+import { Submission } from "./submission.types";
+
+export type Assessment = {
+  id: string;
+  created: string;
+  createdBy: string;
+  intimateTopics: boolean;
+  version: string;
+};
+
+export type FullAssessment = Assessment & {
+  submissions: Submission[];
+};

package/src/types/cloud-function-types.ts

@@ -0,0 +1,203 @@
+import { CloudFunction } from "../enum";
+import {
+  AddImagesRequest,
+  AuthenticateBankIDRequest,
+  CollectBankIDRequest,
+  CreateAssessmentRequest,
+  CreateBillingPortalRequest,
+  CreateCheckoutSessionRequest,
+  CreateLikeRequest,
+  CreatePLSRequest,
+  CreateReportRequest,
+  CreateSubmissionRequest,
+  GetAssessmentRequest,
+  GetMatchableUserRequest,
+  GetMatchCheckRequest,
+  GetMatchesRequest,
+  GetMatchRequest,
+  GetMessagesRequest,
+  GetProductsRequest,
+  GetSubmissionRequest,
+  GetUserRequest,
+  HandleLikeSeenRequest,
+  HandleMatchSeenRequest,
+  RegisterUserRequest,
+  RemoveMatchRequest,
+  SendMessageRequest,
+  SubmitCategoryFeedbackRequest,
+  UpdateAnswerRequest,
+  UpdateQuestionsRequest,
+  UpdateUserRequest,
+} from "./request.types";
+import {
+  AddImagesResponse,
+  AuthenticateBankIDResponse,
+  CollectBankIDResponse,
+  CreateAssessmentResponse,
+  CreateBillingPortalResponse,
+  CreateCheckoutSessionResponse,
+  CreateLikeResponse,
+  CreatePLSResponse,
+  CreateReportResponse,
+  CreateSubmissionResponse,
+  GetAssessmentResponse,
+  GetAssessmentsResponse,
+  GetMatchableUserResponse,
+  GetMatchableUsersResponse,
+  GetMatchCheckResponse,
+  GetMatchesResponse,
+  GetMatchResponse,
+  GetMessagesResponse,
+  GetProductsResponse,
+  GetSubmissionResponse,
+  GetUserResponse,
+  HandleLikeSeenResponse,
+  HandleMatchSeenResponse,
+  RegisterUserResponse,
+  RemoveMatchResponse,
+  SendMessageResponse,
+  SubmitCategoryFeedbackResponse,
+  UpdateAnswerResponse,
+  UpdateQuestionsResponse,
+  UpdateUserResponse,
+} from "./response.types";
+
+// Define a mapping of Cloud Functions to payload and response types
+export type CloudFunctionTypes = {
+  // Assessment
+  [CloudFunction.CREATE_ASSESSMENT]: {
+    payload: CreateAssessmentRequest;
+    response: CreateAssessmentResponse;
+  };
+  [CloudFunction.GET_ASSESSMENT]: {
+    payload: GetAssessmentRequest;
+    response: GetAssessmentResponse;
+  };
+  [CloudFunction.GET_ASSESSMENTS]: {
+    payload?: undefined;
+    response: GetAssessmentsResponse;
+  };
+  // Submission
+  [CloudFunction.CREATE_SUBMISSION]: {
+    payload: CreateSubmissionRequest;
+    response: CreateSubmissionResponse;
+  };
+  [CloudFunction.GET_SUBMISSION]: {
+    payload: GetSubmissionRequest;
+    response: GetSubmissionResponse;
+  };
+  [CloudFunction.UPDATE_ANSWER]: {
+    payload: UpdateAnswerRequest;
+    response: UpdateAnswerResponse;
+  };
+  [CloudFunction.SUBMIT_CATEGORY_FEEDBACK]: {
+    payload: SubmitCategoryFeedbackRequest;
+    response: SubmitCategoryFeedbackResponse;
+  };
+  // BankID
+  [CloudFunction.AUTHENTICATE_BANKID]: {
+    payload: AuthenticateBankIDRequest;
+    response: AuthenticateBankIDResponse;
+  };
+  [CloudFunction.COLLECT_BANKID]: {
+    payload: CollectBankIDRequest;
+    response: CollectBankIDResponse;
+  };
+  // Like
+  [CloudFunction.CREATE_LIKE]: {
+    payload: CreateLikeRequest;
+    response: CreateLikeResponse;
+  };
+  [CloudFunction.GET_LIKES]: {
+    payload: CreateLikeRequest;
+    response: CreateLikeResponse;
+  };
+  [CloudFunction.HANDLE_LIKE_SEEN]: {
+    payload: HandleLikeSeenRequest;
+    response: HandleLikeSeenResponse;
+  };
+  // Match
+  [CloudFunction.GET_MATCH]: {
+    payload: GetMatchRequest;
+    response: GetMatchResponse;
+  };
+  [CloudFunction.HANDLE_MATCH_SEEN]: {
+    payload: HandleMatchSeenRequest;
+    response: HandleMatchSeenResponse;
+  };
+  [CloudFunction.GET_MATCHES]: {
+    payload: GetMatchesRequest;
+    response: GetMatchesResponse;
+  };
+  [CloudFunction.GET_MATCH_CHECK]: {
+    payload: GetMatchCheckRequest;
+    response: GetMatchCheckResponse;
+  };
+  [CloudFunction.REMOVE_MATCH]: {
+    payload: RemoveMatchRequest;
+    response: RemoveMatchResponse;
+  };
+  [CloudFunction.GET_MATCHABLE_USER]: {
+    payload: GetMatchableUserRequest;
+    response: GetMatchableUserResponse;
+  };
+  [CloudFunction.GET_MATCHABLE_USERS]: {
+    payload: GetMatchableUsersResponse;
+    response: GetMatchableUsersResponse;
+  };
+  // Messages
+  [CloudFunction.SEND_MESSAGE]: {
+    payload: SendMessageRequest;
+    response: SendMessageResponse;
+  };
+  [CloudFunction.GET_MESSAGES]: {
+    payload: GetMessagesRequest;
+    response: GetMessagesResponse;
+  };
+  // PLS
+  [CloudFunction.CREATE_PLS]: {
+    payload: CreatePLSRequest;
+    response: CreatePLSResponse;
+  };
+  // Rating
+  [CloudFunction.UPDATE_QUESTIONS]: {
+    payload: UpdateQuestionsRequest;
+    response: UpdateQuestionsResponse;
+  };
+  // Report
+  [CloudFunction.CREATE_REPORT]: {
+    payload: CreateReportRequest;
+    response: CreateReportResponse;
+  };
+  // Storage
+  [CloudFunction.ADD_IMAGES]: {
+    payload: AddImagesRequest;
+    response: AddImagesResponse;
+  };
+  // Stripe
+  [CloudFunction.GET_PRODUCTS]: {
+    payload: GetProductsRequest;
+    response: GetProductsResponse;
+  };
+  [CloudFunction.CREATE_BILLING_PORTAL]: {
+    payload: CreateBillingPortalRequest;
+    response: CreateBillingPortalResponse;
+  };
+  [CloudFunction.CREATE_CHECKOUT_SESSION]: {
+    payload: CreateCheckoutSessionRequest;
+    response: CreateCheckoutSessionResponse;
+  };
+  // User
+  [CloudFunction.REGISTER_USER]: {
+    payload: RegisterUserRequest;
+    response: RegisterUserResponse;
+  };
+  [CloudFunction.UPDATE_USER]: {
+    payload: UpdateUserRequest;
+    response: UpdateUserResponse;
+  };
+  [CloudFunction.GET_CURRENT_USER]: {
+    payload: GetUserRequest;
+    response: GetUserResponse;
+  };
+};

package/src/types/index.ts

@@ -0,0 +1,12 @@
+export * from "./assessment.types";
+export * from "./cloud-function-types";
+export * from "./like.types";
+export * from "./match.types";
+export * from "./message.types";
+export * from "./request.types";
+export * from "./report.types";
+export * from "./response.types";
+export * from "./pls.types";
+export * from "./stripe.types";
+export * from "./submission.types";
+export * from "./user.types";

package/src/types/like.types.ts

@@ -0,0 +1,9 @@
+import { LikeType } from "../enum";
+
+export type Like = {
+  userId: string;
+  thumbnailBlurred?: string;
+  seen: boolean;
+  created: string;
+  type: LikeType;
+};

package/src/types/match.types.ts

@@ -0,0 +1,75 @@
+import { LikeType } from "../enum";
+import { AdvancedMatchStatus } from "../enum/match.enum";
+import { RatedQuestions } from "./rating.types";
+
+export type Match = {
+  id: string;
+  users: Record<string, boolean>;
+  created: string;
+  percentages: RatedQuestions;
+  totalPercentage: number;
+  conversationId: string;
+  advancedMatchStatus: AdvancedMatchStatus;
+  advancedMatch?: AdvancedMatch;
+};
+
+interface StrengthOrWeakness {
+  title: string;
+  summary: string;
+}
+
+export type AdvancedMatch = {
+  strengths: StrengthOrWeakness[];
+  weaknesses: StrengthOrWeakness[];
+  summary: string;
+};
+
+export type UserData = {
+  id: string;
+  intro: string;
+  firstName: string;
+  state: string;
+  birth: string;
+  gender: string;
+  distance: number;
+  interestedIn: string;
+  zodiacSign: string;
+  images: string[];
+  profileInput: Record<string, string>;
+  aiSummary?: string;
+  thumbnail: string;
+  image: string;
+  bankIDVerified: boolean;
+};
+
+export type MatchableUser = {
+  user: UserData;
+  percentages: RatedQuestions;
+  totalPercentage: number;
+  isMatch: boolean;
+  likeType?: LikeType;
+  isWildcard: boolean;
+  matchId?: string;
+  conversationId?: string;
+  advancedMatchStatus?: AdvancedMatchStatus;
+};
+
+export type MatchCheck = {
+  user: UserData;
+  percentages: RatedQuestions;
+  totalPercentage: number;
+};
+
+export type UserQuestions = {
+  questions: Record<string, string>;
+  invalidQuestions: string[];
+  favoriteQuestions: string[];
+};
+
+export type UserMatch = {
+  matchId: string;
+  userId: string;
+  seen: boolean;
+  created: string;
+  conversationId: string;
+};

package/src/types/message.types.ts

@@ -0,0 +1,9 @@
+export type Message = {
+  id: string;
+  conversationId: string;
+  recipient: string;
+  sender: string;
+  message: string;
+  created: string;
+  delivered: boolean;
+};

package/src/types/pls.types.ts

@@ -0,0 +1,8 @@
+export type PLS = {
+  id: string;
+  questionnaire: Record<string, string>;
+  channelId: string;
+  channel: string;
+  variation: string;
+  created: string;
+};

package/src/types/rating.types.ts

@@ -0,0 +1 @@
+export type RatedQuestions = Record<string, number>;

package/src/types/report.types.ts

@@ -0,0 +1,12 @@
+import { ReportReason, ReportStatus } from "../enum";
+
+export type Report = {
+  id: string;
+  reporterId: string;
+  reportedUserId: string;
+  reason: ReportReason;
+  description?: string;
+  status: ReportStatus;
+  resolvedBy?: string;
+  created: string;
+};

package/src/types/request.types.ts

@@ -0,0 +1,101 @@
+import { FeedbackAgreement, LikeType, ReportReason } from "../enum";
+import { Answer } from "./submission.types";
+import { RegistrationData } from "./user.types";
+
+// assessment
+export type CreateAssessmentRequest = { intimateTopics: boolean };
+export type GetAssessmentRequest = { id: string };
+
+// submission
+export type CreateSubmissionRequest = {
+  assessmentId: string;
+};
+export type GetSubmissionRequest = {
+  assessmentId: string;
+  submissionId: string;
+};
+export type UpdateAnswerRequest = {
+  assessmentId: string;
+  submissionId: string;
+  categoryId: string;
+  answer: Answer;
+};
+export type SubmitCategoryFeedbackRequest = {
+  assessmentId: string;
+  submissionId: string;
+  categoryId: string;
+  agreement: FeedbackAgreement;
+  evaluationReflection: string;
+  additionalThoughts: string;
+};
+
+// bankid
+export type AuthenticateBankIDRequest = undefined;
+export type CollectBankIDRequest = {
+  orderRef: string;
+};
+
+// message
+export type SendMessageRequest = {
+  conversationId: string;
+  messageId: string;
+  message: string;
+};
+
+export type GetMessagesRequest = {
+  conversationId: string;
+  limit: number;
+  offset: string;
+};
+
+// like
+export type CreateLikeRequest = { recipientId: string; type: LikeType };
+export type GetLikesRequest = { limit: number; offset: string };
+export type HandleLikeSeenRequest = { userId: string };
+
+// match
+export type RemoveMatchRequest = { recipientId: string };
+export type GetMatchRequest = { matchId: string };
+export type HandleMatchSeenRequest = { userId: string };
+export type GetMatchesRequest = { limit: number; offset: string };
+export type GetMatchableUserRequest = { userId: string };
+export type GetMatchCheckRequest = { userId: string };
+
+// pls
+export type CreatePLSRequest = {
+  questionnaire: Record<string, string>;
+  channelId: string;
+  variation: string;
+};
+
+// rating
+export type UpdateQuestionsRequest = { questions: Record<string, string> };
+
+// report
+export type CreateReportRequest = {
+  reportedUserId: string;
+  reason: ReportReason;
+  description?: string;
+};
+
+// stripe
+export type CreateCheckoutSessionRequest = {
+  priceId: string;
+};
+
+// user
+export type RegisterUserRequest = {
+  email: string;
+  password: string;
+  referrerId?: string;
+  data: RegistrationData;
+};
+export type GetUserRequest = undefined;
+export type UpdateUserRequest = Partial<any>; // TODO; fix typing
+
+// storage
+export type AddImagesRequest = { images: string[] };
+
+// stripe
+export type GetProductsRequest = undefined;
+export type CreateBillingPortalRequest = undefined;

package/src/types/response.types.ts

@@ -0,0 +1,80 @@
+import { Assessment, FullAssessment } from "./assessment.types";
+import { Submission, CategoryEvaluation } from "./submission.types";
+import { Match, MatchableUser, MatchCheck, UserMatch } from "./match.types";
+import { Message } from "./message.types";
+import { StripeProduct } from "./stripe.types";
+import { User } from "./user.types";
+import { Like } from "./like.types";
+
+// assessment
+export type CreateAssessmentResponse = Assessment;
+export type GetAssessmentResponse = Assessment;
+export type GetAssessmentsResponse = FullAssessment[];
+export type CreateSubmissionResponse = Submission;
+export type GetSubmissionResponse = Submission;
+export type UpdateAnswerResponse = {
+  submission: Submission;
+  categoryEvaluation?: CategoryEvaluation;
+};
+export type SubmitCategoryFeedbackResponse = CategoryEvaluation;
+
+//BankID
+export type AuthenticateBankIDResponse = {
+  orderRef: string;
+  qrStartToken: string;
+  autoStartToken: string;
+};
+
+export interface CollectBankIDResponse {
+  orderRef: string;
+  status: "pending" | "complete" | "failed";
+  qrCode?: string;
+  hintCode?: string;
+}
+
+// message
+export type SendMessageResponse = Message;
+export type GetMessagesResponse = Message[];
+
+// match
+export type HandleLikeResponse = boolean;
+export type RemoveMatchResponse = void;
+export type GetMatchResponse = Match;
+export type HandleMatchSeenResponse = void;
+export type GetMatchesResponse = UserMatch[];
+export type GetMatchableUserResponse = MatchableUser;
+export type GetMatchableUsersResponse = MatchableUser[];
+
+// like
+export type CreateLikeResponse = { isMatch: boolean };
+export type GetLikesResponse = Like[];
+export type HandleLikeSeenResponse = void;
+
+// pls
+export type CreatePLSResponse = void;
+
+// rating
+export type UpdateQuestionsResponse = void;
+
+// report
+export type CreateReportResponse = void;
+
+// stripe
+export type CreateBillingPortalResponse = { url: string };
+export type CreateCheckoutSessionResponse = { url: string };
+export type GetProductsResponse = StripeProduct[];
+
+// user
+export type RegisterUserResponse = {
+  success: boolean;
+  message: string;
+};
+export type GetUserResponse = User;
+export type UpdateUserResponse = User;
+
+// storage
+export type AddImagesResponse = { images: string[]; thumbnail: string };
+
+export type CancelBankIDResponse = void;
+
+export type GetMatchCheckResponse = MatchCheck;

package/src/types/stripe.types.ts

@@ -0,0 +1,8 @@
+export type StripeProduct = {
+  id: string;
+  title: string;
+  description: string | null;
+  price: number | null;
+  priceId: string;
+  interval: string | null;
+};

package/src/types/submission.types.ts

@@ -0,0 +1,30 @@
+import { FeedbackAgreement } from "../enum";
+
+type QuestionId = string;
+type CategoryId = string;
+
+export type Submission = {
+  id: string;
+  assessmentId: string;
+  introductionSeen: boolean;
+  answers: Record<QuestionId, Answer>;
+  categoryEvaluations: Record<CategoryId, CategoryEvaluation>;
+  lastUpdated: string;
+  created: string;
+};
+
+export type Answer = {
+  questionId: string;
+  answer: string | null;
+  elaboration?: string;
+  skipped: boolean;
+  reason: string | null;
+};
+
+export type CategoryEvaluation = {
+  categoryId: string;
+  aiSummary: string;
+  agreement: FeedbackAgreement | null;
+  evaluationReflection: string | null;
+  additionalThoughts: string | null;
+};

package/src/types/user.types.ts

@@ -0,0 +1,125 @@
+import { Gender } from "../enum";
+
+export type User = {
+  id: string;
+  email: string;
+  bankIDVerified: boolean; // should this be used?
+  registrationReferralAllowed: boolean; // should this be used?
+  profile: Profile;
+  preferences: DatingPreferences;
+  notifications: UserNotifications;
+};
+
+export type Profile = {
+  intro: string;
+  firstName: string;
+  state: string;
+  birth: Date;
+  age: number;
+  gender: Gender;
+  zodiacSign: string;
+  images: string[];
+  thumbnail: string;
+  thumbnailBlurred: string;
+  image: string;
+  aiSummary?: string;
+  attachedSummary: boolean;
+  profileInput: Record<string, string>;
+};
+
+export type NotificationSettings = {
+  enabled: boolean;
+  settings: Record<string, boolean>; // e.g., push, email, etc.
+};
+
+export type UserNotifications = {
+  pushNotificationsEnabled: boolean;
+  emailNotificationsEnabled: boolean;
+  pushNotificationSettings: NotificationSettings;
+  emailNotificationSettings: NotificationSettings;
+};
+
+export type DatingPreferences = {
+  minAge: number;
+  maxAge: number;
+  interestedIn: Gender[];
+  distanceRadius: number;
+};
+
+export type RegistrationData = {
+  firstName: string;
+  lat: number;
+  lng: number;
+  birth: Date;
+  gender: Gender;
+  interestedIn: Gender[];
+  minAge: number;
+  maxAge: number;
+  distanceRadius: number;
+};
+
+// export type User = {
+//   id: string;
+//   intro: string;
+//   firstName: string;
+//   state: string;
+//   birth: string;
+//   gender: string;
+//   interestedIn: string;
+//   zodiacSign: string;
+//   images: string[];
+//   profileInput: ProfileInput;
+//   lat: number;
+//   lng: number;
+//   radius: number;
+//   geohash: string;
+//   minAge: number;
+//   maxAge: number;
+//   aiSummary?: string;
+//   attachedSummary: boolean;
+//   thumbnail: string;
+//   image: string;
+//   bankIDVerified: boolean;
+//   emailNotificationsEnabled: boolean;
+//   pushNotificationsEnabled: boolean;
+//   pushNotificationSettings: NotificationSettings;
+//   registrationReferralAllowed: boolean;
+// };
+
+// export type UserRegistrationData = {
+//   firstName: string;
+//   state: string;
+//   birth: string;
+//   gender: string;
+//   images: string[];
+//   intro: string;
+//   interestedIn: string;
+//   lat?: number;
+//   lng?: number;
+//   radius?: number;
+//   minAge?: number;
+//   maxAge?: number;
+// };
+
+// export type UpdateUserData = {
+//   intro: string;
+//   firstName: string;
+//   state: string;
+//   birth: string;
+//   profileInput: ProfileInput;
+//   lat: number;
+//   lng: number;
+//   radius: number;
+//   geohash: string;
+//   minAge: number;
+//   maxAge: number;
+//   interestedIn: string; // maybe to be removed before release
+//   attachedSummary: boolean;
+//   expoPushToken?: string;
+//   pushNotificationsEnabled: boolean;
+//   emailNotificationsEnabled: boolean;
+//   pushNotificationSettings?: NotificationSettings;
+//   emailNotificationSettings?: NotificationSettings;
+// };
+
+// export type ProfileInput = Record<string, string>;

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+      "baseUrl": ".",
+      "declaration": true,
+      "outDir": "./dist",
+      "esModuleInterop": true,
+      "moduleResolution": "node",
+      "module": "CommonJS", 
+      "target": "ES2021",
+      "strict": true
+    },
+    "include": [
+      "src/**/*.ts"
+    ]
+  }
+  

package/version-bump.js

@@ -0,0 +1,21 @@
+const fs = require("fs");
+const execSync = require("child_process").execSync;
+
+// Get the current version from package.json
+const packageJson = require("./package.json");
+const currentVersion = packageJson.version;
+
+// Get the latest published version from npm registry
+const latestVersion = execSync("npm show heartraite version").toString().trim();
+
+// Increment the version based on the latest version
+const versionParts = latestVersion.split(".");
+versionParts[2] = (parseInt(versionParts[2]) + 1).toString(); // Increment patch version
+const newVersion = versionParts.join(".");
+
+packageJson.version = newVersion;
+
+// Update the package.json with the new version
+fs.writeFileSync("package.json", JSON.stringify(packageJson, null, 2));
+
+console.log(`Version bumped from ${currentVersion} to ${newVersion}`);