@salesforce/core 3.6.4 → 3.7.1

package/lib/status/streamingClient.d.ts

@@ -1,75 +1,8 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
 import { AsyncOptionalCreatable, Duration, Env } from '@salesforce/kit/lib';
-import { AnyFunction, AnyJson, JsonMap } from '@salesforce/ts-types/lib';
+import { AnyJson } from '@salesforce/ts-types/lib';
+import type { Client as CometClient, StreamProcessor } from 'sfdx-faye';
 import { Org } from '../org/org';
-import { StatusResult } from './client';
-/**
- * Types for defining extensions.
- */
-export interface StreamingExtension {
-    /**
-     * Extension for outgoing message.
-     *
-     * @param message The message.
-     * @param callback The callback to invoke after the message is processed.
-     */
-    outgoing?: (message: JsonMap, callback: AnyFunction) => void;
-    /**
-     * Extension for the incoming message.
-     *
-     * @param message The message.
-     * @param callback The callback to invoke after the message is processed.
-     */
-    incoming?: (message: JsonMap, callback: AnyFunction) => void;
-}
-/**
- * Function type for processing messages
- */
-export declare type StreamProcessor = (message: JsonMap) => StatusResult;
-/**
- * Comet client interface. The is to allow for mocking the inner streaming Cometd implementation.
- * The Faye implementation is used by default but it could be used to adapt another Cometd impl.
- */
-export declare abstract class CometClient extends EventEmitter {
-    /**
-     * Disable polling features.
-     *
-     * @param label Polling feature label.
-     */
-    abstract disable(label: string): void;
-    /**
-     * Add a custom extension to the underlying client.
-     *
-     * @param extension The json function for the extension.
-     */
-    abstract addExtension(extension: StreamingExtension): void;
-    /**
-     * Sets an http header name/value.
-     *
-     * @param name The header name.
-     * @param value The header value.
-     */
-    abstract setHeader(name: string, value: string): void;
-    /**
-     * handshake with the streaming channel
-     *
-     * @param callback Callback for the handshake when it successfully completes. The handshake should throw
-     * errors when errors are encountered.
-     */
-    abstract handshake(callback: () => void): void;
-    /**
-     * Subscribes to Comet topics. Subscribe should perform a handshake if one hasn't been performed yet.
-     *
-     * @param channel The topic to subscribe to.
-     * @param callback The callback to execute once a message has been received.
-     */
-    abstract subscribe(channel: string, callback: (message: JsonMap) => void): CometSubscription;
-    /**
-     * Method to call to disconnect the client from the server.
-     */
-    abstract disconnect(): void;
-}
+export { Client as CometClient, Message, StreamProcessor, CometSubscription, StatusResult, StreamingExtension, } from 'sfdx-faye';
 /**
  * Inner streaming client interface. This implements the Cometd behavior.
  * Also allows for mocking the functional behavior.
@@ -88,13 +21,6 @@ export interface StreamingClientIfc {
      */
     setLogger: (logLine: (message: string) => void) => void;
 }
-/**
- * The subscription object returned from the cometd subscribe object.
- */
-export interface CometSubscription {
-    callback(callback: () => void): void;
-    errback(callback: (error: Error) => void): void;
-}
 /**
  * Api wrapper to support Salesforce streaming. The client contains an internal implementation of a cometd specification.
  *

package/lib/status/streamingClient.js

@@ -8,15 +8,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamingClient = exports.CometClient = void 0;
 /* eslint-disable @typescript-eslint/ban-ts-comment */
-const events_1 = require("events");
 const url_1 = require("url");
 const lib_1 = require("@salesforce/kit/lib");
 const lib_2 = require("@salesforce/ts-types/lib");
-// @ts-ignore
 const Faye = require("sfdx-faye");
 const logger_1 = require("../logger");
 const sfdxError_1 = require("../sfdxError");
 const messages_1 = require("../messages");
