kireji 0.7.3 → 0.8.2

package/src/type.d.ts

@@ -1,5 +1,6 @@
 declare interface IEcosystem
  extends IMix<null, ITopLevelDomainAny>,
+ IKirejiConfig,
  IWebComponent {
 
  // Subparts.
@@ -10,10 +11,6 @@ declare interface IEcosystem
  readonly parts: IParts
 
  // Serialized Properties.
- /** One of three strings representing the severity of the API change. Used to automatically compute the correct semantic version at build time. */
- readonly "change": "major" | "minor" | "patch"
- /** A number used to control the detail in logs. Only messages with a priority less than or equal to this number will be logged. */
- readonly "verbosity": number
  /** The git branch for the current build version. */
  readonly "branch": string
  /** Returns a packed version of the entire repo as a stand-alone script that boots the ecosystem. */
@@ -26,16 +23,12 @@ declare interface IEcosystem
  readonly "ETag": string
  /** The current unix timestamp, acquired using the high-precision performance.now() + performance.timeOrigin. */
  readonly "now": DOMHighResTimeStamp
- /** The host of the desired default app. The server will redirect to this when the user visits localhost at the designated port to test locally. */
- readonly "defaultApplicationHost": string
  /** A stylesheet containing CSS variables with `url()` values that correspond to images. Used to seamlessly hand-off image rendering from the server-rendered page to the client-rendered page without modifying the DOM. */
  readonly "images.css": string
  /** The current application's PWA manifest. */
  readonly "manifest.json": string
  /** A JSON object serializing the desired landing model of the ecosystem. */
  readonly "landing-model.json": string
- /** The internal port (typically between 3000 and 4000) where the server will be hosted for both the reverse proxy in production and when testing locally via `localhost`. */
- readonly "port": number
  /** Returns the given HTML document with images (using `early-*` compressed images for server- or worker-rendered snapshots) into the head as style tag(s). This is used for enhancing the first page appearance when using server-side rendering. When injecting early images, it scans the given document for image usages to determine which early images the snapshot requires. */
  readonly injectImages(HTML_DOCUMENT: string): string
  /** Handles standard anchor link clicks in one of four ways:
@@ -69,7 +62,104 @@ declare interface IEcosystem
  /** A boolean that is set to `true` as soon as the route ID is set for the first time. */
  readonly initialized: undefined | true
 }
