added generated docs from code

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"

packages/altair-docs/.gitignore

@@ -1,2 +1,3 @@
 .vitepress/cache
 .vitepress/dist
+.vitepress/.temp

packages/altair-docs/.vitepress/config.mts

@@ -1,65 +1,60 @@
-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',
       {},
       `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,27 +106,28 @@ 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 }) {
     // Skip the 404 page
     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',
-  }
-})
+  },
+});

packages/altair-docs/api/authorization/authorization-provider/classes/AuthorizationProvider.md

@@ -0,0 +1,54 @@
+# `abstract` AuthorizationProvider\<T\>
+
+## 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`

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) | - |

packages/altair-docs/api/authorization/authorization-provider/interfaces/AuthorizationProviderExecuteOptions.md

@@ -0,0 +1,11 @@
+# AuthorizationProviderExecuteOptions\<T\>
+
+## Type parameters
+
+• **T** = `unknown`
+
+## Properties
+
+### data
+
+> **data**: `T`

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)

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) | - |

packages/altair-docs/api/authorization/providers/api-key/interfaces/ApiKeyAuthorizationProviderData.md

@@ -0,0 +1,13 @@
+# ApiKeyAuthorizationProviderData
+
+## Properties
+
+### key
+
+> **key**: `string`
+
+***
+
+### value
+
+> **value**: `string`

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)

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) | - |

packages/altair-docs/api/authorization/providers/basic/interfaces/BasicAuthorizationProviderData.md

@@ -0,0 +1,13 @@
+# BasicAuthorizationProviderData
+
+## Properties
+
+### password
+
+> **password**: `string`
+
+***
+
+### username
+
+> **username**: `string`