Merge pull request #40 from ferreira-tb:ferreira-tb/issue39

feat: add `relations` field to `POST /vn`.

README.md

@@ -26,11 +26,11 @@ console.log(results);
 
 ## Documentation
 
-To check out docs, visit [tb.dev.br/vndb-query](https://tb.dev.br/vndb-query/guide/introduction.html).
+Read the [documentation](https://tb.dev.br/vndb-query/guide/introduction.html) for more details.
 
 ## Playground
 
-You can play with VNDB Query in the [playground](https://jsfiddle.net/ferreiratb/0Lezvkfa/27/).
+You can test VNDB Query in the [playground](https://jsfiddle.net/ferreiratb/0Lezvkfa/27/).
 
 ## License
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vndb-query",
-	"version": "1.6.1",
+	"version": "1.7.0",
 	"description": "VNDB HTTPS API with custom query builder",
 	"type": "module",
 	"private": false,

types/index.ts

@@ -6,6 +6,7 @@ export * from './request';
 
 export type MaybeArray<T> = T | T[];
 export type MaybePromise<T> = T | Promise<T>;
+export type Nullable<T> = T | null | undefined;
 
 export type VNDBConstructorOptions = Partial<Pick<RequestWithToken, 'token'>>;
 

types/response.ts

@@ -102,6 +102,13 @@ export type ResponsePostVisualNovelTag = ResponsePostTag & {
 	lie?: boolean;
 };
 
+export type ResponsePostVisualNovelRelations = ResponsePostVisualNovel & {
+	/** Relation type. */
+	relation?: string;
+	/** Whether this VN relation is official. */
+	relation_official?: boolean;
+};
+
 /** @see https://api.vndb.org/kana#vn-fields */
 export type ResponsePostVisualNovel = {
 	id: string;
@@ -145,6 +152,8 @@ export type ResponsePostVisualNovel = {
 	/** Number of votes. */
 	votecount?: number;
 	screenshots?: ResponsePostVisualNovelScreenshot[];
+	/** List of VNs directly related to this entry. */
+	relations?: ResponsePostVisualNovelRelations[];
 	/** Only directly applied tags are returned, parent tags are not included. */
 	tags?: ResponsePostVisualNovelTag[];
 	/**