@salesforce/lds-runtime-mobile 1.100.2

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2022 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2022, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/dist/DraftQueueFactory.d.ts

@@ -0,0 +1,3 @@
+import type { DraftQueue } from '@salesforce/lds-drafts';
+import type { DurableStore } from '@luvio/environments';
+export declare function buildLdsDraftQueue(durableStore: DurableStore): DraftQueue;

package/dist/NimbusBinaryStore.d.ts

@@ -0,0 +1,2 @@
+import type { BinaryStore } from '@salesforce/lds-store-binary';
+export declare const NimbusBinaryStore: BinaryStore;

package/dist/NimbusDraftQueue.d.ts

@@ -0,0 +1,25 @@
+import type { DraftAction, DraftQueue, ProcessActionResult, DraftQueueState, DraftQueueChangeListener, DraftActionMetadata, ActionHandler, CustomActionExecutor, PendingDraftAction } from '@salesforce/lds-drafts';
+/**
+ * An implementation of the DraftQueue interface which serializes
+ * requests and sends them across the Nimbus bridge and deserializes the result.
+ *
+ * This instance is leveraged in the LMR webview which proxies DraftQueue requests
+ * to a concrete implementation running in jscore.
+ */
+export declare class NimbusDraftQueue implements DraftQueue {
+    enqueue<Response>(handlerId: string, data: unknown): Promise<PendingDraftAction<Response>>;
+    registerOnChangedListener(_listener: DraftQueueChangeListener): () => Promise<void>;
+    processNextAction(): Promise<ProcessActionResult>;
+    getQueueActions(): Promise<DraftAction<unknown, unknown>[]>;
+    getDataForAction<T>(action: DraftAction<T, unknown>): Promise<T | undefined>;
+    getQueueState(): DraftQueueState;
+    removeDraftAction(_actionId: string): Promise<void>;
+    startQueue(): Promise<void>;
+    stopQueue(): Promise<void>;
+    replaceAction(_actionId: string, _withActionId: string): Promise<DraftAction<unknown, unknown>>;
+    mergeAction<Data, Response>(_targetActionId: string, _sourceActionId: string): Promise<DraftAction<Data, Response>>;
+    setMetadata(_actionId: string, _metadata: DraftActionMetadata): Promise<DraftAction<unknown, unknown>>;
+    addHandler(_handler: ActionHandler<unknown, unknown, unknown>): Promise<void>;
+    addCustomHandler(_id: string, _executor: CustomActionExecutor): Promise<void>;
+    removeHandler(_id: string): Promise<void>;
+}

package/dist/RecordIdGenerator.d.ts

@@ -0,0 +1,15 @@
+export declare const recordIdGenerator: (id: string) => {
+    /**
+     * Returns a new record id with the provided prefix
+     */
+    newRecordId: (prefix: string) => string;
+    /**
+     * Returns true if the recordId was generated using this generator; false otherwise
+     */
+    isGenerated: (recordId: string) => boolean;
+    /**
+     * Returns a number value of when the record was generated.
+     * Throws if the recordId passed is invalid or the recordId was not generated.
+     */
+    recordGenerationTime: (recordId: string) => number;
+};

package/dist/__mocks__/@salesforce/i18n/currency.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "USD";
+export default _default;

package/dist/__mocks__/@salesforce/i18n/dateTime.shortDateFormat.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "M/d/yyyy";
+export default _default;

package/dist/__mocks__/@salesforce/i18n/dateTime.shortDateTimeFormat.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "M/d/yyyy, h:mm a";
+export default _default;

package/dist/__mocks__/@salesforce/i18n/dateTime.shortTimeFormat.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "h:mm a";
+export default _default;

package/dist/__mocks__/@salesforce/i18n/locale.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "en-US";
+export default _default;

package/dist/__mocks__/@salesforce/i18n/timeZone.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "America/Los_Angeles";
+export default _default;

package/dist/__mocks__/@salesforce/user/Id.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "005B0000000GR4OIAW";
+export default _default;

