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

id-core

v1.0.0-alpha1

Published

iDEditor core OSM data types and graph https://github.com/openstreetmap/iD/blob/master/ARCHITECTURE.md#core

Downloads

18

Readme

iD-core - core data types from iDEditor

build status npm version

ALPHA: see TODO

Overview

This packages up iD Editor core OSM data types and Graph as an npm package to require() in your own projects. Included:

Usage

Needs to be instantiated with presets **subject to change see TODO.

npm install id-core
var presets = {
    categories: {},
    defaults: {},
    fields: {},
    presets: {}
};

var iDCore = require('id-core');

var myNode = new iDCore.Node();

Why

According to https://github.com/openstreetmap/iD/blob/master/ARCHITECTURE.md#core

[iD] eventually aims to be a reusable, modular library to kickstart other JavaScript-based tools for OpenStreetMap.

The OSM data model is complex and hard to implement. iD is not published on npm and importing the whole iD project is excessive for a JavaScript based tool for OpenStreetMap. At Digital Democracy we are building tools on top of OSM, and borrowing from iD gives us a head start.

How

iD does not use a commonJS module structure, so it's not as simple as requireing what is needed. We use Smash to concatenate just what is needed from d3 and iD editor to make things work. To rebuild from iD source files:

make clean && make

Tests

npm install
npm test

Uses tests directly from iD to test exported objects.

TODO

  • iD-core needs to be instantiated with presets, since the core types depend on them being set. We currently export the uninstantiated object though, which is needed for tests to work, but that means we have no access to the instantiated presets object.
  • Needs documentation beyond https://github.com/openstreetmap/iD/blob/master/ARCHITECTURE.md#core
  • iD.locale has no tests yet. It is adapted from iD/js/lib/locale.js which polutes the global namespace, which we don't want. We can writed our own or wait for iD/#890.

License

iD-core is available under the WTFPL, though obviously, if you want to dual-license any contributions that's cool. It includes d3js, which BSD-licensed.