wiki-entity 0.6.1 → 0.7.0

package/lib/wikipedia/api.js

@@ -1,146 +1,146 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRedirects = exports.getExtract = exports.getExtracts = exports.Api = void 0;
-const request_1 = require("../request");
-const API_URL = "https://$lang.wikipedia.org/w/api.php";
-class Api {
-    constructor(qs = { action: "query", format: "json" }, httpTimeout) {
-        this.qs = qs;
-        this.httpTimeout = httpTimeout;
-        this.qs.action = this.qs.action || "query";
-        this.qs.format = "json";
-        this.httpTimeout = httpTimeout || 10 * 1000;
-    }
-    query(lang, qs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (qs)
-                this.qs = Object.assign({}, this.qs, qs);
-            const data = yield (0, request_1.default)(API_URL.replace("$lang", lang), {
-                params: this.qs,
-                timeout: this.httpTimeout
-            });
-            if (hasError(data))
-                throw getError(data);
-            if (data && data.query && data.query.pages) {
-                return Object.keys(data.query.pages)
-                    .map((id) => data.query.pages[id])
-                    .map((page) => {
-                    const item = {
-                        pageid: page.pageid,
-                        title: page.title
-                    };
-                    if (page["categories"]) {
-                        item.categories = page["categories"].map((it) => it.title);
-                    }
-                    if (page["redirects"]) {
-                        item.redirects = page["redirects"].map((it) => it.title);
-                    }
-                    if (page["extract"]) {
-                        item.extract = page["extract"];
-                    }
-                    return item;
-                });
-            }
-            return [];
-        });
-    }
-    redirects() {
-        this.qs["rdlimit"] = "max";
-        this.addField("prop", "redirects");
-        return this;
-    }
-    categories() {
-        this.qs["cllimit"] = "max";
-        this.qs["clshow"] = "!hidden";
-        this.addField("prop", "categories");
-        return this;
-    }
-    extract(sentences = 3) {
-        this.qs["exsentences"] = sentences.toString();
-        this.qs["explaintext"] = "true";
-        this.addField("prop", "extracts");
-        return this;
-    }
-    addField(name, value) {
-        const vals = (this.qs[name] || "").split("|").filter((item) => !!item);
-        vals.push(value);
-        this.qs[name] = vals.join("|");
-        return this;
-    }
-}
-exports.Api = Api;
-function getExtracts(params) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const qs = {
-            action: "query",
-            titles: params.titles && params.titles.join("|"),
-            exsentences: params.sentences || 3,
-            prop: "extracts",
-            explaintext: true,
-            exintro: true,
-            exlimit: "max",
-            exsectionformat: "plain",
-            format: "json"
-        };
-        const data = yield (0, request_1.default)(API_URL.replace("$lang", params.lang), {
-            params: qs
-        });
-        if (hasError(data))
-            throw getError(data);
-        if (data && data.query && data.query.pages) {
-            return Object.keys(data.query.pages).map((id) => data.query.pages[id]);
-        }
-        return [];
-    });
-}
-exports.getExtracts = getExtracts;
-const getExtract = (lang, title, sentences) => getExtracts({
-    lang: lang,
-    titles: [title],
-    sentences: sentences
-}).then(function (extracts) {
-    if (extracts.length) {
-        return extracts[0];
-    }
-    return null;
-});
-exports.getExtract = getExtract;
-function getRedirects(lang, title) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const qs = {
-            action: "query",
-            generator: "redirects",
-            titles: title,
-            grdlimit: "max",
-            format: "json"
-        };
-        const data = yield (0, request_1.default)(API_URL.replace("$lang", lang), {
-            params: qs
-        });
-        if (hasError(data))
-            throw getError(data);
-        if (data && data.query && data.query.pages) {
-            return Object.keys(data.query.pages).map((id) => data.query.pages[id].title);
-        }
-        return [];
-    });
-}
-exports.getRedirects = getRedirects;
-function getError(data) {
-    return ((data &&
-        data.error &&
-        new Error(data.error.info || "Wikidata Api Error")) ||
-        new Error("NO error"));
-}
-function hasError(data) {
-    return !!data.error;
-}
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRedirects = exports.getExtract = exports.getExtracts = exports.Api = void 0;
+const request_1 = require("../request");
+const API_URL = "https://$lang.wikipedia.org/w/api.php";
+class Api {
+    constructor(qs = { action: "query", format: "json" }, httpTimeout) {
+        this.qs = qs;
+        this.httpTimeout = httpTimeout;
+        this.qs.action = this.qs.action || "query";
+        this.qs.format = "json";
+        this.httpTimeout = httpTimeout || 10 * 1000;
+    }
+    query(lang, qs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (qs)
+                this.qs = Object.assign({}, this.qs, qs);
+            const data = yield (0, request_1.default)(API_URL.replace("$lang", lang), {
+                params: this.qs,
+                timeout: this.httpTimeout
+            });
+            if (hasError(data))
+                throw getError(data);
+            if (data && data.query && data.query.pages) {
+                return Object.keys(data.query.pages)
+                    .map((id) => data.query.pages[id])
+                    .map((page) => {
+                    const item = {
+                        pageid: page.pageid,
+                        title: page.title
+                    };
+                    if (page["categories"]) {
+                        item.categories = page["categories"].map((it) => it.title);
+                    }
+                    if (page["redirects"]) {
+                        item.redirects = page["redirects"].map((it) => it.title);
+                    }
+                    if (page["extract"]) {
+                        item.extract = page["extract"];
+                    }
+                    return item;
+                });
+            }
+            return [];
+        });
+    }
+    redirects() {
+        this.qs["rdlimit"] = "max";
+        this.addField("prop", "redirects");
+        return this;
+    }
+    categories() {
+        this.qs["cllimit"] = "max";
+        this.qs["clshow"] = "!hidden";
+        this.addField("prop", "categories");
+        return this;
+    }
+    extract(sentences = 3) {
+        this.qs["exsentences"] = sentences.toString();
+        this.qs["explaintext"] = "true";
+        this.addField("prop", "extracts");
+        return this;
+    }
+    addField(name, value) {
+        const vals = (this.qs[name] || "").split("|").filter((item) => !!item);
+        vals.push(value);
+        this.qs[name] = vals.join("|");
+        return this;
+    }
+}
+exports.Api = Api;
+function getExtracts(params) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const qs = {
+            action: "query",
+            titles: params.titles && params.titles.join("|"),
+            exsentences: params.sentences || 3,
+            prop: "extracts",
+            explaintext: true,
+            exintro: true,
+            exlimit: "max",
+            exsectionformat: "plain",
+            format: "json"
+        };
+        const data = yield (0, request_1.default)(API_URL.replace("$lang", params.lang), {
+            params: qs
+        });
+        if (hasError(data))
+            throw getError(data);
+        if (data && data.query && data.query.pages) {
+            return Object.keys(data.query.pages).map((id) => data.query.pages[id]);
+        }
+        return [];
+    });
+}
+exports.getExtracts = getExtracts;
+const getExtract = (lang, title, sentences) => getExtracts({
+    lang: lang,
+    titles: [title],
+    sentences: sentences
+}).then(function (extracts) {
+    if (extracts.length) {
+        return extracts[0];
+    }
+    return null;
+});
+exports.getExtract = getExtract;
+function getRedirects(lang, title) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const qs = {
+            action: "query",
+            generator: "redirects",
+            titles: title,
+            grdlimit: "max",
+            format: "json"
+        };
+        const data = yield (0, request_1.default)(API_URL.replace("$lang", lang), {
+            params: qs
+        });
+        if (hasError(data))
+            throw getError(data);
+        if (data && data.query && data.query.pages) {
+            return Object.keys(data.query.pages).map((id) => data.query.pages[id].title);
+        }
+        return [];
+    });
+}
+exports.getRedirects = getRedirects;
+function getError(data) {
+    return ((data &&
+        data.error &&
+        new Error(data.error.info || "Wikidata Api Error")) ||
+        new Error("NO error"));
+}
+function hasError(data) {
+    return !!data.error;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wiki-entity",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Wiki entity fetcher",
   "main": "./lib/index.js",
   "types": "./types/index.d.ts",

package/types/index.d.ts

@@ -1,8 +1,9 @@
-import { WikiEntity, WikiEntitiesParams } from "./types";
-import { Api as WikipediaApi } from "./wikipedia/api";
-export { simplifyEntity } from "./wikidata/simplify_entity";
-export { WikipediaApi };
-export * from "./simpleEntity";
-export * from "./types";
-export declare function getEntities(params: WikiEntitiesParams): Promise<WikiEntity[]>;
-export declare function mapRedirects(titles: string[], lang: string): Promise<Record<string, string>>;
+import { WikiEntity, WikiEntitiesParams } from "./types";
+import { Api as WikipediaApi } from "./wikipedia/api";
+export { simplifyEntity } from "./wikidata/simplify_entity";
+export { setUserAgent, getUserAgent } from "./request";
+export { WikipediaApi };
+export * from "./simpleEntity";
+export * from "./types";
+export declare function getEntities(params: WikiEntitiesParams): Promise<WikiEntity[]>;
+export declare function mapRedirects(titles: string[], lang: string): Promise<Record<string, string>>;

package/types/request.d.ts

@@ -1,3 +1,5 @@
-import { AxiosRequestConfig } from "axios";
-export declare type RequestOptions = AxiosRequestConfig;
-export default function <T>(url: string, options: RequestOptions): Promise<T>;
+import { AxiosRequestConfig } from "axios";
+export declare type RequestOptions = AxiosRequestConfig;
+export declare function setUserAgent(ua: string): void;
+export declare function getUserAgent(): string;
+export default function request<T>(url: string, options: RequestOptions): Promise<T>;

package/types/simpleEntity/convertToSimpleEntity.d.ts

@@ -1,6 +1,6 @@
-import { SimpleEntityType, SimpleEntity } from "./simpleEntity";
-import { WikiEntity } from "../types";
-export declare type WikiEntityToEntityOptions = {
-    defaultType?: SimpleEntityType;
-};
-export declare function convertToSimpleEntity(wikiEntity: WikiEntity, lang: string, options?: WikiEntityToEntityOptions): SimpleEntity;
+import { SimpleEntityType, SimpleEntity } from "./simpleEntity";
+import { WikiEntity } from "../types";
+export declare type WikiEntityToEntityOptions = {
+    defaultType?: SimpleEntityType;
+};
+export declare function convertToSimpleEntity(wikiEntity: WikiEntity, lang: string, options?: WikiEntityToEntityOptions): SimpleEntity;

package/types/simpleEntity/getEntityCountry.d.ts

@@ -1,2 +1,2 @@
-import { WikiEntity } from "../types";
-export declare function getEntityCountryCode(wikiEntity: WikiEntity): string[];
+import { WikiEntity } from "../types";
+export declare function getEntityCountryCode(wikiEntity: WikiEntity): string[];

package/types/simpleEntity/getEntityData.d.ts

@@ -1,3 +1,3 @@
-import { SimpleEntityData } from "./simpleEntity";
-import { WikiEntity } from "../types";
-export declare function getEntityData(wikiEntity: WikiEntity): SimpleEntityData;
+import { SimpleEntityData } from "./simpleEntity";
+import { WikiEntity } from "../types";
+export declare function getEntityData(wikiEntity: WikiEntity): SimpleEntityData;

package/types/simpleEntity/getEntityInstanceType.d.ts

@@ -1,3 +1,3 @@
-import { WikiEntity } from '../types';
-import { SimpleEntityType } from './simpleEntity';
-export declare function getEntityType(wikiEntity: WikiEntity): SimpleEntityType;
+import { WikiEntity } from '../types';
+import { SimpleEntityType } from './simpleEntity';
+export declare function getEntityType(wikiEntity: WikiEntity): SimpleEntityType;

package/types/simpleEntity/getEntityType.d.ts

@@ -1,3 +1,3 @@
-import { SimpleEntityType } from './simpleEntity';
-import { WikiEntity } from '../types';
-export declare function getEntityType(wikiEntity: WikiEntity): SimpleEntityType;
+import { SimpleEntityType } from './simpleEntity';
+import { WikiEntity } from '../types';
+export declare function getEntityType(wikiEntity: WikiEntity): SimpleEntityType;

package/types/simpleEntity/getEntityTypeByExtract.d.ts

@@ -1,2 +1,2 @@
-import { SimpleEntityType } from './simpleEntity';
-export declare function getEntityTypeByExtract(extract: string, lang: string): SimpleEntityType;
+import { SimpleEntityType } from './simpleEntity';
+export declare function getEntityTypeByExtract(extract: string, lang: string): SimpleEntityType;

package/types/simpleEntity/index.d.ts

@@ -1,2 +1,2 @@
-export { SimpleEntity, SimpleEntityData, SimpleEntityType } from './simpleEntity';
-export { convertToSimpleEntity } from './convertToSimpleEntity';
+export { SimpleEntity, SimpleEntityData, SimpleEntityType } from './simpleEntity';
+export { convertToSimpleEntity } from './convertToSimpleEntity';

package/types/simpleEntity/simpleEntity.d.ts

@@ -1,29 +1,29 @@
-export declare enum SimpleEntityType {
-    EVENT = "E",
-    ORG = "O",
-    PERSON = "H",
-    PLACE = "P",
-    PRODUCT = "R",
-    WORK = "W"
-}
-export declare const SIMPLE_ENTITY_TYPES: SimpleEntityType[];
-export declare type SimpleEntityData = {
-    [prop: string]: string[];
-};
-export declare type SimpleEntity = {
-    lang?: string;
-    wikiDataId?: string;
-    name?: string;
-    abbr?: string;
-    description?: string;
-    about?: string;
-    wikiPageId?: number;
-    wikiPageTitle?: string;
-    type?: SimpleEntityType;
-    types?: string[];
-    countryCodes?: string[];
-    data?: SimpleEntityData;
-    categories?: string[];
-    redirectsToId?: string;
-    redirectsFromId?: string;
-};
+export declare enum SimpleEntityType {
+    EVENT = "E",
+    ORG = "O",
+    PERSON = "H",
+    PLACE = "P",
+    PRODUCT = "R",
+    WORK = "W"
+}
+export declare const SIMPLE_ENTITY_TYPES: SimpleEntityType[];
+export declare type SimpleEntityData = {
+    [prop: string]: string[];
+};
+export declare type SimpleEntity = {
+    lang?: string;
+    wikiDataId?: string;
+    name?: string;
+    abbr?: string;
+    description?: string;
+    about?: string;
+    wikiPageId?: number;
+    wikiPageTitle?: string;
+    type?: SimpleEntityType;
+    types?: string[];
+    countryCodes?: string[];
+    data?: SimpleEntityData;
+    categories?: string[];
+    redirectsToId?: string;
+    redirectsFromId?: string;
+};

package/types/types.d.ts

@@ -1,68 +1,68 @@
-export declare type PlainObject<T> = {
-    [index: string]: T;
-};
-export declare type AnyPlainObject = PlainObject<any>;
-export declare type StringPlainObject = PlainObject<string>;
-export interface WikidataPropertyValue {
-    datatype: string;
-    value: any;
-    pageid?: number;
-    value_string?: string;
-    label?: string;
-    description?: string;
-    qualifiers?: WikidataEntityClaims | null;
-}
-export interface WikidataBaseEntity {
-    id: string;
-    label?: string;
-    description?: string;
-    [index: string]: any;
-}
-export interface WikidataProperty extends WikidataBaseEntity {
-    values: WikidataPropertyValue[];
-}
-export declare type WikidataEntityClaims = PlainObject<WikidataProperty>;
-export interface WikidataEntity extends WikidataBaseEntity {
-    pageid?: number;
-    aliases?: string[];
-    sitelinks?: PlainObject<string>;
-    claims?: WikidataEntityClaims;
-    labels?: PlainObject<string>;
-}
-export declare type WikidataEntities = PlainObject<WikidataEntity>;
-export interface WikiEntity extends WikidataEntity {
-    extract?: string;
-    types?: string[];
-    redirects?: string[];
-    categories?: string[];
-    redirectsToId?: string;
-    redirectsFromId?: string;
-}
-export declare type WikiEntities = PlainObject<WikiEntity>;
-export declare type ParamClaimsType = "none" | "all" | "item" | "property";
-export interface WikidataEntitiesParams {
-    ids?: string[];
-    titles?: string[];
-    props?: WikidataPropsParam[];
-    language?: string;
-    redirect?: string;
-    claims?: ParamClaimsType;
-    httpTimeout?: number;
-    languages?: string[];
-}
-export declare enum WikidataPropsParam {
-    info = "info",
-    sitelinks = "sitelinks",
-    aliases = "aliases",
-    labels = "labels",
-    descriptions = "descriptions",
-    claims = "claims",
-    datatype = "datatype"
-}
-export interface WikiEntitiesParams extends WikidataEntitiesParams {
-    extract?: number;
-    types?: boolean | string[];
-    redirects?: boolean;
-    categories?: boolean;
-    wikiPageId?: boolean;
-}
+export declare type PlainObject<T> = {
+    [index: string]: T;
+};
+export declare type AnyPlainObject = PlainObject<any>;
+export declare type StringPlainObject = PlainObject<string>;
+export interface WikidataPropertyValue {
+    datatype: string;
+    value: any;
+    pageid?: number;
+    value_string?: string;
+    label?: string;
+    description?: string;
+    qualifiers?: WikidataEntityClaims | null;
+}
+export interface WikidataBaseEntity {
+    id: string;
+    label?: string;
+    description?: string;
+    [index: string]: any;
+}
+export interface WikidataProperty extends WikidataBaseEntity {
+    values: WikidataPropertyValue[];
+}
+export declare type WikidataEntityClaims = PlainObject<WikidataProperty>;
+export interface WikidataEntity extends WikidataBaseEntity {
+    pageid?: number;
+    aliases?: string[];
+    sitelinks?: PlainObject<string>;
+    claims?: WikidataEntityClaims;
+    labels?: PlainObject<string>;
+}
+export declare type WikidataEntities = PlainObject<WikidataEntity>;
+export interface WikiEntity extends WikidataEntity {
+    extract?: string;
+    types?: string[];
+    redirects?: string[];
+    categories?: string[];
+    redirectsToId?: string;
+    redirectsFromId?: string;
+}
+export declare type WikiEntities = PlainObject<WikiEntity>;
+export declare type ParamClaimsType = "none" | "all" | "item" | "property";
+export interface WikidataEntitiesParams {
+    ids?: string[];
+    titles?: string[];
+    props?: WikidataPropsParam[];
+    language?: string;
+    redirect?: string;
+    claims?: ParamClaimsType;
+    httpTimeout?: number;
+    languages?: string[];
+}
+export declare enum WikidataPropsParam {
+    info = "info",
+    sitelinks = "sitelinks",
+    aliases = "aliases",
+    labels = "labels",
+    descriptions = "descriptions",
+    claims = "claims",
+    datatype = "datatype"
+}
+export interface WikiEntitiesParams extends WikidataEntitiesParams {
+    extract?: number;
+    types?: boolean | string[];
+    redirects?: boolean;
+    categories?: boolean;
+    wikiPageId?: boolean;
+}

package/types/utils.d.ts

@@ -1,8 +1,8 @@
-export declare type PlainObject<T> = {
-    [index: string]: T;
-};
-export declare type AnyPlainObject = PlainObject<any>;
-export declare type StringPlainObject = PlainObject<string>;
-export declare function eachSeries<T>(arr: any[], iteratorFn: (item: any) => Promise<T>): any;
-export declare function uniq<T>(items: T[]): T[];
-export declare function isValidWikiId(id: string): boolean;
+export declare type PlainObject<T> = {
+    [index: string]: T;
+};
+export declare type AnyPlainObject = PlainObject<any>;
+export declare type StringPlainObject = PlainObject<string>;
+export declare function eachSeries<T>(arr: any[], iteratorFn: (item: any) => Promise<T>): any;
+export declare function uniq<T>(items: T[]): T[];
+export declare function isValidWikiId(id: string): boolean;

package/types/wikidata/api.d.ts

@@ -1,4 +1,4 @@
-import { WikidataEntities, WikidataEntitiesParams } from "../types";
-export declare function getEntities(params: WikidataEntitiesParams): Promise<WikidataEntities>;
-export declare function getManyEntities(params: WikidataEntitiesParams): Promise<WikidataEntities>;
-export declare function validateParams(params: WikidataEntitiesParams): void;
+import { WikidataEntities, WikidataEntitiesParams } from "../types";
+export declare function getEntities(params: WikidataEntitiesParams): Promise<WikidataEntities>;
+export declare function getManyEntities(params: WikidataEntitiesParams): Promise<WikidataEntities>;
+export declare function validateParams(params: WikidataEntitiesParams): void;

package/types/wikidata/get_entity_types.d.ts

@@ -1 +1 @@
-export declare function getEntityTypesByName(name: string, prefixes?: string[]): Promise<string[]>;
+export declare function getEntityTypesByName(name: string, prefixes?: string[]): Promise<string[]>;

package/types/wikidata/index.d.ts

@@ -1,3 +1,3 @@
-import { WikidataEntities, WikidataEntitiesParams, WikidataEntityClaims } from "../types";
-export declare function getEntities(params: WikidataEntitiesParams): Promise<WikidataEntities>;
-export declare function exploreEntityClaims(claims: WikidataEntityClaims, params: WikidataEntitiesParams): Promise<void>;
+import { WikidataEntities, WikidataEntitiesParams, WikidataEntityClaims } from "../types";
+export declare function getEntities(params: WikidataEntitiesParams): Promise<WikidataEntities>;
+export declare function exploreEntityClaims(claims: WikidataEntityClaims, params: WikidataEntitiesParams): Promise<void>;

package/types/wikidata/simplify_claims.d.ts

@@ -1,4 +1,4 @@
-import { WikidataEntityClaims, WikidataProperty, WikidataPropertyValue } from "../types";
-export declare function simplifyClaims(claims: any): WikidataEntityClaims;
-export declare function simplifyPropertyClaims(propClaims: any[], id: string): WikidataProperty;
-export declare function simplifyClaim(claim: any): WikidataPropertyValue;
+import { WikidataEntityClaims, WikidataProperty, WikidataPropertyValue } from "../types";
+export declare function simplifyClaims(claims: any): WikidataEntityClaims;
+export declare function simplifyPropertyClaims(propClaims: any[], id: string): WikidataProperty;
+export declare function simplifyClaim(claim: any): WikidataPropertyValue;