@dereekb/trello 13.11.14

package/src/lib/trello/trello.api.card.d.ts

@@ -0,0 +1,116 @@
+import { type TrelloContext } from './trello.factory';
+import { type TrelloCardId, type TrelloLabelId, type TrelloMemberId } from '../trello.type';
+import { type CreateCardBody, type TrelloAction, type TrelloCard, type TrelloCommentCardAction, type UpdateCardBody } from './trello.api.card.type';
+export interface GetCardInput {
+    readonly cardId: TrelloCardId;
+}
+export type GetCardFunction = (input: GetCardInput) => Promise<TrelloCard>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that retrieves a card by id.
+ */
+export declare function getCard(context: TrelloContext): GetCardFunction;
+export type CreateCardFunction = (input: CreateCardBody) => Promise<TrelloCard>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-post
+ *
+ * @param context The Trello API context.
+ * @returns A function that creates a card on a list.
+ */
+export declare function createCard(context: TrelloContext): CreateCardFunction;
+export interface UpdateCardInput extends UpdateCardBody {
+    readonly cardId: TrelloCardId;
+}
+export type UpdateCardFunction = (input: UpdateCardInput) => Promise<TrelloCard>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-put
+ *
+ * @param context The Trello API context.
+ * @returns A function that updates an existing card.
+ */
+export declare function updateCard(context: TrelloContext): UpdateCardFunction;
+export type DeleteCardFunction = (input: GetCardInput) => Promise<void>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-delete
+ *
+ * @param context The Trello API context.
+ * @returns A function that deletes a card.
+ */
+export declare function deleteCard(context: TrelloContext): DeleteCardFunction;
+/**
+ * Known Trello action type. Trello supports many more (40+) — pass any string for filters not enumerated here.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/guides/rest-api/action-types/
+ */
+export type TrelloActionType = 'commentCard' | 'updateCard' | 'createCard' | 'deleteCard' | 'addMemberToCard' | 'removeMemberFromCard' | 'addAttachmentToCard' | 'deleteAttachmentFromCard' | 'addChecklistToCard' | 'removeChecklistFromCard' | 'updateCheckItemStateOnCard' | 'addLabelToCard' | 'removeLabelFromCard' | string;
+export interface ListCardActionsInput {
+    readonly cardId: TrelloCardId;
+    /**
+     * Comma-separated list of action types to include, or `all`. Defaults to `commentCard,updateCard:idList` server-side.
+     */
+    readonly filter?: TrelloActionType;
+    /**
+     * Maximum number of actions to return. Defaults to 50 server-side; max is 1000.
+     */
+    readonly limit?: number;
+    /**
+     * Cursor: return actions before this action id (older).
+     */
+    readonly before?: string;
+    /**
+     * Cursor: return actions since this action id (newer).
+     */
+    readonly since?: string;
+}
+export type ListCardActionsFunction = <D = unknown>(input: ListCardActionsInput) => Promise<ReadonlyArray<TrelloAction<D>>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-actions-get
+ *
+ * Comments are returned as actions with `type === 'commentCard'`; pass `filter: 'commentCard'` and the generic
+ * type parameter `TrelloCommentCardActionData` to get a comment-typed result.
+ *
+ * @param context The Trello API context.
+ * @returns A function that lists actions on a card.
+ */
+export declare function listCardActions(context: TrelloContext): ListCardActionsFunction;
+export interface AddCommentToCardInput {
+    readonly cardId: TrelloCardId;
+    /**
+     * Comment text (1-16384 characters).
+     */
+    readonly text: string;
+}
+export type AddCommentToCardFunction = (input: AddCommentToCardInput) => Promise<TrelloCommentCardAction>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-actions-comments-post
+ *
+ * @param context The Trello API context.
+ * @returns A function that adds a comment to a card.
+ */
+export declare function addCommentToCard(context: TrelloContext): AddCommentToCardFunction;
+export interface AddMemberToCardInput {
+    readonly cardId: TrelloCardId;
+    readonly memberId: TrelloMemberId;
+}
+export type AddMemberToCardFunction = (input: AddMemberToCardInput) => Promise<ReadonlyArray<TrelloMemberId>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-idmembers-post
+ *
+ * @param context The Trello API context.
+ * @returns A function that adds a member to a card.
+ */
+export declare function addMemberToCard(context: TrelloContext): AddMemberToCardFunction;
+export interface AddLabelToCardInput {
+    readonly cardId: TrelloCardId;
+    readonly labelId: TrelloLabelId;
+}
+export type AddLabelToCardFunction = (input: AddLabelToCardInput) => Promise<ReadonlyArray<TrelloLabelId>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-idlabels-post
+ *
+ * @param context The Trello API context.
+ * @returns A function that adds an existing label to a card.
+ */
+export declare function addLabelToCard(context: TrelloContext): AddLabelToCardFunction;

