/*
    Copyright (c) 2022 Betim Beja and Shko Online LLC
    Licensed under the MIT license.
*/

declare namespace ShkoOnline {
    type EnumType<Type> = Type extends ComponentFramework.PropertyTypes.EnumProperty<infer X> ? X : never;

    export type PropertyTypes<T extends { [key: string]: any }> = {
        [P in keyof T]: T[P] extends ComponentFramework.PropertyTypes.Property
        ? T[P]
        : T[P] extends ComponentFramework.PropertyTypes.EnumProperty<EnumType<T[P]>>
        ? T[P]
        : T[P] extends ComponentFramework.PropertyTypes.DataSet
        ? T[P]
        : never;
    };

    /**
     * The entire property bag interface available to control via Context Object
     */
    export interface Context<TInputs extends PropertyTypes<TInputs>> {
        parameters: TInputs;
    }

    export type KnownTypes<TOutput> = {
        [P in keyof TOutput]: TOutput[P] extends string | undefined
        ? TOutput[P]
        : TOutput[P] extends number | undefined
        ? TOutput[P]
        : TOutput[P] extends Date | undefined
        ? TOutput[P]
        : TOutput[P] extends boolean | undefined
        ? TOutput[P]
        : TOutput[P] extends ComponentFramework.LookupValue[] | undefined
        ? TOutput[P]
        : TOutput[P] extends number[] | undefined
        ? TOutput[P]
        : 0 extends 1 & TOutput[P] // any trick copied from here https://stackoverflow.com/a/55541672
        ? any
        : never;
    };

    export type OutputOnlyTypes<TInput extends PropertyTypes<TInput>, TOutput extends KnownTypes<TOutput>> = {
        [P in keyof TOutput]: P extends keyof TInput
        ? never
        : 0 extends 1 & TOutput[P] // any trick copied from here https://stackoverflow.com/a/55541672
        ? 'any'
        : TOutput[P] extends string | undefined
        ? 'string'
        : TOutput[P] extends number | undefined
        ? 'number'
        : TOutput[P] extends Date | undefined
        ? 'Date'
        : TOutput[P] extends boolean | undefined
        ? 'boolean'
        : TOutput[P] extends ComponentFramework.LookupValue[] | undefined
        ? 'Lookup'
        : TOutput[P] extends number[] | undefined
        ? 'number'
        : never;
    };

