@peekling/preflight 0.1.0

package/AUTHORS

@@ -0,0 +1,8 @@
+Peekling Preflight was originally designed and developed by Prajwal S. Venkateshmurthy (https://prajwal.me).
+
+Other contributors are recorded in the repository history.
+
+This is a factual authorship record. Licensing terms and applicable
+notice-retention requirements are in LICENSE and NOTICE. Redistributions must
+comply with Section 4 of the Apache License 2.0, including its applicable
+notice-retention requirements.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSING.md

@@ -0,0 +1,20 @@
+# Licensing and attribution
+
+Peekling Preflight code and documentation are licensed under Apache-2.0. The
+license allows personal and commercial use, modification, distribution, and
+sublicensing subject to its terms.
+
+Redistributions must comply with Section 4 of the Apache License 2.0, including
+its applicable notice-retention requirements. When a distribution includes a
+`NOTICE` file, Section 4 describes how readable copies of applicable NOTICE
+attributions may be provided. Apache-2.0 does not require every website using
+Peekling to display a visible attribution.
+
+`AUTHORS` is a factual authorship record and does not add a license condition.
+Character assets retain their declared Pack licenses. The Peekling name, logo,
+official mascot, and other distinctive brand identity are outside this code
+license except as allowed by applicable law or separate permission. See Section
+6 of Apache-2.0.
+
+The Apache License text controls if this summary conflicts with it. This summary
+is informational and is not legal advice.

package/NOTICE

@@ -0,0 +1,6 @@
+Peekling Preflight
+Copyright 2026 Prajwal S. Venkateshmurthy
+
+Original design and development by Prajwal S. Venkateshmurthy.
+Contact: https://prajwal.me
+Project: https://peekling.com/

package/README.md

@@ -0,0 +1,195 @@
+# `@peekling/preflight`
+
+Use Preflight to check Peekling Configuration, Plan, and optional Pack data in
+Node without opening a browser, fetching resources, or executing application
+code. It is intended for development tools, tests, and CI.
+
+## Prerequisites and installation
+
+- Node.js 22.14.0 or newer
+- The exact matching `@peekling/runtime` version
+
+Install the runtime for the application and Preflight for development:
+
+```sh
+npm install @peekling/runtime@0.1.0
+npm install --save-dev @peekling/preflight@0.1.0
+```
+
+`@peekling/preflight` declares the exact runtime version as a peer dependency.
+That keeps development validation aligned with the runtime used by the
+application.
+
+## Run a complete check
+
+This example is self-contained. The all-zero SHA-256 is valid test metadata for
+Preflight, which does not fetch the atlas. Replace it with the hash of the real
+atlas bytes before passing the Pack to the browser runtime.
+
+```js
+import { preflight } from "@peekling/preflight";
+
+const configuration = {
+  packUrl: "./character.json",
+  plan: {
+    baseline: {
+      channels: ["state"],
+      state: { state: "idle" },
+    },
+  },
+};
+
+const pack = {
+  name: "preflight-example",
+  displayName: "Preflight example",
+  version: "0.1.0",
+  license: "CC0-1.0",
+  atlas: {
+    src: "atlas.png",
+    sha256: "0".repeat(64),
+    columns: 16,
+    rows: 1,
+    cellWidth: 32,
+    cellHeight: 32,
+  },
+  states: {
+    idle: { frames: [0], fps: 1, loop: true },
+  },
+  defaultScale: 1,
+};
+
+const report = preflight(configuration, {
+  pack,
+  baseUrl: "https://example.com/app/",
+});
+
+console.log(report);
+```
+
+Expected result:
+
+```js
+{
+  valid: true,
+  errors: [],
+  warnings: [],
+}
+```
+
+Passing the Pack through the second argument supplies explicit Pack context for
+authoring tools. Preflight can then check every Plan State and Capability
+reference instead of reporting that Pack context is missing.
+
+## API
+
+```ts
+preflight(configuration, options?): PreflightResult
+```
+
+| Argument          | Type      | Required | Meaning                                                                  |
+| ----------------- | --------- | -------- | ------------------------------------------------------------------------ |
+| `configuration`   | `unknown` | Yes      | Configuration data to snapshot and validate                              |
+| `options.pack`    | `unknown` | No       | Native or normalized Pack data used to check Plan references             |
+| `options.baseUrl` | `string`  | No       | Absolute HTTP or HTTPS page URL used only to resolve relative references |
+
+Configuration must select `character`, `packUrl`, or inline `pack`. Supplying
+`options.pack` also counts as explicit selection for an authoring tool. Do not
+pass both an inline Configuration Pack and `options.pack`.
+
+The result is deterministic:
+
+```ts
+interface PreflightResult {
+  readonly valid: boolean;
+  readonly errors: readonly PreflightDiagnostic[];
+  readonly warnings: readonly PreflightDiagnostic[];
+}
+
+interface PreflightDiagnostic {
+  readonly code: string;
+  readonly path: string;
+  readonly message: string;
+  readonly fix: string;
+}
+```
+
+`valid` is `true` only when `errors` is empty. Warnings still need review, but
+they do not change `valid` by themselves.
+
+## Handle diagnostics
+
+```js
+const report = preflight(configuration, { pack });
+
+for (const warning of report.warnings) {
+  console.warn(`${warning.code} at ${warning.path}: ${warning.message}`);
+}
+
+if (!report.valid) {
+  for (const error of report.errors) {
+    console.error(`${error.code} at ${error.path}: ${error.message}`);
+    console.error(`Fix: ${error.fix}`);
+  }
+  process.exitCode = 1;
+}
+```
+
+Expected result: valid input leaves the process exit code unchanged. Invalid
+input prints stable field paths and sets exit status `1` for CI.
+
+## What Preflight checks
+
+- Configuration uses the closed public shape and selects a Pack.
+- Plan Rules, Effects, channel ownership, and lifetimes are valid.
+- Pack context supports every referenced State and Capability.
+- Relative resource and content-link paths resolve against `baseUrl`.
+- Absolute serialized resource URLs use canonical HTTPS.
+- Theme colors use lowercase `transparent` or exact 3, 4, 6, or 8 digit hex.
+- JavaScript records contain own data properties instead of inherited fields or
+  accessors.
+- Atlas mirror and density choices agree with the supplied Pack.
+
+Preflight rejects credentials, malformed hosts or ports, protocol-relative and
+absolute HTTP resource URLs, Unicode whitespace, control characters,
+backslashes, and noncanonical IP spelling. An HTTP `baseUrl` is allowed for
+local development, but serialized absolute resource URLs still require HTTPS.
+
+Preflight does not fetch manifests, read atlas bytes, decode images, import
+application modules, run predicates, or call host callbacks. Runtime admission
+still validates data and resources that exist only in the browser.
+
+## Data boundary
+
+JavaScript records must use the current realm's ordinary `Object.prototype` or a
+null prototype. Custom prototypes, inherited fields, ordinary objects from
+another realm, and accessors reject. Parse cross-realm JSON in the receiving
+realm before checking it.
+
+Pack and Configuration snapshots are bounded. This prevents an authoring tool
+from handing unrestricted object graphs to the shared validators.
+
+## Choose the right integration
+
+| Need                                                     | Use                                    |
+| -------------------------------------------------------- | -------------------------------------- |
+| Call validation from JavaScript                          | `@peekling/preflight`                  |
+| Check JSON files from a terminal or CI job               | `peekling doctor` from `@peekling/cli` |
+| Check declared JSON files during Vite startup and builds | `@peekling/vite`                       |
+| Validate live browser Configuration and fetched bytes    | `@peekling/runtime`                    |
+
+Doctor applies the same semantic checks, then adds bounded JSON file reading and
+command-line output. Vite adds root-confined file handling and watched-input
+behavior. The browser runtime uses the same semantic kernel with a compact
+fail-fast diagnostic sink.
+
+## Related documentation
+
+- [Configure Peekling](../../docs/configuration.md)
+- [`@peekling/cli`](../cli/README.md)
+- [`@peekling/vite`](../vite/README.md)
+- [`@peekling/runtime`](../runtime/README.md)
+
+## License
+
+Apache-2.0. See [licensing and attribution](LICENSING.md) for notice retention,
+authorship, and brand boundaries.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { preflight } from "@peekling/runtime/preflight";
+export type { PreflightDiagnostic, PreflightOptions, PreflightResult, } from "@peekling/runtime/preflight";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1 @@
+export { preflight } from "@peekling/runtime/preflight";

package/dist/json.d.ts

@@ -0,0 +1,2 @@
+export { parseDataText } from "@peekling/runtime/pack";
+//# sourceMappingURL=json.d.ts.map

package/dist/json.js

@@ -0,0 +1 @@
+export { parseDataText } from "@peekling/runtime/pack";

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@peekling/preflight",
+  "version": "0.1.0",
+  "description": "Pure development-time validation for Peekling configuration and Packs",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Prajwal S. Venkateshmurthy",
+    "url": "https://prajwal.me"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/peekling/peekling-engine.git"
+  },
+  "homepage": "https://github.com/peekling/peekling-engine#readme",
+  "bugs": {
+    "url": "https://github.com/peekling/peekling-engine/issues"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "README.md",
+    "LICENSE",
+    "NOTICE",
+    "AUTHORS",
+    "LICENSING.md"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./json": {
+      "types": "./dist/json.d.ts",
+      "import": "./dist/json.js"
+    }
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "@peekling/runtime": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "prepack": "npm --prefix ../.. run build",
+    "test": "npm run build && node --test --experimental-strip-types test/*.test.ts",
+    "typecheck": "tsc -b --pretty false"
+  },
+  "devDependencies": {
+    "@peekling/runtime": "0.1.0",
+    "typescript": "^7.0.2"
+  }
+}