@vxrn/utils 1.27.1 → 2.0.0-beta.100.1

package/src/nativeAppManifest.ts

@@ -0,0 +1,229 @@
+// typed native.app manifest inside the existing one vite options.
+// name is the native target and appregistry key. one canonical definition:
+// one/native re-exports it for apps and vxrn prebuild consumes it, so a new
+// field is added once, here.
+export interface NativeAppManifest {
+  name: string
+  displayName?: string
+  scheme?: string | string[]
+  version?: string
+  icon?: {
+    source: string
+    backgroundColor: string
+  }
+  splash?: {
+    source: string
+    backgroundColor: string
+    width?: number
+  }
+  imagePicker?: {
+    // ios camera usage description shown at the system prompt. setting it
+    // also declares the android camera permission; both are required for
+    // One.ImagePicker.launchCamera.
+    camera?: string
+  }
+  // present when the app uses local notifications. prebuild stamps the
+  // android notification permissions and receiver plus the ios delegate gate.
+  // push opts into remote push: the fcm source set and the aps-environment
+  // entitlement. without it firebase stays out of the app entirely.
+  notifications?: {
+    push?: boolean
+  }
+  // One.UI.PictureInPicture: stamps the ios audio background mode (pip opens
+  // only for a playback session) and android's supportsPictureInPicture.
+  pictureInPicture?: boolean
+  ios?: {
+    bundleId: string
+    buildNumber?: string
+    tablet?: boolean
+    deploymentTarget?: string
+    screensGamma?: boolean
+    useFrameworks?: 'static' | 'dynamic'
+    ccache?: boolean
+    usesNonExemptEncryption?: boolean
+    // exposes the app's Documents in the Files app and document pickers.
+    fileSharing?: boolean
+    widgets?: {
+      appGroup: string
+      kind: string
+      displayName: string
+      description: string
+      pushNotifications?: boolean
+    }
+  }
+  android?: {
+    applicationId: string
+    versionCode?: number
+    minSdk?: number
+    adaptiveIcon?: {
+      foreground?: string
+      background?: string
+    }
+    // google maps api key for One.UI.Map. setting it compiles the maps sdk
+    // into the app and stamps the key meta-data; without it the maps source
+    // set stays out and mounting One.UI.Map throws.
+    googleMapsApiKey?: string
+  }
+}
+
+const TARGET_NAME = /^[A-Za-z][A-Za-z0-9_]*$/
+const SCHEME = /^[a-z][a-z0-9+.-]*$/i
+const VERSION = /^\d+\.\d+\.\d+/
+const BUILD_NUMBER = /^[A-Za-z0-9.]+$/
+const REVERSE_DNS = /^[A-Za-z][A-Za-z0-9-]*(\.[A-Za-z][A-Za-z0-9-]*)+$/
+const DEPLOYMENT_TARGET = /^\d+\.\d+$/
+const HEX_COLOR = /^#[\da-f]{6}$/i
+
+function fail(message: string): never {
+  throw new Error(`[one] invalid native.app: ${message}`)
+}
+
+// platform scopes the platform-id requirement: an ios prebuild skips the
+// android requirement and vice versa. without it both are required, because
+// a manifest without platform ids prebuilds nothing.
+export function validateNativeApp(
+  manifest: NativeAppManifest,
+  platform?: 'ios' | 'android' | string
+): NativeAppManifest {
+  if (!manifest || typeof manifest !== 'object') fail('manifest must be an object')
+  if (!manifest.name || typeof manifest.name !== 'string') fail('name is required')
+  if (!TARGET_NAME.test(manifest.name)) {
+    fail(
+      `name "${manifest.name}" must start with a letter and contain only letters, digits, and underscore`
+    )
+  }
+  const schemes =
+    manifest.scheme === undefined
+      ? []
+      : Array.isArray(manifest.scheme)
+        ? manifest.scheme
+        : [manifest.scheme]
+  for (const scheme of schemes) {
+    if (typeof scheme !== 'string' || !SCHEME.test(scheme)) {
+      fail(`scheme "${scheme}" must be a valid uri scheme`)
+    }
+  }
+  if (manifest.version !== undefined && !VERSION.test(manifest.version)) {
+    fail(`version "${manifest.version}" must start with major.minor.patch`)
+  }
+  if (
+    manifest.icon !== undefined &&
+    (!manifest.icon.source || !HEX_COLOR.test(manifest.icon.backgroundColor))
+  ) {
+    fail('icon requires source and a six-digit hex backgroundColor')
+  }
+  if (
+    manifest.splash !== undefined &&
+    (!manifest.splash.source ||
+      !HEX_COLOR.test(manifest.splash.backgroundColor) ||
+      (manifest.splash.width !== undefined &&
+        (!Number.isFinite(manifest.splash.width) ||
+          manifest.splash.width < 1 ||
+          manifest.splash.width > 288)))
+  ) {
+    fail(
+      'splash requires source, a six-digit hex backgroundColor, and width from 1 to 288'
+    )
+  }
+  if (
+    manifest.imagePicker?.camera !== undefined &&
+    (typeof manifest.imagePicker.camera !== 'string' ||
+      manifest.imagePicker.camera.trim() === '')
+  ) {
+    fail('imagePicker.camera must be a non-empty string')
+  }
+  if (manifest.notifications !== undefined) {
+    if (
+      typeof manifest.notifications !== 'object' ||
+      (manifest.notifications.push !== undefined &&
+        typeof manifest.notifications.push !== 'boolean')
+    ) {
+      fail('notifications.push must be a boolean')
+    }
+  }
+  if (
+    manifest.pictureInPicture !== undefined &&
+    typeof manifest.pictureInPicture !== 'boolean'
+  ) {
+    fail('pictureInPicture must be a boolean')
+  }
+  if (!platform || platform === 'ios') {
+    if (!manifest.ios?.bundleId || !REVERSE_DNS.test(manifest.ios.bundleId)) {
+      fail(`ios.bundleId "${manifest.ios?.bundleId}" must be reverse-dns`)
+    }
+    if (
+      manifest.ios.deploymentTarget !== undefined &&
+      !DEPLOYMENT_TARGET.test(manifest.ios.deploymentTarget)
+    ) {
+      fail(
+        `ios.deploymentTarget "${manifest.ios.deploymentTarget}" must look like "17.0"`
+      )
+    }
+    if (
+      manifest.ios.buildNumber !== undefined &&
+      !BUILD_NUMBER.test(manifest.ios.buildNumber)
+    ) {
+      fail(
+        `ios.buildNumber "${manifest.ios.buildNumber}" must contain only letters, digits, and dots`
+      )
+    }
+    const widgets = manifest.ios.widgets
+    if (widgets) {
+      if (!manifest.ios.deploymentTarget || Number(manifest.ios.deploymentTarget) < 17) {
+        fail('ios.widgets requires ios.deploymentTarget of 17.0 or newer')
+      }
+      if (
+        !/^group\.[A-Za-z][A-Za-z0-9-]*(\.[A-Za-z][A-Za-z0-9-]*)+$/.test(widgets.appGroup)
+      ) {
+        fail('ios.widgets.appGroup must be a reverse-dns App Group beginning with group.')
+      }
+      if (!/^[A-Za-z][A-Za-z0-9._-]*$/.test(widgets.kind)) {
+        fail('ios.widgets.kind must be a non-empty WidgetKit kind')
+      }
+      if (!widgets.displayName?.trim() || !widgets.description?.trim()) {
+        fail('ios.widgets.displayName and description must be non-empty strings')
+      }
+      if (
+        widgets.pushNotifications !== undefined &&
+        typeof widgets.pushNotifications !== 'boolean'
+      ) {
+        fail('ios.widgets.pushNotifications must be a boolean')
+      }
+    }
+  }
+  if (!platform || platform === 'android') {
+    if (
+      !manifest.android?.applicationId ||
+      !REVERSE_DNS.test(manifest.android.applicationId)
+    ) {
+      fail(
+        `android.applicationId "${manifest.android?.applicationId}" must be reverse-dns`
+      )
+    }
+    if (
+      manifest.android.minSdk !== undefined &&
+      (!Number.isInteger(manifest.android.minSdk) ||
+        manifest.android.minSdk < 21 ||
+        manifest.android.minSdk > 36)
+    ) {
+      fail(`android.minSdk "${manifest.android.minSdk}" must be an integer from 21 to 36`)
+    }
+    if (
+      manifest.android.versionCode !== undefined &&
+      (!Number.isInteger(manifest.android.versionCode) ||
+        manifest.android.versionCode < 1)
+    ) {
+      fail(
+        `android.versionCode "${manifest.android.versionCode}" must be a positive integer`
+      )
+    }
+    if (
+      manifest.android.googleMapsApiKey !== undefined &&
+      (typeof manifest.android.googleMapsApiKey !== 'string' ||
+        manifest.android.googleMapsApiKey.trim() === '')
+    ) {
+      fail('android.googleMapsApiKey must be a non-empty string')
+    }
+  }
+  return manifest
+}

