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

moysklad-tools

v0.3.1

Published

Набор инструментов для библиотеки moysklad

Downloads

14

Readme

moysklad-tools

Набор инструментов для библиотеки moysklad

Набор инструментов автоматизирующих рутинные операции при работе с библиотекой.

Установка

$ npm install moysklad-tools

Использование

const Moysklad = require('moysklad')
const loadRows = require('moysklad-tools/loadRows')

const moysklad = Moysklad()

// ...

let order = await moysklad.GET(['entity/customerorder', orderId])
let orderRows = await loadRows(moysklad, order.positions, { limit: 100 })

// ...

API

#loadRows

tools.loadRows(moysklad: Moysklad, collection: Object, query: Object?) : Array<Object>

При получении документа, позиции могут быть загружены не полностью. loadRows загружает/подгружает позиции в коллекции и возвращает массив rows.

Позиции загружаются асинхронно/параллельно (не через пейджинг по nextHref).

Если коллекция уже загружена частично, то произойдет догрузка остальной части коллекции.

let order = await moysklad.GET(['entity/customerorder', orderId], {
  expand: 'positions'
})

let orderPositionsRows = await loadRows(moysklad, order.positions, { limit: 100 })

#getId

Возвращает идентификатор из url, ref или entity

tools.getId('https://path/to/some/18fba15b-9288-11e9-9109-f8fc00117bb7')
// → 18fba15b-9288-11e9-9109-f8fc00117bb7

tools.getId('entity/foo/18fba15b-9288-11e9-9109-f8fc00117bb7')
// → 18fba15b-9288-11e9-9109-f8fc00117bb7

tools.getId({
  meta: {
    type: 'foo',
    href: 'https://path/to/some/18fba15b-9288-11e9-9109-f8fc00117bb7'
  }
})
// → 18fba15b-9288-11e9-9109-f8fc00117bb7

#getAttr

Возвращает атрибут (attributes) судности по идентификатору или ссылке

tools.getAttr(entity: Object, attrId: String) : Object

tools.getAttr(entity: Object, href: String) : Object

tools.getAttr(entity: Object, ref: String) : Object

tools.getAttr(entity, '18fba15b-9288-11e9-9109-f8fc001173b7')

tools.getAttr(entity, 'https://online.moysklad.ru/api/remap/1.1/entity/customerorder/metadata/attributes/18fba15b-9288-11e9-9109-f8fc001173b7')

tools.getAttr(entity, 'entity/customerorder/metadata/attributes/18fba15b-9288-11e9-9109-f8fc001173b7')

#getAttrMaybe

Оборачивает возвращаемое значение getAttr в maybe.

let attrId = getAttrMaybe(entity, entity.attributes[0].id)
    .map(attr => attr.id)
    .orJust(defaultValue)

let attrValueName = getAttrMaybe(entity, entity.attributes[0].id)
    .get('value.name')
    .orJust(defaultValue)

#getAttrVal

Возвращает значение (value) атрибута (attributes) судности по идентификатору или ссылке

tools.getAttrVal(entity: Object, attrId: String) : any

tools.getAttrVal(entity: Object, href: String) : Object

tools.getAttrVal(entity: Object, ref: String) : Object

[deprecated] #createMeta

Создание структуры meta

createMeta(moysklad: Object, type: String, path: String|Array<String>) : Object

let meta = createMeta(moysklad, 'sometype', 'path/to/some')

assert.deepEqual(meta, {
  type: 'sometype',
  href: 'https://online.moysklad.ru/api/remap/1.1/path/to/some',
  mediaType: 'application/json'
})

[deprecated] #createAttr

Создание структуры пользовательского поля c типом справочник

  • tools.createAttr(moysklad: Object, id: String, entityId: String) : Object

    // id пользовательского атрибута с типом "Справочник"
    const СПОСОБ_ДОСТАВКИ = '48a9dbca-75f3-4f1c-933b-57df18b5169f'
    
    // {id справочника}/{id элемента справочника}
    const ПОЧТА = '3e2a8f95-e4d2-4ae7-90a4-e61ff2dde955/55e6f545-b41f-4a72-8b85-363058b68598'
    
    let attr = createAttr(moysklad, СПОСОБ_ДОСТАВКИ, ПОЧТА)
    
    assert.deepEqual(attr, {
      id: '48a9dbca-75f3-4f1c-933b-57df18b5169f',
      value: {
        meta: {
          type: 'customentity',
          href: 'https://online.moysklad.ru/api/remap/1.1/entity/customentity/3e2a8f95-e4d2-4ae7-90a4-e61ff2dde955/55e6f545-b41f-4a72-8b85-363058b68598',
          mediaType: 'application/json'
        }
      }
    })
  • tools.createAttr(moysklad?: Object, id: String, name: String) : Object

    Упрощенная запись с указанием имени элемента пользовательского справочника.

    // id пользовательского атрибута с типом "Справочник"
    const СПОСОБ_ДОСТАВКИ = '48a9dbca-75f3-4f1c-933b-57df18b5169f'
    
    let attr = client.createAttr(СПОСОБ_ДОСТАВКИ, 'Почта')
    
    assert.deepEqual(attr, {
      id: '48a9dbca-75f3-4f1c-933b-57df18b5169f',
      value: {
        name: 'Почта'
      }
    })

Пользовательские атрибуты других типов создаются ввиде простых объектов, без специальных методов

const АДРЕС_ДОСТАВКИ = '48a9dbca-75f3-4f1c-933b-57df18b5169f'
let stringAttr = {
  id: АДРЕС_ДОСТАВКИ,
  value: 'ул. Красноармейская, 10'
}

const КОЛ_ВО_МЕСТ = '48a9dbca-75f3-4f1c-933b-57df18b5169с'
let numberAttr = {
  id: КОЛ_ВО_МЕСТ,
  value: 2
}

const ВРЕМЯ_ДОСТАВКИ = '48a9dbca-75f3-4f1c-933b-57df18b5169d'
let timeAttr = {
  id: ВРЕМЯ_ДОСТАВКИ,
  value: Moysklad.getTimeString(new Date(2017, 2, 7, 11, 25))
}