resora 0.1.11 → 0.2.1

package/dist/index.d.cts

@@ -11,7 +11,76 @@ import { Response } from "express";
  */
 declare function ApiResource<R extends Resource>(instance: Resource<R>): Resource<R>;
 //#endregion
-//#region src/types.d.ts
+//#region src/types/common.d.ts
+/**
+ * @description A type representing a case transformation strategy.
+ * Can be a preset string ('camel', 'snake', 'pascal', 'kebab') or a custom transformer function.
+ */
+type CaseStyle = 'camel' | 'snake' | 'pascal' | 'kebab' | ((key: string) => string);
+/**
+ * @description A type representing the resource serializer variant.
+ */
+type ResponseKind = 'resource' | 'collection' | 'generic';
+/**
+ * @description Context passed into a response factory function.
+ */
+interface ResponseFactoryContext {
+  type: ResponseKind;
+  rootKey: string;
+  resource: any;
+  meta?: Record<string, any> | undefined;
+}
+/**
+ * @description A factory used to produce a fully custom response envelope.
+ */
+type ResponseFactory = (payload: any, context: ResponseFactoryContext) => Record<string, any>;
+/**
+ * @description Structure options for customizing the response envelope.
+ */
+interface ResponseStructureConfig {
+  /**
+   * @description Whether payloads should be wrapped in a root key.
+   * Set to false to return unwrapped payloads when possible.
+   * @default true
+   */
+  wrap?: boolean | undefined;
+  /**
+   * @description The key used to wrap resource payloads.
+   * @default 'data'
+   */
+  rootKey?: string | undefined;
+  /**
+   * @description A factory for complete control over the final response structure.
+   */
+  factory?: ResponseFactory | undefined;
+}
+//#endregion
+//#region src/types/pagination.d.ts
+/**
+ * @description A type that represents the pagination information for a collection of resources. It includes properties such as currentPage, from, to, perPage, total, firstPage, lastPage, prevPage, and nextPage. All properties are optional and can be undefined if not applicable.
+ */
+interface Pagination {
+  currentPage?: number | undefined;
+  from?: number | undefined;
+  to?: number | undefined;
+  perPage?: number | undefined;
+  total?: number | undefined;
+  firstPage?: number | undefined;
+  lastPage?: number | undefined;
+  prevPage?: number | undefined;
+  nextPage?: number | undefined;
+  path?: string | undefined;
+  links?: any;
+}
+/**
+ * @description A type that represents the cursor information for pagination. It includes properties such as before and after, which are optional and can be undefined if not applicable. The before property represents the cursor for the previous page, while the after property represents the cursor for the next page.
+ */
+interface Cursor {
+  previous?: string | undefined;
+  next?: string | undefined;
+}
+//#endregion
+//#region src/types/resource.d.ts
 interface MetaData {
   [key: string]: any;
 }
@@ -35,183 +104,47 @@ interface ResponseData<R extends ResourceData = any> extends ResourceDef {
   meta?: MetaData | undefined;
 }
 /**
- * @description A type that represents the metadata for a paginated collection of resources. It extends the MetaData type and includes all properties of a Collectible object except for the data property. This type is used to provide additional information about the paginated collection, such as pagination details, without including the actual resource data.
- * @example
- * const paginatedMeta: PaginatedMetaData = {
- *   pagination: {
- *     currentPage: 1,
- *     total: 100
- *   },
- *   timestamp: '2024-06-01T12:00:00Z'
- * };
+ * @description A type that represents the metadata for a paginated collection of resources.
  */
 type PaginatedMetaData<R extends Collectible = Collectible> = MetaData & Omit<R, 'data'>;
 /**
- * @description A type that represents the body of a response for a collection of resources. It includes a data property, which can be either an array of ResourceData objects or a Collectible object, and an optional meta property that can contain any additional metadata related to the response. The type is generic and can be used to define the structure of the response body for API endpoints that return collections of resources.
- * @example
- * const collectionResponse: CollectionBody = {
- *   data: [
- *     { id: 1, name: 'Resource 1' },
- *     { id: 2, name: 'Resource 2' }
- *   ],
- *   meta: {
- *     pagination: {
- *       currentPage: 1,
- *       total: 2
- *     }
- *   }
- * };
+ * @description A type that represents the body of a response for a collection of resources.
  */
 interface ResponseDataCollection<R extends Collectible | undefined = undefined> extends ResourceData {
   data: R extends Collectible ? R['data'] : R;
   meta?: R extends Collectible ? PaginatedMetaData<R> | undefined : undefined;
 }
