Added url param to options and added logic to get title from url

README.md

@@ -62,9 +62,17 @@ const wiki = require('wikipedia');
 	}
 })();
 ```
+
+You can also pass a valid wikipedia url instead of a string by using the url parameters in [pageOptions][10] like this. If you use an url without the url option it will fail.
+```js
+    const page = await wiki.page('https://en.wikipedia.org/wiki/Batman',{url:true});
+    console.log(page);
+    //Response will be the same as passing a string
+```
+
 The page method returns a [Page][2] class object which has fields like `pageid`, `title`, `parentid`, `revisionid` and methods like `summary()`, `intro()`, `images()`, `html()` and more.
 
-All the page methods can take a title parameter or a pageId. Read up on the [Page documentation][2] here to see a detailed overview of the methods available in page.
+All the page methods can take a title parameter, url or a pageId. Read up on the [Page documentation][2] here to see a detailed overview of the methods available in page.
 
 You can also call methods like `summary()` on the `wiki` object directly. [Read up here][3] to see when you should use the `page` object and when you should call `summary()` directly. There's a performance difference! Long story short, use the method directly if you are using only the `summary` of the page and are not expecting to use any of the other `page` attributes.
 
@@ -246,3 +254,4 @@ The project would not be the way it is without these rockstars.
 [7]: https://github.com/dopecodez/wikipedia/blob/master/docs/optionTypes.md#eventOptions
 [8]: https://github.com/dopecodez/wikipedia/blob/master/docs/wiki.md#onThisDay
 [9]: https://github.com/dopecodez/wikipedia/blob/master/docs/PAGE.md#summary
+[10]: https://github.com/dopecodez/wikipedia/blob/master/docs/optionTypes.md#pageOptions

docs/optionTypes.md

@@ -19,12 +19,14 @@ interface pageOptions {
     redirect?: boolean
     preload?: boolean
     fields?: Array<pageFunctions>
+    url?: boolean
 }
 ```
 The options for page methods on `Page` or `wiki`. Generally, can be used for all page methods which do not return a array.
 
 - `redirect : boolean`(default = true) - redirect in case wikipedia returns a 304. **This is the only field that is applicable to any method called on a [Page][1] object**.
 - `autoSuggest : boolean`(default = false) - suggest a page title which is reccomened by wikipedia for given string. Useful in case you are using user input to get details for a page.
+- `url : boolean`(default = false) - allows you to pass a valid wikipedia url in the title to get the information of that page.
 
 The other two fields are only applicable if added on the `wiki.page('title')` method, otherwise its ignored.
 
