@toa.io/extensions.configuration 1.0.0-alpha.283 → 1.0.0-alpha.286

package/components/configuration.values/manifest.toa.yaml

@@ -8,27 +8,20 @@ name: values
 # prototype's `created` event.
 
 entity:
-  schema:
-    type: object
-    properties:
-      component:
-        type: string
-      epoch:
-        type: string
-      configuration:
-        type: object
-      originator:
-        type: string
-    required:
-      - component
-      - epoch
-      - configuration
-      - originator
-  index:
-    lookup:
-      component: asc
-      epoch: asc
-      _created: desc
+  properties:
+    component:
+      type: string
+    epoch:
+      type: string
+    configuration:
+      type: object
+    originator:
+      type: string
+  required:
+    - component
+    - epoch
+    - configuration
+    - originator
 
 operations:
   # the latest configuration of a component: created, else deployed defaults, else none

package/components/configuration.values/migrations/0001-system-properties.yaml

@@ -0,0 +1,14 @@
+# 1.0.0-alpha.286 renamed the four system properties of a record. A database written before it
+# holds them under the old names, where nothing reads them: such a record is never created,
+# never updated, never deleted, and at version zero.
+#
+# `$rename` leaves a record that has none of them alone, so this is a no-op for a component
+# that has only ever run this release.
+- update:
+    filter: {}
+    update:
+      $rename:
+        _version: VERSION
+        _created: CREATED
+        _updated: UPDATED
+        _deleted: DELETED

package/components/configuration.values/migrations/0002-indexes.yaml

@@ -0,0 +1,7 @@
+- index:
+    name: index_lookup
+    keys:
+      component: asc
+      epoch: asc
+      CREATED: desc
+    sparse: true

package/components/configuration.values/operations/create.js

@@ -4,7 +4,6 @@ export async function transition(input, object) {
     const known = entry(input.component);
     if (known === undefined)
         return new UnknownComponentError(input.component);
-    // the schema fills its defaults, so what is stored is whole
     const configuration = structuredClone(input.configuration);
     const schema = schemas.schema(known.schema);
     try {
@@ -28,4 +27,4 @@ class UnknownComponentError extends Error {
 class InvalidConfigurationError extends Error {
     code = 'INVALID_CONFIGURATION';
 }
-//# sourceMappingURL=create.js.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3JlYXRlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc291cmNlL2NyZWF0ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGlCQUFpQixDQUFBO0FBQzFDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxjQUFjLENBQUE7QUFHcEMsTUFBTSxDQUFDLEtBQUssVUFBVSxVQUFVLENBQUMsS0FBWSxFQUFFLE1BQWM7SUFDM0QsTUFBTSxLQUFLLEdBQUcsS0FBSyxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUVwQyxJQUFJLEtBQUssS0FBSyxTQUFTO1FBQUUsT0FBTyxJQUFJLHFCQUFxQixDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUUxRSxNQUFNLGFBQWEsR0FBRyxlQUFlLENBQUMsS0FBSyxDQUFDLGFBQWEsQ0FBQyxDQUFBO0lBRTFELE1BQU0sTUFBTSxHQUFnQixPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQTtJQUV4RCxJQUFJLENBQUM7UUFDSCxNQUFNLENBQUMsUUFBUSxDQUFDLGFBQWEsQ0FBQyxDQUFBO0lBQ2hDLENBQUM7SUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1FBQ2YsT0FBTyxJQUFJLHlCQUF5QixDQUFFLEtBQWUsQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUNoRSxDQUFDO0lBRUQsTUFBTSxDQUFDLFNBQVMsR0FBRyxLQUFLLENBQUMsU0FBUyxDQUFBO0lBQ2xDLE1BQU0sQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFDLEtBQUssQ0FBQTtJQUMxQixNQUFNLENBQUMsYUFBYSxHQUFHLGFBQWEsQ0FBQTtJQUNwQyxNQUFNLENBQUMsVUFBVSxHQUFHLEtBQUssQ0FBQyxVQUFVLENBQUMsRUFBRSxDQUFBO0lBRXZDLE9BQU8sTUFBTSxDQUFBO0FBQ2YsQ0FBQztBQUVELE1BQU0scUJBQXNCLFNBQVEsS0FBSztJQUN2QixJQUFJLEdBQUcsbUJBQW1CLENBQUE7SUFFMUMsWUFBbUIsU0FBaUI7UUFDbEMsS0FBSyxDQUFDLGNBQWMsU0FBUyxxQkFBcUIsQ0FBQyxDQUFBO0lBQ3JELENBQUM7Q0FDRjtBQUVELE1BQU0seUJBQTBCLFNBQVEsS0FBSztJQUMzQixJQUFJLEdBQUcsdUJBQXVCLENBQUE7Q0FDL0MifQ==

package/components/configuration.values/operations/fetch.js

@@ -10,4 +10,4 @@ export async function computation(input, context) {
         };
     }));
 }
