@kizenapps/packager 0.3.0 → 0.4.0-6ad8aed

package/dist/index.d.ts

@@ -1,95 +1,98 @@
-type FileContent = {
+interface FileContent {
     path: string;
     content: string;
     base64Image?: string;
     binaryData?: Buffer;
-};
+}
 type MinifiedFileContent = FileContent & {
     minified: string;
 };
 
 declare const minifyFiles: (files: FileContent[]) => Promise<MinifiedFileContent[]>;
 
-type PublishableEnvironments = "go" | "fmo" | "staging" | "integration" | "e2e-integration" | "e2e-staging" | "test1";
-type EnvironmentAliases = "prod" | "dev" | "testing";
-type Environment = PublishableEnvironments | EnvironmentAliases;
-type ManifestFileContent = {
+declare const PUBLISHABLE_ENVIRONMENTS: readonly ["go", "fmo", "staging", "integration", "e2e-integration", "e2e-staging", "test1"];
+declare const ENVIRONMENT_ALIASES: readonly ["prod", "dev", "testing"];
+declare const ENVIRONMENTS: readonly ["go", "fmo", "staging", "integration", "e2e-integration", "e2e-staging", "test1", "prod", "dev", "testing"];
+type PublishableEnvironments = (typeof PUBLISHABLE_ENVIRONMENTS)[number];
+type EnvironmentAliases = (typeof ENVIRONMENT_ALIASES)[number];
+type Environment = (typeof ENVIRONMENTS)[number];
+interface ManifestFileContent {
     version: string;
     api_name: string;
     name: string;
     engine: string;
     description: string;
-    release_branches: string[];
-    release_environments: Array<Environment>;
+    release_branches?: string[];
+    release_environments?: Environment[];
     entry: string;
     release_notes_directory?: string;
     config_template?: Record<string, unknown>;
     base_config?: Record<string, unknown>;
     setup_assistant?: SetupAssistantConfig;
     user_setup_assistant?: SetupAssistantConfig;
-    services?: Array<Record<string, unknown>>;
-    published: boolean;
+    services?: Record<string, unknown>[];
+    published?: boolean;
     developer_business_id?: string | Record<PublishableEnvironments, string>;
     block_loading_for_setup?: boolean;
-};
-type SetupAssistantField = {
+}
+interface SetupAssistantField {
     key: string;
-    type: "custom_object" | "description" | "container" | "field" | "text" | "number" | "select" | "boolean";
+    type: 'custom_object' | 'description' | 'container' | 'field' | 'text' | 'number' | 'select' | 'boolean';
     columns?: number;
-    fields?: Array<SetupAssistantField>;
+    fields?: SetupAssistantField[];
     content?: string;
     label?: string;
     object_id?: string;
     default?: string;
-    options?: Array<{
+    options?: {
         label: string;
         value: string;
-    }>;
+    }[];
     allow_multiple?: boolean;
     placeholder?: string;
     when?: string;
-};
-type SetupAssistantConfig = {
-    fields?: Array<SetupAssistantField>;
-    actions?: Array<string>;
-};
-type ManifestFile = ManifestFileContent | Array<ManifestFileContent>;
+}
+interface SetupAssistantConfig {
+    fields?: SetupAssistantField[];
+    actions?: string[];
+}
+type ManifestFile = ManifestFileContent | ManifestFileContent[];
 
-type CalendarSource = {
+interface CalendarSource {
     api_name: string;
     name: string;
     calendars_script: string;
     events_script: string;
     when: string;
-};
+}
 type CalendarSourcesMap = Record<string, CalendarSource>;
-type ObjectSettingsItem = {
+interface ObjectSettingsItem {
     api_name: string;
     label: string;
     script: string;
     when: string;
-};
+}
 type ObjectSettingsItemsMap = Record<string, ObjectSettingsItem>;
 type EventScripts = Record<string, string>;
-type JSAction = {
+interface JSAction {
     name: string;
     hint_object_name: string;
     api_name: string;
     script: string;
-};
+}
 type JSActionsMap = Record<string, JSAction>;
-type RouteScript = {
+interface RouteScript {
     script: string;
     api_name: string;
     hint_object_name: string;
-    routes: Array<string>;
+    routes: string[];
     name: string;
-};
+}
 type RouteScriptsMap = Record<string, RouteScript>;
