skedyul 0.1.34 → 0.1.37

package/dist/.build-stamp

@@ -0,0 +1 @@
+1768373827435

package/dist/config.d.ts

@@ -23,11 +23,37 @@ export interface AppModelDefinition {
     /** Description of what this model represents */
     description?: string;
 }
+/**
+ * Context passed to the install handler when a user installs the app.
+ */
+export interface InstallHandlerContext {
+    /** Environment variables from preInstall.env filled by the user */
+    env: Record<string, string>;
+    /** Workplace information */
+    workplace: {
+        id: string;
+        subdomain: string;
+    };
+}
+/**
+ * Result returned by the install handler.
+ */
+export interface InstallHandlerResult {
+    /** Additional environment variables to add to the installation */
+    env?: Record<string, string>;
+    /** Optional OAuth redirect URL - if provided, user is redirected before install completes */
+    redirect?: string;
+}
+/**
+ * Install handler function type.
+ */
+export type InstallHandler = (ctx: InstallHandlerContext) => Promise<InstallHandlerResult>;
 export interface InstallConfig {
     /**
      * Per-install environment variables.
      * These are configured by the user when installing the app.
      * Values are stored per-installation and can differ between installs.
+     * @deprecated Use preInstall.env and postInstall.env instead
      */
     env?: EnvSchema;
     /**
@@ -35,6 +61,35 @@ export interface InstallConfig {
      * Users will map these to their CRM models during installation.
      */
     appModels?: AppModelDefinition[];
+    /**
+     * Install handler - called when user clicks install.
+     * Use dynamic import: handler: import('./src/install')
+     */
+    handler?: Promise<{
+        default: InstallHandler;
+    }>;
+}
+/**
+ * Pre-install configuration.
+ * Variables collected BEFORE the app is installed (e.g., API keys, credentials).
+ */
+export interface PreInstallConfig {
+    /**
+     * Environment variables required before installation.
+     * User must provide these values during the install flow.
+     */
+    env?: EnvSchema;
+}
+/**
+ * Post-install configuration.
+ * Variables that can be configured AFTER the app is installed.
+ */
+export interface PostInstallConfig {
+    /**
+     * Environment variables configurable after installation.
+     * These appear in the Settings page of the installed app.
+     */
+    env?: EnvSchema;
 }
 export interface AppFieldVisibility {
     /** Show in data/detail view */
@@ -228,8 +283,21 @@ export interface SkedyulConfig {
     /**
      * Install-time configuration.
      * Defines what users need to configure when installing the app.
+     * @deprecated Use preInstall and postInstall instead
      */
     install?: InstallConfig;
+    /**
+     * Pre-install configuration.
+     * Environment variables collected BEFORE the app is installed.
+     * User must provide these values (e.g., API keys) during the install flow.
+     */
+    preInstall?: PreInstallConfig;
+    /**
+     * Post-install configuration.
+     * Environment variables that can be configured AFTER the app is installed.
+     * These appear in the Settings page of the installed app.
+     */
+    postInstall?: PostInstallConfig;
     /**
      * Communication channels this app provides.
      * Defines how the app can send/receive messages.
@@ -288,8 +356,12 @@ export interface SerializableSkedyulConfig {
     workflowsPath?: string;
     /** Global/version-level environment variable schema */
     env?: EnvSchema;
-    /** Install-time configuration */
+    /** Install-time configuration @deprecated Use preInstall and postInstall */
     install?: InstallConfig;
+    /** Pre-install configuration (env vars required before install) */
+    preInstall?: PreInstallConfig;
+    /** Post-install configuration (env vars configurable after install) */
+    postInstall?: PostInstallConfig;
     /** Communication channels this app provides */
     communicationChannels?: CommunicationChannelDefinition[];
     /** Workflows this app provides */
@@ -339,12 +411,19 @@ export declare function validateConfig(config: SkedyulConfig): {
 };
 /**
  * Get all required install env keys from a config
+ * @deprecated Use getRequiredPreInstallEnvKeys instead
  */
 export declare function getRequiredInstallEnvKeys(config: SkedyulConfig): string[];
+/**
+ * Get all required pre-install env keys from a config
+ */
+export declare function getRequiredPreInstallEnvKeys(config: SkedyulConfig): string[];
 /**
  * Get all env keys (both global and install) from a config
  */
 export declare function getAllEnvKeys(config: SkedyulConfig): {
     global: string[];
     install: string[];
+    preInstall: string[];
+    postInstall: string[];
 };

package/dist/config.js

@@ -38,6 +38,7 @@ exports.defineConfig = defineConfig;
 exports.loadConfig = loadConfig;
 exports.validateConfig = validateConfig;
 exports.getRequiredInstallEnvKeys = getRequiredInstallEnvKeys;
+exports.getRequiredPreInstallEnvKeys = getRequiredPreInstallEnvKeys;
 exports.getAllEnvKeys = getAllEnvKeys;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
@@ -184,7 +185,7 @@ function validateConfig(config) {
             }
         }
     }