package/src/publicEnv.ts

@@ -0,0 +1,19 @@
+export const ONE_PUBLIC_PREFIX = 'ONE_PUBLIC_'
+export const EXPO_PUBLIC_PREFIX = 'EXPO_PUBLIC_'
+
+/**
+ * Expose One public values under Expo's established same-suffix names for
+ * package compatibility. Explicit Expo values win; Expo input never creates a
+ * One-owned name.
+ */
+export function withExpoPublicEnvAliases<T>(env: Record<string, T>): Record<string, T> {
+  const aliased = { ...env }
+
+  for (const [key, value] of Object.entries(env)) {
+    if (!key.startsWith(ONE_PUBLIC_PREFIX)) continue
+    const expoKey = `${EXPO_PUBLIC_PREFIX}${key.slice(ONE_PUBLIC_PREFIX.length)}`
+    if (!(expoKey in aliased)) aliased[expoKey] = value
+  }
+
+  return aliased
+}

package/types/createMessageSocket.d.ts

@@ -1,2 +1,2 @@
-export declare function createMessageSocket(): import("ws").Server<typeof import("ws").default, typeof import("http").IncomingMessage>;
+export declare function createMessageSocket(): import("ws").Server<typeof import("ws").WebSocket, typeof import("http").IncomingMessage>;
 //# sourceMappingURL=createMessageSocket.d.ts.map

