@js-utils-kit/types 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,122 @@
+import { ArchiverOptions, ArchiverOptions as ArchiverOptions$1 } from "archiver";
+
+//#region src/ArchiveFormat.d.ts
+/**
+ * Supported archive formats.
+ */
+type ArchiveFormat = 'zip' | 'tar';
+//#endregion
+//#region src/CreateArchiveOptions.d.ts
+/**
+ * Configuration options.
+ */
+interface CreateArchiveOptions {
+  /**
+   * Archive format to use {@link ArchiveFormat}.
+   */
+  format: ArchiveFormat;
+  /**
+   * Path to the source directory that should be archived.
+   */
+  source: string;
+  /**
+   * Destination file path where the archive will be written
+   * @example
+   *  - For `zip` format: `dist.zip`
+   *  - For `tar` format: `dist.tar`
+   */
+  destination: string;
+  /**
+   * Additional options passed directly to the archiver library. See {@link ArchiverOptions}.
+   */
+  options?: ArchiverOptions$1;
+  /**
+   * Optional flag to enable internal logging. Useful for CLI mode.
+   */
+  log?: boolean;
+  /**
+   * Called after archiving is complete — receives total size in bytes.
+   */
+  onSuccess?: (bytes: number) => void;
+}
+//#endregion
+//#region src/Environment.d.ts
+/**
+ * Represents the standard runtime environments used in application development.
+ *
+ * This enum is typically used with {@link https://nodejs.org/en/learn/getting-started/nodejs-the-difference-between-development-and-production process.env.NODE_ENV } to determine
+ * whether the app is running in development, production, or test mode.
+ *
+ * @example
+ * ```ts
+ * if (process.env.NODE_ENV === Environment.DEV) {
+ *   console.log('Running in development mode');
+ * }
+ * ```
+ */
+declare const Environment: {
+  /** Production environment (`"production"`) */
+  readonly PROD: "production";
+  /** Development environment (`"development"`) */
+  readonly DEV: "development";
+  /** Testing environment (`"test"`) */
+  readonly TEST: "test";
+  /** Unknown or undefined environment */
+  readonly UNKNOWN: "unknown";
+};
+type Environment = (typeof Environment)[keyof typeof Environment];
+//#endregion
+//#region src/Hour.d.ts
+/**
+ * Represents an hour value in a 24-hour format.
+ *
+ * @remarks
+ * - Valid range is `0–23`.
+ */
+type Hour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23;
+//#endregion
+//#region src/MinuteOrSecond.d.ts
+/**
+ * Represents a minute or second value in time.
+ *
+ * @remarks
+ * - Valid range is `0–59`.
+ */
+type MinuteOrSecond = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59;
+//#endregion
+//#region src/Trim.d.ts
+/**
+ * Trims whitespace from a string with methods for leading and trailing and normalizing whitespace.
+ */
+interface Trim {
+  /**
+   * Removes whitespace from both ends of a string.
+   *
+   * @param str - The string to trim.
+   * @returns The trimmed string.
+   */
+  (str: string): string;
+  /**
+   * Removes leading whitespace from a string.
+   *
+   * @param str - The string to trim.
+   * @returns The string with leading whitespace removed.
+   */
+  start(str: string): string;
+  /**
+   * Removes trailing whitespace from a string.
+   *
+   * @param str - The string to trim.
+   * @returns The string with trailing whitespace removed.
+   */
+  end(str: string): string;
+  /**
+   * Trims the string and replaces sequences of whitespace with a single space.
+   *
+   * @param str - The string to normalize.
+   * @returns The string with normalized whitespace.
+   */
+  normalizeWhitespace(str: string): string;
+}
+//#endregion
+export { ArchiveFormat, ArchiverOptions, CreateArchiveOptions, Environment, Hour, MinuteOrSecond, Trim };

package/dist/index.d.mts

@@ -0,0 +1,122 @@
+import { ArchiverOptions, ArchiverOptions as ArchiverOptions$1 } from "archiver";
+
+//#region src/ArchiveFormat.d.ts
+/**
+ * Supported archive formats.
+ */
+type ArchiveFormat = 'zip' | 'tar';
+//#endregion
+//#region src/CreateArchiveOptions.d.ts
+/**
+ * Configuration options.
+ */
+interface CreateArchiveOptions {
+  /**
+   * Archive format to use {@link ArchiveFormat}.
+   */
+  format: ArchiveFormat;
+  /**
+   * Path to the source directory that should be archived.
+   */
+  source: string;
+  /**
+   * Destination file path where the archive will be written
+   * @example
+   *  - For `zip` format: `dist.zip`
+   *  - For `tar` format: `dist.tar`
+   */
+  destination: string;
+  /**
+   * Additional options passed directly to the archiver library. See {@link ArchiverOptions}.
+   */
+  options?: ArchiverOptions$1;
+  /**
+   * Optional flag to enable internal logging. Useful for CLI mode.
+   */
+  log?: boolean;
+  /**
+   * Called after archiving is complete — receives total size in bytes.
+   */
+  onSuccess?: (bytes: number) => void;
+}
+//#endregion
+//#region src/Environment.d.ts
+/**
+ * Represents the standard runtime environments used in application development.
+ *
+ * This enum is typically used with {@link https://nodejs.org/en/learn/getting-started/nodejs-the-difference-between-development-and-production process.env.NODE_ENV } to determine
+ * whether the app is running in development, production, or test mode.
+ *
+ * @example
+ * ```ts
+ * if (process.env.NODE_ENV === Environment.DEV) {
+ *   console.log('Running in development mode');
+ * }
+ * ```
+ */
+declare const Environment: {
+  /** Production environment (`"production"`) */
+  readonly PROD: "production";
+  /** Development environment (`"development"`) */
+  readonly DEV: "development";
+  /** Testing environment (`"test"`) */
+  readonly TEST: "test";
+  /** Unknown or undefined environment */
+  readonly UNKNOWN: "unknown";
+};
+type Environment = (typeof Environment)[keyof typeof Environment];
+//#endregion
+//#region src/Hour.d.ts
+/**
+ * Represents an hour value in a 24-hour format.
+ *
+ * @remarks
+ * - Valid range is `0–23`.
+ */
+type Hour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23;
+//#endregion
+//#region src/MinuteOrSecond.d.ts
+/**
+ * Represents a minute or second value in time.
+ *
+ * @remarks
+ * - Valid range is `0–59`.
+ */
+type MinuteOrSecond = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59;
+//#endregion
+//#region src/Trim.d.ts
+/**
+ * Trims whitespace from a string with methods for leading and trailing and normalizing whitespace.
+ */
+interface Trim {
+  /**
+   * Removes whitespace from both ends of a string.
+   *
+   * @param str - The string to trim.
+   * @returns The trimmed string.
+   */
+  (str: string): string;
+  /**
+   * Removes leading whitespace from a string.
+   *
+   * @param str - The string to trim.
+   * @returns The string with leading whitespace removed.
+   */
+  start(str: string): string;
+  /**
+   * Removes trailing whitespace from a string.
+   *
+   * @param str - The string to trim.
+   * @returns The string with trailing whitespace removed.
+   */
+  end(str: string): string;
+  /**
+   * Trims the string and replaces sequences of whitespace with a single space.
+   *
+   * @param str - The string to normalize.
+   * @returns The string with normalized whitespace.
+   */
+  normalizeWhitespace(str: string): string;
+}
+//#endregion
+export { ArchiveFormat, ArchiverOptions, CreateArchiveOptions, Environment, Hour, MinuteOrSecond, Trim };