sf-flow-coverage 0.0.0-stage → 0.0.1

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 (55) hide show
  1. package/LICENSE.md +9 -0
  2. package/README.md +275 -2
  3. package/lib/commands/flowcov/gate.d.ts +17 -0
  4. package/lib/commands/flowcov/gate.js +82 -0
  5. package/lib/commands/flowcov/gate.js.map +1 -0
  6. package/lib/commands/flowcov/readiness.d.ts +17 -0
  7. package/lib/commands/flowcov/readiness.js +87 -0
  8. package/lib/commands/flowcov/readiness.js.map +1 -0
  9. package/lib/commands/flowcov/scaffold.d.ts +18 -0
  10. package/lib/commands/flowcov/scaffold.js +76 -0
  11. package/lib/commands/flowcov/scaffold.js.map +1 -0
  12. package/lib/core/apexTemplate.d.ts +18 -0
  13. package/lib/core/apexTemplate.js +310 -0
  14. package/lib/core/apexTemplate.js.map +1 -0
  15. package/lib/core/flowTypes.d.ts +16 -0
  16. package/lib/core/flowTypes.js +29 -0
  17. package/lib/core/flowTypes.js.map +1 -0
  18. package/lib/core/flowXml.d.ts +8 -0
  19. package/lib/core/flowXml.js +97 -0
  20. package/lib/core/flowXml.js.map +1 -0
  21. package/lib/core/gate.d.ts +20 -0
  22. package/lib/core/gate.js +92 -0
  23. package/lib/core/gate.js.map +1 -0
  24. package/lib/core/git.d.ts +13 -0
  25. package/lib/core/git.js +81 -0
  26. package/lib/core/git.js.map +1 -0
  27. package/lib/core/orgCoverageSource.d.ts +17 -0
  28. package/lib/core/orgCoverageSource.js +108 -0
  29. package/lib/core/orgCoverageSource.js.map +1 -0
  30. package/lib/core/projectFiles.d.ts +9 -0
  31. package/lib/core/projectFiles.js +48 -0
  32. package/lib/core/projectFiles.js.map +1 -0
  33. package/lib/core/readiness.d.ts +12 -0
  34. package/lib/core/readiness.js +37 -0
  35. package/lib/core/readiness.js.map +1 -0
  36. package/lib/core/requiredFields.d.ts +27 -0
  37. package/lib/core/requiredFields.js +75 -0
  38. package/lib/core/requiredFields.js.map +1 -0
  39. package/lib/core/scaffold.d.ts +18 -0
  40. package/lib/core/scaffold.js +79 -0
  41. package/lib/core/scaffold.js.map +1 -0
  42. package/lib/core/toolingQuery.d.ts +7 -0
  43. package/lib/core/toolingQuery.js +16 -0
  44. package/lib/core/toolingQuery.js.map +1 -0
  45. package/lib/core/types.d.ts +117 -0
  46. package/lib/core/types.js +2 -0
  47. package/lib/core/types.js.map +1 -0
  48. package/lib/index.d.ts +14 -0
  49. package/lib/index.js +10 -0
  50. package/lib/index.js.map +1 -0
  51. package/messages/flowcov.gate.md +49 -0
  52. package/messages/flowcov.readiness.md +39 -0
  53. package/messages/flowcov.scaffold.md +59 -0
  54. package/oclif.manifest.json +317 -0
  55. package/package.json +311 -3
