@pi-r/aws-lib 0.6.0 → 0.6.1

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBucketKey = exports.checkBucketCannedACL = exports.setDatabaseEndpoint = exports.setEndpoint = exports.getPrivatePolicy = exports.getBucketPublicReadPolicy = exports.getPublicReadPolicy = exports.isDatabaseDefined = exports.isProviderChainDefined = exports.isSharedCredentialsDefined = exports.isEnvDefined = exports.isAccessDefined = void 0;
+exports.getBucketKey = exports.formatDefaultRetention = exports.checkBucketCannedACL = exports.setDatabaseEndpoint = exports.setEndpoint = exports.getPrivatePolicy = exports.getBucketPublicReadPolicy = exports.getPublicReadPolicy = exports.isDatabaseDefined = exports.isProviderChainDefined = exports.isSharedCredentialsDefined = exports.isEnvDefined = exports.isAccessDefined = void 0;
 const types_1 = require("@e-mc/types");
 function isAccessDefined(credential) {
     return !!(credential.accessKeyId && credential.secretAccessKey);
@@ -96,5 +96,20 @@ function checkBucketCannedACL(value) {
     }
 }
 exports.checkBucketCannedACL = checkBucketCannedACL;
+function formatDefaultRetention(retention) {
+    const { Years = 0, Days = 0, Mode } = retention;
+    const status = [];
+    if (Years > 0) {
+        status.push(Years.toString() + 'Y');
+    }
+    if (Days > 0) {
+        status.push(Days.toString() + 'D');
+    }
+    if (Mode) {
+        status.push(status.length ? `(${Mode})` : Mode);
+    }
+    return status.join(' ');
+}
+exports.formatDefaultRetention = formatDefaultRetention;
 const getBucketKey = (credential, bucket, acl, service, sdk) => JSON.stringify(credential) + bucket + '_' + (acl || '') + service + sdk;
 exports.getBucketKey = getBucketKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/aws-lib",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "AWS cloud utility functions for E-mc.",
   "main": "index.js",
   "types": "types/index.d.ts",

package/types/index.d.ts

@@ -1,5 +1,3 @@
-import type { CloudDatabase } from '@e-mc/types/lib/cloud';
-
 declare namespace AWS {
     type BucketCannedACL = "authenticated-read" | "private" | "public-read" | "public-read-write";
     type ObjectCannedACL = BucketCannedACL | "bucket-owner-full-control" | "bucket-owner-read";
@@ -65,18 +63,42 @@ declare namespace AWS {
         protocol: string;
     }
 
+    interface DefaultRetention {
+        /**
+         * @public
+         * <p>The default Object Lock retention mode you want to apply to new objects placed in the
+         *          specified bucket. Must be used with either <code>Days</code> or <code>Years</code>.</p>
+         */
+        Mode?: ObjectLockRetentionMode;
+        /**
+         * @public
+         * <p>The number of days that you want to specify for the default retention period. Must be
+         *          used with <code>Mode</code>.</p>
+         */
+        Days?: number;
+        /**
+         * @public
+         * <p>The number of years that you want to specify for the default retention period. Must be
+         *          used with <code>Mode</code>.</p>
+         */
+        Years?: number;
+    }
+
     type Provider<T> = () => Promise<T>;
+    type ObjectLockRetentionMode = "GOVERNANCE" | "COMPLIANCE" | string; // eslint-disable-line @typescript-eslint/no-redundant-type-constituents
 
     function isAccessDefined(credential: AccessConfig): boolean;
     function isEnvDefined(): boolean;
     function isSharedCredentialsDefined(): boolean;
     function isProviderChainDefined(): boolean;
-    function isDatabaseDefined(credential: unknown, data: CloudDatabase): boolean;
+    function isDatabaseDefined(credential: unknown, data: unknown): boolean;
     function getPublicReadPolicy(bucket: string, authenticated?: boolean, write?: boolean): string;
     function getBucketPublicReadPolicy(bucket: string): string;
     function getPrivatePolicy(bucket: string): string;
     function setDatabaseEndpoint(config: EndpointConfig, fallbackRegion?: string): void;
     function setEndpoint(config: EndpointConfig, instance: string, fallbackRegion?: string): void;
+    function checkBucketCannedACL(value: unknown): Undef<BucketCannedACL>;
+    function formatDefaultRetention(retention: DefaultRetention): string;
     function getBucketKey(credential: unknown, bucket: string, acl: string | undefined, service: string, sdk: string): string;
 }