shipthis 0.0.28 → 0.0.29

package/dist/commands/apple/certificate/status.js

@@ -1,4 +1,4 @@
-import { jsxs, jsx, Fragment } from 'react/jsx-runtime';
+import { jsxs, Fragment, jsx } from 'react/jsx-runtime';
 import { Flags } from '@oclif/core';
 import { Box, Text, render } from 'ink';
 import { f as getShortDate, q as Certificate, r as CertificateType, P as Platform, C as CredentialsType, B as BaseAuthenticatedCommand } from '../../../baseGameCommand-B3NbuvDu.js';
@@ -65,17 +65,20 @@ const AppleCertificatesTable = ({ ctx, ...boxProps }) => {
   });
   const { data: certs, isLoading } = useAppleCertificates({ ctx });
   const hasUsable = certs && userCredentialsResponse && certs.some((cert) => canAppleCertificateBeUsed(cert, userCredentialsResponse.data));
-  return /* @__PURE__ */ jsxs(Box, { flexDirection: "column", marginBottom: 1, ...boxProps, children: [
-    /* @__PURE__ */ jsx(Title, { children: "Distribution Certificates in your Apple account" }),
-    isLoading && /* @__PURE__ */ jsx(Spinner, { type: "dots" }),
-    certs && userCredentialsResponse && /* @__PURE__ */ jsxs(Fragment, { children: [
-      /* @__PURE__ */ jsxs(Box, { marginLeft: 2, marginBottom: 1, flexDirection: "column", children: [
-        /* @__PURE__ */ jsx(Text, { children: `You have ${certs.length} Distribution Certificates in your Apple account` }),
-        /* @__PURE__ */ jsx(Text, { children: `${hasUsable ? "One" : "None"} of these can be used by ShipThis` })
-      ] }),
-      /* @__PURE__ */ jsx(Table, { data: certs.map((cert) => getAppleCertificateSummary(cert, userCredentialsResponse.data)) }),
-      !hasUsable && /* @__PURE__ */ jsx(Box, { marginTop: 1, children: /* @__PURE__ */ jsx(Text, { bold: true, children: "You do not have a usable Distribution Certificate. To ship an iOS game, you will need a usable Distribution Certificate." }) })
-    ] })
+  return /* @__PURE__ */ jsxs(Fragment, { children: [
+    /* @__PURE__ */ jsxs(Box, { flexDirection: "column", marginBottom: 1, ...boxProps, children: [
+      /* @__PURE__ */ jsx(Title, { children: "Distribution Certificates in your Apple account" }),
+      isLoading && /* @__PURE__ */ jsx(Spinner, { type: "dots" }),
+      certs && userCredentialsResponse && /* @__PURE__ */ jsxs(Fragment, { children: [
+        /* @__PURE__ */ jsxs(Box, { marginLeft: 2, marginBottom: 1, flexDirection: "column", children: [
+          /* @__PURE__ */ jsx(Text, { children: `You have ${certs.length} Distribution Certificates in your Apple account` }),
+          /* @__PURE__ */ jsx(Text, { children: `${hasUsable ? "One" : "None"} of these can be used by ShipThis` })
+        ] }),
+        certs.length > 0 && /* @__PURE__ */ jsx(Table, { data: certs.map((cert) => getAppleCertificateSummary(cert, userCredentialsResponse.data)) }),
+        !hasUsable && /* @__PURE__ */ jsx(Box, { marginTop: 1, children: /* @__PURE__ */ jsx(Text, { bold: true, children: "You do not have a usable Distribution Certificate. To ship an iOS game, you will need a usable Distribution Certificate." }) })
+      ] })
+    ] }),
+    certs && !hasUsable && /* @__PURE__ */ jsx(NextSteps, { steps: ["shipthis apple certificate create"] })
   ] });
 };
 

package/docs/apple/apiKey.md

@@ -1,27 +1,32 @@
 # Topic: `apple apiKey`
 
+## Description
+
 Commands in the apple apiKey topic are prefixed `shipthis apple apiKey`. These commands relate to App Store Connect API Keys.
 
 - You can view the App Store Connect API Keys in the [Apple Developer Portal](https://appstoreconnect.apple.com/access/integrations/api).
 - You can view the keys which ShipThis can use in the [ShipThis Dashboard](https://shipthis.cc/credentials)
 
+:::info
+An **App Store Connect API key** is used to authenticate and authorize automated interactions with Apple's App Store Connect API, enabling tasks like managing app metadata, TestFlight, and sales reports.
+:::
+
 :::tip
 You will need to be authenticated against ShipThis and Apple before you can use
 these commands. To do that please run the following commands first:
 
 - [`shipthis login`](/docs/reference/login)
 - [`shipthis apple login`](/docs/reference/apple/login)
+
 :::
 
 ## Example
 
-
-
+[![asciicast](https://asciinema.org/a/PsCq8H4NowWSiGGMLraosAh9a.svg)](https://asciinema.org/a/PsCq8H4NowWSiGGMLraosAh9a)
 
 ## Commands
 
-
-### apple apiKey create
+### `apple apiKey create`
 
 #### Description
 
@@ -48,7 +53,7 @@ EXAMPLES
   $ shipthis apple apiKey create --force
 ```
 
-### apple apiKey export
+### `apple apiKey export`
 
 #### Description
 
@@ -73,7 +78,7 @@ EXAMPLES
   $ shipthis apple apiKey export userApiKey.zip
 ```
 
-### apple apiKey import
+### `apple apiKey import`
 
 #### Description
 
@@ -98,7 +103,7 @@ EXAMPLES
   $ shipthis apple apiKey import userApiKey.zip
 ```
 
-### apple apiKey status
+### `apple apiKey status`
 
 #### Description
 

package/docs/apple/certificate.md

@@ -1,12 +1,32 @@
 # Topic: `apple certificate`
 
-Commands related to App Store Certificates
+## Description
 
+Commands in the apple certificate topic are prefixed `shipthis apple certificate`.
+These commands relate to iOS Distribution Certificates within your Apple Developer account.
 
-## Commands
+- You can view the Distribution Certificates in the [Apple Developer Portal](https://developer.apple.com/account/resources/certificates/list).
+- You can more about Certificates in the [Apple Documentation](https://developer.apple.com/help/account/create-certificates/certificates-overview/).
+- You can view the Certificates which ShipThis uses in the [ShipThis Dashboard](https://shipthis.cc/credentials).
+
+:::info
+An **iOS Distribution Certificate** is used to authenticate and authorize the distribution of iOS apps, ensuring they are signed and trusted for installation on devices or submission to the App Store.
+:::
+
+:::tip
+You will need to be authenticated against ShipThis and Apple before you can use
+these commands. To do that please run the following commands first:
+
+- [`shipthis login`](/docs/reference/login)
+- [`shipthis apple login`](/docs/reference/apple/login)
 
+:::
+
+## Example
+
+## Commands
 
-### apple certificate create
+### `apple certificate create`
 
 #### Description
 
@@ -33,7 +53,7 @@ EXAMPLES
   $ shipthis apple certificate create --force
 ```
 
-### apple certificate export
+### `apple certificate export`
 
 #### Description
 
@@ -58,7 +78,7 @@ EXAMPLES
   $ shipthis apple certificate export userCert.zip
 ```
 
-### apple certificate import
+### `apple certificate import`
 
 #### Description
 
@@ -83,7 +103,7 @@ EXAMPLES
   $ shipthis apple certificate import userCert.zip
 ```
 
-### apple certificate status
+### `apple certificate status`
 
 #### Description
 

package/docs/game/build.md

@@ -5,13 +5,19 @@ to managing completed builds of your game.
 
 ShipThis allows you to list and download your builds.
 
-## Example 
+:::tip
+The `game build` topic relates to the files which are generated by ShipThis from
+your game code. It should not be confused with the command [`shipthis game ship`](/docs/reference/game/ship).
+:::
+
+
+## Example
 
 [![asciicast](https://asciinema.org/a/m2i3bOvZHUpQXFWtYXc7UnaKQ.svg)](https://asciinema.org/a/m2i3bOvZHUpQXFWtYXc7UnaKQ)
 
 ## Commands
 
-### game build download
+### Command: `game build download`
 
 #### Description
 
@@ -40,7 +46,7 @@ EXAMPLES
   $ shipthis game build download --gameId 0c179fc4 e4b9a3d7 output.apk
 ```
 
-### game build list
+### Command: `game build list`
 
 #### Description
 

package/oclif.manifest.json

@@ -663,139 +663,6 @@
         "status.js"
       ]
     },
-    "game:build:download": {
-      "aliases": [],
-      "args": {
-        "build_id": {
-          "description": "The ID of the build to download",
-          "name": "build_id",
-          "required": true
-        },
-        "file": {
-          "description": "Name of the file to output",
-          "name": "file",
-          "required": true
-        }
-      },
-      "description": "Downloads the given build artifact to the specified file",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
-      ],
-      "flags": {
-        "gameId": {
-          "char": "g",
-          "description": "The ID of the game",
-          "name": "gameId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "force": {
-          "char": "f",
-          "description": "Overwrite the file if it already exists",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "game:build:download",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "game",
-        "build",
-        "download.js"
-      ]
-    },
-    "game:build:list": {
-      "aliases": [],
-      "args": {},
-      "description": "Lists the builds for successful jobs of a game.",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
-      ],
-      "flags": {
-        "gameId": {
-          "char": "g",
-          "description": "The ID of the game",
-          "name": "gameId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "pageNumber": {
-          "char": "p",
-          "description": "The page number to show (starts at 0)",
-          "name": "pageNumber",
-          "default": 0,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "pageSize": {
-          "char": "s",
-          "description": "The number of items to show per page",
-          "name": "pageSize",
-          "default": 10,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "orderBy": {
-          "char": "o",
-          "description": "The field to order by",
-          "name": "orderBy",
-          "default": "createdAt",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "createdAt",
-            "updatedAt"
-          ],
-          "type": "option"
-        },
-        "order": {
-          "char": "r",
-          "description": "The order to sort by",
-          "name": "order",
-          "default": "desc",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "asc",
-            "desc"
-          ],
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "game:build:list",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "game",
-        "build",
-        "list.js"
-      ]
-    },
     "apple:apiKey:create": {
       "aliases": [],
       "args": {},
@@ -945,13 +812,67 @@
         "status.js"
       ]
     },
-    "game:ios:status": {
+    "game:build:download": {
+      "aliases": [],
+      "args": {
+        "build_id": {
+          "description": "The ID of the build to download",
+          "name": "build_id",
+          "required": true
+        },
+        "file": {
+          "description": "Name of the file to output",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Downloads the given build artifact to the specified file",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
+      ],
+      "flags": {
+        "gameId": {
+          "char": "g",
+          "description": "The ID of the game",
+          "name": "gameId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "Overwrite the file if it already exists",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "game:build:download",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "game",
+        "build",
+        "download.js"
+      ]
+    },
+    "game:build:list": {
       "aliases": [],
       "args": {},
-      "description": "Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.",
+      "description": "Lists the builds for successful jobs of a game.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4"
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
       ],
       "flags": {
         "gameId": {
@@ -961,11 +882,55 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "pageNumber": {
+          "char": "p",
+          "description": "The page number to show (starts at 0)",
+          "name": "pageNumber",
+          "default": 0,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pageSize": {
+          "char": "s",
+          "description": "The number of items to show per page",
+          "name": "pageSize",
+          "default": 10,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "orderBy": {
+          "char": "o",
+          "description": "The field to order by",
+          "name": "orderBy",
+          "default": "createdAt",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "createdAt",
+            "updatedAt"
+          ],
+          "type": "option"
+        },
+        "order": {
+          "char": "r",
+          "description": "The order to sort by",
+          "name": "order",
+          "default": "desc",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "asc",
+            "desc"
+          ],
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:status",
+      "id": "game:build:list",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -976,8 +941,8 @@
         "dist",
         "commands",
         "game",
-        "ios",
-        "status.js"
+        "build",
+        "list.js"
       ]
     },
     "game:job:list": {
@@ -1117,6 +1082,41 @@
         "status.js"
       ]
     },
+    "game:ios:status": {
+      "aliases": [],
+      "args": {},
+      "description": "Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4"
+      ],
+      "flags": {
+        "gameId": {
+          "char": "g",
+          "description": "The ID of the game",
+          "name": "gameId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "game:ios:status",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "game",
+        "ios",
+        "status.js"
+      ]
+    },
     "game:ios:app:addTester": {
       "aliases": [],
       "args": {},
@@ -1508,5 +1508,5 @@
       ]
     }
   },
-  "version": "0.0.28"
+  "version": "0.0.29"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
   "description": "Game Shipping Tool",
-  "version": "0.0.28",
+  "version": "0.0.29",
   "author": "Hello Invent Ltd",
   "bin": {
     "shipthis": "./bin/run.js"