Packaging and module loading questions

[wyattanderson]

Hey, I have a couple quick questions about packaging and module loading of Orbit.js:

1. What's the preferred way to load Orbit.js? CommonJS support with the version distributed on Bower seems lacking. If I require orbit-common and orbit-common-jsonapi, Orbit and OC are actually leaked to the window object. Is this intentional? Is there a way to build Orbit to avoid this? Are ES6 modules preferred?
2. Why isn't Orbit published to NPM?

I'm trying to set up a new project with Orbit in a CommonJS/webpack stack and these two things are making it tough.

[dgeb]

I've really just been optimizing for my own use cases until others are requested.

I've been targeting AMD usage but am open to exporting CommonJS as well. We should look into customizing the Brocfile to enable CommonJS output from the transpiler.

Also, I'd be willing to publish builds to npm in addition to bower.

[wyattanderson]

Alright, cool. I ended up getting it working with Webpack, Bower and AMD, but need to wait for JSONAPI RC3 or 1.0 support before I go any further. Glad to know you're open to NPM and CommonJS, though! Thanks!

[dgeb]

Sure - glad you worked something out in the meantime.

Also, we're tracking JSON API compliance in #113 - it's very high on the priority list.

[john-griffin]

@dgeb it would be awesome if the builds were also pushed to npm thanks. I was trying to integrate orbit and react native and this seems to be the only way to do it.

[amutz]

@dgeb Another vote here for publishing to NPM. Any guess as to when this might happen?

[dgeb]

@john-griffin @amutz Can you tell me more about your use cases? Are you looking for CommonJS builds as well? Are you using webpack?

If you know of any, please point me to any well done examples of libs published to both bower and npm and transpiled for AMD, CommonJS, and globals.

[john-griffin]

@dgeb I was attempting to integrate a React Native app with a JSON API data source. Orbit could be a good fit for that because it can be used with any framework, is JSON API compatible and allows for defining a custom data source (e.g. I could implement the equivalent of LocalStorageSource for React Native).

React Native apps are complied in Node so use CommonJS. I'm sorry but I'm not familiar with other projects that publish to both bower and npm.

[dgeb]

@john-griffin thanks for the details. I'd definitely like to support this use case and will look into transpiling for CommonJS and simultaneous publishing to bower and npm.

[gnarf]

I'd like npm if only to not need bower for anything :)

[damon-kreft]

@wyattanderson , hey. Could you let us know how you got Orbit working with Webpack?

Thanks

[wyattanderson]

could you let us know how you got Orbit working with Webpack?

Sorry, I don't have the code around anymore. We ended up going a different direction. I needed to do a lot of things mentioned on the shimming modules page to make it work.

[Emerson]

+1 for Webpack and NPM

[dgeb]

Orbit is now published to npm as orbit-core. In addition, sources have been extracted into their own repos as published as orbit-jsonapi and orbit-local-storage. Builds include CommonJS and AMD modules in /dist along with ES modules in /src.

Please let me know if you have any problems with the builds.

[tatemz]

Related to this issue: I am using a React project that imports another one of my modules (an "sdk' that uses OrbitJS).

On a basic test, I am getting compilation errors (using Webpack) such as the following:

Unexpected token: punc (,) [./~/@orbit/core/dist/modules/es2017/main.js:16,0][static/js/main.ee237ffc.js:17062,11]

What is the standard practice for using the es5 version of each Orbit module?

This is the pr that motivated me to post my question here: facebook/create-react-app#2650