@decaf-ts/integrations 0.11.0 → 0.14.0

package/lib/types/io/airtable/AirtableService.d.mts

@@ -0,0 +1,268 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.mts";
+/**
+ * @description Configuration for the Airtable service
+ * @summary Extends {@link HttpApiServiceConfig} with the Airtable personal
+ * access token (sent as a bearer token) and the default `baseId` used when a
+ * call does not override it. When omitted, the `io.airtable` environment
+ * slice supplies the token (and optional `baseId`, `baseUrl`, `timeout`).
+ * @category IO
+ * @memberOf module:integrations/io/airtable/service
+ */
+export interface AirtableServiceConfig extends HttpApiServiceConfig {
+    /**
+     * @description Airtable personal access token
+     * @summary Sent as `Authorization: Bearer <token>` with every API call.
+     */
+    token?: string;
+    /**
+     * @description Default base ID used when a call does not override it
+     */
+    baseId?: string;
+}
+/**
+ * @description Normalized Airtable record descriptor
+ * @summary The Airtable record envelope: the record `id`, the `fields` map
+ * (column name to value), and the optional `createdTime` timestamp.
+ * @category IO
+ * @memberOf module:integrations/io/airtable/service
+ */
+export interface AirtableRecord {
+    id: string;
+    fields: Record<string, unknown>;
+    createdTime?: string;
+}
+/**
+ * @description Options for listing Airtable records
+ * @summary Carries the required `table` name plus the view, formula filter,
+ * record caps and paging offset, field projection, and first-sort configuration
+ * Airtable supports. Only the first sort entry is sent (Airtable's
+ * `sort[0][field]`/`sort[0][direction]` query parameters); paging works by
+ * passing the previous page's `offset` back as `offset`.
+ * @category IO
+ * @memberOf module:integrations/io/airtable/service
+ */
+export interface AirtableListOptions {
+    /**
+     * @description Table name or ID to list records from (required)
+     */
+    table: string;
+    /**
+     * @description View name or ID to restrict the listing to
+     */
+    view?: string;
+    /**
+     * @description Airtable formula restricting the returned records (e.g. `"{Status} = 'Active'"`)
+     */
+    filterByFormula?: string;
+    /**
+     * @description Maximum number of records to return in total
+     */
+    maxRecords?: number;
+    /**
+     * @description Number of records per page
+     */
+    pageSize?: number;
+    /**
+     * @description The `offset` from the previous page's result
+     */
+    offset?: string;
+    /**
+     * @description Column names to project
+     */
+    fields?: string[];
+    /**
+     * @description First sort entry applied to the listing
+     */
+    sort?: Array<{
+        field: string;
+        direction?: "asc" | "desc";
+    }>;
+}
+/**
+ * @description Result of an Airtable record listing
+ * @summary Carries the page of `records` and the `offset` cursor to pass back
+ * as `AirtableListOptions.offset` when more pages exist.
+ * @category IO
+ * @memberOf module:integrations/io/airtable/service
+ */
+export interface AirtableListResult {
+    records: AirtableRecord[];
+    offset?: string;
+}
+/**
+ * @description Input for creating or updating an Airtable record
+ * @summary Carries the required `table` name, the `fields` map to write, and
+ * the `typecast` flag letting Airtable convert values to the column types.
+ * `updateRecord` additionally carries the `recordId`.
+ * @category IO
+ * @memberOf module:integrations/io/airtable/service
+ */
+export interface AirtableWriteInput {
+    table: string;
+    fields: Record<string, unknown>;
+    typecast?: boolean;
+}
+/**
+ * @description Airtable Web API integration service
+ * @summary An undecorated HTTP service for listing records
+ * with filtering, sorting, and cursor paging; fetching, creating, updating,
+ * and deleting individual records. Base targets resolve per call from the
+ * `baseId` argument, falling back to the configured value, and throw
+ * `InternalError` when unresolved. Every operation requires a token
+ * (`requireToken()`), and transport failures are mapped to decaf errors via
+ * {@link httpError}.
+ * @class AirtableService
+ * @category IO
+ * @example
+ * ```ts
+ * import { AirtableService } from "@decaf-ts/integrations/io/airtable";
+ *
+ * const airtable = new AirtableService();
+ * await airtable.initialize({
+ *   token: process.env.GRAPH_CREDENTIAL_AIRTABLE_TOKEN,
+ *   baseId: "appExampleBase",
+ * });
+ * const created = await airtable.createRecord({
+ *   table: "Tasks",
+ *   fields: { Name: "Ship release", Status: "Todo" },
+ * });
+ * ```
+ * @memberOf module:integrations/io/airtable/service
+ */
+export declare class AirtableService extends HttpApiService<AirtableServiceConfig> {
+    /**
+     * @description The provider name used in error messages
+     */
+    protected readonly serviceName = "Airtable";
+    /**
+     * @description The Airtable Web API v0 base URL
+     * @summary Used when the resolved config carries no `baseUrl`.
+     * @returns {string} `"https://api.airtable.com/v0"`.
+     */
+    protected defaultBaseUrl(): string;
+    /**
+     * @description Builds the Airtable bearer authorization headers
+     * @summary Returns the `Authorization: Bearer <token>` header when the
+     * config carries a token, and no headers otherwise.
+     * @param {AirtableServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers (empty without a token).
+     */
+    protected authHeaders(config: AirtableServiceConfig): Record<string, string>;
+    /**
+     * @description Reads the Airtable credentials and defaults from the environment
+     * @summary Reads the `io.airtable` environment slice and returns a partial
+     * config when a token is configured, `undefined` otherwise. Values pass
+     * through `envString`/`envNumber` to reject unset-leaf proxies.
+     * @returns {Partial<AirtableServiceConfig> | undefined} A partial config, or `undefined` when no Airtable token is configured.
+     */
+    protected configFromEnvironment(): Partial<AirtableServiceConfig> | undefined;
+    /**
+     * @description Resolves the URL-encoded base path for a call
+     * @summary Builds `/<baseId>` from the given base ID, falling back to the
+     * configured value, and throws when neither is available.
+     * @param {string} [baseId] - The per-call base override.
+     * @returns {string} The URL-encoded base API path.
+     * @throws {InternalError} When neither the input nor the config yields a base ID.
+     */
+    protected basePath(baseId?: string): string;
+    /**
+     * @description Resolves the URL-encoded table path for a call
+     * @summary Builds `<basePath>/<table>` with both segments URL-encoded, and
+     * throws when the table name is empty (or the base cannot be resolved).
+     * @param {string} table - The table name or ID.
+     * @param {string} [baseId] - The per-call base override.
+     * @returns {string} The URL-encoded table API path.
+     * @throws {InternalError} When the table name is empty or the base ID cannot be resolved.
+     */
+    protected tablePath(table: string, baseId?: string): string;
+    /**
+     * @description Lists records in an Airtable table with cursor paging
+     * @summary `GET`s the table endpoint with the configured view, formula
+     * filter, record caps, page size, page offset, field projection, and first
+     * sort entry. Return the `offset` cursor as the next call's
+     * `AirtableListOptions.offset` to fetch further pages.
+     * @param {AirtableListOptions} options - The table and filter/sort/paging options.
+     * @param {string} [baseId] - The base override; falls back to the configured `baseId`.
+     * @returns {Promise<AirtableListResult>} The page of records and the next offset cursor when more pages exist.
+     * @throws {InternalError} When no token is configured or the table/base cannot be resolved.
+     * @throws {NotFoundError} When the base or table does not exist (HTTP 404).
+     * @throws {ConflictError} When Airtable answers with HTTP 409.
+     * @throws {BadRequestError} When Airtable answers with any other HTTP error status (e.g. invalid formula).
+     * @example
+     * ```ts
+     * let offset: string | undefined;
+     * do {
+     *   const page = await airtable.listRecords({
+     *     table: "Tasks",
+     *     filterByFormula: "{Status} = 'Active'",
+     *     pageSize: 100,
+     *     offset,
+     *     sort: [{ field: "Name", direction: "asc" }],
+     *   });
+     *   console.log(page.records);
+     *   offset = page.offset;
+     * } while (offset);
+     * ```
+     */
+    listRecords(options: AirtableListOptions, baseId?: string): Promise<AirtableListResult>;
+    /**
+     * @description Fetches a single Airtable record
+     * @summary `GET`s the table endpoint with the record ID appended and
+     * returns the record envelope.
+     * @param {string} table - The table name or ID.
+     * @param {string} recordId - The record ID to fetch (e.g. `"rec1234567890"`).
+     * @param {string} [baseId] - The base override; falls back to the configured `baseId`.
+     * @returns {Promise<AirtableRecord>} The record envelope.
+     * @throws {InternalError} When no token is configured or the table/base cannot be resolved.
+     * @throws {NotFoundError} When the record does not exist (HTTP 404).
+     * @throws {ConflictError} When Airtable answers with HTTP 409.
+     * @throws {BadRequestError} When Airtable answers with any other HTTP error status.
+     */
+    getRecord(table: string, recordId: string, baseId?: string): Promise<AirtableRecord>;
+    /**
+     * @description Creates an Airtable record
+     * @summary `POST`s the fields map to the table endpoint; `typecast` lets
+     * Airtable coerce values into the column types (disabled by default).
+     * @param {AirtableWriteInput} input - The table, fields, and typecast option.
+     * @param {string} [baseId] - The base override; falls back to the configured `baseId`.
+     * @returns {Promise<AirtableRecord>} The created record envelope.
+     * @throws {InternalError} When no token is configured or the table/base cannot be resolved.
+     * @throws {NotFoundError} When the base or table does not exist (HTTP 404).
+     * @throws {ConflictError} When Airtable answers with HTTP 409.
+     * @throws {BadRequestError} When Airtable answers with any other HTTP error status (e.g. invalid field values).
+     */
+    createRecord(input: AirtableWriteInput, baseId?: string): Promise<AirtableRecord>;
+    /**
+     * @description Updates an Airtable record
+     * @summary `PATCH`es the fields map onto the record identified by
+     * `recordId`; only the provided fields change. `typecast` lets Airtable
+     * coerce values into the column types (disabled by default).
+     * @param {AirtableWriteInput & {recordId: string}} input - The table, fields, typecast option, and target record ID.
+     * @param {string} [baseId] - The base override; falls back to the configured `baseId`.
+     * @returns {Promise<AirtableRecord>} The updated record envelope.
+     * @throws {InternalError} When no token is configured or the table/base cannot be resolved.
+     * @throws {NotFoundError} When the record does not exist (HTTP 404).
+     * @throws {ConflictError} When Airtable answers with HTTP 409.
+     * @throws {BadRequestError} When Airtable answers with any other HTTP error status (e.g. invalid field values).
+     */
+    updateRecord(input: AirtableWriteInput & {
+        recordId: string;
+    }, baseId?: string): Promise<AirtableRecord>;
+    /**
+     * @description Deletes an Airtable record
+     * @summary `DELETE`s the record identified by `recordId` and returns the
+     * Airtable deletion confirmation.
+     * @param {string} table - The table name or ID.
+     * @param {string} recordId - The record ID to delete.
+     * @param {string} [baseId] - The base override; falls back to the configured `baseId`.
+     * @returns {Promise<{id: string, deleted: boolean}>} The deleted record's ID and Airtable's `deleted` confirmation.
+     * @throws {InternalError} When no token is configured or the table/base cannot be resolved.
+     * @throws {NotFoundError} When the record does not exist (HTTP 404).
+     * @throws {ConflictError} When Airtable answers with HTTP 409.
+     * @throws {BadRequestError} When Airtable answers with any other HTTP error status.
+     */
+    deleteRecord(table: string, recordId: string, baseId?: string): Promise<{
+        id: string;
+        deleted: boolean;
+    }>;
+}

