codify-plugin-lib 1.0.110 → 1.0.112

package/dist/index.d.ts

@@ -9,4 +9,5 @@ export * from './resource/parsed-resource-settings.js';
 export * from './resource/resource.js';
 export * from './resource/resource-settings.js';
 export * from './stateful-parameter/stateful-parameter.js';
+export * from './utils/utils.js';
 export declare function runPlugin(plugin: Plugin): Promise<void>;

package/dist/index.js

@@ -4,12 +4,12 @@ export * from './plan/change-set.js';
 export * from './plan/plan.js';
 export * from './plan/plan-types.js';
 export * from './plugin/plugin.js';
-// export * from './utils/utils.js'
 export * from './pty/index.js';
 export * from './resource/parsed-resource-settings.js';
 export * from './resource/resource.js';
 export * from './resource/resource-settings.js';
 export * from './stateful-parameter/stateful-parameter.js';
+export * from './utils/utils.js';
 export async function runPlugin(plugin) {
     const messageHandler = new MessageHandler(plugin);
     process.on('message', (message) => messageHandler.onMessage(message));

package/dist/pty/index.d.ts

@@ -3,6 +3,10 @@ export interface SpawnResult {
     exitCode: number;
     data: string;
 }
+export declare enum SpawnStatus {
+    SUCCESS = "success",
+    ERROR = "error"
+}
 export interface SpawnOptions {
     cwd?: string;
     env?: Record<string, unknown>;

package/dist/pty/index.js

@@ -1,4 +1,9 @@
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
+export var SpawnStatus;
+(function (SpawnStatus) {
+    SpawnStatus["SUCCESS"] = "success";
+    SpawnStatus["ERROR"] = "error";
+})(SpawnStatus || (SpawnStatus = {}));
 export class SpawnError extends Error {
     data;
     cmd;

package/dist/utils/utils.d.ts

@@ -1,34 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
 import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
-import { SpawnOptions } from 'node:child_process';
-export declare enum SpawnStatus {
-    SUCCESS = "success",
-    ERROR = "error"
-}
-export interface SpawnResult {
-    status: SpawnStatus;
-    data: string;
-}
-type CodifySpawnOptions = {
-    cwd?: string;
-    stdioString?: boolean;
-} & SpawnOptions;
-/**
- *
- * @param cmd Command to run. Ex: `rm -rf`
- * @param args Optional additional arguments to append
- * @param opts Standard options for node spawn. Additional argument:
- * throws determines if a shell will throw a JS error. Defaults to true
- * @param extras From PromiseSpawn
- *
- * @see promiseSpawn
- * @see spawn
- *
- * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
- */
-export declare function codifySpawn(cmd: string, args?: string[], opts?: Omit<CodifySpawnOptions, 'stdio' | 'stdioString'> & {
-    throws?: boolean;
-}, extras?: Record<any, any>): Promise<SpawnResult>;
 export declare function isDebug(): boolean;
 export declare function splitUserConfig<T extends StringIndexedObject>(config: ResourceConfig & T): {
     parameters: T;
@@ -37,4 +7,3 @@ export declare function splitUserConfig<T extends StringIndexedObject>(config: R
 export declare function setsEqual(set1: Set<unknown>, set2: Set<unknown>): boolean;
 export declare function untildify(pathWithTilde: string): string;
 export declare function areArraysEqual(isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined, desired: unknown, current: unknown): boolean;
-export {};

package/dist/utils/utils.js

@@ -1,54 +1,4 @@
-import promiseSpawn from '@npmcli/promise-spawn';
 import os from 'node:os';
-export var SpawnStatus;
-(function (SpawnStatus) {
-    SpawnStatus["SUCCESS"] = "success";
-    SpawnStatus["ERROR"] = "error";
-})(SpawnStatus || (SpawnStatus = {}));
-/**
- *
- * @param cmd Command to run. Ex: `rm -rf`
- * @param args Optional additional arguments to append
- * @param opts Standard options for node spawn. Additional argument:
- * throws determines if a shell will throw a JS error. Defaults to true
- * @param extras From PromiseSpawn
- *
- * @see promiseSpawn
- * @see spawn
- *
- * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
- */
-export async function codifySpawn(cmd, args, opts, extras) {
-    try {
-        // TODO: Need to benchmark the effects of using sh vs zsh for shell.
-        //  Seems like zsh shells run slower
-        const result = await promiseSpawn(cmd, args ?? [], { ...opts, stdio: 'pipe', stdioString: true, shell: opts?.shell ?? process.env.SHELL }, extras);
-        if (isDebug()) {
-            console.log(`codifySpawn result for: ${cmd}`);
-            console.log(JSON.stringify(result, null, 2));
-        }
-        const status = result.code === 0
-            ? SpawnStatus.SUCCESS
-            : SpawnStatus.ERROR;
-        return {
-            status,
-            data: status === SpawnStatus.SUCCESS ? result.stdout : result.stderr
-        };
-    }
-    catch (error) {
-        const shouldThrow = opts?.throws ?? true;
-        if (isDebug() || shouldThrow) {
-            console.error(`CodifySpawn Error for command ${cmd} ${args}`, error);
-        }
-        if (shouldThrow) {
-            throw error;
-        }
-        return {
-            status: SpawnStatus.ERROR,
-            data: error,
-        };
-    }
-}
 export function isDebug() {
     return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.110",
+  "version": "1.0.112",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/index.ts

@@ -6,12 +6,12 @@ export * from './plan/change-set.js'
 export * from './plan/plan.js'
 export * from './plan/plan-types.js'
 export * from './plugin/plugin.js'
-// export * from './utils/utils.js'
 export * from './pty/index.js'
 export * from './resource/parsed-resource-settings.js';
 export * from './resource/resource.js'
 export * from './resource/resource-settings.js'
 export * from './stateful-parameter/stateful-parameter.js'
+export * from './utils/utils.js'
 
 export async function runPlugin(plugin: Plugin) {
   const messageHandler = new MessageHandler(plugin);

package/src/pty/index.ts

@@ -6,6 +6,11 @@ export interface SpawnResult {
   data: string;
 }
 
+export enum SpawnStatus {
+  SUCCESS = 'success',
+  ERROR = 'error',
+}
+
 export interface SpawnOptions {
   cwd?: string;
   env?: Record<string, unknown>,

package/src/utils/utils.ts

@@ -1,82 +1,6 @@
-import promiseSpawn from '@npmcli/promise-spawn';
 import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
-import { SpawnOptions } from 'node:child_process';
 import os from 'node:os';
 
-export enum SpawnStatus {
-  SUCCESS = 'success',
-  ERROR = 'error',
-}
-
-export interface SpawnResult {
-  status: SpawnStatus,
-  data: string;
-}
-
-type CodifySpawnOptions = {
-  cwd?: string;
-  stdioString?: boolean;
-} & SpawnOptions
-
-/**
- *
- * @param cmd Command to run. Ex: `rm -rf`
- * @param args Optional additional arguments to append
- * @param opts Standard options for node spawn. Additional argument:
- * throws determines if a shell will throw a JS error. Defaults to true
- * @param extras From PromiseSpawn
- *
- * @see promiseSpawn
- * @see spawn
- *
- * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
- */
-export async function codifySpawn(
-  cmd: string,
-  args?: string[],
-  opts?: Omit<CodifySpawnOptions, 'stdio' | 'stdioString'> & { throws?: boolean },
-  extras?: Record<any, any>,
-): Promise<SpawnResult> {
-  try {
-    // TODO: Need to benchmark the effects of using sh vs zsh for shell.
-    //  Seems like zsh shells run slower
-    const result = await promiseSpawn(
-      cmd,
-      args ?? [],
-      { ...opts, stdio: 'pipe', stdioString: true, shell: opts?.shell ?? process.env.SHELL },
-      extras,
-    );
-
-    if (isDebug()) {
-      console.log(`codifySpawn result for: ${cmd}`);
-      console.log(JSON.stringify(result, null, 2))
-    }
-
-    const status = result.code === 0
-      ? SpawnStatus.SUCCESS
-      : SpawnStatus.ERROR;
-
-    return {
-      status,
-      data: status === SpawnStatus.SUCCESS ? result.stdout : result.stderr
-    }
-  } catch (error) {
-    const shouldThrow = opts?.throws ?? true;
-    if (isDebug() || shouldThrow) {
-      console.error(`CodifySpawn Error for command ${cmd} ${args}`, error);
-    }
-
-    if (shouldThrow) {
-      throw error;
-    }
-
-    return {
-      status: SpawnStatus.ERROR,
-      data: error as string,
-    }
-  }
-}
-
 export function isDebug(): boolean {
   return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
 }