inferred-types 0.51.1 → 0.51.2

package/src/runtime/type-guards/urls/repos/github.ts

@@ -1,198 +0,0 @@
-import {
-  GithubOrgUrl,
-  GithubRepoIssuesListUrl,
-  GithubRepoIssueUrl,
-  GithubRepoProjectsUrl,
-  GithubRepoProjectUrl,
-  GithubRepoReleasesUrl,
-  GithubRepoReleaseTagUrl,
-  GithubRepoUrl,
-  GithubUrl
-} from "inferred-types/dist/types/index"
-import { isString } from "inferred-types/dist/runtime/index"
-import { stripLeading, stripTrailing } from "../../../literals"
-
-
-/**
- * **isGithubUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * **Github** URL.
- */
-export const isGithubUrl = (val: unknown): val is GithubUrl => {
-  const valid = [
-    "https://github.com",
-    'https://www.github.com',
-    'https://github.io'
-  ];
-  return isString(val) && valid.some(i =>
-    val === i ||
-    val.startsWith(`${i}/`) ||
-    val.startsWith(`${i}?`)
-  );
-}
-
-/**
- * **isGithubOrgUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * **Github** _organization_ URL.
- */
-export const isGithubOrgUrl = <T>(val: T): val is GithubOrgUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    stripper(val).length === 2
-  )
-}
-
-const stripper = (s: string) => {
-  return stripTrailing(
-    stripLeading(s, "https://github.com/"),
-    "/"
-  )
-}
-
-/**
- * **isGithubRepoUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * **Github** _repo_ URL.
- */
-export const isGithubRepoUrl = <T>(val: T): val is GithubRepoUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    stripper(val).split("/").length === 2
-  ) ? true : false
-}
-
-
-/**
- * **isGithubRepoReleasesUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * URL for the _releases_ of a given _repo_.
- *
- * **Related:** `isGithubRepoReleaseTagUrl`
- */
-export const isGithubRepoReleasesUrl = <T>(val: T): val is GithubRepoReleasesUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    val.includes("/releases") &&
-    stripper(val).split("/").length === 3
-  )
-}
-
-/**
- * **isGithubRepoReleaseTagUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * URL for the _releases_ of a given _repo_.
- *
- * **Related:** `isGithubRepoReleasesUrl`
- */
-export const isGithubRepoReleaseTagUrl = <T>(val: T): val is GithubRepoReleaseTagUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    val.includes("/releases/tag/") &&
-    stripper(val).length === 4
-  )
-}
-
-
-/**
- * **isGithubIssuesListUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * URL for the _issues_ of a given _repo_.
- *
- * **Related:** `isGithubIssueUrl`
- */
-export const isGithubIssuesListUrl = <T>(val: T): val is GithubRepoIssuesListUrl & T => {
-  return isString(val) &&
-    val.startsWith("https://github.com/") &&
-    val.includes("/issues")
-}
-
-
-/**
- * **isGithubIssueUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * URL for the _issues_ of a given _repo_.
- *
- * **Related:** `isGithubIssuesListUrl`
- */
-export const isGithubIssueUrl = <T>(val: T): val is GithubRepoIssueUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    val.includes("/issues/")
-  )
-}
-
-/**
- * **isGithubProjectsListUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * URL for the _projects_ of a given _repo_.
- *
- * **Related:** `isGithubProjectUrl`
- */
-export const isGithubProjectsListUrl = <T>(val: T): val is GithubRepoProjectsUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    (val.includes("/projects?") || val.trim().endsWith("/projects") ) &&
-    stripper(val).split("/").length === 3
-  )
-}
-
-
-/**
- * **isGithubProjectUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * URL for a _specific project_ of a given _repo_.
- *
- * **Related:** `isGithubProjectsListUrl`
- */
-export const isGithubProjectUrl = <T>(val: T): val is GithubRepoProjectUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    val.includes("/projects/") &&
-    stripper(val).split("/").length === 4
-  )
-}
-
-
-/**
- * **isGithubReleasesListUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * URL for the _Releases_ of a given _repo_.
- *
- * **Related:** `isGithubReleaseTagUrl`
- */
-export const isGithubReleasesListUrl = <T>(val: T): val is GithubRepoReleasesUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    (val.includes("/releases?") || val.trim().endsWith("/releases") ) &&
-    stripper(val).split("/").length === 3
-  )
-}
-
-
-/**
- * **isGithubReleaseTagUrl**`(val)`
- *
- * Type guard which validates that the passed in value is a valid
- * URL for a _specific release_ of a given _repo_.
- *
- * **Related:** `isGithubReleasesListUrl`
- */
-export const isGithubReleaseTagUrl = <T>(val: T): val is GithubRepoProjectUrl & T => {
-  return isString(val) && (
-    val.startsWith("https://github.com/") &&
-    val.includes("/releases/tag/") &&
-    stripper(val).split("/").length === 5
-  )
-}
-

