@rockcarver/frodo-lib 4.10.0 → 4.11.0-1

package/types/ops/cloud/ServiceAccountOps.d.ts

@@ -0,0 +1,86 @@
+import { IdObjectSkeletonInterface } from '../../api/ApiTypes';
+import { State } from '../../shared/State';
+import { JwkRsa, JwksInterface } from '../JoseOps';
+import { AccessTokenMetaType } from '../OAuth2OidcOps';
+export type ServiceAccount = {
+    /**
+     * Check if service accounts are available
+     * @returns {Promise<boolean>} true if service accounts are available, false otherwise
+     */
+    isServiceAccountsFeatureAvailable(): Promise<boolean>;
+    /**
+     * Create service account
+     * @param {string} name Human-readable name of service account
+     * @param {string} description Description of service account
+     * @param {'Active' | 'Inactive'} accountStatus Service account status
+     * @param {string[]} scopes Scopes.
+     * @param {JwksInterface} jwks Java Web Key Set
+     * @returns {Promise<IdObjectSkeletonInterface>} A promise resolving to a service account object
+     */
+    createServiceAccount(name: string, description: string, accountStatus: 'active' | 'inactive', scopes: string[], jwks: JwksInterface): Promise<IdObjectSkeletonInterface>;
+    /**
+     * Get service account
+     * @param {string} serviceAccountId service account id
+     * @returns {Promise<ServiceAccountType>} a promise resolving to a service account object
+     */
+    getServiceAccount(serviceAccountId: string): Promise<ServiceAccountType>;
+    /**
+     * Validate service account
+     * @param {string} saId optional service account id
+     * @param {JwkRsa} saJwk optional service account JWK
+     * @returns {Promise<AccessTokenMetaType | null>} Access token or null if validation fails
+     */
+    validateServiceAccount(saId?: string, saJwk?: JwkRsa): Promise<AccessTokenMetaType | null>;
+};
+declare const _default: (state: State) => ServiceAccount;
+export default _default;
+export declare const SERVICE_ACCOUNT_ALLOWED_SCOPES: string[];
+export declare const SERVICE_ACCOUNT_DEFAULT_SCOPES: string[];
+export type ServiceAccountType = IdObjectSkeletonInterface & {
+    name: string;
+    description: string;
+    accountStatus: 'active' | 'inactive';
+    scopes: string[];
+    jwks: string;
+};
+/**
+ * Check if service accounts are available
+ * @returns {Promise<boolean>} true if service accounts are available, false otherwise
+ */
+export declare function isServiceAccountsFeatureAvailable({ state, }: {
+    state: State;
+}): Promise<boolean>;
+/**
+ * Create service account
+ * @param {string} name Human-readable name of service account
+ * @param {string} description Description of service account
+ * @param {'active' | 'inactive'} accountStatus Service account status
+ * @param {string[]} scopes Scopes.
+ * @param {JwksInterface} jwks Java Web Key Set
+ * @param {State} state library state
+ * @returns {Promise<ServiceAccountType>} A promise resolving to a service account object
+ */
+export declare function createServiceAccount({ name, description, accountStatus, scopes, jwks, state, }: {
+    name: string;
+    description: string;
+    accountStatus: 'active' | 'inactive';
+    scopes: string[];
+    jwks: JwksInterface;
+    state: State;
+}): Promise<ServiceAccountType>;
+/**
+ * Get service account
+ * @param {string} serviceAccountId service account id
+ * @param {State} state library state
+ * @returns {Promise} a promise resolving to a service account object
+ */
+export declare function getServiceAccount({ serviceAccountId, state, }: {
+    serviceAccountId: string;
+    state: State;
+}): Promise<ServiceAccountType>;
+export declare function validateServiceAccount({ saId, saJwk, state, }: {
+    saId?: string;
+    saJwk?: JwkRsa;
+    state: State;
+}): Promise<AccessTokenMetaType | null>;
+//# sourceMappingURL=ServiceAccountOps.d.ts.map

