openapi-sync 2.0.0 → 2.0.1

package/db.json

@@ -1 +1 @@
-{}
+{"tmc":{"openapi":"3.0.3","info":{"title":"TMC Automation API Docs (v1)","version":"1.8.1"},"servers":[{"url":"https://api.tmcng.net/api/v1"}],"tags":[{"name":"User","description":"Users APIs"},{"name":"MembershipRequest","description":"Handle request of users to become a member"}],"components":{"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"User.OtpResponse":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"]},"User.SignupOptions":{"type":"object","properties":{"emailAddress":{"type":"string"},"password":{"type":"string"},"surname":{"type":"string"},"othernames":{"type":"string"},"country":{"type":"string"},"address":{"type":"string"},"phoneNumber":{"type":"string"}},"required":["emailAddress","password","surname","othernames","country","address","phoneNumber"]},"User.Profile":{"type":"object","properties":{"user_id":{"type":"string"},"email_address":{"type":"string"},"scopes":{"type":"array","items":{"type":"number","enum":[0,1,2,3,4,5]}},"name":{"type":"string"},"surname":{"type":"string"},"othernames":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"local_government_area":{"type":"string"},"branch":{"type":"string"},"address":{"type":"string"},"phone_number":{"type":"string"},"date_of_birth":{"type":"string"},"state_of_origin":{"type":"string"},"lga_of_origin":{"type":"string"},"whatsapp_number":{"type":"string"},"genotype":{"type":"string"},"blood_group":{"type":"string"},"specific_ailment":{"type":"string"},"hospital":{"type":"string"},"qualification":{"type":"string"},"occupation":{"type":"string"},"specialization":{"type":"string"},"years_of_experience":{"type":"number"},"membership_duration":{"type":"number"}},"required":["user_id","email_address","scopes","name","surname","othernames","country","state","local_government_area","branch","address","phone_number","date_of_birth","state_of_origin","lga_of_origin","whatsapp_number","genotype","blood_group","specific_ailment","hospital","qualification","occupation","specialization","years_of_experience","membership_duration"]},"User.LoginResponse":{"type":"object","properties":{"userId":{"type":"string"},"token":{"type":"string"}},"required":["userId","token"]},"User.MembershipStatusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["Member","NonMember","Pending","Denied"]}},"required":["status"]},"User.AuthenticationResponse":{"type":"object","properties":{"authenticated":{"type":"boolean"},"userId":{"type":"string"}},"required":["authenticated","userId"]},"User.InitialLoadData":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/User.Profile"},"membershipStatus":{"type":"string","enum":["Member","NonMember","Pending","Denied"]}},"required":["profile","membershipStatus"]},"User.OtpValidationResponse":{"type":"object","properties":{"validated":{"type":"boolean"},"message":{"type":"string"}},"required":["validated","message"]},"User.SignupResponse":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"userId":{"type":"string"}},"required":["userId"]}},"required":["message"]},"Database.DbAccessTokens":{"type":"object","properties":{"id":{"type":"number"},"token":{"type":"string"},"user_id":{"type":"string"},"created_at":{"type":"string"}},"required":["id","token","user_id","created_at"]},"Database.DbApp":{"type":"object","properties":{"id":{"type":"number"},"property":{"type":"string"},"value":{"type":"string"}},"required":["id","property","value"]},"Database.DbMembershipRequests":{"type":"object","properties":{"id":{"type":"number"},"user_id":{"type":"string"},"state":{"type":"string"},"local_government_area":{"type":"string"},"branch":{"type":"string"},"date_of_birth":{"type":"string"},"state_of_origin":{"type":"string"},"lga_of_origin":{"type":"string"},"whatsapp_number":{"type":"string"},"genotype":{"type":"string"},"blood_group":{"type":"string"},"specific_ailment":{"type":"string"},"hospital":{"type":"string"},"qualification":{"type":"string"},"occupation":{"type":"string"},"specialization":{"type":"string"},"years_of_experience":{"type":"number"},"membership_duration":{"type":"number"},"reviewed_by":{"type":"string"},"status":{"type":"string"},"reviewed_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","user_id","state","local_government_area","branch","date_of_birth","state_of_origin","lga_of_origin","whatsapp_number","genotype","blood_group","specific_ailment","hospital","qualification","occupation","specialization","years_of_experience","membership_duration","status","created_at"]},"Database.DbOtps":{"type":"object","properties":{"id":{"type":"number"},"token":{"type":"string"},"otp":{"type":"string"},"created_at":{"type":"string"}},"required":["id","token","otp","created_at"]},"Database.DbUsers":{"type":"object","properties":{"id":{"type":"number"},"user_id":{"type":"string"},"membership_id":{"type":"string"},"email_address":{"type":"string"},"surname":{"type":"string"},"othernames":{"type":"string"},"phone_number":{"type":"string"},"password":{"type":"string"},"country":{"type":"string"},"local_government_area":{"type":"string"},"scopes":{"type":"string"},"state":{"type":"string"},"branch":{"type":"string"},"address":{"type":"string"},"date_of_birth":{"type":"string"},"state_of_origin":{"type":"string"},"lga_of_origin":{"type":"string"},"whatsapp_number":{"type":"string"},"genotype":{"type":"string"},"blood_group":{"type":"string"},"specific_ailment":{"type":"string"},"hospital":{"type":"string"},"qualification":{"type":"string"},"occupation":{"type":"string"},"specialization":{"type":"string"},"years_of_experience":{"type":"number"},"membership_duration":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","email_address","surname","othernames","phone_number","password","country","local_government_area","state","branch","address","date_of_birth","state_of_origin","lga_of_origin","whatsapp_number","genotype","blood_group","specific_ailment","hospital","qualification","occupation","specialization","years_of_experience","membership_duration","created_at","updated_at"]},"MembershipRequest.CreateOptions":{"type":"object","properties":{"state":{"type":"string"},"local_government_area":{"type":"string"},"branch":{"type":"string"},"date_of_birth":{"type":"string"},"state_of_origin":{"type":"string"},"lga_of_origin":{"type":"string"},"whatsapp_number":{"type":"string"},"genotype":{"type":"string"},"blood_group":{"type":"string"},"specific_ailment":{"type":"string"},"hospital":{"type":"string"},"qualification":{"type":"string"},"occupation":{"type":"string"},"specialization":{"type":"string"},"years_of_experience":{"type":"number"},"membership_duration":{"type":"number"}},"required":["state","local_government_area","branch","date_of_birth","state_of_origin","lga_of_origin","whatsapp_number","genotype","blood_group","specific_ailment","hospital","qualification","occupation","specialization","years_of_experience","membership_duration"]},"MembershipRequest.ReviewResponse":{"type":"object","properties":{"status":{"type":"string","enum":["Denied","Approved"]},"approved":{"type":"boolean"},"data":{"$ref":"#/components/schemas/MembershipRequest.ReviewResponseData"}},"required":["status","approved"]},"MembershipRequest.ReviewResponseData":{"type":"object","properties":{"membershipId":{"type":"string"}},"required":["membershipId"]},"Email.Email":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"subject":{"type":"string"},"body":{"type":"string"}},"required":["from","to","subject","body"]},"Email.SendEmailResponse":{"type":"object","properties":{"sent":{"type":"boolean"},"message":{"type":"string"}},"required":["sent","message"]},"Database.Column":{"type":"object","properties":{"Field":{"type":"string"},"Type":{"type":"string"},"Null":{"type":"string"},"Key":{"type":"string"},"Default":{"type":"string"},"Extra":{"type":"string"}},"required":["Field","Type","Null","Key","Extra"]},"Database.AccessTokens":{"type":"string","enum":["access_tokens","id","token","user_id","created_at"]},"Database.App":{"type":"string","enum":["app","id","property","value"]},"Database.MembershipRequests":{"type":"string","enum":["membership_requests","id","user_id","state","local_government_area","branch","date_of_birth","state_of_origin","lga_of_origin","whatsapp_number","genotype","blood_group","specific_ailment","hospital","qualification","occupation","specialization","years_of_experience","membership_duration","reviewed_by","status","reviewed_at","created_at"]},"Database.Otps":{"type":"string","enum":["otps","id","token","otp","created_at"]},"Database.Users":{"type":"string","enum":["users","id","user_id","membership_id","email_address","surname","othernames","phone_number","password","country","local_government_area","scopes","state","branch","address","date_of_birth","state_of_origin","lga_of_origin","whatsapp_number","genotype","blood_group","specific_ailment","hospital","qualification","occupation","specialization","years_of_experience","membership_duration","created_at","updated_at"]},"Aw.Bx.Cy.E":{"type":"object","properties":{"fgh":{"type":"string"}},"required":["fgh"]},"Aw.Bx.Cy.Dz.J":{"type":"object","properties":{"fghlll":{"type":"string"}},"required":["fghlll"]},"Update.Manifest":{"type":"object","properties":{"version":{"type":"string"}},"required":["version"]},"Update.UpdateConfig":{"type":"object","properties":{"scripts":{"type":"array","items":{"type":"string"}},"commit":{"type":"string"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"BadRequest":{"description":"Error occurred in request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Error occurred in request"}}}}}}},"parameters":{}},"paths":{"/user/login":{"post":{"tags":["User"],"summary":"Login to user account","operationId":"postUserLogin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string"},"password":{"type":"string"}},"required":["email_address","password"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.LoginResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/generate-otp":{"post":{"tags":["User"],"summary":"Generate OTP to be sent to user's email address when creating new account","operationId":"postUserGenerateOtp","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string"}},"required":["email_address"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.OtpResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/validate-otp":{"post":{"tags":["User"],"summary":"Validate OTP sent by user to server","operationId":"postUserValidateOtp","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"user_otp":{"type":"string"}},"required":["token","user_otp"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.OtpValidationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/create":{"post":{"tags":["User"],"summary":"Create new user account","operationId":"postUserCreate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"surname":{"type":"string"},"othernames":{"type":"string"},"email_address":{"type":"string","format":"email"},"country":{"type":"string"},"address":{"type":"string"},"phone_number":{"type":"string"},"password":{"type":"string","minLength":8}},"required":["surname","othernames","email_address","country","address","phone_number","password"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.SignupResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/profile":{"get":{"tags":["User"],"summary":"Get user profile","description":"```Scopes: []```","operationId":"getUserProfile","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.Profile"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/initial-load-data":{"get":{"tags":["User"],"summary":"Get all common data needed to load frontend pages","description":"```Scopes: []```","operationId":"getUserInitialLoadData","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.InitialLoadData"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/update-scopes/{userId}":{"post":{"tags":["User"],"summary":"Updates scopes of user","description":"```Scopes: [Scope.Developer]```","operationId":"postUserUpdateScopesByUserId","security":[{"bearerAuth":[]}],"parameters":[{"name":"userId","description":"User ID of the user whose scopes are to be updated","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scopes":{"type":"string"}},"required":["scopes"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/membership-status":{"get":{"tags":["User"],"summary":"Get membership status of user","description":"```Scopes: []```","operationId":"getUserMembershipStatus","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.MembershipStatusResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/membership-request/create":{"post":{"tags":["MembershipRequest"],"summary":"Create new membership request","description":"```Scopes: []```","operationId":"postUserMembershipRequestCreate","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string"},"local_government_area":{"type":"string"},"branch":{"type":"string"},"date_of_birth":{"type":"string"},"state_of_origin":{"type":"string"},"lga_of_origin":{"type":"string"},"whatsapp_number":{"type":"string"},"genotype":{"type":"string"},"blood_group":{"type":"string"},"specific_ailment":{"type":"string"},"hospital":{"type":"string"},"qualification":{"type":"string"},"occupation":{"type":"string"},"specialization":{"type":"string"},"years_of_experience":{"type":"number"},"membership_duration":{"type":"number"}},"required":["state","local_government_area","branch","date_of_birth","state_of_origin","lga_of_origin","whatsapp_number","genotype","blood_group","specific_ailment","hospital","qualification","occupation","specialization","years_of_experience","membership_duration"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/membership-request/data":{"get":{"tags":["MembershipRequest"],"summary":"Membership request data","description":"```Scopes: []```","operationId":"getUserMembershipRequestData","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Database.DbMembershipRequests"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/membership-request/pending-requests":{"get":{"tags":["MembershipRequest"],"summary":"All pending requests to be reviewed by an admin user","description":"```Scopes: [Clearance.from(Scope.BranchExecutive)]```","operationId":"getUserMembershipRequestPendingRequests","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Database.DbMembershipRequests"}}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/membership-request/review/{requesterId}":{"post":{"tags":["MembershipRequest"],"summary":"All pending requests to be reviewed by an admin user","description":"```Scopes: [Clearance.from(Scope.BranchExecutive)]```","operationId":"postUserMembershipRequestReviewByRequesterId","security":[{"bearerAuth":[]}],"parameters":[{"name":"requesterId","description":"User ID of the user that made the membership request","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Denied","Approved"]}},"required":["status"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipRequest.ReviewResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/user/membership-request/list":{"get":{"tags":["MembershipRequest"],"summary":"All pending requests in database","description":"```Scopes: [Scope.Developer]```","operationId":"getUserMembershipRequestList","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Database.DbMembershipRequests"}}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}}}}}

package/dist/Openapi-sync/components/helpers.js

@@ -23,7 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JSONStringify = exports.getEndpointDetails = exports.capitalize = exports.yamlStringToJson = exports.isYamlString = exports.isJson = void 0;
+exports.renderTypeRefMD = exports.JSONStringify = exports.getEndpointDetails = exports.capitalize = exports.yamlStringToJson = exports.isYamlString = exports.isJson = void 0;
+exports.getNestedValue = getNestedValue;
 const regex_1 = require("./regex");
 const yaml = __importStar(require("js-yaml"));
 const isJson = (value) => {
@@ -99,24 +100,46 @@ const getEndpointDetails = (path, method) => {
     return { name, variables, pathParts };
 };
 exports.getEndpointDetails = getEndpointDetails;
-const JSONStringify = (obj) => {
+const JSONStringify = (obj, indent = 1) => {
     let result = "{";
     const keys = Object.keys(obj);
     for (let i = 0; i < keys.length; i++) {
         const key = keys[i];
         const value = obj[key];
-        result += key + ": ";
+        result += "\n" + "    ".repeat(indent) + key + ": ";
         if (typeof value === "object" && value !== null) {
-            result += (0, exports.JSONStringify)(value);
+            result += "" + (0, exports.JSONStringify)(value, indent + 1);
         }
         else {
-            result += value;
+            result += value
+                .split("\n")
+                .filter((line) => line.trim() !== "")
+                .join(`\n${"    ".repeat(indent)}`);
         }
         if (i < keys.length - 1) {
             result += ", ";
         }
     }
-    result += "}";
+    result += `\n${"    ".repeat(indent - 1)}}`;
     return result;
 };
 exports.JSONStringify = JSONStringify;
+const renderTypeRefMD = (typeRef, indent = 1) => {
+    return `\n\`\`\`typescript\n${"  ".repeat(indent)}  ${typeRef
+        .split("\n")
+        .filter((line) => line.trim() !== "")
+        .join(`\n${"  ".repeat(indent)}  `)}\n\`\`\``;
+};
+exports.renderTypeRefMD = renderTypeRefMD;
+function getNestedValue(obj, path) {
+    // Split the path string into an array of keys
+    const keys = path.split(".");
+    // Use the reduce method to navigate the object
+    return keys.reduce((currentObj, key) => {
+        // If the current object is not null or undefined,
+        // return the value of the next key. Otherwise, return undefined.
+        return currentObj && currentObj[key] !== undefined
+            ? currentObj[key]
+            : undefined;
+    }, obj);
+}