@opra/common 0.20.3 → 0.21.0

package/types/document/factory/factory.d.ts

@@ -7,7 +7,7 @@ import { addReferences } from './add-references.js';
 import { createBuiltinTypeDocument, createDocument, createDocumentFromUrl } from './create-document.js';
 import { extractCollectionSchema, extractSingletonSchema, importResourceClass } from './import-resource-class.js';
 import { extractComplexTypeSchema, extractEnumTypeSchema, extractFieldSchema, extractMappedTypeSchema, extractSimpleTypeSchema, extractUnionTypeSchema, importTypeClass } from './import-type-class.js';
-import { createCollection, createSingleton, processResourceQueue } from './process-resources.js';
+import { createCollectionResource, createFileResource, createSingletonResource, processResourceQueue } from './process-resources.js';
 import { addDataType, createDataTypeInstance, processTypes } from './process-types.js';
 /**
  * @namespace DocumentFactory
@@ -48,8 +48,9 @@ export declare class DocumentFactory {
     protected extractSingletonSchema: typeof extractSingletonSchema;
     protected extractCollectionSchema: typeof extractCollectionSchema;
     protected processResourceQueue: typeof processResourceQueue;
-    protected createCollection: typeof createCollection;
-    protected createSingleton: typeof createSingleton;
+    protected createCollectionResource: typeof createCollectionResource;
+    protected createSingletonResource: typeof createSingletonResource;
+    protected createFileResource: typeof createFileResource;
     /**
      * Creates ApiDocument instance from given schema object
      * @param init

package/types/document/factory/process-resources.d.ts

@@ -1,7 +1,9 @@
 import { OpraSchema } from '../../schema/index.js';
 import { Collection } from '../resource/collection.js';
 import { Singleton } from '../resource/singleton.js';
+import { Storage } from '../resource/storage.js';
 import type { DocumentFactory } from './factory.js';
 export declare function processResourceQueue(this: DocumentFactory): Promise<void>;
-export declare function createCollection(this: DocumentFactory, name: string, schema: OpraSchema.Collection): Promise<Collection>;
-export declare function createSingleton(this: DocumentFactory, name: string, schema: OpraSchema.Singleton): Promise<Singleton>;
+export declare function createCollectionResource(this: DocumentFactory, name: string, schema: OpraSchema.Collection): Promise<Collection>;
+export declare function createSingletonResource(this: DocumentFactory, name: string, schema: OpraSchema.Singleton): Promise<Singleton>;
+export declare function createFileResource(this: DocumentFactory, name: string, schema: OpraSchema.Storage): Promise<Storage>;

package/types/document/index.d.ts

@@ -12,3 +12,4 @@ export * from './data-type/union-type.js';
 export * from './resource/resource.js';
 export * from './resource/collection.js';
 export * from './resource/singleton.js';
+export * from './resource/storage.js';

package/types/document/resource/storage.d.ts

@@ -0,0 +1,44 @@
+import { StrictOmit, Type } from 'ts-gems';
+import { OpraSchema } from '../../schema/index.js';
+import type { ApiDocument } from '../api-document.js';
+import { Resource } from './resource.js';
+export declare namespace Storage {
+    export interface InitArguments extends Resource.InitArguments, Pick<OpraSchema.Storage, 'operations'> {
+    }
+    export interface DecoratorOptions extends Resource.DecoratorOptions {
+    }
+    export interface Metadata extends OpraSchema.Storage {
+        name: string;
+    }
+    interface Operation {
+        handlerName?: string;
+    }
+    export interface Operations {
+        delete?: OpraSchema.Storage.DeleteOperation & Operation;
+        get?: OpraSchema.Storage.GetOperation & Operation;
+        put?: OpraSchema.Storage.PutOperation & Operation;
+    }
+    export type DeleteOperationOptions = StrictOmit<OpraSchema.Storage.DeleteOperation, 'handler'>;
+    export type GetOperationOptions = StrictOmit<OpraSchema.Storage.GetOperation, 'handler'>;
+    export type PutOperationOptions = StrictOmit<OpraSchema.Storage.PutOperation, 'handler'>;
+    export {};
+}
+declare class StorageClass extends Resource {
+    readonly kind = "Storage";
+    readonly operations: Storage.Operations;
+    readonly controller?: object | Type;
+    constructor(document: ApiDocument, init: Storage.InitArguments);
+    exportSchema(): OpraSchema.Storage;
+}
+export interface StorageConstructor {
+    prototype: Storage;
+    new (document: ApiDocument, init: Storage.InitArguments): Storage;
+    (options?: Storage.DecoratorOptions): ClassDecorator;
+    Delete: (options?: Storage.DeleteOperationOptions) => PropertyDecorator;
+    Get: (options?: Storage.GetOperationOptions) => PropertyDecorator;
+    Put: (options?: Storage.PutOperationOptions) => PropertyDecorator;
+}
+export interface Storage extends StorageClass {
+}
+export declare const Storage: StorageConstructor;
+export {};

package/types/helpers/mixin-utils.d.ts

@@ -1,3 +1,3 @@
 import { Type } from 'ts-gems';
-export declare function applyMixins(derivedCtor: any, baseCtor: any, filter?: (k: string) => boolean): void;
+export declare function mergePrototype(targetProto: any, baseProto: any, filter?: (k: string) => boolean): void;
 export declare function inheritPropertyInitializers(target: Record<string, any>, sourceClass: Type, isPropertyInherited?: (key: string) => boolean): void;

package/types/http/index.d.ts

@@ -1,4 +1,3 @@
-export * from './http-headers.js';
 export * from './http-params.js';
 export * from './enums/http-headers-codes.enum.js';
 export * from './enums/http-status-codes.enum.js';

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

@@ -10,6 +10,7 @@ export * from './resource/container.interface.js';
 export * from './resource/endpoint.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.interface.js';
 export * from './type-guards.js';

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

@@ -1,10 +1,11 @@
 import type { Collection } from './collection.interface.js';
 import type { Container } from './container.interface.js';
 import type { Singleton } from './singleton.interface.js';
-export type Resource = Collection | Singleton | Container;
+import type { Storage } from './storage.interface';
+export type Resource = Collection | Singleton | Storage | Container;
 export declare namespace Resource {
     type Name = string;
-    type Kind = Collection.Kind | Singleton.Kind | Container.Kind;
+    type Kind = Collection.Kind | Singleton.Kind | Storage.Kind | Container.Kind;
 }
 export interface ResourceBase {
     kind: string;

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

@@ -0,0 +1,18 @@
+import type { Endpoint } from './endpoint.interface.js';
+import type { ResourceBase } from './resource.interface.js';
+export interface Storage extends ResourceBase {
+    kind: Storage.Kind;
+    operations: Storage.Operations;
+}
+export declare namespace Storage {
+    const Kind = "Storage";
+    type Kind = 'Storage';
+    type DeleteOperation = Endpoint;
+    type GetOperation = Endpoint;
+    type PutOperation = Endpoint & {};
+    interface Operations {
+        delete?: DeleteOperation;
+        get?: GetOperation;
+        put?: PutOperation;
+    }
+}

package/types/schema/type-guards.d.ts

@@ -17,4 +17,5 @@ export declare function isEnumType(obj: any): obj is EnumType;
 export declare function isResource(obj: any): obj is Resource;
 export declare function isCollection(obj: any): obj is Collection;
 export declare function isSingleton(obj: any): obj is Singleton;
+export declare function isStorage(obj: any): obj is Singleton;
 export declare function isContainer(obj: any): obj is Container;

package/cjs/http/http-headers.js

@@ -1,227 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpHeaders = void 0;
-const index_js_1 = require("../helpers/index.js");
-const http_headers_codes_enum_js_1 = require("./enums/http-headers-codes.enum.js");
-const knownKeys = Object.values(http_headers_codes_enum_js_1.HttpHeaderCodes);
-const knownKeysLower = knownKeys.map(x => x.toLowerCase());
-const nodeInspectCustom = Symbol.for('nodejs.util.inspect.custom');
-const kEntries = Symbol('kEntries');
-const kOptions = Symbol('kOptions');
-/**
- *
- * @class HttpHeaders
- */
-class HttpHeaders {
-    constructor(init, options) {
-        this[_a] = new index_js_1.ResponsiveMap();
-        this[kOptions] = { ...options, onChange: undefined };
-        if (init) {
-            if (typeof init === 'string')
-                this.parse(init);
-            else
-                this.set(init);
-        }
-        this[kOptions].onChange = options?.onChange;
-    }
-    get size() {
-        return this[kEntries].size;
-    }
-    /**
-     * Appends a new value to the existing set of values for a header
-     * and returns this instance
-     */
-    append(name, value) {
-        this._append(name, value);
-        this.changed();
-        return this;
-    }
-    /**
-     * Appends multiple values to the existing set of values for a header
-     * and returns this instance
-     */
-    appendAll(headers) {
-        if (headers.forEach && typeof headers.forEach === 'function')
-            headers.forEach((value, name) => this._append(name, value));
-        else
-            Object.keys(headers).forEach(name => this._append(name, headers[name]));
-        this.changed();
-        return this;
-    }
-    set(arg0, arg1) {
-        if (typeof arg0 === 'object') {
-            if (arg0.forEach && typeof arg0.forEach === 'function')
-                arg0.forEach((value, name) => this._set(name, value));
-            else
-                Object.keys(arg0).forEach(name => this._set(name, arg0[name]));
-        }
-        else {
-            if (!arg1 && arg1 !== 0)
-                this[kEntries].delete(arg0);
-            else
-                this._set(arg0, arg1);
-        }
-        this.changed();
-        return this;
-    }
-    parse(init) {
-        this.clear();
-        init.split('\n').forEach(line => {
-            const index = line.indexOf(':');
-            if (index > 0) {
-                const name = line.slice(0, index);
-                const value = line.slice(index + 1).trim();
-                if (HttpHeaders.NON_DELIMITED_HEADERS[name])
-                    this._append(name, value);
-                else if (HttpHeaders.SEMICOLON_DELIMITED_HEADERS[name]) {
-                    const a = value.split(';');
-                    this._append(name, a.length > 1 ? a : value);
-                }
-                else {
-                    const a = value.split(',');
-                    this._append(name, a.length > 1 ? a : value);
-                }
-            }
-        });
-    }
-    /**
-     * Retrieves value of a given header
-     */
-    get(name) {
-        return this[kEntries].get(name);
-    }
-    clear() {
-        if (this[kEntries].size) {
-            this[kEntries].clear();
-            this.changed();
-        }
-    }
-    /**
-     * Deletes a header entry
-     */
-    delete(name) {
-        if (this[kEntries].delete(name)) {
-            this.changed();
-            return true;
-        }
-        return false;
-    }
-    /**
-     * Returns an iterable of key, value pairs for every entry in the map.
-     */
-    entries() {
-        return this[kEntries].entries();
-    }
-    forEach(callbackFn, thisArg) {
-        const iterator = this.entries();
-        let entry = iterator.next();
-        let v;
-        while (!entry.done) {
-            v = entry.value[1];
-            callbackFn.call(thisArg || this, (Array.isArray(v) ? v.join(';') : String(v)), entry.value[0], this);
-            entry = iterator.next();
-        }
-    }
-    /**
-     * Retrieves the names of the headers.
-     */
-    keys() {
-        return this[kEntries].keys();
-    }
-    /**
-     * Checks for existence of a given header.
-     */
-    has(name) {
-        return this[kEntries].has(name);
-    }
-    sort(compareFn) {
-        this[kEntries].sort(compareFn);
-        this.changed();
-        return this;
-    }
-    toObject() {
-        const out = {};
-        for (const [k, v] of this.entries())
-            out[k] = Array.isArray(v) ? v.join(';') : String(v);
-        return out;
-    }
-    getProxy() {
-        const _this = this;
-        return this[kEntries].getProxy({
-            set(target, p, newValue, receiver) {
-                if (typeof p === 'string') {
-                    _this.set(p, newValue);
-                    return true;
-                }
-                return Reflect.set(target, p, newValue, receiver);
-            },
-        });
-    }
-    [(_a = kEntries, nodeInspectCustom)]() {
-        return this[kEntries];
-    }
-    [Symbol.iterator]() {
-        return this.entries();
-    }
-    get [Symbol.toStringTag]() {
-        return 'HttpHeaders';
-    }
-    _append(name, value) {
-        const i = knownKeysLower.indexOf(name.toLowerCase());
-        const normalizedName = knownKeys[i] || name;
-        name = name.toLowerCase();
-        let stored = this[kEntries].get(normalizedName);
-        if (HttpHeaders.NON_DELIMITED_HEADERS[name]) {
-            value = String(Array.isArray(value) ? value[0] : value);
-            this[kEntries].set(normalizedName, value);
-            return;
-        }
-        if (HttpHeaders.ARRAY_HEADERS[name]) {
-            stored = (stored ? [stored, value] : [value])
-                .flat().map(String);
-            this[kEntries].set(normalizedName, stored);
-            return;
-        }
-        const arr = stored ? [stored] : [];
-        if (Array.isArray(value))
-            arr.push(...value);
-        else
-            arr.push(value);
-        this[kEntries].set(normalizedName, arr.join(HttpHeaders.SEMICOLON_DELIMITED_HEADERS[name] ? '; ' : ', '));
-    }
-    _set(name, value) {
-        this[kEntries].delete(name);
-        if (!value && value !== 0)
-            return;
-        this._append(name, value);
-    }
-    changed() {
-        if (this[kOptions].onChange)
-            this[kOptions].onChange();
-    }
-}
-exports.HttpHeaders = HttpHeaders;
-HttpHeaders.kEntries = kEntries;
-HttpHeaders.kOptions = kOptions;
-HttpHeaders.NON_DELIMITED_HEADERS = {
-    'age': true,
-    'from': true,
-    'etag': true,
-    'server': true,
-    'referer': true,
-    'expires': true,
-    'location': true,
-    'user-agent': true,
-    'retry-after': true,
-    'content-type': true,
-    'content-length': true,
-    'max-forwards': true,
-    'last-modified': true,
-    'authorization': true,
-    'proxy-authorization': true,
-    'if-modified-since': true,
-    'if-unmodified-since': true
-};
-HttpHeaders.SEMICOLON_DELIMITED_HEADERS = { 'cookie': true };
-HttpHeaders.ARRAY_HEADERS = { 'set-cookie': true };

