@superapp_men/submit-assessment-results 1.0.0

package/dist/superapp.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Types for @superapp_men/submit-assessment-results
+ * Aligned with SubmitAssessmentResults API (academicYearId and periodWeekSubjectId
+ * are omitted in partner payload; SuperApp adds them when calling the endpoint).
+ */
+/** Question role in the assessment (matches backend enum). */
+declare enum QuestionRole {
+    POSITIONING = 1,
+    VALIDATION = 2,
+    REMEDIATION = 3,
+    BONUS = 4
+}
+/** Response time: milliseconds (number) or "hh:mm:ss" string. */
+type ResponseTimeInput = number | string;
+/** Single question result (partner payload). */
+interface SubmittedQuestionResultPayload {
+    questionCode: string;
+    isCorrect: boolean;
+    questionOrder: number;
+    questionRole: QuestionRole;
+    responseTime?: ResponseTimeInput;
+    attemptsCount?: number;
+    questionTextFr?: string;
+    questionTextAr?: string;
+}
+/** Single skill result; must have either subSkills or questions. */
+interface SubmittedSkillResultPayload {
+    skillCode: string;
+    skillOrder: number;
+    passed: boolean;
+    titleFr?: string;
+    titleAr?: string;
+    descriptionFr?: string;
+    descriptionAr?: string;
+    subSkills?: SubmittedSkillResultPayload[];
+    questions?: SubmittedQuestionResultPayload[];
+}
+/**
+ * Partner payload for submit assessment results.
+ * academicYearId and periodWeekSubjectId are NOT included; the SuperApp
+ * adds them when calling the backend.
+ */
+interface SubmitAssessmentResultsPartnerPayload {
+    studentId: string;
+    partnerCode: string;
+    attemptId: string;
+    isAser?: boolean;
+    totalSkillsInWeek: number;
+    skills: SubmittedSkillResultPayload[];
+}
+/** Success response from SubmitAssessmentResults endpoint. */
+interface SubmitAssessmentResultsResponse {
+    attemptId: string;
+    isDuplicate: boolean;
+    status: string;
+    message: string | null;
+    serverTimeUtc: string;
+}
+/** ValidationProblemDetails (400). */
+interface ValidationProblemDetails {
+    type?: string;
+    title?: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+    errors?: Record<string, string[]>;
+}
+/** ProblemDetails (404, 409, 422, 429, 500). */
+interface ProblemDetails {
+    type?: string;
+    title?: string;
+    status?: number;
+    detail?: string;
+    instance?: string;
+    [key: string]: unknown;
+}
+/**
+ * Result of calling submit: either the success response or an error response
+ * with statusCode and body as returned by the backend.
+ */
+type SubmitAssessmentResultsApiResult = {
+    ok: true;
+    statusCode: number;
+    body: SubmitAssessmentResultsResponse;
+} | {
+    ok: false;
+    statusCode: number;
+    body: ValidationProblemDetails | ProblemDetails;
+};
+/** Message types for iframe/Capacitor communication. */
+declare enum AssessmentMessageType {
+    REQUEST = "assessment:submit-request",
+    RESPONSE = "assessment:submit-response"
+}
+/** Message sent from partner to SuperApp. */
+interface AssessmentSubmitRequestMessage {
+    type: AssessmentMessageType.REQUEST;
+    requestId: string;
+    payload: SubmitAssessmentResultsPartnerPayload;
+    timestamp: number;
+}
+/** Message sent from SuperApp to partner (wraps backend result). */
+interface AssessmentSubmitResponseMessage {
+    type: AssessmentMessageType.RESPONSE;
+    requestId: string;
+    /** HTTP status code from the backend call. */
+    statusCode: number;
+    /** Exact response body from the backend (success or error). */
+    body: SubmitAssessmentResultsResponse | ValidationProblemDetails | ProblemDetails;
+    timestamp: number;
+}
+
+export { AssessmentMessageType, QuestionRole };
+export type { AssessmentSubmitRequestMessage, AssessmentSubmitResponseMessage, ProblemDetails, SubmitAssessmentResultsApiResult, SubmitAssessmentResultsPartnerPayload, SubmitAssessmentResultsResponse, SubmittedQuestionResultPayload, SubmittedSkillResultPayload, ValidationProblemDetails };

