@opra/client 0.17.1 → 0.17.2

package/types/common/http/http-response-message.d.ts

@@ -1,318 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Readable } from 'stream';
-import { HttpMessage, HttpMessageHost } from './http-message.host.js';
-import type { HttpRequestMessage } from './http-request-message.js';
-import { CookieOptions } from './interfaces/cookie-options.interface.js';
-export interface HttpResponseMessage extends HttpMessage {
-    method?: string | undefined;
-    url?: string | undefined;
-    body?: any;
-    statusCode?: number;
-    statusMessage?: string;
-    readonly upgrade?: any;
-    /**
-     * Return request header.
-     *
-     * The `Referrer` header field is special-cased,
-     * both `Referrer` and `Referer` are interchangeable.
-     *
-     * Examples:
-     *
-     *     req.get('Content-Type');
-     *     // => "text/plain"
-     *
-     *     req.get('content-type');
-     *     // => "text/plain"
-     *
-     *     req.get('Something');
-     *     // => undefined
-     *
-     * Aliased as `req.header()`.
-     */
-    get(field: string): string | undefined;
-    getHeader(name: string): number | string | string[] | undefined;
-    /**
-     * Set header `field` to `val`,
-     * or pass an object of header fields.
-     *
-     * Examples:
-     *
-     *    msg.setHeader('Foo', ['bar', 'baz']);
-     *    msg.setHeader('Accept', 'application/json');
-     *    msg.setHeader({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
-     *
-     */
-    setHeader(name: string, value: number | string | readonly string[]): this;
-    /**
-     * Set status `code`.
-     */
-    status(code: number): this;
-    /**
-     * Set the response HTTP status code to `statusCode` and send its string representation as the response body.
-     * @link http://expressjs.com/4x/api.html#res.sendStatus
-     *
-     * Examples:
-     *
-     *    res.sendStatus(200); // equivalent to res.status(200).send('OK')
-     *    res.sendStatus(403); // equivalent to res.status(403).send('Forbidden')
-     *    res.sendStatus(404); // equivalent to res.status(404).send('Not Found')
-     *    res.sendStatus(500); // equivalent to res.status(500).send('Internal Server Error')
-     */
-    sendStatus(code: number): this;
-    /**
-     * Set Link header field with the given `links`.
-     *
-     * Examples:
-     *
-     *    res.links({
-     *      next: 'http://api.example.com/users?page=2',
-     *      last: 'http://api.example.com/users?page=5'
-     *    });
-     */
-    links(links: any): this;
-    /**
-     * Send JSON response.
-     *
-     * Examples:
-     *
-     *     res.json(null);
-     *     res.json({ user: 'tj' });
-     *     res.status(500).json('oh noes!');
-     *     res.status(404).json('I dont have that');
-     */
-    json(body: any): this;
-    /**
-     * Set _Content-Type_ response header with `type` through `mime.lookup()`
-     * when it does not contain "/", or set the Content-Type to `type` otherwise.
-     *
-     * Examples:
-     *
-     *     res.type('.html');
-     *     res.type('html');
-     *     res.type('json');
-     *     res.type('application/json');
-     *     res.type('png');
-     */
-    contentType(type: string): this;
-    /**
-     * Set _Content-Type_ response header with `type` through `mime.lookup()`
-     * when it does not contain "/", or set the Content-Type to `type` otherwise.
-     *
-     * Examples:
-     *
-     *     res.type('.html');
-     *     res.type('html');
-     *     res.type('json');
-     *     res.type('application/json');
-     *     res.type('png');
-     */
-    type(type: string): this;
-    /**
-     * Set _Content-Disposition_ header to _attachment_ with optional `filename`.
-     */
-    attachment(filename?: string): this;
-    /**
-     * Set header `field` to `val`, or pass
-     * an object of header fields.
-     *
-     * Examples:
-     *
-     *    res.set('Foo', ['bar', 'baz']);
-     *    res.set('Accept', 'application/json');
-     *    res.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
-     *
-     * Aliased as `res.header()`.
-     */
-    set(field: any): this;
-    set(field: string, value?: string | string[]): this;
-    header(field: any): this;
-    header(field: string, value?: string | string[]): this;
-    append(field: string, value?: string | string[]): this;
-    /** Clear cookie `name`. */
-    clearCookie(name: string, options?: CookieOptions): this;
-    /**
-     * Set cookie `name` to `val`, with the given `options`.
-     *
-     * Options:
-     *
-     *    - `maxAge`   max-age in milliseconds, converted to `expires`
-     *    - `signed`   sign the cookie
-     *    - `path`     defaults to "/"
-     *
-     * Examples:
-     *
-     *    // "Remember Me" for 15 minutes
-     *    res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true });
-     *
-     *    // save as above
-     *    res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true })
-     */
-    cookie(name: string, val: string, options: CookieOptions): this;
-    cookie(name: string, val: any, options: CookieOptions): this;
-    cookie(name: string, val: any): this;
-    /**
-     * Set the location header to `url`.
-     *
-     * The given `url` can also be the name of a mapped url, for
-     * example by default express supports "back" which redirects
-     * to the _Referrer_ or _Referer_ headers or "/".
-     *
-     * Examples:
-     *
-     *    res.location('/foo/bar').;
-     *    res.location('http://example.com');
-     *    res.location('../login'); // /blog/post/1 -> /blog/login
-     *
-     * Mounting:
-     *
-     *   When an application is mounted and `res.location()`
-     *   is given a path that does _not_ lead with "/" it becomes
-     *   relative to the mount-point. For example if the application
-     *   is mounted at "/blog", the following would become "/blog/login".
-     *
-     *      res.location('login');
-     *
-     *   While the leading slash would result in a location of "/login":
-     *
-     *      res.location('/login');
-     */
-    location(url: string): this;
-    /**
-     * Redirect to the given `url` with optional response `status`
-     * defaulting to 302.
-     *
-     * The resulting `url` is determined by `res.location()`, so
-     * it will play nicely with mounted apps, relative paths,
-     * `"back"` etc.
-     *
-     * Examples:
-     *
-     *    res.redirect('back');
-     *    res.redirect('/foo/bar');
-     *    res.redirect('http://example.com');
-     *    res.redirect(301, 'http://example.com');
-     *    res.redirect('http://example.com', 301);
-     *    res.redirect('../login'); // /blog/post/1 -> /blog/login
-     */
-    redirect(url: string): void;
-    redirect(status: number, url: string): void;
-    /** @deprecated use res.redirect(status, url) instead */
-    redirect(url: string, status: number): void;
-}
-/**
- * @namespace HttpResponseMessage
- */
-export declare namespace HttpResponseMessage {
-    interface Initiator extends HttpMessage.Initiator {
-        statusCode?: number;
-        statusMessage?: string;
-        req?: HttpRequestMessage;
-        chunkedEncoding?: boolean;
-    }
-    function create(init: Initiator): HttpResponseMessage;
-    function fromBuffer(buffer: Buffer | ArrayBuffer): HttpResponseMessage;
-    function fromStream(readable: Readable): Promise<HttpResponseMessage>;
-}
-/**
- * @class HttpResponseMessageHost
- */
-export declare class HttpResponseMessageHost extends HttpMessageHost implements HttpResponseMessage {
-    chunkedEncoding?: boolean;
-    req?: HttpRequestMessage;
-    statusCode?: number;
-    statusMessage?: string;
-    constructor();
-    header(name: 'set-cookie' | 'Set-Cookie', value: string | string[]): this;
-    header(name: string, value: number | string): this;
-    header(headers: Record<string, number | string | string[]>): this;
-    append(name: string, value: string | string[]): this;
-    /**
-     * Set "Content-Disposition" header to "attachment" with optional `filename`.
-     */
-    attachment(filename?: string): this;
-    /**
-     * Alias for msg.type()
-     */
-    contentType(type: string): this;
-    /**
-     * Set _Content-Type_ response header with `type` through `mime.lookup()`
-     * when it does not contain "/", or set the Content-Type to `type` otherwise.
-     *
-     * Examples:
-     *
-     *     res.type('.html');
-     *     res.type('html');
-     *     res.type('json');
-     *     res.type('application/json');
-     *     res.type('png');
-     */
-    type(type: string): this;
-    /**
-     * Set cookie `name` to `value`, with the given `options`.
-     *
-     * Options:
-     *
-     *    - `maxAge`   max-age in milliseconds, converted to `expires`
-     *    - `signed`   sign the cookie
-     *    - `path`     defaults to "/"
-     *
-     * Examples:
-     *
-     *    // "Remember Me" for 15 minutes
-     *    res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true });
-     *
-     *    // same as above
-     *    res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true })
-     *
-     */
-    cookie(name: string, value: string, options?: CookieOptions): this;
-    /**
-     * Clear cookie `name`.
-     */
-    clearCookie(name: string, options?: CookieOptions): this;
-    /**
-     * Set Link header field with the given `links`.
-     *
-     * Examples:
-     *
-     *    res.links({
-     *      next: 'http://api.example.com/users?page=2',
-     *      last: 'http://api.example.com/users?page=5'
-     *    });
-     *
-     */
-    links(links: Record<string, string>): this;
-    redirect(url: string): any;
-    redirect(status: number, url: string): any;
-    /**
-     * Send JSON response.
-     *
-     * Examples:
-     *
-     *     res.json(null);
-     *     res.json({ user: 'tj' });
-     */
-    json(obj: any): this;
-    location(url: string): this;
-    /**
-     * Set status `code`.
-     */
-    status(code: number): this;
-    /**
-     * Set the response HTTP status code to `statusCode` and send its string representation as the response body.
-     * @link http://expressjs.com/4x/api.html#res.sendStatus
-     *
-     * Examples:
-     *
-     *    res.sendStatus(200); // equivalent to res.status(200).send('OK')
-     *    res.sendStatus(403); // equivalent to res.status(403).send('Forbidden')
-     *    res.sendStatus(404); // equivalent to res.status(404).send('Not Found')
-     *    res.sendStatus(500); // equivalent to res.status(500).send('Internal Server Error')
-     */
-    sendStatus(statusCode: number): this;
-    protected _init(init: HttpResponseMessage.Initiator): void;
-    static create(init: HttpResponseMessage.Initiator): HttpResponseMessage;
-    static fromBuffer(buffer: Buffer | ArrayBuffer): HttpResponseMessage;
-    static fromStream(readable: Readable): Promise<HttpResponseMessage>;
-}

