@dolthub/web-utils 0.1.0 → 0.1.3

package/dist/index.d.ts

@@ -1,7 +1,26 @@
+/// <reference types="node" />
+import { Select, ColumnRef } from 'node-sql-parser';
+import { ParsedUrlQueryInput } from 'querystring';
+import { UrlObject } from 'url';
+
 type Maybe<T> = T | undefined | null;
 
 declare function compareArray(arr1: string[], arr2: string[]): boolean;
 
+declare const oneHour: number;
+declare function getUTCDateAndTimeString(date: Date): string;
+declare function getDateString(date: Date): string;
+declare function getUTCDateString(date: Date): string;
+declare function getUTCTimeString(date: Date): string;
+declare function getNow(): Date;
+declare function getDateMinusHours(date: Date, hours: number): Date;
+declare function getUTCNowDateString(): string;
+declare function getLongDateTimeString(d: Date): string;
+declare function getTimeWithSeconds(date: Date): string;
+declare function getTimeAgoString(oldDateTime: number): string;
+declare function areTimeAgosEqual(a: Date, b: Date): boolean;
+declare function convertToUTCDate(d: Date): Date;
+
 declare function dedupe<T>(arr: T[]): T[];
 
 /**
@@ -25,20 +44,281 @@ declare function dedupe<T>(arr: T[]): T[];
  */
 declare function enumKeys<O extends object, K extends keyof O = keyof O>(obj: O): K[];
 
-declare const _default: (str: string, len?: number) => string;
+declare function excerpt(str: string, len?: number): string;
+
+declare function fakeEscapePress(): void;
 
 declare function initialUppercase(s: string): string;
 
+declare const loremer: {
+    word: ({ trueSingleWord, minLength, maxLength, matchRegex, }?: {
+        trueSingleWord?: boolean | undefined;
+        matchRegex?: RegExp | undefined;
+        minLength?: number | undefined;
+        maxLength?: number | undefined;
+    }) => string;
+    words: (n: number) => string[];
+    resourceNameSegment: () => string;
+    sentence: (options?: {
+        max?: number | undefined;
+        min?: number | undefined;
+    }) => string;
+    sentences: (n: number) => string[];
+    paragraph: () => string;
+};
+
 declare function nTimes<T>(n: number, operation: (...args: any[]) => T, args?: Parameters<typeof operation>): T[];
 declare function nTimesWithIndex<T>(n: number, operation: (n: number) => T): T[];
 
-declare function export_default(data: any): string;
+declare const NULL_VALUE = "\uF5F2\uEB94NULL\uF5A8\uE6FF";
+declare function isNullValue(dv: string): boolean;
+declare function getDisplayValue(dv: string): string;
+declare function getDisplayValueForApi(dv: string): string | null;
+
+declare function formatNumber(num: number): string;
+declare function formatToUsd(num: number): string;
+declare function formatToRoundedUsd(num: number): string;
+
+type TableColumn = {
+    name: string;
+    sourceTable?: Maybe<string>;
+};
+declare function parseSelectQuery(q: string): Select | null;
+declare function requireTableNameForSelect(q: string): string[];
+declare function getTableName(q?: string): Maybe<string>;
+type Column = {
+    expr: ColumnRef;
+    as: string | null;
+};
+type Columns = any[] | "*" | Column[];
+declare function getColumns(q: string): Columns | undefined;
+declare function convertToSqlWithNewColNames(q: string, cols: string[] | "*", tableName: string): string;
+declare function convertToSqlWithNewCols(q: string, cols: TableColumn[] | "*", tableNames?: string[]): string;
+declare function convertToSqlWithNewCondition(query: string, column: string, value: string): string;
+declare function convertToSqlWithOrderBy(query: string, column: string, type?: "ASC" | "DESC"): string;
+declare function queryHasOrderBy(query: string, column: string, type?: "ASC" | "DESC"): boolean;
+declare function isMutation(q?: string): boolean;
+declare function removeColumnFromQuery(q: string, colNameToRemove: string, cols: TableColumn[]): string;
+declare function makeQueryExecutable(q: string): string;
+declare function isMultipleQueries(queryString: string): boolean;
+
+declare function pluralize(num: number, str: string): string;
+
+declare function prettyJSON(data: any): string;
 declare function prettyJSONText(text: string): string;
 
 declare function randomArrayItem<T>(arr: T[]): T;
 
+declare function randomNum(min: number, max: number): number;
+
 declare function safeJSONParse(text: string): any;
 
 declare function tuplify<T extends any[]>(...elements: T): T;
 
