@zthun/webigail-url 5.0.2 → 5.0.3

package/dist/data/data-url.d.mts

@@ -1,15 +1,86 @@
+/**
+ * Represents information about a data url.
+ */
 export interface IZDataUrlInfo {
+    /**
+     * The content information mime type.
+     */
     mimeType: string;
+    /**
+     * The output encoding.
+     */
     encoding: "base64" | "utf8";
+    /**
+     * The raw data buffer.
+     */
     buffer: Uint8Array;
 }
+/**
+ * Represents an object that is helpful in building a data url with support
+ * for data encoding.
+ */
 export declare class ZDataUrlBuilder {
+    /**
+     * The representation of the data url object.
+     */
     private _data;
+    /**
+     * Initializes a new instance of this object.
+     */
     constructor();
+    /**
+     * Parses an existing data url and sets all properties.
+     *
+     * @param url -
+     *        The url to parse.
+     *
+     * @returns
+     *        This object.
+     */
     parse(url: string): this;
+    /**
+     * Sets the mime type.
+     *
+     * @param type -
+     *        The mime type.
+     *
+     * @returns
+     *        This object.
+     */
     mimeType(type: string): this;
+    /**
+     * Sets the data buffer.
+     *
+     * @param data -
+     *        The data to set.  If you pass a raw string, then the input encoding
+     *        is expected to be utf8.
+     * @returns
+     *        This object.
+     */
     buffer(data: string | Uint8Array): this;
+    /**
+     * Sets the output encoding.
+     *
+     * If you output encode the data as utf8, then it will be properly
+     * escaped.
+     *
+     * @param encoding -
+     *        The output encoding.
+     *
+     * @returns
+     *        This object.
+     */
     encode(encoding: "base64" | "utf8"): this;
+    /**
+     * Builds the url string and returns it.
+     *
+     * @returns The url string.
+     */
     build(): string;
+    /**
+     * Gets the current information about the url being built.
+     *
+     * @returns The current information about the url being built.
+     */
     info(): IZDataUrlInfo;
 }

package/dist/mime/mime-type-application.d.mts

@@ -1,5 +1,19 @@
+/**
+ * Application mime types.
+ */
 export declare enum ZMimeTypeApplication {
+    /**
+     * JSON data.
+     */
     JSON = "application/json",
+    /**
+     * The unknown type.
+     *
+     * Used for raw byte data.
+     */
     OctetStream = "application/octet-stream",
+    /**
+     * Compressed zip stream.
+     */
     Zip = "application/zip"
 }

package/dist/mime/mime-type-image.d.mts

@@ -1,9 +1,48 @@
+/**
+ * Mime types for images.
+ */
 export declare enum ZMimeTypeImage {
+    /**
+     * Good choice for lossless animation sequences (GIF is less performant). AVIF and
+     * WebP have better performance but less broad browser support.
+     */
     APNG = "image/apng",
+    /**
+     * Good choice for both images and animated images due to high performance and
+     * royalty free image format. It offers much better compression than PNG or JPEG
+     * with support for higher color depths, animated frames, transparency etc.
+     *
+     * Note that when using AVIF, you should include fallbacks to formats with
+     * better browser support (i.e. using the <picture> element).
+     */
     AVIF = "image/avif",
+    /**
+     * Good choice for simple images and animations. Prefer PNG for lossless and
+     * indexed still images, and consider WebP, AVIF or APNG for animation sequences.
+     */
     GIF = "image/gif",
+    /**
+     * Good choice for lossy compression of still images (currently the most popular). Prefer
+     * PNG when more precise reproduction of the image is required, or WebP/AVIF if both better
+     * reproduction and higher compression are required.
+     */
     JPEG = "image/jpeg",
+    /**
+     * PNG is preferred over JPEG for more precise reproduction of source images, or when
+     * transparency is needed. WebP/AVIF provide even better compression and reproduction,
+     * but browser support is more limited.
+     */
     PNG = "image/png",
+    /**
+     * Vector image format; ideal for user interface elements, icons, diagrams, etc., that
+     * must be drawn accurately at different sizes.
+     */
     SVG = "image/svg+xml",
+    /**
+     * Excellent choice for both images and animated images. WebP offers much better compression
+     * than PNG or JPEG with support for higher color depths, animated frames, transparency etc.
+     * AVIF offers slightly better compression, but is not quite as well-supported in browsers
+     * and does not support progressive rendering.
+     */
     WebP = "image/webp"
 }

