textbrowser 0.49.1 → 0.51.0

package/dist/dist/WorkInfo-es.d.ts

@@ -0,0 +1,331 @@
+export type getJSONCallback = (jsonURL: string | string[], cb: SimpleJSONCallback, errBack: SimpleJSONErrback) => Promise<JSON>;
+export type PromiseChainErrback = (value: any) => Promise<any> | any;
+export type KeyCheckerConverterCallback = (key: string | string[], messageStyle: "plain" | "plainNested" | "rich" | "richNested" | any) => any;
+export type Sort = any;
+export type SortList = any;
+export type List = any;
+export type I18NCallback = any;
+export type Integer = number;
+export type JSON6 = any;
+export type AnyValue = any;
+export type BetweenMatches = (str: string) => void;
+export type AfterMatch = (str: string) => void;
+export type EscapeAtOne = (str: string) => void;
+export type Fetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+/**
+ * Callback to give replacement text based on a substitution value.
+ *
+ * `value` - contains the value returned by the individual substitution.
+ * `arg` - See `cfg.arg` of {@link SubstitutionCallback}.
+ * `key` - The substitution key Not currently in use
+ * `locale` - The locale.
+ */
+export type AllSubstitutionCallback = (info: {
+    value: any;
+    arg?: string;
+    key?: string;
+    locale?: string;
+}) => string | Node;
+/**
+ * `arg` - By default, accepts the third portion of the
+ *   `formattingRegex` within `insertNodes`, i.e., to allow the locale to
+ *   supply arguments back to the calling script.
+ * `key` - The substitution key.
+ */
+export type SubstitutionCallback = (cfg: {
+    arg: string;
+    key: string;
+}) => string | Element;
+/**
+ * May have additional properties if supplying options to an underlying
+ * formatter.
+ * The first value is the main value.
+ * The second are the options related to the main value.
+ * The third are any additional options.
+ */
+export type ValueArray = [string | number | Date, object?, object?];
+export type ListValueArray = [string[], (((item: string, i: Integer) => Element) | object)?, object?, object?];
+export type DateRangeValueArray = [Date | number, Date | number, Intl.DateTimeFormatOptions | undefined];
+export type RelativeValueArray = [number, Intl.RelativeTimeFormatUnit, object?];
+export type RelativeTimeInfo = {
+    relative: RelativeValueArray;
+};
+export type ListInfo = {
+    list: ListValueArray;
+};
+export type NumberInfo = {
+    number: ValueArray | number;
+};
+export type DateInfo = {
+    date: ValueArray;
+};
+export type DateTimeInfo = {
+    datetime: ValueArray;
+};
+export type DateRangeInfo = {
+    dateRange: DateRangeValueArray;
+};
+export type DatetimeRangeInfo = {
+    datetimeRange: DateRangeValueArray;
+};
+export type RegionInfo = {
+    region: ValueArray;
+};
+export type LanguageInfo = {
+    language: ValueArray;
+};
+export type ScriptInfo = {
+    script: ValueArray;
+};
+export type CurrencyInfo = {
+    currency: ValueArray;
+};
+export type PluralInfo = {
+    plural: ValueArray;
+};
+export type PlainLocaleStringBodyObject = {
+    [key: string]: string;
+};
+export type PlainNestedLocaleStringBodyObject = {
+    [key: string]: string | PlainNestedLocaleStringBodyObject;
+};
+export type SwitchCaseInfo = {
+    /**
+     * Whether this conditional is the default
+     */
+    default?: boolean | undefined;
+};
+/**
+ * Contains the type, the message, and optional info about the switch case.
+ */
+export type SwitchCaseArray = [string, string, SwitchCaseInfo?];
+export type SwitchArray = {
+    [x: string]: SwitchCaseArray;
+};
+export type SwitchArrays = {
+    [x: string]: SwitchArray;
+};
+export type SwitchCase = {
+    /**
+     * The locale message with any formatting
+     * place-holders; defaults to use of any single conditional
+     */
+    message: string;
+    /**
+     * A description to add for translators
+     */
+    description?: string | undefined;
+};
+export type Switch = {
+    [x: string]: SwitchCase;
+};
+export type Switches = {
+    [x: string]: Switch;
+};
+export type RichLocaleStringSubObject = {
+    /**
+     * The locale message with any formatting
+     * place-holders; defaults to use of any single conditional
+     */
+    message: string;
+    /**
+     * A description to add for translators
+     */
+    description?: string | undefined;
+    /**
+     * Conditionals
+     */
+    switches?: {
+        [x: string]: {
+            [x: string]: SwitchCase;
+        };
+    } | undefined;
+};
+export type RichLocaleStringBodyObject = {
+    [key: string]: RichLocaleStringSubObject;
+};
+export type RichNestedLocaleStringBodyObject = {
+    [key: string]: RichLocaleStringSubObject | RichNestedLocaleStringBodyObject;
+};
+/**
+ * Takes a base path and locale and gives a URL.
+ */
+export type LocaleResolver = (localesBasePath: string, locale: string) => string | false;
+export type DateRange = [Date | number, Date | number, (Intl.DateTimeFormatOptions | undefined)?];
+export type SubstitutionObjectValue = string | string[] | number | Date | DateRange | Element | Node | SubstitutionCallback | NumberInfo | PluralInfo | CurrencyInfo | LanguageInfo | ScriptInfo | DatetimeRangeInfo | DateRangeInfo | RegionInfo | DateTimeInfo | DateInfo | ListInfo | RelativeTimeInfo;
+export type SubstitutionObject = {
+    [key: string]: SubstitutionObjectValue;
+};
+export type Replace = (cfg: {
+    str: string;
+    substs?: any;
+    formatter?: any | any | any;
+}) => string;
+export type ProcessSubstitutions = (cfg: {
+    str: string;
+    substs?: any;
+    formatter?: any | any | any;
+}) => (string | Node)[];
+/**
+ * Callback to return a string or array of nodes and strings based on
+ *   a localized string, substitutions object, and other metadata.
+ *
+ * `string` - The localized string.
+ * `dom` - If substitutions known to contain DOM, can be set
+ *    to `true` to optimize.
+ * `usedKeys` - Array for tracking which keys have been used. Defaults
+ *   to empty array.
+ * `substitutions` - The formatting substitutions object.
+ * `allSubstitutions` - The
+ *   callback or array composed thereof for applying to each substitution.
+ * `locale` - The successfully resolved locale
+ * `locals` - The local section.
+ * `switches` - The switch section.
+ * `maximumLocalNestingDepth` - Depth of local variable resolution to
+ *   check before reporting a recursion error. Defaults to 3.
+ * `missingSuppliedFormatters` - Callback
+ *   supplied key to throw if the supplied key is present (if
+ *   `throwOnMissingSuppliedFormatters` is enabled). Defaults to no-op.
+ * `checkExtraSuppliedFormatters` - No
+ *   argument callback to check if any formatters are not present in `string`
+ *   (if `throwOnExtraSuppliedFormatters` is enabled). Defaults to no-op.
+ */
+export type InsertNodesCallback = (cfg: {
+    string: string;
+    dom?: boolean;
+    usedKeys: string[];
+    substitutions: any;
+    allSubstitutions?: (any | any[]) | null;
+    locale: string | undefined;
+    locals?: any | undefined;
+    switches: any | undefined;
+    maximumLocalNestingDepth?: Integer;
+    missingSuppliedFormatters: any;
+    checkExtraSuppliedFormatters: any;
+}) => string | (Node | string)[];
+export type LocalObject = LocaleBody;
+/**
+ * May also contain language code and direction, translator name and
+ * contact, etc., but no defaults currently apply besides reserving `locals`
+ */
+export type LocaleHead = {
+    locals?: LocalObject;
+    switches?: any;
+};
+export type LocaleBody = any | any | any | any | object;
+export type LocaleObject = {
+    head?: LocaleHead | undefined;
+    body: LocaleBody;
+};
+export type MessageStyleCallbackResult = {
+    /**
+     * Regardless of message style, will contain
+     * the string result
+     */
+    value: string;
+    /**
+     * Full info on the localized item
+     * (for rich message styles only)
+     */
+    info?: any;
+};
+export type MessageStyleCallback = (obj: LocaleObject, key: string) => false | MessageStyleCallbackResult;
+export type CheckExtraSuppliedFormattersCallback = (substs: any | {
+    substitutions: import("./defaultLocaleResolver.js").SubstitutionObject;
+}) => any;
+export type MissingSuppliedFormattersCallback = (cfg: {
+    key: string;
+    formatter: any | any | any;
+}) => boolean;
+export type LocaleObjectInfo = {
+    /**
+     * The successfully retrieved locale strings
+     */
+    strings: any;
+    /**
+     * The successfully resolved locale
+     */
+    locale: string;
+};
+export type LocaleStringArgs = {
+    locales?: string[];
+    defaultLocales?: string[];
+    localesBasePath?: string;
+    localeResolver?: any;
+    localeMatcher?: "lookup" | LocaleMatcher;
+};
+/**
+ * `locales` - BCP-47 language strings. Defaults to `navigator.languages`.
+ * `defaultLocales` - Defaults to ["en-US"].
+ * `localesBasePath` - Defaults to `.`.
+ * `localeResolver` - Defaults to `defaultLocaleResolver`.
+ */
+export type LocaleStringFinder = (cfg?: LocaleStringArgs) => Promise<LocaleObjectInfo>;
+export function getFilePaths(filesObj: any, fileGroup: any, fileData: any): {
+    file: string;
+    schemaFile: string;
+    metadataFile: string;
+};
+export function getWorkData({ lang, fallbackLanguages, work, files, allowPlugins, basePath, languages, preferredLocale }: {
+    lang: any;
+    fallbackLanguages: any;
+    work: any;
+    files: any;
+    allowPlugins: any;
+    basePath: any;
+    languages: any;
+    preferredLocale: any;
+}): Promise<{
+    fileData: undefined;
+    workI18n: any;
+    getFieldAliasOrName: (field: any) => any;
+    metadataObj: any;
+    schemaObj: any;
+    schemaItems: any;
+    fieldInfo: any;
+    pluginsForWork: PluginsForWork;
+    groupsToWorks: any;
+    metadata: Metadata;
+}>;
+/**
+ * Imported by the `dist/sw-helper.js`
+ * @param {string} files The files.json file path
+ * @returns {PlainObject}
+ */
+export function getWorkFiles(files: string): PlainObject;
+declare class PluginsForWork {
+    constructor({ pluginsInWork, pluginFieldMappings, pluginObjects }: {
+        pluginsInWork: any;
+        pluginFieldMappings: any;
+        pluginObjects: any;
+    });
+    pluginsInWork: any;
+    pluginFieldMappings: any;
+    pluginObjects: any;
+    getPluginObject(pluginName: any): any;
+    iterateMappings(cb: any): void;
+    processTargetLanguages(applicableFields: any, cb: any): boolean;
+    isPluginField({ namespace, field }: {
+        namespace: any;
+        field: any;
+    }): any;
+    getPluginFieldParts({ namespace, field }: {
+        namespace: any;
+        field: any;
+    }): any[];
+}
+declare class Metadata {
+    constructor({ metadataObj }: {
+        metadataObj: any;
+    });
+    metadataObj: any;
+    getFieldLang(field: any): any;
+    getFieldMatchesLocale({ namespace, preferredLocale, schemaItems, pluginsForWork }: {
+        namespace: any;
+        preferredLocale: any;
+        schemaItems: any;
+        pluginsForWork: any;
+    }): (field: any) => any;
+}
+export {};
+//# sourceMappingURL=WorkInfo-es.d.ts.map

