@zthun/webigail-rest 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Anthony Bonta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# Webigail REST
+
+Contains services and classes that help with querying REST services based on specific standards.
+
+## Build Status
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/zthun/webigail/tree/latest.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/zthun/webigail/tree/latest)
+
+## Usage
+
+Webigail is built in TypeScript and it exports both ESM and CJS modules.
+
+```sh
+# NPM
+npm install @zthun/webigail-rest
+# Yarn
+yarn add @zthun/webigail-rest
+```
+
+```ts
+import { ZDataRequestBuilder } from '@zthun/helpful-query';
+import { ZHttpService } from '@zthun/webigail-http';
+import { ZRestfulService } from '@zthun/webigail-rest';
+
+const endpoint = 'https://pokeapi.co/api/v2/pokemon-species';
+const service = new ZRestfulService(new ZHttpService(), endpoint);
+
+// Note that the following 2 requests have the expectation that the result for the
+// API is in the form of { count, data } or { count, result };
+// Counts the resources that match the request - uses GET verb
+service.count(new ZDataRequestBuilder().search('bulbasaur').build()).then((count) => console.log(count));
+// Get a page of resources - uses GET verb
+service.request(new ZDataRequestBuilder().page(1).size(50).build()).then((page) => console.log(page));
+
+// Get a single resource - uses GET verb
+service.get('ditto').then((ditto) => console.log(ditto));
+
+// Note:  The pokemon API is read only, but these would still invoke the endpoint with the given verbs
+// The would just fail with 404s, but these are here to illustrate the usage of a full rest service.
+// There is also an assumption that the return values on the services return the data that was mutated.
+// Delete is assumed to return a 204 - No Content if successful.
+
+// Create a new resource - uses POST verb
+service.create({ name: 'not-really-a-pokemon' }).then((created) => console.log(created));
+// Upsert a resource - Creates if not exists, updates if exists - uses PUT verb
+service.upsert({ id: 'missing-no', name: 'MissingNo' }).then((upserted) => console.log(upserted));
+// Updates a resource - uses PATCH verb
+service.update('pikachu', { name: 'Pika-who?' }).then((updated) => console.log(updated));
+// Deletes a resource - uses DELETE verb
+service.delete('pikachu').then(() => console.log('Pikachu has fainted from existence'));
+```