package/src/lib/trello/trello.api.card.type.d.ts

@@ -0,0 +1,141 @@
+import { type Maybe } from '@dereekb/util';
+import { type TrelloActionId, type TrelloBoardId, type TrelloCardId, type TrelloChecklistId, type TrelloLabelId, type TrelloListId, type TrelloMemberId } from '../trello.type';
+import { type TrelloLabelColor, type TrelloMaybeDateString, type TrelloPosition } from '../shared/trello.type';
+import { type TrelloMember } from './trello.api.member.type';
+/**
+ * Trello label.
+ */
+export interface TrelloLabel {
+    readonly id: TrelloLabelId;
+    readonly idBoard: TrelloBoardId;
+    readonly name: string;
+    readonly color: Maybe<TrelloLabelColor>;
+}
+/**
+ * Card `badges` summary block. Trello populates ~12 fields here; only the
+ * most commonly-read ones are typed. Cast for additional fields.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-get
+ */
+export interface TrelloCardBadges {
+    readonly attachments?: number;
+    readonly comments?: number;
+    readonly checkItems?: number;
+    readonly checkItemsChecked?: number;
+    readonly description?: boolean;
+    readonly subscribed?: boolean;
+    readonly votes?: number;
+}
+/**
+ * Trello card.
+ *
+ * Only the most commonly-used fields are typed. Use `fields=all` and a custom cast when more are required.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-get
+ */
+export interface TrelloCard {
+    readonly id: TrelloCardId;
+    readonly name: string;
+    readonly desc: string;
+    readonly closed: boolean;
+    readonly idBoard: TrelloBoardId;
+    readonly idList: TrelloListId;
+    readonly idMembers: ReadonlyArray<TrelloMemberId>;
+    readonly idLabels: ReadonlyArray<TrelloLabelId>;
+    readonly idChecklists: ReadonlyArray<TrelloChecklistId>;
+    readonly labels: ReadonlyArray<TrelloLabel>;
+    readonly pos: number;
+    readonly due: TrelloMaybeDateString;
+    readonly dueComplete: boolean;
+    readonly start: TrelloMaybeDateString;
+    readonly url: string;
+    readonly shortUrl: string;
+    readonly shortLink: string;
+    readonly dateLastActivity: TrelloMaybeDateString;
+    readonly badges?: TrelloCardBadges;
+    readonly subscribed?: boolean;
+}
+export interface CreateCardBody {
+    /**
+     * The id of the list the card should be created on. Required.
+     */
+    readonly idList: TrelloListId;
+    /**
+     * Card name (1-16384 characters).
+     */
+    readonly name?: string;
+    /**
+     * Card description.
+     */
+    readonly desc?: string;
+    /**
+     * Position on the list.
+     */
+    readonly pos?: TrelloPosition;
+    /**
+     * Optional comma-separated list of label ids.
+     */
+    readonly idLabels?: ReadonlyArray<TrelloLabelId>;
+    /**
+     * Optional comma-separated list of member ids.
+     */
+    readonly idMembers?: ReadonlyArray<TrelloMemberId>;
+    /**
+     * Optional due date as an ISO date string.
+     */
+    readonly due?: TrelloMaybeDateString;
+    /**
+     * Optional start date as an ISO date string.
+     */
+    readonly start?: TrelloMaybeDateString;
+}
+export interface UpdateCardBody {
+    readonly name?: string;
+    readonly desc?: string;
+    readonly closed?: boolean;
+    readonly idList?: TrelloListId;
+    readonly idBoard?: TrelloBoardId;
+    readonly idLabels?: ReadonlyArray<TrelloLabelId>;
+    readonly idMembers?: ReadonlyArray<TrelloMemberId>;
+    readonly due?: TrelloMaybeDateString;
+    readonly dueComplete?: boolean;
+    readonly start?: TrelloMaybeDateString;
+    readonly pos?: TrelloPosition;
+    readonly subscribed?: boolean;
+}
+/**
+ * A Trello action (i.e. an immutable activity log entry).
+ *
+ * Comments are surfaced as actions with `type === 'commentCard'`.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/rest/api-group-actions/
+ */
+export interface TrelloAction<D = unknown> {
+    readonly id: TrelloActionId;
+    readonly idMemberCreator: TrelloMemberId;
+    readonly type: string;
+    readonly date: string;
+    readonly data: D;
+    /**
+     * Member who created the action. Populated when the request includes
+     * `member=true` (the default). Omitted otherwise.
+     */
+    readonly memberCreator?: TrelloMember;
+}
+export interface TrelloCommentCardActionData {
+    readonly text: string;
+    readonly card: {
+        readonly id: TrelloCardId;
+        readonly idShort?: number;
+        readonly name?: string;
+    };
+    readonly board: {
+        readonly id: TrelloBoardId;
+        readonly name?: string;
+    };
+    readonly list?: {
+        readonly id: TrelloListId;
+        readonly name?: string;
+    };
+}
+export type TrelloCommentCardAction = TrelloAction<TrelloCommentCardActionData>;

