fix(meta): strip null values from unpackMeta

harlan-zw · Dec 23, 2022 · 4b5c734 · 4b5c734
1 parent 5df1205
commit 4b5c734
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/packages/schema/src/metaFlat.ts b/packages/schema/src/metaFlat.ts
@@ -622,6 +622,10 @@ export interface MetaFlat {
   }
 }
 
-export type MetaFlatInput = Partial<MetaFlat>
+// make MetaFlat record entries also possibly be null
+type MetaFlatNullable = {
+  [K in keyof MetaFlat]: MetaFlat[K] | null
+}
+export type MetaFlatInput = Partial<MetaFlatNullable>
 
 export type AsyncMetaFlatInput = MaybePromiseProps<MetaFlatInput>
diff --git a/packages/zhead/src/meta/unpack.ts b/packages/zhead/src/meta/unpack.ts
@@ -8,7 +8,7 @@ import { MetaPackingSchema, resolveMetaKeyType } from './utils'
  * @param input
  */
 export function unpackMeta<T extends MetaFlatInput>(input: T): Required<Head>['meta'] {
-  return unpackToArray((input), {
+  const meta = unpackToArray((input), {
     key({ key }) {
       return resolveMetaKeyType(key) as string
     },
@@ -19,6 +19,9 @@ export function unpackMeta<T extends MetaFlatInput>(input: T): Required<Head>['m
       return MetaPackingSchema[key]?.keyValue || fixKeyCase(key)
     },
     resolveValueData({ value, key }) {
+      if (value === null) {
+        return '_null'
+      }
       if (typeof value === 'object') {
         const definition = MetaPackingSchema[key]
 
@@ -31,6 +34,8 @@ export function unpackMeta<T extends MetaFlatInput>(input: T): Required<Head>['m
             entrySeparator: ', ',
             keyValueSeparator: '=',
             resolve({ value, key }) {
+              if (value === null)
+                return ''
               if (typeof value === 'boolean')
                 return `${key}`
             },
@@ -41,4 +46,6 @@ export function unpackMeta<T extends MetaFlatInput>(input: T): Required<Head>['m
       return typeof value === 'number' ? value.toString() : value
     },
   })
+  // remove keys with defined but empty content
+  return meta.filter(v => typeof v.content === 'undefined' || v.content !== '_null')
 }
diff --git a/test/zhead/unpackMeta.ts → test/zhead/unpackMeta.test.ts b/test/zhead/unpackMeta.ts → test/zhead/unpackMeta.test.ts
@@ -2,6 +2,22 @@ import { describe, it } from 'vitest'
 import { packMeta, unpackMeta } from 'zhead'
 
 describe('unpackMeta', () => {
+  it('null values', () => {
+    const tags = unpackMeta({
+      ogTitle: 'should stay',
+      description: null
+    })
+
+    expect(tags).toMatchInlineSnapshot(`
+      [
+        {
+          "content": "should stay",
+          "property": "og:title",
+        },
+      ]
+    `)
+  })
+
   it('charset', () => {
     const tags = unpackMeta({
       charset: 'utf-8',