package/lib/types/io/airtable/index.d.cts

@@ -0,0 +1,6 @@
+/**
+ * @module integrations/io/airtable
+ * @summary Airtable Web API service (record CRUD).
+ * @description Re-exports the Airtable client-based service and its types.
+ */
+export * from "./AirtableService.d.cts";

package/lib/types/io/airtable/index.d.mts

@@ -0,0 +1,6 @@
+/**
+ * @module integrations/io/airtable
+ * @summary Airtable Web API service (record CRUD).
+ * @description Re-exports the Airtable client-based service and its types.
+ */
+export * from "./AirtableService.d.mts";

package/lib/types/io/confluence/ConfluenceService.d.cts

@@ -0,0 +1,250 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.cts";
+/**
+ * @description Configuration for the Confluence service
+ * @summary Extends {@link HttpApiServiceConfig} with the API `token`, the
+ * optional `username` that enables Basic authentication, and the required
+ * site `baseUrl`. When omitted, the `io.confluence` environment slice supplies
+ * the same values (plus optional `timeout`).
+ * @category IO
+ * @memberOf module:integrations/io/confluence/service
+ */
+export interface ConfluenceServiceConfig extends HttpApiServiceConfig {
+    /**
+     * @description Confluence API token
+     * @summary Used as the Basic-auth password when `username` is set, otherwise as a bearer token.
+     */
+    token?: string;
+    /**
+     * @description Confluence account username for Basic authentication
+     */
+    username?: string;
+}
+/**
+ * @description Input for creating a Confluence page
+ * @summary Carries the target `spaceKey`, page `title`, storage-format body,
+ * and optional `parentId` of the ancestor page.
+ * @category IO
+ * @memberOf module:integrations/io/confluence/service
+ */
+export interface ConfluencePageInput {
+    /**
+     * @description Space key that owns the new page
+     */
+    spaceKey: string;
+    /**
+     * @description Page title (unique within the space)
+     */
+    title: string;
+    /**
+     * @description Page body in Confluence storage format
+     */
+    body: string;
+    /**
+     * @description Optional parent page ID
+     */
+    parentId?: string;
+}
+/**
+ * @description Input for updating a Confluence page
+ * @summary Carries the `pageId`, new `title` and storage-format body, and an
+ * optional `version`. When `version` is omitted the service fetches the
+ * current version and submits the next one.
+ * @category IO
+ * @memberOf module:integrations/io/confluence/service
+ */
+export interface ConfluencePageUpdate {
+    /**
+     * @description ID of the page to update
+     */
+    pageId: string;
+    /**
+     * @description New page title
+     */
+    title: string;
+    /**
+     * @description New page body in Confluence storage format
+     */
+    body: string;
+    /**
+     * @description Explicit new version number (auto-incremented when omitted)
+     */
+    version?: number;
+}
+/**
+ * @description Input for a Confluence CQL search
+ * @summary Carries the `cql` query and an optional result `limit`.
+ * @category IO
+ * @memberOf module:integrations/io/confluence/service
+ */
+export interface ConfluenceSearchInput {
+    /**
+     * @description Confluence Query Language expression
+     */
+    cql: string;
+    /**
+     * @description Maximum number of results
+     */
+    limit?: number;
+}
+/**
+ * @description Confluence REST API integration service
+ * @summary An undecorated HTTP service for reading, creating, updating, and
+ * deleting pages, listing spaces, and running CQL searches. The site base URL
+ * and API token are required; supplying a `username` switches authentication to
+ * Basic, and transport failures are mapped to decaf errors via
+ * {@link httpError}.
+ * @class ConfluenceService
+ * @extends HttpApiService
+ * @category IO
+ * @example
+ * ```ts
+ * import { ConfluenceService } from "@decaf-ts/integrations/io/confluence";
+ *
+ * const confluence = new ConfluenceService();
+ * await confluence.initialize({
+ *   baseUrl: "https://example.atlassian.net/wiki",
+ *   username: process.env.CONFLUENCE_USERNAME,
+ *   token: process.env.GRAPH_CREDENTIAL_CONFLUENCE_TOKEN,
+ * });
+ * const page = await confluence.getPage("123456");
+ * ```
+ * @mermaid
+ * sequenceDiagram
+ *   autonumber
+ *   participant Caller
+ *   participant Service as ConfluenceService
+ *   participant API as Confluence REST API
+ *   Caller->>Service: updatePage(input)
+ *   activate Service
+ *   Service->>Service: requireCredentials()
+ *   opt version omitted
+ *     Service->>API: GET /rest/api/content/{id}?expand=version
+ *     activate API
+ *     API-->>Service: current version
+ *     deactivate API
+ *   end
+ *   Service->>API: PUT /rest/api/content/{id}
+ *   activate API
+ *   API-->>Service: updated page
+ *   deactivate API
+ *   Service-->>Caller: updated page
+ *   deactivate Service
+ * @memberOf module:integrations/io/confluence/service
+ */
+export declare class ConfluenceService extends HttpApiService<ConfluenceServiceConfig> {
+    /**
+     * @description The provider name used in error messages
+     */
+    protected readonly serviceName = "Confluence";
+    /**
+     * @description The default base URL for Confluence
+     * @summary Returns an empty string; Confluence is site-hosted, so the
+     * resolved `baseUrl` (from config or `io.confluence.baseUrl`) is required.
+     * @returns {string} An empty string.
+     */
+    protected defaultBaseUrl(): string;
+    /**
+     * @description Builds the Confluence authentication headers
+     * @summary Uses HTTP Basic (`username:token`) when both values are present,
+     * otherwise a bearer token when only `token` is present, otherwise no
+     * headers.
+     * @param {ConfluenceServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers.
+     */
+    protected authHeaders(config: ConfluenceServiceConfig): Record<string, string>;
+    /**
+     * @description Reads the Confluence credentials and defaults from the environment
+     * @summary Reads the `io.confluence` slice and returns a partial config when
+     * an API token is configured, `undefined` otherwise. Values pass through
+     * `envString`/`envNumber` to reject unset-leaf proxies.
+     * @returns {Partial<ConfluenceServiceConfig> | undefined} A partial config, or `undefined` when no Confluence token is configured.
+     */
+    protected configFromEnvironment(): Partial<ConfluenceServiceConfig> | undefined;
+    /**
+     * @description Asserts that the Confluence token and site base URL are configured
+     * @summary Called by every operation before it touches the network.
+     * @returns {void}
+     * @throws {InternalError} When no API token or base URL is configured.
+     */
+    protected requireCredentials(): void;
+    /**
+     * @description Wraps a body in the Confluence storage representation
+     * @summary Produces the `{ storage: { value, representation } }` envelope
+     * the content API expects.
+     * @param {string} body - The Confluence storage-format body.
+     * @returns {Record<string, unknown>} The storage body envelope.
+     */
+    private storageBody;
+    /**
+     * @description Fetches a Confluence page
+     * @summary `GET`s `/rest/api/content/<id>` with the requested `expand`
+     * fields (default `body.storage,version`).
+     * @param {string} pageId - The page ID.
+     * @param {string} [expand] - Comma-separated fields to expand; defaults to `"body.storage,version"`.
+     * @returns {Promise<unknown>} The page payload.
+     * @throws {InternalError} When credentials are missing or the page ID is empty.
+     * @throws {NotFoundError} When the page does not exist (HTTP 404).
+     * @throws {BadRequestError} When the API rejects the request.
+     */
+    getPage(pageId: string, expand?: string): Promise<unknown>;
+    /**
+     * @description Lists Confluence spaces
+     * @summary `GET`s `/rest/api/space` with a result `limit` (default `25`).
+     * @param {number} [limit] - Maximum number of spaces to return; defaults to `25`.
+     * @returns {Promise<unknown>} The space collection payload.
+     * @throws {InternalError} When credentials are missing.
+     * @throws {BadRequestError} When the API rejects the request.
+     */
+    listSpaces(limit?: number): Promise<unknown>;
+    /**
+     * @description Creates a Confluence page
+     * @summary `POST`s a `page` content entry in the target space, optionally
+     * under a parent, with the body in storage format.
+     * @param {ConfluencePageInput} input - The space, title, body, and optional parent.
+     * @returns {Promise<unknown>} The created page payload.
+     * @throws {InternalError} When credentials are missing, or the space key or title is empty.
+     * @throws {BadRequestError} When the API rejects the page.
+     * @example
+     * ```ts
+     * await confluence.createPage({
+     *   spaceKey: "OPS",
+     *   title: "Release 1.2.0",
+     *   body: "<p>Details…</p>",
+     * });
+     * ```
+     */
+    createPage(input: ConfluencePageInput): Promise<unknown>;
+    /**
+     * @description Updates a Confluence page
+     * @summary `PUT`s the new title and storage body. When `version` is omitted
+     * the current version is read first and the next number is submitted, as
+     * Confluence requires optimistic versioning.
+     * @param {ConfluencePageUpdate} input - The page, new title/body, and optional version.
+     * @returns {Promise<unknown>} The updated page payload.
+     * @throws {InternalError} When credentials are missing, or the page ID or title is empty.
+     * @throws {NotFoundError} When the page does not exist (HTTP 404).
+     * @throws {ConflictError} When the submitted version is stale (HTTP 409).
+     * @throws {BadRequestError} When the API rejects the update.
+     */
+    updatePage(input: ConfluencePageUpdate): Promise<unknown>;
+    /**
+     * @description Deletes a Confluence page
+     * @summary `DELETE`s the content entry and returns `{ deleted: true, pageId }`.
+     * @param {string} pageId - The page ID to delete.
+     * @returns {Promise<unknown>} `{ deleted: true, pageId }` on success.
+     * @throws {InternalError} When credentials are missing or the page ID is empty.
+     * @throws {NotFoundError} When the page does not exist (HTTP 404).
+     * @throws {BadRequestError} When the API rejects the deletion.
+     */
+    deletePage(pageId: string): Promise<unknown>;
+    /**
+     * @description Searches Confluence content with CQL
+     * @summary `GET`s `/rest/api/content/search` with the CQL expression and an
+     * optional `limit`.
+     * @param {ConfluenceSearchInput} input - The CQL query and result limit.
+     * @returns {Promise<unknown>} The search result payload.
+     * @throws {InternalError} When credentials are missing or the CQL query is empty.
+     * @throws {BadRequestError} When the CQL query is invalid.
+     */
+    search(input: ConfluenceSearchInput): Promise<unknown>;
+}