Class Plugin

This is the global instance of an AHQStore Plugin

import { Plugin } from "@ahqstore/plugin-api"

(async() => {
 const api = new Plugin(
  {
    capabilities: []
  }
 );
 
 // Must call after creation
 // AHQ Store has a timeout after which
 // it'll otherwise terminate your plugin
 await api.initialize();
})()

Index

Constructors

constructor

Methods

fetch getCapabilities getHostApi getState getTargetApi getThemeData hasCapability initialize injectCustomCss on registerAppAssetFetchFn registerAppFetchFn registerAppVersionFetchFn registerSearchFn requestRestart setState unsafeAddCustomOnMessage getInstance

Constructors

constructor

new Plugin(meta: Metadata): Plugin
This abstracts away the complexities of the AHQStore Plugin api

This constructor also handles the IPC communication and gives you a quick way to community via async wrappers

Use registerSearchFn, registerAppFetchFn, registerAppAssetFetchFn, registerAppVersionFetchFn to register handlers for the capability

You must call initialize afterwards
Parameters
- meta: Metadata
  Defines the metadata for your plugin
Returns Plugin
- Defined in index.ts:289

Methods

fetch

fetch(data: FetchOptions): Promise<HTTPOutput>
Performs an HTTP request like the fetch api

The maximum size of the body is 50MB

Note
- This function consumes the body and you don't get the array buffer back
Parameters
- data: FetchOptions
  Please read the information at FetchOptions
Returns Promise<HTTPOutput>
the HTTPOutput data type
- Defined in index.ts:597

getCapabilities

getCapabilities(): Set<Capability>
Gets the capabilities that your worker plugin is registered with

This requires you to get the plugin initialized

Returns Set<Capability>
A list of capabilities
- Defined in index.ts:454

getHostApi

getHostApi(): number
Gets the api version that AHQ Store Supports

This requires you to get the plugin initialized

Returns number
API Version as number
- Defined in index.ts:467

getState

getState(stateId: string): Promise<string>
Gets the state under the stateId specified
Parameters
- stateId: string
  ID (file of the state)
Returns Promise<string>
The string data of the state
- Defined in index.ts:509

getTargetApi

getTargetApi(): number
Gets the target api that the plugin is intended to work with.

Returns number
API Version as number
- Defined in index.ts:477

getThemeData

getThemeData(): Promise<ThemeData>
Gets the AHQ Store Theme Data

NOTE
The returned data does not automatically update with theme changes

Returns Promise<ThemeData>
The theme data ThemeData
- Defined in index.ts:551

hasCapability

hasCapability(capability: Capability): boolean
Parameters
- capability: Capability
Returns boolean
True is the capability is present
- Defined in index.ts:750

initialize

initialize(): Promise<void>
Initializes the AHQ Store Plugin

If you don't call it, the plugin manager will kill your process

Returns Promise<void>
Throws
If it failed to initialize
- Defined in index.ts:427

injectCustomCss

injectCustomCss(css: string): Promise<void>
Injects the provided css into the client gui application

NOTE
This modifies the already injected css to the new css data

Please note the above
Parameters
- css: string
  The css string to inject
Returns Promise<void>
- Defined in index.ts:492

on

on(event: "themeUpdate", handler: (data: ThemeData) => void): UnregisterFn
Parameters
- event: "themeUpdate"
- handler: (data: ThemeData) => void
Returns UnregisterFn
- Defined in index.ts:754
on(event: "commonStateUpdate", handler: (data: undefined) => void): UnregisterFn
Parameters
- event: "commonStateUpdate"
- handler: (data: undefined) => void
Returns UnregisterFn
- Defined in index.ts:755

registerAppAssetFetchFn

registerAppAssetFetchFn(fn: GetApplicationAssetFn): void
Register a function and overrides the current function meant to provide application metadata
Parameters
- fn: GetApplicationAssetFn
  The fn itself
Returns void
- Defined in index.ts:738

registerAppFetchFn

registerAppFetchFn(fn: GetApplicationFn): void
Register a function and overrides the current function meant to provide application metadata
Parameters
- fn: GetApplicationFn
  The fn itself
Returns void
- Defined in index.ts:716

registerAppVersionFetchFn

registerAppVersionFetchFn(fn: GetApplicationVersionsFn): void
Register a function and overrides the current function meant to provide application versions
Parameters
- fn: GetApplicationVersionsFn
  The fn itself
Returns void
- Defined in index.ts:727

registerSearchFn

registerSearchFn(fn: SearchFn): void
Register the search function and overrides the current search function if present

You can only register it if you have Capability.AppInstallationSource
Parameters
- fn: SearchFn
  The search fn itself
Returns void
- Defined in index.ts:705

requestRestart

requestRestart(desc?: string): Promise<void>
Requests the user to restart

NOTE
This does not guarantee restart
Parameters
- desc: string = "A restart is required to apply custom theme data. Are you ready?"
  Explain why you would like to restart (optional, a template is already provided)
Returns Promise<void>
- Defined in index.ts:572

setState

setState(stateId: string, stateData: string): Promise<string>
Sets the state under the stateId specified
Parameters
- stateId: string
  ID (file of the state)
- stateData: string
  Data of the state to update it with
Returns Promise<string>
The string data of the state
- Defined in index.ts:527

unsafeAddCustomOnMessage

unsafeAddCustomOnMessage(fn: OnMessageCallback): void
Experimental
Add your own custom handler to the OnMessage
Parameters
- fn: OnMessageCallback
Returns void
Deprecated
This is unsafe and hence marked deprecated This is unsafe and hence marked so
- Defined in index.ts:641

`Static`getInstance

getInstance(): Plugin | undefined
Returns the single instance of the Plugin. If the instance does not exist, it returns nothing.

Returns Plugin | undefined
The single Plugin instance.
- Defined in index.ts:693

Class Plugin

Index

Constructors

Methods

Constructors

constructor

You must call initialize afterwards

Parameters

Returns Plugin

Methods

fetch

Note

Parameters

Returns Promise<HTTPOutput>

getCapabilities

Returns Set<Capability>

getHostApi

Returns number

getState

Parameters

Returns Promise<string>

getTargetApi

Returns number

getThemeData

NOTE

Returns Promise<ThemeData>

hasCapability

Parameters

Returns boolean

initialize

Returns Promise<void>

Throws

injectCustomCss

NOTE

Parameters

Returns Promise<void>

on

Parameters

Returns UnregisterFn

Parameters

Returns UnregisterFn

registerAppAssetFetchFn

Parameters

Returns void

registerAppFetchFn

Parameters

Returns void

registerAppVersionFetchFn

Parameters

Returns void

registerSearchFn

Parameters

Returns void

requestRestart

NOTE

Parameters

Returns Promise<void>

setState

Parameters

Returns Promise<string>

unsafeAddCustomOnMessage

Parameters

Returns void

Deprecated

StaticgetInstance

Returns Plugin | undefined

Settings

On This Page

`Static`getInstance