resora 0.1.5 → 0.1.7

package/bin/index.mjs

@@ -1,9 +1,11 @@
 #!/usr/bin/env node
-import e,{dirname as t,join as n}from"path";import{existsSync as r,mkdirSync as i,readFileSync as a,rmSync as o,writeFileSync as s}from"fs";import{createRequire as c}from"module";import{fileURLToPath as l}from"url";import{Command as u,Kernel as d}from"@h3ravel/musket";const f=e.dirname(l(import.meta.url));let p=e.resolve(f,`../node_modules/resora/stubs`);r(p)||(p=e.resolve(f,`../stubs`));const m=(e={})=>Object.assign({resourcesDir:`src/resources`,stubsDir:p,stubs:{resource:`resource.stub`,collection:`resource.collection.stub`}},e,{stubs:Object.assign({resource:`resource.stub`,collection:`resource.collection.stub`},e.stubs||{})});var h=class{command;config={};constructor(e={}){this.config=m(e);let t=c(import.meta.url),i=[n(process.cwd(),`resora.config.ts`),n(process.cwd(),`resora.config.js`),n(process.cwd(),`resora.config.cjs`)];for(let e of i)if(r(e))try{let{default:n}=t(e);Object.assign(this.config,m(n));break}catch(t){console.error(`Error loading config file at ${e}:`,t)}}ensureDirectory(e){let n=t(e);r(n)||i(n,{recursive:!0})}generateFile(e,t,n,i){r(t)&&!i?.force?(this.command.error(`Error: ${t} already exists.`),process.exit(1)):r(t)&&i?.force&&o(t);let c=a(e,`utf-8`);for(let[e,t]of Object.entries(n))c=c.replace(RegExp(`{{${e}}}`,`g`),t);return this.ensureDirectory(t),s(t,c),t}makeResource(e,t){let i=e;t?.collection&&!e.endsWith(`Collection`)&&!e.endsWith(`Resource`)?i+=`Collection`:!t?.collection&&!e.endsWith(`Resource`)&&!e.endsWith(`Collection`)&&(i+=`Resource`);let a=`${i}.ts`,o=n(this.config.resourcesDir,a),s=n(this.config.stubsDir,t?.collection||e.endsWith(`Collection`)?this.config.stubs.collection:this.config.stubs.resource);r(s)||(this.command.error(`Error: Stub file ${s} not found.`),process.exit(1));let c=i.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{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=`/** 
      * The resource that this collection collects.
      */
-    collects = ${c}
-    `,u=`import ${c} from './${c}'\n`,d=(!!t?.collection||e.endsWith(`Collection`))&&r(n(this.config.resourcesDir,`${c}.ts`)),f=this.generateFile(s,o,{ResourceName:i,CollectionResourceName:i.replace(/(Resource|Collection)$/,``)+`Resource`,"collects = Resource":d?l:``,"import = Resource":d?u:``},t);return{name:i,path:f}}},g=class extends u{signature=`#create:
+    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
+        {--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:
         {resource : Generates a new resource file.
             | {name : Name of the resource to create}
             | {--c|collection : Make a resource collection}
@@ -17,11 +19,11 @@ import e,{dirname as t,join as n}from"path";import{existsSync as r,mkdirSync as
             | {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}`)}},_=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}`)}},y=String.raw`
   _____                           
  |  __ \                          
  | |__) |___  ___  ___  _ __ __ _ 
  |  _  // _ \/ __|/ _ \| '__/ _, |
  | | \ \  __/\__ \ (_) | | | (_| |
  |_|  \_\___||___/\___/|_|  \__,_|                                                                                           
-`;const v=new h;await d.init(v,{logo:_,name:`Resora CLI`,baseCommands:[g],exceptionHandler(e){throw e}});export{};
+`;const b=new g;await f.init(b,{logo:y,name:`Resora CLI`,baseCommands:[v,_],exceptionHandler(e){throw e}});export{};

package/dist/index.cjs

@@ -26,9 +26,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 }) : target, mod));
 
 //#endregion
