@js-utils-kit/types 1.2.0 → 1.4.0

package/dist/index.d.cts

@@ -1,6 +1,56 @@
 import { ArchiverOptions, ArchiverOptions as ArchiverOptions$1 } from "archiver";
-import { HTTP_STATUS } from "@js-utils-kit/constants";
 
+//#region src/commit/types.d.ts
+/**
+ * Metadata describing a supported commit type.
+ *
+ * @see {@link COMMIT_TYPES}.
+ */
+interface CommitTypeMeta {
+  /**
+   * Conventional commit type identifier
+   *
+   * @example
+   * - feat
+   * - fix
+   * - chore
+   * - BREAKING CHANGE.
+   */
+  type: string;
+  /**
+   * Human-readable description of what this commit type represents.
+   */
+  description: string;
+  /**
+   * Whether this commit type is allowed to introduce a breaking change.
+   *
+   * When true, breaking changes may be expressed using:
+   * - `!` after the type (e.g. `feat!:`)
+   * - `BREAKING CHANGE:` footer
+   */
+  allowsBreakingChange: boolean;
+  /**
+   * Whether commits of this type should be considered release-relevant (e.g. included in changelogs).
+   */
+  isReleaseRelevant?: boolean;
+  /**
+   * Default semantic version impact when no breaking change is present.
+   */
+  defaultReleaseType?: 'major' | 'minor' | 'patch' | 'none';
+  /**
+   * Display-friendly label for UIs or documentation.
+   */
+  title?: string;
+  /**
+   * Emoji or icon representing this commit type.
+   */
+  icon?: string;
+  /**
+   * Marks this commit type as deprecated.
+   */
+  deprecated?: boolean;
+}
+//#endregion
 //#region src/ArchiveFormat.d.ts
 /**
  * Supported archive formats.
@@ -91,8 +141,6 @@ type Hour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
 /**
  * Union type of all supported HTTP status codes.
  *
- * This type is derived directly from {@link HTTP_STATUS} and represents every possible numeric HTTP status value.
- *
  * Useful for enforcing strict type-safety when working with HTTP responses, middleware, validators, and utility functions.
  *
  * @example
@@ -104,7 +152,7 @@ type Hour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
  * }
  * ```
  */
-type HttpStatusCode = (typeof HTTP_STATUS)[keyof typeof HTTP_STATUS];
+type HttpStatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 509 | 510 | 511;
 //#endregion
 //#region src/MinuteOrSecond.d.ts
 /**
@@ -115,6 +163,143 @@ type HttpStatusCode = (typeof HTTP_STATUS)[keyof typeof HTTP_STATUS];
  */
 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/utils/DeepPartial.d.ts
