oclif 4.2.0 → 4.3.1

package/README.md

@@ -232,6 +232,8 @@ USAGE
 FLAGS
   -r, --root=<value>     (required) [default: .] path to oclif CLI root
   -t, --tarball=<value>  optionally specify a path to a tarball already generated by NPM
+  -Z, --compression=<value> optionally override compression, see output of
+                            'dpkg-deb --help' in the -Z description for valid options.
 
 DESCRIPTION
   pack CLI into debian package

package/bin/dev.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 // eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
-(async () => {
+;(async () => {
   const oclif = await import('@oclif/core')
   await oclif.execute({development: true, dir: __dirname})
 })()

package/bin/run.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // eslint-disable-next-line unicorn/prefer-top-level-await
-(async () => {
+;(async () => {
   const oclif = await import('@oclif/core')
   await oclif.execute({dir: __dirname})
 })()

package/lib/aws.d.ts

@@ -1,16 +1,16 @@
-import * as CloudFront from 'aws-sdk/clients/cloudfront';
-import * as S3 from 'aws-sdk/clients/s3';
+import { CreateInvalidationCommandOutput, CreateInvalidationRequest } from '@aws-sdk/client-cloudfront';
+import { CopyObjectOutput, CopyObjectRequest, DeleteObjectsOutput, DeleteObjectsRequest, GetObjectOutput, GetObjectRequest, HeadObjectOutput, HeadObjectRequest, ListObjectsV2Output, ListObjectsV2Request, PutObjectOutput, PutObjectRequest } from '@aws-sdk/client-s3';
 declare const _default: {
     readonly cloudfront: {
-        createCloudfrontInvalidation: (options: CloudFront.Types.CreateInvalidationRequest) => Promise<unknown>;
+        createCloudfrontInvalidation: (options: CreateInvalidationRequest) => Promise<CreateInvalidationCommandOutput>;
     };
     readonly s3: {
-        copyObject: (options: S3.Types.CopyObjectRequest) => Promise<unknown>;
-        deleteObjects: (options: S3.Types.DeleteObjectsRequest) => Promise<S3.DeleteObjectsOutput>;
-        getObject: (options: S3.Types.GetObjectRequest) => Promise<S3.GetObjectOutput>;
-        headObject: (options: S3.Types.HeadObjectRequest) => Promise<S3.HeadObjectOutput>;
-        listObjects: (options: S3.Types.ListObjectsV2Request) => Promise<S3.ListObjectsV2Output>;
-        uploadFile: (local: string, options: S3.Types.PutObjectRequest) => Promise<unknown>;
+        copyObject: (options: CopyObjectRequest) => Promise<CopyObjectOutput>;
+        deleteObjects: (options: DeleteObjectsRequest) => Promise<DeleteObjectsOutput>;
+        getObject: (options: GetObjectRequest) => Promise<GetObjectOutput>;
+        headObject: (options: HeadObjectRequest) => Promise<HeadObjectOutput>;
+        listObjects: (options: ListObjectsV2Request) => Promise<ListObjectsV2Output>;
+        uploadFile: (local: string, options: PutObjectRequest) => Promise<PutObjectOutput>;
     };
 };
 export default _default;

package/lib/aws.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const client_cloudfront_1 = require("@aws-sdk/client-cloudfront");
+const client_s3_1 = require("@aws-sdk/client-s3");
 const fs_extra_1 = require("fs-extra");
 const log_1 = require("./log");
 const util_1 = require("./util");
@@ -7,7 +9,8 @@ const debug = log_1.debug.new('aws');
 const cache = {};
 const aws = {
     get cloudfront() {
-        cache.cloudfront = cache.cloudfront || new (require('aws-sdk/clients/cloudfront'))(this.creds);
+        cache.cloudfront =
+            cache.cloudfront || new (require('@aws-sdk/client-cloudfront').CloudFrontClient)({ credentials: this.creds });
         return cache.cloudfront;
     },
     get creds() {
@@ -26,17 +29,18 @@ const aws = {
         try {
             cache.s3 =
                 cache.s3 ??
-                    new (require('aws-sdk/clients/s3'))({
-                        ...this.creds,
+                    new (require('@aws-sdk/client-s3').S3Client)({
+                        credentials: this.creds,
                         endpoint: process.env.AWS_S3_ENDPOINT,
-                        s3ForcePathStyle: Boolean(process.env.AWS_S3_FORCE_PATH_STYLE),
+                        forcePathStyle: Boolean(process.env.AWS_S3_FORCE_PATH_STYLE),
+                        region: process.env.AWS_REGION ?? 'us-east-1',
                     });
             return cache.s3;
         }
         catch (error) {
             const { code, message } = error;
             if (code === 'MODULE_NOT_FOUND')
-                throw new Error(`${message}\naws-sdk is needed to run this command.\nInstall aws-sdk as a devDependency in your CLI. \`yarn add -D aws-sdk\``);
+                throw new Error(`${message}\n@aws-sdk/client-s3 is needed to run this command.\nInstall @aws-sdk/client-s3 as a devDependency in your CLI. \`yarn add -D @aws-sdk/client-s3\``);
             throw error;
         }
     },
@@ -45,13 +49,11 @@ exports.default = {
     get cloudfront() {
         return {
             createCloudfrontInvalidation: (options) => new Promise((resolve, reject) => {
-                (0, log_1.log)('createCloudfrontInvalidation', options.DistributionId, options.InvalidationBatch.Paths.Items);
-                aws.cloudfront.createInvalidation(options, (err) => {
-                    if (err)
-                        reject(err);
-                    else
-                        resolve(null);
-                });
+                (0, log_1.log)('createCloudfrontInvalidation', options.DistributionId, options.InvalidationBatch?.Paths?.Items);
+                aws.cloudfront
+                    ?.send(new client_cloudfront_1.CreateInvalidationCommand(options))
+                    .then((data) => resolve(data))
+                    .catch((error) => reject(error));
             }),
         };
     },
@@ -59,71 +61,47 @@ exports.default = {
         return {
             copyObject: (options) => new Promise((resolve, reject) => {
                 (0, log_1.log)('s3:copyObject', `from s3://${options.CopySource}`, `to s3://${options.Bucket}/${options.Key}`);
-                aws.s3.copyObject(options, (err, data) => {
-                    if (err)
-                        reject(err);
-                    else
-                        resolve(data);
-                });
+                aws.s3
+                    ?.send(new client_s3_1.CopyObjectCommand(options))
+                    .then((data) => resolve(data))
+                    .catch((error) => reject(error));
             }),
             deleteObjects: (options) => new Promise((resolve, reject) => {
                 debug('deleteObjects', `s3://${options.Bucket}`);
-                aws.s3.deleteObjects(options, (err, deletedObjects) => {
-                    if (err)
-                        reject(err);
-                    resolve(deletedObjects);
-                });
+                aws.s3
+                    ?.send(new client_s3_1.DeleteObjectsCommand(options))
+                    .then((data) => resolve(data))
+                    .catch((error) => reject(error));
             }),
             getObject: (options) => new Promise((resolve, reject) => {
                 debug('getObject', `s3://${options.Bucket}/${options.Key}`);
-                aws.s3.getObject(options, (err, data) => {
-                    if (err)
-                        reject(err);
-                    else
-                        resolve(data);
-                });
+                aws.s3
+                    ?.send(new client_s3_1.GetObjectCommand(options))
+                    .then((data) => resolve(data))
+                    .catch((error) => reject(error));
             }),
             headObject: (options) => new Promise((resolve, reject) => {
                 debug('s3:headObject', `s3://${options.Bucket}/${options.Key}`);
-                aws.s3.headObject(options, (err, data) => {
-                    if (err)
-                        reject(err);
-                    else
-                        resolve(data);
-                });
+                aws.s3
+                    ?.send(new client_s3_1.HeadObjectCommand(options))
+                    .then((data) => resolve(data))
+                    .catch((error) => reject(error));
             }),
             listObjects: (options) => new Promise((resolve, reject) => {
                 debug('listObjects', `s3://${options.Bucket}/${options.Prefix}`);
-                aws.s3.listObjectsV2(options, (err, objects) => {
-                    if (err)
-                        reject(err);
-                    resolve(objects);
-                });
+                aws.s3
+                    ?.send(new client_s3_1.ListObjectsV2Command(options))
+                    .then((data) => resolve(data))
+                    .catch((error) => reject(error));
             }),
             uploadFile: (local, options) => new Promise((resolve, reject) => {
                 (0, log_1.log)('s3:uploadFile', (0, util_1.prettifyPaths)(local), `s3://${options.Bucket}/${options.Key}`);
                 options.Body = (0, fs_extra_1.createReadStream)(local);
-                aws.s3.upload(options, (err) => {
-                    if (err)
-                        reject(err);
-                    else
-                        resolve(null);
-                });
+                aws.s3
+                    ?.send(new client_s3_1.PutObjectCommand(options))
+                    .then((data) => resolve(data))
+                    .catch((error) => reject(error));
             }),
         };
     },
 };
-// export const getObject = (options: S3.Types.GetObjectRequest) => new Promise<S3.GetObjectOutput>((resolve, reject) => {
-//   debug('getObject', `s3://${options.Bucket}/${options.Key}`)
-//   aws.s3().getObject(options, (err, data) => {
-//     if (err) reject(err)
-//     else resolve(data)
-//   })
-// })
-// export const listObjects = (options: S3.Types.ListObjectsV2Request) => new Promise<S3.ListObjectsV2Output>((resolve, reject) => {
-//   debug('listObjects', `s3://${options.Bucket}/${options.Prefix}`)
-//   s3().listObjectsV2(options, (err, objects) => {
-//     if (err) reject(err)
-//     else resolve(objects)
-//   })
-// })

package/lib/commands/pack/deb.d.ts

@@ -2,6 +2,7 @@ import { Command, Interfaces } from '@oclif/core';
 export default class PackDeb extends Command {
     static description: string;
     static flags: {
+        compression: Interfaces.OptionFlag<"xz" | "gzip" | "none" | "zstd" | undefined, Interfaces.CustomOptions>;
         root: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
         tarball: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
     };

package/lib/commands/pack/deb.js

@@ -48,12 +48,19 @@ APT::FTPArchive::Release {
 `,
 };
 class PackDeb extends core_1.Command {
-    static description = 'pack CLI into debian package';
+    static description = 'Pack CLI into debian package.';
     static flags = {
-        root: core_1.Flags.string({ char: 'r', default: '.', description: 'path to oclif CLI root', required: true }),
+        compression: core_1.Flags.option({
+            options: ['gzip', 'none', 'xz', 'zstd'],
+        })({
+            char: 'z',
+            description: 'For more details see the `-Zcompress-type` section at https://man7.org/linux/man-pages/man1/dpkg-deb.1.html',
+            summary: 'Override the default compression used by dpkg-deb.',
+        }),
+        root: core_1.Flags.string({ char: 'r', default: '.', description: 'Path to oclif CLI root.', required: true }),
         tarball: core_1.Flags.string({
             char: 't',
-            description: 'optionally specify a path to a tarball already generated by NPM',
+            description: 'Optionally specify a path to a tarball already generated by NPM.',
             required: false,
         }),
     };
@@ -95,7 +102,8 @@ class PackDeb extends core_1.Command {
             }));
             await exec(`sudo chown -R root "${workspace}"`);
             await exec(`sudo chgrp -R root "${workspace}"`);
-            await exec(`dpkg --build "${workspace}" "${path.join(dist, versionedDebBase)}"`);
+            const dpkgDeb = flags.compression ? `dpkg-deb --build "-Z${flags.compression}"` : 'dpkg-deb --build';
+            await exec(`${dpkgDeb} "${workspace}" "${path.join(dist, versionedDebBase)}"`);
             this.log(`finished building debian / ${arch}`);
         };
         const arches = (0, util_1.uniq)(buildConfig.targets.filter((t) => t.platform === 'linux').map((t) => t.arch));

package/lib/commands/promote.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const client_s3_1 = require("@aws-sdk/client-s3");
 const core_1 = require("@oclif/core");
 const path = require("node:path");
 const aws_1 = require("../aws");
@@ -34,10 +35,10 @@ class Promote extends core_1.Command {
         if (!s3Config.bucket)
             this.error('Cannot determine S3 bucket for promotion');
         const awsDefaults = {
-            ACL: s3Config.acl ?? 'public-read',
+            ACL: s3Config.acl ?? client_s3_1.ObjectCannedACL.public_read,
             Bucket: s3Config.bucket,
             CacheControl: indexDefaults.maxAge,
-            MetadataDirective: 'REPLACE',
+            MetadataDirective: client_s3_1.MetadataDirective.REPLACE,
         };
         const cloudBucketCommitKey = (shortKey) => path.join(s3Config.bucket, (0, upload_util_1.commitAWSDir)(flags.version, flags.sha, s3Config), shortKey);
         const cloudChannelKey = (shortKey) => path.join((0, upload_util_1.channelAWSDir)(flags.channel, s3Config), shortKey);

package/lib/tarballs/config.d.ts

@@ -1,5 +1,17 @@
+import { ObjectCannedACL } from '@aws-sdk/client-s3';
 import { Interfaces } from '@oclif/core';
 export declare const TARGETS: string[];
+export type S3Config = BuildConfig['updateConfig']['s3'] & {
+    folder?: string;
+    indexVersionLimit?: number;
+} & {
+    acl?: ObjectCannedACL;
+};
+export type UpdateConfig = BuildConfig['config']['pjson']['oclif']['update'] & {
+    s3?: BuildConfig['config']['pjson']['oclif']['update']['s3'] & {
+        acl?: ObjectCannedACL;
+    };
+};
 export interface BuildConfig {
     config: Interfaces.Config;
     dist(input: string): string;
@@ -7,16 +19,13 @@ export interface BuildConfig {
     nodeOptions: string[];
     nodeVersion: string;
     root: string;
-    s3Config: BuildConfig['updateConfig']['s3'] & {
-        folder?: string;
-        indexVersionLimit?: number;
-    };
+    s3Config: S3Config;
     targets: {
         arch: Interfaces.ArchTypes;
         platform: Interfaces.PlatformTypes;
     }[];
     tmp: string;
-    updateConfig: BuildConfig['config']['pjson']['oclif']['update'];
+    updateConfig: UpdateConfig;
     workspace(target?: {
         arch: Interfaces.ArchTypes;
         platform: Interfaces.PlatformTypes;

package/lib/tarballs/config.js

@@ -28,7 +28,7 @@ async function buildConfig(root, options = {}) {
     const _gitSha = await gitSha(root, { short: true });
     // eslint-disable-next-line new-cap
     const tmp = await Tmp(config);
-    const updateConfig = config.pjson.oclif.update || {};
+    const updateConfig = (config.pjson.oclif.update || {});
     updateConfig.s3 = updateConfig.s3 || {};
     const nodeVersion = updateConfig.node.version || process.versions.node;
     const nodeOptions = (0, util_1.castArray)(updateConfig.node.options ?? []);
@@ -44,6 +44,10 @@ async function buildConfig(root, options = {}) {
         const [platform, arch] = t.split('-');
         return { arch, platform };
     });
+    const s3Config = {
+        ...updateConfig.s3,
+        acl: updateConfig.s3.acl,
+    };
     return {
         config,
         dist: (...args) => path.join(config.root, 'dist', ...args),
@@ -51,7 +55,7 @@ async function buildConfig(root, options = {}) {
         nodeOptions,
         nodeVersion,
         root,
-        s3Config: updateConfig.s3,
+        s3Config,
         targets,
         tmp,
         updateConfig,

package/lib/version-indexes.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.appendToIndex = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
 const fs = require("fs-extra");
 const path = require("node:path");
 const aws_1 = require("./aws");
@@ -65,7 +66,7 @@ const appendToIndex = async (input) => {
     }, s3Config.indexVersionLimit), { spaces: 2 });
     // put the file back in the same place
     await aws_1.default.s3.uploadFile(jsonFileName, {
-        ACL: s3Config.acl || 'public-read',
+        ACL: s3Config.acl ?? client_s3_1.ObjectCannedACL.public_read,
         Bucket: s3Config.bucket,
         CacheControl: maxAge,
         Key: key,

package/oclif.manifest.json

@@ -334,11 +334,26 @@
     "pack:deb": {
       "aliases": [],
       "args": {},
-      "description": "pack CLI into debian package",
+      "description": "Pack CLI into debian package.",
       "flags": {
+        "compression": {
+          "char": "z",
+          "description": "For more details see the `-Zcompress-type` section at https://man7.org/linux/man-pages/man1/dpkg-deb.1.html",
+          "name": "compression",
+          "summary": "Override the default compression used by dpkg-deb.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "gzip",
+            "none",
+            "xz",
+            "zstd"
+          ],
+          "type": "option"
+        },
         "root": {
           "char": "r",
-          "description": "path to oclif CLI root",
+          "description": "Path to oclif CLI root.",
           "name": "root",
           "required": true,
           "default": ".",
@@ -348,7 +363,7 @@
         },
         "tarball": {
           "char": "t",
-          "description": "optionally specify a path to a tarball already generated by NPM",
+          "description": "Optionally specify a path to a tarball already generated by NPM.",
           "name": "tarball",
           "required": false,
           "hasDynamicHelp": false,
@@ -717,5 +732,5 @@
       ]
     }
   },
-  "version": "4.2.0"
+  "version": "4.3.1"
 }

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.2.0",
+  "version": "4.3.1",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"
   },
   "bugs": "https://github.com/oclif/oclif/issues",
   "dependencies": {
+    "@aws-sdk/client-cloudfront": "^3.468.0",
+    "@aws-sdk/client-s3": "^3.468.0",
     "@oclif/core": "^3.16.0",
     "@oclif/plugin-help": "^6.0.9",
-    "@oclif/plugin-not-found": "^3.0.7",
+    "@oclif/plugin-not-found": "^3.0.8",
     "@oclif/plugin-warn-if-update-available": "^3.0.8",
     "async-retry": "^1.3.3",
-    "aws-sdk": "^2.1231.0",
     "change-case": "^4",
     "debug": "^4.3.3",
     "eslint-plugin-perfectionist": "^2.1.0",