codify-plugin-lib 1.0.91 → 1.0.94

package/dist/messages/handlers.js

@@ -1,6 +1,6 @@
 import { Ajv } from 'ajv';
 import addFormats from 'ajv-formats';
-import { ApplyRequestDataSchema, ApplyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
+import { ApplyRequestDataSchema, ApplyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
 import { SudoError } from '../errors.js';
 const SupportedRequests = {
     'initialize': {
@@ -18,6 +18,11 @@ const SupportedRequests = {
         requestValidator: GetResourceInfoRequestDataSchema,
         responseValidator: GetResourceInfoResponseDataSchema
     },
+    'import': {
+        handler: async (plugin, data) => plugin.import(data),
+        requestValidator: ImportRequestDataSchema,
+        responseValidator: ImportResponseDataSchema
+    },
     'plan': {
         handler: async (plugin, data) => plugin.plan(data),
         requestValidator: PlanRequestDataSchema,

package/dist/plugin/plugin.d.ts

@@ -1,4 +1,4 @@
-import { ApplyRequestData, GetResourceInfoRequestData, GetResourceInfoResponseData, InitializeResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
+import { ApplyRequestData, GetResourceInfoRequestData, GetResourceInfoResponseData, ImportRequestData, ImportResponseData, InitializeResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
 import { Plan } from '../plan/plan.js';
 import { Resource } from '../resource/resource.js';
 import { ResourceController } from '../resource/resource-controller.js';
@@ -10,6 +10,7 @@ export declare class Plugin {
     static create(name: string, resources: Resource<any>[]): Plugin;
     initialize(): Promise<InitializeResponseData>;
     getResourceInfo(data: GetResourceInfoRequestData): Promise<GetResourceInfoResponseData>;
+    import(data: ImportRequestData): Promise<ImportResponseData>;
     validate(data: ValidateRequestData): Promise<ValidateResponseData>;
     plan(data: PlanRequestData): Promise<PlanResponseData>;
     apply(data: ApplyRequestData): Promise<void>;

package/dist/plugin/plugin.js

@@ -32,11 +32,30 @@ export class Plugin {
             throw new Error(`Cannot get info for resource ${data.type}, resource doesn't exist`);
         }
         const resource = this.resourceControllers.get(data.type);
+        const schema = resource.settings.schema;
+        const requiredPropertyNames = (resource.settings.import?.requiredParameters
+            ?? schema.required
+            ?? null);
         return {
             plugin: this.name,
             type: data.type,
             dependencies: resource.dependencies,
-            schema: resource.settings.schema
+            schema: schema,
+            import: resource.settings.import ? {
+                requiredParameters: requiredPropertyNames,
+            } : undefined,
+        };
+    }
+    async import(data) {
+        if (!this.resourceControllers.has(data.config.type)) {
+            throw new Error(`Cannot get info for resource ${data.config.type}, resource doesn't exist`);
+        }
+        const result = await this.resourceControllers
+            .get(data.config.type)
+            ?.import(data.config);
+        return {
+            request: data.config,
+            result: result ?? [],
         };
     }
     async validate(data) {

package/dist/resource/resource-controller.d.ts

@@ -17,6 +17,7 @@ export declare class ResourceController<T extends StringIndexedObject> {
     validate(desiredConfig: Partial<T> & ResourceConfig): Promise<ValidateResponseData['resourceValidations'][0]>;
     plan(desiredConfig: Partial<T> & ResourceConfig | null, stateConfig?: Partial<T> & ResourceConfig | null, statefulMode?: boolean): Promise<Plan<T>>;
     apply(plan: Plan<T>): Promise<void>;
+    import(config: Partial<T> & ResourceConfig): Promise<(Partial<T> & ResourceConfig)[] | null>;
     private applyCreate;
     private applyModify;
     private applyDestroy;
@@ -27,4 +28,5 @@ export declare class ResourceController<T extends StringIndexedObject> {
     private refreshStatefulParameters;
     private validatePlanInputs;
     private getSortedStatefulParameterChanges;
+    private getAllParameterKeys;
 }

package/dist/resource/resource-controller.js

@@ -130,6 +130,30 @@ export class ResourceController {
             }
         }
     }
+    async import(config) {
+        this.addDefaultValues(config);
+        await this.applyTransformParameters(config);
+        // Try to refresh as many parameters as possible here
+        const parametersToRefresh = {
+            ...Object.fromEntries(this.getAllParameterKeys().map((k) => [k, null])),
+            ...config,
+        };
+        // Parse data from the user supplied config
+        const parsedConfig = new ConfigParser(parametersToRefresh, null, this.parsedSettings.statefulParameters);
+        const { allNonStatefulParameters, allStatefulParameters, coreParameters, } = parsedConfig;
+        const currentParametersArray = await this.refreshNonStatefulParameters(allNonStatefulParameters);
+        if (currentParametersArray === null
+            || currentParametersArray === undefined
+            || this.settings.allowMultiple // Stateful parameters are not supported currently if allowMultiple is true
+            || currentParametersArray.length === 0
+            || currentParametersArray.filter(Boolean).length === 0) {
+            return currentParametersArray
+                ?.map((r) => ({ ...coreParameters, ...r }))
+                ?? null;
+        }
+        const statefulCurrentParameters = await this.refreshStatefulParameters(allStatefulParameters, parametersToRefresh);
+        return [{ ...coreParameters, ...currentParametersArray[0], ...statefulCurrentParameters }];
+    }
     async applyCreate(plan) {
         await this.resource.create(plan);
         const statefulParameterChanges = this.getSortedStatefulParameterChanges(plan.changeSet.parameterChanges);
@@ -253,4 +277,9 @@ ${JSON.stringify(refresh, null, 2)}
             .filter((pc) => this.parsedSettings.statefulParameters.has(pc.name))
             .sort((a, b) => this.parsedSettings.statefulParameterOrder.get(a.name) - this.parsedSettings.statefulParameterOrder.get(b.name));
     }
+    getAllParameterKeys() {
+        return this.settings.schema
+            ? Object.keys(this.settings.schema?.properties)
+            : Object.keys(this.parsedSettings.parameterSettings);
+    }
 }

package/dist/resource/resource-settings.d.ts

@@ -52,6 +52,9 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      * @param desired
      */
     inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
+    import?: {
+        requiredParameters: Array<Partial<keyof T>>;
+    };
 }
 /**
  * The type of parameter. This value is mainly used to determine a pre-set equality method for comparing the current

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.91",
+  "version": "1.0.94",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,7 +14,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.49",
+    "codify-schemas": "1.0.52",
     "@npmcli/promise-spawn": "^7.0.1",
     "uuid": "^10.0.0"
   },

package/src/messages/handlers.ts

@@ -5,6 +5,8 @@ import {
   ApplyResponseDataSchema,
   GetResourceInfoRequestDataSchema,
   GetResourceInfoResponseDataSchema,
+  ImportRequestDataSchema,
+  ImportResponseDataSchema,
   InitializeRequestDataSchema,
   InitializeResponseDataSchema,
   IpcMessage,
@@ -36,6 +38,11 @@ const SupportedRequests: Record<string, { handler: (plugin: Plugin, data: any) =
     requestValidator: GetResourceInfoRequestDataSchema,
     responseValidator: GetResourceInfoResponseDataSchema
   },
+  'import': {
+    handler: async (plugin: Plugin, data: any) => plugin.import(data),
+    requestValidator: ImportRequestDataSchema,
+    responseValidator: ImportResponseDataSchema
+  },
   'plan': {
     handler: async (plugin: Plugin, data: any) => plugin.plan(data),
     requestValidator: PlanRequestDataSchema,

package/src/plugin/plugin.ts

@@ -1,7 +1,10 @@
+import { JSONSchemaType } from 'ajv';
 import {
   ApplyRequestData,
   GetResourceInfoRequestData,
   GetResourceInfoResponseData,
+  ImportRequestData,
+  ImportResponseData,
   InitializeResponseData,
   PlanRequestData,
   PlanResponseData,
@@ -56,11 +59,36 @@ export class Plugin {
 
     const resource = this.resourceControllers.get(data.type)!;
 
+    const schema = resource.settings.schema as JSONSchemaType<any>;
+    const requiredPropertyNames = (
+      resource.settings.import?.requiredParameters
+        ?? schema.required 
+        ?? null
+    ) as null | string[];
+
     return {
       plugin: this.name,
       type: data.type,
       dependencies: resource.dependencies,
-      schema: resource.settings.schema as Record<string, unknown> | undefined
+      schema: schema as Record<string, unknown> | undefined,
+      import: resource.settings.import ? {
+        requiredParameters: requiredPropertyNames,
+      } : undefined,
+    }
+  }
+
+  async import(data: ImportRequestData): Promise<ImportResponseData> {
+    if (!this.resourceControllers.has(data.config.type)) {
+      throw new Error(`Cannot get info for resource ${data.config.type}, resource doesn't exist`);
+    }
+
+    const result = await this.resourceControllers
+      .get(data.config.type!)
+      ?.import(data.config);
+
+    return {
+      request: data.config,
+      result: result ?? [],
     }
   }
 

package/src/resource/resource-controller.ts

@@ -185,6 +185,43 @@ export class ResourceController<T extends StringIndexedObject> {
     }
   }
 
+  async import(config: Partial<T> & ResourceConfig): Promise<(Partial<T> & ResourceConfig)[] | null> {
+    this.addDefaultValues(config);
+    await this.applyTransformParameters(config);
+
+    // Try to refresh as many parameters as possible here
+    const parametersToRefresh = {
+      ...Object.fromEntries(
+        this.getAllParameterKeys().map((k) => [k, null])
+      ),
+      ...config,
+    };
+
+    // Parse data from the user supplied config
+    const parsedConfig = new ConfigParser(parametersToRefresh, null, this.parsedSettings.statefulParameters)
+    const {
+      allNonStatefulParameters,
+      allStatefulParameters,
+      coreParameters,
+    } = parsedConfig;
+
+    const currentParametersArray = await this.refreshNonStatefulParameters(allNonStatefulParameters);
+
+    if (currentParametersArray === null
+      || currentParametersArray === undefined
+      || this.settings.allowMultiple // Stateful parameters are not supported currently if allowMultiple is true
+      || currentParametersArray.length === 0
+      || currentParametersArray.filter(Boolean).length === 0
+    ) {
+      return currentParametersArray
+          ?.map((r) => ({ ...coreParameters, ...r }))
+        ?? null;
+    }
+
+    const statefulCurrentParameters = await this.refreshStatefulParameters(allStatefulParameters, parametersToRefresh);
+    return [{ ...coreParameters, ...currentParametersArray[0], ...statefulCurrentParameters }];
+  }
+
   private async applyCreate(plan: Plan<T>): Promise<void> {
     await this.resource.create(plan as CreatePlan<T>);
 
@@ -349,5 +386,10 @@ ${JSON.stringify(refresh, null, 2)}
       )
   }
 
+  private getAllParameterKeys(): string[] {
+    return this.settings.schema
+      ? Object.keys((this.settings.schema as any)?.properties)
+      : Object.keys(this.parsedSettings.parameterSettings);
+  }
 }
 

package/src/resource/resource-settings.test.ts

@@ -524,4 +524,20 @@ describe('Resource parameter tests', () => {
     expect(plan.currentConfig?.propB).to.eq(10);
     expect(plan.currentConfig?.propC).to.be.undefined;
   })
+
+  it('Allows import required parameters customization', () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          import: {
+            requiredParameters: [
+              'propA',
+              'propB',
+            ]
+          }
+        }
+      }
+    };
+  })
 })

package/src/resource/resource-settings.ts

@@ -64,6 +64,10 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    * @param desired
    */
   inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
+
+  import?: {
+    requiredParameters: Array<Partial<keyof T>>;
+  }
 }
 
 /**