@salesforce/plugin-orchestrator 1.0.0

package/messages/appframework.delete.template.md

@@ -0,0 +1,162 @@
+# summary
+
+Delete an AppFramework template.
+
+# description
+
+Deletes an existing template. By default, apps created from this template will remain but will no longer be linked to the template. Use --force-delete to delete both the template and all apps created from it. Use --decouple to keep the apps but remove their link to the template.
+
+# flags.target-org.summary
+
+Login username or alias for the target org
+
+# flags.target-org.description
+
+The target org to connect to for deleting the template.
+
+# flags.api-version.summary
+
+Override the api version used for api requests
+
+# flags.api-version.description
+
+Override the api version used for api requests to the app framework.
+
+# flags.template-id.summary
+
+ID of the template to delete
+
+# flags.template-id.description
+
+The unique identifier of the template to delete.
+
+# flags.template-name.summary
+
+Name of the template to delete
+
+# flags.template-name.description
+
+The name of the template to delete. Use this if you don't know the template ID.
+
+# flags.force-delete.summary
+
+Force delete the template and all apps created from it
+
+# flags.force-delete.description
+
+When set, all apps created from this template will also be deleted. Otherwise, the apps will remain but will no longer be linked to any template.
+
+# flags.decouple.summary
+
+Decouple apps from this template before deleting it
+
+# flags.decouple.description
+
+When set, apps created from this template will have their link to the template removed before the template is deleted. This allows the apps to exist independently after the template is gone.
+
+# flags.no-prompt.summary
+
+Do not prompt for confirmation
+
+# flags.no-prompt.description
+
+Skip the confirmation prompt before deleting the template.
+
+# fetchingTemplate
+
+Fetching template information...
+
+# deletingTemplate
+
+Deleting template...
+
+# decouplingApps
+
+Decoupling apps from template...
+
+# deletingApps
+
+Deleting apps created from this template...
+
+# confirmDeleteYesNo
+
+Are you sure you want to delete this template? Apps created from it will remain but will no longer be linked to the template. (y/n)
+
+# confirmForceDeleteYesNo
+
+WARNING: This will delete the template AND all apps created from it. This operation cannot be undone. Continue? (y/n)
+
+# confirmDecoupleYesNo
+
+This will decouple all apps from the template and then delete the template. Apps will remain independent after the template is gone. Continue? (y/n)
+
+# deleteTemplateSuccess
+
+Successfully deleted template with ID: %s
+
+# error.MissingRequiredFlag
+
+You must provide either template-id or template-name.
+
+# error.MissingRequiredFlag.Actions
+
+- Specify the template ID with --template-id
+- Or specify the template name with --template-name
+
+# error.TemplateNotFound
+
+Could not find template: %s
+
+# error.TemplateNotFound.Actions
+
+- Verify the template ID or name is correct
+- Use 'sf appframework list template' to see available templates
+
+# error.CertificateError
+
+Error connecting to Salesforce: Certificate validation failed.
+
+# error.CertificateError.Actions
+
+- Check your network connection
+- Verify you have valid certificates
+- Try again with a different org
+
+# error.AuthenticationError
+
+Error connecting to Salesforce: Authentication failed.
+
+# error.AuthenticationError.Actions
+
+- Verify your credentials
+- Run 'sf org login' to reauthenticate
+- Check if your session has expired
+
+# error.GenericError
+
+Error deleting template: %s
+
+# error.GenericError.Actions
+
+- Review the error message for details
+- Check if you have permission to delete templates
+- Verify the template isn't being used by active apps
+
+# deleteAppSuccess
+
+Successfully deleted app '%s' (ID: %s)
+
+# decoupleAppSuccess
+
+Successfully decoupled app '%s' (ID: %s) from template
+
+# deletionCancelled
+
+Template deletion cancelled.
+
+# examples
+
+- <%= config.bin %> <%= command.id %> --template-id 0XtB000000001aXYAQ
+- <%= config.bin %> <%= command.id %> --template-name "My Template"
+- <%= config.bin %> <%= command.id %> --template-id 0XtB000000001aXYAQ --force-delete
+- <%= config.bin %> <%= command.id %> --template-id 0XtB000000001aXYAQ --no-prompt

