@sakuzu/maplibre-gl-draw 1.0.0 → 2.1.0

package/dist/api/extensions.d.ts

@@ -0,0 +1,306 @@
+/**
+ * `draw.extensions`: the collections of plugins, modes, feature types, overlays and providers
+ *
+ * Every kind of extension is added the same way: `add` registers it and returns the function
+ * that removes it, and `remove(name)` removes it by name.
+ */
+import type { FeatureTypeDefinition } from './extension/feature-type.js';
+import type { ModeFactory } from './extension/mode.js';
+import type { Plugin } from './extension/plugin.js';
+import type { CompanionProvider, HandleProvider, SnapProvider } from './extension/provider.js';
+import type { OverlayRenderer } from './extension/render.js';
+/** The plugins, in the order they were added. */
+export interface PluginsCollection {
+    /**
+     * Gets a plugin by name.
+     *
+     * @returns The plugin, or `undefined` when there is none with this name
+     */
+    get(name: string): Plugin | undefined;
+    /** Lists the plugins in the order they were added. */
+    list(): Plugin[];
+    /** Counts the plugins. */
+    count(): number;
+    /** Whether a plugin with this name was added. */
+    has(name: string): boolean;
+    /**
+     * Adds a plugin.
+     *
+     * @returns The function that removes it again
+     * @throws `DrawError` with the code `already-exists` when a plugin with the same name was
+     *   added
+     *   or with `invalid-input` when the value does not have the shape of the contract
+     */
+    add(plugin: Plugin): () => void;
+    /**
+     * Adds several plugins in one transaction: all of them or none.
+     *
+     * @returns The function that removes them again
+     * @throws `DrawError` with the code `already-exists` when one of the names is taken, or
+     *   `invalid-input` when a value does not have the shape of the contract; nothing is added
+     *   then
+     */
+    addMany(plugins: readonly Plugin[]): () => void;
+    /**
+     * Removes a plugin, with everything it added.
+     *
+     * @returns True when it was removed
+     * @throws `DrawError` with the code `not-found` when there is no plugin with this name
+     */
+    remove(name: string): boolean;
+    /**
+     * Removes several plugins, with everything they added: all of them or none.
+     *
+     * @returns True when they were removed
+     * @throws `DrawError` with the code `not-found` when one of the names does not exist;
+     *   nothing is removed then
+     */
+    removeMany(names: readonly string[]): boolean;
+    /**
+     * The API a plugin offers to others.
+     *
+     * @returns The API, or `undefined` when there is no plugin with this name or it offers none
+     */
+    getApi<T>(name: string): T | undefined;
+}
+/** The modes that were added, by name. */
+export interface ModesCollection {
+    /**
+     * Gets the factory of a mode by name.
+     *
+     * @returns The factory, or `undefined` when there is no mode with this name
+     */
+    get(name: string): ModeFactory | undefined;
+    /** Lists the names of the modes. */
+    list(): string[];
+    /** Counts the modes. */
+    count(): number;
+    /** Whether a mode with this name was added. */
+    has(name: string): boolean;
+    /**
+     * Adds a mode under a name.
+     *
+     * @returns The function that removes it again
+     * @throws `DrawError` with the code `already-exists` when the name is taken
+     *   or with `invalid-input` when the value does not have the shape of the contract
+     */
+    add(name: string, factory: ModeFactory): () => void;
+    /**
+     * Adds several modes in one transaction: all of them or none.
+     *
+     * @returns The function that removes them again
+     * @throws `DrawError` with the code `already-exists` when one of the names is taken, or
+     *   `invalid-input` when a value does not have the shape of the contract; nothing is added
+     *   then
+     */
+    addMany(entries: readonly {
+        name: string;
+        factory: ModeFactory;
+    }[]): () => void;
+    /**
+     * Removes a mode.
+     *
+     * @returns True when it was removed
+     * @throws `DrawError` with the code `not-found` when there is no mode with this name
+     */
+    remove(name: string): boolean;
+    /**
+     * Removes several modes: all of them or none.
+     *
+     * @returns True when they were removed
+     * @throws `DrawError` with the code `not-found` when one of the names does not exist;
+     *   nothing is removed then
+     */
+    removeMany(names: readonly string[]): boolean;
+}
+/**
+ * The custom feature types, by type name, and the definitions that override a built-in type.
+ */
+export interface FeatureTypesCollection {
+    /**
+     * Gets the definition of a feature type by name: a type that was added, or the definition
+     * that overrides a built-in type.
+     *
+     * @returns The definition, or `undefined` when there is none with this name
+     */
+    get(name: string): FeatureTypeDefinition | undefined;
+    /** Lists the names of the feature types that were added or overridden. */
+    list(): string[];
+    /** Counts the feature types that were added or overridden. */
+    count(): number;
+    /** Whether a feature type with this name was added or overridden. */
+    has(name: string): boolean;
+    /**
+     * Adds a custom feature type. The type takes every feature of its type: its `appliesTo`, if
+     * it has one, is ignored.
+     *
+     * @returns The function that removes it again
+     * @throws `DrawError` with the code `already-exists` when the type name is taken
+     *   or with `invalid-input` when the value does not have the shape of the contract
+     */
+    add(definition: FeatureTypeDefinition): () => void;
+    /**
+     * Adds several custom feature types in one transaction: all of them or none.
+     *
+     * @returns The function that removes them again
+     * @throws `DrawError` with the code `already-exists` when one of the names is taken, or
+     *   `invalid-input` when a value does not have the shape of the contract; nothing is added
+     *   then
+     */
+    addMany(definitions: readonly FeatureTypeDefinition[]): () => void;
+    /**
+     * Overrides a built-in feature type (`Point`, `LineString`, `Polygon`, `Circle`,
+     * `Freehand` or `Image`) with a definition of the same `type` and the same kind of
+     * `geometry` as the built-in one (`Point` for a circle and an image, `LineString` for a
+     * freehand line). The features of the type are drawn by its renderer from then on. Its
+     * `hitTest`, `boxSelect`, `bounds`, `outline`, `bbox` and `snapCandidates` replace those of
+     * the built-in type when it has them, and the built-in ones stay for the members it leaves
+     * out. Its `handles` are shown with those of the built-in type. With `appliesTo`, it takes
+     * only the features for which that returns true, and the others keep the built-in type
+     * entirely.
+     *
+     * The built-in type comes back with the function it returns, with `remove(type)`, and, for
+     * a plugin that overrode it through its context, when the plugin is removed. `add` keeps
+     * refusing the names of the built-in types.
+     *
+     * @returns The function that puts the built-in type back
+     * @throws `DrawError` with the code `invalid-input` when the type is not one of the
+     *   built-in types above, its `geometry` is not the one of the built-in type, or the value
+     *   does not have the shape of the contract, and `already-exists` when the type is already
+     *   overridden
+     */
+    override(definition: FeatureTypeDefinition): () => void;
+    /**
+     * Removes a custom feature type, or the definition that overrides a built-in type (the
+     * built-in type comes back).
+     *
+     * @returns True when it was removed
+     * @throws `DrawError` with the code `not-found` when there is no type with this name
+     */
+    remove(name: string): boolean;
+    /**
+     * Removes several custom feature types: all of them or none.
+     *
+     * @returns True when they were removed
+     * @throws `DrawError` with the code `not-found` when one of the names does not exist;
+     *   nothing is removed then
+     */
+    removeMany(names: readonly string[]): boolean;
+}
+/** The renderers that draw above the features or between the layers, by name. */
+export interface OverlaysCollection {
+    /**
+     * Gets an overlay renderer by name.
+     *
+     * @returns The renderer, or `undefined` when there is none with this name
+     */
+    get(name: string): OverlayRenderer | undefined;
+    /** Lists the names of the overlay renderers. */
+    list(): string[];
+    /** Counts the overlay renderers. */
+    count(): number;
+    /** Whether an overlay renderer with this name was added. */
+    has(name: string): boolean;
+    /**
+     * Adds an overlay renderer.
+     *
+     * @returns The function that removes it again
+     * @throws `DrawError` with the code `already-exists` when the name is taken
+     *   or with `invalid-input` when the value does not have the shape of the contract
+     */
+    add(renderer: OverlayRenderer): () => void;
+    /**
+     * Adds several overlay renderers in one transaction: all of them or none.
+     *
+     * @returns The function that removes them again
+     * @throws `DrawError` with the code `already-exists` when one of the names is taken, or
+     *   `invalid-input` when a value does not have the shape of the contract; nothing is added
+     *   then
+     */
+    addMany(renderers: readonly OverlayRenderer[]): () => void;
+    /**
+     * Removes an overlay renderer.
+     *
+     * @returns True when it was removed
+     * @throws `DrawError` with the code `not-found` when there is none with this name
+     */
+    remove(name: string): boolean;
+    /**
+     * Removes several overlay renderers: all of them or none.
+     *
+     * @returns True when they were removed
+     * @throws `DrawError` with the code `not-found` when one of the names does not exist;
+     *   nothing is removed then
+     */
+    removeMany(names: readonly string[]): boolean;
+}
+/**
+ * The providers of one kind, by name: snapping candidates, handles or companions.
+ *
+ * @typeParam T - The kind of provider
+ */
+export interface ProvidersCollection<T> {
+    /**
+     * Gets a provider by name.
+     *
+     * @returns The provider, or `undefined` when there is none with this name
+     */
+    get(name: string): T | undefined;
+    /** Lists the names of the providers. */
+    list(): string[];
+    /** Counts the providers. */
+    count(): number;
+    /** Whether a provider with this name was added. */
+    has(name: string): boolean;
+    /**
+     * Adds a provider.
+     *
+     * @returns The function that removes it again
+     * @throws `DrawError` with the code `already-exists` when the name is taken
+     *   or with `invalid-input` when the value does not have the shape of the contract
+     */
+    add(provider: T): () => void;
+    /**
+     * Adds several providers in one transaction: all of them or none.
+     *
+     * @returns The function that removes them again
+     * @throws `DrawError` with the code `already-exists` when one of the names is taken, or
+     *   `invalid-input` when a value does not have the shape of the contract; nothing is added
+     *   then
+     */
+    addMany(providers: readonly T[]): () => void;
+    /**
+     * Removes a provider.
+     *
+     * @returns True when it was removed
+     * @throws `DrawError` with the code `not-found` when there is no provider with this name
+     */
+    remove(name: string): boolean;
+    /**
+     * Removes several providers: all of them or none.
+     *
+     * @returns True when they were removed
+     * @throws `DrawError` with the code `not-found` when one of the names does not exist;
+     *   nothing is removed then
+     */
+    removeMany(names: readonly string[]): boolean;
+}
+/**
+ * Every collection of extensions of a draw instance.
+ */
+export interface ExtensionsCollections {
+    /** The plugins: bundles of other extensions and state */
+    readonly plugins: PluginsCollection;
+    /** The modes: ways of receiving input */
+    readonly modes: ModesCollection;
+    /** The custom feature types */
+    readonly featureTypes: FeatureTypesCollection;
+    /** The renderers that draw above the features or between the layers */
+    readonly overlays: OverlaysCollection;
+    /** The providers of snapping candidates */
+    readonly snapProviders: ProvidersCollection<SnapProvider>;
+    /** The providers of handles on the selected features */
+    readonly handleProviders: ProvidersCollection<HandleProvider>;
+    /** The providers of companions drawn one step below a feature */
+    readonly companionProviders: ProvidersCollection<CompanionProvider>;
+}

