diff --git a/package.json b/package.json index bfcc30db87..86307dc0a2 100644 --- a/package.json +++ b/package.json @@ -36,6 +36,9 @@ "stream-http": "^3.1.0", "syncpack": "^9.8.4", "turbo": "^1.7.3", + "typedoc": "^0.25.13", + "typedoc-plugin-markdown": "^4.0.3", + "typedoc-vitepress-theme": "^1.0.0", "typescript": "5.2.2", "web-ext": "^6.5.0", "wrangler": "^2.0.27" diff --git a/packages/altair-docs/.gitignore b/packages/altair-docs/.gitignore index b73303468e..80e2d0b92d 100644 --- a/packages/altair-docs/.gitignore +++ b/packages/altair-docs/.gitignore @@ -1,2 +1,3 @@ .vitepress/cache .vitepress/dist +.vitepress/.temp diff --git a/packages/altair-docs/.vitepress/config.mts b/packages/altair-docs/.vitepress/config.mts index 9e1c9b5c1c..e8251aac2e 100644 --- a/packages/altair-docs/.vitepress/config.mts +++ b/packages/altair-docs/.vitepress/config.mts @@ -1,23 +1,25 @@ -import { defineConfig } from 'vitepress' +import { defineConfig } from 'vitepress'; import { getConfig } from './plugins/sidebar-generation'; +import typedocSidebar from '../api/typedoc-sidebar.json'; const { sidebar: retrievedSidebar } = getConfig({ - filter: meta => meta.sidebar !== false, + filter: (meta) => meta.sidebar !== false, }); const seoTitle = 'Altair GraphQL Client'; const seoImage = '/assets/img/app-shot.png'; -const description = 'Altair is a feature-rich GraphQL Client IDE for all platforms. Enables you interact with any GraphQL server you are authorized to access from any platform you are on.'; +const description = + 'Altair is a feature-rich GraphQL Client IDE for all platforms. Enables you interact with any GraphQL server you are authorized to access from any platform you are on.'; const GA = 'UA-41432833-7'; // https://vitepress.dev/reference/site-config export default defineConfig({ - title: "Altair GraphQL Client", + title: 'Altair GraphQL Client', description, head: [ ['link', { rel: 'icon', href: '/favicon.ico' }], [ 'script', - { async: '', src: `https://www.googletagmanager.com/gtag/js?id=${GA}` } + { async: '', src: `https://www.googletagmanager.com/gtag/js?id=${GA}` }, ], [ 'script', @@ -25,41 +27,34 @@ export default defineConfig({ `window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); - gtag('config', '${GA}');` + gtag('config', '${GA}');`, ], ['meta', { name: 'theme-color', content: '#3eaf7c' }], ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }], - [ - 'meta', - { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }, - ], + ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }], [ 'link', { rel: 'stylesheet', - href: - 'https://fonts.googleapis.com/css?family=DM+Sans:400,500,700&display=swap', + href: 'https://fonts.googleapis.com/css?family=DM+Sans:400,500,700&display=swap', }, ], [ 'link', { rel: 'stylesheet', - href: - 'https://cdn.jsdelivr.net/npm/cookieconsent@3/build/cookieconsent.min.css', + href: 'https://cdn.jsdelivr.net/npm/cookieconsent@3/build/cookieconsent.min.css', }, ], [ 'script', { - src: - 'https://cdn.jsdelivr.net/npm/cookieconsent@3/build/cookieconsent.min.js', + src: 'https://cdn.jsdelivr.net/npm/cookieconsent@3/build/cookieconsent.min.js', 'data-cfasync': 'false', }, ], - // SEO ['meta', { name: 'description', content: description }], ['meta', { itemprop: 'name', content: seoTitle }], @@ -88,7 +83,14 @@ export default defineConfig({ link: 'https://opencollective.com/altair/donate', }, ], - sidebar: [retrievedSidebar[0]], + sidebar: [ + retrievedSidebar[0], + { + text: 'API', + link: '/api/', + items: typedocSidebar, + }, + ], socialLinks: [ { icon: 'twitter', @@ -104,14 +106,15 @@ export default defineConfig({ placement: 'altairsirmueldesign', }, editLink: { - pattern: 'https://github.com/altair-graphql/altair/edit/main/packages/altair-docs/:path', + pattern: + 'https://github.com/altair-graphql/altair/edit/main/packages/altair-docs/:path', text: 'Help us improve this page!', }, lastUpdated: { text: 'Last Updated', }, search: { - provider: 'local' + provider: 'local', }, }, transformHead({ page }) { @@ -119,12 +122,12 @@ export default defineConfig({ if (page !== '404.md') { const canonicalUrl = `https://altairgraphql.dev/${page}` .replace(/index\.md$/, '') - .replace(/\.md$/, '') + .replace(/\.md$/, ''); - return [['link', { rel: 'canonical', href: canonicalUrl }]] + return [['link', { rel: 'canonical', href: canonicalUrl }]]; } }, sitemap: { hostname: 'https://altairgraphql.dev', - } -}) + }, +}); diff --git a/packages/altair-docs/api/authorization/authorization-provider/classes/AuthorizationProvider.md b/packages/altair-docs/api/authorization/authorization-provider/classes/AuthorizationProvider.md new file mode 100644 index 0000000000..951d85d0e1 --- /dev/null +++ b/packages/altair-docs/api/authorization/authorization-provider/classes/AuthorizationProvider.md @@ -0,0 +1,54 @@ +# `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 new file mode 100644 index 0000000000..650782f100 --- /dev/null +++ b/packages/altair-docs/api/authorization/authorization-provider/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..fcee246639 --- /dev/null +++ b/packages/altair-docs/api/authorization/authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..d1d5d608af --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/api-key/classes/default.md @@ -0,0 +1,59 @@ +# 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 new file mode 100644 index 0000000000..b86b56dcc6 --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/api-key/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..ca39d69ced --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/api-key/interfaces/ApiKeyAuthorizationProviderData.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..ba95190b7b --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/basic/classes/default.md @@ -0,0 +1,59 @@ +# 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 new file mode 100644 index 0000000000..8b7f247778 --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/basic/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..3379f889d9 --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/basic/interfaces/BasicAuthorizationProviderData.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..2be994bb39 --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/bearer/classes/default.md @@ -0,0 +1,59 @@ +# 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 new file mode 100644 index 0000000000..c123caac08 --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/bearer/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..848087f994 --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/bearer/interfaces/BearerAuthorizationProviderData.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..9964c7244b --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/oauth2/classes/default.md @@ -0,0 +1,59 @@ +# 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 new file mode 100644 index 0000000000..90bc826f4c --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/oauth2/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..5e8f333b97 --- /dev/null +++ b/packages/altair-docs/api/authorization/providers/oauth2/interfaces/OAuth2AuthorizationProviderData.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..b6a59796f1 --- /dev/null +++ b/packages/altair-docs/api/config/classes/AltairConfig.md @@ -0,0 +1,243 @@ +# 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 new file mode 100644 index 0000000000..2348dbec3d --- /dev/null +++ b/packages/altair-docs/api/config/functions/getAltairConfig.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..b4081c2da3 --- /dev/null +++ b/packages/altair-docs/api/config/functions/setAltairConfig.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..6d4eab7f9a --- /dev/null +++ b/packages/altair-docs/api/config/index.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..fb9abf16f0 --- /dev/null +++ b/packages/altair-docs/api/config/interfaces/AltairConfigOptions.md @@ -0,0 +1,250 @@ +# 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 new file mode 100644 index 0000000000..24dd045ffc --- /dev/null +++ b/packages/altair-docs/api/config/interfaces/AltairWindowOptions.md @@ -0,0 +1,116 @@ +# 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 new file mode 100644 index 0000000000..061b4e176c --- /dev/null +++ b/packages/altair-docs/api/evaluator/events/functions/getErrorEvent.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..8467620352 --- /dev/null +++ b/packages/altair-docs/api/evaluator/events/functions/getResponseEvent.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..94ca27b78d --- /dev/null +++ b/packages/altair-docs/api/evaluator/events/index.md @@ -0,0 +1,10 @@ +# 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 new file mode 100644 index 0000000000..fba67a293e --- /dev/null +++ b/packages/altair-docs/api/evaluator/events/variables/EVALUATOR_INIT_EXECUTE.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..9c6e654a94 --- /dev/null +++ b/packages/altair-docs/api/evaluator/events/variables/EVALUATOR_READY.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..87c18b28b1 --- /dev/null +++ b/packages/altair-docs/api/evaluator/worker/classes/EvaluatorWorker.md @@ -0,0 +1,146 @@ +# `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 new file mode 100644 index 0000000000..0c48f1acba --- /dev/null +++ b/packages/altair-docs/api/evaluator/worker/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..7829c2ec3a --- /dev/null +++ b/packages/altair-docs/api/evaluator/worker/interfaces/EventData.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..55fc44c079 --- /dev/null +++ b/packages/altair-docs/api/index.md @@ -0,0 +1,85 @@ +# 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 new file mode 100644 index 0000000000..9933583237 --- /dev/null +++ b/packages/altair-docs/api/index/functions/registerPluginClass.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 0000000000..a0b1d1b244 --- /dev/null +++ b/packages/altair-docs/api/index/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..73ee1fda43 --- /dev/null +++ b/packages/altair-docs/api/oauth2/client/classes/OAuth2Client.md @@ -0,0 +1,49 @@ +# 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 new file mode 100644 index 0000000000..4b463ffe32 --- /dev/null +++ b/packages/altair-docs/api/oauth2/client/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..0cd5613a7f --- /dev/null +++ b/packages/altair-docs/api/oauth2/client/type-aliases/OAuth2ClientOptions.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..01dd4c7606 --- /dev/null +++ b/packages/altair-docs/api/oauth2/events/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..66ee7f22d4 --- /dev/null +++ b/packages/altair-docs/api/oauth2/events/variables/EVENT_TYPES.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 0000000000..c302f0c036 --- /dev/null +++ b/packages/altair-docs/api/oauth2/helpers/functions/base64UrlEncode.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..2e89761000 --- /dev/null +++ b/packages/altair-docs/api/oauth2/helpers/functions/getCodeChallenge.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..30a6e3858e --- /dev/null +++ b/packages/altair-docs/api/oauth2/helpers/functions/hex.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..8104e59be8 --- /dev/null +++ b/packages/altair-docs/api/oauth2/helpers/functions/secureRandomString.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..505b159d6c --- /dev/null +++ b/packages/altair-docs/api/oauth2/helpers/functions/sha256.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..accdbb46c1 --- /dev/null +++ b/packages/altair-docs/api/oauth2/helpers/index.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..ee2eb0c639 --- /dev/null +++ b/packages/altair-docs/api/oauth2/index.md @@ -0,0 +1 @@ +# oauth2 diff --git a/packages/altair-docs/api/oauth2/types/enumerations/OAuth2Type.md b/packages/altair-docs/api/oauth2/types/enumerations/OAuth2Type.md new file mode 100644 index 0000000000..1bd06f50a7 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/enumerations/OAuth2Type.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..5218ea3211 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/index.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 0000000000..1969a6b8d9 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/interfaces/AccessTokenErrorResponse.md @@ -0,0 +1,25 @@ +# 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 new file mode 100644 index 0000000000..0b85554464 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/interfaces/AccessTokenResponse.md @@ -0,0 +1,51 @@ +# 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 new file mode 100644 index 0000000000..05f463e6b2 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationCodePKCE_AccessTokenRequest.md @@ -0,0 +1,65 @@ +# 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 new file mode 100644 index 0000000000..6a9657b9de --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationCode_AccessTokenRequest.md @@ -0,0 +1,39 @@ +# 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 new file mode 100644 index 0000000000..ed25b3c87f --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationRedirectErrorResponse.md @@ -0,0 +1,25 @@ +# 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 new file mode 100644 index 0000000000..c07e5251b3 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/interfaces/AuthorizationRedirectResponse.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 0000000000..800844c164 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/interfaces/CodeChallengeAuthorizationRequestParams.md @@ -0,0 +1,75 @@ +# 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 new file mode 100644 index 0000000000..13ff28a3b5 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/interfaces/SimpleAuthorizationRequestParams.md @@ -0,0 +1,47 @@ +# 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 new file mode 100644 index 0000000000..1c32e30b39 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/type-aliases/AccessTokenRequest.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..390bb28802 --- /dev/null +++ b/packages/altair-docs/api/oauth2/types/type-aliases/AuthorizationRequestParams.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..e89d086df8 --- /dev/null +++ b/packages/altair-docs/api/origins/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..71c092fe5b --- /dev/null +++ b/packages/altair-docs/api/origins/variables/validOrigins.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..b0a9397576 --- /dev/null +++ b/packages/altair-docs/api/plugin/base/classes/PluginBase.md @@ -0,0 +1,45 @@ +# `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 new file mode 100644 index 0000000000..5530b7fa87 --- /dev/null +++ b/packages/altair-docs/api/plugin/base/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..e1bd1a1927 --- /dev/null +++ b/packages/altair-docs/api/plugin/base/interfaces/PluginConstructor.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..11d9091755 --- /dev/null +++ b/packages/altair-docs/api/plugin/context/context.interface/index.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..17850cb90b --- /dev/null +++ b/packages/altair-docs/api/plugin/context/context.interface/interfaces/CreateActionOptions.md @@ -0,0 +1,27 @@ +# 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 new file mode 100644 index 0000000000..2e3219b922 --- /dev/null +++ b/packages/altair-docs/api/plugin/context/context.interface/interfaces/CreatePanelOptions.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..4e10411e91 --- /dev/null +++ b/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginContext.md @@ -0,0 +1,232 @@ +# 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 new file mode 100644 index 0000000000..19fc24a389 --- /dev/null +++ b/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginContextGenerator.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 0000000000..ee43ac4a16 --- /dev/null +++ b/packages/altair-docs/api/plugin/context/context.interface/interfaces/PluginWindowState.md @@ -0,0 +1,223 @@ +# 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 new file mode 100644 index 0000000000..d505993eaf --- /dev/null +++ b/packages/altair-docs/api/plugin/event/event.interfaces/index.md @@ -0,0 +1,9 @@ +# 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 new file mode 100644 index 0000000000..fe2d8735fa --- /dev/null +++ b/packages/altair-docs/api/plugin/event/event.interfaces/interfaces/PluginEventPayloadMap.md @@ -0,0 +1,89 @@ +# 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 new file mode 100644 index 0000000000..2b9036161a --- /dev/null +++ b/packages/altair-docs/api/plugin/event/event.interfaces/type-aliases/PluginEvent.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..ad4bf7d554 --- /dev/null +++ b/packages/altair-docs/api/plugin/event/event.interfaces/type-aliases/PluginEventCallback.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..5ff9fc2633 --- /dev/null +++ b/packages/altair-docs/api/plugin/panel/classes/AltairPanel.md @@ -0,0 +1,69 @@ +# 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 new file mode 100644 index 0000000000..b930ffc8ea --- /dev/null +++ b/packages/altair-docs/api/plugin/panel/enumerations/AltairPanelLocation.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..591e5f4490 --- /dev/null +++ b/packages/altair-docs/api/plugin/panel/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..566ef7faf4 --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/enumerations/PluginSource.md @@ -0,0 +1,22 @@ +# 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 new file mode 100644 index 0000000000..662b328936 --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/enumerations/PluginType.md @@ -0,0 +1,22 @@ +# 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 new file mode 100644 index 0000000000..9f24badf91 --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/functions/createV1Plugin.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..5c5e796e08 --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/index.md @@ -0,0 +1,14 @@ +# 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 new file mode 100644 index 0000000000..e019a27121 --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/AltairV1Plugin.md @@ -0,0 +1,37 @@ +# 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 new file mode 100644 index 0000000000..88e9b09a82 --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/PluginManifest.md @@ -0,0 +1,75 @@ +# 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 new file mode 100644 index 0000000000..9f1839b253 --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/RemotePluginListItem.md @@ -0,0 +1,55 @@ +# 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 new file mode 100644 index 0000000000..51cb04816b --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/interfaces/RemotePluginListResponse.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..4289d9d82f --- /dev/null +++ b/packages/altair-docs/api/plugin/plugin.interfaces/type-aliases/PluginCapabilities.md @@ -0,0 +1,6 @@ +# 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 new file mode 100644 index 0000000000..e617d48881 --- /dev/null +++ b/packages/altair-docs/api/plugin/ui-action/classes/AltairUiAction.md @@ -0,0 +1,57 @@ +# 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 new file mode 100644 index 0000000000..52f47b9f10 --- /dev/null +++ b/packages/altair-docs/api/plugin/ui-action/enumerations/AltairUiActionLocation.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..0d8e35de0f --- /dev/null +++ b/packages/altair-docs/api/plugin/ui-action/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..8b49c61e24 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/capabilities/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..4289d9d82f --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/capabilities/type-aliases/PluginCapabilities.md @@ -0,0 +1,6 @@ +# 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 new file mode 100644 index 0000000000..66689208da --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/context/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..a6bf95856c --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/context/interfaces/PluginV3Context.md @@ -0,0 +1,281 @@ +# 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 new file mode 100644 index 0000000000..7b991ebd48 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/events/functions/getActionEvent.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..c37ef9e96a --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/events/index.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..9762e5ffe4 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_CREATE_ACTION_EVENT.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..96f34b824d --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_ENGINE_READY.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..4e1ad69637 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_GET_APP_STYLE_URL_EVENT.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..0eda7dad51 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/events/variables/PLUGIN_SUBSCRIBE_TO_EVENT.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..11693ef046 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/frame-engine/classes/PluginFrameEngine.md @@ -0,0 +1,47 @@ +# 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 new file mode 100644 index 0000000000..c4b9d9edd3 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/frame-engine/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..b6e22dd60c --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/frame-worker/classes/PluginFrameWorker.md @@ -0,0 +1,193 @@ +# 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 new file mode 100644 index 0000000000..35a3bef7ab --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/frame-worker/index.md @@ -0,0 +1,10 @@ +# 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 new file mode 100644 index 0000000000..8c26c37bc8 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/frame-worker/interfaces/FrameQueryParams.md @@ -0,0 +1,23 @@ +# 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 new file mode 100644 index 0000000000..69a776c667 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/frame-worker/type-aliases/InstanceType.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..faa2488458 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/frame-worker/variables/instanceTypes.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..c236c81f2a --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/manifest/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..a6a565d7a1 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/manifest/interfaces/PluginV3Manifest.md @@ -0,0 +1,73 @@ +# 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 new file mode 100644 index 0000000000..bd0752f6b4 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/panel/classes/AltairV3Panel.md @@ -0,0 +1,43 @@ +# `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 new file mode 100644 index 0000000000..85e5a0705e --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/panel/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..fc8de34c27 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/parent-engine/classes/PluginParentEngine.md @@ -0,0 +1,75 @@ +# 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 new file mode 100644 index 0000000000..92c5d1c1bc --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/parent-engine/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..b9501fb94c --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/parent-worker/classes/PluginParentWorker.md @@ -0,0 +1,201 @@ +# 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 new file mode 100644 index 0000000000..792c93873d --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/parent-worker/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..9bbf9fc25d --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/parent-worker/interfaces/PluginParentWorkerOptions.md @@ -0,0 +1,37 @@ +# 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 new file mode 100644 index 0000000000..a6837573ea --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/plugin/classes/PluginV3.md @@ -0,0 +1,39 @@ +# `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 new file mode 100644 index 0000000000..c256ecc8df --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/plugin/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..3b4b597154 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/plugin/interfaces/PluginV3Options.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..566ef7faf4 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/source/enumerations/PluginSource.md @@ -0,0 +1,22 @@ +# 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 new file mode 100644 index 0000000000..6b178f9033 --- /dev/null +++ b/packages/altair-docs/api/plugin/v3/source/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..79b8b3f3e4 --- /dev/null +++ b/packages/altair-docs/api/script/context/functions/buildContextResponse.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..d6bb27e946 --- /dev/null +++ b/packages/altair-docs/api/script/context/functions/getGlobalContext.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..4c35185780 --- /dev/null +++ b/packages/altair-docs/api/script/context/functions/importModuleHelper.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..f639cbde69 --- /dev/null +++ b/packages/altair-docs/api/script/context/index.md @@ -0,0 +1,10 @@ +# 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 new file mode 100644 index 0000000000..6e99f4fd30 --- /dev/null +++ b/packages/altair-docs/api/script/context/variables/ModuleImports.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..1f49cd0185 --- /dev/null +++ b/packages/altair-docs/api/script/errors/classes/RequestScriptError.md @@ -0,0 +1,33 @@ +# 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 new file mode 100644 index 0000000000..df3bf4178e --- /dev/null +++ b/packages/altair-docs/api/script/errors/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..2d7842291b --- /dev/null +++ b/packages/altair-docs/api/script/evaluator-client-engine/classes/ScriptEvaluatorClientEngine.md @@ -0,0 +1,35 @@ +# 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 new file mode 100644 index 0000000000..16bbf6afbf --- /dev/null +++ b/packages/altair-docs/api/script/evaluator-client-engine/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..1d24748abb --- /dev/null +++ b/packages/altair-docs/api/script/evaluator-worker-engine/classes/ScriptEvaluatorWorkerEngine.md @@ -0,0 +1,25 @@ +# 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 new file mode 100644 index 0000000000..22f2a5a51c --- /dev/null +++ b/packages/altair-docs/api/script/evaluator-worker-engine/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..25cd9070c6 --- /dev/null +++ b/packages/altair-docs/api/script/evaluator-worker-engine/type-aliases/WorkerHandlerNames.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..9e2cb89f1f --- /dev/null +++ b/packages/altair-docs/api/script/events/functions/getErrorEvent.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..e3af48c8aa --- /dev/null +++ b/packages/altair-docs/api/script/events/functions/getResponseEvent.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..d6508d0f6b --- /dev/null +++ b/packages/altair-docs/api/script/events/index.md @@ -0,0 +1,9 @@ +# 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 new file mode 100644 index 0000000000..5f8d00cf9b --- /dev/null +++ b/packages/altair-docs/api/script/events/variables/SCRIPT_INIT_EXECUTE.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..e1154b2a47 --- /dev/null +++ b/packages/altair-docs/api/script/types/classes/ScriptEvaluatorClient.md @@ -0,0 +1,111 @@ +# `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 new file mode 100644 index 0000000000..2e53581e6f --- /dev/null +++ b/packages/altair-docs/api/script/types/classes/ScriptEvaluatorWorker.md @@ -0,0 +1,55 @@ +# `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 new file mode 100644 index 0000000000..5ddbb30936 --- /dev/null +++ b/packages/altair-docs/api/script/types/enumerations/RequestType.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..6ddca1032e --- /dev/null +++ b/packages/altair-docs/api/script/types/index.md @@ -0,0 +1,31 @@ +# 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 new file mode 100644 index 0000000000..799c0b2c08 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/AllScriptEventHandlers.md @@ -0,0 +1,169 @@ +# 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 new file mode 100644 index 0000000000..ed75326add --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/CookieOptions.md @@ -0,0 +1,31 @@ +# 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 new file mode 100644 index 0000000000..1a40c4df61 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/GlobalContextBuilderHandlers.md @@ -0,0 +1,67 @@ +# 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 new file mode 100644 index 0000000000..3258050143 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/GlobalHelperContext.md @@ -0,0 +1,53 @@ +# 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 new file mode 100644 index 0000000000..3fc6c12bfc --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ModuleImportsMap.md @@ -0,0 +1,5 @@ +# 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 new file mode 100644 index 0000000000..40d505aaeb --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptContextData.md @@ -0,0 +1,73 @@ +# 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 new file mode 100644 index 0000000000..c34c4fff4a --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptContextHelpers.md @@ -0,0 +1,79 @@ +# 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 new file mode 100644 index 0000000000..96058d522a --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptContextResponse.md @@ -0,0 +1,31 @@ +# 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 new file mode 100644 index 0000000000..c1422190e4 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptContextStorage.md @@ -0,0 +1,31 @@ +# 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 new file mode 100644 index 0000000000..5c260eef72 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptEvaluatorClientFactory.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..da19f9607c --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptEventDataPayload.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 0000000000..a6434eae26 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptEventErrorPayload.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..a8639c2c78 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptEventHandlers.md @@ -0,0 +1,113 @@ +# 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 new file mode 100644 index 0000000000..cefcd75891 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptEventResponsePayload.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..144338c3bb --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptTranformResult.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..cd463a65a0 --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/ScriptWorkerMessageData.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..86d387e03b --- /dev/null +++ b/packages/altair-docs/api/script/types/interfaces/SendRequestResponse.md @@ -0,0 +1,29 @@ +# 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 new file mode 100644 index 0000000000..2bbf226973 --- /dev/null +++ b/packages/altair-docs/api/script/types/type-aliases/SameSite.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..abf0cf92fd --- /dev/null +++ b/packages/altair-docs/api/script/types/type-aliases/ScriptEvent.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..e0f0b9805c --- /dev/null +++ b/packages/altair-docs/api/script/types/type-aliases/ScriptEventData.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..df034f2158 --- /dev/null +++ b/packages/altair-docs/api/script/types/type-aliases/ScriptEventParameters.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..701f97ed26 --- /dev/null +++ b/packages/altair-docs/api/script/types/type-aliases/ScriptResponseEvent.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..ec6c20c328 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/index.md @@ -0,0 +1,14 @@ +# 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 new file mode 100644 index 0000000000..71ca978bc7 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/interfaces/SubscriptionProviderData.md @@ -0,0 +1,23 @@ +# 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 new file mode 100644 index 0000000000..11aba3ba86 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/action-cable/classes/ActionCableSubscriptionProvider.md @@ -0,0 +1,101 @@ +# 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 new file mode 100644 index 0000000000..6fa1c00f97 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/action-cable/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..c59a738555 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/app-sync/classes/AppSyncSubscriptionProvider.md @@ -0,0 +1,104 @@ +# 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 new file mode 100644 index 0000000000..ed2cbef57c --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/app-sync/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..23eceb0a0b --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/graphql-sse/classes/GraphQLSSESubscriptionProvider.md @@ -0,0 +1,115 @@ +# 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 new file mode 100644 index 0000000000..4610c9d693 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/graphql-sse/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..876b225c71 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/graphql-ws/classes/GraphQLWsSubscriptionProvider.md @@ -0,0 +1,115 @@ +# 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 new file mode 100644 index 0000000000..58ed49946a --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/graphql-ws/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..0b03cbd41d --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/ws/classes/WebsocketSubscriptionProvider.md @@ -0,0 +1,115 @@ +# 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 new file mode 100644 index 0000000000..c992d453e4 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/providers/ws/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..33feabda59 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/subscription-provider/classes/SubscriptionProvider.md @@ -0,0 +1,69 @@ +# `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 new file mode 100644 index 0000000000..7ec8d44097 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/subscription-provider/index.md @@ -0,0 +1,10 @@ +# 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 new file mode 100644 index 0000000000..77e814f85a --- /dev/null +++ b/packages/altair-docs/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExecuteOptions.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..aaaff9d292 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/subscription-provider/interfaces/SubscriptionProviderExtraOptions.md @@ -0,0 +1,23 @@ +# 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 new file mode 100644 index 0000000000..211c71d02a --- /dev/null +++ b/packages/altair-docs/api/subscriptions/subscription-provider/type-aliases/SubscriptionProviderConstructor.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..8c8cdfd086 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/type-aliases/SubscriptionProviderIds.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..79bf122ec1 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/variables/ACTION_CABLE_PROVIDER_ID.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..08373a4020 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/variables/APP_SYNC_PROVIDER_ID.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..ac767e2a57 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/variables/GRAPHQL_SSE_ID.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..d28adfed20 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/variables/GRAPHQL_WS_PROVIDER_ID.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..59a6462202 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/variables/SUBSCRIPTION_PROVIDER_IDS.md @@ -0,0 +1,25 @@ +# 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 new file mode 100644 index 0000000000..9edab39ce2 --- /dev/null +++ b/packages/altair-docs/api/subscriptions/variables/WEBSOCKET_PROVIDER_ID.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..d265b8a57f --- /dev/null +++ b/packages/altair-docs/api/theme/defaults/dark/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..8538598d9f --- /dev/null +++ b/packages/altair-docs/api/theme/defaults/dark/variables/default.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..bdd4d55821 --- /dev/null +++ b/packages/altair-docs/api/theme/defaults/dracula/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..8538598d9f --- /dev/null +++ b/packages/altair-docs/api/theme/defaults/dracula/variables/default.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..962f9a4e42 --- /dev/null +++ b/packages/altair-docs/api/theme/defaults/light/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..df88948edd --- /dev/null +++ b/packages/altair-docs/api/theme/defaults/light/variables/default.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..facf4f5a10 --- /dev/null +++ b/packages/altair-docs/api/theme/index.md @@ -0,0 +1,9 @@ +# 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 new file mode 100644 index 0000000000..60e4361518 --- /dev/null +++ b/packages/altair-docs/api/theme/theme/functions/createTheme.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..84a4791f85 --- /dev/null +++ b/packages/altair-docs/api/theme/theme/functions/hexToRgbStr.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..6d8a6a73c0 --- /dev/null +++ b/packages/altair-docs/api/theme/theme/functions/mergeThemes.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..cb79cdac8e --- /dev/null +++ b/packages/altair-docs/api/theme/theme/index.md @@ -0,0 +1,12 @@ +# 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 new file mode 100644 index 0000000000..08d9b75efe --- /dev/null +++ b/packages/altair-docs/api/theme/theme/type-aliases/ICustomTheme.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..f4f5b284cf --- /dev/null +++ b/packages/altair-docs/api/theme/theme/type-aliases/ITheme.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..8d2442a882 --- /dev/null +++ b/packages/altair-docs/api/theme/theme/variables/foundations.md @@ -0,0 +1,101 @@ +# 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 new file mode 100644 index 0000000000..6ccca27e8b --- /dev/null +++ b/packages/altair-docs/api/theme/variables/dark.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..bd8954ba03 --- /dev/null +++ b/packages/altair-docs/api/theme/variables/dracula.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..7f1bdeba9b --- /dev/null +++ b/packages/altair-docs/api/theme/variables/light.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..3d3dbe4db3 --- /dev/null +++ b/packages/altair-docs/api/typedoc-sidebar.json @@ -0,0 +1,2198 @@ +[ + { + "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 new file mode 100644 index 0000000000..226da2b09f --- /dev/null +++ b/packages/altair-docs/api/types/shared/index.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..4a37e9132c --- /dev/null +++ b/packages/altair-docs/api/types/shared/interfaces/BaseDocument.md @@ -0,0 +1,24 @@ +# 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 new file mode 100644 index 0000000000..02df1259d3 --- /dev/null +++ b/packages/altair-docs/api/types/shared/interfaces/BaseOwnableDocument.md @@ -0,0 +1,46 @@ +# 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 new file mode 100644 index 0000000000..04f661e1ab --- /dev/null +++ b/packages/altair-docs/api/types/shared/type-aliases/CreateDTO.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..59d5d5822d --- /dev/null +++ b/packages/altair-docs/api/types/shared/type-aliases/IDictionary.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..0d4d848af2 --- /dev/null +++ b/packages/altair-docs/api/types/shared/type-aliases/NoExtraProperties.md @@ -0,0 +1,9 @@ +# 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 new file mode 100644 index 0000000000..09b04fb723 --- /dev/null +++ b/packages/altair-docs/api/types/shared/type-aliases/TODO.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..9f490c5bee --- /dev/null +++ b/packages/altair-docs/api/types/shared/type-aliases/UpdateDTO.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..559d737f72 --- /dev/null +++ b/packages/altair-docs/api/types/state/account.interfaces/classes/TeamId.md @@ -0,0 +1,65 @@ +# 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 new file mode 100644 index 0000000000..ffb2588620 --- /dev/null +++ b/packages/altair-docs/api/types/state/account.interfaces/index.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000000..48d4775ffe --- /dev/null +++ b/packages/altair-docs/api/types/state/account.interfaces/interfaces/AccountState.md @@ -0,0 +1,61 @@ +# 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 new file mode 100644 index 0000000000..05aca44033 --- /dev/null +++ b/packages/altair-docs/api/types/state/account.interfaces/interfaces/IPlan.md @@ -0,0 +1,31 @@ +# 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 new file mode 100644 index 0000000000..f16308f3be --- /dev/null +++ b/packages/altair-docs/api/types/state/account.interfaces/interfaces/IPlanInfo.md @@ -0,0 +1,49 @@ +# 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 new file mode 100644 index 0000000000..d96a2f4c06 --- /dev/null +++ b/packages/altair-docs/api/types/state/account.interfaces/interfaces/Team.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..1d77d4cc5a --- /dev/null +++ b/packages/altair-docs/api/types/state/authorization.interface/index.md @@ -0,0 +1,12 @@ +# 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 new file mode 100644 index 0000000000..e019b818fc --- /dev/null +++ b/packages/altair-docs/api/types/state/authorization.interface/interfaces/AuthorizationResult.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..27b8e20a51 --- /dev/null +++ b/packages/altair-docs/api/types/state/authorization.interface/interfaces/AuthorizationState.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..3d3b968870 --- /dev/null +++ b/packages/altair-docs/api/types/state/authorization.interface/type-aliases/AuthorizationTypes.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..5d6064c819 --- /dev/null +++ b/packages/altair-docs/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPES.md @@ -0,0 +1,25 @@ +# 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 new file mode 100644 index 0000000000..de6b9c9b36 --- /dev/null +++ b/packages/altair-docs/api/types/state/authorization.interface/variables/AUTHORIZATION_TYPE_LIST.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..51029782e2 --- /dev/null +++ b/packages/altair-docs/api/types/state/authorization.interface/variables/DEFAULT_AUTHORIZATION_TYPE.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..95c18a2171 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/index.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..23df444e55 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/CollectionState.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..20c2ee4114 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/ExportCollectionState.md @@ -0,0 +1,140 @@ +# 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 new file mode 100644 index 0000000000..4d72251571 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQuery.md @@ -0,0 +1,209 @@ +# 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 new file mode 100644 index 0000000000..aeeb252366 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQueryCollection.md @@ -0,0 +1,90 @@ +# 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 new file mode 100644 index 0000000000..449f2f5aa2 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IQueryCollectionTree.md @@ -0,0 +1,128 @@ +# 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 new file mode 100644 index 0000000000..4e0a846299 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IRemoteQuery.md @@ -0,0 +1,237 @@ +# 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 new file mode 100644 index 0000000000..269554ecd5 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/interfaces/IRemoteQueryCollection.md @@ -0,0 +1,117 @@ +# 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 new file mode 100644 index 0000000000..34cfe3b73f --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/type-aliases/EntityStorageType.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..d679833dc8 --- /dev/null +++ b/packages/altair-docs/api/types/state/collection.interfaces/type-aliases/SortByOptions.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..7d2e05313e --- /dev/null +++ b/packages/altair-docs/api/types/state/collections-meta.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..3f66892f0e --- /dev/null +++ b/packages/altair-docs/api/types/state/collections-meta.interfaces/interfaces/CollectionsMetaState.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..20945bb6b4 --- /dev/null +++ b/packages/altair-docs/api/types/state/dialog.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..8af32907d1 --- /dev/null +++ b/packages/altair-docs/api/types/state/dialog.interfaces/interfaces/DialogState.md @@ -0,0 +1,37 @@ +# 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 new file mode 100644 index 0000000000..2c5226ec4d --- /dev/null +++ b/packages/altair-docs/api/types/state/docs.interfaces/index.md @@ -0,0 +1,12 @@ +# 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 new file mode 100644 index 0000000000..8587e29c81 --- /dev/null +++ b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/DocsState.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..e442c3b4ea --- /dev/null +++ b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/FieldDocView.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..30c3876612 --- /dev/null +++ b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/RootDocView.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..bb47e396f2 --- /dev/null +++ b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/SearchDocView.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..dc2a3e6b56 --- /dev/null +++ b/packages/altair-docs/api/types/state/docs.interfaces/interfaces/TypeDocView.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..a0056c445c --- /dev/null +++ b/packages/altair-docs/api/types/state/docs.interfaces/type-aliases/DocView.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..ad919a19ca --- /dev/null +++ b/packages/altair-docs/api/types/state/donation.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..b7abe5022f --- /dev/null +++ b/packages/altair-docs/api/types/state/donation.interfaces/interfaces/DonationState.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..fb2939d6e9 --- /dev/null +++ b/packages/altair-docs/api/types/state/environments.interfaces/index.md @@ -0,0 +1,12 @@ +# 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 new file mode 100644 index 0000000000..8777df76dc --- /dev/null +++ b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/EnvironmentState.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..72aa00a955 --- /dev/null +++ b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/EnvironmentsState.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..eeaa27dbe5 --- /dev/null +++ b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/ExportEnvironmentState.md @@ -0,0 +1,47 @@ +# 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 new file mode 100644 index 0000000000..539115181d --- /dev/null +++ b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/IEnvironment.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 0000000000..1244cc9c0d --- /dev/null +++ b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/IInitialEnvironments.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..bc585d93d1 --- /dev/null +++ b/packages/altair-docs/api/types/state/environments.interfaces/interfaces/InitialEnvironmentState.md @@ -0,0 +1,23 @@ +# 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 new file mode 100644 index 0000000000..3173c9e83a --- /dev/null +++ b/packages/altair-docs/api/types/state/gql-schema.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..9d3ab6326a --- /dev/null +++ b/packages/altair-docs/api/types/state/gql-schema.interfaces/interfaces/GQLSchemaState.md @@ -0,0 +1,31 @@ +# 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 new file mode 100644 index 0000000000..626dc3c722 --- /dev/null +++ b/packages/altair-docs/api/types/state/header.interfaces/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..2f21bb8df1 --- /dev/null +++ b/packages/altair-docs/api/types/state/header.interfaces/interfaces/Header.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..38d9dece54 --- /dev/null +++ b/packages/altair-docs/api/types/state/header.interfaces/type-aliases/HeaderState.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..0c1a539c21 --- /dev/null +++ b/packages/altair-docs/api/types/state/history.interfaces/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..cdb03d51bd --- /dev/null +++ b/packages/altair-docs/api/types/state/history.interfaces/interfaces/History.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..3b310005b1 --- /dev/null +++ b/packages/altair-docs/api/types/state/history.interfaces/interfaces/HistoryState.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..b076a39d22 --- /dev/null +++ b/packages/altair-docs/api/types/state/layout.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..b4dbee86be --- /dev/null +++ b/packages/altair-docs/api/types/state/layout.interfaces/interfaces/LayoutState.md @@ -0,0 +1,31 @@ +# 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 new file mode 100644 index 0000000000..50677b9d06 --- /dev/null +++ b/packages/altair-docs/api/types/state/local.interfaces/index.md @@ -0,0 +1,9 @@ +# 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 new file mode 100644 index 0000000000..7b34ccd581 --- /dev/null +++ b/packages/altair-docs/api/types/state/local.interfaces/interfaces/LocalState.md @@ -0,0 +1,25 @@ +# 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 new file mode 100644 index 0000000000..1bb9e9a9f4 --- /dev/null +++ b/packages/altair-docs/api/types/state/local.interfaces/interfaces/V1PluginStateEntry.md @@ -0,0 +1,37 @@ +# 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 new file mode 100644 index 0000000000..9f5ad78e46 --- /dev/null +++ b/packages/altair-docs/api/types/state/local.interfaces/interfaces/V3PluginStateEntry.md @@ -0,0 +1,37 @@ +# 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 new file mode 100644 index 0000000000..ff6bccf25b --- /dev/null +++ b/packages/altair-docs/api/types/state/per-window.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..7dab178569 --- /dev/null +++ b/packages/altair-docs/api/types/state/per-window.interfaces/interfaces/PerWindowState.md @@ -0,0 +1,79 @@ +# 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 new file mode 100644 index 0000000000..c147a15899 --- /dev/null +++ b/packages/altair-docs/api/types/state/postrequest.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..dd8e164967 --- /dev/null +++ b/packages/altair-docs/api/types/state/postrequest.interfaces/interfaces/PostrequestState.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..87309f7aeb --- /dev/null +++ b/packages/altair-docs/api/types/state/prerequest.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..88b3f2f878 --- /dev/null +++ b/packages/altair-docs/api/types/state/prerequest.interfaces/interfaces/PrerequestState.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..ac4db1cece --- /dev/null +++ b/packages/altair-docs/api/types/state/query.interfaces/index.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..5c04210a8e --- /dev/null +++ b/packages/altair-docs/api/types/state/query.interfaces/interfaces/LogLine.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..c0eaecb2b3 --- /dev/null +++ b/packages/altair-docs/api/types/state/query.interfaces/interfaces/QueryEditorState.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..f8c295f315 --- /dev/null +++ b/packages/altair-docs/api/types/state/query.interfaces/interfaces/QueryState.md @@ -0,0 +1,169 @@ +# 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 new file mode 100644 index 0000000000..675b328782 --- /dev/null +++ b/packages/altair-docs/api/types/state/query.interfaces/interfaces/SubscriptionResponse.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..65be3c1738 --- /dev/null +++ b/packages/altair-docs/api/types/state/query.interfaces/type-aliases/HttpVerb.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..7447dee45c --- /dev/null +++ b/packages/altair-docs/api/types/state/query.interfaces/type-aliases/SelectedOperation.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..a9e3b008cd --- /dev/null +++ b/packages/altair-docs/api/types/state/query.interfaces/variables/HTTP_VERBS.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..e1a7650ab7 --- /dev/null +++ b/packages/altair-docs/api/types/state/settings.interfaces/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..3149d32c8e --- /dev/null +++ b/packages/altair-docs/api/types/state/settings.interfaces/interfaces/SettingsState.md @@ -0,0 +1,215 @@ +# 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 new file mode 100644 index 0000000000..a7e154a095 --- /dev/null +++ b/packages/altair-docs/api/types/state/settings.interfaces/type-aliases/SettingsLanguage.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..8103a086da --- /dev/null +++ b/packages/altair-docs/api/types/state/state.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..80ec369e92 --- /dev/null +++ b/packages/altair-docs/api/types/state/state.interfaces/interfaces/RootState.md @@ -0,0 +1,61 @@ +# 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 new file mode 100644 index 0000000000..78df8eaaa2 --- /dev/null +++ b/packages/altair-docs/api/types/state/stream.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..611f02156a --- /dev/null +++ b/packages/altair-docs/api/types/state/stream.interfaces/interfaces/StreamState.md @@ -0,0 +1,31 @@ +# 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 new file mode 100644 index 0000000000..86bde34672 --- /dev/null +++ b/packages/altair-docs/api/types/state/variable.interfaces/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..56bdb17c2d --- /dev/null +++ b/packages/altair-docs/api/types/state/variable.interfaces/interfaces/FileVariable.md @@ -0,0 +1,25 @@ +# 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 new file mode 100644 index 0000000000..2ab8341c3c --- /dev/null +++ b/packages/altair-docs/api/types/state/variable.interfaces/interfaces/VariableState.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..cccad8f169 --- /dev/null +++ b/packages/altair-docs/api/types/state/window.interfaces/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..220df734ea --- /dev/null +++ b/packages/altair-docs/api/types/state/window.interfaces/interfaces/ExportWindowState.md @@ -0,0 +1,114 @@ +# 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 new file mode 100644 index 0000000000..bf9614a72f --- /dev/null +++ b/packages/altair-docs/api/types/state/window.interfaces/interfaces/WindowState.md @@ -0,0 +1,5 @@ +# 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 new file mode 100644 index 0000000000..673616a7c1 --- /dev/null +++ b/packages/altair-docs/api/types/state/windows-meta.interfaces/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..ad5fe70492 --- /dev/null +++ b/packages/altair-docs/api/types/state/windows-meta.interfaces/interfaces/WindowsMetaState.md @@ -0,0 +1,67 @@ +# 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 new file mode 100644 index 0000000000..94b228c597 --- /dev/null +++ b/packages/altair-docs/api/types/state/workspace.interface/classes/WorkspaceId.md @@ -0,0 +1,65 @@ +# 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 new file mode 100644 index 0000000000..af75983c35 --- /dev/null +++ b/packages/altair-docs/api/types/state/workspace.interface/index.md @@ -0,0 +1,10 @@ +# 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 new file mode 100644 index 0000000000..1f1beadf01 --- /dev/null +++ b/packages/altair-docs/api/types/state/workspace.interface/interfaces/Workspace.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..a0b613c79e --- /dev/null +++ b/packages/altair-docs/api/types/state/workspace.interface/interfaces/WorkspacesState.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..3d0b57a4c5 --- /dev/null +++ b/packages/altair-docs/api/types/state/workspace.interface/variables/WORKSPACES.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..88467c5144 --- /dev/null +++ b/packages/altair-docs/api/utils/is_electron/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..937ae55495 --- /dev/null +++ b/packages/altair-docs/api/utils/is_electron/variables/default.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 0000000000..fce58ff5c6 --- /dev/null +++ b/packages/altair-docs/api/utils/logger/functions/createLogger.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..7e9801ad5a --- /dev/null +++ b/packages/altair-docs/api/utils/logger/index.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..e9318cbfbe --- /dev/null +++ b/packages/altair-docs/api/utils/logger/interfaces/ILogger.md @@ -0,0 +1,71 @@ +# 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 new file mode 100644 index 0000000000..8d06faea07 --- /dev/null +++ b/packages/altair-docs/api/utils/url/functions/urlWithParams.md @@ -0,0 +1,13 @@ +# 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 new file mode 100644 index 0000000000..bf5078248f --- /dev/null +++ b/packages/altair-docs/api/utils/url/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..4b2e1a977e --- /dev/null +++ b/packages/altair-docs/api/utils/value-object/classes/ValueObject.md @@ -0,0 +1,54 @@ +# `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 new file mode 100644 index 0000000000..3fc8a2cbae --- /dev/null +++ b/packages/altair-docs/api/utils/value-object/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..820a3b6fe9 --- /dev/null +++ b/packages/altair-docs/api/validate-partial-settings/functions/default.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..3970a7a2f7 --- /dev/null +++ b/packages/altair-docs/api/validate-partial-settings/index.md @@ -0,0 +1,7 @@ +# 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 new file mode 100644 index 0000000000..25b7d23624 --- /dev/null +++ b/packages/altair-docs/api/validate-settings/functions/default.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..146bc47418 --- /dev/null +++ b/packages/altair-docs/api/validate-settings/index.md @@ -0,0 +1,7 @@ +# validate-settings + +## Index + +| Member | Description | +| :------ | :------ | +| [default](functions/default.md) | - | diff --git a/packages/altair-docs/package.json b/packages/altair-docs/package.json index d2894006e5..cfa35a88ec 100644 --- a/packages/altair-docs/package.json +++ b/packages/altair-docs/package.json @@ -4,7 +4,7 @@ "license": "MIT", "scripts": { "dev": "vitepress dev", - "build": "vitepress build", + "build": "yarn --cwd ../../ typedoc && vitepress build", "preview": "vitepress preview", "prepare": "npm run build" }, @@ -13,6 +13,7 @@ "@octokit/rest": "^20.0.2", "@types/lodash.escaperegexp": "^4.1.9", "@types/lodash.sortby": "^4.7.9", + "altair-graphql-core": "^7.0.1", "inflection": "^3.0.0", "lodash.escaperegexp": "^4.1.2", "lodash.sortby": "^4.7.0", diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000000..9e0d42dafa --- /dev/null +++ b/typedoc.json @@ -0,0 +1,42 @@ +{ + // Comments are supported, like tsconfig.json + "entryPoints": ["packages/altair-core/src/*"], + "entryPointStrategy": "expand", + "out": "packages/altair-docs/api", + "docsRoot": "./packages/altair-docs", + "entryFileName": "index.md", + "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"], + "tsconfig": "packages/altair-core/tsconfig.json", + "exclude": [ + "**/node_modules/**", + "**/__tests__/**", + "**/__mocks__/**", + "**/__fixtures__/**", + "**/__snapshots", + "**/*+(index|.spec|.e2e).ts" + ], + "readme": "none", + "githubPages": false, + "indexFormat": "table", + "hideBreadcrumbs": true, + "expandParameters": true, + "useCodeBlocks": false, + "disableSources": true, + "textContentMappings": { + "title.indexPage": "API Reference", + "title.memberPage": "{name}" + }, + // "flattenOutputFiles": true, + "excludeGroups": true, + "excludePrivate": true, + "excludeReferences": true, + "excludeInternal": true, + // "excludeNotDocumented": true, + + "sidebar": { + "autoConfiguration": true, + "format": "vitepress", + "pretty": true, + "collapsed": true + } +} diff --git a/yarn.lock b/yarn.lock index 0395854e2a..28aace4a00 100644 --- a/yarn.lock +++ b/yarn.lock @@ -10596,6 +10596,11 @@ ansi-regex@^6.0.1: resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.0.1.tgz#3183e38fae9a65d7cb5e53945cd5897d0260a06a" integrity sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA== +ansi-sequence-parser@^1.1.0: + version "1.1.1" + resolved "https://registry.yarnpkg.com/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz#e0aa1cdcbc8f8bb0b5bca625aac41f5f056973cf" + integrity sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg== + ansi-styles@^2.2.1: version "2.2.1" resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe" @@ -22970,6 +22975,11 @@ jsonc-parser@3.2.0: resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.0.tgz#31ff3f4c2b9793f89c67212627c51c6394f88e76" integrity sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w== +jsonc-parser@^3.2.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.1.tgz#031904571ccf929d7670ee8c547545081cb37f1a" + integrity sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA== + jsonfile@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-3.0.1.tgz#a5ecc6f65f53f662c4415c7675a0331d0992ec66" @@ -23926,6 +23936,11 @@ lucide-angular@^0.298.0: dependencies: tslib "^2.3.0" +lunr@^2.3.9: + version "2.3.9" + resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1" + integrity sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow== + macos-release@^2.5.0: version "2.5.0" resolved "https://registry.yarnpkg.com/macos-release/-/macos-release-2.5.0.tgz#067c2c88b5f3fb3c56a375b2ec93826220fa1ff2" @@ -24172,7 +24187,7 @@ markdown-toc@^1.2.0: repeat-string "^1.6.1" strip-color "^0.1.0" -marked@^4.0.17, marked@^4.0.19: +marked@^4.0.17, marked@^4.0.19, marked@^4.3.0: version "4.3.0" resolved "https://registry.yarnpkg.com/marked/-/marked-4.3.0.tgz#796362821b019f734054582038b116481b456cf3" integrity sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A== @@ -30828,6 +30843,16 @@ shellwords@^0.1.1: resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.1.tgz#d6b9181c1a48d397324c84871efbcfc73fc0654b" integrity sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww== +shiki@^0.14.7: + version "0.14.7" + resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.14.7.tgz#c3c9e1853e9737845f1d2ef81b31bcfb07056d4e" + integrity sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg== + dependencies: + ansi-sequence-parser "^1.1.0" + jsonc-parser "^3.2.0" + vscode-oniguruma "^1.7.0" + vscode-textmate "^8.0.0" + shikiji-core@0.9.19, shikiji-core@^0.9.19: version "0.9.19" resolved "https://registry.yarnpkg.com/shikiji-core/-/shikiji-core-0.9.19.tgz#227975e998eb2a579cf83de30977762be3802507" @@ -33163,6 +33188,26 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c= +typedoc-plugin-markdown@^4.0.3: + version "4.0.3" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.0.3.tgz#c452a654f6e66ea911eb80a6a03ebe85a32a3065" + integrity sha512-0tZbeVGGCd4+lpoIX+yHWgUfyaLZCQCgJOpuVdTtOtD3+jKaedJ4sl/tkNaYBPeWVKiyDkSHfGuHkq53jlzIFg== + +typedoc-vitepress-theme@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/typedoc-vitepress-theme/-/typedoc-vitepress-theme-1.0.0.tgz#362af92d9be44a0233b3b4f8111b3d41029c540c" + integrity sha512-tkPQBVvzukxMpHVIpTuOviyR6QJoSRhoYV0JcZX6NzAJU+CD8eEA+Xrc7a4UYPncL8oznzn8KaLsxQz7yVSvjg== + +typedoc@^0.25.13: + version "0.25.13" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.25.13.tgz#9a98819e3b2d155a6d78589b46fa4c03768f0922" + integrity sha512-pQqiwiJ+Z4pigfOnnysObszLiU3mVLWAExSPf+Mu06G/qsc3wzbuM56SZQvONhHLncLUhYzOVkjFFpFfL5AzhQ== + dependencies: + lunr "^2.3.9" + marked "^4.3.0" + minimatch "^9.0.3" + shiki "^0.14.7" + typescript-json-schema@0.50.1: version "0.50.1" resolved "https://registry.yarnpkg.com/typescript-json-schema/-/typescript-json-schema-0.50.1.tgz#48041eb9f6efbdf4ba88c3e3af9433601f7a2b47" @@ -33991,6 +34036,16 @@ vscode-languageserver-types@^3.17.1: resolved "https://registry.yarnpkg.com/vscode-languageserver-types/-/vscode-languageserver-types-3.17.5.tgz#3273676f0cf2eab40b3f44d085acbb7f08a39d8a" integrity sha512-Ld1VelNuX9pdF39h2Hgaeb5hEZM2Z3jUrrMgWQAu82jMtZp7p3vJT3BzToKtZI7NgQssZje5o0zryOrhQvzQAg== +vscode-oniguruma@^1.7.0: + version "1.7.0" + resolved "https://registry.yarnpkg.com/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz#439bfad8fe71abd7798338d1cd3dc53a8beea94b" + integrity sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA== + +vscode-textmate@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-8.0.0.tgz#2c7a3b1163ef0441097e0b5d6389cd5504b59e5d" + integrity sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg== + vue-demi@>=0.14.6: version "0.14.6" resolved "https://registry.yarnpkg.com/vue-demi/-/vue-demi-0.14.6.tgz#dc706582851dc1cdc17a0054f4fec2eb6df74c92"