@univerjs/core 1.0.0-alpha.2 → 1.0.0-alpha.4

package/lib/types/shared/numfmt/dec-to-frac.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Split a fractional number into a numerator and denominator for display as
+ * vulgar fractions.
+ *
+ * @ignore
+ * @param {number} number The value to split
+ * @param {number} [numeratorMaxDigits] The maxdigits number
+ * @param {number} [denominatorMaxDigits] The maxdigits de
+ * @returns {Array<number>} Array of two numbers, numerator and denominator.
+ */
+export declare function dec2frac(number: number, numeratorMaxDigits?: number, denominatorMaxDigits?: number): [number, number];

package/lib/types/shared/numfmt/decimal.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare const SPREADSHEET_SIGNIFICANT_DIGITS = 15;
+export interface IDecimalValue {
+    readonly negative: boolean;
+    readonly digits: string;
+    readonly exponent: number;
+}
+export interface IRoundedDecimalParts {
+    readonly negative: boolean;
+    readonly integer: string;
+    readonly fraction: string;
+    readonly zero: boolean;
+}
+export interface IScientificDecimalParts {
+    readonly exponent: number;
+    readonly rounded: IRoundedDecimalParts;
+}
+export declare function decimalFromNumber(value: number): IDecimalValue;
+export declare function shiftDecimal(value: IDecimalValue, power: number): IDecimalValue;
+export declare function roundDecimal(value: IDecimalValue, places?: number): IRoundedDecimalParts;
+export declare function decimalPartsToNumber(value: IRoundedDecimalParts): number;
+export declare function decimalPartsToPlainString(value: IRoundedDecimalParts): string;
+export declare function roundScientificDecimal(value: IDecimalValue, integerDigits: number, hasIntegerPattern: boolean, fractionDigits: number): IScientificDecimalParts;

package/lib/types/shared/numfmt/format-info.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { FormatDateInfo, FormatInfo, FormatSection } from './types';
+export declare function isPercent(partitions: Array<FormatSection | undefined>): boolean;
+export declare function isDate(partitions: Array<FormatSection | undefined>): boolean;
+export declare function isText(partitions: Array<FormatSection | undefined>): boolean;
+export declare function info(partitions: Array<FormatSection | undefined>, currencyId?: string | null): FormatInfo;
+export declare function dateInfo(partitions: Array<FormatSection | undefined>): FormatDateInfo;

package/lib/types/shared/numfmt/format-number.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { FormatColor, ParsedPattern, ResolvedFormatOptions } from './types';
+export declare function formatColor(value: unknown, pattern: ParsedPattern, options: ResolvedFormatOptions): FormatColor;
+export declare function formatValue(value: unknown, pattern: ParsedPattern, options: ResolvedFormatOptions): string;

package/lib/types/shared/numfmt/general.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IDecimalValue } from './decimal';
+import type { LocaleData, ParsedFormatSection } from './types';
+export declare function general(output: Array<string | number>, part: Partial<ParsedFormatSection>, value: number | string, locale: LocaleData, decimalValue?: IDecimalValue | null): Array<string | number>;

package/lib/types/shared/numfmt/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * as numfmt from './api';
+export type { INumfmtLocaleTag } from './utils';
+export { currencySymbols, DEFAULT_NUMBER_FORMAT, DEFAULT_TEXT_FORMAT, DEFAULT_TEXT_FORMAT_EXCEL, getNumfmtParseValueFilter, isDefaultFormat, isPatternEqualWithoutDecimal, isTextFormat, } from './utils';