-    // Validate install.env schema
+    // Validate install.env schema (deprecated)
     if (config.install?.env) {
         for (const [key, def] of Object.entries(config.install.env)) {
             if (!def.label) {
@@ -195,6 +196,28 @@ function validateConfig(config) {
             }
         }
     }
+    // Validate preInstall.env schema
+    if (config.preInstall?.env) {
+        for (const [key, def] of Object.entries(config.preInstall.env)) {
+            if (!def.label) {
+                errors.push(`preInstall.env.${key}: Missing required field 'label'`);
+            }
+            if (def.visibility && !['visible', 'encrypted'].includes(def.visibility)) {
+                errors.push(`preInstall.env.${key}: Invalid visibility '${def.visibility}'`);
+            }
+        }
+    }
+    // Validate postInstall.env schema
+    if (config.postInstall?.env) {
+        for (const [key, def] of Object.entries(config.postInstall.env)) {
+            if (!def.label) {
+                errors.push(`postInstall.env.${key}: Missing required field 'label'`);
+            }
+            if (def.visibility && !['visible', 'encrypted'].includes(def.visibility)) {
+                errors.push(`postInstall.env.${key}: Invalid visibility '${def.visibility}'`);
+            }
+        }
+    }
     // Validate appModels
     if (config.install?.appModels) {
         for (let i = 0; i < config.install.appModels.length; i++) {
@@ -293,6 +316,7 @@ function validateConfig(config) {
 }
 /**
  * Get all required install env keys from a config
+ * @deprecated Use getRequiredPreInstallEnvKeys instead
  */
 function getRequiredInstallEnvKeys(config) {
     if (!config.install?.env)
@@ -301,6 +325,16 @@ function getRequiredInstallEnvKeys(config) {
         .filter(([, def]) => def.required)
         .map(([key]) => key);
 }
+/**
+ * Get all required pre-install env keys from a config
+ */
+function getRequiredPreInstallEnvKeys(config) {
+    if (!config.preInstall?.env)
+        return [];
+    return Object.entries(config.preInstall.env)
+        .filter(([, def]) => def.required)
+        .map(([key]) => key);
+}
 /**
  * Get all env keys (both global and install) from a config
  */
@@ -308,5 +342,7 @@ function getAllEnvKeys(config) {
     return {
         global: config.env ? Object.keys(config.env) : [],
         install: config.install?.env ? Object.keys(config.install.env) : [],
+        preInstall: config.preInstall?.env ? Object.keys(config.preInstall.env) : [],
+        postInstall: config.postInstall?.env ? Object.keys(config.postInstall.env) : [],
     };
 }

package/dist/index.d.ts

@@ -3,4 +3,4 @@ export * from './schemas';
 export { server } from './server';
 export { workplace, communicationChannel, configure, getConfig } from './core/client';
 export { defineConfig, loadConfig, validateConfig, getRequiredInstallEnvKeys, getAllEnvKeys, CONFIG_FILE_NAMES, } from './config';
-export type { SkedyulConfig, SerializableSkedyulConfig, EnvVariableDefinition, EnvSchema, EnvVisibility, InstallConfig, AppModelDefinition, ComputeLayerType, AppFieldVisibility, AppFieldDefinition, ChannelToolBindings, ChannelIdentifierType, ChannelIdentifierValue, CommunicationChannelDefinition, WorkflowActionInput, WorkflowAction, WorkflowDefinition, } from './config';
+export type { SkedyulConfig, SerializableSkedyulConfig, EnvVariableDefinition, EnvSchema, EnvVisibility, InstallConfig, AppModelDefinition, ComputeLayerType, InstallHandlerContext, InstallHandlerResult, InstallHandler, PreInstallConfig, PostInstallConfig, AppFieldVisibility, AppFieldDefinition, ChannelToolBindings, ChannelIdentifierType, ChannelIdentifierValue, CommunicationChannelDefinition, WorkflowActionInput, WorkflowAction, WorkflowDefinition, } from './config';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skedyul",
-  "version": "0.1.34",
+  "version": "0.1.37",
   "description": "The Skedyul SDK for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,12 +13,21 @@
       "default": "./dist/index.js"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "build": "tsc --build tsconfig.json && tsc --project tsconfig.tests.json",
+    "build": "tsc --build tsconfig.json && tsc --project tsconfig.tests.json && node -e \"require('fs').mkdirSync('dist',{recursive:true}); require('fs').writeFileSync('dist/.build-stamp', String(Date.now()))\"",
+    "dev": "npx nodemon --watch src --ext js,ts --exec \"pnpm run build\"",
     "test": "npm run build && node --test dist-tests/server.test.js"
   },
-  "keywords": ["mcp", "skedyul", "serverless", "node", "typescript"],
+  "keywords": [
+    "mcp",
+    "skedyul",
+    "serverless",
+    "node",
+    "typescript"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/skedyul/skedyul-node"
@@ -34,4 +43,4 @@
     "@types/node": "^24.10.1",
     "typescript": "^5.5.0"
   }
-}
+}