-/**
- * @description A type that represents the body of a response for a collection of resources.
- * It can be either an array of ResourceData objects or a Collectible object, which contains an
- * array of ResourceData objects. The type also includes the meta property, which is optional
- * and can contain any additional metadata related to the response.
- * @example
- * const collectionResponse: CollectionBody = {
- *   data: [
- *     { id: 1, name: 'Resource 1' },
- *     { id: 2, name: 'Resource 2' }
- *   ],
- *   meta: {
- *     pagination: {
- *       currentPage: 1,
- *       total: 2
- *     }
- *   }
- * };
- */
 type CollectionBody<R extends ResourceData[] | Collectible = ResourceData[]> = ResponseDataCollection<R extends Collectible ? R : {
   data: R;
 }>;
-/**
- * @description A type that represents the body of a response for a single resource.
- * It can be either a ResourceData object or a NonCollectible object, which contains a
- * ResourceData object. The type also includes the meta property, which is optional and can
- * contain any additional metadata related to the response.
- * @example
- * const resourceResponse: ResourceBody = {
- *   data: {
- *     id: 1,
- *     name: 'Resource Name',
- *     description: 'Resource Description'
- *   },
- *   meta: {
- *     timestamp: '2024-06-01T12:00:00Z'
- *   }
- * };
- */
 type ResourceBody<R extends ResourceData | NonCollectible = ResourceData> = ResponseData<R extends NonCollectible ? R : {
   data: R;
 }>;
-/**
- * @description A type that represents the body of a response for either a single resource or a collection of resources.
- * It can be either a ResourceData object, an array of ResourceData objects, a NonCollectible object, or a Collectible object.
- * The type also includes the meta property, which is optional and can contain any additional metadata related to the response.
- * @example
- * const genericResponse: GenericBody = {
- *   data: {
- *     id: 1,
- *     name: 'Resource Name',
- *     description: 'Resource Description'
- *   },
- *   meta: {
- *     timestamp: '2024-06-01T12:00:00Z'
- *   }
- * };
- */
 type GenericBody<R extends NonCollectible | Collectible | ResourceData = ResourceData> = ResponseData<R>;