package/dist/__mocks__/force/ldsGraphqlParser.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="jest" />
+declare const astResolver: jest.Mock<any, any>;
+export { astResolver };

package/dist/__mocks__/lightning/i18nCldrOptions.d.ts

@@ -0,0 +1,2 @@
+declare function formattingOptions(pattern: String): String;
+export default formattingOptions;

package/dist/__mocks__/lightning/i18nService.d.ts

@@ -0,0 +1,10 @@
+declare function getNumberFormat(): {
+    format: () => string;
+};
+declare function getDateTimeFormat(): {
+    format: (date: number) => string;
+};
+declare function getDateTimeISO8601Parser(): {
+    parse: (input: string) => number | Date;
+};
+export { getNumberFormat, getDateTimeFormat, getDateTimeISO8601Parser };

package/dist/__mocks__/o11y/activity.d.ts

@@ -0,0 +1,2 @@
+import type { Activity } from 'o11y/client';
+export declare const activity: Activity;

package/dist/__mocks__/o11y/client.d.ts

@@ -0,0 +1,5 @@
+import type { Instrumentation } from 'o11y/client';
+export { activity } from './activity';
+export { instrumentation } from './instrumentation';
+export { idleDetector } from './idleDetector';
+export declare function getInstrumentation(_name: string): Instrumentation;

package/dist/__mocks__/o11y/idleDetector.d.ts

@@ -0,0 +1,2 @@
+import type { IdleDetector } from 'o11y/client';
+export declare const idleDetector: IdleDetector;

package/dist/__mocks__/o11y/instrumentation.d.ts

@@ -0,0 +1,15 @@
+import type { Activity, MetricsTags, Schema, SchematizedData } from 'o11y/client';
+declare function log(_schema: Schema, _data?: SchematizedData): void;
+declare function error(_err: Error, _userSchemaOrText?: string, _data?: SchematizedData): void;
+declare function startActivity(_name: string): Activity;
+declare function incrementCounter(_operation: string, _increment?: number, _hasError?: boolean, _tags?: MetricsTags): void;
+declare function trackValue(_operation: string, _value: number, _hasError?: boolean, _tags?: MetricsTags): void;
+export declare const instrumentation: {
+    log: typeof log;
+    error: typeof error;
+    startActivity: typeof startActivity;
+    incrementCounter: typeof incrementCounter;
+    trackValue: typeof trackValue;
+};
+export declare const METRIC_KEYS: {};
+export {};

package/dist/durableStore/NimbusSqliteStore/NimbusSqliteStore.d.ts

@@ -0,0 +1,20 @@
+import type { SqliteResult, SqliteStore, SqliteType } from '@salesforce/lds-store-sql';
+import type { SqliteStorePlugin } from '@salesforce/nimbus-plugin-lds';
+import type { DurableStore, DurableStoreEntries, DurableStoreOperation, OnDurableStoreChangedListener } from '@luvio/environments';
+export declare class NimbusSqliteStore implements SqliteStore, DurableStore {
+    private plugin;
+    private readonly dataTableMap;
+    private readonly internalDataTable;
+    constructor(plugin: SqliteStorePlugin);
+    isEvalSupported(): boolean;
+    query(sql: string, params: SqliteType[]): Promise<SqliteResult>;
+    getEntries<T>(entryIds: string[], segment: string): Promise<DurableStoreEntries<T> | undefined>;
+    getAllEntries<T>(segment: string): Promise<DurableStoreEntries<T> | undefined>;
+    setEntries<T>(entries: DurableStoreEntries<T>, segment: string): Promise<void>;
+    batchOperations<T>(operations: DurableStoreOperation<T>[]): Promise<void>;
+    evictEntries(entryIds: string[], segment: string): Promise<void>;
+    registerOnChangedListener(listener: OnDurableStoreChangedListener): () => Promise<void>;
+    private getTable;
+    private idsToDeleteOperation;
+    private batchOperationAsPromise;
+}

