@makefully/adaptfully 5.0.6 → 5.0.8

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project are documented in this file.
 
+## 5.0.8 — 2026-10-22
+
+### Fixed
+
+- **Scoped package gameIds** — `buildGameId()` / `sanitizeFsSegment()` flatten `@scope/name` (and `\`) so Yap `gameId`, extract/prebuild folder segments, and saved zip/report names stay single path segments (e.g. `makefully-fancifully-0.1.0`).
+
+## 5.0.7 — 2026-10-07
+
+### Added
+
+- Gitignore patterns for `assets/meta/deployments/**/s3.json` and `**/showfully.json`.
+- Docs for web deploy via SFTP (atomic `cleanRemote`), AWS S3, and Showfully folder (credential shapes consumed by Wrapfully).
+
 ## 5.0.6 — 2026-10-07
 
 ### Changed

package/README.md

@@ -437,11 +437,17 @@ mygame/
             │   └── sftp.json
             ├── web-prod/
             │   └── sftp.json
+            ├── web-s3-prod/
+            │   ├── manifest.json   # { "type": "s3" }
+            │   └── s3.json
+            ├── web-showfully/
+            │   ├── manifest.json   # { "type": "showfully" }
+            │   └── showfully.json
             └── steam/           # default deployment for the `steam` platform
                 └── steam.json
 ```
 
-The selected deployment's folder is shipped as `meta/publish/` in the zip, so per-platform credential file names (`build.json`, `sftp.json`, `steam.json`, `apple.json`, `google.json`, `ms.json`, `android/`, `ms/`) live inside `assets/meta/deployments/<key>/`.
+The selected deployment's folder is shipped as `meta/publish/` in the zip, so per-platform credential file names (`build.json`, `sftp.json`, `s3.json`, `showfully.json`, `steam.json`, `apple.json`, `google.json`, `ms.json`, `android/`, `ms/`) live inside `assets/meta/deployments/<key>/`.
 
 Icons (`icon-foreground.png`, `icon-background.png`) are required for mobile, desktop, and Steam builds. If either file is missing from `assets/meta/`, Adaptfully **warns** and ships packaged placeholder icons for that build so Wrapfully can still run.
 
@@ -718,7 +724,9 @@ Release `win` builds can be signed with `assets/meta/deployments/<deployment>/ms
 
 #### Web (`web` / `webapp`)
 
-`adaptfully deploy web` prebuilds and POSTs to the Wrapfully **`webapp`** builder (same conduit as Steam). Put an `sftp.json` in each web deployment folder (e.g. `assets/meta/deployments/web-prod/sftp.json`); the selected deployment is zipped as `meta/publish/sftp.json` for Wrapfully to deploy via SFTP. The inner key stays the builder name (`webapp`).
+`adaptfully deploy web` prebuilds and POSTs to the Wrapfully **`webapp`** builder (same conduit as Steam). Each web deployment folder under `assets/meta/deployments/<key>/` is zipped as `meta/publish/` for Wrapfully. Set `manifest.json` `"type"` to `sftp`, `s3`, or `showfully` (or rely on the credential filename). The inner settings key stays the builder name (`webapp`).
+
+**SFTP** — `sftp.json`:
 
 ```json
 {
@@ -736,7 +744,42 @@ Release `win` builds can be signed with `assets/meta/deployments/<deployment>/ms
 }
 ```
 
-See [Wrapfully README](https://github.com/Makefully-Studios/wrapfully-client) for `uploadMode`, `serviceWorker`, `metaWeb`, and `cleanRemote`.
+`path` is the remote site root or a longer subfolder path. With `uploadMode: "direct"` and `cleanRemote: true`, Wrapfully uploads to `[path]-temp`, then deletes the live directory and renames temp → `path` (atomic replace). `cleanRemote` is ignored for `versioned` uploads.
+
+**AWS S3** — `s3.json` + `manifest.json` `{ "type": "s3" }`:
+
+```json
+{
+  "webapp": {
+    "region": "us-east-1",
+    "bucket": "my-games-cdn",
+    "prefix": "",
+    "uploadMode": "direct",
+    "cleanRemote": false,
+    "accessKeyId": "(iam access key)",
+    "secretAccessKey": "(iam secret)"
+  }
+}
+```
+
+`prefix: ""` deploys to the bucket root; `"games/mygame"` deploys under that key prefix. `cleanRemote: true` uses an atomic `prefix-temp` swap (refuses empty prefix unless `allowBucketRootWipe: true`).
+
+**Showfully folder** — `showfully.json` + `manifest.json` `{ "type": "showfully" }`:
+
+```json
+{
+  "webapp": {
+    "server": "https://make.makefullystudios.com/",
+    "folder": "MyGame",
+    "path": "",
+    "accessToken": "sfpat_…"
+  }
+}
+```
+
+`folder` is a top-level Showfully folder name. `path: ""` writes at that folder’s root; `"web"` (or nested) prefixes zip entries under a subfolder. `accessToken` is required (Wrapfully workers cannot reuse the Yap submit PAT).
+
+See [Wrapfully README](https://github.com/Makefully-Studios/wrapfully-client) for `uploadMode`, `serviceWorker`, `metaWeb`, and deployer details.
 
 #### Windows (`win`, `win-dev`, `uwp`)
 

package/lib/node/artifacts.js

@@ -1,5 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
+import {buildGameId, sanitizeFsSegment} from './fs-name.js';
 
 const
     MANIFEST_NAME = 'wrapfully-build.json',
@@ -28,7 +29,7 @@ export function buildOutputDir(pkg, outputRoot = 'output') {
 export function resolveExtractRoot(outputRoot, platformKey) {
     const root = path.resolve(outputRoot);
     if (platformKey) {
-        return path.join(root, platformKey);
+        return path.join(root, sanitizeFsSegment(platformKey));
     }
     return root;
 }
@@ -95,8 +96,8 @@ export function resolveBuildArtifactDir(pkg, options = {}) {
         throw new Error(`Unable to read ${manifestPath}`);
     }
 
-    const gameId = `${pkg.name}-${pkg.version}`;
-    if (manifest.gameId && manifest.gameId !== gameId) {
+    const gameId = buildGameId(pkg.name, pkg.version);
+    if (manifest.gameId && sanitizeFsSegment(manifest.gameId) !== gameId) {
         throw new Error(
             `Build artifact is for "${manifest.gameId}" but package.json is ${gameId}. `
             + 'Run a fresh build or pass --artifact <path>.',

package/lib/node/deploy.js

@@ -14,6 +14,7 @@ import {
     resolveEncryptPublicKey,
 } from './choreCrypto.js';
 import {extractZipFile, fileLooksLikeZip} from './unzip-file.js';
+import {buildGameId} from './fs-name.js';
 
 const POLL_MS = 5000;
 
@@ -382,7 +383,7 @@ export async function send (
         } else {
             const destZip = path.join(
                 extractRoot,
-                `${pkg.name}-${pkg.version}-${stage}-${family}.zip`,
+                `${buildGameId(pkg.name, pkg.version)}-${stage}-${family}.zip`,
             );
 
             await pipeline(

package/lib/node/fs-name.js

@@ -0,0 +1,29 @@
+/**
+ * Make a single filesystem / URL path segment safe.
+ * Strips `@`, turns `/` and `\` into `-`, and removes other Windows-illegal chars
+ * so scoped npm names like `@makefully/fancifully` stay flat.
+ *
+ * @param {unknown} value
+ * @param {string} [fallback='app']
+ * @returns {string}
+ */
+export function sanitizeFsSegment(value, fallback = 'app') {
+    const cleaned = String(value ?? '')
+        .replace(/@/g, '')
+        .replace(/[/\\]+/g, '-')
+        .replace(/[<>:"|?*\u0000-\u001f]/g, '-')
+        .replace(/-+/g, '-')
+        .replace(/^-+|-+$/g, '');
+
+    return cleaned || fallback;
+}
+
+/**
+ * Build the Adaptfully/Wrapfully gameId from package name + version.
+ * @param {string} name
+ * @param {string} version
+ * @returns {string}
+ */
+export function buildGameId(name, version) {
+    return sanitizeFsSegment(`${name}-${version}`, 'app');
+}

package/lib/node/index.js

@@ -1,4 +1,5 @@
 export { buildOutputDir, clearStaleBuildExtract, parsePlatformList, resolveBuildArtifactDir, resolveExtractRoot } from './artifacts.js';
+export { buildGameId, sanitizeFsSegment } from './fs-name.js';
 export { createArchive, createDeployArchive, createReleaseArchive, createSourceArchive } from './archive.js';
 export { loadProjectConfig, resolveServerUrl } from './config.js';
 export {

package/lib/node/pipeline.js

@@ -19,6 +19,7 @@ import { googlePublishFromCli } from './google-publish.js';
 import { applePublishFromCli } from './apple-publish.js';
 import { androidKeystoreFromCli } from './android-keystore.js';
 import { appleSigningFromCli } from './apple-signing.js';
+import { buildGameId } from './fs-name.js';
 
 /** @typedef {'prebuild' | 'build' | 'deploy' | 'release'} AdaptfullyStage */
 
@@ -99,7 +100,7 @@ export async function runAdaptfullyStage(stage, platformKey, options) {
         return { prebuiltDir, platformKey, buildSpec, extractRoot };
     }
 
-    const gameId = `${pkg.name}-${pkg.version}`;
+    const gameId = buildGameId(pkg.name, pkg.version);
     const contents = JSON.stringify(pkg);
     /** @type {{ deploymentKey: string, stage: string, family: string }[]} */
     const sent = [];

package/lib/node/prebuild.js

@@ -6,6 +6,7 @@ import {
 } from './registrations.js';
 import { createPackagerForPlatform } from './packagers.js';
 import { copyRecursiveSync, emptyDirSync } from './fs-utils.js';
+import { sanitizeFsSegment } from './fs-name.js';
 
 /** @typedef {'prebuild' | 'build' | 'deploy'} AdaptfullyStage */
 
@@ -38,7 +39,7 @@ export function resolveHtmlInjections(pkg) {
  */
 export function prebuildOutputDir(platformKey, pkg, outputRoot = 'output') {
     const outputFolder = pkg.config?.outputFolder || outputRoot;
-    return path.resolve(outputFolder, `${platformKey}-prebuild`);
+    return path.resolve(outputFolder, `${sanitizeFsSegment(platformKey)}-prebuild`);
 }
 
 /**

package/lib/node/publish-credentials.js

@@ -6,6 +6,8 @@ import { stdin as input, stdout as output } from 'node:process';
 /** Patterns that should never be committed from deployment credential folders. */
 export const PUBLISH_CREDENTIAL_GITIGNORE_PATTERNS = [
     'assets/meta/deployments/**/sftp.json',
+    'assets/meta/deployments/**/s3.json',
+    'assets/meta/deployments/**/showfully.json',
     'assets/meta/deployments/**/steam.json',
     'assets/meta/deployments/**/build.json',
     'assets/meta/deployments/**/google.json',

package/lib/node/report.js

@@ -1,5 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
+import {buildGameId} from './fs-name.js';
 
 /**
  * @param {string} builder
@@ -9,7 +10,7 @@ import path from 'node:path';
 export function printBuildReport(builder, pkg, options = {}) {
     const extractRoot = path.resolve(options.extractRoot || './output');
     const statusPath = path.join(extractRoot, 'wrapfully-status.json');
-    const legacyPath = path.join(extractRoot, `${pkg.name}-${pkg.version}-${builder}.txt`);
+    const legacyPath = path.join(extractRoot, `${buildGameId(pkg.name, pkg.version)}-${builder}.txt`);
 
     let status = null;
     if (fs.existsSync(statusPath)) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/adaptfully",
-    "version": "5.0.6",
+    "version": "5.0.8",
     "description": "Platform abstraction and Wrapfully deploy client for Makefully games",
     "type": "module",
     "main": "./lib/node/index.js",