@expo/eas-json 0.36.0 → 0.38.3

package/src/reader.ts

@@ -0,0 +1,87 @@
+import { Platform } from '@expo/eas-build-job';
+import JsonFile from '@expo/json-file';
+import fs from 'fs-extra';
+import path from 'path';
+
+import { resolveBuildProfile } from './build/resolver';
+import { BuildProfile } from './build/types';
+import { InvalidEasJsonError, MissingEasJsonError } from './errors';
+import { EasJsonSchema } from './schema';
+import { resolveSubmitProfile } from './submit/resolver';
+import { SubmitProfile } from './submit/types';
+import { EasJson } from './types';
+
+export class EasJsonReader {
+  private easJson: EasJson | undefined;
+
+  constructor(private projectDir: string) {}
+
+  public static formatEasJsonPath(projectDir: string): string {
+    return path.join(projectDir, 'eas.json');
+  }
+
+  public async readAsync(): Promise<EasJson> {
+    if (this.easJson) {
+      return this.easJson;
+    }
+
+    try {
+      const easJsonPath = EasJsonReader.formatEasJsonPath(this.projectDir);
+      if (!(await fs.pathExists(easJsonPath))) {
+        throw new MissingEasJsonError(
+          `eas.json could not be found at ${easJsonPath}. Learn more at https://expo.fyi/eas-json`
+        );
+      }
+      const contents = JsonFile.read(easJsonPath);
+      const { value, error } = EasJsonSchema.validate(contents, {
+        allowUnknown: false,
+        abortEarly: false,
+        convert: true,
+        noDefaults: true,
+      });
+      if (error) {
+        throw new InvalidEasJsonError(`eas.json is not valid [${error.toString()}]`);
+      }
+      this.easJson = value;
+      return value;
+    } catch (err: any) {
+      if (err.code === 'EJSONPARSE') {
+        err.message = `Found invalid JSON in eas.json. ${err.message}`;
+      }
+      throw err;
+    }
+  }
+
+  public async getBuildProfileNamesAsync(): Promise<string[]> {
+    const easJson = await this.readAsync();
+    return Object.keys(easJson?.build ?? {});
+  }
+
+  public async getBuildProfileAsync<T extends Platform>(
+    platform: T,
+    profileName: string
+  ): Promise<BuildProfile<T>> {
+    const easJson = await this.readAsync();
+    return resolveBuildProfile({ easJson, platform, profileName });
+  }
+
+  public async getCliConfigAsync(): Promise<EasJson['cli'] | null> {
+    try {
+      const easJson = await this.readAsync();
+      return easJson.cli ?? null;
+    } catch (err: any) {
+      if (err instanceof MissingEasJsonError) {
+        return null;
+      }
+      throw err;
+    }
+  }
+
+  public async getSubmitProfileAsync<T extends Platform>(
+    platform: T,
+    profileName: string
+  ): Promise<SubmitProfile<T>> {
+    const easJson = await this.readAsync();
+    return resolveSubmitProfile({ easJson, platform, profileName });
+  }
+}

package/src/schema.ts

@@ -0,0 +1,13 @@
+import Joi from 'joi';
+
+import { BuildProfileSchema } from './build/schema';
+import { SubmitProfileSchema } from './submit/schema';
+
+export const EasJsonSchema = Joi.object({
+  cli: Joi.object({
+    version: Joi.string(),
+    requireCommit: Joi.boolean(),
+  }),
+  build: Joi.object().pattern(Joi.string(), BuildProfileSchema),
+  submit: Joi.object().pattern(Joi.string(), SubmitProfileSchema),
+});

package/src/submit/resolver.ts

