node-riner 1.3.2 → 2.0.0

package/README.md

@@ -1,28 +1,85 @@
-# Ride Framework
+# Riner Framework (Node Riner)
 
-XMLファイルをベースに動的なHTMLページを生成し、Expressサーバーとして配信する軽量なSSR（Server-Side Rendering）ユーティリティです。
+Rinerは独自のファイルをhtmlに変換し、Expressサーバーで配信します。
 
-## 📦 インストール
-
-プロジェクトのルートディレクトリで以下のコマンドを実行してください。
+## インストール
 
 ```bash
 npm i node-riner@latest
 ```
-## Example
-index.rd
-``` RideFrameworks
+
+## 特長（主な機能）
+
+- RinerRideFile(.rd) から HTML を自動生成して Express で配信
+- `{ ... }` 内の JavaScript をサンドボックス実行して動的に値を埋め込み
+- 永続状態管理 riner.state（サーバ側に保存）
+- 永続的に実行される move（riner.move）を登録して state を更新
+- riner.out / riner.move / riner.off / riner.clear をテンプレートから利用可能
+- SSE（Server-Sent Events）で state の変更をクライアントに配信
+- REST API で state / moves の取得・更新が可能
+
+## 使い方（最小構成）
+
+index.rd（XML）
+```xml
 <Root>
-   <Page route="/">
-      <h1>hello world</h1>
-   </Page>
+  <Page route="/">
+    <Content>
+      <h1>Hello</h1>
+      <p>{riner.out(new Date().toString())}</p>
+    </Content>
+  </Page>
 </Root>
 ```
+
 main.ts
-```
+```ts
 import Riner from 'node-riner'
 
-let App = new Riner("my app")
-App.Ride("index.rd")
-App.serve(3000)
+const app = new Riner('my app')
+app.Ride('index.rd')      // XML を読み込む
+app.config({ siteName: 'MyBlog' }) // サーバ側既定コンテキスト
+app.serve(3000)           // サーバ起動
+```
+
+## riner API（テンプレート内で使用）
+
+- riner.out(...args) — 出力を収集して文字列化して埋め込む  
+- riner.move(fn) — 永続的な move を登録（fn は関数。例: () => counter = (counter||0)+1）  
+- riner.off(fnOrSrc) — 指定した move を解除（関数かソース文字列で指定）  
+- riner.clear() — 全ての move を削除  
+- riner.state — サーバ保存の state オブジェクトへ参照
+
+テンプレート例:
+```xml
+<p>{riner.out(counter)}</p>
+<p>{riner.move(() => counter = (counter || 0) + 1)}</p>
+```
+
+## サーバ側 API / SSE
+
+- GET  /__riner/state        — 現在の riner.state を返す（JSON）
+- POST /__riner/state        — JSON を送って state をマージ
+- GET  /__riner/moves        — 登録中の move 一覧を返す
+- POST /__riner/moves       — { source: "function source" } で move 登録
+- DELETE /__riner/moves     — { source: "function source" } で move 削除
+- SSE  /__riner/events       — state 更新を受け取る（リアルタイム）
+
+## 注意（セキュリティ）
+
+- テンプレート内の `{ ... }` はサンドボックス（vm）で実行しますが、任意コード実行のリスクは完全には無くなりません。  
+- 外部入力や未信頼のテンプレートを評価しないでください。プロダクションでは追加の制限・監査が必須です。
+
+## 例: Test.rd（サンプル）
+
+```xml
+<Root>
+  <Page route="/">
+    <Content>
+      <h1>My Blog</h1>
+      <p>{riner.out(new Date().toString())}</p>
+      <p>訪問回数: {riner.out(counter)}</p>
+    </Content>
+  </Page>
+</Root>
 ```

package/index.ts

