Improve Type Safety in Deploy Utilities

src/utils/deploy/deploy-site.ts

@@ -105,7 +105,7 @@ export const deploySite = async (
     hashFiles({
       assetType,
       concurrentHash,
-      directories: [dir, edgeFunctionsDistPath, deployConfigPath].filter(Boolean),
+      directories: [dir, edgeFunctionsDistPath, deployConfigPath].filter(Boolean) as string[],
       filter,
       hashAlgorithm,
       normalizer: deployFileNormalizer.bind(null, workingDir),

src/utils/deploy/file.ts

@@ -1,9 +1,9 @@
-import walker from 'folder-walker'
+import type { Entry } from 'folder-walker'
 
-export type OriginalFile = walker.Entry
+export type OriginalFile = Entry
 
-export type File = walker.Entry & {
-  hash: string
-  assetType: string
+export type File = Entry & {
+  hash?: string
+  assetType?: string
   normalizedPath: string
 }

src/utils/deploy/hash-files.ts

@@ -3,7 +3,10 @@
 import walker from 'folder-walker'
 
 import { fileFilterCtor, fileNormalizerCtor, hasherCtor, manifestCollectorCtor } from './hasher-segments.js'
-import { $TSFixMe } from '../../commands/types.js'
+import type { File } from './file.js'
+import type { StatusCallback } from './status-cb.js'
+
+type Normalizer = (file: File) => Partial<File>
 
 const hashFiles = async ({
   assetType = 'file',
@@ -14,17 +17,20 @@
   normalizer,
   statusCb,
 }: {
-  assetType?: string | undefined
-  concurrentHash: $TSFixMe
-  directories: $TSFixMe
-  filter: $TSFixMe
-  hashAlgorithm?: string | undefined
-  normalizer?: $TSFixMe
-  statusCb: $TSFixMe
-}): Promise<{ files: Record<string, string>; filesShaMap: Record<string, $TSFixMe[]> }> => {
+  assetType?: string
+  concurrentHash: number
+  directories: string[]
+  filter: (path: string) => boolean
+  hashAlgorithm?: string
+  normalizer?: Normalizer
+  statusCb: StatusCallback
+}): Promise<{
+  files: Record<string, string>
+  filesShaMap: Record<string, { normalizedPath: string; sha: string }[]>
+}> => {
   if (!filter) throw new Error('Missing filter function option')
 
-  const fileStream = walker(directories, { filter })
+  const fileStream = walker(directories, { filter: (filename) => filter(filename) })
   const fileFilter = fileFilterCtor()
   const hasher = hasherCtor({ concurrentHash, hashAlgorithm })
   const fileNormalizer = fileNormalizerCtor({ assetType, normalizer })

src/utils/deploy/hasher-segments.ts

@@ -5,7 +5,7 @@
 
 import transform from 'parallel-transform'
 
 import type { File, OriginalFile } from './file.js'
 import { normalizePath } from './util.js'
 import type { StatusCallback } from './status-cb.js'
 
@@ -40,14 +40,14 @@
   normalizer: normalizeFunction,
 }: {
   assetType: string
-  normalizer?: (file: OriginalFile) => File
+  normalizer?: (file: File) => Partial<File>
 }) => {
   return new Transform({
     objectMode: true,
     transform(fileObj, _, callback) {
       const normalizedFile = { ...fileObj, assetType, normalizedPath: normalizePath(fileObj.relname) }
 
-      const result = normalizeFunction !== undefined ? normalizeFunction(normalizedFile) : normalizedFile
+      const result = normalizeFunction !== undefined ? { ...normalizedFile, ...normalizeFunction(normalizedFile) } : normalizedFile
 
       this.push(result)
 

src/utils/deploy/process-files.ts

@@ -3,14 +3,14 @@ import { join } from 'path'
 
 import { getPathInProject } from '../../lib/settings.js'
 import { EDGE_FUNCTIONS_FOLDER, PUBLIC_URL_PATH } from '../../lib/edge-functions/consts.js'
-import { File } from './file.js'
+import type { File } from './file.js'
 
 const DEPLOY_CONFIG_PATH = 'deploy-config'
 
 const deployConfigPathPath = getPathInProject([DEPLOY_CONFIG_PATH])
 const edgeFunctionsDistPath = getPathInProject([EDGE_FUNCTIONS_FOLDER])
 
-export const deployFileNormalizer = (workingDir: string, file: File) => {
+export const deployFileNormalizer = (workingDir: string, file: File): { normalizedPath: string } => {
   let { normalizedPath } = file
 
   switch (file.root) {

types/folder-walker/index.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+declare module 'folder-walker' {
+  import { Stats } from 'fs'
+  import { Readable } from 'stream'
+
+  export interface Entry {
+    /** file basename */
+    basename: string
+    /** full path to the file */
+    filepath: string
+    /** directory where the file is located */
+    root: string
+    /** relative path to the file from the root */
+    relname: string
+    /** fs.Stats object */
+    stat: Stats
+    /** type of file (file, directory, etc) */
+    type: string
+  }
+
+  export default function walker(
+    folders: string | string[],
+    options?: {
+      filter?: (filename: string, stat: Stats) => boolean
+      fs?: any
+      maxdepth?: number
+    },
+  ): Readable
+}