skedyul 0.1.76 → 0.1.78

package/dist/.build-stamp

@@ -1 +1 @@
-1769062079783
+1769118652018

package/dist/core/client.d.ts

@@ -1,4 +1,21 @@
 import type { CommunicationChannel, Workplace } from './types';
+/**
+ * Error object in normalized API responses.
+ */
+export interface CoreApiError {
+    field: string | null;
+    code: string;
+    message: string;
+}
+/**
+ * Pagination info for list results.
+ */
+export interface InstancePagination {
+    page: number;
+    total: number;
+    hasMore: boolean;
+    limit: number;
+}
 type ClientConfig = {
     /** Base URL for the Skedyul Core API (e.g., "https://app.skedyul.com/api") */
     baseUrl: string;
@@ -82,10 +99,6 @@ export interface ReceiveMessageInput {
     /** Optional remote/external message ID (e.g., Twilio MessageSid) */
     remoteId?: string;
 }
-export interface ReceiveMessageResponse {
-    success: boolean;
-    messageId?: string;
-}
 export declare const communicationChannel: {
     /**
      * List communication channels with optional filters.
@@ -118,7 +131,9 @@ export declare const communicationChannel: {
      * });
      * ```
      */
-    receiveMessage(input: ReceiveMessageInput): Promise<ReceiveMessageResponse>;
+    receiveMessage(input: ReceiveMessageInput): Promise<{
+        messageId: string;
+    }>;
 };
 /**
  * Context required for instance operations.
@@ -148,15 +163,6 @@ export interface InstanceData {
     _meta: InstanceMeta;
     [fieldHandle: string]: unknown;
 }
-/**
- * Pagination info for list results.
- */
-export interface InstancePagination {
-    page: number;
-    total: number;
-    hasMore: boolean;
-    limit: number;
-}
 /**
  * Result from instance.list().
  */

package/dist/core/client.js

@@ -77,9 +77,10 @@ function configure(options) {
 function getConfig() {
     return getEffectiveConfig();
 }
-// ─────────────────────────────────────────────────────────────────────────────
-// Core API Client
-// ─────────────────────────────────────────────────────────────────────────────
+/**
+ * Call the Core API with the normalized response envelope format.
+ * Throws if success is false, otherwise returns unwrapped data.
+ */
 async function callCore(method, params) {
     const effectiveConfig = getEffectiveConfig();
     const { baseUrl, apiToken } = effectiveConfig;
@@ -107,22 +108,34 @@ async function callCore(method, params) {
         throw new Error(`Core API returned non-JSON response (${response.status}): ${text.slice(0, 100)}`);
     }
     const payload = (await response.json());
+    // Handle failure responses
+    if (!payload.success) {
+        const message = payload.errors
+            ?.map((e) => (e.field ? `${e.field}: ${e.message}` : e.message))
+            .join('; ') || 'Unknown error';
+        throw new Error(message);
+    }
+    // Also handle HTTP errors (fallback for non-envelope errors)
     if (!response.ok) {
-        throw new Error(payload?.error?.message ?? `Core API error (${response.status})`);
+        throw new Error(`Core API error (${response.status})`);
     }
-    return payload;
+    return {
+        data: payload.data,
+        errors: payload.errors ?? [],
+        pagination: payload.pagination,
+    };
 }
 exports.workplace = {
     async list(args) {
-        const payload = (await callCore('workplace.list', {
+        const { data } = await callCore('workplace.list', {
             ...(args?.filter ? { filter: args.filter } : {}),
             ...(args?.limit ? { limit: args.limit } : {}),
-        }));
-        return payload.workplaces;
+        });
+        return data;
     },
     async get(id) {
-        const payload = (await callCore('workplace.get', { id }));
-        return payload.workplace;
+        const { data } = await callCore('workplace.get', { id });
+        return data;
     },
 };
 exports.communicationChannel = {
@@ -139,15 +152,15 @@ exports.communicationChannel = {
      * ```
      */
     async list(args) {
-        const payload = (await callCore('communicationChannel.list', {
+        const { data } = await callCore('communicationChannel.list', {
             ...(args?.filter ? { filter: args.filter } : {}),
             ...(args?.limit ? { limit: args.limit } : {}),
-        }));
-        return payload.channels;
+        });
+        return data;
     },
     async get(id) {
-        const payload = (await callCore('communicationChannel.get', { id }));
-        return payload.channel;
+        const { data } = await callCore('communicationChannel.get', { id });
+        return data;
     },
     /**
      * Receive an inbound message on a communication channel.
@@ -167,14 +180,14 @@ exports.communicationChannel = {
      * ```
      */
     async receiveMessage(input) {
-        const payload = (await callCore('communicationChannel.receiveMessage', {
+        const { data } = await callCore('communicationChannel.receiveMessage', {
             communicationChannelId: input.communicationChannelId,
             from: input.from,
             message: input.message,
             contact: input.contact,
             ...(input.remoteId ? { remoteId: input.remoteId } : {}),
-        }));
-        return payload;
+        });
+        return data;
     },
 };
 exports.instance = {
@@ -208,15 +221,18 @@ exports.instance = {
      * ```
      */
     async list(modelHandle, ctx, args) {
-        const payload = (await callCore('instance.list', {
+        const { data, pagination } = await callCore('instance.list', {
             modelHandle,
             ...(ctx?.appInstallationId ? { appInstallationId: ctx.appInstallationId } : {}),
             ...(ctx?.workplace?.id ? { workplaceId: ctx.workplace.id } : {}),
             ...(args?.page !== undefined ? { page: args.page } : {}),
             ...(args?.limit !== undefined ? { limit: args.limit } : {}),
             ...(args?.filter ? { filter: args.filter } : {}),
-        }));
-        return payload;
+        });
+        return {
+            data,
+            pagination: pagination ?? { page: 1, total: 0, hasMore: false, limit: args?.limit ?? 50 },
+        };
     },
     /**
      * Get a single instance by ID.
@@ -227,12 +243,12 @@ exports.instance = {
      * ```
      */
     async get(id, ctx) {
-        const payload = (await callCore('instance.get', {
+        const { data } = await callCore('instance.get', {
             id,
             appInstallationId: ctx.appInstallationId,
             workplaceId: ctx.workplace.id,
-        }));
-        return payload.instance;
+        });
+        return data;
     },
     /**
      * Create a new instance of an internal model.
@@ -246,13 +262,13 @@ exports.instance = {
      * ```
      */
     async create(modelHandle, data, ctx) {
-        const payload = (await callCore('instance.create', {
+        const { data: instance } = await callCore('instance.create', {
             modelHandle,
             appInstallationId: ctx.appInstallationId,
             workplaceId: ctx.workplace.id,
             data,
-        }));
-        return payload.instance;
+        });
+        return instance;
     },
     /**
      * Update an existing instance.
@@ -266,13 +282,13 @@ exports.instance = {
      * ```
      */
     async update(id, data, ctx) {
-        const payload = (await callCore('instance.update', {
+        const { data: instance } = await callCore('instance.update', {
             id,
             appInstallationId: ctx.appInstallationId,
             workplaceId: ctx.workplace.id,
             data,
-        }));
-        return payload.instance;
+        });
+        return instance;
     },
 };
 // ─────────────────────────────────────────────────────────────────────────────
@@ -300,10 +316,10 @@ exports.token = {
      * ```
      */
     async exchange(appInstallationId) {
-        const payload = (await callCore('token.exchange', {
+        const { data } = await callCore('token.exchange', {
             appInstallationId,
-        }));
-        return payload;
+        });
+        return data;
     },
 };
 exports.file = {
@@ -323,10 +339,10 @@ exports.file = {
      * ```
      */
     async getUrl(fileId) {
-        const payload = (await callCore('file.getUrl', {
+        const { data } = await callCore('file.getUrl', {
             fileId,
-        }));
-        return payload;
+        });
+        return data;
     },
 };
 exports.webhook = {
@@ -357,12 +373,12 @@ exports.webhook = {
      * ```
      */
     async create(name, context, options) {
-        const payload = (await callCore('webhook.create', {
+        const { data } = await callCore('webhook.create', {
             name,
             ...(context ? { context } : {}),
             ...(options?.expiresIn ? { expiresIn: options.expiresIn } : {}),
-        }));
-        return payload;
+        });
+        return data;
     },
     /**
      * Delete a webhook registration by ID.
@@ -376,10 +392,10 @@ exports.webhook = {
      * ```
      */
     async delete(id) {
-        const payload = (await callCore('webhook.delete', {
+        const { data } = await callCore('webhook.delete', {
             id,
-        }));
-        return payload;
+        });
+        return data;
     },
     /**
      * Delete webhook registrations by handler name.
@@ -403,11 +419,11 @@ exports.webhook = {
      * ```
      */
     async deleteByName(name, options) {
-        const payload = (await callCore('webhook.deleteByName', {
+        const { data } = await callCore('webhook.deleteByName', {
             name,
             ...(options?.filter ? { filter: options.filter } : {}),
-        }));
-        return payload;
+        });
+        return data;
     },
     /**
      * List webhook registrations for this installation.
@@ -425,9 +441,9 @@ exports.webhook = {
      * ```
      */
     async list(options) {
-        const payload = (await callCore('webhook.list', {
+        const { data } = await callCore('webhook.list', {
             ...(options?.name ? { name: options.name } : {}),
-        }));
-        return payload;
+        });
+        return { webhooks: data };
     },
 };

package/package.json

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