Add CWL

Author: kaimoe

XIVAPI.js

@@ -4,6 +4,7 @@ const resources = require('./resources/'),
 	Character = require('./lib/character'),
 	FreeCompany = require('./lib/freecompany'),
 	Linkshell = require('./lib/linkshell'),
+	CWL = require('./lib/cwl'),
 	PvPTeam = require('./lib/pvpteam')
 
 class XIVAPI {
@@ -49,6 +50,7 @@ See how in https://github.com/xivapi/xivapi-js/releases/tag/v0.1.3.\n\
 		this.character = new Character(this)
 		this.freecompany = new FreeCompany(this)
 		this.linkshell = new Linkshell(this)
+		this.cwl = new CWL(this)
 		this.pvpteam = new PvPTeam(this)
 	}
 }

lib/cwl.js

@@ -0,0 +1,28 @@
+// https://xivapi.com/docs/Linkshell
+const Lib = require('./Lib')
+
+class CWL extends Lib {
+	constructor(parent) {
+		super(parent)
+	}
+
+	/*
+	{
+		server	string	optional
+		page		int			optional
+	}
+	*/
+	async search(name, params={}) {
+		if(typeof(name) === 'undefined')
+			throw this.throwError('cwl.search()','a name')
+		return this.req('/linkshell/crossworld/search', Object.assign(params, {name}))
+	}
+
+	async get(id) {
+		if(typeof(id) === 'undefined')
+			throw this.throwError('cwl.get()', 'an ID')
+		return this.req(`/linkshell/crossworld/${id}`)
+	}
+}
+
+module.exports = CWL

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@xivapi/js",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "A Node.JS wrapper for xivapi.com",
   "main": "XIVAPI.js",
   "directories": {

package.json

@@ -10,6 +10,9 @@ import {
   LinkshellGetResult,
   LinkshellSearchParams,
   LinkshellSearchResult,
+  CWLGetResult,
+  CWLSearchParams,
+  CWLSearchResult,
   PvPTeamGetResult,
   PvPTeamSearchParams,
   PvPTeamSearchResult,
@@ -194,6 +197,16 @@ declare module "@xivapi/js" {
       get: (id: string | number) => Promise<LinkshellGetResult>;
     };
 
+    /**
+     * Search and retrieve CWL data from The Lodestone.
+     * @since 0.4.4
+     * @see https://xivapi.com/docs/Linkshell
+     */
+    public cwl: {
+      search: (name: string, params?: CWLSearchParams) => Promise<CWLSearchResult>;
+      get: (id: string | number) => Promise<CWLGetResult>;
+    };
+
     /**
      * Search and retrieve PVP Team data from The Lodestone.
      * @since 0.4.2

typings/index.d.ts

@@ -0,0 +1,24 @@
+import { CharacterSearchResult } from "./character";
+import { SearchParams, SearchResult } from "./search";
+
+export interface CWLSearchParams extends SearchParams {}
+
+export interface CWLSearchResult extends SearchResult {
+  Results: {
+    Crest: string[];
+    ID: string;
+    Name: string;
+    Server: string;
+  }[];
+}
+
+export interface CWLGetResult {
+  CWL: {
+    ID: string;
+    Pagination: SearchResult["Pagination"];
+    Profile: {
+      Name: string;
+    };
+    Results: CharacterSearchResult["Results"];
+  };
+}

typings/utils/cwl.ts

@@ -1,5 +1,6 @@
 export * from "./character";
 export * from "./freecompany";
 export * from "./linkshell";
+export * from "./cwl";
 export * from "./pvpteam";
 export * from "./search";