soaring-symbols 0.2.1 → 0.2.3

package/API.md

@@ -118,25 +118,26 @@ The object returned by `getAirline()` and found in the array from `listAirlines(
 }
 ```
 
-| Field          | Type            | Description                                                                                                                         |
-| :------------- | :-------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
-| `name`         | `string`        | Full airline name.                                                                                                                  |
-| `iata`         | `string`        | 2-character IATA code.                                                                                                              |
-| `icao`         | `string`        | 3-letter ICAO code.                                                                                                                 |
-| `callsign`     | `string?`       | ICAO radiotelephony callsign, uppercase, e.g. `"VIET NAM AIRLINES"`.                                                                |
-| `country`      | `string`        | ISO 3166-1 alpha-2 code; comma-separated when the airline belongs to several.                                                       |
-| `slug`         | `string`        | URL-friendly name, also the asset folder name.                                                                                      |
-| `website`      | `string?`       | Official website.                                                                                                                   |
-| `flag_carrier` | `boolean?`      | `true` for a national flag carrier.                                                                                                 |
-| `alliance`     | `string?`       | `"oneworld"`, `"SkyTeam"` or `"Star Alliance"`.                                                                                     |
-| `hubs`         | `string[]?`     | IATA codes of its hub airports, e.g. `["HAN", "SGN"]`. Low-cost carriers often have bases rather than hubs, and none listed.        |
-| `founded`      | `number?`       | Year founded, counting from the predecessor its history starts with (e.g. 1956 for Vietnam Airlines).                               |
-| `defunct`      | `boolean?`      | `true` if the airline has ceased operations.                                                                                        |
-| `ceased`       | `number?`       | Year a defunct airline ceased operations.                                                                                           |
-| `vectorized`   | `boolean?`      | `true` if the SVG was vectorized by hand.                                                                                           |
-| `branding`     | `object?`       | `primary_color`, `tagline` and `guidelines` (link to the brand guidelines), each optional.                                          |
-| `assets`       | `object`        | One [`AssetInfo`](#assetinfo) per available type (`icon`, `logo`, `tail`). Missing types have no key.                               |
-| `subsidiaries` | `Subsidiary[]?` | Airlines sharing this airline's marks: `name`, `iata`, `icao`, `country`, `flag_carrier?`. They are not returned by `getAirline()`. |
+| Field          | Type        | Description                                                                                                                          |
+| :------------- | :---------- | :----------------------------------------------------------------------------------------------------------------------------------- |
+| `name`         | `string`    | Full airline name.                                                                                                                   |
+| `iata`         | `string`    | 2-character IATA code.                                                                                                               |
+| `icao`         | `string`    | 3-letter ICAO code.                                                                                                                  |
+| `callsign`     | `string?`   | ICAO radiotelephony callsign, uppercase, e.g. `"VIET NAM AIRLINES"`.                                                                 |
+| `country`      | `string`    | ISO 3166-1 alpha-2 code; comma-separated when the airline belongs to several.                                                        |
+| `slug`         | `string`    | URL-friendly name, also the asset folder name.                                                                                       |
+| `website`      | `string?`   | Official website.                                                                                                                    |
+| `flag_carrier` | `boolean?`  | `true` for a national flag carrier.                                                                                                  |
+| `alliance`     | `string?`   | `"oneworld"`, `"SkyTeam"` or `"Star Alliance"`.                                                                                      |
+| `parent`       | `string?`   | Slug of the airline that owns this one, e.g. `"airasia"` for Thai AirAsia.                                                           |
+| `marks`        | `string?`   | Slug of the airline whose logos this one uses. The files are still published under this airline's own slug, so nothing else changes. |
+| `hubs`         | `string[]?` | IATA codes of its hub airports, e.g. `["HAN", "SGN"]`. Low-cost carriers often have bases rather than hubs, and none listed.         |
+| `founded`      | `number?`   | Year founded, counting from the predecessor its history starts with (e.g. 1956 for Vietnam Airlines).                                |
+| `defunct`      | `boolean?`  | `true` if the airline has ceased operations.                                                                                         |
+| `ceased`       | `number?`   | Year a defunct airline ceased operations.                                                                                            |
+| `vectorized`   | `boolean?`  | `true` if the SVG was vectorized by hand.                                                                                            |
+| `branding`     | `object?`   | `primary_color`, `tagline` and `guidelines` (link to the brand guidelines), each optional.                                           |
+| `assets`       | `object`    | One [`AssetInfo`](#assetinfo) per available type (`icon`, `logo`, `tail`). Missing types have no key.                                |
 
 ### AssetInfo
 
@@ -160,6 +161,16 @@ assets/<slug>/
 └── logo-mono.svg   # hand-made for a multi-color logo, optional
 ```
 
+## Subsidiaries in 0.2.2
+
+`0.2.2` drops the `subsidiaries` field, in a patch release since nothing known reads it. Each airline that used to be listed there is now an entry of its own, with its own codes, country, website and callsign, returned by `listAirlines()` and `getAirline()`. Its `parent` field holds the slug of the airline that owns it.
+
+| Up to 0.2.1                              | From 0.2.2                                                         |
+| :--------------------------------------- | :----------------------------------------------------------------- |
+| `getAirline('AK').subsidiaries`          | `listAirlines().filter((a) => a.parent === 'airasia')`             |
+| `getAirline('FD')` returns `undefined`   | Returns Thai AirAsia; `getAssetPath('FD', 'logo')` gives its logo. |
+| A subsidiary used its parent's SVG files | It has files under its own slug: `assets/thai-airasia/logo.svg`.   |
+
 ## Migrating from the old API
 
 Versions up to `0.1.0-alpha.14` exported `getAssets()`, `getAssetContent()`, a default export and a `soaring-symbols/utils` subpath. They are gone; the asset information now ships precomputed in each airline's `assets` field, so the library no longer touches the file system.

package/README.md

@@ -17,17 +17,21 @@ Browse the collection, open a page for any airline to download its marks, and ch
 
 ## Roadmap
 
+This is the one roadmap for the collection and every integration around it, including the ones built in other repositories (the API on the website, the Raycast extension). Plans that only concern the website itself, such as its pages and tooling, are tracked in the [website's README](https://github.com/soaring-symbols/website#roadmap).
+
 - [x] npm package
+- [x] A `branding.primary_color` for every airline
+- [x] jsDelivr CDN
 - [x] Website with a browsable catalog, a page per airline and an SVG validator
+- [x] JSON API on the website, such as [`/api/airlines/VN`](https://soaringsymbols.org/api/airlines/VN)
 - [x] Raycast extension
-- [x] jsDelivr CDN
-- [ ] Iconify icon set, for Iconify, Nuxt Icon, UnoCSS, Tailwind and Astro
+- [x] Image endpoint on the website, to load a mark by IATA or ICAO code, with monochrome marks in a chosen color and PNG for apps that can't render SVG, such as [`/api/airlines/VN/icon.png`](https://soaringsymbols.org/api/airlines/VN/icon.png)
 - [ ] Figma plugin, to search airlines by name or IATA code and drop their marks into designs
-- [ ] Swift Package, with an asset catalog and a SwiftUI view
-- [ ] JSON API on the website, such as `/api/airlines/VN`
-- [ ] A `branding.primary_color` for every airline (Iberia and Qantas have none yet)
 
-Plans for the website itself are tracked in the [website's README](https://github.com/soaring-symbols/website#roadmap).
+### Not planned
+
+- Iconify icon set: Iconify declined to add the collection, as airline logos are too niche for its users ([iconify/icon-sets#223](https://github.com/iconify/icon-sets/issues/223)). A self-published Iconify JSON would miss what makes Iconify useful (its API, search and auto-installed `@iconify-json` packages), so the SVGs from npm or jsDelivr remain the way to use the marks.
+- Swift and Android packages: bundled marks go stale until the app ships an update, and Android needs every SVG converted to a VectorDrawable. Native apps can load the marks by URL instead, from jsDelivr or the image endpoint. We'll reconsider if someone asks for a package.
 
 ## Installation
 
@@ -47,17 +51,17 @@ bun add soaring-symbols
 
 ## Ecosystem
 
-| Tool / Integration | Author |
-| :-- | :-- |
-| [npm Package](https://www.npmjs.com/package/soaring-symbols) <img src="https://cdn.simpleicons.org/npm/000/CB3837" alt="npm" align=left width=24 height=24 /> | [anhthang]|
-| [Raycast Extension](https://www.raycast.com/anhthang/soaring-symbols) <img src="https://cdn.simpleicons.org/raycast/000/FF6363" alt="Raycast" align=left width=24 height=24 /> | [anhthang]|
+| Tool / Integration                                                                                                                                                              | Author                               |
+| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------- |
+| [npm Package](https://www.npmjs.com/package/soaring-symbols) <img src="https://cdn.simpleicons.org/npm/000/CB3837" alt="npm" align=left width=24 height=24 />                   | [anhthang]                           |
 | [jsDelivr CDN](https://www.jsdelivr.com/package/npm/soaring-symbols) <img src="https://cdn.simpleicons.org/jsdelivr/000/E84D3D" alt="jsDelivr" align=left width=24 height=24 /> | [jsDelivr](https://www.jsdelivr.com) |
+| [Raycast Extension](https://www.raycast.com/anhthang/soaring-symbols) <img src="https://cdn.simpleicons.org/raycast/000/FF6363" alt="Raycast" align=left width=24 height=24 />  | [anhthang]                           |
 
-The Raycast extension also works in launchers that run Raycast extensions, such as [Vicinae](https://www.vicinae.com), [SuperCmd](https://supercmd.sh) and [Tinycast](https://tinycast.dev). See the [ecosystem section on the website](https://soaringsymbols.org/#ecosystem) for how to use each one.
+The Raycast extension also works in launchers that run Raycast extensions, such as [Vicinae](https://www.vicinae.com), [SuperCmd](https://supercmd.sh) and [Tinycast](https://tinycast.dev). See the [ecosystem page on the website](https://soaringsymbols.org/ecosystem#raycast) for how to use each one.
 
 ### CDN
 
-Link any mark straight from the npm package through jsDelivr, with nothing to install. `<slug>` is the airline's name in lowercase with hyphens (e.g. `vietnam-airlines`, see [AIRLINES.md](./AIRLINES.md)); swap `logo` for `icon` or `tail` to get the other marks.
+Link any mark straight from the npm package through jsDelivr, with nothing to install. `<slug>` is the airline's name in lowercase with hyphens (e.g. `vietnam-airlines`; every airline's page on [soaringsymbols.org](https://soaringsymbols.org) shows it); swap `logo` for `icon` or `tail` to get the other marks.
 
 ```text
 https://cdn.jsdelivr.net/npm/soaring-symbols/dist/assets/<slug>/logo.svg
@@ -79,10 +83,13 @@ const vna = getAirline('VN')
     "name": "Vietnam Airlines",
     "iata": "VN",
     "icao": "HVN",
+    "callsign": "VIET NAM AIRLINES",
     "country": "VN",
     "flag_carrier": true,
     "website": "https://www.vietnamairlines.com",
     "alliance": "SkyTeam",
+    "hubs": ["HAN", "SGN"],
+    "founded": 1956,
     "branding": {
         "primary_color": "#d99e09",
         "tagline": "Reach Further",