@fnndsc/brasa 0.53.0 → 0.54.0

package/dist/config/indexConfig.d.ts

@@ -0,0 +1,104 @@
+/**
+ * @file Engine plugin-index configuration: which index `plugin sync` reads.
+ *
+ * Built the way the peer store's configuration is (`./storeConfig.ts`), as
+ * its own setting: an index is a list of descriptors in git, not a store a
+ * plugin is looked up in by name. The value lives here; where it is
+ * persisted is the host's concern, through the hook it installs. With none
+ * installed the override lives for the process.
+ *
+ * Key components:
+ * - DEFAULT_PLUGIN_INDEX: the index read when the operator has set none.
+ * - pluginIndex_get / pluginIndex_isDefault / pluginIndexOverride_get: read it.
+ * - pluginIndex_set / pluginIndex_clear: change it.
+ * - indexConfigPersist_install / indexConfig_persist: the host's persistence.
+ *
+ * Typical usage:
+ * ```ts
+ * pluginIndex_set('FNNDSC/chris-plugins@v2026.11');
+ * await indexConfig_persist();
+ * ```
+ *
+ * Dependencies: none.
+ *
+ * @module
+ */
+/** The index read when the operator has set no override. */
+export declare const DEFAULT_PLUGIN_INDEX: string;
+/**
+ * Returns the index in effect, falling back to the default.
+ *
+ * @returns The index source word.
+ *
+ * @example
+ * ```ts
+ * pluginIndex_get(); // 'FNNDSC/chris-plugins@main'
+ * ```
+ */
+export declare function pluginIndex_get(): string;
+/**
+ * Reports whether the index in effect is the default.
+ *
+ * @returns True when no override is set.
+ *
+ * @example
+ * ```ts
+ * pluginIndex_isDefault(); // true
+ * ```
+ */
+export declare function pluginIndex_isDefault(): boolean;
+/**
+ * Returns the operator's override without applying the default.
+ *
+ * The persistence layer uses this so it writes only an explicit override.
+ *
+ * @returns The override, or undefined when none is set.
+ *
+ * @example
+ * ```ts
+ * pluginIndexOverride_get(); // undefined
+ * ```
+ */
+export declare function pluginIndexOverride_get(): string | undefined;
+/**
+ * Sets the index override.
+ *
+ * @param source - The index source word (`owner/repo[@ref]`, `cube:<path>`, `host:<path>`).
+ *
+ * @example
+ * ```ts
+ * pluginIndex_set('FNNDSC/chris-plugins@v2026.11');
+ * ```
+ */
+export declare function pluginIndex_set(source: string): void;
+/**
+ * Clears the index override, restoring the default.
+ *
+ * @example
+ * ```ts
+ * pluginIndex_clear();
+ * ```
+ */
+export declare function pluginIndex_clear(): void;
+/**
+ * Installs the host's persistence hook.
+ *
+ * @param fn - Callback invoked to persist the current index configuration.
+ *
+ * @example
+ * ```ts
+ * indexConfigPersist_install(settings_save);
+ * ```
+ */
+export declare function indexConfigPersist_install(fn: () => Promise<void>): void;
+/**
+ * Persists the current index configuration through the installed hook.
+ *
+ * @returns A promise resolving once persistence completes.
+ *
+ * @example
+ * ```ts
+ * await indexConfig_persist();
+ * ```
+ */
+export declare function indexConfig_persist(): Promise<void>;

package/dist/config/indexConfig.js

