@astryxdesign/core 0.2.0 → 0.3.0

package/dist/authoring/integration.js

@@ -1,30 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * @file integration.ts
- * @input An integration package's manifest object.
- * @output A type-preserving `createIntegration` helper plus the
- *   `AstryxIntegration` manifest surface.
- * @position Integration-author authoring surface. See `./index.ts` for why
- *   these authoring factories live in `@astryxdesign/core`.
- *
- * `createIntegration` is an intentionally tiny runtime identity function: it
- * returns its argument unchanged. Validation is NOT performed here — it happens
- * at the CLI load boundary.
- */
-
-/**
- * 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.
- */
-
-/**
- * Type-preserving helper for an Astryx integration manifest. Returns its
- * argument unchanged; the value is the exported TypeScript surface. Validation
- * happens at the CLI load boundary.
- */
-export function createIntegration(integration) {
-  return integration;
-}

package/dist/authoring/template.d.ts

@@ -1,66 +0,0 @@
-/**
- * @file template.ts
- * @input A page/block template doc object (without the `type` tag).
- * @output Type-preserving `createPageTemplate`/`createBlockTemplate` helpers
- *   plus the authored-template TypeScript surface.
- * @position Integration-author authoring surface. See `./index.ts` for why
- *   these authoring factories live in `@astryxdesign/core`.
- *
- * 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.
- *
- * These are tiny runtime identity helpers that inject the `type` discriminant.
- * They do NOT validate — validation happens at the CLI load boundary, where
- * integration template discovery runs the module's default export through the
- * template envelope schema.
- */
-/** 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;
-/**
- * Author an Astryx page template doc. Stamp-only: returns the def with
- * `type: 'page'` injected. Validation happens at the CLI load boundary.
- */
-export declare function createPageTemplate<T extends AstryxPageTemplateInput>(def: T): T & {
-    type: 'page';
-};
-/**
- * Author an Astryx block template doc. Stamp-only: returns the def with
- * `type: 'block'` injected. Validation happens at the CLI load boundary.
- */
-export declare function createBlockTemplate<T extends AstryxBlockTemplateInput>(def: T): T & {
-    type: 'block';
-};
-//# sourceMappingURL=template.d.ts.map

package/dist/authoring/template.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../src/authoring/template.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;GAgBG;AAEH,wEAAwE;AACxE,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,8EAA8E;AAC9E,MAAM,WAAW,mBAAmB;IAClC,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,iCAAiC;IACjC,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC;AAED,sEAAsE;AACtE,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,CAAC;AAC1D,uEAAuE;AACvE,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,CAAC;AAE3D,qCAAqC;AACrC,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAAC;AACtE,sCAAsC;AACtC,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IAAC,IAAI,EAAE,OAAO,CAAA;CAAC,CAAC;AAExE,gDAAgD;AAChD,MAAM,MAAM,cAAc,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;AAEtE;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,uBAAuB,EAClE,GAAG,EAAE,CAAC,GACL,CAAC,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAEpB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,wBAAwB,EACpE,GAAG,EAAE,CAAC,GACL,CAAC,GAAG;IAAC,IAAI,EAAE,OAAO,CAAA;CAAC,CAErB"}

package/dist/authoring/template.js

@@ -1,55 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * @file template.ts
- * @input A page/block template doc object (without the `type` tag).
- * @output Type-preserving `createPageTemplate`/`createBlockTemplate` helpers
- *   plus the authored-template TypeScript surface.
- * @position Integration-author authoring surface. See `./index.ts` for why
- *   these authoring factories live in `@astryxdesign/core`.
- *
- * 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.
- *
- * These are tiny runtime identity helpers that inject the `type` discriminant.
- * They do NOT validate — validation happens at the CLI load boundary, where
- * integration template discovery runs the module's default export through the
- * template envelope schema.
- */
-
-/** Optional preview metadata for a template (used by docs surfaces). */
-
-/** Fields common to page and block template docs (without the `type` tag). */
-
-/** Input accepted by {@link createPageTemplate} (no `type` field). */
-
-/** Input accepted by {@link createBlockTemplate} (no `type` field). */
-
-/** A validated page template doc. */
-
-/** A validated block template doc. */
-
-/** A validated template doc (page or block). */
-
-/**
- * Author an Astryx page template doc. Stamp-only: returns the def with
- * `type: 'page'` injected. Validation happens at the CLI load boundary.
- */
-export function createPageTemplate(def) {
-  return {
-    ...def,
-    type: 'page'
-  };
-}
-
-/**
- * Author an Astryx block template doc. Stamp-only: returns the def with
- * `type: 'block'` injected. Validation happens at the CLI load boundary.
- */
-export function createBlockTemplate(def) {
-  return {
-    ...def,
-    type: 'block'
-  };
-}

