Skip to main content

@remnote/plugin-sdk

Enumerations

Component Classes

Other Classes

Component Interfaces

Other Interfaces

Type Aliases

AppEventListerKey

Ƭ AppEventListerKey: string | undefined


CallbackFn

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

Type declaration

▸ (context): unknown | Promise<unknown>

Parameters
NameType
contextRecord<string, any>
Returns

unknown | Promise<unknown>


CardType

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


ComponentFocusId

Ƭ ComponentFocusId: ComponentFocusableItem[]


EditorRange

Ƭ EditorRange: Object

Type declaration

NameType
endnumber
startnumber

EventCallbackFn

Ƭ EventCallbackFn: (event: any) => void

Type declaration

▸ (event): void

Parameters
NameType
eventany
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

NameType
paneIdstring
remIdstring

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

NameType
i"ai"
size?string

RichTextAnnotationInterface

Ƭ RichTextAnnotationInterface: Object

Type declaration

NameType
highlighterSerialization{ text: string }
highlighterSerialization.textstring
i"n"
textstring
urlstring

RichTextAudioInterface

Ƭ RichTextAudioInterface: Object

Type declaration

NameType
height?number
i"a"
onlyAudio?boolean
percent?25 | 50 | 100
urlstring
width?number

RichTextCardDelimiterInterface

Ƭ RichTextCardDelimiterInterface: Object

Type declaration

NameType
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

NameType
_idRemId
aliasId?RemId
content?boolean
i"q"
pin?boolean
showFullName?boolean
textOfDeletedRem?RichTextInterface

RichTextElementTextInterface

Ƭ RichTextElementTextInterface: Object

Type declaration

NameType
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
textstring
title?string
u?boolean
url?string
workInProgressPortal?boolean
workInProgressRem?boolean
workInProgressTag?boolean

RichTextFlashcardIconInterface

Ƭ RichTextFlashcardIconInterface: Object

Type declaration

NameType
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

NameType
_idstring | null
i"g"

RichTextImageClozeBlockInterface

Ƭ RichTextImageClozeBlockInterface: Object

Type declaration

NameType
cIdstring
detectedText?string
frontLabel?RichTextInterface | string
heightnumber
label?RichTextInterface | string
linkedRemId?RemId | string
primary?boolean
rotationnumber
widthnumber
xnumber
ynumber

RichTextImageInterface

Ƭ RichTextImageInterface: Object

Type declaration

NameType
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
urlstring
width?number

RichTextInterface

Ƭ RichTextInterface: RichTextElementInterface[]


RichTextLatexInterface

Ƭ RichTextLatexInterface: Object

Type declaration

NameType
block?boolean
cId?string
i"x"
latexClozes?string[]
textstring

RichTextPluginInterface

Ƭ RichTextPluginInterface: Object

Type declaration

NameType
i"p"
pluginName?string
urlstring

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

NameType
PowerupCodeextends BuiltInPowerupCodes

StringValidatorArray

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


Version

Ƭ Version: z.TypeOf<typeof VersionSig>

Variables

AppEvents

Const AppEvents: Object

Type declaration

NameType
ClickRemReferencestring
ClickSidebarItemstring
CurrentWindowTreeChangestring
EditorSelectionChangedstring
EditorTextEditedstring
FakeEmbedComponentDimensionChangestring
FakeEmbedDOMEventstring
FocusedPaneChangestring
FocusedPortalChangestring
FocusedRemChangestring
GlobalOpenRem"global.open-rem"
GlobalRemChangedstring
MessageBroadcaststring
MouseOutLinkstring
MouseOverLinkstring
PowerupSlotChangedstring
QueueCompleteCard"queue.complete-card"
QueueEnter"queue.enter"
QueueExit"queue.exit"
QueueLoadCard"queue.load-card"
RemChangedstring
RevealAnswer"queue.reveal-answer"
SettingChangedstring
StealKeyEventstring
StorageLocalChangestring
StorageSessionChangestring
StorageSyncedChangestring
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

NameType
BOLDstring
CLOZEstring
DATEstring
HIDDEN_CLOZEstring
HIGHLIGHTstring
INLINE_CODEstring
ITALICstring
LINKstring
UNDERLINEstring

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

NameType
LATEXstring

DateMatcherTypesToDisplayValue

Const DateMatcherTypesToDisplayValue: Record<DateMatcher, string>


EditorEvents

Const EditorEvents: Object

Type declaration

NameType
EditorSelectionChangedstring
EditorTextEditedstring

FocusEvents

