nylas 8.1.1 → 8.2.0

package/lib/cjs/apiClient.js

@@ -5,7 +5,7 @@ const error_js_1 = require("./models/error.js");
 const utils_js_1 = require("./utils.js");
 const version_js_1 = require("./version.js");
 const form_data_encoder_1 = require("form-data-encoder");
-const stream_1 = require("stream");
+const node_stream_1 = require("node:stream");
 const change_case_1 = require("change-case");
 /**
  * The header key for the debugging flow ID
@@ -66,12 +66,15 @@ class APIClient {
             ...this.headers,
             ...overrides?.headers,
         };
-        return {
+        const defaultHeaders = {
             Accept: 'application/json',
             'User-Agent': `Nylas Node SDK v${version_js_1.SDK_VERSION}`,
-            Authorization: `Bearer ${overrides?.apiKey || this.apiKey}`,
             ...mergedHeaders,
         };
+        if (!overrides?.skipAuth) {
+            defaultHeaders.Authorization = `Bearer ${overrides?.apiKey || this.apiKey}`;
+        }
+        return defaultHeaders;
     }
     async sendRequest(options) {
         const req = await this.newRequest(options);
@@ -150,7 +153,11 @@ class APIClient {
         requestOptions.url = this.setRequestUrl(optionParams);
         requestOptions.headers = this.setRequestHeaders(optionParams);
         requestOptions.method = optionParams.method;
-        if (optionParams.body) {
+        if (optionParams.serializedBody) {
+            requestOptions.body = optionParams.serializedBody;
+            requestOptions.headers['Content-Type'] = 'application/json';
+        }
+        else if (optionParams.body) {
             requestOptions.body = JSON.stringify((0, utils_js_1.objKeysToSnakeCase)(optionParams.body, ['metadata']) // metadata should remain as is
             );
             requestOptions.headers['Content-Type'] = 'application/json';
@@ -164,7 +171,7 @@ class APIClient {
             // Set the Content-Type header with the boundary from the encoder
             requestOptions.headers['Content-Type'] = encoder.contentType;
             // Convert the encoded form data to a readable stream for the request body
-            requestOptions.body = stream_1.Readable.from(encoder);
+            requestOptions.body = node_stream_1.Readable.from(encoder);
             // Node.js native fetch requires duplex: 'half' when sending a streaming body
             requestOptions.duplex = 'half';
         }

package/lib/cjs/models/domains.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./calendars.js"), exports);
 __exportStar(require("./connectors.js"), exports);
 __exportStar(require("./contacts.js"), exports);
 __exportStar(require("./credentials.js"), exports);
+__exportStar(require("./domains.js"), exports);
 __exportStar(require("./drafts.js"), exports);
 __exportStar(require("./error.js"), exports);
 __exportStar(require("./events.js"), exports);
@@ -38,6 +39,8 @@ __exportStar(require("./redirectUri.js"), exports);
 __exportStar(require("./response.js"), exports);
 __exportStar(require("./rules.js"), exports);
 __exportStar(require("./scheduler.js"), exports);
+__exportStar(require("./serviceAccount.js"), exports);
 __exportStar(require("./smartCompose.js"), exports);
 __exportStar(require("./threads.js"), exports);
 __exportStar(require("./webhooks.js"), exports);
+__exportStar(require("./workspaces.js"), exports);

package/lib/cjs/models/messages.js

@@ -7,6 +7,7 @@ exports.MessageFields = void 0;
 var MessageFields;
 (function (MessageFields) {
     MessageFields["STANDARD"] = "standard";
+    MessageFields["INCLUDE_BASIC_HEADERS"] = "include_basic_headers";
     MessageFields["INCLUDE_HEADERS"] = "include_headers";
     MessageFields["INCLUDE_TRACKING_OPTIONS"] = "include_tracking_options";
     MessageFields["RAW_MIME"] = "raw_mime";

package/lib/cjs/models/serviceAccount.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceAccountSigner = void 0;
+exports.generateNonce = generateNonce;
+exports.canonicalJson = canonicalJson;
+const node_crypto_1 = require("node:crypto");
+const NONCE_LENGTH = 20;
+const NONCE_ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+const SIGNED_BODY_METHODS = new Set(['post', 'put', 'patch']);
+function normalizePrivateKey(privateKeyPem) {
+    if (Buffer.isBuffer(privateKeyPem) || privateKeyPem.includes('BEGIN')) {
+        return privateKeyPem;
+    }
+    return Buffer.from(privateKeyPem, 'base64').toString('utf8');
+}
+function loadRsaPrivateKey(privateKeyPem) {
+    const privateKey = (0, node_crypto_1.createPrivateKey)(normalizePrivateKey(privateKeyPem));
+    if (privateKey.asymmetricKeyType !== 'rsa') {
+        throw new Error('Service account private key must be RSA.');
+    }
+    return privateKey;
+}
+function generateNonce(length = NONCE_LENGTH) {
+    if (!Number.isInteger(length) || length <= 0) {
+        throw new Error('Nonce length must be a positive integer.');
+    }
+    let nonce = '';
+    for (let i = 0; i < length; i++) {
+        nonce += NONCE_ALPHABET[(0, node_crypto_1.randomInt)(NONCE_ALPHABET.length)];
+    }
+    return nonce;
+}
+function canonicalValue(value) {
+    if (value === undefined || typeof value === 'function') {
+        return 'null';
+    }
+    if (Array.isArray(value)) {
+        return `[${value.map(canonicalValue).join(',')}]`;
+    }
+    if (typeof value === 'number' && !Number.isFinite(value)) {
+        throw new Error('Service account signing only supports finite numbers.');
+    }
+    if (value && typeof value === 'object') {
+        const data = value;
+        return `{${Object.keys(data)
+            .filter((key) => {
+            const item = data[key];
+            return item !== undefined && typeof item !== 'function';
+        })
+            .sort()
+            .map((key) => `${JSON.stringify(key)}:${canonicalValue(data[key])}`)
+            .join(',')}}`;
+    }
+    return JSON.stringify(value);
+}
+/**
+ * Serialize JSON deterministically with sorted object keys and no extra
+ * whitespace, matching Nylas Service Account signing requirements.
+ */
+function canonicalJson(data) {
+    return canonicalValue(data);
+}
+/**
+ * Generates Nylas Service Account request signing headers.
+ */
+class ServiceAccountSigner {
+    constructor({ privateKeyPem, privateKeyId }) {
+        this.privateKey = loadRsaPrivateKey(privateKeyPem);
+        this.privateKeyId = privateKeyId;
+    }
+    buildHeaders({ method, path, body, timestamp = Math.floor(Date.now() / 1000), nonce = generateNonce(), }) {
+        const methodLower = method.toLowerCase();
+        const serializedBody = body && SIGNED_BODY_METHODS.has(methodLower)
+            ? canonicalJson(body)
+            : undefined;
+        const signingEnvelope = {
+            method: methodLower,
+            nonce,
+            path,
+            timestamp,
+        };
+        if (serializedBody) {
+            signingEnvelope.payload = serializedBody;
+        }
+        const signature = (0, node_crypto_1.createSign)('RSA-SHA256')
+            .update(canonicalJson(signingEnvelope))
+            .sign(this.privateKey, 'base64');
+        return {
+            headers: {
+                'X-Nylas-Kid': this.privateKeyId,
+                'X-Nylas-Nonce': nonce,
+                'X-Nylas-Timestamp': String(timestamp),
+                'X-Nylas-Signature': signature,
+            },
+            serializedBody,
+        };
+    }
+}
+exports.ServiceAccountSigner = ServiceAccountSigner;

