@approvio/api 0.0.29 → 0.0.31

package/README.md

@@ -1,6 +1,17 @@
 # Approvio API
 
-This repository contains the OpenAPI specification for the Approvio backend and the tooling to generate the TypeScript API client.
+This repository contains the OpenAPI specification for the Approvio backend, the tooling to generate the TypeScript API client, and TypeScript validators for the generated models using `fp-ts`.
+
+
+## Project Structure
+
+- `openapi.yaml`: Main entry point for the OpenAPI 3.0 specification.
+- `openapi/`: Directory containing split OpenAPI specification files referenced by the main `openapi.yaml`.
+- `src/`: Source code directory.
+  - `src/validators/`: TypeScript validators for the generated OpenAPI models using `fp-ts/Either`.
+  - `src/utils/`: Utility functions, including custom Jest matchers for testing validators.
+- `test/`: Test directory containing unit tests for the validators.
+- `generated/`: Auto-generated output directory containing the TypeScript API client models and code.
 
 ## Getting Started
 

package/dist/mocks/index.cjs

@@ -0,0 +1,137 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region mocks/user.fixtures.ts
+const MOCK_USER_ID = "e6e08687-2189-4710-91b5-479cd25a9119";
+const MOCK_ADMIN_USER_ID = "2d099b40-099f-4975-9320-e52aacfaccd6";
+const memberUserResponse = {
+	id: MOCK_USER_ID,
+	displayName: "Test User",
+	email: "test@localhost.com",
+	orgRole: "member",
+	createdAt: "2026-03-08T12:00:00Z"
+};
+const adminUserResponse = {
+	id: MOCK_ADMIN_USER_ID,
+	displayName: "Admin User",
+	email: "admin@localhost.com",
+	orgRole: "admin",
+	createdAt: "2026-03-08T12:00:00Z"
+};
+const userSummaryResponse = {
+	id: memberUserResponse.id,
+	displayName: memberUserResponse.displayName,
+	email: memberUserResponse.email
+};
+//#endregion
+//#region mocks/pagination.fixture.ts
+/**
+* Mock a Pagination response with a single element
+*/
+const singleItemPaginationResponse = {
+	total: 1,
+	page: 0,
+	limit: 10
+};
+/**
+* Mock a Pagination response where total is <= limit
+*/
+const singlePagePaginationResponse = {
+	total: 10,
+	page: 0,
+	limit: 10
+};
+/**
+* Mock a Pagination response where total is > limit
+*/
+const multiPagePaginationResponse = {
+	total: 20,
+	page: 0,
+	limit: 10
+};
+/**
+* Mock Pagination responses that exhaust all pages
+*/
+const exhaustedPaginationResponses = [{
+	total: 20,
+	page: 0,
+	limit: 10
+}, {
+	total: 20,
+	page: 1,
+	limit: 10
+}];
+//#endregion
+//#region mocks/group.fixtures.ts
+const MOCK_GROUP_ID = "3d3f1904-3c8e-497c-9829-f0b3508e1481";
+const groupResponse = {
+	id: MOCK_GROUP_ID,
+	name: "Engineering Team",
+	description: "All engineering staff",
+	entitiesCount: 15,
+	createdAt: "2026-03-08T12:00:00Z",
+	updatedAt: "2026-03-08T12:00:00Z"
+};
+const groupInfoResponse = {
+	groupId: MOCK_GROUP_ID,
+	groupName: groupResponse.name
+};
+const singleItemListGroupsResponse = {
+	groups: [groupResponse],
+	pagination: singleItemPaginationResponse
+};
+//#endregion
+//#region mocks/workflow.fixtures.ts
+const MOCK_WORKFLOW_ID = "af20e7fc-66c0-420e-8f35-bf5c1071e6a9";
+const MOCK_WORKFLOW_TEMPLATE_ID = "5932b816-16de-4334-a85c-f32315a6a49d";
+const workflowResponse = {
+	id: MOCK_WORKFLOW_ID,
+	name: "Deploy Production Release",
+	description: "Approval for releasing feature X to production.",
+	status: "PENDING",
+	workflowTemplateId: MOCK_WORKFLOW_TEMPLATE_ID,
+	metadata: {
+		env: "prod",
+		ticket: "PROJ-1234"
+	},
+	createdAt: "2026-03-08T12:00:00Z",
+	updatedAt: "2026-03-08T12:00:00Z",
+	expiresAt: "2026-03-10T12:00:00Z"
+};
+const workflowCreateResponse = {
+	name: "Deploy Production Release",
+	description: "Approval for releasing feature X to production.",
+	workflowTemplateId: MOCK_WORKFLOW_TEMPLATE_ID,
+	metadata: {
+		env: "prod",
+		ticket: "PROJ-1234"
+	}
+};
+const singleItemListWorkflowsResponse = {
+	data: [workflowResponse],
+	pagination: singleItemPaginationResponse
+};
+//#endregion
+//#region mocks/auth.fixtures.ts
+const tokenResponse = {
+	accessToken: "mock_access_token",
+	refreshToken: "mock_refresh_token"
+};
+//#endregion
+exports.MOCK_ADMIN_USER_ID = MOCK_ADMIN_USER_ID;
+exports.MOCK_GROUP_ID = MOCK_GROUP_ID;
+exports.MOCK_USER_ID = MOCK_USER_ID;
+exports.MOCK_WORKFLOW_ID = MOCK_WORKFLOW_ID;
+exports.MOCK_WORKFLOW_TEMPLATE_ID = MOCK_WORKFLOW_TEMPLATE_ID;
+exports.adminUserResponse = adminUserResponse;
+exports.exhaustedPaginationResponses = exhaustedPaginationResponses;
+exports.groupInfoResponse = groupInfoResponse;
+exports.groupResponse = groupResponse;
+exports.memberUserResponse = memberUserResponse;
+exports.multiPagePaginationResponse = multiPagePaginationResponse;
+exports.singleItemListGroupsResponse = singleItemListGroupsResponse;
+exports.singleItemListWorkflowsResponse = singleItemListWorkflowsResponse;
+exports.singleItemPaginationResponse = singleItemPaginationResponse;
+exports.singlePagePaginationResponse = singlePagePaginationResponse;
+exports.tokenResponse = tokenResponse;
+exports.userSummaryResponse = userSummaryResponse;
+exports.workflowCreateResponse = workflowCreateResponse;
+exports.workflowResponse = workflowResponse;

