chore: add type checking script and refine TypeScript configuration

- Added a new script for type checking in package.json to ensure type safety during development.
- Updated tsconfig.json to include specific TypeScript file patterns and exclude test files, improving the clarity and efficiency of the TypeScript compilation process.
- Enhanced type safety in creds.ts by introducing a type guard for credential keys and ensuring proper checks before accessing credentials.
- Refined error handling in login actions by explicitly typing the error as FetchError for better clarity.
- Updated the loadCustomFieldsParser function to return undefined instead of null, aligning with TypeScript best practices for better type safety.

Author: alvarosabu

package.json

@@ -25,6 +25,7 @@
   ],
   "scripts": {
     "build": "unbuild",
+    "typecheck": "tsc --noEmit",
     "release": "release-it",
     "dev": "pnpm run build && node dist/index.mjs",
     "lint": "eslint .",

src/commands/login/actions.ts

@@ -28,7 +28,7 @@ export const loginWithToken = async (token: string, region: RegionCode) => {
           throw new APIError('network_error', 'login_with_token', error);
       }
     }
-    throw new APIError('generic', 'login_with_token', error, 'The provided credentials are invalid');
+    throw new APIError('generic', 'login_with_token', error as FetchError, 'The provided credentials are invalid');
   }
 };
 

src/commands/types/generate/actions.ts

@@ -252,14 +252,14 @@ const getComponentPropertiesTypeAnnotations = async (
   }, Promise.resolve({} as JSONSchema));
 };
 
-const loadCustomFieldsParser = async (path: string) => {
+const loadCustomFieldsParser = async (path: string): Promise<((key: string, value: Record<string, unknown>) => Record<string, unknown>) | undefined> => {
   try {
     const customFieldsParser = await import(resolve(path));
     return customFieldsParser.default;
   }
   catch (error) {
     handleError(error as Error);
-    return null;
+    return undefined;
   }
 };
 
@@ -280,7 +280,7 @@ export const generateTypes = async (
   try {
     const typeDefs = [...DEFAULT_TYPEDEFS_HEADER];
     const storyblokPropertyTypes = new Set<string>();
-    let customFieldsParser: Record<string, unknown> | undefined;
+    let customFieldsParser: ((key: string, value: Record<string, unknown>) => Record<string, unknown>) | undefined;
     let compilerOptions: Record<string, unknown> | undefined;
     // Custom fields parser
     if (options.customFieldsParser) {

src/creds.ts

@@ -7,6 +7,10 @@ import { colorPalette, regionsDomain } from './constants';
 import { getStoryblokGlobalPath, readFile, saveToFile } from './utils/filesystem';
 import type { StoryblokCredentials } from './types';
 
+function isCredentialKey(k: string): k is keyof StoryblokCredentials {
+  return k === 'login' || k === 'password' || k === 'region';
+}
+
 export const getCredentials = async (filePath = join(getStoryblokGlobalPath(), 'credentials.json')): Promise<StoryblokCredentials | null> => {
   try {
     await access(filePath);
@@ -60,7 +64,7 @@ export const removeCredentials = async (region: RegionCode, filepath: string = g
   const credentials = await getCredentials(filePath);
   const machineName = regionsDomain[region] || 'api.storyblok.com';
 
-  if (credentials[machineName]) {
+  if (isCredentialKey(machineName) && credentials) {
     delete credentials[machineName];
 
     try {

tsconfig.json

@@ -22,6 +22,6 @@
     "isolatedModules": true,
     "skipLibCheck": true
   },
-  "include": ["src"],
-  "exclude": ["node_modules"]
+  "include": ["src/**/*.ts", "src/**/*.tsx"],
+  "exclude": ["node_modules", "**/*.test.ts", "**/*.test.tsx", "**/__tests__/**", "**/test/**", "**/tests/**"]
 }