package/types/common/http/index.d.ts

@@ -1,14 +0,0 @@
-export * from './http-headers.js';
-export * from './http-params.js';
-export * from './http-response-message.js';
-export * from './http-request-message.js';
-export * from './enums/http-headers-codes.enum.js';
-export * from './enums/http-status-codes.enum.js';
-export * from './interfaces/client-http-headers.interface.js';
-export * from './interfaces/server-http-headers.interface.js';
-export * from './codecs/date-codec.js';
-export * from './codecs/boolean-codec.js';
-export * from './codecs/filter-codec.js';
-export * from './codecs/integer-codec.js';
-export * from './codecs/number-codec.js';
-export * from './codecs/string-codec.js';

package/types/common/http/interfaces/client-http-headers.interface.d.ts

@@ -1,65 +0,0 @@
-export type ClientHttpHeaders = Record<string, string | string[]> & {
-    accept?: string;
-    'accept-language'?: string;
-    'accept-patch'?: string;
-    'accept-ranges'?: string;
-    'access-control-allow-credentials'?: string;
-    'access-control-allow-headers'?: string;
-    'access-control-allow-methods'?: string;
-    'access-control-allow-origin'?: string;
-    'access-control-expose-headers'?: string;
-    'access-control-max-age'?: string;
-    'access-control-request-headers'?: string;
-    'access-control-request-method'?: string;
-    age?: string;
-    allow?: string;
-    'alt-svc'?: string;
-    authorization?: string;
-    'cache-control'?: string;
-    connection?: string;
-    'content-disposition'?: string;
-    'content-encoding'?: string;
-    'content-language'?: string;
-    'content-length'?: string;
-    'content-location'?: string;
-    'content-range'?: string;
-    'content-type'?: string;
-    cookie?: string;
-    date?: string;
-    etag?: string;
-    expect?: string;
-    expires?: string;
-    forwarded?: string;
-    from?: string;
-    host?: string;
-    'if-match'?: string;
-    'if-modified-since'?: string;
-    'if-none-match'?: string;
-    'if-unmodified-since'?: string;
-    'last-modified'?: string;
-    location?: string;
-    origin?: string;
-    pragma?: string;
-    'proxy-authenticate'?: string;
-    'proxy-authorization'?: string;
-    'public-key-pins'?: string;
-    range?: string;
-    referer?: string;
-    'retry-after'?: string;
-    'sec-websocket-accept'?: string;
-    'sec-websocket-extensions'?: string;
-    'sec-websocket-key'?: string;
-    'sec-websocket-protocol'?: string;
-    'sec-websocket-version'?: string;
-    'set-cookie'?: string[];
-    'strict-transport-security'?: string;
-    tk?: string;
-    trailer?: string;
-    'transfer-encoding'?: string;
-    upgrade?: string;
-    'user-agent'?: string;
-    vary?: string;
-    via?: string;
-    warning?: string;
-    'www-authenticate'?: string;
-};

