@rockcarver/frodo-lib 4.10.0 → 4.11.0

package/types/ops/ScriptOps.d.ts

@@ -0,0 +1,426 @@
+import { type ScriptSkeleton } from '../api/ScriptApi';
+import { ResultCallback, type ExportMetaData } from '../ops/OpsTypes';
+import { State } from '../shared/State';
+export type Script = {
+    /**
+     * Create an empty script export template
+     * @returns {ScriptExportInterface} an empty script export template
+     */
+    createScriptExportTemplate(): ScriptExportInterface;
+    /**
+     * Read all scripts
+     * @param {ScriptFilter} filter Optional script filter
+     * @returns {Promise<ScriptSkeleton[]>} a promise that resolves to an array of script objects
+     */
+    readScripts(filter?: ScriptFilter): Promise<ScriptSkeleton[]>;
+    /**
+     * List scripts with only lightweight identifying fields (no script body)
+     * @param {ScriptFilter} filter Optional script filter
+     * @returns {Promise<ScriptSummary[]>} a promise that resolves to an array of lightweight script summaries
+     */
+    listScripts(filter?: ScriptFilter): Promise<ScriptSummary[]>;
+    /**
+     * Get the names of library scripts required by the input script object
+     *
+     * @param {ScriptSkeleton} scriptObj the script object
+     * @returns an array of required library script names
+     */
+    getLibraryScriptNames(scriptObj: ScriptSkeleton): string[];
+    /**
+     * Read script
+     * @param {string} scriptId script id
+     * @returns {Promise<ScriptSkeleton>} promise that resolves to a script object
+     */
+    readScript(scriptId: string): Promise<ScriptSkeleton>;
+    /**
+     * Read script by name
+     * @param {string} scriptName name of the script
+     * @returns {Promise<ScriptSkeleton>} promise that resolves to a script object
+     */
+    readScriptByName(scriptName: string): Promise<ScriptSkeleton>;
+    /**
+     * Read a script's plain-text source only, without the surrounding metadata
+     * @param {string} scriptId script id
+     * @returns {Promise<string>} the decoded script source
+     */
+    readScriptSource(scriptId: string): Promise<string>;
+    /**
+     * Read a script's plain-text source only, by name, without the surrounding metadata
+     * @param {string} scriptName name of the script
+     * @returns {Promise<string>} the decoded script source
+     */
+    readScriptSourceByName(scriptName: string): Promise<string>;
+    /**
+     * Create script
+     * @param {string} scriptId script id
+     * @param {string} scriptName name of the script
+     * @param {ScriptSkeleton} scriptData script object
+     * @returns {Promise<ScriptSkeleton>} a status object
+     */
+    createScript(scriptId: string, scriptName: string, scriptData: ScriptSkeleton): Promise<ScriptSkeleton>;
+    /**
+     * Create or update script
+     * @param {string} scriptId script id
+     * @param {ScriptSkeleton} scriptData script object
+     * @returns {Promise<ScriptSkeleton | null>} a script object, or null if no update was made
+     */
+    updateScript(scriptId: string, scriptData: ScriptSkeleton): Promise<ScriptSkeleton | null>;
+    /**
+     * Update only a script's source, preserving all other metadata
+     * @param {string} scriptId script id
+     * @param {string} source new plain-text script source
+     * @returns {Promise<ScriptSkeleton>} the updated script object
+     */
+    updateScriptSource(scriptId: string, source: string): Promise<ScriptSkeleton>;
+    /**
+     * Delete script
+     * @param {string} scriptId script id
+     * @returns {Promise<ScriptSkeleton>} promise that resolves to a script object
+     */
+    deleteScript(scriptId: string): Promise<ScriptSkeleton>;
+    /**
+     * Delete script by name
+     * @param {String} scriptName script name
+     * @returns {Promise<ScriptSkeleton>} a promise that resolves to a script object
+     */
+    deleteScriptByName(scriptName: string): Promise<ScriptSkeleton>;
+    /**
+     * Delete all non-default scripts
+     * @param {ResultCallback} resultCallback Optional callback to process individual results
+     * @param {ScriptFilter} filter Optional script filter
+     * @returns {Promise<ScriptSkeleton[]>} a promise that resolves to an array of script objects
+     */
+    deleteScripts(resultCallback?: ResultCallback<ScriptSkeleton>, filter?: ScriptFilter): Promise<ScriptSkeleton[]>;
+    /**
+     * Export all scripts
+     * @param {ScriptExportOptions} options script export options
+     * @param {ResultCallback} resultCallback Optional callback to process individual results
+     * @returns {Promise<ScriptExportInterface>} a promise that resolved to a ScriptExportInterface object
+     */
+    exportScripts(options?: ScriptExportOptions, resultCallback?: ResultCallback<ScriptSkeleton>): Promise<ScriptExportInterface>;
+    /**
+     * Export script by id
+     * @param {string} scriptId script uuid
+     * @param {ScriptExportOptions} options script export options
+     * @returns {Promise<ScriptExportInterface>} a promise that resolved to a ScriptExportInterface object
+     */
+    exportScript(scriptId: string, options?: ScriptExportOptions): Promise<ScriptExportInterface>;
+    /**
+     * Export script by name
+     * @param {string} scriptName script name
+     * @param {ScriptExportOptions} options script export options
+     * @returns {Promise<ScriptExportInterface>} a promise that resolved to a ScriptExportInterface object
+     */
+    exportScriptByName(scriptName: string, options?: ScriptExportOptions): Promise<ScriptExportInterface>;
+    /**
+     * Import scripts
+     * @param {string} scriptId Optional id of script. If supplied, only the script of that id is imported. Takes priority over scriptName if both are provided.
+     * @param {string} scriptName Optional name of script. If supplied, only the script of that name is imported
+     * @param {ScriptExportInterface} importData Script import data
+     * @param {ScriptImportOptions} options Script import options
+     * @param {boolean} validate If true, validates Javascript scripts to ensure no errors exist in them. Default: false
+     * @param {ResultCallback} resultCallback Optional callback to process individual results
+     * @returns {Promise<ScriptSkeleton[]>} the imported scripts
+     */
+    importScripts(scriptId: string, scriptName: string, importData: ScriptExportInterface, options?: ScriptImportOptions, validate?: boolean, resultCallback?: ResultCallback<ScriptSkeleton>): Promise<ScriptSkeleton[]>;
+};
+declare const _default: (state: State) => Script;
+export default _default;
+export interface ScriptExportInterface {
+    meta?: ExportMetaData;
+    script: Record<string, ScriptSkeleton>;
+}
+/**
+ * Script import options
+ */
+export interface ScriptImportOptions {
+    /**
+     * Include dependency (library) scripts in export
+     */
+    deps: boolean;
+    /**
+     * Generate new UUIDs for all scripts during import.
+     */
+    reUuid: boolean;
+    /**
+     * Include default scripts in import if true
+     */
+    includeDefault: boolean;
+    /**
+     * Optional script filter to select which scripts to import
+     */
+    filter?: ScriptFilter;
+}
+/**
+ * Script export options
+ */
+export interface ScriptExportOptions {
+    /**
+     * Include dependency (library) scripts in export
+     */
+    deps: boolean;
+    /**
+     * Include default scripts in export if true
+     */
+    includeDefault: boolean;
+    /**
+     * Use string arrays to store script code
+     */
+    useStringArrays: boolean;
+    /**
+     * Optional script filter to select which scripts to export
+     */
+    filter?: ScriptFilter;
+}
+export interface ScriptFilterCondition {
+    /**
+     * Script property to filter by.
+     *
+     * Supported built-in fields:
+     * - `language`: the script engine (`field: 'language'`), such as `JAVASCRIPT` or `GROOVY`
+     * - `context` / `use`: the AM script use (`field: 'context'` or `field: 'use'`), such as
+     *   `AUTHENTICATION_TREE_DECISION_NODE` or `OAUTH2_ACCESS_TOKEN_MODIFICATION`
+     * - `evaluatorVersion`: the script evaluator schema version (`field: 'evaluatorVersion'`), such as
+     *   `1.0` (legacy) or `2.0` (nextgen)
+     *
+     * Any other script property name is matched directly against the script object.
+     */
+    field: string;
+    /**
+     * One or more values to match against the selected field.
+     * Multiple values are OR-ed together.
+     *
+     * Examples:
+     * - `value: 'javascript'`
+     * - `value: ['AUTHENTICATION_TREE_DECISION_NODE', 'OAUTH2_ACCESS_TOKEN_MODIFICATION']`
+     * - `value: '2.0'`
+     */
+    value: string | string[];
+}
+export interface ScriptFilterGroup {
+    /**
+     * Logical operator used to evaluate nested filters. Defaults to `AND`.
+     */
+    operator?: 'AND' | 'OR';
+    /**
+     * Nested filters evaluated with the selected operator.
+     */
+    filters: ScriptFilter[];
+}
+export type ScriptFilter = ScriptFilterCondition | ScriptFilterGroup;
+/**
+ * Lightweight script identifying fields, without the (potentially large)
+ * script body. Returned by {@link listScripts} so callers that only need to
+ * enumerate scripts (e.g. to check what exists, or diff against another
+ * source of ids) don't have to fetch every script's full body to get there.
+ */
+export type ScriptSummary = Pick<ScriptSkeleton, '_id' | 'name' | 'context' | 'language' | 'evaluatorVersion' | 'default'>;
+/**
+ * Create an empty script export template
+ * @returns {ScriptExportInterface} an empty script export template
+ */
+export declare function createScriptExportTemplate({ state, }: {
+    state: State;
+}): ScriptExportInterface;
+/**
+ * Get all scripts
+ * @param {ScriptFilter} filter Optional script filter
+ * @returns {Promise<ScriptSkeleton[]>} a promise that resolves to an array of script objects
+ */
+export declare function readScripts({ filter, state, }: {
+    filter?: ScriptFilter;
+    state: State;
+}): Promise<ScriptSkeleton[]>;
+/**
+ * List scripts with only lightweight identifying fields (no script body)
+ *
+ * @remarks
+ * A realm can hold hundreds of scripts, and {@link readScripts} always
+ * returns the full body of every one of them. This is a strip-down wrapper
+ * over readScripts (the underlying AM endpoint doesn't currently support
+ * field-projection query params here), so it doesn't reduce the network
+ * call, but it avoids ever handing large script bodies to a caller that only
+ * needs to know what scripts exist.
+ *
+ * @param {ScriptFilter} filter Optional script filter
+ * @returns {Promise<ScriptSummary[]>} a promise that resolves to an array of lightweight script summaries
+ */
+export declare function listScripts({ filter, state, }: {
+    filter?: ScriptFilter;
+    state: State;
+}): Promise<ScriptSummary[]>;
+/**
+ * Get the names of library scripts required by the input script object
+ *
+ * @param {ScriptSkeleton} scriptObj the script object
+ * @returns {string[]} an array of required library script names
+ */
+export declare function getLibraryScriptNames(scriptObj: ScriptSkeleton): string[];
+/**
+ * Gets all library scripts for a given script recursively
+ *
+ * @param {ScriptSkeleton} scriptData the script object
+ * @returns {ScriptSkeleton[]} all the library scripts needed for the given script
+ */
+export declare function getLibraryScripts({ scriptData, state, }: {
+    scriptData: ScriptSkeleton;
+    state: State;
+}): Promise<ScriptSkeleton[]>;
+/**
+ * Get script
+ *
+ * @param {string} scriptId the script id
+ * @returns {Promise<ScriptSkeleton>} a promise that resolves to an array of script objects
+ */
+export declare function readScript({ scriptId, state, }: {
+    scriptId: string;
+    state: State;
+}): Promise<ScriptSkeleton>;
+/**
+ * Get script by name
+ * @param {string} scriptName name of the script
+ * @returns {Promise<ScriptSkeleton>} promise that resolves to a script object
+ */
+export declare function readScriptByName({ scriptName, state, }: {
+    scriptName: string;
+    state: State;
+}): Promise<ScriptSkeleton>;
+/**
+ * Read a script's plain-text source only, without the surrounding metadata
+ * @param {string} scriptId script id
+ * @returns {Promise<string>} the decoded script source
+ */
+export declare function readScriptSource({ scriptId, state, }: {
+    scriptId: string;
+    state: State;
+}): Promise<string>;
+/**
+ * Read a script's plain-text source only, by name, without the surrounding metadata
+ * @param {string} scriptName name of the script
+ * @returns {Promise<string>} the decoded script source
+ */
+export declare function readScriptSourceByName({ scriptName, state, }: {
+    scriptName: string;
+    state: State;
+}): Promise<string>;
+/**
+ * Create script
+ * @param {string} scriptId the script id
+ * @param {string} scriptName the script name
+ * @param {ScriptSkeleton} scriptData script object
+ * @returns {Promise<ScriptSkeleton>} a promise resolving to a script object
+ */
+export declare function createScript({ scriptId, scriptName, scriptData, state, }: {
+    scriptId: string;
+    scriptName: string;
+    scriptData: ScriptSkeleton;
+    state: State;
+}): Promise<ScriptSkeleton>;
+/**
+ * Create or update script
+ * @param {string} scriptId script uuid
+ * @param {ScriptSkeleton} scriptData script object
+ * @returns {Promise<ScriptSkeleton | null>} a script object, or null if no update was made
+ */
+export declare function updateScript({ scriptId, scriptData, state, }: {
+    scriptId: string;
+    scriptData: ScriptSkeleton;
+    state: State;
+}): Promise<ScriptSkeleton | null>;
+/**
+ * Update only a script's source, preserving all other metadata
+ * @param {string} scriptId script uuid
+ * @param {string} source new plain-text script source
+ * @returns {Promise<ScriptSkeleton>} the updated script object
+ */
+export declare function updateScriptSource({ scriptId, source, state, }: {
+    scriptId: string;
+    source: string;
+    state: State;
+}): Promise<ScriptSkeleton>;
+/**
+ * Delete script
+ * @param {string} scriptId script uuid
+ * @returns {Promise<ScriptSkeleton>} a promise resolving to a script object
+ */
+export declare function deleteScript({ scriptId, state, }: {
+    scriptId: string;
+    state: State;
+}): Promise<ScriptSkeleton>;
+/**
+ * Delete script by name
+ * @param {String} scriptName script name
+ * @returns {Promise<ScriptSkeleton>} a promise that resolves to a script object
+ */
+export declare function deleteScriptByName({ scriptName, state, }: {
+    scriptName: string;
+    state: State;
+}): Promise<ScriptSkeleton>;
+/**
+ * Delete all non-default scripts
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @param {ScriptFilter} filter Optional script filter
+ * @returns {Promise<ScriptSkeleton[]>} a promise that resolves to an array of script objects
+ */
+export declare function deleteScripts({ filter, resultCallback, state, }: {
+    filter?: ScriptFilter;
+    resultCallback?: ResultCallback<ScriptSkeleton>;
+    state: State;
+}): Promise<ScriptSkeleton[]>;
+/**
+ * Export script by id
+ *
+ * @param {string} scriptId script uuid
+ * @param {ScriptExportOptions} options script export options
+ * @returns {Promise<ScriptExportInterface>} a promise that resolved to a ScriptExportInterface object
+ */
+export declare function exportScript({ scriptId, options, state, }: {
+    scriptId: string;
+    options?: ScriptExportOptions;
+    state: State;
+}): Promise<ScriptExportInterface>;
+/**
+ * Export script by name
+ *
+ * @param {string} scriptName script name
+ * @param {ScriptExportOptions} options script export options
+ * @returns {Promise<ScriptExportInterface>} a promise that resolved to a ScriptExportInterface object
+ */
+export declare function exportScriptByName({ scriptName, options, state, }: {
+    scriptName: string;
+    options?: ScriptExportOptions;
+    state: State;
+}): Promise<ScriptExportInterface>;
+/**
+ * Export all scripts
+ *
+ * @param {ScriptExportOptions} options script export options
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<ScriptExportInterface>} a promise that resolved to a ScriptExportInterface object
+ */
+export declare function exportScripts({ options, resultCallback, state, }: {
+    options?: ScriptExportOptions;
+    resultCallback?: ResultCallback<ScriptSkeleton>;
+    state: State;
+}): Promise<ScriptExportInterface>;
+/**
+ * Import scripts
+ * @param {object} params Params object.
+ * @param {string} params.scriptId Optional id of script. If supplied, only the script of that id is imported. Takes priority over scriptName if both are provided.
+ * @param {string} params.scriptName Optional name of script. If supplied, only the script of that name is imported
+ * @param {ScriptExportInterface} params.importData Script import data
+ * @param {ScriptImportOptions} params.options Script import options
+ * @param {boolean} params.validate If true, validates Javascript scripts to ensure no errors exist in them. Default: false
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<ScriptSkeleton[]>} the imported scripts
+ */
+export declare function importScripts({ scriptId, scriptName, importData, options, validate, resultCallback, state, }: {
+    scriptId?: string;
+    scriptName?: string;
+    importData: ScriptExportInterface;
+    options?: ScriptImportOptions;
+    validate?: boolean;
+    resultCallback?: ResultCallback<ScriptSkeleton>;
+    state: State;
+}): Promise<ScriptSkeleton[]>;
+//# sourceMappingURL=ScriptOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ScriptOps.d.ts","sourceRoot":"","sources":["../../src/ops/ScriptOps.ts"],"names":[],"mappings":"AACA,OAAO,EAQL,KAAK,cAAc,EACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAuBxC,MAAM,MAAM,MAAM,GAAG;IACnB;;;OAGG;IACH,0BAA0B,IAAI,qBAAqB,CAAC;IACpD;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC9D;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAC7D;;;;;OAKG;IACH,qBAAqB,CAAC,SAAS,EAAE,cAAc,GAAG,MAAM,EAAE,CAAC;IAC3D;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACtD;;;;OAIG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9D;;;;OAIG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACpD;;;;OAIG;IACH,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5D;;;;;;OAMG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC,cAAc,CAAC,CAAC;IAC3B;;;;;OAKG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAClC;;;;;OAKG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9E;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACxD;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAChE;;;;;OAKG;IACH,aAAa,CACX,cAAc,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,EAC/C,MAAM,CAAC,EAAE,YAAY,GACpB,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC7B;;;;;OAKG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,mBAAmB,EAC7B,cAAc,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAC9C,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;;OAKG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;;OAKG;IACH,kBAAkB,CAChB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;;;;;;OASG;IACH,aAAa,CACX,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,qBAAqB,EACjC,OAAO,CAAC,EAAE,mBAAmB,EAC7B,QAAQ,CAAC,EAAE,OAAO,EAClB,cAAc,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAC9C,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;CAC9B,CAAC;yBAEc,OAAO,KAAK,KAAG,MAAM;AAArC,wBA8GE;AAEF,MAAM,WAAW,qBAAqB;IACpC,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,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAED,MAAM,MAAM,YAAY,GAAG,qBAAqB,GAAG,iBAAiB,CAAC;AAErE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,cAAc,EACd,KAAK,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,kBAAkB,GAAG,SAAS,CACzE,CAAC;AAEF;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,EACzC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,qBAAqB,CAKxB;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,EAChC,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAU5B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,WAAW,CAAC,EAChC,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAU3B;AAeD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,cAAc,GAAG,MAAM,EAAE,CAKzE;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,cAAc,CAAC;IAC3B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAO5B;AAoCD;;;;;GAKG;AACH,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;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CAqB1B;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,MAAM,CAAC,CAGlB;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,MAAM,CAAC,CAGlB;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,UAAU,EACV,UAAU,EACV,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,cAAc,CAAC;IAC3B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CA+B1B;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,UAAU,EACV,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,cAAc,CAAC;IAC3B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAoCjC;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,QAAQ,EACR,MAAM,EACN,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CAI1B;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CAS1B;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CAS1B;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,EAClC,MAAM,EACN,cAAc,EACd,KAAK,GACN,EAAE;IACD,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC;IAChD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAoB5B;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,OAIC,EACD,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAajC;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,OAIC,EACD,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAajC;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,EAClC,OAIC,EACD,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,cAAc,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC;IAChD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAqCjC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,aAAa,CAAC,EAClC,QAAQ,EACR,UAAU,EACV,UAAU,EACV,OAIC,EACD,QAAgB,EAChB,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,qBAAqB,CAAC;IAClC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC;IAChD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAyD5B"}

