@oino-ts/types 0.16.2 → 0.17.2

package/common/src/OINORequest.d.ts

@@ -0,0 +1,58 @@
+import { OINOContentType } from ".";
+export interface OINORequestInit {
+    params?: Record<string, string>;
+}
+/**
+ * OINO API request result object with returned data and/or http status code/message and
+ * error / warning messages.
+ *
+ */
+export declare class OINORequest {
+    /** Key-value parameters */
+    params?: Record<string, string>;
+    /**
+     * Constructor of OINORequest.
+     *
+     * @param init initialization values
+     *
+     */
+    constructor(init?: OINORequestInit);
+    /**
+     * Copy values from different result.
+     *
+     * @param request source value
+     */
+    copy(request: OINORequest): void;
+}
+export interface OINOHttpRequestInit extends OINORequestInit {
+    url?: URL;
+    method?: string;
+    headers?: Record<string, string>;
+    data?: string | Buffer | Uint8Array | object | null;
+    requestType?: OINOContentType;
+    responseType?: OINOContentType;
+    multipartBoundary?: string;
+    lastModified?: number;
+}
+/**
+ * Specialized result for HTTP responses.
+ */
+export declare class OINOHttpRequest extends OINORequest {
+    readonly url?: URL;
+    readonly method: string;
+    readonly headers: Record<string, string>;
+    readonly data: string | Buffer | Uint8Array | object | null;
+    readonly requestType: OINOContentType;
+    readonly responseType: OINOContentType;
+    readonly multipartBoundary?: string;
+    readonly lastModified?: number;
+    readonly etags?: string[];
+    /**
+     * Constructor for a `OINOHttpRequest`
+     *
+     * @param init initialization values
+     *
+     */
+    constructor(init: OINOHttpRequestInit);
+    static fromRequest(request: Request): Promise<OINOHttpRequest>;
+}

package/common/src/OINOResult.d.ts

@@ -1,3 +1,9 @@
+export interface OINOResultInit {
+    success?: boolean;
+    status?: number;
+    statusText?: string;
+    messages?: string[];
+}
 /**
  * OINO API request result object with returned data and/or http status code/message and
  * error / warning messages.
@@ -7,16 +13,18 @@ export declare class OINOResult {
     /** Wheter request was successfully executed */
     success: boolean;
     /** HTTP status code */
-    statusCode: number;
+    status: number;
     /** HTTP status message */
-    statusMessage: string;
+    statusText: string;
     /** Error / warning messages */
     messages: string[];
     /**
      * Constructor of OINOResult.
      *
+     * @param init initialization values
+     *
      */
-    constructor();
+    constructor(init?: OINOResultInit);
     /**
      * Copy values from different result.
      *
@@ -31,12 +39,12 @@ export declare class OINOResult {
     /**
      * Set HTTP error status using given code and message. Returns self reference for chaining.
      *
-     * @param statusCode HTTP status code
-     * @param statusMessage HTTP status message
+     * @param status HTTP status code
+     * @param statusText HTTP status message
      * @param operation operation where error occured
      *
      */
-    setError(statusCode: number, statusMessage: string, operation: string): OINOResult;
+    setError(status: number, statusText: string, operation: string): OINOResult;
     /**
      * Add warning message. Returns self reference for chaining.
      *
@@ -77,12 +85,11 @@ export declare class OINOResult {
      *
      */
     printLog(): string;
-    /**
-     * Get a Response object from the result values.
-     *
-     * @param headers HTTP headers (overrides existing values)
-     */
-    getStatusResponse(headers?: Record<string, string>): Response;
+}
+export interface OINOHttpResultInit extends OINOResultInit {
+    body?: string;
+    expires?: number;
+    lastModified?: number;
 }
 /**
  * Specialized result for HTTP responses.
@@ -91,17 +98,19 @@ export declare class OINOHttpResult extends OINOResult {
     private _etag;
     /** HTTP body data */
     readonly body: string;
-    /** HTTP cache expiration value */
+    /** HTTP cache expiration value
+     * Note: default 0 means no expiration and 'Pragma: no-cache' is set.
+    */
     expires: number;
     /** HTTP cache last-modified value */
     lastModified: number;
     /**
      * Constructor for a `OINOHttpResult`
      *
-     * @param body HTTP body
+     * @param init initialization values
      *
      */
-    constructor(body: string);
+    constructor(init?: OINOHttpResultInit);
     /**
      * Get the ETag value for the body opportunistically, i.e. don't calculate until requested and reuse value.
      *

package/common/src/index.d.ts

@@ -1,6 +1,7 @@
 export { OINOBenchmark, OINOMemoryBenchmark } from "./OINOBenchmark.js";
 export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js";
-export { OINOResult, OINOHttpResult } from "./OINOResult.js";
+export { OINOResult, OINOHttpResult, type OINOResultInit, type OINOHttpResultInit } from "./OINOResult.js";
+export { OINORequest, OINOHttpRequest, 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";
@@ -12,6 +13,10 @@ export declare const OINO_WARNING_PREFIX = "OINO WARNING";
 export declare const OINO_INFO_PREFIX = "OINO INFO";
 /** OINO debug message prefix */
 export declare const OINO_DEBUG_PREFIX = "OINO DEBUG";
+/** Name of the OINOContentType-parameter request */
+export declare const OINO_REQUEST_TYPE_PARAM = "oinorequesttype";
+/** Name of the OINOContentType-parameter request */
+export declare const OINO_RESPONSE_TYPE_PARAM = "oinoresponsetype";
 /**
  * Supported content format mime-types
  */

package/package.json

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