@remnote/plugin-sdk

Enumerations

• BuiltInPowerupCodes
• CheckboxMatcher
• ComponentFocusableItemType
• DateMatcher
• EmbedComponentType
• FocusPropsType
• MoveUnit
• MultiSelectMatcher
• NumberMatcher
• PORTAL_TYPE
• PageType
• PluginCommandMenuLocation
• PropertyLocation
• PropertyType
• QueryExpressionType
• QueryNodeType
• QueueInteractionScore
• QueueItemType
• REM_TYPE
• RelativeDateMatcher
• RelativeDateModifier
• RelativeDatePeriod
• RemColor
• RemType
• RemTypeTinyGraph
• SelectSourceType
• SelectionType
• SetRemType
• SingleSelectMatcher
• SpecialPluginCallback
• TextMatcher
• WidgetLocation

Component Classes

• LoadingSpinner
• PreviewRemCards
• Queue
• RemHierarchyEditorTree
• RemRichTextEditor
• RemViewer
• RichText
• RichTextEditor

Other Classes

• AppNamespace
• Card
• CardNamespace
• DateNamespace
• DocumentViewer
• EditorNamespace
• EventNamespace
• FocusNamespace
• KnowledgeBaseNamespace
• MessagingNamespace
• PDFWebReader
• PowerupNamespace
• Query
• QueueNamespace
• RNPlugin
• ReaderNamespace
• Rem
• RemNamespace
• RichTextNamespace
• SchedulerNamespace
• SearchNamespace
• SettingsNamespace
• StorageNamespace
• WidgetNamespace
• WindowNamespace

Component Interfaces

• QueueProps

Other Interfaces

• CardData
• Command
• CommandArgs
• ComponentDimensionsProps
• ComponentFocusableItem
• CreateFakeEmbedComponentArgs
• FocusContext
• FocusPropsSelectRangeType
• FocusPropsTextType
• LegacySearchPortalSingleSelectQueryExpression
• LoadingSpinnerProps
• MosaicParent
• PDFWebReaderProps
• PluginDocumentViewProps
• PluginDropdownSetting
• PluginMenuItem
• PluginNumberSetting
• PluginQueueCardData
• PluginSettingBase
• PluginStringSetting
• PreviewRemCardsProps
• ReaderSelection
• RemData
• RemHierarchyEditorTreeProps
• RemRichTextEditorProps
• RemSelection
• RemViewerProps
• RepetitionStatus
• RichTextEditorProps
• RichTextProps
• SearchPortalCheckboxQueryExpression
• SearchPortalDateQueryExpression
• SearchPortalGroupQueryNode
• SearchPortalMultiSelectQueryExpression
• SearchPortalNumberQueryExpression
• SearchPortalRefQueryExpression
• SearchPortalRemTypeQueryExpression
• SearchPortalSingleSelectQueryExpression
• SearchPortalSlotQueryNode
• SearchPortalTextQueryExpression
• SearchPortalUnaryQueryNode
• SimpleCommand
• SlashCommand
• SpecialPluginCallbackInfo
• SubscriptionInfo
• TextSelection
• WidgetLocationContextDataMap
• WidgetOptions

Type Aliases

AppEventListerKey

Ƭ AppEventListerKey: string | undefined

---

CallbackFn

Ƭ CallbackFn: (context: Record<string, any>) => unknown | Promise<unknown>

Type declaration

▸ (context): unknown | Promise<unknown>

Parameters

Name	Type
context	Record<string, any>

Returns

unknown | Promise<unknown>

---

CardType

Ƭ CardType: "forward" | "backward" | { clozeId: string }

---

ComponentFocusId

Ƭ ComponentFocusId: ComponentFocusableItem[]

---

EditorRange

Ƭ EditorRange: Object

Type declaration

Name	Type
end	number
start	number

---

EventCallbackFn

Ƭ EventCallbackFn: (event: any) => void

Type declaration

▸ (event): void

Parameters

Name	Type
event	any

Returns

void

---

FocusElementProps

Ƭ FocusElementProps: Partial<FocusPropsTextType> | Partial<FocusPropsSelectRangeType> | undefined

---

KnowledgeBaseId

Ƭ KnowledgeBaseId: string | null

---

MosaicDirection

Ƭ MosaicDirection: "row" | "column"

---

MosaicNode

Ƭ MosaicNode<T>: MosaicParent<T> | T

Type parameters

Name
T

---

NumberValidatorArray

Ƭ NumberValidatorArray: z.TypeOf<typeof numberValidatorSig>[]

---

OperatingSystem

Ƭ OperatingSystem: "mac" | "windows" | "linux" | "ios" | "android"

---

PaneIdWindowTree

Ƭ PaneIdWindowTree: MosaicNode<string>

---

PaneRem

Ƭ PaneRem: Object

Type declaration

Name	Type
paneId	string
remId	string

---

PaneRemWindowTree

Ƭ PaneRemWindowTree: PaneRem | MosaicParent<PaneRem>

---

PaneTree

Ƭ PaneTree: MosaicParent<string>

---

Platform

Ƭ Platform: "app" | "web"

---

PluginAccessKnowledgeBaseInfoScope

Ƭ PluginAccessKnowledgeBaseInfoScope: z.TypeOf<typeof PluginAccessKnowledgeBaseInfoScopeSig>

---

PluginId

Ƭ PluginId: string