package/lib/cjs/models/workspaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/nylas.js

@@ -35,8 +35,10 @@ const contacts_js_1 = require("./resources/contacts.js");
 const attachments_js_1 = require("./resources/attachments.js");
 const scheduler_js_1 = require("./resources/scheduler.js");
 const notetakers_js_1 = require("./resources/notetakers.js");
+const domains_js_1 = require("./resources/domains.js");
 const policies_js_1 = require("./resources/policies.js");
 const rules_js_1 = require("./resources/rules.js");
+const workspaces_js_1 = require("./resources/workspaces.js");
 const agentLists_js_1 = require("./resources/agentLists.js");
 /**
  * The entry point to the Node SDK
@@ -64,8 +66,10 @@ class Nylas {
         this.grants = new grants_js_1.Grants(this.apiClient);
         this.messages = new messages_js_1.Messages(this.apiClient);
         this.notetakers = new notetakers_js_1.Notetakers(this.apiClient);
+        this.domains = new domains_js_1.Domains(this.apiClient);
         this.policies = new policies_js_1.Policies(this.apiClient);
         this.rules = new rules_js_1.Rules(this.apiClient);
+        this.workspaces = new workspaces_js_1.Workspaces(this.apiClient);
         this.lists = new agentLists_js_1.AgentLists(this.apiClient);
         this.threads = new threads_js_1.Threads(this.apiClient);
         this.webhooks = new webhooks_js_1.Webhooks(this.apiClient);

package/lib/cjs/resources/applications.js

@@ -27,5 +27,18 @@ class Applications extends resource_js_1.Resource {
             overrides,
         });
     }
+    /**
+     * Update application details.
+     *
+     * Each supplied nested object is a full replace, not a deep merge.
+     * @returns The updated application details
+     */
+    update({ requestBody, overrides, }) {
+        return super._updatePatch({
+            path: (0, utils_js_1.makePathParams)('/v3/applications', {}),
+            requestBody,
+            overrides,
+        });
+    }
 }
 exports.Applications = Applications;

