@begin/data - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@begin/data",
-  "version": "1.0.0",
-  "description": "Begin Data is a durable and fast key/value store for Begin built on top of DynamoDB.",
+  "version": "1.0.1",
+  "description": "Begin Data is a durable and fast key/value document store built on top of DynamoDB.",
   "main": "src/index.js",
   "scripts": {
     "lint": "eslint src --ignore-pattern node_modules --fix",
-    "test": "ARC_LOCAL=true NODE_ENV=testing tape test/test.js | tap-spec"
+    "test": "tape test/test.js | tap-spec"
   },
@@ -20,3 +20,5 @@ "license": "Apache-2.0",
   "dependencies": {
+    "@architect/parser": "^1.1.6",
     "hashids": "^1.2.2",
+    "run-parallel": "^1.1.9",
     "run-waterfall": "^1.1.6"
@@ -27,3 +29,2 @@ },
     "eslint": "^5.10.0",
-    "run-parallel": "^1.1.9",
     "tap-spec": "^5.0.0",
@@ -36,2 +37,4 @@ "tape": "^4.9.1"
     "AWS",
+    "dynamodb",
+    "keyvalue",
     "infrastructure",
@@ -38,0 +41,0 @@ "infra"

readme.md

@@ -11,2 +11,19 @@ # Begin Data
 
+## Usage
+
+Begin Data operates on one DynamoDB table named `data` with a partition key `scopeID` and a sort key of `dataID` and, optionally, a `ttl` for expiring documents. 
+
+Example `.arc`:
+
+```
+@app
+myapp
+
+@tables
+data
+  scopeID *String
+  dataID **String
+  ttl TTL
+```
+
 ### API
@@ -30,3 +47,3 @@
 
-All methods require a params object and, optionally, a Node style errback. If no errback is supplied a promise is returned. All methods support `async`/`await`.
+All methods accept params object and, optionally, a Node style errback. If no errback is supplied a promise is returned. All methods support `async`/`await`.
 
@@ -33,0 +50,0 @@ #### Writes

src/_atomic-counters.js

@@ -0,1 +1,6 @@
+/**
+ * @private
+ * @module incr
+ * @module decr
+ */
 let doc = require('./_get-doc')
@@ -2,0 +7,0 @@ let getTableName = require('./_get-table-name')

src/_create-key.js

@@ -0,1 +1,5 @@
+/**
+ * @private
+ * @module createKey
+ */
 let getTableName = require('./_get-table-name')
@@ -2,0 +6,0 @@ let db = require('./_get-db')

src/_fmt.js

@@ -0,4 +1,8 @@
+/**
+ * @private
+ * @module fmt
+ */
 let getKey = require('./_get-key')
 
