@rockcarver/frodo-lib 4.10.0 → 4.11.0-1

package/types/ops/Saml2Ops.d.ts

@@ -0,0 +1,261 @@
+import { type Saml2ProiderLocation, type Saml2ProviderSkeleton, type Saml2ProviderStub } from '../api/Saml2Api';
+import { type ScriptSkeleton } from '../api/ScriptApi';
+import { State } from '../shared/State';
+import { type ExportMetaData } from './OpsTypes';
+export type Saml2 = {
+    /**
+     * Read all SAML2 entity provider stubs
+     * @returns {Promise<Saml2ProviderStub[]>} a promise that resolves to an array of saml2 entity stubs
+     */
+    readSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>;
+    /**
+     *
+     * @param {string} entityId Provider entity id
+     * @returns {Promise<Saml2ProviderStub>} Promise resolving to a Saml2ExportInterface object.
+     */
+    readSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>;
+    /**
+     * Export a single entity provider. The response can be saved to file as is.
+     * @param {string} entityId Provider entity id
+     * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
+     */
+    readSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
+    /**
+     * Create a SAML2 entity provider
+     * @param {Saml2ProiderLocation} location 'hosted' or 'remote'
+     * @param {Saml2ProviderSkeleton} providerData Object representing a SAML entity provider
+     * @param {string} metaData Base64-encoded metadata XML. Only required for remote providers
+     * @returns {Promise<Saml2ProviderSkeleton>} a promise that resolves to a saml2 entity provider object
+     */
+    createSaml2Provider(location: Saml2ProiderLocation, providerData: Saml2ProviderSkeleton, metaData: string): Promise<Saml2ProviderSkeleton>;
+    /**
+     * Update SAML2 entity provider
+     * @param {Saml2ProiderLocation} location Entity provider location (hosted or remote)
+     * @param {string} entityId SAML2 entity id
+     * @param {Saml2ProviderSkeleton} providerData Object representing a SAML entity provider
+     * @returns {Promise<Saml2ProviderSkeleton>} a promise that resolves to a saml2 entity provider object
+     */
+    updateSaml2Provider(location: Saml2ProiderLocation, providerData: Saml2ProviderSkeleton, entityId?: string): Promise<Saml2ProviderSkeleton>;
+    /**
+     * Delete an entity provider. The response can be saved to file as is.
+     * @param {string} entityId Provider entity id
+     * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
+     */
+    deleteSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
+    /**
+     * Delete all entity providers.
+     * @returns {Promise<Saml2ProviderSkeleton[]>} Promise resolving to an array of Saml2ProviderSkeleton objects.
+     */
+    deleteSaml2Providers(): Promise<Saml2ProviderSkeleton[]>;
+    /**
+     * Get a SAML2 entity provider's metadata URL by entity id
+     * @param {string} entityId SAML2 entity id
+     * @returns {string} the URL to get the metadata from
+     */
+    getSaml2ProviderMetadataUrl(entityId: string): string;
+    /**
+     * Get a SAML2 entity provider's metadata by entity id
+     * @param {string} entityId SAML2 entity id
+     * @returns {Promise<object>} a promise that resolves to an object containing a SAML2 metadata
+     */
+    getSaml2ProviderMetadata(entityId: string): Promise<any>;
+    /**
+     * Export a single entity provider. The response can be saved to file as is.
+     * @param {string} entityId Provider entity id
+     * @param {Saml2EntitiesExportOptions} options export options
+     * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
+     */
+    exportSaml2Provider(entityId: string, options?: Saml2EntitiesExportOptions): Promise<Saml2ExportInterface>;
+    /**
+     * Export all entity providers. The response can be saved to file as is.
+     * @param {Saml2EntitiesExportOptions} options export options
+     * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
+     */
+    exportSaml2Providers(options?: Saml2EntitiesExportOptions): Promise<Saml2ExportInterface>;
+    /**
+     * Import a SAML entity provider
+     * @param {string} entityId Provider entity id
+     * @param {Saml2ExportInterface} importData Import data
+     * @param {Saml2EntitiesImportOptions} options import options
+     * @returns {Promise<Saml2ProviderSkeleton>} a promise resolving to a provider object
+     */
+    importSaml2Provider(entityId: string, importData: Saml2ExportInterface, options?: Saml2EntitiesImportOptions): Promise<Saml2ProviderSkeleton>;
+    /**
+     * Import SAML entity providers
+     * @param {Saml2ExportInterface} importData Import data
+     * @param {Saml2EntitiesImportOptions} options import options
+     * @returns {Promise<Saml2ProviderSkeleton[]>} a promise resolving to an array of provider objects
+     */
+    importSaml2Providers(importData: Saml2ExportInterface, options?: Saml2EntitiesImportOptions): Promise<Saml2ProviderSkeleton[]>;
+};
+declare const _default: (state: State) => Saml2;
+export default _default;
+export interface Saml2EntitiesImportOptions {
+    /**
+     * Include any dependencies (scripts).
+     */
+    deps: boolean;
+}
+export interface Saml2EntitiesExportOptions {
+    /**
+     * Include any dependencies (scripts).
+     */
+    deps: boolean;
+}
+export interface Saml2ExportInterface {
+    meta?: ExportMetaData;
+    script: Record<string, ScriptSkeleton>;
+    saml: {
+        hosted: Record<string, Saml2ProviderSkeleton>;
+        remote: Record<string, Saml2ProviderSkeleton>;
+        metadata: Record<string, string[]>;
+    };
+}
+export declare function createSaml2ExportTemplate({ state, }: {
+    state: State;
+}): Saml2ExportInterface;
+/**
+ * Get SAML2 entity provider stubs
+ * @returns {Promise<Saml2ProviderStub[]>} a promise that resolves to an array of saml2 entity stubs
+ */
+export declare function readSaml2ProviderStubs({ state, }: {
+    state: State;
+}): Promise<Saml2ProviderStub[]>;
+/**
+ * Get all SAML2 entity ids
+ * @returns {Promise<string[]>} a promise that resolves to an array of saml2 entity ids
+ */
+export declare function readSaml2EntityIds({ state, }: {
+    state: State;
+}): Promise<string[]>;
+/**
+ * Get a SAML2 entity provider's metadata URL by entity id
+ * @param {string} entityId SAML2 entity id
+ * @returns {string} the URL to get the metadata from
+ */
+export declare function getSaml2ProviderMetadataUrl({ entityId, state, }: {
+    entityId: string;
+    state: State;
+}): string;
+/**
+ * Get a SAML2 entity provider's metadata by entity id
+ * @param {string} entityId SAML2 entity id
+ * @returns {Promise<object>} a promise that resolves to an object containing a SAML2 metadata
+ */
+export declare function getSaml2ProviderMetadata({ entityId, state, }: {
+    entityId: string;
+    state: State;
+}): Promise<string>;
+/**
+ *
+ * @param {string} entityId Provider entity id
+ * @returns {Promise<Saml2ProviderStub>} Promise resolving to a Saml2ExportInterface object.
+ */
+export declare function readSaml2ProviderStub({ entityId, state, }: {
+    entityId: string;
+    state: State;
+}): Promise<Saml2ProviderStub>;
+/**
+ * Export a single entity provider. The response can be saved to file as is.
+ * @param {string} entityId Provider entity id
+ * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
+ */
+export declare function readSaml2Provider({ entityId, state, }: {
+    entityId: string;
+    state: State;
+}): Promise<Saml2ProviderSkeleton>;
+/**
+ * Create a SAML2 entity provider
+ * @param {Saml2ProiderLocation} location 'hosted' or 'remote'
+ * @param {Saml2ProviderSkeleton} providerData Object representing a SAML entity provider
+ * @param {string} metaData Base64-encoded metadata XML. Only required for remote providers
+ * @returns {Promise<Saml2ProviderSkeleton>} a promise that resolves to a saml2 entity provider object
+ */
+export declare function createSaml2Provider({ location, providerData, metaData, state, }: {
+    location: Saml2ProiderLocation;
+    providerData: Saml2ProviderSkeleton;
+    metaData?: string;
+    state: State;
+}): Promise<Saml2ProviderSkeleton>;
+/**
+ * Update SAML2 entity provider
+ * @param {Saml2ProiderLocation} location Entity provider location (hosted or remote)
+ * @param {string} entityId SAML2 entity id
+ * @param {Saml2ProviderSkeleton} providerData Object representing a SAML entity provider
+ * @returns {Promise<Saml2ProviderSkeleton>} a promise that resolves to a saml2 entity provider object
+ */
+export declare function updateSaml2Provider({ location, entityId, providerData, state, }: {
+    location: Saml2ProiderLocation;
+    entityId?: string;
+    providerData: Saml2ProviderSkeleton;
+    state: State;
+}): Promise<Saml2ProviderSkeleton>;
+/**
+ * Delete an entity provider. The response can be saved to file as is.
+ * @param {string} entityId Provider entity id
+ * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
+ */
+export declare function deleteSaml2Provider({ entityId, state, }: {
+    entityId: string;
+    state: State;
+}): Promise<Saml2ProviderSkeleton>;
+/**
+ * Delete all entity providers.
+ * @returns {Promise<Saml2ProviderSkeleton[]>} Promise resolving to an array of Saml2ProviderSkeleton objects.
+ */
+export declare function deleteSaml2Providers({ state, }: {
+    state: State;
+}): Promise<Saml2ProviderSkeleton[]>;
+/**
+ * Export a single entity provider. The response can be saved to file as is.
+ * @param {string} entityId Provider entity id
+ * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
+ */
+export declare function exportSaml2Provider({ entityId, options, state, }: {
+    entityId: string;
+    options?: Saml2EntitiesExportOptions;
+    state: State;
+}): Promise<Saml2ExportInterface>;
+/**
+ * Export all entity providers. The response can be saved to file as is.
+ * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
+ */
+export declare function exportSaml2Providers({ options, state, }: {
+    options?: Saml2EntitiesExportOptions;
+    state: State;
+}): Promise<Saml2ExportInterface>;
+/**
+ * Include dependencies from the import file
+ * @param {object} providerData Object representing a SAML entity provider
+ * @param {object} fileData File data object to read dependencies from
+ */
+export declare function importDependencies({ providerData, fileData, state, }: {
+    providerData: Saml2ProviderSkeleton;
+    fileData: Saml2ExportInterface;
+    state: State;
+}): Promise<void>;
+/**
+ * Import a SAML entity provider
+ * @param {string} entityId Provider entity id
+ * @param {Saml2ExportInterface} importData Import data
+ * @param {Saml2ProviderImportOptions} options import options
+ * @returns {Promise<Saml2ProviderSkeleton>} a promise resolving to a provider object
+ */
+export declare function importSaml2Provider({ entityId, importData, options, state, }: {
+    entityId: string;
+    importData: Saml2ExportInterface;
+    options?: Saml2EntitiesImportOptions;
+    state: State;
+}): Promise<Saml2ProviderSkeleton>;
+/**
+ * Import SAML entity providers
+ * @param {Saml2ExportInterface} importData Import data
+ * @param {Saml2ProviderImportOptions} options import options
+ * @returns {Promise<Saml2ProviderSkeleton[]>} a promise resolving to an array of provider objects
+ */
+export declare function importSaml2Providers({ importData, options, state, }: {
+    importData: Saml2ExportInterface;
+    options?: Saml2EntitiesImportOptions;
+    state: State;
+}): Promise<Saml2ProviderSkeleton[]>;
+//# sourceMappingURL=Saml2Ops.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Saml2Ops.d.ts","sourceRoot":"","sources":["../../src/ops/Saml2Ops.ts"],"names":[],"mappings":"AAAA,OAAO,EASL,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACvB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAa,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAkBxC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAGjD,MAAM,MAAM,KAAK,GAAG;IAClB;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACvD;;;;OAIG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACpE;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACpE;;;;;;OAMG;IACH,mBAAmB,CACjB,QAAQ,EAAE,oBAAoB,EAC9B,YAAY,EAAE,qBAAqB,EACnC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;;;OAMG;IACH,mBAAmB,CACjB,QAAQ,EAAE,oBAAoB,EAC9B,YAAY,EAAE,qBAAqB,EACnC,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;OAIG;IACH,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtE;;;OAGG;IACH,oBAAoB,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACzD;;;;OAIG;IACH,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IACtD;;;;OAIG;IACH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzD;;;;;OAKG;IACH,mBAAmB,CACjB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;OAIG;IACH,oBAAoB,CAClB,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;;OAMG;IACH,mBAAmB,CACjB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;;OAKG;IACH,oBAAoB,CAClB,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;CACrC,CAAC;yBAEc,OAAO,KAAK,KAAG,KAAK;AAApC,wBAgEE;AAEF,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACvC,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC9C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC9C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KACpC,CAAC;CACH;AAGD,wBAAgB,yBAAyB,CAAC,EACxC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,oBAAoB,CAUvB;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAmB/B;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAoBpB;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,MAAM,CAST;AAED;;;;GAIG;AACH,wBAAsB,wBAAwB,CAAC,EAC7C,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,mBASA;AA8ID;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAiC7B;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAyBjC;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,YAAY,EAAE,qBAAqB,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CASjC;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,QAAQ,EACR,QAAoB,EACpB,YAAY,EACZ,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,qBAAqB,CAAC;IACpC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CASjC;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAyBjC;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAwBnC;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,QAAQ,EACR,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,0BAA0B,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA+BhC;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,0BAA0B,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA4EhC;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,YAAY,EACZ,QAAQ,EACR,KAAK,GACN,EAAE;IACD,YAAY,EAAE,qBAAqB,CAAC;IACpC,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,KAAK,EAAE,KAAK,CAAC;CACd,iBAwFA;AAqBD;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,QAAQ,EACR,UAAU,EACV,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,oBAAoB,CAAC;IACjC,OAAO,CAAC,EAAE,0BAA0B,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CA8DjC;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,oBAAoB,CAAC;IACjC,OAAO,CAAC,EAAE,0BAA0B,CAAC;IACrC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,CA0FnC"}