package/lib/types/shared/numfmt/locale.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { LocaleData, LocaleSettings, LocaleToken } from './types';
+/**
+ * @typedef {object} LocaleToken - An object of properties for a locale tag.
+ * @property {string} lang - The basic tag such as `zh_CN` or `fi`
+ * @property {string} language - The language section (`zh` for `zh_CN`)
+ * @property {string} territory - The territory section (`CN` for `zh_CN`)
+ */
+/**
+ * Parse a regular IETF BCP 47 locale tag and emit an object of its parts.
+ * Irregular tags and subtags are not supported.
+ *
+ * @param {string} locale - A BCP 47 string tag of the locale.
+ * @returns {LocaleToken} - An object describing the locale.
+ */
+export declare function parseLocale(locale: string): LocaleToken;
+export declare function resolveLocale(locale: string | number): string | null;
+/**
+ * Used by the formatter to pull a locate from its registered locales. If
+ * subtag isn't available but the base language is, the base language is used.
+ * So if `en-CA` is not found, the formatter tries to find `en` else it
+ * returns a `null`.
+ *
+ * @param {string} locale - A BCP 47 string tag of the locale, or an Excel locale code.
+ * @returns {LocaleData | null} - An object of format date properties.
+ */
+export declare function getLocale(locale: string | number): LocaleData | null;
+export declare function createLocale(settings: LocaleSettings): LocaleData;
+/**
+ * Register locale data for a language so for use when formatting.
+ *
+ * Any partial set of properties may be returned to have the defaults used where properties are missing.
+ *
+ * @see {LocaleData}
+ * @param {object} settings - A collection of settings for a locale.
+ * @param {string} [settings.group]
+ *    Symbol used as a grouping separator (`1,000,000` uses `,`)
+ * @param {string} [settings.decimal]
+ *    Symbol used to separate integers from fractions (usually `.`)
+ * @param {string} [settings.positive]
+ *    Symbol used to indicate positive numbers (usually `+`)
+ * @param {string} [settings.negative]
+ *    Symbol used to indicate positive numbers (usually `-`)
+ * @param {string} [settings.percent]
+ *    Symbol used to indicate a percentage (usually `%`)
+ * @param {string} [settings.exponent]
+ *    Symbol used to indicate an exponent (usually `E`)
+ * @param {string} [settings.nan]
+ *    Symbol used to indicate NaN values (`NaN`)
+ * @param {string} [settings.infinity]
+ *    Symbol used to indicate infinite values (`∞`)
+ * @param {Array<string>} [settings.ampm]
+ *    How AM and PM should be presented.
+ * @param {Array<string>} [settings.mmmm6]
+ *    Long month names for the Islamic calendar (e.g. `Rajab`)
+ * @param {Array<string>} [settings.mmm6]
+ *    Short month names for the Islamic calendar (e.g. `Raj.`)
+ * @param {Array<string>} [settings.mmmm]
+ *    Long month names for the Gregorian calendar (e.g. `November`)
+ * @param {Array<string>} [settings.mmm]
+ *    Short month names for the Gregorian calendar (e.g. `Nov`)
+ * @param {Array<string>} [settings.dddd]
+ *    Long day names (e.g. `Wednesday`)
+ * @param {Array<string>} [settings.ddd]
+ *    Shortened day names (e.g. `Wed`)
+ * @param {Array<string>} [settings.bool]
+ *    How TRUE and FALSE should be presented.
+ * @param {boolean} [settings.preferMDY]
+ *    Is the prefered date format month first (12/31/2025) or day first (31/12/2025)
+ * @param {string | LocaleToken} locale - A string BCP 47 tag or parsed locale token.
+ * @returns {LocaleData} - A full collection of settings for a locale
+ */
+export declare function addLocale(settings: LocaleSettings, locale: string | LocaleToken): LocaleData;
+export declare function listLocales(): string[];
+export declare const defaultLocale: LocaleData;

package/lib/types/shared/numfmt/num-dec.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { NumberDigits } from './types';
+export declare function numDec(value: number, includeSign?: boolean): NumberDigits;

package/lib/types/shared/numfmt/number-props.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function getExponent(number: number, intMax?: number): number;
+export declare function getSignificand(number: number, exponent?: number): number;