package/dist/mocks/index.d.cts

@@ -0,0 +1,44 @@
+import { a as Workflow, d as ListGroups200Response, f as Pagination, i as ListWorkflows200Response, m as GroupInfo, n as User, p as Group, r as TokenResponse, t as WorkflowCreate, u as UserSummary } from "../workflow-create-Dgj7wWZs.cjs";
+
+//#region mocks/user.fixtures.d.ts
+declare const MOCK_USER_ID = "e6e08687-2189-4710-91b5-479cd25a9119";
+declare const MOCK_ADMIN_USER_ID = "2d099b40-099f-4975-9320-e52aacfaccd6";
+declare const memberUserResponse: User;
+declare const adminUserResponse: User;
+declare const userSummaryResponse: UserSummary;
+//#endregion
+//#region mocks/group.fixtures.d.ts
+declare const MOCK_GROUP_ID = "3d3f1904-3c8e-497c-9829-f0b3508e1481";
+declare const groupResponse: Group;
+declare const groupInfoResponse: GroupInfo;
+declare const singleItemListGroupsResponse: ListGroups200Response;
+//#endregion
+//#region mocks/workflow.fixtures.d.ts
+declare const MOCK_WORKFLOW_ID = "af20e7fc-66c0-420e-8f35-bf5c1071e6a9";
+declare const MOCK_WORKFLOW_TEMPLATE_ID = "5932b816-16de-4334-a85c-f32315a6a49d";
+declare const workflowResponse: Workflow;
+declare const workflowCreateResponse: WorkflowCreate;
+declare const singleItemListWorkflowsResponse: ListWorkflows200Response;
+//#endregion
+//#region mocks/auth.fixtures.d.ts
+declare const tokenResponse: TokenResponse;
+//#endregion
+//#region mocks/pagination.fixture.d.ts
+/**
+ * Mock a Pagination response with a single element
+ */
+declare const singleItemPaginationResponse: Pagination;
+/**
+ * Mock a Pagination response where total is <= limit
+ */
+declare const singlePagePaginationResponse: Pagination;
+/**
+ * Mock a Pagination response where total is > limit
+ */
+declare const multiPagePaginationResponse: Pagination;
+/**
+ * Mock Pagination responses that exhaust all pages
+ */
+declare const exhaustedPaginationResponses: Pagination[];
+//#endregion
+export { MOCK_ADMIN_USER_ID, MOCK_GROUP_ID, MOCK_USER_ID, MOCK_WORKFLOW_ID, MOCK_WORKFLOW_TEMPLATE_ID, adminUserResponse, exhaustedPaginationResponses, groupInfoResponse, groupResponse, memberUserResponse, multiPagePaginationResponse, singleItemListGroupsResponse, singleItemListWorkflowsResponse, singleItemPaginationResponse, singlePagePaginationResponse, tokenResponse, userSummaryResponse, workflowCreateResponse, workflowResponse };

