@vyriy/static 0.5.3 → 0.5.5

package/README.md

@@ -17,9 +17,16 @@ vyriy-static
 vyriy-static dist
 vyriy-static build
 vyriy-static public
+vyriy-static --port 3000 dist
 ```
 
-When no directory is provided, the server tries `dist`, `build`, `public`, `out`, and then the current directory.
+When no directory is provided to the CLI, it tries `dist`, `build`, `public`, `out`, and then the current directory.
+
+CLI flags:
+
+- `--port <port>` or `-p <port>` sets the local server port.
+- `--help` or `-h` prints command help.
+- `--version` or `-v` prints the package version.
 
 ## API
 
@@ -38,12 +45,20 @@ import { createRouter } from '@vyriy/router';
 export const assets = useStatic();
 export const app = useSpa({ directory: 'dist', index: 'index.html' });
 
-export const router = withStatic(createRouter(), { directory: 'dist' }).static('/');
+export const router = withStatic(createRouter())
+  .get('/api', () => ({ body: JSON.stringify({ ok: true }) }))
+  .static('/dist', { directory: 'dist' })
+  .static('/', { directory: 'public' });
 export const spaRouter = withSpa(createRouter(), 'dist');
 
 const code = await staticServer({ directory: 'dist' });
 ```
 
-`useStatic({ directory, index, error })` serves files from a directory. `useSpa(options)` serves static files and falls back to the configured index file for missing `GET` and `HEAD` paths. `withStatic(router, options).static(path)` adds prefix-based static mounts. `withSpa(router, directoryOrOptions)` adds static-first SPA fallback behavior.
+- `useStatic({ directory, index, error })` serves files from a directory.
+- `useSpa(options)` serves static files and falls back to the configured index file for missing `GET` and `HEAD` paths.
+- `withStatic(router).static(path, options)` adds prefix-based static mounts.
+- `withStatic(router, options).static(path)` keeps a shared default for static mounts.
+- `withSpa(router, directoryOrOptions)` adds static-first SPA fallback behavior.
 
 Defaults are `directory: 'dist'`, `index: 'index.html'`, and `error: '404.html'`.
+When `staticServer()` is called without options, it tries `dist`, `build`, `public`, `out`, and then the current directory.

package/bin/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { runStaticCli } from '../index.js';
+await runStaticCli(process.argv.slice(2));

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@vyriy/static",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "description": "Static file and SPA serving helpers for Vyriy servers.",
   "type": "module",
-  "bin": "./bin/vyriy-static.js",
+  "bin": {
+    "vs": "./bin/index.js",
+    "vyriy-static": "./bin/index.js"
+  },
   "dependencies": {
-    "@vyriy/handler": "0.5.3",
-    "@vyriy/router": "0.5.3",
-    "@vyriy/server": "0.5.3"
+    "@vyriy/handler": "0.5.5",
+    "@vyriy/router": "0.5.5",
+    "@vyriy/server": "0.5.5"
   },
   "agents": "./AGENTS.md",
   "license": "MIT",

package/server.d.ts

@@ -1,2 +1,14 @@
 import type { StaticServer } from './types.js';
+export type StaticBinCommand = {
+    readonly type: 'help' | 'version';
+} | {
+    readonly type: 'serve';
+    readonly directory?: string;
+    readonly port?: string;
+};
+export type RunStaticCli = (args?: readonly string[], command?: string, alias?: false | string) => Promise<void>;
+export declare const staticVersion: string;
+export declare const createStaticHelpText: (command?: string, alias?: false | string) => string;
+export declare const parseStaticBinArgs: (args: readonly string[]) => StaticBinCommand;
+export declare const runStaticCli: RunStaticCli;
 export declare const staticServer: StaticServer;

package/server.js

@@ -1,5 +1,6 @@
 import { existsSync } from 'node:fs';
 import { server } from '@vyriy/server';
