From 03c2a482da148138d383bbad37651fda5024d98e Mon Sep 17 00:00:00 2001 From: Ronald Ray Date: Fri, 10 May 2019 09:04:27 -0700 Subject: [PATCH] Documentation --- docs/assets/css/external-small.png | Bin docs/assets/css/logo.png | Bin docs/assets/css/main.css | 0 docs/assets/favicon.ico | Bin docs/assets/img/spinner.gif | Bin docs/assets/index.html | 0 docs/assets/js/api-filter.js | 0 docs/assets/js/api-list.js | 0 docs/assets/js/api-search.js | 0 docs/assets/js/apidocs.js | 0 docs/assets/js/yui-prettify.js | 0 docs/assets/vendor/prettify/CHANGES.html | 0 docs/assets/vendor/prettify/COPYING | 0 docs/assets/vendor/prettify/README.html | 0 docs/assets/vendor/prettify/prettify-min.css | 0 docs/assets/vendor/prettify/prettify-min.js | 0 docs/classes/EcAesCtrAsyncWorker.html | 1123 ++++++++++++++ docs/classes/EcCrypto.html | 1070 +++++++++++++ docs/classes/EcFrameworkGraph.html | 1056 +++++++++++++ docs/classes/EcRsaOaepAsyncWorker.html | 1421 ++++++++++++++++++ docs/classes/Task.html | 926 ++++++++++++ 21 files changed, 5596 insertions(+) mode change 100644 => 100755 docs/assets/css/external-small.png mode change 100644 => 100755 docs/assets/css/logo.png mode change 100644 => 100755 docs/assets/css/main.css mode change 100644 => 100755 docs/assets/favicon.ico mode change 100644 => 100755 docs/assets/img/spinner.gif mode change 100644 => 100755 docs/assets/index.html mode change 100644 => 100755 docs/assets/js/api-filter.js mode change 100644 => 100755 docs/assets/js/api-list.js mode change 100644 => 100755 docs/assets/js/api-search.js mode change 100644 => 100755 docs/assets/js/apidocs.js mode change 100644 => 100755 docs/assets/js/yui-prettify.js mode change 100644 => 100755 docs/assets/vendor/prettify/CHANGES.html mode change 100644 => 100755 docs/assets/vendor/prettify/COPYING mode change 100644 => 100755 docs/assets/vendor/prettify/README.html mode change 100644 => 100755 docs/assets/vendor/prettify/prettify-min.css mode change 100644 => 100755 docs/assets/vendor/prettify/prettify-min.js create mode 100644 docs/classes/EcAesCtrAsyncWorker.html create mode 100644 docs/classes/EcCrypto.html create mode 100644 docs/classes/EcFrameworkGraph.html create mode 100644 docs/classes/EcRsaOaepAsyncWorker.html create mode 100644 docs/classes/Task.html diff --git a/docs/assets/css/external-small.png b/docs/assets/css/external-small.png old mode 100644 new mode 100755 diff --git a/docs/assets/css/logo.png b/docs/assets/css/logo.png old mode 100644 new mode 100755 diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css old mode 100644 new mode 100755 diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico old mode 100644 new mode 100755 diff --git a/docs/assets/img/spinner.gif b/docs/assets/img/spinner.gif old mode 100644 new mode 100755 diff --git a/docs/assets/index.html b/docs/assets/index.html old mode 100644 new mode 100755 diff --git a/docs/assets/js/api-filter.js b/docs/assets/js/api-filter.js old mode 100644 new mode 100755 diff --git a/docs/assets/js/api-list.js b/docs/assets/js/api-list.js old mode 100644 new mode 100755 diff --git a/docs/assets/js/api-search.js b/docs/assets/js/api-search.js old mode 100644 new mode 100755 diff --git a/docs/assets/js/apidocs.js b/docs/assets/js/apidocs.js old mode 100644 new mode 100755 diff --git a/docs/assets/js/yui-prettify.js b/docs/assets/js/yui-prettify.js old mode 100644 new mode 100755 diff --git a/docs/assets/vendor/prettify/CHANGES.html b/docs/assets/vendor/prettify/CHANGES.html old mode 100644 new mode 100755 diff --git a/docs/assets/vendor/prettify/COPYING b/docs/assets/vendor/prettify/COPYING old mode 100644 new mode 100755 diff --git a/docs/assets/vendor/prettify/README.html b/docs/assets/vendor/prettify/README.html old mode 100644 new mode 100755 diff --git a/docs/assets/vendor/prettify/prettify-min.css b/docs/assets/vendor/prettify/prettify-min.css old mode 100644 new mode 100755 diff --git a/docs/assets/vendor/prettify/prettify-min.js b/docs/assets/vendor/prettify/prettify-min.js old mode 100644 new mode 100755 diff --git a/docs/classes/EcAesCtrAsyncWorker.html b/docs/classes/EcAesCtrAsyncWorker.html new file mode 100644 index 000000000..1e4988d51 --- /dev/null +++ b/docs/classes/EcAesCtrAsyncWorker.html @@ -0,0 +1,1123 @@ + + + + + EcAesCtrAsyncWorker - CASS Javascript Library + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

