@stacksjs/path 0.70.45 → 0.70.54

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2023 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -2,6 +2,7 @@
 var __require = import.meta.require;
 
 // src/index.ts
+import { existsSync } from "fs";
 import os from "os";
 import {
   basename,
@@ -51,7 +52,10 @@ function userViewsPath(path) {
   return resourcesPath(`views/${path || ""}`);
 }
 function userFunctionsPath(path) {
-  return resourcesPath(`functions/${path || ""}`);
+  return `${resolveUserLibBase(projectPath("functions"), resourcesPath("functions"))}/${path || ""}`;
+}
+function resolveUserLibBase(rootDir, resourcesDir, exists = existsSync) {
+  return exists(rootDir) ? rootDir : resourcesDir;
 }
 function userJobsPath(path) {
   return appPath(`Jobs/${path || ""}`);
@@ -71,6 +75,12 @@ function userModelsPath(path) {
 function userNotificationsPath(path) {
   return appPath(`Notifications/${path || ""}`);
 }
+function userMailPath(path) {
+  return appPath(`Mail/${path || ""}`);
+}
+function userEmailsPath(path) {
+  return resourcesPath(`emails/${path || ""}`);
+}
 function userDatabasePath(path) {
   return projectPath(`database/${path || ""}`);
 }
@@ -162,7 +172,7 @@ function commandsPath(path) {
   return appPath(`Commands/${path || ""}`);
 }
 function componentsPath(path) {
-  return userLibsPath(`components/${path || ""}`);
+  return `${resolveUserLibBase(projectPath("components"), resourcesPath("components"))}/${path || ""}`;
 }
 function configPath(path) {
   return corePath(`config/${path || ""}`);
@@ -228,7 +238,7 @@ function healthPath(path) {
   return corePath(`health/${path || ""}`);
 }
 function functionsPath(path) {
-  return userLibsPath(`functions/${path || ""}`);
+  return `${resolveUserLibBase(projectPath("functions"), resourcesPath("functions"))}/${path || ""}`;
 }
 function gitPath(path) {
   return corePath(`git/${path || ""}`);
@@ -566,6 +576,8 @@ var path = {
   userMiddlewarePath,
   userModelsPath,
   userNotificationsPath,
+  userMailPath,
+  userEmailsPath,
   utilsPath,
   validationPath,
   xRayPath,
@@ -594,11 +606,13 @@ export {
   userModelsPath,
   userMigrationsPath,
   userMiddlewarePath,
+  userMailPath,
   userListenersPath,
   userLibsPath,
   userJobsPath,
   userFunctionsPath,
   userEventsPath,
+  userEmailsPath,
   userDatabasePath,
   userControllersPath,
   userComponentsPath,
@@ -631,6 +645,7 @@ export {
   routesPath,
   routerPath,
   resourcesPath,
+  resolveUserLibBase,
   resolve,
   replPath,
   relativeActionsPath,

package/dist/src/index.d.ts

@@ -20,6 +20,17 @@ export declare function builtUserActionsPath(path?: string, options?: { relative
 export declare function userComponentsPath(path?: string): string;
 export declare function userViewsPath(path?: string): string;
 export declare function userFunctionsPath(path?: string): string;
+/**
+ * Pick where a user lib folder (`components` / `functions`) lives
+ * (stacksjs/stacks#929). A root-level `<project>/components` (or
+ * `/functions`) folder wins when it exists; otherwise the conventional
+ * `resources/<name>`. Lets apps keep these at the project root without
+ * losing the `resources/`-nested default.
+ *
+ * Pure + injectable `exists` so the selection is unit-testable without
+ * touching the real filesystem.
+ */
+export declare function resolveUserLibBase(rootDir: string, resourcesDir: string, exists?: (p: string) => boolean): string;
 /**
  * Returns the path to the user-defined `Jobs` directory.
  *
@@ -92,6 +103,29 @@ export declare function userModelsPath(path?: string): string;
  * ```
  */
 export declare function userNotificationsPath(path?: string): string;
+/**
+ * Returns the path to the user-defined `Mail` directory.
+ *
+ * Mailable classes live here, one file per email type. The companion
+ * stx template lives in `resources/emails/<kebab-name>.stx` and is
+ * resolved by `@stacksjs/email`'s template loader at send time.
+ *
+ * @param path - The relative path to the file or directory within the `Mail` directory.
+ * @returns The absolute path to the specified file or directory within the user-defined `Mail` directory.
+ * @example
+ * ```ts
+ * import { userMailPath } from '@stacksjs/path'
+ *
+ * console.log(userMailPath('Welcome.ts')) // Outputs the absolute path to 'Welcome.ts' within the user-defined `Mail` directory.
+ * ```
+ */
+export declare function userMailPath(path?: string): string;
+/**
+ * Returns the path to the user-defined `resources/emails` directory
+ * where stx email templates live. The make:mail scaffolder writes a
+ * companion stx file alongside each Mailable class.
+ */
+export declare function userEmailsPath(path?: string): string;
 export declare function userDatabasePath(path?: string): string;
 export declare function userMigrationsPath(path?: string): string;
 /**
@@ -1034,6 +1068,8 @@ export declare interface Path {
   userMiddlewarePath: (path?: string) => string
   userModelsPath: (path?: string) => string
   userNotificationsPath: (path?: string) => string
+  userMailPath: (path?: string) => string
+  userEmailsPath: (path?: string) => string
   utilsPath: (path?: string) => string
   validationPath: (path?: string) => string
   xRayPath: (path?: string) => string

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/path",
   "type": "module",
-  "version": "0.70.45",
+  "version": "0.70.54",
   "description": "The Stacks path.",
   "author": "Chris Breuer",
   "contributors": [