Class Plugin

constructor

• new Plugin(o: Plugin | PluginCfg): Plugin

  Plugin constructor

  Parameters

  • o: Plugin | PluginCfg

  Returns Plugin

Optionalconfiguration

Optionalcontents

Optionaldeploy_private_key

Optionaldescription

Optionaldocumentation_link

Optionalhas_auth

Optionalhas_theme

Optionalid

location

name

source

Optionalunsafe

Optionalversion

Staticlocal_store_entries_exists

• get local_store_entries_exists(): boolean

  Returns boolean

Staticlocal_store_entries_filepath

• get local_store_entries_filepath(): string

  Returns string

delete

• delete(): Promise<void>

  Delete plugin

  Returns Promise<void>

dependant_views

• dependant_views(): Promise<string[]>

  List of views relay on this plugin

  Returns Promise<string[]>

exclude_from_mobile

• exclude_from_mobile(): boolean

  Returns boolean

ready_for_mobile

• ready_for_mobile(): boolean

  Returns boolean

upgrade_version

• upgrade_version(
      requirePlugin: (arg0: Plugin, arg1: boolean) => Plugin,
      newVersion?: string,
  ): Promise<void>

  Upgrade plugin version

  Parameters

  • requirePlugin: (arg0: Plugin, arg1: boolean) => Plugin
  • OptionalnewVersion: string

  Returns Promise<void>

upsert

• upsert(): Promise<void>

  Update or Insert plugin

  Returns Promise<void>

StaticensurePluginSupport

• ensurePluginSupport(plugin: Plugin, forceFetch?: boolean): Promise<void>

  Check the saltcorn engine property and change the plugin version if necessary

  Parameters

  • plugin: Plugin

    plugin to validate; plugin.version may be mutated

  • OptionalforceFetch: boolean

    bypass the engine-info cache when checking versions

  Returns Promise<void>

Staticfind

• find(where?: Where, selectopts?: SelectOptions): Promise<Plugin[]>

  Find plugins

  Parameters

  • Optionalwhere: Where

    where object

  • Optionalselectopts: SelectOptions

  Returns Promise<Plugin[]>

  returns plugins list

StaticfindOne

• findOne(where: Where): Promise<Plugin | null>

  Find one plugin

  Parameters

  • where: Where

    where object

  Returns Promise<Plugin | null>

  return existing plugin or new plugin

Staticget_cached_plugins

• get_cached_plugins(): Plugin[]

  Returns Plugin[]

StaticgetEngineInfos

• getEngineInfos(plugin: Plugin, forceFetch?: boolean): Promise<any>

  Return cached engine constraint metadata for a plugin, fetching from npm if needed

  Parameters

  • plugin: Plugin

    plugin whose npm location is queried

  • OptionalforceFetch: boolean

    bypass the cache and re-fetch from npm

  Returns Promise<any>

  map of { version: { engines?: { saltcorn: string } } }

Staticis_fixed_plugin

• is_fixed_plugin(name: string): boolean

  check if plugin is base-plugin or sbadmin2

  Parameters

  • name: string

  Returns boolean

StaticloadAllPlugins

• loadAllPlugins(force?: boolean, reloadModule?: boolean): Promise<void>

  Load all plugins from the database into state

  Parameters

  • Optionalforce: boolean

    passed through to loadPlugin for each plugin

  • reloadModule: boolean = false

    force fresh module loads for each plugin

  Returns Promise<void>

StaticloadAndSaveNewPlugin

• loadAndSaveNewPlugin(
      plugin: Plugin,
      force?: boolean,
      noSignalOrDB?: boolean,
      __?: (str: string, ...args: any[]) => string,
      allowUnsafeOnTenantsWithoutConfigSetting?: boolean,
      overwriteDependencies?: Record<string, string>,
  ): Promise<string[] | undefined>

  Load plugin and its dependencies and save into local installation

  Parameters

  • plugin: Plugin

    plugin to install

  • Optionalforce: boolean

    force reinstall; retries after removing the install dir on failure

  • OptionalnoSignalOrDB: boolean

    skip database upsert and processSend signal (e.g. during restore)

  • __: (str: string, ...args: any[]) => string = ...

    i18n translation function for user-facing messages

  • OptionalallowUnsafeOnTenantsWithoutConfigSetting: boolean

    allow unsafe plugins on tenants without the global config flag

  • OptionaloverwriteDependencies: Record<string, string>

    substitute local paths for dependencies; testing only

  Returns Promise<string[] | undefined>

  warning/info messages collected during install, or undefined if skipped

StaticloadPlugin

• loadPlugin(
      plugin: Plugin,
      force?: boolean,
      forceFetch?: boolean,
      reloadModule?: boolean,
  ): Promise<any>

  Load one plugin and register in state (without DB save)

  Parameters

  • plugin: Plugin

    plugin to load

  • Optionalforce: boolean

    remove the install directory and retry on registration failure

  • OptionalforceFetch: boolean

    bypass the engine-info cache when resolving versions

  • reloadModule: boolean = false

    force a fresh module load even if already cached

  Returns Promise<any>

  PluginInstaller result ({ plugin_module, location, … })

Staticread_local_store_entries

• read_local_store_entries(): Promise<any>

  Returns Promise<any>

StaticrequirePlugin

• requirePlugin(plugin: Plugin, force?: boolean): Promise<any>

  Install plugin without registering in state or saving to database

  Parameters

  • plugin: Plugin

    plugin to install

  • Optionalforce: boolean

    force reinstall even if already present

  Returns Promise<any>

  PluginInstaller result ({ plugin_module, location, version, … })

Staticstore_by_name

• store_by_name(name: string, endpoint?: string): Promise<Plugin | null>

  Parameters

  • name: string
  • Optionalendpoint: string

  Returns Promise<Plugin | null>

Staticstore_plugins_available

• store_plugins_available(msgs?: string[]): Promise<Plugin[]>

  List plugins available in store

  Parameters

  • Optionalmsgs: string[]

    optional packages/plugins-loader/plugin_installer.jsmessages array

  Returns Promise<Plugin[]>

Staticstore_plugins_available_from_store

• store_plugins_available_from_store(endpoint?: string): Promise<Plugin[]>

  Parameters

  • Optionalendpoint: string

  Returns Promise<Plugin[]>