Auto-generate score: [Score Agent] Add BMI

src/scores/bmi/README.md

@@ -0,0 +1,18 @@
+# Body Mass Index (BMI)
+
+## Description
+
+The Body Mass Index (BMI) is a calculation derived from weight and height. The BMI is an indicator of body fatness for most people.
+
+## Formula
+
+BMI = Weight (kg) / Height (m)\^2
+
+## Instructions
+
+- Input the weight in kilograms.
+- Input the height in centimeters.
+
+## Output
+
+- The BMI score (kg/m²)

src/scores/bmi/bmi.test.ts

@@ -0,0 +1,61 @@
+import { ScoreLibrary } from '../library'
+import { bmi } from './bmi'
+import { Score } from '../../classes'
+import { ZodError } from 'zod'
+
+const bmi_calculation = new Score(bmi)
+
+describe('bmi', function () {
+  it('bmi calculation function should be available as a calculation', function () {
+    expect(ScoreLibrary).toHaveProperty('bmi')
+  })
+
+  describe('validation', function () {
+    describe('the score includes the correct input fields', function () {
+      it('should have all the expected input ids configured', function () {
+        const EXPECTED_INPUT_IDS = ['weight', 'height']
+        const configured_input_ids = Object.keys(
+          bmi_calculation.inputSchemaAsObject.shape,
+        )
+
+        expect(EXPECTED_INPUT_IDS).toEqual(configured_input_ids)
+      })
+    })
+
+    describe('when called with invalid data', function () {
+      it('should throw a ZodError', function () {
+        expect(() =>
+          bmi_calculation.calculate({
+            payload: {
+              weight: 'hello',
+            },
+          }),
+        ).toThrow(ZodError)
+      })
+
+      it('should throw a ZodError when height is missing', function () {
+        expect(() =>
+          bmi_calculation.calculate({
+            payload: {
+              weight: 70,
+            },
+          }),
+        ).toThrow(ZodError)
+      })
+    })
+  })
+
+  describe('score calculation', function () {
+    describe('when called with valid data', function () {
+      it('should return the correct BMI', function () {
+        const outcome = bmi_calculation.calculate({
+          payload: {
+            weight: 70,
+            height: 170,
+          },
+        })
+        expect(outcome.bmi).toEqual(24.22)
+      })
+    })
+  })
+})

src/scores/bmi/bmi.ts

@@ -0,0 +1,14 @@
+import { type ScoreType } from '../../types'
+import { BMI_INPUTS, BMI_OUTPUT } from './definition'
+
+export const bmi: ScoreType<typeof BMI_INPUTS, typeof BMI_OUTPUT> = {
+  name: 'Body Mass Index (BMI)',
+  readmeLocation: __dirname,
+  inputSchema: BMI_INPUTS,
+  outputSchema: BMI_OUTPUT,
+  calculate: ({ data }) => {
+    return {
+      bmi: data.weight / ((data.height / 100) ** 2),
+    }
+  }
+}

src/scores/bmi/definition/bmi_inputs.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod'
+import type { ScoreInputSchemaType } from '../../../types'
+
+export const BMI_INPUTS = {
+  weight: { 
+    label: { en: 'Weight (kg)' },
+    type: z.number().nonnegative(),
+    unit: 'kg',
+  },
+  height: { 
+    label: { en: 'Height (cm)' },
+    type: z.number().positive(),
+    unit: 'cm',
+  }
+} satisfies ScoreInputSchemaType

src/scores/bmi/definition/bmi_output.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod'
+import type { ScoreOutputSchemaType } from '../../../types'
+
+export const BMI_OUTPUT = {
+  bmi: { 
+    label: { en: 'Body Mass Index (BMI)' },
+    type: z.number(), 
+    unit: 'kg/m²' 
+  }
+} satisfies ScoreOutputSchemaType

src/scores/bmi/definition/bmi_subscales.ts

@@ -0,0 +1 @@
+// No subscales for BMI

src/scores/bmi/index.ts

@@ -1,2 +1 @@
-export { bmi as bmi_metric } from './metric/bmi'
-export { bmi_us as bmi_imperial } from './us/bmi'
+export * from './bmi'