@kubohiroya/turbowarp-plus-editor-project-model 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.ja.md

@@ -0,0 +1,21 @@
+# TurboWarp Plus Editor Project Model
+
+[English](README.md)
+
+TurboWarp Plus Editor で、実行中の Scratch 作品を画面なしで読み取り、編集する。どの関数も VM と対象（スプライト・ステージ）を構造的な型で受け取るので、このパッケージは VM・GUI・React・Dockview を import しない。パネルと Editor の作品全体の検索が同じ関数を呼ぶため、作品の中身について両者の判断が食い違わない。
+
+## 入口
+
+| import | 内容 |
+| --- | --- |
+| `@kubohiroya/turbowarp-plus-editor-project-model/project-messages` | どのブロックが各メッセージを送り、受け取るか（`scanProjectMessages`・`scanTargetMessages`・`projectMessageGraph`・`messageReference`）と、メッセージの名前を変えられるか（`checkMessageRename`） |
+| `@kubohiroya/turbowarp-plus-editor-project-model/sprite-variable-edit` | 編集中のスプライトまたはステージの変数の作成・名前変更・削除（`editSpriteVariable`）。重複する名前を拒み、クラウド変数の接頭辞を保ち、ブロックが使っている変数は削除しない |
+| `@kubohiroya/turbowarp-plus-editor-project-model` | 上の両方 |
+
+## 検証
+
+`npm test` でビルドし、単体テストを実行する。
+
+## ライセンス
+
+MPL-2.0。`@kubohiroya/turbowarp-plus-editor-layout` から切り出したコードで、その履歴をこのリポジトリに残している。

package/README.md

@@ -1,3 +1,21 @@
-# Temporary Holding Version
+# TurboWarp Plus Editor Project Model
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[日本語](README.ja.md)
+
+Reads and edits a running Scratch project for TurboWarp Plus Editor, without any UI. Every function takes the VM and its targets through structural types, so this package never imports the VM, the GUI, React, or Dockview. Panels and the Editor's project search call the same functions, so they always agree on what a project contains.
+
+## Entry points
+
+| Import | Contents |
+| --- | --- |
+| `@kubohiroya/turbowarp-plus-editor-project-model/project-messages` | Which blocks send or receive each broadcast message (`scanProjectMessages`, `scanTargetMessages`, `projectMessageGraph`, `messageReference`), and whether a message can be renamed (`checkMessageRename`) |
+| `@kubohiroya/turbowarp-plus-editor-project-model/sprite-variable-edit` | Creating, renaming and deleting a variable of the editing sprite or the stage (`editSpriteVariable`). It refuses duplicate names, keeps the cloud prefix, and refuses to delete a variable that a block uses |
+| `@kubohiroya/turbowarp-plus-editor-project-model` | Both of the above |
+
+## Verification
+
+Run `npm test` to build the package and run the unit tests.
+
+## License
+
+MPL-2.0. This code was split out of `@kubohiroya/turbowarp-plus-editor-layout`, and its history is kept in this repository.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './project-messages.ts';
+export * from './sprite-variable-edit.ts';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./project-messages.js";
+export * from "./sprite-variable-edit.js";

