@mak-98/dirvi-app 0.0.0-stage → 0.11.0-beta.2

package/dist/application/create-dirvi-api.d.ts

@@ -0,0 +1,10 @@
+import type { DirviApi } from '../domain/dirvi-api.js';
+import type { Initialization } from '../domain/initialization.js';
+/**
+ * Creates the runtime application facade from validated initialization data.
+ *
+ * Registered App values remain private to this module. Consumers interact
+ * through app IDs and AppApiApplicator values only.
+ */
+export declare function createDirviApi(init: Initialization): DirviApi;
+//# sourceMappingURL=create-dirvi-api.d.ts.map

package/dist/application/create-dirvi-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-dirvi-api.d.ts","sourceRoot":"","sources":["../../src/application/create-dirvi-api.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAElE;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,QAAQ,CAmB7D"}

package/dist/application/create-dirvi-api.js

@@ -0,0 +1,23 @@
+import { createAppApiApplicator, } from '../domain/app.js';
+/**
+ * Creates the runtime application facade from validated initialization data.
+ *
+ * Registered App values remain private to this module. Consumers interact
+ * through app IDs and AppApiApplicator values only.
+ */
+export function createDirviApi(init) {
+    const apps = new Map(init.apps.map((app) => [app.id, app]));
+    return {
+        config: init.config,
+        initialAppId: init.initialAppId,
+        appIds: [...apps.keys()],
+        customExCommands: init.exCommands,
+        openApp: (appId, input) => {
+            const app = apps.get(appId);
+            if (app === undefined) {
+                throw new Error(`App "${appId}" is not registered.`);
+            }
+            return createAppApiApplicator(app, input);
+        },
+    };
+}

package/dist/application/init-runtime.d.ts

@@ -0,0 +1,20 @@
+import type { Initialization } from '../domain/initialization.js';
+import type { PublicInitApi } from '../domain/public-init-api.js';
+/**
+ * Collects startup configuration registrations while init.mjs is evaluated.
+ *
+ * The application exposes `api` to the script, then calls `finish()` once
+ * evaluation completes to seal registration and obtain the validated Config.
+ */
+export type InitRuntime = {
+    readonly api: PublicInitApi;
+    readonly finish: () => Initialization;
+};
+/**
+ * Creates a fresh startup configuration session.
+ *
+ * Each runtime owns its own mutable configuration while registration is open.
+ * The mutable state is not exposed directly to the config script.
+ */
+export declare function createInitRuntime(): InitRuntime;
+//# sourceMappingURL=init-runtime.d.ts.map

package/dist/application/init-runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init-runtime.d.ts","sourceRoot":"","sources":["../../src/application/init-runtime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAElE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAIlE;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,cAAc,CAAC;CACvC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,WAAW,CAiI/C"}

package/dist/application/init-runtime.js

