@oino-ts/types 0.17.5 → 0.19.0

package/common/src/OINORequest.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+/// <reference types="node" />
 import { Buffer } from "node:buffer";
 import { OINOContentType, OINOHeaders, OINOHeadersInit } from ".";
 export interface OINORequestInit {
@@ -19,11 +21,12 @@ export declare class OINORequest {
      */
     constructor(init?: OINORequestInit);
 }
+export type OINOHttpData = string | Buffer | Uint8Array | null;
 export interface OINOHttpRequestInit extends OINORequestInit {
-    url?: URL;
+    url?: URL | string;
     method?: string;
     headers?: OINOHeadersInit;
-    data?: string | Buffer | Uint8Array | object | null;
+    body?: OINOHttpData;
     requestType?: OINOContentType;
     responseType?: OINOContentType;
     multipartBoundary?: string;
@@ -33,15 +36,15 @@ export interface OINOHttpRequestInit extends OINORequestInit {
  * Specialized result for HTTP responses.
  */
 export declare class OINOHttpRequest extends OINORequest {
-    readonly url?: URL;
-    readonly method: string;
-    readonly headers: OINOHeaders;
-    readonly data: string | Buffer | Uint8Array | object | null;
-    readonly requestType: OINOContentType;
-    readonly responseType: OINOContentType;
-    readonly multipartBoundary?: string;
-    readonly lastModified?: number;
-    readonly etags?: string[];
+    url?: URL;
+    method: string;
+    headers: OINOHeaders;
+    body: OINOHttpData;
+    requestType: OINOContentType;
+    responseType: OINOContentType;
+    multipartBoundary?: string;
+    lastModified?: number;
+    etags?: string[];
     /**
      * Constructor for a `OINOHttpRequest`
      *
@@ -49,9 +52,31 @@ export declare class OINOHttpRequest extends OINORequest {
      *
      */
     constructor(init: OINOHttpRequestInit);
+    /**
+     * Creates a `OINOHttpRequest` from a Fetch API `Request` object.
+     *
+     * @param request Fetch request
+     *
+     */
     static fromFetchRequest(request: Request): Promise<OINOHttpRequest>;
-    dataAsText(): string;
-    dataAsParsedJson(): any;
-    dataAsFormData(): URLSearchParams;
-    dataAsBuffer(): Buffer;
+    /**
+     * Returns the request data as a text string.
+     *
+     */
+    bodyAsText(): string;
+    /**
+     * Returns the request data parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson(): any;
+    /**
+     * Returns the request data as URLSearchParams (form data).
+     *
+     */
+    bodyAsFormData(): URLSearchParams;
+    /**
+     * Returns the request data as Buffer.
+     *
+     */
+    bodyAsBuffer(): Buffer;
 }

package/common/src/OINOResult.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+/// <reference types="node" />
 import { Buffer } from "node:buffer";
 import { OINOHeaders, OINOHeadersInit } from ".";
 export interface OINOResultInit {
@@ -127,4 +129,31 @@ export declare class OINOHttpResult extends OINOResult {
      * @param headers HTTP headers (overrides existing values)
      */
     getFetchResponse(headers?: OINOHeadersInit): Response;
+    /**
+     * Create from a Response object from the result values.
+     *
+     * @param response fetch Response object
+     *
+     */
+    static fromFetchResponse(response: Response): Promise<OINOHttpResult>;
+    /**
+     * Returns the request body as a text string.
+     *
+     */
+    bodyAsText(): string;
+    /**
+     * Returns the request body parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson(): any;
+    /**
+     * Returns the request body as URLSearchParams (form body).
+     *
+     */
+    bodyAsFormData(): URLSearchParams;
+    /**
+     * Returns the request body as Buffer.
+     *
+     */
+    bodyAsBuffer(): Buffer;
 }

package/common/src/index.d.ts

@@ -1,7 +1,7 @@
 export { OINOBenchmark, OINOMemoryBenchmark } from "./OINOBenchmark.js";
 export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js";
 export { OINOResult, OINOHttpResult, type OINOResultInit, type OINOHttpResultInit } from "./OINOResult.js";
-export { OINORequest, OINOHttpRequest, type OINORequestInit, type OINOHttpRequestInit } from "./OINORequest.js";
+export { OINORequest, OINOHttpRequest, type OINOHttpData, type OINORequestInit, type OINOHttpRequestInit } from "./OINORequest.js";
 export { OINOStr } from "./OINOStr.js";
 export { OINOHtmlTemplate } from "./OINOHtmlTemplate.js";
 export { OINOFormatter, OINO_EMPTY_FORMATTER } from "./OINOFormatter.js";

package/index.d.ts

@@ -1,23 +1,7 @@
 /// <reference path="db/src/index.d.ts
-/// <reference path="db/src/OINODb.d.ts
-/// <reference path="db/src/OINODbApi.d.ts
-/// <reference path="db/src/OINODbConfig.d.ts
-/// <reference path="db/src/OINODbDataField.d.ts
-/// <reference path="db/src/OINODbDataModel.d.ts
-/// <reference path="db/src/OINODbFactory.d.ts
-/// <reference path="db/src/OINODbModelSet.d.ts
-/// <reference path="db/src/OINODbRequestParams.d.ts
-/// <reference path="db/src/OINODbSqlParams.d.ts
-/// <reference path="db/src/OINODbSwagger.d.ts
-/// <reference path="db/src/OINODbParser.d.ts
-/// <reference path="db-bunsqlite/src/OINODbBunSqlite.d.ts
-/// <reference path="db-mariadb/src/OINODbMariadb.d.ts
-/// <reference path="db-mssql/src/OINODbMsSql.d.ts
-/// <reference path="db-postgresql/src/OINODbPostgresql.d.ts
+/// <reference path="db-bunsqlite/src/index.d.ts
+/// <reference path="db-mariadb/src/index.d.ts
+/// <reference path="db-mssql/src/index.d.ts
+/// <reference path="db-postgresql/src/index.d.ts
 /// <reference path="hashid/src/OINOHashid.d.ts
 /// <reference path="common/src/index.d.ts
-/// <reference path="common/src/OINOBenchmark.d.ts
-/// <reference path="common/src/OINOHtmlTemplate.d.ts
-/// <reference path="common/src/OINOLog.d.ts
-/// <reference path="common/src/OINOResult.d.ts
-/// <reference path="common/src/OINOStr.d.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/types",
-  "version": "0.17.5",
+  "version": "0.19.0",
   "description": "OINO TS package for types.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",