inferred-types 0.54.8 → 0.55.0

package/README.md

@@ -70,6 +70,20 @@ const people = pluralize("person");
 #### Data Patterns
 
 - types like `Url`, `IpAddress`, `CSV`, `DotPath`, `Hexadecimal`, `ZipCode`, and `DomainName` attempt to provide an out of the box type for common data structure patterns we find in the real world
+- ISO3166 support (aka, countries):
+  - `Iso3166_Alpha2`, `Iso3166_Alpha3`, ...
+  - `isIso3166Alpha2()`, `isIsoAlpha3()`, type guards ...
+- ISO8601 support (aka, datetime)
+  - `Iso8601DateTime`, `Iso8601Date`, `Iso8601Time`, ...
+  - `isIsoDateTime()`, `isIsoDate()`, `isIsoTime()`, ...
+
+#### String Literal Matching at design time and run time
+
+```ts
+const matcher = infer("{{ string }} is a {{ infer foo }} utility, that {{ infer bar }}");
+// { foo: "fancy"; bar: "thinks it's better than you!"}
+const fooBar = matcher("infer is a fancy utility, that thinks it's better than you!")
+```
 
 ### Numeric Literals
 
@@ -89,42 +103,73 @@ const people = pluralize("person");
 
 ### Object / Dictionaries
 
-1. Based on an object's entity values:
-
-    Assume a base type of `Obj`:
-
-    ```ts
-    type Obj = {
-        n1: number;
-        n2: 2;
-        n3: 3;
-        success: true;
-        s1: string;
-        s2: "hello";
-    }
-    ```
-
-    We can get a union of string literals representing the _keys_ on the object whose value _extends_ some value:
-
-    ```ts
-    import type { KeysWithValue, KeysWithoutValue } from "inferred-types";
-    // "s1" | "s2"
-    type S = KeysWithValue<Obj, string>;
-    // "success" | "n1" | "n2"
-    type N = KeysWithoutValue<Obj, string>;
-    ```
-
-    > though less used, you can also use `KeysEqualValue` and `KeysNotEqualValue` for equality matching
-
-    If you'd prefer to mutate the object's type rather than just identify the _keys_ which extend a value you can do this with: `WithValue` and `WithoutValue`:
-
-     ```ts
-     import type { WithValue, WithoutValue } from "inferred-types";
-     // { s1: string; s2: "hello" }
-     type S = WithValue<Obj, string>;
-     // { success: true; n1: number; n2: 2; n3: 3 }
-     type N = WithoutValue<Obj, string>;
-     ```
+#### Reduce Object to Keys with a knownValue
+
+  Assume a base type of `Obj`:
+
+  ```ts
+  type Obj = {
+      n1: number;
+      n2: 2;
+      n3: 3;
+      success: true;
+      s1: string;
+      s2: "hello";
+  }
+  ```
+
+  We can get a union of string literals representing the _keys_ on the object whose value _extends_ some value:
+
+  ```ts
+  import type { KeysWithValue, KeysWithoutValue } from "inferred-types";
+  // "s1" | "s2"
+  type S = KeysWithValue<Obj, string>;
+  // "success" | "n1" | "n2"
+  type N = KeysWithoutValue<Obj, string>;
+  ```
+
+  > though less used, you can also use `KeysEqualValue` and `KeysNotEqualValue` for equality matching
+
+  If you'd prefer to mutate the object's type rather than just identify the _keys_ which extend a value you can do this with: `WithValue` and `WithoutValue`:
+
+   ```ts
+   import type { WithValue, WithoutValue } from "inferred-types";
+   // { s1: string; s2: "hello" }
+   type S = WithValue<Obj, string>;
+   // { success: true; n1: number; n2: 2; n3: 3 }
+   type N = WithoutValue<Obj, string>;
+   ```
+
+  And at runtime:
+
+  ```ts
+  // { foo: "hi" }
+  const foo = withoutValue("number")({ foo: "hi", bar: 42, baz: 99 });
+  // { bar: 42 }
+  const bar = withoutValue("number(42,55,66)")({ foo: "hi", bar: 42, baz: 99 });
+
+  // { foo: "hi", bar: 42 }
+  const fooBar = withoutKeys("baz")({ foo: "hi", bar: 42, baz: 99 });
+  // { foo: "hi", bar: 42 }
+  const fooBar2 = withKeys("foo", "bar")({ foo: "hi", bar: 42, baz: 99 })
+  ```
+
+#### Reduce Object's to only `Required` or `Optional` keys
+
+```ts
+type Obj = { foo: string; bar?: string; baz?: number };
+// "foo"
+type ReqKeys = RequiredKeys<Obj>;
+// ["foo"]
+type ReqKeyTup = RequiredKeysTuple<Obj>;
+// "bar" | "baz"
+type OptKeys = OptionalKeys<Obj>;
+// ["bar", "baz"]
+type OptKeyTup = OptionalKeysTuple<Obj>;
+
+type Reduced =
+
+```
 
 ## Contributing
 

