@njweber/app-check 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Boolean Build (a Boolean Bros project)
+
+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

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# app-check
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**One command to check a mobile build before the stores do.** `app-check` auto-detects the artifact,
+runs the right audit, and aggregates the result:
+
+```bash
+npx @njweber/app-check ./build/app-release.aab ./build/YourApp.ipa ./assets/icon.png
+```
+
+| Artifact | What it's checked for | Under the hood |
+|---|---|---|
+| `*.aab`, `*.apk` | Android 16 KB page-size compliance | [`store-check`](https://github.com/nwebersoftware/store-check) |
+| `*.ipa` | App Store submission pitfalls **and** privacy usage descriptions | [`ipa-check`](https://github.com/nwebersoftware/ipa-check) + [`privacy-check`](https://github.com/nwebersoftware/privacy-check) |
+| `*.png` | icon size / alpha rules | [`icon-check`](https://github.com/nwebersoftware/icon-check) |
+
+```
+✓ store-check — 16 KB page-size audit
+…
+✓ ipa-check — iOS submission audit
+…
+✗ icon-check — app icon audit
+  ✗ ios-alpha  has an alpha channel — the App Store icon must have NO transparency
+
+✗ app-check: 3 checks, 1 failed.
+```
+
+## Usage
+
+```bash
+# explicit files
+npx @njweber/app-check ./app-release.aab ./YourApp.ipa
+
+# scan a build directory (recursive; skips node_modules/.git/ios/android)
+npx @njweber/app-check --dir ./dist
+
+# options
+npx @njweber/app-check ./assets/icon.png --android        # adaptive-icon foreground rules
+npx @njweber/app-check ./YourApp.ipa --bundle-id com.acme.app
+npx @njweber/app-check --dir ./dist --json                # machine-readable
+```
+
+**Exit codes:** `0` all good · `1` at least one blocking issue · `2` bad input.
+
+## CI
+
+```yaml
+- uses: nwebersoftware/app-check@main
+  with:
+    path: dist
+```
+
+## What it is not
+
+It's a fast, offline pre-flight — not a substitute for the store's own validation. It catches the
+*mechanical* rejections (alignment, plist shape, icon alpha) that are cheap to check and expensive
+to discover mid-review.
+
+## Family
+
+Each check is also its own focused tool: `store-check` · `ipa-check` · `privacy-check` · `icon-check`.
+
+An `.ipa` deliberately runs **two** audits — submission shape (`ipa-check`) and privacy declarations
+(`privacy-check`).
+
+## License
+
+MIT.

package/bin/app-check.mjs

@@ -0,0 +1,116 @@
+#!/usr/bin/env node
+import { readFileSync, readdirSync } from 'node:fs';
+import { extname, join } from 'node:path';
+
+import { classify, checksFor, runCheck, SUPPORTED } from '../src/run.mjs';
+
+const HELP = `app-check — check a mobile build before the stores do
+
+Usage:
+  app-check <path...> [options]
+
+Checks (auto-detected by extension):
+  *.aab, *.apk   Android — 16 KB page size     (store-check)
+  *.ipa          iOS — submission pitfalls      (ipa-check)
+  *.png          icon rules                     (icon-check)
+
+Options:
+  --dir <dir>        also scan a directory for the above (recursive)
+  --android          treat PNGs as Android adaptive-icon foregrounds
+  --bundle-id <id>   expected iOS CFBundleIdentifier
+  --json             machine-readable output
+  -h, --help
+
+Exit: 0 all good · 1 blocking issue(s) · 2 bad input.
+`;
+
+function parse(argv) {
+  const paths = [];
+  const opts = { json: false, android: false, dir: null, bundleId: null };
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a === '--json') opts.json = true;
+    else if (a === '--android') opts.android = true;
+    else if (a === '--dir') opts.dir = argv[++i];
+    else if (a === '--bundle-id') opts.bundleId = argv[++i];
+    else if (a === '-h' || a === '--help') { process.stdout.write(HELP); process.exit(0); }
+    else if (a.startsWith('-')) { process.stderr.write(`unknown flag: ${a}\n`); process.exit(2); }
+    else paths.push(a);
+  }
+  return { paths, opts };
+}
+
+const SKIP = new Set(['node_modules', '.git', 'ios', 'android', '.expo']);
+
+function collect(dir, out = []) {
+  for (const e of readdirSync(dir, { withFileTypes: true })) {
+    if (e.name.startsWith('.') || SKIP.has(e.name)) continue;
+    const p = join(dir, e.name);
+    if (e.isDirectory()) collect(p, out);
+    else if (SUPPORTED.includes(extname(e.name).toLowerCase())) out.push(p);
+  }
+  return out;
+}
+
+const { paths, opts } = parse(process.argv.slice(2));
+const files = [...paths];
+if (opts.dir) files.push(...collect(opts.dir));
+
+if (files.length === 0) {
+  process.stderr.write(HELP);
+  process.exit(2);
+}
+
+const results = [];
+let badInput = false;
+
+for (const file of files) {
+  const kind = classify(file);
+  if (!kind) {
+    process.stderr.write(`skipped (unrecognized): ${file}\n`);
+    badInput = true;
+    continue;
+  }
+  let buf;
+  try {
+    buf = readFileSync(file);
+  } catch (e) {
+    process.stderr.write(`cannot read ${file}: ${e.message}\n`);
+    badInput = true;
+    continue;
+  }
+  for (const k of checksFor(kind)) {
+    const co = { label: file };
+    if (k === 'icon' && opts.android) co.platform = 'android';
+    if (k === 'ios' && opts.bundleId) co.bundleId = opts.bundleId;
+    results.push(runCheck(k, buf, co));
+  }
+}
+
+const failed = results.filter((r) => !r.report.ok).length;
+
+if (opts.json) {
+  const payload = {
+    ok: failed === 0 && results.length > 0,
+    files: results.map((r) => ({
+      file: r.label,
+      tool: r.name,
+      ok: !!r.report.ok,
+      error: r.error,
+      checks: r.report.checks ?? undefined,
+      failures: r.report.failures?.map((f) => f.abi),
+    })),
+  };
+  process.stdout.write(JSON.stringify(payload, null, 2) + '\n');
+} else {
+  for (const r of results) {
+    process.stdout.write(r.text + '\n');
+    process.stdout.write('\n' + '─'.repeat(60) + '\n\n');
+  }
+  const n = results.length;
+  const summary = `app-check: ${n} check${n === 1 ? '' : 's'}, ${failed} failed.`;
+  process.stdout.write(failed === 0 ? `✓ ${summary}\n` : `✗ ${summary}\n`);
+}
+
+if (results.length === 0) process.exit(2);
+process.exit(failed > 0 ? 1 : 0);

package/package.json

@@ -1,6 +1,26 @@
 {
   "name": "@njweber/app-check",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "One command to check a mobile build before the stores do — Android 16 KB page size, iOS .ipa pitfalls, and icon rules.",
+  "type": "module",
+  "bin": {
+    "app-check": "bin/app-check.mjs"
+  },
+  "files": ["bin", "src", "README.md", "LICENSE"],
+  "scripts": {
+    "test": "node --test"
+  },
+  "keywords": ["ios", "android", "app-store", "google-play", "release", "submission", "react-native", "expo", "cli"],
+  "repository": { "type": "git", "url": "git+https://github.com/nwebersoftware/app-check.git" },
+  "homepage": "https://github.com/nwebersoftware/app-check#readme",
+  "bugs": { "url": "https://github.com/nwebersoftware/app-check/issues" },
+  "author": "Boolean Build (a Boolean Bros project)",
+  "license": "MIT",
+  "engines": { "node": ">=18" },
+  "dependencies": {
+    "@njweber/store-check": "^0.1.0",
+    "@njweber/ipa-check": "^0.1.0",
+    "@njweber/privacy-check": "^0.1.0",
+    "icon-check": "^0.1.0"
+  }
+}

package/src/run.mjs

@@ -0,0 +1,51 @@
+import { checkArtifact, formatReport as fmtAndroid } from '@njweber/store-check/src/check.mjs';
+import { checkIpa, formatReport as fmtIpa } from '@njweber/ipa-check/src/check.mjs';
+import { checkPrivacy, formatReport as fmtPrivacy } from '@njweber/privacy-check/src/check.mjs';
+import { checkIcon, formatReport as fmtIcon } from 'icon-check/src/check.mjs';
+
+const TOOLS = {
+  android: { name: 'store-check', run: (buf) => checkArtifact(buf), fmt: fmtAndroid },
+  ios: { name: 'ipa-check', run: (buf, o) => checkIpa(buf, o), fmt: fmtIpa },
+  privacy: { name: 'privacy-check', run: (buf) => checkPrivacy(buf), fmt: fmtPrivacy },
+  icon: { name: 'icon-check', run: (buf, o) => checkIcon(buf, o), fmt: fmtIcon },
+};
+
+/** Map a file path to the primary check that applies, by extension. */
+export function classify(file) {
+  const lower = String(file).toLowerCase();
+  if (lower.endsWith('.aab') || lower.endsWith('.apk')) return 'android';
+  if (lower.endsWith('.ipa')) return 'ios';
+  if (lower.endsWith('.png')) return 'icon';
+  return null;
+}
+
+/** Every check that should run for an artifact kind (an .ipa gets two audits). */
+export function checksFor(kind) {
+  if (kind === 'ios') return ['ios', 'privacy'];
+  return [kind];
+}
+
+/**
+ * Run one check, never throwing: a bad artifact becomes a failing result, not a crash.
+ * Returns { kind, name, label, report, text, error }.
+ */
+export function runCheck(kind, buf, opts = {}) {
+  const t = TOOLS[kind];
+  if (!t) throw new Error(`unknown check kind: ${kind}`);
+  const label = opts.label ?? '';
+  try {
+    const report = t.run(buf, opts);
+    return { kind, name: t.name, label, report, text: t.fmt(report, label), error: null };
+  } catch (e) {
+    return {
+      kind,
+      name: t.name,
+      label,
+      report: { ok: false },
+      text: `${t.name} — could not check ${label || 'input'}\n  ${e.message}`,
+      error: e.message,
+    };
+  }
+}
+
+export const SUPPORTED = ['.aab', '.apk', '.ipa', '.png'];