resora 0.1.6 → 0.1.7

package/dist/index.d.cts

@@ -165,11 +165,11 @@ interface Cursor {
 }
 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.
+   * @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 where the stub templates are located.
+   * @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;
   /**
@@ -189,12 +189,45 @@ interface Config {
      */
     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'] | {
+    meta?: string | undefined;
+    links?: 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.
+   */
+  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;
+    links?: string | undefined;
+    path?: string | undefined;
+    total?: string | undefined;
+    per_page?: string | undefined;
+    last_page?: string | undefined;
+    current_page?: string | undefined;
+  };
 }
 //#endregion
 //#region src/cli/CliApp.d.ts
 declare class CliApp {
   command: Command;
-  private config;
+  protected config: Config;
   constructor(config?: Partial<Config>);
   /**
    * Initialize Resora by creating a default config file in the current directory

package/dist/index.d.mts

@@ -165,11 +165,11 @@ interface Cursor {
 }
 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.
+   * @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 where the stub templates are located.
+   * @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;
   /**
@@ -189,12 +189,45 @@ interface Config {
      */
     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'] | {
+    meta?: string | undefined;
+    links?: 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.
+   */
+  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;
+    links?: string | undefined;
+    path?: string | undefined;
+    total?: string | undefined;
+    per_page?: string | undefined;
+    last_page?: string | undefined;
+    current_page?: string | undefined;
+  };
 }
 //#endregion
 //#region src/cli/CliApp.d.ts
 declare class CliApp {
   command: Command;
-  private config;
+  protected config: Config;
   constructor(config?: Partial<Config>);
   /**
    * Initialize Resora by creating a default config file in the current directory

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resora",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "A structured API response layer for Node.js and TypeScript with automatic JSON responses, collection support, and pagination handling.",
   "keywords": [
     "api",