@pocketprep/types 1.19.42 → 1.19.44

package/.github/scripts/pick-version.js

@@ -0,0 +1,14 @@
+// Usage: node pick-version.js <version on npm> <version in package.json>
+// Publishes the package.json version only when a PR raised its major or minor; otherwise bumps npm's patch.
+const [ published, requested ] = process.argv.slice(2).map(version => version.split('.').map(Number))
+
+const raisesMajor = requested[0] > published[0]
+const raisesMinor = requested[0] === published[0] && requested[1] > published[1]
+
+if (raisesMajor || raisesMinor) {
+    // respect the major/minor version bump that's already been committed
+    console.log(requested.join('.'))
+} else {
+    // just bump the patch version
+    console.log([ published[0], published[1], published[2] + 1 ].join('.'))
+}

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

@@ -7,18 +7,55 @@ on:
   push:
     branches:
     - master
+    # Only changes that reach consumers should publish; README/CI-only merges would otherwise ship an identical patch
+    paths:
+    - '**.ts'
+    - index.js
+    - package.json
+  workflow_dispatch:
+
+# Back-to-back merges must take turns, or both runs would pick the same patch version
+concurrency:
+  group: npm-publish
+  cancel-in-progress: false
 
 jobs:
   build-and-publish:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
+      # Check out the tip of master rather than the triggering commit, so a queued run
+      # sees the version commit pushed by the run before it
       - uses: actions/checkout@v2
+        with:
+          ref: master
       - uses: actions/setup-node@v2
         with:
           node-version: 24.22.1
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm run lint
+      - name: Pick version
+        id: version
+        run: |
+          published=$(npm view @pocketprep/types version)
+          requested=$(node -p "require('./package.json').version")
+          version=$(node .github/scripts/pick-version.js "$published" "$requested")
+          echo "npm has $published, package.json has $requested, publishing $version"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+      - name: Commit version
+        run: |
+          npm version "${{ steps.version.outputs.version }}" --no-git-tag-version --allow-same-version
+          if git diff --quiet -- package.json package-lock.json; then
+            exit 0
+          fi
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add package.json package-lock.json
+          git commit -m "v${{ steps.version.outputs.version }}"
+          git push origin master
+      # Publish after the push so a rejected push leaves nothing on npm, and a rerun starts clean
       - run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/API/StudyStats.d.ts

@@ -0,0 +1,21 @@
+import { TMockExamStudyStats, TStudyStats } from '../Study/Cloud'
+
+export interface FetchStudyStatsParams {
+    examMetadataId: string
+}
+
+/**
+ * The caller's study stats for one exam version. The same shape the Parse server returns under
+ * `studyStats` from `fetchUserData-v2` and `recordQuiz-v2`, so a client renders either source
+ * with one code path.
+ */
+export interface FetchStudyStatsResponse {
+    studyStats: {
+        standard: Omit<TStudyStats, 'examCommunityAverage'>
+        mockExam?: {
+            overall: TMockExamStudyStats
+            byMockExamId: { [mockExamId: string]: TMockExamStudyStats }
+        }
+        combined: Omit<TStudyStats, 'examCommunityAverage'>
+    }
+}

package/API/index.d.ts

@@ -7,3 +7,4 @@ export * from './Session'
 export * from './User'
 export * from './LevelUp'
 export * from './Billing'
+export * from './StudyStats'

package/README.md

@@ -1,2 +1,9 @@
 # Pocket Prep Types
 One repo, under TypeScript, with reuse and strict typing for all.
+
+## Versioning
+Don't bump the version for routine changes. Merging to `master` publishes to npm with the next patch version and
+commits that version back to `master`.
+
+For a minor or major release, run `npm run minor` or `npm run major` in your PR. The publish workflow uses that
+version as written.

package/Study/Cloud.d.ts

@@ -433,7 +433,7 @@ export type fetchSerialQuestionInfoLib = (params: { compositeKey: string }) => {
     }
 }
 