+declare interface IKirejiConfig {
+ /** * Determines which color mode features will be included in the ecosystem. 
+  * - `none`: The color component will never be included.
+  * - `light`: Dark mode will never be included.
+  * - `dark`: Light mode will never be included.
+  * - `debug-dark`: Dark mode will only be included in local builds.
+  * - `debug-light`: Light mode will only be included in local builds.
+  * - `full`: The full color component will always be included.
+  * * @remarks When the menu and both colors are included, the color control will appear in the menu.
+  */
+ readonly "includeColor": "none" | "light" | "dark" | "debug-dark" | "debug-light" | "full";
 
+ /** * Determines which era mode features will be included in the ecosystem.
+  * - `none`: The era component will never be included.
+  * - `vintage`: Modern mode will never be included.
+  * - `modern`: Vintage mode will never be included.
+  * - `debug-modern`: Modern mode will only be included in local builds.
+  * - `debug-vintage`: Vintage mode will only be included in local builds.
+  * - `full`: The full era component will always be included.
+  * * @remarks When the menu and both eras are included, the era control will appear in the menu.
+  */
+ readonly "includeEra": "none" | "vintage" | "modern" | "debug-modern" | "debug-vintage" | "full";
+
+ /** * Determines whether a list of apps should be included in the menu.
+  * - `none`: Apps will never appear in the menu.
+  * - `local-only`: Apps will only appear in the menu in local builds.
+  * - `full`: Apps will always appear in the menu.
+  * * @remarks Has no effect on builds where the menu is not included or when there are no defined menu apps.
+  */
+ readonly "includeMenuApps": "none" | "local-only" | "full";
+
+ /** * Determines whether or not the version updating features should be included in the menu.
+  * - `none`: Update features will never appear in the menu.
+  * - `local-only`: Update features will only appear in the menu in local builds.
+  * - `full`: Update features will always appear in the menu.
+  * * @remarks Has no effect on builds where the menu is not included.
+  */
+ readonly "includeUpdates": "none" | "local-only" | "full";
+
+ /** * Determines whether or not the Kireji IDE should be included in the ecosystem.
+  * - `none`: kireji.app will never be included.
+  * - `full`: kireji.app will only be included in local builds.
+  * - `demo`: kireji.app will always be included (used only for Demo App Ecosystem).
+  */
+ readonly "includeKirejiApp": "none" | "full" | "demo";
+
+ /** * Determines whether or not the ecosystem should include desktop-like features.
+  * - `none`: The desktop experience will never be included.
+  * - `menu-only`: Only the menu will be included, and it will always be included.
+  * - `local-only`: The full desktop experience will only be included in local builds.
+  * - `full`: The menu will always be included. The desktop experience will only be included in local builds.
+  * - `demo`: The full desktop experience will always be included (used only for Demo App Ecosystem).
+  */
+ readonly "includeDesktop": "none" | "menu-only" | "local-only" | "full" | "demo";
+
+ /** * One of three strings representing the severity of the API change. 
+  * - `major`: A breaking change which breaks existing hash assignments.
+  * - `minor`: A non-breaking change which adds new hash assignments.
+  * - `patch`: A non-breaking change which does not impact hash assignments.
+  */
+ readonly "change": "major" | "minor" | "patch";
+
+ /** A number used to control the detail in logs. Only messages with a priority <= this number will be logged. */
+ readonly "verbosity": string;
+
+ /** The host of the desired default app. The server will redirect to this when testing locally. */
+ readonly "defaultApplicationHost": string;
+
+ /** The internal port (typically 3000-4000) where the server will be hosted. */
+ readonly "port": string;
+
+ /** * Determines whether or not the artifact should be output with embedded source map data. 
+  * - `0`: Disabled
+  * - `1`: Enabled
+  */
+ readonly "mapping": "disabled" | "enabled";
+
+ /** * If enabled, halts the hydration of the application completely. Useful for debugging FOUC. 
+  * - `0`: Disabled
+  * - `1`: Enabled
+  */
+ readonly "haltHydration": "disabled" | "enabled";
+
+ /** * If enabled, a warning line appears at the top of all applications regarding alpha status. 
+  * - `0`: Disabled
+  * - `1`: Enabled
+  */
+ readonly "includeWarning": "disabled" | "enabled";
+
+ /** * If enabled, applications running locally will reset to their landing hash when the service worker is replaced. 
+  * - `0`: Disabled
+  * - `1`: Enabled
+  */
+ readonly "resetLocalState": "disabled" | "enabled";
+
+ /** A string representing how long the main thread should hang to simulate loading. Useful for debugging FOUC. */
+ readonly "hangHydration": string;
+}
 /** This is the root part of the ecosystem, considered the ecosystem itself. @remarks When JSON stringified, it should inline all information compiled from the git repo in node by the build process. The serialized version should not include any values that are added during or after recursively hydrating the part tree. This means that all runtime values should be non-enumerable and defined using the `define()` method. */
 declare const _: IEcosystem
 /** A shorthand for document.querySelector */
