{"id":13632360,"url":"https://github.com/ipfs-shipyard/js-pinning-service-http-client","last_synced_at":"2025-04-12T02:25:50.711Z","repository":{"id":37819737,"uuid":"457571220","full_name":"ipfs-shipyard/js-pinning-service-http-client","owner":"ipfs-shipyard","description":"An IPFS Pinning Service HTTP Client for TypeScript / Javascript","archived":false,"fork":false,"pushed_at":"2024-10-30T10:47:40.000Z","size":7851,"stargazers_count":9,"open_issues_count":3,"forks_count":4,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-11-03T16:05:15.842Z","etag":null,"topics":["ipfs","ipfs-gui"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ipfs-shipyard.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-10T00:10:18.000Z","updated_at":"2024-10-08T06:05:03.000Z","dependencies_parsed_at":"2024-04-09T15:10:17.318Z","dependency_job_id":"db23355d-8c20-49a2-b9f4-5b4c8f938f80","html_url":"https://github.com/ipfs-shipyard/js-pinning-service-http-client","commit_stats":{"total_commits":32,"total_committers":4,"mean_commits":8.0,"dds":0.34375,"last_synced_commit":"152c53590d20e1575ccf660e57f378d33becce1a"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Fjs-pinning-service-http-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Fjs-pinning-service-http-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Fjs-pinning-service-http-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Fjs-pinning-service-http-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipfs-shipyard","download_url":"https://codeload.github.com/ipfs-shipyard/js-pinning-service-http-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224568143,"owners_count":17332833,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ipfs","ipfs-gui"],"created_at":"2024-08-01T22:03:01.255Z","updated_at":"2024-11-14T23:07:57.483Z","avatar_url":"https://github.com/ipfs-shipyard.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"## IPFS Pinning Service API Client for JS\n\nThis client was generated using [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) from the [IPFS Pinning Service API spec](https://ipfs.github.io/pinning-services-api-spec/).\n\nYou can see the commands used to generate the client in the `gen:fetch` npm script.\n\n### Usage\n\n```\nnpm install @ipfs-shipyard/pinning-service-client --save\n```\n\nThis client only has a programmatic API at the moment (no CLI). You use it like so:\n\n```ts\n\nimport { Configuration, RemotePinningServiceClient, Status } from '@ipfs-shipyard/pinning-service-client'\nimport type { PinsGetRequest, PinResults } from '@ipfs-shipyard/pinning-service-client'\n\nconst config = new Configuration({\n  endpointUrl, // the URI for your pinning provider, e.g. `http://localhost:3000`\n  accessToken, // the secret token/key given to you by your pinning provider\n  // fetchApi: fetch, // You can pass your own fetchApi implementation, but we use NodeJS fetch by default.\n})\n\nconst client = new RemotePinningServiceClient(config)\n\n(async () =\u003e {\n  // Get 10 failed Pins\n  const pinsGetOptions: PinsGetRequest = {\n    limit: 10,\n    status: [Status.Failed]\n  }\n  const {count, results}: PinResults = await client.pinsGet(pinsGetOptions)\n\n  console.log(count, results)\n\n})()\n\n```\n\n## Developing\n\n### Building\n\nTo build and compile the typescript sources to javascript use:\n```\nnpm install\nnpm run build\n```\n\n### Updating the generated client\n\nTo update the client, you need to `npm run gen` npm script. This will fetch the latest version of the OpenAPI spec and generate the client. However, openapi-generator-cli does not currently generate the client code with proper import syntax. So you must modify the imports in `generated/fetch/**` directly, or just `git checkout -p` to remove the invalid import path changes.\n\nIt also uses `Set`s for all collection types though it cannot serialize or deserialize these types to/from JSON. They must be manually changed to be `Array`s.\n\nIf you need to modify the generated code's import paths, you will have to run `npm run postgen` manually.\n\n### Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md).\n\n### Publishing\n\nFirst build the package then run ```npm publish```\n\n## License\n\nLicensed under either of\n\n * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)\n * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall\nbe dual licensed as above, without any additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs-shipyard%2Fjs-pinning-service-http-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipfs-shipyard%2Fjs-pinning-service-http-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs-shipyard%2Fjs-pinning-service-http-client/lists"}