@rockcarver/frodo-lib 4.10.0 → 4.11.0-1

package/types/ops/IdmSystemOps.d.ts

@@ -0,0 +1,198 @@
+import { IdObjectSkeletonInterface, PagedResult } from '../api/ApiTypes';
+import { ConnectorServerStatusInterface, SystemObjectPatchOperationInterface, SystemStatusInterface } from '../api/IdmSystemApi';
+import { State } from '../shared/State';
+import { ObjectTypeSkeleton } from './ConnectorOps';
+export type IdmSystem = {
+    /**
+     * Test connector servers
+     * @returns {Promise<ConnectorServerStatusInterface[]>} a promise that resolves to an array of ConnectorServerStatusInterface objects
+     */
+    testConnectorServers(): Promise<ConnectorServerStatusInterface[]>;
+    /**
+     * Read available systems/connectors status
+     * @returns {Promise<SystemStatusInterface[]>} a promise resolving to an array of system status objects
+     */
+    readAvailableSystems(): Promise<SystemStatusInterface[]>;
+    /**
+     * Read available connectors
+     * @returns {Promise<SystemStatusInterface[]>} a promise resolving to an array of connector status objects
+     */
+    readAvailableConnectors(): Promise<SystemStatusInterface[]>;
+    /**
+     * Read system/connector status
+     * @returns {Promise<SystemStatusInterface>} a promise resolving to a system status object
+     */
+    readSystemStatus(systemName: string): Promise<SystemStatusInterface>;
+    /**
+     * Authenticate a system object using username and password (pass-through authentication)
+     * @param {string} systemName name of system/connector
+     * @param {string} systemObjectType type of system object
+     * @param {string} username system object username
+     * @param {string} password system object password
+     * @returns {Promise<IdObjectSkeletonInterface>} a promise resolving to an IdObjectSkeletonInterface object containing only the _id
+     */
+    authenticateSystemObject(systemName: string, systemObjectType: string, username: string, password: string): Promise<IdObjectSkeletonInterface>;
+    /**
+     * Run system script
+     * @param {string} systemName name of system/connector
+     * @param {string} scriptName name of script
+     * @returns {Promise<any>} a promise resolving to a status object
+     */
+    runSystemScript(systemName: string, scriptName: string): Promise<any>;
+    /**
+     * Query all system object ids
+     * @param {string} systemName name of system/connector
+     * @param {string} systemObjectType type of system object
+     * @param {number} pageSize page size (default value: 1000)
+     * @param {string} pageCookie paged results cookie
+     * @returns {Promise<PagedResult<IdObjectSkeletonInterface>>} a promise resolving to an array of IdObjectSkeletonInterface objects
+     */
+    queryAllSystemObjectIds(systemName: string, systemObjectType: string, pageSize?: number, pageCookie?: string): Promise<PagedResult<IdObjectSkeletonInterface>>;
+    /**
+     * Query system objects using a search filter
+     * @param {string} systemName name of system/connector
+     * @param {string} systemObjectType type of system object
+     * @param {string} filter search filter
+     * @param {string[]} fields array of fields to return
+     * @param {number} pageSize page size (default value: 1000)
+     * @param {string} pageCookie paged results cookie
+     * @returns {Promise<PagedResult<IdObjectSkeletonInterface>>} a promise resolving to an array of IdObjectSkeletonInterface objects
+     */
+    querySystemObjects(systemName: string, systemObjectType: string, filter: string, fields?: string[], pageSize?: number, pageCookie?: string): Promise<PagedResult<IdObjectSkeletonInterface>>;
+    /**
+     * Read system object
+     * @param {string} systemName name of system/connector
+     * @param {string} systemObjectType type of system object
+     * @param {string} systemObjectId id of system object
+     * @param {string[]} fields array of fields to return (default: `['*']`)
+     * @returns {Promise<IdObjectSkeletonInterface>} a promise resolving to an IdObjectSkeletonInterface object
+     */
+    readSystemObject(systemName: string, systemObjectType: string, systemObjectId: string, fields?: string[]): Promise<IdObjectSkeletonInterface>;
+    /**
+     * Create system object
+     * @param {string} systemName name of system/connector
+     * @param {string} systemObjectType type of system object
+     * @param {IdObjectSkeletonInterface} systemObjectData system object data
+     * @returns {Promise<IdObjectSkeletonInterface>} a promise resolving to an IdObjectSkeletonInterface object
+     */
+    createSystemObject(systemName: string, systemObjectType: string, systemObjectData: IdObjectSkeletonInterface): Promise<IdObjectSkeletonInterface>;
+    /**
+     * Update or create system object
+     * @param {string} systemName name of system/connector
+     * @param {string} systemObjectType type of system object
+     * @param {string} systemObjectId id of system object
+     * @param {IdObjectSkeletonInterface} systemObjectData system object data
+     * @param {boolean} failIfExists fail if object exists (default value: false)
+     * @returns {Promise<IdObjectSkeletonInterface>} a promise resolving to an IdObjectSkeletonInterface object
+     */
+    updateSystemObject(systemName: string, systemObjectType: string, systemObjectId: string, systemObjectData: IdObjectSkeletonInterface, failIfExists?: boolean): Promise<IdObjectSkeletonInterface>;
+    /**
+     * Partially update system object through a collection of patch operations.
+     * @param {string} systemName name of system/connector
+     * @param {string} systemObjectType type of system object
+     * @param {string} systemObjectId id of system object
+     * @param {SystemObjectPatchOperationInterface[]} operations collection of patch operations to perform on the object
+     * @returns {Promise<IdObjectSkeletonInterface>} a promise resolving to an IdObjectSkeletonInterface object
+     */
+    updateSystemObjectProperties(systemName: string, systemObjectType: string, systemObjectId: string, operations: SystemObjectPatchOperationInterface[]): Promise<IdObjectSkeletonInterface>;
+    /**
+     * Delete system object
+     * @param {string} systemName name of system/connector
+     * @param {string} systemObjectType type of system object
+     * @param {string} systemObjectId id of system object
+     * @returns {Promise<IdObjectSkeletonInterface>} a promise resolving to an IdObjectSkeletonInterface object
+     */
+    deleteSystemObject(systemName: string, systemObjectType: string, systemObjectId: string): Promise<IdObjectSkeletonInterface>;
+    /**
+     * Read system schema
+     * @param {string} systemName name of system/connector
+     * @returns {Promise<Record<string, ObjectTypeSkeleton>>} a promise resolving to a map of Record<string, ObjectTypeSkeleton>
+     */
+    readSystemSchema(systemName: string): Promise<Record<string, ObjectTypeSkeleton>>;
+};
+declare const _default: (state: State) => IdmSystem;
+export default _default;
+/**
+ * Test connector servers
+ * @returns {Promise<ConnectorServerStatusInterface[]>} a promise that resolves to an array of ConnectorServerStatusInterface objects
+ */
+export declare function testConnectorServers({ state, }: {
+    state: State;
+}): Promise<ConnectorServerStatusInterface[]>;
+export declare function readAvailableSystems({ state, }: {
+    state: State;
+}): Promise<SystemStatusInterface[]>;
+export declare function readAvailableConnectors({ state, }: {
+    state: State;
+}): Promise<SystemStatusInterface[]>;
+export declare function readSystemStatus({ systemName, state, }: {
+    systemName: string;
+    state: State;
+}): Promise<SystemStatusInterface>;
+export declare function authenticateSystemObject({ systemName, systemObjectType, username, password, state, }: {
+    systemName: string;
+    systemObjectType: string;
+    username: string;
+    password: string;
+    state: State;
+}): Promise<IdObjectSkeletonInterface>;
+export declare function runSystemScript({ systemName, scriptName, state, }: {
+    systemName: string;
+    scriptName: string;
+    state: State;
+}): Promise<any>;
+export declare function queryAllSystemObjectIds({ systemName, systemObjectType, pageSize, pageCookie, state, }: {
+    systemName: string;
+    systemObjectType: string;
+    pageSize?: number;
+    pageCookie?: string;
+    state: State;
+}): Promise<PagedResult<IdObjectSkeletonInterface>>;
+export declare function querySystemObjects({ systemName, systemObjectType, filter, fields, pageSize, pageCookie, state, }: {
+    systemName: string;
+    systemObjectType: string;
+    filter: string;
+    fields?: string[];
+    pageSize?: number;
+    pageCookie?: string;
+    state: State;
+}): Promise<PagedResult<IdObjectSkeletonInterface>>;
+export declare function readSystemObject({ systemName, systemObjectType, systemObjectId, fields, state, }: {
+    systemName: string;
+    systemObjectType: string;
+    systemObjectId: string;
+    fields?: string[];
+    state: State;
+}): Promise<IdObjectSkeletonInterface>;
+export declare function createSystemObject({ systemName, systemObjectType, systemObjectData, state, }: {
+    systemName: string;
+    systemObjectType: string;
+    systemObjectData: IdObjectSkeletonInterface;
+    state: State;
+}): Promise<IdObjectSkeletonInterface>;
+export declare function updateSystemObject({ systemName, systemObjectType, systemObjectId, systemObjectData, failIfExists, state, }: {
+    systemName: string;
+    systemObjectType: string;
+    systemObjectId: string;
+    systemObjectData: IdObjectSkeletonInterface;
+    failIfExists?: boolean;
+    state: State;
+}): Promise<IdObjectSkeletonInterface>;
+export declare function updateSystemObjectProperties({ systemName, systemObjectType, systemObjectId, operations, state, }: {
+    systemName: string;
+    systemObjectType: string;
+    systemObjectId: string;
+    operations: SystemObjectPatchOperationInterface[];
+    state: State;
+}): Promise<IdObjectSkeletonInterface>;
+export declare function deleteSystemObject({ systemName, systemObjectType, systemObjectId, state, }: {
+    systemName: string;
+    systemObjectType: string;
+    systemObjectId: string;
+    state: State;
+}): Promise<IdObjectSkeletonInterface>;
+export declare function readSystemSchema({ systemName, state, }: {
+    systemName: string;
+    state: State;
+}): Promise<Record<string, ObjectTypeSkeleton>>;
+//# sourceMappingURL=IdmSystemOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IdmSystemOps.d.ts","sourceRoot":"","sources":["../../src/ops/IdmSystemOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EAcL,8BAA8B,EAE9B,mCAAmC,EACnC,qBAAqB,EACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAiB,MAAM,gBAAgB,CAAC;AAGnE,MAAM,MAAM,SAAS,GAAG;IACtB;;;OAGG;IACH,oBAAoB,IAAI,OAAO,CAAC,8BAA8B,EAAE,CAAC,CAAC;IAClE;;;OAGG;IACH,oBAAoB,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzD;;;OAGG;IACH,uBAAuB,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC5D;;;OAGG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACrE;;;;;;;OAOG;IACH,wBAAwB,CACtB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC;;;;;OAKG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtE;;;;;;;OAOG;IACH,uBAAuB,CACrB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,QAAQ,CAAC,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACnD;;;;;;;;;OASG;IACH,kBAAkB,CAChB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EAAE,EACjB,QAAQ,CAAC,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACnD;;;;;;;OAOG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC;;;;;;OAMG;IACH,kBAAkB,CAChB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,gBAAgB,EAAE,yBAAyB,GAC1C,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC;;;;;;;;OAQG;IACH,kBAAkB,CAChB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,EACtB,gBAAgB,EAAE,yBAAyB,EAC3C,YAAY,CAAC,EAAE,OAAO,GACrB,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC;;;;;;;OAOG;IACH,4BAA4B,CAC1B,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,mCAAmC,EAAE,GAChD,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC;;;;;;OAMG;IACH,kBAAkB,CAChB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC;;;;OAIG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;CAChD,CAAC;yBAEc,OAAO,KAAK,KAAG,SAAS;AAAxC,wBA4IE;AAEF;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,8BAA8B,EAAE,CAAC,CAO5C;AAED,wBAAsB,oBAAoB,CAAC,EACzC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAMnC;AAED,wBAAsB,uBAAuB,CAAC,EAC5C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAMnC;AAED,wBAAsB,gBAAgB,CAAC,EACrC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAMjC;AAED,wBAAsB,wBAAwB,CAAC,EAC7C,UAAU,EACV,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAerC;AAED,wBAAsB,eAAe,CAAC,EACpC,UAAU,EACV,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,gBASA;AAED,wBAAsB,uBAAuB,CAAC,EAC5C,UAAU,EACV,gBAAgB,EAChB,QAA4B,EAC5B,UAAsB,EACtB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAelD;AAED,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,gBAAgB,EAChB,MAAM,EACN,MAAc,EACd,QAA4B,EAC5B,UAAsB,EACtB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAiBlD;AAED,wBAAsB,gBAAgB,CAAC,EACrC,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,MAAc,EACd,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAerC;AAED,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,yBAAyB,CAAC;IAC5C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAcrC;AAED,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,YAAoB,EACpB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,yBAAyB,CAAC;IAC5C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAgBrC;AAED,wBAAsB,4BAA4B,CAAC,EACjD,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,mCAAmC,EAAE,CAAC;IAClD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAerC;AAED,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAcrC;AAED,wBAAsB,gBAAgB,CAAC,EACrC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAU9C"}

