@eclipse-lyra/extension-howto-system 0.0.0

package/dist/contributions/ai-setup-howto-contributions.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ai-setup-howto-contributions.d.ts.map

package/dist/contributions/ai-setup-howto-contributions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-setup-howto-contributions.d.ts","sourceRoot":"","sources":["../../src/contributions/ai-setup-howto-contributions.ts"],"names":[],"mappings":""}

package/dist/contributions/onboarding-howto-contributions.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=onboarding-howto-contributions.d.ts.map

package/dist/contributions/onboarding-howto-contributions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding-howto-contributions.d.ts","sourceRoot":"","sources":["../../src/contributions/onboarding-howto-contributions.ts"],"names":[],"mappings":""}

package/dist/howto-contribution.d.ts

@@ -0,0 +1,78 @@
+import { Contribution } from '@eclipse-lyra/core';
+/**
+ * HowTo Contribution System
+ *
+ * Allows extensions to register step-by-step workflows that guide users
+ * through specific processes with pre and post condition checks.
+ */
+/**
+ * Condition function that checks if a requirement is met or outcome is achieved.
+ * Returns a promise that resolves to true if the condition is satisfied.
+ */
+export type ConditionFunction = () => Promise<boolean> | boolean;
+/**
+ * A single step in a HowTo workflow
+ */
+export interface HowToStep {
+    /** Unique identifier for this step */
+    id: string;
+    /** Human-readable title of the step */
+    title: string;
+    /** Detailed description of what the user should do in this step */
+    description: string;
+    /**
+     * Pre-condition check: verifies that requirements are met before this step can be executed.
+     * If this returns false, the step cannot be started.
+     */
+    preCondition?: ConditionFunction;
+    /**
+     * Post-condition check: verifies that the step was completed successfully.
+     * If this returns false, the step is not considered complete.
+     */
+    postCondition?: ConditionFunction;
+    /** Optional command to execute when the step is activated */
+    command?: string;
+    /** Optional command parameters (or function returning params for dynamic values) */
+    commandParams?: Record<string, any> | (() => Record<string, any> | Promise<Record<string, any>>);
+    /** Whether this step is optional */
+    optional?: boolean;
+}
+/**
+ * Context provided to HowTo initialization function
+ */
+export interface HowToContext {
+    /** Callback to notify the panel that conditions should be re-checked */
+    requestUpdate: () => void;
+    /** The contribution ID of this HowTo */
+    contributionId: string;
+}
+/**
+ * Initialization function for a HowTo
+ * Allows the HowTo to set up its own subscriptions and manage its lifecycle
+ */
+export type HowToInitializeFunction = (context: HowToContext) => (() => void) | void;
+/**
+ * A HowTo Contribution defines a complete workflow with multiple steps.
+ * Extends Contribution to work with the contribution registry.
+ */
+export interface HowToContribution extends Contribution {
+    /** Unique identifier for this HowTo */
+    id: string;
+    /** Human-readable title of the workflow (can be a function for dynamic values) */
+    title: string | (() => string);
+    /** Description of what this workflow helps accomplish (can be a function for dynamic values) */
+    description?: string | (() => string);
+    /** Icon identifier (FontAwesome or custom icon) */
+    icon?: string;
+    /** List of steps in the workflow */
+    steps: HowToStep[];
+    /** Optional category for grouping related workflows */
+    category?: string;
+    /**
+     * Optional initialization function that runs when the HowTo is started.
+     * Can set up subscriptions, listeners, etc.
+     * Should return a cleanup function (optional) that will be called when the HowTo is closed.
+     */
+    initialize?: HowToInitializeFunction;
+}
+//# sourceMappingURL=howto-contribution.d.ts.map

package/dist/howto-contribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"howto-contribution.d.ts","sourceRoot":"","sources":["../src/howto-contribution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;;;GAKG;AAEH;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IAEd,mEAAmE;IACnE,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;IAEjC;;;OAGG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAEjG,oCAAoC;IACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,wEAAwE;IACxE,aAAa,EAAE,MAAM,IAAI,CAAC;IAE1B,wCAAwC;IACxC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC;AAErF;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACnD,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IAEX,kFAAkF;IAClF,KAAK,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IAE/B,gGAAgG;IAChG,WAAW,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IAEtC,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oCAAoC;IACpC,KAAK,EAAE,SAAS,EAAE,CAAC;IAEnB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAC;CACxC"}