@salesforce/plugin-orchestrator 1.0.0

package/lib/utils/template/templateTypes.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Template type enum
+ */
+export declare enum TemplateType {
+    DASHBOARD = "dashboard",
+    LIBRARY = "library"
+}
+export type FolderSource = {
+    id?: string;
+    name?: string;
+};
+export type ReleaseInfo = {
+    templateVersion?: string;
+    notesFile?: string | null;
+};
+export type ChainDefinition = {
+    type?: string;
+    file?: string;
+    name?: string | null;
+    dominoChainId?: string | null;
+};
+export type Rule = {
+    type?: string;
+    file?: string;
+};
+export type Icon = {
+    appBadge?: string | null;
+    templatePreviews?: Array<{
+        namespace?: string | null;
+        name?: string | null;
+        id?: string | null;
+        url?: string | null;
+        label?: string | null;
+        description?: string | null;
+    }> | null;
+    templateBadge?: {
+        name?: string;
+        url?: string;
+    } | null;
+};
+export type Tags = {
+    [key: string]: unknown;
+    highlights?: string[];
+    targetAudience?: string[];
+    industries?: string[];
+    requirements?: string[];
+    includes?: string[];
+    categories?: string[];
+};
+/**
+ * Interface for raw template data returned from the API
+ */
+export type RawTemplate = {
+    id: string;
+    name?: string;
+    label?: string;
+    description?: string;
+    templateType?: string;
+    templateSubtype?: string | null;
+    templateId?: string;
+    folderId?: string;
+    namespace?: string | null;
+    releaseInfo?: ReleaseInfo;
+    assetVersion?: number;
+    maxAppCount?: number | null;
+    variableDefinition?: null;
+    layoutDefinition?: null;
+    rules?: Rule[];
+    createdDate?: string;
+    lastModifiedDate?: string;
+    tags?: Tags;
+    icons?: Icon | null;
+    chainDefinitions?: ChainDefinition[];
+    applicationSourceId?: string | null;
+    folderSource?: FolderSource;
+    url?: string;
+    configurationUrl?: string;
+    readinessUrl?: string;
+};
+/**
+ * Interface for processed template data used in the UI
+ * Alias RawTemplateData to RawTemplate for backward compatibility
+ */
+export type RawTemplateData = RawTemplate;
+/**
+ * Interface for processed template data used in the UI
+ */
+export type TemplateData = {
+    id?: string;
+    name?: string;
+    label?: string;
+    description?: string;
+    templateType?: string;
+    templateSubtype?: string | null;
+    templateId?: string;
+    folderId?: string;
+    namespace?: string | null;
+    templateVersion?: string;
+    assetVersion?: number;
+    maxAppCount?: number | null;
+    variableDefinition?: null;
+    layoutDefinition?: null;
+    rules?: Rule[];
+    created?: string;
+    modified?: string;
+    industries?: string;
+    audience?: string;
+    icons?: Icon | null;
+    chainDefinitions?: ChainDefinition[];
+    applicationSourceId?: string | null;
+    url?: string;
+    configurationUrl?: string;
+    readinessUrl?: string;
+};

package/lib/utils/template/templateTypes.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+/**
+ * Template type enum
+ */
+export var TemplateType;
+(function (TemplateType) {
+    TemplateType["DASHBOARD"] = "dashboard";
+    TemplateType["LIBRARY"] = "library";
+})(TemplateType || (TemplateType = {}));
+//# sourceMappingURL=templateTypes.js.map

package/lib/utils/template/templateTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateTypes.js","sourceRoot":"","sources":["../../../src/utils/template/templateTypes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,mCAAmB,CAAA;AACrB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB"}

package/lib/utils/utils.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generates columns for a table
+ *
+ * @param keys - Array of keys for column headers
+ * @returns Object of column configurations
+ */
+export declare function generateTableColumns(keys: string[]): Record<string, {
+    header: string;
+}>;
+/**
+ * Format data as a pretty ASCII table
+ *
+ * @param data - Array of data objects
+ * @param columns - Object containing column definitions
+ * @returns Formatted table string
+ */
+export declare function formatAsTable<T extends Record<string, unknown>>(data: T[], columns: Array<{
+    key: keyof T;
+    label: string;
+    width?: number;
+}>): string[];

