@simplysf/simply-community-core 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +15 -14
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -16,20 +16,21 @@ Requires Node.js `>=22` and either `"type": "module"` or a dynamic `import()`
16
16
 
17
17
  Everything below is exported from the package root. Removing or renaming an export is a breaking change; see [`src/index.ts`](src/index.ts).
18
18
 
19
- | Export | Description |
20
- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
21
- | `publishCommunity(options)` | Triggers a community publish via the Connect REST API and polls until it completes. |
22
- | `checkPublishStatus(connection, jobId)` | Builds the `PollingClient`-compatible poll function `publishCommunity` uses. |
23
- | `deployChangedFiles(options)` | Deploys a specific file list and polls until the deploy reaches a terminal state. |
24
- | `retrieveCustomSite(connection, site, outputDirectory)` | Retrieves a single `CustomSite` component by name. |
25
- | `resolveSearchRoots(directory?, projectDir?)` | Resolves the root directories a site/network lookup should search under. |
26
- | `resolveRetrieveDestination(directory?, projectDir?)` | Resolves the single directory a retrieve should write into. |
27
- | `resolveSiteFile(site, roots)` | Finds the `sites/<site>.site-meta.xml` file for a CustomSite API name. |
28
- | `resolveNetworkFile(site, roots)` | Finds the `networks/*.network-meta.xml` file whose `<site>` element names a CustomSite. |
29
- | `patchCustomSiteXml(xml, options)` | Pure function: replaces a `CustomSite` metadata document's custom URLs with exactly one. |
30
- | `patchNetworkXml(xml, pathPrefix)` | Pure function: patches a `Network` metadata document's `urlPathPrefix`. |
31
- | `readNetworkSiteName(xml)` | Pure function: reads a `Network` metadata document's `<site>` element. |
32
- | `verifyDomain(connection, domain)` | Checks whether a custom domain is registered in the target org, and what it's already bound to. |
19
+ | Export | Description |
20
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
21
+ | `publishCommunity(options)` | Triggers a community publish via the Connect REST API and polls until it completes. |
22
+ | `checkPublishStatus(connection, jobId)` | Builds the `PollingClient`-compatible poll function `publishCommunity` uses. |
23
+ | `deployChangedFiles(options)` | Deploys a specific file list and polls until the deploy reaches a terminal state. |
24
+ | `retrieveCustomSite(connection, site, outputDirectory)` | Retrieves a single `CustomSite` component by name. |
25
+ | `resolveSearchRoots(directory?, projectDir?)` | Resolves the root directories a site/network lookup should search under. |
26
+ | `resolveRetrieveDestination(directory?, projectDir?)` | Resolves the single directory a retrieve should write into. |
27
+ | `resolveSiteFile(site, roots)` | Finds the `sites/<site>.site-meta.xml` file for a CustomSite API name. |
28
+ | `resolveNetworkFile(site, roots)` | Finds the `networks/*.network-meta.xml` file whose `<site>` element names a CustomSite. |
29
+ | `patchCustomSiteXml(xml, options)` | Pure function: replaces a `CustomSite` metadata document's custom URLs with exactly one. |
30
+ | `patchNetworkXml(xml, pathPrefix)` | Pure function: patches a `Network` metadata document's `urlPathPrefix`. |
31
+ | `readNetworkSiteName(xml)` | Pure function: reads a `Network` metadata document's `<site>` element. |
32
+ | `verifyDomain(connection, domain)` | Checks whether a custom domain is registered in the target org, and what it's already bound to. |
33
+ | `PublishCommunityOptions`, `DeployChangedFilesOptions`, `DeployChangedFilesResult`, `DeployComponentFailure`, `PatchCustomSiteXmlOptions`, `PatchCustomSiteXmlResult`, `DomainCheckStatus`, `DomainCheckResult` | Option and result types for `publishCommunity`, `deployChangedFiles`, `patchCustomSiteXml`, and `verifyDomain`. |
33
34
 
34
35
  ```ts
35
36
  import { publishCommunity } from '@simplysf/simply-community-core';
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@simplysf/simply-community-core",
3
3
  "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",
4
- "version": "0.2.1",
4
+ "version": "0.2.3",
5
5
  "author": "@ClayChipps",
6
6
  "homepage": "https://github.com/SimplySF/simply-node",
7
7
  "bugs": "https://github.com/SimplySF/simply-node/issues",
@@ -41,7 +41,7 @@
41
41
  "@salesforce/core": "^8.30.0",
42
42
  "@salesforce/kit": "^3.2.6",
43
43
  "@salesforce/source-deploy-retrieve": "^12.37.2",
44
- "@simplysf/simply-core": "^1.6.0",
44
+ "@simplysf/simply-core": "^1.6.2",
45
45
  "glob": "^13.0.6",
46
46
  "xmlbuilder2": "^4.0.3"
47
47
  },
@@ -135,5 +135,5 @@
135
135
  "output": []
136
136
  }
137
137
  },
138
- "gitHead": "88c3e9418f25a283b7335450e25ce7fdec21f825"
138
+ "gitHead": "00377b58018d2b1a7034c77389daba7c0fa0c246"
139
139
  }