+import packageJson from './package.json' with { type: 'json' };
 import { useStatic } from './use-static.js';
 const DIRECTORIES = [
     'dist',
@@ -7,8 +8,73 @@ const DIRECTORIES = [
     'public',
     'out',
 ];
+const getOptionValue = (args, name, alias) => {
+    const inline = args.find((arg) => arg.startsWith(`${name}=`));
+    if (inline) {
+        return inline.slice(name.length + 1);
+    }
+    const index = args.findIndex((arg) => arg === name || arg === alias);
+    return index >= 0 ? args[index + 1] : undefined;
+};
+const isOptionValue = (args, index) => {
+    const previous = args[index - 1];
+    return previous === '--port' || previous === '-p';
+};
 const resolveDirectory = (directory) => directory ?? DIRECTORIES.find((candidate) => existsSync(candidate)) ?? '.';
 const createStaticHandler = useStatic;
+export const staticVersion = packageJson.version;
+export const createStaticHelpText = (command = 'vyriy-static', alias = 'vs') => {
+    const aliasText = alias ? `  ${alias} [directory]                  Alias for ${command}\n` : '';
+    const aliasExampleText = alias ? `\n  ${alias} .` : '';
+    return `Vyriy Static Server
+
+Usage:
+  ${command} [directory]        Serve a static directory (defaults to dist when it exists)
+  ${command} --port 3000 dist   Serve a directory on a specific port
+${aliasText}\
+  ${command} --help, -h         Show help
+  ${command} --version, -v      Show version
+
+Options:
+  -p, --port <port>             Port passed through the PORT environment variable
+
+Examples:
+  ${command}
+  ${command} public
+  ${command} --port 3000 dist${aliasExampleText}`;
+};
+export const parseStaticBinArgs = (args) => {
+    if (args.includes('--help') || args.includes('-h')) {
+        return { type: 'help' };
+    }
+    if (args.includes('--version') || args.includes('-v')) {
+        return { type: 'version' };
+    }
+    return {
+        type: 'serve',
+        directory: args.find((arg, index) => !arg.startsWith('-') && !isOptionValue(args, index)),
+        port: getOptionValue(args, '--port', '-p'),
+    };
+};
+export const runStaticCli = async (args = [], command = 'vyriy-static', alias = 'vs') => {
+    const parsed = parseStaticBinArgs(args);
+    switch (parsed.type) {
+        case 'help':
+            console.log(createStaticHelpText(command, alias));
+            process.exitCode = 0;
+            break;
+        case 'version':
+            console.log(staticVersion);
+            process.exitCode = 0;
+            break;
+        case 'serve':
+            if (parsed.port) {
+                process.env.PORT = parsed.port;
+            }
+            process.exitCode = await staticServer({ directory: parsed.directory });
+            break;
+    }
+};
 export const staticServer = async (options = {}) => {
     await Promise.resolve(server(createStaticHandler({ ...options, directory: resolveDirectory(options.directory) })));
     return 0;

package/types.d.ts

@@ -5,10 +5,11 @@ export type StaticOptions = {
     readonly index?: string;
     readonly error?: string;
 };
+export type StaticMountOptions = StaticOptions | string;
 export type StaticHandler = Handler<ApiEvent, ApiResult>;
 export type StaticServer = (options?: StaticOptions) => Promise<number>;
 export type StaticRouterApi = Omit<RouterApi, 'delete' | 'fallback' | 'get' | 'patch' | 'post' | 'put'> & {
-    static(path: string): StaticRouterApi;
+    static(path: string, options?: StaticMountOptions): StaticRouterApi;
 } & {
     [Method in Extract<keyof RouterApi, 'delete' | 'fallback' | 'get' | 'patch' | 'post' | 'put'>]: (...args: Parameters<RouterApi[Method]>) => StaticRouterApi;
 };

package/with-spa.js

@@ -17,6 +17,9 @@ export const withSpa = (router, directoryOrOptions = {}) => {
             router.get(path, handler);
             return api;
         },
+        handle() {
+            return (event) => api.route(event);
+        },
         patch(path, handler) {
             router.patch(path, handler);
             return api;

package/with-static.d.ts

@@ -1,3 +1,3 @@
-import type { StaticOptions, StaticRouterApi } from './types.js';
+import type { StaticMountOptions, StaticRouterApi } from './types.js';
 import type { RouterApi } from '@vyriy/router';
-export declare const withStatic: (router: RouterApi, options?: StaticOptions) => StaticRouterApi;
+export declare const withStatic: (router: RouterApi, options?: StaticMountOptions) => StaticRouterApi;

package/with-static.js

@@ -20,10 +20,10 @@ const toStaticPath = (mount, requestPath) => {
     return undefined;
 };
 const isStaticMethod = (method) => method === 'GET' || method === 'HEAD';
-export const withStatic = (router, options = {}) => {
+const toStaticOptions = (options) => typeof options === 'string' ? { directory: options } : (options ?? {});
+export const withStatic = (router, options) => {
     const mounts = [];
     const createStaticHandler = useStatic;
-    const staticHandler = createStaticHandler(options);
     const api = {
         delete(path, handler) {
             router.delete(path, handler);
@@ -37,6 +37,9 @@ export const withStatic = (router, options = {}) => {
             router.get(path, handler);
             return api;
         },
+        handle() {
+            return (event) => api.route(event);
+        },
         patch(path, handler) {
             router.patch(path, handler);
             return api;
@@ -55,11 +58,11 @@ export const withStatic = (router, options = {}) => {
                 return result;
             }
             for (const mount of mounts) {
-                const staticPath = toStaticPath(mount, event.path);
+                const staticPath = toStaticPath(mount.path, event.path);
                 if (staticPath === undefined) {
                     continue;
                 }
-                const staticResult = await staticHandler({
+                const staticResult = await mount.handler({
                     ...event,
                     path: staticPath,
                 }, {});
@@ -67,8 +70,13 @@ export const withStatic = (router, options = {}) => {
             }
             return result;
         },
-        static(path) {
-            mounts.push(normalizeMount(path));
+        static(path, mountOptions) {
+            const staticOptions = mountOptions ?? options;
+            mounts.push({
+                handler: createStaticHandler(toStaticOptions(staticOptions)),
+                path: normalizeMount(path),
+            });
+            mounts.sort((left, right) => right.path.length - left.path.length);
             return api;
         },
     };

package/bin/vyriy-static.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-import { staticServer } from '../index.js';
-process.exitCode = await staticServer({
-    directory: process.argv.find((arg, index) => index > 1 && !arg.startsWith('-')) ?? '.',
-});