package/lib/utils/utils.js

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+/**
+ * Generates columns for a table
+ *
+ * @param keys - Array of keys for column headers
+ * @returns Object of column configurations
+ */
+export function generateTableColumns(keys) {
+    return keys.reduce((result, key) => {
+        const newResult = { ...result };
+        newResult[key] = { header: key.charAt(0).toUpperCase() + key.slice(1) };
+        return newResult;
+    }, {});
+}
+/**
+ * Format data as a pretty ASCII table
+ *
+ * @param data - Array of data objects
+ * @param columns - Object containing column definitions
+ * @returns Formatted table string
+ */
+export function formatAsTable(data, columns) {
+    if (data.length === 0) {
+        return ['No data to display'];
+    }
+    const columnWidths = columns.map((col) => {
+        const headerLength = col.label.length;
+        const maxDataLength = Math.max(...data.map((item) => {
+            const value = item[col.key] ?? '';
+            return String(value).length;
+        }));
+        return col.width ?? Math.max(headerLength, maxDataLength, 10);
+    });
+    const headerRow = columns.map((col, i) => col.label.padEnd(columnWidths[i])).join(' | ');
+    const separatorRow = columns.map((_, i) => '-'.repeat(columnWidths[i])).join('-+-');
+    const dataRows = data.map((item) => columns
+        .map((col, i) => {
+        const value = item[col.key] ?? '';
+        return String(value).padEnd(columnWidths[i]);
+    })
+        .join(' | '));
+    return [headerRow, separatorRow, ...dataRows];
+}
+//# sourceMappingURL=utils.js.map

package/lib/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAc;IACjD,OAAO,IAAI,CAAC,MAAM,CAAqC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QACrE,MAAM,SAAS,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;QAChC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACxE,OAAO,SAAS,CAAC;IACnB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAS,EACT,OAA+D;IAE/D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACvC,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;QACtC,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAC5B,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACnB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAClC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;QAC9B,CAAC,CAAC,CACH,CAAC;QACF,OAAO,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAEzF,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAEpF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACjC,OAAO;SACJ,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC,CAAC;SACD,IAAI,CAAC,KAAK,CAAC,CACf,CAAC;IAEF,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,CAAC;AAChD,CAAC"}

package/messages/appframework.create.app.md

@@ -0,0 +1,124 @@
+# summary
+
+Create a new AppFramework app from a template.
+
+# description
+
+Creates a new app from an existing template. The app will be initialized with the configuration defined in the template.
+
+# flags.target-org.summary
+
+Username or alias of the target org.
+
+# flags.target-org.description
+
+Username or alias of the target org. Not required if the `target-org` configuration variable is already set.
+
+# 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.name.summary
+
+Name for the new app (required)
+
+# flags.name.description
+
+A unique identifier for the app. Must be unique within your org.
+
+# flags.label.summary
+
+Label for the new app
+
+# flags.label.description
+
+A human-readable label for the app. If not provided, the name will be used.
+
+# flags.description.summary
+
+Description of the new app
+
+# flags.description.description
+
+A description of what the app does.
+
+# flags.template-id.summary
+
+ID of the template to use for creating the app
+
+# flags.template-id.description
+
+ID of an existing template to use for creating the app. Either template-id or template-name must be provided.
+
+# flags.template-name.summary
+
+Name of the template to use for creating the app
+
+# flags.template-name.description
+
+Name of an existing template to use for creating the app. Either template-id or template-name must be provided.
+
+# flags.runtime-method.summary
+
+Runtime method for the app (sync or async)
+
+# flags.runtime-method.description
+
+Specifies how the app's runtime operates, either synchronously or asynchronously.
+
+# flags.log-level.summary
+
+Log level for the app
+
+# flags.log-level.description
+
+Sets the logging level for the app. Valid options are: debug, info, warn, error.
+
+# fetchingTemplate
+
+Fetching template information...
+
+# creatingApp
+
+Creating app from template...
+
+# createSuccess
+
+Successfully created app with ID: %s
+
+# noTemplateSpecified
+
+Either template-id or template-name must be specified.
+
+# error.TemplateNotFound
+
+Template not found. Please check the template ID or name and try again.
+
+# error.TemplateNotFound.Actions
+
+- Verify that the template exists in your organization
+- Check that you have spelled the template name correctly
+- Try using the template ID instead of the name
+
+# error.AppCreationError
+
+An error occurred while creating the app: %s
+
+# error.AppCreationError.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
+
+# examples
+
+- Create a new app using a template ID:
+  <%= config.bin %> <%= command.id %> --target-org myOrg --name "my_app" --template-id 01t000000000123
+- Create a new app using a template name:
+  <%= config.bin %> <%= command.id %> --target-org myOrg --name "sales_app" --template-name "Sales_Template"
+- Create a new app with additional details:
+  <%= config.bin %> <%= command.id %> --target-org myOrg --name "analytics_app" --template-name "Analytics_Template" --label "My Analytics App" --description "Custom analytics application" --runtime-method async --log-level debug