package/types/ops/cloud/ServiceAccountOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceAccountOps.d.ts","sourceRoot":"","sources":["../../../src/ops/cloud/ServiceAccountOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAM/D,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAI3C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAGvD,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,iCAAiC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACtD;;;;;;;;OAQG;IACH,oBAAoB,CAClB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,QAAQ,GAAG,UAAU,EACpC,MAAM,EAAE,MAAM,EAAE,EAChB,IAAI,EAAE,aAAa,GAClB,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC;;;;OAIG;IACH,iBAAiB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACzE;;;;;OAKG;IACH,sBAAsB,CACpB,IAAI,CAAC,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAC;CACxC,CAAC;yBAEc,OAAO,KAAK,KAAG,cAAc;AAA7C,wBA+BE;AAMF,eAAO,MAAM,8BAA8B,EAAE,MAAM,EA0BlD,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,MAAM,EAmBlD,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,QAAQ,GAAG,UAAU,CAAC;IACrC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,wBAAsB,iCAAiC,CAAC,EACtD,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAcnB;AAED;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,IAAI,EACJ,WAAW,EACX,aAAa,EACb,MAAM,EACN,IAAI,EACJ,KAAK,GACN,EAAE;IACD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,QAAQ,GAAG,UAAU,CAAC;IACrC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA+B9B;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,+BA2BA;AAED,wBAAsB,sBAAsB,CAAC,EAC3C,IAAgB,EAChB,KAAiB,EACjB,KAAK,GACN,EAAE;IACD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAetC"}

package/types/ops/cloud/StartupOps.d.ts

@@ -0,0 +1,62 @@
+import { RestartStatus } from '../../api/cloud/StartupApi';
+import { State } from '../../shared/State';
+export type Startup = {
+    /**
+     * Check for updates that need applying
+     * @returns {Promise<Updates>} true if there are updates that need to be applied, false otherwise
+     */
+    checkForUpdates(): Promise<Updates>;
+    /**
+     * Apply updates
+     * @param {boolean} wait wait for the operation to complete or not
+     * @param {number} timeout timeout in milliseconds
+     * @returns {Promise<boolean>} true if successful, false otherwise
+     */
+    applyUpdates(wait: boolean, timeout?: number): Promise<boolean>;
+    /**
+     * Get the current restart status of the environment
+     * @returns {Promise<RestartStatus>} the current restart status
+     */
+    readStatus(): Promise<RestartStatus>;
+};
+declare const _default: (state: State) => Startup;
+export default _default;
+/**
+ * Updates that need to be applied.
+ */
+export interface Updates {
+    /**
+     * Array of secrets that need applying
+     */
+    secrets?: unknown[];
+    /**
+     * Array of variables that need applying
+     */
+    variables?: unknown[];
+}
+/**
+ * Get the current restart status of the environment
+ * @returns {Promise<RestartStatus>} the current restart status
+ */
+export declare function readStatus({ state, }: {
+    state: State;
+}): Promise<RestartStatus>;
+/**
+ * Check for updates that need applying
+ * @returns {Promise<boolean>} true if there are updates that need to be applied, false otherwise
+ */
+export declare function checkForUpdates({ state, }: {
+    state: State;
+}): Promise<Updates>;
+/**
+ * Apply updates
+ * @param {boolean} wait wait for the operation to complete or not
+ * @param {number} timeout timeout in milliseconds
+ * @returns {Promise<boolean>} true if successful, false otherwise
+ */
+export declare function applyUpdates({ wait, timeout, state, }: {
+    wait: boolean;
+    timeout?: number;
+    state: State;
+}): Promise<boolean>;
+//# sourceMappingURL=StartupOps.d.ts.map

package/types/ops/cloud/StartupOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StartupOps.d.ts","sourceRoot":"","sources":["../../../src/ops/cloud/StartupOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EACd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAS3C,MAAM,MAAM,OAAO,GAAG;IACpB;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAChE;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;CACtC,CAAC;yBAEc,OAAO,KAAK,KAAG,OAAO;AAAtC,wBAgCE;AAEF;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAEzB;AACD;;;GAGG;AACH,wBAAsB,eAAe,CAAC,EACpC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAwCnB;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,EACjC,IAAI,EACJ,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,oBAuFA"}

