chore(release): v0.1.1 (#6)

.github/workflows/commits.yml

@@ -15,11 +15,13 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+      - name: Enable corepack before running setup-node
+        run: corepack enable
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ vars.NODE_VERSION }}
           cache: 'yarn'
-      - name: Enable corepack
+      - name: Ensure corepack is used
         run: corepack enable
       - name: Install dependencies
         run: yarn install --immutable

.github/workflows/deploy-template.yml

@@ -27,12 +27,14 @@ jobs:
     concurrency: ${{ inputs.environment }}
     steps:
       - uses: actions/checkout@v4
+      - name: Enable corepack before running setup-node
+        run: corepack enable
       - name: Setup Node ${{ vars.NODE_VERSION }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ vars.NODE_VERSION }}
           cache: 'yarn'
-      - name: Enable corepack
+      - name: Ensure corepack is used
         run: corepack enable
       - name: Install dependencies
         run: yarn install --immutable

.github/workflows/node.yml

@@ -13,11 +13,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Enable corepack before running setup-node
+        run: corepack enable
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ vars.NODE_VERSION }}
           cache: 'yarn'
-      - name: Enable corepack
+      - name: Ensure corepack is used
         run: corepack enable
       - name: Install dependencies
         run: yarn install --immutable
@@ -32,11 +34,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Enable corepack before running setup-node
+        run: corepack enable
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ vars.NODE_VERSION }}
           cache: 'yarn'
-      - name: Enable corepack
+      - name: Ensure corepack is used
         run: corepack enable
       - name: Install dependencies
         run: yarn install --immutable
@@ -50,11 +54,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Enable corepack before running setup-node
+        run: corepack enable
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ vars.NODE_VERSION }}
           cache: 'yarn'
-      - name: Enable corepack
+      - name: Ensure corepack is used
         run: corepack enable
       - name: Install dependencies
         run: yarn install --immutable

.github/workflows/prchecks.yml

@@ -14,11 +14,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Enable corepack before running setup-node
+        run: corepack enable
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ vars.NODE_VERSION }}
           cache: 'yarn'
-      - name: Enable corepack
+      - name: Ensure corepack is used
         run: corepack enable
       - name: Install dependencies
         run: yarn install --immutable

package.json