-//# sourceMappingURL=fetch.js.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmV0Y2guanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zb3VyY2UvZmV0Y2gudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLE9BQU8sRUFBZ0IsTUFBTSxrQkFBa0IsQ0FBQTtBQUV4RCxNQUFNLENBQUMsS0FBSyxVQUFVLFdBQVcsQ0FBQyxLQUFhLEVBQUUsT0FBZ0I7SUFDL0QsT0FBTyxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQ3RCLEtBQUssQ0FBQyxHQUFHLENBQUMsS0FBSyxFQUFFLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxFQUFFLEVBQUU7UUFDdkMsTUFBTSxLQUFLLEdBQUcsTUFBTSxPQUFPLENBQUMsT0FBTyxFQUFFLFNBQVMsRUFBRSxLQUFLLENBQUMsQ0FBQTtRQUV0RCxPQUFPO1lBQ0wsU0FBUztZQUNULEtBQUs7WUFDTCxhQUFhLEVBQUUsS0FBSyxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsYUFBYTtZQUMxRCxPQUFPLEVBQUUsS0FBSyxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTztTQUM1QyxDQUFBO0lBQ0gsQ0FBQyxDQUFDLENBQ0gsQ0FBQTtBQUNILENBQUMifQ==

package/components/configuration.values/operations/get.js

@@ -16,4 +16,4 @@ export async function computation(input, context) {
         epoch: input.epoch ?? known.epoch
     };
 }
-//# sourceMappingURL=get.js.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2V0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc291cmNlL2dldC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsS0FBSyxFQUFFLE1BQU0sY0FBYyxDQUFBO0FBQ3BDLE9BQU8sRUFBRSxPQUFPLEVBQWdCLE1BQU0sa0JBQWtCLENBQUE7QUFFeEQ7Ozs7R0FJRztBQUNILE1BQU0sQ0FBQyxLQUFLLFVBQVUsV0FBVyxDQUFDLEtBQVksRUFBRSxPQUFnQjtJQUM5RCxNQUFNLEtBQUssR0FBRyxNQUFNLE9BQU8sQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLFNBQVMsRUFBRSxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUE7SUFFbEUsSUFBSSxLQUFLLEtBQUssSUFBSTtRQUFFLE9BQU8sSUFBSSxDQUFBO0lBRS9CLE1BQU0sS0FBSyxHQUFHLEtBQUssQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUE7SUFFcEMsT0FBTztRQUNMLGFBQWEsRUFBRSxLQUFLLENBQUMsYUFBYTtRQUNsQyxNQUFNLEVBQUUsS0FBSyxFQUFFLE1BQU07UUFDckIsS0FBSyxFQUFFLEtBQUssQ0FBQyxLQUFLLElBQUksS0FBTSxDQUFDLEtBQUs7S0FDbkMsQ0FBQTtBQUNILENBQUMifQ==

package/components/configuration.values/operations/lib/map.js

