@tuanltntu/n8n-nodes-bitrix24/dist/nodes/Bitrix24/descriptions/EntityDescription.js

Comprehensive n8n community node for Bitrix24 API integration with CRM, Tasks, Chat, Telephony, and more

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.entityFields = exports.entityOperations = void 0;
/**
 * Entity Description - Complete implementation based on Bitrix24 API documentation
 * https://apidocs.bitrix24.com/api-reference/entity/index.html
 */
// Operation field
const operationField = {
    displayName: "Operation",
    name: "operation",
    type: "options",
    noDataExpression: true,
    required: true,
    default: "get",
    displayOptions: {
        show: {
            resource: ["entity"],
        },
    },
    options: [
        {
            name: "Get Entity",
            value: "get",
            description: "Get entity information (entity.get)",
            action: "Get entity information",
        },
        {
            name: "Add Entity",
            value: "add",
            description: "Add new entity (entity.add)",
            action: "Add new entity",
        },
        {
            name: "Update Entity",
            value: "update",
            description: "Update entity (entity.update)",
            action: "Update entity",
        },
        {
            name: "Delete Entity",
            value: "delete",
            description: "Delete entity (entity.delete)",
            action: "Delete entity",
        },
        {
            name: "Get Entity Rights",
            value: "getRights",
            description: "Get or change access permissions for the storage (entity.rights)",
            action: "Get or change entity rights",
        },
        {
            name: "Get Entity Sections",
            value: "getSections",
            description: "Get a list of storage sections (entity.section.get)",
            action: "Get entity sections",
        },
        {
            name: "Add Entity Section",
            value: "addSection",
            description: "Add a storage section (entity.section.add)",
            action: "Add entity section",
        },
        {
            name: "Update Entity Section",
            value: "updateSection",
            description: "Modify a storage section (entity.section.update)",
            action: "Update entity section",
        },
        {
            name: "Delete Entity Section",
            value: "deleteSection",
            description: "Delete a storage section (entity.section.delete)",
            action: "Delete entity section",
        },
        {
            name: "Get Entity Item",
            value: "getItem",
            description: "Get entity item (entity.item.get)",
            action: "Get entity item",
        },
        {
            name: "Add Entity Item",
            value: "addItem",
            description: "Add entity item (entity.item.add)",
            action: "Add entity item",
        },
        {
            name: "Update Entity Item",
            value: "updateItem",
            description: "Update entity item (entity.item.update)",
            action: "Update entity item",
        },
        {
            name: "Delete Entity Item",
            value: "deleteItem",
            description: "Delete entity item (entity.item.delete)",
            action: "Delete entity item",
        },
        {
            name: "Get Entity Item Properties",
            value: "getItemProperties",
            description: "Get a list of additional properties for storage items (entity.item.property.get)",
            action: "Get entity item properties",
        },
        {
            name: "Add Entity Item Property",
            value: "addItemProperty",
            description: "Add an additional property for storage items (entity.item.property.add)",
            action: "Add entity item property",
        },
        {
            name: "Update Entity Item Property",
            value: "updateItemProperty",
            description: "Modify an additional property for storage items (entity.item.property.update)",
            action: "Update entity item property",
        },
        {
            name: "Delete Entity Item Property",
            value: "deleteItemProperty",
            description: "Delete an additional property for storage items (entity.item.property.delete)",
            action: "Delete entity item property",
        },
    ],
};
// Entity ID Field
const entityIdField = {
    displayName: "Entity ID",
    name: "entityId",
    type: "string",
    required: true,
    default: "",
    description: "The ID of the entity",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: [
                "get",
                "update",
                "delete",
                "getItem",
                "getItems",
                "addItem",
                "updateItem",
                "deleteItem",
                "getItemFields",
            ],
        },
    },
};
// Entity Name Field
const entityNameField = {
    displayName: "Entity Name",
    name: "entityName",
    type: "string",
    required: true,
    default: "",
    description: "Name of the entity",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["add", "update"],
        },
    },
};
// Entity Code Field
const entityCodeField = {
    displayName: "Entity Code",
    name: "entityCode",
    type: "string",
    required: true,
    default: "",
    description: "Code of the entity",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["add", "update"],
        },
    },
};
// Entity Active Field
const entityActiveField = {
    displayName: "Entity Active",
    name: "entityActive",
    type: "boolean",
    default: true,
    description: "Whether the entity is active",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["add", "update"],
        },
    },
};
// Entity Sort Field
const entitySortField = {
    displayName: "Entity Sort Order",
    name: "entitySort",
    type: "number",
    default: 100,
    description: "Sort order of the entity",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["add", "update"],
        },
    },
};
// Entity Description Field
const entityDescriptionField = {
    displayName: "Entity Description",
    name: "entityDescription",
    type: "string",
    typeOptions: {
        rows: 3,
    },
    default: "",
    description: "Description of the entity",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["add", "update"],
        },
    },
};
// Item ID Field
const itemIdField = {
    displayName: "Item ID",
    name: "itemId",
    type: "string",
    required: true,
    default: "",
    description: "The ID of the entity item",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["getItem", "updateItem", "deleteItem"],
        },
    },
};
// Item Name Field
const itemNameField = {
    displayName: "Item Name",
    name: "itemName",
    type: "string",
    required: true,
    default: "",
    description: "Name of the entity item",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItem", "updateItem"],
        },
    },
};
// Item Active Field
const itemActiveField = {
    displayName: "Item Active",
    name: "itemActive",
    type: "boolean",
    default: true,
    description: "Whether the item is active",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItem", "updateItem"],
        },
    },
};
// Item Sort Field
const itemSortField = {
    displayName: "Item Sort Order",
    name: "itemSort",
    type: "number",
    default: 100,
    description: "Sort order of the item",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItem", "updateItem"],
        },
    },
};
// Item Description Field
const itemDescriptionField = {
    displayName: "Item Description",
    name: "itemDescription",
    type: "string",
    typeOptions: {
        rows: 3,
    },
    default: "",
    description: "Description of the item",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItem", "updateItem"],
        },
    },
};
// Item Properties Field
const itemPropertiesField = {
    displayName: "Item Properties",
    name: "itemProperties",
    type: "collection",
    placeholder: "Add Property",
    default: {},
    description: "Properties of the entity item",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItem", "updateItem"],
        },
    },
    options: [
        {
            displayName: "Property Values",
            name: "propertyValues",
            type: "json",
            default: "{}",
            description: "Property values in JSON format",
        },
    ],
};
// Section ID Field
const sectionIdField = {
    displayName: "Section ID",
    name: "sectionId",
    type: "string",
    required: true,
    default: "",
    description: "The ID of the entity section",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["updateSection", "deleteSection"],
        },
    },
};
// Section Name Field
const sectionNameField = {
    displayName: "Section Name",
    name: "sectionName",
    type: "string",
    required: true,
    default: "",
    description: "Name of the entity section",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addSection", "updateSection"],
        },
    },
};
// Section Code Field
const sectionCodeField = {
    displayName: "Section Code",
    name: "sectionCode",
    type: "string",
    required: true,
    default: "",
    description: "Code of the entity section",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addSection", "updateSection"],
        },
    },
};
// Section Active Field
const sectionActiveField = {
    displayName: "Section Active",
    name: "sectionActive",
    type: "boolean",
    default: true,
    description: "Whether the section is active",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addSection", "updateSection"],
        },
    },
};
// Section Sort Field
const sectionSortField = {
    displayName: "Section Sort Order",
    name: "sectionSort",
    type: "number",
    default: 100,
    description: "Sort order of the section",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addSection", "updateSection"],
        },
    },
};
// Section Description Field
const sectionDescriptionField = {
    displayName: "Section Description",
    name: "sectionDescription",
    type: "string",
    typeOptions: {
        rows: 3,
    },
    default: "",
    description: "Description of the section",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addSection", "updateSection"],
        },
    },
};
// Property ID Field
const propertyIdField = {
    displayName: "Property ID",
    name: "propertyId",
    type: "string",
    required: true,
    default: "",
    description: "The ID of the entity item property",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["updateItemProperty", "deleteItemProperty"],
        },
    },
};
// Property Name Field
const propertyNameField = {
    displayName: "Property Name",
    name: "propertyName",
    type: "string",
    required: true,
    default: "",
    description: "Name of the entity item property",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItemProperty", "updateItemProperty"],
        },
    },
};
// Property Code Field
const propertyCodeField = {
    displayName: "Property Code",
    name: "propertyCode",
    type: "string",
    required: true,
    default: "",
    description: "Code of the entity item property",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItemProperty", "updateItemProperty"],
        },
    },
};
// Property Type Field
const propertyTypeField = {
    displayName: "Property Type",
    name: "propertyType",
    type: "options",
    options: [
        { name: "String", value: "S" },
        { name: "Number", value: "N" },
        { name: "List", value: "L" },
        { name: "File", value: "F" },
        { name: "Date", value: "D" },
        { name: "DateTime", value: "DT" },
        { name: "HTML", value: "HTML" },
        { name: "Element", value: "E" },
        { name: "Gps", value: "G" },
        { name: "User", value: "U" },
    ],
    required: true,
    default: "S",
    description: "Type of the entity item property",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItemProperty", "updateItemProperty"],
        },
    },
};
// Property Required Field
const propertyRequiredField = {
    displayName: "Property Required",
    name: "propertyRequired",
    type: "boolean",
    default: false,
    description: "Whether the property is required",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItemProperty", "updateItemProperty"],
        },
    },
};
// Property Sort Field
const propertySortField = {
    displayName: "Property Sort Order",
    name: "propertySort",
    type: "number",
    default: 100,
    description: "Sort order of the property",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItemProperty", "updateItemProperty"],
        },
    },
};
// Property Multiple Field
const propertyMultipleField = {
    displayName: "Property Multiple",
    name: "propertyMultiple",
    type: "boolean",
    default: false,
    description: "Whether the property can have multiple values",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItemProperty", "updateItemProperty"],
        },
    },
};
// Property Active Field
const propertyActiveField = {
    displayName: "Property Active",
    name: "propertyActive",
    type: "boolean",
    default: true,
    description: "Whether the property is active",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItemProperty", "updateItemProperty"],
        },
    },
};
// Property Values Field
const propertyValuesField = {
    displayName: "Property Values",
    name: "propertyValues",
    type: "collection",
    placeholder: "Add Value",
    default: {},
    description: "Values for list-type properties",
    displayOptions: {
        show: {
            resource: ["entity"],
            operation: ["addItemProperty", "updateItemProperty"],
        },
    },
    options: [
        {
            displayName: "Values",
            name: "values",
            type: "string",
            typeOptions: {
                rows: 3,
            },
            default: "",
            description: "Comma-separated list of values",
        },
    ],
};
// Export all Entity operations and fields
exports.entityOperations = [
    {
        name: "Get Entity",
        value: "get",
        description: "Get entity information (entity.get)",
        action: "Get entity information",
    },
    {
        name: "Add Entity",
        value: "add",
        description: "Add new entity (entity.add)",
        action: "Add new entity",
    },
    {
        name: "Update Entity",
        value: "update",
        description: "Update entity (entity.update)",
        action: "Update entity",
    },
    {
        name: "Delete Entity",
        value: "delete",
        description: "Delete entity (entity.delete)",
        action: "Delete entity",
    },
    {
        name: "Get Entity Rights",
        value: "getRights",
        description: "Get or change access permissions for the storage (entity.rights)",
        action: "Get or change entity rights",
    },
    {
        name: "Get Entity Sections",
        value: "getSections",
        description: "Get a list of storage sections (entity.section.get)",
        action: "Get entity sections",
    },
    {
        name: "Add Entity Section",
        value: "addSection",
        description: "Add a storage section (entity.section.add)",
        action: "Add entity section",
    },
    {
        name: "Update Entity Section",
        value: "updateSection",
        description: "Modify a storage section (entity.section.update)",
        action: "Update entity section",
    },
    {
        name: "Delete Entity Section",
        value: "deleteSection",
        description: "Delete a storage section (entity.section.delete)",
        action: "Delete entity section",
    },
    {
        name: "Get Entity Item",
        value: "getItem",
        description: "Get entity item (entity.item.get)",
        action: "Get entity item",
    },
    {
        name: "Add Entity Item",
        value: "addItem",
        description: "Add entity item (entity.item.add)",
        action: "Add entity item",
    },
    {
        name: "Update Entity Item",
        value: "updateItem",
        description: "Update entity item (entity.item.update)",
        action: "Update entity item",
    },
    {
        name: "Delete Entity Item",
        value: "deleteItem",
        description: "Delete entity item (entity.item.delete)",
        action: "Delete entity item",
    },
    {
        name: "Get Entity Item Properties",
        value: "getItemProperties",
        description: "Get a list of additional properties for storage items (entity.item.property.get)",
        action: "Get entity item properties",
    },
    {
        name: "Add Entity Item Property",
        value: "addItemProperty",
        description: "Add an additional property for storage items (entity.item.property.add)",
        action: "Add entity item property",
    },
    {
        name: "Update Entity Item Property",
        value: "updateItemProperty",
        description: "Modify an additional property for storage items (entity.item.property.update)",
        action: "Update entity item property",
    },
    {
        name: "Delete Entity Item Property",
        value: "deleteItemProperty",
        description: "Delete an additional property for storage items (entity.item.property.delete)",
        action: "Delete entity item property",
    },
];
exports.entityFields = [
    operationField,
    entityIdField,
    entityNameField,
    entityCodeField,
    entityActiveField,
    entitySortField,
    entityDescriptionField,
    sectionIdField,
    sectionNameField,
    sectionCodeField,
    sectionActiveField,
    sectionSortField,
    sectionDescriptionField,
    itemIdField,
    itemNameField,
    itemActiveField,
    itemSortField,
    itemDescriptionField,
    itemPropertiesField,
    propertyIdField,
    propertyNameField,
    propertyCodeField,
    propertyTypeField,
    propertyRequiredField,
    propertySortField,
    propertyMultipleField,
    propertyActiveField,
    propertyValuesField,
];
//# sourceMappingURL=EntityDescription.js.map