codify-schemas 1.0.0 → 1.0.2

package/dist/config-file-schema.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/config-file-schema.json",
+    "title": "Config file Schema",
+    "type": "array",
+    "items": {
+        "$ref": "resource-schema.json"
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export { default as ConfigFileSchema } from './config-file-schema.json';
+export { default as ProjectSchema } from './project-schema.json';
+export { default as ResourceMetaSchema } from './resource-meta-schema.json';
+export { default as ResourceSchema } from './resource-schema.json';
+export { default as IpcMessageSchema } from './ipc-message-schema.json';
+export { default as ApplyRequestDataSchema } from './messages/apply-request-data-schema.json';
+export { default as ErrorResponseDataSchema } from './messages/error-response-data-schema.json';
+export { default as PlanRequestDataSchema } from './messages/plan-request-data-schema.json';
+export { default as PlanResponseDataSchema } from './messages/plan-response-data-schema.json';
+export { default as ValidateRequestDataSchema } from './messages/validate-request-data-schema.json';
+export { default as ValidateResponseDataSchema } from './messages/validate-response-data-schema.json';
+export * from './types';

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,qEAAwE;AAA/D,4IAAA,OAAO,OAAoB;AACpC,6DAAiE;AAAxD,qIAAA,OAAO,OAAiB;AACjC,yEAA4E;AAAnE,gJAAA,OAAO,OAAsB;AACtC,+DAAmE;AAA1D,uIAAA,OAAO,OAAkB;AAClC,qEAAwE;AAA/D,4IAAA,OAAO,OAAoB;AACpC,4FAA8F;AAArF,yJAAA,OAAO,OAA0B;AAC1C,8FAAgG;AAAvF,2JAAA,OAAO,OAA2B;AAC3C,0FAA4F;AAAnF,uJAAA,OAAO,OAAyB;AACzC,4FAA8F;AAArF,yJAAA,OAAO,OAA0B;AAC1C,kGAAoG;AAA3F,+JAAA,OAAO,OAA6B;AAC7C,oGAAsG;AAA7F,iKAAA,OAAO,OAA8B;AAC9C,0CAAwB"}

package/dist/ipc-message-schema.json

@@ -0,0 +1,21 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/ipc-message-schema.json",
+    "title": "IPC Message Schema",
+    "type": "object",
+    "properties": {
+        "cmd": {
+            "description": "The uri for the message. Like an http url",
+            "type": "string"
+        },
+        "status": {
+            "description": "The status of the request. Only used for responses. Can be either success or error",
+            "type": "string",
+            "enum": ["success", "error"]
+        },
+        "data": {
+            "description": "The data of the message."
+        }
+    },
+    "required": ["cmd", "data"]
+}

package/dist/messages/apply-request-data-schema.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/apply-request-data-schema.json",
+    "title": "Apply Request Schema Data",
+    "description": "Apply the previously generated plan. The plan must already be generated in order for apply to work.",
+    "type": "object",
+    "properties": {
+        "planId": {
+            "description": "The plan uuid. This id is used to look up the generated plan on the plugin side",
+            "type": "string",
+            "format": "uuid"
+        }
+    },
+    "required": ["planId"],
+    "additionalProperties": false
+}

package/dist/messages/error-response-data-schema.json

@@ -0,0 +1,14 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/error-response-data-schema.json",
+    "title": "Error Response Schema Data",
+    "type": "object",
+    "properties": {
+        "reason": {
+            "description": "A human read-able reason for the error",
+            "type": "string"
+        }
+    },
+    "required": ["reason"],
+    "additionalProperties": false
+}

package/dist/messages/plan-request-data-schema.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/plan-request-data-schema.json",
+    "title": "Plan Request Schema Data",
+    "$ref": "resource-schema.json"
+}

package/dist/messages/plan-response-data-schema.json

@@ -0,0 +1,53 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/plan-response-data-schema.json",
+    "title": "Plan Response Schema Data",
+    "type": "object",
+    "properties": {
+        "planId": {
+            "description": "The id of the plan to look up for the apply operation",
+            "type": "string",
+            "format": "uuid"
+        },
+        "operation": {
+            "description": "The plan operation",
+            "type": "string",
+            "enum": ["create", "destroy", "modify", "recreate", "noop"]
+        },
+        "resourceType": {
+            "description": "The resource type",
+            "type": "string"
+        },
+        "resourceName": {
+            "description": "The resource name",
+            "type": ["string", "null"]
+        },
+        "parameters": {
+            "description": "The properties come from the provided config and is not necessarily every parameter on the ",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "description": "The property name",
+                        "type": "string"
+                    },
+                    "operation": {
+                        "description": "The operation to be performed on the parameter",
+                        "type": "string",
+                        "enum": ["remove", "add", "modify", "noop"]
+                    },
+                    "previousValue": {
+                        "description": "The value before the change"
+                    },
+                    "newValue": {
+                        "description": "The new value"
+                    }
+                },
+                "required": ["name", "operation", "previousValue", "newValue"]
+            }
+        }
+    },
+    "required": ["planId", "operation", "resourceType", "parameters"],
+    "additionalProperties": false
+}

