resora 0.1.6 → 0.1.8

package/bin/index.mjs

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
-import{copyFileSync as e,existsSync as t,mkdirSync as n,readFileSync as r,rmSync as i,writeFileSync as a}from"fs";import o,{dirname as s,join as c}from"path";import{createRequire as l}from"module";import{fileURLToPath as u}from"url";import{Command as d,Kernel as f}from"@h3ravel/musket";const p=o.dirname(u(import.meta.url));let m=o.resolve(p,`../node_modules/resora/stubs`);t(m)||(m=o.resolve(p,`../stubs`));const h=(e={})=>Object.assign({resourcesDir:`src/resources`,stubsDir:m,stubs:{config:`resora.config.stub`,resource:`resource.stub`,collection:`resource.collection.stub`}},e,{stubs:Object.assign({config:`resora.config.stub`,resource:`resource.stub`,collection:`resource.collection.stub`},e.stubs||{})});var g=class{command;config={};constructor(e={}){this.config=h(e);let n=l(import.meta.url),r=[c(process.cwd(),`resora.config.ts`),c(process.cwd(),`resora.config.js`),c(process.cwd(),`resora.config.cjs`)];for(let e of r)if(t(e))try{let{default:t}=n(e);Object.assign(this.config,h(t));break}catch(t){console.error(`Error loading config file at ${e}:`,t)}}init(){let n=c(process.cwd(),`resora.config.js`),i=c(this.config.stubsDir,this.config.stubs.config);return t(n)&&!this.command.option(`force`)&&(this.command.error(`Error: ${n} already exists.`),process.exit(1)),this.ensureDirectory(n),t(n)&&this.command.option(`force`)&&e(n,n.replace(/\.js$/,`.backup.${Date.now()}.js`)),a(n,r(i,`utf-8`)),{path:n}}ensureDirectory(e){let r=s(e);t(r)||n(r,{recursive:!0})}generateFile(e,n,o,s){t(n)&&!s?.force?(this.command.error(`Error: ${n} already exists.`),process.exit(1)):t(n)&&s?.force&&i(n);let c=r(e,`utf-8`);for(let[e,t]of Object.entries(o))c=c.replace(RegExp(`{{${e}}}`,`g`),t);return this.ensureDirectory(n),a(n,c),n}makeResource(e,n){let r=e;n?.collection&&!e.endsWith(`Collection`)&&!e.endsWith(`Resource`)?r+=`Collection`:!n?.collection&&!e.endsWith(`Resource`)&&!e.endsWith(`Collection`)&&(r+=`Resource`);let i=`${r}.ts`,a=c(this.config.resourcesDir,i),o=c(this.config.stubsDir,n?.collection||e.endsWith(`Collection`)?this.config.stubs.collection:this.config.stubs.resource);t(o)||(this.command.error(`Error: Stub file ${o} not found.`),process.exit(1));let s=r.replace(/(Resource|Collection)$/,``)+`Resource`,l=`/** 
+import{copyFileSync as e,existsSync as t,mkdirSync as n,readFileSync as r,rmSync as i,writeFileSync as a}from"fs";import o,{dirname as s,join as c}from"path";import{createRequire as l}from"module";import{Command as u,Kernel as d}from"@h3ravel/musket";let f=o.resolve(process.cwd(),`node_modules/resora/stubs`);t(f)||(f=o.resolve(process.cwd(),`stubs`));const p=()=>({stubsDir:f,preferredCase:`camel`,paginatedExtras:[`meta`,`links`],paginatedLinks:{first:`first`,last:`last`,prev:`prev`,next:`next`},paginatedMeta:{to:`to`,from:`from`,links:`links`,path:`path`,total:`total`,per_page:`per_page`,last_page:`last_page`,current_page:`current_page`},resourcesDir:`src/resources`,stubs:{config:`resora.config.stub`,resource:`resource.stub`,collection:`resource.collection.stub`}}),m=(e={})=>{let t=p();return Object.assign(t,e,{stubs:Object.assign(t.stubs,e.stubs||{})})};var h=class{command;config={};constructor(e={}){this.config=m(e);let n=l(import.meta.url),r=[c(process.cwd(),`resora.config.ts`),c(process.cwd(),`resora.config.js`),c(process.cwd(),`resora.config.cjs`)];for(let e of r)if(t(e))try{let{default:t}=n(e);Object.assign(this.config,t);break}catch(t){console.error(`Error loading config file at ${e}:`,t)}}init(){let n=c(process.cwd(),`resora.config.js`),i=c(this.config.stubsDir,this.config.stubs.config);return t(n)&&!this.command.option(`force`)&&(this.command.error(`Error: ${n} already exists.`),process.exit(1)),this.ensureDirectory(n),t(n)&&this.command.option(`force`)&&e(n,n.replace(/\.js$/,`.backup.${Date.now()}.js`)),a(n,r(i,`utf-8`)),{path:n}}ensureDirectory(e){let r=s(e);t(r)||n(r,{recursive:!0})}generateFile(e,n,o,s){t(n)&&!s?.force?(this.command.error(`Error: ${n} already exists.`),process.exit(1)):t(n)&&s?.force&&i(n);let c=r(e,`utf-8`);for(let[e,t]of Object.entries(o))c=c.replace(RegExp(`{{${e}}}`,`g`),t);return this.ensureDirectory(n),a(n,c),n}makeResource(e,n){let r=e;n?.collection&&!e.endsWith(`Collection`)&&!e.endsWith(`Resource`)?r+=`Collection`:!n?.collection&&!e.endsWith(`Resource`)&&!e.endsWith(`Collection`)&&(r+=`Resource`);let i=`${r}.ts`,a=c(this.config.resourcesDir,i),o=c(this.config.stubsDir,n?.collection||e.endsWith(`Collection`)?this.config.stubs.collection:this.config.stubs.resource);t(o)||(this.command.error(`Error: Stub file ${o} not found.`),process.exit(1));let s=r.replace(/(Resource|Collection)$/,``)+`Resource`,l=`/** 
      * The resource that this collection collects.
      */
     collects = ${s}
-    `,u=`import ${s} from './${s}'\n`,d=(!!n?.collection||e.endsWith(`Collection`))&&t(c(this.config.resourcesDir,`${s}.ts`)),f=this.generateFile(o,a,{ResourceName:r,CollectionResourceName:r.replace(/(Resource|Collection)$/,``)+`Resource`,"collects = Resource":d?l:``,"import = Resource":d?u:``},n);return{name:r,path:f}}},_=class extends d{signature=`init
+    `,u=`import ${s} from './${s}'\n`,d=(!!n?.collection||e.endsWith(`Collection`))&&t(c(this.config.resourcesDir,`${s}.ts`)),f=this.generateFile(o,a,{ResourceName:r,CollectionResourceName:r.replace(/(Resource|Collection)$/,``)+`Resource`,"collects = Resource":d?l:``,"import = Resource":d?u:``},n);return{name:r,path:f}}},g=class extends u{signature=`init
         {--force : Force overwrite if config file already exists (existing file will be backed up) }
-    `;description=`Initialize Resora`;async handle(){this.app.command=this,this.app.init(),this.success(`Resora initialized`)}},v=class extends d{signature=`#create:
+    `;description=`Initialize Resora`;async handle(){this.app.command=this,this.app.init(),this.success(`Resora initialized`)}},_=class extends u{signature=`#create:
         {resource : Generates a new resource file.
             | {name : Name of the resource to create}
             | {--c|collection : Make a resource collection}
@@ -19,11 +19,11 @@ import{copyFileSync as e,existsSync as t,mkdirSync as n,readFileSync as r,rmSync
             | {prefix : prefix of the resources to create, "Admin" will create AdminResource, AdminCollection} 
             | {--force : Create the resource or collection file even if it already exists.}
         }
-    `;description=`Create a new resource or resource collection file`;async handle(){this.app.command=this;let e=``,t=this.dictionary.name||this.dictionary.baseCommand;if([`resource`,`collection`].includes(t)&&!this.argument(`name`))return void this.error(`Error: Name argument is required.`);if(t===`all`&&!this.argument(`prefix`))return void this.error(`Error: Prefix argument is required.`);switch(t){case`resource`:({path:e}=this.app.makeResource(this.argument(`name`),this.options()));break;case`collection`:({path:e}=this.app.makeResource(this.argument(`name`)+`Collection`,this.options()));break;case`all`:{let t=this.app.makeResource(this.argument(`prefix`),{force:this.option(`force`)}),n=this.app.makeResource(this.argument(`prefix`)+`Collection`,{collection:!0,force:this.option(`force`)});e=`${t.path}, ${n.path}`;break}default:this.fail(`Unknown action: ${t}`)}this.success(`Created: ${e}`)}},y=String.raw`
+    `;description=`Create a new resource or resource collection file`;async handle(){this.app.command=this;let e=``,t=this.dictionary.name||this.dictionary.baseCommand;if([`resource`,`collection`].includes(t)&&!this.argument(`name`))return void this.error(`Error: Name argument is required.`);if(t===`all`&&!this.argument(`prefix`))return void this.error(`Error: Prefix argument is required.`);switch(t){case`resource`:({path:e}=this.app.makeResource(this.argument(`name`),this.options()));break;case`collection`:({path:e}=this.app.makeResource(this.argument(`name`)+`Collection`,this.options()));break;case`all`:{let t=this.app.makeResource(this.argument(`prefix`),{force:this.option(`force`)}),n=this.app.makeResource(this.argument(`prefix`)+`Collection`,{collection:!0,force:this.option(`force`)});e=`${t.path}, ${n.path}`;break}default:this.fail(`Unknown action: ${t}`)}this.success(`Created: ${e}`)}},v=String.raw`
   _____                           
  |  __ \                          
  | |__) |___  ___  ___  _ __ __ _ 
  |  _  // _ \/ __|/ _ \| '__/ _, |
  | | \ \  __/\__ \ (_) | | | (_| |
  |_|  \_\___||___/\___/|_|  \__,_|                                                                                           
-`;const b=new g;await f.init(b,{logo:y,name:`Resora CLI`,baseCommands:[v,_],exceptionHandler(e){throw e}});export{};
+`;const y=new h;await d.init(y,{logo:v,name:`Resora CLI`,baseCommands:[_,g],exceptionHandler(e){throw e}});export{};

package/dist/index.cjs

@@ -30,7 +30,6 @@ let fs = require("fs");
 let path = require("path");
 path = __toESM(path);
 let module$1 = require("module");
-let url = require("url");
 let _h3ravel_musket = require("@h3ravel/musket");
 
 //#region src/ApiResource.ts
@@ -46,9 +45,37 @@ function ApiResource(instance) {
 
 //#endregion
 //#region src/utility.ts
-const __dirname$1 = /* @__PURE__ */ path.default.dirname((0, url.fileURLToPath)(require("url").pathToFileURL(__filename).href));
-let stubsDir = path.default.resolve(__dirname$1, "../node_modules/resora/stubs");
-if (!(0, fs.existsSync)(stubsDir)) stubsDir = path.default.resolve(__dirname$1, "../stubs");
+let stubsDir = path.default.resolve(process.cwd(), "node_modules/resora/stubs");
+if (!(0, fs.existsSync)(stubsDir)) stubsDir = path.default.resolve(process.cwd(), "stubs");
+const getDefaultConfig = () => {
+	return {
+		stubsDir,
+		preferredCase: "camel",
+		paginatedExtras: ["meta", "links"],
+		paginatedLinks: {
+			first: "first",
+			last: "last",
+			prev: "prev",
+			next: "next"
+		},
+		paginatedMeta: {
+			to: "to",
+			from: "from",
+			links: "links",
+			path: "path",
+			total: "total",
+			per_page: "per_page",
+			last_page: "last_page",
+			current_page: "current_page"
+		},
+		resourcesDir: "src/resources",
+		stubs: {
+			config: "resora.config.stub",
+			resource: "resource.stub",
+			collection: "resource.collection.stub"
+		}
+	};
+};
 /**
 * Define the configuration for the package
 * 
@@ -56,19 +83,8 @@ if (!(0, fs.existsSync)(stubsDir)) stubsDir = path.default.resolve(__dirname$1,
 * @returns The merged configuration object
 */
 const defineConfig = (userConfig = {}) => {
-	return Object.assign({
-		resourcesDir: "src/resources",
-		stubsDir,
-		stubs: {
-			config: "resora.config.stub",
-			resource: "resource.stub",
-			collection: "resource.collection.stub"
-		}
-	}, userConfig, { stubs: Object.assign({
-		config: "resora.config.stub",
-		resource: "resource.stub",
-		collection: "resource.collection.stub"
-	}, userConfig.stubs || {}) });
+	const defaultConfig = getDefaultConfig();
+	return Object.assign(defaultConfig, userConfig, { stubs: Object.assign(defaultConfig.stubs, userConfig.stubs || {}) });
 };
 
 //#endregion
@@ -86,7 +102,7 @@ var CliApp = class {
 		];
 		for (const configPath of possibleConfigPaths) if ((0, fs.existsSync)(configPath)) try {
 			const { default: userConfig } = require(configPath);
-			Object.assign(this.config, defineConfig(userConfig));
+			Object.assign(this.config, userConfig);
 			break;
 		} catch (e) {
 			console.error(`Error loading config file at ${configPath}:`, e);
@@ -702,4 +718,5 @@ exports.MakeResource = MakeResource;
 exports.Resource = Resource;
 exports.ResourceCollection = ResourceCollection;
 exports.ServerResponse = ServerResponse;
-exports.defineConfig = defineConfig;
+exports.defineConfig = defineConfig;
+exports.getDefaultConfig = getDefaultConfig;

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
@@ -491,6 +524,7 @@ declare class GenericResource<R extends NonCollectible | Collectible | ResourceD
 }
 //#endregion
 //#region src/utility.d.ts
+declare const getDefaultConfig: () => Config;
 /**
  * Define the configuration for the package
  *
@@ -501,4 +535,4 @@ 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 };
+export { ApiResource, CliApp, Collectible, CollectionBody, Config, Cursor, GenericBody, GenericResource, MakeResource, MetaData, NonCollectible, PaginatedMetaData, Pagination, Resource, ResourceBody, ResourceCollection, ResourceData, ResourceDef, ResponseData, ResponseDataCollection, ServerResponse, defineConfig, getDefaultConfig };

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
@@ -491,6 +524,7 @@ declare class GenericResource<R extends NonCollectible | Collectible | ResourceD
 }
 //#endregion
 //#region src/utility.d.ts
+declare const getDefaultConfig: () => Config;
 /**
  * Define the configuration for the package
  *
@@ -501,4 +535,4 @@ 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 };
+export { ApiResource, CliApp, Collectible, CollectionBody, Config, Cursor, GenericBody, GenericResource, MakeResource, MetaData, NonCollectible, PaginatedMetaData, Pagination, Resource, ResourceBody, ResourceCollection, ResourceData, ResourceDef, ResponseData, ResponseDataCollection, ServerResponse, defineConfig, getDefaultConfig };

package/dist/index.mjs

@@ -1,7 +1,6 @@
 import { copyFileSync, existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "fs";
 import path, { dirname, join } from "path";
 import { createRequire } from "module";
-import { fileURLToPath } from "url";
 import { Command } from "@h3ravel/musket";
 
 //#region src/ApiResource.ts
@@ -17,9 +16,37 @@ function ApiResource(instance) {
 
 //#endregion
 //#region src/utility.ts
-const __dirname = /* @__PURE__ */ path.dirname(fileURLToPath(import.meta.url));
-let stubsDir = path.resolve(__dirname, "../node_modules/resora/stubs");
-if (!existsSync(stubsDir)) stubsDir = path.resolve(__dirname, "../stubs");
+let stubsDir = path.resolve(process.cwd(), "node_modules/resora/stubs");
+if (!existsSync(stubsDir)) stubsDir = path.resolve(process.cwd(), "stubs");
+const getDefaultConfig = () => {
+	return {
+		stubsDir,
+		preferredCase: "camel",
+		paginatedExtras: ["meta", "links"],
+		paginatedLinks: {
+			first: "first",
+			last: "last",
+			prev: "prev",
+			next: "next"
+		},
+		paginatedMeta: {
+			to: "to",
+			from: "from",
+			links: "links",
+			path: "path",
+			total: "total",
+			per_page: "per_page",
+			last_page: "last_page",
+			current_page: "current_page"
+		},
+		resourcesDir: "src/resources",
+		stubs: {
+			config: "resora.config.stub",
+			resource: "resource.stub",
+			collection: "resource.collection.stub"
+		}
+	};
+};
 /**
 * Define the configuration for the package
 * 
@@ -27,19 +54,8 @@ if (!existsSync(stubsDir)) stubsDir = path.resolve(__dirname, "../stubs");
 * @returns The merged configuration object
 */
 const defineConfig = (userConfig = {}) => {
-	return Object.assign({
-		resourcesDir: "src/resources",
-		stubsDir,
-		stubs: {
-			config: "resora.config.stub",
-			resource: "resource.stub",
-			collection: "resource.collection.stub"
-		}
-	}, userConfig, { stubs: Object.assign({
-		config: "resora.config.stub",
-		resource: "resource.stub",
-		collection: "resource.collection.stub"
-	}, userConfig.stubs || {}) });
+	const defaultConfig = getDefaultConfig();
+	return Object.assign(defaultConfig, userConfig, { stubs: Object.assign(defaultConfig.stubs, userConfig.stubs || {}) });
 };
 
 //#endregion
@@ -57,7 +73,7 @@ var CliApp = class {
 		];
 		for (const configPath of possibleConfigPaths) if (existsSync(configPath)) try {
 			const { default: userConfig } = require(configPath);
-			Object.assign(this.config, defineConfig(userConfig));
+			Object.assign(this.config, userConfig);
 			break;
 		} catch (e) {
 			console.error(`Error loading config file at ${configPath}:`, e);
@@ -666,4 +682,4 @@ var Resource = class {
 };
 
 //#endregion
-export { ApiResource, CliApp, GenericResource, MakeResource, Resource, ResourceCollection, ServerResponse, defineConfig };
+export { ApiResource, CliApp, GenericResource, MakeResource, Resource, ResourceCollection, ServerResponse, defineConfig, getDefaultConfig };

package/package.json

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