package/types/ops/IdpOps.d.ts

@@ -0,0 +1,234 @@
+import { type ScriptSkeleton } from '../api/ScriptApi';
+import { type SocialIdpSkeleton } from '../api/SocialIdentityProvidersApi';
+import { State } from '../shared/State';
+import { type ExportMetaData } from './OpsTypes';
+export type Idp = {
+    /**
+     * Read all social identity providers
+     * @returns {Promise<SocialIdpSkeleton[]>} a promise that resolves to an array of social identity providers
+     */
+    readSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
+    /**
+     * Read social identity provider
+     * @param {string} providerId identity provider id/name
+     * @returns {Promise<SocialIdpSkeleton>} a promise that resolves a social identity provider object
+     */
+    readSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>;
+    /**
+     * Create social identity provider
+     * @param {string} providerType identity provider type
+     * @param {string} providerId identity provider id/name
+     * @param {SocialIdpSkeleton} providerData identity provider data
+     * @returns {Promise<SocialIdpSkeleton>} a promise that resolves a social identity provider object
+     */
+    createSocialIdentityProvider(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise<SocialIdpSkeleton>;
+    /**
+     * Update or create social identity provider
+     * @param {string} providerType identity provider type
+     * @param {string} providerId identity provider id/name
+     * @param {SocialIdpSkeleton} providerData identity provider data
+     * @returns {Promise<SocialIdpSkeleton>} a promise that resolves a social identity provider object
+     */
+    updateSocialIdentityProvider(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise<SocialIdpSkeleton>;
+    /**
+     * Delete all social identity providers
+     * @returns {Promise<SocialIdpSkeleton[]>} a promise that resolves to an array of social identity provider objects
+     */
+    deleteSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
+    /**
+     * Delete social identity provider
+     * @param {string} providerId social identity provider id/name
+     * @returns {Promise<SocialIdpSkeleton>} a promise that resolves a social identity provider object
+     */
+    deleteSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>;
+    /**
+     * Export social identity provider
+     * @param {string} providerId provider id/name
+     * @returns {Promise<SocialProviderExportInterface>} a promise that resolves to a SocialProviderExportInterface object
+     */
+    exportSocialIdentityProvider(providerId: string): Promise<SocialProviderExportInterface>;
+    /**
+     * Export all social identity providers
+     * @param {SocialIdentityProviderExportOptions} options export options
+     * @returns {Promise<SocialProviderExportInterface>} a promise that resolves to a SocialProviderExportInterface object
+     */
+    exportSocialIdentityProviders(options?: SocialIdentityProviderExportOptions): Promise<SocialProviderExportInterface>;
+    /**
+     * Import social identity provider
+     * @param {string} providerId provider id/name
+     * @param {SocialProviderExportInterface} importData import data
+     * @param {SocialIdentityProviderImportOptions} options import options
+     * @returns {Promise<SocialIdpSkeleton>} a promise resolving to a social identity provider object
+     */
+    importSocialIdentityProvider(providerId: string, importData: SocialProviderExportInterface, options: SocialIdentityProviderImportOptions): Promise<SocialIdpSkeleton>;
+    /**
+     * Import first social identity provider
+     * @param {SocialProviderExportInterface} importData import data
+     * @param {SocialIdentityProviderImportOptions} options import options
+     * @returns {Promise<SocialIdpSkeleton>} a promise resolving to a social identity provider object
+     */
+    importFirstSocialIdentityProvider(importData: SocialProviderExportInterface, options: SocialIdentityProviderImportOptions): Promise<SocialIdpSkeleton>;
+    /**
+     * Import all social identity providers
+     * @param {SocialProviderExportInterface} importData import data
+     * @param {SocialIdentityProviderImportOptions} options import options
+     * @returns {Promise<SocialIdpSkeleton[]>} a promise resolving to an array of social identity provider objects
+     */
+    importSocialIdentityProviders(importData: SocialProviderExportInterface, options: SocialIdentityProviderImportOptions): Promise<SocialIdpSkeleton[]>;
+};
+declare const _default: (state: State) => Idp;
+export default _default;
+/**
+ * Social identity provider export options
+ */
+export interface SocialIdentityProviderExportOptions {
+    /**
+     * Use string arrays to store multi-line text in scripts.
+     */
+    useStringArrays: boolean;
+    /**
+     * Include any dependencies (scripts).
+     */
+    deps: boolean;
+}
+/**
+ * Social identity provider import options
+ */
+export interface SocialIdentityProviderImportOptions {
+    /**
+     * Include any dependencies (scripts).
+     */
+    deps: boolean;
+}
+export interface SocialProviderExportInterface {
+    meta?: ExportMetaData;
+    script: Record<string, ScriptSkeleton>;
+    idp: Record<string, SocialIdpSkeleton>;
+}
+/**
+ * Get all social identity providers
+ * @returns {Promise} a promise that resolves to an object containing an array of social identity providers
+ */
+export declare function readSocialIdentityProviders({ state, }: {
+    state: State;
+}): Promise<SocialIdpSkeleton[]>;
+/**
+ * Read social identity provider
+ * @param {string} providerId social identity provider id/name
+ * @returns {Promise<SocialIdpSkeleton>} a promise that resolves a social identity provider object
+ */
+export declare function readSocialIdentityProvider({ providerId, state, }: {
+    providerId: string;
+    state: State;
+}): Promise<SocialIdpSkeleton>;
+export declare function createSocialIdentityProvider({ providerType, providerId, providerData, errorIfExists, state, }: {
+    providerType: string;
+    providerId: string;
+    providerData: SocialIdpSkeleton;
+    errorIfExists?: boolean;
+    state: State;
+}): Promise<SocialIdpSkeleton>;
+export declare function updateSocialIdentityProvider({ providerType, providerId, providerData, state, }: {
+    providerType: string;
+    providerId: string;
+    providerData: SocialIdpSkeleton;
+    state: State;
+}): Promise<SocialIdpSkeleton>;
+/**
+ * Delete all social identity providers
+ * @returns {Promise<SocialIdpSkeleton[]>} a promise that resolves to an array of social identity provider objects
+ */
+export declare function deleteSocialIdentityProviders({ state, }: {
+    state: State;
+}): Promise<SocialIdpSkeleton[]>;
+/**
+ * Delete social identity provider by id
+ * @param {String} providerId social identity provider id/name
+ * @returns {Promise} a promise that resolves a social identity provider object
+ */
+export declare function deleteSocialIdentityProvider({ providerId, state, }: {
+    providerId: string;
+    state: State;
+}): Promise<SocialIdpSkeleton>;
+/**
+ * Export social provider by id
+ * @param {string} providerId provider id/name
+ * @returns {Promise<SocialProviderExportInterface>} a promise that resolves to a SocialProviderExportInterface object
+ */
+export declare function exportSocialIdentityProvider({ providerId, state, }: {
+    providerId: string;
+    state: State;
+}): Promise<SocialProviderExportInterface>;
+/**
+ * Export all providers
+ * @returns {Promise<SocialProviderExportInterface>} a promise that resolves to a SocialProviderExportInterface object
+ */
+export declare function exportSocialIdentityProviders({ options, state, }: {
+    options?: SocialIdentityProviderExportOptions;
+    state: State;
+}): Promise<SocialProviderExportInterface>;
+/**
+ * Import social identity provider
+ * @param {string} providerId provider id/name
+ * @param {SocialProviderExportInterface} importData import data
+ * @param {SocialIdentityProviderImportOptions} options import options
+ * @returns {Promise<SocialIdpSkeleton>} a promise resolving to a social identity provider object
+ */
+export declare function importSocialIdentityProvider({ providerId, importData, options, state, }: {
+    providerId: string;
+    importData: SocialProviderExportInterface;
+    options?: SocialIdentityProviderImportOptions;
+    state: State;
+}): Promise<SocialIdpSkeleton>;
+/**
+ * Import first social identity provider
+ * @param {SocialProviderExportInterface} importData import data
+ * @param {SocialIdentityProviderImportOptions} options import options
+ * @returns {Promise<SocialIdpSkeleton>} a promise resolving to a social identity provider object
+ */
+export declare function importFirstSocialIdentityProvider({ importData, options, state, }: {
+    importData: SocialProviderExportInterface;
+    options?: SocialIdentityProviderImportOptions;
+    state: State;
+}): Promise<SocialIdpSkeleton>;
+/**
+ * Import all social identity providers
+ * @param {SocialProviderExportInterface} importData import data
+ * @param {SocialIdentityProviderImportOptions} options import options
+ * @returns {Promise<SocialIdpSkeleton[]>} a promise resolving to an array of social identity provider objects
+ */
+export declare function importSocialIdentityProviders({ importData, options, state, }: {
+    importData: SocialProviderExportInterface;
+    options?: SocialIdentityProviderImportOptions;
+    state: State;
+}): Promise<SocialIdpSkeleton[]>;
+/**
+ * Import provider by id/name
+ * @param {string} providerId provider id/name
+ * @param {SocialProviderExportInterface} importData import data
+ * @returns {Promise<boolean>} a promise resolving to true if successful, false otherwise
+ */
+export declare function importSocialProvider({ providerId, importData, state, }: {
+    providerId: string;
+    importData: SocialProviderExportInterface;
+    state: State;
+}): Promise<boolean>;
+/**
+ * Import first provider
+ * @param {SocialProviderExportInterface} importData import data
+ * @returns {Promise<boolean>} a promise resolving to true if successful, false otherwise
+ */
+export declare function importFirstSocialProvider({ importData, state, }: {
+    importData: SocialProviderExportInterface;
+    state: State;
+}): Promise<boolean>;
+/**
+ * Import all providers
+ * @param {SocialProviderExportInterface} importData import data
+ * @returns {Promise<boolean>} a promise resolving to true if successful, false otherwise
+ */
+export declare function importSocialProviders({ importData, state, }: {
+    importData: SocialProviderExportInterface;
+    state: State;
+}): Promise<boolean>;
+//# sourceMappingURL=IdpOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IdpOps.d.ts","sourceRoot":"","sources":["../../src/ops/IdpOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAIL,KAAK,iBAAiB,EACvB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAexC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAGjD,MAAM,MAAM,GAAG,GAAG;IAChB;;;OAGG;IACH,2BAA2B,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC5D;;;;OAIG;IACH,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC3E;;;;;;OAMG;IACH,4BAA4B,CAC1B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,iBAAiB,GAC9B,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC9B;;;;;;OAMG;IACH,4BAA4B,CAC1B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,iBAAiB,GAC9B,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC9B;;;OAGG;IACH,6BAA6B,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC9D;;;;OAIG;IACH,4BAA4B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC7E;;;;OAIG;IACH,4BAA4B,CAC1B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;OAIG;IACH,6BAA6B,CAC3B,OAAO,CAAC,EAAE,mCAAmC,GAC5C,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;;;OAMG;IACH,4BAA4B,CAC1B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,6BAA6B,EACzC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC9B;;;;;OAKG;IACH,iCAAiC,CAC/B,UAAU,EAAE,6BAA6B,EACzC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC9B;;;;;OAKG;IACH,6BAA6B,CAC3B,UAAU,EAAE,6BAA6B,EACzC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;CACjC,CAAC;yBAEc,OAAO,KAAK,KAAG,GAAG;AAAlC,wBA8EE;AAEF;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACvC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CACxC;AAkBD;;;GAGG;AACH,wBAAsB,2BAA2B,CAAC,EAChD,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAwB/B;AAED;;;;GAIG;AACH,wBAAsB,0BAA0B,CAAC,EAC/C,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAoB7B;AAED,wBAAsB,4BAA4B,CAAC,EACjD,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAoB,EACpB,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,iBAAiB,CAAC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAmC7B;AAED,wBAAsB,4BAA4B,CAAC,EACjD,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,iBAAiB,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA8E7B;AAED;;;GAGG;AACH,wBAAsB,6BAA6B,CAAC,EAClD,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CA2C/B;AAED;;;;GAIG;AACH,wBAAsB,4BAA4B,CAAC,EACjD,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAwB7B;AAED;;;;GAIG;AACH,wBAAsB,4BAA4B,CAAC,EACjD,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CA+BzC;AAED;;;GAGG;AACH,wBAAsB,6BAA6B,CAAC,EAClD,OAA+C,EAC/C,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,mCAAmC,CAAC;IAC9C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CA2DzC;AAED;;;;;;GAMG;AACH,wBAAsB,4BAA4B,CAAC,EACjD,UAAU,EACV,UAAU,EACV,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,6BAA6B,CAAC;IAC1C,OAAO,CAAC,EAAE,mCAAmC,CAAC;IAC9C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA6C7B;AAED;;;;;GAKG;AACH,wBAAsB,iCAAiC,CAAC,EACtD,UAAU,EACV,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,6BAA6B,CAAC;IAC1C,OAAO,CAAC,EAAE,mCAAmC,CAAC;IAC9C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA0C7B;AAED;;;;;GAKG;AACH,wBAAsB,6BAA6B,CAAC,EAClD,UAAU,EACV,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,6BAA6B,CAAC;IAC1C,OAAO,CAAC,EAAE,mCAAmC,CAAC;IAC9C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CA0C/B;AAID;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,6BAA6B,CAAC;IAC1C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAqBnB;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAAC,EAC9C,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,6BAA6B,CAAC;IAC1C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAmBnB;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,6BAA6B,CAAC;IAC1C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAwBnB"}

package/types/ops/InfoOps.d.ts

@@ -0,0 +1,28 @@
+import { EnvInfoInterface } from '../api/cloud/EnvInfoApi';
+import { State } from '../shared/State';
+export type Info = {
+    /**
+     * Get info about the platform instance
+     * @returns {Promise<PlatformInfo>} a promise that resolves to a json blob with information about the instance and tokens
+     */
+    getInfo(): Promise<PlatformInfo>;
+};
+declare const _default: (state: State) => Info;
+export default _default;
+export interface PlatformInfoInterface {
+    host: string;
+    authenticatedSubject: string;
+    amVersion: string;
+    cookieName: string;
+    sessionToken: string;
+    bearerToken?: string;
+    deploymentType: string;
+}
+export type PlatformInfo = PlatformInfoInterface & Partial<EnvInfoInterface>;
+/**
+ * Get info about the platform instance
+ * @param {State} state library state
+ * @returns {Promise<PlatformInfo>} a promise that resolves to a json blob with information about the instance and tokens
+ */
+export declare function getInfo(state: State): Promise<PlatformInfo>;
+//# sourceMappingURL=InfoOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InfoOps.d.ts","sourceRoot":"","sources":["../../src/ops/InfoOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAc,MAAM,yBAAyB,CAAC;AAGvE,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAIxC,MAAM,MAAM,IAAI,GAAG;IACjB;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;CAClC,CAAC;yBAEc,OAAO,KAAK,KAAG,IAAI;AAAnC,wBAUE;AAEF,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,YAAY,GAAG,qBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAiC7E;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,CAmBjE"}