feat: warn for primitive array resources

src/adapters/normalized-adapter.test.ts

@@ -51,6 +51,16 @@ await test('read removes $schema and normalizes ids', async () => {
   assert.notEqual(posts[1]?.['id'], '')
 })
 
+await test('read preserves primitive array items', async () => {
+  const adapter = new StubAdapter({
+    roles: ['admin', 'user'],
+  })
+
+  const normalized = await new NormalizedAdapter(adapter).read()
+
+  assert.deepEqual(normalized?.['roles'], ['admin', 'user'])
+})
+
 await test('write always overwrites $schema', async () => {
   const adapter = new StubAdapter(null)
   const normalizedAdapter = new NormalizedAdapter(adapter)

src/adapters/normalized-adapter.ts

@@ -1,10 +1,10 @@
 import type { Adapter } from 'lowdb'
 
 import { randomId } from '../random-id.ts'
-import type { Data, Item } from '../service.ts'
+import { isItem, type Data, type Item } from '../service.ts'
 
 export const DEFAULT_SCHEMA_PATH = './node_modules/json-server/schema.json'
-export type RawData = Record<string, Item[] | Item | string | undefined> & {
+export type RawData = Record<string, Item[] | Item | string | unknown[] | undefined> & {
   $schema?: string
 }
 
@@ -27,6 +27,10 @@ export class NormalizedAdapter implements Adapter<Data> {
     for (const value of Object.values(data)) {
       if (Array.isArray(value)) {
         for (const item of value) {
+          if (!isItem(item)) {
+            continue
+          }
+
           if (typeof item['id'] === 'number') {
             item['id'] = item['id'].toString()
           }

src/bin.ts

@@ -16,6 +16,7 @@ import { NormalizedAdapter } from "./adapters/normalized-adapter.ts";
 import type { RawData } from "./adapters/normalized-adapter.ts";
 import { Observer } from "./adapters/observer.ts";
 import { createApp } from "./app.ts";
+import { formatPrimitiveArrayWarning, primitiveArrayResourceNames } from "./primitive-array-warning.ts";
 import type { Data } from "./service.ts";
 
 function help() {
@@ -139,6 +140,10 @@ const observer = new Observer(new NormalizedAdapter(adapter));
 const db = new Low<Data>(observer, {});
 await db.read();
 
+for (const name of primitiveArrayResourceNames(db.data)) {
+  console.log(chalk.yellow(formatPrimitiveArrayWarning(name)));
+}
+
 // Create app
 const app = createApp(db, { logger: false, static: staticArr });
 

src/primitive-array-warning.test.ts

@@ -0,0 +1,26 @@
+import assert from 'node:assert/strict'
+import test from 'node:test'
+
+import type { Data } from './service.ts'
+import {
+  formatPrimitiveArrayWarning,
+  primitiveArrayResourceNames,
+} from './primitive-array-warning.ts'
+
+await test('primitiveArrayResourceNames returns resources with primitive array items', () => {
+  const data = {
+    roles: ['admin', 'user'],
+    posts: [{ id: '1', title: 'post' }],
+    mixed: [{ id: '1' }, null],
+    profile: { name: 'Ada' },
+  } as unknown as Data
+
+  assert.deepEqual(primitiveArrayResourceNames(data), ['roles', 'mixed'])
+})
+
+await test('formatPrimitiveArrayWarning describes the resource problem', () => {
+  assert.equal(
+    formatPrimitiveArrayWarning('roles'),
+    'Warning: "roles" contains primitive values. Resources should usually be arrays of objects with id fields.',
+  )
+})

src/primitive-array-warning.ts

@@ -0,0 +1,15 @@
+import { isItem, type Data } from './service.ts'
+
+export function primitiveArrayResourceNames(data: Data): string[] {
+  return Object.entries(data).flatMap(([name, value]) => {
+    if (Array.isArray(value) && value.some((item: unknown) => !isItem(item))) {
+      return [name]
+    }
+
+    return []
+  })
+}
+
+export function formatPrimitiveArrayWarning(name: string): string {
+  return `Warning: "${name}" contains primitive values. Resources should usually be arrays of objects with id fields.`
+}