-type RoutablePage = {
+interface RoutablePage {
     name: string;
     api_name: string;
-    type: "script" | "html";
+    type: 'script' | 'html';
     css: string;
     event_scripts: EventScripts;
     callback: string;
@@ -99,35 +102,35 @@ type RoutablePage = {
     script: string;
     html: string;
     iframe_url: string;
-};
+}
 type RoutablePagesMap = Record<string, RoutablePage>;
-type ToolbarItem = {
+interface ToolbarItem {
     api_name: string;
     label: string;
     icon: string;
     color: string;
     script: string;
     when: string;
-};
+}
 type ToolbarItemsMap = Record<string, ToolbarItem>;
-type DataAdornmentConfig = {
+interface DataAdornmentConfig {
     icon: string;
     color: string;
     tooltip: string;
     customIcon?: string;
-};
-type DataAdornment = {
+}
+interface DataAdornment {
     config: DataAdornmentConfig;
-    field_type: "phonenumber" | "date" | "datetime";
+    field_type: 'phonenumber' | 'date' | 'datetime';
     script: string;
     when: string;
-};
+}
 type DataAdornmentsMap = Record<string, DataAdornment>;
-type FloatingFrame = {
+interface FloatingFrame {
     name: string;
     api_name: string;
     title: string;
-    type: "script";
+    type: 'script';
     css: string;
     event_scripts: EventScripts;
     default_position: string;
@@ -135,17 +138,17 @@ type FloatingFrame = {
     header_text_color: string;
     height: number;
     width: number;
-    ignore: Array<string>;
-    match: Array<string>;
+    ignore: string[];
+    match: string[];
     message_handler: string;
-    minimized_style: "bar" | "circle" | "none";
+    minimized_style: 'bar' | 'circle' | 'none';
     minimized_config: Record<string, unknown>;
     script: string;
     html: string;
     when: string;
-};
+}
 type FloatingFramesMap = Record<string, FloatingFrame>;
-type Block = {
+interface Block {
     name: string;
     api_name: string;
     min_w: number;
@@ -156,21 +159,21 @@ type Block = {
     event_scripts: EventScripts;
     script: string;
     styles: string;
-    types?: Array<string>;
+    types?: string[];
     when: string;
-};
+}
 type BlocksMap = Record<string, Block>;
 type AutomationScriptRuntimeInput = `${string} ${number}.${number}`;
 type AutomationScriptRuntimeOutput = `${string}-${number}-${number}`;
-type AutomationStep = {
+interface AutomationStep {
     name: string;
     action_step_api_name: string;
     overall_description: string;
     action_description: string;
     action_type: string;
     script_runtime: AutomationScriptRuntimeOutput;
-    secrets: Array<string>;
-    inputs: Array<{
+    secrets: string[];
+    inputs: {
         name: string;
         label: string;
         data_type: string;
@@ -179,8 +182,8 @@ type AutomationStep = {
         hint_field_name: string;
         hint_related_object_field_name: string;
         script_alias: string;
-    }>;
-    outputs: Array<{
+    }[];
+    outputs: {
         name: string;
         label: string;
         data_type: string;
@@ -189,14 +192,14 @@ type AutomationStep = {
         hint_field_name: string;
         hint_related_object_field_name: string;
         script_alias: string;
-        conflict_resolution: "overwrite" | "skip" | "append";
+        conflict_resolution: 'overwrite' | 'skip' | 'append';
         create_field_options: boolean;
-    }>;
+    }[];
     script: string;
     when: string;
-};
+}
 type AutomationStepsMap = Record<string, AutomationStep>;
-type PackagedPlugin = {
+interface PackagedPlugin {
     manifest: ManifestFileContent;
     floatingFrames: FloatingFramesMap;
     blocks: BlocksMap;
@@ -211,21 +214,22 @@ type PackagedPlugin = {
     releaseNotes?: string;
     kznFile: Uint8Array | null;
     calendarSources: CalendarSourcesMap;
-};
+}
 type ProcessedPluginPackage = Record<string, PackagedPlugin>;
-type DeployablePlugin = ManifestFileContent & {
+type DeployablePlugin = Omit<ManifestFileContent, 'setup_assistant'> & {
     api_name: string;
+    setup_assistant?: SetupAssistantConfig | undefined;
     artifacts: {
-        data_adornments: Array<DataAdornment>;
-        floating_frames: Array<FloatingFrame>;
-        custom_blocks: Array<Block>;
-        routable_pages: Array<RoutablePage>;
-        toolbar_items: Array<ToolbarItem>;
-        js_action_templates: Array<JSAction>;
-        route_scripts: Array<RouteScript>;
-        object_settings_menu_items: Array<ObjectSettingsItem>;
-        automation_action_configs: Array<AutomationStep>;
-        calendar_sources: Array<CalendarSource>;
+        data_adornments: DataAdornment[];
+        floating_frames: FloatingFrame[];
+        custom_blocks: Block[];
+        routable_pages: RoutablePage[];
+        toolbar_items: ToolbarItem[];
+        js_action_templates: JSAction[];
+        route_scripts: RouteScript[];
+        object_settings_menu_items: ObjectSettingsItem[];
+        automation_action_configs: AutomationStep[];
+        calendar_sources: CalendarSource[];
     };
     thumbnail: Uint8Array | null;
     kznFile: Uint8Array | null;
@@ -245,30 +249,63 @@ declare const parseManifestFromFiles: (files: MinifiedFileContent[]) => Manifest
 
 declare const transformDeployablePlugin: (packagedPlugin: PackagedPlugin) => DeployablePlugin;
 
+/**
+ * Derives a fallback api_name from a directory name, targeting the alphabet of
+ * API_NAME_PATTERN (/^[a-z_][a-z0-9_]+$/): the result is lowercased, runs of
+ * hyphens and whitespace collapse to a single underscore, and any remaining
+ * character outside [a-z0-9_] is dropped. A leading digit or too-short result
+ * is left intact so validation can reject it loudly rather than silently
+ * padding it into something valid.
+ */
 declare const sanitizeToAPIName: (name: string) => string;
 declare const scriptRuntimeToApiName: (runtime: AutomationScriptRuntimeInput) => AutomationScriptRuntimeOutput;
 
+type ValidationSeverity = 'error' | 'warning';
+interface ValidationIssue {
+    /** Stable rule id, e.g. "manifest/api-name-format". */
+    rule: string;
+    severity: ValidationSeverity;
+    /** Canonical message, shared verbatim by every consumer. */
+    message: string;
+    /** Repo-relative path of the file (or directory) the issue was found in. */
+    path?: string;
+    /** api_name of the owning manifest entry, when known (multi-app repos). */
+    pluginApiName?: string;
+}
+declare const errorIssue: (rule: string, message: string, path?: string, pluginApiName?: string) => ValidationIssue;
+/**
+ * Structured error carrying the same issue shape as validatePluginApp, so
+ * pre-flight results and packaging-stage throws render identically.
+ */
+declare class PluginValidationError extends Error {
+    issues: ValidationIssue[];
+    constructor(issues: ValidationIssue[]);
+}
+
+declare const API_NAME_PATTERN: RegExp;
+declare const validatePluginApp: (files: FileContent[]) => ValidationIssue[];
+
 declare const imagetoUint8Array: (base64Image: string) => Uint8Array;
 declare const zipToUint8Array: (zip: Buffer) => Uint8Array;
 
 declare const CRYPTO_VERSION: 1;
 declare const CRYPTO_ALG: "RSA-OAEP-256+A256GCM";
-type CryptoEnvelope = {
+interface CryptoEnvelope {
     v: typeof CRYPTO_VERSION;
     alg: typeof CRYPTO_ALG;
     k: string;
     iv: string;
     tag: string;
     ct: string;
-};
-type Keypair = {
+}
+interface Keypair {
     publicKey: string;
     privateKey: string;
-};
-type EncryptedValue = {
+}
+interface EncryptedValue {
     encrypted: true;
     value: string;
-};
+}
 declare const generateKeypair: () => Keypair;
 declare const encrypt: (plaintext: string, publicKeyPem: string) => CryptoEnvelope;
 declare const decrypt: (envelope: CryptoEnvelope, privateKeyPem: string) => string;
@@ -302,8 +339,8 @@ declare const CONFIG_FILE_NAME = "config.json";
 declare const STYLES_FILE_NAME = "styles.css";
 declare const MANIFEST_FILE_NAME = "kizen.json";
 declare const KZN_FILE_NAME = "import.kzn";
-declare const maybeParseConfig: (content: string | undefined, path: string) => Record<string, unknown>;
+declare const maybeParseConfig: (content: string | undefined, path: string, pluginApiName?: string) => Record<string, unknown>;
 declare const getMinimizedConfig: (config: Record<string, unknown>, entry: string, splitPath: string[], consideredFiles: MinifiedFileContent[]) => Record<string, unknown>;
 declare const getAdornmentIcon: (config: Record<string, unknown>, entry: string, splitPath: string[], consideredFiles: MinifiedFileContent[]) => string;
 
-export { AUTOMATION_SCRIPT_FILE, AUTOMATION_STEPS_DIRECTORY_NAME, type AutomationScriptRuntimeInput, type AutomationScriptRuntimeOutput, type AutomationStep, type AutomationStepsMap, BLOCKS_DIRECTORY_NAME, BROWSER_ROUTE_SCRIPTS_DIRECTORY_NAME, type Block, type BlocksMap, CALENDAR_SOURCES_DIRECTORY_NAME, CALLBACK_SCRIPT_FILE, CONFIG_FILE_NAME, CRYPTO_ALG, CRYPTO_VERSION, type CalendarSource, type CalendarSourcesMap, type CryptoEnvelope, DATA_ADORNMENTS_DIRECTORY_NAME, type DataAdornment, type DataAdornmentConfig, type DataAdornmentsMap, type DeployablePlugin, EVENT_SCRIPTS_DIRECTORY_NAME, type EncryptedValue, type Environment, type EnvironmentAliases, type EventScripts, FLOATING_FRAMES_DIRECTORY_NAME, type FileContent, type FloatingFrame, type FloatingFramesMap, type JSAction, type JSActionsMap, JS_ACTIONS_DIRECTORY_NAME, KZN_FILE_NAME, type Keypair, MAIN_SCRIPT_FILE, MANIFEST_FILE_NAME, MESSAGE_SCRIPT_FILE, type ManifestFile, type ManifestFileContent, type MinifiedFileContent, OBJECT_SETTINGS_ITEMS_DIRECTORY_NAME, type ObjectSettingsItem, type ObjectSettingsItemsMap, type PackagedPlugin, type ProcessedPluginPackage, type PublishableEnvironments, RELEASE_NOTES_EXTENSION, ROUTABLE_PAGES_DIRECTORY_NAME, type RoutablePage, type RoutablePagesMap, type RouteScript, type RouteScriptsMap, SCRIPT_EXTENSION, SETUP_ASSISTANT_DIRECTORY_NAME, STYLES_FILE_NAME, type SetupAssistantConfig, type SetupAssistantField, THUMBNAIL_FILE_NAMES, TOOLBAR_ITEMS_DIRECTORY_NAME, type ToolbarItem, type ToolbarItemsMap, USER_SETUP_ASSISTANT_DIRECTORY_NAME, decrypt, deserializeEnvelope, encrypt, generateKeypair, getAdornmentIcon, getMinimizedConfig, imagetoUint8Array, maybeParseConfig, minifyFiles, packagePlugin, parseManifestFromFiles, roundTripVerify, sanitizeToAPIName, scriptRuntimeToApiName, serializeEnvelope, thumbnailImageExtensions, transformDeployablePlugin, triggerImageExtensions, zipToUint8Array };
+export { API_NAME_PATTERN, AUTOMATION_SCRIPT_FILE, AUTOMATION_STEPS_DIRECTORY_NAME, type AutomationScriptRuntimeInput, type AutomationScriptRuntimeOutput, type AutomationStep, type AutomationStepsMap, BLOCKS_DIRECTORY_NAME, BROWSER_ROUTE_SCRIPTS_DIRECTORY_NAME, type Block, type BlocksMap, CALENDAR_SOURCES_DIRECTORY_NAME, CALLBACK_SCRIPT_FILE, CONFIG_FILE_NAME, CRYPTO_ALG, CRYPTO_VERSION, type CalendarSource, type CalendarSourcesMap, type CryptoEnvelope, DATA_ADORNMENTS_DIRECTORY_NAME, type DataAdornment, type DataAdornmentConfig, type DataAdornmentsMap, type DeployablePlugin, ENVIRONMENTS, ENVIRONMENT_ALIASES, EVENT_SCRIPTS_DIRECTORY_NAME, type EncryptedValue, type Environment, type EnvironmentAliases, type EventScripts, FLOATING_FRAMES_DIRECTORY_NAME, type FileContent, type FloatingFrame, type FloatingFramesMap, type JSAction, type JSActionsMap, JS_ACTIONS_DIRECTORY_NAME, KZN_FILE_NAME, type Keypair, MAIN_SCRIPT_FILE, MANIFEST_FILE_NAME, MESSAGE_SCRIPT_FILE, type ManifestFile, type ManifestFileContent, type MinifiedFileContent, OBJECT_SETTINGS_ITEMS_DIRECTORY_NAME, type ObjectSettingsItem, type ObjectSettingsItemsMap, PUBLISHABLE_ENVIRONMENTS, type PackagedPlugin, PluginValidationError, type ProcessedPluginPackage, type PublishableEnvironments, RELEASE_NOTES_EXTENSION, ROUTABLE_PAGES_DIRECTORY_NAME, type RoutablePage, type RoutablePagesMap, type RouteScript, type RouteScriptsMap, SCRIPT_EXTENSION, SETUP_ASSISTANT_DIRECTORY_NAME, STYLES_FILE_NAME, type SetupAssistantConfig, type SetupAssistantField, THUMBNAIL_FILE_NAMES, TOOLBAR_ITEMS_DIRECTORY_NAME, type ToolbarItem, type ToolbarItemsMap, USER_SETUP_ASSISTANT_DIRECTORY_NAME, type ValidationIssue, type ValidationSeverity, decrypt, deserializeEnvelope, encrypt, errorIssue, generateKeypair, getAdornmentIcon, getMinimizedConfig, imagetoUint8Array, maybeParseConfig, minifyFiles, packagePlugin, parseManifestFromFiles, roundTripVerify, sanitizeToAPIName, scriptRuntimeToApiName, serializeEnvelope, thumbnailImageExtensions, transformDeployablePlugin, triggerImageExtensions, validatePluginApp, zipToUint8Array };