EcAesCtrAsyncWorker Class

+
+ + +
+ Defined in: src/main/js/cass/ec.crypto.js:7491 +
+ + Module: com.eduworks.ec + +
+ + +
+

Asynchronous implementation of EcAesCtr. Uses web workers and assumes 8 workers.

+ +
+ + +
+ + +
+
+

Item Index

+ +
+

Methods

+ + +
+ + + +
+ +
+

Methods

+ +
+

decrypt

+ +
+ (
    +
  • + ciphertext +
    • +
  • + secret +
    • +
  • + iv +
    • +
  • + success +
    • +
  • + failure +
    • +
) +
+ + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:7578 +

+ + + +
+ +
+

Asynchronous form of EcAesCtr.decrypt

+ +
+ +
+

Parameters:

+ +
    +
  • + ciphertext + String + + +
    +

    Text to decrypt.

    + +
    + +
    • +
  • + secret + String + + +
    +

    Secret to use to decrypt.

    + +
    + +
    • +
  • + iv + String + + +
    +

    Initialization Vector to use to decrypt.

    + +
    + +
    • +
  • + success + Function(string) + + +
    +

    Success method, result is Plaintext +with no encoding.

    + +
    + +
    • +
  • + failure + Function(string) + + +
    +

    Failure method, parameter is error +message.

    + +
    + +
    • +
+
+ + + +
+
+

encrypt

+ +
+ (
    +
  • + plaintext +
    • +
  • + secret +
    • +
  • + iv +
    • +
  • + success +
    • +
  • + failure +
    • +
) +
+ + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:7547 +

+ + + +
+ +
+

Asynchronous form of EcAesCtr.encrypt

+ +
+ +
+

Parameters:

+ +
    +
  • + plaintext + String + + +
    +

    Text to encrypt.

    + +
    + +
    • +
  • + secret + String + + +
    +

    Secret to use to encrypt.

    + +
    + +
    • +
  • + iv + String + + +
    +

    Initialization Vector to use to encrypt.

    + +
    + +
    • +
  • + success + Function(string) + + +
    +

    Success method, result is Base64 +encoded Ciphertext.

    + +
    + +
    • +
  • + failure + Function(string) + + +
    +

    Failure method, parameter is error +message.

    + +
    + +
    • +
+
+ + + +
+
+ + + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/EcCrypto.html b/docs/classes/EcCrypto.html new file mode 100644 index 000000000..30a00c95f --- /dev/null +++ b/docs/classes/EcCrypto.html @@ -0,0 +1,1070 @@ + + + + + EcCrypto - CASS Javascript Library + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

EcCrypto Class

+
+ + +
+ Defined in: src/main/js/cass/ec.crypto.js:20 +
+ + Module: com.eduworks.ec + +
+ + +
+ +
+ + +
+ + +
+
+

Item Index

+ +
+

Methods

+ +
    +
  • + md5 + + static +
    • +
  • + sha256 + + static +
    • +
+
+ +
+

Properties

+ + +
+ + +
+ +
+

Methods

+ +
+

md5

+ +
+ (
    +
  • + s +
    • +
) +
+ + + String + + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:33 +

+ + + +
+ +
+

Calculate MD5 hash of a string.

+ +
+ +
+

Parameters:

+ +
    +
  • + s + String + + +
    +

    String to MD5

    + +
    + +
    • +
+
+ +
+

Returns:

+ +
+ String: +

MD5 hash

+ +
+
+ + +
+
+

sha256

+ +
+ (
    +
  • + s +
    • +
) +
+ + + String + + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:45 +

+ + + +
+ +
+

Calculate SHA-256 hash of a string.

