@terraforge/terraform 0.0.19 → 0.0.21

package/dist/index.d.mts

@@ -191,6 +191,13 @@ type GetDataProps<T = State> = {
   type: string;
   state: T;
 };
+type RefreshStateProps<T = State> = {
+  type: string;
+  tag: 'resource' | 'data';
+  priorInputState: T;
+  priorOutputState: T;
+  refreshedState: T;
+};
 interface Provider {
   ownResource(id: string): boolean;
   getResource(props: GetProps): Promise<{
@@ -214,6 +221,7 @@ interface Provider {
   getData?(props: GetDataProps): Promise<{
     state: State;
   }>;
+  isRefreshStateEqual?(props: RefreshStateProps): Promise<boolean> | boolean;
   destroy?(): Promise<void>;
 }
 //#endregion
@@ -284,6 +292,13 @@ declare class TerraformProvider implements Provider {
   }: GetDataProps): Promise<{
     state: State$1;
   }>;
+  isRefreshStateEqual({
+    type,
+    tag,
+    priorInputState,
+    priorOutputState,
+    refreshedState
+  }: RefreshStateProps): Promise<boolean>;
 }
 //#endregion
 //#region src/plugin/registry.d.ts

package/dist/index.mjs

@@ -217,6 +217,16 @@ const generateValue = (prop, ctx) => {
 
 //#endregion
 //#region src/provider.ts
+const areStatesEqual = (left, right) => {
+	const replacer = (_, value) => {
+		if (value !== null && value instanceof Object && !Array.isArray(value)) return Object.keys(value).sort().reduce((sorted, key) => {
+			sorted[key] = value[key];
+			return sorted;
+		}, {});
+		return value;
+	};
+	return JSON.stringify(left, replacer) === JSON.stringify(right, replacer);
+};
 var TerraformProvider = class {
 	configured;
 	plugin;
@@ -305,6 +315,16 @@ var TerraformProvider = class {
 		if (!data) throw new Error(`Data source not found ${type}`);
 		return { state: data };
 	}
+	async isRefreshStateEqual({ type, tag, priorInputState, priorOutputState, refreshedState }) {
+		if (tag === "data") return areStatesEqual(priorOutputState, refreshedState);
+		const plugin = await this.configure();
+		const mergedState = {
+			...refreshedState,
+			...priorInputState
+		};
+		const { requiresReplace, plannedState } = await plugin.planResourceChange(type, refreshedState, mergedState, priorInputState);
+		return requiresReplace.length === 0 && areStatesEqual(plannedState, refreshedState);
+	}
 };
 
 //#endregion
@@ -1997,6 +2017,16 @@ var IncorrectType = class extends TypeError {
 		super(`${path.join(".")} should be a ${type}`);
 	}
 };
+const isEmptyOutputValue = (value) => {
+	if (value === null || typeof value === "undefined") return true;
+	if (Array.isArray(value)) return value.length === 0;
+	if (typeof value === "object") return Object.keys(value).length === 0;
+	return false;
+};
+const shouldOmitOutputValue = (schema, value) => {
+	if (!(schema.optional || schema.computed)) return false;
+	return isEmptyOutputValue(value);
+};
 const formatInputState = (schema, state, includeSchemaFields = true, path = []) => {
 	if (state === null) return null;
 	if (typeof state === "undefined") return null;
@@ -2062,7 +2092,9 @@ const formatOutputState = (schema, state, path = []) => {
 			const object = {};
 			for (const [key, prop] of Object.entries(schema.properties)) {
 				const value = state[key];
-				object[camelCase(key)] = formatOutputState(prop, value, [...path, key]);
+				const formatted = formatOutputState(prop, value, [...path, key]);
+				if (shouldOmitOutputValue(prop, formatted)) continue;
+				object[camelCase(key)] = formatted;
 			}
 			return object;
 		}
@@ -2073,7 +2105,9 @@ const formatOutputState = (schema, state, path = []) => {
 			const object = {};
 			for (const [key, prop] of Object.entries(schema.properties)) {
 				const value = state[0][key];
-				object[camelCase(key)] = formatOutputState(prop, value, [...path, key]);
+				const formatted = formatOutputState(prop, value, [...path, key]);
+				if (shouldOmitOutputValue(prop, formatted)) continue;
+				object[camelCase(key)] = formatted;
 			}
 			return object;
 		} else return null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@terraforge/terraform",
-	"version": "0.0.19",
+	"version": "0.0.21",
 	"type": "module",
 	"repository": {
 		"type": "git",