@decaf-ts/integrations 0.10.8 → 0.12.0

package/lib/esm/io/google-sheets/GoogleSheetsService.js

@@ -0,0 +1,283 @@
+/**
+ * @module integrations/io/google-sheets/service
+ * @summary Google Sheets API integration service for reading and writing spreadsheet values.
+ * @description Exposes the Google Sheets v4 values API (`get`, `update`,
+ * `append`, `clear`) and spreadsheet creation as an undecorated
+ * client-based service built on
+ * {@link HttpApiService}. Authentication accepts either an OAuth token
+ * (bearer) or a plain API key (`X-Goog-Api-Key`); configuration comes from an
+ * explicit `GoogleSheetsServiceConfig` or the `io.googleSheets` environment
+ * slice, and failures are mapped to decaf errors via {@link httpError}.
+ */
+import { InternalError } from "@decaf-ts/db-decorators";
+import { IoEnvironment } from "./../environment.js";
+import { envNumber, envString } from "./../../shared/environmentValue.js";
+import { HttpApiService, httpError, } from "./../../shared/http/index.js";
+/**
+ * @description Google Sheets API integration service
+ * @summary An undecorated HTTP service for reading,
+ * updating, appending, and clearing values in A1 ranges of a spreadsheet, and
+ * for creating new spreadsheets. Every operation requires either an OAuth
+ * token or an API key (`requireAuth()`); ranges and spreadsheet IDs are
+ * URL-encoded, and transport failures are mapped to decaf errors via
+ * {@link httpError}.
+ * @class GoogleSheetsService
+ * @category IO
+ * @example
+ * ```ts
+ * import { GoogleSheetsService } from "@decaf-ts/integrations/io/google-sheets";
+ *
+ * const sheets = new GoogleSheetsService();
+ * await sheets.initialize({
+ *   token: process.env.GRAPH_CREDENTIAL_GOOGLE_SHEETS_TOKEN,
+ * });
+ * const created = await sheets.createSpreadsheet("Metrics");
+ * await sheets.updateValues({
+ *   spreadsheetId: created.spreadsheetId,
+ *   range: "Sheet1!A1:B2",
+ *   values: [
+ *     ["date", "count"],
+ *     ["2026-01-01", "42"],
+ *   ],
+ * });
+ * ```
+ * @memberOf module:integrations/io/google-sheets/service
+ */
+export class GoogleSheetsService extends HttpApiService {
+    constructor() {
+        super(...arguments);
+        /**
+         * @description The provider name used in error messages
+         */
+        this.serviceName = "Google Sheets";
+    }
+    /**
+     * @description The Google Sheets v4 values API base URL
+     * @summary Used when the resolved config carries no `baseUrl`.
+     * @returns {string} `"https://sheets.googleapis.com/v4/spreadsheets"`.
+     */
+    defaultBaseUrl() {
+        return "https://sheets.googleapis.com/v4/spreadsheets";
+    }
+    /**
+     * @description Builds the Google Sheets authorization headers
+     * @summary Returns the `Authorization: Bearer <token>` header when the
+     * config carries an OAuth token, otherwise the `X-Goog-Api-Key` header when
+     * an API key is configured, and no headers otherwise.
+     * @param {GoogleSheetsServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers (empty without a token or API key).
+     */
+    authHeaders(config) {
+        if (config.token)
+            return { Authorization: `Bearer ${config.token}` };
+        if (config.apiKey)
+            return { "X-Goog-Api-Key": config.apiKey };
+        return {};
+    }
+    /**
+     * @description Reads the Google Sheets credentials and defaults from the environment
+     * @summary Reads the `io.googleSheets` environment slice and returns a
+     * partial config when a token or API key is configured, `undefined`
+     * otherwise. Values pass through `envString`/`envNumber` to reject
+     * unset-leaf proxies.
+     * @returns {Partial<GoogleSheetsServiceConfig> | undefined} A partial config, or `undefined` when neither token nor API key is configured.
+     */
+    configFromEnvironment() {
+        const env = IoEnvironment.io.googleSheets;
+        const token = envString(env?.token);
+        const apiKey = envString(env?.apiKey);
+        if (!token && !apiKey)
+            return undefined;
+        return {
+            token,
+            apiKey,
+            baseUrl: envString(env.baseUrl),
+            timeout: envNumber(env.timeout),
+        };
+    }
+    /**
+     * @description Asserts that the service was configured with OAuth credentials
+     * @summary Throws when the resolved config carries neither a `token` nor an
+     * `apiKey`; every operation calls this before issuing requests.
+     * @returns {void}
+     * @throws {InternalError} When neither an OAuth token nor an API key is configured.
+     */
+    requireAuth() {
+        const config = this.config;
+        if (!config.token && !config.apiKey) {
+            throw new InternalError("Google Sheets requires an OAuth token or an API key");
+        }
+    }
+    /**
+     * @description URL-encodes an A1 range for the values API path
+     * @summary Ranges such as `Sheet1!A1:B2` contain characters that must be
+     * percent-encoded; all operations route the range through this helper.
+     * @param {string} range - The A1 notation range to encode.
+     * @returns {string} The URL-encoded range.
+     */
+    rangePath(range) {
+        return encodeURIComponent(range);
+    }
+    /**
+     * @description Reads values from an A1 range of a spreadsheet
+     * @summary `GET`s the values endpoint for the given `spreadsheetId` and
+     * `range` and returns the served range, major dimension, and the grid
+     * values (rows of cell strings). Requires credentials and both arguments.
+     * @param {string} spreadsheetId - The spreadsheet to read from.
+     * @param {string} range - The A1 notation range to read (e.g. `"Sheet1!A1:C10"`).
+     * @returns {Promise<GoogleSheetsValuesResult>} The served range and grid values.
+     * @throws {InternalError} When credentials are missing or the spreadsheet ID/range is empty.
+     * @throws {NotFoundError} When the spreadsheet does not exist (HTTP 404).
+     * @throws {ConflictError} When Google answers with HTTP 409.
+     * @throws {BadRequestError} When Google answers with any other HTTP error status (e.g. invalid range).
+     */
+    async getValues(spreadsheetId, range) {
+        this.requireAuth();
+        if (!spreadsheetId || !range) {
+            throw new InternalError("Google Sheets getValues requires a spreadsheet ID and range");
+        }
+        try {
+            const response = await this.client.get(`/${encodeURIComponent(spreadsheetId)}/values/${this.rangePath(range)}`);
+            return {
+                spreadsheetId,
+                range: response.data.range ?? range,
+                majorDimension: response.data.majorDimension,
+                values: response.data.values ?? [],
+            };
+        }
+        catch (error) {
+            throw httpError("Google Sheets", "get values", error);
+        }
+    }
+    /**
+     * @description Overwrites values in an A1 range of a spreadsheet
+     * @summary `PUT`s the row values to the values endpoint for the given
+     * `spreadsheetId` and `range`. Cells are interpreted according to
+     * `valueInputOption` (`"USER_ENTERED"` by default, `"RAW"` to store text
+     * verbatim), and the existing range content is replaced.
+     * @param {GoogleSheetsWriteInput} input - The target spreadsheet, range, values, and input interpretation.
+     * @returns {Promise<GoogleSheetsValuesResult>} The served range and the written values.
+     * @throws {InternalError} When credentials are missing.
+     * @throws {NotFoundError} When the spreadsheet does not exist (HTTP 404).
+     * @throws {ConflictError} When Google answers with HTTP 409.
+     * @throws {BadRequestError} When Google answers with any other HTTP error status (e.g. invalid range).
+     */
+    async updateValues(input) {
+        this.requireAuth();
+        try {
+            const response = await this.client.put(`/${encodeURIComponent(input.spreadsheetId)}/values/${this.rangePath(input.range)}`, {
+                range: input.range,
+                majorDimension: "ROWS",
+                values: input.values,
+            }, {
+                params: {
+                    valueInputOption: input.valueInputOption ?? "USER_ENTERED",
+                },
+            });
+            return {
+                spreadsheetId: input.spreadsheetId,
+                range: response.data.range ?? input.range,
+                majorDimension: response.data.majorDimension ?? "ROWS",
+                values: response.data.values ?? input.values,
+            };
+        }
+        catch (error) {
+            throw httpError("Google Sheets", "update values", error);
+        }
+    }
+    /**
+     * @description Appends values after the last row of an A1 range's table
+     * @summary `POST`s the row values to the `:append` endpoint for the given
+     * `spreadsheetId` and `range`, inserting new rows after existing table data
+     * (`insertDataOption: "INSERT_ROWS"`). Cells are interpreted according to
+     * `valueInputOption` (`"USER_ENTERED"` by default). Use a single-row or
+     * single-column A1 range to anchor the table; Google reports the range the
+     * data actually landed in.
+     * @param {GoogleSheetsWriteInput} input - The target spreadsheet, anchor range, values, and input interpretation.
+     * @returns {Promise<GoogleSheetsValuesResult>} The range the appended rows landed in and the appended values.
+     * @throws {InternalError} When credentials are missing.
+     * @throws {NotFoundError} When the spreadsheet does not exist (HTTP 404).
+     * @throws {ConflictError} When Google answers with HTTP 409.
+     * @throws {BadRequestError} When Google answers with any other HTTP error status (e.g. invalid range).
+     */
+    async appendValues(input) {
+        this.requireAuth();
+        try {
+            const response = await this.client.post(`/${encodeURIComponent(input.spreadsheetId)}/values/${this.rangePath(input.range)}:append`, {
+                range: input.range,
+                majorDimension: "ROWS",
+                values: input.values,
+            }, {
+                params: {
+                    valueInputOption: input.valueInputOption ?? "USER_ENTERED",
+                    insertDataOption: "INSERT_ROWS",
+                },
+            });
+            return {
+                spreadsheetId: input.spreadsheetId,
+                range: response.data.range ?? input.range,
+                majorDimension: response.data.majorDimension ?? "ROWS",
+                values: response.data.values ?? [],
+            };
+        }
+        catch (error) {
+            throw httpError("Google Sheets", "append values", error);
+        }
+    }
+    /**
+     * @description Clears all values in an A1 range of a spreadsheet
+     * @summary `POST`s the `:clear` endpoint for the given `spreadsheetId` and
+     * `range`, emptying the cells while preserving formatting, and returns the
+     * range Google actually cleared.
+     * @param {string} spreadsheetId - The spreadsheet to clear values in.
+     * @param {string} range - The A1 notation range to clear.
+     * @returns {Promise<{spreadsheetId: string, clearedRange: string}>} The cleared range as reported by Google.
+     * @throws {InternalError} When credentials are missing.
+     * @throws {NotFoundError} When the spreadsheet does not exist (HTTP 404).
+     * @throws {ConflictError} When Google answers with HTTP 409.
+     * @throws {BadRequestError} When Google answers with any other HTTP error status (e.g. invalid range).
+     */
+    async clearValues(spreadsheetId, range) {
+        this.requireAuth();
+        try {
+            const response = await this.client.post(`/${encodeURIComponent(spreadsheetId)}/values/${this.rangePath(range)}:clear`, {});
+            return {
+                spreadsheetId,
+                clearedRange: response.data.clearedRange ?? range,
+            };
+        }
+        catch (error) {
+            throw httpError("Google Sheets", "clear values", error);
+        }
+    }
+    /**
+     * @description Creates a new spreadsheet with the given title
+     * @summary `POST`s a spreadsheet resource with `properties.title` to the
+     * spreadsheets endpoint and returns the new spreadsheet's ID and URL.
+     * @param {string} title - The title for the new spreadsheet.
+     * @returns {Promise<{spreadsheetId: string, spreadsheetUrl?: string}>} The created spreadsheet's ID and URL.
+     * @throws {InternalError} When credentials are missing or the title is empty.
+     * @throws {NotFoundError} When Google answers with HTTP 404.
+     * @throws {ConflictError} When Google answers with HTTP 409.
+     * @throws {BadRequestError} When Google answers with any other HTTP error status.
+     */
+    async createSpreadsheet(title) {
+        this.requireAuth();
+        if (!title) {
+            throw new InternalError("Google Sheets createSpreadsheet requires a title");
+        }
+        try {
+            const response = await this.client.post("/", {
+                properties: { title },
+            });
+            return {
+                spreadsheetId: response.data.spreadsheetId,
+                spreadsheetUrl: response.data.spreadsheetUrl,
+            };
+        }
+        catch (error) {
+            throw httpError("Google Sheets", "create spreadsheet", error);
+        }
+    }
+}
+//# sourceMappingURL=GoogleSheetsService.js.map

