@rockcarver/frodo-lib 4.10.0 → 4.11.0-1

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

@@ -0,0 +1,271 @@
+import { type PagedResult } from '../../api/ApiTypes';
+import { type LogApiKey, type LogEventSkeleton } from '../../api/cloud/LogApi';
+import { State } from '../../shared/State';
+export type LogTailStream = {
+    /**
+     * Polls once for new events since the last poll (the last 15 seconds, on
+     * the very first call -- matching the underlying API's own behavior),
+     * returning only genuinely new events. Never returns the same event
+     * twice, even across repeated calls -- see `createLogTailStream()`.
+     */
+    poll(): Promise<LogEventSkeleton[]>;
+};
+export type Log = {
+    /**
+     * Get default noise filter
+     * @returns {string[]} array of default event types and loggers to be filtered out
+     */
+    getDefaultNoiseFilter(): string[];
+    /**
+     * Resolve log level to an array of effective log levels
+     * @param level string or numeric log level: 'FATAL', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE', 'ALL', 0, 1, 2, 3, 4
+     * @returns {string[]} array of effective log levels
+     */
+    resolveLevel(level: string | number): string[];
+    /**
+     * Resolve a log event's level
+     * @param {object} log log event
+     * @returns {string} log level
+     */
+    resolvePayloadLevel(log: LogEventSkeleton): string;
+    /**
+     * Get available log sources
+     * @returns {Promise<string[]>} promise resolving to an array of available log sources
+     */
+    getLogSources(): Promise<string[]>;
+    /**
+     * Get log api key
+     * @param {string} keyId key id
+     * @returns {Promise<LogApiKey>} promise resolving to a LogApiKey objects
+     */
+    getLogApiKey(keyId: string): Promise<LogApiKey>;
+    /**
+     * Validate log api key and secret
+     * @param {string} keyId log api key id
+     * @param {string} secret log api secret
+     * @returns {Promise<boolean>} a promise resolving to true if the key is valid, false otherwise
+     */
+    isLogApiKeyValid(keyId: string, secret: string): Promise<boolean>;
+    /**
+     * Get log api keys
+     * @returns {Promise<LogApiKey[]>} promise resolving to an array of LogApiKey objects
+     */
+    getLogApiKeys(): Promise<LogApiKey[]>;
+    /**
+     * Create log api key
+     * @param {string} keyName human-readable key name
+     * @returns {Promise<LogApiKey>} a promise resolving to an object containing the log api key and secret
+     */
+    createLogApiKey(keyName: string): Promise<LogApiKey>;
+    /**
+     * Delete log api key
+     * @param {string} keyId key id
+     * @returns {Promise<LogApiKey>} a promise resolving to an object containing the log api key
+     */
+    deleteLogApiKey(keyId: string): Promise<LogApiKey>;
+    /**
+     * Delete all log api keys
+     * @returns {Promise<LogApiKey>} a promise resolving to an array of log api key objects
+     */
+    deleteLogApiKeys(): Promise<LogApiKey[]>;
+    /**
+     * Tail logs
+     * @param {string} source log source(s) to tail
+     * @param {string} cookie paged results cookie
+     * @returns {Promise<PagedResult<LogEventSkeleton>>} promise resolving to paged log event result
+     */
+    tail(source: string, cookie: string): Promise<PagedResult<LogEventSkeleton>>;
+    /**
+     * Creates a stateful, deduped consumer of `tail()` -- everything a caller
+     * doing a live polling loop (e.g. an interactive follow-style view) needs
+     * without reimplementing cookie-tracking or dedup itself.
+     * @remarks
+     * PingOne AIC's own tail-endpoint documentation is explicit that each
+     * subsequent call's range "starts from the last returned log entry in
+     * the previous result (**inclusive**)" -- the boundary event is
+     * documented to repeat by design, and the endpoint returns no unique
+     * event id at all to tell repeats apart with (confirmed live: unlike
+     * `fetch()`, whose results do carry `_id`). A real live poll loop against
+     * `am-authentication` also showed `tail()` redeliver a whole earlier
+     * batch verbatim -- sometimes even within one poll's own result array,
+     * not just across a cookie boundary -- so this dedupes broadly by event
+     * content, not merely by skipping one known boundary event.
+     * @param {string} source log source(s) to tail
+     * @returns {LogTailStream} a stream object with a `poll()` method
+     */
+    createLogTailStream(source: string): LogTailStream;
+    /**
+     * Fetch logs
+     * @param {string} source log source(s) to tail
+     * @param {string} startTs start timestamp
+     * @param {string} endTs end timestamp
+     * @param {string} cookie paged results cookie
+     * @param {string} txid transaction id
+     * @param {string} filter query filter
+     * @returns {Promise<PagedResult<LogEventSkeleton>>} promise resolving to paged log event result
+     */
+    fetch(source: string, startTs: string, endTs: string, cookie: string, txid: string, filter: string): Promise<PagedResult<LogEventSkeleton>>;
+    /**
+     * Search audit events by event name(s) and/or principal, across the full time
+     * range (auto-paginating), with client-side dedup by transaction id.
+     * @param {string} source log source(s) to search, e.g. am-authentication
+     * @param {string} startTs start timestamp
+     * @param {string} endTs end timestamp
+     * @param {string[]} eventNames optional event names to match (OR'd together server-side)
+     * @param {string} principal optional principal substring to match against payload.userId (co)
+     * @param {number} maxEvents safety cap on total events fetched across pages
+     * @param {boolean} dedupeByTransactionId collapse multiple events sharing a transaction id (e.g. a failed-then-successful retry) down to the last one seen; default true
+     * @returns {Promise<LogEventSkeleton[]>} promise resolving to the matched (and optionally deduped) events
+     */
+    searchEvents(source: string, startTs: string, endTs: string, eventNames?: string[], principal?: string, maxEvents?: number, dedupeByTransactionId?: boolean): Promise<LogEventSkeleton[]>;
+};
+declare const _default: (state: State) => Log;
+export default _default;
+/**
+ * Get default noise filter
+ * @returns {string[]} array of default event types and loggers to be filtered out
+ */
+export declare function getDefaultNoiseFilter(): string[];
+/**
+ * Resolve log level to an array of effective log levels
+ * @param level string or numeric log level: 'FATAL', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE', 'ALL', 0, 1, 2, 3, 4
+ * @returns {string[]} array of effective log levels
+ */
+export declare function resolveLevel(level: string | number): string[];
+/**
+ * Resolve a log event's level
+ * @param {object} log log event
+ * @returns {string} log level
+ */
+export declare function resolvePayloadLevel(log: LogEventSkeleton): string;
+/**
+ * Get available log sources
+ * @returns {Promise<string[]>} promise resolving to an array of available log sources
+ */
+export declare function getLogSources({ state }: {
+    state: State;
+}): Promise<string[]>;
+/**
+ * Get log API key
+ * @returns {Promise<PagedResult<LogApiKey>>} a promise resolving to a log api key object
+ */
+export declare function getLogApiKey({ keyId, state, }: {
+    keyId: string;
+    state: State;
+}): Promise<LogApiKey>;
+/**
+ * Validate log API key
+ * @param {string} keyId log api key id
+ * @param {string} secret log api secret
+ * @returns {Promise<boolean>} a promise resolving to true if the key is valid, false otherwise
+ */
+export declare function isLogApiKeyValid({ keyId, secret, state, }: {
+    keyId: string;
+    secret: string;
+    state: State;
+}): Promise<boolean>;
+/**
+ * Get log api keys
+ * @returns {Promise<LogApiKey[]>} promise resolving to an array of LogApiKey objects
+ */
+export declare function getLogApiKeys({ state, }: {
+    state: State;
+}): Promise<LogApiKey[]>;
+/**
+ * Create API key
+ * @param {keyName: string, state: State} params keyName, state
+ * @returns {Promise<LogApiKey>} new API key and secret
+ */
+export declare function createLogApiKey({ keyName, state, }: {
+    keyName: string;
+    state: State;
+}): Promise<LogApiKey>;
+/**
+ * Delete key
+ */
+export declare function deleteLogApiKey({ keyId, state, }: {
+    keyId: string;
+    state: State;
+}): Promise<LogApiKey>;
+/**
+ * Delete all keys
+ */
+export declare function deleteLogApiKeys({ state, }: {
+    state: State;
+}): Promise<LogApiKey[]>;
+/**
+ * Tail logs
+ * @param {string} source log source(s) to tail
+ * @param {string} cookie paged results cookie
+ * @returns {Promise<PagedResult<LogEventSkeleton>>} promise resolving to paged log event result
+ */
+export declare function tail({ source, cookie, state, }: {
+    source: string;
+    cookie: string;
+    state: State;
+}): Promise<PagedResult<LogEventSkeleton>>;
+/**
+ * Creates a stateful, deduped consumer of `tail()` -- see the `Log` type's
+ * own remarks on `createLogTailStream` for why this exists at all instead
+ * of leaving every caller to dedupe `tail()` for itself.
+ * @param {string} source log source(s) to tail
+ * @param {State} state library state
+ * @returns {LogTailStream} a stream object with a `poll()` method
+ */
+export declare function createLogTailStream({ source, state, }: {
+    source: string;
+    state: State;
+}): LogTailStream;
+/**
+ * Fetch logs
+ * @param {string} source log source(s) to tail
+ * @param {string} startTs start timestamp
+ * @param {string} endTs end timestamp
+ * @param {string} cookie paged results cookie
+ * @param {string} txid transaction id
+ * @param {string} filter query filter
+ * @returns {Promise<PagedResult<LogEventSkeleton>>} promise resolving to paged log event result
+ */
+export declare function fetch({ source, startTs, endTs, cookie, txid, filter, state, }: {
+    source: string;
+    startTs: string;
+    endTs: string;
+    cookie: string;
+    txid: string;
+    filter: string;
+    state: State;
+}): Promise<PagedResult<LogEventSkeleton>>;
+/**
+ * Search audit events by event name(s) and/or principal, across the full
+ * time range (auto-paginating within each ~24h chunk the Log API allows,
+ * and auto-chunking the requested range into consecutive windows that size
+ * when it's wider than that — see {@link MAX_LOG_WINDOW_MS} — respecting the
+ * ~1 request/second Log API rate limit between every fetch call, chunk
+ * boundaries included), with client-side dedup by transaction id.
+ *
+ * @remarks
+ * Filtering happens server-side (see {@link buildEventFilter}) rather than
+ * fetching unfiltered and post-filtering client-side — the corrected,
+ * verified-working approach from this session's investigation, materially
+ * cheaper than an unfiltered fetch that risks truncating before reaching
+ * the events in question.
+ *
+ * Dedup collapses multiple events sharing a transaction id (e.g. a failed
+ * login attempt immediately followed by a successful retry, observed live
+ * this session) down to the last one seen. Since fetch results are already
+ * ordered ascending by timestamp within each chunk (and chunks are fetched
+ * in chronological order), "last seen" is the most recent event for that
+ * transaction — the actual outcome, not an arbitrary one. CREST filters
+ * can't express this dedup themselves, so it has to happen client-side.
+ */
+export declare function searchEvents({ source, startTs, endTs, eventNames, principal, maxEvents, dedupeByTransactionId, state, }: {
+    source: string;
+    startTs: string;
+    endTs: string;
+    eventNames?: string[];
+    principal?: string;
+    maxEvents?: number;
+    dedupeByTransactionId?: boolean;
+    state: State;
+}): Promise<LogEventSkeleton[]>;
+//# sourceMappingURL=LogOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LogOps.d.ts","sourceRoot":"","sources":["../../../src/ops/cloud/LogOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EASL,KAAK,SAAS,EAEd,KAAK,gBAAgB,EACtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAG3C,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;OAKG;IACH,IAAI,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG;IAChB;;;OAGG;IACH,qBAAqB,IAAI,MAAM,EAAE,CAAC;IAClC;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/C;;;;OAIG;IACH,mBAAmB,CAAC,GAAG,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACnD;;;OAGG;IACH,aAAa,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACnC;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAChD;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAClE;;;OAGG;IACH,aAAa,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACtC;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACrD;;;;OAIG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACnD;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACzC;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;IACnD;;;;;;;;;OASG;IACH,KAAK,CACH,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC1C;;;;;;;;;;;OAWG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,EAAE,EACrB,SAAS,CAAC,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,EAClB,qBAAqB,CAAC,EAAE,OAAO,GAC9B,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;CAChC,CAAC;yBAEc,OAAO,KAAK,KAAG,GAAG;AAAlC,wBAwEE;AAkOF;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,EAAE,CAEhD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAK7D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,gBAAgB,GAAG,MAAM,CAYjE;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,qBAO9D;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,KAAK,GACN,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,CAAC,CAMrB;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,KAAK,EACL,MAAM,EACN,KAAK,GACN,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAMnB;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,EAClC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAOvB;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,CAAC,CAMrB;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,EACpC,KAAK,EACL,KAAK,GACN,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,CAAC,CAQrB;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAuBvB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,EACzB,MAAM,EACN,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAMzC;AAkBD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,aAAa,CA2BhB;AAED;;;;;;;;;GASG;AACH,wBAAsB,KAAK,CAAC,EAC1B,MAAM,EACN,OAAO,EACP,KAAK,EACL,MAAM,EACN,IAAI,EACJ,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAMzC;AAqED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,YAAY,CAAC,EACjC,MAAM,EACN,OAAO,EACP,KAAK,EACL,UAAU,EACV,SAAS,EACT,SAAgB,EAChB,qBAA4B,EAC5B,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA6C9B"}

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