package/dist/api/extensions.js

@@ -0,0 +1,3 @@
+// SPDX-FileCopyrightText: 2026 SAKAIDA Atsushi
+// SPDX-License-Identifier: AGPL-3.0-only
+export {};

package/dist/api/features.d.ts

@@ -0,0 +1,188 @@
+/**
+ * `draw.features`: the features of the document
+ */
+import type { Feature, FeatureFilter, FeatureInput, FeaturePatch, FeatureStyleResolved, MoveTarget } from './model.js';
+/**
+ * The features of the document, with the standard methods of a collection and the verbs
+ * that move, combine and split them.
+ *
+ * A wrong argument (an ID that does not exist, an input of the wrong shape) throws a
+ * `DrawError` and changes nothing. A refusal because of the state (read-only, a lock) returns
+ * `null` or `false` and changes nothing. A method whose name ends in `Many` runs in one
+ * transaction: all of it happens or none of it does.
+ */
+export interface FeaturesCollection {
+    /**
+     * Gets a feature by ID.
+     *
+     * @returns The feature, or `undefined` when there is none with this ID
+     */
+    get(id: string): Feature | undefined;
+    /**
+     * Gets features by ID, in the order of the IDs.
+     *
+     * @returns One entry per ID: the feature, or `undefined` when there is none with that ID
+     */
+    getMany(ids: readonly string[]): (Feature | undefined)[];
+    /**
+     * Lists the features in stacking order, from the back.
+     *
+     * @param filter - Keeps only the features that match every key given
+     */
+    list(filter?: FeatureFilter): Feature[];
+    /**
+     * Counts the features.
+     *
+     * @param filter - Counts only the features that match every key given
+     */
+    count(filter?: FeatureFilter): number;
+    /** Whether a feature with this ID exists. */
+    has(id: string): boolean;
+    /**
+     * Whether the feature can be edited now: the document is not read-only, and neither the
+     * feature nor its group nor its layer is locked. A refused edit returns `null` or `false`
+     * for the same reasons.
+     *
+     * @throws `DrawError` with the code `not-found` when there is no feature with this ID
+     */
+    isEditable(id: string): boolean;
+    /**
+     * Creates a feature and returns it as it was stored.
+     *
+     * @returns The new feature, or `null` when the document is read-only
+     * @throws `DrawError` with the code `invalid-input` when the input has the wrong shape,
+     *   `already-exists` when its ID is taken, `not-found` when its layer or group does not
+     *   exist, or `invalid-state` when the input names no layer and the document has no layer
+     *   to put it in
+     */
+    create(input: FeatureInput): Feature | null;
+    /**
+     * Creates several features in one transaction: all of them or none.
+     *
+     * @returns The new features in the order of the inputs, or `null` when the document is
+     *   read-only
+     * @throws `DrawError` as {@link FeaturesCollection.create} does, for any of the inputs;
+     *   nothing is created then
+     */
+    createMany(inputs: readonly FeatureInput[]): Feature[] | null;
+    /**
+     * Changes the keys given in the patch and returns the feature after the change.
+     *
+     * `properties` and `style` are merged key by key, and a key given as `undefined` is
+     * removed.
+     *
+     * @returns The changed feature, or `null` when the change is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when there is no feature with this ID, or
+     *   `invalid-input` when the patch has the wrong shape
+     */
+    update(id: string, patch: FeaturePatch): Feature | null;
+    /**
+     * Changes several features in one transaction: all of them or none.
+     *
+     * @returns The changed features in the order of the patches, or `null` when the change is
+     *   refused
+     * @throws `DrawError` as {@link FeaturesCollection.update} does, for any of the patches;
+     *   nothing changes then
+     */
+    updateMany(patches: readonly {
+        id: string;
+        patch: FeaturePatch;
+    }[]): Feature[] | null;
+    /**
+     * Deletes a feature.
+     *
+     * @returns True when it was deleted, false when the deletion is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when there is no feature with this ID
+     */
+    delete(id: string): boolean;
+    /**
+     * Deletes several features in one transaction: all of them or none.
+     *
+     * @returns True when they were deleted, false when the deletion is refused
+     * @throws `DrawError` with the code `not-found` when one of the IDs does not exist; nothing
+     *   is deleted then
+     */
+    deleteMany(ids: readonly string[]): boolean;
+    /**
+     * Moves a feature to another layer, into a group or out of its group; `index` of the
+     * target sets its position there.
+     *
+     * @returns True when it moved, false when the move is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when the feature or the target does not
+     *   exist
+     */
+    move(id: string, to: MoveTarget): boolean;
+    /**
+     * Moves several features in one transaction, keeping their order: all of them or none.
+     *
+     * @returns True when they moved, false when the move is refused
+     * @throws `DrawError` with the code `not-found` when one of the features or the target does
+     *   not exist; nothing moves then
+     */
+    moveMany(ids: readonly string[], to: MoveTarget): boolean;
+    /**
+     * The look a feature is drawn with: the default, the layer rule and the style of the
+     * feature put on top of each other.
+     *
+     * The colors of the `style` option and of the style of the feature are the strings they
+     * were given, alpha included; the color of a layer rule is `#rrggbb`, as
+     * {@link evaluateStyleRule} gives it, and a default is `#rrggbb`.
+     *
+     * @returns The look, or `undefined` when there is no feature with this ID
+     */
+    getAppliedStyle(id: string): FeatureStyleResolved | undefined;
+    /**
+     * Joins areas into one feature and returns it; the result replaces the features given.
+     *
+     * @returns The new feature, or `null` when the operation is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when one of the IDs does not exist, or
+     *   `invalid-input` when fewer than two areas are given or one of the features is not an
+     *   area
+     */
+    union(ids: readonly string[]): Feature | null;
+    /**
+     * Subtracts other areas from an area and returns the result; the result replaces the area
+     * subtracted from, and the areas subtracted stay.
+     *
+     * @param id - The area to subtract from
+     * @param subtractIds - The areas to subtract
+     * @returns The resulting feature, or `null` when the operation is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when one of the IDs does not exist, or
+     *   `invalid-input` when one of the features is not an area
+     */
+    difference(id: string, subtractIds: readonly string[]): Feature | null;
+    /**
+     * Keeps the part where areas overlap and returns it; the result replaces the features given.
+     *
+     * @returns The resulting feature, or `null` when the operation is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when one of the IDs does not exist, or
+     *   `invalid-input` when fewer than two areas are given or one of the features is not an
+     *   area
+     */
+    intersection(ids: readonly string[]): Feature | null;
+    /**
+     * Splits an area along a line and returns the features it made.
+     *
+     * @param id - The area to split
+     * @param lineId - The line to split along
+     * @returns The new features, or `null` when the operation is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when one of the IDs does not exist, or
+     *   `invalid-input` when the features are not an area and a line
+     */
+    split(id: string, lineId: string): Feature[] | null;
+    /**
+     * Creates the areas around features.
+     *
+     * @param ids - The features to surround
+     * @param options - `distanceMeters` is the distance of the outline from the features, and
+     *   `segments` the number of segments of a full circle, as in the buffer of the geometry
+     *   entry
+     * @returns The new features, or `null` when the operation is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when one of the IDs does not exist, or
+     *   `invalid-input` when the distance is not a finite number
+     */
+    buffer(ids: readonly string[], options: {
+        distanceMeters: number;
+        segments?: number;
+    }): Feature[] | null;
+}

