Add types (#64)

Author: Mesquita Vincent

index.d.ts

@@ -0,0 +1,46 @@
+declare interface Marketplace {
+  code: string;
+  id: string;
+  name: string;
+  region: string;
+  domain?: string;
+  mwsDomain?: string;
+  advertisingApiDomain?: string;
+  imagesDomain?: string;
+  vendorId?: string;
+}
+
+/**
+ * Get a marketplace by its id
+ * @param id  The marketplace's id
+ * @returns The marketplace
+ */
+declare function getMarketplaceById(id: string): Marketplace | undefined
+
+/**
+ * Get a marketplace by its code
+ * @param code The marketplace's code
+ * @returns The markerplace
+ */
+declare function getMarketplaceByCode(code: string): Marketplace | undefined
+
+/**
+ * Get a marketplace by its domain
+ * @param domain The marketplace's domain
+ * @returns The marketplace
+ */
+declare function getMarketplaceByDomain(domain: string): Marketplace | undefined
+
+/**
+ * Get several marketplaces by a MWS domain
+ * @param domain The MWS domain
+ * @returns The marketplaces
+ */
+declare function getMarketplacesByMwsDomain(domain: string): Marketplace[]
+
+/**
+ * Get several marketplaces by a MWS region
+ * @param mwsRegion The MWS region
+ * @returns The marketplaces
+ */
+declare function getMarketplacesByMwsRegion(mwsRegion: string): Marketplace[]

package.json

@@ -11,8 +11,10 @@
   },
   "files": [
     "index.js",
+    "index.d.ts",
     "marketplaces.json"
   ],
+  "types": "index.d.ts",
   "dependencies": {
     "memoizee": "^0.4.14"
   },