create-auto-app 0.2.1 → 0.2.2

package/templates/shopping-app/example-integrations/cart/src/generated/cart/core/params.gen.ts

@@ -0,0 +1,153 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+type Slot = 'body' | 'headers' | 'path' | 'query';
+
+export type Field =
+  | {
+      in: Exclude<Slot, 'body'>;
+      /**
+       * Field name. This is the name we want the user to see and use.
+       */
+      key: string;
+      /**
+       * Field mapped name. This is the name we want to use in the request.
+       * If omitted, we use the same value as `key`.
+       */
+      map?: string;
+    }
+  | {
+      in: Extract<Slot, 'body'>;
+      /**
+       * Key isn't required for bodies.
+       */
+      key?: string;
+      map?: string;
+    };
+
+export interface Fields {
+  allowExtra?: Partial<Record<Slot, boolean>>;
+  args?: ReadonlyArray<Field>;
+}
+
+export type FieldsConfig = ReadonlyArray<Field | Fields>;
+
+const extraPrefixesMap: Record<string, Slot> = {
+  $body_: 'body',
+  $headers_: 'headers',
+  $path_: 'path',
+  $query_: 'query',
+};
+const extraPrefixes = Object.entries(extraPrefixesMap);
+
+type KeyMap = Map<
+  string,
+  {
+    in: Slot;
+    map?: string;
+  }
+>;
+
+const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
+  if (!map) {
+    map = new Map();
+  }
+
+  for (const config of fields) {
+    if ('in' in config) {
+      if (config.key) {
+        map.set(config.key, {
+          in: config.in,
+          map: config.map,
+        });
+      }
+    } else if (config.args) {
+      buildKeyMap(config.args, map);
+    }
+  }
+
+  return map;
+};
+
+interface Params {
+  body: unknown;
+  headers: Record<string, unknown>;
+  path: Record<string, unknown>;
+  query: Record<string, unknown>;
+}
+
+const stripEmptySlots = (params: Params) => {
+  for (const [slot, value] of Object.entries(params)) {
+    if (value && typeof value === 'object' && !Object.keys(value).length) {
+      delete params[slot as Slot];
+    }
+  }
+};
+
+export const buildClientParams = (
+  args: ReadonlyArray<unknown>,
+  fields: FieldsConfig,
+) => {
+  const params: Params = {
+    body: {},
+    headers: {},
+    path: {},
+    query: {},
+  };
+
+  const map = buildKeyMap(fields);
+
+  let config: FieldsConfig[number] | undefined;
+
+  for (const [index, arg] of args.entries()) {
+    if (fields[index]) {
+      config = fields[index];
+    }
+
+    if (!config) {
+      continue;
+    }
+
+    if ('in' in config) {
+      if (config.key) {
+        const field = map.get(config.key)!;
+        const name = field.map || config.key;
+        (params[field.in] as Record<string, unknown>)[name] = arg;
+      } else {
+        params.body = arg;
+      }
+    } else {
+      for (const [key, value] of Object.entries(arg ?? {})) {
+        const field = map.get(key);
+
+        if (field) {
+          const name = field.map || key;
+          (params[field.in] as Record<string, unknown>)[name] = value;
+        } else {
+          const extra = extraPrefixes.find(([prefix]) =>
+            key.startsWith(prefix),
+          );
+
+          if (extra) {
+            const [prefix, slot] = extra;
+            (params[slot] as Record<string, unknown>)[
+              key.slice(prefix.length)
+            ] = value;
+          } else {
+            for (const [slot, allowed] of Object.entries(
+              config.allowExtra ?? {},
+            )) {
+              if (allowed) {
+                (params[slot as Slot] as Record<string, unknown>)[key] = value;
+                break;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+
+  stripEmptySlots(params);
+
+  return params;
+};

package/templates/shopping-app/example-integrations/cart/src/generated/cart/core/pathSerializer.gen.ts

@@ -0,0 +1,181 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+interface SerializeOptions<T>
+  extends SerializePrimitiveOptions,
+    SerializerOptions<T> {}
+
+interface SerializePrimitiveOptions {
+  allowReserved?: boolean;
+  name: string;
+}
+
+export interface SerializerOptions<T> {
+  /**
+   * @default true
+   */
+  explode: boolean;
+  style: T;
+}
+
+export type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
+export type ArraySeparatorStyle = ArrayStyle | MatrixStyle;
+type MatrixStyle = 'label' | 'matrix' | 'simple';
+export type ObjectStyle = 'form' | 'deepObject';
+type ObjectSeparatorStyle = ObjectStyle | MatrixStyle;
+
+interface SerializePrimitiveParam extends SerializePrimitiveOptions {
+  value: string;
+}
+
+export const separatorArrayExplode = (style: ArraySeparatorStyle) => {
+  switch (style) {
+    case 'label':
+      return '.';
+    case 'matrix':
+      return ';';
+    case 'simple':
+      return ',';
+    default:
+      return '&';
+  }
+};
+
+export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => {
+  switch (style) {
+    case 'form':
+      return ',';
+    case 'pipeDelimited':
+      return '|';
+    case 'spaceDelimited':
+      return '%20';
+    default:
+      return ',';
+  }
+};
+
+export const separatorObjectExplode = (style: ObjectSeparatorStyle) => {
+  switch (style) {
+    case 'label':
+      return '.';
+    case 'matrix':
+      return ';';
+    case 'simple':
+      return ',';
+    default:
+      return '&';
+  }
+};
+
+export const serializeArrayParam = ({
+  allowReserved,
+  explode,
+  name,
+  style,
+  value,
+}: SerializeOptions<ArraySeparatorStyle> & {
+  value: unknown[];
+}) => {
+  if (!explode) {
+    const joinedValues = (
+      allowReserved ? value : value.map((v) => encodeURIComponent(v as string))
+    ).join(separatorArrayNoExplode(style));
+    switch (style) {
+      case 'label':
+        return `.${joinedValues}`;
+      case 'matrix':
+        return `;${name}=${joinedValues}`;
+      case 'simple':
+        return joinedValues;
+      default:
+        return `${name}=${joinedValues}`;
+    }
+  }
+
+  const separator = separatorArrayExplode(style);
+  const joinedValues = value
+    .map((v) => {
+      if (style === 'label' || style === 'simple') {
+        return allowReserved ? v : encodeURIComponent(v as string);
+      }
+
+      return serializePrimitiveParam({
+        allowReserved,
+        name,
+        value: v as string,
+      });
+    })
+    .join(separator);
+  return style === 'label' || style === 'matrix'
+    ? separator + joinedValues
+    : joinedValues;
+};
+
+export const serializePrimitiveParam = ({
+  allowReserved,
+  name,
+  value,
+}: SerializePrimitiveParam) => {
+  if (value === undefined || value === null) {
+    return '';
+  }
+
+  if (typeof value === 'object') {
+    throw new Error(
+      'Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.',
+    );
+  }
+
+  return `${name}=${allowReserved ? value : encodeURIComponent(value)}`;
+};
+
+export const serializeObjectParam = ({
+  allowReserved,
+  explode,
+  name,
+  style,
+  value,
+  valueOnly,
+}: SerializeOptions<ObjectSeparatorStyle> & {
+  value: Record<string, unknown> | Date;
+  valueOnly?: boolean;
+}) => {
+  if (value instanceof Date) {
+    return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`;
+  }
+
+  if (style !== 'deepObject' && !explode) {
+    let values: string[] = [];
+    Object.entries(value).forEach(([key, v]) => {
+      values = [
+        ...values,
+        key,
+        allowReserved ? (v as string) : encodeURIComponent(v as string),
+      ];
+    });
+    const joinedValues = values.join(',');
+    switch (style) {
+      case 'form':
+        return `${name}=${joinedValues}`;
+      case 'label':
+        return `.${joinedValues}`;
+      case 'matrix':
+        return `;${name}=${joinedValues}`;
+      default:
+        return joinedValues;
+    }
+  }
+
+  const separator = separatorObjectExplode(style);
+  const joinedValues = Object.entries(value)
+    .map(([key, v]) =>
+      serializePrimitiveParam({
+        allowReserved,
+        name: style === 'deepObject' ? `${name}[${key}]` : key,
+        value: v as string,
+      }),
+    )
+    .join(separator);
+  return style === 'label' || style === 'matrix'
+    ? separator + joinedValues
+    : joinedValues;
+};

package/templates/shopping-app/example-integrations/cart/src/generated/cart/core/types.gen.ts

@@ -0,0 +1,120 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Auth, AuthToken } from './auth.gen';
+import type {
+  BodySerializer,
+  QuerySerializer,
+  QuerySerializerOptions,
+} from './bodySerializer.gen';
+
+export interface Client<
+  RequestFn = never,
+  Config = unknown,
+  MethodFn = never,
+  BuildUrlFn = never,
+> {
+  /**
+   * Returns the final request URL.
+   */
+  buildUrl: BuildUrlFn;
+  connect: MethodFn;
+  delete: MethodFn;
+  get: MethodFn;
+  getConfig: () => Config;
+  head: MethodFn;
+  options: MethodFn;
+  patch: MethodFn;
+  post: MethodFn;
+  put: MethodFn;
+  request: RequestFn;
+  setConfig: (config: Config) => Config;
+  trace: MethodFn;
+}
+
+export interface Config {
+  /**
+   * Auth token or a function returning auth token. The resolved value will be
+   * added to the request payload as defined by its `security` array.
+   */
+  auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+  /**
+   * A function for serializing request body parameter. By default,
+   * {@link JSON.stringify()} will be used.
+   */
+  bodySerializer?: BodySerializer | null;
+  /**
+   * An object containing any HTTP headers that you want to pre-populate your
+   * `Headers` object with.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+   */
+  headers?:
+    | RequestInit['headers']
+    | Record<
+        string,
+        | string
+        | number
+        | boolean
+        | (string | number | boolean)[]
+        | null
+        | undefined
+        | unknown
+      >;
+  /**
+   * The request method.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+   */
+  method?:
+    | 'CONNECT'
+    | 'DELETE'
+    | 'GET'
+    | 'HEAD'
+    | 'OPTIONS'
+    | 'PATCH'
+    | 'POST'
+    | 'PUT'
+    | 'TRACE';
+  /**
+   * A function for serializing request query parameters. By default, arrays
+   * will be exploded in form style, objects will be exploded in deepObject
+   * style, and reserved characters are percent-encoded.
+   *
+   * This method will have no effect if the native `paramsSerializer()` Axios
+   * API function is used.
+   *
+   * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+   */
+  querySerializer?: QuerySerializer | QuerySerializerOptions;
+  /**
+   * A function validating request data. This is useful if you want to ensure
+   * the request conforms to the desired shape, so it can be safely sent to
+   * the server.
+   */
+  requestValidator?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function transforming response data before it's returned. This is useful
+   * for post-processing data, e.g. converting ISO strings into Date objects.
+   */
+  responseTransformer?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function validating response data. This is useful if you want to ensure
+   * the response conforms to the desired shape, so it can be safely passed to
+   * the transformers and returned to the user.
+   */
+  responseValidator?: (data: unknown) => Promise<unknown>;
+}
+
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
+  ? true
+  : [T] extends [never | undefined]
+    ? [undefined] extends [T]
+      ? false
+      : true
+    : false;
+
+export type OmitNever<T extends Record<string, unknown>> = {
+  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true
+    ? never
+    : K]: T[K];
+};

package/templates/shopping-app/example-integrations/cart/src/generated/cart/index.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';

package/templates/shopping-app/example-integrations/cart/src/generated/cart/types.gen.ts

@@ -0,0 +1,175 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type CartItem = {
+    /**
+     * Unique identifier for the product
+     */
+    productId: string;
+    /**
+     * Product name
+     */
+    name: string;
+    /**
+     * Product price in dollars
+     */
+    price: number;
+    /**
+     * Quantity of the product in cart
+     */
+    quantity: number;
+};
+
+export type CartSession = {
+    /**
+     * Unique cart session identifier
+     */
+    sessionId: string;
+    /**
+     * Array of items in the cart
+     */
+    items: Array<CartItem>;
+    /**
+     * Total cost of all items in cart
+     */
+    total: number;
+    /**
+     * When the cart session was created
+     */
+    createdAt: string;
+    /**
+     * When the cart was last updated
+     */
+    updatedAt: string;
+};
+
+export type GetApiCartBySessionIdData = {
+    body?: never;
+    path: {
+        /**
+         * Cart session identifier
+         */
+        sessionId: string;
+    };
+    query?: never;
+    url: '/api/cart/{sessionId}';
+};
+
+export type GetApiCartBySessionIdResponses = {
+    /**
+     * Cart session details
+     */
+    200: CartSession;
+};
+
+export type GetApiCartBySessionIdResponse = GetApiCartBySessionIdResponses[keyof GetApiCartBySessionIdResponses];
+
+export type PostApiCartBySessionIdAddData = {
+    body: {
+        /**
+         * Product identifier
+         */
+        productId: string;
+        /**
+         * Product name
+         */
+        name: string;
+        /**
+         * Product price
+         */
+        price: number;
+        /**
+         * Quantity to add
+         */
+        quantity: number;
+    };
+    path: {
+        /**
+         * Cart session identifier
+         */
+        sessionId: string;
+    };
+    query?: never;
+    url: '/api/cart/{sessionId}/add';
+};
+
+export type PostApiCartBySessionIdAddErrors = {
+    /**
+     * Invalid request data
+     */
+    400: unknown;
+};
+
+export type PostApiCartBySessionIdAddResponses = {
+    /**
+     * Item added to cart successfully
+     */
+    200: CartSession;
+};
+
+export type PostApiCartBySessionIdAddResponse = PostApiCartBySessionIdAddResponses[keyof PostApiCartBySessionIdAddResponses];
+
+export type PostApiCartBySessionIdRemoveData = {
+    body: {
+        /**
+         * Product identifier to remove
+         */
+        productId: string;
+        /**
+         * Quantity to remove (optional, removes all if not specified)
+         */
+        quantity: number;
+    };
+    path: {
+        /**
+         * Cart session identifier
+         */
+        sessionId: string;
+    };
+    query?: never;
+    url: '/api/cart/{sessionId}/remove';
+};
+
+export type PostApiCartBySessionIdRemoveErrors = {
+    /**
+     * Invalid request data
+     */
+    400: unknown;
+    /**
+     * Product not found in cart
+     */
+    404: unknown;
+};
+
+export type PostApiCartBySessionIdRemoveResponses = {
+    /**
+     * Item removed from cart successfully
+     */
+    200: CartSession;
+};
+
+export type PostApiCartBySessionIdRemoveResponse = PostApiCartBySessionIdRemoveResponses[keyof PostApiCartBySessionIdRemoveResponses];
+
+export type PostApiCartBySessionIdClearData = {
+    body?: never;
+    path: {
+        /**
+         * Cart session identifier
+         */
+        sessionId: string;
+    };
+    query?: never;
+    url: '/api/cart/{sessionId}/clear';
+};
+
+export type PostApiCartBySessionIdClearResponses = {
+    /**
+     * Cart cleared successfully
+     */
+    200: CartSession;
+};
+
+export type PostApiCartBySessionIdClearResponse = PostApiCartBySessionIdClearResponses[keyof PostApiCartBySessionIdClearResponses];
+
+export type ClientOptions = {
+    baseUrl: 'http://localhost:3002' | (string & {});
+};

package/templates/shopping-app/example-integrations/cart/src/generated/cart/zod.gen.ts

@@ -0,0 +1,78 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { z } from 'zod';
+
+export const zCartItem = z.object({
+    productId: z.string(),
+    name: z.string(),
+    price: z.number(),
+    quantity: z.number()
+});
+
+export const zCartSession = z.object({
+    sessionId: z.string(),
+    items: z.array(zCartItem),
+    total: z.number(),
+    createdAt: z.coerce.date(),
+    updatedAt: z.coerce.date()
+});
+
+export const zGetApiCartBySessionIdData = z.object({
+    body: z.optional(z.never()),
+    path: z.object({
+        sessionId: z.string()
+    }),
+    query: z.optional(z.never())
+});
+
+/**
+ * Cart session details
+ */
+export const zGetApiCartBySessionIdResponse = zCartSession;
+
+export const zPostApiCartBySessionIdAddData = z.object({
+    body: z.object({
+        productId: z.string(),
+        name: z.string(),
+        price: z.number(),
+        quantity: z.number()
+    }),
+    path: z.object({
+        sessionId: z.string()
+    }),
+    query: z.optional(z.never())
+});
+
+/**
+ * Item added to cart successfully
+ */
+export const zPostApiCartBySessionIdAddResponse = zCartSession;
+
+export const zPostApiCartBySessionIdRemoveData = z.object({
+    body: z.object({
+        productId: z.string(),
+        quantity: z.number()
+    }),
+    path: z.object({
+        sessionId: z.string()
+    }),
+    query: z.optional(z.never())
+});
+
+/**
+ * Item removed from cart successfully
+ */
+export const zPostApiCartBySessionIdRemoveResponse = zCartSession;
+
+export const zPostApiCartBySessionIdClearData = z.object({
+    body: z.optional(z.never()),
+    path: z.object({
+        sessionId: z.string()
+    }),
+    query: z.optional(z.never())
+});
+
+/**
+ * Cart cleared successfully
+ */
+export const zPostApiCartBySessionIdClearResponse = zCartSession;

package/templates/shopping-app/example-integrations/cart/src/index.ts

@@ -0,0 +1 @@
+export * from './cart-integration';