{"id":38215436,"url":"https://github.com/prowriting/prowritingaid.typescript","last_synced_at":"2026-01-17T00:47:00.471Z","repository":{"id":57330738,"uuid":"97024031","full_name":"prowriting/prowritingaid.typescript","owner":"prowriting","description":"Official Typescript SDK. Grammar checking API for Typescript. Also includes: style improvements, terminology checking, and plagiarism checking API.","archived":false,"fork":false,"pushed_at":"2021-05-06T13:17:19.000Z","size":98,"stargazers_count":9,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-06T12:50:31.749Z","etag":null,"topics":["api","grammar","prowriting","prowritingaid","sdk","style","typescript","writing"],"latest_commit_sha":null,"homepage":"https://prowritingaid.com/en/App/Api","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prowriting.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-12T15:31:41.000Z","updated_at":"2024-03-11T07:22:47.000Z","dependencies_parsed_at":"2022-09-21T05:05:05.799Z","dependency_job_id":null,"html_url":"https://github.com/prowriting/prowritingaid.typescript","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/prowriting/prowritingaid.typescript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prowriting%2Fprowritingaid.typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prowriting%2Fprowritingaid.typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prowriting%2Fprowritingaid.typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prowriting%2Fprowritingaid.typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prowriting","download_url":"https://codeload.github.com/prowriting/prowritingaid.typescript/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prowriting%2Fprowritingaid.typescript/sbom","scorecard":{"id":747441,"data":{"date":"2025-08-11","repo":{"name":"github.com/prowriting/prowritingaid.typescript","commit":"d1dd538ab1f2d33af8e84ca8b34f5704aa17be9f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Code-Review","score":0,"reason":"Found 0/6 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-22T19:14:45.260Z","repository_id":57330738,"created_at":"2025-08-22T19:14:45.260Z","updated_at":"2025-08-22T19:14:45.260Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28490563,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T23:55:29.509Z","status":"ssl_error","status_checked_at":"2026-01-16T23:55:29.108Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","grammar","prowriting","prowritingaid","sdk","style","typescript","writing"],"created_at":"2026-01-17T00:47:00.393Z","updated_at":"2026-01-17T00:47:00.464Z","avatar_url":"https://github.com/prowriting.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ProWritingAid.API\n\nOfficial typescript [prowritingaid.com](https://prowritingaid.com) API. \n\n- API version: v2\n- Package version: v2.0.0\n\nFor more information, please visit [https://prowritingaid.com/en/App/API#ts](https://prowritingaid.com/en/App/API#ts)\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nInstall package using command:\n\n```shell\nnpm install pro_writing_aid_ts --save\n```\n\n#### git\n#\nOr install package from the git repo:\n\n```shell\n    npm install prowriting/prowritingaid.typescript --save\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following TS code:\n\n```typescript\nimport PWA = require('pro_writing_aid_ts');\n\nlet api = new PWA.HtmlApi();\napi.setApiKey(PWA.ApiKeys.licenseCode, '$Your license code$');\n\nlet request = new PWA.HtmlAnalysisRequest();\nrequest.Html = 'I\\'d like to by that toy. wood you help me? I have twp more brothers.';\nrequest.Reports = ['grammar'];\nrequest.Language = PWA.LanguageEnum.En;\nrequest.Style = PWA.StyleEnum.General;\n\napi.post(request)\n    .then(function (data) {\n        console.log('API called successfully. Returned data: ');\n        console.log(data.Body);\n    }, function (error) {\n        console.error(error);\n    })\n/* Example of what you will get\nAPI called successfully. Returned data: \n{ Html: 'I\\'d like to \u003cspan class=\\'pwa pwa1 pwa-color pwa-blue\\' title=\\'Possible confused word\\' data-report=\\'grammar\\' data-suggestions=\\'buy\\' data-index=\\'0\\' data-category=\\'grammargrammar\\' data-sub-category=\\'by\\' data-urls=\\'\\' data-help=\\'CTF_BY_13_.9990\\' data-original-text=\\'by\\' data-tag-id=\\'cad77c6f-9553-4b4c-87a6-44cd7bd2c740\\'\u003eby\u003c/span\u003e that toy. wood you help me? I have \u003cspan class=\\'pwa pwa1 pwa-color pwa-blue\\' title=\\'Possible confused word\\' data-report=\\'grammar\\' data-suggestions=\\'two\\' data-index=\\'1\\' data-category=\\'grammargrammar\\' data-sub-category=\\'twp\\' data-urls=\\'\\' data-help=\\'CTF_TWP_11_.9998\\' data-original-text=\\'twp\\' data-tag-id=\\'1de06ac4-bd40-4429-accd-e82406eb525e\\'\u003etwp\u003c/span\u003e more brothers.',\n  WordCount: 16,\n  Summaries: \n   [ { ReportDisplayName: 'Grammar Check',\n       ReportName: 'grammar',\n       SummaryItems: [Object],\n       NumberOfIssues: 2,\n       ReportDescription: 'Checks your text for grammar errors and potential word mis-use.' } ] }\n */\n```\n\n## Documentation for API Classes\n\nAll URIs are relative to *https://api.prowritingaid.com*\n\nClass | Method | Description\n------------ | ------------- | ------------- \n*ContextualThesaurusApi* | [**Post**](docs/ContextualThesaurusApi.md#Post) |  \n*HtmlApi* | [**Post**](docs/HtmlApi.md#Post) |  \n*SummaryApi* | [**Post**](docs/SummaryApi.md#Post) |  \n*TextApi* | [**Post**](docs/TextApi.md#Post) |  \n*WordCloudApi* | [**Post**](docs/WordCloudApi.md#Post) |  \n\n\n## Documentation for Models\n\n - [AnalysisSettings](docs/AnalysisSettings.md)\n - [AnalysisSummary](docs/AnalysisSummary.md)\n - [AnalysisSummaryGraph](docs/AnalysisSummaryGraph.md)\n - [AnalysisSummaryGraphItem](docs/AnalysisSummaryGraphItem.md)\n - [AnalysisSummaryItem](docs/AnalysisSummaryItem.md)\n - [AnalysisSummarySubItem](docs/AnalysisSummarySubItem.md)\n - [ContextualThesaurusRequest](docs/ContextualThesaurusRequest.md)\n - [ContextualThesaurusResponse](docs/ContextualThesaurusResponse.md)\n - [DocTag](docs/DocTag.md)\n - [HtmlAnalysisRequest](docs/HtmlAnalysisRequest.md)\n - [HtmlAnalysisResponse](docs/HtmlAnalysisResponse.md)\n - [HttpResponse](docs/HttpResponse.md)\n - [SuggestionCategory](docs/SuggestionCategory.md)\n - [SummaryAnalysisRequest](docs/SummaryAnalysisRequest.md)\n - [SummaryAnalysisResponse](docs/SummaryAnalysisResponse.md)\n - [TextAnalysisRequest](docs/TextAnalysisRequest.md)\n - [TextAnalysisResponse](docs/TextAnalysisResponse.md)\n - [WordCloudRequest](docs/WordCloudRequest.md)\n - [WordCloudResponse](docs/WordCloudResponse.md)\n\n\n## Documentation for Authorization\n\n### licenseCode\n\n- **Type**: API key\n- **API key parameter name**: licenseCode\n- **Location**: HTTP header\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprowriting%2Fprowritingaid.typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprowriting%2Fprowritingaid.typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprowriting%2Fprowritingaid.typescript/lists"}