Class ChRISPlugin

Class for managing individual ChRIS plugins.

Index

Constructors

Methods

client_get plugin_existsInCube plugin_getComputeResources plugin_listPeerStore plugin_registerWithAdmin plugin_run plugin_runOnCUBE plugin_searchPeerStore pluginData_getFromSearch pluginIDs_get pluginIDs_getFromSearchable pluginIDs_resolve pluginInstance_convertToDict pluginString_makeSearchable previousID_get

Constructors

constructor

new ChRISPlugin(): ChRISPlugin
Returns ChRISPlugin
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:201

Methods

client_get

client_get(): Promise<Client | null>
Retrieves the ChRIS client instance asynchronously.

Returns Promise<Client | null>
A Promise resolving to the Client instance or null.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:209

plugin_existsInCube

plugin_existsInCube(
nameOrImage: string,
): Promise<Record<string, unknown> | null>
Checks if a plugin with given name or dock_image already exists in current CUBE.
Parameters
- nameOrImage: string
  Plugin name or docker image to search for.
Returns Promise<Record<string, unknown> | null>
Promise resolving to plugin data if found, null otherwise.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:560

plugin_getComputeResources

plugin_getComputeResources(pluginId: number): Promise<string[]>
Gets the compute resources currently assigned to a plugin.
Parameters
- pluginId: number
  ID of the plugin.
Returns Promise<string[]>
Promise resolving to array of compute resource names.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:690

plugin_listPeerStore

plugin_listPeerStore(
peerStoreUrl?: string,
searchParams?: Record<string, string>,
): Promise<Record<string, unknown>[] | null>
Lists plugins from a peer ChRIS store. Handles pagination to fetch all results.
Parameters
- peerStoreUrl: string = 'https://cube.chrisproject.org/api/v1/'
  URL of the peer store.
- OptionalsearchParams: Record<string, string>
  Optional search parameters.
Returns Promise<Record<string, unknown>[] | null>
Promise resolving to array of plugin data objects.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:597

plugin_registerWithAdmin

plugin_registerWithAdmin(
    pluginData: Record<string, unknown>,
    computeResources?: string[],
    adminToken?: string,
): Promise<Record<string, unknown> | null>
Uploads a plugin representation file to create a new plugin admin resource.

Requires admin credentials. Will push error to errorStack if authentication fails.
Parameters
- pluginData: Record<string, unknown>
  Plugin descriptor JSON data.
- computeResources: string[] = ...
  Array of compute resource names to assign plugin to.
- OptionaladminToken: string
  Optional admin authentication token (if different from current user).
Returns Promise<Record<string, unknown> | null>
Promise resolving to the created plugin data or null on failure.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:432

plugin_run

plugin_run(
plugin: string,
params: string | ChRISObjectParams,
): Promise<Dictionary | null>
Run one plugin with typed parameters or a legacy CLI parameter string.
Parameters
- plugin: string
  Plugin search selector.
- params: string | ChRISObjectParams
  Typed plugin parameters, or a legacy CLI string.
Returns Promise<Dictionary | null>
Created plugin-instance dictionary, or null on failure.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:314

plugin_runOnCUBE

plugin_runOnCUBE(
    pluginID: number,
    previousID: number,
    options: ChRISObjectParams,
): Promise<PluginInstance | null | undefined>
Parameters
- pluginID: number
- previousID: number
- options: ChRISObjectParams
Returns Promise<PluginInstance | null | undefined>
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:262

plugin_searchPeerStore

plugin_searchPeerStore(
    pluginName: string,
    version?: string,
    peerStoreUrl?: string,
): Promise<{ plugin: Record<string, unknown>; storeUrl: string } | null>
Searches for a plugin in a peer ChRIS store (public plugin repository).

Uses anonymous client to query public plugin stores without authentication.
Parameters
- pluginName: string
  Name of the plugin to search for.
- Optionalversion: string
  Optional version of the plugin to search for.
- peerStoreUrl: string = 'https://cube.chrisproject.org/api/v1/'
  URL of the peer ChRIS store (default: cube.chrisproject.org).
Returns Promise<{ plugin: Record<string, unknown>; storeUrl: string } | null>
Promise resolving to plugin data and store URL, or null if not found.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:511

pluginData_getFromSearch

pluginData_getFromSearch(
searchOptions: ChRISElementsGet,
dataField: string | string[],
): Promise<QueryHits | null>
Parameters
- searchOptions: ChRISElementsGet
- dataField: string | string[]
Returns Promise<QueryHits | null>
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:359

pluginIDs_get

pluginIDs_get(name_exact: string): Promise<QueryHits | null>
Parameters
- name_exact: string
Returns Promise<QueryHits | null>
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:415

pluginIDs_getFromSearchable

pluginIDs_getFromSearchable(
searchable: string | Searchable,
): Promise<QueryHits | null>
Gets plugin IDs from a searchable.
Parameters
- searchable: string | Searchable
  A searchable string or Searchable object.
Returns Promise<QueryHits | null>
A Promise resolving to QueryHits containing matching plugin IDs.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:385

pluginIDs_resolve

pluginIDs_resolve(
pluginSearchable: string | Searchable,
): Promise<QueryHits | null>
Resolves a searchable string or object to plugin IDs.
Parameters
- pluginSearchable: string | Searchable
  A searchable string or Searchable object.
Returns Promise<QueryHits | null>
A Promise resolving to QueryHits containing matching plugin IDs.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:230

pluginInstance_convertToDict

pluginInstance_convertToDict(
pluginInstance: PluginInstance | null | undefined,
): Dictionary | null
Parameters
- pluginInstance: PluginInstance | null | undefined
Returns Dictionary | null
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:286

pluginString_makeSearchable

pluginString_makeSearchable(plugin: string): string
Converts a plain string to a searchable format.
Parameters
- plugin: string
Returns string

Deprecated
Use Searchable.from() instead.
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:220

previousID_get

previousID_get(): Promise<number | null>
Returns Promise<number | null>
- Defined in packages/cumin/src/plugins/chrisPlugins.ts:250

Class ChRISPlugin

Index

Constructors

Methods

Constructors

constructor

Returns ChRISPlugin

Methods

client_get

Returns Promise<Client | null>

plugin_existsInCube

Parameters

Returns Promise<Record<string, unknown> | null>

plugin_getComputeResources

Parameters

Returns Promise<string[]>

plugin_listPeerStore

Parameters

Returns Promise<Record<string, unknown>[] | null>

plugin_registerWithAdmin

Parameters

Returns Promise<Record<string, unknown> | null>

plugin_run

Parameters

Returns Promise<Dictionary | null>

plugin_runOnCUBE

Parameters

Returns Promise<PluginInstance | null | undefined>

plugin_searchPeerStore

Parameters

Returns Promise<{ plugin: Record<string, unknown>; storeUrl: string } | null>

pluginData_getFromSearch

Parameters

Returns Promise<QueryHits | null>

pluginIDs_get

Parameters

Returns Promise<QueryHits | null>

pluginIDs_getFromSearchable

Parameters

Returns Promise<QueryHits | null>

pluginIDs_resolve

Parameters

Returns Promise<QueryHits | null>

pluginInstance_convertToDict

Parameters

Returns Dictionary | null

pluginString_makeSearchable

Parameters

Returns string

Deprecated

previousID_get

Returns Promise<number | null>

Settings

On This Page