package/dist/mime/mime-type-text.d.mts

@@ -1,9 +1,38 @@
+/**
+ * Mime types for text based data.
+ */
 export declare enum ZMimeTypeText {
+    /**
+     * Style files used in html documents must be sent as
+     * css.
+     */
     CSS = "text/css",
+    /**
+     * Comma separated values.
+     */
     CSV = "text/csv",
+    /**
+     * JavaScript.
+     */
     EcmaScript = "text/ecmascript",
+    /**
+     * Hyper Text Markup Language.  Markup language for
+     * web pages.
+     */
     HTML = "text/html",
+    /**
+     * JavaScript.
+     */
     JavaScript = "text/javascript",
+    /**
+     * Plain (basic) text.
+     */
     Plain = "text/plain",
+    /**
+     * Xtreme Markup Language.
+     *
+     * Superset of HTML.  Bulky, but can
+     * represent anything.
+     */
     XML = "text/xml"
 }

package/dist/mime/mime-type.d.mts

@@ -1,7 +1,13 @@
 import { ZMimeTypeApplication } from './mime-type-application.mjs';
 import { ZMimeTypeImage } from './mime-type-image.mjs';
 import { ZMimeTypeText } from './mime-type-text.mjs';
+/**
+ * Mime types for file data.
+ */
 export type ZMimeType = ZMimeTypeApplication | ZMimeTypeText | ZMimeTypeImage;
+/**
+ * A mapping of supported mime types.
+ */
 export declare const ZSupportedMimeTypes: Readonly<{
     "": "text/plain;charset=ASCII";
 }>;

package/dist/url/url.d.mts

@@ -1,23 +1,76 @@
+/**
+ * Represents information about a url.
+ */
 export interface IZUrlInfo {
+    /**
+     * The protocol for the url.
+     */
     protocol: string;
+    /**
+     * The username.
+     */
     username?: string;
+    /**
+     * The password.
+     */
     password?: string;
+    /**
+     * The host.
+     */
     hostname: string;
+    /**
+     * The port number.
+     */
     port?: number;
+    /**
+     * A list of current paths.
+     *
+     * You can always get the full path using
+     * path.join('/')
+     */
     path: string[];
+    /**
+     * The client side hash route.
+     */
     hash?: string;
+    /**
+     * The key value params.
+     */
     params: Array<{
         key: string;
         val: string;
     }>;
 }
+/**
+ * The api to target for YouTube.
+ */
 export declare enum ZYouTubeApi {
+    /**
+     * An embedded video link.
+     */
     Embed = "embed",
+    /**
+     * A watch video link.
+     */
     Watch = "watch"
 }
