@eik/core 2.1.46 → 2.1.48

package/types/handlers/alias.put.d.ts

@@ -1,11 +1,11 @@
 export default AliasPut;
 export type AliasPutOptions = {
-    cacheControl?: string;
+    cacheControl?: string | undefined;
     /**
      * List of key-value pairs [hostname, organization]
      */
-    organizations?: Array<[string, string]>;
-    sink?: import("@eik/sink").default;
+    organizations?: [string, string][] | undefined;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -18,17 +18,17 @@ export type AliasPutOptions = {
 declare const AliasPut: {
     new ({ organizations, cacheControl, logger, sink }?: AliasPutOptions): {
         _organizations: [string, string][];
-        _cacheControl: string;
-        _sink: import("@eik/sink").default;
+        _cacheControl: string | undefined;
+        _sink: import("@eik/sink").default | undefined;
         _log: abslog.ValidLogger;
         _metrics: Metrics;
         _histogram: Metrics.MetricsHistogram;
         _orgRegistry: Map<string, string>;
         _multipart: {
-            _pkgMaxFileSize: number;
+            _pkgMaxFileSize: number | undefined;
             _legalFields: string[];
             _legalFiles: string[];
-            _sink: import("@eik/sink").default;
+            _sink: import("@eik/sink").default | undefined;
             _log: abslog.ValidLogger;
             parse(incoming: any): Promise<any>;
             _handleField({ name, value }: {
@@ -58,14 +58,27 @@ declare const AliasPut: {
             get [Symbol.toStringTag](): string;
         };
         get metrics(): Metrics;
+        /**
+         * @param {any} incoming
+         */
         _parser(incoming: any): Promise<any>;
+        /**
+         * @param {any} incoming
+         */
         _exist(incoming: any): Promise<boolean>;
-        handler(req: any, user: any, type: any, name: any, alias: any): Promise<{
+        /**
+         * @param {any} req
+         * @param {any} user
+         * @param {string} type
+         * @param {string} name
+         * @param {string} alias
+         */
+        handler(req: any, user: any, type: string, name: string, alias: string): Promise<{
             _cacheControl: string;
             _statusCode: number;
             _mimeType: string;
             _location: string;
-            _stream: any;
+            _stream: import("node:stream").Readable | undefined;
             _body: any;
             _etag: string;
             get cacheControl(): string;
@@ -76,8 +89,8 @@ declare const AliasPut: {
             set location(value: string);
             get mimeType(): string;
             set mimeType(value: string);
-            get stream(): any;
-            set stream(value: any);
+            get stream(): import("node:stream").Readable | undefined;
+            set stream(value: import("node:stream").Readable | undefined);
             get body(): any;
             set body(value: any);
             get etag(): string;

package/types/handlers/auth.post.d.ts

@@ -1,11 +1,11 @@
 export default AuthPost;
 export type AuthPostOptions = {
-    authKey?: string;
-    cacheControl?: string;
+    authKey?: string | undefined;
+    cacheControl?: string | undefined;
     /**
      * List of key-value pairs [hostname, organization]
      */
-    organizations?: Array<[string, string]>;
+    organizations?: [string, string][] | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -18,17 +18,17 @@ export type AuthPostOptions = {
 declare const AuthPost: {
     new ({ organizations, cacheControl, authKey, logger }?: AuthPostOptions): {
         _organizations: [string, string][];
-        _cacheControl: string;
+        _cacheControl: string | undefined;
         _authKey: string;
         _log: abslog.ValidLogger;
         _metrics: Metrics;
         _histogram: Metrics.MetricsHistogram;
         _orgRegistry: Map<string, string>;
         _multipart: {
-            _pkgMaxFileSize: number;
+            _pkgMaxFileSize: number | undefined;
             _legalFields: string[];
             _legalFiles: string[];
-            _sink: import("@eik/sink").default;
+            _sink: import("@eik/sink").default | undefined;
             _log: abslog.ValidLogger;
             parse(incoming: any): Promise<any>;
             _handleField({ name, value }: {
@@ -58,13 +58,19 @@ declare const AuthPost: {
             get [Symbol.toStringTag](): string;
         };
         get metrics(): Metrics;
+        /**
+         * @param {any} incoming
+         */
         _parser(incoming: any): Promise<any>;
+        /**
+         * @param {any} req
+         */
         handler(req: any): Promise<{
             _cacheControl: string;
             _statusCode: number;
             _mimeType: string;
             _location: string;
-            _stream: any;
+            _stream: import("node:stream").Readable | undefined;
             _body: any;
             _etag: string;
             get cacheControl(): string;
@@ -75,8 +81,8 @@ declare const AuthPost: {
             set location(value: string);
             get mimeType(): string;
             set mimeType(value: string);
-            get stream(): any;
-            set stream(value: any);
+            get stream(): import("node:stream").Readable | undefined;
+            set stream(value: import("node:stream").Readable | undefined);
             get body(): any;
             set body(value: any);
             get etag(): string;

package/types/handlers/map.get.d.ts

@@ -1,12 +1,12 @@
 export default MapGet;
 export type MapGetOptions = {
-    etag?: boolean;
-    cacheControl?: string;
+    etag?: boolean | undefined;
+    cacheControl?: string | undefined;
     /**
      * List of key-value pairs [hostname, organization]
      */
-    organizations?: Array<[string, string]>;
-    sink?: import("@eik/sink").default;
+    organizations?: [string, string][] | undefined;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -21,19 +21,24 @@ declare const MapGet: {
     new ({ organizations, cacheControl, logger, sink, etag }?: MapGetOptions): {
         _organizations: [string, string][];
         _cacheControl: string;
-        _sink: import("@eik/sink").default;
+        _sink: import("@eik/sink").default | undefined;
         _etag: boolean;
         _log: abslog.ValidLogger;
         _metrics: Metrics;
         _histogram: Metrics.MetricsHistogram;
         _orgRegistry: Map<string, string>;
         get metrics(): Metrics;
-        handler(req: any, name: any, version: any): Promise<{
+        /**
+         * @param {any} req
+         * @param {string} name
+         * @param {string} version
+         */
+        handler(req: any, name: string, version: string): Promise<{
             _cacheControl: string;
             _statusCode: number;
             _mimeType: string;
             _location: string;
-            _stream: any;
+            _stream: import("node:stream").Readable | undefined;
             _body: any;
             _etag: string;
             get cacheControl(): string;
@@ -44,8 +49,8 @@ declare const MapGet: {
             set location(value: string);
             get mimeType(): string;
             set mimeType(value: string);
-            get stream(): any;
-            set stream(value: any);
+            get stream(): import("node:stream").Readable | undefined;
+            set stream(value: import("node:stream").Readable | undefined);
             get body(): any;
             set body(value: any);
             get etag(): string;

package/types/handlers/map.put.d.ts

@@ -1,12 +1,12 @@
 export default MapPut;
 export type MapPutOptions = {
-    mapMaxFileSize?: number;
-    cacheControl?: string;
+    mapMaxFileSize?: number | undefined;
+    cacheControl?: string | undefined;
     /**
      * List of key-value pairs [hostname, organization]
      */
-    organizations?: Array<[string, string]>;
-    sink?: import("@eik/sink").default;
+    organizations?: [string, string][] | undefined;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -21,19 +21,28 @@ declare const MapPut: {
     new ({ mapMaxFileSize, organizations, cacheControl, logger, sink, }?: MapPutOptions): {
         _mapMaxFileSize: number;
         _organizations: [string, string][];
-        _cacheControl: string;
-        _sink: import("@eik/sink").default;
+        _cacheControl: string | undefined;
+        _sink: import("@eik/sink").default | undefined;
         _log: abslog.ValidLogger;
         _metrics: Metrics;
         _histogram: Metrics.MetricsHistogram;
         _orgRegistry: Map<string, string>;
         get metrics(): Metrics;
+        /**
+         * @param {any} incoming
+         */
         _parser(incoming: any): Promise<any>;
+        /**
+         * @param {{ fieldname: any, file: any, path: any }} options
+         */
         _handleFile({ fieldname, file, path }: {
             fieldname: any;
             file: any;
             path: any;
         }): Promise<string>;
+        /**
+         * @param {any} incoming
+         */
         _readVersions(incoming: any): Promise<{
             _versions: Map<any, any>;
             _type: string;
@@ -43,9 +52,9 @@ declare const MapPut: {
             get type(): string;
             get name(): string;
             get org(): string;
-            setVersion(version: any, integrity: any): void;
-            getVersion(major: any): any;
-            check(version: any): boolean;
+            setVersion(version: string, integrity: string): void;
+            getVersion(major: number): any;
+            check(version: string): boolean;
             toJSON(): {
                 versions: [any, any][];
                 type: string;
@@ -54,13 +63,23 @@ declare const MapPut: {
             };
             get [Symbol.toStringTag](): string;
         }>;
+        /**
+         * @param {any} incoming
+         * @param {any} versions
+         */
         _writeVersions(incoming: any, versions: any): Promise<void>;
-        handler(req: any, user: any, name: any, version: any): Promise<{
+        /**
+         * @param {any} req
+         * @param {any} user
+         * @param {string} name
+         * @param {string} version
+         */
+        handler(req: any, user: any, name: string, version: string): Promise<{
             _cacheControl: string;
             _statusCode: number;
             _mimeType: string;
             _location: string;
-            _stream: any;
+            _stream: import("node:stream").Readable | undefined;
             _body: any;
             _etag: string;
             get cacheControl(): string;
@@ -71,8 +90,8 @@ declare const MapPut: {
             set location(value: string);
             get mimeType(): string;
             set mimeType(value: string);
-            get stream(): any;
-            set stream(value: any);
+            get stream(): import("node:stream").Readable | undefined;
+            set stream(value: import("node:stream").Readable | undefined);
             get body(): any;
             set body(value: any);
             get etag(): string;

package/types/handlers/pkg.get.d.ts

@@ -1,12 +1,12 @@
 export default PkgGet;
 export type PkgGetOptions = {
-    etag?: boolean;
-    cacheControl?: string;
+    etag?: boolean | undefined;
+    cacheControl?: string | undefined;
     /**
      * List of key-value pairs [hostname, organization]
      */
-    organizations?: Array<[string, string]>;
-    sink?: import("@eik/sink").default;
+    organizations?: [string, string][] | undefined;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -21,19 +21,26 @@ declare const PkgGet: {
     new ({ organizations, cacheControl, logger, sink, etag }?: PkgGetOptions): {
         _organizations: [string, string][];
         _cacheControl: string;
-        _sink: import("@eik/sink").default;
+        _sink: import("@eik/sink").default | undefined;
         _etag: boolean;
         _log: abslog.ValidLogger;
         _metrics: Metrics;
         _histogram: Metrics.MetricsHistogram;
         _orgRegistry: Map<string, string>;
         get metrics(): Metrics;
-        handler(req: any, type: any, name: any, version: any, extra: any): Promise<{
+        /**
+         * @param {any} req
+         * @param {string} type
+         * @param {string} name
+         * @param {string} version
+         * @param {string} extra
+         */
+        handler(req: any, type: string, name: string, version: string, extra: string): Promise<{
             _cacheControl: string;
             _statusCode: number;
             _mimeType: string;
             _location: string;
-            _stream: any;
+            _stream: import("node:stream").Readable | undefined;
             _body: any;
             _etag: string;
             get cacheControl(): string;
@@ -44,8 +51,8 @@ declare const PkgGet: {
             set location(value: string);
             get mimeType(): string;
             set mimeType(value: string);
-            get stream(): any;
-            set stream(value: any);
+            get stream(): import("node:stream").Readable | undefined;
+            set stream(value: import("node:stream").Readable | undefined);
             get body(): any;
             set body(value: any);
             get etag(): string;

package/types/handlers/pkg.log.d.ts

@@ -1,12 +1,12 @@
 export default PkgLog;
 export type PkgLogOptions = {
-    etag?: boolean;
-    cacheControl?: string;
+    etag?: boolean | undefined;
+    cacheControl?: string | undefined;
     /**
      * List of key-value pairs [hostname, organization]
      */
-    organizations?: Array<[string, string]>;
-    sink?: import("@eik/sink").default;
+    organizations?: [string, string][] | undefined;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -21,19 +21,25 @@ declare const PkgLog: {
     new ({ organizations, cacheControl, logger, sink, etag }?: PkgLogOptions): {
         _organizations: [string, string][];
         _cacheControl: string;
-        _sink: import("@eik/sink").default;
+        _sink: import("@eik/sink").default | undefined;
         _etag: boolean;
         _log: abslog.ValidLogger;
         _metrics: Metrics;
         _histogram: Metrics.MetricsHistogram;
         _orgRegistry: Map<string, string>;
         get metrics(): Metrics;
-        handler(req: any, type: any, name: any, version: any): Promise<{
+        /**
+         * @param {any} req
+         * @param {string} type
+         * @param {string} name
+         * @param {string} version
+         */
+        handler(req: any, type: string, name: string, version: string): Promise<{
             _cacheControl: string;
             _statusCode: number;
             _mimeType: string;
             _location: string;
-            _stream: any;
+            _stream: import("node:stream").Readable | undefined;
             _body: any;
             _etag: string;
             get cacheControl(): string;
@@ -44,8 +50,8 @@ declare const PkgLog: {
             set location(value: string);
             get mimeType(): string;
             set mimeType(value: string);
-            get stream(): any;
-            set stream(value: any);
+            get stream(): import("node:stream").Readable | undefined;
+            set stream(value: import("node:stream").Readable | undefined);
             get body(): any;
             set body(value: any);
             get etag(): string;

package/types/handlers/pkg.put.d.ts

@@ -1,12 +1,12 @@
 export default PkgPut;
 export type PkgPutOptions = {
-    pkgMaxFileSize?: number;
-    cacheControl?: string;
+    pkgMaxFileSize?: number | undefined;
+    cacheControl?: string | undefined;
     /**
      * List of key-value pairs [hostname, organization]
      */
-    organizations?: Array<[string, string]>;
-    sink?: import("@eik/sink").default;
+    organizations?: [string, string][] | undefined;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -21,17 +21,17 @@ declare const PkgPut: {
     new ({ pkgMaxFileSize, organizations, cacheControl, logger, sink, }?: PkgPutOptions): {
         _pkgMaxFileSize: number;
         _organizations: [string, string][];
-        _cacheControl: string;
-        _sink: import("@eik/sink").default;
+        _cacheControl: string | undefined;
+        _sink: import("@eik/sink").default | undefined;
         _log: abslog.ValidLogger;
         _metrics: Metrics;
         _histogram: Metrics.MetricsHistogram;
         _orgRegistry: Map<string, string>;
         _multipart: {
-            _pkgMaxFileSize: number;
+            _pkgMaxFileSize: number | undefined;
             _legalFields: string[];
             _legalFiles: string[];
-            _sink: import("@eik/sink").default;
+            _sink: import("@eik/sink").default | undefined;
             _log: abslog.ValidLogger;
             parse(incoming: any): Promise<any>;
             _handleField({ name, value }: {
@@ -61,7 +61,13 @@ declare const PkgPut: {
             get [Symbol.toStringTag](): string;
         };
         get metrics(): Metrics;
+        /**
+         * @param {any} incoming
+         */
         _parser(incoming: any): Promise<any>;
+        /**
+         * @param {any} incoming
+         */
         _readVersions(incoming: any): Promise<{
             _versions: Map<any, any>;
             _type: string;
@@ -71,9 +77,9 @@ declare const PkgPut: {
             get type(): string;
             get name(): string;
             get org(): string;
-            setVersion(version: any, integrity: any): void;
-            getVersion(major: any): any;
-            check(version: any): boolean;
+            setVersion(version: string, integrity: string): void;
+            getVersion(major: number): any;
+            check(version: string): boolean;
             toJSON(): {
                 versions: [any, any][];
                 type: string;
@@ -82,14 +88,28 @@ declare const PkgPut: {
             };
             get [Symbol.toStringTag](): string;
         }>;
+        /**
+         * @param {any} incoming
+         */
         _readVersion(incoming: any): Promise<boolean>;
+        /**
+         * @param {any} incoming
+         * @param {any} versions
+         */
         _writeVersions(incoming: any, versions: any): Promise<void>;
-        handler(req: any, user: any, type: any, name: any, version: any): Promise<{
+        /**
+         * @param {any} req
+         * @param {any} user
+         * @param {string} type
+         * @param {string} name
+         * @param {string} version
+         */
+        handler(req: any, user: any, type: string, name: string, version: string): Promise<{
             _cacheControl: string;
             _statusCode: number;
             _mimeType: string;
             _location: string;
-            _stream: any;
+            _stream: import("node:stream").Readable | undefined;
             _body: any;
             _etag: string;
             get cacheControl(): string;
@@ -100,8 +120,8 @@ declare const PkgPut: {
             set location(value: string);
             get mimeType(): string;
             set mimeType(value: string);
-            get stream(): any;
-            set stream(value: any);
+            get stream(): import("node:stream").Readable | undefined;
+            set stream(value: import("node:stream").Readable | undefined);
             get body(): any;
             set body(value: any);
             get etag(): string;

package/types/handlers/versions.get.d.ts

@@ -1,9 +1,9 @@
 export default VersionsGet;
 export type VersionsGetOptions = {
-    cacheControl?: string;
-    etag?: boolean;
-    organizations?: Array<[string, string]>;
-    sink?: import("@eik/sink").default;
+    cacheControl?: string | undefined;
+    etag?: boolean | undefined;
+    organizations?: [string, string][] | undefined;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -18,19 +18,24 @@ declare const VersionsGet: {
     new ({ organizations, cacheControl, logger, sink, etag }?: VersionsGetOptions): {
         _organizations: [string, string][];
         _cacheControl: string;
-        _sink: import("@eik/sink").default;
+        _sink: import("@eik/sink").default | undefined;
         _etag: boolean;
         _log: abslog.ValidLogger;
         _metrics: Metrics;
         _histogram: Metrics.MetricsHistogram;
         _orgRegistry: Map<string, string>;
         get metrics(): Metrics;
-        handler(req: any, type: any, name: any): Promise<{
+        /**
+         * @param {any} req
+         * @param {string} type
+         * @param {string} name
+         */
+        handler(req: any, type: string, name: string): Promise<{
             _cacheControl: string;
             _statusCode: number;
             _mimeType: string;
             _location: string;
-            _stream: any;
+            _stream: import("node:stream").Readable | undefined;
             _body: any;
             _etag: string;
             get cacheControl(): string;
@@ -41,8 +46,8 @@ declare const VersionsGet: {
             set location(value: string);
             get mimeType(): string;
             set mimeType(value: string);
-            get stream(): any;
-            set stream(value: any);
+            get stream(): import("node:stream").Readable | undefined;
+            set stream(value: import("node:stream").Readable | undefined);
             get body(): any;
             set body(value: any);
             get etag(): string;

package/types/main.d.ts

@@ -45,3 +45,5 @@ import PkgPut from "./handlers/pkg.put.js";
 import MapGet from "./handlers/map.get.js";
 import MapPut from "./handlers/map.put.js";
 import TEST from "./sinks/test.js";
+import MEM from "@eik/sink-memory";
+import FS from "@eik/sink-file-system";

package/types/multipart/form-field.d.ts

@@ -1,8 +1,8 @@
 export default FormField;
 declare const FormField: {
     new ({ value, name }?: {
-        value?: string;
-        name?: string;
+        value?: string | undefined;
+        name?: string | undefined;
     }): {
         _value: string;
         _name: string;

package/types/multipart/parser.d.ts

@@ -1,9 +1,9 @@
 export default MultipartParser;
 export type MultipartParserOptions = {
-    pkgMaxFileSize?: number;
-    legalFields?: string[];
-    legalFiles?: string[];
-    sink?: import("@eik/sink").default;
+    pkgMaxFileSize?: number | undefined;
+    legalFields?: string[] | undefined;
+    legalFiles?: string[] | undefined;
+    sink?: import("@eik/sink").default | undefined;
     logger?: import("abslog").AbstractLoggerOptions;
 };
 /**
@@ -16,12 +16,18 @@ export type MultipartParserOptions = {
  */
 declare const MultipartParser: {
     new ({ pkgMaxFileSize, legalFields, legalFiles, logger, sink }?: MultipartParserOptions): {
-        _pkgMaxFileSize: number;
+        _pkgMaxFileSize: number | undefined;
         _legalFields: string[];
         _legalFiles: string[];
-        _sink: import("@eik/sink").default;
+        _sink: import("@eik/sink").default | undefined;
         _log: abslog.ValidLogger;
+        /**
+         * @param {any} incoming
+         */
         parse(incoming: any): Promise<any>;
+        /**
+         * @param {{ name: any, value: any }} options
+         */
         _handleField({ name, value }: {
             name: any;
             value: any;
@@ -36,12 +42,18 @@ declare const MultipartParser: {
             };
             get [Symbol.toStringTag](): string;
         };
+        /**
+         * @param {{ fieldname: any, file: any, filename: any, incoming: any }} options
+         */
         _handleFile({ fieldname, file, filename, incoming }: {
             fieldname: any;
             file: any;
             filename: any;
             incoming: any;
         }): Promise<any>;
+        /**
+         * @param {{ incoming: any, entry: any }} options
+         */
         _persistFile({ incoming, entry }: {
             incoming: any;
             entry: any;