@zthun/webigail-rest 5.0.1 → 5.0.3

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/url/restful-url.mts","../src/service/restful-service.mts"],"sourcesContent":["import type { IZDataRequest } from \"@zthun/helpful-query\";\nimport { ZFilterSerialize, ZSortSerialize } from \"@zthun/helpful-query\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\n\n/**\n * Represents a decorator that can build a url for a restful endpoint\n * given an existing base url.\n */\nexport class ZRestfulUrlBuilder {\n  private _url: ZUrlBuilder;\n\n  /**\n   * Initializes a new instance of this object.\n   */\n  public constructor(baseUrl: string) {\n    this._url = new ZUrlBuilder().parse(baseUrl);\n  }\n\n  /**\n   * Adds the request parameters to the url.\n   *\n   * This will add the page, size, search, filter, and sort parameters to the url if they are defined.\n   *\n   * @param request -\n   *        The request to add to the url.\n   * @returns\n   *        This object.\n   */\n  public from(request: IZDataRequest): this {\n    this._url = this._url\n      .page(request.page)\n      .size(request.size)\n      .search(request.search)\n      .filter(new ZFilterSerialize().serialize(request.filter))\n      .sort(new ZSortSerialize().serialize(request.sort));\n    return this;\n  }\n\n  /**\n   * Updates the url to optimize to retrieve a count.\n   *\n   * This will add the size and page parameters to the url and remove the sort parameter.\n   *\n   * @returns\n   *        This object.\n   */\n  public count(): this {\n    this._url = this._url.size(1).page(1).sort(null);\n    return this;\n  }\n\n  /**\n   * Returns the built url.\n   *\n   * @returns\n   *      The built url.\n   */\n  public build(): string {\n    return this._url.build();\n  }\n}\n","import type { IZDataRequest, IZDataSource } from \"@zthun/helpful-query\";\nimport type { IZHttpService } from \"@zthun/webigail-http\";\nimport { ZHttpRequestBuilder } from \"@zthun/webigail-http\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\nimport { ZRestfulUrlBuilder } from \"../url/restful-url.mjs\";\nimport type { IZRestfulCreate } from \"./restful-create.mjs\";\nimport type { IZRestfulDelete } from \"./restful-delete.mjs\";\nimport type { IZRestfulGet } from \"./restful-get.mjs\";\nimport type { IZRestfulUpdate } from \"./restful-update.mjs\";\nimport type { IZRestfulUpsert } from \"./restful-upsert.mjs\";\n\n/**\n * A service that conforms to all known restful standards.\n *\n * @param T -\n *        The type of resource being retrieved or mutated.\n */\nexport interface IZRestfulService<T>\n  extends IZRestfulCreate<T>,\n    IZRestfulDelete,\n    IZRestfulGet<T>,\n    IZRestfulUpdate<T>,\n    IZRestfulUpdate<T>,\n    IZRestfulUpsert<T>,\n    IZDataSource<T> {}\n\n/**\n * A generic implementation of a restful service that assumes all verbs are implemented.\n *\n * This can be used to invoke a service that is only partially implemented.  If your service,\n * for example, is read only, then create, upsert, update, and delete should all return\n * not found or forbidden errors.\n *\n * @param T -\n *        The type of resource being retrieved or mutated.\n */\nexport class ZRestfulService<T> implements IZRestfulService<T> {\n  /**\n   * Initializes a new instance of this object.\n   *\n   * @param _http -\n   *        The http service to use when invoking the RESTful service.\n   * @param _endpointUrl -\n   *        The root url of the endpoint to hit.  This can include params\n   *        to send them with every request, but standard params of page,\n   *        size, search, filter, and sort will be overridden depending on\n   *        which method is being invoked.\n   * @param _request -\n   *        The base request to use when constructing requests in the http\n   *        service.\n   */\n  public constructor(\n    private readonly _http: IZHttpService,\n    private readonly _endpointUrl: string,\n    private readonly _request = new ZHttpRequestBuilder<T>().build(),\n  ) {}\n\n  /**\n   * Gets the final endpoint for a resource.\n   *\n   * @param identification -\n   *        The identification of a single resource.  If this is falsy, then\n   *        the entire data scope is used.\n   *\n   * @returns\n   *        A url builder that points to the target resource endpoint.\n   */\n  public endpoint(identification?: number | string) {\n    const url = new ZUrlBuilder().parse(this._endpointUrl);\n    return identification ? url.append(`${identification}`) : url;\n  }\n\n  public async count(req: IZDataRequest): Promise<number> {\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(\n        new ZRestfulUrlBuilder(this.endpoint().build())\n          .from(req)\n          .count()\n          .build(),\n      )\n      .build();\n    const { data: page } = await this._http.request<any>(r);\n    return page.count;\n  }\n\n  public async retrieve(req: IZDataRequest): Promise<T[]> {\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(new ZRestfulUrlBuilder(this.endpoint().build()).from(req).build())\n      .build();\n    const { data: page } = await this._http.request<any>(r);\n    return page.data ?? page.result;\n  }\n\n  public async get(identification: number | string): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async create(body: T): Promise<T> {\n    const url = this.endpoint().build();\n    const r = new ZHttpRequestBuilder<T>()\n      .copy(this._request)\n      .post(body)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async upsert(body: T): Promise<T> {\n    const url = this.endpoint().build();\n    const r = new ZHttpRequestBuilder<T>()\n      .copy(this._request)\n      .put(body)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async update(\n    identification: number | string,\n    fields: Partial<T>,\n  ): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<Partial<T>>()\n      .copy(this._request)\n      .patch(fields)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async delete(identification: number | string): Promise<void> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<undefined>()\n      .copy(this._request)\n      .delete()\n      .url(url)\n      .build();\n    await this._http.request(r);\n  }\n}\n"],"names":["ZRestfulUrlBuilder","from","request","_url","page","size","search","filter","ZFilterSerialize","serialize","sort","ZSortSerialize","count","build","baseUrl","_define_property","ZUrlBuilder","parse","ZRestfulService","endpoint","identification","url","_endpointUrl","append","req","r","ZHttpRequestBuilder","copy","_request","get","data","_http","retrieve","result","create","body","post","upsert","put","update","fields","patch","delete"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAIA;;;AAGC,IACM,MAAMA,kBAAAA,CAAAA;AAUX;;;;;;;;;MAUOC,IAAAA,CAAKC,OAAsB,EAAQ;AACxC,QAAA,IAAI,CAACC,IAAI,GAAG,IAAI,CAACA,IAAI,CAClBC,IAAI,CAACF,OAAAA,CAAQE,IAAI,CAAA,CACjBC,IAAI,CAACH,OAAAA,CAAQG,IAAI,EACjBC,MAAM,CAACJ,OAAAA,CAAQI,MAAM,EACrBC,MAAM,CAAC,IAAIC,6BAAAA,EAAAA,CAAmBC,SAAS,CAACP,OAAAA,CAAQK,MAAM,CAAA,CAAA,CACtDG,IAAI,CAAC,IAAIC,8BAAiBF,SAAS,CAACP,QAAQQ,IAAI,CAAA,CAAA;AACnD,QAAA,OAAO,IAAI;AACb,IAAA;AAEA;;;;;;;AAOC,MACD,KAAOE,GAAc;AACnB,QAAA,IAAI,CAACT,IAAI,GAAG,IAAI,CAACA,IAAI,CAACE,IAAI,CAAC,CAAA,CAAA,CAAGD,IAAI,CAAC,CAAA,CAAA,CAAGM,IAAI,CAAC,IAAA,CAAA;AAC3C,QAAA,OAAO,IAAI;AACb,IAAA;AAEA;;;;;AAKC,MACD,KAAOG,GAAgB;AACrB,QAAA,OAAO,IAAI,CAACV,IAAI,CAACU,KAAK,EAAA;AACxB,IAAA;AAhDA;;MAGA,WAAA,CAAmBC,OAAe,CAAE;AALpC,QAAAC,kBAAA,CAAA,IAAA,EAAQZ,QAAR,MAAA,CAAA;AAME,QAAA,IAAI,CAACA,IAAI,GAAG,IAAIa,uBAAAA,EAAAA,CAAcC,KAAK,CAACH,OAAAA,CAAAA;AACtC,IAAA;AA4CF;;;;;;;;;;;;;;;AClCA;;;;;;;;;AASC,IACM,MAAMI,eAAAA,CAAAA;AAqBX;;;;;;;;;MAUOC,QAAAA,CAASC,cAAgC,EAAE;AAChD,QAAA,MAAMC,MAAM,IAAIL,uBAAAA,EAAAA,CAAcC,KAAK,CAAC,IAAI,CAACK,YAAY,CAAA;AACrD,QAAA,OAAOF,iBAAiBC,GAAAA,CAAIE,MAAM,CAAC,CAAA,EAAGH,gBAAgB,CAAA,GAAIC,GAAAA;AAC5D,IAAA;IAEA,MAAaT,KAAAA,CAAMY,GAAkB,EAAmB;AACtD,QAAA,MAAMC,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CACF,IAAIrB,kBAAAA,CAAmB,IAAI,CAACmB,QAAQ,EAAA,CAAGN,KAAK,EAAA,CAAA,CACzCZ,IAAI,CAACuB,GAAAA,CAAAA,CACLZ,KAAK,EAAA,CACLC,KAAK,EAAA,CAAA,CAETA,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAAA,EAAM1B,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC2B,KAAK,CAAC7B,OAAO,CAAMuB,CAAAA,CAAAA;AACrD,QAAA,OAAOrB,KAAKQ,KAAK;AACnB,IAAA;IAEA,MAAaoB,QAAAA,CAASR,GAAkB,EAAgB;QACtD,MAAMC,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CAAC,IAAIrB,kBAAAA,CAAmB,IAAI,CAACmB,QAAQ,EAAA,CAAGN,KAAK,EAAA,CAAA,CAAIZ,IAAI,CAACuB,GAAAA,CAAAA,CAAKX,KAAK,EAAA,CAAA,CACnEA,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAAA,EAAM1B,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC2B,KAAK,CAAC7B,OAAO,CAAMuB,CAAAA,CAAAA;AACrD,QAAA,OAAOrB,IAAAA,CAAK0B,IAAI,IAAI1B,IAAAA,CAAK6B,MAAM;AACjC,IAAA;IAEA,MAAaJ,GAAAA,CAAIT,cAA+B,EAAc;AAC5D,QAAA,MAAMC,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaI,MAAAA,CAAOC,IAAO,EAAc;AACvC,QAAA,MAAMd,GAAAA,GAAM,IAAI,CAACF,QAAQ,GAAGN,KAAK,EAAA;AACjC,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBQ,IAAI,CAACD,IAAAA,CAAAA,CACLd,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaO,MAAAA,CAAOF,IAAO,EAAc;AACvC,QAAA,MAAMd,GAAAA,GAAM,IAAI,CAACF,QAAQ,GAAGN,KAAK,EAAA;AACjC,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBU,GAAG,CAACH,IAAAA,CAAAA,CACJd,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;AAEA,IAAA,MAAaS,MAAAA,CACXnB,cAA+B,EAC/BoB,MAAkB,EACN;AACZ,QAAA,MAAMnB,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBa,KAAK,CAACD,MAAAA,CAAAA,CACNnB,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaY,MAAAA,CAAOtB,cAA+B,EAAiB;AAClE,QAAA,MAAMC,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBc,MAAM,EAAA,CACNrB,GAAG,CAACA,KACJR,KAAK,EAAA;AACR,QAAA,MAAM,IAAI,CAACkB,KAAK,CAAC7B,OAAO,CAACuB,CAAAA,CAAAA;AAC3B,IAAA;AAnHA;;;;;;;;;;;;;AAaC,MACD,WAAA,CACmBM,KAAoB,EACrC,YAAqC,EACpBH,QAAAA,GAAW,IAAIF,gCAAAA,EAAAA,CAAyBb,KAAK,EAAE,CAChE;;;;aAHiBkB,KAAAA,GAAAA,KAAAA;aACAT,YAAAA,GAAAA,YAAAA;aACAM,QAAAA,GAAAA,QAAAA;AAChB,IAAA;AAkGL;;;;;"}
+{"version":3,"file":"index.cjs","sources":["../src/url/restful-url.mts","../src/service/restful-service.mts"],"sourcesContent":["import type { IZDataRequest } from \"@zthun/helpful-query\";\nimport { ZFilterSerialize, ZSortSerialize } from \"@zthun/helpful-query\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\n\n/**\n * Represents a decorator that can build a url for a restful endpoint\n * given an existing base url.\n */\nexport class ZRestfulUrlBuilder {\n  private _url: ZUrlBuilder;\n\n  /**\n   * Initializes a new instance of this object.\n   */\n  public constructor(baseUrl: string) {\n    this._url = new ZUrlBuilder().parse(baseUrl);\n  }\n\n  /**\n   * Adds the request parameters to the url.\n   *\n   * This will add the page, size, search, filter, and sort parameters to the url if they are defined.\n   *\n   * @param request -\n   *        The request to add to the url.\n   * @returns\n   *        This object.\n   */\n  public from(request: IZDataRequest): this {\n    this._url = this._url\n      .page(request.page)\n      .size(request.size)\n      .search(request.search)\n      .filter(new ZFilterSerialize().serialize(request.filter))\n      .sort(new ZSortSerialize().serialize(request.sort));\n    return this;\n  }\n\n  /**\n   * Updates the url to optimize to retrieve a count.\n   *\n   * This will add the size and page parameters to the url and remove the sort parameter.\n   *\n   * @returns\n   *        This object.\n   */\n  public count(): this {\n    this._url = this._url.size(1).page(1).sort(null);\n    return this;\n  }\n\n  /**\n   * Returns the built url.\n   *\n   * @returns\n   *      The built url.\n   */\n  public build(): string {\n    return this._url.build();\n  }\n}\n","import type { IZDataRequest, IZDataSource } from \"@zthun/helpful-query\";\nimport type { IZHttpService } from \"@zthun/webigail-http\";\nimport { ZHttpRequestBuilder } from \"@zthun/webigail-http\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\nimport { ZRestfulUrlBuilder } from \"../url/restful-url.mjs\";\nimport type { IZRestfulCreate } from \"./restful-create.mjs\";\nimport type { IZRestfulDelete } from \"./restful-delete.mjs\";\nimport type { IZRestfulGet } from \"./restful-get.mjs\";\nimport type { IZRestfulUpdate } from \"./restful-update.mjs\";\nimport type { IZRestfulUpsert } from \"./restful-upsert.mjs\";\n\n/**\n * A service that conforms to all known restful standards.\n *\n * @param T -\n *        The type of resource being retrieved or mutated.\n */\nexport interface IZRestfulService<T>\n  extends\n    IZRestfulCreate<T>,\n    IZRestfulDelete,\n    IZRestfulGet<T>,\n    IZRestfulUpdate<T>,\n    IZRestfulUpdate<T>,\n    IZRestfulUpsert<T>,\n    IZDataSource<T> {}\n\n/**\n * A generic implementation of a restful service that assumes all verbs are implemented.\n *\n * This can be used to invoke a service that is only partially implemented.  If your service,\n * for example, is read only, then create, upsert, update, and delete should all return\n * not found or forbidden errors.\n *\n * @param T -\n *        The type of resource being retrieved or mutated.\n */\nexport class ZRestfulService<T> implements IZRestfulService<T> {\n  /**\n   * Initializes a new instance of this object.\n   *\n   * @param _http -\n   *        The http service to use when invoking the RESTful service.\n   * @param _endpointUrl -\n   *        The root url of the endpoint to hit.  This can include params\n   *        to send them with every request, but standard params of page,\n   *        size, search, filter, and sort will be overridden depending on\n   *        which method is being invoked.\n   * @param _request -\n   *        The base request to use when constructing requests in the http\n   *        service.\n   */\n  public constructor(\n    private readonly _http: IZHttpService,\n    private readonly _endpointUrl: string,\n    private readonly _request = new ZHttpRequestBuilder<T>().build(),\n  ) {}\n\n  /**\n   * Gets the final endpoint for a resource.\n   *\n   * @param identification -\n   *        The identification of a single resource.  If this is falsy, then\n   *        the entire data scope is used.\n   *\n   * @returns\n   *        A url builder that points to the target resource endpoint.\n   */\n  public endpoint(identification?: number | string) {\n    const url = new ZUrlBuilder().parse(this._endpointUrl);\n    return identification ? url.append(`${identification}`) : url;\n  }\n\n  public async count(req: IZDataRequest): Promise<number> {\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(\n        new ZRestfulUrlBuilder(this.endpoint().build())\n          .from(req)\n          .count()\n          .build(),\n      )\n      .build();\n    const { data: page } = await this._http.request<any>(r);\n    return page.count;\n  }\n\n  public async retrieve(req: IZDataRequest): Promise<T[]> {\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(new ZRestfulUrlBuilder(this.endpoint().build()).from(req).build())\n      .build();\n    const { data: page } = await this._http.request<any>(r);\n    return page.data ?? page.result;\n  }\n\n  public async get(identification: number | string): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async create(body: T): Promise<T> {\n    const url = this.endpoint().build();\n    const r = new ZHttpRequestBuilder<T>()\n      .copy(this._request)\n      .post(body)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async upsert(body: T): Promise<T> {\n    const url = this.endpoint().build();\n    const r = new ZHttpRequestBuilder<T>()\n      .copy(this._request)\n      .put(body)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async update(\n    identification: number | string,\n    fields: Partial<T>,\n  ): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<Partial<T>>()\n      .copy(this._request)\n      .patch(fields)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async delete(identification: number | string): Promise<void> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<undefined>()\n      .copy(this._request)\n      .delete()\n      .url(url)\n      .build();\n    await this._http.request(r);\n  }\n}\n"],"names":["ZRestfulUrlBuilder","from","request","_url","page","size","search","filter","ZFilterSerialize","serialize","sort","ZSortSerialize","count","build","baseUrl","_define_property","ZUrlBuilder","parse","ZRestfulService","endpoint","identification","url","_endpointUrl","append","req","r","ZHttpRequestBuilder","copy","_request","get","data","_http","retrieve","result","create","body","post","upsert","put","update","fields","patch","delete"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAIA;;;AAGC,IACM,MAAMA,kBAAAA,CAAAA;AAUX;;;;;;;;;MAUOC,IAAAA,CAAKC,OAAsB,EAAQ;AACxC,QAAA,IAAI,CAACC,IAAI,GAAG,IAAI,CAACA,IAAI,CAClBC,IAAI,CAACF,OAAAA,CAAQE,IAAI,CAAA,CACjBC,IAAI,CAACH,OAAAA,CAAQG,IAAI,EACjBC,MAAM,CAACJ,OAAAA,CAAQI,MAAM,EACrBC,MAAM,CAAC,IAAIC,6BAAAA,EAAAA,CAAmBC,SAAS,CAACP,OAAAA,CAAQK,MAAM,CAAA,CAAA,CACtDG,IAAI,CAAC,IAAIC,8BAAiBF,SAAS,CAACP,QAAQQ,IAAI,CAAA,CAAA;AACnD,QAAA,OAAO,IAAI;AACb,IAAA;AAEA;;;;;;;AAOC,MACD,KAAOE,GAAc;AACnB,QAAA,IAAI,CAACT,IAAI,GAAG,IAAI,CAACA,IAAI,CAACE,IAAI,CAAC,CAAA,CAAA,CAAGD,IAAI,CAAC,CAAA,CAAA,CAAGM,IAAI,CAAC,IAAA,CAAA;AAC3C,QAAA,OAAO,IAAI;AACb,IAAA;AAEA;;;;;AAKC,MACD,KAAOG,GAAgB;AACrB,QAAA,OAAO,IAAI,CAACV,IAAI,CAACU,KAAK,EAAA;AACxB,IAAA;AAhDA;;MAGA,WAAA,CAAmBC,OAAe,CAAE;AALpC,QAAAC,kBAAA,CAAA,IAAA,EAAQZ,QAAR,MAAA,CAAA;AAME,QAAA,IAAI,CAACA,IAAI,GAAG,IAAIa,uBAAAA,EAAAA,CAAcC,KAAK,CAACH,OAAAA,CAAAA;AACtC,IAAA;AA4CF;;;;;;;;;;;;;;;ACjCA;;;;;;;;;AASC,IACM,MAAMI,eAAAA,CAAAA;AAqBX;;;;;;;;;MAUOC,QAAAA,CAASC,cAAgC,EAAE;AAChD,QAAA,MAAMC,MAAM,IAAIL,uBAAAA,EAAAA,CAAcC,KAAK,CAAC,IAAI,CAACK,YAAY,CAAA;AACrD,QAAA,OAAOF,iBAAiBC,GAAAA,CAAIE,MAAM,CAAC,CAAA,EAAGH,gBAAgB,CAAA,GAAIC,GAAAA;AAC5D,IAAA;IAEA,MAAaT,KAAAA,CAAMY,GAAkB,EAAmB;AACtD,QAAA,MAAMC,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CACF,IAAIrB,kBAAAA,CAAmB,IAAI,CAACmB,QAAQ,EAAA,CAAGN,KAAK,EAAA,CAAA,CACzCZ,IAAI,CAACuB,GAAAA,CAAAA,CACLZ,KAAK,EAAA,CACLC,KAAK,EAAA,CAAA,CAETA,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAAA,EAAM1B,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC2B,KAAK,CAAC7B,OAAO,CAAMuB,CAAAA,CAAAA;AACrD,QAAA,OAAOrB,KAAKQ,KAAK;AACnB,IAAA;IAEA,MAAaoB,QAAAA,CAASR,GAAkB,EAAgB;QACtD,MAAMC,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CAAC,IAAIrB,kBAAAA,CAAmB,IAAI,CAACmB,QAAQ,EAAA,CAAGN,KAAK,EAAA,CAAA,CAAIZ,IAAI,CAACuB,GAAAA,CAAAA,CAAKX,KAAK,EAAA,CAAA,CACnEA,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAAA,EAAM1B,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC2B,KAAK,CAAC7B,OAAO,CAAMuB,CAAAA,CAAAA;AACrD,QAAA,OAAOrB,IAAAA,CAAK0B,IAAI,IAAI1B,IAAAA,CAAK6B,MAAM;AACjC,IAAA;IAEA,MAAaJ,GAAAA,CAAIT,cAA+B,EAAc;AAC5D,QAAA,MAAMC,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaI,MAAAA,CAAOC,IAAO,EAAc;AACvC,QAAA,MAAMd,GAAAA,GAAM,IAAI,CAACF,QAAQ,GAAGN,KAAK,EAAA;AACjC,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBQ,IAAI,CAACD,IAAAA,CAAAA,CACLd,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaO,MAAAA,CAAOF,IAAO,EAAc;AACvC,QAAA,MAAMd,GAAAA,GAAM,IAAI,CAACF,QAAQ,GAAGN,KAAK,EAAA;AACjC,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBU,GAAG,CAACH,IAAAA,CAAAA,CACJd,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;AAEA,IAAA,MAAaS,MAAAA,CACXnB,cAA+B,EAC/BoB,MAAkB,EACN;AACZ,QAAA,MAAMnB,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBa,KAAK,CAACD,MAAAA,CAAAA,CACNnB,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaY,MAAAA,CAAOtB,cAA+B,EAAiB;AAClE,QAAA,MAAMC,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,gCAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBc,MAAM,EAAA,CACNrB,GAAG,CAACA,KACJR,KAAK,EAAA;AACR,QAAA,MAAM,IAAI,CAACkB,KAAK,CAAC7B,OAAO,CAACuB,CAAAA,CAAAA;AAC3B,IAAA;AAnHA;;;;;;;;;;;;;AAaC,MACD,WAAA,CACmBM,KAAoB,EACrC,YAAqC,EACpBH,QAAAA,GAAW,IAAIF,gCAAAA,EAAAA,CAAyBb,KAAK,EAAE,CAChE;;;;aAHiBkB,KAAAA,GAAAA,KAAAA;aACAT,YAAAA,GAAAA,YAAAA;aACAM,QAAAA,GAAAA,QAAAA;AAChB,IAAA;AAkGL;;;;;"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/url/restful-url.mts","../src/service/restful-service.mts"],"sourcesContent":["import type { IZDataRequest } from \"@zthun/helpful-query\";\nimport { ZFilterSerialize, ZSortSerialize } from \"@zthun/helpful-query\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\n\n/**\n * Represents a decorator that can build a url for a restful endpoint\n * given an existing base url.\n */\nexport class ZRestfulUrlBuilder {\n  private _url: ZUrlBuilder;\n\n  /**\n   * Initializes a new instance of this object.\n   */\n  public constructor(baseUrl: string) {\n    this._url = new ZUrlBuilder().parse(baseUrl);\n  }\n\n  /**\n   * Adds the request parameters to the url.\n   *\n   * This will add the page, size, search, filter, and sort parameters to the url if they are defined.\n   *\n   * @param request -\n   *        The request to add to the url.\n   * @returns\n   *        This object.\n   */\n  public from(request: IZDataRequest): this {\n    this._url = this._url\n      .page(request.page)\n      .size(request.size)\n      .search(request.search)\n      .filter(new ZFilterSerialize().serialize(request.filter))\n      .sort(new ZSortSerialize().serialize(request.sort));\n    return this;\n  }\n\n  /**\n   * Updates the url to optimize to retrieve a count.\n   *\n   * This will add the size and page parameters to the url and remove the sort parameter.\n   *\n   * @returns\n   *        This object.\n   */\n  public count(): this {\n    this._url = this._url.size(1).page(1).sort(null);\n    return this;\n  }\n\n  /**\n   * Returns the built url.\n   *\n   * @returns\n   *      The built url.\n   */\n  public build(): string {\n    return this._url.build();\n  }\n}\n","import type { IZDataRequest, IZDataSource } from \"@zthun/helpful-query\";\nimport type { IZHttpService } from \"@zthun/webigail-http\";\nimport { ZHttpRequestBuilder } from \"@zthun/webigail-http\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\nimport { ZRestfulUrlBuilder } from \"../url/restful-url.mjs\";\nimport type { IZRestfulCreate } from \"./restful-create.mjs\";\nimport type { IZRestfulDelete } from \"./restful-delete.mjs\";\nimport type { IZRestfulGet } from \"./restful-get.mjs\";\nimport type { IZRestfulUpdate } from \"./restful-update.mjs\";\nimport type { IZRestfulUpsert } from \"./restful-upsert.mjs\";\n\n/**\n * A service that conforms to all known restful standards.\n *\n * @param T -\n *        The type of resource being retrieved or mutated.\n */\nexport interface IZRestfulService<T>\n  extends IZRestfulCreate<T>,\n    IZRestfulDelete,\n    IZRestfulGet<T>,\n    IZRestfulUpdate<T>,\n    IZRestfulUpdate<T>,\n    IZRestfulUpsert<T>,\n    IZDataSource<T> {}\n\n/**\n * A generic implementation of a restful service that assumes all verbs are implemented.\n *\n * This can be used to invoke a service that is only partially implemented.  If your service,\n * for example, is read only, then create, upsert, update, and delete should all return\n * not found or forbidden errors.\n *\n * @param T -\n *        The type of resource being retrieved or mutated.\n */\nexport class ZRestfulService<T> implements IZRestfulService<T> {\n  /**\n   * Initializes a new instance of this object.\n   *\n   * @param _http -\n   *        The http service to use when invoking the RESTful service.\n   * @param _endpointUrl -\n   *        The root url of the endpoint to hit.  This can include params\n   *        to send them with every request, but standard params of page,\n   *        size, search, filter, and sort will be overridden depending on\n   *        which method is being invoked.\n   * @param _request -\n   *        The base request to use when constructing requests in the http\n   *        service.\n   */\n  public constructor(\n    private readonly _http: IZHttpService,\n    private readonly _endpointUrl: string,\n    private readonly _request = new ZHttpRequestBuilder<T>().build(),\n  ) {}\n\n  /**\n   * Gets the final endpoint for a resource.\n   *\n   * @param identification -\n   *        The identification of a single resource.  If this is falsy, then\n   *        the entire data scope is used.\n   *\n   * @returns\n   *        A url builder that points to the target resource endpoint.\n   */\n  public endpoint(identification?: number | string) {\n    const url = new ZUrlBuilder().parse(this._endpointUrl);\n    return identification ? url.append(`${identification}`) : url;\n  }\n\n  public async count(req: IZDataRequest): Promise<number> {\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(\n        new ZRestfulUrlBuilder(this.endpoint().build())\n          .from(req)\n          .count()\n          .build(),\n      )\n      .build();\n    const { data: page } = await this._http.request<any>(r);\n    return page.count;\n  }\n\n  public async retrieve(req: IZDataRequest): Promise<T[]> {\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(new ZRestfulUrlBuilder(this.endpoint().build()).from(req).build())\n      .build();\n    const { data: page } = await this._http.request<any>(r);\n    return page.data ?? page.result;\n  }\n\n  public async get(identification: number | string): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async create(body: T): Promise<T> {\n    const url = this.endpoint().build();\n    const r = new ZHttpRequestBuilder<T>()\n      .copy(this._request)\n      .post(body)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async upsert(body: T): Promise<T> {\n    const url = this.endpoint().build();\n    const r = new ZHttpRequestBuilder<T>()\n      .copy(this._request)\n      .put(body)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async update(\n    identification: number | string,\n    fields: Partial<T>,\n  ): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<Partial<T>>()\n      .copy(this._request)\n      .patch(fields)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async delete(identification: number | string): Promise<void> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<undefined>()\n      .copy(this._request)\n      .delete()\n      .url(url)\n      .build();\n    await this._http.request(r);\n  }\n}\n"],"names":["ZRestfulUrlBuilder","from","request","_url","page","size","search","filter","ZFilterSerialize","serialize","sort","ZSortSerialize","count","build","baseUrl","_define_property","ZUrlBuilder","parse","ZRestfulService","endpoint","identification","url","_endpointUrl","append","req","r","ZHttpRequestBuilder","copy","_request","get","data","_http","retrieve","result","create","body","post","upsert","put","update","fields","patch","delete"],"mappings":";;;;;;;;;;;;;;;;;AAIA;;;AAGC,IACM,MAAMA,kBAAAA,CAAAA;AAUX;;;;;;;;;MAUOC,IAAAA,CAAKC,OAAsB,EAAQ;AACxC,QAAA,IAAI,CAACC,IAAI,GAAG,IAAI,CAACA,IAAI,CAClBC,IAAI,CAACF,OAAAA,CAAQE,IAAI,CAAA,CACjBC,IAAI,CAACH,OAAAA,CAAQG,IAAI,EACjBC,MAAM,CAACJ,OAAAA,CAAQI,MAAM,EACrBC,MAAM,CAAC,IAAIC,gBAAAA,EAAAA,CAAmBC,SAAS,CAACP,OAAAA,CAAQK,MAAM,CAAA,CAAA,CACtDG,IAAI,CAAC,IAAIC,iBAAiBF,SAAS,CAACP,QAAQQ,IAAI,CAAA,CAAA;AACnD,QAAA,OAAO,IAAI;AACb,IAAA;AAEA;;;;;;;AAOC,MACD,KAAOE,GAAc;AACnB,QAAA,IAAI,CAACT,IAAI,GAAG,IAAI,CAACA,IAAI,CAACE,IAAI,CAAC,CAAA,CAAA,CAAGD,IAAI,CAAC,CAAA,CAAA,CAAGM,IAAI,CAAC,IAAA,CAAA;AAC3C,QAAA,OAAO,IAAI;AACb,IAAA;AAEA;;;;;AAKC,MACD,KAAOG,GAAgB;AACrB,QAAA,OAAO,IAAI,CAACV,IAAI,CAACU,KAAK,EAAA;AACxB,IAAA;AAhDA;;MAGA,WAAA,CAAmBC,OAAe,CAAE;AALpC,QAAAC,kBAAA,CAAA,IAAA,EAAQZ,QAAR,MAAA,CAAA;AAME,QAAA,IAAI,CAACA,IAAI,GAAG,IAAIa,WAAAA,EAAAA,CAAcC,KAAK,CAACH,OAAAA,CAAAA;AACtC,IAAA;AA4CF;;;;;;;;;;;;;;;AClCA;;;;;;;;;AASC,IACM,MAAMI,eAAAA,CAAAA;AAqBX;;;;;;;;;MAUOC,QAAAA,CAASC,cAAgC,EAAE;AAChD,QAAA,MAAMC,MAAM,IAAIL,WAAAA,EAAAA,CAAcC,KAAK,CAAC,IAAI,CAACK,YAAY,CAAA;AACrD,QAAA,OAAOF,iBAAiBC,GAAAA,CAAIE,MAAM,CAAC,CAAA,EAAGH,gBAAgB,CAAA,GAAIC,GAAAA;AAC5D,IAAA;IAEA,MAAaT,KAAAA,CAAMY,GAAkB,EAAmB;AACtD,QAAA,MAAMC,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CACF,IAAIrB,kBAAAA,CAAmB,IAAI,CAACmB,QAAQ,EAAA,CAAGN,KAAK,EAAA,CAAA,CACzCZ,IAAI,CAACuB,GAAAA,CAAAA,CACLZ,KAAK,EAAA,CACLC,KAAK,EAAA,CAAA,CAETA,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAAA,EAAM1B,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC2B,KAAK,CAAC7B,OAAO,CAAMuB,CAAAA,CAAAA;AACrD,QAAA,OAAOrB,KAAKQ,KAAK;AACnB,IAAA;IAEA,MAAaoB,QAAAA,CAASR,GAAkB,EAAgB;QACtD,MAAMC,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CAAC,IAAIrB,kBAAAA,CAAmB,IAAI,CAACmB,QAAQ,EAAA,CAAGN,KAAK,EAAA,CAAA,CAAIZ,IAAI,CAACuB,GAAAA,CAAAA,CAAKX,KAAK,EAAA,CAAA,CACnEA,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAAA,EAAM1B,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC2B,KAAK,CAAC7B,OAAO,CAAMuB,CAAAA,CAAAA;AACrD,QAAA,OAAOrB,IAAAA,CAAK0B,IAAI,IAAI1B,IAAAA,CAAK6B,MAAM;AACjC,IAAA;IAEA,MAAaJ,GAAAA,CAAIT,cAA+B,EAAc;AAC5D,QAAA,MAAMC,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaI,MAAAA,CAAOC,IAAO,EAAc;AACvC,QAAA,MAAMd,GAAAA,GAAM,IAAI,CAACF,QAAQ,GAAGN,KAAK,EAAA;AACjC,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBQ,IAAI,CAACD,IAAAA,CAAAA,CACLd,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaO,MAAAA,CAAOF,IAAO,EAAc;AACvC,QAAA,MAAMd,GAAAA,GAAM,IAAI,CAACF,QAAQ,GAAGN,KAAK,EAAA;AACjC,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBU,GAAG,CAACH,IAAAA,CAAAA,CACJd,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;AAEA,IAAA,MAAaS,MAAAA,CACXnB,cAA+B,EAC/BoB,MAAkB,EACN;AACZ,QAAA,MAAMnB,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBa,KAAK,CAACD,MAAAA,CAAAA,CACNnB,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaY,MAAAA,CAAOtB,cAA+B,EAAiB;AAClE,QAAA,MAAMC,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBc,MAAM,EAAA,CACNrB,GAAG,CAACA,KACJR,KAAK,EAAA;AACR,QAAA,MAAM,IAAI,CAACkB,KAAK,CAAC7B,OAAO,CAACuB,CAAAA,CAAAA;AAC3B,IAAA;AAnHA;;;;;;;;;;;;;AAaC,MACD,WAAA,CACmBM,KAAoB,EACrC,YAAqC,EACpBH,QAAAA,GAAW,IAAIF,mBAAAA,EAAAA,CAAyBb,KAAK,EAAE,CAChE;;;;aAHiBkB,KAAAA,GAAAA,KAAAA;aACAT,YAAAA,GAAAA,YAAAA;aACAM,QAAAA,GAAAA,QAAAA;AAChB,IAAA;AAkGL;;;;"}
+{"version":3,"file":"index.js","sources":["../src/url/restful-url.mts","../src/service/restful-service.mts"],"sourcesContent":["import type { IZDataRequest } from \"@zthun/helpful-query\";\nimport { ZFilterSerialize, ZSortSerialize } from \"@zthun/helpful-query\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\n\n/**\n * Represents a decorator that can build a url for a restful endpoint\n * given an existing base url.\n */\nexport class ZRestfulUrlBuilder {\n  private _url: ZUrlBuilder;\n\n  /**\n   * Initializes a new instance of this object.\n   */\n  public constructor(baseUrl: string) {\n    this._url = new ZUrlBuilder().parse(baseUrl);\n  }\n\n  /**\n   * Adds the request parameters to the url.\n   *\n   * This will add the page, size, search, filter, and sort parameters to the url if they are defined.\n   *\n   * @param request -\n   *        The request to add to the url.\n   * @returns\n   *        This object.\n   */\n  public from(request: IZDataRequest): this {\n    this._url = this._url\n      .page(request.page)\n      .size(request.size)\n      .search(request.search)\n      .filter(new ZFilterSerialize().serialize(request.filter))\n      .sort(new ZSortSerialize().serialize(request.sort));\n    return this;\n  }\n\n  /**\n   * Updates the url to optimize to retrieve a count.\n   *\n   * This will add the size and page parameters to the url and remove the sort parameter.\n   *\n   * @returns\n   *        This object.\n   */\n  public count(): this {\n    this._url = this._url.size(1).page(1).sort(null);\n    return this;\n  }\n\n  /**\n   * Returns the built url.\n   *\n   * @returns\n   *      The built url.\n   */\n  public build(): string {\n    return this._url.build();\n  }\n}\n","import type { IZDataRequest, IZDataSource } from \"@zthun/helpful-query\";\nimport type { IZHttpService } from \"@zthun/webigail-http\";\nimport { ZHttpRequestBuilder } from \"@zthun/webigail-http\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\nimport { ZRestfulUrlBuilder } from \"../url/restful-url.mjs\";\nimport type { IZRestfulCreate } from \"./restful-create.mjs\";\nimport type { IZRestfulDelete } from \"./restful-delete.mjs\";\nimport type { IZRestfulGet } from \"./restful-get.mjs\";\nimport type { IZRestfulUpdate } from \"./restful-update.mjs\";\nimport type { IZRestfulUpsert } from \"./restful-upsert.mjs\";\n\n/**\n * A service that conforms to all known restful standards.\n *\n * @param T -\n *        The type of resource being retrieved or mutated.\n */\nexport interface IZRestfulService<T>\n  extends\n    IZRestfulCreate<T>,\n    IZRestfulDelete,\n    IZRestfulGet<T>,\n    IZRestfulUpdate<T>,\n    IZRestfulUpdate<T>,\n    IZRestfulUpsert<T>,\n    IZDataSource<T> {}\n\n/**\n * A generic implementation of a restful service that assumes all verbs are implemented.\n *\n * This can be used to invoke a service that is only partially implemented.  If your service,\n * for example, is read only, then create, upsert, update, and delete should all return\n * not found or forbidden errors.\n *\n * @param T -\n *        The type of resource being retrieved or mutated.\n */\nexport class ZRestfulService<T> implements IZRestfulService<T> {\n  /**\n   * Initializes a new instance of this object.\n   *\n   * @param _http -\n   *        The http service to use when invoking the RESTful service.\n   * @param _endpointUrl -\n   *        The root url of the endpoint to hit.  This can include params\n   *        to send them with every request, but standard params of page,\n   *        size, search, filter, and sort will be overridden depending on\n   *        which method is being invoked.\n   * @param _request -\n   *        The base request to use when constructing requests in the http\n   *        service.\n   */\n  public constructor(\n    private readonly _http: IZHttpService,\n    private readonly _endpointUrl: string,\n    private readonly _request = new ZHttpRequestBuilder<T>().build(),\n  ) {}\n\n  /**\n   * Gets the final endpoint for a resource.\n   *\n   * @param identification -\n   *        The identification of a single resource.  If this is falsy, then\n   *        the entire data scope is used.\n   *\n   * @returns\n   *        A url builder that points to the target resource endpoint.\n   */\n  public endpoint(identification?: number | string) {\n    const url = new ZUrlBuilder().parse(this._endpointUrl);\n    return identification ? url.append(`${identification}`) : url;\n  }\n\n  public async count(req: IZDataRequest): Promise<number> {\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(\n        new ZRestfulUrlBuilder(this.endpoint().build())\n          .from(req)\n          .count()\n          .build(),\n      )\n      .build();\n    const { data: page } = await this._http.request<any>(r);\n    return page.count;\n  }\n\n  public async retrieve(req: IZDataRequest): Promise<T[]> {\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(new ZRestfulUrlBuilder(this.endpoint().build()).from(req).build())\n      .build();\n    const { data: page } = await this._http.request<any>(r);\n    return page.data ?? page.result;\n  }\n\n  public async get(identification: number | string): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder()\n      .copy(this._request)\n      .get()\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async create(body: T): Promise<T> {\n    const url = this.endpoint().build();\n    const r = new ZHttpRequestBuilder<T>()\n      .copy(this._request)\n      .post(body)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async upsert(body: T): Promise<T> {\n    const url = this.endpoint().build();\n    const r = new ZHttpRequestBuilder<T>()\n      .copy(this._request)\n      .put(body)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async update(\n    identification: number | string,\n    fields: Partial<T>,\n  ): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<Partial<T>>()\n      .copy(this._request)\n      .patch(fields)\n      .url(url)\n      .build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async delete(identification: number | string): Promise<void> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<undefined>()\n      .copy(this._request)\n      .delete()\n      .url(url)\n      .build();\n    await this._http.request(r);\n  }\n}\n"],"names":["ZRestfulUrlBuilder","from","request","_url","page","size","search","filter","ZFilterSerialize","serialize","sort","ZSortSerialize","count","build","baseUrl","_define_property","ZUrlBuilder","parse","ZRestfulService","endpoint","identification","url","_endpointUrl","append","req","r","ZHttpRequestBuilder","copy","_request","get","data","_http","retrieve","result","create","body","post","upsert","put","update","fields","patch","delete"],"mappings":";;;;;;;;;;;;;;;;;AAIA;;;AAGC,IACM,MAAMA,kBAAAA,CAAAA;AAUX;;;;;;;;;MAUOC,IAAAA,CAAKC,OAAsB,EAAQ;AACxC,QAAA,IAAI,CAACC,IAAI,GAAG,IAAI,CAACA,IAAI,CAClBC,IAAI,CAACF,OAAAA,CAAQE,IAAI,CAAA,CACjBC,IAAI,CAACH,OAAAA,CAAQG,IAAI,EACjBC,MAAM,CAACJ,OAAAA,CAAQI,MAAM,EACrBC,MAAM,CAAC,IAAIC,gBAAAA,EAAAA,CAAmBC,SAAS,CAACP,OAAAA,CAAQK,MAAM,CAAA,CAAA,CACtDG,IAAI,CAAC,IAAIC,iBAAiBF,SAAS,CAACP,QAAQQ,IAAI,CAAA,CAAA;AACnD,QAAA,OAAO,IAAI;AACb,IAAA;AAEA;;;;;;;AAOC,MACD,KAAOE,GAAc;AACnB,QAAA,IAAI,CAACT,IAAI,GAAG,IAAI,CAACA,IAAI,CAACE,IAAI,CAAC,CAAA,CAAA,CAAGD,IAAI,CAAC,CAAA,CAAA,CAAGM,IAAI,CAAC,IAAA,CAAA;AAC3C,QAAA,OAAO,IAAI;AACb,IAAA;AAEA;;;;;AAKC,MACD,KAAOG,GAAgB;AACrB,QAAA,OAAO,IAAI,CAACV,IAAI,CAACU,KAAK,EAAA;AACxB,IAAA;AAhDA;;MAGA,WAAA,CAAmBC,OAAe,CAAE;AALpC,QAAAC,kBAAA,CAAA,IAAA,EAAQZ,QAAR,MAAA,CAAA;AAME,QAAA,IAAI,CAACA,IAAI,GAAG,IAAIa,WAAAA,EAAAA,CAAcC,KAAK,CAACH,OAAAA,CAAAA;AACtC,IAAA;AA4CF;;;;;;;;;;;;;;;ACjCA;;;;;;;;;AASC,IACM,MAAMI,eAAAA,CAAAA;AAqBX;;;;;;;;;MAUOC,QAAAA,CAASC,cAAgC,EAAE;AAChD,QAAA,MAAMC,MAAM,IAAIL,WAAAA,EAAAA,CAAcC,KAAK,CAAC,IAAI,CAACK,YAAY,CAAA;AACrD,QAAA,OAAOF,iBAAiBC,GAAAA,CAAIE,MAAM,CAAC,CAAA,EAAGH,gBAAgB,CAAA,GAAIC,GAAAA;AAC5D,IAAA;IAEA,MAAaT,KAAAA,CAAMY,GAAkB,EAAmB;AACtD,QAAA,MAAMC,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CACF,IAAIrB,kBAAAA,CAAmB,IAAI,CAACmB,QAAQ,EAAA,CAAGN,KAAK,EAAA,CAAA,CACzCZ,IAAI,CAACuB,GAAAA,CAAAA,CACLZ,KAAK,EAAA,CACLC,KAAK,EAAA,CAAA,CAETA,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAAA,EAAM1B,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC2B,KAAK,CAAC7B,OAAO,CAAMuB,CAAAA,CAAAA;AACrD,QAAA,OAAOrB,KAAKQ,KAAK;AACnB,IAAA;IAEA,MAAaoB,QAAAA,CAASR,GAAkB,EAAgB;QACtD,MAAMC,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CAAC,IAAIrB,kBAAAA,CAAmB,IAAI,CAACmB,QAAQ,EAAA,CAAGN,KAAK,EAAA,CAAA,CAAIZ,IAAI,CAACuB,GAAAA,CAAAA,CAAKX,KAAK,EAAA,CAAA,CACnEA,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAAA,EAAM1B,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC2B,KAAK,CAAC7B,OAAO,CAAMuB,CAAAA,CAAAA;AACrD,QAAA,OAAOrB,IAAAA,CAAK0B,IAAI,IAAI1B,IAAAA,CAAK6B,MAAM;AACjC,IAAA;IAEA,MAAaJ,GAAAA,CAAIT,cAA+B,EAAc;AAC5D,QAAA,MAAMC,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBC,GAAG,EAAA,CACHR,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaI,MAAAA,CAAOC,IAAO,EAAc;AACvC,QAAA,MAAMd,GAAAA,GAAM,IAAI,CAACF,QAAQ,GAAGN,KAAK,EAAA;AACjC,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBQ,IAAI,CAACD,IAAAA,CAAAA,CACLd,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaO,MAAAA,CAAOF,IAAO,EAAc;AACvC,QAAA,MAAMd,GAAAA,GAAM,IAAI,CAACF,QAAQ,GAAGN,KAAK,EAAA;AACjC,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBU,GAAG,CAACH,IAAAA,CAAAA,CACJd,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;AAEA,IAAA,MAAaS,MAAAA,CACXnB,cAA+B,EAC/BoB,MAAkB,EACN;AACZ,QAAA,MAAMnB,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBa,KAAK,CAACD,MAAAA,CAAAA,CACNnB,GAAG,CAACA,KACJR,KAAK,EAAA;QACR,MAAM,EAAEiB,IAAI,EAAE,GAAG,MAAM,IAAI,CAACC,KAAK,CAAC7B,OAAO,CAAIuB,CAAAA,CAAAA;QAC7C,OAAOK,IAAAA;AACT,IAAA;IAEA,MAAaY,MAAAA,CAAOtB,cAA+B,EAAiB;AAClE,QAAA,MAAMC,MAAM,IAAI,CAACF,QAAQ,CAACC,gBAAgBP,KAAK,EAAA;AAC/C,QAAA,MAAMY,CAAAA,GAAI,IAAIC,mBAAAA,EAAAA,CACXC,IAAI,CAAC,IAAI,CAACC,QAAQ,CAAA,CAClBc,MAAM,EAAA,CACNrB,GAAG,CAACA,KACJR,KAAK,EAAA;AACR,QAAA,MAAM,IAAI,CAACkB,KAAK,CAAC7B,OAAO,CAACuB,CAAAA,CAAAA;AAC3B,IAAA;AAnHA;;;;;;;;;;;;;AAaC,MACD,WAAA,CACmBM,KAAoB,EACrC,YAAqC,EACpBH,QAAAA,GAAW,IAAIF,mBAAAA,EAAAA,CAAyBb,KAAK,EAAE,CAChE;;;;aAHiBkB,KAAAA,GAAAA,KAAAA;aACAT,YAAAA,GAAAA,YAAAA;aACAM,QAAAA,GAAAA,QAAAA;AAChB,IAAA;AAkGL;;;;"}

package/dist/service/restful-create.d.mts

@@ -1,3 +1,20 @@
+/**
+ * A service that can be used to create resources.
+ *
+ * @param T -
+ *        The type of resource being created.
+ */
 export interface IZRestfulCreate<T> {
+    /**
+     * Creates a new entity.
+     *
+     * This uses a POST verb.
+     *
+     * @param body -
+     *        The post body that represents the resource to create.
+     *
+     * @returns
+     *        The resource that was created.
+     */
     create(body: T): Promise<T>;
 }

package/dist/service/restful-delete.d.mts

@@ -1,3 +1,14 @@
+/**
+ * A service that can be used to delete resources.
+ */
 export interface IZRestfulDelete {
+    /**
+     * Deletes a resource entity.
+     *
+     * This uses the DELETE verb.
+     *
+     * @param identification -
+     *        The identification of the resource to delete.
+     */
     delete(identification: string): Promise<void>;
 }

package/dist/service/restful-get.d.mts

@@ -1,3 +1,20 @@
+/**
+ * A service that can be used to get resources.
+ *
+ * @param T -
+ *        The type of resource being retrieved.
+ */
 export interface IZRestfulGet<T> {
+    /**
+     * Retrieves a single item by it's identification.
+     *
+     * This uses a GET verb.
+     *
+     * @param identification -
+     *        The identification of the resource to retrieve.
+     *
+     * @returns
+     *        The json representation of the entity.
+     */
     get(identification: number | string): Promise<T>;
 }

package/dist/service/restful-service.d.mts

@@ -6,13 +6,53 @@ import { IZRestfulDelete } from './restful-delete.mjs';
 import { IZRestfulGet } from './restful-get.mjs';
 import { IZRestfulUpdate } from './restful-update.mjs';
 import { IZRestfulUpsert } from './restful-upsert.mjs';
+/**
+ * A service that conforms to all known restful standards.
+ *
+ * @param T -
+ *        The type of resource being retrieved or mutated.
+ */
 export interface IZRestfulService<T> extends IZRestfulCreate<T>, IZRestfulDelete, IZRestfulGet<T>, IZRestfulUpdate<T>, IZRestfulUpdate<T>, IZRestfulUpsert<T>, IZDataSource<T> {
 }
+/**
+ * A generic implementation of a restful service that assumes all verbs are implemented.
+ *
+ * This can be used to invoke a service that is only partially implemented.  If your service,
+ * for example, is read only, then create, upsert, update, and delete should all return
+ * not found or forbidden errors.
+ *
+ * @param T -
+ *        The type of resource being retrieved or mutated.
+ */
 export declare class ZRestfulService<T> implements IZRestfulService<T> {
     private readonly _http;
     private readonly _endpointUrl;
     private readonly _request;
+    /**
+     * Initializes a new instance of this object.
+     *
+     * @param _http -
+     *        The http service to use when invoking the RESTful service.
+     * @param _endpointUrl -
+     *        The root url of the endpoint to hit.  This can include params
+     *        to send them with every request, but standard params of page,
+     *        size, search, filter, and sort will be overridden depending on
+     *        which method is being invoked.
+     * @param _request -
+     *        The base request to use when constructing requests in the http
+     *        service.
+     */
     constructor(_http: IZHttpService, _endpointUrl: string, _request?: import('@zthun/webigail-http').IZHttpRequest<any>);
+    /**
+     * Gets the final endpoint for a resource.
+     *
+     * @param identification -
+     *        The identification of a single resource.  If this is falsy, then
+     *        the entire data scope is used.
+     *
+     * @returns
+     *        A url builder that points to the target resource endpoint.
+     */
     endpoint(identification?: number | string): ZUrlBuilder;
     count(req: IZDataRequest): Promise<number>;
     retrieve(req: IZDataRequest): Promise<T[]>;

package/dist/service/restful-update.d.mts

@@ -1,3 +1,22 @@
+/**
+ * A restful service that can update resources.
+ *
+ * @param T -
+ *        The type of resource being updated.
+ */
 export interface IZRestfulUpdate<T> {
+    /**
+     * Partially updates an existing resource entity.
+     *
+     * This uses the PATCH verb.
+     *
+     * @param identification -
+     *        The identification of the resource to update.
+     * @param fields -
+     *        The partial fields to update.
+     *
+     * @returns
+     *        The resource that was updated.
+     */
     update(identification: string, fields: Partial<T>): Promise<T>;
 }

package/dist/service/restful-upsert.d.mts

@@ -1,3 +1,24 @@
+/**
+ * A restful service that can upsert resources.
+ *
+ * @param T -
+ *        The type of resource being created/updated.
+ */
 export interface IZRestfulUpsert<T> {
+    /**
+     * Creates a new entity or updates an existing entity.
+     *
+     * This is determined by the body parameters on whether
+     * or not an entity already exists.
+     *
+     * This uses the PUT verb.
+     *
+     * @param body -
+     *        The post body that represents the resource to create
+     *        or update.
+     *
+     * @returns
+     *        The resource that was created or updated.
+     */
     upsert(body: T): Promise<T>;
 }

package/dist/url/restful-url.d.mts

@@ -1,8 +1,39 @@
 import { IZDataRequest } from '@zthun/helpful-query';
+/**
+ * Represents a decorator that can build a url for a restful endpoint
+ * given an existing base url.
+ */
 export declare class ZRestfulUrlBuilder {
     private _url;
+    /**
+     * Initializes a new instance of this object.
+     */
     constructor(baseUrl: string);
+    /**
+     * Adds the request parameters to the url.
+     *
+     * This will add the page, size, search, filter, and sort parameters to the url if they are defined.
+     *
+     * @param request -
+     *        The request to add to the url.
+     * @returns
+     *        This object.
+     */
     from(request: IZDataRequest): this;
+    /**
+     * Updates the url to optimize to retrieve a count.
+     *
+     * This will add the size and page parameters to the url and remove the sort parameter.
+     *
+     * @returns
+     *        This object.
+     */
     count(): this;
+    /**
+     * Returns the built url.
+     *
+     * @returns
+     *      The built url.
+     */
     build(): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zthun/webigail-rest",
-  "version": "5.0.1",
+  "version": "5.0.3",
   "description": "Helpful services for querying rest services based on specific standards.",
   "author": "Anthony Bonta",
   "license": "MIT",
@@ -25,19 +25,21 @@
     "access": "public"
   },
   "dependencies": {
-    "@zthun/helpful-fn": "^9.10.1",
-    "@zthun/helpful-query": "^9.10.1",
-    "@zthun/webigail-http": "^5.0.1",
-    "@zthun/webigail-url": "^5.0.1"
+    "@zthun/helpful-fn": "^9.11.2",
+    "@zthun/helpful-query": "^9.11.2",
+    "@zthun/webigail-http": "^5.0.3",
+    "@zthun/webigail-url": "^5.0.3"
   },
   "devDependencies": {
-    "@zthun/janitor-build-config": "^19.4.2",
-    "vite": "^7.1.12",
-    "vitest": "^4.0.5"
+    "@zthun/janitor-build-config": "^19.5.4",
+    "@zthun/janitor-ts-config": "^19.5.3",
+    "typescript": "~5.9.3",
+    "vite": "^7.3.0",
+    "vitest": "^4.0.16"
   },
   "files": [
     "dist"
   ],
   "sideEffects": false,
-  "gitHead": "bbaa81daa0d781b809ea5b4eb4395c7bac635436"
+  "gitHead": "72e9e39897db1a5105194b6b40d5060e537a0a55"
 }