@@ -38,13 +40,15 @@ interface listOptions {
     autoSuggest?: boolean
     redirect?: boolean
     limit?: number
+    url?: boolean
 }
 ```
 The options for page methods on `Page` or `wiki`. Generally, can be used for all page methods which return an array
 
 - `autoSuggest : boolean`(default = false) - suggest a page title which is reccomened by wikipedia for given search string*
 - `redirect : boolean`(default = true) - redirect in case wikipedia returns a 304
 - `limit : number`(default = 10) - Use this to increase/decrease number of results in the returned array
+- `url : boolean`(default = false) - allows you to pass a valid wikipedia url in the title to get the information of that page.
 
 ### searchOptions
 

source/index.ts

@@ -66,13 +66,13 @@ wiki.search = async (query: string, searchOptions?: searchOptions): Promise<wiki
  * Call this method to get the basic info for page and also to preload any params you might use in future
  *
  * @param title - The title or page Id of the page
- * @param pageOptions - Whether to redirect, autoSuggest or preload any fields {@link pageOptions | pageOptions }
+ * @param pageOptions - Whether to redirect, autoSuggest, use url or preload any fields {@link pageOptions | pageOptions }
  * @returns The intro string
  */
 wiki.page = async (title: string, pageOptions?: pageOptions): Promise<Page> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         let pageParams: any = {
             prop: 'info|pageprops',
@@ -114,8 +114,8 @@ wiki.page = async (title: string, pageOptions?: pageOptions): Promise<Page> => {
  */
 wiki.intro = async (title: string, pageOptions?: pageOptions): Promise<string> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const result = await intro(title, pageOptions?.redirect);
         return result;
@@ -136,8 +136,8 @@ wiki.intro = async (title: string, pageOptions?: pageOptions): Promise<string> =
  */
 wiki.images = async (title: string, listOptions?: listOptions): Promise<Array<imageResult>> => {
     try {
-        if (listOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (listOptions?.url || listOptions?.autoSuggest) {
+            title = await setTitleForPage(title, listOptions);
         }
         const result = await images(title, listOptions);
         return result;
@@ -158,8 +158,8 @@ wiki.images = async (title: string, listOptions?: listOptions): Promise<Array<im
  */
 wiki.summary = async (title: string, pageOptions?: pageOptions): Promise<wikiSummary> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const result = await summary(title, pageOptions?.redirect);
         return result;
@@ -182,8 +182,8 @@ wiki.summary = async (title: string, pageOptions?: pageOptions): Promise<wikiSum
  */
 wiki.html = async (title: string, pageOptions?: pageOptions): Promise<string> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const result = await html(title, pageOptions?.redirect);
         return result;
@@ -204,8 +204,8 @@ wiki.html = async (title: string, pageOptions?: pageOptions): Promise<string> =>
  */
 wiki.content = async (title: string, pageOptions?: pageOptions): Promise<string> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const response = await content(title, pageOptions?.redirect);
         return response.result;
@@ -226,8 +226,8 @@ wiki.content = async (title: string, pageOptions?: pageOptions): Promise<string>
  */
 wiki.categories = async (title: string, listOptions?: listOptions): Promise<Array<string>> => {
     try {
-        if (listOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (listOptions?.url || listOptions?.autoSuggest) {
+            title = await setTitleForPage(title, listOptions);
         }
         const response = await categories(title, listOptions);
         return response;
@@ -251,8 +251,8 @@ wiki.categories = async (title: string, listOptions?: listOptions): Promise<Arra
  */
 wiki.related = async (title: string, pageOptions?: pageOptions): Promise<relatedResult> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const response = await related(title, pageOptions?.redirect);
         return response;
@@ -276,8 +276,8 @@ wiki.related = async (title: string, pageOptions?: pageOptions): Promise<related
  */
 wiki.media = async (title: string, pageOptions?: pageOptions): Promise<wikiMediaResult> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const response = await media(title, pageOptions?.redirect);
         return response;
@@ -298,8 +298,8 @@ wiki.media = async (title: string, pageOptions?: pageOptions): Promise<wikiMedia
  */
 wiki.links = async (title: string, listOptions?: listOptions): Promise<Array<string>> => {
     try {
-        if (listOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (listOptions?.url || listOptions?.autoSuggest) {
+            title = await setTitleForPage(title, listOptions);
         }
         const response = await links(title, listOptions);
         return response;
@@ -320,8 +320,8 @@ wiki.links = async (title: string, listOptions?: listOptions): Promise<Array<str
  */
 wiki.references = async (title: string, listOptions?: listOptions): Promise<Array<string>> => {
     try {
-        if (listOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (listOptions?.url || listOptions?.autoSuggest) {
+            title = await setTitleForPage(title, listOptions);
         }
         const response = await references(title, listOptions);
         return response;
@@ -342,8 +342,8 @@ wiki.references = async (title: string, listOptions?: listOptions): Promise<Arra
  */
 wiki.coordinates = async (title: string, pageOptions?: pageOptions): Promise<coordinatesResult | null> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const response = await coordinates(title, pageOptions?.redirect);
         return response;
@@ -364,8 +364,8 @@ wiki.coordinates = async (title: string, pageOptions?: pageOptions): Promise<coo
  */
 wiki.langLinks = async (title: string, listOptions?: listOptions): Promise<Array<langLinksResult>> => {
     try {
-        if (listOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (listOptions?.url || listOptions?.autoSuggest) {
+            title = await setTitleForPage(title, listOptions);
         }
         const response = await langLinks(title, listOptions);
         return response;
@@ -386,8 +386,8 @@ wiki.langLinks = async (title: string, listOptions?: listOptions): Promise<Array
  */
 wiki.infobox = async (title: string, pageOptions?: pageOptions): Promise<any> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const response = await infobox(title, pageOptions?.redirect);
         return response;
@@ -408,8 +408,8 @@ wiki.infobox = async (title: string, pageOptions?: pageOptions): Promise<any> =>
  */
 wiki.tables = async (title: string, pageOptions?: pageOptions): Promise<Array<any>> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const response = await tables(title, pageOptions?.redirect);
         return response;
@@ -580,8 +580,8 @@ wiki.random = async (format?: randomFormats): Promise<wikiSummary | title | rela
  */
 wiki.mobileHtml = async (title: string, pageOptions?: pageOptions): Promise<notFound | string> => {
     try {
-        if (pageOptions?.autoSuggest) {
-            title = await setTitleForPage(title);
+        if (pageOptions?.url || pageOptions?.autoSuggest) {
+            title = await setTitleForPage(title, pageOptions);
         }
         const result = await mobileHtml(title, pageOptions?.redirect);
         return result;

source/messages.ts

@@ -1,5 +1,6 @@
 export const MSGS = {
     PAGE_NOT_SUGGEST: 'No page with given title suggested : ',
     PAGE_NOT_EXIST: 'No page with given title exists : ',
-    INFOBOX_NOT_EXIST: 'Info cannot be parsed for given page'
+    INFOBOX_NOT_EXIST: 'Info cannot be parsed for given page',
+    INVALID_WIKIPEDIA_URL: 'The provided URL is invalid or does not belong to Wikipedia - ',
 }

source/optionTypes.ts

@@ -12,12 +12,14 @@ export interface pageOptions {
     redirect?: boolean
     preload?: boolean
     fields?: Array<pageFunctions>
+    url?: boolean
 }
 
 export interface listOptions {
     autoSuggest?: boolean
     redirect?: boolean
     limit?: number
+    url?: boolean
 }
 
 export interface geoOptions {

source/page.ts

@@ -31,7 +31,7 @@ export class Page {
     _categories!: Array<string>;
     _references!: Array<string>;
     _links!: Array<string>;
-    _coordinates!: coordinatesResult;
+    _coordinates!: coordinatesResult | null;
     _langLinks!: Array<langLinksResult>;
     _infobox!: any;
     _tables!: Array<any>;
@@ -245,7 +245,7 @@ export class Page {
      * @param redirect - Whether to redirect in case of 302
      * @returns The coordinates as {@link coordinatesResult | coordinatesResult}
      */
-    public coordinates = async (pageOptions?: pageOptions): Promise<coordinatesResult> => {
+    public coordinates = async (pageOptions?: pageOptions): Promise<coordinatesResult | null> => {
         try {
             if (!this._coordinates) {
                 const result = await coordinates(this.pageid.toString(), pageOptions?.redirect);
@@ -628,7 +628,7 @@ export const references = async (title: string, listOptions?: listOptions): Prom
  * @param redirect - Whether to redirect in case of 302
  * @returns The coordinates as {@link coordinatesResult | coordinatesResult}
  */
-export const coordinates = async (title: string, redirect = true): Promise<coordinatesResult> => {
+export const coordinates = async (title: string, redirect = true): Promise<coordinatesResult | null> => {
     try {
         let coordinatesOptions: any = {
             prop: 'coordinates',

source/utils.ts

@@ -1,4 +1,4 @@
-import wiki from ".";
+import wiki, { pageOptions } from ".";
 import { pageError } from "./errors";
 import { MSGS } from "./messages";
 
@@ -7,9 +7,15 @@ export function isString(title: any){
     return isNaN(title);
 }
 
-//set title for page in case autoSuggest is true
-export async function setTitleForPage(title: string) {
+//set title for page in case url or autoSuggest is true
+export async function setTitleForPage(title: string, pageOptions?: pageOptions): Promise<string> {
     {
+        if (pageOptions?.url) {
+            const match = title.match(/(?<=\/wiki\/)[^/?#]+/);
+            if (!match) throw new pageError(`${MSGS.INVALID_WIKIPEDIA_URL}${title}`);
+            title = match[0];
+            return title;
+        }
         const searchResult = await wiki.search(title, { limit: 1, suggestion: true })
         if (!searchResult.suggestion && searchResult.results.length == 0) {
             throw new pageError(`${MSGS.PAGE_NOT_SUGGEST}${title}`)

test/index.test.ts

@@ -217,4 +217,11 @@ test('Suggest returns string', async () => {
 test('sets the user agent', async () => {
     let result = wiki.setUserAgent("testUser");
     expect(result).toStrictEqual(undefined);
+});
+
+test('Page returns results as Page Class if url given instead of title', async () => {
+    requestMock.mockImplementation(async () => { return { query: { pages: { 500: pageJson } } } });
+    setTitleMock.mockImplementation(async () => { return "test" });
+    const result = await wiki.page("https://en.wikipedia.org/wiki/Test", { url: true });
+    expect(result.toString()).toStrictEqual(pageObject.toString());
 });

test/utils.test.ts

@@ -16,7 +16,7 @@ test('Is String returns true for strings', () => {
 });
 
 test('Returns error if no suggestion or search results are present', async () => {
-    searchMock.mockImplementation(async () => { return { suggestion: null, results: [] } });
+    searchMock.mockImplementation(async () => { return { suggestion: "", results: [] } });
     const t = async () => {
         await setTitleForPage("Test")
     };
@@ -30,7 +30,7 @@ test('Returns suggestion if suggestion is present', async () => {
 });
 
 test('Returns title if no suggestion but search results are present', async () => {
-    searchMock.mockImplementation(async () => { return { suggestion: null, results: ['result'] } });
+    searchMock.mockImplementation(async () => { return { suggestion: "", results: ['result'] } });
     const result = await setTitleForPage("Test");
     expect(result).toBe("Test");
 });
@@ -58,3 +58,21 @@ test('Sets pageid from result if not present in params', () => {
     const result = setPageId({}, output);
     expect(result).toBe("500");
 });
+
+test('Returns the correct title if given url', async () => {
+    const result = await setTitleForPage("https://en.wikipedia.org/wiki/Batman", { url: true });
+    expect(result).toBe("Batman");
+});
+
+test('Returns the correct title if url has special chars in title', async () => {
+    const result = await setTitleForPage("https://en.wikipedia.org/wiki/666_(number)", { url: true });
+    expect(result).toBe("666_(number)");
+});
+
+test('Throws error if url not wikipedia', async () => {
+    const t = async () => {
+        await setTitleForPage("https://example.com/666_(number)", { url: true });
+    };
+    expect(t).rejects.toThrowError(pageError);
+});
+