@@ -18,4 +18,4 @@ function read() {
 let parsed = null;
 let values = {};
 export const VARIABLE = 'TOA_CONFIGURATION_VALUES';
-//# sourceMappingURL=map.js.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc291cmNlL2xpYi9tYXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsNkVBQTZFO0FBQzdFLE1BQU0sVUFBVSxLQUFLLENBQUMsU0FBaUI7SUFDckMsT0FBTyxJQUFJLEVBQUUsQ0FBQyxTQUFTLENBQUMsQ0FBQTtBQUMxQixDQUFDO0FBRUQsMENBQTBDO0FBQzFDLE1BQU0sVUFBVSxVQUFVO0lBQ3hCLE9BQU8sTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFBO0FBQ25DLENBQUM7QUFFRCxTQUFTLElBQUk7SUFDWCxNQUFNLE1BQU0sR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxJQUFJLElBQUksQ0FBQTtJQUU1QyxvRkFBb0Y7SUFDcEYsSUFBSSxNQUFNLEtBQUssTUFBTSxFQUFFLENBQUM7UUFDdEIsTUFBTSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFXLENBQUE7UUFDckMsTUFBTSxHQUFHLE1BQU0sQ0FBQTtJQUNqQixDQUFDO0lBRUQsT0FBTyxNQUFNLENBQUE7QUFDZixDQUFDO0FBRUQsSUFBSSxNQUFNLEdBQWtCLElBQUksQ0FBQTtBQUNoQyxJQUFJLE1BQU0sR0FBVyxFQUFFLENBQUE7QUFFdkIsTUFBTSxDQUFDLE1BQU0sUUFBUSxHQUFHLDBCQUEwQixDQUFBIn0=

package/components/configuration.values/operations/lib/resolve.js

@@ -11,14 +11,14 @@ export async function resolve(context, component, epoch) {
     // one query per pair, so that a component's latest is never behind another's newer ones
     const query = {
         criteria: `component=="${component}";epoch=="${epoch}"`,
-        sort: ['_created:desc'],
+        sort: ['CREATED:desc'],
         limit: 1
     };
     const objects = await context.local.enumerate({ query });
     if (objects.length > 0)
-        return { configuration: objects[0].configuration, created: objects[0]._created };
+        return { configuration: objects[0].configuration, created: objects[0].CREATED };
     if (known !== undefined && known.epoch === epoch)
         return { configuration: known.defaults ?? {}, created: 0 };
     return null;
 }
-//# sourceMappingURL=resolve.js.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVzb2x2ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NvdXJjZS9saWIvcmVzb2x2ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsS0FBSyxFQUFFLE1BQU0sVUFBVSxDQUFBO0FBRWhDOzs7R0FHRztBQUNILE1BQU0sQ0FBQyxLQUFLLFVBQVUsT0FBTyxDQUMzQixPQUFnQixFQUNoQixTQUFpQixFQUNqQixLQUFjO0lBRWQsTUFBTSxLQUFLLEdBQUcsS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0lBRTlCLEtBQUssS0FBSyxLQUFLLEVBQUUsS0FBSyxDQUFBO0lBRXRCLElBQUksS0FBSyxLQUFLLFNBQVM7UUFBRSxPQUFPLElBQUksQ0FBQTtJQUVwQyx3RkFBd0Y7SUFDeEYsTUFBTSxLQUFLLEdBQVU7UUFDbkIsUUFBUSxFQUFFLGVBQWUsU0FBUyxhQUFhLEtBQUssR0FBRztRQUN2RCxJQUFJLEVBQUUsQ0FBQyxjQUFjLENBQUM7UUFDdEIsS0FBSyxFQUFFLENBQUM7S0FDVCxDQUFBO0lBRUQsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsS0FBSyxDQUFDLFNBQVMsQ0FBQyxFQUFFLEtBQUssRUFBRSxDQUFDLENBQUE7SUFFeEQsSUFBSSxPQUFPLENBQUMsTUFBTSxHQUFHLENBQUM7UUFDcEIsT0FBTyxFQUFFLGFBQWEsRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsYUFBYSxFQUFFLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxFQUFFLENBQUE7SUFFakYsSUFBSSxLQUFLLEtBQUssU0FBUyxJQUFJLEtBQUssQ0FBQyxLQUFLLEtBQUssS0FBSztRQUM5QyxPQUFPLEVBQUUsYUFBYSxFQUFFLEtBQUssQ0FBQyxRQUFRLElBQUksRUFBRSxFQUFFLE9BQU8sRUFBRSxDQUFDLEVBQUUsQ0FBQTtJQUU1RCxPQUFPLElBQUksQ0FBQTtBQUNiLENBQUMifQ==

package/components/configuration.values/operations/list.js

@@ -8,4 +8,4 @@ export async function computation(_, context) {
         return { component, epoch, schema, configuration: value.configuration };
     }));
 }
