@dereekb/trello 13.11.14

package/nestjs/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@dereekb/trello/nestjs",
+  "version": "13.11.14",
+  "peerDependencies": {
+    "@dereekb/nestjs": "13.11.14",
+    "@dereekb/rxjs": "13.11.14",
+    "@dereekb/trello": "13.11.14",
+    "@dereekb/util": "13.11.14",
+    "@nestjs/common": "^11.1.19",
+    "@nestjs/config": "^4.0.4",
+    "express": "^5.2.1"
+  },
+  "devDependencies": {
+    "@nestjs/testing": "^11.1.19"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "types": "./index.d.ts",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    }
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js",
+  "types": "./index.d.ts"
+}

package/nestjs/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/nestjs/src/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './trello';
+export * from './webhook';

package/nestjs/src/lib/trello/index.d.ts

@@ -0,0 +1,3 @@
+export * from './trello.api';
+export * from './trello.config';
+export * from './trello.module';

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

@@ -0,0 +1,36 @@
+import { type Trello, type TrelloContext } from '@dereekb/trello';
+import { TrelloServiceConfig } from './trello.config';
+export declare class TrelloApi {
+    readonly config: TrelloServiceConfig;
+    readonly trello: Trello;
+    get trelloContext(): TrelloContext;
+    get trelloRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
+    constructor(config: TrelloServiceConfig);
+    get getBoard(): import("@dereekb/trello").GetBoardFunction;
+    get createBoard(): import("@dereekb/trello").CreateBoardFunction;
+    get updateBoard(): import("@dereekb/trello").UpdateBoardFunction;
+    get deleteBoard(): import("@dereekb/trello").DeleteBoardFunction;
+    get listBoardLists(): import("@dereekb/trello").ListBoardListsFunction;
+    get listBoardCards(): import("@dereekb/trello").ListBoardCardsFunction;
+    get listBoardMembers(): import("@dereekb/trello").ListBoardMembersFunction;
+    get listBoardLabels(): import("@dereekb/trello").ListBoardLabelsFunction;
+    get getList(): import("@dereekb/trello").GetListFunction;
+    get createList(): import("@dereekb/trello").CreateListFunction;
+    get updateList(): import("@dereekb/trello").UpdateListFunction;
+    get listCardsInList(): import("@dereekb/trello").ListCardsInListFunction;
+    get getCard(): import("@dereekb/trello").GetCardFunction;
+    get createCard(): import("@dereekb/trello").CreateCardFunction;
+    get updateCard(): import("@dereekb/trello").UpdateCardFunction;
+    get deleteCard(): import("@dereekb/trello").DeleteCardFunction;
+    get addCommentToCard(): import("@dereekb/trello").AddCommentToCardFunction;
+    get addMemberToCard(): import("@dereekb/trello").AddMemberToCardFunction;
+    get addLabelToCard(): import("@dereekb/trello").AddLabelToCardFunction;
+    get listCardActions(): import("@dereekb/trello").ListCardActionsFunction;
+    get getMember(): import("@dereekb/trello").GetMemberFunction;
+    get getMe(): import("@dereekb/trello").GetMeFunction;
+    get createWebhook(): import("@dereekb/trello").CreateWebhookFunction;
+    get getWebhook(): import("@dereekb/trello").GetWebhookFunction;
+    get updateWebhook(): import("@dereekb/trello").UpdateWebhookFunction;
+    get deleteWebhook(): import("@dereekb/trello").DeleteWebhookFunction;
+    get listWebhooksForToken(): import("@dereekb/trello").ListWebhooksForTokenFunction;
+}

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

@@ -0,0 +1,12 @@
+import { type TrelloConfig, type TrelloFactoryConfig } from '@dereekb/trello';
+export declare const TRELLO_API_KEY_ENV_VAR = "TRELLO_API_KEY";
+export declare const TRELLO_API_TOKEN_ENV_VAR = "TRELLO_API_TOKEN";
+export type TrelloServiceApiConfig = TrelloConfig;
+/**
+ * Configuration for TrelloApi.
+ */
+export declare abstract class TrelloServiceConfig {
+    readonly trello: TrelloServiceApiConfig;
+    readonly factoryConfig?: TrelloFactoryConfig;
+    static assertValidConfig(config: TrelloServiceConfig): void;
+}