@@ -0,0 +1,306 @@
+import { SecretSkeleton, VersionOfSecretSkeleton } from '../../api/cloud/SecretsApi';
+import { State } from '../../shared/State';
+import { ExportMetaData, ResultCallback } from '../OpsTypes';
+export type Secret = {
+    /**
+     * Read all secrets
+     * @returns {Promise<SecretSkeleton[]>} a promise that resolves to an array of secrets
+     */
+    readSecrets(): Promise<SecretSkeleton[]>;
+    /**
+     * Read secret
+     * @param {string} secretId secret id/name
+     * @returns {Promise<SecretSkeleton>} a promise that resolves to a secret
+     */
+    readSecret(secretId: string): Promise<SecretSkeleton>;
+    /**
+     * Read the value of a secret
+     * @param {string} secretId secret id/name
+     * @param {string} target Host URL of target environment to encrypt secret value for
+     * @param {boolean} decrypt retrieve secret value in the clear (default: false)
+     * @returns {Promise<string>} a promise that resolves to the value of the secret
+     */
+    readSecretValue(secretId: string, target?: string, decrypt?: boolean): Promise<any>;
+    /**
+     * Read the values of an array of secrets
+     * @param {string} secretIds secret id/name
+     * @param {string} target Host URL of target environment to encrypt secret values for
+     * @param {boolean} decrypt retrieve secret values in the clear (default: false)
+     * @returns {Promise<{ [key: string]: string }>} a promise that resolves to a map of secret ids and values
+     */
+    readSecretValues(secretIds: string[], target?: string, decrypt?: boolean): Promise<{
+        [key: string]: string;
+    }>;
+    /**
+     * Export secret. The response can be saved to file as is.
+     * @param {string} secretId secret id/name
+     * @param {boolean} includeActiveValue include active value of secret (default: false)
+     * @param {string} target Host URL of target environment to encrypt secret value for
+     * @returns {Promise<SecretsExportInterface>} Promise resolving to a SecretsExportInterface object.
+     */
+    exportSecret(secretId: string, includeActiveValue?: boolean, target?: string): Promise<SecretsExportInterface>;
+    /**
+     * Export all secrets
+     * @param {boolean} includeActiveValues include active values of secrets (default: false)
+     * @param {string} target Host URL of target environment to encrypt secret values for
+     * @returns {Promise<SecretsExportInterface>} Promise resolving to an SecretsExportInterface object.
+     */
+    exportSecrets(includeActiveValues?: boolean, target?: string): Promise<SecretsExportInterface>;
+    /**
+     * Import secret by id
+     * @param {string} secretId secret id/name
+     * @param {SecretsExportInterface} importData import data
+     * @param {boolean} includeActiveValue include active value of secret (default: false)
+     * @param {string} source Host URL of source environment where the secret was exported from
+     * @returns {Promise<SecretSkeleton | null>} imported secret object, or null if no update was made
+     */
+    importSecret(secretId: string, importData: SecretsExportInterface, includeActiveValue?: boolean, source?: string): Promise<SecretSkeleton | null>;
+    /**
+     * Import secrets
+     * @param {SecretsExportInterface} importData import data
+     * @param {boolean} includeActiveValues include active values of secrets (default: false)
+     * @param {string} source Host URL of source environment where the secrets were exported from
+     * @returns {Promise<SecretSkeleton[]>} array of imported secret objects
+     */
+    importSecrets(importData: SecretsExportInterface, includeActiveValues?: boolean, source?: string): Promise<SecretSkeleton[]>;
+    /**
+     * Create secret
+     * @param {string} secretId secret id/name
+     * @param {string} value secret value
+     * @param {string} description secret description
+     * @param {string} encoding secret encoding (only `generic` is supported)
+     * @param {boolean} useInPlaceholders flag indicating if the secret can be used in placeholders
+     * @returns {Promise<SecretSkeleton>} a promise that resolves to a secret
+     */
+    createSecret(secretId: string, value: string, description: string, encoding?: string, useInPlaceholders?: boolean): Promise<SecretSkeleton>;
+    /**
+     * Update secret description
+     * @param {string} secretId secret id/name
+     * @param {string} description secret description
+     * @returns {Promise<SecretSkeleton | null>} a promise that resolves to the updated secret object if a change was made, otherwise returns null
+     */
+    updateSecretDescription(secretId: string, description: string): Promise<SecretSkeleton | null>;
+    /**
+     * Delete secret
+     * @param {string} secretId secret id/name
+     * @returns {Promise<SecretSkeleton>} a promise that resolves to a secret object
+     */
+    deleteSecret(secretId: string): Promise<SecretSkeleton>;
+    /**
+     * Read versions of secret
+     * @param {string} secretId secret id/name
+     * @returns {Promise<VersionOfSecretSkeleton[]>} a promise that resolves to an array of secret versions
+     */
+    readVersionsOfSecret(secretId: string): Promise<VersionOfSecretSkeleton[]>;
+    /**
+     * Create version of secret
+     * @param {string} secretId secret id/name
+     * @param {string} value secret value
+     * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a version object
+     */
+    createVersionOfSecret(secretId: string, value: string): Promise<VersionOfSecretSkeleton>;
+    /**
+     * Update secret
+     * @param {string} secretId secret id/name
+     * @param {string} description optional secret description; if provided, attempts to update the secret description
+     * @param {string} value optional secret value; if provided, attempts to create a new version of the secret
+     * @returns {Promise<SecretSkeleton | null>} imported secret object, or null if no update was made
+     */
+    updateSecret(secretId: string, description?: string, value?: string): Promise<SecretSkeleton | null>;
+    /**
+     * Read version of secret
+     * @param {string} secretId secret id/name
+     * @param {string} version secret version
+     * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a version object
+     */
+    readVersionOfSecret(secretId: string, version: string): Promise<VersionOfSecretSkeleton>;
+    /**
+     * Enable a version of a secret
+     * @param {string} secretId secret id/name
+     * @param {string} version secret version
+     * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a status object
+     */
+    enableVersionOfSecret(secretId: string, version: string): Promise<VersionOfSecretSkeleton>;
+    /**
+     * Disable a version of a secret
+     * @param {string} secretId secret id/name
+     * @param {string} version secret version
+     * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a status object
+     */
+    disableVersionOfSecret(secretId: string, version: string): Promise<VersionOfSecretSkeleton>;
+    /**
+     * Delete version of secret
+     * @param {string} secretId secret id/name
+     * @param {string} version secret version
+     * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a version object
+     */
+    deleteVersionOfSecret(secretId: string, version: string): Promise<VersionOfSecretSkeleton>;
+    /**
+     * Prune versions of secret that are not the latest secret version
+     * @param {string} secretId secret id/name
+     * @param {boolean} keepLoaded true to keep the currently loaded secret versions regardless of if they are active or not. Default: false
+     * @param {boolean} keepDeactivated true to keep the deactivated versions and only prune the active versions that aren't the latest version. Default: false
+     * @param {ResultCallback<VersionOfSecretSkeleton>} resultCallback Optional callback to process individual results
+     * @returns {Promise<VersionOfSecretSkeleton[]>} a promise that reolves to the pruned version objects
+     */
+    pruneVersionsOfSecret(secretId: string, keepLoaded?: boolean, keepDeactivated?: boolean, resultCallback?: ResultCallback<VersionOfSecretSkeleton>): Promise<VersionOfSecretSkeleton[]>;
+};
+declare const _default: (state: State) => Secret;
+export default _default;
+export interface SecretsExportInterface {
+    meta?: ExportMetaData;
+    secret: Record<string, SecretSkeleton>;
+}
+/**
+ * Secrets import options
+ */
+export interface SecretImportOptions {
+    /**
+     * Import active values of secret
+     */
+    includeActiveValues: boolean;
+    /**
+     * Host URL of source environment to decrypt secret values from
+     */
+    source?: string;
+}
+/**
+ * Secrets export options
+ */
+export interface SecretExportOptions {
+    /**
+     * Export active values of secret
+     */
+    includeActiveValues: boolean;
+    /**
+     * Host URL of target environment to encrypt secret values for
+     */
+    target?: string;
+}
+export declare function createSecretsExportTemplate({ state, }: {
+    state: State;
+}): SecretsExportInterface;
+export declare function exportSecret({ secretId, options, state, }: {
+    secretId: string;
+    options?: SecretExportOptions;
+    state: State;
+}): Promise<SecretsExportInterface>;
+export declare function exportSecrets({ options, state, }: {
+    options?: SecretExportOptions;
+    state: State;
+}): Promise<SecretsExportInterface>;
+export declare function readSecretValue({ secretId, decrypt, target, state, }: {
+    secretId: string;
+    decrypt?: boolean;
+    target?: string;
+    state: State;
+}): Promise<any>;
+export declare function readSecretValues({ secretIds, decrypt, target, state, }: {
+    secretIds: string[];
+    decrypt?: boolean;
+    target?: string;
+    state: State;
+}): Promise<{
+    [key: string]: string;
+}>;
+/**
+ * Import secret by id
+ * @param {string} secretId secret id/name
+ * @param {SecretsExportInterface} importData import data
+ * @param {SecretImportOptions} options import options
+ * @returns {Promise<SecretSkeleton | null>} imported secret object, or null if no update was made
+ */
+export declare function importSecret({ secretId, importData, options, state, }: {
+    secretId: string;
+    importData: SecretsExportInterface;
+    options?: SecretImportOptions;
+    state: State;
+}): Promise<SecretSkeleton | null>;
+/**
+ * Import secrets
+ * @param {SecretsExportInterface} importData import data
+ * @param {SecretImportOptions} options import options
+ * @returns {Promise<SecretSkeleton[]>} array of imported secret objects
+ */
+export declare function importSecrets({ importData, options, state, }: {
+    importData: SecretsExportInterface;
+    options?: SecretImportOptions;
+    state: State;
+}): Promise<SecretSkeleton[]>;
+export declare function enableVersionOfSecret({ secretId, version, state, }: {
+    secretId: string;
+    version: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton>;
+export declare function disableVersionOfSecret({ secretId, version, state, }: {
+    secretId: string;
+    version: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton>;
+export declare function readSecret({ secretId, state, }: {
+    secretId: string;
+    state: State;
+}): Promise<SecretSkeleton>;
+export declare function readSecrets({ state, }: {
+    state: State;
+}): Promise<SecretSkeleton[]>;
+export declare function createSecret({ secretId, value, description, encoding, useInPlaceholders, state, }: {
+    secretId: string;
+    value: string;
+    description: string;
+    encoding: string;
+    useInPlaceholders: boolean;
+    state: State;
+}): Promise<SecretSkeleton>;
+export declare function createVersionOfSecret({ secretId, value, state, }: {
+    secretId: string;
+    value: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton>;
+/**
+ * Update secret
+ * @param {string} secretId secret id/name
+ * @param {string} description optional secret description; if provided, attempts to update the secret description
+ * @param {string} value optional secret value; if provided, attempts to create a new version of the secret
+ * @returns {Promise<SecretSkeleton | null>} imported secret object, or null if no update was made
+ */
+export declare function updateSecret({ secretId, description, value, state, }: {
+    secretId: string;
+    description?: string;
+    value?: string;
+    state: State;
+}): Promise<SecretSkeleton | null>;
+export declare function deleteSecret({ secretId, state, }: {
+    secretId: string;
+    state: State;
+}): Promise<any>;
+export declare function readVersionOfSecret({ secretId, version, state, }: {
+    secretId: string;
+    version: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton>;
+export declare function readVersionsOfSecret({ secretId, state, }: {
+    secretId: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton[]>;
+export declare function updateSecretDescription({ secretId, description, state, }: {
+    secretId: string;
+    description: string;
+    state: State;
+}): Promise<SecretSkeleton | null>;
+/**
+ * Prune versions of secret that are not the latest secret version
+ * @param {string} secretId secret id/name
+ * @param {boolean} keepLoaded true to keep the currently loaded secret versions regardless of if they are active or not. Default: false
+ * @param {boolean} keepDeactivated true to keep the deactivated versions and only prune the active versions that aren't the latest version. Default: false
+ * @param {ResultCallback<VersionOfSecretSkeleton>} resultCallback Optional callback to process individual results
+ * @returns {Promise<VersionOfSecretSkeleton[]>} a promise that reolves to the pruned version objects
+ */
+export declare function pruneVersionsOfSecret({ secretId, keepLoaded, keepDeactivated, resultCallback, state, }: {
+    secretId: string;
+    keepLoaded?: boolean;
+    keepDeactivated?: boolean;
+    resultCallback?: ResultCallback<VersionOfSecretSkeleton>;
+    state: State;
+}): Promise<VersionOfSecretSkeleton[]>;
+//# sourceMappingURL=SecretsOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SecretsOps.d.ts","sourceRoot":"","sources":["../../../src/ops/cloud/SecretsOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAYL,cAAc,EACd,uBAAuB,EACxB,MAAM,4BAA4B,CAAC;AASpC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAiB3C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7D,MAAM,MAAM,MAAM,GAAG;IACnB;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACtD;;;;;;OAMG;IACH,eAAe,CACb,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,GAAG,CAAC,CAAC;IAChB;;;;;;OAMG;IACH,gBAAgB,CACd,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC,CAAC;IACtC;;;;;;OAMG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,kBAAkB,CAAC,EAAE,OAAO,EAC5B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CACX,mBAAmB,CAAC,EAAE,OAAO,EAC7B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACnC;;;;;;;OAOG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,sBAAsB,EAClC,kBAAkB,CAAC,EAAE,OAAO,EAC5B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAClC;;;;;;OAMG;IACH,aAAa,CACX,UAAU,EAAE,sBAAsB,EAClC,mBAAmB,CAAC,EAAE,OAAO,EAC7B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC7B;;;;;;;;OAQG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,cAAc,CAAC,CAAC;IAC3B;;;;;OAKG;IACH,uBAAuB,CACrB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAClC;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACxD;;;;OAIG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAC3E;;;;;OAKG;IACH,qBAAqB,CACnB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC;;;;;;OAMG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,WAAW,CAAC,EAAE,MAAM,EACpB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAClC;;;;;OAKG;IACH,mBAAmB,CACjB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC;;;;;OAKG;IACH,qBAAqB,CACnB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC;;;;;OAKG;IACH,sBAAsB,CACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC;;;;;OAKG;IACH,qBAAqB,CACnB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC;;;;;;;OAOG;IACH,qBAAqB,CACnB,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,OAAO,EACpB,eAAe,CAAC,EAAE,OAAO,EACzB,cAAc,CAAC,EAAE,cAAc,CAAC,uBAAuB,CAAC,GACvD,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;CACvC,CAAC;yBAEc,OAAO,KAAK,KAAG,MAAM;AAArC,wBA6IE;AAEF,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAkCD,wBAAgB,2BAA2B,CAAC,EAC1C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,sBAAsB,CAKzB;AAgBD,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,OAAsD,EACtD,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAuBlC;AAED,wBAAsB,aAAa,CAAC,EAClC,OAAsD,EACtD,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAyDlC;AA+HD,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,OAAe,EACf,MAAa,EACb,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,GAAG,CAAC,CA4Bf;AAED,wBAAsB,gBAAgB,CAAC,EACrC,SAAS,EACT,OAAe,EACf,MAAa,EACb,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC,CAuCrC;AA8GD;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,UAAU,EACV,OAAmD,EACnD,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,sBAAsB,CAAC;IACnC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CA0DjC;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,EAClC,UAAU,EACV,OAAmD,EACnD,KAAK,GACN,EAAE;IACD,UAAU,EAAE,sBAAsB,CAAC;IACnC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAgD5B;AAED,wBAAsB,qBAAqB,CAAC,EAC1C,QAAQ,EACR,OAAO,EACP,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,oCAuBA;AAED,wBAAsB,sBAAsB,CAAC,EAC3C,QAAQ,EACR,OAAO,EACP,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAoBnC;AAED,wBAAsB,UAAU,CAAC,EAC/B,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CAS1B;AAED,wBAAsB,WAAW,CAAC,EAChC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAS5B;AAED,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,KAAK,EACL,WAAW,EACX,QAAoB,EACpB,iBAAwB,EACxB,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,KAAK,EAAE,KAAK,CAAC;CACd,2BAgBA;AAED,wBAAsB,qBAAqB,CAAC,EAC1C,QAAQ,EACR,KAAK,EACL,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;CACd,oCAoBA;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,WAAW,EACX,KAAK,EACL,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CA+BjC;AAED,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,gBASA;AAED,wBAAsB,mBAAmB,CAAC,EACxC,QAAQ,EACR,OAAO,EACP,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,oCAYA;AAED,wBAAsB,oBAAoB,CAAC,EACzC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,sCASA;AAED,wBAAsB,uBAAuB,CAAC,EAC5C,QAAQ,EACR,WAAW,EACX,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAsCjC;AAED;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,QAAQ,EACR,UAAkB,EAClB,eAAuB,EACvB,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,cAAc,CAAC,uBAAuB,CAAC,CAAC;IACzD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAyDrC"}