@webspatial/builder 0.1.18 → 0.1.20

package/README.md

@@ -15,6 +15,6 @@ For WebSpatial Builder:
 For WebSpatial:
 - [Table of Contents](../../docs/en/README.md)
 - [Introduction](../../docs/en/introduction/README.md)
-- [Quick Start](../../docs/en/quick-start/README.md)
+- [Quick Example](../../docs/en/quick-start/README.md)
 - [Core Concepts](../../docs/en/core-concepts/README.md)
 - [Development Guide](../../docs/en/development-guide/README.md)

package/dist/lib/pwa/validate.js

@@ -178,7 +178,15 @@ async function checkIcons(manifest, manifestUrl, isDev = false) {
     // Check if the image is completely opaque
     if (maxSizeImage && !imageHelper_1.ImageHelper.isFullyOpaque(maxSizeImage)) {
         if (isDev) {
+            manifest.icons = [
+                {
+                    src: (0, path_1.join)(__dirname, '../../assets/icon-default.png'),
+                    sizes: '1024x1024',
+                    purpose: 'maskable',
+                },
+            ];
             utils_2.CliLog.warn('In the Web Spatial App on VisionPro, the icon must be greater than or equal to 1024x1024, and the purpose parameter must include maskable');
+            utils_2.CliLog.warn('No matching icon found, use default icon');
             return;
         }
         throw new CustomError_1.CustomError({

package/dist/lib/resource/index.d.ts

@@ -8,6 +8,7 @@ export declare const WEB_PROJECT_DIRECTORY = "web-spatial/static-web";
 export declare const ASSET_DIRECTORY = "web-spatial/Assets.xcassets";
 export declare const BACK_APPICON_DIRECTORY: string;
 export declare const MIDDLE_APPICON_DIRECTORY: string;
+export declare const LOGO_DIRECTORY: string;
 export declare class ResourceManager {
     static moveProjectFrom(dir: string): Promise<void>;
     static generateIcon(info: ManifestInfo): Promise<Jimp>;

package/dist/lib/resource/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResourceManager = exports.MIDDLE_APPICON_DIRECTORY = exports.BACK_APPICON_DIRECTORY = exports.ASSET_DIRECTORY = exports.WEB_PROJECT_DIRECTORY = exports.PROJECT_TEST_DIRECTORY = exports.PROJECT_EXPORT_DIRECTORY = exports.PROJECT_BUILD_DIRECTORY = exports.PROJECT_DIRECTORY = void 0;
+exports.ResourceManager = exports.LOGO_DIRECTORY = exports.MIDDLE_APPICON_DIRECTORY = exports.BACK_APPICON_DIRECTORY = exports.ASSET_DIRECTORY = exports.WEB_PROJECT_DIRECTORY = exports.PROJECT_TEST_DIRECTORY = exports.PROJECT_EXPORT_DIRECTORY = exports.PROJECT_BUILD_DIRECTORY = exports.PROJECT_DIRECTORY = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 const file_1 = require("./file");
@@ -16,6 +16,7 @@ exports.BACK_APPICON_DIRECTORY = exports.ASSET_DIRECTORY +
     '/AppIcon.solidimagestack/Back.solidimagestacklayer/Content.imageset';
 exports.MIDDLE_APPICON_DIRECTORY = exports.ASSET_DIRECTORY +
     '/AppIcon.solidimagestack/Middle.solidimagestacklayer/Content.imageset';
+exports.LOGO_DIRECTORY = exports.ASSET_DIRECTORY + '/logo.imageset';
 const supportPlatform = ['visionos'];
 class ResourceManager {
     static async moveProjectFrom(dir) {
@@ -67,7 +68,7 @@ class ResourceManager {
         if (!hasModule) {
             (0, child_process_1.execSync)(`cd ${(0, path_1.join)(__dirname, '../../../')} && pnpm add @webspatial/platform-${usePlatform}`);
         }
-        let tempDir = (0, path_1.join)(__dirname, `../../temp`);
+        let tempDir = './node_modules/.webspatial-builder-temp';
         let tempPlatformDir = (0, path_1.join)(tempDir, `platform-${usePlatform}`);
         let tempProjectDir = (0, path_1.join)(tempPlatformDir, './project');
         let temBuildDir = (0, path_1.join)(tempPlatformDir, './build');

package/dist/lib/xcode/manifestSwiftTemplate.d.ts

@@ -1 +1 @@
-export declare const manifestSwiftTemplate = "\nimport Foundation\n\nvar pwaManager = PWAManager()\n\nstruct PWAManager: Codable {\n    var isLocal: Bool = false\n    var start_url: String = \"START_URL\"\n    var scope: String = \"SCOPE\"\n    var id: String = \"AppID\"\n\n    var name: String = \"AppName\"\n    var short_name: String = \"name\"\n    var description: String = \"Description\"\n\n    var display: PWADisplayMode = .minimal\n    var display_override: [PWADisplayMode] = []\n    var protocol_handlers: [PWAProtocol] = [PWAProtocol(protocolValue: \"\", url: \"\")]\n    var mainScene: WindowContainerOptions = .init(\n        defaultSize: .init(\n            width: SceneWidth,\n            height: SceneHeight\n        ),\n        resizability: SceneResizability\n    )\n    var useMainScene: Bool = USE_MAIN_SCENE\n\n    mutating func _init() {\n        let urlType = start_url.split(separator: \"://\").first\n        if !(urlType == \"http\" || urlType == \"https\") {\n            if scope == \"\" || scope == \"/\" {\n                scope = \"./\"\n            }\n            let startUrl = Bundle.main.url(forResource: start_url, withExtension: \"\", subdirectory: \"\")\n            start_url = startUrl!.absoluteString\n            scope = URL(string: (scope.starts(with: \"/\") ? \"..\" : \"../\") + scope, relativeTo: startUrl)!.absoluteString\n            isLocal = true\n        }\n\n        if display_override.count > 0 {\n            display = display_override[0]\n        }\n\n        for i in 0 ... protocol_handlers.count - 1 {\n            let item = protocol_handlers[i]\n            protocol_handlers[i].updateUrl(scope + item.url)\n        }\n    }\n\n    func checkInScope(url: String) -> Bool {\n        return url.starts(with: scope)\n    }\n\n    // web+spatial://test\n    func checkInDeeplink(url: String) -> String {\n        var linkUrl: String = url\n        for item in protocol_handlers {\n            if linkUrl.starts(with: item.protocolValue) {\n                let queryString: String = linkUrl.replacingOccurrences(of: item.protocolValue, with: \"\").addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)!\n                linkUrl = item.url.replacingOccurrences(of: \"%s\", with: item.protocolValue + queryString)\n            }\n        }\n        logger.debug(linkUrl)\n        return linkUrl\n    }\n\n    func getLocalResourceURL(url: String) -> String {\n        let path = String(url.split(separator: \"file://\").first!.split(separator: \"?\").first!)\n        let newUrl = URL(string: url)\n        let fileManager = FileManager.default\n        if fileManager.fileExists(atPath: newUrl!.path) {\n            return url\n        }\n        var resource: String = Bundle.main.url(forResource: newUrl?.path, withExtension: \"\", subdirectory: \"\")?.absoluteString ?? \"\"\n        if resource == \"\" {\n            resource = Bundle.main.url(forResource: \"static-web\" + path, withExtension: \"\", subdirectory: \"\")?.absoluteString ?? \"\"\n        }\n        if resource == \"\" {\n            return url\n        }\n        if newUrl?.query() != nil {\n            resource += \"?\" + (newUrl?.query())!\n        }\n        if newUrl?.fragment() != nil {\n            resource += \"#\" + (newUrl?.fragment())!\n        }\n        return resource\n    }\n}\n\nenum PWADisplayMode: Codable {\n    case minimal\n    case standalone\n    case fullscreen\n}\n\nstruct PWAProtocol: Codable {\n    var protocolValue: String = \"\"\n    var url: String = \"\"\n\n    mutating func updateUrl(_ str: String) {\n        url = str\n    }\n}\n\n";
+export declare const manifestSwiftTemplate = "\nimport Foundation\n\nvar pwaManager = PWAManager()\n\nstruct PWAManager: Codable {\n    var isLocal: Bool = false\n    var start_url: String = \"START_URL\"\n    var scope: String = \"SCOPE\"\n    var id: String = \"AppID\"\n\n    var name: String = \"AppName\"\n    var short_name: String = \"name\"\n    var description: String = \"Description\"\n\n    var display: PWADisplayMode = .minimal\n    var display_override: [PWADisplayMode] = []\n    var protocol_handlers: [PWAProtocol] = [PWAProtocol(protocolValue: \"\", url: \"\")]\n    var mainScene: WindowContainerOptions = .init(\n        defaultSize: .init(\n            width: SceneWidth,\n            height: SceneHeight\n        ),\n        resizability: SceneResizability\n    )\n    var useMainScene: Bool = USE_MAIN_SCENE\n    private var version: String = \"PACKAGE_VERSION\"\n\n    mutating func _init() {\n        let urlType = start_url.split(separator: \"://\").first\n        if !(urlType == \"http\" || urlType == \"https\") {\n            if scope == \"\" || scope == \"/\" {\n                scope = \"./\"\n            }\n            let startUrl = Bundle.main.url(forResource: start_url, withExtension: \"\", subdirectory: \"\")\n            start_url = startUrl!.absoluteString\n            scope = URL(string: (scope.starts(with: \"/\") ? \"..\" : \"../\") + scope, relativeTo: startUrl)!.absoluteString\n            isLocal = true\n        }\n\n        if display_override.count > 0 {\n            display = display_override[0]\n        }\n\n        for i in 0 ... protocol_handlers.count - 1 {\n            let item = protocol_handlers[i]\n            protocol_handlers[i].updateUrl(scope + item.url)\n        }\n    }\n\n    func checkInScope(url: String) -> Bool {\n        return url.starts(with: scope)\n    }\n\n    // web+spatial://test\n    func checkInDeeplink(url: String) -> String {\n        var linkUrl: String = url\n        for item in protocol_handlers {\n            if linkUrl.starts(with: item.protocolValue) {\n                let queryString: String = linkUrl.replacingOccurrences(of: item.protocolValue, with: \"\").addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)!\n                linkUrl = item.url.replacingOccurrences(of: \"%s\", with: item.protocolValue + queryString)\n            }\n        }\n        logger.debug(linkUrl)\n        return linkUrl\n    }\n\n    func getLocalResourceURL(url: String) -> String {\n        let path = String(url.split(separator: \"file://\").first!.split(separator: \"?\").first!)\n        let newUrl = URL(string: url)\n        let fileManager = FileManager.default\n        if fileManager.fileExists(atPath: newUrl!.path) {\n            return url\n        }\n        var resource: String = Bundle.main.url(forResource: newUrl?.path, withExtension: \"\", subdirectory: \"\")?.absoluteString ?? \"\"\n        if resource == \"\" {\n            resource = Bundle.main.url(forResource: \"static-web\" + path, withExtension: \"\", subdirectory: \"\")?.absoluteString ?? \"\"\n        }\n        if resource == \"\" {\n            return url\n        }\n        if newUrl?.query() != nil {\n            resource += \"?\" + (newUrl?.query())!\n        }\n        if newUrl?.fragment() != nil {\n            resource += \"#\" + (newUrl?.fragment())!\n        }\n        return resource\n    }\n    \n    func getVersion() -> String {\n        return version\n    }\n}\n\nenum PWADisplayMode: Codable {\n    case minimal\n    case standalone\n    case fullscreen\n}\n\nstruct PWAProtocol: Codable {\n    var protocolValue: String = \"\"\n    var url: String = \"\"\n\n    mutating func updateUrl(_ str: String) {\n        url = str\n    }\n}\n\n";

package/dist/lib/xcode/manifestSwiftTemplate.js

@@ -27,6 +27,7 @@ struct PWAManager: Codable {
         resizability: SceneResizability
     )
     var useMainScene: Bool = USE_MAIN_SCENE
+    private var version: String = "PACKAGE_VERSION"
 
     mutating func _init() {
         let urlType = start_url.split(separator: "://").first
@@ -89,6 +90,10 @@ struct PWAManager: Codable {
         }
         return resource
     }
+    
+    func getVersion() -> String {
+        return version
+    }
 }
 
 enum PWADisplayMode: Codable {

package/dist/lib/xcode/xcodeproject.js

@@ -79,7 +79,7 @@ class XcodeProject {
         this.updateExportOptions();
         if (option.icon)
             await this.bindIcon(option.icon);
-        this.bindManifestInfo(project, option.manifestInfo.json, isDev);
+        await this.bindManifestInfo(project, option.manifestInfo.json, isDev);
         if (option['version']) {
             this.updateVersion(project, option['version']);
         }
@@ -169,6 +169,14 @@ class XcodeProject {
             middleConfig.images[0]['filename'] = middleIconFileName;
             await middleIcon.writeAsync(middleIconFullPath);
             await fs.writeFileSync(middleIconConfigPath, JSON.stringify(middleConfig));
+            const logoConfigDirectory = (0, path_1.join)(resource_1.PROJECT_DIRECTORY, resource_1.LOGO_DIRECTORY);
+            const logoConfigPath = (0, path_1.join)(logoConfigDirectory, 'Contents.json');
+            let logoConfig = await (0, load_1.loadJsonFromDisk)(logoConfigPath);
+            const logoFileName = 'logo.' + icon.getMIME().replace('image/', '');
+            const logoFullPath = (0, path_1.join)(logoConfigDirectory, logoFileName);
+            logoConfig.images[0]['filename'] = logoFileName;
+            await icon.writeAsync(logoFullPath);
+            await fs.writeFileSync(logoConfigPath, JSON.stringify(logoConfig));
         }
     }
     static updateTeamId(xcodeProject, teamId) {
@@ -181,7 +189,7 @@ class XcodeProject {
         }
         fs.writeFileSync((0, path_1.join)(resource_1.PROJECT_BUILD_DIRECTORY, 'ExportOptions.plist'), useExportOptionsXML);
     }
-    static bindManifestInfo(xcodeProject, manifest, isDev = false) {
+    static async bindManifestInfo(xcodeProject, manifest, isDev = false) {
         var _a;
         xcodeProject.updateProductName(manifest.name);
         // set PRODUCT_BUNDLE_IDENTIFIER need ""
@@ -189,7 +197,7 @@ class XcodeProject {
             xcodeProject.updateBuildProperty('PRODUCT_BUNDLE_IDENTIFIER', `"${manifest.id}"`);
         }
         this.updateDeeplink((_a = manifest.protocol_handlers) !== null && _a !== void 0 ? _a : []);
-        this.modifySwift(manifest);
+        await this.modifySwift(manifest);
     }
     static updateVersion(xcodeProject, version) {
         xcodeProject.updateBuildProperty('CURRENT_PROJECT_VERSION', version);
@@ -203,9 +211,13 @@ class XcodeProject {
         const newInfoPlist = infoPlistXML.replace('DEEPLINK', deeplinkString);
         fs.writeFileSync(infoPlistPath, newInfoPlist);
     }
-    static modifySwift(manifest) {
+    static async modifySwift(manifest) {
+        var _a;
         const manifestSwiftPath = (0, path_1.join)(resource_1.PROJECT_DIRECTORY, './web-spatial/libs/webView/manifest.swift');
+        const xcodePackageJsonPath = (0, path_1.join)(resource_1.PROJECT_DIRECTORY, 'package.json');
+        const packageJson = await (0, load_1.loadJsonFromDisk)(xcodePackageJsonPath);
         let manifestSwift = manifestSwiftTemplate_1.manifestSwiftTemplate;
+        manifestSwift = manifestSwift.replace('PACKAGE_VERSION', (_a = packageJson.version) !== null && _a !== void 0 ? _a : '0.0.0');
         manifestSwift = manifestSwift.replace('START_URL', manifest.start_url);
         manifestSwift = manifestSwift.replace('SCOPE', manifest.scope);
         manifestSwift = manifestSwift.replace('AppName', manifest.name);

package/dist/lib/xcode/xcrun.js

@@ -158,10 +158,14 @@ class Xcrun {
         try {
             const res = (0, child_process_1.execSync)(buildCMD);
             if (res.toString().includes('** BUILD FAILED **')) {
+                console.log(res.toString());
                 return false;
             }
         }
-        catch (e) { }
+        catch (e) {
+            console.log(e);
+            return false;
+        }
         console.log('------------------- build end -------------------');
         return true;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webspatial/builder",
-  "version": "0.1.18",
+  "version": "0.1.20",
   "description": "Client CLI tool to Generate XRApp project for Apple Vision Pro",
   "type": "commonjs",
   "engines": {
@@ -40,7 +40,7 @@
     "sharp": "^0.33.5",
     "valid-url": "^1.0.9",
     "xcode": "^3.0.1",
-    "@webspatial/platform-visionos": "^0.1.18"
+    "@webspatial/platform-visionos": "^0.1.20"
   },
   "devDependencies": {
     "@rollup/plugin-terser": "^0.4.3",