package/src/lib/trello/trello.api.list.d.ts

@@ -0,0 +1,46 @@
+import { type TrelloContext } from './trello.factory';
+import { type TrelloListId } from '../trello.type';
+import { type CreateListBody, type TrelloList, type UpdateListBody } from './trello.api.list.type';
+import { type TrelloCard } from './trello.api.card.type';
+export interface GetListInput {
+    readonly listId: TrelloListId;
+}
+export type GetListFunction = (input: GetListInput) => Promise<TrelloList>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-lists/#api-lists-id-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that retrieves a list by id.
+ */
+export declare function getList(context: TrelloContext): GetListFunction;
+export type CreateListFunction = (input: CreateListBody) => Promise<TrelloList>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-lists/#api-lists-post
+ *
+ * @param context The Trello API context.
+ * @returns A function that creates a new list on a board.
+ */
+export declare function createList(context: TrelloContext): CreateListFunction;
+export interface UpdateListInput extends UpdateListBody {
+    readonly listId: TrelloListId;
+}
+export type UpdateListFunction = (input: UpdateListInput) => Promise<TrelloList>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-lists/#api-lists-id-put
+ *
+ * @param context The Trello API context.
+ * @returns A function that updates an existing list.
+ */
+export declare function updateList(context: TrelloContext): UpdateListFunction;
+export interface ListCardsInListInput {
+    readonly listId: TrelloListId;
+    readonly filter?: 'all' | 'closed' | 'none' | 'open';
+}
+export type ListCardsInListFunction = (input: ListCardsInListInput) => Promise<ReadonlyArray<TrelloCard>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-lists/#api-lists-id-cards-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that lists all cards on a list.
+ */
+export declare function listCardsInList(context: TrelloContext): ListCardsInListFunction;

package/src/lib/trello/trello.api.list.type.d.ts

@@ -0,0 +1,40 @@
+import { type TrelloBoardId, type TrelloListId } from '../trello.type';
+import { type TrelloPosition } from '../shared/trello.type';
+/**
+ * Trello list.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/rest/api-group-lists/#api-lists-id-get
+ */
+export interface TrelloList {
+    readonly id: TrelloListId;
+    readonly name: string;
+    readonly closed: boolean;
+    readonly idBoard: TrelloBoardId;
+    readonly pos: number;
+    readonly subscribed?: boolean;
+}
+export interface CreateListBody {
+    /**
+     * Name of the list (1-16384 characters).
+     */
+    readonly name: string;
+    /**
+     * The id of the board the list belongs to. Required.
+     */
+    readonly idBoard: TrelloBoardId;
+    /**
+     * The id of the list to copy from. Cannot be used with `idBoard`.
+     */
+    readonly idListSource?: TrelloListId;
+    /**
+     * Position of the list (top, bottom, or a positive number).
+     */
+    readonly pos?: TrelloPosition;
+}
+export interface UpdateListBody {
+    readonly name?: string;
+    readonly closed?: boolean;
+    readonly idBoard?: TrelloBoardId;
+    readonly pos?: TrelloPosition;
+    readonly subscribed?: boolean;
+}

