{"id":15283922,"url":"https://github.com/versia-pub/api","last_synced_at":"2025-07-29T11:11:00.789Z","repository":{"id":239696216,"uuid":"800278486","full_name":"versia-pub/api","owner":"versia-pub","description":"TypeScript APIs for various Versia services.","archived":false,"fork":false,"pushed_at":"2025-02-18T11:17:13.000Z","size":378,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-19T03:49:59.836Z","etag":null,"topics":["cryptography","ecmascript2020","federation","lysand","typescript","webcrypto"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@versia/federation","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/versia-pub.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,"zenodo":null},"funding":{"github":["versia-pub"]}},"created_at":"2024-05-14T03:15:25.000Z","updated_at":"2025-02-21T21:36:09.000Z","dependencies_parsed_at":"2024-09-16T12:09:59.604Z","dependency_job_id":"23846532-25a2-4763-bee8-89c97cfa25b8","html_url":"https://github.com/versia-pub/api","commit_stats":null,"previous_names":["lysand-org/api","versia-pub/api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/versia-pub/api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versia-pub%2Fapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versia-pub%2Fapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versia-pub%2Fapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versia-pub%2Fapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/versia-pub","download_url":"https://codeload.github.com/versia-pub/api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versia-pub%2Fapi/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266939098,"owners_count":24009616,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["cryptography","ecmascript2020","federation","lysand","typescript","webcrypto"],"created_at":"2024-09-30T14:48:13.997Z","updated_at":"2025-07-29T11:11:00.765Z","avatar_url":"https://github.com/versia-pub.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://versia.pub\"\u003e\u003cimg src=\"https://cdn.versia.pub/branding/logo-dark.svg\" alt=\"Versia Logo\" height=\"110\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ccenter\u003e\u003ch1\u003eVersia API\u003c/h1\u003e\u003c/center\u003e\n\nSet of NPM packages written in TypeScript to interact with Versia-compatible services.\n\n## Packages\n\n- **`@versia/federation`**: Federation types, validators and cryptography for Versia server implementations.\n- **`@versia/client`**: Client for the reference Versia Server implementation.\n\n## Efficiency\n\nThe built output of each package is not even `200 KB` in size, making it a lightweight and efficient solution for your Versia needs. Installing the package adds around `5 MB` to your `node_modules` folder, but this does not affect the final bundle size.\n\nCompilation (bundling/minifying) time is a few seconds, almost all of which is spent on type-checking. The actual compilation time is less than a tenth of a second.\n\n## Usage\n\n### Federation\n\nPlease see the [**`@versia/federation` README**](federation/README.md) for more information.\n\n### Client\n\nPlease see the [**`@versia/client` README**](client/README.md) for more information.\n\n## Getting Started\n\n### Prerequisites\n\n#### For Usage\n\nSee the [**Compatibility**](#compatibility) section for the supported environments. Any package manager can be used to install the packages.\n\n#### For Development\n\n- [**Bun**](https://bun.sh) version `1.1.8` or higher.\n- Either the [**Linux**](https://www.linux.org) or [**macOS**](https://www.apple.com/macos) operating systems. ([**Windows**](https://www.microsoft.com/windows) will work, but is not officially supported.)\n\n### Compatibility\n\nThis library is built for JavaScript runtimes with the support for:\n\n- [**ES Modules**](https://nodejs.org/api/esm.html)\n- [**ECMAScript 2020**](https://www.ecma-international.org/ecma-262/11.0/index.html)\n\n#### Runtimes\n\n- **Node.js**: 14.0+ is the minimum, but only Node.js 20.0+ (LTS) is officially supported.\n- **Deno**: Support is unknown. 1.0+ is expected to work.\n- **Bun**: Bun 1.1.8 is the minimum-supported version. As Bun is rapidly evolving, this may change. Previous versions may also work.\n\n#### Browsers\n\nConsequently, this library is compatible without any bundling in the following browser versions:\n\n- **Chrome**: 80+\n- **Edge**: 80+\n- **Firefox**: 74+\n- **Safari**: 13.1+\n- **Opera**: 67+\n- **Internet Explorer**: None\n\nIf you are targeting older browsers, please don't, you are doing yourself a disservice.\n\nTranspilation to non-ES Module environments is not officially supported, but should be simple with the use of a bundler like [**Parcel**](https://parceljs.org) or [**Rollup**](https://rollupjs.org).\n\n### Installation\n\nBoth packages are distributed as a scoped package on the NPM registry or [JSR](https://jsr.io).\n\nWe strongly recommend using JSR over NPM for all your packages that are available on it.\n\n```bash\n# NPM version\ndeno add npm:@versia/federation npm:@versia/client # For Deno\nnpm install @versia/federation @versia/client # For NPM\nyarn add @versia/federation @versia/client # For Yarn\npnpm add @versia/federation @versia/client # For PNPM\nbun add @versia/federation @versia/client # For Bun\n\n# JSR version\ndeno add @versia/federation @versia/client # For Deno\nnpx jsr add @versia/federation @versia/client # For JSR\nyarn dlx jsr add @versia/federation @versia/client # For Yarn\npnpm dlx jsr add @versia/federation @versia/client # For PNPM\nbunx jsr add @versia/federation @versia/client # For Bun\n```\n\n#### From Source\n\nIf you want to install from source, you can clone this repository and run the following commands:\n\n```bash\nbun install # Install dependencies\n\nbun run build # Build the packages\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n### Projects\n\n- [**Bun**](https://bun.sh): Thanks to the Bun team for creating an amazing JavaScript runtime.\n- [**TypeScript**](https://www.typescriptlang.org): TypeScript is the backbone of this project.\n- [**Node.js**](https://nodejs.org): Node.js created the idea of JavaScript on the server.\n\n### People\n\n- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Versia Server ActivityPub bridge.","funding_links":["https://github.com/sponsors/versia-pub"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fversia-pub%2Fapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fversia-pub%2Fapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fversia-pub%2Fapi/lists"}