iphone-dimensions 1.0.0

package/dist/index.js

@@ -0,0 +1,62 @@
+// Generated by scripts/build.mjs. Do not edit.
+import dataset from './data.js';
+function stateRank(state) {
+  if (state === 'closed') {
+    return 0;
+  }
+  if (state === 'open') {
+    return 1;
+  }
+  return 2;
+}
+
+function freezePhone(phone) {
+  Object.freeze(phone.resolution_px);
+  Object.freeze(phone.also_known_as);
+  return Object.freeze(phone);
+}
+
+const { phones: phoneList, ...rest } = dataset;
+Object.freeze(rest.notes);
+Object.freeze(rest.units);
+const phones = Object.freeze(phoneList.map(freezePhone));
+const meta = Object.freeze(rest);
+
+function getPhone(id) {
+  for (const phone of phones) {
+    if (phone.id === id) {
+      return phone;
+    }
+  }
+  return undefined;
+}
+
+function findPhones(query) {
+  const needle = query.toLowerCase();
+  const matches = [];
+  for (const phone of phones) {
+    if (phone.name.toLowerCase().includes(needle) || phone.id.toLowerCase().includes(needle)) {
+      matches.push(phone);
+      continue;
+    }
+    for (const alias of phone.also_known_as) {
+      if (alias.toLowerCase().includes(needle)) {
+        matches.push(phone);
+        break;
+      }
+    }
+  }
+  return matches;
+}
+
+function getProduct(productId) {
+  const matches = [];
+  for (const phone of phones) {
+    if (phone.product_id === productId) {
+      matches.push(phone);
+    }
+  }
+  matches.sort((left, right) => stateRank(left.state) - stateRank(right.state));
+  return matches;
+}
+export { phones, meta, getPhone, findPhones, getProduct };

package/index.d.ts

@@ -0,0 +1,54 @@
+export interface ResolutionPx {
+  readonly width: number;
+  readonly height: number;
+}
+
+export interface IPhone {
+  id: string;
+  product_id: string;
+  state: 'closed' | 'open' | null;
+  name: string;
+  also_known_as: readonly string[];
+  family: string;
+  announced: string;
+  released: string;
+  height_mm: number;
+  width_mm: number;
+  depth_mm: number;
+  weight_g: number;
+  height_in: number;
+  width_in: number;
+  depth_in: number;
+  weight_oz: number;
+  display_in: number;
+  resolution_px: ResolutionPx;
+  ppi: number;
+  url: string;
+  source_url: string;
+  dates_source_url: string;
+}
+
+export interface Units {
+  readonly length: 'mm';
+  readonly mass: 'g';
+  readonly display: 'in';
+}
+
+export interface Meta {
+  schema_version: 1;
+  name: string;
+  description: string;
+  license: string;
+  homepage: string;
+  source: string;
+  units: Units;
+  verified: string;
+  notes: readonly string[];
+  count: number;
+}
+
+export const phones: readonly IPhone[];
+export const meta: Meta;
+export function getPhone(id: string): IPhone | undefined;
+export function findPhones(query: string): IPhone[];
+export function getProduct(productId: string): IPhone[];

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "iphone-dimensions",
+  "version": "1.0.0",
+  "description": "Apple's published dimensions for every iPhone since the iPhone 7: height, width, depth, weight, display and pixel density, in mm and inches, each row cited to Apple's tech specs.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "homepage": "https://iphonesize.com/data-sources",
+  "repository": "github:iphonesize/iphone-dimensions",
+  "bugs": {
+    "url": "https://github.com/iphonesize/iphone-dimensions/issues"
+  },
+  "keywords": [
+    "iphone",
+    "apple",
+    "dimensions",
+    "size",
+    "specs",
+    "dataset",
+    "device",
+    "screen"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./data/iphones.json": "./data/iphones.json",
+    "./data/iphones.csv": "./data/iphones.csv"
+  },
+  "files": [
+    "dist/",
+    "index.d.ts",
+    "data/",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "test": "node scripts/build.mjs && node --test --test-timeout=1000",
+    "sync": "node scripts/sync.mjs && node scripts/build.mjs",
+    "prepublishOnly": "npm test"
+  }
+}