@nexcodepl/endpoint-types - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

lib/types.d.ts

+export declare enum EndpointMethod {
+    Post = "POST",
+    Get = "GET",
+    Put = "PUT",
+    Delete = "DELETE"
+}
+export type EndpointDefinitionParams<T> = {
+    [K in keyof T]: string | number | boolean | undefined;
+};
+export type EndpointDefinitionParamsAllowed<T> = EndpointDefinitionParams<T> | undefined;
+export type EndpointDefinitionHeaders = Record<string, string>;
+type Secure<T extends boolean> = T extends true ? {
+    secure: T;
+} : {
+    secure?: T;
+};
+export type EndpointDefinition<TParams extends EndpointDefinitionParamsAllowed<TParams>, TData, TResponse, TSecure extends boolean = false> = {
+    url: string;
+    method: EndpointMethod;
+    params?: TParams;
+    paramsInline?: (keyof TParams)[];
+    data?: TData;
+    response?: TResponse;
+    noFormDataStringify?: boolean;
+    headers?: EndpointDefinitionHeaders;
+} & Secure<TSecure>;
+export type EndpointGetArgs<TEndpointDefinition> = TEndpointDefinition extends EndpointDefinition<undefined, undefined, any, boolean> ? {
+    params?: undefined;
+    data?: undefined;
+} : TEndpointDefinition extends EndpointDefinition<infer TParamsOnly, undefined, any, boolean> ? {
+    params: TParamsOnly;
+} : TEndpointDefinition extends EndpointDefinition<undefined, infer TDataOnly, any, boolean> ? {
+    data: TDataOnly;
+} : TEndpointDefinition extends EndpointDefinition<infer TParams, infer TData, any, boolean> ? {
+    params: TParams;
+    data: TData;
+} : never;
+export type EndpointDefinitionGetParams<TEndpointDefinition> = TEndpointDefinition extends EndpointDefinition<infer TParams, any, any, boolean> ? TParams : never;
+export type EndpointDefinitionGetData<TEndpointDefinition> = TEndpointDefinition extends EndpointDefinition<any, infer TData, any, boolean> ? TData : never;
+export type EndpointDefinitionGetResponse<TEndpointDefinition> = TEndpointDefinition extends EndpointDefinition<any, any, infer TResponse, boolean> ? TResponse : never;
+export interface EndpointErrorResponse {
+    response: {
+        status: number;
+        data?: {
+            errorMessage?: string;
+            errorCode?: string;
+            errorData?: any;
+        };
+    };
+}
+export {};

lib/types.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EndpointMethod = void 0;
+var EndpointMethod;
+(function (EndpointMethod) {
+    EndpointMethod["Post"] = "POST";
+    EndpointMethod["Get"] = "GET";
+    EndpointMethod["Put"] = "PUT";
+    EndpointMethod["Delete"] = "DELETE";
+})(EndpointMethod || (exports.EndpointMethod = EndpointMethod = {}));

lib/index.d.ts

@@ -1,1 +0,1 @@
-export * from "./endpoint.types";
+export * from "./types";

lib/index.js

 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -13,2 +17,2 @@ if (k2 === undefined) k2 = k;
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./endpoint.types"), exports);
+__exportStar(require("./types"), exports);

package.json

 {
     "name": "@nexcodepl/endpoint-types",
-    "version": "1.0.0",
-    "description": "Package for creating endpoint on server side",
+    "version": "2.0.0",
+    "description": "Types for endpoint library",
     "main": "lib/index.js",
@@ -26,4 +26,3 @@ "types": "lib/index.d.ts",
     },
-    "dependencies": {
-    },
+    "dependencies": {},
     "devDependencies": {
@@ -36,3 +35,3 @@ "@types/node": "^14.14.3",
         "ts-node": "^9.0.0",
-        "typescript": "^4.0.3"
+        "typescript": "^5.1.6"
     },
@@ -39,0 +38,0 @@ "files": [

lib/endpoint.types.d.ts

-export declare type EndpointMethod = "GET" | "POST" | "PUT" | "DELETE";
-export interface EndpointDefinition<TParams, TData, TResponse, TSecure extends boolean> {
-    url: string;
-    method: EndpointMethod;
-    secure: TSecure;
-    params?: TParams;
-    data?: TData;
-    response?: TResponse;
-}
-export declare type EndpointArgs<TEndpointDefinition> = TEndpointDefinition extends EndpointDefinition<undefined, undefined, any, boolean> ? {
-    params?: undefined;
-    data?: undefined;
-} : TEndpointDefinition extends EndpointDefinition<infer TParamsOnly, undefined, any, boolean> ? {
-    params: TParamsOnly;
-} : TEndpointDefinition extends EndpointDefinition<undefined, infer TDataOnly, any, boolean> ? {
-    data: TDataOnly;
-} : TEndpointDefinition extends EndpointDefinition<infer TParams, infer TData, any, boolean> ? {
-    params: TParams;
-    data: TData;
-} : never;
-export declare type EndpointDefinitionGetParams<TEndpointDefinition> = TEndpointDefinition extends EndpointDefinition<infer TParams, any, any, boolean> ? TParams : never;
-export declare type EndpointDefinitionGetData<TEndpointDefinition> = TEndpointDefinition extends EndpointDefinition<any, infer TData, any, boolean> ? TData : never;
-export declare type EndpointDefinitionGetResponse<TEndpointDefinition> = TEndpointDefinition extends EndpointDefinition<any, any, infer TResponse, boolean> ? TResponse : never;

lib/endpoint.types.js

-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

No alert changes

Improved metrics

Total package byte prevSize

5604

26.76%

Lines of code

79

102.56%

No dependency changes