package/types/ops/cloud/TelemetryOps.d.ts

@@ -0,0 +1,109 @@
+import { LogExporterSkeleton, TelemetryExporterCategory, TelemetryExporters } from '../../api/cloud/TelemetryApi';
+import { State } from '../../shared/State';
+import { ExportMetaData } from '../OpsTypes';
+export type Telemetry = {
+    /**
+     * Read all telemetry exporters
+     * @returns {Promise<TelemetryExporters>} a promise resolving to the telemetry exporters
+     */
+    readTelemetry(): Promise<TelemetryExporters>;
+    /**
+     * Export telemetry exporters, optionally filtered by id and/or category
+     * @param {string} exporterId optional exporter id to filter by
+     * @param {TelemetryExporterCategory} category optional category to filter by
+     * @returns {Promise<TelemetryExportInterface[]>} a promise resolving to a TelemetryExportInterface object
+     */
+    exportTelemetry(exporterId?: string, category?: TelemetryExporterCategory): Promise<TelemetryExportInterface>;
+    /**
+     * Import telemetry exporters
+     * @param {TelemetryExportInterface} importData telemetry import data
+     * @param {string} exporterId optional exporter id; if provided, only imports the specified exporter
+     * @param {TelemetryExporterCategory} category optional exporter category; if provided, only imports exporters of the specified category
+     * @returns {Promise<LogExporterSkeleton[]>} the imported log exporters
+     */
+    importTelemetry(importData: TelemetryExportInterface, exporterId?: string, category?: TelemetryExporterCategory): Promise<LogExporterSkeleton[]>;
+    /**
+     * Create or update a telemetry exporter
+     * @param {TelemetryExporterCategory} category exporter category
+     * @param {string} exporterId exporter id
+     * @param {LogExporterSkeleton} exporterData exporter configuration
+     * @returns {Promise<LogExporterSkeleton>} the updated exporter
+     */
+    updateTelemetry(category: TelemetryExporterCategory, exporterId: string, exporterData: LogExporterSkeleton): Promise<LogExporterSkeleton>;
+    /**
+     * Delete telemetry exporters
+     * @param {string} exporterId optional exporter id; if provided, only deletes the specified exporter
+     * @param {TelemetryExporterCategory} category optional exporter category; if provided, only deletes exporters in the specified category
+     * @returns {Promise<LogExporterSkeleton[]>}
+     */
+    deleteTelemetry(exporterId?: string, category?: TelemetryExporterCategory): Promise<LogExporterSkeleton[]>;
+};
+declare const _default: (state: State) => Telemetry;
+export default _default;
+export interface TelemetryExportInterface {
+    meta?: ExportMetaData;
+    telemetry: TelemetryExporters;
+}
+/**
+ * Create an empty telemetry export template
+ * @returns {TelemetryExportInterface} an empty telemetry export template
+ */
+export declare function createTelemetryExportTemplate({ state, }: {
+    state: State;
+}): TelemetryExportInterface;
+/**
+ * Read all telemetry exporters
+ * @returns {Promise<TelemetryExporters>} a promise resolving to telemetry exporters
+ */
+export declare function readTelemetry({ state, }: {
+    state: State;
+}): Promise<TelemetryExporters>;
+/**
+ * Export telemetry exporters, optionally filtered by id and/or category
+ * @param {string} exporterId optional exporter id to filter by
+ * @param {TelemetryExporterCategory} category optional category to filter by
+ * @returns {Promise<TelemetryExportInterface>} a promise resolving to a TelemetryExportInterface object
+ */
+export declare function exportTelemetry({ exporterId, category, state, }: {
+    exporterId?: string;
+    category?: TelemetryExporterCategory;
+    state: State;
+}): Promise<TelemetryExportInterface>;
+/**
+ * Import telemetry exporters
+ * @param {string} exporterId optional exporter id; if provided, only imports the specified exporter
+ * @param {TelemetryExporterCategory} category optional exporter category; if provided, only imports exporters of the specified category
+ * @param {TelemetryExportInterface} importData telemetry import data
+ * @returns {Promise<LogExporterSkeleton[]>} the imported telemetry exporters
+ */
+export declare function importTelemetry({ exporterId, category, importData, state, }: {
+    exporterId?: string;
+    category?: TelemetryExporterCategory;
+    importData: TelemetryExportInterface;
+    state: State;
+}): Promise<LogExporterSkeleton[]>;
+/**
+ * Create or update a single telemetry exporter
+ * @param {TelemetryExporterCategory} category exporter category
+ * @param {string} exporterId exporter id
+ * @param {LogExporterSkeleton} exporterData exporter data
+ * @returns {Promise<LogExporterSkeleton>} the created/updated exporter
+ */
+export declare function updateTelemetry({ category, exporterId, exporterData, state, }: {
+    category: TelemetryExporterCategory;
+    exporterId: string;
+    exporterData: LogExporterSkeleton;
+    state: State;
+}): Promise<LogExporterSkeleton>;
+/**
+ * Delete telemetry exporters
+ * @param {string} exporterId optional exporter id
+ * @param {TelemetryExporterCategory} category optional exporter category
+ * @returns {Promise<LogExporterSkeleton[]>}
+ */
+export declare function deleteTelemetry({ exporterId, category, state, }: {
+    exporterId?: string;
+    category?: TelemetryExporterCategory;
+    state: State;
+}): Promise<LogExporterSkeleton[]>;
+//# sourceMappingURL=TelemetryOps.d.ts.map

