@salesforce/core 3.30.14 → 3.31.7

package/lib/crypto/secureBuffer.d.ts

@@ -1,46 +1,46 @@
-/// <reference types="node" />
-import { Optional } from '@salesforce/ts-types';
-/**
- * Returns the intended type of the object to return. This is implementation specific.
- *
- * @param buffer A buffer containing the decrypted secret.
- */
-export declare type DecipherCallback<T> = (buffer: Buffer) => T;
-/**
- * Used to store and retrieve a sensitive information in memory. This is not meant for at rest encryption.
- *
- * ```
- * const sString: SecureBuffer<string> = new SecureBuffer();
- * sString.consume(secretTextBuffer);
- * const value: string = sString.value((buffer: Buffer): string => {
- *     const password: string = buffer.toString('utf8');
- *     // doSomething with the password
- *     // returns something of type <T>
- *     return testReturnValue;
- * });
- * ```
- */
-export declare class SecureBuffer<T> {
-    private key;
-    private iv;
-    private secret?;
-    /**
-     * Invokes a callback with a decrypted version of the buffer.
-     *
-     * @param cb The callback containing the decrypted buffer parameter that returns a desired.
-     * typed object. It's important to understand that once the callback goes out of scope the buffer parameters is
-     * overwritten with random data. Do not make a copy of this buffer and persist it!
-     */
-    value(cb: DecipherCallback<T>): Optional<T>;
-    /**
-     * Overwrites the value of the encrypted secret with random data.
-     */
-    clear(): void;
-    /**
-     * Consumes a buffer of data that's intended to be secret.
-     *
-     * @param buffer Data to encrypt. The input buffer is overwritten with random data after it's encrypted
-     * and assigned internally.
-     */
-    consume(buffer: Buffer): void;
-}
+/// <reference types="node" />
+import { Optional } from '@salesforce/ts-types';
+/**
+ * Returns the intended type of the object to return. This is implementation specific.
+ *
+ * @param buffer A buffer containing the decrypted secret.
+ */
+export declare type DecipherCallback<T> = (buffer: Buffer) => T;
+/**
+ * Used to store and retrieve a sensitive information in memory. This is not meant for at rest encryption.
+ *
+ * ```
+ * const sString: SecureBuffer<string> = new SecureBuffer();
+ * sString.consume(secretTextBuffer);
+ * const value: string = sString.value((buffer: Buffer): string => {
+ *     const password: string = buffer.toString('utf8');
+ *     // doSomething with the password
+ *     // returns something of type <T>
+ *     return testReturnValue;
+ * });
+ * ```
+ */
+export declare class SecureBuffer<T> {
+    private key;
+    private iv;
+    private secret?;
+    /**
+     * Invokes a callback with a decrypted version of the buffer.
+     *
+     * @param cb The callback containing the decrypted buffer parameter that returns a desired.
+     * typed object. It's important to understand that once the callback goes out of scope the buffer parameters is
+     * overwritten with random data. Do not make a copy of this buffer and persist it!
+     */
+    value(cb: DecipherCallback<T>): Optional<T>;
+    /**
+     * Overwrites the value of the encrypted secret with random data.
+     */
+    clear(): void;
+    /**
+     * Consumes a buffer of data that's intended to be secret.
+     *
+     * @param buffer Data to encrypt. The input buffer is overwritten with random data after it's encrypted
+     * and assigned internally.
+     */
+    consume(buffer: Buffer): void;
+}

package/lib/crypto/secureBuffer.js

