@opra/client 0.22.0 → 0.23.1

package/esm/constants.js

@@ -1,4 +1,5 @@
 export const JSON_CONTENT_TYPE_PATTERN = /^application\/([\w-]+\+)?\bjson\b/i;
 export const TEXT_CONTENT_TYPE_PATTERN = /^text\/.*$/i;
 export const FORMDATA_CONTENT_TYPE_PATTERN = /^multipart\/\bform-data\b/i;
-export const kHttpClientContext = Symbol('kContext');
+export const kRequest = Symbol.for('kRequest');
+export const kContext = Symbol.for('kContext');

package/esm/http-request-observable.js

@@ -1,15 +1,15 @@
 import { lastValueFrom, Observable } from 'rxjs';
 import { uid } from '@opra/common';
-import { kHttpClientContext } from './constants.js';
+import { kContext, kRequest } from './constants.js';
 import { HttpRequest } from './http-request.js';
 import { HttpObserveType } from './types.js';
-const kRequest = Symbol('kRequest');
 export class HttpRequestObservable extends Observable {
     constructor(context, options) {
         super((subscriber) => {
-            context.send(options?.observe || HttpObserveType.Body, this[kRequest]).subscribe((subscriber));
+            context.send(options?.observe || HttpObserveType.Body, this[kRequest])
+                .subscribe((subscriber));
         });
-        this[kHttpClientContext] = context;
+        this[kContext] = context;
         this[kRequest] = new HttpRequest(options?.http);
         this.contentId = uid(6);
     }
@@ -26,12 +26,11 @@ export class HttpRequestObservable extends Observable {
         return this;
     }
     async fetch(observe) {
-        return lastValueFrom(this[kHttpClientContext].send(observe || HttpObserveType.Body, this[kRequest]));
+        return lastValueFrom(this[kContext]
+            .send(observe || HttpObserveType.Body, this[kRequest]));
     }
     with(cb) {
         cb(this);
         return this;
     }
 }
-HttpRequestObservable.kContext = kHttpClientContext;
-HttpRequestObservable.kRequest = kRequest;

package/esm/http-request.js

