Skip to content

Feature/add option to save node coords separately on journey export #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
devintrivir wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Feature/add option to save node coords separately on journey export #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 65 additions & 21 deletions src/cli/journey/journey-export.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import { getTokens } from '../../ops/AuthenticateOps';
import {
exportJourneyCoords,
exportJourneysToFile,
exportJourneysToFiles,
exportJourneyToFile,
Expand Down Expand Up @@ -62,6 +63,12 @@
'Do not include the x and y coordinate positions of the journey/tree nodes.'
)
)
.addOption(
new Option(
'--sep-coords',
'Export x and y coordinate positions of the journey/tree nodes to separate files.'
).default(false)
)
// .addOption(
// new Option(
// '-O, --organize <method>',
Expand All @@ -82,44 +89,80 @@
options,
command
);
if (!(await getTokens())) {
printMessage('Authentication failed.', 'error');
process.exitCode = 1;
return;
}
let outcome = false;
// export
if (options.journeyId && (await getTokens())) {
if (options.journeyId) {
verboseMessage('Exporting journey...');
const outcome = await exportJourneyToFile(
outcome = await exportJourneyToFile(
options.journeyId,
options.file,
options.metadata,
{
useStringArrays: options.useStringArrays,
deps: options.deps,
coords: options.coords,
coords: !options.sepCoords,
}
);
if (!outcome) process.exitCode = 1;
if (outcome && options.sepCoords) {
verboseMessage('Exporting journey coordinates separately...');
await exportJourneyCoords([options.journeyId], {
deps: options.journeyId,
useStringArrays: options.useStringArrays,
coords: true,
sepCoords: true,

Check failure on line 117 in src/cli/journey/journey-export.ts

View workflow job for this annotation

GitHub Actions / Build 

Object literal may only specify known properties, but 'sepCoords' does not exist in type 'TreeExportOptions'. Did you mean to write 'coords'?
});
}
}
// --all -a
else if (options.all && (await getTokens())) {
else if (options.all) {
verboseMessage('Exporting all journeys to a single file...');
const outcome = await exportJourneysToFile(
options.file,
options.metadata,
{
useStringArrays: options.useStringArrays,
deps: options.deps,
coords: options.coords,
}
);
if (!outcome) process.exitCode = 1;
outcome = await exportJourneysToFile(options.file, options.metadata, {
useStringArrays: options.useStringArrays,
deps: options.deps,
coords: !options.sepCoords,
});
if (outcome && options.sepCoords) {
verboseMessage(
'Exporting coordinates of all journeys to a separate file...'
);
await exportJourneyCoords(
'all',
{
deps: options.deps,
useStringArrays: options.useStringArrays,
coords: true,
},
'all'
);
}
}
// --all-separate -A
else if (options.allSeparate && (await getTokens())) {
else if (options.allSeparate) {
verboseMessage('Exporting all journeys to separate files...');
const outcome = await exportJourneysToFiles(options.metadata, {
outcome = await exportJourneysToFiles(options.metadata, {
useStringArrays: options.useStringArrays,
deps: options.deps,
coords: options.coords,
coords: !options.sepCoords,
});
if (!outcome) process.exitCode = 1;
if (outcome && options.sepCoords) {
verboseMessage(
'Exporting coordinates of all journeys to separate files...'
);
await exportJourneyCoords(
'all',
{
deps: options.deps,
useStringArrays: options.useStringArrays,
coords: true,
},
'allSeparate'
);
}
}
// unrecognized combination of options or no options
else {
Expand All @@ -129,10 +172,11 @@
);
program.help();
process.exitCode = 1;
return;
}

if (!outcome) process.exitCode = 1;
}
// end command logic inside action handler
);

return program;
}
113 changes: 113 additions & 0 deletions src/ops/JourneyOps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,119 @@ export async function exportJourneysToFiles(
return false;
}

export async function exportJourneyCoords(
journeyIds: string[] | 'all',
options: TreeExportOptions = {
deps: false,
useStringArrays: false,
coords: true,
},
mode: 'single' | 'all' | 'allSeparate' = 'single'
): Promise<boolean> {
try {
let idsToExport: string[] = [];
if (journeyIds === 'all') {
const journeysExport = await exportJourneys(options, errorHandler);
idsToExport = Object.keys(journeysExport.trees);
} else {
idsToExport = journeyIds;
}
if (mode === 'all') {
const allCoords: Record<
string,
{
nodeCoordinates: Record<string, { x: number; y: number }>;
staticNodeCoordinates: Record<string, { x: number; y: number }>;
}
> = {};
for (const treeId of idsToExport) {
const treeExport = await exportJourney(treeId, options);
const nodeCoordinates: Record<string, { x: number; y: number }> = {};
const staticNodeCoordinates: Record<string, { x: number; y: number }> =
{};
const justNodes: typeof treeExport.tree.nodes = {};
for (const [nodeId, nodeData] of Object.entries(
treeExport.tree.nodes
)) {
const { x, y, ...etc } = nodeData as any;
if (typeof x === 'number' && typeof y === 'number')
nodeCoordinates[nodeId] = { x, y };
justNodes[nodeId] = etc;
}
const justStaticNodes: typeof treeExport.tree.staticNodes = {};
for (const [nodeId, nodeData] of Object.entries(
treeExport.tree.staticNodes ?? {}
)) {
const { x, y, ...etc } = nodeData as any;
if (typeof x === 'number' && typeof y === 'number')
staticNodeCoordinates[nodeId] = { x, y };
justStaticNodes[nodeId] = etc;
}
allCoords[treeId] = { nodeCoordinates, staticNodeCoordinates };
}
const coordsFile = getFilePath(
getTypedFilename(`allJourneys`, 'coords'),
true
);
saveJsonToFile({ coordinates: allCoords }, coordsFile);
return true;
}
for (const treeId of idsToExport) {
try {
const treeExport = await exportJourney(treeId, options);
const nodeCoordinates: Record<string, { x: number; y: number }> = {};
const staticNodeCoordinates: Record<string, { x: number; y: number }> =
{};
const justNodes: typeof treeExport.tree.nodes = {};
for (const [nodeId, nodeData] of Object.entries(
treeExport.tree.nodes
)) {
const { x, y, ...etc } = nodeData as any;
if (typeof x === 'number' && typeof y === 'number')
nodeCoordinates[nodeId] = { x, y };
justNodes[nodeId] = etc;
}
const justStaticNodes: typeof treeExport.tree.staticNodes = {};
for (const [nodeId, nodeData] of Object.entries(
treeExport.tree.staticNodes ?? {}
)) {
const { x, y, ...etc } = nodeData as any;
if (typeof x === 'number' && typeof y === 'number')
staticNodeCoordinates[nodeId] = { x, y };
justStaticNodes[nodeId] = etc;
}
const justTree = {
...treeExport,
tree: {
...treeExport.tree,
nodes: justNodes,
staticNodes: justStaticNodes,
},
};
if (mode === 'single') {
const journeyFile = getFilePath(
getTypedFilename(treeId, 'journey'),
true
);
saveJsonToFile({ trees: { [treeId]: justTree } }, journeyFile);
}
const coordsFile = getFilePath(
getTypedFilename(treeId, 'coords'),
true
);
saveJsonToFile({ nodeCoordinates, staticNodeCoordinates }, coordsFile);
printMessage(`${treeId} node coordinates saved.`, 'info');
} catch (error) {
throw new FrodoError(`Error saving ${treeId}`);
}
}
return true;
} catch (error) {
printError(error);
}
return false;
}

/**
* Import a journey from file
* @param {string} journeyId journey id/name
Expand Down
Loading