{"id":31692552,"url":"https://github.com/alexandergrooff/spage-protobuf","last_synced_at":"2026-02-14T08:31:43.118Z","repository":{"id":311600795,"uuid":"1029275942","full_name":"AlexanderGrooff/spage-protobuf","owner":"AlexanderGrooff","description":"Define communication between Spage components","archived":false,"fork":false,"pushed_at":"2025-10-01T13:13:08.000Z","size":64,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-08T14:58:46.688Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlexanderGrooff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-30T19:39:10.000Z","updated_at":"2025-10-01T13:13:11.000Z","dependencies_parsed_at":"2025-08-25T13:26:51.981Z","dependency_job_id":"770109c4-eaa8-4e5e-9441-ac8b92a9d8c9","html_url":"https://github.com/AlexanderGrooff/spage-protobuf","commit_stats":null,"previous_names":["alexandergrooff/spage-protobuf"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/AlexanderGrooff/spage-protobuf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderGrooff%2Fspage-protobuf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderGrooff%2Fspage-protobuf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderGrooff%2Fspage-protobuf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderGrooff%2Fspage-protobuf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlexanderGrooff","download_url":"https://codeload.github.com/AlexanderGrooff/spage-protobuf/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderGrooff%2Fspage-protobuf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29440330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T07:24:13.446Z","status":"ssl_error","status_checked_at":"2026-02-14T07:23:58.969Z","response_time":53,"last_error":"SSL_read: 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":[],"created_at":"2025-10-08T14:53:55.700Z","updated_at":"2026-02-14T08:31:43.104Z","avatar_url":"https://github.com/AlexanderGrooff.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spage Protobuf\n\nThis repository contains Protocol Buffer definitions for the Spage project, along with code generation for both Go and TypeScript.\n\n## Overview\n\nThe protobuf definitions define the communication protocol between Spage components\n\n## Code Generation\n\n### Prerequisites\n\n1. Install `protoc` (Protocol Buffer compiler)\n2. Install Go protobuf plugins:\n\n   ```bash\n   go install google.golang.org/protobuf/cmd/protoc-gen-go@latest\n   go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest\n   ```\n\n3. Install Node.js dependencies:\n\n   ```bash\n   npm install\n   ```\n\n### Generating Code\n\n#### Generate Go code only\n\n```bash\nmake proto-go\n# or\nnpm run proto:go\n```\n\n#### Generate TypeScript code only\n\n```bash\nmake proto-ts\n# or\nnpm run proto:ts\n```\n\n#### Generate both Go and TypeScript code\n\n```bash\nmake proto\n# or\nnpm run proto\n```\n\n### Generated Files\n\n#### Go\n\n- `spage/core/*.pb.go` - Core protobuf message types\n\n#### TypeScript\n\n- `generated/typescript/spage/core/` - Core TypeScript types\n\n## Using Generated Types\n\n### In Go Projects\n\n```go\nimport (\n    \"github.com/AlexanderGrooff/spage-protobuf/spage/core\"\n)\n```\n\n### In TypeScript Projects\n\n```typescript\nimport { SpagePlay, PlayStatus } from '../../../spage-protobuf/generated/typescript/spage/core/plays';\nimport { SpageTask, TaskStatus } from '../../../spage-protobuf/generated/typescript/spage/core/common';\n```\n\n## Development Workflow\n\n1. **Modify protobuf files** in `spage/core/`\n2. **Regenerate code**: `make proto`\n3. **Update consuming projects** to use the new types\n4. **Test** the changes in all components\n\n## File Structure\n\n```\nspage-protobuf/\n├── spage/\n│   ├── core/\n│   │   ├── common.proto      # Common types (Task, Error, Health)\n│   │   └── plays.proto       # Play-related types\n├── generated/\n│   └── typescript/           # Generated TypeScript types\n├── Makefile                  # Build automation\n├── package.json              # Node.js dependencies\n└── README.md                 # This file\n```\n\n## TypeScript Configuration\n\nThe TypeScript generation uses `ts-proto` with the following options:\n\n- `esModuleInterop=true` - Better ES module compatibility\n- `forceLong=string` - Use strings for 64-bit integers\n- `useOptionals=messages` - Make message fields optional\n- `exportCommonSymbols=false` - Avoid naming conflicts\n- `stringEnums=true` - Use string enums instead of numeric\n\n## Contributing\n\nWhen adding new protobuf definitions:\n\n1. Add the new `.proto` file\n2. Update the generation commands if needed\n3. Regenerate all code: `make proto`\n4. Update this README if the structure changes\n5. Test the changes in all consuming projects\n\n## Troubleshooting\n\n### TypeScript Generation Issues\n\n- Ensure `ts-proto` is installed: `npm install`\n- Check that the output directory exists: `mkdir -p generated/typescript`\n- Verify protobuf syntax: `protoc --version`\n\n### Go Generation Issues\n\n- Ensure Go protobuf plugins are installed\n- Check that `protoc` is in your PATH\n- Verify the `go.mod` file is up to date\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexandergrooff%2Fspage-protobuf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexandergrooff%2Fspage-protobuf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexandergrooff%2Fspage-protobuf/lists"}