@@ -1,83 +1,83 @@
-"use strict";
-/*
- * Copyright (c) 2020, salesforce.com, inc.
- * All rights reserved.
- * Licensed under the BSD 3-Clause license.
- * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SecureBuffer = void 0;
-const crypto = require("crypto");
-const ts_types_1 = require("@salesforce/ts-types");
-const cipherName = 'aes-256-cbc';
-const cipherSize = 32;
-/**
- * Used to store and retrieve a sensitive information in memory. This is not meant for at rest encryption.
- *
- * ```
- * const sString: SecureBuffer<string> = new SecureBuffer();
- * sString.consume(secretTextBuffer);
- * const value: string = sString.value((buffer: Buffer): string => {
- *     const password: string = buffer.toString('utf8');
- *     // doSomething with the password
- *     // returns something of type <T>
- *     return testReturnValue;
- * });
- * ```
- */
-class SecureBuffer {
-    constructor() {
-        this.key = crypto.randomBytes(cipherSize);
-        this.iv = crypto.randomBytes(16);
-    }
-    /**
-     * Invokes a callback with a decrypted version of the buffer.
-     *
-     * @param cb The callback containing the decrypted buffer parameter that returns a desired.
-     * typed object. It's important to understand that once the callback goes out of scope the buffer parameters is
-     * overwritten with random data. Do not make a copy of this buffer and persist it!
-     */
-    value(cb) {
-        if (cb) {
-            const cipher = crypto.createDecipheriv(cipherName, this.key, this.iv);
-            const a = cipher.update((0, ts_types_1.ensure)(this.secret));
-            const b = cipher.final();
-            const c = Buffer.concat([a, b]);
-            try {
-                return cb(c);
-            }
-            finally {
-                crypto.randomFillSync(a);
-                crypto.randomFillSync(b);
-                crypto.randomFillSync(c);
-            }
-        }
-    }
-    /**
-     * Overwrites the value of the encrypted secret with random data.
-     */
-    clear() {
-        if (this.secret) {
-            crypto.randomFillSync(this.secret);
-        }
-        const cipher = crypto.createCipheriv(cipherName, this.key, this.iv);
-        this.secret = Buffer.concat([cipher.update(Buffer.from('')), cipher.final()]);
-    }
-    /**
-     * Consumes a buffer of data that's intended to be secret.
-     *
-     * @param buffer Data to encrypt. The input buffer is overwritten with random data after it's encrypted
-     * and assigned internally.
-     */
-    consume(buffer) {
-        let targetBuffer = buffer;
-        if (!targetBuffer) {
-            targetBuffer = Buffer.from('');
-        }
-        const cipher = crypto.createCipheriv(cipherName, this.key, this.iv);
-        this.secret = Buffer.concat([cipher.update(targetBuffer), cipher.final()]);
-        crypto.randomFillSync(targetBuffer);
-    }
-}
-exports.SecureBuffer = SecureBuffer;
+"use strict";
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecureBuffer = void 0;
+const crypto = require("crypto");
+const ts_types_1 = require("@salesforce/ts-types");
+const cipherName = 'aes-256-cbc';
+const cipherSize = 32;
+/**
+ * Used to store and retrieve a sensitive information in memory. This is not meant for at rest encryption.
+ *
+ * ```
+ * const sString: SecureBuffer<string> = new SecureBuffer();
+ * sString.consume(secretTextBuffer);
+ * const value: string = sString.value((buffer: Buffer): string => {
+ *     const password: string = buffer.toString('utf8');
+ *     // doSomething with the password
+ *     // returns something of type <T>
+ *     return testReturnValue;
+ * });
+ * ```
+ */
+class SecureBuffer {
+    constructor() {
+        this.key = crypto.randomBytes(cipherSize);
+        this.iv = crypto.randomBytes(16);
+    }
+    /**
+     * Invokes a callback with a decrypted version of the buffer.
+     *
+     * @param cb The callback containing the decrypted buffer parameter that returns a desired.
+     * typed object. It's important to understand that once the callback goes out of scope the buffer parameters is
+     * overwritten with random data. Do not make a copy of this buffer and persist it!
+     */
+    value(cb) {
+        if (cb) {
+            const cipher = crypto.createDecipheriv(cipherName, this.key, this.iv);
+            const a = cipher.update((0, ts_types_1.ensure)(this.secret));
+            const b = cipher.final();
+            const c = Buffer.concat([a, b]);
+            try {
+                return cb(c);
+            }
+            finally {
+                crypto.randomFillSync(a);
+                crypto.randomFillSync(b);
+                crypto.randomFillSync(c);
+            }
+        }
+    }
+    /**
+     * Overwrites the value of the encrypted secret with random data.
+     */
+    clear() {
+        if (this.secret) {
+            crypto.randomFillSync(this.secret);
+        }
+        const cipher = crypto.createCipheriv(cipherName, this.key, this.iv);
+        this.secret = Buffer.concat([cipher.update(Buffer.from('')), cipher.final()]);
+    }
+    /**
+     * Consumes a buffer of data that's intended to be secret.
+     *
+     * @param buffer Data to encrypt. The input buffer is overwritten with random data after it's encrypted
+     * and assigned internally.
+     */
+    consume(buffer) {
+        let targetBuffer = buffer;
+        if (!targetBuffer) {
+            targetBuffer = Buffer.from('');
+        }
+        const cipher = crypto.createCipheriv(cipherName, this.key, this.iv);
+        this.secret = Buffer.concat([cipher.update(targetBuffer), cipher.final()]);
+        crypto.randomFillSync(targetBuffer);
+    }
+}
+exports.SecureBuffer = SecureBuffer;
 //# sourceMappingURL=secureBuffer.js.map

package/lib/deviceOauthService.d.ts