+type DeepPartial<T> = T extends ((...args: unknown[]) => unknown) ? T : T extends readonly (infer U)[] ? readonly DeepPartial<U>[] : T extends object ? { [P in keyof T]?: DeepPartial<T[P]> } : T;
+//#endregion
+//#region src/PackageJson.d.ts
+type Person = string | {
+  name: string;
+  email: string;
+  url: string;
+};
+type Repository = string | {
+  type: string;
+  url: string;
+  directory: string;
+};
+type Bugs = string | {
+  url: string;
+  email: string;
+};
+type FundingItem = string | {
+  url: string;
+  type: string;
+};
+type Funding = FundingItem | FundingItem[];
+type LicenseItem = {
+  type: string;
+  url: string;
+};
+type DevEngineItem = {
+  name: string;
+  version: string;
+  onFail: 'ignore' | 'warn' | 'error' | 'download';
+};
+type DevEngineField = DevEngineItem | DevEngineItem[];
+type DevEngines = {
+  os: DevEngineField;
+  cpu: DevEngineField;
+  libc: DevEngineField;
+  runtime: DevEngineField;
+  packageManager: DevEngineField;
+};
+type PackageJson = DeepPartial<{
+  name: string;
+  displayName: string;
+  version: string;
+  description: string;
+  keywords: string[];
+  private: boolean | 'true' | 'false';
+  homepage: string;
+  repository: Repository;
+  bugs: Bugs;
+  license: string;
+  licenses: LicenseItem[];
+  author: Person;
+  contributors: Person[];
+  maintainers: Person[];
+  funding: Funding;
+  files: string[];
+  main: string;
+  module: string;
+  types: string;
+  typings: string;
+  exports: unknown;
+  imports: Record<string, unknown>;
+  bin: string | Record<string, string>;
+  man: string | string[];
+  type: 'commonjs' | 'module';
+  directories: {
+    bin: string;
+    doc: string;
+    example: string;
+    lib: string;
+    man: string;
+    test: string;
+  };
+  scripts: Record<string, string>;
+  config: Record<string, unknown>;
+  dependencies: Record<string, string>;
+  devDependencies: Record<string, string>;
+  optionalDependencies: Record<string, string>;
+  peerDependencies: Record<string, string>;
+  peerDependenciesMeta: Record<string, {
+    optional: boolean;
+  }>;
+  bundleDependencies: boolean | string[];
+  bundledDependencies: boolean | string[];
+  engines: Record<string, string>;
+  engineStrict: boolean;
+  os: string[];
+  cpu: string[];
+  devEngines: DevEngines;
+  preferGlobal: boolean;
+  publishConfig: {
+    access: 'public' | 'restricted';
+    tag: string;
+    registry: string;
+    provenance: boolean;
+  };
+  dist: {
+    shasum: string;
+    tarball: string;
+  };
+  readme: string;
+  esnext: string | {
+    main: string;
+    browser: string;
+  };
+  workspaces: string[] | {
+    packages: string[];
+    nohoist: string[];
+  };
+  resolutions: Record<string, unknown>;
+  overrides: Record<string, unknown>;
+  packageManager: string;
+  typesVersions: Record<string, Record<string, string[]>>;
+  volta: {
+    extends: string;
+    node: string;
+    npm: string;
+    pnpm: string;
+    yarn: string;
+  };
+  pnpm: Record<string, unknown>;
+  eslintConfig: Record<string, unknown>;
+  prettier: Record<string, unknown>;
+  stylelint: Record<string, unknown>;
+  ava: Record<string, unknown>;
+  release: Record<string, unknown>;
+  jscpd: Record<string, unknown>;
+  stackblitz: {
+    installDependencies: boolean;
+    startCommand: string | boolean;
+    compileTrigger: 'auto' | 'keystroke' | 'save';
+    env: Record<string, string>;
+  };
+  [key: string]: unknown;
+}>;
+//#endregion
 //#region src/Trim.d.ts
 /**
  * Trims whitespace from a string with methods for leading and trailing and normalizing whitespace.
@@ -150,4 +335,4 @@ interface Trim {
   normalizeWhitespace(str: string): string;
 }
 //#endregion
-export { ArchiveFormat, ArchiverOptions, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, Trim };
+export { ArchiveFormat, ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, PackageJson, Trim };

package/dist/index.d.mts

@@ -1,6 +1,56 @@
 import { ArchiverOptions, ArchiverOptions as ArchiverOptions$1 } from "archiver";
-import { HTTP_STATUS } from "@js-utils-kit/constants";
 
+//#region src/commit/types.d.ts
+/**
+ * Metadata describing a supported commit type.
+ *
+ * @see {@link COMMIT_TYPES}.
+ */
+interface CommitTypeMeta {
+  /**
+   * Conventional commit type identifier
+   *
+   * @example
+   * - feat
+   * - fix
+   * - chore
+   * - BREAKING CHANGE.
+   */
+  type: string;
+  /**
+   * Human-readable description of what this commit type represents.
+   */
+  description: string;
+  /**
+   * Whether this commit type is allowed to introduce a breaking change.
+   *
+   * When true, breaking changes may be expressed using:
+   * - `!` after the type (e.g. `feat!:`)
+   * - `BREAKING CHANGE:` footer
+   */
+  allowsBreakingChange: boolean;
+  /**
+   * Whether commits of this type should be considered release-relevant (e.g. included in changelogs).
+   */
+  isReleaseRelevant?: boolean;
+  /**
+   * Default semantic version impact when no breaking change is present.
+   */
+  defaultReleaseType?: 'major' | 'minor' | 'patch' | 'none';
+  /**
+   * Display-friendly label for UIs or documentation.
+   */
+  title?: string;
+  /**
+   * Emoji or icon representing this commit type.
+   */
+  icon?: string;
+  /**
+   * Marks this commit type as deprecated.
+   */
+  deprecated?: boolean;
+}
+//#endregion
 //#region src/ArchiveFormat.d.ts
 /**
  * Supported archive formats.
@@ -91,8 +141,6 @@ type Hour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
 /**
  * Union type of all supported HTTP status codes.
  *
- * This type is derived directly from {@link HTTP_STATUS} and represents every possible numeric HTTP status value.
- *
  * Useful for enforcing strict type-safety when working with HTTP responses, middleware, validators, and utility functions.
  *
  * @example
@@ -104,7 +152,7 @@ type Hour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
  * }
  * ```
  */