package/dist/durableStore/NimbusSqliteStore/tables/AbstractKeyValueDataTable.d.ts

@@ -0,0 +1,14 @@
+import type { SqliteOperation, SqliteStorePlugin } from '@salesforce/nimbus-plugin-lds';
+import type { DurableStoreEntries } from '@luvio/environments';
+import type { LdsDataTableBase } from '../tables';
+export declare abstract class AbstractKeyValueDataTable implements LdsDataTableBase {
+    readonly tableName: SqliteOperation['table'];
+    readonly plugin: SqliteStorePlugin;
+    private columnNames;
+    private conflictColumnNames;
+    constructor(plugin: SqliteStorePlugin, tableName: SqliteOperation['table']);
+    getByKeys<T>(keys: string[]): Promise<DurableStoreEntries<T>>;
+    getAll<T>(): Promise<DurableStoreEntries<T>>;
+    entriesToUpsertOperations<T>(entries: DurableStoreEntries<T>, segment: string): SqliteOperation;
+    private mapToDurableEntries;
+}

package/dist/durableStore/NimbusSqliteStore/tables/LdsDataTable.d.ts

@@ -0,0 +1,15 @@
+import type { SqliteOperation, SqliteStorePlugin } from '@salesforce/nimbus-plugin-lds';
+import type { DurableStoreEntries } from '@luvio/environments';
+import type { LdsDataTableBase } from '../tables/LdsDataTableBase';
+export declare class LdsDataTable implements LdsDataTableBase {
+    readonly tableName = "lds_data";
+    readonly plugin: SqliteStorePlugin;
+    private columnNames;
+    private conflictColumnNames;
+    private getAllQuery;
+    constructor(plugin: SqliteStorePlugin);
+    getByKeys<T>(keys: string[]): Promise<DurableStoreEntries<T>>;
+    getAll<T>(): Promise<DurableStoreEntries<T>>;
+    entriesToUpsertOperations<T>(entries: DurableStoreEntries<T>, segment: string): SqliteOperation;
+    private mapToDurableEntries;
+}

package/dist/durableStore/NimbusSqliteStore/tables/LdsDataTableBase.d.ts

@@ -0,0 +1,8 @@
+import type { DurableStoreEntries } from '@luvio/environments';
+import type { SqliteOperation } from '@salesforce/nimbus-plugin-lds';
+export interface LdsDataTableBase {
+    tableName: SqliteOperation['table'];
+    getByKeys<T>(keys: string[], segment?: string): Promise<DurableStoreEntries<T>>;
+    getAll<T>(segment?: string): Promise<DurableStoreEntries<T>>;
+    entriesToUpsertOperations<T>(entries: DurableStoreEntries<T>, segment: string): SqliteOperation;
+}

package/dist/durableStore/NimbusSqliteStore/tables/LdsDraftIdMapDataTable.d.ts

@@ -0,0 +1,5 @@
+import type { SqliteStorePlugin } from 'packages/lds-mobile-nimbus-plugins/dist';
+import { AbstractKeyValueDataTable } from './AbstractKeyValueDataTable';
+export declare class LdsDraftIdMapDataTable extends AbstractKeyValueDataTable {
+    constructor(plugin: SqliteStorePlugin);
+}

package/dist/durableStore/NimbusSqliteStore/tables/LdsDraftsDataTable.d.ts

@@ -0,0 +1,5 @@
+import type { SqliteStorePlugin } from 'packages/lds-mobile-nimbus-plugins/dist';
+import { AbstractKeyValueDataTable } from './AbstractKeyValueDataTable';
+export declare class LdsDraftsDataTable extends AbstractKeyValueDataTable {
+    constructor(plugin: SqliteStorePlugin);
+}

package/dist/durableStore/NimbusSqliteStore/tables/LdsInternalDataTable.d.ts

