@aloma.io/integration-sdk 3.8.55 → 3.8.56

package/test/scenarios/complex/expected/products-resource.mts

@@ -0,0 +1,239 @@
+// ProductsResource resource functions
+// These functions will be bound to the controller instance and accessible as products.method()
+
+// Generated TypeScript interfaces from OpenAPI schemas
+
+export interface Product {
+  /** Unique product identifier */
+  id: string;
+  /** Product name */
+  name: string;
+  /** Product description */
+  description?: string;
+  /** Product price */
+  price: number;
+  /** Product category */
+  category?: string;
+  /** Whether product is in stock */
+  inStock?: boolean;
+  /** Product tags */
+  tags?: string[];
+  /** Creation timestamp */
+  createdAt?: string;
+  /** Last update timestamp */
+  updatedAt?: string;
+}
+
+export interface ProductList {
+  products?: Product[];
+  /** Total number of products */
+  total?: number;
+  /** Whether there are more products available */
+  hasMore?: boolean;
+}
+
+export interface CreateProductRequest {
+  /** Product name */
+  name: string;
+  /** Product description */
+  description?: string;
+  /** Product price */
+  price: number;
+  /** Product category */
+  category?: string;
+  /** Product tags */
+  tags?: string[];
+}
+
+export interface UpdateProductRequest {
+  /** Product name */
+  name?: string;
+  /** Product description */
+  description?: string;
+  /** Product price */
+  price?: number;
+  /** Product category */
+  category?: string;
+  /** Whether product is in stock */
+  inStock?: boolean;
+  /** Product tags */
+  tags?: string[];
+}
+
+
+/**
+ * List all products
+ *
+ * @param {Object} options - Request options
+ * @param {number} options.limit (optional) - Maximum number of products to return [query]
+ * @param {string} options.category (optional) - Filter by category [query]
+ * @param {boolean} options.archived (optional) - Include archived products [query]
+ *
+ * @returns {Promise<ProductList>} GET /products response
+ *
+ * response fields:
+ * - products?: Product[]
+ * - total?: number - Total number of products
+ * - hasMore?: boolean - Whether there are more products available
+ */
+export function getProducts(this: any, options?: {limit?: number, category?: string, archived?: boolean}) {
+  options = options || {};
+
+  const url = '/products';
+
+  const fetchOptions: any = {
+    method: 'GET',
+    params: {},
+    headers: options.headers,
+  };
+
+  // Add query parameters
+  if (options.limit !== undefined) {
+    fetchOptions.params.limit = options.limit;
+  }
+  if (options.category !== undefined) {
+    fetchOptions.params.category = options.category;
+  }
+  if (options.archived !== undefined) {
+    fetchOptions.params.archived = options.archived;
+  }
+
+    return this.api.fetch(url, fetchOptions);
+}
+
+/**
+ * Create a new product
+ *
+ * @param {Object} options - Request options
+ * @param {string} options.name (required) - Product name [body property]
+ * @param {string} options.description (required) - Product description [body property]
+ * @param {number} options.price (required) - Product price [body property]
+ * @param {string} options.category (required) - Product category [body property]
+ * @param {string[]} options.tags (required) - Product tags [body property]
+ *
+ * @returns {Promise<Product>} POST /products response
+ *
+ * response fields:
+ * - id: string - Unique product identifier
+ * - name: string - Product name
+ * - description?: string - Product description
+ * - price: number - Product price
+ * - category?: string - Product category
+ * - inStock?: boolean - Whether product is in stock
+ * - tags?: string[] - Product tags
+ * - createdAt?: string - Creation timestamp
+ * - updatedAt?: string - Last update timestamp
+ */
+export function createProduct(this: any, options: {name: string /** Product name */, description: string /** Product description */, price: number /** Product price */, category: string /** Product category */, tags: string[] /** Product tags */}) {
+  options = options || {};
+
+  const url = '/products';
+
+  const { headers, ...bodyData } = options;
+  const requestBody = Object.keys(bodyData).length > 0 ? bodyData : undefined;
+
+  const fetchOptions: any = {
+    method: 'POST',
+    body: requestBody,
+    headers: options.headers,
+  };
+
+    return this.api.fetch(url, fetchOptions);
+}
+
+/**
+ * Get a specific product
+ *
+ * @param {string} productId The product ID
+ * @param {Object} options (optional) - Request options
+ *
+ * @returns {Promise<Product>} GET /products/{productId} response
+ *
+ * response fields:
+ * - id: string - Unique product identifier
+ * - name: string - Product name
+ * - description?: string - Product description
+ * - price: number - Product price
+ * - category?: string - Product category
+ * - inStock?: boolean - Whether product is in stock
+ * - tags?: string[] - Product tags
+ * - createdAt?: string - Creation timestamp
+ * - updatedAt?: string - Last update timestamp
+ */
+export function getProduct(this: any, productId: string) {
+  let url = '/products/{productId}';
+  if (productId) {
+    url = url.replace('{productId}', productId);
+  }
+
+  return this.api.fetch(url, {
+    method: 'GET',
+  });
+    return this.api.fetch(url, fetchOptions);
+}
+
+/**
+ * Update a product
+ *
+ * @param {string} productId The product ID
+ * @param {Object} options - Request options
+ * @param {string} options.name (required) - Product name [body property]
+ * @param {string} options.description (required) - Product description [body property]
+ * @param {number} options.price (required) - Product price [body property]
+ * @param {string} options.category (required) - Product category [body property]
+ * @param {boolean} options.inStock (required) - Whether product is in stock [body property]
+ * @param {string[]} options.tags (required) - Product tags [body property]
+ *
+ * @returns {Promise<Product>} PUT /products/{productId} response
+ *
+ * response fields:
+ * - id: string - Unique product identifier
+ * - name: string - Product name
+ * - description?: string - Product description
+ * - price: number - Product price
+ * - category?: string - Product category
+ * - inStock?: boolean - Whether product is in stock
+ * - tags?: string[] - Product tags
+ * - createdAt?: string - Creation timestamp
+ * - updatedAt?: string - Last update timestamp
+ */
+export function updateProduct(this: any, productId: string, options: {name: string /** Product name */, description: string /** Product description */, price: number /** Product price */, category: string /** Product category */, inStock: boolean /** Whether product is in stock */, tags: string[] /** Product tags */}) {
+  options = options || {};
+
+  // Build URL with path parameters
+  let url = '/products/{productId}';
+  if (productId) {
+    url = url.replace('{productId}', productId);
+  }
+
+  const { headers, ...bodyData } = options;
+  const requestBody = Object.keys(bodyData).length > 0 ? bodyData : undefined;
+
+  const fetchOptions: any = {
+    method: 'PUT',
+    body: requestBody,
+    headers: options.headers,
+  };
+
+    return this.api.fetch(url, fetchOptions);
+}
+
+/**
+ * Delete a product
+ *
+ * @param {string} productId The product ID
+ * @param {Object} options (optional) - Request options
+ *
+ * @returns {Promise<any>} DELETE /products/{productId} response
+ */
+export function deleteProduct(this: any, productId: string) {
+  let url = '/products/{productId}';
+  if (productId) {
+    url = url.replace('{productId}', productId);
+  }
+
+  return this.api.fetch(url, {
+    method: 'DELETE',
+  });
+    return this.api.fetch(url, fetchOptions);
+}

