Changed
0.14.1
Docname |
Text |
|---|---|
modules/db |
DbPoolConstructor function sanitize argument sort as boolean for deterministic cache keys was created. |
modules/file-manager |
IRequest OpenOptions property headers with an Authorization request header is no longer cached without a Cache-Control response header. |
modules/types |
BREAKING function purgeMemory unimplemented argument percent was replaced with type as 0 | 1. |
0.14.0
Docname |
Text |
|---|---|
modules/cloud |
BREAKING ICloudServiceClient function deleteObjects is an alias for deleteObjectsV3. |
modules/document |
IDocument property accessor imports as StringMap was changed to ImportModule: IDocument function parameter imports as StringMap was changed to ImportModule: findSourceScope findSourceRoot locateSourceFiles resolveSourceFile |
modules/types |
BREAKING function hashKey argument algorithm default value was changed from “md5” to “sha256”. function setTempDir argument lock as boolean can be used at initialization to prevent unauthorized modification. |
0.13.7
Docname |
Text |
|---|---|
modules/core |
HostConstructor property cacheDir can be permanently locked. |
0.13.6
Docname |
Text |
|---|---|
modules/core |
ClientDbConstructor function purgeResult argument lru as boolean | number can initiate garbage collection by source provider. |
modules/core |
BREAKING IClientDb function setQueryResult did not apply property cacheDir when memory permission was disabled. |
modules/file-manager |
BREAKING IFileManager properties permission | sessionId are permanently locked in the constructor. FileManagerConstructor function generateSessionId for host sessionId tracking was created. |
modules/module |
IModule function supports argument locked as boolean can permanently prevent modification to these properties: sessionId broadcastId permission |
0.13.5
Docname |
Text |
|---|---|
modules/core |
BREAKING HostConstructor function getPermissionFromSettings returns a completely frozen Permission global instance. Any attempt to modify the object will silently be denied access. |
modules/request |
RequestModule agent properties keep_alive_interval | proxy_env for configuring the HTTP/s global Agent instance were created. RequestModule property proxy.keep_alive_interval for throttling the keep alive packets (ms) was created. |
0.13.4
Docname |
Text |
|---|---|
modules/types |
BREAKING function cloneObject uses a WeakMap<object, object> internally for reference tracking. |
0.13.2
Docname |
Text |
|---|---|
modules/file-manager |
FileManagerConstructor function writeChecksum | verifyChecksum options properties ignore | ignoreRoot as string[] can evaluate relative glob patterns. |
0.13.0
Docname |
Text |
|---|---|
document/plugins/interface |
ITransformSeries function upgrade | upgradeESM can specify a version range to locate a hoisted package: Type Version first latest exact 1.1.0 startsWith 1.1. RegExp ^ ”^1\\.[0-9]\\.” RegExp $ ”\\.[0-9]\\.\\d+$” ITransformSeries symbol name for constructorOf was changed from transformseries to document:transform:series. |
modules/cloud |
BREAKING CloudConstructor override function toPosix preserves backslashes when transacting from a Win32 platform. Additional dependent static methods affected: joinPath normalizePath globDir |
modules/compress |
CompressModule settings property cache as CacheDirAction for categorized cache expiration was implemented. |
modules/file-manager |
BREAKING IFileManager when parsing an invalid encoding (BufferEncoding) will process the file as a Buffer instead of assuming “utf-8”. FileManagerConstructor function writeChecksum | verifyChecksum options property include as string[] can be prefixed with “!” to negate a subset of glob paths. |
modules/module |
ModuleConstructor function isDir argument absolute as boolean was created. IModule function writeLog uses same method signature as function addLog. |
modules/module |
MemoryModule settings property cache_disk.include can be prefixed with “!” to negate a subset of glob paths. |
modules/request |
IRequest function aria2c | rclone argument pathname can accept a URL instance. |
modules/types |
function parseTime argument epoch as true for starting the interval from Unix or Epoch time. function parseTime argument negative as false for including plus and minus operators. function parseExpires argument epoch as true for starting the interval from Unix or Epoch time. |
0.12.7
Docname |
Text |
|---|---|
modules/module |
BREAKING ModuleConstructor function joinPath did not preserve leading and trailing spaces for Unix paths. |
0.12.5
Docname |
Text |
|---|---|
modules/types |
function importESM argument options as ImportAttributes was implemented. |
0.12.4
Docname |
Text |
|---|---|
modules/types |
function getTempDir argument create as boolean using fs.mkdtemp was implemented. |
0.12.2
Docname |
Text |
|---|---|
modules/module |
BREAKING ModuleConstructor function isURL no longer uses URL.canParse for validation. The native method accepts values without the “://” protocol. |
modules/types |
function sanitizeCmd optionally concatenates arguments without altering the supplied values. |
0.12.0
Docname |
Text |
|---|---|
cloud/aws |
BREAKING There is no special handling when uploading the file extension “.map”. CloudStorageUpload property descendantsGroup as [“.map”] can be used to restore the old behavior. |
cloud/aws-v3 |
BREAKING There is no special handling when uploading the file extension “.map”. CloudStorageUpload property descendantsGroup as [“.map”] can be used to restore the old behavior. |
cloud/azure |
BREAKING There is no special handling when uploading the file extension “.map”. CloudStorageUpload property descendantsGroup as [“.map”] can be used to restore the old behavior. |
cloud/gcp |
BREAKING There is no special handling when uploading the file extension “.map”. CloudStorageUpload property descendantsGroup as [“.map”] can be used to restore the old behavior. |
cloud/oci |
BREAKING There is no special handling when uploading the file extension “.map”. CloudStorageUpload property descendantsGroup as [“.map”] can be used to restore the old behavior. |
db/mongodb |
BREAKING MongoDB object CommandOperationOptions is no longer coerced into JS native objects. Db instance abort signal is attached to these commands: collection.find collection.aggregate db.command |
modules/compress |
ICompress function tryFile | tryImage enforce read (file) and write (output) permissions. BREAKING type PluginCompressor argument mimeType as string was replaced with metadata as PlainObject. |
modules/core |
BREAKING Permission glob matchers picomatch | minimatch do not set any initial options other than nocase for Windows. HostConstructor function kill can be called without iv when using a pre-encrypted username. IPermission function setters can be called with a boolean: setDiskRead setDiskWrite setUNCRead setUNCWrite |
modules/document |
IDocument function watchModified argument recursive as [string, string[]][] for directory watchers was created. |
modules/file-manager |
IFileManager function fetchFiles using the rclone:? protocol supports Rclone copy commands. IFileManager property getter retryLimit for failed attempts was created. |
modules/module |
IModule function isFatal validates error objects are an instance of Error. |
modules/module |
NodeModule property posix.strict was enabled by default. LoggerProcessSettings property enabled was implemented. |
modules/request |
RequestModule settings section rclone for cloud storage copying was created. |
modules/types |
function getTempDir optionally concatenates path segments (path.join) without creating any directories. |
0.11.7
Docname |
Text |
|---|---|
modules/types |
BREAKING Method decryptUTF8 did not consistently reproduce data output from encryptUTF8. |
0.11.1
Docname |
Text |
|---|---|
modules/types |
BREAKING function escapePattern argument lookBehind was replaced with symbols as boolean: \x26 & \x21 ! \x23 # \x25 % \x2c , \x3a : \x3b ; \x3c < \x3d = \x3e > \x40 @ \x60 ` \x7e ~ \x22 “ (0.13.8) function supported argument lts as boolean can be used as the patch argument. |
0.11.0
Docname |
Text |
|---|---|
cloud/atlas |
NPM package mongodb was upgraded from 6.2 to 7.1 with a NodeJS 20.19 requirement. |
cloud/aws |
ICloudServiceClient method deleteObjectsV3 overrides Bucket property in ListObjectsRequest with method parameter Bucket. |
cloud/aws-v3 |
ICloudServiceClient method deleteObjectsV3 overrides Bucket property in ListObjectsRequest with method parameter Bucket. |
cloud/azure |
EnvironmentCredential from @azure/identity is enforced when qualified for default authentication. |
db/mongodb |
NPM package mongodb was upgraded from 6.2 to 7.1 with a NodeJS 20.19 requirement. |
db/mssql |
NPM package tedious was upgraded from 18.6 to 19.2 with a NodeJS 18.17 requirement. |
modules/cloud |
ICloud function deleteObjects argument recursive is a union with options as DeleteObjectsOptions. |
modules/file-manager |
FileManagerConstructor function writeChecksum | verifyChecksum options property exclude as string[] can be prefixed with “!” to negate a subset of glob paths. IFileManager function install with name watch injected with an NPM package or Watch constructor was implemented. IFileManager property cacheToDisk | cacheToMemory were made readonly references. |
modules/module |
MemoryModule settings property cache_disk.exclude can be prefixed with “!” to negate a subset of glob paths. |
modules/request |
RequestModule property proxy.exclude can be prefixed with “!” to negate a subset of glob addresses. |
modules/types |
type HighResolutionTime in object with bigint primitive was implemented. |
modules/watch |
Permissions are required to watch externally added supplementary source files. |
0.10.0
Docname |
Text |
|---|---|
cloud/gcp |
GCPStorage property admin.configBucket.retentionPolicy as 0 calls the method removeRetentionPeriod. Firebase (admin) authentication using a JSON file or an object with a service account key is supported. Firestore aggregate and collection group partition queries are supported. Firestore method findNearest for vector queries as VectorQueryOptions was implemented. |
modules/cloud |
CloudConstructor function finalize return value was modified to Promise<void>. CloudConstructor function uploadAsset return value was modified to Promise<void>[]. |
modules/compress |
ICompress property chunkSize was converted into a 1KB aligned accessor. |
modules/core |
IHost function pauseLog | resumeLog argument type as string was implemented. |
modules/file-manager |
IFileManager function return value as Promise<unknown> was changed to Promise<void>: finalize finalizeCompress finalizeCleanup finalizeCloud finalizeDocument finalizeTask |
modules/module |
ModuleConstructor function asHash argument minLength was replaced with digest as BinaryToTextEncoding. |
modules/task |
TaskConstructor function finalize return value was changed to Promise<void>. |
modules/types |
function createAbortError uses native DOMException with name “AbortError” and code 20. function formatTime with argument char as “:” displays using digital clock format. interface CloneObjectOptions in module was relocated to types. type Writeable was renamed Writable. interface GetTempDirOptions in module was renamed TempDirOptions. |
0.9.4
Docname |
Text |
|---|---|
image/index |
NPM binaries for WebP (ESM) are supported. |
0.9.0
Docname |
Text |
|---|---|
modules/db |
IDb function executeQuery | executeBatchQuery argument callback as ErrorQueryCallback. |
modules/document |
IDocument property config was made abstract. |
modules/file-manager |
IFileManager function install with name “image” and target as ImageConstructor were implemented. IFileManager function install with name “document” | “image” | “task” and handler as string were implemented. IFileManager function transformAsset return value was modified to Promise<boolean>. |
modules/module |
IModule function src and dest arguments can accept a URL instance: canRead canWrite readFile writeFile deleteFile copyFile moveFile createDir removeDir streamFile (static) |
modules/request |
RequestInit property requestTimeout was renamed readTimeout. |
modules/types |
type StringOfArray was renamed ArrayOf<string>. type BufferContent was renamed Bufferable. interface PoolConfig in db was relocated to settings. interface LoggerFormat in logger was relocated to settings. interface AddEventListenerOptions in dom was relocated to core. |
0.8.0
Docname |
Text |
|---|---|
db/mssql |
NPM package tedious was upgraded from 16.7 to 18.3 with a NodeJS 18 requirement. |
0.7.0
Docname |
Text |
|---|---|
cloud/aws-v3 |
NPM dependency @pi-r/aws was replaced with @pi-r/aws-lib. |