package/dist/index.cjs

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const webigailHttp = require("@zthun/webigail-http");
+const webigailUrl = require("@zthun/webigail-url");
+class ZRestfulService {
+  /**
+   * 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, _endpointUrl, _request = new webigailHttp.ZHttpRequestBuilder().build()) {
+    this._http = _http;
+    this._endpointUrl = _endpointUrl;
+    this._request = _request;
+  }
+  /**
+   * 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) {
+    const url = new webigailUrl.ZUrlBuilder().parse(this._endpointUrl);
+    return identification ? url.append(`${identification}`) : url;
+  }
+  async count(req) {
+    const url = this.endpoint().page(1).size(1).search(req.search).build();
+    const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).get().url(url).build();
+    const { data: page } = await this._http.request(r);
+    return page.count;
+  }
+  async retrieve(req) {
+    const url = this.endpoint().page(req.page).size(req.size).search(req.search).build();
+    const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).get().url(url).build();
+    const { data: page } = await this._http.request(r);
+    return page.data ?? page.result;
+  }
+  async get(identification) {
+    const url = this.endpoint(identification).build();
+    const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).get().url(url).build();
+    const { data } = await this._http.request(r);
+    return data;
+  }
+  async create(body) {
+    const url = this.endpoint().build();
+    const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).post(body).url(url).build();
+    const { data } = await this._http.request(r);
+    return data;
+  }
+  async upsert(body) {
+    const url = this.endpoint().build();
+    const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).put(body).url(url).build();
+    const { data } = await this._http.request(r);
+    return data;
+  }
+  async update(identification, fields) {
+    const url = this.endpoint(identification).build();
+    const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).patch(fields).url(url).build();
+    const { data } = await this._http.request(r);
+    return data;
+  }
+  async delete(identification) {
+    const url = this.endpoint(identification).build();
+    const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).delete().url(url).build();
+    await this._http.request(r);
+  }
+}
+exports.ZRestfulService = ZRestfulService;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/service/restful-service.mts"],"sourcesContent":["import { IZDataRequest, IZDataSource } from '@zthun/helpful-query';\nimport { IZHttpService, ZHttpRequestBuilder } from '@zthun/webigail-http';\nimport { ZUrlBuilder } from '@zthun/webigail-url';\n\n/**\n * A service that conforms to restful standards.\n */\nexport interface IZRestfulService<T> extends IZDataSource<T> {\n  /**\n   * Retrieves a single item by it's identification.\n   *\n   * This uses a GET verb.\n   *\n   * @param identification -\n   *        The identification of the resource to retrieve.\n   *\n   * @returns\n   *        The json representation of the entity.\n   */\n  get(identification: number | string): Promise<T>;\n\n  /**\n   * Creates a new entity.\n   *\n   * This uses a POST verb.\n   *\n   * @param body -\n   *        The post body that represents the resource to create.\n   *\n   * @returns\n   *        The resource that was created.\n   */\n  create(body: T): Promise<T>;\n\n  /**\n   * Creates a new entity or updates an existing entity.\n   *\n   * This is determined by the body parameters on whether\n   * or not an entity already exists.\n   *\n   * This uses the PUT verb.\n   *\n   * @param body -\n   *        The post body that represents the resource to create\n   *        or update.\n   *\n   * @returns\n   *        The resource that was created or updated.\n   */\n  upsert(body: T): Promise<T>;\n\n  /**\n   * Partially updates an existing resource entity.\n   *\n   * This uses the PATCH verb.\n   *\n   * @param identification -\n   *        The identification of the resource to update.\n   * @param fields -\n   *        The partial fields to update.\n   *\n   * @returns\n   *        The resource that was updated.\n   */\n  update(identification: string, fields: Partial<T>): Promise<T>;\n\n  /**\n   * Deletes a resource entity.\n   *\n   * This uses the DELETE verb.\n   *\n   * @param identification -\n   *        The identification of the resource to delete.\n   */\n  delete(identification: string): Promise<void>;\n}\n\n/**\n * A factory for constructing basic http request builders.\n *\n * This is used to create a common construction for http requests\n * that contain common options like headers and timeouts.\n */\nexport type ZHttpRequestFactory = () => ZHttpRequestBuilder;\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 */\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 url = this.endpoint().page(1).size(1).search(req.search).build();\n    const r = new ZHttpRequestBuilder().copy(this._request).get().url(url).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 url = this.endpoint().page(req.page).size(req.size).search(req.search).build();\n    const r = new ZHttpRequestBuilder().copy(this._request).get().url(url).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().copy(this._request).get().url(url).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>().copy(this._request).post(body).url(url).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>().copy(this._request).put(body).url(url).build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async update(identification: number | string, fields: Partial<T>): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<Partial<T>>().copy(this._request).patch(fields).url(url).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>().copy(this._request).delete().url(url).build();\n    await this._http.request(r);\n  }\n}\n"],"names":["ZHttpRequestBuilder","ZUrlBuilder"],"mappings":";;;;AA4FO,MAAM,gBAAkD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAetD,YACY,OACA,cACA,WAAW,IAAIA,aAAuB,oBAAA,EAAE,SACzD;AAHiB,SAAA,QAAA;AACA,SAAA,eAAA;AACA,SAAA,WAAA;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYI,SAAS,gBAAkC;AAChD,UAAM,MAAM,IAAIC,YAAA,YAAA,EAAc,MAAM,KAAK,YAAY;AACrD,WAAO,iBAAiB,IAAI,OAAO,GAAG,cAAc,EAAE,IAAI;AAAA,EAC5D;AAAA,EAEA,MAAa,MAAM,KAAqC;AACtD,UAAM,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM;AACrE,UAAM,IAAI,IAAID,aAAAA,sBAAsB,KAAK,KAAK,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AACvE,UAAA,EAAE,MAAM,SAAS,MAAM,KAAK,MAAM,QAAa,CAAC;AACtD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAa,SAAS,KAAkC;AACtD,UAAM,MAAM,KAAK,SAAW,EAAA,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,OAAO,IAAI,MAAM,EAAE;AAC7E,UAAM,IAAI,IAAIA,aAAAA,sBAAsB,KAAK,KAAK,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AACvE,UAAA,EAAE,MAAM,SAAS,MAAM,KAAK,MAAM,QAAa,CAAC;AAC/C,WAAA,KAAK,QAAQ,KAAK;AAAA,EAC3B;AAAA,EAEA,MAAa,IAAI,gBAA6C;AAC5D,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAIA,aAAAA,sBAAsB,KAAK,KAAK,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AAC7E,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OAAO,MAAqB;AACvC,UAAM,MAAM,KAAK,SAAS,EAAE,MAAM;AAClC,UAAM,IAAI,IAAIA,aAAAA,oBAAuB,EAAE,KAAK,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AACrF,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OAAO,MAAqB;AACvC,UAAM,MAAM,KAAK,SAAS,EAAE,MAAM;AAClC,UAAM,IAAI,IAAIA,aAAAA,oBAAuB,EAAE,KAAK,KAAK,QAAQ,EAAE,IAAI,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AACpF,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OAAO,gBAAiC,QAAgC;AACnF,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAIA,aAAAA,oBAAgC,EAAE,KAAK,KAAK,QAAQ,EAAE,MAAM,MAAM,EAAE,IAAI,GAAG,EAAE,MAAM;AACjG,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OAAO,gBAAgD;AAClE,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAIA,aAAAA,sBAAiC,KAAK,KAAK,QAAQ,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,MAAM;AACrF,UAAA,KAAK,MAAM,QAAQ,CAAC;AAAA,EAC5B;AACF;;"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './service/restful-service.mjs';

