@e-mc/types 0.6.0 → 0.7.0

package/constant.d.ts

@@ -1,5 +1,5 @@
 export const enum INTERNAL {
-    VERSION = '0.6.0',
+    VERSION = '0.7.0',
     TEMP_DIR = 'tmp', // eslint-disable-line @typescript-eslint/no-shadow
     CJS = '__cjs__'
 }
@@ -19,6 +19,8 @@ export const enum VAL_CLOUD {
     DOWNLOAD_FILE = 'Download success',
     DELETE_FILE = 'Delete success',
     RENAME_FILE = 'File renamed',
+    CREATE_TAG = 'Tags created',
+    DELETE_TAG = 'Tags deleted',
     PUBLIC_READ = 'Grant public-read',
     CREATE_BUCKET = 'Bucket created',
     DELETE_BUCKET = 'Bucket deleted',
@@ -35,8 +37,10 @@ export const enum ERR_MESSAGE {
     ABORTED = 'Aborted',
     ABORTED_OPERATION = 'The operation was aborted',
     FAILED = 'Failed',
+    FAILED_CHECKSUM = 'Checksum did not match',
     PARAMETERS = 'Invalid parameters',
     FORMAT = 'Invalid format',
+    CHECKSUM = 'Invalid checksum',
     ERROR_CODE = 'Error code',
     EXEC_PERMISSION = 'Exec command not permitted',
     NOT_CACHEABLE = 'Not able to cache',
@@ -225,6 +229,12 @@ export const enum LOG_TYPE {
     DB = 65536
 }
 
+export const enum READDIR_SORT {
+    FILE = 0,
+    DIRECTORY = 1,
+    DESCENDING = 2
+}
+
 export const enum SETTINGS_KEY_NAME {
     NODE_PROCESS_CPUUSAGE = "node.process.cpu_usage",
     NODE_PROCESS_MEMORYUSAGE = "node.process.memory_usage",

package/index.d.ts

@@ -216,6 +216,18 @@ declare namespace types {
         ERROR: "error";
     };
 
+    interface READDIR_SORT {
+        FILE: number;
+        DIRECTORY: number;
+        DESCENDING: number;
+    }
+
+    const READDIR_SORT: {
+        FILE: 0;
+        DIRECTORY: 1;
+        DESCENDING: 2;
+    };
+
     interface THRESHOLD {
         FILEMANAGER_INTERVAL: number;
         WATCH_INTERVAL: number;

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorMessage = exports.errorValue = exports.validateUUID = exports.randomString = exports.decryptUTF8 = exports.encryptUTF8 = exports.getEncoding = exports.asFunction = exports.coerceObject = exports.cloneObject = exports.cascadeObject = exports.formatSize = exports.renameExt = exports.escapePattern = exports.hasGlob = exports.convertTime = exports.formatTime = exports.parseExpires = exports.parseTime = exports.isEmpty = exports.isString = exports.isObject = exports.isPlainObject = exports.isArray = exports.setTempDir = exports.getTempDir = exports.setLogCurrent = exports.getLogCurrent = exports.existsFlag = exports.mainFlag = exports.processFlag = exports.modifiedFlag = exports.watchFlag = exports.usingFlag = exports.cloneFlag = exports.ignoreFlag = exports.hasBit = exports.createAbortError = exports.THRESHOLD = exports.IMPORT_MAP = exports.WATCH_EVENT = exports.DB_TRANSACTION = exports.DB_TYPE = exports.FETCH_TYPE = exports.DOWNLOAD_TYPE = exports.ERR_CODE = exports.ASSET_FLAG = exports.FILE_TYPE = exports.STATUS_TYPE = exports.LOG_TYPE = void 0;
-exports.generateUUID = exports.purgeMemory = void 0;
+exports.errorValue = exports.validateUUID = exports.randomString = exports.decryptUTF8 = exports.encryptUTF8 = exports.getEncoding = exports.asFunction = exports.coerceObject = exports.cloneObject = exports.cascadeObject = exports.formatSize = exports.renameExt = exports.escapePattern = exports.hasGlob = exports.convertTime = exports.formatTime = exports.parseExpires = exports.parseTime = exports.isEmpty = exports.isString = exports.isObject = exports.isPlainObject = exports.isArray = exports.setTempDir = exports.getTempDir = exports.setLogCurrent = exports.getLogCurrent = exports.existsFlag = exports.mainFlag = exports.processFlag = exports.modifiedFlag = exports.watchFlag = exports.usingFlag = exports.cloneFlag = exports.ignoreFlag = exports.hasBit = exports.createAbortError = exports.IMPORT_MAP = exports.THRESHOLD = exports.READDIR_SORT = exports.WATCH_EVENT = exports.DB_TRANSACTION = exports.DB_TYPE = exports.FETCH_TYPE = exports.DOWNLOAD_TYPE = exports.ERR_CODE = exports.ASSET_FLAG = exports.FILE_TYPE = exports.STATUS_TYPE = exports.LOG_TYPE = void 0;
+exports.generateUUID = exports.purgeMemory = exports.errorMessage = void 0;
 const path = require("path");
 const fs = require("fs");
 const crypto = require("crypto");
@@ -241,6 +241,18 @@ var WATCH_EVENT;
     WATCH_EVENT["CLOSE"] = "close";
     WATCH_EVENT["ERROR"] = "error";
 })(WATCH_EVENT || (exports.WATCH_EVENT = WATCH_EVENT = {}));
+var READDIR_SORT;
+(function (READDIR_SORT) {
+    READDIR_SORT[READDIR_SORT["FILE"] = 0] = "FILE";
+    READDIR_SORT[READDIR_SORT["DIRECTORY"] = 1] = "DIRECTORY";
+    READDIR_SORT[READDIR_SORT["DESCENDING"] = 2] = "DESCENDING";
+})(READDIR_SORT || (exports.READDIR_SORT = READDIR_SORT = {}));
+var THRESHOLD;
+(function (THRESHOLD) {
+    THRESHOLD[THRESHOLD["FILEMANAGER_INTERVAL"] = 100] = "FILEMANAGER_INTERVAL";
+    THRESHOLD[THRESHOLD["WATCH_INTERVAL"] = 500] = "WATCH_INTERVAL";
+    THRESHOLD[THRESHOLD["WATCH_CHANGE"] = 100] = "WATCH_CHANGE";
+})(THRESHOLD || (exports.THRESHOLD = THRESHOLD = {}));
 var IMPORT_MAP;
 (function (IMPORT_MAP) {
     IMPORT_MAP["@squared-functions/cloud"] = "@e-mc/cloud";
@@ -321,12 +333,6 @@ var IMPORT_MAP;
     IMPORT_MAP["@squared-functions/document/packages/terser"] = "@pi-r/terser";
     IMPORT_MAP["@squared-functions/document/packages/uglify-js"] = "@pi-r/uglify-js";
 })(IMPORT_MAP || (exports.IMPORT_MAP = IMPORT_MAP = {}));
-var THRESHOLD;
-(function (THRESHOLD) {
-    THRESHOLD[THRESHOLD["FILEMANAGER_INTERVAL"] = 100] = "FILEMANAGER_INTERVAL";
-    THRESHOLD[THRESHOLD["WATCH_INTERVAL"] = 500] = "WATCH_INTERVAL";
-    THRESHOLD[THRESHOLD["WATCH_CHANGE"] = 100] = "WATCH_CHANGE";
-})(THRESHOLD || (exports.THRESHOLD = THRESHOLD = {}));
 function createAbortError() {
     return new AbortError();
 }

package/lib/cloud.d.ts

@@ -25,27 +25,29 @@ export interface CloudStorage extends CloudService {
     download?: CloudStorageDownload;
 }
 
-export interface CloudStorageAdmin<T = unknown, U = string, V = unknown> extends CloudStorageACL<U> {
+export interface CloudStorageAdmin<T = unknown, U = string, V = unknown, W = unknown> extends CloudStorageACL<U> {
     emptyBucket?: boolean;
     configBucket?: {
         create?: T;
         policy?: V;
         website?: BucketWebsiteOptions;
+        retentionPolicy?: W;
     };
     recursive?: boolean;
     preservePath?: boolean;
 }
 
-export interface CloudStorageAction<T = unknown, U = string, V = unknown> extends Partial<LocationUri> {
+export interface CloudStorageAction<T = unknown, U = string, V = unknown, W = unknown> extends Partial<LocationUri> {
     active?: boolean;
     overwrite?: boolean;
-    admin?: CloudStorageAdmin<T, U, V>;
+    admin?: CloudStorageAdmin<T, U, V, W>;
 }
 
-export interface CloudStorageUpload<T = unknown, U = string, V = unknown, W = string> extends CloudStorageACL<U>, CloudStorageAction<V, W> {
+export interface CloudStorageUpload<T = unknown, U = string, V = unknown, W = string, X = unknown> extends CloudStorageACL<U>, CloudStorageAction<V, W, unknown, X> {
     buffer?: Null<Buffer>;
     contentType?: string;
     metadata?: Record<string, string>;
+    tags?: Record<string, string> | false;
     options?: T;
     fileGroup?: [BufferContent, string, string?][];
     localStorage?: boolean;
@@ -71,19 +73,19 @@ export interface BucketWebsiteOptions {
     errorPath?: string;
 }
 
-export interface FunctionData {
-    bucket: string;
-}
-
-export interface UploadData<T = unknown, U = string, V = unknown, W = string> extends FunctionData {
-    upload: CloudStorageUpload<T, U, V, W>;
+export interface UploadData<T = unknown, U = string, V = unknown, W = string, X = unknown> extends BucketAction {
+    upload: CloudStorageUpload<T, U, V, W, X>;
     localUri: string;
     buffer: Buffer;
 }
 
-export interface DownloadData<T = unknown> extends FunctionData {
+export interface DownloadData<T = unknown> extends BucketAction {
     download: CloudStorageDownload<T>;
 }
 
+export interface BucketAction {
+    bucket: string;
+}
+
 export type CloudFeatures = "storage" | "database";
 export type CloudFunctions = "upload" | "download";

package/lib/db.d.ts

@@ -91,6 +91,8 @@ export interface PoolConfig<T = number> extends MinMax {
     queue_max?: number;
     queue_idle?: T;
     purge?: T;
+    timeout?: number;
+    socket_timeout?: number;
 }
 
 export interface TimeoutAction {

package/lib/filemanager.d.ts

@@ -1,8 +1,9 @@
-import type { BundleAction, FileInfo, LogStatus } from './squared';
+import type { BundleAction, ChecksumOutput, FileInfo, LogStatus } from './squared';
 
 import type { IFileManager, IModule, ModuleConstructor } from './index';
 import type { ExternalAsset } from './asset';
 import type { HostInitLog as IHostInitLog } from './core';
+import type { ReadHashOptions } from './module';
 import type { RequestData as IRequestData } from './node';
 import type { RequestInit } from './request';
 
@@ -99,5 +100,14 @@ export interface FindAssetOptions<T extends ExternalAsset = ExternalAsset> {
     replaced?: boolean;
 }
 
+export interface ChecksumOptions extends ReadHashOptions, Pick<ChecksumOutput, "include" | "exclude" | "recursive"> {
+    sortBy?: number;
+    verbose?: boolean;
+    ignore?: string[];
+    joinRoot?: boolean;
+    outPath?: string;
+    throwsEmpty?: boolean;
+}
+
 export type FetchType = FETCH_TYPE[keyof FETCH_TYPE];
 export type PostFinalizeCallback = (files: FileInfo[] | string[], errors: string[], status?: LogStatus[]) => void;

package/lib/index.d.ts

@@ -11,11 +11,11 @@ import type { BufferResult, CompressFormat, TryFileCompressor, TryFileResult, Tr
 import type { ClientDbConstructor, HostInitConfig, IAbortComponent, IClient, IClientDb, IPermission, JoinQueueOptions, PermissionReadWrite, ResumeThreadOptions, ThreadCountStat } from './core';
 import type { BatchQueryResult, DB_TYPE, ExecuteBatchQueryOptions, ExecuteQueryOptions, HandleFailOptions, PoolConfig, ProcessRowsOptions, QueryResult, SQL_COMMAND } from './db';
 import type { AsSourceFileOptions, ConfigOrTransformer, CustomizeOptions as CustomizeDocument, GenerateLintTableOptions, LintMessage, PluginConfig, SourceCode, SourceInput, SourceMap, SourceMapOptions, TransformAction, TransformCallback, TransformOutput, TransformResult, UpdateGradleOptions } from './document';
-import type { AssetContentOptions, DeleteFileAddendum, FileOutput, FinalizeResult, FindAssetOptions, IHttpDiskCache, IHttpMemoryCache, InstallData, PostFinalizeCallback, ReplaceOptions } from './filemanager';
+import type { AssetContentOptions, ChecksumOptions, DeleteFileAddendum, FileOutput, FinalizeResult, FindAssetOptions, IHttpDiskCache, IHttpMemoryCache, InstallData, PostFinalizeCallback, ReplaceOptions } from './filemanager';
 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, RemoveDirOptions, WriteFileOptions } from './module';
+import type { AsHashOptions, CheckSemVerOptions, CopyDirOptions, CopyDirResult, CopyFileOptions, CreateDirOptions, DeleteFileOptions, GetTempDirOptions, MoveFileOptions, NormalizeFlags, ParseFunctionOptions, PermissionOptions, ProtocolType, ReadFileCallback, ReadFileOptions, ReadHashOptions, RemoveDirOptions, WriteFileOptions } from './module';
 import type { RequestData, Settings } from './node';
 import type { ApplyOptions, Aria2Options, BufferFormat, DataEncodedResult, DataObjectResult, FormDataPart, 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';
@@ -486,6 +486,12 @@ declare namespace functions {
         loadSettings(settings: Settings, password?: string): boolean;
         loadSettings(settings: Settings, permission?: PermissionReadWrite, password?: string): boolean;
         sanitizeAssets(assets: T[], exclusions?: string[]): T[];
+        writeChecksum(root: string, options?: ChecksumOptions): Promise<string[]>;
+        writeChecksum(root: string, to: Undef<string>, options?: ChecksumOptions): Promise<Null<string[]>>;
+        writeChecksum(root: string, to?: string | ChecksumOptions, options?: ChecksumOptions): Promise<Null<string[]>>;
+        verifyChecksum(root: string, options?: ChecksumOptions): Promise<Null<[string[], string[]]>>;
+        verifyChecksum(root: string, from: Undef<string>, options?: ChecksumOptions): Promise<Null<[string[], string[]]>>;
+        verifyChecksum(root: string, from?: string | ChecksumOptions, options?: ChecksumOptions): Promise<Null<[string[], string[]]>>;
         createFileThread(host: IFileManager<T>, file: T): IFileThread<T>;
         setTimeout(options: ObjectMap<NumString>): void;
         defineHttpCache(options: HttpMemorySettings, disk?: boolean): void;
@@ -684,6 +690,7 @@ declare namespace functions {
         asHash(data: BinaryLike, options: AsHashOptions): string;
         asHash(data: BinaryLike, minLength: number): string;
         asHash(data: BinaryLike, algorithm?: NumString | AsHashOptions, minLength?: number | AsHashOptions): string;
+        readHash(value: string | URL, options?: ReadHashOptions): Promise<string>;
         toPosix(value: unknown, normalize: boolean): string;
         toPosix(value: unknown, filename?: string, normalize?: boolean): string;
         hasLogType(value: LogType): boolean;

package/lib/module.d.ts

@@ -1,4 +1,6 @@
-import type { BinaryToTextEncoding, HashOptions } from 'crypto';
+import type { ChecksumBase } from './squared';
+
+import type { HashOptions } from 'crypto';
 
 declare enum NORMALIZE_FLAGS {
     NONE = 0,
@@ -95,9 +97,12 @@ export interface CopyDirResult {
     ignored: string[];
 }
 
-export interface AsHashOptions extends HashOptions {
-    algorithm?: string;
-    digest?: BinaryToTextEncoding;
+export interface ReadHashOptions extends ChecksumBase {
+    chunkSize?: number;
+    minStreamSize?: number;
+}
+
+export interface AsHashOptions extends HashOptions, ChecksumBase {
     minLength?: number;
 }
 

package/lib/settings.d.ts

@@ -33,7 +33,7 @@ export interface ClientSettings extends PlainObject {
     cache_dir?: string;
 }
 
-export interface NodeModule {
+export interface NodeModule<T = PlainObject> extends HandlerSettings<T> {
     process?: {
         cpu_usage?: boolean;
         memory_usage?: boolean;
@@ -125,6 +125,10 @@ export interface DocumentGroup<T = { imports?: StringMap } & AnyObject, U = T> {
     imports?: StringMap;
 }
 
+export interface DocumentUsersGroup<T = AnyObject, U = T> extends DocumentGroup<T, U> {
+    extensions?: Null<string[]>;
+}
+
 export interface DocumentComponent<T = boolean, U = T, V = U> extends Omit<DocumentGroup<T, U>, "pages"> {
     cloud?: V;
 }
@@ -137,7 +141,7 @@ export interface DocumentComponentOption<T = unknown> {
 }
 
 export interface DocumentSettings extends DocumentGroup, PurgeAction, PlainObject {
-    users?: ObjectMap<DocumentGroup>;
+    users?: ObjectMap<DocumentUsersGroup>;
     directory?: DocumentDirectory;
     options?: DocumentComponentOptions;
 }

package/lib/squared.d.ts

@@ -1,6 +1,8 @@
 /// <reference path="type.d.ts" />
 /// <reference path="object.d.ts" />
 
+import type { BinaryToTextEncoding } from "crypto";
+
 interface Asset extends MimeTypeAction {
     uri?: string;
 }
@@ -33,7 +35,7 @@ interface BoxRectDimension extends BoxRect, Dimension {
     overflow?: boolean;
 }
 
-export interface FileAsset extends TextAsset, OutputAction, DocumentAction, MultipartAction, ResourceAction, IncrementalAction {
+export interface FileAsset extends TextAsset, OutputAction, DocumentAction, MultipartAction, ResourceAction, IncrementalAction, ChecksumAction {
     format?: StringOfArray;
     dataView?: NodeJS.ArrayBufferView;
     base64?: string;
@@ -96,6 +98,11 @@ export interface BundleAction<T = unknown> {
     exported?: boolean;
 }
 
+export interface ChecksumAction {
+    checksum?: ChecksumValue;
+    checksumOutput?: ChecksumValue;
+}
+
 export interface DocumentAction {
     document?: StringOfArray;
     encoding?: BufferEncoding;
@@ -220,11 +227,8 @@ export interface CompressFormat extends CompressLevel {
     options?: PlainObject & { apiKey?: string };
 }
 
-export interface WatchInterval<T = FileAsset> {
+export interface WatchInterval<T = FileAsset> extends TaskBase {
     id?: string;
-    interval?: NumString;
-    start?: NumString;
-    expires?: NumString;
     main?: boolean;
     reload?: WatchReload;
     assets?: T[];
@@ -282,6 +286,7 @@ export interface RequestData extends RequestBase, ImportAction<StringMap>, Incre
     task?: string[];
     modules?: string[];
     update?: WatchInterval;
+    checksum?: string | boolean | 1 | ChecksumOutput;
     cache?: boolean | AnyObject;
 }
 
@@ -343,8 +348,27 @@ export interface ControllerSettingsDirectoryUI {
     audio: string;
 }
 
+export interface ChecksumBase<T = BinaryToTextEncoding> {
+    algorithm?: string;
+    digest?: T;
+}
+
+export interface ChecksumOutput<T = BinaryToTextEncoding> extends ChecksumBase<T> {
+    filename?: string;
+    include?: StringOfArray;
+    exclude?: StringOfArray;
+    recursive?: boolean | 1;
+}
+
+export interface TaskBase {
+    interval?: NumString;
+    start?: NumString;
+    expires?: NumString;
+}
+
 export type WebSocketEvent = "close" | "error";
 export type IncrementalMatch = "none" | "staging" | "etag" | "exists";
 export type TextEncoding = "utf-8" | "utf-16" | "utf-16be" | "utf-16le" | "latin1";
 export type AttributeMap = ObjectMap<unknown>;
-export type WatchValue = boolean | WatchInterval;
+export type WatchValue = boolean | WatchInterval;
+export type ChecksumValue = string | ChecksumBase & { value?: string };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Type definitions for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,9 +21,9 @@
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
     "bytes": "^3.1.2",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "typescript": "5.1.6"
+    "typescript": "5.3.3"
   }
 }