feat: add typescript support (#814)

* feat: add ts * feat: add cjs * feat: add cjs * feat: add cjs * feat: add cjs * feat: add cjs * feat: add cjs * feat: add cjs * refactor: checkBucketName * refactor: common/utils with ts * refactor: createRequest with ts * feat: add es2017 Co-authored-by: weiyie <912881342@qq.com>
ali-sdk · Jun 12, 2020 · 8ef7528 · 8ef7528
1 parent ae22ad1
commit 8ef7528
Show file tree

Hide file tree

Showing 103 changed files with 1,000 additions and 381 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -13,4 +13,6 @@ test/browser/build
 test/benchmark/
 test/fixtures/
 task/
-browser-build.js
+browser-build.js
+es
+cjs
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,6 +1,6 @@
 /* eslint max-len: [0] */
 module.exports = {
-  extends: 'airbnb',
+  extends: ['airbnb', 'eslint-config-ali/typescript'],
   parserOptions: {
     ecmaFeatures: {
       experimentalObjectRestSpread: true,
@@ -30,5 +30,6 @@ module.exports = {
     }],
     'no-buffer-constructor': [2],
     "comma-dangle": [2, "never"],
+    'import/prefer-default-export': [0],
   }
 };
diff --git a/.gitignore b/.gitignore
@@ -41,3 +41,5 @@ package-lock.json
 .DS_Store
 /example/node_modules/
 /example/public/index.js
+
+es
diff --git a/lib/browser/bucket.js b/lib/browser/bucket.js
@@ -1,6 +1,6 @@
 
 const assert = require('assert');
-const _checkBucketName = require('../common/utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../common/utils/checkBucketName');
 
 const proto = exports;
 

diff --git a/lib/browser/client.js b/lib/browser/client.js
@@ -11,9 +11,9 @@ const urllib = require('urllib');
 const pkg = require('./version');
 const bowser = require('bowser');
 const signUtils = require('../common/signUtils');
-const _isIP = require('../common/utils/isIP');
+const { isIP: _isIP } = require('../common/utils/isIP');
 const _initOptions = require('../common/client/initOptions');
-const createRequest = require('../common/utils/createRequest');
+const { createRequest } = require('../common/utils/createRequest');
 
 const globalHttpAgent = new AgentKeepalive();
 

diff --git a/lib/browser/managed-upload.js b/lib/browser/managed-upload.js
@@ -6,8 +6,8 @@ const util = require('util');
 const path = require('path');
 const mime = require('mime');
 const copy = require('copy-to');
-const isBlob = require('../common/utils/isBlob');
-const isFile = require('../common/utils/isFile');
+const { isBlob } = require('../common/utils/isBlob');
+const { isFile } = require('../common/utils/isFile');
 
 const proto = exports;
 
@@ -131,6 +131,7 @@ proto._resumeMultipart = async function _resumeMultipart(checkpoint, options) {
   let multipartFinish = false;
 
   let uploadPartJob = function uploadPartJob(self, partNo) {
+    // eslint-disable-next-line no-async-promise-executor
     return new Promise(async (resolve, reject) => {
       try {
         if (!self.isCancel()) {

diff --git a/lib/browser/object.js b/lib/browser/object.js
@@ -10,8 +10,8 @@ const mime = require('mime');
 const callback = require('../common/callback');
 const signHelper = require('../common/signUtils');
 const merge = require('merge-descriptors');
-const isBlob = require('../common/utils/isBlob');
-const isFile = require('../common/utils/isFile');
+const { isBlob } = require('../common/utils/isBlob');
+const { isFile } = require('../common/utils/isFile');
 
 // var assert = require('assert');
 

diff --git a/lib/bucket.js b/lib/bucket.js
@@ -1,8 +1,8 @@
 
 
 const assert = require('assert');
-const isArray = require('./common/utils/isArray');
-const _checkBucketName = require('../lib/common/utils/checkBucketName');
+const { isArray } = require('./common/utils/isArray');
+const { checkBucketName: _checkBucketName } = require('../lib/common/utils/checkBucketName');
 
 const proto = exports;
 

diff --git a/lib/client.js b/lib/client.js
@@ -14,9 +14,9 @@ const urllib = require('urllib');
 const pkg = require('../package.json');
 const bowser = require('bowser');
 const signUtils = require('./common/signUtils');
-const _isIP = require('./common/utils/isIP');
+const { isIP: _isIP } = require('./common/utils/isIP');
 const _initOptions = require('./common/client/initOptions');
-const createRequest = require('./common/utils/createRequest');
+const { createRequest } = require('./common/utils/createRequest');
 
 const globalHttpAgent = new AgentKeepalive();
 const globalHttpsAgent = new HttpsAgentKeepalive();

diff --git a/lib/common/bucket/deleteBucketEncryption.js b/lib/common/bucket/deleteBucketEncryption.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 // const jstoxml = require('jstoxml');

diff --git a/lib/common/bucket/deleteBucketLifecycle.js b/lib/common/bucket/deleteBucketLifecycle.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 

diff --git a/lib/common/bucket/deleteBucketPolicy.js b/lib/common/bucket/deleteBucketPolicy.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/deleteBucketTags.js b/lib/common/bucket/deleteBucketTags.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/deleteBucketWebsite.js b/lib/common/bucket/deleteBucketWebsite.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 

diff --git a/lib/common/bucket/getBucketEncryption.js b/lib/common/bucket/getBucketEncryption.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/getBucketLifecycle.js b/lib/common/bucket/getBucketLifecycle.js
@@ -1,6 +1,6 @@
-const _checkBucketName = require('../utils/checkBucketName');
-const isArray = require('../utils/isArray');
-const formatObjKey = require('../utils/formatObjKey');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { isArray } = require('../utils/isArray');
+const { formatObjKey } = require('../utils/formatObjKey');
 
 const proto = exports;
 

diff --git a/lib/common/bucket/getBucketPolicy.js b/lib/common/bucket/getBucketPolicy.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/getBucketRequestPayment.js b/lib/common/bucket/getBucketRequestPayment.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/getBucketTags.js b/lib/common/bucket/getBucketTags.js
@@ -1,6 +1,6 @@
 const proto = exports;
-const _checkBucketName = require('../utils/checkBucketName');
-const isObject = require('../utils/isObject');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { isObject } = require('../utils/isObject');
 /**
  * getBucketTags
  * @param {String} name - bucket name

diff --git a/lib/common/bucket/getBucketVersioning.js b/lib/common/bucket/getBucketVersioning.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/getBucketWebsite.js b/lib/common/bucket/getBucketWebsite.js
@@ -1,5 +1,5 @@
-const _checkBucketName = require('../utils/checkBucketName');
-const isObject = require('../utils/isObject');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { isObject } = require('../utils/isObject');
 
 const proto = exports;
 

diff --git a/lib/common/bucket/putBucket.js b/lib/common/bucket/putBucket.js
@@ -1,6 +1,6 @@
 const proto = exports;
-const _checkBucketName = require('../utils/checkBucketName');
-const obj2xml = require('../utils/obj2xml');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { obj2xml } = require('../utils/obj2xml');
 
 proto.putBucket = async function putBucket(name, options) {
   _checkBucketName(name, true);

diff --git a/lib/common/bucket/putBucketEncryption.js b/lib/common/bucket/putBucketEncryption.js
@@ -1,7 +1,7 @@
 const proto = exports;
 // const jstoxml = require('jstoxml');
-const _checkBucketName = require('../utils/checkBucketName');
-const obj2xml = require('../utils/obj2xml');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { obj2xml } = require('../utils/obj2xml');
 /**
  * putBucketEncryption
  * @param {String} bucketName - bucket name

diff --git a/lib/common/bucket/putBucketLifecycle.js b/lib/common/bucket/putBucketLifecycle.js
@@ -1,11 +1,11 @@
 /* eslint-disable no-use-before-define */
-const _checkBucketName = require('../utils/checkBucketName');
-const isArray = require('../utils/isArray');
-const deepCopy = require('../utils/deepCopy');
-const isObject = require('../utils/isObject');
-const obj2xml = require('../utils/obj2xml');
-const checkObjectTag = require('../utils/checkObjectTag');
-const getStrBytesCount = require('../utils/getStrBytesCount');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { isArray } = require('../utils/isArray');
+const { deepCopy } = require('../utils/deepCopy');
+const { isObject } = require('../utils/isObject');
+const { obj2xml } = require('../utils/obj2xml');
+const { checkObjectTag } = require('../utils/checkObjectTag');
+const { getStrBytesCount } = require('../utils/getStrBytesCount');
 
 const proto = exports;
 

diff --git a/lib/common/bucket/putBucketPolicy.js b/lib/common/bucket/putBucketPolicy.js
@@ -1,6 +1,6 @@
-const _checkBucketName = require('../utils/checkBucketName');
-const policy2Str = require('../utils/policy2Str');
-const isObject = require('../utils/isObject');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { policy2Str } = require('../utils/policy2Str');
+const { isObject } = require('../utils/isObject');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/putBucketRequestPayment.js b/lib/common/bucket/putBucketRequestPayment.js
@@ -1,5 +1,5 @@
-const _checkBucketName = require('../utils/checkBucketName');
-const obj2xml = require('../utils/obj2xml');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { obj2xml } = require('../utils/obj2xml');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/putBucketTags.js b/lib/common/bucket/putBucketTags.js
@@ -1,6 +1,6 @@
-const _checkBucketName = require('../utils/checkBucketName');
-const obj2xml = require('../utils/obj2xml');
-const checkTag = require('../utils/checkBucketTag');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { obj2xml } = require('../utils/obj2xml');
+const { checkBucketTag } = require('../utils/checkBucketTag');
 
 const proto = exports;
 /**
@@ -12,7 +12,7 @@ const proto = exports;
 
 proto.putBucketTags = async function putBucketTags(name, tag, options = {}) {
   _checkBucketName(name);
-  checkTag(tag);
+  checkBucketTag(tag);
   const params = this._bucketRequestParams('PUT', name, 'tagging', options);
   params.successStatuses = [200];
   tag = Object.keys(tag).map(key => ({

diff --git a/lib/common/bucket/putBucketVersioning.js b/lib/common/bucket/putBucketVersioning.js
@@ -1,5 +1,5 @@
-const _checkBucketName = require('../utils/checkBucketName');
-const obj2xml = require('../utils/obj2xml');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { obj2xml } = require('../utils/obj2xml');
 
 const proto = exports;
 /**

diff --git a/lib/common/bucket/putBucketWebsite.js b/lib/common/bucket/putBucketWebsite.js
@@ -1,6 +1,6 @@
-const _checkBucketName = require('../utils/checkBucketName');
-const obj2xml = require('../utils/obj2xml');
-const isArray = require('../utils/isArray');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
+const { obj2xml } = require('../utils/obj2xml');
+const { isArray } = require('../utils/isArray');
 
 const proto = exports;
 proto.putBucketWebsite = async function putBucketWebsite(name, config = {}, options) {

diff --git a/lib/common/client/initOptions.js b/lib/common/client/initOptions.js
@@ -1,6 +1,6 @@
 const ms = require('humanize-ms');
 const urlutil = require('url');
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 function setEndpoint(endpoint, secure) {
   let url = urlutil.parse(endpoint);

diff --git a/lib/common/image/processObjectSave.js b/lib/common/image/processObjectSave.js
@@ -1,5 +1,5 @@
 /* eslint-disable no-use-before-define */
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 const querystring = require('querystring');
 const { Base64: { encode: str2Base64 } } = require('js-base64');
 

diff --git a/lib/common/multipart.js b/lib/common/multipart.js
@@ -1,7 +1,7 @@
 
 const copy = require('copy-to');
 const callback = require('./callback');
-const deepCopy = require('./utils/deepCopy');
+const { deepCopy } = require('./utils/deepCopy');
 
 const proto = exports;
 

diff --git a/lib/common/object/calculatePostSignature.js b/lib/common/object/calculatePostSignature.js
@@ -1,7 +1,7 @@
 
-const policy2Str = require('../utils/policy2Str');
+const { policy2Str } = require('../utils/policy2Str');
 const signHelper = require('../signUtils');
-const isObject = require('../utils/isObject');
+const { isObject } = require('../utils/isObject');
 
 const proto = exports;
 

diff --git a/lib/common/object/copyObject.js b/lib/common/object/copyObject.js
@@ -1,4 +1,4 @@
-const _checkBucketName = require('../utils/checkBucketName');
+const { checkBucketName: _checkBucketName } = require('../utils/checkBucketName');
 
 const proto = exports;
 

diff --git a/lib/common/object/deleteMulti.js b/lib/common/object/deleteMulti.js
@@ -1,6 +1,6 @@
 /* eslint-disable object-curly-newline */
 const utility = require('utility');
-const obj2xml = require('../utils/obj2xml');
+const { obj2xml } = require('../utils/obj2xml');
 
 const proto = exports;
 

diff --git a/lib/common/object/getBucketVersions.js b/lib/common/object/getBucketVersions.js
@@ -1,7 +1,7 @@
 /* eslint-disable no-use-before-define */
 const proto = exports;
-const isObject = require('../utils/isObject');
-const isArray = require('../utils/isArray');
+const { isObject } = require('../utils/isObject');
+const { isArray } = require('../utils/isArray');
 
 
 proto.getBucketVersions = getBucketVersions;

diff --git a/lib/common/object/getObjectTagging.js b/lib/common/object/getObjectTagging.js
@@ -1,5 +1,5 @@
 const proto = exports;
-const isObject = require('../utils/isObject');
+const { isObject } = require('../utils/isObject');
 /**
  * getObjectTagging
  * @param {String} name - object name

diff --git a/lib/common/object/putObjectTagging.js b/lib/common/object/putObjectTagging.js
@@ -1,5 +1,5 @@
-const obj2xml = require('../utils/obj2xml');
-const checkTag = require('../utils/checkObjectTag');
+const { obj2xml } = require('../utils/obj2xml');
+const { checkObjectTag } = require('../utils/checkObjectTag');
 
 const proto = exports;
 /**
@@ -10,7 +10,7 @@ const proto = exports;
  */
 
 proto.putObjectTagging = async function putObjectTagging(name, tag, options = {}) {
-  checkTag(tag);
+  checkObjectTag(tag);
 
   options.subres = Object.assign({ tagging: '' }, options.subres);
   if (options.versionId) {

diff --git a/lib/common/utils/checkBucketName.d.ts b/lib/common/utils/checkBucketName.d.ts
@@ -0,0 +1 @@
+export declare const checkBucketName: (name: string, createBucket: boolean) => void;
diff --git a/lib/common/utils/checkBucketName.js b/lib/common/utils/checkBucketName.js
@@ -1,10 +1,9 @@
-/**
- * check Bucket Name
- */
-
-module.exports = function (name, createBucket) {
-  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');
-  }
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkBucketName = void 0;
+exports.checkBucketName = (name, createBucket) => {
+    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');
+    }
 };
diff --git a/lib/common/utils/checkBucketName.ts b/lib/common/utils/checkBucketName.ts
@@ -0,0 +1,7 @@
+export const checkBucketName = (name: string, createBucket: boolean): 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');
+  }
+};
+
diff --git a/lib/common/utils/checkBucketNameTest.d.ts b/lib/common/utils/checkBucketNameTest.d.ts
@@ -0,0 +1 @@
+export declare const checkBucketNameTest: (name: string, createBucket: boolean) => void;