create-octane-xplat 0.1.0 → 0.4.0

package/README.md

@@ -0,0 +1,25 @@
+# create-octane-xplat
+
+> Scaffolds an Octane xplat app — one codebase targeting web, iOS, and
+> Android via NativeScript.
+>
+> Status: `0.x` — the API surface is still moving. iOS/Android targets need
+> the NativeScript toolchain (Xcode/JDK + `ns`).
+
+```sh
+pnpm create octane-xplat my-app
+# or: npm create octane-xplat my-app
+```
+
+Copies the starter template (vite + nativescript configs, shared `src/`,
+`App_Resources`, pinned workspace deps), installs dependencies with pnpm,
+and starts the web dev server. From there:
+
+```sh
+pnpm dev            # web
+pnpm dev:ios        # iOS simulator — needs the NativeScript toolchain
+pnpm dev:android    # Android — needs the NativeScript toolchain
+pnpm typecheck      # web + native tsconfigs
+```
+
+Docs: [Running and checking an app](https://octane-xplat.goddardai.org/toolchain)

package/index.mjs

@@ -1,28 +1,31 @@
 #!/usr/bin/env node
-import { existsSync, readdirSync, cpSync, renameSync } from 'node:fs';
-import { dirname, join, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { spawnSync } from 'node:child_process';
+import { existsSync, readdirSync, cpSync, renameSync } from 'node:fs'
+import { dirname, join, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { spawnSync } from 'node:child_process'
 
-const dir = resolve(process.argv[2] ?? 'octane-xplat-app');
+const dir = resolve(process.argv[2] ?? 'octane-xplat-app')
 
 if (existsSync(dir) && readdirSync(dir).length > 0) {
-	console.error(`✗ ${dir} exists and is not empty`);
-	process.exit(1);
+	console.error(`✗ ${dir} exists and is not empty`)
+	process.exit(1)
 }
 
-const template = join(dirname(fileURLToPath(import.meta.url)), 'template');
-cpSync(template, dir, { recursive: true });
+const template = join(dirname(fileURLToPath(import.meta.url)), 'template')
+cpSync(template, dir, { recursive: true })
 // npm packs .gitignore as a renamed file or drops it — ship it undotted.
-try { renameSync(join(dir, 'gitignore'), join(dir, '.gitignore')); } catch {}
-console.log(`\n✓ scaffolded ${dir}`);
+try {
+	renameSync(join(dir, 'gitignore'), join(dir, '.gitignore'))
+} catch {}
 
-const install = spawnSync('pnpm', ['install'], { cwd: dir, stdio: 'inherit' });
+console.log(`\n✓ scaffolded ${dir}`)
+
+const install = spawnSync('pnpm', ['install'], { cwd: dir, stdio: 'inherit' })
 if (install.status !== 0) {
-	console.log(`\nInstall didn't finish (pnpm missing?). To run manually:`);
-	console.log(`  cd ${dir}\n  pnpm install\n  pnpm dev`);
-	process.exit(install.status ?? 1);
+	console.log(`\nInstall didn't finish (pnpm missing?). To run manually:`)
+	console.log(`  cd ${dir}\n  pnpm install\n  pnpm dev`)
+	process.exit(install.status ?? 1)
 }
 
-console.log('\n✓ installed — starting dev server (Ctrl+C to stop)\n');
-spawnSync('pnpm', ['dev'], { cwd: dir, stdio: 'inherit' });
+console.log('\n✓ installed — starting dev server (Ctrl+C to stop)\n')
+spawnSync('pnpm', ['dev'], { cwd: dir, stdio: 'inherit' })

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "create-octane-xplat",
-  "version": "0.1.0",
-  "type": "module",
+  "version": "0.4.0",
   "description": "Scaffold a minimal @octane-xplat/ui app — one Octane codebase for web + iOS + Android",
   "bin": {
     "create-octane-xplat": "./index.mjs"
@@ -10,6 +9,7 @@
     "index.mjs",
     "template"
   ],
+  "type": "module",
   "publishConfig": {
     "access": "public"
   }

package/template/.gitattributes

@@ -0,0 +1 @@
+*.tsrx linguist-language=TypeScript

package/template/.oxlintrc.json

@@ -0,0 +1,25 @@
+{
+	"jsPlugins": ["@octane-xplat/lint/oxlint-plugin"],
+	"rules": {
+		"curly": "error",
+		"xplat/spacing": "error",
+		"xplat/no-dom-globals": "error",
+		"xplat/no-web-only-api": "error",
+		"xplat/element-vocabulary": "error",
+		"xplat/no-nativescript-import": "error",
+		"xplat/no-ns-deep-import": "error",
+		"xplat/no-native-dead-style": "error",
+		"xplat/no-line-height-unitless": "error",
+		"xplat/no-style-string": "error",
+		"xplat/no-unknown-class": "warn",
+		"xplat/no-ts-imports-tsrx": "error",
+		"xplat/signal-dollar-suffix": "error",
+		"xplat/require-signals-runtime": "warn",
+		"xplat/no-view-onpress": "error",
+		"xplat/no-console-debug": "error",
+		"xplat/hooks-in-plain-ts": "warn",
+		"xplat/native-pragma-first-line": "error",
+		"xplat/no-jsx-text-breakers": "error",
+		"xplat/no-root-logical-render": "error"
+	}
+}

package/template/App_Resources/Android/app.gradle

@@ -0,0 +1,25 @@
+// You can add your native dependencies here
+dependencies {
+//  implementation 'androidx.multidex:multidex:2.0.1'
+}
+
+android {
+  compileSdkVersion 35
+  buildToolsVersion "35"
+  // ndkVersion ""
+
+  defaultConfig {
+    minSdkVersion 24
+    targetSdkVersion 35
+
+    // Version Information
+    versionCode 1
+    versionName "1.0.0"
+    
+    generatedDensities = []
+  }
+
+  aaptOptions {
+    additionalParameters "--no-version-vectors"
+  }
+}

package/template/App_Resources/Android/before-plugins.gradle

@@ -0,0 +1,15 @@
+// this configurations is loaded before building plugins, as well as before building
+// the app - this is where you can apply global settings and overrides
+
+project.ext {
+  // androidXAppCompat = "1.4.1"
+  // androidXExifInterface = "1.3.3"
+  // androidXFragment = "1.4.1"
+  // androidXMaterial = "1.5.0"
+  // androidXMultidex = "2.0.1"
+  // androidXTransition = "1.4.1"
+  // androidXViewPager = "1.0.0"
+
+  // useKotlin = true
+  // kotlinVersion = "1.6.0"
+}

package/template/App_Resources/Android/src/main/AndroidManifest.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+	package="__PACKAGE__">
+
+	<supports-screens
+		android:smallScreens="true"
+		android:normalScreens="true"
+		android:largeScreens="true"
+		android:xlargeScreens="true"/>
+
+	<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
+	<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+	<uses-permission android:name="android.permission.INTERNET"/>
+	<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+
+	<application
+		android:networkSecurityConfig="@xml/network_security_config"
+		android:name="com.tns.NativeScriptApplication"
+		android:allowBackup="true"
+		android:icon="@mipmap/ic_launcher"
+		android:label="@string/app_name"
+		android:theme="@style/AppTheme"
+		android:hardwareAccelerated="true">
+
+		<activity
+			android:name="com.tns.NativeScriptActivity"
+			android:label="@string/title_activity_kimera"
+			android:configChanges="keyboard|keyboardHidden|orientation|screenSize|smallestScreenSize|screenLayout|locale|uiMode"
+			android:theme="@style/LaunchScreenTheme"
+			android:hardwareAccelerated="true"
+      		android:launchMode="singleTask"
+			android:exported="true">
+
+			<meta-data android:name="SET_THEME_ON_LAUNCH" android:resource="@style/AppTheme" />
+
+			<intent-filter>
+				<action android:name="android.intent.action.MAIN" />
+				<category android:name="android.intent.category.LAUNCHER" />
+			</intent-filter>
+		</activity>
+		<activity android:name="com.tns.ErrorReportActivity"/>
+	</application>
+</manifest>

package/template/App_Resources/Android/src/main/res/drawable/ic_launcher_foreground.xml

@@ -0,0 +1,15 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="108dp"
+    android:height="108dp"
+    android:viewportWidth="108"
+    android:viewportHeight="108">
+  <group android:scaleX="0.07382812"
+      android:scaleY="0.07382812"
+      android:translateX="16.2"
+      android:translateY="16.2">
+    <path
+        android:pathData="M843,511.86L843,512.96C843,513.22 842.8,513.43 842.55,513.46C809.18,516.58 783.07,543.69 783.07,577.86L783.07,714.8C783.07,724.37 781.06,733.6 777.43,742.03C767.08,766.1 743.59,783.6 716.27,783.6L647.07,783.6L646.59,783L377.41,445.68L377.41,783.6L307.73,783.6C270.84,783.6 240.93,753.7 240.93,716.8L240.93,577.86C240.93,543.69 214.82,516.58 181.45,513.46C181.2,513.43 181,513.22 181,512.96L181,511.86C181,511.61 181.19,511.4 181.45,511.37C214.69,508.14 240.67,480.35 240.67,446.26L240.67,307.2C240.67,297.91 242.57,289.05 246,281.01C256.18,257.14 279.87,240.39 307.47,240.39L377.13,240.39L377.41,240.74L646.59,578.07L646.59,240.39L716.53,240.39C753.42,240.39 783.33,270.3 783.33,307.2L783.33,446.26C783.33,480.35 809.31,508.14 842.55,511.37C842.81,511.4 843,511.61 843,511.86"
+        android:fillColor="#65ADF1"
+        android:fillType="nonZero"/>
+  </group>
+</vector>

package/template/App_Resources/Android/src/main/res/drawable-nodpi/splash_screen.xml

@@ -0,0 +1,8 @@
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android" android:gravity="fill">
+    <item>
+        <bitmap android:gravity="fill" android:src="@drawable/background" />
+    </item>
+    <item>
+        <bitmap android:gravity="center" android:src="@drawable/logo" />
+    </item>
+</layer-list>

package/template/App_Resources/Android/src/main/res/mipmap-anydpi-v26/ic_launcher.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
+    <background android:drawable="@color/ic_launcher_background"/>
+    <foreground android:drawable="@drawable/ic_launcher_foreground"/>
+</adaptive-icon>

package/template/App_Resources/Android/src/main/res/values/colors.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<resources>
+    <!-- The default color of the ActionBar -->
+    <color name="ns_primary">#F5F5F5</color>
+	
+    <!-- (API21+) The color of the status bar and contextual app bars; this is normally a dark version of colorPrimary. -->
+    <color name="ns_primaryDark">#757575</color>
+
+    <!-- The color of UI controls such as check boxes, radio buttons, and edit text boxes. -->
+	<color name="ns_accent">#65ADF1</color>
+
+    <!-- this is unused in the default themes, so we might want to remove it? -->
+    <!-- <color name="ns_blue">#272734</color> -->
+</resources>

package/template/App_Resources/Android/src/main/res/values/ic_launcher_background.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <color name="ic_launcher_background">#FFFFFF</color>
+</resources>

package/template/App_Resources/Android/src/main/res/values/styles.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <!-- theme to use FOR launch screen-->
+    <style name="LaunchScreenThemeBase" parent="Theme.AppCompat.Light.NoActionBar">
+        <item name="toolbarStyle">@style/NativeScriptToolbarStyle</item>
+
+        <item name="colorPrimary">@color/ns_primary</item>
+        <item name="colorPrimaryDark">@color/ns_primaryDark</item>
+        <item name="colorAccent">@color/ns_accent</item>
+
+        <item name="android:windowBackground">@drawable/splash_screen</item>
+
+        <item name="android:windowActionBarOverlay">true</item>
+        <item name="android:windowTranslucentStatus">true</item>
+    </style>
+
+    <style name="LaunchScreenTheme" parent="LaunchScreenThemeBase">
+    </style>
+
+    <!-- theme to use AFTER launch screen is loaded-->
+    <style name="AppThemeBase" parent="Theme.AppCompat.Light.NoActionBar">
+        <item name="toolbarStyle">@style/NativeScriptToolbarStyle</item>
+
+        <item name="colorPrimary">@color/ns_primary</item>
+        <item name="colorPrimaryDark">@color/ns_primaryDark</item>
+        <item name="colorAccent">@color/ns_accent</item>
+    </style>
+
+    <style name="AppTheme" parent="AppThemeBase">
+    </style>
+
+    <!-- theme for action-bar -->
+    <style name="NativeScriptToolbarStyleBase" parent="Widget.AppCompat.Toolbar">
+        <item name="android:background">@color/ns_primary</item>
+        <item name="theme">@style/ThemeOverlay.AppCompat.ActionBar</item>
+        <item name="popupTheme">@style/ThemeOverlay.AppCompat</item>
+    </style>
+
+    <style name="NativeScriptToolbarStyle" parent="NativeScriptToolbarStyleBase">
+    </style>
+</resources>

package/template/App_Resources/Android/src/main/res/values-v21/colors.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<resources>
+	<!-- You can override base colors from values/colors.xml here, for example: -->
+	<!-- <color name="ns_accent">#65ADF1</color> -->
+</resources>

package/template/App_Resources/Android/src/main/res/values-v21/styles.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<resources xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <!-- Application theme -->
+    <style name="AppThemeBase21" parent="AppThemeBase">
+        <!-- Uncomment this to make the app show underneat the status bar -->
+        <!-- <item name="android:windowTranslucentStatus">true</item> -->
+
+        <item name="android:datePickerStyle">@style/SpinnerDatePicker</item>
+        <item name="android:timePickerStyle">@style/SpinnerTimePicker</item>
+    </style>
+
+    <style name="AppTheme" parent="AppThemeBase21">
+    </style>
+
+    <!-- Default style for DatePicker - in spinner mode -->
+    <style name="SpinnerDatePicker" parent="android:Widget.Material.Light.DatePicker">
+        <!-- set the default mode for the date picker (supported values: spinner, calendar)  -->
+        <item name="android:datePickerMode">spinner</item>
+    </style>
+
+    <!-- Default style for TimePicker - in spinner mode -->
+    <style name="SpinnerTimePicker" parent="android:Widget.Material.Light.TimePicker">
+        <!-- set the default mode for the time picker (supported values: spinner, clock)  -->
+        <item name="android:timePickerMode">spinner</item>
+    </style>
+
+    <style name="NativeScriptToolbarStyle" parent="NativeScriptToolbarStyleBase">
+        <item name="android:elevation">4dp</item>
+
+        <!-- Add padding to the ActionBar - useful when android:windowTranslucentStatus is set to true -->
+        <!-- <item name="android:paddingTop">24dp</item> -->
+    </style>
+</resources>

package/template/App_Resources/Android/src/main/res/values-v29/styles.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <!-- Application theme -->
+    <style name="AppThemeBase29" parent="AppThemeBase21">
+
+        <!-- 
+            Disable forced dark mode on newer devices. 
+            Enabling this will make your app appear in dark-mode, 
+            but the way the app is converted may lead to visual issues 
+        -->
+        <item name="android:forceDarkAllowed">false</item>
+    </style>
+
+    <style name="AppTheme" parent="AppThemeBase29">
+    </style>
+
+</resources>

package/template/App_Resources/Android/src/main/res/xml/network_security_config.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Dev only: the Vite HMR dev server is reached over cleartext HTTP on the
+  loopback host (127.0.0.1 via `adb reverse`) or the emulator NAT alias
+  (10.0.2.2). Android blocks cleartext by default on targetSdk >= 28, which
+  fails the module graph fetch at boot; permit it for those hosts only.
+-->
+<network-security-config>
+    <domain-config cleartextTrafficPermitted="true">
+        <domain includeSubdomains="false">127.0.0.1</domain>
+        <domain includeSubdomains="false">10.0.2.2</domain>
+        <domain includeSubdomains="false">localhost</domain>
+    </domain-config>
+</network-security-config>

package/template/App_Resources/iOS/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,122 @@
+{
+	"images": [
+		{
+			"size": "20x20",
+			"idiom": "iphone",
+			"filename": "icon-20@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "20x20",
+			"idiom": "iphone",
+			"filename": "icon-20@3x.png",
+			"scale": "3x"
+		},
+		{
+			"size": "29x29",
+			"idiom": "iphone",
+			"filename": "icon-29.png",
+			"scale": "1x"
+		},
+		{
+			"size": "29x29",
+			"idiom": "iphone",
+			"filename": "icon-29@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "29x29",
+			"idiom": "iphone",
+			"filename": "icon-29@3x.png",
+			"scale": "3x"
+		},
+		{
+			"size": "40x40",
+			"idiom": "iphone",
+			"filename": "icon-40@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "40x40",
+			"idiom": "iphone",
+			"filename": "icon-40@3x.png",
+			"scale": "3x"
+		},
+		{
+			"size": "60x60",
+			"idiom": "iphone",
+			"filename": "icon-60@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "60x60",
+			"idiom": "iphone",
+			"filename": "icon-60@3x.png",
+			"scale": "3x"
+		},
+		{
+			"size": "20x20",
+			"idiom": "ipad",
+			"filename": "icon-20.png",
+			"scale": "1x"
+		},
+		{
+			"size": "20x20",
+			"idiom": "ipad",
+			"filename": "icon-20@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "29x29",
+			"idiom": "ipad",
+			"filename": "icon-29.png",
+			"scale": "1x"
+		},
+		{
+			"size": "29x29",
+			"idiom": "ipad",
+			"filename": "icon-29@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "40x40",
+			"idiom": "ipad",
+			"filename": "icon-40.png",
+			"scale": "1x"
+		},
+		{
+			"size": "40x40",
+			"idiom": "ipad",
+			"filename": "icon-40@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "76x76",
+			"idiom": "ipad",
+			"filename": "icon-76.png",
+			"scale": "1x"
+		},
+		{
+			"size": "76x76",
+			"idiom": "ipad",
+			"filename": "icon-76@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "83.5x83.5",
+			"idiom": "ipad",
+			"filename": "icon-83.5@2x.png",
+			"scale": "2x"
+		},
+		{
+			"size": "1024x1024",
+			"idiom": "ios-marketing",
+			"filename": "icon-1024.png",
+			"scale": "1x"
+		}
+	],
+	"info": {
+		"version": 1,
+		"author": "xcode"
+	}
+}

package/template/App_Resources/iOS/Assets.xcassets/Contents.json

@@ -0,0 +1,6 @@
+{
+	"info": {
+		"version": 1,
+		"author": "xcode"
+	}
+}

package/template/App_Resources/iOS/Assets.xcassets/LaunchScreen.AspectFill.imageset/Contents.json

@@ -0,0 +1,23 @@
+{
+	"images": [
+		{
+			"idiom": "universal",
+			"filename": "LaunchScreen-AspectFill.png",
+			"scale": "1x"
+		},
+		{
+			"idiom": "universal",
+			"filename": "LaunchScreen-AspectFill@2x.png",
+			"scale": "2x"
+		},
+		{
+			"idiom": "universal",
+			"filename": "LaunchScreen-AspectFill@3x.png",
+			"scale": "3x"
+		}
+	],
+	"info": {
+		"version": 1,
+		"author": "xcode"
+	}
+}