skikrumb-api 1.0.5 → 1.0.7

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { apiKeys, Device, QueryDevice } from "./models";
 export declare const skiKrumb: (options?: {
     apiKey: string;
-    requestedWith: string;
-    url: string;
+    requestedWith: string | undefined;
+    url: string | undefined;
 }) => {
     createPaymentIntent: (form: any) => Promise<any>;
     createPrePurchaseIntent: (form: any) => Promise<any>;

package/dist/models.d.ts

@@ -6,7 +6,7 @@ export interface apiKeys {
     claims: any;
 }
 export interface Device {
-    serial_number: number;
+    serial_number: string;
     created_at: string;
     updated_at: string;
     data?: Data[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skikrumb-api",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Wrapper for the skiKrumb API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/{README.md → readme.md}

@@ -21,6 +21,30 @@ const {readDeviceData} = skiKrumb({
     url: 'Defaults to http://api.skikrumb.ca'
 })
 ```
+### skiKrumb(options?)
+#### options
+
+Type: `object`
+
+##### apiKey
+
+Type: `string`
+
+Your API Key as provided by skiKrumb.
+
+##### requestedWith
+
+Type: `string`\
+Default: `'skiKrumb API Wrapper'`
+
+Sets the `requestedWith` header. Helps with identifying your application.
+
+##### url
+
+Type: `string`\
+Default: `'https://api.skikrumb.ca'`
+
+Defaults to production skiKrumb API URL. Possible values: `https://api-dev.skikrumb.ca` or localhost testing.
 
 ## API Documentation
 #### [Swagger Documentation](https://api.skikrumb.ca/documentation/static/index.html)
@@ -28,6 +52,4 @@ const {readDeviceData} = skiKrumb({
 > Requires an API key. Request an API Key by emailing info@skikrumb.ca
 
 > © skiKrumb
-> `2023`
-
-
+> `2023`

package/index.ts

@@ -1,77 +0,0 @@
-import ky from 'ky';
-import {apiKeys, Device, QueryDevice} from "./models";
-
-export const skiKrumb = (options = {
-    apiKey: '',
-    requestedWith: 'skiKrumb API Wrapper',
-    url: 'https://api.skikrumb.ca'
-}) => {
-    const api = ky.extend({
-        hooks: {
-            beforeRequest: [
-                request => {
-                    request.headers.set('X-Requested-With', `${options.requestedWith}`)
-                    request.headers.set('Authorization', `Bearer ${options.apiKey}`)
-                    request.headers.set('Content-Type', `application/json`)
-                }
-            ]
-        }
-    });
-
-    const createPaymentIntent =  async (form: any): Promise<any> => {
-        if (!form)
-            throw new Error('Form values not posted.')
-
-        return api.post(`${options.url}/payments/intent`, {
-            body: form
-        }).json()
-    }
-    const createPrePurchaseIntent =  async (form: any): Promise<any> => {
-        if (!form)
-            throw new Error('Form values not posted.')
-
-        return api.post(`${options.url}/payments/pre-purchase/intent`, {
-            body: form
-        }).json()
-    }
-
-    const readDeviceData =  async (serialNumber: number, query: QueryDevice): Promise<Device[]> => {
-        if (!serialNumber)
-            throw new Error('Serial number is required')
-
-        return api.get(`${options.url}/devices/data/${serialNumber}`, {
-            searchParams: new URLSearchParams({...query})
-        }).json()
-    }
-
-    const readDeviceDailyDistance =  async (serialNumber: number, query: QueryDevice): Promise<Device[]> => {
-        if (!serialNumber)
-            throw new Error('Serial number is required')
-
-        return api.get(`${options.url}/devices/${serialNumber}/distance`, {
-            searchParams: new URLSearchParams({...query})
-        }).json()
-    }
-
-    const readDataForDevices =  async (query: QueryDevice): Promise<Device[]> => {
-        if (!query.serial_numbers)
-            throw new Error('Serial number is required')
-
-        return api.get(`${options.url}/devices/data`, {
-            searchParams: new URLSearchParams({...query})
-        }).json()
-    }
-
-    const readApiKeys =  async (): Promise<apiKeys[]> => {
-        return api.get(`${options.url}/keys`).json()
-    }
-
-    return {
-        createPaymentIntent,
-        createPrePurchaseIntent,
-        readApiKeys,
-        readDataForDevices,
-        readDeviceDailyDistance,
-        readDeviceData
-    };
-};

package/models.ts

@@ -1,41 +0,0 @@
-export interface apiKeys {
-  id: number;
-  name: string;
-  description: string;
-  jwt: string;
-  claims: any;
-}
-
-export interface Device {
-  serial_number: number;
-  created_at: string;
-  updated_at: string;
-  data?: Data[];
-}
-
-export interface Data {
-  latitude: number;
-  longitude: number;
-  temperature: number;
-  battery: number;
-  serial_number: number;
-  id: number;
-  created_at: string;
-  updated_at: string;
-  recorded_at: string;
-  firmware: string;
-  signal_strength: number;
-  altitude: number;
-}
-
-export interface QueryDevice {
-  serial_numbers?: string;
-  order_by?: string;
-  ascending?: string;
-  start_date?: string;
-  date?: string;
-  end_date?: string;
-  size?: string;
-  page?: string;
-}
-