@@ -0,0 +1,81 @@
1
+ import { execFile } from 'node:child_process';
2
+ import { promisify } from 'node:util';
3
+ import { flowNameFromPath } from './flowTypes.js';
4
+ const execFileAsync = promisify(execFile);
5
+ const FLOW_PATHSPECS = ['*.flow-meta.xml', '*.flow'];
6
+ const MAX_BUFFER = 64 * 1024 * 1024;
7
+ async function git(cwd, args) {
8
+ const { stdout } = await execFileAsync('git', ['-c', 'core.quotePath=false', ...args], {
9
+ cwd,
10
+ maxBuffer: MAX_BUFFER,
11
+ windowsHide: true,
12
+ });
13
+ return stdout;
14
+ }
15
+ export async function isGitRepo(cwd) {
16
+ try {
17
+ return (await git(cwd, ['rev-parse', '--is-inside-work-tree'])).trim() === 'true';
18
+ }
19
+ catch {
20
+ return false;
21
+ }
22
+ }
23
+ async function hasCommits(cwd) {
24
+ try {
25
+ await git(cwd, ['rev-parse', '--verify', '--quiet', 'HEAD']);
26
+ return true;
27
+ }
28
+ catch {
29
+ return false;
30
+ }
31
+ }
32
+ /**
33
+ * Counts commits that touched each Flow file, keyed by Flow API name.
34
+ * Returns undefined when `cwd` is not inside a git repository.
35
+ */
36
+ export async function getFlowChurn(cwd, since) {
37
+ if (!(await isGitRepo(cwd)))
38
+ return undefined;
39
+ // A repository with no commits yet has no history to count (and `git log` would fail).
40
+ if (!(await hasCommits(cwd)))
41
+ return new Map();
42
+ const args = ['log', '--format=', '--name-only'];
43
+ if (since)
44
+ args.push(`--since=${since}`);
45
+ const output = await git(cwd, [...args, '--', ...FLOW_PATHSPECS]);
46
+ const churn = new Map();
47
+ for (const line of output.split('\n')) {
48
+ const name = flowNameFromPath(line.trim());
49
+ if (name)
50
+ churn.set(name, (churn.get(name) ?? 0) + 1);
51
+ }
52
+ return churn;
53
+ }
54
+ /**
55
+ * Flow files added, modified, or renamed between the merge base of `from` and `to`
56
+ * (the same range a pull request shows). Paths are relative to the repository root.
57
+ */
58
+ export async function getChangedFlowFiles(cwd, from, to) {
59
+ const output = await git(cwd, [
60
+ 'diff',
61
+ '--name-status',
62
+ '--diff-filter=AMR',
63
+ `${from}...${to}`,
64
+ '--',
65
+ ...FLOW_PATHSPECS,
66
+ ]);
67
+ const paths = [];
68
+ for (const line of output.split('\n')) {
69
+ const parts = line.split('\t');
70
+ // Renames are "R100<TAB>old<TAB>new"; everything else is "M<TAB>path".
71
+ const filePath = parts.at(-1)?.trim();
72
+ if (parts.length >= 2 && filePath && flowNameFromPath(filePath))
73
+ paths.push(filePath);
74
+ }
75
+ return paths;
76
+ }
77
+ /** Reads a file's content at a git revision. `filePath` is relative to the repository root. */
78
+ export async function showFileAtRevision(cwd, revision, filePath) {
79
+ return git(cwd, ['show', `${revision}:${filePath.replace(/\\/g, '/')}`]);
80
+ }
81
+ //# sourceMappingURL=git.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"git.js","sourceRoot":"","sources":["../../src/core/git.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAE1C,MAAM,cAAc,GAAG,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;AACrD,MAAM,UAAU,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAEpC,KAAK,UAAU,GAAG,CAAC,GAAW,EAAE,IAAc;IAC5C,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC,EAAE;QACrF,GAAG;QACH,SAAS,EAAE,UAAU;QACrB,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAW;IACzC,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,MAAM,CAAC;IACpF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,GAAW;IACnC,IAAI,CAAC;QACH,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,KAAc;IAC5D,IAAI,CAAC,CAAC,MAAM,SAAS,CAAC,GAAG,CAAC,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9C,uFAAuF;IACvF,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC;QAAE,OAAO,IAAI,GAAG,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;IACjD,IAAI,KAAK;QAAE,IAAI,CAAC,IAAI,CAAC,WAAW,KAAK,EAAE,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3C,IAAI,IAAI;YAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,GAAW,EAAE,IAAY,EAAE,EAAU;IAC7E,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,GAAG,EAAE;QAC5B,MAAM;QACN,eAAe;QACf,mBAAmB;QACnB,GAAG,IAAI,MAAM,EAAE,EAAE;QACjB,IAAI;QACJ,GAAG,cAAc;KAClB,CAAC,CAAC;IACH,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,uEAAuE;QACvE,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QACtC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,QAAQ,IAAI,gBAAgB,CAAC,QAAQ,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxF,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,+FAA+F;AAC/F,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,GAAW,EAAE,QAAgB,EAAE,QAAgB;IACtF,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3E,CAAC"}
@@ -0,0 +1,17 @@
1
+ import type { CoverageSource, FlowCoverage, ToolingQuery } from './types.js';
2
+ /** Reads Flow coverage from FlowTestCoverage, which Salesforce fills in when Apex tests run in the org. */
3
+ export declare class OrgCoverageSource implements CoverageSource {
4
+ private readonly query;
5
+ constructor(query: ToolingQuery);
6
+ listActiveCountedFlows(): Promise<FlowCoverage[]>;
7
+ getFlowCoverage(flowNames: string[]): Promise<FlowCoverage[]>;
8
+ private queryInChunks;
9
+ private buildCoverage;
10
+ /**
11
+ * Union of covered element names per FlowTestCoverage row, so element coverage reflects all
12
+ * tests together. Returns undefined if FlowElementTestCoverage can't be queried, in which case
13
+ * the best single test's count is used instead.
14
+ */
15
+ private loadCoveredElements;
16
+ private loadClassNames;
17
+ }
@@ -0,0 +1,108 @@
1
+ import { COUNTED_PROCESS_TYPES, qualifiedFlowName, splitFlowName } from './flowTypes.js';
2
+ const CHUNK_SIZE = 200;
3
+ const FLOW_FIELDS = 'Id, VersionNumber, ProcessType, Status, Definition.DeveloperName, Definition.NamespacePrefix';
4
+ /** Salesforce IDs come back as 18 characters, but compare on the case-sensitive 15-character form to be safe. */
5
+ const idKey = (id) => id.slice(0, 15);
6
+ function chunk(items, size = CHUNK_SIZE) {
7
+ const chunks = [];
8
+ for (let i = 0; i < items.length; i += size)
9
+ chunks.push(items.slice(i, i + size));
10
+ return chunks;
11
+ }
12
+ const soqlList = (values) => values.map((v) => `'${v.replace(/\\/g, '\\\\').replace(/'/g, "\\'")}'`).join(', ');
13
+ /** Reads Flow coverage from FlowTestCoverage, which Salesforce fills in when Apex tests run in the org. */
14
+ export class OrgCoverageSource {
15
+ query;
16
+ constructor(query) {
17
+ this.query = query;
18
+ }
19
+ async listActiveCountedFlows() {
20
+ const flows = await this.query(`SELECT ${FLOW_FIELDS} FROM Flow WHERE Status = 'Active' AND ProcessType IN (${soqlList([...COUNTED_PROCESS_TYPES])})`);
21
+ return this.buildCoverage(flows);
22
+ }
23
+ async getFlowCoverage(flowNames) {
24
+ if (flowNames.length === 0)
25
+ return [];
26
+ const wanted = new Set(flowNames);
27
+ const developerNames = [...new Set(flowNames.map((n) => splitFlowName(n).developerName))];
28
+ const definitions = await this.queryInChunks(developerNames, (list) => `SELECT Id, DeveloperName, NamespacePrefix, ActiveVersionId, LatestVersionId FROM FlowDefinition WHERE DeveloperName IN (${list})`);
29
+ const versionIds = definitions
30
+ .filter((d) => wanted.has(qualifiedFlowName(d.DeveloperName, d.NamespacePrefix)))
31
+ .map((d) => d.ActiveVersionId ?? d.LatestVersionId)
32
+ .filter((id) => !!id);
33
+ if (versionIds.length === 0)
34
+ return [];
35
+ const flows = await this.queryInChunks(versionIds, (list) => `SELECT ${FLOW_FIELDS} FROM Flow WHERE Id IN (${list})`);
36
+ return this.buildCoverage(flows);
37
+ }
38
+ async queryInChunks(values, buildSoql) {
39
+ const results = [];
40
+ for (const part of chunk(values)) {
41
+ // Sequential on purpose: keeps API usage predictable on large orgs.
42
+ results.push(...(await this.query(buildSoql(soqlList(part)))));
43
+ }
44
+ return results;
45
+ }
46
+ async buildCoverage(flows) {
47
+ const coverageRows = await this.queryInChunks(flows.map((f) => f.Id), (list) => `SELECT Id, FlowVersionId, ApexTestClassId, TestMethodName, NumElementsCovered, NumElementsNotCovered FROM FlowTestCoverage WHERE FlowVersionId IN (${list})`);
48
+ const coveredElements = await this.loadCoveredElements(coverageRows);
49
+ const classNames = await this.loadClassNames(coverageRows);
50
+ const rowsByVersion = new Map();
51
+ for (const row of coverageRows) {
52
+ const key = idKey(row.FlowVersionId);
53
+ rowsByVersion.set(key, [...(rowsByVersion.get(key) ?? []), row]);
54
+ }
55
+ return flows.map((flow) => {
56
+ const rows = rowsByVersion.get(idKey(flow.Id)) ?? [];
57
+ const elementsTotal = Math.max(0, ...rows.map((r) => (r.NumElementsCovered ?? 0) + (r.NumElementsNotCovered ?? 0)));
58
+ const bestSingleTest = Math.max(0, ...rows.map((r) => r.NumElementsCovered ?? 0));
59
+ const unionAcrossTests = coveredElements
60
+ ? new Set(rows.flatMap((r) => [...(coveredElements.get(idKey(r.Id)) ?? [])])).size
61
+ : 0;
62
+ const elementsCovered = Math.min(Math.max(bestSingleTest, unionAcrossTests), elementsTotal);
63
+ const tests = rows.map((r) => ({
64
+ className: (r.ApexTestClassId && classNames.get(idKey(r.ApexTestClassId))) || r.ApexTestClassId || 'unknown',
65
+ methodName: r.TestMethodName ?? 'unknown',
66
+ }));
67
+ return {
68
+ flowName: qualifiedFlowName(flow.Definition?.DeveloperName ?? flow.Id, flow.Definition?.NamespacePrefix),
69
+ flowVersionId: flow.Id,
70
+ versionNumber: flow.VersionNumber,
71
+ processType: flow.ProcessType,
72
+ status: flow.Status,
73
+ covered: rows.length > 0,
74
+ elementsCovered,
75
+ elementsTotal,
76
+ elementCoveragePercent: elementsTotal > 0 ? Math.round((elementsCovered / elementsTotal) * 1000) / 10 : 0,
77
+ tests,
78
+ };
79
+ });
80
+ }
81
+ /**
82
+ * Union of covered element names per FlowTestCoverage row, so element coverage reflects all
83
+ * tests together. Returns undefined if FlowElementTestCoverage can't be queried, in which case
84
+ * the best single test's count is used instead.
85
+ */
86
+ async loadCoveredElements(rows) {
87
+ if (rows.length === 0)
88
+ return new Map();
89
+ try {
90
+ const elements = await this.queryInChunks(rows.map((r) => r.Id), (list) => `SELECT FlowTestCoverageId, ElementName FROM FlowElementTestCoverage WHERE FlowTestCoverageId IN (${list})`);
91
+ const byRow = new Map();
92
+ for (const element of elements) {
93
+ const key = idKey(element.FlowTestCoverageId);
94
+ byRow.set(key, (byRow.get(key) ?? new Set()).add(element.ElementName));
95
+ }
96
+ return byRow;
97
+ }
98
+ catch {
99
+ return undefined;
100
+ }
101
+ }
102
+ async loadClassNames(rows) {
103
+ const ids = [...new Set(rows.map((r) => r.ApexTestClassId).filter((id) => !!id))];
104
+ const classes = await this.queryInChunks(ids, (list) => `SELECT Id, Name, NamespacePrefix FROM ApexClass WHERE Id IN (${list})`);
105
+ return new Map(classes.map((c) => [idKey(c.Id), c.NamespacePrefix ? `${c.NamespacePrefix}.${c.Name}` : c.Name]));
106
+ }
107
+ }
108
+ //# sourceMappingURL=orgCoverageSource.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"orgCoverageSource.js","sourceRoot":"","sources":["../../src/core/orgCoverageSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAmCzF,MAAM,UAAU,GAAG,GAAG,CAAC;AACvB,MAAM,WAAW,GAAG,8FAA8F,CAAC;AAEnH,iHAAiH;AACjH,MAAM,KAAK,GAAG,CAAC,EAAU,EAAU,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAEtD,SAAS,KAAK,CAAI,KAAU,EAAE,IAAI,GAAG,UAAU;IAC7C,MAAM,MAAM,GAAU,EAAE,CAAC;IACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI;QAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACnF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,MAAgB,EAAU,EAAE,CAC5C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAErF,2GAA2G;AAC3G,MAAM,OAAO,iBAAiB;IACQ,KAAK;IAAzC,YAAoC,KAAmB;qBAAnB,KAAK;IAAiB,CAAC;IAEpD,KAAK,CAAC,sBAAsB;QACjC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAC5B,UAAU,WAAW,0DAA0D,QAAQ,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,GAAG,CACvH,CAAC;QACF,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAmB;QAC9C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QAClC,MAAM,cAAc,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAC1F,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAC1C,cAAc,EACd,CAAC,IAAI,EAAE,EAAE,CACP,2HAA2H,IAAI,GAAG,CACrI,CAAC;QACF,MAAM,UAAU,GAAG,WAAW;aAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;aAChF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,IAAI,CAAC,CAAC,eAAe,CAAC;aAClD,MAAM,CAAC,CAAC,EAAE,EAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACtC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CACpC,UAAU,EACV,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,WAAW,2BAA2B,IAAI,GAAG,CAClE,CAAC;QACF,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAEO,KAAK,CAAC,aAAa,CACzB,MAAgB,EAChB,SAAmC;QAEnC,MAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,oEAAoE;YACpE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,KAAmB;QAC7C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAC3C,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACtB,CAAC,IAAI,EAAE,EAAE,CACP,sJAAsJ,IAAI,GAAG,CAChK,CAAC;QACF,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACrE,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAE3D,MAAM,aAAa,GAAG,IAAI,GAAG,EAAoC,CAAC;QAClE,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACrC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QACnE,CAAC;QAED,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACxB,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACrD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAC5B,CAAC,EACD,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,kBAAkB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,qBAAqB,IAAI,CAAC,CAAC,CAAC,CACjF,CAAC;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,kBAAkB,IAAI,CAAC,CAAC,CAAC,CAAC;YAClF,MAAM,gBAAgB,GAAG,eAAe;gBACtC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;gBAClF,CAAC,CAAC,CAAC,CAAC;YACN,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,gBAAgB,CAAC,EAAE,aAAa,CAAC,CAAC;YAC5F,MAAM,KAAK,GAAkB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC5C,SAAS,EAAE,CAAC,CAAC,CAAC,eAAe,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,IAAI,SAAS;gBAC5G,UAAU,EAAE,CAAC,CAAC,cAAc,IAAI,SAAS;aAC1C,CAAC,CAAC,CAAC;YACJ,OAAO;gBACL,QAAQ,EAAE,iBAAiB,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,IAAI,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC;gBACxG,aAAa,EAAE,IAAI,CAAC,EAAE;gBACtB,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,OAAO,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC;gBACxB,eAAe;gBACf,aAAa;gBACb,sBAAsB,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,eAAe,GAAG,aAAa,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;gBACzG,KAAK;aACN,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,mBAAmB,CAAC,IAA8B;QAC9D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,GAAG,EAAE,CAAC;QACxC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CACvC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACrB,CAAC,IAAI,EAAE,EAAE,CACP,oGAAoG,IAAI,GAAG,CAC9G,CAAC;YACF,MAAM,KAAK,GAAG,IAAI,GAAG,EAAuB,CAAC;YAC7C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;gBAC9C,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;YACzE,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,IAA8B;QACzD,MAAM,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CACtC,GAAG,EACH,CAAC,IAAI,EAAE,EAAE,CAAC,gEAAgE,IAAI,GAAG,CAClF,CAAC;QACF,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,eAAe,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnH,CAAC;CACF"}
@@ -0,0 +1,9 @@
1
+ /** Recursively finds Flow metadata files under `root`, keyed by Flow API name. First match wins. */
2
+ export declare function findFlowFiles(root: string): Promise<Map<string, string>>;
3
+ export type ProjectConfig = {
4
+ /** Path of the default package directory in sfdx-project.json. */
5
+ defaultPackagePath?: string;
6
+ sourceApiVersion?: string;
7
+ };
8
+ /** Reads sfdx-project.json from `root`. Returns an empty config when it is missing or unreadable. */
9
+ export declare function readProjectConfig(root: string): Promise<ProjectConfig>;
@@ -0,0 +1,48 @@
1
+ import { readdir, readFile } from 'node:fs/promises';
2
+ import { join } from 'node:path';
3
+ import { flowNameFromPath } from './flowTypes.js';
4
+ const SKIP_DIRS = new Set(['node_modules', '.git', '.sf', '.sfdx', '.wireit', 'lib', 'coverage']);
5
+ /** Recursively finds Flow metadata files under `root`, keyed by Flow API name. First match wins. */
6
+ export async function findFlowFiles(root) {
7
+ const found = new Map();
8
+ const walk = async (dir) => {
9
+ const entries = await readdir(dir, { withFileTypes: true });
10
+ for (const entry of entries) {
11
+ const fullPath = join(dir, entry.name);
12
+ if (entry.isDirectory()) {
13
+ if (!SKIP_DIRS.has(entry.name))
14
+ await walk(fullPath);
15
+ }
16
+ else {
17
+ const name = flowNameFromPath(entry.name);
18
+ if (name && !found.has(name))
19
+ found.set(name, fullPath);
20
+ }
21
+ }
22
+ };
23
+ await walk(root);
24
+ return found;
25
+ }
26
+ /** Reads sfdx-project.json from `root`. Returns an empty config when it is missing or unreadable. */
27
+ export async function readProjectConfig(root) {
28
+ let raw;
29
+ try {
30
+ raw = await readFile(join(root, 'sfdx-project.json'), 'utf8');
31
+ }
32
+ catch {
33
+ return {};
34
+ }
35
+ try {
36
+ const project = JSON.parse(raw);
37
+ const dirs = project.packageDirectories ?? [];
38
+ const defaultDir = dirs.find((d) => d.default) ?? dirs[0];
39
+ return {
40
+ defaultPackagePath: defaultDir?.path,
41
+ sourceApiVersion: typeof project.sourceApiVersion === 'string' ? project.sourceApiVersion : undefined,
42
+ };
43
+ }
44
+ catch {
45
+ return {};
46
+ }
47
+ }
48
+ //# sourceMappingURL=projectFiles.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"projectFiles.js","sourceRoot":"","sources":["../../src/core/projectFiles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;AAElG,oGAAoG;AACpG,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAY;IAC9C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,MAAM,IAAI,GAAG,KAAK,EAAE,GAAW,EAAiB,EAAE;QAChD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5D,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;oBAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvD,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC1C,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;oBAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,OAAO,KAAK,CAAC;AACf,CAAC;AAUD,qGAAqG;AACrG,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,IAAY;IAClD,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAA4E,CAAC;QAC3G,MAAM,IAAI,GAAG,OAAO,CAAC,kBAAkB,IAAI,EAAE,CAAC;QAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1D,OAAO;YACL,kBAAkB,EAAE,UAAU,EAAE,IAAI;YACpC,gBAAgB,EAAE,OAAO,OAAO,CAAC,gBAAgB,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS;SACtG,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}
@@ -0,0 +1,12 @@
1
+ import type { CoverageSource, ReadinessResult } from './types.js';
2
+ export type ReadinessOptions = {
3
+ source: CoverageSource;
4
+ /** Commit counts per Flow API name, used to rank uncovered Flows. */
5
+ churn?: Map<string, number>;
6
+ threshold?: number;
7
+ };
8
+ /**
9
+ * Measures the org against the deploy-as-active coverage requirement: the share of
10
+ * active autolaunched Flows and processes that at least one Apex test runs.
11
+ */
12
+ export declare function buildReadinessReport(options: ReadinessOptions): Promise<ReadinessResult>;
@@ -0,0 +1,37 @@
1
+ import { DEFAULT_THRESHOLD } from './flowTypes.js';
2
+ /**
3
+ * Measures the org against the deploy-as-active coverage requirement: the share of
4
+ * active autolaunched Flows and processes that at least one Apex test runs.
5
+ */
6
+ export async function buildReadinessReport(options) {
7
+ const threshold = options.threshold ?? DEFAULT_THRESHOLD;
8
+ const coverage = await options.source.listActiveCountedFlows();
9
+ const flows = coverage.map((c) => ({
10
+ flowName: c.flowName,
11
+ processType: c.processType,
12
+ versionNumber: c.versionNumber,
13
+ covered: c.covered,
14
+ elementCoveragePercent: c.elementCoveragePercent,
15
+ tests: c.tests,
16
+ changes: options.churn ? (options.churn.get(c.flowName) ?? 0) : undefined,
17
+ }));
18
+ flows.sort((a, b) => Number(a.covered) - Number(b.covered) ||
19
+ (b.changes ?? 0) - (a.changes ?? 0) ||
20
+ a.flowName.localeCompare(b.flowName));
21
+ const totalFlows = flows.length;
22
+ const coveredFlows = flows.filter((f) => f.covered).length;
23
+ // With no active Flows to cover, Salesforce has nothing to block.
24
+ const coveragePercent = totalFlows === 0 ? 100 : Math.round((coveredFlows / totalFlows) * 1000) / 10;
25
+ const flowsNeeded = Math.max(0, Math.ceil((threshold * totalFlows) / 100) - coveredFlows);
26
+ return {
27
+ threshold,
28
+ totalFlows,
29
+ coveredFlows,
30
+ uncoveredFlows: totalFlows - coveredFlows,
31
+ coveragePercent,
32
+ ready: flowsNeeded === 0,
33
+ flowsNeeded,
34
+ flows,
35
+ };
36
+ }
37
+ //# sourceMappingURL=readiness.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"readiness.js","sourceRoot":"","sources":["../../src/core/readiness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAUnD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAyB;IAClE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,iBAAiB,CAAC;IACzD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,sBAAsB,EAAE,CAAC;IAE/D,MAAM,KAAK,GAAoB,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,sBAAsB,EAAE,CAAC,CAAC,sBAAsB;QAChD,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;KAC1E,CAAC,CAAC,CAAC;IAEJ,KAAK,CAAC,IAAI,CACR,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;QACrC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CACvC,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC;IAChC,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAC3D,kEAAkE;IAClE,MAAM,eAAe,GAAG,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACrG,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,UAAU,CAAC,GAAG,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC;IAE1F,OAAO;QACL,SAAS;QACT,UAAU;QACV,YAAY;QACZ,cAAc,EAAE,UAAU,GAAG,YAAY;QACzC,eAAe;QACf,KAAK,EAAE,WAAW,KAAK,CAAC;QACxB,WAAW;QACX,KAAK;KACN,CAAC;AACJ,CAAC"}
@@ -0,0 +1,27 @@
1
+ /** The parts of an sObject describe field result needed to fill required fields. */
2
+ export type DescribeField = {
3
+ name: string;
4
+ type: string;
5
+ nillable: boolean;
6
+ createable: boolean;
7
+ defaultedOnCreate: boolean;
8
+ calculated?: boolean;
9
+ autoNumber?: boolean;
10
+ length?: number;
11
+ picklistValues?: Array<{
12
+ value: string;
13
+ active: boolean;
14
+ defaultValue?: boolean;
15
+ }> | null;
16
+ referenceTo?: string[] | null;
17
+ };
18
+ /** Describes an sObject's fields. Returns undefined when the object can't be described. */
19
+ export type DescribeObject = (objectName: string) => Promise<DescribeField[] | undefined>;
20
+ /** Field name to Apex literal, per object. */
21
+ export type RequiredFieldMap = Record<string, Record<string, string>>;
22
+ /** An Apex literal for a required field, or undefined when no safe value can be made up. */
23
+ export declare function apexValueForField(field: DescribeField): string | undefined;
24
+ /** Fields a test must set to insert a record: createable, not nillable, and not defaulted by the platform. */
25
+ export declare function requiredFieldValues(fields: DescribeField[]): Record<string, string>;
26
+ /** Describes each object once and returns its required fields. Objects that can't be described are left out. */
27
+ export declare function loadRequiredFields(objects: string[], describe: DescribeObject): Promise<RequiredFieldMap>;
@@ -0,0 +1,75 @@
1
+ import { escapeApexString } from './flowXml.js';
2
+ const SKIPPED_SYSTEM_FIELDS = new Set(['OwnerId', 'CurrencyIsoCode']);
3
+ function textValue(field, text) {
4
+ const max = field.length && field.length > 0 ? field.length : text.length;
5
+ return `'${escapeApexString(text.slice(0, max))}'`;
6
+ }
7
+ /** An Apex literal for a required field, or undefined when no safe value can be made up. */
8
+ export function apexValueForField(field) {
9
+ switch (field.type) {
10
+ case 'string':
11
+ case 'textarea':
12
+ case 'encryptedstring':
13
+ return textValue(field, 'Test');
14
+ case 'email':
15
+ return "'test@example.com'";
16
+ case 'phone':
17
+ return "'5555550100'";
18
+ case 'url':
19
+ return "'https://example.com'";
20
+ case 'int':
21
+ case 'double':
22
+ case 'currency':
23
+ case 'percent':
24
+ return '1';
25
+ case 'date':
26
+ return 'Date.today()';
27
+ case 'datetime':
28
+ return 'Datetime.now()';
29
+ case 'time':
30
+ return 'Time.newInstance(12, 0, 0, 0)';
31
+ case 'boolean':
32
+ return 'false';
33
+ case 'picklist':
34
+ case 'multipicklist': {
35
+ const values = (field.picklistValues ?? []).filter((v) => v.active);
36
+ const chosen = values.find((v) => v.defaultValue) ?? values[0];
37
+ return chosen ? `'${escapeApexString(chosen.value)}'` : undefined;
38
+ }
39
+ case 'reference':
40
+ return `null /* TODO: set a ${(field.referenceTo ?? []).join(' or ') || 'record'} Id */`;
41
+ default:
42
+ return undefined;
43
+ }
44
+ }
45
+ /** Fields a test must set to insert a record: createable, not nillable, and not defaulted by the platform. */
46
+ export function requiredFieldValues(fields) {
47
+ const values = {};
48
+ for (const field of fields) {
49
+ if (!field.createable || field.nillable || field.defaultedOnCreate)
50
+ continue;
51
+ if (field.calculated || field.autoNumber || SKIPPED_SYSTEM_FIELDS.has(field.name))
52
+ continue;
53
+ const value = apexValueForField(field);
54
+ if (value !== undefined)
55
+ values[field.name] = value;
56
+ }
57
+ return values;
58
+ }
59
+ /** Describes each object once and returns its required fields. Objects that can't be described are left out. */
60
+ export async function loadRequiredFields(objects, describe) {
61
+ const map = {};
62
+ for (const object of [...new Set(objects)]) {
63
+ let fields;
64
+ try {
65
+ fields = await describe(object);
66
+ }
67
+ catch {
68
+ fields = undefined;
69
+ }
70
+ if (fields)
71
+ map[object] = requiredFieldValues(fields);
72
+ }
73
+ return map;
74
+ }
75
+ //# sourceMappingURL=requiredFields.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"requiredFields.js","sourceRoot":"","sources":["../../src/core/requiredFields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAsBhD,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAEtE,SAAS,SAAS,CAAC,KAAoB,EAAE,IAAY;IACnD,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1E,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC;AACrD,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,iBAAiB,CAAC,KAAoB;IACpD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,iBAAiB;YACpB,OAAO,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAClC,KAAK,OAAO;YACV,OAAO,oBAAoB,CAAC;QAC9B,KAAK,OAAO;YACV,OAAO,cAAc,CAAC;QACxB,KAAK,KAAK;YACR,OAAO,uBAAuB,CAAC;QACjC,KAAK,KAAK,CAAC;QACX,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS;YACZ,OAAO,GAAG,CAAC;QACb,KAAK,MAAM;YACT,OAAO,cAAc,CAAC;QACxB,KAAK,UAAU;YACb,OAAO,gBAAgB,CAAC;QAC1B,KAAK,MAAM;YACT,OAAO,+BAA+B,CAAC;QACzC,KAAK,SAAS;YACZ,OAAO,OAAO,CAAC;QACjB,KAAK,UAAU,CAAC;QAChB,KAAK,eAAe,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACpE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YAC/D,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QACpE,CAAC;QACD,KAAK,WAAW;YACd,OAAO,uBAAuB,CAAC,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,QAAQ,CAAC;QAC3F;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED,8GAA8G;AAC9G,MAAM,UAAU,mBAAmB,CAAC,MAAuB;IACzD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,iBAAiB;YAAE,SAAS;QAC7E,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,IAAI,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,SAAS;QAC5F,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACtD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,gHAAgH;AAChH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAAiB,EAAE,QAAwB;IAClF,MAAM,GAAG,GAAqB,EAAE,CAAC;IACjC,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC3C,IAAI,MAAmC,CAAC;QACxC,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,MAAM;YAAE,GAAG,CAAC,MAAM,CAAC,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
@@ -0,0 +1,18 @@
1
+ import { type DescribeObject } from './requiredFields.js';
2
+ import type { ScaffoldResult } from './types.js';
3
+ export declare const DEFAULT_APEX_API_VERSION = "65.0";
4
+ export type ScaffoldOptions = {
5
+ flowNames: string[];
6
+ /** Project root: searched for Flow files and sfdx-project.json. */
7
+ projectDir: string;
8
+ /** Where to write classes. Defaults to `<default package>/main/default/classes`. */
9
+ outputDir?: string;
10
+ /** Overwrite test classes that already exist. */
11
+ force?: boolean;
12
+ /** Report what would be generated without writing files. */
13
+ dryRun?: boolean;
14
+ /** Describes sObjects in the org so generated records set their required fields. */
15
+ describe?: DescribeObject;
16
+ };
17
+ /** Generates starter Apex tests for the named Flows from their metadata files in the project. */
18
+ export declare function scaffoldTests(options: ScaffoldOptions): Promise<ScaffoldResult>;
@@ -0,0 +1,79 @@
1
+ import { access, mkdir, readFile, writeFile } from 'node:fs/promises';
2
+ import { join } from 'node:path';
3
+ import { apexClassMetaXml, flowKind, generateApexTest } from './apexTemplate.js';
4
+ import { isCountedProcessType } from './flowTypes.js';
5
+ import { parseFlowXml } from './flowXml.js';
6
+ import { findFlowFiles, readProjectConfig } from './projectFiles.js';
7
+ import { loadRequiredFields } from './requiredFields.js';
8
+ export const DEFAULT_APEX_API_VERSION = '65.0';
9
+ /** sObjects a generated test creates records of. */
10
+ function objectsToCreate(flow) {
11
+ const kind = flowKind(flow);
12
+ const objects = flow.variables
13
+ .filter((v) => v.isInput && !v.isCollection && v.dataType === 'SObject' && v.objectType)
14
+ .map((v) => v.objectType);
15
+ if ((kind === 'record' || kind === 'platformEvent') && flow.object)
16
+ objects.push(flow.object);
17
+ return objects;
18
+ }
19
+ async function exists(path) {
20
+ try {
21
+ await access(path);
22
+ return true;
23
+ }
24
+ catch {
25
+ return false;
26
+ }
27
+ }
28
+ /** Generates starter Apex tests for the named Flows from their metadata files in the project. */
29
+ export async function scaffoldTests(options) {
30
+ const project = await readProjectConfig(options.projectDir);
31
+ const outputDir = options.outputDir ??
32
+ join(options.projectDir, project.defaultPackagePath ?? 'force-app', 'main', 'default', 'classes');
33
+ const apiVersion = project.sourceApiVersion ?? DEFAULT_APEX_API_VERSION;
34
+ const flowFiles = await findFlowFiles(options.projectDir);
35
+ const result = { created: [], skipped: [] };
36
+ const flows = [];
37
+ for (const flowName of [...new Set(options.flowNames)]) {
38
+ const flowPath = flowFiles.get(flowName);
39
+ if (!flowPath) {
40
+ result.skipped.push({ flowName, reason: `No ${flowName}.flow-meta.xml found under ${options.projectDir}.` });
41
+ continue;
42
+ }
43
+ let flow;
44
+ try {
45
+ flow = parseFlowXml(flowName, await readFile(flowPath, 'utf8'));
46
+ }
47
+ catch (error) {
48
+ result.skipped.push({ flowName, reason: error.message });
49
+ continue;
50
+ }
51
+ if (!isCountedProcessType(flow.processType)) {
52
+ result.skipped.push({
53
+ flowName,
54
+ reason: `Process type ${flow.processType ?? 'unknown'} does not count toward deploy-as-active coverage.`,
55
+ });
56
+ continue;
57
+ }
58
+ flows.push({ flowName, flow });
59
+ }
60
+ const requiredFields = options.describe
61
+ ? await loadRequiredFields(flows.flatMap((f) => objectsToCreate(f.flow)), options.describe)
62
+ : {};
63
+ for (const { flowName, flow } of flows) {
64
+ const test = generateApexTest(flow, { requiredFields });
65
+ const classPath = join(outputDir, `${test.className}.cls`);
66
+ if (!options.force && (await exists(classPath))) {
67
+ result.skipped.push({ flowName, reason: `${classPath} already exists. Use --force to overwrite.` });
68
+ continue;
69
+ }
70
+ if (!options.dryRun) {
71
+ await mkdir(outputDir, { recursive: true });
72
+ await writeFile(classPath, test.body, 'utf8');
73
+ await writeFile(`${classPath}-meta.xml`, apexClassMetaXml(apiVersion), 'utf8');
74
+ }
75
+ result.created.push({ flowName, className: test.className, path: classPath });
76
+ }
77
+ return result;
78
+ }
79
+ //# sourceMappingURL=scaffold.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../src/core/scaffold.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAuB,kBAAkB,EAAyB,MAAM,qBAAqB,CAAC;AAGrG,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAgB/C,oDAAoD;AACpD,SAAS,eAAe,CAAC,IAAkB;IACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS;SAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,UAAU,CAAC;SACvF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAoB,CAAC,CAAC;IACtC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,eAAe,CAAC,IAAI,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9F,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,iGAAiG;AACjG,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAwB;IAC1D,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,SAAS,GACb,OAAO,CAAC,SAAS;QACjB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,kBAAkB,IAAI,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACpG,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,IAAI,wBAAwB,CAAC;IACxE,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAmB,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAE5D,MAAM,KAAK,GAAoD,EAAE,CAAC;IAClE,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,QAAQ,8BAA8B,OAAO,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;YAC7G,SAAS;QACX,CAAC;QACD,IAAI,IAAkB,CAAC;QACvB,IAAI,CAAC;YACH,IAAI,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;QAClE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAG,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YACpE,SAAS;QACX,CAAC;QACD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;gBAClB,QAAQ;gBACR,MAAM,EAAE,gBAAgB,IAAI,CAAC,WAAW,IAAI,SAAS,mDAAmD;aACzG,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,cAAc,GAAqB,OAAO,CAAC,QAAQ;QACvD,CAAC,CAAC,MAAM,kBAAkB,CACtB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAC7C,OAAO,CAAC,QAAQ,CACjB;QACH,CAAC,CAAC,EAAE,CAAC;IAEP,KAAK,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,KAAK,EAAE,CAAC;QACvC,MAAM,IAAI,GAAG,gBAAgB,CAAC,IAAI,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;QACxD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC;QAC3D,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,4CAA4C,EAAE,CAAC,CAAC;YACpG,SAAS;QACX,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5C,MAAM,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,MAAM,SAAS,CAAC,GAAG,SAAS,WAAW,EAAE,gBAAgB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;QACjF,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -0,0 +1,7 @@
1
+ import type { Connection } from '@salesforce/core';
2
+ import type { DescribeObject } from './requiredFields.js';
3
+ import type { ToolingQuery } from './types.js';
4
+ /** Adapts an org connection to the ToolingQuery used by OrgCoverageSource, fetching every page. */
5
+ export declare function toolingQuery(connection: Pick<Connection, 'tooling'>): ToolingQuery;
6
+ /** Adapts an org connection to the DescribeObject used by scaffolding to fill required fields. */
7
+ export declare function describeObject(connection: Pick<Connection, 'describe'>): DescribeObject;
@@ -0,0 +1,16 @@
1
+ const MAX_FETCH = 1_000_000;
2
+ /** Adapts an org connection to the ToolingQuery used by OrgCoverageSource, fetching every page. */
3
+ export function toolingQuery(connection) {
4
+ return async (soql) => {
5
+ const result = await connection.tooling.query(soql, { autoFetch: true, maxFetch: MAX_FETCH });
6
+ return result.records;
7
+ };
8
+ }
9
+ /** Adapts an org connection to the DescribeObject used by scaffolding to fill required fields. */
10
+ export function describeObject(connection) {
11
+ return async (objectName) => {
12
+ const result = await connection.describe(objectName);
13
+ return result.fields;
14
+ };
15
+ }
16
+ //# sourceMappingURL=toolingQuery.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"toolingQuery.js","sourceRoot":"","sources":["../../src/core/toolingQuery.ts"],"names":[],"mappings":"AAKA,MAAM,SAAS,GAAG,SAAS,CAAC;AAE5B,mGAAmG;AACnG,MAAM,UAAU,YAAY,CAAC,UAAuC;IAClE,OAAO,KAAK,EAAqC,IAAY,EAAgB,EAAE;QAC7E,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,CAAI,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACjG,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,cAAc,CAAC,UAAwC;IACrE,OAAO,KAAK,EAAE,UAAkB,EAA4B,EAAE;QAC5D,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC,MAAoC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}