+var sfdx_faye_1 = require("sfdx-faye");
+Object.defineProperty(exports, "CometClient", { enumerable: true, get: function () { return sfdx_faye_1.Client; } });
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'streaming', [
     'waitParamValidValueError',
@@ -25,13 +25,6 @@ const messages = messages_1.Messages.load('@salesforce/core', 'streaming', [
     'genericTimeout',
     'handshakeApiVersionError',
 ]);
-/**
- * Comet client interface. The is to allow for mocking the inner streaming Cometd implementation.
- * The Faye implementation is used by default but it could be used to adapt another Cometd impl.
- */
-class CometClient extends events_1.EventEmitter {
-}
-exports.CometClient = CometClient;
 /**
  * Validation helper
  *
@@ -382,6 +375,7 @@ exports.StreamingClient = StreamingClient;
                     });
                 },
                 setLogger: (logLine) => {
+                    // @ts-ignore
                     Faye.logger = {};
                     ['info', 'error', 'fatal', 'warn', 'debug'].forEach((element) => {
                         lib_1.set(Faye.logger, element, logLine);

package/lib/testSetup.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="sfdx-faye" />
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import * as sinonType from 'sinon';
@@ -5,7 +6,7 @@ import { AnyJson, JsonMap, Optional } from '@salesforce/ts-types';
 import { ConfigContents } from './config/configStore';
 import { Logger } from './logger';
 import { SfdxError } from './sfdxError';
-import { CometClient, CometSubscription, StreamingExtension } from './status/streamingClient';
+import { CometClient, CometSubscription, Message, StreamingExtension } from './status/streamingClient';
 import { SfOrg } from './globalInfo';
 /**
  * Different parts of the system that are mocked out. They can be restored for
@@ -306,7 +307,7 @@ export interface StreamingMockCometSubscriptionOptions {
     /**
      * A list of messages to playback for the client. One message per process tick.
      */
-    messagePlaylist?: JsonMap[];
+    messagePlaylist?: Message[];
 }
 /**
  * Simulates a comet subscription to a streaming channel.
@@ -366,7 +367,7 @@ export declare class StreamingMockCometClient extends CometClient {
      * @param channel The streaming channel.
      * @param callback The function to invoke after the subscription completes.
      */
-    subscribe(channel: string, callback: (message: JsonMap) => void): CometSubscription;
+    subscribe(channel: string, callback: (message: Message) => void): CometSubscription;
     /**
      * Fake disconnect. Does Nothing.
      */

package/lib/testSetup.js

