Skip to content

Commit

Permalink
New build 0.6.3
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidValin committed Oct 8, 2018
1 parent d3859a4 commit e71086e
Show file tree
Hide file tree
Showing 13 changed files with 188 additions and 144 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Build Status](https://travis-ci.org/howerest/sdkzer.svg?branch=master)](https://travis-ci.org/howerest/sdkzer)

# Full API docs
Current v0.6.2 - [Read full API docs](http://www.howerest.com/sdkzer/docs/0.6.2/classes/_howerest_sdkzer_.sdkzer.html)
Current v0.6.3 - [Read full API docs](http://www.howerest.com/sdkzer/docs/0.6.3/classes/_howerest_sdkzer_.sdkzer.html)

## Introduction ##
sdkzer implements a dev-friendly javascript API to interact with http services implemented as RESTful which implement CRUD operations: Create, Read, Update and Delete. You create entities that extend Sdkzer class and those will automatically be connected to your restful backend endpoints. A class like User will allow you to deal with your http://yourdomain.com/api/v1/users endpoint.
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sdkzer",
"version": "0.6.2",
"version": "0.6.3",
"description": "Implements a simple API to deal with RESTful web services (endpoints) from Javascript.",
"main": "dist/howerest.sdkzer.js",
"authors": [
Expand Down
224 changes: 130 additions & 94 deletions dist/doc/classes/_howerest_sdkzer_.sdkzer.html

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions dist/doc/classes/_validation_rule_.validationrule.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L17">validation_rule.ts:17</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L17">validation_rule.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -153,7 +153,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> _invalid<wbr>Message</h
<div class="tsd-signature tsd-kind-icon">_invalid<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;Invalid&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L17">validation_rule.ts:17</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L17">validation_rule.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -163,7 +163,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> conditions</h3>
<div class="tsd-signature tsd-kind-icon">conditions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L13">validation_rule.ts:13</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L13">validation_rule.ts:13</a></li>
</ul>
</aside>
</section>
Expand All @@ -173,7 +173,7 @@ <h3>from<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">from<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L14">validation_rule.ts:14</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L14">validation_rule.ts:14</a></li>
</ul>
</aside>
</section>
Expand All @@ -184,7 +184,7 @@ <h3>params</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_validation_rule_.ivalidationrule.html">IValidationRule</a>.<a href="../interfaces/_validation_rule_.ivalidationrule.html#params">params</a></p>
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L16">validation_rule.ts:16</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L16">validation_rule.ts:16</a></li>
</ul>
</aside>
</section>
Expand All @@ -194,7 +194,7 @@ <h3>to<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">to<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L15">validation_rule.ts:15</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L15">validation_rule.ts:15</a></li>
</ul>
</aside>
</section>
Expand All @@ -211,7 +211,7 @@ <h3>invalid<wbr>Message</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L27">validation_rule.ts:27</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L27">validation_rule.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -236,7 +236,7 @@ <h3>add<wbr>Invalid<wbr>Message</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L52">validation_rule.ts:52</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L52">validation_rule.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -265,7 +265,7 @@ <h3>is<wbr>Valid</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_validation_rule_.ivalidationrule.html">IValidationRule</a>.<a href="../interfaces/_validation_rule_.ivalidationrule.html#isvalid">isValid</a></p>
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L34">validation_rule.ts:34</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L34">validation_rule.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions dist/doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ <h1> sdkzer</h1>
<h2 id="sdkzer">sdkzer</h2>
<p><a href="https://travis-ci.org/howerest/sdkzer"><img src="https://travis-ci.org/howerest/sdkzer.svg?branch=master" alt="Build Status"></a></p>
<h1 id="full-api-docs">Full API docs</h1>
<p>Current v0.6.2 - <a href="http://www.howerest.com/sdkzer/docs/0.6.2/classes/_howerest_sdkzer_.sdkzer.html">Read full API docs</a></p>
<p>Current v0.6.3 - <a href="http://www.howerest.com/sdkzer/docs/0.6.3/classes/_howerest_sdkzer_.sdkzer.html">Read full API docs</a></p>
<h2 id="introduction">Introduction</h2>
<p>sdkzer implements a dev-friendly javascript API to interact with http services implemented as RESTful which implement CRUD operations: Create, Read, Update and Delete. You create entities that extend Sdkzer class and those will automatically be connected to your restful backend endpoints. A class like User will allow you to deal with your <a href="http://yourdomain.com/api/v1/users">http://yourdomain.com/api/v1/users</a> endpoint.</p>
<p>If you have a RESTful (CRUD) http API, sdkzer will work out of the box allowing you to Create, Read, Update and Delete records from a javascript API that makes sense, along with multiple methods to deal with the record state.</p>
Expand Down Expand Up @@ -352,4 +352,4 @@ <h2>Legend</h2>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>restful</h3>
<div class="tsd-signature tsd-kind-icon">restful<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/howerest.sdkzer.ts#L578">howerest.sdkzer.ts:578</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/howerest.sdkzer.ts#L584">howerest.sdkzer.ts:584</a></li>
</ul>
</aside>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>default<wbr>Http<wbr>Headers</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Http<wbr>Headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/howerest.sdkzer.ts#L571">howerest.sdkzer.ts:571</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/howerest.sdkzer.ts#L577">howerest.sdkzer.ts:577</a></li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions dist/doc/interfaces/_validation_rule_.ivalidationrule.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h3>invalid<wbr>Message</h3>
<div class="tsd-signature tsd-kind-icon">invalid<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L59">validation_rule.ts:59</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L59">validation_rule.ts:59</a></li>
</ul>
</aside>
</section>
Expand All @@ -121,7 +121,7 @@ <h3>params</h3>
<div class="tsd-signature tsd-kind-icon">params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L58">validation_rule.ts:58</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L58">validation_rule.ts:58</a></li>
</ul>
</aside>
</section>
Expand All @@ -138,7 +138,7 @@ <h3>is<wbr>Valid</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/c344a92/src/validation_rule.ts#L61">validation_rule.ts:61</a></li>
<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/4eb1ec0/src/validation_rule.ts#L61">validation_rule.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
21 changes: 13 additions & 8 deletions dist/howerest.sdkzer.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@ export declare class Sdkzer {
/**
* Checks if Sdkzer has been configured to communicate to RESTful resources
*/
private static usingRestfulCrudHttpPattern();
private static usingRestfulCrudHttpPattern;
/**
* Checks if Sdkzer has been configured to communicate using custom CRUD endpoints
*/
private static usingCustomHttpPattern();
private static usingCustomHttpPattern;
/**
* Checks if Sdkzer is using any fetch strategy once received parent ids
*/
private static usingParentsFetchStrategy();
private static usingParentsFetchStrategy;
/**
* Retrieves the http guess config for an specific CRUD operation.
* @param {String} operation Accepts "create", "read", "update" and "delete"
*/
private static getHttpQueryGuessConfigFor(operation);
private static getHttpQueryGuessConfigFor;
/**
* Sets the defaults() values in the instance attributes
*/
Expand Down Expand Up @@ -121,14 +121,19 @@ export declare class Sdkzer {
*/
fetch(httpQuery?: WebServices.HttpQuery, camelize?: Boolean): Promise<WebServices.HttpResponse>;
/**
* Parses the resources data from an incoming HttpResponse
* The idea is to return the resources attributes exclusively
* Parses a single resource record from an incoming HttpResponse data
* NOTE: The idea is to return the parsed record data only
*/
$parse(data: Object, dataPrefixKey?: string): Object;
parseRecord(data: Object, prefix?: string): object;
/**
* Parses a collection of resource records from an incoming HttpResponse data
* NOTE: The idea is to return the parsed collection of records data only
*/
static parseCollection(data: Array<Object>, prefix?: string): Array<object>;
/**
* Transforms the local attributes to be processed by the origin in JSON format
*/
toOriginJSON(): Object;
protected toOriginJSON(): Object;
/**
* Transforms the local attributes to be processed by the origin in XML format
*/
Expand Down
45 changes: 24 additions & 21 deletions dist/howerest.sdkzer.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/howerest.sdkzer.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sdkzer",
"version": "0.6.2",
"version": "0.6.3",
"description": "Implements a simple API to deal with RESTful web services (endpoints) from Javascript.",
"keywords": [
"sdk",
Expand Down
2 changes: 1 addition & 1 deletion webpack.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ module.exports = {
plugins: [
// new CheckerPlugin(),
new webpack.BannerPlugin({
banner: "sdkzer 0.6.2 - By David Valin - www.davidvalin.com",
banner: "sdkzer 0.6.3 - By David Valin - www.davidvalin.com",
entryOnly: true
})
]
Expand Down

0 comments on commit e71086e

Please sign in to comment.