@simplysf/simply-community-core 0.2.6 → 0.2.8

package/lib/checkPublishStatus.d.ts

@@ -1,3 +1,4 @@
+import { Duration } from '@salesforce/kit';
 import { type Connection, type StatusResult } from '@salesforce/core';
 /**
  * Builds a `PollingClient`-compatible `poll()` function for a community publish job.
@@ -9,7 +10,8 @@ import { type Connection, type StatusResult } from '@salesforce/core';
  *
  * @param connection - The org connection to poll against.
  * @param jobId - The `jobId` returned by `POST /connect/communities/{id}/publish`.
+ * @param requestTimeout - Bounds each status-check attempt. Defaults to `DEFAULT_PUBLISH_REQUEST_TIMEOUT`; overridable mainly so tests don't have to wait out the real default.
  * @returns A `poll()` function for `PollingClient.create({ poll, ... })`.
  * @throws {SfError} `CommunityPublishFailedError` if the job reaches a terminal failure state.
  */
-export declare function checkPublishStatus(connection: Connection, jobId: string): () => Promise<StatusResult>;
+export declare function checkPublishStatus(connection: Connection, jobId: string, requestTimeout?: Duration): () => Promise<StatusResult>;

package/lib/checkPublishStatus.js

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 import { SfError } from '@salesforce/core';
+import { retryWithBackoff } from '@simplysf/simply-core';
+import { DEFAULT_PUBLISH_REQUEST_TIMEOUT } from './requestTimeout.js';
 /**
  * Builds a `PollingClient`-compatible `poll()` function for a community publish job.
  *
@@ -24,12 +26,21 @@ import { SfError } from '@salesforce/core';
  *
  * @param connection - The org connection to poll against.
  * @param jobId - The `jobId` returned by `POST /connect/communities/{id}/publish`.
+ * @param requestTimeout - Bounds each status-check attempt. Defaults to `DEFAULT_PUBLISH_REQUEST_TIMEOUT`; overridable mainly so tests don't have to wait out the real default.
  * @returns A `poll()` function for `PollingClient.create({ poll, ... })`.
  * @throws {SfError} `CommunityPublishFailedError` if the job reaches a terminal failure state.
  */
