Class default

Base client for the platform API Classes that extend PlatformBaseClient have intentins of only working in platform context

PlatformBaseClient

Param: client

The axios instance to use for the client

Example

// if sdk is used in the forge app that is running in the platform context
const utils = new ComponentUtils()
// this won't work outside of platform context because client needs authtorization to communicate with the API.

Hierarchy (View Summary)

default
- default

Index

Constructors

constructor

new default(options?: { env?: string; host?: string; token?: string }): default
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns default
Inherited from default.constructor
- Defined in v0.10/api/platformBaseClient.ts:24

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

addVariable

addVariable(key: string, value: any): Promise<any>
Set a single variable, preserving the rest.

A read-modify-write over a replace-everything PATCH, so concurrent writers can lose each other's updates. Prefer updateVariables when setting more than one key.
Parameters
- key: string
- value: any
Returns Promise<any>
Example
```
await platform.forge().addVariable('WEBHOOK_URL', '...')
await platform.forge().addVariable('storefront', 'WEBHOOK_URL', '...')
```
- Defined in v0.10/api/forge.ts:155
addVariable(ref: string, key: string, value: any): Promise<any>
Set a single variable, preserving the rest.

A read-modify-write over a replace-everything PATCH, so concurrent writers can lose each other's updates. Prefer updateVariables when setting more than one key.
Parameters
- ref: string
- key: string
- value: any
Returns Promise<any>
Example
```
await platform.forge().addVariable('WEBHOOK_URL', '...')
await platform.forge().addVariable('storefront', 'WEBHOOK_URL', '...')
```
- Defined in v0.10/api/forge.ts:156

bundleUpload

bundleUpload(buffer: Buffer): Promise<any>
Parameters
- buffer: Buffer
Returns Promise<any>
- Defined in v0.10/api/forge.ts:63

getVariables

getVariables(ref?: string): Promise<any>
Read variables for the current environment (X-Project-Env, defaults to dev).

With no argument this returns the CALLING APP's own variables and needs no permission at all. With a ref it reads that app's variables and needs manage forge.
Parameters
- Optionalref: string
  App uuid, name or tag. Omit for the current app.
Returns Promise<any>
Example
```
const mine = await platform.forge().getVariables()
const other = await platform.forge().getVariables('storefront')
```
- Defined in v0.10/api/forge.ts:117

getWorkspaceApps

getWorkspaceApps(): Promise<any>
Returns Promise<any>
- Defined in v0.10/api/forge.ts:72

list

list(): Promise<any>
Returns Promise<any>
- Defined in v0.10/api/forge.ts:80

listServices

listServices(ref: string): Promise<any>
Parameters
- ref: string
Returns Promise<any>
- Defined in v0.10/api/forge.ts:84

removeVersion

removeVersion(ref: string, version: string): Promise<any>
Parameters
- ref: string
- version: string
Returns Promise<any>
- Defined in v0.10/api/forge.ts:76

runService

runService(
    target: string,
    body?: any,
    options?: {
        headers?: Record<string, string>;
        query?: Record<string, string>;
    },
): Promise<any>
Run a Forge service: runService(target, body?, { query?, headers? }). Mirrors axios.post(url, data, config) — the 2nd arg is the request payload.

target is either:
- a bare service name — runs that service on the CURRENT app; or
- a service PRN prn:forge:{ref}:service/{name} — runs it on ANOTHER app, where ref is the app's name or uuid. A name is resolved by the runtime deterministically (marketplace → custom); use the uuid to pin a specific app. This is the addressing to use where there's no ambient "current app" — e.g. a workflow, which has no per-install uuid to hardcode.
body is sent as the POST body; options.query / options.headers are optional.

The current app's uuid (bare-name form) is resolved automatically from the platform context (FORGE_APP_UUID for public views, forge_app_uuid in sessionStorage for platform views), so app code never needs its own uuid.

Resolving the app does NOT grant access. Execution is still authorized against the caller's permissions — for a platform-access service the caller must hold service::{name} forge::{appUuid}; public-access services require none. An app's own runtime token is implicitly granted this for all of its own services.
Parameters
- target: string
- Optionalbody: any
- Optionaloptions: { headers?: Record<string, string>; query?: Record<string, string> }
Returns Promise<any>
- Defined in v0.10/api/forge.ts:195

setClient

setClient(client: AxiosInstance): default
Parameters
- client: AxiosInstance
Returns default
Inherited from default.setClient
- Defined in v0.10/api/baseClient.ts:10

updateVariables

updateVariables(variables: ForgeVariables): Promise<any>
Replace the variable set for the current environment.

This REPLACES the whole set for that environment — keys absent from variables are removed. The other environment is left untouched.

The self form needs manage_variables forge, which only ever writes the calling app. Targeting another app by ref needs manage forge.
Parameters
- variables: ForgeVariables
Returns Promise<any>
Example
```
await platform.forge().updateVariables({ WEBHOOK_URL: '...' })
await platform.forge().updateVariables('storefront', { WEBHOOK_URL: '...' })
```
- Defined in v0.10/api/forge.ts:134
updateVariables(ref: string, variables: ForgeVariables): Promise<any>
Replace the variable set for the current environment.

This REPLACES the whole set for that environment — keys absent from variables are removed. The other environment is left untouched.

The self form needs manage_variables forge, which only ever writes the calling app. Targeting another app by ref needs manage forge.
Parameters
- ref: string
- variables: ForgeVariables
Returns Promise<any>
Example
```
await platform.forge().updateVariables({ WEBHOOK_URL: '...' })
await platform.forge().updateVariables('storefront', { WEBHOOK_URL: '...' })
```
- Defined in v0.10/api/forge.ts:135

Class default

Param: client

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

client

Protectedenv

Protectedhost

Protectedtoken

Methods

addVariable

Parameters

Returns Promise<any>

Example

Parameters

Returns Promise<any>

Example

bundleUpload

Parameters

Returns Promise<any>

getVariables

Parameters

Returns Promise<any>

Example

getWorkspaceApps

Returns Promise<any>

list

Returns Promise<any>

listServices

Parameters

Returns Promise<any>

removeVersion

Parameters

Returns Promise<any>

runService

Parameters

Returns Promise<any>

setClient

Parameters

Returns default

updateVariables

Parameters

Returns Promise<any>

Example

Parameters

Returns Promise<any>

Example

Settings

On This Page

`Protected`env

`Protected`host

`Protected`token