@ssoeasy-dev/proto 1.1.0-beta.1

package/gen/ts/index.ts

@@ -0,0 +1,8 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.5
+//   protoc               unknown
+
+/* eslint-disable */
+
+export * as common from "./index.common";

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@ssoeasy-dev/proto",
+  "version": "1.1.0-beta.1",
+  "description": "gRPC proto contracts and generated TypeScript clients for SSOEasy",
+  "main": "gen/ts/index.ts",
+  "types": "gen/ts/index.ts",
+  "exports": {
+    ".": {
+      "types": "./gen/ts/index.ts",
+      "default": "./gen/ts/index.ts"
+    },
+    "./auth": {
+      "types": "./gen/ts/index.auth.ts",
+      "default": "./gen/ts/index.auth.ts"
+    },
+    "./companies": {
+      "types": "./gen/ts/index.companies.ts",
+      "default": "./gen/ts/index.companies.ts"
+    },
+    "./common": {
+      "types": "./gen/ts/index.common.ts",
+      "default": "./gen/ts/index.common.ts"
+    }
+  },
+  "files": [
+    "gen/ts/**/*",
+    "proto/**/*.proto",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@bufbuild/protobuf": "^2.0.0",
+    "long": "^5.2.3",
+    "nice-grpc": "^2.1.10",
+    "nice-grpc-common": "^2.0.2",
+    "rxjs": "7.8.2"
+  },
+  "devDependencies": {
+    "semver": "^7.6.0",
+    "ts-proto": "2.11.5"
+  },
+  "peerDependencies": {
+    "@grpc/grpc-js": "^1.9.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ssoeasy-dev/proto.git"
+  },
+  "keywords": [
+    "grpc",
+    "proto",
+    "typescript",
+    "sso",
+    "ssoeasy"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "generate": "buf generate --template buf.gen.ts.yaml",
+    "clean": "rm -rf gen/ts"
+  }
+}

package/proto/auth/v1/auth.proto

@@ -0,0 +1,89 @@
+syntax = "proto3";
+
+package auth.v1;
+
+import "auth/v1/common.proto";
+import "auth/v1/user_policy.proto";
+import "auth/v1/verification.proto";
+import "common/v1/types.proto";
+
+service AuthService {
+  rpc Registration(RegistrationRequest) returns (RegistrationResponse);
+  rpc RegistrationCompensate(RegistrationCompensateRequest) returns (common.v1.StatusResponse);
+  rpc Login(LoginRequest) returns (LoginResponse);
+  rpc Authorize(AuthorizeRequest) returns (auth.v1.Tokens);
+  rpc Logout(Tokens) returns (common.v1.StatusResponse);
+  rpc GetMe(GetMeRequest) returns (GetMeResponse);
+  rpc GetCompanyIdByCode(GetCompanyIdByCodeRequest) returns (GetCompanyIdByCodeResponse);
+}
+
+message GetMeRequest {
+  string token = 1;
+}
+
+message GetMeResponse {
+  string user_id = 1;
+  string login = 2;
+}
+
+message AuthCode {
+  string id = 1;
+  string value = 2;
+  int64 expires_at = 3;
+}
+
+message RegistrationRequest {
+  string login = 1;
+  string password = 2;
+  optional auth.v1.VerificationType verification_type = 3;
+  repeated auth.v1.UserPolicyRequest policies = 4;
+}
+
+message RegistrationResponse {
+  string user_id = 1;
+  string credential_id = 2;
+  repeated auth.v1.UserPolicyResponse policies = 3;
+  optional auth.v1.Verification verification = 4;
+}
+
+message RegistrationCompensateRequest {
+  string user_id = 1;
+  string credential_id = 2;
+  optional string verification_id = 3;
+  repeated string policy_ids = 4;
+}
+
+message LoginRequest {
+  string login = 1;
+  string password = 2;
+  string code_challenge = 3;
+  string service_id = 4;
+  optional auth.v1.VerificationType verification_type = 5;
+}
+
+message LoginResponse {
+  optional AuthCode code = 1;
+  optional auth.v1.Verification verification = 2;
+}
+
+message CodeVerifier {
+  string code = 1;
+  string verifier = 2;
+}
+
+message AuthorizeRequest {
+  string service_id = 1;
+  optional auth.v1.Tokens tokens = 2;
+  optional CodeVerifier code = 3;
+  string company_id = 4;
+}
+
+message GetCompanyIdByCodeRequest {
+  string code = 1;
+  string service_id = 2;
+}
+
+message GetCompanyIdByCodeResponse {
+  string user_id = 1;
+  optional string company_id = 2;
+}

package/proto/auth/v1/common.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+package auth.v1;
+
+message Tokens {
+  string access = 1;
+  string refresh = 2;
+}

