@turndown/library 0.1.22 → 0.1.23

package/dist/helpers/object/index.js

@@ -1,6 +1,9 @@
 const unsafePathSegments = new Set(["__proto__", "prototype", "constructor"]);
 const isRecord = (value) => {
-    return typeof value === "object" && value !== null && !Array.isArray(value) && !(value instanceof Date);
+    return (typeof value === "object" &&
+        value !== null &&
+        !Array.isArray(value) &&
+        !(value instanceof Date));
 };
 const isSafePathSegment = (segment) => {
     return segment.length > 0 && !unsafePathSegments.has(segment);
@@ -272,9 +275,7 @@ export const resetPagination = (sort, filters) => {
 export const formatPhoneNumber = (value) => {
     const originalValue = value.toString();
     const digits = originalValue.replace(/\D/g, "");
-    const normalizedDigits = digits.length === 11 && digits.startsWith("1")
-        ? digits.slice(1)
-        : digits;
+    const normalizedDigits = digits.length === 11 && digits.startsWith("1") ? digits.slice(1) : digits;
     if (normalizedDigits.length !== 10)
         return originalValue;
     const area = normalizedDigits.slice(0, 3);
@@ -422,7 +423,8 @@ export const getNestedValue = (value, path) => {
         if (currentValue === null || currentValue === undefined) {
             return undefined;
         }
-        if (typeof currentValue !== "object" && typeof currentValue !== "function") {
+        if (typeof currentValue !== "object" &&
+            typeof currentValue !== "function") {
             return undefined;
         }
         currentValue = currentValue[pathSegment];
@@ -445,7 +447,8 @@ export const getNestedValue = (value, path) => {
  */
 export const setNestedValue = (objectToUpdate, path, value) => {
     const pathSegments = getPathSegments(path);
-    if (pathSegments.length === 0 || pathSegments.some((pathSegment) => !isSafePathSegment(pathSegment))) {
+    if (pathSegments.length === 0 ||
+        pathSegments.some((pathSegment) => !isSafePathSegment(pathSegment))) {
         return objectToUpdate;
     }
     let currentValue = objectToUpdate;

package/dist/helpers/string/index.d.ts

@@ -1,6 +1,7 @@
 /**
  * String utilities for common text manipulation tasks.
  */
+import { TUSStateCode } from "@/types";
 /**
  * Adds commas to a number for thousands separators.
  *
@@ -248,10 +249,10 @@ export declare const containsAny: (str: string, ...substrings: string[]) => bool
  */
 export declare const containsAll: (str: string, ...substrings: string[]) => boolean;
 export interface IAddress {
-    addressLine1?: string;
+    addressLine1: string;
     addressLine2?: string;
-    city?: string;
-    stateCode?: string;
-    postalCode?: string;
+    city: string;
+    stateCode: TUSStateCode;
+    postalCode: string;
 }
 export declare const formatAddress: (address: IAddress) => string;

package/dist/helpers/string/index.js

@@ -65,10 +65,7 @@ export const toCamelCase = (str) => {
         return "";
     }
     const [firstWord, ...remainingWords] = words;
-    return [
-        firstWord.toLowerCase(),
-        ...remainingWords.map(capitalizeWord),
-    ].join("");
+    return [firstWord.toLowerCase(), ...remainingWords.map(capitalizeWord)].join("");
 };
 export const camelCase = toCamelCase;
 /**
@@ -78,7 +75,9 @@ export const camelCase = toCamelCase;
  * @example toKebabCase('Hello_World') => 'hello-world'
  */
 export const toKebabCase = (str) => {
-    return getWords(str).map((word) => word.toLowerCase()).join("-");
+    return getWords(str)
+        .map((word) => word.toLowerCase())
+        .join("-");
 };
 export const kebabCase = toKebabCase;
 /**
@@ -88,7 +87,9 @@ export const kebabCase = toKebabCase;
  * @example toSnakeCase('hello-world') => 'hello_world'
  */
 export const toSnakeCase = (str) => {
-    return getWords(str).map((word) => word.toLowerCase()).join("_");
+    return getWords(str)
+        .map((word) => word.toLowerCase())
+        .join("_");
 };
 export const snakeCase = toSnakeCase;
 /**

package/dist/types/base/index.d.ts

@@ -102,76 +102,67 @@ export declare const US_STATES_CODE: {
     readonly AS: "AS";
     readonly MP: "MP";
 };
-export type TUnitedStatesStateCode = TRecordValue<typeof US_STATES_CODE>;
-export declare const UNITED_STATES_JURISDICTIONS: {
-    readonly Alabama: "Alabama";
-    readonly Alaska: "Alaska";
-    readonly AmericanSamoa: "American Samoa";
-    readonly Arizona: "Arizona";
-    readonly Arkansas: "Arkansas";
-    readonly BakerIsland: "Baker Island";
-    readonly California: "California";
-    readonly Colorado: "Colorado";
-    readonly Connecticut: "Connecticut";
-    readonly Delaware: "Delaware";
-    readonly DistrictOfColumbia: "District of Columbia";
-    readonly Florida: "Florida";
-    readonly Georgia: "Georgia";
-    readonly Guam: "Guam";
-    readonly Hawaii: "Hawaii";
-    readonly HowlandIsland: "Howland Island";
-    readonly Idaho: "Idaho";
-    readonly Illinois: "Illinois";
-    readonly Indiana: "Indiana";
-    readonly Iowa: "Iowa";
-    readonly JarvisIsland: "Jarvis Island";
-    readonly JohnstonAtoll: "Johnston Atoll";
-    readonly Kansas: "Kansas";
-    readonly Kentucky: "Kentucky";
-    readonly KingmanReef: "Kingman Reef";
-    readonly Louisiana: "Louisiana";
-    readonly Maine: "Maine";
-    readonly Maryland: "Maryland";
-    readonly Massachusetts: "Massachusetts";
-    readonly Michigan: "Michigan";
-    readonly MidwayAtoll: "Midway Atoll";
-    readonly Minnesota: "Minnesota";
-    readonly Mississippi: "Mississippi";
-    readonly Missouri: "Missouri";
-    readonly Montana: "Montana";
-    readonly NavassaIsland: "Navassa Island";
-    readonly Nebraska: "Nebraska";
-    readonly Nevada: "Nevada";
-    readonly NewHampshire: "New Hampshire";
-    readonly NewJersey: "New Jersey";
-    readonly NewMexico: "New Mexico";
-    readonly NewYork: "New York";
-    readonly NorthCarolina: "North Carolina";
-    readonly NorthDakota: "North Dakota";
-    readonly NorthernMarianaIslands: "Northern Mariana Islands";
-    readonly Ohio: "Ohio";
-    readonly Oklahoma: "Oklahoma";
-    readonly Oregon: "Oregon";
-    readonly PalmyraAtoll: "Palmyra Atoll";
-    readonly Pennsylvania: "Pennsylvania";
-    readonly PuertoRico: "Puerto Rico";
-    readonly RhodeIsland: "Rhode Island";
-    readonly SouthCarolina: "South Carolina";
-    readonly SouthDakota: "South Dakota";
-    readonly Tennessee: "Tennessee";
-    readonly Texas: "Texas";
-    readonly UnitedStatesVirginIslands: "United States Virgin Islands";
-    readonly Utah: "Utah";
-    readonly Vermont: "Vermont";
-    readonly Virginia: "Virginia";
-    readonly WakeIsland: "Wake Island";
-    readonly Washington: "Washington";
-    readonly WestVirginia: "West Virginia";
-    readonly Wisconsin: "Wisconsin";
-    readonly Wyoming: "Wyoming";
+export type TUSStateCode = TRecordValue<typeof US_STATES_CODE>;
+export declare const US_JURISDICTIONS: {
+    readonly AL: "Alabama";
+    readonly AK: "Alaska";
+    readonly AZ: "Arizona";
+    readonly AR: "Arkansas";
+    readonly CA: "California";
+    readonly CO: "Colorado";
+    readonly CT: "Connecticut";
+    readonly DE: "Delaware";
+    readonly FL: "Florida";
+    readonly GA: "Georgia";
+    readonly HI: "Hawaii";
+    readonly ID: "Idaho";
+    readonly IL: "Illinois";
+    readonly IN: "Indiana";
+    readonly IA: "Iowa";
+    readonly KS: "Kansas";
+    readonly KY: "Kentucky";
+    readonly LA: "Louisiana";
+    readonly ME: "Maine";
+    readonly MD: "Maryland";
+    readonly MA: "Massachusetts";
+    readonly MI: "Michigan";
+    readonly MN: "Minnesota";
+    readonly MS: "Mississippi";
+    readonly MO: "Missouri";
+    readonly MT: "Montana";
+    readonly NE: "Nebraska";
+    readonly NV: "Nevada";
+    readonly NH: "New Hampshire";
+    readonly NJ: "New Jersey";
+    readonly NM: "New Mexico";
+    readonly NY: "New York";
+    readonly NC: "North Carolina";
+    readonly ND: "North Dakota";
+    readonly OH: "Ohio";
+    readonly OK: "Oklahoma";
+    readonly OR: "Oregon";
+    readonly PA: "Pennsylvania";
+    readonly RI: "Rhode Island";
+    readonly SC: "South Carolina";
+    readonly SD: "South Dakota";
+    readonly TN: "Tennessee";
+    readonly TX: "Texas";
+    readonly UT: "Utah";
+    readonly VT: "Vermont";
+    readonly VA: "Virginia";
+    readonly WA: "Washington";
+    readonly WV: "West Virginia";
+    readonly WI: "Wisconsin";
+    readonly WY: "Wyoming";
+    readonly DC: "District of Columbia";
+    readonly PR: "Puerto Rico";
+    readonly GU: "Guam";
+    readonly VI: "United States Virgin Islands";
+    readonly AS: "American Samoa";
+    readonly MP: "Northern Mariana Islands";
 };
-export type TUnitedStatesJurisdiction = TRecordValue<typeof UNITED_STATES_JURISDICTIONS>;
-export declare const UnitedStatesJurisdictionOptions: ISelectOption<TUnitedStatesJurisdiction>[];
+export type TUSJurisdiction = TRecordValue<typeof US_JURISDICTIONS>;
+export declare const UnitedStatesJurisdictionOptions: ISelectOption<TUSJurisdiction>[];
 export declare const STATUS: {
     readonly Pending: "Pending";
     readonly InProgress: "InProgress";

package/dist/types/base/index.js

@@ -65,74 +65,67 @@ export const US_STATES_CODE = {
     AS: "AS",
     MP: "MP",
 };
-export const UNITED_STATES_JURISDICTIONS = {
-    Alabama: "Alabama",
-    Alaska: "Alaska",
-    AmericanSamoa: "American Samoa",
-    Arizona: "Arizona",
-    Arkansas: "Arkansas",
-    BakerIsland: "Baker Island",
-    California: "California",
-    Colorado: "Colorado",
-    Connecticut: "Connecticut",
-    Delaware: "Delaware",
-    DistrictOfColumbia: "District of Columbia",
-    Florida: "Florida",
-    Georgia: "Georgia",
-    Guam: "Guam",
-    Hawaii: "Hawaii",
-    HowlandIsland: "Howland Island",
-    Idaho: "Idaho",
-    Illinois: "Illinois",
-    Indiana: "Indiana",
-    Iowa: "Iowa",
-    JarvisIsland: "Jarvis Island",
-    JohnstonAtoll: "Johnston Atoll",
-    Kansas: "Kansas",
-    Kentucky: "Kentucky",
-    KingmanReef: "Kingman Reef",
-    Louisiana: "Louisiana",
-    Maine: "Maine",
-    Maryland: "Maryland",
-    Massachusetts: "Massachusetts",
-    Michigan: "Michigan",
-    MidwayAtoll: "Midway Atoll",
-    Minnesota: "Minnesota",
-    Mississippi: "Mississippi",
-    Missouri: "Missouri",
-    Montana: "Montana",
-    NavassaIsland: "Navassa Island",
-    Nebraska: "Nebraska",
-    Nevada: "Nevada",
-    NewHampshire: "New Hampshire",
-    NewJersey: "New Jersey",
-    NewMexico: "New Mexico",
-    NewYork: "New York",
-    NorthCarolina: "North Carolina",
-    NorthDakota: "North Dakota",
-    NorthernMarianaIslands: "Northern Mariana Islands",
-    Ohio: "Ohio",
-    Oklahoma: "Oklahoma",
-    Oregon: "Oregon",
-    PalmyraAtoll: "Palmyra Atoll",
-    Pennsylvania: "Pennsylvania",
-    PuertoRico: "Puerto Rico",
-    RhodeIsland: "Rhode Island",
-    SouthCarolina: "South Carolina",
-    SouthDakota: "South Dakota",
-    Tennessee: "Tennessee",
-    Texas: "Texas",
-    UnitedStatesVirginIslands: "United States Virgin Islands",
-    Utah: "Utah",
-    Vermont: "Vermont",
-    Virginia: "Virginia",
-    WakeIsland: "Wake Island",
-    Washington: "Washington",
-    WestVirginia: "West Virginia",
-    Wisconsin: "Wisconsin",
-    Wyoming: "Wyoming",
+export const US_JURISDICTIONS = {
+    // 50 States
+    AL: "Alabama",
+    AK: "Alaska",
+    AZ: "Arizona",
+    AR: "Arkansas",
+    CA: "California",
+    CO: "Colorado",
+    CT: "Connecticut",
+    DE: "Delaware",
+    FL: "Florida",
+    GA: "Georgia",
+    HI: "Hawaii",
+    ID: "Idaho",
+    IL: "Illinois",
+    IN: "Indiana",
+    IA: "Iowa",
+    KS: "Kansas",
+    KY: "Kentucky",
+    LA: "Louisiana",
+    ME: "Maine",
+    MD: "Maryland",
+    MA: "Massachusetts",
+    MI: "Michigan",
+    MN: "Minnesota",
+    MS: "Mississippi",
+    MO: "Missouri",
+    MT: "Montana",
+    NE: "Nebraska",
+    NV: "Nevada",
+    NH: "New Hampshire",
+    NJ: "New Jersey",
+    NM: "New Mexico",
+    NY: "New York",
+    NC: "North Carolina",
+    ND: "North Dakota",
+    OH: "Ohio",
+    OK: "Oklahoma",
+    OR: "Oregon",
+    PA: "Pennsylvania",
+    RI: "Rhode Island",
+    SC: "South Carolina",
+    SD: "South Dakota",
+    TN: "Tennessee",
+    TX: "Texas",
+    UT: "Utah",
+    VT: "Vermont",
+    VA: "Virginia",
+    WA: "Washington",
+    WV: "West Virginia",
+    WI: "Wisconsin",
+    WY: "Wyoming",
+    // Territories
+    DC: "District of Columbia",
+    PR: "Puerto Rico",
+    GU: "Guam",
+    VI: "United States Virgin Islands",
+    AS: "American Samoa",
+    MP: "Northern Mariana Islands",
 };
-export const UnitedStatesJurisdictionOptions = Object.values(UNITED_STATES_JURISDICTIONS).map((jurisdiction) => ({
+export const UnitedStatesJurisdictionOptions = Object.values(US_JURISDICTIONS).map((jurisdiction) => ({
     label: jurisdiction,
     value: jurisdiction,
 }));

package/dist/types/company/index.d.ts

@@ -1,14 +1,14 @@
-import { IMetaData, TRecordValue, TUnitedStatesStateCode } from "../index";
+import { IMetaData, TRecordValue, TUSStateCode } from "../index";
 export * from "./routes";
 export interface ICompany extends IMetaData {
     id: string;
     displayName: string;
-    addressLine1?: string;
+    addressLine1: string;
     addressLine2?: string;
-    city?: string;
-    stateCode?: TUnitedStatesStateCode;
+    city: string;
+    stateCode: TUSStateCode;
     companyType: TCompanyType;
-    postalCode?: string;
+    postalCode: string;
     country?: string;
     timezone?: string;
     photoUrl?: string;

package/dist/types/company/routes.d.ts

@@ -19,11 +19,11 @@ export interface IGetCompaniesQuery {
 }
 export interface ICreateCompanyRequest {
     displayName: string;
-    addressLine1?: string;
+    addressLine1: string;
     addressLine2?: string;
-    city?: string;
-    stateCode?: string;
-    postalCode?: string;
+    city: string;
+    stateCode: string;
+    postalCode: string;
     companyType: TCompanyType;
 }
 export interface ICreateCompanyResponse extends ICompany {

package/dist/types/damage-report/index.d.ts

@@ -1,6 +1,22 @@
+import { TRecordValue } from "../base";
 export * from "./routes";
-export type TDamageSeverity = "LOW" | "MEDIUM" | "HIGH" | "CRITICAL";
-export type TDamageStatus = "OPEN" | "IN_REVIEW" | "ASSIGNED" | "IN_PROGRESS" | "RESOLVED" | "CLOSED" | "ESCALATED";
+export declare const DAMAGE_SEVERITY: {
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly HIGH: "HIGH";
+    readonly CRITICAL: "CRITICAL";
+};
+export type TDamageSeverity = TRecordValue<typeof DAMAGE_SEVERITY>;
+export declare const DAMAGE_STATUS: {
+    OPEN: string;
+    IN_REVIEW: string;
+    ASSIGNED: string;
+    IN_PROGRESS: string;
+    RESOLVED: string;
+    CLOSED: string;
+    ESCALATED: string;
+};
+export type TDamageStatus = TRecordValue<typeof DAMAGE_STATUS>;
 export interface IDamageReport {
     id: string;
     propertyId: string;

package/dist/types/damage-report/index.js

@@ -1 +1,16 @@
 export * from "./routes";
+export const DAMAGE_SEVERITY = {
+    LOW: "LOW",
+    MEDIUM: "MEDIUM",
+    HIGH: "HIGH",
+    CRITICAL: "CRITICAL",
+};
+export const DAMAGE_STATUS = {
+    OPEN: "OPEN",
+    IN_REVIEW: "IN_REVIEW",
+    ASSIGNED: "ASSIGNED",
+    IN_PROGRESS: "IN_PROGRESS",
+    RESOLVED: "RESOLVED",
+    CLOSED: "CLOSED",
+    ESCALATED: "ESCALATED",
+};

package/dist/types/property/index.d.ts

@@ -1,4 +1,4 @@
-import { ISelectOption, IMetaData, TRecordValue, TStatus, TUnitedStatesStateCode } from "../index";
+import { ISelectOption, IMetaData, TRecordValue, TStatus, TUSStateCode } from "../index";
 export * from "./routes";
 export declare const PROPERTY_STATUS: {
     readonly Active: "Active";
@@ -12,14 +12,14 @@ export declare const PropertyTypeOptions: ISelectOption<TPropertyType>[];
 export interface IProperty extends IMetaData {
     id: string;
     displayName: string;
-    addressLine1?: string;
+    addressLine1: string;
     addressLine2?: string;
-    city?: string;
-    stateCode?: TUnitedStatesStateCode | string;
+    city: string;
+    stateCode: TUSStateCode | string;
     propertyType?: TPropertyType;
     status?: TPropertyStatus;
     sqft?: number;
-    postalCode?: string;
+    postalCode: string;
     country?: string;
     timezone?: string;
     imageUrl?: string;
@@ -97,10 +97,11 @@ export interface IPropertySummary {
     id: string;
     displayName: string;
     propertyType: TPropertyType;
-    addressLine1?: string;
-    city?: string;
-    stateCode?: string;
-    postalCode?: string;
+    addressLine1: string;
+    addressLine2: string;
+    city: string;
+    stateCode: string;
+    postalCode: string;
     imageUrl?: string;
     status?: string;
 }

package/dist/types/user/index.d.ts

@@ -26,10 +26,9 @@ export interface IUserSafe extends Omit<IUser, "passwordHash" | "loginAttempts"
 }
 export declare const ACCOUNT_TYPE: {
     readonly TURNDOWN_ADMIN: "TURNDOWN_ADMIN";
-    readonly PROPERTY_MANAGER: "PROPERTY_MANAGER";
     readonly ACCOUNT_ADMIN: "ACCOUNT_ADMIN";
-    readonly MAINTAINER: "MAINTAINER";
-    readonly CLEANER: "CLEANER";
+    readonly MANAGER: "MANAGER";
+    readonly STAFF: "STAFF";
     readonly GUEST: "GUEST";
 };
 export type TAccountType = TRecordValue<typeof ACCOUNT_TYPE>;

package/dist/types/user/index.js

@@ -1,10 +1,9 @@
 export * from "./routes";
 export const ACCOUNT_TYPE = {
     TURNDOWN_ADMIN: "TURNDOWN_ADMIN",
-    PROPERTY_MANAGER: "PROPERTY_MANAGER",
     ACCOUNT_ADMIN: "ACCOUNT_ADMIN",
-    MAINTAINER: "MAINTAINER",
-    CLEANER: "CLEANER",
+    MANAGER: "MANAGER",
+    STAFF: "STAFF",
     GUEST: "GUEST",
 };
 export const ACCOUNT_STATUS = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turndown/library",
-  "version": "0.1.22",
+  "version": "0.1.23",
   "description": "Shared TypeScript library for the Turndown suite.",
   "keywords": [
     "types",
@@ -34,6 +34,7 @@
     "clean": "rimraf dist",
     "build": "npm run clean && tsc -p .",
     "dev": "tsc -w -p .",
+    "format": "prettier --write .",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage"