npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dodoo

v1.1.4

Published

Node.js typesafe client for odoo ERP using xmlrpc api

Downloads

18

Readme

dodoo

This package offers a painless implementation of odoo xmlrpc api in javascript

Installation

Install the plugin from npm:

npm install dodoo

Then import the main class:

// with "esModuleInterop"
import Odoo from "dodoo"
// or without
import * as Odoo from "dodoo"
// or just
const Odoo = require("dodoo")

Usage

Instantiate the main class:

const odoo = new Odoo({
  url: process.env.ODOO_URL,
  db: process.env.ODOO_DB,
  username: process.env.ODOO_USERNAME,
  password: process.env.ODOO_PASSWORD,
})

From that instance you can call these methods:

  • version: Returns the server version (doesn't require to be authenticated so you can call it, for example, to verify the status of the server and configuration)
  • authenticate: This method is needed in order to acccess objects on your odoo server, consider a best practice to call it first than every other method
  • executeKw: This method offer a way to access every model
  • model: This method instantiate a helper classes to access models on odoo

version, authenticate and executeKw (execute_kw) are documented on Odoo, while for model:

const ResPartner = odoo.model("res.partner")

// ResPartner.create
// ResPartner.createMany
// ResPartner.findById
// ResPartner.findOne
// ResPartner.findMany
// ResPartner.update
// ResPartner.updateMany
// ResPartner.delete
// ResPartner.deleteMany
// ResPartner.count
// ResPartner.upsert

// Each model instance is a record of that model
const singlePartner = new ResPartner({ name: "Jhon" })

// You can modify records directly
singlePartner.email = "[email protected]"
;(async () => {
  // call hasChanged to know if a certain field has been changed since the first instantiation or the last `save` or `reload` call
  if (singlePartner.hasChanged("email"))
    await singlePartner.save() // call save to sync local values on odoo
  else await singlePartner.reload() // or reload to discard them and pull the latest values from odoo
})()

// singlePartner.hasChanged
// singlePartner.decrement
// singlePartner.increment
// singlePartner.save
// singlePartner.reload
// singlePartner.delete

P.S.: if, when creating or updating records, you need to pass a value for a One2Many or a Many2Many field you can use Command which exposes some utility methods to handle them.

Full example:

import Odoo from "dodoo"

const odoo = new Odoo({
  url: process.env.ODOO_URL,
  db: process.env.ODOO_DB,
  username: process.env.ODOO_USERNAME,
  password: process.env.ODOO_PASSWORD,
})

;(async () => {
  await odoo.authenticate()

  const AccountMove = odoo.model("account.move")

  const move = new AccountMove({
    // rest invoice
    invoice_line_ids: [
      Odoo.Command.create({
        // rest invoice line
        tax_ids: [Odoo.Command.set(1, 2, 3)],
      }),
    ],
  })

  await move.save()
})()

P.P.S.: The docs are implemented in a more detailed way as jsdocs

License

MIT