{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./converters" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./data" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./decorators" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./design-system" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./directives" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./encoding" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./env" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./error" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./feature-flags" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./formatters" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./logger" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./mappers" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./mixins" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./observer" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./promise" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./resource" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./route" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./serializers" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./shortcut-manager" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./state" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./utils" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./uuid" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./window" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./inactivity" } } ] }, { "kind": "javascript-module", "path": "src/data/inMemoryDatabase.ts", "declarations": [ { "kind": "class", "description": "An in memory database of specific DatabaseRecord types.", "name": "InMemoryDatabase", "members": [ { "kind": "field", "name": "isWorking", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "records", "type": { "text": "Record" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "beforeUpdateListeners", "privacy": "private" }, { "kind": "field", "name": "afterUpdateListeners", "privacy": "private" }, { "kind": "method", "name": "create", "privacy": "public", "return": { "type": { "text": "Promise>" } }, "parameters": [ { "name": "newValue", "type": { "text": "Omit" } } ] }, { "kind": "method", "name": "read", "privacy": "public", "return": { "type": { "text": "Promise>" } }, "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "update", "privacy": "public", "return": { "type": { "text": "Promise>" } }, "parameters": [ { "name": "id", "type": { "text": "string" } }, { "name": "newValue", "type": { "text": "Omit, 'id'>" } } ] }, { "kind": "method", "name": "delete", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "visit", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "visitor", "type": { "text": "(record: T) => void" } } ] }, { "kind": "method", "name": "onBeforeUpdate", "privacy": "public", "return": { "type": { "text": "() => void" } }, "parameters": [ { "name": "listener", "type": { "text": "Listener>" } } ] }, { "kind": "method", "name": "onAfterUpdate", "privacy": "public", "return": { "type": { "text": "() => void" } }, "parameters": [ { "name": "listener", "type": { "text": "Listener>" } } ] } ] } ], "exports": [ { "kind": "js", "name": "InMemoryDatabase", "declaration": { "name": "InMemoryDatabase", "module": "src/data/inMemoryDatabase.ts" } } ] }, { "kind": "javascript-module", "path": "src/data/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./inMemoryDatabase" } } ] }, { "kind": "javascript-module", "path": "src/design-system/design-system.ts", "declarations": [ { "kind": "function", "name": "assureDesignSystem", "return": { "type": { "text": "DesignSystemModule" } }, "parameters": [ { "name": "module", "type": { "text": "DesignSystemModule" } } ], "description": "assureDesignSystem.", "privacy": "public" }, { "kind": "function", "name": "getCurrentDesignSystem", "return": { "type": { "text": "" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" }, "description": "The starting HTML element" }, { "name": "fallbackPrefix", "type": { "text": "string" }, "description": "The prefix to fallback to if the provider is not available" } ], "description": "Get the current design system provider element and prefix by checking available providers.\nIf no provider is found, falls back to the provided prefix.", "privacy": "public" }, { "kind": "function", "name": "getCurrentDesignSystemPrefix", "return": { "type": { "text": "" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" }, "description": "The starting HTML element" }, { "name": "fallbackPrefix", "type": { "text": "string" }, "description": "The prefix to fallback to if the provider is not available" } ], "description": "Get the current design system prefix by checking available providers.\nIf no provider is found, falls back to the provided prefix.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "assureDesignSystem", "declaration": { "name": "assureDesignSystem", "module": "src/design-system/design-system.ts" } }, { "kind": "js", "name": "getCurrentDesignSystem", "declaration": { "name": "getCurrentDesignSystem", "module": "src/design-system/design-system.ts" } }, { "kind": "js", "name": "getCurrentDesignSystemPrefix", "declaration": { "name": "getCurrentDesignSystemPrefix", "module": "src/design-system/design-system.ts" } } ] }, { "kind": "javascript-module", "path": "src/design-system/editable-elements.ts", "declarations": [ { "kind": "variable", "name": "BASE_EDITABLE_ELEMENT_SELECTORS", "type": { "text": "[\n ...NATIVE_EDITABLE_ELEMENT_SELECTORS,\n ...CONTENT_EDITABLE_SELECTORS,\n ...ARIA_EDITABLE_ROLE_SELECTORS,\n]" }, "default": "[\n ...NATIVE_EDITABLE_ELEMENT_SELECTORS,\n ...CONTENT_EDITABLE_SELECTORS,\n ...ARIA_EDITABLE_ROLE_SELECTORS,\n]", "description": "Base selectors treated as editable context regardless of design system.\nIncludes native controls, contenteditable, and ARIA-editable roles." }, { "kind": "variable", "name": "DESIGN_SYSTEM_EDITABLE_ELEMENT_SELECTORS", "type": { "text": "Record<\n EditableDesignSystemPrefix,\n readonly string[]\n>" }, "default": "{\n rapid: buildDesignSystemEditableSelectors('rapid'),\n zero: buildDesignSystemEditableSelectors('zero'),\n}", "description": "Design-system specific editable host selectors." }, { "kind": "function", "name": "buildEditableElementSelector", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "designSystems", "type": { "text": "readonly EditableDesignSystemPrefix[]" } }, { "name": "customEditableSelectors", "default": "[]", "type": { "text": "readonly string[]" } } ] } ], "exports": [ { "kind": "js", "name": "BASE_EDITABLE_ELEMENT_SELECTORS", "declaration": { "name": "BASE_EDITABLE_ELEMENT_SELECTORS", "module": "src/design-system/editable-elements.ts" } }, { "kind": "js", "name": "DESIGN_SYSTEM_EDITABLE_ELEMENT_SELECTORS", "declaration": { "name": "DESIGN_SYSTEM_EDITABLE_ELEMENT_SELECTORS", "module": "src/design-system/editable-elements.ts" } }, { "kind": "js", "name": "buildEditableElementSelector", "declaration": { "name": "buildEditableElementSelector", "module": "src/design-system/editable-elements.ts" } } ] }, { "kind": "javascript-module", "path": "src/design-system/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./design-system" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./editable-elements" } } ] }, { "kind": "javascript-module", "path": "src/converters/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./string-array-converter" } } ] }, { "kind": "javascript-module", "path": "src/converters/string-array-converter.ts", "declarations": [ { "kind": "variable", "name": "stringArrayConverter", "type": { "text": "ValueConverter" }, "default": "{\n fromView(v: string): string | string[] | undefined {\n if (!v?.trim()) return undefined;\n return v.includes(',') ? v.split(',').map((s) => s.trim()) : v.trim();\n },\n toView(v: string | string[] | undefined): string {\n if (typeof v === 'string') return v;\n if (Array.isArray(v)) return v.join(',');\n return '';\n },\n}", "description": "A @microsoft/fast-element#ValueConverter that converts between comma-separated string attributes\nand `string | string[]` properties.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "stringArrayConverter", "declaration": { "name": "stringArrayConverter", "module": "src/converters/string-array-converter.ts" } } ] }, { "kind": "javascript-module", "path": "src/directives/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./sync" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./when-else" } } ] }, { "kind": "javascript-module", "path": "src/encoding/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./base64" } } ] }, { "kind": "javascript-module", "path": "src/decorators/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./renderOnChange" } } ] }, { "kind": "javascript-module", "path": "src/decorators/renderOnChange.ts", "declarations": [ { "kind": "function", "name": "renderOnChange", "parameters": [ { "name": "target", "type": { "text": "FASTElement & { render(): void }" }, "description": "The target to define the property change handler on." }, { "name": "name", "type": { "text": "string" }, "description": "The property name." } ], "description": "Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "renderOnChange", "declaration": { "name": "renderOnChange", "module": "src/decorators/renderOnChange.ts" } } ] }, { "kind": "javascript-module", "path": "src/env/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./is-dev" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./variables" } } ] }, { "kind": "javascript-module", "path": "src/env/is-dev.ts", "declarations": [ { "kind": "function", "name": "isDev", "description": "Determines if the current environment is a development environment.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "isDev", "declaration": { "name": "isDev", "module": "src/env/is-dev.ts" } } ] }, { "kind": "javascript-module", "path": "src/env/variables.ts", "declarations": [ { "kind": "variable", "name": "BUILDER", "type": { "text": "string" } }, { "kind": "variable", "name": "_BUILDER", "type": { "text": "string" }, "default": "'webpack'", "description": "The builder aka file bundler.", "privacy": "public" }, { "kind": "variable", "name": "PUBLIC_PATH", "type": { "text": "string" } }, { "kind": "variable", "name": "_PUBLIC_PATH", "type": { "text": "string" }, "default": "'/'", "description": "The public path.", "privacy": "public" }, { "kind": "variable", "name": "SOCKET_EXT", "type": { "text": "string" } }, { "kind": "variable", "name": "_SOCKET_EXT", "type": { "text": "string" }, "default": "'gwf'", "description": "The sub-path used for WebSocket connections when API_HOST is not set", "privacy": "public" }, { "kind": "variable", "name": "FORCE_HTTP", "type": { "text": "string" } }, { "kind": "variable", "name": "_FORCE_HTTP", "type": { "text": "string" }, "description": "The path to a JSON config file for the HTTP mode.", "privacy": "public" }, { "kind": "variable", "name": "GENESIS_SOCKET_URL", "default": "`${location.protocol.replace('http', 'ws')}//${location.host}${_PUBLIC_PATH}/${_SOCKET_EXT}/`", "description": "Genesis Socket URL", "privacy": "public" }, { "kind": "variable", "name": "API_HOST", "type": { "text": "string" } }, { "kind": "variable", "name": "_API_HOST", "type": { "text": "string" }, "default": "`${PROTOCOL}//${location.host}/${_SOCKET_EXT}/`", "description": "The Genesis Server URL (WebSocket or HTTP).", "privacy": "public" }, { "kind": "variable", "name": "HTTP_CONFIG", "type": { "text": "string" } }, { "kind": "variable", "name": "_HTTP_CONFIG", "type": { "text": "string" }, "description": "Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).", "privacy": "public" }, { "kind": "variable", "name": "DEFAULT_ORGANISATION", "type": { "text": "string" } }, { "kind": "variable", "name": "_DEFAULT_ORGANISATION", "type": { "text": "string" }, "description": "The default Organisation value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).", "privacy": "public" }, { "kind": "variable", "name": "DEFAULT_PASSWORD", "type": { "text": "string" } }, { "kind": "variable", "name": "_DEFAULT_PASSWORD", "type": { "text": "string" }, "description": "The default Password value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).", "privacy": "public" }, { "kind": "variable", "name": "DEFAULT_USER", "type": { "text": "string" } }, { "kind": "variable", "name": "_DEFAULT_USER", "type": { "text": "string" }, "description": "The default Username value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).", "privacy": "public" }, { "kind": "variable", "name": "LOGIN_URL", "type": { "text": "string" }, "default": "'gwf/event-login-auth'", "privacy": "public" }, { "kind": "variable", "name": "LOGIN_REFRESH_URL", "type": { "text": "string" }, "default": "'gwf/event-login-auth'", "privacy": "public" }, { "kind": "variable", "name": "LOGIN_DETAILS_URL", "type": { "text": "string" }, "default": "'gwf/event-login-details'", "privacy": "public" }, { "kind": "variable", "name": "LOGOUT_URL", "type": { "text": "string" }, "default": "'gwf/event-logout'", "privacy": "public" }, { "kind": "variable", "name": "CHANGE_PASSWORD_URL", "type": { "text": "string" }, "default": "'gwf/event-change-user-password'", "privacy": "public" }, { "kind": "variable", "name": "FORGOT_PASSWORD_URL", "type": { "text": "string" }, "default": "'gwf/event-self-service-password-reset'", "privacy": "public" }, { "kind": "variable", "name": "RESET_PASSWORD_URL", "type": { "text": "string" }, "default": "'gwf/event-password-reset-action'", "privacy": "public" }, { "kind": "variable", "name": "SSO_LIST_URL", "type": { "text": "string" }, "default": "'gwf/sso/list'", "privacy": "public" }, { "kind": "variable", "name": "SSO_LOGIN_URL", "type": { "text": "string" }, "default": "'gwf/{type}/login?idp={id}'", "privacy": "public" }, { "kind": "variable", "name": "ENVIRONMENT_LEVEL", "type": { "text": "string" }, "default": "'default'", "privacy": "public" }, { "kind": "variable", "name": "ACCEPT_TERMS_URL", "type": { "text": "string" }, "default": "'gwf/auth/accept-terms'", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "BUILDER", "declaration": { "name": "_BUILDER", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "PUBLIC_PATH", "declaration": { "name": "_PUBLIC_PATH", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "SOCKET_EXT", "declaration": { "name": "_SOCKET_EXT", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "FORCE_HTTP", "declaration": { "name": "_FORCE_HTTP", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "GENESIS_SOCKET_URL", "declaration": { "name": "GENESIS_SOCKET_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "API_HOST", "declaration": { "name": "_API_HOST", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "HTTP_CONFIG", "declaration": { "name": "_HTTP_CONFIG", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "DEFAULT_ORGANISATION", "declaration": { "name": "_DEFAULT_ORGANISATION", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "DEFAULT_PASSWORD", "declaration": { "name": "_DEFAULT_PASSWORD", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "DEFAULT_USER", "declaration": { "name": "_DEFAULT_USER", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "LOGIN_URL", "declaration": { "name": "LOGIN_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "LOGIN_REFRESH_URL", "declaration": { "name": "LOGIN_REFRESH_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "LOGIN_DETAILS_URL", "declaration": { "name": "LOGIN_DETAILS_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "LOGOUT_URL", "declaration": { "name": "LOGOUT_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "CHANGE_PASSWORD_URL", "declaration": { "name": "CHANGE_PASSWORD_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "FORGOT_PASSWORD_URL", "declaration": { "name": "FORGOT_PASSWORD_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "RESET_PASSWORD_URL", "declaration": { "name": "RESET_PASSWORD_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "SSO_LIST_URL", "declaration": { "name": "SSO_LIST_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "SSO_LOGIN_URL", "declaration": { "name": "SSO_LOGIN_URL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "ENVIRONMENT_LEVEL", "declaration": { "name": "ENVIRONMENT_LEVEL", "module": "src/env/variables.ts" } }, { "kind": "js", "name": "ACCEPT_TERMS_URL", "declaration": { "name": "ACCEPT_TERMS_URL", "module": "src/env/variables.ts" } } ] }, { "kind": "javascript-module", "path": "src/error/errorMap.ts", "declarations": [ { "kind": "class", "description": "", "name": "DefaultErrorMap", "members": [ { "kind": "field", "name": "map", "privacy": "private", "default": "new Map()" }, { "kind": "field", "name": "lastError", "type": { "text": "Error" }, "description": "{@inheritDoc ErrorMap.lastError}" }, { "kind": "method", "name": "set", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "key", "type": { "text": "keyof TErrorDetailMap" } }, { "name": "error", "type": { "text": "Error" } } ], "description": "{@inheritDoc ErrorMap.set}" }, { "kind": "method", "name": "get", "return": { "type": { "text": "" } }, "parameters": [ { "name": "key", "type": { "text": "keyof TErrorDetailMap" }, "description": "The key." } ], "description": "Get an error by key.", "privacy": "public" }, { "kind": "method", "name": "has", "return": { "type": { "text": "" } }, "parameters": [ { "name": "key", "type": { "text": "keyof TErrorDetailMap" }, "description": "The key." } ], "description": "Has an error for key.", "privacy": "public" }, { "kind": "method", "name": "delete", "return": { "type": { "text": "" } }, "parameters": [ { "name": "key", "type": { "text": "keyof TErrorDetailMap" }, "description": "The key." } ], "description": "Delete an error.", "privacy": "public" }, { "kind": "method", "name": "clear", "description": "Clear errors.", "privacy": "public" }, { "kind": "field", "name": "size", "type": { "text": "number" }, "description": "The size of the error map.", "return": { "type": { "text": "" } }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "values", "privacy": "public" }, { "kind": "field", "name": "messages", "type": { "text": "string" }, "description": "{@inheritDoc ErrorMap.messages}", "readonly": true } ] }, { "kind": "function", "name": "createErrorMap", "return": { "type": { "text": "" } }, "parameters": [ { "name": "logger", "type": { "text": "ErrorMapLogger" }, "description": "A logger error method reference." } ], "description": "A factory to create the error map.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "DefaultErrorMap", "declaration": { "name": "DefaultErrorMap", "module": "src/error/errorMap.ts" } }, { "kind": "js", "name": "createErrorMap", "declaration": { "name": "createErrorMap", "module": "src/error/errorMap.ts" } } ] }, { "kind": "javascript-module", "path": "src/error/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./errorMap" } } ] }, { "kind": "javascript-module", "path": "src/feature-flags/featureFlags.ts", "declarations": [ { "kind": "function", "name": "isFeatureActivated", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "feature", "type": { "text": "string" } } ] } ], "exports": [ { "kind": "js", "name": "isFeatureActivated", "declaration": { "name": "isFeatureActivated", "module": "src/feature-flags/featureFlags.ts" } } ] }, { "kind": "javascript-module", "path": "src/feature-flags/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./featureFlags" } } ] }, { "kind": "javascript-module", "path": "src/formatters/datetime.ts", "declarations": [ { "kind": "function", "name": "formatDateTimestamp", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "timestamp", "type": { "text": "number" } } ], "description": "Formats [DATE] UNIX Timestamps (without time) to readable strings", "privacy": "public" }, { "kind": "function", "name": "formatDateTimeTimestamp", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "timestamp", "type": { "text": "number" } } ], "description": "Formats [DATETIME] UNIX Timestamps (with time) to readable strings", "privacy": "public" }, { "kind": "function", "name": "formatDateTimeTimestampWithMilliseconds", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "timestamp", "type": { "text": "number" } } ], "description": "Formats [DATETIME] UNIX Timestamps (with time and milliseconds) to readable strings", "privacy": "public" }, { "kind": "function", "name": "formatTimestamp", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "timestamp", "type": { "text": "number" }, "description": "The UNIX Timestamp." }, { "name": "withTime", "type": { "text": "boolean" }, "description": "The flag to determine if formatted value should contain 'time' info." } ], "description": "Formats [DATE|DATETIME] Unix Timestamps to readable strings", "privacy": "public" }, { "kind": "function", "name": "getDateFormatter", "parameters": [ { "name": "locale", "default": "'en-GB'", "type": { "text": "string" } }, { "name": "options", "default": "defaultDateOptions", "type": { "text": "Intl.DateTimeFormatOptions" } } ], "privacy": "public" } ], "exports": [ { "kind": "js", "name": "formatDateTimestamp", "declaration": { "name": "formatDateTimestamp", "module": "src/formatters/datetime.ts" } }, { "kind": "js", "name": "formatDateTimeTimestamp", "declaration": { "name": "formatDateTimeTimestamp", "module": "src/formatters/datetime.ts" } }, { "kind": "js", "name": "formatDateTimeTimestampWithMilliseconds", "declaration": { "name": "formatDateTimeTimestampWithMilliseconds", "module": "src/formatters/datetime.ts" } }, { "kind": "js", "name": "formatTimestamp", "declaration": { "name": "formatTimestamp", "module": "src/formatters/datetime.ts" } }, { "kind": "js", "name": "getDateFormatter", "declaration": { "name": "getDateFormatter", "module": "src/formatters/datetime.ts" } } ] }, { "kind": "javascript-module", "path": "src/formatters/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./datetime" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./localeNumberParser" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./number" } } ] }, { "kind": "javascript-module", "path": "src/formatters/localeNumberParser.ts", "declarations": [ { "kind": "class", "description": "", "name": "NumberParser", "members": [ { "kind": "field", "name": "_decimal", "type": { "text": "RegExp" }, "privacy": "private", "default": "new RegExp(`[${parts.find((d) => d.type === 'decimal').value}]`)" }, { "kind": "field", "name": "_separator", "type": { "text": "RegExp" }, "privacy": "private", "default": "new RegExp(\n `[$${parts.find((d) => d.type === 'decimal').value}](?:0*$|[^0]0+$)`,\n )" }, { "kind": "field", "name": "_numeral", "type": { "text": "RegExp" }, "privacy": "private", "default": "new RegExp(`[${numerals.join('')}]`, 'g')" }, { "kind": "field", "name": "_index", "type": { "text": "any" }, "privacy": "private" }, { "kind": "method", "name": "parse", "parameters": [ { "name": "localeNumber", "type": { "text": "string" } } ] }, { "kind": "method", "name": "hasSeparator", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "localeNumber", "type": { "text": "string" } } ] }, { "kind": "field", "name": "_group", "default": "new RegExp(`[${parts.find((d) => d.type === 'group').value}]`, 'g')" } ] } ], "exports": [ { "kind": "js", "name": "NumberParser", "declaration": { "name": "NumberParser", "module": "src/formatters/localeNumberParser.ts" } } ] }, { "kind": "javascript-module", "path": "src/formatters/number.ts", "declarations": [ { "kind": "function", "name": "getNumberFormatter", "parameters": [ { "name": "format", "type": { "text": "string" } }, { "name": "locale", "optional": true, "type": { "text": "string | null" } } ], "privacy": "public" } ], "exports": [ { "kind": "js", "name": "getNumberFormatter", "declaration": { "name": "getNumberFormatter", "module": "src/formatters/number.ts" } } ] }, { "kind": "javascript-module", "path": "src/inactivity/inactivity-dialog.ts", "declarations": [ { "kind": "class", "description": "", "name": "InactivityDialog", "members": [ { "kind": "field", "name": "isVisible", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "remainingSeconds", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "onContinue", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "onLogout", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "countdownInterval", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "startTime", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "totalSeconds", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "method", "name": "configure", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "type": { "text": "InactivityDialogOptions" } } ] }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "startCountdown", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "stopCountdown", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleContinue", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleLogout", "privacy": "public", "return": { "type": { "text": "void" } } } ], "superclass": { "name": "FASTElement", "package": "@microsoft/fast-element" }, "tagName": "inactivity-dialog", "customElement": true } ], "exports": [ { "kind": "js", "name": "InactivityDialog", "declaration": { "name": "InactivityDialog", "module": "src/inactivity/inactivity-dialog.ts" } }, { "kind": "custom-element-definition", "name": "inactivity-dialog", "declaration": { "name": "InactivityDialog", "module": "src/inactivity/inactivity-dialog.ts" } } ] }, { "kind": "javascript-module", "path": "src/inactivity/inactivity-manager.ts", "declarations": [ { "kind": "class", "description": "", "name": "InactivityManager", "members": [ { "kind": "field", "name": "service", "type": { "text": "InactivityService" }, "privacy": "private", "default": "new InactivityService({\n timeoutMinutes: config.timeoutMinutes,\n warningMinutes: config.warningMinutes,\n })" }, { "kind": "field", "name": "dialog", "type": { "text": "InactivityDialog | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "config", "type": { "text": "InactivityManagerConfig" }, "privacy": "private", "default": "config" }, { "kind": "field", "name": "isDialogVisible", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "setupEventListeners", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "showWarningDialog", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "remainingSeconds", "type": { "text": "number" } } ] }, { "kind": "method", "name": "hideWarningDialog", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleContinue", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleLogout", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleTimeout", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "start", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "stop", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "reset", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "destroy", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getService", "privacy": "public", "return": { "type": { "text": "InactivityService" } } }, { "kind": "method", "name": "isWarningVisible", "privacy": "public", "return": { "type": { "text": "boolean" } } } ] } ], "exports": [ { "kind": "js", "name": "InactivityManager", "declaration": { "name": "InactivityManager", "module": "src/inactivity/inactivity-manager.ts" } } ] }, { "kind": "javascript-module", "path": "src/inactivity/inactivity-service.ts", "declarations": [ { "kind": "class", "description": "", "name": "InactivityService", "members": [ { "kind": "field", "name": "config", "type": { "text": "InactivityConfig" }, "privacy": "private", "default": "config" }, { "kind": "field", "name": "warningId", "type": { "text": "number | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "timeoutId", "type": { "text": "number | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "lastActivity", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "isActive", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "eventListeners", "type": { "text": "Map" }, "privacy": "private", "default": "new Map()" }, { "kind": "method", "name": "setupActivityListeners", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "checkTimeout", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "on", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "EventListener" } } ] }, { "kind": "method", "name": "off", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "EventListener" } } ] }, { "kind": "method", "name": "emit", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "K" } }, { "name": "data", "optional": true, "type": { "text": "InactivityEvents[K]" } } ] }, { "kind": "method", "name": "start", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "stop", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "resetTimer", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "scheduleTimers", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "clearTimers", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "destroy", "privacy": "public", "return": { "type": { "text": "void" } } } ] } ], "exports": [ { "kind": "js", "name": "InactivityService", "declaration": { "name": "InactivityService", "module": "src/inactivity/inactivity-service.ts" } } ] }, { "kind": "javascript-module", "path": "src/inactivity/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./inactivity-dialog" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./inactivity-manager" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./inactivity-service" } } ] }, { "kind": "javascript-module", "path": "src/logger/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./logger" } } ] }, { "kind": "javascript-module", "path": "src/logger/logger.ts", "declarations": [ { "kind": "variable", "name": "defaultLoggerOptions", "type": { "text": "LoggerOptions" }, "default": "{\n level: logLevelDebug,\n}", "description": "The default logger options.", "privacy": "public" }, { "kind": "function", "name": "createLogger", "return": { "type": { "text": "" } }, "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "The name to give the logger." }, { "name": "options", "default": "defaultLoggerOptions", "type": { "text": "LoggerOptions" }, "description": "The options to use when creating the logger." } ], "description": "Creates a logger with the given name and options.", "deprecated": "- Use `createLogger` from `@genesislcap/foundation-logger` instead.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "LogLevel", "declaration": { "name": "LogLevel", "package": "@genesislcap/foundation-logger" } }, { "kind": "js", "name": "defaultLoggerOptions", "declaration": { "name": "defaultLoggerOptions", "module": "src/logger/logger.ts" } }, { "kind": "js", "name": "createLogger", "declaration": { "name": "createLogger", "module": "src/logger/logger.ts" } } ] }, { "kind": "javascript-module", "path": "src/mappers/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./dto" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./genesis-json-schema" } } ] }, { "kind": "javascript-module", "path": "src/mixins/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./pendingState" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./lifecycle" } } ] }, { "kind": "javascript-module", "path": "src/observer/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./observer" } } ] }, { "kind": "javascript-module", "path": "src/observer/observer.ts", "declarations": [ { "kind": "function", "name": "createObserver", "return": { "type": { "text": "Observer" } }, "description": "Creates a new event observer instance.", "privacy": "public" }, { "kind": "function", "name": "respondToVisibility", "return": { "type": { "text": "" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" }, "description": "HTMLElement to observe" }, { "name": "callback", "type": { "text": "(arg0: boolean) => any" }, "description": "any function called when the visibility changes" } ], "description": "Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "createObserver", "declaration": { "name": "createObserver", "module": "src/observer/observer.ts" } }, { "kind": "js", "name": "respondToVisibility", "declaration": { "name": "respondToVisibility", "module": "src/observer/observer.ts" } } ] }, { "kind": "javascript-module", "path": "src/promise/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./resolveAfter" } } ] }, { "kind": "javascript-module", "path": "src/promise/resolveAfter.ts", "declarations": [ { "kind": "function", "name": "resolveAfter", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "ms", "type": { "text": "number" } }, { "name": "valueCreator", "type": { "text": "() => T" } } ], "description": "Resolve a promise after a timeout.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "resolveAfter", "declaration": { "name": "resolveAfter", "module": "src/promise/resolveAfter.ts" } } ] }, { "kind": "javascript-module", "path": "src/resource/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./types" } } ] }, { "kind": "javascript-module", "path": "src/resource/types.ts", "declarations": [ { "kind": "variable", "name": "ResourceType", "type": { "text": "{\n local: 'local',\n remote: 'remote',\n}" }, "default": "{\n local: 'local',\n remote: 'remote',\n}", "description": "An object that defines two resource types: \"local\" and \"remote\".", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "ResourceType", "declaration": { "name": "ResourceType", "module": "src/resource/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/route/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./route" } } ] }, { "kind": "javascript-module", "path": "src/route/route.ts", "declarations": [ { "kind": "class", "description": "A singleton utility to observe and notify about route changes.\nIt uses both polling and popstate events to detect changes.", "name": "RouteUtil", "members": [ { "kind": "field", "name": "pathName", "type": { "text": "string" }, "description": "The current pathname of the window location." }, { "kind": "field", "name": "routeCheckInterval", "type": { "text": "number | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "instance", "type": { "text": "RouteUtil" }, "privacy": "private", "static": true }, { "kind": "field", "name": "shared", "type": { "text": "RouteUtil" }, "privacy": "public", "static": true, "description": "Gets the singleton instance of RouteUtil.", "readonly": true }, { "kind": "method", "name": "initializeRouteDetection", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Initialize framework-agnostic route detection" }, { "kind": "method", "name": "handleRouteChange", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Handle route changes by updating the pathName observable" }, { "kind": "method", "name": "destroy", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Clean up route detection listeners and polling." } ] } ], "exports": [ { "kind": "js", "name": "RouteUtil", "declaration": { "name": "RouteUtil", "module": "src/route/route.ts" } } ] }, { "kind": "javascript-module", "path": "src/serializers/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./json" } } ] }, { "kind": "javascript-module", "path": "src/shortcut-manager/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./shortcut-manager" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./shortcut-listener" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./shortcut-events" } } ] }, { "kind": "javascript-module", "path": "src/shortcut-manager/shortcut-events.ts", "declarations": [ { "kind": "variable", "name": "SHORTCUT_BLOCKED_EVENT", "type": { "text": "string" }, "default": "'foundation-shortcut-blocked'" }, { "kind": "variable", "name": "SHORTCUT_BLOCKED_DEFAULT_TITLE", "type": { "text": "string" }, "default": "'Shortcut blocked'" }, { "kind": "variable", "name": "SHORTCUT_BLOCKED_DEFAULT_MESSAGE", "type": { "text": "string" }, "default": "'This shortcut is currently unavailable in this context.'" }, { "kind": "variable", "name": "SHORTCUT_BLOCKED_INPUT_MESSAGE", "type": { "text": "string" }, "default": "'This shortcut is unavailable while typing in an input field.'" }, { "kind": "variable", "name": "SHORTCUT_BLOCKED_PAUSED_MESSAGE", "type": { "text": "string" }, "default": "'Shortcuts are paused.'" }, { "kind": "variable", "name": "SHORTCUT_BLOCKED_ELEMENT_FOCUS_MESSAGE", "type": { "text": "string" }, "default": "'This shortcut is unavailable in the current focus context.'" }, { "kind": "function", "name": "emitShortcutBlockedEvent", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "detail", "type": { "text": "Omit & {\n blockedMessage?: ShortcutBlockedMessage;\n }" } }, { "name": "target", "optional": true, "type": { "text": "EventTarget | null" } } ] } ], "exports": [ { "kind": "js", "name": "SHORTCUT_BLOCKED_EVENT", "declaration": { "name": "SHORTCUT_BLOCKED_EVENT", "module": "src/shortcut-manager/shortcut-events.ts" } }, { "kind": "js", "name": "SHORTCUT_BLOCKED_DEFAULT_TITLE", "declaration": { "name": "SHORTCUT_BLOCKED_DEFAULT_TITLE", "module": "src/shortcut-manager/shortcut-events.ts" } }, { "kind": "js", "name": "SHORTCUT_BLOCKED_DEFAULT_MESSAGE", "declaration": { "name": "SHORTCUT_BLOCKED_DEFAULT_MESSAGE", "module": "src/shortcut-manager/shortcut-events.ts" } }, { "kind": "js", "name": "SHORTCUT_BLOCKED_INPUT_MESSAGE", "declaration": { "name": "SHORTCUT_BLOCKED_INPUT_MESSAGE", "module": "src/shortcut-manager/shortcut-events.ts" } }, { "kind": "js", "name": "SHORTCUT_BLOCKED_PAUSED_MESSAGE", "declaration": { "name": "SHORTCUT_BLOCKED_PAUSED_MESSAGE", "module": "src/shortcut-manager/shortcut-events.ts" } }, { "kind": "js", "name": "SHORTCUT_BLOCKED_ELEMENT_FOCUS_MESSAGE", "declaration": { "name": "SHORTCUT_BLOCKED_ELEMENT_FOCUS_MESSAGE", "module": "src/shortcut-manager/shortcut-events.ts" } }, { "kind": "js", "name": "emitShortcutBlockedEvent", "declaration": { "name": "emitShortcutBlockedEvent", "module": "src/shortcut-manager/shortcut-events.ts" } } ] }, { "kind": "javascript-module", "path": "src/shortcut-manager/shortcut-listener.ts", "declarations": [ { "kind": "class", "description": "A custom element that listens for keyboard shortcuts.", "name": "FoundationShortcutListener", "members": [ { "kind": "field", "name": "shortcutManager", "type": { "text": "ShortcutManager" } }, { "kind": "field", "name": "keyListener", "type": { "text": "((event: KeyboardEvent) => void) | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "isListening", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "addKeyListener", "privacy": "private" }, { "kind": "method", "name": "removeKeyListener", "privacy": "private" }, { "kind": "method", "name": "handleKeyDown", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "extractKeyFromCode", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "code", "type": { "text": "string" } } ] }, { "kind": "method", "name": "getDeepActiveElement", "privacy": "private", "return": { "type": { "text": "Element | null" } } }, { "kind": "method", "name": "getEventElement", "privacy": "private", "return": { "type": { "text": "Element | null" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "isEditableContext", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } }, { "name": "editableSelector", "type": { "text": "string" } } ] }, { "kind": "method", "name": "isInputElement", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement | null" } }, { "name": "editableSelector", "type": { "text": "string" } } ] } ], "superclass": { "name": "FASTElement", "package": "@microsoft/fast-element" }, "tagName": "foundation-shortcut-listener", "customElement": true } ], "exports": [ { "kind": "js", "name": "FoundationShortcutListener", "declaration": { "name": "FoundationShortcutListener", "module": "src/shortcut-manager/shortcut-listener.ts" } }, { "kind": "custom-element-definition", "name": "foundation-shortcut-listener", "declaration": { "name": "FoundationShortcutListener", "module": "src/shortcut-manager/shortcut-listener.ts" } } ] }, { "kind": "javascript-module", "path": "src/shortcut-manager/shortcut-manager.ts", "declarations": [ { "kind": "class", "description": "Default implementation of the ShortcutManager interface", "name": "DefaultShortcutManager", "members": [ { "kind": "field", "name": "shortcuts", "privacy": "private", "default": "new Map>()" }, { "kind": "field", "name": "shortcutLookup", "privacy": "private", "default": "new Map()" }, { "kind": "field", "name": "keyCombinationMap", "privacy": "private", "default": "new Map>()" }, { "kind": "field", "name": "_isPausedSubject", "privacy": "private", "default": "new BehaviorSubject(false)" }, { "kind": "field", "name": "_activeContext", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "executionGuards", "privacy": "private", "default": "new Map ShortcutExecutionStatus | boolean>()" }, { "kind": "field", "name": "editableContextConfig", "type": { "text": "Required" }, "privacy": "private", "default": "{\n ...DEFAULT_SHORTCUT_EDITABLE_CONTEXT_CONFIG,\n }" }, { "kind": "field", "name": "editableSelector", "privacy": "private" }, { "kind": "field", "name": "blockedMessageConfig", "type": { "text": "Required" }, "privacy": "private", "default": "{\n ...DEFAULT_SHORTCUT_BLOCKED_MESSAGE_CONFIG,\n }" }, { "kind": "field", "name": "isPaused", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "isPaused$", "type": { "text": "Observable" }, "readonly": true }, { "kind": "field", "name": "isPausedSubject", "type": { "text": "BehaviorSubject" }, "readonly": true }, { "kind": "method", "name": "registerShortcuts", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "shortcuts", "type": { "text": "ShortcutDefinition[]" } } ] }, { "kind": "method", "name": "registerShortcut", "return": { "type": { "text": "ShortcutRegistrationResult" } }, "parameters": [ { "name": "shortcut", "type": { "text": "ShortcutDefinition" } } ] }, { "kind": "method", "name": "unregisterShortcut", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "context", "type": { "text": "string" } }, { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "unregisterShortcutsByContext", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "context", "type": { "text": "string" } } ] }, { "kind": "method", "name": "executeShortcut", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "id", "type": { "text": "string" } }, { "name": "eventTarget", "optional": true, "type": { "text": "EventTarget | null" } } ] }, { "kind": "method", "name": "shouldEmitBlockedEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "shortcut", "optional": true, "type": { "text": "ShortcutDefinition" } } ] }, { "kind": "method", "name": "resolveBlockedMessage", "privacy": "private", "return": { "type": { "text": "ShortcutBlockedMessage" } }, "parameters": [ { "name": "shortcut", "type": { "text": "ShortcutDefinition | undefined" } }, { "name": "fallback", "type": { "text": "ShortcutBlockedMessage" } } ] }, { "kind": "method", "name": "executeShortcutByContext", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "context", "type": { "text": "string" } }, { "name": "id", "type": { "text": "string" } }, { "name": "eventTarget", "optional": true, "type": { "text": "EventTarget | null" } } ] }, { "kind": "method", "name": "getShortcuts", "return": { "type": { "text": "ShortcutDefinition[]" } } }, { "kind": "method", "name": "getShortcutsByContext", "return": { "type": { "text": "ShortcutDefinition[]" } }, "parameters": [ { "name": "context", "type": { "text": "string" } } ] }, { "kind": "method", "name": "findShortcutByKeyCombination", "return": { "type": { "text": "ShortcutDefinition | undefined" } }, "parameters": [ { "name": "key", "type": { "text": "string" } }, { "name": "ctrlKey", "default": "false" }, { "name": "altKey", "default": "false" }, { "name": "shiftKey", "default": "false" }, { "name": "metaKey", "default": "false" } ] }, { "kind": "method", "name": "getContexts", "return": { "type": { "text": "string[]" } } }, { "kind": "method", "name": "getShortcutsByContextMap", "return": { "type": { "text": "Map>" } } }, { "kind": "method", "name": "registerContext", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "context", "type": { "text": "string" } } ] }, { "kind": "method", "name": "setActiveContext", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "context", "type": { "text": "string" } } ] }, { "kind": "method", "name": "getActiveContext", "return": { "type": { "text": "string | undefined" } } }, { "kind": "method", "name": "clearActiveContext", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "registerExecutionGuard", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "id", "type": { "text": "string" } }, { "name": "guard", "type": { "text": "() => ShortcutExecutionStatus | boolean" } } ] }, { "kind": "method", "name": "unregisterExecutionGuard", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "clearExecutionGuards", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureEditableContext", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "config", "default": "{}", "type": { "text": "ShortcutEditableContextConfig" } } ] }, { "kind": "method", "name": "getEditableContextConfig", "return": { "type": { "text": "Required" } } }, { "kind": "method", "name": "getEditableSelector", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "configureBlockedMessages", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "config", "default": "{}", "type": { "text": "ShortcutBlockedMessageConfig" } } ] }, { "kind": "method", "name": "getBlockedMessages", "return": { "type": { "text": "Required" } } }, { "kind": "method", "name": "pause", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "resume", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "normalizeShortcutDefinition", "privacy": "private", "return": { "type": { "text": "ShortcutDefinition" } }, "parameters": [ { "name": "shortcut", "type": { "text": "ShortcutDefinition" } } ], "description": "Normalizes a shortcut definition to handle option/alt equivalence\nIf optionKey is set, altKey will also be set to true (and vice versa)" }, { "kind": "method", "name": "createKeyCombinationKey", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "key", "type": { "text": "string" } }, { "name": "ctrlKey", "default": "false" }, { "name": "altKey", "default": "false" }, { "name": "shiftKey", "default": "false" }, { "name": "metaKey", "default": "false" } ] }, { "kind": "method", "name": "isElementFocused", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "getExecutionStatus", "privacy": "private", "return": { "type": { "text": "ShortcutExecutionStatus" } }, "parameters": [ { "name": "shortcut", "type": { "text": "ShortcutDefinition" } } ] }, { "kind": "method", "name": "getExecutionGuardStatus", "privacy": "private", "return": { "type": { "text": "ShortcutExecutionStatus" } } }, { "kind": "method", "name": "refreshEditableSelector", "privacy": "private", "return": { "type": { "text": "void" } } } ] }, { "kind": "variable", "name": "ShortcutManager", "description": "A dependency injection token for the ShortcutManager interface.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "DefaultShortcutManager", "declaration": { "name": "DefaultShortcutManager", "module": "src/shortcut-manager/shortcut-manager.ts" } }, { "kind": "js", "name": "ShortcutManager", "declaration": { "name": "ShortcutManager", "module": "src/shortcut-manager/shortcut-manager.ts" } } ] }, { "kind": "javascript-module", "path": "src/state/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./reactive" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./visitor" } } ] }, { "kind": "javascript-module", "path": "src/state/reactive.ts", "declarations": [ { "kind": "function", "name": "reactive", "return": { "type": { "text": "" } }, "parameters": [ { "name": "object", "type": { "text": "T" }, "description": "The object to make reactive." }, { "name": "deep", "default": "false", "description": "Indicates whether to deeply convert the object." } ], "description": "Converts a plain object to a reactive, observable object." } ], "exports": [ { "kind": "js", "name": "reactive", "declaration": { "name": "reactive", "module": "src/state/reactive.ts" } } ] }, { "kind": "javascript-module", "path": "src/state/visitor.ts", "declarations": [ { "kind": "function", "name": "visitObject", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "object", "type": { "text": "any" }, "description": "The object." }, { "name": "deep", "type": { "text": "boolean" }, "description": "A flag to indicate if a recursive visit of sub objects should occur." }, { "name": "visitor", "type": { "text": "ObjectVisitor" }, "description": "The defined {@link ObjectVisitor}logic.\n * " }, { "name": "data", "type": { "text": "TVisitorData" }, "description": "Visitor data." }, { "name": "traversed", "type": { "text": "WeakSet | Set" }, "description": "The traversed object set." } ], "description": "Visit object utility." } ], "exports": [ { "kind": "js", "name": "visitObject", "declaration": { "name": "visitObject", "module": "src/state/visitor.ts" } } ] }, { "kind": "javascript-module", "path": "src/styles/color.ts", "declarations": [ { "kind": "variable", "name": "activeColorScheme", "description": "A design token that represents the active color scheme (light or dark).", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "activeColorScheme", "declaration": { "name": "activeColorScheme", "module": "src/styles/color.ts" } } ] }, { "kind": "javascript-module", "path": "src/styles/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./color" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./slotted-styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./typography" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./toElementStyles" } } ] }, { "kind": "javascript-module", "path": "src/styles/slotted-styles.ts", "declarations": [ { "kind": "class", "description": "A custom element that encapsulates a set of styles that can be applied to slotted elements.", "name": "SlottedStyles", "members": [ { "kind": "field", "name": "styles", "type": { "text": "ElementStyles" }, "description": "The styles to apply to slotted elements." }, { "kind": "method", "name": "stylesChanged", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prev", "type": { "text": "ElementStyles" }, "description": "The previous value of the `styles` property." }, { "name": "next", "type": { "text": "ElementStyles" }, "description": "The new value of the `styles` property." } ], "description": "Called when the `styles` property changes.\nRemoves the previous styles from the parent element's FAST controller and adds the new styles." } ], "superclass": { "name": "FASTElement", "package": "@microsoft/fast-element" }, "tagName": "slotted-styles", "customElement": true } ], "exports": [ { "kind": "js", "name": "SlottedStyles", "declaration": { "name": "SlottedStyles", "module": "src/styles/slotted-styles.ts" } }, { "kind": "custom-element-definition", "name": "slotted-styles", "declaration": { "name": "SlottedStyles", "module": "src/styles/slotted-styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/styles/toElementStyles.ts", "declarations": [ { "kind": "function", "name": "toElementStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "styles", "type": { "text": "ComposableStyles | ComposableStyles[]" }, "description": "ComposableStyles or a ComposableStyles array." } ], "description": "toElementStyles.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "toElementStyles", "declaration": { "name": "toElementStyles", "module": "src/styles/toElementStyles.ts" } } ] }, { "kind": "javascript-module", "path": "src/styles/typography.ts", "declarations": [ { "kind": "function", "name": "loadFontFaces", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "fontFaceRules", "type": { "text": "string" }, "description": "The CSS rules for the font faces." }, { "name": "styleElementId", "type": { "text": "string" }, "description": "The ID of the style element to insert into the document." } ], "description": "Loads font faces by inserting a style element with the specified font face rules into the document.", "privacy": "public" }, { "kind": "function", "name": "getFontMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "family", "type": { "text": "string" }, "description": "The font family." }, { "name": "style", "default": "FontStyle.Normal", "type": { "text": "FontStyle" }, "description": "Optional. The font style. Defaults to FontStyle.Normal." }, { "name": "weight", "default": "FontWeight.Regular", "type": { "text": "FontWeight" }, "description": "Optional. The font weight. Defaults to FontWeight.Regular." } ], "description": "Generates a CSS mixin for the specified font family, style, and weight.", "privacy": "public" }, { "kind": "variable", "name": "TypeRampValues", "type": { "text": "{\n minusOne: -1,\n minusTwo: -2,\n plusOne: 1,\n plusTwo: 2,\n plusThree: 3,\n plusFour: 4,\n plusFive: 5,\n plusSix: 6,\n}" }, "default": "{\n minusOne: -1,\n minusTwo: -2,\n plusOne: 1,\n plusTwo: 2,\n plusThree: 3,\n plusFour: 4,\n plusFive: 5,\n plusSix: 6,\n}", "description": "An object containing type ramp values.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "loadFontFaces", "declaration": { "name": "loadFontFaces", "module": "src/styles/typography.ts" } }, { "kind": "js", "name": "getFontMixin", "declaration": { "name": "getFontMixin", "module": "src/styles/typography.ts" } }, { "kind": "js", "name": "TypeRampValues", "declaration": { "name": "TypeRampValues", "module": "src/styles/typography.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/deepMerge.ts", "declarations": [ { "kind": "function", "name": "deepMerge", "return": { "type": { "text": "" } }, "parameters": [ { "name": "target", "type": { "text": "T" }, "description": "The target object to merge into (defaults/base values)" }, { "name": "source", "type": { "text": "Partial" }, "description": "The source object to merge from (overrides)" } ], "description": "Deep merges two objects, with source values taking precedence over target values.\nArrays are replaced (not merged), and null/undefined values in source are preserved.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "deepMerge", "declaration": { "name": "deepMerge", "module": "src/utils/deepMerge.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/delay.ts", "declarations": [ { "kind": "function", "name": "delay", "return": { "type": { "text": "" } }, "parameters": [ { "name": "ms", "type": { "text": "number" }, "description": "The number of milliseconds to delay" } ], "description": "Delay for a given number of milliseconds", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "delay", "declaration": { "name": "delay", "module": "src/utils/delay.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/dom.ts", "declarations": [ { "kind": "function", "name": "insertDocumentCSSRule", "return": { "type": { "text": "" } }, "parameters": [ { "name": "cssRule", "type": { "text": "string" }, "description": "The CSS rule to insert." }, { "name": "styleElementId", "type": { "text": "string" }, "description": "The ID of the style element to use or create." } ], "description": "Inserts a CSS rule into the document by creating a new style element or using an existing one with the specified ID.\nReturns a function that can be called to remove the rule from the document.", "privacy": "public" }, { "kind": "function", "name": "insertDocumentLink", "parameters": [ { "name": "href", "type": { "text": "string" }, "description": "The URL of the CSS file to insert." } ], "description": "Inserts a CSS link into the document if it doesn't already exist.", "privacy": "public" }, { "kind": "function", "name": "getAllElements", "return": { "type": { "text": "Element[]" } }, "parameters": [ { "name": "root", "type": { "text": "Element | Document" } } ], "description": "Recursively gather all elements including those in shadow DOM", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "insertDocumentCSSRule", "declaration": { "name": "insertDocumentCSSRule", "module": "src/utils/dom.ts" } }, { "kind": "js", "name": "insertDocumentLink", "declaration": { "name": "insertDocumentLink", "module": "src/utils/dom.ts" } }, { "kind": "js", "name": "getAllElements", "declaration": { "name": "getAllElements", "module": "src/utils/dom.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./deepMerge" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./delay" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./dom" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./logger" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./noop" } } ] }, { "kind": "javascript-module", "path": "src/utils/logger.ts", "declarations": [ { "kind": "variable", "name": "logger", "description": "Logger for the foundation-utils package", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "logger", "declaration": { "name": "logger", "module": "src/utils/logger.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/noop.ts", "declarations": [ { "kind": "function", "name": "noop", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "fn", "optional": true, "type": { "text": "() => void" } }, { "description": "An optional function to execute for its side effects.", "name": "callback" } ], "description": "A no-operation function that executes an optional callback.\n\nThis is a lower-level utility function. For preventing tree-shaking of custom elements,\nprefer using avoidTreeShaking which provides a more explicit API.", "privacy": "public" }, { "kind": "function", "name": "avoidTreeShaking", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "classes", "type": { "text": "unknown[]" }, "description": "One or more custom element classes that should not be tree-shaken." } ], "description": "Explicitly prevents tree-shaking of custom element classes by referencing them.\n\nBundlers may incorrectly remove code that it thinks has no side effects,\nsuch as custom element definitions that are only referenced in templates.\nBy passing these classes to `avoidTreeShaking`, we create a side effect\nthat signals to the bundler to preserve the code.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "noop", "declaration": { "name": "noop", "module": "src/utils/noop.ts" } }, { "kind": "js", "name": "avoidTreeShaking", "declaration": { "name": "avoidTreeShaking", "module": "src/utils/noop.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/os-platform.ts", "declarations": [ { "kind": "class", "description": "Platform detection utilities for cross-platform compatibility", "name": "OperatingSystemUtils", "members": [ { "kind": "field", "name": "isMacOS", "type": { "text": "boolean" }, "static": true, "description": "Detects if the current platform is macOS", "readonly": true }, { "kind": "field", "name": "isWindows", "type": { "text": "boolean" }, "static": true, "description": "Detects if the current platform is Windows", "readonly": true }, { "kind": "field", "name": "isLinux", "type": { "text": "boolean" }, "static": true, "description": "Detects if the current platform is Linux", "readonly": true }, { "kind": "method", "name": "getModifierSymbols", "static": true, "return": { "type": { "text": "{\n ctrl: string;\n alt: string;\n shift: string;\n meta: string;\n }" } }, "description": "Gets the appropriate modifier key symbols for the current platform" }, { "kind": "method", "name": "formatKeyCombination", "static": true, "return": { "type": { "text": "string" } }, "parameters": [ { "name": "key", "type": { "text": "string" } }, { "name": "ctrlKey", "default": "false" }, { "name": "altKey", "default": "false" }, { "name": "shiftKey", "default": "false" }, { "name": "metaKey", "default": "false" } ], "description": "Formats a key combination with platform-appropriate symbols" } ] } ], "exports": [ { "kind": "js", "name": "OperatingSystemUtils", "declaration": { "name": "OperatingSystemUtils", "module": "src/utils/os-platform.ts" } } ] }, { "kind": "javascript-module", "path": "src/uuid/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./uuid" } } ] }, { "kind": "javascript-module", "path": "src/uuid/uuid.ts", "declarations": [ { "kind": "variable", "name": "UUID", "description": "A dependency injection token for the UUID interface.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "UUID", "declaration": { "name": "UUID", "module": "src/uuid/uuid.ts" } } ] }, { "kind": "javascript-module", "path": "src/window/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./window" } } ] }, { "kind": "javascript-module", "path": "src/window/window.ts", "declarations": [ { "kind": "function", "name": "inIFrame", "return": { "type": { "text": "" } }, "description": "Returns a boolean value indicating whether the current window is inside an iframe.", "privacy": "public" }, { "kind": "function", "name": "inSymphonyDesktop", "return": { "type": { "text": "" } }, "description": "Returns a boolean value indicating whether the user is running the Symphony desktop app.", "privacy": "public" }, { "kind": "variable", "name": "POPUP_DEFAULT_WIDTH", "type": { "text": "number" }, "default": "483", "description": "The default width (in pixels) for pop-up windows.", "privacy": "public" }, { "kind": "variable", "name": "POPUP_DEFAULT_HEIGHT", "type": { "text": "number" }, "default": "600", "description": "The default height (in pixels) for pop-up windows.", "privacy": "public" }, { "kind": "function", "name": "openPopup", "return": { "type": { "text": "" } }, "parameters": [ { "name": "urlNavigate", "type": { "text": "string" }, "description": "The URL to navigate to." }, { "name": "target", "type": { "text": "string" }, "description": "The name of the new window." }, { "name": "popUpWidth", "default": "POPUP_DEFAULT_WIDTH", "type": { "text": "number" }, "description": "The width of the new window (optional)." }, { "name": "popUpHeight", "default": "POPUP_DEFAULT_HEIGHT", "type": { "text": "number" }, "description": "The height of the new window (optional)." } ], "description": "Opens a new browser window with the specified URL, target, width, and height.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "inIFrame", "declaration": { "name": "inIFrame", "module": "src/window/window.ts" } }, { "kind": "js", "name": "inSymphonyDesktop", "declaration": { "name": "inSymphonyDesktop", "module": "src/window/window.ts" } }, { "kind": "js", "name": "POPUP_DEFAULT_WIDTH", "declaration": { "name": "POPUP_DEFAULT_WIDTH", "module": "src/window/window.ts" } }, { "kind": "js", "name": "POPUP_DEFAULT_HEIGHT", "declaration": { "name": "POPUP_DEFAULT_HEIGHT", "module": "src/window/window.ts" } }, { "kind": "js", "name": "openPopup", "declaration": { "name": "openPopup", "module": "src/window/window.ts" } } ] }, { "kind": "javascript-module", "path": "src/directives/sync/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./sync" } } ] }, { "kind": "javascript-module", "path": "src/directives/sync/sync.ts", "declarations": [ { "kind": "variable", "name": "defaultEventMap", "type": { "text": "Map" }, "default": "new Map([\n ['FAST-TEXT-AREA', 'input'],\n ['FAST-TEXT-FIELD', 'input'],\n ['FOUNDATION-TEXT-AREA', 'input'],\n ['FOUNDATION-TEXT-FIELD', 'input'],\n ['INPUT', 'input'],\n ['ZERO-TEXT-FIELD', 'input'],\n])", "description": "A map that associates specific HTML element tags with their corresponding default event names.", "privacy": "public" }, { "kind": "function", "name": "sync", "return": { "type": { "text": "CaptureType" } }, "parameters": [ { "name": "binding", "type": { "text": "Binding" } }, { "name": "conversionType", "default": "'string'", "type": { "text": "ConversionType" } }, { "name": "eventName", "default": "'default'", "type": { "text": "EventName" } }, { "name": "keyAttr", "optional": true, "type": { "text": "string" } } ], "description": "Creates a synchronization directive that binds a data source to an HTML element,", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "defaultEventMap", "declaration": { "name": "defaultEventMap", "module": "src/directives/sync/sync.ts" } }, { "kind": "js", "name": "sync", "declaration": { "name": "sync", "module": "src/directives/sync/sync.ts" } } ] }, { "kind": "javascript-module", "path": "src/directives/when-else/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./when-else" } } ] }, { "kind": "javascript-module", "path": "src/directives/when-else/when-else.ts", "declarations": [ { "kind": "function", "name": "whenElse", "return": { "type": { "text": "CaptureType" } }, "parameters": [ { "name": "binding", "type": { "text": "Binding" }, "description": "The condition to test for rendering." }, { "name": "trueTemplateOrTemplateBinding", "type": { "text": "WhenTemplate" }, "description": "The template or a binding that gets the template to render when the condition is true." }, { "name": "falseTemplateOrTemplateBinding", "type": { "text": "WhenTemplate" }, "description": "The template or a binding that gets the template to render when the condition is false." } ], "description": "Directive that allows supplying an \"else\" template to the traditional https://www.fast.design/docs/api/fast-element.when/#when-function directive", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "whenElse", "declaration": { "name": "whenElse", "module": "src/directives/when-else/when-else.ts" } } ] }, { "kind": "javascript-module", "path": "src/encoding/base64/decode.ts", "declarations": [ { "kind": "function", "name": "decodeFromBase64", "return": { "type": { "text": "" } }, "parameters": [ { "name": "base64Value", "type": { "text": "string" } }, { "description": "The value to decode from base64.", "name": "value" } ], "description": "Decodes a value from base64.", "privacy": "public" }, { "kind": "function", "name": "decodeFromBase64WithPrefix", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "string" }, "description": "The value to decode from base64." } ], "description": "Decodes a value from base64 with a prefix.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "decodeFromBase64", "declaration": { "name": "decodeFromBase64", "module": "src/encoding/base64/decode.ts" } }, { "kind": "js", "name": "decodeFromBase64WithPrefix", "declaration": { "name": "decodeFromBase64WithPrefix", "module": "src/encoding/base64/decode.ts" } } ] }, { "kind": "javascript-module", "path": "src/encoding/base64/encode.ts", "declarations": [ { "kind": "function", "name": "encodeToBase64", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "string | ArrayBuffer" }, "description": "The value to encode to base64." } ], "description": "Encodes the given value to base64.", "privacy": "public" }, { "kind": "function", "name": "encodeToBase64WithPrefix", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "string | ArrayBuffer" }, "description": "The value to encode to base64." } ], "description": "Encodes the given value with a prefix to base64.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "encodeToBase64", "declaration": { "name": "encodeToBase64", "module": "src/encoding/base64/encode.ts" } }, { "kind": "js", "name": "encodeToBase64WithPrefix", "declaration": { "name": "encodeToBase64WithPrefix", "module": "src/encoding/base64/encode.ts" } } ] }, { "kind": "javascript-module", "path": "src/encoding/base64/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./decode" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./encode" } } ] }, { "kind": "javascript-module", "path": "src/mappers/dto/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./serverRow" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./types" } } ] }, { "kind": "javascript-module", "path": "src/mappers/dto/serverRow.ts", "declarations": [ { "kind": "class", "description": "The default `ServerRowDTOMapper`.", "name": "DefaultServerRowDTOMapper", "members": [ { "kind": "field", "name": "fromDTO", "description": "Converts a server row DTO to an entity.", "parameters": [ { "description": "The DTO to convert.", "name": "dto" } ], "return": { "type": { "text": "" } }, "privacy": "public" }, { "kind": "field", "name": "toDTO", "description": "Converts a server row entity to a DTO.", "parameters": [ { "description": "The entity to convert.", "name": "entity" } ], "return": { "type": { "text": "" } }, "privacy": "public" } ] }, { "kind": "variable", "name": "ServerRowDTOMapper", "description": "A DI token used to obtain a `ServerRowDTOMapper` instance.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "DefaultServerRowDTOMapper", "declaration": { "name": "DefaultServerRowDTOMapper", "module": "src/mappers/dto/serverRow.ts" } }, { "kind": "js", "name": "ServerRowDTOMapper", "declaration": { "name": "ServerRowDTOMapper", "module": "src/mappers/dto/serverRow.ts" } } ] }, { "kind": "javascript-module", "path": "src/mappers/dto/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mappers/genesis-json-schema/index.ts", "declarations": [ { "kind": "function", "name": "mapGenesisJsonSchema", "return": { "type": { "text": "Genesis.JSONSchema7" } }, "parameters": [ { "name": "jsonSchemResponse", "type": { "text": "{\n OUTBOUND: JSONSchema7;\n}" } } ], "description": "Takes in a valid response from `connect.getJsonSchema(resourceName)` and maps it to\na JsonSchema extended with the genesisType metadata for a field", "privacy": "public" }, { "kind": "function", "name": "mapJsonSchemaFieldToExprBuilderField", "return": { "type": { "text": "Types.Field | null" } }, "parameters": [ { "name": "[name, schema]", "type": { "text": "[\n string,\n Genesis.FieldJsonSchema,\n]" } } ], "description": "Maps fields contained in a JSON schema block enhanced with genesisType metadata\nto the field shape required by the expression builder component.\n\nOnly sets the properties that are *required*. Optional properties, such as\n`defaultValue`, must be explicitly set by the user separately.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./types" } }, { "kind": "js", "name": "mapGenesisJsonSchema", "declaration": { "name": "mapGenesisJsonSchema", "module": "src/mappers/genesis-json-schema/index.ts" } }, { "kind": "js", "name": "mapJsonSchemaFieldToExprBuilderField", "declaration": { "name": "mapJsonSchemaFieldToExprBuilderField", "module": "src/mappers/genesis-json-schema/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/mappers/genesis-json-schema/test.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mappers/genesis-json-schema/types.ts", "declarations": [ { "kind": "variable", "name": "genesisFieldTypes", "type": { "text": "[\n 'STRING',\n 'ENUM',\n 'INT',\n 'SHORT',\n 'DOUBLE',\n 'LONG',\n 'BOOLEAN',\n 'BIGDECIMAL',\n 'DATE',\n 'DATETIME',\n 'RAW',\n 'NANO_TIMESTAMP',\n ]" }, "default": "[\n 'STRING',\n 'ENUM',\n 'INT',\n 'SHORT',\n 'DOUBLE',\n 'LONG',\n 'BOOLEAN',\n 'BIGDECIMAL',\n 'DATE',\n 'DATETIME',\n 'RAW',\n 'NANO_TIMESTAMP',\n ]" } ], "exports": [ { "kind": "js", "name": "genesisFieldTypes", "declaration": { "name": "genesisFieldTypes", "module": "src/mappers/genesis-json-schema/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/mixins/lifecycle/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./lifecycle" } } ] }, { "kind": "javascript-module", "path": "src/mixins/lifecycle/lifecycle.ts", "declarations": [ { "kind": "mixin", "description": "", "name": "LifecycleMixin", "members": [ { "kind": "method", "name": "cloneNode", "return": { "type": { "text": "Node" } }, "parameters": [ { "name": "deep", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "deepClone", "return": { "type": { "text": "Node" } } }, { "kind": "field", "name": "shouldRunDisconnect", "return": { "type": { "text": "" } }, "readonly": true }, { "kind": "field", "name": "shouldRunConnect", "return": { "type": { "text": "" } }, "readonly": true }, { "kind": "method", "name": "#_blockLifecycleDueToTokenChange", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "lifecycleType", "type": { "text": "Lifecycletype" } } ] } ], "parameters": [ { "name": "Base", "type": { "text": "T" } } ] }, { "kind": "variable", "name": "layoutCacheDocument", "description": "Stored on the layout's internal cache to signify that the document is not part of the DOM", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "LifecycleMixin", "declaration": { "name": "LifecycleMixin", "module": "src/mixins/lifecycle/lifecycle.ts" } }, { "kind": "js", "name": "layoutCacheDocument", "declaration": { "name": "layoutCacheDocument", "module": "src/mixins/lifecycle/lifecycle.ts" } } ] }, { "kind": "javascript-module", "path": "src/mixins/pendingState/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./pendingState" } } ] }, { "kind": "javascript-module", "path": "src/mixins/pendingState/pendingState.ts", "declarations": [ { "kind": "mixin", "description": "The `PendingState` mixin.", "name": "PendingState", "members": [ { "kind": "field", "name": "pendingCount", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The number of promises that are currently pending." }, { "kind": "field", "name": "resolvedCount", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The number of promises that have been resolved." }, { "kind": "field", "name": "hasPendingChildren", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "A boolean indicating whether there are any pending children." }, { "kind": "field", "name": "progress", "type": { "text": "number" }, "privacy": "public", "description": "Gets the progress of the pending promises as a percentage between 0 and 1.", "readonly": true } ], "parameters": [ { "name": "Base", "type": { "text": "TBase" } } ], "privacy": "public" } ], "exports": [ { "kind": "js", "name": "PendingState", "declaration": { "name": "PendingState", "module": "src/mixins/pendingState/pendingState.ts" } } ] }, { "kind": "javascript-module", "path": "src/serializers/json/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./json" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./json.types" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./jsonReplacer" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./jsonReviver" } } ] }, { "kind": "javascript-module", "path": "src/serializers/json/json.ts", "declarations": [ { "kind": "function", "name": "customNumberParser", "parameters": [ { "name": "value" } ], "description": "A Default Number Parser for deserializing objects.", "privacy": "public" }, { "kind": "variable", "name": "defaultJSONSerializerConfig", "type": { "text": "JSONSerializerConfig" }, "default": "{\n parse: (input: any) => parse(input, null, customNumberParser),\n stringify: (object: any) => stringify(object),\n}", "description": "A Default JSONSerializer Config for serializing and deserializing functions.", "privacy": "public" }, { "kind": "class", "description": "", "name": "DefaultJSONSerializer", "members": [ { "kind": "field", "name": "serialize" }, { "kind": "method", "name": "deserialize", "parameters": [ { "name": "input", "type": { "text": "any" } } ] } ] }, { "kind": "variable", "name": "JSONSerializer", "description": "A DI token for the JSON serializer.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "customNumberParser", "declaration": { "name": "customNumberParser", "module": "src/serializers/json/json.ts" } }, { "kind": "js", "name": "defaultJSONSerializerConfig", "declaration": { "name": "defaultJSONSerializerConfig", "module": "src/serializers/json/json.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "DefaultJSONSerializer", "module": "src/serializers/json/json.ts" } }, { "kind": "js", "name": "JSONSerializer", "declaration": { "name": "JSONSerializer", "module": "src/serializers/json/json.ts" } } ] }, { "kind": "javascript-module", "path": "src/serializers/json/json.types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/serializers/json/jsonReplacer.ts", "declarations": [ { "kind": "function", "name": "JSONReplacer", "return": { "type": { "text": "" } }, "parameters": [ { "name": "key", "type": { "text": "string" }, "description": "The object key." }, { "name": "value", "type": { "text": "any" }, "description": "The key value." } ], "description": "JSON replacer function.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "JSONReplacer", "declaration": { "name": "JSONReplacer", "module": "src/serializers/json/jsonReplacer.ts" } } ] }, { "kind": "javascript-module", "path": "src/serializers/json/jsonReviver.ts", "declarations": [ { "kind": "function", "name": "JSONReviver", "return": { "type": { "text": "" } }, "parameters": [ { "name": "key", "type": { "text": "string" }, "description": "The object key." }, { "name": "value", "type": { "text": "any" }, "description": "The key value." } ], "description": "JSON reviver function.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "JSONReviver", "declaration": { "name": "JSONReviver", "module": "src/serializers/json/jsonReviver.ts" } } ] }, { "kind": "javascript-module", "path": "src/serializers/json/types.ts", "declarations": [], "exports": [] } ] }