-export type fetchSerialQuestionInfoLibV2 = (params: { 
+export type fetchSerialQuestionInfoLibV2 = (params: {
     compositeKey?: string
     examMetadataId?: string
 }) => {
@@ -543,7 +543,7 @@ export type resetUserExamProgress = (params: { appId: string }) => (
     UserExamMetadata | TEUserAppMetadata | undefined
 )
 
-export type resetQuizProgress = (params: { 
+export type resetQuizProgress = (params: {
     examGuid: string
     examMetadataId?: string
 }) => UserExamMetadata | undefined
@@ -691,14 +691,14 @@ export type fetchMockExams = () => MockExam[]
 
 export type fetchMockExamQuestions = (params: { mockExamId: string }) => ExamData[]
 
-export type fetchMockExamQuestionsV2 = (params: { 
+export type fetchMockExamQuestionsV2 = (params: {
     mockExamId: string
     includeMatrixQuestions?: boolean
     includeMPMCQuestions?: boolean
     includeBuildListQuestions?: boolean
 }) => Question[]
 
-export type fetchMockExamQuestionsV3 = (params: { 
+export type fetchMockExamQuestionsV3 = (params: {
     mockExamId: string
     includeMatrixQuestions?: boolean
     includeMPMCQuestions?: boolean
@@ -792,7 +792,7 @@ export type fetchReferralInfo = (params: { bundleId: string }) => {
     code: string
 }
 
-export type fetchPrebuiltQuizQuestions = (params: { 
+export type fetchPrebuiltQuizQuestions = (params: {
     prebuiltQuizId: string
     includeMPMCQuestions?: boolean
     includeBuildListQuestions?: boolean
@@ -864,7 +864,7 @@ export type fetchUserExamMetadata = () => Promise<UserExamMetadataJSON[]>
 
 export type deleteUserExamData = (params: { examGuid: string }) => Promise<void>
 
-export type fetchRecallQuizQuestions = (params: { 
+export type fetchRecallQuizQuestions = (params: {
     examMetadataId: string
     includeMPMCQuestions?: boolean
     includeBuildListQuestions?: boolean
@@ -878,19 +878,36 @@ export type upsertUserExamBackground = (params: {
     hasTakenExam?: boolean
 }) => UserExamBackgroundJSON
 
-export type fetchConceptQuizQuestions = (params: { 
+export type fetchConceptQuizQuestions = (params: {
     conceptQuizId: string
     questionCount: number
 }) => QuestionJSON[]
 
+export type TSelectableConcept = {
+    conceptQuizId: string
+    concept: string
+    serials: string[]
+}
+
 export type fetchBYOConcepts = (params: {
     examMetadataId: string
 }) => {
-    concepts: {
-        conceptQuizId: string
-        concept: string
-        serials: string[]
-    }[]
+    concepts: TSelectableConcept[]
+}
+
+export type TWeakestConcept = {
+    conceptQuizId: string
+    concept: string
+    totalAnswersCount: number
+    totalCorrectAnswersCount: number
+    averageScore: number
+}
+
+export type fetchWeakestConcepts = (params: {
+    examMetadataId: string
+}) => {
+    examHasConcepts: boolean
+    weakestConcepts: TWeakestConcept[]
 }
 
 export type fetchReadinessReportDetails = (params: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pocketprep/types",
-  "version": "1.19.42",
+  "version": "1.19.44",
   "description": "Pocket Prep type declarations",
   "repository": {
     "type": "git",
@@ -18,7 +18,9 @@
   "scripts": {
     "lint": "eslint '**/*.ts'",
     "types-copy": "pwd | pbcopy",
-    "patch": "npm version patch --no-git-tag-version"
+    "patch": "npm version patch --no-git-tag-version",
+    "minor": "npm version minor --no-git-tag-version",
+    "major": "npm version major --no-git-tag-version"
   },
   "homepage": "https://github.com/Pocket-Prep/types#readme",
   "dependencies": {