@forestadmin/datasource-zendesk 1.0.0

package/dist/collections/ticket/schema-definition.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TICKET_COMMENT_THREAD_SCHEMA = exports.TICKET_SORTABLE = void 0;
+exports.getTicketFieldSchemas = getTicketFieldSchemas;
+const datasource_1 = require("../../datasource");
+const enums_1 = require("../../enums");
+const base_zendesk_collection_1 = require("../base-zendesk-collection");
+exports.TICKET_SORTABLE = {
+    updated_at: 'updated_at',
+    created_at: 'created_at',
+    priority: 'priority',
+    status: 'status',
+    ticket_type: 'ticket_type',
+};
+exports.TICKET_COMMENT_THREAD_SCHEMA = {
+    id: 'Number',
+    body: 'String',
+    html_body: 'String',
+    public: 'Boolean',
+    author_email: 'String',
+    author_name: 'String',
+    created_at: 'Date',
+};
+function getTicketFieldSchemas() {
+    return {
+        id: {
+            type: 'Column',
+            columnType: 'Number',
+            isPrimaryKey: true,
+            isReadOnly: true,
+            isSortable: false,
+            filterOperators: new Set(base_zendesk_collection_1.ID_OPS),
+        },
+        subject: {
+            type: 'Column',
+            columnType: 'String',
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        description: {
+            type: 'Column',
+            columnType: 'String',
+            filterOperators: new Set(),
+        },
+        status: {
+            type: 'Column',
+            columnType: 'Enum',
+            enumValues: [...enums_1.TICKET_STATUSES],
+            isSortable: true,
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        priority: {
+            type: 'Column',
+            columnType: 'Enum',
+            enumValues: [...enums_1.TICKET_PRIORITIES],
+            isSortable: true,
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        ticket_type: {
+            type: 'Column',
+            columnType: 'Enum',
+            enumValues: [...enums_1.TICKET_TYPES],
+            isSortable: true,
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        requester_id: {
+            type: 'Column',
+            columnType: 'Number',
+            filterOperators: new Set(base_zendesk_collection_1.NUMBER_OPS),
+        },
+        assignee_id: {
+            type: 'Column',
+            columnType: 'Number',
+            filterOperators: new Set(base_zendesk_collection_1.NUMBER_OPS),
+        },
+        group_id: {
+            type: 'Column',
+            columnType: 'Number',
+            filterOperators: new Set(base_zendesk_collection_1.NUMBER_OPS),
+        },
+        organization_id: {
+            type: 'Column',
+            columnType: 'Number',
+            filterOperators: new Set(base_zendesk_collection_1.NUMBER_OPS),
+        },
+        external_id: {
+            type: 'Column',
+            columnType: 'String',
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        requester_email: {
+            type: 'Column',
+            columnType: 'String',
+            isReadOnly: true,
+            filterOperators: new Set(['Equal']),
+        },
+        tags: {
+            type: 'Column',
+            columnType: ['String'],
+            filterOperators: new Set(),
+        },
+        url: {
+            type: 'Column',
+            columnType: 'String',
+            isReadOnly: true,
+            filterOperators: new Set(),
+        },
+        created_at: {
+            type: 'Column',
+            columnType: 'Date',
+            isReadOnly: true,
+            isSortable: true,
+            filterOperators: new Set(base_zendesk_collection_1.DATE_OPS),
+        },
+        updated_at: {
+            type: 'Column',
+            columnType: 'Date',
+            isReadOnly: true,
+            isSortable: true,
+            filterOperators: new Set(base_zendesk_collection_1.DATE_OPS),
+        },
+        comments: {
+            type: 'Column',
+            columnType: [exports.TICKET_COMMENT_THREAD_SCHEMA],
+            isReadOnly: true,
+            filterOperators: new Set(),
+        },
+        requester: {
+            type: 'ManyToOne',
+            foreignCollection: datasource_1.COLLECTION_NAMES.user,
+            foreignKey: 'requester_id',
+            foreignKeyTarget: 'id',
+        },
+        assignee: {
+            type: 'ManyToOne',
+            foreignCollection: datasource_1.COLLECTION_NAMES.user,
+            foreignKey: 'assignee_id',
+            foreignKeyTarget: 'id',
+        },
+        organization: {
+            type: 'ManyToOne',
+            foreignCollection: datasource_1.COLLECTION_NAMES.organization,
+            foreignKey: 'organization_id',
+            foreignKeyTarget: 'id',
+        },
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hLWRlZmluaXRpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29sbGVjdGlvbnMvdGlja2V0L3NjaGVtYS1kZWZpbml0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQXdCQSxzREEwSEM7QUFoSkQsaURBQW9EO0FBQ3BELHVDQUErRTtBQUMvRSx3RUFBc0Y7QUFFekUsUUFBQSxlQUFlLEdBQTJCO0lBQ3JELFVBQVUsRUFBRSxZQUFZO0lBQ3hCLFVBQVUsRUFBRSxZQUFZO0lBQ3hCLFFBQVEsRUFBRSxVQUFVO0lBQ3BCLE1BQU0sRUFBRSxRQUFRO0lBQ2hCLFdBQVcsRUFBRSxhQUFhO0NBQzNCLENBQUM7QUFFVyxRQUFBLDRCQUE0QixHQUFHO0lBQzFDLEVBQUUsRUFBRSxRQUFRO0lBQ1osSUFBSSxFQUFFLFFBQVE7SUFDZCxTQUFTLEVBQUUsUUFBUTtJQUNuQixNQUFNLEVBQUUsU0FBUztJQUNqQixZQUFZLEVBQUUsUUFBUTtJQUN0QixXQUFXLEVBQUUsUUFBUTtJQUNyQixVQUFVLEVBQUUsTUFBTTtDQUNWLENBQUM7QUFFWCxTQUFnQixxQkFBcUI7SUFDbkMsT0FBTztRQUNMLEVBQUUsRUFBRTtZQUNGLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLFFBQVE7WUFDcEIsWUFBWSxFQUFFLElBQUk7WUFDbEIsVUFBVSxFQUFFLElBQUk7WUFDaEIsVUFBVSxFQUFFLEtBQUs7WUFDakIsZUFBZSxFQUFFLElBQUksR0FBRyxDQUFDLGdDQUFNLENBQUM7U0FDakM7UUFDRCxPQUFPLEVBQUU7WUFDUCxJQUFJLEVBQUUsUUFBUTtZQUNkLFVBQVUsRUFBRSxRQUFRO1lBQ3BCLGVBQWUsRUFBRSxJQUFJLEdBQUcsQ0FBQyxvQ0FBVSxDQUFDO1NBQ3JDO1FBQ0QsV0FBVyxFQUFFO1lBQ1gsSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsUUFBUTtZQUNwQixlQUFlLEVBQUUsSUFBSSxHQUFHLEVBQUU7U0FDM0I7UUFDRCxNQUFNLEVBQUU7WUFDTixJQUFJLEVBQUUsUUFBUTtZQUNkLFVBQVUsRUFBRSxNQUFNO1lBQ2xCLFVBQVUsRUFBRSxDQUFDLEdBQUcsdUJBQWUsQ0FBQztZQUNoQyxVQUFVLEVBQUUsSUFBSTtZQUNoQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMsb0NBQVUsQ0FBQztTQUNyQztRQUNELFFBQVEsRUFBRTtZQUNSLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLE1BQU07WUFDbEIsVUFBVSxFQUFFLENBQUMsR0FBRyx5QkFBaUIsQ0FBQztZQUNsQyxVQUFVLEVBQUUsSUFBSTtZQUNoQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMsb0NBQVUsQ0FBQztTQUNyQztRQUNELFdBQVcsRUFBRTtZQUNYLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLE1BQU07WUFDbEIsVUFBVSxFQUFFLENBQUMsR0FBRyxvQkFBWSxDQUFDO1lBQzdCLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLGVBQWUsRUFBRSxJQUFJLEdBQUcsQ0FBQyxvQ0FBVSxDQUFDO1NBQ3JDO1FBQ0QsWUFBWSxFQUFFO1lBQ1osSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsUUFBUTtZQUNwQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMsb0NBQVUsQ0FBQztTQUNyQztRQUNELFdBQVcsRUFBRTtZQUNYLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLFFBQVE7WUFDcEIsZUFBZSxFQUFFLElBQUksR0FBRyxDQUFDLG9DQUFVLENBQUM7U0FDckM7UUFDRCxRQUFRLEVBQUU7WUFDUixJQUFJLEVBQUUsUUFBUTtZQUNkLFVBQVUsRUFBRSxRQUFRO1lBQ3BCLGVBQWUsRUFBRSxJQUFJLEdBQUcsQ0FBQyxvQ0FBVSxDQUFDO1NBQ3JDO1FBQ0QsZUFBZSxFQUFFO1lBQ2YsSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsUUFBUTtZQUNwQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMsb0NBQVUsQ0FBQztTQUNyQztRQUNELFdBQVcsRUFBRTtZQUNYLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLFFBQVE7WUFDcEIsZUFBZSxFQUFFLElBQUksR0FBRyxDQUFDLG9DQUFVLENBQUM7U0FDckM7UUFDRCxlQUFlLEVBQUU7WUFDZixJQUFJLEVBQUUsUUFBUTtZQUNkLFVBQVUsRUFBRSxRQUFRO1lBQ3BCLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLGVBQWUsRUFBRSxJQUFJLEdBQUcsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1NBQ3BDO1FBQ0QsSUFBSSxFQUFFO1lBQ0osSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsQ0FBQyxRQUFRLENBQUM7WUFDdEIsZUFBZSxFQUFFLElBQUksR0FBRyxFQUFFO1NBQzNCO1FBQ0QsR0FBRyxFQUFFO1lBQ0gsSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsUUFBUTtZQUNwQixVQUFVLEVBQUUsSUFBSTtZQUNoQixlQUFlLEVBQUUsSUFBSSxHQUFHLEVBQUU7U0FDM0I7UUFDRCxVQUFVLEVBQUU7WUFDVixJQUFJLEVBQUUsUUFBUTtZQUNkLFVBQVUsRUFBRSxNQUFNO1lBQ2xCLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLGVBQWUsRUFBRSxJQUFJLEdBQUcsQ0FBQyxrQ0FBUSxDQUFDO1NBQ25DO1FBQ0QsVUFBVSxFQUFFO1lBQ1YsSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsTUFBTTtZQUNsQixVQUFVLEVBQUUsSUFBSTtZQUNoQixVQUFVLEVBQUUsSUFBSTtZQUNoQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMsa0NBQVEsQ0FBQztTQUNuQztRQUNELFFBQVEsRUFBRTtZQUNSLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLENBQUMsb0NBQTRCLENBQUM7WUFDMUMsVUFBVSxFQUFFLElBQUk7WUFDaEIsZUFBZSxFQUFFLElBQUksR0FBRyxFQUFFO1NBQzNCO1FBQ0QsU0FBUyxFQUFFO1lBQ1QsSUFBSSxFQUFFLFdBQVc7WUFDakIsaUJBQWlCLEVBQUUsNkJBQWdCLENBQUMsSUFBSTtZQUN4QyxVQUFVLEVBQUUsY0FBYztZQUMxQixnQkFBZ0IsRUFBRSxJQUFJO1NBQ3ZCO1FBQ0QsUUFBUSxFQUFFO1lBQ1IsSUFBSSxFQUFFLFdBQVc7WUFDakIsaUJBQWlCLEVBQUUsNkJBQWdCLENBQUMsSUFBSTtZQUN4QyxVQUFVLEVBQUUsYUFBYTtZQUN6QixnQkFBZ0IsRUFBRSxJQUFJO1NBQ3ZCO1FBQ0QsWUFBWSxFQUFFO1lBQ1osSUFBSSxFQUFFLFdBQVc7WUFDakIsaUJBQWlCLEVBQUUsNkJBQWdCLENBQUMsWUFBWTtZQUNoRCxVQUFVLEVBQUUsaUJBQWlCO1lBQzdCLGdCQUFnQixFQUFFLElBQUk7U0FDdkI7S0FDRixDQUFDO0FBQ0osQ0FBQyJ9

package/dist/collections/ticket/serializer.d.ts

@@ -0,0 +1,15 @@
+import type { ZendeskRecord } from '../../types';
+import type { RecordData } from '@forestadmin/datasource-toolkit';
+/**
+ * Map a raw Zendesk ticket payload to the Forest column layout exposed by TicketCollection.
+ *
+ * - Zendesk's `type` field is renamed `ticket_type` to avoid collision with the JS keyword.
+ * - Custom fields (`custom_fields: [{ id, value }]`) are flattened to columns named via the
+ *   `customFieldIdToColumnName` map. Unknown custom field ids are silently ignored.
+ * - `requester_email` is provided by the caller through `emails` because the raw ticket
+ *   payload only carries `requester_id`.
+ */
+export declare function serializeTicket(ticket: ZendeskRecord, emails: Map<number, string>, customFieldIdToColumnName: Map<number, string>): RecordData;
+export declare function serializeUser(user: ZendeskRecord): RecordData;
+export declare function serializeOrganization(organization: ZendeskRecord): RecordData;
+//# sourceMappingURL=serializer.d.ts.map

package/dist/collections/ticket/serializer.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeTicket = serializeTicket;
+exports.serializeUser = serializeUser;
+exports.serializeOrganization = serializeOrganization;
+const TICKET_BASE_FIELDS = [
+    'id',
+    'subject',
+    'description',
+    'status',
+    'priority',
+    'requester_id',
+    'assignee_id',
+    'group_id',
+    'organization_id',
+    'external_id',
+    'tags',
+    'url',
+    'created_at',
+    'updated_at',
+];
+/**
+ * Map a raw Zendesk ticket payload to the Forest column layout exposed by TicketCollection.
+ *
+ * - Zendesk's `type` field is renamed `ticket_type` to avoid collision with the JS keyword.
+ * - Custom fields (`custom_fields: [{ id, value }]`) are flattened to columns named via the
+ *   `customFieldIdToColumnName` map. Unknown custom field ids are silently ignored.
+ * - `requester_email` is provided by the caller through `emails` because the raw ticket
+ *   payload only carries `requester_id`.
+ */
+function serializeTicket(ticket, emails, customFieldIdToColumnName) {
+    const record = {};
+    for (const key of TICKET_BASE_FIELDS) {
+        if (ticket[key] !== undefined)
+            record[key] = ticket[key];
+    }
+    record.ticket_type = ticket.type ?? null;
+    const requesterId = ticket.requester_id;
+    if (typeof requesterId === 'number' && emails.has(requesterId)) {
+        record.requester_email = emails.get(requesterId);
+    }
+    else {
+        record.requester_email = null;
+    }
+    const rawCustomFields = Array.isArray(ticket.custom_fields)
+        ? ticket.custom_fields
+        : [];
+    for (const entry of rawCustomFields) {
+        const columnName = customFieldIdToColumnName.get(entry.id);
+        if (columnName)
+            record[columnName] = entry.value;
+    }
+    return record;
+}
+function serializeUser(user) {
+    const record = {
+        id: user.id,
+        email: user.email,
+        name: user.name,
+        role: user.role,
+        phone: user.phone,
+        organization_id: user.organization_id,
+        time_zone: user.time_zone,
+        locale: user.locale,
+        verified: user.verified,
+        suspended: user.suspended,
+        created_at: user.created_at,
+        updated_at: user.updated_at,
+    };
+    const userFields = (user.user_fields ?? {});
+    for (const [key, value] of Object.entries(userFields)) {
+        if (record[key] === undefined)
+            record[key] = value;
+    }
+    return record;
+}
+function serializeOrganization(organization) {
+    const record = {
+        id: organization.id,
+        name: organization.name,
+        domain_names: organization.domain_names,
+        details: organization.details,
+        notes: organization.notes,
+        group_id: organization.group_id,
+        shared_tickets: organization.shared_tickets,
+        created_at: organization.created_at,
+        updated_at: organization.updated_at,
+    };
+    const orgFields = (organization.organization_fields ?? {});
+    for (const [key, value] of Object.entries(orgFields)) {
+        if (record[key] === undefined)
+            record[key] = value;
+    }
+    return record;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VyaWFsaXplci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb2xsZWN0aW9ucy90aWNrZXQvc2VyaWFsaXplci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQTZCQSwwQ0ErQkM7QUFFRCxzQ0F1QkM7QUFFRCxzREFvQkM7QUF4R0QsTUFBTSxrQkFBa0IsR0FBRztJQUN6QixJQUFJO0lBQ0osU0FBUztJQUNULGFBQWE7SUFDYixRQUFRO0lBQ1IsVUFBVTtJQUNWLGNBQWM7SUFDZCxhQUFhO0lBQ2IsVUFBVTtJQUNWLGlCQUFpQjtJQUNqQixhQUFhO0lBQ2IsTUFBTTtJQUNOLEtBQUs7SUFDTCxZQUFZO0lBQ1osWUFBWTtDQUNiLENBQUM7QUFFRjs7Ozs7Ozs7R0FRRztBQUNILFNBQWdCLGVBQWUsQ0FDN0IsTUFBcUIsRUFDckIsTUFBMkIsRUFDM0IseUJBQThDO0lBRTlDLE1BQU0sTUFBTSxHQUFlLEVBQUUsQ0FBQztJQUU5QixLQUFLLE1BQU0sR0FBRyxJQUFJLGtCQUFrQixFQUFFLENBQUM7UUFDckMsSUFBSSxNQUFNLENBQUMsR0FBRyxDQUFDLEtBQUssU0FBUztZQUFFLE1BQU0sQ0FBQyxHQUFHLENBQUMsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUF1QixDQUFDO0lBQ2pGLENBQUM7SUFFRCxNQUFNLENBQUMsV0FBVyxHQUFJLE1BQU0sQ0FBQyxJQUEyQixJQUFJLElBQUksQ0FBQztJQUVqRSxNQUFNLFdBQVcsR0FBRyxNQUFNLENBQUMsWUFBWSxDQUFDO0lBRXhDLElBQUksT0FBTyxXQUFXLEtBQUssUUFBUSxJQUFJLE1BQU0sQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLEVBQUUsQ0FBQztRQUMvRCxNQUFNLENBQUMsZUFBZSxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDbkQsQ0FBQztTQUFNLENBQUM7UUFDTixNQUFNLENBQUMsZUFBZSxHQUFHLElBQUksQ0FBQztJQUNoQyxDQUFDO0lBRUQsTUFBTSxlQUFlLEdBQUcsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsYUFBYSxDQUFDO1FBQ3pELENBQUMsQ0FBRSxNQUFNLENBQUMsYUFBdUQ7UUFDakUsQ0FBQyxDQUFDLEVBQUUsQ0FBQztJQUVQLEtBQUssTUFBTSxLQUFLLElBQUksZUFBZSxFQUFFLENBQUM7UUFDcEMsTUFBTSxVQUFVLEdBQUcseUJBQXlCLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUMzRCxJQUFJLFVBQVU7WUFBRSxNQUFNLENBQUMsVUFBVSxDQUFDLEdBQUcsS0FBSyxDQUFDLEtBQTJCLENBQUM7SUFDekUsQ0FBQztJQUVELE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUM7QUFFRCxTQUFnQixhQUFhLENBQUMsSUFBbUI7SUFDL0MsTUFBTSxNQUFNLEdBQWU7UUFDekIsRUFBRSxFQUFFLElBQUksQ0FBQyxFQUF3QjtRQUNqQyxLQUFLLEVBQUUsSUFBSSxDQUFDLEtBQTJCO1FBQ3ZDLElBQUksRUFBRSxJQUFJLENBQUMsSUFBMEI7UUFDckMsSUFBSSxFQUFFLElBQUksQ0FBQyxJQUEwQjtRQUNyQyxLQUFLLEVBQUUsSUFBSSxDQUFDLEtBQTJCO1FBQ3ZDLGVBQWUsRUFBRSxJQUFJLENBQUMsZUFBcUM7UUFDM0QsU0FBUyxFQUFFLElBQUksQ0FBQyxTQUErQjtRQUMvQyxNQUFNLEVBQUUsSUFBSSxDQUFDLE1BQTRCO1FBQ3pDLFFBQVEsRUFBRSxJQUFJLENBQUMsUUFBOEI7UUFDN0MsU0FBUyxFQUFFLElBQUksQ0FBQyxTQUErQjtRQUMvQyxVQUFVLEVBQUUsSUFBSSxDQUFDLFVBQWdDO1FBQ2pELFVBQVUsRUFBRSxJQUFJLENBQUMsVUFBZ0M7S0FDbEQsQ0FBQztJQUVGLE1BQU0sVUFBVSxHQUFHLENBQUMsSUFBSSxDQUFDLFdBQVcsSUFBSSxFQUFFLENBQTRCLENBQUM7SUFFdkUsS0FBSyxNQUFNLENBQUMsR0FBRyxFQUFFLEtBQUssQ0FBQyxJQUFJLE1BQU0sQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLEVBQUUsQ0FBQztRQUN0RCxJQUFJLE1BQU0sQ0FBQyxHQUFHLENBQUMsS0FBSyxTQUFTO1lBQUUsTUFBTSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEtBQTJCLENBQUM7SUFDM0UsQ0FBQztJQUVELE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUM7QUFFRCxTQUFnQixxQkFBcUIsQ0FBQyxZQUEyQjtJQUMvRCxNQUFNLE1BQU0sR0FBZTtRQUN6QixFQUFFLEVBQUUsWUFBWSxDQUFDLEVBQXdCO1FBQ3pDLElBQUksRUFBRSxZQUFZLENBQUMsSUFBMEI7UUFDN0MsWUFBWSxFQUFFLFlBQVksQ0FBQyxZQUFrQztRQUM3RCxPQUFPLEVBQUUsWUFBWSxDQUFDLE9BQTZCO1FBQ25ELEtBQUssRUFBRSxZQUFZLENBQUMsS0FBMkI7UUFDL0MsUUFBUSxFQUFFLFlBQVksQ0FBQyxRQUE4QjtRQUNyRCxjQUFjLEVBQUUsWUFBWSxDQUFDLGNBQW9DO1FBQ2pFLFVBQVUsRUFBRSxZQUFZLENBQUMsVUFBZ0M7UUFDekQsVUFBVSxFQUFFLFlBQVksQ0FBQyxVQUFnQztLQUMxRCxDQUFDO0lBRUYsTUFBTSxTQUFTLEdBQUcsQ0FBQyxZQUFZLENBQUMsbUJBQW1CLElBQUksRUFBRSxDQUE0QixDQUFDO0lBRXRGLEtBQUssTUFBTSxDQUFDLEdBQUcsRUFBRSxLQUFLLENBQUMsSUFBSSxNQUFNLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUM7UUFDckQsSUFBSSxNQUFNLENBQUMsR0FBRyxDQUFDLEtBQUssU0FBUztZQUFFLE1BQU0sQ0FBQyxHQUFHLENBQUMsR0FBRyxLQUEyQixDQUFDO0lBQzNFLENBQUM7SUFFRCxPQUFPLE1BQU0sQ0FBQztBQUNoQixDQUFDIn0=

package/dist/collections/ticket-collection.d.ts

@@ -0,0 +1,18 @@
+import type { ZendeskClient } from '../client';
+import type { CustomFieldEntry, ZendeskRecord } from '../types';
+import type { Caller, DataSource, Filter, Logger, PaginatedFilter, Projection, RecordData } from '@forestadmin/datasource-toolkit';
+import BaseZendeskCollection from './base-zendesk-collection';
+export default class TicketCollection extends BaseZendeskCollection {
+    private readonly customFields;
+    constructor(datasource: DataSource, client: ZendeskClient, customFields: CustomFieldEntry[], logger?: Logger);
+    list(caller: Caller, filter: PaginatedFilter, projection: Projection): Promise<RecordData[]>;
+    create(caller: Caller, data: RecordData[]): Promise<RecordData[]>;
+    update(caller: Caller, filter: Filter, patch: RecordData): Promise<void>;
+    delete(caller: Caller, filter: Filter): Promise<void>;
+    protected findOne(id: number | string): Promise<ZendeskRecord | null>;
+    protected serializeRecord(record: ZendeskRecord): RecordData;
+    protected serializeForFilter(records: ZendeskRecord[]): Promise<RecordData[]>;
+    private filtersOnRequesterEmail;
+    private buildPayload;
+}
+//# sourceMappingURL=ticket-collection.d.ts.map

package/dist/collections/ticket-collection.js

@@ -0,0 +1,139 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const datasource_1 = require("../datasource");
+const base_zendesk_collection_1 = __importDefault(require("./base-zendesk-collection"));
+const comments_embedder_1 = require("./ticket/comments-embedder");
+const relation_embedder_1 = require("./ticket/relation-embedder");
+const schema_definition_1 = require("./ticket/schema-definition");
+const serializer_1 = require("./ticket/serializer");
+const READ_ONLY_INPUTS = new Set([
+    'id',
+    'url',
+    'created_at',
+    'updated_at',
+    'requester_email',
+    'comments',
+    'requester',
+    'assignee',
+    'organization',
+]);
+function collectIds(records, field) {
+    const ids = [];
+    for (const record of records) {
+        const value = record[field];
+        if (typeof value === 'number')
+            ids.push(value);
+        else if (typeof value === 'string' && !Number.isNaN(Number(value)))
+            ids.push(Number(value));
+    }
+    return Array.from(new Set(ids));
+}
+class TicketCollection extends base_zendesk_collection_1.default {
+    constructor(datasource, client, customFields, logger) {
+        super(datasource_1.COLLECTION_NAMES.ticket, datasource, client, 'ticket', schema_definition_1.TICKET_SORTABLE, logger);
+        this.customFields = customFields;
+        this.addFields((0, schema_definition_1.getTicketFieldSchemas)());
+        this.addCustomFields(customFields);
+    }
+    async list(caller, filter, projection) {
+        const ids = this.extractIdLookup(filter?.conditionTree);
+        const tickets = ids ? await this.fetchRecordsByIds(ids) : await this.searchRecords(filter);
+        const needsEmail = projection.includes('requester_email') ||
+            (ids !== null && this.filtersOnRequesterEmail(filter));
+        const emails = needsEmail
+            ? await this.client.fetchUserEmails(collectIds(tickets, 'requester_id'))
+            : new Map();
+        let records = tickets.map(ticket => (0, serializer_1.serializeTicket)(ticket, emails, this.zendeskIdToColumnName));
+        // The id-lookup path bypassed Zendesk Search, so honor the filter, sort and pagination here.
+        if (ids)
+            records = this.refine(records, filter, caller.timezone);
+        const relations = (0, relation_embedder_1.findRequestedRelations)(projection);
+        if (relations.requester || relations.assignee || relations.organization) {
+            await (0, relation_embedder_1.embedRelations)(records, relations, this.client);
+        }
+        if ((0, comments_embedder_1.isCommentsRequested)(projection)) {
+            await (0, comments_embedder_1.embedComments)(records, this.client);
+        }
+        return projection.apply(records);
+    }
+    async create(caller, data) {
+        const created = [];
+        for (const item of data) {
+            // eslint-disable-next-line no-await-in-loop
+            const raw = await this.client.createTicket(this.buildPayload(item, { onCreate: true }));
+            created.push((0, serializer_1.serializeTicket)(raw, new Map(), this.zendeskIdToColumnName));
+        }
+        return created;
+    }
+    async update(caller, filter, patch) {
+        const ids = await this.resolveIds(filter, caller.timezone);
+        const payload = this.buildPayload(patch, { onCreate: false });
+        for (const id of ids) {
+            // eslint-disable-next-line no-await-in-loop
+            await this.client.updateTicket(id, payload);
+        }
+    }
+    async delete(caller, filter) {
+        const ids = await this.resolveIds(filter, caller.timezone);
+        for (const id of ids) {
+            // eslint-disable-next-line no-await-in-loop
+            await this.client.deleteTicket(id);
+        }
+    }
+    findOne(id) {
+        return this.client.findTicket(id);
+    }
+    serializeRecord(record) {
+        return (0, serializer_1.serializeTicket)(record, new Map(), this.zendeskIdToColumnName);
+    }
+    // Resolve requester_email so scope/segment conditions on it are honored when filtering in memory.
+    async serializeForFilter(records) {
+        const emails = await this.client.fetchUserEmails(collectIds(records, 'requester_id'));
+        return records.map(record => (0, serializer_1.serializeTicket)(record, emails, this.zendeskIdToColumnName));
+    }
+    // ===== Helpers =====
+    filtersOnRequesterEmail(filter) {
+        return filter?.conditionTree?.someLeaf(leaf => leaf.field === 'requester_email') ?? false;
+    }
+    buildPayload(data, { onCreate }) {
+        const payload = {};
+        const customFields = [];
+        for (const [key, value] of Object.entries(data)) {
+            if (READ_ONLY_INPUTS.has(key)) {
+                // ignore read-only inputs
+            }
+            else if (key === 'description') {
+                // Zendesk derives `description` from the first comment; it can only be set at creation.
+                if (onCreate) {
+                    payload.description = value;
+                }
+                else {
+                    this.logger?.('Warn', `[datasource-zendesk] 'description' cannot be edited after creation; ignoring it.`);
+                }
+            }
+            else if (key === 'ticket_type') {
+                payload.type = value;
+            }
+            else {
+                const ticketCustomField = this.customFields.find(cf => cf.columnName === key);
+                if (ticketCustomField) {
+                    customFields.push({ id: ticketCustomField.zendeskId, value });
+                }
+                else {
+                    payload[key] = value;
+                }
+            }
+        }
+        if (customFields.length > 0)
+            payload.custom_fields = customFields;
+        if (onCreate && typeof data.description === 'string') {
+            payload.comment = { body: data.description };
+        }
+        return payload;
+    }
+}
+exports.default = TicketCollection;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGlja2V0LWNvbGxlY3Rpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29sbGVjdGlvbnMvdGlja2V0LWNvbGxlY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFZQSw4Q0FBaUQ7QUFDakQsd0ZBQThEO0FBQzlELGtFQUFnRjtBQUNoRixrRUFBb0Y7QUFDcEYsa0VBQW9GO0FBQ3BGLG9EQUFzRDtBQUV0RCxNQUFNLGdCQUFnQixHQUFHLElBQUksR0FBRyxDQUFDO0lBQy9CLElBQUk7SUFDSixLQUFLO0lBQ0wsWUFBWTtJQUNaLFlBQVk7SUFDWixpQkFBaUI7SUFDakIsVUFBVTtJQUNWLFdBQVc7SUFDWCxVQUFVO0lBQ1YsY0FBYztDQUNmLENBQUMsQ0FBQztBQUVILFNBQVMsVUFBVSxDQUFDLE9BQXdCLEVBQUUsS0FBYTtJQUN6RCxNQUFNLEdBQUcsR0FBYSxFQUFFLENBQUM7SUFFekIsS0FBSyxNQUFNLE1BQU0sSUFBSSxPQUFPLEVBQUUsQ0FBQztRQUM3QixNQUFNLEtBQUssR0FBRyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDNUIsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRO1lBQUUsR0FBRyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQzthQUMxQyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO1lBQUUsR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQztJQUM5RixDQUFDO0lBRUQsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7QUFDbEMsQ0FBQztBQUVELE1BQXFCLGdCQUFpQixTQUFRLGlDQUFxQjtJQUdqRSxZQUNFLFVBQXNCLEVBQ3RCLE1BQXFCLEVBQ3JCLFlBQWdDLEVBQ2hDLE1BQWU7UUFFZixLQUFLLENBQUMsNkJBQWdCLENBQUMsTUFBTSxFQUFFLFVBQVUsRUFBRSxNQUFNLEVBQUUsUUFBUSxFQUFFLG1DQUFlLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDdEYsSUFBSSxDQUFDLFlBQVksR0FBRyxZQUFZLENBQUM7UUFFakMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFBLHlDQUFxQixHQUFFLENBQUMsQ0FBQztRQUN4QyxJQUFJLENBQUMsZUFBZSxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBQ3JDLENBQUM7SUFFUSxLQUFLLENBQUMsSUFBSSxDQUNqQixNQUFjLEVBQ2QsTUFBdUIsRUFDdkIsVUFBc0I7UUFFdEIsTUFBTSxHQUFHLEdBQUcsSUFBSSxDQUFDLGVBQWUsQ0FBQyxNQUFNLEVBQUUsYUFBYSxDQUFDLENBQUM7UUFDeEQsTUFBTSxPQUFPLEdBQUcsR0FBRyxDQUFDLENBQUMsQ0FBQyxNQUFNLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxJQUFJLENBQUMsYUFBYSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBRTNGLE1BQU0sVUFBVSxHQUNkLFVBQVUsQ0FBQyxRQUFRLENBQUMsaUJBQWlCLENBQUM7WUFDdEMsQ0FBQyxHQUFHLEtBQUssSUFBSSxJQUFJLElBQUksQ0FBQyx1QkFBdUIsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1FBQ3pELE1BQU0sTUFBTSxHQUFHLFVBQVU7WUFDdkIsQ0FBQyxDQUFDLE1BQU0sSUFBSSxDQUFDLE1BQU0sQ0FBQyxlQUFlLENBQUMsVUFBVSxDQUFDLE9BQU8sRUFBRSxjQUFjLENBQUMsQ0FBQztZQUN4RSxDQUFDLENBQUMsSUFBSSxHQUFHLEVBQWtCLENBQUM7UUFFOUIsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUNqQyxJQUFBLDRCQUFlLEVBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMscUJBQXFCLENBQUMsQ0FDNUQsQ0FBQztRQUVGLDZGQUE2RjtRQUM3RixJQUFJLEdBQUc7WUFBRSxPQUFPLEdBQUcsSUFBSSxDQUFDLE1BQU0sQ0FBQyxPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUVqRSxNQUFNLFNBQVMsR0FBRyxJQUFBLDBDQUFzQixFQUFDLFVBQVUsQ0FBQyxDQUFDO1FBRXJELElBQUksU0FBUyxDQUFDLFNBQVMsSUFBSSxTQUFTLENBQUMsUUFBUSxJQUFJLFNBQVMsQ0FBQyxZQUFZLEVBQUUsQ0FBQztZQUN4RSxNQUFNLElBQUEsa0NBQWMsRUFBQyxPQUFPLEVBQUUsU0FBUyxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUN4RCxDQUFDO1FBRUQsSUFBSSxJQUFBLHVDQUFtQixFQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUM7WUFDcEMsTUFBTSxJQUFBLGlDQUFhLEVBQUMsT0FBTyxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUM1QyxDQUFDO1FBRUQsT0FBTyxVQUFVLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ25DLENBQUM7SUFFUSxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQWMsRUFBRSxJQUFrQjtRQUN0RCxNQUFNLE9BQU8sR0FBaUIsRUFBRSxDQUFDO1FBRWpDLEtBQUssTUFBTSxJQUFJLElBQUksSUFBSSxFQUFFLENBQUM7WUFDeEIsNENBQTRDO1lBQzVDLE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBSSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxJQUFJLEVBQUUsRUFBRSxRQUFRLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDO1lBQ3hGLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBQSw0QkFBZSxFQUFDLEdBQUcsRUFBRSxJQUFJLEdBQUcsRUFBRSxFQUFFLElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUM7UUFDNUUsQ0FBQztRQUVELE9BQU8sT0FBTyxDQUFDO0lBQ2pCLENBQUM7SUFFUSxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQWMsRUFBRSxNQUFjLEVBQUUsS0FBaUI7UUFDckUsTUFBTSxHQUFHLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDM0QsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztRQUU5RCxLQUFLLE1BQU0sRUFBRSxJQUFJLEdBQUcsRUFBRSxDQUFDO1lBQ3JCLDRDQUE0QztZQUM1QyxNQUFNLElBQUksQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDLEVBQUUsRUFBRSxPQUFPLENBQUMsQ0FBQztRQUM5QyxDQUFDO0lBQ0gsQ0FBQztJQUVRLEtBQUssQ0FBQyxNQUFNLENBQUMsTUFBYyxFQUFFLE1BQWM7UUFDbEQsTUFBTSxHQUFHLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUM7UUFFM0QsS0FBSyxNQUFNLEVBQUUsSUFBSSxHQUFHLEVBQUUsQ0FBQztZQUNyQiw0Q0FBNEM7WUFDNUMsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUNyQyxDQUFDO0lBQ0gsQ0FBQztJQUVrQixPQUFPLENBQUMsRUFBbUI7UUFDNUMsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUNwQyxDQUFDO0lBRWtCLGVBQWUsQ0FBQyxNQUFxQjtRQUN0RCxPQUFPLElBQUEsNEJBQWUsRUFBQyxNQUFNLEVBQUUsSUFBSSxHQUFHLEVBQUUsRUFBRSxJQUFJLENBQUMscUJBQXFCLENBQUMsQ0FBQztJQUN4RSxDQUFDO0lBRUQsa0dBQWtHO0lBQy9FLEtBQUssQ0FBQyxrQkFBa0IsQ0FBQyxPQUF3QjtRQUNsRSxNQUFNLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxNQUFNLENBQUMsZUFBZSxDQUFDLFVBQVUsQ0FBQyxPQUFPLEVBQUUsY0FBYyxDQUFDLENBQUMsQ0FBQztRQUV0RixPQUFPLE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxJQUFBLDRCQUFlLEVBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMscUJBQXFCLENBQUMsQ0FBQyxDQUFDO0lBQzVGLENBQUM7SUFFRCxzQkFBc0I7SUFFZCx1QkFBdUIsQ0FBQyxNQUFtQztRQUNqRSxPQUFPLE1BQU0sRUFBRSxhQUFhLEVBQUUsUUFBUSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLEtBQUssS0FBSyxpQkFBaUIsQ0FBQyxJQUFJLEtBQUssQ0FBQztJQUM1RixDQUFDO0lBRU8sWUFBWSxDQUFDLElBQWdCLEVBQUUsRUFBRSxRQUFRLEVBQXlCO1FBQ3hFLE1BQU0sT0FBTyxHQUFrQixFQUFFLENBQUM7UUFDbEMsTUFBTSxZQUFZLEdBQTBDLEVBQUUsQ0FBQztRQUUvRCxLQUFLLE1BQU0sQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ2hELElBQUksZ0JBQWdCLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7Z0JBQzlCLDBCQUEwQjtZQUM1QixDQUFDO2lCQUFNLElBQUksR0FBRyxLQUFLLGFBQWEsRUFBRSxDQUFDO2dCQUNqQyx3RkFBd0Y7Z0JBQ3hGLElBQUksUUFBUSxFQUFFLENBQUM7b0JBQ2IsT0FBTyxDQUFDLFdBQVcsR0FBRyxLQUFLLENBQUM7Z0JBQzlCLENBQUM7cUJBQU0sQ0FBQztvQkFDTixJQUFJLENBQUMsTUFBTSxFQUFFLENBQ1gsTUFBTSxFQUNOLGtGQUFrRixDQUNuRixDQUFDO2dCQUNKLENBQUM7WUFDSCxDQUFDO2lCQUFNLElBQUksR0FBRyxLQUFLLGFBQWEsRUFBRSxDQUFDO2dCQUNqQyxPQUFPLENBQUMsSUFBSSxHQUFHLEtBQUssQ0FBQztZQUN2QixDQUFDO2lCQUFNLENBQUM7Z0JBQ04sTUFBTSxpQkFBaUIsR0FBRyxJQUFJLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxVQUFVLEtBQUssR0FBRyxDQUFDLENBQUM7Z0JBRTlFLElBQUksaUJBQWlCLEVBQUUsQ0FBQztvQkFDdEIsWUFBWSxDQUFDLElBQUksQ0FBQyxFQUFFLEVBQUUsRUFBRSxpQkFBaUIsQ0FBQyxTQUFTLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztnQkFDaEUsQ0FBQztxQkFBTSxDQUFDO29CQUNOLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxLQUFLLENBQUM7Z0JBQ3ZCLENBQUM7WUFDSCxDQUFDO1FBQ0gsQ0FBQztRQUVELElBQUksWUFBWSxDQUFDLE1BQU0sR0FBRyxDQUFDO1lBQUUsT0FBTyxDQUFDLGFBQWEsR0FBRyxZQUFZLENBQUM7UUFFbEUsSUFBSSxRQUFRLElBQUksT0FBTyxJQUFJLENBQUMsV0FBVyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ3JELE9BQU8sQ0FBQyxPQUFPLEdBQUcsRUFBRSxJQUFJLEVBQUUsSUFBSSxDQUFDLFdBQVcsRUFBRSxDQUFDO1FBQy9DLENBQUM7UUFFRCxPQUFPLE9BQU8sQ0FBQztJQUNqQixDQUFDO0NBQ0Y7QUE3SUQsbUNBNklDIn0=

package/dist/collections/user-collection.d.ts

@@ -0,0 +1,15 @@
+import type { ZendeskClient } from '../client';
+import type { CustomFieldEntry, ZendeskRecord } from '../types';
+import type { Caller, DataSource, Filter, Logger, RecordData } from '@forestadmin/datasource-toolkit';
+import SearchableCollection from './searchable-collection';
+export default class UserCollection extends SearchableCollection {
+    private readonly customFields;
+    constructor(datasource: DataSource, client: ZendeskClient, customFields: CustomFieldEntry[], logger?: Logger);
+    create(caller: Caller, data: RecordData[]): Promise<RecordData[]>;
+    update(caller: Caller, filter: Filter, patch: RecordData): Promise<void>;
+    delete(caller: Caller, filter: Filter): Promise<void>;
+    protected findOne(id: number | string): Promise<ZendeskRecord | null>;
+    protected serializeRecord(record: ZendeskRecord): RecordData;
+    private buildPayload;
+}
+//# sourceMappingURL=user-collection.d.ts.map

package/dist/collections/user-collection.js

@@ -0,0 +1,162 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const datasource_1 = require("../datasource");
+const enums_1 = require("../enums");
+const base_zendesk_collection_1 = require("./base-zendesk-collection");
+const searchable_collection_1 = __importDefault(require("./searchable-collection"));
+const serializer_1 = require("./ticket/serializer");
+const SORTABLE = {
+    created_at: 'created_at',
+    updated_at: 'updated_at',
+    name: 'name',
+};
+const READ_ONLY_INPUTS = new Set(['id', 'created_at', 'updated_at']);
+function getUserFieldSchemas() {
+    return {
+        id: {
+            type: 'Column',
+            columnType: 'Number',
+            isPrimaryKey: true,
+            isReadOnly: true,
+            isSortable: false,
+            filterOperators: new Set(base_zendesk_collection_1.ID_OPS),
+        },
+        email: {
+            type: 'Column',
+            columnType: 'String',
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        name: {
+            type: 'Column',
+            columnType: 'String',
+            isSortable: true,
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        role: {
+            type: 'Column',
+            columnType: 'Enum',
+            enumValues: [...enums_1.USER_ROLES],
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        phone: {
+            type: 'Column',
+            columnType: 'String',
+            filterOperators: new Set(base_zendesk_collection_1.STRING_OPS),
+        },
+        organization_id: {
+            type: 'Column',
+            columnType: 'Number',
+            filterOperators: new Set(base_zendesk_collection_1.NUMBER_OPS),
+        },
+        time_zone: {
+            type: 'Column',
+            columnType: 'String',
+            filterOperators: new Set(),
+        },
+        locale: {
+            type: 'Column',
+            columnType: 'String',
+            filterOperators: new Set(),
+        },
+        verified: {
+            type: 'Column',
+            columnType: 'Boolean',
+            filterOperators: new Set(base_zendesk_collection_1.BOOLEAN_OPS),
+        },
+        suspended: {
+            type: 'Column',
+            columnType: 'Boolean',
+            filterOperators: new Set(base_zendesk_collection_1.BOOLEAN_OPS),
+        },
+        created_at: {
+            type: 'Column',
+            columnType: 'Date',
+            isReadOnly: true,
+            isSortable: true,
+            filterOperators: new Set(base_zendesk_collection_1.DATE_OPS),
+        },
+        updated_at: {
+            type: 'Column',
+            columnType: 'Date',
+            isReadOnly: true,
+            isSortable: true,
+            filterOperators: new Set(base_zendesk_collection_1.DATE_OPS),
+        },
+        organization: {
+            type: 'ManyToOne',
+            foreignCollection: datasource_1.COLLECTION_NAMES.organization,
+            foreignKey: 'organization_id',
+            foreignKeyTarget: 'id',
+        },
+        requested_tickets: {
+            type: 'OneToMany',
+            foreignCollection: datasource_1.COLLECTION_NAMES.ticket,
+            originKey: 'requester_id',
+            originKeyTarget: 'id',
+        },
+    };
+}
+class UserCollection extends searchable_collection_1.default {
+    constructor(datasource, client, customFields, logger) {
+        super(datasource_1.COLLECTION_NAMES.user, datasource, client, 'user', SORTABLE, logger);
+        this.customFields = customFields;
+        this.addFields(getUserFieldSchemas());
+        this.addCustomFields(customFields);
+    }
+    async create(caller, data) {
+        const created = [];
+        for (const item of data) {
+            // eslint-disable-next-line no-await-in-loop
+            const raw = await this.client.createUser(this.buildPayload(item));
+            created.push((0, serializer_1.serializeUser)(raw));
+        }
+        return created;
+    }
+    async update(caller, filter, patch) {
+        const ids = await this.resolveIds(filter, caller.timezone);
+        const payload = this.buildPayload(patch);
+        for (const id of ids) {
+            // eslint-disable-next-line no-await-in-loop
+            await this.client.updateUser(id, payload);
+        }
+    }
+    async delete(caller, filter) {
+        const ids = await this.resolveIds(filter, caller.timezone);
+        for (const id of ids) {
+            // eslint-disable-next-line no-await-in-loop
+            await this.client.deleteUser(id);
+        }
+    }
+    findOne(id) {
+        return this.client.findUser(id);
+    }
+    serializeRecord(record) {
+        return (0, serializer_1.serializeUser)(record);
+    }
+    buildPayload(data) {
+        const payload = {};
+        const userFields = {};
+        for (const [key, value] of Object.entries(data)) {
+            if (READ_ONLY_INPUTS.has(key) || key === 'requested_tickets' || key === 'organization') {
+                // ignored
+            }
+            else {
+                const customField = this.customFields.find(cf => cf.columnName === key);
+                if (customField?.zendeskKey) {
+                    userFields[customField.zendeskKey] = value;
+                }
+                else {
+                    payload[key] = value;
+                }
+            }
+        }
+        if (Object.keys(userFields).length > 0)
+            payload.user_fields = userFields;
+        return payload;
+    }
+}
+exports.default = UserCollection;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlci1jb2xsZWN0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbGxlY3Rpb25zL3VzZXItY29sbGVjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQVdBLDhDQUFpRDtBQUNqRCxvQ0FBc0M7QUFDdEMsdUVBQWtHO0FBQ2xHLG9GQUEyRDtBQUMzRCxvREFBb0Q7QUFFcEQsTUFBTSxRQUFRLEdBQTJCO0lBQ3ZDLFVBQVUsRUFBRSxZQUFZO0lBQ3hCLFVBQVUsRUFBRSxZQUFZO0lBQ3hCLElBQUksRUFBRSxNQUFNO0NBQ2IsQ0FBQztBQUVGLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsWUFBWSxFQUFFLFlBQVksQ0FBQyxDQUFDLENBQUM7QUFFckUsU0FBUyxtQkFBbUI7SUFDMUIsT0FBTztRQUNMLEVBQUUsRUFBRTtZQUNGLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLFFBQVE7WUFDcEIsWUFBWSxFQUFFLElBQUk7WUFDbEIsVUFBVSxFQUFFLElBQUk7WUFDaEIsVUFBVSxFQUFFLEtBQUs7WUFDakIsZUFBZSxFQUFFLElBQUksR0FBRyxDQUFDLGdDQUFNLENBQUM7U0FDakM7UUFDRCxLQUFLLEVBQUU7WUFDTCxJQUFJLEVBQUUsUUFBUTtZQUNkLFVBQVUsRUFBRSxRQUFRO1lBQ3BCLGVBQWUsRUFBRSxJQUFJLEdBQUcsQ0FBQyxvQ0FBVSxDQUFDO1NBQ3JDO1FBQ0QsSUFBSSxFQUFFO1lBQ0osSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsUUFBUTtZQUNwQixVQUFVLEVBQUUsSUFBSTtZQUNoQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMsb0NBQVUsQ0FBQztTQUNyQztRQUNELElBQUksRUFBRTtZQUNKLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLE1BQU07WUFDbEIsVUFBVSxFQUFFLENBQUMsR0FBRyxrQkFBVSxDQUFDO1lBQzNCLGVBQWUsRUFBRSxJQUFJLEdBQUcsQ0FBQyxvQ0FBVSxDQUFDO1NBQ3JDO1FBQ0QsS0FBSyxFQUFFO1lBQ0wsSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsUUFBUTtZQUNwQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMsb0NBQVUsQ0FBQztTQUNyQztRQUNELGVBQWUsRUFBRTtZQUNmLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLFFBQVE7WUFDcEIsZUFBZSxFQUFFLElBQUksR0FBRyxDQUFDLG9DQUFVLENBQUM7U0FDckM7UUFDRCxTQUFTLEVBQUU7WUFDVCxJQUFJLEVBQUUsUUFBUTtZQUNkLFVBQVUsRUFBRSxRQUFRO1lBQ3BCLGVBQWUsRUFBRSxJQUFJLEdBQUcsRUFBRTtTQUMzQjtRQUNELE1BQU0sRUFBRTtZQUNOLElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLFFBQVE7WUFDcEIsZUFBZSxFQUFFLElBQUksR0FBRyxFQUFFO1NBQzNCO1FBQ0QsUUFBUSxFQUFFO1lBQ1IsSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsU0FBUztZQUNyQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMscUNBQVcsQ0FBQztTQUN0QztRQUNELFNBQVMsRUFBRTtZQUNULElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLFNBQVM7WUFDckIsZUFBZSxFQUFFLElBQUksR0FBRyxDQUFDLHFDQUFXLENBQUM7U0FDdEM7UUFDRCxVQUFVLEVBQUU7WUFDVixJQUFJLEVBQUUsUUFBUTtZQUNkLFVBQVUsRUFBRSxNQUFNO1lBQ2xCLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLGVBQWUsRUFBRSxJQUFJLEdBQUcsQ0FBQyxrQ0FBUSxDQUFDO1NBQ25DO1FBQ0QsVUFBVSxFQUFFO1lBQ1YsSUFBSSxFQUFFLFFBQVE7WUFDZCxVQUFVLEVBQUUsTUFBTTtZQUNsQixVQUFVLEVBQUUsSUFBSTtZQUNoQixVQUFVLEVBQUUsSUFBSTtZQUNoQixlQUFlLEVBQUUsSUFBSSxHQUFHLENBQUMsa0NBQVEsQ0FBQztTQUNuQztRQUNELFlBQVksRUFBRTtZQUNaLElBQUksRUFBRSxXQUFXO1lBQ2pCLGlCQUFpQixFQUFFLDZCQUFnQixDQUFDLFlBQVk7WUFDaEQsVUFBVSxFQUFFLGlCQUFpQjtZQUM3QixnQkFBZ0IsRUFBRSxJQUFJO1NBQ3ZCO1FBQ0QsaUJBQWlCLEVBQUU7WUFDakIsSUFBSSxFQUFFLFdBQVc7WUFDakIsaUJBQWlCLEVBQUUsNkJBQWdCLENBQUMsTUFBTTtZQUMxQyxTQUFTLEVBQUUsY0FBYztZQUN6QixlQUFlLEVBQUUsSUFBSTtTQUN0QjtLQUNGLENBQUM7QUFDSixDQUFDO0FBRUQsTUFBcUIsY0FBZSxTQUFRLCtCQUFvQjtJQUc5RCxZQUNFLFVBQXNCLEVBQ3RCLE1BQXFCLEVBQ3JCLFlBQWdDLEVBQ2hDLE1BQWU7UUFFZixLQUFLLENBQUMsNkJBQWdCLENBQUMsSUFBSSxFQUFFLFVBQVUsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUMzRSxJQUFJLENBQUMsWUFBWSxHQUFHLFlBQVksQ0FBQztRQUVqQyxJQUFJLENBQUMsU0FBUyxDQUFDLG1CQUFtQixFQUFFLENBQUMsQ0FBQztRQUN0QyxJQUFJLENBQUMsZUFBZSxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBQ3JDLENBQUM7SUFFUSxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQWMsRUFBRSxJQUFrQjtRQUN0RCxNQUFNLE9BQU8sR0FBaUIsRUFBRSxDQUFDO1FBRWpDLEtBQUssTUFBTSxJQUFJLElBQUksSUFBSSxFQUFFLENBQUM7WUFDeEIsNENBQTRDO1lBQzVDLE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBSSxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1lBQ2xFLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBQSwwQkFBYSxFQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7UUFDbkMsQ0FBQztRQUVELE9BQU8sT0FBTyxDQUFDO0lBQ2pCLENBQUM7SUFFUSxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQWMsRUFBRSxNQUFjLEVBQUUsS0FBaUI7UUFDckUsTUFBTSxHQUFHLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDM0QsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUV6QyxLQUFLLE1BQU0sRUFBRSxJQUFJLEdBQUcsRUFBRSxDQUFDO1lBQ3JCLDRDQUE0QztZQUM1QyxNQUFNLElBQUksQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLEVBQUUsRUFBRSxPQUFPLENBQUMsQ0FBQztRQUM1QyxDQUFDO0lBQ0gsQ0FBQztJQUVRLEtBQUssQ0FBQyxNQUFNLENBQUMsTUFBYyxFQUFFLE1BQWM7UUFDbEQsTUFBTSxHQUFHLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUM7UUFFM0QsS0FBSyxNQUFNLEVBQUUsSUFBSSxHQUFHLEVBQUUsQ0FBQztZQUNyQiw0Q0FBNEM7WUFDNUMsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUNuQyxDQUFDO0lBQ0gsQ0FBQztJQUVrQixPQUFPLENBQUMsRUFBbUI7UUFDNUMsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUNsQyxDQUFDO0lBRWtCLGVBQWUsQ0FBQyxNQUFxQjtRQUN0RCxPQUFPLElBQUEsMEJBQWEsRUFBQyxNQUFNLENBQUMsQ0FBQztJQUMvQixDQUFDO0lBRU8sWUFBWSxDQUFDLElBQWdCO1FBQ25DLE1BQU0sT0FBTyxHQUFrQixFQUFFLENBQUM7UUFDbEMsTUFBTSxVQUFVLEdBQTRCLEVBQUUsQ0FBQztRQUUvQyxLQUFLLE1BQU0sQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ2hELElBQUksZ0JBQWdCLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxJQUFJLEdBQUcsS0FBSyxtQkFBbUIsSUFBSSxHQUFHLEtBQUssY0FBYyxFQUFFLENBQUM7Z0JBQ3ZGLFVBQVU7WUFDWixDQUFDO2lCQUFNLENBQUM7Z0JBQ04sTUFBTSxXQUFXLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxFQUFFLENBQUMsVUFBVSxLQUFLLEdBQUcsQ0FBQyxDQUFDO2dCQUV4RSxJQUFJLFdBQVcsRUFBRSxVQUFVLEVBQUUsQ0FBQztvQkFDNUIsVUFBVSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsR0FBRyxLQUFLLENBQUM7Z0JBQzdDLENBQUM7cUJBQU0sQ0FBQztvQkFDTixPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsS0FBSyxDQUFDO2dCQUN2QixDQUFDO1lBQ0gsQ0FBQztRQUNILENBQUM7UUFFRCxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUM7WUFBRSxPQUFPLENBQUMsV0FBVyxHQUFHLFVBQVUsQ0FBQztRQUV6RSxPQUFPLE9BQU8sQ0FBQztJQUNqQixDQUFDO0NBQ0Y7QUE3RUQsaUNBNkVDIn0=

package/dist/datasource.d.ts

@@ -0,0 +1,16 @@
+import type { ZendeskClient } from './client';
+import type { CustomFieldMapping } from './types';
+import type { Logger } from '@forestadmin/datasource-toolkit';
+import { BaseDataSource } from '@forestadmin/datasource-toolkit';
+export declare const COLLECTION_NAMES: {
+    readonly ticket: "zendesk_ticket";
+    readonly user: "zendesk_user";
+    readonly organization: "zendesk_organization";
+};
+export default class ZendeskDataSource extends BaseDataSource {
+    readonly client: ZendeskClient;
+    readonly customFieldMapping: CustomFieldMapping;
+    static create(client: ZendeskClient, logger?: Logger): Promise<ZendeskDataSource>;
+    private constructor();
+}
+//# sourceMappingURL=datasource.d.ts.map