@timmo001/groundwork-desktop 0.0.0-stage → 0.27.0
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 +201 -0
- package/README.md +40 -2
- package/package.json +47 -4
- package/src/config.ts +244 -0
- package/src/login.ts +91 -0
- package/src/main.ts +613 -0
- package/src/rpc.ts +96 -0
- package/src/view.ts +584 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,41 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @timmo001/groundwork-desktop
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Groundwork's desktop defaults for an
|
|
4
|
+
[Electrobun](https://github.com/blackboardsh/electrobun) app: what people
|
|
5
|
+
expect from a browser window, such as find in page, zoom
|
|
6
|
+
keys, the right-click menu, a tray icon, one instance and the system's dark
|
|
7
|
+
mode and scale. An app that keeps working with its window closed, such as one
|
|
8
|
+
that runs a server, can run in the tray and start at login.
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
// src/bun/index.ts
|
|
12
|
+
import Electrobun, { BrowserView } from "electrobun/main";
|
|
13
|
+
import {
|
|
14
|
+
openDesktopWindow,
|
|
15
|
+
type DesktopRequests,
|
|
16
|
+
type DesktopSchema,
|
|
17
|
+
} from "@timmo001/groundwork-desktop/main";
|
|
18
|
+
|
|
19
|
+
import config from "../../desktop.config.ts";
|
|
20
|
+
|
|
21
|
+
await openDesktopWindow(Electrobun, {
|
|
22
|
+
title: "My app",
|
|
23
|
+
url: "views://mainview/index.html",
|
|
24
|
+
frame: { width: 760, height: 640 },
|
|
25
|
+
config,
|
|
26
|
+
createRPC: (requests: DesktopRequests) =>
|
|
27
|
+
BrowserView.defineRPC<DesktopSchema>({ handlers: { requests } }),
|
|
28
|
+
});
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
- `.` defines the app's desktop config. Every default is on unless the config
|
|
32
|
+
turns it off.
|
|
33
|
+
- `./main` opens the window from the main process, with the tray and the
|
|
34
|
+
requests the view makes.
|
|
35
|
+
- `./view` connects the page: find, the right-click menu, the browser keys,
|
|
36
|
+
in-app notices and the Omarchy theme.
|
|
37
|
+
|
|
38
|
+
The app brings its own `electrobun`, so it keeps the release it pins. The docs
|
|
39
|
+
are at
|
|
40
|
+
[groundwork.timmo.dev/desktop/building](https://groundwork.timmo.dev/desktop/building),
|
|
41
|
+
and `templates/desktop-app` is a starting point.
|
package/package.json
CHANGED
|
@@ -1,6 +1,49 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@timmo001/groundwork-desktop",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.27.0",
|
|
4
|
+
"description": "Groundwork's desktop defaults for Electrobun apps: the tray, find, zoom, the right-click menu, one instance, the system's mode and scale, and running in the tray",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": "./src/config.ts",
|
|
9
|
+
"./main": "./src/main.ts",
|
|
10
|
+
"./view": "./src/view.ts"
|
|
11
|
+
},
|
|
12
|
+
"files": [
|
|
13
|
+
"src",
|
|
14
|
+
"!src/**/*.test.ts",
|
|
15
|
+
"README.md",
|
|
16
|
+
"LICENSE"
|
|
17
|
+
],
|
|
18
|
+
"publishConfig": {
|
|
19
|
+
"access": "public",
|
|
20
|
+
"provenance": true
|
|
21
|
+
},
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "git+https://github.com/timmo001/groundwork.git",
|
|
25
|
+
"directory": "packages/desktop"
|
|
26
|
+
},
|
|
27
|
+
"scripts": {
|
|
28
|
+
"check": "bun run --parallel --no-exit-on-error lint typecheck format:check",
|
|
29
|
+
"test": "bun test",
|
|
30
|
+
"lint": "oxlint .",
|
|
31
|
+
"typecheck": "tsc",
|
|
32
|
+
"format": "prettier --write .",
|
|
33
|
+
"format:check": "prettier --check ."
|
|
34
|
+
},
|
|
35
|
+
"dependencies": {
|
|
36
|
+
"@timmo001/groundwork-tokens": "0.27.0",
|
|
37
|
+
"@timmo001/groundwork-ui": "0.27.0",
|
|
38
|
+
"effect": "4.1.4"
|
|
39
|
+
},
|
|
40
|
+
"devDependencies": {
|
|
41
|
+
"@oxlint/plugins": "1.93.0",
|
|
42
|
+
"@timmo001/oxlint-rules": "0.6.5",
|
|
43
|
+
"@types/bun": "1.4.4",
|
|
44
|
+
"oxlint": "1.93.0",
|
|
45
|
+
"oxlint-tsgolint": "7.0.2006",
|
|
46
|
+
"prettier": "3.10.0",
|
|
47
|
+
"typescript": "7.0.2"
|
|
48
|
+
}
|
|
49
|
+
}
|
package/src/config.ts
ADDED
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An app's `desktop.config`: every browser default a Groundwork desktop app
|
|
3
|
+
* gets, each on unless the config turns it off, so an empty config gives all
|
|
4
|
+
* of them. Shared by the main process and the view.
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
/** The tray icon, its tooltip and the image it shows. */
|
|
8
|
+
export interface TrayConfig {
|
|
9
|
+
/** An image path, or a `views://` URL to one bundled with the views. */
|
|
10
|
+
readonly image?: string;
|
|
11
|
+
/** Text beside the icon, where the system shows it. Empty by default. */
|
|
12
|
+
readonly title?: string;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* The text the desktop defaults show, for an app in another language or
|
|
17
|
+
* voice. Each defaults to the English below.
|
|
18
|
+
*/
|
|
19
|
+
export interface DesktopLabels {
|
|
20
|
+
/** The in-app notices' region. Defaults to `Notifications`. */
|
|
21
|
+
readonly notifications?: string;
|
|
22
|
+
/** The find field's label. Defaults to `Find in page`. */
|
|
23
|
+
readonly find?: string;
|
|
24
|
+
/** The find field's placeholder. Defaults to `Find`. */
|
|
25
|
+
readonly findPlaceholder?: string;
|
|
26
|
+
/** Defaults to `Previous match`. */
|
|
27
|
+
readonly previousMatch?: string;
|
|
28
|
+
/** Defaults to `Next match`. */
|
|
29
|
+
readonly nextMatch?: string;
|
|
30
|
+
/** Defaults to `Close find`. */
|
|
31
|
+
readonly closeFind?: string;
|
|
32
|
+
/** Defaults to `Cut`. */
|
|
33
|
+
readonly cut?: string;
|
|
34
|
+
/** Defaults to `Copy`. */
|
|
35
|
+
readonly copy?: string;
|
|
36
|
+
/** Defaults to `Paste`. */
|
|
37
|
+
readonly paste?: string;
|
|
38
|
+
/** Defaults to `Select all`. */
|
|
39
|
+
readonly selectAll?: string;
|
|
40
|
+
/** Defaults to `Copy link`. */
|
|
41
|
+
readonly copyLink?: string;
|
|
42
|
+
/** Defaults to `Open link in browser`. */
|
|
43
|
+
readonly openLink?: string;
|
|
44
|
+
/** The tray's item that shows the window. Defaults to `Show <title>`. */
|
|
45
|
+
readonly show?: string;
|
|
46
|
+
/** The tray's quit item. Defaults to `Quit`. */
|
|
47
|
+
readonly quit?: string;
|
|
48
|
+
/** The tray's start at login item. Defaults to `Start at login`. */
|
|
49
|
+
readonly startAtLogin?: string;
|
|
50
|
+
/** The notice when a download finishes. Defaults to `Download finished`. */
|
|
51
|
+
readonly downloadFinished?: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/** The labels with their defaults, `show` left to the window's title. */
|
|
55
|
+
export type ResolvedDesktopLabels = Required<Omit<DesktopLabels, "show">> &
|
|
56
|
+
Pick<DesktopLabels, "show">;
|
|
57
|
+
|
|
58
|
+
/** What a desktop app turns on, all optional. */
|
|
59
|
+
export interface DesktopConfig {
|
|
60
|
+
/** A tray icon that shows the window and quits. On by default. */
|
|
61
|
+
readonly tray?: boolean | TrayConfig;
|
|
62
|
+
/** System notifications instead of in-app ones. Off by default. */
|
|
63
|
+
readonly notifications?: boolean;
|
|
64
|
+
/** The page zoom on top of the system's scale, such as 0.8. Defaults to 1. */
|
|
65
|
+
readonly zoom?: number;
|
|
66
|
+
/** Ctrl + and - zoom, Ctrl+0 resets, remembered across launches. */
|
|
67
|
+
readonly zoomKeys?: boolean;
|
|
68
|
+
/** Cut, copy, paste, select all and link actions on right click. */
|
|
69
|
+
readonly contextMenu?: boolean;
|
|
70
|
+
/** Find in the page with Ctrl+F. */
|
|
71
|
+
readonly find?: boolean;
|
|
72
|
+
/** Reading and writing the clipboard from the view. */
|
|
73
|
+
readonly clipboard?: boolean;
|
|
74
|
+
/** F5 and Ctrl+R reload, Ctrl+Shift+R hard reloads. */
|
|
75
|
+
readonly reload?: boolean;
|
|
76
|
+
/** Back and forward with Alt+Left and Right and the mouse's side buttons. */
|
|
77
|
+
readonly history?: boolean;
|
|
78
|
+
/** Links to http(s) and `externalSchemes` open in the system browser. */
|
|
79
|
+
readonly externalLinks?: boolean;
|
|
80
|
+
/** Schemes besides http(s) that open outside the app. Defaults to `mailto`. */
|
|
81
|
+
readonly externalSchemes?: readonly string[];
|
|
82
|
+
/** A notice when a download finishes, with where it went. */
|
|
83
|
+
readonly downloads?: boolean;
|
|
84
|
+
/** Only one copy runs; opening another brings the first to the front. */
|
|
85
|
+
readonly singleInstance?: boolean;
|
|
86
|
+
/** The window opens at the size and place it closed at. */
|
|
87
|
+
readonly windowState?: boolean;
|
|
88
|
+
/** F12 and Ctrl+Shift+I open the dev tools, in dev builds only. */
|
|
89
|
+
readonly devTools?: boolean;
|
|
90
|
+
/** The system spell checker in text fields, where the webview has one. */
|
|
91
|
+
readonly spellcheck?: boolean;
|
|
92
|
+
/** Passes the app's deep links (`urlSchemes`) to the view. */
|
|
93
|
+
readonly deepLinks?: boolean;
|
|
94
|
+
/**
|
|
95
|
+
* Passes the desktop's Omarchy theme to the view, and every switch, where
|
|
96
|
+
* Omarchy is installed. `pageTheme` offers it and uses it until another
|
|
97
|
+
* theme is picked.
|
|
98
|
+
*/
|
|
99
|
+
readonly omarchyTheme?: boolean;
|
|
100
|
+
/**
|
|
101
|
+
* Origins the app's own pages come from besides its views, such as a server
|
|
102
|
+
* it runs on this machine (`http://127.0.0.1:7380`). Their pages load in
|
|
103
|
+
* the window, not the system browser. None by default.
|
|
104
|
+
*/
|
|
105
|
+
readonly ownOrigins?: readonly string[];
|
|
106
|
+
/**
|
|
107
|
+
* Closing the window leaves the app running in the tray, and the tray's
|
|
108
|
+
* show item opens it again. Needs the tray, and
|
|
109
|
+
* `runtime.exitOnLastWindowClosed: false` in `electrobun.config.ts`. Off by
|
|
110
|
+
* default.
|
|
111
|
+
*/
|
|
112
|
+
readonly runInTray?: boolean;
|
|
113
|
+
/**
|
|
114
|
+
* A start at login item in the tray, which starts the app in the tray when
|
|
115
|
+
* `runInTray` is on. Linux only for now, through an XDG autostart entry; the
|
|
116
|
+
* item is left out elsewhere. Off by default.
|
|
117
|
+
*/
|
|
118
|
+
readonly startAtLogin?: boolean;
|
|
119
|
+
/** The text the defaults show. English by default. */
|
|
120
|
+
readonly labels?: DesktopLabels;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/** Every option filled in. */
|
|
124
|
+
export interface ResolvedDesktopConfig {
|
|
125
|
+
readonly tray: false | Required<TrayConfig>;
|
|
126
|
+
readonly notifications: boolean;
|
|
127
|
+
readonly zoom: number;
|
|
128
|
+
readonly zoomKeys: boolean;
|
|
129
|
+
readonly contextMenu: boolean;
|
|
130
|
+
readonly find: boolean;
|
|
131
|
+
readonly clipboard: boolean;
|
|
132
|
+
readonly reload: boolean;
|
|
133
|
+
readonly history: boolean;
|
|
134
|
+
readonly externalLinks: boolean;
|
|
135
|
+
readonly externalSchemes: readonly string[];
|
|
136
|
+
readonly downloads: boolean;
|
|
137
|
+
readonly singleInstance: boolean;
|
|
138
|
+
readonly windowState: boolean;
|
|
139
|
+
readonly devTools: boolean;
|
|
140
|
+
readonly spellcheck: boolean;
|
|
141
|
+
readonly deepLinks: boolean;
|
|
142
|
+
readonly omarchyTheme: boolean;
|
|
143
|
+
readonly ownOrigins: readonly string[];
|
|
144
|
+
readonly runInTray: boolean;
|
|
145
|
+
readonly startAtLogin: boolean;
|
|
146
|
+
readonly labels: ResolvedDesktopLabels;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
/** Types a config in the app's `desktop.config.ts`. */
|
|
150
|
+
export const defineDesktopConfig = (
|
|
151
|
+
config: DesktopConfig = {},
|
|
152
|
+
): DesktopConfig => config;
|
|
153
|
+
|
|
154
|
+
/** Fills in the defaults. */
|
|
155
|
+
export const resolveConfig = (
|
|
156
|
+
config: DesktopConfig = {},
|
|
157
|
+
): ResolvedDesktopConfig => {
|
|
158
|
+
const tray = config.tray ?? true;
|
|
159
|
+
const trayConfig: TrayConfig = tray === true || tray === false ? {} : tray;
|
|
160
|
+
|
|
161
|
+
return {
|
|
162
|
+
tray:
|
|
163
|
+
tray === false
|
|
164
|
+
? false
|
|
165
|
+
: {
|
|
166
|
+
image: trayConfig.image ?? "views://tray/icon.png",
|
|
167
|
+
title: trayConfig.title ?? "",
|
|
168
|
+
},
|
|
169
|
+
notifications: config.notifications ?? false,
|
|
170
|
+
zoom: config.zoom ?? 1,
|
|
171
|
+
zoomKeys: config.zoomKeys ?? true,
|
|
172
|
+
contextMenu: config.contextMenu ?? true,
|
|
173
|
+
find: config.find ?? true,
|
|
174
|
+
clipboard: config.clipboard ?? true,
|
|
175
|
+
reload: config.reload ?? true,
|
|
176
|
+
history: config.history ?? true,
|
|
177
|
+
externalLinks: config.externalLinks ?? true,
|
|
178
|
+
externalSchemes: config.externalSchemes ?? ["mailto"],
|
|
179
|
+
downloads: config.downloads ?? true,
|
|
180
|
+
singleInstance: config.singleInstance ?? true,
|
|
181
|
+
windowState: config.windowState ?? true,
|
|
182
|
+
devTools: config.devTools ?? true,
|
|
183
|
+
spellcheck: config.spellcheck ?? true,
|
|
184
|
+
deepLinks: config.deepLinks ?? true,
|
|
185
|
+
omarchyTheme: config.omarchyTheme ?? true,
|
|
186
|
+
ownOrigins: config.ownOrigins ?? [],
|
|
187
|
+
// Both live in the tray, so neither works without it
|
|
188
|
+
runInTray: tray !== false && (config.runInTray ?? false),
|
|
189
|
+
startAtLogin: tray !== false && (config.startAtLogin ?? false),
|
|
190
|
+
labels: {
|
|
191
|
+
notifications: "Notifications",
|
|
192
|
+
find: "Find in page",
|
|
193
|
+
findPlaceholder: "Find",
|
|
194
|
+
previousMatch: "Previous match",
|
|
195
|
+
nextMatch: "Next match",
|
|
196
|
+
closeFind: "Close find",
|
|
197
|
+
cut: "Cut",
|
|
198
|
+
copy: "Copy",
|
|
199
|
+
paste: "Paste",
|
|
200
|
+
selectAll: "Select all",
|
|
201
|
+
copyLink: "Copy link",
|
|
202
|
+
openLink: "Open link in browser",
|
|
203
|
+
quit: "Quit",
|
|
204
|
+
startAtLogin: "Start at login",
|
|
205
|
+
downloadFinished: "Download finished",
|
|
206
|
+
...config.labels,
|
|
207
|
+
},
|
|
208
|
+
};
|
|
209
|
+
};
|
|
210
|
+
|
|
211
|
+
/** The origin of a URL, such as `http://127.0.0.1:7380`, if it has one. */
|
|
212
|
+
const originOf = (url: string): string | undefined => {
|
|
213
|
+
const origin = URL.parse(url)?.origin;
|
|
214
|
+
|
|
215
|
+
return origin === undefined || origin === "null" ? undefined : origin;
|
|
216
|
+
};
|
|
217
|
+
|
|
218
|
+
/** Whether a URL is one of the app's own pages from `ownOrigins`. */
|
|
219
|
+
export const isOwnOrigin = (
|
|
220
|
+
url: string,
|
|
221
|
+
config: ResolvedDesktopConfig,
|
|
222
|
+
): boolean => {
|
|
223
|
+
const origin = originOf(url);
|
|
224
|
+
|
|
225
|
+
return (
|
|
226
|
+
origin !== undefined &&
|
|
227
|
+
config.ownOrigins.some((own) => originOf(own) === origin)
|
|
228
|
+
);
|
|
229
|
+
};
|
|
230
|
+
|
|
231
|
+
/** Whether a URL may open in the system browser under this config. */
|
|
232
|
+
export const isExternal = (
|
|
233
|
+
url: string,
|
|
234
|
+
config: ResolvedDesktopConfig,
|
|
235
|
+
): boolean => {
|
|
236
|
+
if (isOwnOrigin(url, config)) return false;
|
|
237
|
+
const scheme = /^([a-z][a-z0-9+.-]*):/i.exec(url)?.[1]?.toLowerCase();
|
|
238
|
+
|
|
239
|
+
return (
|
|
240
|
+
scheme === "http" ||
|
|
241
|
+
scheme === "https" ||
|
|
242
|
+
(scheme !== undefined && config.externalSchemes.includes(scheme))
|
|
243
|
+
);
|
|
244
|
+
};
|
package/src/login.ts
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Start at login for `openDesktopWindow`'s tray item. On Linux it's an XDG
|
|
3
|
+
* autostart entry that runs the app's launcher with `GROUNDWORK_DESKTOP_HIDDEN`
|
|
4
|
+
* set, so an app with `runInTray` starts in the tray. Electrobun's launcher
|
|
5
|
+
* doesn't pass its arguments on to the main process, hence the variable.
|
|
6
|
+
*/
|
|
7
|
+
import { mkdir, rm } from "node:fs/promises";
|
|
8
|
+
import { homedir } from "node:os";
|
|
9
|
+
import { dirname, join } from "node:path";
|
|
10
|
+
|
|
11
|
+
import { Option, Schema } from "effect";
|
|
12
|
+
|
|
13
|
+
/** Set to `1` when the app starts at login, so it opens in the tray. */
|
|
14
|
+
export const hiddenVariable = "GROUNDWORK_DESKTOP_HIDDEN";
|
|
15
|
+
|
|
16
|
+
/** Turns starting at login on or off. */
|
|
17
|
+
export interface LoginItem {
|
|
18
|
+
readonly enabled: () => Promise<boolean>;
|
|
19
|
+
readonly set: (enabled: boolean) => Promise<void>;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
const decodeVersion = Schema.decodeUnknownOption(
|
|
23
|
+
Schema.Struct({
|
|
24
|
+
identifier: Schema.String,
|
|
25
|
+
name: Schema.String,
|
|
26
|
+
channel: Schema.String,
|
|
27
|
+
}),
|
|
28
|
+
);
|
|
29
|
+
|
|
30
|
+
// An Exec argument in double quotes, then escaped again as a string value,
|
|
31
|
+
// as the Desktop Entry spec has it
|
|
32
|
+
const execArgument = (value: string): string =>
|
|
33
|
+
`"${value.replaceAll(/["`$\\]/g, (character) => `\\${character}`)}"`.replaceAll(
|
|
34
|
+
"\\",
|
|
35
|
+
"\\\\",
|
|
36
|
+
);
|
|
37
|
+
|
|
38
|
+
/** The entry an app with this name starts from at login. */
|
|
39
|
+
export const autostartEntry = (name: string, launcher: string): string =>
|
|
40
|
+
[
|
|
41
|
+
"[Desktop Entry]",
|
|
42
|
+
"Type=Application",
|
|
43
|
+
`Name=${name}`,
|
|
44
|
+
`Exec=env ${hiddenVariable}=1 ${execArgument(launcher)}`,
|
|
45
|
+
"Terminal=false",
|
|
46
|
+
"X-GNOME-Autostart-enabled=true",
|
|
47
|
+
"",
|
|
48
|
+
].join("\n");
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* The app's start at login item, or `undefined` where there's none: off
|
|
52
|
+
* Linux, or outside a built app. The entry is named for the app's identifier,
|
|
53
|
+
* with the channel after it for builds other than stable.
|
|
54
|
+
*/
|
|
55
|
+
export const loginItem = async (): Promise<LoginItem | undefined> => {
|
|
56
|
+
if (process.platform !== "linux") return undefined;
|
|
57
|
+
const bin = dirname(process.execPath);
|
|
58
|
+
|
|
59
|
+
const version = decodeVersion(
|
|
60
|
+
await Bun.file(join(bin, "..", "Resources", "version.json"))
|
|
61
|
+
.json()
|
|
62
|
+
.catch(() => undefined),
|
|
63
|
+
);
|
|
64
|
+
|
|
65
|
+
if (Option.isNone(version)) return undefined;
|
|
66
|
+
const { identifier, name, channel } = version.value;
|
|
67
|
+
|
|
68
|
+
const folder = join(
|
|
69
|
+
process.env.XDG_CONFIG_HOME || join(homedir(), ".config"),
|
|
70
|
+
"autostart",
|
|
71
|
+
);
|
|
72
|
+
|
|
73
|
+
const path = join(
|
|
74
|
+
folder,
|
|
75
|
+
`${identifier}${channel === "stable" ? "" : `-${channel}`}.desktop`,
|
|
76
|
+
);
|
|
77
|
+
|
|
78
|
+
return {
|
|
79
|
+
enabled: () => Bun.file(path).exists(),
|
|
80
|
+
set: async (enabled) => {
|
|
81
|
+
if (!enabled) {
|
|
82
|
+
await rm(path, { force: true });
|
|
83
|
+
|
|
84
|
+
return;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
await mkdir(folder, { recursive: true });
|
|
88
|
+
await Bun.write(path, autostartEntry(name, join(bin, "launcher")));
|
|
89
|
+
},
|
|
90
|
+
};
|
|
91
|
+
};
|