@in-human-resources/backend-proto 0.1.3 → 0.1.5

package/hiring/v1/pipeline.proto

@@ -0,0 +1,156 @@
+syntax = "proto3";
+
+package hiring.v1;
+
+option go_package = "github.com/InHuman-Resources/Backend/Go/proto/gen/hiring/v1;hiringv1";
+
+// Pipeline capability aligns with business hiring automation areas.
+enum PipelineCapability {
+  PIPELINE_CAPABILITY_UNSPECIFIED = 0;
+  PIPELINE_CAPABILITY_SCREENING = 1;
+  PIPELINE_CAPABILITY_RECRUITER_REVIEW = 2;
+  PIPELINE_CAPABILITY_ASSESSMENT = 3;
+  PIPELINE_CAPABILITY_INTERVIEW = 4;
+  PIPELINE_CAPABILITY_OFFER = 5;
+  PIPELINE_CAPABILITY_COMMUNICATION = 6;
+}
+
+enum PipelineStepType {
+  PIPELINE_STEP_TYPE_UNSPECIFIED = 0;
+  PIPELINE_STEP_TYPE_AUTOMATED = 1;
+  PIPELINE_STEP_TYPE_HUMAN_GATE = 2;
+  PIPELINE_STEP_TYPE_ASSESSMENT = 3;
+  PIPELINE_STEP_TYPE_INTERVIEW = 4;
+  PIPELINE_STEP_TYPE_OFFER = 5;
+}
+
+message BlockSLA {
+  int32 reminder_after_days = 1;
+  int32 escalate_after_days = 2;
+  int32 auto_reject_after_days = 3;
+}
+
+message ManualFieldSpec {
+  string id = 1;
+  string label = 2;
+  string type = 3;
+  bool required = 4;
+}
+
+message ManualFieldsConfig {
+  repeated ManualFieldSpec fields = 1;
+}
+
+message PipelineBlock {
+  string block_id = 1;
+  int32 sort_order = 2;
+  PipelineCapability capability = 3;
+  bool enabled = 4;
+  string display_name = 5;
+  string candidate_status_label = 6;
+  PipelineStepType step_type = 7;
+  BlockSLA sla = 8;
+  ManualFieldsConfig manual_fields = 9;
+  string config_json = 10;
+}
+
+message PipelineDefinition {
+  string definition_id = 1;
+  string company_id = 2;
+  string name = 3;
+  string description = 4;
+  string slug = 5;
+  int32 version = 6;
+  string status = 7;
+  bool is_platform = 8;
+  string source_template_id = 9;
+  int32 schema_version = 10;
+  repeated PipelineBlock blocks = 11;
+}
+
+message ExecutionStep {
+  string stage_id = 1;
+  PipelineStepType step_type = 2;
+  string block_id = 3;
+  PipelineCapability capability = 4;
+  BlockSLA sla = 5;
+  string config_json = 6;
+  string manual_fields_json = 7;
+}
+
+message PipelineSnapshot {
+  string definition_id = 1;
+  int32 definition_version = 2;
+  int32 schema_version = 3;
+  string definition_name = 4;
+  repeated ExecutionStep steps = 5;
+}
+
+message ListPlatformPipelineTemplatesRequest {}
+
+message ListPlatformPipelineTemplatesResponse {
+  repeated PipelineDefinition templates = 1;
+}
+
+message GetPipelineDefinitionRequest {
+  string definition_id = 1;
+}
+
+message ListPipelineDefinitionsRequest {}
+
+message ListPipelineDefinitionsResponse {
+  repeated PipelineDefinition definitions = 1;
+}
+
+message CreatePipelineDefinitionRequest {
+  string name = 1;
+  string description = 2;
+  repeated PipelineBlock blocks = 3;
+}
+
+message CreatePipelineDefinitionResponse {
+  string definition_id = 1;
+}
+
+message UpdatePipelineDefinitionRequest {
+  string definition_id = 1;
+  string name = 2;
+  string description = 3;
+  repeated PipelineBlock blocks = 4;
+}
+
+message PublishPipelineDefinitionRequest {
+  string definition_id = 1;
+}
+
+message PublishPipelineDefinitionResponse {
+  int32 version = 1;
+}
+
+message ClonePipelineFromTemplateRequest {
+  string template_id = 1;
+  string name = 2;
+}
+
+message ClonePipelineFromTemplateResponse {
+  string definition_id = 1;
+}
+
+message SetCompanyDefaultPipelineRequest {
+  string definition_id = 1;
+}
+
+message SetCompanyDefaultPipelineResponse {}
+
+message SetJobPipelineDefinitionRequest {
+  string job_id = 1;
+  string definition_id = 2;
+}
+
+message GetApplicationPipelineSnapshotRequest {
+  string application_id = 1;
+}
+
+message GetApplicationPipelineSnapshotResponse {
+  PipelineSnapshot snapshot = 1;
+}