Const FocusEvents: Object

Type declaration

NameType
FocusedPortalChangestring
FocusedRemChangestring

GlobalEvent

Const GlobalEvent: Object

Type declaration

NameType
GlobalOpenRem"global.open-rem"
URLChange"global.url-change"

LegacySearchPortalSingleSelectQueryExpression

LegacySearchPortalSingleSelectQueryExpression: ZodType<LegacySearchPortalSingleSelectQueryExpression, ZodTypeDef, LegacySearchPortalSingleSelectQueryExpression>


MessagingEvents

Const MessagingEvents: Object

Type declaration

NameType
MessageBroadcaststring

MultiSelectMatcherTypesToDisplayValue

Const MultiSelectMatcherTypesToDisplayValue: Record<MultiSelectMatcher, string>


NonRelativeMatcherTypes

Const NonRelativeMatcherTypes: DateMatcher[]


NumberMatcherTypesToDisplayValue

Const NumberMatcherTypesToDisplayValue: Record<NumberMatcher, string>


PowerupEvent

Const PowerupEvent: Object

Type declaration

NameType
ClickRemReferencestring
MouseOutLinkstring
MouseOverLinkstring
PowerupSlotChangedstring

PowerupSlotCodeMap

Const PowerupSlotCodeMap: Object

Type declaration

NameType
a{ SortDirection: string = 'd' }
a.SortDirectionstring
at{ Templates: string = 't' }
at.Templatesstring
b{ FileURL: string = 'f'; LastReadDate: string = 'd'; ReadPercent: string = 'r'; Title: string = 't'; URL: string = 'u' }
b.FileURLstring
b.LastReadDatestring
b.ReadPercentstring
b.Titlestring
b.URLstring
c{}
cd{ DontBoundHeight: string = 'b'; DontWrap: string = 'w'; Language: string = 'l' }
cd.DontBoundHeightstring
cd.DontWrapstring
cd.Languagestring
ct{ Template: string = 't' }
ct.Templatestring
d{ Date: string = 'd'; Timestamp: string = 's' }
d.Datestring
d.Timestampstring
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.ExamSchedulerCollectionstring
de.ExamSchedulerDatestring
de.ExamSchedulerDesiredStabilitystring
de.ExamSchedulerMaxNewCardsPerDaystring
de.ExamSchedulerMaxTotalCardsPerDaystring
de.MaxNewCardsPerDaystring
de.MaxTotalCardsPerDaystring
de.Statusstring
de.Topicsstring
dv{}
e{ Message: string = 'm' }
e.Messagestring
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.Authorsstring
f.HasNoTextLayerstring
f.Keywordsstring
f.LastReadDatestring
f.Namestring
f.ReadPercentstring
f.Themestring
f.Titlestring
f.Typestring
f.URLstring
f.ViewerDatastring
g{ AutoActivate: string = 'a'; CollapseConfigure: string = 'c'; Pinned: string = 'p'; PrimaryColumnName: string = 'n' }
g.AutoActivatestring
g.CollapseConfigurestring
g.Pinnedstring
g.PrimaryColumnNamestring
h{ Color: string = 'c' }
h.Colorstring
ha{}
hh{ Data: string = 'd'; HTMLId: string = 'h' }
hh.Datastring
hh.HTMLIdstring
i{}
id{}
j{}
k{}
l{ Aliases: string = 'a' }
l.Aliasesstring
m{}
n{ Data: string = 'd'; PdfId: string = 'p' }
n.Datastring
n.PdfIdstring
o{ DeprecatedSource: string = 'o'; Status: string = 's' }
o.DeprecatedSourcestring
o.Statusstring
os{ Sources: string = 'os' }
os.Sourcesstring
p{ Data: string = 'd'; Url: string = 'w' }
p.Datastring
p.Urlstring
pn{}
q{}
qt{}
r{ Size: string = 's' }
r.Sizestring
rt{ Date: string = 'd' }
rt.Datestring
s{}
sd{}
sp{ AutomaticBacklinkSearchPortalFor: string = 'b'; DontIncludeNestedDescendants: string = 's'; Filter: string = 'f'; Query: string = 'q' }
sp.AutomaticBacklinkSearchPortalForstring
sp.DontIncludeNestedDescendantsstring
sp.Filterstring
sp.Querystring
t{ Status: string = 's' }
t.Statusstring
ty{}
u{}
w{}
x{}
y{ ExtraSlotsOnBackOfCard: string = 'b'; ExtraSlotsOnFrontOfCard: string = 'f'; SelectTag: string = 't' }
y.ExtraSlotsOnBackOfCardstring
y.ExtraSlotsOnFrontOfCardstring
y.SelectTagstring
z{ Hostname: string = 'u' }
z.Hostnamestring