---

PluginManifest

Ƭ PluginManifest: z.TypeOf<typeof PluginManifestV1Sig>

---

PluginSchedulerParameter

Ƭ PluginSchedulerParameter: PluginNumberSetting & { type: "number" } | PluginStringSetting & { type: "string" } | PluginDropdownSetting & { type: "dropdown" } | PluginSettingBase<boolean> & { type: "boolean" }

---

PluginSchedulerParameterWithValue

Ƭ PluginSchedulerParameterWithValue: PluginNumberSetting & { type: "number" ; value: number | undefined } | PluginStringSetting & { type: "string" ; value: string | undefined } | PluginDropdownSetting & { type: "dropdown" ; value: string | undefined } | PluginSettingBase<boolean> & { type: "boolean" ; value: boolean | undefined }

---

PowerupCode

Ƭ PowerupCode: string

---

PowerupSlotCode

Ƭ PowerupSlotCode: string

---

PowerupSlotCodeMap

Ƭ PowerupSlotCodeMap: typeof PowerupSlotCodeMap

---

QueryRemType

Ƭ QueryRemType: "concept" | "descriptor" | "none"

---

RICH_TEXT_FORMATTING_KEYS

Ƭ RICH_TEXT_FORMATTING_KEYS: keyof typeof RICH_TEXT_FORMATTING

---

RICH_TEXT_FORMATTING_VALUES

Ƭ RICH_TEXT_FORMATTING_VALUES: typeof RICH_TEXT_FORMATTING[RICH_TEXT_FORMATTING_KEYS]

---

RegisterPowerupOptions

Ƭ RegisterPowerupOptions: z.infer<typeof RegisterPowerupOptions>

---

RemId

Ƭ RemId: string

---

RemIdWindowTree

Ƭ RemIdWindowTree: MosaicNode<string>

---

RichTextAddIconInterface

Ƭ RichTextAddIconInterface: Object

Type declaration

Name	Type
i	"ai"
size?	string

---

RichTextAnnotationInterface

Ƭ RichTextAnnotationInterface: Object

Type declaration

Name	Type
highlighterSerialization	{ text: string }
highlighterSerialization.text	string
i	"n"
text	string
url	string

---

RichTextAudioInterface

Ƭ RichTextAudioInterface: Object

Type declaration

Name	Type
height?	number
i	"a"
onlyAudio?	boolean
percent?	25 | 50 | 100
url	string
width?	number

---

RichTextCardDelimiterInterface

Ƭ RichTextCardDelimiterInterface: Object

Type declaration

Name	Type
delimiterCharacterForSerialization?	string
i	"s"

---

RichTextElementInterface

Ƭ RichTextElementInterface: RichTextElementItemInterface | string & { i?: undefined }

---

RichTextElementItemInterface

Ƭ RichTextElementItemInterface: RichTextElementTextInterface | RichTextElementRemInterface | RichTextImageInterface | RichTextAudioInterface | RichTextPluginInterface | RichTextGlobalNameInterface | RichTextLatexInterface | RichTextCardDelimiterInterface | RichTextAnnotationInterface | RichTextFlashcardIconInterface | RichTextAddIconInterface

---

RichTextElementRemInterface

Ƭ RichTextElementRemInterface: Object

Type declaration

Name	Type
_id	RemId
aliasId?	RemId
content?	boolean
i	"q"
pin?	boolean
showFullName?	boolean
textOfDeletedRem?	RichTextInterface

---

RichTextElementTextInterface

Ƭ RichTextElementTextInterface: Object

Type declaration

Name	Type
b?	boolean
block?	boolean
cId?	string
code?	boolean
h?	number | string
hiddenCloze?	boolean
i	"m"
l?	boolean
language?	string
q?	boolean
qId?	string
revealedCloze?	boolean
tc?	number | string
text	string
title?	string
u?	boolean
url?	string
workInProgressPortal?	boolean
workInProgressRem?	boolean
workInProgressTag?	boolean

---

RichTextFlashcardIconInterface

Ƭ RichTextFlashcardIconInterface: Object

Type declaration

Name	Type
i	"fi"
size?	string

---

RichTextFormatName

Ƭ RichTextFormatName: keyof typeof richTextFormatNameCodeMap | keyof Omit<typeof RemColor, "undefined"> | "cloze"

---

RichTextFormattingTypeInterface

Ƭ RichTextFormattingTypeInterface: "cId" | "u" | "b" | "l" | "qId" | "q" | "hiddenCloze" | "revealedCloze" | "h" | "url" | "code" | "c" | "language"

---

RichTextGlobalNameInterface

Ƭ RichTextGlobalNameInterface: Object

Type declaration

Name	Type
_id	string | null
i	"g"

---

RichTextImageClozeBlockInterface

Ƭ RichTextImageClozeBlockInterface: Object

Type declaration

Name	Type
cId	string
detectedText?	string
frontLabel?	RichTextInterface | string
height	number
label?	RichTextInterface | string
linkedRemId?	RemId | string
primary?	boolean
rotation	number
width	number
x	number
y	number

---

RichTextImageInterface

Ƭ RichTextImageInterface: Object

Type declaration

Name	Type
blocks?	RichTextImageClozeBlockInterface[]
clozeOrder?	ClozeIdentifier[]
frontLabel?	RichTextInterface
height?	number
i	"i"
imgId?	string
label?	RichTextInterface
loading?	boolean
openOcclusionPopup?	boolean
percent?	25 | 50 | 100
practiceInOrder?	boolean
title?	string
transparent?	boolean
url	string
width?	number

