chore: create example project using API

fix: fetch dependency usage

Author: IanTapply22

.gitignore

@@ -3,4 +3,6 @@ package-lock.json
 .vscode
 
 *-cache.json
-scripts/
+scripts/
+
+.env

example/.env.example

@@ -0,0 +1,3 @@
+ENTERPRISE_API_KEY = 'ent_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+SETSTORE_PLUGIN_API_KEY = 'ss_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+SETSTORE_CONNECTION_API_KEY = 'sc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

example/index.js

@@ -0,0 +1,32 @@
+import { MCSetsAPI } from 'mcsets-js-sdk-client'
+import dotenv from 'dotenv'
+
+// Inject ENV vars from ENV file 
+dotenv.config({quiet: true})
+
+// Create constants with API keys from ENV vars
+const enterpriseApiKey = process.env.ENTERPRISE_API_KEY
+const setStorePluginApiKey = process.env.SETSTORE_PLUGIN_API_KEY
+const setStoreConnectionApiKey = process.env.SETSTORE_CONNECTION_API_KEY
+
+// Base API required no auth so we will set the key to null
+const baseApi = MCSetsAPI.from(null, 'base')
+
+const enterpriseApi = MCSetsAPI.from(enterpriseApiKey, 'enterprise')
+
+// Create two set store API instances with both API keys to support both auth methods
+const setStorePluginApi = MCSetsAPI.from(setStorePluginApiKey, 'setstore')
+const setStoreConnectionApi = MCSetsAPI.from(setStoreConnectionApiKey, 'setstore')
+
+/**
+ * Example API calls are made below
+ */
+
+// Use base API to fetch health status (no auth required)
+await baseApi.getHealth().then(console.log)
+ 
+// Use the enterprise API to fetch products (requires enterprise API key, see ENV for key examples)
+await enterpriseApi.getProducts().then(console.log)
+
+// Use the set store plugin API to fetch pending delivery commands (requires set store plugin API key, see ENV for key examples)
+await setStorePluginApi.fetchPendingDeliveryCommands().then(console.log)

example/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "description": "An example project using the MCSets JS SDK client.",
+  "license": "MIT",
+  "author": "Ian Tapply",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "dotenv": "^17.3.1",
+    "mcsets-js-sdk-client": "file:../"
+  }
+}

index.d.ts

@@ -144,4 +144,6 @@ declare module 'mcsets-js-sdk-client' {
         total: number
     }
   }
+
+  export default MCSetsAPI
 }

package.json

@@ -3,6 +3,7 @@
   "version": "1.0.2",
   "description": "Library to manage and interact with MCSets API's",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "mocha --recursive --reporter spec --exit",
     "pretest": "npm run lint",

src/rest.js

@@ -1,5 +1,11 @@
 const debug = require('debug')('mcsets-js-sdk-client')
-const fetch = require('node-fetch')
+
+let fetch
+try {
+  fetch = globalThis.fetch || require('node-fetch')
+} catch (e) {
+  throw new Error('Fetch API is not available. Please ensure you are running in an environment with fetch support or install node-fetch for Node.js environments.')
+}
 
 const constants = require('./constants')