feat: Add manufacturer.annotations (#15)

* feat: Add manufacturer.annotations * ci: Generate code * Store annotation_map --------- Co-authored-by: Seam Bot <devops@getseam.com>
seamapi · Dec 27, 2023 · 3805e57 · 3805e57
1 parent b84754d
commit 3805e57
Show file tree

Hide file tree

Showing 10 changed files with 241 additions and 24 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -70,7 +70,7 @@
   },
   "devDependencies": {
     "@seamapi/logger": "^1.9.2",
-    "@seamapi/types": "^1.68.0",
+    "@seamapi/types": "^1.71.0",
     "@tsconfig/next": "^2.0.0",
     "@types/get-pixels": "^3.3.2",
     "@types/lodash": "^4.14.202",

diff --git a/public/openapi.json b/public/openapi.json
diff --git a/src/lib/database/seed-from-api.ts b/src/lib/database/seed-from-api.ts
@@ -28,9 +28,13 @@ export const seedDatabaseFromApi = async (
 
     if (hasManufacturer) continue
 
-    const { logo, ...rest } = manufacturer
+    const { logo, annotations, ...rest } = manufacturer
     db.addManufacturer({
       ...rest,
+      annotation_map: annotations.reduce(
+        (acc, cur) => ({ ...acc, [cur.annotation_code]: cur }),
+        {},
+      ),
       logo:
         logo != null
           ? {

diff --git a/src/lib/database/seed.ts b/src/lib/database/seed.ts
@@ -19,6 +19,12 @@ export const seedDatabase = (db: Database) => {
     integration_support_level: "stable",
     is_connect_webview_supported: true,
     requires_seam_support_to_add_account: false,
+    annotation_map: {
+      subscription_required: {
+        annotation_code: "subscription_required",
+        message: "Need to subscribe",
+      },
+    },
   })
 
   const device_model = db.addDeviceModel({

diff --git a/src/lib/models.ts b/src/lib/models.ts
@@ -9,10 +9,16 @@ export const stored_image_reference = z.object({
 export type StoredImageReference = z.infer<typeof stored_image_reference>
 
 export const stored_manufacturer = schemas.manufacturer
-  .omit({ device_model_count: true, logo: true })
+  .omit({ device_model_count: true, logo: true, annotations: true })
   .merge(
     z.object({
       logo: stored_image_reference.optional(),
+      annotation_map: z
+        .record(
+          schemas.manufacturer_annotation_code,
+          schemas.manufacturer_annotation,
+        )
+        .optional(),
     }),
   )
 export type StoredManufacturer = z.infer<typeof stored_manufacturer>

diff --git a/src/lib/public-mappings/manufacturer.ts b/src/lib/public-mappings/manufacturer.ts
@@ -18,6 +18,7 @@ export const publicMapManufacturer = ({
 }: PublicMapManufacturerOptions): Manufacturer => ({
   manufacturer_id: manufacturer.manufacturer_id,
   display_name: manufacturer.display_name,
+  annotations: Object.values(manufacturer.annotation_map ?? {}),
   logo: manufacturer.logo
     ? publicMapImageReference({
         image: manufacturer.logo,

diff --git a/src/route-types.ts b/src/route-types.ts
@@ -75,6 +75,10 @@ export type Routes = {
             | "inquire"
           is_connect_webview_supported: boolean
           requires_seam_support_to_add_account: boolean
+          annotations: {
+            annotation_code: "subscription_required"
+            message: string
+          }[]
         }
         is_device_supported: boolean
         display_name: string
@@ -235,6 +239,10 @@ export type Routes = {
             | "inquire"
           is_connect_webview_supported: boolean
           requires_seam_support_to_add_account: boolean
+          annotations: {
+            annotation_code: "subscription_required"
+            message: string
+          }[]
         }
         is_device_supported: boolean
         display_name: string
@@ -374,6 +382,10 @@ export type Routes = {
         is_connect_webview_supported: boolean
         requires_seam_support_to_add_account: boolean
         device_model_count: number
+        annotations: {
+          annotation_code: "subscription_required"
+          message: string
+        }[]
       }
     }
   }
@@ -413,6 +425,10 @@ export type Routes = {
         is_connect_webview_supported: boolean
         requires_seam_support_to_add_account: boolean
         device_model_count: number
+        annotations: {
+          annotation_code: "subscription_required"
+          message: string
+        }[]
       }[]
     }
   }

diff --git a/test/api/v1/manufacturers/get.test.ts b/test/api/v1/manufacturers/get.test.ts
@@ -16,4 +16,7 @@ test("GET /v1/manufacturers/get", async (t: ExecutionContext) => {
 
   t.is(data.manufacturer.manufacturer_id, manufacturer.manufacturer_id)
   t.is(data.manufacturer.device_model_count, 1)
+  t.is(data.manufacturer.annotations.length, 1)
+  const annotation_message = data.manufacturer.annotations[0]?.message ?? ""
+  t.true(annotation_message.length > 0)
 })
diff --git a/test/seed.test.ts b/test/seed.test.ts
@@ -33,6 +33,7 @@ test("seed database from api", async (t) => {
     integration_support_level: "stable",
     is_connect_webview_supported: true,
     requires_seam_support_to_add_account: false,
+    annotation_map: {},
   })
 
   const device_model = apiDb.addDeviceModel({