-type HttpStatusCode = (typeof HTTP_STATUS)[keyof typeof HTTP_STATUS];
+type HttpStatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 509 | 510 | 511;
 //#endregion
 //#region src/MinuteOrSecond.d.ts
 /**
@@ -115,6 +163,143 @@ type HttpStatusCode = (typeof HTTP_STATUS)[keyof typeof HTTP_STATUS];
  */
 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/utils/DeepPartial.d.ts
+type DeepPartial<T> = T extends ((...args: unknown[]) => unknown) ? T : T extends readonly (infer U)[] ? readonly DeepPartial<U>[] : T extends object ? { [P in keyof T]?: DeepPartial<T[P]> } : T;
+//#endregion
+//#region src/PackageJson.d.ts
+type Person = string | {
+  name: string;
+  email: string;
+  url: string;
+};
+type Repository = string | {
+  type: string;
+  url: string;
+  directory: string;
+};
+type Bugs = string | {
+  url: string;
+  email: string;
+};
+type FundingItem = string | {
+  url: string;
+  type: string;
+};
+type Funding = FundingItem | FundingItem[];
+type LicenseItem = {
+  type: string;
+  url: string;
+};
+type DevEngineItem = {
+  name: string;
+  version: string;
+  onFail: 'ignore' | 'warn' | 'error' | 'download';
+};
+type DevEngineField = DevEngineItem | DevEngineItem[];
+type DevEngines = {
+  os: DevEngineField;
+  cpu: DevEngineField;
+  libc: DevEngineField;
+  runtime: DevEngineField;
+  packageManager: DevEngineField;
+};
+type PackageJson = DeepPartial<{
+  name: string;
+  displayName: string;
+  version: string;
+  description: string;
+  keywords: string[];
+  private: boolean | 'true' | 'false';
+  homepage: string;
+  repository: Repository;
+  bugs: Bugs;
+  license: string;
+  licenses: LicenseItem[];
+  author: Person;
+  contributors: Person[];
+  maintainers: Person[];
+  funding: Funding;
+  files: string[];
+  main: string;
+  module: string;
+  types: string;
+  typings: string;
+  exports: unknown;
+  imports: Record<string, unknown>;
+  bin: string | Record<string, string>;
+  man: string | string[];
+  type: 'commonjs' | 'module';
+  directories: {
+    bin: string;
+    doc: string;
+    example: string;
+    lib: string;
+    man: string;
+    test: string;
+  };
+  scripts: Record<string, string>;
+  config: Record<string, unknown>;
+  dependencies: Record<string, string>;
+  devDependencies: Record<string, string>;
+  optionalDependencies: Record<string, string>;
+  peerDependencies: Record<string, string>;
+  peerDependenciesMeta: Record<string, {
+    optional: boolean;
+  }>;
+  bundleDependencies: boolean | string[];
+  bundledDependencies: boolean | string[];
+  engines: Record<string, string>;
+  engineStrict: boolean;
+  os: string[];
+  cpu: string[];
+  devEngines: DevEngines;
+  preferGlobal: boolean;
+  publishConfig: {
+    access: 'public' | 'restricted';
+    tag: string;
+    registry: string;
+    provenance: boolean;
+  };
+  dist: {
+    shasum: string;
+    tarball: string;
+  };
+  readme: string;
+  esnext: string | {
+    main: string;
+    browser: string;
+  };
+  workspaces: string[] | {
+    packages: string[];
+    nohoist: string[];
+  };
+  resolutions: Record<string, unknown>;
+  overrides: Record<string, unknown>;
+  packageManager: string;
+  typesVersions: Record<string, Record<string, string[]>>;
+  volta: {
+    extends: string;
+    node: string;
+    npm: string;
+    pnpm: string;
+    yarn: string;
+  };
+  pnpm: Record<string, unknown>;
+  eslintConfig: Record<string, unknown>;
+  prettier: Record<string, unknown>;
+  stylelint: Record<string, unknown>;
+  ava: Record<string, unknown>;
+  release: Record<string, unknown>;
+  jscpd: Record<string, unknown>;
+  stackblitz: {
+    installDependencies: boolean;
+    startCommand: string | boolean;
+    compileTrigger: 'auto' | 'keystroke' | 'save';
+    env: Record<string, string>;
+  };
+  [key: string]: unknown;
+}>;
+//#endregion
 //#region src/Trim.d.ts
 /**
  * Trims whitespace from a string with methods for leading and trailing and normalizing whitespace.
@@ -150,4 +335,4 @@ interface Trim {
   normalizeWhitespace(str: string): string;
 }
 //#endregion
-export { ArchiveFormat, ArchiverOptions, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, Trim };
+export { ArchiveFormat, ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, PackageJson, Trim };