refactor!: api

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

.dictionary.txt

@@ -19,6 +19,7 @@ mkbuild
 nvmrc
 pathe
 pkgs
+pnpx
 preid
 shfmt
 unstub

README.md

@@ -41,111 +41,77 @@ yarn add @flex-development/pkg-types
 
 ## Use
 
-```typescript
-import type { PackageJson } from '@flex-development/pkg-types'
-import fs from 'node:fs'
-import path from 'node:path'
-
-/**
- * Enables or disables [`type`][1] in `package.json`.
- *
- * [1]: https://nodejs.org/api/packages.html#type
- *
- * @example
- *  toggle()
- * @example
- *  toggle('off')
- * @example
- *  toggle('on')
- *
- * @param {'off' | 'on'} [command] - Toggle command
- * @return {void} Nothing when complete
- */
-function toggle(command?: 'off' | 'on'): void {
-  // see: https://yarnpkg.com/advanced/lifecycle-scripts#environment-variables
-  const { npm_package_json = 'package.json' } = process.env
-
-  /**
-   * Absolute path to `package.json`.
-   *
-   * @const {string} pkgfile
-   */
-  const pkgfile: string = path.resolve(npm_package_json)
-
-  /**
-   * `package.json` data.
-   *
-   * @var {PackageJson} pkg
-   */
-  let pkg: PackageJson = JSON.parse(fs.readFileSync(pkgfile, 'utf8'))
-
-  // toggle package type
-  pkg = Object.keys(pkg).reduce<PackageJson>((acc, key) => {
-    const [, type, prefix = ''] = /^((#?)type)$/.exec(key) ?? []
-
-    if (type) {
-      key = command
-        ? `${command === 'off' ? '#' : ''}type`
-        : prefix
-        ? type.replace(new RegExp('^' + prefix), '')
-        : '#' + type
-
-      acc[key] = pkg[type]!
-    } else {
-      acc[key] = pkg[key]!
-    }
-
-    return acc
-  }, {})
-
-  // rewrite package.json
-  return void fs.writeFileSync(pkgfile, JSON.stringify(pkg, null, 2) + '\n')
-}
-
-export default toggle
+```ts
+import type {
+  Condition,
+  ConditionMap,
+  ExportConditions,
+  Exports,
+  ExportsKey,
+  ExportsList,
+  ExportsObject,
+  ImportConditions,
+  Imports,
+  ImportsKey,
+  PackageJson,
+  PackageType,
+  SubpathExports
+} from '@flex-development/pkg-types'
 ```
 
-Need this functionality? See [`toggle-pkg-type`][toggle-pkg-type] \:blush:
-
 ## API
 
-### Interfaces
-
-- [`DependencyMap`](src/interfaces/dependency-map.ts)
-- [`Directories`](src/interfaces/directories.ts)
-- [`PackageJson`](src/interfaces/package-json.ts)
-- [`PublishConfig`](src/interfaces/publish-config.ts)
-- [`Scripts`](src/interfaces/scripts.ts)
-
-### Types
-
-- [`Access`](src/types/access.ts)
-- [`Bin`](src/types/bin.ts)
-- [`Browser`](src/types/browser.ts)
-- [`Bugs`](src/types/bugs.ts)
-- [`CPU`](src/types/cpu.ts)
-- [`DependencyMeta`](src/types/dependency-meta.ts)
-- [`Engine`](src/types/engine.ts)
-- [`Engines`](src/types/engines.ts)
-- [`ExportCondition`](src/types/export-condition.ts)
-- [`ExportConditions`](src/types/export-conditions.ts)
-- [`Exports`](src/types/exports.ts)
-- [`FundingInfo`](src/types/funding-info.ts)
-- [`FundingType`](src/types/funding-type.ts)
-- [`HoistingLimits`](src/types/hoisiting-limits.ts)
-- [`ImportsKey`](src/types/imports-key.ts)
-- [`Imports`](src/types/imports.ts)
-- [`InstallConfig`](src/types/install-config.ts)
-- [`LicenseObject`](src/types/license-object.ts)
-- [`OS`](src/types/os.ts)
-- [`PeerDependencyMeta`](src/types/peer-dependency-meta.ts)
-- [`Person`](src/types/person.ts)
-- [`Registry`](src/types/registry.ts)
-- [`Repository`](src/types/repository.ts)
-- [`SemanticVersion`](src/types/semantic-version.ts)
-- [`Type`](src/types/type.ts)
-- [`TypesVersions`](src/types/types-versions.ts)
-- [`WorkspacesConfig`](src/types/workspaces-config.ts)
+- [`Access`](./src/access.ts)
+- [`Bin`](./src/bin.ts)
+- [`BinObject`](./src/bin-object.ts)
+- [`Browser`](./src/browser.ts)
+- [`BrowserObject`](./src/browser-object.ts)
+- [`Bugs`](./src/bugs.ts)
+- [`Condition`](./src/condition.ts)
+- [`ConditionMap`](./src/condition-map.ts)
+- [`Config`](./src/config.ts)
+- [`CPU`](./src/cpu.ts)
+- [`CPUMap`](./src/cpu-map.ts)
+- [`Dependencies`](./src/dependencies.ts)
+- [`DevDependencies`](./src/dev-dependencies.ts)
+- [`Directories`](./src/directories.ts)
+- [`Engine`](./src/engine.ts)
+- [`EngineMap`](./src/engine-map.ts)
+- [`Engines`](./src/engines.ts)
+- [`ExportConditions`](./src/export-conditions.ts)
+- [`Exports`](./src/exports.ts)
+- [`ExportsKey`](./src/exports-key.ts)
+- [`ExportsList`](./src/exports-list.ts)
+- [`ExportsObject`](./src/exports-object.ts)
+- [`ImportConditions`](./src/import-conditions.ts)
+- [`Imports`](./src/imports.ts)
+- [`ImportsKey`](./src/imports-key.ts)
+- [`JsonArray`](./src/json-array.ts)
+- [`JsonObject`](./src/json-object.ts)
+- [`JsonPrimitive`](./src/json-primitive.ts)
+- [`JsonValue`](./src/json-value.ts)
+- [`LicenseInfo`](./src/license-info.ts)
+- [`OptionalDependencies`](./src/optional-dependencies.ts)
+- [`OS`](./src/os.ts)
+- [`OSMap`](./src/os-map.ts)
+- [`PackageJson`](./src/package-json.ts)
+- [`PackageManager`](./src/package-manager.ts)
+- [`PackageManagerMap`](./src/package-manager-map.ts)
+- [`PackageType`](./src/package-type.ts)
+- [`PeerDependencies`](./src/peer-dependencies.ts)
+- [`PeerDependenciesMeta`](./src/peer-dependencies-meta.ts)
+- [`PeerDependencyMetadata`](./src/peer-dependency-metadata.ts)
+- [`People`](./src/people.ts)
+- [`Person`](./src/person.ts)
+- [`PublishConfig`](./src/publish-config.ts)
+- [`RepositoryInfo`](./src/repository-info.ts)
+- [`RepositoryType`](./src/repository-type.ts)
+- [`RepositoryTypeMap`](./src/repository-type-map.ts)
+- [`Scripts`](./src/scripts.ts)
+- [`SemanticVersion`](./src/semantic-version.ts)
+- [`SubpathExports`](./src/subpath-exports.ts)
+- [`TypesVersions`](./src/types-versions.ts)
+- [`WorkspacesConfig`](./src/workspaces-config.ts)
 
 ## Related
 
@@ -155,7 +121,8 @@ Need this functionality? See [`toggle-pkg-type`][toggle-pkg-type] \:blush:
 
 See [`CONTRIBUTING.md`](CONTRIBUTING.md).
 
-[toggle-pkg-type]: https://github.com/flex-development/toggle-pkg-type
+This project has a [code of conduct](./CODE_OF_CONDUCT.md). By interacting with this repository, organization, or
+community you agree to abide by its terms.
 
 [tsconfig-types]: https://github.com/flex-development/tsconfig-types
 

package.json

@@ -32,6 +32,8 @@
   "type": "module",
   "files": [
     "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md",
     "dist"
   ],
   "exports": {
@@ -195,9 +197,6 @@
     "vitest": "2.0.5",
     "yaml-eslint-parser": "1.2.3"
   },
-  "peerDependencies": {
-    "@flex-development/tutils": ">=6.0.0-alpha.7"
-  },
   "packageManager": "yarn@4.4.0",
   "sideEffects": false
 }

src/types/__tests__/access.spec-d.ts src/__tests__/access.spec-d.tssrc/types/__tests__/access.spec-d.ts renamed to src/__tests__/access.spec-d.ts

@@ -1,16 +1,11 @@
 /**
  * @file Unit Tests - Access
- * @module pkg-types/types/tests/Access
+ * @module pkg-types/tests/unit-d/Access
  */
 
-import type { JsonValue } from '@flex-development/tutils'
 import type TestSubject from '../access'
 
-describe('unit:types/Access', () => {
-  it('should be json value', () => {
-    expectTypeOf<TestSubject>().toMatchTypeOf<JsonValue>()
-  })
-
+describe('unit-d:Access', () => {
   it('should extract "public"', () => {
     expectTypeOf<TestSubject>().extract<'public'>().toBeString()
   })

src/__tests__/bin-object.spec-d.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Unit Tests - BinObject
+ * @module pkg-types/tests/unit-d/BinObject
+ */
+
+import type TestSubject from '../bin-object'
+
+describe('unit-d:BinObject', () => {
+  it('should allow empty object', () => {
+    assertType<TestSubject>({})
+  })
+
+  it('should match Record<string, string>', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<Record<string, string>>()
+  })
+})

src/__tests__/bin.spec-d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Unit Tests - Bin
+ * @module pkg-types/tests/unit-d/Bin
+ */
+
+import type TestSubject from '../bin'
+import type BinObject from '../bin-object'
+
+describe('unit-d:Bin', () => {
+  it('should extract BinObject', () => {
+    expectTypeOf<TestSubject>().extract<BinObject>().not.toBeNever()
+  })
+
+  it('should extract string', () => {
+    expectTypeOf<TestSubject>().extract<string>().not.toBeNever()
+  })
+})

src/__tests__/browser-object.spec-d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file Unit Tests - BrowserObject
+ * @module pkg-types/tests/unit-d/BrowserObject
+ */
+
+import type TestSubject from '../browser-object'
+
+describe('unit-d:BrowserObject', () => {
+  it('should match Record<string, string | false>', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<Record<string, string | false>>()
+  })
+})

src/__tests__/browser.spec-d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Unit Tests - Browser
+ * @module pkg-types/tests/unit-d/Browser
+ */
+
+import type TestSubject from '../browser'
+import type BrowserObject from '../browser-object'
+
+describe('unit-d:Browser', () => {
+  it('should extract BrowserObject', () => {
+    expectTypeOf<TestSubject>().extract<BrowserObject>().not.toBeNever()
+  })
+
+  it('should extract string', () => {
+    expectTypeOf<TestSubject>().extract<string>().not.toBeNever()
+  })
+})

src/__tests__/bugs.spec-d.ts

@@ -0,0 +1,30 @@
+/**
+ * @file Unit Tests - Bugs
+ * @module pkg-types/tests/unit-d/Bugs
+ */
+
+import type { Nilable } from '@flex-development/tutils'
+import type TestSubject from '../bugs'
+import type JsonObject from '../json-object'
+
+describe('unit-d:Bugs', () => {
+  it('should allow empty object', () => {
+    assertType<TestSubject>({})
+  })
+
+  it('should extend JsonObject', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<JsonObject>()
+  })
+
+  it('should match [email?: string | null]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('email')
+      .toEqualTypeOf<Nilable<string>>()
+  })
+
+  it('should match [url?: string]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('url')
+      .toEqualTypeOf<Nilable<string>>()
+  })
+})