@astryxdesign/cli 0.1.6-canary.15dd282 → 0.1.6-canary.1b61ba6

package/src/template.mjs

@@ -1,73 +1,15 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
 /**
- * @file Static template authoring API.
+ * @file Static template authoring API (public `@astryxdesign/cli/template`).
  *
- * Helpers for authoring Astryx page/block template docs. Like
- * `createConfig`/`createIntegration`, these are tiny runtime identity helpers
- * whose real value is the exported TypeScript surface from
- * `@astryxdesign/cli/template`. They inject the discriminant `type` so a
- * discovered doc always knows whether it is a page or a block. They do NOT
- * validate — validation happens at the load boundary, where integration
- * template discovery runs the module's default export through
- * {@link TemplateEnvelopeSchema} (see `loadModuleWithSchema`).
+ * The `createPageTemplate`/`createBlockTemplate` authoring helpers now live in
+ * `@astryxdesign/core/authoring` and are re-exported here so existing
+ * `@astryxdesign/cli/template` imports keep working. The Zod load-boundary
+ * schemas live in `./schemas/template-schema.mjs` (core-free) and are
+ * re-exported here for back-compat; internal hot-path code imports them from
+ * the schema module directly so it never depends on core's built `dist/`.
  */
 
-import {z} from 'zod';
-
-const PreviewSchema = z
-  .object({
-    image: z.string().optional(),
-    aspectRatio: z.string().optional(),
-  })
-  .strict();
-
-/**
- * Shared authored-template shape. `type` is injected by the create* helpers,
- * so authors never write it. Inline source/sourceFile are intentionally NOT
- * part of v1 — a template's source is the required same-stem sibling file.
- * Exported so integration template discovery can validate the stamped result.
- */
-export const BaseTemplateSchema = z
-  .object({
-    name: z.string().min(1, 'name is required'),
-    description: z.string().min(1, 'description is required'),
-    category: z.string().optional(),
-    componentsUsed: z.array(z.string()).optional(),
-    preview: PreviewSchema.optional(),
-  })
-  .strict();
-
-/**
- * The metadata envelope integration template discovery validates: a stamped
- * template doc. This is the LOAD-boundary contract — a hand-written plain
- * object that matches this shape is accepted (discovery does not check "was it
- * made by the factory", only the shape).
- */
-export const TemplateEnvelopeSchema = BaseTemplateSchema.extend({
-  type: z.enum(['page', 'block']),
-});
-
-/**
- * Author an Astryx page template doc. Stamp-only: returns the def with
- * `type: 'page'` injected. Validation happens at the load boundary.
- *
- * @template {import('./types/template-api').AstryxPageTemplateInput} T
- * @param {T} def
- * @returns {T & {type: 'page'}}
- */
-export function createPageTemplate(def) {
-  return /** @type {T & {type: 'page'}} */ ({...def, type: 'page'});
-}
-
-/**
- * Author an Astryx block template doc. Stamp-only: returns the def with
- * `type: 'block'` injected. Validation happens at the load boundary.
- *
- * @template {import('./types/template-api').AstryxBlockTemplateInput} T
- * @param {T} def
- * @returns {T & {type: 'block'}}
- */
-export function createBlockTemplate(def) {
-  return /** @type {T & {type: 'block'}} */ ({...def, type: 'block'});
-}
+export {createPageTemplate, createBlockTemplate} from '@astryxdesign/core/authoring';
+export {BaseTemplateSchema, TemplateEnvelopeSchema} from './schemas/template-schema.mjs';

package/src/types/config.d.ts

@@ -1,70 +1,15 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
 /**
- * A command to run as part of a post-codemod hook. Returned by a hook's
- * `buildCommand` and executed via `execFile` after codemods write files.
+ * The config-authoring surface moved to `@astryxdesign/core/config` so an app's
+ * config file gets type feedback without depending on the CLI. Re-exported here
+ * so existing `@astryxdesign/cli/config` type imports keep resolving.
  */
-export interface PostCodemodCommand {
-  command: string;
-  args?: string[];
-  options?: {
-    cwd?: string;
-    env?: NodeJS.ProcessEnv;
-    timeout?: number;
-  };
-}
-
-/**
- * A post-codemod hook. `buildCommand` receives the package directory and the
- * list of files changed by codemods, and returns the command to run (or a
- * nullish value to skip).
- */
-export type PostCodemodHook = {
-  name?: string;
-  buildCommand: (ctx: {
-    packageDir: string;
-    files: string[];
-  }) =>
-    | PostCodemodCommand
-    | null
-    | undefined
-    | Promise<PostCodemodCommand | null | undefined>;
-};
-
-/** A component XLE layout expressions can reference by name via `{hint}`. */
-export interface XleComponent {
-  /** Import specifier the component is imported from, e.g. '@/components/KpiCard'. */
-  from: string;
-  /** Optional human description shown in tooling. */
-  description?: string;
-  /** Import as the module's default export instead of a named export. Defaults to false. */
-  default?: boolean;
-}
-
-/** User config exported from astryx.config.{ts,mjs,js}. */
-export interface AstryxConfig {
-  /** Integration package names to load. */
-  integrations?: string[];
-  /** Where to file issues/feedback for this project. */
-  issuesUrl?: string;
-  /** Lifecycle hooks. */
-  hooks?: {
-    postCodemod?: PostCodemodHook[];
-  };
-  /**
-   * EXPERIMENTAL — shape may change and is not part of the stable config
-   * contract. Provisional home for features still being proven out.
-   */
-  experimental?: {
-    /** Experimental XLE (layout expression) configuration. */
-    xle?: {
-      /**
-       * Register app-local components so XLE layout expressions can
-       * reference them by name via {hint}. Keyed by component name.
-       */
-      components?: Record<string, XleComponent>;
-    };
-  };
-}
-
-export declare function createConfig<T extends AstryxConfig>(config: T): T;
+export type {
+  PostCodemodCommand,
+  PostCodemodHook,
+  XleComponent,
+  AstryxConfig,
+} from '@astryxdesign/core/config';
+
+export {createConfig} from '@astryxdesign/core/config';

