Class WindowWriter

Client for managing maintenance window configurations and media uploads.

Provides full write access to the Brave Ship maintenance window system, including creating, updating, and deleting downtime schedules.

Example

const writer = new WindowWriter({
  api: 'https://api.farmart.com/api/v1',
  getIdToken: async () => await user.getIdToken(),
  workspace: 'production'
});

await writer.registerFeatureConfig('my_app', {
  plannedReleases: [{
    downtimeStartAt: '2024-01-01T10:00:00Z',
    downtimeEndAt: '2024-01-01T12:00:00Z',
    scopes: ['web']
  }]
});

Index

Constructors

constructor

Methods

deleteFeatureConfig registerFeatureConfig updateFeatureConfig uploadImage

Constructors

constructor

new WindowWriter(options: IWindowWriterOptions): WindowWriter
Creates a new WindowWriter client instance.
Parameters
- options: IWindowWriterOptions
  Configuration options
Returns WindowWriter
- Defined in sdk/admin-sdk/src/window-writer.ts:50

Methods

deleteFeatureConfig

deleteFeatureConfig(featureName: string): Promise<void>
Deletes a maintenance window configuration.
Parameters
- featureName: string
  Name of the feature to delete
Returns Promise<void>
- Defined in sdk/admin-sdk/src/window-writer.ts:111

registerFeatureConfig

registerFeatureConfig(
featureName: string,
featureConfig: FeatureRemoteConfig,
): Promise<void>
Registers a new maintenance window configuration.
Parameters
- featureName: string
  Name of the feature or application (must be snake_case)
- featureConfig: FeatureRemoteConfig
  Initial maintenance configuration
Returns Promise<void>
Example
```
await writer.registerFeatureConfig('payment_service', {
  plannedReleases: [...]
});
```
- Defined in sdk/admin-sdk/src/window-writer.ts:77

updateFeatureConfig

updateFeatureConfig(
featureName: string,
featureConfig: Partial<FeatureRemoteConfig>,
): Promise<void>
Updates an existing maintenance window configuration.
Parameters
- featureName: string
  Name of the feature to update
- featureConfig: Partial<FeatureRemoteConfig>
  Partial configuration updates
Returns Promise<void>
- Defined in sdk/admin-sdk/src/window-writer.ts:95

uploadImage

uploadImage(
    file: File,
    folder: string,
    onUploadProgress: ((progressEvent: AxiosProgressEvent) => void) | undefined,
): Promise<string>
Uploads a file (e.g., image for maintenance page) to the media storage.
Parameters
- file: File
  File object to upload
- folder: string
  Target folder in storage
- onUploadProgress: ((progressEvent: AxiosProgressEvent) => void) | undefined
  Optional callback for tracking upload progress
Returns Promise<string>
The public download URL of the uploaded file
Example
```
const imageUrl = await writer.uploadImage(file, 'maintenance-banners');
```
- Defined in sdk/admin-sdk/src/window-writer.ts:133

Class WindowWriter

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WindowWriter

Methods

deleteFeatureConfig

Parameters

Returns Promise<void>

registerFeatureConfig

Parameters

Returns Promise<void>

Example

updateFeatureConfig

Parameters

Returns Promise<void>

uploadImage

Parameters

Returns Promise<string>

Example

Settings

On This Page