package/dist/config.d.ts

@@ -1,80 +0,0 @@
-/**
- * @file config.ts
- * @input An app's Astryx config object.
- * @output A type-preserving `createConfig` helper plus the `AstryxConfig`
- *   surface authors write in `astryx.config.{ts,mjs,js}`.
- * @position Consumer-facing authoring surface. Lives in `@astryxdesign/core`
- *   (not the CLI) so an app's config file gets editor/type feedback without
- *   taking a dependency on the CLI. The CLI re-exports this from
- *   `@astryxdesign/cli/config` for back-compat.
- *
- * `createConfig` is an intentionally tiny runtime identity function: it returns
- * its argument unchanged. Its value is the exported TypeScript surface.
- * Validation is NOT performed here — it happens at the CLI load boundary.
- */
-/**
- * A command to run as part of a post-codemod hook. Returned by a hook's
- * `buildCommand` and executed after codemods write files.
- */
-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>;
-        };
-    };
-}
-/**
- * Type-preserving helper for the Astryx config file. Returns its argument
- * unchanged; the value is the exported TypeScript surface so config files get
- * editor/type feedback. Validation happens at the CLI load boundary.
- */
-export declare function createConfig<T extends AstryxConfig>(config: T): T;
-//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AAEH;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;QACxB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,CAAC,GAAG,EAAE;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,KACG,kBAAkB,GAClB,IAAI,GACJ,SAAS,GACT,OAAO,CAAC,kBAAkB,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;CACpD,CAAC;AAEF,6EAA6E;AAC7E,MAAM,WAAW,YAAY;IAC3B,oFAAoF;IACpF,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0FAA0F;IAC1F,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,2DAA2D;AAC3D,MAAM,WAAW,YAAY;IAC3B,yCAAyC;IACzC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,KAAK,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;KACjC,CAAC;IACF;;;OAGG;IACH,YAAY,CAAC,EAAE;QACb,0DAA0D;QAC1D,GAAG,CAAC,EAAE;YACJ;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;SAC3C,CAAC;KACH,CAAC;CACH;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAEjE"}

package/dist/config.js

@@ -1,40 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * @file config.ts
- * @input An app's Astryx config object.
- * @output A type-preserving `createConfig` helper plus the `AstryxConfig`
- *   surface authors write in `astryx.config.{ts,mjs,js}`.
- * @position Consumer-facing authoring surface. Lives in `@astryxdesign/core`
- *   (not the CLI) so an app's config file gets editor/type feedback without
- *   taking a dependency on the CLI. The CLI re-exports this from
- *   `@astryxdesign/cli/config` for back-compat.
- *
- * `createConfig` is an intentionally tiny runtime identity function: it returns
- * its argument unchanged. Its value is the exported TypeScript surface.
- * Validation is NOT performed here — it happens at the CLI load boundary.
- */
-
-/**
- * A command to run as part of a post-codemod hook. Returned by a hook's
- * `buildCommand` and executed after codemods write files.
- */
-
-/**
- * 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).
- */
-
-/** A component XLE layout expressions can reference by name via `{hint}`. */
-
-/** User config exported from astryx.config.{ts,mjs,js}. */
-
-/**
- * Type-preserving helper for the Astryx config file. Returns its argument
- * unchanged; the value is the exported TypeScript surface so config files get
- * editor/type feedback. Validation happens at the CLI load boundary.
- */
-export function createConfig(config) {
-  return config;
-}