package/dist/project-messages.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Broadcast message scanning for the message section and for the host's project search.
+ *
+ * This module is the only place that decides which block sends or receives a message, so the
+ * section and the host's search can never disagree. It takes the runtime through structural
+ * types and never imports the VM or the GUI.
+ */
+type Field = {
+    id?: string;
+    value?: unknown;
+};
+type Block = {
+    id: string;
+    opcode: string;
+    next?: string | null;
+    shadow?: boolean;
+    fields?: Record<string, Field>;
+    inputs?: Record<string, {
+        block?: string | null;
+        shadow?: string | null;
+    }>;
+};
+type Blocks = {
+    getScripts(): readonly string[];
+    getBlock(id: string): Block | undefined;
+};
+type MessageVariable = {
+    name: string;
+    type?: string;
+};
+export type MessageTarget = {
+    id: string;
+    isStage: boolean;
+    isOriginal: boolean;
+    getName(): string;
+    variables: Record<string, MessageVariable>;
+    blocks: Blocks;
+};
+export type MessageProject = {
+    targets: readonly MessageTarget[];
+};
+export declare const broadcastVariableType = "broadcast_msg";
+export declare const sendOpcodes: readonly ["event_broadcast", "event_broadcastandwait"];
+export declare const receiveOpcode = "event_whenbroadcastreceived";
+export type MessageDirection = 'send' | 'receive';
+export interface MessageReference {
+    direction: MessageDirection;
+    /** The broadcast_msg variable this block names, when it names one. */
+    id?: string;
+    /** The dropdown's own text, which is what the project file stores. */
+    fieldValue: string;
+    /** The owning variable's name when it resolves, otherwise the dropdown text. */
+    name: string;
+    /** `event_broadcastandwait` waits for every receiving script to finish. */
+    wait: boolean;
+}
+/**
+ * The judgement for a single block. Returns nothing for blocks that are not broadcast blocks and
+ * for a broadcast whose message is a reporter, because that message is only known while running.
+ */
+export declare function messageReference(target: MessageTarget, block: Block, stage?: MessageTarget): MessageReference | undefined;
+export interface MessageUse extends MessageReference {
+    key: string;
+    targetId: string;
+    targetName: string;
+    isStage: boolean;
+    blockId: string;
+    opcode: string;
+    /** The top block of the script holding this block, so the host can open the whole script. */
+    scriptId: string;
+    scriptOpcode: string;
+    /** When that script starts with a "when I receive" hat, the message it waits for. */
+    scriptMessageName?: string;
+}
+export type MessageStatus = 'both' | 'sendOnly' | 'receiveOnly' | 'unused';
+export interface ProjectMessage {
+    /** Stable identity for a message: its variable id, or its name when no variable owns it. */
+    key: string;
+    id?: string;
+    name: string;
+    status: MessageStatus;
+    sends: readonly MessageUse[];
+    receives: readonly MessageUse[];
+}
+/** Every message in the project, with the places that send and receive it. */
+export declare function scanProjectMessages(project: MessageProject): readonly ProjectMessage[];
+export type MessageRenameError = 'emptyName' | 'duplicateName' | 'unavailable';
+export type MessageRenameCheck = {
+    error: MessageRenameError;
+} | {
+    name: string;
+} | {
+    unchanged: true;
+};
+/**
+ * Whether a message may take this name. A message is owned by the stage, so its name has to be
+ * free across the whole project.
+ */
+export declare function checkMessageRename(messages: readonly ProjectMessage[], message: ProjectMessage, name: string): MessageRenameCheck;
+export interface MessageGraphNode {
+    id: string;
+    name: string;
+    isStage: boolean;
+}
+export interface MessageGraphEdge {
+    direction: MessageDirection;
+    targetId: string;
+    messageKey: string;
+    /** How many blocks in that target send or receive the message. */
+    count: number;
+}
+export interface MessageGraph {
+    targets: readonly MessageGraphNode[];
+    messages: readonly Pick<ProjectMessage, 'key' | 'id' | 'name' | 'status'>[];
+    edges: readonly MessageGraphEdge[];
+}
+/** The whole project as sprite or stage, message, sprite or stage. Isolated messages are kept. */
+export declare function projectMessageGraph(project: MessageProject, messages?: readonly ProjectMessage[]): MessageGraph;
+export interface TargetMessages {
+    targetId: string;
+    isStage: boolean;
+    /** Blocks in this target that send a message. */
+    sends: readonly MessageUse[];
+    /** Hats in this target that receive a message. */
+    receives: readonly MessageUse[];
+    /** Messages the project uses or declares that this target neither sends nor receives. */
+    elsewhere: readonly ProjectMessage[];
+    /** Every message in the project, so a rename can check the names already taken. */
+    messages: readonly ProjectMessage[];
+    /** The relationship diagram, which only the stage shows. */
+    graph?: MessageGraph;
+}
+/** What one sprite or the stage sends and receives. The stage also carries the project diagram. */
+export declare function scanTargetMessages(project: MessageProject, targetId: string): TargetMessages;
+export {};

package/dist/project-messages.js