package/dist/api/features.js

@@ -0,0 +1,3 @@
+// SPDX-FileCopyrightText: 2026 SAKAIDA Atsushi
+// SPDX-License-Identifier: AGPL-3.0-only
+export {};

package/dist/api/groups.d.ts

@@ -0,0 +1,111 @@
+/**
+ * `draw.groups`: the groups of the document
+ */
+import type { Group, GroupFilter, GroupInput, GroupPatch, MoveTarget } from './model.js';
+/**
+ * The groups of the document, with the standard methods of a collection and the verbs that
+ * move them.
+ *
+ * A wrong argument (an ID that does not exist, an input of the wrong shape) throws a
+ * `DrawError` and changes nothing. A refusal because of the state (read-only, a lock) returns
+ * `null` or `false` and changes nothing. A method whose name ends in `Many` runs in one
+ * transaction: all of it happens or none of it does.
+ */
+export interface GroupsCollection {
+    /**
+     * Gets a group by ID.
+     *
+     * @returns The group, or `undefined` when there is none with this ID
+     */
+    get(id: string): Group | undefined;
+    /**
+     * Gets groups by ID, in the order of the IDs.
+     *
+     * @returns One entry per ID: the group, or `undefined` when there is none with that ID
+     */
+    getMany(ids: readonly string[]): (Group | undefined)[];
+    /**
+     * Lists the groups in stacking order, from the back.
+     *
+     * @param filter - Keeps only the groups that match every key given
+     */
+    list(filter?: GroupFilter): Group[];
+    /**
+     * Counts the groups.
+     *
+     * @param filter - Counts only the groups that match every key given
+     */
+    count(filter?: GroupFilter): number;
+    /** Whether a group with this ID exists. */
+    has(id: string): boolean;
+    /**
+     * Creates a group of features and returns it as it was stored.
+     *
+     * @returns The new group, or `null` when the document is read-only
+     * @throws `DrawError` with the code `not-found` when one of the features does not exist,
+     *   `invalid-input` when the features are not in the same layer, or `already-exists` when
+     *   its ID is taken
+     */
+    create(input: GroupInput): Group | null;
+    /**
+     * Creates several groups in one transaction: all of them or none.
+     *
+     * @returns The new groups in the order of the inputs, or `null` when the document is
+     *   read-only
+     * @throws `DrawError` as {@link GroupsCollection.create} does, for any of the inputs;
+     *   nothing is created then
+     */
+    createMany(inputs: readonly GroupInput[]): Group[] | null;
+    /**
+     * Changes the keys given in the patch and returns the group after the change.
+     *
+     * @returns The changed group, or `null` when the change is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when there is no group with this ID, or
+     *   `invalid-input` when the patch has the wrong shape
+     */
+    update(id: string, patch: GroupPatch): Group | null;
+    /**
+     * Changes several groups in one transaction: all of them or none.
+     *
+     * @returns The changed groups in the order of the patches, or `null` when the change is
+     *   refused
+     * @throws `DrawError` as {@link GroupsCollection.update} does, for any of the patches;
+     *   nothing changes then
+     */
+    updateMany(patches: readonly {
+        id: string;
+        patch: GroupPatch;
+    }[]): Group[] | null;
+    /**
+     * Deletes a group; its features stay in the layer.
+     *
+     * @returns True when it was deleted, false when the deletion is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when there is no group with this ID
+     */
+    delete(id: string): boolean;
+    /**
+     * Deletes several groups in one transaction: all of them or none. Their features stay in
+     * their layers.
+     *
+     * @returns True when they were deleted, false when the deletion is refused
+     * @throws `DrawError` with the code `not-found` when one of the IDs does not exist; nothing
+     *   is deleted then
+     */
+    deleteMany(ids: readonly string[]): boolean;
+    /**
+     * Moves a group to another layer, or to another position in its layer.
+     *
+     * @returns True when it moved, false when the move is refused (read-only, a lock)
+     * @throws `DrawError` with the code `not-found` when the group or the target does not
+     *   exist, or `invalid-input` when the target is a group
+     */
+    move(id: string, to: MoveTarget): boolean;
+    /**
+     * Moves several groups in one transaction: all of them or none.
+     *
+     * @returns True when they moved, false when the move is refused
+     * @throws `DrawError` as {@link GroupsCollection.move} does, for any of the groups; nothing
+     *   moves then
+     */
+    moveMany(ids: readonly string[], to: MoveTarget): boolean;
+}

