@aglyn/plugins-crm 1.0.0-beta.220 → 1.0.0-beta.222

package/src/lib/transfer/fields.d.ts

@@ -0,0 +1,102 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { CONTACT_LIFECYCLE_STAGES, type ContactFieldDefinition, type CrmFieldObject } from '@aglyn/aglyn/app-utils/crm';
+import type { TransferCustomFieldDefinition, TransferField, TransferFieldGroup } from '@aglyn/aglyn/data-transfer';
+/** The CRM's resource keys, as `plugins.config.json` declares them. */
+export declare const CRM_CONTACTS_RESOURCE = "crm.contacts";
+export declare const CRM_COMPANIES_RESOURCE = "crm.companies";
+/**
+ * The workspace's members, as an owner column names them: a lookup target
+ * the CRM's resources answer themselves (`lookupTargets`), because no
+ * resource imports members.
+ */
+export declare const CRM_MEMBERS_TARGET = "crm.members";
+/**
+ * The lifecycle stages as a picklist the values step can match against: a
+ * fixed list the platform defines, which an import maps onto and never adds
+ * to.
+ */
+export declare const CRM_LIFECYCLE_STAGE_PICKLIST = "crm.lifecycleStage";
+/** The picklist a custom `select` field's options are matched as. */
+export declare function crmCustomPicklistId(object: CrmFieldObject, key: string): string;
+/** The custom field a {@link crmCustomPicklistId} names, or `null`. */
+export declare function crmCustomPicklistKey(picklistId: string): {
+    object: string;
+    key: string;
+} | null;
+/** The stage a label (or an id, or a spelling between them) names, or `null`. */
+export declare function crmLifecycleStageOf(value: unknown): (typeof CONTACT_LIFECYCLE_STAGES)[number] | null;
+/** A stage's place in the funnel, for "never backward"; `-1` for none. */
+export declare function crmLifecycleStageRank(value: unknown): number;
+/** The six parts of a postal address, as a file's columns name them. */
+export declare const CRM_ADDRESS_PARTS: readonly ["Street", "Street2", "City", "State", "PostalCode", "Country"];
+export type CrmAddressPart = (typeof CRM_ADDRESS_PARTS)[number];
+/** The postal-address key each part is stored under. */
+export declare const CRM_ADDRESS_PART_KEYS: Readonly<Record<CrmAddressPart, 'line1' | 'line2' | 'city' | 'state' | 'postalCode' | 'country'>>;
+/** The field ids of one address. */
+export declare function crmAddressFieldIds(prefix: string): string[];
+export declare const CONTACT_TRANSFER_GROUPS: readonly TransferFieldGroup[];
+/** A contact's own fields, in the order the picker lists them. */
+export declare const CONTACT_TRANSFER_FIELDS: readonly TransferField[];
+/** What only the platform writes about a contact: exported, never imported. */
+export declare const CONTACT_TRANSFER_DERIVED: readonly TransferField[];
+/** When the record was made and last changed. */
+export declare const CRM_TIMESTAMP_FIELDS: readonly TransferField[];
+export declare const COMPANY_TRANSFER_GROUPS: readonly TransferFieldGroup[];
+/** A company's own fields, in the order the picker lists them. */
+export declare const COMPANY_TRANSFER_FIELDS: readonly TransferField[];
+/** What only the platform writes about a company. */
+export declare const COMPANY_TRANSFER_DERIVED: readonly TransferField[];
+/**
+ * The organization's custom fields for one kind of record, as the catalog
+ * takes them (`custom:<key>`): live definitions only, in their order, a
+ * `select` matched as a picklist of its options.
+ */
+export declare function crmCustomTransferFields(definitions: ReadonlyArray<Pick<ContactFieldDefinition, 'key' | 'label' | 'type' | 'retiredAt' | 'order'>>, object: CrmFieldObject): TransferCustomFieldDefinition[];
+export declare const CRM_LEADS_RESOURCE = "crm.leads";
+export declare const CRM_DEALS_RESOURCE = "crm.deals";
+export declare const CRM_TASKS_RESOURCE = "crm.tasks";
+export declare const CRM_ACTIVITIES_RESOURCE = "crm.activities";
+export declare const CRM_PIPELINES_RESOURCE = "crm.pipelines";
+export declare const CRM_FIELDS_RESOURCE = "crm.fields";
+/** The organization's live campaigns as a list a lead's campaign names are matched onto. */
+export declare const CRM_CAMPAIGNS_PICKLIST = "crm.campaigns";
+/** Salesforce's forecast categories as a fixed list a value is matched onto. */
+export declare const CRM_FORECAST_CATEGORY_PICKLIST = "crm.forecastCategory";
+export declare const LEAD_TRANSFER_GROUPS: readonly TransferFieldGroup[];
+/** A lead's own fields, in the order the picker lists them. */
+export declare const LEAD_TRANSFER_FIELDS: readonly TransferField[];
+/** What only the platform records about a lead. */
+export declare const LEAD_TRANSFER_DERIVED: readonly TransferField[];
+export declare const DEAL_TRANSFER_GROUPS: readonly TransferFieldGroup[];
+/** A deal's own fields, in the order the picker lists them. */
+export declare const DEAL_TRANSFER_FIELDS: readonly TransferField[];
+/** What a deal's stage decides: exported, never written from a file. */
+export declare const DEAL_TRANSFER_DERIVED: readonly TransferField[];
+export declare const TASK_TRANSFER_GROUPS: readonly TransferFieldGroup[];
+/** A task's own fields, in the order the picker lists them. */
+export declare const TASK_TRANSFER_FIELDS: readonly TransferField[];
+/** When a task was done: exported, never written from a file. */
+export declare const TASK_TRANSFER_DERIVED: readonly TransferField[];
+export declare const ACTIVITY_TRANSFER_GROUPS: readonly TransferFieldGroup[];
+/** Everything an export of the team's logged work carries. Read-only: activities are logged, not imported. */
+export declare const ACTIVITY_TRANSFER_FIELDS: readonly TransferField[];
+export declare const PIPELINE_TRANSFER_GROUPS: readonly TransferFieldGroup[];
+/** One row per stage of every pipeline. Read-only: pipelines are set up on their own page. */
+export declare const PIPELINE_TRANSFER_FIELDS: readonly TransferField[];
+/** One row per custom field. Read-only: fields are defined on the Fields page. */
+export declare const FIELD_DEFINITION_TRANSFER_FIELDS: readonly TransferField[];