---

RichTextInterface

Ƭ RichTextInterface: RichTextElementInterface[]

---

RichTextLatexInterface

Ƭ RichTextLatexInterface: Object

Type declaration

Name	Type
block?	boolean
cId?	string
i	"x"
latexClozes?	string[]
text	string

---

RichTextPluginInterface

Ƭ RichTextPluginInterface: Object

Type declaration

Name	Type
i	"p"
pluginName?	string
url	string

---

RichTextStoreHighlightColor

Ƭ RichTextStoreHighlightColor: string

---

SRSScheduleCardParams

Ƭ SRSScheduleCardParams: Parameters<SpecialPluginCallbackInfo[SRSScheduleCard]>[0]

---

SRSScheduleCardResult

Ƭ SRSScheduleCardResult: Awaited<ReturnType<SpecialPluginCallbackInfo[SRSScheduleCard]>>

---

SearchPortalQuery

Ƭ SearchPortalQuery: SearchPortalUnaryQueryNode | SearchPortalGroupQueryNode | SearchPortalSlotQueryNode | SearchPortalQueryExpression

---

SearchPortalQueryExpression

Ƭ SearchPortalQueryExpression: SearchPortalRefQueryExpression | SearchPortalTextQueryExpression | SearchPortalNumberQueryExpression | SearchPortalRemTypeQueryExpression | SearchPortalDateQueryExpression | SearchPortalMultiSelectQueryExpression | SearchPortalSingleSelectQueryExpression | LegacySearchPortalSingleSelectQueryExpression | SearchPortalCheckboxQueryExpression | SearchPortalDateQueryExpression

---

SlotCodesForPowerup

Ƭ SlotCodesForPowerup<PowerupCode>: keyof PowerupSlotCodeMap[PowerupCode]

Type parameters

Name	Type
PowerupCode	extends BuiltInPowerupCodes

---

StringValidatorArray

Ƭ StringValidatorArray: z.TypeOf<typeof stringValidatorSig>[]

---

Version

Ƭ Version: z.TypeOf<typeof VersionSig>

Variables

AppEvents

• Const AppEvents: Object

Type declaration

Name	Type
ClickRemReference	string
ClickSidebarItem	string
CurrentWindowTreeChange	string
EditorSelectionChanged	string
EditorTextEdited	string
FakeEmbedComponentDimensionChange	string
FakeEmbedDOMEvent	string
FocusedPaneChange	string
FocusedPortalChange	string
FocusedRemChange	string
GlobalOpenRem	"global.open-rem"
GlobalRemChanged	string
MessageBroadcast	string
MouseOutLink	string
MouseOverLink	string
PowerupSlotChanged	string
QueueCompleteCard	"queue.complete-card"
QueueEnter	"queue.enter"
QueueExit	"queue.exit"
QueueLoadCard	"queue.load-card"
RemChanged	string
RevealAnswer	"queue.reveal-answer"
SettingChanged	string
StealKeyEvent	string
StorageLocalChange	string
StorageSessionChange	string
StorageSyncedChange	string
URLChange	"global.url-change"
onActivate	"onActivate"
onDeactivate	"onDeactivate"
setCustomCSS	"setCustomCSS"
setDarkMode	"setDarkMode"

---

DEPRECATED_RICH_TEXT_ELEMENT_TYPES

• Const DEPRECATED_RICH_TEXT_ELEMENT_TYPES: Object

Type declaration

Name	Type
BOLD	string
CLOZE	string
DATE	string
HIDDEN_CLOZE	string
HIGHLIGHT	string
INLINE_CODE	string
ITALIC	string
LINK	string
UNDERLINE	string

---

DEPRECATED_RICH_TEXT_ELEMENT_TYPES_TO_NEW_FORMATTING

• Const DEPRECATED_RICH_TEXT_ELEMENT_TYPES_TO_NEW_FORMATTING: Object

---

DEPRECATED_RICH_TEXT_FORMATTING_TYPES

• Const DEPRECATED_RICH_TEXT_FORMATTING_TYPES: Object

Type declaration

Name	Type
LATEX	string

---

DateMatcherTypesToDisplayValue

• Const DateMatcherTypesToDisplayValue: Record<DateMatcher, string>

---

EditorEvents

• Const EditorEvents: Object

Type declaration

Name	Type
EditorSelectionChanged	string
EditorTextEdited	string

---

FocusEvents

• Const FocusEvents: Object

Type declaration

Name	Type
FocusedPortalChange	string
FocusedRemChange	string

---

GlobalEvent

• Const GlobalEvent: Object

Type declaration

Name	Type
GlobalOpenRem	"global.open-rem"
URLChange	"global.url-change"

---

LegacySearchPortalSingleSelectQueryExpression

• LegacySearchPortalSingleSelectQueryExpression: ZodType<LegacySearchPortalSingleSelectQueryExpression, ZodTypeDef, LegacySearchPortalSingleSelectQueryExpression>

---

MessagingEvents

• Const MessagingEvents: Object

Type declaration

Name	Type
MessageBroadcast	string

---

MultiSelectMatcherTypesToDisplayValue

• Const MultiSelectMatcherTypesToDisplayValue: Record<MultiSelectMatcher, string>