package/dist/mocks/index.d.mts

@@ -0,0 +1,44 @@
+import { a as Workflow, d as ListGroups200Response, f as Pagination, i as ListWorkflows200Response, m as GroupInfo, n as User, p as Group, r as TokenResponse, t as WorkflowCreate, u as UserSummary } from "../workflow-create-DVgNnx0X.mjs";
+
+//#region mocks/user.fixtures.d.ts
+declare const MOCK_USER_ID = "e6e08687-2189-4710-91b5-479cd25a9119";
+declare const MOCK_ADMIN_USER_ID = "2d099b40-099f-4975-9320-e52aacfaccd6";
+declare const memberUserResponse: User;
+declare const adminUserResponse: User;
+declare const userSummaryResponse: UserSummary;
+//#endregion
+//#region mocks/group.fixtures.d.ts
+declare const MOCK_GROUP_ID = "3d3f1904-3c8e-497c-9829-f0b3508e1481";
+declare const groupResponse: Group;
+declare const groupInfoResponse: GroupInfo;
+declare const singleItemListGroupsResponse: ListGroups200Response;
+//#endregion
+//#region mocks/workflow.fixtures.d.ts
+declare const MOCK_WORKFLOW_ID = "af20e7fc-66c0-420e-8f35-bf5c1071e6a9";
+declare const MOCK_WORKFLOW_TEMPLATE_ID = "5932b816-16de-4334-a85c-f32315a6a49d";
+declare const workflowResponse: Workflow;
+declare const workflowCreateResponse: WorkflowCreate;
+declare const singleItemListWorkflowsResponse: ListWorkflows200Response;
+//#endregion
+//#region mocks/auth.fixtures.d.ts
+declare const tokenResponse: TokenResponse;
+//#endregion
+//#region mocks/pagination.fixture.d.ts
+/**
+ * Mock a Pagination response with a single element
+ */
+declare const singleItemPaginationResponse: Pagination;
+/**
+ * Mock a Pagination response where total is <= limit
+ */
+declare const singlePagePaginationResponse: Pagination;
+/**
+ * Mock a Pagination response where total is > limit
+ */
+declare const multiPagePaginationResponse: Pagination;
+/**
+ * Mock Pagination responses that exhaust all pages
+ */
+declare const exhaustedPaginationResponses: Pagination[];
+//#endregion
+export { MOCK_ADMIN_USER_ID, MOCK_GROUP_ID, MOCK_USER_ID, MOCK_WORKFLOW_ID, MOCK_WORKFLOW_TEMPLATE_ID, adminUserResponse, exhaustedPaginationResponses, groupInfoResponse, groupResponse, memberUserResponse, multiPagePaginationResponse, singleItemListGroupsResponse, singleItemListWorkflowsResponse, singleItemPaginationResponse, singlePagePaginationResponse, tokenResponse, userSummaryResponse, workflowCreateResponse, workflowResponse };

package/dist/mocks/index.mjs