package/dist/index.js

@@ -0,0 +1,82 @@
+import { ZHttpRequestBuilder } from "@zthun/webigail-http";
+import { ZUrlBuilder } from "@zthun/webigail-url";
+class ZRestfulService {
+  /**
+   * 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, _endpointUrl, _request = new ZHttpRequestBuilder().build()) {
+    this._http = _http;
+    this._endpointUrl = _endpointUrl;
+    this._request = _request;
+  }
+  /**
+   * 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) {
+    const url = new ZUrlBuilder().parse(this._endpointUrl);
+    return identification ? url.append(`${identification}`) : url;
+  }
+  async count(req) {
+    const url = this.endpoint().page(1).size(1).search(req.search).build();
+    const r = new ZHttpRequestBuilder().copy(this._request).get().url(url).build();
+    const { data: page } = await this._http.request(r);
+    return page.count;
+  }
+  async retrieve(req) {
+    const url = this.endpoint().page(req.page).size(req.size).search(req.search).build();
+    const r = new ZHttpRequestBuilder().copy(this._request).get().url(url).build();
+    const { data: page } = await this._http.request(r);
+    return page.data ?? page.result;
+  }
+  async get(identification) {
+    const url = this.endpoint(identification).build();
+    const r = new ZHttpRequestBuilder().copy(this._request).get().url(url).build();
+    const { data } = await this._http.request(r);
+    return data;
+  }
+  async create(body) {
+    const url = this.endpoint().build();
+    const r = new ZHttpRequestBuilder().copy(this._request).post(body).url(url).build();
+    const { data } = await this._http.request(r);
+    return data;
+  }
+  async upsert(body) {
+    const url = this.endpoint().build();
+    const r = new ZHttpRequestBuilder().copy(this._request).put(body).url(url).build();
+    const { data } = await this._http.request(r);
+    return data;
+  }
+  async update(identification, fields) {
+    const url = this.endpoint(identification).build();
+    const r = new ZHttpRequestBuilder().copy(this._request).patch(fields).url(url).build();
+    const { data } = await this._http.request(r);
+    return data;
+  }
+  async delete(identification) {
+    const url = this.endpoint(identification).build();
+    const r = new ZHttpRequestBuilder().copy(this._request).delete().url(url).build();
+    await this._http.request(r);
+  }
+}
+export {
+  ZRestfulService
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/service/restful-service.mts"],"sourcesContent":["import { IZDataRequest, IZDataSource } from '@zthun/helpful-query';\nimport { IZHttpService, ZHttpRequestBuilder } from '@zthun/webigail-http';\nimport { ZUrlBuilder } from '@zthun/webigail-url';\n\n/**\n * A service that conforms to restful standards.\n */\nexport interface IZRestfulService<T> extends IZDataSource<T> {\n  /**\n   * Retrieves a single item by it's identification.\n   *\n   * This uses a GET verb.\n   *\n   * @param identification -\n   *        The identification of the resource to retrieve.\n   *\n   * @returns\n   *        The json representation of the entity.\n   */\n  get(identification: number | string): Promise<T>;\n\n  /**\n   * Creates a new entity.\n   *\n   * This uses a POST verb.\n   *\n   * @param body -\n   *        The post body that represents the resource to create.\n   *\n   * @returns\n   *        The resource that was created.\n   */\n  create(body: T): Promise<T>;\n\n  /**\n   * Creates a new entity or updates an existing entity.\n   *\n   * This is determined by the body parameters on whether\n   * or not an entity already exists.\n   *\n   * This uses the PUT verb.\n   *\n   * @param body -\n   *        The post body that represents the resource to create\n   *        or update.\n   *\n   * @returns\n   *        The resource that was created or updated.\n   */\n  upsert(body: T): Promise<T>;\n\n  /**\n   * Partially updates an existing resource entity.\n   *\n   * This uses the PATCH verb.\n   *\n   * @param identification -\n   *        The identification of the resource to update.\n   * @param fields -\n   *        The partial fields to update.\n   *\n   * @returns\n   *        The resource that was updated.\n   */\n  update(identification: string, fields: Partial<T>): Promise<T>;\n\n  /**\n   * Deletes a resource entity.\n   *\n   * This uses the DELETE verb.\n   *\n   * @param identification -\n   *        The identification of the resource to delete.\n   */\n  delete(identification: string): Promise<void>;\n}\n\n/**\n * A factory for constructing basic http request builders.\n *\n * This is used to create a common construction for http requests\n * that contain common options like headers and timeouts.\n */\nexport type ZHttpRequestFactory = () => ZHttpRequestBuilder;\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 */\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 url = this.endpoint().page(1).size(1).search(req.search).build();\n    const r = new ZHttpRequestBuilder().copy(this._request).get().url(url).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 url = this.endpoint().page(req.page).size(req.size).search(req.search).build();\n    const r = new ZHttpRequestBuilder().copy(this._request).get().url(url).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().copy(this._request).get().url(url).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>().copy(this._request).post(body).url(url).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>().copy(this._request).put(body).url(url).build();\n    const { data } = await this._http.request<T>(r);\n    return data;\n  }\n\n  public async update(identification: number | string, fields: Partial<T>): Promise<T> {\n    const url = this.endpoint(identification).build();\n    const r = new ZHttpRequestBuilder<Partial<T>>().copy(this._request).patch(fields).url(url).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>().copy(this._request).delete().url(url).build();\n    await this._http.request(r);\n  }\n}\n"],"names":[],"mappings":";;AA4FO,MAAM,gBAAkD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAetD,YACY,OACA,cACA,WAAW,IAAI,oBAAuB,EAAE,SACzD;AAHiB,SAAA,QAAA;AACA,SAAA,eAAA;AACA,SAAA,WAAA;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYI,SAAS,gBAAkC;AAChD,UAAM,MAAM,IAAI,YAAA,EAAc,MAAM,KAAK,YAAY;AACrD,WAAO,iBAAiB,IAAI,OAAO,GAAG,cAAc,EAAE,IAAI;AAAA,EAC5D;AAAA,EAEA,MAAa,MAAM,KAAqC;AACtD,UAAM,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM;AACrE,UAAM,IAAI,IAAI,sBAAsB,KAAK,KAAK,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AACvE,UAAA,EAAE,MAAM,SAAS,MAAM,KAAK,MAAM,QAAa,CAAC;AACtD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAa,SAAS,KAAkC;AACtD,UAAM,MAAM,KAAK,SAAW,EAAA,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,OAAO,IAAI,MAAM,EAAE;AAC7E,UAAM,IAAI,IAAI,sBAAsB,KAAK,KAAK,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AACvE,UAAA,EAAE,MAAM,SAAS,MAAM,KAAK,MAAM,QAAa,CAAC;AAC/C,WAAA,KAAK,QAAQ,KAAK;AAAA,EAC3B;AAAA,EAEA,MAAa,IAAI,gBAA6C;AAC5D,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAI,sBAAsB,KAAK,KAAK,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AAC7E,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OAAO,MAAqB;AACvC,UAAM,MAAM,KAAK,SAAS,EAAE,MAAM;AAClC,UAAM,IAAI,IAAI,oBAAuB,EAAE,KAAK,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AACrF,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OAAO,MAAqB;AACvC,UAAM,MAAM,KAAK,SAAS,EAAE,MAAM;AAClC,UAAM,IAAI,IAAI,oBAAuB,EAAE,KAAK,KAAK,QAAQ,EAAE,IAAI,IAAI,EAAE,IAAI,GAAG,EAAE,MAAM;AACpF,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OAAO,gBAAiC,QAAgC;AACnF,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAI,oBAAgC,EAAE,KAAK,KAAK,QAAQ,EAAE,MAAM,MAAM,EAAE,IAAI,GAAG,EAAE,MAAM;AACjG,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OAAO,gBAAgD;AAClE,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAI,sBAAiC,KAAK,KAAK,QAAQ,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,MAAM;AACrF,UAAA,KAAK,MAAM,QAAQ,CAAC;AAAA,EAC5B;AACF;"}

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

