overwork types directory

Author: Nico105

package.json

@@ -3,7 +3,11 @@
   "version": "0.0.1",
   "description": "A library to search for offers on marktguru.at",
   "main": "dist/index.js",
-  "types": "src/index.d.ts",
+  "types": "typings/index.d.ts",
+  "files": [
+    "dist/",
+    "typings/"
+  ],
   "scripts": {
     "build": "tsc --project tsconfig.json",
     "test": "jest",

src/@types/marktguru.d.ts

@@ -1,5 +1,5 @@
 import axios from 'axios';
-import { marktguru } from './@types/marktguru';
+import * as marktguru from '../typings/index';
 
 const defaultOptions: marktguru.SearchOptions = {
     limit: 1000,

src/index.d.ts

@@ -99,7 +99,6 @@
     // "skipLibCheck": true                              /* Skip type checking all .d.ts files. */
   },
   "include": [
-    ",./node_modules",
     "./src",
   ]
 }

src/index.ts

@@ -0,0 +1,119 @@
+export type Retailer =
+    | 'billa'
+    | 'billa-plus'
+    | 'penny'
+    | 'hofer'
+    | 'lidl'
+    | 'spar'
+    | 'eurospar'
+    | 'interspar'
+    | 'adeg-nahversorger'
+    | 'mpreis'
+    | 'unimarkt'
+    | string;
+
+export type Config = {
+    config: {
+        apiKey: string;
+        clientKey: string;
+    };
+};
+
+export type Brand = {
+    uniqueName: string;
+    indexOffer: boolean;
+    indexLeaflet: boolean;
+    id: number;
+    name: string;
+    industryId: number;
+};
+
+export type Advertiser = {
+    uniqueName: Retailer;
+    indexOffer: boolean;
+    indexLeaflet: boolean;
+    id: string;
+    name: string;
+    industryId: number;
+};
+
+export type Category = {
+    uniqueName: string | null;
+    indexOffer: boolean;
+    indexLeaflet: boolean;
+    id: number;
+    name: string;
+    description: string;
+    parentId: number;
+};
+
+export type ValidityDates = {
+    from: string;
+    to: string;
+};
+
+export type Industry = {
+    id: number;
+    name: string;
+};
+
+export type Product = {
+    id: number;
+    name: string;
+    description: string | null;
+};
+
+export type Unit = {
+    shortName: string;
+    id: number;
+    name: string;
+};
+
+export type ImageMetadata = {
+    aspectRatio: number;
+    height: number;
+    width: number;
+};
+
+export type Images = {
+    count: number;
+    metadata: ImageMetadata[];
+    urls: {
+        small: string;
+        medium: string;
+        large: string;
+    };
+};
+
+export type Offer = {
+    brand: Brand;
+    advertisers: Advertiser[];
+    categories: Category[];
+    id: number;
+    description: string;
+    price: number;
+    oldPrice: number | null;
+    referencePrice: number;
+    requiresLoyalityMembership: boolean;
+    leafletFlightId: number;
+    validityDates: ValidityDates[];
+    externalId: number | null;
+    externalTrackingUrls: string[];
+    externalUrl: string | null;
+    trackFlightImpression: null;
+    type: 'standard';
+    industries: Industry[];
+    product: Product;
+    unit: Unit;
+    images: Images;
+    imageType: 'offer';
+};
+
+export type SearchOptions = {
+    allowedRetailers?: Retailer[];
+    limit?: number;
+    offset?: number;
+    zipCode?: number;
+};
+
+export function search(query: string, options?: SearchOptions): Promise<Offer[]>;