package/lib/cjs/resources/attachments.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Attachments = void 0;
 const utils_js_1 = require("../utils.js");
 const resource_js_1 = require("./resource.js");
+const node_stream_1 = require("node:stream");
 /**
  * Nylas Attachments API
  *
@@ -23,15 +24,15 @@ class Attachments extends resource_js_1.Resource {
     /**
      * Download the attachment data
      *
-     * This method returns a NodeJS.ReadableStream which can be used to stream the attachment data.
+     * This method returns a Web ReadableStream which can be used to stream the attachment data.
      * This is particularly useful for handling large attachments efficiently, as it avoids loading
-     * the entire file into memory. The stream can be piped to a file stream or used in any other way
-     * that Node.js streams are typically used.
+     * the entire file into memory. In Node.js, convert it with Readable.fromWeb() when a
+     * NodeJS.ReadableStream is required.
      *
      * @param identifier Grant ID or email account to query
      * @param attachmentId The id of the attachment to download.
      * @param queryParams The query parameters to include in the request
-     * @returns {NodeJS.ReadableStream} The ReadableStream containing the file data.
+     * @returns {ReadableStream<Uint8Array>} The ReadableStream containing the file data.
      */
     download({ identifier, attachmentId, queryParams, overrides, }) {
         return this._getStream({
@@ -40,6 +41,27 @@ class Attachments extends resource_js_1.Resource {
             overrides,
         });
     }
+    /**
+     * Download the attachment data as a Node.js readable stream.
+     *
+     * This is a Node.js convenience wrapper around {@link Attachments.download}. Use
+     * {@link Attachments.download} directly in Fetch-native runtimes, such as Cloudflare Workers,
+     * where Web ReadableStreams are the standard stream primitive.
+     *
+     * @param identifier Grant ID or email account to query
+     * @param attachmentId The id of the attachment to download.
+     * @param queryParams The query parameters to include in the request
+     * @returns {NodeJS.ReadableStream} The Node.js readable stream containing the file data.
+     */
+    async downloadNodeStream({ identifier, attachmentId, queryParams, overrides, }) {
+        const stream = await this.download({
+            identifier,
+            attachmentId,
+            queryParams,
+            overrides,
+        });
+        return node_stream_1.Readable.fromWeb(stream);
+    }
     /**
      * Download the attachment as a byte array
      * @param identifier Grant ID or email account to query

package/lib/cjs/resources/domains.js

@@ -0,0 +1,232 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Domains = void 0;
+const serviceAccount_js_1 = require("../models/serviceAccount.js");
+const utils_js_1 = require("../utils.js");
+const resource_js_1 = require("./resource.js");
+/**
+ * Nylas Manage Domains API
+ *
+ * Register email domains and run their DNS verification flow
+ * (ownership / MX / SPF / DKIM / feedback) for Transactional Send and Nylas Inbound.
+ */
+class Domains extends resource_js_1.Resource {
+    assertServiceAccountSigningHeaders(overrides) {
+        const headers = {
+            ...(this.apiClient.headers ?? {}),
+            ...(overrides?.headers ?? {}),
+        };
+        const normalizedHeaders = Object.fromEntries(Object.entries(headers).map(([header, value]) => [
+            header.toLowerCase(),
+            value,
+        ]));
+        const missingHeader = Domains.REQUIRED_SERVICE_ACCOUNT_HEADERS.some((header) => !normalizedHeaders[header]?.trim());
+        if (missingHeader) {
+            throw new Error('Manage Domains API requests require Nylas Service Account signing headers.');
+        }
+    }
+    buildSignedRequest({ method, path, requestBody, signer, overrides, }) {
+        if (!signer) {
+            this.assertServiceAccountSigningHeaders(overrides);
+            const body = requestBody ? (0, utils_js_1.objKeysToSnakeCase)(requestBody) : undefined;
+            return {
+                overrides: { ...overrides, skipAuth: true },
+                serializedBody: body ? (0, serviceAccount_js_1.canonicalJson)(body) : undefined,
+            };
+        }
+        const body = requestBody ? (0, utils_js_1.objKeysToSnakeCase)(requestBody) : undefined;
+        const signedRequest = signer.buildHeaders({ method, path, body });
+        const signedOverrides = {
+            ...overrides,
+            skipAuth: true,
+            headers: {
+                ...(overrides?.headers ?? {}),
+                ...signedRequest.headers,
+            },
+        };
+        this.assertServiceAccountSigningHeaders(signedOverrides);
+        return {
+            overrides: signedOverrides,
+            serializedBody: signedRequest.serializedBody,
+        };
+    }
+    /**
+     * Return all domains for the caller's organization.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The list of domains.
+     */
+    list({ queryParams, signer, overrides, } = {}) {
+        const path = (0, utils_js_1.makePathParams)('/v3/admin/domains', {});
+        if (signer) {
+            return super._list({
+                queryParams,
+                path,
+                getOverrides: () => this.buildSignedRequest({
+                    method: 'GET',
+                    path,
+                    signer,
+                    overrides,
+                }).overrides,
+            });
+        }
+        const signed = this.buildSignedRequest({
+            method: 'GET',
+            path,
+            overrides,
+        });
+        return super._list({
+            queryParams,
+            path,
+            overrides: signed.overrides,
+        });
+    }
+    /**
+     * Return a domain.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The domain.
+     */
+    find({ domainId, signer, overrides, }) {
+        const path = (0, utils_js_1.makePathParams)('/v3/admin/domains/{domainId}', { domainId });
+        const signed = this.buildSignedRequest({
+            method: 'GET',
+            path,
+            signer,
+            overrides,
+        });
+        return super._find({
+            path,
+            overrides: signed.overrides,
+        });
+    }
+    /**
+     * Create a domain.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The created domain.
+     */
+    create({ requestBody, signer, overrides, }) {
+        const path = (0, utils_js_1.makePathParams)('/v3/admin/domains', {});
+        const signed = this.buildSignedRequest({
+            method: 'POST',
+            path,
+            requestBody,
+            signer,
+            overrides,
+        });
+        return super._create({
+            path,
+            requestBody,
+            serializedBody: signed.serializedBody,
+            overrides: signed.overrides,
+        });
+    }
+    /**
+     * Update a domain.
+     *
+     * Note: the response echoes the sparse cleared input (typically just `name`
+     * and `updatedAt`), not a full domain. Re-fetch the domain with `find` if you
+     * need the complete record.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The updated domain fields.
+     */
+    update({ domainId, requestBody, signer, overrides, }) {
+        const path = (0, utils_js_1.makePathParams)('/v3/admin/domains/{domainId}', { domainId });
+        const signed = this.buildSignedRequest({
+            method: 'PUT',
+            path,
+            requestBody,
+            signer,
+            overrides,
+        });
+        return super._update({
+            path,
+            requestBody,
+            serializedBody: signed.serializedBody,
+            overrides: signed.overrides,
+        });
+    }
+    /**
+     * Delete a domain.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The deletion response.
+     */
+    destroy({ domainId, signer, overrides, }) {
+        const path = (0, utils_js_1.makePathParams)('/v3/admin/domains/{domainId}', { domainId });
+        const signed = this.buildSignedRequest({
+            method: 'DELETE',
+            path,
+            signer,
+            overrides,
+        });
+        return super._destroy({
+            path,
+            overrides: signed.overrides,
+        });
+    }
+    /**
+     * Get the DNS record a customer must configure for a given verification type.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The verification result, including the DNS record to configure.
+     */
+    info({ domainId, requestBody, signer, overrides, }) {
+        const path = (0, utils_js_1.makePathParams)('/v3/admin/domains/{domainId}/info', {
+            domainId,
+        });
+        const signed = this.buildSignedRequest({
+            method: 'POST',
+            path,
+            requestBody,
+            signer,
+            overrides,
+        });
+        return super._create({
+            path,
+            requestBody,
+            serializedBody: signed.serializedBody,
+            overrides: signed.overrides,
+        });
+    }
+    /**
+     * Trigger a DNS verification check for a given verification type.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The verification result, including the current status.
+     */
+    verify({ domainId, requestBody, signer, overrides, }) {
+        const path = (0, utils_js_1.makePathParams)('/v3/admin/domains/{domainId}/verify', {
+            domainId,
+        });
+        const signed = this.buildSignedRequest({
+            method: 'POST',
+            path,
+            requestBody,
+            signer,
+            overrides,
+        });
+        return super._create({
+            path,
+            requestBody,
+            serializedBody: signed.serializedBody,
+            overrides: signed.overrides,
+        });
+    }
+}
+exports.Domains = Domains;
+Domains.REQUIRED_SERVICE_ACCOUNT_HEADERS = [
+    'x-nylas-kid',
+    'x-nylas-timestamp',
+    'x-nylas-nonce',
+    'x-nylas-signature',
+];

package/lib/cjs/resources/messages.js

@@ -81,13 +81,14 @@ class Messages extends resource_js_1.Resource {
      * Send an email
      * @return The sent message
      */
-    async send({ identifier, requestBody, overrides, }) {
+    async send({ identifier, requestBody, queryParams, overrides, }) {
         const path = (0, utils_js_1.makePathParams)('/v3/grants/{identifier}/messages/send', {
             identifier,
         });
         const requestOptions = {
             method: 'POST',
             path,
+            queryParams,
             overrides,
         };
         // Use form data if the total payload size (body + attachments) is greater than 3mb

package/lib/cjs/resources/redirectUris.js

@@ -47,7 +47,7 @@ class RedirectUris extends resource_js_1.Resource {
      * @return The updated Redirect URI
      */
     update({ redirectUriId, requestBody, overrides, }) {
-        return super._update({
+        return super._updatePatch({
             overrides,
             path: (0, utils_js_1.makePathParams)('/v3/applications/redirect-uris/{redirectUriId}', {
                 redirectUriId,
@@ -57,7 +57,7 @@ class RedirectUris extends resource_js_1.Resource {
     }
     /**
      * Delete a Redirect URI
-     * @return The deleted Redirect URI
+     * @return The deletion response
      */
     destroy({ redirectUriId, overrides, }) {
         return super._destroy({

package/lib/cjs/resources/resource.js

@@ -13,13 +13,26 @@ class Resource {
     constructor(apiClient) {
         this.apiClient = apiClient;
     }
-    async fetchList({ queryParams, path, overrides, }) {
+    async fetchList({ queryParams, path, overrides, getOverrides, }) {
         const res = await this.apiClient.request({
             method: 'GET',
             path,
             queryParams,
-            overrides,
+            overrides: getOverrides ? getOverrides() : overrides,
         });
+        // Some list endpoints return a nested envelope after key conversion:
+        // { data: { items: T[], nextCursor? } }.
+        // This guard remaps that nested shape back to the flat shape the list machinery
+        // and public SDK surface expect.
+        const data = res.data;
+        if (data != null &&
+            !Array.isArray(data) &&
+            typeof data === 'object' &&
+            Array.isArray(data.items)) {
+            const nested = data;
+            res.data = nested.items;
+            res.nextCursor = nested.nextCursor ?? res.nextCursor;
+        }
         if (queryParams?.limit) {
             let entriesRemaining = queryParams.limit;
             while (res.data.length != queryParams.limit) {
@@ -35,7 +48,7 @@ class Resource {
                         limit: entriesRemaining,
                         pageToken: res.nextCursor,
                     },
-                    overrides,
+                    overrides: getOverrides ? getOverrides() : overrides,
                 });
                 res.data = res.data.concat(nextRes.data);
                 res.requestId = nextRes.requestId;
@@ -81,12 +94,13 @@ class Resource {
             overrides,
         });
     }
-    payloadRequest(method, { path, queryParams, requestBody, overrides }) {
+    payloadRequest(method, { path, queryParams, requestBody, serializedBody, overrides, }) {
         return this.apiClient.request({
             method,
             path,
             queryParams,
             body: requestBody,
+            serializedBody,
             overrides,
         });
     }

package/lib/cjs/resources/threads.js

@@ -34,13 +34,14 @@ class Threads extends resource_js_1.Resource {
      * Return a Thread
      * @return The thread
      */
-    find({ identifier, threadId, overrides, }) {
+    find({ identifier, threadId, overrides, queryParams, }) {
         return super._find({
             path: (0, utils_js_1.makePathParams)('/v3/grants/{identifier}/threads/{threadId}', {
                 identifier,
                 threadId,
             }),
             overrides,
+            queryParams,
         });
     }
     /**