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

Constructors

constructor

new default(ref?: null | string): default
Parameters
- ref: null | string = null
Returns default
Overrides default.constructor
- Defined in v0.10/api/component.ts:25

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

aggregate

aggregate(pipeline: FindAggregateParams): AggregateChainable
Execute aggregate pipeline with optional streaming support

Returns a chainable object that allows both buffered and streaming modes. Call .onData() to enable streaming mode, or await directly for buffered mode.
Parameters
- pipeline: FindAggregateParams
  MongoDB aggregation pipeline
Returns AggregateChainable
Chainable object with streaming methods and Promise interface
Example
```
// Buffered response (default, up to 5K documents)
const result = await component.aggregate([{ $match: { status: 'active' } }]);
console.log(result.data); // All results at once

// Streaming response (up to 25K documents)
await component.aggregate([{ $match: { status: 'active' } }])
  .onData((doc) => console.log('Received:', doc))
  .onError((err) => console.error('Error:', err))
  .onEnd(() => console.log('Stream complete'));
```
- Defined in v0.10/api/component.ts:300

concurrentUpdate

concurrentUpdate(
    uuid: string,
    version: number,
    data: Record<string, any>,
    options: UpdateOptions,
): Promise<AxiosResponse<any, any>>
Concurrent update model by uuid with optimistic locking

Uses version-based concurrency control — the update will fail with a conflict error if the document has been modified since the provided version. Supports inline update operators in the data payload.
Parameters
- uuid: string
  The uuid of the model
- version: number
  The expected version of the model
- data: Record<string, any>
  Fields to update, optionally including update operators
- options: UpdateOptions
  Update options
Returns Promise<AxiosResponse<any, any>>
The updated model
Example
```
await component.concurrentUpdate(uuid, model.__version__, {
  status: "processed",
  $inc: { retry_count: 1 }
}, opts)
```
- Defined in v0.10/api/component.ts:261

create

create(model: Record<string, any>): Promise<AxiosResponse<any, any>>
Parameters
- model: Record<string, any>
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:269

createMany

createMany(
data: Record<string, any>[],
options: CreateManyOptions,
): Promise<AxiosResponse<any, any>>
Create many models
Parameters
- data: Record<string, any>[]
- options: CreateManyOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:209

delete

delete(uuid: string): Promise<AxiosResponse<any, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:273

deleteExtension

deleteExtension(name: string, version: string): Promise<AxiosResponse<any, any>>
Delete an extension from the component
Parameters
- name: string
  The name of the extension to delete
- version: string
  The component version
Returns Promise<AxiosResponse<any, any>>
Updated component settings
Example
```
await component.deleteExtension('shipping_tracker', '0.1.0')
```
- Defined in v0.10/api/component.ts:469

deletePolicy

deletePolicy(name: string, version: string): Promise<AxiosResponse<any, any>>
Delete a policy from the component
Parameters
- name: string
  The name of the policy to delete
- version: string
  The component version
Returns Promise<AxiosResponse<any, any>>
Updated component settings
Example
```
await component.deletePolicy('restrict_email', '0.1.0')
```
- Defined in v0.10/api/component.ts:543

find

find(
filters: FindParams,
opts?: FindOptions,
): Promise<AxiosResponse<FindResponse, any>>
Find method to search for models
Parameters
- filters: FindParams
  The filters to apply to the search
- Optionalopts: FindOptions
  The options to apply to the search
Returns Promise<AxiosResponse<FindResponse, any>>
- The result of the search
Example
```
platform.component(name).find({
    currentPage: 1,
    perPage: 10,
})

// advanced search
platform.component(name).find({
    $adv: {
        name: "John Doe",
    }
)
```
- Defined in v0.10/api/component.ts:51

findOne

findOne(filter: FindAdvancedParams, opts: FindOptions): Promise<null | Model>
FindOne method to search for a single model
Parameters
- filter: FindAdvancedParams
  The filters to apply to the search
- opts: FindOptions
  The options to apply to the search
Returns Promise<null | Model>
- The result of the search
Example
```
platform.component(name).findOne({
    name: "John Doe",
})
```
- Defined in v0.10/api/component.ts:133

function

function(name: string, input: any): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- input: any
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:390

get

get(uuid: string): Promise<AxiosResponse<Model, any>>
Get model by uuid
Parameters
- uuid: string
  string - The uuid of the model
Returns Promise<AxiosResponse<Model, any>>
(Promise)
- Defined in v0.10/api/component.ts:153

getExtension

getExtension(name: string, version: string): Promise<AxiosResponse<any, any>>
Get a single extension by name from the component
Parameters
- name: string
  The name of the extension to retrieve
- version: string
  The component version
Returns Promise<AxiosResponse<any, any>>
The extension object
Example
```
const extension = await component.getExtension('shipping_tracker', '0.1.0')
```
- Defined in v0.10/api/component.ts:412

getPolicy

getPolicy(name: string, version: string): Promise<AxiosResponse<any, any>>
Get a single policy by name from the component
Parameters
- name: string
  The name of the policy to retrieve
- version: string
  The component version
Returns Promise<AxiosResponse<any, any>>
The policy object
Example
```
const policy = await component.getPolicy('restrict_email', '0.1.0')
```
- Defined in v0.10/api/component.ts:485

installExtension

installExtension(
extension: Extension,
version: string,
): Promise<AxiosResponse<any, any>>
Install a new extension on the component
Parameters
- extension: Extension
  The extension definition to install
- version: string
  The component version to install the extension on
Returns Promise<AxiosResponse<any, any>>
Updated component settings
Example
```
await component.installExtension({
    name: 'shipping_tracker',
    is_active: true,
    fields: [...],
    config: { api_key: 'key' }
}, '0.1.0')
```
- Defined in v0.10/api/component.ts:433

