adding type definitions

Author: 0marSalah

package.json

@@ -26,7 +26,8 @@
   "exports": {
     ".": {
       "require": "./dist/index.js",
-      "import": "./dist/esm/index.js"
+      "import": "./dist/esm/index.js",
+      "types": "./dist/index.d.ts"
     },
     "./package.json": "./package.json"
   },

src/index.d.ts

@@ -0,0 +1,29 @@
+import { Pack } from 'tar-stream'
+import { Buffer } from 'buffer'
+
+export interface ActorProfileOptions {
+  actorProfile?: any
+  outbox?: any
+  followers?: any
+  followingAccounts?: any
+  lists?: any
+  bookmarks?: any
+  likes?: any
+  blockedAccounts?: any
+  blockedDomains?: any
+  mutedAccounts?: any
+}
+
+/**
+ * Exports an actor profile and associated data as a tarball.
+ * @param options - The options for the actor profile.
+ * @returns A tar-stream Pack object containing the exported data.
+ */
+export function exportActorProfile(options: ActorProfileOptions): Pack
+
+/**
+ * Imports an actor profile from a tarball buffer.
+ * @param tarBuffer - The tarball buffer containing the actor profile.
+ * @returns A promise resolving to the imported actor profile data.
+ */
+export function importActorProfile(tarBuffer: Buffer): Promise<any>

src/index.ts

@@ -5,19 +5,7 @@ import * as tar from 'tar-stream'
 import { type Pack } from 'tar-stream'
 import YAML from 'yaml'
 import { Readable } from 'stream'
-
-export interface ActorProfileOptions {
-  actorProfile?: any
-  outbox?: any
-  followers?: any
-  followingAccounts?: any
-  lists?: any
-  bookmarks?: any
-  likes?: any
-  blockedAccounts?: any
-  blockedDomains?: any
-  mutedAccounts?: any
-}
+import { ActorProfileOptions } from './index.d'
 
 export function exportActorProfile({
   actorProfile,