package/types/ops/cloud/TelemetryOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TelemetryOps.d.ts","sourceRoot":"","sources":["../../../src/ops/cloud/TelemetryOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,mBAAmB,EAEnB,yBAAyB,EACzB,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAS3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB;;;OAGG;IACH,aAAa,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7C;;;;;OAKG;IACH,eAAe,CACb,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,yBAAyB,GACnC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACrC;;;;;;OAMG;IACH,eAAe,CACb,UAAU,EAAE,wBAAwB,EACpC,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,yBAAyB,GACnC,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAClC;;;;;;OAMG;IACH,eAAe,CACb,QAAQ,EAAE,yBAAyB,EACnC,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC;;;;;OAKG;IACH,eAAe,CACb,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,yBAAyB,GACnC,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;CACnC,CAAC;yBAEc,OAAO,KAAK,KAAG,SAAS;AAAxC,wBAyCE;AAEF,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,SAAS,EAAE,kBAAkB,CAAC;CAC/B;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAAC,EAC5C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,wBAAwB,CAK3B;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,EAClC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAS9B;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,EACpC,UAAU,EACV,QAAQ,EACR,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,yBAAyB,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAkDpC;AACD;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,EACpC,UAAU,EACV,QAAQ,EACR,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,yBAAyB,CAAC;IACrC,UAAU,EAAE,wBAAwB,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CA0BjC;AACD;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,yBAAyB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,mBAAmB,CAAC;IAClC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAiB/B;AACD;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,EACpC,UAAU,EACV,QAAQ,EACR,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,yBAAyB,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CA2BjC"}

package/types/ops/cloud/VariablesOps.d.ts