package/src/runtime/type-guards/urls/repos/index.ts

@@ -1,19 +0,0 @@
-import { RepoUrls } from "inferred-types/dist/types/index";
-import { isGithubUrl } from "./github";
-import { isBitbucketUrl } from "./bitbucket";
-import { isCodeCommitUrl } from "./codeCommit";
-
-export * from "./github";
-export * from "./bitbucket";
-export * from "./codeCommit";
-export * from "./isSemanticVersion"
-
-/**
- * **isRepoUrl**`(val)`
- *
- * Type guard which validates that the value passed in is a valid Repo URL
- */
-export const isRepoUrl = (val: unknown): val is RepoUrls => {
-  return isGithubUrl(val) || isBitbucketUrl(val) || isCodeCommitUrl(val)
-}
-

package/src/runtime/type-guards/urls/repos/isSemanticVersion.ts

@@ -1,46 +0,0 @@
-import {
-  RepoSource,
-  SemanticVersion,
-} from "inferred-types/dist/types/index";
-import { REPO_SOURCES } from "inferred-types/dist/constants/index";
-import {  stripLeading, isString } from "src/runtime/index";
-
-/**
- * **isRepoSource**`(val)`
- *
- * Type guard which validates whether the value passed in is a
- * `RepoSource`.
- */
-export const isRepoSource = <T>(v: T): v is T & RepoSource => {
-  return isString(v) && REPO_SOURCES.includes(v as any);
-}
-
-/**
- * **isSemanticVersion**`(val,[allowPrefix]=false)`
- *
- * Type guard which validates whether the value passed in is a
- * semantic version number.
- *
- * - the optional `allowPrefix` parameter allows for a lowercase "v"
- * to be prefixed to the version so that values like `v1.0.12` and
- * `v 1.0.12` are allowed.
- * - by default the `allowPrefix` option is set to false
- */
-export const isSemanticVersion = <T,P extends boolean>(
-  v:T,
-  allowPrefix: P = false as P
-): v is T & SemanticVersion<P> => {
-  return (
-    isString(v) &&
-    v.split(".").length === 3 &&
-    !Number.isNaN(Number(v.split(".")[1])) &&
-    !Number.isNaN(Number(v.split(".")[2])) &&
-    (
-      !Number.isNaN(Number(v.split(".")[0])) ||
-      (
-        allowPrefix && !Number.isNaN(Number(stripLeading(v.split(".")[0], "v").trim()))
-      )
-    )
-  );
-}
-

package/src/runtime/type-guards/urls/retail.ts