    /** https://learn.microsoft.com/en-us/power-apps/developer/model-driven-apps/clientapi/reference/xrm-utility/getentitymetadata */
    export interface EntityMetadata {
        /** Whether a custom activity should appear in the activity menus in the Web application. 0 indicates that the custom activity doesn't appear; 1 indicates that it does appear. */
        ActivityTypeMask?: number;
        /**Indicates whether to automatically move records to the owner’s default queue when a record of this type is created or assigned.*/
        AutoRouteToOwnerQueue?: boolean;
        /**For internal use only. */
        CanEnableSyncToExternalSearchIndex?: boolean;
        /**Indicates whether the table can trigger a workflow process.*/
        CanTriggerWorkflow?: boolean;
        /**Description for the table.*/
        Description?: string;
        /**Plural display name for the table.*/
        DisplayCollectionName?: string;
        /**Display name for the table.*/
        DisplayName?: string;
        /**Indicates whether the table will enforce custom state transitions.*/
        EnforceStateTransitions?: boolean;
        /**The hexadecimal code to represent the color to be used for this table in the application.*/
        EntityColor?: string;
        /**Indicates whether activities are associated with this table.*/
        HasActivities?: boolean;
        /**Indicates whether the table is an activity.*/
        IsActivity?: boolean;
        /**Indicates whether the email messages can be sent to an email address stored in a record of this type.*/
        IsActivityParty?: boolean;
        /**Indicates whether the table is enabled for business process flows.*/
        IsBusinessProcessEnabled?: boolean;
        /**Indicates whether the table is a business process flow table.*/
        IsBPFEntity?: boolean;
        /**Indicates whether the table is a child table.*/
        IsChildEntity?: boolean;
        /**Indicates whether connections are enabled for this table.*/
        IsConnectionsEnabled?: boolean;
        /**Indicates whether the table is a custom table.*/
        IsCustomEntity?: boolean;
        /**Indicates whether the table is customizable.*/
        IsCustomizable?: boolean;
        /**Indicates whether document management is enabled.*/
        IsDocumentManagementEnabled?: boolean;
        /** Indicates whether the document recommendations is enabled.*/
        IsDocumentRecommendationsEnabled?: boolean;
        /** Indicates whether duplicate detection is enabled.*/
        IsDuplicateDetectionEnabled?: boolean;
        /**Indicates whether charts are enabled.*/
        IsEnabledForCharts?: boolean;
        /**Indicates whether the table can be imported using the Import Wizard.*/
        IsImportable?: boolean;
        /**Indicates the table is enabled for interactive experience.*/
        IsInteractionCentricEnabled?: boolean;
        /**Indicates whether knowledge management is enabled for the table.*/
        IsKnowledgeManagementEnabled?: boolean;
        /**Indicates whether mail merge is enabled for this table.*/
        IsMailMergeEnabled?: boolean;
        /**Indicates whether the table is part of a managed solution.*/
        IsManaged?: boolean;
        /**Indicates whether OneNote integration is enabled for the table.*/
        IsOneNoteIntegrationEnabled?: boolean;
        /**Indicates whether optimistic concurrency is enabled for the table.*/
        IsOptimisticConcurrencyEnabled?: boolean;
        /**Indicates whether the table is enabled for quick create forms.*/
        IsQuickCreateEnabled?: boolean;
        /**Indicates whether the table supports setting custom state transitions.*/
        IsStateModelAware?: boolean;
        /**Indicates whether the table is will be shown in Advanced Find.*/
        IsValidForAdvancedFind?: boolean;
        /**Indicates whether Microsoft Dynamics 365 for tablets users can see data for this table.*/
        IsVisibleInMobileClient?: boolean;
        /**Indicates whether the table is enabled for Unified Interface.*/
        IsEnabledInUnifiedInterface?: boolean;
        /**The logical collection name.*/
        LogicalCollectionName?: string;
        /**The table type code.*/
        ObjectTypeCode?: number;
        /**The ownership type for the table: "UserOwned" or "OrganizationOwned".*/
        OwnershipType?: string;
        /** The name of the Web API table set for this table. */
        EntitySetName?: string;
        /** The logical name for the table. */
        LogicalName: string;
        /**The name of the column that is the primary id for the table.*/
        PrimaryIdAttribute?: string;
        /**The name of the primary image column for a table.*/
        PrimaryImageAttribute?: string;
        /** The name of the primary column for a table. */
        PrimaryNameAttribute?: string;
        /**The privilege definitions for the table where *each* object contains the following values to define the security privilege for access to a table*/
        Privileges?: ShkoOnline.Privileges[];
        /** A collection of column definitions objects. The object returned depends on the type of column definitions. */
        Attributes?: ShkoOnline.AttributeMetadata[];
    }

    export interface AttributeMetadataCollection {
        add: () => void;
        get: (name: string) => ShkoOnline.AttributeMetadata | undefined;
        getAll: () => ShkoOnline.AttributeMetadata[];
        getByFilter: () => ShkoOnline.AttributeMetadata[];
        getByName: (name: string) => ShkoOnline.AttributeMetadata | undefined;
        getByIndex: (index: number) => ShkoOnline.AttributeMetadata | undefined;
        getFirst: (
            lambda: (attribute: ShkoOnline.AttributeMetadata) => boolean,
        ) => ShkoOnline.AttributeMetadata | undefined;
        getLength: () => number;
        remove: () => void;
    }

    export interface Privileges {
        /**Whether the privilege can be basic access level.*/
        CanBeBasic: boolean;
        /**Whether the privilege can be deep access level*/
        CanBeDeep: boolean;
        /**Whether the privilege for an external party can be basic access level.*/
        CanBeEntityReference: boolean;
        /**Whether the privilege can be global access level.*/
        CanBeGlobal: boolean;
        /**Whether the privilege can be local access level*/
        CanBeLocal: boolean;
        /**Whether the privilege for an external party can be parent access level.*/
        CanBeParentEntityReference: boolean;
        /**The name of the privilege*/
        Name: string;
        /**The ID of the privilege.*/
        PrivilegeId: string;
        /**
       The type of privilege, which is one of the following:
         0: None
         1: Create
         2: Read
         3: Write
         4: Delete
         5: Assign
         6: Share
         7: Append
         8: AppendTo
      */
        PrivilegeType: ShkoOnline.PrivilegeType;
    }