-export function checkPublishStatus(connection, jobId) {
+export function checkPublishStatus(connection, jobId, requestTimeout = DEFAULT_PUBLISH_REQUEST_TIMEOUT) {
     return async () => {
-        const result = await connection.query(`SELECT Id, Status, FinishedAt, Error FROM BackgroundOperation WHERE Id = '${jobId}'`);
+        let result;
+        try {
+            result = await retryWithBackoff(() => Promise.resolve(connection.query(`SELECT Id, Status, FinishedAt, Error FROM BackgroundOperation WHERE Id = '${jobId}'`)), { retryAttempts: 0, backoffFactor: 1, attemptTimeout: requestTimeout });
+        }
+        catch {
+            // A stalled or failed status check isn't a publish failure — treat it the same as "not
+            // finished yet" below and let PollingClient's own timeout/frequency decide when to give up.
+            return { completed: false };
+        }
         const operation = result.records[0];
         // The BackgroundOperation record may not be queryable in the instant right after the publish
         // request is submitted — treat "not found yet" the same as "still running", not as a failure.

package/lib/checkPublishStatus.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkPublishStatus.js","sourceRoot":"","sources":["../src/checkPublishStatus.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,OAAO,EAAsC,MAAM,kBAAkB,CAAC;AAU/E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAAC,UAAsB,EAAE,KAAa;IACtE,OAAO,KAAK,IAA2B,EAAE;QACvC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,CACnC,6EAA6E,KAAK,GAAG,CACtF,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAA0C,CAAC;QAE7E,6FAA6F;QAC7F,8FAA8F;QAC9F,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC;YAC3B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,MAAM,IAAI,OAAO,CACf,qCAAqC,SAAS,CAAC,MAAM,IAAI,SAAS,MAAM,SAAS,CAAC,KAAK,EAAE,EACzF,6BAA6B,CAC9B,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"checkPublishStatus.js","sourceRoot":"","sources":["../src/checkPublishStatus.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,OAAO,EAAsC,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAUtE;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,kBAAkB,CAChC,UAAsB,EACtB,KAAa,EACb,iBAA2B,+BAA+B;IAE1D,OAAO,KAAK,IAA2B,EAAE;QACvC,IAAI,MAAM,CAAC;QACX,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,gBAAgB,CAC7B,GAAG,EAAE,CACH,OAAO,CAAC,OAAO,CACb,UAAU,CAAC,KAAK,CACd,6EAA6E,KAAK,GAAG,CACtF,CACF,EACH,EAAE,aAAa,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,cAAc,EAAE,cAAc,EAAE,CACvE,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,uFAAuF;YACvF,4FAA4F;YAC5F,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAC9B,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAA0C,CAAC;QAE7E,6FAA6F;QAC7F,8FAA8F;QAC9F,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC;YAC3B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,MAAM,IAAI,OAAO,CACf,qCAAqC,SAAS,CAAC,MAAM,IAAI,SAAS,MAAM,SAAS,CAAC,KAAK,EAAE,EACzF,6BAA6B,CAC9B,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC"}

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 export { checkPublishStatus } from './checkPublishStatus.js';
 export { deployChangedFiles, type DeployChangedFilesOptions, type DeployComponentFailure, type DeployChangedFilesResult, } from './deployChangedFiles.js';
-export { publishCommunity, type PublishCommunityOptions } from './publishCommunity.js';
+export { publishCommunity, DEFAULT_PUBLISH_REQUEST_TIMEOUT, type PublishCommunityOptions } from './publishCommunity.js';
 export { resolveSearchRoots, resolveRetrieveDestination, resolveSiteFile, resolveNetworkFile, } from './resolveSiteFiles.js';
 export { retrieveCustomSite } from './retrieveCustomSite.js';
 export { patchCustomSiteXml, type PatchCustomSiteXmlOptions, type PatchCustomSiteXmlResult, patchNetworkXml, readNetworkSiteName, } from './siteMetadataXml.js';

package/lib/index.js

@@ -21,7 +21,7 @@
 // it.
 export { checkPublishStatus } from './checkPublishStatus.js';
 export { deployChangedFiles, } from './deployChangedFiles.js';
-export { publishCommunity } from './publishCommunity.js';
+export { publishCommunity, DEFAULT_PUBLISH_REQUEST_TIMEOUT } from './publishCommunity.js';
 export { resolveSearchRoots, resolveRetrieveDestination, resolveSiteFile, resolveNetworkFile, } from './resolveSiteFiles.js';
 export { retrieveCustomSite } from './retrieveCustomSite.js';
 export { patchCustomSiteXml, patchNetworkXml, readNetworkSiteName, } from './siteMetadataXml.js';

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,mGAAmG;AACnG,iGAAiG;AACjG,qGAAqG;AACrG,kGAAkG;AAClG,oGAAoG;AACpG,MAAM;AAEN,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EACL,kBAAkB,GAInB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAgC,MAAM,uBAAuB,CAAC;AACvF,OAAO,EACL,kBAAkB,EAClB,0BAA0B,EAC1B,eAAe,EACf,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EACL,kBAAkB,EAGlB,eAAe,EACf,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAkD,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,mGAAmG;AACnG,iGAAiG;AACjG,qGAAqG;AACrG,kGAAkG;AAClG,oGAAoG;AACpG,MAAM;AAEN,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EACL,kBAAkB,GAInB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,+BAA+B,EAAgC,MAAM,uBAAuB,CAAC;AACxH,OAAO,EACL,kBAAkB,EAClB,0BAA0B,EAC1B,eAAe,EACf,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EACL,kBAAkB,EAGlB,eAAe,EACf,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAkD,MAAM,mBAAmB,CAAC"}

package/lib/publishCommunity.d.ts

@@ -1,4 +1,6 @@
+import { Duration } from '@salesforce/kit';
 import type { Connection } from '@salesforce/core';
+export { DEFAULT_PUBLISH_REQUEST_TIMEOUT } from './requestTimeout.js';
 /** The response shape of `POST /connect/communities/{id}/publish`. */
 type CommunityPublishResponse = {
     id: string;
@@ -16,6 +18,12 @@ export type PublishCommunityOptions = {
     retryAttempts?: number;
     /** Factor the retry delay grows by after each failed attempt. Defaults to 2. */
     retryBackoff?: number;
+    /**
+     * Bounds each individual Connect/SOQL request this makes against the org. Defaults to
+     * {@link DEFAULT_PUBLISH_REQUEST_TIMEOUT}; overridable mainly so tests don't have to wait out the
+     * real default.
+     */
+    requestTimeout?: Duration;
 };
 /**
  * Trigger a community publish via the Connect REST API and poll until the job reaches a terminal
@@ -30,4 +38,3 @@ export type PublishCommunityOptions = {
  * @throws If the initial publish request fails and retries (if any) are exhausted.
  */
 export declare function publishCommunity(options: PublishCommunityOptions): Promise<CommunityPublishResponse>;
-export {};

package/lib/publishCommunity.js

@@ -17,6 +17,8 @@ import { Duration } from '@salesforce/kit';
 import { PollingClient } from '@salesforce/core';
 import { retryWithBackoff } from '@simplysf/simply-core';
 import { checkPublishStatus } from './checkPublishStatus.js';
+import { DEFAULT_PUBLISH_REQUEST_TIMEOUT } from './requestTimeout.js';
+export { DEFAULT_PUBLISH_REQUEST_TIMEOUT } from './requestTimeout.js';
 /**
  * Trigger a community publish via the Connect REST API and poll until the job reaches a terminal
  * state, throwing if it fails.
@@ -30,12 +32,17 @@ import { checkPublishStatus } from './checkPublishStatus.js';
  * @throws If the initial publish request fails and retries (if any) are exhausted.
  */
 export async function publishCommunity(options) {
+    const requestTimeout = options.requestTimeout ?? DEFAULT_PUBLISH_REQUEST_TIMEOUT;
     const publishResponse = await retryWithBackoff(async () => options.connection.request({
         method: 'POST',
         url: `/connect/communities/${options.networkId}/publish`,
-    }), { retryAttempts: options.retryAttempts ?? 0, backoffFactor: options.retryBackoff ?? 2 });
+    }), {
+        retryAttempts: options.retryAttempts ?? 0,
+        backoffFactor: options.retryBackoff ?? 2,
+        attemptTimeout: requestTimeout,
+    });
     const client = await PollingClient.create({
-        poll: checkPublishStatus(options.connection, publishResponse.jobId),
+        poll: checkPublishStatus(options.connection, publishResponse.jobId, requestTimeout),
         frequency: Duration.seconds(15),
         timeout: Duration.minutes(options.wait),
         timeoutErrorName: 'CommunityPublishTimeoutError',

package/lib/publishCommunity.js.map

@@ -1 +1 @@
-{"version":3,"file":"publishCommunity.js","sourceRoot":"","sources":["../src/publishCommunity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAiB7D;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAgC;IACrE,MAAM,eAAe,GAAG,MAAM,gBAAgB,CAC5C,KAAK,IAAI,EAAE,CACT,OAAO,CAAC,UAAU,CAAC,OAAO,CAA2B;QACnD,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,wBAAwB,OAAO,CAAC,SAAS,UAAU;KACzD,CAAC,EACJ,EAAE,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,YAAY,IAAI,CAAC,EAAE,CACxF,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC;QACxC,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,KAAK,CAAC;QACnE,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,gBAAgB,EAAE,8BAA8B;KACjD,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;IAEzB,OAAO,eAAe,CAAC;AACzB,CAAC"}
+{"version":3,"file":"publishCommunity.js","sourceRoot":"","sources":["../src/publishCommunity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAuBtE;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAgC;IACrE,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,+BAA+B,CAAC;IAEjF,MAAM,eAAe,GAAG,MAAM,gBAAgB,CAC5C,KAAK,IAAI,EAAE,CACT,OAAO,CAAC,UAAU,CAAC,OAAO,CAA2B;QACnD,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,wBAAwB,OAAO,CAAC,SAAS,UAAU;KACzD,CAAC,EACJ;QACE,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,CAAC;QACzC,aAAa,EAAE,OAAO,CAAC,YAAY,IAAI,CAAC;QACxC,cAAc,EAAE,cAAc;KAC/B,CACF,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC;QACxC,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,KAAK,EAAE,cAAc,CAAC;QACnF,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,gBAAgB,EAAE,8BAA8B;KACjD,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;IAEzB,OAAO,eAAe,CAAC;AACzB,CAAC"}

package/lib/requestTimeout.d.ts

@@ -0,0 +1,7 @@
+import { Duration } from '@salesforce/kit';
+/**
+ * Bounds a single attempt at any Connect/SOQL call this package makes against the org, so a stalled
+ * TCP/TLS handshake (e.g. a CI runner's network path to the org differing from a desktop's) fails
+ * fast instead of hanging forever. See docs/design/0040-community-publish-request-timeouts.md.
+ */
+export declare const DEFAULT_PUBLISH_REQUEST_TIMEOUT: Duration;

package/lib/requestTimeout.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2026, SimplySF.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Duration } from '@salesforce/kit';
+/**
+ * Bounds a single attempt at any Connect/SOQL call this package makes against the org, so a stalled
+ * TCP/TLS handshake (e.g. a CI runner's network path to the org differing from a desktop's) fails
+ * fast instead of hanging forever. See docs/design/0040-community-publish-request-timeouts.md.
+ */
+export const DEFAULT_PUBLISH_REQUEST_TIMEOUT = Duration.seconds(30);
+//# sourceMappingURL=requestTimeout.js.map

package/lib/requestTimeout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestTimeout.js","sourceRoot":"","sources":["../src/requestTimeout.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@simplysf/simply-community-core",
   "description": "Community publish/deploy/domain-verification logic and site-file discovery — the library layer behind @simplysf/simply-community, published separately for direct consumption (e.g. editor tooling, CI scripts) without the CLI framework",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "author": "@ClayChipps",
   "homepage": "https://github.com/SimplySF/simply-plugins-core",
   "bugs": "https://github.com/SimplySF/simply-plugins-core/issues",
@@ -41,7 +41,7 @@
     "@salesforce/core": "^8.30.0",
     "@salesforce/kit": "^3.2.6",
     "@salesforce/source-deploy-retrieve": "^12.37.2",
-    "@simplysf/simply-core": "^1.6.5",
+    "@simplysf/simply-core": "^1.6.7",
     "glob": "^13.0.6",
     "xmlbuilder2": "^4.0.3"
   },
@@ -135,5 +135,5 @@
       "output": []
     }
   },
-  "gitHead": "ee0ec7ad3da298db4005467eaf3749cae9f46876"
+  "gitHead": "d622401adb05e1d637da5ef33a96c2311cd98e8e"
 }