feat(interfaces): Person

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

Author: unicornware

src/interfaces/__tests__/person.spec-d.ts

@@ -0,0 +1,20 @@
+/**
+ * @file Unit Tests - Person
+ * @module pkg-types/interfaces/tests/Person
+ */
+
+import pkg from '../../../package.json' assert { type: 'json' }
+import type TestSubject from '../person'
+
+describe('unit:interfaces/Person', () => {
+  it('should allow object that only has property "name"', () => {
+    assertType<TestSubject>({ name: pkg.author.name })
+  })
+
+  it('should allow object with all properties', () => {
+    assertType<Required<TestSubject>>({
+      ...pkg.author,
+      email: 'unicornware@flexdevelopment.llc'
+    })
+  })
+})

src/interfaces/index.ts

@@ -9,5 +9,6 @@ export type { default as FundingObject } from './funding-object'
 export type { default as InstallConfig } from './install-config'
 export type { default as LicenseObject } from './license-object'
 export type { default as PeerDependencyMeta } from './peer-dependency-meta'
+export type { default as Person } from './person'
 export type { default as PublishConfig } from './publish-config'
 export type { default as WorkspacesConfig } from './workspaces-config'

src/interfaces/person.ts

@@ -0,0 +1,26 @@
+/**
+ * @file Interfaces - Person
+ * @module pkg-types/interfaces/Person
+ */
+
+/**
+ * Someone who has been involved in creating or maintaining a package.
+ */
+interface Person {
+  /**
+   * Person's email address.
+   */
+  email?: string
+
+  /**
+   * Person's name.
+   */
+  name: string
+
+  /**
+   * Person's URL.
+   */
+  url?: string
+}
+
+export type { Person as default }