package/dist/superapp.esm.js

@@ -0,0 +1,22 @@
+/**
+ * Types for @superapp_men/submit-assessment-results
+ * Aligned with SubmitAssessmentResults API (academicYearId and periodWeekSubjectId
+ * are omitted in partner payload; SuperApp adds them when calling the endpoint).
+ */
+/** Question role in the assessment (matches backend enum). */
+var QuestionRole;
+(function (QuestionRole) {
+    QuestionRole[QuestionRole["POSITIONING"] = 1] = "POSITIONING";
+    QuestionRole[QuestionRole["VALIDATION"] = 2] = "VALIDATION";
+    QuestionRole[QuestionRole["REMEDIATION"] = 3] = "REMEDIATION";
+    QuestionRole[QuestionRole["BONUS"] = 4] = "BONUS";
+})(QuestionRole || (QuestionRole = {}));
+/** Message types for iframe/Capacitor communication. */
+var AssessmentMessageType;
+(function (AssessmentMessageType) {
+    AssessmentMessageType["REQUEST"] = "assessment:submit-request";
+    AssessmentMessageType["RESPONSE"] = "assessment:submit-response";
+})(AssessmentMessageType || (AssessmentMessageType = {}));
+
+export { AssessmentMessageType, QuestionRole };
+//# sourceMappingURL=superapp.esm.js.map