QueryRemType

QueryRemType: ZodType<QueryRemType, ZodTypeDef, QueryRemType>


QueueEvent

Const QueueEvent: Object

Type declaration

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

QueueItemTypeHumanReadable

Const QueueItemTypeHumanReadable: Object

Type declaration

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

RICH_TEXT_ELEMENT_TYPE

Const RICH_TEXT_ELEMENT_TYPE: Object

Type declaration

NameType
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

NameType
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

NameType
GlobalRemChangedstring
RemChangedstring

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

NameType
SettingChangedstring

SidebarEvents

Const SidebarEvents: Object

Type declaration

NameType
ClickSidebarItemstring

SingleSelectMatcherTypesToDisplayValue

Const SingleSelectMatcherTypesToDisplayValue: Record<SingleSelectMatcher, string>


StorageEvents

Const StorageEvents: Object

Type declaration

NameType
StorageLocalChangestring
StorageSessionChangestring
StorageSyncedChangestring

TextMatcherTypesToDisplayValue

Const TextMatcherTypesToDisplayValue: Record<TextMatcher, string>


TextMatchersAllowedWithoutPrimaryQuery

Const TextMatchersAllowedWithoutPrimaryQuery: TextMatcher[]


WidgetEvents

Const WidgetEvents: Object

Type declaration

NameType
FakeEmbedComponentDimensionChangestring
FakeEmbedDOMEventstring
StealKeyEventstring

WindowEvents

Const WindowEvents: Object

Type declaration

NameType
CurrentWindowTreeChangestring
FocusedPaneChangestring

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

NameType
boldstring
italicstring
quotestring
underlinestring

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

NameType
Funcextends (plugin: RNPlugin) => Promise<any>

Parameters

NameType
pluginRNPlugin
userFuncFunc
rerun() => void
setState(result: Awaited<ReturnType<Func>>) => void
previousSubscriptionsSubscriptionInfo[]

Returns

Promise<SubscriptionInfo[]>


declareIndexPlugin

declareIndexPlugin(onActivate, onDeactivate): void

Parameters

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

Returns

void


filterAsync

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

Type parameters

Name
T

Parameters

NameType
arrayT[]
filter(t: T) => Promise<boolean>

Returns

Promise<T[]>


isAppEvent

isAppEvent(eventId): eventId is string

Parameters

NameType
eventIdstring

Returns

eventId is string


makeNamespacedCall

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

Parameters

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

Returns

fn

▸ (methodName, args): Promise<any>

Parameters
NameType
methodNamestring
argsRecord<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

NameType
many

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

NameType
remTypeRemTypeTinyGraph

Returns

REM_TYPE


remTypeToTinyGraphType

remTypeToTinyGraphType(remType): RemTypeTinyGraph

Parameters

NameType
remTypeREM_TYPE

Returns

RemTypeTinyGraph


renderWidget

renderWidget(ComponentClass): void

Parameters

NameType
ComponentClassComponentClass<{}, any> | () => null | Element | () => null | Element

Returns

void


useAPIEventListener

useAPIEventListener(appEvent, listenerKey, callback): void

Parameters

NameType
appEventstring
listenerKeyAppEventListerKey
callback(args: any) => void

Returns

void


useGetRemsByIdsReactive

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

Parameters

NameType
inpRemIdsundefined | (undefined | string)[]

Returns

(Rem | undefined)[]


useLocalStorageState

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

Type parameters

Name
Value

Parameters

NameType
keystring
defaultValueValue

Returns

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


useOnMessageBroadcast

useOnMessageBroadcast(cb): void

Parameters

NameType
cb(message: any) => void

Returns

void


usePlugin

usePlugin(): RNPlugin

Returns

RNPlugin


useRunAsync

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

Type parameters

Name
T

Parameters

NameType
fn() => Promise<T>
depsany[]

Returns

undefined | T


useSessionStorageState

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

Type parameters

Name
Value

Parameters

NameType
keystring
defaultValueValue

Returns

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


useSyncedStorageState

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

Type parameters

Name
Value

Parameters

NameType
keystring
defaultValueValue

Returns

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


useTracker

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

Type parameters

NameType
Textends unknown

Parameters

NameTypeDefault value
userFunc(plugin: RNPlugin) => Promise<T>undefined
depsany[][]

Returns

T | undefined