fets 0.4.1-alpha-20230714103147-e36adcc → 0.4.2

package/cjs/client/auth/oauth.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAuthPathErrorType = void 0;
+var OAuthPathErrorType;
+(function (OAuthPathErrorType) {
+    /**
+     * The request is missing a parameter so the server can’t proceed with the request.
+     * This may also be returned if the request includes an unsupported parameter or repeats a parameter.
+     */
+    OAuthPathErrorType["invalid_request"] = "invalid_request";
+    /**
+     * Client authentication failed, such as if the request contains an invalid client ID or secret.
+     * Send an HTTP 401 response in this case.
+     */
+    OAuthPathErrorType["invalid_client"] = "invalid_client";
+    /**
+     * The authorization code (or user’s password for the password grant type) is invalid or expired.
+     * This is also the error you would return if the redirect URL given in the authorization grant does not match the URL provided in this access token request.
+     */
+    OAuthPathErrorType["invalid_grant"] = "invalid_grant";
+    /**
+     * For access token requests that include a scope (password or client_credentials grants), this error indicates an invalid scope value in the request.
+     */
+    OAuthPathErrorType["invalid_scope"] = "invalid_scope";
+    /**
+     * This client is not authorized to use the requested grant type. For example, if you restrict which applications can use the Implicit grant, you would return this error for the other apps.
+     */
+    OAuthPathErrorType["unauthorized_client"] = "unauthorized_client";
+    /**
+     * If a grant type is requested that the authorization server doesn’t recognize, use this code.
+     * Note that unknown grant types also use this specific error code rather than using the `invalid_request` above.
+     */
+    OAuthPathErrorType["unsupported_grant_type"] = "unsupported_grant_type";
+})(OAuthPathErrorType || (exports.OAuthPathErrorType = OAuthPathErrorType = {}));

package/cjs/client/createClient.js

@@ -54,7 +54,7 @@ function createClient({ endpoint, fetchFn = fetch_1.fetch, plugins = [] }) {
                                 path = path.replace(`{${pathParamKey}}`, value).replace(`:${pathParamKey}`, value);
                             }
                         }
-                        if (!path.startsWith('/')) {
+                        if (!path.startsWith('/') && !path.startsWith('http')) {
                             path = `/${path}`;
                         }
                         let searchParams;
@@ -116,7 +116,7 @@ function createClient({ endpoint, fetchFn = fetch_1.fetch, plugins = [] }) {
                             });
                         }
                         let finalUrl = path;
-                        if (endpoint) {
+                        if (endpoint && !path.startsWith('http')) {
                             finalUrl = `${endpoint}${path}`;
                         }
                         if (searchParams) {

package/esm/client/auth/oauth.js

@@ -0,0 +1,31 @@
+export var OAuthPathErrorType;
+(function (OAuthPathErrorType) {
+    /**
+     * The request is missing a parameter so the server can’t proceed with the request.
+     * This may also be returned if the request includes an unsupported parameter or repeats a parameter.
+     */
+    OAuthPathErrorType["invalid_request"] = "invalid_request";
+    /**
+     * Client authentication failed, such as if the request contains an invalid client ID or secret.
+     * Send an HTTP 401 response in this case.
+     */
+    OAuthPathErrorType["invalid_client"] = "invalid_client";
+    /**
+     * The authorization code (or user’s password for the password grant type) is invalid or expired.
+     * This is also the error you would return if the redirect URL given in the authorization grant does not match the URL provided in this access token request.
+     */
+    OAuthPathErrorType["invalid_grant"] = "invalid_grant";
+    /**
+     * For access token requests that include a scope (password or client_credentials grants), this error indicates an invalid scope value in the request.
+     */
+    OAuthPathErrorType["invalid_scope"] = "invalid_scope";
+    /**
+     * This client is not authorized to use the requested grant type. For example, if you restrict which applications can use the Implicit grant, you would return this error for the other apps.
+     */
+    OAuthPathErrorType["unauthorized_client"] = "unauthorized_client";
+    /**
+     * If a grant type is requested that the authorization server doesn’t recognize, use this code.
+     * Note that unknown grant types also use this specific error code rather than using the `invalid_request` above.
+     */
+    OAuthPathErrorType["unsupported_grant_type"] = "unsupported_grant_type";
+})(OAuthPathErrorType || (OAuthPathErrorType = {}));

package/esm/client/createClient.js

@@ -50,7 +50,7 @@ export function createClient({ endpoint, fetchFn = fetch, plugins = [] }) {
                                 path = path.replace(`{${pathParamKey}}`, value).replace(`:${pathParamKey}`, value);
                             }
                         }
-                        if (!path.startsWith('/')) {
+                        if (!path.startsWith('/') && !path.startsWith('http')) {
                             path = `/${path}`;
                         }
                         let searchParams;
@@ -112,7 +112,7 @@ export function createClient({ endpoint, fetchFn = fetch, plugins = [] }) {
                             });
                         }
                         let finalUrl = path;