package/dist/dist/WorkInfo-es.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkInfo-es.d.ts","sourceRoot":"","sources":["../WorkInfo-es.js"],"names":[],"mappings":"wCAIW,MAAM,GAAC,MAAM,EAAE,MACf,kBAAkB,WAClB,iBAAiB,KACf,OAAO,CAAC,IAAI,CAAC;kCAo+Cb,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,GAAC,GAAG;gDA00BlC,MAAM,GAAC,MAAM,EAAE,gBAEf,OAAO,GAAC,aAAa,GAAC,MAAM,GACtC,YAAgB,GAChB,GAA+D;mBA2kBnD,GAAyB;uBAGzB,GAA6B;mBAG7B,GAAyB;2BAIzB,GAAiC;sBAqCjC,MAAM;oBA91EN,GAAG;uBAiBH,GAAG;mCAkBL,MAAM,KACJ,IAAI;+BAKN,MAAM,KACJ,IAAI;gCAKN,MAAM,KACJ,IAAI;oBAyDJ,CACR,KAAK,EAAE,WAAW,GAAC,GAAG,EAAE,IAAI,CAAC,EAAE,WAAW,KACvC,OAAO,CAAC,QAAQ,CAAC;;;;;;;;;sCAkMZ,CAAC,IAAI,EAAE;IACf,KAAK,EAAE,GAA4D,CAAA;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,KAAK,MAAM,GAAC,IAAI;;;;;;;yCA21BV;IACN,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,KACS,MAAM,GAAC,OAAO;;;;;;;;yBASb,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;6BAQtC,CACZ,MAAU,EAAE,EACZ,CAAK,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,GAAC,MAAM,CAAC,CAAC,EACrD,MAAU,CAAC,EACX,MAAU,CAAC,CACR;kCAIS,CACR,IAAI,GAAC,MAAM,EAAE,IAAI,GAAC,MAAM,EAAE,IAAI,CAAC,qBAAqB,GAAC,SAAS,CAC/D;iCAIS,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;;cAK7C,kBAAkB;;;UAKlB,cAAc;;;YAKd,UAAU,GAAC,MAAM;;;UAKjB,UAAU;;;cAKV,UAAU;;;eAKV,mBAAmB;;;mBAKnB,mBAAmB;;;YAKnB,UAAU;;;cAKV,UAAU;;;YAKV,UAAU;;;cAKV,UAAU;;;YAKV,UAAU;;0CAIX;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAC;gDAIvB;IACZ,CAAK,GAAG,EAAE,MAAM,GAAG,MAAM,GAAC,iCAAiC,CAAA;CACxD;;;;;;;;;;8BAUS,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;0BAIjC;QAAO,MAAM,GAAE,eAAe;CAAC;2BAI/B;QAAO,MAAM,GAAE,WAAW;CAAC;;;;;;aAK1B,MAAM;;;;;;qBAMP;QAAO,MAAM,GAAE,UAAU;CAAC;uBAI1B;QAAO,MAAM,GAAE,MAAM;CAAC;;;;;;aAKrB,MAAM;;;;;;;;;;;;;;yCAOP;IACZ,CAAK,GAAG,EAAE,MAAM,GAAG,yBAAyB,CAAA;CACzC;+CAIS;IACZ,CAAK,GAAG,EAAE,MAAM,GAAG,yBAAyB,GAAC,gCAAgC,CAAA;CAC1E;;;;+CAMO,MAAM,UACN,MAAM,KACJ,MAAM,GAAC,KAAK;wBAIZ,CACR,IAAI,GAAC,MAAM,EAAE,IAAI,GAAC,MAAM,EAAE,CAAC,IAAI,CAAC,qBAAqB,GAAC,SAAS,CAAC,CAAC,CAClE;sCAIS,MAAM,GAAC,MAAM,EAAE,GAAC,MAAM,GAAC,IAAI,GAAC,SAAS,GAC3C,OAAO,GAAC,IAAI,GAAC,oBAAoB,GACjC,UAAU,GAAC,UAAU,GAAC,YAAY,GAAC,YAAY,GAAC,UAAU,GAC1D,iBAAiB,GAAC,aAAa,GAAC,UAAU,GAAC,YAAY,GAAC,QAAQ,GAChE,QAAQ,GAAC,gBAAgB;iCAKnB;IACZ,CAAK,GAAG,EAAE,MAAM,GAAG,uBAAuB,CAAA;CACvC;4BAyBO;IACN,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,GAAuD,CAAC;IACjE,SAAS,CAAC,EAAE,GAAyC,GACzD,GAA6C,GAC7C,GAA8C,CAAA;CAC3C,KACS,MAAM;yCAKR;IACN,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,GAAuD,CAAC;IACjE,SAAS,CAAC,EAAE,GAAyC,GACzD,GAA6C,GAC7C,GAA8C,CAAA;CAC3C,KACS,CAAC,MAAM,GAAC,IAAI,CAAC,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;kCA0Bf,CAAC,GAAG,EAAE;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,EAAE,GAAuD,CAAC;IACvE,gBAAgB,CAAC,EAAG,CACxB,GAAoE,GACpE,GAAoE,EAAE,CACjE,OAAA,CAAA;IACD,MAAM,EAAE,MAAM,GAAC,SAAS,CAAC;IACzB,MAAM,CAAC,EAAE,GAAkD,GAAC,SAAS,CAAC;IACtE,QAAQ,EAAE,GAA6C,GAAC,SAAS,CAAC;IAClE,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,yBAAyB,EAAE,GACQ,CAAC;IACpC,4BAA4B,EAAE,GACQ,CAAA;CACvC,KAAK,MAAM,GAAC,CAAC,IAAI,GAAC,MAAM,CAAC,EAAE;0BA8VnB,UAAU;;;;;;aAOR,WAAW;eACX,GAA6C;;yBAI9C,GACwB,GACpC,GAAmE,GACnE,GAAoE,GACpE,GAA0E,GAC1E,MAAU;;;UAOE,UAAU;;;;;;;WAKV,MAAM;;;;;WAEN,GAEiB;;yCAMpB,YAAY,OAEZ,MAAM,KACJ,KAAK,GAAC,0BAA0B;4DAsNjC,GAAuD,GAAC;IAC9D,aAAa,EAAE,OAAO,4BAA4B,EAAE,kBAAkB,CAAA;CACvE;gDAMS,CACR,GAAG,EAAE;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,GAAuC,GACxD,GAAiD,GACjD,GAAgD,CAAA;CAC3C,KACE,OAAO;;;;;aA8KD,GACG;;;;YACH,MAAM;;+BAIP;IACR,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,GAAmD,CAAC;IACrE,aAAa,CAAC,EAAE,QAAQ,GAAC,aAAa,CAAA;CACvC;;;;;;;iCAQS,CACR,GAAG,CAAC,EAAE,gBAAgB,KACnB,OAAO,CAAC,gBAAgB,CAAC;AAylBjC;;;;EAWC;AAED;;;;;;;;;;;;;;;;;;;;GAkOC;AApQD;;;;GAIG;AACH,oCAHW,MAAM,GACJ,WAAW,CAgBvB;AA5FD;IACE;;;;OAIC;IAHC,mBAAkC;IAClC,yBAA8C;IAC9C,mBAAkC;IAEpC,sCAMC;IACD,+BAyBC;IACD,gEAgBC;IACD;;;YAEC;IACD;;;cASC;CACF;AAhJD;IACE;;OAEC;IADC,iBAA8B;IAGhC,8BAIC;IAED;;;;;4BAoCC;CACF"}

package/dist/dist/activateCallback-es.d.ts

@@ -0,0 +1,17 @@
+export { activateCallback as default };
+export type Logger = (...args: any[]) => void;
+/**
+* @callback Logger
+* @param {...any} args
+* @returns {void}
+*/
+/**
+ * @param {PlainObject} cfg
+ * @param {string} cfg.namespace
+ * @param {string[]} cfg.files
+ * @param {Logger} cfg.log
+ * @param {string} [cfg.basePath]
+ * @returns {Promise<void>}
+ */
+declare function activateCallback({ namespace, files, log, basePath }: PlainObject): Promise<void>;
+//# sourceMappingURL=activateCallback-es.d.ts.map

package/dist/dist/activateCallback-es.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"activateCallback-es.d.ts","sourceRoot":"","sources":["../activateCallback-es.js"],"names":[],"mappings":";+BAsBa,GAAG,EAAA,KACJ,IAAI;AAHhB;;;;EAIE;AAEF;;;;;;;GAOG;AACH,uEAPW,WAAW,GAKT,OAAO,CAAC,IAAI,CAAC,CA+HzB"}