    export interface AttributeMetadata {
        /** Type of a column. */
        AttributeType: ShkoOnline.AttributeType;
        /** The name of the attribute that this attribute extends.*/
        AttributeOf: string;
        /** The name of the type for the attribute.*/
        AttributeTypeName: {
            value: string;
        };
        /** */
        AutoNumberFormat: string;
        /** Whether field-level security can be applied to prevent a user from adding data to this attribute.*/
        CanBeSecuredForCreate: boolean;
        /** Whether field-level security can be applied to prevent a user from viewing data from this attribute.*/
        CanBeSecuredForRead: boolean;
        /** Whether field-level security can be applied to prevent a user from updating data for this attribute.*/
        CanBeSecuredForUpdate: boolean;
        /** Whether any settings not controlled by managed properties can be changed.*/
        CanModifyAdditionalSettings: ShkoOnline.BooleanManagedProperty;
        /**An organization-specific ID for the attribute used for auditing.*/
        ColumnNumber: number;
        CreatedOn: Date;
        /**The Microsoft Dynamics 365 version that the attribute was deprecated in.*/
        DeprecatedVersion: string;
        /** The label containing the description for the attribute.*/
        Description: {
            LocalizedLabels: [
                {
                    /** The localized label string.*/
                    Label: string;
                    /** The language code for the label.*/
                    LanguageCode: number;
                    /** Whether the label is managed.*/
                    IsManaged: boolean;
                    /** A unique identifier for the metadata item.*/
                    MetadataId: string;
                    /** Whether the item of metadata has changed.*/
                    HasChanged: boolean;
                },
            ];
            UserLocalizedLabel: {
                /** The localized label string.*/
                Label: string;
                /** The language code for the label.*/
                LanguageCode: number;
                /** Whether the label is managed.*/
                IsManaged: boolean;
                /** A unique identifier for the metadata item.*/
                MetadataId: string;
                /** Whether the item of metadata has changed.*/
                HasChanged: boolean;
            };
        };
        /** Display name for the column. */
        DisplayName: string;
        /** Logical name of the table that contains the column. */
        EntityLogicalName: string;
        ExternalName: string;
        /**Indicates whether the item of metadata has changed. */
        HasChanged: string;
        /**For internal use only. */
        InheritsFrom: string;
        /** A string identifying the solution version that the solution component was added in. */
        IntroducedVersion: string;
        /** Whether the attribute is enabled for auditing. */
        IsAuditEnabled: ShkoOnline.BooleanManagedProperty;
        /** Whether the attribute is a custom attribute. */
        IsCustomAttribute: boolean;
        /** Whether the attribute allows customization.*/
        IsCustomizable: ShkoOnline.BooleanManagedProperty;
        IsDataSourceSecret: boolean;
        /** For internal use only. */
        IsFilterable: boolean;
        /** For internal use only. */
        IsGlobalFilterEnabled: ShkoOnline.BooleanManagedProperty;
        /** Whether the attribute is a logical attribute. */
        IsLogical: boolean;
        /** Whether the attribute is part of a managed solution. */
        IsManaged: boolean;
        /** Whether the attribute represents the unique identifier for the record. */
        IsPrimaryId: boolean;
        /** Whether the attribute represents the primary attribute for the entity. */
        IsPrimaryName: boolean;
        /** Whether the attribute display name can be changed.*/
        IsRenameable: ShkoOnline.BooleanManagedProperty;
        IsRequiredForForm: boolean;
        /** For internal use only. */
        IsRetrievable: boolean;
        /** For internal use only. */
        IsSearchable: boolean;
        /** Whether the attribute is secured for field-level security. */
        IsSecured: boolean;
        /** For internal use only. */
        IsSortableEnabled: ShkoOnline.BooleanManagedProperty;
        /** Whether the attribute appears in Advanced Find.*/
        IsValidForAdvancedFind: ShkoOnline.BooleanManagedProperty;
        /**Whether the value can be set when a record is created.*/
        IsValidForCreate: boolean;
        IsValidForForm: boolean;
        IsValidForGrid: boolean;
        /** Whether the value can be retrieved. */
        IsValidForRead: boolean;
        /** Whether the value can be updated.*/
        IsValidForUpdate: boolean;
        IsValidODataAttribute: boolean;
        /** The id of the attribute that is linked between appointments and recurring appointments. */
        LinkedAttributeId: string;
        /** Logical name for the column. */
        LogicalName: string;
        /** A unique identifier for the metadata item. */
        MetadataId: string;
        ModifiedOn: Date;
        /** The property that determines the data entry requirement level enforced for the attribute. */
        RequiredLevel: {
            /** The value of the managed property.*/
            Value: ShkoOnline.AttributeRequiredLevel;
            /** Whether the managed property value can be changed.*/
            CanBeChanged: boolean;
            /**The logical name for the managed property.*/
            ManagedPropertyLogicalName: string;
        };
        /**  Schema name for the column.  */
        SchemaName: string;
        Settings: { name: string };
        /** A value that indicates the source type for a calculated or rollup attribute. */
        SourceType: number;
    }

