`@stesura/core/stores`

Per-editor nanostores atoms, the registry that finds them, and the global user preferences.

createEditorStores({ defaults, extensionStores }) builds one FullEditorStores per editor scope: atoms for the editor mode, TOC, pagination output (page counts, page numbering, the first-layout gate), stylesheet, list configs and block handle. extensionStores is spread into the result; type it by augmenting EditorStoreExtensions. The root editor’s configPlugin (part of basePlugins / stesuraPlugins) creates and registers them with addEditorStoresToMap when its view mounts and removes them on unmount, so integrators never call these; commands and plugins reach the stores through getEditorStores(idOrState) instead of taking a stores parameter. A sub-editor’s state falls through to its parent’s stores. In React, read and write them with useEditorStoreValue / useEditorStore from @stesura/editor-react.

userPreferences holds global atoms shared by every editor. Seed their defaults with initUserPreferences before the first mount.

Functions & values

`addEditorStoresToMap`

Parameters:

Name	Type	Default
`id`	`string`
`atoms`	`FullEditorStores`

Returns:

boolean

`addMountConfigToMap`

Parameters:

Name	Type	Default
`id`	`string`
`state`	`ConfigPluginState`

Returns:

boolean

`createEditorStores`

Parameters:

Name	Type	Default
`props`	`{ defaults: Partial<EditorStoreDefaults>; extensionStores: Record<string, PreinitializedWritableAtom<unknown>>; }`

Returns:

FullEditorStores

`disarmAll`

Parameters:

Name	Type	Default
`editorId`	`string`
`except`	`"formatPainter" \| "highlight"`

Returns:

void

`getEditorStores`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

FullEditorStores | undefined

`getFirstLayoutReady`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

boolean | null

`getFirstLayoutReadyAtom`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

WritableAtom<boolean | null> | undefined

`getMountConfig`

Parameters:

Name	Type	Default
`id`	`string`

Returns:

ConfigPluginState | undefined

`getNodePageNumbersStore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

Map<string, string> | undefined

`getPageCountsStore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

Map<string, number> | undefined

`getPageNumberingStore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

Map<string, PageNumberingAttrs> | undefined

`getProofReadApiFailedFor`

Parameters:

Name	Type	Default
`editorId`	`string`

Returns:

boolean

`getProofReadLoadingFor`

Parameters:

Name	Type	Default
`editorId`	`string`

Returns:

boolean

`getRootEditorView`

Parameters:

Name	Type	Default
`id`	`string`

Returns:

EditorView | undefined

`getTocBreaksStore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

Map<string, TOCbreakEntry[]> | undefined