@@ -0,0 +1,25 @@
+import { IZDataRequest, IZDataSource } from '@zthun/helpful-query';
+import { IZHttpService, ZHttpRequestBuilder } from '@zthun/webigail-http';
+import { ZUrlBuilder } from '@zthun/webigail-url';
+export interface IZRestfulService<T> extends IZDataSource<T> {
+    get(identification: number | string): Promise<T>;
+    create(body: T): Promise<T>;
+    upsert(body: T): Promise<T>;
+    update(identification: string, fields: Partial<T>): Promise<T>;
+    delete(identification: string): Promise<void>;
+}
+export type ZHttpRequestFactory = () => ZHttpRequestBuilder;
+export declare class ZRestfulService<T> implements IZRestfulService<T> {
+    private readonly _http;
+    private readonly _endpointUrl;
+    private readonly _request;
+    constructor(_http: IZHttpService, _endpointUrl: string, _request?: import("@zthun/webigail-http").IZHttpRequest<any>);
+    endpoint(identification?: number | string): ZUrlBuilder;
+    count(req: IZDataRequest): Promise<number>;
+    retrieve(req: IZDataRequest): Promise<T[]>;
+    get(identification: number | string): Promise<T>;
+    create(body: T): Promise<T>;
+    upsert(body: T): Promise<T>;
+    update(identification: number | string, fields: Partial<T>): Promise<T>;
+    delete(identification: number | string): Promise<void>;
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@zthun/webigail-rest",
+  "version": "2.1.0",
+  "description": "Helpful services for querying rest services based on specific standards.",
+  "author": "Anthony Bonta",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zthun/webigail",
+    "directory": "packages/webigail-rest"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs",
+    "types": "./dist/index.d.ts"
+  },
+  "type": "module",
+  "scripts": {
+    "build": "vite build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "vite": "^5.0.12",
+    "vitest": "^1.2.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@zthun/helpful-fn": "^3.2.0",
+    "@zthun/helpful-query": "^3.2.0",
+    "@zthun/webigail-http": "^2.1.0",
+    "@zthun/webigail-url": "^2.1.0"
+  },
+  "sideEffects": false,
+  "gitHead": "a013c6401a9b2cca4bfc113987c09d3f2f23ed44"
+}