improve type safety

Author: cschroeter

packages/cli/src/install.ts

@@ -10,13 +10,13 @@ interface Args {
   config: ParkUIConfig
 }
 
-export const installRegistryItem = ({ item, config }: Args) =>
+export const installRegistryItem = ({ item: { files, pandaConfig }, config }: Args) =>
   Effect.all([
     createFiles({
-      files: item.files,
+      files,
       config,
     }),
-    updatePandaConfig(item.panda),
+    updatePandaConfig(pandaConfig),
   ])
 
 interface CreateFilesArgs {

packages/cli/src/panda.ts

@@ -9,9 +9,9 @@ import {
   SyntaxKind,
 } from 'ts-morph'
 import { PandaConfigInvalid, PandaConfigNotFound } from './error'
-import type { PandaConfiguration } from './schema'
+import type { JsonValue, PandaConfig } from './schema'
 
-export const updatePandaConfig = ({ imports = [], config = {} }: PandaConfiguration = {}) => {
+export const updatePandaConfig = ({ imports = [], extension = {} }: PandaConfig = {}) => {
   return getConfigPath().pipe(
     Effect.flatMap((configPath) =>
       pipe(
@@ -77,7 +77,9 @@ export const updatePandaConfig = ({ imports = [], config = {} }: PandaConfigurat
                     catch: () => PandaConfigInvalid,
                   }),
                 ),
-                Effect.tap((configObj) => Effect.sync(() => mergeObjectLiteral(configObj, config))),
+                Effect.tap((objLiteral) =>
+                  Effect.sync(() => mergeObjectLiteral(objLiteral, extension)),
+                ),
                 Effect.tap(() => sourceFile.organizeImports()),
                 Effect.flatMap(() =>
                   Effect.tryPromise({
@@ -111,10 +113,10 @@ const getConfigPath = () =>
     ),
   )
 
-const mergeObjectLiteral = (
-  objLiteral: ObjectLiteralExpression,
-  update: Record<string, unknown>,
-) => {
+const mergeObjectLiteral = (objLiteral: ObjectLiteralExpression, update: JsonValue) => {
+  if (typeof update !== 'object' || update === null || Array.isArray(update)) {
+    throw new Error('update must be an object')
+  }
   for (const [key, value] of Object.entries(update)) {
     let prop = objLiteral.getProperty(key) as PropertyAssignment | undefined
 
@@ -129,7 +131,7 @@ const mergeObjectLiteral = (
         prop
           .setInitializer('{}')
           .getInitializerIfKind(SyntaxKind.ObjectLiteralExpression)) as ObjectLiteralExpression
-      mergeObjectLiteral(nested, value as Record<string, unknown>)
+      mergeObjectLiteral(nested, value)
     } else {
       if (prop) {
         const existingObj = prop.getInitializerIfKind(SyntaxKind.ObjectLiteralExpression)

packages/cli/src/schema.ts

@@ -31,7 +31,13 @@ const moduleDeclaration = z.discriminatedUnion('type', [
 ])
 export type ModuleDeclaration = z.infer<typeof moduleDeclaration>
 
-type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue }
+export type JsonValue =
+  | string
+  | number
+  | boolean
+  | null
+  | JsonValue[]
+  | { [key: string]: JsonValue }
 
 const jsonValue: z.ZodType<JsonValue> = z.lazy(() =>
   z.union([
@@ -45,7 +51,6 @@ const jsonValue: z.ZodType<JsonValue> = z.lazy(() =>
 )
 
 const indexFile = z.object({
-  fileName: z.string(),
   exports: z.array(moduleDeclaration).optional(),
   imports: z.array(moduleDeclaration).optional(),
 })
@@ -60,14 +65,10 @@ const registryFile = z.object({
 export type RegistryFile = z.infer<typeof registryFile>
 
 const pandaConfig = z.object({
-  theme: jsonValue.optional(),
-})
-
-const pandaConfiguration = z.object({
-  config: pandaConfig.optional(),
+  extension: jsonValue.optional(),
   imports: z.array(moduleDeclaration).optional(),
 })
-export type PandaConfiguration = z.infer<typeof pandaConfiguration>
+export type PandaConfig = z.infer<typeof pandaConfig>
 
 export const registryItem = z.object({
   id: z.string(),
@@ -78,7 +79,7 @@ export const registryItem = z.object({
   devDependencies: z.array(z.string()).optional(),
   registryDependencies: z.array(z.string()).optional(),
   files: z.array(registryFile).optional(),
-  panda: pandaConfiguration.optional(),
+  pandaConfig: pandaConfig.optional(),
   categories: z.array(z.string()).optional(),
 })
 export type RegistryItem = z.infer<typeof registryItem>

website/public/schema/registry-item.json

@@ -192,22 +192,23 @@
       },
       "description": "The main payload of the registry item. This is an array of files that are part of the registry item"
     },
-    "panda": {
+    "pandaConfig": {
       "type": "object",
       "properties": {
-        "config": {
-          "type": "object",
-          "properties": {
-            "theme": {
-              "$ref": "#/definitions/JsonValue",
-              "description": "The theme configuration for the panda item"
-            }
+        "extension": {
+          "$ref": "#/definitions/JsonValue",
+          "description": "The theme configuration for the panda item"
+        },
+        "imports": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ModuleDeclaration"
           },
-          "additionalProperties": false
+          "description": "The module imports required for the panda configuration"
         }
       },
       "additionalProperties": false,
-      "description": "The panda configuration for the registry item. This is an object with a config property."
+      "description": "The panda configuration for the registry item."
     },
     "categories": {
       "type": "array",