package/dist/superapp.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"superapp.esm.js","sources":["../src/types.ts"],"sourcesContent":["/**\r\n * Types for @superapp_men/submit-assessment-results\r\n * Aligned with SubmitAssessmentResults API (academicYearId and periodWeekSubjectId\r\n * are omitted in partner payload; SuperApp adds them when calling the endpoint).\r\n */\r\n\r\n/** Question role in the assessment (matches backend enum). */\r\nexport enum QuestionRole {\r\n  POSITIONING = 1,\r\n  VALIDATION = 2,\r\n  REMEDIATION = 3,\r\n  BONUS = 4,\r\n}\r\n\r\n/** Response time: milliseconds (number) or \"hh:mm:ss\" string. */\r\nexport type ResponseTimeInput = number | string;\r\n\r\n/** Single question result (partner payload). */\r\nexport interface SubmittedQuestionResultPayload {\r\n  questionCode: string;\r\n  isCorrect: boolean;\r\n  questionOrder: number;\r\n  questionRole: QuestionRole;\r\n  responseTime?: ResponseTimeInput;\r\n  attemptsCount?: number;\r\n  questionTextFr?: string;\r\n  questionTextAr?: string;\r\n}\r\n\r\n/** Single skill result; must have either subSkills or questions. */\r\nexport interface SubmittedSkillResultPayload {\r\n  skillCode: string;\r\n  skillOrder: number;\r\n  passed: boolean;\r\n  titleFr?: string;\r\n  titleAr?: string;\r\n  descriptionFr?: string;\r\n  descriptionAr?: string;\r\n  subSkills?: SubmittedSkillResultPayload[];\r\n  questions?: SubmittedQuestionResultPayload[];\r\n}\r\n\r\n/**\r\n * Partner payload for submit assessment results.\r\n * academicYearId and periodWeekSubjectId are NOT included; the SuperApp\r\n * adds them when calling the backend.\r\n */\r\nexport interface SubmitAssessmentResultsPartnerPayload {\r\n  studentId: string;\r\n  partnerCode: string;\r\n  attemptId: string;\r\n  isAser?: boolean;\r\n  totalSkillsInWeek: number;\r\n  skills: SubmittedSkillResultPayload[];\r\n}\r\n\r\n/** Success response from SubmitAssessmentResults endpoint. */\r\nexport interface SubmitAssessmentResultsResponse {\r\n  attemptId: string;\r\n  isDuplicate: boolean;\r\n  status: string;\r\n  message: string | null;\r\n  serverTimeUtc: string;\r\n}\r\n\r\n/** ValidationProblemDetails (400). */\r\nexport interface ValidationProblemDetails {\r\n  type?: string;\r\n  title?: string;\r\n  status: number;\r\n  detail?: string;\r\n  instance?: string;\r\n  errors?: Record<string, string[]>;\r\n}\r\n\r\n/** ProblemDetails (404, 409, 422, 429, 500). */\r\nexport interface ProblemDetails {\r\n  type?: string;\r\n  title?: string;\r\n  status?: number;\r\n  detail?: string;\r\n  instance?: string;\r\n  [key: string]: unknown;\r\n}\r\n\r\n/**\r\n * Result of calling submit: either the success response or an error response\r\n * with statusCode and body as returned by the backend.\r\n */\r\nexport type SubmitAssessmentResultsApiResult =\r\n  | { ok: true; statusCode: number; body: SubmitAssessmentResultsResponse }\r\n  | {\r\n      ok: false;\r\n      statusCode: number;\r\n      body: ValidationProblemDetails | ProblemDetails;\r\n    };\r\n\r\n/** Message types for iframe/Capacitor communication. */\r\nexport enum AssessmentMessageType {\r\n  REQUEST = \"assessment:submit-request\",\r\n  RESPONSE = \"assessment:submit-response\",\r\n}\r\n\r\n/** Message sent from partner to SuperApp. */\r\nexport interface AssessmentSubmitRequestMessage {\r\n  type: AssessmentMessageType.REQUEST;\r\n  requestId: string;\r\n  payload: SubmitAssessmentResultsPartnerPayload;\r\n  timestamp: number;\r\n}\r\n\r\n/** Message sent from SuperApp to partner (wraps backend result). */\r\nexport interface AssessmentSubmitResponseMessage {\r\n  type: AssessmentMessageType.RESPONSE;\r\n  requestId: string;\r\n  /** HTTP status code from the backend call. */\r\n  statusCode: number;\r\n  /** Exact response body from the backend (success or error). */\r\n  body: SubmitAssessmentResultsResponse | ValidationProblemDetails | ProblemDetails;\r\n  timestamp: number;\r\n}\r\n"],"names":[],"mappings":"AAAA;;;;AAIG;AAEH;IACY;AAAZ,CAAA,UAAY,YAAY,EAAA;AACtB,IAAA,YAAA,CAAA,YAAA,CAAA,aAAA,CAAA,GAAA,CAAA,CAAA,GAAA,aAAe;AACf,IAAA,YAAA,CAAA,YAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAc;AACd,IAAA,YAAA,CAAA,YAAA,CAAA,aAAA,CAAA,GAAA,CAAA,CAAA,GAAA,aAAe;AACf,IAAA,YAAA,CAAA,YAAA,CAAA,OAAA,CAAA,GAAA,CAAA,CAAA,GAAA,OAAS;AACX,CAAC,EALW,YAAY,KAAZ,YAAY,GAAA,EAAA,CAAA,CAAA;AA0FxB;IACY;AAAZ,CAAA,UAAY,qBAAqB,EAAA;AAC/B,IAAA,qBAAA,CAAA,SAAA,CAAA,GAAA,2BAAqC;AACrC,IAAA,qBAAA,CAAA,UAAA,CAAA,GAAA,4BAAuC;AACzC,CAAC,EAHW,qBAAqB,KAArB,qBAAqB,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/superapp.js

