resora 0.2.8 → 0.2.9

package/README.md

@@ -52,7 +52,7 @@ import { Resource } from 'resora';
 
 class UserResource extends Resource {
   data() {
-    return this.toArray();
+    return this.toObject();
   }
 }
 ```
@@ -88,7 +88,7 @@ class UserCollection<R extends User[]> extends ResourceCollection<R> {
   collects = UserResource;
 
   data() {
-    return this.toArray();
+    return this.toObject();
   }
 }
 ```

package/dist/index.cjs

@@ -22,4 +22,4 @@ Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=Object.
  |  _  // _ \/ __|/ _ \| '__/ _, |
  | | \ \  __/\__ \ (_) | | | (_| |
  |_|  \_\___||___/\___/|_|  \__,_|                                                                                           
-`;var Q=class{_status=200;headers={};constructor(e,t){this.response=e,this.body=t}setStatusCode(e){return this._status=e,`status`in this.response&&typeof this.response.status==`function`?this.response.status(e):`status`in this.response&&(this.response.status=e),this}status(){return this._status}statusText(){if(`statusMessage`in this.response)return this.response.statusMessage;if(`statusText`in this.response)return this.response.statusText}setCookie(e,t,n){return this.#e(`Set-Cookie`,`${e}=${t}; ${Object.entries(n||{}).map(([e,t])=>`${e}=${t}`).join(`; `)}`),this}setHeaders(e){for(let[t,n]of Object.entries(e))this.#e(t,n);return this}header(e,t){return this.#e(e,t),this}#e(e,t){this.headers[e]=t,`headers`in this.response?this.response.headers.set(e,t):`setHeader`in this.response&&this.response.setHeader(e,t)}then(e,t){let n=Promise.resolve(this.body).then(e,t);return`send`in this.response&&this.response.send(this.body),n}catch(e){return this.then(void 0,e)}finally(e){return this.then(e,e)}},$=class{static preferredCase;static responseStructure;static config;instanceConfig;additionalMeta;called={};when(e,t){return V(e,t)}whenNotNull(e){return H(e)}mergeWhen(e,t){return U(e,t)}with(e){if(this.called.with=!0,e===void 0)return this.additionalMeta||{};let t=typeof e==`function`?e(this.getResourceForMeta()):e;return this.additionalMeta=j(this.additionalMeta,t),this.called.json&&this.applyMetaToBody(t,this.resolveCurrentRootKey()),this}withMeta(e){return this.with(e),this}resolveMergedMeta(e){return j(z(this,e),this.additionalMeta)}runResponse(e){this.called.toResponse=!0,e.ensureJson();let t=e.body(),n=e.createServerResponse(e.rawResponse,t);return this.called.withResponse=!0,e.callWithResponse(n,e.rawResponse),n}runThen(e){this.called.then=!0,e.ensureJson();let t=e.body();if(e.rawResponse!==void 0){let n=e.createServerResponse(e.rawResponse,t);this.called.withResponse=!0,e.callWithResponse(n,e.rawResponse)}else this.called.withResponse=!0,e.callWithResponse();let n=e.body(),r=Promise.resolve(n).then(e.onfulfilled,e.onrejected);return e.rawResponse!==void 0&&e.sendRawResponse&&e.sendRawResponse(e.rawResponse,n),r}config(e){return e===void 0?this.instanceConfig||{}:(this.instanceConfig={...this.instanceConfig||{},...e,responseStructure:{...this.instanceConfig?.responseStructure||{},...e.responseStructure||{}}},this)}resolveSerializerConfig(e,t){let n=typeof e.config==`function`?e.config():{};return{preferredCase:this.instanceConfig?.preferredCase??n?.preferredCase,responseStructure:{...n?.responseStructure||{},...this.instanceConfig?.responseStructure||{}}}}resolveSerializerCaseStyle(e,t){return this.resolveSerializerConfig(e,t).preferredCase??e.preferredCase??t?.preferredCase??S()}resolveSerializerResponseStructure(e,t){let n=this.resolveSerializerConfig(e,t),r=w();return{wrap:n.responseStructure?.wrap??e.responseStructure?.wrap??t?.responseStructure?.wrap??r?.wrap??!0,rootKey:n.responseStructure?.rootKey??e.responseStructure?.rootKey??t?.responseStructure?.rootKey??r?.rootKey??`data`,factory:n.responseStructure?.factory??e.responseStructure?.factory??t?.responseStructure?.factory??r?.factory}}},ke=class e extends ${body={data:{}};resource;collects;withResponseContext;constructor(e,t){super(),this.res=t,this.resource=e;let n=!!this.resource&&typeof this.resource==`object`&&`data`in this.resource,r=n?this.resource.data:void 0,i=!!r&&!Array.isArray(r),a=n?r:this.resource;if(a&&typeof a==`object`&&!Array.isArray(a)&&!N(a)){let e=M(a)?Object.keys(a.toObject()):Object.keys(a);for(let t of e)t in this||Object.defineProperty(this,t,{enumerable:!0,configurable:!0,get:()=>M(a)&&typeof a.getAttribute==`function`?a.getAttribute(t):i?r[t]:this.resource[t],set:e=>{if(M(a)&&typeof a.setAttribute==`function`){a.setAttribute(t,e);return}if(i){r[t]=e;return}this.resource[t]=e}})}}data(){return this.resource}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveCollectsConfig(){let e=this.collects;if(!e)return;let t=typeof e.config==`function`?e.config():{};return{preferredCase:t.preferredCase??e.preferredCase,responseStructure:{...e.responseStructure||{},...t.responseStructure||{}}}}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor,this.resolveCollectsConfig())}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=A(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=P(this.data());Array.isArray(t)&&this.collects&&(t=t.map(e=>new this.collects(e).data())),!Array.isArray(t)&&t&&t.data!==void 0&&(t=t.data),t=W(t);let n=L(this.resource),{metaKey:r}=F(),i=r?n[r]:void 0;r&&delete n[r];let a=this.resolveSerializerCaseStyle(this.constructor,this.resolveCollectsConfig());if(a){let e=K(a);t=q(t,e)}let o=this.resolveMergedMeta(e.prototype.with),{wrap:s,rootKey:c,factory:l}=this.resolveResponseStructure();this.body=R({payload:t,meta:i,metaKey:r,wrap:s,rootKey:c,factory:l,context:{type:`generic`,resource:this.resource}}),this.body=A(this.body,{...n,...o||{}},c)}return this}toArray(){this.called.toArray=!0,this.json();let e=P(this.resource);return!Array.isArray(e)&&e&&e.data!==void 0&&(e=e.data),e}additional(e){this.called.additional=!0,this.json();let t=e.data;delete e.data,delete e.pagination;let n=this.getPayloadKey();return t&&n&&this.body[n]!==void 0&&(this.body[n]=Array.isArray(this.body[n])?[...this.body[n],...t]:{...this.body[n],...t}),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}},Ae=class e extends ${body={data:[]};resource;collects;withResponseContext;isPaginatedCollectible(e){if(!e||typeof e!=`object`)return!1;let t=e;return t.pagination&&Array.isArray(t.data)?!0:t.meta&&typeof t.meta==`object`&&`currentPage`in t.meta?Array.isArray(t.data)||N(t.data):!1}constructor(e,t){super(),this.res=t,this.resource=e}data(){return this.toArray()}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveCollectsConfig(){let e=this.collects;if(!e)return;let t=typeof e.config==`function`?e.config():{};return{preferredCase:t.preferredCase??e.preferredCase,responseStructure:{...e.responseStructure||{},...t.responseStructure||{}}}}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor,this.resolveCollectsConfig())}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=A(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=this.data();this.collects&&(t=t.map(e=>new this.collects(e).data())),t=P(t),t=W(t);let n=Array.isArray(this.resource)?{}:L(this.resource),{metaKey:r}=F(),i=r?n[r]:void 0;r&&delete n[r];let a=this.resolveSerializerCaseStyle(this.constructor,this.resolveCollectsConfig());if(a){let e=K(a);t=q(t,e)}let o=this.resolveMergedMeta(e.prototype.with),{wrap:s,rootKey:c,factory:l}=this.resolveResponseStructure();this.body=R({payload:t,meta:i,metaKey:r,wrap:s,rootKey:c,factory:l,context:{type:`collection`,resource:this.resource}}),this.body=A(this.body,{...n,...o||{}},c)}return this}toArray(){return this.called.toArray=!0,this.json(),P(Array.isArray(this.resource)?this.resource:N(this.resource)?this.resource.all():this.resource.data)}additional(e){this.called.additional=!0,this.json(),delete e.cursor,delete e.pagination;let t=this.getPayloadKey();return e.data&&t&&Array.isArray(this.body[t])&&(this.body[t]=[...this.body[t],...e.data]),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}setCollects(e){return this.collects=e,this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}},je=class e extends ${body={data:{}};resource;withResponseContext;constructor(e,t){super(),this.res=t,this.resource=e;let n=this.resource.data??this.resource;if(!Array.isArray(n)){let e=M(n)?Object.keys(n.toObject()):Object.keys(n);for(let t of e)t in this||Object.defineProperty(this,t,{enumerable:!0,configurable:!0,get:()=>M(n)&&typeof n.getAttribute==`function`?n.getAttribute(t):this.resource.data?.[t]??this.resource[t],set:e=>{if(M(n)&&typeof n.setAttribute==`function`){n.setAttribute(t,e);return}this.resource.data&&this.resource.data[t]?this.resource.data[t]=e:this.resource[t]=e}})}}static collection(e){return new Ae(e).setCollects(this)}data(){return this.toArray()}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor)}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=A(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=P(this.data());!Array.isArray(t)&&t&&t.data!==void 0&&(t=t.data),t=W(t);let n=this.resolveSerializerCaseStyle(this.constructor);if(n){let e=K(n);t=q(t,e)}let r=this.resolveMergedMeta(e.prototype.with),{wrap:i,rootKey:a,factory:o}=this.resolveResponseStructure();this.body=R({payload:t,wrap:i,rootKey:a,factory:o,context:{type:`resource`,resource:this.resource}}),this.body=A(this.body,r,a)}return this}toArray(){this.called.toArray=!0,this.json();let e=P(this.resource);return!Array.isArray(e)&&e&&e.data!==void 0&&(e=e.data),e}additional(e){this.called.additional=!0,this.json();let t=this.getPayloadKey();return e.data&&t&&this.body[t]!==void 0&&(this.body[t]=Array.isArray(this.body[t])?[...this.body[t],...e.data]:{...this.body[t],...e.data}),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}};exports.ApiResource=ee,exports.CONDITIONAL_ATTRIBUTE_MISSING=B,exports.CliApp=Ee,exports.GenericResource=ke,exports.InitCommand=De,exports.MakeResource=Oe,exports.Resource=je,exports.ResourceCollection=Ae,exports.ServerResponse=Q,exports.appendRootProperties=A,exports.applyRuntimeConfig=xe,exports.buildPaginationExtras=L,exports.buildResponseEnvelope=R,exports.defineConfig=Y,exports.getCaseTransformer=K,exports.getDefaultConfig=ye,exports.getGlobalBaseUrl=fe,exports.getGlobalCase=S,exports.getGlobalCursorMeta=O,exports.getGlobalPageName=me,exports.getGlobalPaginatedExtras=ce,exports.getGlobalPaginatedLinks=ue,exports.getGlobalPaginatedMeta=E,exports.getGlobalResponseFactory=oe,exports.getGlobalResponseRootKey=ie,exports.getGlobalResponseStructure=w,exports.getGlobalResponseWrap=re,exports.getPaginationExtraKeys=F,exports.isArkormLikeCollection=N,exports.isArkormLikeModel=M,exports.isPlainObject=k,exports.loadRuntimeConfig=Te,exports.mergeMetadata=j,exports.normalizeSerializableData=P,exports.resetRuntimeConfigForTests=be,exports.resolveMergeWhen=U,exports.resolveWhen=V,exports.resolveWhenNotNull=H,exports.resolveWithHookMetadata=z,exports.sanitizeConditionalAttributes=W,exports.setGlobalBaseUrl=de,exports.setGlobalCase=x,exports.setGlobalCursorMeta=D,exports.setGlobalPageName=pe,exports.setGlobalPaginatedExtras=se,exports.setGlobalPaginatedLinks=le,exports.setGlobalPaginatedMeta=T,exports.setGlobalResponseFactory=ae,exports.setGlobalResponseRootKey=te,exports.setGlobalResponseStructure=C,exports.setGlobalResponseWrap=ne,exports.splitWords=G,exports.toCamelCase=he,exports.toKebabCase=ve,exports.toPascalCase=_e,exports.toSnakeCase=ge,exports.transformKeys=q;
+`;var Q=class{_status=200;headers={};constructor(e,t){this.response=e,this.body=t}setStatusCode(e){return this._status=e,`status`in this.response&&typeof this.response.status==`function`?this.response.status(e):`status`in this.response&&(this.response.status=e),this}status(){return this._status}statusText(){if(`statusMessage`in this.response)return this.response.statusMessage;if(`statusText`in this.response)return this.response.statusText}setCookie(e,t,n){return this.#e(`Set-Cookie`,`${e}=${t}; ${Object.entries(n||{}).map(([e,t])=>`${e}=${t}`).join(`; `)}`),this}setHeaders(e){for(let[t,n]of Object.entries(e))this.#e(t,n);return this}header(e,t){return this.#e(e,t),this}#e(e,t){this.headers[e]=t,`headers`in this.response?this.response.headers.set(e,t):`setHeader`in this.response&&this.response.setHeader(e,t)}then(e,t){let n=Promise.resolve(this.body).then(e,t);return`send`in this.response&&this.response.send(this.body),n}catch(e){return this.then(void 0,e)}finally(e){return this.then(e,e)}},$=class{static preferredCase;static responseStructure;static config;instanceConfig;additionalMeta;called={};when(e,t){return V(e,t)}whenNotNull(e){return H(e)}mergeWhen(e,t){return U(e,t)}with(e){if(this.called.with=!0,e===void 0)return this.additionalMeta||{};let t=typeof e==`function`?e(this.getResourceForMeta()):e;return this.additionalMeta=j(this.additionalMeta,t),this.called.json&&this.applyMetaToBody(t,this.resolveCurrentRootKey()),this}withMeta(e){return this.with(e),this}resolveMergedMeta(e){return j(z(this,e),this.additionalMeta)}runResponse(e){this.called.toResponse=!0,e.ensureJson();let t=e.body(),n=e.createServerResponse(e.rawResponse,t);return this.called.withResponse=!0,e.callWithResponse(n,e.rawResponse),n}runThen(e){this.called.then=!0,e.ensureJson();let t=e.body();if(e.rawResponse!==void 0){let n=e.createServerResponse(e.rawResponse,t);this.called.withResponse=!0,e.callWithResponse(n,e.rawResponse)}else this.called.withResponse=!0,e.callWithResponse();let n=e.body(),r=Promise.resolve(n).then(e.onfulfilled,e.onrejected);return e.rawResponse!==void 0&&e.sendRawResponse&&e.sendRawResponse(e.rawResponse,n),r}config(e){return e===void 0?this.instanceConfig||{}:(this.instanceConfig={...this.instanceConfig||{},...e,responseStructure:{...this.instanceConfig?.responseStructure||{},...e.responseStructure||{}}},this)}resolveSerializerConfig(e,t){let n=typeof e.config==`function`?e.config():{};return{preferredCase:this.instanceConfig?.preferredCase??n?.preferredCase,responseStructure:{...n?.responseStructure||{},...this.instanceConfig?.responseStructure||{}}}}resolveSerializerCaseStyle(e,t){return this.resolveSerializerConfig(e,t).preferredCase??e.preferredCase??t?.preferredCase??S()}resolveSerializerResponseStructure(e,t){let n=this.resolveSerializerConfig(e,t),r=w();return{wrap:n.responseStructure?.wrap??e.responseStructure?.wrap??t?.responseStructure?.wrap??r?.wrap??!0,rootKey:n.responseStructure?.rootKey??e.responseStructure?.rootKey??t?.responseStructure?.rootKey??r?.rootKey??`data`,factory:n.responseStructure?.factory??e.responseStructure?.factory??t?.responseStructure?.factory??r?.factory}}},ke=class e extends ${body={data:{}};resource;collects;withResponseContext;constructor(e,t){super(),this.res=t,this.resource=e;let n=!!this.resource&&typeof this.resource==`object`&&`data`in this.resource,r=n?this.resource.data:void 0,i=!!r&&!Array.isArray(r),a=n?r:this.resource;if(a&&typeof a==`object`&&!Array.isArray(a)&&!N(a)){let e=M(a)?Object.keys(a.toObject()):Object.keys(a);for(let t of e)t in this||Object.defineProperty(this,t,{enumerable:!0,configurable:!0,get:()=>M(a)&&typeof a.getAttribute==`function`?a.getAttribute(t):i?r[t]:this.resource[t],set:e=>{if(M(a)&&typeof a.setAttribute==`function`){a.setAttribute(t,e);return}if(i){r[t]=e;return}this.resource[t]=e}})}}data(){return this.resource}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveCollectsConfig(){let e=this.collects;if(!e)return;let t=typeof e.config==`function`?e.config():{};return{preferredCase:t.preferredCase??e.preferredCase,responseStructure:{...e.responseStructure||{},...t.responseStructure||{}}}}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor,this.resolveCollectsConfig())}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=A(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=P(this.data());Array.isArray(t)&&this.collects&&(t=t.map(e=>new this.collects(e).data())),!Array.isArray(t)&&t&&t.data!==void 0&&(t=t.data),t=W(t);let n=L(this.resource),{metaKey:r}=F(),i=r?n[r]:void 0;r&&delete n[r];let a=this.resolveSerializerCaseStyle(this.constructor,this.resolveCollectsConfig());if(a){let e=K(a);t=q(t,e)}let o=this.resolveMergedMeta(e.prototype.with),{wrap:s,rootKey:c,factory:l}=this.resolveResponseStructure();this.body=R({payload:t,meta:i,metaKey:r,wrap:s,rootKey:c,factory:l,context:{type:`generic`,resource:this.resource}}),this.body=A(this.body,{...n,...o||{}},c)}return this}toObject(){this.called.toObject=!0,this.json();let e=P(this.resource);return!Array.isArray(e)&&e&&e.data!==void 0&&(e=e.data),e}toArray(){return this.called.toArray=!0,this.toObject()}additional(e){this.called.additional=!0,this.json();let t=e.data;delete e.data,delete e.pagination;let n=this.getPayloadKey();return t&&n&&this.body[n]!==void 0&&(this.body[n]=Array.isArray(this.body[n])?[...this.body[n],...t]:{...this.body[n],...t}),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}},Ae=class e extends ${body={data:[]};resource;collects;withResponseContext;isPaginatedCollectible(e){if(!e||typeof e!=`object`)return!1;let t=e;return t.pagination&&Array.isArray(t.data)?!0:t.meta&&typeof t.meta==`object`&&`currentPage`in t.meta?Array.isArray(t.data)||N(t.data):!1}constructor(e,t){super(),this.res=t,this.resource=e}data(){return this.toObject()}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveCollectsConfig(){let e=this.collects;if(!e)return;let t=typeof e.config==`function`?e.config():{};return{preferredCase:t.preferredCase??e.preferredCase,responseStructure:{...e.responseStructure||{},...t.responseStructure||{}}}}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor,this.resolveCollectsConfig())}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=A(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=this.data();this.collects&&(t=t.map(e=>new this.collects(e).data())),t=P(t),t=W(t);let n=Array.isArray(this.resource)?{}:L(this.resource),{metaKey:r}=F(),i=r?n[r]:void 0;r&&delete n[r];let a=this.resolveSerializerCaseStyle(this.constructor,this.resolveCollectsConfig());if(a){let e=K(a);t=q(t,e)}let o=this.resolveMergedMeta(e.prototype.with),{wrap:s,rootKey:c,factory:l}=this.resolveResponseStructure();this.body=R({payload:t,meta:i,metaKey:r,wrap:s,rootKey:c,factory:l,context:{type:`collection`,resource:this.resource}}),this.body=A(this.body,{...n,...o||{}},c)}return this}toObject(){return this.called.toObject=!0,this.json(),P(Array.isArray(this.resource)?this.resource:N(this.resource)?this.resource.all():this.resource.data)}toArray(){return this.called.toArray=!0,this.toObject()}additional(e){this.called.additional=!0,this.json(),delete e.cursor,delete e.pagination;let t=this.getPayloadKey();return e.data&&t&&Array.isArray(this.body[t])&&(this.body[t]=[...this.body[t],...e.data]),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}setCollects(e){return this.collects=e,this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}},je=class e extends ${body={data:{}};resource;withResponseContext;constructor(e,t){super(),this.res=t,this.resource=e;let n=this.resource.data??this.resource;if(!Array.isArray(n)){let e=M(n)?Object.keys(n.toObject()):Object.keys(n);for(let t of e)t in this||Object.defineProperty(this,t,{enumerable:!0,configurable:!0,get:()=>M(n)&&typeof n.getAttribute==`function`?n.getAttribute(t):this.resource.data?.[t]??this.resource[t],set:e=>{if(M(n)&&typeof n.setAttribute==`function`){n.setAttribute(t,e);return}this.resource.data&&this.resource.data[t]?this.resource.data[t]=e:this.resource[t]=e}})}}static collection(e){return new Ae(e).setCollects(this)}data(){return this.toObject()}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor)}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=A(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=P(this.data());!Array.isArray(t)&&t&&t.data!==void 0&&(t=t.data),t=W(t);let n=this.resolveSerializerCaseStyle(this.constructor);if(n){let e=K(n);t=q(t,e)}let r=this.resolveMergedMeta(e.prototype.with),{wrap:i,rootKey:a,factory:o}=this.resolveResponseStructure();this.body=R({payload:t,wrap:i,rootKey:a,factory:o,context:{type:`resource`,resource:this.resource}}),this.body=A(this.body,r,a)}return this}toObject(){this.called.toObject=!0,this.json();let e=P(this.resource);return!Array.isArray(e)&&e&&e.data!==void 0&&(e=e.data),e}toArray(){return this.called.toArray=!0,this.toObject()}additional(e){this.called.additional=!0,this.json();let t=this.getPayloadKey();return e.data&&t&&this.body[t]!==void 0&&(this.body[t]=Array.isArray(this.body[t])?[...this.body[t],...e.data]:{...this.body[t],...e.data}),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}};exports.ApiResource=ee,exports.CONDITIONAL_ATTRIBUTE_MISSING=B,exports.CliApp=Ee,exports.GenericResource=ke,exports.InitCommand=De,exports.MakeResource=Oe,exports.Resource=je,exports.ResourceCollection=Ae,exports.ServerResponse=Q,exports.appendRootProperties=A,exports.applyRuntimeConfig=xe,exports.buildPaginationExtras=L,exports.buildResponseEnvelope=R,exports.defineConfig=Y,exports.getCaseTransformer=K,exports.getDefaultConfig=ye,exports.getGlobalBaseUrl=fe,exports.getGlobalCase=S,exports.getGlobalCursorMeta=O,exports.getGlobalPageName=me,exports.getGlobalPaginatedExtras=ce,exports.getGlobalPaginatedLinks=ue,exports.getGlobalPaginatedMeta=E,exports.getGlobalResponseFactory=oe,exports.getGlobalResponseRootKey=ie,exports.getGlobalResponseStructure=w,exports.getGlobalResponseWrap=re,exports.getPaginationExtraKeys=F,exports.isArkormLikeCollection=N,exports.isArkormLikeModel=M,exports.isPlainObject=k,exports.loadRuntimeConfig=Te,exports.mergeMetadata=j,exports.normalizeSerializableData=P,exports.resetRuntimeConfigForTests=be,exports.resolveMergeWhen=U,exports.resolveWhen=V,exports.resolveWhenNotNull=H,exports.resolveWithHookMetadata=z,exports.sanitizeConditionalAttributes=W,exports.setGlobalBaseUrl=de,exports.setGlobalCase=x,exports.setGlobalCursorMeta=D,exports.setGlobalPageName=pe,exports.setGlobalPaginatedExtras=se,exports.setGlobalPaginatedLinks=le,exports.setGlobalPaginatedMeta=T,exports.setGlobalResponseFactory=ae,exports.setGlobalResponseRootKey=te,exports.setGlobalResponseStructure=C,exports.setGlobalResponseWrap=ne,exports.splitWords=G,exports.toCamelCase=he,exports.toKebabCase=ve,exports.toPascalCase=_e,exports.toSnakeCase=ge,exports.transformKeys=q;

package/dist/index.d.cts

@@ -81,10 +81,6 @@ interface Cursor {
 }
 //#endregion
 //#region src/types/resource.d.ts
-interface ResourceLevelConfig {
-  preferredCase?: CaseStyle | undefined;
-  responseStructure?: ResponseStructureConfig | undefined;
-}
 interface MetaData {
   [key: string]: any;
 }
@@ -242,6 +238,27 @@ interface Config {
    */
   extraCommands?: typeof Command<any>[];
 }
+/**
+ * @description A type that represents the configuration options that can be set at the resource level, allowing for customization of case style, response structure, and additional data included in paginated responses on a per-resource basis.
+ */
+interface ResourceLevelConfig {
+  /**
+   * @description The preferred case style for resource keys in the response.
+   * Can be set to a preset string ('camel', 'snake', 'pascal', 'kebab') or a custom transformer function.
+   * @default 'camel'
+   */
+  preferredCase?: CaseStyle | undefined;
+  /**
+   * @description An object specifying the structure of the response body for resources. It includes a rootKey property that defines the key under which the resource data will be nested in the response. The rootKey is a string that represents the name of this key in the response body.
+   */
+  responseStructure?: ResponseStructureConfig | undefined;
+  /**
+   * @description An array or object specifying which additional data to include in paginated responses.
+   * Can include 'meta', 'links', and/or 'cursor'. If an object is provided, the keys can be customized to specify the property names for each type of extra data in the response.
+   * @default ['meta', 'links']
+   */
+  paginatedExtras?: Config['paginatedExtras'] | undefined;
+}
 interface ResoraConfig extends Partial<Omit<Config, 'stubs' | 'cursorMeta' | 'paginatedMeta' | 'paginatedLinks' | 'responseStructure'>> {
   /**
    * @description The file names of the various stub templates used for generating resources and configuration.
@@ -341,6 +358,13 @@ declare class MakeResource extends Command<CliApp> {
 }
 //#endregion
 //#region src/ServerResponse.d.ts
+/**
+ * ServerResponse class to handle HTTP response construction and sending, compatible
+ * with both Express and H3 response objects.
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.1.0
+ */
 declare class ServerResponse<R extends NonCollectible | Collectible | ResourceData[] | ResourceData = any> {
   #private;
   private response;
@@ -422,6 +446,16 @@ interface SerializerConstructor {
   responseStructure?: ResponseStructureConfig;
   config?: () => ResourceLevelConfig;
 }
+/**
+ * @description BaseSerializer is an abstract class that provides common functionality for
+ * serializing resources. It handles configuration, metadata management, and response
+ * structure resolution. Concrete serializers should extend this class and implement
+ * the abstract methods to define how resources are transformed and how metadata is
+ * applied to the response body.
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.2.8
+ */
 declare abstract class BaseSerializer<TResource = any> {
   static preferredCase?: CaseStyle;
   static responseStructure?: ResponseStructureConfig;
@@ -431,6 +465,7 @@ declare abstract class BaseSerializer<TResource = any> {
   protected called: {
     json?: boolean;
     data?: boolean;
+    toObject?: boolean;
     toArray?: boolean;
     additional?: boolean;
     with?: boolean;
@@ -439,15 +474,63 @@ declare abstract class BaseSerializer<TResource = any> {
     then?: boolean;
     toResponse?: boolean;
   };
+  /**
+   * Helper method to conditionally resolve a value based on a condition.
+   *
+   * @param condition
+   * @param value
+   * @returns
+   */
   when<T>(condition: any, value: T | (() => T)): T | undefined;
+  /**
+   * Helper method to conditionally resolve a value only if it's not null or undefined.
+   *
+   * @param value
+   * @returns
+   */
   whenNotNull<T>(value: T | null | undefined): T | undefined;
+  /**
+   * Helper method to conditionally merge values into the response based on a condition.
+   *
+   * @param condition
+   * @param value
+   * @returns
+   */
   mergeWhen<T extends Record<string, any>>(condition: any, value: T | (() => T)): Partial<T>;
+  /**
+   * Resolve the current root key for the response structure.
+   */
   protected abstract resolveCurrentRootKey(): string;
   protected abstract applyMetaToBody(meta: MetaData, rootKey: string): void;
   protected abstract getResourceForMeta(): TResource;
+  /**
+   * Add additional metadata to the response. If called without arguments.
+   *
+   * @param meta
+   * @returns
+   */
   with(meta?: any): any;
+  /**
+   * Add additional metadata to the response, ensuring it is merged with any existing metadata.
+   *
+   * @param meta
+   * @returns
+   */
   withMeta<M extends MetaData>(meta: M | ((resource: TResource) => M)): this;
+  /**
+   * Resolve the merged metadata for the current response, combining any metadata
+   * defined in hooks with additional metadata added via with() or withMeta().
+   *
+   * @param withMethod
+   * @returns
+   */
   protected resolveMergedMeta(withMethod: (meta?: any) => any): Record<string, any> | undefined;
+  /**
+   * Run the response generation process, ensuring that the response is properly structured.
+   *
+   * @param input
+   * @returns
+   */
   protected runResponse<TBody, TRawResponse, TServerResponse>(input: {
     ensureJson: () => void;
     rawResponse: TRawResponse;
@@ -455,6 +538,13 @@ declare abstract class BaseSerializer<TResource = any> {
     createServerResponse: (raw: TRawResponse, body: TBody) => TServerResponse;
     callWithResponse: (response: TServerResponse, raw: TRawResponse) => void;
   }): TServerResponse;
+  /**
+   * Run the thenable process for the resource, allowing for async handling and
+   * response generation.
+   *
+   * @param input
+   * @returns
+   */
   protected runThen<TBody, TRawResponse, TServerResponse, TResult1, TResult2>(input: {
     ensureJson: () => void;
     body: () => TBody;
@@ -465,8 +555,24 @@ declare abstract class BaseSerializer<TResource = any> {
     onfulfilled?: ((value: TBody) => TResult1 | PromiseLike<TResult1>) | null;
     onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null;
   }): Promise<TResult1 | TResult2>;
+  /**
+   * Get or set the resource-level configuration for this serializer instance.
+   */
   config(): ResourceLevelConfig;
+  /**
+   * Set the resource-level configuration for this serializer instance.
+   *
+   * @param config The configuration object to set for this serializer instance.
+   */
   config(config: ResourceLevelConfig): this;
+  /**
+   * Resolve the effective serializer configuration for this instance, combining
+   * class-level and instance-level configurations.
+   *
+   * @param localConstructor
+   * @param _fallbackConfig
+   * @returns
+   */
   protected resolveSerializerConfig(localConstructor: SerializerConstructor, _fallbackConfig?: ResourceLevelConfig): {
     preferredCase: CaseStyle | undefined;
     responseStructure: {
@@ -475,7 +581,22 @@ declare abstract class BaseSerializer<TResource = any> {
       factory?: ResponseFactory | undefined;
     };
   };
+  /**
+   * Resolve the preferred case style for this serializer instance, considering
+   * instance-level configuration, class-level configuration, and global defaults.
+   *
+   * @param localConstructor The constructor of the serializer class.
+   * @param fallbackConfig    The fallback configuration to use if no other configuration is found.
+   * @returns The resolved    case style for this serializer instance.
+   */
   protected resolveSerializerCaseStyle(localConstructor: SerializerConstructor, fallbackConfig?: ResourceLevelConfig): CaseStyle | undefined;
+  /**
+   * Resolve the response structure configuration for this serializer instance, considering
+   *
+   * @param localConstructor
+   * @param fallbackConfig
+   * @returns
+   */
   protected resolveSerializerResponseStructure(localConstructor: SerializerConstructor, fallbackConfig?: ResourceLevelConfig): {
     wrap: boolean;
     rootKey: string;
@@ -485,7 +606,12 @@ declare abstract class BaseSerializer<TResource = any> {
 //#endregion
 //#region src/ResourceCollection.d.ts
 /**
- * ResourceCollection class to handle API resource transformation and response building for collections
+ * ResourceCollection class to handle API resource transformation and response building
+ * for collections
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.1.0
+ * @see BaseSerializer for shared serialization logic and configuration handling
  */
 declare class ResourceCollection<R extends ResourceData[] | Collectible | CollectionLike | PaginatorLike = ResourceData[] | Collectible | CollectionLike | PaginatorLike, T extends ResourceData = any> extends BaseSerializer<R> {
   private res?;
@@ -497,7 +623,13 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible | Collec
     response: ServerResponse<CollectionBody<R>>;
     raw: Response | H3Event['res'];
   };
-  private isPaginatedCollectible;
+  /**
+   * Type guard to determine if the provided value is a Collectible with pagination information.
+   *
+   * @param value The value to check.
+   * @returns     True if the value is a Collectible with pagination information, false otherwise.
+   */
+  isPaginatedCollectible(value: unknown): value is Collectible;
   constructor(rsc: R);
   constructor(rsc: R, res: Response);
   /**
@@ -514,9 +646,33 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible | Collec
   protected setBody(body: CollectionBody<R>): this;
   private resolveCollectsConfig;
   private resolveResponseStructure;
+  /**
+   * Resolve the current root key for the response structure, based on configuration and defaults.
+   *
+   * @returns
+   */
   protected resolveCurrentRootKey(): string;
+  /**
+   * Apply metadata properties to the response body, ensuring they are merged with
+   * any existing properties and respecting the configured root key.
+   *
+   * @param meta
+   * @param rootKey
+   */
   protected applyMetaToBody(meta: MetaData, rootKey: string): void;
+  /**
+   * Get the resource data to be used for generating metadata, allowing for
+   * customization in subclasses.
+   *
+   * @returns
+   */
   protected getResourceForMeta(): R;
+  /**
+   * Get the appropriate key for the response payload based on the current response
+   * structure configuration.
+   *
+   * @returns The key to use for the response payload, or undefined if no key is needed.
+   */
   private getPayloadKey;
   /**
    * Convert resource to JSON response format
@@ -525,10 +681,18 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible | Collec
    */
   json(): this;
   /**
-   * Flatten resource to return original data
+   * Convert resource to object format and return original data.
    *
    * @returns
    */
+  toObject(): (R extends Collectible ? R['data'][number] : R extends PaginatorLike<infer TPaginatorData> ? TPaginatorData : R extends CollectionLike<infer TCollectionData> ? TCollectionData : R extends ResourceData[] ? R[number] : never)[];
+  /**
+   * Convert resource to object format and return original data.
+   *
+   * @deprecated Use toObject() instead.
+   * @alias toArray
+   * @since 0.2.9
+   */
   toArray(): (R extends Collectible ? R['data'][number] : R extends PaginatorLike<infer TPaginatorData> ? TPaginatorData : R extends CollectionLike<infer TCollectionData> ? TCollectionData : R extends ResourceData[] ? R[number] : never)[];
   /**
    * Add additional properties to the response body
@@ -573,6 +737,11 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible | Collec
 //#region src/Resource.d.ts
 /**
  * Resource class to handle API resource transformation and response building
+ *
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.1.0
+ * @see BaseSerializer for shared serialization logic and configuration handling
  */
 declare class Resource<R extends ResourceData | NonCollectible = ResourceData> extends BaseSerializer<R> {
   private res?;
@@ -604,6 +773,11 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> e
    */
   protected setBody(body: ResourceBody<R>): this;
   private resolveResponseStructure;
+  /**
+   * Resolve the current root key for the response body based on configuration and defaults.
+   *
+   * @returns
+   */
   protected resolveCurrentRootKey(): string;
   protected applyMetaToBody(meta: MetaData, rootKey: string): void;
   protected getResourceForMeta(): R;
@@ -615,10 +789,18 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> e
    */
   json(): this;
   /**
-   * Flatten resource to array format (for collections) or return original data for single resources
+   * Convert resource to object format (for collections) or return original data for single resources.
    *
    * @returns
    */
+  toObject(): R extends NonCollectible ? R['data'] : R;
+  /**
+   * Convert resource to object format and return original data.
+   *
+   * @deprecated Use toObject() instead.
+   * @alias toArray
+   * @since 0.2.9
+   */
   toArray(): R extends NonCollectible ? R['data'] : R;
   /**
    * Add additional properties to the response body
@@ -627,7 +809,14 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> e
    * @returns
    */
   additional<X extends Record<string, any>>(extra: X): this;
+  /**
+   * Build a response object, optionally accepting a raw response to mutate in withResponse.
+   */
   response(): ServerResponse<ResourceBody<R>>;
+  /**
+   * Build a response object, optionally accepting a raw response to mutate in withResponse.
+   * @param res Optional raw response object (e.g. Express Response or H3Event res)
+   */
   response(res: H3Event['res']): ServerResponse<ResourceBody<R>>;
   /**
    * Customize the outgoing transport response right before dispatch.
@@ -662,6 +851,10 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> e
 //#region src/GenericResource.d.ts
 /**
  * GenericResource class to handle API resource transformation and response building
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.1.0
+ * @see BaseSerializer for shared serialization logic and configuration handling
  */
 declare class GenericResource<R extends NonCollectible | Collectible | CollectionLike | PaginatorLike | ResourceData = ResourceData, T extends ResourceData = any> extends BaseSerializer<R> {
   private res?;
@@ -688,8 +881,24 @@ declare class GenericResource<R extends NonCollectible | Collectible | Collectio
   protected setBody(body: GenericBody<R>): this;
   private resolveCollectsConfig;
   private resolveResponseStructure;
+  /**
+   * Resolve the current root key for the response structure, based on configuration and defaults.
+   *
+   * @returns
+   */
   protected resolveCurrentRootKey(): string;
+  /**
+   * Apply metadata properties to the response body, ensuring they are merged with.
+   *
+   * @param meta
+   * @param rootKey
+   */
   protected applyMetaToBody(meta: MetaData, rootKey: string): void;
+  /**
+   * Get the resource data to be used for generating metadata.
+   *
+   * @returns
+   */
   protected getResourceForMeta(): R;
   private getPayloadKey;
   /**
@@ -699,10 +908,18 @@ declare class GenericResource<R extends NonCollectible | Collectible | Collectio
    */
   json(): this;
   /**
-   * Convert resource to array format (for collections)
+   * Convert resource to object format (for collections).
    *
    * @returns
    */
+  toObject(): any;
+  /**
+   * Convert resource to object format and return original data.
+   *
+   * @deprecated Use toObject() instead.
+   * @alias toArray
+   * @since 0.2.9
+   */
   toArray(): any;
   /**
    * Add additional properties to the response body
@@ -711,7 +928,15 @@ declare class GenericResource<R extends NonCollectible | Collectible | Collectio
    * @returns
    */
   additional<X extends Record<string, any>>(extra: X): this;
+  /**
+   * Build a response object, optionally accepting a raw response to write to directly.
+   */
   response(): ServerResponse<GenericBody<R>>;
+  /**
+   * Build a response object, writing to the provided raw response if possible.
+   *
+   * @param res
+   */
   response(res: H3Event['res']): ServerResponse<GenericBody<R>>;
   /**
    * Customize the outgoing transport response right before dispatch.
@@ -832,6 +1057,11 @@ declare const resolveMergeWhen: <T extends Record<string, any>>(condition: any,
 declare const sanitizeConditionalAttributes: (value: any) => any;
 //#endregion
 //#region src/utilities/config.d.ts
+/**
+ * Get the default configuration for the application
+ *
+ * @returns
+ */
 declare const getDefaultConfig: () => Config;
 /**
  * Defines the configuration for the application by merging the provided configuration with the default configuration. This function takes a partial configuration object as input and returns a complete configuration object that includes all required properties, using default values for any properties that are not specified in the input.
@@ -851,8 +1081,29 @@ type ArkormLikeModel = {
 type ArkormLikeCollection = {
   all: () => unknown;
 };
+/**
+ * Type guard to check if a value is an Arkorm-like model, which is defined as an object
+ * that has a toObject method and optionally getRawAttributes, getAttribute, and
+ * setAttribute methods.
+ *
+ * @param value  The value to check
+ * @returns True if the value is an Arkorm-like model, false otherwise
+ */
 declare const isArkormLikeModel: (value: unknown) => value is ArkormLikeModel;
+/**
+ * Type guard to check if a value is an Arkorm-like collection, which is defined as an object
+ *
+ * @param value
+ * @returns
+ */
 declare const isArkormLikeCollection: (value: unknown) => value is ArkormLikeCollection;
+/**
+ * Normalize a value for serialization by recursively converting Arkorm-like models and
+ * collections to plain objects, while preserving the structure of arrays and plain objects.
+ *
+ * @param value The value to normalize
+ * @returns The normalized value, ready for serialization
+ */
 declare const normalizeSerializableData: (value: unknown) => unknown;
 //#endregion
 //#region src/utilities/metadata.d.ts

package/dist/index.d.mts

@@ -81,10 +81,6 @@ interface Cursor {
 }
 //#endregion
 //#region src/types/resource.d.ts
-interface ResourceLevelConfig {
-  preferredCase?: CaseStyle | undefined;
-  responseStructure?: ResponseStructureConfig | undefined;
-}
 interface MetaData {
   [key: string]: any;
 }
@@ -242,6 +238,27 @@ interface Config {
    */
   extraCommands?: typeof Command<any>[];
 }
+/**
+ * @description A type that represents the configuration options that can be set at the resource level, allowing for customization of case style, response structure, and additional data included in paginated responses on a per-resource basis.
+ */
+interface ResourceLevelConfig {
+  /**
+   * @description The preferred case style for resource keys in the response.
+   * Can be set to a preset string ('camel', 'snake', 'pascal', 'kebab') or a custom transformer function.
+   * @default 'camel'
+   */
+  preferredCase?: CaseStyle | undefined;
+  /**
+   * @description An object specifying the structure of the response body for resources. It includes a rootKey property that defines the key under which the resource data will be nested in the response. The rootKey is a string that represents the name of this key in the response body.
+   */
+  responseStructure?: ResponseStructureConfig | undefined;
+  /**
+   * @description An array or object specifying which additional data to include in paginated responses.
+   * Can include 'meta', 'links', and/or 'cursor'. If an object is provided, the keys can be customized to specify the property names for each type of extra data in the response.
+   * @default ['meta', 'links']
+   */
+  paginatedExtras?: Config['paginatedExtras'] | undefined;
+}
 interface ResoraConfig extends Partial<Omit<Config, 'stubs' | 'cursorMeta' | 'paginatedMeta' | 'paginatedLinks' | 'responseStructure'>> {
   /**
    * @description The file names of the various stub templates used for generating resources and configuration.
@@ -341,6 +358,13 @@ declare class MakeResource extends Command<CliApp> {
 }
 //#endregion
 //#region src/ServerResponse.d.ts
+/**
+ * ServerResponse class to handle HTTP response construction and sending, compatible
+ * with both Express and H3 response objects.
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.1.0
+ */
 declare class ServerResponse<R extends NonCollectible | Collectible | ResourceData[] | ResourceData = any> {
   #private;
   private response;
@@ -422,6 +446,16 @@ interface SerializerConstructor {
   responseStructure?: ResponseStructureConfig;
   config?: () => ResourceLevelConfig;
 }
+/**
+ * @description BaseSerializer is an abstract class that provides common functionality for
+ * serializing resources. It handles configuration, metadata management, and response
+ * structure resolution. Concrete serializers should extend this class and implement
+ * the abstract methods to define how resources are transformed and how metadata is
+ * applied to the response body.
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.2.8
+ */
 declare abstract class BaseSerializer<TResource = any> {
   static preferredCase?: CaseStyle;
   static responseStructure?: ResponseStructureConfig;
@@ -431,6 +465,7 @@ declare abstract class BaseSerializer<TResource = any> {
   protected called: {
     json?: boolean;
     data?: boolean;
+    toObject?: boolean;
     toArray?: boolean;
     additional?: boolean;
     with?: boolean;
@@ -439,15 +474,63 @@ declare abstract class BaseSerializer<TResource = any> {
     then?: boolean;
     toResponse?: boolean;
   };
+  /**
+   * Helper method to conditionally resolve a value based on a condition.
+   *
+   * @param condition
+   * @param value
+   * @returns
+   */
   when<T>(condition: any, value: T | (() => T)): T | undefined;
+  /**
+   * Helper method to conditionally resolve a value only if it's not null or undefined.
+   *
+   * @param value
+   * @returns
+   */
   whenNotNull<T>(value: T | null | undefined): T | undefined;
+  /**
+   * Helper method to conditionally merge values into the response based on a condition.
+   *
+   * @param condition
+   * @param value
+   * @returns
+   */
   mergeWhen<T extends Record<string, any>>(condition: any, value: T | (() => T)): Partial<T>;
+  /**
+   * Resolve the current root key for the response structure.
+   */
   protected abstract resolveCurrentRootKey(): string;
   protected abstract applyMetaToBody(meta: MetaData, rootKey: string): void;
   protected abstract getResourceForMeta(): TResource;
+  /**
+   * Add additional metadata to the response. If called without arguments.
+   *
+   * @param meta
+   * @returns
+   */
   with(meta?: any): any;
+  /**
+   * Add additional metadata to the response, ensuring it is merged with any existing metadata.
+   *
+   * @param meta
+   * @returns
+   */
   withMeta<M extends MetaData>(meta: M | ((resource: TResource) => M)): this;
+  /**
+   * Resolve the merged metadata for the current response, combining any metadata
+   * defined in hooks with additional metadata added via with() or withMeta().
+   *
+   * @param withMethod
+   * @returns
+   */
   protected resolveMergedMeta(withMethod: (meta?: any) => any): Record<string, any> | undefined;
+  /**
+   * Run the response generation process, ensuring that the response is properly structured.
+   *
+   * @param input
+   * @returns
+   */
   protected runResponse<TBody, TRawResponse, TServerResponse>(input: {
     ensureJson: () => void;
     rawResponse: TRawResponse;
@@ -455,6 +538,13 @@ declare abstract class BaseSerializer<TResource = any> {
     createServerResponse: (raw: TRawResponse, body: TBody) => TServerResponse;
     callWithResponse: (response: TServerResponse, raw: TRawResponse) => void;
   }): TServerResponse;
+  /**
+   * Run the thenable process for the resource, allowing for async handling and
+   * response generation.
+   *
+   * @param input
+   * @returns
+   */
   protected runThen<TBody, TRawResponse, TServerResponse, TResult1, TResult2>(input: {
     ensureJson: () => void;
     body: () => TBody;
@@ -465,8 +555,24 @@ declare abstract class BaseSerializer<TResource = any> {
     onfulfilled?: ((value: TBody) => TResult1 | PromiseLike<TResult1>) | null;
     onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null;
   }): Promise<TResult1 | TResult2>;
+  /**
+   * Get or set the resource-level configuration for this serializer instance.
+   */
   config(): ResourceLevelConfig;
+  /**
+   * Set the resource-level configuration for this serializer instance.
+   *
+   * @param config The configuration object to set for this serializer instance.
+   */
   config(config: ResourceLevelConfig): this;
+  /**
+   * Resolve the effective serializer configuration for this instance, combining
+   * class-level and instance-level configurations.
+   *
+   * @param localConstructor
+   * @param _fallbackConfig
+   * @returns
+   */
   protected resolveSerializerConfig(localConstructor: SerializerConstructor, _fallbackConfig?: ResourceLevelConfig): {
     preferredCase: CaseStyle | undefined;
     responseStructure: {
@@ -475,7 +581,22 @@ declare abstract class BaseSerializer<TResource = any> {
       factory?: ResponseFactory | undefined;
     };
   };
+  /**
+   * Resolve the preferred case style for this serializer instance, considering
+   * instance-level configuration, class-level configuration, and global defaults.
+   *
+   * @param localConstructor The constructor of the serializer class.
+   * @param fallbackConfig    The fallback configuration to use if no other configuration is found.
+   * @returns The resolved    case style for this serializer instance.
+   */
   protected resolveSerializerCaseStyle(localConstructor: SerializerConstructor, fallbackConfig?: ResourceLevelConfig): CaseStyle | undefined;
+  /**
+   * Resolve the response structure configuration for this serializer instance, considering
+   *
+   * @param localConstructor
+   * @param fallbackConfig
+   * @returns
+   */
   protected resolveSerializerResponseStructure(localConstructor: SerializerConstructor, fallbackConfig?: ResourceLevelConfig): {
     wrap: boolean;
     rootKey: string;
@@ -485,7 +606,12 @@ declare abstract class BaseSerializer<TResource = any> {
 //#endregion
 //#region src/ResourceCollection.d.ts
 /**
- * ResourceCollection class to handle API resource transformation and response building for collections
+ * ResourceCollection class to handle API resource transformation and response building
+ * for collections
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.1.0
+ * @see BaseSerializer for shared serialization logic and configuration handling
  */
 declare class ResourceCollection<R extends ResourceData[] | Collectible | CollectionLike | PaginatorLike = ResourceData[] | Collectible | CollectionLike | PaginatorLike, T extends ResourceData = any> extends BaseSerializer<R> {
   private res?;
@@ -497,7 +623,13 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible | Collec
     response: ServerResponse<CollectionBody<R>>;
     raw: Response | H3Event['res'];
   };
-  private isPaginatedCollectible;
+  /**
+   * Type guard to determine if the provided value is a Collectible with pagination information.
+   *
+   * @param value The value to check.
+   * @returns     True if the value is a Collectible with pagination information, false otherwise.
+   */
+  isPaginatedCollectible(value: unknown): value is Collectible;
   constructor(rsc: R);
   constructor(rsc: R, res: Response);
   /**
@@ -514,9 +646,33 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible | Collec
   protected setBody(body: CollectionBody<R>): this;
   private resolveCollectsConfig;
   private resolveResponseStructure;
+  /**
+   * Resolve the current root key for the response structure, based on configuration and defaults.
+   *
+   * @returns
+   */
   protected resolveCurrentRootKey(): string;
+  /**
+   * Apply metadata properties to the response body, ensuring they are merged with
+   * any existing properties and respecting the configured root key.
+   *
+   * @param meta
+   * @param rootKey
+   */
   protected applyMetaToBody(meta: MetaData, rootKey: string): void;
+  /**
+   * Get the resource data to be used for generating metadata, allowing for
+   * customization in subclasses.
+   *
+   * @returns
+   */
   protected getResourceForMeta(): R;
+  /**
+   * Get the appropriate key for the response payload based on the current response
+   * structure configuration.
+   *
+   * @returns The key to use for the response payload, or undefined if no key is needed.
+   */
   private getPayloadKey;
   /**
    * Convert resource to JSON response format
@@ -525,10 +681,18 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible | Collec
    */
   json(): this;
   /**
-   * Flatten resource to return original data
+   * Convert resource to object format and return original data.
    *
    * @returns
    */
+  toObject(): (R extends Collectible ? R['data'][number] : R extends PaginatorLike<infer TPaginatorData> ? TPaginatorData : R extends CollectionLike<infer TCollectionData> ? TCollectionData : R extends ResourceData[] ? R[number] : never)[];
+  /**
+   * Convert resource to object format and return original data.
+   *
+   * @deprecated Use toObject() instead.
+   * @alias toArray
+   * @since 0.2.9
+   */
   toArray(): (R extends Collectible ? R['data'][number] : R extends PaginatorLike<infer TPaginatorData> ? TPaginatorData : R extends CollectionLike<infer TCollectionData> ? TCollectionData : R extends ResourceData[] ? R[number] : never)[];
   /**
    * Add additional properties to the response body
@@ -573,6 +737,11 @@ declare class ResourceCollection<R extends ResourceData[] | Collectible | Collec
 //#region src/Resource.d.ts
 /**
  * Resource class to handle API resource transformation and response building
+ *
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.1.0
+ * @see BaseSerializer for shared serialization logic and configuration handling
  */
 declare class Resource<R extends ResourceData | NonCollectible = ResourceData> extends BaseSerializer<R> {
   private res?;
@@ -604,6 +773,11 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> e
    */
   protected setBody(body: ResourceBody<R>): this;
   private resolveResponseStructure;
+  /**
+   * Resolve the current root key for the response body based on configuration and defaults.
+   *
+   * @returns
+   */
   protected resolveCurrentRootKey(): string;
   protected applyMetaToBody(meta: MetaData, rootKey: string): void;
   protected getResourceForMeta(): R;
@@ -615,10 +789,18 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> e
    */
   json(): this;
   /**
-   * Flatten resource to array format (for collections) or return original data for single resources
+   * Convert resource to object format (for collections) or return original data for single resources.
    *
    * @returns
    */
+  toObject(): R extends NonCollectible ? R['data'] : R;
+  /**
+   * Convert resource to object format and return original data.
+   *
+   * @deprecated Use toObject() instead.
+   * @alias toArray
+   * @since 0.2.9
+   */
   toArray(): R extends NonCollectible ? R['data'] : R;
   /**
    * Add additional properties to the response body
@@ -627,7 +809,14 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> e
    * @returns
    */
   additional<X extends Record<string, any>>(extra: X): this;
+  /**
+   * Build a response object, optionally accepting a raw response to mutate in withResponse.
+   */
   response(): ServerResponse<ResourceBody<R>>;
+  /**
+   * Build a response object, optionally accepting a raw response to mutate in withResponse.
+   * @param res Optional raw response object (e.g. Express Response or H3Event res)
+   */
   response(res: H3Event['res']): ServerResponse<ResourceBody<R>>;
   /**
    * Customize the outgoing transport response right before dispatch.
@@ -662,6 +851,10 @@ declare class Resource<R extends ResourceData | NonCollectible = ResourceData> e
 //#region src/GenericResource.d.ts
 /**
  * GenericResource class to handle API resource transformation and response building
+ *
+ * @author Legacy (3m1n3nc3)
+ * @since 0.1.0
+ * @see BaseSerializer for shared serialization logic and configuration handling
  */
 declare class GenericResource<R extends NonCollectible | Collectible | CollectionLike | PaginatorLike | ResourceData = ResourceData, T extends ResourceData = any> extends BaseSerializer<R> {
   private res?;
@@ -688,8 +881,24 @@ declare class GenericResource<R extends NonCollectible | Collectible | Collectio
   protected setBody(body: GenericBody<R>): this;
   private resolveCollectsConfig;
   private resolveResponseStructure;
+  /**
+   * Resolve the current root key for the response structure, based on configuration and defaults.
+   *
+   * @returns
+   */
   protected resolveCurrentRootKey(): string;
+  /**
+   * Apply metadata properties to the response body, ensuring they are merged with.
+   *
+   * @param meta
+   * @param rootKey
+   */
   protected applyMetaToBody(meta: MetaData, rootKey: string): void;
+  /**
+   * Get the resource data to be used for generating metadata.
+   *
+   * @returns
+   */
   protected getResourceForMeta(): R;
   private getPayloadKey;
   /**
@@ -699,10 +908,18 @@ declare class GenericResource<R extends NonCollectible | Collectible | Collectio
    */
   json(): this;
   /**
-   * Convert resource to array format (for collections)
+   * Convert resource to object format (for collections).
    *
    * @returns
    */
+  toObject(): any;
+  /**
+   * Convert resource to object format and return original data.
+   *
+   * @deprecated Use toObject() instead.
+   * @alias toArray
+   * @since 0.2.9
+   */
   toArray(): any;
   /**
    * Add additional properties to the response body
@@ -711,7 +928,15 @@ declare class GenericResource<R extends NonCollectible | Collectible | Collectio
    * @returns
    */
   additional<X extends Record<string, any>>(extra: X): this;
+  /**
+   * Build a response object, optionally accepting a raw response to write to directly.
+   */
   response(): ServerResponse<GenericBody<R>>;
+  /**
+   * Build a response object, writing to the provided raw response if possible.
+   *
+   * @param res
+   */
   response(res: H3Event['res']): ServerResponse<GenericBody<R>>;
   /**
    * Customize the outgoing transport response right before dispatch.
@@ -832,6 +1057,11 @@ declare const resolveMergeWhen: <T extends Record<string, any>>(condition: any,
 declare const sanitizeConditionalAttributes: (value: any) => any;
 //#endregion
 //#region src/utilities/config.d.ts
+/**
+ * Get the default configuration for the application
+ *
+ * @returns
+ */
 declare const getDefaultConfig: () => Config;
 /**
  * Defines the configuration for the application by merging the provided configuration with the default configuration. This function takes a partial configuration object as input and returns a complete configuration object that includes all required properties, using default values for any properties that are not specified in the input.
@@ -851,8 +1081,29 @@ type ArkormLikeModel = {
 type ArkormLikeCollection = {
   all: () => unknown;
 };
+/**
+ * Type guard to check if a value is an Arkorm-like model, which is defined as an object
+ * that has a toObject method and optionally getRawAttributes, getAttribute, and
+ * setAttribute methods.
+ *
+ * @param value  The value to check
+ * @returns True if the value is an Arkorm-like model, false otherwise
+ */
 declare const isArkormLikeModel: (value: unknown) => value is ArkormLikeModel;
+/**
+ * Type guard to check if a value is an Arkorm-like collection, which is defined as an object
+ *
+ * @param value
+ * @returns
+ */
 declare const isArkormLikeCollection: (value: unknown) => value is ArkormLikeCollection;
+/**
+ * Normalize a value for serialization by recursively converting Arkorm-like models and
+ * collections to plain objects, while preserving the structure of arrays and plain objects.
+ *
+ * @param value The value to normalize
+ * @returns The normalized value, ready for serialization
+ */
 declare const normalizeSerializableData: (value: unknown) => unknown;
 //#endregion
 //#region src/utilities/metadata.d.ts

package/dist/index.mjs

@@ -22,4 +22,4 @@ import{copyFileSync as e,existsSync as t,mkdirSync as n,readFileSync as r,rmSync
  |  _  // _ \/ __|/ _ \| '__/ _, |
  | | \ \  __/\__ \ (_) | | | (_| |
  |_|  \_\___||___/\___/|_|  \__,_|                                                                                           
-`;var Q=class{_status=200;headers={};constructor(e,t){this.response=e,this.body=t}setStatusCode(e){return this._status=e,`status`in this.response&&typeof this.response.status==`function`?this.response.status(e):`status`in this.response&&(this.response.status=e),this}status(){return this._status}statusText(){if(`statusMessage`in this.response)return this.response.statusMessage;if(`statusText`in this.response)return this.response.statusText}setCookie(e,t,n){return this.#e(`Set-Cookie`,`${e}=${t}; ${Object.entries(n||{}).map(([e,t])=>`${e}=${t}`).join(`; `)}`),this}setHeaders(e){for(let[t,n]of Object.entries(e))this.#e(t,n);return this}header(e,t){return this.#e(e,t),this}#e(e,t){this.headers[e]=t,`headers`in this.response?this.response.headers.set(e,t):`setHeader`in this.response&&this.response.setHeader(e,t)}then(e,t){let n=Promise.resolve(this.body).then(e,t);return`send`in this.response&&this.response.send(this.body),n}catch(e){return this.then(void 0,e)}finally(e){return this.then(e,e)}},$=class{static preferredCase;static responseStructure;static config;instanceConfig;additionalMeta;called={};when(e,t){return B(e,t)}whenNotNull(e){return V(e)}mergeWhen(e,t){return H(e,t)}with(e){if(this.called.with=!0,e===void 0)return this.additionalMeta||{};let t=typeof e==`function`?e(this.getResourceForMeta()):e;return this.additionalMeta=A(this.additionalMeta,t),this.called.json&&this.applyMetaToBody(t,this.resolveCurrentRootKey()),this}withMeta(e){return this.with(e),this}resolveMergedMeta(e){return A(R(this,e),this.additionalMeta)}runResponse(e){this.called.toResponse=!0,e.ensureJson();let t=e.body(),n=e.createServerResponse(e.rawResponse,t);return this.called.withResponse=!0,e.callWithResponse(n,e.rawResponse),n}runThen(e){this.called.then=!0,e.ensureJson();let t=e.body();if(e.rawResponse!==void 0){let n=e.createServerResponse(e.rawResponse,t);this.called.withResponse=!0,e.callWithResponse(n,e.rawResponse)}else this.called.withResponse=!0,e.callWithResponse();let n=e.body(),r=Promise.resolve(n).then(e.onfulfilled,e.onrejected);return e.rawResponse!==void 0&&e.sendRawResponse&&e.sendRawResponse(e.rawResponse,n),r}config(e){return e===void 0?this.instanceConfig||{}:(this.instanceConfig={...this.instanceConfig||{},...e,responseStructure:{...this.instanceConfig?.responseStructure||{},...e.responseStructure||{}}},this)}resolveSerializerConfig(e,t){let n=typeof e.config==`function`?e.config():{};return{preferredCase:this.instanceConfig?.preferredCase??n?.preferredCase,responseStructure:{...n?.responseStructure||{},...this.instanceConfig?.responseStructure||{}}}}resolveSerializerCaseStyle(e,t){return this.resolveSerializerConfig(e,t).preferredCase??e.preferredCase??t?.preferredCase??x()}resolveSerializerResponseStructure(e,t){let n=this.resolveSerializerConfig(e,t),r=C();return{wrap:n.responseStructure?.wrap??e.responseStructure?.wrap??t?.responseStructure?.wrap??r?.wrap??!0,rootKey:n.responseStructure?.rootKey??e.responseStructure?.rootKey??t?.responseStructure?.rootKey??r?.rootKey??`data`,factory:n.responseStructure?.factory??e.responseStructure?.factory??t?.responseStructure?.factory??r?.factory}}},Oe=class e extends ${body={data:{}};resource;collects;withResponseContext;constructor(e,t){super(),this.res=t,this.resource=e;let n=!!this.resource&&typeof this.resource==`object`&&`data`in this.resource,r=n?this.resource.data:void 0,i=!!r&&!Array.isArray(r),a=n?r:this.resource;if(a&&typeof a==`object`&&!Array.isArray(a)&&!M(a)){let e=j(a)?Object.keys(a.toObject()):Object.keys(a);for(let t of e)t in this||Object.defineProperty(this,t,{enumerable:!0,configurable:!0,get:()=>j(a)&&typeof a.getAttribute==`function`?a.getAttribute(t):i?r[t]:this.resource[t],set:e=>{if(j(a)&&typeof a.setAttribute==`function`){a.setAttribute(t,e);return}if(i){r[t]=e;return}this.resource[t]=e}})}}data(){return this.resource}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveCollectsConfig(){let e=this.collects;if(!e)return;let t=typeof e.config==`function`?e.config():{};return{preferredCase:t.preferredCase??e.preferredCase,responseStructure:{...e.responseStructure||{},...t.responseStructure||{}}}}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor,this.resolveCollectsConfig())}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=k(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=N(this.data());Array.isArray(t)&&this.collects&&(t=t.map(e=>new this.collects(e).data())),!Array.isArray(t)&&t&&t.data!==void 0&&(t=t.data),t=U(t);let n=I(this.resource),{metaKey:r}=P(),i=r?n[r]:void 0;r&&delete n[r];let a=this.resolveSerializerCaseStyle(this.constructor,this.resolveCollectsConfig());if(a){let e=K(a);t=q(t,e)}let o=this.resolveMergedMeta(e.prototype.with),{wrap:s,rootKey:c,factory:l}=this.resolveResponseStructure();this.body=L({payload:t,meta:i,metaKey:r,wrap:s,rootKey:c,factory:l,context:{type:`generic`,resource:this.resource}}),this.body=k(this.body,{...n,...o||{}},c)}return this}toArray(){this.called.toArray=!0,this.json();let e=N(this.resource);return!Array.isArray(e)&&e&&e.data!==void 0&&(e=e.data),e}additional(e){this.called.additional=!0,this.json();let t=e.data;delete e.data,delete e.pagination;let n=this.getPayloadKey();return t&&n&&this.body[n]!==void 0&&(this.body[n]=Array.isArray(this.body[n])?[...this.body[n],...t]:{...this.body[n],...t}),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}},ke=class e extends ${body={data:[]};resource;collects;withResponseContext;isPaginatedCollectible(e){if(!e||typeof e!=`object`)return!1;let t=e;return t.pagination&&Array.isArray(t.data)?!0:t.meta&&typeof t.meta==`object`&&`currentPage`in t.meta?Array.isArray(t.data)||M(t.data):!1}constructor(e,t){super(),this.res=t,this.resource=e}data(){return this.toArray()}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveCollectsConfig(){let e=this.collects;if(!e)return;let t=typeof e.config==`function`?e.config():{};return{preferredCase:t.preferredCase??e.preferredCase,responseStructure:{...e.responseStructure||{},...t.responseStructure||{}}}}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor,this.resolveCollectsConfig())}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=k(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=this.data();this.collects&&(t=t.map(e=>new this.collects(e).data())),t=N(t),t=U(t);let n=Array.isArray(this.resource)?{}:I(this.resource),{metaKey:r}=P(),i=r?n[r]:void 0;r&&delete n[r];let a=this.resolveSerializerCaseStyle(this.constructor,this.resolveCollectsConfig());if(a){let e=K(a);t=q(t,e)}let o=this.resolveMergedMeta(e.prototype.with),{wrap:s,rootKey:c,factory:l}=this.resolveResponseStructure();this.body=L({payload:t,meta:i,metaKey:r,wrap:s,rootKey:c,factory:l,context:{type:`collection`,resource:this.resource}}),this.body=k(this.body,{...n,...o||{}},c)}return this}toArray(){return this.called.toArray=!0,this.json(),N(Array.isArray(this.resource)?this.resource:M(this.resource)?this.resource.all():this.resource.data)}additional(e){this.called.additional=!0,this.json(),delete e.cursor,delete e.pagination;let t=this.getPayloadKey();return e.data&&t&&Array.isArray(this.body[t])&&(this.body[t]=[...this.body[t],...e.data]),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}setCollects(e){return this.collects=e,this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}},Ae=class e extends ${body={data:{}};resource;withResponseContext;constructor(e,t){super(),this.res=t,this.resource=e;let n=this.resource.data??this.resource;if(!Array.isArray(n)){let e=j(n)?Object.keys(n.toObject()):Object.keys(n);for(let t of e)t in this||Object.defineProperty(this,t,{enumerable:!0,configurable:!0,get:()=>j(n)&&typeof n.getAttribute==`function`?n.getAttribute(t):this.resource.data?.[t]??this.resource[t],set:e=>{if(j(n)&&typeof n.setAttribute==`function`){n.setAttribute(t,e);return}this.resource.data&&this.resource.data[t]?this.resource.data[t]=e:this.resource[t]=e}})}}static collection(e){return new ke(e).setCollects(this)}data(){return this.toArray()}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor)}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=k(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=N(this.data());!Array.isArray(t)&&t&&t.data!==void 0&&(t=t.data),t=U(t);let n=this.resolveSerializerCaseStyle(this.constructor);if(n){let e=K(n);t=q(t,e)}let r=this.resolveMergedMeta(e.prototype.with),{wrap:i,rootKey:a,factory:o}=this.resolveResponseStructure();this.body=L({payload:t,wrap:i,rootKey:a,factory:o,context:{type:`resource`,resource:this.resource}}),this.body=k(this.body,r,a)}return this}toArray(){this.called.toArray=!0,this.json();let e=N(this.resource);return!Array.isArray(e)&&e&&e.data!==void 0&&(e=e.data),e}additional(e){this.called.additional=!0,this.json();let t=this.getPayloadKey();return e.data&&t&&this.body[t]!==void 0&&(this.body[t]=Array.isArray(this.body[t])?[...this.body[t],...e.data]:{...this.body[t],...e.data}),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}};export{f as ApiResource,z as CONDITIONAL_ATTRIBUTE_MISSING,Te as CliApp,Oe as GenericResource,Ee as InitCommand,De as MakeResource,Ae as Resource,ke as ResourceCollection,Q as ServerResponse,k as appendRootProperties,be as applyRuntimeConfig,I as buildPaginationExtras,L as buildResponseEnvelope,Y as defineConfig,K as getCaseTransformer,ve as getDefaultConfig,fe as getGlobalBaseUrl,x as getGlobalCase,D as getGlobalCursorMeta,me as getGlobalPageName,ce as getGlobalPaginatedExtras,ue as getGlobalPaginatedLinks,T as getGlobalPaginatedMeta,oe as getGlobalResponseFactory,ie as getGlobalResponseRootKey,C as getGlobalResponseStructure,re as getGlobalResponseWrap,P as getPaginationExtraKeys,M as isArkormLikeCollection,j as isArkormLikeModel,O as isPlainObject,we as loadRuntimeConfig,A as mergeMetadata,N as normalizeSerializableData,ye as resetRuntimeConfigForTests,H as resolveMergeWhen,B as resolveWhen,V as resolveWhenNotNull,R as resolveWithHookMetadata,U as sanitizeConditionalAttributes,de as setGlobalBaseUrl,b as setGlobalCase,E as setGlobalCursorMeta,pe as setGlobalPageName,se as setGlobalPaginatedExtras,le as setGlobalPaginatedLinks,w as setGlobalPaginatedMeta,ae as setGlobalResponseFactory,te as setGlobalResponseRootKey,S as setGlobalResponseStructure,ne as setGlobalResponseWrap,W as splitWords,G as toCamelCase,_e as toKebabCase,ge as toPascalCase,he as toSnakeCase,q as transformKeys};
+`;var Q=class{_status=200;headers={};constructor(e,t){this.response=e,this.body=t}setStatusCode(e){return this._status=e,`status`in this.response&&typeof this.response.status==`function`?this.response.status(e):`status`in this.response&&(this.response.status=e),this}status(){return this._status}statusText(){if(`statusMessage`in this.response)return this.response.statusMessage;if(`statusText`in this.response)return this.response.statusText}setCookie(e,t,n){return this.#e(`Set-Cookie`,`${e}=${t}; ${Object.entries(n||{}).map(([e,t])=>`${e}=${t}`).join(`; `)}`),this}setHeaders(e){for(let[t,n]of Object.entries(e))this.#e(t,n);return this}header(e,t){return this.#e(e,t),this}#e(e,t){this.headers[e]=t,`headers`in this.response?this.response.headers.set(e,t):`setHeader`in this.response&&this.response.setHeader(e,t)}then(e,t){let n=Promise.resolve(this.body).then(e,t);return`send`in this.response&&this.response.send(this.body),n}catch(e){return this.then(void 0,e)}finally(e){return this.then(e,e)}},$=class{static preferredCase;static responseStructure;static config;instanceConfig;additionalMeta;called={};when(e,t){return B(e,t)}whenNotNull(e){return V(e)}mergeWhen(e,t){return H(e,t)}with(e){if(this.called.with=!0,e===void 0)return this.additionalMeta||{};let t=typeof e==`function`?e(this.getResourceForMeta()):e;return this.additionalMeta=A(this.additionalMeta,t),this.called.json&&this.applyMetaToBody(t,this.resolveCurrentRootKey()),this}withMeta(e){return this.with(e),this}resolveMergedMeta(e){return A(R(this,e),this.additionalMeta)}runResponse(e){this.called.toResponse=!0,e.ensureJson();let t=e.body(),n=e.createServerResponse(e.rawResponse,t);return this.called.withResponse=!0,e.callWithResponse(n,e.rawResponse),n}runThen(e){this.called.then=!0,e.ensureJson();let t=e.body();if(e.rawResponse!==void 0){let n=e.createServerResponse(e.rawResponse,t);this.called.withResponse=!0,e.callWithResponse(n,e.rawResponse)}else this.called.withResponse=!0,e.callWithResponse();let n=e.body(),r=Promise.resolve(n).then(e.onfulfilled,e.onrejected);return e.rawResponse!==void 0&&e.sendRawResponse&&e.sendRawResponse(e.rawResponse,n),r}config(e){return e===void 0?this.instanceConfig||{}:(this.instanceConfig={...this.instanceConfig||{},...e,responseStructure:{...this.instanceConfig?.responseStructure||{},...e.responseStructure||{}}},this)}resolveSerializerConfig(e,t){let n=typeof e.config==`function`?e.config():{};return{preferredCase:this.instanceConfig?.preferredCase??n?.preferredCase,responseStructure:{...n?.responseStructure||{},...this.instanceConfig?.responseStructure||{}}}}resolveSerializerCaseStyle(e,t){return this.resolveSerializerConfig(e,t).preferredCase??e.preferredCase??t?.preferredCase??x()}resolveSerializerResponseStructure(e,t){let n=this.resolveSerializerConfig(e,t),r=C();return{wrap:n.responseStructure?.wrap??e.responseStructure?.wrap??t?.responseStructure?.wrap??r?.wrap??!0,rootKey:n.responseStructure?.rootKey??e.responseStructure?.rootKey??t?.responseStructure?.rootKey??r?.rootKey??`data`,factory:n.responseStructure?.factory??e.responseStructure?.factory??t?.responseStructure?.factory??r?.factory}}},Oe=class e extends ${body={data:{}};resource;collects;withResponseContext;constructor(e,t){super(),this.res=t,this.resource=e;let n=!!this.resource&&typeof this.resource==`object`&&`data`in this.resource,r=n?this.resource.data:void 0,i=!!r&&!Array.isArray(r),a=n?r:this.resource;if(a&&typeof a==`object`&&!Array.isArray(a)&&!M(a)){let e=j(a)?Object.keys(a.toObject()):Object.keys(a);for(let t of e)t in this||Object.defineProperty(this,t,{enumerable:!0,configurable:!0,get:()=>j(a)&&typeof a.getAttribute==`function`?a.getAttribute(t):i?r[t]:this.resource[t],set:e=>{if(j(a)&&typeof a.setAttribute==`function`){a.setAttribute(t,e);return}if(i){r[t]=e;return}this.resource[t]=e}})}}data(){return this.resource}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveCollectsConfig(){let e=this.collects;if(!e)return;let t=typeof e.config==`function`?e.config():{};return{preferredCase:t.preferredCase??e.preferredCase,responseStructure:{...e.responseStructure||{},...t.responseStructure||{}}}}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor,this.resolveCollectsConfig())}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=k(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=N(this.data());Array.isArray(t)&&this.collects&&(t=t.map(e=>new this.collects(e).data())),!Array.isArray(t)&&t&&t.data!==void 0&&(t=t.data),t=U(t);let n=I(this.resource),{metaKey:r}=P(),i=r?n[r]:void 0;r&&delete n[r];let a=this.resolveSerializerCaseStyle(this.constructor,this.resolveCollectsConfig());if(a){let e=K(a);t=q(t,e)}let o=this.resolveMergedMeta(e.prototype.with),{wrap:s,rootKey:c,factory:l}=this.resolveResponseStructure();this.body=L({payload:t,meta:i,metaKey:r,wrap:s,rootKey:c,factory:l,context:{type:`generic`,resource:this.resource}}),this.body=k(this.body,{...n,...o||{}},c)}return this}toObject(){this.called.toObject=!0,this.json();let e=N(this.resource);return!Array.isArray(e)&&e&&e.data!==void 0&&(e=e.data),e}toArray(){return this.called.toArray=!0,this.toObject()}additional(e){this.called.additional=!0,this.json();let t=e.data;delete e.data,delete e.pagination;let n=this.getPayloadKey();return t&&n&&this.body[n]!==void 0&&(this.body[n]=Array.isArray(this.body[n])?[...this.body[n],...t]:{...this.body[n],...t}),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}},ke=class e extends ${body={data:[]};resource;collects;withResponseContext;isPaginatedCollectible(e){if(!e||typeof e!=`object`)return!1;let t=e;return t.pagination&&Array.isArray(t.data)?!0:t.meta&&typeof t.meta==`object`&&`currentPage`in t.meta?Array.isArray(t.data)||M(t.data):!1}constructor(e,t){super(),this.res=t,this.resource=e}data(){return this.toObject()}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveCollectsConfig(){let e=this.collects;if(!e)return;let t=typeof e.config==`function`?e.config():{};return{preferredCase:t.preferredCase??e.preferredCase,responseStructure:{...e.responseStructure||{},...t.responseStructure||{}}}}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor,this.resolveCollectsConfig())}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=k(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=this.data();this.collects&&(t=t.map(e=>new this.collects(e).data())),t=N(t),t=U(t);let n=Array.isArray(this.resource)?{}:I(this.resource),{metaKey:r}=P(),i=r?n[r]:void 0;r&&delete n[r];let a=this.resolveSerializerCaseStyle(this.constructor,this.resolveCollectsConfig());if(a){let e=K(a);t=q(t,e)}let o=this.resolveMergedMeta(e.prototype.with),{wrap:s,rootKey:c,factory:l}=this.resolveResponseStructure();this.body=L({payload:t,meta:i,metaKey:r,wrap:s,rootKey:c,factory:l,context:{type:`collection`,resource:this.resource}}),this.body=k(this.body,{...n,...o||{}},c)}return this}toObject(){return this.called.toObject=!0,this.json(),N(Array.isArray(this.resource)?this.resource:M(this.resource)?this.resource.all():this.resource.data)}toArray(){return this.called.toArray=!0,this.toObject()}additional(e){this.called.additional=!0,this.json(),delete e.cursor,delete e.pagination;let t=this.getPayloadKey();return e.data&&t&&Array.isArray(this.body[t])&&(this.body[t]=[...this.body[t],...e.data]),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}setCollects(e){return this.collects=e,this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}},Ae=class e extends ${body={data:{}};resource;withResponseContext;constructor(e,t){super(),this.res=t,this.resource=e;let n=this.resource.data??this.resource;if(!Array.isArray(n)){let e=j(n)?Object.keys(n.toObject()):Object.keys(n);for(let t of e)t in this||Object.defineProperty(this,t,{enumerable:!0,configurable:!0,get:()=>j(n)&&typeof n.getAttribute==`function`?n.getAttribute(t):this.resource.data?.[t]??this.resource[t],set:e=>{if(j(n)&&typeof n.setAttribute==`function`){n.setAttribute(t,e);return}this.resource.data&&this.resource.data[t]?this.resource.data[t]=e:this.resource[t]=e}})}}static collection(e){return new ke(e).setCollects(this)}data(){return this.toObject()}getBody(){return this.json(),this.body}setBody(e){return this.body=e,this}resolveResponseStructure(){return this.resolveSerializerResponseStructure(this.constructor)}resolveCurrentRootKey(){return this.resolveResponseStructure().rootKey}applyMetaToBody(e,t){this.body=k(this.body,e,t)}getResourceForMeta(){return this.resource}getPayloadKey(){let{wrap:e,rootKey:t,factory:n}=this.resolveResponseStructure();return n||!e?void 0:t}json(){if(!this.called.json){this.called.json=!0;let t=N(this.data());!Array.isArray(t)&&t&&t.data!==void 0&&(t=t.data),t=U(t);let n=this.resolveSerializerCaseStyle(this.constructor);if(n){let e=K(n);t=q(t,e)}let r=this.resolveMergedMeta(e.prototype.with),{wrap:i,rootKey:a,factory:o}=this.resolveResponseStructure();this.body=L({payload:t,wrap:i,rootKey:a,factory:o,context:{type:`resource`,resource:this.resource}}),this.body=k(this.body,r,a)}return this}toObject(){this.called.toObject=!0,this.json();let e=N(this.resource);return!Array.isArray(e)&&e&&e.data!==void 0&&(e=e.data),e}toArray(){return this.called.toArray=!0,this.toObject()}additional(e){this.called.additional=!0,this.json();let t=this.getPayloadKey();return e.data&&t&&this.body[t]!==void 0&&(this.body[t]=Array.isArray(this.body[t])?[...this.body[t],...e.data]:{...this.body[t],...e.data}),this.body={...this.body,...e},this}response(e){let t=e??this.res;return this.runResponse({ensureJson:()=>this.json(),rawResponse:t,body:()=>this.body,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)}})}withResponse(e,t){return this}then(e,t){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:t})}catch(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onrejected:e})}finally(e){return this.runThen({ensureJson:()=>this.json(),body:()=>this.body,rawResponse:this.res,createServerResponse:(e,t)=>{let n=new Q(e,t);return this.withResponseContext={response:n,raw:e},n},callWithResponse:(e,t)=>{this.withResponse(e,t)},sendRawResponse:(e,t)=>{e.send(t)},onfulfilled:e,onrejected:e})}};export{f as ApiResource,z as CONDITIONAL_ATTRIBUTE_MISSING,Te as CliApp,Oe as GenericResource,Ee as InitCommand,De as MakeResource,Ae as Resource,ke as ResourceCollection,Q as ServerResponse,k as appendRootProperties,be as applyRuntimeConfig,I as buildPaginationExtras,L as buildResponseEnvelope,Y as defineConfig,K as getCaseTransformer,ve as getDefaultConfig,fe as getGlobalBaseUrl,x as getGlobalCase,D as getGlobalCursorMeta,me as getGlobalPageName,ce as getGlobalPaginatedExtras,ue as getGlobalPaginatedLinks,T as getGlobalPaginatedMeta,oe as getGlobalResponseFactory,ie as getGlobalResponseRootKey,C as getGlobalResponseStructure,re as getGlobalResponseWrap,P as getPaginationExtraKeys,M as isArkormLikeCollection,j as isArkormLikeModel,O as isPlainObject,we as loadRuntimeConfig,A as mergeMetadata,N as normalizeSerializableData,ye as resetRuntimeConfigForTests,H as resolveMergeWhen,B as resolveWhen,V as resolveWhenNotNull,R as resolveWithHookMetadata,U as sanitizeConditionalAttributes,de as setGlobalBaseUrl,b as setGlobalCase,E as setGlobalCursorMeta,pe as setGlobalPageName,se as setGlobalPaginatedExtras,le as setGlobalPaginatedLinks,w as setGlobalPaginatedMeta,ae as setGlobalResponseFactory,te as setGlobalResponseRootKey,S as setGlobalResponseStructure,ne as setGlobalResponseWrap,W as splitWords,G as toCamelCase,_e as toKebabCase,ge as toPascalCase,he as toSnakeCase,q as transformKeys};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resora",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "A structured API response layer for Node.js and TypeScript with automatic JSON responses, collection support, and pagination handling.",
   "keywords": [
     "api",
@@ -52,7 +52,7 @@
     "@types/node": "^20.10.6",
     "@types/supertest": "^6.0.3",
     "@vitest/coverage-v8": "4.0.18",
-    "arkormx": "^0.1.11",
+    "arkormx": "^0.2.5",
     "barrelize": "^1.7.3",
     "eslint": "^10.0.0",
     "express": "^5.1.0",

package/stubs/resource.collection.stub

@@ -11,6 +11,6 @@ export default class {{ResourceName}} extends ResourceCollection {
      * @memberof {{ResourceName}}
      */
     data () {
-        return this.toArray()
+        return this.toObject()
     }
 }

package/stubs/resource.stub

@@ -10,6 +10,6 @@ export default class {{ResourceName}} extends Resource {
      * @memberof {{ResourceName}}
      */
     data () {
-        return this.toArray()
+        return this.toObject()
     }
 }