@marcoturi/fastify-boilerplate 0.0.1

package/graphql.ts

@@ -0,0 +1,70 @@
+export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T>;
+export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
+export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
+export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
+export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+  ID: { input: string; output: string; }
+  String: { input: string; output: string; }
+  Boolean: { input: boolean; output: boolean; }
+  Int: { input: number; output: number; }
+  Float: { input: number; output: number; }
+};
+
+export type Mutation = {
+  __typename?: 'Mutation';
+  putUser: Scalars['ID']['output'];
+};
+
+
+export type MutationPutUserArgs = {
+  input: PutUserPayload;
+};
+
+export type PutUserPayload = {
+  country: Scalars['String']['input'];
+  email: Scalars['String']['input'];
+  postalCode: Scalars['String']['input'];
+  street: Scalars['String']['input'];
+};
+
+export type Query = {
+  __typename?: 'Query';
+  findUsers: UserPaginatedResponse;
+};
+
+
+export type QueryFindUsersArgs = {
+  country?: InputMaybe<Scalars['String']['input']>;
+  limit?: InputMaybe<Scalars['Int']['input']>;
+  page?: InputMaybe<Scalars['Int']['input']>;
+  postalCode?: InputMaybe<Scalars['String']['input']>;
+  street?: InputMaybe<Scalars['String']['input']>;
+};
+
+export type User = {
+  __typename?: 'User';
+  country: Scalars['String']['output'];
+  email: Scalars['String']['output'];
+  id: Scalars['ID']['output'];
+  postalCode: Scalars['String']['output'];
+  role: UserRole;
+  street: Scalars['String']['output'];
+};
+
+export type UserPaginatedResponse = {
+  __typename?: 'UserPaginatedResponse';
+  count: Scalars['Int']['output'];
+  data: Array<Maybe<User>>;
+  limit: Scalars['Int']['output'];
+  page: Scalars['Int']['output'];
+};
+
+export enum UserRole {
+  Admin = 'admin',
+  Guest = 'guest',
+  Moderator = 'moderator'
+}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@marcoturi/fastify-boilerplate",
+  "version": "0.0.1",
+  "description": "Auto-generated REST (OpenAPI) and GraphQL client types for fastify-boilerplate",
+  "type": "module",
+  "exports": {
+    "./rest": "./rest.d.ts",
+    "./graphql": "./graphql.ts"
+  },
+  "files": [
+    "rest.d.ts",
+    "graphql.ts"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marcoturi/fastify-boilerplate.git",
+    "directory": "client"
+  }
+}

package/rest.d.ts

@@ -0,0 +1,323 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/api/v1/users": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Find users */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Specifies a limit of returned records */
+                    limit?: number;
+                    /** @description Page number */
+                    page?: number;
+                    /** @description Country of residence */
+                    country?: string;
+                    /** @description Postal code */
+                    postalCode?: string;
+                    /** @description Street */
+                    street?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Total number of items
+                             * @example 5
+                             */
+                            count: number;
+                            /**
+                             * @description Number of items per page
+                             * @example 10
+                             */
+                            limit: number;
+                            /**
+                             * @description Page number
+                             * @example 0
+                             */
+                            page: number;
+                            data: unknown[];
+                        } & {
+                            data: (({
+                                /**
+                                 * Format: uuid
+                                 * @description Entity's id
+                                 * @example 2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231
+                                 */
+                                id: string;
+                            } & {
+                                /**
+                                 * @description Entity creation date
+                                 * @example 2020-11-24T17:43:15.970Z
+                                 */
+                                createdAt: string;
+                                /**
+                                 * @description Entity last update date
+                                 * @example 2020-11-24T17:43:15.970Z
+                                 */
+                                updatedAt: string;
+                            }) & {
+                                /**
+                                 * Format: email
+                                 * @description User's email address
+                                 * @example test@mail.com
+                                 */
+                                email: string;
+                                /**
+                                 * @description User's country of residence
+                                 * @example France
+                                 */
+                                country: string;
+                                /**
+                                 * @description Postal code
+                                 * @example 123456
+                                 */
+                                postalCode: string;
+                                /**
+                                 * @description Street where the user is registered
+                                 * @example Park Avenue
+                                 */
+                                street: string;
+                                /**
+                                 * @description User's role
+                                 * @example guest
+                                 */
+                                role: "admin" | "moderator" | "guest";
+                            })[];
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        /** @description Create user */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: email
+                         * @description User email address
+                         * @example john@gmail.com
+                         */
+                        email: string;
+                        /**
+                         * @description Country of residence
+                         * @example France
+                         */
+                        country: string;
+                        /**
+                         * @description Postal code
+                         * @example 10000
+                         */
+                        postalCode: string;
+                        /**
+                         * @description Street
+                         * @example Grande Rue
+                         */
+                        street: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * Format: uuid
+                             * @description Entity's id
+                             * @example 2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231
+                             */
+                            id: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/users/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /** @description Delete a user */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Entity's id */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description User Deleted */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/health": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Health Check Succeeded */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            status?: string;
+                        };
+                    };
+                };
+                /** @description Error Performing Health Check */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Error message for failure during health check
+                             * @example Internal Server Error
+                             */
+                            message?: string;
+                            /**
+                             * @description Code representing the error. Always matches the HTTP response code.
+                             * @example 500
+                             */
+                            statusCode?: number;
+                        };
+                    };
+                };
+                /** @description Health Check Failed */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Error code associated with the failing check
+                             * @example FST_UNDER_PRESSURE
+                             */
+                            code?: string;
+                            /**
+                             * @description Error thrown during health check
+                             * @example Service Unavailable
+                             */
+                            error?: string;
+                            /**
+                             * @description Error message to explain health check failure
+                             * @example Service Unavailable
+                             */
+                            message?: string;
+                            /**
+                             * @description Code representing the error. Always matches the HTTP response code.
+                             * @example 503
+                             */
+                            statusCode?: number;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** ApiErrorResponse */
+        "def-0": {
+            /** @example 400 */
+            statusCode: number;
+            /** @example Validation Error */
+            message: string;
+            /** @example Bad Request */
+            error: string;
+            /** @example YevPQs */
+            correlationId: string;
+            /**
+             * @description Optional list of sub-errors
+             * @example incorrect email
+             */
+            subErrors?: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;