package/src/lib/trello/trello.api.member.d.ts

@@ -0,0 +1,25 @@
+import { type TrelloContext } from './trello.factory';
+import { type TrelloMemberId } from '../trello.type';
+import { type TrelloMember } from './trello.api.member.type';
+export interface GetMemberInput {
+    /**
+     * Member id, username, or the literal `me` (the authenticated user).
+     */
+    readonly memberId: TrelloMemberId | 'me' | string;
+}
+export type GetMemberFunction = (input: GetMemberInput) => Promise<TrelloMember>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-members/#api-members-id-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that retrieves a member by id (or `me`).
+ */
+export declare function getMember(context: TrelloContext): GetMemberFunction;
+export type GetMeFunction = () => Promise<TrelloMember>;
+/**
+ * Convenience wrapper around `getMember({ memberId: 'me' })`.
+ *
+ * @param context The Trello API context.
+ * @returns A function that retrieves the authenticated user.
+ */
+export declare function getMe(context: TrelloContext): GetMeFunction;

package/src/lib/trello/trello.api.member.type.d.ts

@@ -0,0 +1,20 @@
+import { type EmailAddress, type Maybe } from '@dereekb/util';
+import { type TrelloBoardId, type TrelloMemberId, type TrelloOrganizationId, type TrelloUsername } from '../trello.type';
+/**
+ * Trello member.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/rest/api-group-members/#api-members-id-get
+ */
+export interface TrelloMember {
+    readonly id: TrelloMemberId;
+    readonly username: TrelloUsername;
+    readonly fullName: string;
+    readonly initials: string;
+    readonly avatarUrl: Maybe<string>;
+    /**
+     * Email is only returned for the requesting user, and only when the token has the `account` scope.
+     */
+    readonly email?: Maybe<EmailAddress>;
+    readonly idBoards?: ReadonlyArray<TrelloBoardId>;
+    readonly idOrganizations?: ReadonlyArray<TrelloOrganizationId>;
+}

package/src/lib/trello/trello.api.webhook.d.ts

@@ -0,0 +1,57 @@
+import { type TrelloContext } from './trello.factory';
+import { type TrelloApiToken, type TrelloWebhookId } from '../trello.type';
+import { type CreateWebhookBody, type TrelloWebhook, type UpdateWebhookBody } from './trello.api.webhook.type';
+export type CreateWebhookFunction = (input: CreateWebhookBody) => Promise<TrelloWebhook>;
+/**
+ * Trello validates the callback URL with a HEAD request before creation. The endpoint MUST return 200.
+ *
+ * https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/#creating-a-webhook
+ *
+ * @param context The Trello API context.
+ * @returns A function that registers a new webhook.
+ */
+export declare function createWebhook(context: TrelloContext): CreateWebhookFunction;
+export interface GetWebhookInput {
+    readonly webhookId: TrelloWebhookId;
+}
+export type GetWebhookFunction = (input: GetWebhookInput) => Promise<TrelloWebhook>;
+/**
+ * https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/#retrieving-a-webhook
+ *
+ * @param context The Trello API context.
+ * @returns A function that retrieves a webhook by id.
+ */
+export declare function getWebhook(context: TrelloContext): GetWebhookFunction;
+export interface UpdateWebhookInput extends UpdateWebhookBody {
+    readonly webhookId: TrelloWebhookId;
+}
+export type UpdateWebhookFunction = (input: UpdateWebhookInput) => Promise<TrelloWebhook>;
+/**
+ * https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/#updating-a-webhook
+ *
+ * @param context The Trello API context.
+ * @returns A function that updates an existing webhook.
+ */
+export declare function updateWebhook(context: TrelloContext): UpdateWebhookFunction;
+export type DeleteWebhookFunction = (input: GetWebhookInput) => Promise<void>;
+/**
+ * https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/#deleting-a-webhook
+ *
+ * @param context The Trello API context.
+ * @returns A function that deletes a webhook.
+ */
+export declare function deleteWebhook(context: TrelloContext): DeleteWebhookFunction;
+export interface ListWebhooksForTokenInput {
+    /**
+     * Optional override for the token whose webhooks to list. Defaults to the context's configured token.
+     */
+    readonly apiToken?: TrelloApiToken;
+}
+export type ListWebhooksForTokenFunction = (input?: ListWebhooksForTokenInput) => Promise<ReadonlyArray<TrelloWebhook>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/
+ *
+ * @param context The Trello API context.
+ * @returns A function that lists all webhooks registered for a token.
+ */
+export declare function listWebhooksForToken(context: TrelloContext): ListWebhooksForTokenFunction;