package/lib/types/shared/numfmt/options.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ResolvedFormatOptions } from './types';
+export declare const defaultOptions: Readonly<ResolvedFormatOptions>;

package/lib/types/shared/numfmt/pad.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @ignore
+ * @param {string} char Instruction character (['#', '?', '0'])
+ * @param {boolean} [nbsp] Use nonbreaking space or not?
+ * @returns {string} Padding character
+ */
+export declare function pad(char: string, nbsp?: boolean): string;

package/lib/types/shared/numfmt/parse-format-section.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { FormatToken, ParsedFormatSection } from './types';
+export declare function parseFormatSection(inputTokens: FormatToken[]): ParsedFormatSection;

package/lib/types/shared/numfmt/parse-pattern.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ParsedPattern } from './types';
+export declare function parsePattern(pattern: string): ParsedPattern;
+export declare function parseCatch(pattern: string): ParsedPattern;

package/lib/types/shared/numfmt/parse-value.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ParseData } from './types';
+export interface ParseOptions {
+    locale?: string;
+}
+/** Parse a numeric string and return its value and inferred format. */
+export declare function parseNumber(value: string, options?: ParseOptions): ParseData<number> | null;
+export declare function isValidDate(year: number, month: number, day: number): boolean;
+/** Parse a date or datetime string and return its serial value and format. */
+export declare function parseDate(value: string, options?: ParseOptions): ParseData<number> | null;
+/** Parse a time string and return its day fraction and inferred format. */
+export declare function parseTime(value: string, options?: ParseOptions): ParseData<number> | null;
+/** Parse a localized or English boolean string. */
+export declare function parseBool(value: string, options?: ParseOptions): ParseData<boolean> | null;
+/** Parse a spreadsheet input as a number, date, time, or boolean. */
+export declare function parseValue(value: string, options?: ParseOptions): ParseData | null;

package/lib/types/shared/numfmt/round.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Return a number rounded to the specified amount of places. This is the
+ * rounding function used internally by the formatter (symmetric arithmetic
+ * rounding).
+ *
+ * @param {number} number - The number to round.
+ * @param {number} [places] - The number of decimals to round to.
+ * @returns {number} A rounded number.
+ */
+export declare function round(number: number, places?: number): number;
+export declare function round(number: unknown, places?: number): unknown;

package/lib/types/shared/numfmt/run-part.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IDecimalValue } from './decimal';
+import type { FormatSection, LocaleData, ResolvedFormatOptions } from './types';
+export declare function runPart(value: unknown, part: FormatSection, options: ResolvedFormatOptions, locale?: LocaleData | null, decimalValue?: IDecimalValue | null): string;

package/lib/types/shared/numfmt/serial-date.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { DateTimeParts } from './types';
+/**
+ * Convert a native JavaScript Date, or array to a spreadsheet serial date.
+ *
+ * Returns a serial date number if input was a Date object or an array of
+ * numbers, or null.
+ */
+export declare function dateToSerial(date: unknown, options?: {
+    ignoreTimezone?: boolean;
+}): number | null;
+/**
+ * Convert a spreadsheet serial date to an array of date parts, accurate to a
+ * second.
+ */
+export declare function dateFromSerial(serial: number, options?: {
+    leap1900?: boolean;
+}): DateTimeParts;

package/lib/types/shared/numfmt/to-ymd.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { DateParts } from './types';
+export declare function toYMD1900(serial: number, leap1900?: boolean): DateParts;
+export declare function toYMD1904(serial: number): DateParts;
+export declare function toYMD1317(serial: number): DateParts;
+export declare function toYMD(serial: number, system?: number, leap1900?: boolean): DateParts;

package/lib/types/shared/numfmt/tokenize.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { FormatToken } from './types';
+/**
+ * Breaks a format pattern string into a list of tokens.
+ */
+export declare function tokenize(pattern: string): FormatToken[];