package/dist/api/groups.js

@@ -0,0 +1,3 @@
+// SPDX-FileCopyrightText: 2026 SAKAIDA Atsushi
+// SPDX-License-Identifier: AGPL-3.0-only
+export {};

package/dist/api/hidden.d.ts

@@ -0,0 +1,45 @@
+/**
+ * `draw.hidden`: what this client hides without changing the document
+ */
+/**
+ * The IDs of the features, groups and layers this client hides. Hiding changes only what this
+ * client draws; the document and its `visible` flags stay as they are.
+ */
+export interface HiddenCollection {
+    /** Whether this client hides the item with this ID. */
+    get(id: string): boolean;
+    /** Lists the IDs this client hides. */
+    list(): readonly string[];
+    /** Counts the IDs this client hides. */
+    count(): number;
+    /** Whether this client hides the item with this ID; the same as {@link HiddenCollection.get}. */
+    has(id: string): boolean;
+    /**
+     * Hides a feature, a group or a layer in this client only; the document does not change.
+     *
+     * @throws `DrawError` with the code `not-found` when the ID is not a feature, a group or a
+     *   layer of the document
+     */
+    add(id: string): void;
+    /**
+     * Hides several items in this client only, all of them or none.
+     *
+     * @throws `DrawError` with the code `not-found` when one of the IDs is not in the document;
+     *   nothing is hidden then
+     */
+    addMany(ids: readonly string[]): void;
+    /**
+     * Shows an item this client hid.
+     *
+     * @returns False when this client did not hide it
+     */
+    remove(id: string): boolean;
+    /**
+     * Shows several items this client hid, all at once.
+     *
+     * @returns False when this client hid none of them
+     */
+    removeMany(ids: readonly string[]): boolean;
+    /** Shows every item this client hid. */
+    clear(): void;
+}

package/dist/api/hidden.js

@@ -0,0 +1,3 @@
+// SPDX-FileCopyrightText: 2026 SAKAIDA Atsushi
+// SPDX-License-Identifier: AGPL-3.0-only
+export {};