Merge pull request #2 from ReeceM/feature/test-mcb

Add Microbundle and also update the api methods to handle errors and return Slice/Type types (wip)

Author: ReeceM

.gitignore

@@ -1,3 +1,9 @@
+.vscode
 node_modules
+
+# Builds
 dist
+
+# Environment stuff
 env.json
+

.npmignore

@@ -1,3 +1,7 @@
+.github
 node_modules
 env.json
 src
+.editorconfig
+pnpm-lock.yml
+package-lock.json

README.md

@@ -10,27 +10,56 @@ I have intentionally only implemented mainly support for node as I don't see the
 
 The readme is a WIP and the code could probably have some error handling added.
 
-## Example
+## Usage
 
 Below is an example of how to use this to interact with the API for the custom types, it gets a type and writes the result to ta json file.
 
+### If using commonJS:
+
 ```js
-const Api = require('./dist/index').default;
+const Api = require('@reecem/custom-type-api');
 const credentials = require('./env.json');
 const fs = require('fs');
 const path = require('path')
 
-
 const api = new Api('slicemachine-startup', credentials.token)
 
 async function test() {
-  await api.login()
+  await api.init()
+
+  try {
+    const type = await api.types().getOne('page');
+
+    console.log(type)
+
+    fs.writeFileSync(path.join(__dirname, 'page.json'), JSON.stringify(type, null, 2))
+  } catch (ex) {
+    console.error(ex)
+  }
+}
+
+test()
+```
+
+
+### If using modules:
+
+```js
+import Api from '@reecem/custom-type-api'
+
+import { createRequire } from "module"; // Bring in the ability to create the 'require' method
+const require = createRequire(import.meta.url); // construct the require method
+const credentials = require('../env.json');
+
+async function test() {
+  const api = new Api('slicemachine-startup', credentials.token)
+
+  await api.init()
 
   try {
-    const response = await api.types().getOne('page');
-    const res = await response.json();
-    console.log(res)
-    fs.writeFileSync(path.join(__dirname, 'page.json'), JSON.stringify(res, null, 2))
+    let slice = await api.slices().getOne('form_slice');
+    console.log(slice)
+    fs.writeFileSync(path.join(__dirname, 'form_slice.json'), JSON.stringify(slice, null, 2))
   } catch (ex) {
     console.error(ex)
   }

package.json

@@ -1,22 +1,35 @@
 {
   "name": "@reecem/custom-type-api",
-  "version": "0.1.1",
+  "version": "0.2.0-alpha.3",
   "description": "API interface for the Prismic.io Custom Type API (beta)",
-  "main": "dist/index.js",
+  "type": "module",
+  "source": "src/index.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc --build tsconfig.json"
+    "build": "microbundle",
+    "dev": "microbundle watch",
+    "tsc-build": "tsc --build tsconfig.json"
   },
   "keywords": [
     "prismic.io",
-    "custom-type"
+    "custom-types",
+    "slices",
+    "api",
+    "slicemachine"
   ],
-  "author": "ReeceM",
+  "author": "@ReeceM",
   "license": "ISC",
   "devDependencies": {
     "@types/node-fetch": "^2.5.10",
+    "microbundle": "^0.13.3",
     "typescript": "^4.2.4"
   },
+  "engines": {
+    "node": ">=12.0"
+  },
   "dependencies": {
     "node-fetch": "^2.6.1"
   }