package/nestjs/src/lib/trello/trello.module.d.ts

@@ -0,0 +1,21 @@
+import { type ModuleMetadata } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { TrelloServiceConfig } from './trello.config';
+/**
+ * Default factory function for creating TrelloServiceConfig from ConfigService.
+ *
+ * Reads `TRELLO_API_KEY` and `TRELLO_API_TOKEN` from the environment.
+ *
+ * @param configService The NestJS ConfigService.
+ * @returns A validated TrelloServiceConfig.
+ */
+export declare function trelloServiceConfigFactory(configService: ConfigService): TrelloServiceConfig;
+export interface ProvideAppTrelloMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
+}
+/**
+ * Convenience function used to generate ModuleMetadata for an app's TrelloModule.
+ *
+ * @param config Optional additional module metadata overrides.
+ * @returns Module metadata for the Trello module.
+ */
+export declare function appTrelloModuleMetadata(config?: ProvideAppTrelloMetadataConfig): ModuleMetadata;

package/nestjs/src/lib/webhook/index.d.ts

@@ -0,0 +1,7 @@
+export * from './webhook.trello';
+export * from './webhook.trello.config';
+export * from './webhook.trello.controller';
+export * from './webhook.trello.module';
+export * from './webhook.trello.service';
+export * from './webhook.trello.type';
+export * from './webhook.trello.verify';

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

@@ -0,0 +1,22 @@
+import { type TrelloAppSecret } from '@dereekb/trello';
+export declare const TRELLO_APP_SECRET_ENV_VAR = "TRELLO_APP_SECRET";
+export declare const TRELLO_WEBHOOK_CALLBACK_URL_ENV_VAR = "TRELLO_WEBHOOK_CALLBACK_URL";
+export interface TrelloWebhookConfig {
+    /**
+     * The Trello app secret used to verify webhook signatures.
+     */
+    readonly appSecret: TrelloAppSecret;
+    /**
+     * The exact callback URL configured for the registered webhook.
+     *
+     * Must match the URL Trello was given on registration — the HMAC is computed over `rawBody + callbackUrl`.
+     */
+    readonly callbackUrl: string;
+}
+/**
+ * Configuration for {@link TrelloWebhookService}.
+ */
+export declare abstract class TrelloWebhookServiceConfig {
+    readonly webhookConfig: TrelloWebhookConfig;
+    static assertValidConfig(config: TrelloWebhookServiceConfig): void;
+}

package/nestjs/src/lib/webhook/webhook.trello.controller.d.ts

@@ -0,0 +1,12 @@
+import { type RawBodyBuffer } from '@dereekb/nestjs';
+import { type Request } from 'express';
+import { TrelloWebhookService } from './webhook.trello.service';
+export declare class TrelloWebhookController {
+    readonly trelloWebhookService: TrelloWebhookService;
+    constructor(trelloWebhookService: TrelloWebhookService);
+    /**
+     * Endpoint Trello pings with HEAD during webhook registration. Must return 200.
+     */
+    handleTrelloWebhookHead(): void;
+    handleTrelloWebhook(req: Request, rawBody: RawBodyBuffer): Promise<void>;
+}

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

