handoff-app 2.0.0-5 → 2.0.0-7

package/dist/index.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoreTypes = exports.CoreTransformerUtils = exports.CoreTransformers = exports.defineAssetStorage = exports.defineReactComponent = exports.definePattern = exports.defineHandlebarsComponent = exports.defineCsfComponent = exports.defineComponent = exports.defineConfig = void 0;
+exports.CoreTypes = exports.CoreTransformerUtils = exports.CoreTransformers = exports.defineAssetStorage = exports.defineConfig = void 0;
 require("dotenv/config");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const handoff_core_1 = require("handoff-core");
@@ -142,7 +142,6 @@ class Handoff {
         this.skipBuild = (_d = options.skipBuild) !== null && _d !== void 0 ? _d : false;
         logger_1.Logger.init({ debug: this.debug });
         this.init(options.config);
-        global.handoff = this;
     }
     init(configOverride) {
         var _a, _b, _c;
@@ -268,6 +267,34 @@ class Handoff {
             return this;
         });
     }
+    /**
+     * Publish the catalog items declared in this connected workspace to the configured remote registry:
+     * every one, or only the named ids. An item takes the component lane or the pattern lane depending
+     * on whether it declares an implementation or a composition, so the lane is resolved from the
+     * workspace rather than named by the caller. One build covers both lanes. The publish module is
+     * loaded lazily so the registry client and build code never enter the docs app bundle.
+     */
+    publishCatalog(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.preRunner();
+            const { publishCatalog } = yield Promise.resolve().then(() => __importStar(require('./registry/publish')));
+            yield publishCatalog(this, toSelection(id));
+            return this;
+        });
+    }
+    /**
+     * Checkout published catalog items from the connected remote registry into this workspace: every
+     * one, or only the named ids. The lane an item was published into is looked up in the registry.
+     * Mirrors {@link publishCatalog}.
+     */
+    checkoutCatalog(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.preRunner();
+            const { checkoutCatalog } = yield Promise.resolve().then(() => __importStar(require('./registry/checkout')));
+            yield checkoutCatalog(this, toSelection(id));
+            return this;
+        });
+    }
     /**
      * Publish design token sets from this connected workspace to the configured remote registry. Runs a
      * fresh token build (Figma extract + style transformers), discovers the logical sets, and uploads
@@ -392,13 +419,6 @@ class Handoff {
             return this;
         });
     }
-    makeTemplate(component, state) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.preRunner();
-            yield (0, make_1.makeTemplate)(this, component, state);
-            return this;
-        });
-    }
     makePage(name, parent) {
         return __awaiter(this, void 0, void 0, function* () {
             this.preRunner();
@@ -586,12 +606,6 @@ class Handoff {
 }
 var config_2 = require("./config");
 Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return config_2.defineConfig; } });
-var declarations_1 = require("./declarations");
-Object.defineProperty(exports, "defineComponent", { enumerable: true, get: function () { return declarations_1.defineComponent; } });
-Object.defineProperty(exports, "defineCsfComponent", { enumerable: true, get: function () { return declarations_1.defineCsfComponent; } });
-Object.defineProperty(exports, "defineHandlebarsComponent", { enumerable: true, get: function () { return declarations_1.defineHandlebarsComponent; } });
-Object.defineProperty(exports, "definePattern", { enumerable: true, get: function () { return declarations_1.definePattern; } });
-Object.defineProperty(exports, "defineReactComponent", { enumerable: true, get: function () { return declarations_1.defineReactComponent; } });
 var define_1 = require("./registry/asset-storage/define");
 Object.defineProperty(exports, "defineAssetStorage", { enumerable: true, get: function () { return define_1.defineAssetStorage; } });
 // Export transformers and types from handoff-core

package/dist/pattern.d.ts

@@ -0,0 +1,7 @@
+import type { CatalogItem, CatalogItemMeta, CompositionRef } from './catalog/types';
+export type { CatalogItem, CatalogItemMeta, CompositionRef } from './catalog/types';
+/** Declares a catalog item built from a `composition` of other items, referenced by id. */
+export declare const defineCatalogItem: (input: CatalogItemMeta & {
+    composition: CompositionRef[];
+    implementation?: never;
+}) => CatalogItem<never>;

package/dist/pattern.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineCatalogItem = void 0;
+/**
+ * Composition catalog items.
+ *
+ * A composition renders by referencing other items, so it declares no implementation and owns no
+ * previews — `CatalogPreview` and `Preview` are deliberately not re-exported here.
+ */
+const define_1 = require("./catalog/define");
+/** Declares a catalog item built from a `composition` of other items, referenced by id. */
+const defineCatalogItem = (input) => (0, define_1.createCatalogItem)(input);
+exports.defineCatalogItem = defineCatalogItem;