package/hiring/v1/service.proto

@@ -0,0 +1,310 @@
+syntax = "proto3";
+
+package hiring.v1;
+
+option go_package = "github.com/InHuman-Resources/Backend/Go/proto/gen/hiring/v1;hiringv1";
+
+import "hiring/v1/pipeline.proto";
+
+// HiringService is the private hiring API for the API gateway and approved internal callers
+// (e.g. workflow in M2). Product clients must use api.v1.HiringService on the gateway.
+service HiringService {
+  rpc CreateJob(CreateJobRequest) returns (CreateJobResponse);
+  rpc PublishJob(PublishJobRequest) returns (PublishJobResponse);
+  rpc ApplyToJob(ApplyToJobRequest) returns (ApplyToJobResponse);
+  rpc GetJob(GetJobRequest) returns (GetJobResponse);
+  rpc GetApplication(GetApplicationRequest) returns (GetApplicationResponse);
+
+  rpc ListJobs(ListJobsRequest) returns (ListJobsResponse);
+  rpc SearchJobs(SearchJobsRequest) returns (SearchJobsResponse);
+  rpc UpdateJob(UpdateJobRequest) returns (UpdateJobResponse);
+  rpc CloseJob(CloseJobRequest) returns (CloseJobResponse);
+
+  rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse);
+  rpc ListApplicationsForJob(ListApplicationsForJobRequest) returns (ListApplicationsForJobResponse);
+  rpc ListApplicationsForCandidate(ListApplicationsForCandidateRequest) returns (ListApplicationsForCandidateResponse);
+
+  rpc TransitionApplicationStage(TransitionApplicationStageRequest) returns (TransitionApplicationStageResponse);
+  rpc RecordRecruiterDecision(RecordRecruiterDecisionRequest) returns (RecordRecruiterDecisionResponse);
+  rpc RecordScreeningResult(RecordScreeningResultRequest) returns (RecordScreeningResultResponse);
+  rpc RecordInterview(RecordInterviewRequest) returns (RecordInterviewResponse);
+  rpc LinkAssessment(LinkAssessmentRequest) returns (LinkAssessmentResponse);
+  rpc RecordOffer(RecordOfferRequest) returns (RecordOfferResponse);
+  rpc ListApplicationEvents(ListApplicationEventsRequest) returns (ListApplicationEventsResponse);
+
+  // Pipeline configuration (M2.5)
+  rpc ListPlatformPipelineTemplates(ListPlatformPipelineTemplatesRequest) returns (ListPlatformPipelineTemplatesResponse);
+  rpc GetPipelineDefinition(GetPipelineDefinitionRequest) returns (PipelineDefinition);
+  rpc ListPipelineDefinitions(ListPipelineDefinitionsRequest) returns (ListPipelineDefinitionsResponse);
+  rpc CreatePipelineDefinition(CreatePipelineDefinitionRequest) returns (CreatePipelineDefinitionResponse);
+  rpc UpdatePipelineDefinition(UpdatePipelineDefinitionRequest) returns (PipelineDefinition);
+  rpc PublishPipelineDefinition(PublishPipelineDefinitionRequest) returns (PublishPipelineDefinitionResponse);
+  rpc ClonePipelineFromTemplate(ClonePipelineFromTemplateRequest) returns (ClonePipelineFromTemplateResponse);
+  rpc SetCompanyDefaultPipeline(SetCompanyDefaultPipelineRequest) returns (SetCompanyDefaultPipelineResponse);
+  rpc SetJobPipelineDefinition(SetJobPipelineDefinitionRequest) returns (Job);
+  rpc GetApplicationPipelineSnapshot(GetApplicationPipelineSnapshotRequest) returns (GetApplicationPipelineSnapshotResponse);
+}
+
+// --- Pagination ---
+
+message PageRequest {
+  int32 page_size = 1; // default 20, max 100
+  string page_token = 2; // opaque; empty for first page
+}
+
+message PageResponse {
+  string next_page_token = 1;
+}
+
+// --- Jobs ---
+
+message CreateJobRequest {
+  string title = 1;
+  string description = 2;
+  string public_slug = 3;
+  string pipeline_definition_id = 4;
+}
+
+message CreateJobResponse {
+  string job_id = 1;
+}
+
+message PublishJobRequest {
+  string job_id = 1;
+}
+
+message PublishJobResponse {
+  string status = 1;
+}
+
+message GetJobRequest {
+  string job_id = 1;
+}
+
+message Job {
+  string job_id = 1;
+  string company_id = 2;
+  string title = 3;
+  string description = 4;
+  string status = 5;
+  string public_slug = 6;
+  string requirements = 7;
+  string team_metadata_json = 8;
+  string created_at = 9;
+  string updated_at = 10;
+  string pipeline_definition_id = 11;
+}
+
+message GetJobResponse {
+  string job_id = 1;
+  string company_id = 2;
+  string title = 3;
+  string description = 4;
+  string status = 5;
+  string public_slug = 6;
+  string requirements = 7;
+  string team_metadata_json = 8;
+  string created_at = 9;
+  string updated_at = 10;
+  string pipeline_definition_id = 11;
+}
+
+message ListJobsRequest {
+  string status_filter = 1; // empty = all for company
+  PageRequest page = 2;
+}
+
+message ListJobsResponse {
+  repeated Job jobs = 1;
+  PageResponse page = 2;
+}
+
+message SearchJobsRequest {
+  string query = 1;
+  PageRequest page = 2;
+}
+
+message SearchJobsResponse {
+  repeated Job jobs = 1;
+  PageResponse page = 2;
+}
+
+message UpdateJobRequest {
+  string job_id = 1;
+  string title = 2;
+  string description = 3;
+  string public_slug = 4;
+  string requirements = 5;
+  string team_metadata_json = 6;
+  string pipeline_definition_id = 7;
+}
+
+message UpdateJobResponse {
+  Job job = 1;
+}
+
+message CloseJobRequest {
+  string job_id = 1;
+}
+
+message CloseJobResponse {
+  string status = 1;
+}
+
+// --- Applications ---
+
+message ApplyToJobRequest {
+  string job_id = 1;
+}
+
+message ApplyToJobResponse {
+  string application_id = 1;
+}
+
+message Application {
+  string application_id = 1;
+  string job_id = 2;
+  string candidate_user_id = 3;
+  string current_stage = 4;
+  string applied_at = 5;
+  string job_title = 6;
+  string company_id = 7;
+}
+
+message GetApplicationRequest {
+  string application_id = 1;
+}
+
+message GetApplicationResponse {
+  string application_id = 1;
+  string job_id = 2;
+  string candidate_user_id = 3;
+  string current_stage = 4;
+  string applied_at = 5;
+  string requirements = 6;
+  string team_metadata_json = 7;
+}
+
+message ListApplicationsRequest {
+  string status_filter = 1; // filter by job status or application stage — optional stage substring
+  string stage_filter = 2;
+  PageRequest page = 3;
+}
+
+message ListApplicationsResponse {
+  repeated Application applications = 1;
+  PageResponse page = 2;
+}
+
+message ListApplicationsForJobRequest {
+  string job_id = 1;
+  PageRequest page = 2;
+}
+
+message ListApplicationsForJobResponse {
+  repeated Application applications = 1;
+  PageResponse page = 2;
+}
+
+message ListApplicationsForCandidateRequest {
+  // If empty, hiring uses candidate user id from verified token (recommended for gateway).
+  string candidate_user_id = 1;
+  PageRequest page = 2;
+}
+
+message ListApplicationsForCandidateResponse {
+  repeated Application applications = 1;
+  PageResponse page = 2;
+}
+
+// --- Pipeline ---
+
+message TransitionApplicationStageRequest {
+  string application_id = 1;
+  string target_stage = 2;
+  string reason = 3;
+}
+
+message TransitionApplicationStageResponse {
+  string current_stage = 1;
+}
+
+message RecordRecruiterDecisionRequest {
+  string application_id = 1;
+  string stage_context = 2;
+  string outcome = 3;
+  string reasoning = 4;
+  map<string, string> manual_inputs = 5;
+}
+
+message RecordRecruiterDecisionResponse {
+  string decision_id = 1;
+}
+
+message RecordScreeningResultRequest {
+  string application_id = 1;
+  double score = 2;
+  string explanation = 3;
+  string skill_extractions_json = 4;
+  string source_model_id = 5;
+  string raw_output_ref = 6;
+}
+
+message RecordScreeningResultResponse {
+  string screening_result_id = 1;
+}
+
+message RecordInterviewRequest {
+  string application_id = 1;
+  string scheduled_at = 2; // RFC3339 or empty
+  string actual_at = 3;
+  string notes = 4;
+  string transcript_ref = 5;
+  string structured_scores_json = 6;
+}
+
+message RecordInterviewResponse {
+  string interview_record_id = 1;
+}
+
+message LinkAssessmentRequest {
+  string application_id = 1;
+  string external_assessment_id = 2;
+  string status = 3;
+  string score_summary = 4;
+}
+
+message LinkAssessmentResponse {
+  string assessment_link_id = 1;
+}
+
+message RecordOfferRequest {
+  string application_id = 1;
+  string terms = 2;
+  string status = 3;
+}
+
+message RecordOfferResponse {
+  string offer_id = 1;
+}
+
+message ApplicationEvent {
+  string event_id = 1;
+  string application_id = 2;
+  string from_stage = 3;
+  string to_stage = 4;
+  string actor_type = 5;
+  string actor_user_id = 6;
+  string metadata_json = 7;
+  string created_at = 8;
+}
+
+message ListApplicationEventsRequest {
+  string application_id = 1;
+  PageRequest page = 2;
+}
+
+message ListApplicationEventsResponse {
+  repeated ApplicationEvent events = 1;
+  PageResponse page = 2;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@in-human-resources/backend-proto",
-  "version": "0.1.3",
-  "description": "Protobuf-ES and Connect-ES generated clients for api.v1, auth.v1, and common.v1",
+  "version": "0.1.5",
+  "description": "Protobuf-ES and Connect-ES generated clients for api.v1, auth.v1, hiring.v1, workflow.v1, and common.v1",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
@@ -9,6 +9,8 @@
     "gen/ts",
     "api",
     "auth",
+    "hiring",
+    "workflow",
     "common",
     "buf.yaml",
     "buf.gen.yaml"

package/workflow/v1/service.proto

@@ -0,0 +1,87 @@
+syntax = "proto3";
+
+package workflow.v1;
+
+option go_package = "github.com/InHuman-Resources/Backend/Go/proto/gen/workflow/v1;workflowv1";
+
+// WorkflowService is private: API gateway and approved internal callers only.
+// Drives Temporal application lifecycle; product clients use api.v1.HiringService.
+service WorkflowService {
+  // StartApplicationLifecycle starts (or idempotently re-attaches to) the root workflow for one application.
+  rpc StartApplicationLifecycle(StartApplicationLifecycleRequest) returns (StartApplicationLifecycleResponse);
+
+  rpc CancelWorkflow(CancelWorkflowRequest) returns (CancelWorkflowResponse);
+
+  // Human / domain signals (Temporal signal names match RPC suffixes where applicable).
+  rpc SignalRecruiterDecision(SignalRecruiterDecisionRequest) returns (SignalRecruiterDecisionResponse);
+  rpc SignalAssessmentCompleted(SignalAssessmentCompletedRequest) returns (SignalAssessmentCompletedResponse);
+  rpc SignalInterviewBooked(SignalInterviewBookedRequest) returns (SignalInterviewBookedResponse);
+  rpc SignalOfferDecision(SignalOfferDecisionRequest) returns (SignalOfferDecisionResponse);
+
+  rpc GetWorkflowStatus(GetWorkflowStatusRequest) returns (GetWorkflowStatusResponse);
+}
+
+message StartApplicationLifecycleRequest {
+  string application_id = 1;
+  string job_id = 2;
+  string candidate_user_id = 3;
+  string company_id = 4;
+  // JSON-encoded hiring PipelineSnapshot; when set, workflow interprets steps from snapshot.
+  string pipeline_snapshot_json = 5;
+}
+
+message StartApplicationLifecycleResponse {
+  string workflow_id = 1;
+  string run_id = 2;
+}
+
+message CancelWorkflowRequest {
+  string application_id = 1;
+}
+
+message CancelWorkflowResponse {}
+
+message SignalRecruiterDecisionRequest {
+  string application_id = 1;
+  // approve advances pipeline; reject moves to rejected.
+  bool approve = 2;
+  string reason = 3;
+  map<string, string> manual_inputs = 4;
+}
+
+message SignalRecruiterDecisionResponse {}
+
+message SignalAssessmentCompletedRequest {
+  string application_id = 1;
+  string external_assessment_id = 2;
+}
+
+message SignalAssessmentCompletedResponse {}
+
+message SignalInterviewBookedRequest {
+  string application_id = 1;
+  string scheduled_at_rfc3339 = 2;
+}
+
+message SignalInterviewBookedResponse {}
+
+message SignalOfferDecisionRequest {
+  string application_id = 1;
+  bool accepted = 2;
+  string reason = 3;
+}
+
+message SignalOfferDecisionResponse {}
+
+message GetWorkflowStatusRequest {
+  string application_id = 1;
+}
+
+message GetWorkflowStatusResponse {
+  string workflow_id = 1;
+  string run_id = 2;
+  // Temporal workflow status name, e.g. RUNNING, COMPLETED.
+  string status = 3;
+  // Best-effort last known stage from workflow (may be empty if not yet started).
+  string last_known_stage = 4;
+}