@metamask/snaps-cli 0.37.0-flask.1 → 0.38.0-flask.1

package/dist/types/commands/eval/__test__/browserify/bad/snap.config.d.ts

@@ -0,0 +1,3 @@
+import type { SnapConfig } from '../../../../../config';
+declare const config: SnapConfig;
+export default config;

package/dist/types/commands/eval/__test__/browserify/good/snap.config.d.ts

@@ -0,0 +1,3 @@
+import type { SnapConfig } from '../../../../../config';
+declare const config: SnapConfig;
+export default config;

package/dist/types/commands/eval/__test__/webpack/bad/snap.config.d.ts

@@ -0,0 +1,3 @@
+import type { SnapConfig } from '../../../../../config';
+declare const config: SnapConfig;
+export default config;

package/dist/types/commands/eval/__test__/webpack/good/snap.config.d.ts

@@ -0,0 +1,3 @@
+import type { SnapConfig } from '../../../../../config';
+declare const config: SnapConfig;
+export default config;

package/dist/types/commands/eval/__test__/webpack/snap.config.d.ts

@@ -0,0 +1,3 @@
+import type { SnapConfig } from '../../../../config';
+declare const config: SnapConfig;
+export default config;

package/dist/types/commands/eval/eval.d.ts

@@ -0,0 +1,14 @@
+import type { ProcessedConfig } from '../../config';
+export declare type EvalOptions = {
+    input?: string;
+};
+export declare type EvalContext = Required<EvalOptions>;
+/**
+ * Runs the snap in a worker, to ensure SES compatibility.
+ *
+ * @param config - The processed config object.
+ * @param options - The eval options.
+ * @returns A promise that resolves once the eval has finished.
+ * @throws If the eval failed.
+ */
+export declare function evaluateHandler(config: ProcessedConfig, options?: EvalOptions): Promise<void>;

package/dist/types/commands/eval/implementation.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Evaluate the given bundle in the SES environment. This is a wrapper around
+ * {@link evalBundle} that throws a {@link CommandError} if the bundle cannot be
+ * evaluated.
+ *
+ * @param path - The path to the bundle.
+ * @throws If the bundle cannot be evaluated.
+ */
+export declare function evaluate(path: string): Promise<import("@metamask/snaps-utils").EvalOutput>;

package/dist/types/{cmds/serve → commands/eval}/index.d.ts

@@ -6,4 +6,5 @@ declare const command: {
     builder: (yarg: yargs.Argv) => void;
     handler: (argv: YargsArgs) => Promise<void>;
 };
+export * from './implementation';
 export default command;

package/dist/types/commands/manifest/implementation.d.ts

@@ -0,0 +1,12 @@
+import type { Ora } from 'ora';
+/**
+ * Check the snap manifest file at the given path. If `write` is `true`, the
+ * manifest will be written to disk if it is invalid. If `write` is `false`,
+ * the manifest will not be written to disk, and the function will log any
+ * errors and warnings to the console.
+ *
+ * @param path - The path to the manifest file.
+ * @param write - Whether to write the manifest to disk if it is invalid.
+ * @param spinner - An optional spinner to use for logging.
+ */
+export declare function manifest(path: string, write: boolean, spinner?: Ora): Promise<boolean>;

package/dist/types/{cmds → commands}/manifest/index.d.ts

@@ -6,4 +6,5 @@ declare const command: {
     builder: (yarg: yargs.Argv) => void;
     handler: (argv: YargsArgs) => Promise<void>;
 };
+export * from './implementation';
 export default command;

package/dist/types/commands/manifest/manifest.d.ts

@@ -0,0 +1,14 @@
+import type { ProcessedConfig } from '../../config';
+declare type ManifestOptions = {
+    fix?: boolean;
+};
+/**
+ * Validates a snap.manifest.json file. Attempts to fix the manifest and write
+ * the fixed version to disk if `writeManifest` is true. Throws if validation
+ * fails.
+ *
+ * @param config - The config object.
+ * @param options - The options object.
+ */
+export declare function manifestHandler(config: ProcessedConfig, options: ManifestOptions): Promise<void>;
+export {};

package/dist/types/commands/serve/serve.d.ts

@@ -0,0 +1,16 @@
+import type { ProcessedConfig } from '../../config';
+declare type ServeOptions = {
+    /**
+     * The port to listen on.
+     */
+    port: number;
+};
+/**
+ * Starts a local, static HTTP server on the given port with the given root
+ * directory.
+ *
+ * @param config - The config object.
+ * @param options - The options object.
+ */
+export declare function serveHandler(config: ProcessedConfig, options: ServeOptions): Promise<void>;
+export {};

package/dist/types/commands/watch/implementation.d.ts

@@ -0,0 +1,14 @@
+import type { Watching } from 'webpack';
+import type { ProcessedWebpackConfig } from '../../config';
+import type { WebpackOptions } from '../../webpack';
+/**
+ * Build the snap bundle and watch for changes. This uses Webpack to build the
+ * bundle.
+ *
+ * @param config - The config object.
+ * @param options - The Webpack options.
+ * @returns A promise that resolves when the bundle is built for the first time.
+ * The promise resolves with a Webpack watching instance that can be used to
+ * close the watcher.
+ */
+export declare function watch(config: ProcessedWebpackConfig, options?: WebpackOptions): Promise<Watching>;

package/dist/types/commands/watch/index.d.ts

@@ -0,0 +1,10 @@
+import type yargs from 'yargs';
+import type { YargsArgs } from '../../types/yargs';
+declare const command: {
+    command: string[];
+    desc: string;
+    builder: (yarg: yargs.Argv) => void;
+    handler: (argv: YargsArgs) => Promise<void>;
+};
+export * from './implementation';
+export default command;

package/dist/types/commands/watch/watch.d.ts

@@ -0,0 +1,19 @@
+import type { ProcessedConfig } from '../../config';
+declare type WatchOptions = {
+    /**
+     * The port to listen on.
+     */
+    port?: number;
+};
+/**
+ * Watch a directory and its subdirectories for changes, and build when files
+ * are added or changed.
+ *
+ * Ignores 'node_modules' and dotfiles.
+ * Creates destination directory if it doesn't exist.
+ *
+ * @param config - The config object.
+ * @param options - The options object.
+ */
+export declare function watchHandler(config: ProcessedConfig, options: WatchOptions): Promise<void>;
+export {};