diff --git a/docs/README.md b/docs/README.md index d981c4b4..3d90cfef 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,7 +16,7 @@ graphql-lambda-subscriptions - [SubscribePseudoIterable](interfaces/SubscribePseudoIterable.md) - [SubscriptionServer](interfaces/SubscriptionServer.md) -### Type aliases +### Type Aliases - [LoggerFunction](README.md#loggerfunction) - [MaybePromise](README.md#maybepromise) @@ -29,7 +29,7 @@ graphql-lambda-subscriptions - [makeServer](README.md#makeserver) - [subscribe](README.md#subscribe) -## Type aliases +## Type Aliases ### LoggerFunction @@ -109,7 +109,7 @@ ___ ### makeServer -▸ `Const` **makeServer**(`opts`): [`SubscriptionServer`](interfaces/SubscriptionServer.md) +▸ **makeServer**(`opts`): [`SubscriptionServer`](interfaces/SubscriptionServer.md) #### Parameters @@ -125,7 +125,7 @@ ___ ### subscribe -▸ `Const` **subscribe**<`T`, `TRoot`, `TArgs`, `TContext`\>(`topic`, `options?`): [`SubscribePseudoIterable`](interfaces/SubscribePseudoIterable.md)<`T`, [`SubscribeArgs`](README.md#subscribeargs)<`TRoot`, `TArgs`, `TContext`\>\> +▸ **subscribe**<`T`, `TRoot`, `TArgs`, `TContext`\>(`topic`, `options?`): [`SubscribePseudoIterable`](interfaces/SubscribePseudoIterable.md)<`T`, [`SubscribeArgs`](README.md#subscribeargs)<`TRoot`, `TArgs`, `TContext`\>\> Creates subscribe handler for use in your graphql schema. diff --git a/docs/interfaces/ApiGatewayManagementApiSubset.md b/docs/interfaces/ApiGatewayManagementApiSubset.md index 7c3aaf65..4d1e40e8 100644 --- a/docs/interfaces/ApiGatewayManagementApiSubset.md +++ b/docs/interfaces/ApiGatewayManagementApiSubset.md @@ -28,7 +28,7 @@ | Name | Type | | :------ | :------ | -| `promise` | () => `Promise`<`void`\> | +| `promise` | () => `Promise`<`any`\> | ___ @@ -50,4 +50,4 @@ ___ | Name | Type | | :------ | :------ | -| `promise` | () => `Promise`<`void`\> | +| `promise` | () => `Promise`<`any`\> | diff --git a/docs/interfaces/ServerArgs.md b/docs/interfaces/ServerArgs.md index fdd07b5e..d2ed9bef 100644 --- a/docs/interfaces/ServerArgs.md +++ b/docs/interfaces/ServerArgs.md @@ -10,18 +10,15 @@ - [context](ServerArgs.md#context) - [dynamodb](ServerArgs.md#dynamodb) - [log](ServerArgs.md#log) -- [pingpong](ServerArgs.md#pingpong) -- [schema](ServerArgs.md#schema) -- [tableNames](ServerArgs.md#tablenames) - -### Methods - - [onConnect](ServerArgs.md#onconnect) - [onConnectionInit](ServerArgs.md#onconnectioninit) - [onDisconnect](ServerArgs.md#ondisconnect) - [onError](ServerArgs.md#onerror) - [onPing](ServerArgs.md#onping) - [onPong](ServerArgs.md#onpong) +- [pingpong](ServerArgs.md#pingpong) +- [schema](ServerArgs.md#schema) +- [tableNames](ServerArgs.md#tablenames) ## Properties @@ -55,52 +52,22 @@ Defaults to debug('graphql-lambda-subscriptions') from https://www.npmjs.com/pac ___ -### pingpong - -• `Optional` **pingpong**: [`MaybePromise`](../README.md#maybepromise)<{ `delay`: `number` ; `machine`: `string` ; `timeout`: `number` }\> - -If set you can use the `stepFunctionsHandler` and a step function to setup a per connection ping/pong cycle to detect disconnects sooner than the 10 minute idle timeout. - -___ - -### schema - -• **schema**: `GraphQLSchema` - -A GraphQL Schema with resolvers - -You can use `makeExecutableSchema` from [`@graphql-tools/schema`](https://www.npmjs.com/package/@graphql-tools/schema), or `makeSchema` from [`nexus`](https://nexusjs.org/) - -```ts -import { makeExecutableSchema } from '@graphql-tools/schema -// or -import { makeSchema } from 'nexus' -``` - -___ - -### tableNames - -• `Optional` **tableNames**: [`MaybePromise`](../README.md#maybepromise)<{ `connections?`: `string` ; `subscriptions?`: `string` }\> - -An optional object or a promise for an object with DDB table names. - -Defaults to `{ connections: 'graphql_connections', subscriptions: 'graphql_subscriptions' }` +### onConnect -## Methods +• `Optional` **onConnect**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) }) => [`MaybePromise`](../README.md#maybepromise)<`void`\> -### onConnect +#### Type declaration -▸ `Optional` **onConnect**(`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `e` | `Object` | | `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> @@ -108,9 +75,13 @@ ___ ### onConnectionInit -▸ `Optional` **onConnectionInit**(`e`): [`MaybePromise`](../README.md#maybepromise)<`Record`<`string`, `any`\>\> +• `Optional` **onConnectionInit**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) ; `message`: `ConnectionInitMessage` }) => [`MaybePromise`](../README.md#maybepromise)<`Record`<`string`, `any`\>\> + +#### Type declaration + +▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`Record`<`string`, `any`\>\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | @@ -118,7 +89,7 @@ ___ | `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) | | `e.message` | `ConnectionInitMessage` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`Record`<`string`, `any`\>\> @@ -126,16 +97,20 @@ ___ ### onDisconnect -▸ `Optional` **onDisconnect**(`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +• `Optional` **onDisconnect**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) }) => [`MaybePromise`](../README.md#maybepromise)<`void`\> -#### Parameters +#### Type declaration + +▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\> + +##### Parameters | Name | Type | | :------ | :------ | | `e` | `Object` | | `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> @@ -143,16 +118,20 @@ ___ ### onError -▸ `Optional` **onError**(`error`, `context`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +• `Optional` **onError**: (`error`: `any`, `context`: `any`) => [`MaybePromise`](../README.md#maybepromise)<`void`\> + +#### Type declaration -#### Parameters +▸ (`error`, `context`): [`MaybePromise`](../README.md#maybepromise)<`void`\> + +##### Parameters | Name | Type | | :------ | :------ | | `error` | `any` | | `context` | `any` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> @@ -160,9 +139,13 @@ ___ ### onPing -▸ `Optional` **onPing**(`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +• `Optional` **onPing**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) ; `message`: `PingMessage` }) => [`MaybePromise`](../README.md#maybepromise)<`void`\> + +#### Type declaration + +▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | @@ -170,7 +153,7 @@ ___ | `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) | | `e.message` | `PingMessage` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> @@ -178,9 +161,13 @@ ___ ### onPong -▸ `Optional` **onPong**(`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +• `Optional` **onPong**: (`e`: { `event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) ; `message`: `PongMessage` }) => [`MaybePromise`](../README.md#maybepromise)<`void`\> -#### Parameters +#### Type declaration + +▸ (`e`): [`MaybePromise`](../README.md#maybepromise)<`void`\> + +##### Parameters | Name | Type | | :------ | :------ | @@ -188,6 +175,40 @@ ___ | `e.event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) | | `e.message` | `PongMessage` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> + +___ + +### pingpong + +• `Optional` **pingpong**: [`MaybePromise`](../README.md#maybepromise)<{ `delay`: `number` ; `machine`: `string` ; `timeout`: `number` }\> + +If set you can use the `stepFunctionsHandler` and a step function to setup a per connection ping/pong cycle to detect disconnects sooner than the 10 minute idle timeout. + +___ + +### schema + +• **schema**: `GraphQLSchema` + +A GraphQL Schema with resolvers + +You can use `makeExecutableSchema` from [`@graphql-tools/schema`](https://www.npmjs.com/package/@graphql-tools/schema), or `makeSchema` from [`nexus`](https://nexusjs.org/) + +```ts +import { makeExecutableSchema } from '@graphql-tools/schema +// or +import { makeSchema } from 'nexus' +``` + +___ + +### tableNames + +• `Optional` **tableNames**: [`MaybePromise`](../README.md#maybepromise)<{ `connections?`: `string` ; `subscriptions?`: `string` }\> + +An optional object or a promise for an object with DDB table names. + +Defaults to `{ connections: 'graphql_connections', subscriptions: 'graphql_subscriptions' }` diff --git a/docs/interfaces/StateFunctionInput.md b/docs/interfaces/StateFunctionInput.md index 1b5af1ad..79d0e3f8 100644 --- a/docs/interfaces/StateFunctionInput.md +++ b/docs/interfaces/StateFunctionInput.md @@ -40,4 +40,4 @@ ___ ### state -• **state**: ``"PING"`` \| ``"REVIEW"`` \| ``"ABORT"`` +• **state**: ``"ABORT"`` \| ``"PING"`` \| ``"REVIEW"`` diff --git a/docs/interfaces/SubscribeOptions.md b/docs/interfaces/SubscribeOptions.md index 08b92823..0b70a967 100644 --- a/docs/interfaces/SubscribeOptions.md +++ b/docs/interfaces/SubscribeOptions.md @@ -14,9 +14,6 @@ ### Properties - [filter](SubscribeOptions.md#filter) - -### Methods - - [onAfterSubscribe](SubscribeOptions.md#onaftersubscribe) - [onComplete](SubscribeOptions.md#oncomplete) - [onSubscribe](SubscribeOptions.md#onsubscribe) @@ -29,21 +26,25 @@ An object or a function that returns an object that will be matched against the `payload` of a published event. If the payload's field equals the filter the subscription will receive the event. If the payload is missing the filter's field the subscription will receive the event. -## Methods +___ ### onAfterSubscribe -▸ `Optional` **onAfterSubscribe**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +• `Optional` **onAfterSubscribe**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void`\> + +#### Type declaration + +▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\> Gets resolver arguments to perform work after a subscription saved. This is useful for sending out initial events. -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `...args` | `TSubscribeArgs` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> @@ -51,19 +52,23 @@ ___ ### onComplete -▸ `Optional` **onComplete**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +• `Optional` **onComplete**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void`\> + +#### Type declaration + +▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\> Called at least once. Gets resolver arguments to perform work after a subscription has ended. This is useful for bookkeeping or logging. This callback will fire If the client disconnects, sends a `complete` message, or the server sends a `complete` message via the pub/sub system. Because of the nature of aws lambda, it's possible for a client to send a "complete" message immediately disconnect and have those events execute on lambda out of order. Which why this function can be called up to twice. -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `...args` | `TSubscribeArgs` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> @@ -71,17 +76,21 @@ ___ ### onSubscribe -▸ `Optional` **onSubscribe**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\> +• `Optional` **onSubscribe**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\> + +#### Type declaration + +▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\> Gets resolver arguments to perform work before a subscription is allowed. This is useful for checking arguments or validating permissions. Return an array of GraphqlErrors if you don't want the subscription to subscribe. -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `...args` | `TSubscribeArgs` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\> diff --git a/docs/interfaces/SubscribePseudoIterable.md b/docs/interfaces/SubscribePseudoIterable.md index fd0c52fc..be5fcb6b 100644 --- a/docs/interfaces/SubscribePseudoIterable.md +++ b/docs/interfaces/SubscribePseudoIterable.md @@ -30,13 +30,10 @@ ### Properties - [filter](SubscribePseudoIterable.md#filter) -- [topic](SubscribePseudoIterable.md#topic) - -### Methods - - [onAfterSubscribe](SubscribePseudoIterable.md#onaftersubscribe) - [onComplete](SubscribePseudoIterable.md#oncomplete) - [onSubscribe](SubscribePseudoIterable.md#onsubscribe) +- [topic](SubscribePseudoIterable.md#topic) ## Properties @@ -46,23 +43,21 @@ ___ -### topic - -• **topic**: `string` +### onAfterSubscribe -## Methods +• `Optional` **onAfterSubscribe**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void`\> -### onAfterSubscribe +#### Type declaration -▸ `Optional` **onAfterSubscribe**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `...args` | `TSubscribeArgs` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> @@ -70,15 +65,19 @@ ___ ### onComplete -▸ `Optional` **onComplete**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\> +• `Optional` **onComplete**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void`\> -#### Parameters +#### Type declaration + +▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void`\> + +##### Parameters | Name | Type | | :------ | :------ | | `...args` | `TSubscribeArgs` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void`\> @@ -86,14 +85,24 @@ ___ ### onSubscribe -▸ `Optional` **onSubscribe**(...`args`): [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\> +• `Optional` **onSubscribe**: (...`args`: `TSubscribeArgs`) => [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\> -#### Parameters +#### Type declaration + +▸ (...`args`): [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `...args` | `TSubscribeArgs` | -#### Returns +##### Returns [`MaybePromise`](../README.md#maybepromise)<`void` \| `GraphQLError`[]\> + +___ + +### topic + +• **topic**: `string` diff --git a/docs/interfaces/SubscriptionServer.md b/docs/interfaces/SubscriptionServer.md index 810a4fc4..f8fb4cc0 100644 --- a/docs/interfaces/SubscriptionServer.md +++ b/docs/interfaces/SubscriptionServer.md @@ -4,24 +4,28 @@ ## Table of contents -### Methods +### Properties - [complete](SubscriptionServer.md#complete) - [publish](SubscriptionServer.md#publish) - [stepFunctionsHandler](SubscriptionServer.md#stepfunctionshandler) - [webSocketHandler](SubscriptionServer.md#websockethandler) -## Methods +## Properties ### complete -▸ **complete**(`event`): `Promise`<`void`\> +• **complete**: (`event`: { `payload?`: `Record`<`string`, `any`\> ; `topic`: `string` }) => `Promise`<`void`\> + +#### Type declaration + +▸ (`event`): `Promise`<`void`\> Send a complete message and end all relevant subscriptions. This might take some time depending on how many subscriptions there are. The payload if present will be used to match against any filters the subscriptions might have. -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | @@ -29,7 +33,7 @@ The payload if present will be used to match against any filters the subscriptio | `event.payload?` | `Record`<`string`, `any`\> | | `event.topic` | `string` | -#### Returns +##### Returns `Promise`<`void`\> @@ -37,13 +41,17 @@ ___ ### publish -▸ **publish**(`event`): `Promise`<`void`\> +• **publish**: (`event`: { `payload`: `Record`<`string`, `any`\> ; `topic`: `string` }) => `Promise`<`void`\> + +#### Type declaration + +▸ (`event`): `Promise`<`void`\> Publish an event to all relevant subscriptions. This might take some time depending on how many subscriptions there are. The payload if present will be used to match against any filters the subscriptions might have. -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | @@ -51,7 +59,7 @@ The payload if present will be used to match against any filters the subscriptio | `event.payload` | `Record`<`string`, `any`\> | | `event.topic` | `string` | -#### Returns +##### Returns `Promise`<`void`\> @@ -59,17 +67,21 @@ ___ ### stepFunctionsHandler -▸ **stepFunctionsHandler**(`input`): `Promise`<[`StateFunctionInput`](StateFunctionInput.md)\> +• **stepFunctionsHandler**: (`input`: [`StateFunctionInput`](StateFunctionInput.md)) => `Promise`<[`StateFunctionInput`](StateFunctionInput.md)\> + +#### Type declaration + +▸ (`input`): `Promise`<[`StateFunctionInput`](StateFunctionInput.md)\> The handler for your step functions powered ping/pong support -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `input` | [`StateFunctionInput`](StateFunctionInput.md) | -#### Returns +##### Returns `Promise`<[`StateFunctionInput`](StateFunctionInput.md)\> @@ -77,16 +89,20 @@ ___ ### webSocketHandler -▸ **webSocketHandler**(`event`): `Promise`<[`WebSocketResponse`](../README.md#websocketresponse)\> +• **webSocketHandler**: (`event`: [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md)) => `Promise`<[`WebSocketResponse`](../README.md#websocketresponse)\> + +#### Type declaration + +▸ (`event`): `Promise`<[`WebSocketResponse`](../README.md#websocketresponse)\> The handler for your websocket functions -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `event` | [`APIGatewayWebSocketEvent`](APIGatewayWebSocketEvent.md) | -#### Returns +##### Returns `Promise`<[`WebSocketResponse`](../README.md#websocketresponse)\> diff --git a/lib/pubsub/subscribe.ts b/lib/pubsub/subscribe.ts index af01f3d4..22d5f2d7 100644 --- a/lib/pubsub/subscribe.ts +++ b/lib/pubsub/subscribe.ts @@ -4,7 +4,7 @@ import { PubSubEvent, SubscribeArgs, SubscribeOptions, SubscribePseudoIterable } /** * Creates subscribe handler for use in your graphql schema. * - * `subscribe` is the most important method in the library. It is the primary difference between `graphql-ws` and `graphql-lambda-subscriptions`. It returns a [[SubscribePseudoIterable]] that pretends to be an async iterator that you put on the `subscribe` resolver for your Subscription. In reality it includes a few properties that we use to subscribe to events and fire lifecycle functions. See [[SubscribeOptions]] for information about the callbacks. + * `subscribe` is the most important method in the library. It is the primary difference between `graphql-ws` and `graphql-lambda-subscriptions`. It returns a {@link SubscribePseudoIterable} that pretends to be an async iterator that you put on the `subscribe` resolver for your Subscription. In reality it includes a few properties that we use to subscribe to events and fire lifecycle functions. See {@link SubscribeOptions} for information about the callbacks. * * @param topic - Subscriptions are made to a `string` topic and can be filtered based upon the topics payload. * @param options - Optional callbacks for filtering, and lifecycle events. diff --git a/lib/types.ts b/lib/types.ts index c696585e..e26c6123 100644 --- a/lib/types.ts +++ b/lib/types.ts @@ -34,7 +34,7 @@ export interface ServerArgs { subscriptions?: string }> /** - * Makes the context object for all operations defaults to { connectionInitPayload, connectionId } + * Makes the context object for all operations defaults to \{ connectionInitPayload, connectionId \} */ context?: ((arg: { connectionInitPayload: any, connectionId: string, publish: SubscriptionServer['publish'], complete: SubscriptionServer['complete'] }) => MaybePromise) | object /** diff --git a/package-lock.json b/package-lock.json index 47ed4a2a..f2774687 100644 --- a/package-lock.json +++ b/package-lock.json @@ -42,8 +42,8 @@ "rollup": "2.77.2", "rollup-plugin-node-resolve": "5.2.0", "semantic-release": "19.0.3", - "typedoc": "0.22.18", - "typedoc-plugin-markdown": "3.11.14", + "typedoc": "0.23.9", + "typedoc-plugin-markdown": "3.13.4", "typescript": "4.7.4", "ws": "8.8.1" }, @@ -10402,12 +10402,11 @@ } }, "node_modules/typedoc": { - "version": "0.22.18", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.22.18.tgz", - "integrity": "sha512-NK9RlLhRUGMvc6Rw5USEYgT4DVAUFk7IF7Q6MYfpJ88KnTZP7EneEa4RcP+tX1auAcz7QT1Iy0bUSZBYYHdoyA==", + "version": "0.23.9", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.23.9.tgz", + "integrity": "sha512-rvWci2KHwteVUufZjjtIy/4PIHiE66t4VW4Ob6pezV//GHZ9Px0CHE5iq032GZzKONJWnNb+EJsrQv32INRvxA==", "dev": true, "dependencies": { - "glob": "^8.0.3", "lunr": "^2.3.9", "marked": "^4.0.16", "minimatch": "^5.1.0", @@ -10417,22 +10416,22 @@ "typedoc": "bin/typedoc" }, "engines": { - "node": ">= 12.10.0" + "node": ">= 14.14" }, "peerDependencies": { - "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x || 4.5.x || 4.6.x || 4.7.x" + "typescript": "4.6.x || 4.7.x" } }, "node_modules/typedoc-plugin-markdown": { - "version": "3.11.14", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.11.14.tgz", - "integrity": "sha512-lh47OQvl0079nB18YL9wuTRRhMpjo300SZKfx/xpQY8qG+GINeSxTod95QBELeI0NP81sNtUbemRDrn5nyef4Q==", + "version": "3.13.4", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.13.4.tgz", + "integrity": "sha512-E/EBBmu6ARtnbswZGtBVBB/BfukZiGMOlqPc0RXCI/NFitONBahFqbCAF5fKQlijlcfipJj5pw5AMFH3NytrAw==", "dev": true, "dependencies": { "handlebars": "^4.7.7" }, "peerDependencies": { - "typedoc": ">=0.22.0" + "typedoc": ">=0.23.0" } }, "node_modules/typedoc/node_modules/brace-expansion": { @@ -10444,25 +10443,6 @@ "balanced-match": "^1.0.0" } }, - "node_modules/typedoc/node_modules/glob": { - "version": "8.0.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-8.0.3.tgz", - "integrity": "sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ==", - "dev": true, - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^5.0.1", - "once": "^1.3.0" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/typedoc/node_modules/minimatch": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.0.tgz", @@ -18631,12 +18611,11 @@ } }, "typedoc": { - "version": "0.22.18", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.22.18.tgz", - "integrity": "sha512-NK9RlLhRUGMvc6Rw5USEYgT4DVAUFk7IF7Q6MYfpJ88KnTZP7EneEa4RcP+tX1auAcz7QT1Iy0bUSZBYYHdoyA==", + "version": "0.23.9", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.23.9.tgz", + "integrity": "sha512-rvWci2KHwteVUufZjjtIy/4PIHiE66t4VW4Ob6pezV//GHZ9Px0CHE5iq032GZzKONJWnNb+EJsrQv32INRvxA==", "dev": true, "requires": { - "glob": "^8.0.3", "lunr": "^2.3.9", "marked": "^4.0.16", "minimatch": "^5.1.0", @@ -18652,19 +18631,6 @@ "balanced-match": "^1.0.0" } }, - "glob": { - "version": "8.0.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-8.0.3.tgz", - "integrity": "sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ==", - "dev": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^5.0.1", - "once": "^1.3.0" - } - }, "minimatch": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.0.tgz", @@ -18677,9 +18643,9 @@ } }, "typedoc-plugin-markdown": { - "version": "3.11.14", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.11.14.tgz", - "integrity": "sha512-lh47OQvl0079nB18YL9wuTRRhMpjo300SZKfx/xpQY8qG+GINeSxTod95QBELeI0NP81sNtUbemRDrn5nyef4Q==", + "version": "3.13.4", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.13.4.tgz", + "integrity": "sha512-E/EBBmu6ARtnbswZGtBVBB/BfukZiGMOlqPc0RXCI/NFitONBahFqbCAF5fKQlijlcfipJj5pw5AMFH3NytrAw==", "dev": true, "requires": { "handlebars": "^4.7.7" diff --git a/package.json b/package.json index 434e2349..1f59a1e6 100644 --- a/package.json +++ b/package.json @@ -71,8 +71,8 @@ "rollup": "2.77.2", "rollup-plugin-node-resolve": "5.2.0", "semantic-release": "19.0.3", - "typedoc": "0.22.18", - "typedoc-plugin-markdown": "3.11.14", + "typedoc": "0.23.9", + "typedoc-plugin-markdown": "3.13.4", "typescript": "4.7.4", "ws": "8.8.1" },