    export interface BooleanAttributeMetadata extends ShkoOnline.AttributeMetadata {
        /** Type of a column. */
        AttributeType: ShkoOnline.AttributeType.Boolean;
        /**Default value for a Yes/No column.*/
        DefaultFormValue: boolean;
        /**Options for the boolean column where each option is a key:value pair.*/
        OptionSet: ShkoOnline.BooleanOptionSet;
    }

    export interface BooleanOptionSet {
        MetadataId: string;
        IsCustomOptionSet: boolean;
        Name: string;
        OptionSetType: OptionSetType.Boolean;
        DisplayName: string;
        TrueOption: {
            Value: number;
            Label: string;
            Color?: string;
        };
        FalseOption: {
            Value: number;
            Label: string;
            Color?: string;
        };
    }
    export interface BooleanManagedProperty {
        /** The value of the managed property.*/
        Value: boolean;
        /** Whether the managed property value can be changed.*/
        CanBeChanged: boolean;
        /**The logical name for the managed property.*/
        ManagedPropertyLogicalName: string;
    }

    export interface StringAttributeMetadata extends ShkoOnline.AttributeMetadata {
        AttributeType: ShkoOnline.AttributeType.String;
        Format: string;
        MaxLength: number;
        ImeMode: ShkoOnline.ImeMode;
    }

    export interface NumberAttributeMetadata extends ShkoOnline.AttributeMetadata {
        AttributeType:
        | ShkoOnline.AttributeType.Integer
        | ShkoOnline.AttributeType.BigInt
        | ShkoOnline.AttributeType.Decimal
        | ShkoOnline.AttributeType.Double;
        ImeMode: ShkoOnline.ImeMode;
        MaxValue: number;
        MinValue: number;
    }

    export interface DecimalNumberAttributeMetadata extends ShkoOnline.NumberAttributeMetadata {
        AttributeType: ShkoOnline.AttributeType.Decimal;
        Precision: number;
    }

    export interface IntegerNumberAttributeMetadata extends ShkoOnline.NumberAttributeMetadata {
        AttributeType: ShkoOnline.AttributeType.Integer;
        Format: string;
    }

    export interface DateTimeAttributeMetadata extends ShkoOnline.AttributeMetadata {
        AttributeType: ShkoOnline.AttributeType.DateTime;
        Format: string;
        ImeMode: ShkoOnline.ImeMode;
        Behaviour: ShkoOnline.DateTimeFieldBehavior;
    }

    export interface LookupAttributeMetadata extends ShkoOnline.AttributeMetadata {
        AttributeType: ShkoOnline.AttributeType.Lookup;
        Targets: string[];
    }

    export interface EnumTypeAttributeMetadata extends ShkoOnline.AttributeMetadata {
        /** Type of a column. */
        AttributeType: ShkoOnline.AttributeType.String;
        /**Options for the column where each option is a key:value pair*/
        OptionSet: {
            [key: string]: string;
        };
    }

