@design-edito/tools 0.4.23 → 0.5.1

package/components/Video/utils.js

@@ -13,21 +13,25 @@ export const muteAttributeWorkaround = (video, shouldMute) => {
 export const forceMute = (video) => {
     if (video === null)
         return;
+    // eslint-disable-next-line no-param-reassign
     video.muted = true;
 };
 export const forceLoud = (video) => {
     if (video === null)
         return;
+    // eslint-disable-next-line no-param-reassign
     video.muted = false;
 };
 export const forceVolume = (video, volume) => {
     if (video === null)
         return;
+    // eslint-disable-next-line no-param-reassign
     video.volume = volume;
 };
 export const forceCurrentTime = (video, time, setCurrentTime) => {
     if (video === null)
         return;
+    // eslint-disable-next-line no-param-reassign
     video.currentTime = time;
     setCurrentTime(time);
 };
@@ -41,11 +45,12 @@ export const forcePlay = async (video) => {
         return video.paused;
     }
     catch (e) {
+        // eslint-disable-next-line no-console
         console.error(e);
     }
     return false;
 };
-export const forcePause = async (video) => {
+export const forcePause = (video) => {
     if (video === null)
         return false;
     if (video.paused)
@@ -55,6 +60,7 @@ export const forcePause = async (video) => {
         return video.paused;
     }
     catch (e) {
+        // eslint-disable-next-line no-console
         console.error(e);
     }
     return false;
@@ -62,6 +68,7 @@ export const forcePause = async (video) => {
 export const forcePlaybackRate = (video, rate) => {
     if (video === null)
         return;
+    // eslint-disable-next-line no-param-reassign
     video.playbackRate = rate;
 };
 export const forceFullscreen = async (video) => {
@@ -72,6 +79,7 @@ export const forceFullscreen = async (video) => {
         return document.fullscreenElement === video;
     }
     catch (e) {
+        // eslint-disable-next-line no-console
         console.error(e);
     }
     return false;
@@ -85,6 +93,7 @@ export const forceExitFullscreen = async (video) => {
         return document.fullscreenElement !== video;
     }
     catch (e) {
+        // eslint-disable-next-line no-console
         console.error(e);
     }
     return false;
@@ -117,7 +126,7 @@ export function formatTime(ms, format, fps = 25) {
     const result = Object
         .keys(tokens)
         .sort((a, b) => b.length - a.length)
-        .reduce((acc, t) => acc.replace(new RegExp(t, 'g'), String(tokens[t])), format);
+        .reduce((acc, t) => acc.replace(new RegExp(t, 'gv'), String(tokens[t])), format);
     return result;
 }
 export const getTimelineClickProgress = (event, timeline, video) => {

package/components/index.d.ts

@@ -1,27 +1,27 @@
 export * as beforeAfter from './BeforeAfter/index.js'
 export * as button from './Button/index.js'
 export * as clippable from './Clippable/index.js'
-export * as disclaimer from './Disclaimer/index.js'
 export * as drawer from './Drawer/index.js'
+export * as disclaimer from './Disclaimer/index.js'
 export * as eventListener from './EventListener/index.js'
 export * as gallery from './Gallery/index.js'
 export * as iframe from './Iframe/index.js'
-export * as image from './Image/index.js'
 export * as input from './Input/index.js'
 export * as intersectionObserver from './IntersectionObserver/index.js'
-export * as jsonEditor from './JsonEditor/index.js'
 export * as overlayer from './Overlayer/index.js'
+export * as jsonEditor from './JsonEditor/index.js'
 export * as paginator from './Paginator/index.js'
 export * as resizeObserver from './ResizeObserver/index.js'
 export * as scrllgngn from './Scrllgngn/index.js'
 export * as scrollListener from './ScrollListener/index.js'
+export * as image from './Image/index.js'
 export * as select from './Select/index.js'
-export * as sequencer from './Sequencer/index.js'
 export * as shadowRoot from './ShadowRoot/index.js'
+export * as sequencer from './Sequencer/index.js'
 export * as subtitles from './Subtitles/index.js'
 export * as textarea from './Textarea/index.js'
-export * as uiModule from './UIModule/index.js'
 export * as theatre from './Theatre/index.js'
+export * as uiModule from './UIModule/index.js'
 export * as video from './Video/index.js'
 export * as wipAudioQuote from './_WIP_AudioQuote/index.js'
 export * as wipIcon from './_WIP_Icon/index.js'

package/components/index.js

@@ -1,27 +1,27 @@
 export * as beforeAfter from './BeforeAfter/index.js'
 export * as button from './Button/index.js'
 export * as clippable from './Clippable/index.js'
-export * as disclaimer from './Disclaimer/index.js'
 export * as drawer from './Drawer/index.js'
+export * as disclaimer from './Disclaimer/index.js'
 export * as eventListener from './EventListener/index.js'
 export * as gallery from './Gallery/index.js'
 export * as iframe from './Iframe/index.js'
-export * as image from './Image/index.js'
 export * as input from './Input/index.js'
 export * as intersectionObserver from './IntersectionObserver/index.js'
-export * as jsonEditor from './JsonEditor/index.js'
 export * as overlayer from './Overlayer/index.js'
+export * as jsonEditor from './JsonEditor/index.js'
 export * as paginator from './Paginator/index.js'
 export * as resizeObserver from './ResizeObserver/index.js'
 export * as scrllgngn from './Scrllgngn/index.js'
 export * as scrollListener from './ScrollListener/index.js'
+export * as image from './Image/index.js'
 export * as select from './Select/index.js'
-export * as sequencer from './Sequencer/index.js'
 export * as shadowRoot from './ShadowRoot/index.js'
+export * as sequencer from './Sequencer/index.js'
 export * as subtitles from './Subtitles/index.js'
 export * as textarea from './Textarea/index.js'
-export * as uiModule from './UIModule/index.js'
 export * as theatre from './Theatre/index.js'
+export * as uiModule from './UIModule/index.js'
 export * as video from './Video/index.js'
 export * as wipAudioQuote from './_WIP_AudioQuote/index.js'
 export * as wipIcon from './_WIP_Icon/index.js'

package/components/utils/types.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Extends a type with an optional `className` prop accepting a string or an array of string-or-nullish values.
+ *
+ * @template T - The base type to extend.
+ */
 export type WithClassName<T extends Record<string, unknown>> = T & {
     className?: string | Array<string | null | undefined>;
 };

package/node/@aws-s3/storage/directory/copy-dir/index.d.ts

@@ -12,15 +12,15 @@ export type CopyDirOptions = {
  * Recursively copies every object under `sourceDir` to the same relative path
  * beneath `targetDir` in a single S3 bucket (AWS SDK v3).
  *
- * @param {S3Client} client - The v3 S3 client instance.
- * @param {string} bucketName - The name of the S3 bucket.
- * @param {string} sourceDir - The source directory prefix to copy from.
- * @param {string} targetDir - The target directory prefix to copy to.
- * @param {CopyDirOptions} [options] - Optional copy‑behaviour configuration.
- * @param {Omit<ListObjectsV2CommandInput,'Bucket'|'Prefix'>} [options.listObjectsOptions] - Extra list parameters.
- * @param {Omit<CopyObjectCommandInput,'Bucket'|'Key'|'CopySource'>} [options.copyOptions] - Extra copy parameters.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite existing files at target.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client - The v3 S3 client instance.
+ * @param bucketName - The name of the S3 bucket.
+ * @param sourceDir - The source directory prefix to copy from.
+ * @param targetDir - The target directory prefix to copy to.
+ * @param [options] - Optional copy‑behaviour configuration.
+ * @param [options.listObjectsOptions] - Extra list parameters.
+ * @param [options.copyOptions] - Extra copy parameters.
+ * @param [options.overwrite=false] - Whether to overwrite existing files at target.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)` if every object is copied.
  * - Failure: `Outcome.makeFailure(errStr)` on error.
  */

package/node/@aws-s3/storage/directory/copy-dir/index.js

@@ -1,19 +1,20 @@
 import { ListObjectsV2Command, CopyObjectCommand, HeadObjectCommand } from '@aws-sdk/client-s3';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Recursively copies every object under `sourceDir` to the same relative path
  * beneath `targetDir` in a single S3 bucket (AWS SDK v3).
  *
- * @param {S3Client} client - The v3 S3 client instance.
- * @param {string} bucketName - The name of the S3 bucket.
- * @param {string} sourceDir - The source directory prefix to copy from.
- * @param {string} targetDir - The target directory prefix to copy to.
- * @param {CopyDirOptions} [options] - Optional copy‑behaviour configuration.
- * @param {Omit<ListObjectsV2CommandInput,'Bucket'|'Prefix'>} [options.listObjectsOptions] - Extra list parameters.
- * @param {Omit<CopyObjectCommandInput,'Bucket'|'Key'|'CopySource'>} [options.copyOptions] - Extra copy parameters.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite existing files at target.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client - The v3 S3 client instance.
+ * @param bucketName - The name of the S3 bucket.
+ * @param sourceDir - The source directory prefix to copy from.
+ * @param targetDir - The target directory prefix to copy to.
+ * @param [options] - Optional copy‑behaviour configuration.
+ * @param [options.listObjectsOptions] - Extra list parameters.
+ * @param [options.copyOptions] - Extra copy parameters.
+ * @param [options.overwrite=false] - Whether to overwrite existing files at target.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)` if every object is copied.
  * - Failure: `Outcome.makeFailure(errStr)` on error.
  */
@@ -42,10 +43,12 @@ export async function copyDir(client, bucketName, sourceDir, targetDir, options)
                         continue;
                     }
                     catch (err) {
-                        const code = err?.name ?? err?.$metadata?.httpStatusCode;
-                        if (code !== 'NotFound' && code !== 404) {
+                        const name = deepGetProperty(err, 'name');
+                        const httpStatusCode = deepGetProperty(err, '$metadata.httpStatusCode');
+                        const code = name ?? httpStatusCode;
+                        // eslint-disable-next-line max-depth
+                        if (code !== 'NotFound' && code !== 404)
                             return Outcome.makeFailure(unknownToString(err));
-                        }
                         // Not found, proceed with copy
                     }
                 }

package/node/@aws-s3/storage/directory/list/index.d.ts

@@ -6,11 +6,11 @@ export type ListOptions = Omit<ListObjectsV2CommandInput, 'Bucket' | 'Prefix' |
  * Lists all direct‑child object keys under a given directory prefix in an S3
  * bucket (AWS SDK v3). The listing is **non‑recursive**.
  *
- * @param {S3Client} client         - The v3 S3 client used to list objects.
- * @param {string}   bucketName     - The name of the S3 bucket.
- * @param {string}   directoryPath  - The directory prefix to list.
- * @param {ListOptions} [options]   - Additional parameters for `ListObjectsV2`.
- * @returns {Promise<Outcome.Either<string[], string>>}
+ * @param client         - The v3 S3 client used to list objects.
+ * @param   bucketName     - The name of the S3 bucket.
+ * @param   directoryPath  - The directory prefix to list.
+ * @param [options]   - Additional parameters for `ListObjectsV2`.
+ * @returns
  * - Success: `Outcome.makeSuccess(keys)` where `keys` is an array of object keys.
  * - Failure: `Outcome.makeFailure(errStr)` if the list operation fails.
  */

package/node/@aws-s3/storage/directory/list/index.js

@@ -5,11 +5,11 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
  * Lists all direct‑child object keys under a given directory prefix in an S3
  * bucket (AWS SDK v3). The listing is **non‑recursive**.
  *
- * @param {S3Client} client         - The v3 S3 client used to list objects.
- * @param {string}   bucketName     - The name of the S3 bucket.
- * @param {string}   directoryPath  - The directory prefix to list.
- * @param {ListOptions} [options]   - Additional parameters for `ListObjectsV2`.
- * @returns {Promise<Outcome.Either<string[], string>>}
+ * @param client         - The v3 S3 client used to list objects.
+ * @param   bucketName     - The name of the S3 bucket.
+ * @param   directoryPath  - The directory prefix to list.
+ * @param [options]   - Additional parameters for `ListObjectsV2`.
+ * @returns
  * - Success: `Outcome.makeSuccess(keys)` where `keys` is an array of object keys.
  * - Failure: `Outcome.makeFailure(errStr)` if the list operation fails.
  */

package/node/@aws-s3/storage/directory/move-dir/index.d.ts

@@ -21,12 +21,12 @@ export type MoveDirOptions = {
  * Behaviour when `overwrite` is **false** (default): abort if *any* destination
  * key already exists.
  *
- * @param {S3Client} client      - The v3 S3 client instance.
- * @param {string}   bucketName  - The name of the S3 bucket.
- * @param {string}   sourceDir   - The source directory prefix to move from.
- * @param {string}   targetDir   - The target directory prefix to move to.
- * @param {MoveDirOptions} [options] - Optional configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client      - The v3 S3 client instance.
+ * @param   bucketName  - The name of the S3 bucket.
+ * @param   sourceDir   - The source directory prefix to move from.
+ * @param   targetDir   - The target directory prefix to move to.
+ * @param [options] - Optional configuration.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)`.
  * - On failure: `Outcome.makeFailure(errStr)`.
  */

package/node/@aws-s3/storage/directory/move-dir/index.js

@@ -1,6 +1,7 @@
 import { ListObjectsV2Command, CopyObjectCommand, DeleteObjectCommand, HeadObjectCommand } from '@aws-sdk/client-s3';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Recursively moves every object under `sourceDir` to the corresponding path
  * under `targetDir` within the same S3 bucket (AWS SDK v3).
@@ -8,12 +9,12 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
  * Behaviour when `overwrite` is **false** (default): abort if *any* destination
  * key already exists.
  *
- * @param {S3Client} client      - The v3 S3 client instance.
- * @param {string}   bucketName  - The name of the S3 bucket.
- * @param {string}   sourceDir   - The source directory prefix to move from.
- * @param {string}   targetDir   - The target directory prefix to move to.
- * @param {MoveDirOptions} [options] - Optional configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client      - The v3 S3 client instance.
+ * @param   bucketName  - The name of the S3 bucket.
+ * @param   sourceDir   - The source directory prefix to move from.
+ * @param   targetDir   - The target directory prefix to move to.
+ * @param [options] - Optional configuration.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)`.
  * - On failure: `Outcome.makeFailure(errStr)`.
  */
@@ -41,7 +42,10 @@ export async function moveDir(client, bucketName, sourceDir, targetDir, options)
                         throw new Error(`Object already exists at ${dest}.`);
                     }
                     catch (err) {
-                        if (err.$metadata?.httpStatusCode !== 404 && err.name !== 'NotFound')
+                        const name = deepGetProperty(err, 'name');
+                        const httpStatusCode = deepGetProperty(err, '$metadata.httpStatusCode');
+                        // eslint-disable-next-line max-depth
+                        if (httpStatusCode !== 404 && name !== 'NotFound')
                             throw err;
                     }
                 }

package/node/@aws-s3/storage/directory/remove-dir/index.d.ts

@@ -18,11 +18,11 @@ export type RemoveDirOptions = {
  * using the AWS SDK v3 client. Handles pagination and the 1 000‑key limit of
  * `DeleteObjects`.
  *
- * @param {S3Client}  client           - The v3 S3 client instance.
- * @param {string}    bucketName       - The name of the S3 bucket.
- * @param {string}    directoryPath    - The “directory” prefix to delete.
- * @param {RemoveDirOptions} [options] - Optional listing/deletion configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param  client           - The v3 S3 client instance.
+ * @param    bucketName       - The name of the S3 bucket.
+ * @param    directoryPath    - The “directory” prefix to delete.
+ * @param [options] - Optional listing/deletion configuration.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)` – deletion succeeded, or prefix
  *   absent and `ignoreMissing` is true.
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails, or prefix

package/node/@aws-s3/storage/directory/remove-dir/index.js

@@ -6,11 +6,11 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
  * using the AWS SDK v3 client. Handles pagination and the 1 000‑key limit of
  * `DeleteObjects`.
  *
- * @param {S3Client}  client           - The v3 S3 client instance.
- * @param {string}    bucketName       - The name of the S3 bucket.
- * @param {string}    directoryPath    - The “directory” prefix to delete.
- * @param {RemoveDirOptions} [options] - Optional listing/deletion configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param  client           - The v3 S3 client instance.
+ * @param    bucketName       - The name of the S3 bucket.
+ * @param    directoryPath    - The “directory” prefix to delete.
+ * @param [options] - Optional listing/deletion configuration.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)` – deletion succeeded, or prefix
  *   absent and `ignoreMissing` is true.
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails, or prefix

package/node/@aws-s3/storage/file/copy/index.d.ts

@@ -16,14 +16,14 @@ export type CopyOptions = {
 /**
  * Copies an object from one key to another within the same S3 bucket.
  *
- * @param {S3Client} client            - The v3 S3 client instance.
- * @param {string}   bucketName        - The name of the S3 bucket.
- * @param {string}   sourcePath        - The key of the source object.
- * @param {string}   targetPath        - The key where the object will be copied.
- * @param {CopyOptions} [options]      - Optional copy configuration.
- * @param {Omit<CopyObjectCommandInput,'Bucket'|'Key'|'CopySource'>} [options.copyOptions] - Extra copy params.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing object.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client            - The v3 S3 client instance.
+ * @param   bucketName        - The name of the S3 bucket.
+ * @param   sourcePath        - The key of the source object.
+ * @param   targetPath        - The key where the object will be copied.
+ * @param [options]      - Optional copy configuration.
+ * @param [options.copyOptions] - Extra copy params.
+ * @param [options.overwrite=false] - Whether to overwrite an existing object.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/@aws-s3/storage/file/copy/index.js

@@ -1,17 +1,18 @@
 import { CopyObjectCommand, HeadObjectCommand } from '@aws-sdk/client-s3';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Copies an object from one key to another within the same S3 bucket.
  *
- * @param {S3Client} client            - The v3 S3 client instance.
- * @param {string}   bucketName        - The name of the S3 bucket.
- * @param {string}   sourcePath        - The key of the source object.
- * @param {string}   targetPath        - The key where the object will be copied.
- * @param {CopyOptions} [options]      - Optional copy configuration.
- * @param {Omit<CopyObjectCommandInput,'Bucket'|'Key'|'CopySource'>} [options.copyOptions] - Extra copy params.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing object.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client            - The v3 S3 client instance.
+ * @param   bucketName        - The name of the S3 bucket.
+ * @param   sourcePath        - The key of the source object.
+ * @param   targetPath        - The key where the object will be copied.
+ * @param [options]      - Optional copy configuration.
+ * @param [options.copyOptions] - Extra copy params.
+ * @param [options.overwrite=false] - Whether to overwrite an existing object.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -24,7 +25,9 @@ export async function copy(client, bucketName, sourcePath, targetPath, options)
                 return Outcome.makeFailure(`Object already exists at ${targetPath}.`);
             }
             catch (err) {
-                const notFound = err.$metadata?.httpStatusCode === 404 || err.name === 'NotFound';
+                const name = deepGetProperty(err, 'name');
+                const httpStatusCode = deepGetProperty(err, '$metadata.httpStatusCode');
+                const notFound = httpStatusCode === 404 || name === 'NotFound';
                 if (!notFound)
                     throw err; // propagate unexpected errors
             }

package/node/@aws-s3/storage/file/download/index.d.ts

@@ -1,4 +1,4 @@
-import { type Readable } from 'node:stream';
+import type { Readable } from 'node:stream';
 import { type S3Client, type GetObjectCommandInput } from '@aws-sdk/client-s3';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 /**
@@ -11,11 +11,11 @@ export type DownloadOptions = Omit<GetObjectCommandInput, 'Bucket' | 'Key'>;
  *
  * The function streams the object’s content back as a Node `Readable`.
  *
- * @param {S3Client} client       - The v3 S3 client instance.
- * @param {string}   bucketName   - The name of the S3 bucket.
- * @param {string}   sourcePath   - The key of the object to download.
- * @param {DownloadOptions} [options] - Extra parameters for the download.
- * @returns {Promise<Outcome.Either<Readable, string>>}
+ * @param client       - The v3 S3 client instance.
+ * @param   bucketName   - The name of the S3 bucket.
+ * @param   sourcePath   - The key of the object to download.
+ * @param [options] - Extra parameters for the download.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stream)` containing the file content.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/@aws-s3/storage/file/download/index.js

@@ -6,11 +6,11 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
  *
  * The function streams the object’s content back as a Node `Readable`.
  *
- * @param {S3Client} client       - The v3 S3 client instance.
- * @param {string}   bucketName   - The name of the S3 bucket.
- * @param {string}   sourcePath   - The key of the object to download.
- * @param {DownloadOptions} [options] - Extra parameters for the download.
- * @returns {Promise<Outcome.Either<Readable, string>>}
+ * @param client       - The v3 S3 client instance.
+ * @param   bucketName   - The name of the S3 bucket.
+ * @param   sourcePath   - The key of the object to download.
+ * @param [options] - Extra parameters for the download.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stream)` containing the file content.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -21,6 +21,7 @@ export async function download(client, bucketName, sourcePath, options) {
             Key: sourcePath,
             ...options
         }));
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- GetObjectCommand's response.Body is always a Readable stream in Node.js
         const stream = response.Body;
         return Outcome.makeSuccess(stream);
     }

package/node/@aws-s3/storage/file/exists/index.d.ts

@@ -10,12 +10,12 @@ export type ExistsOptions = {
 /**
  * Checks whether an object exists in a specified S3 bucket (AWS SDK v3).
  *
- * @param {S3Client} client          - The v3 S3 client instance.
- * @param {string}   bucketName      - The name of the S3 bucket.
- * @param {string}   sourcePath      - The key of the object to test.
- * @param {ExistsOptions} [options]  - Optional configuration.
- * @param {Omit<HeadObjectCommandInput,'Bucket'|'Key'>} [options.headObjectOptions] - Extra `HeadObject` params.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param client          - The v3 S3 client instance.
+ * @param   bucketName      - The name of the S3 bucket.
+ * @param   sourcePath      - The key of the object to test.
+ * @param [options]  - Optional configuration.
+ * @param [options.headObjectOptions] - Extra `HeadObject` params.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)` if the object exists,
  *            `Outcome.makeSuccess(false)` if it does not.
  * - Failure: `Outcome.makeFailure(errStr)` for unexpected errors.

package/node/@aws-s3/storage/file/exists/index.js

@@ -1,15 +1,16 @@
 import { HeadObjectCommand } from '@aws-sdk/client-s3';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Checks whether an object exists in a specified S3 bucket (AWS SDK v3).
  *
- * @param {S3Client} client          - The v3 S3 client instance.
- * @param {string}   bucketName      - The name of the S3 bucket.
- * @param {string}   sourcePath      - The key of the object to test.
- * @param {ExistsOptions} [options]  - Optional configuration.
- * @param {Omit<HeadObjectCommandInput,'Bucket'|'Key'>} [options.headObjectOptions] - Extra `HeadObject` params.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param client          - The v3 S3 client instance.
+ * @param   bucketName      - The name of the S3 bucket.
+ * @param   sourcePath      - The key of the object to test.
+ * @param [options]  - Optional configuration.
+ * @param [options.headObjectOptions] - Extra `HeadObject` params.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)` if the object exists,
  *            `Outcome.makeSuccess(false)` if it does not.
  * - Failure: `Outcome.makeFailure(errStr)` for unexpected errors.
@@ -25,13 +26,15 @@ export async function exists(client, bucketName, sourcePath, options) {
         return Outcome.makeSuccess(true);
     }
     catch (err) {
-        const notFound = err.$metadata?.httpStatusCode === 404
-            || err.name === 'NotFound'
-            || err.Code === 'NotFound' // some SDKs emit Code
-            || err.Code === 'NoSuchKey';
-        if (notFound) {
+        const name = deepGetProperty(err, 'name');
+        const Code = deepGetProperty(err, 'Code');
+        const httpStatusCode = deepGetProperty(err, '$metadata.httpStatusCode');
+        const notFound = httpStatusCode === 404
+            || name === 'NotFound'
+            || Code === 'NotFound' // some SDKs emit Code
+            || Code === 'NoSuchKey';
+        if (notFound)
             return Outcome.makeSuccess(false);
-        }
         return Outcome.makeFailure(unknownToString(err));
     }
 }

package/node/@aws-s3/storage/file/move/index.d.ts

@@ -18,15 +18,15 @@ export type MoveOptions = {
  * The function copies the object from `sourcePath` to `targetPath` and, upon
  * successful copy, deletes the original object.
  *
- * @param {S3Client} client - The S3 client instance.
- * @param {string}   bucketName - The name of the bucket.
- * @param {string}   sourcePath - The source object's key.
- * @param {string}   targetPath - The destination object's key.
- * @param {MoveOptions} [options] - Optional copy/delete behaviour.
- * @param {Omit<CopyObjectCommandInput,'Bucket'|'Key'|'CopySource'>} [options.copyOptions]   - Extra copy params.
- * @param {Omit<DeleteObjectCommandInput,'Bucket'|'Key'>}            [options.deleteOptions] - Extra delete params.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing `targetPath`.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client - The S3 client instance.
+ * @param   bucketName - The name of the bucket.
+ * @param   sourcePath - The source object's key.
+ * @param   targetPath - The destination object's key.
+ * @param [options] - Optional copy/delete behaviour.
+ * @param [options.copyOptions]   - Extra copy params.
+ * @param            [options.deleteOptions] - Extra delete params.
+ * @param [options.overwrite=false] - Whether to overwrite an existing `targetPath`.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)`
  * - Failure: `Outcome.makeFailure(errStr)`
  */

package/node/@aws-s3/storage/file/move/index.js

@@ -1,21 +1,22 @@
 import { HeadObjectCommand, CopyObjectCommand, DeleteObjectCommand } from '@aws-sdk/client-s3';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Moves an object from one key to another within the same S3 bucket (AWS SDK v3).
  *
  * The function copies the object from `sourcePath` to `targetPath` and, upon
  * successful copy, deletes the original object.
  *
- * @param {S3Client} client - The S3 client instance.
- * @param {string}   bucketName - The name of the bucket.
- * @param {string}   sourcePath - The source object's key.
- * @param {string}   targetPath - The destination object's key.
- * @param {MoveOptions} [options] - Optional copy/delete behaviour.
- * @param {Omit<CopyObjectCommandInput,'Bucket'|'Key'|'CopySource'>} [options.copyOptions]   - Extra copy params.
- * @param {Omit<DeleteObjectCommandInput,'Bucket'|'Key'>}            [options.deleteOptions] - Extra delete params.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing `targetPath`.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client - The S3 client instance.
+ * @param   bucketName - The name of the bucket.
+ * @param   sourcePath - The source object's key.
+ * @param   targetPath - The destination object's key.
+ * @param [options] - Optional copy/delete behaviour.
+ * @param [options.copyOptions]   - Extra copy params.
+ * @param            [options.deleteOptions] - Extra delete params.
+ * @param [options.overwrite=false] - Whether to overwrite an existing `targetPath`.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)`
  * - Failure: `Outcome.makeFailure(errStr)`
  */
@@ -29,13 +30,15 @@ export async function move(client, bucketName, sourcePath, targetPath, options)
                 return Outcome.makeFailure(`Object already exists at ${targetPath}.`);
             }
             catch (err) {
-                const notFound = err.$metadata?.httpStatusCode === 404
-                    || err.name === 'NotFound'
-                    || err.Code === 'NotFound'
-                    || err.Code === 'NoSuchKey';
-                if (!notFound) {
+                const name = deepGetProperty(err, 'name');
+                const Code = deepGetProperty(err, 'Code');
+                const httpStatusCode = deepGetProperty(err, '$metadata.httpStatusCode');
+                const notFound = httpStatusCode === 404
+                    || name === 'NotFound'
+                    || Code === 'NotFound'
+                    || Code === 'NoSuchKey';
+                if (!notFound)
                     return Outcome.makeFailure(unknownToString(err));
-                }
                 // If not found, proceed with copy
             }
         }