@@ -0,0 +1,125 @@
+/**
+ * @file Engine plugin-index configuration: which index `plugin sync` reads.
+ *
+ * Built the way the peer store's configuration is (`./storeConfig.ts`), as
+ * its own setting: an index is a list of descriptors in git, not a store a
+ * plugin is looked up in by name. The value lives here; where it is
+ * persisted is the host's concern, through the hook it installs. With none
+ * installed the override lives for the process.
+ *
+ * Key components:
+ * - DEFAULT_PLUGIN_INDEX: the index read when the operator has set none.
+ * - pluginIndex_get / pluginIndex_isDefault / pluginIndexOverride_get: read it.
+ * - pluginIndex_set / pluginIndex_clear: change it.
+ * - indexConfigPersist_install / indexConfig_persist: the host's persistence.
+ *
+ * Typical usage:
+ * ```ts
+ * pluginIndex_set('FNNDSC/chris-plugins@v2026.11');
+ * await indexConfig_persist();
+ * ```
+ *
+ * Dependencies: none.
+ *
+ * @module
+ */
+/** The index read when the operator has set no override. */
+export const DEFAULT_PLUGIN_INDEX = 'FNNDSC/chris-plugins@main';
+/** The operator's override, or undefined to use {@link DEFAULT_PLUGIN_INDEX}. */
+let pluginIndex;
+/** Host-installed persistence hook; the default keeps the value in memory. */
+let persist = async () => {
+    // Headless default: the override lives for the process and is not persisted.
+};
+/**
+ * Returns the index in effect, falling back to the default.
+ *
+ * @returns The index source word.
+ *
+ * @example
+ * ```ts
+ * pluginIndex_get(); // 'FNNDSC/chris-plugins@main'
+ * ```
+ */
+export function pluginIndex_get() {
+    return pluginIndex ?? DEFAULT_PLUGIN_INDEX;
+}
+/**
+ * Reports whether the index in effect is the default.
+ *
+ * @returns True when no override is set.
+ *
+ * @example
+ * ```ts
+ * pluginIndex_isDefault(); // true
+ * ```
+ */
+export function pluginIndex_isDefault() {
+    return pluginIndex === undefined;
+}
+/**
+ * Returns the operator's override without applying the default.
+ *
+ * The persistence layer uses this so it writes only an explicit override.
+ *
+ * @returns The override, or undefined when none is set.
+ *
+ * @example
+ * ```ts
+ * pluginIndexOverride_get(); // undefined
+ * ```
+ */
+export function pluginIndexOverride_get() {
+    return pluginIndex;
+}
+/**
+ * Sets the index override.
+ *
+ * @param source - The index source word (`owner/repo[@ref]`, `cube:<path>`, `host:<path>`).
+ *
+ * @example
+ * ```ts
+ * pluginIndex_set('FNNDSC/chris-plugins@v2026.11');
+ * ```
+ */
+export function pluginIndex_set(source) {
+    pluginIndex = source;
+}
+/**
+ * Clears the index override, restoring the default.
+ *
+ * @example
+ * ```ts
+ * pluginIndex_clear();
+ * ```
+ */
+export function pluginIndex_clear() {
+    pluginIndex = undefined;
+}
+/**
+ * Installs the host's persistence hook.
+ *
+ * @param fn - Callback invoked to persist the current index configuration.
+ *
+ * @example
+ * ```ts
+ * indexConfigPersist_install(settings_save);
+ * ```
+ */
+export function indexConfigPersist_install(fn) {
+    persist = fn;
+}
+/**
+ * Persists the current index configuration through the installed hook.
+ *
+ * @returns A promise resolving once persistence completes.
+ *
+ * @example
+ * ```ts
+ * await indexConfig_persist();
+ * ```
+ */
+export async function indexConfig_persist() {
+    await persist();
+}
+//# sourceMappingURL=indexConfig.js.map

package/dist/config/indexConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexConfig.js","sourceRoot":"","sources":["../../src/config/indexConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,4DAA4D;AAC5D,MAAM,CAAC,MAAM,oBAAoB,GAAW,2BAA2B,CAAC;AAExE,iFAAiF;AACjF,IAAI,WAA+B,CAAC;AAEpC,8EAA8E;AAC9E,IAAI,OAAO,GAAwB,KAAK,IAAmB,EAAE;IAC3D,6EAA6E;AAC/E,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,WAAW,IAAI,oBAAoB,CAAC;AAC7C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB;IACnC,OAAO,WAAW,KAAK,SAAS,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAC,MAAc;IAC5C,WAAW,GAAG,MAAM,CAAC;AACvB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB;IAC/B,WAAW,GAAG,SAAS,CAAC;AAC1B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,0BAA0B,CAAC,EAAuB;IAChE,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IACvC,MAAM,OAAO,EAAE,CAAC;AAClB,CAAC"}

package/dist/index.d.ts

@@ -28,6 +28,7 @@ export * from './core/version.js';
 export * from './session/index.js';
 export * from './builtins/index.js';
 export * from './config/storeConfig.js';
+export * from './config/indexConfig.js';
 export * from './lib/vfs/vfs.js';
 export * from './lib/spinner.js';
 export * from './logo/brain.js';

package/dist/index.js

@@ -38,6 +38,7 @@ export * from './core/version.js';
 export * from './session/index.js';
 export * from './builtins/index.js';
 export * from './config/storeConfig.js';
+export * from './config/indexConfig.js';
 export * from './lib/vfs/vfs.js';
 export * from './lib/spinner.js';
 export * from './logo/brain.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,cAAc,kBAAkB,CAAC;AACjC,iEAAiE;AACjE,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,uEAAuE;AACvE,4EAA4E;AAC5E,sBAAsB;AACtB,OAAO,EAAE,iBAAiB,IAAI,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAC5F,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,eAAe,IAAI,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,0BAA0B,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;AACrD,wBAAwB,CAAC,YAAY,CAAC,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAkB,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAC/I,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,cAAc,kBAAkB,CAAC;AACjC,iEAAiE;AACjE,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,uEAAuE;AACvE,4EAA4E;AAC5E,sBAAsB;AACtB,OAAO,EAAE,iBAAiB,IAAI,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAC5F,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,eAAe,IAAI,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,0BAA0B,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;AACrD,wBAAwB,CAAC,YAAY,CAAC,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAkB,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAC/I,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC"}