mirror of
https://github.com/google/blockly.git
synced 2026-01-05 08:00:09 +01:00
7ccdcc5cef
* refactor(events): Use "export ... from" where applicable
* refactor(events): Introduce EventType enum
Introduce an enum for the event .type values. We can't actually
use it as the type of the .type property on Abstract events,
because we want to allow developers to add their own custom
event types inheriting from this type, but at least this way we
can be reasonably sure that all of our own event subclasses have
distinct .type values—plus consistent use of enum syntax
(EventType.TYPE_NAME) is probably good for readability overall.
Put it in a separate module from the rest of events/utils.ts
because it would be helpful if event utils could use
event instanceof SomeEventType
for type narrowing but but at the moment most events are in
modules that depend on events/utils.ts for their .type
constant, and although circular ESM dependencies should work
in principle there are various restrictions and this
particular circularity causes issues at the moment.
A few of the event classes also depend on utils.ts for fire()
or other functions, which will be harder to deal with, but at
least this commit is win in terms of reducing the complexity
of our dependencies, making most of the Abstract event subclass
module dependent on type.ts, which has no imports, rather than
on utils.ts which has multiple imports.
127 lines
3.3 KiB
TypeScript
127 lines
3.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Base class for comment events.
|
|
*
|
|
* @class
|
|
*/
|
|
// Former goog.module ID: Blockly.Events.CommentBase
|
|
|
|
import type {WorkspaceComment} from '../comments/workspace_comment.js';
|
|
import * as comments from '../serialization/workspace_comments.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
import {
|
|
Abstract as AbstractEvent,
|
|
AbstractEventJson,
|
|
} from './events_abstract.js';
|
|
import type {CommentCreate} from './events_comment_create.js';
|
|
import type {CommentDelete} from './events_comment_delete.js';
|
|
import {getGroup, getRecordUndo} from './utils.js';
|
|
|
|
/**
|
|
* Abstract class for a comment event.
|
|
*/
|
|
export class CommentBase extends AbstractEvent {
|
|
override isBlank = true;
|
|
|
|
/** The ID of the comment that this event references. */
|
|
commentId?: string;
|
|
|
|
/**
|
|
* @param opt_comment The comment this event corresponds to. Undefined for a
|
|
* blank event.
|
|
*/
|
|
constructor(opt_comment?: WorkspaceComment) {
|
|
super();
|
|
/** Whether or not an event is blank. */
|
|
this.isBlank = !opt_comment;
|
|
|
|
if (!opt_comment) return;
|
|
|
|
this.commentId = opt_comment.id;
|
|
this.workspaceId = opt_comment.workspace.id;
|
|
this.group = getGroup();
|
|
this.recordUndo = getRecordUndo();
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): CommentBaseJson {
|
|
const json = super.toJson() as CommentBaseJson;
|
|
if (!this.commentId) {
|
|
throw new Error(
|
|
'The comment ID is undefined. Either pass a comment to ' +
|
|
'the constructor, or call fromJson',
|
|
);
|
|
}
|
|
json['commentId'] = this.commentId;
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Deserializes the JSON event.
|
|
*
|
|
* @param event The event to append new properties to. Should be a subclass
|
|
* of CommentBase, but we can't specify that due to the fact that
|
|
* parameters to static methods in subclasses must be supertypes of
|
|
* parameters to static methods in superclasses.
|
|
* @internal
|
|
*/
|
|
static fromJson(
|
|
json: CommentBaseJson,
|
|
workspace: Workspace,
|
|
event?: any,
|
|
): CommentBase {
|
|
const newEvent = super.fromJson(
|
|
json,
|
|
workspace,
|
|
event ?? new CommentBase(),
|
|
) as CommentBase;
|
|
newEvent.commentId = json['commentId'];
|
|
return newEvent;
|
|
}
|
|
|
|
/**
|
|
* Helper function for Comment[Create|Delete]
|
|
*
|
|
* @param event The event to run.
|
|
* @param create if True then Create, if False then Delete
|
|
*/
|
|
static CommentCreateDeleteHelper(
|
|
event: CommentCreate | CommentDelete,
|
|
create: boolean,
|
|
) {
|
|
const workspace = event.getEventWorkspace_();
|
|
if (create) {
|
|
if (!event.json) {
|
|
throw new Error('Encountered a comment event without proper json');
|
|
}
|
|
comments.append(event.json, workspace);
|
|
} else {
|
|
if (!event.commentId) {
|
|
throw new Error(
|
|
'The comment ID is undefined. Either pass a comment to ' +
|
|
'the constructor, or call fromJson',
|
|
);
|
|
}
|
|
const comment = workspace.getCommentById(event.commentId);
|
|
if (comment) {
|
|
comment.dispose();
|
|
} else {
|
|
console.warn("Can't delete non-existent comment: " + event.commentId);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
export interface CommentBaseJson extends AbstractEventJson {
|
|
commentId: string;
|
|
}
|