@simplysf/simply-settings-core 0.0.0-stage → 0.2.0

package/LICENSE.txt

@@ -0,0 +1,206 @@
+Apache License Version 2.0
+
+Copyright (c) 2026, SimplySF.
+All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.

package/README.md

@@ -1,3 +1,82 @@
-# Temporary Holding Version
+# @simplysf/simply-settings-core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![NPM](https://img.shields.io/npm/v/@simplysf/simply-settings-core?label=@simplysf/simply-settings-core)](https://npmjs.com/@simplysf/simply-settings-core) [![Downloads/week](https://img.shields.io/npm/dw/@simplysf/simply-settings-core.svg)](https://npmjs.com/@simplysf/simply-settings-core) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://raw.githubusercontent.com/SimplySF/simply-plugins-core/main/LICENSE.txt)
+
+State and Country/Territory picklist automation. This package creates states through Setup's
+_Configure New State_ form, which no Salesforce API can do. It also activates them by deploying
+`AddressSettings`. It is not a Salesforce CLI plugin. It's the library layer behind
+[`@simplysf/simply-settings`](https://github.com/SimplySF/simply-plugins/tree/main/packages/simply-settings)'s
+`settings address state` commands, published separately so anything can import the same logic
+without pulling in the CLI framework: an editor extension, a CI job, a script.
+
+## Install
+
+```bash
+npm install @simplysf/simply-settings-core
+```
+
+Requires Node.js `>=22` and either `"type": "module"` or a dynamic `import()`. This package ships ESM only.
+
+## API
+
+Everything below is exported from the package root. Removing or renaming an export is a breaking change; see [`src/index.ts`](src/index.ts).
+
+| Export                                                                      | Description                                                                                                                                                            |
+| --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `parseStateDefinitions(json)`                                               | Validates a `{ "US-CA": "California" }` object into `StateDefinition[]`, naming the first bad entry.                                                                   |
+| `filterStateDefinitions(definitions, countries?)`                           | Narrows definitions to ISO country codes. Fails on a malformed code or a country with no definitions.                                                                  |
+| `formatStateKey(definition)`                                                | `US-CA` for a definition.                                                                                                                                              |
+| `retrieveAddressSettingsXml(options)` / `deployAddressSettingsXml(options)` | Metadata API retrieve/deploy of the org's `Address` settings, as `Address.settings-meta.xml` text. A failed deploy is reported in the result, not thrown.              |
+| `parseAddressSettingsXml(xml)`                                              | The countries and states in a settings file, with ISO codes kept as strings (Andorra's `02` stays `02`).                                                               |
+| `planStateCreation(definitions, settings)`                                  | Splits definitions into `pending` (to submit) and `settled` (`exists`, `country-missing`) without any Setup traffic.                                                   |
+| `openSetupSession(options)` / `SetupSession`                                | A cookie-carrying session on the org's Setup pages, opened through a single-use frontdoor URL (the mechanism `sf org open` uses).                                      |
+| `createState(session, definition, options?)`                                | Submits one state through _Configure New State_ and classifies the result. Retries transport failures, and reports per-state problems as `failed` instead of throwing. |
+| `createStates(options)`                                                     | Runs `createState` over many states, `concurrency` at a time (default `DEFAULT_CREATE_CONCURRENCY`, 4).                                                                |
+| `parseNewStateForm(html)` / `fillNewStateForm(form, definition)`            | Finds the form by its fields' stable id suffixes, not Visualforce's generated ids, and builds the submission.                                                          |
+| `classifyNewStateResponse(response)`                                        | Maps a form POST response to `created`, `exists`, `rejected`, `country-missing`, or `failed`.                                                                          |
+| `planStateActivation(xml, definitions)`                                     | Sets `<active>`/`<visible>` on exactly the listed states. Every other state and country is untouched.                                                                  |
+| `activateStates(options)`                                                   | Retrieve, `planStateActivation`, then deploy. Supports `dryRun`.                                                                                                       |
+| `isLoginPage(response)`, `NEW_STATE_FORM_PATH`, `SetupTransportError`       | Supporting helpers and constants.                                                                                                                                      |
+
+```ts
+import {
+  createStates,
+  openSetupSession,
+  parseAddressSettingsXml,
+  parseStateDefinitions,
+  planStateCreation,
+  retrieveAddressSettingsXml,
+} from '@simplysf/simply-settings-core';
+import { Duration } from '@salesforce/kit';
+
+const definitions = parseStateDefinitions({ 'US-GU': 'Guam', 'AD-02': 'Canillo' });
+const settings = parseAddressSettingsXml(await retrieveAddressSettingsXml({ connection, wait: Duration.minutes(10) }));
+const { pending, settled } = planStateCreation(definitions, settings);
+
+const session = await openSetupSession({ connection });
+const outcomes = await createStates({ session, states: pending, onProgress: (outcome) => console.log(outcome) });
+```
+
+```ts
+import { activateStates, parseStateDefinitions } from '@simplysf/simply-settings-core';
+import { Duration } from '@salesforce/kit';
+
+const result = await activateStates({
+  connection,
+  wait: Duration.minutes(10),
+  states: parseStateDefinitions({ 'US-GU': 'Guam' }),
+});
+// result.activated / alreadyActive / notInOrg, and result.deploy if a deploy ran
+```
+
+Opening a Setup session needs an access token that can reach the UI (the `web` or `full` OAuth
+scope), as granted by `sf org login web`. Without one, `openSetupSession` throws a
+`SetupSessionError` before anything is submitted.
+
+## Issues
+
+Please report any issues at https://github.com/SimplySF/simply-plugins-core/issues
+
+## Contributing
+
+This package is part of the [`@simplysf/simply`](https://github.com/SimplySF/simply-plugins-core) monorepo. See [CONTRIBUTING.md](CONTRIBUTING.md) for what's specific to this package, and the repo's [root CONTRIBUTING.md](https://github.com/SimplySF/simply-plugins-core/blob/main/CONTRIBUTING.md) for repo structure, setup, commit conventions, and how to submit a pull request. Please also read our [Code of Conduct](https://github.com/SimplySF/simply-plugins-core/blob/main/CODE_OF_CONDUCT.md).

package/lib/address/activateStates.d.ts

@@ -0,0 +1,23 @@
+import { type AddressSettingsDeployResult, type AddressSettingsTransferOptions } from './addressSettingsTransfer.js';
+import type { StateDefinition } from './stateDefinitions.js';
+export type ActivateStatesOptions = AddressSettingsTransferOptions & {
+    states: StateDefinition[];
+    /** Plan only: report what would change, deploy nothing. */
+    dryRun?: boolean;
+};
+export type ActivateStatesResult = {
+    activated: StateDefinition[];
+    alreadyActive: StateDefinition[];
+    notInOrg: StateDefinition[];
+    /** Present when a deploy ran — not for a dry run, or when nothing needed changing. */
+    deploy?: AddressSettingsDeployResult;
+};
+/**
+ * Sets the given states active and visible: retrieves the org's AddressSettings, flips
+ * `<active>`/`<visible>` on exactly those states, and deploys the result back.
+ *
+ * @param options - Connection, states, wait, and dry-run.
+ * @returns How each state was handled, and the deploy result if one ran. A failed deploy is
+ * reported in `deploy.success`/`deploy.failures`, not thrown.
+ */
+export declare function activateStates(options: ActivateStatesOptions): Promise<ActivateStatesResult>;

package/lib/address/activateStates.js

@@ -0,0 +1,34 @@
+/*
+ * 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 { planStateActivation } from './addressSettingsXml.js';
+import { deployAddressSettingsXml, retrieveAddressSettingsXml, } from './addressSettingsTransfer.js';
+/**
+ * Sets the given states active and visible: retrieves the org's AddressSettings, flips
+ * `<active>`/`<visible>` on exactly those states, and deploys the result back.
+ *
+ * @param options - Connection, states, wait, and dry-run.
+ * @returns How each state was handled, and the deploy result if one ran. A failed deploy is
+ * reported in `deploy.success`/`deploy.failures`, not thrown.
+ */
+export async function activateStates(options) {
+    const xml = await retrieveAddressSettingsXml(options);
+    const { xml: updatedXml, ...plan } = planStateActivation(xml, options.states);
+    if (options.dryRun || updatedXml === undefined) {
+        return plan;
+    }
+    return { ...plan, deploy: await deployAddressSettingsXml({ ...options, xml: updatedXml }) };
+}
+//# sourceMappingURL=activateStates.js.map

package/lib/address/activateStates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activateStates.js","sourceRoot":"","sources":["../../src/address/activateStates.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EACL,wBAAwB,EACxB,0BAA0B,GAG3B,MAAM,8BAA8B,CAAC;AAiBtC;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAA8B;IACjE,MAAM,GAAG,GAAG,MAAM,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,mBAAmB,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9E,IAAI,OAAO,CAAC,MAAM,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;AAC9F,CAAC"}

package/lib/address/addressSettingsTransfer.d.ts

@@ -0,0 +1,42 @@
+import { type Connection } from '@salesforce/core';
+import type { Duration } from '@salesforce/kit';
+export type AddressSettingsTransferOptions = {
+    connection: Connection;
+    /** How long to poll the retrieve/deploy before giving up. */
+    wait: Duration;
+};
+export type AddressSettingsDeployFailure = {
+    fullName: string;
+    type: string;
+    error: string;
+};
+export type AddressSettingsDeployResult = {
+    id: string;
+    status: string;
+    success: boolean;
+    failures: AddressSettingsDeployFailure[];
+};
+/**
+ * Retrieves the org's `Address` settings (the `AddressSettings` metadata type, which holds every
+ * country and state in State and Country/Territory Picklists).
+ *
+ * A Metadata API retrieve rather than a `readMetadata` call, because what comes back is then
+ * exactly the source-format file `deployAddressSettingsXml` sends back — one representation for
+ * both reading and writing, with no type coercion in between.
+ *
+ * @param options - The org connection and how long to wait for the retrieve.
+ * @returns The `Address.settings-meta.xml` file's text.
+ */
+export declare function retrieveAddressSettingsXml(options: AddressSettingsTransferOptions): Promise<string>;
+/**
+ * Deploys `Address.settings-meta.xml` content to the org and polls to completion.
+ *
+ * Does not throw on a failed deploy — the failure is reported in the result (`success: false`,
+ * populated `failures`). An error here means the deploy request or polling itself broke.
+ *
+ * @param options - The org connection, the settings XML, and how long to wait.
+ * @returns The deploy's id, terminal status, and component failures.
+ */
+export declare function deployAddressSettingsXml(options: AddressSettingsTransferOptions & {
+    xml: string;
+}): Promise<AddressSettingsDeployResult>;

package/lib/address/addressSettingsTransfer.js

@@ -0,0 +1,90 @@
+/*
+ * 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 { mkdtemp, mkdir, readFile, rm, writeFile } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import path from 'node:path';
+import { SfError } from '@salesforce/core';
+import { ComponentSet, ComponentStatus } from '@salesforce/source-deploy-retrieve';
+const SETTINGS_FILE = path.join('settings', 'Address.settings-meta.xml');
+async function withTempDir(fn) {
+    const dir = await mkdtemp(path.join(tmpdir(), 'simply-settings-'));
+    try {
+        return await fn(dir);
+    }
+    finally {
+        await rm(dir, { recursive: true, force: true });
+    }
+}
+/**
+ * Retrieves the org's `Address` settings (the `AddressSettings` metadata type, which holds every
+ * country and state in State and Country/Territory Picklists).
+ *
+ * A Metadata API retrieve rather than a `readMetadata` call, because what comes back is then
+ * exactly the source-format file `deployAddressSettingsXml` sends back — one representation for
+ * both reading and writing, with no type coercion in between.
+ *
+ * @param options - The org connection and how long to wait for the retrieve.
+ * @returns The `Address.settings-meta.xml` file's text.
+ */
+export async function retrieveAddressSettingsXml(options) {
+    return withTempDir(async (dir) => {
+        const componentSet = new ComponentSet([{ fullName: 'Address', type: 'Settings' }]);
+        const retrieve = await componentSet.retrieve({
+            usernameOrConnection: options.connection,
+            output: dir,
+            merge: false,
+        });
+        const result = await retrieve.pollStatus({ timeout: options.wait });
+        const file = result
+            .getFileResponses()
+            .find((response) => response.state !== ComponentStatus.Failed && response.filePath?.endsWith('.settings-meta.xml'));
+        if (!file?.filePath) {
+            const messages = result.getFileResponses().flatMap((response) => ('error' in response ? [response.error] : []));
+            throw new SfError(`Couldn't retrieve AddressSettings from the org.${messages.length > 0 ? ` ${messages.join(' ')}` : ''}`, 'AddressSettingsRetrieveError');
+        }
+        return readFile(file.filePath, 'utf8');
+    });
+}
+/**
+ * Deploys `Address.settings-meta.xml` content to the org and polls to completion.
+ *
+ * Does not throw on a failed deploy — the failure is reported in the result (`success: false`,
+ * populated `failures`). An error here means the deploy request or polling itself broke.
+ *
+ * @param options - The org connection, the settings XML, and how long to wait.
+ * @returns The deploy's id, terminal status, and component failures.
+ */
+export async function deployAddressSettingsXml(options) {
+    return withTempDir(async (dir) => {
+        const filePath = path.join(dir, SETTINGS_FILE);
+        await mkdir(path.dirname(filePath), { recursive: true });
+        await writeFile(filePath, options.xml, 'utf8');
+        const deploy = await ComponentSet.fromSource(filePath).deploy({ usernameOrConnection: options.connection });
+        const result = await deploy.pollStatus({ timeout: options.wait });
+        const failures = result
+            .getFileResponses()
+            .flatMap((response) => response.state === ComponentStatus.Failed
+            ? [{ fullName: response.fullName, type: response.type, error: response.error }]
+            : []);
+        return {
+            id: result.response.id,
+            status: result.response.status,
+            success: result.response.success,
+            failures,
+        };
+    });
+}
+//# sourceMappingURL=addressSettingsTransfer.js.map

package/lib/address/addressSettingsTransfer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addressSettingsTransfer.js","sourceRoot":"","sources":["../../src/address/addressSettingsTransfer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAmB,MAAM,kBAAkB,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAqBnF,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,2BAA2B,CAAC,CAAC;AAEzE,KAAK,UAAU,WAAW,CAAI,EAA+B;IAC3D,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,CAAC;IACnE,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;YAAS,CAAC;QACT,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,OAAuC;IACtF,OAAO,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC/B,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACnF,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC;YAC3C,oBAAoB,EAAE,OAAO,CAAC,UAAU;YACxC,MAAM,EAAE,GAAG;YACX,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAEpE,MAAM,IAAI,GAAG,MAAM;aAChB,gBAAgB,EAAE;aAClB,IAAI,CACH,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,KAAK,eAAe,CAAC,MAAM,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAC7G,CAAC;QAEJ,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpB,MAAM,QAAQ,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAChH,MAAM,IAAI,OAAO,CACf,kDAAkD,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EACvG,8BAA8B,CAC/B,CAAC;QACJ,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,OAAyD;IAEzD,OAAO,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,MAAM,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAE/C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC5G,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAElE,MAAM,QAAQ,GAAG,MAAM;aACpB,gBAAgB,EAAE;aAClB,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpB,QAAQ,CAAC,KAAK,KAAK,eAAe,CAAC,MAAM;YACvC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC/E,CAAC,CAAC,EAAE,CACP,CAAC;QAEJ,OAAO;YACL,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;YACtB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;YAC9B,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO;YAChC,QAAQ;SACT,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/lib/address/addressSettingsXml.d.ts

@@ -0,0 +1,49 @@
+import type { StateDefinition } from './stateDefinitions.js';
+export type AddressSettingsState = {
+    isoCode: string;
+    label: string;
+    active: boolean;
+    visible: boolean;
+};
+export type AddressSettingsCountry = {
+    isoCode: string;
+    label: string;
+    active: boolean;
+    visible: boolean;
+    states: AddressSettingsState[];
+};
+/** The parts of an org's `AddressSettings` this package reads. */
+export type AddressSettings = {
+    countries: AddressSettingsCountry[];
+};
+export type StateActivationPlan = {
+    /**
+     * The settings XML with every `activated` state set active and visible, or `undefined` when
+     * `activated` is empty — there is nothing to deploy.
+     */
+    xml?: string;
+    /** Definitions whose state was inactive or hidden and is now set active and visible. */
+    activated: StateDefinition[];
+    /** Definitions whose state was already active and visible. */
+    alreadyActive: StateDefinition[];
+    /** Definitions with no matching state in the org (not created yet, or the country is absent). */
+    notInOrg: StateDefinition[];
+};
+/**
+ * Reads the countries and states out of an `Address.settings-meta.xml` document.
+ *
+ * @param xml - The settings file's text, as retrieved.
+ * @returns Every country with its states, in document order.
+ * @throws SfError when the document isn't AddressSettings or has no countries (State and
+ * Country/Territory Picklists not enabled).
+ */
+export declare function parseAddressSettingsXml(xml: string): AddressSettings;
+/**
+ * Sets `<active>` and `<visible>` to `true` on exactly the states named by `definitions`, leaving
+ * every other state and every country untouched.
+ *
+ * @param xml - The settings file's text, as retrieved from the same org it will be deployed to.
+ * @param definitions - The states to activate.
+ * @returns The rewritten XML (only when something changed) and how each definition was handled.
+ */
+export declare function planStateActivation(xml: string, definitions: StateDefinition[]): StateActivationPlan;