    export interface PickListAttributeMetadata extends ShkoOnline.AttributeMetadata {
        /** Type of a column. */
        AttributeType: ShkoOnline.AttributeType.Picklist;
        /**Default form value for the column.*/
        DefaultFormValue: number;
        /**Options for the column where each option is a key:value pair.*/
        OptionSet: ShkoOnline.OptionSet<OptionSetType.Picklist>;
    }

    export interface OptionSet<T extends OptionSetType> {
        MetadataId: string;
        IsCustomOptionSet: boolean;
        Name: string;
        OptionSetType: T;
        Options: {
            [value: number]: {
                Value: number;
                Label: string;
                Color?: string;
            };
        };
    }

    /**
     * https://learn.microsoft.com/en-us/dotnet/api/microsoft.xrm.sdk.metadata.optionsettype
     */
    export enum OptionSetType {
        /** The option set provides a list of options. */
        Picklist = 0,
        /** The option set represents state options for a StateAttributeMetadata attribute. */
        State = 1,
        /** The option set represents status options for a StatusAttributeMetadata attribute. */
        Status = 2,
        /** The option set provides two options for a BooleanAttributeMetadata attribute. */
        Boolean = 3,
    }

    export interface StateAttributeMetadata extends ShkoOnline.AttributeMetadata {
        /** Type of a column. */
        AttributeType: ShkoOnline.AttributeType.State;
        /**Options for the column where each option is a key:value pair*/
        OptionSet: {
            [key: string]: string;
        };
        /**Returns the default status (number) based on the passed in state value for a table*/
        getDefaultStatus(state: number): number;
        /**Returns possible status values (array of numbers) for a specified state value.*/
        getStatusValuesForState(state: number): number[];
    }

    export interface StatusAttributeMetadata extends ShkoOnline.AttributeMetadata {
        /** Type of a column. */
        AttributeType: ShkoOnline.AttributeType.Status;
        /**Options for the column where each option is a key:value pair.*/
        OptionSet: {
            [key: string]: string;
        };
        /**Returns the state value (number) for the specified status value (number).*/
        getState(status: number): number;
    }

    /**
     * Describes the type of an attribute.
     * For the Web API use the AttributeTypeCode EnumType.
     */
    export enum AttributeType {
        /** A big integer attribute */
        BigInt = 18,
        /** A Boolean attribute. Value = 0. */
        Boolean = 0,

        /** An attribute that contains calendar rules. Value = 0x10. */
        CalendarRules = 16,

        /** An attribute that represents a customer. Value = 1.*/
        Customer = 1,

        /** A date/time attribute. Value = 2. */
        DateTime = 2,

        /** A decimal attribute. Value = 3. */
        Decimal = 3,

        /** A double attribute. Value = 4. */
        Double = 4,

        /** An entity name attribute. Value = 20. */
        EntityName = 20,

        /**
         * An integer attribute. Value = 5.
         */
        Integer = 5,

        /**A lookup attribute. Value = 6. */
        Lookup = 6,

        /** A managed property attribute. Value = 0x13. */
        ManagedProperty = 19,

        /** A memo attribute. Value = 7. */
        Memo = 7,

        /** A money attribute. Value = 8. */
        Money = 8,

        /** An owner attribute. Value = 9. */
        Owner = 9,

        /** A partylist attribute. Value = 10.*/
        PartyList = 10,

        /** A picklist attribute. Value = 11. */
        Picklist = 11,

        /** A state attribute. Value = 12. */
        State = 12,

        /** A status attribute. Value = 13. */
        Status = 13,

        /** A string attribute. Value = 14.*/
        String = 14,

        /** An attribute that is an ID. Value = 15. */
        Uniqueidentifier = 15,

        /** An attribute that is created by the system at run time. Value = 0x11. */
        Virtual = 17,
    }

    type ImeMode = 0 | 1 | 2 | 3;
    type DateTimeFieldBehavior = 0 | 1 | 3;
    type PrivilegeType = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
    type AttributeRequiredLevel = 0 | 1 | 2 | 3;
}

export type { ShkoOnline };