---

NonRelativeMatcherTypes

• Const NonRelativeMatcherTypes: DateMatcher[]

---

NumberMatcherTypesToDisplayValue

• Const NumberMatcherTypesToDisplayValue: Record<NumberMatcher, string>

---

PowerupEvent

• Const PowerupEvent: Object

Type declaration

Name	Type
ClickRemReference	string
MouseOutLink	string
MouseOverLink	string
PowerupSlotChanged	string

---

PowerupSlotCodeMap

• Const PowerupSlotCodeMap: Object

Type declaration

Name	Type
a	{ SortDirection: string = 'd' }
a.SortDirection	string
at	{ Templates: string = 't' }
at.Templates	string
b	{ FileURL: string = 'f'; LastReadDate: string = 'd'; ReadPercent: string = 'r'; Title: string = 't'; URL: string = 'u' }
b.FileURL	string
b.LastReadDate	string
b.ReadPercent	string
b.Title	string
b.URL	string
c	{}
cd	{ DontBoundHeight: string = 'b'; DontWrap: string = 'w'; Language: string = 'l' }
cd.DontBoundHeight	string
cd.DontWrap	string
cd.Language	string
ct	{ Template: string = 't' }
ct.Template	string
d	{ Date: string = 'd'; Timestamp: string = 's' }
d.Date	string
d.Timestamp	string
de	{ ExamSchedulerCollection: string = 'emcd'; ExamSchedulerDate: string = 'e'; ExamSchedulerDesiredStability: string = 'eds'; ExamSchedulerMaxNewCardsPerDay: string = 'emnc'; ExamSchedulerMaxTotalCardsPerDay: string = 'emtc'; MaxNewCardsPerDay: string = 'm'; MaxTotalCardsPerDay: string = 'c'; Status: string = 's'; Topics: string = 't' }
de.ExamSchedulerCollection	string
de.ExamSchedulerDate	string
de.ExamSchedulerDesiredStability	string
de.ExamSchedulerMaxNewCardsPerDay	string
de.ExamSchedulerMaxTotalCardsPerDay	string
de.MaxNewCardsPerDay	string
de.MaxTotalCardsPerDay	string
de.Status	string
de.Topics	string
dv	{}
e	{ Message: string = 'm' }
e.Message	string
f	{ Authors: string = 'a'; HasNoTextLayer: string = 'tl'; Keywords: string = 'k'; LastReadDate: string = 'd'; Name: string = 'n'; ReadPercent: string = 'r'; Theme: string = 'h'; Title: string = 'i'; Type: string = 't'; URL: string = 'u'; ViewerData: string = 'v' }
f.Authors	string
f.HasNoTextLayer	string
f.Keywords	string
f.LastReadDate	string
f.Name	string
f.ReadPercent	string
f.Theme	string
f.Title	string
f.Type	string
f.URL	string
f.ViewerData	string
g	{ AutoActivate: string = 'a'; CollapseConfigure: string = 'c'; Pinned: string = 'p'; PrimaryColumnName: string = 'n' }
g.AutoActivate	string
g.CollapseConfigure	string
g.Pinned	string
g.PrimaryColumnName	string
h	{ Color: string = 'c' }
h.Color	string
ha	{}
hh	{ Data: string = 'd'; HTMLId: string = 'h' }
hh.Data	string
hh.HTMLId	string
i	{}
id	{}
j	{}
k	{}
l	{ Aliases: string = 'a' }
l.Aliases	string
m	{}
n	{ Data: string = 'd'; PdfId: string = 'p' }
n.Data	string
n.PdfId	string
o	{ DeprecatedSource: string = 'o'; Status: string = 's' }
o.DeprecatedSource	string
o.Status	string
os	{ Sources: string = 'os' }
os.Sources	string
p	{ Data: string = 'd'; Url: string = 'w' }
p.Data	string
p.Url	string
pn	{}
q	{}
qt	{}
r	{ Size: string = 's' }
r.Size	string
rt	{ Date: string = 'd' }
rt.Date	string
s	{}
sd	{}
sp	{ AutomaticBacklinkSearchPortalFor: string = 'b'; DontIncludeNestedDescendants: string = 's'; Filter: string = 'f'; Query: string = 'q' }
sp.AutomaticBacklinkSearchPortalFor	string
sp.DontIncludeNestedDescendants	string
sp.Filter	string
sp.Query	string
t	{ Status: string = 's' }
t.Status	string
ty	{}
u	{}
w	{}
x	{}
y	{ ExtraSlotsOnBackOfCard: string = 'b'; ExtraSlotsOnFrontOfCard: string = 'f'; SelectTag: string = 't' }
y.ExtraSlotsOnBackOfCard	string
y.ExtraSlotsOnFrontOfCard	string
y.SelectTag	string
z	{ Hostname: string = 'u' }
z.Hostname	string

---

QueryRemType

• QueryRemType: ZodType<QueryRemType, ZodTypeDef, QueryRemType>

---

QueueEvent

• Const QueueEvent: Object

Type declaration

Name	Type
QueueCompleteCard	"queue.complete-card"
QueueEnter	"queue.enter"
QueueExit	"queue.exit"
QueueLoadCard	"queue.load-card"
RevealAnswer	"queue.reveal-answer"

---

QueueItemTypeHumanReadable

• Const QueueItemTypeHumanReadable: Object

