feat(interfaces): FundingObject

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

Author: unicornware

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

@@ -0,0 +1,18 @@
+/**
+ * @file Unit Tests - FundingObject
+ * @module pkg-types/interfaces/tests/FundingObject
+ */
+
+import type TestSubject from '../funding-object'
+
+describe('unit:interfaces/FundingObject', () => {
+  const url: string = 'https://github.com/sponsors/flex-development'
+
+  it('should allow object that only has property "url"', () => {
+    assertType<TestSubject>({ url })
+  })
+
+  it('should allow object with funding account url and funding type', () => {
+    assertType<Required<TestSubject>>({ type: 'github', url })
+  })
+})

src/interfaces/funding-object.ts

@@ -0,0 +1,25 @@
+/**
+ * @file Interfaces - FundingObject
+ * @module pkg-types/interfaces/FundingObject
+ */
+
+import type { FundingType } from '#src/types'
+
+/**
+ * Object containing information about how to support a package monetarily.
+ *
+ * @see https://docs.npmjs.com/cli/configuring-npm/package-json#funding
+ */
+interface FundingObject {
+  /**
+   * Package funding type.
+   */
+  type?: FundingType
+
+  /**
+   * URL to funding account for package.
+   */
+  url: string
+}
+
+export type { FundingObject as default }

src/interfaces/index.ts

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