-module.exports = function(obj) {
+module.exports = function fmt(obj) {
   let copy = {...obj, ...getKey(obj)}
@@ -5,0 +9,0 @@ delete copy.key

src/_get-db.js

@@ -0,1 +1,5 @@
+/**
+ * @private
+ * @module DynamoDB
+ */
 if (typeof process.env.NODE_ENV === 'undefined') {
@@ -2,0 +6,0 @@ process.env.NODE_ENV = 'testing'

src/_get-doc.js

@@ -0,1 +1,5 @@
+/**
+ * @private
+ * @module DynamoDB.DocumentClient
+ */
 if (typeof process.env.NODE_ENV === 'undefined') {
@@ -2,0 +6,0 @@ process.env.NODE_ENV = 'testing'

src/_get-key.js

@@ -1,7 +0,18 @@
-module.exports = function _getKey(params) {
+/**
+ * @private
+ * @module getKey
+ *
+ * Get the begin-data partition key (scopeID) and sort key (dataID)
+ *
+ * - the env var BEGIN_DATA_SCOPE_ID override always wins
+ * - uses ARC_APP_NAME if it exists
+ * - fallback to 'local' for running in the sandbox
+ * - dataID is scoped to staging or production depending on NODE_ENV
+ */
+module.exports = function getKey(params) {
   let {table, key} = params
   let env = process.env.NODE_ENV === 'testing'? 'staging' : (process.env.NODE_ENV || 'staging')
-  let scopeID = process.env.BEGIN_DATA_SCOPE_ID || 'local'
+  let scopeID = process.env.BEGIN_DATA_SCOPE_ID || process.env.ARC_APP_NAME || 'sandbox'
   let dataID = `${env}#${table}#${key}`
   return {scopeID, dataID}
 }

src/_get-table-name.js

@@ -1,4 +0,73 @@
-module.exports = function() {
+/**
+ * @private
+ * @module getTableName
+ *
+ * Get the begin-data table name
+ *
+ * - the env var BEGIN_DATA_TABLE_NAME override always wins
+ * - fallback to `data` table defined the current .arc
+ * - final fallback to begin-data-production-data or begin-data-staging-data
+ */
+let parse = require('@architect/parser')
+let join = require('path').join
+let fs = require('fs')
+let read = p=> fs.readFileSync(p).toString()
+let exists = fs.existsSync
+let table = false // cache between invocations
+
+module.exports = function getTableName() {
+
+  if (table)
+    return table
+
+  let raw
+  let arc
   let env = process.env.NODE_ENV === 'testing'? 'staging' : process.env.NODE_ENV
-  return process.env.BEGIN_DATA_TABLE_NAME || `begin-data-${env}-data`
+  let cwd = process.cwd()
+  let arcDefaultPath = join(cwd, '.arc')
+  let appDotArcPath = join(cwd, 'app.arc')
+  let arcYamlPath = join(cwd, 'arc.yaml')
+  let arcJsonPath = join(cwd, 'arc.json')
+  let localPath = join(__dirname, '..', 'shared', '.arc')
+
+  let override = process.env.hasOwnProperty('BEGIN_DATA_TABLE_NAME')
+  if (override) {
+    table = process.env.BEGIN_DATA_TABLE_NAME
+  }
+  else if (exists(arcDefaultPath)) {
+    raw = read(arcDefaultPath)
+    arc = parse(raw)
+    table = `${arc.app[0]}-${env}-data`
+  }
+  else if (exists(appDotArcPath)) {
+    raw = read(appDotArcPath)
+    arc = parse(raw)
+    table = `${arc.app[0]}-${env}-data`
+  }
+  else if (exists(arcYamlPath)) {
+    raw = read(arcYamlPath)
+    arc = parse.yaml(raw)
+    // HACK
+    raw = parse.yaml.stringify(raw)
+    table = `${arc.app[0]}-${env}-data`
+  }
+  else if (exists(arcJsonPath)) {
+    raw = read(arcJsonPath)
+    arc = parse.json(raw)
+    // HACK
+    raw = parse.json.stringify(raw)
+    table = `${arc.app[0]}-${env}-data`
+  }
+  else if (exists(localPath)) {
+    // otherwise we are: testing, staging or in production
+    // loading from node_modules/@architect/shared/.arc
+    raw = read(localPath)
+    arc = parse(raw)
+    table = `${arc.app[0]}-${env}-data`
+  }
+  else {
+    table = `begin-data-${env}-data`
+  }
+
+  return table
 }

src/_unfmt.js

@@ -1,2 +0,6 @@
-module.exports = function(obj) {
+/**
+ * @private
+ * @module unfmt
+ */
+module.exports = function unfmt(obj) {
   let copy = {...obj}
@@ -3,0 +7,0 @@ copy.key = obj.dataID.split('#')[2]

src/_validate.js

 /**
+ * @private
+ * @module validate
+ *
  * validate.table([table|items])
@@ -24,3 +27,2 @@ * ---
  *
- *
  * validate.size([item|items])
@@ -27,0 +29,0 @@ * ---

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25028

increased by12.41%

Dev dependency count

4

decreased by-20%

Lines of code

738

increased by16.04%

Number of lines in readme file

136

increased by14.29%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

4

increased by100%

Number of low supply chain risk alerts

11

increased by83.33%

Dependency changes

• + Added@architect/parser@^1.1.6

• + Addedrun-parallel@^1.1.9

• + Added@architect/parser@1.2.2(transitive)

• + Addedqueue-microtask@1.2.3(transitive)

• + Addedrun-parallel@1.2.0(transitive)