package/messages/appframework.display.app.md

@@ -0,0 +1,70 @@
+# summary
+
+Display details of an AppFramework app.
+
+# description
+
+Display detailed information about a specific AppFramework app. You must specify either the --app-id or --app-name flag to identify the app.
+
+# flags.target-org.summary
+
+Login username or alias for the target org.
+
+# flags.target-org.description
+
+Overrides your default org.
+
+# flags.api-version.summary
+
+Override the api version used for api requests made by this command.
+
+# flags.api-version.description
+
+Override the api version used for api requests made by this command.
+
+# flags.app-id.summary
+
+ID of the app to display.
+
+# flags.app-id.description
+
+Specify the ID of the app to display. Either this or --app-name is required.
+
+# flags.app-name.summary
+
+Name of the app to display.
+
+# flags.app-name.description
+
+Specify the name of the app to display. Either this or --app-id is required.
+
+# noAppSpecified
+
+No app specified. You must specify either an app ID with --app-id or an app name with --app-name.
+
+# fetchingApp
+
+Fetching app details...
+
+# noAppFound
+
+No app found with the specified ID or name.
+
+# error.RetrievalError
+
+Failed to retrieve app details: %s
+
+# error.RetrievalError.Actions
+
+- Check that the app ID or name is correct
+- Verify you have permissions to view apps in this org
+- Ensure your authentication to the org is valid
+- Try running with --debug for more details
+
+# examples
+
+- Display app details by ID:
+  <%= config.bin %> <%= command.id %> --app-id 00Dxx0000000001
+
+- Display app details by name:
+  <%= config.bin %> <%= command.id %> --app-name "My App"

package/messages/appframework.display.template.md