package/src/lib/trello/trello.api.webhook.type.d.ts

@@ -0,0 +1,41 @@
+import { type Maybe } from '@dereekb/util';
+import { type TrelloId, type TrelloWebhookId } from '../trello.type';
+/**
+ * Trello webhook registration.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/
+ */
+export interface TrelloWebhook {
+    readonly id: TrelloWebhookId;
+    readonly idModel: TrelloId;
+    readonly callbackURL: string;
+    readonly description: string;
+    readonly active: boolean;
+    readonly consecutiveFailures?: number;
+    readonly firstConsecutiveFailDate?: Maybe<string>;
+}
+export interface CreateWebhookBody {
+    /**
+     * The id of the model (board, card, member, list, etc.) to subscribe to.
+     */
+    readonly idModel: TrelloId;
+    /**
+     * The URL Trello will POST to when an event occurs.
+     *
+     * Trello validates this URL with a HEAD request before creation. It must respond with 200.
+     */
+    readonly callbackURL: string;
+    /**
+     * Optional human-readable description.
+     */
+    readonly description?: string;
+    /**
+     * Whether the webhook is active. Defaults to true.
+     */
+    readonly active?: boolean;
+}
+export interface UpdateWebhookBody {
+    readonly callbackURL?: string;
+    readonly description?: string;
+    readonly active?: boolean;
+}

package/src/lib/trello/trello.factory.d.ts