@@ -0,0 +1,224 @@
+import { VariableExpressionType, VariableSkeleton } from '../../api/cloud/VariablesApi';
+import { State } from '../../shared/State';
+import { ExportMetaData } from '../OpsTypes';
+export type Variable = {
+    /**
+     * Read variable by id/name
+     * @param {string} variableId variable id/name
+     * @param {boolean} noDecode Do not decode value (default: false)
+     * @returns {Promise<VariableSkeleton>} a promise that resolves to a variable object
+     */
+    readVariable(variableId: string, noDecode?: boolean): Promise<VariableSkeleton>;
+    /**
+     * Read all variables
+     * @param {boolean} noDecode Do not decode values (default: false)
+     * @returns {Promise<VariableSkeleton[]>} a promise that resolves to an array of variable objects
+     */
+    readVariables(noDecode?: boolean): Promise<VariableSkeleton[]>;
+    /**
+     * Export variable. The response can be saved to file as is.
+     * @param {string} variableId variable id/name
+     * @param {boolean} noDecode Do not decode value (default: false)
+     * @returns {Promise<VariablesExportInterface>} Promise resolving to a VariablesExportInterface object.
+     */
+    exportVariable(variableId: string, noDecode?: boolean): Promise<VariablesExportInterface>;
+    /**
+     * Export all variables
+     * @param {boolean} noDecode Do not decode values (default: false)
+     * @returns {Promise<VariablesExportInterface>} Promise resolving to an VariablesExportInterface object.
+     */
+    exportVariables(noDecode?: boolean): Promise<VariablesExportInterface>;
+    /**
+     * Import variable by id
+     * @param {string} variableId variable id/name
+     * @param {VariablesExportInterface} importData import data
+     * @returns {Promise<VariableSkeleton | null>} imported variable object, or null if no update was made
+     */
+    importVariable(variableId: string, importData: VariablesExportInterface): Promise<VariableSkeleton | null>;
+    /**
+     * Import variables
+     * @param {VariablesExportInterface} importData import data
+     * @returns {Promise<VariableSkeleton[]>} array of imported variable objects
+     */
+    importVariables(importData: VariablesExportInterface): Promise<VariableSkeleton[]>;
+    /**
+     * Create variable
+     * @param {string} variableId variable id/name
+     * @param {string} value variable value
+     * @param {string} description variable description
+     * @param {VariableExpressionType} expressionType type of the value
+     * @param {boolean} noEncode do not encode if passing a pre-encoded (base64) value
+     * @returns {Promise<VariableSkeleton>} a promise that resolves to a variable object
+     */
+    createVariable(variableId: string, value: string, description?: string, expressionType?: VariableExpressionType, noEncode?: boolean): Promise<VariableSkeleton>;
+    /**
+     * Update or create variable
+     * @param {string} variableId variable id/name
+     * @param {string} value variable value
+     * @param {string} description variable description
+     * @param {VariableExpressionType} expressionType type of the value
+     * @param {boolean} noEncode do not encode if passing a pre-encoded (base64) value
+     * @returns {Promise<VariableSkeleton | null>} a promise that resolves to a variable object, or null if no update was made
+     */
+    updateVariable(variableId: string, value?: string, description?: string, expressionType?: VariableExpressionType, noEncode?: boolean): Promise<VariableSkeleton | null>;
+    /**
+     * Update variable description
+     * @param {string} variableId variable id/name
+     * @param {string} description variable description
+     * @returns {Promise<VariableSkeleton | null>} a promise that resolves to a variable object, or null if no update was made
+     */
+    updateVariableDescription(variableId: string, description: string): Promise<VariableSkeleton | null>;
+    /**
+     * Delete variable by id/name
+     * @param {string} variableId variable id/name
+     * @returns {Promise<VariableSkeleton>} a promise that resolves to a variable object
+     */
+    deleteVariable(variableId: string): Promise<VariableSkeleton>;
+    /**
+     * Attempt to resolve a string to an ESV variable in AIC deployments.
+     * @param {string} input Input string to be evaluated as a possible ESV.
+     * @param {Map<string, VariableSkeleton>} variables Provide an empty or prepopulated map of ESV variables. The function adds any resolved variables to the map that don't exist.
+     * @returns {string} Returns the resolved value of the ESV or the original input string
+     */
+    resolveVariable(input: string, variables: Record<string, VariableSkeleton>): Promise<string>;
+    /**
+     * Get variable by id/name
+     * @param {string} variableId variable id/name
+     * @returns {Promise<VariableSkeleton>} a promise that resolves to a variable object
+     * @deprecated since v2.0.0 use {@link Variable.readVariable | readVariable} instead
+     * ```javascript
+     * readVariable(variableId: string): Promise<VariableSkeleton>
+     * ```
+     * @group Deprecated
+     */
+    getVariable(variableId: string): Promise<VariableSkeleton>;
+    /**
+     * Get all variables
+     * @returns {Promise<VariableSkeleton[]>} a promise that resolves to an array of variable objects
+     * @deprecated since v2.0.0 use {@link Variable.readVariables | readVariables} instead
+     * ```javascript
+     * readVariables(): Promise<VariableSkeleton[]>
+     * ```
+     * @group Deprecated
+     */
+    getVariables(): Promise<VariableSkeleton[]>;
+    /**
+     * Create variable
+     * @param {string} variableId variable id/name
+     * @param {string} valueBase64 base64-encoded variable value
+     * @param {string} description variable description
+     * @param {VariableExpressionType} expressionType type of the value
+     * @returns {Promise<VariableSkeleton>} a promise that resolves to a variable object
+     * @deprecated since v2.0.0 use {@link Variable.createVariable | createVariable} instead
+     * ```javascript
+     * createVariable(variableId: string, value: string, description: string, expressionType?: VariableExpressionType): Promise<VariableSkeleton>
+     * ```
+     * @group Deprecated
+     */
+    putVariable(variableId: string, valueBase64: string, description: string, expressionType?: VariableExpressionType): Promise<VariableSkeleton>;
+    /**
+     * Set variable description
+     * @param {string} variableId variable id/name
+     * @param {string} description variable description
+     * @returns {Promise<any>} a promise that resolves to an empty string
+     * @deprecated since v2.0.0 use {@link Variable.updateVariableDescription | updateVariableDescription} instead
+     * ```javascript
+     * updateVariableDescription(variableId: string, description: string): Promise<any>
+     * ```
+     * @group Deprecated
+     */
+    setVariableDescription(variableId: string, description: string): Promise<any>;
+};
+declare const _default: (state: State) => Variable;
+export default _default;
+export interface VariablesExportInterface {
+    meta?: ExportMetaData;
+    variable: Record<string, VariableSkeleton>;
+}
+export declare function createVariablesExportTemplate({ state, }: {
+    state: State;
+}): VariablesExportInterface;
+export declare function readVariable({ variableId, noDecode, state, }: {
+    variableId: string;
+    noDecode?: boolean;
+    state: State;
+}): Promise<VariableSkeleton>;
+export declare function readVariables({ noDecode, state, }: {
+    noDecode?: boolean;
+    state: State;
+}): Promise<VariableSkeleton[]>;
+export declare function exportVariable({ variableId, noDecode, state, }: {
+    variableId: string;
+    noDecode: boolean;
+    state: State;
+}): Promise<VariablesExportInterface>;
+export declare function exportVariables({ noDecode, state, }: {
+    noDecode: boolean;
+    state: State;
+}): Promise<VariablesExportInterface>;
+/**
+ * Import variable
+ * @param {string} variableId variable id/name
+ * @param {VariablesExportInterface} importData import data
+ * @returns {Promise<VariableSkeleton | null>} imported variable object, or null if no update was made
+ */
+export declare function importVariable({ variableId, importData, state, }: {
+    variableId?: string;
+    importData: VariablesExportInterface;
+    state: State;
+}): Promise<VariableSkeleton | null>;
+/**
+ * Import variables
+ * @param {VariablesExportInterface} importData import data
+ * @returns {Promise<VariableSkeleton[]>} array of imported variable objects
+ */
+export declare function importVariables({ importData, state, }: {
+    importData: VariablesExportInterface;
+    state: State;
+}): Promise<VariableSkeleton[]>;
+export declare function createVariable({ variableId, value, description, expressionType, noEncode, state, }: {
+    variableId: string;
+    value: string;
+    description?: string;
+    expressionType?: VariableExpressionType;
+    noEncode?: boolean;
+    state: State;
+}): Promise<VariableSkeleton>;
+/**
+ * Update or create variable
+ * @param {string} variableId variable id/name
+ * @param {string} value variable value
+ * @param {string} description variable description
+ * @param {VariableExpressionType} expressionType type of the value
+ * @param {boolean} noEncode do not encode if passing a pre-encoded (base64) value
+ * @returns {Promise<VariableSkeleton | null>} a promise that resolves to a variable object, or null if no update was made
+ */
+export declare function updateVariable({ variableId, value, description, expressionType, noEncode, state, }: {
+    variableId: string;
+    value?: string;
+    description?: string;
+    expressionType?: VariableExpressionType;
+    noEncode?: boolean;
+    state: State;
+}): Promise<VariableSkeleton | null>;
+export declare function updateVariableDescription({ variableId, description, state, }: {
+    variableId: string;
+    description: string;
+    state: State;
+}): Promise<VariableSkeleton | null>;
+export declare function deleteVariable({ variableId, state, }: {
+    variableId: string;
+    state: State;
+}): Promise<VariableSkeleton>;
+/**
+ * Attempt to resolve a string to an ESV variable in AIC deployments.
+ * @param {string} input Input string to be evaluated as a possible ESV.
+ * @param {Map<string, VariableSkeleton>} variables Provide an empty or prepopulated map of ESV variables. The function adds any resolved variables to the map that don't exist.
+ * @returns {string} Returns the resolved value of the ESV or the original input string
+ */
+export declare function resolveVariable({ input, variables, state, }: {
+    input: string;
+    variables?: Record<string, VariableSkeleton>;
+    state: State;
+}): Promise<string>;
+//# sourceMappingURL=VariablesOps.d.ts.map