installPolicy

installPolicy(policy: Policy, version: string): Promise<AxiosResponse<any, any>>
Install a new policy on the component
Parameters
- policy: Policy
  The policy definition to install
- version: string
  The component version to install the policy on
Returns Promise<AxiosResponse<any, any>>
Updated component settings
Example
```
await component.installPolicy({
    type: 'field_access',
    name: 'restrict_email',
    enabled: true,
    priority: 1,
    config: { fields: ['email'], actions: ['see'], roles: ['role-uuid'] }
}, '0.1.0')
```
- Defined in v0.10/api/component.ts:507

modify

modify(
    filters: Record<string, any>,
    data: Record<string, any>,
    options: ModifyOptions,
): Promise<AxiosResponse<any, any>>
Modify models by filters

Updates all models matching the given filters. Supports inline update operators in the data payload for granular operations.
Parameters
- filters: Record<string, any>
  Query filters to match models
- data: Record<string, any>
  Fields to update, optionally including update operators
- options: ModifyOptions
  Modify options (e.g. upsert)
Returns Promise<AxiosResponse<any, any>>
The modified models
Example
```
await component.modify(
  { status: "active" },
  { $inc: { impression_count: 1 }, $addToSet: { viewers: "user-1" } },
  { upsert: false }
)
```
- Defined in v0.10/api/component.ts:234

publish

publish(version: string, env: string): Promise<AxiosResponse<any, any>>
Parameters
- version: string
- env: string
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:361

revisions

revisions(uuid: string): Promise<AxiosResponse<any, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:396

saveSettings

saveSettings(settings: any, version: string): Promise<AxiosResponse<any, any>>
Parameters
- settings: any
- version: string
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:369

saveTemplatesDist

saveTemplatesDist(
    version: string,
    sdkVersion: string,
    engine: string,
    dist: Record<string, string>,
): Promise<any>
Parameters
- version: string
- sdkVersion: string
- engine: string
- dist: Record<string, string>
Returns Promise<any>
- Defined in v0.10/api/component.ts:373

setClient

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

settings

settings(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:353

settingsForVersion

settingsForVersion(version: string): Promise<AxiosResponse<any, any>>
Parameters
- version: string
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:357

update

update(
    uuid: string,
    data: Record<string, any>,
    options: UpdateOptions,
): Promise<AxiosResponse<any, any>>
Update model by uuid

Regular fields in data are applied via $set. You can include MongoDB update operators (prefixed with $) directly in the data object for granular updates like incrementing, pushing to arrays, etc.
Parameters
- uuid: string
  The uuid of the model to update
- data: Record<string, any>
  Fields to update, optionally including update operators
- options: UpdateOptions
  Update options
Returns Promise<AxiosResponse<any, any>>
The updated model
Example
```
// Simple update (backwards compatible)
await component.update(uuid, { name: "John" }, opts)

// With update operators
await component.update(uuid, {
  name: "John",
  $inc: { login_count: 1 },
  $push: { tags: "verified" },
  $addToSet: { roles: "admin" }
}, opts)
```
- Defined in v0.10/api/component.ts:181

updateExtension

updateExtension(
    name: string,
    version: string,
    data: Partial<Extension>,
): Promise<AxiosResponse<any, any>>
Update an existing extension on the component
Parameters
- name: string
  The name of the extension to update
- version: string
  The component version
- data: Partial<Extension>
  Partial extension data to update
Returns Promise<AxiosResponse<any, any>>
Updated component settings
Example
```
await component.updateExtension('shipping_tracker', '0.1.0', {
    is_active: false,
    config: { api_key: 'new-key' }
})
```
- Defined in v0.10/api/component.ts:453

updateMany

updateMany(
data: Record<string, any>[],
options: UpdateManyOptions,
): Promise<AxiosResponse<any, any>>
Update many models
Parameters
- data: Record<string, any>[]
- options: UpdateManyOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:195

updatePolicy

updatePolicy(
    name: string,
    version: string,
    data: Partial<Policy>,
): Promise<AxiosResponse<any, any>>
Update an existing policy on the component
Parameters
- name: string
  The name of the policy to update
- version: string
  The component version
- data: Partial<Policy>
  Partial policy data to update
Returns Promise<AxiosResponse<any, any>>
Updated component settings
Example
```
await component.updatePolicy('restrict_email', '0.1.0', {
    enabled: false,
    priority: 2
})
```
- Defined in v0.10/api/component.ts:527

workflow

workflow(event: string, input: any): Promise<AxiosResponse<any, any>>
Parameters
- event: string
- input: any
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/component.ts:383

Class default

Param: client

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

client

Protectedenv

Protectedhost

Protectedtoken

Methods

aggregate

Parameters

Returns AggregateChainable

Example

concurrentUpdate

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

create

Parameters

Returns Promise<AxiosResponse<any, any>>

createMany

Parameters

Returns Promise<AxiosResponse<any, any>>

delete

Parameters

Returns Promise<AxiosResponse<any, any>>

deleteExtension

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

deletePolicy

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

find

Parameters

Returns Promise<AxiosResponse<FindResponse, any>>

Example

findOne

Parameters

Returns Promise<null | Model>

Example

function

Parameters

Returns Promise<AxiosResponse<any, any>>

get

Parameters

Returns Promise<AxiosResponse<Model, any>>

getExtension

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

getPolicy

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

installExtension

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

installPolicy

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

modify

Parameters

Returns Promise<AxiosResponse<any, any>>

Example

publish

Parameters

Returns Promise<AxiosResponse<any, any>>

`Protected`env

`Protected`host

`Protected`token