@kwiz/common 1.0.127 → 1.0.128

package/src/types/locales.ts

@@ -1,126 +1,126 @@
-export type SysNumberFormatType = {
-    CurrencyDecimalDigits: number;
-    CurrencyDecimalSeparator: string;
-    IsReadOnly: boolean;
-    CurrencyGroupSizes: number[];
-    NumberGroupSizes: number[];
-    PercentGroupSizes: number[];
-    CurrencyGroupSeparator: string;
-    CurrencySymbol: string;
-    NaNSymbol: string;
-    CurrencyNegativePattern: number;
-    NumberNegativePattern: number;
-    PercentPositivePattern: number;
-    PercentNegativePattern: number;
-    NegativeInfinitySymbol: string;
-    NegativeSign: string;
-    NumberDecimalDigits: number;
-    NumberDecimalSeparator: string;
-    NumberGroupSeparator: string;
-    CurrencyPositivePattern: number;
-    PositiveInfinitySymbol: string;
-    PositiveSign: string;
-    PercentDecimalDigits: number;
-    PercentDecimalSeparator: string;
-    PercentGroupSeparator: string;
-    PercentSymbol: string;
-    PerMilleSymbol: string;
-    NativeDigits: string[];
-    DigitSubstitution: number;
-};
-
-export type SysDateFormatType = {
-    AMDesignator: string;
-    Calendar: {
-        MinSupportedDateTime: string;
-        MaxSupportedDateTime: string;
-        AlgorithmType: number;
-        CalendarType: number;
-        Eras: number[];
-        TwoDigitYearMax: number;
-        IsReadOnly: boolean;
-    };
-    DateSeparator: string;
-    FirstDayOfWeek: number;
-    CalendarWeekRule: number;
-    FullDateTimePattern: string;
-    LongDatePattern: string;
-    LongTimePattern: string;
-    MonthDayPattern: string;
-    PMDesignator: string;
-    RFC1123Pattern: string;
-    ShortDatePattern: string;
-    ShortTimePattern: string;
-    SortableDateTimePattern: string;
-    TimeSeparator: string;
-    UniversalSortableDateTimePattern: string;
-    YearMonthPattern: string;
-    AbbreviatedDayNames: string[];
-    ShortestDayNames: string[];
-    DayNames: string[];
-    AbbreviatedMonthNames: string[];
-    MonthNames: string[];
-    IsReadOnly: boolean;
-    NativeCalendarName: string;
-    AbbreviatedMonthGenitiveNames: string[];
-    MonthGenitiveNames: string[];
-    eras: any[];
-};
-export type CultureInfoType = {
-    LCID: number;
-    name: string;
-    numberFormat: SysNumberFormatType;
-    dateTimeFormat: SysDateFormatType;
-    ShortDatePattern?: string;
-    ShortTimePattern?: string;
-    DateSeparator?: string;
-    TimeSeparator?: string;
-    CurrencySymbol?: string;
-    PercentSymbol?: string;
-    NumberDecimalSeparator?: string;
-    NumberGroupSeparator?: string;
-};
-
-export interface IKLocales {
-    getCultureNameOrLCIDFromContextInfo(s: number): string | number;
-    GetCulture(cultureNameOrLCID: string | number): CultureInfoType;
-    GetCurrentCulture(): CultureInfoType;
-    SetCurrentCulture(culture: CultureInfoType);
-    ParseDate(strDate: string, culture?: CultureInfoType): Date;
-    /** default format: date only */
-    DateToString(dateObj: Date, culture: CultureInfoType, format?: { includeDate?: boolean; includeTime?: boolean; }): string;
-    ParseNumber(strNumber: string, culture?: CultureInfoType): number;
-    /** isPercentAsWholeNumbers means a percent number that is 1 to 100, not 0-1. will not multiply it by 100. */
-    NumberToString(num: number,
-        /** current web cutlure, default=GetCurrentCulture */
-        webCulture?: CultureInfoType,
-        numFormat?: {
-            /** default=false */
-            includeGroupSeparator?: boolean;
-            /** default=false */
-            isPercent?: boolean;
-            /** isPercentAsWholeNumbers means a percent number that is 1 to 100, not 0-1. will not multiply it by 100, default=false */
-            isPercentAsWholeNumbers?: boolean;
-            /** default=false */
-            isCurrency?: boolean;
-            /** default=webCulture.LCID */
-            currencyLocaleId?: number;
-            /** default=false */
-            numberOnly?: boolean;
-        }): string;
-    IsValidNumber(strNumber: string, culture: CultureInfoType): boolean;
-}
-
-declare global {
-    interface Date {
-        /**
-        * Formats a date by using the invariant (culture-independent) culture.
-        * @deprecated this is only available when loading KLocals known script
-        */
-        format(format: string): string;
-    }
-
-    interface IKWizComGlobals {
-        kLocales?: IKLocales;
-    }
+export type SysNumberFormatType = {
+    CurrencyDecimalDigits: number;
+    CurrencyDecimalSeparator: string;
+    IsReadOnly: boolean;
+    CurrencyGroupSizes: number[];
+    NumberGroupSizes: number[];
+    PercentGroupSizes: number[];
+    CurrencyGroupSeparator: string;
+    CurrencySymbol: string;
+    NaNSymbol: string;
+    CurrencyNegativePattern: number;
+    NumberNegativePattern: number;
+    PercentPositivePattern: number;
+    PercentNegativePattern: number;
+    NegativeInfinitySymbol: string;
+    NegativeSign: string;
+    NumberDecimalDigits: number;
+    NumberDecimalSeparator: string;
+    NumberGroupSeparator: string;
+    CurrencyPositivePattern: number;
+    PositiveInfinitySymbol: string;
+    PositiveSign: string;
+    PercentDecimalDigits: number;
+    PercentDecimalSeparator: string;
+    PercentGroupSeparator: string;
+    PercentSymbol: string;
+    PerMilleSymbol: string;
+    NativeDigits: string[];
+    DigitSubstitution: number;
+};
+
+export type SysDateFormatType = {
+    AMDesignator: string;
+    Calendar: {
+        MinSupportedDateTime: string;
+        MaxSupportedDateTime: string;
+        AlgorithmType: number;
+        CalendarType: number;
+        Eras: number[];
+        TwoDigitYearMax: number;
+        IsReadOnly: boolean;
+    };
+    DateSeparator: string;
+    FirstDayOfWeek: number;
+    CalendarWeekRule: number;
+    FullDateTimePattern: string;
+    LongDatePattern: string;
+    LongTimePattern: string;
+    MonthDayPattern: string;
+    PMDesignator: string;
+    RFC1123Pattern: string;
+    ShortDatePattern: string;
+    ShortTimePattern: string;
+    SortableDateTimePattern: string;
+    TimeSeparator: string;
+    UniversalSortableDateTimePattern: string;
+    YearMonthPattern: string;
+    AbbreviatedDayNames: string[];
+    ShortestDayNames: string[];
+    DayNames: string[];
+    AbbreviatedMonthNames: string[];
+    MonthNames: string[];
+    IsReadOnly: boolean;
+    NativeCalendarName: string;
+    AbbreviatedMonthGenitiveNames: string[];
+    MonthGenitiveNames: string[];
+    eras: any[];
+};
+export type CultureInfoType = {
+    LCID: number;
+    name: string;
+    numberFormat: SysNumberFormatType;
+    dateTimeFormat: SysDateFormatType;
+    ShortDatePattern?: string;
+    ShortTimePattern?: string;
+    DateSeparator?: string;
+    TimeSeparator?: string;
+    CurrencySymbol?: string;
+    PercentSymbol?: string;
+    NumberDecimalSeparator?: string;
+    NumberGroupSeparator?: string;
+};
+
+export interface IKLocales {
+    getCultureNameOrLCIDFromContextInfo(s: number): string | number;
+    GetCulture(cultureNameOrLCID: string | number): CultureInfoType;
+    GetCurrentCulture(): CultureInfoType;
+    SetCurrentCulture(culture: CultureInfoType);
+    ParseDate(strDate: string, culture?: CultureInfoType): Date;
+    /** default format: date only */
+    DateToString(dateObj: Date, culture: CultureInfoType, format?: { includeDate?: boolean; includeTime?: boolean; }): string;
+    ParseNumber(strNumber: string, culture?: CultureInfoType): number;
+    /** isPercentAsWholeNumbers means a percent number that is 1 to 100, not 0-1. will not multiply it by 100. */
+    NumberToString(num: number,
+        /** current web cutlure, default=GetCurrentCulture */
+        webCulture?: CultureInfoType,
+        numFormat?: {
+            /** default=false */
+            includeGroupSeparator?: boolean;
+            /** default=false */
+            isPercent?: boolean;
+            /** isPercentAsWholeNumbers means a percent number that is 1 to 100, not 0-1. will not multiply it by 100, default=false */
+            isPercentAsWholeNumbers?: boolean;
+            /** default=false */
+            isCurrency?: boolean;
+            /** default=webCulture.LCID */
+            currencyLocaleId?: number;
+            /** default=false */
+            numberOnly?: boolean;
+        }): string;
+    IsValidNumber(strNumber: string, culture: CultureInfoType): boolean;
+}
+
+declare global {
+    interface Date {
+        /**
+        * Formats a date by using the invariant (culture-independent) culture.
+        * @deprecated this is only available when loading KLocals known script
+        */
+        format(format: string): string;
+    }
+
+    interface IKWizComGlobals {
+        kLocales?: IKLocales;
+    }
 }

package/src/types/localstoragecache.types.ts

@@ -1,9 +1,9 @@
-//#region Cache Service
-export interface ILocalStorageCacheLifetime {
-    seconds?: number;
-    minutes?: number;
-    hours?: number;
-    days?: number;
-    months?: number;
-    years?: number;
+//#region Cache Service
+export interface ILocalStorageCacheLifetime {
+    seconds?: number;
+    minutes?: number;
+    hours?: number;
+    days?: number;
+    months?: number;
+    years?: number;
 }

package/src/types/location.types.ts

@@ -1,28 +1,28 @@
-export type IMeetingLocationEntityType = "Custom" | "Default" | "ConferenceRoom" | "HomeAddress" | "BusinessAddress"
-    | "GeoCoordinates" | "StreetAddress" | "Hotel" | "Restaurant" | "LocalBusiness" | "PostalAddress";
-
-export interface IMeetingLocationAddress {
-    Street: string;
-    City: string;
-    State: string;
-    CountryOrRegion: string;
-    PostalCode: string;
-}
-
-export interface IMeetingLocationCoordinates {
-    Latitude: number;
-    Longitude: number;
-}
-
-/** Represents location information of an event. 
- * Similar to https://learn.microsoft.com/en-us/graph/api/resources/location?view=graph-rest-1.0/ */
-export interface IMeetingLocation {
-    Address?: IMeetingLocationAddress,
-    Coordinates?: IMeetingLocationCoordinates,
-    DisplayName: string;
-    EntityType?: IMeetingLocationEntityType;
-    IsPreviouslyUsed?: boolean;
-    LocationSource?: string;
-    LocationUri?: string;
-    UniqueId?: string;
+export type IMeetingLocationEntityType = "Custom" | "Default" | "ConferenceRoom" | "HomeAddress" | "BusinessAddress"
+    | "GeoCoordinates" | "StreetAddress" | "Hotel" | "Restaurant" | "LocalBusiness" | "PostalAddress";
+
+export interface IMeetingLocationAddress {
+    Street: string;
+    City: string;
+    State: string;
+    CountryOrRegion: string;
+    PostalCode: string;
+}
+
+export interface IMeetingLocationCoordinates {
+    Latitude: number;
+    Longitude: number;
+}
+
+/** Represents location information of an event. 
+ * Similar to https://learn.microsoft.com/en-us/graph/api/resources/location?view=graph-rest-1.0/ */
+export interface IMeetingLocation {
+    Address?: IMeetingLocationAddress,
+    Coordinates?: IMeetingLocationCoordinates,
+    DisplayName: string;
+    EntityType?: IMeetingLocationEntityType;
+    IsPreviouslyUsed?: boolean;
+    LocationSource?: string;
+    LocationUri?: string;
+    UniqueId?: string;
 }

package/src/types/moment.ts

@@ -1,12 +1,12 @@
-interface IMomentJSObj {
-    toDate: () => Date;
-    isValid: () => boolean;
-}
-
-
-export type typeMomentJS = (inp?: string, format?: string, strict?: boolean) => IMomentJSObj;
-export type typeMonentJSTimeZone = (inp?: string, format?: string, strict?: boolean) => IMomentJSObj;
-declare global {
-    var momentJS: typeMomentJS;
-    var monentJSTimeZone: typeMonentJSTimeZone;
+interface IMomentJSObj {
+    toDate: () => Date;
+    isValid: () => boolean;
+}
+
+
+export type typeMomentJS = (inp?: string, format?: string, strict?: boolean) => IMomentJSObj;
+export type typeMonentJSTimeZone = (inp?: string, format?: string, strict?: boolean) => IMomentJSObj;
+declare global {
+    var momentJS: typeMomentJS;
+    var monentJSTimeZone: typeMonentJSTimeZone;
 }

package/src/types/regex.types.ts

@@ -1,17 +1,17 @@
-import { IDictionary } from "./common.types";
-
-export interface IRegexExpression {
-    pattern: string;
-    example: string;
-    options: string[];
-    isDefault: boolean;
-}
-
-export interface IRegexList extends IDictionary<IRegexExpression> {
-}
-
-declare global {
-    interface IModernListSettings {
-        RegexList?: IRegexList;
-    }
+import { IDictionary } from "./common.types";
+
+export interface IRegexExpression {
+    pattern: string;
+    example: string;
+    options: string[];
+    isDefault: boolean;
+}
+
+export interface IRegexList extends IDictionary<IRegexExpression> {
+}
+
+declare global {
+    interface IModernListSettings {
+        RegexList?: IRegexList;
+    }
 }

package/src/types/rest.types.ts

@@ -1,96 +1,96 @@
-import { ILocalStorageCacheLifetime } from "./localstoragecache.types";
-
-export type IRestResponseType = "" | "blob" | "arraybuffer" | "text" | "json" | "document";
-// eslint-disable-next-line no-shadow
-export enum jsonTypes {
-    verbose = "application/json; odata=verbose",
-    minimal = "application/json; odata=minimal",
-    nometadata = "application/json; odata=nometadata",
-    standard = "application/json"
-}
-
-// eslint-disable-next-line no-shadow
-export enum contentTypes {
-    xml = "application/xml",
-    json = "application/json"
-}
-
-export const AllRestCacheOptionsKeys: Required<IRestCacheOptions> = {
-    allowCache: true,
-    forceCacheUpdate: true,
-    localStorageExpiration: 1,
-    maxAge: 1
-};
-export interface IRestCacheOptions {
-    allowCache?: boolean;
-    /** if allowCache=true and local storage is supported, this will keep the results in local storage for a while */
-    localStorageExpiration?: number | ILocalStorageCacheLifetime | Date;
-    /** max age the runtime memeroy cache result is valid for in seconds */
-    maxAge?: number;
-    /** when a request allows to be stored in cache (persistent/memory) - signals that we want to update the cached value */
-    forceCacheUpdate?: boolean;
-}
-
-export interface IRestRequestOptions {
-    /** default: get if no body sent, otherwise post */
-    method?: "GET" | "POST";
-    xHttpMethod?: "MERGE" | "DELETE" | "PUT";
-    /**default true */
-    includeDigestInPost?: boolean;
-    /**default false */
-    includeDigestInGet?: boolean;
-    /**default: Accept: jsonTypes.verbose, and (in post only) content-type: jsonTypes.verbose */
-    headers?: {
-        [key: string]: string;
-        Accept?: string;
-        "content-type"?: string;
-        /** `Bearer ${token}` */
-        Authorization?: string;
-    };
-    /** allow cache on post requests if you provide a unique key to identify and match */
-    postCacheKey?: string;
-    cors?: boolean;
-    responseType?: IRestResponseType;
-    /**If set to true, will return the xhr object itself (XMLHttpRequest) (does not support allowCache!) */
-    returnXhrObject?: boolean;
-    /** provide a SharePoint web URL, if running a SharePoint request. Will be used to get the right form digest if/when needed. */
-    spWebUrl?: string;
-    jsonMetadata?: jsonTypes;
-}
-export interface IRestOptions extends IRestRequestOptions, IRestCacheOptions {
-}
-
-export interface IRequestObjects {
-    xhr: XMLHttpRequest;
-    options: IRestRequestOptions;
-    cacheOptions: IRestCacheOptions & { cacheKey?: string; };
-}
-
-export type IRequestBody = Document | Blob | BufferSource | FormData | URLSearchParams | string | null;//should be type XMLHttpRequestBodyInit, but some projects don't recognize it for some reason
-
-export interface IJsonSyncResultBase<T> {
-    status: number;
-    errorData?: any;
-    /** preserve original error message from failed cached result */
-    errorMessage?: string;
-    result?: T;
-    success: boolean;
-    cachedTime?: number;
-}
-export interface IJsonSyncResultSuccess<T> extends IJsonSyncResultBase<T> {
-    result: T;
-    success: true;
-}
-export interface IJsonSyncResultError<T> extends IJsonSyncResultBase<T> {
-    errorData: any;
-    /** preserve original error message from failed cached result */
-    errorMessage: string;
-    success: false;
-}
-export type IJsonSyncResult<T> = IJsonSyncResultSuccess<T> | IJsonSyncResultError<T>;
-
-export interface IRestError {
-    message: string;
-    errorData?: any;
-    xhr?: XMLHttpRequest;
+import { ILocalStorageCacheLifetime } from "./localstoragecache.types";
+
+export type IRestResponseType = "" | "blob" | "arraybuffer" | "text" | "json" | "document";
+// eslint-disable-next-line no-shadow
+export enum jsonTypes {
+    verbose = "application/json; odata=verbose",
+    minimal = "application/json; odata=minimal",
+    nometadata = "application/json; odata=nometadata",
+    standard = "application/json"
+}
+
+// eslint-disable-next-line no-shadow
+export enum contentTypes {
+    xml = "application/xml",
+    json = "application/json"
+}
+
+export const AllRestCacheOptionsKeys: Required<IRestCacheOptions> = {
+    allowCache: true,
+    forceCacheUpdate: true,
+    localStorageExpiration: 1,
+    maxAge: 1
+};
+export interface IRestCacheOptions {
+    allowCache?: boolean;
+    /** if allowCache=true and local storage is supported, this will keep the results in local storage for a while */
+    localStorageExpiration?: number | ILocalStorageCacheLifetime | Date;
+    /** max age the runtime memeroy cache result is valid for in seconds */
+    maxAge?: number;
+    /** when a request allows to be stored in cache (persistent/memory) - signals that we want to update the cached value */
+    forceCacheUpdate?: boolean;
+}
+
+export interface IRestRequestOptions {
+    /** default: get if no body sent, otherwise post */
+    method?: "GET" | "POST";
+    xHttpMethod?: "MERGE" | "DELETE" | "PUT";
+    /**default true */
+    includeDigestInPost?: boolean;
+    /**default false */
+    includeDigestInGet?: boolean;
+    /**default: Accept: jsonTypes.verbose, and (in post only) content-type: jsonTypes.verbose */
+    headers?: {
+        [key: string]: string;
+        Accept?: string;
+        "content-type"?: string;
+        /** `Bearer ${token}` */
+        Authorization?: string;
+    };
+    /** allow cache on post requests if you provide a unique key to identify and match */
+    postCacheKey?: string;
+    cors?: boolean;
+    responseType?: IRestResponseType;
+    /**If set to true, will return the xhr object itself (XMLHttpRequest) (does not support allowCache!) */
+    returnXhrObject?: boolean;
+    /** provide a SharePoint web URL, if running a SharePoint request. Will be used to get the right form digest if/when needed. */
+    spWebUrl?: string;
+    jsonMetadata?: jsonTypes;
+}
+export interface IRestOptions extends IRestRequestOptions, IRestCacheOptions {
+}
+
+export interface IRequestObjects {
+    xhr: XMLHttpRequest;
+    options: IRestRequestOptions;
+    cacheOptions: IRestCacheOptions & { cacheKey?: string; };
+}
+
+export type IRequestBody = Document | Blob | BufferSource | FormData | URLSearchParams | string | null;//should be type XMLHttpRequestBodyInit, but some projects don't recognize it for some reason
+
+export interface IJsonSyncResultBase<T> {
+    status: number;
+    errorData?: any;
+    /** preserve original error message from failed cached result */
+    errorMessage?: string;
+    result?: T;
+    success: boolean;
+    cachedTime?: number;
+}
+export interface IJsonSyncResultSuccess<T> extends IJsonSyncResultBase<T> {
+    result: T;
+    success: true;
+}
+export interface IJsonSyncResultError<T> extends IJsonSyncResultBase<T> {
+    errorData: any;
+    /** preserve original error message from failed cached result */
+    errorMessage: string;
+    success: false;
+}
+export type IJsonSyncResult<T> = IJsonSyncResultSuccess<T> | IJsonSyncResultError<T>;
+
+export interface IRestError {
+    message: string;
+    errorData?: any;
+    xhr?: XMLHttpRequest;
 }