First

Author: aarondfrancis

.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: Publish to NPM
+on:
+  release:
+    types: [ created ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/tests.yml

@@ -0,0 +1,15 @@
+name: Tests
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install packages
+        run: npm install
+
+      - name: Run tests
+        run: npm run test

.gitignore

@@ -0,0 +1,4 @@
+dist
+.idea
+node_modules
+package-lock.json

cli.js

@@ -0,0 +1,2 @@
+export { default as FileCache } from './src/cache/file'
+export { default as terminalLogger } from './src/loggers/terminal'

index.js

@@ -0,0 +1,4 @@
+export { default as Block } from './src/block'
+export { default as torchlight } from './src/torchlight'
+export { default as MemoryCache } from './src/cache/memory'
+export { default as standardLogger } from './src/loggers/standard'

package.json

@@ -0,0 +1,62 @@
+{
+    "name": "@torchlight-api/client",
+    "version": "0.0.1",
+    "description": "A general purpose JavaScript client for Torchlight - the syntax highlighting API",
+    "source": "*.js",
+    "type": "module",
+    "exports": {
+        ".": {
+            "import": "./dist/client.esm.js",
+            "require": "./dist/client.cjs"
+        },
+        "./cli": {
+            "import": "./dist/cli.esm.js",
+            "require": "./dist/cli.cjs"
+        }
+    },
+    "scripts": {
+        "test": "standard --env jest && jest",
+        "build": "microbundle -f esm,cjs"
+    },
+    "author": "Aaron Francis <[email protected]> (https://torchlight.dev)",
+    "license": "MIT",
+    "dependencies": {
+        "axios": "^0.21.1",
+        "chalk": "^4.1.2",
+        "fs-extra": "^10.0.0",
+        "lodash.chunk": "^4.2.0",
+        "lodash.get": "^4.4.2",
+        "md5": "^2.3.0"
+    },
+    "devDependencies": {
+        "@babel/preset-env": "^7.15.0",
+        "babel-jest": "^27.0.6",
+        "jest": "^27.0.6",
+        "microbundle": "^0.13.3",
+        "standard": "^16.0.3"
+    },
+    "jest": {
+        "clearMocks": true,
+        "transform": {
+            "^.+\\.[t|j]sx?$": "babel-jest"
+        }
+    },
+    "babel": {
+        "presets": [
+            [
+                "@babel/preset-env",
+                {
+                    "targets": {
+                        "node": "12.13.0"
+                    }
+                }
+            ]
+        ]
+    },
+    "standard": {
+        "ignore": [
+            "tests",
+            "dists"
+        ]
+    }
+}

src/block.js

@@ -0,0 +1,94 @@
+import md5 from 'md5'
+import guid from './support/guid'
+import torchlight from './torchlight'
+
+export default function Block (opts = {}) {
+  opts = {
+    id: guid(),
+    theme: torchlight.config('theme', 'nord'),
+    ...opts
+  }
+
+  this.id = opts.id
+  this.code = opts.code
+  this.language = opts.language
+  this.theme = opts.theme
+
+  this.highlighted = null
+  this.classes = null
+  this.styles = null
+}
+
+Block.prototype.hash = function () {
+  return md5('' +
+    this.language +
+    this.theme +
+    this.code +
+    torchlight.config('bust', 0) +
+    JSON.stringify(torchlight.config('options'))
+  )
+}
+
+Block.prototype.code = function (code) {
+  this.code = code
+
+  return this
+}
+
+Block.prototype.language = function (language) {
+  this.language = language
+
+  return this
+}
+
+Block.prototype.theme = function (theme) {
+  this.theme = theme
+
+  return this
+}
+
+Block.prototype.placeholder = function (extra = '') {
+  if (extra) {
+    extra = `-${extra}`
+  }
+
+  return `__torchlight-block-[${this.id}]${extra}__`
+}
+
+Block.prototype.setResponseData = function (data) {
+  if (data) {
+    this.highlighted = data.highlighted
+    this.classes = data.classes
+    this.styles = data.styles
+  }
+
+  return this
+}
+
+Block.prototype.setResponseDataFromCache = function () {
+  const data = this.getResponseDataFromCache()
+
+  this.setResponseData(data)
+
+  return this
+}
+
+Block.prototype.getResponseDataFromCache = function () {
+  return torchlight.cache.get(this.hash(), {})
+}
+
+Block.prototype.populateCache = function (data) {
+  torchlight.cache.set(this.hash(), data)
+
+  return this
+}
+
+Block.prototype.toRequestParams = function () {
+  return {
+    id: this.id,
+    hash: this.hash(),
+    language: this.language,
+    theme: this.theme,
+    code: this.code
+  }
+}

src/cache/file.js

@@ -0,0 +1,78 @@
+import md5 from 'md5'
+import path from 'path'
+import fs from 'fs-extra'
+
+/**
+ * @param options
+ * @constructor
+ */
+export default function File (options = {}) {
+  if (!options.directory) {
+    throw new Error('No cache directory specified.')
+  }
+
+  this.directory = path.resolve(options.directory)
+
+  fs.ensureDirSync(this.directory)
+}
+
+/**
+ * Get an item from the cache.
+ *
+ * @param {string} key
+ * @param {*} def
+ * @return {*}
+ */
+File.prototype.get = function (key, def) {
+  if (!fs.pathExistsSync(this.filename(key))) {
+    return def
+  }
+
+  const entry = fs.readJsonSync(this.filename(key))
+
+  if (Date.now() / 1000 > entry.expires) {
+    this.delete(key)
+
+    return def
+  }
+
+  return entry.value
+}
+
+/**
+ * Set an item in the cache.
+ *
+ * @param {string} key
+ * @param {*} value
+ * @param {number} ttlSeconds
+ */
+File.prototype.set = function (key, value, ttlSeconds = 60 * 24 * 7) {
+  fs.writeJsonSync(this.filename(key), {
+    expires: (Date.now() / 1000) + ttlSeconds,
+    value: value
+  })
+}
+
+/**
+ * Remove a key from the cache.
+ *
+ * @param key
+ */
+File.prototype.delete = function (key) {
+  fs.removeSync(this.filename(key))
+}
+
+/**
+ * Clear the cache.
+ */
+File.prototype.clear = function () {
+  fs.removeSync(this.directory)
+}
+
+/**
+ * @param {string} key
+ * @return {string}
+ */
+File.prototype.filename = function (key) {
+  return path.join(this.directory, md5(key) + '.json')
+}

src/cache/memory.js

@@ -0,0 +1,58 @@
+let store = {}
+
+export default function Memory () {
+  //
+}
+
+/**
+ * Get an item from the cache.
+ *
+ * @param {string} key
+ * @param {*} def
+ * @return {*}
+ */
+Memory.prototype.get = function (key, def) {
+  if (!Object.prototype.hasOwnProperty.call(store, key)) {
+    return def
+  }
+
+  const entry = store[key]
+
+  if (Date.now() / 1000 > entry.expires) {
+    this.delete(key)
+
+    return def
+  }
+
+  return entry.value
+}
+
+/**
+ * Set an item in the cache.
+ *
+ * @param {string} key
+ * @param {*} value
+ * @param {number} ttlSeconds
+ */
+Memory.prototype.set = function (key, value, ttlSeconds = 60 * 24 * 7) {
+  store[key] = {
+    expires: (Date.now() / 1000) + ttlSeconds,
+    value: value
+  }
+}
+
+/**
+ * Remove a key from the cache.
+ *
+ * @param key
+ */
+Memory.prototype.delete = function (key) {
+  delete store[key]
+}
+
+/**
+ * Clear the cache.
+ */
+Memory.prototype.clear = function () {
+  store = {}
+}