@@ -18,24 +18,22 @@ export class HttpRequest {
         this.referrerPolicy = init?.referrerPolicy || '';
         this.signal = init?.signal || new AbortController().signal;
         this.body = init?.body;
-        this.urlInstance = new OpraURL(init?.url);
-        if (init?.params)
-            this.params.appendAll(init.params);
+        this.parsedUrl = new OpraURL(init?.url);
+        if (init?.params) {
+            const params = new URLSearchParams(init.params);
+            params.forEach((v, k) => this.params.set(k, v));
+        }
     }
     /** Returns the URL of request as a string. */
     get url() {
-        return this.urlInstance.href;
+        return this.parsedUrl;
     }
     set url(value) {
-        this.urlInstance.parse(value);
+        this.parsedUrl = value;
     }
     /** Returns the searchParams of the URL as OpraURLSearchParams */
     get params() {
-        return this.urlInstance.searchParams;
-    }
-    /** Returns the path part of URL as OpraURLPath */
-    get path() {
-        return this.urlInstance.path;
+        return this.parsedUrl.searchParams;
     }
     clone(...update) {
         const out = new HttpRequest();

package/esm/singleton-node.js

@@ -1,59 +1,64 @@
-import { kHttpClientContext } from './constants.js';
+import { toArrayDef } from 'putil-varhelpers';
+import { kContext, kRequest } from './constants.js';
 import { HttpRequestObservable } from './http-request-observable.js';
 export class HttpSingletonNode {
     constructor(context) {
-        this[kHttpClientContext] = context;
+        this[kContext] = context;
     }
     create(data, options) {
-        const context = this[kHttpClientContext];
+        const context = this[kContext];
+        context.operation = 'create';
         const requestHost = new HttpRequestObservable(context, options);
-        const request = requestHost[HttpRequestObservable.kRequest];
+        const request = requestHost[kRequest];
         request.method = 'POST';
-        request.url = context.resourceName;
+        request.url.join(context.resourceName);
         request.body = data;
         if (options?.include)
-            request.params.set('$include', options.include);
+            request.params.set('$include', toArrayDef(options.include, []).join(','));
         if (options?.pick)
-            request.params.set('$pick', options.pick);
+            request.params.set('$pick', toArrayDef(options.pick, []).join(','));
         if (options?.omit)
-            request.params.set('$omit', options.omit);
+            request.params.set('$omit', toArrayDef(options.omit, []).join(','));
         return requestHost;
     }
     delete(options) {
-        const context = this[kHttpClientContext];
+        const context = this[kContext];
+        context.operation = 'delete';
         const requestHost = new HttpRequestObservable(context, options);
-        const request = requestHost[HttpRequestObservable.kRequest];
+        const request = requestHost[kRequest];
         request.method = 'DELETE';
-        request.path.join({ resource: context.resourceName });
+        request.url.join({ resource: context.resourceName });
         return requestHost;
     }
     get(options) {
-        const context = this[kHttpClientContext];
+        const context = this[kContext];
+        context.operation = 'get';
         const requestHost = new HttpRequestObservable(context, options);
-        const request = requestHost[HttpRequestObservable.kRequest];
+        const request = requestHost[kRequest];
         request.method = 'GET';
-        request.path.join({ resource: context.resourceName });
+        request.url.join({ resource: context.resourceName });
         if (options?.include)
-            request.params.set('$include', options.include);
+            request.params.set('$include', toArrayDef(options.include, []).join(','));
         if (options?.pick)
-            request.params.set('$pick', options.pick);
+            request.params.set('$pick', toArrayDef(options.pick, []).join(','));
         if (options?.omit)
-            request.params.set('$omit', options.omit);
+            request.params.set('$omit', toArrayDef(options.omit, []).join(','));
         return requestHost;
     }
     update(data, options) {
-        const context = this[kHttpClientContext];
+        const context = this[kContext];
+        context.operation = 'update';
         const requestHost = new HttpRequestObservable(context, options);
-        const request = requestHost[HttpRequestObservable.kRequest];
+        const request = requestHost[kRequest];
         request.method = 'PATCH';
-        request.path.join({ resource: context.resourceName });
+        request.url.join({ resource: context.resourceName });
         request.body = data;
         if (options?.include)
-            request.params.set('$include', options.include);
+            request.params.set('$include', toArrayDef(options.include, []).join(','));
         if (options?.pick)
-            request.params.set('$pick', options.pick);
+            request.params.set('$pick', toArrayDef(options.pick, []).join(','));
         if (options?.omit)
-            request.params.set('$omit', options.omit);
+            request.params.set('$omit', toArrayDef(options.omit, []).join(','));
         return requestHost;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/client",
-  "version": "0.22.0",
+  "version": "0.23.1",
   "description": "Opra Client package",
   "author": "Panates",
   "license": "MIT",
@@ -46,7 +46,7 @@
     "@browsery/i18next": "^0.6.0",
     "@browsery/stream": "^0.5.0",
     "@browsery/util": "^0.4.0",
-    "@opra/common": "^0.22.0",
+    "@opra/common": "^0.23.1",
     "accepts": "^1.3.8",
     "buffer": "^6.0.3",
     "cookie": "^0.5.0",
@@ -60,7 +60,7 @@
     "process": "^0.11.10",
     "putil-isplainobject": "^1.1.5",
     "putil-merge": "^3.10.3",
-    "putil-promisify": "^1.10.0",
+    "putil-promisify": "^1.10.1",
     "putil-varhelpers": "^1.6.5",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1",

package/types/client.d.ts

@@ -1,6 +1,6 @@
 import { Observable, Subscriber } from 'rxjs';
 import { StrictOmit, Type } from 'ts-gems';
-import { ApiDocument, HttpParams } from '@opra/common';
+import { ApiDocument, OpraSchema } from '@opra/common';
 import { HttpCollectionNode } from './collection-node.js';
 import { HttpRequest } from './http-request.js';
 import { HttpResponse } from './http-response.js';
@@ -30,16 +30,16 @@ export declare class OpraHttpClient {
     };
     defaults: StrictOmit<HttpRequestDefaults, 'headers' | 'params'> & {
         headers: Headers;
-        params: HttpParams;
+        params: URLSearchParams;
     };
     constructor(serviceUrl: string, options?: OpraHttpClientOptions);
     get serviceUrl(): string;
     getMetadata(): Promise<ApiDocument>;
     collection<TType = any>(resourceName: string | Type<TType>): HttpCollectionNode<TType>;
     singleton<TType = any>(resourceName: string | Type<TType>): HttpSingletonNode<TType>;
-    protected _sendRequest<TBody>(observe: HttpObserveType, request: HttpRequest, ctx?: HttpClientContext): Observable<HttpResponse<TBody> | TBody | HttpEvent>;
+    protected _sendRequest<TBody>(resourceKind: OpraSchema.Resource.Kind, operation: string, observe: HttpObserveType, request: HttpRequest, ctx?: HttpClientContext): Observable<HttpResponse<TBody> | TBody | HttpEvent>;
     protected _fetch(url: string, init?: RequestInit): Promise<Response>;
     protected _createResponse(init?: HttpResponse.Initiator): HttpResponse;
-    protected _handleResponse(observe: HttpObserveType, subscriber: Subscriber<any>, request: HttpRequest, fetchResponse: Response, ctx?: HttpClientContext): Promise<void>;
+    protected _handleResponse(resourceKind: OpraSchema.Resource.Kind, operation: string, observe: HttpObserveType, subscriber: Subscriber<any>, request: HttpRequest, fetchResponse: Response, ctx?: HttpClientContext): Promise<void>;
 }
 export {};

package/types/collection-node.d.ts

@@ -1,7 +1,7 @@
 import { StrictOmit } from 'ts-gems';
 import type { PartialInput } from '@opra/common';
 import { OpraFilter } from '@opra/common';
-import { kHttpClientContext } from './constants.js';
+import { kContext } from './constants.js';
 import { HttpRequestObservable } from './http-request-observable.js';
 import { HttpResponse } from './http-response.js';
 import { HttpClientContext, HttpEvent, HttpObserveType } from './types.js';
@@ -48,7 +48,7 @@ export declare namespace HttpCollectionNode {
     }
 }
 export declare class HttpCollectionNode<TType, TResponseExt = {}> {
-    protected [kHttpClientContext]: HttpClientContext;
+    protected [kContext]: HttpClientContext;
     constructor(context: HttpClientContext);
     create(data: PartialInput<TType>, options?: StrictOmit<HttpCollectionNode.CreateOptions, 'observe'> & {
         observe?: HttpObserveType.Body;

package/types/constants.d.ts

@@ -1,4 +1,5 @@
 export declare const JSON_CONTENT_TYPE_PATTERN: RegExp;
 export declare const TEXT_CONTENT_TYPE_PATTERN: RegExp;
 export declare const FORMDATA_CONTENT_TYPE_PATTERN: RegExp;
-export declare const kHttpClientContext: unique symbol;
+export declare const kRequest: unique symbol;
+export declare const kContext: unique symbol;

package/types/http-request-observable.d.ts

@@ -1,10 +1,8 @@
 import { Observable } from 'rxjs';
-import { ClientHttpHeaders } from '@opra/common';
-import { kHttpClientContext } from './constants.js';
+import { kContext, kRequest } from './constants.js';
 import { HttpRequest } from './http-request.js';
 import { HttpResponse } from './http-response.js';
 import { HttpClientContext, HttpObserveType, HttpRequestDefaults } from './types.js';
-declare const kRequest: unique symbol;
 export declare namespace HttpRequestObservable {
     interface Options {
         observe?: HttpObserveType;
@@ -12,17 +10,14 @@ export declare namespace HttpRequestObservable {
     }
 }
 export declare class HttpRequestObservable<T, TBody, TResponseExt = {}> extends Observable<T> {
-    static kContext: symbol;
-    static kRequest: symbol;
     readonly contentId: string;
-    protected [kHttpClientContext]: HttpClientContext;
+    protected [kContext]: HttpClientContext;
     protected [kRequest]: HttpRequest;
     constructor(context: HttpClientContext, options?: HttpRequestObservable.Options);
-    header<K extends keyof ClientHttpHeaders>(name: K, value: ClientHttpHeaders[K]): this;
+    header(name: string, value: string | string[]): this;
     param(name: string, value: any): this;
     fetch(): Promise<TBody>;
     fetch(observe: HttpObserveType.Body): Promise<TBody>;
     fetch(observe: HttpObserveType.Response): Promise<HttpResponse<TBody> & TResponseExt>;
     with(cb: (_this: this) => void): this;
 }
-export {};

package/types/http-request.d.ts

@@ -1,5 +1,6 @@
 /// <reference lib="dom" />
-import { HttpParams, OpraURL, OpraURLPath } from '@opra/common';
+import { OpraURL } from '@opra/common';
+import { URLSearchParamsInit } from './types.js';
 export declare namespace HttpRequest {
     interface Initiator {
         cache?: RequestCache;
@@ -10,7 +11,7 @@ export declare namespace HttpRequest {
         keepalive?: boolean;
         method?: string;
         mode?: RequestMode;
-        params?: HttpParams.Initiator;
+        params?: URLSearchParamsInit;
         redirect?: RequestRedirect;
         referrer?: string;
         referrerPolicy?: ReferrerPolicy;
@@ -58,18 +59,16 @@ export declare class HttpRequest {
      *  whether or not request has been aborted, and its abort event handler. */
     signal?: AbortSignal;
     /** Returns the parsed url as OpraURL instance */
-    readonly urlInstance: OpraURL;
+    parsedUrl: OpraURL;
     /** Body of the http request */
     body?: any;
     duplex?: 'half';
     constructor(init?: HttpRequest.Initiator);
     /** Returns the URL of request as a string. */
-    get url(): string;
-    set url(value: string);
+    get url(): OpraURL;
+    set url(value: OpraURL);
     /** Returns the searchParams of the URL as OpraURLSearchParams */
-    get params(): HttpParams;
-    /** Returns the path part of URL as OpraURLPath */
-    get path(): OpraURLPath;
+    get params(): URLSearchParams;
     clone(...update: (HttpRequest | HttpRequest.Initiator)[]): HttpRequest;
     merge(update: HttpRequest | HttpRequest.Initiator): void;
     inset(src: HttpRequest | HttpRequest.Initiator): void;

package/types/singleton-node.d.ts

@@ -1,6 +1,6 @@
 import { StrictOmit } from 'ts-gems';
 import { PartialInput } from '@opra/common';
-import { kHttpClientContext } from './constants.js';
+import { kContext } from './constants.js';
 import { HttpRequestObservable } from './http-request-observable.js';
 import { HttpResponse } from './http-response.js';
 import { HttpClientContext, HttpEvent, HttpObserveType } from './types.js';
@@ -24,7 +24,7 @@ export declare namespace HttpSingletonNode {
     }
 }
 export declare class HttpSingletonNode<TType, TResponseExt = {}> {
-    protected [kHttpClientContext]: HttpClientContext;
+    protected [kContext]: HttpClientContext;
     constructor(context: HttpClientContext);
     create(data: PartialInput<TType>, options?: StrictOmit<HttpSingletonNode.CreateOptions, 'observe'> & {
         observe?: HttpObserveType.Body;

package/types/types.d.ts

@@ -1,5 +1,5 @@
 import type { Observable } from 'rxjs';
-import type { HttpParams } from '@opra/common';
+import type { OpraSchema } from '@opra/common';
 import type { OpraHttpClient } from './client';
 import type { HttpRequest } from './http-request.js';
 import type { HttpResponse } from './http-response.js';
@@ -7,6 +7,7 @@ export type HttpRequestHandler = (observe: HttpObserveType, request: HttpRequest
 export type RequestInterceptor = (ctx: HttpClientContext, request: HttpRequest) => void | Promise<void>;
 export type ResponseInterceptor = ((ctx: HttpClientContext, observe: HttpObserveType, response: any) => void | Promise<void>);
 export type HttpEvent = HttpSentEvent | HttpDownloadProgressEvent | HttpUploadProgressEvent | HttpResponseHeaderEvent | HttpResponseEvent | HttpUserEvent;
+export type URLSearchParamsInit = string[][] | Record<string, string> | string | URLSearchParams;
 export declare enum HttpObserveType {
     Response = "response",
     Body = "body",
@@ -44,15 +45,17 @@ export declare enum HttpEventType {
     Custom = "custom"
 }
 export interface HttpClientContext {
-    readonly client: OpraHttpClient;
-    readonly resourceName: string;
+    client: OpraHttpClient;
+    resourceKind: OpraSchema.Resource.Kind;
+    resourceName: string;
+    operation: string;
     send: HttpRequestHandler;
     requestInterceptors?: RequestInterceptor[];
     responseInterceptors?: ResponseInterceptor[];
 }
 export interface HttpRequestDefaults extends Partial<Pick<HttpRequest, 'cache' | 'credentials' | 'destination' | 'integrity' | 'keepalive' | 'mode' | 'redirect' | 'referrer' | 'referrerPolicy'>> {
     headers?: HeadersInit;
-    params?: HttpParams.Initiator;
+    params?: URLSearchParamsInit;
 }
 interface HttpEventBase {
     observe: HttpObserveType;