shipthis 0.0.8 → 0.0.20

package/bin/readme.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+scriptDir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+cd $scriptDir/..
+
+# We want to avoid overwriting the docs we have manually written
+
+bin/dev.js internal readme docs/ -d 2 --only docs/game --notDryRun --overWrite
+bin/dev.js internal readme docs/ -d 2 --only docs/apple/apiKey --notDryRun --overWrite
+bin/dev.js internal readme docs/ -d 2 --only docs/apple/certificate --notDryRun --overWrite
+bin/dev.js internal readme docs/ -d 2 --only docs/login.md --notDryRun --overWrite
+bin/dev.js internal readme docs/ -d 2 --only docs/status.md --notDryRun --overWrite
+bin/dev.js internal readme docs/ -d 2 --only docs/dashboard.md --notDryRun --overWrite
+bin/dev.js internal readme docs/ -d 2 --only docs/help.md --notDryRun --overWrite

package/bin/run.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --no-deprecation
 
 import {execute} from '@oclif/core'
 

package/dist/commands/apple/apiKey/create.js

@@ -26,7 +26,7 @@ import 'deepmerge';
 
 class AppleApiKeyCreate extends BaseAppleCommand {
   static args = {};
-  static description = "Creates an App Store Connect API Key in your Apple Developer account and saves the private key in your ShipThis account";
+  static description = "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.";
   static examples = ["<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --force"];
   static flags = {
     force: Flags.boolean({ char: "f" }),

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

@@ -73,7 +73,7 @@ const AppleApiKeysTable = ({ ctx, ...boxProps }) => {
 
 class AppleApiKeyStatus extends BaseAuthenticatedCommand {
   static args = {};
-  static description = "Displays the status of the App Store Connect API Keys in your Apple and ShipThis accounts. The API key is used to automatically publish your games to the App Store.";
+  static description = "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.";
   static examples = [
     "<%= config.bin %> <%= command.id %>",
     "<%= config.bin %> <%= command.id %> --noAppleAuth"

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

@@ -65,7 +65,7 @@ function exportCertificate(certificate, privateKey) {
 
 class AppleCertificateCreate extends BaseAppleCommand {
   static args = {};
-  static description = "Creates an iOS Distribution Certificate in your Apple Developer account and saves it with the private key to your ShipThis account";
+  static description = "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account";
   static examples = ["<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --force"];
   static flags = {
     force: Flags.boolean({ char: "f" }),

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

@@ -81,7 +81,7 @@ const AppleCertificatesTable = ({ ctx, ...boxProps }) => {
 
 class AppleCertificateStatus extends BaseAuthenticatedCommand {
   static args = {};
-  static description = "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts. These are used to sign all of your iOS apps.";
+  static description = "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.\nThese are used to sign all of your iOS apps.";
   static examples = [
     "<%= config.bin %> <%= command.id %>",
     "<%= config.bin %> <%= command.id %> --noAppleAuth"

package/dist/commands/apple/login.js

@@ -36,7 +36,7 @@ class AppleLogin extends BaseAuthenticatedCommand {
     force: Flags.boolean({ char: "f" }),
     appleEmail: Flags.string({
       char: "e",
-      description: "Your Apple email address"
+      description: "Your Apple Developer email address"
     })
   };
   async run() {
@@ -47,12 +47,12 @@ class AppleLogin extends BaseAuthenticatedCommand {
     }
     const getAppleEmail = async () => {
       if (flags.appleEmail) return flags.appleEmail;
-      const appleEmail2 = await getInput("Please enter your Apple email address: ");
+      const appleEmail2 = await getInput("Please enter your Apple Developer account email address: ");
       if (!appleEmail2) throw new Error("Email address is required");
       return appleEmail2;
     };
     const getApplePassword = async () => {
-      const applePassword2 = await getMaskedInput("Please enter your Apple password: ");
+      const applePassword2 = await getMaskedInput("Please enter your Apple Developer password: ");
       if (!applePassword2) throw new Error("Password is required");
       return applePassword2;
     };

package/dist/commands/apple/status.js

@@ -1,10 +1,10 @@
 import { jsxs, jsx } from 'react/jsx-runtime';
+import { B as BaseAuthenticatedCommand } from '../../baseGameCommand-BeUNc6Wy.js';
 import 'path';
 import 'fs';
 import '@oclif/core';
 import '@expo/apple-utils/build/index.js';
 import 'axios';
-import '../../baseGameCommand-BeUNc6Wy.js';
 import 'luxon';
 import 'crypto';
 import 'readline-sync';
@@ -13,7 +13,6 @@ import 'react';
 import '@tanstack/react-query';
 import 'socket.io-client';
 import 'isomorphic-git';
-import { B as BaseAppleCommand } from '../../baseAppleCommand-IhowpKpk.js';
 import { A as App } from '../../App-SiSXLW2s.js';
 import { render } from 'ink';
 import 'ink-spinner';
@@ -25,19 +24,35 @@ import 'ini';
 import 'deepmerge';
 import '../../Title-BCQtayg6.js';
 
-class AppleStatus extends BaseAppleCommand {
+class AppleStatus extends BaseAuthenticatedCommand {
   static args = {};
-  static description = "Shows the status of the Apple authentication and integration";
+  static description = "Shows the status of the Apple authentication and integration.";
   static examples = ["<%= config.bin %> <%= command.id %>"];
   static flags = {};
   async run() {
-    const authState = await this.refreshAppleAuthState();
-    const { session } = authState;
+    const checkAuth = async () => {
+      try {
+        const authState = await this.refreshAppleAuthState();
+        const { session: session2 } = authState;
+        return {
+          isAuthenticatedOnApple: true,
+          session: session2
+        };
+      } catch {
+        return {
+          isAuthenticatedOnApple: false,
+          session: null
+        };
+      }
+    };
+    const { isAuthenticatedOnApple, session } = await checkAuth();
     const statuses = {
-      "Full Name": session.user.fullName,
-      "Provider Name": session.provider.name
+      "Authenticated on Apple Developer Portal": isAuthenticatedOnApple,
+      "Apple Full Name": session?.user?.fullName || "Please authenticate",
+      "Apple Provider Name": session?.provider?.name || "Please authenticate"
     };
-    const steps = [];
+    let steps = [];
+    if (!isAuthenticatedOnApple) steps.push("$ shipthis apple login");
     render(
       /* @__PURE__ */ jsxs(App, { children: [
         /* @__PURE__ */ jsx(StatusTable, { marginBottom: 1, title: "Apple Status", statuses }),

package/dist/commands/game/create.js

@@ -18,7 +18,7 @@ import 'isomorphic-git';
 
 class GameCreate extends BaseAuthenticatedCommand {
   static args = {};
-  static description = "Create a new game";
+  static description = "Create a new game in ShipThis.";
   static examples = ["<%= config.bin %> <%= command.id %>"];
   static flags = {
     quiet: Flags.boolean({ char: "q", description: "Avoid output except for interactions and errors" }),

package/dist/commands/game/details.js

@@ -26,7 +26,7 @@ import '../../Title-BCQtayg6.js';
 
 class GameDetails extends BaseGameCommand {
   static args = {};
-  static description = "Shows and sets the details of a game. If --gameId is not provided it will look in the current directory.";
+  static description = "Shows and sets the details of a game.";
   static examples = [
     "<%= config.bin %> <%= command.id %>",
     "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",

package/dist/commands/game/ios/app/create.js

@@ -25,7 +25,7 @@ import 'deepmerge';
 
 class GameIosAppCreate extends BaseGameCommand {
   static args = {};
-  static description = "Creates an App and BundleId in the Apple Developer Portal. If --gameId is not provided it will look in the current directory.";
+  static description = "Creates an App and BundleId in the Apple Developer Portal.";
   static examples = ["<%= config.bin %> <%= command.id %>"];
   static flags = {
     quiet: Flags.boolean({ char: "q", description: "Avoid output except for interactions and errors" }),

package/dist/commands/game/ios/app/status.js

@@ -29,7 +29,7 @@ import '../../../../useAppleBundleId-VKmaX7sP.js';
 
 class GameIosAppStatus extends BaseGameCommand {
   static args = {};
-  static description = "Shows the Game iOS App status. If --gameId is not provided it will look in the current directory.";
+  static description = "Shows the Game iOS App status. ";
   static examples = ["<%= config.bin %> <%= command.id %>"];
   static flags = {
     gameId: Flags.string({ char: "g", description: "The ID of the game" })

package/dist/commands/game/ios/app/sync.js

@@ -25,7 +25,7 @@ import 'deepmerge';
 
 class GameIosAppSync extends BaseGameCommand {
   static args = {};
-  static description = 'Synchronies the Apple App "BundleId" with the capabilities from the local project. If --gameId is not provided it will look in the current directory.';
+  static description = 'Synchronies the Apple App "BundleId" with the capabilities from the local project.';
   static examples = ["<%= config.bin %> <%= command.id %>"];
   static flags = {
     quiet: Flags.boolean({ char: "q", description: "Avoid output except for interactions and errors" }),

package/dist/commands/game/ios/profile/create.js

@@ -26,7 +26,7 @@ import 'deepmerge';
 
 class GameIosProfileCreate extends BaseGameCommand {
   static args = {};
-  static description = "Creates a Mobile Provisioning Profile in the Apple Developer Portal. If --gameId is not provided it will look in the current directory.";
+  static description = "Creates a Mobile Provisioning Profile in the Apple Developer Portal.";
   static examples = ["<%= config.bin %> <%= command.id %>"];
   static flags = {
     quiet: Flags.boolean({ char: "q", description: "Avoid output except for interactions and errors" }),

package/dist/commands/game/ios/profile/status.js

@@ -149,7 +149,7 @@ const ProjectCredentialsTable = ({ credentialTypeName, queryProps, ...boxProps }
 
 class GameIosProfileStatus extends BaseGameCommand {
   static args = {};
-  static description = "Shows the Game iOS Mobile Provisioning Profile Status. If --gameId is not provided it will look in the current directory.";
+  static description = "Shows the Game iOS Mobile Provisioning Profile Status.";
   static examples = ["<%= config.bin %> <%= command.id %>"];
   static flags = {
     gameId: Flags.string({ char: "g", description: "The ID of the game" }),

package/dist/commands/game/job/list.js

@@ -27,7 +27,7 @@ import '../../../cacheKeys-CShA-ZjE.js';
 
 class GameJobList extends BaseGameCommand {
   static args = {};
-  static description = "Lists the jobs for a game. If --gameId is not provided it will look in the current directory.";
+  static description = "Lists the jobs for a game.";
   static examples = [
     "<%= config.bin %> <%= command.id %>",
     "<%= config.bin %> <%= command.id %> --gameId 0c179fc4"

package/dist/commands/game/list.js

@@ -25,7 +25,7 @@ import 'isomorphic-git';
 
 class GameList extends BaseAuthenticatedCommand {
   static args = {};
-  static description = "Shows a list of all your games";
+  static description = "Shows a list of all your games.";
   static examples = ["<%= config.bin %> <%= command.id %>"];
   static flags = {
     pageNumber: Flags.integer({ char: "p", description: "The page number to show (starts at 0)", default: 0 }),

package/dist/commands/game/ship.js

@@ -22,7 +22,7 @@ import 'isomorphic-git';
 
 class GameShip extends BaseGameCommand {
   static args = {};
-  static description = "Builds the app (for all platforms with valid credentials) and ships it to the stores";
+  static description = "Builds the app (for all platforms with valid credentials) and ships it to the stores.";
   static examples = ["<%= config.bin %> <%= command.id %>"];
   async run() {
     await this.ensureWeAreInAProjectDir();

package/dist/commands/game/status.js

@@ -27,7 +27,7 @@ import '../../Title-BCQtayg6.js';
 
 class GameStatus extends BaseGameCommand {
   static args = {};
-  static description = "Shows the Game status. If --gameId is not provided it will look in the current directory.";
+  static description = "Shows the status of the current game.";
   static examples = [
     "<%= config.bin %> <%= command.id %>",
     "<%= config.bin %> <%= command.id %> --gameId 0c179fc4"

package/dist/commands/game/wizard.js

@@ -22,7 +22,7 @@ class GameWizard extends BaseAuthenticatedCommand {
   static flags = {
     forceStep: Flags.string({
       char: "f",
-      description: "Force a specific step to run. You can repeat this flag to force multiple steps."
+      description: "Force a specific step to run."
     }),
     platform: Flags.string({
       char: "p",
@@ -31,7 +31,8 @@ class GameWizard extends BaseAuthenticatedCommand {
         "ios"
         /* TODO - android */
       ],
-      required: true
+      required: false,
+      default: "ios"
     })
   };
   async run() {

package/dist/commands/status.js

@@ -56,7 +56,7 @@ class Status extends BaseCommand {
     let steps = [];
     if (!isLoggedIn) steps.push("$ shipthis login --email my.email@address.nowhere");
     if (!isGodotGame) steps.push("Run this command in a Godot project directory");
-    if (!isShipThisConfigured) steps.push('$ shipthis game create --name "My Awesome Game"');
+    if (!isShipThisConfigured) steps.push("$ shipthis game wizard --platform ios");
     if (steps.length === 0) steps = ["$ shipthis game status"];
     const statusProps = {
       title: "Status",

package/dist/utils/help.js

@@ -0,0 +1,14 @@
+import { Help } from '@oclif/core';
+
+class CustomHelp extends Help {
+  formatTopics(topics) {
+    const publicTopics = topics.filter((t) => t.name !== "internal");
+    return super.formatTopics(publicTopics);
+  }
+  // formatCommand is protected, so we need to override it to make it public
+  exposedFormatCommand(command) {
+    return super.formatCommand(command);
+  }
+}
+
+export { CustomHelp as default };

package/docs/README.md

@@ -0,0 +1,20 @@
+# CLI Reference
+
+# Intro
+
+ShipThis is a platform that helps you manage shipping your [Godot](https://godotengine.org/) Games to the app
+stores. Currently it supports the Apple App Store however more platforms being developed.
+
+This is all done with an easy to use command line tool called `shipthis`.
+
+You can discover **ShipThis in less than 5 minutes** via our [Quick Start Guide](https://shipthis.cc/docs/quickstart).
+
+## Topics
+- [apple](apple.md)
+- [game](game.md)
+
+## Commands
+- [dashboard](dashboard.md)
+- [login](login.md)
+- [status](status.md)
+- [help](help.md)

package/docs/apple/apiKey/create.md

@@ -0,0 +1,26 @@
+# apple apiKey create
+
+## Description
+
+Creates an App Store Connect API Key in your Apple Developer account.
+Saves the private key in your ShipThis account.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey create [-f] [-q]
+
+FLAGS
+  -f, --force
+  -q, --quiet  Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates an App Store Connect API Key in your Apple Developer account.
+  Saves the private key in your ShipThis account.
+
+EXAMPLES
+  $ shipthis apple apiKey create
+
+  $ shipthis apple apiKey create --force
+```

package/docs/apple/apiKey/export.md

@@ -0,0 +1,24 @@
+# apple apiKey export
+
+## Description
+
+Saves the current App Store Connect API Key to a ZIP file
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey export FILE [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to create
+
+FLAGS
+  -f, --force  Overwrite the file if it already exists
+
+DESCRIPTION
+  Saves the current App Store Connect API Key to a ZIP file
+
+EXAMPLES
+  $ shipthis apple apiKey export userApiKey.zip
+```

package/docs/apple/apiKey/import.md

@@ -0,0 +1,24 @@
+# apple apiKey import
+
+## Description
+
+Imports an App Store Connect API Key ZIP file into your ShipThis account
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey import FILE [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to import (must be in the same format as the export)
+
+FLAGS
+  -f, --force
+
+DESCRIPTION
+  Imports an App Store Connect API Key ZIP file into your ShipThis account
+
+EXAMPLES
+  $ shipthis apple apiKey import userApiKey.zip
+```

package/docs/apple/apiKey/status.md

@@ -0,0 +1,25 @@
+# apple apiKey status
+
+## Description
+
+Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
+This API key is used to automatically publish your games to the App Store.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey status [-f]
+
+FLAGS
+  -f, --noAppleAuth
+
+DESCRIPTION
+  Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
+  This API key is used to automatically publish your games to the App Store.
+
+EXAMPLES
+  $ shipthis apple apiKey status
+
+  $ shipthis apple apiKey status --noAppleAuth
+```

package/docs/apple/apiKey.md

@@ -0,0 +1,110 @@
+# apple apiKey
+
+Commands related to App Store Connect API Keys
+
+
+## Commands
+
+
+### apple apiKey create
+
+#### Description
+
+Creates an App Store Connect API Key in your Apple Developer account.
+Saves the private key in your ShipThis account.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey create [-f] [-q]
+
+FLAGS
+  -f, --force
+  -q, --quiet  Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates an App Store Connect API Key in your Apple Developer account.
+  Saves the private key in your ShipThis account.
+
+EXAMPLES
+  $ shipthis apple apiKey create
+
+  $ shipthis apple apiKey create --force
+```
+
+### apple apiKey export
+
+#### Description
+
+Saves the current App Store Connect API Key to a ZIP file
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey export FILE [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to create
+
+FLAGS
+  -f, --force  Overwrite the file if it already exists
+
+DESCRIPTION
+  Saves the current App Store Connect API Key to a ZIP file
+
+EXAMPLES
+  $ shipthis apple apiKey export userApiKey.zip
+```
+
+### apple apiKey import
+
+#### Description
+
+Imports an App Store Connect API Key ZIP file into your ShipThis account
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey import FILE [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to import (must be in the same format as the export)
+
+FLAGS
+  -f, --force
+
+DESCRIPTION
+  Imports an App Store Connect API Key ZIP file into your ShipThis account
+
+EXAMPLES
+  $ shipthis apple apiKey import userApiKey.zip
+```
+
+### apple apiKey status
+
+#### Description
+
+Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
+This API key is used to automatically publish your games to the App Store.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey status [-f]
+
+FLAGS
+  -f, --noAppleAuth
+
+DESCRIPTION
+  Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
+  This API key is used to automatically publish your games to the App Store.
+
+EXAMPLES
+  $ shipthis apple apiKey status
+
+  $ shipthis apple apiKey status --noAppleAuth
+```

package/docs/apple/certificate/create.md

@@ -0,0 +1,26 @@
+# apple certificate create
+
+## Description
+
+Creates an iOS Distribution Certificate in your Apple Developer account.
+Saves the certificate with the private key to your ShipThis account
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple certificate create [-f] [-q]
+
+FLAGS
+  -f, --force
+  -q, --quiet  Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates an iOS Distribution Certificate in your Apple Developer account.
+  Saves the certificate with the private key to your ShipThis account
+
+EXAMPLES
+  $ shipthis apple certificate create
+
+  $ shipthis apple certificate create --force
+```

package/docs/apple/certificate/export.md

@@ -0,0 +1,24 @@
+# apple certificate export
+
+## Description
+
+Saves the current Apple Distribution Certificate to a ZIP file.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple certificate export FILE [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to create
+
+FLAGS
+  -f, --force  Overwrite the file if it already exists
+
+DESCRIPTION
+  Saves the current Apple Distribution Certificate to a ZIP file.
+
+EXAMPLES
+  $ shipthis apple certificate export userCert.zip
+```

package/docs/apple/certificate/import.md

@@ -0,0 +1,24 @@
+# apple certificate import
+
+## Description
+
+Imports an iOS Distribution Certificate to your ShipThis account
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple certificate import FILE [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to import (must be in the same format as the export)
+
+FLAGS
+  -f, --force
+
+DESCRIPTION
+  Imports an iOS Distribution Certificate to your ShipThis account
+
+EXAMPLES
+  $ shipthis apple certificate import userCert.zip
+```

package/docs/apple/certificate/status.md

@@ -0,0 +1,25 @@
+# apple certificate status
+
+## Description
+
+Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.
+These are used to sign all of your iOS apps.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple certificate status [-f]
+
+FLAGS
+  -f, --noAppleAuth
+
+DESCRIPTION
+  Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.
+  These are used to sign all of your iOS apps.
+
+EXAMPLES
+  $ shipthis apple certificate status
+
+  $ shipthis apple certificate status --noAppleAuth
+```