presidium 3.4.8 → 3.6.0

package/AwsCredentials.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const fs = require('fs')
 const resolvePath = require('./internal/resolvePath')

package/DiskHashTable.js

@@ -0,0 +1,3 @@
+const DiskHashTable = require('presidium-db/DiskHashTable')
+
+module.exports = DiskHashTable

package/DiskSortedHashTable.js

@@ -0,0 +1,3 @@
+const DiskSortedHashTable = require('presidium-db/DiskSortedHashTable')
+
+module.exports = DiskSortedHashTable

package/Docker.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const isString = require('rubico/x/isString')
 const identity = require('rubico/x/identity')

package/DynamoDBGlobalSecondaryIndex.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const crypto = require('crypto')
 const HTTP = require('./HTTP')

package/DynamoDBStream.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const { differenceWith } = require('rubico/x')
 const Transducer = require('rubico/Transducer')

package/DynamoDBTable.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const crypto = require('crypto')
 const HTTP = require('./HTTP')

package/ECR.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const crypto = require('crypto')
 const HTTP = require('./HTTP')

package/GoogleChromeDevTools.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 const EventEmitter = require('events')
 const GoogleChromeForTesting = require('./GoogleChromeForTesting')
 const WebSocket = require('./WebSocket')

package/GoogleChromeForTesting.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 const https = require('https')
 const os = require('os')
 const fs = require('fs')

package/HTTP.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 const http = require('http')
 const https = require('https')
 const path = require('path')

package/NpmToken.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const fs = require('fs')
 const resolvePath = require('./internal/resolvePath')

