@stacksjs/path 0.64.6 → 0.65.0

package/src/index.ts

@@ -8,6 +8,7 @@ import {
   join,
   normalize,
   parse,
+  type ParsedPath,
   relative,
   resolve,
   sep,
@@ -25,7 +26,7 @@ import { log } from '@stacksjs/logging'
  * @returns The absolute path to the file or directory.
  * @example
  * ```ts
- * import { actionsPath } from '@stacksjs/paths'
+ * import { actionsPath } from '@stacksjs/path'
  *
  * console.log(actionsPath('path/to/action.ts')) // Outputs the absolute path to 'path/to/action.ts' within the `actions` directory
  * ```
@@ -34,31 +35,37 @@ export function actionsPath(path?: string): string {
   return corePath(`actions/${path || ''}`)
 }
 
-export function relativeActionsPath(path?: string) {
+export function relativeActionsPath(path?: string): string {
   return relative(projectPath(), actionsPath(path))
 }
 
-export function userActionsPath(path?: string, options?: { relative: true }) {
-  return appPath(`Actions/${path || ''}`)
+export function userActionsPath(path?: string, options?: { relative: true }): string {
+  const absolutePath = appPath(`Actions/${path || ''}`)
+
+  if (options?.relative)
+    return relative(process.cwd(), absolutePath)
+
+  return absolutePath
 }
 
-export function builtUserActionsPath(path?: string, options?: { relative: boolean }) {
+export function builtUserActionsPath(path?: string, options?: { relative: boolean }): string {
   const absolutePath = frameworkPath(`actions/${path || ''}`)
 
-  if (options?.relative) return relative(process.cwd(), absolutePath)
+  if (options?.relative)
+    return relative(process.cwd(), absolutePath)
 
   return absolutePath
 }
 
-export function userComponentsPath(path?: string) {
+export function userComponentsPath(path?: string): string {
   return libsPath(`components/${path || ''}`)
 }
 
-export function userViewsPath(path?: string) {
+export function userViewsPath(path?: string): string {
   return resourcesPath(`views/${path || ''}`)
 }
 
-export function userFunctionsPath(path?: string) {
+export function userFunctionsPath(path?: string): string {
   return resourcesPath(`functions/${path || ''}`)
 }
 
@@ -69,7 +76,7 @@ export function userFunctionsPath(path?: string) {
  * @returns The absolute path to the specified file or directory within the user-defined `Jobs` directory.
  * @example
  * ```ts
- * import { userJobsPath } from '@stacksjs/paths'
+ * import { userJobsPath } from '@stacksjs/path'
  *
  * console.log(userJobsPath('MyJob.ts')) // Outputs the absolute path to 'MyJob.ts' within the user-defined `Jobs` directory.
  * ```
@@ -85,7 +92,7 @@ export function userJobsPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the user-defined `Listeners` directory.
  * @example
  * ```ts
- * import { userListenersPath } from '@stacksjs/paths'
+ * import { userListenersPath } from '@stacksjs/path'
  *
  * console.log(userListenersPath('MyListener.ts')) // Outputs the absolute path to 'MyListener.ts' within the user-defined `Listeners` directory.
  * ```
@@ -101,12 +108,12 @@ export function userListenersPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the user-defined Middleware directory.
  * @example
  * ```ts
- * import { userMiddlewarePath } from '@stacksjs/paths'
+ * import { userMiddlewarePath } from '@stacksjs/path'
  *
  * console.log(userMiddlewarePath('MyMiddleware.ts')) // Outputs the absolute path to 'MyMiddleware.ts' within the user-defined Middleware directory.
  * ```
  */
-export function userMiddlewarePath(path?: string) {
+export function userMiddlewarePath(path?: string): string {
   return appPath(`Middleware/${path || ''}`)
 }
 
@@ -117,7 +124,7 @@ export function userMiddlewarePath(path?: string) {
  * @returns The absolute path to the specified file or directory within the user-defined `Models` directory.
  * @example
  * ```ts
- * import { userModelsPath } from '@stacksjs/paths'
+ * import { userModelsPath } from '@stacksjs/path'
  *
  * console.log(userModelsPath('MyModel.ts')) // Outputs the absolute path to 'MyModel.ts' within the user-defined `Models` directory.
  * ```
@@ -133,20 +140,20 @@ export function userModelsPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the user-defined `Notifications` directory.
  * @example
  * ```ts
- * import { userNotificationsPath } from '@stacksjs/paths'
+ * import { userNotificationsPath } from '@stacksjs/path'
  *
  * console.log(userNotificationsPath('MyNotification.ts')) // Outputs the absolute path to 'MyNotification.ts' within the user-defined `Notifications` directory.
  * ```
  */
-export function userNotificationsPath(path?: string) {
+export function userNotificationsPath(path?: string): string {
   return appPath(`Notifications/${path || ''}`)
 }
 
-export function userDatabasePath(path?: string) {
+export function userDatabasePath(path?: string): string {
   return projectPath(`database/${path || ''}`)
 }
 
-export function userMigrationsPath(path?: string) {
+export function userMigrationsPath(path?: string): string {
   return userDatabasePath(`migrations/${path || ''}`)
 }
 
@@ -156,7 +163,7 @@ export function userMigrationsPath(path?: string) {
  * @returns The absolute path to the `Events.ts` file within the user-defined directory.
  * @example
  * ```ts
- * import { userEventsPath } from '@stacksjs/paths'
+ * import { userEventsPath } from '@stacksjs/path'
  *
  * console.log(userEventsPath()) // Outputs the absolute path to 'Events.ts' within the user-defined directory.
  * ```
@@ -175,12 +182,12 @@ export function userEventsPath(): string {
  *
  * @example
  * ```ts
- * import { aiPath } from '@stacksjs/paths'
+ * import { aiPath } from '@stacksjs/path'
  *
  * console.log(aiPath('src/drivers/example.ts')) // Outputs the absolute path to 'openai.ts' within the AI directory
  * ```
  */
-export function aiPath(path?: string) {
+export function aiPath(path?: string): string {
   return corePath(`ai/${path || ''}`)
 }
 
@@ -191,12 +198,12 @@ export function aiPath(path?: string) {
  * @returns The absolute path to the specified file or directory within the `assets` directory.
  * @example
  * ```ts
- * import { assetsPath } from '@stacksjs/paths'
+ * import { assetsPath } from '@stacksjs/path'
  *
  * console.log(assetsPath('images/logo.png')) // Outputs the absolute path to 'images/logo.png' within the `assets` directory.
  * ```
  */
-export function assetsPath(path?: string) {
+export function assetsPath(path?: string): string {
   return resourcesPath(`assets/${path || ''}`)
 }
 
@@ -206,12 +213,12 @@ export function assetsPath(path?: string) {
  * @returns The absolute path to the `alias` directory.
  * @example
  * ```ts
- * import { aliasPath } from '@stacksjs/paths'
+ * import { aliasPath } from '@stacksjs/path'
  *
  * console.log(aliasPath()) // Outputs the absolute path to the `alias` directory.
  * ```
  */
-export function aliasPath() {
+export function aliasPath(): string {
   return corePath('alias/src/index.ts')
 }
 
@@ -224,16 +231,17 @@ export function aliasPath() {
  * @returns The absolute or relative path to the specified file or directory within the buddy  * @returns The absolute or relative path to the specified file or directory within the buddy directory.
  * @example
  * ```ts
- * import { buddyPath } from '@stacksjs/paths'
+ * import { buddyPath } from '@stacksjs/path'
  *
  * console.log(buddyPath('config/buddy.json')) // Outputs the absolute path to 'config/buddy.json' within the buddy directory.
  * console.log(buddyPath('config/buddy.json', { relative: true })) // Outputs the relative path to 'config/buddy.json' within the buddy directory.
  * ```
  */
-export function buddyPath(path?: string, options?: { relative?: boolean }) {
+export function buddyPath(path?: string, options?: { relative?: boolean }): string {
   const absolutePath = corePath(`buddy/${path || ''}`)
 
-  if (options?.relative) return relative(process.cwd(), absolutePath)
+  if (options?.relative)
+    return relative(process.cwd(), absolutePath)
 
   return absolutePath
 }
@@ -245,7 +253,7 @@ export function buddyPath(path?: string, options?: { relative?: boolean }) {
  * @returns The absolute path to the specified file or directory within the runtime directory.
  * @example
  * ```ts
- * import { runtimePath } from '@stacksjs/paths'
+ * import { runtimePath } from '@stacksjs/path'
  *
  * console.log(runtimePath('runtime-config.json')) // Outputs the absolute path to 'runtime-config.json' within the runtime directory.
  * ```
@@ -261,7 +269,7 @@ export function runtimePath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the `analytics` directory.
  * @example
  * ```ts
- * import { analyticsPath } from '@stacksjs/paths'
+ * import { analyticsPath } from '@stacksjs/path'
  *
  * console.log(analyticsPath('data/report.csv')) // Outputs the absolute path to 'data/report.csv' within the `analytics` directory.
  * ```
@@ -277,7 +285,7 @@ export function analyticsPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the `arrays` directory.
  * @example
  * ```ts
- * import { arraysPath } from '@stacksjs/paths'
+ * import { arraysPath } from '@stacksjs/path'
  *
  * console.log(arraysPath('list.txt')) // Outputs the absolute path to 'list.txt' within the `arrays` directory.
  * ```
@@ -293,7 +301,7 @@ export function arraysPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the app directory.
  * @example
  * ```ts
- * import { appPath } from '@stacksjs/paths'
+ * import { appPath } from '@stacksjs/path'
  *
  * console.log(appPath('Actions/DummyAction.ts')) // Outputs the absolute path to 'Actions/DummyAction.ts' within the app directory.
  * ```
@@ -309,7 +317,7 @@ export function appPath(path?: string): string {
  * @returns The absolute path to the specified file or directory within the auth directory.
  * @example
  * ```ts
- * import { authPath } from '@stacksjs/paths'
+ * import { authPath } from '@stacksjs/path'
  *
  * console.log(authPath('login.ts')) // Outputs the absolute path to 'login.ts' within the auth directory.
  * ```
@@ -318,6 +326,22 @@ export function authPath(path?: string): string {
   return corePath(`auth/${path || ''}`)
 }
 
+/**
+ * Returns the path to the `auth` directory within the core directory.
+ *
+ * @param path - The relative path to the file or directory within the auth directory.
+ * @returns The absolute path to the specified file or directory within the auth directory.
+ * @example
+ * ```ts
+ * import { coreApiPath } from '@stacksjs/path'
+ *
+ * console.log(coreApiPath('login.ts')) // Outputs the absolute path to 'login.ts' within the auth directory.
+ * ```
+ */
+export function coreApiPath(path?: string): string {
+  return corePath(`api/${path || ''}`)
+}
+
 /**
  * Returns the path to the build directory. The build directory
  * contains Stacks' build engine & its tooling integrations.
@@ -330,7 +354,7 @@ export function authPath(path?: string): string {
  * buildPath('components.ts')
  * ```
  */
-export function buildPath(path?: string) {
+export function buildPath(path?: string): string {
   return corePath(`build/${path || ''}`)
 }
 
@@ -563,6 +587,16 @@ export function enumsPath(path?: string): string {
   return corePath(`enums/${path || ''}`)
 }
 
+/**
+ * Returns the path to the `eslint-plugin` directory within the core directory.
+ *
+ * @param path - The relative path to the file or directory within the eslint-plugin directory.
+ * @returns The absolute path to the specified file or directory within the eslint-plugin directory.
+ */
+export function eslintPluginPath(path?: string): string {
+  return corePath(`eslint-plugin/${path || ''}`)
+}
+
 /**
  * Returns the path to the `error-handling` directory within the core directory.
  *
@@ -599,7 +633,7 @@ export function coreEnvPath(path?: string): string {
  * @param type - The type of examples to filter by ('vue-components' or 'web-components').
  * @returns The absolute path to the specified type of examples within the `examples` directory.
  */
-export function examplesPath(type: 'vue-components' | 'web-components'): string {
+export function examplesPath(type?: 'vue-components' | 'web-components'): string {
   return frameworkPath(`examples/${type || ''}`)
 }
 
@@ -622,14 +656,25 @@ export function fakerPath(path?: string): string {
  * @param options.cwd - Specifies a custom working directory.
  * @returns The absolute or relative path to the specified file or directory within the framework directory.
  */
-export function frameworkPath(path?: string, options?: { relative?: boolean; cwd?: string }): string {
+export function frameworkPath(path?: string, options?: { relative?: boolean, cwd?: string }): string {
   const absolutePath = storagePath(`framework/${path || ''}`)
 
-  if (options?.relative) return relative(options.cwd || process.cwd(), absolutePath)
+  if (options?.relative)
+    return relative(options.cwd || process.cwd(), absolutePath)
 
   return absolutePath
 }
 
+/**
+ * Returns the path to the `frontend` directory within the core directory.
+ *
+ * @param path - The relative path to the file or directory within the health directory.
+ * @returns The absolute path to the specified file or directory within the health directory.
+ */
+export function browserPath(path?: string): string {
+  return corePath(`browser/${path || ''}`)
+}
+
 /**
  * Returns the path to the `health` directory within the core directory.
  *
@@ -681,7 +726,8 @@ export function langPath(path?: string): string {
 export function layoutsPath(path?: string, options?: { relative?: boolean }): string {
   const absolutePath = resourcesPath(`layouts/${path || ''}`)
 
-  if (options?.relative) return relative(process.cwd(), absolutePath)
+  if (options?.relative)
+    return relative(process.cwd(), absolutePath)
 
   return absolutePath
 }
@@ -813,10 +859,11 @@ export function onboardingPath(path?: string): string {
  * @param type - The type of the library ('vue-components', 'web-components', or 'functions') for which to return the package.json path.
  * @returns The absolute path to the specified package.json file within the framework directory.
  */
-export function packageJsonPath(type: 'vue-components' | 'web-components' | 'functions'): string {
-  if (type === 'vue-components') return frameworkPath('libs/components/vue/package.json')
-
-  if (type === 'web-components') return frameworkPath('libs/components/web/package.json')
+export function packageJsonPath(type: LibraryType): string {
+  if (type === 'vue-components')
+    return frameworkPath('libs/components/vue/package.json')
+  if (type === 'web-components')
+    return frameworkPath('libs/components/web/package.json')
 
   return frameworkPath(`libs/${type}/package.json`)
 }
@@ -865,7 +912,8 @@ export function projectPath(filePath = '', options?: { relative: boolean }): str
   const finalPath = resolve(path, filePath)
 
   // If the `relative` option is true, return the path relative to the current working directory
-  if (options?.relative) return relative(process.cwd(), finalPath)
+  if (options?.relative)
+    return relative(process.cwd(), finalPath)
 
   return finalPath
 }
@@ -892,7 +940,8 @@ export async function findProjectPath(project: string): Promise<string> {
   // since we are targeting a specific project, find its path
   const projectPath = projects.find((proj: string) => proj.includes(project))
 
-  if (!projectPath) throw new Error(`Could not find project with name: ${project}`)
+  if (!projectPath)
+    throw new Error(`Could not find project with name: ${project}`)
 
   return projectPath.startsWith('/') ? projectPath : `/${projectPath}`
 }
@@ -933,7 +982,7 @@ export function publicPath(path?: string): string {
  * @param path - The relative path to the file or directory within the push directory.
  * @returns The absolute path to the specified file or directory within the push directory.
  */
-export function pushPath(path?: string) {
+export function pushPath(path?: string): string {
   return notificationsPath(`push/${path || ''}`)
 }
 
@@ -943,7 +992,7 @@ export function pushPath(path?: string) {
  * @param path - The relative path to the file or directory within the query-builder directory.
  * @returns The absolute path to the specified file or directory within the query-builder directory.
  */
-export function queryBuilderPath(path?: string) {
+export function queryBuilderPath(path?: string): string {
   return corePath(`query-builder/${path || ''}`)
 }
 
@@ -953,7 +1002,7 @@ export function queryBuilderPath(path?: string) {
  * @param path - The relative path to the file or directory within the queue directory.
  * @returns The absolute path to the specified file or directory within the queue directory.
  */
-export function queuePath(path?: string) {
+export function queuePath(path?: string): string {
   return corePath(`queue/${path || ''}`)
 }
 
@@ -963,7 +1012,7 @@ export function queuePath(path?: string) {
  * @param path - The relative path to the file or directory within the realtime directory.
  * @returns The absolute path to the specified file or directory within the realtime directory.
  */
-export function realtimePath(path?: string) {
+export function realtimePath(path?: string): string {
   return corePath(`realtime/${path || ''}`)
 }
 
@@ -975,7 +1024,7 @@ export function realtimePath(path?: string) {
  * @param options.relative - If true, returns the path relative to the current working directory.
  * @returns The absolute or relative path to the specified file or directory within the `resources` directory.
  */
-export function resourcesPath(path?: string, options?: { relative?: boolean }) {
+export function resourcesPath(path?: string, options?: { relative?: boolean }): string {
   if (options?.relative) {
     const absolutePath = projectPath(`resources/${path || ''}`)
     return relative(process.cwd(), absolutePath)
@@ -990,7 +1039,7 @@ export function resourcesPath(path?: string, options?: { relative?: boolean }) {
  * @param path - The relative path to the file or directory within the repl directory.
  * @returns The absolute path to the specified file or directory within the repl directory.
  */
-export function replPath(path?: string) {
+export function replPath(path?: string): string {
   return corePath(`repl/${path || ''}`)
 }
 
@@ -1000,7 +1049,7 @@ export function replPath(path?: string) {
  * @param path - The relative path to the file or directory within the router directory.
  * @returns The absolute path to the specified file or directory within the router directory.
  */
-export function routerPath(path?: string) {
+export function routerPath(path?: string): string {
   return corePath(`router/${path || ''}`)
 }
 
@@ -1012,10 +1061,11 @@ export function routerPath(path?: string) {
  * @param options.relative - If true, returns the path relative to the current working directory.
  * @returns The absolute or relative path to the specified file or directory within the `routes` directory.
  */
-export function routesPath(path?: string, options?: { relative?: boolean }) {
+export function routesPath(path?: string, options?: { relative?: boolean }): string {
   const absolutePath = resourcesPath(`routes/${path || ''}`)
 
-  if (options?.relative) return relative(process.cwd(), absolutePath)
+  if (options?.relative)
+    return relative(process.cwd(), absolutePath)
 
   return projectPath(`routes/${path || ''}`)
 }
@@ -1026,7 +1076,7 @@ export function routesPath(path?: string, options?: { relative?: boolean }) {
  * @param path - The relative path to the file or directory within the search-engine directory.
  * @returns The absolute path to the specified file or directory within the search-engine directory.
  */
-export function searchEnginePath(path?: string) {
+export function searchEnginePath(path?: string): string {
   return corePath(`search-engine/${path || ''}`)
 }
 
@@ -1036,7 +1086,7 @@ export function searchEnginePath(path?: string) {
  * @param path - The relative path to the file or directory within the `settings` directory.
  * @returns The absolute path to the specified file or directory within the `settings` directory.
  */
-export function settingsPath(path?: string) {
+export function settingsPath(path?: string): string {
   return projectPath(`${path || 'views/dashboard/settings'}`)
 }
 
@@ -1046,7 +1096,7 @@ export function settingsPath(path?: string) {
  * @param path - The relative path to the file or directory within the `scripts` directory.
  * @returns The absolute path to the specified file or directory within the `scripts` directory.
  */
-export function scriptsPath(path?: string) {
+export function scriptsPath(path?: string): string {
   return frameworkPath(`scripts/${path || ''}`)
 }
 
@@ -1056,7 +1106,7 @@ export function scriptsPath(path?: string) {
  * @param path - The relative path to the file or directory within the scheduler directory.
  * @returns The absolute path to the specified file or directory within the scheduler directory.
  */
-export function schedulerPath(path?: string) {
+export function schedulerPath(path?: string): string {
   return corePath(`scheduler/${path || ''}`)
 }
 
@@ -1066,7 +1116,7 @@ export function schedulerPath(path?: string) {
  * @param path - The relative path to the file or directory within the slug directory.
  * @returns The absolute path to the specified file or directory within the slug directory.
  */
-export function slugPath(path?: string) {
+export function slugPath(path?: string): string {
   return corePath(`slug/${path || ''}`)
 }
 
@@ -1076,7 +1126,7 @@ export function slugPath(path?: string) {
  * @param path - The relative path to the file or directory within the `sms` directory.
  * @returns The absolute path to the specified file or directory within the `sms` directory.
  */
-export function smsPath(path?: string) {
+export function smsPath(path?: string): string {
   return notificationsPath(`sms/${path || ''}`)
 }
 
@@ -1086,7 +1136,7 @@ export function smsPath(path?: string) {
  * @param path - The relative path to the file or directory within the storage directory.
  * @returns The absolute path to the specified file or directory within the storage directory.
  */
-export function coreStoragePath(path?: string) {
+export function coreStoragePath(path?: string): string {
   return corePath(`storage/${path || ''}`)
 }
 
@@ -1096,7 +1146,7 @@ export function coreStoragePath(path?: string) {
  * @param path - The relative path to the file or directory within the `stores` directory.
  * @returns The absolute path to the specified file or directory within the `stores` directory.
  */
-export function storesPath(path?: string) {
+export function storesPath(path?: string): string {
   return resourcesPath(`stores/${path || ''}`)
 }
 
@@ -1106,7 +1156,7 @@ export function storesPath(path?: string) {
  * @param path - The relative path to the file or directory within the security directory.
  * @returns The absolute path to the specified file or directory within the security directory.
  */
-export function securityPath(path?: string) {
+export function securityPath(path?: string): string {
   return corePath(`security/${path || ''}`)
 }
 
@@ -1116,11 +1166,11 @@ export function securityPath(path?: string) {
  * @param path - The relative path to the file or directory within the server directory.
  * @returns The absolute path to the specified file or directory within the server directory.
  */
-export function serverPath(path?: string) {
+export function serverPath(path?: string): string {
   return corePath(`server/${path || ''}`)
 }
 
-export function userServerPath(path?: string) {
+export function userServerPath(path?: string): string {
   return frameworkPath(`server/${path || ''}`)
 }
 
@@ -1130,7 +1180,7 @@ export function userServerPath(path?: string) {
  * @param path - The relative path to the file or directory within the `serverless` directory.
  * @returns The absolute path to the specified file or directory within the `serverless` directory.
  */
-export function serverlessPath(path?: string) {
+export function serverlessPath(path?: string): string {
   return corePath(`serverless/${path || ''}`)
 }
 
@@ -1140,7 +1190,7 @@ export function serverlessPath(path?: string) {
  * @param path - The relative path to the file or directory within the framework's `src` directory.
  * @returns The absolute path to the specified file or directory within the framework's `src` directory.
  */
-export function stacksPath(path?: string) {
+export function stacksPath(path?: string): string {
   return frameworkPath(`src/${path || ''}`)
 }
 
@@ -1150,7 +1200,7 @@ export function stacksPath(path?: string) {
  * @param path - The relative path to the file or directory within the shell directory.
  * @returns The absolute path to the specified file or directory within the shell directory.
  */
-export function shellPath(path?: string) {
+export function shellPath(path?: string): string {
   return corePath(`shell/${path || ''}`)
 }
 
@@ -1160,7 +1210,7 @@ export function shellPath(path?: string) {
  * @param path - The relative path to the file or directory within the `strings` directory.
  * @returns The absolute path to the specified file or directory within the `strings` directory.
  */
-export function stringsPath(path?: string) {
+export function stringsPath(path?: string): string {
   return corePath(`strings/${path || ''}`)
 }
 
@@ -1170,7 +1220,7 @@ export function stringsPath(path?: string) {
  * @param path - The relative path to the file or directory within the testing directory.
  * @returns The absolute path to the specified file or directory within the testing directory.
  */
-export function testingPath(path?: string) {
+export function testingPath(path?: string): string {
   return corePath(`testing/${path || ''}`)
 }
 
@@ -1180,7 +1230,7 @@ export function testingPath(path?: string) {
  * @param path - The relative path to the file or directory within the tinker directory.
  * @returns The absolute path to the specified file or directory within the tinker directory.
  */
-export function tinkerPath(path?: string) {
+export function tinkerPath(path?: string): string {
   return corePath(`tinker/${path || ''}`)
 }
 
@@ -1190,7 +1240,7 @@ export function tinkerPath(path?: string) {
  * @param path - The relative path to the file or directory within the `tests` directory.
  * @returns The absolute path to the specified file or directory within the `tests` directory.
  */
-export function testsPath(path?: string) {
+export function testsPath(path?: string): string {
   return frameworkPath(`tests/${path || ''}`)
 }
 
@@ -1200,7 +1250,7 @@ export function testsPath(path?: string) {
  * @param path - The relative path to the file or directory within the `types` directory.
  * @returns The absolute path to the specified file or directory within the `types` directory.
  */
-export function typesPath(path?: string) {
+export function typesPath(path?: string): string {
   return corePath(`types/${path || ''}`)
 }
 
@@ -1210,10 +1260,11 @@ export function typesPath(path?: string) {
  * @param path - The relative path to the file or directory within the ui directory.
  * @returns The absolute path to the specified file or directory within the ui directory.
  */
-export function uiPath(path?: string, options?: { relative?: boolean }) {
+export function uiPath(path?: string, options?: { relative?: boolean }): string {
   const absolutePath = corePath(`ui/${path || ''}`)
 
-  if (options?.relative) return relative(process.cwd(), absolutePath)
+  if (options?.relative)
+    return relative(process.cwd(), absolutePath)
 
   return absolutePath
 }
@@ -1224,7 +1275,7 @@ export function uiPath(path?: string, options?: { relative?: boolean }) {
  * @param path - The relative path to the file or directory within the `utils` directory.
  * @returns The absolute path to the specified file or directory within the `utils` directory.
  */
-export function utilsPath(path?: string) {
+export function utilsPath(path?: string): string {
   return corePath(`utils/${path || ''}`)
 }
 
@@ -1234,7 +1285,7 @@ export function utilsPath(path?: string) {
  * @param path - The relative path to the file or directory within the validation directory.
  * @returns The absolute path to the specified file or directory within the validation directory.
  */
-export function validationPath(path?: string) {
+export function validationPath(path?: string): string {
   return corePath(`validation/${path || ''}`)
 }
 
@@ -1244,7 +1295,7 @@ export function validationPath(path?: string) {
  * @param path - The relative path to the file or directory within the vite-config directory.
  * @returns The absolute path to the specified file or directory within the vite-config directory.
  */
-export function viteConfigPath(path?: string) {
+export function viteConfigPath(path?: string): string {
   return corePath(`vite-config/${path || ''}`)
 }
 
@@ -1254,7 +1305,7 @@ export function viteConfigPath(path?: string) {
  * @param path - The relative path to the file or directory within the vite directory.
  * @returns The absolute path to the specified file or directory within the vite directory.
  */
-export function vitePluginPath(path?: string) {
+export function vitePluginPath(path?: string): string {
   return corePath(`vite-plugin/${path || ''}`)
 }
 
@@ -1264,7 +1315,7 @@ export function vitePluginPath(path?: string) {
  * @param path - The relative path to the file or directory within the x-ray directory.
  * @returns The absolute path to the specified file or directory within the x-ray directory.
  */
-export function xRayPath(path?: string) {
+export function xRayPath(path?: string): string {
   return frameworkPath(`stacks/x-ray/${path || ''}`)
 }
 
@@ -1274,11 +1325,142 @@ export function xRayPath(path?: string) {
  * @param path - The relative path to append to the home directory path.
  * @returns The absolute path to the specified file or directory within the home directory.
  */
-export function homeDir(path?: string) {
+export function homeDir(path?: string): string {
   return os.homedir() + (path ? (path.startsWith('/') ? '' : '/') + path : '~')
 }
 
-export const path = {
+export interface Path {
+  actionsPath: (path?: string) => string
+  userActionsPath: (path?: string) => string
+  builtUserActionsPath: (path?: string, option?: { relative: boolean }) => string
+  userComponentsPath: (path?: string) => string
+  userViewsPath: (path?: string) => string
+  userFunctionsPath: (path?: string) => string
+  aiPath: (path?: string) => string
+  assetsPath: (path?: string) => string
+  relativeActionsPath: (path?: string) => string
+  aliasPath: (path?: string) => string
+  analyticsPath: (path?: string) => string
+  arraysPath: (path?: string) => string
+  appPath: (path?: string) => string
+  authPath: (path?: string) => string
+  coreApiPath: (path?: string) => string
+  buddyPath: (path?: string) => string
+  buildEnginePath: (path?: string) => string
+  libsEntriesPath: (path?: string) => string
+  buildPath: (path?: string) => string
+  cachePath: (path?: string) => string
+  chatPath: (path?: string) => string
+  cliPath: (path?: string) => string
+  cloudPath: (path?: string) => string
+  frameworkCloudPath: (path?: string) => string
+  collectionsPath: (path?: string) => string
+  commandsPath: (path?: string) => string
+  componentsPath: (path?: string) => string
+  configPath: (path?: string) => string
+  projectConfigPath: (path?: string) => string
+  corePath: (path?: string) => string
+  customElementsDataPath: (path?: string) => string
+  databasePath: (path?: string) => string
+  datetimePath: (path?: string) => string
+  developmentPath: (path?: string) => string
+  desktopPath: (path?: string) => string
+  docsPath: (path?: string) => string
+  dnsPath: (path?: string) => string
+  emailPath: (path?: string) => string
+  enumsPath: (path?: string) => string
+  eslintPluginPath: (path?: string) => string
+  errorHandlingPath: (path?: string) => string
+  eventsPath: (path?: string) => string
+  coreEnvPath: (path?: string) => string
+  healthPath: (path?: string) => string
+  examplesPath: (type?: 'vue-components' | 'web-components') => string
+  fakerPath: (path?: string) => string
+  frameworkPath: (path?: string) => string
+  browserPath: (path?: string) => string
+  storagePath: (path?: string) => string
+  functionsPath: (path?: string) => string
+  gitPath: (path?: string) => string
+  langPath: (path?: string) => string
+  layoutsPath: (path?: string, options?: { relative?: boolean }) => string
+  libsPath: (path?: string) => string
+  userLibsPath: (path?: string) => string
+  libraryEntryPath: (type: LibraryType) => string
+  lintPath: (path?: string) => string
+  listenersPath: (path?: string) => string
+  loggingPath: (path?: string) => string
+  logsPath: (path?: string) => string
+  jobsPath: (path?: string) => string
+  modulesPath: (path?: string) => string
+  ormPath: (path?: string) => string
+  objectsPath: (path?: string) => string
+  onboardingPath: (path?: string) => string
+  notificationsPath: (path?: string) => string
+  packageJsonPath: (type: LibraryType) => string
+  viewsPath: (path?: string) => string
+  pathPath: (path?: string) => string
+  paymentsPath: (path?: string) => string
+  projectPath: (path?: string) => string
+  findProjectPath: (project: string) => Promise<string>
+  coreStoragePath: (path?: string) => string
+  publicPath: (path?: string) => string
+  pushPath: (path?: string) => string
+  queryBuilderPath: (path?: string) => string
+  queuePath: (path?: string) => string
+  realtimePath: (path?: string) => string
+  resourcesPath: (path?: string) => string
+  replPath: (path?: string) => string
+  routerPath: (path?: string) => string
+  routesPath: (path?: string) => string
+  runtimePath: (path?: string) => string
+  searchEnginePath: (path?: string) => string
+  schedulerPath: (path?: string) => string
+  settingsPath: (path?: string) => string
+  smsPath: (path?: string) => string
+  slugPath: (path?: string) => string
+  scriptsPath: (path?: string) => string
+  securityPath: (path?: string) => string
+  serverPath: (path?: string) => string
+  userServerPath: (path?: string) => string
+  serverlessPath: (path?: string) => string
+  stacksPath: (path?: string) => string
+  stringsPath: (path?: string) => string
+  shellPath: (path?: string) => string
+  storesPath: (path?: string) => string
+  testingPath: (path?: string) => string
+  testsPath: (path?: string) => string
+  tinkerPath: (path?: string) => string
+  typesPath: (path?: string) => string
+  uiPath: (path?: string, options?: { relative?: boolean }) => string
+  userDatabasePath: (path?: string) => string
+  userMigrationsPath: (path?: string) => string
+  userEventsPath: (path?: string) => string
+  userJobsPath: (path?: string) => string
+  userListenersPath: (path?: string) => string
+  userMiddlewarePath: (path?: string) => string
+  userModelsPath: (path?: string) => string
+  userNotificationsPath: (path?: string) => string
+  utilsPath: (path?: string) => string
+  validationPath: (path?: string) => string
+  viteConfigPath: (path?: string) => string
+  vitePluginPath: (path?: string) => string
+  xRayPath: (path?: string) => string
+  homeDir: (path?: string) => string
+  basename: (path: string) => string
+  delimiter: () => ';' | ':'
+  dirname: (path: string) => string
+  extname: (path: string) => string
+  isAbsolute: (path: string) => boolean
+  join: (...paths: string[]) => string
+  normalize: (path: string) => string
+  relative: (from: string, to: string) => string
+  resolve: (...paths: string[]) => string
+  parse: (path: string) => ParsedPath
+  sep: () => '/' | '\\'
+  toNamespacedPath: (path: string) => string
+}
+
+export const path: Path = {
   actionsPath,
   userActionsPath,
   builtUserActionsPath,
@@ -1293,6 +1475,7 @@ export const path = {
   arraysPath,
   appPath,
   authPath,
+  coreApiPath,
   buddyPath,
   buildEnginePath,
   libsEntriesPath,
@@ -1317,6 +1500,7 @@ export const path = {
   dnsPath,
   emailPath,
   enumsPath,
+  eslintPluginPath,
   errorHandlingPath,
   eventsPath,
   coreEnvPath,
@@ -1324,6 +1508,7 @@ export const path = {
   examplesPath,
   fakerPath,
   frameworkPath,
+  browserPath,
   storagePath,
   functionsPath,
   gitPath,
@@ -1395,7 +1580,7 @@ export const path = {
 
   // path utils
   basename,
-  delimiter,
+  delimiter: () => delimiter,
   dirname,
   extname,
   isAbsolute,
@@ -1404,7 +1589,7 @@ export const path = {
   relative,
   resolve,
   parse,
-  sep,
+  sep: () => sep,
   toNamespacedPath,
 }