-//# sourceMappingURL=list.js.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibGlzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NvdXJjZS9saXN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxVQUFVLEVBQUUsS0FBSyxFQUFFLE1BQU0sY0FBYyxDQUFBO0FBQ2hELE9BQU8sRUFBRSxPQUFPLEVBQWdCLE1BQU0sa0JBQWtCLENBQUE7QUFFeEQsc0ZBQXNGO0FBQ3RGLE1BQU0sQ0FBQyxLQUFLLFVBQVUsV0FBVyxDQUFDLENBQU8sRUFBRSxPQUFnQjtJQUN6RCxPQUFPLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FDdEIsVUFBVSxFQUFFLENBQUMsR0FBRyxDQUFDLEtBQUssRUFBRSxTQUFTLEVBQUUsRUFBRTtRQUNuQyxNQUFNLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxHQUFHLEtBQUssQ0FBQyxTQUFTLENBQUUsQ0FBQTtRQUMzQyxNQUFNLEtBQUssR0FBRyxNQUFNLE9BQU8sQ0FBQyxPQUFPLEVBQUUsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFBO1FBRXRELE9BQU8sRUFBRSxTQUFTLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxhQUFhLEVBQUUsS0FBTSxDQUFDLGFBQWEsRUFBRSxDQUFBO0lBQzFFLENBQUMsQ0FBQyxDQUNILENBQUE7QUFDSCxDQUFDIn0=

package/components/configuration.values/source/create.ts

@@ -2,13 +2,11 @@ import * as schemas from '@toa.io/schemas'
 import { entry } from './lib/map.js'
 import type { Schema } from '@toa.io/schemas'
 
