@e-mc/types 0.8.0 → 0.8.1

package/LICENSE

@@ -1,11 +1,11 @@
-Copyright 2023 An Pham
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
+Copyright 2023 An Pham
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/constant.d.ts

@@ -1,5 +1,5 @@
 export const enum INTERNAL {
-    VERSION = '0.8.0',
+    VERSION = '0.8.1',
     TEMP_DIR = 'tmp', // eslint-disable-line @typescript-eslint/no-shadow
     CJS = '__cjs__'
 }
@@ -255,6 +255,7 @@ export const enum SETTINGS_KEY_NAME {
     PERMISSION_HOMEREAD = "permission.home_read",
     PERMISSION_HOMEWRITE = "permission.home_write",
     MEMORY_SETTINGS_USERS = "memory.settings.users",
+    MEMORY_SETTINGS_CACHE_DISK = "memory.settings.cache_disk",
     ERROR_OUT = "error.out",
     ERROR_FATAL = "error.fatal",
     BROADCAST_OUT = "broadcast.out",

package/lib/asset.d.ts

@@ -14,6 +14,10 @@ export interface BinaryAction {
     binOpts?: string[];
 }
 
+export interface StreamAction {
+    minStreamSize?: NumString;
+}
+
 export interface FileData<T extends ExternalAsset> extends MimeTypeAction {
     file: T;
 }
@@ -50,7 +54,7 @@ export interface InitialValue extends Partial<LocationUri>, MimeTypeAction {
     cacheable?: boolean;
 }
 
-export interface ExternalAsset extends FileAsset, BundleAction, BinaryAction {
+export interface ExternalAsset extends FileAsset, BundleAction, BinaryAction, StreamAction {
     id?: number;
     url?: URL;
     socketPath?: string;

package/lib/cloud.d.ts

@@ -1,6 +1,6 @@
 import type { DbDataSource, LocationUri, StorageAction } from './squared';
 
-import type { ExternalAsset } from './asset';
+import type { ExternalAsset, StreamAction } from './asset';
 
 export interface UploadAction {
     cloudUrl?: string;
@@ -37,7 +37,7 @@ export interface CloudStorageAdmin<T = unknown, U = string, V = unknown, W = unk
     preservePath?: boolean;
 }
 
-export interface CloudStorageAction<T = unknown, U = string, V = unknown, W = unknown> extends Partial<LocationUri> {
+export interface CloudStorageAction<T = unknown, U = string, V = unknown, W = unknown> extends Partial<LocationUri>, StreamAction {
     active?: boolean;
     overwrite?: boolean;
     admin?: CloudStorageAdmin<T, U, V, W>;
@@ -49,7 +49,7 @@ export interface CloudStorageUpload<T = unknown, U = string, V = unknown, W = st
     metadata?: Record<string, string>;
     tags?: Record<string, string> | false;
     options?: T;
-    fileGroup?: [BufferContent, string, string?][];
+    fileGroup?: UploadContent[];
     localStorage?: boolean;
     endpoint?: string;
     all?: boolean;
@@ -87,5 +87,6 @@ export interface BucketAction {
     bucket: string;
 }
 
+export type UploadContent = [BufferContent, string, string?];
 export type CloudFeatures = "storage" | "database";
 export type CloudFunctions = "upload" | "download";

package/lib/core.d.ts

@@ -152,6 +152,7 @@ export interface StoreResultOptions {
 export interface CacheOptions {
     value?: DbCacheValue;
     renewCache?: boolean;
+    exclusiveOf?: [number, number?, number?];
     sessionKey?: string;
 }
 

package/lib/index.d.ts

@@ -15,7 +15,7 @@ import type { AssetContentOptions, ChecksumOptions, DeleteFileAddendum, FileOutp
 import type { HttpAgentSettings, HttpProtocolVersion, HttpRequestClient, InternetProtocolVersion } from './http';
 import type { CommandData, CropData, QualityData, ResizeData, RotateData, TransformOptions } from './image';
 import type { ExecCommand, LOG_TYPE, LogArguments, LogComponent, LogDate, LogFailOptions, LogMessageOptions, LogOptions, LogProcessOptions, LogTime, LogType, LogValue, STATUS_TYPE, StatusType } from './logger';
-import type { AsHashOptions, CheckSemVerOptions, CopyDirOptions, CopyDirResult, CopyFileOptions, CreateDirOptions, DeleteFileOptions, GetTempDirOptions, MoveFileOptions, NormalizeFlags, ParseFunctionOptions, PermissionOptions, ProtocolType, ReadFileCallback, ReadFileOptions, ReadHashOptions, RemoveDirOptions, WriteFileOptions } from './module';
+import type { AsHashOptions, CheckSemVerOptions, CopyDirOptions, CopyDirResult, CopyFileOptions, CreateDirOptions, DeleteFileOptions, GetTempDirOptions, MoveFileOptions, NormalizeFlags, ParseFunctionOptions, PermissionOptions, ProtocolType, ReadBufferOptions, ReadFileCallback, ReadFileOptions, ReadHashOptions, ReadTextOptions, RemoveDirOptions, WriteFileOptions } from './module';
 import type { RequestData, Settings } from './node';
 import type { ApplyOptions, Aria2Options, BufferFormat, DataEncodedResult, DataObjectResult, FormDataPart, HeadersOnCallback, HostConfig, OpenOptions, PostOptions, ProxySettings, ReadExpectType, RequestInit } from './request';
 import type { ClientModule, CloudModule, CloudServiceOptions, CompressModule, CompressSettings, DbCoerceSettings, DbModule, DbSourceOptions, DnsLookupSettings, DocumentComponent, DocumentComponentOption, DocumentModule, HttpConnectSettings, HttpMemorySettings, ImageModule, RequestModule, RequestSettings, TaskModule, WatchModule } from './settings';
@@ -412,7 +412,7 @@ declare namespace functions {
         addCopy(data: FileCommand<T>, saveAs?: string, replace?: boolean): Undef<string>;
         findMime(file: T, rename?: boolean): Promise<string>;
         getUTF8String(file: T, uri?: string): string;
-        getBuffer(file: T): Null<Buffer>;
+        getBuffer<U>(file: T, minStreamSize?: U): U extends number ? Promise<Buffer> : Null<Buffer>;
         getCacheDir(url: string | URL, createDir?: boolean): string;
         setAssetContent(file: T, content: string, options?: AssetContentOptions): string;
         getAssetContent(file: T, content?: string): Undef<string>;
@@ -562,7 +562,7 @@ declare namespace functions {
         canRead(uri: string, options?: PermissionOptions): boolean;
         canWrite(uri: string, options?: PermissionOptions): boolean;
         readFile(src: string): Undef<Buffer>;
-        readFile<U extends ReadFileOptions>(src: string, options?: U): Undef<U extends { encoding: string } ? string : BufferContent>;
+        readFile<U extends ReadFileOptions>(src: string, options?: U): Undef<U extends { encoding: string } ? U extends { minStreamSize: NumString } ? Promise<string> : string : U extends { minStreamSize: NumString } ? Promise<Buffer> : Buffer>;
         readFile<U extends Buffer>(src: string, promises: true): Promise<Undef<U>>;
         readFile<U extends BufferContent>(src: string, options: ReadFileOptions, promises: true): Promise<Undef<U>>;
         readFile<U extends ReadFileCallback<V>, V extends Buffer>(src: string, callback: U): Undef<U extends ReadFileCallback<infer W> ? W : V>;
@@ -716,8 +716,13 @@ declare namespace functions {
         copyDir(src: string | URL, dest: string | URL, options: CopyDirOptions): Promise<CopyDirResult>;
         copyDir(src: string | URL, dest: string | URL, move?: boolean, recursive?: boolean): Promise<CopyDirResult>;
         renameFile(src: string | URL, dest: string | URL, throws?: boolean): boolean;
+        streamFile<U extends BufferContent>(src: string, cache: boolean): Promise<U>;
+        streamFile<U extends BufferContent>(src: string, options: U): Promise<U extends { encoding: string } ? string : Buffer>;
+        streamFile<U extends BufferContent>(src: string, cache?: boolean | U, options?: U): Promise<U extends { encoding: string } ? string : Buffer>;
         readText(value: string | URL, cache: boolean): string;
-        readText(value: string | URL, encoding?: BufferEncoding | boolean, cache?: boolean): string;
+        readText<U extends ReadTextOptions>(value: string | URL, options: U): U extends { minStreamSize: NumString } ? Promise<string> : string;
+        readText(value: string | URL, encoding?: BufferEncoding | boolean | ReadTextOptions, cache?: boolean): string;
+        readBuffer<U extends ReadBufferOptions>(value: string | URL, options: U): U extends { minStreamSize: NumString } ? Promise<Null<Buffer>> : Null<Buffer>;
         readBuffer(value: string | URL, cache?: boolean): Null<Buffer>;
         resolveMime(data: string | Buffer | Uint8Array | ArrayBuffer): Promise<Undef<FileTypeResult>>;
         lookupMime(value: string, extension?: boolean): string;

package/lib/module.d.ts

@@ -1,5 +1,7 @@
 import type { ChecksumBase } from './squared';
 
+import type { StreamAction } from './asset';
+
 import type { HashOptions } from 'crypto';
 
 declare enum NORMALIZE_FLAGS {
@@ -25,7 +27,7 @@ export interface FileSystemOptions extends PermissionOptions {
     throwsDoesNotExist?: boolean;
 }
 
-export interface ReadFileOptions extends FileSystemOptions, RequireAction {
+export interface ReadFileOptions extends FileSystemOptions, StreamBase, RequireAction {
     cache?: boolean;
     encoding?: BufferEncoding;
 }
@@ -97,9 +99,17 @@ export interface CopyDirResult {
     ignored: string[];
 }
 
-export interface ReadHashOptions extends ChecksumBase {
+export interface StreamBase extends StreamAction {
+    signal?: AbortSignal;
+}
+
+export interface ReadHashOptions extends ChecksumBase, StreamBase {
     chunkSize?: number;
-    minStreamSize?: number;
+}
+
+export interface ReadBufferOptions extends StreamBase {
+    encoding?: BufferEncoding;
+    cache?: boolean;
 }
 
 export interface AsHashOptions extends HashOptions, ChecksumBase {
@@ -116,5 +126,6 @@ export interface GetTempDirOptions {
 }
 
 export type NormalizeFlags = typeof NORMALIZE_FLAGS[keyof typeof NORMALIZE_FLAGS];
+export type ReadTextOptions = ReadBufferOptions;
 export type ReadFileCallback<T> = (err: Null<NodeJS.ErrnoException>, data?: T) => void;
 export type ProtocolType = "http" | "https" | "http/s" | "ftp" | "sftp" | "s/ftp" | "torrent" | "unc";

package/lib/settings.d.ts

@@ -166,6 +166,14 @@ export interface MemoryModule<T = MemorySettings> extends HandlerSettings<T>, Re
 
 export interface MemorySettings extends PlainObject {
     users?: boolean | string[];
+    cache_disk?: MemoryCacheDiskSettings;
+}
+
+export interface MemoryCacheDiskSettings<T = NumString> extends IncludeAction<Null<string[]>> {
+    enabled?: boolean;
+    min_size?: T;
+    max_size?: T;
+    expires?: T;
 }
 
 export interface DbModule<T = DbSettings> extends ClientModule<T>, DbSourceDataType<ObjectMap<StringMap>>, PlainObject {}
@@ -233,11 +241,9 @@ export interface RequestModule<T = RequestSettings> extends HandlerSettings<T> {
         http_version?: NumString;
         accept_encoding?: boolean;
     };
-    proxy?: AuthValue & {
+    proxy?: AuthValue & IncludeAction & {
         address?: string;
         port?: NumString;
-        include?: string[];
-        exclude?: string[];
         keep_alive?: boolean;
     };
     headers?: HttpOutgoingHeaders;
@@ -364,12 +370,10 @@ export interface HttpSettings {
     certs?: ObjectMap<SecureConfig<StringOfArray>>;
 }
 
-export interface HttpDiskSettings {
+export interface HttpDiskSettings extends IncludeAction {
     enabled?: boolean;
     limit?: NumString;
     expires?: NumString;
-    include?: string[];
-    exclude?: string[];
 }
 
 export interface HttpMemorySettings extends HttpDiskSettings {
@@ -392,15 +396,13 @@ export interface DnsLookupSettings {
     resolve?: ObjectMap<Partial<LookupAddress>>;
 }
 
-export interface HashConfig {
+export interface HashConfig extends IncludeAction<ObjectMap<string[] | "*">> {
     enabled?: boolean;
     algorithm?: HashAlgorithm;
     etag?: boolean;
     expires?: NumString;
     renew?: boolean;
     limit?: NumString;
-    exclude?: ObjectMap<string[] | "*">;
-    include?: ObjectMap<string[] | "*">;
 }
 
 export interface SecureConfig<T = string, U = T> {
@@ -440,6 +442,11 @@ export interface PurgeAction {
     purge?: PurgeComponent;
 }
 
+export interface IncludeAction<T = string[]> {
+    include?: T;
+    exclude?: T;
+}
+
 export interface CipherConfig {
     algorithm?: CipherGCMTypes;
     key?: BinaryLike;

package/lib/squared.d.ts

@@ -53,7 +53,7 @@ export interface DataSource<T = unknown> extends DocumentAction {
     preRender?: string | FunctionType;
     whenEmpty?: string | FunctionType;
     removeEmpty?: boolean;
-    ignoreCache?: boolean | 0 | 1;
+    ignoreCache?: boolean | 0 | 1 | [number, number?, number?];
     transactionState?: number;
     transactionFail?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Type definitions for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",