Class Store

An in memory store that has a bunch of usefful methods for retrieving Atomic Data Resources. It is also resposible for keeping the Resources in sync with Subscribers (components that use the Resource), and for managing the current Agent (User).

Hierarchy

Store

Constructors

constructor

new Store(opts?: StoreOpts): Store
Parameters
- Optional opts: StoreOpts
Returns Store
- Defined in lib/dist/src/store.d.ts:65

Properties

`Private` _resources

_resources: any

All the resources of the store

`Private` `Optional` agent

agent?: any

Current Agent, used for signing commits. Is required for posting things.

`Private` client

client: any

`Private` eventManager

eventManager: any

`Private` findAvailableSubject

findAvailableSubject: any

`Private` injectedFetch

injectedFetch: any

`Private` randomPart

randomPart: any

`Private` serverUrl

serverUrl: any

The base URL of an Atomic Server. This is where to send commits, create new instances, search, etc.

subscribers

subscribers: Map<string, ResourceCallback[]>

A list of all functions that need to be called when a certain resource is updated

`Private` webSockets

webSockets: any

Mapped from origin to websocket

Accessors

resources

get resources(): Map<string, Resource>
All the resources of the store

Returns Map<string, Resource>
- Defined in lib/dist/src/store.d.ts:67

Methods

addResource

addResource(resource: Resource): void
Deprecated
Will be marked private in the future, please use addResources

Adds a Resource to the store and notifies subscribers. Replaces existing resources, unless this new resource is explicitly incomplete.
Parameters
- resource: Resource
Returns void
- Defined in lib/dist/src/store.d.ts:77

addResources

addResources(...resources: Resource[]): void
Parameters
- Rest ...resources: Resource[]
Returns void
- Defined in lib/dist/src/store.d.ts:70

buildUniqueSubjectFromParts

buildUniqueSubjectFromParts(...parts: string[]): Promise<string>
Checks is a set of URL parts can be combined into an available subject. Will retry until it works.
Parameters
- Rest ...parts: string[]
Returns Promise<string>
- Defined in lib/dist/src/store.d.ts:84

checkSubjectTaken

checkSubjectTaken(subject: string): Promise<boolean>
Checks if a subject is free to use
Parameters
- subject: string
Returns Promise<boolean>
- Defined in lib/dist/src/store.d.ts:79

createSubject

createSubject(className?: string, parentSubject?: string): string
Creates a random URL. Add a classnme (e.g. 'persons') to make a nicer name
Parameters
- Optional className: string
- Optional parentSubject: string
Returns string
- Defined in lib/dist/src/store.d.ts:86

fetchResourceFromServer

fetchResourceFromServer(subject: string, opts?: { body?: string | ArrayBuffer; fromProxy?: boolean; method?: "GET" | "POST"; noWebSocket?: boolean; setLoading?: boolean }): Promise<Resource>
Always fetches resource from the server then adds it to the store.
Parameters
- subject: string
  
  The resource URL to be fetched
- Optional opts: { body?: string | ArrayBuffer; fromProxy?: boolean; method?: "GET" | "POST"; noWebSocket?: boolean; setLoading?: boolean }
  - Optional body?: string | ArrayBuffer
    
    HTTP Body for POSTing
  - Optional fromProxy?: boolean
    
    Fetch it from the /path endpoint of your server URL. This effectively is a proxy / cache.
  - Optional method?: "GET" | "POST"
    
    HTTP Method, defaults to GET
  - Optional noWebSocket?: boolean
    
    Do not use WebSockets, use HTTP(S)
  - Optional setLoading?: boolean
    
    Overwrites the existing resource and sets it to loading.
Returns Promise<Resource>
- Defined in lib/dist/src/store.d.ts:90

getAgent

getAgent(): undefined | Agent
Returns the Currently set Agent, returns null if there is none. Make sure to first run store.setAgent().

Returns undefined | Agent
- Defined in lib/dist/src/store.d.ts:118

getAllSubjects

getAllSubjects(): string[]
Returns string[]
- Defined in lib/dist/src/store.d.ts:107

getDefaultWebSocket

getDefaultWebSocket(): undefined | WebSocket
Returns the WebSocket for the current Server URL

Returns undefined | WebSocket
- Defined in lib/dist/src/store.d.ts:109

getProperty

getProperty(subject: string): Promise<Property>
Gets a property by URL.
Parameters
- subject: string
Returns Promise<Property>
- Defined in lib/dist/src/store.d.ts:133

