gdelt-ts-client 1.0.0

package/dist/constants/index.d.ts

@@ -0,0 +1,184 @@
+/**
+ * Constants for the GDELT API
+ */
+/**
+ * Base URL for the GDELT API
+ */
+export declare const API_BASE_URL = "https://api.gdeltproject.org/api/v2/doc/doc";
+/**
+ * Enum for the different output modes of the GDELT API
+ * @enum {string}
+ */
+export declare enum EMode {
+    /**
+     * Simple list of news articles that matched the query
+     */
+    articleList = "artlist",
+    /**
+     * High design visual layout of articles with social sharing images
+     */
+    articleGallery = "artgallery",
+    /**
+     * Displays all matching images processed by GDELT Visual Global Knowledge Graph
+     */
+    imageCollage = "imagecollage",
+    /**
+     * Same as imageCollage but with additional information about each image
+     */
+    imageCollageInfo = "imagecollageinfo",
+    /**
+     * High design visual layout of images
+     */
+    imageGallery = "imagegallery",
+    /**
+     * List of social sharing images from matching articles
+     */
+    imageCollageShare = "imagecollagesshare",
+    /**
+     * Timeline of news coverage volume by day/hour/15 minutes
+     */
+    timelineVolume = "timelinevol",
+    /**
+     * Same as timelineVolume but returns raw counts instead of percentages
+     */
+    timelineVolumeRaw = "timelinevolraw",
+    /**
+     * Same as timelineVolume but displays top 10 most relevant articles for each time step
+     */
+    timelineVolumeInfo = "timelinevolinfo",
+    /**
+     * Timeline of average tone of matching coverage
+     */
+    timelineTone = "timelinetone",
+    /**
+     * Timeline of coverage volume broken down by language
+     */
+    timelineLanguage = "timelinelang",
+    /**
+     * Timeline of coverage volume broken down by source country
+     */
+    timelineSourceCountry = "timelinesourcecountry",
+    /**
+     * Emotional histogram showing tonal distribution of coverage
+     */
+    toneChart = "tonechart",
+    /**
+     * Word cloud of image tags from VGKG-processed images
+     */
+    wordCloudImageTags = "wordcloudimagetags",
+    /**
+     * Word cloud of image web tags from VGKG-processed images
+     */
+    wordCloudImageWebTags = "wordcloudimagewebtags"
+}
+/**
+ * Enum for the different output formats of the GDELT API
+ * @enum {string}
+ */
+export declare enum EFormat {
+    /**
+     * Browser-based visualization or display
+     */
+    html = "html",
+    /**
+     * Comma-delimited format
+     */
+    csv = "csv",
+    /**
+     * RSS 2.0 format (only available in ArticleList mode)
+     */
+    rss = "rss",
+    /**
+     * Extended RSS format with mobile/AMP versions (only available in ArticleList mode)
+     */
+    rssArchive = "rssarchive",
+    /**
+     * JSON format
+     */
+    json = "json",
+    /**
+     * JSONP format
+     */
+    jsonp = "jsonp",
+    /**
+     * JSONFeed 1.0 format (only available in ArticleList mode)
+     */
+    jsonFeed = "jsonfeed"
+}
+/**
+ * Enum for the different timespan units of the GDELT API
+ * @enum {string}
+ */
+export declare enum ETimespanUnit {
+    /**
+     * Minutes
+     */
+    minutes = "min",
+    /**
+     * Hours
+     */
+    hours = "h",
+    /**
+     * Days
+     */
+    days = "d",
+    /**
+     * Weeks
+     */
+    weeks = "w",
+    /**
+     * Months
+     */
+    months = "m"
+}
+/**
+ * Enum for the different sort options of the GDELT API
+ * @enum {string}
+ */
+export declare enum ESort {
+    /**
+     * Sort by date, newest first
+     */
+    dateDesc = "datedesc",
+    /**
+     * Sort by date, oldest first
+     */
+    dateAsc = "dateasc",
+    /**
+     * Sort by tone, most positive first
+     */
+    toneDesc = "tonedesc",
+    /**
+     * Sort by tone, most negative first
+     */
+    toneAsc = "toneasc",
+    /**
+     * Default relevance sorting mode
+     */
+    hybridRelevance = "hybridrel"
+}
+/**
+ * Enum for the different translation options of the GDELT API
+ * @enum {string}
+ */
+export declare enum ETranslation {
+    /**
+     * Google Translate Widget
+     */
+    googleTranslate = "googtrans"
+}
+/**
+ * Enum for the different time zoom options of the GDELT API
+ * @enum {string}
+ */
+export declare enum ETimeZoom {
+    /**
+     * Enable interactive zooming
+     */
+    enabled = "yes",
+    /**
+     * Disable interactive zooming
+     */
+    disabled = "no"
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/constants/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,eAAO,MAAM,YAAY,gDAAgD,CAAC;AAE1E;;;GAGG;AACH,oBAAY,KAAK;IACf;;OAEG;IACH,WAAW,YAAY;IAEvB;;OAEG;IACH,cAAc,eAAe;IAE7B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,gBAAgB,qBAAqB;IAErC;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,iBAAiB,uBAAuB;IAExC;;OAEG;IACH,cAAc,gBAAgB;IAE9B;;OAEG;IACH,iBAAiB,mBAAmB;IAEpC;;OAEG;IACH,kBAAkB,oBAAoB;IAEtC;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,gBAAgB,iBAAiB;IAEjC;;OAEG;IACH,qBAAqB,0BAA0B;IAE/C;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,kBAAkB,uBAAuB;IAEzC;;OAEG;IACH,qBAAqB,0BAA0B;CAChD;AAED;;;GAGG;AACH,oBAAY,OAAO;IACjB;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,GAAG,QAAQ;IAEX;;OAEG;IACH,GAAG,QAAQ;IAEX;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,KAAK,UAAU;IAEf;;OAEG;IACH,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,oBAAY,aAAa;IACvB;;OAEG;IACH,OAAO,QAAQ;IAEf;;OAEG;IACH,KAAK,MAAM;IAEX;;OAEG;IACH,IAAI,MAAM;IAEV;;OAEG;IACH,KAAK,MAAM;IAEX;;OAEG;IACH,MAAM,MAAM;CACb;AAED;;;GAGG;AACH,oBAAY,KAAK;IACf;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,eAAe,cAAc;CAC9B;AAED;;;GAGG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,eAAe,cAAc;CAC9B;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB;;OAEG;IACH,OAAO,QAAQ;IAEf;;OAEG;IACH,QAAQ,OAAO;CAChB"}

package/dist/constants/index.js

@@ -0,0 +1,193 @@
+"use strict";
+/**
+ * Constants for the GDELT API
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ETimeZoom = exports.ETranslation = exports.ESort = exports.ETimespanUnit = exports.EFormat = exports.EMode = exports.API_BASE_URL = void 0;
+/**
+ * Base URL for the GDELT API
+ */
+exports.API_BASE_URL = 'https://api.gdeltproject.org/api/v2/doc/doc';
+/**
+ * Enum for the different output modes of the GDELT API
+ * @enum {string}
+ */
+var EMode;
+(function (EMode) {
+    /**
+     * Simple list of news articles that matched the query
+     */
+    EMode["articleList"] = "artlist";
+    /**
+     * High design visual layout of articles with social sharing images
+     */
+    EMode["articleGallery"] = "artgallery";
+    /**
+     * Displays all matching images processed by GDELT Visual Global Knowledge Graph
+     */
+    EMode["imageCollage"] = "imagecollage";
+    /**
+     * Same as imageCollage but with additional information about each image
+     */
+    EMode["imageCollageInfo"] = "imagecollageinfo";
+    /**
+     * High design visual layout of images
+     */
+    EMode["imageGallery"] = "imagegallery";
+    /**
+     * List of social sharing images from matching articles
+     */
+    EMode["imageCollageShare"] = "imagecollagesshare";
+    /**
+     * Timeline of news coverage volume by day/hour/15 minutes
+     */
+    EMode["timelineVolume"] = "timelinevol";
+    /**
+     * Same as timelineVolume but returns raw counts instead of percentages
+     */
+    EMode["timelineVolumeRaw"] = "timelinevolraw";
+    /**
+     * Same as timelineVolume but displays top 10 most relevant articles for each time step
+     */
+    EMode["timelineVolumeInfo"] = "timelinevolinfo";
+    /**
+     * Timeline of average tone of matching coverage
+     */
+    EMode["timelineTone"] = "timelinetone";
+    /**
+     * Timeline of coverage volume broken down by language
+     */
+    EMode["timelineLanguage"] = "timelinelang";
+    /**
+     * Timeline of coverage volume broken down by source country
+     */
+    EMode["timelineSourceCountry"] = "timelinesourcecountry";
+    /**
+     * Emotional histogram showing tonal distribution of coverage
+     */
+    EMode["toneChart"] = "tonechart";
+    /**
+     * Word cloud of image tags from VGKG-processed images
+     */
+    EMode["wordCloudImageTags"] = "wordcloudimagetags";
+    /**
+     * Word cloud of image web tags from VGKG-processed images
+     */
+    EMode["wordCloudImageWebTags"] = "wordcloudimagewebtags";
+})(EMode || (exports.EMode = EMode = {}));
+/**
+ * Enum for the different output formats of the GDELT API
+ * @enum {string}
+ */
+var EFormat;
+(function (EFormat) {
+    /**
+     * Browser-based visualization or display
+     */
+    EFormat["html"] = "html";
+    /**
+     * Comma-delimited format
+     */
+    EFormat["csv"] = "csv";
+    /**
+     * RSS 2.0 format (only available in ArticleList mode)
+     */
+    EFormat["rss"] = "rss";
+    /**
+     * Extended RSS format with mobile/AMP versions (only available in ArticleList mode)
+     */
+    EFormat["rssArchive"] = "rssarchive";
+    /**
+     * JSON format
+     */
+    EFormat["json"] = "json";
+    /**
+     * JSONP format
+     */
+    EFormat["jsonp"] = "jsonp";
+    /**
+     * JSONFeed 1.0 format (only available in ArticleList mode)
+     */
+    EFormat["jsonFeed"] = "jsonfeed";
+})(EFormat || (exports.EFormat = EFormat = {}));
+/**
+ * Enum for the different timespan units of the GDELT API
+ * @enum {string}
+ */
+var ETimespanUnit;
+(function (ETimespanUnit) {
+    /**
+     * Minutes
+     */
+    ETimespanUnit["minutes"] = "min";
+    /**
+     * Hours
+     */
+    ETimespanUnit["hours"] = "h";
+    /**
+     * Days
+     */
+    ETimespanUnit["days"] = "d";
+    /**
+     * Weeks
+     */
+    ETimespanUnit["weeks"] = "w";
+    /**
+     * Months
+     */
+    ETimespanUnit["months"] = "m";
+})(ETimespanUnit || (exports.ETimespanUnit = ETimespanUnit = {}));
+/**
+ * Enum for the different sort options of the GDELT API
+ * @enum {string}
+ */
+var ESort;
+(function (ESort) {
+    /**
+     * Sort by date, newest first
+     */
+    ESort["dateDesc"] = "datedesc";
+    /**
+     * Sort by date, oldest first
+     */
+    ESort["dateAsc"] = "dateasc";
+    /**
+     * Sort by tone, most positive first
+     */
+    ESort["toneDesc"] = "tonedesc";
+    /**
+     * Sort by tone, most negative first
+     */
+    ESort["toneAsc"] = "toneasc";
+    /**
+     * Default relevance sorting mode
+     */
+    ESort["hybridRelevance"] = "hybridrel";
+})(ESort || (exports.ESort = ESort = {}));
+/**
+ * Enum for the different translation options of the GDELT API
+ * @enum {string}
+ */
+var ETranslation;
+(function (ETranslation) {
+    /**
+     * Google Translate Widget
+     */
+    ETranslation["googleTranslate"] = "googtrans";
+})(ETranslation || (exports.ETranslation = ETranslation = {}));
+/**
+ * Enum for the different time zoom options of the GDELT API
+ * @enum {string}
+ */
+var ETimeZoom;
+(function (ETimeZoom) {
+    /**
+     * Enable interactive zooming
+     */
+    ETimeZoom["enabled"] = "yes";
+    /**
+     * Disable interactive zooming
+     */
+    ETimeZoom["disabled"] = "no";
+})(ETimeZoom || (exports.ETimeZoom = ETimeZoom = {}));
+//# sourceMappingURL=index.js.map

package/dist/constants/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH;;GAEG;AACU,QAAA,YAAY,GAAG,6CAA6C,CAAC;AAE1E;;;GAGG;AACH,IAAY,KA2EX;AA3ED,WAAY,KAAK;IACf;;OAEG;IACH,gCAAuB,CAAA;IAEvB;;OAEG;IACH,sCAA6B,CAAA;IAE7B;;OAEG;IACH,sCAA6B,CAAA;IAE7B;;OAEG;IACH,8CAAqC,CAAA;IAErC;;OAEG;IACH,sCAA6B,CAAA;IAE7B;;OAEG;IACH,iDAAwC,CAAA;IAExC;;OAEG;IACH,uCAA8B,CAAA;IAE9B;;OAEG;IACH,6CAAoC,CAAA;IAEpC;;OAEG;IACH,+CAAsC,CAAA;IAEtC;;OAEG;IACH,sCAA6B,CAAA;IAE7B;;OAEG;IACH,0CAAiC,CAAA;IAEjC;;OAEG;IACH,wDAA+C,CAAA;IAE/C;;OAEG;IACH,gCAAuB,CAAA;IAEvB;;OAEG;IACH,kDAAyC,CAAA;IAEzC;;OAEG;IACH,wDAA+C,CAAA;AACjD,CAAC,EA3EW,KAAK,qBAAL,KAAK,QA2EhB;AAED;;;GAGG;AACH,IAAY,OAmCX;AAnCD,WAAY,OAAO;IACjB;;OAEG;IACH,wBAAa,CAAA;IAEb;;OAEG;IACH,sBAAW,CAAA;IAEX;;OAEG;IACH,sBAAW,CAAA;IAEX;;OAEG;IACH,oCAAyB,CAAA;IAEzB;;OAEG;IACH,wBAAa,CAAA;IAEb;;OAEG;IACH,0BAAe,CAAA;IAEf;;OAEG;IACH,gCAAqB,CAAA;AACvB,CAAC,EAnCW,OAAO,uBAAP,OAAO,QAmClB;AAED;;;GAGG;AACH,IAAY,aAyBX;AAzBD,WAAY,aAAa;IACvB;;OAEG;IACH,gCAAe,CAAA;IAEf;;OAEG;IACH,4BAAW,CAAA;IAEX;;OAEG;IACH,2BAAU,CAAA;IAEV;;OAEG;IACH,4BAAW,CAAA;IAEX;;OAEG;IACH,6BAAY,CAAA;AACd,CAAC,EAzBW,aAAa,6BAAb,aAAa,QAyBxB;AAED;;;GAGG;AACH,IAAY,KAyBX;AAzBD,WAAY,KAAK;IACf;;OAEG;IACH,8BAAqB,CAAA;IAErB;;OAEG;IACH,4BAAmB,CAAA;IAEnB;;OAEG;IACH,8BAAqB,CAAA;IAErB;;OAEG;IACH,4BAAmB,CAAA;IAEnB;;OAEG;IACH,sCAA6B,CAAA;AAC/B,CAAC,EAzBW,KAAK,qBAAL,KAAK,QAyBhB;AAED;;;GAGG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB;;OAEG;IACH,6CAA6B,CAAA;AAC/B,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAED;;;GAGG;AACH,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB;;OAEG;IACH,4BAAe,CAAA;IAEf;;OAEG;IACH,4BAAe,CAAA;AACjB,CAAC,EAVW,SAAS,yBAAT,SAAS,QAUpB"}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * GDELT API TypeScript Client
+ * A strongly-typed client for interacting with the GDELT API
+ */
+export * from './constants';
+export * from './interfaces/api-parameters';
+export * from './interfaces/api-responses';
+export * from './client';
+export * from './types/enhanced-types';
+export * from './types/type-guards';
+export * from './types/query-builder';
+export { GdeltClient as EnhancedGdeltClient } from './client';
+export declare function createEnhancedGdeltClient(config?: import('./interfaces/api-parameters').IGdeltClientConfig): import('./client').GdeltClient;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,cAAc,aAAa,CAAC;AAG5B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAG3C,cAAc,UAAU,CAAC;AAGzB,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AAGtC,OAAO,EAAE,WAAW,IAAI,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC9D,wBAAgB,yBAAyB,CAAC,MAAM,CAAC,EAAE,OAAO,6BAA6B,EAAE,kBAAkB,GAAG,OAAO,UAAU,EAAE,WAAW,CAE3I"}

package/dist/index.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * GDELT API TypeScript Client
+ * A strongly-typed client for interacting with the GDELT API
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnhancedGdeltClient = void 0;
+exports.createEnhancedGdeltClient = createEnhancedGdeltClient;
+// Export constants
+__exportStar(require("./constants"), exports);
+// Export interfaces
+__exportStar(require("./interfaces/api-parameters"), exports);
+__exportStar(require("./interfaces/api-responses"), exports);
+// Export main client
+__exportStar(require("./client"), exports);
+// Export enhanced TypeScript features as utilities
+__exportStar(require("./types/enhanced-types"), exports);
+__exportStar(require("./types/type-guards"), exports);
+__exportStar(require("./types/query-builder"), exports);
+// Export factory function for backward compatibility
+var client_1 = require("./client");
+Object.defineProperty(exports, "EnhancedGdeltClient", { enumerable: true, get: function () { return client_1.GdeltClient; } });
+function createEnhancedGdeltClient(config) {
+    return new (require('./client').GdeltClient)(config);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;AAmBH,8DAEC;AAnBD,mBAAmB;AACnB,8CAA4B;AAE5B,oBAAoB;AACpB,8DAA4C;AAC5C,6DAA2C;AAE3C,qBAAqB;AACrB,2CAAyB;AAEzB,mDAAmD;AACnD,yDAAuC;AACvC,sDAAoC;AACpC,wDAAsC;AAEtC,qDAAqD;AACrD,mCAA8D;AAArD,6GAAA,WAAW,OAAuB;AAC3C,SAAgB,yBAAyB,CAAC,MAAiE;IACzG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AACvD,CAAC"}

package/dist/interfaces/api-parameters.d.ts

@@ -0,0 +1,201 @@
+import { EFormat, EMode, ESort, ETimeZoom, ETranslation, ETimespanUnit } from '../constants';
+/**
+ * Interface for the GDELT API query operators
+ * These operators are used within the query parameter
+ */
+export interface IQueryOperators {
+    /**
+     * Returns all coverage from the specified domain
+     * @example domain:cnn.com
+     */
+    domain?: string;
+    /**
+     * Requires an exact match for domain, allowing searching for common short domains
+     * @example domainis:un.org
+     */
+    domainIs?: string;
+    /**
+     * Searches the average "tone" of human facial emotions in each image
+     * @example imagefacetone<-1.5
+     */
+    imageFaceTone?: string;
+    /**
+     * Searches the total number of foreground human faces in the image
+     * @example imagenumfaces>3
+     */
+    imageNumFaces?: string;
+    /**
+     * Searches a combination of OCR results, metadata, and caption
+     * @example imageocrmeta:"zika"
+     */
+    imageOCRMeta?: string;
+    /**
+     * Searches for images with specific tags assigned by Google's algorithms
+     * @example imagetag:"safesearchviolence"
+     */
+    imageTag?: string;
+    /**
+     * Searches for images that have appeared a certain number of times on the web
+     * @example imagewebcount<10
+     */
+    imageWebCount?: string;
+    /**
+     * Searches for images with specific tags derived from web captions
+     * @example imagewebtag:"drone"
+     */
+    imageWebTag?: string;
+    /**
+     * Allows specifying words that must appear within a given distance of each other
+     * @example near20:"trump putin"
+     */
+    near?: string;
+    /**
+     * Requires a word to appear at least a certain number of times in a document
+     * @example repeat3:"trump"
+     */
+    repeat?: string;
+    /**
+     * Searches for articles published in outlets located in a particular country
+     * @example sourcecountry:france
+     */
+    sourceCountry?: string;
+    /**
+     * Searches for articles originally published in the given language
+     * @example sourcelang:spanish
+     */
+    sourceLang?: string;
+    /**
+     * Searches for any of the GDELT Global Knowledge Graph (GKG) Themes
+     * @example theme:TERROR
+     */
+    theme?: string;
+    /**
+     * Filters for articles above or below a particular tone score
+     * @example tone<-5
+     */
+    tone?: string;
+    /**
+     * Searches for high emotion or low emotion articles, regardless of positive/negative
+     * @example toneabs>10
+     */
+    toneAbs?: string;
+}
+/**
+ * Interface for the GDELT API base parameters
+ */
+export interface IGdeltApiBaseParams {
+    /**
+     * The search query
+     * Can include keywords, phrases, and operators
+     */
+    query: string;
+    /**
+     * The output mode
+     * Determines the type of visualization or data returned
+     */
+    mode?: EMode;
+    /**
+     * The output format
+     * Determines the format of the returned data (HTML, JSON, CSV, etc.)
+     */
+    format?: EFormat;
+    /**
+     * The timespan to search
+     * Specifies the number of months, weeks, days, hours, or minutes to search
+     * @example "1d" for 1 day, "2h" for 2 hours, "30min" for 30 minutes
+     */
+    timespan?: string;
+    /**
+     * The start date/time to search
+     * Format: YYYYMMDDHHMMSS
+     * Must be within the last 3 months
+     */
+    startdatetime?: string;
+    /**
+     * The end date/time to search
+     * Format: YYYYMMDDHHMMSS
+     * Must be within the last 3 months
+     */
+    enddatetime?: string;
+    /**
+     * The maximum number of records to return
+     * Only applies to ArticleList and ImageCollage modes
+     * Default: 75, Maximum: 250
+     */
+    maxrecords?: number;
+    /**
+     * The number of time steps to smooth over
+     * Only available in Timeline modes
+     * Maximum: 30
+     */
+    timelinesmooth?: number;
+    /**
+     * The translation widget to embed
+     * Only available in ArticleList mode with HTML output
+     */
+    trans?: ETranslation;
+    /**
+     * The sort order for results
+     * Default: relevance
+     */
+    sort?: ESort;
+    /**
+     * Whether to enable interactive zooming of the timeline
+     * Only available for timeline modes in HTML format
+     */
+    timezoom?: ETimeZoom;
+    /**
+     * The callback function name for JSONP format
+     * Only used when format is JSONP
+     */
+    callback?: string;
+}
+/**
+ * Interface for creating a timespan parameter
+ */
+export interface ITimespan {
+    /**
+     * The value of the timespan
+     */
+    value: number;
+    /**
+     * The unit of the timespan
+     */
+    unit: ETimespanUnit;
+}
+/**
+ * Interface for the GDELT API client configuration
+ */
+export interface IGdeltClientConfig {
+    /**
+     * The base URL for the GDELT API
+     * @default "https://api.gdeltproject.org/api/v2/doc/doc"
+     */
+    baseUrl?: string;
+    /**
+     * The default format for API responses
+     * @default EFormat.json
+     */
+    defaultFormat?: EFormat;
+    /**
+     * The timeout for API requests in milliseconds
+     * @default 30000 (30 seconds)
+     */
+    timeout?: number;
+    /**
+     * Whether to retry failed requests
+     * @default true
+     */
+    retry?: boolean;
+    /**
+     * The maximum number of retries for failed requests
+     * @default 3
+     */
+    maxRetries?: number;
+    /**
+     * The delay between retries in milliseconds
+     * @default 1000 (1 second)
+     */
+    retryDelay?: number;
+}
+//# sourceMappingURL=api-parameters.d.ts.map

package/dist/interfaces/api-parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-parameters.d.ts","sourceRoot":"","sources":["../../src/interfaces/api-parameters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7F;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/interfaces/api-parameters.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-parameters.js.map

package/dist/interfaces/api-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-parameters.js","sourceRoot":"","sources":["../../src/interfaces/api-parameters.ts"],"names":[],"mappings":""}