+/**
+ * Represents an object that is helpful in building a url.
+ */
 export declare class ZUrlBuilder {
+    /**
+     * The url to the gravatar api.
+     */
     static UrlGravatar: string;
+    /**
+     * The url to youtube.
+     *
+     * This is mostly used to embed videos.
+     */
     static UrlYouTube: string;
+    /**
+     * A mapping between protocol and default port.
+     */
     static ProtocolPorts: {
         http: number;
         https: number;
@@ -27,32 +80,316 @@ export declare class ZUrlBuilder {
         smtp: number;
         smb: number;
     };
+    /**
+     * Gets whether the given protocols default port is port.
+     *
+     * The main purpose of this method is to determine if a url requires
+     * a port section.  Therefore, there are some special behaviors which may
+     * not be obvious:
+     *
+     * 1.  If the port is falsy then this method returns true.
+     * 2.  If the port is NaN, then this method returns true.
+     * 3.  If the port is a string that evaluates to 0, then this method returns true.
+     * 4.  If port is less than 0, then this method returns true.
+     *
+     * @param protocol -
+     *        The protocol to check.
+     * @param port -
+     *        The port to compare.
+     *
+     * @returns
+     *        True if the default port for protocol is port.
+     */
     static defaults(protocol: string, port: string | number): boolean;
+    /**
+     * The representation of the url object.
+     */
     private readonly _url;
+    /**
+     * Initializes a new instance of this object.
+     *
+     * @param protocol -
+     *        The protocol to use.
+     * @param hostname -
+     *        The hostname to connect with.
+     */
     constructor(protocol?: string, hostname?: string);
+    /**
+     * Fills the information from the current location data.
+     *
+     * @param loc -
+     *        The optional location object to populate with.
+     *
+     * @returns
+     *        This object.
+     */
     location(loc: Location): this;
+    /**
+     * Fills the information for an api path call.
+     *
+     * This is a combination of location, hash with an empty string, and an
+     * append of the basePath.
+     *
+     * @param loc -
+     *        The optional location object to populate with.
+     * @param basePath -
+     *        The basePath for the api.  Generally, it's best to
+     *        just keep this as api and have your server accept
+     *        this path.
+     *
+     * @returns
+     *        This object.
+     */
     api(loc: Location, basePath?: string): this;
+    /**
+     * Parses an existing url and sets all properties.
+     *
+     * If you give this a path without the protocol and hostname, then it will
+     * automatically append the protocol and host of the browser window if it
+     * exists.
+     *
+     * This method sets all the properties so if you need to modify the url before
+     * parsing it, it is best to always call this method first.
+     *
+     * @param url -
+     *        The url to parse.
+     *
+     * @returns
+     *        This object.
+     */
     parse(url: string): this;
+    /**
+     * Sets the url for a user gravatar.
+     *
+     * @param hash -
+     *        The md5 email hash.
+     * @param size -
+     *        The dimensional size of the gravatar image.
+     *
+     * @returns
+     *        This object.
+     */
     gravatar(hash?: string, size?: number): this;
+    /**
+     * Sets the url for a target video on YouTube.
+     *
+     * @param api -
+     *        The target api.  If this is watch, then
+     *        it will be a target link to a youTube url.
+     *        If this is embed, then it will be a target
+     *        link that can be put into an iframe for
+     *        embedded youtube videos.
+     * @param id -
+     *        The id of the video to watch.
+     *
+     * @returns
+     *        This object.
+     */
     youTube(api: ZYouTubeApi, id: string): this;
+    /**
+     * Sets the url to the base YouTube domain.
+     *
+     * @returns
+     *        This object.
+     */
     youTube(): this;
+    /**
+     * Sets the protocol.
+     *
+     * @param protocol -
+     *        The protocol.
+     *
+     * @returns
+     *        This object.
+     */
     protocol(protocol: string): this;
+    /**
+     * Sets the user name.
+     *
+     * Used for things like ssh and ftp.
+     *
+     * @param user -
+     *        The username
+     *
+     * @returns
+     *        This object.
+     */
     username(user: string | undefined): this;
+    /**
+     * Sets the password.
+     *
+     * This is only valid if the username is set.
+     *
+     * @param pwd -
+     *        The user password.
+     *
+     * @returns
+     *        This object.
+     */
     password(pwd: string | undefined): this;
+    /**
+     * Sets the host name.
+     *
+     * This sets the entire hostname as the root domain.  This
+     * will blow away any subdomains added, so it's best to
+     * call this method first.
+     *
+     * @param host -
+     *        The hostname.
+     *
+     * @returns
+     *        This object.
+     */
     hostname(host: string): this;
+    /**
+     * Adds a subdomain in front of the hostname.
+     *
+     * If a hostname was never set, then domain becomes the hostname.
+     *
+     * @param domain -
+     *        The domain to append.
+     *
+     * @returns
+     *        This object.
+     */
     subdomain(domain: string): this;
+    /**
+     * Removes a subdomain from the current domain.
+     *
+     * @returns
+     *        This object.
+     */
     popSubdomain(): this;
+    /**
+     * Sets the port.
+     *
+     * @param port -
+     *        The port.
+     *
+     * @returns
+     *        This object.
+     */
     port(port: number | undefined): this;
+    /**
+     * Removes all existing path segments and restarts the path.
+     *
+     * @param path -
+     *        The starting path.
+     *
+     * @returns
+     *        This object.
+     */
     path(path: string): this;
+    /**
+     * Appends a path segment.
+     *
+     * @param path -
+     *        The segment to append.
+     *
+     * @returns
+     *        This object.
+     */
     append(path: string): this;
+    /**
+     * Sets the hash section.
+     *
+     * @param hash -
+     *        The hash section.
+     *
+     * @returns
+     *        This object.
+     */
     hash(hash: string | undefined): this;
+    /**
+     * Adds a search parameter.
+     *
+     * This version assumes that value is not null.
+     *
+     * @param key -
+     *        The parameter key.
+     * @param val -
+     *        The parameter value.
+     *
+     * @returns
+     *        This object.
+     */
     param(key: string, val: string): this;
+    /**
+     * Removes all duplicate params and adds one with the key to the value.
+     *
+     * @param key -
+     *        The parameter key that can have only one.
+     * @param val -
+     *        The parameter value.  If this is falsy, then
+     *        the key is deleted.
+     */
     onlyParam(key: string, val?: string): this;
+    /**
+     * Adds a page param.
+     *
+     * @param page -
+     *        The page param to add.  If this null, undefined,
+     *        or less than 1, then any page param is deleted.
+     *
+     * @returns
+     *        This object.
+     */
     page(page?: number | null): this;
+    /**
+     * Adds a size param.
+     *
+     * @param size -
+     *        The size param to add.  If this is null, undefined,
+     *        or less than 0, then any size param is deleted.
+     *
+     * @returns
+     *        This object.
+     */
     size(size?: number | null): this;
+    /**
+     * Adds a search param.
+     *
+     * @param search -
+     *        The search param to add.  If this is null, undefined,
+     *        or empty, then any search param is deleted.
+     *
+     * @returns
+     *        This object.
+     */
     search(search?: string | null): this;
+    /**
+     * Adds a filter param.
+     *
+     * @param filter -
+     *        The filter param to add.  If this is null, undefined,
+     *        or empty, then any filter param is deleted.
+     *
+     * @returns
+     *        This object.
+     */
     filter(filter?: string | null): this;
+    /**
+     * Adds a sort param.
+     *
+     * @param sort -
+     *        The sort param to add.  If this is null, undefined,
+     *        or empty, then any filter param is deleted.
+     *
+     * @returns
+     *        This object.
+     */
     sort(sort?: string | null): this;
+    /**
+     * Builds the url string and returns it.
+     *
+     * @returns
+     *        The url string.
+     */
     build(): string;
+    /**
+     * Gets the current information about the uri being built.
+     *
+     * @returns The current uri information.
+     */
     info(): IZUrlInfo;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zthun/webigail-url",
-  "version": "5.0.2",
+  "version": "5.0.3",
   "description": "Url parsing and building.",
   "author": "Anthony Bonta",
   "license": "MIT",
@@ -25,17 +25,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@zthun/janitor-build-config": "^19.5.3",
-    "lodash-es": "^4.17.21",
+    "lodash-es": "^4.17.22",
     "url-parse": "^1.5.10"
   },
   "devDependencies": {
-    "vite": "^7.2.7",
-    "vitest": "^4.0.15"
+    "@zthun/janitor-build-config": "^19.5.4",
+    "@zthun/janitor-ts-config": "^19.5.3",
+    "typescript": "~5.9.3",
+    "vite": "^7.3.0",
+    "vitest": "^4.0.16"
   },
   "files": [
     "dist"
   ],
   "sideEffects": false,
-  "gitHead": "a9bb37cb546337dce70e531a66ed08b90751c305"
+  "gitHead": "72e9e39897db1a5105194b6b40d5060e537a0a55"
 }