package/esm/http/http-headers.js

@@ -1,223 +0,0 @@
-var _a;
-import { ResponsiveMap } from '../helpers/index.js';
-import { HttpHeaderCodes } from './enums/http-headers-codes.enum.js';
-const knownKeys = Object.values(HttpHeaderCodes);
-const knownKeysLower = knownKeys.map(x => x.toLowerCase());
-const nodeInspectCustom = Symbol.for('nodejs.util.inspect.custom');
-const kEntries = Symbol('kEntries');
-const kOptions = Symbol('kOptions');
-/**
- *
- * @class HttpHeaders
- */
-export class HttpHeaders {
-    constructor(init, options) {
-        this[_a] = new ResponsiveMap();
-        this[kOptions] = { ...options, onChange: undefined };
-        if (init) {
-            if (typeof init === 'string')
-                this.parse(init);
-            else
-                this.set(init);
-        }
-        this[kOptions].onChange = options?.onChange;
-    }
-    get size() {
-        return this[kEntries].size;
-    }
-    /**
-     * Appends a new value to the existing set of values for a header
-     * and returns this instance
-     */
-    append(name, value) {
-        this._append(name, value);
-        this.changed();
-        return this;
-    }
-    /**
-     * Appends multiple values to the existing set of values for a header
-     * and returns this instance
-     */
-    appendAll(headers) {
-        if (headers.forEach && typeof headers.forEach === 'function')
-            headers.forEach((value, name) => this._append(name, value));
-        else
-            Object.keys(headers).forEach(name => this._append(name, headers[name]));
-        this.changed();
-        return this;
-    }
-    set(arg0, arg1) {
-        if (typeof arg0 === 'object') {
-            if (arg0.forEach && typeof arg0.forEach === 'function')
-                arg0.forEach((value, name) => this._set(name, value));
-            else
-                Object.keys(arg0).forEach(name => this._set(name, arg0[name]));
-        }
-        else {
-            if (!arg1 && arg1 !== 0)
-                this[kEntries].delete(arg0);
-            else
-                this._set(arg0, arg1);
-        }
-        this.changed();
-        return this;
-    }
-    parse(init) {
-        this.clear();
-        init.split('\n').forEach(line => {
-            const index = line.indexOf(':');
-            if (index > 0) {
-                const name = line.slice(0, index);
-                const value = line.slice(index + 1).trim();
-                if (HttpHeaders.NON_DELIMITED_HEADERS[name])
-                    this._append(name, value);
-                else if (HttpHeaders.SEMICOLON_DELIMITED_HEADERS[name]) {
-                    const a = value.split(';');
-                    this._append(name, a.length > 1 ? a : value);
-                }
-                else {
-                    const a = value.split(',');
-                    this._append(name, a.length > 1 ? a : value);
-                }
-            }
-        });
-    }
-    /**
-     * Retrieves value of a given header
-     */
-    get(name) {
-        return this[kEntries].get(name);
-    }
-    clear() {
-        if (this[kEntries].size) {
-            this[kEntries].clear();
-            this.changed();
-        }
-    }
-    /**
-     * Deletes a header entry
-     */
-    delete(name) {
-        if (this[kEntries].delete(name)) {
-            this.changed();
-            return true;
-        }
-        return false;
-    }
-    /**
-     * Returns an iterable of key, value pairs for every entry in the map.
-     */
-    entries() {
-        return this[kEntries].entries();
-    }
-    forEach(callbackFn, thisArg) {
-        const iterator = this.entries();
-        let entry = iterator.next();
-        let v;
-        while (!entry.done) {
-            v = entry.value[1];
-            callbackFn.call(thisArg || this, (Array.isArray(v) ? v.join(';') : String(v)), entry.value[0], this);
-            entry = iterator.next();
-        }
-    }
-    /**
-     * Retrieves the names of the headers.
-     */
-    keys() {
-        return this[kEntries].keys();
-    }
-    /**
-     * Checks for existence of a given header.
-     */
-    has(name) {
-        return this[kEntries].has(name);
-    }
-    sort(compareFn) {
-        this[kEntries].sort(compareFn);
-        this.changed();
-        return this;
-    }
-    toObject() {
-        const out = {};
-        for (const [k, v] of this.entries())
-            out[k] = Array.isArray(v) ? v.join(';') : String(v);
-        return out;
-    }
-    getProxy() {
-        const _this = this;
-        return this[kEntries].getProxy({
-            set(target, p, newValue, receiver) {
-                if (typeof p === 'string') {
-                    _this.set(p, newValue);
-                    return true;
-                }
-                return Reflect.set(target, p, newValue, receiver);
-            },
-        });
-    }
-    [(_a = kEntries, nodeInspectCustom)]() {
-        return this[kEntries];
-    }
-    [Symbol.iterator]() {
-        return this.entries();
-    }
-    get [Symbol.toStringTag]() {
-        return 'HttpHeaders';
-    }
-    _append(name, value) {
-        const i = knownKeysLower.indexOf(name.toLowerCase());
-        const normalizedName = knownKeys[i] || name;
-        name = name.toLowerCase();
-        let stored = this[kEntries].get(normalizedName);
-        if (HttpHeaders.NON_DELIMITED_HEADERS[name]) {
-            value = String(Array.isArray(value) ? value[0] : value);
-            this[kEntries].set(normalizedName, value);
-            return;
-        }
-        if (HttpHeaders.ARRAY_HEADERS[name]) {
-            stored = (stored ? [stored, value] : [value])
-                .flat().map(String);
-            this[kEntries].set(normalizedName, stored);
-            return;
-        }
-        const arr = stored ? [stored] : [];
-        if (Array.isArray(value))
-            arr.push(...value);
-        else
-            arr.push(value);
-        this[kEntries].set(normalizedName, arr.join(HttpHeaders.SEMICOLON_DELIMITED_HEADERS[name] ? '; ' : ', '));
-    }
-    _set(name, value) {
-        this[kEntries].delete(name);
-        if (!value && value !== 0)
-            return;
-        this._append(name, value);
-    }
-    changed() {
-        if (this[kOptions].onChange)
-            this[kOptions].onChange();
-    }
-}
-HttpHeaders.kEntries = kEntries;
-HttpHeaders.kOptions = kOptions;
-HttpHeaders.NON_DELIMITED_HEADERS = {
-    'age': true,
-    'from': true,
-    'etag': true,
-    'server': true,
-    'referer': true,
-    'expires': true,
-    'location': true,
-    'user-agent': true,
-    'retry-after': true,
-    'content-type': true,
-    'content-length': true,
-    'max-forwards': true,
-    'last-modified': true,
-    'authorization': true,
-    'proxy-authorization': true,
-    'if-modified-since': true,
-    'if-unmodified-since': true
-};
-HttpHeaders.SEMICOLON_DELIMITED_HEADERS = { 'cookie': true };
-HttpHeaders.ARRAY_HEADERS = { 'set-cookie': true };