package/types/ops/ScriptTypeOps.d.ts

@@ -0,0 +1,124 @@
+import { EngineConfigurationSkeleton, ScriptBinding, ScriptingContextSkeleton, ScriptTypeSkeleton } from '../api/ScriptTypeApi';
+import { State } from '../shared/State';
+import { ExportMetaData } from './OpsTypes';
+export type ScriptType = {
+    /**
+     * Create an empty scriptType export template
+     * @returns {ScriptTypeExportInterface} an empty scriptType export template
+     */
+    createScriptTypeExportTemplate(): ScriptTypeExportInterface;
+    /**
+     * Read scriptType by id
+     * @param {string} scriptTypeId ScriptType id
+     * @returns {Promise<ScriptTypeSkeleton>} a promise that resolves to a scriptType object
+     */
+    readScriptType(scriptTypeId: string): Promise<ScriptTypeSkeleton>;
+    /**
+     * Read all scriptTypes.
+     * @returns {Promise<ScriptTypeSkeleton[]>} a promise that resolves to an array of scriptType objects
+     */
+    readScriptTypes(): Promise<ScriptTypeSkeleton[]>;
+    /**
+     * Export all scriptTypes. The response can be saved to file as is.
+     * @returns {Promise<ScriptTypeExportInterface>} Promise resolving to a ScriptTypeExportInterface object.
+     */
+    exportScriptTypes(): Promise<ScriptTypeExportInterface>;
+    /**
+     * Read the bindings (available objects/APIs, e.g. httpClient, idRepository)
+     * exposed to scripts running in a given scripting context.
+     * @param {string} context scripting context id, e.g. SCRIPTED_DECISION_NODE
+     * @returns {Promise<ScriptBinding[]>} a promise that resolves to an array of script bindings
+     */
+    readScriptBindings(context: string): Promise<ScriptBinding[]>;
+    /**
+     * Update script type
+     * @param {string} scriptTypeId script type id
+     * @param {ScriptTypeSkeleton} scriptTypeData script type data
+     * @returns {Promise<ScriptTypeSkeleton>} a promise resolving to a script type object
+     */
+    updateScriptType(scriptTypeId: string, scriptTypeData: ScriptTypeSkeleton): Promise<ScriptTypeSkeleton>;
+    /**
+     * Import script types
+     * @param {ScriptTypeExportInterface} importData script type import data
+     * @param {string} scriptTypeId Optional script type id. If supplied, only the script type of that id is imported. Takes priority over scriptTypeUrl if both are provided.
+     * @returns {Promise<ScriptTypeSkeleton[]>} the imported script types
+     */
+    importScriptTypes(importData: ScriptTypeExportInterface, scriptTypeId?: string): Promise<ScriptTypeSkeleton[]>;
+};
+declare const _default: (state: State) => ScriptType;
+export default _default;
+export type ScriptTypeExportSkeleton = ScriptTypeSkeleton & {
+    engineConfiguration: EngineConfigurationSkeleton;
+    context: ScriptingContextSkeleton;
+};
+export interface ScriptTypeExportInterface {
+    meta?: ExportMetaData;
+    scripttype: Record<string, ScriptTypeExportSkeleton>;
+}
+/**
+ * Create an empty scriptType export template
+ * @returns {ScriptTypeExportInterface} an empty scriptType export template
+ */
+export declare function createScriptTypeExportTemplate({ state, }: {
+    state: State;
+}): ScriptTypeExportInterface;
+/**
+ * Read scriptType by id
+ * @param {string} scriptTypeId ScriptType id
+ * @returns {Promise<ScriptTypeSkeleton>} a promise that resolves to a scriptType object
+ */
+export declare function readScriptType({ scriptTypeId, state, }: {
+    scriptTypeId: string;
+    state: State;
+}): Promise<ScriptTypeSkeleton>;
+/**
+ * Read the bindings (available objects/APIs, e.g. httpClient, idRepository)
+ * exposed to scripts running in a given scripting context. This is the same
+ * underlying data `exportScriptTypes` already fetches per script type (as
+ * its `context.bindings` field) -- exposed here as a standalone, targeted
+ * read so a caller doesn't need to export every script type just to answer
+ * "what can a script in context X call?"
+ * @param {string} context scripting context id, e.g. SCRIPTED_DECISION_NODE
+ * @returns {Promise<ScriptBinding[]>} a promise that resolves to an array of script bindings
+ */
+export declare function readScriptBindings({ context, state, }: {
+    context: string;
+    state: State;
+}): Promise<ScriptBinding[]>;
+/**
+ * Read all scriptTypes.
+ * @returns {Promise<ScriptTypeSkeleton[]>} a promise that resolves to an array of scriptType objects
+ */
+export declare function readScriptTypes({ state, }: {
+    state: State;
+}): Promise<ScriptTypeSkeleton[]>;
+/**
+ * Export all scriptTypes. The response can be saved to file as is.
+ * @returns {Promise<ScriptTypeExportInterface>} Promise resolving to a ScriptTypeExportInterface object.
+ */
+export declare function exportScriptTypes({ state, }: {
+    state: State;
+}): Promise<ScriptTypeExportInterface>;
+/**
+ * Update script type
+ * @param {string} scriptTypeId script type id
+ * @param {ScriptTypeSkeleton} scriptTypeData script type config object
+ * @returns {Promise<ScriptTypeSkeleton>} a promise that resolves to a script type object
+ */
+export declare function updateScriptType({ scriptTypeId, scriptTypeData, state, }: {
+    scriptTypeId: string;
+    scriptTypeData: ScriptTypeSkeleton;
+    state: State;
+}): Promise<ScriptTypeSkeleton>;
+/**
+ * Import script types
+ * @param {string} scriptTypeId Optional script type id. If supplied, only the script type of that id is imported. Takes priority over scriptTypeUrl if both are provided.
+ * @param {ScriptTypeExportInterface} importData script type import data
+ * @returns {Promise<ScriptTypeExportSkeleton[]>} the imported script types
+ */
+export declare function importScriptTypes({ scriptTypeId, importData, state, }: {
+    scriptTypeId?: string;
+    importData: ScriptTypeExportInterface;
+    state: State;
+}): Promise<ScriptTypeExportSkeleton[]>;
+//# sourceMappingURL=ScriptTypeOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ScriptTypeOps.d.ts","sourceRoot":"","sources":["../../src/ops/ScriptTypeOps.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAO3B,aAAa,EACb,wBAAwB,EACxB,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAUxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,8BAA8B,IAAI,yBAAyB,CAAC;IAC5D;;;;OAIG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAClE;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACjD;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACxD;;;;;OAKG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAC9D;;;;;OAKG;IACH,gBAAgB,CACd,YAAY,EAAE,MAAM,EACpB,cAAc,EAAE,kBAAkB,GACjC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC/B;;;;;OAKG;IACH,iBAAiB,CACf,UAAU,EAAE,yBAAyB,EACrC,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;CAClC,CAAC;yBAEc,OAAO,KAAK,KAAG,UAAU;AAAzC,wBAkCE;AAEF,MAAM,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAC1D,mBAAmB,EAAE,2BAA2B,CAAC;IACjD,OAAO,EAAE,wBAAwB,CAAC;CACnC,CAAC;AAEF,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;CACtD;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,EAC7C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,yBAAyB,CAK5B;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,EACnC,YAAY,EACZ,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAM9B;AAED;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAU3B;AAED;;;GAGG;AACH,wBAAsB,eAAe,CAAC,EACpC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAYhC;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAgErC;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,YAAY,EACZ,cAAc,EACd,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,kBAAkB,CAAC;IACnC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAE9B;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,YAAY,EACZ,UAAU,EACV,KAAK,GACN,EAAE;IACD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,yBAAyB,CAAC;IACtC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC,CA6CtC"}