Merge pull request #1 from apiaryio/kylef/package

Initial package

Author: tjanc

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+package-lock.json

CHANGELOG.md

@@ -0,0 +1,5 @@
+# API Elements (JavaScript) CHANGELOG
+
+## 0.1.0
+
+Initial Release.

README.md

@@ -1 +1,32 @@
-# api-elements.js
+# API Elements JavaScript
+
+This library provides an interface to [API Elements](http://apielements.org) in JavaScript.
+
+## Install
+
+```shell
+$ npm install api-elements
+```
+
+## Usage
+
+### Node
+
+```javascript
+const apiElements = require('api-elements');
+const namespace = new apiElements.Namespace();
+
+
+// Parsing a JSON Representation of API Elements tree
+const parseResult = namespace.serialiser.deserialise({
+  element: 'parseResult',
+  content: []
+});
+
+console.log(parseResult);
+
+
+// Creating API Elements directly
+const parseResult = new namespace.elements.ParseResult();
+console.log(parseResult);
+```

lib/api-elements.js

@@ -0,0 +1,17 @@
+const minim = require('minim');
+const minimParseResult = require('minim-parse-result');
+
+
+class Namespace extends minim.Namespace {
+  constructor() {
+    super();
+    this.use(minimParseResult);
+  }
+}
+
+
+const namespace = new Namespace();
+
+
+module.exports = namespace;
+module.exports.Namespace = Namespace;

package.json

@@ -0,0 +1,28 @@
+{
+  "name": "api-elements",
+  "version": "0.1.0",
+  "description": "API Elements JavaScript",
+  "main": "lib/api-elements.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/apiaryio/api-elements.js.git"
+  },
+  "scripts": {
+    "test": "mocha"
+  },
+  "author": "Apiary",
+  "license": "MIT",
+  "dependencies": {
+    "minim": "^0.20.4",
+    "minim-parse-result": "^0.10.0"
+  },
+  "devDependencies": {
+    "chai": "^4.1.2",
+    "mocha": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=4"
+  },
+  "author": "Apiary.io <[email protected]>",
+  "license": "MIT"
+}

test/test_api_elements.js

@@ -0,0 +1,42 @@
+const { expect } = require('chai');
+
+const apiElements = require('../lib/api-elements');
+
+
+describe('API Elements', () => {
+  context('provides a default namespace', () => {
+    let namespace;
+
+    before(() => {
+      namespace = apiElements;
+    });
+
+    context('which provides elements', () => {
+      it('contains ParseResult', () => {
+        expect(namespace.elements.ParseResult).to.not.be.null;
+      });
+
+      it('contains Category', () => {
+        expect(namespace.elements.Category).to.not.be.null;
+      });
+    });
+  });
+
+  context('provides a namespace class', () => {
+    let namespace;
+
+    before(() => {
+      namespace = new apiElements.Namespace();
+    });
+
+    context('which provides elements', () => {
+      it('contains ParseResult', () => {
+        expect(namespace.elements.ParseResult).to.not.be.null;
+      });
+
+      it('contains Category', () => {
+        expect(namespace.elements.Category).to.not.be.null;
+      });
+    });
+  });
+});