Exposing api and ctx in order to make advanced queries

[rudyrigot]

This would solve #10 and #11, but I'm fairly new to Angular JS, so let me know if you feel the way I've done it is relevant.

Also, I have left the non-promise form of submit() that is in the kit, but we can change that. An idea how: extending the Api class into an ApiWithPromise class, and extending the SearchForm class into a SearchFormWithPromise class. The only differences are: ApiWithPromise.form(formName) returns a SearchFormWithPromise instead of just a SearchForm, and SearchFormWithPromise.submit() returns a promise instead of taking a callback. And of course, Prismic.api() would return an ApiWithPromise object. Not sure it's the best way to make it happen; we could also monkey-patch stuff but I'm not sure it would be as clean. Not even sure it's relevant to want to make that callback into a promise. Let me know what you think!

[rudyrigot]

And with ctx exposed, here's the commit to fix the issue I had on the starter project I made yesterday: https://github.com/rudyrigot/javascript-angular-starter/commit/43a85ddf815bee315eac537df9b7ba5e13ee1f6f

(Right now, the bower.json is pointing at my GitHub branch to make it work)

[dlecan]

@rudyrigot you would like to update Prismic JS kit to return promises instead of using callbacks ? What kind of promises ? ES6 promises ? You're launching an Angular + Prismic development, we need IE8 compatibility :)

[rudyrigot]

Older IE compatibility is underway (see here and here).

We talked about doing it with promises directly in the kit when we first built it, and we elected not to. The reasons are cultural across the JS community, and technical:

• first, the kit is for advanced Angular JS developers, but also for the wide community of less experimented JS developers for whom promises are either very new, or entirely unknown.
• second, we want to limit the reliance on third-party libraries in the kit, while being sure to be compatible with older browsers.

Those two reasons don't apply much to using prismic.io with Angular (I believe more people using Angular have heard of promises, and dependencies are well-organized); so although I don't think the JS kit should work with promises, I think it'd be cool if angular-prismicio did.

About this PR though, I'm more interested in feedback about how I exposed what I exposed, and how to expose it better.

[dlecan]

@rudyrigot In my PR, I removed most of the callbacks to have a cleaner code and better errors handling. I introduced promises maybeApi and maybeContext which can be exposed as API methods if necessary.

So yes, for me, exposing context and api can be useful and do it through promises is a good idea.

[rudyrigot]

Yep, I saw your PR, I hope it will be merged soon. :) But from what you're saying, I guess it would probably make sense to rebuild what I did on top of your PR when it's merged, right?

[awulder]

@rudyrigot Should I first merge the PR's of @dlecan?

[rudyrigot]

Yes, definitely; I'll adapt mine when you do, and you guys will then tell me what you think of it.

[awulder]

@rudyrigot I have merged the PR of @dlecan into master.

[rudyrigot]

Yep, there you go, I merged master into this branch, and rewrote my code to adapt to it.

[awulder]

Looking good, thanks.