@@ -0,0 +1,15 @@
+import type { SqliteOperation, SqliteStorePlugin } from '@salesforce/nimbus-plugin-lds';
+import type { DurableStoreEntries } from '@luvio/environments';
+import type { LdsDataTableBase } from '../tables';
+export declare class LdsInternalDataTable implements LdsDataTableBase {
+    readonly tableName = "lds_internal";
+    readonly plugin: SqliteStorePlugin;
+    private columnNames;
+    private conflictColumnNames;
+    private getAllQuery;
+    constructor(plugin: SqliteStorePlugin);
+    getByKeys<T>(keys: string[], namespace: string): Promise<DurableStoreEntries<T>>;
+    getAll<T>(namespace: string): Promise<DurableStoreEntries<T>>;
+    entriesToUpsertOperations<T>(entries: DurableStoreEntries<T>, segment: string): SqliteOperation;
+    private mapToDurableEntries;
+}

package/dist/durableStore/NimbusSqliteStore/tables/index.d.ts

@@ -0,0 +1,5 @@
+export { LdsDataTable } from './LdsDataTable';
+export { LdsDraftsDataTable } from './LdsDraftsDataTable';
+export { LdsDraftIdMapDataTable } from './LdsDraftIdMapDataTable';
+export { LdsInternalDataTable } from './LdsInternalDataTable';
+export { LdsDataTableBase } from './LdsDataTableBase';

package/dist/durableStore/NimbusSqliteStore/tables/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function selectColumnsFromTableWhereKeyIn(columnNames: string[], table: string, keyColumnName: string, whereIn: string[]): string;
+export declare function selectColumnsFromTableWhereKeyInNamespaced(columnNames: string[], table: string, keyColumnName: string, whereIn: string[], namespaceColumnName: string): string;

package/dist/durableStore/index.d.ts

@@ -0,0 +1,2 @@
+import type { DurableStore } from '@luvio/environments';
+export declare function getNimbusDurableStore(): DurableStore;

package/dist/durableStore/makeEnvironmentGraphqlAware.d.ts

@@ -0,0 +1,2 @@
+import type { Environment } from '@luvio/engine';
+export declare function makeEnvironmentGraphqlAware(environment: Environment): Environment;

package/dist/environment/enableLazyObjectInfoCaching.d.ts

@@ -0,0 +1,13 @@
+import type { Environment } from '@luvio/engine';
+import type { ObjectInfoRepresentation } from '@salesforce/lds-adapters-uiapi';
+export type EnsureCachedObjectInfoFunction = (apiName: string, objectInfo?: ObjectInfoRepresentation) => Promise<void>;
+/**
+ * This environment observes incoming data for records and object info representations
+ * If the incoming data is a record or object info it extracts the apiName
+ * and calls a provided function which will ensure the associated object info is cached
+ *
+ * @param env base environment
+ * @param ensureObjectInfoCached function to cache the object info if not already cached
+ * @returns configured environment
+ */
+export declare function enableObjectInfoCaching(env: Environment, ensureObjectInfoCached: EnsureCachedObjectInfoFunction): Environment;

package/dist/inspection/setupInspection.d.ts

@@ -0,0 +1,2 @@
+import type { Luvio } from '@luvio/engine';
+export declare function setupInspection(luvio: Luvio): void;

package/dist/instrumentation/instrumentDraftQueue.d.ts

@@ -0,0 +1,2 @@
+import type { DraftQueue } from '@salesforce/lds-drafts';
+export declare function instrumentDraftQueue(queue: DraftQueue): void;

package/dist/instrumentation/instrumentGraphQLEval.d.ts

@@ -0,0 +1,2 @@
+import type { Adapter } from '@luvio/engine';
+export declare function instrumentGraphQLEval<C, D>(adapter: Adapter<C, D>): Adapter<C, D>;

package/dist/instrumentation/instrumentMobileAdapter.d.ts

@@ -0,0 +1,6 @@
+import type { ReportObserver } from '@salesforce/lds-instrumentation';
+import type { Luvio, InMemoryStore } from '@luvio/engine';
+type Unsubscribe = () => void;
+export declare function setupMobileInstrumentation(luvio: Luvio, store: InMemoryStore): void;
+export declare function registerReportObserver(reportObserver: ReportObserver): Unsubscribe;
+export {};