+ +
+ +
+

Parameters:

+ +
    +
  • + s + String + + +
    +

    String to SHA-256

    + +
    + +
    • +
+
+ +
+

Returns:

+ +
+ String: +

SHA-256 hash

+ +
+
+ + +
+
+ +
+

Properties

+ +
+

caching

+ Boolean + + + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:26 +

+ + +
+ +
+

Turn on (defualt off) caching of decrypted data.

+ +
+ + + +
+
+ + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/EcFrameworkGraph.html b/docs/classes/EcFrameworkGraph.html new file mode 100644 index 000000000..8b31b1f15 --- /dev/null +++ b/docs/classes/EcFrameworkGraph.html @@ -0,0 +1,1056 @@ + + + + + EcFrameworkGraph - CASS Javascript Library + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

EcFrameworkGraph Class

+
+ + +
+ Defined in: src/main/js/cass/cass.rollup.js:2135 +
+ + Module: org.cassproject + +
+ + +
+

Graph for working with a framework. Additional computed data (such as profile data) can be overlaid on the graph through the use of "metaverticies" and "metaedges" that hold additional information.

+ +
+ + +
+ + +
+
+

Item Index

+ +
+

Methods

+ + +
+ + + +
+ +
+

Methods

+ +
+

addFramework

+ +
+ (
    +
  • + framework +
    • +
  • + repo +
    • +
  • + success +
    • +
  • + failure +
    • +
) +
+ + + + + + + + +
+

+ Defined in + src/main/js/cass/cass.rollup.js:2161 +

+ + + +
+ +
+

Adds a framework to the graph, and creates the edges to connect the competencies in the framework.

+ +
+ +
+

Parameters:

+ +
    +
  • + framework + EcFramework + + +
    +

    Framework to add to the graph.

    + +
    + +
    • +
  • + repo + EcRepository + + +
    +

    Repository to fetch data from that exists in the framework.

    + +
    + +
    • +
  • + success + Function() + + +
    +

    Method to invoke when done adding the framework.

    + +
    + +
    • +
  • + failure + Function(error) + + +
    +

    Method to invoke when things go badly.

    + +
    + +
    • +
+
+ + + +
+
+

getMetaStateCompetency

+ +
+ (
    +
  • + c +
    • +
) +
+ + + + + + + + + + + +
+

+ Defined in + src/main/js/cass/cass.rollup.js:2292 +

+ + + +
+ +
+

Fetches the Meta Competency (additional state information used to compute profiles or other data) for a competency.

+ +
+ +
+

Parameters:

+ +
    +
  • + c + EcCompetency + + +
    +

    Competency to fetch meta state for.

    + +
    + +
    • +
+
+ +
+

Returns:

+ +
+

Meta state (empty object by default)

+ +
+
+ + +
+
+ + + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/EcRsaOaepAsyncWorker.html b/docs/classes/EcRsaOaepAsyncWorker.html new file mode 100644 index 000000000..cf9fe05a5 --- /dev/null +++ b/docs/classes/EcRsaOaepAsyncWorker.html @@ -0,0 +1,1421 @@ + + + + + EcRsaOaepAsyncWorker - CASS Javascript Library + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

EcRsaOaepAsyncWorker Class

+
+ + +
+ Defined in: src/main/js/cass/ec.crypto.js:7272 +
+ + Module: com.eduworks.ec + +
+ + +
+

Asynchronous implementation of EcRsaOaep. Uses web workers and assumes 8 workers.

+ +
+ + +
+ + +
+
+

Item Index

+ +
+

Methods

+ + +
+ + + +
+ +
+

Methods

+ +
+

decrypt

+ +
+ (
    +
  • + ppk +
    • +
  • + ciphertext +
    • +
  • + success +
    • +
  • + failure +
    • +
) +
+ + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:7357 +

+ + + +
+ +
+

Asynchronous form of EcRsaOaep.decrypt

+ +
+ +
+

Parameters:

+ +
    +
  • + ppk + EcPpk + + +
    +

    Public private keypair to use to decrypt.

    + +
    + +
    • +
  • + ciphertext + String + + +
    +

    Ciphertext to decrypt.

    + +
    + +
    • +
  • + success + Function(string) + + +
    +

    Success method, result is unencoded +plaintext.

    + +
    + +
    • +
  • + failure + Function(string) + + +
    +

    Failure method, parameter is error +message.

    + +
    + +
    • +
