{"_id":"@9wick/shodo","_rev":"1-ab42e7a38158c1f0eea2ac2e57ccf634","name":"@9wick/shodo","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@9wick/shodo","version":"0.1.0","description":"","main":"dist/index.js","scripts":{"build":"rm -rf ./dist && tsc","version":"npm run build","lint-fix":"eslint --fix './src/**/*.{js,ts}' && prettier --write './src/**/*.{js,ts}'"},"repository":{"type":"git","url":"git+ssh://git@github.com/9wick/shodo-js.git"},"keywords":["shodo","textlint","lint","japanese"],"author":{"name":"kido","email":"kido@9wick.com","url":"https://github.com/9wick"},"license":"MIT","dependencies":{"cli-color":"^2.0.3","node-fetch-commonjs":"^3.2.4"},"devDependencies":{"@tsconfig/strictest":"^1.0.2","@types/cli-color":"^2.0.2","@typescript-eslint/eslint-plugin":"^5.38.1","@typescript-eslint/parser":"^5.38.1","eslint":"^8.22.0","eslint-config-prettier":"^8.5.0","eslint-config-standard-with-typescript":"^23.0.0","eslint-plugin-import":"^2.26.0","eslint-plugin-n":"^15.3.0","eslint-plugin-promise":"^6.0.1","prettier":"^2.7.1","ts-node":"^10.9.1","typescript":"^4.8.4","utility-types":"^3.10.0"},"bugs":{"url":"https://github.com/9wick/shodo-js/issues"},"homepage":"https://github.com/9wick/shodo-js#readme","types":"./dist/index.d.ts","gitHead":"8fef4d0ab466b1c002cb642d9839991ce80d4e38","_id":"@9wick/shodo@0.1.0","_nodeVersion":"16.15.1","_npmVersion":"8.11.0","dist":{"integrity":"sha512-vhnVtwWHMhtzhDDGjUKKP0QWo0q608Xz9fZaBCnCpwUdssSykMPMlkR2iT6MJfQSHZ/M4Mrz070Ngrcm1xnB8g==","shasum":"69c5b7920274d792318a1b6816fff87cbb741ef3","tarball":"https://registry.npmjs.org/@9wick/shodo/-/shodo-0.1.0.tgz","fileCount":17,"unpackedSize":26204,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBKSC0AFyKj/g04YvSqIBhm/x99mLUq3iM47lEe4hoX8AiBZA7fQE4hNPHhcBLz8+hVKslmVQhWg8J1yl03k1cgJ2g=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjOPHDACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpzgQ//ct+pJ1zxT2T/MIYK09QBI0rO0LzoINXAjAZRKIzsfnfVLQt8\r\np7y1R0uhv4NjbMNQ9Pe+Bt8/zl6Ubqd3t5TrX5wnI3VAg0B8h18I8WFv8kuq\r\nCt8HzJhQqgZaFoYeJj9KNZG1jEoTlI7WrX8FqQ8ZOzBJV34jK5apsEea5GoN\r\ne291Cgnj55Fy0xVv+dwh26CHa8R/QqVoH4CjyMYp6Fg4iZjO1uuYOYkdj9o3\r\nq/2uCwbzmdbg/0DFLVGe+2Exi7xSBu7/7EAR6La01PXgl6zlOB7lE0UxQl8s\r\nlgdvZvOX1fb0LCT4oTdAjz2vTG7v4oYlu+lgbD61408eCv9zS3KDpKUbM4gj\r\nee0mNMK7phL21bOdKx6JEdDtHdjXv0Xo8IV05nlfhtraKLawu0uNpmKvZS2N\r\nRwe1UgxJkAbQgtgrIXBdUUBmO/985kdemel3V1j1l2wK0G5ApjiLQ8KYoZtF\r\nkqQwhLgvKSMscR1sL1ulk9URG4vXOcu1eArA3tU8YEujEbXUwHDWJZLGqd9O\r\nmhruL4RHNRe16STf0uvcenJexcFLHHjhSkfjxZRrueaCkD/YK5CD15jSksx9\r\nH0Cot7p81pLpt9+1EJygLc+BpybFG3lw66tvQHoGwbx48wz7vU/eQDIrw0cg\r\n3dwKfqdbjCZ/sRVHSQn1u6jtc4WRaCt1kEw=\r\n=78ii\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"kido","email":"kido@9wick.com"},"directories":{},"maintainers":[{"name":"kido","email":"kido@9wick.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/shodo_0.1.0_1664676290957_0.23790643251467958"},"_hasShrinkwrap":false},"0.1.1":{"name":"@9wick/shodo","version":"0.1.1","description":"[Shodo.ink](https://shodo.ink/)で公開されている API の非公式 SDK です。 利用には[Shodo の API](https://blog.shodo.ink/entry/2022/05/18/161818)のトークンが必要です","main":"dist/index.js","scripts":{"build":"rm -rf ./dist && tsc","version":"npm run lint-fix && npm run build","lint-fix":"eslint --fix './src/**/*.{js,ts}' && prettier --write './src/**/*.{js,ts}'"},"repository":{"type":"git","url":"git+ssh://git@github.com/9wick/shodo-js.git"},"keywords":["shodo","textlint","lint","japanese"],"author":{"name":"kido","email":"kido@9wick.com","url":"https://github.com/9wick"},"license":"MIT","dependencies":{"cli-color":"^2.0.3","node-fetch-commonjs":"^3.2.4"},"devDependencies":{"@tsconfig/strictest":"^1.0.2","@types/cli-color":"^2.0.2","@typescript-eslint/eslint-plugin":"^5.38.1","@typescript-eslint/parser":"^5.38.1","eslint":"^8.22.0","eslint-config-prettier":"^8.5.0","eslint-config-standard-with-typescript":"^23.0.0","eslint-plugin-import":"^2.26.0","eslint-plugin-n":"^15.3.0","eslint-plugin-promise":"^6.0.1","prettier":"^2.7.1","ts-node":"^10.9.1","typescript":"^4.8.4","utility-types":"^3.10.0"},"bugs":{"url":"https://github.com/9wick/shodo-js/issues"},"homepage":"https://github.com/9wick/shodo-js#readme","types":"./dist/index.d.ts","gitHead":"86a2d0d15309539e8c48f4a0254b6ef65dd11fa8","_id":"@9wick/shodo@0.1.1","_nodeVersion":"16.15.1","_npmVersion":"8.11.0","dist":{"integrity":"sha512-uYwAuKJObYnrx1f2h/bEaHap7/7bswgyYpEEfzDSKOHvN8Kg5ba7AZuMjwa1YnPplEN+Hi28TvP6aZirqQse7Q==","shasum":"bfec55ecf6302e585aa88024fee166fb4c662e59","tarball":"https://registry.npmjs.org/@9wick/shodo/-/shodo-0.1.1.tgz","fileCount":18,"unpackedSize":28862,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCBckggVWOlpfzeixvr13zElHWY2XnyKngGjEWB3xxmiQIhAMWToVdM8qMkHyNQ3yRdxmuJJNyxQwyUjdKHJfPiluO0"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjOPeEACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqBiQ/+LYk1YUdqAypnzRl7XX9b37/eH6Azmrh3chAIi8QLF0lYIWTe\r\n0UpNC2VVrABqslHssLllIGXcpiFWygL4L1DHYYfp3miZjWB4Jbg+Hjk3myqM\r\n4J8KCFLfTKeC/7MnhgqwNxTTILKAzTGtdV2LgN7qc9I2pcBUTlQ4DTJrUni6\r\nxPeIRXfcqd6oNnsjAgw7ws9FNEplnZiPwqjqoHL9CEIxYK/7LhMj2VCWREKA\r\nC3EnDWuFN8+OB5Xf1KP+r30667jeLkD+/FWZPaG/u2Jtgl081Z9SKLDjYOpv\r\nX1BYRP9BnyBZF3NDXRoZActNeZWT3ZO8L0a8qQhUzEUL7NkTs6hR03Wf/xez\r\n6naF/emiyQSAzReBJaF2obiPMmiVSRBJlVO6bCcZsjPsN2ZKv8ColW4keaHR\r\ngYTnkWidsqQ21pR7iguJzqvrX+Eo+3YEfq5T9CrQl+9Bou5eKS8oFTepidT8\r\n/1/HscBcX/eE1BnvLC3YLjP+MYkLg3OXVXwYogC1sC/Hsx64whLhK1ANf8R9\r\nULz6OMouQ4eZUb4FliKmzqy8q/cxoBhiKiNlvnot5Y5lnCNOFV7Mq8GIh2hX\r\n03X9zZlAT+ElDz4BpcWdHL+peBKO2dY2Ur2SlJOhWTJj9Q0XriUWyswvraIF\r\nJjLOYhFy0fP2MEVNXh7uqdu3lX4iTG6vblA=\r\n=kuv/\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"kido","email":"kido@9wick.com"},"directories":{},"maintainers":[{"name":"kido","email":"kido@9wick.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/shodo_0.1.1_1664677763826_0.24001033861876886"},"_hasShrinkwrap":false}},"time":{"created":"2022-10-02T02:04:50.903Z","0.1.0":"2022-10-02T02:04:51.149Z","modified":"2022-10-02T02:29:24.191Z","0.1.1":"2022-10-02T02:29:24.048Z"},"maintainers":[{"name":"kido","email":"kido@9wick.com"}],"homepage":"https://github.com/9wick/shodo-js#readme","keywords":["shodo","textlint","lint","japanese"],"repository":{"type":"git","url":"git+ssh://git@github.com/9wick/shodo-js.git"},"author":{"name":"kido","email":"kido@9wick.com","url":"https://github.com/9wick"},"bugs":{"url":"https://github.com/9wick/shodo-js/issues"},"license":"MIT","readme":"# Shodo-js\n\n[Shodo.ink](https://shodo.ink/)で公開されている API の非公式 SDK です。\n利用には[Shodo の API](https://blog.shodo.ink/entry/2022/05/18/161818)のトークンが必要です\n\n# インストール方法\n\n```shell\nnpm i @9wick/shodo\n```\n\n# 使い方\n\n```typescript\nimport { Shodo } from \"@9wick/shodo\";\n\nconst run = async () => {\n  const apiRoute = \"WRITE YOUR API ROUTE\";\n  const token = \"WRITE YOUR TOKEN\";\n\n  // create instance\n  const shodo = new Shodo({ token, apiRoute });\n\n  if (!(await shodo.isValidAccount())) {\n    throw new Error(\"Shodoアカウント情報が間違っています\");\n  }\n\n  const sampleText =\n    \"飛行機の欠便があり、運行状況が変わった。 バスの運行状況は変わりません。\";\n  // use api\n  const messages = await shodo.lintWait(sampleText);\n\n  // print results\n  shodo.printResults(sampleText, messages);\n\n  /**\n   * Output:\n   * 1:11 もしかしてAI\n   *   飛行機の欠便があり、運行（→ 運航）状況が変わった。 バ\n   * ...\n   */\n};\n\nrun();\n```\n\n## トークンの取得方法\n\n[Shodo の公式ブログ](https://blog.shodo.ink/entry/2022/05/18/161818)の手順に従って、\nAPI ルートと TOKEN を取得します。\n\n## 対応状況\n\nAPI リファレンスはこちら\nhttps://github.com/zenproducts/developers.shodo.ink/blob/master/docs/api.md\n\n| 対象 API             | 対応状況 |  関数名   | 備考 |\n| -------------------- | -------- |-----|-------|\n| 校正 API             | ✅       |  createLint   |       |\n| 校正結果 API         | ✅       |  getLintResults   |       |\n| 記事ファイル API     |          |     |       |\n| 記事ファイル詳細 API |          |     |       |\n| タスク API           |          |     |       |\n| タスク詳細 API       |          |     |       |\n\n\n## API外関数\n\nAPIの利用に便利な関数をいくつか作っています\n\n- shodo.lintWait\n\n校正 APIと校正結果 APIを使い、校正結果が帰ってくるまで待機する関数です\n\n```typescript\n\nconst sampleText = \"飛行機の欠便があり、運行状況が変わった。 バスの運行状況は変わりません。\";\nconst messages = await shodo.lintWait(sampleText);\n\n```\n\n\n- shodo.printResults\n\n校正結果を見やすく出力する関数です\n参考：https://github.com/zenproducts/shodo-python/blob/main/shodo/main.py#L29\n\n\n```typescript\n\nconst sampleText = \"飛行機の欠便があり、運行状況が変わった。 バスの運行状況は変わりません。\";\nconst messages = await shodo.lintWait(sampleText);\n\nshodo.printResults(sampleText, messages);\n```\n","readmeFilename":"README.md","description":"[Shodo.ink](https://shodo.ink/)で公開されている API の非公式 SDK です。 利用には[Shodo の API](https://blog.shodo.ink/entry/2022/05/18/161818)のトークンが必要です"}