@@ -0,0 +1,117 @@
+import { ConfigSchema, defaultConfig, merge } from '../domain/config.js';
+/**
+ * Creates a fresh startup configuration session.
+ *
+ * Each runtime owns its own mutable configuration while registration is open.
+ * The mutable state is not exposed directly to the config script.
+ */
+export function createInitRuntime() {
+    let config = defaultConfig;
+    let initialAppId;
+    const apps = new Map();
+    const exCommands = new Map();
+    let finished = false;
+    return {
+        api: {
+            options: {
+                set: (patch) => {
+                    // init.mjs is a startup script. It must not modify startup options
+                    // after the host has finished evaluating and consuming it.
+                    if (finished) {
+                        throw new Error('Initialization has finished. Configure dirvi while init.mjs is being evaluated.');
+                    }
+                    // Validate the complete result, not merely the patch. This preserves
+                    // domain invariants even when a patch changes nested configuration.
+                    config = ConfigSchema.parse(merge(config, patch));
+                },
+            },
+            apps: {
+                register: (id, appReference) => {
+                    if (finished) {
+                        throw new Error('Initialization has finished. Register apps while ' +
+                            'init.mjs is being evaluated.');
+                    }
+                    if (id.trim().length === 0) {
+                        throw new Error('App ID must not be empty.');
+                    }
+                    if (apps.has(id)) {
+                        throw new Error(`An app with ID "${id}" was registered multiple times.`);
+                    }
+                    apps.set(id, appReference);
+                },
+                initialAppId: (appId) => {
+                    if (finished) {
+                        throw new Error('Initialization has finished. Select an initial app while ' +
+                            'init.mjs is being evaluated.');
+                    }
+                    if (appId.trim().length === 0) {
+                        throw new Error('App ID must not be empty.');
+                    }
+                    initialAppId = appId;
+                },
+            },
+            ex: {
+                register: (name, execute) => {
+                    if (finished) {
+                        throw new Error('Initialization has finished. Register Ex commands while ' +
+                            'init.mjs is being evaluated.');
+                    }
+                    if (name.trim().length === 0) {
+                        throw new Error('Ex command name must not be empty.');
+                    }
+                    if (exCommands.has(name)) {
+                        throw new Error(`An Ex command named "${name}" was registered multiple times.`);
+                    }
+                    exCommands.set(name, {
+                        name,
+                        execute,
+                    });
+                },
+            },
+        },
+        finish: () => {
+            if (finished) {
+                throw new Error('Initialization has already finished.');
+            }
+            if (apps.size === 0) {
+                throw new Error('Initialization did not register any apps. Call ' +
+                    'dirvi.apps.register(id, appReference) at least once in init.mjs.');
+            }
+            if (initialAppId !== undefined) {
+                if (!apps.has(initialAppId)) {
+                    throw new Error(`Startup app "${initialAppId}" has not been registered.`);
+                }
+                finished = true;
+                return {
+                    config,
+                    initialAppId: initialAppId,
+                    registeredApps: new Map(apps),
+                    exCommands: [...exCommands.values()],
+                };
+            }
+            const lastRegisteredAppRef = getLastRegisteredAppId(apps);
+            finished = true;
+            return {
+                config,
+                initialAppId: lastRegisteredAppRef,
+                registeredApps: new Map(apps),
+                exCommands: [...exCommands.values()],
+            };
+        },
+    };
+}
+/**
+ * Returns the most recently registered app ID.
+ *
+ * Map iteration follows registration insertion order. This is a convenience
+ * fallback only; init.mjs should set initialAppId explicitly when startup
+ * selection is semantically important.
+ */
+function getLastRegisteredAppId(apps) {
+    const appIds = [...apps.keys()];
+    const lastAppId = appIds.at(-1);
+    if (lastAppId === undefined) {
+        throw new Error('Internal error: Check some app is registered before searching ids.');
+    }
+    return lastAppId;
+}

package/dist/application/package-loader.d.ts

@@ -0,0 +1,9 @@
+import type { AppPackageReference } from '../domain/app-pack-ref.js';
+import type { AppPlugin } from 'dirvi-apis';
+/**
+ * In the future will be expanded to load other plugins too.
+ */
+export type PackageLoader = {
+    loadAppPlugin: (reference: AppPackageReference) => Promise<AppPlugin>;
+};
+//# sourceMappingURL=package-loader.d.ts.map

package/dist/application/package-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-loader.d.ts","sourceRoot":"","sources":["../../src/application/package-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,CAAC,SAAS,EAAE,mBAAmB,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;CACvE,CAAC"}

package/dist/application/package-loader.js

@@ -0,0 +1 @@
+export {};

package/dist/application/shell-api.d.ts

@@ -0,0 +1,5 @@
+import type { AppInput } from '../domain/app.js';
+export type ShellApi = {
+    readonly openApp: (appId: string, input: AppInput) => Promise<void>;
+};
+//# sourceMappingURL=shell-api.d.ts.map

package/dist/application/shell-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shell-api.d.ts","sourceRoot":"","sources":["../../src/application/shell-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE,CAAC"}

package/dist/application/shell-api.js

@@ -0,0 +1 @@
+export {};

package/dist/domain/app-pack-ref.d.ts

@@ -0,0 +1,17 @@
+export type NpmAppReference = {
+    readonly source: 'npm';
+    readonly packageName: string;
+    readonly version: string;
+};
+export type AppPackageReference = NpmAppReference;
+/**
+ * Parses and validates an app package reference supplied by init.mjs.
+ *
+ * init.mjs is runtime JavaScript, so TypeScript's AppPackageReference type is
+ * not sufficient to establish that a received value is safe to interpret as an
+ * npm package reference.
+ */
+export declare const AppPackageReference: {
+    parse(input: unknown): AppPackageReference;
+};
+//# sourceMappingURL=app-pack-ref.d.ts.map

