@zthun/webigail-rest 3.1.3 → 3.3.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/dist/index.cjs +49 -8
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +50 -9
- package/dist/index.js.map +1 -1
- package/dist/url/restful-url.d.mts +8 -0
- package/package.json +8 -8
package/dist/index.cjs
CHANGED
|
@@ -1,8 +1,51 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
-
const helpfulQuery = require("@zthun/helpful-query");
|
|
4
3
|
const webigailHttp = require("@zthun/webigail-http");
|
|
5
4
|
const webigailUrl = require("@zthun/webigail-url");
|
|
5
|
+
const helpfulQuery = require("@zthun/helpful-query");
|
|
6
|
+
class ZRestfulUrlBuilder {
|
|
7
|
+
/**
|
|
8
|
+
* Initializes a new instance of this object.
|
|
9
|
+
*/
|
|
10
|
+
constructor(baseUrl) {
|
|
11
|
+
this._url = new webigailUrl.ZUrlBuilder().parse(baseUrl);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Adds the request parameters to the url.
|
|
15
|
+
*
|
|
16
|
+
* This will add the page, size, search, filter, and sort parameters to the url if they are defined.
|
|
17
|
+
*
|
|
18
|
+
* @param request -
|
|
19
|
+
* The request to add to the url.
|
|
20
|
+
* @returns
|
|
21
|
+
* This object.
|
|
22
|
+
*/
|
|
23
|
+
from(request) {
|
|
24
|
+
this._url = this._url.page(request.page).size(request.size).search(request.search).filter(new helpfulQuery.ZFilterSerialize().serialize(request.filter)).sort(new helpfulQuery.ZSortSerialize().serialize(request.sort));
|
|
25
|
+
return this;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Updates the url to optimize to retrieve a count.
|
|
29
|
+
*
|
|
30
|
+
* This will add the size and page parameters to the url and remove the sort parameter.
|
|
31
|
+
*
|
|
32
|
+
* @returns
|
|
33
|
+
* This object.
|
|
34
|
+
*/
|
|
35
|
+
count() {
|
|
36
|
+
this._url = this._url.size(1).page(1).sort(null);
|
|
37
|
+
return this;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Returns the built url.
|
|
41
|
+
*
|
|
42
|
+
* @returns
|
|
43
|
+
* The built url.
|
|
44
|
+
*/
|
|
45
|
+
build() {
|
|
46
|
+
return this._url.build();
|
|
47
|
+
}
|
|
48
|
+
}
|
|
6
49
|
class ZRestfulService {
|
|
7
50
|
/**
|
|
8
51
|
* Initializes a new instance of this object.
|
|
@@ -38,17 +81,14 @@ class ZRestfulService {
|
|
|
38
81
|
return identification ? url.append(`${identification}`) : url;
|
|
39
82
|
}
|
|
40
83
|
async count(req) {
|
|
41
|
-
const
|
|
42
|
-
|
|
43
|
-
|
|
84
|
+
const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).get().url(
|
|
85
|
+
new ZRestfulUrlBuilder(this.endpoint().build()).from(req).count().build()
|
|
86
|
+
).build();
|
|
44
87
|
const { data: page } = await this._http.request(r);
|
|
45
88
|
return page.count;
|
|
46
89
|
}
|
|
47
90
|
async retrieve(req) {
|
|
48
|
-
const
|
|
49
|
-
const sort = new helpfulQuery.ZSortSerialize().serialize(req.sort);
|
|
50
|
-
const url = this.endpoint().page(req.page).size(req.size).search(req.search).filter(filter).sort(sort).build();
|
|
51
|
-
const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).get().url(url).build();
|
|
91
|
+
const r = new webigailHttp.ZHttpRequestBuilder().copy(this._request).get().url(new ZRestfulUrlBuilder(this.endpoint().build()).from(req).build()).build();
|
|
52
92
|
const { data: page } = await this._http.request(r);
|
|
53
93
|
return page.data ?? page.result;
|
|
54
94
|
}
|
|
@@ -83,4 +123,5 @@ class ZRestfulService {
|
|
|
83
123
|
}
|
|
84
124
|
}
|
|
85
125
|
exports.ZRestfulService = ZRestfulService;
|
|
126
|
+
exports.ZRestfulUrlBuilder = ZRestfulUrlBuilder;
|
|
86
127
|
//# sourceMappingURL=index.cjs.map
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","sources":["../src/service/restful-service.mts"],"sourcesContent":["import {\n IZDataRequest,\n
|
|
1
|
+
{"version":3,"file":"index.cjs","sources":["../src/url/restful-url.mts","../src/service/restful-service.mts"],"sourcesContent":["import {\n IZDataRequest,\n ZFilterSerialize,\n ZSortSerialize,\n} 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 { IZDataRequest, IZDataSource } from \"@zthun/helpful-query\";\nimport { IZHttpService, ZHttpRequestBuilder } from \"@zthun/webigail-http\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\nimport { ZRestfulUrlBuilder } from \"../url/restful-url.mjs\";\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 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":["ZUrlBuilder","ZFilterSerialize","ZSortSerialize","ZHttpRequestBuilder"],"mappings":";;;;;AAWO,MAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA,EAMvB,YAAY,SAAiB;AAClC,SAAK,OAAO,IAAIA,YAAY,YAAA,EAAE,MAAM,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAatC,KAAK,SAA8B;AACxC,SAAK,OAAO,KAAK,KACd,KAAK,QAAQ,IAAI,EACjB,KAAK,QAAQ,IAAI,EACjB,OAAO,QAAQ,MAAM,EACrB,OAAO,IAAIC,aAAiB,iBAAA,EAAE,UAAU,QAAQ,MAAM,CAAC,EACvD,KAAK,IAAIC,aAAAA,eAAe,EAAE,UAAU,QAAQ,IAAI,CAAC;AAC7C,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWF,QAAc;AACd,SAAA,OAAO,KAAK,KAAK,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,IAAI;AACxC,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASF,QAAgB;AACd,WAAA,KAAK,KAAK,MAAM;AAAA,EAAA;AAE3B;AC5BO,MAAM,gBAAkD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAetD,YACY,OACA,cACA,WAAW,IAAIC,aAAuB,oBAAA,EAAE,SACzD;AAHiB,SAAA,QAAA;AACA,SAAA,eAAA;AACA,SAAA,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaZ,SAAS,gBAAkC;AAChD,UAAM,MAAM,IAAIH,YAAA,YAAA,EAAc,MAAM,KAAK,YAAY;AACrD,WAAO,iBAAiB,IAAI,OAAO,GAAG,cAAc,EAAE,IAAI;AAAA,EAAA;AAAA,EAG5D,MAAa,MAAM,KAAqC;AAChD,UAAA,IAAI,IAAIG,aAAAA,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAA,EACA;AAAA,MACC,IAAI,mBAAmB,KAAK,SAAA,EAAW,MAAA,CAAO,EAC3C,KAAK,GAAG,EACR,MAAA,EACA,MAAM;AAAA,MAEV,MAAM;AACH,UAAA,EAAE,MAAM,KAAK,IAAI,MAAM,KAAK,MAAM,QAAa,CAAC;AACtD,WAAO,KAAK;AAAA,EAAA;AAAA,EAGd,MAAa,SAAS,KAAkC;AAChD,UAAA,IAAI,IAAIA,aAAA,oBAAA,EACX,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,IAAI,mBAAmB,KAAK,WAAW,OAAO,EAAE,KAAK,GAAG,EAAE,OAAO,EACrE,MAAM;AACH,UAAA,EAAE,MAAM,KAAK,IAAI,MAAM,KAAK,MAAM,QAAa,CAAC;AAC/C,WAAA,KAAK,QAAQ,KAAK;AAAA,EAAA;AAAA,EAG3B,MAAa,IAAI,gBAA6C;AAC5D,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAIA,iCAAoB,EAC/B,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EAAA;AAAA,EAGT,MAAa,OAAO,MAAqB;AACvC,UAAM,MAAM,KAAK,SAAS,EAAE,MAAM;AAClC,UAAM,IAAI,IAAIA,aAAAA,sBACX,KAAK,KAAK,QAAQ,EAClB,KAAK,IAAI,EACT,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EAAA;AAAA,EAGT,MAAa,OAAO,MAAqB;AACvC,UAAM,MAAM,KAAK,SAAS,EAAE,MAAM;AAClC,UAAM,IAAI,IAAIA,aAAAA,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAI,IAAI,EACR,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EAAA;AAAA,EAGT,MAAa,OACX,gBACA,QACY;AACZ,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAIA,aAAAA,sBACX,KAAK,KAAK,QAAQ,EAClB,MAAM,MAAM,EACZ,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EAAA;AAAA,EAGT,MAAa,OAAO,gBAAgD;AAClE,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAIA,iCAA+B,EAC1C,KAAK,KAAK,QAAQ,EAClB,OAAO,EACP,IAAI,GAAG,EACP,MAAM;AACH,UAAA,KAAK,MAAM,QAAQ,CAAC;AAAA,EAAA;AAE9B;;;"}
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -1,6 +1,49 @@
|
|
|
1
|
-
import { ZFilterSerialize, ZSortSerialize } from "@zthun/helpful-query";
|
|
2
1
|
import { ZHttpRequestBuilder } from "@zthun/webigail-http";
|
|
3
2
|
import { ZUrlBuilder } from "@zthun/webigail-url";
|
|
3
|
+
import { ZFilterSerialize, ZSortSerialize } from "@zthun/helpful-query";
|
|
4
|
+
class ZRestfulUrlBuilder {
|
|
5
|
+
/**
|
|
6
|
+
* Initializes a new instance of this object.
|
|
7
|
+
*/
|
|
8
|
+
constructor(baseUrl) {
|
|
9
|
+
this._url = new ZUrlBuilder().parse(baseUrl);
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Adds the request parameters to the url.
|
|
13
|
+
*
|
|
14
|
+
* This will add the page, size, search, filter, and sort parameters to the url if they are defined.
|
|
15
|
+
*
|
|
16
|
+
* @param request -
|
|
17
|
+
* The request to add to the url.
|
|
18
|
+
* @returns
|
|
19
|
+
* This object.
|
|
20
|
+
*/
|
|
21
|
+
from(request) {
|
|
22
|
+
this._url = this._url.page(request.page).size(request.size).search(request.search).filter(new ZFilterSerialize().serialize(request.filter)).sort(new ZSortSerialize().serialize(request.sort));
|
|
23
|
+
return this;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Updates the url to optimize to retrieve a count.
|
|
27
|
+
*
|
|
28
|
+
* This will add the size and page parameters to the url and remove the sort parameter.
|
|
29
|
+
*
|
|
30
|
+
* @returns
|
|
31
|
+
* This object.
|
|
32
|
+
*/
|
|
33
|
+
count() {
|
|
34
|
+
this._url = this._url.size(1).page(1).sort(null);
|
|
35
|
+
return this;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Returns the built url.
|
|
39
|
+
*
|
|
40
|
+
* @returns
|
|
41
|
+
* The built url.
|
|
42
|
+
*/
|
|
43
|
+
build() {
|
|
44
|
+
return this._url.build();
|
|
45
|
+
}
|
|
46
|
+
}
|
|
4
47
|
class ZRestfulService {
|
|
5
48
|
/**
|
|
6
49
|
* Initializes a new instance of this object.
|
|
@@ -36,17 +79,14 @@ class ZRestfulService {
|
|
|
36
79
|
return identification ? url.append(`${identification}`) : url;
|
|
37
80
|
}
|
|
38
81
|
async count(req) {
|
|
39
|
-
const
|
|
40
|
-
|
|
41
|
-
|
|
82
|
+
const r = new ZHttpRequestBuilder().copy(this._request).get().url(
|
|
83
|
+
new ZRestfulUrlBuilder(this.endpoint().build()).from(req).count().build()
|
|
84
|
+
).build();
|
|
42
85
|
const { data: page } = await this._http.request(r);
|
|
43
86
|
return page.count;
|
|
44
87
|
}
|
|
45
88
|
async retrieve(req) {
|
|
46
|
-
const
|
|
47
|
-
const sort = new ZSortSerialize().serialize(req.sort);
|
|
48
|
-
const url = this.endpoint().page(req.page).size(req.size).search(req.search).filter(filter).sort(sort).build();
|
|
49
|
-
const r = new ZHttpRequestBuilder().copy(this._request).get().url(url).build();
|
|
89
|
+
const r = new ZHttpRequestBuilder().copy(this._request).get().url(new ZRestfulUrlBuilder(this.endpoint().build()).from(req).build()).build();
|
|
50
90
|
const { data: page } = await this._http.request(r);
|
|
51
91
|
return page.data ?? page.result;
|
|
52
92
|
}
|
|
@@ -81,6 +121,7 @@ class ZRestfulService {
|
|
|
81
121
|
}
|
|
82
122
|
}
|
|
83
123
|
export {
|
|
84
|
-
ZRestfulService
|
|
124
|
+
ZRestfulService,
|
|
125
|
+
ZRestfulUrlBuilder
|
|
85
126
|
};
|
|
86
127
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../src/service/restful-service.mts"],"sourcesContent":["import {\n IZDataRequest,\n
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../src/url/restful-url.mts","../src/service/restful-service.mts"],"sourcesContent":["import {\n IZDataRequest,\n ZFilterSerialize,\n ZSortSerialize,\n} 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 { IZDataRequest, IZDataSource } from \"@zthun/helpful-query\";\nimport { IZHttpService, ZHttpRequestBuilder } from \"@zthun/webigail-http\";\nimport { ZUrlBuilder } from \"@zthun/webigail-url\";\nimport { ZRestfulUrlBuilder } from \"../url/restful-url.mjs\";\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 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":[],"mappings":";;;AAWO,MAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA,EAMvB,YAAY,SAAiB;AAClC,SAAK,OAAO,IAAI,YAAY,EAAE,MAAM,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAatC,KAAK,SAA8B;AACxC,SAAK,OAAO,KAAK,KACd,KAAK,QAAQ,IAAI,EACjB,KAAK,QAAQ,IAAI,EACjB,OAAO,QAAQ,MAAM,EACrB,OAAO,IAAI,iBAAiB,EAAE,UAAU,QAAQ,MAAM,CAAC,EACvD,KAAK,IAAI,eAAe,EAAE,UAAU,QAAQ,IAAI,CAAC;AAC7C,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWF,QAAc;AACd,SAAA,OAAO,KAAK,KAAK,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,IAAI;AACxC,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASF,QAAgB;AACd,WAAA,KAAK,KAAK,MAAM;AAAA,EAAA;AAE3B;AC5BO,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,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaZ,SAAS,gBAAkC;AAChD,UAAM,MAAM,IAAI,YAAA,EAAc,MAAM,KAAK,YAAY;AACrD,WAAO,iBAAiB,IAAI,OAAO,GAAG,cAAc,EAAE,IAAI;AAAA,EAAA;AAAA,EAG5D,MAAa,MAAM,KAAqC;AAChD,UAAA,IAAI,IAAI,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAA,EACA;AAAA,MACC,IAAI,mBAAmB,KAAK,SAAA,EAAW,MAAA,CAAO,EAC3C,KAAK,GAAG,EACR,MAAA,EACA,MAAM;AAAA,MAEV,MAAM;AACH,UAAA,EAAE,MAAM,KAAK,IAAI,MAAM,KAAK,MAAM,QAAa,CAAC;AACtD,WAAO,KAAK;AAAA,EAAA;AAAA,EAGd,MAAa,SAAS,KAAkC;AAChD,UAAA,IAAI,IAAI,oBAAA,EACX,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,IAAI,mBAAmB,KAAK,WAAW,OAAO,EAAE,KAAK,GAAG,EAAE,OAAO,EACrE,MAAM;AACH,UAAA,EAAE,MAAM,KAAK,IAAI,MAAM,KAAK,MAAM,QAAa,CAAC;AAC/C,WAAA,KAAK,QAAQ,KAAK;AAAA,EAAA;AAAA,EAG3B,MAAa,IAAI,gBAA6C;AAC5D,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAI,oBAAoB,EAC/B,KAAK,KAAK,QAAQ,EAClB,IAAI,EACJ,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EAAA;AAAA,EAGT,MAAa,OAAO,MAAqB;AACvC,UAAM,MAAM,KAAK,SAAS,EAAE,MAAM;AAClC,UAAM,IAAI,IAAI,sBACX,KAAK,KAAK,QAAQ,EAClB,KAAK,IAAI,EACT,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EAAA;AAAA,EAGT,MAAa,OAAO,MAAqB;AACvC,UAAM,MAAM,KAAK,SAAS,EAAE,MAAM;AAClC,UAAM,IAAI,IAAI,sBACX,KAAK,KAAK,QAAQ,EAClB,IAAI,IAAI,EACR,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EAAA;AAAA,EAGT,MAAa,OACX,gBACA,QACY;AACZ,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAI,sBACX,KAAK,KAAK,QAAQ,EAClB,MAAM,MAAM,EACZ,IAAI,GAAG,EACP,MAAM;AACT,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,MAAM,QAAW,CAAC;AACvC,WAAA;AAAA,EAAA;AAAA,EAGT,MAAa,OAAO,gBAAgD;AAClE,UAAM,MAAM,KAAK,SAAS,cAAc,EAAE,MAAM;AAChD,UAAM,IAAI,IAAI,oBAA+B,EAC1C,KAAK,KAAK,QAAQ,EAClB,OAAO,EACP,IAAI,GAAG,EACP,MAAM;AACH,UAAA,KAAK,MAAM,QAAQ,CAAC;AAAA,EAAA;AAE9B;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zthun/webigail-rest",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.3.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
|
"dependencies": {
|
|
28
|
-
"@zthun/helpful-fn": "^7.
|
|
29
|
-
"@zthun/helpful-query": "^7.
|
|
30
|
-
"@zthun/webigail-http": "^3.
|
|
31
|
-
"@zthun/webigail-url": "^3.
|
|
28
|
+
"@zthun/helpful-fn": "^7.2.1",
|
|
29
|
+
"@zthun/helpful-query": "^7.2.1",
|
|
30
|
+
"@zthun/webigail-http": "^3.3.0",
|
|
31
|
+
"@zthun/webigail-url": "^3.3.0"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
|
-
"vite": "^
|
|
35
|
-
"vitest": "^
|
|
34
|
+
"vite": "^6.3.5",
|
|
35
|
+
"vitest": "^3.1.4"
|
|
36
36
|
},
|
|
37
37
|
"files": [
|
|
38
38
|
"dist"
|
|
39
39
|
],
|
|
40
40
|
"sideEffects": false,
|
|
41
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "72a0000e563ffc63023e23b6c5428d8e61de17f5"
|
|
42
42
|
}
|