basic data model for a shareable application with scriptable "sticky notes"
npm install shareable-note-stickersbasic data model for a shareable application with scriptable "sticky notes"
This module implements the underlying data model for a shareable hierarchical collection of "boards" containing scriptable widgets (called "stickers").
It will often be used in combination with
* sns-boardview - a preact component that displays one of these boards of stickers and provides all methods to visually select and edit them, and
* a "sharing adapter" such as the sns-collabs-adapter that actually provides the sharing capability.
To get a real application, you'll have to combine these modules and add a proper user interface - as done by NoteStickers.
Because of this modularity, it is not too difficult to use a different sharing framework (such as Y.js or automerge), modify the user interface according to your personal needs or even develop a headless tool that analyzes and/or changes the shared data without user intervention.
(work in progress, see NoteStickers for a first usage example)
"shareable-note-stickers" is intended for being used as a module within a "host application". In order to use it, simply import the necessary types, constants, functions and classes:
``
import {
throwError, throwReadOnlyError,
ValueIsBoard, ValueIsSticker,
ValueIsName, ValueIsIdentifier, ValueIsGeometry, ValueIsError,
allowBoard,
SNS_Id, SNS_Name, SNS_Identifier,
SNS_Ordinal, SNS_Text, SNS_Textline, SNS_Color, SNS_URL,
SNS_Geometry, SNS_FontStyle, SNS_Error,
SNS_Visual, SNS_Folder, SNS_Project, SNS_Board, SNS_Sticker,
newId, removeIdsFrom, SNS_Change,
TemplateOfBehavior,
SNS_BehaviorEntryGroup, SNS_BehaviorEntry,
groupedBehaviorEntryList,
} from 'https://rozek.github.io/shareable-note-stickers/dist/shareable-note-stickers.modern.js'
(Note: the above import statement is just an example - your imports may differ)
To simplify scripting, most of the exported functions are also available as part of the global variable SNS
`
window.SNS = {
SNS_FontStyles, SNS_ErrorTypes,
SNS_matchableProperties, SNS_MatchModes,
throwError, throwReadOnlyError,
ValueIsVisual, allowVisual, allowedVisual, expectVisual, expectedVisual,
ValueIsFolder, allowFolder, allowedFolder, expectFolder, expectedFolder,
ValueIsProject, allowProject, allowedProject, expectProject, expectedProject,
ValueIsBoard, allowBoard, allowedBoard, expectBoard, expectedBoard,
ValueIsSticker, allowSticker, allowedSticker, expectSticker, expectedSticker,
ValueIsId, allowId, allowedId, expectId, expectedId,
ValueIsIdentifier, allowIdentifier, allowedIdentifier, expectIdentifier, expectedIdentifier,
ValueIsName, allowName, allowedName, expectName, expectedName,
ValueIsLocation, allowLocation, allowedLocation, expectLocation, expectedLocation,
ValueIsDimension, allowDimension, allowedDimension, expectDimension, expectedDimension,
ValueIsPosition, allowPosition, allowedPosition, expectPosition, expectedPosition,
ValueIsSize, allowSize, allowedSize, expectSize, expectedSize,
ValueIsGeometry, allowGeometry, allowedGeometry, expectGeometry, expectedGeometry,
ValueIsError, allowError, allowedError, expectError, expectedError,
ValueIsSerializableObject, allowSerializableObject, allowedSerializableObject, expectSerializableObject, expectedSerializableObject,
ValueIsSerializableValue, allowSerializableValue, allowedSerializableValue, expectSerializableValue, expectedSerializableValue,
acceptableBoolean, acceptableOptionalBoolean,
acceptableNumber, acceptableOptionalNumber,
acceptableNumberInRange, acceptableOptionalNumberInRange,
acceptableInteger, acceptableOptionalInteger,
acceptableIntegerInRange, acceptableOptionalIntegerInRange,
acceptableOrdinal, acceptableOptionalOrdinal,
acceptableString, acceptableOptionalString,
acceptableNonEmptyString, acceptableOptionalNonEmptyString,
acceptableStringMatching, acceptableOptionalStringMatching,
acceptableText, acceptableOptionalText,
acceptableTextline, acceptableOptionalTextline,
acceptableFunction, acceptableOptionalFunction,
acceptableList, acceptableOptionalList,
acceptableListSatisfying, acceptableOptionalListSatisfying,
acceptableColor, acceptableOptionalColor,
acceptableEMailAddress, acceptablePhoneNumber, acceptableURL,
newId, removeIdsFrom,
CSSStyleOfVisual,
TemplateOfBehavior,
}
"shareable-note-stickers" exports a few types and classes, and a bunch of helper functions.
Type exports are for TypeScript users only - all others may simply skip this section.
* type SNS_Id = string
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
#### Rendering ####
* type SNS_onRenderingCallback = (
#### Search Support ####
* const SNS_MatchModes = ['equality','containment','match']
*
*
*
*
*
*
#### Dialogs ####
* type SNS_Dialog = {
#### Change Reporting ####
* const SNS_Changes = [
*
*
#### Error Reporting ####
* const SNS_ErrorTypes = [
*
*
*
#### UI Support ####
* type SNS_groupedBehaviorEntryList = SNS_BehaviorEntryGroup[]
*
*
(t.b.w.)
* Id
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
(t.b.w.)
* Path
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
(t.b.w.)
* BoardAtIndexPath
*
*
*
*
*
*
*
*
*
*
*
(t.b.w.)
* StickerList
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
(t.b.w.)
* Board
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
(t.b.w.)
* ConnectionState
*
*
*
(t.b.w.)
* ValueIsVisual, allow/expect[ed]Visual
* , allow/expect[ed]Folder
* , allow/expect[ed]Project
* , allow/expect[ed]Board
* , allow/expect[ed]Sticker
* , allow/expect[ed]Id
* , allow/expect[ed]Identifier
* , allow/expect[ed]Name
* , allow/expect[ed]Location
* , allow/expect[ed]Dimension
* , allow/expect[ed]Position
* , allow/expect[ed]Size
* , allow/expect[ed]Geometry
* , allow/expect[ed]Error
* , allow/expect[ed]SerializableObject
* , allow/expect[ed]SerializableValue
(t.b.w.)
* acceptable[Optional]Boolean
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
(t.b.w.)
* attachBoard
*
*
*
*
*
*
*
*
*
*
*
(t.b.w.)
* groupedBehaviorEntryList
(t.b.w.)
* throwError
*
*
*
*
(t.b.w.)
The following JSON schema describes the file format used for exported NoteSticker projects:
(t.b.w.)