@@ -1,221 +0,0 @@
-import {
-  AmazonUrl,
-  AppleUrl,
-  BestBuyUrl,
-  CostCoUrl,
-  CvsUrl,
-  DellUrl,
-  EbayUrl,
-  EtsyUrl,
-  HandMUrl,
-  HomeDepotUrl,
-  IkeaUrl,
-  KrogerUrl,
-  LowesUrl,
-  MacysUrl,
-  NikeUrl,
-  RetailUrl,
-  TargetUrl,
-  WalgreensUrl,
-  WalmartUrl,
-  WayFairUrl,
-  WholeFoodsUrl,
-  ZaraUrl
-} from "inferred-types/dist/types/index";
-import { isString } from "../isString";
-import {
-  AMAZON_DNS,
-  APPLE_DNS,
-  BEST_BUY_DNS,
-  COSTCO_DNS,
-  CVS_DNS,
-  DELL_DNS,
-  EBAY_DNS,
-  ETSY_DNS,
-  HM_DNS,
-  HOME_DEPOT_DNS,
-  KROGER_DNS,
-  MACYS_DNS,
-  NIKE_DNS,
-  TARGET_DNS,
-  WALGREENS_DNS,
-  WALMART_DNS,
-  WAYFAIR_DNS,
-  WHOLE_FOODS_DNS,
-  ZARA_DNS,
-} from "inferred-types/dist/constants/index";
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Whole Food Markets**.
- */
-export const isWholeFoodsUrl = (val: unknown): val is WholeFoodsUrl => {
-  return isString(val) && WHOLE_FOODS_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **CVS** pharmacy.
- */
-export const isCvsUrl = (val: unknown): val is CvsUrl => {
-  return isString(val) && CVS_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Walgreens** pharmacy.
- */
-export const isWalgreensUrl = (val: unknown): val is WalgreensUrl => {
-  return isString(val) && WALGREENS_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **CVS** pharmacy.
- */
-export const isKrogersUrl = (val: unknown): val is KrogerUrl => {
-  return isString(val) && KROGER_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **CVS** pharmacy.
- */
-export const isZaraUrl = (val: unknown): val is ZaraUrl => {
-  return isString(val) && ZARA_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **H&M** retailer.
- */
-export const isHmUrl = (val: unknown): val is HandMUrl => {
-  return isString(val) && HM_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Dell** retailer.
- */
-export const isDellUrl = (val: unknown): val is DellUrl => {
-  return isString(val) && DELL_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Ikea** retailer.
- */
-export const isIkeaUrl = (val: unknown): val is IkeaUrl => {
-  return isString(val) && KROGER_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Lowes** retailer.
- */
-export const isLowesUrl = (val: unknown): val is LowesUrl => {
-  return isString(val) && KROGER_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Macy's** retailer.
- */
-export const isNikeUrl = (val: unknown): val is NikeUrl => {
-  return isString(val) && NIKE_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Macy's** retailer.
- */
-export const isWayfairUrl = (val: unknown): val is WayFairUrl => {
-  return isString(val) && WAYFAIR_DNS.some(i => val.startsWith(`https://${i}`));
-}
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Macy's** retailer.
- */
-export const isBestBuyUrl = (val: unknown): val is BestBuyUrl => {
-  return isString(val) && BEST_BUY_DNS.some(i => val.startsWith(`https://${i}`));
-}
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Macy's** retailer.
- */
-export const isCostCoUrl = (val: unknown): val is CostCoUrl => {
-  return isString(val) && COSTCO_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Macy's** retailer.
- */
-export const isEtsyUrl = (val: unknown): val is EtsyUrl => {
-  return isString(val) && ETSY_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Macy's** retailer.
- */
-export const isTargetUrl = (val: unknown): val is TargetUrl => {
-  return isString(val) && TARGET_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Macy's** retailer.
- */
-export const isEbayUrl = (val: unknown): val is EbayUrl => {
-  return isString(val) && EBAY_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for the **Home Depot** retailer.
- */
-export const isHomeDepotUrl = (val: unknown): val is HomeDepotUrl => {
-  return isString(val) && HOME_DEPOT_DNS.some(i => val.startsWith(`https://${i}`));
-}
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for the **Macy's** retailer.
- */
-export const isMacysUrl = (val: unknown): val is MacysUrl => {
-  return isString(val) && MACYS_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Apple**.
- */
-export const isAppleUrl = (val: unknown): val is AppleUrl => {
-  return isString(val) && APPLE_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Walmart**.
- */
-export const isWalmartUrl = (val: unknown): val is WalmartUrl => {
-  return isString(val) && WALMART_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which validates that the `val` passed in is a valid URL
- * for **Walmart**.
- */
-export const isAmazonUrl = (val: unknown): val is AmazonUrl => {
-  return isString(val) && AMAZON_DNS.some(i => val.startsWith(`https://${i}`));
-}
-
-/**
- * type guard which check if the passed in value is a Url for one
- * of the top retailers in the world
- */
-export const isRetailUrl = (val: unknown): val is RetailUrl => {
-  return isAmazonUrl(val) || isWalgreensUrl(val) || isAppleUrl(val) || isMacysUrl(val) || isEbayUrl(val) || isHomeDepotUrl(val) || isTargetUrl(val) || isEtsyUrl(val) || isCostCoUrl(val) || isBestBuyUrl(val) || isWayfairUrl(val) || isNikeUrl(val) || isLowesUrl(val) || isIkeaUrl(val) || isDellUrl(val) || isHmUrl(val) || isZaraUrl(val) || isKrogersUrl(val) || isWalgreensUrl(val) || isCvsUrl(val) || isWholeFoodsUrl(val)
-
-}

package/src/runtime/type-guards/urls/youtube.ts

@@ -1,172 +0,0 @@
-import {
-  YouTubeCreatorUrl,
-  YouTubeFeedType,
-  YouTubeFeedUrl,
-  YouTubePlaylistUrl,
-  YouTubeShareUrl,
-  YouTubeUrl,
-  YouTubeVideosInPlaylist
-} from "inferred-types/dist/types/index";
-import { isString, isUndefined, hasUrlQueryParameter } from "src/runtime/index";
-
-/**
- * **isYouTubeUrl**`(val)`
- *
- * Type guard which checks whether the passed in value is a valid
- * YouTube URL.
- */
-export const isYouTubeUrl = <T>(val: T): val is T & YouTubeUrl => {
-  return isString(val) && (
-    val.startsWith("https://www.youtube.com") ||
-    val.startsWith("https://youtube.com") ||
-    val.startsWith("https://youtu.be")
-  )
-}
-
-/**
- * **isYouTubeShareUrl**`(val)`
- *
- * Type guard which checks whether the passed in value is a URL
- * from YouTube's _URL shortening_ site `https://youtu.be`.
- */
-export const isYouTubeShareUrl = <T>(val:T): val is T & YouTubeShareUrl => {
-  return isString(val) && val.startsWith(`https://youtu.be`);
-}
-
-/**
- * **isYouTubeVideoUrl**`(val)`
- *
- * Type guard which checks whether the passed in value is a valid
- * YouTube URL _which plays video_.
- */
-export const isYouTubeVideoUrl = <T>(val: T): val is T & YouTubeUrl => {
-  return isString(val) && (
-    val.startsWith("https://www.youtube.com") ||
-    val.startsWith("https://youtube.com") ||
-    val.startsWith("https://youtu.be")
-  )
-}
-
-/**
- * **isYouTubePlaylistUrl**`(val)`
- *
- * Type guard which checks whether the passed in value is a valid
- * YouTube URL which points to a "playlist" on the platform.
- */
-export const isYouTubePlaylistUrl = <T>(val: T): val is T & YouTubePlaylistUrl => {
-  return isString(val) && (
-    val === `https://www.youtube.com/feed/playlists` ||
-    val === `https://youtube.com/feed/playlists` ||
-    val === `https://www.youtube.com/channel/playlists` ||
-    val === `https://youtube.com/channel/playlists` ||
-    ( val.startsWith(`https://www.youtube.com/@`) && val.endsWith(`/playlists`)) ||
-    ( val.startsWith(`https://youtube.com/@`) && val.endsWith(`/playlists`))
-  )
-}
-
-/**
- * maps the "feed type" to a URL path
- */
-const feed_map = <T extends YouTubeFeedType | undefined>(type: T) => {
-  return isUndefined(type)
-    ? `/feed`
-    : type === "liked"
-    ? `/playlist?list=LL`
-    : ["history","playlists","trending","subscriptions"].includes(type)
-      ? `/feed/${type}`
-      : `/feed/`;
-}
-
-/**
- * **isYouTubeFeedUrl**`(val,[kind])**
- *
- * Type guard which checks whether the passed in value is a valid
- * YouTube URL which responds with "feed" content. This is content
- * which is available to a logged in user and helps them see lists
- * of videos related to their settings.
- *
- * By default any "feed" URL is matched but you can narrow that down
- * to a specific feed type by specifying the `kind` variable.
- */
-export const isYouTubeFeedUrl = <
-  T,
-  U extends YouTubeFeedType = YouTubeFeedType
->(
-  val:T,
-  type?: U
-): val is T & YouTubeFeedUrl<U> => {
-  return isString(val) && (
-    val.startsWith(`https://www.youtube.com${feed_map(type)}`) ||
-    val.startsWith(`https://youtube.com${feed_map(type)}`)
-  )
-}
-
-/**
- * **isYouTubeHistoryUrl**`(val,[kind])**
- *
- * Type guard which checks whether the passed in value is a valid
- * YouTube URL which responds with a user's history feed.
- */
-export const isYouTubeFeedHistoryUrl = <T>(val: T) => {
-  return isString(val) && (
-    val.startsWith(`https://www.youtube.com/feed/history`) ||
-    val.startsWith(`https://youtube.com/feed/history`)
-  )
-}
-
-/**
- * **isYouTubePlaylistsUrl**`(val,[kind])**
- *
- * Type guard which checks whether the passed in value is a valid
- * YouTube URL which responds with a user's own playlists page.
- */
-export const isYouTubePlaylistsUrl = <T>(val: T) => {
-  return isString(val) && (
-    val.startsWith(`https://www.youtube.com/feed/playlists`) ||
-    val.startsWith(`https://youtube.com/feed/playlists`)
-  )
-}
-
-/**
- * **isYouTubeTrendingUrl**`(val,[kind])**
- *
- * Type guard which checks whether the passed in value is a valid
- * YouTube URL which responds with a user's own history feed.
- */
-export const isYouTubeTrendingUrl = <T>(val: T) => {
-  return isString(val) && (
-    val.startsWith(`https://www.youtube.com/feed/trending`) ||
-    val.startsWith(`https://youtube.com/feed/trending`)
-  )
-}
-
-/**
- * **isYouTubeSubscriptionsUrl**`(val,[kind])**
- *
- * Type guard which checks whether the passed in value is a valid
- * YouTube URL which responds with a user's own subscriptions feed.
- */
-export const isYouTubeSubscriptionsUrl = <T>(val: T) => {
-  return isString(val) && (
-    val.startsWith(`https://www.youtube.com/feed/subscriptions`) ||
-    val.startsWith(`https://youtube.com/feed/subscriptions`)
-  )
-}
-
-
-export const isYouTubeCreatorUrl = <T extends string>(
-  url: T
-): url is T & YouTubeCreatorUrl => {
-  return isString(url) && (
-    url.startsWith(`https://www.youtube.com/@`) ||
-    url.startsWith(`https://youtube.com/@`) ||
-    url.startsWith(`https://www.youtube.com/channel/`)
-  );
-}
-
-export const isYouTubeVideosInPlaylist = <T>(val: T): val is T & YouTubeVideosInPlaylist => {
-  return isString(val) && (
-    val.startsWith(`https://www.youtube.com/playlist?`) ||
-    val.startsWith(`https://youtube.com/playlist?`)
-  ) && hasUrlQueryParameter(val, "list")
-}

package/src/runtime/vuejs/asVueRef.ts

@@ -1,18 +0,0 @@
-import { Narrowable, VueRef } from "inferred-types/dist/types/index";
-
-/**
- * **asVueRef**(value)
- *
- * Receives a _value_ and makes it look like a `VueRef<T>` which will make
- * it pass the `IsRef<T>` type check. It also provides a hidden `_value` property
- * to the runtime which makes it pass the `isRef()` runtime check.
- *
- * Note:
- *
- * - this is a convenience function for building test cases in a library where you're
- * not actually exporting VueJS symbols (like inferred-types).
- */
-export const asVueRef = <T extends Narrowable>(value: T) => ({
-  value,
-  _value: null
-}) as unknown as VueRef<T>;

package/src/runtime/vuejs/index.ts

@@ -1 +0,0 @@
-export * from "./asVueRef";

package/src/types/README.md

@@ -1,3 +0,0 @@
-# Types
-
-A directory for types only. These types _will_ be exported as symbols during the build process.