skedyul 0.2.136 → 0.2.137

package/dist/.build-stamp

@@ -1 +1 @@
-1770176002055
+1770183335160

package/dist/errors.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Error types for install handlers.
+ *
+ * These errors can be thrown by install handlers to indicate specific failure modes.
+ * The server will recognize these errors and return structured error responses
+ * that the frontend can display inline on the install form.
+ */
+export type InstallErrorCode = 'MISSING_REQUIRED_FIELD' | 'AUTHENTICATION_FAILED' | 'INVALID_CONFIGURATION' | 'CONNECTION_FAILED';
+/**
+ * Base error class for install handler errors.
+ *
+ * @example
+ * ```typescript
+ * throw new InstallError('Something went wrong', 'INVALID_CONFIGURATION')
+ * ```
+ */
+export declare class InstallError extends Error {
+    code: InstallErrorCode;
+    field?: string;
+    constructor(message: string, code: InstallErrorCode, field?: string);
+}
+/**
+ * Error thrown when a required field is missing.
+ *
+ * @example
+ * ```typescript
+ * if (!ctx.env.API_KEY) {
+ *   throw new MissingRequiredFieldError('API_KEY')
+ * }
+ * ```
+ */
+export declare class MissingRequiredFieldError extends InstallError {
+    constructor(fieldName: string, message?: string);
+}
+/**
+ * Error thrown when authentication/credential verification fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await apiClient.verifyCredentials()
+ * } catch (error) {
+ *   throw new AuthenticationError('Invalid API credentials. Please check your username and password.')
+ * }
+ * ```
+ */
+export declare class AuthenticationError extends InstallError {
+    constructor(message?: string);
+}
+/**
+ * Error thrown when the configuration is invalid.
+ *
+ * @example
+ * ```typescript
+ * if (!isValidUrl(ctx.env.API_URL)) {
+ *   throw new InvalidConfigurationError('API_URL', 'Invalid URL format')
+ * }
+ * ```
+ */
+export declare class InvalidConfigurationError extends InstallError {
+    constructor(fieldName?: string, message?: string);
+}
+/**
+ * Error thrown when a connection to an external service fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await fetch(apiUrl)
+ * } catch (error) {
+ *   throw new ConnectionError('Unable to connect to the API server. Please check the URL.')
+ * }
+ * ```
+ */
+export declare class ConnectionError extends InstallError {
+    constructor(message?: string);
+}

package/dist/errors.js

@@ -0,0 +1,99 @@
+"use strict";
+/**
+ * Error types for install handlers.
+ *
+ * These errors can be thrown by install handlers to indicate specific failure modes.
+ * The server will recognize these errors and return structured error responses
+ * that the frontend can display inline on the install form.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionError = exports.InvalidConfigurationError = exports.AuthenticationError = exports.MissingRequiredFieldError = exports.InstallError = void 0;
+/**
+ * Base error class for install handler errors.
+ *
+ * @example
+ * ```typescript
+ * throw new InstallError('Something went wrong', 'INVALID_CONFIGURATION')
+ * ```
+ */
+class InstallError extends Error {
+    constructor(message, code, field) {
+        super(message);
+        this.name = 'InstallError';
+        this.code = code;
+        this.field = field;
+    }
+}
+exports.InstallError = InstallError;
+/**
+ * Error thrown when a required field is missing.
+ *
+ * @example
+ * ```typescript
+ * if (!ctx.env.API_KEY) {
+ *   throw new MissingRequiredFieldError('API_KEY')
+ * }
+ * ```
+ */
+class MissingRequiredFieldError extends InstallError {
+    constructor(fieldName, message) {
+        super(message ?? `${fieldName} is required`, 'MISSING_REQUIRED_FIELD', fieldName);
+        this.name = 'MissingRequiredFieldError';
+    }
+}
+exports.MissingRequiredFieldError = MissingRequiredFieldError;
+/**
+ * Error thrown when authentication/credential verification fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await apiClient.verifyCredentials()
+ * } catch (error) {
+ *   throw new AuthenticationError('Invalid API credentials. Please check your username and password.')
+ * }
+ * ```
+ */
+class AuthenticationError extends InstallError {
+    constructor(message) {
+        super(message ?? 'Authentication failed', 'AUTHENTICATION_FAILED');
+        this.name = 'AuthenticationError';
+    }
+}
+exports.AuthenticationError = AuthenticationError;
+/**
+ * Error thrown when the configuration is invalid.
+ *
+ * @example
+ * ```typescript
+ * if (!isValidUrl(ctx.env.API_URL)) {
+ *   throw new InvalidConfigurationError('API_URL', 'Invalid URL format')
+ * }
+ * ```
+ */
+class InvalidConfigurationError extends InstallError {
+    constructor(fieldName, message) {
+        super(message ?? 'Invalid configuration', 'INVALID_CONFIGURATION', fieldName);
+        this.name = 'InvalidConfigurationError';
+    }
+}
+exports.InvalidConfigurationError = InvalidConfigurationError;
+/**
+ * Error thrown when a connection to an external service fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await fetch(apiUrl)
+ * } catch (error) {
+ *   throw new ConnectionError('Unable to connect to the API server. Please check the URL.')
+ * }
+ * ```
+ */
+class ConnectionError extends InstallError {
+    constructor(message) {
+        super(message ?? 'Connection failed', 'CONNECTION_FAILED');
+        this.name = 'ConnectionError';
+    }
+}
+exports.ConnectionError = ConnectionError;

