@junobuild/config 0.0.1-next-2024-02-17

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 David Dal Busco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,222 @@
+[![npm][npm-badge]][npm-badge-url]
+[![license][npm-license]][npm-license-url]
+
+[npm-badge]: https://img.shields.io/npm/v/@junobuild/config
+[npm-badge-url]: https://www.npmjs.com/package/@junobuild/config
+[npm-license]: https://img.shields.io/npm/l/@junobuild/config
+[npm-license-url]: https://github.com/junobuild/juno-js/blob/main/LICENSE
+
+# Juno Config
+
+Configuration options for [Juno] CLI.
+
+<!-- TSDOC_START -->
+
+### :tropical_drink: Interfaces
+
+- [JunoConfigEnv](#gear-junoconfigenv)
+- [StorageConfigHeader](#gear-storageconfigheader)
+- [StorageConfigRewrite](#gear-storageconfigrewrite)
+- [StorageConfigRedirect](#gear-storageconfigredirect)
+- [StorageConfig](#gear-storageconfig)
+- [SatelliteAssertions](#gear-satelliteassertions)
+- [SatelliteId](#gear-satelliteid)
+- [SatelliteIds](#gear-satelliteids)
+- [OrbiterConfig](#gear-orbiterconfig)
+- [JunoConfig](#gear-junoconfig)
+
+#### :gear: JunoConfigEnv
+
+| Property | Type     | Description |
+| -------- | -------- | ----------- |
+| `mode`   | `string` |             |
+
+#### :gear: StorageConfigHeader
+
+Headers allow the client and the satellite to pass additional information along with a request or a response. Some sets of headers can affect how the browser handles the page and its content.
+
+| Property  | Type                 | Description                                                                                                                                                                                  |
+| --------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `source`  | `string`             | The glob pattern used to match files within the storage that these headers will apply to.                                                                                                    |
+| `headers` | `[string, string][]` | An array of key-value pairs representing the headers to apply. Each pair includes the header name and its value.Example: `[["Cache-Control", "max-age=3600"], ["X-Custom-Header", "value"]]` |
+
+#### :gear: StorageConfigRewrite
+
+You can utilize optional rewrites to display the same content for multiple URLs. Rewrites are especially useful when combined with pattern matching, allowing acceptance of any URL that matches the pattern.
+
+| Property      | Type     | Description                                                                                                           |
+| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
+| `source`      | `string` | The glob pattern or specific path to match for incoming requests. Matches are rewritten to the specified destination. |
+| `destination` | `string` | The destination path or file to which matching requests should be rewritten.                                          |
+
+#### :gear: StorageConfigRedirect
+
+Use a URL redirect to prevent broken links if you've moved a page or to shorten URLs.
+
+| Property   | Type         | Description                                                                                                   |
+| ---------- | ------------ | ------------------------------------------------------------------------------------------------------------- |
+| `source`   | `string`     | The glob pattern or specific path to match for incoming requests that should be redirected.                   |
+| `location` | `string`     | The URL or path to which the request should be redirected.                                                    |
+| `code`     | `301 or 302` | The HTTP status code to use for the redirect, typically 301 (permanent redirect) or 302 (temporary redirect). |
+
+#### :gear: StorageConfig
+
+Configures the Hosting behavior of the Storage.
+
+| Property    | Type                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                 |
+| ----------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `headers`   | `StorageConfigHeader[]`                  | Optional array of `StorageConfigHeader` objects to define custom HTTP headers for specific files or patterns.                                                                                                                                                                                                                                                                                               |
+| `rewrites`  | `StorageConfigRewrite[]`                 | Optional array of `StorageConfigRewrite` objects to define rewrite rules.                                                                                                                                                                                                                                                                                                                                   |
+| `redirects` | `StorageConfigRedirect[]`                | Optional array of `StorageConfigRedirect` objects to define HTTP redirects.                                                                                                                                                                                                                                                                                                                                 |
+| `iframe`    | `"deny" or "same-origin" or "allow-any"` | For security reasons and to prevent click-jacking attacks, dapps deployed with Juno are, by default, set to deny embedding in other sites.Options are:- `deny`: Prevents any content from being displayed in an iframe.- `same-origin`: Allows iframe content from the same origin as the page.- `allow-any`: Allows iframe content from any origin.If not specified, then `deny` is used as default value. |
+
+#### :gear: SatelliteAssertions
+
+| Property     | Type                | Description                                                                                                                                                                                                                                                                                                                   |
+| ------------ | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `heapMemory` | `number or boolean` | Configuration for the heap memory size check, which can be:- `true` to enable the check with a default threshold of 900MB,- `false` to disable the heap memory size check,- A `number` to specify a custom threshold in MB (megabytes) for the heap memory size check.If not specified, then `true` is used as default value. |
+
+#### :gear: SatelliteId
+
+| Property      | Type     | Description                                                       |
+| ------------- | -------- | ----------------------------------------------------------------- |
+| `satelliteId` | `string` | The unique identifier (ID) of the satellite for this application. |
+
+#### :gear: SatelliteIds
+
+| Property        | Type                     | Description                                                                                                                                                                                                                                                                                             |
+| --------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `satellitesIds` | `Record<string, string>` | A mapping of satellite identifiers (IDs) to different configurations based on the mode of the application.This allows the application to use different satellite IDs, such as production, staging, etc.Example:{ "production": "xo2hm-lqaaa-aaaal-ab3oa-cai", "staging": "gl6nx-5maaa-aaaaa-qaaqq-cai"} |
+
+#### :gear: OrbiterConfig
+
+| Property    | Type     | Description                                     |
+| ----------- | -------- | ----------------------------------------------- |
+| `orbiterId` | `string` | The identifier of the orbiter used in the dApp. |
+
+#### :gear: JunoConfig
+
+| Property    | Type              | Description |
+| ----------- | ----------------- | ----------- |
+| `satellite` | `SatelliteConfig` |             |
+| `orbiter`   | `OrbiterConfig`   |             |
+
+### :cocktail: Types
+
+- [ENCODING_TYPE](#gear-encoding_type)
+- [JunoConfigMode](#gear-junoconfigmode)
+- [StorageConfigSourceGlob](#gear-storageconfigsourceglob)
+- [Only](#gear-only)
+- [Either](#gear-either)
+- [SatelliteConfig](#gear-satelliteconfig)
+
+#### :gear: ENCODING_TYPE
+
+| Type            | Type                                                      |
+| --------------- | --------------------------------------------------------- |
+| `ENCODING_TYPE` | `'identity' or 'gzip' or 'compress' or 'deflate' or 'br'` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/encoding.ts#L1)
+
+#### :gear: JunoConfigMode
+
+| Type             | Type                                      |
+| ---------------- | ----------------------------------------- |
+| `JunoConfigMode` | `'production' or 'development' or string` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L1)
+
+#### :gear: StorageConfigSourceGlob
+
+Represents a glob pattern for matching files in the storage configuration.
+
+| Type                      | Type |
+| ------------------------- | ---- |
+| `StorageConfigSourceGlob` |      |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/storage.config.ts#L4)
+
+#### :gear: Only
+
+| Type   | Type |
+| ------ | ---- |
+| `Only` | `{   |
+
+[P in keyof T]: T[P];
+} and {
+[P in keyof U]?: never;
+}` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/utility.ts#L2)
+
+#### :gear: Either
+
+| Type     | Type                       |
+| -------- | -------------------------- |
+| `Either` | `Only<T, U> or Only<U, T>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/utility.ts#L8)
+
+#### :gear: SatelliteConfig
+
+| Type              | Type                                     |
+| ----------------- | ---------------------------------------- |
+| `SatelliteConfig` | `Either<SatelliteId, SatelliteIds> and { |
+
+/\*\*
+
+- Specifies the directory from which to deploy to storage.
+- For instance, if `npm run build` outputs files to a `dist` folder, use `source: 'dist'`.
+-
+- @default `build`
+  \*/
+  source?: string;
+
+/\*\*
+
+- Optional configuration parameters for the satellite, affecting the operational behavior of its Storage.
+- Changes to these parameters must be applied manually afterwards using `juno config` commands.
+  \*/
+  storage?: StorageConfig;
+
+/\*\*
+
+- Specifies files or patterns to ignore during deployment, using glob patterns similar to those in .gitignore.
+  \*/
+  ignore?: string[];
+
+/\*\*
+
+- Controls the Gzip compression optimization for files in the source folder. By default, it targets JavaScript (js), ES Module (mjs), and CSS (css) files.
+- You can disable this by setting it to `false` or customize it with a different file matching pattern using glob syntax.
+  \*/
+  gzip?: string or false;
+
+/\*\*
+
+- Customizes file encoding mapping for HTTP response headers `Content-Encoding` based on file extension:
+- - `.Z` for compress,
+- - `.gz` for gzip,
+- - `.br` for brotli,
+- - `.zlib` for deflate,
+- - anything else defaults to `identity`.
+- The "encoding" attribute allows overriding default mappings with an array of glob patterns and encoding types.
+  \*/
+  encoding?: Array<[string, ENCODING_TYPE]>;
+
+/\*\*
+
+- Optional configurations to override default assertions made by the CLI regarding satellite deployment conditions.
+  \*/
+  assertions?: SatelliteAssertions;
+  }` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/satellite.config.ts#L40)
+
+<!-- TSDOC_END -->
+
+## License
+
+MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com)
+
+[juno]: https://juno.build

package/dist/browser/index.js

@@ -0,0 +1,2 @@
+function o(n){return n}export{o as defineConfig};
+//# sourceMappingURL=index.js.map

package/dist/browser/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.ts"],
+  "sourcesContent": ["export type * from './types/encoding';\nexport type * from './types/juno.config';\nexport type * from './types/juno.env';\nexport type * from './types/satellite.config';\nexport type * from './types/storage.config';\nexport type * from './types/utility';\n\n/// Export and expose functions for user configuration\n\nimport type {JunoConfig} from './types/juno.config';\nimport type {JunoConfigEnv} from './types/juno.env';\n\nexport type JunoConfigFn = (config: JunoConfigEnv) => JunoConfig;\n\nexport type JunoConfigFnOrObject = JunoConfig | JunoConfigFn;\n\nexport function defineConfig(config: JunoConfig): JunoConfig;\nexport function defineConfig(config: JunoConfigFn): JunoConfigFn;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject {\n  return config;\n}\n"],
+  "mappings": "AAmBO,SAASA,EAAaC,EAAoD,CAC/E,OAAOA,CACT",
+  "names": ["defineConfig", "config"]
+}

package/dist/index.js

@@ -0,0 +1 @@
+export * from './browser/index.js';

package/dist/node/index.mjs

@@ -0,0 +1,4 @@
+import { createRequire as topLevelCreateRequire } from 'module';
+ const require = topLevelCreateRequire(import.meta.url);
+function o(n){return n}export{o as defineConfig};
+//# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.ts"],
+  "sourcesContent": ["export type * from './types/encoding';\nexport type * from './types/juno.config';\nexport type * from './types/juno.env';\nexport type * from './types/satellite.config';\nexport type * from './types/storage.config';\nexport type * from './types/utility';\n\n/// Export and expose functions for user configuration\n\nimport type {JunoConfig} from './types/juno.config';\nimport type {JunoConfigEnv} from './types/juno.env';\n\nexport type JunoConfigFn = (config: JunoConfigEnv) => JunoConfig;\n\nexport type JunoConfigFnOrObject = JunoConfig | JunoConfigFn;\n\nexport function defineConfig(config: JunoConfig): JunoConfig;\nexport function defineConfig(config: JunoConfigFn): JunoConfigFn;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject {\n  return config;\n}\n"],
+  "mappings": ";;AAmBO,SAASA,EAAaC,EAAoD,CAC/E,OAAOA,CACT",
+  "names": ["defineConfig", "config"]
+}

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+export type * from './types/encoding';
+export type * from './types/juno.config';
+export type * from './types/juno.env';
+export type * from './types/satellite.config';
+export type * from './types/storage.config';
+export type * from './types/utility';
+import type { JunoConfig } from './types/juno.config';
+import type { JunoConfigEnv } from './types/juno.env';
+export type JunoConfigFn = (config: JunoConfigEnv) => JunoConfig;
+export type JunoConfigFnOrObject = JunoConfig | JunoConfigFn;
+export declare function defineConfig(config: JunoConfig): JunoConfig;
+export declare function defineConfig(config: JunoConfigFn): JunoConfigFn;
+export declare function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject;

package/dist/types/types/encoding.d.ts

@@ -0,0 +1 @@
+export type ENCODING_TYPE = 'identity' | 'gzip' | 'compress' | 'deflate' | 'br';

package/dist/types/types/juno.config.d.ts

@@ -0,0 +1,11 @@
+import type { SatelliteConfig } from './satellite.config';
+export interface OrbiterConfig {
+    /**
+     * The identifier of the orbiter used in the dApp.
+     */
+    orbiterId: string;
+}
+export interface JunoConfig {
+    satellite: SatelliteConfig;
+    orbiter?: OrbiterConfig;
+}

package/dist/types/types/juno.env.d.ts

@@ -0,0 +1,4 @@
+export type JunoConfigMode = 'production' | 'development' | string;
+export interface JunoConfigEnv {
+    mode: JunoConfigMode;
+}

package/dist/types/types/satellite.config.d.ts

@@ -0,0 +1,72 @@
+import type { ENCODING_TYPE } from './encoding';
+import type { JunoConfigMode } from './juno.env';
+import type { StorageConfig } from './storage.config';
+import type { Either } from './utility';
+export interface SatelliteAssertions {
+    /**
+     * Configuration for the heap memory size check, which can be:
+     * - `true` to enable the check with a default threshold of 900MB,
+     * - `false` to disable the heap memory size check,
+     * - A `number` to specify a custom threshold in MB (megabytes) for the heap memory size check.
+     *
+     * If not specified, then `true` is used as default value.
+     */
+    heapMemory?: number | boolean;
+}
+export interface SatelliteId {
+    /**
+     * The unique identifier (ID) of the satellite for this application.
+     */
+    satelliteId: string;
+}
+export interface SatelliteIds {
+    /**
+     * A mapping of satellite identifiers (IDs) to different configurations based on the mode of the application.
+     *
+     * This allows the application to use different satellite IDs, such as production, staging, etc.
+     *
+     * Example:
+     * {
+     *   "production": "xo2hm-lqaaa-aaaal-ab3oa-cai",
+     *   "staging": "gl6nx-5maaa-aaaaa-qaaqq-cai"
+     * }
+     */
+    satellitesIds: Record<JunoConfigMode, string>;
+}
+export type SatelliteConfig = Either<SatelliteId, SatelliteIds> & {
+    /**
+     * Specifies the directory from which to deploy to storage.
+     * For instance, if `npm run build` outputs files to a `dist` folder, use `source: 'dist'`.
+     *
+     * @default `build`
+     */
+    source?: string;
+    /**
+     * Optional configuration parameters for the satellite, affecting the operational behavior of its Storage.
+     * Changes to these parameters must be applied manually afterwards using `juno config` commands.
+     */
+    storage?: StorageConfig;
+    /**
+     * Specifies files or patterns to ignore during deployment, using glob patterns similar to those in .gitignore.
+     */
+    ignore?: string[];
+    /**
+     * Controls the Gzip compression optimization for files in the source folder. By default, it targets JavaScript (js), ES Module (mjs), and CSS (css) files.
+     * You can disable this by setting it to `false` or customize it with a different file matching pattern using glob syntax.
+     */
+    gzip?: string | false;
+    /**
+     * Customizes file encoding mapping for HTTP response headers `Content-Encoding` based on file extension:
+     * - `.Z` for compress,
+     * - `.gz` for gzip,
+     * - `.br` for brotli,
+     * - `.zlib` for deflate,
+     * - anything else defaults to `identity`.
+     * The "encoding" attribute allows overriding default mappings with an array of glob patterns and encoding types.
+     */
+    encoding?: Array<[string, ENCODING_TYPE]>;
+    /**
+     * Optional configurations to override default assertions made by the CLI regarding satellite deployment conditions.
+     */
+    assertions?: SatelliteAssertions;
+};

package/dist/types/types/storage.config.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Represents a glob pattern for matching files in the storage configuration.
+ */
+export type StorageConfigSourceGlob = string;
+/**
+ * Headers allow the client and the satellite to pass additional information along with a request or a response. Some sets of headers can affect how the browser handles the page and its content.
+ */
+export interface StorageConfigHeader {
+    /**
+     * The glob pattern used to match files within the storage that these headers will apply to.
+     */
+    source: StorageConfigSourceGlob;
+    /**
+     * An array of key-value pairs representing the headers to apply. Each pair includes the header name and its value.
+     * Example: `[["Cache-Control", "max-age=3600"], ["X-Custom-Header", "value"]]`
+     */
+    headers: [string, string][];
+}
+/**
+ * You can utilize optional rewrites to display the same content for multiple URLs. Rewrites are especially useful when combined with pattern matching, allowing acceptance of any URL that matches the pattern.
+ */
+export interface StorageConfigRewrite {
+    /**
+     * The glob pattern or specific path to match for incoming requests. Matches are rewritten to the specified destination.
+     */
+    source: StorageConfigSourceGlob;
+    /**
+     * The destination path or file to which matching requests should be rewritten.
+     */
+    destination: string;
+}
+/**
+ * Use a URL redirect to prevent broken links if you've moved a page or to shorten URLs.
+ */
+export interface StorageConfigRedirect {
+    /**
+     * The glob pattern or specific path to match for incoming requests that should be redirected.
+     */
+    source: StorageConfigSourceGlob;
+    /**
+     * The URL or path to which the request should be redirected.
+     */
+    location: string;
+    /**
+     * The HTTP status code to use for the redirect, typically 301 (permanent redirect) or 302 (temporary redirect).
+     */
+    code: 301 | 302;
+}
+/**
+ * Configures the Hosting behavior of the Storage.
+ */
+export interface StorageConfig {
+    /**
+     * Optional array of `StorageConfigHeader` objects to define custom HTTP headers for specific files or patterns.
+     */
+    headers?: StorageConfigHeader[];
+    /**
+     * Optional array of `StorageConfigRewrite` objects to define rewrite rules.
+     */
+    rewrites?: StorageConfigRewrite[];
+    /**
+     * Optional array of `StorageConfigRedirect` objects to define HTTP redirects.
+     */
+    redirects?: StorageConfigRedirect[];
+    /**
+     * For security reasons and to prevent click-jacking attacks, dapps deployed with Juno are, by default, set to deny embedding in other sites.
+     *
+     * Options are:
+     * - `deny`: Prevents any content from being displayed in an iframe.
+     * - `same-origin`: Allows iframe content from the same origin as the page.
+     * - `allow-any`: Allows iframe content from any origin.
+     *
+     * If not specified, then `deny` is used as default value.
+     */
+    iframe?: 'deny' | 'same-origin' | 'allow-any';
+}

package/dist/types/types/utility.d.ts

@@ -0,0 +1,6 @@
+export type Only<T, U> = {
+    [P in keyof T]: T[P];
+} & {
+    [P in keyof U]?: never;
+};
+export type Either<T, U> = Only<T, U> | Only<U, T>;

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@junobuild/config",
+  "version": "0.0.1-next-2024-02-17",
+  "description": "Configuration options for Juno CLI",
+  "author": "David Dal Busco (https://daviddalbusco.com)",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/node/index.mjs",
+  "module": "./dist/browser/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/browser/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/node/index.mjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "rmdir": "node ../../scripts/rmdir.mjs",
+    "ts-declaration": "tsc --emitDeclarationOnly --outDir dist/types",
+    "build": "npm run rmdir && mkdir -p dist && node esbuild.mjs && npm run ts-declaration",
+    "prepack": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/junobuild/juno-js.git",
+    "directory": "packages/config"
+  },
+  "bugs": {
+    "url": "https://github.com/junobuild/juno-js"
+  },
+  "homepage": "https://juno.build"
+}