-                        if (endpoint) {
+                        if (endpoint && !path.startsWith('http')) {
                             finalUrl = `${endpoint}${path}`;
                         }
                         if (searchParams) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fets",
-  "version": "0.4.1-alpha-20230714103147-e36adcc",
+  "version": "0.4.2",
   "description": "TypeScript HTTP Framework focusing on e2e type-safety, easy setup, performance & great developer experience",
   "sideEffects": false,
   "dependencies": {

package/typings/client/auth/oauth.d.cts

@@ -0,0 +1,112 @@
+import type { TypedResponseWithJSONStatusMap } from '../../typed-fetch.cjs';
+export type OAuth2AuthParams<TSecurityScheme> = TSecurityScheme extends {
+    type: 'oauth2';
+} ? {
+    headers: {
+        Authorization: `Bearer ${string}`;
+    };
+} : {};
+export type OASOAuthPathRequestParamsWithHeader = {
+    formUrlEncoded: {
+        grant_type: 'client_credentials';
+    };
+    headers: {
+        /**
+         * The client ID and secret can be sent in the HTTP Basic auth header.
+         * @example `Authorization: Basic <base64 encoded client_id:client_secret>`
+         */
+        Authorization: `Basic ${string}`;
+    };
+};
+export type OASOAuthPathRequestParamsWithoutHeader = {
+    grant_type: 'client_credentials';
+    client_id: string;
+    client_secret: string;
+};
+export type OASOAuthPath<TOAS> = TOAS extends {
+    components: {
+        securitySchemes: {
+            [key: string]: {
+                type: 'oauth2';
+                flows: {
+                    authorizationCode: {
+                        tokenUrl: infer TTokenURL;
+                    };
+                };
+            };
+        };
+    };
+} ? {
+    [TPath in TTokenURL extends string ? TTokenURL : never]: {
+        /**
+         * The client needs to authenticate themselves for this request.
+         * Typically the service will allow either additional request parameters `client_id` and `client_secret`,
+         * or accept the client ID and secret in the HTTP Basic auth header.
+         */
+        post(requestParams: OASOAuthPathRequestParamsWithHeader | OASOAuthPathRequestParamsWithoutHeader, requestInit?: RequestInit): Promise<TypedResponseWithJSONStatusMap<{
+            200: OAuthPathSuccessResponse;
+            400: OAuthPathFailedResponse;
+        }>>;
+    };
+} : {};
+export type OAuthPathSuccessResponse = {
+    /**
+     * The access token string as issued by the authorization server.
+     */
+    access_token: string;
+    /**
+     * The type of token this is, typically just the string “Bearer”.
+     */
+    token_type: 'Bearer' | 'bearer';
+    /**
+     * If the access token expires, the server should reply with the duration of time the access token is granted for.
+     */
+    expires_in?: number;
+    /**
+     * If the access token will expire,
+     * then it is useful to return a refresh token which applications can use to obtain another access token.
+     * However, tokens issued with the implicit grant cannot be issued a refresh token.
+     */
+    refresh_token?: string;
+    /**
+     * If the scope the user granted is identical to the scope the app requested, this parameter is optional.
+     * If the granted scope is different from the requested scope,
+     * such as if the user modified the scope, then this parameter is required.
+     */
+    scope?: string;
+};
+export interface OAuthPathFailedResponse {
+    error: OAuthPathErrorType;
+    error_description?: string;
+    error_uri?: string;
+}
+export declare enum OAuthPathErrorType {
+    /**
+     * The request is missing a parameter so the server can’t proceed with the request.
+     * This may also be returned if the request includes an unsupported parameter or repeats a parameter.
+     */
+    invalid_request = "invalid_request",
+    /**
+     * Client authentication failed, such as if the request contains an invalid client ID or secret.
+     * Send an HTTP 401 response in this case.
+     */
+    invalid_client = "invalid_client",
+    /**
+     * The authorization code (or user’s password for the password grant type) is invalid or expired.
+     * This is also the error you would return if the redirect URL given in the authorization grant does not match the URL provided in this access token request.
+     */
+    invalid_grant = "invalid_grant",
+    /**
+     * For access token requests that include a scope (password or client_credentials grants), this error indicates an invalid scope value in the request.
+     */
+    invalid_scope = "invalid_scope",
+    /**
+     * This client is not authorized to use the requested grant type. For example, if you restrict which applications can use the Implicit grant, you would return this error for the other apps.
+     */
+    unauthorized_client = "unauthorized_client",
+    /**
+     * If a grant type is requested that the authorization server doesn’t recognize, use this code.
+     * Note that unknown grant types also use this specific error code rather than using the `invalid_request` above.
+     */
+    unsupported_grant_type = "unsupported_grant_type"
+}

package/typings/client/auth/oauth.d.ts

@@ -0,0 +1,112 @@
+import type { TypedResponseWithJSONStatusMap } from '../../typed-fetch.js';
+export type OAuth2AuthParams<TSecurityScheme> = TSecurityScheme extends {
+    type: 'oauth2';
+} ? {
+    headers: {
+        Authorization: `Bearer ${string}`;
+    };
+} : {};
+export type OASOAuthPathRequestParamsWithHeader = {
+    formUrlEncoded: {
+        grant_type: 'client_credentials';
+    };
+    headers: {
+        /**
+         * The client ID and secret can be sent in the HTTP Basic auth header.
+         * @example `Authorization: Basic <base64 encoded client_id:client_secret>`
+         */
+        Authorization: `Basic ${string}`;
+    };
+};
+export type OASOAuthPathRequestParamsWithoutHeader = {
+    grant_type: 'client_credentials';
+    client_id: string;
+    client_secret: string;
+};
+export type OASOAuthPath<TOAS> = TOAS extends {
+    components: {
+        securitySchemes: {
+            [key: string]: {
+                type: 'oauth2';
+                flows: {
+                    authorizationCode: {
+                        tokenUrl: infer TTokenURL;
+                    };
+                };
+            };
+        };
+    };
+} ? {
+    [TPath in TTokenURL extends string ? TTokenURL : never]: {
+        /**
+         * The client needs to authenticate themselves for this request.
+         * Typically the service will allow either additional request parameters `client_id` and `client_secret`,
+         * or accept the client ID and secret in the HTTP Basic auth header.
+         */
+        post(requestParams: OASOAuthPathRequestParamsWithHeader | OASOAuthPathRequestParamsWithoutHeader, requestInit?: RequestInit): Promise<TypedResponseWithJSONStatusMap<{
+            200: OAuthPathSuccessResponse;
+            400: OAuthPathFailedResponse;
+        }>>;
+    };
+} : {};
+export type OAuthPathSuccessResponse = {
+    /**
+     * The access token string as issued by the authorization server.
+     */
+    access_token: string;
+    /**
+     * The type of token this is, typically just the string “Bearer”.
+     */
+    token_type: 'Bearer' | 'bearer';
+    /**
+     * If the access token expires, the server should reply with the duration of time the access token is granted for.
+     */
+    expires_in?: number;
+    /**
+     * If the access token will expire,
+     * then it is useful to return a refresh token which applications can use to obtain another access token.
+     * However, tokens issued with the implicit grant cannot be issued a refresh token.
+     */
+    refresh_token?: string;
+    /**
+     * If the scope the user granted is identical to the scope the app requested, this parameter is optional.
+     * If the granted scope is different from the requested scope,
+     * such as if the user modified the scope, then this parameter is required.
+     */
+    scope?: string;
+};
+export interface OAuthPathFailedResponse {
+    error: OAuthPathErrorType;
+    error_description?: string;
+    error_uri?: string;
+}
+export declare enum OAuthPathErrorType {
+    /**
+     * The request is missing a parameter so the server can’t proceed with the request.
+     * This may also be returned if the request includes an unsupported parameter or repeats a parameter.
+     */
+    invalid_request = "invalid_request",
+    /**
+     * Client authentication failed, such as if the request contains an invalid client ID or secret.
+     * Send an HTTP 401 response in this case.
+     */
+    invalid_client = "invalid_client",
+    /**
+     * The authorization code (or user’s password for the password grant type) is invalid or expired.
+     * This is also the error you would return if the redirect URL given in the authorization grant does not match the URL provided in this access token request.
+     */
+    invalid_grant = "invalid_grant",
+    /**
+     * For access token requests that include a scope (password or client_credentials grants), this error indicates an invalid scope value in the request.
+     */
+    invalid_scope = "invalid_scope",
+    /**
+     * This client is not authorized to use the requested grant type. For example, if you restrict which applications can use the Implicit grant, you would return this error for the other apps.
+     */
+    unauthorized_client = "unauthorized_client",
+    /**
+     * If a grant type is requested that the authorization server doesn’t recognize, use this code.
+     * Note that unknown grant types also use this specific error code rather than using the `invalid_request` above.
+     */
+    unsupported_grant_type = "unsupported_grant_type"
+}

package/typings/client/types.d.cts

@@ -1,7 +1,8 @@
-import { B, Call, Pipe, Strings, Tuples } from 'hotscript';
-import { O } from 'ts-toolbelt';
+import type { B, Call, Pipe, Strings, Tuples } from 'hotscript';
+import type { O } from 'ts-toolbelt';
 import { HTTPMethod, NotOkStatusCode, StatusCode, TypedResponse } from '../typed-fetch.cjs';
-import { FromSchema, JSONSchema, OpenAPIDocument } from '../types.cjs';
+import type { FromSchema, JSONSchema, OpenAPIDocument } from '../types.cjs';
+import type { OASOAuthPath, OAuth2AuthParams } from './auth/oauth.cjs';
 type JSONSchema7TypeName = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
 type Mutable<Type> = {
     -readonly [Key in keyof Type]: Mutable<Type[Key]>;
@@ -87,7 +88,7 @@ export type OASClient<TOAS extends OpenAPIDocument> = {
             query: {};
         } ? (requestParams: OASRequestParams<TOAS, TPath, TMethod>, init?: RequestInit) => Promise<OASResponse<TOAS, TPath, TMethod>> : (requestParams?: OASRequestParams<TOAS, TPath, TMethod>, init?: RequestInit) => Promise<OASResponse<TOAS, TPath, TMethod>>;
     };
-};
+} & OASOAuthPath<TOAS>;
 export type OASModel<TOAS extends OpenAPIDocument, TName extends string> = TOAS extends {
     components: {
         schemas: {
@@ -293,12 +294,5 @@ export type ApiKeyAuthParams<TSecurityScheme> = TSecurityScheme extends {
         [TQueryName in TApiKeyQueryName extends string ? TApiKeyQueryName : never]: string;
     };
 } : {};
-export type OAuth2AuthParams<TSecurityScheme> = TSecurityScheme extends {
-    type: 'oauth2';
-} ? {
-    headers: {
-        Authorization: `Bearer ${string}`;
-    };
-} : {};
 export type OASSecurityParams<TSecurityScheme> = BasicAuthParams<TSecurityScheme> & BearerAuthParams<TSecurityScheme> & ApiKeyAuthParams<TSecurityScheme> & OAuth2AuthParams<TSecurityScheme>;
 export {};

package/typings/client/types.d.ts

@@ -1,7 +1,8 @@
-import { B, Call, Pipe, Strings, Tuples } from 'hotscript';
-import { O } from 'ts-toolbelt';
+import type { B, Call, Pipe, Strings, Tuples } from 'hotscript';
+import type { O } from 'ts-toolbelt';
 import { HTTPMethod, NotOkStatusCode, StatusCode, TypedResponse } from '../typed-fetch.js';
-import { FromSchema, JSONSchema, OpenAPIDocument } from '../types.js';
+import type { FromSchema, JSONSchema, OpenAPIDocument } from '../types.js';
+import type { OASOAuthPath, OAuth2AuthParams } from './auth/oauth.js';
 type JSONSchema7TypeName = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
 type Mutable<Type> = {
     -readonly [Key in keyof Type]: Mutable<Type[Key]>;
@@ -87,7 +88,7 @@ export type OASClient<TOAS extends OpenAPIDocument> = {
             query: {};
         } ? (requestParams: OASRequestParams<TOAS, TPath, TMethod>, init?: RequestInit) => Promise<OASResponse<TOAS, TPath, TMethod>> : (requestParams?: OASRequestParams<TOAS, TPath, TMethod>, init?: RequestInit) => Promise<OASResponse<TOAS, TPath, TMethod>>;
     };
-};
+} & OASOAuthPath<TOAS>;
 export type OASModel<TOAS extends OpenAPIDocument, TName extends string> = TOAS extends {
     components: {
         schemas: {
@@ -293,12 +294,5 @@ export type ApiKeyAuthParams<TSecurityScheme> = TSecurityScheme extends {
         [TQueryName in TApiKeyQueryName extends string ? TApiKeyQueryName : never]: string;
     };
 } : {};
-export type OAuth2AuthParams<TSecurityScheme> = TSecurityScheme extends {
-    type: 'oauth2';
-} ? {
-    headers: {
-        Authorization: `Bearer ${string}`;
-    };
-} : {};
 export type OASSecurityParams<TSecurityScheme> = BasicAuthParams<TSecurityScheme> & BearerAuthParams<TSecurityScheme> & ApiKeyAuthParams<TSecurityScheme> & OAuth2AuthParams<TSecurityScheme>;
 export {};

package/typings/typed-fetch.d.cts

@@ -46,7 +46,7 @@ export type TypedResponseCtor = Omit<typeof Response, 'json'> & {
     redirect(url: string | URL): TypedResponse<any, Record<string, string>, 302>;
 };
 export type TypedResponseWithJSONStatusMap<TResponseJSONStatusMap extends StatusCodeMap<any>> = {
-    [TStatusCode in keyof TResponseJSONStatusMap]?: TStatusCode extends StatusCode ? TypedResponse<TResponseJSONStatusMap[TStatusCode], Record<string, string>, TStatusCode> : never;
+    [TStatusCode in keyof TResponseJSONStatusMap]: TStatusCode extends StatusCode ? TypedResponse<TResponseJSONStatusMap[TStatusCode], Record<string, string>, TStatusCode> : never;
 }[keyof TResponseJSONStatusMap];
 export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'CONNECT' | 'TRACE';
 export type TypedRequestInit<THeaders extends Record<string, string>, TMethod extends HTTPMethod, TFormData extends Record<string, FormDataEntryValue>> = Omit<RequestInit, 'method' | 'headers' | 'body'> & {

package/typings/typed-fetch.d.ts

@@ -46,7 +46,7 @@ export type TypedResponseCtor = Omit<typeof Response, 'json'> & {
     redirect(url: string | URL): TypedResponse<any, Record<string, string>, 302>;
 };
 export type TypedResponseWithJSONStatusMap<TResponseJSONStatusMap extends StatusCodeMap<any>> = {
-    [TStatusCode in keyof TResponseJSONStatusMap]?: TStatusCode extends StatusCode ? TypedResponse<TResponseJSONStatusMap[TStatusCode], Record<string, string>, TStatusCode> : never;
+    [TStatusCode in keyof TResponseJSONStatusMap]: TStatusCode extends StatusCode ? TypedResponse<TResponseJSONStatusMap[TStatusCode], Record<string, string>, TStatusCode> : never;
 }[keyof TResponseJSONStatusMap];
 export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'CONNECT' | 'TRACE';
 export type TypedRequestInit<THeaders extends Record<string, string>, TMethod extends HTTPMethod, TFormData extends Record<string, FormDataEntryValue>> = Omit<RequestInit, 'method' | 'headers' | 'body'> & {