@dereekb/trello 13.11.15 → 13.11.17

package/nestjs/index.cjs.js

@@ -260,6 +260,37 @@ exports.TrelloApi = /*#__PURE__*/ function() {
                 return trello.listCardActions(this.trelloContext);
             }
         },
+        {
+            key: "listCardAttachments",
+            get: // MARK: Card Attachments
+            function get() {
+                return trello.listCardAttachments(this.trelloContext);
+            }
+        },
+        {
+            key: "getCardAttachment",
+            get: function get() {
+                return trello.getCardAttachment(this.trelloContext);
+            }
+        },
+        {
+            key: "addAttachmentToCard",
+            get: function get() {
+                return trello.addAttachmentToCard(this.trelloContext);
+            }
+        },
+        {
+            key: "deleteAttachmentFromCard",
+            get: function get() {
+                return trello.deleteAttachmentFromCard(this.trelloContext);
+            }
+        },
+        {
+            key: "downloadCardAttachment",
+            get: function get() {
+                return trello.downloadCardAttachment(this.trelloContext);
+            }
+        },
         {
             key: "getMember",
             get: // MARK: Members

package/nestjs/index.esm.js

@@ -1,5 +1,5 @@
 import { Injectable, Inject, Logger, Head, Post, Req, Controller, Module } from '@nestjs/common';
-import { trelloFactory, getBoard, createBoard, updateBoard, deleteBoard, listBoardLists, listBoardCards, listBoardMembers, listBoardLabels, getList, createList, updateList, listCardsInList, getCard, createCard, updateCard, deleteCard, addCommentToCard, addMemberToCard, addLabelToCard, listCardActions, getMember, getMe, createWebhook, getWebhook, updateWebhook, deleteWebhook, listWebhooksForToken } from '@dereekb/trello';
+import { trelloFactory, getBoard, createBoard, updateBoard, deleteBoard, listBoardLists, listBoardCards, listBoardMembers, listBoardLabels, getList, createList, updateList, listCardsInList, getCard, createCard, updateCard, deleteCard, addCommentToCard, addMemberToCard, addLabelToCard, listCardActions, listCardAttachments, getCardAttachment, addAttachmentToCard, deleteAttachmentFromCard, downloadCardAttachment, getMember, getMe, createWebhook, getWebhook, updateWebhook, deleteWebhook, listWebhooksForToken } from '@dereekb/trello';
 import { ConfigService, ConfigModule } from '@nestjs/config';
 import { handlerFactory, handlerConfigurerFactory, handlerMappedSetFunctionFactory } from '@dereekb/util';
 import { RawBody } from '@dereekb/nestjs';
@@ -258,6 +258,37 @@ var TrelloApi = /*#__PURE__*/ function() {
                 return listCardActions(this.trelloContext);
             }
         },
