@opra/common 0.33.13 → 1.0.0-alpha.2

package/types/http/opra-url.d.ts

@@ -1,66 +0,0 @@
-import { OpraURLPath } from './opra-url-path.js';
-declare const nodeInspectCustom: unique symbol;
-declare const kContext: unique symbol;
-declare const kPath: unique symbol;
-declare const kSearchParams: unique symbol;
-export declare class OpraURL {
-    protected static kContext: symbol;
-    protected static kPath: symbol;
-    protected static kParams: symbol;
-    protected [kPath]: OpraURLPath;
-    protected [kSearchParams]: URLSearchParams;
-    protected [kContext]: {
-        protocol: string;
-        username: string;
-        pathname?: string;
-        hostname: string;
-        port: string;
-        hash: string;
-        password: string;
-        address?: string;
-    };
-    constructor(input?: string | URL | OpraURL, base?: string | URL | OpraURL);
-    get address(): string;
-    get host(): string;
-    set host(v: string);
-    get hostname(): string;
-    set hostname(v: string);
-    get href(): string;
-    get password(): string;
-    set password(v: string);
-    get port(): string;
-    set port(value: string | number);
-    get protocol(): string;
-    set protocol(v: string);
-    get username(): string;
-    set username(v: string);
-    get origin(): string;
-    get path(): OpraURLPath;
-    set path(path: OpraURLPath);
-    get pathname(): string;
-    set pathname(v: string);
-    get hash(): string;
-    set hash(v: string);
-    get search(): string;
-    set search(v: string);
-    get searchParams(): URLSearchParams;
-    set setSearchParams(v: URLSearchParams);
-    invalidate(): void;
-    join(...items: OpraURLPath.ComponentLike[]): this;
-    resolve(...items: OpraURLPath.ComponentLike[]): OpraURL;
-    toString(): string;
-    protected _parse(input: string): void;
-    [nodeInspectCustom](): {
-        protocol: string;
-        username: string;
-        password: string;
-        host: string;
-        hostname: string;
-        origin: string;
-        path: OpraURLPath;
-        pathname: string;
-        search: string;
-        hash: string;
-    };
-}
-export {};

package/types/schema/document/api-document.interface.d.ts

@@ -1,11 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import type { Container } from '../resource/container.interface';
-import { TypeDocument } from './type-document.interface.js';
-export interface ApiDocument extends TypeDocument {
-    servers?: ServerInfo[];
-    root?: StrictOmit<Container, 'kind'>;
-}
-export type ServerInfo = {
-    url: string;
-    description?: string;
-};

package/types/schema/document/document-base.interface.d.ts

@@ -1,24 +0,0 @@
-import type { SpecVersion } from '../constants';
-export interface DocumentBase {
-    version: SpecVersion;
-    url?: string;
-    info: DocumentInfo;
-}
-export type DocumentInfo = {
-    title: string;
-    version: string;
-    description?: string;
-    termsOfService?: string;
-    contact?: ContactPerson[];
-    license?: LicenseInfo;
-};
-export type ContactPerson = {
-    name?: string;
-    email?: string;
-    url?: string;
-};
-export type LicenseInfo = {
-    name: string;
-    url?: string;
-    content?: string;
-};

package/types/schema/document/type-document.interface.d.ts

@@ -1,6 +0,0 @@
-import type { DataType } from '../data-type/data-type.interface';
-import type { DocumentBase } from './document-base.interface.js';
-export interface TypeDocument extends DocumentBase {
-    references?: Record<string, string | TypeDocument>;
-    types?: Record<DataType.Name, DataType>;
-}

package/types/schema/opra-schema.ns.d.ts

@@ -1,19 +0,0 @@
-export * from './data-type/complex-type.interface.js';
-export * from './data-type/data-type.interface.js';
-export * from './data-type/enum-type.interface.js';
-export * from './data-type/field.interface.js';
-export * from './data-type/simple-type.interface.js';
-export * from './data-type/mapped-type.interface.js';
-export * from './data-type/mixin-type.interface.js';
-export * from './resource/action.interface.js';
-export * from './resource/endpoint.interface.js';
-export * from './resource/collection.interface.js';
-export * from './resource/container.interface.js';
-export * from './resource/resource.interface.js';
-export * from './resource/singleton.interface.js';
-export * from './resource/storage.interface.js';
-export * from './constants.js';
-export * from './document/document-base.interface.js';
-export * from './document/type-document.interface.js';
-export * from './document/api-document.interface.js';
-export * from './type-guards.js';

package/types/schema/resource/action.interface.d.ts

@@ -1,6 +0,0 @@
-import { DataType } from '../data-type/data-type.interface.js';
-import { Endpoint } from './endpoint.interface.js';
-export interface Action extends Endpoint {
-    returnType?: string | DataType;
-    returnMime?: string;
-}

package/types/schema/resource/collection.interface.d.ts

