feat: worm

README.md

@@ -111,6 +111,12 @@ All operation use es7 async/await to implement. All api is async function.
   - versioning
     - [.getBucketVersioning(name, [, options])](#getBucketVersioningname-options)
     - [.putBucketVersioning(name, status[, options])](#putBucketVersioningname-status-options)
+  - worm
+    - [.abortBucketWorm(name[, options])](#abortBucketWormname-options)
+    - [.completeBucketWorm(name, wormId[, options])](#completeBucketWormname-wormId-options)
+    - [.extendBucketWorm(name, wormId, days[, options])](#extendBucketWormname-wormId-days-options)
+    - [.getBucketWorm(name[, options])](#getBucketWormname-options)
+    - [.initiateBucketWorm(name, days[, options])](#initiateBucketWormname-days-options)
 
 - [Object Operations](#object-operations)
   - [.list(query[, options])](#listquery-options)
@@ -1259,6 +1265,95 @@ Success will return:
 
 ---
 
+### .abortBucketWorm(name[, options])
+
+used to delete an unlocked retention policy.
+
+parameters:
+
+- name {String} the bucket name
+- [options] {Object} optional args
+
+Success will return:
+
+- status {Number} response status
+- res {Object} response info
+
+---
+
+### .completeBucketWorm(name, wormId[, options])
+
+used to lock a retention policy.
+
+parameters:
+
+- name {String} the bucket name
+- wormId {String} worm id
+- [options] {Object} optional args
+
+Success will return:
+
+- status {Number} response status
+- res {Object} response info
+
+---
+
+### .extendBucketWorm(name, wormId, days[, options])
+
+ used to extend the retention period of objects in a bucket whose retention policy is locked.
+
+parameters:
+
+- name {String} the bucket name
+- wormId {String} worm id
+- days {String | Number} retention days
+- [options] {Object} optional args
+
+Success will return:
+
+- status {Number} response status
+- res {Object} response info
+
+---
+
+### .getBucketWorm(name[, options])
+
+ used to query the retention policy information of the specified bucket.
+
+parameters:
+
+- name {String} the bucket name
+- [options] {Object} optional args
+
+Success will return:
+
+- wormId {String} worm id
+- state {String} `Locked` or `InProgress`
+- days {String} retention days
+- creationDate {String}
+- status {Number} response status
+- res {Object} response info
+
+---
+
+### .initiateBucketWorm(name, days[, options])
+
+create a retention policy.
+
+parameters:
+
+- name {String} the bucket name
+- days {String | Number}} set retention days
+- [options] {Object} optional args
+
+Success will return:
+
+- wormId {String} worm id
+- status {Number} response status
+- res {Object} response info
+
+---
+
 ## Object Operations
 
 All operations function return Promise, except `signatureUrl`.

lib/browser/client.js

@@ -104,6 +104,12 @@ merge(proto, require('../common/bucket/deleteBucketLifecycle'));
 // multiversion
 merge(proto, require('../common/bucket/putBucketVersioning'));
 merge(proto, require('../common/bucket/getBucketVersioning'));
+// worm
+merge(proto, require('../common/bucket/abortBucketWorm'));
+merge(proto, require('../common/bucket/completeBucketWorm'));
+merge(proto, require('../common/bucket/extendBucketWorm'));
+merge(proto, require('../common/bucket/getBucketWorm'));
+merge(proto, require('../common/bucket/initiateBucketWorm'));
 
 // multipart upload
 merge(proto, require('./managed-upload'));

lib/common/bucket/abortBucketWorm.d.ts

@@ -0,0 +1,4 @@
+export declare function abortBucketWorm(this: any, name: string, options: any): Promise<{
+    res: any;
+    status: any;
+}>;

lib/common/bucket/abortBucketWorm.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.abortBucketWorm = void 0;
+const checkBucketName_1 = require("../utils/checkBucketName");
+async function abortBucketWorm(name, options) {
+    checkBucketName_1.checkBucketName(name);
+    const params = this._bucketRequestParams('DELETE', name, 'worm', options);
+    const result = await this.request(params);
+    return {
+        res: result.res,
+        status: result.status
+    };
+}
+exports.abortBucketWorm = abortBucketWorm;

lib/common/bucket/abortBucketWorm.ts

@@ -0,0 +1,12 @@
+import { checkBucketName } from '../utils/checkBucketName';
+
+export async function abortBucketWorm(this: any, name: string, options) {
+  checkBucketName(name);
+  const params = this._bucketRequestParams('DELETE', name, 'worm', options);
+
+  const result = await this.request(params);
+  return {
+    res: result.res,
+    status: result.status
+  };
+}

lib/common/bucket/completeBucketWorm.d.ts

@@ -0,0 +1,4 @@
+export declare function completeBucketWorm(this: any, name: string, wormId: string, options: any): Promise<{
+    res: any;
+    status: any;
+}>;

lib/common/bucket/completeBucketWorm.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.completeBucketWorm = void 0;
+const checkBucketName_1 = require("../utils/checkBucketName");
+async function completeBucketWorm(name, wormId, options) {
+    checkBucketName_1.checkBucketName(name);
+    const params = this._bucketRequestParams('POST', name, { wormId }, options);
+    const result = await this.request(params);
+    return {
+        res: result.res,
+        status: result.status
+    };
+}
+exports.completeBucketWorm = completeBucketWorm;

lib/common/bucket/completeBucketWorm.ts

@@ -0,0 +1,12 @@
+import { checkBucketName } from '../utils/checkBucketName';
+
+export async function completeBucketWorm(this: any, name: string, wormId: string, options) {
+  checkBucketName(name);
+  const params = this._bucketRequestParams('POST', name, { wormId }, options);
+
+  const result = await this.request(params);
+  return {
+    res: result.res,
+    status: result.status
+  };
+}

lib/common/bucket/extendBucketWorm.d.ts

@@ -0,0 +1,4 @@
+export declare function extendBucketWorm(this: any, name: string, wormId: string, days: string, options: any): Promise<{
+    res: any;
+    status: any;
+}>;

lib/common/bucket/extendBucketWorm.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extendBucketWorm = void 0;
+const checkBucketName_1 = require("../utils/checkBucketName");
+const obj2xml_1 = require("../utils/obj2xml");
+async function extendBucketWorm(name, wormId, days, options) {
+    checkBucketName_1.checkBucketName(name);
+    const params = this._bucketRequestParams('POST', name, { wormExtend: '', wormId }, options);
+    const paramlXMLObJ = {
+        ExtendWormConfiguration: {
+            RetentionPeriodInDays: days
+        }
+    };
+    params.mime = 'xml';
+    params.content = obj2xml_1.obj2xml(paramlXMLObJ, { headers: true });
+    params.successStatuses = [200];
+    const result = await this.request(params);
+    return {
+        res: result.res,
+        status: result.status
+    };
+}
+exports.extendBucketWorm = extendBucketWorm;

lib/common/bucket/extendBucketWorm.ts

@@ -0,0 +1,21 @@
+import { checkBucketName } from '../utils/checkBucketName';
+import { obj2xml } from '../utils/obj2xml';
+
+export async function extendBucketWorm(this: any, name: string, wormId: string, days: string | number, options) {
+  checkBucketName(name);
+  const params = this._bucketRequestParams('POST', name, { wormExtend: '', wormId }, options);
+  const paramlXMLObJ = {
+    ExtendWormConfiguration: {
+      RetentionPeriodInDays: days
+    }
+  };
+
+  params.mime = 'xml';
+  params.content = obj2xml(paramlXMLObJ, { headers: true });
+  params.successStatuses = [200];
+  const result = await this.request(params);
+  return {
+    res: result.res,
+    status: result.status
+  };
+}

lib/common/bucket/getBucketWorm.d.ts

@@ -0,0 +1 @@
+export declare function getBucketWorm(this: any, name: string, options: any): Promise<any>;

lib/common/bucket/getBucketWorm.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBucketWorm = void 0;
+const checkBucketName_1 = require("../utils/checkBucketName");
+const dataFix_1 = require("../utils/dataFix");
+async function getBucketWorm(name, options) {
+    checkBucketName_1.checkBucketName(name);
+    const params = this._bucketRequestParams('GET', name, 'worm', options);
+    params.successStatuses = [200];
+    params.xmlResponse = true;
+    const result = await this.request(params);
+    dataFix_1.dataFix(result.data, {
+        lowerFirst: true,
+        rename: {
+            RetentionPeriodInDays: 'days'
+        }
+    });
+    return Object.assign(Object.assign({}, result.data), { res: result.res, status: result.status });
+}
+exports.getBucketWorm = getBucketWorm;

lib/common/bucket/getBucketWorm.ts

@@ -0,0 +1,22 @@
+import { checkBucketName } from '../utils/checkBucketName';
+import { dataFix } from '../utils/dataFix';
+
+export async function getBucketWorm(this: any, name: string, options) {
+  checkBucketName(name);
+  const params = this._bucketRequestParams('GET', name, 'worm', options);
+  params.successStatuses = [200];
+  params.xmlResponse = true;
+
+  const result = await this.request(params);
+  dataFix(result.data, {
+    lowerFirst: true,
+    rename: {
+      RetentionPeriodInDays: 'days'
+    }
+  });
+  return {
+    ...result.data,
+    res: result.res,
+    status: result.status
+  };
+}

lib/common/bucket/index.js

@@ -22,3 +22,8 @@ merge(proto, require('./putBucketPolicy'));
 merge(proto, require('./deleteBucketPolicy'));
 merge(proto, require('./getBucketVersioning'));
 merge(proto, require('./putBucketVersioning'));
+merge(proto, require('./abortBucketWorm'));
+merge(proto, require('./completeBucketWorm'));
+merge(proto, require('./extendBucketWorm'));
+merge(proto, require('./getBucketWorm'));
+merge(proto, require('./initiateBucketWorm'));

lib/common/bucket/initiateBucketWorm.d.ts

@@ -0,0 +1,5 @@
+export declare function initiateBucketWorm(this: any, name: string, days: string, options: any): Promise<{
+    res: any;
+    wormId: any;
+    status: any;
+}>;

lib/common/bucket/initiateBucketWorm.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initiateBucketWorm = void 0;
+const obj2xml_1 = require("../utils/obj2xml");
+const checkBucketName_1 = require("../utils/checkBucketName");
+async function initiateBucketWorm(name, days, options) {
+    checkBucketName_1.checkBucketName(name);
+    const params = this._bucketRequestParams('POST', name, 'worm', options);
+    const paramlXMLObJ = {
+        InitiateWormConfiguration: {
+            RetentionPeriodInDays: days
+        }
+    };
+    params.mime = 'xml';
+    params.content = obj2xml_1.obj2xml(paramlXMLObJ, { headers: true });
+    params.successStatuses = [200];
+    const result = await this.request(params);
+    return {
+        res: result.res,
+        wormId: result.res.headers['x-oss-worm-id'],
+        status: result.status
+    };
+}
+exports.initiateBucketWorm = initiateBucketWorm;

lib/common/bucket/initiateBucketWorm.ts

@@ -0,0 +1,28 @@
+import { obj2xml } from '../utils/obj2xml';
+import { checkBucketName } from '../utils/checkBucketName';
+
+export async function initiateBucketWorm(
+  this: any,
+  name: string,
+  days: string,
+  options
+) {
+  checkBucketName(name);
+  const params = this._bucketRequestParams('POST', name, 'worm', options);
+  const paramlXMLObJ = {
+    InitiateWormConfiguration: {
+      RetentionPeriodInDays: days
+    }
+  };
+
+  params.mime = 'xml';
+  params.content = obj2xml(paramlXMLObJ, { headers: true });
+  params.successStatuses = [200];
+
+  const result = await this.request(params);
+  return {
+    res: result.res,
+    wormId: result.res.headers['x-oss-worm-id'],
+    status: result.status
+  };
+}

lib/common/utils/checkBucketName.d.ts

@@ -1 +1 @@
-export declare const checkBucketName: (name: string, createBucket: boolean) => void;
+export declare const checkBucketName: (name: string, createBucket?: boolean) => void;

lib/common/utils/checkBucketName.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkBucketName = void 0;
-exports.checkBucketName = (name, createBucket) => {
+exports.checkBucketName = (name, createBucket = false) => {
     const bucketRegex = createBucket ? /^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$/ : /^[a-z0-9_][a-z0-9-_]{1,61}[a-z0-9_]$/;
     if (!bucketRegex.test(name)) {
         throw new Error('The bucket must be conform to the specifications');

lib/common/utils/checkBucketName.ts

@@ -1,4 +1,4 @@
-export const checkBucketName = (name: string, createBucket: boolean): void => {
+export const checkBucketName = (name: string, createBucket = false): void => {
   const bucketRegex = createBucket ? /^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$/ : /^[a-z0-9_][a-z0-9-_]{1,61}[a-z0-9_]$/;
   if (!bucketRegex.test(name)) {
     throw new Error('The bucket must be conform to the specifications');

lib/common/utils/dataFix.d.ts

@@ -0,0 +1,12 @@
+interface Rename {
+    [propName: string]: string;
+}
+interface Config {
+    lowerFirst?: boolean;
+    rename?: Rename;
+    remove?: string[];
+    camel?: string[];
+    bool?: string[];
+}
+export declare function dataFix(o: object, conf: Config, finalKill?: Function): typeof dataFix | undefined;
+export {};