package/OptionalValidator.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 /**
  * @name OptionalValidator
  *

package/Password.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 const crypto = require('crypto')
 
 /**

package/README.md

@@ -1,6 +1,9 @@
 # Presidium
 ![presidium](https://rubico.land/assets/presidium-logo-3-w200.jpg)
 
+Source code: [GitHub](https://github.com/richytong/presidium) |
+License: [CFOSS](https://cloutsworld.com/en-us/legal/license/cfoss)
+
 ![Node.js CI](https://github.com/richytong/presidium/workflows/Node.js%20CI/badge.svg)
 [![codecov](https://codecov.io/gh/richytong/presidium/branch/master/graph/badge.svg)](https://codecov.io/gh/richytong/presidium)
 [![npm version](https://img.shields.io/npm/v/presidium.svg?style=flat)](https://www.npmjs.com/package/presidium)
@@ -350,5 +353,65 @@ const data = await googleChromeDevTools.Page.navigate({
 })
 ```
 
+## [Store data on disk as a hash table](https://presidium.services/docs/DiskHashTable)
+```javascript
+const DiskHashTable = require('presidium-db/DiskHashTable')
+
+const ht = new DiskHashTable({
+  storageFilepath: '/path/to/storage-file',
+  headerFilepath: '/path/to/header-file',
+  initialLength: 1024,
+})
+await ht.init()
+
+await ht.set('my-key', 'my-value')
+
+const myValue = await ht.get('my-key')
+console.log(myValue) // 'my-value'
+
+await ht.delete('my-key')
+```
+
+## [Store data on disk as a sorted hash table](https://presidium.services/docs/DiskSortedHashTable)
+```javascript
+const DiskSortedHashTable = require('presidium-db/DiskSortedHashTable')
+
+const sortedHt = new DiskSortedHashTable({
+  storageFilepath: '/path/to/storage-file',
+  headerFilepath: '/path/to/header-file',
+  initialLength: 1024,
+})
+await sortedHt.init()
+
+await sortedHt.set('first-key', 'first-value', 1)
+await sortedHt.set('second-key', 'second-value', 2)
+await sortedHt.set('third-key', 'third-value', 3)
+
+for await (const value of sortedHt.forwardIterator()) {
+  console.log(value) // first-value
+                     // second-value
+                     // third-value
+}
+
+for await (const value of sortedHt.reverseIterator()) {
+  console.log(value) // third-value
+                     // second-value
+                     // first-value
+}
+
+for await (const value of sortedHt.forwardIterator({ startingSortValue: 2, endingSortValue: 3 })) {
+  console.log(value) // second-value
+                     // third-value
+}
+
+for await (const value of sortedHt.reverseIterator({ startingSortValue: 2, endingSortValue: 1 })) {
+  console.log(value) // second-value
+                     // first-value
+}
+```
+
+## License
+Presidium is distributed under the [CFOSS License](https://cloutsworld.com/en-us/legal/license/cfoss).
+
 # Support
  * minimum Node.js version: 16

package/Readable.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 /**
  * @name Readable
  *

package/S3Bucket.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const crypto = require('crypto')
 const HTTP = require('./HTTP')
@@ -173,6 +180,7 @@ class S3Bucket {
         await this.create()
         await this.putPublicAccessBlock()
         await this.putRequestPayment()
+        await this._putBucketEncryption()
         if (this.VersioningStatus == 'Enabled') {
           await this.putVersioning()
         }
@@ -314,6 +322,43 @@ class S3Bucket {
     return this.http1[method](url, { headers, body })
   }
 
+  // _putBucketEncryption() -> Promise<>
+  async _putBucketEncryption() {
+    const body = `
+<ServerSideEncryptionConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+    <Rule>
+        <ApplyServerSideEncryptionByDefault>
+            <SSEAlgorithm>AES256</SSEAlgorithm>
+        </ApplyServerSideEncryptionByDefault>
+        <BlockedEncryptionTypes>
+            <EncryptionType>NONE</EncryptionType>
+        </BlockedEncryptionTypes>
+        <BucketKeyEnabled>true</BucketKeyEnabled>
+    </Rule>
+</ServerSideEncryptionConfiguration>
+    `.trim()
+
+    const response = await this._awsRequest0('PUT', '/?encryption', {}, body)
+
+    if (response.ok) {
+      await Readable.Text(response)
+      return {}
+    }
+    throw new AwsError(await Readable.Text(response), response.status)
+  }
+
+  /*
+  // _getBucketEncryption() -> data object
+  async _getBucketEncryption() {
+    const response = await this._awsRequest0('GET', '/?encryption', {}, '')
+    if (response.ok) {
+      const text = await Readable.Text(response)
+      return text
+    }
+    throw new AwsError(await Readable.Text(response), response.status)
+  }
+  */
+
   /**
    * @name getLocation
    *

package/Secrets.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const fs = require('fs')
 

package/SecretsManager.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const crypto = require('crypto')
 const HTTP = require('./HTTP')

package/StrictValidator.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 /**
  * @name StrictValidator
  *

package/TranscribeStream.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 require('rubico/global')
 const EventEmitter = require('events')
 const crypto = require('crypto')

package/XML.js

@@ -1,3 +1,10 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 /**
  * @name XML
  *

package/index.js

@@ -1,5 +1,14 @@
+/**
+ * Presidium
+ * https://presidium.services/
+ * (c) Richard Tong
+ * Presidium may be freely distributed under the CFOSS license.
+ */
+
 module.exports = {
   AwsCredentials: require('./AwsCredentials.js'),
+  DiskHashTable: require('./DiskHashTable.js'),
+  DiskSortedHashTable: require('./DiskSortedHashTable.js'),
   Docker: require('./Docker.js'),
   DynamoDBGlobalSecondaryIndex: require('./DynamoDBGlobalSecondaryIndex.js'),
   DynamoDBStream: require('./DynamoDBStream.js'),

package/internal/RetryAwsErrors.test.js

@@ -1,4 +1,4 @@
-const Test = require('./thunk-test')
+const Test = require('thunk-test')
 const RetryAwsErrors = require('./RetryAwsErrors')
 
 // TODO

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "presidium",
-  "version": "3.4.8",
+  "version": "3.6.0",
   "description": "A library for creating web services",
   "author": "Richard Tong",
-  "license": "MIT",
+  "license": "CFOSS",
   "main": "index.js",
   "repository": {
     "type": "git",
@@ -13,6 +13,8 @@
   "files": [
     "internal",
     "AwsCredentials.js",
+    "DiskHashTable.js",
+    "DiskSortedHashTable.js",
     "Docker.js",
     "DynamoDBGlobalSecondaryIndex.js",
     "DynamoDBStream.js",
@@ -62,7 +64,8 @@
   "dependencies": {
     "extract-zip": "^2.0.1",
     "html-entities": "^2.6.0",
-    "presidium-websocket": ">=2.0.1",
+    "presidium-db": ">=3.10.0",
+    "presidium-websocket": ">=3.2.1",
     "rubico": "^2.7.7",
     "tar-stream": "^3.1.7"
   },