@@ -0,0 +1,54 @@
+import { type ConfiguredFetch, type FetchJsonFunction } from '@dereekb/util/fetch';
+import { type Maybe, type ResetPeriodPromiseRateLimiter } from '@dereekb/util';
+import { type LogTrelloServerErrorFunction } from '../trello.error.api';
+import { type TrelloRateLimitedFetchHandlerConfig } from '../trello.limit';
+import { type TrelloConfig } from '../trello.config';
+/**
+ * A Trello context used for making authenticated requests to the Trello REST API.
+ */
+export interface TrelloContext {
+    /**
+     * Configured fetch that handles auth, rate limiting, and error normalization.
+     */
+    readonly fetch: ConfiguredFetch;
+    /**
+     * Convenience fetchJson wrapper.
+     */
+    readonly fetchJson: FetchJsonFunction;
+    /**
+     * The configuration this context was created with.
+     */
+    readonly config: TrelloConfig;
+    /**
+     * The underlying rate limiter used by the configured fetch.
+     */
+    readonly trelloRateLimiter: ResetPeriodPromiseRateLimiter;
+}
+export interface TrelloContextRef {
+    readonly trelloContext: TrelloContext;
+}
+/**
+ * A Trello API instance wrapping a {@link TrelloContext}.
+ */
+export type Trello = TrelloContextRef;
+export interface TrelloFactoryConfig {
+    /**
+     * Optional rate limiter configuration override.
+     */
+    readonly rateLimiterConfig?: Maybe<TrelloRateLimitedFetchHandlerConfig>;
+    /**
+     * Optional custom error logger.
+     */
+    readonly logTrelloServerErrorFunction?: LogTrelloServerErrorFunction;
+}
+export type TrelloFactory = (config: TrelloConfig) => Trello;
+/**
+ * Builds a Trello API factory.
+ *
+ * Auth uses Trello's `Authorization: OAuth oauth_consumer_key=..., oauth_token=...` header form so credentials never appear in URLs or logs.
+ *
+ * @param factoryConfig Factory-level configuration shared across created Trello instances.
+ * @returns A factory function that creates a configured Trello API instance.
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function trelloFactory(factoryConfig?: TrelloFactoryConfig): TrelloFactory;

package/src/lib/trello.api.page.d.ts

@@ -0,0 +1,92 @@
+import { type Maybe } from '@dereekb/util';
+import { type FetchPageFactory, type FetchPageFactoryConfigDefaults } from '@dereekb/util/fetch';
+import { type TrelloActionId, type TrelloId } from './trello.type';
+/**
+ * Maximum allowed `limit` value for most Trello collection endpoints.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/rest/
+ */
+export declare const TRELLO_MAX_PAGE_LIMIT = 1000;
+/**
+ * Filter shape for Trello cursor-style pagination using action IDs.
+ *
+ * Trello collection endpoints typically accept `before`/`since` filters that take an item id
+ * (often an action id or card id) and return items older/newer than that cursor.
+ */
+export interface TrelloCursorPageFilter {
+    /**
+     * Returns items before this id (older).
+     */
+    readonly before?: TrelloId;
+    /**
+     * Returns items since this id (newer).
+     */
+    readonly since?: TrelloId;
+    /**
+     * Maximum number of items to return. Defaults vary per endpoint; max is typically 1000.
+     */
+    readonly limit?: number;
+}
+/**
+ * A Trello collection endpoint typically returns a bare JSON array.
+ *
+ * This type captures pagination metadata around such a response.
+ */
+export interface TrelloPageResult<T> {
+    /**
+     * The page data.
+     */
+    readonly data: ReadonlyArray<T>;
+    /**
+     * Maximum items requested for this page (echoed from input).
+     */
+    readonly limit: number;
+    /**
+     * Cursor that can be used as `before` to fetch the next (older) page.
+     *
+     * Undefined when this page has fewer items than the requested limit.
+     */
+    readonly nextBefore?: TrelloId;
+}
+/**
+ * Reads the id of the last item in a Trello page response, for use as the next page's `before` cursor.
+ */
+export type TrelloPageItemIdReader<T> = (item: T) => TrelloId;
+/**
+ * Default reader that pulls `id` off the item. Works for most Trello resource types.
+ *
+ * @param item The page item whose id to read.
+ * @returns The item's id.
+ */
+export declare const defaultTrelloPageItemIdReader: <T extends {
+    readonly id: TrelloId;
+}>(item: T) => TrelloId;
+/**
+ * Reader that pulls the action id off a Trello action item.
+ *
+ * @param item The action page item whose id to read.
+ * @returns The item's action id.
+ */
+export declare const trelloActionIdReader: <T extends {
+    readonly id: TrelloActionId;
+}>(item: T) => TrelloActionId;
+/**
+ * Wraps a raw Trello collection fetch into a {@link TrelloPageResult}.
+ *
+ * @param input The page filter that was used.
+ * @param data The raw page items.
+ * @param idReader Function to read the id from the last item.
+ * @returns A page result with the data and a cursor for the next page.
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function buildTrelloPageResult<T>(input: TrelloCursorPageFilter, data: ReadonlyArray<T>, idReader: TrelloPageItemIdReader<T>): TrelloPageResult<T>;
+export type TrelloFetchPageFetchFunction<I extends TrelloCursorPageFilter, R extends TrelloPageResult<unknown>> = (input: I) => Promise<R>;
+/**
+ * Creates a FetchPageFactory using the input TrelloFetchPageFetchFunction.
+ *
+ * @param fetch Function that fetches a single page of results from the Trello API.
+ * @param defaults Optional default pagination configuration.
+ * @returns A configured FetchPageFactory that handles Trello's cursor-based pagination using `before`.
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function trelloFetchPageFactory<I extends TrelloCursorPageFilter, R extends TrelloPageResult<unknown>>(fetch: TrelloFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): FetchPageFactory<I, R>;

package/src/lib/trello.config.d.ts

@@ -0,0 +1,20 @@
+import { type TrelloApiKey, type TrelloApiToken, type TrelloApiUrl } from './trello.type';
+/**
+ * Configuration for a TrelloContext.
+ */
+export interface TrelloConfig {
+    /**
+     * Trello API key. Created at https://trello.com/power-ups/admin.
+     *
+     * Note that the API key alone does not grant access to user data.
+     */
+    readonly apiKey: TrelloApiKey;
+    /**
+     * Trello user API token. Required for all authenticated requests.
+     */
+    readonly apiToken: TrelloApiToken;
+    /**
+     * Optional custom API base URL. Defaults to https://api.trello.com/1.
+     */
+    readonly apiUrl?: TrelloApiUrl | string;
+}