package/messages/appframework.create.template.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"

package/messages/appframework.decouple.app.md

@@ -0,0 +1,82 @@
+# summary
+
+Decouple an AppFramework app from its template.
+
+# description
+
+Decouples an AppFramework app from its template. This allows the app to be modified independently without being affected by template updates. You must specify either the app-id or app-name flag to identify the app to decouple.
+
+# 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 decouple.
+
+# flags.app-id.description
+
+Specify the ID of the app to decouple. Either this or app-name is required.
+
+# flags.app-name.summary
+
+Name of the app to decouple.
+
+# flags.app-name.description
+
+Specify the name of the app to decouple. Either this or app-id is required.
+
+# noAppSpecified
+
+No app specified for decoupling. You must specify either an app ID with --app-id or an app name with --app-name.
+
+# fetchingApp
+
+Fetching app details...
+
+# decouplingApp
+
+Decoupling app from template...
+
+# noAppFound
+
+No app found with the specified ID or name.
+
+# noTemplateFound
+
+The specified app does not have an associated template to decouple from.
+
+# decoupleSuccess
+
+Successfully decoupled app: %s
+
+# error.DecoupleError
+
+Failed to decouple app: %s
+
+# error.DecoupleError.Actions
+
+- Check that the app ID or name is correct
+- Verify the app is associated with a template
+- Ensure you have permissions to decouple apps in this org
+- Try running with --debug for more details
+
+# examples
+
+- Decouple an app by ID:
+  <%= config.bin %> <%= command.id %> --app-id 00Dxx0000000001
+
+- Decouple an app by name:
+  <%= config.bin %> <%= command.id %> --app-name "My App"

package/messages/appframework.delete.app.md

@@ -0,0 +1,94 @@
+# summary
+
+Delete an AppFramework app.
+
+# description
+
+Deletes an app from AppFramework. Either the app ID or app name must be provided 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 delete.
+
+# flags.app-id.description
+
+Specify the ID of the app to delete. Either this or --app-name is required.
+
+# flags.app-name.summary
+
+Name of the app to delete.
+
+# flags.app-name.description
+
+Specify the name of the app to delete. Either this or --app-id is required.
+
+# flags.no-prompt.summary
+
+Skip confirmation prompt before deleting.
+
+# flags.no-prompt.description
+
+Disables the confirmation prompt that normally appears before deleting an app. Use with caution.
+
+# noAppSpecified
+
+No app specified for deletion. You must specify either an app ID with --app-id or an app name with --app-name.
+
+# fetchingApp
+
+Fetching app details...
+
+# deletingApp
+
+Deleting app...
+
+# noAppFound
+
+No app found with the specified ID or name.
+
+# confirmDelete
+
+Are you sure you want to delete the app '%s'? This action cannot be undone.
+
+# deleteCancelled
+
+App deletion cancelled.
+
+# deleteSuccess
+
+Successfully deleted app with ID: %s
+
+# error.DeleteError
+
+Failed to delete app: %s
+
+# error.DeleteError.Actions
+
+- Check that the app ID or name is correct
+- Verify you have permissions to delete apps in this org
+- Ensure your authentication to the org is valid
+- Try running with --debug for more details
+
+# examples
+
+- Delete an app using its ID:
+  <%= config.bin %> <%= command.id %> --app-id 01t5e000006lOjDAA2
+
+- Delete an app using its name:
+  <%= config.bin %> <%= command.id %> --app-name MyAppName