rsf-zero 0.1.6 → 0.1.7

package/README.md

@@ -44,6 +44,8 @@ See [/example/src/App.tsx](https://github.com/IgorNadj/rsf-zero/tree/main/exampl
 
 **RSF Zero** is designed to be a dead simple micro-framework.
 
+Read the [blog post](https://igornadj.io/blog/2025-08-02-rsf-is-all-you-need/) for the motivation behind it.
+
 🕊 **Minimal**: Add whatever you want on top, nothing bundled that you don't use\
 🕊 **Simple**: Add `'use server'` to run something on the server, and you're done, nothing new to learn\
 🕊️ **Done**: Instead, spend your spare time sipping a nice coffee or looking at a bird

package/dist/cli/build/buildClientFiles.d.ts

@@ -0,0 +1,3 @@
+import { Action } from "../../types.ts";
+export declare const buildClientFiles: (rootDir: string, onActionFound: (action: Action) => {}) => Promise<void>;
+//# sourceMappingURL=buildClientFiles.d.ts.map

package/dist/cli/build/buildClientFiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildClientFiles.d.ts","sourceRoot":"","sources":["../../../src/cli/build/buildClientFiles.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,MAAM,EAAC,MAAM,gBAAgB,CAAC;AAItC,eAAO,MAAM,gBAAgB,GAAU,SAAS,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,MAAM,KAAK,EAAE,kBAwB5F,CAAA"}

package/dist/cli/build/buildServerFiles.d.ts

@@ -0,0 +1,3 @@
+import { Action } from "../../types.ts";
+export declare const buildServerFiles: (actions: Action[], rootDir: string) => void;
+//# sourceMappingURL=buildServerFiles.d.ts.map

package/dist/cli/build/buildServerFiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildServerFiles.d.ts","sourceRoot":"","sources":["../../../src/cli/build/buildServerFiles.ts"],"names":[],"mappings":"AAQA,OAAO,EAAC,MAAM,EAAC,MAAM,gBAAgB,CAAC;AAWtC,eAAO,MAAM,gBAAgB,GAAI,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,SAuBlE,CAAA"}

package/dist/cli/build.d.ts

@@ -0,0 +1,2 @@
+export declare const build: () => Promise<void>;
+//# sourceMappingURL=build.d.ts.map

package/dist/cli/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/cli/build.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,KAAK,qBAcjB,CAAA"}

package/dist/cli/dev/startVite.d.ts

@@ -0,0 +1,7 @@
+import type { Express } from "express";
+import { Action } from "../../types.ts";
+export declare const startVite: ({ app, onActionFound }: {
+    app: Express;
+    onActionFound: (action: Action) => void;
+}) => Promise<import("vite").ViteDevServer>;
+//# sourceMappingURL=startVite.d.ts.map

package/dist/cli/dev/startVite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"startVite.d.ts","sourceRoot":"","sources":["../../../src/cli/dev/startVite.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EAAC,MAAM,EAAC,MAAM,gBAAgB,CAAC;AAGtC,eAAO,MAAM,SAAS,GAAU,wBAG7B;IACD,GAAG,EAAE,OAAO,CAAC;IACb,aAAa,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC,0CAgCA,CAAC"}

package/dist/cli/dev.d.ts

@@ -0,0 +1,3 @@
+import "dotenv/config";
+export declare const dev: () => Promise<void>;
+//# sourceMappingURL=dev.d.ts.map

package/dist/cli/dev.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dev.d.ts","sourceRoot":"","sources":["../../src/cli/dev.ts"],"names":[],"mappings":"AAEA,OAAO,eAAe,CAAC;AAOvB,eAAO,MAAM,GAAG,qBA4Bf,CAAA"}

package/dist/cli/start/createActionRoute.d.ts

@@ -0,0 +1,9 @@
+import type { Express } from "express";
+import { Action, ActionRegistry } from "../../types.ts";
+type ReturnType = {
+    add: (actionId: Action['id'], actionFn: CallableFunction) => void;
+    set: (actionRegistry: ActionRegistry) => void;
+};
+export declare const createActionRoute: (app: Express) => ReturnType;
+export {};
+//# sourceMappingURL=createActionRoute.d.ts.map

package/dist/cli/start/createActionRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createActionRoute.d.ts","sourceRoot":"","sources":["../../../src/cli/start/createActionRoute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EAAC,MAAM,EAAE,cAAc,EAAC,MAAM,gBAAgB,CAAC;AAGtD,KAAK,UAAU,GAAG;IAChB,GAAG,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAClE,GAAG,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,IAAI,CAAC;CAC/C,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAI,KAAK,OAAO,KAAG,UAwChD,CAAC"}

package/dist/cli/start.d.ts

@@ -0,0 +1,4 @@
+import "dotenv/config";
+import { RsfZeroOptions } from "../export-types.ts";
+export declare const start: (options: RsfZeroOptions) => Promise<void>;
+//# sourceMappingURL=start.d.ts.map

package/dist/cli/start.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.d.ts","sourceRoot":"","sources":["../../src/cli/start.ts"],"names":[],"mappings":"AAGA,OAAO,eAAe,CAAC;AAIvB,OAAO,EAAC,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAGlD,eAAO,MAAM,KAAK,GAAU,SAAS,cAAc,kBAyBlD,CAAA"}

package/dist/cli/start.js

@@ -11,7 +11,7 @@ import express from "express";
 import morgan from "morgan";
 import "dotenv/config";
 import { createActionRoute } from "./start/createActionRoute.js";
-export const start = async () => {
+export const start = async (options) => {
     const app = express();
     const port = 3000;
     app.use(morgan("dev"));
@@ -19,7 +19,7 @@ export const start = async () => {
     // Client
     const staticPath = path.join(process.cwd(), 'dist/client/');
     console.log('Serving static files from:', staticPath);
-    app.use(express.static('dist/client/'));
+    app.use(express.static('dist/client/', options.startStatic ?? {}));
     // Server
     // - create action route
     const { set: setActionRegistry } = createActionRoute(app);

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -2,8 +2,10 @@
 import { dev } from "./cli/dev.js";
 import { build } from "./cli/build.js";
 import { start } from "./cli/start.js";
+import { loadOptions } from "./options.js";
 const args = process.argv.slice(2);
 const command = args[0];
+const options = await loadOptions();
 if (command === 'dev') {
     await dev();
 }
@@ -11,7 +13,7 @@ else if (command === 'build') {
     await build();
 }
 else if (command === 'start') {
-    await start();
+    await start(options);
 }
 else {
     console.log('rsf-zero: Unknown command. Available commands: dev, build, start');

package/dist/debug.d.ts

@@ -0,0 +1,2 @@
+export declare const debug: (message: string, ...param: any[]) => void;
+//# sourceMappingURL=debug.d.ts.map

package/dist/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,KAAK,GAAI,SAAS,MAAM,EAAE,GAAG,OAAO,GAAG,EAAE,SAErD,CAAC"}

package/dist/export-types.d.ts

@@ -0,0 +1,5 @@
+import type serveStatic from "serve-static";
+export type RsfZeroOptions = {
+    startStatic?: serveStatic.ServeStaticOptions;
+};
+//# sourceMappingURL=export-types.d.ts.map

package/dist/export-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-types.d.ts","sourceRoot":"","sources":["../src/export-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,cAAc,CAAC;AAE5C,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC;CAC9C,CAAA"}

package/dist/export-types.js

@@ -0,0 +1 @@
+export {};

package/dist/lib/client.d.ts

@@ -0,0 +1,2 @@
+export declare const createActionCaller: (actionName: string) => (...args: any[]) => Promise<unknown>;
+//# sourceMappingURL=client.d.ts.map

package/dist/lib/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/lib/client.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,kBAAkB,GAAI,YAAY,MAAM,MACrC,GAAG,MAAM,GAAG,EAAE,qBAkB7B,CAAC"}

package/dist/options.d.ts

@@ -0,0 +1,11 @@
+import { RsfZeroOptions } from "./export-types.ts";
+/**
+ * Locate rsf0-config.js in the current project root (process.cwd()).
+ */
+export declare function findOptionsFile(cwd?: string): string | null;
+/**
+ * Load RSF options from rsf0-config.js at project root.
+ * Returns an empty object if no file is found or on safe failure.
+ */
+export declare function loadOptions(): Promise<RsfZeroOptions>;
+//# sourceMappingURL=options.d.ts.map

package/dist/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAMnD;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,GAAE,MAAsB,GAAG,MAAM,GAAG,IAAI,CAG1E;AAUD;;;GAGG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,cAAc,CAAC,CAiB3D"}

package/dist/options.js

@@ -0,0 +1,52 @@
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+import fs from 'fs';
+import path from 'path';
+import { pathToFileURL } from 'url';
+import { debug } from "./debug.js";
+const defaultOptions = {
+    startStatic: {},
+};
+/**
+ * Locate rsf0-config.js in the current project root (process.cwd()).
+ */
+export function findOptionsFile(cwd = process.cwd()) {
+    const jsPath = path.join(cwd, 'rsf0-config.js');
+    return fs.existsSync(jsPath) ? jsPath : null;
+}
+/**
+ * Dynamically import a JS module by absolute file path.
+ */
+async function importJsModule(absPath) {
+    const url = pathToFileURL(absPath).href;
+    return import(__rewriteRelativeImportExtension(url));
+}
+/**
+ * Load RSF options from rsf0-config.js at project root.
+ * Returns an empty object if no file is found or on safe failure.
+ */
+export async function loadOptions() {
+    const configPath = findOptionsFile();
+    if (!configPath)
+        return {};
+    try {
+        const mod = await importJsModule(configPath);
+        const options = (mod && (mod.default ?? mod.options ?? mod.rsf ?? mod.config ?? mod));
+        if (options && typeof options === 'object') {
+            debug('Options loaded: ' + configPath);
+            return options;
+        }
+        return {};
+    }
+    catch (err) {
+        // Fail soft: log a friendly message and continue with defaults
+        debug('No options file found at: ' + configPath);
+        return defaultOptions;
+    }
+}

package/dist/transform/asRelativeImport.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Converts any import e.g. absolute path to a relative one.
+ *
+ * Given `/User/x/my-file.ts, /User/x`
+ * Returns `./my-file.ts`
+ *
+ * Given `/User/x/my-file.ts, /User/somewhere-else`
+ * Returns `../x/my-file.ts`
+ *
+ * Can be passed an optional `replaceExtWith` param to replace the extension.
+ */
+export declare const asRelativeImport: (targetPath: string, relativeToPath: string, replaceExtWith?: string) => string;
+//# sourceMappingURL=asRelativeImport.d.ts.map

package/dist/transform/asRelativeImport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asRelativeImport.d.ts","sourceRoot":"","sources":["../../src/transform/asRelativeImport.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,GAAI,YAAY,MAAM,EAAE,gBAAgB,MAAM,EAAE,iBAAiB,MAAM,WAOnG,CAAA"}

package/dist/transform/client/transformRsfForClientPlugin.d.ts

@@ -0,0 +1,11 @@
+import type { Plugin } from "vite";
+import { Action } from "../../types.ts";
+/**
+ * This plugin sees a file with 'use server' and transforms it to a client-side version.
+ *
+ * The client-side version has the original code replaced with an API call to the server for that action.
+ *
+ * This plugin also registers all actions found via the passed onActionFound function.
+ */
+export declare const transformRsfForClientPlugin: (onActionFound: (action: Action) => void) => Plugin;
+//# sourceMappingURL=transformRsfForClientPlugin.d.ts.map

package/dist/transform/client/transformRsfForClientPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformRsfForClientPlugin.d.ts","sourceRoot":"","sources":["../../../src/transform/client/transformRsfForClientPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAEnC,OAAO,EAAC,MAAM,EAAC,MAAM,gBAAgB,CAAC;AAGtC;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,GAAI,eAAe,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,KAAI,MAWtF,CAAA"}

package/dist/transform/client/transformTopLevelRsf.d.ts

@@ -0,0 +1,6 @@
+import { Action } from "../../types.ts";
+/**
+ * Given a file that starts with 'use server', return a transformed client version of that file.
+ */
+export declare const transformTopLevelRsf: (id: string, code: string, onActionFound: (action: Action) => void) => string | undefined;
+//# sourceMappingURL=transformTopLevelRsf.d.ts.map

package/dist/transform/client/transformTopLevelRsf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformTopLevelRsf.d.ts","sourceRoot":"","sources":["../../../src/transform/client/transformTopLevelRsf.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,MAAM,EAAC,MAAM,gBAAgB,CAAC;AAGtC;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAE7B,IAAI,MAAM,EACV,MAAM,MAAM,EACZ,eAAe,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,KACtC,MAAM,GAAG,SA0Db,CAAC"}

package/dist/transform/collectExportNames.d.ts

@@ -0,0 +1,3 @@
+import * as swc from "@swc/core";
+export declare const collectExportNames: (mod: swc.Module) => Set<string>;
+//# sourceMappingURL=collectExportNames.d.ts.map

package/dist/transform/collectExportNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectExportNames.d.ts","sourceRoot":"","sources":["../../src/transform/collectExportNames.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,WAAW,CAAC;AAEjC,eAAO,MAAM,kBAAkB,GAAI,KAAK,GAAG,CAAC,MAAM,gBAsBjD,CAAC"}

package/dist/transform/extname.d.ts

@@ -0,0 +1,2 @@
+export declare const extname: (filePath: string) => string;
+//# sourceMappingURL=extname.d.ts.map

package/dist/transform/extname.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extname.d.ts","sourceRoot":"","sources":["../../src/transform/extname.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,GAAI,UAAU,MAAM,WASvC,CAAC"}

package/dist/transform/getActionId.d.ts

@@ -0,0 +1,2 @@
+export declare const getActionId: (sourceFilePath: string, actionName: string) => string;
+//# sourceMappingURL=getActionId.d.ts.map

package/dist/transform/getActionId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getActionId.d.ts","sourceRoot":"","sources":["../../src/transform/getActionId.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,WAAW,GAAI,gBAAgB,MAAM,EAAE,YAAY,MAAM,WAIrE,CAAA"}

package/dist/transform/isTopLevelRsfFile.d.ts

@@ -0,0 +1,2 @@
+export declare const isTopLevelRsfFile: (id: string, code: string) => boolean;
+//# sourceMappingURL=isTopLevelRsfFile.d.ts.map

package/dist/transform/isTopLevelRsfFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isTopLevelRsfFile.d.ts","sourceRoot":"","sources":["../../src/transform/isTopLevelRsfFile.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB,GAAI,IAAI,MAAM,EAAE,MAAM,MAAM,YAMzD,CAAC"}

package/dist/transform/replaceFileExt.d.ts

@@ -0,0 +1,2 @@
+export declare const replaceFileExt: (path: string, newExt: string) => string;
+//# sourceMappingURL=replaceFileExt.d.ts.map

package/dist/transform/replaceFileExt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"replaceFileExt.d.ts","sourceRoot":"","sources":["../../src/transform/replaceFileExt.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,QAAQ,MAAM,WAG1D,CAAA"}

package/dist/transform/server/generateActionRegistry.d.ts

@@ -0,0 +1,11 @@
+import { Action } from "../../types.ts";
+/**
+ * Create a typescript file that imports all actions. This can then be passed to a tsc to be processed into dist js files.
+ */
+export declare const generateActionRegistryTs: (actions: Action[], registryPath: string) => string;
+/**
+ * Create a javascript file that imports all actions. This is used by the start command to load action functions when the server starts.
+ */
+export declare const generateActionRegistryJs: (actions: Action[], relativeToDir: string) => string;
+export declare const generateEmptyActionRegistryJs: () => string;
+//# sourceMappingURL=generateActionRegistry.d.ts.map

package/dist/transform/server/generateActionRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateActionRegistry.d.ts","sourceRoot":"","sources":["../../../src/transform/server/generateActionRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,gBAAgB,CAAC;AAKtC;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,SAAS,MAAM,EAAE,EAAE,cAAc,MAAM,KAAG,MAoBlF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,SAAS,MAAM,EAAE,EAAE,eAAe,MAAM,KAAG,MA2BnF,CAAA;AAED,eAAO,MAAM,6BAA6B,QAAO,MAIhD,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+export type Action = {
+    id: string;
+    name: string;
+    sourceFilePath: string;
+};
+export type ActionRegistry = Record<Action['id'], CallableFunction>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;CACxB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC"}

package/package.json

@@ -3,7 +3,7 @@
   "description": "A minimal micro-framework with React Server Functions support",
   "author": "Igor Nadj",
   "type": "module",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "repository": {
     "type": "git",
     "url": "https://github.com/IgorNadj/rsf-zero.git",
@@ -41,6 +41,9 @@
     "./client": {
       "types": "./dist/lib/client.d.ts",
       "default": "./dist/lib/client.js"
+    },
+    "./server": {
+      "types": "./dist/export-types.d.ts"
     }
   },
   "files": [