package/dist/instrumentation/instrumentPrimingSession.d.ts

@@ -0,0 +1,2 @@
+import type { PrimingSession } from '@salesforce/lds-priming';
+export declare function instrumentPrimingSession(session: PrimingSession): PrimingSession;

package/dist/instrumentation/instrumentationContentDocumentVersionAdapter.d.ts

@@ -0,0 +1,2 @@
+import type { Adapter } from '@luvio/engine';
+export declare function instrumentContentDocumentVersionAdapter<C, D>(adapter: Adapter<C, D>): Adapter<C, D>;

package/dist/instrumentation/instrumentationUtils.d.ts

@@ -0,0 +1,10 @@
+import type { AdapterRequestContext, LuvioAdapterEventObserver } from '@luvio/engine';
+export declare function attachObserversToAdapterRequestContext(observers: LuvioAdapterEventObserver[], adapterRequestContext?: AdapterRequestContext): AdapterRequestContext;
+/**
+ * Use this method to sanitize the unknown error object when
+ * we are unsure of the type of the error thrown
+ *
+ * @param err Unknown object to sanitize
+ * @returns an instance of error
+ */
+export declare function normalizeError(err: unknown): Error;

package/dist/instrumentation/metrics.d.ts

@@ -0,0 +1,14 @@
+export declare const O11Y_NAMESPACE_LDS_MOBILE = "lds-mobile";
+export declare function reportGraphqlQueryParseError(err: unknown): void;
+export declare function reportGraphqlSqlEvalPreconditionError(err: unknown): void;
+export declare function reportGraphqlCreateSnapshotError(err: unknown): void;
+export declare function reportGraphQlEvalDbReadDuration(duration: number): void;
+export declare function reportGraphqlAdapterError(errorCode: string): void;
+export declare function reportDraftActionEvent(state: 'added' | 'completed' | 'deleted' | 'updated' | 'failed'): void;
+export declare function reportDraftQueueState(state: 'started' | 'error' | 'waiting' | 'stopped'): void;
+export declare function reportDraftAwareContentDocumentVersionSythensizeError(err: unknown): void;
+export declare function reportDraftAwareContentVersionSynthesizeCalls(mimeType: string): void;
+/** Priming */
+export declare function reportPrimingSessionCreated(): void;
+export declare function reportPrimingError(errorType: string, recordCount: number): void;
+export declare function reportPrimingSuccess(recordCount: number): void;

package/dist/instrumentation/withInstrumentation.d.ts

@@ -0,0 +1,12 @@
+type Operation = () => Promise<any>;
+export type WithInstrumentation = (operation: () => Promise<any>, config: InstrumentationConfig) => Promise<any>;
+export interface InstrumentationConfig {
+    tags: Record<string, string>;
+    metricName: string;
+}
+/**
+ * Higher order function that instruments any async operation
+ *
+ */
+export declare const withInstrumentation: (operation: Operation, config?: InstrumentationConfig) => Promise<any>;
+export {};

package/dist/localization/formatDisplayValue.d.ts

@@ -0,0 +1,6 @@
+export declare const FORMATTABLE_DISPLAY_VALUE_TYPES: string[];
+/**
+ * Formats the display value for a draft field
+ * @param value the value to format
+ */
+export declare function formatDisplayValue(value: boolean | number | string | null, datatype: string): null | string;

package/dist/main.d.ts

@@ -0,0 +1,6 @@
+import { getRuntime } from './runtime';
+export { getRuntime };
+export type { ObjectInfoService } from './utils/ObjectInfoService';
+export type { ObservabilityContext } from '@salesforce/nimbus-plugin-lds';
+export { registerReportObserver } from './instrumentation/instrumentMobileAdapter';
+export { reportGraphqlQueryParseError } from './instrumentation/metrics';