@expo/eas-json 0.30.0 → 0.34.0

package/build/EasJson.types.d.ts

@@ -14,7 +14,12 @@ export interface EasSubmitConfiguration {
     [Platform.ANDROID]?: AndroidSubmitProfile;
     [Platform.IOS]?: IosSubmitProfile;
 }
+export interface CliConfig {
+    version?: string;
+    requireCommit?: boolean;
+}
 export interface EasJson {
+    cli?: CliConfig;
     build: {
         [profile: string]: RawBuildProfile;
     };

package/build/EasJsonReader.d.ts

@@ -1,8 +1,9 @@
 import { Platform } from '@expo/eas-build-job';
 import { BuildProfile } from './EasBuild.types';
-import { EasJson, RawBuildProfile } from './EasJson.types';
+import { CliConfig, EasJson, RawBuildProfile } from './EasJson.types';
 import { SubmitProfile } from './EasSubmit.types';
 interface EasJsonPreValidation {
+    cli?: object;
     build: {
         [profile: string]: object;
     };
@@ -10,16 +11,24 @@ interface EasJsonPreValidation {
         [profile: string]: object;
     };
 }
+declare type LoggerFn = (...args: any[]) => void;
+interface Logger {
+    log: LoggerFn;
+    warn: LoggerFn;
+}
 export declare class EasJsonReader {
     private projectDir;
+    private static log?;
     static formatEasJsonPath(projectDir: string): string;
+    static setLog(log: Logger): void;
     constructor(projectDir: string);
     getBuildProfileNamesAsync(): Promise<string[]>;
+    getCliConfigAsync(): Promise<CliConfig | null>;
     getSubmitProfileNamesAsync({ throwIfEasJsonDoesNotExist }?: {
         throwIfEasJsonDoesNotExist?: boolean | undefined;
     }): Promise<string[]>;
     readBuildProfileAsync<T extends Platform>(platform: T, profileName: string): Promise<BuildProfile<T>>;
-    readSubmitProfileAsync<T extends Platform>(platform: T, profileName?: string): Promise<SubmitProfile<T>>;
+    readSubmitProfileAsync<T extends Platform>(platform: T, profileNameArg?: string): Promise<SubmitProfile<T>>;
     readAndValidateAsync(): Promise<EasJson>;
     readRawAsync(): Promise<EasJsonPreValidation>;
     private resolveBuildProfile;

package/build/EasJsonReader.js

@@ -9,6 +9,7 @@ const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const EasJson_types_1 = require("./EasJson.types");
 const EasJsonSchema_1 = require("./EasJsonSchema");
 const EasSubmit_types_1 = require("./EasSubmit.types");
+const errors_1 = require("./errors");
 const defaults = {
     distribution: 'store',
     credentialsSource: EasJson_types_1.CredentialsSource.REMOTE,
@@ -20,11 +21,37 @@ class EasJsonReader {
     static formatEasJsonPath(projectDir) {
         return path_1.default.join(projectDir, 'eas.json');
     }
+    static setLog(log) {
+        this.log = log;
+    }
     async getBuildProfileNamesAsync() {
         var _a;
         const easJson = await this.readRawAsync();
         return Object.keys((_a = easJson === null || easJson === void 0 ? void 0 : easJson.build) !== null && _a !== void 0 ? _a : {});
     }
+    async getCliConfigAsync() {
+        try {
+            const easJson = await this.readRawAsync();
+            if (!easJson.cli) {
+                return null;
+            }
+            const { value, error } = EasJsonSchema_1.CliConfigSchema.validate(easJson.cli, {
+                allowUnknown: false,
+                convert: true,
+                abortEarly: false,
+            });
+            if (error) {
+                throw new Error(`"cli" field in eas.json is not valid [${error.toString()}]`);
+            }
+            return value;
+        }
+        catch (err) {
+            if (err.code === 'ENOENT') {
+                return null;
+            }
+            throw err;
+        }
+    }
     async getSubmitProfileNamesAsync({ throwIfEasJsonDoesNotExist = true } = {}) {
         var _a;
         try {
@@ -56,14 +83,18 @@ class EasJsonReader {
             throw new Error(`Unknown platform ${platform}`);
         }
     }
-    async readSubmitProfileAsync(platform, profileName) {
+    async readSubmitProfileAsync(platform, profileNameArg) {
         var _a;
+        let profileName = profileNameArg;
         if (!profileName) {
             const profileNames = await this.getSubmitProfileNamesAsync({
                 throwIfEasJsonDoesNotExist: false,
             });
-            if (profileNames.includes('release')) {
-                return await this.readSubmitProfileAsync(platform, 'release');
+            if (profileNames.includes('production')) {
+                profileName = 'production';
+            }
+            else if (profileNames.includes('release')) {
+                profileName = 'release';
             }
             else {
                 return getDefaultSubmitProfile(platform);
@@ -90,7 +121,7 @@ class EasJsonReader {
             abortEarly: false,
         });
         if (error) {
-            throw new Error(`eas.json is not valid [${error.toString()}]`);
+            throw new errors_1.InvalidEasJsonError(`eas.json is not valid [${error.toString()}]`);
         }
         return value;
     }
@@ -100,7 +131,7 @@ class EasJsonReader {
             const rawEasJson = json_file_1.default.read(easJsonPath);
             const { value, error } = EasJsonSchema_1.MinimalEasJsonSchema.validate(rawEasJson, { abortEarly: false });
             if (error) {
-                throw new Error(`eas.json is not valid [${error.toString()}]`);
+                throw new errors_1.InvalidEasJsonError(`eas.json is not valid [${error.toString()}]`);
             }
             return value;
         }

package/build/EasJsonSchema.d.ts

@@ -1,5 +1,6 @@
 import Joi from 'joi';
 export declare const AndroidSubmitProfileSchema: Joi.ObjectSchema<any>;
 export declare const IosSubmitProfileSchema: Joi.ObjectSchema<any>;
+export declare const CliConfigSchema: Joi.ObjectSchema<any>;
 export declare const MinimalEasJsonSchema: Joi.ObjectSchema<any>;
 export declare const EasJsonSchema: Joi.ObjectSchema<any>;

package/build/EasJsonSchema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EasJsonSchema = exports.MinimalEasJsonSchema = exports.IosSubmitProfileSchema = exports.AndroidSubmitProfileSchema = void 0;
+exports.EasJsonSchema = exports.MinimalEasJsonSchema = exports.CliConfigSchema = exports.IosSubmitProfileSchema = exports.AndroidSubmitProfileSchema = void 0;
 const tslib_1 = require("tslib");
 const eas_build_job_1 = require("@expo/eas-build-job");
 const joi_1 = (0, tslib_1.__importDefault)(require("joi"));
@@ -68,6 +68,9 @@ exports.AndroidSubmitProfileSchema = joi_1.default.object({
     changesNotSentForReview: joi_1.default.boolean().default(false),
 });
 exports.IosSubmitProfileSchema = joi_1.default.object({
+    ascApiKeyPath: joi_1.default.string(),
+    ascApiKeyId: joi_1.default.string(),
+    ascApiKeyIssuerId: joi_1.default.string(),
     appleId: joi_1.default.string(),
     ascAppId: joi_1.default.string(),
     appleTeamId: joi_1.default.string(),
@@ -80,11 +83,17 @@ const EasJsonSubmitConfigurationSchema = joi_1.default.object({
     android: exports.AndroidSubmitProfileSchema,
     ios: exports.IosSubmitProfileSchema,
 });
+exports.CliConfigSchema = joi_1.default.object({
+    version: joi_1.default.string(),
+    requireCommit: joi_1.default.boolean(),
+});
 exports.MinimalEasJsonSchema = joi_1.default.object({
+    cli: joi_1.default.object(),
     build: joi_1.default.object().pattern(joi_1.default.string(), joi_1.default.object()),
     submit: joi_1.default.object().pattern(joi_1.default.string(), joi_1.default.object()),
 });
 exports.EasJsonSchema = joi_1.default.object({
+    cli: exports.CliConfigSchema,
     build: joi_1.default.object().pattern(joi_1.default.string(), EasJsonBuildProfileSchema),
     submit: joi_1.default.object().pattern(joi_1.default.string(), EasJsonSubmitConfigurationSchema),
 });

package/build/EasSubmit.types.d.ts

@@ -19,6 +19,9 @@ export interface AndroidSubmitProfile {
 }
 export declare const AndroidSubmitProfileFieldsToEvaluate: (keyof AndroidSubmitProfile)[];
 export interface IosSubmitProfile {
+    ascApiKeyPath?: string;
+    ascApiKeyIssuerId?: string;
+    ascApiKeyId?: string;
     appleId?: string;
     ascAppId?: string;
     appleTeamId?: string;

package/build/EasSubmit.types.js

@@ -18,4 +18,8 @@ var AndroidReleaseTrack;
 exports.AndroidSubmitProfileFieldsToEvaluate = [
     'serviceAccountKeyPath',
 ];
-exports.IosSubmitProfileFieldsToEvaluate = [];
+exports.IosSubmitProfileFieldsToEvaluate = [
+    'ascApiKeyPath',
+    'ascApiKeyIssuerId',
+    'ascApiKeyId',
+];

package/build/errors.d.ts

@@ -0,0 +1,2 @@
+export declare class InvalidEasJsonError extends Error {
+}

package/build/errors.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidEasJsonError = void 0;
+class InvalidEasJsonError extends Error {
+}
+exports.InvalidEasJsonError = InvalidEasJsonError;

package/build/index.d.ts

@@ -2,4 +2,4 @@ export { AndroidSubmitProfile, AndroidReleaseStatus, AndroidReleaseTrack, IosSub
 export { EasJson } from './EasJson.types';
 export { AndroidBuildProfile, BuildProfile, CredentialsSource, DistributionType, IosBuildProfile, IosEnterpriseProvisioning, IosVersionAutoIncrement, AndroidVersionAutoIncrement, } from './EasBuild.types';
 export { EasJsonReader } from './EasJsonReader';
-export { hasMismatchedExtendsAsync, isUsingDeprecatedFormatAsync, migrateAsync } from './migrate';
+export * as errors from './errors';

package/build/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrateAsync = exports.isUsingDeprecatedFormatAsync = exports.hasMismatchedExtendsAsync = exports.EasJsonReader = exports.CredentialsSource = exports.AndroidReleaseTrack = exports.AndroidReleaseStatus = void 0;
+exports.errors = exports.EasJsonReader = exports.CredentialsSource = exports.AndroidReleaseTrack = exports.AndroidReleaseStatus = void 0;
+const tslib_1 = require("tslib");
 var EasSubmit_types_1 = require("./EasSubmit.types");
 Object.defineProperty(exports, "AndroidReleaseStatus", { enumerable: true, get: function () { return EasSubmit_types_1.AndroidReleaseStatus; } });
 Object.defineProperty(exports, "AndroidReleaseTrack", { enumerable: true, get: function () { return EasSubmit_types_1.AndroidReleaseTrack; } });
@@ -8,7 +9,4 @@ var EasBuild_types_1 = require("./EasBuild.types");
 Object.defineProperty(exports, "CredentialsSource", { enumerable: true, get: function () { return EasBuild_types_1.CredentialsSource; } });
 var EasJsonReader_1 = require("./EasJsonReader");
 Object.defineProperty(exports, "EasJsonReader", { enumerable: true, get: function () { return EasJsonReader_1.EasJsonReader; } });
-var migrate_1 = require("./migrate");
-Object.defineProperty(exports, "hasMismatchedExtendsAsync", { enumerable: true, get: function () { return migrate_1.hasMismatchedExtendsAsync; } });
-Object.defineProperty(exports, "isUsingDeprecatedFormatAsync", { enumerable: true, get: function () { return migrate_1.isUsingDeprecatedFormatAsync; } });
-Object.defineProperty(exports, "migrateAsync", { enumerable: true, get: function () { return migrate_1.migrateAsync; } });
+exports.errors = (0, tslib_1.__importStar)(require("./errors"));

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "@expo/eas-json",
   "description": "A library for interacting with the eas.json",
-  "version": "0.30.0",
+  "version": "0.34.0",
   "author": "Expo <support@expo.dev>",
   "bugs": "https://github.com/expo/eas-cli/issues",
   "dependencies": {
-    "@expo/eas-build-job": "0.2.48",
+    "@expo/eas-build-job": "0.2.57",
     "@expo/json-file": "8.2.33",
+    "chalk": "4.1.2",
     "env-string": "1.0.1",
     "fs-extra": "10.0.0",
     "joi": "17.4.2",
+    "log-symbols": "4.1.0",
     "tslib": "2.3.1"
   },
   "devDependencies": {
@@ -33,5 +35,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ca0a8f79cd592243c5f9944c5c555bff22847dcb"
+  "gitHead": "36118b700f4cadc184bddd733b568fe7abde69fe"
 }

package/src/EasJson.types.ts

@@ -19,7 +19,13 @@ export interface EasSubmitConfiguration {
   [Platform.IOS]?: IosSubmitProfile;
 }
 
+export interface CliConfig {
+  version?: string;
+  requireCommit?: boolean;
+}
+
 export interface EasJson {
+  cli?: CliConfig;
   build: { [profile: string]: RawBuildProfile };
   submit?: { [profile: string]: EasSubmitConfiguration };
 }

package/src/EasJsonReader.ts

@@ -4,9 +4,10 @@ import envString from 'env-string';
 import path from 'path';
 
 import { BuildProfile } from './EasBuild.types';
-import { CredentialsSource, EasJson, RawBuildProfile } from './EasJson.types';
+import { CliConfig, CredentialsSource, EasJson, RawBuildProfile } from './EasJson.types';
 import {
   AndroidSubmitProfileSchema,
+  CliConfigSchema,
   EasJsonSchema,
   IosSubmitProfileSchema,
   MinimalEasJsonSchema,
@@ -16,8 +17,10 @@ import {
   IosSubmitProfileFieldsToEvaluate,
   SubmitProfile,
 } from './EasSubmit.types';
+import { InvalidEasJsonError } from './errors';
 
 interface EasJsonPreValidation {
+  cli?: object;
   build: { [profile: string]: object };
   submit?: { [profile: string]: object };
 }
@@ -27,11 +30,24 @@ const defaults = {
   credentialsSource: CredentialsSource.REMOTE,
 } as const;
 
+type LoggerFn = (...args: any[]) => void;
+
+interface Logger {
+  log: LoggerFn;
+  warn: LoggerFn;
+}
+
 export class EasJsonReader {
+  private static log?: Logger;
+
   public static formatEasJsonPath(projectDir: string): string {
     return path.join(projectDir, 'eas.json');
   }
 
+  public static setLog(log: Logger): void {
+    this.log = log;
+  }
+
   constructor(private projectDir: string) {}
 
   public async getBuildProfileNamesAsync(): Promise<string[]> {
@@ -39,6 +55,29 @@ export class EasJsonReader {
     return Object.keys(easJson?.build ?? {});
   }
 
+  public async getCliConfigAsync(): Promise<CliConfig | null> {
+    try {
+      const easJson = await this.readRawAsync();
+      if (!easJson.cli) {
+        return null;
+      }
+      const { value, error } = CliConfigSchema.validate(easJson.cli, {
+        allowUnknown: false,
+        convert: true,
+        abortEarly: false,
+      });
+      if (error) {
+        throw new Error(`"cli" field in eas.json is not valid [${error.toString()}]`);
+      }
+      return value as CliConfig;
+    } catch (err: any) {
+      if (err.code === 'ENOENT') {
+        return null;
+      }
+      throw err;
+    }
+  }
+
   public async getSubmitProfileNamesAsync({ throwIfEasJsonDoesNotExist = true } = {}): Promise<
     string[]
   > {
@@ -81,18 +120,24 @@ export class EasJsonReader {
 
   public async readSubmitProfileAsync<T extends Platform>(
     platform: T,
-    profileName?: string
+    profileNameArg?: string
   ): Promise<SubmitProfile<T>> {
+    let profileName = profileNameArg;
+
     if (!profileName) {
       const profileNames = await this.getSubmitProfileNamesAsync({
         throwIfEasJsonDoesNotExist: false,
       });
-      if (profileNames.includes('release')) {
-        return await this.readSubmitProfileAsync(platform, 'release');
+
+      if (profileNames.includes('production')) {
+        profileName = 'production';
+      } else if (profileNames.includes('release')) {
+        profileName = 'release';
       } else {
         return getDefaultSubmitProfile(platform);
       }
     }
+
     const easJson = await this.readAndValidateAsync();
     const profile = easJson?.submit?.[profileName];
     if (!profile) {
@@ -115,7 +160,7 @@ export class EasJsonReader {
     });
 
     if (error) {
-      throw new Error(`eas.json is not valid [${error.toString()}]`);
+      throw new InvalidEasJsonError(`eas.json is not valid [${error.toString()}]`);
     }
     return value as EasJson;
   }
@@ -126,7 +171,7 @@ export class EasJsonReader {
       const rawEasJson = JsonFile.read(easJsonPath);
       const { value, error } = MinimalEasJsonSchema.validate(rawEasJson, { abortEarly: false });
       if (error) {
-        throw new Error(`eas.json is not valid [${error.toString()}]`);
+        throw new InvalidEasJsonError(`eas.json is not valid [${error.toString()}]`);
       }
       return value;
     } catch (err: any) {

package/src/EasJsonSchema.ts

@@ -90,6 +90,9 @@ export const AndroidSubmitProfileSchema = Joi.object({
 });
 
 export const IosSubmitProfileSchema = Joi.object({
+  ascApiKeyPath: Joi.string(),
+  ascApiKeyId: Joi.string(),
+  ascApiKeyIssuerId: Joi.string(),
   appleId: Joi.string(),
   ascAppId: Joi.string(),
   appleTeamId: Joi.string(),
@@ -104,12 +107,19 @@ const EasJsonSubmitConfigurationSchema = Joi.object({
   ios: IosSubmitProfileSchema,
 });
 
+export const CliConfigSchema = Joi.object({
+  version: Joi.string(),
+  requireCommit: Joi.boolean(),
+});
+
 export const MinimalEasJsonSchema = Joi.object({
+  cli: Joi.object(),
   build: Joi.object().pattern(Joi.string(), Joi.object()),
   submit: Joi.object().pattern(Joi.string(), Joi.object()),
 });
 
 export const EasJsonSchema = Joi.object({
+  cli: CliConfigSchema,
   build: Joi.object().pattern(Joi.string(), EasJsonBuildProfileSchema),
   submit: Joi.object().pattern(Joi.string(), EasJsonSubmitConfigurationSchema),
 });

package/src/EasSubmit.types.ts

@@ -26,6 +26,9 @@ export const AndroidSubmitProfileFieldsToEvaluate: (keyof AndroidSubmitProfile)[
 ];
 
 export interface IosSubmitProfile {
+  ascApiKeyPath?: string;
+  ascApiKeyIssuerId?: string;
+  ascApiKeyId?: string;
   appleId?: string;
   ascAppId?: string;
   appleTeamId?: string;
@@ -35,7 +38,11 @@ export interface IosSubmitProfile {
   appName?: string;
 }
 
-export const IosSubmitProfileFieldsToEvaluate: (keyof IosSubmitProfile)[] = [];
+export const IosSubmitProfileFieldsToEvaluate: (keyof IosSubmitProfile)[] = [
+  'ascApiKeyPath',
+  'ascApiKeyIssuerId',
+  'ascApiKeyId',
+];
 
 export type SubmitProfile<TPlatform extends Platform = Platform> =
   TPlatform extends Platform.ANDROID

package/src/__tests__/EasJsonReader-build-test.ts

@@ -14,13 +14,13 @@ beforeEach(async () => {
 test('minimal valid eas.json for both platforms', async () => {
   await fs.writeJson('/project/eas.json', {
     build: {
-      release: {},
+      production: {},
     },
   });
 
   const reader = new EasJsonReader('/project');
-  const iosProfile = await reader.readBuildProfileAsync(Platform.IOS, 'release');
-  const androidProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'release');
+  const iosProfile = await reader.readBuildProfileAsync(Platform.IOS, 'production');
+  const androidProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'production');
 
   expect({
     distribution: 'store',
@@ -36,7 +36,7 @@ test('minimal valid eas.json for both platforms', async () => {
 test('valid eas.json for development client builds', async () => {
   await fs.writeJson('/project/eas.json', {
     build: {
-      release: {},
+      production: {},
       debug: {
         developmentClient: true,
         android: {
@@ -219,7 +219,7 @@ test('valid profile extending other profile with platform specific caching', asy
 test('valid eas.json with missing profile', async () => {
   await fs.writeJson('/project/eas.json', {
     build: {
-      release: {},
+      production: {},
     },
   });
 
@@ -231,14 +231,14 @@ test('valid eas.json with missing profile', async () => {
 test('invalid eas.json when using wrong buildType', async () => {
   await fs.writeJson('/project/eas.json', {
     build: {
-      release: { android: { buildType: 'archive' } },
+      production: { android: { buildType: 'archive' } },
     },
   });
 
   const reader = new EasJsonReader('/project');
-  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'release');
+  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'production');
   await expect(promise).rejects.toThrowError(
-    'eas.json is not valid [ValidationError: "build.release.android.buildType" must be one of [apk, app-bundle]]'
+    'eas.json is not valid [ValidationError: "build.production.android.buildType" must be one of [apk, app-bundle]]'
   );
 });
 
@@ -246,33 +246,33 @@ test('empty json', async () => {
   await fs.writeJson('/project/eas.json', {});
 
   const reader = new EasJsonReader('/project');
-  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'release');
-  await expect(promise).rejects.toThrowError('There is no profile named release in eas.json');
+  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'production');
+  await expect(promise).rejects.toThrowError('There is no profile named production in eas.json');
 });
 
 test('invalid semver value', async () => {
   await fs.writeJson('/project/eas.json', {
     build: {
-      release: { node: '12.0.0-alpha' },
+      production: { node: '12.0.0-alpha' },
     },
   });
 
   const reader = new EasJsonReader('/project');
-  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'release');
+  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'production');
   await expect(promise).rejects.toThrowError(
-    'eas.json is not valid [ValidationError: "build.release.node" failed custom validation because 12.0.0-alpha is not a valid version]'
+    'eas.json is not valid [ValidationError: "build.production.node" failed custom validation because 12.0.0-alpha is not a valid version]'
   );
 });
 
 test('get profile names', async () => {
   await fs.writeJson('/project/eas.json', {
     build: {
-      release: { node: '12.0.0-alpha' },
+      production: { node: '12.0.0-alpha' },
       blah: { node: '12.0.0-alpha' },
     },
   });
 
   const reader = new EasJsonReader('/project');
   const allProfileNames = await reader.getBuildProfileNamesAsync();
-  expect(allProfileNames.sort()).toEqual(['blah', 'release'].sort());
+  expect(allProfileNames.sort()).toEqual(['blah', 'production'].sort());
 });