@@ -0,0 +1,169 @@
+/**
+ * Broadcast message scanning for the message section and for the host's project search.
+ *
+ * This module is the only place that decides which block sends or receives a message, so the
+ * section and the host's search can never disagree. It takes the runtime through structural
+ * types and never imports the VM or the GUI.
+ */
+export const broadcastVariableType = 'broadcast_msg';
+export const sendOpcodes = ['event_broadcast', 'event_broadcastandwait'];
+export const receiveOpcode = 'event_whenbroadcastreceived';
+/**
+ * The judgement for a single block. Returns nothing for blocks that are not broadcast blocks and
+ * for a broadcast whose message is a reporter, because that message is only known while running.
+ */
+export function messageReference(target, block, stage) {
+    const direction = block.opcode === receiveOpcode ? 'receive' :
+        sendOpcodes.includes(block.opcode) ? 'send' : undefined;
+    if (!direction)
+        return undefined;
+    const input = block.inputs?.BROADCAST_INPUT;
+    const menu = input?.block ? target.blocks.getBlock(input.block) : undefined;
+    const field = block.fields?.BROADCAST_OPTION ?? menu?.fields?.BROADCAST_OPTION;
+    if (!field)
+        return undefined;
+    const fieldValue = String(field.value ?? '');
+    const owner = field.id ? target.variables[field.id] ?? stage?.variables[field.id] : undefined;
+    return {
+        direction,
+        id: field.id,
+        fieldValue,
+        name: owner?.type === broadcastVariableType && owner.name ? owner.name : fieldValue,
+        wait: block.opcode === 'event_broadcastandwait'
+    };
+}
+const messageKey = (id, name) => id ?? 'name:' + name;
+function* walkScripts(blocks) {
+    for (const rootId of blocks.getScripts()) {
+        const root = blocks.getBlock(rootId);
+        if (!root)
+            continue;
+        const pending = [rootId];
+        const seen = new Set();
+        while (pending.length) {
+            const id = pending.pop();
+            if (!id || seen.has(id))
+                continue;
+            seen.add(id);
+            const block = blocks.getBlock(id);
+            if (!block || block.shadow)
+                continue;
+            yield { root, block };
+            if (block.next)
+                pending.push(block.next);
+            for (const input of Object.values(block.inputs ?? {})) {
+                // A shadow holds a dropdown or a literal, which messageReference reads directly.
+                if (input.block && input.block !== input.shadow)
+                    pending.push(input.block);
+            }
+        }
+    }
+}
+const statusOf = (sends, receives) => sends.length && receives.length ? 'both' : sends.length ? 'sendOnly' : receives.length ? 'receiveOnly' : 'unused';
+/** Every message in the project, with the places that send and receive it. */
+export function scanProjectMessages(project) {
+    const stage = project.targets.find(target => target.isStage);
+    const found = new Map();
+    const ensure = (id, name) => {
+        const key = messageKey(id, name);
+        let entry = found.get(key);
+        if (!entry) {
+            entry = { key, id, name, sends: [], receives: [] };
+            found.set(key, entry);
+        }
+        // A message created but never used still carries its variable name.
+        if (name && entry.name !== name)
+            entry.name = name;
+        return entry;
+    };
+    for (const target of project.targets) {
+        if (!target.isOriginal)
+            continue;
+        for (const [id, variable] of Object.entries(target.variables)) {
+            if (variable.type === broadcastVariableType)
+                ensure(id, variable.name);
+        }
+    }
+    for (const target of project.targets) {
+        if (!target.isOriginal)
+            continue;
+        const targetName = target.getName();
+        for (const { root, block } of walkScripts(target.blocks)) {
+            const reference = messageReference(target, block, stage);
+            if (!reference)
+                continue;
+            const hat = root.opcode === receiveOpcode ? messageReference(target, root, stage) : undefined;
+            const entry = ensure(reference.id, reference.name);
+            const use = {
+                ...reference,
+                key: entry.key,
+                targetId: target.id,
+                targetName,
+                isStage: target.isStage,
+                blockId: block.id,
+                opcode: block.opcode,
+                scriptId: root.id,
+                scriptOpcode: root.opcode,
+                scriptMessageName: hat?.name
+            };
+            (reference.direction === 'send' ? entry.sends : entry.receives).push(use);
+        }
+    }
+    return [...found.values()]
+        .map(({ key, id, name, sends, receives }) => ({ key, id, name, sends, receives, status: statusOf(sends, receives) }))
+        .sort((left, right) => left.name.localeCompare(right.name) || left.key.localeCompare(right.key));
+}
+/**
+ * Whether a message may take this name. A message is owned by the stage, so its name has to be
+ * free across the whole project.
+ */
+export function checkMessageRename(messages, message, name) {
+    const next = name.trim();
+    if (!next)
+        return { error: 'emptyName' };
+    if (next === message.name)
+        return { unchanged: true };
+    const taken = next.toLocaleLowerCase();
+    if (messages.some(other => other.key !== message.key && other.name.toLocaleLowerCase() === taken)) {
+        return { error: 'duplicateName' };
+    }
+    return { name: next };
+}
+/** The whole project as sprite or stage, message, sprite or stage. Isolated messages are kept. */
+export function projectMessageGraph(project, messages = scanProjectMessages(project)) {
+    const edges = new Map();
+    for (const message of messages) {
+        for (const use of [...message.sends, ...message.receives]) {
+            const key = use.direction + '\u0000' + use.targetId + '\u0000' + message.key;
+            const edge = edges.get(key);
+            if (edge)
+                edge.count++;
+            else
+                edges.set(key, { direction: use.direction, targetId: use.targetId, messageKey: message.key, count: 1 });
+        }
+    }
+    return {
+        targets: project.targets.filter(target => target.isOriginal)
+            .map(target => ({ id: target.id, name: target.getName(), isStage: target.isStage })),
+        messages: messages.map(({ key, id, name, status }) => ({ key, id, name, status })),
+        edges: [...edges.values()]
+    };
+}
+/** What one sprite or the stage sends and receives. The stage also carries the project diagram. */
+export function scanTargetMessages(project, targetId) {
+    const messages = scanProjectMessages(project);
+    const isStage = Boolean(project.targets.find(target => target.id === targetId)?.isStage);
+    const mine = (uses) => uses.filter(use => use.targetId === targetId);
+    const sends = messages.flatMap(message => mine(message.sends));
+    const receives = messages.flatMap(message => mine(message.receives));
+    return {
+        targetId,
+        isStage,
+        sends,
+        receives,
+        elsewhere: messages.filter(message => !message.sends.some(use => use.targetId === targetId) &&
+            !message.receives.some(use => use.targetId === targetId)),
+        messages,
+        graph: isStage ? projectMessageGraph(project, messages) : undefined
+    };
+}

