diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4f54039..79c2461 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -4,18 +4,18 @@ name: CI # Controls when the workflow will run on: - # Triggers the workflow on push events but only for the main branch + # Triggers the workflow on push events but only for the master branch push: branches: - - main - #- preview + - main + #- preview # Allows you to run this workflow manually from the Actions tab workflow_dispatch: # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: - # This workflow contains jobs called "Build-main" and "Build-Preview" + # This workflow contains jobs called "Build-Main" and "Build-Preview" Build-Main: if: ${{ github.ref == 'refs/heads/main' }} uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-production.yml@main diff --git a/_config.yml b/_config.yml index 7476da3..cd99bfb 100644 --- a/_config.yml +++ b/_config.yml @@ -31,6 +31,7 @@ code_types: /code-parser/docs/core/code-types/ useVersionTree: false isDCV: true +useJSVersionV3: true baseurl: "/code-parser/docs/web" plugins: diff --git a/_data/full_tree.yml b/_data/full_tree.yml deleted file mode 100644 index 961dff4..0000000 --- a/_data/full_tree.yml +++ /dev/null @@ -1,4 +0,0 @@ -tree_file_list: - - sidelist-full-tree.html - - sidelist-programming-javascript.html - - sidelist-programming-javascript-v1.1.0.html diff --git a/_data/product_version.yml b/_data/product_version.yml deleted file mode 100644 index 3a6adaa..0000000 --- a/_data/product_version.yml +++ /dev/null @@ -1,11 +0,0 @@ -useGroupedVersion: true - -version_info_list_js: - - value: latest version(2.2.10) - - value: 2.x - child: - - 2.0.20 - - value: 1.x - child: - - 1.1.0 - - 1.0.2 \ No newline at end of file diff --git a/_includes/dcpNav.html b/_includes/dcpNav.html deleted file mode 100644 index 9d0082c..0000000 --- a/_includes/dcpNav.html +++ /dev/null @@ -1,56 +0,0 @@ - - -
-
-
-
- -
-
-
-
-
- -
Resource Base
-
-
-
-
-
- -
-
-
-
\ No newline at end of file diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html deleted file mode 100644 index 5ddeaf6..0000000 --- a/_includes/sidelist-full-tree.html +++ /dev/null @@ -1 +0,0 @@ -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming-javascript.html" -%} diff --git a/_includes/sidelist-programming-javascript-v1.1.0.html b/_includes/sidelist-programming-javascript-v1.1.0.html deleted file mode 100644 index b8c336b..0000000 --- a/_includes/sidelist-programming-javascript-v1.1.0.html +++ /dev/null @@ -1,113 +0,0 @@ -
  • - Introduction -
  • -
  • DEVELOPMENT
  • -
  • - User Guide -
  • -
  • - API Reference - -
  • -
  • - Release Notes - -
  • diff --git a/_includes/sidelist-programming-javascript.html b/_includes/sidelist-programming-javascript.html deleted file mode 100644 index 2f4942e..0000000 --- a/_includes/sidelist-programming-javascript.html +++ /dev/null @@ -1,530 +0,0 @@ -
  • - Introduction -
  • -
  • DEVELOPMENT
  • -
  • - User Guide -
  • -
  • - API Reference - -
  • -
  • - Release Notes - -
  • diff --git a/_layouts/default-layout-OLD.html b/_layouts/default-layout-OLD.html deleted file mode 100644 index 96c2b4c..0000000 --- a/_layouts/default-layout-OLD.html +++ /dev/null @@ -1,104 +0,0 @@ - - - -{%- include head.html -%} -{%- assign noTitleIndex = "" -%} -{%- if page.noTitleIndex or page.url contains 'release-notes' -%} - {%- assign noTitleIndex = "noTitleIndex" -%} -{%- endif -%} - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - - {%- include dcpNav.html -%} -
    Table of contents
    -
    -
    -
    -
    - {%- include main-page-head.html -%} -
    -
    -
    - {{ content }} -
    -
    -
    -

    This page is compatible for:

    -

    Version 1.0

    -
    -
    -

    Is this page helpful?

    - YesYes - NoNo -
    -
    - {%- if page.needAutoGenerateSidebar -%} -

    In this article:

    -
    - {%- endif -%} -
    -
    - -
    - -
    -
    -
    -
    -
    - {%- include liquid_autoGenerateHistoryList.html -%} - {%- include auto-version-list.html -%} -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - - {%- include livehelp.html -%} - - - - - - - - - - - diff --git a/_layouts/home-page.html b/_layouts/home-page.html deleted file mode 100644 index 89aa900..0000000 --- a/_layouts/home-page.html +++ /dev/null @@ -1,50 +0,0 @@ - - - -{%- include head.html -%} - - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - -
    -
    -
    - - {{ content }} -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - - - diff --git a/_layouts/search-page-OLD.html b/_layouts/search-page-OLD.html deleted file mode 100644 index 4ccecab..0000000 --- a/_layouts/search-page-OLD.html +++ /dev/null @@ -1,319 +0,0 @@ - - - -{%- include head.html -%} - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - -
    -
    -
    - -
    -
    -
    -
    - -
    Documentation
    -
    -
    -
    -
    -
    -
    -
    - -
    -
    -
    -
    -
    -
    -
    Table of contents
    -
    -
    -
    -
    -
    -
    -
    -

    Search

    - - -
    -
    -
    - -
    -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - {%- if page.needAutoGenerateSidebar -%} - {%- unless page.needGenerateH3Content -%} - - {%- else -%} - - {%- endunless -%} - {%- else -%} - - {%- endif -%} - - - - {%- include livehelp.html -%} - - - \ No newline at end of file diff --git a/assets/js/dcpWebVersionSearch.json b/assets/js/dcpWebVersionSearch.json deleted file mode 100644 index 029d8b1..0000000 --- a/assets/js/dcpWebVersionSearch.json +++ /dev/null @@ -1,109 +0,0 @@ -[ - { - "version": "2.0.20", - "matchList": { - "js":{ - "dcvRepoWeb": [ - { - "path": "/programming/javascript/api-reference/utility", - "version": "1.2.10" - }, { - "path": "/programming/javascript/api-reference/license", - "version": "3.2.10" - }, { - "path": "/programming/javascript/api-reference/capture-vision-router", - "version": "2.2.10" - }, { - "path": "/programming/javascript/api-reference/core", - "version": "3.2.10" - }, { - "path": "/programming/javascript/api-reference/image-processing", - "version": "2.2.10" - } - ], - "dcvRepoCore": [ - { - "path": "/enums/capture-vision-router", - "version": "2.2.10" - }, { - "path": "/enums/core", - "version": "3.2.10" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.10" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.10" - } - ], - "dce": "4.0.2" - } - } - }, - { - "version": "2.0.20", - "matchList": { - "js":{ - "dcvRepoWeb": [ - { - "path": "/programming/javascript/api-reference/utility", - "version": "1.0.30" - }, { - "path": "/programming/javascript/api-reference/license", - "version": "3.0.20" - }, { - "path": "/programming/javascript/api-reference/capture-vision-router", - "version": "2.0.20" - }, { - "path": "/programming/javascript/api-reference/core", - "version": "3.0.30" - }, { - "path": "/programming/javascript/api-reference/image-processing", - "version": "2.0.20" - } - ], - "dcvRepoCore": [ - { - "path": "/enums/capture-vision-router", - "version": "2.0.20" - }, { - "path": "/enums/core", - "version": "3.0.20" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.20" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.20" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.20" - } - ], - "dce": "4.0.1" - } - } - } -] - \ No newline at end of file diff --git a/programming/javascript/api-reference/code-parser-module-class-v2.0.20.md b/programming/javascript/api-reference/code-parser-module-class-v2.0.20.md deleted file mode 100644 index 42ed1a4..0000000 --- a/programming/javascript/api-reference/code-parser-module-class-v2.0.20.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: default-layout -title: CodeParserModule Class - Dynamsoft Code Parser JavaScript Edition API -description: This page introduces APIs related to the CodeParserModule Class of Dynamsoft Code Parser JavaScript Edition. -keywords: capture vision, code parser Module, api reference, javascript, js -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# CodeParserModule Class - -The `CodeParserModule` class is defined in the namespace `Dynamsoft.DCP`. - -| API Name | Description | -| ------------------------------------ | ----------------------------------------------------------- | -| `static` [getVersion()](#getversion) | Returns the version of the `CodeParser` module. | -| `static` [loadSpec()](#loadspec) | Loads the specification for a certain type of code strings. | - -### getVersion - -Returns the version of the `CodeParser` module. - -```typescript -static getVersion(): string; -``` - -**Code snippet** - -```javascript -const version = Dynamsoft.DCP.CodeParserModule.getVersion(); -console.log(version); -``` - -### loadSpec - -Loads the specification for a certain type of code strings. - -```typescript -loadSpec(specificationName: string, specificationPath?: string): Promise; -``` - -**Parameters** - -* `specificationName`: specifies the name of the specification. -* `specificationPath`: specifies the path to find the specification file. If not specified, the method will try to load the file from the path specified for the "dcp" module in `Dynamsoft.Core.CoreModule.engineResourcePaths`. For example, if the path for the "dcp" module is "https://cdn.jsdelivr.net/npm/dynamsoft-code-parser@2.0.20/dist/", then calling `Dynamsoft.DCP.CodeParserModule.loadSpec("AADHAAR")` will load the file "AADHAAR.data" from "https://cdn.jsdelivr.net/npm/dynamsoft-code-parser@2.0.20/dist/specification/AADHAAR.data". - -**Code Snippet** - -```javascript -await Dynamsoft.DCP.CodeParserModule.loadSpec("AADHAAR"); -``` diff --git a/programming/javascript/api-reference/code-parser-v2.2.10.md b/programming/javascript/api-reference/code-parser-v2.2.10.md deleted file mode 100644 index 1e90efd..0000000 --- a/programming/javascript/api-reference/code-parser-v2.2.10.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -layout: default-layout -title: CodeParser Class - Dynamsoft Code Parser SDK JS Edition API Reference -description: This page shows CodeParser Class of Dynamsoft Code Parser SDK JS Edition. -keywords: CodeParser, api reference, JS, JavaScript -needAutoGenerateSidebar: true ---- - -# CodeParser Class - -The `CodeParser` class enable users to parse given bytes or a string to be human-readable. - -| Method | Description | -| -------------------------------------------- | ---------------------------------------------------------------------- | -| `static` [createInstance()](#createinstance) | Initializes a new instance of the `CodeParser` class. | -| [dispose()](#dispose) | Releases all resources used by the `CodeParser` object. | -| [disposed](#disposed) | Returns whether the `CodeParser` object has been disposed of. | -| [initSettings](#initsettings) | Initializes runtime settings with the settings in a given JSON string. | -| [resetSettings](#resetsettings) | Resets runtime settings to default. | -| [parse](#parse) | Parses code data for readable results. | - -## createInstance - -Initializes a new instance of the `CodeParser` class. - -**Syntax** - -```typescript -createInstance(): Promise; -``` - -**Parameter** - -None. - -**Return value** - -A promise that resolves to the initialized `CodeParser` object. - -**Code snippet** - -```javascript -let parser = await Dynamsoft.DCP.CodeParser.createInstance(); -``` - -## dispose - -Releases all resources used by the `CodeParser` object. - -**Syntax** - -```typescript -dispose(): Promise; -``` - -**Parameter** - -None. - -**Return value** - -Returns a promise that resolves when the resources have been successfully released. - -**Code snippet** - -```javascript -let parser = await Dynamsoft.DCP.CodeParser.createInstance(); -// Use the parser to perform a job. -// ... -// Release the resources after the job is finished. -parser.dispose(); -``` - -## disposed - -Returns whether the `CodeParser` object has been disposed of. - -**Syntax** - -```typescript -disposed: boolean; -``` - -**Parameter** - -None. - -**Return value** - -A boolean value that indicates whether the `CodeParser` object has been disposed of. - -**Code snippet** - -```javascript -if(parser.disposed){ - console.log("The parser has been disposed of."); -} else { - // Use the parser to perform a job. -} -``` - -## initSettings - -Initializes settings from a given string. - -```typescript -initSettings: (settings: string) => Promise; -``` - -**Parameters** - -* `settings`: A JSON string that represents the content of the settings. - -**Return value** - -A promise that resolves when the operation has completed. It does not provide any value upon resolution. - -## resetSettings - -Resets all parameters to default values. - -```typescript -resetSettings: () => Promise; -``` - -**Parameters** - -None. - -**Return value** - -Returns a promise that resolves when the settings have been successfully reset to their default values. - -## parse - -Parses a single string to be human-readable. - -```typescript -parse: (source: Uint8Array | string, taskSettingName?: string) => Promise; -``` - -**Parameters** - -* `source`: the array of bytes or the string to parse. - -* `taskSettingName`: the name of [CodeParserTaskSetting](https://www.dynamsoft.com/capture-vision/docs/core/parameters/reference/code-parser-task-settings/) that defines the settings used for code parsing. - -**Return Value** - -Returns an array of [ParsedResultItem](./interfaces/parsed-result-item.md) containing the human-readable results. diff --git a/programming/javascript/api-reference/enum/index-v1.1.0.md b/programming/javascript/api-reference/enum/index-v1.1.0.md deleted file mode 100644 index 8ee320e..0000000 --- a/programming/javascript/api-reference/enum/index-v1.1.0.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default-layout -title: Enum Index - Dynamsoft Code Parser JavaScript 1.x API -description: This page shows the Enums of Dynamsoft Code Parser JavaScript SDK version 1.x. -keywords: enums, api reference, javascript, js -needAutoGenerateSidebar: false -noTitleIndex: true -breadcrumbText: Enum Index ---- - -# Enums - -Dynamsoft Code Parser JavaScript SDK v1.x has the following enums. - -* [EnumCodeFormat](enumcodeformat.html) -* [EnumErrorCode](enumerrorcode.html) -* [EnumResultInfoType](enumresultinfotype.html) diff --git a/programming/javascript/api-reference/index-v1.1.0.md b/programming/javascript/api-reference/index-v1.1.0.md deleted file mode 100644 index 4203258..0000000 --- a/programming/javascript/api-reference/index-v1.1.0.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -layout: default-layout -title: Entry Page - Dynamsoft Code Parser JavaScript API version 1.x. -description: This is the main page of Dynamsoft Code Parser JavaScript SDK version 2.x API Reference. -keywords: CodeParser, api reference, javascript, js -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -breadcrumbText: API Reference ---- - -# JavaScript API Reference - -The Dynamsoft Code Parser JavaScript library comes with one primary class: `CodeParser`. - -## CodeParser - -A CodeParser takes code data in forms of byte array or plain string as input and returns parsed results. The following code snippet shows its basic usage: - -```js -let parser = await Dynamsoft.DCP.CodeParser.createInstance(); -parser.setCodeFormat(enumcodeformat); -let result = await parser.parseData(code); -console.log(result); -``` - -The APIs for this class include: - -### Initialize License - -| API Name | Description | -|---|---| -| [license](./licenseControl.html#license) | Initializes license of DCP. | - -### Initialize Engine - -| API Name | Description | -|---|---| -| [engineResourcePath](./initializeEngine.html#engineresourcepath) | Specifies the path of WASM engine. | -| [loadWasm()](./initializeEngine.html#loadwasm) | Loads and compiles the WASM. | - -### Create and Destroy - -| API Name | Description | -|---|---| -| [createInstance()](./codeParser.html#createinstance) | Creates a `CodeParser` instance. | -| [destroyContext()](./codeParser.html#destroycontext) | Destroys the `CodeParser` instance in WASM. | - -### Set Code Format - -| API Name | Description | -|---|---| -| [setCodeFormat()](./codeParser.html#setcodeformat) | Sets input code's format. | - -### Parse Code Data - -| API Name | Description | -|---|---| -| [parseData()](./codeParser.html#parsedata) | Parses code data for readable results. | - - - -## Interfaces and Enums - -In order to make the code more predictable and readable, the library defines a series of supporting interfaces and enumerations: - -### Interfaces - -* [CodeParserException](./interfaces/CodeParserException.html) -* [BasicPersonalInfo](./interfaces/BasicPersonalInfo.html) -* [ParseResult](./interfaces/ParseResult.html) - -### Enums - -* [EnumErrorCode](./enum/EnumErrorCode.html) -* [EnumCodeFormat](./enum/EnumCodeFormat.html) -* [EnumResultInfoType](./enum/EnumResultInfoType.html) diff --git a/programming/javascript/api-reference/interfaces/parsed-result-item-v2.4.2000.md b/programming/javascript/api-reference/interfaces/parsed-result-item-v2.4.2000.md deleted file mode 100644 index 4f1933c..0000000 --- a/programming/javascript/api-reference/interfaces/parsed-result-item-v2.4.2000.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default-layout -title: ParsedResultItem - Dynamsoft Code Parser JavaScript Interface -description: This page shows the ParsedResultItem interface of Dynamsoft Code Parser for JavaScript. -keywords: ParsedResultItem, javascript, interface -needAutoGenerateSidebar: false -noTitleIndex: true -breadcrumbText: ParsedResultItem ---- - -# ParsedResultItem - -The ParsedResultItem interface provides a structure representing the result items returned by Dynamsoft Code Parser. - -```ts -interface ParsedResultItem extends Core.CapturedResultItem { - codeType: string; - jsonString: string; - getFieldValue: (fieldName: string) => string; - getFieldMappingStatus: (fieldName: string) => EnumMappingStatus; - getFieldValidationStatus: (fieldName: string) => EnumValidationStatus; -} -``` - - - -## codeType - -Returns the code type of the parsed result. - -```ts -codeType: string; -``` - -## jsonString - -Returns the parsed result as a JSON formatted string. - -```ts -jsonString: string; -``` - -## getFieldValue - -Gets the value of a specified field from the parsed result. - -```ts -getFieldValue(fieldName: string): string; -``` - -**Parameters** - -`fieldName`: specifies the name of the field. - -**Return Value** - -A string which contains the field value. - -**Code Snippet** - -```js -parser.getFieldValue("passportNumber"); -``` - -## getFieldMappingStatus - -Gets the mapping status of a specified field from the parsed result. - -```ts -getFieldMappingStatus: (fieldName: string) => EnumMappingStatus; -``` - -**Parameters** - -`fieldName`: specifies the name of the field. - -**Return Value** - -A value that indicates whether the mapping succeeded. - -**Code Snippet** - -```js -await parser.getFieldMappingStatus("nationality"); -``` - -**See Also** - -* [EnumMappingStatus](../enum/EnumMappingStatus.md) - -## getFieldValidationStatus - -Gets the validation status of a specified field from the parsed result. - -```ts -getFieldValidationStatus: (fieldName: string) => EnumValidationStatus; -``` - -**Parameters** - -`fieldName`: specifies the name of the field. - -**Return Value** - -A value that indicates whether the validation succeeded. - -**Code Snippet** - -```js -await parser.getFieldValidationStatus("passportNumber"); -``` - -**See Also** - -* [EnumValidationStatus](../enum/EnumValidationStatus.md) diff --git a/programming/javascript/api-reference/interfaces/parsed-result-v2.6.1000.md b/programming/javascript/api-reference/interfaces/parsed-result-v2.6.1000.md deleted file mode 100644 index d20da7f..0000000 --- a/programming/javascript/api-reference/interfaces/parsed-result-v2.6.1000.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -layout: default-layout -title: ParsedResult - Dynamsoft Code Parser JavaScript Interface -description: This page shows the ParsedResult interface of Dynamsoft Code Parser for JavaScript. -keywords: ParsedResult, javascript, interface -needAutoGenerateSidebar: false -noTitleIndex: true -breadcrumbText: ParsedResult ---- - -# ParsedResult - -The ParsedResult interface provides a structure representing the result object returned by Dynamsoft Code Parser. - -```ts -interface ParsedResult { - originalImageHashId: string; - originalImageTag: Core.ImageTag; - parsedResultItems: Array; - hasItem: (item: ParsedResultItem) => boolean; - removeItem: (item: ParsedResultItem) => void; - errorCode: number; - errorString: string; -} -``` - - - -## originalImageHashId - -Returns the hash id of the original image. - -```ts -originalImageHashId: string; -``` - -## originalImageTag - -Returns the tag of the original image. - -```ts -originalImageTag: Core.ImageTag; -``` - -**See Also** - -* [ImageTag](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/image-tag.html) - -## parsedResultItems - -Returns an array that contains all `ParsedResultItem`s. - -## hasItem() - -Checks whether the specified `ParsedResultItem` exists. - -## removeItem() - -Removes the specified `ParsedResultItem`. - -## errorCode - -Returns the error code for the parsing operation. - -## errorString - -Returns the error string that corresponds with `errorCode`.