feat(interfaces): LicenseObject

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

src/interfaces/__tests__/license-object.spec-d.ts

@@ -0,0 +1,22 @@
+/**
+ * @file Unit Tests - LicenseObject
+ * @module pkg-types/interfaces/tests/LicenseObject
+ */
+
+import type TestSubject from '../license-object'
+
+describe('unit:interfaces/LicenseObject', () => {
+  const url: string = 'https://www.opensource.org/licenses/mit-license.php'
+
+  it('should allow empty object', () => {
+    assertType<TestSubject>({})
+  })
+
+  it('should allow object that only has property "url"', () => {
+    assertType<TestSubject>({ url })
+  })
+
+  it('should allow object with all properties', () => {
+    assertType<Required<TestSubject>>({ type: 'MIT', url })
+  })
+})

src/interfaces/index.ts

@@ -7,5 +7,6 @@ export type { default as BugsObject } from './bugs-object'
 export type { default as DependencyMeta } from './dependency-meta'
 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 WorkspacesConfig } from './workspaces-config'

src/interfaces/license-object.ts

@@ -0,0 +1,23 @@
+/**
+ * @file Interfaces - LicenseObject
+ * @module pkg-types/interfaces/LicenseObject
+ */
+
+/**
+ * Object representing a package license.
+ *
+ * @see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#license
+ */
+interface LicenseObject {
+  /**
+   * License type.
+   */
+  type?: string
+
+  /**
+   * License URL.
+   */
+  url?: string
+}
+
+export type { LicenseObject as default }