Type declaration

Name	Type
1	string
10	string
11	string
12	string
13	string
14	string
15	string
16	string
17	string
18	string
19	string
2	string
20	string
21	string
3	string
4	string
5	string
6	string
7	string
8	string

---

RICH_TEXT_ELEMENT_TYPE

• Const RICH_TEXT_ELEMENT_TYPE: Object

Type declaration

Name	Type
ADD_ICON	"ai"
ANNOTATION	"n"
AUDIO	"a"
CARD_DELIMITER	"s"
DEPRECATED_CODE	"o"
DRAWING	"r"
FLASHCARD_ICON	"fi"
GLOBAL_NAME	"g"
IMAGE	"i"
LATEX	"x"
PLUGIN	"p"
REM	"q"
TEXT	"m"

---

RICH_TEXT_FORMATTING

• Const RICH_TEXT_FORMATTING: Object

Type declaration

Name	Type
BOLD	"b"
CLOZE	"cId"
CODE	"code"
CODE_LANGUAGE	"language"
COMMENT_ID	"c"
DEPRECATED_LINK	"url"
HIDDEN_CLOZE	"hiddenCloze"
HIGHLIGHT	"h"
INLINE_CODE	"q"
INLINE_LINK	"qId"
ITALIC	"l"
QUOTE	"qt"
REVEALED_CLOZE	"revealedCloze"
TEXT_COLOR	"tc"
UNDERLINE	"u"

---

RegisterPowerupOptions