@@ -0,0 +1,22 @@
+'use strict';
+
+/**
+ * Types for @superapp_men/submit-assessment-results
+ * Aligned with SubmitAssessmentResults API (academicYearId and periodWeekSubjectId
+ * are omitted in partner payload; SuperApp adds them when calling the endpoint).
+ */
+/** Question role in the assessment (matches backend enum). */
+exports.QuestionRole = void 0;
+(function (QuestionRole) {
+    QuestionRole[QuestionRole["POSITIONING"] = 1] = "POSITIONING";
+    QuestionRole[QuestionRole["VALIDATION"] = 2] = "VALIDATION";
+    QuestionRole[QuestionRole["REMEDIATION"] = 3] = "REMEDIATION";
+    QuestionRole[QuestionRole["BONUS"] = 4] = "BONUS";
+})(exports.QuestionRole || (exports.QuestionRole = {}));
+/** Message types for iframe/Capacitor communication. */
+exports.AssessmentMessageType = void 0;
+(function (AssessmentMessageType) {
+    AssessmentMessageType["REQUEST"] = "assessment:submit-request";
+    AssessmentMessageType["RESPONSE"] = "assessment:submit-response";
+})(exports.AssessmentMessageType || (exports.AssessmentMessageType = {}));
+//# sourceMappingURL=superapp.js.map