+        {
+            key: "listCardAttachments",
+            get: // MARK: Card Attachments
+            function get() {
+                return listCardAttachments(this.trelloContext);
+            }
+        },
+        {
+            key: "getCardAttachment",
+            get: function get() {
+                return getCardAttachment(this.trelloContext);
+            }
+        },
+        {
+            key: "addAttachmentToCard",
+            get: function get() {
+                return addAttachmentToCard(this.trelloContext);
+            }
+        },
+        {
+            key: "deleteAttachmentFromCard",
+            get: function get() {
+                return deleteAttachmentFromCard(this.trelloContext);
+            }
+        },
+        {
+            key: "downloadCardAttachment",
+            get: function get() {
+                return downloadCardAttachment(this.trelloContext);
+            }
+        },
         {
             key: "getMember",
             get: // MARK: Members

package/nestjs/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/trello/nestjs",
-  "version": "13.11.15",
+  "version": "13.11.17",
   "peerDependencies": {
-    "@dereekb/nestjs": "13.11.15",
-    "@dereekb/rxjs": "13.11.15",
-    "@dereekb/trello": "13.11.15",
-    "@dereekb/util": "13.11.15",
+    "@dereekb/nestjs": "13.11.17",
+    "@dereekb/rxjs": "13.11.17",
+    "@dereekb/trello": "13.11.17",
+    "@dereekb/util": "13.11.17",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "express": "^5.2.1"

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

@@ -26,6 +26,11 @@ export declare class TrelloApi {
     get addMemberToCard(): import("@dereekb/trello").AddMemberToCardFunction;
     get addLabelToCard(): import("@dereekb/trello").AddLabelToCardFunction;
     get listCardActions(): import("@dereekb/trello").ListCardActionsFunction;
+    get listCardAttachments(): import("@dereekb/trello").ListCardAttachmentsFunction;
+    get getCardAttachment(): import("@dereekb/trello").GetCardAttachmentFunction;
+    get addAttachmentToCard(): import("@dereekb/trello").AddAttachmentToCardFunction;
+    get deleteAttachmentFromCard(): import("@dereekb/trello").DeleteAttachmentFromCardFunction;
+    get downloadCardAttachment(): import("@dereekb/trello").DownloadCardAttachmentFunction;
     get getMember(): import("@dereekb/trello").GetMemberFunction;
     get getMe(): import("@dereekb/trello").GetMeFunction;
     get createWebhook(): import("@dereekb/trello").CreateWebhookFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/trello",
-  "version": "13.11.15",
+  "version": "13.11.17",
   "exports": {
     "./nestjs": {
       "module": "./nestjs/index.esm.js",
@@ -17,9 +17,9 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/nestjs": "13.11.15",
-    "@dereekb/rxjs": "13.11.15",
-    "@dereekb/util": "13.11.15",
+    "@dereekb/nestjs": "13.11.17",
+    "@dereekb/rxjs": "13.11.17",
+    "@dereekb/util": "13.11.17",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "express": "^5.2.1",

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

@@ -5,6 +5,8 @@ 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.card.attachment';
+export * from './trello.api.card.attachment.type';
 export * from './trello.api.member';
 export * from './trello.api.member.type';
 export * from './trello.api.webhook';

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

@@ -0,0 +1,105 @@
+import { type TrelloContext } from './trello.factory';
+import { type TrelloAttachmentId, type TrelloCardId } from '../trello.type';
+import { type AddAttachmentToCardBody, type TrelloAttachment } from './trello.api.card.attachment.type';
+export interface ListCardAttachmentsInput {
+    readonly cardId: TrelloCardId;
+    /**
+     * Comma-separated list of attachment fields to return, or `all`.
+     */
+    readonly fields?: string;
+    /**
+     * Optional filter (e.g. `cover`).
+     */
+    readonly filter?: string;
+}
+export type ListCardAttachmentsFunction = (input: ListCardAttachmentsInput) => Promise<ReadonlyArray<TrelloAttachment>>;
+/**
+ * Https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-attachments-get.
+ *
+ * @param context - The Trello API context.
+ * @returns Lists attachments on a card.
+ */
+export declare function listCardAttachments(context: TrelloContext): ListCardAttachmentsFunction;
+export interface GetCardAttachmentInput {
+    readonly cardId: TrelloCardId;
+    readonly attachmentId: TrelloAttachmentId;
+    /**
+     * Comma-separated list of attachment fields to return, or `all`.
+     */
+    readonly fields?: string;
+}
+export type GetCardAttachmentFunction = (input: GetCardAttachmentInput) => Promise<TrelloAttachment>;
+/**
+ * Https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-attachments-idattachment-get.
+ *
+ * @param context - The Trello API context.
+ * @returns Retrieves a single attachment on a card.
+ */
+export declare function getCardAttachment(context: TrelloContext): GetCardAttachmentFunction;
+export interface AddAttachmentToCardInput extends AddAttachmentToCardBody {
+    readonly cardId: TrelloCardId;
+}
+export type AddAttachmentToCardFunction = (input: AddAttachmentToCardInput) => Promise<TrelloAttachment>;
+/**
+ * Https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-attachments-post.
+ *
+ * Supports both file uploads (multipart/form-data) and url-only attachments. Pass exactly one of `file` or `url`.
+ *
+ * @param context - The Trello API context.
+ * @returns Adds an attachment (file or url) to a card.
+ */
+export declare function addAttachmentToCard(context: TrelloContext): AddAttachmentToCardFunction;
+export interface DeleteAttachmentFromCardInput {
+    readonly cardId: TrelloCardId;
+    readonly attachmentId: TrelloAttachmentId;
+}
+export type DeleteAttachmentFromCardFunction = (input: DeleteAttachmentFromCardInput) => Promise<void>;
+/**
+ * Https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-attachments-idattachment-delete.
+ *
+ * @param context - The Trello API context.
+ * @returns Removes an attachment from a card.
+ */
+export declare function deleteAttachmentFromCard(context: TrelloContext): DeleteAttachmentFromCardFunction;
+/**
+ * Result returned by {@link downloadCardAttachment}. The attachment metadata is included so callers
+ * can correlate the bytes with the original filename, mime type, and size without an extra request.
+ */
+export interface DownloadCardAttachmentResult {
+    readonly attachment: TrelloAttachment;
+    readonly response: Response;
+    /**
+     * Reads the response body as an ArrayBuffer.
+     */
+    readonly arrayBuffer: () => Promise<ArrayBuffer>;
+    /**
+     * Reads the response body as a Blob (typed with the attachment's mime type when available).
+     */
+    readonly blob: () => Promise<Blob>;
+    /**
+     * Reads the response body as text.
+     */
+    readonly text: () => Promise<string>;
+}
+export interface DownloadCardAttachmentInput {
+    readonly cardId: TrelloCardId;
+    readonly attachmentId: TrelloAttachmentId;
+    /**
+     * Optional pre-fetched attachment metadata. When provided, skips the extra GET request used to resolve the file name.
+     */
+    readonly attachment?: TrelloAttachment;
+}
+export type DownloadCardAttachmentFunction = (input: DownloadCardAttachmentInput) => Promise<DownloadCardAttachmentResult>;
+/**
+ * Downloads the raw bytes of a card attachment via the authenticated Trello download endpoint:
+ * `GET /cards/{id}/attachments/{idAttachment}/download/{filename}`.
+ *
+ * The configured Trello fetch automatically attaches the OAuth `Authorization` header required by Trello
+ * for private file downloads.
+ *
+ * @param context - The Trello API context.
+ * @returns Downloads the attachment bytes along with its metadata.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/guides/rest-api/file-attachments/
+ */
+export declare function downloadCardAttachment(context: TrelloContext): DownloadCardAttachmentFunction;

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

@@ -0,0 +1,88 @@
+import { type ContentTypeMimeType, type Maybe } from '@dereekb/util';
+import { type TrelloAttachmentId, type TrelloMemberId } from '../trello.type';
+/**
+ * A scaled preview generated by Trello for image attachments.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-attachments-id-get
+ */
+export interface TrelloAttachmentPreview {
+    readonly id: string;
+    readonly url: string;
+    readonly bytes: number;
+    readonly width: number;
+    readonly height: number;
+    readonly scaled: boolean;
+}
+/**
+ * A Trello attachment.
+ *
+ * Attachments can be uploaded files or URL-only references. File attachments expose `bytes`, `mimeType`,
+ * and a non-empty `previews` array for image content. URL attachments have `bytes === null` and an empty
+ * `previews` array.
+ *
+ * @see https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-attachments-get
+ */
+export interface TrelloAttachment {
+    readonly id: TrelloAttachmentId;
+    readonly idMember: TrelloMemberId;
+    readonly name: string;
+    /**
+     * Original file name (for uploaded files). Empty for URL-only attachments.
+     */
+    readonly fileName: string;
+    /**
+     * Authenticated download url for the attachment file (or the external url for URL-only attachments).
+     *
+     * For uploaded private files Trello requires the OAuth `Authorization` header to download.
+     */
+    readonly url: string;
+    /**
+     * File size in bytes, or `null` for URL-only attachments.
+     */
+    readonly bytes: Maybe<number>;
+    /**
+     * MIME type of the uploaded file, or `null` for URL-only attachments.
+     */
+    readonly mimeType: Maybe<ContentTypeMimeType>;
+    readonly date: string;
+    readonly edgeColor: Maybe<string>;
+    readonly pos: number;
+    readonly isUpload: boolean;
+    readonly previews: ReadonlyArray<TrelloAttachmentPreview>;
+}
+export interface AddAttachmentToCardFileInput {
+    /**
+     * File bytes to upload. Accepts anything `BlobPart` supports — `Buffer`, `Uint8Array`, `ArrayBuffer`, `string`, or a `Blob`.
+     */
+    readonly content: BlobPart;
+    /**
+     * File name (including extension) that Trello will display.
+     */
+    readonly fileName: string;
+    /**
+     * MIME type for the uploaded file. Defaults to `application/octet-stream` when omitted.
+     */
+    readonly mimeType?: ContentTypeMimeType;
+}
+export interface AddAttachmentToCardBody {
+    /**
+     * Optional display name. Defaults to the file name (for file uploads) or the url (for url-only attachments).
+     */
+    readonly name?: string;
+    /**
+     * Uploads a file. Mutually exclusive with `url`.
+     */
+    readonly file?: AddAttachmentToCardFileInput;
+    /**
+     * Attaches an external url. Mutually exclusive with `file`.
+     */
+    readonly url?: string;
+    /**
+     * If true, asks Trello to use this attachment for the card cover (uploaded files only).
+     */
+    readonly setCover?: boolean;
+    /**
+     * Optional mimeType override sent as a form field — only honored for url-only attachments.
+     */
+    readonly mimeType?: ContentTypeMimeType;
+}

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

@@ -9,6 +9,7 @@ export type TrelloMemberId = TrelloId;
 export type TrelloLabelId = TrelloId;
 export type TrelloActionId = TrelloId;
 export type TrelloChecklistId = TrelloId;
+export type TrelloAttachmentId = TrelloId;
 export type TrelloWebhookId = TrelloId;
 export type TrelloOrganizationId = TrelloId;
 export type TrelloEnterpriseId = TrelloId;