@js-utils-kit/types 1.3.0 → 1.4.0

package/dist/index.d.cts

@@ -163,6 +163,143 @@ type HttpStatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205
  */
 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.
@@ -198,4 +335,4 @@ interface Trim {
   normalizeWhitespace(str: string): string;
 }
 //#endregion
-export { ArchiveFormat, ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, Trim };
+export { ArchiveFormat, ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, PackageJson, Trim };

package/dist/index.d.mts

@@ -163,6 +163,143 @@ type HttpStatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205
  */
 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.
@@ -198,4 +335,4 @@ interface Trim {
   normalizeWhitespace(str: string): string;
 }
 //#endregion
-export { ArchiveFormat, ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, Trim };
+export { ArchiveFormat, ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, PackageJson, Trim };