• Const RegisterPowerupOptions: ZodUnion<[ZodObject<{ slots: ZodArray<ZodObject<{ code: ZodString ; defaultEnumValue: ZodOptional<ZodString> ; dontPublishToSharedArticle: ZodOptional<ZodBoolean> ; enumValues: ZodOptional<ZodRecord<ZodString, ZodString>> ; hidden: ZodOptional<ZodBoolean> ; name: ZodString ; onlyProgrammaticModifying: ZodOptional<ZodBoolean> ; propertyLocation: ZodOptional<ZodNativeEnum<typeof PropertyLocation>> ; propertyType: ZodOptional<ZodNativeEnum<typeof PropertyType>> ; selectSourceType: ZodOptional<ZodNativeEnum<typeof SelectSourceType>> }, "strip", ZodTypeAny, { code: string ; defaultEnumValue: undefined | string ; dontPublishToSharedArticle: undefined | boolean ; enumValues: undefined | Record<string, string> ; hidden: undefined | boolean ; name: string ; onlyProgrammaticModifying: undefined | boolean ; propertyLocation: undefined | RIGHT | BELOW | ONLY_DOCUMENT | ONLY_IN_TABLE | INLINE ; propertyType: undefined | IMPLICIT_TEXT | TITLE | NUMBER | TEXT | CHECKBOX | DATE | MULTI_SELECT | SINGLE_SELECT | CREATED_AT | LAST_UPDATED | IMAGE | URL | DEFINITION ; selectSourceType: undefined | Enum | AnyRem | Relation }, { code: string ; defaultEnumValue: undefined | string ; dontPublishToSharedArticle: undefined | boolean ; enumValues: undefined | Record<string, string> ; hidden: undefined | boolean ; name: string ; onlyProgrammaticModifying: undefined | boolean ; propertyLocation: undefined | RIGHT | BELOW | ONLY_DOCUMENT | ONLY_IN_TABLE | INLINE ; propertyType: undefined | IMPLICIT_TEXT | TITLE | NUMBER | TEXT | CHECKBOX | DATE | MULTI_SELECT | SINGLE_SELECT | CREATED_AT | LAST_UPDATED | IMAGE | URL | DEFINITION ; selectSourceType: undefined | Enum | AnyRem | Relation }>, "many"> }, "strip", ZodTypeAny, { slots: { code: string; name: string; onlyProgrammaticModifying?: boolean | undefined; hidden?: boolean | undefined; enumValues?: Record<string, string> | undefined; defaultEnumValue?: string | undefined; propertyType?: PropertyType | undefined; propertyLocation?: PropertyLocation | undefined; selectSourceType?: SelectSourc...[] }, { slots: { code: string; name: string; onlyProgrammaticModifying?: boolean | undefined; hidden?: boolean | undefined; enumValues?: Record<string, string> | undefined; defaultEnumValue?: string | undefined; propertyType?: PropertyType | undefined; propertyLocation?: PropertyLocation | undefined; selectSourceType?: SelectSourc...[] }>, ZodObject<{ properties: ZodArray<ZodObject<{ code: ZodString ; defaultEnumValue: ZodOptional<ZodString> ; dontPublishToSharedArticle: ZodOptional<ZodBoolean> ; enumValues: ZodOptional<ZodRecord<ZodString, ZodString>> ; hidden: ZodOptional<ZodBoolean> ; name: ZodString ; onlyProgrammaticModifying: ZodOptional<ZodBoolean> ; propertyLocation: ZodOptional<ZodNativeEnum<typeof PropertyLocation>> ; propertyType: ZodOptional<ZodNativeEnum<typeof PropertyType>> ; selectSourceType: ZodOptional<ZodNativeEnum<typeof SelectSourceType>> }, "strip", ZodTypeAny, { code: string ; defaultEnumValue: undefined | string ; dontPublishToSharedArticle: undefined | boolean ; enumValues: undefined | Record<string, string> ; hidden: undefined | boolean ; name: string ; onlyProgrammaticModifying: undefined | boolean ; propertyLocation: undefined | RIGHT | BELOW | ONLY_DOCUMENT | ONLY_IN_TABLE | INLINE ; propertyType: undefined | IMPLICIT_TEXT | TITLE | NUMBER | TEXT | CHECKBOX | DATE | MULTI_SELECT | SINGLE_SELECT | CREATED_AT | LAST_UPDATED | IMAGE | URL | DEFINITION ; selectSourceType: undefined | Enum | AnyRem | Relation }, { code: string ; defaultEnumValue: undefined | string ; dontPublishToSharedArticle: undefined | boolean ; enumValues: undefined | Record<string, string> ; hidden: undefined | boolean ; name: string ; onlyProgrammaticModifying: undefined | boolean ; propertyLocation: undefined | RIGHT | BELOW | ONLY_DOCUMENT | ONLY_IN_TABLE | INLINE ; propertyType: undefined | IMPLICIT_TEXT | TITLE | NUMBER | TEXT | CHECKBOX | DATE | MULTI_SELECT | SINGLE_SELECT | CREATED_AT | LAST_UPDATED | IMAGE | URL | DEFINITION ; selectSourceType: undefined | Enum | AnyRem | Relation }>, "many"> }, "strip", ZodTypeAny, { properties: { code: string; name: string; onlyProgrammaticModifying?: boolean | undefined; hidden?: boolean | undefined; enumValues?: Record<string, string> | undefined; defaultEnumValue?: string | undefined; propertyType?: PropertyType | undefined; propertyLocation?: PropertyLocation | undefined; selectSourceType?: SelectSourc...[] }, { properties: { code: string; name: string; onlyProgrammaticModifying?: boolean | undefined; hidden?: boolean | undefined; enumValues?: Record<string, string> | undefined; defaultEnumValue?: string | undefined; propertyType?: PropertyType | undefined; propertyLocation?: PropertyLocation | undefined; selectSourceType?: SelectSourc...[] }>]>

---

RegisterPropertyOptions

• Const RegisterPropertyOptions: ZodObject<{ code: ZodString ; defaultEnumValue: ZodOptional<ZodString> ; dontPublishToSharedArticle: ZodOptional<ZodBoolean> ; enumValues: ZodOptional<ZodRecord<ZodString, ZodString>> ; hidden: ZodOptional<ZodBoolean> ; name: ZodString ; onlyProgrammaticModifying: ZodOptional<ZodBoolean> ; propertyLocation: ZodOptional<ZodNativeEnum<typeof PropertyLocation>> ; propertyType: ZodOptional<ZodNativeEnum<typeof PropertyType>> ; selectSourceType: ZodOptional<ZodNativeEnum<typeof SelectSourceType>> }, "strip", ZodTypeAny, { code: string ; defaultEnumValue: undefined | string ; dontPublishToSharedArticle: undefined | boolean ; enumValues: undefined | Record<string, string> ; hidden: undefined | boolean ; name: string ; onlyProgrammaticModifying: undefined | boolean ; propertyLocation: undefined | RIGHT | BELOW | ONLY_DOCUMENT | ONLY_IN_TABLE | INLINE ; propertyType: undefined | IMPLICIT_TEXT | TITLE | NUMBER | TEXT | CHECKBOX | DATE | MULTI_SELECT | SINGLE_SELECT | CREATED_AT | LAST_UPDATED | IMAGE | URL | DEFINITION ; selectSourceType: undefined | Enum | AnyRem | Relation }, { code: string ; defaultEnumValue: undefined | string ; dontPublishToSharedArticle: undefined | boolean ; enumValues: undefined | Record<string, string> ; hidden: undefined | boolean ; name: string ; onlyProgrammaticModifying: undefined | boolean ; propertyLocation: undefined | RIGHT | BELOW | ONLY_DOCUMENT | ONLY_IN_TABLE | INLINE ; propertyType: undefined | IMPLICIT_TEXT | TITLE | NUMBER | TEXT | CHECKBOX | DATE | MULTI_SELECT | SINGLE_SELECT | CREATED_AT | LAST_UPDATED | IMAGE | URL | DEFINITION ; selectSourceType: undefined | Enum | AnyRem | Relation }>

---

RelativeDateMatcherToLabel

• Const RelativeDateMatcherToLabel: Record<RelativeDateMatcher, string>

---

RemEvent

• Const RemEvent: Object

Type declaration

Name	Type
GlobalRemChanged	string
RemChanged	string

---

SearchPortalCheckboxQueryExpression

• SearchPortalCheckboxQueryExpression: ZodType<SearchPortalCheckboxQueryExpression, ZodTypeDef, SearchPortalCheckboxQueryExpression>

---

SearchPortalDateQueryExpression

• SearchPortalDateQueryExpression: ZodType<SearchPortalDateQueryExpression, ZodTypeDef, SearchPortalDateQueryExpression>

---

SearchPortalGroupQueryNode

• SearchPortalGroupQueryNode: ZodType<SearchPortalGroupQueryNode, ZodTypeDef, SearchPortalGroupQueryNode>

---

SearchPortalMultiSelectQueryExpression

• SearchPortalMultiSelectQueryExpression: ZodType<SearchPortalMultiSelectQueryExpression, ZodTypeDef, SearchPortalMultiSelectQueryExpression>

---

SearchPortalNumberQueryExpression

• SearchPortalNumberQueryExpression: ZodType<SearchPortalNumberQueryExpression, ZodTypeDef, SearchPortalNumberQueryExpression>

---

SearchPortalQuery

• SearchPortalQuery: ZodType<SearchPortalQuery, ZodTypeDef, SearchPortalQuery>

---

SearchPortalQueryExpression

• SearchPortalQueryExpression: ZodType<SearchPortalQueryExpression, ZodTypeDef, SearchPortalQueryExpression>

---

SearchPortalRefQueryExpression

• SearchPortalRefQueryExpression: ZodType<SearchPortalRefQueryExpression, ZodTypeDef, SearchPortalRefQueryExpression>

---

SearchPortalRemTypeQueryExpression

• SearchPortalRemTypeQueryExpression: ZodType<SearchPortalRemTypeQueryExpression, ZodTypeDef, SearchPortalRemTypeQueryExpression>

---

SearchPortalSingleSelectQueryExpression

• SearchPortalSingleSelectQueryExpression: ZodType<SearchPortalSingleSelectQueryExpression, ZodTypeDef, SearchPortalSingleSelectQueryExpression>

---

SearchPortalSlotQueryNode

• SearchPortalSlotQueryNode: ZodType<SearchPortalSlotQueryNode, ZodTypeDef, SearchPortalSlotQueryNode>

---

SearchPortalTextQueryExpression

• SearchPortalTextQueryExpression: ZodType<SearchPortalTextQueryExpression, ZodTypeDef, SearchPortalTextQueryExpression>

---

SearchPortalUnaryQueryNode

• SearchPortalUnaryQueryNode: ZodType<SearchPortalUnaryQueryNode, ZodTypeDef, SearchPortalUnaryQueryNode>

---

SettingEvents

• Const SettingEvents: Object

Type declaration

Name	Type
SettingChanged	string

---

SidebarEvents

• Const SidebarEvents: Object

Type declaration

Name	Type
ClickSidebarItem	string

---

SingleSelectMatcherTypesToDisplayValue

• Const SingleSelectMatcherTypesToDisplayValue: Record<SingleSelectMatcher, string>

---

StorageEvents

• Const StorageEvents: Object

Type declaration

Name	Type
StorageLocalChange	string
StorageSessionChange	string
StorageSyncedChange	string

---

TextMatcherTypesToDisplayValue

• Const TextMatcherTypesToDisplayValue: Record<TextMatcher, string>

---

TextMatchersAllowedWithoutPrimaryQuery

• Const TextMatchersAllowedWithoutPrimaryQuery: TextMatcher[]

---

WidgetEvents

• Const WidgetEvents: Object

Type declaration

Name	Type
FakeEmbedComponentDimensionChange	string
FakeEmbedDOMEvent	string
StealKeyEvent	string

---

WindowEvents

• Const WindowEvents: Object

Type declaration

Name	Type
CurrentWindowTreeChange	string
FocusedPaneChange	string

---

numberValidatorSig

• Const numberValidatorSig: ZodUnion<[ZodObject<{ arg: ZodNumber ; type: ZodLiteral<"gte"> }, "strip", ZodTypeAny, { arg: number ; type: "gte" }, { arg: number ; type: "gte" }>, ZodObject<{ arg: ZodNumber ; type: ZodLiteral<"min"> }, "strip", ZodTypeAny, { arg: number ; type: "min" }, { arg: number ; type: "min" }>, ZodObject<{ arg: ZodNumber ; type: ZodLiteral<"gt"> }, "strip", ZodTypeAny, { arg: number ; type: "gt" }, { arg: number ; type: "gt" }>]>

---

richTextFormatNameCodeMap

• Const richTextFormatNameCodeMap: Object

Type declaration

Name	Type
bold	string
italic	string
quote	string
underline	string

---

stringValidatorSig

• Const stringValidatorSig: ZodUnion<[ZodObject<{ type: ZodLiteral<"email"> }, "strip", ZodTypeAny, { type: "email" }, { type: "email" }>, ZodObject<{ type: ZodLiteral<"url"> }, "strip", ZodTypeAny, { type: "url" }, { type: "url" }>, ZodObject<{ arg: ZodString ; type: ZodLiteral<"regex"> }, "strip", ZodTypeAny, { arg: string ; type: "regex" }, { arg: string ; type: "regex" }>, ZodObject<{ arg: ZodString ; type: ZodLiteral<"startsWith"> }, "strip", ZodTypeAny, { arg: string ; type: "startsWith" }, { arg: string ; type: "startsWith" }>]>

Functions

createReactiveApi

▸ createReactiveApi<Func>(plugin, userFunc, rerun, setState, previousSubscriptions): Promise<SubscriptionInfo[]>

Type parameters

Name	Type
Func	extends (plugin: RNPlugin) => Promise<any>

Parameters

Name	Type
plugin	RNPlugin
userFunc	Func
rerun	() => void
setState	(result: Awaited<ReturnType<Func>>) => void
previousSubscriptions	SubscriptionInfo[]

Returns

Promise<SubscriptionInfo[]>

---

declareIndexPlugin

▸ declareIndexPlugin(onActivate, onDeactivate): void

Parameters

Name	Type
onActivate	(plugin: ReactRNPlugin) => Promise<void>
onDeactivate	(plugin: ReactRNPlugin) => Promise<void>

Returns

void

---

filterAsync

▸ filterAsync<T>(array, filter): Promise<T[]>

Type parameters

Name
T

Parameters

Name	Type
array	T[]
filter	(t: T) => Promise<boolean>

Returns

Promise<T[]>

---

isAppEvent

▸ isAppEvent(eventId): eventId is string

Parameters

Name	Type
eventId	string

Returns

eventId is string

---

makeNamespacedCall

▸ makeNamespacedCall(call, namespace): (methodName: string, args: Record<string, any>) => Promise<any>

Parameters

Name	Type
call	(methodName: string, args: Record<string, any>, namespace?: string | string[]) => Promise<any>
namespace	string

Returns

fn

▸ (methodName, args): Promise<any>

Parameters

Name	Type
methodName	string
args	Record<string, any>

Returns

Promise<any>

---

parseManifest

▸ parseManifest(m): Either<ValidationError[], { author: string ; changelogUrl: undefined | string ; description: undefined | string ; enableOnMobile: boolean ; id: string ; manifestVersion: 1 ; minimumRemNoteVersion: undefined | { major: number; minor: number; patch: number; } ; name: string ; projectUrl: undefined | string ; repoUrl: string ; requestNative: boolean ; requiredScopes: ({ level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; type: All } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; remName: string ; type: DescendantsOfName } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; remId: string ; type: DescendantsOfId } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; powerupCode: string ; type: Powerup } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; type: FocusedSubtree } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; type: KnowledgeBaseInfo })[] ; supportUrl: undefined | string ; theme: undefined | ("dark" | "light")[] ; unlisted: undefined | boolean ; version: { major: number; minor: number; patch: number; } = VersionSig }>

