@zthun/webigail-rest 2.4.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # Webigail REST
2
2
 
3
- Contains services and classes that help with querying REST services based on specific standards.
3
+ Contains services and classes that help with querying REST services based on
4
+ specific standards.
4
5
 
5
6
  ## Build Status
6
7
 
@@ -18,22 +19,26 @@ yarn add @zthun/webigail-rest
18
19
  ```
19
20
 
20
21
  ```ts
21
- import { ZDataRequestBuilder } from '@zthun/helpful-query';
22
- import { ZHttpService } from '@zthun/webigail-http';
23
- import { ZRestfulService } from '@zthun/webigail-rest';
22
+ import { ZDataRequestBuilder } from "@zthun/helpful-query";
23
+ import { ZHttpService } from "@zthun/webigail-http";
24
+ import { ZRestfulService } from "@zthun/webigail-rest";
24
25
 
25
- const endpoint = 'https://pokeapi.co/api/v2/pokemon-species';
26
+ const endpoint = "https://pokeapi.co/api/v2/pokemon-species";
26
27
  const service = new ZRestfulService(new ZHttpService(), endpoint);
27
28
 
28
29
  // Note that the following 2 requests have the expectation that the result for the
29
30
  // API is in the form of { count, data } or { count, result };
30
31
  // Counts the resources that match the request - uses GET verb
31
- service.count(new ZDataRequestBuilder().search('bulbasaur').build()).then((count) => console.log(count));
32
+ service
33
+ .count(new ZDataRequestBuilder().search("bulbasaur").build())
34
+ .then((count) => console.log(count));
32
35
  // Get a page of resources - uses GET verb
33
- service.request(new ZDataRequestBuilder().page(1).size(50).build()).then((page) => console.log(page));
36
+ service
37
+ .request(new ZDataRequestBuilder().page(1).size(50).build())
38
+ .then((page) => console.log(page));
34
39
 
35
40
  // Get a single resource - uses GET verb
36
- service.get('ditto').then((ditto) => console.log(ditto));
41
+ service.get("ditto").then((ditto) => console.log(ditto));
37
42
 
38
43
  // Note: The pokemon API is read only, but these would still invoke the endpoint with the given verbs
39
44
  // The would just fail with 404s, but these are here to illustrate the usage of a full rest service.
@@ -41,11 +46,19 @@ service.get('ditto').then((ditto) => console.log(ditto));
41
46
  // Delete is assumed to return a 204 - No Content if successful.
42
47
 
43
48
  // Create a new resource - uses POST verb
44
- service.create({ name: 'not-really-a-pokemon' }).then((created) => console.log(created));
49
+ service
50
+ .create({ name: "not-really-a-pokemon" })
51
+ .then((created) => console.log(created));
45
52
  // Upsert a resource - Creates if not exists, updates if exists - uses PUT verb
46
- service.upsert({ id: 'missing-no', name: 'MissingNo' }).then((upserted) => console.log(upserted));
53
+ service
54
+ .upsert({ id: "missing-no", name: "MissingNo" })
55
+ .then((upserted) => console.log(upserted));
47
56
  // Updates a resource - uses PATCH verb
48
- service.update('pikachu', { name: 'Pika-who?' }).then((updated) => console.log(updated));
57
+ service
58
+ .update("pikachu", { name: "Pika-who?" })
59
+ .then((updated) => console.log(updated));
49
60
  // Deletes a resource - uses DELETE verb