@@ -1,71 +1,71 @@
-import { AsyncCreatable } from '@salesforce/kit';
-import { OAuth2Config } from 'jsforce';
-import { JsonMap, Nullable } from '@salesforce/ts-types';
-import { AuthInfo } from './org';
-export interface DeviceCodeResponse extends JsonMap {
-    device_code: string;
-    interval: number;
-    user_code: string;
-    verification_uri: string;
-}
-export interface DeviceCodePollingResponse extends JsonMap {
-    access_token: string;
-    refresh_token: string;
-    signature: string;
-    scope: string;
-    instance_url: string;
-    id: string;
-    token_type: string;
-    issued_at: string;
-}
-/**
- * Handles device based login flows
- *
- * Usage:
- * ```
- * const oauthConfig = {
- *   loginUrl: this.flags.instanceurl,
- *   clientId: this.flags.clientid,
- * };
- * const deviceOauthService = await DeviceOauthService.create(oauthConfig);
- * const loginData = await deviceOauthService.requestDeviceLogin();
- * console.log(loginData);
- * const approval = await deviceOauthService.awaitDeviceApproval(loginData);
- * const authInfo = await deviceOauthService.authorizeAndSave(approval);
- * ```
- */
-export declare class DeviceOauthService extends AsyncCreatable<OAuth2Config> {
-    static RESPONSE_TYPE: string;
-    static GRANT_TYPE: string;
-    static SCOPE: string;
-    private static POLLING_COUNT_MAX;
-    private logger;
-    private options;
-    private pollingCount;
-    constructor(options: OAuth2Config);
-    /**
-     * Begin the authorization flow by requesting the login
-     *
-     * @returns {Promise<DeviceCodeResponse>}
-     */
-    requestDeviceLogin(): Promise<DeviceCodeResponse>;
-    /**
-     * Polls the server until successful response OR max attempts have been made
-     *
-     * @returns {Promise<Nullable<DeviceCodePollingResponse>>}
-     */
-    awaitDeviceApproval(loginData: DeviceCodeResponse): Promise<Nullable<DeviceCodePollingResponse>>;
-    /**
-     * Creates and saves new AuthInfo
-     *
-     * @returns {Promise<AuthInfo>}
-     */
-    authorizeAndSave(approval: DeviceCodePollingResponse): Promise<AuthInfo>;
-    protected init(): Promise<void>;
-    private getLoginOptions;
-    private getPollingOptions;
-    private getDeviceFlowRequestUrl;
-    private poll;
-    private shouldContinuePolling;
-    private pollForDeviceApproval;
-}
+import { AsyncCreatable } from '@salesforce/kit';
+import { OAuth2Config } from 'jsforce';
+import { JsonMap, Nullable } from '@salesforce/ts-types';
+import { AuthInfo } from './org';
+export interface DeviceCodeResponse extends JsonMap {
+    device_code: string;
+    interval: number;
+    user_code: string;
+    verification_uri: string;
+}
+export interface DeviceCodePollingResponse extends JsonMap {
+    access_token: string;
+    refresh_token: string;
+    signature: string;
+    scope: string;
+    instance_url: string;
+    id: string;
+    token_type: string;
+    issued_at: string;
+}
+/**
+ * Handles device based login flows
+ *
+ * Usage:
+ * ```
+ * const oauthConfig = {
+ *   loginUrl: this.flags.instanceurl,
+ *   clientId: this.flags.clientid,
+ * };
+ * const deviceOauthService = await DeviceOauthService.create(oauthConfig);
+ * const loginData = await deviceOauthService.requestDeviceLogin();
+ * console.log(loginData);
+ * const approval = await deviceOauthService.awaitDeviceApproval(loginData);
+ * const authInfo = await deviceOauthService.authorizeAndSave(approval);
+ * ```
+ */
+export declare class DeviceOauthService extends AsyncCreatable<OAuth2Config> {
+    static RESPONSE_TYPE: string;
+    static GRANT_TYPE: string;
+    static SCOPE: string;
+    private static POLLING_COUNT_MAX;
+    private logger;
+    private options;
+    private pollingCount;
+    constructor(options: OAuth2Config);
+    /**
+     * Begin the authorization flow by requesting the login
+     *
+     * @returns {Promise<DeviceCodeResponse>}
+     */
+    requestDeviceLogin(): Promise<DeviceCodeResponse>;
+    /**
+     * Polls the server until successful response OR max attempts have been made
+     *
+     * @returns {Promise<Nullable<DeviceCodePollingResponse>>}
+     */
+    awaitDeviceApproval(loginData: DeviceCodeResponse): Promise<Nullable<DeviceCodePollingResponse>>;
+    /**
+     * Creates and saves new AuthInfo
+     *
+     * @returns {Promise<AuthInfo>}
+     */
+    authorizeAndSave(approval: DeviceCodePollingResponse): Promise<AuthInfo>;
+    protected init(): Promise<void>;
+    private getLoginOptions;
+    private getPollingOptions;
+    private getDeviceFlowRequestUrl;
+    private poll;
+    private shouldContinuePolling;
+    private pollForDeviceApproval;
+}