fix: Unify some types

Unified some types across functions.
Fixed loadConfig to not being async.

Author: nicovitt

src/cli.ts

@@ -2,10 +2,9 @@ import 'dotenv/config';
 
 import pkg from "../package.json" with { type: "json" };
 
-// @ts-ignore
-import { Command } from 'commander';
+import { Command, } from 'commander';
 import { loadConfig, printConfig } from './features/config/index.js';
-import { del, down, typescript, up, type TypescriptConversionOptions } from './features/schema/index.js';
+import { del, down, typescript, up, type CLI_DeleteType, type CLI_DownType, type CLI_UpType, type TypescriptConversionOptions } from './features/schema/index.js';
 
 main().catch((error) => {
   console.error("Error: " + error.message);
@@ -23,8 +22,8 @@ async function main() {
   program
     .command("config")
     .description("Returns the current configuration")
-    .action(async () => {
-      await loadConfig(program.opts().configPath);
+    .action(() => {
+      loadConfig(program.opts().configPath);
 
       printConfig();
     });
@@ -38,8 +37,8 @@ async function main() {
     )
     .option("--ignore <ignore...>", "Class(es) to ignore", "")
     .description("Fetch the schema from Parse Server")
-    .action(async (schemaPath: string, options: { prefix?: string; ignore?: string[]; } | undefined) => {
-      await loadConfig(program.opts().configPath, {
+    .action(async (schemaPath: string, options: CLI_DownType | undefined) => {
+      loadConfig(program.opts().configPath, {
         operation: "down",
       });
 
@@ -57,8 +56,8 @@ async function main() {
     .option("--safe", "This will prevent destructive operations", "")
     .option("--deleteNonEmptyClass", "Delete non-empty classes", false)
     .description("Upload the local schema to Parse Server")
-    .action(async (schemaPath: string, options: { prefix: any; ignore: any; safe: any; deleteNonEmptyClass: any; }) => {
-      await loadConfig(program.opts().configPath, {
+    .action(async (schemaPath: string, options: CLI_UpType) => {
+      loadConfig(program.opts().configPath, {
         operation: "up",
       });
 
@@ -80,8 +79,8 @@ async function main() {
     )
     .option("--deleteNonEmptyClass", "Delete non-empty classes", false)
     .description("Delete the local schema from Parse Server")
-    .action(async (schemaPath: string, options: { prefix?: string; deleteNonEmptyClass?: boolean; } | undefined) => {
-      await loadConfig(program.opts().configPath);
+    .action(async (schemaPath: string, options: CLI_DeleteType | undefined) => {
+      loadConfig(program.opts().configPath);
 
       await del( schemaPath, options);
     });
@@ -100,7 +99,7 @@ async function main() {
     .option("--custom-class-field-types-config <path>", "Path to .json config file for custom class field types")
     .option("--verbose", "Enable verbose logging including dependency graph", false)
     .action(async (typescriptPath: string, options: TypescriptConversionOptions | undefined) => {
-       await loadConfig(program.opts().configPath);
+       loadConfig(program.opts().configPath);
 
       await typescript(typescriptPath, options);
     });

src/features/config/services/loadConfig.ts

@@ -10,10 +10,10 @@ import type { ConfigInterface } from "../index.js";
  * @param options Options for loading the config.
  * @returns The loaded config.
  */
-export async function loadConfig(
+export function loadConfig(
   configPath?: string,
-  options?: { operation: string }
-): Promise<ConfigInterface> {
+  options?: { operation: "down" | "up" }
+): ConfigInterface {
   const {
     PARSE_SERVER_APPLICATION_ID,
     PARSE_SERVER_MASTER_KEY,

src/features/schema/index.ts

@@ -20,3 +20,7 @@ export {
   type SetterType,
   type TypescriptConversionOptions,
 } from "./types/TypescriptConversionTypes.js";
+
+export { type CLI_DeleteType, type DeleteType } from "./types/DeleteTypes.js";
+export { type CLI_DownType, type DownType } from "./types/DownTypes.js";
+export { type CLI_UpType, type UpType } from "./types/UpTypes.js";

src/features/schema/services/del.ts

@@ -1,5 +1,10 @@
 import path from "path";
-import { deleteSchema, getLocalSchema, getRemoteSchema } from "../index.js";
+import {
+  deleteSchema,
+  getLocalSchema,
+  getRemoteSchema,
+  type DeleteType,
+} from "../index.js";
 
 /**
  * Deletes the schema from Parse Server.
@@ -9,13 +14,7 @@ import { deleteSchema, getLocalSchema, getRemoteSchema } from "../index.js";
  * @param options.prefix Only classes with the given prefix will be deleted. The prefix will be added to the class names in the local schema.
  * @param options.deleteNonEmptyClass Whether to delete non-empty classes when deleting a class. Default is
  */
-export async function del(
-  schemaPath: string,
-  options: {
-    prefix?: string;
-    deleteNonEmptyClass?: boolean;
-  } = {}
-) {
+export async function del(schemaPath: string, options: DeleteType = {}) {
   const localSchemaPath = schemaPath
     ? path.resolve(schemaPath)
     : path.resolve(".", "schema", "classes");

src/features/schema/services/down.ts

@@ -1,7 +1,7 @@
 import fs from "fs";
 import { mkdirp } from "mkdirp";
 import path from "path";
-import { getRemoteSchema } from "../index.js";
+import { getRemoteSchema, type DownType } from "../index.js";
 
 /**
  * Fetches the schema from Parse Server and saves it to a local file or folder.
@@ -11,13 +11,7 @@ import { getRemoteSchema } from "../index.js";
  * @param options.prefix Only classes with the given prefix will be pulled. The prefix will be removed from the class names in the local schema.
  * @param options.ignore Class(es) to ignore. You can use * at the end to ignore all classes that start with the given string.
  */
-export async function down(
-  schemaPath: string,
-  options: {
-    prefix?: string;
-    ignore?: string[];
-  } = {}
-) {
+export async function down(schemaPath: string, options: DownType = {}) {
   let schema = await getRemoteSchema();
 
   const prefix = options.prefix;

src/features/schema/services/up.ts

@@ -6,6 +6,7 @@ import {
   getLocalSchema,
   getRemoteSchema,
   updateSchema,
+  type UpType,
 } from "../index.js";
 
 /**
@@ -19,17 +20,7 @@ import {
  * @param options.deleteFields Whether to delete fields that are not in the local schema. Default is true.
  * @param options.deleteNonEmptyClass Whether to delete non-empty classes when deleting a class. Default is
  */
-export async function up(
-  schemaPath: string,
-  options: {
-    ignore?: string[];
-    prefix?: string;
-    deleteClasses?: boolean;
-    deleteFields?: boolean;
-    deleteNonEmptyClass?: boolean;
-    filter?: (className: string) => boolean;
-  } = {}
-) {
+export async function up(schemaPath: string, options: UpType = {}) {
   const localSchemaPath = schemaPath
     ? path.resolve(schemaPath)
     : path.resolve(".", "schema", "classes");

src/features/schema/types/DeleteTypes.ts

@@ -0,0 +1,6 @@
+export type DeleteType = {
+  prefix?: string;
+  deleteNonEmptyClass?: boolean;
+};
+
+export type CLI_DeleteType = { prefix?: string; deleteNonEmptyClass?: boolean };

src/features/schema/types/DownTypes.ts

@@ -0,0 +1,6 @@
+export type DownType = {
+  prefix?: string;
+  ignore?: string[];
+};
+
+export type CLI_DownType = { prefix?: string; ignore?: string[] };

src/features/schema/types/UpTypes.ts

@@ -0,0 +1,15 @@
+export type UpType = {
+  ignore?: string[];
+  prefix?: string;
+  deleteClasses?: boolean;
+  deleteFields?: boolean;
+  deleteNonEmptyClass?: boolean;
+  filter?: (className: string) => boolean;
+};
+
+export type CLI_UpType = {
+  prefix: string | undefined;
+  ignore: string[] | undefined;
+  safe: boolean | undefined;
+  deleteNonEmptyClass: boolean | undefined;
+};