@devtron-labs/devtron-fe-common-lib 0.0.81-beta-8 → 0.0.82-1

package/dist/Shared/types.d.ts

@@ -1,4 +1,5 @@
-import { CommonNodeAttr, ResponseType, UserApprovalConfigType, VulnerabilityType } from '../Common';
+import { PatchOperationType } from './constants';
+import { OptionType, CommonNodeAttr, ResponseType, UserApprovalConfigType, VulnerabilityType } from '../Common';
 
 export declare enum RegistryType {
     GIT = "git",
@@ -95,6 +96,88 @@ export declare enum CIMaterialSidebarType {
     CODE_SOURCE = "Code Source",
     PARAMETERS = "Parameters"
 }
+/**
+ * @example Usage with specific enum for path & `unknown` type for value
+ * ```ts
+ * enum PatchKeys {
+ *  name = 'name',
+ *  description = 'description',
+ * }
+ *
+ * const query: PatchQueryType<PatchKeys> = {
+ *  op: PatchOperationType.replace,
+ *  path: PatchKeys.name,
+ *  value: '1'
+ * }
+ * ```
+ *
+ * @example Usage with specific enum for path & custom type for value
+ * ```ts
+ * enum PatchKeys {
+ *  name = 'name',
+ *  description = 'description',
+ * }
+ *
+ * const query: PatchQueryType<PatchKeys, number> = {
+ *  op: PatchOperationType.replace,
+ *  path: PatchKeys.name,
+ *  value: 1
+ * }
+ * ```
+ *
+ * @example Usage with `PatchOperationType.remove`
+ * Note: Value is not allowed for remove operation
+ *
+ * ```ts
+ * const query: PatchQueryType<string> = {
+ *  op: PatchOperationType.remove,
+ *  path: 'name'
+ * }
+ * ```
+ */
+export type PatchQueryType<T extends string, K = unknown> = {
+    /**
+     * The path of the json to be patched
+     */
+    path: T;
+} & ({
+    /**
+     * Operation type for patch
+     */
+    op: PatchOperationType.replace;
+    /**
+     * Corresponding value for the operation
+     */
+    value: K;
+} | {
+    /**
+     * Operation type for patch
+     */
+    op: PatchOperationType.remove;
+    value?: never;
+});
+export interface GroupedOptionsType {
+    label: string;
+    options: OptionType[];
+}
+/**
+ * Enum for devtron resources
+ */
+export declare enum ResourceKindType {
+    devtronApplication = "application/devtron-application",
+    helmChart = "application/helm-application",
+    job = "job",
+    cluster = "cluster",
+    release = "release",
+    releaseTrack = "release-track"
+}
+/**
+ * Versions support for the resources on BE
+ */
+export declare enum ResourceVersionType {
+    v1 = "v1",
+    alpha1 = "alpha1"
+}
 export interface LastExecutionResultType {
     lastExecution: string;
     severityCount: {
@@ -122,6 +205,10 @@ export interface MaterialSecurityInfoType {
     isScanned: boolean;
     isScanEnabled: boolean;
 }
+export declare enum WebhookEventNameType {
+    PULL_REQUEST = "Pull Request",
+    TAG_CREATION = "Tag Creation"
+}
 export declare enum Nodes {
     Service = "Service",
     Alertmanager = "Alertmanager",
@@ -166,15 +253,3 @@ export declare enum Nodes {
     Overview = "Overview"
 }
 export type NodeType = keyof typeof Nodes;
-export declare enum AggregationKeys {
-    Workloads = "Workloads",
-    Networking = "Networking",
-    'Config & Storage' = "Config & Storage",
-    RBAC = "RBAC",
-    Administration = "Administration",
-    'Custom Resource' = "Custom Resource",
-    'Other Resources' = "Other Resources",
-    Events = "Events",
-    Namespaces = "Namespaces"
-}
-export type AggregationKeysType = keyof typeof AggregationKeys;

package/dist/Shared/validations.d.ts

@@ -2,7 +2,16 @@ export interface ValidationResponseType {
     isValid: boolean;
     message?: string;
 }
-export declare const requiredField: (value: string) => ValidationResponseType;
+export declare const MESSAGES: {
+    PROVIDE_A_NUMBER: string;
+    LOWERCASE_ALPHANUMERIC: string;
+    CAN_NOT_START_END_WITH_SEPARATORS: string;
+    getMinMaxCharMessage: (min: number, max: number) => string;
+    getMaxCharMessage: (max: number) => string;
+    VALID_POSITIVE_NUMBER: string;
+    VALID_POSITIVE_INTEGER: string;
+    MAX_SAFE_INTEGER: string;
+};
 export declare const validateName: (name: string) => ValidationResponseType;
 export declare const validateDescription: (description: string) => ValidationResponseType;
 export declare const validateRequiredPositiveNumber: (value: string | number) => ValidationResponseType;