package/proto/auth/v1/permission.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package auth.v1;
+
+import "common/v1/types.proto";
+
+service PermissionService {
+  rpc CheckPermission(CheckPermissionRequest) returns (common.v1.StatusResponse);
+}
+
+message CheckPermissionRequest {
+  string id = 1;
+  string token = 2;
+  optional string company_id = 3;
+}

package/proto/auth/v1/user_policy.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+package auth.v1;
+
+enum AttributeType {
+  ATTRIBUTE_TYPE_UNSPECIFIED = 0;
+  ATTRIBUTE_TYPE_BOOLEAN = 1;
+  ATTRIBUTE_TYPE_STRING = 2;
+  ATTRIBUTE_TYPE_NUMBER = 3;
+}
+
+message Attribute {
+  string name = 1;
+  string operator = 2;
+  string value = 3;
+}
+
+message UserPolicyRequest {
+  string name = 1;
+  string service_id = 2;
+  optional string company_id = 3;
+}
+
+message UserPolicyResponse {
+  string id = 1;
+  string name = 2;
+  string service_id = 3;
+  optional string company_id = 4;
+  repeated Attribute attributes = 5;
+}

package/proto/auth/v1/verification.proto

@@ -0,0 +1,48 @@
+syntax = "proto3";
+
+package auth.v1;
+
+import "common/v1/types.proto";
+
+service VerificationService {
+  rpc Verificate(VerificateRequest) returns (common.v1.StatusResponse);
+  rpc Refresh(RefreshRequest) returns (Verification);
+  rpc CheckStatus(CheckStatusRequest) returns (CheckStatusResponse);
+}
+
+enum VerificationType {
+  VERIFICATION_TYPE_UNSPECIFIED = 0;
+  VERIFICATION_TYPE_EMAIL_CODE = 1;
+  VERIFICATION_TYPE_EMAIL_LINK = 2;
+}
+
+message Verification {
+  string id = 1;
+  string value = 2;
+  int64 expires_at = 3;
+}
+
+message VerificateRequest {
+  string id = 1;
+  string value = 2;
+}
+
+message RefreshRequest {
+  string user_id = 1;
+  VerificationType type = 2;
+}
+
+enum VerificationStatus {
+  VERIFICATION_STATUS_UNSPECIFIED = 0;
+  VERIFICATION_STATUS_WAIT = 1;
+  VERIFICATION_STATUS_EXPIRES = 2;
+  VERIFICATION_STATUS_VERIFIED = 3;
+}
+
+message CheckStatusRequest {
+  string id = 1;
+}
+
+message CheckStatusResponse {
+  VerificationStatus status = 1;
+}

package/proto/common/v1/types.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+package common.v1;
+
+message StatusResponse {
+  bool success = 1;
+}

package/proto/companies/v1/employee.proto

@@ -0,0 +1,26 @@
+syntax = "proto3";
+
+package companies.v1;
+
+service EmployeeService {
+  rpc GetByUserId(GetByUserIdRequest) returns (GetByUserIdResponse);
+}
+
+message GetByUserIdRequest {
+  string user_id = 1;
+  optional string service_id = 2;
+}
+
+message EmployeeCompany {
+  string id = 1;
+  string name = 2;
+  optional string service_name = 3;
+  optional string subscription_id = 4;
+  optional bool subscription_is_active = 5;
+}
+
+message GetByUserIdResponse {
+  string firstname = 1;
+  string lastname = 2;
+  repeated EmployeeCompany companies = 3;
+}

package/proto/companies/v1/owner.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package companies.v1;
+
+import "common/v1/types.proto";
+
+service OwnerService {
+  rpc RegisterOwner(RegisterOwnerRequest) returns (RegisterOwnerResponse);
+  rpc RegisterOwnerCompensate(RegisterOwnerResponse) returns (common.v1.StatusResponse);
+}
+
+message RegisterOwnerRequest {
+  string email = 1;
+  string firstname = 2;
+  string lastname = 3;
+}
+
+message RegisterOwnerResponse {
+  string company_id = 1;
+  string employee_id = 2;
+  string subscription_id = 3;
+  string employee_company_id = 4;
+}

package/proto/companies/v1/service.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+package companies.v1;
+
+import "common/v1/types.proto";
+
+service ServiceService {
+  rpc CheckUri(CheckUriRequest) returns (common.v1.StatusResponse);
+}
+
+message CheckUriRequest {
+  string uri = 1;
+  string service_id = 2;
+}

package/proto/companies/v1/subscription.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+package companies.v1;
+
+import "common/v1/types.proto";
+
+service SubscriptionService {
+  rpc CheckSubscription(CheckSubscriptionRequest) returns (common.v1.StatusResponse);
+}
+
+message CheckSubscriptionRequest {
+  string company_id = 1;
+  string service_id = 2;
+}