getResourceAncestry

getResourceAncestry(resource: Resource): Promise<string[]>
Returns the ancestry of a resource, starting with the resource itself.
Parameters
- resource: Resource
Returns Promise<string[]>
- Defined in lib/dist/src/store.d.ts:192

getResourceAsync

getResourceAsync(subject: string): Promise<Resource>
Gets a resource by URL. Fetches and parses it if it's not available in the store. Not recommended to use this for rendering, because it might cause resources to be fetched multiple times.
Parameters
- subject: string
Returns Promise<Resource>
- Defined in lib/dist/src/store.d.ts:131

getResourceLoading

getResourceLoading(subject?: string, opts?: FetchOpts): Resource
Gets a resource by URL. Fetches and parses it if it's not available in the store. Instantly returns an empty loading resource, while the fetching is done in the background . If the subject is undefined, an empty non-saved resource will be returned.
Parameters
- Optional subject: string
- Optional opts: FetchOpts
Returns Resource
- Defined in lib/dist/src/store.d.ts:125

getServerUrl

getServerUrl(): string
Returns the base URL of the companion server

Returns string
- Defined in lib/dist/src/store.d.ts:113

getWebSocketForSubject

getWebSocketForSubject(subject: string): undefined | WebSocket
Opens a Websocket for some subject URL, or returns the existing one.
Parameters
- subject: string
Returns undefined | WebSocket
- Defined in lib/dist/src/store.d.ts:111

injectFetch