@@ -0,0 +1,50 @@
+import { type Handler, type HandlerBindAccessor, type HandlerMappedSetFunction } from '@dereekb/util';
+import { type TrelloWebhookActionType, type TrelloWebhookAddMemberToCardActionData, type TrelloWebhookBoardActionData, type TrelloWebhookCardActionData, type TrelloWebhookCommentCardActionData, type TrelloWebhookEvent, type UntypedTrelloWebhookEvent } from './webhook.trello.type';
+/**
+ * Action type emitted when a new card is created.
+ */
+export declare const TRELLO_WEBHOOK_CREATE_CARD_ACTION_TYPE = "createCard";
+/**
+ * Action type emitted when a card is updated.
+ */
+export declare const TRELLO_WEBHOOK_UPDATE_CARD_ACTION_TYPE = "updateCard";
+/**
+ * Action type emitted when a card is deleted.
+ */
+export declare const TRELLO_WEBHOOK_DELETE_CARD_ACTION_TYPE = "deleteCard";
+/**
+ * Action type emitted when a comment is added to a card.
+ */
+export declare const TRELLO_WEBHOOK_COMMENT_CARD_ACTION_TYPE = "commentCard";
+/**
+ * Action type emitted when a member is added to a card.
+ */
+export declare const TRELLO_WEBHOOK_ADD_MEMBER_TO_CARD_ACTION_TYPE = "addMemberToCard";
+/**
+ * Action type emitted when a member is removed from a card.
+ */
+export declare const TRELLO_WEBHOOK_REMOVE_MEMBER_FROM_CARD_ACTION_TYPE = "removeMemberFromCard";
+/**
+ * Action type emitted when a board is updated.
+ */
+export declare const TRELLO_WEBHOOK_UPDATE_BOARD_ACTION_TYPE = "updateBoard";
+/**
+ * Re-narrows an UntypedTrelloWebhookEvent's payload to the given action data type.
+ *
+ * @param event The untyped event.
+ * @returns A typed view over the same event.
+ */
+export declare function trelloWebhookEvent<D>(event: UntypedTrelloWebhookEvent): TrelloWebhookEvent<D>;
+export type TrelloEventHandler = Handler<UntypedTrelloWebhookEvent, TrelloWebhookActionType>;
+export declare const trelloEventHandlerFactory: import("@dereekb/util").HandlerFactory<UntypedTrelloWebhookEvent, string, boolean>;
+export type TrelloHandlerMappedSetFunction<D> = HandlerMappedSetFunction<TrelloWebhookEvent<D>>;
+export interface TrelloEventHandlerConfigurer extends HandlerBindAccessor<UntypedTrelloWebhookEvent, TrelloWebhookActionType> {
+    handleCreateCard: TrelloHandlerMappedSetFunction<TrelloWebhookCardActionData>;
+    handleUpdateCard: TrelloHandlerMappedSetFunction<TrelloWebhookCardActionData>;
+    handleDeleteCard: TrelloHandlerMappedSetFunction<TrelloWebhookCardActionData>;
+    handleCommentCard: TrelloHandlerMappedSetFunction<TrelloWebhookCommentCardActionData>;
+    handleAddMemberToCard: TrelloHandlerMappedSetFunction<TrelloWebhookAddMemberToCardActionData>;
+    handleRemoveMemberFromCard: TrelloHandlerMappedSetFunction<TrelloWebhookAddMemberToCardActionData>;
+    handleUpdateBoard: TrelloHandlerMappedSetFunction<TrelloWebhookBoardActionData>;
+}
+export declare const trelloEventHandlerConfigurerFactory: import("@dereekb/util").HandlerConfigurerFactory<TrelloEventHandlerConfigurer, UntypedTrelloWebhookEvent, string, boolean>;

package/nestjs/src/lib/webhook/webhook.trello.module.d.ts

@@ -0,0 +1,13 @@
+import { ConfigService } from '@nestjs/config';
+import { TrelloWebhookServiceConfig } from './webhook.trello.config';
+/**
+ * Factory function that creates TrelloWebhookServiceConfig from NestJS ConfigService.
+ *
+ * Reads `TRELLO_APP_SECRET` and `TRELLO_WEBHOOK_CALLBACK_URL` from the environment.
+ *
+ * @param configService The NestJS ConfigService.
+ * @returns A validated TrelloWebhookServiceConfig.
+ */
+export declare function trelloWebhookServiceConfigFactory(configService: ConfigService): TrelloWebhookServiceConfig;
+export declare class TrelloWebhookModule {
+}