package/types/ops/cloud/VariablesOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VariablesOps.d.ts","sourceRoot":"","sources":["../../../src/ops/cloud/VariablesOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,sBAAsB,EACtB,gBAAgB,EACjB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAU3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;;OAKG;IACH,YAAY,CACV,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7B;;;;OAIG;IACH,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC/D;;;;;OAKG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACrC;;;;OAIG;IACH,eAAe,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACvE;;;;;OAKG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,wBAAwB,GACnC,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IACpC;;;;OAIG;IACH,eAAe,CACb,UAAU,EAAE,wBAAwB,GACnC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC/B;;;;;;;;OAQG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,WAAW,CAAC,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,sBAAsB,EACvC,QAAQ,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7B;;;;;;;;OAQG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,sBAAsB,EACvC,QAAQ,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IACpC;;;;;OAKG;IACH,yBAAyB,CACvB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IACpC;;;;OAIG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC9D;;;;;OAKG;IACH,eAAe,CACb,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,GAC1C,OAAO,CAAC,MAAM,CAAC,CAAC;IAInB;;;;;;;;;OASG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC3D;;;;;;;;OAQG;IACH,YAAY,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC5C;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,sBAAsB,GACtC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7B;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC/E,CAAC;yBAEc,OAAO,KAAK,KAAG,QAAQ;AAAvC,wBAyHE;AAEF,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC5C;AAED,wBAAgB,6BAA6B,CAAC,EAC5C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,wBAAwB,CAK3B;AAED,wBAAsB,YAAY,CAAC,EACjC,UAAU,EACV,QAAgB,EAChB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAW5B;AAED,wBAAsB,aAAa,CAAC,EAClC,QAAgB,EAChB,KAAK,GACN,EAAE;IACD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAc9B;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,QAAQ,EACR,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAepC;AAED,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,wBAAwB,CAAC,CA4BpC;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,wBAAwB,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAkCnC;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,wBAAwB,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA2B9B;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,KAAK,EACL,WAAgB,EAChB,cAAyB,EACzB,QAAgB,EAChB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA2B5B;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,KAAK,EACL,WAAW,EACX,cAAc,EACd,QAAgB,EAChB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAkCnC;AAED,wBAAsB,yBAAyB,CAAC,EAC9C,UAAU,EACV,WAAW,EACX,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAoCnC;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAO5B;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,EACpC,KAAK,EACL,SAAc,EACd,KAAK,GACN,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC7C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,MAAM,CAAC,CAuBlB"}