mates 0.1.0-beta.13 → 0.1.0-beta.15

package/dist/Fetch/Fetch.d.ts

@@ -8,8 +8,8 @@ export type FetchRequest = Omit<RequestInit, "body"> & {
      * - If it starts with `http:` or `https:` it is used as-is (absolute URL),
      *   ignoring any `host` set on the client/base request.
      * - Otherwise it is treated as a path and appended to `host`
-     *   (e.g. `host = "https://api.example.com"` + `url = "/users"` →
-     *   `"https://api.example.com/users"`).
+     *   (e.g. `host = "https://<host>"` + `url = "/users"` →
+     *   `"https://<host>/users"`).
      * - Dynamic segments (`:id`) are substituted from `params`.
      *
      * @example
@@ -24,7 +24,7 @@ export type FetchRequest = Omit<RequestInit, "body"> & {
      */
     path?: string;
     /**
-     * Origin / base host, e.g. `"https://api.example.com"`.
+     * Origin / base host, e.g. `"https://<your-api>"`.
      * Used as a prefix when `url` is a relative path.
      * Defaults to `""` (no host prefix).
      */
@@ -67,7 +67,7 @@ export declare const clearInterceptors: () => void;
  * - All requests are logged to Mates DevTools when devtools is connected.
  *
  * @example
- * const api = new FetchClient({ host: "https://api.example.com" });
+ * const api = new FetchClient({ host: "https://<your-api>" });
  * api.interceptBefore((url, opts) => ({
  *   url,
  *   options: { ...opts, headers: { ...opts.headers, Authorization: `Bearer ${token}` } },
@@ -106,16 +106,16 @@ export declare class FetchClient {
      * exactly as `buildRequestUrl` handles them.
      *
      * @example
-     * const loadUser = api.fetchAction({ host: "https://api.example.com", url: "/users/:id" });
+     * const loadUser = api.fetchAction({ host: "https://<your-api>", url: "/users/:id" });
      * loadUser({ id: 7, expand: "posts" });
-     * // → GET https://api.example.com/users/7?expand=posts
+     * // → GET https://<your-api>/users/7?expand=posts
      */
     fetchAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
     /**
      * Creates an asyncAction that always issues a GET request via this client.
      *
      * @example
-     * const loadUsers = api.getAction({ host: "https://api.example.com", url: "/users" });
+     * const loadUsers = api.getAction({ host: "https://<your-api>", url: "/users" });
      * loadUsers({ page: 2, limit: 20 });
      */
     getAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -123,7 +123,7 @@ export declare class FetchClient {
      * Creates an asyncAction that always issues a POST request via this client.
      *
      * @example
-     * const createUser = api.postAction({ host: "https://api.example.com", url: "/users" });
+     * const createUser = api.postAction({ host: "https://<your-api>", url: "/users" });
      * createUser({ name: "Alice" });
      */
     postAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -131,7 +131,7 @@ export declare class FetchClient {
      * Creates an asyncAction that always issues a PUT request via this client.
      *
      * @example
-     * const replaceUser = api.putAction({ host: "https://api.example.com", url: "/users/:id" });
+     * const replaceUser = api.putAction({ host: "https://<your-api>", url: "/users/:id" });
      * replaceUser({ id: 7, name: "Bob" });
      */
     putAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -139,7 +139,7 @@ export declare class FetchClient {
      * Creates an asyncAction that always issues a PATCH request via this client.
      *
      * @example
-     * const patchUser = api.patchAction({ host: "https://api.example.com", url: "/users/:id" });
+     * const patchUser = api.patchAction({ host: "https://<your-api>", url: "/users/:id" });
      * patchUser({ id: 7, status: "inactive" });
      */
     patchAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -147,7 +147,7 @@ export declare class FetchClient {
      * Creates an asyncAction that always issues a DELETE request via this client.
      *
      * @example
-     * const removeUser = api.deleteAction({ host: "https://api.example.com", url: "/users/:id" });
+     * const removeUser = api.deleteAction({ host: "https://<your-api>", url: "/users/:id" });
      * removeUser({ id: 7 });
      */
     deleteAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;

package/dist/Utils/svgIcon.d.ts

@@ -70,7 +70,7 @@ declare const svgIconDirective: (_markup: string, _config: SvgConfig) => import(
  * import { safeSVG, html } from "mates";
  *
  * const heartIcon =
- *   `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+ *   `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">  <!-- standard SVG namespace -->
  *      <path d="M12 21.35l-1.45-1.32C5.4 15.36 2 12.28 2 8.5…"/>
  *    </svg>`;
  *

package/dist/index.d.ts

@@ -1120,8 +1120,8 @@ type FetchRequest = Omit<RequestInit, "body"> & {
      * - If it starts with `http:` or `https:` it is used as-is (absolute URL),
      *   ignoring any `host` set on the client/base request.
      * - Otherwise it is treated as a path and appended to `host`
-     *   (e.g. `host = "https://api.example.com"` + `url = "/users"` →
-     *   `"https://api.example.com/users"`).
+     *   (e.g. `host = "https://<host>"` + `url = "/users"` →
+     *   `"https://<host>/users"`).
      * - Dynamic segments (`:id`) are substituted from `params`.
      *
      * @example
@@ -1136,7 +1136,7 @@ type FetchRequest = Omit<RequestInit, "body"> & {
      */
     path?: string;
     /**
-     * Origin / base host, e.g. `"https://api.example.com"`.
+     * Origin / base host, e.g. `"https://<your-api>"`.
      * Used as a prefix when `url` is a relative path.
      * Defaults to `""` (no host prefix).
      */
@@ -1179,7 +1179,7 @@ declare const clearInterceptors: () => void;
  * - All requests are logged to Mates DevTools when devtools is connected.
  *
  * @example
- * const api = new FetchClient({ host: "https://api.example.com" });
+ * const api = new FetchClient({ host: "https://<your-api>" });
  * api.interceptBefore((url, opts) => ({
  *   url,
  *   options: { ...opts, headers: { ...opts.headers, Authorization: `Bearer ${token}` } },
@@ -1218,16 +1218,16 @@ declare class FetchClient {
      * exactly as `buildRequestUrl` handles them.
      *
      * @example
-     * const loadUser = api.fetchAction({ host: "https://api.example.com", url: "/users/:id" });
+     * const loadUser = api.fetchAction({ host: "https://<your-api>", url: "/users/:id" });
      * loadUser({ id: 7, expand: "posts" });
-     * // → GET https://api.example.com/users/7?expand=posts
+     * // → GET https://<your-api>/users/7?expand=posts
      */
     fetchAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
     /**
      * Creates an asyncAction that always issues a GET request via this client.
      *
      * @example
-     * const loadUsers = api.getAction({ host: "https://api.example.com", url: "/users" });
+     * const loadUsers = api.getAction({ host: "https://<your-api>", url: "/users" });
      * loadUsers({ page: 2, limit: 20 });
      */
     getAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -1235,7 +1235,7 @@ declare class FetchClient {
      * Creates an asyncAction that always issues a POST request via this client.
      *
      * @example
-     * const createUser = api.postAction({ host: "https://api.example.com", url: "/users" });
+     * const createUser = api.postAction({ host: "https://<your-api>", url: "/users" });
      * createUser({ name: "Alice" });
      */
     postAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -1243,7 +1243,7 @@ declare class FetchClient {
      * Creates an asyncAction that always issues a PUT request via this client.
      *
      * @example
-     * const replaceUser = api.putAction({ host: "https://api.example.com", url: "/users/:id" });
+     * const replaceUser = api.putAction({ host: "https://<your-api>", url: "/users/:id" });
      * replaceUser({ id: 7, name: "Bob" });
      */
     putAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -1251,7 +1251,7 @@ declare class FetchClient {
      * Creates an asyncAction that always issues a PATCH request via this client.
      *
      * @example
-     * const patchUser = api.patchAction({ host: "https://api.example.com", url: "/users/:id" });
+     * const patchUser = api.patchAction({ host: "https://<your-api>", url: "/users/:id" });
      * patchUser({ id: 7, status: "inactive" });
      */
     patchAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -1259,7 +1259,7 @@ declare class FetchClient {
      * Creates an asyncAction that always issues a DELETE request via this client.
      *
      * @example
-     * const removeUser = api.deleteAction({ host: "https://api.example.com", url: "/users/:id" });
+     * const removeUser = api.deleteAction({ host: "https://<your-api>", url: "/users/:id" });
      * removeUser({ id: 7 });
      */
     deleteAction<T = unknown>(config?: FetchActionConfig): AsyncActionReturnType<(params?: Record<string, any>) => Promise<T>>;
@@ -4724,7 +4724,7 @@ type WsConnection<T = unknown> = {
  * ```ts
  * // ✅ correct — inside a component's outer function
  * const MyComponent = () => {
- *   const sock = ws<ChatMessage>("wss://api.example.com/chat", {
+ *   const sock = ws<ChatMessage>("wss://<your-server>/chat", {
  *     reconnect: true,
  *   });
  *   onSocket((msg) => { messages.update(d => { d.push(msg); }); }, [sock]);
@@ -4732,7 +4732,7 @@ type WsConnection<T = unknown> = {
  * };
  *
  * // ❌ wrong — module level, no host, cleanup is never registered
- * const chatSocket = ws<ChatMessage>("wss://api.example.com/chat");
+ * const chatSocket = ws<ChatMessage>("wss://<your-server>/chat");
  *
  * // ❌ wrong — inner function, outer function has already returned
  * const MyComponent = () => {
@@ -5901,7 +5901,7 @@ declare const svgIconDirective: (_markup: string, _config: SvgConfig) => lit_htm
  * import { safeSVG, html } from "mates";
  *
  * const heartIcon =
- *   `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+ *   `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">  <!-- standard SVG namespace -->
  *      <path d="M12 21.35l-1.45-1.32C5.4 15.36 2 12.28 2 8.5…"/>
  *    </svg>`;
  *