package/dist/domain/app-pack-ref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-pack-ref.d.ts","sourceRoot":"","sources":["../../src/domain/app-pack-ref.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAElD;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;iBACjB,OAAO,GAAG,mBAAmB;CA+C3C,CAAC"}

package/dist/domain/app-pack-ref.js

@@ -0,0 +1,37 @@
+/**
+ * Parses and validates an app package reference supplied by init.mjs.
+ *
+ * init.mjs is runtime JavaScript, so TypeScript's AppPackageReference type is
+ * not sufficient to establish that a received value is safe to interpret as an
+ * npm package reference.
+ */
+export const AppPackageReference = {
+    parse(input) {
+        if (!isRecord(input)) {
+            throw new Error('Dirvi app package reference must be an object.');
+        }
+        if (input.source !== 'npm') {
+            throw new Error(`Unsupported Dirvi app package source "${String(input.source)}".`);
+        }
+        if (typeof input.packageName !== 'string') {
+            throw new Error('Dirvi npm app package name must be a string.');
+        }
+        if (!/^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/.test(input.packageName)) {
+            throw new Error(`Invalid npm package name "${input.packageName}" for a Dirvi app.`);
+        }
+        if (typeof input.version !== 'string') {
+            throw new Error(`Dirvi app package "${input.packageName}" version must be a string.`);
+        }
+        if (!/^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/.test(input.version)) {
+            throw new Error(`Dirvi app package "${input.packageName}" must use an exact version.`);
+        }
+        return {
+            source: 'npm',
+            packageName: input.packageName,
+            version: input.version,
+        };
+    },
+};
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}

package/dist/domain/app.d.ts

@@ -0,0 +1,39 @@
+import type { AppApiApplicator, AppPlugin } from 'dirvi-apis';
+/**
+ * Unique symbol used as computed property name.
+ *
+ * DO NOT EXPORT: Meant to be private to the file, so `App` has opaque
+ * `AppPlugin`.
+ */
+declare const appPlugin: unique symbol;
+export type App = {
+    /**
+     * User-owned identifier from init.mjs.
+     *
+     * This is intentionally not package-owned plugin metadata. It identifies a
+     * configured app instance, so users can register the same plugin more than
+     * once under different IDs.
+     */
+    readonly id: string;
+    /**
+     * Opaque storage for the plugin implementation.
+     *
+     * Consumers can inspect the configured app ID, but only this module can
+     * obtain and invoke the underlying AppPlugin.
+     */
+    readonly [appPlugin]: AppPlugin;
+};
+/**
+ * Creates one configured app instance from a user-selected ID and a plugin.
+ */
+export declare function createApp(id: string, plugin: AppPlugin): App;
+export type AppInput = string | undefined;
+/**
+ * Creates the app API applicator for a configured app without exposing the
+ * `AppPlugin`.
+ *
+ * The concrete AppApi generic parameters remain owned by the plugin.
+ */
+export declare function createAppApiApplicator(app: App, input: AppInput): AppApiApplicator;
+export {};
+//# sourceMappingURL=app.d.ts.map

package/dist/domain/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/domain/app.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE9D;;;;;GAKG;AACH,QAAA,MAAM,SAAS,eAAsB,CAAC;AAEtC,MAAM,MAAM,GAAG,GAAG;IAChB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,GAAG,CAK5D;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,QAAQ,GACd,gBAAgB,CAElB"}

package/dist/domain/app.js

@@ -0,0 +1,25 @@
+/**
+ * Unique symbol used as computed property name.
+ *
+ * DO NOT EXPORT: Meant to be private to the file, so `App` has opaque
+ * `AppPlugin`.
+ */
+const appPlugin = Symbol('appPlugin');
+/**
+ * Creates one configured app instance from a user-selected ID and a plugin.
+ */
+export function createApp(id, plugin) {
+    return {
+        id,
+        [appPlugin]: plugin,
+    };
+}
+/**
+ * Creates the app API applicator for a configured app without exposing the
+ * `AppPlugin`.
+ *
+ * The concrete AppApi generic parameters remain owned by the plugin.
+ */
+export function createAppApiApplicator(app, input) {
+    return app[appPlugin].createAppApiApplicator(input);
+}