@@ -0,0 +1,114 @@
+import { Platform } from '@expo/eas-build-job';
+import envString from 'env-string';
+
+import { MissingParentProfileError, MissingProfileError } from '../errors';
+import { EasJson } from '../types';
+import { AndroidSubmitProfileSchema, IosSubmitProfileSchema } from './schema';
+import {
+  AndroidSubmitProfileFieldsToEvaluate,
+  IosSubmitProfileFieldsToEvaluate,
+  SubmitProfile,
+} from './types';
+
+export function resolveSubmitProfile<T extends Platform>({
+  easJson,
+  platform,
+  profileName,
+}: {
+  easJson: EasJson;
+  platform: T;
+  profileName: string;
+}): SubmitProfile<T> {
+  const submitProfile = resolveProfile({
+    easJson,
+    platform,
+    profileName,
+  });
+  const unevaluatedProfile = mergeProfiles(getDefaultProfile(platform), submitProfile);
+  return evaluateFields(platform, unevaluatedProfile);
+}
+
+function resolveProfile<T extends Platform>({
+  easJson,
+  profileName,
+  depth = 0,
+  platform,
+}: {
+  platform: T;
+  easJson: EasJson;
+  profileName: string;
+  depth?: number;
+}): SubmitProfile<T> | undefined {
+  if (depth >= 2) {
+    throw new Error(
+      'Too long chain of profile extensions, make sure "extends" keys do not make a cycle'
+    );
+  }
+
+  const profile = easJson.submit?.[profileName];
+  if (!profile) {
+    if (depth === 0) {
+      throw new MissingProfileError(`There is no submit profile named ${profileName} in eas.json`);
+    } else {
+      throw new MissingParentProfileError(
+        `Extending non-existent submit profile in eas.json: ${profileName}`
+      );
+    }
+  }
+
+  const { extends: baseProfileName, ...rest } = profile;
+  const platformProfile = rest[platform] as SubmitProfile<T> | undefined;
+  if (baseProfileName) {
+    const baseProfile = resolveProfile({
+      easJson,
+      platform,
+      profileName: baseProfileName,
+      depth: depth + 1,
+    });
+    return mergeProfiles(baseProfile, platformProfile);
+  } else {
+    return platformProfile;
+  }
+}
+
+function mergeProfiles<T extends Platform>(
+  base: SubmitProfile<T>,
+  update?: SubmitProfile<T>
+): SubmitProfile<T>;
+function mergeProfiles<T extends Platform>(
+  base?: SubmitProfile<T>,
+  update?: SubmitProfile<T>
+): SubmitProfile<T> | undefined;
+function mergeProfiles<T extends Platform>(
+  base?: SubmitProfile<T>,
+  update?: SubmitProfile<T>
+): SubmitProfile<T> | undefined {
+  if (!update) {
+    return base;
+  }
+  return { ...base, ...update };
+}
+
+export function getDefaultProfile<T extends Platform>(platform: T): SubmitProfile<T> {
+  const Schema =
+    platform === Platform.ANDROID ? AndroidSubmitProfileSchema : IosSubmitProfileSchema;
+  return Schema.validate({}, { allowUnknown: false, abortEarly: false, convert: true }).value;
+}
+
+function evaluateFields<T extends Platform>(
+  platform: T,
+  profile: SubmitProfile<T>
+): SubmitProfile<T> {
+  const fields =
+    platform === Platform.ANDROID
+      ? AndroidSubmitProfileFieldsToEvaluate
+      : IosSubmitProfileFieldsToEvaluate;
+  const evaluatedProfile = { ...profile };
+  for (const field of fields) {
+    if (field in evaluatedProfile) {
+      // @ts-ignore
+      evaluatedProfile[field] = envString(evaluatedProfile[field], process.env);
+    }
+  }
+  return evaluatedProfile;
+}

package/src/submit/schema.ts

@@ -0,0 +1,35 @@
+import Joi from 'joi';
+
+import { AndroidReleaseStatus, AndroidReleaseTrack } from './types';
+
+export const AndroidSubmitProfileSchema = Joi.object({
+  serviceAccountKeyPath: Joi.string(),
+  track: Joi.string()
+    .valid(...Object.values(AndroidReleaseTrack))
+    .default(AndroidReleaseTrack.internal),
+  releaseStatus: Joi.string()
+    .valid(...Object.values(AndroidReleaseStatus))
+    .default(AndroidReleaseStatus.completed),
+  changesNotSentForReview: Joi.boolean().default(false),
+  applicationId: Joi.string(),
+});
+
+export const IosSubmitProfileSchema = Joi.object({
+  ascApiKeyPath: Joi.string(),
+  ascApiKeyId: Joi.string(),
+  ascApiKeyIssuerId: Joi.string(),
+  appleId: Joi.string(),
+  ascAppId: Joi.string(),
+  appleTeamId: Joi.string(),
+  sku: Joi.string(),
+  language: Joi.string().default('en-US'),
+  companyName: Joi.string(),
+  appName: Joi.string(),
+  bundleIdentifier: Joi.string(),
+});
+
+export const SubmitProfileSchema = Joi.object({
+  extends: Joi.string(),
+  android: AndroidSubmitProfileSchema,
+  ios: IosSubmitProfileSchema,
+});