+
+ + + +
+
+

encrypt

+ +
+ (
    +
  • + pk +
    • +
  • + plaintext +
    • +
  • + success +
    • +
  • + failure +
    • +
) +
+ + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:7328 +

+ + + +
+ +
+

Asynchronous form of EcRsaOaep.encrypt

+ +
+ +
+

Parameters:

+ +
    +
  • + pk + EcPk + + +
    +

    Public Key to use to encrypt.

    + +
    + +
    • +
  • + plaintext + String + + +
    +

    Plaintext to encrypt.

    + +
    + +
    • +
  • + success + Function(string) + + +
    +

    Success method, result is Base64 +encoded Ciphertext.

    + +
    + +
    • +
  • + failure + Function(string) + + +
    +

    Failure method, parameter is error +message.

    + +
    + +
    • +
+
+ + + +
+
+

sign

+ +
+ (
    +
  • + ppk +
    • +
  • + text +
    • +
  • + success +
    • +
  • + failure +
    • +
) +
+ + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:7401 +

+ + + +
+ +
+

Asynchronous form of EcRsaOaep.sign

+ +
+ +
+

Parameters:

+ +
    +
  • + ppk + EcPpk + + +
    +

    Public private keypair to use to sign message.

    + +
    + +
    • +
  • + text + String + + +
    +

    Text to sign.

    + +
    + +
    • +
  • + success + Function(string) + + +
    +

    Success method, result is Base64 +encoded signature.

    + +
    + +
    • +
  • + failure + Function(string) + + +
    +

    Failure method, parameter is error +message.

    + +
    + +
    • +
+
+ + + +
+
+

signSha256

+ +
+ (
    +
  • + ppk +
    • +
  • + text +
    • +
  • + success +
    • +
  • + failure +
    • +
) +
+ + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:7430 +

+ + + +
+ +
+

Asynchronous form of EcRsaOaep.signSha256

+ +
+ +
+

Parameters:

+ +
    +
  • + ppk + EcPpk + + +
    +

    Public private keypair to use to sign message.

    + +
    + +
    • +
  • + text + String + + +
    +

    Text to sign.

    + +
    + +
    • +
  • + success + Function(string) + + +
    +

    Success method, result is Base64 +encoded signature.

    + +
    + +
    • +
  • + failure + Function(string) + + +
    +

    Failure method, parameter is error +message.

    + +
    + +
    • +
+
+ + + +
+
+

verify

+ +
+ (
    +
  • + pk +
    • +
  • + text +
    • +
  • + signature +
    • +
  • + success +
    • +
  • + failure +
    • +
) +
+ + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.crypto.js:7459 +

+ + + +
+ +
+

Asynchronous form of EcRsaOaep.verify

+ +
+ +
+

Parameters:

+ +
    +
  • + pk + EcPk + + +
    +

    Public key to use to verify message.

    + +
    + +
    • +
  • + text + String + + +
    +

    Text to use in verification.

    + +
    + +
    • +
  • + signature + String + + +
    +

    Signature to use in verification.

    + +
    + +
    • +
  • + success + Function(boolean) + + +
    +

    Success method, result is whether +signature is valid.

    + +
    + +
    • +
  • + failure + Function(string) + + +
    +

    Failure method, parameter is error +message.

    + +
    + +
    • +
+
+ + + +
+
+ + + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/Task.html b/docs/classes/Task.html new file mode 100644 index 000000000..9723458a1 --- /dev/null +++ b/docs/classes/Task.html @@ -0,0 +1,926 @@ + + + + + Task - CASS Javascript Library + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

Task Class

+
+ + +
+ Defined in: src/main/js/cass/ec.base.js:1230 +
+ + Module: com.eduworks.ec + +
+ + +
+

Class with static methods to prevent unnecessary overhead with small operations that don't prevent drawing, +but to setTimeout on methods that slow down the browser sufficiently to interfere with drawing. +Uses a framerate timer to determine between the two.

+ +
+ + +
+ + +
+
+

Item Index

+ +
+

Methods

+ + +
+ + + +
+ +
+

Methods

+ +
+

updateFrame

+ + () + + + + + + static + + + +
+

+ Defined in + src/main/js/cass/ec.base.js:1248 +

+ + + +
+ +
+

Updates the framerate timer/counter.

+ +
+ + + + +
+
+ + + +
+
+
+
+
+
+
+
+ + + + + + + + + +