Adding comments back in.

Author: malexanderlim

components/azure_sql/azure_sql.app.mjs

@@ -65,6 +65,14 @@ export default {
     getConnection() {
       return sql.connect(this.getConfig());
     },
+    /**
+     * A helper method to get the schema of the database. Used by other features
+     * (like the `sql` prop) to enrich the code editor and provide the user with
+     * auto-complete and fields suggestion.
+     *
+     * @returns {DbInfo} The schema of the database, which is a
+     * JSON-serializable object.
+     */
     async getSchema() {
       const sql = `
         SELECT t.TABLE_SCHEMA AS tableSchema,
@@ -97,6 +105,15 @@ export default {
         return acc;
       }, {});
     },
+    /**
+     * Adapts the arguments to `executeQuery` so that they can be consumed by
+     * the SQL proxy (when applicable). Note that this method is not intended to
+     * be used by the component directly.
+     * @param {object} preparedStatement The prepared statement to be sent to the DB.
+     * @param {string} preparedStatement.sql The prepared SQL query to be executed.
+     * @param {string[]} preparedStatement.values The values to replace in the SQL query.
+     * @returns {object} - The adapted query and parameters.
+     */
     proxyAdapter(preparedStatement = {}) {
       const { query } = preparedStatement;
       const inputs = preparedStatement?.inputs || {};
@@ -111,6 +128,16 @@ export default {
         params: [],
       };
     },
+    /**
+     * A method that performs the inverse transformation of `proxyAdapter`.
+     *
+     * @param {object} proxyArgs - The output of `proxyAdapter`.
+     * @param {string} proxyArgs.query - The SQL query to be executed.
+     * @param {string[]} proxyArgs.params - The values to replace in the SQL
+     * query.
+     * @returns {object} - The adapted query and parameters, compatible with
+     * `executeQuery`.
+     */
     executeQueryAdapter(proxyArgs = {}) {
       let { query } = proxyArgs;
       const params = proxyArgs?.params || [];