package/nestjs/src/lib/webhook/webhook.trello.service.d.ts

@@ -0,0 +1,24 @@
+import { type Handler } from '@dereekb/util';
+import { type Request } from 'express';
+import { TrelloWebhookServiceConfig } from './webhook.trello.config';
+import { type UntypedTrelloWebhookEvent } from './webhook.trello.type';
+export interface UpdateForTrelloWebhookResponse {
+    readonly valid: boolean;
+    readonly handled: boolean;
+    readonly event?: UntypedTrelloWebhookEvent;
+}
+/**
+ * Service that processes Trello webhook events.
+ *
+ * Verifies the signature, then dispatches verified events through a {@link Handler}
+ * configured via {@link TrelloEventHandlerConfigurer}.
+ */
+export declare class TrelloWebhookService {
+    private readonly logger;
+    private readonly _verifier;
+    readonly handler: Handler<UntypedTrelloWebhookEvent>;
+    readonly configure: import("@dereekb/util").HandlerConfigurer<import("./webhook.trello").TrelloEventHandlerConfigurer, UntypedTrelloWebhookEvent, string, boolean>;
+    constructor(config: TrelloWebhookServiceConfig);
+    updateForWebhook(req: Request, rawBody: Buffer): Promise<UpdateForTrelloWebhookResponse>;
+    updateForTrelloEvent(event: UntypedTrelloWebhookEvent): Promise<boolean>;
+}

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

@@ -0,0 +1,85 @@
+import { type TrelloBoardId, type TrelloCardId, type TrelloId, type TrelloListId, type TrelloMemberId, type TrelloOrganizationId, type TrelloWebhookId } from '@dereekb/trello';
+/**
+ * Trello webhook action type, e.g. `createCard`, `updateCard`, `addMemberToCard`.
+ *
+ * The full set is large; consult the API reference for the active list.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/guides/rest-api/object-definitions/#action-types
+ */
+export type TrelloWebhookActionType = string;
+/**
+ * The minimal shape of a Trello webhook action.
+ */
+export interface TrelloWebhookAction<D = unknown> {
+    readonly id: TrelloId;
+    readonly type: TrelloWebhookActionType;
+    readonly date: string;
+    readonly idMemberCreator: TrelloMemberId;
+    readonly data: D;
+}
+/**
+ * Trello webhook model — the object the webhook is subscribed to.
+ *
+ * The shape varies depending on the model type (board, card, list, member, etc.).
+ */
+export interface TrelloWebhookModel {
+    readonly id: TrelloId;
+    readonly [key: string]: unknown;
+}
+/**
+ * Webhook configuration object included in the POST body.
+ */
+export interface TrelloWebhookEventWebhook {
+    readonly id: TrelloWebhookId;
+    readonly idModel: TrelloId;
+    readonly callbackURL: string;
+    readonly description: string;
+    readonly active: boolean;
+}
+/**
+ * Trello webhook POST body shape.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/#receiving-webhook-events
+ */
+export interface TrelloWebhookEvent<D = unknown> {
+    readonly action: TrelloWebhookAction<D>;
+    readonly model: TrelloWebhookModel;
+    readonly webhook: TrelloWebhookEventWebhook;
+}
+export type UntypedTrelloWebhookEvent = TrelloWebhookEvent<unknown>;
+export interface TrelloWebhookCardActionData {
+    readonly card: {
+        readonly id: TrelloCardId;
+        readonly name?: string;
+        readonly idShort?: number;
+    };
+    readonly board: {
+        readonly id: TrelloBoardId;
+        readonly name?: string;
+    };
+    readonly list?: {
+        readonly id: TrelloListId;
+        readonly name?: string;
+    };
+    readonly old?: Record<string, unknown>;
+}
+export interface TrelloWebhookCommentCardActionData extends TrelloWebhookCardActionData {
+    readonly text: string;
+}
+export interface TrelloWebhookAddMemberToCardActionData extends TrelloWebhookCardActionData {
+    readonly idMember: TrelloMemberId;
+    readonly member: {
+        readonly id: TrelloMemberId;
+        readonly name?: string;
+    };
+}
+export interface TrelloWebhookBoardActionData {
+    readonly board: {
+        readonly id: TrelloBoardId;
+        readonly name?: string;
+    };
+    readonly organization?: {
+        readonly id: TrelloOrganizationId;
+        readonly name?: string;
+    };
+}