-export { type Maybe, compareArray, dedupe, enumKeys, _default as excerpt, initialUppercase, nTimes, nTimesWithIndex, export_default as prettyJSON, prettyJSONText, randomArrayItem, safeJSONParse, tuplify };
+type Url = string | UrlObject;
+/**
+ * __Route__
+ *
+ * `Route` class that handles adding static and dynamic route segments to
+ * existing routes. `Route` can be initialized with a "href" string or
+ * `UrlObject` and optional "as" string or `UrlObject`.
+ *
+ * @example
+ * const routeA = new Route("/repositories");
+ * routeA.hrefPathname() // "/repositories"
+ * routeA.addDynamic("ownerName", "my-owner")
+ * routeA.hrefPathname() // "repositories/[ownerName]"
+ * routeA.asPathname() // "repositories/my-owner"
+ *
+ * const routeB = new Route(
+ *   { pathname: "/repositories/[ownerName]", query: { refName: "main" } },
+ *   { pathname: "/repositories/my-owner", query: { refName: "main" } },
+ * )
+ * routeB.hrefPathname() // "/repositories/[ownerName]"
+ * routeB.asPathname() // "repositories/my-owner"
+ * routeB.getQuery() // { refName: "main" }
+ */
+declare class Route {
+    href: Url;
+    as: Url;
+    constructor(href: Url, as?: Url);
+    /**
+     * __hrefPathname__
+     *
+     * Gets pathname string from href string or `UrlObject`.
+     *
+     * @param addFrag Optional route fragment string to add to `href` pathname
+     *
+     * @returns `href` pathname string, with added route fragment if provided
+     *
+     * @example
+     * const routeA = new Route("/repositories");
+     * routeA.hrefPathname() // "/repositories"
+     * routeA.hrefPathname("[ownerName]") // "repositories/[ownerName]"
+     *
+     * const routeB = new Route({ pathname: "/repositories" })
+     * routeB.hrefPathname() // "/repositories"
+     * routeB.hrefPathname("[ownerName]") // "repositories/[ownerName]"
+     */
+    hrefPathname(addFrag?: string): string;
+    /**
+     *  __asPathname__
+     *
+     * Gets pathname string from as string or `UrlObject`.
+     *
+     * @param addFrag Optional route fragment string to add to `as` pathname
+     *
+     * @returns `as` pathname string, with added route fragment if provided
+     *
+     * @example
+     * const routeA = new Route("/repositories");
+     * routeA.asPathname() // "/repositories"
+     * routeA.asPathname("my-username") // "repositories/my-username"
+     *
+     * const routeB = new Route(
+     *   { pathname: "/repositories/[ownerName]" },
+     *   { pathname: "/repositories/my-username" },
+     * );
+     * routeB.asPathname() // "/repositories/my-username"
+     * routeB.asPathname("data") // "repositories/my-username/data"
+     */
+    asPathname(addFrag?: string): string;
+    /**
+     * __getQuery__
+     *
+     * Gets query object from the href `UrlObject`.
+     *
+     * @returns query object
+     *
+     * @example
+     * const route = new Route("/repositories");
+     * route.withQuery({ refName: "main" })
+     * route.getQuery() // { refName: "main" }
+     */
+    getQuery(): string | ParsedUrlQueryInput | undefined | null;
+    /**
+     * __getHash__
+     *
+     * Gets hash string from the href `UrlObject`.
+     *
+     * @returns hash string
+     *
+     * @example
+     * const route = new Route("/repositories");
+     * route.withHash("commitA")
+     * route.getHash() // "commitA"
+     */
+    getHash(): string;
+    /**
+     * __addStatic__
+     *
+     * Adds static route fragment string to a `Route`. Static route fragments look like:
+     * ```ts
+     * { href: "/repositories", as: "/repositories" }
+     * ```
+     * As opposed to dynamic route fragments which look like:
+     * ```ts
+     * { href: "/[ownerName]", as: "/owner-value" }
+     * ```
+     *
+     * @param pathFrag Route fragment string to add to the url. "/" is automatically prepended.
+     *
+     * @returns new instance of `Route`
+     *
+     * @example
+     * const route = new Route("/repositories");
+     * route.addStatic("data")
+     * route.hrefPathname() // "/repositories/data"
+     * route.asPathname() // "/repositories/data"
+     */
+    addStatic(pathFrag: string): Route;
+    /**
+     * __maybeAddStatic__
+     *
+     * Maybe adds static route fragment string to a `Route`.
+     *
+     * @see this.addStatic
+     *
+     * @param pathFrag Optional route fragment string to add to the url. "/" is automatically prepended.
+     *
+     * @example
+     * const route = new Route("/repositories");
+     * route.maybeAddStatic("data")
+     * route.hrefPathname() // "/repositories/data"
+     * route.maybeAddStatic()
+     * route.hrefPathname() // "/repositories"
+     */
+    maybeAddStatic(pathFrag?: string): Route;
+    /**
+     * __addDynamic__
+     *
+     * Adds dynamic route fragment string to a Route.
+     * Dynamic route fragments look like:
+     * ```ts
+     * { href: "/[ownerName]", as: "/owner-value" }
+     * ```
+     * As opposed to static route fragments which look like:
+     *
+     * ```ts
+     * { href: "/repositories", as: "/repositories" }
+     * ```
+     *
+     * @param param String fragment to add to the href path. This value will be wrapped in square brackets. "/" is automatically prepended.
+     * @param as Value of the `param` to be added to the `as` path. "/" is automatically prepended.
+     * @param encode Default false. If true, encodes a `as` param value string as a valid component of a Uniform Resource Identifier (URI).
+     *
+     * @returns new instance of `Route`
+     *
+     * @example
+     * const route = new Route("/repositories");
+     * route.addDynamic("ownerName", "my-owner-name")
+     * route.hrefPathname() // "/repositories/[ownerName]"
+     * route.asPathname() // "/repositories/my-owner-name"
+     */
+    addDynamic(param: string, as: string, encode?: boolean): Route;
+    /**
+     * __withQuery__
+     *
+     * Adds query object to a `Route`. Looks like "?refName=main&active=Tables"
+     * when url is formatted.
+     *
+     * @param q Record with fields that will be added to the query string.
+     *
+     * @returns new instance of `Route`
+     *
+     * @example
+     * const route = new Route("/repositories/[ownerName]", "/repositories/my-owner");
+     * route.withQuery({ refName: "main", active: undefined })
+     * route.hrefPathname() // { pathname: "/repositories/[ownerName]", query: { refName: "main" } }
+     * route.asPathname() // { pathname: "/repositories/my-owner", query: { refName: "main" } }
+     */
+    withQuery(q: Record<string, string | undefined | null>): Route;
+    /**
+     * __withHash__
+     *
+     * Adds hash string to a `Route`. Looks like "#hash-value" when url is formatted.
+     *
+     * @param hash Optional hash string
+     *
+     * @returns new instance of Route
+     *
+     * @example
+     * const route = new Route("/repositories/[ownerName]", "/repositories/my-owner");
+     * route.withHash({ commitId: "commitA" })
+     * route.hrefPathname() // { pathname: "/repositories/[ownerName]", hash: { commitId: "commitA" } }
+     * route.asPathname() // { pathname: "/repositories/my-owner", hash: { commitId: "commitA" } }
+     */
+    withHash(hash?: string): Route;
+}
+
+declare function emailValidator(s: string): {
+    isValid: boolean;
+    errorMsg: string;
+};
+declare function usernameValidator(s: string): {
+    isValid: boolean;
+    errorMsg: string;
+    detailedErrorMsg: string;
+};
+
+export { type Maybe, NULL_VALUE, Route, areTimeAgosEqual, compareArray, convertToSqlWithNewColNames, convertToSqlWithNewCols, convertToSqlWithNewCondition, convertToSqlWithOrderBy, convertToUTCDate, dedupe, emailValidator, enumKeys, excerpt, fakeEscapePress, formatNumber, formatToRoundedUsd, formatToUsd, getColumns, getDateMinusHours, getDateString, getDisplayValue, getDisplayValueForApi, getLongDateTimeString, getNow, getTableName, getTimeAgoString, getTimeWithSeconds, getUTCDateAndTimeString, getUTCDateString, getUTCNowDateString, getUTCTimeString, initialUppercase, isMultipleQueries, isMutation, isNullValue, loremer, makeQueryExecutable, nTimes, nTimesWithIndex, oneHour, parseSelectQuery, pluralize, prettyJSON, prettyJSONText, queryHasOrderBy, randomArrayItem, randomNum, removeColumnFromQuery, requireTableNameForSelect, safeJSONParse, tuplify, usernameValidator };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@dolthub/web-utils",
   "author": "DoltHub",
-  "version": "0.1.0",
+  "description": "A collection of utilities for building web applications",
+  "version": "0.1.3",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/index.d.ts",
@@ -21,7 +22,7 @@
     "lint": "eslint --cache --ext .ts,.js,.tsx,.jsx src",
     "prettier": "prettier --check 'src/**/*.{js,ts}'",
     "prettier-fix": "prettier --write 'src/**/*.{js,ts}'",
-    "publish": "yarn dbuild && npm publish",
+    "npm:publish": "yarn dbuild && npm publish",
     "test": "jest",
     "yalc:publish": "yarn dbuild && yalc publish",
     "yalc:push": "yarn dbuild && yalc push"
@@ -55,5 +56,9 @@
   },
   "bugs": {
     "url": "https://github.com/dolthub/react-library/issues"
+  },
+  "dependencies": {
+    "node-sql-parser": "^4.17.0",
+    "timeago.js": "^4.0.2"
   }
 }