package/lib/esm/io/google-sheets/GoogleSheetsService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GoogleSheetsService.js","sourceRoot":"","sources":["../../../../src/io/google-sheets/GoogleSheetsService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,4BAAuB;AAC/C,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,2CAAsC;AACrE,OAAO,EACL,cAAc,EAEd,SAAS,GACV,qCAA0B;AAwD3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,mBAAoB,SAAQ,cAAyC;IAAlF;;QACE;;WAEG;QACgB,gBAAW,GAAG,eAAe,CAAC;IAmRnD,CAAC;IAjRC;;;;OAIG;IACO,cAAc;QACtB,OAAO,+CAA+C,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACO,WAAW,CACnB,MAAiC;QAEjC,IAAI,MAAM,CAAC,KAAK;YAAE,OAAO,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;QACrE,IAAI,MAAM,CAAC,MAAM;YAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;QAC9D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;OAOG;IACO,qBAAqB;QAG7B,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,CAAC,YAAY,CAAC;QAC1C,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YAAE,OAAO,SAAS,CAAC;QACxC,OAAO;YACL,KAAK;YACL,MAAM;YACN,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;YAC/B,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;SAChC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,WAAW;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,aAAa,CACrB,qDAAqD,CACtD,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACO,SAAS,CAAC,KAAa;QAC/B,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,SAAS,CACb,aAAqB,EACrB,KAAa;QAEb,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,aAAa,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,MAAM,IAAI,aAAa,CACrB,6DAA6D,CAC9D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,IAAI,kBAAkB,CAAC,aAAa,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CACxE,CAAC;YACF,OAAO;gBACL,aAAa;gBACb,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK;gBACnC,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAc;gBAC5C,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE;aACnC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,eAAe,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,YAAY,CAChB,KAA6B;QAE7B,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,IAAI,kBAAkB,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,IAAI,CAAC,SAAS,CAClE,KAAK,CAAC,KAAK,CACZ,EAAE,EACH;gBACE,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,cAAc,EAAE,MAAM;gBACtB,MAAM,EAAE,KAAK,CAAC,MAAM;aACrB,EACD;gBACE,MAAM,EAAE;oBACN,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,IAAI,cAAc;iBAC3D;aACF,CACF,CAAC;YACF,OAAO;gBACL,aAAa,EAAE,KAAK,CAAC,aAAa;gBAClC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK;gBACzC,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAc,IAAI,MAAM;gBACtD,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM;aAC7C,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,eAAe,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,YAAY,CAChB,KAA6B;QAE7B,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,IAAI,kBAAkB,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,IAAI,CAAC,SAAS,CAClE,KAAK,CAAC,KAAK,CACZ,SAAS,EACV;gBACE,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,cAAc,EAAE,MAAM;gBACtB,MAAM,EAAE,KAAK,CAAC,MAAM;aACrB,EACD;gBACE,MAAM,EAAE;oBACN,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,IAAI,cAAc;oBAC1D,gBAAgB,EAAE,aAAa;iBAChC;aACF,CACF,CAAC;YACF,OAAO;gBACL,aAAa,EAAE,KAAK,CAAC,aAAa;gBAClC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK;gBACzC,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAc,IAAI,MAAM;gBACtD,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE;aACnC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,eAAe,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW,CACf,aAAqB,EACrB,KAAa;QAEb,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,IAAI,kBAAkB,CAAC,aAAa,CAAC,WAAW,IAAI,CAAC,SAAS,CAC5D,KAAK,CACN,QAAQ,EACT,EAAE,CACH,CAAC;YACF,OAAO;gBACL,aAAa;gBACb,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,YAAY,IAAI,KAAK;aAClD,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,eAAe,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,iBAAiB,CACrB,KAAa;QAEb,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,aAAa,CACrB,kDAAkD,CACnD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAGpC,GAAG,EAAE;gBACN,UAAU,EAAE,EAAE,KAAK,EAAE;aACtB,CAAC,CAAC;YACH,OAAO;gBACL,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAa;gBAC1C,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAc;aAC7C,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,eAAe,EAAE,oBAAoB,EAAE,KAAK,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;CACF"}

