presidium 0.21.0 → 0.21.1

package/S3.js

@@ -157,6 +157,64 @@ S3.prototype.putObject = function s3PutObject(bucketname, key, body, options) {
   }).promise()
 }
 
+/**
+ * @name S3.prototype.upload
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * S3(options).upload(
+ *   key string,
+ *   body Buffer|TypedArray|Blob|String|ReadableStream,
+ *   options? {
+ *     ACL: 'private'|'public-read'|'public-read-write'|'authenticated-read'|'aws-exec-read'|'bucket-owner-read'|'bucket-owner-full-control'
+ *     CacheControl?: string,
+ *     ContentDisposition?: string,
+ *     ContentEncoding?: string,
+ *     ContentLanguage?: string,
+ *     ContentLength?: string,
+ *     ContentMD5?: string,
+ *     ContentType?: string,
+ *     ExpectedBucketOwner?: string,
+ *     Expires?: Date|Date.toString()|number,
+ *     GrantFullControl?: string,
+ *     GrantRead?: string,
+ *     GrantReadACP?: string,
+ *     GrantWriteACP?: string,
+ *     Metadata?: Object<string>,
+ *     ObjectLockLegalHoldStatus?: 'ON'|'OFF',
+ *     ObjectLockMode?: 'GOVERNANCE'|'COMPLIANCE',
+ *     ObjectLockRetainUntilDate?: Date|Date.toString()|number,
+ *     RequestPayer?: requester,
+ *     SSECustomerAlgorithm?: string,
+ *     SSECustomerKey?: string|Buffer,
+ *     SSECustomerKeyMD5?: string,
+ *     SSEKMSEncryptionContext?: string,
+ *     SSEKMSKeyId?: string,
+ *     ServerSideEncryption?: 'AES256'|'aws:kms',
+ *     StorageClass?: 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'
+ *     Tagging?: string,
+ *     WebsiteRedirectLocation?: string,
+ *   },
+ * ) -> Promise<{
+ *   ETag: string,
+ *   ServerSideEncryption?: 'AES256'|'aws:kms',
+ *   VersionId: string,
+ *   SSECustomerAlgorithm?: string,
+ *   SSECustomerKey?: string,
+ *   SSEKMSKeyId?: string,
+ *   SSEKMSEncryptionContext?: string,
+ *   RequestCharged?: string,
+ * }>
+ * ```
+ */
+S3.prototype.upload = function upload(bucketname, key, body, options) {
+  return this.s3.upload({
+    Bucket: bucketname,
+    Key: key,
+    Body: body,
+  }).promise()
+}
+
 /**
  * @name S3.prototype.deleteObject
  *

package/S3Bucket.js

@@ -95,6 +95,62 @@ S3Bucket.prototype.putObject = async function s3BucketPutObject(
   return this.s3.putObject(this.name, key, body, options)
 }
 
+/**
+ * @name S3Bucket.prototype.upload
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * S3Bucket(s3).upload(
+ *   key string,
+ *   body string|Buffer|ReadableStream,
+ *   options? {
+ *     ACL: 'private'|'public-read'|'public-read-write'|'authenticated-read'|'aws-exec-read'|'bucket-owner-read'|'bucket-owner-full-control'
+ *     CacheControl?: string,
+ *     ContentDisposition?: string,
+ *     ContentEncoding?: string,
+ *     ContentLanguage?: string,
+ *     ContentLength?: string,
+ *     ContentMD5?: string,
+ *     ContentType?: string,
+ *     ExpectedBucketOwner?: string,
+ *     Expires?: Date|Date.toString()|number,
+ *     GrantFullControl?: string,
+ *     GrantRead?: string,
+ *     GrantReadACP?: string,
+ *     GrantWriteACP?: string,
+ *     Metadata?: Object<string>,
+ *     ObjectLockLegalHoldStatus?: 'ON'|'OFF',
+ *     ObjectLockMode?: 'GOVERNANCE'|'COMPLIANCE',
+ *     ObjectLockRetainUntilDate?: Date|Date.toString()|number,
+ *     RequestPayer?: requester,
+ *     SSECustomerAlgorithm?: string,
+ *     SSECustomerKey?: string|Buffer,
+ *     SSECustomerKeyMD5?: string,
+ *     SSEKMSEncryptionContext?: string,
+ *     SSEKMSKeyId?: string,
+ *     ServerSideEncryption?: 'AES256'|'aws:kms',
+ *     StorageClass?: 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'
+ *     Tagging?: string,
+ *     WebsiteRedirectLocation?: string,
+ *   },
+ * ) -> Promise<{
+ *   ETag: string,
+ *   ServerSideEncryption?: 'AES256'|'aws:kms',
+ *   VersionId: string,
+ *   SSECustomerAlgorithm?: string,
+ *   SSECustomerKey?: string,
+ *   SSEKMSKeyId?: string,
+ *   SSEKMSEncryptionContext?: string,
+ *   RequestCharged?: string,
+ * }>
+ * ```
+ */
+S3Bucket.prototype.upload = async function upload(key, body, options) {
+  await this.ready
+  return this.s3.upload(this.name, key, body, options)
+}
+
+
 /**
  * @name S3Bucket.prototype.deleteObject
  *

package/S3Bucket.test.js

@@ -61,6 +61,11 @@ const test = new Test('S3Bucket', S3Bucket)
   assert(binary.ContentType == 'application/octet-stream')
   assert.deepEqual(binary.Body, Buffer.from('binary'))
 
+  const res = await testBucket.upload('buffer', Buffer.from('buffer'))
+  const buffer = await testBucket.getObject('buffer')
+  assert(buffer.ContentType == 'application/octet-stream')
+  assert.deepEqual(buffer.Body, Buffer.from('buffer'))
+
   await testBucket.deleteAllObjects({ MaxKeys: 1 })
   const deleted = await testBucket.delete()
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "0.21.0",
+  "version": "0.21.1",
   "description": "A library for creating web services",
   "author": "Richard Tong",
   "license": "MIT",