package/types/common/http/interfaces/cookie-options.interface.d.ts

@@ -1,4 +0,0 @@
-import cookie from 'cookie';
-export interface CookieOptions extends cookie.CookieSerializeOptions {
-    signed?: boolean;
-}

package/types/common/http/interfaces/server-http-headers.interface.d.ts

@@ -1 +0,0 @@
-export type ServerHttpHeaders = Record<string, string | string[]> & {};

package/types/common/i18n/i18n.d.ts

@@ -1,28 +0,0 @@
-import { FallbackLng, Formatter as I18nextFormatter, i18n, InitOptions as I18nextInitOptions, Resource as I18nextResource, TFunction as I18nextTFunction, TOptions } from '@browsery/i18next';
-import * as I18next from '@browsery/i18next';
-import { Type } from 'ts-gems';
-export type BaseI18n = Type<I18next.i18n>;
-export declare const BaseI18n: BaseI18n;
-export type DeepTranslateOptions = TOptions & {
-    ignore?: (input: any, inst: i18n) => boolean;
-};
-export type InitCallback = I18next.Callback;
-export type TranslateFunction = I18nextTFunction;
-export type Formatter = I18nextFormatter;
-export type LanguageResource = I18nextResource;
-export type { FallbackLng };
-export interface InitOptions extends I18nextInitOptions {
-    resourceDirs?: string[];
-}
-export declare class I18n extends BaseI18n {
-    init(callback?: InitCallback): Promise<TranslateFunction>;
-    init(options: InitOptions, callback?: InitCallback): Promise<TranslateFunction>;
-    deep(input: any, options?: DeepTranslateOptions): any;
-    registerLocaleDir(...dirname: string[]): void;
-    loadResourceBundle(lang: string, ns: string, filePath: string, deep?: boolean, overwrite?: boolean): Promise<void>;
-    loadResourceDir(dirnames: string | string[], deep?: boolean, overwrite?: boolean): Promise<void>;
-    createInstance(options: {} | undefined, callback: any): I18n;
-    static createInstance(options?: InitOptions, callback?: InitCallback): I18n;
-    protected _deepTranslate(input: any, objectStack: WeakMap<object, any>, options?: DeepTranslateOptions): any;
-    static get defaultInstance(): I18n;
-}