package/lib/esm/io/google-sheets/index.js

@@ -0,0 +1,7 @@
+/**
+ * @module integrations/io/google-sheets
+ * @summary Google Sheets REST v4 service (values read/write/append/clear, spreadsheet creation).
+ * @description Re-exports the Google Sheets client-based service and its types.
+ */
+export * from "./GoogleSheetsService.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/io/google-sheets/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/io/google-sheets/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,yCAAsC"}

package/lib/esm/io/graphql/GraphqlService.js

@@ -0,0 +1,138 @@
+import { InternalError } from "@decaf-ts/db-decorators";
+import { IoEnvironment } from "./../environment.js";
+import { envNumber, envString } from "./../../shared/environmentValue.js";
+import { HttpApiService, httpError, } from "./../../shared/http/index.js";
+/**
+ * @description Generic GraphQL endpoint integration service
+ * @summary An undecorated HTTP service that `POST`s GraphQL
+ * documents to any endpoint. Unlike the other integration services there is
+ * no default base URL — the endpoint must come from the config (`endpoint` or
+ * `baseUrl`) or the `io.graphql` environment slice. Initialization normalizes
+ * the `endpoint` alias to `baseUrl` before delegating to the shared
+ * {@link HttpApiService.initialize}; the optional token is sent as a bearer
+ * header and per-request headers extend it. Transport failures are mapped to
+ * decaf errors via {@link httpError}, while GraphQL field-level `errors` are
+ * returned in the response for the caller to interpret.
+ * @class GraphqlService
+ * @category IO
+ * @example
+ * ```ts
+ * import { GraphqlService } from "@decaf-ts/integrations/io/graphql";
+ *
+ * const graphql = new GraphqlService();
+ * await graphql.initialize({
+ *   endpoint: "https://api.example.com/graphql",
+ *   token: process.env.GRAPH_CREDENTIAL_GRAPHQL_TOKEN,
+ * });
+ * const response = await graphql.request<{ user: { name: string } }>({
+ *   query: `query GetUser($id: ID!) {
+ *     user(id: $id) { name }
+ *   }`,
+ *   variables: { id: "123" },
+ * });
+ * ```
+ * @memberOf module:integrations/io/graphql/service
+ */
+export class GraphqlService extends HttpApiService {
+    constructor() {
+        super(...arguments);
+        /**
+         * @description The provider name used in error messages
+         */
+        this.serviceName = "GraphQL";
+    }
+    /**
+     * @description The absence of a default GraphQL endpoint
+     * @summary Returns an empty string because GraphQL endpoints are
+     * provider-specific; {@link GraphqlService.request} rejects execution when
+     * no endpoint was configured.
+     * @returns {string} An empty string.
+     */
+    defaultBaseUrl() {
+        return "";
+    }
+    /**
+     * @description Normalizes the `endpoint` alias before shared initialization
+     * @summary When the provided config carries no `baseUrl` but an `endpoint`,
+     * copies `endpoint` into `baseUrl` and delegates to
+     * {@link HttpApiService.initialize}, which merges the environment slice and
+     * builds the Axios client.
+     * @param {...MaybeContextualArg<any>} args - An optional `Partial<GraphqlServiceConfig>`, optionally followed by a decaf `Context`.
+     * @returns {Promise<{config: GraphqlServiceConfig, client: AxiosInstance}>} The merged configuration and the configured Axios instance.
+     * @throws {InternalError} When no base URL can be resolved from the config or environment.
+     */
+    async initialize(...args) {
+        const provided = (args[0] ?? {});
+        if (!provided.baseUrl && provided.endpoint) {
+            args[0] = { ...provided, baseUrl: provided.endpoint };
+        }
+        return super.initialize(...args);
+    }
+    /**
+     * @description Builds the GraphQL bearer authorization headers
+     * @summary Returns the `Authorization: Bearer <token>` header when the
+     * config carries a token, and no headers otherwise.
+     * @param {GraphqlServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers (empty without a token).
+     */
+    authHeaders(config) {
+        return config.token ? { Authorization: `Bearer ${config.token}` } : {};
+    }
+    /**
+     * @description Reads the GraphQL endpoint and token from the environment
+     * @summary Reads the `io.graphql` environment slice and returns a partial
+     * config (with `endpoint` also mirrored to `baseUrl`) when an endpoint is
+     * configured, `undefined` otherwise. Values pass through
+     * `envString`/`envNumber` to reject unset-leaf proxies.
+     * @returns {Partial<GraphqlServiceConfig> | undefined} A partial config, or `undefined` when no GraphQL endpoint is configured.
+     */
+    configFromEnvironment() {
+        const env = IoEnvironment.io.graphql;
+        const endpoint = envString(env?.endpoint);
+        if (!endpoint)
+            return undefined;
+        return {
+            endpoint,
+            baseUrl: endpoint,
+            token: envString(env.token),
+            timeout: envNumber(env.timeout),
+        };
+    }
+    /**
+     * @description Executes a GraphQL query or mutation against the configured endpoint
+     * @summary `POST`s the standard GraphQL request body (`query`,
+     * `variables`, `operationName`) to the resolved endpoint with the optional
+     * per-request headers merged over the client defaults. Requires a
+     * non-empty query and a configured endpoint. Returns the raw execution
+     * envelope: field-level `errors` are reported in `GraphqlResponse.errors`
+     * rather than thrown, so callers must inspect them for partial failures.
+     * @template T - The expected type of the `data` payload.
+     * @param {GraphqlRequest} input - The query document, variables, operation name, and per-request headers.
+     * @returns {Promise<GraphqlResponse<T>>} The execution envelope with `data`, `errors`, and `extensions`.
+     * @throws {InternalError} When the query is empty or no endpoint is configured.
+     * @throws {NotFoundError} When the endpoint answers with HTTP 404.
+     * @throws {ConflictError} When the endpoint answers with HTTP 409.
+     * @throws {BadRequestError} When the endpoint answers with any other HTTP error status.
+     */
+    async request(input) {
+        if (!input.query || input.query.trim().length === 0) {
+            throw new InternalError("GraphQL request requires a query");
+        }
+        const endpoint = this.config.endpoint ?? this.config.baseUrl;
+        if (!endpoint) {
+            throw new InternalError("GraphQL requires an endpoint");
+        }
+        try {
+            const response = await this.client.post(endpoint, {
+                query: input.query,
+                variables: input.variables,
+                operationName: input.operationName,
+            }, { headers: input.headers });
+            return response.data;
+        }
+        catch (error) {
+            throw httpError("GraphQL", "request", error);
+        }
+    }
+}
+//# sourceMappingURL=GraphqlService.js.map