package/dist/react.d.ts

@@ -0,0 +1,43 @@
+/** React catalog items, including the CSF source format. */
+import type { ComponentType, ReactNode } from 'react';
+import type { CatalogItem, CatalogItemMeta, CsfSource } from './catalog/types';
+export type { CatalogItem, CatalogItemMeta, CatalogPreview, CompositionRef, CsfSource, Preview, SourceDescriptor } from './catalog/types';
+/** Reads the implementation from a CSF file. That file also defines the previews. */
+export declare const fromCSF: (file: string) => CsfSource;
+type PropsOf<TComponent> = TComponent extends ComponentType<infer TProps> ? TProps : Record<string, unknown>;
+/** Argument metadata for one property, shaped like the Storybook equivalent. */
+export type ArgType = {
+    name?: string;
+    description?: string;
+    control?: unknown;
+    table?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** CSF meta type, so a story file type-checks without a Storybook dependency. */
+export type Meta<TComponent = unknown> = {
+    title?: string;
+    component?: TComponent;
+    args?: Partial<PropsOf<TComponent>>;
+    argTypes?: Record<string, ArgType>;
+    render?: (args: PropsOf<TComponent>) => ReactNode;
+};
+/** CSF story type, so a story file type-checks without a Storybook dependency. */
+export type StoryObj<TMeta = unknown> = TMeta extends {
+    component?: infer TComponent;
+} ? {
+    name?: string;
+    args?: Partial<PropsOf<TComponent>>;
+    argTypes?: Record<string, ArgType>;
+    render?: (args: PropsOf<TComponent>) => ReactNode;
+} : never;
+/**
+ * `implementation` accepts an imported component, a file path, or `fromCSF(...)`. For an imported
+ * component, the file is resolved from the import in this declaration. The renderer comes from this
+ * module, so the build fails an item whose file does not match it.
+ */
+export declare function defineCatalogItem<TProps = Record<string, unknown>>(input: CatalogItemMeta & {
+    implementation: ComponentType<TProps> | string;
+}): CatalogItem<TProps>;
+export declare function defineCatalogItem(input: CatalogItemMeta & {
+    implementation: CsfSource;
+}): CatalogItem<never>;

package/dist/react.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromCSF = void 0;
+exports.defineCatalogItem = defineCatalogItem;
+const define_1 = require("./catalog/define");
+/** Reads the implementation from a CSF file. That file also defines the previews. */
+const fromCSF = (file) => ({ format: 'csf', file });
+exports.fromCSF = fromCSF;
+function defineCatalogItem(input) {
+    return (0, define_1.createCatalogItem)(input, 'react');
+}

package/dist/registry/asset-storage/define.d.ts

@@ -1,5 +1,5 @@
 /**
- * Typed identity helper for custom asset storage adapters (mirrors `defineComponent`): a consumer
+ * Typed identity helper for custom asset storage adapters (mirrors `defineCatalogItem`): a consumer
  * default-exports its result from a **server-only** module and points
  * `runtime.registry.assetStorage.module` at it. It must be its own module (not an inline
  * `defineConfig` function) so the build can trace it into the deployed registry. The default export

package/dist/registry/asset-storage/define.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * Typed identity helper for custom asset storage adapters (mirrors `defineComponent`): a consumer
+ * Typed identity helper for custom asset storage adapters (mirrors `defineCatalogItem`): a consumer
  * default-exports its result from a **server-only** module and points
  * `runtime.registry.assetStorage.module` at it. It must be its own module (not an inline
  * `defineConfig` function) so the build can trace it into the deployed registry. The default export

package/dist/registry/checkout/index.d.ts

@@ -43,3 +43,12 @@ export declare const checkoutEntity: (handoff: Handoff, kind: TransferEntityKind
  * prompting is per entity (skipped under `--force`).
  */
 export declare const checkoutEntities: (handoff: Handoff, kind: TransferEntityKind, ids?: string[]) => Promise<void>;
+/**
+ * Checkout published catalog items into this workspace: every one, or only `ids` when given. An item
+ * was published as a component or as a pattern depending on its declaration, so the lane is looked up
+ * in the registry and the caller never names one.
+ *
+ * A failing lane is reported and never aborts the other. The run throws at the end if any item
+ * failed.
+ */
+export declare const checkoutCatalog: (handoff: Handoff, ids?: string[]) => Promise<void>;