Parameters

Name	Type
m	any

Returns

Either<ValidationError[], { author: string ; changelogUrl: undefined | string ; description: undefined | string ; enableOnMobile: boolean ; id: string ; manifestVersion: 1 ; minimumRemNoteVersion: undefined | { major: number; minor: number; patch: number; } ; name: string ; projectUrl: undefined | string ; repoUrl: string ; requestNative: boolean ; requiredScopes: ({ level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; type: All } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; remName: string ; type: DescendantsOfName } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; remId: string ; type: DescendantsOfId } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; powerupCode: string ; type: Powerup } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; type: FocusedSubtree } | { level: PluginActionPermissionLevel = PluginActionPermissionLevelSig; type: KnowledgeBaseInfo })[] ; supportUrl: undefined | string ; theme: undefined | ("dark" | "light")[] ; unlisted: undefined | boolean ; version: { major: number; minor: number; patch: number; } = VersionSig }>

---

remTypeTinyGraphToNormal

▸ remTypeTinyGraphToNormal(remType): REM_TYPE

Parameters

Name	Type
remType	RemTypeTinyGraph

Returns

REM_TYPE

---

remTypeToTinyGraphType

▸ remTypeToTinyGraphType(remType): RemTypeTinyGraph

Parameters

Name	Type
remType	REM_TYPE