`getTOCstore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

TOCstate | undefined

`headerFooterEditorRegistry`

Name	Type	Default
`atom`	`WritableAtom<ActiveSubEditor<HeaderFooterEditorKey>[]>`
`keyId`	`(key: HeaderFooterEditorKey) => string` Stable identity for a key within one main editor.
`register`	`(entry: ActiveSubEditor<HeaderFooterEditorKey>) => void`
`unregister`	`(mainEditorId: string, key: HeaderFooterEditorKey) => void`
`getAll`	`(mainEditorId: string) => ActiveSubEditor<HeaderFooterEditorKey>[]` Entries belonging to `mainEditorId` only.
`get`	`(mainEditorId: string, key: HeaderFooterEditorKey) => ActiveSubEditor<HeaderFooterEditorKey> \| undefined` The registered editor bound to `key` under `mainEditorId`, if mounted.

`initUserPreferences`

Parameters:

Name	Type	Default
`defaults`	`Partial<UserPreferences>`

Returns:

void

`proofReadApiFailedByEditor`

Name	Type	Default
`value`	`Record<string, boolean>`
`eqKey`	`<Key extends string>(oldValue: (Key extends string ? boolean : never) \| undefined, newValue: (Key extends string ? boolean : never) \| undefined, key: Key) => boolean` Compares the previous and next values for a key on `setKey`. Returning `true` means the values are the same, so the store keeps the old value and no listener is called. One function serves every key of the map, so the key name comes as the third argument. The old value is `undefined` when the key is not in the map yet.	`Object.is`
`listen`	`(listener: (value: Readonly<Record<string, boolean>>, oldValue: Readonly<Record<string, boolean>> \| undefined, changedKey: string \| undefined) => void) => () => void` Subscribe to store changes. In contrast with Store#subscribe it do not call listener immediately.
`notify`	`(oldValue?: Readonly<Record<string, boolean>> \| undefined, changedKey?: string \| undefined) => void` Low-level method to notify listeners about changes in the store. Can cause unexpected behaviour when combined with frontend frameworks that perform equality checks for values, such as React.
`set`	`(newValue: Record<string, boolean>) => void` Change store value. `$settings.set({ theme: 'dark' })` Operation is atomic, subscribers will be notified once with the new value. `changedKey` will be undefined
`setKey`	`<Key extends string>(key: Key, value: (Key extends string ? boolean : never) \| undefined) => void` Change key in store value. `$settings.setKey('theme', 'dark')` To delete key set `undefined`. `$settings.setKey('theme', undefined)`
`subscribe`	`(listener: (value: Readonly<Record<string, boolean>>, oldValue: Readonly<Record<string, boolean>> \| undefined, changedKey: string \| undefined) => void) => () => void` Subscribe to store changes and call listener immediately. `import { $router } from '../store' $router.subscribe(page => { console.log(page) })`
`eq`	`(oldValue: Readonly<Record<string, boolean>> \| undefined, newValue: Readonly<Record<string, boolean>>) => boolean` Compares the previous and next values on every `set`. Returning `true` means the values are the same, so the store keeps the old value and no listener is called.	`Object.is`
`get`	`() => Record<string, boolean>` Get store value. In contrast with ReadableAtom#value this value will be always initialized even if store had no listeners. `$store.get()`
`init`	`Record<string, boolean> \| undefined` Low-level attribute to read store’s initial value.
`lc`	`number` Listeners count.
`off`	`() => void` Unbind all listeners.

`proofReadLoadingByEditor`

Name	Type	Default
`value`	`Record<string, boolean>`
`eqKey`	`<Key extends string>(oldValue: (Key extends string ? boolean : never) \| undefined, newValue: (Key extends string ? boolean : never) \| undefined, key: Key) => boolean` Compares the previous and next values for a key on `setKey`. Returning `true` means the values are the same, so the store keeps the old value and no listener is called. One function serves every key of the map, so the key name comes as the third argument. The old value is `undefined` when the key is not in the map yet.	`Object.is`
`listen`	`(listener: (value: Readonly<Record<string, boolean>>, oldValue: Readonly<Record<string, boolean>> \| undefined, changedKey: string \| undefined) => void) => () => void` Subscribe to store changes. In contrast with Store#subscribe it do not call listener immediately.
`notify`	`(oldValue?: Readonly<Record<string, boolean>> \| undefined, changedKey?: string \| undefined) => void` Low-level method to notify listeners about changes in the store. Can cause unexpected behaviour when combined with frontend frameworks that perform equality checks for values, such as React.
`set`	`(newValue: Record<string, boolean>) => void` Change store value. `$settings.set({ theme: 'dark' })` Operation is atomic, subscribers will be notified once with the new value. `changedKey` will be undefined
`setKey`	`<Key extends string>(key: Key, value: (Key extends string ? boolean : never) \| undefined) => void` Change key in store value. `$settings.setKey('theme', 'dark')` To delete key set `undefined`. `$settings.setKey('theme', undefined)`
`subscribe`	`(listener: (value: Readonly<Record<string, boolean>>, oldValue: Readonly<Record<string, boolean>> \| undefined, changedKey: string \| undefined) => void) => () => void` Subscribe to store changes and call listener immediately. `import { $router } from '../store' $router.subscribe(page => { console.log(page) })`
`eq`	`(oldValue: Readonly<Record<string, boolean>> \| undefined, newValue: Readonly<Record<string, boolean>>) => boolean` Compares the previous and next values on every `set`. Returning `true` means the values are the same, so the store keeps the old value and no listener is called.	`Object.is`
`get`	`() => Record<string, boolean>` Get store value. In contrast with ReadableAtom#value this value will be always initialized even if store had no listeners. `$store.get()`
`init`	`Record<string, boolean> \| undefined` Low-level attribute to read store’s initial value.
`lc`	`number` Listeners count.
`off`	`() => void` Unbind all listeners.

`registerArmedMode`

Parameters:

Name	Type	Default
`editorId`	`string`
`key`	`"formatPainter" \| "highlight"`
`disarm`	`() => void`

Returns:

() => void

`registerRootEditorView`

Parameters:

Name	Type	Default
`id`	`string`
`view`	`EditorView`

Returns:

void

`registryVersion`

Name	Type	Default
`value`	`number` Low-level method to read store’s value without calling `onStart`. Try to use only ReadableAtom#get . Without subscribers, value can be undefined.
`set`	`(newValue: number) => void` Change store value. `$router.set({ path: location.pathname, page: parse(location.pathname) })`
`eq`	`(oldValue: number \| undefined, newValue: number) => boolean` Compares the previous and next values on every `set`. Returning `true` means the values are the same, so the store keeps the old value and no listener is called.	`Object.is`
`get`	`() => number` Get store value. In contrast with ReadableAtom#value this value will be always initialized even if store had no listeners. `$store.get()`
`init`	`number \| undefined` Low-level attribute to read store’s initial value.
`lc`	`number` Listeners count.
`listen`	`(listener: (value: number, oldValue: number \| undefined) => void) => () => void` Subscribe to store changes. In contrast with Store#subscribe it do not call listener immediately.
`notify`	`(oldValue?: number \| undefined) => void` Low-level method to notify listeners about changes in the store. Can cause unexpected behaviour when combined with frontend frameworks that perform equality checks for values, such as React.
`off`	`() => void` Unbind all listeners.
`subscribe`	`(listener: (value: number, oldValue?: number \| undefined) => void) => () => void` Subscribe to store changes and call listener immediately. `import { $router } from '../store' $router.subscribe(page => { console.log(page) })`

`removeEditorStoresFromMap`

Parameters:

Name	Type	Default
`id`	`string`

Returns:

void

`removeMountConfigFromMap`

Parameters:

Name	Type	Default
`id`	`string`

Returns:

void

`resolveEditorId`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`

