@fre4x/fred 1.0.29 → 1.0.40

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Adaptive Agent
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Adaptive Agent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,54 +1,63 @@
-# fred — The Economic Nerve
-
-> *Monetary policy, GDP, unemployment, inflation — the macroeconomic forces that move everything. This B1TE reads them directly.*
-
-Part of **[FRE4X-B1TE](../)** — a monorepo of MCP servers built for autonomous agents.
-
-The Federal Reserve publishes the data that governments and institutions use to make decisions worth trillions. This server gives the agent that same data stream — unfiltered, paginated, ready for inference. While analysts write reports, the agent already knows.
-
-## Tools
-
-| Tool | What it reaches |
-|------|----------------|
-| `fred_search_series` | Full-text search across all FRED series |
-| `fred_get_series_info` | Metadata for a series — units, frequency, range, last update |
-| `fred_get_series_data` | Observation time-series for any series (e.g. `GDP`, `UNRATE`, `CPIAUCSL`) |
-| `fred_get_category_series` | All series under a given FRED category |
-| `fred_get_releases` | Index of all FRED data releases |
-| `fred_get_release_series` | Series belonging to a specific release |
-| `fred_get_sources` | All primary data sources in FRED |
-| `fred_get_source` | Details for one source |
-
-All list tools support pagination via `limit` / `offset`.
-
-## Requirements
-
-A [FRED API key](https://fred.stlouisfed.org/docs/api/api_key.html) (free) — set as `FRED_API_KEY`.
-
-## Deploy
-
-```json
-{
-  "mcpServers": {
-    "fred": {
-      "command": "npx",
-      "args": ["-y", "@fre4x/fred"],
-      "env": {
-        "FRED_API_KEY": "your_api_key_here"
-      }
-    }
-  }
-}
-```
-
-## Development
-
-```bash
-npm install
-npm run dev      # tsx, no build
-npm run build    # compile → dist/
-```
-
-## License
-
-MIT — **WE ARE THE FRE4X.**
+# fred — The Economic Nerve
+
+> *Monetary policy, GDP, unemployment, inflation — the macroeconomic forces that move everything. This B1TE reads them directly.*
+
+Part of **[FRE4X-B1TE](../)** — a monorepo of MCP servers built for autonomous agents.
+
+The Federal Reserve publishes the data that governments and institutions use to make decisions worth trillions. This server gives the agent that same data stream — unfiltered, paginated, ready for inference. While analysts write reports, the agent already knows.
+
+## Tools
+
+| Tool | What it reaches |
+|------|----------------|
+| `fred_search_series` | Full-text search across all FRED series |
+| `fred_get_series_info` | Metadata for a series — units, frequency, range, last update |
+| `fred_get_series_data` | Observation time-series for any series (e.g. `GDP`, `UNRATE`, `CPIAUCSL`) |
+| `fred_get_category_series` | All series under a given FRED category |
+| `fred_get_releases` | Index of all FRED data releases |
+| `fred_get_release_series` | Series belonging to a specific release |
+| `fred_get_sources` | All primary data sources in FRED |
+| `fred_get_source` | Details for one source |
+
+All list tools support pagination via `limit` / `offset`.
+
+## Requirements
+
+A [FRED API key](https://fred.stlouisfed.org/docs/api/api_key.html) (free) — set as `FRED_API_KEY`.
+
+## Mock Mode
+
+Run without an API key (returns fixture data of identical shape):
+
+```bash
+MOCK=true npx @fre4x/fred
+```
+
+## Deploy
+
+```json
+{
+  "mcpServers": {
+    "fred": {
+      "command": "npx",
+      "args": ["-y", "@fre4x/fred"],
+      "env": {
+        "FRED_API_KEY": "your_api_key_here"
+      }
+    }
+  }
+}
+```
+
+## Development
+
+```bash
+npm install
+npm run dev      # tsx, no build
+npm run build    # esbuild → dist/
+npm test         # vitest unit tests
+```
+
+## License
+
+MIT — **WE ARE THE FRE4X.**

package/dist/api.d.ts

@@ -0,0 +1,17 @@
+import type { FredSearchResponse, FredSeriesInfoResponse, FredObservationsResponse, FredReleasesResponse, FredSourcesResponse, FredCategorySeriesResponse, FredSource } from './types.js';
+export declare class FredApiClient {
+    private client;
+    private apiKey;
+    constructor();
+    searchSeries(query: string, limit?: number, offset?: number): Promise<FredSearchResponse>;
+    getSeriesInfo(seriesId: string): Promise<FredSeriesInfoResponse>;
+    getSeriesObservations(seriesId: string, limit?: number, offset?: number): Promise<FredObservationsResponse>;
+    getCategorySeries(categoryId: number, limit?: number, offset?: number): Promise<FredCategorySeriesResponse>;
+    getReleases(limit?: number, offset?: number): Promise<FredReleasesResponse>;
+    getReleaseSeries(releaseId: number, limit?: number, offset?: number): Promise<FredCategorySeriesResponse>;
+    getSources(): Promise<FredSourcesResponse>;
+    getSource(sourceId: number): Promise<{
+        sources: FredSource[];
+    }>;
+}
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACR,kBAAkB,EAClB,sBAAsB,EACtB,wBAAwB,EACxB,oBAAoB,EACpB,mBAAmB,EACnB,0BAA0B,EAC1B,UAAU,EACb,MAAM,YAAY,CAAC;AAIpB,qBAAa,aAAa;IACtB,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,MAAM,CAAS;;IAgBjB,YAAY,CACd,KAAK,EAAE,MAAM,EACb,KAAK,SAAK,EACV,MAAM,SAAI,GACX,OAAO,CAAC,kBAAkB,CAAC;IAgBxB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAUhE,qBAAqB,CACvB,QAAQ,EAAE,MAAM,EAChB,KAAK,SAAO,EACZ,MAAM,SAAI,GACX,OAAO,CAAC,wBAAwB,CAAC;IAU9B,iBAAiB,CACnB,UAAU,EAAE,MAAM,EAClB,KAAK,SAAK,EACV,MAAM,SAAI,GACX,OAAO,CAAC,0BAA0B,CAAC;IAgBhC,WAAW,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAUlE,gBAAgB,CAClB,SAAS,EAAE,MAAM,EACjB,KAAK,SAAK,EACV,MAAM,SAAI,GACX,OAAO,CAAC,0BAA0B,CAAC;IAUhC,UAAU,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAK1C,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,UAAU,EAAE,CAAA;KAAE,CAAC;CASxE"}

package/dist/api.js

@@ -0,0 +1,76 @@
+import axios from 'axios';
+const FRED_BASE_URL = 'https://api.stlouisfed.org/fred';
+export class FredApiClient {
+    client;
+    apiKey;
+    constructor() {
+        const key = process.env.FRED_API_KEY;
+        if (!key) {
+            throw new Error('FRED_API_KEY environment variable not set. Please set it to use this server.');
+        }
+        this.apiKey = key;
+        this.client = axios.create({
+            baseURL: FRED_BASE_URL,
+            params: { api_key: this.apiKey, file_type: 'json' },
+        });
+    }
+    async searchSeries(query, limit = 20, offset = 0) {
+        const { data } = await this.client.get('/series/search', {
+            params: {
+                search_text: query,
+                limit,
+                offset,
+                order_by: 'popularity',
+                sort_order: 'desc',
+            },
+        });
+        return data;
+    }
+    async getSeriesInfo(seriesId) {
+        const { data } = await this.client.get('/series', {
+            params: { series_id: seriesId },
+        });
+        return data;
+    }
+    async getSeriesObservations(seriesId, limit = 1000, offset = 0) {
+        const { data } = await this.client.get('/series/observations', {
+            params: { series_id: seriesId, limit, offset },
+        });
+        return data;
+    }
+    async getCategorySeries(categoryId, limit = 20, offset = 0) {
+        const { data } = await this.client.get('/category/series', {
+            params: {
+                category_id: categoryId,
+                limit,
+                offset,
+                order_by: 'popularity',
+                sort_order: 'desc',
+            },
+        });
+        return data;
+    }
+    async getReleases(limit = 20, offset = 0) {
+        const { data } = await this.client.get('/releases', {
+            params: { limit, offset },
+        });
+        return data;
+    }
+    async getReleaseSeries(releaseId, limit = 20, offset = 0) {
+        const { data } = await this.client.get('/release/series', {
+            params: { release_id: releaseId, limit, offset },
+        });
+        return data;
+    }
+    async getSources() {
+        const { data } = await this.client.get('/sources');
+        return data;
+    }
+    async getSource(sourceId) {
+        const { data } = await this.client.get('/source', {
+            params: { source_id: sourceId },
+        });
+        return data;
+    }
+}
+//# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,OAAO,CAAC;AAWlD,MAAM,aAAa,GAAG,iCAAiC,CAAC;AAExD,MAAM,OAAO,aAAa;IACd,MAAM,CAAgB;IACtB,MAAM,CAAS;IAEvB;QACI,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;QACrC,IAAI,CAAC,GAAG,EAAE,CAAC;YACP,MAAM,IAAI,KAAK,CACX,8EAA8E,CACjF,CAAC;QACN,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YACvB,OAAO,EAAE,aAAa;YACtB,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE;SACtD,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,YAAY,CACd,KAAa,EACb,KAAK,GAAG,EAAE,EACV,MAAM,GAAG,CAAC;QAEV,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAClC,gBAAgB,EAChB;YACI,MAAM,EAAE;gBACJ,WAAW,EAAE,KAAK;gBAClB,KAAK;gBACL,MAAM;gBACN,QAAQ,EAAE,YAAY;gBACtB,UAAU,EAAE,MAAM;aACrB;SACJ,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,QAAgB;QAChC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAClC,SAAS,EACT;YACI,MAAM,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE;SAClC,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,qBAAqB,CACvB,QAAgB,EAChB,KAAK,GAAG,IAAI,EACZ,MAAM,GAAG,CAAC;QAEV,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAClC,sBAAsB,EACtB;YACI,MAAM,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE;SACjD,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,iBAAiB,CACnB,UAAkB,EAClB,KAAK,GAAG,EAAE,EACV,MAAM,GAAG,CAAC;QAEV,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAClC,kBAAkB,EAClB;YACI,MAAM,EAAE;gBACJ,WAAW,EAAE,UAAU;gBACvB,KAAK;gBACL,MAAM;gBACN,QAAQ,EAAE,YAAY;gBACtB,UAAU,EAAE,MAAM;aACrB;SACJ,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC;QACpC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAClC,WAAW,EACX;YACI,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;SAC5B,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,gBAAgB,CAClB,SAAiB,EACjB,KAAK,GAAG,EAAE,EACV,MAAM,GAAG,CAAC;QAEV,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAClC,iBAAiB,EACjB;YACI,MAAM,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE;SACnD,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,UAAU;QACZ,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAsB,UAAU,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,QAAgB;QAC5B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAClC,SAAS,EACT;YACI,MAAM,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE;SAClC,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# 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":""}