injectFetch(fetchOverride: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)): void
Inject a custom fetch implementation to use when fetching resources over http
Parameters
- fetchOverride: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
  - - (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
    - Parameters
      
      input: RequestInfo | URL
      
      Optional init: RequestInit
      
      Returns Promise<Response>
Returns void
- Defined in lib/dist/src/store.d.ts:69

isOffline

isOffline(): boolean
If the store does not have an active internet connection, will return false. This may affect some functionality. For example, some checks will not be performed client side when offline.

Returns boolean
- Defined in lib/dist/src/store.d.ts:144

notify

notify(resource: Resource): Promise<void>
Let's subscribers know that a resource has been changed. Time to update your views!
Parameters
- resource: Resource
Returns Promise<void>
- Defined in lib/dist/src/store.d.ts:146

notifyError

notifyError(e: string | Error): void
This is called when Errors occur in some of the library functions. Set your errorhandler function to store.errorHandler.
Parameters
- e: string | Error
Returns void
- Defined in lib/dist/src/store.d.ts:138

notifyResourceManuallyCreated

notifyResourceManuallyCreated(resource: Resource): void
Parameters
- resource: Resource
Returns void
- Defined in lib/dist/src/store.d.ts:148

notifyResourceSaved

notifyResourceSaved(resource: Resource): void
Parameters
- resource: Resource
Returns void
- Defined in lib/dist/src/store.d.ts:147

on

on<T>(event: T, callback: StoreEventHandlers[T]): (() => void)
Type Parameters
Type Parameters
- T extends StoreEvents
Parameters
- event: T
- callback: StoreEventHandlers[T]
Returns (() => void)
- - (): void
  - Returns void
- Defined in lib/dist/src/store.d.ts:186

openWebSocket

openWebSocket(url: string): void
Opens a WebSocket for this Atomic Server URL
Parameters
- url: string
Returns void
- Defined in lib/dist/src/store.d.ts:176

parseMetaTags

parseMetaTags(): void
Parses the HTML document for JSON-AD data in tags, adds it to the store

Returns void
- Defined in lib/dist/src/store.d.ts:150

postCommit

postCommit(commit: Commit, endpoint: string): Promise<Commit>
Parameters
- commit: Commit
- endpoint: string
Returns Promise<Commit>
- Defined in lib/dist/src/store.d.ts:188

postToServer

postToServer(url: string, data: string | ArrayBuffer): Promise<Resource>
Sends an HTTP POST request to the server to the Subject. Parses the returned Resource and adds it to the store.
Parameters
- url: string
- data: string | ArrayBuffer
Returns Promise<Resource>
- Defined in lib/dist/src/store.d.ts:157

preloadPropsAndClasses

preloadPropsAndClasses(): Promise<void>
Fetches all Classes and Properties from your current server, including external resources. This helps to speed up time to interactive, but may not be necessary for all applications.

Returns Promise<void>
- Defined in lib/dist/src/store.d.ts:155

removeResource

removeResource(subject: string): void
Removes (destroys / deletes) resource from this store
Parameters
- subject: string
Returns void
- Defined in lib/dist/src/store.d.ts:159

renameSubject

renameSubject(resource: Resource, newSubject: string): Promise<void>
Changes the Subject of a Resource. Checks if the new name is already taken, errors if so.
Parameters
- resource: Resource
- newSubject: string
Returns Promise<void>
- Defined in lib/dist/src/store.d.ts:164

setAgent

setAgent(agent: undefined | Agent): void
Sets the current Agent, used for signing commits. Authenticates all open websockets, and retries previously failed fetches.

Warning: doing this stores the Private Key of the Agent in memory. This might have security implications for your application.
Parameters
- agent: undefined | Agent
Returns void
- Defined in lib/dist/src/store.d.ts:172

setServerUrl

setServerUrl(url: string): void
Sets the Server base URL, without the trailing slash.
Parameters
- url: string
Returns void
- Defined in lib/dist/src/store.d.ts:174

subscribe(subject: string, callback: ResourceCallback): void
Registers a callback for when the a resource is updated. When you call this, you should probably also call .unsubscribe some time later.
Parameters
- subject: string
- callback: ResourceCallback
Returns void
- Defined in lib/dist/src/store.d.ts:181

subscribeWebSocket

subscribeWebSocket(subject: string): void
Parameters
- subject: string
Returns void
- Defined in lib/dist/src/store.d.ts:182

unSubscribeWebSocket

unSubscribeWebSocket(subject: string): void
Parameters
- subject: string
Returns void
- Defined in lib/dist/src/store.d.ts:183

unsubscribe

unsubscribe(subject: string, callback: ResourceCallback): void
Unregisters the callback (see subscribe())
Parameters
- subject: string
- callback: ResourceCallback
Returns void
- Defined in lib/dist/src/store.d.ts:185

uploadFiles

uploadFiles(files: File[], parent: string): Promise<string[]>
Parameters
- files: File[]
- parent: string
Returns Promise<string[]>
- Defined in lib/dist/src/store.d.ts:187

Class Store

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional opts: StoreOpts

Returns Store

Properties

Private _resources

Private Optional agent

Private client

Private eventManager

Private findAvailableSubject

Private injectedFetch

Private randomPart

Private serverUrl

subscribers

Private webSockets

Accessors

resources

Returns Map<string, Resource>

Methods

addResource

Deprecated

Parameters

resource: Resource

Returns void

addResources

Parameters

Rest ...resources: Resource[]

Returns void

buildUniqueSubjectFromParts

Parameters

Rest ...parts: string[]

Returns Promise<string>

checkSubjectTaken

Parameters

subject: string

Returns Promise<boolean>

createSubject

Parameters

Optional className: string

Optional parentSubject: string

Returns string

fetchResourceFromServer

Parameters

subject: string

Optional opts: { body?: string | ArrayBuffer; fromProxy?: boolean; method?: "GET" | "POST"; noWebSocket?: boolean; setLoading?: boolean }

Optional body?: string | ArrayBuffer

Optional fromProxy?: boolean

Optional method?: "GET" | "POST"

Optional noWebSocket?: boolean

Optional setLoading?: boolean

Returns Promise<Resource>

getAgent

Returns undefined | Agent

getAllSubjects

Returns string[]

getDefaultWebSocket

Returns undefined | WebSocket

getProperty

Parameters

subject: string

Returns Promise<Property>

getResourceAncestry

Parameters

resource: Resource

Returns Promise<string[]>

getResourceAsync

Parameters

subject: string

Returns Promise<Resource>

getResourceLoading

Parameters

Optional subject: string

`Optional` opts: StoreOpts

`Private` _resources

`Private` `Optional` agent

`Private` client

`Private` eventManager

`Private` findAvailableSubject

`Private` injectedFetch

`Private` randomPart

`Private` serverUrl

`Private` webSockets

`Rest` ...resources: Resource[]

`Rest` ...parts: string[]

`Optional` className: string

`Optional` parentSubject: string

`Optional` opts: { body?: string | ArrayBuffer; fromProxy?: boolean; method?: "GET" | "POST"; noWebSocket?: boolean; setLoading?: boolean }

`Optional` body?: string | ArrayBuffer

`Optional` fromProxy?: boolean

`Optional` method?: "GET" | "POST"

`Optional` noWebSocket?: boolean

`Optional` setLoading?: boolean

`Optional` subject: string

`Optional` opts: FetchOpts

`Optional` init: RequestInit