package/types/common/i18n/index.d.ts

@@ -1,5 +0,0 @@
-import { I18n } from './i18n.js';
-export * from './i18n.js';
-export * from './translate.js';
-declare const i18n: I18n;
-export { i18n };

package/types/common/i18n/string-utils.d.ts

@@ -1,2 +0,0 @@
-export declare function escapeString(s: string): string;
-export declare function unescapeString(s: string): string;

package/types/common/i18n/translate.d.ts

@@ -1,4 +0,0 @@
-import { TOptions } from '@browsery/i18next';
-export declare function translate(key: string, options?: TOptions<Record<string, any>>): string;
-export declare function translate(key: string, options: TOptions<Record<string, any>>, fallback: string): string;
-export declare function translate(key: string, fallback: string): string;

package/types/common/index.d.ts

@@ -1,11 +0,0 @@
-export * from './types.js';
-export * from './document/index.js';
-export * from './exception/index.js';
-export * from './filter/index.js';
-export * from './helpers/index.js';
-export * from './http/index.js';
-export * from './i18n/index.js';
-export * from './schema/index.js';
-export * from './url/index.js';
-export * from './utils/path-utils.js';
-export { uid } from 'uid';

package/types/common/schema/constants.d.ts

@@ -1,2 +0,0 @@
-export declare const SpecVersion = "1.0";
-export type SpecVersion = '1.0';

package/types/common/schema/data-type/complex-type.interface.d.ts

@@ -1,16 +0,0 @@
-import { Type } from 'ts-gems';
-import type { DataType, DataTypeBase } from './data-type.interface.js';
-import { Field } from './field.interface.js';
-import type { MappedType } from './mapped-type.interface.js';
-import type { UnionType } from './union-type.interface.js';
-export interface ComplexType extends DataTypeBase {
-    ctor?: Type;
-    base?: DataType.Name | ComplexType | UnionType | MappedType;
-    abstract?: boolean;
-    fields?: Record<Field.Name, Field | DataType.Name>;
-    additionalFields?: boolean;
-}
-export declare namespace ComplexType {
-    const Kind = "ComplexType";
-    type Kind = 'ComplexType';
-}

package/types/common/schema/data-type/data-type.interface.d.ts