package/dist/index.d.ts

@@ -3,6 +3,8 @@ export * from './types';
 export * from './schemas';
 export { server } from './server';
 export { DEFAULT_DOCKERFILE } from './dockerfile';
+export { InstallError, MissingRequiredFieldError, AuthenticationError, InvalidConfigurationError, ConnectionError, } from './errors';
+export type { InstallErrorCode } from './errors';
 export { z };
 export { workplace, communicationChannel, instance, token, file, webhook, resource, contactAssociationLink, configure, getConfig, runWithConfig, } from './core/client';
 export type { InstanceContext, InstanceData, InstanceMeta, InstancePagination, InstanceListResult, InstanceListArgs, FileUrlResponse, FileUploadParams, FileUploadResult, WebhookCreateResult, WebhookListItem, WebhookDeleteByNameOptions, WebhookListOptions, ResourceLinkParams, ResourceLinkResult, ContactAssociationLinkCreateParams, ContactAssociationLinkCreateResult, } from './core/client';

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRequiredInstallEnvKeys = exports.getAllEnvKeys = exports.CONFIG_FILE_NAMES = exports.validateConfig = exports.loadConfig = exports.defineConfig = exports.runWithConfig = exports.getConfig = exports.configure = exports.contactAssociationLink = exports.resource = exports.webhook = exports.file = exports.token = exports.instance = exports.communicationChannel = exports.workplace = exports.z = exports.DEFAULT_DOCKERFILE = exports.server = void 0;
+exports.getRequiredInstallEnvKeys = exports.getAllEnvKeys = exports.CONFIG_FILE_NAMES = exports.validateConfig = exports.loadConfig = exports.defineConfig = exports.runWithConfig = exports.getConfig = exports.configure = exports.contactAssociationLink = exports.resource = exports.webhook = exports.file = exports.token = exports.instance = exports.communicationChannel = exports.workplace = exports.z = exports.ConnectionError = exports.InvalidConfigurationError = exports.AuthenticationError = exports.MissingRequiredFieldError = exports.InstallError = exports.DEFAULT_DOCKERFILE = exports.server = void 0;
 const zod_1 = require("zod");
 Object.defineProperty(exports, "z", { enumerable: true, get: function () { return zod_1.z; } });
 __exportStar(require("./types"), exports);
@@ -23,6 +23,13 @@ var server_1 = require("./server");
 Object.defineProperty(exports, "server", { enumerable: true, get: function () { return server_1.server; } });
 var dockerfile_1 = require("./dockerfile");
 Object.defineProperty(exports, "DEFAULT_DOCKERFILE", { enumerable: true, get: function () { return dockerfile_1.DEFAULT_DOCKERFILE; } });
+// Install handler errors
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "InstallError", { enumerable: true, get: function () { return errors_1.InstallError; } });
+Object.defineProperty(exports, "MissingRequiredFieldError", { enumerable: true, get: function () { return errors_1.MissingRequiredFieldError; } });
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return errors_1.AuthenticationError; } });
+Object.defineProperty(exports, "InvalidConfigurationError", { enumerable: true, get: function () { return errors_1.InvalidConfigurationError; } });
+Object.defineProperty(exports, "ConnectionError", { enumerable: true, get: function () { return errors_1.ConnectionError; } });
 var client_1 = require("./core/client");
 Object.defineProperty(exports, "workplace", { enumerable: true, get: function () { return client_1.workplace; } });
 Object.defineProperty(exports, "communicationChannel", { enumerable: true, get: function () { return client_1.communicationChannel; } });

package/dist/server.js

@@ -44,6 +44,7 @@ const streamableHttp_js_1 = require("@modelcontextprotocol/sdk/server/streamable
 const z = __importStar(require("zod"));
 const service_1 = require("./core/service");
 const client_1 = require("./core/client");
+const errors_1 = require("./errors");
 function normalizeBilling(billing) {
     if (!billing || typeof billing.credits !== 'number') {
         return { credits: 0 };
@@ -906,12 +907,24 @@ function createDedicatedServerInstance(config, tools, callTool, state, mcpServer
                     });
                 }
                 catch (err) {
-                    sendJSON(res, 500, {
-                        error: {
-                            code: -32603,
-                            message: err instanceof Error ? err.message : String(err ?? ''),
-                        },
-                    });
+                    // Check for typed install errors
+                    if (err instanceof errors_1.InstallError) {
+                        sendJSON(res, 400, {
+                            error: {
+                                code: err.code,
+                                message: err.message,
+                                field: err.field,
+                            },
+                        });
+                    }
+                    else {
+                        sendJSON(res, 500, {
+                            error: {
+                                code: -32603,
+                                message: err instanceof Error ? err.message : String(err ?? ''),
+                            },
+                        });
+                    }
                 }
                 return;
             }
@@ -1423,6 +1436,16 @@ function createServerlessInstance(config, tools, callTool, state, mcpServer, reg
                         return createResponse(200, { env: result.env ?? {}, redirect: result.redirect }, headers);
                     }
                     catch (err) {
+                        // Check for typed install errors
+                        if (err instanceof errors_1.InstallError) {
+                            return createResponse(400, {
+                                error: {
+                                    code: err.code,
+                                    message: err.message,
+                                    field: err.field,
+                                },
+                            }, headers);
+                        }
                         return createResponse(500, {
                             error: {
                                 code: -32603,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skedyul",
-  "version": "0.2.136",
+  "version": "0.2.137",
   "description": "The Skedyul SDK for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",