package/dist/sprite-variable-edit.d.ts

@@ -0,0 +1,66 @@
+export type SpriteVariableEdit = {
+    type: 'create';
+    name: string;
+} | {
+    type: 'rename';
+    id: string;
+    name: string;
+} | {
+    type: 'delete';
+    id: string;
+};
+export type SpriteVariableEditError = 'emptyName' | 'duplicateName' | 'inUse' | 'unavailable';
+type Variable = {
+    name: string;
+    type: string;
+    isCloud?: boolean;
+};
+type Block = {
+    opcode: string;
+    fields: Record<string, {
+        value: unknown;
+    }>;
+    inputs: Record<string, {
+        block: string | null;
+        shadow: string | null;
+    }>;
+};
+type VariableEvent = {
+    type: 'var_create';
+    varId: string;
+    varName: string;
+    varType: '';
+    isLocal: boolean;
+    isCloud: false;
+} | {
+    type: 'var_rename';
+    varId: string;
+    newName: string;
+} | {
+    type: 'var_delete';
+    varId: string;
+};
+type VariableTarget = {
+    id: string;
+    isStage: boolean;
+    isOriginal: boolean;
+    getName(): string;
+    variables: Record<string, Variable>;
+    blocks: {
+        _blocks: Record<string, Block>;
+        getAllVariableAndListReferences(): Record<string, unknown>;
+        blocklyListen(event: VariableEvent): void;
+    };
+};
+type VariableProject = {
+    editingTarget?: VariableTarget;
+    runtime: {
+        targets: readonly VariableTarget[];
+        getEditingTarget(): VariableTarget | null;
+        getTargetForStage(): VariableTarget | null;
+    };
+    refreshWorkspace(): void;
+};
+export declare const cloudVariablePrefix = "\u2601 ";
+export declare function editSpriteVariable(vm: VariableProject, targetId: string, edit: SpriteVariableEdit): SpriteVariableEditError | void;
+export {};

package/dist/sprite-variable-edit.js