50
- service.delete('pikachu').then(() => console.log('Pikachu has fainted from existence'));
61
+ service
62
+ .delete("pikachu")
63
+ .then(() => console.log("Pikachu has fainted from existence"));
51
64
  ```
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","sources":["../src/service/restful-service.mts"],"sourcesContent":["import { IZDataRequest, IZDataSource, ZFilterSerialize, ZSortSerialize } from '@zthun/helpful-query';\nimport { IZHttpService, ZHttpRequestBuilder } from '@zthun/webigail-http';\nimport { ZUrlBuilder } from '@zthun/webigail-url';\nimport { IZRestfulCreate } from './restful-create.mjs';\nimport { IZRestfulDelete } from './restful-delete.mjs';\nimport { IZRestfulGet } from './restful-get.mjs';\nimport { IZRestfulUpdate } from './restful-update.mjs';\nimport { 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 filter = new ZFilterSerialize().serialize(req.filter);\n const url = this.endpoint().page(1).size(1).search(req.search).filter(filter).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 filter = new ZFilterSerialize().serialize(req.filter);\n const sort = new ZSortSerialize().serialize(req.sort);\n const url = this.endpoint().page(req.page).size(req.size).search(req.search).filter(filter).sort(sort).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","ZFilterSerialize","ZSortSerialize"],"mappings":";;;;;AAkCO,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,SAAS,IAAIC,aAAA,iBAAA,EAAmB,UAAU,IAAI,MAAM;AAC1D,UAAM,MAAM,KAAK,SAAA,EAAW,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,IAAI,MAAM,EAAE,OAAO,MAAM,EAAE;AAC9E,UAAM,IAAI,IAAIF,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,SAAS,IAAIE,aAAA,iBAAA,EAAmB,UAAU,IAAI,MAAM;AAC1D,UAAM,OAAO,IAAIC,aAAA,eAAA,EAAiB,UAAU,IAAI,IAAI;AAC9C,UAAA,MAAM,KAAK,WAAW,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,OAAO,IAAI,MAAM,EAAE,OAAO,MAAM,EAAE,KAAK,IAAI,EAAE;AACvG,UAAM,IAAI,IAAIH,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;;"}
1
+ {"version":3,"file":"index.cjs","sources":["../src/service/restful-service.mts"],"sourcesContent":["import {\n IZDataRequest,\n IZDataSource,\n ZFilterSerialize,\n ZSortSerialize,\n} from \"@zthun/helpful-query\";\nimport { IZHttpService, ZHttpRequestBuilder } from \"@zthun/webigail-http\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\nimport { IZRestfulCreate } from \"./restful-create.mjs\";\nimport { IZRestfulDelete } from \"./restful-delete.mjs\";\nimport { IZRestfulGet } from \"./restful-get.mjs\";\nimport { IZRestfulUpdate } from \"./restful-update.mjs\";\nimport { 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 filter = new ZFilterSerialize().serialize(req.filter);\n const url = this.endpoint()\n .page(1)\n .size(1)\n .search(req.search)\n .filter(filter)\n .build();\n const r = new ZHttpRequestBuilder()\n .copy(this._request)\n .get()\n .url(url)\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 filter = new ZFilterSerialize().serialize(req.filter);\n const sort = new ZSortSerialize().serialize(req.sort);\n const url = this.endpoint()\n .page(req.page)\n .size(req.size)\n .search(req.search)\n .filter(filter)\n .sort(sort)\n .build();\n const r = new ZHttpRequestBuilder()\n .copy(this._request)\n .get()\n .url(url)\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":["ZHttpRequestBuilder","ZUrlBuilder","ZFilterSerialize","ZSortSerialize"],"mappings":";;;;;AAuCO,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,SAAS,IAAIC,aAAA,iBAAA,EAAmB,UAAU,IAAI,MAAM;AAC1D,UAAM,MAAM,KAAK,SAAA,EACd,KAAK,CAAC,EACN,KAAK,CAAC,EACN,OAAO,IAAI,MAAM,EACjB,OAAO,MAAM,EACb;AACH,UAAM,IAAI,IAAIF,aAAAA,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,GAAG,EACP,MAAM;AACH,UAAA,EAAE,MAAM,SAAS,MAAM,KAAK,MAAM,QAAa,CAAC;AACtD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAa,SAAS,KAAkC;AACtD,UAAM,SAAS,IAAIE,aAAA,iBAAA,EAAmB,UAAU,IAAI,MAAM;AAC1D,UAAM,OAAO,IAAIC,aAAA,eAAA,EAAiB,UAAU,IAAI,IAAI;AAC9C,UAAA,MAAM,KAAK,WACd,KAAK,IAAI,IAAI,EACb,KAAK,IAAI,IAAI,EACb,OAAO,IAAI,MAAM,EACjB,OAAO,MAAM,EACb,KAAK,IAAI,EACT;AACH,UAAM,IAAI,IAAIH,aAAAA,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,GAAG,EACP,MAAM;AACH,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,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,GAAG,EACP,MAAM;AACT,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,EAClC,KAAK,KAAK,QAAQ,EAClB,KAAK,IAAI,EACT,IAAI,GAAG,EACP,MAAM;AACT,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,EAClC,KAAK,KAAK,QAAQ,EAClB,IAAI,IAAI,EACR,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OACX,gBACA,QACY;AACZ,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAIA,aAAAA,oBAAgC,EAC3C,KAAK,KAAK,QAAQ,EAClB,MAAM,MAAM,EACZ,IAAI,GAAG,EACP,MAAM;AACT,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,sBACX,KAAK,KAAK,QAAQ,EAClB,OAAO,EACP,IAAI,GAAG,EACP,MAAM;AACH,UAAA,KAAK,MAAM,QAAQ,CAAC;AAAA,EAC5B;AACF;;"}
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":["../src/service/restful-service.mts"],"sourcesContent":["import { IZDataRequest, IZDataSource, ZFilterSerialize, ZSortSerialize } from '@zthun/helpful-query';\nimport { IZHttpService, ZHttpRequestBuilder } from '@zthun/webigail-http';\nimport { ZUrlBuilder } from '@zthun/webigail-url';\nimport { IZRestfulCreate } from './restful-create.mjs';\nimport { IZRestfulDelete } from './restful-delete.mjs';\nimport { IZRestfulGet } from './restful-get.mjs';\nimport { IZRestfulUpdate } from './restful-update.mjs';\nimport { 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 filter = new ZFilterSerialize().serialize(req.filter);\n const url = this.endpoint().page(1).size(1).search(req.search).filter(filter).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 filter = new ZFilterSerialize().serialize(req.filter);\n const sort = new ZSortSerialize().serialize(req.sort);\n const url = this.endpoint().page(req.page).size(req.size).search(req.search).filter(filter).sort(sort).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":";;;AAkCO,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,SAAS,IAAI,iBAAA,EAAmB,UAAU,IAAI,MAAM;AAC1D,UAAM,MAAM,KAAK,SAAA,EAAW,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,IAAI,MAAM,EAAE,OAAO,MAAM,EAAE;AAC9E,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,SAAS,IAAI,iBAAA,EAAmB,UAAU,IAAI,MAAM;AAC1D,UAAM,OAAO,IAAI,eAAA,EAAiB,UAAU,IAAI,IAAI;AAC9C,UAAA,MAAM,KAAK,WAAW,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,OAAO,IAAI,MAAM,EAAE,OAAO,MAAM,EAAE,KAAK,IAAI,EAAE;AACvG,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;"}
1
+ {"version":3,"file":"index.js","sources":["../src/service/restful-service.mts"],"sourcesContent":["import {\n IZDataRequest,\n IZDataSource,\n ZFilterSerialize,\n ZSortSerialize,\n} from \"@zthun/helpful-query\";\nimport { IZHttpService, ZHttpRequestBuilder } from \"@zthun/webigail-http\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\nimport { IZRestfulCreate } from \"./restful-create.mjs\";\nimport { IZRestfulDelete } from \"./restful-delete.mjs\";\nimport { IZRestfulGet } from \"./restful-get.mjs\";\nimport { IZRestfulUpdate } from \"./restful-update.mjs\";\nimport { 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 filter = new ZFilterSerialize().serialize(req.filter);\n const url = this.endpoint()\n .page(1)\n .size(1)\n .search(req.search)\n .filter(filter)\n .build();\n const r = new ZHttpRequestBuilder()\n .copy(this._request)\n .get()\n .url(url)\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 filter = new ZFilterSerialize().serialize(req.filter);\n const sort = new ZSortSerialize().serialize(req.sort);\n const url = this.endpoint()\n .page(req.page)\n .size(req.size)\n .search(req.search)\n .filter(filter)\n .sort(sort)\n .build();\n const r = new ZHttpRequestBuilder()\n .copy(this._request)\n .get()\n .url(url)\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":[],"mappings":";;;AAuCO,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,SAAS,IAAI,iBAAA,EAAmB,UAAU,IAAI,MAAM;AAC1D,UAAM,MAAM,KAAK,SAAA,EACd,KAAK,CAAC,EACN,KAAK,CAAC,EACN,OAAO,IAAI,MAAM,EACjB,OAAO,MAAM,EACb;AACH,UAAM,IAAI,IAAI,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,GAAG,EACP,MAAM;AACH,UAAA,EAAE,MAAM,SAAS,MAAM,KAAK,MAAM,QAAa,CAAC;AACtD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAa,SAAS,KAAkC;AACtD,UAAM,SAAS,IAAI,iBAAA,EAAmB,UAAU,IAAI,MAAM;AAC1D,UAAM,OAAO,IAAI,eAAA,EAAiB,UAAU,IAAI,IAAI;AAC9C,UAAA,MAAM,KAAK,WACd,KAAK,IAAI,IAAI,EACb,KAAK,IAAI,IAAI,EACb,OAAO,IAAI,MAAM,EACjB,OAAO,MAAM,EACb,KAAK,IAAI,EACT;AACH,UAAM,IAAI,IAAI,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,GAAG,EACP,MAAM;AACH,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,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,GAAG,EACP,MAAM;AACT,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,EAClC,KAAK,KAAK,QAAQ,EAClB,KAAK,IAAI,EACT,IAAI,GAAG,EACP,MAAM;AACT,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,EAClC,KAAK,KAAK,QAAQ,EAClB,IAAI,IAAI,EACR,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EACT;AAAA,EAEA,MAAa,OACX,gBACA,QACY;AACZ,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAI,oBAAgC,EAC3C,KAAK,KAAK,QAAQ,EAClB,MAAM,MAAM,EACZ,IAAI,GAAG,EACP,MAAM;AACT,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,sBACX,KAAK,KAAK,QAAQ,EAClB,OAAO,EACP,IAAI,GAAG,EACP,MAAM;AACH,UAAA,KAAK,MAAM,QAAQ,CAAC;AAAA,EAC5B;AACF;"}
@@ -6,7 +6,6 @@ import { IZRestfulDelete } from './restful-delete.mjs';
6
6
  import { IZRestfulGet } from './restful-get.mjs';
7
7
  import { IZRestfulUpdate } from './restful-update.mjs';
8
8
  import { IZRestfulUpsert } from './restful-upsert.mjs';
9
-
10
9
  export interface IZRestfulService<T> extends IZRestfulCreate<T>, IZRestfulDelete, IZRestfulGet<T>, IZRestfulUpdate<T>, IZRestfulUpdate<T>, IZRestfulUpsert<T>, IZDataSource<T> {
11
10
  }
12
11
  export declare class ZRestfulService<T> implements IZRestfulService<T> {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zthun/webigail-rest",
3
- "version": "2.4.1",
3
+ "version": "3.0.0",
4
4
  "description": "Helpful services for querying rest services based on specific standards.",
5
5
  "author": "Anthony Bonta",
6
6
  "license": "MIT",
@@ -25,18 +25,18 @@
25
25
  "access": "public"
26
26
  },
27
27
  "devDependencies": {
28
- "vite": "^5.3.3",
29
- "vitest": "^2.0.2"
28
+ "vite": "^5.4.10",
29
+ "vitest": "^2.1.4"
30
30
  },
31
31
  "files": [
32
32
  "dist"
33
33
  ],
34
34
  "dependencies": {
35
- "@zthun/helpful-fn": "^5.0.3",
36
- "@zthun/helpful-query": "^5.0.3",
37
- "@zthun/webigail-http": "^2.4.1",
38
- "@zthun/webigail-url": "^2.4.1"
35
+ "@zthun/helpful-fn": "^6.5.0",
36
+ "@zthun/helpful-query": "^6.5.0",
37
+ "@zthun/webigail-http": "^3.0.0",
38
+ "@zthun/webigail-url": "^3.0.0"
39
39
  },
40
40
  "sideEffects": false,
41
- "gitHead": "fa93ec3ab3adcf1fe29030cb0d5552c8607954e9"
41
+ "gitHead": "217a1f8050b591818162a2307c7e441f879b976f"
42
42
  }