feat(typings): export runMigration function and options in typings

fix(index.ts): add index.ts and make package.json refer to it in main field
contentful · May 19, 2020 · e6902bf · e6902bf
2 parents 210ccd5 + 589b27f
commit e6902bf
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -142,7 +142,7 @@ npm install contentful-migration
 ### Usage as a library
 
 ```javascript
-const runMigration = require('contentful-migration/built/bin/cli').runMigration
+const { runMigration } = require('contentful-migration')
 const options = {
   filePath: '<migration-file-path>',
   spaceId: '<space-id>',

diff --git a/index.d.ts b/index.d.ts
@@ -1,5 +1,16 @@
 import * as axios from 'axios'
 
+export interface RunMigrationConfig {
+  filePath: string
+  accessToken?: string
+  spaceId?: string
+  environmentId?: string
+  proxy?: string
+  rawProxy?: boolean
+}
+
+export function runMigration (config: RunMigrationConfig): Promise<any>
+
 export interface Movement {
   toTheTop(): void
   toTheBottom(): void

diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "description": "Migration tooling for contentful",
   "author": "Contentful GmbH",
   "license": "MIT",
-  "main": "index",
+  "main": "built/index",
   "keywords": [
     "contentful",
     "content model",

diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,3 @@
+import { runMigration } from './bin/cli'
+
+module.exports = { runMigration }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { runMigration } from './bin/cli'

		module.exports = { runMigration }