@doist/twist-sdk 2.7.0 → 2.9.0

package/dist/types/types/requests.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import type { UploadFile } from '../utils/multipart-upload.js';
 import { type Attachment } from './entities.js';
 export declare const CreateChannelArgsSchema: z.ZodObject<{
     workspaceId: z.ZodNumber;
@@ -353,6 +354,11 @@ export type RemoveGroupUsersArgs = {
 export type GetWorkspaceUsersArgs = {
     workspaceId: number;
     archived?: boolean;
+    /**
+     * Include users who have been removed from the workspace. Defaults to `false`.
+     * The Twist API always returns removed users, so the SDK filters them client-side.
+     */
+    includeRemoved?: boolean;
 };
 export type GetUserByIdArgs = {
     workspaceId: number;
@@ -370,4 +376,20 @@ export type GetUserLocalTimeArgs = {
     workspaceId: number;
     userId: number;
 };
+export type UploadAttachmentArgs = {
+    /**
+     * The file to upload. Accepts a `Blob`/`File` (browser) or a `Uint8Array` of raw
+     * bytes. A Node `Buffer` is a `Uint8Array`, so `await readFile(path)` works directly.
+     */
+    file: UploadFile;
+    /**
+     * File name. Required when `file` is a `Uint8Array`; inferred from the `File.name`
+     * otherwise.
+     */
+    fileName?: string;
+    /** MIME type. Defaults to the `Blob`'s type or one inferred from the file extension. */
+    contentType?: string;
+    /** Attachment ID to use. A random UUID is generated when omitted. */
+    attachmentId?: string;
+};
 export {};

package/dist/types/utils/multipart-upload.d.ts

@@ -0,0 +1,53 @@
+import type { CustomFetch } from '../types/http.js';
+/**
+ * File content accepted by the upload helpers.
+ *
+ * - `Blob`/`File` — browser, or any runtime with a global `Blob` (Node 18+).
+ * - `Uint8Array` — raw bytes (requires `fileName`). A Node `Buffer` is a `Uint8Array`,
+ *   so reading a file with `fs` and passing the result works without conversion.
+ *
+ * Both are universal types, so the published `.d.ts` stays free of Node-only globals
+ * (`Buffer`, `NodeJS.*`) and the helper pulls in no Node built-ins — keeping the browser
+ * bundle clean.
+ */
+export type UploadFile = Blob | Uint8Array;
+type UploadMultipartFileArgs = {
+    /** Base API URI with trailing slash, e.g. `https://api.twist.com/api/v3/`. */
+    baseUrl: string;
+    /** API token used for `Authorization: Bearer`. */
+    authToken: string;
+    /** Relative endpoint path, e.g. `attachments/upload`. */
+    endpoint: string;
+    /** File content to upload. */
+    file: UploadFile;
+    /** File name. Required for raw `Uint8Array` bytes; inferred from a `File`. */
+    fileName?: string;
+    /** MIME type. Defaults to the `Blob`'s type or one inferred from the file extension. */
+    contentType?: string;
+    /** Extra multipart fields to send alongside the file metadata fields. */
+    additionalFields?: Record<string, string | number | boolean | undefined | null>;
+    /** Optional request ID for tracing. */
+    requestId?: string;
+    /** Optional custom fetch implementation. */
+    customFetch?: CustomFetch;
+};
+/**
+ * Determine a content-type from a filename extension. Falls back to
+ * `application/octet-stream` for unknown extensions.
+ */
+export declare function getContentTypeFromFileName(fileName: string): string;
+/**
+ * Upload a file using `multipart/form-data`.
+ *
+ * Builds the request body with the global `FormData`/`Blob` so it works unchanged in the
+ * browser and in Node.js (via `undici`). The `file` part is sent alongside `file_name`,
+ * `file_size`, and `underlying_type` fields (the canonical Twist upload shape); any
+ * `additionalFields` are merged in and override the derived values. Authentication uses
+ * `Authorization: Bearer`, matching every other Twist SDK client, and `Content-Type` is
+ * intentionally left unset so the runtime adds the correct multipart boundary.
+ *
+ * The response is JSON-parsed and camel-cased by {@link fetchWithRetry}; callers validate
+ * the returned shape with the appropriate schema.
+ */
+export declare function uploadMultipartFile<T>(args: UploadMultipartFileArgs): Promise<T>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/twist-sdk",
-    "version": "2.7.0",
+    "version": "2.9.0",
     "description": "A TypeScript wrapper for the Twist REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/twist-sdk-typescript/",
@@ -36,7 +36,7 @@
         "type-check": "npx tsc --noEmit",
         "check": "oxlint src && oxfmt --check",
         "check:fix": "oxlint src --fix && oxfmt",
-        "attw": "npx @arethetypeswrong/cli --pack --ignore-rules fallback-condition false-esm",
+        "attw": "attw --pack --ignore-rules fallback-condition false-esm",
         "audit": "npm audit --audit-level=moderate",
         "integrity-checks": "npm-run-all clean check test build attw",
         "prepublishOnly": "npm run integrity-checks",
@@ -50,6 +50,7 @@
         "zod": "4.1.12"
     },
     "devDependencies": {
+        "@arethetypeswrong/cli": "0.18.2",
         "@semantic-release/changelog": "6.0.3",
         "@semantic-release/git": "10.0.1",
         "conventional-changelog-conventionalcommits": "9.3.0",
@@ -70,6 +71,9 @@
     "peerDependencies": {
         "type-fest": "^4.12.0 || ^5.1.0"
     },
+    "overrides": {
+        "fflate": "0.8.2"
+    },
     "husky": {
         "hooks": {
             "pre-commit": "npx lint-staged && npm run build"