package/dist/superapp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"superapp.js","sources":["../src/types.ts"],"sourcesContent":["/**\r\n * Types for @superapp_men/submit-assessment-results\r\n * Aligned with SubmitAssessmentResults API (academicYearId and periodWeekSubjectId\r\n * are omitted in partner payload; SuperApp adds them when calling the endpoint).\r\n */\r\n\r\n/** Question role in the assessment (matches backend enum). */\r\nexport enum QuestionRole {\r\n  POSITIONING = 1,\r\n  VALIDATION = 2,\r\n  REMEDIATION = 3,\r\n  BONUS = 4,\r\n}\r\n\r\n/** Response time: milliseconds (number) or \"hh:mm:ss\" string. */\r\nexport type ResponseTimeInput = number | string;\r\n\r\n/** Single question result (partner payload). */\r\nexport interface SubmittedQuestionResultPayload {\r\n  questionCode: string;\r\n  isCorrect: boolean;\r\n  questionOrder: number;\r\n  questionRole: QuestionRole;\r\n  responseTime?: ResponseTimeInput;\r\n  attemptsCount?: number;\r\n  questionTextFr?: string;\r\n  questionTextAr?: string;\r\n}\r\n\r\n/** Single skill result; must have either subSkills or questions. */\r\nexport interface SubmittedSkillResultPayload {\r\n  skillCode: string;\r\n  skillOrder: number;\r\n  passed: boolean;\r\n  titleFr?: string;\r\n  titleAr?: string;\r\n  descriptionFr?: string;\r\n  descriptionAr?: string;\r\n  subSkills?: SubmittedSkillResultPayload[];\r\n  questions?: SubmittedQuestionResultPayload[];\r\n}\r\n\r\n/**\r\n * Partner payload for submit assessment results.\r\n * academicYearId and periodWeekSubjectId are NOT included; the SuperApp\r\n * adds them when calling the backend.\r\n */\r\nexport interface SubmitAssessmentResultsPartnerPayload {\r\n  studentId: string;\r\n  partnerCode: string;\r\n  attemptId: string;\r\n  isAser?: boolean;\r\n  totalSkillsInWeek: number;\r\n  skills: SubmittedSkillResultPayload[];\r\n}\r\n\r\n/** Success response from SubmitAssessmentResults endpoint. */\r\nexport interface SubmitAssessmentResultsResponse {\r\n  attemptId: string;\r\n  isDuplicate: boolean;\r\n  status: string;\r\n  message: string | null;\r\n  serverTimeUtc: string;\r\n}\r\n\r\n/** ValidationProblemDetails (400). */\r\nexport interface ValidationProblemDetails {\r\n  type?: string;\r\n  title?: string;\r\n  status: number;\r\n  detail?: string;\r\n  instance?: string;\r\n  errors?: Record<string, string[]>;\r\n}\r\n\r\n/** ProblemDetails (404, 409, 422, 429, 500). */\r\nexport interface ProblemDetails {\r\n  type?: string;\r\n  title?: string;\r\n  status?: number;\r\n  detail?: string;\r\n  instance?: string;\r\n  [key: string]: unknown;\r\n}\r\n\r\n/**\r\n * Result of calling submit: either the success response or an error response\r\n * with statusCode and body as returned by the backend.\r\n */\r\nexport type SubmitAssessmentResultsApiResult =\r\n  | { ok: true; statusCode: number; body: SubmitAssessmentResultsResponse }\r\n  | {\r\n      ok: false;\r\n      statusCode: number;\r\n      body: ValidationProblemDetails | ProblemDetails;\r\n    };\r\n\r\n/** Message types for iframe/Capacitor communication. */\r\nexport enum AssessmentMessageType {\r\n  REQUEST = \"assessment:submit-request\",\r\n  RESPONSE = \"assessment:submit-response\",\r\n}\r\n\r\n/** Message sent from partner to SuperApp. */\r\nexport interface AssessmentSubmitRequestMessage {\r\n  type: AssessmentMessageType.REQUEST;\r\n  requestId: string;\r\n  payload: SubmitAssessmentResultsPartnerPayload;\r\n  timestamp: number;\r\n}\r\n\r\n/** Message sent from SuperApp to partner (wraps backend result). */\r\nexport interface AssessmentSubmitResponseMessage {\r\n  type: AssessmentMessageType.RESPONSE;\r\n  requestId: string;\r\n  /** HTTP status code from the backend call. */\r\n  statusCode: number;\r\n  /** Exact response body from the backend (success or error). */\r\n  body: SubmitAssessmentResultsResponse | ValidationProblemDetails | ProblemDetails;\r\n  timestamp: number;\r\n}\r\n"],"names":["QuestionRole","AssessmentMessageType"],"mappings":";;AAAA;;;;AAIG;AAEH;AACYA;AAAZ,CAAA,UAAY,YAAY,EAAA;AACtB,IAAA,YAAA,CAAA,YAAA,CAAA,aAAA,CAAA,GAAA,CAAA,CAAA,GAAA,aAAe;AACf,IAAA,YAAA,CAAA,YAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAc;AACd,IAAA,YAAA,CAAA,YAAA,CAAA,aAAA,CAAA,GAAA,CAAA,CAAA,GAAA,aAAe;AACf,IAAA,YAAA,CAAA,YAAA,CAAA,OAAA,CAAA,GAAA,CAAA,CAAA,GAAA,OAAS;AACX,CAAC,EALWA,oBAAY,KAAZA,oBAAY,GAAA,EAAA,CAAA,CAAA;AA0FxB;AACYC;AAAZ,CAAA,UAAY,qBAAqB,EAAA;AAC/B,IAAA,qBAAA,CAAA,SAAA,CAAA,GAAA,2BAAqC;AACrC,IAAA,qBAAA,CAAA,UAAA,CAAA,GAAA,4BAAuC;AACzC,CAAC,EAHWA,6BAAqB,KAArBA,6BAAqB,GAAA,EAAA,CAAA,CAAA;;"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@superapp_men/submit-assessment-results",
+  "version": "1.0.0",
+  "description": "Submit assessment results from SuperApp partner applications via iframe/Capacitor",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./superapp": {
+      "import": "./dist/superapp.esm.js",
+      "require": "./dist/superapp.js",
+      "types": "./dist/superapp.d.ts"
+    }
+  },
+  "files": ["dist", "README.md"],
+  "scripts": {
+    "build": "rollup -c rollup.config.mjs",
+    "dev": "rollup -c rollup.config.mjs -w",
+    "prepublishOnly": "npm run build",
+    "publish:package": "npm run build && npm publish --access public"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": ["superapp", "assessment", "partner-apps", "iframe", "capacitor"],
+  "author": "SuperApp Team",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "rollup": "^4.0.0",
+    "rollup-plugin-dts": "^6.0.0",
+    "tslib": "^2.6.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {},
+  "dependencies": {}
+}