@caruuto/caruuto-js 0.3.5 → 0.4.0

package/CHANGELOG.md

@@ -5,7 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## 0.3.4 - 2024-05-08
+## 0.3.6 - 2024-09-06
+
+### Added
+
+- Added `createToken` method for creating new tokens for reset password, etc.
+- Added `verifyToken` method for verifying tokens created by `createToken`.
+
+## 0.3.5 - 2024-05-08
 
 ### Fixed
 

package/index.js

@@ -1,21 +1,16 @@
-const CaruutoClient = function (caruutoUrl, caruutoApiKey) {
-  this.options = {}
+const CaruutoClient = function (caruutoUrl, caruutoApiKey, options = {}) {
+  this.options = options
   this.options.caruutoUrl = caruutoUrl
   this.options.caruutoApiKey = caruutoApiKey
 
   this.options.version = '1'
   this.options.callback = this._processRequest.bind(this)
 
-  this.reservedProperties = [
-    '_id',
-    'apiVersion',
-    'createdBy',
-    'createdAt',
-    'lastModifiedAt',
-    'lastModifiedBy',
-    'v',
-    'history',
-    'composed'
+  this.reservedProperties = this.options.reservedProperties || [
+    'created_at',
+    'created_by',
+    'updated_at',
+    'updated_by'
   ]
 
   if (this.options.caruutoUrl === undefined) {
@@ -51,11 +46,18 @@ require('./lib/filters')(CaruutoClient)
 
 require('./lib/terminators')(CaruutoClient)
 
+// -----------------------------------------
+
 module.exports = CaruutoClient
 
 /**
  * Creates a new Caruuto Client.
  */
-module.exports.createClient = (caruutoUrl, caruutoApiKey) => {
-  return new CaruutoClient(caruutoUrl, caruutoApiKey)
+module.exports.createClient = (caruutoUrl, caruutoApiKey, options) => {
+  const client = new CaruutoClient(caruutoUrl, caruutoApiKey, options)
+
+  // Attach extensions once the client is created.
+  require('./lib/extensions')(CaruutoClient, client)
+
+  return client
 }

package/lib/extensions/email.js

@@ -0,0 +1,57 @@
+module.exports = function (CaruutoClient, clientInstance) {
+  CaruutoClient.prototype.email = {
+    find: function (query) {
+      this.endpoint = 'email'
+
+      this.query = query
+
+      const requestPayload = {
+        method: 'GET',
+        uri: this._buildURL({ useParams: true })
+      }
+
+      this._setHeader('content-type', 'application/json')
+
+      return this._createRequestObject(requestPayload)
+    }.bind(clientInstance),
+    queue: function (data) {
+      this.endpoint = 'email'
+
+      const requestPayload = {
+        body: data,
+        method: 'POST',
+        uri: this._buildURL()
+      }
+
+      this._setHeader('content-type', 'application/json')
+
+      return this._createRequestObject(requestPayload)
+    }.bind(clientInstance),
+    update: function (data) {
+      this.endpoint = 'email'
+
+      const requestPayload = {
+        body: data,
+        method: 'PUT',
+        uri: this._buildURL()
+      }
+
+      this._setHeader('content-type', 'application/json')
+
+      return this._createRequestObject(requestPayload)
+    }.bind(clientInstance),
+    delete: function (data) {
+      this.endpoint = 'email'
+
+      const requestPayload = {
+        body: data,
+        method: 'DELETE',
+        uri: this._buildURL()
+      }
+
+      this._setHeader('content-type', 'application/json')
+
+      return this._createRequestObject(requestPayload)
+    }.bind(clientInstance)
+  }
+}

package/lib/extensions/tokens.js

@@ -0,0 +1,33 @@
+module.exports = function (CaruutoClient, clientInstance) {
+  CaruutoClient.prototype.tokens = {
+    create: function (data) {
+      this.endpoint = 'tokens'
+
+      const requestPayload = {
+        body: data,
+        method: 'POST',
+        uri: this._buildURL()
+      }
+
+      this._setHeader('content-type', 'application/json')
+
+      return this._createRequestObject(requestPayload)
+    }.bind(clientInstance),
+    verify: function (token) {
+      this.endpoint = 'tokens'
+
+      const requestPayload = {
+        body: {
+          token,
+          verify: true
+        },
+        method: 'POST',
+        uri: this._buildURL()
+      }
+
+      this._setHeader('content-type', 'application/json')
+
+      return this._createRequestObject(requestPayload)
+    }.bind(clientInstance)
+  }
+}

package/lib/extensions.js

@@ -0,0 +1,53 @@
+const fs = require('fs')
+const path = require('path')
+
+/*
+Each extension should be added to the CaruutoClient prototype, so that
+for example, the email extension can be used as:
+
+```
+const client = new CaruutoClient()
+client.email.send({ ... })
+client.email.queue({ ... })
+```
+
+The extension function should take the CaruutoClient prototype as an
+argument and add methods to it.
+For example:
+
+```
+module.exports = function (CaruutoClient, clientInstance) {
+  CaruutoClient.prototype.email = {
+    queue: function (data) {
+      this.endpoint = 'email/queue'
+
+      const requestPayload = {
+        body: data,
+        method: 'POST',
+        uri: this._buildURL()
+      }
+
+      this._setHeader('content-type', 'application/json')
+
+      return this._createRequestObject(requestPayload)
+    }.bind(clientInstance)
+  }
+}
+```
+*/
+
+// Load all extensions from the lib/extensions directory/
+module.exports = function (CaruutoClient, clientInstance) {
+  const extensionsDir = path.join(__dirname, 'extensions')
+  const files = fs.readdirSync(extensionsDir)
+
+  files.forEach(file => {
+    if (file.endsWith('.js')) {
+      const extension = require(path.join(extensionsDir, file))
+
+      if (typeof extension === 'function') {
+        extension(CaruutoClient, clientInstance)
+      }
+    }
+  })
+}

package/lib/performFetch.js

@@ -76,7 +76,9 @@ module.exports = function (CaruutoClient) {
         if (responseData.errors) {
           err.errors = responseData.errors
         }
-      } catch (error) {}
+      } catch (error) {
+        console.log('error :>> ', error)
+      }
       return Promise.reject(err)
     }
 

package/lib/terminators.js

@@ -297,4 +297,45 @@ module.exports = function (CaruutoClient) {
 
     return this._createRequestObject(requestPayload)
   }
+
+  /*
+   * Create a new token.
+   * @param {Object} data
+   * @api public
+   */
+  CaruutoClient.prototype.createToken = function (data) {
+    this.endpoint = 'tokens'
+
+    const requestPayload = {
+      body: data,
+      method: 'POST',
+      uri: this._buildURL()
+    }
+
+    this._setHeader('content-type', 'application/json')
+
+    return this._createRequestObject(requestPayload)
+  }
+
+  /*
+   * Verify a token.
+   * @param {Object} data
+   * @api public
+   */
+  CaruutoClient.prototype.verifyToken = function (token) {
+    this.endpoint = 'tokens'
+
+    const requestPayload = {
+      body: {
+        token,
+        verify: true
+      },
+      method: 'POST',
+      uri: this._buildURL()
+    }
+
+    this._setHeader('content-type', 'application/json')
+
+    return this._createRequestObject(requestPayload)
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caruuto/caruuto-js",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "A high-level library for interacting with Caruuto",
   "exports": "./index.js",
   "scripts": {
@@ -14,6 +14,7 @@
     "debug": "^2.6.1",
     "encoding": "^0.1.13",
     "got": "^11.0.0",
+    "human-interval": "^2.0.1",
     "mocha": "^10.2.0",
     "query-string": "5.0.1"
   },
@@ -40,6 +41,7 @@
   },
   "homepage": "https://github.com/Caruuto/caruuto-js",
   "devDependencies": {
+    "chai": "^5.2.0",
     "coveralls": "^3.0.2",
     "eslint": "8.5.0",
     "eslint-config-next": "13.0.5",

package/scripts/coverage.js

@@ -2,11 +2,12 @@
 
 const exec = require('child_process').exec
 
-if (process.env['CI']) {
+if (process.env.CI) {
   exec(
     'cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js',
     (err, out) => {
       if (err) console.log(err)
+      console.log(out)
     }
   )
 }

package/x.js

@@ -1,7 +1,11 @@
 const { createClient } = require('./index')
 
 ;(async () => {
-  const x = createClient('https://localcaruuto.com/api', '12345678900987654321')
+  const x = createClient(
+    'https://localcaruuto.com/api',
+    '12345678900987654321',
+    { reservedProperties: ['created_at'] }
+  )
 
   // const signedUrl = await x.inMedia('radical').getSignedUrl('test.jpg')
 
@@ -13,7 +17,32 @@ const { createClient } = require('./index')
   //   questionId: 'f373b0a2-9c87-41f1-af49-f643da8f836c'
   // })
 
-  x.search({ phrase: 'grower' })
-  const y = await x.find()
-  console.log('y :>> ', y)
+  // x.search({ phrase: 'grower' })
+  // const y = await x.find()
+  // console.log('y :>> ', y)
+
+  // const z = await x.tokens.create({
+  //   email: 'jameslambie@gmail.com',
+  //   expiry: 7200000,
+  //   type: 'RESET'
+  // })
+  // const z = await x.verifyToken('q8ug8epjx5hzcg48ku')
+  // console.log('z :>> ', z)
+
+  // console.log('p :>> ', await x.create({ x: 1 }))
+
+  console.log('x :>> ', x)
+  // console.log('x :>> ', x.email)
+  // console.log('x :>> ', x.email.queue)
+  // const xx = await x.email.queue({
+  //   to: 'x@x.com',
+  //   from: 'z@z.com',
+  //   templateId: 'test'
+  // })
+
+  // console.log('xx :>> ', xx)
+
+  const zz = await x.email.find({ sent: true })
+
+  console.log('zz :>> ', zz)
 })()