handoff-app 1.2.2-3 → 1.2.2-5

package/Changelog.md

@@ -12,6 +12,11 @@ This patch release clears ESLint failures in the Next.js app pages and aligns
 several code paths with the compiler target so production builds succeed without
 enabling `--downlevelIteration`.
 
+### Change
+
+* Altered the avaliable types to the SlotMetadata so the default can handle
+  a wide variaty of types - `default?: string | number | boolean | object | any[] | null;`
+
 ### Lint and code quality
 
 * Resolved `no-else-return`, `no-unused-vars`, `camelcase`, `prefer-const`,

package/dist/app-builder/build.js

@@ -18,9 +18,9 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 const components_1 = require("../pipeline/components");
 const patterns_1 = require("../pipeline/patterns");
+const builder_1 = __importDefault(require("../transformers/preview/component/builder"));
 const css_1 = require("../transformers/preview/component/css");
 const javascript_1 = require("../transformers/preview/component/javascript");
-const builder_1 = __importDefault(require("../transformers/preview/component/builder"));
 const logger_1 = require("../utils/logger");
 const client_config_1 = require("./client-config");
 const paths_1 = require("./paths");
@@ -54,11 +54,15 @@ const initializeProjectApp = (handoff) => __awaiter(void 0, void 0, void 0, func
     yield (0, paths_1.syncPublicFiles)(handoff);
     // Copy custom theme CSS if it exists in the user's project
     const customThemePath = path_1.default.resolve(handoff.workingPath, 'theme.css');
+    const destPath = path_1.default.resolve(appPath, 'css', 'theme.css');
     if (fs_extra_1.default.existsSync(customThemePath)) {
-        const destPath = path_1.default.resolve(appPath, 'css', 'theme.css');
         yield fs_extra_1.default.copy(customThemePath, destPath, { overwrite: true });
         logger_1.Logger.success(`Custom theme.css loaded`);
     }
+    else {
+        // create a empty theme.css file
+        yield fs_extra_1.default.writeFile(destPath, '');
+    }
     // Prepare project app configuration using stable placeholder replacement.
     const handoffProjectId = handoff.getProjectId();
     const handoffAppBasePath = (_a = handoff.config.app.base_path) !== null && _a !== void 0 ? _a : '';

package/dist/transformers/preview/component.d.ts

@@ -26,7 +26,7 @@ export interface SlotMetadata {
     name: string;
     description: string;
     generic: string;
-    default?: string;
+    default?: string | number | boolean | object | any[] | null;
     type: SlotType;
     items?: {
         type: SlotType;

package/dist/transformers/preview/component.js

@@ -16,10 +16,10 @@ exports.getComponentOutputPath = exports.SlotType = void 0;
 exports.componentTransformer = componentTransformer;
 const path_1 = __importDefault(require("path"));
 const api_1 = require("./component/api");
-const summary_1 = __importDefault(require("./component/summary"));
 const builder_1 = __importDefault(require("./component/builder"));
 const css_1 = require("./component/css");
 const javascript_1 = require("./component/javascript");
+const summary_1 = __importDefault(require("./component/summary"));
 var SlotType;
 (function (SlotType) {
     SlotType["TEXT"] = "text";

package/package.json

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

package/src/app/css.d.ts

@@ -0,0 +1 @@
+declare module '*.css' {}

package/src/app/pages/_app.tsx

@@ -1,5 +1,8 @@
 import type { AppProps } from 'next/app';
 
+import '../css/index.css';
+import '../css/theme.css';
+
 function MyApp({ Component, pageProps }: AppProps) {
   return (
     <>

package/src/app-builder/build.ts

@@ -4,13 +4,23 @@ import path from 'path';
 import Handoff from '..';
 import { buildComponents } from '../pipeline/components';
 import { buildPatterns } from '../pipeline/patterns';
+import processComponents from '../transformers/preview/component/builder';
 import { buildMainCss } from '../transformers/preview/component/css';
 import { buildMainJS } from '../transformers/preview/component/javascript';
-import processComponents from '../transformers/preview/component/builder';
 import { Logger } from '../utils/logger';
 import { generateTokensApi, persistClientConfig } from './client-config';
 import { getAppPath, syncPublicFiles } from './paths';
-import { WatcherState, getRuntimeComponentsPathsToWatch, watchAppSource, watchComponentDirectories, watchGlobalEntries, watchPages, watchPublicDirectory, watchRuntimeComponents, watchRuntimeConfiguration } from './watchers';
+import {
+  WatcherState,
+  getRuntimeComponentsPathsToWatch,
+  watchAppSource,
+  watchComponentDirectories,
+  watchGlobalEntries,
+  watchPages,
+  watchPublicDirectory,
+  watchRuntimeComponents,
+  watchRuntimeConfiguration,
+} from './watchers';
 import { createWebSocketServer } from './websocket';
 
 const escapeForSingleQuotedJsString = (value: string): string => value.replace(/\\/g, '\\\\').replace(/'/g, "\\'");
@@ -46,10 +56,13 @@ const initializeProjectApp = async (handoff: Handoff): Promise<string> => {
 
   // Copy custom theme CSS if it exists in the user's project
   const customThemePath = path.resolve(handoff.workingPath, 'theme.css');
+  const destPath = path.resolve(appPath, 'css', 'theme.css');
   if (fs.existsSync(customThemePath)) {
-    const destPath = path.resolve(appPath, 'css', 'theme.css');
     await fs.copy(customThemePath, destPath, { overwrite: true });
     Logger.success(`Custom theme.css loaded`);
+  } else {
+    // create a empty theme.css file
+    await fs.writeFile(destPath, '');
   }
 
   // Prepare project app configuration using stable placeholder replacement.

package/src/transformers/preview/component.ts

@@ -2,10 +2,10 @@ import type { DocAnnotation, TypeNode } from 'handoff-docgen';
 import path from 'path';
 import Handoff from '../../index';
 import { getAPIPath } from './component/api';
-import writeComponentSummaryAPI from './component/summary';
 import processComponents from './component/builder';
 import { buildMainCss } from './component/css';
 import { buildMainJS } from './component/javascript';
+import writeComponentSummaryAPI from './component/summary';
 
 export interface ComponentMetadata {
   title: string;
@@ -33,7 +33,7 @@ export interface SlotMetadata {
   name: string;
   description: string;
   generic: string;
-  default?: string;
+  default?: string | number | boolean | object | any[] | null;
   type: SlotType;
   // used if type is array
   items?: {