@microsoft/power-apps-cli 0.5.3 → 0.5.4

package/node_modules/@microsoft/1ds-properties-js/types/1ds-properties-js.d.ts

@@ -0,0 +1,706 @@
+/*
+ * 1DS JS SDK Properties plugin, 4.3.9
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ *
+ * Javascript Telemetry SDKs <TelReachSDK@microsoft.com>
+ * https://eng.ms/docs/products/geneva/collect/instrument/1ds/javascriptsdk/getting-started
+ *
+ * ---------------------------------------------------------------------------
+ * This is a single combined (rollup) declaration file for the package,
+ * if you require a namespace wrapped version it is also available.
+ * - Namespaced version: types/1ds-properties-js.namespaced.d.ts
+ * ---------------------------------------------------------------------------
+ */
+
+import { BaseTelemetryPlugin } from '@microsoft/1ds-core-js';
+import { GuidStyle } from '@microsoft/1ds-core-js';
+import { IAppInsightsCore } from '@microsoft/1ds-core-js';
+import { IDistributedTraceContext } from '@microsoft/1ds-core-js';
+import { IEventProperty } from '@microsoft/1ds-core-js';
+import { IExtendedConfiguration } from '@microsoft/1ds-core-js';
+import { IPlugin } from '@microsoft/1ds-core-js';
+import { IProcessTelemetryContext } from '@microsoft/1ds-core-js';
+import { ITelemetryItem } from '@microsoft/1ds-core-js';
+import { IUnloadHookContainer } from '@microsoft/applicationinsights-core-js';
+
+export declare const AppExtensionKeys: {
+    id: "id";
+    ver: "ver";
+    appName: "name";
+    locale: "locale";
+    expId: "expId";
+    env: "env";
+    0: "id";
+    1: "ver";
+    2: "name";
+    3: "locale";
+    4: "expId";
+    5: "env";
+};
+
+export declare class Application implements IAppContext {
+    /**
+     * Validate each flight id in appExpId against the app flight ID format and create
+     * a comma seperated appExpId with valid flight ids.Ignore invalid flight IDs
+     * @param appExpId - The current experiment id
+     * @param appExpIdNew - The new experiment id to set (if valid)
+     * @param flightIdNameSpaces - The valid set of flight id names
+     * @returns The validated experiment id,
+     */
+    static validateAppExpId: (appExpIdNew: string, flightIdNameSpaces?: string[]) => string;
+    /**
+     * Static constructor, attempt to create accessors
+     */
+    // private static _staticInit;
+    /**
+     * The application ID.
+     */
+    id?: string;
+    /**
+     * The application version.
+     */
+    ver?: string;
+    /**
+     * The application name.
+     */
+    name?: string;
+    /**
+     * The application locale.
+     */
+    locale?: string;
+    /**
+     * The application environment.
+     */
+    env?: string;
+    /**
+     * Returns the application experiment Id.
+     * Note: This property will NOT exist in ES3/IE8 environment, if you need IE8 compatibility
+     * use the method {@link Application#getExpId} from your code. For ES5+ environment this will be replaced with a
+     * property getter only.
+     */
+    expId?: string;
+    constructor(propertiesConfig: IPropertyConfiguration, core?: IAppInsightsCore, unloadHookContainer?: IUnloadHookContainer);
+    /**
+     * The application experiment Id.
+     */
+    getExpId(): string;
+}
+
+/**
+ * Cloud.ts
+ * @author Hector Hernandez (hectorh)
+ * @copyright Microsoft 2020
+ */
+export declare class Cloud {
+    /**
+     * 	Role of the service. Role is used to identify the component's name.
+     */
+    role?: string;
+    /**
+     * The instance id of the deployed role instance generating the event. In most cases, roleInstance is a computer name.
+     */
+    roleInstance?: string;
+    /**
+     * 	The build version of the role.
+     */
+    roleVer?: string;
+}
+
+export declare const CloudExtKeys: {
+    role: "role";
+    roleInstance: "roleInstance";
+    roleVer: "roleVer";
+    0: "role";
+    1: "roleInstance";
+    2: "roleVer";
+};
+
+export declare const defaultFlightIdNameSpaces: string[];
+
+export declare class Device implements IDeviceContext {
+    /**
+     * Device local ID.
+     */
+    localId?: string;
+    /**
+     * Device class.
+     */
+    deviceClass?: string;
+    /**
+     * Device make.
+     */
+    make?: string;
+    /**
+     * Device model.
+     */
+    model?: string;
+}
+
+export declare const DeviceExtKeys: {
+    localId: "localId";
+    deviceClass: "deviceClass";
+    make: "make";
+    model: "model";
+    0: "localId";
+    1: "deviceClass";
+    2: "make";
+    3: "model";
+};
+
+export declare const enum eAppExtensionKeys {
+    id = 0,
+    ver = 1,
+    appName = 2,
+    locale = 3,
+    expId = 4,
+    env = 5
+}
+
+export declare const enum eCloudExtKeys {
+    role = 0,
+    roleInstance = 1,
+    roleVer = 2
+}
+
+export declare const enum eDeviceExtKeys {
+    localId = 0,
+    deviceClass = 1,
+    make = 2,
+    model = 3
+}
+
+/**
+ * TelemetryContext.ts
+ * @author Hector Hernandez (hectorh)
+ * @copyright Microsoft 2019
+ */
+export declare const enum eExtensions {
+    UserExt = 0,
+    DeviceExt = 1,
+    TraceExt = 2,
+    WebExt = 3,
+    AppExt = 4,
+    OSExt = 5,
+    SdkExt = 6,
+    IntWebExt = 7,
+    UtcExt = 8,
+    LocExt = 9,
+    CloudExt = 10,
+    DtExt = 11
+}
+
+export declare const enum eLocExtKeys {
+    tz = 0
+}
+
+export declare const enum eOSExtKeys {
+    osName = 0,
+    ver = 1
+}
+
+export declare const enum eUserExtensionKeys {
+    locale = 0,
+    localId = 1,
+    id = 2
+}
+
+export declare const enum eWebExtensionKeys {
+    domain = 0,
+    browser = 1,
+    browserVer = 2,
+    screenRes = 3,
+    userConsent = 4,
+    consentDetails = 5
+}
+
+export declare const Extensions: {
+    UserExt: "user";
+    DeviceExt: "device";
+    TraceExt: "trace";
+    WebExt: "web";
+    AppExt: "app";
+    OSExt: "os";
+    SdkExt: "sdk";
+    IntWebExt: "intweb";
+    UtcExt: "utc";
+    LocExt: "loc";
+    CloudExt: "cloud";
+    DtExt: "dt";
+    0: "user";
+    1: "device";
+    2: "trace";
+    3: "web";
+    4: "app";
+    5: "os";
+    6: "sdk";
+    7: "intweb";
+    8: "utc";
+    9: "loc";
+    10: "cloud";
+    11: "dt";
+};
+
+export declare interface IAppContext {
+    /**
+     * The application ID.
+     */
+    id?: string;
+    /**
+     * The application version.
+     */
+    ver?: string;
+    /**
+     * The application name.
+     */
+    name?: string;
+    /**
+     * The application locale.
+     */
+    locale?: string;
+    /**
+     * The application environment.
+     */
+    env?: string;
+    /**
+     * Gets the application experiment Id, this is only available in an ES5+ container (i.e. not available in IE8)
+     * The value is the same as calling getExpId() which you should use if your users are running in an ES3 container (browser)
+     */
+    expId?: string;
+    /**
+     * Gets the application experiment Id.
+     */
+    getExpId(): string | undefined;
+}
+
+export declare interface IDeviceContext {
+    /**
+     * Device local ID.
+     */
+    localId?: string;
+    /**
+     * Device class.
+     */
+    deviceClass?: string;
+    /**
+     * Device make.
+     */
+    make?: string;
+    /**
+     * Device model.
+     */
+    model?: string;
+}
+
+export declare interface IOperatingSystemContext {
+    /**
+     * Operating system name.
+     */
+    name?: string;
+    /**
+     * Semantic: major.minor where major and minor are decimal numbers. Indicates the major and minor version of the operating system.
+     */
+    ver?: string;
+}
+
+/**
+ * The IPropertyConfiguration interface holds the configuration details passed to PartA module.
+ */
+export declare interface IPropertyConfiguration {
+    /**
+     * Flag to allow client side population of browser information in web extension
+     */
+    populateBrowserInfo?: boolean;
+    /**
+     * Flag to allow client side population of os extension
+     */
+    populateOperatingSystemInfo?: boolean;
+    /**
+     * A string that contains the user agent parsed for auto collection in
+     * case the userAgent can't be obtained from the DOM.
+     */
+    userAgent?: string;
+    /**
+     * An override to allow the passing of specific IUserAgentData (brands, platform and mobile), this value defaults to navigator.userAgentData.
+     */
+    userAgentData?: IUserAgentData;
+    /**
+     * Names the cookie used by your site to track user consent. Default is "MSCC".
+     */
+    userConsentCookieName?: string;
+    /**
+     * @deprecated Use the `callback.userConsentDetails` instead, now always written as false to `ext.web.userConsent`
+     * Used to manually set the value of the "userConsent" field
+     */
+    userConsented?: boolean;
+    /**
+     * Field to add the name of services or SDKs in the events
+     */
+    serviceName?: string;
+    /**
+     * Environment is captured from meta tag. This is used to override the value or bypass defining meta tags.
+     */
+    env?: string;
+    /**
+     * Experiment id is captured from the experiment cookie. This is used to override the value or bypass defining meta tags.
+     */
+    expId?: string;
+    /**
+     * A session is logged if the user is inactive for this time in milliseconds.
+     * Default 30 mins.
+     */
+    sessionRenewalMs?: number;
+    /**
+     * A session is logged if it has continued for this time in milliseconds.
+     * Default 24h.
+     */
+    sessionExpirationMs?: number;
+    /**
+     * Use a guid value to identify the automatic session rather than the 6 digit value, this also defines the format to use
+     */
+    sessionAsGuid?: boolean | GuidStyle;
+    /**
+     * Custom cookie domain. This is helpful if you want to share SDK cookies
+     * across subdomains.
+     */
+    cookieDomain?: string;
+    /**
+     * An optional value that will be used as name postfix for localStorage and cookie name.
+     */
+    namePrefix?: string;
+    /**
+     * If enabled all events will have operationId, operationName and operationParentId used by Application Insights for distributed tracing
+     */
+    enableApplicationInsightsTrace?: boolean;
+    /**
+     * If enabled AI user cookie is created and all events will have user ID information
+     */
+    enableApplicationInsightsUser?: boolean;
+    /**
+     * See details {@link https://www.osgwiki.com/wiki/Telemetry#De-Identification_of_Telemetry_Events | here}.
+     * Hashes the identifiable Part A fields  https://osgwiki.com/wiki/CommonSchema/flags
+     * ext.user.localId and ext.device.localId need to be hashed if being sent and using "d:" prefix when this setting is enabled
+     */
+    hashIdentifiers?: boolean;
+    /**
+     * See details {@link https://www.osgwiki.com/wiki/Telemetry#De-Identification_of_Telemetry_Events | here}.
+     * Removes the identifiable Part A fields  https://osgwiki.com/wiki/CommonSchema/flags
+     * ext.user.localId and ext.device.localId need use "r:" prefix when if being sent and this setting is enabled
+     */
+    dropIdentifiers?: boolean;
+    /**
+     * See details {@link https://www.osgwiki.com/wiki/Telemetry#De-Identification_of_Telemetry_Events | here}. Collector to scrub `ext.ingest.clientIp`
+     * field stamped server-side. This takes precedence over both Hash Identifier and Drop Identifier flags above, so as long as this bit is set,
+     * the client IP will be scrubbed as "xxx.xxx.xxx.*" for IPv4 and will not be dropped. The main use case for this flag is Interchange customers
+     * that need to use OriginalMessage feature but wish not to have IP info in Geneva data store. For more details on this scenario, please see link
+     * here: {@link https://eng.ms/docs/products/geneva/connectors/asimov_to_geneva/management#default-commonschema | 1DS Interchange Default CommonSchema}
+     * See also {@link https://www.osgwiki.com/wiki/CommonSchema/flags | CommonSchema/flags}
+     * @since 3.2.11 / 4.0.0
+     */
+    scrubIpOnly?: boolean;
+    /**
+     * placeholder for callbacks
+     */
+    callback?: IValueCallback;
+    /**
+     * [Optional] Identifies the default length used to generate random session and user id's if non currently exists for the user / session.
+     * Defaults to 22, previous default value was 5, if you need to keep the previous maximum length you should set this value to 5.
+     */
+    idLength?: number;
+    /**
+     * [Optional] Enable adding the distributed tracing values to the envelope (ext.dt)
+     */
+    enableDistributedTracing?: boolean;
+    /**
+     * [Optional] A flag which defines whether the properties plugin will override any of the part A 'ext' fields or
+     * whether (when `true`) will keep any value provided by the event. `ext.dt` and `ext.trace` always let the event
+     * override the default value. Added in v3.2.5
+     */
+    eventContainExtFields?: boolean;
+    /**
+     * [Optional] A flag that indicates whether the user has explicitly opted in (CCPA) to data Sharing.
+     * This value has 3 possible states
+     * - Not specified - Do not add (indirectly implies that they have opted in by default
+     * - `true` - The user has explicitly opted in to allow DataSharing
+     * - `false` - The user has explicitly opted out to allow DataSharing
+     * When specified (`true`/`false`) this will add the `GPC_DataSharingOptIn` property to the `ext.web.consentDetails` sent with
+     * every event. If you also have specified a `callback.userConsentDetails` this value will be added to the returned and validated
+     * `userConsentDetails`.
+     */
+    gpcDataSharingOptIn?: boolean;
+    /**
+     * [Optional] Disable the sanitization of the `ext.web.consentDetails` value returned by the `callback.userConsentDetails`
+     * callback. When disabled (`true`) any additional properties included in the returned object will be included, any missing
+     * standard properties will still be added.
+     */
+    disableConsentDetailsSanitize?: boolean;
+}
+
+export declare interface ITraceContext {
+    /**
+     * Trace id
+     */
+    traceId: string;
+    /**
+     * Parent id
+     */
+    parentId: string;
+    /**
+     * Trace state
+     */
+    traceState?: any;
+    /**
+     * An integer representation of the W3C TraceContext trace-flags. https://www.w3.org/TR/trace-context/#trace-flags
+     */
+    traceFlags?: number;
+    /**
+     * Name
+     */
+    name?: string;
+}
+
+export declare interface IUserAgentBrand {
+    brand: string;
+    version: string;
+}
+
+export declare interface IUserAgentData {
+    brands?: IUserAgentBrand[];
+    mobile?: boolean;
+    platform?: string;
+}
+
+export declare interface IUserContentDetails {
+    Required?: boolean;
+    Analytics?: boolean;
+    SocialMedia?: boolean;
+    Advertising?: boolean;
+}
+
+export declare interface IUserContext {
+    /**
+     * The userId as known by the logging library.
+     * This property is not available in IE8, use getLocalId() instead
+     */
+    localId?: string;
+    /**
+     * Language and region (IETF language tag).
+     */
+    locale?: string;
+    /**
+     * UserID used by ApplicationInsights
+     */
+    id?: string;
+    /**
+     * The userId as known by the logging library.
+     */
+    getLocalId(): string | undefined;
+}
+
+export declare interface IValueCallback {
+    userConsentDetails?: () => IUserContentDetails;
+}
+
+export declare interface IWebContext {
+    /**
+     * Domain of the page.
+     */
+    domain?: string;
+    /**
+     * Web browser name.
+     */
+    browser?: string;
+    /**
+     * Web browser version.
+     */
+    browserVer?: string;
+    /**
+     * Web browser screen resolution.
+     */
+    screenRes?: string;
+    /**
+     * Describes whether the user has given consent for Cookies.
+     * This is configurable by users to define which cookie to look for marking this flag as true or false.
+     * This property is not available in IE8, use getUserConsent() instead
+     * v4.3.0 Removed, now always written as false -- use userConsentDetails callback instead
+     */
+    userConsent?: boolean;
+    /**
+     * [Optional] A flag that indicates whether the user has explicitly opted in (CCPA) to data Sharing.
+     * This value has 3 possible states
+     * - Not specified - Do not add (indirectly implies that they have opted in by default
+     * - `true` - The user has explicitly opted in to allow DataSharing
+     * - `false` - The user has explicitly opted out to allow DataSharing
+     * When specified (`true`/`false`) this will add the `GPC_DataSharingOptIn` property to the `ext.web.consentDetails` sent with
+     * every event. If you also have specified a `callback.userConsentDetails` this value will be added to the returned and validated
+     * `userConsentDetails`.
+     * This value is initialized from the properties plugin config.
+     */
+    gpcDataSharingOptIn?: boolean | null;
+    /**
+     * function to extract user consent details
+     */
+    getUserConsentDetails?: () => string;
+    /**
+     * Describes whether the user has given consent for Cookies.
+     * This is configurable by users to define which cookie to look for marking this flag as true or false.
+     */
+    getUserConsent(): boolean | undefined;
+}
+
+/**
+ * Loc.ts
+ * @author Hector Hernandez (hectorh)
+ * @copyright Microsoft 2019
+ */
+export declare class Loc {
+    /**
+     * 	Time zone on the device (ISO 8601).
+     */
+    tz: string;
+    constructor();
+}
+
+export declare const LocExtKeys: {
+    tz: "tz";
+    0: "tz";
+};
+
+export declare class OperatingSystem implements IOperatingSystemContext {
+    /**
+     * Operating system name.
+     */
+    name: string;
+    /**
+     * Semantic: major.minor where major and minor are decimal numbers. Indicates the major and minor version of the operating system.
+     */
+    ver: string;
+    constructor(propertiesConfig: IPropertyConfiguration, unloadHookContainer?: IUnloadHookContainer);
+}
+
+export declare const OSExtKeys: {
+    osName: "name";
+    ver: "ver";
+    0: "name";
+    1: "ver";
+};
+
+export declare class PropertiesPlugin extends BaseTelemetryPlugin {
+    identifier: string;
+    priority: number;
+    version: string;
+    constructor();
+    initialize(coreConfig: IExtendedConfiguration, core: IAppInsightsCore, extensions: IPlugin[]): void;
+    /**
+     * Process the event and add part A fields to it.
+     * @param event - The event that needs to be stored.
+     * @param itemCtx - This is the context for the current request, ITelemetryPlugin instances
+     * can optionally use this to access the current core instance or define / pass additional information
+     * to later plugins (vs appending items to the telemetry item)
+     */
+    processTelemetry(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    /**
+     * Get properties context to override or specify specific part A properties
+     * @returns the Context
+     */
+    getPropertiesContext(): TelemetryContext;
+    /**
+     * Sets a custom property to be sent with every event. IEventProperty can be used to tag the property as
+     * pii or customer content.
+     * @param name - The name of the property.
+     * @param value - The context property's value.
+     */
+    setProperty(name: string, value: string | number | boolean | string[] | number[] | boolean[] | IEventProperty): void;
+}
+
+export declare class Session {
+    /**
+     * Static constructor, attempt to create accessors
+     */
+    // private static _staticInit;
+    /**
+     * Returns or sets the id as known by the logging library.
+     * Note: This property will NOT exist in ES3/IE8 environment, if you need IE8 compatibility
+     * use the methods {@link Session#getId} and  {@link Session#setId} from your code. For ES5+ environment this will be replaced with a
+     * property getter only.
+     */
+    id?: string;
+    /**
+     * The date at which this guid was genereated.
+     * Per the spec the ID will be regenerated if more than acquisitionSpan milliseconds ellapse from this time.
+     */
+    acquisitionDate?: number;
+    /**
+     * The date at which this session ID was last reported.
+     * This value should be updated whenever telemetry is sent using this ID.
+     * Per the spec the ID will be regenerated if more than renewalSpan milliseconds elapse from this time with no activity.
+     */
+    renewalDate?: number;
+    customId: string;
+    /**
+     * The automatically generated session ID using SessionManager.
+     */
+    automaticId?: string;
+    constructor();
+    setId(id: string): void;
+    getId(): string;
+}
+
+export declare class TelemetryContext {
+    app: IAppContext;
+    user: IUserContext;
+    os: IOperatingSystemContext;
+    web: IWebContext;
+    session: Session;
+    device: Device;
+    cloud: Cloud;
+    loc: Loc;
+    constructor(coreConfig: IExtendedConfiguration, propertiesConfig: IPropertyConfiguration, core: IAppInsightsCore, unloadHookContainer?: IUnloadHookContainer);
+    /**
+     * Gets the current distributed trace context for this instance if available
+     */
+    getTraceCtx(): IDistributedTraceContext | null | undefined;
+    /**
+     * Returns the current session id, if one does not already exist a new one will be attempted to be created.
+     * If you have set a specific custom id via session.setId(), this function will return that value.
+     */
+    getSessionId(): string;
+    applyApplicationContext(event: ITelemetryItem): void;
+    applyUserContext(event: ITelemetryItem): void;
+    applyWebContext(event: ITelemetryItem): void;
+    applyOsContext(event: ITelemetryItem): void;
+    applySdkContext(event: ITelemetryItem): void;
+    applyIntWebContext(event: ITelemetryItem): void;
+    applyUtcContext(event: ITelemetryItem): void;
+    applyLocContext(event: ITelemetryItem): void;
+    applySessionContext(event: ITelemetryItem): void;
+    applyDeviceContext(event: ITelemetryItem): void;
+    applyCloudContext(event: ITelemetryItem): void;
+    applyAITraceContext(event: ITelemetryItem): void;
+    applyDistributedTraceContext(event: ITelemetryItem): void;
+}
+
+export declare const UserExtensionKeys: {
+    locale: "locale";
+    localId: "localId";
+    id: "id";
+    0: "locale";
+    1: "localId";
+    2: "id";
+};
+
+export declare const WebExtensionKeys: {
+    domain: "domain";
+    browser: "browser";
+    browserVer: "browserVer";
+    screenRes: "screenRes";
+    userConsent: "userConsent";
+    consentDetails: "consentDetails";
+    0: "domain";
+    1: "browser";
+    2: "browserVer";
+    3: "screenRes";
+    4: "userConsent";
+    5: "consentDetails";
+};
+
+export { }