@@ -0,0 +1,101 @@
+# summary
+
+Display details of an AppFramework template.
+
+# description
+
+Shows detailed information about a specific AppFramework template including its name, label, ID, type, and other properties.
+
+# flags.template-id.summary
+
+The ID of the template to display.
+
+# flags.template-id.description
+
+Specify the unique identifier of the template you want to display. Use this flag when you know the template's ID.
+
+# flags.template-name.summary
+
+The name of the template to display.
+
+# flags.template-name.description
+
+Specify the name of the template you want to display. Use this flag when you know the template's name but not its ID.
+
+# flags.target-org.summary
+
+Login username or alias for the target org
+
+# flags.target-org.description
+
+The target org to connect to for displaying the template.
+
+# flags.api-version.summary
+
+Override the api version used for api requests
+
+# flags.api-version.description
+
+Override the api version used for api requests to the app framework.
+
+# fetchingTemplate
+
+Fetching AppFramework template...
+
+# error.MissingRequiredFlag
+
+Either --template-id or --template-name must be provided
+
+# error.MissingRequiredFlag.Actions
+
+- Use --template-id to specify a template by ID
+- Use --template-name to specify a template by name
+
+# error.CertificateError
+
+Error retrieving AppFramework template: Certificate validation error
+
+# error.CertificateError.Actions
+
+- This appears to be a certificate validation issue, which is common in dev environments
+- Try specifying the API version with --api-version=64.0 (or your org's version)
+- Make sure you're using the correct org with -o YOUR_ORG_ALIAS
+- If using a sandbox or scratch org, ensure your connection is properly authenticated
+
+# error.AuthenticationError
+
+Error retrieving AppFramework template: Authentication issue
+
+# error.AuthenticationError.Actions
+
+- Your session may have expired or you may not have permission to access this resource
+- Try running sf org refresh to update your credentials
+- Ensure you have AppFramework enabled and have permission to view templates
+
+# error.TemplateNotFound
+
+Template %s not found
+
+# error.TemplateNotFound.Actions
+
+- Verify that you have the correct template ID or name
+- Ensure the template exists in this org
+- Check your permissions to view templates
+
+# error.GenericError
+
+Error retrieving AppFramework template: %s
+
+# error.GenericError.Actions
+
+- Verify that you are using an org with AppFramework enabled
+- Check that the template ID or name is correct
+- Check your credentials and permissions
+- Try running sf org refresh to update your credentials
+
+# examples
+
+- Display a template using its ID:
+  <%= config.bin %> <%= command.id %> --template-id 01RM0000000HwBGMA0
+- Display a template using its name:
+  <%= config.bin %> <%= command.id %> --template-name MyTemplate

package/messages/appframework.list.app.md

@@ -0,0 +1,126 @@
+# summary
+
+List AppFramework apps in your org.
+
+# description
+
+Lists all AppFramework apps in your org. You can filter the results by template type and other criteria.
+
+# flags.target-org.summary
+
+Login username or alias for the target org.
+
+# flags.target-org.description
+
+Overrides your default org.
+
+# flags.api-version.summary
+
+Override the api version used for api requests made by this command.
+
+# flags.api-version.description
+
+Override the api version used for api requests made by this command.
+
+# flags.filter-type.summary
+
+Filter apps by template type.
+
+# flags.filter-type.description
+
+Only show apps with the specified template type, such as 'app', 'dashboard', or 'analytics'.
+
+# flags.filter-subtype.summary
+
+Filter apps by template subtype.
+
+# flags.filter-subtype.description
+
+Only show apps with the specified template subtype.
+
+# flags.json.summary
+
+Format output as JSON.
+
+# flags.json.description
+
+Format output as a JSON array of app records.
+
+# flags.csv.summary
+
+Format output as CSV.
+
+# flags.csv.description
+
+Format output as CSV on the specified fields.
+
+# flags.csv-fields.summary
+
+Fields to include when generating CSV output.
+
+# flags.csv-fields.description
+
+Specify a comma-separated list of field API names to include in the CSV output.
+
+# fetchingApps
+
+Fetching apps from AppFramework. This might take a moment...
+
+# noAppsFound
+
+No AppFramework apps found in the org.
+
+# emptyFilteredApps
+
+No apps found matching the specified filters.
+
+# error.ListError
+
+Failed to list apps: %s
+
+# error.ListError.Actions
+
+- Verify you have permissions to view apps in this org
+- Ensure your authentication to the org is valid
+- Try running with --debug for more details
+
+# examples
+
+- List all AppFramework apps in your default org:
+  <%= config.bin %> <%= command.id %>
+- List apps with a specific API version:
+  <%= config.bin %> <%= command.id %> --api-version=64.0
+
+# noResultsFound
+
+No AppFramework apps found in the org.
+
+# error.CertificateError
+
+Certificate error: Unable to connect to the org. This is typically caused by an SSL certificate error.
+
+# error.CertificateError.Actions
+
+- Check your network connection and try again.
+- Ensure that your network is not blocking or intercepting HTTPS requests.
+- If you are behind a corporate proxy, ensure that your proxy certificates are properly configured.
+
+# error.AuthenticationError
+
+Authentication error: Unable to authenticate with the org. Please check your credentials and try again.
+
+# error.AuthenticationError.Actions
+
+- Use `sf org login` to log in to the org again.
+- Ensure that your user has the necessary permissions to access the AppFramework API.
+- Check if your authentication token has expired.
+
+# error.GenericError
+
+An error occurred while listing apps: %s
+
+# error.GenericError.Actions
+
+- Check the error message above for more details.
+- Ensure that AppFramework is enabled in your org.
+- Ensure that your user has the necessary permissions.

package/messages/appframework.list.template.md

@@ -0,0 +1,78 @@
+# summary
+
+List all available AppFramework templates in the target org.
+
+# description
+
+Lists AppFramework templates available in the target org. Shows template name, label, ID and other information.
+
+# flags.target-org.summary
+
+Login username or alias for the target org
+
+# flags.target-org.description
+
+The target org to connect to for listing templates.
+
+# flags.api-version.summary
+
+Override the api version used for api requests
+
+# flags.api-version.description
+
+Override the api version used for api requests to the app framework.
+
+# templatesFound
+
+Found %s AppFramework templates:
+
+# noResultsFound
+
+No AppFramework templates found.
+
+# fetchingTemplates
+
+Fetching AppFramework templates...
+
+# templateTypeLegend
+
+Legend: %s - Application templates, %s - Component templates, %s - Other template types
+
+# error.CertificateError
+
+Error retrieving AppFramework templates: Certificate validation error
+
+# error.CertificateError.Actions
+
+- This appears to be a certificate validation issue, which is common in dev environments
+- Try specifying the API version with --api-version=64.0 (or your org's version)
+- Make sure you're using the correct org with -o YOUR_ORG_ALIAS
+- If using a sandbox or scratch org, ensure your connection is properly authenticated
+
+# error.AuthenticationError
+
+Error retrieving AppFramework templates: Authentication issue
+
+# error.AuthenticationError.Actions
+
+- Your session may have expired or you may not have permission to access this resource
+- Try running sf org refresh to update your credentials
+- Ensure you have AppFramework enabled and have permission to view templates
+
+# error.GenericError
+
+Error retrieving AppFramework templates: %s
+
+# error.GenericError.Actions
+
+- Verify that you are using an org with AppFramework enabled
+- Check that your credentials and permissions are valid
+- Check your internet connection
+- Try running sf org refresh to update your credentials
+
+# examples
+
+- List all AppFramework templates in your default org:
+  <%= config.bin %> <%= command.id %>
+- List templates with a specific API version:
+  <%= config.bin %> <%= command.id %> --api-version=64.0

package/messages/appframework.template.create.md

@@ -0,0 +1,82 @@
+# summary
+
+Create a new AppFramework template.
+
+# description
+
+Creates a new empty template that can be customized. Templates allow you to define reusable configurations for AppFramework applications.
+
+# flags.target-org.summary
+
+Login username or alias for the target org
+
+# flags.target-org.description
+
+The target org to connect to for creating the template.
+
+# flags.api-version.summary
+
+Override the api version used for api requests
+
+# flags.api-version.description
+
+Override the api version used for api requests to the app framework.
+
+# flags.name.summary
+
+Name for the new template (required)
+
+# flags.name.description
+
+A unique identifier for the template. Must be unique within your org.
+
+# flags.type.summary
+
+Type of template to create
+
+# flags.type.description
+
+Specifies the type of template to create. Valid options are: app, component, dashboard, or lens. Defaults to 'app' if not specified.
+
+# flags.subtype.summary
+
+Subtype for the template
+
+# flags.subtype.description
+
+An optional subtype categorization for the template (e.g., 'tableau' for app templates).
+
+# flags.label.summary
+
+Label for the new template
+
+# flags.label.description
+
+A human-readable label for the template. This is displayed in the Analytics Studio UI.
+
+# flags.description.summary
+
+Description of the new template
+
+# flags.description.description
+
+A description of what the template does. This is displayed in the Analytics Studio UI.
+
+# fetchingApp
+
+Fetching app information...
+
+# creatingTemplate
+
+Creating template from app...
+
+# createSuccess
+
+Successfully created template with ID: %s
+
+# examples
+
+- <%= config.bin %> <%= command.id %> --target-org myOrg --name "my_template"
+- <%= config.bin %> <%= command.id %> --target-org myOrg --name "sales_template" --type app --label "My Custom Template"
+- <%= config.bin %> <%= command.id %> --target-org myOrg --name "dashboard_template" --type dashboard --subtype "analytics"
+- <%= config.bin %> <%= command.id %> --target-org myOrg --name "analytics_template" --type app --subtype "tableau" --label "Sales Template" --description "Template for sales analytics apps"