package/src/{EasSubmit.types.ts → submit/types.ts}

@@ -19,6 +19,7 @@ export interface AndroidSubmitProfile {
   track: AndroidReleaseTrack;
   releaseStatus: AndroidReleaseStatus;
   changesNotSentForReview: boolean;
+  applicationId?: string;
 }
 
 export const AndroidSubmitProfileFieldsToEvaluate: (keyof AndroidSubmitProfile)[] = [
@@ -36,6 +37,7 @@ export interface IosSubmitProfile {
   language: string;
   companyName?: string;
   appName?: string;
+  bundleIdentifier?: string;
 }
 
 export const IosSubmitProfileFieldsToEvaluate: (keyof IosSubmitProfile)[] = [
@@ -45,10 +47,10 @@ export const IosSubmitProfileFieldsToEvaluate: (keyof IosSubmitProfile)[] = [
 ];
 
 export type SubmitProfile<TPlatform extends Platform = Platform> =
-  TPlatform extends Platform.ANDROID
-    ? AndroidSubmitProfile
-    : TPlatform extends Platform.IOS
-    ? IosSubmitProfile
-    : TPlatform extends Platform
-    ? AndroidSubmitProfile | IosSubmitProfile
-    : never;
+  TPlatform extends Platform.ANDROID ? AndroidSubmitProfile : IosSubmitProfile;
+
+export interface EasJsonSubmitProfile {
+  extends?: string;
+  [Platform.ANDROID]?: AndroidSubmitProfile;
+  [Platform.IOS]?: IosSubmitProfile;
+}

package/src/types.ts

@@ -0,0 +1,21 @@
+import { EasJsonBuildProfile } from './build/types';
+import { EasJsonSubmitProfile } from './submit/types';
+
+export type ProfileType = 'build' | 'submit';
+export type EasJsonProfile<T extends ProfileType> = T extends 'build'
+  ? EasJsonBuildProfile
+  : EasJsonSubmitProfile;
+
+export enum CredentialsSource {
+  LOCAL = 'local',
+  REMOTE = 'remote',
+}
+
+export interface EasJson {
+  cli?: {
+    version?: string;
+    requireCommit?: boolean;
+  };
+  build?: { [profileName: string]: EasJsonBuildProfile };
+  submit?: { [profileName: string]: EasJsonSubmitProfile };
+}

package/build/EasJson.types.d.ts

@@ -1,29 +0,0 @@
-import { Platform } from '@expo/eas-build-job';
-import { AndroidBuildProfile, CommonBuildProfile, IosBuildProfile } from './EasBuild.types';
-import { AndroidSubmitProfile, IosSubmitProfile } from './EasSubmit.types';
-export declare enum CredentialsSource {
-    LOCAL = "local",
-    REMOTE = "remote"
-}
-export interface RawBuildProfile extends Partial<CommonBuildProfile> {
-    extends?: string;
-    [Platform.ANDROID]?: Partial<AndroidBuildProfile>;
-    [Platform.IOS]?: Partial<IosBuildProfile>;
-}
-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;
-    };
-    submit?: {
-        [profile: string]: EasSubmitConfiguration;
-    };
-}

package/build/EasJsonReader.d.ts

