heartraite 1.0.23 → 1.0.25

package/dist/enum/cloudfunction.enum.d.ts

@@ -11,12 +11,13 @@ export declare enum CloudFunction {
     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",
+    GET_MATCH_CHECK = "matchmaking/get-match-check",
+    GET_MATCHABLE_USER = "matchmaking/get-matchable-user",
+    GET_MATCHABLE_USERS = "matchmaking/get-matchable-users",
     SEND_MESSAGE = "message/send-message",
     GET_MESSAGES = "message/get-messages",
+    CALCULATE_PLS_SCORE = "pls/calculate-score",
     CREATE_PLS_INPUT = "pls/create-input",
     CREATE_PLS_ASSESSMENT = "pls/create-assessment",
     GET_PLS_ASSESSMENT = "pls/get-assessment",

package/dist/enum/cloudfunction.enum.js

@@ -15,12 +15,13 @@ var CloudFunction;
     CloudFunction["GET_MATCH"] = "match/get-match";
     CloudFunction["HANDLE_MATCH_SEEN"] = "match/handle-match-seen";
     CloudFunction["GET_MATCHES"] = "match/get-matches";
-    CloudFunction["GET_MATCH_CHECK"] = "match/get-match-check";
     CloudFunction["REMOVE_MATCH"] = "match/remove-match";
-    CloudFunction["GET_MATCHABLE_USER"] = "match/get-matchable-user";
-    CloudFunction["GET_MATCHABLE_USERS"] = "match/get-matchable-users";
+    CloudFunction["GET_MATCH_CHECK"] = "matchmaking/get-match-check";
+    CloudFunction["GET_MATCHABLE_USER"] = "matchmaking/get-matchable-user";
+    CloudFunction["GET_MATCHABLE_USERS"] = "matchmaking/get-matchable-users";
     CloudFunction["SEND_MESSAGE"] = "message/send-message";
     CloudFunction["GET_MESSAGES"] = "message/get-messages";
+    CloudFunction["CALCULATE_PLS_SCORE"] = "pls/calculate-score";
     CloudFunction["CREATE_PLS_INPUT"] = "pls/create-input";
     CloudFunction["CREATE_PLS_ASSESSMENT"] = "pls/create-assessment";
     CloudFunction["GET_PLS_ASSESSMENT"] = "pls/get-assessment";

package/dist/types/assessment.types.d.ts

@@ -1,4 +1,6 @@
+import { PLSScore } from "./pls.types";
 import { Submission } from "./submission.types";
+type SubmissionId = string;
 export type Assessment = {
     id: string;
     created: string;
@@ -8,4 +10,6 @@ export type Assessment = {
 };
 export type FullAssessment = Assessment & {
     submissions: Submission[];
+    scores?: Record<SubmissionId, PLSScore>;
 };
+export {};

package/dist/types/cloud-function-types.d.ts

@@ -1,6 +1,6 @@
 import { CloudFunction } from "../enum";
-import { AddImagesRequest, AuthenticateBankIDRequest, CollectBankIDRequest, CreateBillingPortalRequest, CreateCheckoutSessionRequest, CreateLikeRequest, CreatePLSAssessmentRequest, CreatePLSInputRequest, CreatePLSSubmissionRequest, CreateReportRequest, GetCARequest, GetMatchableUserRequest, GetMatchCheckRequest, GetMatchesRequest, GetMatchRequest, GetMessagesRequest, GetPLSAssessmentRequest, GetPLSSubmissionRequest, GetProductsRequest, GetUserRequest, HandleLikeSeenRequest, HandleMatchSeenRequest, RegisterOnboardingRequest, RegisterUserRequest, RemoveMatchRequest, SendMessageRequest, SubmitAnswerRequest, SubmitCategoryFeedbackRequest, SubmitPLSCategoryFeedbackRequest, UpdatePLSAnswerRequest, UpdateQuestionsRequest, UpdateUserRequest } from "./request.types";
-import { AddImagesResponse, AuthenticateBankIDResponse, CollectBankIDResponse, CreateBillingPortalResponse, CreateCheckoutSessionResponse, CreateLikeResponse, CreatePLSAssessmentResponse, CreatePLSInputResponse, CreatePLSSubmissionResponse, CreateReportResponse, GetCAResponse, GetMatchableUserResponse, GetMatchableUsersResponse, GetMatchCheckResponse, GetMatchesResponse, GetMatchResponse, GetMessagesResponse, GetPLSAssessmentResponse, GetPLSAssessmentsResponse, GetPLSSubmissionResponse, GetProductsResponse, GetUserResponse, HandleLikeSeenResponse, HandleMatchSeenResponse, RegisterOnboardingResponse, RegisterUserResponse, RemoveMatchResponse, SendMessageResponse, SubmitAnswerResponse, SubmitCategoryFeedbackResponse, SubmitPLSCategoryFeedbackResponse, UpdatePLSAnswerResponse, UpdateQuestionsResponse, UpdateUserResponse } from "./response.types";
+import { AddImagesRequest, AuthenticateBankIDRequest, CalculatePLSScoreRequest, CollectBankIDRequest, CreateBillingPortalRequest, CreateCheckoutSessionRequest, CreateLikeRequest, CreatePLSAssessmentRequest, CreatePLSInputRequest, CreatePLSSubmissionRequest, CreateReportRequest, GetCARequest, GetMatchableUserRequest, GetMatchCheckRequest, GetMatchesRequest, GetMatchRequest, GetMessagesRequest, GetPLSAssessmentRequest, GetPLSSubmissionRequest, GetProductsRequest, GetUserRequest, HandleLikeSeenRequest, HandleMatchSeenRequest, RegisterOnboardingRequest, RegisterUserRequest, RemoveMatchRequest, SendMessageRequest, SubmitAnswerRequest, SubmitCategoryFeedbackRequest, SubmitPLSCategoryFeedbackRequest, UpdatePLSAnswerRequest, UpdateQuestionsRequest, UpdateUserRequest } from "./request.types";
+import { AddImagesResponse, AuthenticateBankIDResponse, CalculatePLSScoreResponse, CollectBankIDResponse, CreateBillingPortalResponse, CreateCheckoutSessionResponse, CreateLikeResponse, CreatePLSAssessmentResponse, CreatePLSInputResponse, CreatePLSSubmissionResponse, CreateReportResponse, GetCAResponse, GetMatchableUserResponse, GetMatchableUsersResponse, GetMatchCheckResponse, GetMatchesResponse, GetMatchResponse, GetMessagesResponse, GetPLSAssessmentResponse, GetPLSAssessmentsResponse, GetPLSSubmissionResponse, GetProductsResponse, GetUserResponse, HandleLikeSeenResponse, HandleMatchSeenResponse, RegisterOnboardingResponse, RegisterUserResponse, RemoveMatchResponse, SendMessageResponse, SubmitAnswerResponse, SubmitCategoryFeedbackResponse, SubmitPLSCategoryFeedbackResponse, UpdatePLSAnswerResponse, UpdateQuestionsResponse, UpdateUserResponse } from "./response.types";
 export type CloudFunctionTypes = {
     [CloudFunction.REGISTER_USER]: {
         payload: RegisterUserRequest;
@@ -74,6 +74,10 @@ export type CloudFunctionTypes = {
         payload: GetMessagesRequest;
         response: GetMessagesResponse;
     };
+    [CloudFunction.CALCULATE_PLS_SCORE]: {
+        payload: CalculatePLSScoreRequest;
+        response: CalculatePLSScoreResponse;
+    };
     [CloudFunction.CREATE_PLS_INPUT]: {
         payload: CreatePLSInputRequest;
         response: CreatePLSInputResponse;

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export * from "./error.types";
 export * from "./helper.types";
 export * from "./like.types";
 export * from "./match.types";
+export * from "./matchmaking.types";
 export * from "./message.types";
 export * from "./request.types";
 export * from "./report.types";

package/dist/types/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./error.types"), exports);
 __exportStar(require("./helper.types"), exports);
 __exportStar(require("./like.types"), exports);
 __exportStar(require("./match.types"), exports);
+__exportStar(require("./matchmaking.types"), exports);
 __exportStar(require("./message.types"), exports);
 __exportStar(require("./request.types"), exports);
 __exportStar(require("./report.types"), exports);

package/dist/types/match.types.d.ts

@@ -1,7 +1,5 @@
-import { LikeType } from "../enum";
 import { AdvancedMatchStatus } from "../enum/match.enum";
 import { RatedQuestions } from "./rating.types";
-import { UserProfile } from "./user.types";
 export type Match = {
     id: string;
     users: Record<string, boolean>;
@@ -21,26 +19,6 @@ interface StrengthOrWeakness {
     title: string;
     summary: string;
 }
-export type MatchStatus = {
-    likeType?: LikeType;
-    advancedMatchStatus?: AdvancedMatchStatus;
-};
-export type MatchData = {
-    percentages: Record<string, number>;
-    totalPercentage: number;
-    isMatch: boolean;
-};
-export type MatchableUser = {
-    matchId?: string;
-    conversationId?: string;
-    profile: UserProfile;
-    matchData: MatchData;
-    matchStatus: MatchStatus;
-};
-export type MatchCheck = {
-    profile: UserProfile;
-    matchData: MatchData;
-};
 export type UserMatch = {
     matchId: string;
     userId: string;

package/dist/types/matchmaking.types.d.ts

@@ -0,0 +1,23 @@
+import { AdvancedMatchStatus, LikeType } from "../enum";
+import { UserProfile } from "./user.types";
+export type MatchableUser = {
+    matchId?: string;
+    conversationId?: string;
+    distance: number;
+    profile: UserProfile;
+    compatibility: MatchCompatibility;
+    matchStatus: MatchStatus;
+};
+export type MatchStatus = {
+    isMatch: boolean;
+    likeType?: LikeType;
+    advancedMatchStatus?: AdvancedMatchStatus;
+};
+export type MatchCompatibility = {
+    categoryPercentages: Record<string, number>;
+    totalPercentage: number;
+};
+export type MatchCheck = {
+    profile: UserProfile;
+    compatibility: MatchCompatibility;
+};

package/dist/types/matchmaking.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/pls.types.d.ts

@@ -1,3 +1,4 @@
+import { Score } from "./ca.types";
 export type PLS = {
     id: string;
     questionnaire: Record<string, string>;
@@ -6,3 +7,10 @@ export type PLS = {
     variation: string;
     created: string;
 };
+export type PLSScore = {
+    assessmentId: string;
+    submissionId: string;
+    created: string;
+    scores: Score;
+    summary: string;
+};

package/dist/types/request.types.d.ts

@@ -62,6 +62,9 @@ export type GetMatchableUserRequest = {
 export type GetMatchCheckRequest = {
     userId: string;
 };
+export type CalculatePLSScoreRequest = {
+    assessmentId: string;
+};
 export type CreatePLSInputRequest = {
     questionnaire: Record<string, string>;
     channelId: string;

package/dist/types/response.types.d.ts

@@ -1,6 +1,7 @@
 import { Assessment, FullAssessment } from "./assessment.types";
 import { Submission, CategoryEvaluation } from "./submission.types";
-import { Match, MatchableUser, MatchCheck, UserMatch } from "./match.types";
+import { Match, UserMatch } from "./match.types";
+import { MatchableUser, MatchCheck } from "./matchmaking.types";
 import { Message } from "./message.types";
 import { StripeProduct } from "./stripe.types";
 import { User } from "./user.types";
@@ -41,6 +42,7 @@ export type CreateLikeResponse = {
 };
 export type GetLikesResponse = Like[];
 export type HandleLikeSeenResponse = void;
+export type CalculatePLSScoreResponse = FullAssessment;
 export type CreatePLSInputResponse = void;
 export type CreatePLSAssessmentResponse = Assessment;
 export type GetPLSAssessmentResponse = FullAssessment;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "heartraite",
-  "version": "1.0.23",
+  "version": "1.0.25",
   "description": "Heartraite npm package for common functionality",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/enum/cloudfunction.enum.ts

@@ -11,12 +11,13 @@ export enum CloudFunction {
   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",
+  GET_MATCH_CHECK = "matchmaking/get-match-check",
+  GET_MATCHABLE_USER = "matchmaking/get-matchable-user",
+  GET_MATCHABLE_USERS = "matchmaking/get-matchable-users",
   SEND_MESSAGE = "message/send-message",
   GET_MESSAGES = "message/get-messages",
+  CALCULATE_PLS_SCORE = "pls/calculate-score",
   CREATE_PLS_INPUT = "pls/create-input",
   CREATE_PLS_ASSESSMENT = "pls/create-assessment",
   GET_PLS_ASSESSMENT = "pls/get-assessment",

package/src/types/assessment.types.ts

@@ -1,5 +1,8 @@
+import { PLSScore } from "./pls.types";
 import { Submission } from "./submission.types";
 
+type SubmissionId = string;
+
 export type Assessment = {
   id: string;
   created: string;
@@ -10,4 +13,5 @@ export type Assessment = {
 
 export type FullAssessment = Assessment & {
   submissions: Submission[];
+  scores?: Record<SubmissionId, PLSScore>;
 };

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

@@ -2,6 +2,7 @@ import { CloudFunction } from "../enum";
 import {
   AddImagesRequest,
   AuthenticateBankIDRequest,
+  CalculatePLSScoreRequest,
   CollectBankIDRequest,
   CreateBillingPortalRequest,
   CreateCheckoutSessionRequest,
@@ -36,6 +37,7 @@ import {
 import {
   AddImagesResponse,
   AuthenticateBankIDResponse,
+  CalculatePLSScoreResponse,
   CollectBankIDResponse,
   CreateBillingPortalResponse,
   CreateCheckoutSessionResponse,
@@ -157,6 +159,10 @@ export type CloudFunctionTypes = {
   };
 
   // pls
+  [CloudFunction.CALCULATE_PLS_SCORE]: {
+    payload: CalculatePLSScoreRequest;
+    response: CalculatePLSScoreResponse;
+  };
   [CloudFunction.CREATE_PLS_INPUT]: {
     payload: CreatePLSInputRequest;
     response: CreatePLSInputResponse;

package/src/types/index.ts

@@ -5,6 +5,7 @@ export * from "./error.types";
 export * from "./helper.types";
 export * from "./like.types";
 export * from "./match.types";
+export * from "./matchmaking.types";
 export * from "./message.types";
 export * from "./request.types";
 export * from "./report.types";

package/src/types/match.types.ts

@@ -1,7 +1,5 @@
-import { LikeType } from "../enum";
 import { AdvancedMatchStatus } from "../enum/match.enum";
 import { RatedQuestions } from "./rating.types";
-import { UserProfile } from "./user.types";
 
 export type Match = {
   id: string;
@@ -25,30 +23,6 @@ interface StrengthOrWeakness {
   summary: string;
 }
 
-export type MatchStatus = {
-  likeType?: LikeType;
-  advancedMatchStatus?: AdvancedMatchStatus;
-};
-
-export type MatchData = {
-  percentages: Record<string, number>;
-  totalPercentage: number;
-  isMatch: boolean;
-};
-
-export type MatchableUser = {
-  matchId?: string;
-  conversationId?: string;
-  profile: UserProfile;
-  matchData: MatchData;
-  matchStatus: MatchStatus;
-};
-
-export type MatchCheck = {
-  profile: UserProfile;
-  matchData: MatchData;
-};
-
 export type UserMatch = {
   matchId: string;
   userId: string;

package/src/types/matchmaking.types.ts

@@ -0,0 +1,27 @@
+import { AdvancedMatchStatus, LikeType } from "../enum";
+import { UserProfile } from "./user.types";
+
+export type MatchableUser = {
+  matchId?: string;
+  conversationId?: string;
+  distance: number;
+  profile: UserProfile;
+  compatibility: MatchCompatibility;
+  matchStatus: MatchStatus;
+};
+
+export type MatchStatus = {
+  isMatch: boolean;
+  likeType?: LikeType;
+  advancedMatchStatus?: AdvancedMatchStatus;
+};
+
+export type MatchCompatibility = {
+  categoryPercentages: Record<string, number>;
+  totalPercentage: number;
+};
+
+export type MatchCheck = {
+  profile: UserProfile;
+  compatibility: MatchCompatibility;
+};

package/src/types/pls.types.ts

@@ -1,3 +1,5 @@
+import { Score } from "./ca.types";
+
 export type PLS = {
   id: string;
   questionnaire: Record<string, string>;
@@ -6,3 +8,11 @@ export type PLS = {
   variation: string;
   created: string;
 };
+
+export type PLSScore = {
+  assessmentId: string;
+  submissionId: string;
+  created: string;
+  scores: Score;
+  summary: string;
+};

package/src/types/request.types.ts

@@ -57,6 +57,9 @@ export type GetMatchableUserRequest = { userId: string };
 export type GetMatchCheckRequest = { userId: string };
 
 // pls
+export type CalculatePLSScoreRequest = {
+  assessmentId: string;
+};
 export type CreatePLSInputRequest = {
   questionnaire: Record<string, string>;
   channelId: string;

package/src/types/response.types.ts

@@ -1,6 +1,7 @@
 import { Assessment, FullAssessment } from "./assessment.types";
 import { Submission, CategoryEvaluation } from "./submission.types";
-import { Match, MatchableUser, MatchCheck, UserMatch } from "./match.types";
+import { Match, UserMatch } from "./match.types";
+import { MatchableUser, MatchCheck } from "./matchmaking.types";
 import { Message } from "./message.types";
 import { StripeProduct } from "./stripe.types";
 import { User } from "./user.types";
@@ -54,6 +55,7 @@ export type GetLikesResponse = Like[];
 export type HandleLikeSeenResponse = void;
 
 // pls
+export type CalculatePLSScoreResponse = FullAssessment;
 export type CreatePLSInputResponse = void;
 export type CreatePLSAssessmentResponse = Assessment;
 export type GetPLSAssessmentResponse = FullAssessment;