nylas 8.1.1 → 8.2.0

package/lib/cjs/resources/workspaces.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Workspaces = void 0;
+const utils_js_1 = require("../utils.js");
+const resource_js_1 = require("./resource.js");
+/**
+ * Nylas Workspaces API
+ *
+ * Workspaces group grants in a Nylas application by email domain. Grants can be
+ * auto-grouped by matching email domain or manually assigned and removed.
+ */
+class Workspaces extends resource_js_1.Resource {
+    /**
+     * Return all workspaces for the application.
+     *
+     * The list endpoint is not paginated and returns every workspace as a flat array.
+     * @return The list of workspaces.
+     */
+    list({ queryParams, overrides, } = {}) {
+        return super._list({
+            queryParams,
+            path: (0, utils_js_1.makePathParams)('/v3/workspaces', {}),
+            overrides,
+        });
+    }
+    /**
+     * Return a workspace.
+     * @return The workspace.
+     */
+    find({ workspaceId, overrides, }) {
+        return super._find({
+            path: (0, utils_js_1.makePathParams)('/v3/workspaces/{workspaceId}', { workspaceId }),
+            overrides,
+        });
+    }
+    /**
+     * Create a workspace.
+     * @return The created workspace.
+     */
+    create({ requestBody, overrides, }) {
+        return super._create({
+            path: (0, utils_js_1.makePathParams)('/v3/workspaces', {}),
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Update a workspace.
+     *
+     * Issued as PATCH; the workspace must be addressed by its UUID.
+     * @return The updated workspace.
+     */
+    update({ workspaceId, requestBody, overrides, }) {
+        return super._updatePatch({
+            path: (0, utils_js_1.makePathParams)('/v3/workspaces/{workspaceId}', { workspaceId }),
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Delete a workspace.
+     * @return The deletion response.
+     */
+    destroy({ workspaceId, overrides, }) {
+        return super._destroy({
+            path: (0, utils_js_1.makePathParams)('/v3/workspaces/{workspaceId}', { workspaceId }),
+            overrides,
+        });
+    }
+    /**
+     * Start a background job that auto-groups grants into workspaces by email domain.
+     * @return The auto-group job response.
+     */
+    autoGroup({ requestBody, overrides, } = {}) {
+        return super._create({
+            path: (0, utils_js_1.makePathParams)('/v3/workspaces/auto-group', {}),
+            requestBody: requestBody ?? {},
+            overrides,
+        });
+    }
+    /**
+     * Manually assign grants to and/or remove grants from a workspace.
+     * @return The assignment response.
+     */
+    manualAssign({ workspaceId, requestBody, overrides, }) {
+        return super._create({
+            path: (0, utils_js_1.makePathParams)('/v3/workspaces/{workspaceId}/manual-assign', {
+                workspaceId,
+            }),
+            requestBody,
+            overrides,
+        });
+    }
+}
+exports.Workspaces = Workspaces;

package/lib/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
 // This file is generated by scripts/exportVersion.js
-exports.SDK_VERSION = '8.1.1';
+exports.SDK_VERSION = '8.2.0';

package/lib/esm/apiClient.js

@@ -2,7 +2,7 @@ import { NylasApiError, NylasOAuthError, NylasSdkTimeoutError, } from './models/
 import { objKeysToCamelCase, objKeysToSnakeCase } from './utils.js';
 import { SDK_VERSION } from './version.js';
 import { FormDataEncoder } from 'form-data-encoder';
-import { Readable } from 'stream';
+import { Readable } from 'node:stream';
 import { snakeCase } from 'change-case';
 /**
  * The header key for the debugging flow ID
@@ -63,12 +63,15 @@ export default class APIClient {
             ...this.headers,
             ...overrides?.headers,
         };
-        return {
+        const defaultHeaders = {
             Accept: 'application/json',
             'User-Agent': `Nylas Node SDK v${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);
@@ -147,7 +150,11 @@ export default 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(objKeysToSnakeCase(optionParams.body, ['metadata']) // metadata should remain as is
             );
             requestOptions.headers['Content-Type'] = 'application/json';

package/lib/esm/models/domains.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/models/index.js

@@ -8,6 +8,7 @@ export * from './calendars.js';
 export * from './connectors.js';
 export * from './contacts.js';
 export * from './credentials.js';
+export * from './domains.js';
 export * from './drafts.js';
 export * from './error.js';
 export * from './events.js';
@@ -22,6 +23,8 @@ export * from './redirectUri.js';
 export * from './response.js';
 export * from './rules.js';
 export * from './scheduler.js';
+export * from './serviceAccount.js';
 export * from './smartCompose.js';
 export * from './threads.js';
 export * from './webhooks.js';
+export * from './workspaces.js';

package/lib/esm/models/messages.js

@@ -4,6 +4,7 @@
 export 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/esm/models/serviceAccount.js

@@ -0,0 +1,93 @@
+import { createPrivateKey, createSign, randomInt, } from '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 = createPrivateKey(normalizePrivateKey(privateKeyPem));
+    if (privateKey.asymmetricKeyType !== 'rsa') {
+        throw new Error('Service account private key must be RSA.');
+    }
+    return privateKey;
+}
+export 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[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.
+ */
+export function canonicalJson(data) {
+    return canonicalValue(data);
+}
+/**
+ * Generates Nylas Service Account request signing headers.
+ */
+export 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 = 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,
+        };
+    }
+}

package/lib/esm/models/workspaces.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/nylas.js

@@ -16,8 +16,10 @@ import { Contacts } from './resources/contacts.js';
 import { Attachments } from './resources/attachments.js';
 import { Scheduler } from './resources/scheduler.js';
 import { Notetakers } from './resources/notetakers.js';
+import { Domains } from './resources/domains.js';
 import { Policies } from './resources/policies.js';
 import { Rules } from './resources/rules.js';
+import { Workspaces } from './resources/workspaces.js';
 import { AgentLists } from './resources/agentLists.js';
 /**
  * The entry point to the Node SDK
@@ -45,8 +47,10 @@ class Nylas {
         this.grants = new Grants(this.apiClient);
         this.messages = new Messages(this.apiClient);
         this.notetakers = new Notetakers(this.apiClient);
+        this.domains = new Domains(this.apiClient);
         this.policies = new Policies(this.apiClient);
         this.rules = new Rules(this.apiClient);
+        this.workspaces = new Workspaces(this.apiClient);
         this.lists = new AgentLists(this.apiClient);
         this.threads = new Threads(this.apiClient);
         this.webhooks = new Webhooks(this.apiClient);

package/lib/esm/resources/applications.js

@@ -24,4 +24,17 @@ export class Applications extends 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: makePathParams('/v3/applications', {}),
+            requestBody,
+            overrides,
+        });
+    }
 }

package/lib/esm/resources/attachments.js

@@ -1,5 +1,6 @@
 import { makePathParams } from '../utils.js';
 import { Resource } from './resource.js';
+import { Readable } from 'node:stream';
 /**
  * Nylas Attachments API
  *
@@ -20,15 +21,15 @@ export class Attachments extends 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({
@@ -37,6 +38,27 @@ export class Attachments extends 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 Readable.fromWeb(stream);
+    }
     /**
      * Download the attachment as a byte array
      * @param identifier Grant ID or email account to query

package/lib/esm/resources/domains.js

@@ -0,0 +1,228 @@
+import { canonicalJson, } from '../models/serviceAccount.js';
+import { makePathParams, objKeysToSnakeCase } from '../utils.js';
+import { Resource } from './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.
+ */
+export class Domains extends 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 ? objKeysToSnakeCase(requestBody) : undefined;
+            return {
+                overrides: { ...overrides, skipAuth: true },
+                serializedBody: body ? canonicalJson(body) : undefined,
+            };
+        }
+        const body = requestBody ? 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 = 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 = 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 = 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 = 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 = 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 = 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 = 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,
+        });
+    }
+}
+Domains.REQUIRED_SERVICE_ACCOUNT_HEADERS = [
+    'x-nylas-kid',
+    'x-nylas-timestamp',
+    'x-nylas-nonce',
+    'x-nylas-signature',
+];

package/lib/esm/resources/messages.js

@@ -78,13 +78,14 @@ export class Messages extends Resource {
      * Send an email
      * @return The sent message
      */
-    async send({ identifier, requestBody, overrides, }) {
+    async send({ identifier, requestBody, queryParams, overrides, }) {
         const path = 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/esm/resources/redirectUris.js

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

package/lib/esm/resources/resource.js

@@ -10,13 +10,26 @@ export 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) {
@@ -32,7 +45,7 @@ export class Resource {
                         limit: entriesRemaining,
                         pageToken: res.nextCursor,
                     },
-                    overrides,
+                    overrides: getOverrides ? getOverrides() : overrides,
                 });
                 res.data = res.data.concat(nextRes.data);
                 res.requestId = nextRes.requestId;
@@ -78,12 +91,13 @@ export 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,
         });
     }