codify-plugin-lib 1.0.13 → 1.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/entities/plan.d.ts +4 -4
- package/dist/entities/plugin.d.ts +1 -1
- package/dist/entities/resource.d.ts +8 -8
- package/dist/entities/resource.js +1 -1
- package/package.json +1 -1
- package/src/entities/plan.ts +4 -4
- package/src/entities/plugin.ts +1 -1
- package/src/entities/resource.test.ts +6 -6
- package/src/entities/resource.ts +9 -9
package/dist/entities/plan.d.ts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { ChangeSet } from './change-set';
|
|
2
2
|
import { PlanResponseData, ResourceConfig } from 'codify-schemas';
|
|
3
|
-
export declare class Plan {
|
|
3
|
+
export declare class Plan<T extends ResourceConfig> {
|
|
4
4
|
id: string;
|
|
5
5
|
changeSet: ChangeSet;
|
|
6
|
-
resourceConfig:
|
|
7
|
-
constructor(id: string, changeSet: ChangeSet, resourceConfig:
|
|
8
|
-
static create(changeSet: ChangeSet, resourceConfig:
|
|
6
|
+
resourceConfig: T;
|
|
7
|
+
constructor(id: string, changeSet: ChangeSet, resourceConfig: T);
|
|
8
|
+
static create<T extends ResourceConfig>(changeSet: ChangeSet, resourceConfig: T): Plan<T>;
|
|
9
9
|
getResourceType(): string;
|
|
10
10
|
toResponse(): PlanResponseData;
|
|
11
11
|
}
|
|
@@ -3,7 +3,7 @@ import { ApplyRequestData, PlanRequestData, PlanResponseData, ResourceConfig, Va
|
|
|
3
3
|
import { Plan } from './plan';
|
|
4
4
|
export declare class Plugin {
|
|
5
5
|
resources: Map<string, Resource<ResourceConfig>>;
|
|
6
|
-
planStorage: Map<string, Plan
|
|
6
|
+
planStorage: Map<string, Plan<ResourceConfig>>;
|
|
7
7
|
constructor(resources: Map<string, Resource<ResourceConfig>>);
|
|
8
8
|
onInitialize(): Promise<void>;
|
|
9
9
|
validate(data: ValidateRequestData): Promise<ValidateResponseData>;
|
|
@@ -6,13 +6,13 @@ export declare abstract class Resource<T extends ResourceConfig> {
|
|
|
6
6
|
constructor(dependencies?: Resource<any>[]);
|
|
7
7
|
abstract getTypeId(): string;
|
|
8
8
|
onInitialize(): Promise<void>;
|
|
9
|
-
plan(desiredConfig: T): Promise<Plan
|
|
10
|
-
apply(plan: Plan): Promise<void>;
|
|
11
|
-
abstract validate(config:
|
|
12
|
-
abstract getCurrentConfig(): Promise<T | null>;
|
|
9
|
+
plan(desiredConfig: T): Promise<Plan<T>>;
|
|
10
|
+
apply(plan: Plan<T>): Promise<void>;
|
|
11
|
+
abstract validate(config: unknown): Promise<boolean>;
|
|
12
|
+
abstract getCurrentConfig(desiredConfig: T): Promise<T | null>;
|
|
13
13
|
abstract calculateOperation(change: ParameterChange): ResourceOperation.MODIFY | ResourceOperation.RECREATE;
|
|
14
|
-
abstract applyCreate(plan: Plan): Promise<void>;
|
|
15
|
-
abstract applyModify(plan: Plan): Promise<void>;
|
|
16
|
-
abstract applyRecreate(plan: Plan): Promise<void>;
|
|
17
|
-
abstract applyDestroy(plan: Plan): Promise<void>;
|
|
14
|
+
abstract applyCreate(plan: Plan<T>): Promise<void>;
|
|
15
|
+
abstract applyModify(plan: Plan<T>): Promise<void>;
|
|
16
|
+
abstract applyRecreate(plan: Plan<T>): Promise<void>;
|
|
17
|
+
abstract applyDestroy(plan: Plan<T>): Promise<void>;
|
|
18
18
|
}
|
|
@@ -12,7 +12,7 @@ class Resource {
|
|
|
12
12
|
async onInitialize() { }
|
|
13
13
|
async plan(desiredConfig) {
|
|
14
14
|
await this.validate(desiredConfig);
|
|
15
|
-
const currentConfig = await this.getCurrentConfig();
|
|
15
|
+
const currentConfig = await this.getCurrentConfig(desiredConfig);
|
|
16
16
|
if (!currentConfig) {
|
|
17
17
|
return plan_1.Plan.create(change_set_1.ChangeSet.createForNullCurrentConfig(desiredConfig), desiredConfig);
|
|
18
18
|
}
|
package/package.json
CHANGED
package/src/entities/plan.ts
CHANGED
|
@@ -5,18 +5,18 @@ import {
|
|
|
5
5
|
} from 'codify-schemas';
|
|
6
6
|
import { randomUUID } from 'crypto';
|
|
7
7
|
|
|
8
|
-
export class Plan {
|
|
8
|
+
export class Plan<T extends ResourceConfig> {
|
|
9
9
|
id: string;
|
|
10
10
|
changeSet: ChangeSet;
|
|
11
|
-
resourceConfig:
|
|
11
|
+
resourceConfig: T
|
|
12
12
|
|
|
13
|
-
constructor(id: string, changeSet: ChangeSet, resourceConfig:
|
|
13
|
+
constructor(id: string, changeSet: ChangeSet, resourceConfig: T) {
|
|
14
14
|
this.id = id;
|
|
15
15
|
this.changeSet = changeSet;
|
|
16
16
|
this.resourceConfig = resourceConfig;
|
|
17
17
|
}
|
|
18
18
|
|
|
19
|
-
static create(changeSet: ChangeSet, resourceConfig:
|
|
19
|
+
static create<T extends ResourceConfig>(changeSet: ChangeSet, resourceConfig: T): Plan<T> {
|
|
20
20
|
return new Plan(
|
|
21
21
|
randomUUID(),
|
|
22
22
|
changeSet,
|
package/src/entities/plugin.ts
CHANGED
|
@@ -7,19 +7,19 @@ import { expect } from 'chai';
|
|
|
7
7
|
import { Plan } from './plan';
|
|
8
8
|
|
|
9
9
|
class TestResource extends Resource<TestConfig> {
|
|
10
|
-
applyCreate(plan: Plan): Promise<void> {
|
|
10
|
+
applyCreate(plan: Plan<TestConfig>): Promise<void> {
|
|
11
11
|
return Promise.resolve(undefined);
|
|
12
12
|
}
|
|
13
13
|
|
|
14
|
-
applyDestroy(plan: Plan): Promise<void> {
|
|
14
|
+
applyDestroy(plan: Plan<TestConfig>): Promise<void> {
|
|
15
15
|
return Promise.resolve(undefined);
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
-
applyModify(plan: Plan): Promise<void> {
|
|
18
|
+
applyModify(plan: Plan<TestConfig>): Promise<void> {
|
|
19
19
|
return Promise.resolve(undefined);
|
|
20
20
|
}
|
|
21
21
|
|
|
22
|
-
applyRecreate(plan: Plan): Promise<void> {
|
|
22
|
+
applyRecreate(plan: Plan<TestConfig>): Promise<void> {
|
|
23
23
|
return Promise.resolve(undefined);
|
|
24
24
|
}
|
|
25
25
|
|
|
@@ -156,7 +156,7 @@ describe('Resource tests', () => {
|
|
|
156
156
|
const result = await resourceSpy.apply(
|
|
157
157
|
Plan.create(
|
|
158
158
|
new ChangeSet(ResourceOperation.CREATE, []),
|
|
159
|
-
{ type: 'resource' }
|
|
159
|
+
{ type: 'resource', propA: 'a', propB: 0 }
|
|
160
160
|
)
|
|
161
161
|
)
|
|
162
162
|
|
|
@@ -174,7 +174,7 @@ describe('Resource tests', () => {
|
|
|
174
174
|
const result = await resourceSpy.apply(
|
|
175
175
|
Plan.create(
|
|
176
176
|
new ChangeSet(ResourceOperation.DESTROY, []),
|
|
177
|
-
{ type: 'resource' }
|
|
177
|
+
{ type: 'resource', propA: 'a', propB: 0 }
|
|
178
178
|
)
|
|
179
179
|
)
|
|
180
180
|
|
package/src/entities/resource.ts
CHANGED
|
@@ -14,10 +14,10 @@ export abstract class Resource<T extends ResourceConfig> {
|
|
|
14
14
|
|
|
15
15
|
// TODO: Add state in later.
|
|
16
16
|
// Calculate change set from current config -> state -> desired in the future
|
|
17
|
-
async plan(desiredConfig: T): Promise<Plan
|
|
17
|
+
async plan(desiredConfig: T): Promise<Plan<T>> {
|
|
18
18
|
await this.validate(desiredConfig);
|
|
19
19
|
|
|
20
|
-
const currentConfig = await this.getCurrentConfig();
|
|
20
|
+
const currentConfig = await this.getCurrentConfig(desiredConfig);
|
|
21
21
|
if (!currentConfig) {
|
|
22
22
|
return Plan.create(ChangeSet.createForNullCurrentConfig(desiredConfig), desiredConfig);
|
|
23
23
|
}
|
|
@@ -42,7 +42,7 @@ export abstract class Resource<T extends ResourceConfig> {
|
|
|
42
42
|
);
|
|
43
43
|
}
|
|
44
44
|
|
|
45
|
-
async apply(plan: Plan): Promise<void> {
|
|
45
|
+
async apply(plan: Plan<T>): Promise<void> {
|
|
46
46
|
if (plan.getResourceType() !== this.getTypeId()) {
|
|
47
47
|
throw new Error(`Internal error: Plan set to wrong resource during apply. Expected ${this.getTypeId()} but got: ${plan.getResourceType()}`);
|
|
48
48
|
}
|
|
@@ -55,17 +55,17 @@ export abstract class Resource<T extends ResourceConfig> {
|
|
|
55
55
|
}
|
|
56
56
|
}
|
|
57
57
|
|
|
58
|
-
abstract validate(config:
|
|
58
|
+
abstract validate(config: unknown): Promise<boolean>;
|
|
59
59
|
|
|
60
|
-
abstract getCurrentConfig(): Promise<T | null>;
|
|
60
|
+
abstract getCurrentConfig(desiredConfig: T): Promise<T | null>;
|
|
61
61
|
|
|
62
62
|
abstract calculateOperation(change: ParameterChange): ResourceOperation.MODIFY | ResourceOperation.RECREATE;
|
|
63
63
|
|
|
64
|
-
abstract applyCreate(plan: Plan): Promise<void>;
|
|
64
|
+
abstract applyCreate(plan: Plan<T>): Promise<void>;
|
|
65
65
|
|
|
66
|
-
abstract applyModify(plan: Plan): Promise<void>;
|
|
66
|
+
abstract applyModify(plan: Plan<T>): Promise<void>;
|
|
67
67
|
|
|
68
|
-
abstract applyRecreate(plan: Plan): Promise<void>;
|
|
68
|
+
abstract applyRecreate(plan: Plan<T>): Promise<void>;
|
|
69
69
|
|
|
70
|
-
abstract applyDestroy(plan:Plan): Promise<void>;
|
|
70
|
+
abstract applyDestroy(plan:Plan<T>): Promise<void>;
|
|
71
71
|
}
|