@doist/typist 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 1.0.0 (2022-11-04)
+
+### Features
+
+-   Initial Typist implementation ([19451ab](https://github.com/Doist/typist/commit/19451ab9eb66de1399585d9a2e06141096d690c4))
+
+### Bug Fixes
+
+-   **deps:** update tiptap packages to v2.0.0-beta.200 ([#3](https://github.com/Doist/typist/issues/3)) ([6e977a9](https://github.com/Doist/typist/commit/6e977a9ee5f687700d2868a834b8d20068c15e3e))

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,83 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+-   Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+-   The use of sexualized language or imagery, and sexual attention or advances of any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or email address, without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at frontend+opensource@doist.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][faq]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -0,0 +1,123 @@
+# Contributing to Typist
+
+The following is a set of guidelines for contributing to Typist. Please spend several minutes reading these guidelines before you create an issue, pull request or discussion.
+
+## Code of Conduct
+
+Doist has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect contributors to Typist to adhere to it. Please read [the full text](https://github.com/doist/typist/blob/main/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
+
+## Open Development
+
+All work on Typist happens directly on [GitHub](https://github.com/Doist/typist). Both core team members and external contributors send pull requests that go through the same review process.
+
+## Semantic Versioning
+
+Typist follows [semantic versioning](https://semver.org/). We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.
+
+Every significant change is documented in the [CHANGELOG.md](CHANGELOG.md) file.
+
+## Branch Organization
+
+Submit all changes directly to the [main](https://github.com/doist/typist/tree/main) branch. We don't use separate branches for development or for upcoming releases. We do our best to keep `main` in good shape, with all tests passing.
+
+## Proposing a Change
+
+If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend opening a [GitHub Discussion](https://github.com/doist/typist/discussions) with the core team first. Although we welcome all contributions, this lets us reach an agreement on your proposal before you put significant effort into something that might not fit Doist product requirements.
+
+## Your First Pull Request
+
+Working on your first Pull Request? You can learn how from this free video series:
+
+-   [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
+
+If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.
+
+## Project Setup
+
+Before you can contribute to the codebase, you will need to fork the Typist repository, and the following steps will help you hit the ground running:
+
+1. Fork the repository (click the <kbd>Fork</kbd> button at the top right of [this page](https://github.com/doist/typist));
+
+2. Clone your fork locally;
+
+```sh
+git clone https://github.com/<your_github_username>/typist.git
+cd typist
+```
+
+3. Install all dependencies by running `npm install`;
+
+    > **Note**
+    >
+    > If you're not using **npm 7+**, install peer dependencies with `npx npm-install-peers`.
+
+## Development Workflow
+
+After cloning Typist and installing all dependencies, several commands are at your disposal:
+
+-   `npm run build`: Builds the `@doist/typist` package for publishing to [npm](https://www.npmjs.com/) and [GitHub Packages](https://github.com/orgs/Doist/packages?repo_name=typist);
+-   `npm run check`: Validates code quality with ESLint, styling with Prettier, and types with TypeScript;
+-   `npm run clean`: Removes temporary directories used for multiple caches;
+-   `npm run storybook:build`: Builds Storybook as a static Web application;
+-   `npm run storybook:start`: Starts Storybook Web application (available at http://localhost:6006/);
+-   `npm run test`: Runs all unit test with Jest and end-to-end tests with Storybook.
+
+### Release Process (core team only)
+
+The release process for Typist is almost fully automated with [`semantic-release`](https://github.com/semantic-release/semantic-release), only requiring a core team member to trigger [this workflow](https://github.com/Doist/typist/actions/workflows/publish-typist-package-release.yml) manually whenever a new release needs to be published.
+
+### Visual Studio Code
+
+#### CSS Modules for Storybook
+
+Typist Storybook makes use of [`typescript-plugin-css-modules`](https://github.com/mrmckeb/typescript-plugin-css-modules), a [TypeScript language service plugin](https://github.com/Microsoft/TypeScript/wiki/Writing-a-Language-Service-Plugin) for [CSS Modules](https://github.com/css-modules/css-modules), which provides type information to IDEs and any other tools that work with TypeScript language service plugins.
+
+To use this plugin with Visual Studio Code, you should set your workspace's version of TypeScript, which will load plugins from your tsconfig.json file. For instructions, please see: [Using the workspace version of TypeScript](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-the-workspace-version-of-typescript).
+
+## Sending a Pull Request
+
+Pull requests are actively monitored, and only need the approval of one or more core team members. We will review your pull request and either merge it, request changes to it, or close it with an explanation.
+
+Before submitting a pull request, please take the following into consideration:
+
+-   Fork [the repository](https://github.com/doist/typist) and create your branch from `main`;
+-   Follow the [Commit Message Guidelines](#commit-message-guidelines) below;
+-   Add tests for code that should be tested (like bug fixes);
+-   Ensure the test suite passes with flying colours;
+-   Do not override built-in validation and formatting checks.
+
+### Commit Message Guidelines
+
+#### Atomic Commits
+
+If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:
+
+-   A commit should not mix whitespace and/or code style changes with functional code changes;
+-   A commit should contain exactly one self-contained functional change;
+-   A commit should not create an inconsistent state (e.g., test errors, linting errors, partial fix, etc.).
+
+#### Commit Message Format
+
+This repository expects all commit messages to follow the [Conventional Commits Specification](https://www.conventionalcommits.org/) to automate semantic versioning and `CHANGELOG.md` generation.
+
+As a quick summary, each commit message consists of a **header**, an **optional body**, and an **optional footer**. The header has a special format that includes a **type**, an **optional scope**, and a **description**:
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Commit types, such as `feat:` or `fix:`, are the only ones that will affect versioning and `CHANGELOG.md` generation, whereas commit types such as `build:`, `chore:`, `ci:`, `docs:`, `perf:`, `refactor:`, `revert:`, `style:` and `test:` will not. They are still valid, and it would be great if you could use them when appropriate.
+
+A commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section, or appends a `!` after the type/scope, introduces a breaking API change (correlating with `MAJOR` in Semantic Versioning). A breaking change can be part of commits of any _type_.
+
+## License
+
+By contributing to Typist, you agree that your contributions will be licensed under its [MIT license](LICENSE).
+
+## Attribution
+
+This document is based on [reactjs.org contributing guidelines](https://reactjs.org/docs/how-to-contribute.html).

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Doist Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+<div align="center">
+    <h1>
+        <img src="https://github.com/Doist/typist/blob/main/.github/assets/logo-light.png?raw=true#gh-light-mode-only" />
+        <img src="https://github.com/Doist/typist/blob/main/.github/assets/logo-dark.png?raw=true#gh-dark-mode-only" />
+    </h1>
+</div>
+
+Typist is the mighty [Tiptap](https://tiptap.dev/)-based rich-text editor that powers Doist products, which can also be used for displaying content in a read-only fashion. Typist also supports a plain-text mode, and comes with HTML/Markdown serializers.
+
+> **Note**
+>
+> This project is not attempting to be an all-purpose rich-text editor. Whilst everyone is welcome to fork or use this package in their own products, development decisions are centered around Doist product requirements.
+
+<div align="center">
+
+![GitHub: CI Validation](https://github.com/Doist/typist/actions/workflows/check-ci-validation.yml/badge.svg?branch=main)
+![npm Version](https://img.shields.io/npm/v/@doist/typist)
+![npm Bundle Size (minified)](https://img.shields.io/bundlephobia/min/@doist/typist)
+![npm Downloads (monthly)](https://img.shields.io/npm/dm/@doist/typist?color=blue)
+
+[![semantic-release: Conventional Commits](https://img.shields.io/badge/semantic--release-Conventional%20Commits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![License: MIT](https://img.shields.io/github/license/doist/typist)](LICENSE.md)
+
+</div>
+
+## Installation
+
+```sh
+npm install --save @doist/typist
+```
+
+### Peer Dependencies
+
+If you are using **npm 7+** and the `legacy-peer-deps` options is not enabled, peer dependencies should have been automatically installed for you with the command above. Otherwise, you can install them with:
+
+```sh
+npm info @doist/typist peerDependencies --json \
+    | command sed 's/[\{\},]//g ; s/: /@/g' \
+    | xargs npm install --save
+```
+
+## Usage
+
+```tsx
+import { TypistEditor, RichTextKit } from '@doist/typist'
+
+function TypistEditorContainer({ content }) {
+    return (
+        <TypistEditor
+            placeholder="A full rich-text editor, be creative…"
+            content={content}
+            extensions={[RichTextKit]}
+        />
+    )
+}
+```
+
+If you're looking for additional documentation, in-depth examples, or a live demo, please check out our [Storybook](https://typist.doist.dev/).
+
+## Resources
+
+A curated list of open-source rich-text editors powered by Tiptap that we can draw inspiration from:
+
+-   GitLab's content editor:\
+    https://gitlab.com/gitlab-org/gitlab/-/tree/master/app/assets/javascripts/content_editor
+
+## Contributing
+
+If you're interested in contributing code and/or documentation, please read our [contributing guide](CONTRIBUTING.md).
+
+## License
+
+The use of this source code is governed by an MIT-style license that can be found in the [LICENSE](LICENSE) file.

package/dist/components/typist-editor.d.ts

@@ -0,0 +1,173 @@
+/// <reference types="react" />
+import { ViewEventHandlersOptions } from '../extensions/core/view-event-handlers';
+import { getAllNodesAttributesByType } from './typist-editor.helper';
+import type { Editor as CoreEditor, EditorEvents, Extensions } from '@tiptap/core';
+import type { Selection } from 'prosemirror-state';
+/**
+ * The forwarded ref that describes the helper methods that the `TypistEditor` parent component
+ * will have access to.
+ */
+declare type TypistEditorRef = {
+    /**
+     * Returns the `Editor` instance associated to the `TypistEditor` component.
+     */
+    getEditor: () => CoreEditor;
+    /**
+     * Returns the current editor document output as Markdown.
+     */
+    getMarkdown: () => string;
+    /**
+     * Returns the attributes of a given node type for all the nodes in the editor document.
+     */
+    getAllNodesAttributesByType: (nodeType: string) => ReturnType<typeof getAllNodesAttributesByType>;
+};
+/**
+ * The properties that describe the `beforeCreate` editor event.
+ */
+declare type BeforeCreateProps = EditorEvents['beforeCreate'];
+/**
+ * The properties that describe the `create` editor event.
+ */
+declare type CreateProps = EditorEvents['create'];
+/**
+ * The properties that describe the `update` editor event.
+ */
+declare type UpdateProps = EditorEvents['update'] & Pick<TypistEditorRef, 'getMarkdown'>;
+/**
+ * The properties that describe the `selectionUpdate` editor event.
+ */
+declare type SelectionUpdateProps = EditorEvents['selectionUpdate'];
+/**
+ * The properties that describe the `transaction` editor event.
+ */
+declare type TransacationProps = EditorEvents['transaction'];
+/**
+ * The properties that describe the `focus` editor event.
+ */
+declare type FocusProps = EditorEvents['focus'];
+/**
+ * The properties that describe the `blur` editor event.
+ */
+declare type BlurProps = EditorEvents['blur'];
+/**
+ * The properties that describe the `destroy` editor event.
+ */
+declare type DestroyProps = EditorEvents['destroy'];
+/**
+ * The properties available to represent an instance of the `TypistEditor` component, including
+ * the supported WAI-ARIA 1.1 attributes.
+ */
+declare type TypistEditorProps = {
+    /**
+     * Auto focus the editor to the end of the document on initialization.
+     */
+    autoFocus?: boolean;
+    /**
+     * The CSS class for the container surrounding the editor DOM element.
+     */
+    className?: string;
+    /**
+     * The initial Markdown content for the editor.
+     */
+    content?: string;
+    /**
+     * The initial content selection (only applied if `autoFocus` is `true`).
+     */
+    contentSelection?: Selection;
+    /**
+     * Determines if users can write into the editor.
+     */
+    editable?: boolean;
+    /**
+     * The list of required extensions to initialize the editor.
+     *
+     * You may consider wrapping this prop with `useMemo` to prevent unnecessary re-renders.
+     */
+    extensions: Extensions;
+    /**
+     * A short hint that gives users an idea what can be entered in the editor.
+     */
+    placeholder?: string;
+    /**
+     * The event handler that is fired before the editor view is created.
+     *
+     * You may consider wrapping this prop with `useCallback` to prevent unnecessary re-renders.
+     */
+    onBeforeCreate?: (props: BeforeCreateProps) => void;
+    /**
+     * The event handler that is fired when the editor view is ready.
+     *
+     * You may consider wrapping this prop with `useCallback` to prevent unnecessary re-renders.
+     */
+    onCreate?: (props: CreateProps) => void;
+    /**
+     * The event handler that is fired when the editor content has changed.
+     *
+     * You may consider wrapping this prop with `useCallback` to prevent unnecessary re-renders.
+     */
+    onUpdate?: (props: UpdateProps) => void;
+    /**
+     * The event handler that is fired when the editor selection has changed.
+     *
+     * You may consider wrapping this prop with `useCallback` to prevent unnecessary re-renders.
+     */
+    onSelectionUpdate?: (props: SelectionUpdateProps) => void;
+    /**
+     * The event handler that is fired when the editor state has changed.
+     *
+     * You may consider wrapping this prop with `useCallback` to prevent unnecessary re-renders.
+     */
+    onTransaction?: (props: TransacationProps) => void;
+    /**
+     * The event handler that is fired when the editor view gains focus.
+     *
+     * You may consider wrapping this prop with `useCallback` to prevent unnecessary re-renders.
+     */
+    onFocus?: (props: FocusProps) => void;
+    /**
+     * The event handler that is fired when the editor view loses focus.
+     *
+     * You may consider wrapping this prop with `useCallback` to prevent unnecessary re-renders.
+     */
+    onBlur?: (props: BlurProps) => void;
+    /**
+     * The event handler that is fired when the editor view is being destroyed.
+     *
+     * You may consider wrapping this prop with `useCallback` to prevent unnecessary re-renders.
+     */
+    onDestroy?: (props: DestroyProps) => void;
+    /**
+     * Identifies the element (or elements) that describes the object.
+     *
+     * @see aria-labelledby
+     */
+    'aria-describedby'?: React.AriaAttributes['aria-describedby'];
+    /**
+     * Defines a string value that labels the current element.
+     *
+     * @see aria-labelledby.
+     */
+    'aria-label'?: React.AriaAttributes['aria-label'];
+    /**
+     * Identifies the element (or elements) that labels the current element.
+     *
+     * @see aria-describedby.
+     */
+    'aria-labelledby'?: React.AriaAttributes['aria-labelledby'];
+    /**
+     * The event handler that processes `click` events in the editor.
+     */
+    onClick?: ViewEventHandlersOptions['onClick'];
+    /**
+     * The event handler that processes `keydown` events in the editor.
+     */
+    onKeyDown?: ViewEventHandlersOptions['onKeyDown'];
+};
+/**
+ * The `TypistEditor` component represents a plain-text or a rich-text editing control, built on
+ * top of the amazing [Tiptap](https://tiptap.dev/) library.
+ */
+declare const TypistEditor: import("react").ForwardRefExoticComponent<TypistEditorProps & import("react").RefAttributes<TypistEditorRef>>;
+export { TypistEditor };
+export type { BeforeCreateProps, BlurProps, CreateProps, DestroyProps, FocusProps, SelectionUpdateProps, TransacationProps, TypistEditorProps, TypistEditorRef, UpdateProps, };
+//# sourceMappingURL=typist-editor.d.ts.map

package/dist/components/typist-editor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typist-editor.d.ts","sourceRoot":"","sources":["../../src/components/typist-editor.tsx"],"names":[],"mappings":";AAQA,OAAO,EAAqB,wBAAwB,EAAE,MAAM,wCAAwC,CAAA;AAMpG,OAAO,EAAE,2BAA2B,EAA2B,MAAM,wBAAwB,CAAA;AAE7F,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAClF,OAAO,KAAK,EAAU,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAE1D;;;GAGG;AACH,aAAK,eAAe,GAAG;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,UAAU,CAAA;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,MAAM,CAAA;IAEzB;;OAEG;IACH,2BAA2B,EAAE,CACzB,QAAQ,EAAE,MAAM,KACf,UAAU,CAAC,OAAO,2BAA2B,CAAC,CAAA;CACtD,CAAA;AAED;;GAEG;AACH,aAAK,iBAAiB,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AAErD;;GAEG;AACH,aAAK,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;AAEzC;;GAEG;AACH,aAAK,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;AAEhF;;GAEG;AACH,aAAK,oBAAoB,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAA;AAE3D;;GAEG;AACH,aAAK,iBAAiB,GAAG,YAAY,CAAC,aAAa,CAAC,CAAA;AAEpD;;GAEG;AACH,aAAK,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;AAEvC;;GAEG;AACH,aAAK,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAA;AAErC;;GAEG;AACH,aAAK,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAA;AAE3C;;;GAGG;AACH,aAAK,iBAAiB,GAAG;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,SAAS,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,UAAU,EAAE,UAAU,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAEnD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IAEvC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IAEvC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAElD;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAA;IAErC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAA;IAEnC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAA;IAEzC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAA;IAE7D;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;IAEjD;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAA;IAE3D;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAA;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC,WAAW,CAAC,CAAA;CACpD,CAAA;AAED;;;GAGG;AACH,QAAA,MAAM,YAAY,+GA8MhB,CAAA;AAEF,OAAO,EAAE,YAAY,EAAE,CAAA;AAEvB,YAAY,EACR,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,WAAW,GACd,CAAA"}

package/dist/components/typist-editor.helper.d.ts

@@ -0,0 +1,22 @@
+import { Selection } from 'prosemirror-state';
+import type { Node as ProseMirrorNode } from 'prosemirror-model';
+/**
+ * Given a ProseMirror document, and a selection, resolves that selection within the bounds of the
+ * document size. This works similarly to the official `autoFocus` implementation.
+ */
+declare function resolveContentSelection(doc: ProseMirrorNode, selection: Selection): Selection;
+/**
+ * The return type for the node attributes, an object mapping attribute names to values.
+ */
+declare type NodeAttributes = {
+    [key: string]: unknown;
+};
+/**
+ * Given a ProseMirror document and a node type, returns the attributes of the given node type for
+ * all the nodes in the document. This is based on the official implementation for the
+ * `findChildren` helper function.
+ */
+declare function getAllNodesAttributesByType(doc: ProseMirrorNode, nodeType: string): Array<NodeAttributes>;
+export { getAllNodesAttributesByType, resolveContentSelection };
+export type { NodeAttributes };
+//# sourceMappingURL=typist-editor.helper.d.ts.map

package/dist/components/typist-editor.helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typist-editor.helper.d.ts","sourceRoot":"","sources":["../../src/components/typist-editor.helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAiB,MAAM,mBAAmB,CAAA;AAE5D,OAAO,KAAK,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEhE;;;GAGG;AACH,iBAAS,uBAAuB,CAAC,GAAG,EAAE,eAAe,EAAE,SAAS,EAAE,SAAS,GAAG,SAAS,CAStF;AAED;;GAEG;AACH,aAAK,cAAc,GAAG;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB,CAAA;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAChC,GAAG,EAAE,eAAe,EACpB,QAAQ,EAAE,MAAM,GACjB,KAAK,CAAC,cAAc,CAAC,CAUvB;AAED,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,CAAA;AAE/D,YAAY,EAAE,cAAc,EAAE,CAAA"}

package/dist/components/typist-editor.helper.js

@@ -0,0 +1,26 @@
+import { clamp } from 'lodash-es';
+import { Selection, TextSelection } from 'prosemirror-state';
+/**
+ * Given a ProseMirror document, and a selection, resolves that selection within the bounds of the
+ * document size. This works similarly to the official `autoFocus` implementation.
+ */
+function resolveContentSelection(doc, selection) {
+    const minPos = Selection.atStart(doc).from;
+    const maxPos = Selection.atEnd(doc).to;
+    return TextSelection.create(doc, clamp(selection.anchor, minPos, maxPos), clamp(selection.head, minPos, maxPos));
+}
+/**
+ * Given a ProseMirror document and a node type, returns the attributes of the given node type for
+ * all the nodes in the document. This is based on the official implementation for the
+ * `findChildren` helper function.
+ */
+function getAllNodesAttributesByType(doc, nodeType) {
+    const result = [];
+    doc.descendants((node) => {
+        if (node.type.name === nodeType) {
+            result.push(node.attrs);
+        }
+    });
+    return result;
+}
+export { getAllNodesAttributesByType, resolveContentSelection };