@@ -413,7 +413,7 @@ class StreamingMockCometClient extends streamingClient_1.CometClient {
      * @param {StreamingMockCometSubscriptionOptions} options Extends the StreamingClient options.
      */
     constructor(options) {
-        super();
+        super(options.url);
         this.options = options;
         if (!this.options.messagePlaylist) {
             this.options.messagePlaylist = [{ id: this.options.id }];

package/lib/util/getJwtAudienceUrl.d.ts

@@ -1,4 +1,4 @@
-import { OAuth2Options } from 'jsforce';
-export declare function getJwtAudienceUrl(options: OAuth2Options & {
+import { OAuth2Config } from 'jsforce';
+export declare function getJwtAudienceUrl(options: OAuth2Config & {
     createdOrgInstance?: string;
 }): Promise<string>;

package/lib/util/sfdcUrl.js

@@ -70,6 +70,7 @@ class SfdcUrl extends url_1.URL {
             '.salesforce.com',
             '.salesforceliveagent.com',
             '.secure.force.com',
+            'crmforce.mil',
         ];
         const allowlistOfSalesforceHosts = ['developer.salesforce.com', 'trailhead.salesforce.com'];
         return allowlistOfSalesforceDomainPatterns.some((pattern) => {

package/lib/webOAuthServer.d.ts

@@ -1,8 +1,7 @@
 /// <reference types="node" />
 import * as http from 'http';
 import { AsyncCreatable } from '@salesforce/kit';
-import { OAuth2Options } from 'jsforce';
-import { AuthInfo } from './org/authInfo';
+import { AuthInfo, OAuth2Config } from './org/authInfo';
 /**
  * Handles the creation of a web server for web based login flows.
  *
@@ -80,7 +79,7 @@ export declare class WebOAuthServer extends AsyncCreatable<WebOAuthServer.Option
 }
 export declare namespace WebOAuthServer {
     interface Options {
-        oauthConfig: OAuth2Options;
+        oauthConfig: OAuth2Config;
     }
     type Request = http.IncomingMessage & {
         query: {

package/lib/webOAuthServer.js

@@ -13,6 +13,7 @@ const url_1 = require("url");
 const net_1 = require("net");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
+const jsforce_1 = require("jsforce");
 const logger_1 = require("./logger");
 const authInfo_1 = require("./org/authInfo");
 const sfdxError_1 = require("./sfdxError");
@@ -132,7 +133,7 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
         if (!this.oauthConfig.redirectUri)
             this.oauthConfig.redirectUri = `http://localhost:${port}/OauthRedirect`;
         this.webServer = await WebServer.create({ port });
-        this.oauth2 = new authInfo_1.OAuth2WithVerifier(this.oauthConfig);
+        this.oauth2 = new jsforce_1.OAuth2(this.oauthConfig);
         this.authUrl = authInfo_1.AuthInfo.getAuthorizationUrl(this.oauthConfig, this.oauth2);
     }
     /**

package/messages/config.md

@@ -22,6 +22,10 @@ Specify a valid Salesforce instance URL.
 
 Specify a valid Salesforce API version, for example, 42.0.
 
+# invalidCustomOrgMetadataTemplates
+
+Specify a valid repository URL or directory for the custom org metadata templates.
+
 # invalidIsvDebuggerSid
 
 Specify a valid Debugger SID.
@@ -97,7 +101,7 @@ ISV debugger URL
 
 # apiVersion
 
-API version of your project. Default: API version of your Dev Hub org. 
+API version of your project. Default: API version of your Dev Hub org.
 
 # disableTelemetry
 
@@ -109,7 +113,7 @@ Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
 
 # restDeploy
 
-Whether deployments use the Metadata REST API (true) or SOAP API (false, default value).  
+Whether deployments use the Metadata REST API (true) or SOAP API (false, default value).
 
 # instanceUrl
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.6.4",
+  "version": "3.7.1",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "license": "BSD-3-Clause",
@@ -48,9 +48,10 @@
     "@types/mkdirp": "^1.0.1",
     "change-case": "^4.1.2",
     "debug": "^3.1.0",
+    "form-data": "^4.0.0",
     "graceful-fs": "^4.2.4",
     "jsen": "0.6.6",
-    "jsforce": "^1.10.1",
+    "jsforce": "2.0.0-beta.7",
     "jsonwebtoken": "8.5.0",
     "mkdirp": "1.0.4",
     "sfdx-faye": "^1.0.9",
@@ -64,6 +65,7 @@
     "@types/debug": "0.0.30",
     "@types/jsen": "0.0.19",
     "@types/jsonwebtoken": "8.3.2",
+    "@types/sfdx-faye": "^1.0.0",
     "@types/shelljs": "0.7.8",
     "@types/sinon": "^9.0.8",
     "@typescript-eslint/eslint-plugin": "^4.2.0",

package/lib/status/client.d.ts

@@ -1,15 +0,0 @@
-import { AnyJson } from '@salesforce/ts-types';
-/**
- * Return type for the Streaming and Polling client.
- */
-export interface StatusResult {
-    /**
-     * If the result of the streaming or polling client is expected to return a result
-     */
-    payload?: AnyJson;
-    /**
-     * Indicates to the streaming or polling client that the subscriber has what its needs. If `true` the client will end
-     * the messaging exchanges with the endpoint.
-     */
-    completed: boolean;
-}

package/lib/status/client.js

@@ -1,9 +0,0 @@
-"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 });
-//# sourceMappingURL=client.js.map