handoff-app 0.4.0 → 0.4.1

package/Changelog.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.1] - 2023-04-16
+
+### Bugfixes
+- Fixes a typing error in the project config
+- Fixes an issue where the path of the integrations are relative to the project
+- Fixes an issue where local integrations aren't properly merged on watch
+- Updates the installed template to match the latest desired state
+
 ## [0.4.0] - 2023-04-16
 
 This release introduces two major new features - framework integrations

package/client-config.d.ts

@@ -16,20 +16,20 @@ export interface Integration {
 
 export interface FigmaSearch {
   size: ComponentSizeMap[];
-  components: FigmaComponentSearch;
+  components: FigmaComponentList;
 }
 
 export interface FigmaComponentList {
-  alert?: FigmaComponentStructure | null;
-  button?: FigmaComponentStructure | null;
-  checkbox?: FigmaComponentStructure | null;
-  input?: FigmaComponentStructure | null;
-  modal?: FigmaComponentStructure | null;
-  pagination?: FigmaComponentStructure | null;
-  radio?: FigmaComponentStructure | null;
-  select?: FigmaComponentStructure | null;
-  switch?: FigmaComponentStructure | null;
-  tooltip?: FigmaComponentStructure | null;
+  alert?: FigmaComponentSearch | null;
+  button?: FigmaComponentSearch | null;
+  checkbox?: FigmaComponentSearch | null;
+  input?: FigmaComponentSearch | null;
+  modal?: FigmaComponentSearch | null;
+  pagination?: FigmaComponentSearch | null;
+  radio?: FigmaComponentSearch | null;
+  select?: FigmaComponentSearch | null;
+  switch?: FigmaComponentSearch | null;
+  tooltip?: FigmaComponentSearch | null;
 }
 
 export interface FigmaComponentSearch {

package/figma-exporter/dist/figma-exporter.cjs.dev.js

@@ -9744,7 +9744,7 @@ const getPathToIntegration = () => {
   const integrationFolder = 'integrations';
   const defaultIntegration = 'bootstrap';
   const defaultVersion = '5.2';
-  const defaultPath = path__default["default"].resolve(path__default["default"].join(integrationFolder, defaultIntegration, defaultVersion));
+  const defaultPath = path__default["default"].resolve(path__default["default"].join(__dirname, integrationFolder, defaultIntegration, defaultVersion));
   const config = documentationObject.getFetchConfig();
   if (config.integration) {
     if (config.integration.name === 'custom') {

package/figma-exporter/dist/figma-exporter.cjs.prod.js

@@ -9744,7 +9744,7 @@ const getPathToIntegration = () => {
   const integrationFolder = 'integrations';
   const defaultIntegration = 'bootstrap';
   const defaultVersion = '5.2';
-  const defaultPath = path__default["default"].resolve(path__default["default"].join(integrationFolder, defaultIntegration, defaultVersion));
+  const defaultPath = path__default["default"].resolve(path__default["default"].join(__dirname, integrationFolder, defaultIntegration, defaultVersion));
   const config = documentationObject.getFetchConfig();
   if (config.integration) {
     if (config.integration.name === 'custom') {

package/figma-exporter/src/transformers/integration/index.ts

@@ -14,7 +14,7 @@ export const getPathToIntegration = () => {
   const defaultIntegration = 'bootstrap';
   const defaultVersion = '5.2';
 
-  const defaultPath = path.resolve(path.join(integrationFolder, defaultIntegration, defaultVersion));
+  const defaultPath = path.resolve(path.join(__dirname, integrationFolder, defaultIntegration, defaultVersion));
 
   const config = getFetchConfig();
   if (config.integration) {

package/installer/template/config.js

@@ -2,31 +2,35 @@
 
 /** @type {import('handoff-app/client-config').Config} */
 const config = {
-  title: 'Demo Design System',  // The Title of your project
-  client: 'Demo Software',      // The name of your org
-  google_tag_manager: null,     // A GTM tag id. If null, GTM will not be added
-  integration: {                // Integration exports a prebuild token map
-    name: 'bootstrap',          // Pick the integration type (bootstrap)
-    version: '5.2',             // Pick the integration version
+  title: 'Demo Design System', // The Title of your project
+  client: 'Demo Software', // The name of your org
+  google_tag_manager: null, // A GTM tag id. If null, GTM will not be added
+  integration: {
+    // Integration exports a prebuild token map
+    name: 'bootstrap', // Pick the integration type (bootstrap)
+    version: '5.2', // Pick the integration version
   },
-  componentSizeMap: [           // Component size map allows you to map figma
-    {                           // size names (small, medium, large) to customize
-      figma: 'small',           // your token names to match the sizes used 
-      css: 'sm',                // in your project like (sm, md, lg)
-    },
-    {
-      figma: 'medium',
-      css: 'md',
-    },
-    {
-      figma: 'large',
-      css: 'lg',
-    },
-  ],
-  figma: {                      // figma allows you to customize the way handoff
-    components: {               // fetches from figma.
-      alert: {                  // Customize the alert fetch
-        search: 'Alert',        // Search for alerts in a frame called Alert
+  figma: { // figma allows you to customize the way handoff fetches from figma.
+    size: [
+      // Component size map allows you to map figma
+      {
+        // size names (small, medium, large) to customize
+        figma: 'small', // your token names to match the sizes used
+        css: 'sm', // in your project like (sm, md, lg)
+      },
+      {
+        figma: 'medium',
+        css: 'md',
+      },
+      {
+        figma: 'large',
+        css: 'lg',
+      },
+    ],
+    components: {
+      alert: {
+        // Customize the alert fetch
+        search: 'Alert', // Search for alerts in a frame called Alert
       },
       button: {
         search: 'Button',
@@ -57,10 +61,11 @@ const config = {
       },
     },
   },
-  poweredBy: true,              // Show Powered By Handoff at the bottom of the site
-  logo: '/logo.svg',            // The logo to use on the site
-  favicon: '/favicon.ico',      // The Favicon for the site
-  type_sort: [                  // The preferred type sorting
+  poweredBy: true, // Show Powered By Handoff at the bottom of the site
+  logo: '/logo.svg', // The logo to use on the site
+  favicon: '/favicon.ico', // The Favicon for the site
+  type_sort: [
+    // The preferred type sorting
     'Heading 1',
     'Heading 2',
     'Heading 3',
@@ -75,13 +80,13 @@ const config = {
   ],
   // Containers for holding design elements. This object will be overwritten on fetch
   design: { color: [], typography: [], effect: [] },
-  // Containers for holding assets. This object will be overwritten on fetch  
+  // Containers for holding assets. This object will be overwritten on fetch
   assets: { icons: [], logos: [] },
-  // The sample text to use on the typography page                   
-  type_copy: 'Almost before we knew it, we had left the ground.', 
+  // The sample text to use on the typography page
+  type_copy: 'Almost before we knew it, we had left the ground.',
   // The sort order of the color types
-  color_sort: ['primary', 'secondary', 'extra', 'system'], 
-  // The sort order of the component types   
+  color_sort: ['primary', 'secondary', 'extra', 'system'],
+  // The sort order of the component types
   component_sort: ['primary', 'secondary', 'transparent'],
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "handoff-app",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Automated documentation toolchain for building client side documentation from figma",
   "author ": {
     "name": "Convertiv",