@simplysf/simply-document 0.3.7 → 0.4.1

package/lib/common/technicalDesignDocumentTemplate.d.ts

@@ -1,211 +0,0 @@
-/** A record type on a standard or custom object. */
-export type RecordTypeItem = {
-    fullName: string;
-    label?: string;
-    active?: string;
-    description?: string;
-};
-/** A page layout on a standard or custom object. */
-export type LayoutItem = {
-    nameOnly?: string;
-};
-/** A custom field on a standard object, custom object, custom setting, custom metadata type, or platform event. */
-export type CustomFieldItem = {
-    fullName: string;
-    label?: string;
-    type?: string;
-    required?: string;
-    externalId?: string;
-    unique?: string;
-    miniDescription?: string;
-};
-/** A field set on a standard or custom object. */
-export type FieldSetItem = {
-    fullName: string;
-    label?: string;
-    description?: string;
-    displayedFields?: Array<{
-        field?: string;
-    }>;
-};
-/** A validation rule on a standard or custom object. */
-export type ValidationRuleItem = {
-    fullName: string;
-    active?: string;
-    description?: string;
-};
-/**
- * A standard object, custom object, custom setting, custom metadata type, or platform event.
- * These all share the same shape, since they're all backed by `CustomObject`-family metadata.
- */
-export type ObjectItem = {
-    name: string;
-    label?: string;
-    miniDescription?: string;
-    sharingModel?: string;
-    externalSharingModel?: string;
-    customSettingsType?: string;
-    eventType?: string;
-    publishBehavior?: string;
-    recordTypes?: RecordTypeItem[];
-    layouts?: LayoutItem[];
-    customFields?: CustomFieldItem[];
-    fieldSets?: FieldSetItem[];
-    validationRules?: ValidationRuleItem[];
-};
-export type GroupItem = {
-    label?: string;
-    apiName?: string;
-    doesIncludeBosses?: string;
-};
-export type QueueItem = {
-    label?: string;
-    name: string;
-    doesSendEmailToMembers?: string;
-    queueObjects?: string[];
-};
-export type PermissionSetGroupItem = {
-    label?: string;
-    name: string;
-    description?: string;
-};
-export type PermissionSetItem = {
-    label?: string;
-    name: string;
-    description?: string;
-};
-export type CustomApplicationItem = {
-    label?: string;
-    name: string;
-    description?: string;
-};
-export type FlowItem = {
-    label?: string;
-    name: string;
-    processType?: string;
-    description?: string;
-};
-export type FlexipageItem = {
-    masterLabel?: string;
-    name: string;
-    type?: string;
-};
-export type ApprovalProcessItem = {
-    label?: string;
-    name: string;
-    active?: string;
-    description?: string;
-};
-export type CustomLabelItem = {
-    fullName?: string;
-    shortDescription?: string;
-};
-export type EmailTemplateItem = {
-    apiName: string;
-    label?: string;
-    type?: string;
-    description?: string;
-};
-export type ReportItem = {
-    name: string;
-    folderName?: string;
-    description?: string;
-};
-export type DashboardItem = {
-    name: string;
-    folderName?: string;
-    description?: string;
-};
-export type ApexClassItem = {
-    name: string;
-    status?: string;
-    apiVersion?: string;
-};
-export type ApexTriggerItem = {
-    name: string;
-    status?: string;
-    apiVersion?: string;
-};
-export type LightningComponentItem = {
-    name: string;
-    description?: string;
-    apiVersion?: string;
-};
-export type AuraComponentItem = {
-    name: string;
-    description?: string;
-    apiVersion?: string;
-};
-export type VisualforcePageItem = {
-    name: string;
-    label?: string;
-    description?: string;
-    apiVersion?: string;
-};
-export type StaticResourceItem = {
-    name: string;
-    contentType?: string;
-    cacheControl?: string;
-    description?: string;
-};
-export type ExperienceBundleItem = {
-    name: string;
-};
-export type DigitalExperienceBundleItem = {
-    name: string;
-};
-export type CustomMetadataItem = {
-    label?: string;
-    name: string;
-};
-export type SharingRuleItem = {
-    label?: string;
-    fullName?: string;
-    object?: string;
-    type?: string;
-    accessLevel?: string;
-    description?: string;
-};
-/** The full data model rendered by the technical design document template. */
-export type TechnicalDesignDocumentData = {
-    apexClasses: ApexClassItem[];
-    apexTriggers: ApexTriggerItem[];
-    approvalProcesses: ApprovalProcessItem[];
-    auraComponents: AuraComponentItem[];
-    customApplications: CustomApplicationItem[];
-    customLabels: CustomLabelItem[];
-    customMetadata: CustomMetadataItem[];
-    customMetadataTypes: ObjectItem[];
-    customObjects: ObjectItem[];
-    customSettings: ObjectItem[];
-    dashboards: DashboardItem[];
-    digitalExperienceBundles: DigitalExperienceBundleItem[];
-    emailTemplates: EmailTemplateItem[];
-    experienceBundles: ExperienceBundleItem[];
-    flexipages: FlexipageItem[];
-    flows: FlowItem[];
-    groups: GroupItem[];
-    lightningComponents: LightningComponentItem[];
-    permissionSets: PermissionSetItem[];
-    permissionSetGroups: PermissionSetGroupItem[];
-    platformEvents: ObjectItem[];
-    queues: QueueItem[];
-    reports: ReportItem[];
-    sharingRules: SharingRuleItem[];
-    standardObjects: ObjectItem[];
-    staticResources: StaticResourceItem[];
-    visualforcePages: VisualforcePageItem[];
-};
-/**
- * Render a Confluence-storage-format technical design document from a Salesforce project's
- * scanned metadata, covering objects/data model, security model, groups/queues/permissions,
- * solution inventory, and custom code inventory.
- *
- * @param data - The scanned project metadata to render.
- * @param customTemplateSource - A user-supplied Handlebars template to render instead of the
- * built-in one. Compiled against the same Handlebars instance as the built-in template, so it
- * can also use the `loud` helper. See the README's "Custom Templates" section for the `data`
- * shape.
- * @returns The rendered XHTML document.
- */
-export declare function buildTechnicalDesignDocumentHtml(data: TechnicalDesignDocumentData, customTemplateSource?: string): string;