Returns:

string | undefined

`setFirstLayoutReady`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`
`ready`	`boolean`

Returns:

void

`setNodePageNumbersStore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`
`pageNumbers`	`Map<string, string>`

Returns:

void

`setPageCountsStore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`
`pageCounts`	`Map<string, number>`

Returns:

void

`setPageNumberingStore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`
`pageNumbering`	`Map<string, PageNumberingAttrs>`

Returns:

void

`setProofReadApiFailedFor`

Parameters:

Name	Type	Default
`editorId`	`string`
`value`	`boolean`

Returns:

void

`setProofReadLoadingFor`

Parameters:

Name	Type	Default
`editorId`	`string`
`value`	`boolean`

Returns:

void

`setTocBreaksStore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`
`breaks`	`Map<string, TOCbreakEntry[]>`

Returns:

void

`setTOCstore`

Parameters:

Name	Type	Default
`idOrState`	`string \| EditorState`
`toc`	`TOCstate`

Returns:

void

`unregisterRootEditorView`

Parameters:

Name	Type	Default
`id`	`string`

Returns:

void

`userPreferences`

Name	Type	Default
`showOutline`	`PreinitializedWritableAtom<boolean> & object`
`showRuler`	`PreinitializedWritableAtom<boolean> & object`
`zoomLevel`	`PreinitializedWritableAtom<number> & object`
`trackChanges`	`PreinitializedWritableAtom<{ show: boolean; enabled: boolean; }> & object`
`showComments`	`PreinitializedWritableAtom<CommentDisplayMode> & object`
`displayUnits`	`PreinitializedWritableAtom<DisplayUnits> & object`
`proofReadEnabled`	`PreinitializedWritableAtom<boolean> & object`
`proofReadLoading`	`PreinitializedWritableAtom<boolean> & object`
`proofReadApiFailed`	`PreinitializedWritableAtom<boolean> & object`

Types

`HeaderFooterEditorKey`

Name	Type	Default
`sectionId`	`string`
`target`	`"header" \| "footer"`
`variant`	`HeaderFooterVariant`

Other exports

Export	Type	Description
`ARMED_MODE_KEYS`	`readonly ["formatPainter", "highlight"]`	The modes that can be armed. `ArmedModeKey` is its element type.
`ArmedModeKey`	`"formatPainter" \| "highlight"`
`UserPreferenceKey`	`"showOutline" \| "showRuler" \| "showComments" \| "displayUnits" \| "proofReadEnabled" \| "zoomLevel" \| "trackChanges" \| "proofReadLoading" \| "proofReadApiFailed"`