feat(interfaces): PeerDependencyMeta

Signed-off-by: Lexus Drumgold <[email protected]>

src/interfaces/__tests__/peer-dependency-meta.spec-d.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Unit Tests - PeerDependencyMeta
+ * @module pkg-types/interfaces/tests/PeerDependencyMeta
+ */
+
+import type TestSubject from '../peer-dependency-meta'
+
+describe('unit:interfaces/PeerDependencyMeta', () => {
+  it('should allow empty object', () => {
+    assertType<TestSubject>({})
+  })
+
+  it('should allow object with peer dependency metadat', () => {
+    assertType<TestSubject>({ optional: false })
+  })
+})

src/interfaces/index.ts

@@ -4,3 +4,4 @@
  */
 
 export type { default as DependencyMeta } from './dependency-meta'
+export type { default as PeerDependencyMeta } from './peer-dependency-meta'

src/interfaces/peer-dependency-meta.ts

@@ -0,0 +1,20 @@
+/**
+ * @file Interfaces - PeerDependencyMeta
+ * @module pkg-types/interfaces/PeerDependencyMeta
+ */
+
+/**
+ * Peer dependency metadata.
+ *
+ * @see https://yarnpkg.com/configuration/manifest#peerDependenciesMeta
+ */
+interface PeerDependencyMeta {
+  /**
+   * Have package manager mark dependency as optional.
+   *
+   * A package consumer omitting the dependency will not raise an error.
+   */
+  optional?: boolean
+}
+
+export type { PeerDependencyMeta as default }