@nuxtjp/local-runtime 0.0.0-stage → 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.
- package/LICENSE +202 -0
- package/LICENSE-PREVIOUS +21 -0
- package/NOTICE +4 -0
- package/README.ja.md +71 -0
- package/README.md +70 -2
- package/dist/module.d.mts +10 -0
- package/dist/module.json +12 -0
- package/dist/module.mjs +33 -0
- package/dist/runtime/app/assets/local-runtime.css +1 -0
- package/dist/runtime/app/components/LocalRuntimeStatus.d.vue.ts +8 -0
- package/dist/runtime/app/components/LocalRuntimeStatus.vue +25 -0
- package/dist/runtime/app/components/LocalRuntimeStatus.vue.d.ts +8 -0
- package/dist/runtime/app/composables/useLocalRuntime.d.ts +92 -0
- package/dist/runtime/app/composables/useLocalRuntime.js +51 -0
- package/dist/runtime/client/client.d.ts +22 -0
- package/dist/runtime/client/client.js +117 -0
- package/dist/runtime/client/endpoint.d.ts +5 -0
- package/dist/runtime/client/endpoint.js +14 -0
- package/dist/runtime/client/index.d.ts +6 -0
- package/dist/runtime/client/index.js +4 -0
- package/dist/runtime/client/request.d.ts +5 -0
- package/dist/runtime/client/request.js +22 -0
- package/dist/runtime/client/response.d.ts +1 -0
- package/dist/runtime/client/response.js +36 -0
- package/dist/runtime/client/transport.d.ts +1 -0
- package/dist/runtime/client/transport.js +11 -0
- package/dist/runtime/shared/guards/manifest.d.ts +2 -0
- package/dist/runtime/shared/guards/manifest.js +71 -0
- package/dist/runtime/shared/guards/payload.d.ts +3 -0
- package/dist/runtime/shared/guards/payload.js +29 -0
- package/dist/runtime/shared/guards/primitives.d.ts +5 -0
- package/dist/runtime/shared/guards/primitives.js +16 -0
- package/dist/runtime/shared/guards/session.d.ts +2 -0
- package/dist/runtime/shared/guards/session.js +27 -0
- package/dist/runtime/shared/guards/view.d.ts +2 -0
- package/dist/runtime/shared/guards/view.js +22 -0
- package/dist/runtime/shared/guards.d.ts +4 -0
- package/dist/runtime/shared/guards.js +4 -0
- package/dist/runtime/shared/nuxt-imports.d.ts +9 -0
- package/dist/runtime/shared/security.d.ts +7 -0
- package/dist/runtime/shared/security.js +13 -0
- package/dist/runtime/shared/types.d.ts +95 -0
- package/dist/runtime/shared/types.js +0 -0
- package/dist/types.d.mts +3 -0
- package/package.json +75 -3
- package/schemas/local-runtime-v1.schema.json +332 -0
- package/src/runtime/shared/types.ts +126 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/LICENSE-PREVIOUS
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 NuxtJP contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/NOTICE
ADDED
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,3 +1,71 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @nuxtjp/local-runtime
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[日本語](README.ja.md)
|
|
4
|
+
|
|
5
|
+
Connect a browser interface to one explicitly configured local Rust runtime, after an explicit user operation.
|
|
6
|
+
|
|
7
|
+
## Install and use
|
|
8
|
+
|
|
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`.
|
|
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
|
+
Connect to local runtime
|
|
37
|
+
</button>
|
|
38
|
+
</template>
|
|
39
|
+
```
|
|
40
|
+
|
|
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.
|
|
42
|
+
|
|
43
|
+
## Scope and interfaces
|
|
44
|
+
|
|
45
|
+
- Start connections only after an explicit user operation.
|
|
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.
|
|
48
|
+
|
|
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.
|
|
51
|
+
|
|
52
|
+
## Development and verification
|
|
53
|
+
|
|
54
|
+
Use `pnpm@10.29.3` and a Node version accepted by `package.json`:
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
pnpm install --frozen-lockfile
|
|
58
|
+
pnpm typecheck
|
|
59
|
+
pnpm test
|
|
60
|
+
pnpm build
|
|
61
|
+
```
|
|
62
|
+
|
|
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.
|
|
66
|
+
|
|
67
|
+
## Documentation and license
|
|
68
|
+
|
|
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)
|
|
70
|
+
|
|
71
|
+
Code: [Apache-2.0](LICENSE). Retain [NOTICE](NOTICE) and the prior grants in [LICENSE-PREVIOUS](LICENSE-PREVIOUS).
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { NuxtModule } from '@nuxt/schema';
|
|
2
|
+
|
|
3
|
+
interface ModuleOptions {
|
|
4
|
+
endpoint: string;
|
|
5
|
+
componentPrefix: string;
|
|
6
|
+
}
|
|
7
|
+
declare const localRuntimeModule: NuxtModule<ModuleOptions>;
|
|
8
|
+
|
|
9
|
+
export { localRuntimeModule as default };
|
|
10
|
+
export type { ModuleOptions };
|
package/dist/module.json
ADDED
package/dist/module.mjs
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { defineNuxtModule, createResolver, addComponent, addImports } from '@nuxt/kit';
|
|
2
|
+
|
|
3
|
+
const localRuntimeModule = defineNuxtModule({
|
|
4
|
+
meta: {
|
|
5
|
+
name: "@nuxtjp/local-runtime",
|
|
6
|
+
configKey: "nuxtJpLocalRuntime",
|
|
7
|
+
compatibility: { nuxt: "^4.5.1" }
|
|
8
|
+
},
|
|
9
|
+
defaults: {
|
|
10
|
+
endpoint: "http://127.0.0.1:37843",
|
|
11
|
+
componentPrefix: "NuxtJp"
|
|
12
|
+
},
|
|
13
|
+
setup(options, nuxt) {
|
|
14
|
+
const resolver = createResolver(import.meta.url);
|
|
15
|
+
nuxt.options.runtimeConfig.public.nuxtJpLocalRuntime = {
|
|
16
|
+
endpoint: options.endpoint
|
|
17
|
+
};
|
|
18
|
+
addComponent({
|
|
19
|
+
name: `${options.componentPrefix}LocalRuntimeStatus`,
|
|
20
|
+
filePath: resolver.resolve("./runtime/app/components/LocalRuntimeStatus.vue")
|
|
21
|
+
});
|
|
22
|
+
addImports({
|
|
23
|
+
name: "useLocalRuntime",
|
|
24
|
+
from: resolver.resolve("./runtime/app/composables/useLocalRuntime")
|
|
25
|
+
});
|
|
26
|
+
const stylesheet = resolver.resolve("./runtime/app/assets/local-runtime.css");
|
|
27
|
+
if (!nuxt.options.css.includes(stylesheet)) {
|
|
28
|
+
nuxt.options.css.push(stylesheet);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
export { localRuntimeModule as default };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.nuxtjp-local-runtime{align-items:flex-start;background:#f6f8fb;border:1px solid #ccd4df;border-radius:.75rem;color:#1d2939;display:flex;gap:.75rem;padding:1rem}.nuxtjp-local-runtime__indicator{background:#667085;border-radius:999px;height:.75rem;margin-top:.3rem;width:.75rem}.nuxtjp-local-runtime[data-phase=connected] .nuxtjp-local-runtime__indicator{background:#067647}.nuxtjp-local-runtime[data-phase=denied] .nuxtjp-local-runtime__indicator,.nuxtjp-local-runtime[data-phase=unavailable] .nuxtjp-local-runtime__indicator{background:#b42318}.nuxtjp-local-runtime p{margin:.25rem 0 0}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { DeepReadonly } from 'vue';
|
|
2
|
+
import type { LocalRuntimeState } from '../../shared/types.js';
|
|
3
|
+
type __VLS_Props = {
|
|
4
|
+
state: DeepReadonly<LocalRuntimeState>;
|
|
5
|
+
};
|
|
6
|
+
declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
|
|
7
|
+
declare const _default: typeof __VLS_export;
|
|
8
|
+
export default _default;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<script setup>
|
|
2
|
+
defineProps({
|
|
3
|
+
state: { type: null, required: true }
|
|
4
|
+
});
|
|
5
|
+
</script>
|
|
6
|
+
|
|
7
|
+
<template>
|
|
8
|
+
<section
|
|
9
|
+
class="nuxtjp-local-runtime"
|
|
10
|
+
:data-phase="state.phase"
|
|
11
|
+
aria-live="polite"
|
|
12
|
+
>
|
|
13
|
+
<div class="nuxtjp-local-runtime__indicator" aria-hidden="true" />
|
|
14
|
+
<div>
|
|
15
|
+
<strong>{{ state.phase === "connected" ? "\u30ED\u30FC\u30AB\u30EB\u63A5\u7D9A\u6E08\u307F" : "\u30ED\u30FC\u30AB\u30EB\u63A5\u7D9A" }}</strong>
|
|
16
|
+
<p v-if="state.manifest">
|
|
17
|
+
{{ state.manifest.runtime_id }} ·
|
|
18
|
+
V8 {{ state.manifest.engine.status }} ·
|
|
19
|
+
外部送信 {{ state.manifest.security.external_egress }}
|
|
20
|
+
</p>
|
|
21
|
+
<p v-else-if="state.error">{{ state.error }}</p>
|
|
22
|
+
<p v-else>明示的に接続するまでローカル通信は開始されません。</p>
|
|
23
|
+
</div>
|
|
24
|
+
</section>
|
|
25
|
+
</template>
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { DeepReadonly } from 'vue';
|
|
2
|
+
import type { LocalRuntimeState } from '../../shared/types.js';
|
|
3
|
+
type __VLS_Props = {
|
|
4
|
+
state: DeepReadonly<LocalRuntimeState>;
|
|
5
|
+
};
|
|
6
|
+
declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
|
|
7
|
+
declare const _default: typeof __VLS_export;
|
|
8
|
+
export default _default;
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import type { ViewEnvelope } from '../../shared/types.js';
|
|
2
|
+
export declare function useLocalRuntime(): {
|
|
3
|
+
state: Readonly<import("vue").Ref<{
|
|
4
|
+
readonly phase: import("../../client/index.js").ConnectionPhase;
|
|
5
|
+
readonly manifest: {
|
|
6
|
+
readonly schema: "nuxtjp://local-runtime/manifest/v1";
|
|
7
|
+
readonly runtime_id: string;
|
|
8
|
+
readonly protocol_version: "1";
|
|
9
|
+
readonly mode: "local-simulation" | "local-production";
|
|
10
|
+
readonly external_actions: false;
|
|
11
|
+
readonly engine: {
|
|
12
|
+
readonly kind: "rust-v8";
|
|
13
|
+
readonly status: "disabled" | "simulated" | "ready";
|
|
14
|
+
readonly isolation: "in-process-simulation" | "process";
|
|
15
|
+
readonly arbitrary_network: false;
|
|
16
|
+
readonly arbitrary_filesystem: false;
|
|
17
|
+
};
|
|
18
|
+
readonly security: {
|
|
19
|
+
readonly default_band: "sealed";
|
|
20
|
+
readonly external_egress: "deny";
|
|
21
|
+
readonly allowed_origins: readonly string[];
|
|
22
|
+
readonly limits: {
|
|
23
|
+
readonly max_request_bytes: number;
|
|
24
|
+
readonly max_response_bytes: number;
|
|
25
|
+
readonly max_messages_per_minute: number;
|
|
26
|
+
readonly max_bytes_per_minute: number;
|
|
27
|
+
readonly session_ttl_seconds: number;
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
|
+
readonly capabilities: readonly {
|
|
31
|
+
readonly id: string;
|
|
32
|
+
readonly service_id: string;
|
|
33
|
+
readonly description: string;
|
|
34
|
+
readonly output_band: "session" | "public";
|
|
35
|
+
readonly payload_schema: {
|
|
36
|
+
readonly id: string;
|
|
37
|
+
readonly fields: readonly {
|
|
38
|
+
readonly name: string;
|
|
39
|
+
readonly kind: import("../../client/index.js").PayloadValueKind;
|
|
40
|
+
}[];
|
|
41
|
+
};
|
|
42
|
+
}[];
|
|
43
|
+
} | null;
|
|
44
|
+
readonly error: string | null;
|
|
45
|
+
}, {
|
|
46
|
+
readonly phase: import("../../client/index.js").ConnectionPhase;
|
|
47
|
+
readonly manifest: {
|
|
48
|
+
readonly schema: "nuxtjp://local-runtime/manifest/v1";
|
|
49
|
+
readonly runtime_id: string;
|
|
50
|
+
readonly protocol_version: "1";
|
|
51
|
+
readonly mode: "local-simulation" | "local-production";
|
|
52
|
+
readonly external_actions: false;
|
|
53
|
+
readonly engine: {
|
|
54
|
+
readonly kind: "rust-v8";
|
|
55
|
+
readonly status: "disabled" | "simulated" | "ready";
|
|
56
|
+
readonly isolation: "in-process-simulation" | "process";
|
|
57
|
+
readonly arbitrary_network: false;
|
|
58
|
+
readonly arbitrary_filesystem: false;
|
|
59
|
+
};
|
|
60
|
+
readonly security: {
|
|
61
|
+
readonly default_band: "sealed";
|
|
62
|
+
readonly external_egress: "deny";
|
|
63
|
+
readonly allowed_origins: readonly string[];
|
|
64
|
+
readonly limits: {
|
|
65
|
+
readonly max_request_bytes: number;
|
|
66
|
+
readonly max_response_bytes: number;
|
|
67
|
+
readonly max_messages_per_minute: number;
|
|
68
|
+
readonly max_bytes_per_minute: number;
|
|
69
|
+
readonly session_ttl_seconds: number;
|
|
70
|
+
};
|
|
71
|
+
};
|
|
72
|
+
readonly capabilities: readonly {
|
|
73
|
+
readonly id: string;
|
|
74
|
+
readonly service_id: string;
|
|
75
|
+
readonly description: string;
|
|
76
|
+
readonly output_band: "session" | "public";
|
|
77
|
+
readonly payload_schema: {
|
|
78
|
+
readonly id: string;
|
|
79
|
+
readonly fields: readonly {
|
|
80
|
+
readonly name: string;
|
|
81
|
+
readonly kind: import("../../client/index.js").PayloadValueKind;
|
|
82
|
+
}[];
|
|
83
|
+
};
|
|
84
|
+
}[];
|
|
85
|
+
} | null;
|
|
86
|
+
readonly error: string | null;
|
|
87
|
+
}>>;
|
|
88
|
+
connected: import("vue").ComputedRef<boolean>;
|
|
89
|
+
connect: (capabilities?: string[]) => Promise<void>;
|
|
90
|
+
view: (capabilityId: string, viewId: string) => Promise<ViewEnvelope>;
|
|
91
|
+
disconnect: () => Promise<void>;
|
|
92
|
+
};
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { computed, readonly, ref } from "vue";
|
|
2
|
+
import { useRuntimeConfig } from "#imports";
|
|
3
|
+
import { LocalRuntimeClient } from "../../client/client.js";
|
|
4
|
+
export function useLocalRuntime() {
|
|
5
|
+
const config = useRuntimeConfig();
|
|
6
|
+
const state = ref({
|
|
7
|
+
phase: "idle",
|
|
8
|
+
manifest: null,
|
|
9
|
+
error: null
|
|
10
|
+
});
|
|
11
|
+
let client = null;
|
|
12
|
+
async function connect(capabilities = []) {
|
|
13
|
+
state.value = { phase: "connecting", manifest: null, error: null };
|
|
14
|
+
try {
|
|
15
|
+
const endpoint = config.public.nuxtJpLocalRuntime.endpoint;
|
|
16
|
+
client = new LocalRuntimeClient({
|
|
17
|
+
endpoint,
|
|
18
|
+
origin: window.location.origin
|
|
19
|
+
});
|
|
20
|
+
const manifest = await client.manifest();
|
|
21
|
+
await client.connect(capabilities);
|
|
22
|
+
state.value = { phase: "connected", manifest, error: null };
|
|
23
|
+
} catch (error) {
|
|
24
|
+
client = null;
|
|
25
|
+
state.value = {
|
|
26
|
+
phase: error instanceof DOMException && error.name === "NotAllowedError" ? "denied" : "unavailable",
|
|
27
|
+
manifest: null,
|
|
28
|
+
error: error instanceof Error ? error.message : "\u63A5\u7D9A\u3067\u304D\u307E\u305B\u3093\u3067\u3057\u305F"
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
async function view(capabilityId, viewId) {
|
|
33
|
+
if (!client) throw new Error("local runtime is not connected");
|
|
34
|
+
return client.view(capabilityId, viewId);
|
|
35
|
+
}
|
|
36
|
+
async function disconnect() {
|
|
37
|
+
try {
|
|
38
|
+
await client?.disconnect();
|
|
39
|
+
} finally {
|
|
40
|
+
client = null;
|
|
41
|
+
state.value = { phase: "idle", manifest: null, error: null };
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
state: readonly(state),
|
|
46
|
+
connected: computed(() => state.value.phase === "connected"),
|
|
47
|
+
connect,
|
|
48
|
+
view,
|
|
49
|
+
disconnect
|
|
50
|
+
};
|
|
51
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { LocalRuntimeManifest, SessionGrant, ViewEnvelope } from '../shared/types.js';
|
|
2
|
+
export interface LocalRuntimeClientOptions {
|
|
3
|
+
endpoint: string;
|
|
4
|
+
origin: string;
|
|
5
|
+
fetcher?: typeof fetch;
|
|
6
|
+
maximumResponseBytes?: number;
|
|
7
|
+
timeoutMilliseconds?: number;
|
|
8
|
+
}
|
|
9
|
+
export declare class LocalRuntimeClient {
|
|
10
|
+
readonly endpoint: URL;
|
|
11
|
+
private readonly origin;
|
|
12
|
+
private readonly fetcher;
|
|
13
|
+
private readonly maximumResponseBytes;
|
|
14
|
+
private readonly timeoutMilliseconds;
|
|
15
|
+
private grant;
|
|
16
|
+
private runtimeManifest;
|
|
17
|
+
constructor(options: LocalRuntimeClientOptions);
|
|
18
|
+
manifest(): Promise<LocalRuntimeManifest>;
|
|
19
|
+
connect(capabilities: string[]): Promise<SessionGrant>;
|
|
20
|
+
view(capabilityId: string, viewId: string): Promise<ViewEnvelope>;
|
|
21
|
+
disconnect(): Promise<void>;
|
|
22
|
+
}
|