diff --git a/doc/001-getting-started.md b/doc/001-getting-started.md index fc2382f..62e1338 100644 --- a/doc/001-getting-started.md +++ b/doc/001-getting-started.md @@ -24,7 +24,7 @@ Finally, we recommend cloning the [Hypersync SDK Samples GitHub repository](http - The samples repository contains several complete Hypersync apps that can be used to bring data from an external service into Hyperproof. Using the Hypersync SDK you can customize these samples to meet your needs. The hypersync-sdk-samples repository contains samples for MySQL, Zoho and other services. You will find these Hypersync apps in the `/apps` directory. -- The samples repository also includes a handful of templates to get you started building your own Hypersyncs from scatch. Templates can be found in the `/templates` directory. See the `README.md` files in each template directory for more information on using the templates. +- The samples repository also includes a handful of templates to get you started building your own Hypersyncs from scratch. Templates can be found in the `/templates` directory. See the `README.md` files in each template directory for more information on using the templates. ## Sandbox Organization (optional) diff --git a/doc/005-data-sources.md b/doc/005-data-sources.md index e5ecf4e..fdc93c3 100644 --- a/doc/005-data-sources.md +++ b/doc/005-data-sources.md @@ -66,7 +66,7 @@ For more information on configuring the data sets in your data source using `dat Many REST APIs use a paging mechanism to allow data to be retrieved in chunks. For example, some APIs take a `pageSize` and `pageNumber` argument which specify how many items to return, and the page number to start reading from, respectively. -Four paging styles are supported: **Page Based**, **Offset And Limit**, **Next Token**, and **GraphQL Connections**. As a default, query string parameters will be programatically added to an API url. If POST is designated as the data source HTTP method, paging parameters are added to the body of the request. +Four paging styles are supported: **Page Based**, **Offset And Limit**, **Next Token**, and **GraphQL Connections**. As a default, query string parameters will be programmatically added to an API url. If POST is designated as the data source HTTP method, paging parameters are added to the body of the request. 1. **Page Based.** Begin paging at a starting value and increment the page value by 1 after each iteration (1, 2, 3, etc). Return at most `limitValue` items per page. diff --git a/doc/006-proof-types.md b/doc/006-proof-types.md index 67669e2..0d5cc8a 100644 --- a/doc/006-proof-types.md +++ b/doc/006-proof-types.md @@ -8,7 +8,7 @@ Hypersync apps expose the data in an external service in the form of proof types Each one of these proof types selects the appropriate data from the external service and formats it as appropriate for the type of data. Data can be formatted in tabular, stacked and hierarchical layouts. -Once the user selects a proof type, they may be asked for one or more criteria values. The Group Membership proof type, for example, will likely reuqire that the user specify the name of the group that they are interested in. This information is then used to filter the group membership data. The metadata for these criteria values (e.g. whether the group name is shown as a select control or a text field) comes from the [criteria provider](./007-criteria.md). +Once the user selects a proof type, they may be asked for one or more criteria values. The Group Membership proof type, for example, will likely require that the user specify the name of the group that they are interested in. This information is then used to filter the group membership data. The metadata for these criteria values (e.g. whether the group name is shown as a select control or a text field) comes from the [criteria provider](./007-criteria.md). Proof types retrieve data from the app's [data source](./005-data-sources.md) by name. The proof type may also provide parameter values to the data source to ensure that the right data is returned. @@ -28,11 +28,11 @@ Proof types retrieve data from the app's [data source](./005-data-sources.md) by A proof type may format the data in the following ways: -| Layout | Description | -| ------------ | ---------------------------------------------------------------------------------------------------------------- | -| Tabular | Data is arranged in a table where each row is an item in the data set. | -| Stacked | Fields in an item are arranged verticially, and that vertical stack is repeated for every row in the result set. | -| Hierarchical | A combination of tabular and/or stacked layouts where some layouts are nested. | +| Layout | Description | +| ------------ | --------------------------------------------------------------------------------------------------------------- | +| Tabular | Data is arranged in a table where each row is an item in the data set. | +| Stacked | Fields in an item are arranged vertically, and that vertical stack is repeated for every row in the result set. | +| Hierarchical | A combination of tabular and/or stacked layouts where some layouts are nested. | Tabular and stacked layouts can be output as PDF or Excel files. Hierarchical layouts can only be output as PDF. diff --git a/doc/007-criteria.md b/doc/007-criteria.md index 5186c20..3bbf9a1 100644 --- a/doc/007-criteria.md +++ b/doc/007-criteria.md @@ -50,7 +50,7 @@ The `ICriteriaProvider` interface has three methods: `generateProofCategoryField `generateProofCategoryField` returns a proof category criteria field that can be used to filter proof types by category. For apps with a small number of proof types where a category is not required, this method should return `null`. -`generateCriteriaFields` is invoked as the user is creating or editing a Hypersync. This method returns criteria metadata to Hyperproof in the form of an `ICriteraMetadata` object. This object contains the fields that the user needs to configure for the proof type, as well as some default values for the Hypersync name, frequency of execution, and versioning benavior. As mentioned above this method is called iteratively as the user configures the Hypersync. +`generateCriteriaFields` is invoked as the user is creating or editing a Hypersync. This method returns criteria metadata to Hyperproof in the form of an `ICriteriaMetadata` object. This object contains the fields that the user needs to configure for the proof type, as well as some default values for the Hypersync name, frequency of execution, and versioning behavior. As mentioned above this method is called iteratively as the user configures the Hypersync. `generateProofCriteria` is called at sync time. This method is responsible for formatting the configured criteria so that they can be included in a the generated proof. `generateProofCriteria` will generally apply transforms and perform lookups in order to properly format the criteria. diff --git a/doc/008-debugging.md b/doc/008-debugging.md index 01a51dd..dd81e36 100644 --- a/doc/008-debugging.md +++ b/doc/008-debugging.md @@ -43,6 +43,6 @@ To exit the `logs` command, press escape or Ctrl-C. ## Browser Network Tab -All supported browsers have a Developer Tools feature that can also be helpful when diagnoting problems with your app. +All supported browsers have a Developer Tools feature that can also be helpful when diagnosing problems with your app. -When you encounter an unexpectd problem using your app, open the Developer Tools and navigate to the Network tab. Once you've done that, repeat the operation and look for network calls that are flagged as errors (shown in red in Google Chrome for example). You can inspect the response bodies of these requests to learn more about what failed. +When you encounter an unexpected problem using your app, open the Developer Tools and navigate to the Network tab. Once you've done that, repeat the operation and look for network calls that are flagged as errors (shown in red in Google Chrome for example). You can inspect the response bodies of these requests to learn more about what failed. diff --git a/doc/052-data-source-json.md b/doc/052-data-source-json.md index c160917..bcac663 100644 --- a/doc/052-data-source-json.md +++ b/doc/052-data-source-json.md @@ -2,7 +2,7 @@ For Hypersync apps that retrieve data from a REST data source, the [RestDataSourceBase](./005-data-sources.md) class makes it possible to extract, transform and sort multiple data sets without writing code. The `/json/dataSource.json` file is used to define these datasets. -At the top level, a `dataSource.json` file should expose an oject with three properties: `baseUrl`, `dataSets` and `messages`. Note that only `dataSets` is required--`baseUrl` and `messages` are both optional. +At the top level, a `dataSource.json` file should expose an object with three properties: `baseUrl`, `dataSets` and `messages`. Note that only `dataSets` is required--`baseUrl` and `messages` are both optional. ## baseUrl diff --git a/doc/055-proof-type-json.md b/doc/055-proof-type-json.md index 5d46b70..2b4bf97 100644 --- a/doc/055-proof-type-json.md +++ b/doc/055-proof-type-json.md @@ -7,7 +7,7 @@ Each proof type file exposes a JSON object with these properties: | Property | Required | Description | | ----------- | -------- | ---------------------------------------------------------------------- | | description | Yes | Description of the proof type | -| criteria | Yes | Array of criteria fields that are requried by the proof type | +| criteria | Yes | Array of criteria fields that are required by the proof type | | proofSpec | Yes | Object that specifies how the proof type should be rendered | | overrides | No | Proof specs which override the base proof spec based on some condition | diff --git a/doc/hyperproof-cli.md b/doc/hyperproof-cli.md index 6a07f4d..5fba5e2 100644 --- a/doc/hyperproof-cli.md +++ b/doc/hyperproof-cli.md @@ -23,17 +23,17 @@ The Hyperproof CLI has been tested on the following Linux distributions. | ------------ | --------------------------------------------------------------------------- | | Ubuntu | 18.04 LTS (Bionic Beaver), 20.04 LTS (Focal Fossa), 22.04 (Jammy Jellyfish) | -It may also be installed on other Debian distributions but the Hyperprof CLI has not been tested on these platforms. +It may also be installed on other Debian distributions but the Hyperproof CLI has not been tested on these platforms. Once you have installed the [.Net Runtime 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0), the CLI can be installed by downloading a `.deb` package from the Hyperproof web site. Click the link below to download the latest version of the Hyperproof CLI. -- [Download HP CLI `.deb` for Debian Linux Distributions](https://downloads.hyperproof.app/hpcli/hpcli_1.2.4-1_amd64.deb) +- [Download HP CLI `.deb` for Debian Linux Distributions](https://downloads.hyperproof.app/hpcli/hpcli_1.2.6-1_amd64.deb) The `.deb` package installs the HP CLI under `/usr/bin`. ### Install on Windows -For Windows, the Hyperproof CLI is intalled using an installation executable that can be downloaded from the Hyperproof web site. +For Windows, the Hyperproof CLI is installed using an installation executable that can be downloaded from the Hyperproof web site. The Hyperproof CLI has been tested on the following Windows versions. @@ -44,7 +44,7 @@ The Hyperproof CLI has been tested on the following Windows versions. Once you have installed the [.Net Runtime 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0), click the link below to download and run the HP CLI Windows installer. -- [Download HP CLI Windows Installer](https://downloads.hyperproof.app/hpcli/hpcli-1.2.4.exe) +- [Download HP CLI Windows Installer](https://downloads.hyperproof.app/hpcli/hpcli-1.2.6.exe) The Hyperproof CLI will be installed under `C:\Program Files\Hyperproof CLI` unless you choose a different installation location. The installation directory should be added to your path. diff --git a/package.json b/package.json index 4432e19..1e64642 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@hyperproof/hypersync-sdk", - "version": "6.0.0", + "version": "6.0.1", "description": "Hypersync SDK", "license": "MIT", "repository": {