@@ -1,39 +0,0 @@
-import { Platform } from '@expo/eas-build-job';
-import { BuildProfile } from './EasBuild.types';
-import { CliConfig, EasJson, RawBuildProfile } from './EasJson.types';
-import { SubmitProfile } from './EasSubmit.types';
-interface EasJsonPreValidation {
-    cli?: object;
-    build: {
-        [profile: string]: object;
-    };
-    submit?: {
-        [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, profileNameArg?: string): Promise<SubmitProfile<T>>;
-    readAndValidateAsync(): Promise<EasJson>;
-    readRawAsync(): Promise<EasJsonPreValidation>;
-    private resolveBuildProfile;
-    private ensureBuildProfileExists;
-    private evaluateFields;
-}
-export declare function profileMerge(base: RawBuildProfile, update: RawBuildProfile): RawBuildProfile;
-export {};

package/build/EasJsonReader.js

@@ -1,204 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.profileMerge = exports.EasJsonReader = void 0;
-const tslib_1 = require("tslib");
-const eas_build_job_1 = require("@expo/eas-build-job");
-const json_file_1 = (0, tslib_1.__importDefault)(require("@expo/json-file"));
-const env_string_1 = (0, tslib_1.__importDefault)(require("env-string"));
-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,
-};
-class EasJsonReader {
-    constructor(projectDir) {
-        this.projectDir = projectDir;
-    }
-    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 {
-            const easJson = await this.readRawAsync();
-            return Object.keys((_a = easJson === null || easJson === void 0 ? void 0 : easJson.submit) !== null && _a !== void 0 ? _a : {});
-        }
-        catch (err) {
-            if (!throwIfEasJsonDoesNotExist && err.code === 'ENOENT') {
-                return [];
-            }
-            else {
-                throw err;
-            }
-        }
-    }
-    async readBuildProfileAsync(platform, profileName) {
-        const easJson = await this.readAndValidateAsync();
-        this.ensureBuildProfileExists(easJson, profileName);
-        const { android: resolvedAndroidSpecificValues, ios: resolvedIosSpecificValues, ...resolvedProfile } = this.resolveBuildProfile(easJson, profileName);
-        if (platform === eas_build_job_1.Platform.ANDROID) {
-            const profileWithoutDefaults = profileMerge(resolvedProfile, resolvedAndroidSpecificValues !== null && resolvedAndroidSpecificValues !== void 0 ? resolvedAndroidSpecificValues : {});
-            return profileMerge(defaults, profileWithoutDefaults);
-        }
-        else if (platform === eas_build_job_1.Platform.IOS) {
-            const profileWithoutDefaults = profileMerge(resolvedProfile, resolvedIosSpecificValues !== null && resolvedIosSpecificValues !== void 0 ? resolvedIosSpecificValues : {});
-            return profileMerge(defaults, profileWithoutDefaults);
-        }
-        else {
-            throw new Error(`Unknown platform ${platform}`);
-        }
-    }
-    async readSubmitProfileAsync(platform, profileNameArg) {
-        var _a;
-        let profileName = profileNameArg;
-        if (!profileName) {
-            const profileNames = await this.getSubmitProfileNamesAsync({
-                throwIfEasJsonDoesNotExist: false,
-            });
-            if (profileNames.includes('production')) {
-                profileName = 'production';
-            }
-            else if (profileNames.includes('release')) {
-                profileName = 'release';
-            }
-            else {
-                return getDefaultSubmitProfile(platform);
-            }
-        }
-        const easJson = await this.readAndValidateAsync();
-        const profile = (_a = easJson === null || easJson === void 0 ? void 0 : easJson.submit) === null || _a === void 0 ? void 0 : _a[profileName];
-        if (!profile) {
-            throw new Error(`There is no profile named ${profileName} in eas.json`);
-        }
-        const platformProfile = profile[platform];
-        if (platformProfile) {
-            return this.evaluateFields(platform, platformProfile);
-        }
-        else {
-            return getDefaultSubmitProfile(platform);
-        }
-    }
-    async readAndValidateAsync() {
-        const easJson = await this.readRawAsync();
-        const { value, error } = EasJsonSchema_1.EasJsonSchema.validate(easJson, {
-            allowUnknown: false,
-            convert: true,
-            abortEarly: false,
-        });
-        if (error) {
-            throw new errors_1.InvalidEasJsonError(`eas.json is not valid [${error.toString()}]`);
-        }
-        return value;
-    }
-    async readRawAsync() {
-        try {
-            const easJsonPath = EasJsonReader.formatEasJsonPath(this.projectDir);
-            const rawEasJson = json_file_1.default.read(easJsonPath);
-            const { value, error } = EasJsonSchema_1.MinimalEasJsonSchema.validate(rawEasJson, { abortEarly: false });
-            if (error) {
-                throw new errors_1.InvalidEasJsonError(`eas.json is not valid [${error.toString()}]`);
-            }
-            return value;
-        }
-        catch (err) {
-            if (err.code === 'EJSONPARSE') {
-                err.message = `Found invalid JSON in eas.json. ${err.message}`;
-            }
-            throw err;
-        }
-    }
-    resolveBuildProfile(easJson, profileName, depth = 0) {
-        if (depth >= 2) {
-            throw new Error('Too long chain of build profile extensions, make sure "extends" keys do not make a cycle');
-        }
-        const buildProfile = easJson.build[profileName];
-        if (!buildProfile) {
-            throw new Error(`There is no profile named ${profileName} in eas.json`);
-        }
-        const { extends: baseProfileName, ...buildProfileRest } = buildProfile;
-        if (baseProfileName) {
-            return profileMerge(this.resolveBuildProfile(easJson, baseProfileName, depth + 1), buildProfileRest);
-        }
-        else {
-            return buildProfileRest;
-        }
-    }
-    ensureBuildProfileExists(easJson, profileName) {
-        if (!easJson.build || !easJson.build[profileName]) {
-            throw new Error(`There is no profile named ${profileName} in eas.json`);
-        }
-    }
-    evaluateFields(platform, profile) {
-        const fields = platform === eas_build_job_1.Platform.ANDROID
-            ? EasSubmit_types_1.AndroidSubmitProfileFieldsToEvaluate
-            : EasSubmit_types_1.IosSubmitProfileFieldsToEvaluate;
-        const evaluatedProfile = { ...profile };
-        for (const field of fields) {
-            if (field in evaluatedProfile) {
-                // @ts-ignore
-                evaluatedProfile[field] = (0, env_string_1.default)(evaluatedProfile[field], process.env);
-            }
-        }
-        return evaluatedProfile;
-    }
-}
-exports.EasJsonReader = EasJsonReader;
-function profileMerge(base, update) {
-    const result = {
-        ...base,
-        ...update,
-    };
-    if (base.env && update.env) {
-        result.env = {
-            ...base.env,
-            ...update.env,
-        };
-    }
-    if (base.android && update.android) {
-        result.android = profileMerge(base.android, update.android);
-    }
-    if (base.ios && update.ios) {
-        result.ios = profileMerge(base.ios, update.ios);
-    }
-    return result;
-}
-exports.profileMerge = profileMerge;
-function getDefaultSubmitProfile(platform) {
-    const Schema = platform === eas_build_job_1.Platform.ANDROID ? EasJsonSchema_1.AndroidSubmitProfileSchema : EasJsonSchema_1.IosSubmitProfileSchema;
-    return Schema.validate({}, { convert: true }).value;
-}

package/build/EasJsonSchema.d.ts

@@ -1,6 +0,0 @@
-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/src/EasJson.types.ts

@@ -1,31 +0,0 @@
-import { Platform } from '@expo/eas-build-job';
-
-import { AndroidBuildProfile, CommonBuildProfile, IosBuildProfile } from './EasBuild.types';
-import { AndroidSubmitProfile, IosSubmitProfile } from './EasSubmit.types';
-
-export enum CredentialsSource {
-  LOCAL = 'local',
-  REMOTE = 'remote',
-}
-
-export interface RawBuildProfile extends Partial<CommonBuildProfile> {
-  extends?: string;
-  [Platform.ANDROID]?: Partial<AndroidBuildProfile>;
-  [Platform.IOS]?: Partial<IosBuildProfile>;
-}
-
-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 };
-  submit?: { [profile: string]: EasSubmitConfiguration };
-}