@simplysf/simply-document 0.2.0

package/lib/common/changeReportTemplate.js

@@ -0,0 +1,269 @@
+/*
+ * Copyright (c) 2026, Clay Chipps; Copyright (c) 2026 Salesforce, Inc.
+ *
+ * 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 Handlebars from 'handlebars';
+const handlebars = Handlebars.create();
+const changeTableSource = `
+<table class="wrapped">
+  <colgroup>
+    <col />
+    <col />
+    <col />
+    <col />
+    <col />
+  </colgroup>
+  <tbody>
+    <tr>
+      <th>Component Name</th>
+      <th>Component Type</th>
+      <th>Change Type</th>
+      <th>Change description</th>
+      <th>Path</th>
+    </tr>
+    {{#each this}}
+    <tr>
+      <td>{{this.componentName}}</td>
+      <td>{{this.componentType}}</td>
+      <td style="text-align: center"><b>{{this.changeType}}</b></td>
+      <td>{{this.changeDescription}}</td>
+      <td>{{this.path}}</td>
+    </tr>
+    {{/each}}
+  </tbody>
+</table>
+`;
+const changeReportSource = `<h2>Objects &amp; Data Model</h2>
+
+<h3>Standard Objects</h3>
+{{#if standardObjects}}
+  {{> changeTable standardObjects}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Custom Objects</h3>
+{{#if customObjects}}
+  {{> changeTable customObjects}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Custom Settings</h3>
+{{#if customSettings}}
+  {{> changeTable customSettings}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Custom Metadata Types</h3>
+{{#if customMetadataTypes}}
+  {{> changeTable customMetadataTypes}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Custom Metadata</h3>
+{{#if customMetadata}}
+  {{> changeTable customMetadata}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Platform Events</h3>
+{{#if platformEvents}}
+  {{> changeTable platformEvents}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h2>Custom Code</h2>
+
+<h3>Apex Classes</h3>
+{{#if apexClasses}}
+  {{> changeTable apexClasses}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Apex Triggers</h3>
+{{#if apexTriggers}}
+  {{> changeTable apexTriggers}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Visualforce Pages</h3>
+{{#if visualforcePages}}
+  {{> changeTable visualforcePages}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h2>User Interface Components</h2>
+
+<h3>Lightning Web Components</h3>
+{{#if lightningComponents}}
+  {{> changeTable lightningComponents}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Aura Components</h3>
+{{#if auraComponents}}
+  {{> changeTable auraComponents}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h2>Business Logic &amp; Automation</h2>
+
+<h3>Flows</h3>
+{{#if flows}}
+  {{> changeTable flows}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Flexipages</h3>
+{{#if flexipages}}
+  {{> changeTable flexipages}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Approval Processes</h3>
+{{#if approvalProcesses}}
+  {{> changeTable approvalProcesses}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h2>Applications &amp; Branding</h2>
+
+<h3>Custom Applications</h3>
+{{#if customApplications}}
+  {{> changeTable customApplications}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Custom Labels</h3>
+{{#if customLabels}}
+  {{> changeTable customLabels}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Static Resources</h3>
+{{#if staticResources}}
+  {{> changeTable staticResources}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h2>Analytics &amp; Reporting</h2>
+
+<h3>Dashboards</h3>
+{{#if dashboards}}
+  {{> changeTable dashboards}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Reports</h3>
+{{#if reports}}
+  {{> changeTable reports}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Email Templates</h3>
+{{#if emailTemplates}}
+  {{> changeTable emailTemplates}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h2>Digital Experiences</h2>
+
+<h3>Digital Experience Bundles</h3>
+{{#if digitalExperienceBundles}}
+  {{> changeTable digitalExperienceBundles}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Experience Bundles</h3>
+{{#if experienceBundles}}
+  {{> changeTable experienceBundles}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h2>Security, Groups &amp; Queues</h2>
+
+<h3>Groups</h3>
+{{#if groups}}
+  {{> changeTable groups}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Queues</h3>
+{{#if queues}}
+  {{> changeTable queues}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Permission Sets</h3>
+{{#if permissionSets}}
+  {{> changeTable permissionSets}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Permission Set Groups</h3>
+{{#if permissionSetGroups}}
+  {{> changeTable permissionSetGroups}}
+{{else}}
+  <p>None</p>
+{{/if}}
+
+<h3>Sharing Rules</h3>
+{{#if sharingRules}}
+  {{> changeTable sharingRules}}
+{{else}}
+  <p>None</p>
+{{/if}}
+`;
+handlebars.registerPartial('changeTable', changeTableSource);
+const renderChangeReport = handlebars.compile(changeReportSource);
+/**
+ * Render a Confluence-storage-format change report grouping a set of changed components by
+ * component type, for pasting into a release/change-management page.
+ *
+ * @param changes - The changed components, grouped by component type.
+ * @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 `changeTable` partial. See the README's "Custom Templates" section for the
+ * `changes` data shape and the fields `changeTable` renders.
+ * @returns The rendered XHTML fragment.
+ */
+export function buildChangeReportHtml(changes, customTemplateSource) {
+    const render = customTemplateSource ? handlebars.compile(customTemplateSource) : renderChangeReport;
+    return render(changes);
+}
+//# sourceMappingURL=changeReportTemplate.js.map

package/lib/common/changeReportTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changeReportTemplate.js","sourceRoot":"","sources":["../../src/common/changeReportTemplate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,UAAU,MAAM,YAAY,CAAC;AAcpC,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;AAEvC,MAAM,iBAAiB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BzB,CAAC;AAEF,MAAM,kBAAkB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4M1B,CAAC;AAEF,UAAU,CAAC,eAAe,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;AAE7D,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAElE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAA+B,EAAE,oBAA6B;IAClG,MAAM,MAAM,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC;IACpG,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;AACzB,CAAC"}

package/lib/common/technicalDesignDocumentTemplate.d.ts

@@ -0,0 +1,211 @@
+/** 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;