+let fs = require("fs");
 let path = require("path");
 path = __toESM(path);
-let fs = require("fs");
 let module$1 = require("module");
 let url = require("url");
 let _h3ravel_musket = require("@h3ravel/musket");
@@ -60,17 +60,19 @@ const defineConfig = (userConfig = {}) => {
 		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 || {}) });
 };
 
 //#endregion
-//#region src/cli/actions.ts
+//#region src/cli/CliApp.ts
 var CliApp = class {
 	command;
 	config = {};
@@ -91,6 +93,23 @@ var CliApp = class {
 		}
 	}
 	/**
+	* Initialize Resora by creating a default config file in the current directory
+	* 
+	* @returns 
+	*/
+	init() {
+		const outputPath = (0, path.join)(process.cwd(), "resora.config.js");
+		const stubPath = (0, path.join)(this.config.stubsDir, this.config.stubs.config);
+		if ((0, fs.existsSync)(outputPath) && !this.command.option("force")) {
+			this.command.error(`Error: ${outputPath} already exists.`);
+			process.exit(1);
+		}
+		this.ensureDirectory(outputPath);
+		if ((0, fs.existsSync)(outputPath) && this.command.option("force")) (0, fs.copyFileSync)(outputPath, outputPath.replace(/\.js$/, `.backup.${Date.now()}.js`));
+		(0, fs.writeFileSync)(outputPath, (0, fs.readFileSync)(stubPath, "utf-8"));
+		return { path: outputPath };
+	}
+	/**
 	* Utility to ensure directory exists
 	*
 	* @param filePath

package/dist/index.d.cts

@@ -165,17 +165,21 @@ 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;
   /**
    * @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.
      */
@@ -185,13 +189,54 @@ 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/actions.d.ts
+//#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
+   *
+   * @returns
+   */
+  init(): {
+    path: string;
+  };
   /**
    * Utility to ensure directory exists
    *

package/dist/index.d.mts

@@ -165,17 +165,21 @@ 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;
   /**
    * @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.
      */
@@ -185,13 +189,54 @@ 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/actions.d.ts
+//#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
+   *
+   * @returns
+   */
+  init(): {
+    path: string;
+  };
   /**
    * Utility to ensure directory exists
    *

package/dist/index.mjs

@@ -1,5 +1,5 @@
+import { copyFileSync, existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "fs";
 import path, { dirname, join } from "path";
-import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "fs";
 import { createRequire } from "module";
 import { fileURLToPath } from "url";
 import { Command } from "@h3ravel/musket";
@@ -31,17 +31,19 @@ const defineConfig = (userConfig = {}) => {
 		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 || {}) });
 };
 
 //#endregion
-//#region src/cli/actions.ts
+//#region src/cli/CliApp.ts
 var CliApp = class {
 	command;
 	config = {};
@@ -62,6 +64,23 @@ var CliApp = class {
 		}
 	}
 	/**
+	* Initialize Resora by creating a default config file in the current directory
+	* 
+	* @returns 
+	*/
+	init() {
+		const outputPath = join(process.cwd(), "resora.config.js");
+		const stubPath = join(this.config.stubsDir, this.config.stubs.config);
+		if (existsSync(outputPath) && !this.command.option("force")) {
+			this.command.error(`Error: ${outputPath} already exists.`);
+			process.exit(1);
+		}
+		this.ensureDirectory(outputPath);
+		if (existsSync(outputPath) && this.command.option("force")) copyFileSync(outputPath, outputPath.replace(/\.js$/, `.backup.${Date.now()}.js`));
+		writeFileSync(outputPath, readFileSync(stubPath, "utf-8"));
+		return { path: outputPath };
+	}
+	/**
 	* Utility to ensure directory exists
 	*
 	* @param filePath

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resora",
-  "version": "0.1.5",
+  "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",

package/stubs/resora.config.stub

@@ -0,0 +1,5 @@
+import { defineConfig } from 'resora'
+
+export default defineConfig({
+  resourcesDir: 'src/resources',
+})