@tstdl/base 0.90.68 → 0.90.70

package/api/client/client.d.ts

@@ -1,11 +1,10 @@
-import type { HttpClientOptions } from '../../http/client/index.js';
-import { HttpClient } from '../../http/client/index.js';
-import type { Resolvable } from '../../injector/interfaces.js';
-import type { ApiClientImplementation, ApiDefinition, ApiEndpointDefinition } from '../types.js';
+import { HttpClient, type HttpClientOptions } from '../../http/client/index.js';
+import { type Resolvable } from '../../injector/interfaces.js';
+import { type ApiClientImplementation, type ApiDefinition, type ApiEndpointDefinition } from '../types.js';
 export type ApiClient<T extends ApiDefinition> = new (httpClientOrOptions?: HttpClient | HttpClientOptions) => ApiClientImplementation<T> & Resolvable<HttpClient | HttpClientOptions>;
 export type ClientOptions = {
     /**
-     * url prefix
+     * Url prefix
      * @default `api/`
      */
     prefix?: string;
@@ -17,3 +16,5 @@ export type ApiClientHttpRequestContext = {
 export declare const httpClientSymbol: unique symbol;
 export declare const apiDefinitionSymbol: unique symbol;
 export declare function compileClient<T extends ApiDefinition>(definition: T, options?: ClientOptions): ApiClient<T>;
+export declare function getHttpClientOfApiClient(apiClient: any): HttpClient;
+export declare function getApiDefinitionOfApiClient(apiClient: any): ApiDefinition;

package/api/client/client.js

@@ -10,6 +10,7 @@ import { objectEntries } from '../../utils/object/object.js';
 import { toTitleCase } from '../../utils/string/title-case.js';
 import { isArray, isBlob, isDefined, isObject, isReadableStream, isString, isUint8Array, isUndefined } from '../../utils/type-guards.js';
 import { buildUrl } from '../../utils/url-builder.js';
+import { resolveValueOrProvider } from '../../utils/value-or-provider.js';
 import { normalizedApiDefinitionEndpointsEntries } from '../types.js';
 import { getFullApiEndpointResource } from '../utils.js';
 export const httpClientSymbol = Symbol('ApiTransport');
@@ -27,6 +28,17 @@ export function compileClient(definition, options = {}) {
                 this[httpClientSymbol] = (httpClientOrOptions instanceof HttpClient) ? httpClientOrOptions : inject(HttpClient, httpClientOrOptions);
                 this[apiDefinitionSymbol] = definition;
             }
+            getEndpointResource(endpoint, parameters) {
+                const resource = getFullApiEndpointResource({ api: definition, endpoint: resolveValueOrProvider(definition.endpoints[endpoint]), defaultPrefix: options.prefix });
+                if (isUndefined(parameters)) {
+                    return resource;
+                }
+                return buildUrl(resource, parameters).parsedUrl;
+            }
+            getEndpointUrl(endpoint, parameters) {
+                const url = this.getEndpointResource(endpoint, parameters);
+                return new URL(url, this[httpClientSymbol].options.baseUrl);
+            }
         }
     }[apiName];
     Injector.registerSingleton(api, {
@@ -40,7 +52,7 @@ export function compileClient(definition, options = {}) {
         const methods = isArray(endpoint.method) ? endpoint.method : [endpoint.method ?? 'GET'];
         const resource = getFullApiEndpointResource({ api: definition, endpoint, defaultPrefix: options.prefix });
         const hasGet = methods.includes('GET');
-        const fallbackMethod = methods.filter((method) => method != 'GET')[0] ?? 'GET';
+        const fallbackMethod = methods.find((method) => method != 'GET') ?? 'GET';
         const apiEndpointFunction = {
             async [name](parameters, requestBody) {
                 const context = { endpoint };
@@ -119,3 +131,9 @@ function getServerSentEvents(baseUrl, resource, endpoint, parameters) {
     }
     return new ServerSentEvents(url.toString(), { withCredentials: endpoint.credentials });
 }
+export function getHttpClientOfApiClient(apiClient) {
+    return apiClient[httpClientSymbol];
+}
+export function getApiDefinitionOfApiClient(apiClient) {
+    return apiClient[apiDefinitionSymbol];
+}

package/api/types.d.ts

@@ -4,6 +4,7 @@ import type { SchemaOutput, SchemaTestable } from '../schema/index.js';
 import type { ServerSentEventsSource } from '../sse/server-sent-events-source.js';
 import type { ServerSentEvents } from '../sse/server-sent-events.js';
 import type { NonUndefinable, OneOrMany, Record, ReturnTypeOrT } from '../types.js';
+import { type ValueOrProvider } from '../utils/value-or-provider.js';
 import type { ApiGatewayMiddlewareContext } from './server/index.js';
 export type ApiRegistrationOptions = {
     name?: string;
@@ -69,7 +70,7 @@ export type ApiEndpointDefinition = {
     credentials?: boolean;
     cors?: ApiEndpointDefinitionCors;
 };
-export type ApiEndpointsDefinition = Record<string, ApiEndpointDefinition | (() => ApiEndpointDefinition)>;
+export type ApiEndpointsDefinition = Record<string, ValueOrProvider<ApiEndpointDefinition>>;
 export type ApiDefinition<Resource extends string = string, Endpoints extends ApiEndpointsDefinition = ApiEndpointsDefinition> = {
     /**
      * Default root resource for endpoints.
@@ -112,6 +113,9 @@ export type ApiController<T extends ApiDefinition = any> = {
 };
 export type ApiClientImplementation<T extends ApiDefinition = any> = {
     [P in ApiEndpointKeys<T>]: ApiEndpointClientImplementation<T, P>;
+} & {
+    getEndpointResource<E extends ApiEndpointKeys<T>>(endpoint: E, parameters?: ApiParameters<T, E>): string;
+    getEndpointUrl<E extends ApiEndpointKeys<T>>(endpoint: E, parameters?: ApiParameters<T, E>): string;
 };
 export declare function defineApi<T extends ApiDefinition>(definition: T): T;
 export declare function resolveApiEndpointDataProvider<T>(request: HttpServerRequest, context: ApiGatewayMiddlewareContext, provider: ApiEndpointDataProvider<T>): Promise<T>;

package/api/types.js

@@ -1,5 +1,6 @@
 import { objectEntries } from '../utils/object/object.js';
 import { isFunction } from '../utils/type-guards.js';
+import { resolveValueOrProvider } from '../utils/value-or-provider.js';
 export function defineApi(definition) {
     return definition;
 }
@@ -14,5 +15,5 @@ export function normalizedApiDefinitionEndpoints(apiDefinitionEndpoints) {
     return Object.fromEntries(entries);
 }
 export function normalizedApiDefinitionEndpointsEntries(apiDefinition) {
-    return objectEntries(apiDefinition).map(([key, def]) => [key, isFunction(def) ? def() : def]);
+    return objectEntries(apiDefinition).map(([key, def]) => [key, resolveValueOrProvider(def)]);
 }

package/dom/files-select.d.ts

@@ -0,0 +1,7 @@
+import type { OneOrMany } from '../types.js';
+export type FileSelectDialogOptions = {
+    accept?: OneOrMany<string>;
+    multiple?: boolean;
+    capture?: string;
+};
+export declare function openFileSelectDialog({ accept, multiple, capture }?: FileSelectDialogOptions): Promise<File[] | null>;

package/dom/files-select.js

@@ -0,0 +1,19 @@
+import { isDefined, isString } from '../utils/type-guards.js';
+export async function openFileSelectDialog({ accept, multiple, capture } = {}) {
+    const fileInput = document.createElement('input');
+    fileInput.type = 'file';
+    if (isDefined(accept)) {
+        fileInput.accept = isString(accept) ? accept : accept.join(',');
+    }
+    if (isDefined(multiple)) {
+        fileInput.multiple = multiple;
+    }
+    if (isDefined(capture)) {
+        fileInput.capture = capture;
+    }
+    fileInput.click();
+    return new Promise((resolve) => {
+        fileInput.addEventListener('change', () => resolve(Array.from(fileInput.files ?? [])));
+        fileInput.addEventListener('cancel', () => resolve(null));
+    });
+}

package/dom/index.d.ts

@@ -0,0 +1 @@
+export * from './files-select.js';

package/dom/index.js

@@ -0,0 +1 @@
+export * from './files-select.js';

package/file/index.d.ts

@@ -1 +1,2 @@
 export * from './mime-type.js';
+export * from './mime-types.js';

package/file/index.js

@@ -1 +1,2 @@
 export * from './mime-type.js';
+export * from './mime-types.js';

package/http/client/http-client-request.d.ts

@@ -1,17 +1,12 @@
-import type { CancellationSignal } from '../../cancellation/index.js';
-import type { Disposable } from '../../disposable/index.js';
-import { dispose } from '../../disposable/index.js';
+import { type CancellationSignal } from '../../cancellation/index.js';
+import { dispose, type Disposable } from '../../disposable/index.js';
 import type { Record, TypedOmit, UndefinableJson, UndefinableJsonObject } from '../../types.js';
-import type { HttpFormObject } from '../http-form.js';
-import { HttpForm } from '../http-form.js';
-import type { HttpHeadersObject } from '../http-headers.js';
-import { HttpHeaders } from '../http-headers.js';
-import type { HttpQueryObject } from '../http-query.js';
-import { HttpQuery } from '../http-query.js';
-import type { HttpUrlParametersObject } from '../http-url-parameters.js';
-import { HttpUrlParameters } from '../http-url-parameters.js';
+import { HttpForm, type HttpFormObject } from '../http-form.js';
+import { HttpHeaders, type HttpHeadersObject } from '../http-headers.js';
+import { HttpQuery, type HttpQueryObject } from '../http-query.js';
+import { HttpUrlParameters, type HttpUrlParametersObject } from '../http-url-parameters.js';
 import type { HttpMethod } from '../types.js';
-/** only one type at a time is supported. If multiple are set, behaviour is undefined */
+/** Only one type at a time is supported. If multiple are set, behaviour is undefined */
 export type HttpRequestBody = {
     text?: string;
     json?: UndefinableJson;
@@ -54,7 +49,7 @@ export declare class HttpClientRequest implements Disposable {
     method: HttpMethod;
     headers: HttpHeaders;
     /**
-     * automatically maps parameters to `urlParameters`, `query` and `body`
+     * Automatically maps parameters to `urlParameters`, `query` and `body`
      * depending on whether the `url` has parameters specified, the request `method`
      * and if there is already a `body` or not
      * @see mapParameters
@@ -63,13 +58,13 @@ export declare class HttpClientRequest implements Disposable {
      * @see mapParametersToBody
      */
     parameters: UndefinableJsonObject | undefined;
-    /** if false, disable parameters mapping completely */
+    /** If false, disable parameters mapping completely */
     mapParameters: boolean;
     mapParametersToUrl: boolean;
     mapParametersToQuery: boolean;
     mapParametersToBody: boolean;
     /**
-     * parameters for url
+     * Parameters for url
      * @example
      * {
      *   url: 'http://domain.tld/users/:userId',
@@ -79,7 +74,7 @@ export declare class HttpClientRequest implements Disposable {
      */
     urlParameters: HttpUrlParameters;
     /**
-     * separator for url parameter array
+     * Separator for url parameter array
      * @default ','
      * @example
      * {
@@ -91,7 +86,7 @@ export declare class HttpClientRequest implements Disposable {
      */
     urlParametersSeparator: string;
     /**
-     * url query
+     * Url query
      * @example
      * {
      *   url: 'http://domain.tld/search',
@@ -104,25 +99,25 @@ export declare class HttpClientRequest implements Disposable {
     authorization: HttpRequestAuthorization | undefined;
     body: HttpRequestBody | undefined;
     /**
-     * request timeout in milliseconds
+     * Request timeout in milliseconds
      * @default 30000
      */
     timeout: number;
     throwOnNon200: boolean;
     /**
-     * can be used to store data for middleware etc.
+     * Can be used to store data for middleware etc.
      *
      * will not be used for actual request
      */
     context: Record<string>;
     /**
-     * can be used to cancel the request. Throws HttpError
+     * Can be used to cancel the request. Throws HttpError
      */
     get abortSignal(): CancellationSignal;
     constructor(url: string, method?: HttpMethod, options?: HttpClientRequestOptions);
     constructor(requestObject: HttpClientRequestObject);
     [dispose](): void;
-    /** abort the request */
+    /** Abort the request */
     abort(): void;
     clone(): HttpClientRequest;
     asObject(): HttpClientRequestObject;

package/http/client/http-client-request.js

@@ -12,7 +12,7 @@ export class HttpClientRequest {
     method;
     headers;
     /**
-     * automatically maps parameters to `urlParameters`, `query` and `body`
+     * Automatically maps parameters to `urlParameters`, `query` and `body`
      * depending on whether the `url` has parameters specified, the request `method`
      * and if there is already a `body` or not
      * @see mapParameters
@@ -21,13 +21,13 @@ export class HttpClientRequest {
      * @see mapParametersToBody
      */
     parameters;
-    /** if false, disable parameters mapping completely */
+    /** If false, disable parameters mapping completely */
     mapParameters;
     mapParametersToUrl;
     mapParametersToQuery;
     mapParametersToBody;
     /**
-     * parameters for url
+     * Parameters for url
      * @example
      * {
      *   url: 'http://domain.tld/users/:userId',
@@ -37,7 +37,7 @@ export class HttpClientRequest {
      */
     urlParameters;
     /**
-     * separator for url parameter array
+     * Separator for url parameter array
      * @default ','
      * @example
      * {
@@ -49,7 +49,7 @@ export class HttpClientRequest {
      */
     urlParametersSeparator;
     /**
-     * url query
+     * Url query
      * @example
      * {
      *   url: 'http://domain.tld/search',
@@ -62,19 +62,19 @@ export class HttpClientRequest {
     authorization;
     body;
     /**
-     * request timeout in milliseconds
+     * Request timeout in milliseconds
      * @default 30000
      */
     timeout;
     throwOnNon200;
     /**
-     * can be used to store data for middleware etc.
+     * Can be used to store data for middleware etc.
      *
      * will not be used for actual request
      */
     context;
     /**
-     * can be used to cancel the request. Throws HttpError
+     * Can be used to cancel the request. Throws HttpError
      */
     get abortSignal() {
         return this.#abortToken.signal;
@@ -110,7 +110,7 @@ export class HttpClientRequest {
         this.#abortToken.set();
         this.#abortToken.complete();
     }
-    /** abort the request */
+    /** Abort the request */
     abort() {
         this.#abortToken.set();
         this.#abortToken.complete();

package/http/client/http-client.js

@@ -272,14 +272,14 @@ function mapParameters(request, baseUrl) {
     const filteredParameterEntries = objectEntries(request.parameters ?? {}).filter(([_, value]) => isDefined(value));
     const filteredParameters = Object.fromEntries(filteredParameterEntries);
     let parameterEntries = new Set(filteredParameterEntries);
-    if (!request.mapParametersToUrl) {
-        url = new URL(request.url, baseUrl);
-    }
-    else {
+    if (request.mapParametersToUrl) {
         const { parsedUrl, parametersRest } = buildUrl(request.url, filteredParameters, { arraySeparator: request.urlParametersSeparator });
         url = new URL(parsedUrl, baseUrl);
         parameterEntries = new Set(objectEntries(parametersRest));
     }
+    else {
+        url = new URL(request.url, baseUrl);
+    }
     if (request.mapParametersToBody && !isGetOrHead && isUndefined(request.body)) {
         request.body = { json: Object.fromEntries(parameterEntries) };
         parameterEntries.clear();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.90.68",
+  "version": "0.90.70",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"
@@ -41,6 +41,7 @@
     "./decorators": "./decorators/index.js",
     "./disposable": "./disposable/index.js",
     "./distributed-loop": "./distributed-loop/index.js",
+    "./dom": "./dom/index.js",
     "./enumerable": "./enumerable/index.js",
     "./errors": "./errors/index.js",
     "./file": "./file/index.js",
@@ -110,7 +111,7 @@
     "luxon": "^3.4",
     "reflect-metadata": "^0.2",
     "rxjs": "^7.8",
-    "type-fest": "4.15"
+    "type-fest": "4.16"
   },
   "devDependencies": {
     "@mxssfd/typedoc-theme": "1.1",