@@ -17,6 +17,10 @@ export default class Ride {
     defaultinfo: string
     defaultContext: any                   // サーバ/アプリ側で渡したい既定のコンテキスト
 
+    // riner 用の持続状態と登録済み move 関数のソース一覧
+    private rinerState: Record<string, any>
+    private rinerMoves: string[]
+
     constructor(name: string) {
         this.F = ""
         this.parsedJson = {}
@@ -25,12 +29,50 @@ export default class Ride {
         this.name = name
         this.defaultinfo = ""
         this.defaultContext = {}
+        this.rinerState = {}
+        this.rinerMoves = []
+    }
+
+    /**
+     * 保存済み move 関数を sandbox 上で実行し、rinerState を同期する
+     * - ctx はそのまま sandbox に渡す（req 等を参照できるように）
+     * - move 関数内では riner.state または state のように直接変数を参照して変更可能
+     */
+    private runPersistedMoves(ctx: any = {}) {
+        if (!this.rinerMoves.length) return
+
+        // ベース sandbox：ctx をコピー
+        const sandboxBase: Record<string, any> = Object.assign({}, ctx)
+
+        // riner.state とトップレベル変数として現在の rinerState を注入
+        sandboxBase.riner = { state: this.rinerState }
+        Object.keys(this.rinerState).forEach(k => {
+            sandboxBase[k] = this.rinerState[k]
+        })
+
+        // 実行中にエラーが出ても次の move に進める
+        for (const src of this.rinerMoves) {
+            try {
+                // src は関数ソース文字列 (例: "() => cout += 1")
+                // 即時実行して state を更新させる
+                runInNewContext(`(${src})()`, sandboxBase, { timeout: 2000 })
+            } catch (e) {
+                // 失敗は無視（必要ならログを出す）
+                // console.error('move execution error', e)
+            }
+        }
+
+        // sandboxBase のトップレベル変数を rinerState に同期（riner/state は除外）
+        Object.keys(sandboxBase).forEach(k => {
+            if (k === 'riner' || k === 'console' || k === 'req' || k === 'server' || k === 'page' || k === 'data') return
+            this.rinerState[k] = sandboxBase[k]
+        })
     }
 
     /**
      * 値を再帰的に HTML に変換するユーティリティ
      * - ctx を渡すと { ... } 内のコードをそのコンテキストで評価する
-     * - 出力は console.log() の内容を優先して取得し、なければ評価結果を文字列化する
+     * - riner.out / riner.move / riner.state を提供
      */
     private renderValue(value: any, ctx: any = {}): string {
         if (value === null || value === undefined) return ''
@@ -42,26 +84,63 @@ export default class Ride {
                 let newValue = value
                 matches.forEach(m => {
                     const code = m.slice(1, -1) // 中身
-                    // sandbox を作り、console.log の出力を収集する
+
+                    // まず、保存済み move を実行して最新の状態にする
+                    this.runPersistedMoves(ctx)
+
+                    // 出力収集用
                     const output: string[] = []
-                    const sandbox = Object.assign({}, ctx, {
-                        console: {
-                            log: (...args: any[]) => output.push(args.join(' ')),
-                            error: (...args: any[]) => output.push(args.join(' ')),
-                            warn: (...args: any[]) => output.push(args.join(' '))
-                        }
+
+                    // sandbox を組み立て：ctx をコピー、riner、そしてトップレベルに rinerState を展開
+                    const sandbox: Record<string, any> = Object.assign({}, ctx)
+
+                    // riner オブジェクト（host 側のメソッドはクロスコンテキストで呼ばれる）
+                    sandbox.riner = {
+                        // 出力を収集するために riner.out を提供
+                        out: (...args: any[]) => output.push(args.map(a => String(a)).join(' ')),
+                        // riner.move は sandbox 内で関数を渡すと、その関数ソースを保存して以降持続的に実行される
+                        move: (fn: Function) => {
+                            try {
+                                const src = fn.toString()
+                                // 重複を避けるため同一ソースは再登録しない
+                                if (!this.rinerMoves.includes(src)) this.rinerMoves.push(src)
+                                return true
+                            } catch (e) {
+                                return false
+                            }
+                        },
+                        // 直接 state にアクセスできるように参照を渡す
+                        state: this.rinerState
+                    }
+
+                    // トップレベルでも直接 state の各キーを参照できるように注入
+                    Object.keys(this.rinerState).forEach(k => {
+                        sandbox[k] = this.rinerState[k]
                     })
 
-                    // まずは vm で実行（タイムアウト付き）
+                    // console を簡易的にラップして出力を収集
+                    sandbox.console = {
+                        log: (...args: any[]) => output.push(args.map(a => String(a)).join(' ')),
+                        error: (...args: any[]) => output.push(args.map(a => String(a)).join(' ')),
+                        warn: (...args: any[]) => output.push(args.map(a => String(a)).join(' '))
+                    }
+
+                    // 実行
+                    console.log(sandbox)
+                    console.log(code)
                     let res: any
                     try {
-                        // 実行が式でも文でも動くようにそのまま実行
                         res = runInNewContext(code, sandbox, { timeout: 2000 })
                     } catch (e) {
-                        // 実行に失敗したら空文字に
                         res = undefined
                     }
 
+                    // sandbox 上で変更されたトップレベル変数を rinerState に反映
+                    Object.keys(sandbox).forEach(k => {
+                        if (k === 'riner' || k === 'console' || k === 'req' || k === 'server' || k === 'page' || k === 'data') return
+                        this.rinerState[k] = sandbox[k]
+                    })
+
                     const out = output.length ? output.join('\n') : (res !== undefined ? String(res) : '')
                     newValue = newValue.replace(m, out)
                 })
@@ -164,7 +243,8 @@ export default class Ride {
      * Ride メソッド（ファイル読み込みと HTML 生成）
      */
     Ride(name: string) {
-        this.F = readFileSync(path.join(__dirname, "../../", name), { encoding: "utf-8"})
+        // this.F = readFileSync(path.join(__dirname, "../../", name), { encoding: "utf-8"})
+        this.F = readFileSync(path.join(process.cwd(), name), { encoding: "utf-8"})
         this.returnhtml()
     }
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "node-riner",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "main": "index.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "dev": "tsx script.ts"
+    "dev": "tsx t.ts"
   },
   "keywords": [],
   "author": "",

package/runs.js

@@ -1 +0,0 @@
-// debug