package/src/types/doc.d.ts

@@ -0,0 +1,23 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * The doc-authoring surface moved to `@astryxdesign/core/authoring`. Re-exported
+ * here so existing `@astryxdesign/cli/doc` type imports keep resolving. The Zod
+ * load-boundary schemas remain in the CLI (see `src/doc.mjs`).
+ */
+export type {
+  AstryxBaseDocInput,
+  AstryxPropInput,
+  AstryxParamInput,
+  AstryxReturnInput,
+  AstryxComponentDocInput,
+  AstryxFunctionDocInput,
+  AstryxGenericDocInput,
+  AstryxComponentDoc,
+} from '@astryxdesign/core/authoring';
+
+export {
+  createComponentDoc,
+  createFunctionDoc,
+  createDoc,
+} from '@astryxdesign/core/authoring';

package/src/types/integration.d.ts

@@ -1,21 +1,14 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
 /**
- * Integration manifest exported from a conventional root manifest file
- * (astryx.integration.{ts,mjs,js}) sibling to the integration package's
- * package.json. Identity (name/version) comes from the package's
- * package.json, not from the manifest.
+ * The integration-manifest authoring surface moved to
+ * `@astryxdesign/core/authoring`. `AstryxIntegration` and `createIntegration`
+ * are re-exported here so existing `@astryxdesign/cli/integration` type imports
+ * keep resolving. `AstryxIntegrationIssue` stays in the CLI — it is an internal
+ * validation type, not part of the authoring surface.
  */
-export interface AstryxIntegration {
-  /** Relative path to the components/docs root (resolved to absolute). */
-  components?: string;
-  /** Relative path to the templates root (resolved to absolute). */
-  templates?: string;
-  /** Relative path to the codemods root (resolved to absolute). */
-  codemods?: string;
-  /** Where to file issues/feedback for this integration. */
-  issuesUrl?: string;
-}
+export type {AstryxIntegration} from '@astryxdesign/core/authoring';
+export {createIntegration} from '@astryxdesign/core/authoring';
 
 /** An issue surfaced by an integration. */
 export interface AstryxIntegrationIssue {
@@ -23,7 +16,3 @@ export interface AstryxIntegrationIssue {
   severity: 'warning' | 'error';
   message: string;
 }
-
-export declare function createIntegration<T extends AstryxIntegration>(
-  integration: T,
-): T;

package/src/types/template-api.d.ts

@@ -1,54 +1,18 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
 /**
- * Authoring surface for Astryx static templates, exported from
- * `@astryxdesign/cli/template`.
- *
- * A template doc lives in a `<id>.doc.{ts,mjs,js}` file with a required
- * same-stem sibling source file (`<id>.tsx`). The doc's `type` (page or
- * block) — injected by the create* helpers — decides how the template is
- * scaffolded; there is no `/pages` vs `/blocks` directory requirement.
+ * The template-authoring surface moved to `@astryxdesign/core/authoring`.
+ * Re-exported here so existing `@astryxdesign/cli/template` type imports keep
+ * resolving.
  */
-
-/** Optional preview metadata for a template (used by docs surfaces). */
-export interface AstryxTemplatePreview {
-  /** Path or URL to a preview image. */
-  image?: string;
-  /** CSS aspect-ratio hint for the preview, e.g. "16 / 9". */
-  aspectRatio?: string;
-}
-
-/** Fields common to page and block template docs (without the `type` tag). */
-export interface AstryxTemplateInput {
-  /** Human-readable template name. Required. */
-  name: string;
-  /** One-line description of what the template provides. Required. */
-  description: string;
-  /** Optional grouping/category label. */
-  category?: string;
-  /** Component display names the template composes. */
-  componentsUsed?: string[];
-  /** Optional preview metadata. */
-  preview?: AstryxTemplatePreview;
-}
-
-/** Input accepted by {@link createPageTemplate} (no `type` field). */
-export type AstryxPageTemplateInput = AstryxTemplateInput;
-/** Input accepted by {@link createBlockTemplate} (no `type` field). */
-export type AstryxBlockTemplateInput = AstryxTemplateInput;
-
-/** A validated page template doc. */
-export type AstryxPageTemplate = AstryxTemplateInput & {type: 'page'};
-/** A validated block template doc. */
-export type AstryxBlockTemplate = AstryxTemplateInput & {type: 'block'};
-
-/** A validated template doc (page or block). */
-export type AstryxTemplate = AstryxPageTemplate | AstryxBlockTemplate;
-
-export declare function createPageTemplate<T extends AstryxPageTemplateInput>(
-  def: T,
-): T & {type: 'page'};
-
-export declare function createBlockTemplate<T extends AstryxBlockTemplateInput>(
-  def: T,
-): T & {type: 'block'};
+export type {
+  AstryxTemplatePreview,
+  AstryxTemplateInput,
+  AstryxPageTemplateInput,
+  AstryxBlockTemplateInput,
+  AstryxPageTemplate,
+  AstryxBlockTemplate,
+  AstryxTemplate,
+} from '@astryxdesign/core/authoring';
+
+export {createPageTemplate, createBlockTemplate} from '@astryxdesign/core/authoring';