@rockcarver/frodo-lib 4.10.0 → 4.11.0

package/types/ops/ThemeOps.d.ts

@@ -0,0 +1,245 @@
+import { type IdObjectSkeletonInterface } from '../api/ApiTypes';
+import { State } from '../shared/State';
+import { ExportMetaData } from './OpsTypes';
+export type ThemeSkeleton = IdObjectSkeletonInterface & {
+    name: string;
+    isDefault: boolean;
+    linkedTrees: string[];
+};
+export type UiThemeRealmObject = IdObjectSkeletonInterface & {
+    name: string;
+    realm: Map<string, ThemeSkeleton[]>;
+};
+export declare const THEMEREALM_ID = "ui/themerealm";
+export type Theme = {
+    /**
+     * Create an empty theme export template
+     * @returns {ThemeExportInterface} an empty theme export template
+     */
+    createThemeExportTemplate(): ThemeExportInterface;
+    /**
+     * Read all themes
+     * @returns {Promise<ThemeSkeleton[]>} a promise that resolves to an array of themes
+     */
+    readThemes(): Promise<ThemeSkeleton[]>;
+    /**
+     * Read theme by id
+     * @param {string} themeId theme id
+     * @param {string} realm realm name
+     * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+     */
+    readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
+    /**
+     * Read theme by name
+     * @param {string} themeName theme name
+     * @param {string} realm realm name
+     * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+     */
+    readThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
+    /**
+     * Export all themes. The response can be saved to file as is.
+     * @returns {Promise<ThemeExportInterface>} Promise resolving to a ThemeExportInterface object.
+     */
+    exportThemes(): Promise<ThemeExportInterface>;
+    /**
+     * Update theme
+     * @param {ThemeSkeleton} themeData theme object
+     * @param {string} themeId theme id
+     * @param {string} realm realm name
+     * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+     */
+    createTheme(themeData: ThemeSkeleton, themeId?: string, realm?: string): Promise<ThemeSkeleton>;
+    /**
+     * Update theme
+     * @param {string} themeId theme id
+     * @param {ThemeSkeleton} themeData theme object
+     * @param {string} realm realm name
+     * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+     */
+    updateTheme(themeId: string, themeData: ThemeSkeleton, realm?: string): Promise<ThemeSkeleton>;
+    /**
+     * Update theme by name
+     * @param {String} themeName theme name
+     * @param {ThemeSkeleton} themeData theme object
+     * @param {string} realm realm name
+     * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+     */
+    updateThemeByName(themeName: string, themeData: ThemeSkeleton, realm?: string): Promise<ThemeSkeleton>;
+    /**
+     * Update all themes
+     * @param {Map<string, ThemeSkeleton>} allThemesData themes object containing all themes for all realms
+     * @param {string} realm realm name
+     * @returns {Promise<Map<string, ThemeSkeleton>>} a promise that resolves to a themes object
+     */
+    updateThemes(themeMap: Record<string, ThemeSkeleton>): Promise<Record<string, ThemeSkeleton>>;
+    /**
+     * Import themes
+     * @param {ThemeExportInterface} importData import data
+     * @returns {Promise<ThemeSkeleton[]>} a promise resolving to an array of theme objects
+     */
+    importThemes(importData: ThemeExportInterface): Promise<ThemeSkeleton[]>;
+    /**
+     * Delete theme by id
+     * @param {string} themeId theme id
+     * @param {string} realm realm name
+     * @returns {Promise<ThemeSkeleton>} a promise that resolves to a themes object
+     */
+    deleteTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
+    /**
+     * Delete theme by name
+     * @param {string} themeName theme name
+     * @param {string} realm realm name
+     * @returns {Promise<ThemeSkeleton>} a promise that resolves to a themes object
+     */
+    deleteThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
+    /**
+     * Delete all themes
+     * @param {string} realm realm name
+     * @returns {Promise<ThemeSkeleton[]>} a promise that resolves to an array of themes
+     */
+    deleteThemes(realm?: string): Promise<ThemeSkeleton[]>;
+};
+declare const _default: (state: State) => Theme;
+export default _default;
+export interface ThemeExportInterface {
+    meta?: ExportMetaData;
+    theme: Record<string, ThemeSkeleton>;
+}
+/**
+ * Create an empty theme export template
+ * @returns {ThemeExportInterface} an empty theme export template
+ */
+export declare function createThemeExportTemplate({ state, }: {
+    state: State;
+}): ThemeExportInterface;
+/**
+ * Read all themes
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton[]>} a promise that resolves to an array of themes
+ */
+export declare function readThemes({ realm, state, }: {
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton[]>;
+/**
+ * Read theme by id
+ * @param {string} themeId theme id
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+ */
+export declare function readTheme({ themeId, realm, state, }: {
+    themeId: string;
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton>;
+/**
+ * Read theme by name
+ * @param {string} themeName theme name
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+ */
+export declare function readThemeByName({ themeName, realm, state, }: {
+    themeName: string;
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton>;
+/**
+ * Export all themes. The response can be saved to file as is.
+ * @returns {Promise<ThemeExportInterface>} Promise resolving to a ThemeExportInterface object.
+ */
+export declare function exportThemes({ state, }: {
+    state: State;
+}): Promise<ThemeExportInterface>;
+/**
+ * Create theme
+ * @param {string} themeId theme id
+ * @param {ThemeSkeleton} themeData theme object
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+ */
+export declare function createTheme({ themeData, themeId, realm, state, }: {
+    themeData: ThemeSkeleton;
+    themeId?: string;
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton>;
+/**
+ * Update theme
+ * @param {string} themeId theme id
+ * @param {ThemeSkeleton} themeData theme object
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+ */
+export declare function updateTheme({ themeId, themeData, realm, state, }: {
+    themeId: string;
+    themeData: ThemeSkeleton;
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton>;
+/**
+ * Update theme by name
+ * @param {String} themeName theme name
+ * @param {ThemeSkeleton} themeData theme object
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton>} a promise that resolves to a theme object
+ */
+export declare function updateThemeByName({ themeName, themeData, realm, state, }: {
+    themeName: string;
+    themeData: ThemeSkeleton;
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton>;
+/**
+ * Update all themes
+ * @param {Map<string, ThemeSkeleton>} allThemesData themes object containing all themes for all realms
+ * @param {string} realm realm name
+ * @returns {Promise<Map<string, ThemeSkeleton>>} a promise that resolves to a themes object
+ */
+export declare function updateThemes({ themeMap, realm, state, }: {
+    themeMap: Record<string, ThemeSkeleton>;
+    realm?: string;
+    state: State;
+}): Promise<Record<string, ThemeSkeleton>>;
+/**
+ * Import themes
+ * @param {ThemeExportInterface} importData import data
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton[]>} a promise resolving to an array of theme objects
+ */
+export declare function importThemes({ importData, realm, state, }: {
+    importData: ThemeExportInterface;
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton[]>;
+/**
+ * Delete theme by id
+ * @param {string} themeId theme id
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton>} a promise that resolves to a themes object
+ */
+export declare function deleteTheme({ themeId, realm, state, }: {
+    themeId: string;
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton>;
+/**
+ * Delete theme by name
+ * @param {string} themeName theme name
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton>} a promise that resolves to a themes object
+ */
+export declare function deleteThemeByName({ themeName, realm, state, }: {
+    themeName: string;
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton>;
+/**
+ * Delete all themes
+ * @param {string} realm realm name
+ * @returns {Promise<ThemeSkeleton[]>} a promise that resolves to an array of themes
+ */
+export declare function deleteThemes({ realm, state, }: {
+    realm?: string;
+    state: State;
+}): Promise<ThemeSkeleton[]>;
+//# sourceMappingURL=ThemeOps.d.ts.map

package/types/ops/ThemeOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThemeOps.d.ts","sourceRoot":"","sources":["../../src/ops/ThemeOps.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAEjE,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAUxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,MAAM,aAAa,GAAG,yBAAyB,GAAG;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF,eAAO,MAAM,aAAa,kBAAkB,CAAC;AAE7C,MAAM,MAAM,KAAK,GAAG;IAClB;;;OAGG;IACH,yBAAyB,IAAI,oBAAoB,CAAC;IAClD;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IACvC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACnE;;;;;OAKG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3E;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC9C;;;;;;OAMG;IACH,WAAW,CACT,SAAS,EAAE,aAAa,EACxB,OAAO,CAAC,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1B;;;;;;OAMG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,aAAa,EACxB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1B;;;;;;OAMG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,aAAa,EACxB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1B;;;;;OAKG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GACtC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IAC1C;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IACzE;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrE;;;;;OAKG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC7E;;;;OAIG;IACH,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;CACxD,CAAC;yBAEc,OAAO,KAAK,KAAG,KAAK;AAApC,wBAwEE;AAEF,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,EACxC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,oBAAoB,CAKvB;AAsBD;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,EAC/B,KAAY,EACZ,KAAK,GACN,EAAE;IACD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAW3B;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAAC,EAC9B,OAAO,EACP,KAAK,EACL,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAwBzB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,EACpC,SAAS,EACT,KAAK,EACL,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAsBzB;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,EACjC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAuChC;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,EAChC,SAAS,EACT,OAAO,EACP,KAAK,EACL,KAAK,GACN,EAAE;IACD,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAoBzB;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,SAAS,EACT,KAAK,EACL,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CA4CzB;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,SAAS,EACT,SAAS,EACT,KAAK,EACL,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CA0CzB;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,KAAY,EACZ,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAiEzC;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,EACjC,UAAU,EACV,KAAY,EACZ,KAAK,GACN,EAAE;IACD,UAAU,EAAE,oBAAoB,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAiB3B;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,KAAK,EACL,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAsCzB;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,SAAS,EACT,KAAK,EACL,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAsCzB;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,KAAK,GACN,EAAE;IACD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAwB3B"}

package/types/ops/TokenCacheOps.d.ts

@@ -0,0 +1,243 @@
+import { State } from '../shared/State';
+import { UserSessionMetaType } from './AuthenticateOps';
+import { type AccessTokenMetaType } from './OAuth2OidcOps';
+export type TokenCache = {
+    /**
+     * Get connection profiles file name
+     * @returns {string} connection profiles file name
+     */
+    getTokenCachePath(): string;
+    /**
+     * Initialize token cache
+     *
+     * This method is called from app.ts and runs before any of the message handlers are registered.
+     * Therefore none of the Console message functions will produce any output.
+     */
+    initTokenCache(): void;
+    /**
+     * Check if there are suitable tokens in the cache
+     * @param {tokenType} tokenType type of token
+     * @returns {Promise<boolean>} true if tokens found in cache, false otherwise
+     */
+    hasToken(tokenType: tokenType): Promise<boolean>;
+    /**
+     * Check if there are suitable user session tokens in the cache
+     * @returns {Promise<boolean>} true if tokens found in cache, false otherwise
+     */
+    hasUserSessionToken(): Promise<boolean>;
+    /**
+     * Check if there are suitable user bearer tokens in the cache
+     * @returns {Promise<boolean>} true if tokens found in cache, false otherwise
+     */
+    hasUserBearerToken(): Promise<boolean>;
+    /**
+     * Check if there are suitable service account bearer tokens in the cache
+     * @returns {Promise<boolean>} true if tokens found in cache, false otherwise
+     */
+    hasSaBearerToken(): Promise<boolean>;
+    /**
+     * Read token
+     * @param {tokenType} tokenType type of token
+     * @returns {Promise<string>} token or null
+     */
+    readToken(tokenType: tokenType): Promise<AccessTokenMetaType | UserSessionMetaType>;
+    /**
+     * Read user session token
+     * @returns {Promise<string>} token or null
+     */
+    readUserSessionToken(): Promise<UserSessionMetaType>;
+    /**
+     * Read user bearer token
+     * @returns {Promise<string>} token or null
+     */
+    readUserBearerToken(): Promise<AccessTokenMetaType>;
+    /**
+     * Read service account bearer token
+     * @returns {Promise<string>} token or null
+     */
+    readSaBearerToken(): Promise<AccessTokenMetaType>;
+    /**
+     * Save user session token for current connection
+     * @param {string} subject optional real username, recorded for display by list()
+     * @returns {Promise<boolean>} true if the operation succeeded, false otherwise
+     */
+    saveUserSessionToken(token: UserSessionMetaType, subject?: string): Promise<boolean>;
+    /**
+     * Save user bearer token for current connection
+     * @param {string} subject optional real username, recorded for display by list()
+     * @returns {Promise<boolean>} true if the operation succeeded, false otherwise
+     */
+    saveUserBearerToken(token: AccessTokenMetaType, subject?: string): Promise<boolean>;
+    /**
+     * Save service account bearer token for current connection
+     * @param {string} subject optional real service-account name, recorded for display by list()
+     * @returns {Promise<boolean>} true if the operation succeeded, false otherwise
+     */
+    saveSaBearerToken(token: AccessTokenMetaType, subject?: string): Promise<boolean>;
+    /**
+     * Save token of any type for current connection
+     * @param {tokenType} tokenType type of token
+     * @param {UserSessionMetaType | AccessTokenMetaType} token token object
+     * @param {string} subject optional actual subject (e.g. username), recorded for display by list()
+     * @returns {Promise<boolean>} true if the operation succeeded, false otherwise
+     */
+    saveToken(tokenType: tokenType, token: UserSessionMetaType | AccessTokenMetaType, subject?: string): Promise<boolean>;
+    /**
+     * Purge all expired tokens from cache
+     * @returns {TokenCacheInterface} purged cache
+     */
+    purge(): TokenCacheInterface;
+    /**
+     * Flush cache
+     * @returns {boolean} true if the operation succeeded, false otherwise
+     */
+    flush(): boolean;
+    /**
+     * List every cached session across all hosts
+     * @returns {CachedSessionSummary[]} flattened list of cache entries
+     */
+    list(): CachedSessionSummary[];
+    /**
+     * Delete all cached tokens for a host, or just one realm under it
+     * @param {string} host host to delete cached tokens for
+     * @param {string} realm optional realm to scope the deletion to
+     * @returns {boolean} true if a matching entry was found and removed, false otherwise
+     */
+    deleteHost(host: string, realm?: string): boolean;
+};
+declare const _default: (state: State) => TokenCache;
+export default _default;
+export type tokenType = 'userSession' | 'userBearer' | 'pfUserBearer' | 'saBearer' | 'pfSaBearer' | 'browserUserSession' | 'browserUserBearer';
+export interface TokenCacheInterface {
+    [hostKey: string]: {
+        [realmKey: string]: {
+            [typeKey in tokenType]: {
+                [subjectKey: string]: {
+                    [expKey: string]: string;
+                };
+            };
+        };
+    };
+}
+/**
+ * Get token cache file name
+ * @param {State} state library state
+ * @returns {String} connection profiles file name
+ */
+export declare function getTokenCachePath({ state }: {
+    state: State;
+}): string;
+/**
+ * Initialize connection profiles
+ *
+ * This method is called from app.ts and runs before any of the message handlers are registered.
+ * Therefore none of the Console message functions will produce any output.
+ * @param {State} state library state
+ */
+export declare function initTokenCache({ state }: {
+    state: State;
+}): void;
+export declare function hasToken({ tokenType, state, }: {
+    tokenType: tokenType;
+    state: State;
+}): Promise<boolean>;
+export declare function hasUserSessionToken({ state, }: {
+    state: State;
+}): Promise<boolean>;
+export declare function hasUserBearerToken({ state, }: {
+    state: State;
+}): Promise<boolean>;
+export declare function hasSaBearerToken({ state, }: {
+    state: State;
+}): Promise<boolean>;
+/**
+ * Returns the subject already recorded for `state.getHost()` and the given
+ * token type (see `recordSubjectIndexEntry()`), or `undefined` if nothing's
+ * been recorded for it yet. A cheap, local, synchronous file read — used
+ * by `AuthenticateOps.ts`'s cache-hit browser-session reuse to show the
+ * same resolved subject `frodo session list` would, without repeating the
+ * (potentially network-calling) resolution work that produced it in the
+ * first place.
+ */
+export declare function getRecordedSubject({ tokenType, state, }: {
+    tokenType: tokenType;
+    state: State;
+}): string | undefined;
+export declare function readToken({ tokenType, state, }: {
+    tokenType: tokenType;
+    state: State;
+}): Promise<AccessTokenMetaType | UserSessionMetaType>;
+export declare function readUserSessionToken({ state, }: {
+    state: State;
+}): Promise<UserSessionMetaType>;
+export declare function readUserBearerToken({ state, }: {
+    state: State;
+}): Promise<AccessTokenMetaType>;
+export declare function readSaBearerToken({ state, }: {
+    state: State;
+}): Promise<AccessTokenMetaType>;
+export declare function saveUserSessionToken({ token, subject, state, }: {
+    token: UserSessionMetaType;
+    subject?: string;
+    state: State;
+}): Promise<boolean>;
+export declare function saveUserBearerToken({ token, subject, state, }: {
+    token: AccessTokenMetaType;
+    subject?: string;
+    state: State;
+}): Promise<boolean>;
+export declare function saveSaBearerToken({ token, subject, state, }: {
+    token: AccessTokenMetaType;
+    subject?: string;
+    state: State;
+}): Promise<boolean>;
+export declare function saveToken({ tokenType, token, subject, state, }: {
+    tokenType: tokenType;
+    token: UserSessionMetaType | AccessTokenMetaType;
+    subject?: string;
+    state: State;
+}): Promise<boolean>;
+export declare function purge({ state }: {
+    state: State;
+}): TokenCacheInterface;
+export declare function flush({ state }: {
+    state: State;
+}): boolean;
+export interface CachedSessionSummary {
+    host: string;
+    realm: string;
+    tokenType: tokenType | 'unknown';
+    subject: string;
+    expires: number;
+    isExpired: boolean;
+}
+/**
+ * Lists every cache entry across all hosts, flattening the cache's
+ * `host -> realm -> tokenType -> subject -> exp` structure. `host` is
+ * resolved via the side index recorded alongside every save (see
+ * `recordHostIndexEntry()`); a cache file untouched since before that index
+ * existed reports `'unknown'` for entries it can't resolve yet — they
+ * self-heal the next time that host's token is saved again. `subject` is
+ * only resolvable for browser-login entries today (their subject key is a
+ * fixed constant, not derived from anything host/user-specific); every
+ * other auth mode's subject key is derived from a credential (password,
+ * service-account JWK) this function has no access to, so it reports
+ * `'unknown'` for those rather than guessing.
+ */
+export declare function listCachedSessions({ state, }: {
+    state: State;
+}): CachedSessionSummary[];
+/**
+ * Removes all cached tokens for a host (or just one realm under it),
+ * mirroring `flush()`'s file-rewrite shape but scoped instead of
+ * whole-file. Powers `frodo session delete <host>` (v1: local cache clear
+ * only, no server-side session/token invalidation — see the plan doc's
+ * Phase F addendum).
+ * @returns {boolean} true if a matching entry was found and removed, false if there was nothing to delete
+ */
+export declare function deleteHostTokens({ host, realm, state, }: {
+    host: string;
+    realm?: string;
+    state: State;
+}): boolean;
+//# sourceMappingURL=TokenCacheOps.d.ts.map

package/types/ops/TokenCacheOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenCacheOps.d.ts","sourceRoot":"","sources":["../../src/ops/TokenCacheOps.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AASxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAE3D,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,iBAAiB,IAAI,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,cAAc,IAAI,IAAI,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD;;;OAGG;IACH,mBAAmB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC;;;OAGG;IACH,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACrC;;;;OAIG;IACH,SAAS,CACP,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC,CAAC;IACtD;;;OAGG;IACH,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACrD;;;OAGG;IACH,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACpD;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAClD;;;;OAIG;IACH,oBAAoB,CAClB,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB;;;;OAIG;IACH,mBAAmB,CACjB,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB;;;;OAIG;IACH,iBAAiB,CACf,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB;;;;;;OAMG;IACH,SAAS,CACP,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,mBAAmB,GAAG,mBAAmB,EAChD,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB;;;OAGG;IACH,KAAK,IAAI,mBAAmB,CAAC;IAC7B;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC;IACjB;;;OAGG;IACH,IAAI,IAAI,oBAAoB,EAAE,CAAC;IAC/B;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACnD,CAAC;yBAEc,OAAO,KAAK,KAAG,UAAU;AAAzC,wBAiFE;AAkBF,MAAM,MAAM,SAAS,GACjB,aAAa,GACb,YAAY,GACZ,cAAc,GACd,UAAU,GACV,YAAY,GAOZ,oBAAoB,GACpB,mBAAmB,CAAC;AAExB,MAAM,WAAW,mBAAmB;IAClC,CAAC,OAAO,EAAE,MAAM,GAAG;QACjB,CAAC,QAAQ,EAAE,MAAM,GAAG;aACjB,OAAO,IAAI,SAAS,GAAG;gBACtB,CAAC,UAAU,EAAE,MAAM,GAAG;oBACpB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;iBAC1B,CAAC;aACH;SACF,CAAC;KACH,CAAC;CACH;AAID;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG,MAAM,CAcrE;AAiED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,QAmCzD;AAED,wBAAsB,QAAQ,CAAC,EAC7B,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAoBnB;AAED,wBAAsB,mBAAmB,CAAC,EACxC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAEnB;AAED,wBAAsB,kBAAkB,CAAC,EACvC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAEnB;AAED,wBAAsB,gBAAgB,CAAC,EACrC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAEnB;AAyKD;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,MAAM,GAAG,SAAS,CAErB;AAgCD,wBAAsB,SAAS,CAAC,EAC9B,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC,CAwDrD;AAED,wBAAsB,oBAAoB,CAAC,EACzC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAK/B;AAED,wBAAsB,mBAAmB,CAAC,EACxC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAK/B;AAED,wBAAsB,iBAAiB,CAAC,EACtC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAK/B;AAgFD,wBAAsB,oBAAoB,CAAC,EACzC,KAAK,EACL,OAAO,EACP,KAAK,GACN,EAAE;IACD,KAAK,EAAE,mBAAmB,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAkFnB;AAED,wBAAsB,mBAAmB,CAAC,EACxC,KAAK,EACL,OAAO,EACP,KAAK,GACN,EAAE;IACD,KAAK,EAAE,mBAAmB,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAkFnB;AAED,wBAAsB,iBAAiB,CAAC,EACtC,KAAK,EACL,OAAO,EACP,KAAK,GACN,EAAE;IACD,KAAK,EAAE,mBAAmB,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAsFnB;AAED,wBAAsB,SAAS,CAAC,EAC9B,SAAS,EACT,KAAK,EACL,OAAO,EACP,KAAK,GACN,EAAE;IACD,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,mBAAmB,GAAG,mBAAmB,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAkFnB;AAED,wBAAgB,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG,mBAAmB,CA2BtE;AAED,wBAAgB,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAoB1D;AAqCD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,oBAAoB,EAAE,CAuDzB;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,IAAI,EACJ,KAAK,EACL,KAAK,GACN,EAAE;IACD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAoCV"}