{"id":23442261,"url":"https://github.com/teamwertarbyte/updatehive-react","last_synced_at":"2025-04-09T21:48:51.305Z","repository":{"id":248550296,"uuid":"817820610","full_name":"TeamWertarbyte/updatehive-react","owner":"TeamWertarbyte","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-09T09:24:46.000Z","size":196,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T21:48:42.776Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TeamWertarbyte.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-20T14:03:19.000Z","updated_at":"2024-10-04T09:42:21.000Z","dependencies_parsed_at":"2025-02-15T13:46:41.198Z","dependency_job_id":"cd62c681-0e4b-4a6d-8800-734865c2c89a","html_url":"https://github.com/TeamWertarbyte/updatehive-react","commit_stats":null,"previous_names":["teamwertarbyte/updatehive-react"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fupdatehive-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fupdatehive-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fupdatehive-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fupdatehive-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TeamWertarbyte","download_url":"https://codeload.github.com/TeamWertarbyte/updatehive-react/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248119403,"owners_count":21050754,"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":[],"created_at":"2024-12-23T17:29:08.941Z","updated_at":"2025-04-09T21:48:51.279Z","avatar_url":"https://github.com/TeamWertarbyte.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UpdateHive - React Client component\n\nClient side react components and hooks for interacting with the UpdateHive API. Working with and rendering changelogs\nprovided by UpdateHive in a standardized way across react applications.\n\n## Installation\n\n```\n# npm\nnpm -i @wertarbyte/updatehive-react\n\n# yarn\nyarn add @wertarbyte/updatehive-react\n```\n\n## Usage\n\nEither use the react hook and render the changelog yourself or let this library fetch and render the changelog for you.\n\nFor a more complete example, see the [App.tsx](https://github.com/TeamWertarbyte/updatehive-react/blob/master/src/App.tsx) in the src directory.\n\n### Hook\n\n```tsx\nimport { useChangelog } from '@wertarbyte/updatehive-react';\n\nconst Changelog = () =\u003e {\n  const { loading, error, changelog } = useChangelog({\n    connection: {\n      API_KEY,\n    },\n    changelogs: {\n      product: PRODUCT_ID,\n    },\n  });\n\n  if (loading) return \u003cp\u003eLoading...\u003c/p\u003e;\n  if (error) return \u003cp\u003eError: {error.message}\u003c/p\u003e;\n\n  return (\n    \u003cdiv\u003e\n      \u003ch1\u003e{changelog.title}\u003c/h1\u003e\n      \u003cul\u003e\n        {changelog.entries.map((entry) =\u003e (\n          \u003cli key={entry.id}\u003e{entry.version}\u003c/li\u003e\n        ))}\n      \u003c/ul\u003e\n    \u003c/div\u003e\n  );\n};\n```\n\n### Component\n\n```tsx\nimport {\n  ChangelogContainer,\n  MinimalChangelogList,\n} from '@wertarbyte/updatehive-react';\n\nreturn (\n  \u003cChangelogContainer\n    API_KEY={API_KEY}\n    product={PRODUCT}\n    config={{ url: serviceURL }}\n  \u003e\n    \u003cMinimalChangelogList /\u003e\n  \u003c/ChangelogContainer\u003e\n);\n```\n\n## Configuration\n\n```tsx\n/**\n * Configuration to retrieve changelogs from UpdateHive.\n *\n * @param connection\n *    API_KEY:        API_KEY to access UpdateHive public REST API.\n *    url:            Override the default URL to UpdateHive API.\n *\n * @param changelogs\n *    product:        Product ID to retrieve changelogs for.\n *    onlyLast:       Retrieve only the last changelog.\n */\nexport type UpdateHiveConfig = {\n  connection: {\n    API_KEY: string;\n    url?: string;\n  };\n  changelogs: {\n    product: string;\n    onlyLast?: boolean;\n  };\n};\n```\n\n## Development\n\n### Testing\n\nThe library can be easily testet in dev mode via the provided 'dev' script and App.tsx.\n\n```\n# npm\nnpm run dev\n```\n\n### ChangelogLists\n\nChangelogLists are split into public (API) classes and their internal representation, to\nseparate concerns and allow for easier reusage.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamwertarbyte%2Fupdatehive-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteamwertarbyte%2Fupdatehive-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamwertarbyte%2Fupdatehive-react/lists"}