mongodb-atlas-api-client: Instructions file for GitHub Copilot

MongoDB Atlas API Client - Copilot Instructions

Project Overview

This is a MongoDB Atlas API client library for Node.js that provides a programmatic interface to the MongoDB Atlas REST API. The library uses HTTP Digest Authentication and wraps the urllib HTTP client library.

Architecture and Code Organization

Module Structure

• Each API resource (User, Cluster, Project, Organization, etc.) is implemented as a separate class in src/
• Each class follows a consistent pattern:
  • Constructor receives: client, baseUrl, and optionally projectId
  • Methods return promises
  • All API methods accept an optional options parameter
• The main entry point (src/index.js) exports a factory function that creates instances of all API resource classes
• TypeScript definitions (.d.ts files) are provided alongside each JavaScript file

Key Components

• httpClient.js: HTTP client wrapper that handles digest authentication
• helper.js: Utility functions for query string generation
• index.js: Main entry point that instantiates and exports all API resource clients

Code Patterns and Conventions

API Method Pattern

async methodName(param1, param2, options = {}) {
  const queryString = getQueryStringFromOptions(options);
  const httpOptions = options.httpOptions;
  const response = await this.client_.fetch(`${this.baseUrl_}/path/${param1}?${queryString}`, {
    "method": "METHOD",
    "data": body,
    ...httpOptions
  });
  return response;
}

Class Pattern

• Private properties use trailing underscore: this.client_, this.baseUrl_, this.projectId_
• All methods are async and return promises
• Methods should handle options parameter for query strings and HTTP options
• The httpOptions parameter is extracted from options and passed separately (not included in query string)

Naming Conventions

• Use camelCase for variables and function names
• Use PascalCase for class names
• Use descriptive names (e.g., getAll, getById, delete, create, update)
• Private instance variables end with underscore: this.client_, this.baseUrl_