Compare commits
11
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2929d7d5e4 | ||
|
|
493f899a11 | ||
|
|
68e886c142 | ||
|
|
9e13ea9c40 | ||
|
|
058cdc20ab | ||
|
|
7f68a72e2b | ||
|
|
8e4f3ff951 | ||
|
|
67b5dc5965 | ||
|
|
9555db9bf5 | ||
|
|
a7d398ad6a | ||
|
|
a55a7a9170 |
@@ -30,7 +30,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v4
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version-file: .nvmrc
|
||||||
cache: npm
|
cache: npm
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
|
|||||||
@@ -1,426 +0,0 @@
|
|||||||
StepForge
|
|
||||||
Copyright (c) 2026 Tyler Westbrook
|
|
||||||
|
|
||||||
This work is licensed under the Creative Commons
|
|
||||||
Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0).
|
|
||||||
|
|
||||||
You are free to use, copy, modify, and share this software for
|
|
||||||
NON-COMMERCIAL purposes, with attribution. You may NOT use it for
|
|
||||||
commercial purposes without separate written permission from the
|
|
||||||
copyright holder.
|
|
||||||
|
|
||||||
License summary: https://creativecommons.org/licenses/by-nc/4.0/
|
|
||||||
SPDX-License-Identifier: CC-BY-NC-4.0
|
|
||||||
|
|
||||||
The full legal text of the license follows.
|
|
||||||
|
|
||||||
=======================================================================
|
|
||||||
|
|
||||||
Attribution-NonCommercial 4.0 International
|
|
||||||
|
|
||||||
=======================================================================
|
|
||||||
|
|
||||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
|
||||||
does not provide legal services or legal advice. Distribution of
|
|
||||||
Creative Commons public licenses does not create a lawyer-client or
|
|
||||||
other relationship. Creative Commons makes its licenses and related
|
|
||||||
information available on an "as-is" basis. Creative Commons gives no
|
|
||||||
warranties regarding its licenses, any material licensed under their
|
|
||||||
terms and conditions, or any related information. Creative Commons
|
|
||||||
disclaims all liability for damages resulting from their use to the
|
|
||||||
fullest extent possible.
|
|
||||||
|
|
||||||
Using Creative Commons Public Licenses
|
|
||||||
|
|
||||||
Creative Commons public licenses provide a standard set of terms and
|
|
||||||
conditions that creators and other rights holders may use to share
|
|
||||||
original works of authorship and other material subject to copyright
|
|
||||||
and certain other rights specified in the public license below. The
|
|
||||||
following considerations are for informational purposes only, are not
|
|
||||||
exhaustive, and do not form part of our licenses.
|
|
||||||
|
|
||||||
Considerations for licensors: Our public licenses are
|
|
||||||
intended for use by those authorized to give the public
|
|
||||||
permission to use material in ways otherwise restricted by
|
|
||||||
copyright and certain other rights. Our licenses are
|
|
||||||
irrevocable. Licensors should read and understand the terms
|
|
||||||
and conditions of the license they choose before applying it.
|
|
||||||
Licensors should also secure all rights necessary before
|
|
||||||
applying our licenses so that the public can reuse the
|
|
||||||
material as expected. Licensors should clearly mark any
|
|
||||||
material not subject to the license. This includes other CC-
|
|
||||||
licensed material, or material used under an exception or
|
|
||||||
limitation to copyright. More considerations for licensors:
|
|
||||||
wiki.creativecommons.org/Considerations_for_licensors
|
|
||||||
|
|
||||||
Considerations for the public: By using one of our public
|
|
||||||
licenses, a licensor grants the public permission to use the
|
|
||||||
licensed material under specified terms and conditions. If
|
|
||||||
the licensor's permission is not necessary for any reason--for
|
|
||||||
example, because of any applicable exception or limitation to
|
|
||||||
copyright--then that use is not regulated by the license. Our
|
|
||||||
licenses grant only permissions under copyright and certain
|
|
||||||
other rights that a licensor has authority to grant. Use of
|
|
||||||
the licensed material may still be restricted for other
|
|
||||||
reasons, including because others have copyright or other
|
|
||||||
rights in the material. A licensor may make special requests,
|
|
||||||
such as asking that all changes be marked or described.
|
|
||||||
Although not required by our licenses, you are encouraged to
|
|
||||||
respect those requests where reasonable. More considerations
|
|
||||||
for the public:
|
|
||||||
wiki.creativecommons.org/Considerations_for_licensees
|
|
||||||
|
|
||||||
=======================================================================
|
|
||||||
|
|
||||||
Creative Commons Attribution-NonCommercial 4.0 International Public
|
|
||||||
License
|
|
||||||
|
|
||||||
By exercising the Licensed Rights (defined below), You accept and agree
|
|
||||||
to be bound by the terms and conditions of this Creative Commons
|
|
||||||
Attribution-NonCommercial 4.0 International Public License ("Public
|
|
||||||
License"). To the extent this Public License may be interpreted as a
|
|
||||||
contract, You are granted the Licensed Rights in consideration of Your
|
|
||||||
acceptance of these terms and conditions, and the Licensor grants You
|
|
||||||
such rights in consideration of benefits the Licensor receives from
|
|
||||||
making the Licensed Material available under these terms and
|
|
||||||
conditions.
|
|
||||||
|
|
||||||
|
|
||||||
Section 1 -- Definitions.
|
|
||||||
|
|
||||||
a. Adapted Material means material subject to Copyright and Similar
|
|
||||||
Rights that is derived from or based upon the Licensed Material
|
|
||||||
and in which the Licensed Material is translated, altered,
|
|
||||||
arranged, transformed, or otherwise modified in a manner requiring
|
|
||||||
permission under the Copyright and Similar Rights held by the
|
|
||||||
Licensor. For purposes of this Public License, where the Licensed
|
|
||||||
Material is a musical work, performance, or sound recording,
|
|
||||||
Adapted Material is always produced where the Licensed Material is
|
|
||||||
synched in timed relation with a moving image.
|
|
||||||
|
|
||||||
b. Adapter's License means the license You apply to Your Copyright
|
|
||||||
and Similar Rights in Your contributions to Adapted Material in
|
|
||||||
accordance with the terms and conditions of this Public License.
|
|
||||||
|
|
||||||
c. Copyright and Similar Rights means copyright and/or similar rights
|
|
||||||
closely related to copyright including, without limitation,
|
|
||||||
performance, broadcast, sound recording, and Sui Generis Database
|
|
||||||
Rights, without regard to how the rights are labeled or
|
|
||||||
categorized. For purposes of this Public License, the rights
|
|
||||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
|
||||||
Rights.
|
|
||||||
d. Effective Technological Measures means those measures that, in the
|
|
||||||
absence of proper authority, may not be circumvented under laws
|
|
||||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
|
||||||
Treaty adopted on December 20, 1996, and/or similar international
|
|
||||||
agreements.
|
|
||||||
|
|
||||||
e. Exceptions and Limitations means fair use, fair dealing, and/or
|
|
||||||
any other exception or limitation to Copyright and Similar Rights
|
|
||||||
that applies to Your use of the Licensed Material.
|
|
||||||
|
|
||||||
f. Licensed Material means the artistic or literary work, database,
|
|
||||||
or other material to which the Licensor applied this Public
|
|
||||||
License.
|
|
||||||
|
|
||||||
g. Licensed Rights means the rights granted to You subject to the
|
|
||||||
terms and conditions of this Public License, which are limited to
|
|
||||||
all Copyright and Similar Rights that apply to Your use of the
|
|
||||||
Licensed Material and that the Licensor has authority to license.
|
|
||||||
|
|
||||||
h. Licensor means the individual(s) or entity(ies) granting rights
|
|
||||||
under this Public License.
|
|
||||||
|
|
||||||
i. NonCommercial means not primarily intended for or directed towards
|
|
||||||
commercial advantage or monetary compensation. For purposes of
|
|
||||||
this Public License, the exchange of the Licensed Material for
|
|
||||||
other material subject to Copyright and Similar Rights by digital
|
|
||||||
file-sharing or similar means is NonCommercial provided there is
|
|
||||||
no payment of monetary compensation in connection with the
|
|
||||||
exchange.
|
|
||||||
|
|
||||||
j. Share means to provide material to the public by any means or
|
|
||||||
process that requires permission under the Licensed Rights, such
|
|
||||||
as reproduction, public display, public performance, distribution,
|
|
||||||
dissemination, communication, or importation, and to make material
|
|
||||||
available to the public including in ways that members of the
|
|
||||||
public may access the material from a place and at a time
|
|
||||||
individually chosen by them.
|
|
||||||
|
|
||||||
k. Sui Generis Database Rights means rights other than copyright
|
|
||||||
resulting from Directive 96/9/EC of the European Parliament and of
|
|
||||||
the Council of 11 March 1996 on the legal protection of databases,
|
|
||||||
as amended and/or succeeded, as well as other essentially
|
|
||||||
equivalent rights anywhere in the world.
|
|
||||||
|
|
||||||
l. You means the individual or entity exercising the Licensed Rights
|
|
||||||
under this Public License. Your has a corresponding meaning.
|
|
||||||
|
|
||||||
|
|
||||||
Section 2 -- Scope.
|
|
||||||
|
|
||||||
a. License grant.
|
|
||||||
|
|
||||||
1. Subject to the terms and conditions of this Public License,
|
|
||||||
the Licensor hereby grants You a worldwide, royalty-free,
|
|
||||||
non-sublicensable, non-exclusive, irrevocable license to
|
|
||||||
exercise the Licensed Rights in the Licensed Material to:
|
|
||||||
|
|
||||||
a. reproduce and Share the Licensed Material, in whole or
|
|
||||||
in part, for NonCommercial purposes only; and
|
|
||||||
|
|
||||||
b. produce, reproduce, and Share Adapted Material for
|
|
||||||
NonCommercial purposes only.
|
|
||||||
|
|
||||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
|
||||||
Exceptions and Limitations apply to Your use, this Public
|
|
||||||
License does not apply, and You do not need to comply with
|
|
||||||
its terms and conditions.
|
|
||||||
|
|
||||||
3. Term. The term of this Public License is specified in Section
|
|
||||||
6(a).
|
|
||||||
|
|
||||||
4. Media and formats; technical modifications allowed. The
|
|
||||||
Licensor authorizes You to exercise the Licensed Rights in
|
|
||||||
all media and formats whether now known or hereafter created,
|
|
||||||
and to make technical modifications necessary to do so. The
|
|
||||||
Licensor waives and/or agrees not to assert any right or
|
|
||||||
authority to forbid You from making technical modifications
|
|
||||||
necessary to exercise the Licensed Rights, including
|
|
||||||
technical modifications necessary to circumvent Effective
|
|
||||||
Technological Measures. For purposes of this Public License,
|
|
||||||
simply making modifications authorized by this Section 2(a)
|
|
||||||
(4) never produces Adapted Material.
|
|
||||||
|
|
||||||
5. Downstream recipients.
|
|
||||||
|
|
||||||
a. Offer from the Licensor -- Licensed Material. Every
|
|
||||||
recipient of the Licensed Material automatically
|
|
||||||
receives an offer from the Licensor to exercise the
|
|
||||||
Licensed Rights under the terms and conditions of this
|
|
||||||
Public License.
|
|
||||||
|
|
||||||
b. No downstream restrictions. You may not offer or impose
|
|
||||||
any additional or different terms or conditions on, or
|
|
||||||
apply any Effective Technological Measures to, the
|
|
||||||
Licensed Material if doing so restricts exercise of the
|
|
||||||
Licensed Rights by any recipient of the Licensed
|
|
||||||
Material.
|
|
||||||
|
|
||||||
6. No endorsement. Nothing in this Public License constitutes or
|
|
||||||
may be construed as permission to assert or imply that You
|
|
||||||
are, or that Your use of the Licensed Material is, connected
|
|
||||||
with, or sponsored, endorsed, or granted official status by,
|
|
||||||
the Licensor or others designated to receive attribution as
|
|
||||||
provided in Section 3(a)(1)(A)(i).
|
|
||||||
|
|
||||||
b. Other rights.
|
|
||||||
|
|
||||||
1. Moral rights, such as the right of integrity, are not
|
|
||||||
licensed under this Public License, nor are publicity,
|
|
||||||
privacy, and/or other similar personality rights; however, to
|
|
||||||
the extent possible, the Licensor waives and/or agrees not to
|
|
||||||
assert any such rights held by the Licensor to the limited
|
|
||||||
extent necessary to allow You to exercise the Licensed
|
|
||||||
Rights, but not otherwise.
|
|
||||||
|
|
||||||
2. Patent and trademark rights are not licensed under this
|
|
||||||
Public License.
|
|
||||||
|
|
||||||
3. To the extent possible, the Licensor waives any right to
|
|
||||||
collect royalties from You for the exercise of the Licensed
|
|
||||||
Rights, whether directly or through a collecting society
|
|
||||||
under any voluntary or waivable statutory or compulsory
|
|
||||||
licensing scheme. In all other cases the Licensor expressly
|
|
||||||
reserves any right to collect such royalties, including when
|
|
||||||
the Licensed Material is used other than for NonCommercial
|
|
||||||
purposes.
|
|
||||||
|
|
||||||
|
|
||||||
Section 3 -- License Conditions.
|
|
||||||
|
|
||||||
Your exercise of the Licensed Rights is expressly made subject to the
|
|
||||||
following conditions.
|
|
||||||
|
|
||||||
a. Attribution.
|
|
||||||
|
|
||||||
1. If You Share the Licensed Material (including in modified
|
|
||||||
form), You must:
|
|
||||||
|
|
||||||
a. retain the following if it is supplied by the Licensor
|
|
||||||
with the Licensed Material:
|
|
||||||
|
|
||||||
i. identification of the creator(s) of the Licensed
|
|
||||||
Material and any others designated to receive
|
|
||||||
attribution, in any reasonable manner requested by
|
|
||||||
the Licensor (including by pseudonym if
|
|
||||||
designated);
|
|
||||||
|
|
||||||
ii. a copyright notice;
|
|
||||||
|
|
||||||
iii. a notice that refers to this Public License;
|
|
||||||
|
|
||||||
iv. a notice that refers to the disclaimer of
|
|
||||||
warranties;
|
|
||||||
|
|
||||||
v. a URI or hyperlink to the Licensed Material to the
|
|
||||||
extent reasonably practicable;
|
|
||||||
|
|
||||||
b. indicate if You modified the Licensed Material and
|
|
||||||
retain an indication of any previous modifications; and
|
|
||||||
|
|
||||||
c. indicate the Licensed Material is licensed under this
|
|
||||||
Public License, and include the text of, or the URI or
|
|
||||||
hyperlink to, this Public License.
|
|
||||||
|
|
||||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
|
||||||
reasonable manner based on the medium, means, and context in
|
|
||||||
which You Share the Licensed Material. For example, it may be
|
|
||||||
reasonable to satisfy the conditions by providing a URI or
|
|
||||||
hyperlink to a resource that includes the required
|
|
||||||
information.
|
|
||||||
|
|
||||||
3. If requested by the Licensor, You must remove any of the
|
|
||||||
information required by Section 3(a)(1)(A) to the extent
|
|
||||||
reasonably practicable.
|
|
||||||
|
|
||||||
4. If You Share Adapted Material You produce, the Adapter's
|
|
||||||
License You apply must not prevent recipients of the Adapted
|
|
||||||
Material from complying with this Public License.
|
|
||||||
|
|
||||||
|
|
||||||
Section 4 -- Sui Generis Database Rights.
|
|
||||||
|
|
||||||
Where the Licensed Rights include Sui Generis Database Rights that
|
|
||||||
apply to Your use of the Licensed Material:
|
|
||||||
|
|
||||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
|
||||||
to extract, reuse, reproduce, and Share all or a substantial
|
|
||||||
portion of the contents of the database for NonCommercial purposes
|
|
||||||
only;
|
|
||||||
|
|
||||||
b. if You include all or a substantial portion of the database
|
|
||||||
contents in a database in which You have Sui Generis Database
|
|
||||||
Rights, then the database in which You have Sui Generis Database
|
|
||||||
Rights (but not its individual contents) is Adapted Material; and
|
|
||||||
|
|
||||||
c. You must comply with the conditions in Section 3(a) if You Share
|
|
||||||
all or a substantial portion of the contents of the database.
|
|
||||||
|
|
||||||
For the avoidance of doubt, this Section 4 supplements and does not
|
|
||||||
replace Your obligations under this Public License where the Licensed
|
|
||||||
Rights include other Copyright and Similar Rights.
|
|
||||||
|
|
||||||
|
|
||||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
|
||||||
|
|
||||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
|
||||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
|
||||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
|
||||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
|
||||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
|
||||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
|
||||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
|
||||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
|
||||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
|
||||||
|
|
||||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
|
||||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
|
||||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
|
||||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
|
||||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
|
||||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
|
||||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
|
||||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
|
||||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
|
||||||
|
|
||||||
c. The disclaimer of warranties and limitation of liability provided
|
|
||||||
above shall be interpreted in a manner that, to the extent
|
|
||||||
possible, most closely approximates an absolute disclaimer and
|
|
||||||
waiver of all liability.
|
|
||||||
|
|
||||||
|
|
||||||
Section 6 -- Term and Termination.
|
|
||||||
|
|
||||||
a. This Public License applies for the term of the Copyright and
|
|
||||||
Similar Rights licensed here. However, if You fail to comply with
|
|
||||||
this Public License, then Your rights under this Public License
|
|
||||||
terminate automatically.
|
|
||||||
|
|
||||||
b. Where Your right to use the Licensed Material has terminated under
|
|
||||||
Section 6(a), it reinstates:
|
|
||||||
|
|
||||||
1. automatically as of the date the violation is cured, provided
|
|
||||||
it is cured within 30 days of Your discovery of the
|
|
||||||
violation; or
|
|
||||||
|
|
||||||
2. upon express reinstatement by the Licensor.
|
|
||||||
|
|
||||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
|
||||||
right the Licensor may have to seek remedies for Your violations
|
|
||||||
of this Public License.
|
|
||||||
|
|
||||||
c. For the avoidance of doubt, the Licensor may also offer the
|
|
||||||
Licensed Material under separate terms or conditions or stop
|
|
||||||
distributing the Licensed Material at any time; however, doing so
|
|
||||||
will not terminate this Public License.
|
|
||||||
|
|
||||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
|
||||||
License.
|
|
||||||
|
|
||||||
|
|
||||||
Section 7 -- Other Terms and Conditions.
|
|
||||||
|
|
||||||
a. The Licensor shall not be bound by any additional or different
|
|
||||||
terms or conditions communicated by You unless expressly agreed.
|
|
||||||
|
|
||||||
b. Any arrangements, understandings, or agreements regarding the
|
|
||||||
Licensed Material not stated herein are separate from and
|
|
||||||
independent of the terms and conditions of this Public License.
|
|
||||||
|
|
||||||
|
|
||||||
Section 8 -- Interpretation.
|
|
||||||
|
|
||||||
a. For the avoidance of doubt, this Public License does not, and
|
|
||||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
|
||||||
conditions on any use of the Licensed Material that could lawfully
|
|
||||||
be made without permission under this Public License.
|
|
||||||
|
|
||||||
b. To the extent possible, if any provision of this Public License is
|
|
||||||
deemed unenforceable, it shall be automatically reformed to the
|
|
||||||
minimum extent necessary to make it enforceable. If the provision
|
|
||||||
cannot be reformed, it shall be severed from this Public License
|
|
||||||
without affecting the enforceability of the remaining terms and
|
|
||||||
conditions.
|
|
||||||
|
|
||||||
c. No term or condition of this Public License will be waived and no
|
|
||||||
failure to comply consented to unless expressly agreed to by the
|
|
||||||
Licensor.
|
|
||||||
|
|
||||||
d. Nothing in this Public License constitutes or may be interpreted
|
|
||||||
as a limitation upon, or waiver of, any privileges and immunities
|
|
||||||
that apply to the Licensor or You, including from the legal
|
|
||||||
processes of any jurisdiction or authority.
|
|
||||||
|
|
||||||
=======================================================================
|
|
||||||
|
|
||||||
Creative Commons is not a party to its public
|
|
||||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
|
||||||
its public licenses to material it publishes and in those instances
|
|
||||||
will be considered the “Licensor.” The text of the Creative Commons
|
|
||||||
public licenses is dedicated to the public domain under the CC0 Public
|
|
||||||
Domain Dedication. Except for the limited purpose of indicating that
|
|
||||||
material is shared under a Creative Commons public license or as
|
|
||||||
otherwise permitted by the Creative Commons policies published at
|
|
||||||
creativecommons.org/policies, Creative Commons does not authorize the
|
|
||||||
use of the trademark "Creative Commons" or any other trademark or logo
|
|
||||||
of Creative Commons without its prior written consent including,
|
|
||||||
without limitation, in connection with any unauthorized modifications
|
|
||||||
to any of its public licenses or any other arrangements,
|
|
||||||
understandings, or agreements concerning use of licensed material. For
|
|
||||||
the avoidance of doubt, this paragraph does not form part of the
|
|
||||||
public licenses.
|
|
||||||
|
|
||||||
Creative Commons may be contacted at creativecommons.org.
|
|
||||||
|
|
||||||
@@ -144,10 +144,6 @@ See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the repo layout.
|
|||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
StepForge is licensed under the **Creative Commons Attribution-NonCommercial
|
Creative Commons Attribution-NonCommercial
|
||||||
4.0 International License (CC BY-NC 4.0)**. See the root [LICENSE](LICENSE) for
|
|
||||||
the full terms.
|
|
||||||
|
|
||||||
In plain terms: you're free to use, modify, and share it for **non-commercial**
|
Basically, do whatever you want with it just don't make money off it or sell it.
|
||||||
purposes, with attribution — but you may not sell it or use it commercially
|
|
||||||
without written permission from the copyright holder.
|
|
||||||
|
|||||||
+106
-1
@@ -22,6 +22,7 @@ const { readLock } = require('../core/locks');
|
|||||||
const CaptureService = require('./capture');
|
const CaptureService = require('./capture');
|
||||||
const { TextIntelService } = require('./text-intel');
|
const { TextIntelService } = require('./text-intel');
|
||||||
const { keepProcessesResponsive } = require('./win-power');
|
const { keepProcessesResponsive } = require('./win-power');
|
||||||
|
const { zoomShortcutFromInputEvent } = require('./shortcut-utils');
|
||||||
const security = require('./security');
|
const security = require('./security');
|
||||||
const PACKAGE_JSON = require(path.join(__dirname, '..', 'package.json'));
|
const PACKAGE_JSON = require(path.join(__dirname, '..', 'package.json'));
|
||||||
|
|
||||||
@@ -65,6 +66,10 @@ let templates;
|
|||||||
let capture;
|
let capture;
|
||||||
let textIntel;
|
let textIntel;
|
||||||
let mainWindow;
|
let mainWindow;
|
||||||
|
let lastZoomShortcut = null;
|
||||||
|
let canvasZoomActive = false;
|
||||||
|
const UI_ZOOM_LEVEL_MIN = -8;
|
||||||
|
const UI_ZOOM_LEVEL_MAX = 8;
|
||||||
|
|
||||||
function reindex(guideId) {
|
function reindex(guideId) {
|
||||||
try {
|
try {
|
||||||
@@ -87,6 +92,43 @@ function applyTheme() {
|
|||||||
nativeTheme.themeSource = settings.get('appearance') || 'system';
|
nativeTheme.themeSource = settings.get('appearance') || 'system';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function dispatchZoomShortcut(kind) {
|
||||||
|
sendToRenderer('editor:zoom-shortcut', kind);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ctrl+=/Ctrl+-/Ctrl+0 zoom the step editor's canvas while a guide is open
|
||||||
|
// there (dispatchZoomShortcut above); everywhere else — library, welcome,
|
||||||
|
// dialogs — the same keys scale the whole window's UI like a browser.
|
||||||
|
function applyUiZoom(kind) {
|
||||||
|
if (!mainWindow || mainWindow.isDestroyed()) return;
|
||||||
|
const wc = mainWindow.webContents;
|
||||||
|
if (kind === 'fit') {
|
||||||
|
wc.zoomLevel = 0;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const delta = kind === 'in' ? 1 : kind === 'out' ? -1 : 0;
|
||||||
|
if (!delta) return;
|
||||||
|
wc.zoomLevel = Math.max(UI_ZOOM_LEVEL_MIN, Math.min(UI_ZOOM_LEVEL_MAX, wc.zoomLevel + delta));
|
||||||
|
}
|
||||||
|
|
||||||
|
// A single physical keypress reaches here twice — once via the global
|
||||||
|
// accelerator registration, once via before-input-event — plus multiple
|
||||||
|
// accelerator spellings can match the same key on some layouts. Collapse
|
||||||
|
// same-kind repeats within 50ms so one keypress is one zoom step.
|
||||||
|
function handleZoomShortcut(kind) {
|
||||||
|
if (!kind) return;
|
||||||
|
const now = Date.now();
|
||||||
|
if (lastZoomShortcut && lastZoomShortcut.kind === kind && (now - lastZoomShortcut.at) < 50) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
lastZoomShortcut = { kind, at: now };
|
||||||
|
if (canvasZoomActive) {
|
||||||
|
dispatchZoomShortcut(kind);
|
||||||
|
} else {
|
||||||
|
applyUiZoom(kind);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function createWindow() {
|
function createWindow() {
|
||||||
mainWindow = new BrowserWindow({
|
mainWindow = new BrowserWindow({
|
||||||
width: 1280,
|
width: 1280,
|
||||||
@@ -113,6 +155,16 @@ function createWindow() {
|
|||||||
// away from it and every popup is denied, so no other document can run
|
// away from it and every popup is denied, so no other document can run
|
||||||
// with this window's preload bridge.
|
// with this window's preload bridge.
|
||||||
security.installWindowSecurity(mainWindow, 'main');
|
security.installWindowSecurity(mainWindow, 'main');
|
||||||
|
mainWindow.webContents.on('before-input-event', (event, input) => {
|
||||||
|
// Electron reports both the key-down and key-up as separate
|
||||||
|
// before-input-event calls; only act on the down edge or every tap
|
||||||
|
// fires the shortcut twice regardless of the dedupe window below.
|
||||||
|
if (input.type !== 'keyDown') return;
|
||||||
|
const kind = zoomShortcutFromInputEvent(input);
|
||||||
|
if (!kind) return;
|
||||||
|
event.preventDefault();
|
||||||
|
handleZoomShortcut(kind);
|
||||||
|
});
|
||||||
mainWindow.loadFile(path.join(__dirname, 'renderer', 'index.html'));
|
mainWindow.loadFile(path.join(__dirname, 'renderer', 'index.html'));
|
||||||
mainWindow.once('ready-to-show', () => {
|
mainWindow.once('ready-to-show', () => {
|
||||||
mainWindow.show();
|
mainWindow.show();
|
||||||
@@ -248,6 +300,19 @@ function createWindow() {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const waitClickBackendReady = async () => {
|
||||||
|
for (let i = 0; i < 240; i++) {
|
||||||
|
const streamReady = Boolean(
|
||||||
|
capture.streamBackend
|
||||||
|
&& typeof capture.streamBackend.isActive === 'function'
|
||||||
|
&& capture.streamBackend.isActive(),
|
||||||
|
);
|
||||||
|
if (streamReady || capture.frameLoopRunning) return true;
|
||||||
|
await new Promise((res) => setTimeout(res, 50));
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
|
||||||
// Third scenario: the real "Start recording" path. armRecording
|
// Third scenario: the real "Start recording" path. armRecording
|
||||||
// warms the recorder while the window is visible and only arms the
|
// warms the recorder while the window is visible and only arms the
|
||||||
// session once it hides; the first click *after* arming must get a
|
// session once it hides; the first click *after* arming must get a
|
||||||
@@ -268,6 +333,12 @@ function createWindow() {
|
|||||||
const warmupClicks = store.getGuide(armGuide.guideId).stepsOrder.length;
|
const warmupClicks = store.getGuide(armGuide.guideId).stepsOrder.length;
|
||||||
capture.onOsClick(Date.now(), toPhysical({ x: bounds.x + 100, y: bounds.y + 100 }), 'button-1');
|
capture.onOsClick(Date.now(), toPhysical({ x: bounds.x + 100, y: bounds.y + 100 }), 'button-1');
|
||||||
await waitArmed();
|
await waitArmed();
|
||||||
|
if (!await waitClickBackendReady()) {
|
||||||
|
throw new Error('arm selftest backend never became ready');
|
||||||
|
}
|
||||||
|
await new Promise((res) => setTimeout(res, 1500));
|
||||||
|
if (mainWindow.isVisible()) mainWindow.hide();
|
||||||
|
await new Promise((res) => setTimeout(res, 200));
|
||||||
const armPoint = {
|
const armPoint = {
|
||||||
x: Math.round(bounds.x + bounds.width * 0.4),
|
x: Math.round(bounds.x + bounds.width * 0.4),
|
||||||
y: Math.round(bounds.y + bounds.height * 0.4),
|
y: Math.round(bounds.y + bounds.height * 0.4),
|
||||||
@@ -295,6 +366,12 @@ function createWindow() {
|
|||||||
capture.togglePause(false);
|
capture.togglePause(false);
|
||||||
await capture.startClickFrameBackend();
|
await capture.startClickFrameBackend();
|
||||||
await waitArmed();
|
await waitArmed();
|
||||||
|
if (!await waitClickBackendReady()) {
|
||||||
|
throw new Error('debounce selftest backend never became ready');
|
||||||
|
}
|
||||||
|
await new Promise((res) => setTimeout(res, 1500));
|
||||||
|
if (mainWindow.isVisible()) mainWindow.hide();
|
||||||
|
await new Promise((res) => setTimeout(res, 200));
|
||||||
await new Promise((res) => setTimeout(res, 300));
|
await new Promise((res) => setTimeout(res, 300));
|
||||||
const dbPoint = {
|
const dbPoint = {
|
||||||
x: Math.round(bounds.x + bounds.width * 0.55),
|
x: Math.round(bounds.x + bounds.width * 0.55),
|
||||||
@@ -365,6 +442,27 @@ function createWindow() {
|
|||||||
|
|
||||||
function registerHotkeys() {
|
function registerHotkeys() {
|
||||||
globalShortcut.unregisterAll();
|
globalShortcut.unregisterAll();
|
||||||
|
const zoomBindings = [
|
||||||
|
['CommandOrControl+Plus', 'in'],
|
||||||
|
['CommandOrControl+Shift+=', 'in'],
|
||||||
|
['CommandOrControl+=', 'in'],
|
||||||
|
['CommandOrControl+numadd', 'in'],
|
||||||
|
['CommandOrControl+-', 'out'],
|
||||||
|
['CommandOrControl+Minus', 'out'],
|
||||||
|
['CommandOrControl+numsub', 'out'],
|
||||||
|
['CommandOrControl+0', 'fit'],
|
||||||
|
['CommandOrControl+num0', 'fit'],
|
||||||
|
];
|
||||||
|
for (const [accel, kind] of zoomBindings) {
|
||||||
|
try {
|
||||||
|
if (globalShortcut.register(accel, () => handleZoomShortcut(kind))) {
|
||||||
|
// Keep registering the other spellings so keyboards with different
|
||||||
|
// plus/minus translations still land on the same action.
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// Invalid accelerators must not break startup.
|
||||||
|
}
|
||||||
|
}
|
||||||
const accel = settings.get('capture.hotkeyCapture');
|
const accel = settings.get('capture.hotkeyCapture');
|
||||||
const pauseAccel = settings.get('capture.hotkeyPauseResume');
|
const pauseAccel = settings.get('capture.hotkeyPauseResume');
|
||||||
try {
|
try {
|
||||||
@@ -399,6 +497,14 @@ function setupIpc() {
|
|||||||
getMainWebContents: () => (mainWindow && !mainWindow.isDestroyed() ? mainWindow.webContents : null),
|
getMainWebContents: () => (mainWindow && !mainWindow.isDestroyed() ? mainWindow.webContents : null),
|
||||||
});
|
});
|
||||||
const c = security.check;
|
const c = security.check;
|
||||||
|
|
||||||
|
// The renderer reports whether the step editor (with a guide open) is the
|
||||||
|
// visible screen, so Ctrl+=/Ctrl+-/Ctrl+0 can pick canvas zoom vs UI zoom.
|
||||||
|
ipcMain.on('editor:canvas-zoom-active', (event, active) => {
|
||||||
|
if (!trustedSender(event)) return;
|
||||||
|
canvasZoomActive = Boolean(active);
|
||||||
|
});
|
||||||
|
|
||||||
const IMAGE_BUDGET = 256 * 1024 * 1024; // channels that carry base64 PNGs
|
const IMAGE_BUDGET = 256 * 1024 * 1024; // channels that carry base64 PNGs
|
||||||
const h = (channel, fn, opts = {}) => {
|
const h = (channel, fn, opts = {}) => {
|
||||||
const { maxChars = 2 * 1024 * 1024, validate = null } = opts;
|
const { maxChars = 2 * 1024 * 1024, validate = null } = opts;
|
||||||
@@ -898,7 +1004,6 @@ function setupIpc() {
|
|||||||
buildVersion: PACKAGE_JSON.buildVersion || app.getVersion(),
|
buildVersion: PACKAGE_JSON.buildVersion || app.getVersion(),
|
||||||
dataDir: store.root,
|
dataDir: store.root,
|
||||||
platform: process.platform,
|
platform: process.platform,
|
||||||
license: PACKAGE_JSON.license || 'CC-BY-NC-4.0',
|
|
||||||
}));
|
}));
|
||||||
// Platform capture-capability profile (session type, portal/PipeWire,
|
// Platform capture-capability profile (session type, portal/PipeWire,
|
||||||
// xinput, click source, actionable messages) for the diagnostics UI, plus
|
// xinput, click source, actionable messages) for the diagnostics UI, plus
|
||||||
|
|||||||
@@ -67,6 +67,10 @@ const api = {
|
|||||||
onState: (fn) => ipcRenderer.on('capture:state', (e, payload) => fn(payload)),
|
onState: (fn) => ipcRenderer.on('capture:state', (e, payload) => fn(payload)),
|
||||||
onStepUpdated: (fn) => ipcRenderer.on('step:updated', (e, payload) => fn(payload)),
|
onStepUpdated: (fn) => ipcRenderer.on('step:updated', (e, payload) => fn(payload)),
|
||||||
},
|
},
|
||||||
|
editor: {
|
||||||
|
onZoomShortcut: (fn) => ipcRenderer.on('editor:zoom-shortcut', (e, payload) => fn(payload)),
|
||||||
|
setCanvasZoomActive: (active) => ipcRenderer.send('editor:canvas-zoom-active', Boolean(active)),
|
||||||
|
},
|
||||||
archive: {
|
archive: {
|
||||||
export: invoke('archive:export'),
|
export: invoke('archive:export'),
|
||||||
open: invoke('archive:open'),
|
open: invoke('archive:open'),
|
||||||
|
|||||||
+16
-1
@@ -169,7 +169,14 @@ function makeHotkeyInput(value = '') {
|
|||||||
return wrap;
|
return wrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function promptText({ title, label = 'Value', value = '', placeholder = '', multiline = false } = {}) {
|
async function promptText({
|
||||||
|
title,
|
||||||
|
label = 'Value',
|
||||||
|
value = '',
|
||||||
|
placeholder = '',
|
||||||
|
multiline = false,
|
||||||
|
onInput = null,
|
||||||
|
} = {}) {
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
const field = multiline
|
const field = multiline
|
||||||
? el('textarea', { rows: 6, placeholder }, value)
|
? el('textarea', { rows: 6, placeholder }, value)
|
||||||
@@ -186,12 +193,20 @@ async function promptText({ title, label = 'Value', value = '', placeholder = ''
|
|||||||
});
|
});
|
||||||
|
|
||||||
field.addEventListener('keydown', (e) => {
|
field.addEventListener('keydown', (e) => {
|
||||||
|
if (multiline && e.key === 'Enter') {
|
||||||
|
// Let the textarea keep the Enter key for a new line.
|
||||||
|
e.stopPropagation();
|
||||||
|
return;
|
||||||
|
}
|
||||||
if (!multiline && e.key === 'Enter') {
|
if (!multiline && e.key === 'Enter') {
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
close();
|
close();
|
||||||
resolve(field.value);
|
resolve(field.value);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
field.addEventListener('input', () => {
|
||||||
|
if (typeof onInput === 'function') onInput(field.value);
|
||||||
|
});
|
||||||
|
|
||||||
setTimeout(() => field.focus(), 0);
|
setTimeout(() => field.focus(), 0);
|
||||||
});
|
});
|
||||||
|
|||||||
+87
-24
@@ -4,6 +4,7 @@
|
|||||||
|
|
||||||
const api = window.stepforge;
|
const api = window.stepforge;
|
||||||
const dialogs = window.StepForgeDialogs || {};
|
const dialogs = window.StepForgeDialogs || {};
|
||||||
|
const shortcuts = window.StepForgeShortcuts || {};
|
||||||
|
|
||||||
const clone = (value) => JSON.parse(JSON.stringify(value));
|
const clone = (value) => JSON.parse(JSON.stringify(value));
|
||||||
const BLOCK_KIND_ORDER = { text: 0, code: 1, table: 2 };
|
const BLOCK_KIND_ORDER = { text: 0, code: 1, table: 2 };
|
||||||
@@ -105,6 +106,24 @@ function isEditableTarget(target) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function zoomShortcutFromEvent(e) {
|
||||||
|
if (shortcuts.zoomShortcutFromKeyboardEvent) {
|
||||||
|
return shortcuts.zoomShortcutFromKeyboardEvent(e);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!(e.ctrlKey || e.metaKey)) return null;
|
||||||
|
|
||||||
|
const { key, code, shiftKey } = e;
|
||||||
|
if (key === '0' || code === 'Digit0' || code === 'Numpad0') return 'fit';
|
||||||
|
if (
|
||||||
|
key === '+' || key === '=' || key === 'Add' || key === 'Plus' ||
|
||||||
|
code === 'Equal' || code === 'NumpadAdd' ||
|
||||||
|
(key === '=' && shiftKey) || (code === 'Equal' && shiftKey)
|
||||||
|
) return 'in';
|
||||||
|
if (key === '-' || key === '_' || key === 'Subtract' || key === 'Minus' || code === 'Minus' || code === 'NumpadSubtract') return 'out';
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
class GuideEditor {
|
class GuideEditor {
|
||||||
constructor({ root, onMetaChange = () => {}, onToast = toast, onBack = () => {} } = {}) {
|
constructor({ root, onMetaChange = () => {}, onToast = toast, onBack = () => {} } = {}) {
|
||||||
this.root = root;
|
this.root = root;
|
||||||
@@ -141,6 +160,13 @@ class GuideEditor {
|
|||||||
this.saveStepDebounced = debounce(() => this.flushStep(), 180);
|
this.saveStepDebounced = debounce(() => this.flushStep(), 180);
|
||||||
this.saveGuideDebounced = debounce(() => this.flushGuide(), 180);
|
this.saveGuideDebounced = debounce(() => this.flushGuide(), 180);
|
||||||
|
|
||||||
|
if (api.editor && typeof api.editor.onZoomShortcut === 'function') {
|
||||||
|
api.editor.onZoomShortcut((kind) => {
|
||||||
|
if (!this.active || !this.guide) return;
|
||||||
|
this.applyZoomShortcut(kind);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
this.onDocumentKeyDown = this.onDocumentKeyDown.bind(this);
|
this.onDocumentKeyDown = this.onDocumentKeyDown.bind(this);
|
||||||
document.addEventListener('keydown', this.onDocumentKeyDown, true);
|
document.addEventListener('keydown', this.onDocumentKeyDown, true);
|
||||||
}
|
}
|
||||||
@@ -152,6 +178,9 @@ class GuideEditor {
|
|||||||
|
|
||||||
setActive(active) {
|
setActive(active) {
|
||||||
this.active = Boolean(active);
|
this.active = Boolean(active);
|
||||||
|
if (api.editor && typeof api.editor.setCanvasZoomActive === 'function') {
|
||||||
|
api.editor.setCanvasZoomActive(this.active);
|
||||||
|
}
|
||||||
if (!this.active && this.guideId) {
|
if (!this.active && this.guideId) {
|
||||||
// Leaving the editor: flush pending debounced saves so navigation can
|
// Leaving the editor: flush pending debounced saves so navigation can
|
||||||
// never drop the last edit (failures keep the dirty state and retry),
|
// never drop the last edit (failures keep the dirty state and retry),
|
||||||
@@ -1182,7 +1211,6 @@ class GuideEditor {
|
|||||||
const typeSelect = makeSelect(selected.type, [
|
const typeSelect = makeSelect(selected.type, [
|
||||||
'rect', 'oval', 'line', 'arrow', 'text', 'tooltip', 'number', 'blur', 'highlight', 'magnify', 'cursor',
|
'rect', 'oval', 'line', 'arrow', 'text', 'tooltip', 'number', 'blur', 'highlight', 'magnify', 'cursor',
|
||||||
].map((type) => ({ value: type, label: ANNOTATION_TYPE_LABELS[type] || type })));
|
].map((type) => ({ value: type, label: ANNOTATION_TYPE_LABELS[type] || type })));
|
||||||
const textInput = el('input', { type: 'text', value: selected.text || '', placeholder: 'Annotation text' });
|
|
||||||
const valueInput = el('input', { type: 'number', value: Number.isFinite(selected.value) ? selected.value : '', placeholder: 'Value' });
|
const valueInput = el('input', { type: 'number', value: Number.isFinite(selected.value) ? selected.value : '', placeholder: 'Value' });
|
||||||
const strokeInput = el('input', { type: 'color', value: style.stroke || '#E5484D' });
|
const strokeInput = el('input', { type: 'color', value: style.stroke || '#E5484D' });
|
||||||
const fillInput = el('input', { type: 'color', value: style.fill && style.fill !== 'transparent' ? style.fill : '#ffffff' });
|
const fillInput = el('input', { type: 'color', value: style.fill && style.fill !== 'transparent' ? style.fill : '#ffffff' });
|
||||||
@@ -1218,9 +1246,17 @@ class GuideEditor {
|
|||||||
const fields = new Set(ANNOTATION_FIELDS[selected.type] || []);
|
const fields = new Set(ANNOTATION_FIELDS[selected.type] || []);
|
||||||
const strokeLabel = (selected.type === 'text' || selected.type === 'number') ? 'Color' : 'Stroke';
|
const strokeLabel = (selected.type === 'text' || selected.type === 'number') ? 'Color' : 'Stroke';
|
||||||
const typeLabel = ANNOTATION_TYPE_LABELS[selected.type] || selected.type;
|
const typeLabel = ANNOTATION_TYPE_LABELS[selected.type] || selected.type;
|
||||||
|
const textInput = fields.has('text')
|
||||||
|
? el('textarea', {
|
||||||
|
rows: Math.max(3, Math.min(8, String(selected.text || '').split('\n').length)),
|
||||||
|
placeholder: 'Annotation text',
|
||||||
|
spellcheck: true,
|
||||||
|
})
|
||||||
|
: el('input', { type: 'text', value: selected.text || '', placeholder: 'Annotation text' });
|
||||||
|
if (fields.has('text')) textInput.value = selected.text || '';
|
||||||
|
|
||||||
const rows = [labeledRow('Type', typeSelect)];
|
const rows = [labeledRow('Type', typeSelect)];
|
||||||
if (fields.has('text')) rows.push(labeledRow('Text', textInput));
|
if (fields.has('text')) rows.push(labeledRow('Text', textInput, { stacked: true }));
|
||||||
if (fields.has('value')) rows.push(labeledRow('Value', valueInput));
|
if (fields.has('value')) rows.push(labeledRow('Value', valueInput));
|
||||||
if (fields.has('stroke')) rows.push(labeledRow(strokeLabel, strokeInput));
|
if (fields.has('stroke')) rows.push(labeledRow(strokeLabel, strokeInput));
|
||||||
if (fields.has('fill')) rows.push(labeledRow('Fill', fillInput));
|
if (fields.has('fill')) rows.push(labeledRow('Fill', fillInput));
|
||||||
@@ -1348,6 +1384,22 @@ class GuideEditor {
|
|||||||
if (mode === 1.5) this.dom.zoom150Btn.classList.add('active');
|
if (mode === 1.5) this.dom.zoom150Btn.classList.add('active');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
applyZoomShortcut(kind) {
|
||||||
|
if (kind === 'in') {
|
||||||
|
this.setZoom(Math.min(3, (Number(this.currentZoom) || 1) + 0.25));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if (kind === 'out') {
|
||||||
|
this.setZoom(Math.max(0.25, (Number(this.currentZoom) || 1) - 0.25));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if (kind === 'fit') {
|
||||||
|
this.setZoom('fit');
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
pushCanvasHistory(recordOrLabel = 'change') {
|
pushCanvasHistory(recordOrLabel = 'change') {
|
||||||
if (!this.currentStep) return;
|
if (!this.currentStep) return;
|
||||||
const record = recordOrLabel && typeof recordOrLabel === 'object'
|
const record = recordOrLabel && typeof recordOrLabel === 'object'
|
||||||
@@ -2168,19 +2220,39 @@ class GuideEditor {
|
|||||||
async editAnnotationText(ann) {
|
async editAnnotationText(ann) {
|
||||||
const step = this.currentStep;
|
const step = this.currentStep;
|
||||||
if (!step || !ann) return;
|
if (!step || !ann) return;
|
||||||
|
const originalText = ann.text ?? '';
|
||||||
|
const applyText = (nextText, { persist = true } = {}) => {
|
||||||
|
const selected = this.canvas.selected();
|
||||||
|
if (!selected) return;
|
||||||
|
selected.text = nextText;
|
||||||
|
step.annotations = clone(this.canvas.annotations || []);
|
||||||
|
this.pendingSave = true;
|
||||||
|
this.canvas.setAnnotations(step.annotations || []);
|
||||||
|
this.renderAnnotationPanel();
|
||||||
|
this.emitMeta();
|
||||||
|
if (persist) this.saveStepDebounced();
|
||||||
|
};
|
||||||
const value = await dialogs.promptText({
|
const value = await dialogs.promptText({
|
||||||
title: ann.type === 'tooltip' ? 'Edit tooltip' : 'Edit text',
|
title: ann.type === 'tooltip' ? 'Edit tooltip' : 'Edit text',
|
||||||
label: 'Text',
|
label: 'Text',
|
||||||
value: ann.text || '',
|
value: originalText,
|
||||||
multiline: true,
|
multiline: true,
|
||||||
|
onInput: applyText,
|
||||||
});
|
});
|
||||||
if (value == null) return;
|
this.saveStepDebounced.cancel();
|
||||||
ann.text = value;
|
if (value == null) {
|
||||||
step.annotations = clone(step.annotations || []);
|
const current = this.canvas.selected();
|
||||||
this.pendingSave = true;
|
if ((current?.text ?? '') !== originalText) {
|
||||||
|
applyText(originalText, { persist: false });
|
||||||
|
}
|
||||||
|
await this.flushStep(step);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const current = this.canvas.selected();
|
||||||
|
if ((current?.text ?? '') !== value) {
|
||||||
|
applyText(value, { persist: false });
|
||||||
|
}
|
||||||
await this.flushStep(step);
|
await this.flushStep(step);
|
||||||
this.renderAnnotationPanel();
|
|
||||||
this.emitMeta();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
formatDescription(command, block = null) {
|
formatDescription(command, block = null) {
|
||||||
@@ -2227,6 +2299,12 @@ class GuideEditor {
|
|||||||
|
|
||||||
onDocumentKeyDown(e) {
|
onDocumentKeyDown(e) {
|
||||||
if (!this.active || !this.guide) return;
|
if (!this.active || !this.guide) return;
|
||||||
|
const zoomShortcut = zoomShortcutFromEvent(e);
|
||||||
|
if (zoomShortcut) {
|
||||||
|
e.preventDefault();
|
||||||
|
this.applyZoomShortcut(zoomShortcut);
|
||||||
|
return;
|
||||||
|
}
|
||||||
if ((e.ctrlKey || e.metaKey) && e.key === '/' && !e.shiftKey) {
|
if ((e.ctrlKey || e.metaKey) && e.key === '/' && !e.shiftKey) {
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
this.openQuickActions();
|
this.openQuickActions();
|
||||||
@@ -2270,21 +2348,6 @@ class GuideEditor {
|
|||||||
if (next) this.selectStep(next.stepId);
|
if (next) this.selectStep(next.stepId);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if ((e.ctrlKey || e.metaKey) && (e.key === '=' || e.key === '+')) {
|
|
||||||
e.preventDefault();
|
|
||||||
this.setZoom(Math.min(3, (Number(this.currentZoom) || 1) + 0.25));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if ((e.ctrlKey || e.metaKey) && e.key === '-') {
|
|
||||||
e.preventDefault();
|
|
||||||
this.setZoom(Math.max(0.25, (Number(this.currentZoom) || 1) - 0.25));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if ((e.ctrlKey || e.metaKey) && e.key === '0') {
|
|
||||||
e.preventDefault();
|
|
||||||
this.setZoom('fit');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// Copy / paste the selected annotation.
|
// Copy / paste the selected annotation.
|
||||||
if ((e.ctrlKey || e.metaKey) && e.key.toLowerCase() === 'c' && this.selectedAnnotationId) {
|
if ((e.ctrlKey || e.metaKey) && e.key.toLowerCase() === 'c' && this.selectedAnnotationId) {
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
|
|||||||
@@ -21,6 +21,7 @@
|
|||||||
<div id="modal-root"></div>
|
<div id="modal-root"></div>
|
||||||
<div id="toast-root"></div>
|
<div id="toast-root"></div>
|
||||||
<script src="util.js"></script>
|
<script src="util.js"></script>
|
||||||
|
<script src="../shortcut-utils.js"></script>
|
||||||
<script src="canvas.js"></script>
|
<script src="canvas.js"></script>
|
||||||
<script src="dialogs.js"></script>
|
<script src="dialogs.js"></script>
|
||||||
<script src="editor.js"></script>
|
<script src="editor.js"></script>
|
||||||
|
|||||||
@@ -0,0 +1,55 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
|
(function attachShortcutUtils(root, factory) {
|
||||||
|
const api = factory();
|
||||||
|
if (typeof module !== 'undefined' && module.exports) {
|
||||||
|
module.exports = api;
|
||||||
|
}
|
||||||
|
if (root) {
|
||||||
|
root.StepForgeShortcuts = api;
|
||||||
|
}
|
||||||
|
})(typeof globalThis !== 'undefined' ? globalThis : this, () => {
|
||||||
|
function hasZoomModifier(source) {
|
||||||
|
return Boolean(source && (source.ctrlKey || source.metaKey || source.control || source.meta));
|
||||||
|
}
|
||||||
|
|
||||||
|
function zoomShortcutFromSource(source) {
|
||||||
|
if (!hasZoomModifier(source)) return null;
|
||||||
|
|
||||||
|
const key = String(source.key || '');
|
||||||
|
const code = String(source.code || '');
|
||||||
|
const shiftKey = Boolean(source.shiftKey || source.shift);
|
||||||
|
|
||||||
|
if (key === '0' || code === 'Digit0' || code === 'Numpad0') return 'fit';
|
||||||
|
|
||||||
|
if (
|
||||||
|
key === '+' || key === '=' || key === 'Add' || key === 'Plus' ||
|
||||||
|
code === 'Equal' || code === 'NumpadAdd' ||
|
||||||
|
(key === '=' && shiftKey) || (code === 'Equal' && shiftKey)
|
||||||
|
) {
|
||||||
|
return 'in';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
key === '-' || key === '_' || key === 'Subtract' || key === 'Minus' ||
|
||||||
|
code === 'Minus' || code === 'NumpadSubtract'
|
||||||
|
) {
|
||||||
|
return 'out';
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function zoomShortcutFromKeyboardEvent(event) {
|
||||||
|
return zoomShortcutFromSource(event);
|
||||||
|
}
|
||||||
|
|
||||||
|
function zoomShortcutFromInputEvent(input) {
|
||||||
|
return zoomShortcutFromSource(input);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
zoomShortcutFromInputEvent,
|
||||||
|
zoomShortcutFromKeyboardEvent,
|
||||||
|
};
|
||||||
|
});
|
||||||
@@ -23,11 +23,8 @@ guide-capture workflow patterns. To keep it legally clean:
|
|||||||
- Keep file formats (`.sfgz`, `.sfglt`, guide/step JSON) documented and
|
- Keep file formats (`.sfgz`, `.sfglt`, guide/step JSON) documented and
|
||||||
versioned in `docs/` and `ARCHITECTURE.md`.
|
versioned in `docs/` and `ARCHITECTURE.md`.
|
||||||
|
|
||||||
StepForge is licensed under **Creative Commons Attribution-NonCommercial 4.0
|
Contributions are accepted under MPL-2.0 with a Developer Certificate of
|
||||||
International (CC BY-NC 4.0)** — see the root [LICENSE](../LICENSE). By
|
Origin sign-off (`git commit -s`).
|
||||||
contributing you agree that your contributions are licensed under that same
|
|
||||||
license, and you add a Developer Certificate of Origin sign-off to each commit
|
|
||||||
(`git commit -s`) to certify you have the right to submit them.
|
|
||||||
|
|
||||||
## Offline Rules
|
## Offline Rules
|
||||||
|
|
||||||
|
|||||||
+7
-12
@@ -1,14 +1,9 @@
|
|||||||
StepForge is licensed under the Creative Commons
|
Creative Commons Attribution-NonCommercial
|
||||||
Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0).
|
|
||||||
|
|
||||||
The authoritative, full license text lives in the repository root:
|
|
||||||
|
|
||||||
../LICENSE
|
|
||||||
|
|
||||||
Summary: you may use, copy, modify, and share this software for
|
|
||||||
NON-COMMERCIAL purposes, with attribution. Commercial use requires
|
|
||||||
separate written permission from the copyright holder (Tyler Westbrook).
|
|
||||||
|
|
||||||
Human-readable summary: https://creativecommons.org/licenses/by-nc/4.0/
|
|
||||||
SPDX-License-Identifier: CC-BY-NC-4.0
|
|
||||||
Copyright (c) 2026 Tyler Westbrook
|
Copyright (c) 2026 Tyler Westbrook
|
||||||
|
|
||||||
|
Permission is granted to use, copy, modify, and distribute this software for non-commercial purposes only.
|
||||||
|
|
||||||
|
You may not sell this software, sell modified versions of it, or use it as part of a commercial product or service without written permission from the copyright holder.
|
||||||
|
|
||||||
|
This software is provided "as is", without warranty of any kind.
|
||||||
+1
-1
@@ -5,7 +5,7 @@
|
|||||||
"description": "Local-first desktop tool for capturing, annotating, and exporting step-by-step guides, with an optional user-configured local AI integration.",
|
"description": "Local-first desktop tool for capturing, annotating, and exporting step-by-step guides, with an optional user-configured local AI integration.",
|
||||||
"main": "app/main.js",
|
"main": "app/main.js",
|
||||||
"author": "StepForge [email protected]",
|
"author": "StepForge [email protected]",
|
||||||
"license": "CC-BY-NC-4.0",
|
"license": "MPL-2.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=22.12.0"
|
"node": ">=22.12.0"
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ Version: @VERSION@
|
|||||||
Release: 1%{?dist}
|
Release: 1%{?dist}
|
||||||
Summary: Local-first step-by-step guide capture and export tool
|
Summary: Local-first step-by-step guide capture and export tool
|
||||||
|
|
||||||
License: CC-BY-NC-4.0
|
License: MPL-2.0
|
||||||
URL: https://github.com/Twest2/StepForge
|
URL: https://github.com/Twest2/StepForge
|
||||||
|
|
||||||
# Runtime shared libraries (Chromium/Electron) + capture integration.
|
# Runtime shared libraries (Chromium/Electron) + capture integration.
|
||||||
|
|||||||
@@ -1,56 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
const test = require('node:test');
|
|
||||||
const assert = require('node:assert/strict');
|
|
||||||
const fs = require('node:fs');
|
|
||||||
const path = require('node:path');
|
|
||||||
|
|
||||||
const ROOT = path.resolve(__dirname, '..', '..');
|
|
||||||
const read = (rel) => fs.readFileSync(path.join(ROOT, rel), 'utf8').replace(/\r\n/g, '\n');
|
|
||||||
const exists = (rel) => fs.existsSync(path.join(ROOT, rel));
|
|
||||||
|
|
||||||
// The license was a release blocker: package.json/spec said MPL-2.0 while the
|
|
||||||
// README/docs said CC-BY-NC. The owner chose CC BY-NC 4.0. These guards keep
|
|
||||||
// every surface consistent so it can never silently drift back to a
|
|
||||||
// contradiction.
|
|
||||||
|
|
||||||
test('a root LICENSE exists with the full CC BY-NC 4.0 text', () => {
|
|
||||||
assert.ok(exists('LICENSE'), 'root LICENSE must exist');
|
|
||||||
const license = read('LICENSE');
|
|
||||||
assert.match(license, /Creative Commons/);
|
|
||||||
assert.match(license, /Attribution-NonCommercial 4\.0 International/);
|
|
||||||
assert.match(license, /SPDX-License-Identifier:\s*CC-BY-NC-4\.0/);
|
|
||||||
// It must be the real legalcode, not a one-paragraph paraphrase.
|
|
||||||
assert.ok(license.length > 8000, 'LICENSE should contain the full legal text');
|
|
||||||
assert.match(license, /Section 1 -+ Definitions/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('package.json declares CC-BY-NC-4.0 and never MPL', () => {
|
|
||||||
const pkg = JSON.parse(read('package.json'));
|
|
||||||
assert.equal(pkg.license, 'CC-BY-NC-4.0');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('no shipping license surface still claims MPL-2.0', () => {
|
|
||||||
for (const rel of [
|
|
||||||
'package.json',
|
|
||||||
'README.md',
|
|
||||||
'docs/LICENSE',
|
|
||||||
'docs/CONTRIBUTING.md',
|
|
||||||
'packaging/linux/fedora/stepforge.spec',
|
|
||||||
]) {
|
|
||||||
assert.doesNotMatch(read(rel), /MPL-2\.0|Mozilla Public/i, `${rel} must not mention MPL`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test('the license story is consistent across the shipping surfaces', () => {
|
|
||||||
assert.match(read('README.md'), /CC BY-NC 4\.0/);
|
|
||||||
assert.match(read('docs/CONTRIBUTING.md'), /CC BY-NC 4\.0/);
|
|
||||||
assert.match(read('docs/LICENSE'), /CC-BY-NC-4\.0/);
|
|
||||||
assert.match(read('packaging/linux/fedora/stepforge.spec'), /^License:\s+CC-BY-NC-4\.0$/m);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('the About info surface reports the license from package.json', () => {
|
|
||||||
// main.js exposes license in app:info so the About view can never contradict.
|
|
||||||
const main = read('app/main.js');
|
|
||||||
assert.match(main, /license: PACKAGE_JSON\.license/);
|
|
||||||
});
|
|
||||||
@@ -48,9 +48,9 @@ test('Fedora/dnf packaging files exist in their own separate locations', () => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test('the RPM spec declares runtime Requires, license, and CC-BY-NC-4.0', () => {
|
test('the RPM spec declares runtime Requires, license, and MPL-2.0', () => {
|
||||||
const spec = read('packaging/linux/fedora/stepforge.spec');
|
const spec = read('packaging/linux/fedora/stepforge.spec');
|
||||||
assert.match(spec, /^License:\s+CC-BY-NC-4\.0$/m);
|
assert.match(spec, /^License:\s+MPL-2\.0$/m);
|
||||||
assert.match(spec, /^Requires:\s+nss$/m);
|
assert.match(spec, /^Requires:\s+nss$/m);
|
||||||
assert.match(spec, /%license/);
|
assert.match(spec, /%license/);
|
||||||
assert.match(spec, /chrome-sandbox/); // %post makes the sandbox helper setuid
|
assert.match(spec, /chrome-sandbox/); // %post makes the sandbox helper setuid
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
|
const test = require('node:test');
|
||||||
|
const assert = require('node:assert/strict');
|
||||||
|
|
||||||
|
const {
|
||||||
|
zoomShortcutFromInputEvent,
|
||||||
|
zoomShortcutFromKeyboardEvent,
|
||||||
|
} = require('../../app/shortcut-utils');
|
||||||
|
|
||||||
|
test('zoom shortcut helper recognizes zoom in, out, and fit across event shapes', () => {
|
||||||
|
assert.equal(zoomShortcutFromKeyboardEvent({ ctrlKey: true, key: '=', code: 'Equal' }), 'in');
|
||||||
|
assert.equal(zoomShortcutFromKeyboardEvent({ ctrlKey: true, key: '+', code: 'NumpadAdd' }), 'in');
|
||||||
|
assert.equal(zoomShortcutFromKeyboardEvent({ ctrlKey: true, key: 'Plus', code: 'Equal' }), 'in');
|
||||||
|
assert.equal(zoomShortcutFromKeyboardEvent({ ctrlKey: true, key: '-', code: 'Minus' }), 'out');
|
||||||
|
assert.equal(zoomShortcutFromKeyboardEvent({ metaKey: true, key: '0', code: 'Digit0' }), 'fit');
|
||||||
|
assert.equal(zoomShortcutFromKeyboardEvent({ ctrlKey: true, key: '=', code: 'Equal', shiftKey: true }), 'in');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('zoom shortcut helper recognizes Electron before-input-event payloads', () => {
|
||||||
|
assert.equal(zoomShortcutFromInputEvent({ control: true, key: '=', code: 'Equal' }), 'in');
|
||||||
|
assert.equal(zoomShortcutFromInputEvent({ control: true, key: '=', code: 'Equal', shift: true }), 'in');
|
||||||
|
assert.equal(zoomShortcutFromInputEvent({ control: true, key: 'Plus', code: 'Equal', shift: true }), 'in');
|
||||||
|
assert.equal(zoomShortcutFromInputEvent({ control: true, key: '-', code: 'Minus' }), 'out');
|
||||||
|
assert.equal(zoomShortcutFromInputEvent({ meta: true, key: '0', code: 'Digit0' }), 'fit');
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user