@in-human-resources/backend-proto 0.1.0

package/README.md

@@ -0,0 +1,63 @@
+# `@in-human-resources/backend-proto`
+
+Published npm package: **Protobuf-ES** message types and **Connect-ES** service stubs for `api.v1`, `auth.v1`, and `common.v1`.
+
+## Install
+
+```bash
+npm install @in-human-resources/backend-proto
+```
+
+Peer dependencies (install in your app):
+
+```bash
+npm install @bufbuild/protobuf @connectrpc/connect
+```
+
+For browsers you may also use `@connectrpc/connect-web`.
+
+## Usage
+
+Import Connect service definitions and create a client (example: gateway `api.v1`):
+
+```typescript
+import { createClient } from '@connectrpc/connect';
+import { createGrpcTransport } from '@connectrpc/connect-node';
+import { AuthService } from '@in-human-resources/backend-proto/gen/ts/api/v1/auth_connect.js';
+
+const transport = createGrpcTransport({ baseUrl: 'http://localhost:8082', httpVersion: '2' });
+export const authClient = createClient(AuthService, transport);
+```
+
+Use the same pattern for `company_connect.js`, `candidate_connect.js`, or internal `auth/v1/service_connect.js` as needed.
+
+## Regenerate (maintainers)
+
+From this directory:
+
+```bash
+npm install
+npx buf generate
+```
+
+This refreshes **Go** output under `gen/` and **TypeScript** under `gen/ts/`. Commit both when APIs change.
+
+## Publish
+
+1. Bump `"version"` in `package.json`.
+2. `npm login` (npmjs.com account with permission to publish the `@in-human-resources` scope).
+3. **npm requires 2FA to publish** (or a [granular access token](https://docs.npmjs.com/about-access-tokens) with publish rights). Enable 2FA on [npm account settings](https://www.npmjs.com/settings/~/auth) (Authorization and publishing), or create a token with “Bypass two-factor authentication” if your org allows it.
+4. From `proto/`:
+
+   ```bash
+   npm publish
+   ```
+
+   `publishConfig.access` is set to `public` in `package.json` for this scoped package.
+
+## Layout
+
+| Path        | Contents                                      |
+|------------|-----------------------------------------------|
+| `gen/`     | Go protobuf + gRPC (`paths=source_relative`) |
+| `gen/ts/`  | `*_pb.ts` (messages) and `*_connect.ts` (Connect services) |

package/buf.gen.yaml

@@ -0,0 +1,17 @@
+version: v2
+plugins:
+  - remote: buf.build/protocolbuffers/go
+    out: gen
+    opt: paths=source_relative
+  - remote: buf.build/grpc/go
+    out: gen
+    opt: paths=source_relative
+  # TypeScript: Protobuf-ES messages, then Connect-ES service stubs (order matters).
+  - local: protoc-gen-es
+    out: gen/ts
+    opt:
+      - target=ts
+      - import_extension=.js
+  - local: protoc-gen-connect-es
+    out: gen/ts
+    opt: target=ts

package/buf.yaml

@@ -0,0 +1,10 @@
+version: v2
+modules:
+  - path: .
+    name: buf.build/InHuman-Resources/backend
+lint:
+  use:
+    - STANDARD
+breaking:
+  use:
+    - FILE

package/gen/ts/api/v1/auth_connect.ts

@@ -0,0 +1,195 @@
+// @generated by protoc-gen-connect-es v1.7.0 with parameter "target=ts"
+// @generated from file api/v1/auth.proto (package api.v1, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { ChangePasswordRequest, GetProfileRequest, GetProfileResponse, LinkOAuthAccountRequest, ListSessionsRequest, ListSessionsResponse, LoginRequest, LoginResponse, LogoutRequest, OAuthCallbackRequest, OAuthCallbackResponse, OAuthLoginRequest, OAuthLoginResponse, RefreshTokenRequest, RefreshTokenResponse, RegisterRequest, RegisterResponse, RequestPasswordResetRequest, ResendVerificationEmailRequest, ResetPasswordRequest, RevokeAllSessionsRequest, RevokeSessionRequest, UnlinkOAuthAccountRequest, UpdateProfileRequest, VerifyEmailRequest } from "./auth_pb.js";
+import { MethodKind } from "@bufbuild/protobuf";
+import { Empty } from "./common_pb.js";
+
+/**
+ * AuthService is the client-facing authentication service.
+ * Mobile and web clients call these RPCs directly.
+ *
+ * @generated from service api.v1.AuthService
+ */
+export const AuthService = {
+  typeName: "api.v1.AuthService",
+  methods: {
+    /**
+     * Core authentication
+     *
+     * @generated from rpc api.v1.AuthService.Register
+     */
+    register: {
+      name: "Register",
+      I: RegisterRequest,
+      O: RegisterResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.Login
+     */
+    login: {
+      name: "Login",
+      I: LoginRequest,
+      O: LoginResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.RefreshToken
+     */
+    refreshToken: {
+      name: "RefreshToken",
+      I: RefreshTokenRequest,
+      O: RefreshTokenResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.Logout
+     */
+    logout: {
+      name: "Logout",
+      I: LogoutRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Email verification
+     *
+     * @generated from rpc api.v1.AuthService.VerifyEmail
+     */
+    verifyEmail: {
+      name: "VerifyEmail",
+      I: VerifyEmailRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.ResendVerificationEmail
+     */
+    resendVerificationEmail: {
+      name: "ResendVerificationEmail",
+      I: ResendVerificationEmailRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Password management
+     *
+     * @generated from rpc api.v1.AuthService.RequestPasswordReset
+     */
+    requestPasswordReset: {
+      name: "RequestPasswordReset",
+      I: RequestPasswordResetRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.ResetPassword
+     */
+    resetPassword: {
+      name: "ResetPassword",
+      I: ResetPasswordRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.ChangePassword
+     */
+    changePassword: {
+      name: "ChangePassword",
+      I: ChangePasswordRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Profile
+     *
+     * @generated from rpc api.v1.AuthService.GetProfile
+     */
+    getProfile: {
+      name: "GetProfile",
+      I: GetProfileRequest,
+      O: GetProfileResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.UpdateProfile
+     */
+    updateProfile: {
+      name: "UpdateProfile",
+      I: UpdateProfileRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Sessions
+     *
+     * @generated from rpc api.v1.AuthService.ListSessions
+     */
+    listSessions: {
+      name: "ListSessions",
+      I: ListSessionsRequest,
+      O: ListSessionsResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.RevokeSession
+     */
+    revokeSession: {
+      name: "RevokeSession",
+      I: RevokeSessionRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.RevokeAllSessions
+     */
+    revokeAllSessions: {
+      name: "RevokeAllSessions",
+      I: RevokeAllSessionsRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * OAuth
+     *
+     * @generated from rpc api.v1.AuthService.OAuthLogin
+     */
+    oAuthLogin: {
+      name: "OAuthLogin",
+      I: OAuthLoginRequest,
+      O: OAuthLoginResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.OAuthCallback
+     */
+    oAuthCallback: {
+      name: "OAuthCallback",
+      I: OAuthCallbackRequest,
+      O: OAuthCallbackResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.LinkOAuthAccount
+     */
+    linkOAuthAccount: {
+      name: "LinkOAuthAccount",
+      I: LinkOAuthAccountRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc api.v1.AuthService.UnlinkOAuthAccount
+     */
+    unlinkOAuthAccount: {
+      name: "UnlinkOAuthAccount",
+      I: UnlinkOAuthAccountRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+  }
+} as const;
+