Add generated docs.

Move to CircleCI
auth0 · Jun 19, 2017 · 2a01717 · 2a01717
1 parent 9aba719
commit 2a01717
Show file tree

Hide file tree

Showing 62 changed files with 54,312 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -36,8 +36,8 @@ node_modules
 # InelliJ IDEA
 .idea
 
-# Documentation
-docs/*
 
 build
-**/.env
+**/.env
+out/
+test-results.xml
diff --git a/.jsdoc.json b/.jsdoc.json
@@ -0,0 +1,32 @@
+{
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": [
+            "jsdoc"
+        ]
+    },
+    "source": {
+        "include": [
+            "src",
+            "package.json",
+            "README.md"
+        ],
+        "includePattern": ".js$",
+        "excludePattern": "(node_modules/|docs|test)"
+    },
+    "plugins": [
+        "./node_modules/jsdoc/plugins/markdown"
+    ],
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": true,
+        "useLongnameInNav": false
+    },
+    "opts": {
+        "destination": "./out/",
+        "encoding": "utf8",
+        "private": false,
+        "recurse": true,
+        "template": "./node_modules/minami"
+    }
+}
diff --git a/circle.yml b/circle.yml
@@ -0,0 +1,15 @@
+machine:
+  node:
+    version: v6.10.0
+  environment:
+    PATH: "${PATH}:${HOME}/${CIRCLE_PROJECT_REPONAME}/node_modules/.bin"
+dependencies:
+  override:
+    - yarn
+  cache_directories:
+    - ~/.cache/yarn
+test:
+  override:
+    - yarn test:ci
+  post:
+    - yarn test:coverage
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,18 @@
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+  status:
+    patch:
+      default:
+        if_no_uploads: error
+    changes: true
+    project:
+      default:
+        target: auto
+        if_no_uploads: error
+  ignore:
+    - test/
+    - docs/
+    - examples/
+comment: false
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html
diff --git a/docs/fonts/Lato-Regular.ttf b/docs/fonts/Lato-Regular.ttf
diff --git a/docs/fonts/OFL.txt b/docs/fonts/OFL.txt
@@ -0,0 +1,92 @@
+Copyright (c) 2010-2014 by tyPoland Lukasz Dziedzic (team@latofonts.com) with Reserved Font Name "Lato"
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/docs/fonts/SourceCodePro-Regular.ttf b/docs/fonts/SourceCodePro-Regular.ttf
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
diff --git a/docs/module-auth.html b/docs/module-auth.html
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
diff --git a/docs/module-management.html b/docs/module-management.html
diff --git a/docs/scripts/linenumber.js b/docs/scripts/linenumber.js
@@ -0,0 +1,25 @@
+/*global document */
+(function() {
+    var source = document.getElementsByClassName('prettyprint source linenums');
+    var i = 0;
+    var lineNumber = 0;
+    var lineId;
+    var lines;
+    var totalLines;
+    var anchorHash;
+
+    if (source && source[0]) {
+        anchorHash = document.location.hash.substring(1);
+        lines = source[0].getElementsByTagName('li');
+        totalLines = lines.length;
+
+        for (; i < totalLines; i++) {
+            lineNumber++;
+            lineId = 'line' + lineNumber;
+            lines[i].id = lineId;
+            if (lineId === anchorHash) {
+                lines[i].className += ' selected';
+            }
+        }
+    }
+})();