@molopos/shared 2.0.17 → 2.0.18

package/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./date";
 export * from "./enum";
 export * from "./lib/utils";
-export * from "./url-query";
+export * from "./url-endpoint";
 export type DateLike = Date | string;
 export type Numberlike = number | `${number}` | `${number}.${number}`;

package/index.js

@@ -17,4 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./date"), exports);
 __exportStar(require("./enum"), exports);
 __exportStar(require("./lib/utils"), exports);
-__exportStar(require("./url-query"), exports);
+__exportStar(require("./url-endpoint"), exports);

package/package.json

@@ -1 +1 @@
-{"name":"@molopos/shared","publishConfig":{"access":"public"},"version":"2.0.17","description":"Shared between backend and frontend repos","license":"ISC","repository":{"type":"git","url":"https://github.com/unicubate/molopos-shared.git"},"dependencies":{"date-fns":"^4.1.0","luxon":"^3.7.2"}}
+{"name":"@molopos/shared","publishConfig":{"access":"public"},"version":"2.0.18","description":"Shared between backend and frontend repos","license":"ISC","repository":{"type":"git","url":"https://github.com/unicubate/molopos-shared.git"},"dependencies":{"date-fns":"^4.1.0","luxon":"^3.7.2"}}

package/{url-query → url-endpoint}/index.d.ts

@@ -1,25 +1,27 @@
+import type { UrlObject } from "url";
+export type Url = string | UrlObject;
 export type EndpointLike<T extends string> = `/${T}`;
 /**
  * Create a URL with query parameters
  * @param baseUrl - The base URL
  * @param endpoint - The endpoint
- * @param urlParams - The URL parameters
- * @param queryParams - The query parameters
+ * @param params - The URL parameters
+ * @param query - The query parameters
  * @returns
  *
  * @example
  * const url = URLEndpoint({
  *   baseUrl: "https://api.example.com",
- *   endpoint: "/users",
- *   urlParams: { id: "123" },
- *   queryParams: { limit: 10, offset: 0 },
+ *   endpoint: "/users/:id",
+ *   params: { id: "123" },
+ *   query: { limit: 10, page: 1 },
  * });
- * // https://api.example.com/users/123?limit=10&offset=0
+ * // https://api.example.com/users/123?limit=10&page=1
  *
  */
 export declare const URLEndpoint: ({ query, params, baseUrl, endpoint, }: {
     query?: Object;
-    baseUrl: string;
+    baseUrl: Url;
     params?: Object;
     endpoint: EndpointLike<string>;
-}) => string;
+}) => Url;

package/{url-query → url-endpoint}/index.js

@@ -5,18 +5,18 @@ exports.URLEndpoint = void 0;
  * Create a URL with query parameters
  * @param baseUrl - The base URL
  * @param endpoint - The endpoint
- * @param urlParams - The URL parameters
- * @param queryParams - The query parameters
+ * @param params - The URL parameters
+ * @param query - The query parameters
  * @returns
  *
  * @example
  * const url = URLEndpoint({
  *   baseUrl: "https://api.example.com",
- *   endpoint: "/users",
- *   urlParams: { id: "123" },
- *   queryParams: { limit: 10, offset: 0 },
+ *   endpoint: "/users/:id",
+ *   params: { id: "123" },
+ *   query: { limit: 10, page: 1 },
  * });
- * // https://api.example.com/users/123?limit=10&offset=0
+ * // https://api.example.com/users/123?limit=10&page=1
  *
  */
 const URLEndpoint = ({ query, params, baseUrl, endpoint, }) => {

package/url-endpoint/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/url-endpoint/index.test.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+describe("URLEndpoint", () => {
+    test("URLEndpoint", () => {
+        const baseUrl = "https://api.example.com";
+        const result = (0, index_1.URLEndpoint)({
+            baseUrl,
+            endpoint: "/users/:id",
+            params: { id: "123" },
+            query: { limit: 10, page: 1 },
+        });
+        expect(result).toEqual(`${baseUrl}/users/123?limit=10&page=1`);
+    });
+});