package/types/http/http-headers.d.ts

@@ -1,86 +0,0 @@
-/// <reference types="node" />
-/// <reference lib="dom" />
-import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
-import { ResponsiveMap } from '../helpers/index.js';
-declare const nodeInspectCustom: unique symbol;
-declare const kEntries: unique symbol;
-declare const kOptions: unique symbol;
-/**
- *
- * @namespace HttpHeaders
- */
-export declare namespace HttpHeaders {
-    type Initiator = Headers | HttpHeaders | IncomingHttpHeaders | OutgoingHttpHeaders | HeadersObject | Map<string, string | string[]>;
-    type HeadersObject = Record<string, string | string[]>;
-    interface Options {
-        onChange?: () => void;
-    }
-}
-/**
- *
- * @class HttpHeaders
- */
-export declare class HttpHeaders {
-    protected static kEntries: symbol;
-    protected static kOptions: symbol;
-    protected [kEntries]: ResponsiveMap<string | string[]>;
-    protected [kOptions]: HttpHeaders.Options;
-    constructor(init?: HttpHeaders.Initiator | string, options?: HttpHeaders.Options);
-    get size(): number;
-    /**
-     * Appends a new value to the existing set of values for a header
-     * and returns this instance
-     */
-    append(name: string, value: string | number | string[]): this;
-    /**
-     * Appends multiple values to the existing set of values for a header
-     * and returns this instance
-     */
-    appendAll(headers: HttpHeaders.Initiator): this;
-    /**
-     * Appends multiple values to the existing set of values for a header
-     * and returns this instance
-     */
-    set(init: HttpHeaders.Initiator): this;
-    /**
-     * Sets or modifies a value for a given header.
-     * If the header already exists, its value is replaced with the given value
-     */
-    set(name: string, value: number | string | string[] | undefined): this;
-    parse(init: string): void;
-    /**
-     * Retrieves value of a given header
-     */
-    get(name: string): string | string[] | undefined;
-    clear(): void;
-    /**
-     * Deletes a header entry
-     */
-    delete(name: string): boolean;
-    /**
-     * Returns an iterable of key, value pairs for every entry in the map.
-     */
-    entries(): IterableIterator<[string, string | string[]]>;
-    forEach(callbackFn: (value: number | string | string[], key: string, parent: HttpHeaders) => void, thisArg?: any): void;
-    /**
-     * Retrieves the names of the headers.
-     */
-    keys(): IterableIterator<string>;
-    /**
-     * Checks for existence of a given header.
-     */
-    has(name: string): boolean;
-    sort(compareFn?: (a: string, b: string) => number): this;
-    toObject(): Record<string, string>;
-    getProxy(): HttpHeaders.HeadersObject;
-    [nodeInspectCustom](): ResponsiveMap<string | string[]>;
-    [Symbol.iterator](): IterableIterator<[string, number | string | string[]]>;
-    get [Symbol.toStringTag](): string;
-    protected _append(name: string, value: any): void;
-    protected _set(name: string, value: any): void;
-    protected changed(): void;
-    static NON_DELIMITED_HEADERS: any;
-    static SEMICOLON_DELIMITED_HEADERS: any;
-    static ARRAY_HEADERS: any;
-}
-export {};