@replayablejs/build 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Replayable contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# @replayablejs/build
+
+Run local preview and produce runnable playable variants.
+
+Part of [Replayable](https://github.com/replayablejs/replayable) **0.1.0-alpha.0**.
+APIs may change during the alpha series.
+
+## Install
+
+```sh
+pnpm add -D @replayablejs/build@0.1.0-alpha.0
+```
+
+## Public surface
+
+`servePreview`, `buildProject`, `buildVariant` and their option/result types.
+
+[Usage and reference](https://github.com/replayablejs/replayable/blob/main/docs/reference/build.md).
+The package manifest defines supported import paths; internal source files are not public APIs.
+
+## Development
+
+From the repository root, install with `pnpm install --frozen-lockfile` and build dependencies
+with `pnpm build`. Run `pnpm --filter @replayablejs/build test` for this package's tests.
+
+## License
+
+Original code is [MIT licensed](https://github.com/replayablejs/replayable/blob/main/LICENSE). Bundled third-party resources retain
+their accompanying license terms.

package/dist/index.d.mts

@@ -0,0 +1,85 @@
+import { BuildAssetsResult } from "@replayablejs/assets";
+import { PlayableVariant, ReplayableConfigInput } from "@replayablejs/config";
+//#region src/types/build.d.ts
+/** Optional variant and server choices accepted by local development. */
+interface ServePreviewOptions {
+  /** Hostname or IP address exposed by the development server. */
+  readonly host?: string;
+  /** Language selected from the configured playable variants. */
+  readonly language?: string;
+  /** Opens the playable in the default browser after the server starts. */
+  readonly open?: boolean;
+  /** Preferred development server port. */
+  readonly port?: number;
+  /** Root directory of the authored Replayable project. */
+  readonly projectRoot: string;
+  /** Version selected from the configured playable variants. */
+  readonly version?: string;
+}
+/** Running local development server and its selected playable variant. */
+interface ServePreviewResult {
+  /** Stops the development server and releases its resources. */
+  readonly close: () => Promise<void>;
+  /** URLs available only from the current machine. */
+  readonly localUrls: readonly string[];
+  /** URLs exposed to other devices on the network. */
+  readonly networkUrls: readonly string[];
+  /** ID of the concrete version, network, and language being served. */
+  readonly variantId: string;
+}
+/** Explicit filesystem destinations required to build one concrete variant. */
+interface BuildVariantOptions {
+  /** Absolute directory that will contain this runnable playable. */
+  readonly outputDirectory: string;
+  /** Root directory of the authored Replayable project. */
+  readonly projectRoot: string;
+}
+/** Files and metadata produced by one successful playable build. */
+interface BuildVariantResult {
+  /** Summary of the assets consumed by the playable bundle. */
+  readonly assets: BuildAssetsResult;
+  /** Absolute path to the generated playable HTML document. */
+  readonly htmlFile: string;
+  /** Absolute directory containing the complete runnable playable. */
+  readonly outputDirectory: string;
+  /** ID of the concrete version, network, and language that was built. */
+  readonly variantId: string;
+}
+/** Files and metadata produced by one successful project build. */
+interface BuildProjectResult {
+  /** Absolute directory containing every generated playable variant. */
+  readonly outputDirectory: string;
+  /** Results for the concrete variants in deterministic configuration order. */
+  readonly variants: readonly BuildVariantResult[];
+}
+//#endregion
+//#region src/development/serve-preview.d.ts
+/** Builds one preview variant's assets and starts its local Vite server. */
+declare function servePreview(config: ReplayableConfigInput, options: ServePreviewOptions): Promise<ServePreviewResult>;
+//#endregion
+//#region src/production/build-project.d.ts
+/**
+ * Builds every concrete variant configured by one Replayable project.
+ *
+ * Variants are built sequentially because their asset builds share generated
+ * source paths. The project output is reset once so variants removed from the
+ * configuration cannot leave stale playable directories behind.
+ * The first variant is restored afterward as a deterministic baseline. This
+ * does not isolate an active preview: build and development share asset paths.
+ *
+ * @param config - Human-authored or already validated Replayable configuration.
+ * @param workingDirectory - Project directory used to resolve authored paths.
+ */
+declare function buildProject(config: ReplayableConfigInput, workingDirectory?: string): Promise<BuildProjectResult>;
+//#endregion
+//#region src/production/build-variant.d.ts
+/**
+ * Produces one runnable playable from a concrete configuration variant.
+ *
+ * @param variant - Fully resolved version, network, and language combination.
+ * @param options - Explicit project root and variant output directory.
+ */
+declare function buildVariant(variant: PlayableVariant, options: BuildVariantOptions): Promise<BuildVariantResult>;
+//#endregion
+export { type BuildProjectResult, type BuildVariantOptions, type BuildVariantResult, type ServePreviewOptions, type ServePreviewResult, buildProject, buildVariant, servePreview };
+//# sourceMappingURL=index.d.mts.map