package/test/scenarios/complex/specs/orders.json

@@ -0,0 +1,362 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Orders API",
+    "version": "1.0.0",
+    "description": "A simple orders management API"
+  },
+  "servers": [
+    {
+      "url": "https://api.testshop.com",
+      "description": "Production server"
+    }
+  ],
+  "paths": {
+    "/orders": {
+      "get": {
+        "operationId": "getOrders",
+        "summary": "List all orders",
+        "parameters": [
+          {
+            "name": "status",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "enum": ["pending", "confirmed", "shipped", "delivered", "cancelled"]
+            },
+            "description": "Filter by order status"
+          },
+          {
+            "name": "customerId",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Filter by customer ID"
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "schema": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 50
+            },
+            "description": "Maximum number of orders to return"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of orders",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OrderList"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "operationId": "createOrder",
+        "summary": "Create a new order",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateOrderRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Order created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Order"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/orders/{orderId}": {
+      "get": {
+        "operationId": "getOrder",
+        "summary": "Get a specific order",
+        "parameters": [
+          {
+            "name": "orderId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "The order ID"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Order details",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Order"
+                }
+              }
+            }
+          }
+        }
+      },
+      "patch": {
+        "operationId": "updateOrderStatus",
+        "summary": "Update order status",
+        "parameters": [
+          {
+            "name": "orderId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "The order ID"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateOrderStatusRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Order status updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Order"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/orders/{orderId}/cancel": {
+      "post": {
+        "operationId": "cancelOrder",
+        "summary": "Cancel an order",
+        "parameters": [
+          {
+            "name": "orderId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "The order ID"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Order cancelled",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Order"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Order": {
+        "type": "object",
+        "required": ["id", "customerId", "items", "status", "totalAmount"],
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique order identifier"
+          },
+          "customerId": {
+            "type": "string",
+            "description": "Customer who placed the order"
+          },
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/OrderItem"
+            },
+            "description": "Items in the order"
+          },
+          "status": {
+            "type": "string",
+            "enum": ["pending", "confirmed", "shipped", "delivered", "cancelled"],
+            "description": "Current order status"
+          },
+          "totalAmount": {
+            "type": "number",
+            "minimum": 0,
+            "description": "Total order amount"
+          },
+          "shippingAddress": {
+            "$ref": "#/components/schemas/Address"
+          },
+          "billingAddress": {
+            "$ref": "#/components/schemas/Address"
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Order creation timestamp"
+          },
+          "updatedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Last update timestamp"
+          }
+        }
+      },
+      "OrderItem": {
+        "type": "object",
+        "required": ["productId", "quantity", "unitPrice"],
+        "properties": {
+          "productId": {
+            "type": "string",
+            "description": "Product identifier"
+          },
+          "productName": {
+            "type": "string",
+            "description": "Product name"
+          },
+          "quantity": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "Quantity ordered"
+          },
+          "unitPrice": {
+            "type": "number",
+            "minimum": 0,
+            "description": "Price per unit"
+          },
+          "totalPrice": {
+            "type": "number",
+            "minimum": 0,
+            "description": "Total price for this item"
+          }
+        }
+      },
+      "Address": {
+        "type": "object",
+        "required": ["street", "city", "zipCode", "country"],
+        "properties": {
+          "street": {
+            "type": "string",
+            "description": "Street address"
+          },
+          "city": {
+            "type": "string",
+            "description": "City"
+          },
+          "state": {
+            "type": "string",
+            "description": "State or province"
+          },
+          "zipCode": {
+            "type": "string",
+            "description": "ZIP or postal code"
+          },
+          "country": {
+            "type": "string",
+            "description": "Country"
+          }
+        }
+      },
+      "OrderList": {
+        "type": "object",
+        "properties": {
+          "orders": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Order"
+            }
+          },
+          "total": {
+            "type": "integer",
+            "description": "Total number of orders"
+          },
+          "hasMore": {
+            "type": "boolean",
+            "description": "Whether there are more orders available"
+          }
+        }
+      },
+      "CreateOrderRequest": {
+        "type": "object",
+        "required": ["customerId", "items"],
+        "properties": {
+          "customerId": {
+            "type": "string",
+            "description": "Customer who is placing the order"
+          },
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/OrderItemRequest"
+            },
+            "description": "Items to order"
+          },
+          "shippingAddress": {
+            "$ref": "#/components/schemas/Address"
+          },
+          "billingAddress": {
+            "$ref": "#/components/schemas/Address"
+          }
+        }
+      },
+      "OrderItemRequest": {
+        "type": "object",
+        "required": ["productId", "quantity"],
+        "properties": {
+          "productId": {
+            "type": "string",
+            "description": "Product to order"
+          },
+          "quantity": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "Quantity to order"
+          }
+        }
+      },
+      "UpdateOrderStatusRequest": {
+        "type": "object",
+        "required": ["status"],
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": ["confirmed", "shipped", "delivered"],
+            "description": "New order status"
+          },
+          "trackingNumber": {
+            "type": "string",
+            "description": "Tracking number (for shipped status)"
+          }
+        }
+      }
+    }
+  }
+}