@nuxtjp/local-runtime 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.ja.md +71 -0
  2. package/README.md +19 -35
  3. package/dist/module.json +1 -1
  4. package/package.json +3 -2
package/README.ja.md ADDED
@@ -0,0 +1,71 @@
1
+ # @nuxtjp/local-runtime
2
+
3
+ [English](README.md)
4
+
5
+ 利用者の明示操作で、ブラウザ画面から設定済みのローカルRustランタイムへ接続します。
6
+
7
+ ## 導入と使い方
8
+
9
+ `0.1.0`はnpmで公開済みです。Node `^22.19.0`または`^24.11.0`、Nuxt `^4.5.1`、Vue `^3.5.40`を使用してください。
10
+
11
+ ```sh
12
+ npm install @nuxtjp/local-runtime@0.1.0
13
+ ```
14
+
15
+ ```ts
16
+ export default defineNuxtConfig({
17
+ modules: ['@nuxtjp/local-runtime'],
18
+ nuxtJpLocalRuntime: {
19
+ endpoint: 'http://127.0.0.1:37843'
20
+ }
21
+ })
22
+ ```
23
+
24
+ ```vue
25
+ <script setup lang="ts">
26
+ const runtime = useLocalRuntime()
27
+
28
+ async function connect(): Promise<void> {
29
+ await runtime.connect(['workflow.issue.read'])
30
+ }
31
+ </script>
32
+
33
+ <template>
34
+ <NuxtJpLocalRuntimeStatus :state="runtime.state.value" />
35
+ <button type="button" @click="connect">
36
+ ローカルランタイムへ接続
37
+ </button>
38
+ </template>
39
+ ```
40
+
41
+ 接続先のhostは、ページのoriginを別途許可する必要があります。要求するcapabilityは利用アプリが指定します。Browser Local Network Accessの許可は、利用者とブラウザが管理します。
42
+
43
+ ## 責務と公開インターフェース
44
+
45
+ - 接続を始めるのは、利用者が明示的に操作した後だけです。
46
+ - 上限付きloopback応答を検証し、接続状態を表示します。
47
+ - Nuxtの初期表示はidleにします。build中に接続せず、`connect()`はブラウザでの明示操作として実行します。
48
+
49
+ 許可originとcapabilityは利用アプリが指定します。リソースの自動探索や認証情報の永続保存は行いません。
50
+ `/client`と`/guards`はJavaScriptと型宣言を配布します。`/types`は型専用importのための既存TypeScript定義、`/schema`はJSON schemaを公開します。
51
+
52
+ ## 開発と検証
53
+
54
+ `pnpm@10.29.3`と、`package.json`のenginesを満たすNodeを使用してください。
55
+
56
+ ```sh
57
+ pnpm install --frozen-lockfile
58
+ pnpm typecheck
59
+ pnpm test
60
+ pnpm build
61
+ ```
62
+
63
+ 検証入力はNuxt/kit/schema `4.5.1`、Vue `3.5.43`、Vitest `4.1.11`に固定しています。互換性のある依存修正でadvisoryを減らしましたが、残るadvisoryと未検証環境はリリース前に評価してください。Nodeとhostの最低条件はNuxtに合わせて引き上げています。
64
+ module/client API、loopback endpointの規則、明示接続の動作、ライセンス条件は維持しています。
65
+ ローカルTGZの試験は配布物の動作確認であり、registryの配布確認とは別です。操作・配備・公開には、それぞれの権限と設定が必要です。
66
+
67
+ ## 文書とライセンス
68
+
69
+ [使い方](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/docs/getting-started.md) · [Schema](schemas) · [実装](https://github.com/nuxtjp/nuxt-local-runtime/tree/main/src) · [テスト](https://github.com/nuxtjp/nuxt-local-runtime/tree/main/test) · [貢献方法](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/CONTRIBUTING.md) · [セキュリティ報告](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/SECURITY.md)
70
+
71
+ コードは[Apache-2.0](LICENSE)です。[NOTICE](NOTICE)と[以前の許諾](LICENSE-PREVIOUS)を保持してください。
package/README.md CHANGED
@@ -1,23 +1,17 @@
1
1
  # @nuxtjp/local-runtime
2
2
 
3
- 利用者の明示操作で、ブラウザ画面から設定済みのローカルRust環境へ接続できます。
3
+ [日本語](README.ja.md)
4
4
 
5
- ## 利用前の確認
5
+ Connect a browser interface to one explicitly configured local Rust runtime, after an explicit user operation.
6
6
 
7
- 実装済みの範囲、必要な依存関係、検証コマンドを以下の英語説明に併記しています。操作・配備・公開は、それぞれの権限と設定を確認してから実施してください。
7
+ ## Install and use
8
8
 
9
- ## 導入・使い方
10
-
11
- 以下は現行 API の利用例です。npm 上の配布状況を確認してから、対応版を install してください。ローカル TGZ の試験成功は、registry 配布の確認には含めません。
9
+ Version `0.1.0` is published on npm. Use Node `^22.19.0` or `^24.11.0`, Nuxt `^4.5.1` and Vue `^3.5.40`.
12
10
 
13
11
  ```sh
14
12
  npm install @nuxtjp/local-runtime@0.1.0
15
13
  ```
16
14
 
17
- Node ^22.19.0 / ^24.11.0、Nuxt ^4.5.1、Vue ^3.5.40 が必要です。
18
-
19
- ## Nuxt usage
20
-
21
15
  ```ts
22
16
  export default defineNuxtConfig({
23
17
  modules: ['@nuxtjp/local-runtime'],
@@ -39,34 +33,25 @@ async function connect(): Promise<void> {
39
33
  <template>
40
34
  <NuxtJpLocalRuntimeStatus :state="runtime.state.value" />
41
35
  <button type="button" @click="connect">
42
- ローカルランタイムへ接続
36
+ Connect to local runtime
43
37
  </button>
44
38
  </template>
45
39
  ```
46
40
 
47
- The host must separately allow the page origin. Browser Local Network Access
48
- permission remains a user- and browser-controlled gate.
49
-
50
- ## English
41
+ The host must separately allow the page origin. The application supplies the requested capabilities. Browser Local Network Access permission remains controlled by the user and browser.
51
42
 
52
- Connect a browser interface to one explicitly configured local Rust runtime.
43
+ ## Scope and interfaces
53
44
 
54
- ## What you can do
55
-
56
- - Start a connection only after an explicit user operation.
45
+ - Start connections only after an explicit user operation.
57
46
  - Validate bounded loopback responses and display connection state.
47
+ - Keep the initial Nuxt-rendered state idle. A build must not connect to a runtime; `connect()` remains an explicit browser action.
58
48
 
59
- ## Current scope
60
-
61
- The application supplies the allowed origin and capabilities. There is no automatic resource discovery or persistent credential storage.
49
+ The application supplies allowed origins and capabilities. The module does not discover resources automatically or persist credentials.
50
+ The `/client` and `/guards` subpaths ship JavaScript and declarations. `/types` exposes the existing raw TypeScript definitions for type-only imports; `/schema` exposes the JSON schema.
62
51
 
63
- Check npm availability before installation. Required hosts: Node ^22.19.0 or ^24.11.0, Nuxt ^4.5.1 and Vue ^3.5.40.
64
- The client and guards subpaths ship JavaScript and declarations; /types exposes the existing raw TypeScript definitions for type-only imports. /schema exposes the JSON schema.
65
- A Nuxt build must render the initial idle state without connecting to a runtime; connect() remains an explicit browser action.
52
+ ## Development and verification
66
53
 
67
- ## Getting started
68
-
69
- Use `pnpm@10.29.3` and the Node.js version declared in `engines` in `package.json`. Run from this repository:
54
+ Use `pnpm@10.29.3` and a Node version accepted by `package.json`:
70
55
 
71
56
  ```sh
72
57
  pnpm install --frozen-lockfile
@@ -75,13 +60,12 @@ pnpm test
75
60
  pnpm build
76
61
  ```
77
62
 
78
- ## Documentation and source
79
-
80
- [Usage guide](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/docs/getting-started.md)
63
+ The verification inputs pin Nuxt/kit/schema to `4.5.1`, Vue to `3.5.43` and Vitest to `4.1.11`. Compatible dependency fixes remove advisories; assess remaining advisories and untested environments before a release. Node and host compatibility floors were raised to match Nuxt.
64
+ The module/client API, loopback endpoint rules, explicit connection behavior and license terms are retained.
65
+ A local TGZ test proves archive behavior, not registry availability. Operations, deployment and publication require their own permissions and settings.
81
66
 
82
- [Schemas](schemas) · [Implementation and public interfaces](https://github.com/nuxtjp/nuxt-local-runtime/tree/main/src) · [Verification cases](https://github.com/nuxtjp/nuxt-local-runtime/tree/main/test) · [Contributing](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/CONTRIBUTING.md) · [Security reporting](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/SECURITY.md) · [License](LICENSE) · [Attribution notices](NOTICE)
67
+ ## Documentation and license
83
68
 
84
- ## Candidate changes
69
+ [Usage guide](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/docs/getting-started.md) · [Schemas](schemas) · [Source](https://github.com/nuxtjp/nuxt-local-runtime/tree/main/src) · [Tests](https://github.com/nuxtjp/nuxt-local-runtime/tree/main/test) · [Contributing](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/CONTRIBUTING.md) · [Security reporting](https://github.com/nuxtjp/nuxt-local-runtime/blob/main/SECURITY.md)
85
70
 
86
- Direct Nuxt/kit/schema pins 4.5.1, Vue 3.5.43 and Vitest 4.1.11 update the verification inputs; refreshed dependencies remove advisories with compatible fixes. Node and host compatibility floors were raised to match Nuxt.
87
- The module/client API, loopback endpoint rules, explicit connection behavior and license terms are retained. Remaining advisories and untested environments must be assessed before release.
71
+ Code: [Apache-2.0](LICENSE). Retain [NOTICE](NOTICE) and the prior grants in [LICENSE-PREVIOUS](LICENSE-PREVIOUS).
package/dist/module.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "compatibility": {
5
5
  "nuxt": "^4.5.1"
6
6
  },
7
- "version": "0.1.0",
7
+ "version": "0.1.1",
8
8
  "builder": {
9
9
  "@nuxt/module-builder": "1.0.2",
10
10
  "unbuild": "unknown"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nuxtjp/local-runtime",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Fail-closed Nuxt client for a loopback local runtime",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
@@ -15,7 +15,8 @@
15
15
  "LICENSE",
16
16
  "README.md",
17
17
  "NOTICE",
18
- "LICENSE-PREVIOUS"
18
+ "LICENSE-PREVIOUS",
19
+ "README.ja.md"
19
20
  ],
20
21
  "main": "./dist/module.mjs",
21
22
  "types": "./dist/types.d.mts",