@junobuild/config 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +132 -0
  2. package/dist/types/mainnet/juno.config.d.ts +5 -1
  3. package/dist/types/mainnet/satellite.config.d.ts +6 -2
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -12,9 +12,109 @@ Configuration options for [Juno] CLI.
12
12
 
13
13
  <!-- TSDOC_START -->
14
14
 
15
+ ### :toolbox: Functions
16
+
17
+ - [defineDevConfig](#gear-definedevconfig)
18
+ - [defineDevConfig](#gear-definedevconfig)
19
+ - [defineDevConfig](#gear-definedevconfig)
20
+ - [defineDevConfig](#gear-definedevconfig)
21
+
22
+ #### :gear: defineDevConfig
23
+
24
+ | Function | Type |
25
+ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
26
+ | `defineDevConfig` | `{ (config: JunoDevConfig): JunoDevConfig; (config: JunoDevConfigFn): JunoDevConfigFn; (config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject; }` |
27
+
28
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/config.ts#L7)
29
+
30
+ #### :gear: defineDevConfig
31
+
32
+ | Function | Type |
33
+ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
34
+ | `defineDevConfig` | `{ (config: JunoDevConfig): JunoDevConfig; (config: JunoDevConfigFn): JunoDevConfigFn; (config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject; }` |
35
+
36
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/config.ts#L8)
37
+
38
+ #### :gear: defineDevConfig
39
+
40
+ | Function | Type |
41
+ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
42
+ | `defineDevConfig` | `{ (config: JunoDevConfig): JunoDevConfig; (config: JunoDevConfigFn): JunoDevConfigFn; (config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject; }` |
43
+
44
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/config.ts#L9)
45
+
46
+ #### :gear: defineDevConfig
47
+
48
+ | Function | Type |
49
+ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
50
+ | `defineDevConfig` | `{ (config: JunoDevConfig): JunoDevConfig; (config: JunoDevConfigFn): JunoDevConfigFn; (config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject; }` |
51
+
52
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/config.ts#L10)
53
+
54
+ ### :tropical_drink: Interfaces
55
+
56
+ - [JunoConfigEnv](#gear-junoconfigenv)
57
+ - [OrbiterConfig](#gear-orbiterconfig)
58
+ - [JunoConfig](#gear-junoconfig)
59
+ - [SatelliteDevCollections](#gear-satellitedevcollections)
60
+ - [SatelliteDevController](#gear-satellitedevcontroller)
61
+ - [SatelliteDevConfig](#gear-satellitedevconfig)
62
+ - [JunoDevConfig](#gear-junodevconfig)
63
+
64
+ #### :gear: JunoConfigEnv
65
+
66
+ | Property | Type | Description |
67
+ | -------- | -------- | ----------- |
68
+ | `mode` | `string` | |
69
+
70
+ #### :gear: OrbiterConfig
71
+
72
+ | Property | Type | Description |
73
+ | ----------- | -------- | ------------------------------------------------------------------------ |
74
+ | `id` | `string` | The identifier of the orbiter used in the dApp. |
75
+ | `orbiterId` | `string` | deprecated: `orbiterId` will be removed in the future. Use `id` instead. |
76
+
77
+ #### :gear: JunoConfig
78
+
79
+ | Property | Type | Description |
80
+ | ----------- | ----------------- | ----------- |
81
+ | `satellite` | `SatelliteConfig` | |
82
+ | `orbiter` | `OrbiterConfig` | |
83
+
84
+ #### :gear: SatelliteDevCollections
85
+
86
+ | Property | Type | Description |
87
+ | --------- | -------------------------- | ----------- |
88
+ | `db` | `SatelliteDevCollection[]` | |
89
+ | `storage` | `SatelliteDevCollection[]` | |
90
+
91
+ #### :gear: SatelliteDevController
92
+
93
+ | Property | Type | Description |
94
+ | -------- | -------------------- | ----------- |
95
+ | `id` | `string` | |
96
+ | `scope` | `"write" or "admin"` | |
97
+
98
+ #### :gear: SatelliteDevConfig
99
+
100
+ | Property | Type | Description |
101
+ | ------------- | -------------------------- | ----------- |
102
+ | `collections` | `SatelliteDevCollections` | |
103
+ | `controllers` | `SatelliteDevController[]` | |
104
+
105
+ #### :gear: JunoDevConfig
106
+
107
+ | Property | Type | Description |
108
+ | ----------- | -------------------- | ----------- |
109
+ | `satellite` | `SatelliteDevConfig` | |
110
+
15
111
  ### :cocktail: Types
16
112
 
17
113
  - [ENCODING_TYPE](#gear-encoding_type)
114
+ - [JunoConfigMode](#gear-junoconfigmode)
115
+ - [SatelliteDevCollection](#gear-satellitedevcollection)
116
+ - [JunoDevConfigFn](#gear-junodevconfigfn)
117
+ - [JunoDevConfigFnOrObject](#gear-junodevconfigfnorobject)
18
118
 
19
119
  #### :gear: ENCODING_TYPE
20
120
 
@@ -24,6 +124,38 @@ Configuration options for [Juno] CLI.
24
124
 
25
125
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/encoding.ts#L1)
26
126
 
127
+ #### :gear: JunoConfigMode
128
+
129
+ | Type | Type |
130
+ | ---------------- | ------------------------ |
131
+ | `JunoConfigMode` | `'production' or string` |
132
+
133
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/mainnet/juno.env.ts#L1)
134
+
135
+ #### :gear: SatelliteDevCollection
136
+
137
+ | Type | Type |
138
+ | ------------------------ | ------------------------------------------ |
139
+ | `SatelliteDevCollection` | `Omit<Rule, 'created_at' or 'updated_at'>` |
140
+
141
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/juno.dev.config.ts#L3)
142
+
143
+ #### :gear: JunoDevConfigFn
144
+
145
+ | Type | Type |
146
+ | ----------------- | --------------------- |
147
+ | `JunoDevConfigFn` | `() => JunoDevConfig` |
148
+
149
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/config.ts#L3)
150
+
151
+ #### :gear: JunoDevConfigFnOrObject
152
+
153
+ | Type | Type |
154
+ | ------------------------- | ---------------------------------- |
155
+ | `JunoDevConfigFnOrObject` | `JunoDevConfig or JunoDevConfigFn` |
156
+
157
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/config.ts#L5)
158
+
27
159
  <!-- TSDOC_END -->
28
160
 
29
161
  ## License
package/dist/types/mainnet/juno.config.d.ts CHANGED
@@ -3,7 +3,11 @@ export interface OrbiterConfig {
3
3
  /**
4
4
  * The identifier of the orbiter used in the dApp.
5
5
  */
6
- orbiterId: string;
6
+ id: string;
7
+ /**
8
+ * @deprecated `orbiterId` will be removed in the future. Use `id` instead.
9
+ */
10
+ orbiterId?: string;
7
11
  }
8
12
  export interface JunoConfig {
9
13
  satellite: SatelliteConfig;
package/dist/types/mainnet/satellite.config.d.ts CHANGED
@@ -17,7 +17,11 @@ export interface SatelliteId {
17
17
  /**
18
18
  * The unique identifier (ID) of the satellite for this application.
19
19
  */
20
- satelliteId: string;
20
+ id: string;
21
+ /**
22
+ * @deprecated `satelliteId` will be removed in the future. Use `id` instead.
23
+ */
24
+ satelliteId?: string;
21
25
  }
22
26
  export interface SatelliteIds {
23
27
  /**
@@ -31,7 +35,7 @@ export interface SatelliteIds {
31
35
  * "staging": "gl6nx-5maaa-aaaaa-qaaqq-cai"
32
36
  * }
33
37
  */
34
- satellitesIds: Record<JunoConfigMode, string>;
38
+ ids: Record<JunoConfigMode, string>;
35
39
  }
36
40
  export type SatelliteConfig = Either<SatelliteId, SatelliteIds> & {
37
41
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@junobuild/config",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "Configuration options for Juno CLI",
5
5
  "author": "David Dal Busco (https://daviddalbusco.com)",
6
6
  "license": "MIT",