@@ -0,0 +1,118 @@
+//#region mocks/user.fixtures.ts
+const MOCK_USER_ID = "e6e08687-2189-4710-91b5-479cd25a9119";
+const MOCK_ADMIN_USER_ID = "2d099b40-099f-4975-9320-e52aacfaccd6";
+const memberUserResponse = {
+	id: MOCK_USER_ID,
+	displayName: "Test User",
+	email: "test@localhost.com",
+	orgRole: "member",
+	createdAt: "2026-03-08T12:00:00Z"
+};
+const adminUserResponse = {
+	id: MOCK_ADMIN_USER_ID,
+	displayName: "Admin User",
+	email: "admin@localhost.com",
+	orgRole: "admin",
+	createdAt: "2026-03-08T12:00:00Z"
+};
+const userSummaryResponse = {
+	id: memberUserResponse.id,
+	displayName: memberUserResponse.displayName,
+	email: memberUserResponse.email
+};
+//#endregion
+//#region mocks/pagination.fixture.ts
+/**
+* Mock a Pagination response with a single element
+*/
+const singleItemPaginationResponse = {
+	total: 1,
+	page: 0,
+	limit: 10
+};
+/**
+* Mock a Pagination response where total is <= limit
+*/
+const singlePagePaginationResponse = {
+	total: 10,
+	page: 0,
+	limit: 10
+};
+/**
+* Mock a Pagination response where total is > limit
+*/
+const multiPagePaginationResponse = {
+	total: 20,
+	page: 0,
+	limit: 10
+};
+/**
+* Mock Pagination responses that exhaust all pages
+*/
+const exhaustedPaginationResponses = [{
+	total: 20,
+	page: 0,
+	limit: 10
+}, {
+	total: 20,
+	page: 1,
+	limit: 10
+}];
+//#endregion
+//#region mocks/group.fixtures.ts
+const MOCK_GROUP_ID = "3d3f1904-3c8e-497c-9829-f0b3508e1481";
+const groupResponse = {
+	id: MOCK_GROUP_ID,
+	name: "Engineering Team",
+	description: "All engineering staff",
+	entitiesCount: 15,
+	createdAt: "2026-03-08T12:00:00Z",
+	updatedAt: "2026-03-08T12:00:00Z"
+};
+const groupInfoResponse = {
+	groupId: MOCK_GROUP_ID,
+	groupName: groupResponse.name
+};
+const singleItemListGroupsResponse = {
+	groups: [groupResponse],
+	pagination: singleItemPaginationResponse
+};
+//#endregion
+//#region mocks/workflow.fixtures.ts
+const MOCK_WORKFLOW_ID = "af20e7fc-66c0-420e-8f35-bf5c1071e6a9";
+const MOCK_WORKFLOW_TEMPLATE_ID = "5932b816-16de-4334-a85c-f32315a6a49d";
+const workflowResponse = {
+	id: MOCK_WORKFLOW_ID,
+	name: "Deploy Production Release",
+	description: "Approval for releasing feature X to production.",
+	status: "PENDING",
+	workflowTemplateId: MOCK_WORKFLOW_TEMPLATE_ID,
+	metadata: {
+		env: "prod",
+		ticket: "PROJ-1234"
+	},
+	createdAt: "2026-03-08T12:00:00Z",
+	updatedAt: "2026-03-08T12:00:00Z",
+	expiresAt: "2026-03-10T12:00:00Z"
+};
+const workflowCreateResponse = {
+	name: "Deploy Production Release",
+	description: "Approval for releasing feature X to production.",
+	workflowTemplateId: MOCK_WORKFLOW_TEMPLATE_ID,
+	metadata: {
+		env: "prod",
+		ticket: "PROJ-1234"
+	}
+};
+const singleItemListWorkflowsResponse = {
+	data: [workflowResponse],
+	pagination: singleItemPaginationResponse
+};
+//#endregion
+//#region mocks/auth.fixtures.ts
+const tokenResponse = {
+	accessToken: "mock_access_token",
+	refreshToken: "mock_refresh_token"
+};
+//#endregion
+export { MOCK_ADMIN_USER_ID, MOCK_GROUP_ID, MOCK_USER_ID, MOCK_WORKFLOW_ID, MOCK_WORKFLOW_TEMPLATE_ID, adminUserResponse, exhaustedPaginationResponses, groupInfoResponse, groupResponse, memberUserResponse, multiPagePaginationResponse, singleItemListGroupsResponse, singleItemListWorkflowsResponse, singleItemPaginationResponse, singlePagePaginationResponse, tokenResponse, userSummaryResponse, workflowCreateResponse, workflowResponse };