-/**
- * @description A type that represents the pagination information for a collection of resources. It includes properties such as currentPage, from, to, perPage, total, firstPage, lastPage, prevPage, and nextPage. All properties are optional and can be undefined if not applicable.
- * @example
- * const paginationInfo: Pagination = {
- *   currentPage: 1,
- *   from: 1,
- *   to: 10,
- *   perPage: 10,
- *   total: 100,
- *   firstPage: 1,
- *   lastPage: 10,
- *   prevPage: null,
- *   nextPage: 2
- * };
- */
-interface Pagination {
-  currentPage?: number | undefined;
-  from?: number | undefined;
-  to?: number | undefined;
-  perPage?: number | undefined;
-  total?: number | undefined;
-  firstPage?: number | undefined;
-  lastPage?: number | undefined;
-  prevPage?: number | undefined;
-  nextPage?: number | undefined;
-}
-/**
- * @description A type that represents the cursor information for pagination. It includes properties such as before and after, which are optional and can be undefined if not applicable. The before property represents the cursor for the previous page, while the after property represents the cursor for the next page.
- * @example
- * const cursorInfo: Cursor = {
- *   previous: 'cursor-for-previous-page',
- *   next: 'cursor-for-next-page'
- * };
- */
-interface Cursor {
-  previous?: string | undefined;
-  next?: string | undefined;
-}
+//#endregion
+//#region src/types/config.d.ts
 interface Config {
-  /**
-   * @description The directory where resource files are stored. This is the location where the generated resource files will be saved. It should be a valid path on the file system relative to the project root.
-   */
   resourcesDir: string;
-  /**
-   * @description The directory where stub files are stored. Stub files are templates used for generating resource files. This should also be a valid path on the file system relative to the project root where the stub templates are located.
-   */
   stubsDir: string;
-  /**
-   * @description An object that defines the stub file names for different types of resources.
-   */
   stubs: {
-    /**
-     * @description The stub file name for the configuration file. This stub will be used when generating the default configuration file.
-     */
     config: string;
-    /**
-     * @description The stub file name for a resource. This stub will be used when generating a resource file.
-     */
     resource: string;
-    /**
-     * @description The stub file name for a collection resource. This stub will be used when generating a collection resource file.
-     */
     collection: string;
   };
-  /**
-   * @description This option allows you to specify the case style that should be used for the keys in API responses returned by the resources.
-   */
-  preferredCase: 'camel' | 'snake' | 'pascal' | 'kebab';
-  /**
-   * @description This option allows you to specify the extra properties that should be included in the response body when a resource is paginated. You can choose to include either 'meta', 'links', or both, or you can provide custom property names for these extras.
-   */
-  paginatedExtras: ['meta', 'links'] | {
+  preferredCase: CaseStyle;
+  paginatedExtras: ('meta' | 'links' | 'cursor')[] | {
     meta?: string | undefined;
     links?: string | undefined;
+    cursor?: string | undefined;
   };
-  /**
-   * @description This option allows you to specify the property names that should be used for pagination links in the response body when a resource is paginated. You can provide custom property names for the pagination links, and if not specified, the default property names will be used.
-   */
+  baseUrl: string;
+  pageName: string;
   paginatedLinks: {
     first?: string | undefined;
     last?: string | undefined;
     prev?: string | undefined;
     next?: string | undefined;
   };
-  /**
-   * @description This option allows you to specify the property names that should be used for pagination metadata in the response body when a resource is paginated. You can provide custom property names for properties, and if not specified, the default property names will be used.
-   */
   paginatedMeta: {
     to?: string | undefined;
     from?: string | undefined;
@@ -222,6 +155,12 @@ interface Config {
     last_page?: string | undefined;
     current_page?: string | undefined;
   };
+  cursorMeta: {
+    previous?: string | undefined;
+    next?: string | undefined;
+  };
+  responseStructure: ResponseStructureConfig;
+  extraCommands?: typeof Command<any>[];
 }
 //#endregion
 //#region src/cli/CliApp.d.ts
@@ -230,6 +169,11 @@ declare class CliApp {
   protected config: Config;
   constructor(config?: Partial<Config>);
   loadConfig(config?: Partial<Config>): Promise<this>;
+  /**
+   * Get the current configuration object
+   * @returns
+   */
+  getConfig(): Config;
   /**
    * Initialize Resora by creating a default config file in the current directory
    *
@@ -264,6 +208,13 @@ declare class CliApp {
   };
 }
 //#endregion
+//#region src/cli/commands/InitCommand.d.ts
+declare class InitCommand extends Command<CliApp> {
+  protected signature: string;
+  protected description: string;
+  handle(): Promise<void>;
+}
+//#endregion
 //#region src/cli/commands/MakeResource.d.ts
 declare class MakeResource extends Command<CliApp> {
   protected signature: string;
@@ -272,7 +223,7 @@ declare class MakeResource extends Command<CliApp> {
 }
 //#endregion
 //#region src/ServerResponse.d.ts
-declare class ServerResponse<R extends NonCollectible | Collectible | ResourceData[] | ResourceData = ResourceData> {
+declare class ServerResponse<R extends NonCollectible | Collectible | ResourceData[] | ResourceData = any> {
   #private;
   private response;
   private body;
@@ -354,9 +305,23 @@ declare class ServerResponse<R extends NonCollectible | Collectible | ResourceDa
 declare class ResourceCollection<R extends ResourceData[] | Collectible = ResourceData[], T extends ResourceData = any> {
   private res?;
   [key: string]: any;
-  body: CollectionBody<R>;
+  private body;
   resource: R;
   collects?: typeof Resource<T>;
+  private additionalMeta?;
+  protected withResponseContext?: {
+    response: ServerResponse<CollectionBody<R>>;
+    raw: Response | H3Event['res'];
+  };
+  /**
+   * Preferred case style for this collection's output keys.
+   * Set on a subclass to override the global default.
+   */
+  static preferredCase?: CaseStyle;
+  /**
+   * Response structure override for this collection class.
+   */
+  static responseStructure?: ResponseStructureConfig;
   private called;
   constructor(rsc: R);
   constructor(rsc: R, res: Response);
@@ -364,12 +329,48 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible = Resour
    * Get the original resource data
    */
   data(): (R extends Collectible ? R["data"][number] : R extends ResourceData[] ? R[number] : never)[];
+  /**
+   * Get the current serialized output body.
+   */
+  getBody(): CollectionBody<R>;
+  /**
+   * Replace the current serialized output body.
+   */
+  protected setBody(body: CollectionBody<R>): this;
+  /**
+   * Conditionally include a value in serialized output.
+   */
+  when<T>(condition: any, value: T | (() => T)): T | undefined;
+  /**
+   * Include a value only when it is not null/undefined.
+   */
+  whenNotNull<T>(value: T | null | undefined): T | undefined;
+  /**
+   * Conditionally merge object attributes into serialized output.
+   */
+  mergeWhen<T extends Record<string, any>>(condition: any, value: T | (() => T)): Partial<T>;
+  private resolveResponseStructure;
+  private getPayloadKey;
   /**
    * Convert resource to JSON response format
    *
    * @returns
    */
   json(): this;
+  /**
+   * Append structured metadata to the response body.
+   *
+   * @param meta  Metadata object or metadata factory
+   * @returns
+   */
+  with(meta?: any): any;
+  /**
+   * Typed fluent metadata helper.
+   *
+   * @param meta  Metadata object or metadata factory
+   * @returns
+   */
+  withMeta<M extends MetaData>(meta: M | ((resource: R) => M)): this;
   /**
    * Flatten resource to return original data
    *
@@ -385,6 +386,12 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible = Resour
   additional<X extends Record<string, any>>(extra: X): this;
   response(): ServerResponse<CollectionBody<R>>;
   response(res: H3Event['res']): ServerResponse<CollectionBody<R>>;
+  /**
+   * Customize the outgoing transport response right before dispatch.
+   *
+   * Override in custom classes to mutate headers/status/body.
+   */
+  withResponse(_response?: ServerResponse<CollectionBody<R>>, _rawResponse?: Response | H3Event['res']): any;
   setCollects(collects: typeof Resource<T>): this;
   /**
    * Promise-like then method to allow chaining with async/await or .then() syntax
@@ -417,8 +424,22 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible = Resour
 declare class Resource<R extends ResourceData | NonCollectible = ResourceData> {
   private res?;
   [key: string]: any;
-  body: ResourceBody<R>;
+  private body;
   resource: R;
+  private additionalMeta?;
+  protected withResponseContext?: {
+    response: ServerResponse<ResourceBody<R>>;
+    raw: Response | H3Event['res'];
+  };
+  /**
+   * Preferred case style for this resource's output keys.
+   * Set on a subclass to override the global default.
+   */
+  static preferredCase?: CaseStyle;
+  /**
+   * Response structure override for this resource class.
+   */
+  static responseStructure?: ResponseStructureConfig;
   private called;
   constructor(rsc: R, res?: Response | undefined);
   /**
@@ -432,12 +453,48 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> {
    * Get the original resource data
    */
   data(): R extends NonCollectible ? R["data"] : R;
+  /**
+   * Get the current serialized output body.
+   */
+  getBody(): ResourceBody<R>;
+  /**
+   * Replace the current serialized output body.
+   */
+  protected setBody(body: ResourceBody<R>): this;
+  /**
+   * Conditionally include a value in serialized output.
+   */
+  when<T>(condition: any, value: T | (() => T)): T | undefined;
+  /**
+   * Include a value only when it is not null/undefined.
+   */
+  whenNotNull<T>(value: T | null | undefined): T | undefined;
+  /**
+   * Conditionally merge object attributes into serialized output.
+   */
+  mergeWhen<T extends Record<string, any>>(condition: any, value: T | (() => T)): Partial<T>;
+  private resolveResponseStructure;
+  private getPayloadKey;
   /**
    * Convert resource to JSON response format
    *
    * @returns
    */
   json(): this;
+  /**
+   * Append structured metadata to the response body.
+   *
+   * @param meta  Metadata object or metadata factory
+   * @returns
+   */
+  with(meta?: any): any;
+  /**
+   * Typed fluent metadata helper.
+   *
+   * @param meta  Metadata object or metadata factory
+   * @returns
+   */
+  withMeta<M extends MetaData>(meta: M | ((resource: R) => M)): this;
   /**
    * Flatten resource to array format (for collections) or return original data for single resources
    *
@@ -453,6 +510,12 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> {
   additional<X extends Record<string, any>>(extra: X): this;
   response(): ServerResponse<ResourceBody<R>>;
   response(res: H3Event['res']): ServerResponse<ResourceBody<R>>;
+  /**
+   * Customize the outgoing transport response right before dispatch.
+   *
+   * Override in custom classes to mutate headers/status/body.
+   */
+  withResponse(_response?: ServerResponse<ResourceBody<R>>, _rawResponse?: Response | H3Event['res']): any;
   /**
    * Promise-like then method to allow chaining with async/await or .then() syntax
    *
@@ -484,21 +547,71 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> {
 declare class GenericResource<R extends NonCollectible | Collectible | ResourceData = ResourceData, T extends ResourceData = any> {
   private res?;
   [key: string]: any;
-  body: GenericBody<R>;
+  private body;
   resource: R;
   collects?: typeof Resource<T>;
+  private additionalMeta?;
+  protected withResponseContext?: {
+    response: ServerResponse<GenericBody<R>>;
+    raw: Response | H3Event['res'];
+  };
+  /**
+   * Preferred case style for this resource's output keys.
+   * Set on a subclass to override the global default.
+   */
+  static preferredCase?: CaseStyle;
+  /**
+   * Response structure override for this generic resource class.
+   */
+  static responseStructure?: ResponseStructureConfig;
   private called;
   constructor(rsc: R, res?: Response | undefined);
   /**
    * Get the original resource data
    */
   data(): R;
+  /**
+   * Get the current serialized output body.
+   */
+  getBody(): GenericBody<R>;
+  /**
+   * Replace the current serialized output body.
+   */
+  protected setBody(body: GenericBody<R>): this;
+  /**
+   * Conditionally include a value in serialized output.
+   */
+  when<T>(condition: any, value: T | (() => T)): T | undefined;
+  /**
+   * Include a value only when it is not null/undefined.
+   */
+  whenNotNull<T>(value: T | null | undefined): T | undefined;
+  /**
+   * Conditionally merge object attributes into serialized output.
+   */
+  mergeWhen<T extends Record<string, any>>(condition: any, value: T | (() => T)): Partial<T>;
+  private resolveResponseStructure;
+  private getPayloadKey;
   /**
    * Convert resource to JSON response format
    *
    * @returns
    */
   json(): this;
+  /**
+   * Append structured metadata to the response body.
+   *
+   * @param meta  Metadata object or metadata factory
+   * @returns
+   */
+  with(meta?: any): any;
+  /**
+   * Typed fluent metadata helper.
+   *
+   * @param meta  Metadata object or metadata factory
+   * @returns
+   */
+  withMeta<M extends MetaData>(meta: M | ((resource: R) => M)): this;
   /**
    * Convert resource to array format (for collections)
    *
@@ -514,6 +627,12 @@ declare class GenericResource<R extends NonCollectible | Collectible | ResourceD
   additional<X extends Record<string, any>>(extra: X): this;
   response(): ServerResponse<GenericBody<R>>;
   response(res: H3Event['res']): ServerResponse<GenericBody<R>>;
+  /**
+   * Customize the outgoing transport response right before dispatch.
+   *
+   * Override in custom classes to mutate headers/status/body.
+   */
+  withResponse(_response?: ServerResponse<GenericBody<R>>, _rawResponse?: Response | H3Event['res']): any;
   /**
    * Promise-like then method to allow chaining with async/await or .then() syntax
    *
@@ -524,16 +643,85 @@ declare class GenericResource<R extends NonCollectible | Collectible | ResourceD
   then<TResult1 = GenericBody<R>, TResult2 = never>(onfulfilled?: ((value: GenericBody<R>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
 }
 //#endregion
-//#region src/utility.d.ts
+//#region src/utilities/case.d.ts
+declare const splitWords: (str: string) => string[];
+declare const toCamelCase: (str: string) => string;
+declare const toSnakeCase: (str: string) => string;
+declare const toPascalCase: (str: string) => string;
+declare const toKebabCase: (str: string) => string;
+declare const getCaseTransformer: (style: CaseStyle) => ((key: string) => string);
+declare const transformKeys: (obj: any, transformer: (key: string) => string) => any;
+//#endregion
+//#region src/utilities/conditional.d.ts
+declare const CONDITIONAL_ATTRIBUTE_MISSING: unique symbol;
+declare const resolveWhen: <T>(condition: any, value: T | (() => T)) => T | typeof CONDITIONAL_ATTRIBUTE_MISSING;
+declare const resolveWhenNotNull: <T>(value: T | null | undefined) => T | typeof CONDITIONAL_ATTRIBUTE_MISSING;
+declare const resolveMergeWhen: <T extends Record<string, any>>(condition: any, value: T | (() => T)) => Partial<T>;
+declare const sanitizeConditionalAttributes: (value: any) => any;
+//#endregion
+//#region src/utilities/config.d.ts
 declare const getDefaultConfig: () => Config;
-/**
- * Define the configuration for the package
- *
- * @param userConfig  The user configuration to override the default configuration
- * @returns The merged configuration object
- */
 declare const defineConfig: (userConfig?: Partial<Omit<Config, "stubs">> & {
   stubs?: Partial<Config["stubs"]>;
 }) => Config;
 //#endregion
-export { ApiResource, CliApp, Collectible, CollectionBody, Config, Cursor, GenericBody, GenericResource, MakeResource, MetaData, NonCollectible, PaginatedMetaData, Pagination, Resource, ResourceBody, ResourceCollection, ResourceData, ResourceDef, ResponseData, ResponseDataCollection, ServerResponse, defineConfig, getDefaultConfig };
+//#region src/utilities/metadata.d.ts
+declare const resolveWithHookMetadata: (instance: any, baseWithMethod: (...args: any[]) => any) => MetaData | undefined;
+//#endregion
+//#region src/utilities/objects.d.ts
+declare const isPlainObject: (value: any) => value is Record<string, any>;
+declare const appendRootProperties: (body: any, extra?: Record<string, any> | undefined, rootKey?: string) => any;
+declare const mergeMetadata: (base?: Record<string, any> | undefined, incoming?: Record<string, any> | undefined) => Record<string, any> | undefined;
+//#endregion
+//#region src/utilities/pagination.d.ts
+declare const getPaginationExtraKeys: () => {
+  metaKey?: string;
+  linksKey?: string;
+  cursorKey?: string;
+};
+declare const buildPaginationExtras: (resource: any) => Record<string, any>;
+//#endregion
+//#region src/utilities/response.d.ts
+declare const buildResponseEnvelope: ({
+  payload,
+  meta,
+  metaKey,
+  wrap,
+  rootKey,
+  factory,
+  context
+}: {
+  payload: any;
+  meta?: Record<string, any> | undefined;
+  metaKey?: string;
+  wrap?: boolean;
+  rootKey?: string;
+  factory?: ResponseFactory | undefined;
+  context: Omit<ResponseFactoryContext, "rootKey" | "meta">;
+}) => Record<string, any>;
+//#endregion
+//#region src/utilities/state.d.ts
+declare const setGlobalCase: (style: CaseStyle | undefined) => void;
+declare const getGlobalCase: () => CaseStyle | undefined;
+declare const setGlobalResponseStructure: (config: ResponseStructureConfig | undefined) => void;
+declare const getGlobalResponseStructure: () => ResponseStructureConfig | undefined;
+declare const setGlobalResponseRootKey: (rootKey: string | undefined) => void;
+declare const setGlobalResponseWrap: (wrap: boolean | undefined) => void;
+declare const getGlobalResponseWrap: () => boolean | undefined;
+declare const getGlobalResponseRootKey: () => string | undefined;
+declare const setGlobalResponseFactory: (factory: ResponseFactory | undefined) => void;
+declare const getGlobalResponseFactory: () => ResponseFactory | undefined;
+declare const setGlobalPaginatedExtras: (extras: Config["paginatedExtras"]) => void;
+declare const getGlobalPaginatedExtras: () => Config["paginatedExtras"];
+declare const setGlobalPaginatedLinks: (links: Config["paginatedLinks"]) => void;
+declare const getGlobalPaginatedLinks: () => Config["paginatedLinks"];
+declare const setGlobalBaseUrl: (baseUrl: Config["baseUrl"]) => void;
+declare const getGlobalBaseUrl: () => Config["baseUrl"];
+declare const setGlobalPageName: (pageName: Config["pageName"]) => void;
+declare const getGlobalPageName: () => Config["pageName"];
+declare const setGlobalPaginatedMeta: (meta: Config["paginatedMeta"]) => void;
+declare const getGlobalPaginatedMeta: () => Config["paginatedMeta"];
+declare const setGlobalCursorMeta: (meta: Config["cursorMeta"]) => void;
+declare const getGlobalCursorMeta: () => Config["cursorMeta"];
+//#endregion
+export { ApiResource, CONDITIONAL_ATTRIBUTE_MISSING, CaseStyle, CliApp, Collectible, CollectionBody, Config, Cursor, GenericBody, GenericResource, InitCommand, MakeResource, MetaData, NonCollectible, PaginatedMetaData, Pagination, Resource, ResourceBody, ResourceCollection, ResourceData, ResourceDef, ResponseData, ResponseDataCollection, ResponseFactory, ResponseFactoryContext, ResponseKind, ResponseStructureConfig, ServerResponse, appendRootProperties, buildPaginationExtras, buildResponseEnvelope, defineConfig, getCaseTransformer, getDefaultConfig, getGlobalBaseUrl, getGlobalCase, getGlobalCursorMeta, getGlobalPageName, getGlobalPaginatedExtras, getGlobalPaginatedLinks, getGlobalPaginatedMeta, getGlobalResponseFactory, getGlobalResponseRootKey, getGlobalResponseStructure, getGlobalResponseWrap, getPaginationExtraKeys, isPlainObject, mergeMetadata, resolveMergeWhen, resolveWhen, resolveWhenNotNull, resolveWithHookMetadata, sanitizeConditionalAttributes, setGlobalBaseUrl, setGlobalCase, setGlobalCursorMeta, setGlobalPageName, setGlobalPaginatedExtras, setGlobalPaginatedLinks, setGlobalPaginatedMeta, setGlobalResponseFactory, setGlobalResponseRootKey, setGlobalResponseStructure, setGlobalResponseWrap, splitWords, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, transformKeys };