-export async function transition (input: Input, object: Entity): Promise<Entity | Error> {
+export async function transition(input: Input, object: Entity): Promise<Entity | Error> {
   const known = entry(input.component)
 
-  if (known === undefined)
-    return new UnknownComponentError(input.component)
+  if (known === undefined) return new UnknownComponentError(input.component)
 
-  // the schema fills its defaults, so what is stored is whole
   const configuration = structuredClone(input.configuration)
 
   const schema: Schema<any> = schemas.schema(known.schema)
@@ -30,7 +28,7 @@ export async function transition (input: Input, object: Entity): Promise<Entity
 class UnknownComponentError extends Error {
   public readonly code = 'UNKNOWN_COMPONENT'
 
-  public constructor (component: string) {
+  public constructor(component: string) {
     super(`Component '${component}' is not configured`)
   }
 }

package/components/configuration.values/source/fetch.ts

@@ -1,16 +1,18 @@
 import { resolve, type Context } from './lib/resolve.js'
 
-export async function computation (input: Pair[], context: Context): Promise<Fetched[]> {
-  return await Promise.all(input.map(async ({ component, epoch }) => {
-    const value = await resolve(context, component, epoch)
+export async function computation(input: Pair[], context: Context): Promise<Fetched[]> {
+  return await Promise.all(
+    input.map(async ({ component, epoch }) => {
+      const value = await resolve(context, component, epoch)
 
-    return {
-      component,
-      epoch,
-      configuration: value === null ? null : value.configuration,
-      created: value === null ? 0 : value.created
-    }
-  }))
+      return {
+        component,
+        epoch,
+        configuration: value === null ? null : value.configuration,
+        created: value === null ? 0 : value.created
+      }
+    })
+  )
 }
 
 interface Pair {

package/components/configuration.values/source/get.ts

@@ -6,11 +6,10 @@ import { resolve, type Context } from './lib/resolve.js'
  * schema is the deployment's, so an epoch the deployment does not know has none — the
  * value is still what was stored for it.
  */
-export async function computation (input: Input, context: Context): Promise<Item | null> {
+export async function computation(input: Input, context: Context): Promise<Item | null> {
   const value = await resolve(context, input.component, input.epoch)
 
-  if (value === null)
-    return null
+  if (value === null) return null
 
   const known = entry(input.component)
 

package/components/configuration.values/source/lib/map.test.ts

@@ -12,7 +12,9 @@ it('should be empty without the variable', () => {
 })
 
 it('should read the variable', () => {
-  const values = { 'a.b': { epoch: 'e', schema: { type: 'object' }, defaults: { foo: 1 } } }
+  const values = {
+    'a.b': { epoch: 'e', schema: { type: 'object' }, defaults: { foo: 1 } }
+  }
 
   process.env[VARIABLE] = JSON.stringify(values)
 
@@ -31,7 +33,10 @@ it('should follow the variable', () => {
 })
 
 it('should list the components by name', () => {
-  process.env[VARIABLE] = JSON.stringify({ 'b.two': { epoch: 'e', schema: {} }, 'a.one': { epoch: 'e', schema: {} } })
+  process.env[VARIABLE] = JSON.stringify({
+    'b.two': { epoch: 'e', schema: {} },
+    'a.one': { epoch: 'e', schema: {} }
+  })
 
   assert.deepStrictEqual(components(), ['a.one', 'b.two'])
 })

package/components/configuration.values/source/lib/map.ts

@@ -1,14 +1,14 @@
 /** What the deployment told the service about every configured component. */
-export function entry (component: string): Entry | undefined {
+export function entry(component: string): Entry | undefined {
   return read()[component]
 }
 
 /** The configured components, by name. */
-export function components (): string[] {
+export function components(): string[] {
   return Object.keys(read()).sort()
 }
 
-function read (): Values {
+function read(): Values {
   const source = process.env[VARIABLE] ?? '{}'
 
   // read again once the variable changes, as it does between scenarios of one process

package/components/configuration.values/source/lib/resolve.ts

@@ -4,25 +4,28 @@ import { entry } from './map.js'
  * The latest configuration created for the component and the epoch; the deployed
  * defaults when none was; `null` when the epoch is not the one deployed.
  */
-export async function resolve (context: Context, component: string, epoch?: string): Promise<Value | null> {
+export async function resolve(
+  context: Context,
+  component: string,
+  epoch?: string
+): Promise<Value | null> {
   const known = entry(component)
 
   epoch ??= known?.epoch
 
-  if (epoch === undefined)
-    return null
+  if (epoch === undefined) return null
 
   // one query per pair, so that a component's latest is never behind another's newer ones
   const query: Query = {
     criteria: `component=="${component}";epoch=="${epoch}"`,
-    sort: ['_created:desc'],
+    sort: ['CREATED:desc'],
     limit: 1
   }
 
   const objects = await context.local.enumerate({ query })
 
   if (objects.length > 0)
-    return { configuration: objects[0].configuration, created: objects[0]._created }
+    return { configuration: objects[0].configuration, created: objects[0].CREATED }
 
   if (known !== undefined && known.epoch === epoch)
     return { configuration: known.defaults ?? {}, created: 0 }
@@ -50,5 +53,5 @@ interface Query {
 
 interface Stored {
   configuration: object
-  _created: number
+  CREATED: number
 }

package/components/configuration.values/source/list.ts

@@ -2,13 +2,15 @@ import { components, entry } from './lib/map.js'
 import { resolve, type Context } from './lib/resolve.js'
 
 /** The configuration of every component for its deployed epoch, by component name. */
-export async function computation (_: null, context: Context): Promise<Item[]> {
-  return await Promise.all(components().map(async (component) => {
-    const { epoch, schema } = entry(component)!
-    const value = await resolve(context, component, epoch)
+export async function computation(_: null, context: Context): Promise<Item[]> {
+  return await Promise.all(
+    components().map(async (component) => {
+      const { epoch, schema } = entry(component)!
+      const value = await resolve(context, component, epoch)
 
-    return { component, epoch, schema, configuration: value!.configuration }
-  }))
+      return { component, epoch, schema, configuration: value!.configuration }
+    })
+  )
 }
 
 interface Item {

package/components/configuration.values/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../../../tsconfig.component.json",
   "compilerOptions": {
     "outDir": "./operations",
     "rootDir": "./source"