package/types/createMessageSocket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createMessageSocket.d.ts","sourceRoot":"","sources":["../src/createMessageSocket.ts"],"names":[],"mappings":"AAQA,wBAAgB,mBAAmB,4FA6HlC"}
+{"version":3,"file":"createMessageSocket.d.ts","sourceRoot":"","sources":["../src/createMessageSocket.ts"],"names":[],"mappings":"AAQA,wBAAgB,mBAAmB,8FA6HlC"}

package/types/detectPackageManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"detectPackageManager.d.ts","sourceRoot":"","sources":["../src/detectPackageManager.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;AA+ChE,eAAO,MAAM,oBAAoB,GAAU,UAAS;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAO;;;;;EAwBxE,CAAA"}
+{"version":3,"file":"detectPackageManager.d.ts","sourceRoot":"","sources":["../src/detectPackageManager.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;AA+ChE,eAAO,MAAM,oBAAoB,aAAmB;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE;;;;;EAwBnE,CAAA"}

package/types/exec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exec.d.ts","sourceRoot":"","sources":["../src/exec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,YAAY,EAAS,MAAM,oBAAoB,CAAA;AAGvE,eAAO,MAAM,IAAI,GAAI,KAAK,MAAM,EAAE,UAAU,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,WAEzE,CAAA;AAED,eAAO,MAAM,WAAW,GACtB,KAAK,MAAM,EACX,UAAU,YAAY,GAAG;IACvB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,kBA4BF,CAAA;AAED,eAAO,MAAM,gBAAgB,GAC3B,KAAK,MAAM,EACX,UAAU,YAAY,GAAG;IACvB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,kBAMF,CAAA"}
+{"version":3,"file":"exec.d.ts","sourceRoot":"","sources":["../src/exec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,YAAY,EAAS,MAAM,oBAAoB,CAAA;AAGvE,eAAO,MAAM,IAAI,QAAS,MAAM,YAAY,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,WAEzE,CAAA;AAED,eAAO,MAAM,WAAW,QACjB,MAAM,YACD,YAAY,GAAG;IACvB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,kBA4BF,CAAA;AAED,eAAO,MAAM,gBAAgB,QACtB,MAAM,YACD,YAAY,GAAG;IACvB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,kBAMF,CAAA"}

package/types/index.d.ts

@@ -4,4 +4,5 @@ export * from './createMessageSocket';
 export * from './detectPackageManager';
 export * from './exec';
 export * from './mustReplace';
+export * from './publicEnv';
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,wBAAwB,CAAA;AACtC,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,wBAAwB,CAAA;AACtC,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA"}

package/types/nativeAppManifest.d.ts

@@ -0,0 +1,52 @@
+export interface NativeAppManifest {
+    name: string;
+    displayName?: string;
+    scheme?: string | string[];
+    version?: string;
+    icon?: {
+        source: string;
+        backgroundColor: string;
+    };
+    splash?: {
+        source: string;
+        backgroundColor: string;
+        width?: number;
+    };
+    imagePicker?: {
+        camera?: string;
+    };
+    notifications?: {
+        push?: boolean;
+    };
+    pictureInPicture?: boolean;
+    ios?: {
+        bundleId: string;
+        buildNumber?: string;
+        tablet?: boolean;
+        deploymentTarget?: string;
+        screensGamma?: boolean;
+        useFrameworks?: 'static' | 'dynamic';
+        ccache?: boolean;
+        usesNonExemptEncryption?: boolean;
+        fileSharing?: boolean;
+        widgets?: {
+            appGroup: string;
+            kind: string;
+            displayName: string;
+            description: string;
+            pushNotifications?: boolean;
+        };
+    };
+    android?: {
+        applicationId: string;
+        versionCode?: number;
+        minSdk?: number;
+        adaptiveIcon?: {
+            foreground?: string;
+            background?: string;
+        };
+        googleMapsApiKey?: string;
+    };
+}
+export declare function validateNativeApp(manifest: NativeAppManifest, platform?: 'ios' | 'android' | string): NativeAppManifest;
+//# sourceMappingURL=nativeAppManifest.d.ts.map

package/types/nativeAppManifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nativeAppManifest.d.ts","sourceRoot":"","sources":["../src/nativeAppManifest.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,MAAM,CAAA;QACd,eAAe,EAAE,MAAM,CAAA;KACxB,CAAA;IACD,MAAM,CAAC,EAAE;QACP,MAAM,EAAE,MAAM,CAAA;QACd,eAAe,EAAE,MAAM,CAAA;QACvB,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;IACD,WAAW,CAAC,EAAE;QAIZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IAKD,aAAa,CAAC,EAAE;QACd,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,CAAA;IAGD,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,GAAG,CAAC,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAA;QAChB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,aAAa,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;QACpC,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,uBAAuB,CAAC,EAAE,OAAO,CAAA;QAEjC,WAAW,CAAC,EAAE,OAAO,CAAA;QACrB,OAAO,CAAC,EAAE;YACR,QAAQ,EAAE,MAAM,CAAA;YAChB,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,EAAE,MAAM,CAAA;YACnB,WAAW,EAAE,MAAM,CAAA;YACnB,iBAAiB,CAAC,EAAE,OAAO,CAAA;SAC5B,CAAA;KACF,CAAA;IACD,OAAO,CAAC,EAAE;QACR,aAAa,EAAE,MAAM,CAAA;QACrB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE;YACb,UAAU,CAAC,EAAE,MAAM,CAAA;YACnB,UAAU,CAAC,EAAE,MAAM,CAAA;SACpB,CAAA;QAID,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAC1B,CAAA;CACF;AAiBD,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,iBAAiB,EAC3B,QAAQ,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,GACpC,iBAAiB,CA8InB"}

package/types/publicEnv.d.ts

@@ -0,0 +1,9 @@
+export declare const ONE_PUBLIC_PREFIX = "ONE_PUBLIC_";
+export declare const EXPO_PUBLIC_PREFIX = "EXPO_PUBLIC_";
+/**
+ * Expose One public values under Expo's established same-suffix names for
+ * package compatibility. Explicit Expo values win; Expo input never creates a
+ * One-owned name.
+ */
+export declare function withExpoPublicEnvAliases<T>(env: Record<string, T>): Record<string, T>;
+//# sourceMappingURL=publicEnv.d.ts.map

package/types/publicEnv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publicEnv.d.ts","sourceRoot":"","sources":["../src/publicEnv.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,gBAAgB,CAAA;AAC9C,eAAO,MAAM,kBAAkB,iBAAiB,CAAA;AAEhD;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAUrF"}

package/dist/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc","ignoreList":[]}

package/dist/esm/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc","ignoreList":[]}

package/dist/esm/index.native.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc","ignoreList":[]}