@adobe/aio-lib-db 0.1.0-alpha.1

package/utils/apiRequest.js

@@ -0,0 +1,103 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+const { RUNTIME_HEADER, REQUEST_ID_HEADER } = require('../lib/constants')
+const DbError = require('../lib/DbError')
+const { EJSON } = require("bson")
+
+/**
+ * Execute a POST request to the App Builder Database Service API and return the data field from the result
+ *
+ * @param {DbBase} db
+ * @param {AxiosInstance} axiosClient
+ * @param {string} apiPath db api url past <ENDPOINT>/v1/
+ * @param {Object=} params
+ * @param {Object=} options
+ * @returns {Promise<*>}
+ * @throws {DbError}
+ */
+async function apiPost(db, axiosClient, apiPath, params = {}, options = {}) {
+  const body = params
+  if (Object.keys(options).length > 0) {
+    body.options = options
+  }
+  return await apiRequest(db, axiosClient, `v1/${apiPath}`, 'POST', body)
+}
+
+/**
+ * Execute a GET request to the App Builder Database Service API and return the data field from the result
+ *
+ * @param {DbBase} db
+ * @param {AxiosInstance} axiosClient
+ * @param {string} apiPath db api url past <ENDPOINT>/v1/
+ * @returns {Promise<*>}
+ * @throws {DbError}
+ */
+async function apiGet(db, axiosClient, apiPath) {
+  return await apiRequest(db, axiosClient, `v1/${apiPath}`, 'GET')
+}
+
+/**
+ * Internal helper method to construct and execute a request to the App Builder Database Service API
+ *
+ * @param {DbBase} db
+ * @param {AxiosInstance} axiosClient
+ * @param {string} apiPath
+ * @param {string} method
+ * @param {Object=} body
+ * @returns {Promise<*>}
+ * @throws {DbError}
+ */
+async function apiRequest(db, axiosClient, apiPath, method, body = {}) {
+  const fullUrl = `${db.serviceUrl}/${apiPath}`
+  let res
+  try {
+    const creds = db.runtimeAuth.split(/:(.*)/,2)
+    /** @type {Object}
+     * @mixes AxiosRequestConfig */
+    const reqConfig = {
+      headers: { [RUNTIME_HEADER]: db.runtimeNamespace },
+      auth: {
+        username: creds[0],
+        password: creds[1]
+      }
+    }
+    if (method === 'GET') {
+      res = await axiosClient.get(fullUrl, reqConfig)
+    }
+    else {
+      res = await axiosClient.post(fullUrl, EJSON.stringify(body, { relaxed: false }), reqConfig)
+    }
+  }
+  catch (err) {
+    if (err.response?.data) {
+      const reqId = err.response.data.requestId || err.response.headers[REQUEST_ID_HEADER]
+      throw new DbError(
+        `Request ${reqId} to ${apiPath} failed with code ${err.response.status}: ${err.response.data.message}`,
+        reqId,
+        err.response.status,
+        { cause: err }
+      )
+    }
+    throw err
+  }
+
+  if (!res.data.success) {
+    const reqId = res.data.requestId || res.headers[REQUEST_ID_HEADER]
+    throw new DbError(`Request ${reqId} to ${apiPath} failed: ${res.data.message}`, reqId, res.status)
+  }
+  return res.data.data
+}
+
+module.exports = {
+  apiPost,
+  apiGet
+}

package/utils/axiosUtils.js

@@ -0,0 +1,57 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+const { default: axios } = require("axios")
+const { CookieJar } = require("tough-cookie")
+const { HttpCookieAgent, HttpsCookieAgent } = require("http-cookie-agent/http")
+const { cleanParse } = require("./ejsonHandler")
+
+/**
+ * Use EJSON instead of JSON and clean primitive values
+ *
+ * @param {AxiosResponse} response
+ * @returns {AxiosResponse}
+ */
+function jsonToEjson(response) {
+  if (/^application\/json/.test(response.headers["content-type"])) {
+    response.data = cleanParse(response.data)
+  }
+  return response
+}
+
+/**
+ * Instantiate an Axios client with optional session support
+ *
+ * @param withSession
+ * @return {AxiosInstance}
+ */
+function getAxiosClient(withSession = false) {
+  let client
+
+  if (withSession) {
+    const jar = new CookieJar()
+    client = axios.create({
+      httpAgent: new HttpCookieAgent({ cookies: { jar } }),
+      httpsAgent: new HttpsCookieAgent({ cookies: { jar } })
+    })
+  }
+  else {
+    client = axios.create()
+  }
+
+  // Parse 20x results using EJSON instead of JSON
+  client.interceptors.response.use(jsonToEjson)
+  return client
+}
+
+module.exports = {
+  getAxiosClient
+}

package/utils/ejsonHandler.js

@@ -0,0 +1,61 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+const { BSONValue, EJSON } = require("bson")
+
+/**
+ * Transform any of the object's properties that are BSONValues representing primitives back into their js types
+ * Does a recursive deep mapping
+ *
+ * @param {Object} obj
+ * @returns {BSONValue|Object|*}
+ */
+function transformBsonPrimitives(obj) {
+  // A long-standing bug in js makes typeof null = 'object', so filter that out first
+  if (obj === null) {
+    return obj
+  }
+  else if (obj instanceof BSONValue) {
+    if (obj.valueOf !== undefined && typeof obj.valueOf() !== 'object') {
+      return obj.valueOf()
+    }
+    return obj
+  }
+  else if (Array.isArray(obj)) {
+    return obj.map((val) => {
+      return transformBsonPrimitives(val)
+    })
+  }
+  else if (typeof obj === 'object') {
+    const mapped = {}
+    Object.keys(obj).forEach((key) => {
+      mapped[key] = transformBsonPrimitives(obj[key])
+    })
+    return mapped
+  }
+  else {
+    return obj
+  }
+}
+
+/**
+ * Parse a response into BSON with {relaxed: false} except for primitives
+ *
+ * @param {Object} res The body from an Axios response
+ * @returns {Object}
+ */
+function cleanParse(res) {
+  return transformBsonPrimitives(EJSON.parse(JSON.stringify(res), { relaxed: false }))
+}
+
+module.exports = {
+  cleanParse
+}