feat: deprecated satelliteId for id and replace satellitesIds with ids (

#105)
junobuild · Feb 29, 2024 · 25e5758 · 25e5758
1 parent 318cdb8
commit 25e5758
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 34 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,8 +31,8 @@
     "@dfinity/identity": "^1.0.1",
     "@dfinity/principal": "^1.0.1",
     "@junobuild/admin": "^0.0.46",
-    "@junobuild/cli-tools": "^0.0.3",
-    "@junobuild/config": "^0.0.2",
+    "@junobuild/cli-tools": "^0.0.5",
+    "@junobuild/config": "^0.0.4",
     "@junobuild/core-peer": "^0.0.11",
     "@junobuild/utils": "^0.0.19",
     "conf": "^12.0.0",

diff --git a/src/commands/init.ts b/src/commands/init.ts
@@ -42,8 +42,8 @@ const initConfig = async () => {
 
   await writeJunoConfig({
     config: {
-      satellite: {satelliteId, source},
-      ...(nonNullish(orbiterId) && {orbiter: {orbiterId}})
+      satellite: {id: satelliteId, source},
+      ...(nonNullish(orbiterId) && {orbiter: {id: orbiterId}})
     },
     configType
   });

diff --git a/src/configs/juno.config.ts b/src/configs/juno.config.ts
@@ -37,7 +37,7 @@ export const writeJunoConfig = async ({
     case 'js': {
       const {
         orbiter,
-        satellite: {satelliteId, source}
+        satellite: {id, source}
       } = config;
 
       const template = await readTemplateFile({
@@ -48,9 +48,9 @@ export const writeJunoConfig = async ({
       });
 
       const content = template
-        .replace('<SATELLITE_ID>', satelliteId)
+        .replace('<SATELLITE_ID>', id)
         .replace('<SOURCE>', source ?? DEPLOY_DEFAULT_SOURCE)
-        .replace('<ORBITER_ID>', orbiter?.orbiterId ?? '');
+        .replace('<ORBITER_ID>', orbiter?.id ?? '');
 
       await writeFile(`${JUNO_CONFIG_FILENAME}.${configType}`, content, 'utf-8');
       break;

diff --git a/src/types/config.ts b/src/types/config.ts
@@ -1,4 +1,4 @@
-import type {JunoConfig, JunoConfigEnv, SatelliteConfig} from '@junobuild/config';
+import type {JunoConfig, JunoConfigEnv, OrbiterConfig, SatelliteConfig} from '@junobuild/config';
 
 export type ConfigType = 'ts' | 'js' | 'json';
 
@@ -7,7 +7,7 @@ export interface SatelliteConfigEnv {
   env: JunoConfigEnv;
 }
 
-export type JunoConfigWithSatelliteId = Omit<JunoConfig, 'satellite'> & {
-  satellite: Omit<SatelliteConfig, 'satelliteId' | 'satellitesIds'> &
-    Required<Pick<SatelliteConfig, 'satelliteId'>>;
+export type JunoConfigWithSatelliteId = Omit<JunoConfig, 'satellite' | 'orbiter'> & {
+  satellite: Omit<SatelliteConfig, 'id' | 'satellitesIds'> & Required<Pick<SatelliteConfig, 'id'>>;
+  orbiter?: Omit<OrbiterConfig, 'orbiterId'>;
 };
diff --git a/src/utils/satellite.utils.ts b/src/utils/satellite.utils.ts
@@ -6,11 +6,11 @@ import type {SatelliteConfigEnv} from '../types/config';
 import {actorParameters} from './actor.utils';
 
 export const satelliteParameters = ({
-  satellite: {satelliteId: satelliteIdUser, satellitesIds},
+  satellite: {satelliteId: deprecatedSatelliteId, id, ids},
   env: {mode}
 }: SatelliteConfigEnv): Omit<SatelliteParameters, 'satelliteId'> &
   Required<Pick<SatelliteParameters, 'satelliteId'>> => {
-  const satelliteId = satellitesIds?.[mode] ?? satelliteIdUser;
+  const satelliteId = ids?.[mode] ?? id ?? deprecatedSatelliteId;
 
   if (isNullish(satelliteId)) {
     console.log(`${red(`A satellite ID for ${mode} must be set in your configuration.`)}`);

diff --git a/templates/init/juno.config.js b/templates/init/juno.config.js
@@ -3,10 +3,10 @@ import {defineConfig} from '@junobuild/config';
 /** @type {import('@junobuild/config').JunoConfig} */
 export default defineConfig({
   satellite: {
-    satelliteId: '<SATELLITE_ID>',
+    id: '<SATELLITE_ID>',
     source: '<SOURCE>'
   },
   orbiter: {
-    orbiterId: '<ORBITER_ID>'
+    id: '<ORBITER_ID>'
   }
 });
diff --git a/templates/init/juno.config.ts b/templates/init/juno.config.ts
@@ -2,10 +2,10 @@ import {defineConfig} from '@junobuild/config';
 
 export default defineConfig({
   satellite: {
-    satelliteId: '<SATELLITE_ID>',
+    id: '<SATELLITE_ID>',
     source: '<SOURCE>'
   },
   orbiter: {
-    orbiterId: '<ORBITER_ID>'
+    id: '<ORBITER_ID>'
   }
 });
diff --git a/templates/init/juno.satellite.config.js b/templates/init/juno.satellite.config.js
@@ -3,7 +3,7 @@ import {defineConfig} from '@junobuild/config';
 /** @type {import('@junobuild/config').JunoConfig} */
 export default defineConfig({
   satellite: {
-    satelliteId: '<SATELLITE_ID>',
+    id: '<SATELLITE_ID>',
     source: '<SOURCE>'
   }
 });
diff --git a/templates/init/juno.satellite.config.ts b/templates/init/juno.satellite.config.ts
@@ -2,7 +2,7 @@ import {defineConfig} from '@junobuild/config';
 
 export default defineConfig({
   satellite: {
-    satelliteId: '<SATELLITE_ID>',
+    id: '<SATELLITE_ID>',
     source: '<SOURCE>'
   }
 });