@caperjs/core 0.7.3 → 0.7.4

package/src/utils/orientation.js

@@ -0,0 +1,37 @@
+/**
+ * The one normalizer for `caper.config.ts`'s `orientation`, shared by the
+ * runtime `orientation` plugin, the native CLI, `caper doctor` and the PWA
+ * default. Plain ESM with a hand-written `orientation.d.ts` beside it, so the
+ * Node CLI (`cli/`, `build/`) can import it without a TypeScript step. Keep it
+ * dependency-free and free of browser globals.
+ */
+
+const LOCKS = ['portrait', 'landscape'];
+
+/**
+ * `orientation` as `{ lock, overlay }`, or `null` when unset. The string form is
+ * shorthand for `{ lock }`; a missing `overlay` means the default overlay (`{}`).
+ * Throws on anything else.
+ *
+ * @param {unknown} orientation
+ */
+export function resolveOrientation(orientation) {
+  if (orientation === undefined || orientation === null) return null;
+  if (typeof orientation === 'string') {
+    if (!LOCKS.includes(orientation)) {
+      throw new TypeError(`orientation must be 'portrait' or 'landscape' (got ${JSON.stringify(orientation)})`);
+    }
+    return { lock: orientation, overlay: {} };
+  }
+  if (typeof orientation === 'object' && !Array.isArray(orientation)) {
+    const { lock, overlay } = orientation;
+    if (!LOCKS.includes(lock)) {
+      throw new TypeError(`orientation.lock must be 'portrait' or 'landscape' (got ${JSON.stringify(lock)})`);
+    }
+    if (overlay !== undefined && overlay !== false && (overlay === null || typeof overlay !== 'object')) {
+      throw new TypeError(`orientation.overlay must be false or an object (got ${JSON.stringify(overlay)})`);
+    }
+    return { lock, overlay: overlay ?? {} };
+  }
+  throw new TypeError(`orientation must be 'portrait', 'landscape', or { lock, overlay? } (got ${JSON.stringify(orientation)})`);
+}

package/src/utils/orientation.test.ts

@@ -0,0 +1,30 @@
+import { describe, expect, it } from 'vitest';
+import { resolveOrientation } from './orientation';
+
+describe('resolveOrientation', () => {
+  it('is null when unset', () => {
+    expect(resolveOrientation(undefined)).toBeNull();
+    expect(resolveOrientation(null)).toBeNull();
+  });
+
+  it.each(['portrait', 'landscape'] as const)('expands the %s shorthand with the default overlay', (lock) => {
+    expect(resolveOrientation(lock)).toEqual({ lock, overlay: {} });
+  });
+
+  it('keeps the object form, defaulting the overlay', () => {
+    expect(resolveOrientation({ lock: 'landscape' })).toEqual({ lock: 'landscape', overlay: {} });
+  });
+
+  it('passes overlay options and false through', () => {
+    const overlay = { text: 'Hold your phone upright to play' };
+    expect(resolveOrientation({ lock: 'portrait', overlay })).toEqual({ lock: 'portrait', overlay });
+    expect(resolveOrientation({ lock: 'portrait', overlay: false })).toEqual({ lock: 'portrait', overlay: false });
+  });
+
+  it.each(['any', 'Portrait', 1, true, {}, { lock: 'any' }, { overlay: false }, { lock: 'portrait', overlay: 'off' }])(
+    'throws on %o',
+    (value) => {
+      expect(() => resolveOrientation(value)).toThrow(/orientation/);
+    },
+  );
+});

package/src/version.ts

@@ -1,3 +1,3 @@
 // This file is auto-generated during the build process.
-export const version: string = '0.7.3';
+export const version: string = '0.7.4';
 export const pixiVersion: string = '8.22.0';