Files
modeling-app/src/lib/commandBarConfigs/applicationCommandConfig.ts
Kevin Nadro e2fd3948f5 [Feature] Create assembly samples from home page (#6747)
* fix: how?

* fix: 0 byte thumbnail png loading bug

* fix: adding navigate to single file back

* fix: cargo fmt

* fix: sorting files to match manifest and unit test

* fix: restoring back to main

* fix: cargo fmt

* fix: ope, I forgot I deleted some code that renamed single files to the samples name to track easier within the file tree

* fix: ope

* Update src/lib/commandBarConfigs/applicationCommandConfig.ts

Co-authored-by: Frank Noirot <frank@zoo.dev>

* fix: unique name for project, ope

* fix: filtered samples for web and skeleton create a sample command

* fix: Create A Sample specifically desktop home page instead of overloading the add to file

* fix: hiding source

* fix: gotcha on add to file with existing project default args and assemblies

---------

Co-authored-by: Frank Noirot <frank@zoo.dev>
2025-05-08 19:41:29 +00:00

437 lines
14 KiB
TypeScript

import type { systemIOMachine } from '@src/machines/systemIO/systemIOMachine'
import type { ActorRefFrom } from 'xstate'
import type { Command, CommandArgumentOption } from '@src/lib/commandTypes'
import type { RequestedKCLFile } from '@src/machines/systemIO/utils'
import { SystemIOMachineEvents } from '@src/machines/systemIO/utils'
import { isDesktop } from '@src/lib/isDesktop'
import {
everyKclSample,
findKclSample,
kclSamplesManifestWithNoMultipleFiles,
} from '@src/lib/kclSamples'
import { getUniqueProjectName } from '@src/lib/desktopFS'
import { IS_ML_EXPERIMENTAL, ML_EXPERIMENTAL_MESSAGE } from '@src/lib/constants'
import toast from 'react-hot-toast'
import { reportRejection } from '@src/lib/trap'
import { relevantFileExtensions } from '@src/lang/wasmUtils'
import { getStringAfterLastSeparator, webSafePathSplit } from '@src/lib/paths'
import { FILE_EXT } from '@src/lib/constants'
function onSubmitKCLSampleCreation({
sample,
kclSample,
uniqueNameIfNeeded,
systemIOActor,
}: {
sample: any
kclSample: ReturnType<typeof findKclSample>
uniqueNameIfNeeded: any
systemIOActor: ActorRefFrom<typeof systemIOMachine>
}) {
if (!kclSample) {
toast.error('The command could not be submitted, unable to find Zoo sample')
return
}
const pathParts = webSafePathSplit(sample)
const projectPathPart = pathParts[0]
const files = kclSample.files
const filePromises = files.map((file) => {
const sampleCodeUrl =
(isDesktop() ? '.' : '') +
`/kcl-samples/${encodeURIComponent(
projectPathPart
)}/${encodeURIComponent(file)}`
return fetch(sampleCodeUrl).then((response) => {
return {
response,
file,
projectName: projectPathPart,
}
})
})
const requestedFiles: RequestedKCLFile[] = []
// If any fetches fail from the KCL Code download we will instantly reject
// No cleanup required since the fetch response is in memory
// TODO: Try to catch if there is a failure then delete the root folder and show error
Promise.all(filePromises)
.then(async (responses) => {
for (let i = 0; i < responses.length; i++) {
const response = responses[i]
const code = await response.response.text()
requestedFiles.push({
requestedCode: code,
requestedFileName: response.file,
requestedProjectName: uniqueNameIfNeeded,
})
}
if (requestedFiles.length === 1) {
/**
* Navigates to the single file that could be renamed on disk for duplicates
*/
const folderNameBecomesKCLFileName = projectPathPart + FILE_EXT
systemIOActor.send({
type: SystemIOMachineEvents.importFileFromURL,
data: {
requestedProjectName: requestedFiles[0].requestedProjectName,
requestedFileNameWithExtension: folderNameBecomesKCLFileName,
requestedCode: requestedFiles[0].requestedCode,
},
})
} else {
/**
* Bulk create the assembly and navigate to the project
*/
systemIOActor.send({
type: SystemIOMachineEvents.bulkCreateKCLFilesAndNavigateToProject,
data: {
files: requestedFiles,
requestedProjectName: uniqueNameIfNeeded,
},
})
}
})
.catch(reportError)
}
export function createApplicationCommands({
systemIOActor,
}: {
systemIOActor: ActorRefFrom<typeof systemIOMachine>
}) {
const textToCADCommand: Command = {
name: 'Text-to-CAD',
description: 'Generate parts from text prompts.',
displayName: 'Text to CAD',
groupId: 'application',
needsReview: false,
status: IS_ML_EXPERIMENTAL ? 'experimental' : 'active',
icon: 'sparkles',
onSubmit: (record) => {
if (record) {
const requestedProjectName = record.newProjectName || record.projectName
const requestedPrompt = record.prompt
const isProjectNew = !!record.newProjectName
systemIOActor.send({
type: SystemIOMachineEvents.generateTextToCAD,
data: { requestedPrompt, requestedProjectName, isProjectNew },
})
}
},
args: {
method: {
inputType: 'options',
required: true,
skip: true,
options: isDesktop()
? [
{ name: 'New project', value: 'newProject' },
{ name: 'Existing project', value: 'existingProject' },
]
: [{ name: 'Overwrite', value: 'existingProject' }],
valueSummary(value) {
return isDesktop()
? value === 'newProject'
? 'New project'
: 'Existing project'
: 'Overwrite'
},
},
projectName: {
inputType: 'options',
required: (commandsContext) =>
isDesktop() &&
commandsContext.argumentsToSubmit.method === 'existingProject',
skip: true,
options: (_, _context) => {
const { folders } = systemIOActor.getSnapshot().context
const options: CommandArgumentOption<string>[] = []
folders.forEach((folder) => {
options.push({
name: folder.name,
value: folder.name,
isCurrent: false,
})
})
return options
},
},
newProjectName: {
inputType: 'text',
required: (commandsContext) =>
isDesktop() &&
commandsContext.argumentsToSubmit.method === 'newProject',
skip: true,
},
prompt: {
inputType: 'text',
required: true,
warningMessage: ML_EXPERIMENTAL_MESSAGE,
},
},
}
const addKCLFileToProject: Command = {
name: 'add-kcl-file-to-project',
displayName: 'Add file to project',
description:
'Add KCL file, Zoo sample, or 3D model to new or existing project.',
needsReview: false,
icon: 'importFile',
groupId: 'application',
onSubmit(data) {
if (data) {
/** TODO: Make a new machine for models. This is only a temporary location
* to move it to the global application level. To reduce its footprint
* and complexity the implementation lives here with systemIOMachine. Not
* inside the systemIOMachine. We can have a fancy model machine that loads
* KCL samples
*/
const folders = systemIOActor.getSnapshot().context.folders
const isProjectNew = !!data.newProjectName
const requestedProjectName = data.newProjectName || data.projectName
const uniqueNameIfNeeded = isProjectNew
? getUniqueProjectName(requestedProjectName, folders)
: requestedProjectName
const kclSample = findKclSample(data.sample)
if (
data.source === 'kcl-samples' &&
kclSample &&
kclSample.files.length >= 1
) {
onSubmitKCLSampleCreation({
sample: data.sample,
kclSample,
uniqueNameIfNeeded,
systemIOActor,
})
} else if (data.source === 'local' && data.path) {
const clonePath = data.path
const fileNameWithExtension = getStringAfterLastSeparator(clonePath)
const readFileContentsAndCreateNewFile = async () => {
const text = await window.electron.readFile(clonePath, 'utf8')
systemIOActor.send({
type: SystemIOMachineEvents.importFileFromURL,
data: {
requestedProjectName: uniqueNameIfNeeded,
requestedFileNameWithExtension: fileNameWithExtension,
requestedCode: text,
},
})
}
readFileContentsAndCreateNewFile().catch(reportRejection)
} else {
toast.error("The command couldn't be submitted, check the arguments.")
}
}
},
args: {
source: {
inputType: 'options',
required: true,
skip: false,
defaultValue: isDesktop() ? 'local' : 'kcl-samples',
options() {
return [
{
value: 'kcl-samples',
name: 'KCL Samples',
isCurrent: true,
},
...(isDesktop()
? [
{
value: 'local',
name: 'Local Drive',
isCurrent: false,
},
]
: []),
]
},
},
sample: {
inputType: 'options',
required: (commandContext) =>
!['local'].includes(
commandContext.argumentsToSubmit.source as string
),
hidden: (commandContext) =>
['local'].includes(commandContext.argumentsToSubmit.source as string),
valueSummary(value) {
const MAX_LENGTH = 12
if (typeof value === 'string') {
return value.length > MAX_LENGTH
? value.substring(0, MAX_LENGTH) + '...'
: value
}
return value
},
options: ({ argumentsToSubmit }) => {
const samples =
isDesktop() && argumentsToSubmit.method !== 'existingProject'
? everyKclSample
: kclSamplesManifestWithNoMultipleFiles
return samples.map((sample) => {
return {
value: sample.pathFromProjectDirectoryToFirstFile,
name: sample.title,
}
})
},
},
method: {
inputType: 'options',
required: true,
skip: true,
options: ({ argumentsToSubmit }, _) => {
if (isDesktop() && typeof argumentsToSubmit.sample === 'string') {
const kclSample = findKclSample(argumentsToSubmit.sample)
if (kclSample && kclSample.files.length > 1) {
return [
{ name: 'New project', value: 'newProject', isCurrent: true },
]
} else {
return [
{ name: 'New project', value: 'newProject', isCurrent: true },
{ name: 'Existing project', value: 'existingProject' },
]
}
} else {
return [{ name: 'Overwrite', value: 'existingProject' }]
}
},
valueSummary(value) {
return isDesktop()
? value === 'newProject'
? 'New project'
: 'Existing project'
: 'Overwrite'
},
},
projectName: {
inputType: 'options',
required: (commandsContext) =>
isDesktop() &&
commandsContext.argumentsToSubmit.method === 'existingProject',
skip: true,
options: (_, _context) => {
const { folders } = systemIOActor.getSnapshot().context
const options: CommandArgumentOption<string>[] = []
folders.forEach((folder) => {
options.push({
name: folder.name,
value: folder.name,
isCurrent: false,
})
})
return options
},
},
newProjectName: {
inputType: 'text',
required: (commandsContext) =>
isDesktop() &&
commandsContext.argumentsToSubmit.method === 'newProject',
skip: true,
},
path: {
inputType: 'path',
skip: true,
hidden: !isDesktop(),
defaultValue: '',
valueSummary: (value) => {
return isDesktop() ? window.electron.path.basename(value) : ''
},
required: (commandContext) =>
isDesktop() &&
['local'].includes(commandContext.argumentsToSubmit.source as string),
filters: [
{
name: `Import ${relevantFileExtensions().map((f) => ` .${f}`)}`,
extensions: relevantFileExtensions(),
},
],
},
},
}
/**
* Looks similar to Add file to project but more data is hard coded for the home page button
* to direct the user in a more seamless method.
*
* This will always create a new folder on disk does not import into existing projects.
* Desktop only command for now!
*/
const createASampleDesktopOnly: Command = {
name: 'create-a-sample',
displayName: 'Create a sample',
description: 'Create a new project from a Zoo Sample',
needsReview: false,
icon: 'importFile',
groupId: 'application',
hideFromSearch: true,
onSubmit: (data) => {
if (data) {
const folders = systemIOActor.getSnapshot().context.folders
const kclSample = findKclSample(data.sample)
if (!kclSample) {
toast.error(
'The command could not be submitted, unable to find Zoo sample'
)
return
}
const pathParts = webSafePathSplit(
kclSample.pathFromProjectDirectoryToFirstFile
)
const folderNameBecomesSampleName = pathParts[0]
const uniqueNameIfNeeded = getUniqueProjectName(
folderNameBecomesSampleName,
folders
)
onSubmitKCLSampleCreation({
sample: data.sample,
kclSample,
uniqueNameIfNeeded,
systemIOActor,
})
}
},
args: {
source: {
inputType: 'text',
required: true,
skip: false,
defaultValue: 'kcl-samples',
hidden: true,
},
sample: {
inputType: 'options',
required: true,
valueSummary(value) {
const MAX_LENGTH = 12
if (typeof value === 'string') {
return value.length > MAX_LENGTH
? value.substring(0, MAX_LENGTH) + '...'
: value
}
return value
},
options: everyKclSample.map((sample) => {
return {
value: sample.pathFromProjectDirectoryToFirstFile,
name: sample.title,
}
}),
},
},
}
return isDesktop()
? [textToCADCommand, addKCLFileToProject, createASampleDesktopOnly]
: [textToCADCommand, addKCLFileToProject]
}