@@ -1,14 +0,0 @@
-import type { ComplexType } from './complex-type.interface.js';
-import type { EnumType } from './enum-type.interface.js';
-import type { MappedType } from './mapped-type.interface.js';
-import type { SimpleType } from './simple-type.interface.js';
-import type { UnionType } from './union-type.interface.js';
-export type DataType = SimpleType | EnumType | ComplexType | MappedType | UnionType;
-export declare namespace DataType {
-    type Name = string;
-    type Kind = ComplexType.Kind | EnumType.Kind | MappedType.Kind | SimpleType.Kind | UnionType.Kind;
-}
-export type DataTypeBase = {
-    kind: DataType.Kind;
-    description?: string;
-};

package/types/common/schema/data-type/enum-type.interface.d.ts

@@ -1,15 +0,0 @@
-import type { DataType, DataTypeBase } from './data-type.interface.js';
-export interface EnumType extends DataTypeBase {
-    base?: DataType.Name | EnumType;
-    values: Record<EnumType.key, EnumType.value>;
-    meanings?: Record<EnumType.key, string>;
-}
-export type EnumObject = Record<EnumType.key, EnumType.value>;
-export type EnumArray = readonly (string | number)[];
-export type EnumThunk = EnumObject | EnumArray;
-export declare namespace EnumType {
-    const Kind = "EnumType";
-    type Kind = typeof Kind;
-    type value = string | number;
-    type key = string;
-}

package/types/common/schema/data-type/field.interface.d.ts

@@ -1,21 +0,0 @@
-import type { DataType } from './data-type.interface.js';
-export declare namespace Field {
-    type Name = string;
-    type QualifiedName = string;
-}
-export type Field = {
-    type: DataType.Name | DataType;
-    description?: string;
-    isArray?: boolean;
-    default?: any;
-    required?: boolean;
-    format?: string;
-    fixed?: string | number;
-    examples?: any[] | Record<string, any>;
-    deprecated?: boolean | string;
-    /**
-     * If true, this Field will not be included in results by default.
-     * The client side should include the Field name in the "include" query parameter.
-     */
-    exclusive?: boolean;
-};

package/types/common/schema/data-type/mapped-type.interface.d.ts

@@ -1,11 +0,0 @@
-import type { DataType, DataTypeBase } from './data-type.interface.js';
-import { Field } from './field.interface.js';
-export interface MappedType extends DataTypeBase {
-    type: DataType.Name | DataType;
-    omit?: Field.Name[];
-    pick?: Field.Name[];
-}
-export declare namespace MappedType {
-    const Kind = "MappedType";
-    type Kind = 'MappedType';
-}

package/types/common/schema/data-type/simple-type.interface.d.ts

@@ -1,18 +0,0 @@
-import { Type } from 'ts-gems';
-import type { DataType, DataTypeBase } from './data-type.interface.js';
-export interface SimpleType extends DataTypeBase {
-    ctor?: Type;
-    base?: DataType.Name | SimpleType;
-    pattern?: string | RegExp;
-    codec?: SimpleType.Codec;
-}
-export declare namespace SimpleType {
-    const Kind = "SimpleType";
-    type Kind = 'SimpleType';
-    interface Codec {
-        decode?: (v: any) => any;
-        encode?: (v: any) => any;
-        coerce?: (v: any) => any;
-        validate?: (v: any) => void;
-    }
-}

package/types/common/schema/data-type/union-type.interface.d.ts

@@ -1,10 +0,0 @@
-import type { ComplexType } from './complex-type.interface.js';
-import type { DataType, DataTypeBase } from './data-type.interface.js';
-import type { MappedType } from './mapped-type.interface.js';
-export declare namespace UnionType {
-    const Kind = "UnionType";
-    type Kind = 'UnionType';
-}
-export interface UnionType extends DataTypeBase {
-    types: (DataType.Name | ComplexType | UnionType | MappedType)[];
-}

package/types/common/schema/document.interface.d.ts

@@ -1,34 +0,0 @@
-import type { SpecVersion } from './constants.js';
-import type { DataType } from './data-type/data-type.interface.js';
-import type { Resource } from './resource/resource.interface.js';
-export interface ApiDocument {
-    version: SpecVersion;
-    url?: string;
-    info: DocumentInfo;
-    references?: Record<string, string | ApiDocument>;
-    types?: Record<DataType.Name, DataType>;
-    resources?: Record<Resource.Name, Resource>;
-    servers?: ServerInfo[];
-}
-export type DocumentInfo = {
-    title: string;
-    version: string;
-    description?: string;
-    termsOfService?: string;
-    contact?: ContactPerson[];
-    license?: LicenseInfo;
-};
-export type ServerInfo = {
-    url: string;
-    description?: string;
-};
-export type ContactPerson = {
-    name?: string;
-    email?: string;
-    url?: string;
-};
-export type LicenseInfo = {
-    name: string;
-    url?: string;
-    content?: string;
-};