@@ -1,55 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import type { OpraFilter } from '../../filter/index.js';
-import type { DataType } from '../data-type/data-type.interface.js';
-import type { Field } from '../data-type/field.interface';
-import type { Endpoint } from './endpoint.interface.js';
-import type { ResourceBase } from './resource.interface.js';
-export interface Collection extends StrictOmit<ResourceBase, 'kind'> {
-    kind: Collection.Kind;
-    type: DataType.Name;
-    primaryKey: Field.Name | Field.Name[];
-    operations?: Collection.Operations;
-}
-export declare namespace Collection {
-    const Kind = "Collection";
-    type Kind = 'Collection';
-    interface Operations {
-        create?: Operations.Create;
-        delete?: Operations.Delete;
-        deleteMany?: Operations.DeleteMany;
-        findMany?: Operations.FindMany;
-        get?: Operations.Get;
-        update?: Operations.Update;
-        updateMany?: Operations.UpdateMany;
-    }
-    namespace Operations {
-        type Create = Endpoint<_InputOptions & _OutputOptions>;
-        type Delete = Endpoint;
-        type DeleteMany = Endpoint<_FilterOption>;
-        type Get = Endpoint & _OutputOptions;
-        type FindMany = Endpoint<_FilterOption & _OutputOptions & {
-            sortFields?: string[];
-            defaultSort?: string[];
-        }>;
-        type Update = Endpoint<_InputOptions & _OutputOptions>;
-        type UpdateMany = Endpoint<_FilterOption & _InputOptions & _OutputOptions>;
-    }
-}
-interface _FilterOption {
-    filters?: {
-        field: Field.QualifiedName;
-        operators?: OpraFilter.ComparisonOperator[];
-        notes?: string;
-    }[];
-}
-interface _InputOptions {
-    inputMaxContentSize?: number | string;
-    inputPick?: Field.QualifiedName[];
-    inputOmit?: Field.QualifiedName[];
-    inputOverwriteFields?: Record<string, Field>;
-}
-interface _OutputOptions {
-    outputPick?: Field.QualifiedName[];
-    outputOmit?: Field.QualifiedName[];
-}
-export {};

package/types/schema/resource/container.interface.d.ts

@@ -1,10 +0,0 @@
-import type { StrictOmit } from 'ts-gems';
-import type { Resource, ResourceBase } from './resource.interface';
-export interface Container extends StrictOmit<ResourceBase, 'kind'> {
-    kind: Container.Kind;
-    resources?: Record<Resource.Name, Resource>;
-}
-export declare namespace Container {
-    const Kind = "Container";
-    type Kind = 'Container';
-}

package/types/schema/resource/endpoint.interface.d.ts

@@ -1,13 +0,0 @@
-import { Field } from '../data-type/field.interface.js';
-export interface Endpoint<TOptions extends Object = any> {
-    description?: string;
-    parameters?: Record<Endpoint.Parameter.Name, Endpoint.Parameter>;
-    options?: TOptions;
-}
-export declare namespace Endpoint {
-    interface Parameter extends Pick<Field, 'type' | 'description' | 'isArray' | 'default' | 'required' | 'deprecated' | 'examples'> {
-    }
-    namespace Parameter {
-        type Name = string;
-    }
-}

package/types/schema/resource/resource.interface.d.ts

@@ -1,15 +0,0 @@
-import { Action } from './action.interface.js';
-import type { Collection } from './collection.interface.js';
-import type { Container } from './container.interface.js';
-import type { Singleton } from './singleton.interface.js';
-import type { Storage } from './storage.interface.js';
-export type Resource = Collection | Singleton | Storage | Container;
-export declare namespace Resource {
-    type Name = string;
-    type Kind = Collection.Kind | Singleton.Kind | Storage.Kind | Container.Kind;
-}
-export interface ResourceBase {
-    kind: string;
-    description?: string;
-    actions?: Record<string, Action | undefined>;
-}

package/types/schema/resource/singleton.interface.d.ts

@@ -1,25 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import type { DataType } from '../data-type/data-type.interface.js';
-import type { Collection } from './collection.interface.js';
-import type { ResourceBase } from './resource.interface.js';
-export interface Singleton extends StrictOmit<ResourceBase, 'kind'> {
-    kind: Singleton.Kind;
-    type: DataType.Name;
-    operations?: Singleton.Operations;
-}
-export declare namespace Singleton {
-    const Kind = "Singleton";
-    type Kind = 'Singleton';
-    interface Operations {
-        create?: Operations.Create;
-        delete?: Operations.Delete;
-        get?: Operations.Get;
-        update?: Operations.Update;
-    }
-    namespace Operations {
-        type Create = Collection.Operations.Create;
-        type Delete = Collection.Operations.Delete;
-        type Get = Collection.Operations.Get;
-        type Update = Collection.Operations.Update;
-    }
-}

package/types/schema/resource/storage.interface.d.ts

@@ -1,61 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import { DataType } from '../data-type/data-type.interface.js';
-import type { Endpoint } from './endpoint.interface.js';
-import type { ResourceBase } from './resource.interface.js';
-export interface Storage extends StrictOmit<ResourceBase, 'kind'> {
-    kind: Storage.Kind;
-    operations?: Storage.Operations;
-}
-export declare namespace Storage {
-    const Kind = "Storage";
-    type Kind = 'Storage';
-    interface Operations {
-        delete?: Operations.Delete;
-        get?: Operations.Get;
-        post?: Operations.Post;
-        [key: string]: Endpoint | undefined;
-    }
-    namespace Operations {
-        type Delete = Endpoint;
-        type Get = Endpoint;
-        type Post = Endpoint & {
-            returnType?: string | DataType;
-            /**
-             * the minium size of uploaded file
-             *
-             * @default 1
-             */
-            minFileSize?: number | undefined;
-            /**
-             * limit the amount of uploaded files, set Infinity for unlimited
-             *
-             * @default Infinity
-             */
-            maxFiles?: number;
-            /**
-             * limit the size of uploaded file
-             *
-             * @default 200 * 1024 * 1024
-             */
-            maxFileSize?: number | undefined;
-            /**
-             * limit the size of the batch of uploaded files
-             *
-             * @default maxFileSize
-             */
-            maxTotalFileSize?: number | undefined;
-            /**
-             * limit the number of fields, set 0 for unlimited
-             *
-             * @default 1000
-             */
-            maxFields?: number | undefined;
-            /**
-             * limit the amount of memory all fields together (except files) can allocate in bytes
-             *
-             * @default 20 * 1024 * 1024
-             */
-            maxFieldsSize?: number | undefined;
-        };
-    }
-}