package/lib/esm/io/graphql/GraphqlService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphqlService.js","sourceRoot":"","sources":["../../../../src/io/graphql/GraphqlService.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,4BAAuB;AAC/C,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,2CAAsC;AACrE,OAAO,EACL,cAAc,EAEd,SAAS,GACV,qCAA0B;AAmE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,OAAO,cAAe,SAAQ,cAAoC;IAAxE;;QACE;;WAEG;QACgB,gBAAW,GAAG,SAAS,CAAC;IAyG7C,CAAC;IAvGC;;;;;;OAMG;IACO,cAAc;QACtB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU,CACd,GAAG,IAA6B;QAEhC,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAkC,CAAC;QAClE,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACxD,CAAC;QACD,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CAAC,MAA4B;QAChD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACO,qBAAqB;QAC7B,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,CAAC,OAAO,CAAC;QACrC,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ;YAAE,OAAO,SAAS,CAAC;QAChC,OAAO;YACL,QAAQ;YACR,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC;YAC3B,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;SAChC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,OAAO,CACX,KAAqB;QAErB,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,aAAa,CAAC,kCAAkC,CAAC,CAAC;QAC9D,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAC7D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,aAAa,CAAC,8BAA8B,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,QAAQ,EACR;gBACE,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,aAAa,EAAE,KAAK,CAAC,aAAa;aACnC,EACD,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAC3B,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;CACF"}

package/lib/esm/io/graphql/index.js

@@ -0,0 +1,7 @@
+/**
+ * @module integrations/io/graphql
+ * @summary Generic GraphQL endpoint client (queries and mutations).
+ * @description Re-exports the GraphQL client-based service and its types.
+ */
+export * from "./GraphqlService.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/io/graphql/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/io/graphql/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oCAAiC"}

package/lib/esm/io/index.js

@@ -0,0 +1,13 @@
+/**
+ * @module integrations/io
+ * @summary IO integration services (Google Sheets, Airtable, GraphQL, Spreadsheet).
+ * @description Re-exports the data-source services, their per-service modules,
+ * and the shared `io` environment slice. Each sub-module is also available
+ * through its own package subpath export.
+ */
+export * from "./airtable/index.js";
+export * from "./google-sheets/index.js";
+export * from "./graphql/index.js";
+export * from "./spreadsheet/index.js";
+export * from "./environment.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/io/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/io/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oCAA2B;AAC3B,yCAAgC;AAChC,mCAA0B;AAC1B,uCAA8B;AAC9B,iCAA8B"}