JavaScript SDK

npm install @terrakernel/odxproxy-client-js
# or: yarn add / pnpm add

import { init, search_read } from "@terrakernel/odxproxy-client-js";

init({
  instance: {
    url: process.env.ODOO_URL!,      // your Odoo base URL
    db: process.env.ODOO_DB!,        // Odoo database name
    user_id: 2,                      // Odoo user id (integer)
    api_key: process.env.ODOO_API_KEY!,  // the Odoo USER's api key
  },
  odx_api_key: process.env.ODX_API_KEY!, // the PROXY's x-api-key
  gateway_url: "https://your-proxy.example.com", // optional; default https://gateway.odxproxy.io
  default_timeout_secs: 15,               // optional; sent as x-request-timeout
  default_context: { lang: "en_US", allowed_company_ids: [1] }, // optional; v2 calls only
});

type Partner = { id: number; name: string; email?: string };

const res = await search_read<Partner>(
  "res.partner",
  [[["is_company", "=", true]]],           // domain (params)
  { fields: ["id", "name", "email"], limit: 50, context: { tz: "UTC" } }
);

const partners = res.result ?? [];

const ac = new AbortController();
await search_read("res.partner", [[]], { context: { tz: "UTC" } }, undefined, {
  timeoutSecs: 60,   // overrides default_timeout_secs for this call
  signal: ac.signal, // cancel via ac.abort()
});

import { create, write, remove, call_method } from "@terrakernel/odxproxy-client-js";

const kw = { context: { tz: "UTC" } };

const created  = await create("res.partner", [{ name: "Acme Inc", is_company: true }], kw);
const updated  = await write("res.partner",  [[42], { name: "Acme LLC" }], kw);
const deleted  = await remove("res.partner", [[42]], kw);

// call_method: function_name is the 4th positional arg (after keyword)
const confirmed = await call_method<boolean>("sale.order", [[42]], kw, "action_confirm");

import { v2 } from "@terrakernel/odxproxy-client-js";

const partners = await v2.search_read<{ id: number; name: string }>("res.partner", {
  domain: [["is_company", "=", true]],
  fields: ["name"],
  limit: 10,
});

const ids = await v2.create("res.partner", [{ name: "Acme" }, { name: "Globex" }]); // result: [41, 42]
const one = await v2.create_one("res.partner", { name: "Initech" });               // result: 43
await v2.write("res.partner", ids.result!, { comment: "via v2" });
await v2.remove("res.partner", ids.result!);

await v2.call_method("account.move", "action_post", { ids: [7] });                  // record method
await v2.call_method("res.partner", "name_search", { name: "Acm", limit: 5 });

import { version, about, license, metrics } from "@terrakernel/odxproxy-client-js";

const v   = await version("https://erp.example.com"); // envelope; url is required
const a   = await about();      // envelope: { build, version }
const lic = await license();    // OdxLicenseInfo — NOT an envelope
const txt = await metrics();    // Prometheus text (string)

import { search_read, AuthError, OdooLogicError, OdooTimeoutError, OdxError }
  from "@terrakernel/odxproxy-client-js";

try {
  const res = await search_read("res.partner", [[]], { context: { tz: "UTC" } });
  console.log(res.result);
} catch (err) {
  if (err instanceof AuthError)        { /* bad x-api-key — reauth */ }
  else if (err instanceof OdooLogicError)   { /* Odoo validation / access error */ }
  else if (err instanceof OdooTimeoutError) { /* retry with backoff */ }
  else if (err instanceof OdxError)    { console.error(err.code, err.message, err.httpStatus); }
  else throw err; // not from this SDK (e.g. a caller-initiated AbortError)
}