diff --git a/packages/altair-docs/.gitignore b/packages/altair-docs/.gitignore index 80e2d0b92d..611734c895 100644 --- a/packages/altair-docs/.gitignore +++ b/packages/altair-docs/.gitignore @@ -1,3 +1,6 @@ .vitepress/cache .vitepress/dist .vitepress/.temp + +# generated docs +api/core/ \ No newline at end of file diff --git a/packages/altair-docs/.vitepress/config.mts b/packages/altair-docs/.vitepress/config.mts index e8251aac2e..22b73145d3 100644 --- a/packages/altair-docs/.vitepress/config.mts +++ b/packages/altair-docs/.vitepress/config.mts @@ -1,6 +1,6 @@ import { defineConfig } from 'vitepress'; import { getConfig } from './plugins/sidebar-generation'; -import typedocSidebar from '../api/typedoc-sidebar.json'; +import coreApiSidebar from '../api/core/typedoc-sidebar.json'; const { sidebar: retrievedSidebar } = getConfig({ filter: (meta) => meta.sidebar !== false, @@ -86,9 +86,10 @@ export default defineConfig({ sidebar: [ retrievedSidebar[0], { - text: 'API', - link: '/api/', - items: typedocSidebar, + text: 'Core API', + link: '/api/core/', + items: coreApiSidebar, + collapsed: true, }, ], socialLinks: [ diff --git a/packages/altair-docs/api/authorization/authorization-provider/classes/AuthorizationProvider.md b/packages/altair-docs/api/authorization/authorization-provider/classes/AuthorizationProvider.md deleted file mode 100644 index 951d85d0e1..0000000000 --- a/packages/altair-docs/api/authorization/authorization-provider/classes/AuthorizationProvider.md +++ /dev/null @@ -1,54 +0,0 @@ -# `abstract` AuthorizationProvider\ - -## Extended by - -- [`default`](../../providers/api-key/classes/default.md) -- [`default`](../../providers/basic/classes/default.md) -- [`default`](../../providers/bearer/classes/default.md) -- [`default`](../../providers/oauth2/classes/default.md) - -## Type parameters - -• **T** = `unknown` - -## Constructors - -### new AuthorizationProvider() - -> **new AuthorizationProvider**\<`T`\>(`hydrator`: (`data`: `string`) => `string`): [`AuthorizationProvider`](AuthorizationProvider.md)\<`T`\> - -#### Parameters - -• **hydrator** - -#### Returns - -[`AuthorizationProvider`](AuthorizationProvider.md)\<`T`\> - -## Methods - -### execute() - -> `abstract` **execute**(`options`: [`AuthorizationProviderExecuteOptions`](../interfaces/AuthorizationProviderExecuteOptions.md)\<`T`\>): `Promise`\<[`AuthorizationResult`](../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Parameters - -• **options**: [`AuthorizationProviderExecuteOptions`](../interfaces/AuthorizationProviderExecuteOptions.md)\<`T`\> - -#### Returns - -`Promise`\<[`AuthorizationResult`](../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -*** - -### hydrate() - -> **hydrate**(`data`: `string`): `string` - -#### Parameters - -• **data**: `string` - -#### Returns - -`string` diff --git a/packages/altair-docs/api/authorization/authorization-provider/index.md b/packages/altair-docs/api/authorization/authorization-provider/index.md deleted file mode 100644 index 650782f100..0000000000 --- a/packages/altair-docs/api/authorization/authorization-provider/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# authorization/authorization-provider - -## Index - -| Member | Description | -| :------ | :------ | -| [AuthorizationProvider](classes/AuthorizationProvider.md) | - | -| [AuthorizationProviderExecuteOptions](interfaces/AuthorizationProviderExecuteOptions.md) | - | diff --git a/packages/altair-docs/api/authorization/authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md b/packages/altair-docs/api/authorization/authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md deleted file mode 100644 index fcee246639..0000000000 --- a/packages/altair-docs/api/authorization/authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# AuthorizationProviderExecuteOptions\ - -## Type parameters - -• **T** = `unknown` - -## Properties - -### data - -> **data**: `T` diff --git a/packages/altair-docs/api/authorization/providers/api-key/classes/default.md b/packages/altair-docs/api/authorization/providers/api-key/classes/default.md deleted file mode 100644 index d1d5d608af..0000000000 --- a/packages/altair-docs/api/authorization/providers/api-key/classes/default.md +++ /dev/null @@ -1,59 +0,0 @@ -# default - -## Extends - -- [`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md)\<[`ApiKeyAuthorizationProviderData`](../interfaces/ApiKeyAuthorizationProviderData.md)\> - -## Constructors - -### new default() - -> **new default**(`hydrator`: (`data`: `string`) => `string`): [`default`](default.md) - -#### Parameters - -• **hydrator** - -#### Returns - -[`default`](default.md) - -#### Inherited from - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`constructor`](../../../authorization-provider/classes/AuthorizationProvider.md#constructors) - -## Methods - -### execute() - -> **execute**(`options`: [`AuthorizationProviderExecuteOptions`](../../../authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md)\<[`ApiKeyAuthorizationProviderData`](../interfaces/ApiKeyAuthorizationProviderData.md)\>): `Promise`\<[`AuthorizationResult`](../../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Parameters - -• **options**: [`AuthorizationProviderExecuteOptions`](../../../authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md)\<[`ApiKeyAuthorizationProviderData`](../interfaces/ApiKeyAuthorizationProviderData.md)\> - -#### Returns - -`Promise`\<[`AuthorizationResult`](../../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Overrides - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`execute`](../../../authorization-provider/classes/AuthorizationProvider.md#execute) - -*** - -### hydrate() - -> **hydrate**(`data`: `string`): `string` - -#### Parameters - -• **data**: `string` - -#### Returns - -`string` - -#### Inherited from - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`hydrate`](../../../authorization-provider/classes/AuthorizationProvider.md#hydrate) diff --git a/packages/altair-docs/api/authorization/providers/api-key/index.md b/packages/altair-docs/api/authorization/providers/api-key/index.md deleted file mode 100644 index b86b56dcc6..0000000000 --- a/packages/altair-docs/api/authorization/providers/api-key/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# authorization/providers/api-key - -## Index - -| Member | Description | -| :------ | :------ | -| [default](classes/default.md) | - | -| [ApiKeyAuthorizationProviderData](interfaces/ApiKeyAuthorizationProviderData.md) | - | diff --git a/packages/altair-docs/api/authorization/providers/api-key/interfaces/ApiKeyAuthorizationProviderData.md b/packages/altair-docs/api/authorization/providers/api-key/interfaces/ApiKeyAuthorizationProviderData.md deleted file mode 100644 index ca39d69ced..0000000000 --- a/packages/altair-docs/api/authorization/providers/api-key/interfaces/ApiKeyAuthorizationProviderData.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApiKeyAuthorizationProviderData - -## Properties - -### key - -> **key**: `string` - -*** - -### value - -> **value**: `string` diff --git a/packages/altair-docs/api/authorization/providers/basic/classes/default.md b/packages/altair-docs/api/authorization/providers/basic/classes/default.md deleted file mode 100644 index ba95190b7b..0000000000 --- a/packages/altair-docs/api/authorization/providers/basic/classes/default.md +++ /dev/null @@ -1,59 +0,0 @@ -# default - -## Extends - -- [`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md)\<[`BasicAuthorizationProviderData`](../interfaces/BasicAuthorizationProviderData.md)\> - -## Constructors - -### new default() - -> **new default**(`hydrator`: (`data`: `string`) => `string`): [`default`](default.md) - -#### Parameters - -• **hydrator** - -#### Returns - -[`default`](default.md) - -#### Inherited from - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`constructor`](../../../authorization-provider/classes/AuthorizationProvider.md#constructors) - -## Methods - -### execute() - -> **execute**(`options`: [`AuthorizationProviderExecuteOptions`](../../../authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md)\<[`BasicAuthorizationProviderData`](../interfaces/BasicAuthorizationProviderData.md)\>): `Promise`\<[`AuthorizationResult`](../../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Parameters - -• **options**: [`AuthorizationProviderExecuteOptions`](../../../authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md)\<[`BasicAuthorizationProviderData`](../interfaces/BasicAuthorizationProviderData.md)\> - -#### Returns - -`Promise`\<[`AuthorizationResult`](../../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Overrides - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`execute`](../../../authorization-provider/classes/AuthorizationProvider.md#execute) - -*** - -### hydrate() - -> **hydrate**(`data`: `string`): `string` - -#### Parameters - -• **data**: `string` - -#### Returns - -`string` - -#### Inherited from - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`hydrate`](../../../authorization-provider/classes/AuthorizationProvider.md#hydrate) diff --git a/packages/altair-docs/api/authorization/providers/basic/index.md b/packages/altair-docs/api/authorization/providers/basic/index.md deleted file mode 100644 index 8b7f247778..0000000000 --- a/packages/altair-docs/api/authorization/providers/basic/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# authorization/providers/basic - -## Index - -| Member | Description | -| :------ | :------ | -| [default](classes/default.md) | - | -| [BasicAuthorizationProviderData](interfaces/BasicAuthorizationProviderData.md) | - | diff --git a/packages/altair-docs/api/authorization/providers/basic/interfaces/BasicAuthorizationProviderData.md b/packages/altair-docs/api/authorization/providers/basic/interfaces/BasicAuthorizationProviderData.md deleted file mode 100644 index 3379f889d9..0000000000 --- a/packages/altair-docs/api/authorization/providers/basic/interfaces/BasicAuthorizationProviderData.md +++ /dev/null @@ -1,13 +0,0 @@ -# BasicAuthorizationProviderData - -## Properties - -### password - -> **password**: `string` - -*** - -### username - -> **username**: `string` diff --git a/packages/altair-docs/api/authorization/providers/bearer/classes/default.md b/packages/altair-docs/api/authorization/providers/bearer/classes/default.md deleted file mode 100644 index 2be994bb39..0000000000 --- a/packages/altair-docs/api/authorization/providers/bearer/classes/default.md +++ /dev/null @@ -1,59 +0,0 @@ -# default - -## Extends - -- [`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md)\<[`BearerAuthorizationProviderData`](../interfaces/BearerAuthorizationProviderData.md)\> - -## Constructors - -### new default() - -> **new default**(`hydrator`: (`data`: `string`) => `string`): [`default`](default.md) - -#### Parameters - -• **hydrator** - -#### Returns - -[`default`](default.md) - -#### Inherited from - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`constructor`](../../../authorization-provider/classes/AuthorizationProvider.md#constructors) - -## Methods - -### execute() - -> **execute**(`options`: [`AuthorizationProviderExecuteOptions`](../../../authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md)\<[`BearerAuthorizationProviderData`](../interfaces/BearerAuthorizationProviderData.md)\>): `Promise`\<[`AuthorizationResult`](../../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Parameters - -• **options**: [`AuthorizationProviderExecuteOptions`](../../../authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md)\<[`BearerAuthorizationProviderData`](../interfaces/BearerAuthorizationProviderData.md)\> - -#### Returns - -`Promise`\<[`AuthorizationResult`](../../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Overrides - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`execute`](../../../authorization-provider/classes/AuthorizationProvider.md#execute) - -*** - -### hydrate() - -> **hydrate**(`data`: `string`): `string` - -#### Parameters - -• **data**: `string` - -#### Returns - -`string` - -#### Inherited from - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`hydrate`](../../../authorization-provider/classes/AuthorizationProvider.md#hydrate) diff --git a/packages/altair-docs/api/authorization/providers/bearer/index.md b/packages/altair-docs/api/authorization/providers/bearer/index.md deleted file mode 100644 index c123caac08..0000000000 --- a/packages/altair-docs/api/authorization/providers/bearer/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# authorization/providers/bearer - -## Index - -| Member | Description | -| :------ | :------ | -| [default](classes/default.md) | - | -| [BearerAuthorizationProviderData](interfaces/BearerAuthorizationProviderData.md) | - | diff --git a/packages/altair-docs/api/authorization/providers/bearer/interfaces/BearerAuthorizationProviderData.md b/packages/altair-docs/api/authorization/providers/bearer/interfaces/BearerAuthorizationProviderData.md deleted file mode 100644 index 848087f994..0000000000 --- a/packages/altair-docs/api/authorization/providers/bearer/interfaces/BearerAuthorizationProviderData.md +++ /dev/null @@ -1,7 +0,0 @@ -# BearerAuthorizationProviderData - -## Properties - -### token - -> **token**: `string` diff --git a/packages/altair-docs/api/authorization/providers/oauth2/classes/default.md b/packages/altair-docs/api/authorization/providers/oauth2/classes/default.md deleted file mode 100644 index 9964c7244b..0000000000 --- a/packages/altair-docs/api/authorization/providers/oauth2/classes/default.md +++ /dev/null @@ -1,59 +0,0 @@ -# default - -## Extends - -- [`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md)\<[`OAuth2AuthorizationProviderData`](../interfaces/OAuth2AuthorizationProviderData.md)\> - -## Constructors - -### new default() - -> **new default**(`hydrator`: (`data`: `string`) => `string`): [`default`](default.md) - -#### Parameters - -• **hydrator** - -#### Returns - -[`default`](default.md) - -#### Inherited from - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`constructor`](../../../authorization-provider/classes/AuthorizationProvider.md#constructors) - -## Methods - -### execute() - -> **execute**(`options`: [`AuthorizationProviderExecuteOptions`](../../../authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md)\<[`OAuth2AuthorizationProviderData`](../interfaces/OAuth2AuthorizationProviderData.md)\>): `Promise`\<[`AuthorizationResult`](../../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Parameters - -• **options**: [`AuthorizationProviderExecuteOptions`](../../../authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md)\<[`OAuth2AuthorizationProviderData`](../interfaces/OAuth2AuthorizationProviderData.md)\> - -#### Returns - -`Promise`\<[`AuthorizationResult`](../../../../types/state/authorization.interface/interfaces/AuthorizationResult.md)\> - -#### Overrides - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`execute`](../../../authorization-provider/classes/AuthorizationProvider.md#execute) - -*** - -### hydrate() - -> **hydrate**(`data`: `string`): `string` - -#### Parameters - -• **data**: `string` - -#### Returns - -`string` - -#### Inherited from - -[`AuthorizationProvider`](../../../authorization-provider/classes/AuthorizationProvider.md).[`hydrate`](../../../authorization-provider/classes/AuthorizationProvider.md#hydrate) diff --git a/packages/altair-docs/api/authorization/providers/oauth2/index.md b/packages/altair-docs/api/authorization/providers/oauth2/index.md deleted file mode 100644 index 90bc826f4c..0000000000 --- a/packages/altair-docs/api/authorization/providers/oauth2/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# authorization/providers/oauth2 - -## Index - -| Member | Description | -| :------ | :------ | -| [default](classes/default.md) | - | -| [OAuth2AuthorizationProviderData](interfaces/OAuth2AuthorizationProviderData.md) | - | diff --git a/packages/altair-docs/api/authorization/providers/oauth2/interfaces/OAuth2AuthorizationProviderData.md b/packages/altair-docs/api/authorization/providers/oauth2/interfaces/OAuth2AuthorizationProviderData.md deleted file mode 100644 index 5e8f333b97..0000000000 --- a/packages/altair-docs/api/authorization/providers/oauth2/interfaces/OAuth2AuthorizationProviderData.md +++ /dev/null @@ -1,7 +0,0 @@ -# OAuth2AuthorizationProviderData - -## Properties - -### accessTokenResponse - -> **accessTokenResponse**: [`AccessTokenResponse`](../../../../oauth2/types/interfaces/AccessTokenResponse.md) diff --git a/packages/altair-docs/api/config/classes/AltairConfig.md b/packages/altair-docs/api/config/classes/AltairConfig.md deleted file mode 100644 index b6a59796f1..0000000000 --- a/packages/altair-docs/api/config/classes/AltairConfig.md +++ /dev/null @@ -1,243 +0,0 @@ -# AltairConfig - -## Constructors - -### new AltairConfig() - -> **new AltairConfig**(`__namedParameters`: [`AltairConfigOptions`](../interfaces/AltairConfigOptions.md)): [`AltairConfig`](AltairConfig.md) - -#### Parameters - -• **\_\_namedParameters**: [`AltairConfigOptions`](../interfaces/AltairConfigOptions.md)= `{}` - -#### Returns - -[`AltairConfig`](AltairConfig.md) - -## Properties - -### add\_query\_depth\_limit - -> **add\_query\_depth\_limit**: `number` = `3` - -*** - -### defaultTheme - -> **defaultTheme**: `string` = `'system'` - -*** - -### default\_language - -> **default\_language**: `string` - -*** - -### disableLineNumbers - -> **disableLineNumbers**: `boolean` = `false` - -*** - -### donation - -> **donation**: `object` - -#### action\_count\_threshold - -> **action\_count\_threshold**: `number` = `50` - -#### url - -> **url**: `string` = `'https://opencollective.com/altair/donate'` - -*** - -### ga - -> **ga**: `string` = `'UA-41432833-6'` - -*** - -### initialData - -> **initialData**: `object` - -#### disableAccount - -> **disableAccount**: `boolean` = `false` - -#### environments - -> **environments**: [`IInitialEnvironments`](../../types/state/environments.interfaces/interfaces/IInitialEnvironments.md) - -#### headers - -> **headers**: [`IDictionary`](../../types/shared/type-aliases/IDictionary.md) - -#### initialHttpMethod - -> **initialHttpMethod**: `"POST"` \| `"GET"` \| `"PUT"` \| `"DELETE"` - -#### initialSubscriptionsPayload - -> **initialSubscriptionsPayload**: [`IDictionary`](../../types/shared/type-aliases/IDictionary.md) - -#### initialSubscriptionsProvider - -> **initialSubscriptionsProvider**: `undefined` \| [`SubscriptionProviderIds`](../../subscriptions/type-aliases/SubscriptionProviderIds.md) - -#### instanceStorageNamespace - -> **instanceStorageNamespace**: `string` = `'altair_'` - -#### persistedSettings - -> **persistedSettings**: `undefined` \| `Partial`\<[`SettingsState`](../../types/state/settings.interfaces/interfaces/SettingsState.md)\> - -#### postRequestScript - -> **postRequestScript**: `string` = `''` - -#### preRequestScript - -> **preRequestScript**: `string` = `''` - -#### preserveState - -> **preserveState**: `boolean` = `true` - -#### query - -> **query**: `string` = `''` - -#### settings - -> **settings**: `undefined` \| `Partial`\<[`SettingsState`](../../types/state/settings.interfaces/interfaces/SettingsState.md)\> - -#### subscriptionsEndpoint - -> **subscriptionsEndpoint**: `string` = `''` - -#### subscriptionsProtocol - -> **subscriptionsProtocol**: `string` = `''` - -#### url - -> **url**: `string` = `''` - -#### variables - -> **variables**: `string` = `''` - -#### windows - -> **windows**: [`AltairWindowOptions`](../interfaces/AltairWindowOptions.md)[] - -*** - -### isTranslateMode - -> **isTranslateMode**: `any` - -*** - -### isWebApp - -> **isWebApp**: `any` - -*** - -### languages - -> **languages**: `object` - -#### cs-CZ - -> **cs-CZ**: `string` = `'Czech'` - -#### de-DE - -> **de-DE**: `string` = `'German'` - -#### en-US - -> **en-US**: `string` = `'English'` - -#### es-ES - -> **es-ES**: `string` = `'Español'` - -#### fr-FR - -> **fr-FR**: `string` = `'French'` - -#### it-IT - -> **it-IT**: `string` = `'Italian'` - -#### ja-JP - -> **ja-JP**: `string` = `'Japanese'` - -#### ko-KR - -> **ko-KR**: `string` = `'Korean'` - -#### pl-PL - -> **pl-PL**: `string` = `'Polish'` - -#### pt-BR - -> **pt-BR**: `string` = `'Brazilian'` - -#### ro-RO - -> **ro-RO**: `string` = `'Romanian'` - -#### ru-RU - -> **ru-RU**: `string` = `'Russian'` - -#### sr-SP - -> **sr-SP**: `string` = `'Serbian'` - -#### uk-UA - -> **uk-UA**: `string` = `'Ukrainian'` - -#### vi-VN - -> **vi-VN**: `string` = `'Vietnamese'` - -#### zh-CN - -> **zh-CN**: `string` = `'Chinese Simplified'` - -*** - -### max\_windows - -> **max\_windows**: `number` - -*** - -### query\_history\_depth - -> **query\_history\_depth**: `number` - -*** - -### tab\_size - -> **tab\_size**: `number` = `2` - -*** - -### themes - -> **themes**: `string`[] diff --git a/packages/altair-docs/api/config/functions/getAltairConfig.md b/packages/altair-docs/api/config/functions/getAltairConfig.md deleted file mode 100644 index 2348dbec3d..0000000000 --- a/packages/altair-docs/api/config/functions/getAltairConfig.md +++ /dev/null @@ -1,7 +0,0 @@ -# getAltairConfig() - -> **getAltairConfig**(): [`AltairConfig`](../classes/AltairConfig.md) - -## Returns - -[`AltairConfig`](../classes/AltairConfig.md) diff --git a/packages/altair-docs/api/config/functions/setAltairConfig.md b/packages/altair-docs/api/config/functions/setAltairConfig.md deleted file mode 100644 index b4081c2da3..0000000000 --- a/packages/altair-docs/api/config/functions/setAltairConfig.md +++ /dev/null @@ -1,11 +0,0 @@ -# setAltairConfig() - -> **setAltairConfig**(`_config`: [`AltairConfig`](../classes/AltairConfig.md)): `void` - -## Parameters - -• **\_config**: [`AltairConfig`](../classes/AltairConfig.md) - -## Returns - -`void` diff --git a/packages/altair-docs/api/config/index.md b/packages/altair-docs/api/config/index.md deleted file mode 100644 index 6d4eab7f9a..0000000000 --- a/packages/altair-docs/api/config/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# config - -## Index - -| Member | Description | -| :------ | :------ | -| [AltairConfig](classes/AltairConfig.md) | - | -| [AltairConfigOptions](interfaces/AltairConfigOptions.md) | - | -| [AltairWindowOptions](interfaces/AltairWindowOptions.md) | - | -| [getAltairConfig](functions/getAltairConfig.md) | - | -| [setAltairConfig](functions/setAltairConfig.md) | - | diff --git a/packages/altair-docs/api/config/interfaces/AltairConfigOptions.md b/packages/altair-docs/api/config/interfaces/AltairConfigOptions.md deleted file mode 100644 index fb9abf16f0..0000000000 --- a/packages/altair-docs/api/config/interfaces/AltairConfigOptions.md +++ /dev/null @@ -1,250 +0,0 @@ -# AltairConfigOptions - -## Extends - -- [`AltairWindowOptions`](AltairWindowOptions.md) - -## Properties - -### disableAccount? - -> `optional` **disableAccount**: `boolean` - -Disable the account and remote syncing functionality - -*** - -### endpointURL? - -> `optional` **endpointURL**: `string` - -URL to set as the server endpoint - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`endpointURL`](AltairWindowOptions.md#endpointurl) - -*** - -### initialEnvironments? - -> `optional` **initialEnvironments**: [`IInitialEnvironments`](../../types/state/environments.interfaces/interfaces/IInitialEnvironments.md) - -Initial Environments to be added - -#### Example - -```ts -{ - * base: { - * title: 'Environment', - * variables: {} - * }, - * subEnvironments: [ - * { - * title: 'sub-1', - * variables: {} - * } - * ] - * } -``` - -*** - -### initialHeaders? - -> `optional` **initialHeaders**: [`IDictionary`](../../types/shared/type-aliases/IDictionary.md) - -Initial headers object to be added - -#### Example - -```ts -{ - * 'X-GraphQL-Token': 'asd7-237s-2bdk-nsdk4' - * } -``` - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialHeaders`](AltairWindowOptions.md#initialheaders) - -*** - -### initialHttpMethod? - -> `optional` **initialHttpMethod**: `"POST"` \| `"GET"` \| `"PUT"` \| `"DELETE"` - -HTTP method to use for making requests - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialHttpMethod`](AltairWindowOptions.md#initialhttpmethod) - -*** - -### initialName? - -> `optional` **initialName**: `string` - -Initial name of the window - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialName`](AltairWindowOptions.md#initialname) - -*** - -### initialPostRequestScript? - -> `optional` **initialPostRequestScript**: `string` - -Initial post-request script to be added - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialPostRequestScript`](AltairWindowOptions.md#initialpostrequestscript) - -*** - -### initialPreRequestScript? - -> `optional` **initialPreRequestScript**: `string` - -Initial pre-request script to be added - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialPreRequestScript`](AltairWindowOptions.md#initialprerequestscript) - -*** - -### initialQuery? - -> `optional` **initialQuery**: `string` - -Initial query to be added - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialQuery`](AltairWindowOptions.md#initialquery) - -*** - -### initialSettings? - -> `optional` **initialSettings**: `Partial`\<[`SettingsState`](../../types/state/settings.interfaces/interfaces/SettingsState.md)\> - -Initial app settings to use - -*** - -### initialSubscriptionsPayload? - -> `optional` **initialSubscriptionsPayload**: [`IDictionary`](../../types/shared/type-aliases/IDictionary.md) - -Initial subscriptions connection params - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialSubscriptionsPayload`](AltairWindowOptions.md#initialsubscriptionspayload) - -*** - -### initialSubscriptionsProvider? - -> `optional` **initialSubscriptionsProvider**: [`SubscriptionProviderIds`](../../subscriptions/type-aliases/SubscriptionProviderIds.md) - -Initial subscriptions provider - -#### Default - -```ts -"websocket" -``` - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialSubscriptionsProvider`](AltairWindowOptions.md#initialsubscriptionsprovider) - -*** - -### initialVariables? - -> `optional` **initialVariables**: `string` - -Initial variables to be added - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`initialVariables`](AltairWindowOptions.md#initialvariables) - -*** - -### initialWindows? - -> `optional` **initialWindows**: [`AltairWindowOptions`](AltairWindowOptions.md)[] - -List of options for windows to be loaded - -*** - -### instanceStorageNamespace? - -> `optional` **instanceStorageNamespace**: `string` - -Namespace for storing the data for the altair instance. -Use this when you have multiple altair instances running on the same domain. - -#### Example - -```ts -instanceStorageNamespace: 'altair_dev_' -``` - -*** - -### persistedSettings? - -> `optional` **persistedSettings**: `Partial`\<[`SettingsState`](../../types/state/settings.interfaces/interfaces/SettingsState.md)\> - -Persisted settings for the app. The settings will be merged with the app settings. - -*** - -### preserveState? - -> `optional` **preserveState**: `boolean` - -Indicates if the state should be preserved for subsequent app loads - -#### Default - -```ts -true -``` - -*** - -### subscriptionsEndpoint? - -> `optional` **subscriptionsEndpoint**: `string` - -URL to set as the subscription endpoint. This can be relative or absolute. - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`subscriptionsEndpoint`](AltairWindowOptions.md#subscriptionsendpoint) - -*** - -### subscriptionsProtocol? - -> `optional` **subscriptionsProtocol**: `string` - -URL protocol for the subscription endpoint. This is used if the specified subscriptions endpoint is relative. -e.g. wss - -#### Inherited from - -[`AltairWindowOptions`](AltairWindowOptions.md).[`subscriptionsProtocol`](AltairWindowOptions.md#subscriptionsprotocol) diff --git a/packages/altair-docs/api/config/interfaces/AltairWindowOptions.md b/packages/altair-docs/api/config/interfaces/AltairWindowOptions.md deleted file mode 100644 index 24dd045ffc..0000000000 --- a/packages/altair-docs/api/config/interfaces/AltairWindowOptions.md +++ /dev/null @@ -1,116 +0,0 @@ -# AltairWindowOptions - -## Extended by - -- [`AltairConfigOptions`](AltairConfigOptions.md) - -## Properties - -### endpointURL? - -> `optional` **endpointURL**: `string` - -URL to set as the server endpoint - -*** - -### initialHeaders? - -> `optional` **initialHeaders**: [`IDictionary`](../../types/shared/type-aliases/IDictionary.md) - -Initial headers object to be added - -#### Example - -```ts -{ - * 'X-GraphQL-Token': 'asd7-237s-2bdk-nsdk4' - * } -``` - -*** - -### initialHttpMethod? - -> `optional` **initialHttpMethod**: `"POST"` \| `"GET"` \| `"PUT"` \| `"DELETE"` - -HTTP method to use for making requests - -*** - -### initialName? - -> `optional` **initialName**: `string` - -Initial name of the window - -*** - -### initialPostRequestScript? - -> `optional` **initialPostRequestScript**: `string` - -Initial post-request script to be added - -*** - -### initialPreRequestScript? - -> `optional` **initialPreRequestScript**: `string` - -Initial pre-request script to be added - -*** - -### initialQuery? - -> `optional` **initialQuery**: `string` - -Initial query to be added - -*** - -### initialSubscriptionsPayload? - -> `optional` **initialSubscriptionsPayload**: [`IDictionary`](../../types/shared/type-aliases/IDictionary.md) - -Initial subscriptions connection params - -*** - -### initialSubscriptionsProvider? - -> `optional` **initialSubscriptionsProvider**: [`SubscriptionProviderIds`](../../subscriptions/type-aliases/SubscriptionProviderIds.md) - -Initial subscriptions provider - -#### Default - -```ts -"websocket" -``` - -*** - -### initialVariables? - -> `optional` **initialVariables**: `string` - -Initial variables to be added - -*** - -### subscriptionsEndpoint? - -> `optional` **subscriptionsEndpoint**: `string` - -URL to set as the subscription endpoint. This can be relative or absolute. - -*** - -### subscriptionsProtocol? - -> `optional` **subscriptionsProtocol**: `string` - -URL protocol for the subscription endpoint. This is used if the specified subscriptions endpoint is relative. -e.g. wss diff --git a/packages/altair-docs/api/evaluator/events/functions/getErrorEvent.md b/packages/altair-docs/api/evaluator/events/functions/getErrorEvent.md deleted file mode 100644 index 061b4e176c..0000000000 --- a/packages/altair-docs/api/evaluator/events/functions/getErrorEvent.md +++ /dev/null @@ -1,15 +0,0 @@ -# getErrorEvent() - -> **getErrorEvent**\<`T`\>(`type`: `T`): `string` - -## Type parameters - -• **T** *extends* `string` - -## Parameters - -• **type**: `T` - -## Returns - -`string` diff --git a/packages/altair-docs/api/evaluator/events/functions/getResponseEvent.md b/packages/altair-docs/api/evaluator/events/functions/getResponseEvent.md deleted file mode 100644 index 8467620352..0000000000 --- a/packages/altair-docs/api/evaluator/events/functions/getResponseEvent.md +++ /dev/null @@ -1,15 +0,0 @@ -# getResponseEvent() - -> **getResponseEvent**\<`T`\>(`type`: `T`): `string` - -## Type parameters - -• **T** *extends* `string` - -## Parameters - -• **type**: `T` - -## Returns - -`string` diff --git a/packages/altair-docs/api/evaluator/events/index.md b/packages/altair-docs/api/evaluator/events/index.md deleted file mode 100644 index 94ca27b78d..0000000000 --- a/packages/altair-docs/api/evaluator/events/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# evaluator/events - -## Index - -| Member | Description | -| :------ | :------ | -| [EVALUATOR\_INIT\_EXECUTE](variables/EVALUATOR_INIT_EXECUTE.md) | - | -| [EVALUATOR\_READY](variables/EVALUATOR_READY.md) | - | -| [getErrorEvent](functions/getErrorEvent.md) | - | -| [getResponseEvent](functions/getResponseEvent.md) | - | diff --git a/packages/altair-docs/api/evaluator/events/variables/EVALUATOR_INIT_EXECUTE.md b/packages/altair-docs/api/evaluator/events/variables/EVALUATOR_INIT_EXECUTE.md deleted file mode 100644 index fba67a293e..0000000000 --- a/packages/altair-docs/api/evaluator/events/variables/EVALUATOR_INIT_EXECUTE.md +++ /dev/null @@ -1,3 +0,0 @@ -# EVALUATOR\_INIT\_EXECUTE - -> `const` **EVALUATOR\_INIT\_EXECUTE**: `"init_execute"` = `'init_execute'` diff --git a/packages/altair-docs/api/evaluator/events/variables/EVALUATOR_READY.md b/packages/altair-docs/api/evaluator/events/variables/EVALUATOR_READY.md deleted file mode 100644 index 9c6e654a94..0000000000 --- a/packages/altair-docs/api/evaluator/events/variables/EVALUATOR_READY.md +++ /dev/null @@ -1,3 +0,0 @@ -# EVALUATOR\_READY - -> `const` **EVALUATOR\_READY**: `"evaluator::ready"` = `'evaluator::ready'` diff --git a/packages/altair-docs/api/evaluator/worker/classes/EvaluatorWorker.md b/packages/altair-docs/api/evaluator/worker/classes/EvaluatorWorker.md deleted file mode 100644 index 87c18b28b1..0000000000 --- a/packages/altair-docs/api/evaluator/worker/classes/EvaluatorWorker.md +++ /dev/null @@ -1,146 +0,0 @@ -# `abstract` EvaluatorWorker - -## Extended by - -- [`PluginFrameWorker`](../../../plugin/v3/frame-worker/classes/PluginFrameWorker.md) -- [`PluginParentWorker`](../../../plugin/v3/parent-worker/classes/PluginParentWorker.md) - -## Constructors - -### new EvaluatorWorker() - -> **new EvaluatorWorker**(): [`EvaluatorWorker`](EvaluatorWorker.md) - -#### Returns - -[`EvaluatorWorker`](EvaluatorWorker.md) - -## Methods - -### destroy() - -> `abstract` **destroy**(): `void` - -#### Returns - -`void` - -*** - -### onError() - -> `abstract` **onError**(`handler`: (`err`: `unknown`) => `void`): `void` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -*** - -### onMessage() - -> `abstract` **onMessage**\<`T`, `P`\>(`handler`: (`e`: [`EventData`](../interfaces/EventData.md)\<`T`, `P`\>) => `void`): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **P** = `unknown` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -*** - -### request() - -> **request**\<`T`, `R`\>(`type`: `T`, ...`args`: `unknown`[]): `Promise`\<`undefined` \| `R`\> - -#### Type parameters - -• **T** *extends* `string` - -• **R** = `unknown` - -#### Parameters - -• **type**: `T` - -• ...**args**: `unknown`[] - -#### Returns - -`Promise`\<`undefined` \| `R`\> - -*** - -### respond() - -> **respond**\<`T`, `R`\>(`type`: `T`, `handler`: (...`args`: `unknown`[]) => `Promise`\<`R`\>): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **R** = `unknown` - -#### Parameters - -• **type**: `T` - -• **handler** - -#### Returns - -`void` - -*** - -### send() - -> `abstract` **send**\<`T`\>(`type`: `T`, `payload`?: `unknown`): `void` - -#### Type parameters - -• **T** *extends* `string` - -#### Parameters - -• **type**: `T` - -• **payload?**: `unknown` - -#### Returns - -`void` - -*** - -### subscribe() - -> **subscribe**\<`T`, `P`\>(`type`: `T`, `handler`: (`type`: `T`, `e`: [`EventData`](../interfaces/EventData.md)\<`T`, `P`\>) => `void`): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **P** = `unknown` - -#### Parameters - -• **type**: `T` - -• **handler** - -#### Returns - -`void` diff --git a/packages/altair-docs/api/evaluator/worker/index.md b/packages/altair-docs/api/evaluator/worker/index.md deleted file mode 100644 index 0c48f1acba..0000000000 --- a/packages/altair-docs/api/evaluator/worker/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# evaluator/worker - -## Index - -| Member | Description | -| :------ | :------ | -| [EvaluatorWorker](classes/EvaluatorWorker.md) | - | -| [EventData](interfaces/EventData.md) | - | diff --git a/packages/altair-docs/api/evaluator/worker/interfaces/EventData.md b/packages/altair-docs/api/evaluator/worker/interfaces/EventData.md deleted file mode 100644 index 7829c2ec3a..0000000000 --- a/packages/altair-docs/api/evaluator/worker/interfaces/EventData.md +++ /dev/null @@ -1,19 +0,0 @@ -# EventData\ - -## Type parameters - -• **T** *extends* `string` - -• **P** = `unknown` - -## Properties - -### payload - -> **payload**: `P` - -*** - -### type - -> **type**: `T` diff --git a/packages/altair-docs/api/index.md b/packages/altair-docs/api/index.md deleted file mode 100644 index 55fc44c079..0000000000 --- a/packages/altair-docs/api/index.md +++ /dev/null @@ -1,85 +0,0 @@ -# API Reference - -| Member | Description | -| :------ | :------ | -| [authorization/authorization-provider](authorization/authorization-provider/index.md) | - | -| [authorization/providers/api-key](authorization/providers/api-key/index.md) | - | -| [authorization/providers/basic](authorization/providers/basic/index.md) | - | -| [authorization/providers/bearer](authorization/providers/bearer/index.md) | - | -| [authorization/providers/oauth2](authorization/providers/oauth2/index.md) | - | -| [config](config/index.md) | - | -| [evaluator/events](evaluator/events/index.md) | - | -| [evaluator/worker](evaluator/worker/index.md) | - | -| [index](index/index.md) | - | -| [oauth2](oauth2/index.md) | - | -| [oauth2/client](oauth2/client/index.md) | - | -| [oauth2/events](oauth2/events/index.md) | - | -| [oauth2/helpers](oauth2/helpers/index.md) | - | -| [oauth2/types](oauth2/types/index.md) | - | -| [origins](origins/index.md) | - | -| [plugin/base](plugin/base/index.md) | - | -| [plugin/context/context.interface](plugin/context/context.interface/index.md) | - | -| [plugin/event/event.interfaces](plugin/event/event.interfaces/index.md) | - | -| [plugin/panel](plugin/panel/index.md) | - | -| [plugin/plugin.interfaces](plugin/plugin.interfaces/index.md) | - | -| [plugin/ui-action](plugin/ui-action/index.md) | - | -| [plugin/v3/capabilities](plugin/v3/capabilities/index.md) | - | -| [plugin/v3/context](plugin/v3/context/index.md) | - | -| [plugin/v3/events](plugin/v3/events/index.md) | - | -| [plugin/v3/frame-engine](plugin/v3/frame-engine/index.md) | - | -| [plugin/v3/frame-worker](plugin/v3/frame-worker/index.md) | - | -| [plugin/v3/manifest](plugin/v3/manifest/index.md) | - | -| [plugin/v3/panel](plugin/v3/panel/index.md) | - | -| [plugin/v3/parent-engine](plugin/v3/parent-engine/index.md) | - | -| [plugin/v3/parent-worker](plugin/v3/parent-worker/index.md) | - | -| [plugin/v3/plugin](plugin/v3/plugin/index.md) | - | -| [plugin/v3/source](plugin/v3/source/index.md) | - | -| [script/context](script/context/index.md) | - | -| [script/errors](script/errors/index.md) | - | -| [script/evaluator-client-engine](script/evaluator-client-engine/index.md) | - | -| [script/evaluator-worker-engine](script/evaluator-worker-engine/index.md) | - | -| [script/events](script/events/index.md) | - | -| [script/types](script/types/index.md) | - | -| [subscriptions](subscriptions/index.md) | - | -| [subscriptions/providers/action-cable](subscriptions/providers/action-cable/index.md) | - | -| [subscriptions/providers/app-sync](subscriptions/providers/app-sync/index.md) | - | -| [subscriptions/providers/graphql-sse](subscriptions/providers/graphql-sse/index.md) | - | -| [subscriptions/providers/graphql-ws](subscriptions/providers/graphql-ws/index.md) | - | -| [subscriptions/providers/ws](subscriptions/providers/ws/index.md) | - | -| [subscriptions/subscription-provider](subscriptions/subscription-provider/index.md) | - | -| [theme](theme/index.md) | - | -| [theme/defaults/dark](theme/defaults/dark/index.md) | - | -| [theme/defaults/dracula](theme/defaults/dracula/index.md) | - | -| [theme/defaults/light](theme/defaults/light/index.md) | - | -| [theme/theme](theme/theme/index.md) | - | -| [types/shared](types/shared/index.md) | - | -| [types/state/account.interfaces](types/state/account.interfaces/index.md) | - | -| [types/state/authorization.interface](types/state/authorization.interface/index.md) | - | -| [types/state/collection.interfaces](types/state/collection.interfaces/index.md) | - | -| [types/state/collections-meta.interfaces](types/state/collections-meta.interfaces/index.md) | - | -| [types/state/dialog.interfaces](types/state/dialog.interfaces/index.md) | - | -| [types/state/docs.interfaces](types/state/docs.interfaces/index.md) | - | -| [types/state/donation.interfaces](types/state/donation.interfaces/index.md) | - | -| [types/state/environments.interfaces](types/state/environments.interfaces/index.md) | - | -| [types/state/gql-schema.interfaces](types/state/gql-schema.interfaces/index.md) | - | -| [types/state/header.interfaces](types/state/header.interfaces/index.md) | - | -| [types/state/history.interfaces](types/state/history.interfaces/index.md) | - | -| [types/state/layout.interfaces](types/state/layout.interfaces/index.md) | - | -| [types/state/local.interfaces](types/state/local.interfaces/index.md) | - | -| [types/state/per-window.interfaces](types/state/per-window.interfaces/index.md) | - | -| [types/state/postrequest.interfaces](types/state/postrequest.interfaces/index.md) | - | -| [types/state/prerequest.interfaces](types/state/prerequest.interfaces/index.md) | - | -| [types/state/query.interfaces](types/state/query.interfaces/index.md) | - | -| [types/state/settings.interfaces](types/state/settings.interfaces/index.md) | - | -| [types/state/state.interfaces](types/state/state.interfaces/index.md) | - | -| [types/state/stream.interfaces](types/state/stream.interfaces/index.md) | - | -| [types/state/variable.interfaces](types/state/variable.interfaces/index.md) | - | -| [types/state/window.interfaces](types/state/window.interfaces/index.md) | - | -| [types/state/windows-meta.interfaces](types/state/windows-meta.interfaces/index.md) | - | -| [types/state/workspace.interface](types/state/workspace.interface/index.md) | - | -| [utils/is\_electron](utils/is_electron/index.md) | - | -| [utils/logger](utils/logger/index.md) | - | -| [utils/url](utils/url/index.md) | - | -| [utils/value-object](utils/value-object/index.md) | - | -| [validate-partial-settings](validate-partial-settings/index.md) | - | -| [validate-settings](validate-settings/index.md) | - | diff --git a/packages/altair-docs/api/index/functions/registerPluginClass.md b/packages/altair-docs/api/index/functions/registerPluginClass.md deleted file mode 100644 index 9933583237..0000000000 --- a/packages/altair-docs/api/index/functions/registerPluginClass.md +++ /dev/null @@ -1,17 +0,0 @@ -# registerPluginClass() - -> **registerPluginClass**\<`T`\>(`pluginClassName`: `string`, `pluginClass`: [`PluginConstructor`](../../plugin/base/interfaces/PluginConstructor.md)\<`T`\>): `void` - -## Type parameters - -• **T** *extends* [`PluginBase`](../../plugin/base/classes/PluginBase.md) - -## Parameters - -• **pluginClassName**: `string` - -• **pluginClass**: [`PluginConstructor`](../../plugin/base/interfaces/PluginConstructor.md)\<`T`\> - -## Returns - -`void` diff --git a/packages/altair-docs/api/index/index.md b/packages/altair-docs/api/index/index.md deleted file mode 100644 index a0b1d1b244..0000000000 --- a/packages/altair-docs/api/index/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# index - -## Index - -| Member | Description | -| :------ | :------ | -| [registerPluginClass](functions/registerPluginClass.md) | - | diff --git a/packages/altair-docs/api/oauth2/client/classes/OAuth2Client.md b/packages/altair-docs/api/oauth2/client/classes/OAuth2Client.md deleted file mode 100644 index 73ee1fda43..0000000000 --- a/packages/altair-docs/api/oauth2/client/classes/OAuth2Client.md +++ /dev/null @@ -1,49 +0,0 @@ -# OAuth2Client - -## Constructors - -### new OAuth2Client() - -> **new OAuth2Client**(`options`: [`OAuth2ClientOptions`](../type-aliases/OAuth2ClientOptions.md)): [`OAuth2Client`](OAuth2Client.md) - -#### Parameters - -• **options**: [`OAuth2ClientOptions`](../type-aliases/OAuth2ClientOptions.md) - -#### Returns - -[`OAuth2Client`](OAuth2Client.md) - -## Methods - -### getAccessTokenFromCode() - -> **getAccessTokenFromCode**(`code`: `string`): `Promise`\<[`AccessTokenResponse`](../../types/interfaces/AccessTokenResponse.md) \| [`AccessTokenErrorResponse`](../../types/interfaces/AccessTokenErrorResponse.md)\> - -#### Parameters - -• **code**: `string` - -#### Returns - -`Promise`\<[`AccessTokenResponse`](../../types/interfaces/AccessTokenResponse.md) \| [`AccessTokenErrorResponse`](../../types/interfaces/AccessTokenErrorResponse.md)\> - -*** - -### getAuthorizationRedirectResponse() - -> **getAuthorizationRedirectResponse**(): `Promise`\<`undefined` \| [`AuthorizationRedirectResponse`](../../types/interfaces/AuthorizationRedirectResponse.md) \| [`AuthorizationRedirectErrorResponse`](../../types/interfaces/AuthorizationRedirectErrorResponse.md)\> - -#### Returns - -`Promise`\<`undefined` \| [`AuthorizationRedirectResponse`](../../types/interfaces/AuthorizationRedirectResponse.md) \| [`AuthorizationRedirectErrorResponse`](../../types/interfaces/AuthorizationRedirectErrorResponse.md)\> - -*** - -### getAuthorizationUrl() - -> **getAuthorizationUrl**(): `Promise`\<`string`\> - -#### Returns - -`Promise`\<`string`\> diff --git a/packages/altair-docs/api/oauth2/client/index.md b/packages/altair-docs/api/oauth2/client/index.md deleted file mode 100644 index 4b463ffe32..0000000000 --- a/packages/altair-docs/api/oauth2/client/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# oauth2/client - -## Index - -| Member | Description | -| :------ | :------ | -| [OAuth2Client](classes/OAuth2Client.md) | - | -| [OAuth2ClientOptions](type-aliases/OAuth2ClientOptions.md) | - | diff --git a/packages/altair-docs/api/oauth2/client/type-aliases/OAuth2ClientOptions.md b/packages/altair-docs/api/oauth2/client/type-aliases/OAuth2ClientOptions.md deleted file mode 100644 index 0cd5613a7f..0000000000 --- a/packages/altair-docs/api/oauth2/client/type-aliases/OAuth2ClientOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# OAuth2ClientOptions - -> **OAuth2ClientOptions**: `AuthorizationCode_OAuth2ClientOptions` \| `AuthorizationCodePKCE_OAuth2ClientOptions` diff --git a/packages/altair-docs/api/oauth2/events/index.md b/packages/altair-docs/api/oauth2/events/index.md deleted file mode 100644 index 01dd4c7606..0000000000 --- a/packages/altair-docs/api/oauth2/events/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# oauth2/events - -## Index - -| Member | Description | -| :------ | :------ | -| [EVENT\_TYPES](variables/EVENT_TYPES.md) | - | diff --git a/packages/altair-docs/api/oauth2/events/variables/EVENT_TYPES.md b/packages/altair-docs/api/oauth2/events/variables/EVENT_TYPES.md deleted file mode 100644 index 66ee7f22d4..0000000000 --- a/packages/altair-docs/api/oauth2/events/variables/EVENT_TYPES.md +++ /dev/null @@ -1,17 +0,0 @@ -# EVENT\_TYPES - -> `const` **EVENT\_TYPES**: `object` - -## Type declaration - -### ACTION - -> **ACTION**: `string` = `'action'` - -### AUTHORIZATION\_CODE - -> **AUTHORIZATION\_CODE**: `string` = `'authorization-code'` - -### FRAME\_READY - -> **FRAME\_READY**: `string` = `'frame-ready'` diff --git a/packages/altair-docs/api/oauth2/helpers/functions/base64UrlEncode.md b/packages/altair-docs/api/oauth2/helpers/functions/base64UrlEncode.md deleted file mode 100644 index c302f0c036..0000000000 --- a/packages/altair-docs/api/oauth2/helpers/functions/base64UrlEncode.md +++ /dev/null @@ -1,11 +0,0 @@ -# base64UrlEncode() - -> **base64UrlEncode**(`buffer`: `ArrayBuffer`): `string` - -## Parameters - -• **buffer**: `ArrayBuffer` - -## Returns - -`string` diff --git a/packages/altair-docs/api/oauth2/helpers/functions/getCodeChallenge.md b/packages/altair-docs/api/oauth2/helpers/functions/getCodeChallenge.md deleted file mode 100644 index 2e89761000..0000000000 --- a/packages/altair-docs/api/oauth2/helpers/functions/getCodeChallenge.md +++ /dev/null @@ -1,11 +0,0 @@ -# getCodeChallenge() - -> **getCodeChallenge**(`codeVerifier`: `string`): `Promise`\<`string`\> - -## Parameters - -• **codeVerifier**: `string` - -## Returns - -`Promise`\<`string`\> diff --git a/packages/altair-docs/api/oauth2/helpers/functions/hex.md b/packages/altair-docs/api/oauth2/helpers/functions/hex.md deleted file mode 100644 index 30a6e3858e..0000000000 --- a/packages/altair-docs/api/oauth2/helpers/functions/hex.md +++ /dev/null @@ -1,11 +0,0 @@ -# hex() - -> **hex**(`buffer`: `ArrayBuffer`): `string` - -## Parameters - -• **buffer**: `ArrayBuffer` - -## Returns - -`string` diff --git a/packages/altair-docs/api/oauth2/helpers/functions/secureRandomString.md b/packages/altair-docs/api/oauth2/helpers/functions/secureRandomString.md deleted file mode 100644 index 8104e59be8..0000000000 --- a/packages/altair-docs/api/oauth2/helpers/functions/secureRandomString.md +++ /dev/null @@ -1,11 +0,0 @@ -# secureRandomString() - -> **secureRandomString**(`length`: `number`): `string` - -## Parameters - -• **length**: `number`= `16` - -## Returns - -`string` diff --git a/packages/altair-docs/api/oauth2/helpers/functions/sha256.md b/packages/altair-docs/api/oauth2/helpers/functions/sha256.md deleted file mode 100644 index 505b159d6c..0000000000 --- a/packages/altair-docs/api/oauth2/helpers/functions/sha256.md +++ /dev/null @@ -1,11 +0,0 @@ -# sha256() - -> **sha256**(`str`: `string`): `Promise`\<`ArrayBuffer`\> - -## Parameters - -• **str**: `string` - -## Returns - -`Promise`\<`ArrayBuffer`\> diff --git a/packages/altair-docs/api/oauth2/helpers/index.md b/packages/altair-docs/api/oauth2/helpers/index.md deleted file mode 100644 index accdbb46c1..0000000000 --- a/packages/altair-docs/api/oauth2/helpers/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# oauth2/helpers - -## Index - -| Member | Description | -| :------ | :------ | -| [base64UrlEncode](functions/base64UrlEncode.md) | - | -| [getCodeChallenge](functions/getCodeChallenge.md) | - | -| [hex](functions/hex.md) | - | -| [secureRandomString](functions/secureRandomString.md) | - | -| [sha256](functions/sha256.md) | - | diff --git a/packages/altair-docs/api/oauth2/index.md b/packages/altair-docs/api/oauth2/index.md deleted file mode 100644 index ee2eb0c639..0000000000 --- a/packages/altair-docs/api/oauth2/index.md +++ /dev/null @@ -1 +0,0 @@ -# oauth2 diff --git a/packages/altair-docs/api/oauth2/types/enumerations/OAuth2Type.md b/packages/altair-docs/api/oauth2/types/enumerations/OAuth2Type.md deleted file mode 100644 index 1bd06f50a7..0000000000 --- a/packages/altair-docs/api/oauth2/types/enumerations/OAuth2Type.md +++ /dev/null @@ -1,13 +0,0 @@ -# OAuth2Type - -## Enumeration Members - -### AUTHORIZATION\_CODE - -> **AUTHORIZATION\_CODE**: `"auth_code"` - -*** - -### AUTHORIZATION\_CODE\_PKCE - -> **AUTHORIZATION\_CODE\_PKCE**: `"auth_code_pkce"` diff --git a/packages/altair-docs/api/oauth2/types/index.md b/packages/altair-docs/api/oauth2/types/index.md deleted file mode 100644 index 5218ea3211..0000000000 --- a/packages/altair-docs/api/oauth2/types/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# oauth2/types - -## Index - -| Member | Description | -| :------ | :------ | -| [OAuth2Type](enumerations/OAuth2Type.md) | - | -| [AccessTokenErrorResponse](interfaces/AccessTokenErrorResponse.md) | - | -| [AccessTokenResponse](interfaces/AccessTokenResponse.md) | - | -| [AuthorizationCodePKCE\_AccessTokenRequest](interfaces/AuthorizationCodePKCE_AccessTokenRequest.md) | - | -| [AuthorizationCode\_AccessTokenRequest](interfaces/AuthorizationCode_AccessTokenRequest.md) | - | -| [AuthorizationRedirectErrorResponse](interfaces/AuthorizationRedirectErrorResponse.md) | - | -| [AuthorizationRedirectResponse](interfaces/AuthorizationRedirectResponse.md) | - | -| [CodeChallengeAuthorizationRequestParams](interfaces/CodeChallengeAuthorizationRequestParams.md) | - | -| [SimpleAuthorizationRequestParams](interfaces/SimpleAuthorizationRequestParams.md) | - | -| [AccessTokenRequest](type-aliases/AccessTokenRequest.md) | - | -| [AuthorizationRequestParams](type-aliases/AuthorizationRequestParams.md) | - | diff --git a/packages/altair-docs/api/oauth2/types/interfaces/AccessTokenErrorResponse.md b/packages/altair-docs/api/oauth2/types/interfaces/AccessTokenErrorResponse.md deleted file mode 100644 index 1969a6b8d9..0000000000 --- a/packages/altair-docs/api/oauth2/types/interfaces/AccessTokenErrorResponse.md +++ /dev/null @@ -1,25 +0,0 @@ -# AccessTokenErrorResponse - -## Properties - -### error - -> **error**: `string` - -*** - -### error\_description? - -> `optional` **error\_description**: `string` - -*** - -### error\_uri? - -> `optional` **error\_uri**: `string` - -*** - -### state - -> **state**: `string` diff --git a/packages/altair-docs/api/oauth2/types/interfaces/AccessTokenResponse.md b/packages/altair-docs/api/oauth2/types/interfaces/AccessTokenResponse.md deleted file mode 100644 index 0b85554464..0000000000 --- a/packages/altair-docs/api/oauth2/types/interfaces/AccessTokenResponse.md +++ /dev/null @@ -1,51 +0,0 @@ -# AccessTokenResponse - -## Properties - -### access\_token - -> **access\_token**: `string` - -The access token issued by the authorization server - -*** - -### expires\_in? - -> `optional` **expires\_in**: `number` - -The lifetime in seconds of the access token - -*** - -### id\_token? - -> `optional` **id\_token**: `string` - -*** - -### refresh\_token? - -> `optional` **refresh\_token**: `string` - -*** - -### scope? - -> `optional` **scope**: `string` - -*** - -### state - -> **state**: `string` - -The exact value of the state parameter passed by the client in the authorization request - -*** - -### token\_type - -> **token\_type**: `string` - -The type of the token issued diff --git a/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationCodePKCE_AccessTokenRequest.md b/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationCodePKCE_AccessTokenRequest.md deleted file mode 100644 index 05f463e6b2..0000000000 --- a/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationCodePKCE_AccessTokenRequest.md +++ /dev/null @@ -1,65 +0,0 @@ -# AuthorizationCodePKCE\_AccessTokenRequest - -## Extends - -- [`AuthorizationCode_AccessTokenRequest`](AuthorizationCode_AccessTokenRequest.md) - -## Properties - -### client\_id - -> **client\_id**: `string` - -#### Inherited from - -[`AuthorizationCode_AccessTokenRequest`](AuthorizationCode_AccessTokenRequest.md).[`client_id`](AuthorizationCode_AccessTokenRequest.md#client-id) - -*** - -### client\_secret - -> **client\_secret**: `string` - -#### Inherited from - -[`AuthorizationCode_AccessTokenRequest`](AuthorizationCode_AccessTokenRequest.md).[`client_secret`](AuthorizationCode_AccessTokenRequest.md#client-secret) - -*** - -### code - -> **code**: `string` - -The authorization code received from the authorization server - -#### Inherited from - -[`AuthorizationCode_AccessTokenRequest`](AuthorizationCode_AccessTokenRequest.md).[`code`](AuthorizationCode_AccessTokenRequest.md#code) - -*** - -### code\_verifier - -> **code\_verifier**: `string` - -*** - -### grant\_type - -> **grant\_type**: `"authorization_code"` - -#### Inherited from - -[`AuthorizationCode_AccessTokenRequest`](AuthorizationCode_AccessTokenRequest.md).[`grant_type`](AuthorizationCode_AccessTokenRequest.md#grant-type) - -*** - -### redirect\_uri - -> **redirect\_uri**: `string` - -The redirect URI used in the initial request - -#### Inherited from - -[`AuthorizationCode_AccessTokenRequest`](AuthorizationCode_AccessTokenRequest.md).[`redirect_uri`](AuthorizationCode_AccessTokenRequest.md#redirect-uri) diff --git a/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationCode_AccessTokenRequest.md b/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationCode_AccessTokenRequest.md deleted file mode 100644 index 6a9657b9de..0000000000 --- a/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationCode_AccessTokenRequest.md +++ /dev/null @@ -1,39 +0,0 @@ -# AuthorizationCode\_AccessTokenRequest - -## Extended by - -- [`AuthorizationCodePKCE_AccessTokenRequest`](AuthorizationCodePKCE_AccessTokenRequest.md) - -## Properties - -### client\_id - -> **client\_id**: `string` - -*** - -### client\_secret - -> **client\_secret**: `string` - -*** - -### code - -> **code**: `string` - -The authorization code received from the authorization server - -*** - -### grant\_type - -> **grant\_type**: `"authorization_code"` - -*** - -### redirect\_uri - -> **redirect\_uri**: `string` - -The redirect URI used in the initial request diff --git a/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationRedirectErrorResponse.md b/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationRedirectErrorResponse.md deleted file mode 100644 index ed25b3c87f..0000000000 --- a/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationRedirectErrorResponse.md +++ /dev/null @@ -1,25 +0,0 @@ -# AuthorizationRedirectErrorResponse - -## Properties - -### error - -> **error**: `string` - -*** - -### error\_description? - -> `optional` **error\_description**: `string` - -*** - -### error\_uri? - -> `optional` **error\_uri**: `string` - -*** - -### state - -> **state**: `string` diff --git a/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationRedirectResponse.md b/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationRedirectResponse.md deleted file mode 100644 index c07e5251b3..0000000000 --- a/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationRedirectResponse.md +++ /dev/null @@ -1,17 +0,0 @@ -# AuthorizationRedirectResponse - -## Properties - -### code - -> **code**: `string` - -The authorization code received from the authorization server - -*** - -### state - -> **state**: `string` - -The exact value of the state parameter passed by the client in the authorization request diff --git a/packages/altair-docs/api/oauth2/types/interfaces/CodeChallengeAuthorizationRequestParams.md b/packages/altair-docs/api/oauth2/types/interfaces/CodeChallengeAuthorizationRequestParams.md deleted file mode 100644 index 800844c164..0000000000 --- a/packages/altair-docs/api/oauth2/types/interfaces/CodeChallengeAuthorizationRequestParams.md +++ /dev/null @@ -1,75 +0,0 @@ -# CodeChallengeAuthorizationRequestParams - -## Extends - -- [`SimpleAuthorizationRequestParams`](SimpleAuthorizationRequestParams.md) - -## Properties - -### client\_id - -> **client\_id**: `string` - -The client ID of your application - -#### Inherited from - -[`SimpleAuthorizationRequestParams`](SimpleAuthorizationRequestParams.md).[`client_id`](SimpleAuthorizationRequestParams.md#client-id) - -*** - -### code\_challenge - -> **code\_challenge**: `string` - -*** - -### code\_challenge\_method - -> **code\_challenge\_method**: `"S256"` - -*** - -### redirect\_uri - -> **redirect\_uri**: `string` - -The URL in your app where users will be sent after authorization - -#### Inherited from - -[`SimpleAuthorizationRequestParams`](SimpleAuthorizationRequestParams.md).[`redirect_uri`](SimpleAuthorizationRequestParams.md#redirect-uri) - -*** - -### response\_type - -> **response\_type**: `"code"` - -#### Inherited from - -[`SimpleAuthorizationRequestParams`](SimpleAuthorizationRequestParams.md).[`response_type`](SimpleAuthorizationRequestParams.md#response-type) - -*** - -### scope - -> **scope**: `string` - -A space-separated list of scopes - -#### Inherited from - -[`SimpleAuthorizationRequestParams`](SimpleAuthorizationRequestParams.md).[`scope`](SimpleAuthorizationRequestParams.md#scope) - -*** - -### state - -> **state**: `string` - -A random string generated by your application, which you'll verify later - -#### Inherited from - -[`SimpleAuthorizationRequestParams`](SimpleAuthorizationRequestParams.md).[`state`](SimpleAuthorizationRequestParams.md#state) diff --git a/packages/altair-docs/api/oauth2/types/interfaces/SimpleAuthorizationRequestParams.md b/packages/altair-docs/api/oauth2/types/interfaces/SimpleAuthorizationRequestParams.md deleted file mode 100644 index 13ff28a3b5..0000000000 --- a/packages/altair-docs/api/oauth2/types/interfaces/SimpleAuthorizationRequestParams.md +++ /dev/null @@ -1,47 +0,0 @@ -# SimpleAuthorizationRequestParams - -## Extends - -- `Record`\<`string`, `string`\> - -## Extended by - -- [`CodeChallengeAuthorizationRequestParams`](CodeChallengeAuthorizationRequestParams.md) - -## Properties - -### client\_id - -> **client\_id**: `string` - -The client ID of your application - -*** - -### redirect\_uri - -> **redirect\_uri**: `string` - -The URL in your app where users will be sent after authorization - -*** - -### response\_type - -> **response\_type**: `"code"` - -*** - -### scope - -> **scope**: `string` - -A space-separated list of scopes - -*** - -### state - -> **state**: `string` - -A random string generated by your application, which you'll verify later diff --git a/packages/altair-docs/api/oauth2/types/type-aliases/AccessTokenRequest.md b/packages/altair-docs/api/oauth2/types/type-aliases/AccessTokenRequest.md deleted file mode 100644 index 1c32e30b39..0000000000 --- a/packages/altair-docs/api/oauth2/types/type-aliases/AccessTokenRequest.md +++ /dev/null @@ -1,3 +0,0 @@ -# AccessTokenRequest - -> **AccessTokenRequest**: [`AuthorizationCode_AccessTokenRequest`](../interfaces/AuthorizationCode_AccessTokenRequest.md) \| [`AuthorizationCodePKCE_AccessTokenRequest`](../interfaces/AuthorizationCodePKCE_AccessTokenRequest.md) diff --git a/packages/altair-docs/api/oauth2/types/type-aliases/AuthorizationRequestParams.md b/packages/altair-docs/api/oauth2/types/type-aliases/AuthorizationRequestParams.md deleted file mode 100644 index 390bb28802..0000000000 --- a/packages/altair-docs/api/oauth2/types/type-aliases/AuthorizationRequestParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# AuthorizationRequestParams - -> **AuthorizationRequestParams**: [`SimpleAuthorizationRequestParams`](../interfaces/SimpleAuthorizationRequestParams.md) \| [`CodeChallengeAuthorizationRequestParams`](../interfaces/CodeChallengeAuthorizationRequestParams.md) diff --git a/packages/altair-docs/api/origins/index.md b/packages/altair-docs/api/origins/index.md deleted file mode 100644 index e89d086df8..0000000000 --- a/packages/altair-docs/api/origins/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# origins - -## Index - -| Member | Description | -| :------ | :------ | -| [validOrigins](variables/validOrigins.md) | - | diff --git a/packages/altair-docs/api/origins/variables/validOrigins.md b/packages/altair-docs/api/origins/variables/validOrigins.md deleted file mode 100644 index 71c092fe5b..0000000000 --- a/packages/altair-docs/api/origins/variables/validOrigins.md +++ /dev/null @@ -1,3 +0,0 @@ -# validOrigins - -> `const` **validOrigins**: `string`[] diff --git a/packages/altair-docs/api/plugin/base/classes/PluginBase.md b/packages/altair-docs/api/plugin/base/classes/PluginBase.md deleted file mode 100644 index b0a9397576..0000000000 --- a/packages/altair-docs/api/plugin/base/classes/PluginBase.md +++ /dev/null @@ -1,45 +0,0 @@ -# `abstract` PluginBase - -## Constructors - -### new PluginBase() - -> **new PluginBase**(`ctx`: [`PluginContext`](../../context/context.interface/interfaces/PluginContext.md)): [`PluginBase`](PluginBase.md) - -#### Parameters - -• **ctx**: [`PluginContext`](../../context/context.interface/interfaces/PluginContext.md) - -#### Returns - -[`PluginBase`](PluginBase.md) - -## Properties - -### ctx - -> `protected` **ctx**: [`PluginContext`](../../context/context.interface/interfaces/PluginContext.md) - -## Methods - -### destroy() - -> `abstract` **destroy**(): `void` - -#### Returns - -`void` - -*** - -### initialize() - -> `abstract` **initialize**(`ctx`: [`PluginContext`](../../context/context.interface/interfaces/PluginContext.md)): `void` - -#### Parameters - -• **ctx**: [`PluginContext`](../../context/context.interface/interfaces/PluginContext.md) - -#### Returns - -`void` diff --git a/packages/altair-docs/api/plugin/base/index.md b/packages/altair-docs/api/plugin/base/index.md deleted file mode 100644 index 5530b7fa87..0000000000 --- a/packages/altair-docs/api/plugin/base/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# plugin/base - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginBase](classes/PluginBase.md) | - | -| [PluginConstructor](interfaces/PluginConstructor.md) | - | diff --git a/packages/altair-docs/api/plugin/base/interfaces/PluginConstructor.md b/packages/altair-docs/api/plugin/base/interfaces/PluginConstructor.md deleted file mode 100644 index e1bd1a1927..0000000000 --- a/packages/altair-docs/api/plugin/base/interfaces/PluginConstructor.md +++ /dev/null @@ -1,15 +0,0 @@ -# PluginConstructor\ - -## Type parameters - -• **T** *extends* [`PluginBase`](../classes/PluginBase.md) = [`PluginBase`](../classes/PluginBase.md) - -## Constructors - -### new PluginConstructor() - -> **new PluginConstructor**(): `T` - -#### Returns - -`T` diff --git a/packages/altair-docs/api/plugin/context/context.interface/index.md b/packages/altair-docs/api/plugin/context/context.interface/index.md deleted file mode 100644 index 11d9091755..0000000000 --- a/packages/altair-docs/api/plugin/context/context.interface/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# plugin/context/context.interface - -## Index - -| Member | Description | -| :------ | :------ | -| [CreateActionOptions](interfaces/CreateActionOptions.md) | - | -| [CreatePanelOptions](interfaces/CreatePanelOptions.md) | - | -| [PluginContext](interfaces/PluginContext.md) | - | -| [PluginContextGenerator](interfaces/PluginContextGenerator.md) | - | -| [PluginWindowState](interfaces/PluginWindowState.md) | Data structure for exported windows | diff --git a/packages/altair-docs/api/plugin/context/context.interface/interfaces/CreateActionOptions.md b/packages/altair-docs/api/plugin/context/context.interface/interfaces/CreateActionOptions.md deleted file mode 100644 index 17850cb90b..0000000000 --- a/packages/altair-docs/api/plugin/context/context.interface/interfaces/CreateActionOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -# CreateActionOptions - -## Properties - -### execute() - -> **execute**: (`data`: [`PluginWindowState`](PluginWindowState.md)) => `void` - -#### Parameters - -• **data**: [`PluginWindowState`](PluginWindowState.md) - -#### Returns - -`void` - -*** - -### location? - -> `optional` **location**: [`RESULT_PANE`](../../../ui-action/enumerations/AltairUiActionLocation.md#result_pane) - -*** - -### title - -> **title**: `string` diff --git a/packages/altair-docs/api/plugin/context/context.interface/interfaces/CreatePanelOptions.md b/packages/altair-docs/api/plugin/context/context.interface/interfaces/CreatePanelOptions.md deleted file mode 100644 index 2e3219b922..0000000000 --- a/packages/altair-docs/api/plugin/context/context.interface/interfaces/CreatePanelOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreatePanelOptions - -## Properties - -### location? - -> `optional` **location**: [`AltairPanelLocation`](../../../panel/enumerations/AltairPanelLocation.md) - -*** - -### title? - -> `optional` **title**: `string` diff --git a/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginContext.md b/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginContext.md deleted file mode 100644 index 4e10411e91..0000000000 --- a/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginContext.md +++ /dev/null @@ -1,232 +0,0 @@ -# PluginContext - -## Properties - -### app - -> **app**: `object` - -#### addSubscriptionProvider() - -##### Parameters - -• **providerData**: [`SubscriptionProviderData`](../../../../subscriptions/interfaces/SubscriptionProviderData.md) - -##### Returns - -`void` - -#### createAction() - -action has 1 location for now: resultpane - -Each call creates a new action. Instead, plugins should create action once, when needed -Action can be destroyed when the plugin decides to. - -returns action instance (includes destroy() method) - -##### Parameters - -• **options**: [`CreateActionOptions`](CreateActionOptions.md) - -##### Returns - -[`AltairUiAction`](../../../ui-action/classes/AltairUiAction.md) - -#### createPanel() - -panel has two locations: sidebar, header - -Each call creates a new panel. Instead, plugin should create panel only once (@initialize) -Panel can be destroyed when the plugin is unused. - -returns panel instance (includes destroy() method) - -##### Parameters - -• **element**: `HTMLElement` - -• **options?**: [`CreatePanelOptions`](CreatePanelOptions.md) - -##### Returns - -[`AltairPanel`](../../../panel/classes/AltairPanel.md) - -#### createWindow() - -##### Parameters - -• **data**: [`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md) - -##### Returns - -`void` - -#### destroyAction() - -##### Parameters - -• **uiAction**: [`AltairUiAction`](../../../ui-action/classes/AltairUiAction.md) - -##### Returns - -`void` - -#### destroyPanel() - -##### Parameters - -• **panel**: [`AltairPanel`](../../../panel/classes/AltairPanel.md) - -##### Returns - -`void` - -#### executeCommand() - -##### Returns - -`void` - -#### getCurrentWindowState() - -##### Returns - -`Promise`\<`undefined` \| [`PluginWindowState`](PluginWindowState.md)\> - -#### getWindowState() - -Returns an allowed set of data from the state visible to plugins - -Since it is a method, the state can be generated when called. -So we can ensure uniqueness of the state, as well as avoid passing values by references. - -##### Parameters - -• **windowId**: `string` - -##### Returns - -`Promise`\<`undefined` \| [`PluginWindowState`](PluginWindowState.md)\> - -#### isElectron() - -##### Returns - -`boolean` - -#### setEndpoint() - -##### Parameters - -• **windowId**: `string` - -• **url**: `string` - -##### Returns - -`void` - -#### setHeader() - -##### Parameters - -• **windowId**: `string` - -• **key**: `string` - -• **value**: `string` - -##### Returns - -`void` - -#### setQuery() - -##### Parameters - -• **windowId**: `string` - -• **query**: `string` - -##### Returns - -`void` - -#### setVariables() - -##### Parameters - -• **windowId**: `string` - -• **variables**: `string` - -##### Returns - -`void` - -*** - -### events - -> **events**: `object` - -#### off() - -##### Returns - -`void` - -#### on() - -##### Type parameters - -• **E** *extends* keyof [`PluginEventPayloadMap`](../../../event/event.interfaces/interfaces/PluginEventPayloadMap.md) - -##### Parameters - -• **event**: `E` - -• **callback**: [`PluginEventCallback`](../../../event/event.interfaces/type-aliases/PluginEventCallback.md)\<`E`\> - -##### Returns - -`object` - -###### unsubscribe() - -> **unsubscribe**: () => `void` - -###### Returns - -`void` - -*** - -### theme - -> **theme**: `object` - -#### add() - -##### Parameters - -• **name**: `string` - -• **theme**: `RecursivePartial`\<`object` & `object`\> - -##### Returns - -`void` - -#### enable() - -##### Parameters - -• **name**: `string` - -• **darkMode?**: `boolean` - -##### Returns - -`Promise`\<`void`\> diff --git a/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginContextGenerator.md b/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginContextGenerator.md deleted file mode 100644 index 19fc24a389..0000000000 --- a/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginContextGenerator.md +++ /dev/null @@ -1,17 +0,0 @@ -# PluginContextGenerator - -## Methods - -### createV1Context() - -> **createV1Context**(`pluginName`: `string`, `plugin`: [`AltairV1Plugin`](../../../plugin.interfaces/interfaces/AltairV1Plugin.md)): [`PluginContext`](PluginContext.md) - -#### Parameters - -• **pluginName**: `string` - -• **plugin**: [`AltairV1Plugin`](../../../plugin.interfaces/interfaces/AltairV1Plugin.md) - -#### Returns - -[`PluginContext`](PluginContext.md) diff --git a/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginWindowState.md b/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginWindowState.md deleted file mode 100644 index ee43ac4a16..0000000000 --- a/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginWindowState.md +++ /dev/null @@ -1,223 +0,0 @@ -# PluginWindowState - -Data structure for exported windows - -## Extends - -- [`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md) - -## Properties - -### apiUrl - -> **apiUrl**: `string` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`apiUrl`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#apiurl) - -*** - -### collectionId? - -> `optional` **collectionId**: `string` - -ID of the collection this query belongs to - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`collectionId`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#collectionid) - -*** - -### gqlSchema? - -> `optional` **gqlSchema**: `GraphQLSchema` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`gqlSchema`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#gqlschema) - -*** - -### headers - -> **headers**: `object`[] - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`headers`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#headers) - -*** - -### postRequestScript? - -> `optional` **postRequestScript**: `string` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`postRequestScript`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#postrequestscript) - -*** - -### postRequestScriptEnabled? - -> `optional` **postRequestScriptEnabled**: `boolean` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`postRequestScriptEnabled`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#postrequestscriptenabled) - -*** - -### preRequestScript? - -> `optional` **preRequestScript**: `string` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`preRequestScript`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#prerequestscript) - -*** - -### preRequestScriptEnabled? - -> `optional` **preRequestScriptEnabled**: `boolean` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`preRequestScriptEnabled`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#prerequestscriptenabled) - -*** - -### query - -> **query**: `string` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`query`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#query) - -*** - -### queryResult - -> **queryResult**: `string` - -*** - -### requestEndTime - -> **requestEndTime**: `number` - -*** - -### requestStartTime - -> **requestStartTime**: `number` - -*** - -### responseStatus - -> **responseStatus**: `number` - -*** - -### responseTime - -> **responseTime**: `number` - -*** - -### sdl - -> **sdl**: `string` - -*** - -### subscriptionConnectionParams? - -> `optional` **subscriptionConnectionParams**: `string` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`subscriptionConnectionParams`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#subscriptionconnectionparams) - -*** - -### subscriptionProvider? - -> `optional` **subscriptionProvider**: [`SubscriptionProviderIds`](../../../../subscriptions/type-aliases/SubscriptionProviderIds.md) - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`subscriptionProvider`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#subscriptionprovider) - -*** - -### subscriptionUrl - -> **subscriptionUrl**: `string` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`subscriptionUrl`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#subscriptionurl) - -*** - -### type - -> **type**: `"window"` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`type`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#type) - -*** - -### variables - -> **variables**: `string` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`variables`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#variables) - -*** - -### version - -> **version**: `1` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`version`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#version) - -*** - -### windowId - -> **windowId**: `string` - -*** - -### windowIdInCollection? - -> `optional` **windowIdInCollection**: `string` - -ID for window in collection - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`windowIdInCollection`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#windowidincollection) - -*** - -### windowName - -> **windowName**: `string` - -#### Inherited from - -[`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md).[`windowName`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md#windowname) diff --git a/packages/altair-docs/api/plugin/event/event.interfaces/index.md b/packages/altair-docs/api/plugin/event/event.interfaces/index.md deleted file mode 100644 index d505993eaf..0000000000 --- a/packages/altair-docs/api/plugin/event/event.interfaces/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# plugin/event/event.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginEventPayloadMap](interfaces/PluginEventPayloadMap.md) | - | -| [PluginEvent](type-aliases/PluginEvent.md) | - | -| [PluginEventCallback](type-aliases/PluginEventCallback.md) | - | diff --git a/packages/altair-docs/api/plugin/event/event.interfaces/interfaces/PluginEventPayloadMap.md b/packages/altair-docs/api/plugin/event/event.interfaces/interfaces/PluginEventPayloadMap.md deleted file mode 100644 index fe2d8735fa..0000000000 --- a/packages/altair-docs/api/plugin/event/event.interfaces/interfaces/PluginEventPayloadMap.md +++ /dev/null @@ -1,89 +0,0 @@ -# PluginEventPayloadMap - -## Properties - -### app-ready - -> **app-ready**: `boolean` - -*** - -### current-window.change - -> **current-window.change**: `object` - -#### windowId - -> **windowId**: `string` - -*** - -### query-result-meta.change - -> **query-result-meta.change**: `object` - -#### data - -> **data**: `object` - -#### data.requestEndTime - -> **requestEndTime**: `number` - -#### data.requestStartTime - -> **requestStartTime**: `number` - -#### data.responseStatus - -> **responseStatus**: `number` - -#### data.responseTime - -> **responseTime**: `number` - -#### windowId - -> **windowId**: `string` - -*** - -### query-result.change - -> **query-result.change**: `object` - -#### data - -> **data**: `any` - -#### windowId - -> **windowId**: `string` - -*** - -### query.change - -> **query.change**: `object` - -#### data - -> **data**: `string` - -#### windowId - -> **windowId**: `string` - -*** - -### sdl.change - -> **sdl.change**: `object` - -#### data - -> **data**: `string` - -#### windowId - -> **windowId**: `string` diff --git a/packages/altair-docs/api/plugin/event/event.interfaces/type-aliases/PluginEvent.md b/packages/altair-docs/api/plugin/event/event.interfaces/type-aliases/PluginEvent.md deleted file mode 100644 index 2b9036161a..0000000000 --- a/packages/altair-docs/api/plugin/event/event.interfaces/type-aliases/PluginEvent.md +++ /dev/null @@ -1,3 +0,0 @@ -# PluginEvent - -> **PluginEvent**: keyof [`PluginEventPayloadMap`](../interfaces/PluginEventPayloadMap.md) diff --git a/packages/altair-docs/api/plugin/event/event.interfaces/type-aliases/PluginEventCallback.md b/packages/altair-docs/api/plugin/event/event.interfaces/type-aliases/PluginEventCallback.md deleted file mode 100644 index ad4bf7d554..0000000000 --- a/packages/altair-docs/api/plugin/event/event.interfaces/type-aliases/PluginEventCallback.md +++ /dev/null @@ -1,15 +0,0 @@ -# PluginEventCallback()\ - -> **PluginEventCallback**\<`T`\>: (`payload`: [`PluginEventPayloadMap`](../interfaces/PluginEventPayloadMap.md)\[`T`\]) => `void` - -## Type parameters - -• **T** *extends* [`PluginEvent`](PluginEvent.md) - -## Parameters - -• **payload**: [`PluginEventPayloadMap`](../interfaces/PluginEventPayloadMap.md)\[`T`\] - -## Returns - -`void` diff --git a/packages/altair-docs/api/plugin/panel/classes/AltairPanel.md b/packages/altair-docs/api/plugin/panel/classes/AltairPanel.md deleted file mode 100644 index 5ff9fc2633..0000000000 --- a/packages/altair-docs/api/plugin/panel/classes/AltairPanel.md +++ /dev/null @@ -1,69 +0,0 @@ -# AltairPanel - -Used for dynamic panel elements. Can also be used for angular components in the future. - -## Constructors - -### new AltairPanel() - -> **new AltairPanel**(`title`: `string`, `element`: `HTMLElement`, `location`: [`AltairPanelLocation`](../enumerations/AltairPanelLocation.md), `engine`?: [`PluginParentEngine`](../../v3/parent-engine/classes/PluginParentEngine.md)): [`AltairPanel`](AltairPanel.md) - -#### Parameters - -• **title**: `string` - -• **element**: `HTMLElement` - -• **location**: [`AltairPanelLocation`](../enumerations/AltairPanelLocation.md) - -• **engine?**: [`PluginParentEngine`](../../v3/parent-engine/classes/PluginParentEngine.md) - -#### Returns - -[`AltairPanel`](AltairPanel.md) - -## Properties - -### element - -> **element**: `HTMLElement` - -*** - -### engine? - -> `optional` **engine**: [`PluginParentEngine`](../../v3/parent-engine/classes/PluginParentEngine.md) - -*** - -### id - -> **id**: `string` - -*** - -### isActive - -> **isActive**: `boolean` = `false` - -*** - -### location - -> **location**: [`AltairPanelLocation`](../enumerations/AltairPanelLocation.md) - -*** - -### title - -> **title**: `string` - -## Methods - -### destroy() - -> **destroy**(): `void` - -#### Returns - -`void` diff --git a/packages/altair-docs/api/plugin/panel/enumerations/AltairPanelLocation.md b/packages/altair-docs/api/plugin/panel/enumerations/AltairPanelLocation.md deleted file mode 100644 index b930ffc8ea..0000000000 --- a/packages/altair-docs/api/plugin/panel/enumerations/AltairPanelLocation.md +++ /dev/null @@ -1,19 +0,0 @@ -# AltairPanelLocation - -## Enumeration Members - -### HEADER - -> **HEADER**: `"header"` - -*** - -### RESULT\_PANE\_BOTTOM - -> **RESULT\_PANE\_BOTTOM**: `"result_pane_bottom"` - -*** - -### SIDEBAR - -> **SIDEBAR**: `"sidebar"` diff --git a/packages/altair-docs/api/plugin/panel/index.md b/packages/altair-docs/api/plugin/panel/index.md deleted file mode 100644 index 591e5f4490..0000000000 --- a/packages/altair-docs/api/plugin/panel/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# plugin/panel - -## Index - -| Member | Description | -| :------ | :------ | -| [AltairPanelLocation](enumerations/AltairPanelLocation.md) | - | -| [AltairPanel](classes/AltairPanel.md) | Used for dynamic panel elements. Can also be used for angular components in the future. | diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/enumerations/PluginSource.md b/packages/altair-docs/api/plugin/plugin.interfaces/enumerations/PluginSource.md deleted file mode 100644 index 566ef7faf4..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/enumerations/PluginSource.md +++ /dev/null @@ -1,22 +0,0 @@ -# PluginSource - -Defines the repository of the plugin. -Used to know where to get the plugin from. - -## Enumeration Members - -### GITHUB - -> **GITHUB**: `"github"` - -*** - -### NPM - -> **NPM**: `"npm"` - -*** - -### URL - -> **URL**: `"url"` diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/enumerations/PluginType.md b/packages/altair-docs/api/plugin/plugin.interfaces/enumerations/PluginType.md deleted file mode 100644 index 662b328936..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/enumerations/PluginType.md +++ /dev/null @@ -1,22 +0,0 @@ -# PluginType - -Specifies the type of the plugin. -Determines how the plugin would interact with Altair. - -## Enumeration Members - -### ACTION\_BUTTON - -> **ACTION\_BUTTON**: `"action_button"` - -*** - -### HEADER - -> **HEADER**: `"header"` - -*** - -### SIDEBAR - -> **SIDEBAR**: `"sidebar"` diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/functions/createV1Plugin.md b/packages/altair-docs/api/plugin/plugin.interfaces/functions/createV1Plugin.md deleted file mode 100644 index 9f24badf91..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/functions/createV1Plugin.md +++ /dev/null @@ -1,13 +0,0 @@ -# createV1Plugin() - -> **createV1Plugin**(`name`: `string`, `manifest`: [`PluginManifest`](../interfaces/PluginManifest.md)): [`AltairV1Plugin`](../interfaces/AltairV1Plugin.md) - -## Parameters - -• **name**: `string` - -• **manifest**: [`PluginManifest`](../interfaces/PluginManifest.md) - -## Returns - -[`AltairV1Plugin`](../interfaces/AltairV1Plugin.md) diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/index.md b/packages/altair-docs/api/plugin/plugin.interfaces/index.md deleted file mode 100644 index 5c5e796e08..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# plugin/plugin.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginSource](enumerations/PluginSource.md) | Defines the repository of the plugin. Used to know where to get the plugin from. | -| [PluginType](enumerations/PluginType.md) | Specifies the type of the plugin. Determines how the plugin would interact with Altair. | -| [AltairV1Plugin](interfaces/AltairV1Plugin.md) | - | -| [PluginManifest](interfaces/PluginManifest.md) | Plugin Manifest Structure | -| [RemotePluginListItem](interfaces/RemotePluginListItem.md) | - | -| [RemotePluginListResponse](interfaces/RemotePluginListResponse.md) | - | -| [PluginCapabilities](type-aliases/PluginCapabilities.md) | Specifies the capabilities (functionalities) available to the plugin. In the future, this would be used to request the necessary permissions from the user. | -| [createV1Plugin](functions/createV1Plugin.md) | - | diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/AltairV1Plugin.md b/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/AltairV1Plugin.md deleted file mode 100644 index e019a27121..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/AltairV1Plugin.md +++ /dev/null @@ -1,37 +0,0 @@ -# AltairV1Plugin - -## Properties - -### capabilities - -> **capabilities**: [`PluginCapabilities`](../type-aliases/PluginCapabilities.md)[] - -*** - -### display\_name - -> **display\_name**: `string` - -*** - -### manifest - -> **manifest**: [`PluginManifest`](PluginManifest.md) - -*** - -### name - -> **name**: `string` - -*** - -### plugin\_class? - -> `optional` **plugin\_class**: `string` - -*** - -### type? - -> `optional` **type**: [`PluginType`](../enumerations/PluginType.md) diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/PluginManifest.md b/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/PluginManifest.md deleted file mode 100644 index 88e9b09a82..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/PluginManifest.md +++ /dev/null @@ -1,75 +0,0 @@ -# PluginManifest - -Plugin Manifest Structure - -## Properties - -### author? - -> `optional` **author**: `string` - -*** - -### author\_email? - -> `optional` **author\_email**: `string` - -*** - -### capabilities? - -> `optional` **capabilities**: [`PluginCapabilities`](../type-aliases/PluginCapabilities.md)[] - -*** - -### description - -> **description**: `string` - -*** - -### display\_name - -> **display\_name**: `string` - -*** - -### manifest\_version - -> **manifest\_version**: `1` \| `2` - -*** - -### name - -> **name**: `string` - -*** - -### plugin\_class? - -> `optional` **plugin\_class**: `string` - -*** - -### scripts - -> **scripts**: `string`[] - -*** - -### styles? - -> `optional` **styles**: `string`[] - -*** - -### type? - -> `optional` **type**: [`PluginType`](../enumerations/PluginType.md) - -*** - -### version - -> **version**: `string` diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/RemotePluginListItem.md b/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/RemotePluginListItem.md deleted file mode 100644 index 9f1839b253..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/RemotePluginListItem.md +++ /dev/null @@ -1,55 +0,0 @@ -# RemotePluginListItem - -## Properties - -### author - -> **author**: `null` \| `string` - -*** - -### created\_at - -> **created\_at**: `number` - -*** - -### description - -> **description**: `string` - -*** - -### homepage - -> **homepage**: `null` \| `string` - -*** - -### manifest - -> **manifest**: [`PluginManifest`](PluginManifest.md) - -*** - -### name - -> **name**: `string` - -*** - -### summary - -> **summary**: `null` \| `string` - -*** - -### updated\_at - -> **updated\_at**: `number` - -*** - -### version - -> **version**: `string` diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/RemotePluginListResponse.md b/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/RemotePluginListResponse.md deleted file mode 100644 index 51cb04816b..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/RemotePluginListResponse.md +++ /dev/null @@ -1,19 +0,0 @@ -# RemotePluginListResponse - -## Properties - -### items - -> **items**: [`RemotePluginListItem`](RemotePluginListItem.md)[] - -*** - -### page - -> **page**: `number` - -*** - -### total - -> **total**: `number` diff --git a/packages/altair-docs/api/plugin/plugin.interfaces/type-aliases/PluginCapabilities.md b/packages/altair-docs/api/plugin/plugin.interfaces/type-aliases/PluginCapabilities.md deleted file mode 100644 index 4289d9d82f..0000000000 --- a/packages/altair-docs/api/plugin/plugin.interfaces/type-aliases/PluginCapabilities.md +++ /dev/null @@ -1,6 +0,0 @@ -# PluginCapabilities - -> **PluginCapabilities**: `"query:read"` \| `"query:write"` \| `"header:read"` \| `"header:write"` \| `"environment:read"` \| `"environment:write"` - -Specifies the capabilities (functionalities) available to the plugin. -In the future, this would be used to request the necessary permissions from the user. diff --git a/packages/altair-docs/api/plugin/ui-action/classes/AltairUiAction.md b/packages/altair-docs/api/plugin/ui-action/classes/AltairUiAction.md deleted file mode 100644 index e617d48881..0000000000 --- a/packages/altair-docs/api/plugin/ui-action/classes/AltairUiAction.md +++ /dev/null @@ -1,57 +0,0 @@ -# AltairUiAction - -## Constructors - -### new AltairUiAction() - -> **new AltairUiAction**(`title`: `string`, `location`: [`RESULT_PANE`](../enumerations/AltairUiActionLocation.md#result_pane), `callback`: () => `void`): [`AltairUiAction`](AltairUiAction.md) - -#### Parameters - -• **title**: `string` - -• **location**: [`RESULT_PANE`](../enumerations/AltairUiActionLocation.md#result_pane) - -• **callback** - -#### Returns - -[`AltairUiAction`](AltairUiAction.md) - -## Properties - -### callback() - -> **callback**: () => `void` - -#### Returns - -`void` - -*** - -### id - -> **id**: `string` - -*** - -### location - -> **location**: [`RESULT_PANE`](../enumerations/AltairUiActionLocation.md#result_pane) - -*** - -### title - -> **title**: `string` - -## Methods - -### execute() - -> **execute**(): `void` - -#### Returns - -`void` diff --git a/packages/altair-docs/api/plugin/ui-action/enumerations/AltairUiActionLocation.md b/packages/altair-docs/api/plugin/ui-action/enumerations/AltairUiActionLocation.md deleted file mode 100644 index 52f47b9f10..0000000000 --- a/packages/altair-docs/api/plugin/ui-action/enumerations/AltairUiActionLocation.md +++ /dev/null @@ -1,7 +0,0 @@ -# AltairUiActionLocation - -## Enumeration Members - -### RESULT\_PANE - -> **RESULT\_PANE**: `"result_pane"` diff --git a/packages/altair-docs/api/plugin/ui-action/index.md b/packages/altair-docs/api/plugin/ui-action/index.md deleted file mode 100644 index 0d8e35de0f..0000000000 --- a/packages/altair-docs/api/plugin/ui-action/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# plugin/ui-action - -## Index - -| Member | Description | -| :------ | :------ | -| [AltairUiActionLocation](enumerations/AltairUiActionLocation.md) | - | -| [AltairUiAction](classes/AltairUiAction.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/capabilities/index.md b/packages/altair-docs/api/plugin/v3/capabilities/index.md deleted file mode 100644 index 8b49c61e24..0000000000 --- a/packages/altair-docs/api/plugin/v3/capabilities/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# plugin/v3/capabilities - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginCapabilities](type-aliases/PluginCapabilities.md) | Specifies the capabilities (functionalities) available to the plugin. In the future, this would be used to request the necessary permissions from the user. | diff --git a/packages/altair-docs/api/plugin/v3/capabilities/type-aliases/PluginCapabilities.md b/packages/altair-docs/api/plugin/v3/capabilities/type-aliases/PluginCapabilities.md deleted file mode 100644 index 4289d9d82f..0000000000 --- a/packages/altair-docs/api/plugin/v3/capabilities/type-aliases/PluginCapabilities.md +++ /dev/null @@ -1,6 +0,0 @@ -# PluginCapabilities - -> **PluginCapabilities**: `"query:read"` \| `"query:write"` \| `"header:read"` \| `"header:write"` \| `"environment:read"` \| `"environment:write"` - -Specifies the capabilities (functionalities) available to the plugin. -In the future, this would be used to request the necessary permissions from the user. diff --git a/packages/altair-docs/api/plugin/v3/context/index.md b/packages/altair-docs/api/plugin/v3/context/index.md deleted file mode 100644 index 66689208da..0000000000 --- a/packages/altair-docs/api/plugin/v3/context/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# plugin/v3/context - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginV3Context](interfaces/PluginV3Context.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/context/interfaces/PluginV3Context.md b/packages/altair-docs/api/plugin/v3/context/interfaces/PluginV3Context.md deleted file mode 100644 index a6bf95856c..0000000000 --- a/packages/altair-docs/api/plugin/v3/context/interfaces/PluginV3Context.md +++ /dev/null @@ -1,281 +0,0 @@ -# PluginV3Context - -## Methods - -### addTheme() - -> **addTheme**(`name`: `string`, `theme`: `RecursivePartial`\<`object` & `object`\>): `Promise`\<`void`\> - -Add a custom theme to the app - -#### Parameters - -• **name**: `string` - -• **theme**: `RecursivePartial`\<`object` & `object`\> - -#### Returns - -`Promise`\<`void`\> - -*** - -### createAction() - -> **createAction**(`options`: [`CreateActionOptions`](../../../context/context.interface/interfaces/CreateActionOptions.md)): `Promise`\<`undefined` \| `string`\> - -Adds a button in the app to perform an action. -The action is defined by the plugin and is executed when the button is clicked. - -This returns the unique id of the action. - -#### Parameters - -• **options**: [`CreateActionOptions`](../../../context/context.interface/interfaces/CreateActionOptions.md) - -#### Returns - -`Promise`\<`undefined` \| `string`\> - -*** - -### createPanel() - -> **createPanel**(`panelName`: `string`, `options`?: [`CreatePanelOptions`](../../../context/context.interface/interfaces/CreatePanelOptions.md)): `Promise`\<`undefined` \| `string`\> - -Create an AltairPanel instance for displaying content in the app based on the panel name. -The panel names are defined in the plugin options when the plugin is initialized. - -This returns the unique id of the panel. - -#### Parameters - -• **panelName**: `string` - -• **options?**: [`CreatePanelOptions`](../../../context/context.interface/interfaces/CreatePanelOptions.md) - -#### Returns - -`Promise`\<`undefined` \| `string`\> - -*** - -### createWindow() - -> **createWindow**(`data`: [`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md)): `Promise`\<`void`\> - -Create a new window in the app with the given data - -#### Parameters - -• **data**: [`ExportWindowState`](../../../../types/state/window.interfaces/interfaces/ExportWindowState.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### destroyAction() - -> **destroyAction**(`actionId`: `string`): `Promise`\<`void`\> - -Destroy an action based on its unique id - -#### Parameters - -• **actionId**: `string` - -#### Returns - -`Promise`\<`void`\> - -*** - -### destroyPanel() - -> **destroyPanel**(`panelId`: `string`): `Promise`\<`void`\> - -Destroy a panel based on its unique id - -#### Parameters - -• **panelId**: `string` - -#### Returns - -`Promise`\<`void`\> - -*** - -### enableTheme() - -> **enableTheme**(`name`: `string`, `darkMode`?: `boolean`): `Promise`\<`void`\> - -Enable a theme in the app - -#### Parameters - -• **name**: `string` - -• **darkMode?**: `boolean` - -#### Returns - -`Promise`\<`void`\> - -*** - -### getCurrentWindowState() - -> **getCurrentWindowState**(): `Promise`\<`undefined` \| [`PluginWindowState`](../../../context/context.interface/interfaces/PluginWindowState.md)\> - -Returns data about the current window (tab) in the app - -#### Returns - -`Promise`\<`undefined` \| [`PluginWindowState`](../../../context/context.interface/interfaces/PluginWindowState.md)\> - -*** - -### getWindowState() - -> **getWindowState**(`windowId`: `string`): `Promise`\<`undefined` \| [`PluginWindowState`](../../../context/context.interface/interfaces/PluginWindowState.md)\> - -Returns data about a window (tab) in the app - -#### Parameters - -• **windowId**: `string` - -#### Returns - -`Promise`\<`undefined` \| [`PluginWindowState`](../../../context/context.interface/interfaces/PluginWindowState.md)\> - -*** - -### isElectron() - -> **isElectron**(): `Promise`\<`boolean`\> - -Check if the app is running in an Electron environment - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### off() - -> **off**(): `void` - -Remove all the event listeners - -#### Returns - -`void` - -*** - -### on() - -> **on**\<`E`\>(`event`: `E`, `callback`: [`PluginEventCallback`](../../../event/event.interfaces/type-aliases/PluginEventCallback.md)\<`E`\>): `object` - -Subscribe to an event in the app - -#### Type parameters - -• **E** *extends* keyof [`PluginEventPayloadMap`](../../../event/event.interfaces/interfaces/PluginEventPayloadMap.md) - -#### Parameters - -• **event**: `E` - -• **callback**: [`PluginEventCallback`](../../../event/event.interfaces/type-aliases/PluginEventCallback.md)\<`E`\> - -#### Returns - -`object` - -##### unsubscribe() - -> **unsubscribe**: () => `void` - -###### Returns - -`void` - -*** - -### setEndpoint() - -> **setEndpoint**(`windowId`: `string`, `url`: `string`): `Promise`\<`void`\> - -Set the endpoint in the app for the given window - -#### Parameters - -• **windowId**: `string` - -• **url**: `string` - -#### Returns - -`Promise`\<`void`\> - -*** - -### setHeader() - -> **setHeader**(`windowId`: `string`, `key`: `string`, `value`: `string`): `Promise`\<`void`\> - -Add a header in the app for the given window - -#### Parameters - -• **windowId**: `string` - -• **key**: `string` - -• **value**: `string` - -#### Returns - -`Promise`\<`void`\> - -*** - -### setQuery() - -> **setQuery**(`windowId`: `string`, `query`: `string`): `Promise`\<`void`\> - -Set the query in the app for the given window - -#### Parameters - -• **windowId**: `string` - -• **query**: `string` - -#### Returns - -`Promise`\<`void`\> - -*** - -### setVariables() - -> **setVariables**(`windowId`: `string`, `variables`: `string`): `Promise`\<`void`\> - -Set the variables in the app for the given window - -#### Parameters - -• **windowId**: `string` - -• **variables**: `string` - -#### Returns - -`Promise`\<`void`\> diff --git a/packages/altair-docs/api/plugin/v3/events/functions/getActionEvent.md b/packages/altair-docs/api/plugin/v3/events/functions/getActionEvent.md deleted file mode 100644 index 7b991ebd48..0000000000 --- a/packages/altair-docs/api/plugin/v3/events/functions/getActionEvent.md +++ /dev/null @@ -1,11 +0,0 @@ -# getActionEvent() - -> **getActionEvent**(`actionId`: `string`): `string` - -## Parameters - -• **actionId**: `string` - -## Returns - -`string` diff --git a/packages/altair-docs/api/plugin/v3/events/index.md b/packages/altair-docs/api/plugin/v3/events/index.md deleted file mode 100644 index c37ef9e96a..0000000000 --- a/packages/altair-docs/api/plugin/v3/events/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# plugin/v3/events - -## Index - -| Member | Description | -| :------ | :------ | -| [PLUGIN\_CREATE\_ACTION\_EVENT](variables/PLUGIN_CREATE_ACTION_EVENT.md) | - | -| [PLUGIN\_ENGINE\_READY](variables/PLUGIN_ENGINE_READY.md) | - | -| [PLUGIN\_GET\_APP\_STYLE\_URL\_EVENT](variables/PLUGIN_GET_APP_STYLE_URL_EVENT.md) | - | -| [PLUGIN\_SUBSCRIBE\_TO\_EVENT](variables/PLUGIN_SUBSCRIBE_TO_EVENT.md) | - | -| [getActionEvent](functions/getActionEvent.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_CREATE_ACTION_EVENT.md b/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_CREATE_ACTION_EVENT.md deleted file mode 100644 index 9762e5ffe4..0000000000 --- a/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_CREATE_ACTION_EVENT.md +++ /dev/null @@ -1,3 +0,0 @@ -# PLUGIN\_CREATE\_ACTION\_EVENT - -> `const` **PLUGIN\_CREATE\_ACTION\_EVENT**: `"plugin::create_action"` = `'plugin::create_action'` diff --git a/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_ENGINE_READY.md b/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_ENGINE_READY.md deleted file mode 100644 index 96f34b824d..0000000000 --- a/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_ENGINE_READY.md +++ /dev/null @@ -1,3 +0,0 @@ -# PLUGIN\_ENGINE\_READY - -> `const` **PLUGIN\_ENGINE\_READY**: `"plugin-engine::ready"` = `'plugin-engine::ready'` diff --git a/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_GET_APP_STYLE_URL_EVENT.md b/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_GET_APP_STYLE_URL_EVENT.md deleted file mode 100644 index 4e1ad69637..0000000000 --- a/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_GET_APP_STYLE_URL_EVENT.md +++ /dev/null @@ -1,3 +0,0 @@ -# PLUGIN\_GET\_APP\_STYLE\_URL\_EVENT - -> `const` **PLUGIN\_GET\_APP\_STYLE\_URL\_EVENT**: `"plugin::get_app_style_url"` = `'plugin::get_app_style_url'` diff --git a/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_SUBSCRIBE_TO_EVENT.md b/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_SUBSCRIBE_TO_EVENT.md deleted file mode 100644 index 0eda7dad51..0000000000 --- a/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_SUBSCRIBE_TO_EVENT.md +++ /dev/null @@ -1,3 +0,0 @@ -# PLUGIN\_SUBSCRIBE\_TO\_EVENT - -> `const` **PLUGIN\_SUBSCRIBE\_TO\_EVENT**: `"plugin::subscribe_to_event"` = `'plugin::subscribe_to_event'` diff --git a/packages/altair-docs/api/plugin/v3/frame-engine/classes/PluginFrameEngine.md b/packages/altair-docs/api/plugin/v3/frame-engine/classes/PluginFrameEngine.md deleted file mode 100644 index 11693ef046..0000000000 --- a/packages/altair-docs/api/plugin/v3/frame-engine/classes/PluginFrameEngine.md +++ /dev/null @@ -1,47 +0,0 @@ -# PluginFrameEngine - -## Constructors - -### new PluginFrameEngine() - -> **new PluginFrameEngine**(`worker`: [`PluginFrameWorker`](../../frame-worker/classes/PluginFrameWorker.md), `options`: [`PluginV3Options`](../../plugin/interfaces/PluginV3Options.md)): [`PluginFrameEngine`](PluginFrameEngine.md) - -#### Parameters - -• **worker**: [`PluginFrameWorker`](../../frame-worker/classes/PluginFrameWorker.md) - -• **options**: [`PluginV3Options`](../../plugin/interfaces/PluginV3Options.md) - -#### Returns - -[`PluginFrameEngine`](PluginFrameEngine.md) - -## Methods - -### canInitialize() - -> **canInitialize**(): `boolean` - -#### Returns - -`boolean` - -*** - -### getContext() - -> **getContext**(): [`PluginV3Context`](../../context/interfaces/PluginV3Context.md) - -#### Returns - -[`PluginV3Context`](../../context/interfaces/PluginV3Context.md) - -*** - -### ready() - -> **ready**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> diff --git a/packages/altair-docs/api/plugin/v3/frame-engine/index.md b/packages/altair-docs/api/plugin/v3/frame-engine/index.md deleted file mode 100644 index c4b9d9edd3..0000000000 --- a/packages/altair-docs/api/plugin/v3/frame-engine/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# plugin/v3/frame-engine - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginFrameEngine](classes/PluginFrameEngine.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/frame-worker/classes/PluginFrameWorker.md b/packages/altair-docs/api/plugin/v3/frame-worker/classes/PluginFrameWorker.md deleted file mode 100644 index b6e22dd60c..0000000000 --- a/packages/altair-docs/api/plugin/v3/frame-worker/classes/PluginFrameWorker.md +++ /dev/null @@ -1,193 +0,0 @@ -# PluginFrameWorker - -## Extends - -- [`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md) - -## Constructors - -### new PluginFrameWorker() - -> **new PluginFrameWorker**(): [`PluginFrameWorker`](PluginFrameWorker.md) - -#### Returns - -[`PluginFrameWorker`](PluginFrameWorker.md) - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`constructor`](../../../../evaluator/worker/classes/EvaluatorWorker.md#constructors) - -## Methods - -### destroy() - -> **destroy**(): `void` - -#### Returns - -`void` - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`destroy`](../../../../evaluator/worker/classes/EvaluatorWorker.md#destroy) - -*** - -### getInstanceType() - -> **getInstanceType**(): [`InstanceType`](../type-aliases/InstanceType.md) - -#### Returns - -[`InstanceType`](../type-aliases/InstanceType.md) - -*** - -### getParams() - -> **getParams**(): [`FrameQueryParams`](../interfaces/FrameQueryParams.md) - -#### Returns - -[`FrameQueryParams`](../interfaces/FrameQueryParams.md) - -*** - -### onError() - -> **onError**(`handler`: (`err`: `any`) => `void`): `void` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`onError`](../../../../evaluator/worker/classes/EvaluatorWorker.md#onerror) - -*** - -### onMessage() - -> **onMessage**\<`T`, `P`\>(`handler`: (`e`: [`EventData`](../../../../evaluator/worker/interfaces/EventData.md)\<`T`, `P`\>) => `void`): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **P** = `unknown` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`onMessage`](../../../../evaluator/worker/classes/EvaluatorWorker.md#onmessage) - -*** - -### request() - -> **request**\<`T`, `R`\>(`type`: `T`, ...`args`: `unknown`[]): `Promise`\<`undefined` \| `R`\> - -#### Type parameters - -• **T** *extends* `string` - -• **R** = `unknown` - -#### Parameters - -• **type**: `T` - -• ...**args**: `unknown`[] - -#### Returns - -`Promise`\<`undefined` \| `R`\> - -#### Inherited from - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`request`](../../../../evaluator/worker/classes/EvaluatorWorker.md#request) - -*** - -### respond() - -> **respond**\<`T`, `R`\>(`type`: `T`, `handler`: (...`args`: `unknown`[]) => `Promise`\<`R`\>): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **R** = `unknown` - -#### Parameters - -• **type**: `T` - -• **handler** - -#### Returns - -`void` - -#### Inherited from - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`respond`](../../../../evaluator/worker/classes/EvaluatorWorker.md#respond) - -*** - -### send() - -> **send**(`type`: `string`, `payload`: `any`): `void` - -#### Parameters - -• **type**: `string` - -• **payload**: `any` - -#### Returns - -`void` - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`send`](../../../../evaluator/worker/classes/EvaluatorWorker.md#send) - -*** - -### subscribe() - -> **subscribe**\<`T`, `P`\>(`type`: `T`, `handler`: (`type`: `T`, `e`: [`EventData`](../../../../evaluator/worker/interfaces/EventData.md)\<`T`, `P`\>) => `void`): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **P** = `unknown` - -#### Parameters - -• **type**: `T` - -• **handler** - -#### Returns - -`void` - -#### Inherited from - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`subscribe`](../../../../evaluator/worker/classes/EvaluatorWorker.md#subscribe) diff --git a/packages/altair-docs/api/plugin/v3/frame-worker/index.md b/packages/altair-docs/api/plugin/v3/frame-worker/index.md deleted file mode 100644 index 35a3bef7ab..0000000000 --- a/packages/altair-docs/api/plugin/v3/frame-worker/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# plugin/v3/frame-worker - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginFrameWorker](classes/PluginFrameWorker.md) | - | -| [FrameQueryParams](interfaces/FrameQueryParams.md) | - | -| [InstanceType](type-aliases/InstanceType.md) | - | -| [instanceTypes](variables/instanceTypes.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/frame-worker/interfaces/FrameQueryParams.md b/packages/altair-docs/api/plugin/v3/frame-worker/interfaces/FrameQueryParams.md deleted file mode 100644 index 8c26c37bc8..0000000000 --- a/packages/altair-docs/api/plugin/v3/frame-worker/interfaces/FrameQueryParams.md +++ /dev/null @@ -1,23 +0,0 @@ -# FrameQueryParams - -## Indexable - - \[`key`: `string`\]: `string` - -## Properties - -### id - -> **id**: `string` - -*** - -### instanceType - -> **instanceType**: [`InstanceType`](../type-aliases/InstanceType.md) - -*** - -### sc - -> **sc**: `string` diff --git a/packages/altair-docs/api/plugin/v3/frame-worker/type-aliases/InstanceType.md b/packages/altair-docs/api/plugin/v3/frame-worker/type-aliases/InstanceType.md deleted file mode 100644 index 69a776c667..0000000000 --- a/packages/altair-docs/api/plugin/v3/frame-worker/type-aliases/InstanceType.md +++ /dev/null @@ -1,3 +0,0 @@ -# InstanceType - -> **InstanceType**: *typeof* [`instanceTypes`](../variables/instanceTypes.md)\[keyof *typeof* [`instanceTypes`](../variables/instanceTypes.md)\] diff --git a/packages/altair-docs/api/plugin/v3/frame-worker/variables/instanceTypes.md b/packages/altair-docs/api/plugin/v3/frame-worker/variables/instanceTypes.md deleted file mode 100644 index faa2488458..0000000000 --- a/packages/altair-docs/api/plugin/v3/frame-worker/variables/instanceTypes.md +++ /dev/null @@ -1,13 +0,0 @@ -# instanceTypes - -> `const` **instanceTypes**: `object` - -## Type declaration - -### MAIN - -> `readonly` **MAIN**: `"main"` = `'main'` - -### PANEL - -> `readonly` **PANEL**: `"panel"` = `'panel'` diff --git a/packages/altair-docs/api/plugin/v3/manifest/index.md b/packages/altair-docs/api/plugin/v3/manifest/index.md deleted file mode 100644 index c236c81f2a..0000000000 --- a/packages/altair-docs/api/plugin/v3/manifest/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# plugin/v3/manifest - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginV3Manifest](interfaces/PluginV3Manifest.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/manifest/interfaces/PluginV3Manifest.md b/packages/altair-docs/api/plugin/v3/manifest/interfaces/PluginV3Manifest.md deleted file mode 100644 index a6a565d7a1..0000000000 --- a/packages/altair-docs/api/plugin/v3/manifest/interfaces/PluginV3Manifest.md +++ /dev/null @@ -1,73 +0,0 @@ -# PluginV3Manifest - -## Properties - -### author? - -> `optional` **author**: `string` - -Name of the author of the plugin - -*** - -### author\_email? - -> `optional` **author\_email**: `string` - -Email of the author of the plugin - -*** - -### capabilities? - -> `optional` **capabilities**: [`PluginCapabilities`](../../capabilities/type-aliases/PluginCapabilities.md)[] - -capabilities of the plugin - -*** - -### description - -> **description**: `string` - -Description of the plugin - -*** - -### display\_name - -> **display\_name**: `string` - -Display name of the plugin - -*** - -### entry - -> **entry**: `PluginEntry` - -The entry point of the plugin - -*** - -### manifest\_version - -> **manifest\_version**: `3` - -Version of manifest (should be 3) - -*** - -### name - -> **name**: `string` - -Name of the plugin - -*** - -### version - -> **version**: `string` - -Version of the plugin diff --git a/packages/altair-docs/api/plugin/v3/panel/classes/AltairV3Panel.md b/packages/altair-docs/api/plugin/v3/panel/classes/AltairV3Panel.md deleted file mode 100644 index bd0752f6b4..0000000000 --- a/packages/altair-docs/api/plugin/v3/panel/classes/AltairV3Panel.md +++ /dev/null @@ -1,43 +0,0 @@ -# `abstract` AltairV3Panel - -## Constructors - -### new AltairV3Panel() - -> **new AltairV3Panel**(): [`AltairV3Panel`](AltairV3Panel.md) - -#### Returns - -[`AltairV3Panel`](AltairV3Panel.md) - -## Methods - -### create() - -> `abstract` **create**(`ctx`: [`PluginV3Context`](../../context/interfaces/PluginV3Context.md), `container`: `HTMLElement`): `void` - -#### Parameters - -• **ctx**: [`PluginV3Context`](../../context/interfaces/PluginV3Context.md) - -• **container**: `HTMLElement` - -#### Returns - -`void` - -*** - -### initialize() - -> **initialize**(`ctx`: [`PluginV3Context`](../../context/interfaces/PluginV3Context.md), `data`?: `StylesData`): `void` - -#### Parameters - -• **ctx**: [`PluginV3Context`](../../context/interfaces/PluginV3Context.md) - -• **data?**: `StylesData` - -#### Returns - -`void` diff --git a/packages/altair-docs/api/plugin/v3/panel/index.md b/packages/altair-docs/api/plugin/v3/panel/index.md deleted file mode 100644 index 85e5a0705e..0000000000 --- a/packages/altair-docs/api/plugin/v3/panel/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# plugin/v3/panel - -## Index - -| Member | Description | -| :------ | :------ | -| [AltairV3Panel](classes/AltairV3Panel.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/parent-engine/classes/PluginParentEngine.md b/packages/altair-docs/api/plugin/v3/parent-engine/classes/PluginParentEngine.md deleted file mode 100644 index fc8de34c27..0000000000 --- a/packages/altair-docs/api/plugin/v3/parent-engine/classes/PluginParentEngine.md +++ /dev/null @@ -1,75 +0,0 @@ -# PluginParentEngine - -## Constructors - -### new PluginParentEngine() - -> **new PluginParentEngine**(`worker`: [`PluginParentWorker`](../../parent-worker/classes/PluginParentWorker.md)): [`PluginParentEngine`](PluginParentEngine.md) - -#### Parameters - -• **worker**: [`PluginParentWorker`](../../parent-worker/classes/PluginParentWorker.md) - -#### Returns - -[`PluginParentEngine`](PluginParentEngine.md) - -## Properties - -### subscribedEvents - -> **subscribedEvents**: `string`[] = `[]` - -## Methods - -### destroy() - -> **destroy**(): `void` - -#### Returns - -`void` - -*** - -### handleActionEvents() - -> **handleActionEvents**(): `void` - -#### Returns - -`void` - -*** - -### handleEvents() - -> **handleEvents**(): `void` - -#### Returns - -`void` - -*** - -### prepareListeners() - -> **prepareListeners**(): `void` - -#### Returns - -`void` - -*** - -### start() - -> **start**(`context`: [`PluginV3Context`](../../context/interfaces/PluginV3Context.md)): `void` - -#### Parameters - -• **context**: [`PluginV3Context`](../../context/interfaces/PluginV3Context.md) - -#### Returns - -`void` diff --git a/packages/altair-docs/api/plugin/v3/parent-engine/index.md b/packages/altair-docs/api/plugin/v3/parent-engine/index.md deleted file mode 100644 index 92c5d1c1bc..0000000000 --- a/packages/altair-docs/api/plugin/v3/parent-engine/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# plugin/v3/parent-engine - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginParentEngine](classes/PluginParentEngine.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/parent-worker/classes/PluginParentWorker.md b/packages/altair-docs/api/plugin/v3/parent-worker/classes/PluginParentWorker.md deleted file mode 100644 index b9501fb94c..0000000000 --- a/packages/altair-docs/api/plugin/v3/parent-worker/classes/PluginParentWorker.md +++ /dev/null @@ -1,201 +0,0 @@ -# PluginParentWorker - -## Extends - -- [`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md) - -## Constructors - -### new PluginParentWorker() - -> **new PluginParentWorker**(`opts`: [`PluginParentWorkerOptions`](../interfaces/PluginParentWorkerOptions.md)): [`PluginParentWorker`](PluginParentWorker.md) - -#### Parameters - -• **opts**: [`PluginParentWorkerOptions`](../interfaces/PluginParentWorkerOptions.md) - -#### Returns - -[`PluginParentWorker`](PluginParentWorker.md) - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`constructor`](../../../../evaluator/worker/classes/EvaluatorWorker.md#constructors) - -## Methods - -### destroy() - -> **destroy**(): `void` - -#### Returns - -`void` - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`destroy`](../../../../evaluator/worker/classes/EvaluatorWorker.md#destroy) - -*** - -### getIframe() - -> **getIframe**(): `HTMLIFrameElement` - -#### Returns - -`HTMLIFrameElement` - -*** - -### getInstanceType() - -> **getInstanceType**(): [`InstanceType`](../../frame-worker/type-aliases/InstanceType.md) - -#### Returns - -[`InstanceType`](../../frame-worker/type-aliases/InstanceType.md) - -*** - -### onError() - -> **onError**(`handler`: (`err`: `unknown`) => `void`): `void` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`onError`](../../../../evaluator/worker/classes/EvaluatorWorker.md#onerror) - -*** - -### onMessage() - -> **onMessage**\<`T`, `P`\>(`handler`: (`e`: [`EventData`](../../../../evaluator/worker/interfaces/EventData.md)\<`T`, `P`\>) => `void`): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **P** = `unknown` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`onMessage`](../../../../evaluator/worker/classes/EvaluatorWorker.md#onmessage) - -*** - -### request() - -> **request**\<`T`, `R`\>(`type`: `T`, ...`args`: `unknown`[]): `Promise`\<`undefined` \| `R`\> - -#### Type parameters - -• **T** *extends* `string` - -• **R** = `unknown` - -#### Parameters - -• **type**: `T` - -• ...**args**: `unknown`[] - -#### Returns - -`Promise`\<`undefined` \| `R`\> - -#### Inherited from - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`request`](../../../../evaluator/worker/classes/EvaluatorWorker.md#request) - -*** - -### respond() - -> **respond**\<`T`, `R`\>(`type`: `T`, `handler`: (...`args`: `unknown`[]) => `Promise`\<`R`\>): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **R** = `unknown` - -#### Parameters - -• **type**: `T` - -• **handler** - -#### Returns - -`void` - -#### Inherited from - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`respond`](../../../../evaluator/worker/classes/EvaluatorWorker.md#respond) - -*** - -### send() - -> **send**\<`T`\>(`type`: `T`, `payload`?: `unknown`): `void` - -#### Type parameters - -• **T** *extends* `string` - -#### Parameters - -• **type**: `T` - -• **payload?**: `unknown` - -#### Returns - -`void` - -#### Overrides - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`send`](../../../../evaluator/worker/classes/EvaluatorWorker.md#send) - -*** - -### subscribe() - -> **subscribe**\<`T`, `P`\>(`type`: `T`, `handler`: (`type`: `T`, `e`: [`EventData`](../../../../evaluator/worker/interfaces/EventData.md)\<`T`, `P`\>) => `void`): `void` - -#### Type parameters - -• **T** *extends* `string` - -• **P** = `unknown` - -#### Parameters - -• **type**: `T` - -• **handler** - -#### Returns - -`void` - -#### Inherited from - -[`EvaluatorWorker`](../../../../evaluator/worker/classes/EvaluatorWorker.md).[`subscribe`](../../../../evaluator/worker/classes/EvaluatorWorker.md#subscribe) diff --git a/packages/altair-docs/api/plugin/v3/parent-worker/index.md b/packages/altair-docs/api/plugin/v3/parent-worker/index.md deleted file mode 100644 index 792c93873d..0000000000 --- a/packages/altair-docs/api/plugin/v3/parent-worker/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# plugin/v3/parent-worker - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginParentWorker](classes/PluginParentWorker.md) | - | -| [PluginParentWorkerOptions](interfaces/PluginParentWorkerOptions.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/parent-worker/interfaces/PluginParentWorkerOptions.md b/packages/altair-docs/api/plugin/v3/parent-worker/interfaces/PluginParentWorkerOptions.md deleted file mode 100644 index 9bbf9fc25d..0000000000 --- a/packages/altair-docs/api/plugin/v3/parent-worker/interfaces/PluginParentWorkerOptions.md +++ /dev/null @@ -1,37 +0,0 @@ -# PluginParentWorkerOptions - -## Properties - -### additionalParams? - -> `optional` **additionalParams**: `Record`\<`string`, `string`\> - -*** - -### additionalSandboxAttributes? - -> `optional` **additionalSandboxAttributes**: `string`[] - -*** - -### disableAppend? - -> `optional` **disableAppend**: `boolean` - -*** - -### id - -> **id**: `string` - -*** - -### instanceType? - -> `optional` **instanceType**: [`InstanceType`](../../frame-worker/type-aliases/InstanceType.md) - -*** - -### pluginEntrypointUrl - -> **pluginEntrypointUrl**: `string` diff --git a/packages/altair-docs/api/plugin/v3/plugin/classes/PluginV3.md b/packages/altair-docs/api/plugin/v3/plugin/classes/PluginV3.md deleted file mode 100644 index a6837573ea..0000000000 --- a/packages/altair-docs/api/plugin/v3/plugin/classes/PluginV3.md +++ /dev/null @@ -1,39 +0,0 @@ -# `abstract` PluginV3 - -## Constructors - -### new PluginV3() - -> **new PluginV3**(`options`: [`PluginV3Options`](../interfaces/PluginV3Options.md)): [`PluginV3`](PluginV3.md) - -#### Parameters - -• **options**: [`PluginV3Options`](../interfaces/PluginV3Options.md)= `undefined` - -#### Returns - -[`PluginV3`](PluginV3.md) - -## Methods - -### destroy() - -> `abstract` **destroy**(): `void` - -#### Returns - -`void` - -*** - -### initialize() - -> `abstract` **initialize**(`ctx`: [`PluginV3Context`](../../context/interfaces/PluginV3Context.md)): `void` - -#### Parameters - -• **ctx**: [`PluginV3Context`](../../context/interfaces/PluginV3Context.md) - -#### Returns - -`void` diff --git a/packages/altair-docs/api/plugin/v3/plugin/index.md b/packages/altair-docs/api/plugin/v3/plugin/index.md deleted file mode 100644 index c256ecc8df..0000000000 --- a/packages/altair-docs/api/plugin/v3/plugin/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# plugin/v3/plugin - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginV3](classes/PluginV3.md) | - | -| [PluginV3Options](interfaces/PluginV3Options.md) | - | diff --git a/packages/altair-docs/api/plugin/v3/plugin/interfaces/PluginV3Options.md b/packages/altair-docs/api/plugin/v3/plugin/interfaces/PluginV3Options.md deleted file mode 100644 index 3b4b597154..0000000000 --- a/packages/altair-docs/api/plugin/v3/plugin/interfaces/PluginV3Options.md +++ /dev/null @@ -1,7 +0,0 @@ -# PluginV3Options - -## Properties - -### panels - -> **panels**: `Record`\<`string`, [`AltairV3Panel`](../../panel/classes/AltairV3Panel.md)\> diff --git a/packages/altair-docs/api/plugin/v3/source/enumerations/PluginSource.md b/packages/altair-docs/api/plugin/v3/source/enumerations/PluginSource.md deleted file mode 100644 index 566ef7faf4..0000000000 --- a/packages/altair-docs/api/plugin/v3/source/enumerations/PluginSource.md +++ /dev/null @@ -1,22 +0,0 @@ -# PluginSource - -Defines the repository of the plugin. -Used to know where to get the plugin from. - -## Enumeration Members - -### GITHUB - -> **GITHUB**: `"github"` - -*** - -### NPM - -> **NPM**: `"npm"` - -*** - -### URL - -> **URL**: `"url"` diff --git a/packages/altair-docs/api/plugin/v3/source/index.md b/packages/altair-docs/api/plugin/v3/source/index.md deleted file mode 100644 index 6b178f9033..0000000000 --- a/packages/altair-docs/api/plugin/v3/source/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# plugin/v3/source - -## Index - -| Member | Description | -| :------ | :------ | -| [PluginSource](enumerations/PluginSource.md) | Defines the repository of the plugin. Used to know where to get the plugin from. | diff --git a/packages/altair-docs/api/script/context/functions/buildContextResponse.md b/packages/altair-docs/api/script/context/functions/buildContextResponse.md deleted file mode 100644 index 79b8b3f3e4..0000000000 --- a/packages/altair-docs/api/script/context/functions/buildContextResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# buildContextResponse() - -> **buildContextResponse**(`data`: [`ScriptContextData`](../../types/interfaces/ScriptContextData.md)): `undefined` \| [`ScriptContextResponse`](../../types/interfaces/ScriptContextResponse.md) - -## Parameters - -• **data**: [`ScriptContextData`](../../types/interfaces/ScriptContextData.md) - -## Returns - -`undefined` \| [`ScriptContextResponse`](../../types/interfaces/ScriptContextResponse.md) diff --git a/packages/altair-docs/api/script/context/functions/getGlobalContext.md b/packages/altair-docs/api/script/context/functions/getGlobalContext.md deleted file mode 100644 index d6bb27e946..0000000000 --- a/packages/altair-docs/api/script/context/functions/getGlobalContext.md +++ /dev/null @@ -1,13 +0,0 @@ -# getGlobalContext() - -> **getGlobalContext**(`data`: [`ScriptContextData`](../../types/interfaces/ScriptContextData.md), `handlers`: [`GlobalContextBuilderHandlers`](../../types/interfaces/GlobalContextBuilderHandlers.md)): [`GlobalHelperContext`](../../types/interfaces/GlobalHelperContext.md) - -## Parameters - -• **data**: [`ScriptContextData`](../../types/interfaces/ScriptContextData.md) - -• **handlers**: [`GlobalContextBuilderHandlers`](../../types/interfaces/GlobalContextBuilderHandlers.md) - -## Returns - -[`GlobalHelperContext`](../../types/interfaces/GlobalHelperContext.md) diff --git a/packages/altair-docs/api/script/context/functions/importModuleHelper.md b/packages/altair-docs/api/script/context/functions/importModuleHelper.md deleted file mode 100644 index 4c35185780..0000000000 --- a/packages/altair-docs/api/script/context/functions/importModuleHelper.md +++ /dev/null @@ -1,11 +0,0 @@ -# importModuleHelper() - -> **importModuleHelper**(`moduleName`: `string`): `Promise`\<`any`\> - -## Parameters - -• **moduleName**: `string` - -## Returns - -`Promise`\<`any`\> diff --git a/packages/altair-docs/api/script/context/index.md b/packages/altair-docs/api/script/context/index.md deleted file mode 100644 index f639cbde69..0000000000 --- a/packages/altair-docs/api/script/context/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# script/context - -## Index - -| Member | Description | -| :------ | :------ | -| [ModuleImports](variables/ModuleImports.md) | - | -| [buildContextResponse](functions/buildContextResponse.md) | - | -| [getGlobalContext](functions/getGlobalContext.md) | - | -| [importModuleHelper](functions/importModuleHelper.md) | - | diff --git a/packages/altair-docs/api/script/context/variables/ModuleImports.md b/packages/altair-docs/api/script/context/variables/ModuleImports.md deleted file mode 100644 index 6e99f4fd30..0000000000 --- a/packages/altair-docs/api/script/context/variables/ModuleImports.md +++ /dev/null @@ -1,3 +0,0 @@ -# ModuleImports - -> `const` **ModuleImports**: [`ModuleImportsMap`](../../types/interfaces/ModuleImportsMap.md) diff --git a/packages/altair-docs/api/script/errors/classes/RequestScriptError.md b/packages/altair-docs/api/script/errors/classes/RequestScriptError.md deleted file mode 100644 index 1f49cd0185..0000000000 --- a/packages/altair-docs/api/script/errors/classes/RequestScriptError.md +++ /dev/null @@ -1,33 +0,0 @@ -# RequestScriptError - -## Extends - -- `Error` - -## Constructors - -### new RequestScriptError() - -> **new RequestScriptError**(`error`: `unknown`): [`RequestScriptError`](RequestScriptError.md) - -#### Parameters - -• **error**: `unknown` - -#### Returns - -[`RequestScriptError`](RequestScriptError.md) - -#### Overrides - -`Error.constructor` - -## Properties - -### cause - -> **cause**: `Error` - -#### Overrides - -`Error.cause` diff --git a/packages/altair-docs/api/script/errors/index.md b/packages/altair-docs/api/script/errors/index.md deleted file mode 100644 index df3bf4178e..0000000000 --- a/packages/altair-docs/api/script/errors/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# script/errors - -## Index - -| Member | Description | -| :------ | :------ | -| [RequestScriptError](classes/RequestScriptError.md) | - | diff --git a/packages/altair-docs/api/script/evaluator-client-engine/classes/ScriptEvaluatorClientEngine.md b/packages/altair-docs/api/script/evaluator-client-engine/classes/ScriptEvaluatorClientEngine.md deleted file mode 100644 index 2d7842291b..0000000000 --- a/packages/altair-docs/api/script/evaluator-client-engine/classes/ScriptEvaluatorClientEngine.md +++ /dev/null @@ -1,35 +0,0 @@ -# ScriptEvaluatorClientEngine - -## Constructors - -### new ScriptEvaluatorClientEngine() - -> **new ScriptEvaluatorClientEngine**(`engineFactory`: [`ScriptEvaluatorClientFactory`](../../types/interfaces/ScriptEvaluatorClientFactory.md), `timeout`: `number`): [`ScriptEvaluatorClientEngine`](ScriptEvaluatorClientEngine.md) - -#### Parameters - -• **engineFactory**: [`ScriptEvaluatorClientFactory`](../../types/interfaces/ScriptEvaluatorClientFactory.md) - -• **timeout**: `number`= `DEFAULT_TIMEOUT` - -#### Returns - -[`ScriptEvaluatorClientEngine`](ScriptEvaluatorClientEngine.md) - -## Methods - -### executeScript() - -> **executeScript**(`script`: `string`, `data`: [`ScriptContextData`](../../types/interfaces/ScriptContextData.md), `userAvailableHandlers`: [`ScriptEventHandlers`](../../types/interfaces/ScriptEventHandlers.md)): `Promise`\<[`ScriptTranformResult`](../../types/interfaces/ScriptTranformResult.md)\> - -#### Parameters - -• **script**: `string` - -• **data**: [`ScriptContextData`](../../types/interfaces/ScriptContextData.md) - -• **userAvailableHandlers**: [`ScriptEventHandlers`](../../types/interfaces/ScriptEventHandlers.md) - -#### Returns - -`Promise`\<[`ScriptTranformResult`](../../types/interfaces/ScriptTranformResult.md)\> diff --git a/packages/altair-docs/api/script/evaluator-client-engine/index.md b/packages/altair-docs/api/script/evaluator-client-engine/index.md deleted file mode 100644 index 16bbf6afbf..0000000000 --- a/packages/altair-docs/api/script/evaluator-client-engine/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# script/evaluator-client-engine - -## Index - -| Member | Description | -| :------ | :------ | -| [ScriptEvaluatorClientEngine](classes/ScriptEvaluatorClientEngine.md) | - | diff --git a/packages/altair-docs/api/script/evaluator-worker-engine/classes/ScriptEvaluatorWorkerEngine.md b/packages/altair-docs/api/script/evaluator-worker-engine/classes/ScriptEvaluatorWorkerEngine.md deleted file mode 100644 index 1d24748abb..0000000000 --- a/packages/altair-docs/api/script/evaluator-worker-engine/classes/ScriptEvaluatorWorkerEngine.md +++ /dev/null @@ -1,25 +0,0 @@ -# ScriptEvaluatorWorkerEngine - -## Constructors - -### new ScriptEvaluatorWorkerEngine() - -> **new ScriptEvaluatorWorkerEngine**(`worker`: [`ScriptEvaluatorWorker`](../../types/classes/ScriptEvaluatorWorker.md)): [`ScriptEvaluatorWorkerEngine`](ScriptEvaluatorWorkerEngine.md) - -#### Parameters - -• **worker**: [`ScriptEvaluatorWorker`](../../types/classes/ScriptEvaluatorWorker.md) - -#### Returns - -[`ScriptEvaluatorWorkerEngine`](ScriptEvaluatorWorkerEngine.md) - -## Methods - -### start() - -> **start**(): `void` - -#### Returns - -`void` diff --git a/packages/altair-docs/api/script/evaluator-worker-engine/index.md b/packages/altair-docs/api/script/evaluator-worker-engine/index.md deleted file mode 100644 index 22f2a5a51c..0000000000 --- a/packages/altair-docs/api/script/evaluator-worker-engine/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# script/evaluator-worker-engine - -## Index - -| Member | Description | -| :------ | :------ | -| [ScriptEvaluatorWorkerEngine](classes/ScriptEvaluatorWorkerEngine.md) | - | -| [WorkerHandlerNames](type-aliases/WorkerHandlerNames.md) | - | diff --git a/packages/altair-docs/api/script/evaluator-worker-engine/type-aliases/WorkerHandlerNames.md b/packages/altair-docs/api/script/evaluator-worker-engine/type-aliases/WorkerHandlerNames.md deleted file mode 100644 index 25cd9070c6..0000000000 --- a/packages/altair-docs/api/script/evaluator-worker-engine/type-aliases/WorkerHandlerNames.md +++ /dev/null @@ -1,3 +0,0 @@ -# WorkerHandlerNames - -> **WorkerHandlerNames**: *typeof* `workerHandlerNames`\[`number`\] diff --git a/packages/altair-docs/api/script/events/functions/getErrorEvent.md b/packages/altair-docs/api/script/events/functions/getErrorEvent.md deleted file mode 100644 index 9e2cb89f1f..0000000000 --- a/packages/altair-docs/api/script/events/functions/getErrorEvent.md +++ /dev/null @@ -1,11 +0,0 @@ -# getErrorEvent() - -> **getErrorEvent**(`type`: `string`): `string` - -## Parameters - -• **type**: `string` - -## Returns - -`string` diff --git a/packages/altair-docs/api/script/events/functions/getResponseEvent.md b/packages/altair-docs/api/script/events/functions/getResponseEvent.md deleted file mode 100644 index e3af48c8aa..0000000000 --- a/packages/altair-docs/api/script/events/functions/getResponseEvent.md +++ /dev/null @@ -1,15 +0,0 @@ -# getResponseEvent() - -> **getResponseEvent**\<`T`\>(`type`: `T`): \`$\{T\}\_response\` - -## Type parameters - -• **T** *extends* `string` - -## Parameters - -• **type**: `T` - -## Returns - -\`$\{T\}\_response\` diff --git a/packages/altair-docs/api/script/events/index.md b/packages/altair-docs/api/script/events/index.md deleted file mode 100644 index d6508d0f6b..0000000000 --- a/packages/altair-docs/api/script/events/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# script/events - -## Index - -| Member | Description | -| :------ | :------ | -| [SCRIPT\_INIT\_EXECUTE](variables/SCRIPT_INIT_EXECUTE.md) | - | -| [getErrorEvent](functions/getErrorEvent.md) | - | -| [getResponseEvent](functions/getResponseEvent.md) | - | diff --git a/packages/altair-docs/api/script/events/variables/SCRIPT_INIT_EXECUTE.md b/packages/altair-docs/api/script/events/variables/SCRIPT_INIT_EXECUTE.md deleted file mode 100644 index 5f8d00cf9b..0000000000 --- a/packages/altair-docs/api/script/events/variables/SCRIPT_INIT_EXECUTE.md +++ /dev/null @@ -1,3 +0,0 @@ -# SCRIPT\_INIT\_EXECUTE - -> `const` **SCRIPT\_INIT\_EXECUTE**: `"init_execute"` = `'init_execute'` diff --git a/packages/altair-docs/api/script/types/classes/ScriptEvaluatorClient.md b/packages/altair-docs/api/script/types/classes/ScriptEvaluatorClient.md deleted file mode 100644 index e1154b2a47..0000000000 --- a/packages/altair-docs/api/script/types/classes/ScriptEvaluatorClient.md +++ /dev/null @@ -1,111 +0,0 @@ -# `abstract` ScriptEvaluatorClient - -## Constructors - -### new ScriptEvaluatorClient() - -> **new ScriptEvaluatorClient**(): [`ScriptEvaluatorClient`](ScriptEvaluatorClient.md) - -#### Returns - -[`ScriptEvaluatorClient`](ScriptEvaluatorClient.md) - -## Methods - -### destroy() - -> `abstract` **destroy**(): `void` - -#### Returns - -`void` - -*** - -### onError() - -> `abstract` **onError**(`handler`: (`err`: `any`) => `void`): `void` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -*** - -### send() - -> `abstract` **send**(`type`: `string`, `payload`: `any`): `void` - -#### Parameters - -• **type**: `string` - -• **payload**: `any` - -#### Returns - -`void` - -*** - -### sendError() - -> **sendError**\<`T`\>(`type`: `T`, `payload`: [`ScriptEventErrorPayload`](../interfaces/ScriptEventErrorPayload.md)): `void` - -#### Type parameters - -• **T** *extends* keyof [`AllScriptEventHandlers`](../interfaces/AllScriptEventHandlers.md) - -#### Parameters - -• **type**: `T` - -• **payload**: [`ScriptEventErrorPayload`](../interfaces/ScriptEventErrorPayload.md) - -#### Returns - -`void` - -*** - -### sendResponse() - -> **sendResponse**\<`T`\>(`type`: `T`, `payload`: [`ScriptEventResponsePayload`](../interfaces/ScriptEventResponsePayload.md)): `void` - -#### Type parameters - -• **T** *extends* keyof [`AllScriptEventHandlers`](../interfaces/AllScriptEventHandlers.md) - -#### Parameters - -• **type**: `T` - -• **payload**: [`ScriptEventResponsePayload`](../interfaces/ScriptEventResponsePayload.md) - -#### Returns - -`void` - -*** - -### subscribe() - -> `abstract` **subscribe**\<`T`\>(`type`: `T`, `handler`: (`type`: `T`, `e`: [`ScriptEventData`](../type-aliases/ScriptEventData.md)\<`T`\>) => `void`): `void` - -#### Type parameters - -• **T** *extends* keyof [`AllScriptEventHandlers`](../interfaces/AllScriptEventHandlers.md) - -#### Parameters - -• **type**: `T` - -• **handler** - -#### Returns - -`void` diff --git a/packages/altair-docs/api/script/types/classes/ScriptEvaluatorWorker.md b/packages/altair-docs/api/script/types/classes/ScriptEvaluatorWorker.md deleted file mode 100644 index 2e53581e6f..0000000000 --- a/packages/altair-docs/api/script/types/classes/ScriptEvaluatorWorker.md +++ /dev/null @@ -1,55 +0,0 @@ -# `abstract` ScriptEvaluatorWorker - -## Constructors - -### new ScriptEvaluatorWorker() - -> **new ScriptEvaluatorWorker**(): [`ScriptEvaluatorWorker`](ScriptEvaluatorWorker.md) - -#### Returns - -[`ScriptEvaluatorWorker`](ScriptEvaluatorWorker.md) - -## Methods - -### onError() - -> `abstract` **onError**(`handler`: (`err`: `any`) => `void`): `void` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -*** - -### onMessage() - -> `abstract` **onMessage**(`handler`: (`e`: [`ScriptWorkerMessageData`](../interfaces/ScriptWorkerMessageData.md)) => `void`): `void` - -#### Parameters - -• **handler** - -#### Returns - -`void` - -*** - -### send() - -> `abstract` **send**(`type`: `string`, `payload`: `any`): `void` - -#### Parameters - -• **type**: `string` - -• **payload**: `any` - -#### Returns - -`void` diff --git a/packages/altair-docs/api/script/types/enumerations/RequestType.md b/packages/altair-docs/api/script/types/enumerations/RequestType.md deleted file mode 100644 index 5ddbb30936..0000000000 --- a/packages/altair-docs/api/script/types/enumerations/RequestType.md +++ /dev/null @@ -1,19 +0,0 @@ -# RequestType - -## Enumeration Members - -### INTROSPECTION - -> **INTROSPECTION**: `"introspection"` - -*** - -### QUERY - -> **QUERY**: `"query"` - -*** - -### SUBSCRIPTION - -> **SUBSCRIPTION**: `"subscription"` diff --git a/packages/altair-docs/api/script/types/index.md b/packages/altair-docs/api/script/types/index.md deleted file mode 100644 index 6ddca1032e..0000000000 --- a/packages/altair-docs/api/script/types/index.md +++ /dev/null @@ -1,31 +0,0 @@ -# script/types - -## Index - -| Member | Description | -| :------ | :------ | -| [RequestType](enumerations/RequestType.md) | - | -| [ScriptEvaluatorClient](classes/ScriptEvaluatorClient.md) | - | -| [ScriptEvaluatorWorker](classes/ScriptEvaluatorWorker.md) | - | -| [AllScriptEventHandlers](interfaces/AllScriptEventHandlers.md) | - | -| [CookieOptions](interfaces/CookieOptions.md) | - | -| [GlobalContextBuilderHandlers](interfaces/GlobalContextBuilderHandlers.md) | - | -| [GlobalHelperContext](interfaces/GlobalHelperContext.md) | - | -| [ModuleImportsMap](interfaces/ModuleImportsMap.md) | - | -| [ScriptContextData](interfaces/ScriptContextData.md) | - | -| [ScriptContextHelpers](interfaces/ScriptContextHelpers.md) | - | -| [ScriptContextResponse](interfaces/ScriptContextResponse.md) | - | -| [ScriptContextStorage](interfaces/ScriptContextStorage.md) | - | -| [ScriptEvaluatorClientFactory](interfaces/ScriptEvaluatorClientFactory.md) | - | -| [ScriptEventDataPayload](interfaces/ScriptEventDataPayload.md) | - | -| [ScriptEventErrorPayload](interfaces/ScriptEventErrorPayload.md) | - | -| [ScriptEventHandlers](interfaces/ScriptEventHandlers.md) | - | -| [ScriptEventResponsePayload](interfaces/ScriptEventResponsePayload.md) | - | -| [ScriptTranformResult](interfaces/ScriptTranformResult.md) | - | -| [ScriptWorkerMessageData](interfaces/ScriptWorkerMessageData.md) | - | -| [SendRequestResponse](interfaces/SendRequestResponse.md) | - | -| [SameSite](type-aliases/SameSite.md) | - | -| [ScriptEvent](type-aliases/ScriptEvent.md) | - | -| [ScriptEventData](type-aliases/ScriptEventData.md) | - | -| [ScriptEventParameters](type-aliases/ScriptEventParameters.md) | - | -| [ScriptResponseEvent](type-aliases/ScriptResponseEvent.md) | - | diff --git a/packages/altair-docs/api/script/types/interfaces/AllScriptEventHandlers.md b/packages/altair-docs/api/script/types/interfaces/AllScriptEventHandlers.md deleted file mode 100644 index 799c0b2c08..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/AllScriptEventHandlers.md +++ /dev/null @@ -1,169 +0,0 @@ -# AllScriptEventHandlers - -## Extends - -- [`ScriptEventHandlers`](ScriptEventHandlers.md) - -## Properties - -### alert() - -> **alert**: (`msg`: `string`) => `Promise`\<`void`\> - -#### Parameters - -• **msg**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ScriptEventHandlers`](ScriptEventHandlers.md).[`alert`](ScriptEventHandlers.md#alert) - -*** - -### executeComplete() - -> **executeComplete**: (`data`: [`ScriptContextData`](ScriptContextData.md)) => `void` - -#### Parameters - -• **data**: [`ScriptContextData`](ScriptContextData.md) - -#### Returns - -`void` - -*** - -### getStorageItem() - -> **getStorageItem**: (`key`: `string`) => `Promise`\<`unknown`\> - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`unknown`\> - -#### Inherited from - -[`ScriptEventHandlers`](ScriptEventHandlers.md).[`getStorageItem`](ScriptEventHandlers.md#getstorageitem) - -*** - -### log() - -> **log**: (`d`: `unknown`) => `Promise`\<`void`\> - -#### Parameters - -• **d**: `unknown` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ScriptEventHandlers`](ScriptEventHandlers.md).[`log`](ScriptEventHandlers.md#log) - -*** - -### request() - -> **request**: (`arg1`: `any`, `arg2`: `any`, `arg3`: `any`) => `Promise`\<`any`\> - -#### Parameters - -• **arg1**: `any` - -• **arg2**: `any` - -• **arg3**: `any` - -#### Returns - -`Promise`\<`any`\> - -#### Inherited from - -[`ScriptEventHandlers`](ScriptEventHandlers.md).[`request`](ScriptEventHandlers.md#request) - -*** - -### scriptError() - -> **scriptError**: (`err`: `Error`) => `void` - -#### Parameters - -• **err**: `Error` - -#### Returns - -`void` - -*** - -### setCookie() - -> **setCookie**: (`key`: `string`, `value`: `string`, `options`?: [`CookieOptions`](CookieOptions.md)) => `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -• **value**: `string` - -• **options?**: [`CookieOptions`](CookieOptions.md) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ScriptEventHandlers`](ScriptEventHandlers.md).[`setCookie`](ScriptEventHandlers.md#setcookie) - -*** - -### setStorageItem() - -> **setStorageItem**: (`key`: `string`, `value`: `unknown`) => `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -• **value**: `unknown` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ScriptEventHandlers`](ScriptEventHandlers.md).[`setStorageItem`](ScriptEventHandlers.md#setstorageitem) - -*** - -### updateActiveEnvironment() - -> **updateActiveEnvironment**: (`environmentData`: `Record`\<`string`, `unknown`\>) => `Promise`\<`void`\> - -#### Parameters - -• **environmentData**: `Record`\<`string`, `unknown`\> - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ScriptEventHandlers`](ScriptEventHandlers.md).[`updateActiveEnvironment`](ScriptEventHandlers.md#updateactiveenvironment) diff --git a/packages/altair-docs/api/script/types/interfaces/CookieOptions.md b/packages/altair-docs/api/script/types/interfaces/CookieOptions.md deleted file mode 100644 index ed75326add..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/CookieOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -# CookieOptions - -## Properties - -### domain? - -> `optional` **domain**: `string` - -*** - -### expires? - -> `optional` **expires**: `number` \| `Date` - -*** - -### path? - -> `optional` **path**: `string` - -*** - -### sameSite? - -> `optional` **sameSite**: [`SameSite`](../type-aliases/SameSite.md) - -*** - -### secure? - -> `optional` **secure**: `boolean` diff --git a/packages/altair-docs/api/script/types/interfaces/GlobalContextBuilderHandlers.md b/packages/altair-docs/api/script/types/interfaces/GlobalContextBuilderHandlers.md deleted file mode 100644 index 1a40c4df61..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/GlobalContextBuilderHandlers.md +++ /dev/null @@ -1,67 +0,0 @@ -# GlobalContextBuilderHandlers - -## Properties - -### getStorageItem() - -> **getStorageItem**: (`key`: `string`) => `Promise`\<`unknown`\> - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`unknown`\> - -*** - -### request() - -> **request**: (`arg1`: `any`, `arg2`: `any`, `arg3`: `any`) => `Promise`\<`any`\> - -#### Parameters - -• **arg1**: `any` - -• **arg2**: `any` - -• **arg3**: `any` - -#### Returns - -`Promise`\<`any`\> - -*** - -### setCookie() - -> **setCookie**: (`key`: `string`, `value`: `string`, `options`?: [`CookieOptions`](CookieOptions.md)) => `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -• **value**: `string` - -• **options?**: [`CookieOptions`](CookieOptions.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### setStorageItem() - -> **setStorageItem**: (`key`: `string`, `value`: `unknown`) => `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -• **value**: `unknown` - -#### Returns - -`Promise`\<`void`\> diff --git a/packages/altair-docs/api/script/types/interfaces/GlobalHelperContext.md b/packages/altair-docs/api/script/types/interfaces/GlobalHelperContext.md deleted file mode 100644 index 3258050143..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/GlobalHelperContext.md +++ /dev/null @@ -1,53 +0,0 @@ -# GlobalHelperContext - -## Properties - -### data - -> **data**: [`ScriptContextData`](ScriptContextData.md) - -*** - -### helpers - -> **helpers**: [`ScriptContextHelpers`](ScriptContextHelpers.md) - -*** - -### importModule() - -> **importModule**: (`moduleName`: `string`) => `any` - -#### Parameters - -• **moduleName**: `string` - -#### Returns - -`any` - -*** - -### log() - -> **log**: (`d`: `unknown`) => `void` - -#### Parameters - -• **d**: `unknown` - -#### Returns - -`void` - -*** - -### response? - -> `optional` **response**: [`ScriptContextResponse`](ScriptContextResponse.md) - -*** - -### storage - -> **storage**: [`ScriptContextStorage`](ScriptContextStorage.md) diff --git a/packages/altair-docs/api/script/types/interfaces/ModuleImportsMap.md b/packages/altair-docs/api/script/types/interfaces/ModuleImportsMap.md deleted file mode 100644 index 3fc6c12bfc..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ModuleImportsMap.md +++ /dev/null @@ -1,5 +0,0 @@ -# ModuleImportsMap - -## Indexable - - \[`name`: `string`\]: `object` diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptContextData.md b/packages/altair-docs/api/script/types/interfaces/ScriptContextData.md deleted file mode 100644 index 40d505aaeb..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptContextData.md +++ /dev/null @@ -1,73 +0,0 @@ -# ScriptContextData - -## Properties - -### \_\_cookieJar? - -> `optional` **\_\_cookieJar**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) - -*** - -### \_\_toSetActiveEnvironment? - -> `optional` **\_\_toSetActiveEnvironment**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) - -*** - -### environment - -> **environment**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) - -*** - -### headers - -> **headers**: [`HeaderState`](../../../types/state/header.interfaces/type-aliases/HeaderState.md) - -*** - -### operationName - -> **operationName**: `string` - -*** - -### query - -> **query**: `string` - -*** - -### requestExtensions? - -> `optional` **requestExtensions**: `string` - -*** - -### requestScriptLogs? - -> `optional` **requestScriptLogs**: [`LogLine`](../../../types/state/query.interfaces/interfaces/LogLine.md)[] - -*** - -### requestType? - -> `optional` **requestType**: [`RequestType`](../enumerations/RequestType.md) - -*** - -### response? - -> `optional` **response**: [`SendRequestResponse`](SendRequestResponse.md) - -*** - -### url - -> **url**: `string` - -*** - -### variables - -> **variables**: `string` diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptContextHelpers.md b/packages/altair-docs/api/script/types/interfaces/ScriptContextHelpers.md deleted file mode 100644 index c34c4fff4a..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptContextHelpers.md +++ /dev/null @@ -1,79 +0,0 @@ -# ScriptContextHelpers - -## Properties - -### getCookie() - -> **getCookie**: (`key`: `string`) => `string` - -#### Parameters - -• **key**: `string` - -#### Returns - -`string` - -*** - -### getEnvironment() - -> **getEnvironment**: (`key`: `string`) => `any` - -#### Parameters - -• **key**: `string` - -#### Returns - -`any` - -*** - -### request() - -> **request**: (`arg1`: `any`, `arg2`: `any`, `arg3`: `any`) => `Promise`\<`null` \| `ArrayBuffer`\> - -#### Parameters - -• **arg1**: `any` - -• **arg2**: `any` - -• **arg3**: `any` - -#### Returns - -`Promise`\<`null` \| `ArrayBuffer`\> - -*** - -### setCookie() - -> **setCookie**: (`key`: `string`, `value`: `string`) => `void` - -#### Parameters - -• **key**: `string` - -• **value**: `string` - -#### Returns - -`void` - -*** - -### setEnvironment() - -> **setEnvironment**: (`key`: `string`, `value`: `any`) => `void` - -#### Parameters - -• **key**: `string` - -• **value**: `any` - -#### Returns - -`void` diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptContextResponse.md b/packages/altair-docs/api/script/types/interfaces/ScriptContextResponse.md deleted file mode 100644 index 96058d522a..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptContextResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# ScriptContextResponse - -## Properties - -### body - -> **body**: `unknown` - -*** - -### headers - -> **headers**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) - -*** - -### requestType - -> **requestType**: [`RequestType`](../enumerations/RequestType.md) - -*** - -### responseTime - -> **responseTime**: `number` - -*** - -### statusCode - -> **statusCode**: `number` diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptContextStorage.md b/packages/altair-docs/api/script/types/interfaces/ScriptContextStorage.md deleted file mode 100644 index c1422190e4..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptContextStorage.md +++ /dev/null @@ -1,31 +0,0 @@ -# ScriptContextStorage - -## Properties - -### get() - -> **get**: (`key`: `string`) => `Promise`\<`unknown`\> - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`unknown`\> - -*** - -### set() - -> **set**: (`key`: `string`, `value`: `unknown`) => `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -• **value**: `unknown` - -#### Returns - -`Promise`\<`void`\> diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptEvaluatorClientFactory.md b/packages/altair-docs/api/script/types/interfaces/ScriptEvaluatorClientFactory.md deleted file mode 100644 index 5c260eef72..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptEvaluatorClientFactory.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScriptEvaluatorClientFactory - -## Properties - -### create() - -> **create**: () => [`ScriptEvaluatorClient`](../classes/ScriptEvaluatorClient.md) - -#### Returns - -[`ScriptEvaluatorClient`](../classes/ScriptEvaluatorClient.md) diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptEventDataPayload.md b/packages/altair-docs/api/script/types/interfaces/ScriptEventDataPayload.md deleted file mode 100644 index da19f9607c..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptEventDataPayload.md +++ /dev/null @@ -1,17 +0,0 @@ -# ScriptEventDataPayload\ - -## Type parameters - -• **T** *extends* [`ScriptEvent`](../type-aliases/ScriptEvent.md) - -## Properties - -### args - -> **args**: `Parameters`\<[`AllScriptEventHandlers`](AllScriptEventHandlers.md)\[`T`\]\> - -*** - -### id - -> **id**: `string` diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptEventErrorPayload.md b/packages/altair-docs/api/script/types/interfaces/ScriptEventErrorPayload.md deleted file mode 100644 index a6434eae26..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptEventErrorPayload.md +++ /dev/null @@ -1,13 +0,0 @@ -# ScriptEventErrorPayload - -## Properties - -### error - -> **error**: `string` - -*** - -### id - -> **id**: `string` diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptEventHandlers.md b/packages/altair-docs/api/script/types/interfaces/ScriptEventHandlers.md deleted file mode 100644 index a8639c2c78..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptEventHandlers.md +++ /dev/null @@ -1,113 +0,0 @@ -# ScriptEventHandlers - -## Extended by - -- [`AllScriptEventHandlers`](AllScriptEventHandlers.md) - -## Properties - -### alert() - -> **alert**: (`msg`: `string`) => `Promise`\<`void`\> - -#### Parameters - -• **msg**: `string` - -#### Returns - -`Promise`\<`void`\> - -*** - -### getStorageItem() - -> **getStorageItem**: (`key`: `string`) => `Promise`\<`unknown`\> - -#### Parameters - -• **key**: `string` - -#### Returns - -`Promise`\<`unknown`\> - -*** - -### log() - -> **log**: (`d`: `unknown`) => `Promise`\<`void`\> - -#### Parameters - -• **d**: `unknown` - -#### Returns - -`Promise`\<`void`\> - -*** - -### request() - -> **request**: (`arg1`: `any`, `arg2`: `any`, `arg3`: `any`) => `Promise`\<`any`\> - -#### Parameters - -• **arg1**: `any` - -• **arg2**: `any` - -• **arg3**: `any` - -#### Returns - -`Promise`\<`any`\> - -*** - -### setCookie() - -> **setCookie**: (`key`: `string`, `value`: `string`, `options`?: [`CookieOptions`](CookieOptions.md)) => `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -• **value**: `string` - -• **options?**: [`CookieOptions`](CookieOptions.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### setStorageItem() - -> **setStorageItem**: (`key`: `string`, `value`: `unknown`) => `Promise`\<`void`\> - -#### Parameters - -• **key**: `string` - -• **value**: `unknown` - -#### Returns - -`Promise`\<`void`\> - -*** - -### updateActiveEnvironment() - -> **updateActiveEnvironment**: (`environmentData`: `Record`\<`string`, `unknown`\>) => `Promise`\<`void`\> - -#### Parameters - -• **environmentData**: `Record`\<`string`, `unknown`\> - -#### Returns - -`Promise`\<`void`\> diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptEventResponsePayload.md b/packages/altair-docs/api/script/types/interfaces/ScriptEventResponsePayload.md deleted file mode 100644 index cefcd75891..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptEventResponsePayload.md +++ /dev/null @@ -1,13 +0,0 @@ -# ScriptEventResponsePayload - -## Properties - -### id - -> **id**: `string` - -*** - -### response - -> **response**: `any` diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptTranformResult.md b/packages/altair-docs/api/script/types/interfaces/ScriptTranformResult.md deleted file mode 100644 index 144338c3bb..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptTranformResult.md +++ /dev/null @@ -1,19 +0,0 @@ -# ScriptTranformResult - -## Properties - -### additionalHeaders - -> **additionalHeaders**: [`HeaderState`](../../../types/state/header.interfaces/type-aliases/HeaderState.md) - -*** - -### environment? - -> `optional` **environment**: [`IEnvironment`](../../../types/state/environments.interfaces/interfaces/IEnvironment.md) - -*** - -### requestScriptLogs - -> **requestScriptLogs**: [`LogLine`](../../../types/state/query.interfaces/interfaces/LogLine.md)[] diff --git a/packages/altair-docs/api/script/types/interfaces/ScriptWorkerMessageData.md b/packages/altair-docs/api/script/types/interfaces/ScriptWorkerMessageData.md deleted file mode 100644 index cd463a65a0..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/ScriptWorkerMessageData.md +++ /dev/null @@ -1,13 +0,0 @@ -# ScriptWorkerMessageData - -## Properties - -### payload - -> **payload**: `any` - -*** - -### type - -> **type**: `string` diff --git a/packages/altair-docs/api/script/types/interfaces/SendRequestResponse.md b/packages/altair-docs/api/script/types/interfaces/SendRequestResponse.md deleted file mode 100644 index 86d387e03b..0000000000 --- a/packages/altair-docs/api/script/types/interfaces/SendRequestResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -# SendRequestResponse - -## Properties - -### meta - -> **meta**: `object` - -#### headers - -> **headers**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) - -#### requestEndTime - -> **requestEndTime**: `number` - -#### requestStartTime - -> **requestStartTime**: `number` - -#### responseTime - -> **responseTime**: `number` - -*** - -### response - -> **response**: `HttpResponse`\<`any`\> diff --git a/packages/altair-docs/api/script/types/type-aliases/SameSite.md b/packages/altair-docs/api/script/types/type-aliases/SameSite.md deleted file mode 100644 index 2bbf226973..0000000000 --- a/packages/altair-docs/api/script/types/type-aliases/SameSite.md +++ /dev/null @@ -1,3 +0,0 @@ -# SameSite - -> **SameSite**: `"Lax"` \| `"None"` \| `"Strict"` diff --git a/packages/altair-docs/api/script/types/type-aliases/ScriptEvent.md b/packages/altair-docs/api/script/types/type-aliases/ScriptEvent.md deleted file mode 100644 index abf0cf92fd..0000000000 --- a/packages/altair-docs/api/script/types/type-aliases/ScriptEvent.md +++ /dev/null @@ -1,3 +0,0 @@ -# ScriptEvent - -> **ScriptEvent**: keyof [`AllScriptEventHandlers`](../interfaces/AllScriptEventHandlers.md) diff --git a/packages/altair-docs/api/script/types/type-aliases/ScriptEventData.md b/packages/altair-docs/api/script/types/type-aliases/ScriptEventData.md deleted file mode 100644 index e0f0b9805c..0000000000 --- a/packages/altair-docs/api/script/types/type-aliases/ScriptEventData.md +++ /dev/null @@ -1,7 +0,0 @@ -# ScriptEventData\ - -> **ScriptEventData**\<`T`\>: `T` *extends* [`ScriptEvent`](ScriptEvent.md) ? `object` : `never` - -## Type parameters - -• **T** *extends* [`ScriptEvent`](ScriptEvent.md) diff --git a/packages/altair-docs/api/script/types/type-aliases/ScriptEventParameters.md b/packages/altair-docs/api/script/types/type-aliases/ScriptEventParameters.md deleted file mode 100644 index df034f2158..0000000000 --- a/packages/altair-docs/api/script/types/type-aliases/ScriptEventParameters.md +++ /dev/null @@ -1,7 +0,0 @@ -# ScriptEventParameters\ - -> **ScriptEventParameters**\<`T`\>: `Parameters`\<[`AllScriptEventHandlers`](../interfaces/AllScriptEventHandlers.md)\[`T`\]\> - -## Type parameters - -• **T** *extends* [`ScriptEvent`](ScriptEvent.md) diff --git a/packages/altair-docs/api/script/types/type-aliases/ScriptResponseEvent.md b/packages/altair-docs/api/script/types/type-aliases/ScriptResponseEvent.md deleted file mode 100644 index 701f97ed26..0000000000 --- a/packages/altair-docs/api/script/types/type-aliases/ScriptResponseEvent.md +++ /dev/null @@ -1,7 +0,0 @@ -# ScriptResponseEvent\ - -> **ScriptResponseEvent**\<`T`\>: \`$\{T\}\_response\` - -## Type parameters - -• **T** *extends* `string` diff --git a/packages/altair-docs/api/subscriptions/index.md b/packages/altair-docs/api/subscriptions/index.md deleted file mode 100644 index ec6c20c328..0000000000 --- a/packages/altair-docs/api/subscriptions/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# subscriptions - -## Index - -| Member | Description | -| :------ | :------ | -| [SubscriptionProviderData](interfaces/SubscriptionProviderData.md) | - | -| [SubscriptionProviderIds](type-aliases/SubscriptionProviderIds.md) | - | -| [ACTION\_CABLE\_PROVIDER\_ID](variables/ACTION_CABLE_PROVIDER_ID.md) | - | -| [APP\_SYNC\_PROVIDER\_ID](variables/APP_SYNC_PROVIDER_ID.md) | - | -| [GRAPHQL\_SSE\_ID](variables/GRAPHQL_SSE_ID.md) | - | -| [GRAPHQL\_WS\_PROVIDER\_ID](variables/GRAPHQL_WS_PROVIDER_ID.md) | - | -| [SUBSCRIPTION\_PROVIDER\_IDS](variables/SUBSCRIPTION_PROVIDER_IDS.md) | - | -| [WEBSOCKET\_PROVIDER\_ID](variables/WEBSOCKET_PROVIDER_ID.md) | - | diff --git a/packages/altair-docs/api/subscriptions/interfaces/SubscriptionProviderData.md b/packages/altair-docs/api/subscriptions/interfaces/SubscriptionProviderData.md deleted file mode 100644 index 71ca978bc7..0000000000 --- a/packages/altair-docs/api/subscriptions/interfaces/SubscriptionProviderData.md +++ /dev/null @@ -1,23 +0,0 @@ -# SubscriptionProviderData - -## Properties - -### copyTag? - -> `optional` **copyTag**: `string` - -*** - -### getProviderClass() - -> **getProviderClass**: () => `Promise`\<[`SubscriptionProviderConstructor`](../subscription-provider/type-aliases/SubscriptionProviderConstructor.md)\> - -#### Returns - -`Promise`\<[`SubscriptionProviderConstructor`](../subscription-provider/type-aliases/SubscriptionProviderConstructor.md)\> - -*** - -### id - -> **id**: `string` diff --git a/packages/altair-docs/api/subscriptions/providers/action-cable/classes/ActionCableSubscriptionProvider.md b/packages/altair-docs/api/subscriptions/providers/action-cable/classes/ActionCableSubscriptionProvider.md deleted file mode 100644 index 11aba3ba86..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/action-cable/classes/ActionCableSubscriptionProvider.md +++ /dev/null @@ -1,101 +0,0 @@ -# ActionCableSubscriptionProvider - -## Extends - -- [`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md) - -## Constructors - -### new ActionCableSubscriptionProvider() - -> **new ActionCableSubscriptionProvider**(`subscriptionUrl`: `string`, `connectionParams`: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md), `extraOptions`?: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md)): [`ActionCableSubscriptionProvider`](ActionCableSubscriptionProvider.md) - -#### Parameters - -• **subscriptionUrl**: `string` - -• **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -• **extraOptions?**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Returns - -[`ActionCableSubscriptionProvider`](ActionCableSubscriptionProvider.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`constructor`](../../../subscription-provider/classes/SubscriptionProvider.md#constructors) - -## Properties - -### channel? - -> `optional` **channel**: `string` - -*** - -### connectionParams - -> `protected` **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`connectionParams`](../../../subscription-provider/classes/SubscriptionProvider.md#connectionparams) - -*** - -### extraOptions? - -> `protected` `optional` **extraOptions**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`extraOptions`](../../../subscription-provider/classes/SubscriptionProvider.md#extraoptions) - -*** - -### subscription? - -> `optional` **subscription**: `any` - -*** - -### subscriptionUrl - -> `protected` **subscriptionUrl**: `string` - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`subscriptionUrl`](../../../subscription-provider/classes/SubscriptionProvider.md#subscriptionurl) - -## Methods - -### close() - -> **close**(): `void` - -#### Returns - -`void` - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`close`](../../../subscription-provider/classes/SubscriptionProvider.md#close) - -*** - -### execute() - -> **execute**(`options`: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md)): `Observable`\<`unknown`\> - -#### Parameters - -• **options**: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md) - -#### Returns - -`Observable`\<`unknown`\> - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`execute`](../../../subscription-provider/classes/SubscriptionProvider.md#execute) diff --git a/packages/altair-docs/api/subscriptions/providers/action-cable/index.md b/packages/altair-docs/api/subscriptions/providers/action-cable/index.md deleted file mode 100644 index 6fa1c00f97..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/action-cable/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# subscriptions/providers/action-cable - -## Index - -| Member | Description | -| :------ | :------ | -| [ActionCableSubscriptionProvider](classes/ActionCableSubscriptionProvider.md) | - | diff --git a/packages/altair-docs/api/subscriptions/providers/app-sync/classes/AppSyncSubscriptionProvider.md b/packages/altair-docs/api/subscriptions/providers/app-sync/classes/AppSyncSubscriptionProvider.md deleted file mode 100644 index c59a738555..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/app-sync/classes/AppSyncSubscriptionProvider.md +++ /dev/null @@ -1,104 +0,0 @@ -# AppSyncSubscriptionProvider - -## Extends - -- [`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md) - -## Constructors - -### new AppSyncSubscriptionProvider() - -> **new AppSyncSubscriptionProvider**(`subscriptionUrl`: `string`, `connectionParams`: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md), `extraOptions`?: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md)): [`AppSyncSubscriptionProvider`](AppSyncSubscriptionProvider.md) - -#### Parameters - -• **subscriptionUrl**: `string` - -• **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -• **extraOptions?**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Returns - -[`AppSyncSubscriptionProvider`](AppSyncSubscriptionProvider.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`constructor`](../../../subscription-provider/classes/SubscriptionProvider.md#constructors) - -## Properties - -### connectionParams - -> `protected` **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`connectionParams`](../../../subscription-provider/classes/SubscriptionProvider.md#connectionparams) - -*** - -### extraOptions? - -> `protected` `optional` **extraOptions**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`extraOptions`](../../../subscription-provider/classes/SubscriptionProvider.md#extraoptions) - -*** - -### subscription? - -> `optional` **subscription**: `Subscription` - -*** - -### subscriptionUrl - -> `protected` **subscriptionUrl**: `string` - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`subscriptionUrl`](../../../subscription-provider/classes/SubscriptionProvider.md#subscriptionurl) - -## Methods - -### close() - -> **close**(): `void` - -#### Returns - -`void` - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`close`](../../../subscription-provider/classes/SubscriptionProvider.md#close) - -*** - -### execute() - -> **execute**(`options`: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md)): `Observable`\<`unknown`\> - -{ - "aws_project_region": "us-west-2", - "aws_appsync_graphqlEndpoint": "https://....appsync-api.us-west-2.amazonaws.com/graphql", - "aws_appsync_region": "us-west-2", - "aws_appsync_authenticationType": "API_KEY", - "aws_appsync_apiKey": "..." - "aws_appsync_jwtToken" "..." -} - -#### Parameters - -• **options**: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md) - -#### Returns - -`Observable`\<`unknown`\> - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`execute`](../../../subscription-provider/classes/SubscriptionProvider.md#execute) diff --git a/packages/altair-docs/api/subscriptions/providers/app-sync/index.md b/packages/altair-docs/api/subscriptions/providers/app-sync/index.md deleted file mode 100644 index ed2cbef57c..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/app-sync/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# subscriptions/providers/app-sync - -## Index - -| Member | Description | -| :------ | :------ | -| [AppSyncSubscriptionProvider](classes/AppSyncSubscriptionProvider.md) | - | diff --git a/packages/altair-docs/api/subscriptions/providers/graphql-sse/classes/GraphQLSSESubscriptionProvider.md b/packages/altair-docs/api/subscriptions/providers/graphql-sse/classes/GraphQLSSESubscriptionProvider.md deleted file mode 100644 index 23eceb0a0b..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/graphql-sse/classes/GraphQLSSESubscriptionProvider.md +++ /dev/null @@ -1,115 +0,0 @@ -# GraphQLSSESubscriptionProvider - -## Extends - -- [`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md) - -## Constructors - -### new GraphQLSSESubscriptionProvider() - -> **new GraphQLSSESubscriptionProvider**(`subscriptionUrl`: `string`, `connectionParams`: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md), `extraOptions`?: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md)): [`GraphQLSSESubscriptionProvider`](GraphQLSSESubscriptionProvider.md) - -#### Parameters - -• **subscriptionUrl**: `string` - -• **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -• **extraOptions?**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Returns - -[`GraphQLSSESubscriptionProvider`](GraphQLSSESubscriptionProvider.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`constructor`](../../../subscription-provider/classes/SubscriptionProvider.md#constructors) - -## Properties - -### cleanup()? - -> `optional` **cleanup**: () => `void` - -#### Returns - -`void` - -*** - -### client? - -> `optional` **client**: `Client` - -*** - -### connectionParams - -> `protected` **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`connectionParams`](../../../subscription-provider/classes/SubscriptionProvider.md#connectionparams) - -*** - -### extraOptions? - -> `protected` `optional` **extraOptions**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`extraOptions`](../../../subscription-provider/classes/SubscriptionProvider.md#extraoptions) - -*** - -### subscriptionUrl - -> `protected` **subscriptionUrl**: `string` - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`subscriptionUrl`](../../../subscription-provider/classes/SubscriptionProvider.md#subscriptionurl) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`close`](../../../subscription-provider/classes/SubscriptionProvider.md#close) - -*** - -### createClient() - -> **createClient**(): `void` - -#### Returns - -`void` - -*** - -### execute() - -> **execute**(`options`: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md)): `Observable`\<`unknown`\> - -#### Parameters - -• **options**: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md) - -#### Returns - -`Observable`\<`unknown`\> - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`execute`](../../../subscription-provider/classes/SubscriptionProvider.md#execute) diff --git a/packages/altair-docs/api/subscriptions/providers/graphql-sse/index.md b/packages/altair-docs/api/subscriptions/providers/graphql-sse/index.md deleted file mode 100644 index 4610c9d693..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/graphql-sse/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# subscriptions/providers/graphql-sse - -## Index - -| Member | Description | -| :------ | :------ | -| [GraphQLSSESubscriptionProvider](classes/GraphQLSSESubscriptionProvider.md) | - | diff --git a/packages/altair-docs/api/subscriptions/providers/graphql-ws/classes/GraphQLWsSubscriptionProvider.md b/packages/altair-docs/api/subscriptions/providers/graphql-ws/classes/GraphQLWsSubscriptionProvider.md deleted file mode 100644 index 876b225c71..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/graphql-ws/classes/GraphQLWsSubscriptionProvider.md +++ /dev/null @@ -1,115 +0,0 @@ -# GraphQLWsSubscriptionProvider - -## Extends - -- [`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md) - -## Constructors - -### new GraphQLWsSubscriptionProvider() - -> **new GraphQLWsSubscriptionProvider**(`subscriptionUrl`: `string`, `connectionParams`: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md), `extraOptions`?: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md)): [`GraphQLWsSubscriptionProvider`](GraphQLWsSubscriptionProvider.md) - -#### Parameters - -• **subscriptionUrl**: `string` - -• **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -• **extraOptions?**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Returns - -[`GraphQLWsSubscriptionProvider`](GraphQLWsSubscriptionProvider.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`constructor`](../../../subscription-provider/classes/SubscriptionProvider.md#constructors) - -## Properties - -### cleanup()? - -> `optional` **cleanup**: () => `void` - -#### Returns - -`void` - -*** - -### client? - -> `optional` **client**: `Client` - -*** - -### connectionParams - -> `protected` **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`connectionParams`](../../../subscription-provider/classes/SubscriptionProvider.md#connectionparams) - -*** - -### extraOptions? - -> `protected` `optional` **extraOptions**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`extraOptions`](../../../subscription-provider/classes/SubscriptionProvider.md#extraoptions) - -*** - -### subscriptionUrl - -> `protected` **subscriptionUrl**: `string` - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`subscriptionUrl`](../../../subscription-provider/classes/SubscriptionProvider.md#subscriptionurl) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`close`](../../../subscription-provider/classes/SubscriptionProvider.md#close) - -*** - -### createClient() - -> **createClient**(): `void` - -#### Returns - -`void` - -*** - -### execute() - -> **execute**(`options`: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md)): `Observable`\<`unknown`\> - -#### Parameters - -• **options**: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md) - -#### Returns - -`Observable`\<`unknown`\> - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`execute`](../../../subscription-provider/classes/SubscriptionProvider.md#execute) diff --git a/packages/altair-docs/api/subscriptions/providers/graphql-ws/index.md b/packages/altair-docs/api/subscriptions/providers/graphql-ws/index.md deleted file mode 100644 index 58ed49946a..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/graphql-ws/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# subscriptions/providers/graphql-ws - -## Index - -| Member | Description | -| :------ | :------ | -| [GraphQLWsSubscriptionProvider](classes/GraphQLWsSubscriptionProvider.md) | - | diff --git a/packages/altair-docs/api/subscriptions/providers/ws/classes/WebsocketSubscriptionProvider.md b/packages/altair-docs/api/subscriptions/providers/ws/classes/WebsocketSubscriptionProvider.md deleted file mode 100644 index 0b03cbd41d..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/ws/classes/WebsocketSubscriptionProvider.md +++ /dev/null @@ -1,115 +0,0 @@ -# WebsocketSubscriptionProvider - -## Extends - -- [`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md) - -## Constructors - -### new WebsocketSubscriptionProvider() - -> **new WebsocketSubscriptionProvider**(`subscriptionUrl`: `string`, `connectionParams`: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md), `extraOptions`?: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md)): [`WebsocketSubscriptionProvider`](WebsocketSubscriptionProvider.md) - -#### Parameters - -• **subscriptionUrl**: `string` - -• **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -• **extraOptions?**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Returns - -[`WebsocketSubscriptionProvider`](WebsocketSubscriptionProvider.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`constructor`](../../../subscription-provider/classes/SubscriptionProvider.md#constructors) - -## Properties - -### cleanup()? - -> `optional` **cleanup**: () => `void` - -#### Returns - -`void` - -*** - -### client? - -> `optional` **client**: `SubscriptionClient` - -*** - -### connectionParams - -> `protected` **connectionParams**: [`IDictionary`](../../../../types/shared/type-aliases/IDictionary.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`connectionParams`](../../../subscription-provider/classes/SubscriptionProvider.md#connectionparams) - -*** - -### extraOptions? - -> `protected` `optional` **extraOptions**: [`SubscriptionProviderExtraOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExtraOptions.md) - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`extraOptions`](../../../subscription-provider/classes/SubscriptionProvider.md#extraoptions) - -*** - -### subscriptionUrl - -> `protected` **subscriptionUrl**: `string` - -#### Inherited from - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`subscriptionUrl`](../../../subscription-provider/classes/SubscriptionProvider.md#subscriptionurl) - -## Methods - -### close() - -> **close**(): `void` - -#### Returns - -`void` - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`close`](../../../subscription-provider/classes/SubscriptionProvider.md#close) - -*** - -### createClient() - -> **createClient**(): `void` - -#### Returns - -`void` - -*** - -### execute() - -> **execute**(`options`: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md)): `Observable`\<`unknown`\> - -#### Parameters - -• **options**: [`SubscriptionProviderExecuteOptions`](../../../subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md) - -#### Returns - -`Observable`\<`unknown`\> - -#### Overrides - -[`SubscriptionProvider`](../../../subscription-provider/classes/SubscriptionProvider.md).[`execute`](../../../subscription-provider/classes/SubscriptionProvider.md#execute) diff --git a/packages/altair-docs/api/subscriptions/providers/ws/index.md b/packages/altair-docs/api/subscriptions/providers/ws/index.md deleted file mode 100644 index c992d453e4..0000000000 --- a/packages/altair-docs/api/subscriptions/providers/ws/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# subscriptions/providers/ws - -## Index - -| Member | Description | -| :------ | :------ | -| [WebsocketSubscriptionProvider](classes/WebsocketSubscriptionProvider.md) | - | diff --git a/packages/altair-docs/api/subscriptions/subscription-provider/classes/SubscriptionProvider.md b/packages/altair-docs/api/subscriptions/subscription-provider/classes/SubscriptionProvider.md deleted file mode 100644 index 33feabda59..0000000000 --- a/packages/altair-docs/api/subscriptions/subscription-provider/classes/SubscriptionProvider.md +++ /dev/null @@ -1,69 +0,0 @@ -# `abstract` SubscriptionProvider - -## Extended by - -- [`ActionCableSubscriptionProvider`](../../providers/action-cable/classes/ActionCableSubscriptionProvider.md) -- [`AppSyncSubscriptionProvider`](../../providers/app-sync/classes/AppSyncSubscriptionProvider.md) -- [`GraphQLSSESubscriptionProvider`](../../providers/graphql-sse/classes/GraphQLSSESubscriptionProvider.md) -- [`GraphQLWsSubscriptionProvider`](../../providers/graphql-ws/classes/GraphQLWsSubscriptionProvider.md) -- [`WebsocketSubscriptionProvider`](../../providers/ws/classes/WebsocketSubscriptionProvider.md) - -## Constructors - -### new SubscriptionProvider() - -> **new SubscriptionProvider**(`subscriptionUrl`: `string`, `connectionParams`: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md), `extraOptions`?: [`SubscriptionProviderExtraOptions`](../interfaces/SubscriptionProviderExtraOptions.md)): [`SubscriptionProvider`](SubscriptionProvider.md) - -#### Parameters - -• **subscriptionUrl**: `string` - -• **connectionParams**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) - -• **extraOptions?**: [`SubscriptionProviderExtraOptions`](../interfaces/SubscriptionProviderExtraOptions.md) - -#### Returns - -[`SubscriptionProvider`](SubscriptionProvider.md) - -## Properties - -### connectionParams - -> `protected` **connectionParams**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) - -*** - -### extraOptions? - -> `protected` `optional` **extraOptions**: [`SubscriptionProviderExtraOptions`](../interfaces/SubscriptionProviderExtraOptions.md) - -*** - -### subscriptionUrl - -> `protected` **subscriptionUrl**: `string` - -## Methods - -### close() - -> `abstract` **close**(): `void` - -#### Returns - -`void` - -*** - -### execute() - -> `abstract` **execute**(`options`: [`SubscriptionProviderExecuteOptions`](../interfaces/SubscriptionProviderExecuteOptions.md)): `Observable`\<`unknown`\> - -#### Parameters - -• **options**: [`SubscriptionProviderExecuteOptions`](../interfaces/SubscriptionProviderExecuteOptions.md) - -#### Returns - -`Observable`\<`unknown`\> diff --git a/packages/altair-docs/api/subscriptions/subscription-provider/index.md b/packages/altair-docs/api/subscriptions/subscription-provider/index.md deleted file mode 100644 index 7ec8d44097..0000000000 --- a/packages/altair-docs/api/subscriptions/subscription-provider/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# subscriptions/subscription-provider - -## Index - -| Member | Description | -| :------ | :------ | -| [SubscriptionProvider](classes/SubscriptionProvider.md) | - | -| [SubscriptionProviderExecuteOptions](interfaces/SubscriptionProviderExecuteOptions.md) | - | -| [SubscriptionProviderExtraOptions](interfaces/SubscriptionProviderExtraOptions.md) | - | -| [SubscriptionProviderConstructor](type-aliases/SubscriptionProviderConstructor.md) | - | diff --git a/packages/altair-docs/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md b/packages/altair-docs/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md deleted file mode 100644 index 77e814f85a..0000000000 --- a/packages/altair-docs/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md +++ /dev/null @@ -1,19 +0,0 @@ -# SubscriptionProviderExecuteOptions - -## Properties - -### operationName? - -> `optional` **operationName**: `string` - -*** - -### query - -> **query**: `string` - -*** - -### variables? - -> `optional` **variables**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) diff --git a/packages/altair-docs/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExtraOptions.md b/packages/altair-docs/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExtraOptions.md deleted file mode 100644 index aaaff9d292..0000000000 --- a/packages/altair-docs/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExtraOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -# SubscriptionProviderExtraOptions - -## Properties - -### headers? - -> `optional` **headers**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md)\<`string`\> - -*** - -### onConnected()? - -> `optional` **onConnected**: (`error`: `unknown`, `data`: `unknown`) => `void` - -#### Parameters - -• **error**: `unknown` - -• **data**: `unknown` - -#### Returns - -`void` diff --git a/packages/altair-docs/api/subscriptions/subscription-provider/type-aliases/SubscriptionProviderConstructor.md b/packages/altair-docs/api/subscriptions/subscription-provider/type-aliases/SubscriptionProviderConstructor.md deleted file mode 100644 index 211c71d02a..0000000000 --- a/packages/altair-docs/api/subscriptions/subscription-provider/type-aliases/SubscriptionProviderConstructor.md +++ /dev/null @@ -1,15 +0,0 @@ -# SubscriptionProviderConstructor() - -> **SubscriptionProviderConstructor**: (`subscriptionUrl`: `string`, `connectionParams`: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md), `extraOptions`?: [`SubscriptionProviderExtraOptions`](../interfaces/SubscriptionProviderExtraOptions.md)) => [`SubscriptionProvider`](../classes/SubscriptionProvider.md) - -## Parameters - -• **subscriptionUrl**: `string` - -• **connectionParams**: [`IDictionary`](../../../types/shared/type-aliases/IDictionary.md) - -• **extraOptions?**: [`SubscriptionProviderExtraOptions`](../interfaces/SubscriptionProviderExtraOptions.md) - -## Returns - -[`SubscriptionProvider`](../classes/SubscriptionProvider.md) diff --git a/packages/altair-docs/api/subscriptions/type-aliases/SubscriptionProviderIds.md b/packages/altair-docs/api/subscriptions/type-aliases/SubscriptionProviderIds.md deleted file mode 100644 index 8c8cdfd086..0000000000 --- a/packages/altair-docs/api/subscriptions/type-aliases/SubscriptionProviderIds.md +++ /dev/null @@ -1,3 +0,0 @@ -# SubscriptionProviderIds - -> **SubscriptionProviderIds**: *typeof* [`SUBSCRIPTION_PROVIDER_IDS`](../variables/SUBSCRIPTION_PROVIDER_IDS.md)\[keyof *typeof* [`SUBSCRIPTION_PROVIDER_IDS`](../variables/SUBSCRIPTION_PROVIDER_IDS.md)\] diff --git a/packages/altair-docs/api/subscriptions/variables/ACTION_CABLE_PROVIDER_ID.md b/packages/altair-docs/api/subscriptions/variables/ACTION_CABLE_PROVIDER_ID.md deleted file mode 100644 index 79bf122ec1..0000000000 --- a/packages/altair-docs/api/subscriptions/variables/ACTION_CABLE_PROVIDER_ID.md +++ /dev/null @@ -1,3 +0,0 @@ -# ACTION\_CABLE\_PROVIDER\_ID - -> `const` **ACTION\_CABLE\_PROVIDER\_ID**: `"action-cable"` = `'action-cable'` diff --git a/packages/altair-docs/api/subscriptions/variables/APP_SYNC_PROVIDER_ID.md b/packages/altair-docs/api/subscriptions/variables/APP_SYNC_PROVIDER_ID.md deleted file mode 100644 index 08373a4020..0000000000 --- a/packages/altair-docs/api/subscriptions/variables/APP_SYNC_PROVIDER_ID.md +++ /dev/null @@ -1,3 +0,0 @@ -# APP\_SYNC\_PROVIDER\_ID - -> `const` **APP\_SYNC\_PROVIDER\_ID**: `"app-sync"` = `'app-sync'` diff --git a/packages/altair-docs/api/subscriptions/variables/GRAPHQL_SSE_ID.md b/packages/altair-docs/api/subscriptions/variables/GRAPHQL_SSE_ID.md deleted file mode 100644 index ac767e2a57..0000000000 --- a/packages/altair-docs/api/subscriptions/variables/GRAPHQL_SSE_ID.md +++ /dev/null @@ -1,3 +0,0 @@ -# GRAPHQL\_SSE\_ID - -> `const` **GRAPHQL\_SSE\_ID**: `"graphql-sse"` = `'graphql-sse'` diff --git a/packages/altair-docs/api/subscriptions/variables/GRAPHQL_WS_PROVIDER_ID.md b/packages/altair-docs/api/subscriptions/variables/GRAPHQL_WS_PROVIDER_ID.md deleted file mode 100644 index d28adfed20..0000000000 --- a/packages/altair-docs/api/subscriptions/variables/GRAPHQL_WS_PROVIDER_ID.md +++ /dev/null @@ -1,3 +0,0 @@ -# GRAPHQL\_WS\_PROVIDER\_ID - -> `const` **GRAPHQL\_WS\_PROVIDER\_ID**: `"graphql-ws"` = `'graphql-ws'` diff --git a/packages/altair-docs/api/subscriptions/variables/SUBSCRIPTION_PROVIDER_IDS.md b/packages/altair-docs/api/subscriptions/variables/SUBSCRIPTION_PROVIDER_IDS.md deleted file mode 100644 index 59a6462202..0000000000 --- a/packages/altair-docs/api/subscriptions/variables/SUBSCRIPTION_PROVIDER_IDS.md +++ /dev/null @@ -1,25 +0,0 @@ -# SUBSCRIPTION\_PROVIDER\_IDS - -> `const` **SUBSCRIPTION\_PROVIDER\_IDS**: `object` - -## Type declaration - -### ACTION\_CABLE - -> `readonly` **ACTION\_CABLE**: `"action-cable"` = `ACTION_CABLE_PROVIDER_ID` - -### APP\_SYNC - -> `readonly` **APP\_SYNC**: `"app-sync"` = `APP_SYNC_PROVIDER_ID` - -### GRAPHQL\_SSE - -> `readonly` **GRAPHQL\_SSE**: `"graphql-sse"` = `GRAPHQL_SSE_ID` - -### GRAPHQL\_WS - -> `readonly` **GRAPHQL\_WS**: `"graphql-ws"` = `GRAPHQL_WS_PROVIDER_ID` - -### WEBSOCKET - -> `readonly` **WEBSOCKET**: `"websocket"` = `WEBSOCKET_PROVIDER_ID` diff --git a/packages/altair-docs/api/subscriptions/variables/WEBSOCKET_PROVIDER_ID.md b/packages/altair-docs/api/subscriptions/variables/WEBSOCKET_PROVIDER_ID.md deleted file mode 100644 index 9edab39ce2..0000000000 --- a/packages/altair-docs/api/subscriptions/variables/WEBSOCKET_PROVIDER_ID.md +++ /dev/null @@ -1,3 +0,0 @@ -# WEBSOCKET\_PROVIDER\_ID - -> `const` **WEBSOCKET\_PROVIDER\_ID**: `"websocket"` = `'websocket'` diff --git a/packages/altair-docs/api/theme/defaults/dark/index.md b/packages/altair-docs/api/theme/defaults/dark/index.md deleted file mode 100644 index d265b8a57f..0000000000 --- a/packages/altair-docs/api/theme/defaults/dark/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# theme/defaults/dark - -## Index - -| Member | Description | -| :------ | :------ | -| [default](variables/default.md) | - | diff --git a/packages/altair-docs/api/theme/defaults/dark/variables/default.md b/packages/altair-docs/api/theme/defaults/dark/variables/default.md deleted file mode 100644 index 8538598d9f..0000000000 --- a/packages/altair-docs/api/theme/defaults/dark/variables/default.md +++ /dev/null @@ -1,3 +0,0 @@ -# default - -> `const` **default**: [`ICustomTheme`](../../../theme/type-aliases/ICustomTheme.md) diff --git a/packages/altair-docs/api/theme/defaults/dracula/index.md b/packages/altair-docs/api/theme/defaults/dracula/index.md deleted file mode 100644 index bdd4d55821..0000000000 --- a/packages/altair-docs/api/theme/defaults/dracula/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# theme/defaults/dracula - -## Index - -| Member | Description | -| :------ | :------ | -| [default](variables/default.md) | - | diff --git a/packages/altair-docs/api/theme/defaults/dracula/variables/default.md b/packages/altair-docs/api/theme/defaults/dracula/variables/default.md deleted file mode 100644 index 8538598d9f..0000000000 --- a/packages/altair-docs/api/theme/defaults/dracula/variables/default.md +++ /dev/null @@ -1,3 +0,0 @@ -# default - -> `const` **default**: [`ICustomTheme`](../../../theme/type-aliases/ICustomTheme.md) diff --git a/packages/altair-docs/api/theme/defaults/light/index.md b/packages/altair-docs/api/theme/defaults/light/index.md deleted file mode 100644 index 962f9a4e42..0000000000 --- a/packages/altair-docs/api/theme/defaults/light/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# theme/defaults/light - -## Index - -| Member | Description | -| :------ | :------ | -| [default](variables/default.md) | - | diff --git a/packages/altair-docs/api/theme/defaults/light/variables/default.md b/packages/altair-docs/api/theme/defaults/light/variables/default.md deleted file mode 100644 index df88948edd..0000000000 --- a/packages/altair-docs/api/theme/defaults/light/variables/default.md +++ /dev/null @@ -1,3 +0,0 @@ -# default - -> `const` **default**: [`ICustomTheme`](../../../theme/type-aliases/ICustomTheme.md) = `{}` diff --git a/packages/altair-docs/api/theme/index.md b/packages/altair-docs/api/theme/index.md deleted file mode 100644 index facf4f5a10..0000000000 --- a/packages/altair-docs/api/theme/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# theme - -## Index - -| Member | Description | -| :------ | :------ | -| [dark](variables/dark.md) | - | -| [dracula](variables/dracula.md) | - | -| [light](variables/light.md) | - | diff --git a/packages/altair-docs/api/theme/theme/functions/createTheme.md b/packages/altair-docs/api/theme/theme/functions/createTheme.md deleted file mode 100644 index 60e4361518..0000000000 --- a/packages/altair-docs/api/theme/theme/functions/createTheme.md +++ /dev/null @@ -1,13 +0,0 @@ -# createTheme() - -> **createTheme**(`customTheme`: `RecursivePartial`\<`object` & `object`\>, ...`extraThemes`: `RecursivePartial`\<`object` & `object`\>[]): `object` & `object` - -## Parameters - -• **customTheme**: `RecursivePartial`\<`object` & `object`\> - -• ...**extraThemes**: `RecursivePartial`\<`object` & `object`\>[] - -## Returns - -`object` & `object` diff --git a/packages/altair-docs/api/theme/theme/functions/hexToRgbStr.md b/packages/altair-docs/api/theme/theme/functions/hexToRgbStr.md deleted file mode 100644 index 84a4791f85..0000000000 --- a/packages/altair-docs/api/theme/theme/functions/hexToRgbStr.md +++ /dev/null @@ -1,11 +0,0 @@ -# hexToRgbStr() - -> **hexToRgbStr**(`hex`: `string`): `string` - -## Parameters - -• **hex**: `string` - -## Returns - -`string` diff --git a/packages/altair-docs/api/theme/theme/functions/mergeThemes.md b/packages/altair-docs/api/theme/theme/functions/mergeThemes.md deleted file mode 100644 index 6d8a6a73c0..0000000000 --- a/packages/altair-docs/api/theme/theme/functions/mergeThemes.md +++ /dev/null @@ -1,11 +0,0 @@ -# mergeThemes() - -> **mergeThemes**(...`customThemes`: `RecursivePartial`\<`object` & `object`\>[]): `RecursivePartial`\<`object` & `object`\> - -## Parameters - -• ...**customThemes**: `RecursivePartial`\<`object` & `object`\>[] - -## Returns - -`RecursivePartial`\<`object` & `object`\> diff --git a/packages/altair-docs/api/theme/theme/index.md b/packages/altair-docs/api/theme/theme/index.md deleted file mode 100644 index cb79cdac8e..0000000000 --- a/packages/altair-docs/api/theme/theme/index.md +++ /dev/null @@ -1,12 +0,0 @@ -# theme/theme - -## Index - -| Member | Description | -| :------ | :------ | -| [ICustomTheme](type-aliases/ICustomTheme.md) | - | -| [ITheme](type-aliases/ITheme.md) | - | -| [foundations](variables/foundations.md) | - | -| [createTheme](functions/createTheme.md) | - | -| [hexToRgbStr](functions/hexToRgbStr.md) | - | -| [mergeThemes](functions/mergeThemes.md) | - | diff --git a/packages/altair-docs/api/theme/theme/type-aliases/ICustomTheme.md b/packages/altair-docs/api/theme/theme/type-aliases/ICustomTheme.md deleted file mode 100644 index 08d9b75efe..0000000000 --- a/packages/altair-docs/api/theme/theme/type-aliases/ICustomTheme.md +++ /dev/null @@ -1,3 +0,0 @@ -# ICustomTheme - -> **ICustomTheme**: `RecursivePartial`\<[`ITheme`](ITheme.md)\> diff --git a/packages/altair-docs/api/theme/theme/type-aliases/ITheme.md b/packages/altair-docs/api/theme/theme/type-aliases/ITheme.md deleted file mode 100644 index f4f5b284cf..0000000000 --- a/packages/altair-docs/api/theme/theme/type-aliases/ITheme.md +++ /dev/null @@ -1,3 +0,0 @@ -# ITheme - -> **ITheme**: *typeof* `theme` diff --git a/packages/altair-docs/api/theme/theme/variables/foundations.md b/packages/altair-docs/api/theme/theme/variables/foundations.md deleted file mode 100644 index 8d2442a882..0000000000 --- a/packages/altair-docs/api/theme/theme/variables/foundations.md +++ /dev/null @@ -1,101 +0,0 @@ -# foundations - -> `const` **foundations**: `object` - -## Type declaration - -### colors - -> **colors**: `object` - -### colors.black - -> **black**: `string` = `'#201e1f'` - -### colors.blue - -> **blue**: `string` = `'#2d9ee0'` - -### colors.cerise - -> **cerise**: `string` = `'#f00faa'` - -### colors.darkGray - -> **darkGray**: `string` = `'#a6a6a6'` - -### colors.darkPurple - -> **darkPurple**: `string` = `'#303965'` - -### colors.gray - -> **gray**: `string` = `'#eaeaea'` - -### colors.green - -> **green**: `string` = `'#64CB29'` - -### colors.lightGray - -> **lightGray**: `string` = `'#f0f0f0'` - -### colors.lightRed - -> **lightRed**: `string` = `'#cc998d'` - -### colors.orange - -> **orange**: `string` = `'#edae49'` - -### colors.red - -> **red**: `string` = `'#ed6a5a'` - -### colors.rose - -> **rose**: `string` = `'#f45b69'` - -### colors.white - -> **white**: `string` = `'#ffffff'` - -### colors.yellow - -> **yellow**: `string` = `'#e4ce44'` - -### easing - -> **easing**: `string` = `'ease'` - -### type - -> **type**: `object` - -### type.fontFamily - -> **fontFamily**: `object` - -### type.fontFamily.default - -> **default**: `string` = `'-apple-system, BlinkMacSystemFont, "Segoe UI", "Helvetica Neue", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"'` - -### type.fontSize - -> **fontSize**: `object` - -### type.fontSize.base - -> **base**: `number` = `24` - -### type.fontSize.body - -> **body**: `number` = `13` - -### type.fontSize.bodySmaller - -> **bodySmaller**: `number` = `12` - -### type.fontSize.remBase - -> **remBase**: `number` = `24` diff --git a/packages/altair-docs/api/theme/variables/dark.md b/packages/altair-docs/api/theme/variables/dark.md deleted file mode 100644 index 6ccca27e8b..0000000000 --- a/packages/altair-docs/api/theme/variables/dark.md +++ /dev/null @@ -1,3 +0,0 @@ -# dark - -> `const` **dark**: `RecursivePartial`\<`object` & `object`\> = `darkTheme` diff --git a/packages/altair-docs/api/theme/variables/dracula.md b/packages/altair-docs/api/theme/variables/dracula.md deleted file mode 100644 index bd8954ba03..0000000000 --- a/packages/altair-docs/api/theme/variables/dracula.md +++ /dev/null @@ -1,3 +0,0 @@ -# dracula - -> `const` **dracula**: `RecursivePartial`\<`object` & `object`\> = `draculaTheme` diff --git a/packages/altair-docs/api/theme/variables/light.md b/packages/altair-docs/api/theme/variables/light.md deleted file mode 100644 index 7f1bdeba9b..0000000000 --- a/packages/altair-docs/api/theme/variables/light.md +++ /dev/null @@ -1,3 +0,0 @@ -# light - -> `const` **light**: `RecursivePartial`\<`object` & `object`\> = `lightTheme` diff --git a/packages/altair-docs/api/typedoc-sidebar.json b/packages/altair-docs/api/typedoc-sidebar.json deleted file mode 100644 index 3d3dbe4db3..0000000000 --- a/packages/altair-docs/api/typedoc-sidebar.json +++ /dev/null @@ -1,2198 +0,0 @@ -[ - { - "text": "authorization", - "collapsed": true, - "items": [ - { - "text": "authorization-provider", - "link": "/api/authorization/authorization-provider/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "AuthorizationProvider", - "link": "/api/authorization/authorization-provider/classes/AuthorizationProvider.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "AuthorizationProviderExecuteOptions", - "link": "/api/authorization/authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md" - } - ] - } - ] - }, - { - "text": "providers", - "collapsed": true, - "items": [ - { - "text": "api-key", - "link": "/api/authorization/providers/api-key/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/authorization/providers/api-key/classes/default.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "ApiKeyAuthorizationProviderData", - "link": "/api/authorization/providers/api-key/interfaces/ApiKeyAuthorizationProviderData.md" - } - ] - } - ] - }, - { - "text": "basic", - "link": "/api/authorization/providers/basic/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/authorization/providers/basic/classes/default.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "BasicAuthorizationProviderData", - "link": "/api/authorization/providers/basic/interfaces/BasicAuthorizationProviderData.md" - } - ] - } - ] - }, - { - "text": "bearer", - "link": "/api/authorization/providers/bearer/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/authorization/providers/bearer/classes/default.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "BearerAuthorizationProviderData", - "link": "/api/authorization/providers/bearer/interfaces/BearerAuthorizationProviderData.md" - } - ] - } - ] - }, - { - "text": "oauth2", - "link": "/api/authorization/providers/oauth2/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/authorization/providers/oauth2/classes/default.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "OAuth2AuthorizationProviderData", - "link": "/api/authorization/providers/oauth2/interfaces/OAuth2AuthorizationProviderData.md" - } - ] - } - ] - } - ] - } - ] - }, - { - "text": "config", - "link": "/api/config/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "AltairConfig", - "link": "/api/config/classes/AltairConfig.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "AltairConfigOptions", - "link": "/api/config/interfaces/AltairConfigOptions.md" - }, - { - "text": "AltairWindowOptions", - "link": "/api/config/interfaces/AltairWindowOptions.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "getAltairConfig", - "link": "/api/config/functions/getAltairConfig.md" - }, - { - "text": "setAltairConfig", - "link": "/api/config/functions/setAltairConfig.md" - } - ] - } - ] - }, - { - "text": "evaluator", - "collapsed": true, - "items": [ - { - "text": "events", - "link": "/api/evaluator/events/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "EVALUATOR_INIT_EXECUTE", - "link": "/api/evaluator/events/variables/EVALUATOR_INIT_EXECUTE.md" - }, - { - "text": "EVALUATOR_READY", - "link": "/api/evaluator/events/variables/EVALUATOR_READY.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "getErrorEvent", - "link": "/api/evaluator/events/functions/getErrorEvent.md" - }, - { - "text": "getResponseEvent", - "link": "/api/evaluator/events/functions/getResponseEvent.md" - } - ] - } - ] - }, - { - "text": "worker", - "link": "/api/evaluator/worker/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "EvaluatorWorker", - "link": "/api/evaluator/worker/classes/EvaluatorWorker.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "EventData", - "link": "/api/evaluator/worker/interfaces/EventData.md" - } - ] - } - ] - } - ] - }, - { - "text": "index", - "link": "/api/index/", - "collapsed": true, - "items": [ - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "registerPluginClass", - "link": "/api/index/functions/registerPluginClass.md" - } - ] - } - ] - }, - { - "text": "oauth2", - "link": "/api/oauth2/" - }, - { - "text": "origins", - "link": "/api/origins/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "validOrigins", - "link": "/api/origins/variables/validOrigins.md" - } - ] - } - ] - }, - { - "text": "plugin", - "collapsed": true, - "items": [ - { - "text": "base", - "link": "/api/plugin/base/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "PluginBase", - "link": "/api/plugin/base/classes/PluginBase.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PluginConstructor", - "link": "/api/plugin/base/interfaces/PluginConstructor.md" - } - ] - } - ] - }, - { - "text": "context", - "collapsed": true, - "items": [ - { - "text": "context.interface", - "link": "/api/plugin/context/context.interface/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "CreateActionOptions", - "link": "/api/plugin/context/context.interface/interfaces/CreateActionOptions.md" - }, - { - "text": "CreatePanelOptions", - "link": "/api/plugin/context/context.interface/interfaces/CreatePanelOptions.md" - }, - { - "text": "PluginContext", - "link": "/api/plugin/context/context.interface/interfaces/PluginContext.md" - }, - { - "text": "PluginContextGenerator", - "link": "/api/plugin/context/context.interface/interfaces/PluginContextGenerator.md" - }, - { - "text": "PluginWindowState", - "link": "/api/plugin/context/context.interface/interfaces/PluginWindowState.md" - } - ] - } - ] - } - ] - }, - { - "text": "event", - "collapsed": true, - "items": [ - { - "text": "event.interfaces", - "link": "/api/plugin/event/event.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PluginEventPayloadMap", - "link": "/api/plugin/event/event.interfaces/interfaces/PluginEventPayloadMap.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "PluginEvent", - "link": "/api/plugin/event/event.interfaces/type-aliases/PluginEvent.md" - }, - { - "text": "PluginEventCallback", - "link": "/api/plugin/event/event.interfaces/type-aliases/PluginEventCallback.md" - } - ] - } - ] - } - ] - }, - { - "text": "panel", - "link": "/api/plugin/panel/", - "collapsed": true, - "items": [ - { - "text": "Enumerations", - "collapsed": true, - "items": [ - { - "text": "AltairPanelLocation", - "link": "/api/plugin/panel/enumerations/AltairPanelLocation.md" - } - ] - }, - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "AltairPanel", - "link": "/api/plugin/panel/classes/AltairPanel.md" - } - ] - } - ] - }, - { - "text": "plugin.interfaces", - "link": "/api/plugin/plugin.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Enumerations", - "collapsed": true, - "items": [ - { - "text": "PluginSource", - "link": "/api/plugin/plugin.interfaces/enumerations/PluginSource.md" - }, - { - "text": "PluginType", - "link": "/api/plugin/plugin.interfaces/enumerations/PluginType.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "AltairV1Plugin", - "link": "/api/plugin/plugin.interfaces/interfaces/AltairV1Plugin.md" - }, - { - "text": "PluginManifest", - "link": "/api/plugin/plugin.interfaces/interfaces/PluginManifest.md" - }, - { - "text": "RemotePluginListItem", - "link": "/api/plugin/plugin.interfaces/interfaces/RemotePluginListItem.md" - }, - { - "text": "RemotePluginListResponse", - "link": "/api/plugin/plugin.interfaces/interfaces/RemotePluginListResponse.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "PluginCapabilities", - "link": "/api/plugin/plugin.interfaces/type-aliases/PluginCapabilities.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "createV1Plugin", - "link": "/api/plugin/plugin.interfaces/functions/createV1Plugin.md" - } - ] - } - ] - }, - { - "text": "ui-action", - "link": "/api/plugin/ui-action/", - "collapsed": true, - "items": [ - { - "text": "Enumerations", - "collapsed": true, - "items": [ - { - "text": "AltairUiActionLocation", - "link": "/api/plugin/ui-action/enumerations/AltairUiActionLocation.md" - } - ] - }, - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "AltairUiAction", - "link": "/api/plugin/ui-action/classes/AltairUiAction.md" - } - ] - } - ] - }, - { - "text": "v3", - "collapsed": true, - "items": [ - { - "text": "capabilities", - "link": "/api/plugin/v3/capabilities/", - "collapsed": true, - "items": [ - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "PluginCapabilities", - "link": "/api/plugin/v3/capabilities/type-aliases/PluginCapabilities.md" - } - ] - } - ] - }, - { - "text": "context", - "link": "/api/plugin/v3/context/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PluginV3Context", - "link": "/api/plugin/v3/context/interfaces/PluginV3Context.md" - } - ] - } - ] - }, - { - "text": "events", - "link": "/api/plugin/v3/events/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "PLUGIN_CREATE_ACTION_EVENT", - "link": "/api/plugin/v3/events/variables/PLUGIN_CREATE_ACTION_EVENT.md" - }, - { - "text": "PLUGIN_ENGINE_READY", - "link": "/api/plugin/v3/events/variables/PLUGIN_ENGINE_READY.md" - }, - { - "text": "PLUGIN_GET_APP_STYLE_URL_EVENT", - "link": "/api/plugin/v3/events/variables/PLUGIN_GET_APP_STYLE_URL_EVENT.md" - }, - { - "text": "PLUGIN_SUBSCRIBE_TO_EVENT", - "link": "/api/plugin/v3/events/variables/PLUGIN_SUBSCRIBE_TO_EVENT.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "getActionEvent", - "link": "/api/plugin/v3/events/functions/getActionEvent.md" - } - ] - } - ] - }, - { - "text": "frame-engine", - "link": "/api/plugin/v3/frame-engine/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "PluginFrameEngine", - "link": "/api/plugin/v3/frame-engine/classes/PluginFrameEngine.md" - } - ] - } - ] - }, - { - "text": "frame-worker", - "link": "/api/plugin/v3/frame-worker/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "PluginFrameWorker", - "link": "/api/plugin/v3/frame-worker/classes/PluginFrameWorker.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "FrameQueryParams", - "link": "/api/plugin/v3/frame-worker/interfaces/FrameQueryParams.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "InstanceType", - "link": "/api/plugin/v3/frame-worker/type-aliases/InstanceType.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "instanceTypes", - "link": "/api/plugin/v3/frame-worker/variables/instanceTypes.md" - } - ] - } - ] - }, - { - "text": "manifest", - "link": "/api/plugin/v3/manifest/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PluginV3Manifest", - "link": "/api/plugin/v3/manifest/interfaces/PluginV3Manifest.md" - } - ] - } - ] - }, - { - "text": "panel", - "link": "/api/plugin/v3/panel/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "AltairV3Panel", - "link": "/api/plugin/v3/panel/classes/AltairV3Panel.md" - } - ] - } - ] - }, - { - "text": "parent-engine", - "link": "/api/plugin/v3/parent-engine/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "PluginParentEngine", - "link": "/api/plugin/v3/parent-engine/classes/PluginParentEngine.md" - } - ] - } - ] - }, - { - "text": "parent-worker", - "link": "/api/plugin/v3/parent-worker/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "PluginParentWorker", - "link": "/api/plugin/v3/parent-worker/classes/PluginParentWorker.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PluginParentWorkerOptions", - "link": "/api/plugin/v3/parent-worker/interfaces/PluginParentWorkerOptions.md" - } - ] - } - ] - }, - { - "text": "plugin", - "link": "/api/plugin/v3/plugin/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "PluginV3", - "link": "/api/plugin/v3/plugin/classes/PluginV3.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PluginV3Options", - "link": "/api/plugin/v3/plugin/interfaces/PluginV3Options.md" - } - ] - } - ] - }, - { - "text": "source", - "link": "/api/plugin/v3/source/", - "collapsed": true, - "items": [ - { - "text": "Enumerations", - "collapsed": true, - "items": [ - { - "text": "PluginSource", - "link": "/api/plugin/v3/source/enumerations/PluginSource.md" - } - ] - } - ] - } - ] - } - ] - }, - { - "text": "script", - "collapsed": true, - "items": [ - { - "text": "context", - "link": "/api/script/context/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "ModuleImports", - "link": "/api/script/context/variables/ModuleImports.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "buildContextResponse", - "link": "/api/script/context/functions/buildContextResponse.md" - }, - { - "text": "getGlobalContext", - "link": "/api/script/context/functions/getGlobalContext.md" - }, - { - "text": "importModuleHelper", - "link": "/api/script/context/functions/importModuleHelper.md" - } - ] - } - ] - }, - { - "text": "errors", - "link": "/api/script/errors/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "RequestScriptError", - "link": "/api/script/errors/classes/RequestScriptError.md" - } - ] - } - ] - }, - { - "text": "evaluator-client-engine", - "link": "/api/script/evaluator-client-engine/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "ScriptEvaluatorClientEngine", - "link": "/api/script/evaluator-client-engine/classes/ScriptEvaluatorClientEngine.md" - } - ] - } - ] - }, - { - "text": "evaluator-worker-engine", - "link": "/api/script/evaluator-worker-engine/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "ScriptEvaluatorWorkerEngine", - "link": "/api/script/evaluator-worker-engine/classes/ScriptEvaluatorWorkerEngine.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "WorkerHandlerNames", - "link": "/api/script/evaluator-worker-engine/type-aliases/WorkerHandlerNames.md" - } - ] - } - ] - }, - { - "text": "events", - "link": "/api/script/events/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "SCRIPT_INIT_EXECUTE", - "link": "/api/script/events/variables/SCRIPT_INIT_EXECUTE.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "getErrorEvent", - "link": "/api/script/events/functions/getErrorEvent.md" - }, - { - "text": "getResponseEvent", - "link": "/api/script/events/functions/getResponseEvent.md" - } - ] - } - ] - }, - { - "text": "types", - "link": "/api/script/types/", - "collapsed": true, - "items": [ - { - "text": "Enumerations", - "collapsed": true, - "items": [ - { - "text": "RequestType", - "link": "/api/script/types/enumerations/RequestType.md" - } - ] - }, - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "ScriptEvaluatorClient", - "link": "/api/script/types/classes/ScriptEvaluatorClient.md" - }, - { - "text": "ScriptEvaluatorWorker", - "link": "/api/script/types/classes/ScriptEvaluatorWorker.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "AllScriptEventHandlers", - "link": "/api/script/types/interfaces/AllScriptEventHandlers.md" - }, - { - "text": "CookieOptions", - "link": "/api/script/types/interfaces/CookieOptions.md" - }, - { - "text": "GlobalContextBuilderHandlers", - "link": "/api/script/types/interfaces/GlobalContextBuilderHandlers.md" - }, - { - "text": "GlobalHelperContext", - "link": "/api/script/types/interfaces/GlobalHelperContext.md" - }, - { - "text": "ModuleImportsMap", - "link": "/api/script/types/interfaces/ModuleImportsMap.md" - }, - { - "text": "ScriptContextData", - "link": "/api/script/types/interfaces/ScriptContextData.md" - }, - { - "text": "ScriptContextHelpers", - "link": "/api/script/types/interfaces/ScriptContextHelpers.md" - }, - { - "text": "ScriptContextResponse", - "link": "/api/script/types/interfaces/ScriptContextResponse.md" - }, - { - "text": "ScriptContextStorage", - "link": "/api/script/types/interfaces/ScriptContextStorage.md" - }, - { - "text": "ScriptEvaluatorClientFactory", - "link": "/api/script/types/interfaces/ScriptEvaluatorClientFactory.md" - }, - { - "text": "ScriptEventDataPayload", - "link": "/api/script/types/interfaces/ScriptEventDataPayload.md" - }, - { - "text": "ScriptEventErrorPayload", - "link": "/api/script/types/interfaces/ScriptEventErrorPayload.md" - }, - { - "text": "ScriptEventHandlers", - "link": "/api/script/types/interfaces/ScriptEventHandlers.md" - }, - { - "text": "ScriptEventResponsePayload", - "link": "/api/script/types/interfaces/ScriptEventResponsePayload.md" - }, - { - "text": "ScriptTranformResult", - "link": "/api/script/types/interfaces/ScriptTranformResult.md" - }, - { - "text": "ScriptWorkerMessageData", - "link": "/api/script/types/interfaces/ScriptWorkerMessageData.md" - }, - { - "text": "SendRequestResponse", - "link": "/api/script/types/interfaces/SendRequestResponse.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "SameSite", - "link": "/api/script/types/type-aliases/SameSite.md" - }, - { - "text": "ScriptEvent", - "link": "/api/script/types/type-aliases/ScriptEvent.md" - }, - { - "text": "ScriptEventData", - "link": "/api/script/types/type-aliases/ScriptEventData.md" - }, - { - "text": "ScriptEventParameters", - "link": "/api/script/types/type-aliases/ScriptEventParameters.md" - }, - { - "text": "ScriptResponseEvent", - "link": "/api/script/types/type-aliases/ScriptResponseEvent.md" - } - ] - } - ] - } - ] - }, - { - "text": "subscriptions", - "link": "/api/subscriptions/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "SubscriptionProviderData", - "link": "/api/subscriptions/interfaces/SubscriptionProviderData.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "SubscriptionProviderIds", - "link": "/api/subscriptions/type-aliases/SubscriptionProviderIds.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "ACTION_CABLE_PROVIDER_ID", - "link": "/api/subscriptions/variables/ACTION_CABLE_PROVIDER_ID.md" - }, - { - "text": "APP_SYNC_PROVIDER_ID", - "link": "/api/subscriptions/variables/APP_SYNC_PROVIDER_ID.md" - }, - { - "text": "GRAPHQL_SSE_ID", - "link": "/api/subscriptions/variables/GRAPHQL_SSE_ID.md" - }, - { - "text": "GRAPHQL_WS_PROVIDER_ID", - "link": "/api/subscriptions/variables/GRAPHQL_WS_PROVIDER_ID.md" - }, - { - "text": "SUBSCRIPTION_PROVIDER_IDS", - "link": "/api/subscriptions/variables/SUBSCRIPTION_PROVIDER_IDS.md" - }, - { - "text": "WEBSOCKET_PROVIDER_ID", - "link": "/api/subscriptions/variables/WEBSOCKET_PROVIDER_ID.md" - } - ] - }, - { - "text": "providers", - "collapsed": true, - "items": [ - { - "text": "action-cable", - "link": "/api/subscriptions/providers/action-cable/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "ActionCableSubscriptionProvider", - "link": "/api/subscriptions/providers/action-cable/classes/ActionCableSubscriptionProvider.md" - } - ] - } - ] - }, - { - "text": "app-sync", - "link": "/api/subscriptions/providers/app-sync/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "AppSyncSubscriptionProvider", - "link": "/api/subscriptions/providers/app-sync/classes/AppSyncSubscriptionProvider.md" - } - ] - } - ] - }, - { - "text": "graphql-sse", - "link": "/api/subscriptions/providers/graphql-sse/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "GraphQLSSESubscriptionProvider", - "link": "/api/subscriptions/providers/graphql-sse/classes/GraphQLSSESubscriptionProvider.md" - } - ] - } - ] - }, - { - "text": "graphql-ws", - "link": "/api/subscriptions/providers/graphql-ws/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "GraphQLWsSubscriptionProvider", - "link": "/api/subscriptions/providers/graphql-ws/classes/GraphQLWsSubscriptionProvider.md" - } - ] - } - ] - }, - { - "text": "ws", - "link": "/api/subscriptions/providers/ws/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "WebsocketSubscriptionProvider", - "link": "/api/subscriptions/providers/ws/classes/WebsocketSubscriptionProvider.md" - } - ] - } - ] - } - ] - }, - { - "text": "subscription-provider", - "link": "/api/subscriptions/subscription-provider/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "SubscriptionProvider", - "link": "/api/subscriptions/subscription-provider/classes/SubscriptionProvider.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "SubscriptionProviderExecuteOptions", - "link": "/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md" - }, - { - "text": "SubscriptionProviderExtraOptions", - "link": "/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExtraOptions.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "SubscriptionProviderConstructor", - "link": "/api/subscriptions/subscription-provider/type-aliases/SubscriptionProviderConstructor.md" - } - ] - } - ] - } - ] - }, - { - "text": "theme", - "link": "/api/theme/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "dark", - "link": "/api/theme/variables/dark.md" - }, - { - "text": "dracula", - "link": "/api/theme/variables/dracula.md" - }, - { - "text": "light", - "link": "/api/theme/variables/light.md" - } - ] - }, - { - "text": "defaults", - "collapsed": true, - "items": [ - { - "text": "dark", - "link": "/api/theme/defaults/dark/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/theme/defaults/dark/variables/default.md" - } - ] - } - ] - }, - { - "text": "dracula", - "link": "/api/theme/defaults/dracula/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/theme/defaults/dracula/variables/default.md" - } - ] - } - ] - }, - { - "text": "light", - "link": "/api/theme/defaults/light/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/theme/defaults/light/variables/default.md" - } - ] - } - ] - } - ] - }, - { - "text": "theme", - "link": "/api/theme/theme/", - "collapsed": true, - "items": [ - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "ICustomTheme", - "link": "/api/theme/theme/type-aliases/ICustomTheme.md" - }, - { - "text": "ITheme", - "link": "/api/theme/theme/type-aliases/ITheme.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "foundations", - "link": "/api/theme/theme/variables/foundations.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "createTheme", - "link": "/api/theme/theme/functions/createTheme.md" - }, - { - "text": "hexToRgbStr", - "link": "/api/theme/theme/functions/hexToRgbStr.md" - }, - { - "text": "mergeThemes", - "link": "/api/theme/theme/functions/mergeThemes.md" - } - ] - } - ] - } - ] - }, - { - "text": "types", - "collapsed": true, - "items": [ - { - "text": "shared", - "link": "/api/types/shared/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "BaseDocument", - "link": "/api/types/shared/interfaces/BaseDocument.md" - }, - { - "text": "BaseOwnableDocument", - "link": "/api/types/shared/interfaces/BaseOwnableDocument.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "CreateDTO", - "link": "/api/types/shared/type-aliases/CreateDTO.md" - }, - { - "text": "IDictionary", - "link": "/api/types/shared/type-aliases/IDictionary.md" - }, - { - "text": "NoExtraProperties", - "link": "/api/types/shared/type-aliases/NoExtraProperties.md" - }, - { - "text": "TODO", - "link": "/api/types/shared/type-aliases/TODO.md" - }, - { - "text": "UpdateDTO", - "link": "/api/types/shared/type-aliases/UpdateDTO.md" - } - ] - } - ] - }, - { - "text": "state", - "collapsed": true, - "items": [ - { - "text": "account.interfaces", - "link": "/api/types/state/account.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "TeamId", - "link": "/api/types/state/account.interfaces/classes/TeamId.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "AccountState", - "link": "/api/types/state/account.interfaces/interfaces/AccountState.md" - }, - { - "text": "IPlan", - "link": "/api/types/state/account.interfaces/interfaces/IPlan.md" - }, - { - "text": "IPlanInfo", - "link": "/api/types/state/account.interfaces/interfaces/IPlanInfo.md" - }, - { - "text": "Team", - "link": "/api/types/state/account.interfaces/interfaces/Team.md" - } - ] - } - ] - }, - { - "text": "authorization.interface", - "link": "/api/types/state/authorization.interface/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "AuthorizationResult", - "link": "/api/types/state/authorization.interface/interfaces/AuthorizationResult.md" - }, - { - "text": "AuthorizationState", - "link": "/api/types/state/authorization.interface/interfaces/AuthorizationState.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "AuthorizationTypes", - "link": "/api/types/state/authorization.interface/type-aliases/AuthorizationTypes.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "AUTHORIZATION_TYPES", - "link": "/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPES.md" - }, - { - "text": "AUTHORIZATION_TYPE_LIST", - "link": "/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPE_LIST.md" - }, - { - "text": "DEFAULT_AUTHORIZATION_TYPE", - "link": "/api/types/state/authorization.interface/variables/DEFAULT_AUTHORIZATION_TYPE.md" - } - ] - } - ] - }, - { - "text": "collection.interfaces", - "link": "/api/types/state/collection.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "CollectionState", - "link": "/api/types/state/collection.interfaces/interfaces/CollectionState.md" - }, - { - "text": "ExportCollectionState", - "link": "/api/types/state/collection.interfaces/interfaces/ExportCollectionState.md" - }, - { - "text": "IQuery", - "link": "/api/types/state/collection.interfaces/interfaces/IQuery.md" - }, - { - "text": "IQueryCollection", - "link": "/api/types/state/collection.interfaces/interfaces/IQueryCollection.md" - }, - { - "text": "IQueryCollectionTree", - "link": "/api/types/state/collection.interfaces/interfaces/IQueryCollectionTree.md" - }, - { - "text": "IRemoteQuery", - "link": "/api/types/state/collection.interfaces/interfaces/IRemoteQuery.md" - }, - { - "text": "IRemoteQueryCollection", - "link": "/api/types/state/collection.interfaces/interfaces/IRemoteQueryCollection.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "EntityStorageType", - "link": "/api/types/state/collection.interfaces/type-aliases/EntityStorageType.md" - }, - { - "text": "SortByOptions", - "link": "/api/types/state/collection.interfaces/type-aliases/SortByOptions.md" - } - ] - } - ] - }, - { - "text": "collections-meta.interfaces", - "link": "/api/types/state/collections-meta.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "CollectionsMetaState", - "link": "/api/types/state/collections-meta.interfaces/interfaces/CollectionsMetaState.md" - } - ] - } - ] - }, - { - "text": "dialog.interfaces", - "link": "/api/types/state/dialog.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "DialogState", - "link": "/api/types/state/dialog.interfaces/interfaces/DialogState.md" - } - ] - } - ] - }, - { - "text": "docs.interfaces", - "link": "/api/types/state/docs.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "DocsState", - "link": "/api/types/state/docs.interfaces/interfaces/DocsState.md" - }, - { - "text": "FieldDocView", - "link": "/api/types/state/docs.interfaces/interfaces/FieldDocView.md" - }, - { - "text": "RootDocView", - "link": "/api/types/state/docs.interfaces/interfaces/RootDocView.md" - }, - { - "text": "SearchDocView", - "link": "/api/types/state/docs.interfaces/interfaces/SearchDocView.md" - }, - { - "text": "TypeDocView", - "link": "/api/types/state/docs.interfaces/interfaces/TypeDocView.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "DocView", - "link": "/api/types/state/docs.interfaces/type-aliases/DocView.md" - } - ] - } - ] - }, - { - "text": "donation.interfaces", - "link": "/api/types/state/donation.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "DonationState", - "link": "/api/types/state/donation.interfaces/interfaces/DonationState.md" - } - ] - } - ] - }, - { - "text": "environments.interfaces", - "link": "/api/types/state/environments.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "EnvironmentState", - "link": "/api/types/state/environments.interfaces/interfaces/EnvironmentState.md" - }, - { - "text": "EnvironmentsState", - "link": "/api/types/state/environments.interfaces/interfaces/EnvironmentsState.md" - }, - { - "text": "ExportEnvironmentState", - "link": "/api/types/state/environments.interfaces/interfaces/ExportEnvironmentState.md" - }, - { - "text": "IEnvironment", - "link": "/api/types/state/environments.interfaces/interfaces/IEnvironment.md" - }, - { - "text": "IInitialEnvironments", - "link": "/api/types/state/environments.interfaces/interfaces/IInitialEnvironments.md" - }, - { - "text": "InitialEnvironmentState", - "link": "/api/types/state/environments.interfaces/interfaces/InitialEnvironmentState.md" - } - ] - } - ] - }, - { - "text": "gql-schema.interfaces", - "link": "/api/types/state/gql-schema.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "GQLSchemaState", - "link": "/api/types/state/gql-schema.interfaces/interfaces/GQLSchemaState.md" - } - ] - } - ] - }, - { - "text": "header.interfaces", - "link": "/api/types/state/header.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "Header", - "link": "/api/types/state/header.interfaces/interfaces/Header.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "HeaderState", - "link": "/api/types/state/header.interfaces/type-aliases/HeaderState.md" - } - ] - } - ] - }, - { - "text": "history.interfaces", - "link": "/api/types/state/history.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "History", - "link": "/api/types/state/history.interfaces/interfaces/History.md" - }, - { - "text": "HistoryState", - "link": "/api/types/state/history.interfaces/interfaces/HistoryState.md" - } - ] - } - ] - }, - { - "text": "layout.interfaces", - "link": "/api/types/state/layout.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "LayoutState", - "link": "/api/types/state/layout.interfaces/interfaces/LayoutState.md" - } - ] - } - ] - }, - { - "text": "local.interfaces", - "link": "/api/types/state/local.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "LocalState", - "link": "/api/types/state/local.interfaces/interfaces/LocalState.md" - }, - { - "text": "V1PluginStateEntry", - "link": "/api/types/state/local.interfaces/interfaces/V1PluginStateEntry.md" - }, - { - "text": "V3PluginStateEntry", - "link": "/api/types/state/local.interfaces/interfaces/V3PluginStateEntry.md" - } - ] - } - ] - }, - { - "text": "per-window.interfaces", - "link": "/api/types/state/per-window.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PerWindowState", - "link": "/api/types/state/per-window.interfaces/interfaces/PerWindowState.md" - } - ] - } - ] - }, - { - "text": "postrequest.interfaces", - "link": "/api/types/state/postrequest.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PostrequestState", - "link": "/api/types/state/postrequest.interfaces/interfaces/PostrequestState.md" - } - ] - } - ] - }, - { - "text": "prerequest.interfaces", - "link": "/api/types/state/prerequest.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PrerequestState", - "link": "/api/types/state/prerequest.interfaces/interfaces/PrerequestState.md" - } - ] - } - ] - }, - { - "text": "query.interfaces", - "link": "/api/types/state/query.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "LogLine", - "link": "/api/types/state/query.interfaces/interfaces/LogLine.md" - }, - { - "text": "QueryEditorState", - "link": "/api/types/state/query.interfaces/interfaces/QueryEditorState.md" - }, - { - "text": "QueryState", - "link": "/api/types/state/query.interfaces/interfaces/QueryState.md" - }, - { - "text": "SubscriptionResponse", - "link": "/api/types/state/query.interfaces/interfaces/SubscriptionResponse.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "HttpVerb", - "link": "/api/types/state/query.interfaces/type-aliases/HttpVerb.md" - }, - { - "text": "SelectedOperation", - "link": "/api/types/state/query.interfaces/type-aliases/SelectedOperation.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "HTTP_VERBS", - "link": "/api/types/state/query.interfaces/variables/HTTP_VERBS.md" - } - ] - } - ] - }, - { - "text": "settings.interfaces", - "link": "/api/types/state/settings.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "SettingsState", - "link": "/api/types/state/settings.interfaces/interfaces/SettingsState.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "SettingsLanguage", - "link": "/api/types/state/settings.interfaces/type-aliases/SettingsLanguage.md" - } - ] - } - ] - }, - { - "text": "state.interfaces", - "link": "/api/types/state/state.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "RootState", - "link": "/api/types/state/state.interfaces/interfaces/RootState.md" - } - ] - } - ] - }, - { - "text": "stream.interfaces", - "link": "/api/types/state/stream.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "StreamState", - "link": "/api/types/state/stream.interfaces/interfaces/StreamState.md" - } - ] - } - ] - }, - { - "text": "variable.interfaces", - "link": "/api/types/state/variable.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "FileVariable", - "link": "/api/types/state/variable.interfaces/interfaces/FileVariable.md" - }, - { - "text": "VariableState", - "link": "/api/types/state/variable.interfaces/interfaces/VariableState.md" - } - ] - } - ] - }, - { - "text": "window.interfaces", - "link": "/api/types/state/window.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "ExportWindowState", - "link": "/api/types/state/window.interfaces/interfaces/ExportWindowState.md" - }, - { - "text": "WindowState", - "link": "/api/types/state/window.interfaces/interfaces/WindowState.md" - } - ] - } - ] - }, - { - "text": "windows-meta.interfaces", - "link": "/api/types/state/windows-meta.interfaces/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "WindowsMetaState", - "link": "/api/types/state/windows-meta.interfaces/interfaces/WindowsMetaState.md" - } - ] - } - ] - }, - { - "text": "workspace.interface", - "link": "/api/types/state/workspace.interface/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "WorkspaceId", - "link": "/api/types/state/workspace.interface/classes/WorkspaceId.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "Workspace", - "link": "/api/types/state/workspace.interface/interfaces/Workspace.md" - }, - { - "text": "WorkspacesState", - "link": "/api/types/state/workspace.interface/interfaces/WorkspacesState.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "WORKSPACES", - "link": "/api/types/state/workspace.interface/variables/WORKSPACES.md" - } - ] - } - ] - } - ] - } - ] - }, - { - "text": "utils", - "collapsed": true, - "items": [ - { - "text": "is_electron", - "link": "/api/utils/is_electron/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/utils/is_electron/variables/default.md" - } - ] - } - ] - }, - { - "text": "logger", - "link": "/api/utils/logger/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "ILogger", - "link": "/api/utils/logger/interfaces/ILogger.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "createLogger", - "link": "/api/utils/logger/functions/createLogger.md" - } - ] - } - ] - }, - { - "text": "url", - "link": "/api/utils/url/", - "collapsed": true, - "items": [ - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "urlWithParams", - "link": "/api/utils/url/functions/urlWithParams.md" - } - ] - } - ] - }, - { - "text": "value-object", - "link": "/api/utils/value-object/", - "collapsed": true, - "items": [ - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "ValueObject", - "link": "/api/utils/value-object/classes/ValueObject.md" - } - ] - } - ] - } - ] - }, - { - "text": "validate-partial-settings", - "link": "/api/validate-partial-settings/", - "collapsed": true, - "items": [ - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/validate-partial-settings/functions/default.md" - } - ] - } - ] - }, - { - "text": "validate-settings", - "link": "/api/validate-settings/", - "collapsed": true, - "items": [ - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/api/validate-settings/functions/default.md" - } - ] - } - ] - } -] \ No newline at end of file diff --git a/packages/altair-docs/api/types/shared/index.md b/packages/altair-docs/api/types/shared/index.md deleted file mode 100644 index 226da2b09f..0000000000 --- a/packages/altair-docs/api/types/shared/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# types/shared - -## Index - -| Member | Description | -| :------ | :------ | -| [BaseDocument](interfaces/BaseDocument.md) | - | -| [BaseOwnableDocument](interfaces/BaseOwnableDocument.md) | - | -| [CreateDTO](type-aliases/CreateDTO.md) | - | -| [IDictionary](type-aliases/IDictionary.md) | - | -| [NoExtraProperties](type-aliases/NoExtraProperties.md) | - | -| [TODO](type-aliases/TODO.md) | - | -| [UpdateDTO](type-aliases/UpdateDTO.md) | - | diff --git a/packages/altair-docs/api/types/shared/interfaces/BaseDocument.md b/packages/altair-docs/api/types/shared/interfaces/BaseDocument.md deleted file mode 100644 index 4a37e9132c..0000000000 --- a/packages/altair-docs/api/types/shared/interfaces/BaseDocument.md +++ /dev/null @@ -1,24 +0,0 @@ -# BaseDocument - -## Extended by - -- [`BaseOwnableDocument`](BaseOwnableDocument.md) -- [`IQueryCollection`](../../state/collection.interfaces/interfaces/IQueryCollection.md) - -## Properties - -### created\_at? - -> `optional` **created\_at**: `number` - -*** - -### id - -> **id**: `string` - -*** - -### updated\_at? - -> `optional` **updated\_at**: `number` diff --git a/packages/altair-docs/api/types/shared/interfaces/BaseOwnableDocument.md b/packages/altair-docs/api/types/shared/interfaces/BaseOwnableDocument.md deleted file mode 100644 index 02df1259d3..0000000000 --- a/packages/altair-docs/api/types/shared/interfaces/BaseOwnableDocument.md +++ /dev/null @@ -1,46 +0,0 @@ -# BaseOwnableDocument - -## Extends - -- [`BaseDocument`](BaseDocument.md) - -## Extended by - -- [`IRemoteQuery`](../../state/collection.interfaces/interfaces/IRemoteQuery.md) -- [`IRemoteQueryCollection`](../../state/collection.interfaces/interfaces/IRemoteQueryCollection.md) - -## Properties - -### created\_at? - -> `optional` **created\_at**: `number` - -#### Inherited from - -[`BaseDocument`](BaseDocument.md).[`created_at`](BaseDocument.md#created-at) - -*** - -### id - -> **id**: `string` - -#### Inherited from - -[`BaseDocument`](BaseDocument.md).[`id`](BaseDocument.md#id) - -*** - -### ownerUid - -> **ownerUid**: `string` - -*** - -### updated\_at? - -> `optional` **updated\_at**: `number` - -#### Inherited from - -[`BaseDocument`](BaseDocument.md).[`updated_at`](BaseDocument.md#updated-at) diff --git a/packages/altair-docs/api/types/shared/type-aliases/CreateDTO.md b/packages/altair-docs/api/types/shared/type-aliases/CreateDTO.md deleted file mode 100644 index 04f661e1ab..0000000000 --- a/packages/altair-docs/api/types/shared/type-aliases/CreateDTO.md +++ /dev/null @@ -1,7 +0,0 @@ -# CreateDTO\ - -> **CreateDTO**\<`T`\>: `T` *extends* [`BaseOwnableDocument`](../interfaces/BaseOwnableDocument.md) ? `TypedOmit`\<`T`, keyof [`BaseOwnableDocument`](../interfaces/BaseOwnableDocument.md)\> : `TypedOmit`\<`T`, keyof [`BaseDocument`](../interfaces/BaseDocument.md)\> - -## Type parameters - -• **T** *extends* [`BaseDocument`](../interfaces/BaseDocument.md) \| [`BaseOwnableDocument`](../interfaces/BaseOwnableDocument.md) diff --git a/packages/altair-docs/api/types/shared/type-aliases/IDictionary.md b/packages/altair-docs/api/types/shared/type-aliases/IDictionary.md deleted file mode 100644 index 59d5d5822d..0000000000 --- a/packages/altair-docs/api/types/shared/type-aliases/IDictionary.md +++ /dev/null @@ -1,7 +0,0 @@ -# IDictionary\ - -> **IDictionary**\<`V`\>: `Record`\<`string`, `V`\> - -## Type parameters - -• **V** = `any` diff --git a/packages/altair-docs/api/types/shared/type-aliases/NoExtraProperties.md b/packages/altair-docs/api/types/shared/type-aliases/NoExtraProperties.md deleted file mode 100644 index 0d4d848af2..0000000000 --- a/packages/altair-docs/api/types/shared/type-aliases/NoExtraProperties.md +++ /dev/null @@ -1,9 +0,0 @@ -# NoExtraProperties\ - -> **NoExtraProperties**\<`T`, `U`\>: `U` *extends* infer V[] ? [`NoExtraProperties`](NoExtraProperties.md)\<`V`\>[] : `U` & `Impossible`\<`Exclude`\\> - -## Type parameters - -• **T** - -• **U** *extends* `T` = `T` diff --git a/packages/altair-docs/api/types/shared/type-aliases/TODO.md b/packages/altair-docs/api/types/shared/type-aliases/TODO.md deleted file mode 100644 index 09b04fb723..0000000000 --- a/packages/altair-docs/api/types/shared/type-aliases/TODO.md +++ /dev/null @@ -1,3 +0,0 @@ -# TODO - -> **TODO**: `any` diff --git a/packages/altair-docs/api/types/shared/type-aliases/UpdateDTO.md b/packages/altair-docs/api/types/shared/type-aliases/UpdateDTO.md deleted file mode 100644 index 9f490c5bee..0000000000 --- a/packages/altair-docs/api/types/shared/type-aliases/UpdateDTO.md +++ /dev/null @@ -1,7 +0,0 @@ -# UpdateDTO\ - -> **UpdateDTO**\<`T`\>: [`CreateDTO`](CreateDTO.md)\<`T`\> & `Pick`\<`T`, `"id"`\> - -## Type parameters - -• **T** *extends* [`BaseDocument`](../interfaces/BaseDocument.md) \| [`BaseOwnableDocument`](../interfaces/BaseOwnableDocument.md) diff --git a/packages/altair-docs/api/types/state/account.interfaces/classes/TeamId.md b/packages/altair-docs/api/types/state/account.interfaces/classes/TeamId.md deleted file mode 100644 index 559d737f72..0000000000 --- a/packages/altair-docs/api/types/state/account.interfaces/classes/TeamId.md +++ /dev/null @@ -1,65 +0,0 @@ -# TeamId - -## Extends - -- [`ValueObject`](../../../../utils/value-object/classes/ValueObject.md)\<`string`\> - -## Constructors - -### new TeamId() - -> **new TeamId**(`props`: `string`): [`TeamId`](TeamId.md) - -#### Parameters - -• **props**: `string` - -#### Returns - -[`TeamId`](TeamId.md) - -#### Inherited from - -[`ValueObject`](../../../../utils/value-object/classes/ValueObject.md).[`constructor`](../../../../utils/value-object/classes/ValueObject.md#constructors) - -## Properties - -### props - -> `readonly` **props**: `string` - -#### Inherited from - -[`ValueObject`](../../../../utils/value-object/classes/ValueObject.md).[`props`](../../../../utils/value-object/classes/ValueObject.md#props) - -## Methods - -### equals() - -> **equals**(`vo`?: [`ValueObject`](../../../../utils/value-object/classes/ValueObject.md)\<`string`\>): `boolean` - -#### Parameters - -• **vo?**: [`ValueObject`](../../../../utils/value-object/classes/ValueObject.md)\<`string`\> - -#### Returns - -`boolean` - -#### Inherited from - -[`ValueObject`](../../../../utils/value-object/classes/ValueObject.md).[`equals`](../../../../utils/value-object/classes/ValueObject.md#equals) - -*** - -### value() - -> **value**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[`ValueObject`](../../../../utils/value-object/classes/ValueObject.md).[`value`](../../../../utils/value-object/classes/ValueObject.md#value) diff --git a/packages/altair-docs/api/types/state/account.interfaces/index.md b/packages/altair-docs/api/types/state/account.interfaces/index.md deleted file mode 100644 index ffb2588620..0000000000 --- a/packages/altair-docs/api/types/state/account.interfaces/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# types/state/account.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [TeamId](classes/TeamId.md) | - | -| [AccountState](interfaces/AccountState.md) | - | -| [IPlan](interfaces/IPlan.md) | - | -| [IPlanInfo](interfaces/IPlanInfo.md) | - | -| [Team](interfaces/Team.md) | - | diff --git a/packages/altair-docs/api/types/state/account.interfaces/interfaces/AccountState.md b/packages/altair-docs/api/types/state/account.interfaces/interfaces/AccountState.md deleted file mode 100644 index 48d4775ffe..0000000000 --- a/packages/altair-docs/api/types/state/account.interfaces/interfaces/AccountState.md +++ /dev/null @@ -1,61 +0,0 @@ -# AccountState - -## Properties - -### accessToken - -> **accessToken**: `string` - -*** - -### email - -> **email**: `string` - -*** - -### firstName - -> **firstName**: `string` - -*** - -### lastName - -> **lastName**: `string` - -*** - -### loggedIn - -> **loggedIn**: `boolean` - -*** - -### picture - -> **picture**: `string` - -*** - -### plan? - -> `optional` **plan**: [`IPlan`](IPlan.md) - -*** - -### planInfos? - -> `optional` **planInfos**: [`IPlanInfo`](IPlanInfo.md)[] - -*** - -### stats? - -> `optional` **stats**: `Stats` - -*** - -### teams - -> **teams**: [`Team`](Team.md)[] diff --git a/packages/altair-docs/api/types/state/account.interfaces/interfaces/IPlan.md b/packages/altair-docs/api/types/state/account.interfaces/interfaces/IPlan.md deleted file mode 100644 index 05aca44033..0000000000 --- a/packages/altair-docs/api/types/state/account.interfaces/interfaces/IPlan.md +++ /dev/null @@ -1,31 +0,0 @@ -# IPlan - -## Properties - -### canUpgradePro - -> **canUpgradePro**: `boolean` - -*** - -### id - -> **id**: `string` - -*** - -### maxQueriesCount - -> **maxQueriesCount**: `number` - -*** - -### maxTeamMembersCount - -> **maxTeamMembersCount**: `number` - -*** - -### maxTeamsCount - -> **maxTeamsCount**: `number` diff --git a/packages/altair-docs/api/types/state/account.interfaces/interfaces/IPlanInfo.md b/packages/altair-docs/api/types/state/account.interfaces/interfaces/IPlanInfo.md deleted file mode 100644 index f16308f3be..0000000000 --- a/packages/altair-docs/api/types/state/account.interfaces/interfaces/IPlanInfo.md +++ /dev/null @@ -1,49 +0,0 @@ -# IPlanInfo - -## Properties - -### currency - -> **currency**: `string` - -*** - -### description - -> **description**: `string` - -*** - -### id - -> **id**: `string` - -*** - -### interval - -> **interval**: `string` - -*** - -### name - -> **name**: `string` - -*** - -### price - -> **price**: `number` - -*** - -### priceId - -> **priceId**: `string` - -*** - -### role - -> **role**: `string` diff --git a/packages/altair-docs/api/types/state/account.interfaces/interfaces/Team.md b/packages/altair-docs/api/types/state/account.interfaces/interfaces/Team.md deleted file mode 100644 index d96a2f4c06..0000000000 --- a/packages/altair-docs/api/types/state/account.interfaces/interfaces/Team.md +++ /dev/null @@ -1,19 +0,0 @@ -# Team - -## Properties - -### description? - -> `optional` **description**: `string` - -*** - -### id - -> **id**: `string` - -*** - -### name - -> **name**: `string` diff --git a/packages/altair-docs/api/types/state/authorization.interface/index.md b/packages/altair-docs/api/types/state/authorization.interface/index.md deleted file mode 100644 index 1d77d4cc5a..0000000000 --- a/packages/altair-docs/api/types/state/authorization.interface/index.md +++ /dev/null @@ -1,12 +0,0 @@ -# types/state/authorization.interface - -## Index - -| Member | Description | -| :------ | :------ | -| [AuthorizationResult](interfaces/AuthorizationResult.md) | - | -| [AuthorizationState](interfaces/AuthorizationState.md) | - | -| [AuthorizationTypes](type-aliases/AuthorizationTypes.md) | - | -| [AUTHORIZATION\_TYPES](variables/AUTHORIZATION_TYPES.md) | - | -| [AUTHORIZATION\_TYPE\_LIST](variables/AUTHORIZATION_TYPE_LIST.md) | - | -| [DEFAULT\_AUTHORIZATION\_TYPE](variables/DEFAULT_AUTHORIZATION_TYPE.md) | - | diff --git a/packages/altair-docs/api/types/state/authorization.interface/interfaces/AuthorizationResult.md b/packages/altair-docs/api/types/state/authorization.interface/interfaces/AuthorizationResult.md deleted file mode 100644 index e019b818fc..0000000000 --- a/packages/altair-docs/api/types/state/authorization.interface/interfaces/AuthorizationResult.md +++ /dev/null @@ -1,7 +0,0 @@ -# AuthorizationResult - -## Properties - -### headers - -> **headers**: [`IDictionary`](../../../shared/type-aliases/IDictionary.md)\<`string`\> diff --git a/packages/altair-docs/api/types/state/authorization.interface/interfaces/AuthorizationState.md b/packages/altair-docs/api/types/state/authorization.interface/interfaces/AuthorizationState.md deleted file mode 100644 index 27b8e20a51..0000000000 --- a/packages/altair-docs/api/types/state/authorization.interface/interfaces/AuthorizationState.md +++ /dev/null @@ -1,19 +0,0 @@ -# AuthorizationState - -## Properties - -### data - -> **data**: `unknown` - -*** - -### result - -> **result**: [`AuthorizationResult`](AuthorizationResult.md) - -*** - -### type - -> **type**: [`AuthorizationTypes`](../type-aliases/AuthorizationTypes.md) diff --git a/packages/altair-docs/api/types/state/authorization.interface/type-aliases/AuthorizationTypes.md b/packages/altair-docs/api/types/state/authorization.interface/type-aliases/AuthorizationTypes.md deleted file mode 100644 index 3d3b968870..0000000000 --- a/packages/altair-docs/api/types/state/authorization.interface/type-aliases/AuthorizationTypes.md +++ /dev/null @@ -1,3 +0,0 @@ -# AuthorizationTypes - -> **AuthorizationTypes**: *typeof* [`AUTHORIZATION_TYPES`](../variables/AUTHORIZATION_TYPES.md)\[keyof *typeof* [`AUTHORIZATION_TYPES`](../variables/AUTHORIZATION_TYPES.md)\] diff --git a/packages/altair-docs/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPES.md b/packages/altair-docs/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPES.md deleted file mode 100644 index 5d6064c819..0000000000 --- a/packages/altair-docs/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPES.md +++ /dev/null @@ -1,25 +0,0 @@ -# AUTHORIZATION\_TYPES - -> `const` **AUTHORIZATION\_TYPES**: `object` - -## Type declaration - -### API\_KEY - -> `readonly` **API\_KEY**: `"api-key"` = `'api-key'` - -### BASIC - -> `readonly` **BASIC**: `"basic"` = `'basic'` - -### BEARER - -> `readonly` **BEARER**: `"bearer"` = `'bearer'` - -### NONE - -> `readonly` **NONE**: `"none"` = `'none'` - -### OAUTH2 - -> `readonly` **OAUTH2**: `"oauth2"` = `'oauth2'` diff --git a/packages/altair-docs/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPE_LIST.md b/packages/altair-docs/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPE_LIST.md deleted file mode 100644 index de6b9c9b36..0000000000 --- a/packages/altair-docs/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPE_LIST.md +++ /dev/null @@ -1,3 +0,0 @@ -# AUTHORIZATION\_TYPE\_LIST - -> `const` **AUTHORIZATION\_TYPE\_LIST**: (`"none"` \| `"basic"` \| `"bearer"` \| `"api-key"` \| `"oauth2"`)[] diff --git a/packages/altair-docs/api/types/state/authorization.interface/variables/DEFAULT_AUTHORIZATION_TYPE.md b/packages/altair-docs/api/types/state/authorization.interface/variables/DEFAULT_AUTHORIZATION_TYPE.md deleted file mode 100644 index 51029782e2..0000000000 --- a/packages/altair-docs/api/types/state/authorization.interface/variables/DEFAULT_AUTHORIZATION_TYPE.md +++ /dev/null @@ -1,3 +0,0 @@ -# DEFAULT\_AUTHORIZATION\_TYPE - -> `const` **DEFAULT\_AUTHORIZATION\_TYPE**: `"none"` = `AUTHORIZATION_TYPES.NONE` diff --git a/packages/altair-docs/api/types/state/collection.interfaces/index.md b/packages/altair-docs/api/types/state/collection.interfaces/index.md deleted file mode 100644 index 95c18a2171..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/index.md +++ /dev/null @@ -1,15 +0,0 @@ -# types/state/collection.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [CollectionState](interfaces/CollectionState.md) | - | -| [ExportCollectionState](interfaces/ExportCollectionState.md) | - | -| [IQuery](interfaces/IQuery.md) | Data structure for exported windows | -| [IQueryCollection](interfaces/IQueryCollection.md) | - | -| [IQueryCollectionTree](interfaces/IQueryCollectionTree.md) | - | -| [IRemoteQuery](interfaces/IRemoteQuery.md) | Data structure for exported windows | -| [IRemoteQueryCollection](interfaces/IRemoteQueryCollection.md) | - | -| [EntityStorageType](type-aliases/EntityStorageType.md) | - | -| [SortByOptions](type-aliases/SortByOptions.md) | - | diff --git a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/CollectionState.md b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/CollectionState.md deleted file mode 100644 index 23df444e55..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/CollectionState.md +++ /dev/null @@ -1,13 +0,0 @@ -# CollectionState - -## Properties - -### activeCollection? - -> `optional` **activeCollection**: [`IQueryCollection`](IQueryCollection.md) - -*** - -### list - -> **list**: [`IQueryCollection`](IQueryCollection.md)[] diff --git a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/ExportCollectionState.md b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/ExportCollectionState.md deleted file mode 100644 index 20c2ee4114..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/ExportCollectionState.md +++ /dev/null @@ -1,140 +0,0 @@ -# ExportCollectionState - -## Extends - -- [`IQueryCollectionTree`](IQueryCollectionTree.md) - -## Properties - -### collections? - -> `optional` **collections**: [`IQueryCollectionTree`](IQueryCollectionTree.md)[] - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`collections`](IQueryCollectionTree.md#collections) - -*** - -### created\_at? - -> `optional` **created\_at**: `number` - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`created_at`](IQueryCollectionTree.md#created-at) - -*** - -### description? - -> `optional` **description**: `string` - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`description`](IQueryCollectionTree.md#description) - -*** - -### id - -> **id**: `string` - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`id`](IQueryCollectionTree.md#id) - -*** - -### parentPath? - -> `optional` **parentPath**: `string` - -path of the collection in the collection tree -e.g. '/123/456' - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`parentPath`](IQueryCollectionTree.md#parentpath) - -*** - -### postRequest? - -> `optional` **postRequest**: [`PostrequestState`](../../postrequest.interfaces/interfaces/PostrequestState.md) - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`postRequest`](IQueryCollectionTree.md#postrequest) - -*** - -### preRequest? - -> `optional` **preRequest**: [`PrerequestState`](../../prerequest.interfaces/interfaces/PrerequestState.md) - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`preRequest`](IQueryCollectionTree.md#prerequest) - -*** - -### queries - -> **queries**: [`IQuery`](IQuery.md)[] - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`queries`](IQueryCollectionTree.md#queries) - -*** - -### storageType? - -> `optional` **storageType**: [`EntityStorageType`](../type-aliases/EntityStorageType.md) - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`storageType`](IQueryCollectionTree.md#storagetype) - -*** - -### title - -> **title**: `string` - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`title`](IQueryCollectionTree.md#title) - -*** - -### type - -> **type**: `"collection"` - -*** - -### updated\_at? - -> `optional` **updated\_at**: `number` - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`updated_at`](IQueryCollectionTree.md#updated-at) - -*** - -### version - -> **version**: `1` - -*** - -### workspaceId? - -> `optional` **workspaceId**: `string` - -#### Inherited from - -[`IQueryCollectionTree`](IQueryCollectionTree.md).[`workspaceId`](IQueryCollectionTree.md#workspaceid) diff --git a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQuery.md b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQuery.md deleted file mode 100644 index 4d72251571..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQuery.md +++ /dev/null @@ -1,209 +0,0 @@ -# IQuery - -Data structure for exported windows - -## Extends - -- [`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md) - -## Extended by - -- [`IRemoteQuery`](IRemoteQuery.md) - -## Properties - -### apiUrl - -> **apiUrl**: `string` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`apiUrl`](../../window.interfaces/interfaces/ExportWindowState.md#apiurl) - -*** - -### collectionId? - -> `optional` **collectionId**: `string` - -ID of the collection this query belongs to - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`collectionId`](../../window.interfaces/interfaces/ExportWindowState.md#collectionid) - -*** - -### created\_at? - -> `optional` **created\_at**: `number` - -*** - -### gqlSchema? - -> `optional` **gqlSchema**: `GraphQLSchema` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`gqlSchema`](../../window.interfaces/interfaces/ExportWindowState.md#gqlschema) - -*** - -### headers - -> **headers**: `object`[] - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`headers`](../../window.interfaces/interfaces/ExportWindowState.md#headers) - -*** - -### id? - -> `optional` **id**: `string` - -*** - -### postRequestScript? - -> `optional` **postRequestScript**: `string` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`postRequestScript`](../../window.interfaces/interfaces/ExportWindowState.md#postrequestscript) - -*** - -### postRequestScriptEnabled? - -> `optional` **postRequestScriptEnabled**: `boolean` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`postRequestScriptEnabled`](../../window.interfaces/interfaces/ExportWindowState.md#postrequestscriptenabled) - -*** - -### preRequestScript? - -> `optional` **preRequestScript**: `string` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`preRequestScript`](../../window.interfaces/interfaces/ExportWindowState.md#prerequestscript) - -*** - -### preRequestScriptEnabled? - -> `optional` **preRequestScriptEnabled**: `boolean` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`preRequestScriptEnabled`](../../window.interfaces/interfaces/ExportWindowState.md#prerequestscriptenabled) - -*** - -### query - -> **query**: `string` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`query`](../../window.interfaces/interfaces/ExportWindowState.md#query) - -*** - -### storageType? - -> `optional` **storageType**: [`EntityStorageType`](../type-aliases/EntityStorageType.md) - -*** - -### subscriptionConnectionParams? - -> `optional` **subscriptionConnectionParams**: `string` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`subscriptionConnectionParams`](../../window.interfaces/interfaces/ExportWindowState.md#subscriptionconnectionparams) - -*** - -### subscriptionProvider? - -> `optional` **subscriptionProvider**: [`SubscriptionProviderIds`](../../../../subscriptions/type-aliases/SubscriptionProviderIds.md) - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`subscriptionProvider`](../../window.interfaces/interfaces/ExportWindowState.md#subscriptionprovider) - -*** - -### subscriptionUrl - -> **subscriptionUrl**: `string` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`subscriptionUrl`](../../window.interfaces/interfaces/ExportWindowState.md#subscriptionurl) - -*** - -### type - -> **type**: `"window"` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`type`](../../window.interfaces/interfaces/ExportWindowState.md#type) - -*** - -### updated\_at? - -> `optional` **updated\_at**: `number` - -*** - -### variables - -> **variables**: `string` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`variables`](../../window.interfaces/interfaces/ExportWindowState.md#variables) - -*** - -### version - -> **version**: `1` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`version`](../../window.interfaces/interfaces/ExportWindowState.md#version) - -*** - -### windowIdInCollection? - -> `optional` **windowIdInCollection**: `string` - -ID for window in collection - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`windowIdInCollection`](../../window.interfaces/interfaces/ExportWindowState.md#windowidincollection) - -*** - -### windowName - -> **windowName**: `string` - -#### Inherited from - -[`ExportWindowState`](../../window.interfaces/interfaces/ExportWindowState.md).[`windowName`](../../window.interfaces/interfaces/ExportWindowState.md#windowname) diff --git a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQueryCollection.md b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQueryCollection.md deleted file mode 100644 index aeeb252366..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQueryCollection.md +++ /dev/null @@ -1,90 +0,0 @@ -# IQueryCollection - -## Extends - -- [`BaseDocument`](../../../shared/interfaces/BaseDocument.md) - -## Extended by - -- [`IQueryCollectionTree`](IQueryCollectionTree.md) - -## Properties - -### created\_at? - -> `optional` **created\_at**: `number` - -#### Inherited from - -[`BaseDocument`](../../../shared/interfaces/BaseDocument.md).[`created_at`](../../../shared/interfaces/BaseDocument.md#created_at) - -*** - -### description? - -> `optional` **description**: `string` - -*** - -### id - -> **id**: `string` - -#### Inherited from - -[`BaseDocument`](../../../shared/interfaces/BaseDocument.md).[`id`](../../../shared/interfaces/BaseDocument.md#id) - -*** - -### parentPath? - -> `optional` **parentPath**: `string` - -path of the collection in the collection tree -e.g. '/123/456' - -*** - -### postRequest? - -> `optional` **postRequest**: [`PostrequestState`](../../postrequest.interfaces/interfaces/PostrequestState.md) - -*** - -### preRequest? - -> `optional` **preRequest**: [`PrerequestState`](../../prerequest.interfaces/interfaces/PrerequestState.md) - -*** - -### queries - -> **queries**: [`IQuery`](IQuery.md)[] - -*** - -### storageType? - -> `optional` **storageType**: [`EntityStorageType`](../type-aliases/EntityStorageType.md) - -*** - -### title - -> **title**: `string` - -*** - -### updated\_at? - -> `optional` **updated\_at**: `number` - -#### Inherited from - -[`BaseDocument`](../../../shared/interfaces/BaseDocument.md).[`updated_at`](../../../shared/interfaces/BaseDocument.md#updated_at) - -*** - -### workspaceId? - -> `optional` **workspaceId**: `string` diff --git a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQueryCollectionTree.md b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQueryCollectionTree.md deleted file mode 100644 index 449f2f5aa2..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQueryCollectionTree.md +++ /dev/null @@ -1,128 +0,0 @@ -# IQueryCollectionTree - -## Extends - -- [`IQueryCollection`](IQueryCollection.md) - -## Extended by - -- [`ExportCollectionState`](ExportCollectionState.md) - -## Properties - -### collections? - -> `optional` **collections**: [`IQueryCollectionTree`](IQueryCollectionTree.md)[] - -*** - -### created\_at? - -> `optional` **created\_at**: `number` - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`created_at`](IQueryCollection.md#created-at) - -*** - -### description? - -> `optional` **description**: `string` - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`description`](IQueryCollection.md#description) - -*** - -### id - -> **id**: `string` - -#### Overrides - -[`IQueryCollection`](IQueryCollection.md).[`id`](IQueryCollection.md#id) - -*** - -### parentPath? - -> `optional` **parentPath**: `string` - -path of the collection in the collection tree -e.g. '/123/456' - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`parentPath`](IQueryCollection.md#parentpath) - -*** - -### postRequest? - -> `optional` **postRequest**: [`PostrequestState`](../../postrequest.interfaces/interfaces/PostrequestState.md) - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`postRequest`](IQueryCollection.md#postrequest) - -*** - -### preRequest? - -> `optional` **preRequest**: [`PrerequestState`](../../prerequest.interfaces/interfaces/PrerequestState.md) - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`preRequest`](IQueryCollection.md#prerequest) - -*** - -### queries - -> **queries**: [`IQuery`](IQuery.md)[] - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`queries`](IQueryCollection.md#queries) - -*** - -### storageType? - -> `optional` **storageType**: [`EntityStorageType`](../type-aliases/EntityStorageType.md) - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`storageType`](IQueryCollection.md#storagetype) - -*** - -### title - -> **title**: `string` - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`title`](IQueryCollection.md#title) - -*** - -### updated\_at? - -> `optional` **updated\_at**: `number` - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`updated_at`](IQueryCollection.md#updated-at) - -*** - -### workspaceId? - -> `optional` **workspaceId**: `string` - -#### Inherited from - -[`IQueryCollection`](IQueryCollection.md).[`workspaceId`](IQueryCollection.md#workspaceid) diff --git a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IRemoteQuery.md b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IRemoteQuery.md deleted file mode 100644 index 4e0a846299..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IRemoteQuery.md +++ /dev/null @@ -1,237 +0,0 @@ -# IRemoteQuery - -Data structure for exported windows - -## Extends - -- [`IQuery`](IQuery.md).[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md) - -## Properties - -### apiUrl - -> **apiUrl**: `string` - -#### Inherited from - -[`IQuery`](IQuery.md).[`apiUrl`](IQuery.md#apiurl) - -*** - -### collectionId - -> **collectionId**: `string` - -ID of the collection this query belongs to - -#### Overrides - -[`IQuery`](IQuery.md).[`collectionId`](IQuery.md#collectionid) - -*** - -### created\_at? - -> `optional` **created\_at**: `number` - -#### Inherited from - -[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md).[`created_at`](../../../shared/interfaces/BaseOwnableDocument.md#created_at) - -*** - -### gqlSchema? - -> `optional` **gqlSchema**: `GraphQLSchema` - -#### Inherited from - -[`IQuery`](IQuery.md).[`gqlSchema`](IQuery.md#gqlschema) - -*** - -### headers - -> **headers**: `object`[] - -#### Inherited from - -[`IQuery`](IQuery.md).[`headers`](IQuery.md#headers) - -*** - -### id - -> **id**: `string` - -#### Overrides - -[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md).[`id`](../../../shared/interfaces/BaseOwnableDocument.md#id) - -*** - -### ownerUid - -> **ownerUid**: `string` - -#### Inherited from - -[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md).[`ownerUid`](../../../shared/interfaces/BaseOwnableDocument.md#owneruid) - -*** - -### postRequestScript? - -> `optional` **postRequestScript**: `string` - -#### Inherited from - -[`IQuery`](IQuery.md).[`postRequestScript`](IQuery.md#postrequestscript) - -*** - -### postRequestScriptEnabled? - -> `optional` **postRequestScriptEnabled**: `boolean` - -#### Inherited from - -[`IQuery`](IQuery.md).[`postRequestScriptEnabled`](IQuery.md#postrequestscriptenabled) - -*** - -### preRequestScript? - -> `optional` **preRequestScript**: `string` - -#### Inherited from - -[`IQuery`](IQuery.md).[`preRequestScript`](IQuery.md#prerequestscript) - -*** - -### preRequestScriptEnabled? - -> `optional` **preRequestScriptEnabled**: `boolean` - -#### Inherited from - -[`IQuery`](IQuery.md).[`preRequestScriptEnabled`](IQuery.md#prerequestscriptenabled) - -*** - -### query - -> **query**: `string` - -#### Inherited from - -[`IQuery`](IQuery.md).[`query`](IQuery.md#query) - -*** - -### storageType? - -> `optional` **storageType**: [`EntityStorageType`](../type-aliases/EntityStorageType.md) - -#### Inherited from - -[`IQuery`](IQuery.md).[`storageType`](IQuery.md#storagetype) - -*** - -### subscriptionConnectionParams? - -> `optional` **subscriptionConnectionParams**: `string` - -#### Inherited from - -[`IQuery`](IQuery.md).[`subscriptionConnectionParams`](IQuery.md#subscriptionconnectionparams) - -*** - -### subscriptionProvider? - -> `optional` **subscriptionProvider**: [`SubscriptionProviderIds`](../../../../subscriptions/type-aliases/SubscriptionProviderIds.md) - -#### Inherited from - -[`IQuery`](IQuery.md).[`subscriptionProvider`](IQuery.md#subscriptionprovider) - -*** - -### subscriptionUrl - -> **subscriptionUrl**: `string` - -#### Inherited from - -[`IQuery`](IQuery.md).[`subscriptionUrl`](IQuery.md#subscriptionurl) - -*** - -### teamUid? - -> `optional` **teamUid**: `string` - -*** - -### type - -> **type**: `"window"` - -#### Inherited from - -[`IQuery`](IQuery.md).[`type`](IQuery.md#type) - -*** - -### updated\_at? - -> `optional` **updated\_at**: `number` - -#### Inherited from - -[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md).[`updated_at`](../../../shared/interfaces/BaseOwnableDocument.md#updated_at) - -*** - -### variables - -> **variables**: `string` - -#### Inherited from - -[`IQuery`](IQuery.md).[`variables`](IQuery.md#variables) - -*** - -### version - -> **version**: `1` - -#### Inherited from - -[`IQuery`](IQuery.md).[`version`](IQuery.md#version) - -*** - -### windowIdInCollection? - -> `optional` **windowIdInCollection**: `string` - -ID for window in collection - -#### Inherited from - -[`IQuery`](IQuery.md).[`windowIdInCollection`](IQuery.md#windowidincollection) - -*** - -### windowName - -> **windowName**: `string` - -#### Inherited from - -[`IQuery`](IQuery.md).[`windowName`](IQuery.md#windowname) diff --git a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IRemoteQueryCollection.md b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IRemoteQueryCollection.md deleted file mode 100644 index 269554ecd5..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IRemoteQueryCollection.md +++ /dev/null @@ -1,117 +0,0 @@ -# IRemoteQueryCollection - -## Extends - -- `Omit`\<[`IQueryCollection`](IQueryCollection.md), `"parentPath"` \| `"queries"`\>.[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md) - -## Properties - -### created\_at? - -> `optional` **created\_at**: `number` - -#### Inherited from - -[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md).[`created_at`](../../../shared/interfaces/BaseOwnableDocument.md#created_at) - -*** - -### description? - -> `optional` **description**: `string` - -#### Inherited from - -`Omit.description` - -*** - -### id - -> **id**: `string` - -#### Inherited from - -[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md).[`id`](../../../shared/interfaces/BaseOwnableDocument.md#id) - -*** - -### ownerUid - -> **ownerUid**: `string` - -#### Inherited from - -[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md).[`ownerUid`](../../../shared/interfaces/BaseOwnableDocument.md#owneruid) - -*** - -### parentCollectionId? - -> `optional` **parentCollectionId**: `string` - -*** - -### postRequest? - -> `optional` **postRequest**: [`PostrequestState`](../../postrequest.interfaces/interfaces/PostrequestState.md) - -#### Inherited from - -`Omit.postRequest` - -*** - -### preRequest? - -> `optional` **preRequest**: [`PrerequestState`](../../prerequest.interfaces/interfaces/PrerequestState.md) - -#### Inherited from - -`Omit.preRequest` - -*** - -### storageType? - -> `optional` **storageType**: [`EntityStorageType`](../type-aliases/EntityStorageType.md) - -#### Inherited from - -`Omit.storageType` - -*** - -### teamUid? - -> `optional` **teamUid**: `string` - -*** - -### title - -> **title**: `string` - -#### Inherited from - -`Omit.title` - -*** - -### updated\_at? - -> `optional` **updated\_at**: `number` - -#### Inherited from - -[`BaseOwnableDocument`](../../../shared/interfaces/BaseOwnableDocument.md).[`updated_at`](../../../shared/interfaces/BaseOwnableDocument.md#updated_at) - -*** - -### workspaceId? - -> `optional` **workspaceId**: `string` - -#### Inherited from - -`Omit.workspaceId` diff --git a/packages/altair-docs/api/types/state/collection.interfaces/type-aliases/EntityStorageType.md b/packages/altair-docs/api/types/state/collection.interfaces/type-aliases/EntityStorageType.md deleted file mode 100644 index 34cfe3b73f..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/type-aliases/EntityStorageType.md +++ /dev/null @@ -1,3 +0,0 @@ -# EntityStorageType - -> **EntityStorageType**: `"local"` \| `"api"` diff --git a/packages/altair-docs/api/types/state/collection.interfaces/type-aliases/SortByOptions.md b/packages/altair-docs/api/types/state/collection.interfaces/type-aliases/SortByOptions.md deleted file mode 100644 index d679833dc8..0000000000 --- a/packages/altair-docs/api/types/state/collection.interfaces/type-aliases/SortByOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# SortByOptions - -> **SortByOptions**: `"a-z"` \| `"z-a"` \| `"newest"` \| `"oldest"` \| `"none"` diff --git a/packages/altair-docs/api/types/state/collections-meta.interfaces/index.md b/packages/altair-docs/api/types/state/collections-meta.interfaces/index.md deleted file mode 100644 index 7d2e05313e..0000000000 --- a/packages/altair-docs/api/types/state/collections-meta.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/collections-meta.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [CollectionsMetaState](interfaces/CollectionsMetaState.md) | - | diff --git a/packages/altair-docs/api/types/state/collections-meta.interfaces/interfaces/CollectionsMetaState.md b/packages/altair-docs/api/types/state/collections-meta.interfaces/interfaces/CollectionsMetaState.md deleted file mode 100644 index 3f66892f0e..0000000000 --- a/packages/altair-docs/api/types/state/collections-meta.interfaces/interfaces/CollectionsMetaState.md +++ /dev/null @@ -1,13 +0,0 @@ -# CollectionsMetaState - -## Properties - -### collectionsSortBy - -> **collectionsSortBy**: [`SortByOptions`](../../collection.interfaces/type-aliases/SortByOptions.md) - -*** - -### queriesSortBy - -> **queriesSortBy**: [`SortByOptions`](../../collection.interfaces/type-aliases/SortByOptions.md) diff --git a/packages/altair-docs/api/types/state/dialog.interfaces/index.md b/packages/altair-docs/api/types/state/dialog.interfaces/index.md deleted file mode 100644 index 20945bb6b4..0000000000 --- a/packages/altair-docs/api/types/state/dialog.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/dialog.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [DialogState](interfaces/DialogState.md) | - | diff --git a/packages/altair-docs/api/types/state/dialog.interfaces/interfaces/DialogState.md b/packages/altair-docs/api/types/state/dialog.interfaces/interfaces/DialogState.md deleted file mode 100644 index 8af32907d1..0000000000 --- a/packages/altair-docs/api/types/state/dialog.interfaces/interfaces/DialogState.md +++ /dev/null @@ -1,37 +0,0 @@ -# DialogState - -## Properties - -### showHeaderDialog - -> **showHeaderDialog**: `boolean` - -*** - -### showHistoryDialog - -> **showHistoryDialog**: `boolean` - -*** - -### showPreRequestDialog - -> **showPreRequestDialog**: `boolean` - -*** - -### showRequestExtensionsDialog - -> **showRequestExtensionsDialog**: `boolean` - -*** - -### showSubscriptionUrlDialog - -> **showSubscriptionUrlDialog**: `boolean` - -*** - -### showVariableDialog - -> **showVariableDialog**: `boolean` diff --git a/packages/altair-docs/api/types/state/docs.interfaces/index.md b/packages/altair-docs/api/types/state/docs.interfaces/index.md deleted file mode 100644 index 2c5226ec4d..0000000000 --- a/packages/altair-docs/api/types/state/docs.interfaces/index.md +++ /dev/null @@ -1,12 +0,0 @@ -# types/state/docs.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [DocsState](interfaces/DocsState.md) | - | -| [FieldDocView](interfaces/FieldDocView.md) | - | -| [RootDocView](interfaces/RootDocView.md) | - | -| [SearchDocView](interfaces/SearchDocView.md) | - | -| [TypeDocView](interfaces/TypeDocView.md) | - | -| [DocView](type-aliases/DocView.md) | - | diff --git a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/DocsState.md b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/DocsState.md deleted file mode 100644 index 8587e29c81..0000000000 --- a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/DocsState.md +++ /dev/null @@ -1,19 +0,0 @@ -# DocsState - -## Properties - -### docView - -> **docView**: [`DocView`](../type-aliases/DocView.md) - -*** - -### isLoading - -> **isLoading**: `boolean` - -*** - -### showDocs - -> **showDocs**: `boolean` diff --git a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/FieldDocView.md b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/FieldDocView.md deleted file mode 100644 index e442c3b4ea..0000000000 --- a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/FieldDocView.md +++ /dev/null @@ -1,19 +0,0 @@ -# FieldDocView - -## Properties - -### name - -> **name**: `string` - -*** - -### parentType - -> **parentType**: `string` - -*** - -### view - -> **view**: `"field"` diff --git a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/RootDocView.md b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/RootDocView.md deleted file mode 100644 index 30c3876612..0000000000 --- a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/RootDocView.md +++ /dev/null @@ -1,7 +0,0 @@ -# RootDocView - -## Properties - -### view - -> **view**: `"root"` diff --git a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/SearchDocView.md b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/SearchDocView.md deleted file mode 100644 index bb47e396f2..0000000000 --- a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/SearchDocView.md +++ /dev/null @@ -1,7 +0,0 @@ -# SearchDocView - -## Properties - -### view - -> **view**: `"search"` diff --git a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/TypeDocView.md b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/TypeDocView.md deleted file mode 100644 index dc2a3e6b56..0000000000 --- a/packages/altair-docs/api/types/state/docs.interfaces/interfaces/TypeDocView.md +++ /dev/null @@ -1,13 +0,0 @@ -# TypeDocView - -## Properties - -### name - -> **name**: `string` - -*** - -### view - -> **view**: `"type"` diff --git a/packages/altair-docs/api/types/state/docs.interfaces/type-aliases/DocView.md b/packages/altair-docs/api/types/state/docs.interfaces/type-aliases/DocView.md deleted file mode 100644 index a0056c445c..0000000000 --- a/packages/altair-docs/api/types/state/docs.interfaces/type-aliases/DocView.md +++ /dev/null @@ -1,3 +0,0 @@ -# DocView - -> **DocView**: [`TypeDocView`](../interfaces/TypeDocView.md) \| [`FieldDocView`](../interfaces/FieldDocView.md) \| [`RootDocView`](../interfaces/RootDocView.md) \| [`SearchDocView`](../interfaces/SearchDocView.md) diff --git a/packages/altair-docs/api/types/state/donation.interfaces/index.md b/packages/altair-docs/api/types/state/donation.interfaces/index.md deleted file mode 100644 index ad919a19ca..0000000000 --- a/packages/altair-docs/api/types/state/donation.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/donation.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [DonationState](interfaces/DonationState.md) | - | diff --git a/packages/altair-docs/api/types/state/donation.interfaces/interfaces/DonationState.md b/packages/altair-docs/api/types/state/donation.interfaces/interfaces/DonationState.md deleted file mode 100644 index b7abe5022f..0000000000 --- a/packages/altair-docs/api/types/state/donation.interfaces/interfaces/DonationState.md +++ /dev/null @@ -1,7 +0,0 @@ -# DonationState - -## Properties - -### showAlert - -> **showAlert**: `boolean` diff --git a/packages/altair-docs/api/types/state/environments.interfaces/index.md b/packages/altair-docs/api/types/state/environments.interfaces/index.md deleted file mode 100644 index fb2939d6e9..0000000000 --- a/packages/altair-docs/api/types/state/environments.interfaces/index.md +++ /dev/null @@ -1,12 +0,0 @@ -# types/state/environments.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [EnvironmentState](interfaces/EnvironmentState.md) | - | -| [EnvironmentsState](interfaces/EnvironmentsState.md) | - | -| [ExportEnvironmentState](interfaces/ExportEnvironmentState.md) | - | -| [IEnvironment](interfaces/IEnvironment.md) | - | -| [IInitialEnvironments](interfaces/IInitialEnvironments.md) | - | -| [InitialEnvironmentState](interfaces/InitialEnvironmentState.md) | - | diff --git a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/EnvironmentState.md b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/EnvironmentState.md deleted file mode 100644 index 8777df76dc..0000000000 --- a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/EnvironmentState.md +++ /dev/null @@ -1,19 +0,0 @@ -# EnvironmentState - -## Properties - -### id? - -> `optional` **id**: `string` - -*** - -### title - -> **title**: `string` - -*** - -### variablesJson - -> **variablesJson**: `string` diff --git a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/EnvironmentsState.md b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/EnvironmentsState.md deleted file mode 100644 index 72aa00a955..0000000000 --- a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/EnvironmentsState.md +++ /dev/null @@ -1,19 +0,0 @@ -# EnvironmentsState - -## Properties - -### activeSubEnvironment? - -> `optional` **activeSubEnvironment**: `string` - -*** - -### base - -> **base**: [`EnvironmentState`](EnvironmentState.md) - -*** - -### subEnvironments - -> **subEnvironments**: [`EnvironmentState`](EnvironmentState.md)[] diff --git a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/ExportEnvironmentState.md b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/ExportEnvironmentState.md deleted file mode 100644 index eeaa27dbe5..0000000000 --- a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/ExportEnvironmentState.md +++ /dev/null @@ -1,47 +0,0 @@ -# ExportEnvironmentState - -## Extends - -- [`InitialEnvironmentState`](InitialEnvironmentState.md) - -## Properties - -### id? - -> `optional` **id**: `string` - -#### Inherited from - -[`InitialEnvironmentState`](InitialEnvironmentState.md).[`id`](InitialEnvironmentState.md#id) - -*** - -### title? - -> `optional` **title**: `string` - -#### Inherited from - -[`InitialEnvironmentState`](InitialEnvironmentState.md).[`title`](InitialEnvironmentState.md#title) - -*** - -### type - -> **type**: `"environment"` - -*** - -### variables? - -> `optional` **variables**: [`IDictionary`](../../../shared/type-aliases/IDictionary.md) - -#### Inherited from - -[`InitialEnvironmentState`](InitialEnvironmentState.md).[`variables`](InitialEnvironmentState.md#variables) - -*** - -### version - -> **version**: `1` diff --git a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/IEnvironment.md b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/IEnvironment.md deleted file mode 100644 index 539115181d..0000000000 --- a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/IEnvironment.md +++ /dev/null @@ -1,17 +0,0 @@ -# IEnvironment - -## Extends - -- [`IDictionary`](../../../shared/type-aliases/IDictionary.md)\<`any`\> - -## Properties - -### accentColor? - -> `optional` **accentColor**: `string` - -*** - -### headers? - -> `optional` **headers**: [`IDictionary`](../../../shared/type-aliases/IDictionary.md)\<`string`\> diff --git a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/IInitialEnvironments.md b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/IInitialEnvironments.md deleted file mode 100644 index 1244cc9c0d..0000000000 --- a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/IInitialEnvironments.md +++ /dev/null @@ -1,13 +0,0 @@ -# IInitialEnvironments - -## Properties - -### base? - -> `optional` **base**: [`InitialEnvironmentState`](InitialEnvironmentState.md) - -*** - -### subEnvironments? - -> `optional` **subEnvironments**: [`InitialEnvironmentState`](InitialEnvironmentState.md)[] diff --git a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/InitialEnvironmentState.md b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/InitialEnvironmentState.md deleted file mode 100644 index bc585d93d1..0000000000 --- a/packages/altair-docs/api/types/state/environments.interfaces/interfaces/InitialEnvironmentState.md +++ /dev/null @@ -1,23 +0,0 @@ -# InitialEnvironmentState - -## Extended by - -- [`ExportEnvironmentState`](ExportEnvironmentState.md) - -## Properties - -### id? - -> `optional` **id**: `string` - -*** - -### title? - -> `optional` **title**: `string` - -*** - -### variables? - -> `optional` **variables**: [`IDictionary`](../../../shared/type-aliases/IDictionary.md) diff --git a/packages/altair-docs/api/types/state/gql-schema.interfaces/index.md b/packages/altair-docs/api/types/state/gql-schema.interfaces/index.md deleted file mode 100644 index 3173c9e83a..0000000000 --- a/packages/altair-docs/api/types/state/gql-schema.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/gql-schema.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [GQLSchemaState](interfaces/GQLSchemaState.md) | - | diff --git a/packages/altair-docs/api/types/state/gql-schema.interfaces/interfaces/GQLSchemaState.md b/packages/altair-docs/api/types/state/gql-schema.interfaces/interfaces/GQLSchemaState.md deleted file mode 100644 index 9d3ab6326a..0000000000 --- a/packages/altair-docs/api/types/state/gql-schema.interfaces/interfaces/GQLSchemaState.md +++ /dev/null @@ -1,31 +0,0 @@ -# GQLSchemaState - -## Properties - -### allowIntrospection - -> **allowIntrospection**: `boolean` - -*** - -### introspection? - -> `optional` **introspection**: `IntrospectionQuery` - -*** - -### lastUpdatedAt? - -> `optional` **lastUpdatedAt**: `number` - -*** - -### schema? - -> `optional` **schema**: `GraphQLSchema` - -*** - -### sdl - -> **sdl**: `string` diff --git a/packages/altair-docs/api/types/state/header.interfaces/index.md b/packages/altair-docs/api/types/state/header.interfaces/index.md deleted file mode 100644 index 626dc3c722..0000000000 --- a/packages/altair-docs/api/types/state/header.interfaces/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# types/state/header.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [Header](interfaces/Header.md) | - | -| [HeaderState](type-aliases/HeaderState.md) | - | diff --git a/packages/altair-docs/api/types/state/header.interfaces/interfaces/Header.md b/packages/altair-docs/api/types/state/header.interfaces/interfaces/Header.md deleted file mode 100644 index 2f21bb8df1..0000000000 --- a/packages/altair-docs/api/types/state/header.interfaces/interfaces/Header.md +++ /dev/null @@ -1,19 +0,0 @@ -# Header - -## Properties - -### enabled? - -> `optional` **enabled**: `boolean` - -*** - -### key - -> **key**: `string` - -*** - -### value - -> **value**: `string` diff --git a/packages/altair-docs/api/types/state/header.interfaces/type-aliases/HeaderState.md b/packages/altair-docs/api/types/state/header.interfaces/type-aliases/HeaderState.md deleted file mode 100644 index 38d9dece54..0000000000 --- a/packages/altair-docs/api/types/state/header.interfaces/type-aliases/HeaderState.md +++ /dev/null @@ -1,3 +0,0 @@ -# HeaderState - -> **HeaderState**: [`Header`](../interfaces/Header.md)[] diff --git a/packages/altair-docs/api/types/state/history.interfaces/index.md b/packages/altair-docs/api/types/state/history.interfaces/index.md deleted file mode 100644 index 0c1a539c21..0000000000 --- a/packages/altair-docs/api/types/state/history.interfaces/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# types/state/history.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [History](interfaces/History.md) | - | -| [HistoryState](interfaces/HistoryState.md) | - | diff --git a/packages/altair-docs/api/types/state/history.interfaces/interfaces/History.md b/packages/altair-docs/api/types/state/history.interfaces/interfaces/History.md deleted file mode 100644 index cdb03d51bd..0000000000 --- a/packages/altair-docs/api/types/state/history.interfaces/interfaces/History.md +++ /dev/null @@ -1,7 +0,0 @@ -# History - -## Properties - -### query - -> **query**: `string` diff --git a/packages/altair-docs/api/types/state/history.interfaces/interfaces/HistoryState.md b/packages/altair-docs/api/types/state/history.interfaces/interfaces/HistoryState.md deleted file mode 100644 index 3b310005b1..0000000000 --- a/packages/altair-docs/api/types/state/history.interfaces/interfaces/HistoryState.md +++ /dev/null @@ -1,7 +0,0 @@ -# HistoryState - -## Properties - -### list - -> **list**: [`History`](History.md)[] diff --git a/packages/altair-docs/api/types/state/layout.interfaces/index.md b/packages/altair-docs/api/types/state/layout.interfaces/index.md deleted file mode 100644 index b076a39d22..0000000000 --- a/packages/altair-docs/api/types/state/layout.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/layout.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [LayoutState](interfaces/LayoutState.md) | - | diff --git a/packages/altair-docs/api/types/state/layout.interfaces/interfaces/LayoutState.md b/packages/altair-docs/api/types/state/layout.interfaces/interfaces/LayoutState.md deleted file mode 100644 index b4dbee86be..0000000000 --- a/packages/altair-docs/api/types/state/layout.interfaces/interfaces/LayoutState.md +++ /dev/null @@ -1,31 +0,0 @@ -# LayoutState - -## Properties - -### collectionId? - -> `optional` **collectionId**: `string` - -*** - -### hasDynamicTitle? - -> `optional` **hasDynamicTitle**: `boolean` - -*** - -### isLoading - -> **isLoading**: `boolean` - -*** - -### title - -> **title**: `string` - -*** - -### windowIdInCollection? - -> `optional` **windowIdInCollection**: `string` diff --git a/packages/altair-docs/api/types/state/local.interfaces/index.md b/packages/altair-docs/api/types/state/local.interfaces/index.md deleted file mode 100644 index 50677b9d06..0000000000 --- a/packages/altair-docs/api/types/state/local.interfaces/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# types/state/local.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [LocalState](interfaces/LocalState.md) | - | -| [V1PluginStateEntry](interfaces/V1PluginStateEntry.md) | - | -| [V3PluginStateEntry](interfaces/V3PluginStateEntry.md) | - | diff --git a/packages/altair-docs/api/types/state/local.interfaces/interfaces/LocalState.md b/packages/altair-docs/api/types/state/local.interfaces/interfaces/LocalState.md deleted file mode 100644 index 7b34ccd581..0000000000 --- a/packages/altair-docs/api/types/state/local.interfaces/interfaces/LocalState.md +++ /dev/null @@ -1,25 +0,0 @@ -# LocalState - -## Properties - -### closedWindows - -> **closedWindows**: [`PerWindowState`](../../per-window.interfaces/interfaces/PerWindowState.md)[] - -*** - -### installedPlugins - -> **installedPlugins**: [`IDictionary`](../../../shared/type-aliases/IDictionary.md)\<[`V1PluginStateEntry`](V1PluginStateEntry.md) \| [`V3PluginStateEntry`](V3PluginStateEntry.md)\> - -*** - -### panels - -> **panels**: [`AltairPanel`](../../../../plugin/panel/classes/AltairPanel.md)[] - -*** - -### uiActions - -> **uiActions**: [`AltairUiAction`](../../../../plugin/ui-action/classes/AltairUiAction.md)[] diff --git a/packages/altair-docs/api/types/state/local.interfaces/interfaces/V1PluginStateEntry.md b/packages/altair-docs/api/types/state/local.interfaces/interfaces/V1PluginStateEntry.md deleted file mode 100644 index 1bb9e9a9f4..0000000000 --- a/packages/altair-docs/api/types/state/local.interfaces/interfaces/V1PluginStateEntry.md +++ /dev/null @@ -1,37 +0,0 @@ -# V1PluginStateEntry - -## Properties - -### context - -> **context**: [`PluginContext`](../../../../plugin/context/context.interface/interfaces/PluginContext.md) - -*** - -### instance? - -> `optional` **instance**: [`PluginBase`](../../../../plugin/base/classes/PluginBase.md) - -*** - -### isActive? - -> `optional` **isActive**: `boolean` - -*** - -### manifest\_version - -> **manifest\_version**: `1` \| `2` - -*** - -### name - -> **name**: `string` - -*** - -### plugin - -> **plugin**: [`AltairV1Plugin`](../../../../plugin/plugin.interfaces/interfaces/AltairV1Plugin.md) diff --git a/packages/altair-docs/api/types/state/local.interfaces/interfaces/V3PluginStateEntry.md b/packages/altair-docs/api/types/state/local.interfaces/interfaces/V3PluginStateEntry.md deleted file mode 100644 index 9f5ad78e46..0000000000 --- a/packages/altair-docs/api/types/state/local.interfaces/interfaces/V3PluginStateEntry.md +++ /dev/null @@ -1,37 +0,0 @@ -# V3PluginStateEntry - -## Properties - -### context - -> **context**: [`PluginV3Context`](../../../../plugin/v3/context/interfaces/PluginV3Context.md) - -*** - -### engine - -> **engine**: [`PluginParentEngine`](../../../../plugin/v3/parent-engine/classes/PluginParentEngine.md) - -*** - -### isActive? - -> `optional` **isActive**: `boolean` - -*** - -### manifest - -> **manifest**: [`PluginV3Manifest`](../../../../plugin/v3/manifest/interfaces/PluginV3Manifest.md) - -*** - -### manifest\_version - -> **manifest\_version**: `3` - -*** - -### name - -> **name**: `string` diff --git a/packages/altair-docs/api/types/state/per-window.interfaces/index.md b/packages/altair-docs/api/types/state/per-window.interfaces/index.md deleted file mode 100644 index ff6bccf25b..0000000000 --- a/packages/altair-docs/api/types/state/per-window.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/per-window.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [PerWindowState](interfaces/PerWindowState.md) | - | diff --git a/packages/altair-docs/api/types/state/per-window.interfaces/interfaces/PerWindowState.md b/packages/altair-docs/api/types/state/per-window.interfaces/interfaces/PerWindowState.md deleted file mode 100644 index 7dab178569..0000000000 --- a/packages/altair-docs/api/types/state/per-window.interfaces/interfaces/PerWindowState.md +++ /dev/null @@ -1,79 +0,0 @@ -# PerWindowState - -## Properties - -### authorization - -> **authorization**: [`AuthorizationState`](../../authorization.interface/interfaces/AuthorizationState.md) - -*** - -### dialogs - -> **dialogs**: [`DialogState`](../../dialog.interfaces/interfaces/DialogState.md) - -*** - -### docs - -> **docs**: [`DocsState`](../../docs.interfaces/interfaces/DocsState.md) - -*** - -### headers - -> **headers**: [`HeaderState`](../../header.interfaces/type-aliases/HeaderState.md) - -*** - -### history - -> **history**: [`HistoryState`](../../history.interfaces/interfaces/HistoryState.md) - -*** - -### layout - -> **layout**: [`LayoutState`](../../layout.interfaces/interfaces/LayoutState.md) - -*** - -### postRequest - -> **postRequest**: [`PostrequestState`](../../postrequest.interfaces/interfaces/PostrequestState.md) - -*** - -### preRequest - -> **preRequest**: [`PrerequestState`](../../prerequest.interfaces/interfaces/PrerequestState.md) - -*** - -### query - -> **query**: [`QueryState`](../../query.interfaces/interfaces/QueryState.md) - -*** - -### schema - -> **schema**: [`GQLSchemaState`](../../gql-schema.interfaces/interfaces/GQLSchemaState.md) - -*** - -### stream - -> **stream**: [`StreamState`](../../stream.interfaces/interfaces/StreamState.md) - -*** - -### variables - -> **variables**: [`VariableState`](../../variable.interfaces/interfaces/VariableState.md) - -*** - -### windowId - -> **windowId**: `string` diff --git a/packages/altair-docs/api/types/state/postrequest.interfaces/index.md b/packages/altair-docs/api/types/state/postrequest.interfaces/index.md deleted file mode 100644 index c147a15899..0000000000 --- a/packages/altair-docs/api/types/state/postrequest.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/postrequest.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [PostrequestState](interfaces/PostrequestState.md) | - | diff --git a/packages/altair-docs/api/types/state/postrequest.interfaces/interfaces/PostrequestState.md b/packages/altair-docs/api/types/state/postrequest.interfaces/interfaces/PostrequestState.md deleted file mode 100644 index dd8e164967..0000000000 --- a/packages/altair-docs/api/types/state/postrequest.interfaces/interfaces/PostrequestState.md +++ /dev/null @@ -1,13 +0,0 @@ -# PostrequestState - -## Properties - -### enabled - -> **enabled**: `boolean` - -*** - -### script - -> **script**: `string` diff --git a/packages/altair-docs/api/types/state/prerequest.interfaces/index.md b/packages/altair-docs/api/types/state/prerequest.interfaces/index.md deleted file mode 100644 index 87309f7aeb..0000000000 --- a/packages/altair-docs/api/types/state/prerequest.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/prerequest.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [PrerequestState](interfaces/PrerequestState.md) | - | diff --git a/packages/altair-docs/api/types/state/prerequest.interfaces/interfaces/PrerequestState.md b/packages/altair-docs/api/types/state/prerequest.interfaces/interfaces/PrerequestState.md deleted file mode 100644 index 88b3f2f878..0000000000 --- a/packages/altair-docs/api/types/state/prerequest.interfaces/interfaces/PrerequestState.md +++ /dev/null @@ -1,13 +0,0 @@ -# PrerequestState - -## Properties - -### enabled - -> **enabled**: `boolean` - -*** - -### script - -> **script**: `string` diff --git a/packages/altair-docs/api/types/state/query.interfaces/index.md b/packages/altair-docs/api/types/state/query.interfaces/index.md deleted file mode 100644 index ac4db1cece..0000000000 --- a/packages/altair-docs/api/types/state/query.interfaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# types/state/query.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [LogLine](interfaces/LogLine.md) | - | -| [QueryEditorState](interfaces/QueryEditorState.md) | - | -| [QueryState](interfaces/QueryState.md) | - | -| [SubscriptionResponse](interfaces/SubscriptionResponse.md) | - | -| [HttpVerb](type-aliases/HttpVerb.md) | - | -| [SelectedOperation](type-aliases/SelectedOperation.md) | - | -| [HTTP\_VERBS](variables/HTTP_VERBS.md) | - | diff --git a/packages/altair-docs/api/types/state/query.interfaces/interfaces/LogLine.md b/packages/altair-docs/api/types/state/query.interfaces/interfaces/LogLine.md deleted file mode 100644 index 5c04210a8e..0000000000 --- a/packages/altair-docs/api/types/state/query.interfaces/interfaces/LogLine.md +++ /dev/null @@ -1,19 +0,0 @@ -# LogLine - -## Properties - -### source - -> **source**: `string` - -*** - -### text - -> **text**: `string` - -*** - -### time - -> **time**: `number` diff --git a/packages/altair-docs/api/types/state/query.interfaces/interfaces/QueryEditorState.md b/packages/altair-docs/api/types/state/query.interfaces/interfaces/QueryEditorState.md deleted file mode 100644 index c0eaecb2b3..0000000000 --- a/packages/altair-docs/api/types/state/query.interfaces/interfaces/QueryEditorState.md +++ /dev/null @@ -1,13 +0,0 @@ -# QueryEditorState - -## Properties - -### cursorIndex? - -> `optional` **cursorIndex**: `number` - -*** - -### isFocused - -> **isFocused**: `boolean` diff --git a/packages/altair-docs/api/types/state/query.interfaces/interfaces/QueryState.md b/packages/altair-docs/api/types/state/query.interfaces/interfaces/QueryState.md deleted file mode 100644 index f8c295f315..0000000000 --- a/packages/altair-docs/api/types/state/query.interfaces/interfaces/QueryState.md +++ /dev/null @@ -1,169 +0,0 @@ -# QueryState - -## Properties - -### autoscrollSubscriptionResponse - -> **autoscrollSubscriptionResponse**: `boolean` - -*** - -### editorAlertMessage - -> **editorAlertMessage**: `string` - -*** - -### editorAlertSuccess - -> **editorAlertSuccess**: `boolean` - -*** - -### httpVerb - -> **httpVerb**: `"POST"` \| `"GET"` \| `"PUT"` \| `"DELETE"` - -*** - -### isSubscribed - -> **isSubscribed**: `boolean` - -*** - -### operations? - -> `optional` **operations**: `OperationDefinitionNode`[] - -*** - -### query? - -> `optional` **query**: `string` - -*** - -### queryEditorState - -> **queryEditorState**: [`QueryEditorState`](QueryEditorState.md) - -*** - -### requestEndTime - -> **requestEndTime**: `number` - -*** - -### requestExtensions? - -> `optional` **requestExtensions**: `string` - -*** - -### requestScriptLogs? - -> `optional` **requestScriptLogs**: [`LogLine`](LogLine.md)[] - -*** - -### requestStartTime - -> **requestStartTime**: `number` - -*** - -### response? - -> `optional` **response**: `string` - -*** - -### responseHeaders? - -> `optional` **responseHeaders**: [`IDictionary`](../../../shared/type-aliases/IDictionary.md) - -*** - -### responseStatus - -> **responseStatus**: `number` - -*** - -### responseStatusText - -> **responseStatusText**: `string` - -*** - -### responseTime - -> **responseTime**: `number` - -*** - -### selectedOperation? - -> `optional` **selectedOperation**: [`SelectedOperation`](../type-aliases/SelectedOperation.md) - -*** - -### showEditorAlert - -> **showEditorAlert**: `boolean` - -*** - -### showUrlAlert - -> **showUrlAlert**: `boolean` - -*** - -### subscriptionClient? - -> `optional` **subscriptionClient**: [`SubscriptionProvider`](../../../../subscriptions/subscription-provider/classes/SubscriptionProvider.md) - -*** - -### subscriptionConnectionParams - -> **subscriptionConnectionParams**: `string` - -*** - -### subscriptionProviderId? - -> `optional` **subscriptionProviderId**: `string` - -*** - -### subscriptionResponseList - -> **subscriptionResponseList**: [`SubscriptionResponse`](SubscriptionResponse.md)[] - -*** - -### subscriptionUrl - -> **subscriptionUrl**: `string` - -*** - -### url - -> **url**: `string` - -*** - -### urlAlertMessage - -> **urlAlertMessage**: `string` - -*** - -### urlAlertSuccess - -> **urlAlertSuccess**: `boolean` diff --git a/packages/altair-docs/api/types/state/query.interfaces/interfaces/SubscriptionResponse.md b/packages/altair-docs/api/types/state/query.interfaces/interfaces/SubscriptionResponse.md deleted file mode 100644 index 675b328782..0000000000 --- a/packages/altair-docs/api/types/state/query.interfaces/interfaces/SubscriptionResponse.md +++ /dev/null @@ -1,19 +0,0 @@ -# SubscriptionResponse - -## Properties - -### response - -> **response**: `string` - -*** - -### responseObj - -> **responseObj**: `unknown` - -*** - -### responseTime - -> **responseTime**: `number` diff --git a/packages/altair-docs/api/types/state/query.interfaces/type-aliases/HttpVerb.md b/packages/altair-docs/api/types/state/query.interfaces/type-aliases/HttpVerb.md deleted file mode 100644 index 65be3c1738..0000000000 --- a/packages/altair-docs/api/types/state/query.interfaces/type-aliases/HttpVerb.md +++ /dev/null @@ -1,3 +0,0 @@ -# HttpVerb - -> **HttpVerb**: *typeof* [`HTTP_VERBS`](../variables/HTTP_VERBS.md)\[`number`\] diff --git a/packages/altair-docs/api/types/state/query.interfaces/type-aliases/SelectedOperation.md b/packages/altair-docs/api/types/state/query.interfaces/type-aliases/SelectedOperation.md deleted file mode 100644 index 7447dee45c..0000000000 --- a/packages/altair-docs/api/types/state/query.interfaces/type-aliases/SelectedOperation.md +++ /dev/null @@ -1,3 +0,0 @@ -# SelectedOperation - -> **SelectedOperation**: `string` \| `null` diff --git a/packages/altair-docs/api/types/state/query.interfaces/variables/HTTP_VERBS.md b/packages/altair-docs/api/types/state/query.interfaces/variables/HTTP_VERBS.md deleted file mode 100644 index a9e3b008cd..0000000000 --- a/packages/altair-docs/api/types/state/query.interfaces/variables/HTTP_VERBS.md +++ /dev/null @@ -1,3 +0,0 @@ -# HTTP\_VERBS - -> `const` **HTTP\_VERBS**: readonly [`"POST"`, `"GET"`, `"PUT"`, `"DELETE"`] diff --git a/packages/altair-docs/api/types/state/settings.interfaces/index.md b/packages/altair-docs/api/types/state/settings.interfaces/index.md deleted file mode 100644 index e1a7650ab7..0000000000 --- a/packages/altair-docs/api/types/state/settings.interfaces/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# types/state/settings.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [SettingsState](interfaces/SettingsState.md) | - | -| [SettingsLanguage](type-aliases/SettingsLanguage.md) | - | diff --git a/packages/altair-docs/api/types/state/settings.interfaces/interfaces/SettingsState.md b/packages/altair-docs/api/types/state/settings.interfaces/interfaces/SettingsState.md deleted file mode 100644 index 3149d32c8e..0000000000 --- a/packages/altair-docs/api/types/state/settings.interfaces/interfaces/SettingsState.md +++ /dev/null @@ -1,215 +0,0 @@ -# SettingsState - -## Properties - -### addQueryDepthLimit - -> **addQueryDepthLimit**: `number` - -'Add query' functionality depth - -*** - -### alert.disableUpdateNotification? - -> `optional` **alert.disableUpdateNotification**: `boolean` - -Disable update notification - -*** - -### alert.disableWarnings? - -> `optional` **alert.disableWarnings**: `boolean` - -Disable warning alerts - -*** - -### beta.disable.newEditor? - -> `optional` **beta.disable.newEditor**: `boolean` - -Disable new editor beta - -*** - -### beta.disable.newScript? - -> `optional` **beta.disable.newScript**: `boolean` - -Disable new script beta - -*** - -### disableLineNumbers? - -> `optional` **disableLineNumbers**: `boolean` - -Disable line numbers - -*** - -### disablePushNotification? - -> `optional` **disablePushNotification**: `boolean` - -Disable push notifications - -*** - -### editor.shortcuts? - -> `optional` **editor.shortcuts**: `Record`\<`string`, `string`\> - -Contains shortcut to action mapping - -*** - -### enableExperimental? - -> `optional` **enableExperimental**: `boolean` - -Enable experimental features. -Note: Might be unstable - -*** - -### enableTablistScrollbar? - -> `optional` **enableTablistScrollbar**: `boolean` - -Enable the scrollbar in the tab list - -*** - -### historyDepth? - -> `optional` **historyDepth**: `number` - -Number of items allowed in history pane - -*** - -### language - -> **language**: `"en-US"` \| `"fr-FR"` \| `"es-ES"` \| `"cs-CZ"` \| `"de-DE"` \| `"pt-BR"` \| `"ru-RU"` \| `"uk-UA"` \| `"zh-CN"` \| `"ja-JP"` \| `"sr-SP"` \| `"it-IT"` \| `"pl-PL"` \| `"ko-KR"` \| `"ro-RO"` \| `"vi-VN"` - -Set language - -*** - -### plugin.list? - -> `optional` **plugin.list**: `string`[] - -Enabled plugins - -*** - -### request.withCredentials? - -> `optional` **request.withCredentials**: `boolean` - -Send requests with credentials (cookies) - -*** - -### response.hideExtensions? - -> `optional` **response.hideExtensions**: `boolean` - -Hides extensions object - -*** - -### schema.reloadOnStart? - -> `optional` **schema.reloadOnStart**: `boolean` - -Reload schema on app start - -*** - -### script.allowedCookies? - -> `optional` **script.allowedCookies**: `string`[] - -List of cookies to be accessible in the pre-request script - -#### Example - -```ts -['cookie1', 'cookie2'] -``` - -#### Default - -```ts -[] -``` - -*** - -### tabSize - -> **tabSize**: `number` - -Editor tab size - -*** - -### theme - -> **theme**: `string` - -Theme - -*** - -### theme.dark? - -> `optional` **theme.dark**: `string` - -Theme for dark mode - -*** - -### theme.editorFontFamily? - -> `optional` **theme.editorFontFamily**: `string` - -Editor Font Family - -*** - -### theme.editorFontSize? - -> `optional` **theme.editorFontSize**: `number` - -Editor Font Size - -*** - -### theme.fontsize? - -> `optional` **theme.fontsize**: `number` - -Base Font Size -(Default - 24) - -*** - -### themeConfig? - -> `optional` **themeConfig**: `RecursivePartial`\<`object` & `object`\> - -Theme config object - -*** - -### themeConfig.dark? - -> `optional` **themeConfig.dark**: `RecursivePartial`\<`object` & `object`\> - -Theme config object for dark mode diff --git a/packages/altair-docs/api/types/state/settings.interfaces/type-aliases/SettingsLanguage.md b/packages/altair-docs/api/types/state/settings.interfaces/type-aliases/SettingsLanguage.md deleted file mode 100644 index a7e154a095..0000000000 --- a/packages/altair-docs/api/types/state/settings.interfaces/type-aliases/SettingsLanguage.md +++ /dev/null @@ -1,3 +0,0 @@ -# SettingsLanguage - -> **SettingsLanguage**: keyof *typeof* [`languages`](../../../../config/classes/AltairConfig.md#languages) diff --git a/packages/altair-docs/api/types/state/state.interfaces/index.md b/packages/altair-docs/api/types/state/state.interfaces/index.md deleted file mode 100644 index 8103a086da..0000000000 --- a/packages/altair-docs/api/types/state/state.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/state.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [RootState](interfaces/RootState.md) | - | diff --git a/packages/altair-docs/api/types/state/state.interfaces/interfaces/RootState.md b/packages/altair-docs/api/types/state/state.interfaces/interfaces/RootState.md deleted file mode 100644 index 80ec369e92..0000000000 --- a/packages/altair-docs/api/types/state/state.interfaces/interfaces/RootState.md +++ /dev/null @@ -1,61 +0,0 @@ -# RootState - -## Properties - -### account - -> **account**: [`AccountState`](../../account.interfaces/interfaces/AccountState.md) - -*** - -### collection - -> **collection**: [`CollectionState`](../../collection.interfaces/interfaces/CollectionState.md) - -*** - -### collectionsMeta - -> **collectionsMeta**: [`CollectionsMetaState`](../../collections-meta.interfaces/interfaces/CollectionsMetaState.md) - -*** - -### donation - -> **donation**: [`DonationState`](../../donation.interfaces/interfaces/DonationState.md) - -*** - -### environments - -> **environments**: [`EnvironmentsState`](../../environments.interfaces/interfaces/EnvironmentsState.md) - -*** - -### local - -> **local**: [`LocalState`](../../local.interfaces/interfaces/LocalState.md) - -*** - -### settings - -> **settings**: [`SettingsState`](../../settings.interfaces/interfaces/SettingsState.md) - -*** - -### windows - -> **windows**: [`WindowState`](../../window.interfaces/interfaces/WindowState.md) - -*** - -### windowsMeta - -> **windowsMeta**: [`WindowsMetaState`](../../windows-meta.interfaces/interfaces/WindowsMetaState.md) - -*** - -### workspaces - -> **workspaces**: [`WorkspacesState`](../../workspace.interface/interfaces/WorkspacesState.md) diff --git a/packages/altair-docs/api/types/state/stream.interfaces/index.md b/packages/altair-docs/api/types/state/stream.interfaces/index.md deleted file mode 100644 index 78df8eaaa2..0000000000 --- a/packages/altair-docs/api/types/state/stream.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/stream.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [StreamState](interfaces/StreamState.md) | - | diff --git a/packages/altair-docs/api/types/state/stream.interfaces/interfaces/StreamState.md b/packages/altair-docs/api/types/state/stream.interfaces/interfaces/StreamState.md deleted file mode 100644 index 611f02156a..0000000000 --- a/packages/altair-docs/api/types/state/stream.interfaces/interfaces/StreamState.md +++ /dev/null @@ -1,31 +0,0 @@ -# StreamState - -## Properties - -### client? - -> `optional` **client**: `EventSource` - -*** - -### failed? - -> `optional` **failed**: `Event` - -*** - -### isConnected - -> **isConnected**: `boolean` - -*** - -### type - -> **type**: `""` \| `"event"` - -*** - -### url - -> **url**: `string` diff --git a/packages/altair-docs/api/types/state/variable.interfaces/index.md b/packages/altair-docs/api/types/state/variable.interfaces/index.md deleted file mode 100644 index 86bde34672..0000000000 --- a/packages/altair-docs/api/types/state/variable.interfaces/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# types/state/variable.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [FileVariable](interfaces/FileVariable.md) | - | -| [VariableState](interfaces/VariableState.md) | - | diff --git a/packages/altair-docs/api/types/state/variable.interfaces/interfaces/FileVariable.md b/packages/altair-docs/api/types/state/variable.interfaces/interfaces/FileVariable.md deleted file mode 100644 index 56bdb17c2d..0000000000 --- a/packages/altair-docs/api/types/state/variable.interfaces/interfaces/FileVariable.md +++ /dev/null @@ -1,25 +0,0 @@ -# FileVariable - -## Properties - -### data? - -> `optional` **data**: `File` \| `File`[] - -*** - -### id? - -> `optional` **id**: `string` - -*** - -### isMultiple? - -> `optional` **isMultiple**: `boolean` - -*** - -### name - -> **name**: `string` diff --git a/packages/altair-docs/api/types/state/variable.interfaces/interfaces/VariableState.md b/packages/altair-docs/api/types/state/variable.interfaces/interfaces/VariableState.md deleted file mode 100644 index 2ab8341c3c..0000000000 --- a/packages/altair-docs/api/types/state/variable.interfaces/interfaces/VariableState.md +++ /dev/null @@ -1,13 +0,0 @@ -# VariableState - -## Properties - -### files - -> **files**: [`FileVariable`](FileVariable.md)[] - -*** - -### variables - -> **variables**: `string` diff --git a/packages/altair-docs/api/types/state/window.interfaces/index.md b/packages/altair-docs/api/types/state/window.interfaces/index.md deleted file mode 100644 index cccad8f169..0000000000 --- a/packages/altair-docs/api/types/state/window.interfaces/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# types/state/window.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [ExportWindowState](interfaces/ExportWindowState.md) | Data structure for exported windows | -| [WindowState](interfaces/WindowState.md) | - | diff --git a/packages/altair-docs/api/types/state/window.interfaces/interfaces/ExportWindowState.md b/packages/altair-docs/api/types/state/window.interfaces/interfaces/ExportWindowState.md deleted file mode 100644 index 220df734ea..0000000000 --- a/packages/altair-docs/api/types/state/window.interfaces/interfaces/ExportWindowState.md +++ /dev/null @@ -1,114 +0,0 @@ -# ExportWindowState - -Data structure for exported windows - -## Extended by - -- [`PluginWindowState`](../../../../plugin/context/context.interface/interfaces/PluginWindowState.md) -- [`IQuery`](../../collection.interfaces/interfaces/IQuery.md) - -## Properties - -### apiUrl - -> **apiUrl**: `string` - -*** - -### collectionId? - -> `optional` **collectionId**: `string` - -ID of the collection this query belongs to - -*** - -### gqlSchema? - -> `optional` **gqlSchema**: `GraphQLSchema` - -*** - -### headers - -> **headers**: `object`[] - -*** - -### postRequestScript? - -> `optional` **postRequestScript**: `string` - -*** - -### postRequestScriptEnabled? - -> `optional` **postRequestScriptEnabled**: `boolean` - -*** - -### preRequestScript? - -> `optional` **preRequestScript**: `string` - -*** - -### preRequestScriptEnabled? - -> `optional` **preRequestScriptEnabled**: `boolean` - -*** - -### query - -> **query**: `string` - -*** - -### subscriptionConnectionParams? - -> `optional` **subscriptionConnectionParams**: `string` - -*** - -### subscriptionProvider? - -> `optional` **subscriptionProvider**: [`SubscriptionProviderIds`](../../../../subscriptions/type-aliases/SubscriptionProviderIds.md) - -*** - -### subscriptionUrl - -> **subscriptionUrl**: `string` - -*** - -### type - -> **type**: `"window"` - -*** - -### variables - -> **variables**: `string` - -*** - -### version - -> **version**: `1` - -*** - -### windowIdInCollection? - -> `optional` **windowIdInCollection**: `string` - -ID for window in collection - -*** - -### windowName - -> **windowName**: `string` diff --git a/packages/altair-docs/api/types/state/window.interfaces/interfaces/WindowState.md b/packages/altair-docs/api/types/state/window.interfaces/interfaces/WindowState.md deleted file mode 100644 index bf9614a72f..0000000000 --- a/packages/altair-docs/api/types/state/window.interfaces/interfaces/WindowState.md +++ /dev/null @@ -1,5 +0,0 @@ -# WindowState - -## Indexable - - \[`id`: `string`\]: [`PerWindowState`](../../per-window.interfaces/interfaces/PerWindowState.md) diff --git a/packages/altair-docs/api/types/state/windows-meta.interfaces/index.md b/packages/altair-docs/api/types/state/windows-meta.interfaces/index.md deleted file mode 100644 index 673616a7c1..0000000000 --- a/packages/altair-docs/api/types/state/windows-meta.interfaces/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# types/state/windows-meta.interfaces - -## Index - -| Member | Description | -| :------ | :------ | -| [WindowsMetaState](interfaces/WindowsMetaState.md) | - | diff --git a/packages/altair-docs/api/types/state/windows-meta.interfaces/interfaces/WindowsMetaState.md b/packages/altair-docs/api/types/state/windows-meta.interfaces/interfaces/WindowsMetaState.md deleted file mode 100644 index ad5fe70492..0000000000 --- a/packages/altair-docs/api/types/state/windows-meta.interfaces/interfaces/WindowsMetaState.md +++ /dev/null @@ -1,67 +0,0 @@ -# WindowsMetaState - -## Properties - -### activeWindowId - -> **activeWindowId**: `string` - -*** - -### showAccountDialog - -> **showAccountDialog**: `boolean` - -*** - -### showAddToCollectionDialog - -> **showAddToCollectionDialog**: `boolean` - -*** - -### showEditCollectionDialog - -> **showEditCollectionDialog**: `boolean` - -*** - -### showEnvironmentManager - -> **showEnvironmentManager**: `boolean` - -*** - -### showImportCurlDialog - -> **showImportCurlDialog**: `boolean` - -*** - -### showPluginManager - -> **showPluginManager**: `boolean` - -*** - -### showSettingsDialog - -> **showSettingsDialog**: `boolean` - -*** - -### showTeamsDialog - -> **showTeamsDialog**: `boolean` - -*** - -### showUpgradeDialog - -> **showUpgradeDialog**: `boolean` - -*** - -### windowIds - -> **windowIds**: `string`[] diff --git a/packages/altair-docs/api/types/state/workspace.interface/classes/WorkspaceId.md b/packages/altair-docs/api/types/state/workspace.interface/classes/WorkspaceId.md deleted file mode 100644 index 94b228c597..0000000000 --- a/packages/altair-docs/api/types/state/workspace.interface/classes/WorkspaceId.md +++ /dev/null @@ -1,65 +0,0 @@ -# WorkspaceId - -## Extends - -- [`ValueObject`](../../../../utils/value-object/classes/ValueObject.md)\<`string`\> - -## Constructors - -### new WorkspaceId() - -> **new WorkspaceId**(`props`: `string`): [`WorkspaceId`](WorkspaceId.md) - -#### Parameters - -• **props**: `string`= `WORKSPACES.LOCAL` - -#### Returns - -[`WorkspaceId`](WorkspaceId.md) - -#### Overrides - -[`ValueObject`](../../../../utils/value-object/classes/ValueObject.md).[`constructor`](../../../../utils/value-object/classes/ValueObject.md#constructors) - -## Properties - -### props - -> `readonly` **props**: `string` - -#### Inherited from - -[`ValueObject`](../../../../utils/value-object/classes/ValueObject.md).[`props`](../../../../utils/value-object/classes/ValueObject.md#props) - -## Methods - -### equals() - -> **equals**(`vo`?: [`ValueObject`](../../../../utils/value-object/classes/ValueObject.md)\<`string`\>): `boolean` - -#### Parameters - -• **vo?**: [`ValueObject`](../../../../utils/value-object/classes/ValueObject.md)\<`string`\> - -#### Returns - -`boolean` - -#### Inherited from - -[`ValueObject`](../../../../utils/value-object/classes/ValueObject.md).[`equals`](../../../../utils/value-object/classes/ValueObject.md#equals) - -*** - -### value() - -> **value**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[`ValueObject`](../../../../utils/value-object/classes/ValueObject.md).[`value`](../../../../utils/value-object/classes/ValueObject.md#value) diff --git a/packages/altair-docs/api/types/state/workspace.interface/index.md b/packages/altair-docs/api/types/state/workspace.interface/index.md deleted file mode 100644 index af75983c35..0000000000 --- a/packages/altair-docs/api/types/state/workspace.interface/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# types/state/workspace.interface - -## Index - -| Member | Description | -| :------ | :------ | -| [WorkspaceId](classes/WorkspaceId.md) | - | -| [Workspace](interfaces/Workspace.md) | - | -| [WorkspacesState](interfaces/WorkspacesState.md) | - | -| [WORKSPACES](variables/WORKSPACES.md) | - | diff --git a/packages/altair-docs/api/types/state/workspace.interface/interfaces/Workspace.md b/packages/altair-docs/api/types/state/workspace.interface/interfaces/Workspace.md deleted file mode 100644 index 1f1beadf01..0000000000 --- a/packages/altair-docs/api/types/state/workspace.interface/interfaces/Workspace.md +++ /dev/null @@ -1,19 +0,0 @@ -# Workspace - -## Properties - -### id - -> **id**: `string` - -*** - -### name - -> **name**: `string` - -*** - -### teamId? - -> `optional` **teamId**: `string` diff --git a/packages/altair-docs/api/types/state/workspace.interface/interfaces/WorkspacesState.md b/packages/altair-docs/api/types/state/workspace.interface/interfaces/WorkspacesState.md deleted file mode 100644 index a0b613c79e..0000000000 --- a/packages/altair-docs/api/types/state/workspace.interface/interfaces/WorkspacesState.md +++ /dev/null @@ -1,7 +0,0 @@ -# WorkspacesState - -## Properties - -### list - -> **list**: [`Workspace`](Workspace.md)[] diff --git a/packages/altair-docs/api/types/state/workspace.interface/variables/WORKSPACES.md b/packages/altair-docs/api/types/state/workspace.interface/variables/WORKSPACES.md deleted file mode 100644 index 3d0b57a4c5..0000000000 --- a/packages/altair-docs/api/types/state/workspace.interface/variables/WORKSPACES.md +++ /dev/null @@ -1,13 +0,0 @@ -# WORKSPACES - -> `const` **WORKSPACES**: `object` - -## Type declaration - -### LOCAL - -> `readonly` **LOCAL**: `"local"` = `'local'` - -### REMOTE - -> `readonly` **REMOTE**: `"remote"` = `'remote'` diff --git a/packages/altair-docs/api/utils/is_electron/index.md b/packages/altair-docs/api/utils/is_electron/index.md deleted file mode 100644 index 88467c5144..0000000000 --- a/packages/altair-docs/api/utils/is_electron/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# utils/is\_electron - -## Index - -| Member | Description | -| :------ | :------ | -| [default](variables/default.md) | - | diff --git a/packages/altair-docs/api/utils/is_electron/variables/default.md b/packages/altair-docs/api/utils/is_electron/variables/default.md deleted file mode 100644 index 937ae55495..0000000000 --- a/packages/altair-docs/api/utils/is_electron/variables/default.md +++ /dev/null @@ -1,3 +0,0 @@ -# default - -> **default**: `boolean` diff --git a/packages/altair-docs/api/utils/logger/functions/createLogger.md b/packages/altair-docs/api/utils/logger/functions/createLogger.md deleted file mode 100644 index fce58ff5c6..0000000000 --- a/packages/altair-docs/api/utils/logger/functions/createLogger.md +++ /dev/null @@ -1,15 +0,0 @@ -# createLogger() - -> **createLogger**(`environment`: `object`): [`ILogger`](../interfaces/ILogger.md) - -## Parameters - -• **environment** - -• **environment.production**: `boolean` - -• **environment.version**: `string` - -## Returns - -[`ILogger`](../interfaces/ILogger.md) diff --git a/packages/altair-docs/api/utils/logger/index.md b/packages/altair-docs/api/utils/logger/index.md deleted file mode 100644 index 7e9801ad5a..0000000000 --- a/packages/altair-docs/api/utils/logger/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# utils/logger - -## Index - -| Member | Description | -| :------ | :------ | -| [ILogger](interfaces/ILogger.md) | - | -| [createLogger](functions/createLogger.md) | - | diff --git a/packages/altair-docs/api/utils/logger/interfaces/ILogger.md b/packages/altair-docs/api/utils/logger/interfaces/ILogger.md deleted file mode 100644 index e9318cbfbe..0000000000 --- a/packages/altair-docs/api/utils/logger/interfaces/ILogger.md +++ /dev/null @@ -1,71 +0,0 @@ -# ILogger - -## Methods - -### debug() - -> **debug**(...`args`: `any`[]): `void` - -#### Parameters - -• ...**args**: `any`[] - -#### Returns - -`void` - -*** - -### error() - -> **error**(...`args`: `any`[]): `void` - -#### Parameters - -• ...**args**: `any`[] - -#### Returns - -`void` - -*** - -### info() - -> **info**(...`args`: `any`[]): `void` - -#### Parameters - -• ...**args**: `any`[] - -#### Returns - -`void` - -*** - -### log() - -> **log**(...`args`: `any`[]): `void` - -#### Parameters - -• ...**args**: `any`[] - -#### Returns - -`void` - -*** - -### warn() - -> **warn**(...`args`: `any`[]): `void` - -#### Parameters - -• ...**args**: `any`[] - -#### Returns - -`void` diff --git a/packages/altair-docs/api/utils/url/functions/urlWithParams.md b/packages/altair-docs/api/utils/url/functions/urlWithParams.md deleted file mode 100644 index 8d06faea07..0000000000 --- a/packages/altair-docs/api/utils/url/functions/urlWithParams.md +++ /dev/null @@ -1,13 +0,0 @@ -# urlWithParams() - -> **urlWithParams**(`url`: `string`, `params`: `Record`\<`string`, `string`\>): `string` - -## Parameters - -• **url**: `string` - -• **params**: `Record`\<`string`, `string`\> - -## Returns - -`string` diff --git a/packages/altair-docs/api/utils/url/index.md b/packages/altair-docs/api/utils/url/index.md deleted file mode 100644 index bf5078248f..0000000000 --- a/packages/altair-docs/api/utils/url/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# utils/url - -## Index - -| Member | Description | -| :------ | :------ | -| [urlWithParams](functions/urlWithParams.md) | - | diff --git a/packages/altair-docs/api/utils/value-object/classes/ValueObject.md b/packages/altair-docs/api/utils/value-object/classes/ValueObject.md deleted file mode 100644 index 4b2e1a977e..0000000000 --- a/packages/altair-docs/api/utils/value-object/classes/ValueObject.md +++ /dev/null @@ -1,54 +0,0 @@ -# `abstract` ValueObject\ - -## Extended by - -- [`TeamId`](../../../types/state/account.interfaces/classes/TeamId.md) -- [`WorkspaceId`](../../../types/state/workspace.interface/classes/WorkspaceId.md) - -## Type parameters - -• **T** - -## Constructors - -### new ValueObject() - -> **new ValueObject**\<`T`\>(`props`: `T`): [`ValueObject`](ValueObject.md)\<`T`\> - -#### Parameters - -• **props**: `T` - -#### Returns - -[`ValueObject`](ValueObject.md)\<`T`\> - -## Properties - -### props - -> `readonly` **props**: `T` - -## Methods - -### equals() - -> **equals**(`vo`?: [`ValueObject`](ValueObject.md)\<`T`\>): `boolean` - -#### Parameters - -• **vo?**: [`ValueObject`](ValueObject.md)\<`T`\> - -#### Returns - -`boolean` - -*** - -### value() - -> **value**(): `T` - -#### Returns - -`T` diff --git a/packages/altair-docs/api/utils/value-object/index.md b/packages/altair-docs/api/utils/value-object/index.md deleted file mode 100644 index 3fc8a2cbae..0000000000 --- a/packages/altair-docs/api/utils/value-object/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# utils/value-object - -## Index - -| Member | Description | -| :------ | :------ | -| [ValueObject](classes/ValueObject.md) | - | diff --git a/packages/altair-docs/api/validate-partial-settings/functions/default.md b/packages/altair-docs/api/validate-partial-settings/functions/default.md deleted file mode 100644 index 820a3b6fe9..0000000000 --- a/packages/altair-docs/api/validate-partial-settings/functions/default.md +++ /dev/null @@ -1,15 +0,0 @@ -# default() - -> **default**(`this`: `any`, `data`: `any`, `dataCxt`?: `DataValidationCxt`\<`string` \| `number`\>): `data is Partial` - -## Parameters - -• **this**: `any` - -• **data**: `any` - -• **dataCxt?**: `DataValidationCxt`\<`string` \| `number`\> - -## Returns - -`data is Partial` diff --git a/packages/altair-docs/api/validate-partial-settings/index.md b/packages/altair-docs/api/validate-partial-settings/index.md deleted file mode 100644 index 3970a7a2f7..0000000000 --- a/packages/altair-docs/api/validate-partial-settings/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# validate-partial-settings - -## Index - -| Member | Description | -| :------ | :------ | -| [default](functions/default.md) | - | diff --git a/packages/altair-docs/api/validate-settings/functions/default.md b/packages/altair-docs/api/validate-settings/functions/default.md deleted file mode 100644 index 25b7d23624..0000000000 --- a/packages/altair-docs/api/validate-settings/functions/default.md +++ /dev/null @@ -1,15 +0,0 @@ -# default() - -> **default**(`this`: `any`, `data`: `any`, `dataCxt`?: `DataValidationCxt`\<`string` \| `number`\>): `data is SettingsState` - -## Parameters - -• **this**: `any` - -• **data**: `any` - -• **dataCxt?**: `DataValidationCxt`\<`string` \| `number`\> - -## Returns - -`data is SettingsState` diff --git a/packages/altair-docs/api/validate-settings/index.md b/packages/altair-docs/api/validate-settings/index.md deleted file mode 100644 index 146bc47418..0000000000 --- a/packages/altair-docs/api/validate-settings/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# validate-settings - -## Index - -| Member | Description | -| :------ | :------ | -| [default](functions/default.md) | - | diff --git a/typedoc.json b/typedoc.json index 9e0d42dafa..4e549b22b7 100644 --- a/typedoc.json +++ b/typedoc.json @@ -2,7 +2,7 @@ // Comments are supported, like tsconfig.json "entryPoints": ["packages/altair-core/src/*"], "entryPointStrategy": "expand", - "out": "packages/altair-docs/api", + "out": "packages/altair-docs/api/core", "docsRoot": "./packages/altair-docs", "entryFileName": "index.md", "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],