@@ -0,0 +1,53 @@
+export const cloudVariablePrefix = '☁ ';
+function isUsed(target, targets, id, name) {
+    const targetName = target.isStage ? '_stage_' : target.getName();
+    return targets.some(({ blocks }) => {
+        if (Object.hasOwn(blocks.getAllVariableAndListReferences(), id))
+            return true;
+        return Object.values(blocks._blocks).some(block => {
+            if (block.opcode !== 'sensing_of' || block.fields.PROPERTY?.value !== name)
+                return false;
+            const input = block.inputs.OBJECT;
+            if (!input?.block)
+                return false;
+            // A dynamic target can resolve to the variable's owner when the project runs.
+            return input.block !== input.shadow || blocks._blocks[input.block]?.fields.OBJECT?.value === targetName;
+        });
+    });
+}
+export function editSpriteVariable(vm, targetId, edit) {
+    const target = vm.editingTarget;
+    const { runtime } = vm;
+    if (!target || target.id !== targetId || runtime.getEditingTarget() !== target ||
+        !runtime.targets.includes(target) || (!target.isStage && !target.isOriginal))
+        return 'unavailable';
+    const variable = edit.type === 'create' ? undefined : target.variables[edit.id];
+    if (edit.type !== 'create' && variable?.type !== '')
+        return 'unavailable';
+    if (edit.type === 'delete') {
+        if (isUsed(target, runtime.targets, edit.id, variable.name))
+            return 'inUse';
+        target.blocks.blocklyListen({ type: 'var_delete', varId: edit.id });
+    }
+    else {
+        const name = edit.name.trim();
+        if (!name)
+            return 'emptyName';
+        const fullName = variable?.isCloud && !name.startsWith(cloudVariablePrefix) ? cloudVariablePrefix + name : name;
+        if (fullName === variable?.name)
+            return;
+        const scope = target.isStage ? runtime.targets.filter(item => item.isStage || item.isOriginal) :
+            [target, runtime.getTargetForStage()];
+        if (scope.some(owner => owner && Object.values(owner.variables).some(item => item.type === '' && item.name === fullName))) {
+            return 'duplicateName';
+        }
+        if (edit.type === 'create') {
+            const varId = Array.from(crypto.getRandomValues(new Uint32Array(4)), value => value.toString(16).padStart(8, '0')).join('');
+            target.blocks.blocklyListen({ type: 'var_create', varId, varName: fullName, varType: '', isLocal: !target.isStage, isCloud: false });
+        }
+        else {
+            target.blocks.blocklyListen({ type: 'var_rename', varId: edit.id, newName: fullName });
+        }
+    }
+    vm.refreshWorkspace();
+}

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@kubohiroya/turbowarp-plus-editor-project-model",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "UI-free reads and edits of a running Scratch project for TurboWarp Plus Editor",
+  "type": "module",
+  "license": "MPL-2.0",
+  "author": "Hiroya Kubo",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kubohiroya/turbowarp-plus-editor-project-model.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./project-messages": {
+      "types": "./dist/project-messages.d.ts",
+      "default": "./dist/project-messages.js"
+    },
+    "./sprite-variable-edit": {
+      "types": "./dist/sprite-variable-edit.d.ts",
+      "default": "./dist/sprite-variable-edit.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "tsconfig.json",
+    "README.md",
+    "README.ja.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "test": "npm run build && node --test test/*.test.ts"
+  },
+  "devDependencies": {
+    "typescript": "6.0.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './project-messages.ts';
+export * from './sprite-variable-edit.ts';

package/src/project-messages.ts

@@ -0,0 +1,278 @@
+/**
+ * Broadcast message scanning for the message section and for the host's project search.
+ *
+ * This module is the only place that decides which block sends or receives a message, so the
+ * section and the host's search can never disagree. It takes the runtime through structural
+ * types and never imports the VM or the GUI.
+ */
+
+type Field = {id?: string; value?: unknown};
+
+type Block = {
+    id: string;
+    opcode: string;
+    next?: string | null;
+    shadow?: boolean;
+    fields?: Record<string, Field>;
+    inputs?: Record<string, {block?: string | null; shadow?: string | null}>;
+};
+
+type Blocks = {
+    getScripts(): readonly string[];
+    getBlock(id: string): Block | undefined;
+};
+
+type MessageVariable = {name: string; type?: string};
+
+export type MessageTarget = {
+    id: string;
+    isStage: boolean;
+    isOriginal: boolean;
+    getName(): string;
+    variables: Record<string, MessageVariable>;
+    blocks: Blocks;
+};
+
+export type MessageProject = {targets: readonly MessageTarget[]};
+
+export const broadcastVariableType = 'broadcast_msg';
+export const sendOpcodes = ['event_broadcast', 'event_broadcastandwait'] as const;
+export const receiveOpcode = 'event_whenbroadcastreceived';
+
+export type MessageDirection = 'send' | 'receive';
+
+export interface MessageReference {
+    direction: MessageDirection;
+    /** The broadcast_msg variable this block names, when it names one. */
+    id?: string;
+    /** The dropdown's own text, which is what the project file stores. */
+    fieldValue: string;
+    /** The owning variable's name when it resolves, otherwise the dropdown text. */
+    name: string;
+    /** `event_broadcastandwait` waits for every receiving script to finish. */
+    wait: boolean;
+}
+
+/**
+ * The judgement for a single block. Returns nothing for blocks that are not broadcast blocks and
+ * for a broadcast whose message is a reporter, because that message is only known while running.
+ */
+export function messageReference(target: MessageTarget, block: Block,
+    stage?: MessageTarget): MessageReference | undefined {
+    const direction: MessageDirection | undefined = block.opcode === receiveOpcode ? 'receive' :
+        (sendOpcodes as readonly string[]).includes(block.opcode) ? 'send' : undefined;
+    if (!direction) return undefined;
+    const input = block.inputs?.BROADCAST_INPUT;
+    const menu = input?.block ? target.blocks.getBlock(input.block) : undefined;
+    const field = block.fields?.BROADCAST_OPTION ?? menu?.fields?.BROADCAST_OPTION;
+    if (!field) return undefined;
+    const fieldValue = String(field.value ?? '');
+    const owner = field.id ? target.variables[field.id] ?? stage?.variables[field.id] : undefined;
+    return {
+        direction,
+        id: field.id,
+        fieldValue,
+        name: owner?.type === broadcastVariableType && owner.name ? owner.name : fieldValue,
+        wait: block.opcode === 'event_broadcastandwait'
+    };
+}
+
+export interface MessageUse extends MessageReference {
+    key: string;
+    targetId: string;
+    targetName: string;
+    isStage: boolean;
+    blockId: string;
+    opcode: string;
+    /** The top block of the script holding this block, so the host can open the whole script. */
+    scriptId: string;
+    scriptOpcode: string;
+    /** When that script starts with a "when I receive" hat, the message it waits for. */
+    scriptMessageName?: string;
+}
+
+export type MessageStatus = 'both' | 'sendOnly' | 'receiveOnly' | 'unused';
+
+export interface ProjectMessage {
+    /** Stable identity for a message: its variable id, or its name when no variable owns it. */
+    key: string;
+    id?: string;
+    name: string;
+    status: MessageStatus;
+    sends: readonly MessageUse[];
+    receives: readonly MessageUse[];
+}
+
+const messageKey = (id: string | undefined, name: string) => id ?? 'name:' + name;
+
+function* walkScripts(blocks: Blocks) {
+    for (const rootId of blocks.getScripts()) {
+        const root = blocks.getBlock(rootId);
+        if (!root) continue;
+        const pending = [rootId];
+        const seen = new Set<string>();
+        while (pending.length) {
+            const id = pending.pop();
+            if (!id || seen.has(id)) continue;
+            seen.add(id);
+            const block = blocks.getBlock(id);
+            if (!block || block.shadow) continue;
+            yield {root, block};
+            if (block.next) pending.push(block.next);
+            for (const input of Object.values(block.inputs ?? {})) {
+                // A shadow holds a dropdown or a literal, which messageReference reads directly.
+                if (input.block && input.block !== input.shadow) pending.push(input.block);
+            }
+        }
+    }
+}
+
+const statusOf = (sends: readonly unknown[], receives: readonly unknown[]): MessageStatus =>
+    sends.length && receives.length ? 'both' : sends.length ? 'sendOnly' : receives.length ? 'receiveOnly' : 'unused';
+
+/** Every message in the project, with the places that send and receive it. */
+export function scanProjectMessages(project: MessageProject): readonly ProjectMessage[] {
+    const stage = project.targets.find(target => target.isStage);
+    const found = new Map<string, {key: string; id?: string; name: string; sends: MessageUse[]; receives: MessageUse[]}>();
+    const ensure = (id: string | undefined, name: string) => {
+        const key = messageKey(id, name);
+        let entry = found.get(key);
+        if (!entry) {
+            entry = {key, id, name, sends: [], receives: []};
+            found.set(key, entry);
+        }
+        // A message created but never used still carries its variable name.
+        if (name && entry.name !== name) entry.name = name;
+        return entry;
+    };
+
+    for (const target of project.targets) {
+        if (!target.isOriginal) continue;
+        for (const [id, variable] of Object.entries(target.variables)) {
+            if (variable.type === broadcastVariableType) ensure(id, variable.name);
+        }
+    }
+
+    for (const target of project.targets) {
+        if (!target.isOriginal) continue;
+        const targetName = target.getName();
+        for (const {root, block} of walkScripts(target.blocks)) {
+            const reference = messageReference(target, block, stage);
+            if (!reference) continue;
+            const hat = root.opcode === receiveOpcode ? messageReference(target, root, stage) : undefined;
+            const entry = ensure(reference.id, reference.name);
+            const use: MessageUse = {
+                ...reference,
+                key: entry.key,
+                targetId: target.id,
+                targetName,
+                isStage: target.isStage,
+                blockId: block.id,
+                opcode: block.opcode,
+                scriptId: root.id,
+                scriptOpcode: root.opcode,
+                scriptMessageName: hat?.name
+            };
+            (reference.direction === 'send' ? entry.sends : entry.receives).push(use);
+        }
+    }
+
+    return [...found.values()]
+        .map(({key, id, name, sends, receives}) => ({key, id, name, sends, receives, status: statusOf(sends, receives)}))
+        .sort((left, right) => left.name.localeCompare(right.name) || left.key.localeCompare(right.key));
+}
+
+export type MessageRenameError = 'emptyName' | 'duplicateName' | 'unavailable';
+
+export type MessageRenameCheck = {error: MessageRenameError} | {name: string} | {unchanged: true};
+
+/**
+ * Whether a message may take this name. A message is owned by the stage, so its name has to be
+ * free across the whole project.
+ */
+export function checkMessageRename(messages: readonly ProjectMessage[], message: ProjectMessage,
+    name: string): MessageRenameCheck {
+    const next = name.trim();
+    if (!next) return {error: 'emptyName'};
+    if (next === message.name) return {unchanged: true};
+    const taken = next.toLocaleLowerCase();
+    if (messages.some(other => other.key !== message.key && other.name.toLocaleLowerCase() === taken)) {
+        return {error: 'duplicateName'};
+    }
+    return {name: next};
+}
+
+export interface MessageGraphNode {
+    id: string;
+    name: string;
+    isStage: boolean;
+}
+
+export interface MessageGraphEdge {
+    direction: MessageDirection;
+    targetId: string;
+    messageKey: string;
+    /** How many blocks in that target send or receive the message. */
+    count: number;
+}
+
+export interface MessageGraph {
+    targets: readonly MessageGraphNode[];
+    messages: readonly Pick<ProjectMessage, 'key' | 'id' | 'name' | 'status'>[];
+    edges: readonly MessageGraphEdge[];
+}
+
+/** The whole project as sprite or stage, message, sprite or stage. Isolated messages are kept. */
+export function projectMessageGraph(project: MessageProject,
+    messages: readonly ProjectMessage[] = scanProjectMessages(project)): MessageGraph {
+    const edges = new Map<string, MessageGraphEdge>();
+    for (const message of messages) {
+        for (const use of [...message.sends, ...message.receives]) {
+            const key = use.direction + '\u0000' + use.targetId + '\u0000' + message.key;
+            const edge = edges.get(key);
+            if (edge) edge.count++;
+            else edges.set(key, {direction: use.direction, targetId: use.targetId, messageKey: message.key, count: 1});
+        }
+    }
+    return {
+        targets: project.targets.filter(target => target.isOriginal)
+            .map(target => ({id: target.id, name: target.getName(), isStage: target.isStage})),
+        messages: messages.map(({key, id, name, status}) => ({key, id, name, status})),
+        edges: [...edges.values()]
+    };
+}
+
+export interface TargetMessages {
+    targetId: string;
+    isStage: boolean;
+    /** Blocks in this target that send a message. */
+    sends: readonly MessageUse[];
+    /** Hats in this target that receive a message. */
+    receives: readonly MessageUse[];
+    /** Messages the project uses or declares that this target neither sends nor receives. */
+    elsewhere: readonly ProjectMessage[];
+    /** Every message in the project, so a rename can check the names already taken. */
+    messages: readonly ProjectMessage[];
+    /** The relationship diagram, which only the stage shows. */
+    graph?: MessageGraph;
+}
+
+/** What one sprite or the stage sends and receives. The stage also carries the project diagram. */
+export function scanTargetMessages(project: MessageProject, targetId: string): TargetMessages {
+    const messages = scanProjectMessages(project);
+    const isStage = Boolean(project.targets.find(target => target.id === targetId)?.isStage);
+    const mine = (uses: readonly MessageUse[]) => uses.filter(use => use.targetId === targetId);
+    const sends = messages.flatMap(message => mine(message.sends));
+    const receives = messages.flatMap(message => mine(message.receives));
+    return {
+        targetId,
+        isStage,
+        sends,
+        receives,
+        elsewhere: messages.filter(message =>
+            !message.sends.some(use => use.targetId === targetId) &&
+            !message.receives.some(use => use.targetId === targetId)),
+        messages,
+        graph: isStage ? projectMessageGraph(project, messages) : undefined
+    };
+}

package/src/sprite-variable-edit.ts

@@ -0,0 +1,85 @@
+export type SpriteVariableEdit =
+    {type: 'create'; name: string} |
+    {type: 'rename'; id: string; name: string} |
+    {type: 'delete'; id: string};
+
+export type SpriteVariableEditError = 'emptyName' | 'duplicateName' | 'inUse' | 'unavailable';
+
+type Variable = {name: string; type: string; isCloud?: boolean};
+type Block = {
+    opcode: string;
+    fields: Record<string, {value: unknown}>;
+    inputs: Record<string, {block: string | null; shadow: string | null}>;
+};
+type VariableEvent =
+    {type: 'var_create'; varId: string; varName: string; varType: ''; isLocal: boolean; isCloud: false} |
+    {type: 'var_rename'; varId: string; newName: string} |
+    {type: 'var_delete'; varId: string};
+type VariableTarget = {
+    id: string;
+    isStage: boolean;
+    isOriginal: boolean;
+    getName(): string;
+    variables: Record<string, Variable>;
+    blocks: {
+        _blocks: Record<string, Block>;
+        getAllVariableAndListReferences(): Record<string, unknown>;
+        blocklyListen(event: VariableEvent): void;
+    };
+};
+type VariableProject = {
+    editingTarget?: VariableTarget;
+    runtime: {
+        targets: readonly VariableTarget[];
+        getEditingTarget(): VariableTarget | null;
+        getTargetForStage(): VariableTarget | null;
+    };
+    refreshWorkspace(): void;
+};
+
+export const cloudVariablePrefix = '☁ ';
+
+function isUsed(target: VariableTarget, targets: readonly VariableTarget[], id: string, name: string) {
+    const targetName = target.isStage ? '_stage_' : target.getName();
+    return targets.some(({blocks}) => {
+        if (Object.hasOwn(blocks.getAllVariableAndListReferences(), id)) return true;
+        return Object.values(blocks._blocks).some(block => {
+            if (block.opcode !== 'sensing_of' || block.fields.PROPERTY?.value !== name) return false;
+            const input = block.inputs.OBJECT;
+            if (!input?.block) return false;
+            // A dynamic target can resolve to the variable's owner when the project runs.
+            return input.block !== input.shadow || blocks._blocks[input.block]?.fields.OBJECT?.value === targetName;
+        });
+    });
+}
+
+export function editSpriteVariable(vm: VariableProject, targetId: string, edit: SpriteVariableEdit): SpriteVariableEditError | void {
+    const target = vm.editingTarget;
+    const {runtime} = vm;
+    if (!target || target.id !== targetId || runtime.getEditingTarget() !== target ||
+        !runtime.targets.includes(target) || (!target.isStage && !target.isOriginal)) return 'unavailable';
+
+    const variable = edit.type === 'create' ? undefined : target.variables[edit.id];
+    if (edit.type !== 'create' && variable?.type !== '') return 'unavailable';
+    if (edit.type === 'delete') {
+        if (isUsed(target, runtime.targets, edit.id, variable!.name)) return 'inUse';
+        target.blocks.blocklyListen({type: 'var_delete', varId: edit.id});
+    } else {
+        const name = edit.name.trim();
+        if (!name) return 'emptyName';
+        const fullName = variable?.isCloud && !name.startsWith(cloudVariablePrefix) ? cloudVariablePrefix + name : name;
+        if (fullName === variable?.name) return;
+        const scope = target.isStage ? runtime.targets.filter(item => item.isStage || item.isOriginal) :
+            [target, runtime.getTargetForStage()];
+        if (scope.some(owner => owner && Object.values(owner.variables).some(item => item.type === '' && item.name === fullName))) {
+            return 'duplicateName';
+        }
+        if (edit.type === 'create') {
+            const varId = Array.from(crypto.getRandomValues(new Uint32Array(4)), value => value.toString(16).padStart(8, '0')).join('');
+            target.blocks.blocklyListen({type: 'var_create', varId, varName: fullName, varType: '', isLocal: !target.isStage, isCloud: false});
+        } else {
+            target.blocks.blocklyListen({type: 'var_rename', varId: edit.id, newName: fullName});
+        }
+    }
+    vm.refreshWorkspace();
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2023",
+    "module": "NodeNext",
+    "lib": [
+      "ES2023",
+      "DOM"
+    ],
+    "types": [],
+    "skipLibCheck": true,
+    "strict": true,
+    "declaration": true,
+    "rootDir": "src",
+    "outDir": "dist",
+    "rewriteRelativeImportExtensions": true
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}