package/modules/constants/dist/index.cjs

@@ -79,10 +79,14 @@ __export(src_exports, {
   MARKED: () => MARKED,
   MASS_METRICS_LOOKUP: () => MASS_METRICS_LOOKUP,
   MEXICAN_NEWS: () => MEXICAN_NEWS,
+  MIME_TYPES: () => MIME_TYPES,
   MONTH_ABBR: () => MONTH_ABBR,
   MONTH_NAME: () => MONTH_NAME,
   NARROW_CONTAINER_TYPE_KINDS: () => NARROW_CONTAINER_TYPE_KINDS,
+  NETWORK_PROTOCOL: () => NETWORK_PROTOCOL,
+  NETWORK_PROTOCOL_INSECURE: () => NETWORK_PROTOCOL_INSECURE,
   NETWORK_PROTOCOL_LOOKUP: () => NETWORK_PROTOCOL_LOOKUP,
+  NETWORK_PROTOCOL_SECURE: () => NETWORK_PROTOCOL_SECURE,
   NIKE_DNS: () => NIKE_DNS,
   NON_ZERO_NUMERIC_CHAR: () => NON_ZERO_NUMERIC_CHAR,
   NORWEGIAN_NEWS: () => NORWEGIAN_NEWS,
@@ -99,6 +103,7 @@ __export(src_exports, {
   PLURAL_EXCEPTIONS_OLD: () => PLURAL_EXCEPTIONS_OLD,
   POWER_METRICS_LOOKUP: () => POWER_METRICS_LOOKUP,
   PRESSURE_METRICS_LOOKUP: () => PRESSURE_METRICS_LOOKUP,
+  PROTOCOL_DEFAULT_PORTS: () => PROTOCOL_DEFAULT_PORTS,
   PROXMOX_CT_STATE: () => PROXMOX_CT_STATE,
   REPO_PAGE_TYPES: () => REPO_PAGE_TYPES,
   REPO_SOURCES: () => REPO_SOURCES,
@@ -740,6 +745,75 @@ var HASH_TABLE_CHAR = {
 };
 var HASH_TABLE_OTHER = "999";
 
+// src/Http.ts
+var MIME_TYPES = [
+  // Application MIME Types
+  "application/json",
+  "application/xml",
+  "application/javascript",
+  "application/pdf",
+  "application/ld+json",
+  "application/octet-stream",
+  "application/x-www-form-urlencoded",
+  "application/vnd.api+json",
+  "application/msword",
+  "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+  "application/vnd.ms-excel",
+  "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+  "application/vnd.ms-powerpoint",
+  "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+  // Text MIME Types
+  "text/plain",
+  "text/html",
+  "text/css",
+  "text/csv",
+  "text/javascript",
+  "text/markdown",
+  // Image MIME Types
+  "image/jpeg",
+  "image/png",
+  "image/gif",
+  "image/bmp",
+  "image/webp",
+  "image/svg+xml",
+  "image/tiff",
+  // Audio MIME Types
+  "audio/mpeg",
+  "audio/ogg",
+  "audio/wav",
+  "audio/webm",
+  "audio/flac",
+  // Video MIME Types
+  "video/mp4",
+  "video/mpeg",
+  "video/ogg",
+  "video/webm",
+  "video/quicktime",
+  // Multipart MIME Types
+  "multipart/form-data",
+  "multipart/mixed",
+  "multipart/alternative",
+  "multipart/related",
+  // Font MIME Types
+  "font/woff",
+  "font/woff2",
+  "font/ttf",
+  "font/otf",
+  // Other Common MIME Types
+  "application/rss+xml",
+  "application/atom+xml",
+  "application/x-pkcs12",
+  "application/x-shockwave-flash",
+  "application/x-www-form-urlencoded",
+  "application/x-font-ttf",
+  "application/x-font-opentype",
+  "application/x-font-woff",
+  "application/x-font-woff2",
+  "application/vnd.rar",
+  "application/zip",
+  "application/x-7z-compressed"
+];
+
 // src/Images.ts
 var IMAGE_FORMAT_LOOKUP = [
   { ext: "jpg", webFormat: true, other_ext: ["jpeg"] },
@@ -1091,13 +1165,51 @@ var IPv6 = {
 var IPv4 = {
   Loopback: "127.0.0.1"
 };
+var NETWORK_PROTOCOL_INSECURE = [
+  "http",
+  "ftp",
+  "ws",
+  "dns",
+  "telnet",
+  "imap",
+  "pop3",
+  "smtp"
+];
+var NETWORK_PROTOCOL_SECURE = [
+  "https",
+  "sftp",
+  "wss",
+  "sdns",
+  "ssh"
+];
+var NETWORK_PROTOCOL = [
+  ...NETWORK_PROTOCOL_INSECURE,
+  ...NETWORK_PROTOCOL_SECURE
+];
 var NETWORK_PROTOCOL_LOOKUP = {
   http: ["http", "https"],
   ftp: ["ftp", "sftp"],
   file: ["", "file"],
   ws: ["ws", "wss"],
   ssh: ["", "ssh"],
-  scp: ["", "scp"]
+  scp: ["", "scp"],
+  telnet: ["telnet", ""],
+  dns: ["dns", "sdns"]
+};
+var PROTOCOL_DEFAULT_PORTS = {
+  http: 80,
+  https: 443,
+  ws: 80,
+  wss: 443,
+  ssh: 22,
+  telnet: 23,
+  dns: 53,
+  sdns: 853,
+  smtp: 25,
+  imap: 142,
+  pop3: 110,
+  ftp: 21,
+  sftp: 22
 };
 var TOP_LEVEL_DOMAINS = [
   "com",
@@ -2844,10 +2956,14 @@ var TYPE_TRANSFORMS = {
   MARKED,
   MASS_METRICS_LOOKUP,
   MEXICAN_NEWS,
+  MIME_TYPES,
   MONTH_ABBR,
   MONTH_NAME,
   NARROW_CONTAINER_TYPE_KINDS,
+  NETWORK_PROTOCOL,
+  NETWORK_PROTOCOL_INSECURE,
   NETWORK_PROTOCOL_LOOKUP,
+  NETWORK_PROTOCOL_SECURE,
   NIKE_DNS,
   NON_ZERO_NUMERIC_CHAR,
   NORWEGIAN_NEWS,
@@ -2864,6 +2980,7 @@ var TYPE_TRANSFORMS = {
   PLURAL_EXCEPTIONS_OLD,
   POWER_METRICS_LOOKUP,
   PRESSURE_METRICS_LOOKUP,
+  PROTOCOL_DEFAULT_PORTS,
   PROXMOX_CT_STATE,
   REPO_PAGE_TYPES,
   REPO_SOURCES,