@@ -283,7 +373,7 @@ declare function hydratePartsRecursive(part: string | IPartAny, domains: string[
 declare function resolveRelativeHost(relativeHost: string, base: string | string[]): string
 /** The immutable list of runtime instances for the root space, in order of when the were reached during recursive part hydration. */
 declare const instances: IPartAny[]
-/** The immutable list of every part in the root space, in order of when the were reached during recursive part hydration. */
+/** The immutable list of every part of the root space, in order of when the were reached during recursive part hydration. */
 declare const allParts: IPartAny[]
 /** The immutable list of every part host and filename combination, in order of when the were reached during recursive part hydration. */
 declare const allSubjects: [host: string, filename?: string]
@@ -322,4 +412,76 @@ declare class Vector {
 }
 
 declare type IVector = Record<string, number>
-declare type IVector2 = { x: number, y: number }
+declare type IVector2 = { x: number, y: number }
+
+declare type KirejiConfigColor =
+ /** The color component will never be included. */
+ | "none"
+ /** Dark mode will never be included. */
+ | "light"
+ /** Light mode will never be included. */
+ | "dark"
+ /** Dark mode will only be included in local builds. */
+ | "debug-dark"
+ /** Light mode will only be included in local builds. */
+ | "debug-light"
+ /** The full color component will always be included. */
+ | "full"
+
+declare type KirejiConfigEra =
+ /** The era component will never be included. */
+ | "none"
+ /** Modern mode will never be included. */
+ | "vintage"
+ /** Vintage mode will never be included. */
+ | "modern"
+ /**  Modern mode will only be included in local builds. */
+ | "debug-modern"
+ /** Vintage mode will only be included in local builds. */
+ | "debug-vintage"
+ /** The full era component will always be included. */
+ | "full"
+
+declare type KirejiConfigMenuApps =
+ /** Apps will never appear in the menu. */
+ | "none"
+ /** Apps will only appear in the menu in local builds. */
+ | "local-only"
+ /** Apps will always appear in the menu. */
+ | "full"
+
+declare type KirejiConfigUpdates =
+ /** Update features will never appear in the menu. */
+ | "none"
+ /** Update features will only appear in the menu in local builds. */
+ | "local-only"
+ /** Update features will always appear in the menu. */
+ | "full"
+
+declare type KirejiConfigKirejiApp =
+ /** kireji.app will never be included. */
+ | "none"
+ /** kireji.app will only be included in local builds. */
+ | "full"
+ /** kireji.app will always be included (used only for Demo App Ecosystem). */
+ | "demo"
+
+declare type KirejiConfigDesktop =
+ /** The desktop experience will never be included. */
+ | "none"
+ /** Only the menu will be included, and it will always be included. */
+ | "menu-only"
+ /** The full desktop experience will only be included in local builds. */
+ | "local-only"
+ /** The menu will always be included. The desktop experience will only be included in local builds. */
+ | "full"
+ /** The full desktop experience will always be included (used only for Demo App Ecosystem). */
+ | "demo"
+
+declare type KirejiConfigChange =
+ /** A breaking change which breaks existing hash assignments. */
+ | "major"
+ /** A non-breaking change which adds new hash assignments but doesn't break existing ones. */
+ | "minor"
+ /** A non-breaking change which does not impact hash assignments at all. */
+ | "patch"

package/src/validate.js

@@ -25,9 +25,9 @@ if (environment === "node-main") {
  })
  logScope(1, "\nSerialization Test", log => {
   const postHydrationArchive = serialize(_)
-  if (postHydrationArchive !== preHydrationArchive) {
-   warn(`The post-hydration archive was ${postHydrationArchive.length - preHydrationArchive.length} bytes longer than the pre-hydration archive.`)
-   const lines1 = preHydrationArchive.split('\n')
+  if (postHydrationArchive !== _.preHydrationArchive) {
+   warn(`The post-hydration archive was ${postHydrationArchive.length - _.preHydrationArchive.length} bytes longer than the pre-hydration archive.`)
+   const lines1 = _.preHydrationArchive.split('\n')
    const lines2 = postHydrationArchive.split('\n')
    const maxLength = Math.max(lines1.length, lines2.length)
    for (let i = 0; i < maxLength; i++) {

package/src/app/kireji/editor/tab-group/equation.html_.js

@@ -1,42 +0,0 @@
-return `<math>
- <mn>1</mn>
- <mo>+</mo>
- <munderover>
-  <mo>&#x2211;</mo>
-  <mrow>
-   <msub><mi>𝑛</mi><mi>tabs</mi></msub>
-   <mo>=</mo>
-   <mn>1</mn>
-  </mrow>
-  <mi>${allSubjects.length}</mi>
- </munderover>
- <mrow>
-  <mo>(</mo>
-  <msub><mi>𝑛</mi><mi>tabs</mi></msub>
-  <mo>+</mo>
-  <mn>1</mn>
-  <mo>)</mo>
-  <msub><mi>𝑛</mi><mi>tabs</mi></msub>
-  <mo>&#x00D7;</mo>
-  <munderover>
-   <mo>&#x220F;</mo>
-   <mrow>
-    <mi>i</mi>
-    <mo>=</mo>
-    <mn>1</mn>
-   </mrow>
-   <mrow>
-    <msub><mi>𝑛</mi><mi>tabs</mi></msub>
-   </mrow>
-  </munderover>
-  <mrow>
-   <mo>(</mo>
-   <mi>${allSubjects.length}</mi>
-   <mo>-</mo>
-   <mi>i</mi>
-   <mo>-</mo>
-   <mn>1</mn>
-   <mo>)</mo>
-  </mrow>
- </mrow>
-</math>`

package/src/parts/abstract/boolean/equation-variable.html

@@ -1 +0,0 @@
-<math><mi>𝑏</mi></math>

package/src/parts/abstract/box/build.js

@@ -1,24 +0,0 @@
-const { dimensions } = box
-
-if (!Array.isArray(dimensions) || dimensions.some(member => typeof member !== "bigint" && isNaN(member)))
- throw `The "dimensions" property of a box must be an array whose members are numeric.`
-
-const placeValues = []
-const placeStates = []
-const placeLimits = []
-
-let product = 1n
-
-for (const dimension of dimensions) {
- placeValues.push(product)
- placeStates.push(-1)
- placeLimits.push(dimension)
- product *= BigInt(dimension)
-}
-
-box.define({
- cardinality: { value: product },
- placeValues: { value: placeValues },
- placeStates: { value: placeStates },
- placeLimits: { value: placeLimits }
-})

package/src/parts/abstract/box/constants.js

@@ -1 +0,0 @@
-const box = this

package/src/parts/abstract/box/description-abstract

@@ -1 +0,0 @@
-This part provides a set of independent state variables just like the mix but the box keeps its factors self-contained instead of distributing them across subparts. The box is ideal for cartesian product spaces whose factors don't need to handle their own view updates or store any data beyond their cardinality.

package/src/parts/abstract/box/dimensions_.js

@@ -1 +0,0 @@
-return []

package/src/parts/abstract/box/equation.html_.js

@@ -1 +0,0 @@
-return `<math>${box.dimensions.map(dimension => `<mn>${dimension}</mn>`).join("<mo>&sdot;</mo>")}</math>`

package/src/parts/abstract/box/model_.js

@@ -1 +0,0 @@
-return [...box.placeStates]

package/src/parts/abstract/box/part.json

@@ -1,3 +0,0 @@
-{
- "abstract": true
-}

package/src/parts/abstract/box/routeID-distribute.js

@@ -1,7 +0,0 @@
-box.updateRouteID(ROUTE_ID)
-
-for (let i = box.placeValues.length - 1; i >= 0; i--) {
- const placeValue = box.placeValues[i]
- box.placeStates[i] = Number(ROUTE_ID / placeValue)
- ROUTE_ID %= placeValue
-}

package/src/parts/abstract/box/routeID-model-to.js

@@ -1,18 +0,0 @@
-if (!Array.isArray(MODEL))
- throw new TypeError(`Model To RouteID Error: Box "${box.host}" does not support computing a route ID from a model of type "${typeof MODEL}".`)
-
-if (MODEL.length !== box.placeValues.length)
- throw new RangeError(`Model To RouteID Error: Box "${box.host}" does not support computing a route ID from an array with a different length than the number of dimensions the box has.`)
-
-if (MODEL.some(member => isNaN(member)))
- throw new RangeError(`Model To RouteID Error: Box "${box.host}" does not support computing a route ID from an array with element(s) which are not numeric.`)
-
-const resultRouteID = box.placeValues.reduce((resultRouteID, placeValue, i) => resultRouteID + BigInt(placeValue) * BigInt(Math.max(Math.min(Math.round(MODEL[i]), box.placeLimits[i] - 1), 0)), 0n)
-
-if (resultRouteID >= part.cardinality)
- throw new RangeError(`Model To RouteID Error: Part "${part.host}" returned a route ID that was too large (${resultRouteID}) (max ${part.cardinality}).`)
-
-if (resultRouteID < 0n)
- throw new RangeError(`Model To RouteID Error: Part "${part.host}" returned a negative route ID.`)
-
-return resultRouteID

package/src/parts/abstract/box/title-abstract

@@ -1 +0,0 @@
-Box Prototype

package/src/parts/abstract/box/type.d.ts

@@ -1,20 +0,0 @@
-declare interface IBox<TOwner>
- extends IPart<TOwner, null> {
-
- // Serialized Properties.
- readonly "dimensions": [number]
- // Runtime Properties.
- /** The array of dimension multipliers, (the value of a unit for each of the defined dimensions) where the box is viewed as a fixed-length mixed-radix string.
-  * 
-  * Used to speed up computation. */
- readonly placeValues: bigint[]
- /** A cache of the individual dimension values as extracted from the box's overall route ID. */
- readonly placeStates: number[]
- /** A cache of the "dimensions" property, so that the array is not duplicated during arithmetic and so that the values are guaranteed to be bigints. */
- readonly placeLimits: number[]
-}
-
-declare type IBoxAny =
- IBox<IPartAny>
-
-declare const box: IBoxAny

package/src/parts/abstract/match/equation.html_.js

@@ -1,11 +0,0 @@
-return "<math>" + (
- match.length ? (
-  match.length > 4 ? (
-   `<mo>∑</mo><msub><mi>𝑘</mi><mi>𝑝</mi></msub><mtext>,</mtext><mspace width="0.5em"/><mi>𝑝</mi><mo>∈</mo><mi>subparts</mi><mo>(</mo><msub><mi>P</mi><mi>${part.key ?? "ecosystem"}</mi></msub><mo>)</mo>`
-  ) : (
-   match.map(arm => arm["equation-variable.html"]).join("<mo>+</mo>")
-  )
- ) : (
-  "<mn>1</mn>"
- )
-) + "</math>"

package/src/parts/abstract/mix/equation.html_.js

@@ -1,11 +0,0 @@
-return "<math>" + (
- mix.length ? (
-  mix.length > 4 ? (
-   `<mo>∏</mo><msub><mi>𝑘</mi><mi>𝑝</mi></msub><mtext>,</mtext><mspace width="0.5em"/><mi>𝑝</mi><mo>∈</mo><mi>subparts</mi><mo>(</mo><msub><mi>P</mi><mi>${part.key ?? "ecosystem"}</mi></msub><mo>)</mo>`
-  ) : (
-   mix.map(factor => factor["equation-variable.html"]).join("<mo>&sdot;</mo>")
-  )
- ) : (
-  "<mn>1</mn>"
- )
-) + "</math>"

package/src/parts/abstract/part/equation-variable.html_.js

@@ -1 +0,0 @@
-return `<math><msub><mi>𝑘</mi><mi>${part.key ?? "ecosystem"}</mi></msub></math>`

package/src/parts/abstract/part/equation.html_.js

@@ -1,3 +0,0 @@
-const cardinality = part.cardinality
-const cardinalityAsString = instances.includes(part) ? cardinality.toString() : null
-return cardinalityAsString.length < 16 ? `<math><mn>${cardinalityAsString}</mn></math>` : scientific(cardinality, true)

package/src/parts/abstract/part-mask/equation-variable.html_.js

@@ -1 +0,0 @@
-return `<math><msup><mn>2</mn><mn>${partMask.superset.length}</mn></msup></math>`

package/src/parts/abstract/part-mask/equation.html_.js

@@ -1 +0,0 @@
-return `<math>${partMask["equation-variable.html"]}</math>`

package/src/parts/abstract/permutation/equation.html_.js

@@ -1 +0,0 @@
-return `<math><mtext>TBD for ${permutation.maxInstanceCount} max instances.</mtext></math>`

package/src/parts/abstract/scroller/equation-variable.html

@@ -1 +0,0 @@
-<math><mi>𝑠</mi></math>

package/src/parts/abstract/scroller/equation.html

@@ -1 +0,0 @@
-<math><msup><mn>10</mn><mn>4</mn></msup></math>

package/src/parts/user/part.json

@@ -1,3 +0,0 @@
-{
- "extends": "coming-soon"
-}

package/src/parts/user/title

@@ -1 +0,0 @@
-User Parts

package/src/parts/user/type.d.ts

@@ -1,2 +0,0 @@
-declare type IUser
- = IErrorApplication<IParts>