@pidgr/proto 0.37.0 → 0.37.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -0
- package/package.json +16 -3
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @pidgr/proto
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@pidgr/proto)
|
|
4
|
+
[](https://github.com/pidgr/pidgr-proto/releases/latest)
|
|
5
|
+
[](https://github.com/pidgr/pidgr-proto/blob/main/LICENSE)
|
|
6
|
+
|
|
7
|
+
Generated TypeScript protobuf/gRPC stubs for the [Pidgr](https://pidgr.com) platform. Built with [Protobuf-ES](https://github.com/bufbuild/protobuf-es) and [Connect](https://connectrpc.com/).
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @pidgr/proto
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { OrganizationService } from "@pidgr/proto/pidgr/v1/organization_pb";
|
|
19
|
+
import { CampaignService } from "@pidgr/proto/pidgr/v1/campaign_pb";
|
|
20
|
+
import { createClient } from "@connectrpc/connect";
|
|
21
|
+
import { createConnectTransport } from "@connectrpc/connect-web";
|
|
22
|
+
|
|
23
|
+
const transport = createConnectTransport({ baseUrl: "https://api.pidgr.com" });
|
|
24
|
+
const client = createClient(OrganizationService, transport);
|
|
25
|
+
|
|
26
|
+
const org = await client.getOrganization({});
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Available Services
|
|
30
|
+
|
|
31
|
+
| Service | Import |
|
|
32
|
+
|---------|--------|
|
|
33
|
+
| AccessCodeService | `@pidgr/proto/pidgr/v1/access_code_pb` |
|
|
34
|
+
| ActionService | `@pidgr/proto/pidgr/v1/action_pb` |
|
|
35
|
+
| ApiKeyService | `@pidgr/proto/pidgr/v1/api_key_pb` |
|
|
36
|
+
| CampaignService | `@pidgr/proto/pidgr/v1/campaign_pb` |
|
|
37
|
+
| DeviceService | `@pidgr/proto/pidgr/v1/device_pb` |
|
|
38
|
+
| GroupService | `@pidgr/proto/pidgr/v1/group_pb` |
|
|
39
|
+
| HeatmapService | `@pidgr/proto/pidgr/v1/heatmap_pb` |
|
|
40
|
+
| InboxService | `@pidgr/proto/pidgr/v1/inbox_pb` |
|
|
41
|
+
| MemberService | `@pidgr/proto/pidgr/v1/member_pb` |
|
|
42
|
+
| OrganizationService | `@pidgr/proto/pidgr/v1/organization_pb` |
|
|
43
|
+
| ReplayService | `@pidgr/proto/pidgr/v1/replay_pb` |
|
|
44
|
+
| RoleService | `@pidgr/proto/pidgr/v1/role_pb` |
|
|
45
|
+
| SSOService | `@pidgr/proto/pidgr/v1/sso_pb` |
|
|
46
|
+
| TeamService | `@pidgr/proto/pidgr/v1/team_pb` |
|
|
47
|
+
| TemplateService | `@pidgr/proto/pidgr/v1/template_pb` |
|
|
48
|
+
| UserService | `@pidgr/proto/pidgr/v1/user_pb` |
|
|
49
|
+
|
|
50
|
+
Shared types (enums, pagination, messages) are in `@pidgr/proto/pidgr/v1/common_pb`.
|
|
51
|
+
|
|
52
|
+
## Other Languages
|
|
53
|
+
|
|
54
|
+
| Language | Install |
|
|
55
|
+
|----------|---------|
|
|
56
|
+
| Go | `go get github.com/pidgr/pidgr-proto/gen/go@latest` |
|
|
57
|
+
| Rust | Git dependency — see [repo](https://github.com/pidgr/pidgr-proto) |
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
[Apache-2.0](https://github.com/pidgr/pidgr-proto/blob/main/LICENSE)
|
package/package.json
CHANGED
|
@@ -1,19 +1,32 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pidgr/proto",
|
|
3
|
-
"version": "0.37.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.37.1",
|
|
4
|
+
"description": "TypeScript protobuf and gRPC client stubs for the Pidgr internal communications platform",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"pidgr",
|
|
7
|
+
"protobuf",
|
|
8
|
+
"grpc",
|
|
9
|
+
"connect",
|
|
10
|
+
"internal-communications",
|
|
11
|
+
"campaigns",
|
|
12
|
+
"rpc",
|
|
13
|
+
"codegen"
|
|
14
|
+
],
|
|
15
|
+
"homepage": "https://github.com/pidgr/pidgr-proto#readme",
|
|
5
16
|
"repository": {
|
|
6
17
|
"type": "git",
|
|
7
18
|
"url": "https://github.com/pidgr/pidgr-proto.git",
|
|
8
19
|
"directory": "gen/ts"
|
|
9
20
|
},
|
|
21
|
+
"license": "Apache-2.0",
|
|
10
22
|
"publishConfig": {
|
|
11
23
|
"registry": "https://registry.npmjs.org",
|
|
12
24
|
"access": "public",
|
|
13
25
|
"provenance": true
|
|
14
26
|
},
|
|
15
27
|
"files": [
|
|
16
|
-
"pidgr/**/*.ts"
|
|
28
|
+
"pidgr/**/*.ts",
|
|
29
|
+
"README.md"
|
|
17
30
|
],
|
|
18
31
|
"dependencies": {
|
|
19
32
|
"@bufbuild/protobuf": "^2.0.0",
|