package/nestjs/src/lib/webhook/webhook.trello.verify.d.ts

@@ -0,0 +1,46 @@
+import { type Request } from 'express';
+import { type TrelloAppSecret } from '@dereekb/trello';
+import { type UntypedTrelloWebhookEvent } from './webhook.trello.type';
+export interface TrelloWebhookEventVerificationResult {
+    readonly valid: boolean;
+    /**
+     * Parsed event, only present on successful verification.
+     */
+    readonly event?: UntypedTrelloWebhookEvent;
+}
+/**
+ * Function that verifies a Trello webhook event.
+ */
+export type TrelloWebhookEventVerifier = (req: Request, rawBody: Buffer) => TrelloWebhookEventVerificationResult;
+export interface TrelloWebhookEventVerifierConfig {
+    /**
+     * App secret from the Power-Up admin page, used to verify the `X-Trello-Webhook` header.
+     */
+    readonly appSecret: TrelloAppSecret;
+    /**
+     * The exact callback URL configured for this webhook subscription.
+     *
+     * Trello signs the HMAC over `rawBody + callbackURL`, so the URL must match exactly (including scheme + path).
+     */
+    readonly callbackUrl: string;
+}
+/**
+ * Computes the expected `X-Trello-Webhook` value for the given body + callback URL.
+ *
+ * Exported for testability.
+ *
+ * @param appSecret The Trello app secret.
+ * @param rawBody The raw request body bytes.
+ * @param callbackUrl The exact callback URL configured for this webhook.
+ * @returns The expected base64 signature value.
+ */
+export declare function trelloWebhookExpectedSignature(appSecret: TrelloAppSecret, rawBody: Buffer, callbackUrl: string): string;
+/**
+ * Verifies a Trello webhook event header.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/#webhook-signatures
+ *
+ * @param config The verifier configuration.
+ * @returns A function that verifies a Trello webhook event.
+ */
+export declare function trelloWebhookEventVerifier(config: TrelloWebhookEventVerifierConfig): TrelloWebhookEventVerifier;

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@dereekb/trello",
+  "version": "13.11.14",
+  "exports": {
+    "./nestjs": {
+      "module": "./nestjs/index.esm.js",
+      "types": "./nestjs/index.d.ts",
+      "import": "./nestjs/index.cjs.mjs",
+      "default": "./nestjs/index.cjs.js"
+    },
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "types": "./index.d.ts",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    }
+  },
+  "peerDependencies": {
+    "@dereekb/nestjs": "13.11.14",
+    "@dereekb/rxjs": "13.11.14",
+    "@dereekb/util": "13.11.14",
+    "@nestjs/common": "^11.1.19",
+    "@nestjs/config": "^4.0.4",
+    "express": "^5.2.1",
+    "make-error": "^1.3.6"
+  },
+  "devDependencies": {
+    "@nestjs/testing": "^11.1.19"
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js",
+  "types": "./index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/src/lib/index.d.ts

@@ -0,0 +1,7 @@
+export * from './shared';
+export * from './trello';
+export * from './trello.api.page';
+export * from './trello.config';
+export * from './trello.error.api';
+export * from './trello.limit';
+export * from './trello.type';

package/src/lib/shared/index.d.ts

@@ -0,0 +1 @@
+export * from './trello.type';

package/src/lib/shared/trello.type.d.ts

@@ -0,0 +1,23 @@
+import { type ISO8601DateString, type Maybe } from '@dereekb/util';
+/**
+ * RGB hex color string for label colors (no preset name).
+ */
+export type TrelloHexColor = string;
+/**
+ * One of the canonical Trello label colors. Pass `null` to clear a label color.
+ */
+export type TrelloLabelColor = 'yellow' | 'purple' | 'blue' | 'red' | 'green' | 'orange' | 'black' | 'sky' | 'pink' | 'lime';
+/**
+ * Common `pos` value used by lists, cards, and labels.
+ *
+ * Either a number, or the string `top` or `bottom`.
+ */
+export type TrelloPosition = number | 'top' | 'bottom';
+/**
+ * ISO date string used by Trello timestamps.
+ */
+export type TrelloDateString = ISO8601DateString;
+/**
+ * Maybe a date string, since Trello often returns null/undefined for unset dates.
+ */
+export type TrelloMaybeDateString = Maybe<TrelloDateString>;

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

@@ -0,0 +1,11 @@
+export * from './trello.factory';
+export * from './trello.api.board';
+export * from './trello.api.board.type';
+export * from './trello.api.list';
+export * from './trello.api.list.type';
+export * from './trello.api.card';
+export * from './trello.api.card.type';
+export * from './trello.api.member';
+export * from './trello.api.member.type';
+export * from './trello.api.webhook';
+export * from './trello.api.webhook.type';

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

@@ -0,0 +1,103 @@
+import { type TrelloContext } from './trello.factory';
+import { type TrelloBoardId, type TrelloMemberId } from '../trello.type';
+import { type CreateBoardBody, type TrelloBoard, type UpdateBoardBody } from './trello.api.board.type';
+import { type TrelloList } from './trello.api.list.type';
+import { type TrelloCard, type TrelloLabel } from './trello.api.card.type';
+import { type TrelloMember } from './trello.api.member.type';
+export interface GetBoardInput {
+    readonly boardId: TrelloBoardId;
+}
+export type GetBoardFunction = (input: GetBoardInput) => Promise<TrelloBoard>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that retrieves a board by id.
+ */
+export declare function getBoard(context: TrelloContext): GetBoardFunction;
+export type CreateBoardFunction = (input: CreateBoardBody) => Promise<TrelloBoard>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-post
+ *
+ * @param context The Trello API context.
+ * @returns A function that creates a new board.
+ */
+export declare function createBoard(context: TrelloContext): CreateBoardFunction;
+export interface UpdateBoardInput extends UpdateBoardBody {
+    readonly boardId: TrelloBoardId;
+}
+export type UpdateBoardFunction = (input: UpdateBoardInput) => Promise<TrelloBoard>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-put
+ *
+ * @param context The Trello API context.
+ * @returns A function that updates an existing board.
+ */
+export declare function updateBoard(context: TrelloContext): UpdateBoardFunction;
+export type DeleteBoardFunction = (input: GetBoardInput) => Promise<void>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-delete
+ *
+ * @param context The Trello API context.
+ * @returns A function that deletes a board.
+ */
+export declare function deleteBoard(context: TrelloContext): DeleteBoardFunction;
+export interface ListBoardListsInput {
+    readonly boardId: TrelloBoardId;
+    /**
+     * Whether to include all lists, only open, or only closed.
+     *
+     * Defaults to `open`.
+     */
+    readonly filter?: 'all' | 'closed' | 'none' | 'open';
+}
+export type ListBoardListsFunction = (input: ListBoardListsInput) => Promise<ReadonlyArray<TrelloList>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-lists-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that lists all lists on a board.
+ */
+export declare function listBoardLists(context: TrelloContext): ListBoardListsFunction;
+export interface ListBoardCardsInput {
+    readonly boardId: TrelloBoardId;
+    readonly filter?: 'all' | 'closed' | 'none' | 'open' | 'visible';
+}
+export type ListBoardCardsFunction = (input: ListBoardCardsInput) => Promise<ReadonlyArray<TrelloCard>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-cards-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that lists all cards on a board.
+ */
+export declare function listBoardCards(context: TrelloContext): ListBoardCardsFunction;
+export interface ListBoardLabelsInput {
+    readonly boardId: TrelloBoardId;
+    /**
+     * Maximum number of labels to return. Defaults to 50 server-side; max is 1000.
+     */
+    readonly limit?: number;
+}
+export type ListBoardLabelsFunction = (input: ListBoardLabelsInput) => Promise<ReadonlyArray<TrelloLabel>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-labels-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that lists every label defined on a board.
+ */
+export declare function listBoardLabels(context: TrelloContext): ListBoardLabelsFunction;
+export interface ListBoardMembersInput {
+    readonly boardId: TrelloBoardId;
+    /**
+     * Optional member id filter. Pass to list a specific board member.
+     */
+    readonly memberId?: TrelloMemberId;
+}
+export type ListBoardMembersFunction = (input: ListBoardMembersInput) => Promise<ReadonlyArray<TrelloMember>>;
+/**
+ * https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-members-get
+ *
+ * @param context The Trello API context.
+ * @returns A function that lists all members of a board.
+ */
+export declare function listBoardMembers(context: TrelloContext): ListBoardMembersFunction;

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

@@ -0,0 +1,75 @@
+import { type Maybe } from '@dereekb/util';
+import { type TrelloBoardId, type TrelloOrganizationId } from '../trello.type';
+import { type TrelloMaybeDateString } from '../shared/trello.type';
+/**
+ * Trello board.
+ *
+ * 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-boards/#api-boards-id-get
+ */
+export interface TrelloBoard {
+    readonly id: TrelloBoardId;
+    readonly name: string;
+    readonly desc: string;
+    readonly closed: boolean;
+    readonly idOrganization: Maybe<TrelloOrganizationId>;
+    readonly url: string;
+    readonly shortUrl: string;
+    readonly pinned?: boolean;
+    readonly starred?: boolean;
+    readonly subscribed?: boolean;
+    readonly dateLastActivity: TrelloMaybeDateString;
+    readonly dateLastView?: TrelloMaybeDateString;
+}
+/**
+ * Permission level for a Trello board.
+ */
+export type TrelloBoardPermissionLevel = 'private' | 'org' | 'public';
+/**
+ * Background preset name. Custom backgrounds use ids returned by the API.
+ */
+export type TrelloBoardBackground = 'blue' | 'orange' | 'green' | 'red' | 'purple' | 'pink' | 'lime' | 'sky' | 'grey' | string;
+export interface CreateBoardBody {
+    /**
+     * The new board's name. Required. 1-16384 characters.
+     */
+    readonly name: string;
+    /**
+     * Optional board description.
+     */
+    readonly desc?: string;
+    /**
+     * Determines whether to use the default set of lists for the board (To Do, Doing, Done).
+     *
+     * Defaults to true.
+     */
+    readonly defaultLists?: boolean;
+    /**
+     * Determines whether to use the default set of labels for the board.
+     *
+     * Defaults to true.
+     */
+    readonly defaultLabels?: boolean;
+    /**
+     * The id of the organization the board should belong to.
+     */
+    readonly idOrganization?: TrelloOrganizationId;
+    /**
+     * The permission level. Defaults to private.
+     */
+    readonly prefs_permissionLevel?: TrelloBoardPermissionLevel;
+    /**
+     * Background of the board.
+     */
+    readonly prefs_background?: TrelloBoardBackground;
+}
+export interface UpdateBoardBody {
+    readonly name?: string;
+    readonly desc?: string;
+    readonly closed?: boolean;
+    readonly subscribed?: boolean;
+    readonly idOrganization?: TrelloOrganizationId;
+    readonly 'prefs/permissionLevel'?: TrelloBoardPermissionLevel;
+    readonly 'prefs/background'?: TrelloBoardBackground;
+}