@@ -1,6 +1,6 @@
 {
   "name": "plantguard-api",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "The API backend for PlantGuard, an IoT plant water monitoring system, powered by Cloudflare Workers.",
   "author": {
     "name": "NexGenius",

src/devices/register-device.ts

@@ -23,7 +23,7 @@ export async function registerDevice(db: KVNamespace, user: User, req: DeviceReg
   const deviceKey = createDeviceKey(user.id, device.id);
 
   await db.put(deviceKey, JSON.stringify(device), { metadata });
-  await db.put(serialNumberKey, device.userId);
+  await db.put(serialNumberKey, device.id);
 
   return device;
 }

src/devices/router.ts

@@ -5,13 +5,15 @@ import {
   DeviceListQuery,
   DeviceListResponse,
   DeviceListResponseData,
+  DeviceMeasurement,
+  DeviceMeasurementRequest,
   DeviceMetadata,
   DeviceUpdateRequest,
 } from "../models/device";
 import { assertModel, parseBody } from "../utils/model-parser";
 import { PaginationMetadata } from "../utils/pagination";
 import { createAuthenticatedRouter } from "../utils/router";
-import { createDeviceKey, createSerialNumberKey, isValidDeviceId, parseDeviceKey } from "./utils";
+import { createDeviceKey, createMeasurementKey, createSerialNumberKey, isValidDeviceId, parseDeviceKey } from "./utils";
 
 const router = createAuthenticatedRouter({ base: "/api/v1/devices" });
 
@@ -43,6 +45,32 @@ router.get("/", async (request, env): Promise<DeviceListResponse> => {
   return { data, pagination };
 });
 
+router.post("/measure", async (request, env) => {
+  const { serialNumber, ...rest } = await parseBody(request, DeviceMeasurementRequest);
+  const serialNumberKey = createSerialNumberKey(serialNumber);
+
+  const deviceId = await env.devices.get(serialNumberKey);
+  if (!deviceId) {
+    throw new StatusError(404);
+  }
+
+  // This indirectly checks if the current user is the owner of the device
+  const deviceKey = createDeviceKey(request.user.id, deviceId);
+  const device = await env.devices.get(deviceKey);
+  if (!device) {
+    throw new StatusError(404);
+  }
+
+  const measurementKey = createMeasurementKey(deviceId);
+  const measurement: DeviceMeasurement = {
+    ...rest,
+    date: new Date(),
+  };
+  await env.devices.put(measurementKey, JSON.stringify(measurement));
+
+  return new Response(undefined, { status: 204 });
+});
+
 router.get("/:id", async (request, env): Promise<Device> => {
   const { id } = request.params;
   if (!isValidDeviceId(id)) {
@@ -58,6 +86,28 @@ router.get("/:id", async (request, env): Promise<Device> => {
   return Device.parse(JSON.parse(device));
 });
 
+router.get("/:id/current", async (request, env): Promise<Response | DeviceMeasurement> => {
+  const { id } = request.params;
+  if (!isValidDeviceId(id)) {
+    throw new StatusError(400, "Invalid ID");
+  }
+
+  // This indirectly checks if the current user is the owner of the device
+  const deviceKey = createDeviceKey(request.user.id, id);
+  const device = await env.devices.get(deviceKey);
+  if (!device) {
+    throw new StatusError(404);
+  }
+
+  const measurementKey = createMeasurementKey(id);
+  const measurement = await env.devices.get(measurementKey);
+  if (!measurement) {
+    return new Response(undefined, { status: 204 });
+  }
+
+  return DeviceMeasurement.parse(JSON.parse(measurement));
+});
+
 router.patch("/:id", async (request, env): Promise<Device> => {
   const { id } = request.params;
   if (!isValidDeviceId(id)) {

src/devices/utils.ts

@@ -20,6 +20,12 @@ export function createSerialNumberKey(serialNumber: string): string {
   return createKey([serialNumberKeyPrefix, serialNumber]);
 }
 
+const measurementKeyPrefix = "measure";
+
+export function createMeasurementKey(deviceId: string): string {
+  return createKey([measurementKeyPrefix, deviceId]);
+}
+
 export function parseDeviceKey(key: string): DeviceKey {
   const split = splitKey(key);
   if (split[0] !== deviceKeyPrefix) {

src/models/device.ts

@@ -26,7 +26,7 @@ export const DeviceListResponseData = Device.pick({ id: true, name: true });
 export type DeviceListResponseData = z.infer<typeof DeviceListResponseData>;
 
 export const DeviceListResponse = z.object({
-  data: z.array(DeviceMetadata),
+  data: z.array(DeviceListResponseData),
   pagination: PaginationMetadata,
 });
 export type DeviceListResponse = z.infer<typeof DeviceListResponse>;
@@ -80,3 +80,15 @@ export const DevicePairConfirmRequest = DevicePairRequest.pick({ code: true }).e
   name: Device.shape.name,
 });
 export type DevicePairConfirmRequest = z.infer<typeof DevicePairConfirmRequest>;
+
+export const DeviceMeasurement = z.object({
+  temperature: z.number(),
+  humidity: z.number(),
+  date: ZodDate,
+});
+export type DeviceMeasurement = z.infer<typeof DeviceMeasurement>;
+
+export const DeviceMeasurementRequest = DeviceMeasurement.omit({ date: true }).merge(
+  Device.pick({ serialNumber: true }),
+);
+export type DeviceMeasurementRequest = z.infer<typeof DeviceMeasurementRequest>;

src/pair/router.ts

@@ -23,8 +23,8 @@ router.post("/init", async (request, env): Promise<DevicePairInitResponse> => {
   const req = await parseBody(request, DevicePairInitRequest);
   const serialNumberKey = createSerialNumberKey(req.serialNumber);
 
-  const possibleOwner = await env.devices.get(serialNumberKey);
-  if (possibleOwner) {
+  const possibleId = await env.devices.get(serialNumberKey);
+  if (possibleId) {
     throw new StatusError(400, "The serial number has already been registered");
   }