package/dist/messages/validate-request-data-schema.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/validate-request-data-schema.json",
+    "title": "Validate Request Schema Data",
+    "type": "object",
+    "properties": {
+        "configs": {
+            "type": "array",
+            "items": {
+                "$ref": "resource-schema.json"
+            }
+        }
+    },
+    "required": [],
+    "additionalProperties": false
+}

package/dist/messages/validate-response-data-schema.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/validate-response-data-schema.json",
+    "title": "Validate Response Schema Data",
+    "type": "null"
+}

package/dist/project-schema.json

@@ -0,0 +1,32 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/resource-schema.json",
+    "title": "Resource Schema",
+    "type": "object",
+    "properties": {
+        "type": {
+            "description": "All project configs are of the type project",
+            "type": "string",
+            "const": "project"
+        },
+        "version": {
+            "description": "Semver version. Codify will throw an error if this is not satisfied",
+            "type": "string",
+            "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z-]+)?$"
+        },
+        "plugins": {
+            "type": "object",
+            "patternProperties": {
+                ".*": {
+                    "type": "string"
+                }
+            }
+        },
+        "description": {
+            "description": "An optional description of the codify project",
+            "type": "string"
+        }
+    },
+    "additionalProperties": false,
+    "required": ["type"]
+}

package/dist/resource-meta-schema.json

@@ -0,0 +1,32 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "title": "Config file Schema",
+    "type": "object",
+    "properties": {
+        "$id": {
+            "type": "string",
+            "pattern": "^https://www.codify.com/"
+        },
+        "type": {
+            "const": "object"
+        },
+        "properties": {
+            "type": "object",
+            "properties": {
+                "type": false,
+                "name": false,
+                "dependsOn": false,
+                "$ref": {
+                    "const": "https://www.codify.com/resource-schema.json#properties"
+                }
+            }
+        },
+        "$ref": {
+            "const": "https://www.codify.com/resource-schema.json"
+        },
+        "unevaluatedProperties": {
+            "const": false
+        }
+    },
+    "required": ["unevaluatedProperties", "$ref"]
+}

package/dist/resource-schema.json

@@ -0,0 +1,26 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/resource-schema.json",
+    "title": "Resource Schema",
+    "type": "object",
+    "properties": {
+        "type": {
+            "description": "The resource type",
+            "type": "string",
+            "pattern": "^[a-zA-Z-_][\\w-]+$"
+        },
+        "name": {
+            "description": "Optional name. Useful for specifying multiple resources of the same type",
+            "type": "string",
+            "pattern": "^[a-zA-Z-_][\\w-]+$"
+        },
+        "dependsOn": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "uniqueItems": true
+        }
+    },
+    "required": ["type"]
+}

package/dist/types/index.d.ts

@@ -0,0 +1,54 @@
+export interface ProjectConfig {
+    type: string;
+    version?: string;
+    plugins?: Record<string, string>;
+    description?: string;
+}
+export interface ResourceConfig {
+    type: string;
+    name?: string;
+    dependsOn?: string[];
+}
+export declare enum MessageStatus {
+    SUCCESS = "success",
+    ERROR = "error"
+}
+export interface IpcMessage {
+    cmd: string;
+    status?: MessageStatus;
+    data: unknown | null;
+}
+export interface ValidateRequestData {
+    configs: ResourceConfig[];
+}
+export type ValidateResponseData = null;
+export interface PlanRequestData extends ResourceConfig {
+}
+export declare enum ResourceOperation {
+    CREATE = "create",
+    DESTROY = "destroy",
+    MODIFY = "modify",
+    RECREATE = "recreate",
+    NOOP = "noop"
+}
+export declare enum ParameterOperation {
+    ADD = "add",
+    REMOVE = "remove",
+    MODIFY = "modify",
+    NOOP = "noop"
+}
+export interface PlanResponseData {
+    planId: string;
+    operation: ResourceOperation;
+    resourceName?: string;
+    resourceType: string;
+    parameters: Array<{
+        name: string;
+        operation: ParameterOperation;
+        previousValue: string | null;
+        newValue: string | null;
+    }>;
+}
+export interface ApplyRequestData {
+    planId: string;
+}

package/dist/types/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParameterOperation = exports.ResourceOperation = exports.MessageStatus = void 0;
+var MessageStatus;
+(function (MessageStatus) {
+    MessageStatus["SUCCESS"] = "success";
+    MessageStatus["ERROR"] = "error";
+})(MessageStatus || (exports.MessageStatus = MessageStatus = {}));
+var ResourceOperation;
+(function (ResourceOperation) {
+    ResourceOperation["CREATE"] = "create";
+    ResourceOperation["DESTROY"] = "destroy";
+    ResourceOperation["MODIFY"] = "modify";
+    ResourceOperation["RECREATE"] = "recreate";
+    ResourceOperation["NOOP"] = "noop";
+})(ResourceOperation || (exports.ResourceOperation = ResourceOperation = {}));
+var ParameterOperation;
+(function (ParameterOperation) {
+    ParameterOperation["ADD"] = "add";
+    ParameterOperation["REMOVE"] = "remove";
+    ParameterOperation["MODIFY"] = "modify";
+    ParameterOperation["NOOP"] = "noop";
+})(ParameterOperation || (exports.ParameterOperation = ParameterOperation = {}));
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAaA,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAgBD,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,iCAAjB,iBAAiB,QAM5B;AAED,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-schemas",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",