Returns

RemTypeTinyGraph

---

renderWidget

▸ renderWidget(ComponentClass): void

Parameters

Name	Type
ComponentClass	ComponentClass<{}, any> | () => null | Element | () => null | Element

Returns

void

---

useAPIEventListener

▸ useAPIEventListener(appEvent, listenerKey, callback): void

Parameters

Name	Type
appEvent	string
listenerKey	AppEventListerKey
callback	(args: any) => void

Returns

void

---

useGetRemsByIdsReactive

▸ useGetRemsByIdsReactive(inpRemIds): (Rem | undefined)[]

Parameters

Name	Type
inpRemIds	undefined | (undefined | string)[]

Returns

(Rem | undefined)[]

---

useLocalStorageState

▸ useLocalStorageState<Value>(key, defaultValue): [Value, (value: Value) => Promise<void>]

Type parameters

Name
Value

Parameters

Name	Type
key	string
defaultValue	Value

Returns

[Value, (value: Value) => Promise<void>]

---

useOnMessageBroadcast

▸ useOnMessageBroadcast(cb): void

Parameters

Name	Type
cb	(message: any) => void

Returns

void

---

usePlugin

▸ usePlugin(): RNPlugin

Returns

RNPlugin

---

useRunAsync

▸ useRunAsync<T>(fn, deps): undefined | T

Type parameters

Name
T

Parameters

Name	Type
fn	() => Promise<T>
deps	any[]

Returns

undefined | T

---

useSessionStorageState

▸ useSessionStorageState<Value>(key, defaultValue): [Value, (value: Value) => Promise<void>]

Type parameters

Name
Value

Parameters

Name	Type
key	string
defaultValue	Value

Returns

[Value, (value: Value) => Promise<void>]

---

useSyncedStorageState

▸ useSyncedStorageState<Value>(key, defaultValue): [Value, (value: Value) => Promise<void>]

Type parameters

Name
Value

Parameters

Name	Type
key	string
defaultValue	Value

Returns

[Value, (value: Value) => Promise<void>]

---

useTracker

▸ useTracker<T>(userFunc, deps?): T | undefined

Type parameters

Name	Type
T	extends unknown

Parameters

Name	Type	Default value
userFunc	(plugin: RNPlugin) => Promise<T>	undefined
deps	any[]	[]

Returns

T | undefined