@rockcarver/frodo-lib 4.10.0 → 4.11.0

package/types/ops/RealmOps.d.ts

@@ -0,0 +1,196 @@
+import { RealmSkeleton } from '../api/RealmApi';
+import { State } from '../shared/State';
+import { ExportMetaData } from './OpsTypes';
+export type Realm = {
+    /**
+     * Read all realms
+     * @returns {Promise<RealmSkeleton[]>} a promise resolving to an array of realm objects
+     */
+    readRealms(): Promise<RealmSkeleton[]>;
+    /**
+     * Read realm
+     * @param {string} realmId realm id
+     * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+     */
+    readRealm(realmId: string): Promise<RealmSkeleton>;
+    /**
+     * Read realm by name
+     * @param {string} realmName realm name
+     * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+     */
+    readRealmByName(realmName: string): Promise<RealmSkeleton>;
+    /**
+     * Export all realms. The response can be saved to file as is.
+     * @returns {Promise<RealmExportInterface>} Promise resolving to a RealmExportInterface object.
+     */
+    exportRealms(): Promise<RealmExportInterface>;
+    /**
+     * Create realm
+     * @param {string} realmName realm name
+     * @param {RealmSkeleton} realmData realm data
+     * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+     */
+    createRealm(realmName: string, realmData?: RealmSkeleton): Promise<RealmSkeleton>;
+    /**
+     * Update realm
+     * @param {string} realmId realm id
+     * @param {RealmSkeleton} realmData realm data
+     * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+     */
+    updateRealm(realmId: string, realmData: RealmSkeleton): Promise<RealmSkeleton>;
+    /**
+     * Import realms
+     * @param {RealmExportInterface} importData realm import data
+     * @param {string} realmId Optional realm id. If supplied, only the realm of that id is imported. Takes priority over realmName if both are provided.
+     * @param {string} realmName Optional realm name. If supplied, only the realm of that name is imported.
+     * @returns {Promise<RealmSkeleton[]>} the imported realms
+     */
+    importRealms(importData: RealmExportInterface, realmId?: string, realmName?: string): Promise<RealmSkeleton[]>;
+    /**
+     * Delete realm
+     * @param {string} realmId realm id
+     * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+     */
+    deleteRealm(realmId: string): Promise<RealmSkeleton>;
+    /**
+     * Delete realm by name
+     * @param {string} realmName realm name
+     * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+     */
+    deleteRealmByName(realmName: string): Promise<RealmSkeleton>;
+    /**
+     * Add custom DNS domain name (realm DNS alias)
+     * @param {string} realmName realm name
+     * @param {string} domain domain name
+     * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+     */
+    addCustomDomain(realmName: string, domain: string): Promise<RealmSkeleton>;
+    /**
+     * Remove custom DNS domain name (realm DNS alias)
+     * @param {string} realmName realm name
+     * @param {string} domain domain name
+     * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+     */
+    removeCustomDomain(realmName: string, domain: string): Promise<RealmSkeleton>;
+};
+declare const _default: (state: State) => Realm;
+export default _default;
+export interface RealmExportInterface {
+    meta?: ExportMetaData;
+    realm: Record<string, RealmSkeleton>;
+}
+/**
+ * Create an empty realm export template
+ * @returns {RealmExportInterface} an empty realm export template
+ */
+export declare function createRealmExportTemplate({ state, }: {
+    state: State;
+}): RealmExportInterface;
+/**
+ * Get all realms
+ * @returns {Promise} a promise that resolves to an object containing an array of realm objects
+ */
+export declare function getRealms({ state }: {
+    state: State;
+}): Promise<RealmSkeleton[]>;
+/**
+ * Export all realms. The response can be saved to file as is.
+ * @returns {Promise<RealmExportInterface>} Promise resolving to a RealmExportInterface object.
+ */
+export declare function exportRealms({ state, }: {
+    state: State;
+}): Promise<RealmExportInterface>;
+/**
+ * Create realm
+ * @param {string} realmName realm name
+ * @param {RealmSkeleton} realmData realm data
+ * @returns {Promise<RealmSkeleton>} a promise resolving to a realm object
+ */
+export declare function createRealm({ realmName, realmData, state, }: {
+    realmName: string;
+    realmData?: RealmSkeleton;
+    state: State;
+}): Promise<RealmSkeleton>;
+/**
+ * Update realm
+ * @param {string} realmId realm id
+ * @param {RealmSkeleton} realmData realm config object
+ * @returns {Promise<RealmSkeleton>} a promise that resolves to a realm object
+ */
+export declare function updateRealm({ realmId, realmData, state, }: {
+    realmId: string;
+    realmData: RealmSkeleton;
+    state: State;
+}): Promise<RealmSkeleton>;
+/**
+ * Import realms
+ * @param {string} realmId Optional realm id. If supplied, only the realm of that id is imported. Takes priority over realmName if both are provided.
+ * @param {string} realmName Optional realm name. If supplied, only the realm of that name is imported.
+ * @param {RealmExportInterface} importData realm import data
+ * @returns {Promise<RealmSkeleton[]>} the imported realms
+ */
+export declare function importRealms({ realmId, realmName, importData, state, }: {
+    realmId?: string;
+    realmName?: string;
+    importData: RealmExportInterface;
+    state: State;
+}): Promise<RealmSkeleton[]>;
+/**
+ * Get realm
+ * @param {String} realmId realm id
+ * @returns {Promise<RealmSkeleton>} a promise that resolves to a realm object
+ */
+export declare function getRealm({ realmId, state, }: {
+    realmId: string;
+    state: State;
+}): Promise<RealmSkeleton>;
+/**
+ * Get realm by name
+ * @param {string} realmName realm name
+ * @returns {Promise<RealmSkeleton>} a promise that resolves to a realm object
+ */
+export declare function getRealmByName({ realmName, state, }: {
+    realmName: string;
+    state: State;
+}): Promise<RealmSkeleton>;
+/**
+ * Delete realm
+ * @param {string} realmId realm id
+ * @returns {Promise<RealmSkeleton>} a promise that resolves to an object containing a realm object
+ */
+export declare function deleteRealm({ realmId, state, }: {
+    realmId: string;
+    state: State;
+}): Promise<RealmSkeleton>;
+/**
+ * Delete realm by name
+ * @param {string} realmName realm name
+ * @returns {Promise<RealmSkeleton>} a promise that resolves to a realm object
+ */
+export declare function deleteRealmByName({ realmName, state, }: {
+    realmName: string;
+    state: State;
+}): Promise<RealmSkeleton>;
+/**
+ * Add custom DNS domain name (realm DNS alias)
+ * @param {string} realm realm name
+ * @param {string} domain domain name
+ * @returns {Promise<RealmSkeleton>} a promise that resolves to a realm object
+ */
+export declare function addCustomDomain({ realmName, domain, state, }: {
+    realmName: string;
+    domain: string;
+    state: State;
+}): Promise<RealmSkeleton>;
+/**
+ * Remove custom DNS domain name (realm DNS alias)
+ * @param {String} realm realm name
+ * @param {String} domain domain name
+ * @returns {Promise<RealmSkeleton>} a promise that resolves to a realm object
+ */
+export declare function removeCustomDomain({ realmName, domain, state, }: {
+    realmName: string;
+    domain: string;
+    state: State;
+}): Promise<RealmSkeleton>;
+//# sourceMappingURL=RealmOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RealmOps.d.ts","sourceRoot":"","sources":["../../src/ops/RealmOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,aAAa,EACd,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAUxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,MAAM,KAAK,GAAG;IAClB;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IACvC;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACnD;;;;OAIG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3D;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC9C;;;;;OAKG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,aAAa,GACxB,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1B;;;;;OAKG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,aAAa,GACvB,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1B;;;;;;OAMG;IACH,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAC5B;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrD;;;;OAIG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC7D;;;;;OAKG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3E;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAC/E,CAAC;yBAEc,OAAO,KAAK,KAAG,KAAK;AAApC,wBAoDE;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;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,4BAG1D;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,EACjC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAuChC;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,EAChC,SAAS,EACT,SAAqB,EACrB,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAGzB;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,SAAS,EACT,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAEzB;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,EACjC,OAAO,EACP,SAAS,EACT,UAAU,EACV,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,oBAAoB,CAAC;IACjC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAmC3B;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,EAC7B,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAEzB;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,EACnC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAQzB;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAEzB;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAQzB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,EACpC,SAAS,EACT,MAAM,EACN,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CA2BzB;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,SAAS,EACT,MAAM,EACN,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAwBzB"}

package/types/ops/ReconOps.d.ts

@@ -0,0 +1,57 @@
+import { ReconStatusType, ReconType } from '../api/ReconApi';
+import { State } from '../shared/State';
+export type Recon = {
+    /**
+     * Read all reconciliation runs
+     * @returns {Promise<ReconType[]>} a promise resolving to an array of recon objects
+     */
+    readRecons(): Promise<ReconType[]>;
+    /**
+     * Read recon
+     * @param {string} reconId id of the recon
+     * @returns {Promise<ReconType>} a promise resolving to a recon object
+     */
+    readRecon(reconId: string): Promise<ReconType>;
+    /**
+     * Start a reconciliation
+     * @param {string} mappingName mapping to reconcile
+     * @returns {Promise<ReconStatusType>} a promise resolving to a recon status object
+     */
+    startRecon(mappingName: string): Promise<ReconStatusType>;
+    /**
+     * Start a reconciliation by Id
+     * @param {string} mappingName mapping to reconcile
+     * @param {string} objectId id of object to reconcile
+     * @returns {Promise<ReconStatusType>} a promise resolving to a recon status object
+     */
+    startReconById(mappingName: string, objectId: string): Promise<ReconStatusType>;
+    /**
+     * Cancel a reconciliation
+     * @param {string} reconId id of the recon to cancel
+     * @returns {Promise<ReconStatusType>} a promise resolving to a recon status object
+     */
+    cancelRecon(reconId: string): Promise<ReconStatusType>;
+};
+declare const _default: (state: State) => Recon;
+export default _default;
+export declare function readRecons({ state, }: {
+    state: State;
+}): Promise<ReconType[]>;
+export declare function readRecon({ reconId, state, }: {
+    reconId: string;
+    state: State;
+}): Promise<ReconType>;
+export declare function startRecon({ mappingName, state, }: {
+    mappingName: string;
+    state: State;
+}): Promise<ReconStatusType>;
+export declare function startReconById({ mappingName, objectId, state, }: {
+    mappingName: string;
+    objectId: string;
+    state: State;
+}): Promise<ReconStatusType>;
+export declare function cancelRecon({ reconId, state, }: {
+    reconId: string;
+    state: State;
+}): Promise<ReconStatusType>;
+//# sourceMappingURL=ReconOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ReconOps.d.ts","sourceRoot":"","sources":["../../src/ops/ReconOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,eAAe,EACf,SAAS,EACV,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,MAAM,MAAM,KAAK,GAAG;IAClB;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACnC;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC/C;;;;OAIG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC1D;;;;;OAKG;IACH,cAAc,CACZ,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,eAAe,CAAC,CAAC;IAC5B;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CACxD,CAAC;yBAEc,OAAO,KAAK,KAAG,KAAK;AAApC,wBAqBE;AAEF,wBAAsB,UAAU,CAAC,EAC/B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAEvB;AAED,wBAAsB,SAAS,CAAC,EAC9B,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,CAAC,CAErB;AAED,wBAAsB,UAAU,CAAC,EAC/B,WAAW,EACX,KAAK,GACN,EAAE;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,eAAe,CAAC,CAE3B;AAED,wBAAsB,cAAc,CAAC,EACnC,WAAW,EACX,QAAQ,EACR,KAAK,GACN,EAAE;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,eAAe,CAAC,CAE3B;AAED,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,eAAe,CAAC,CAE3B"}

package/types/ops/RequiredScopesOps.d.ts

@@ -0,0 +1,69 @@
+import { State } from '../shared/State';
+import { FrodoError } from './FrodoError';
+/**
+ * Thrown by `assertHasRequiredScope()`/`resolveAvailableScope()` below —
+ * both pre-flight checks reachable only through `api/BaseApi.ts`'s
+ * `attachCredentialInterceptor()`, which distinguishes this from any other
+ * failure to decide whether escalating to a higher-tier credential (see
+ * `ops/PrivilegeEscalationOps.ts`) and retrying is worth attempting at all.
+ * A plain `FrodoError` here would be indistinguishable from an unrelated
+ * failure (a config error, a network error surfacing through the same
+ * call path) that retrying with a different credential can't fix.
+ */
+export declare class InsufficientScopeError extends FrodoError {
+}
+/**
+ * Resolves the scope string to actually request for a module's declared
+ * required scopes, given the current session's auth mode.
+ *
+ * @remarks
+ * Every non-browser auth mode (password, service-account, Amster) already
+ * holds a session cookie or a full-scope bearer token, so the module's
+ * required scopes pass straight through unchanged — there is nothing to
+ * narrow or gate. Cloud browser-login mode is the one case that matters: its
+ * AM-domain calls go through an RFC 8693 exchange (see
+ * `BrowserAuthenticateOps.ts`'s `exchangeTokenForScope`) via a Ping-owned
+ * client (`AICMCPExchangeClient`) with a hard-coded scope allow-list
+ * (`Constants.CLOUD_BROWSER_MODE_AVAILABLE_SCOPES`). A module whose required
+ * scope falls outside that allow-list is structurally unreachable via cloud
+ * browser-mode, so this throws a clear, actionable error rather than letting
+ * the call fail later with an opaque 400/401 from AM.
+ */
+export declare function resolveAvailableScope({ requiredScopes, state, }: {
+    requiredScopes: string[];
+    state: State;
+}): string;
+/**
+ * Local pre-flight gate: throws before a request goes out if the current
+ * session's credential does not carry a scope an operation requires,
+ * instead of letting AM/IDM reject the call over the wire.
+ *
+ * @remarks
+ * This is called from exactly one place — `api/BaseApi.ts`'s per-request
+ * credential resolvers — never from ops-layer code. Required scopes are
+ * declared at the api layer (one value per api-layer function, since each
+ * one maps 1:1 to a single HTTP verb+path, the same granularity AIC's own
+ * scope enforcement operates at) and required (non-optional) on
+ * `generateAmApi`/`generateIdmApi`/`generateEnvApi`/etc., so there is no
+ * ops-layer call site that could forget to gate a new operation — omitting
+ * `requiredScopes` anywhere in that chain is a compile error, not a silent
+ * gap. See the `anchor-enforcement-at-wire-layer` design note for why this
+ * replaced an earlier, ops-layer-anchored version of this same gate.
+ *
+ * OAuth2 scope-gated access control (the `fr:` namespace) is a PingOne
+ * Advanced Identity Cloud concept, not a universal one — classic has no
+ * such scope model at all, and it's unconfirmed whether ForgeOps's IDM
+ * shares cloud's (see the `frodo-scopes-are-cloud-only` design note); this
+ * check is a no-op for every deployment type except cloud. It's also a
+ * no-op whenever the caller has no granted-scope value to check at all
+ * (e.g. a plain AM session cookie, which carries no OAuth2 scope concept,
+ * or no token yet because login hasn't completed) — callers pass `undefined`
+ * for `grantedScope` in exactly those cases rather than this function
+ * inferring it.
+ */
+export declare function assertHasRequiredScope({ requiredScopes, grantedScope, state, }: {
+    requiredScopes: string[];
+    grantedScope: string | undefined;
+    state: State;
+}): void;
+//# sourceMappingURL=RequiredScopesOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RequiredScopesOps.d.ts","sourceRoot":"","sources":["../../src/ops/RequiredScopesOps.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,UAAU;CAAG;AAEzD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,qBAAqB,CAAC,EACpC,cAAc,EACd,KAAK,GACN,EAAE;IACD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,MAAM,CAoBT;AAeD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,cAAc,EACd,YAAY,EACZ,KAAK,GACN,EAAE;IACD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,IAAI,CAqBP"}

package/types/ops/ResourceTypeOps.d.ts

@@ -0,0 +1,219 @@
+import { type ResourceTypeSkeleton } from '../api/ResourceTypesApi';
+import { State } from '../shared/State';
+import { ExportMetaData } from './OpsTypes';
+export type ResourceType = {
+    /**
+     * Read resource type
+     * @param resourceTypeUuid resource type uuid
+     * @returns {Promise<ResourceTypeSkeleton>} a promise that resolves to a resource type object
+     */
+    readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
+    /**
+     * Read all resource types
+     * @returns {Promise<ResourceTypeSkeleton[]>} a promise that resolves to an array of resource type objects
+     */
+    readResourceTypes(): Promise<ResourceTypeSkeleton[]>;
+    /**
+     * Read resource type by name
+     * @param {string} resourceTypeName resource type name
+     * @returns {Promise<ResourceTypeSkeleton>} a promise that resolves to a resource type object
+     */
+    readResourceTypeByName(resourceTypeName: string): Promise<ResourceTypeSkeleton>;
+    /**
+     * Create resource type
+     * @param resourceTypeData resource type data
+     * @param resourceTypeUuid resource type uuid
+     * @returns {Promise<ResourceTypeSkeleton>} a promise that resolves to a resource type object
+     */
+    createResourceType(resourceTypeData: ResourceTypeSkeleton, resourceTypeUuid?: string): Promise<ResourceTypeSkeleton>;
+    /**
+     * Update resource type
+     * @param resourceTypeUuid resource type uuid
+     * @param {string} resourceTypeData resource type data
+     * @returns {Promise<ResourceTypeSkeleton | null>} a promise that resolves to a resource type object, or null if no update was made
+     */
+    updateResourceType(resourceTypeUuid: string, resourceTypeData: ResourceTypeSkeleton): Promise<ResourceTypeSkeleton | null>;
+    /**
+     * Delete resource type
+     * @param {string} resourceTypeUuid resource type uuid
+     * @returns {Promise<ResourceTypeSkeleton>} Promise resolvig to a resource type object
+     */
+    deleteResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
+    /**
+     * Delete resource type by name
+     * @param {string} resourceTypeName resource type name
+     * @returns {Promise<ResourceTypeSkeleton>} Promise resolvig to a resource type object
+     */
+    deleteResourceTypeByName(resourceTypeName: string): Promise<ResourceTypeSkeleton>;
+    /**
+     * Export resource type
+     * @param {string} resourceTypeUuid resource type uuid
+     * @returns {Promise<ResourceTypeExportInterface>} a promise that resolves to an ResourceTypeExportInterface object
+     */
+    exportResourceType(resourceTypeUuid: string): Promise<ResourceTypeExportInterface>;
+    /**
+     * Export resource type by name
+     * @param {string} resourceTypeName resource type name
+     * @returns {Promise<ResourceTypeExportInterface>} a promise that resolves to an ResourceTypeExportInterface object
+     */
+    exportResourceTypeByName(resourceTypeName: string): Promise<ResourceTypeExportInterface>;
+    /**
+     * Export resource types
+     * @returns {Promise<ResourceTypeExportInterface>} a promise that resolves to an ResourceTypeExportInterface object
+     */
+    exportResourceTypes(): Promise<ResourceTypeExportInterface>;
+    /**
+     * Import resource type by uuid
+     * @param {string} resourceTypeUuid client uuid
+     * @param {ResourceTypeExportInterface} importData import data
+     * @returns {Promise<ResourceTypeSkeleton | null>} a promise that resolves to the imported resource type object, or null if no update was made
+     */
+    importResourceType(resourceTypeUuid: string, importData: ResourceTypeExportInterface): Promise<ResourceTypeSkeleton | null>;
+    /**
+     * Import resource type by name
+     * @param {string} resourceTypeName client id
+     * @param {ResourceTypeExportInterface} importData import data
+     * @returns {Promise<ResourceTypeSkeleton | null>} a promise that resolves to the imported resource type object, or null if no update was made
+     */
+    importResourceTypeByName(resourceTypeName: string, importData: ResourceTypeExportInterface): Promise<ResourceTypeSkeleton | null>;
+    /**
+     * Import first resource type
+     * @param {ResourceTypeExportInterface} importData import data
+     * @returns {Promise<ResourceTypeSkeleton | null>} a promise that resolves to the imported resource type object, or null if no update was made
+     */
+    importFirstResourceType(importData: ResourceTypeExportInterface): Promise<ResourceTypeSkeleton | null>;
+    /**
+     * Import resource types
+     * @param {ResourceTypeExportInterface} importData import data
+     * @returns {Promise<ResourceTypeSkeleton[]>} a promise that resolves to the imported resource type objects
+     */
+    importResourceTypes(importData: ResourceTypeExportInterface): Promise<ResourceTypeSkeleton[]>;
+};
+declare const _default: (state: State) => ResourceType;
+export default _default;
+export interface ResourceTypeExportInterface {
+    meta?: ExportMetaData;
+    resourcetype: Record<string, ResourceTypeSkeleton>;
+}
+/**
+ * Create an empty export template
+ * @returns {ResourceTypeExportInterface} an empty export template
+ */
+export declare function createResourceTypeExportTemplate({ state, }: {
+    state: State;
+}): ResourceTypeExportInterface;
+export declare function readResourceType({ resourceTypeUuid, state, }: {
+    resourceTypeUuid: string;
+    state: State;
+}): Promise<any>;
+/**
+ * Get all resource types
+ * @returns {Promise} a promise that resolves to an array of resource type objects
+ */
+export declare function readResourceTypes({ state, }: {
+    state: State;
+}): Promise<ResourceTypeSkeleton[]>;
+/**
+ * Get resource type by name
+ * @param {string} resourceTypeName resource type name
+ * @returns {Promise<ResourceTypeSkeleton>} a promise that resolves to a resource type object
+ */
+export declare function readResourceTypeByName({ resourceTypeName, state, }: {
+    resourceTypeName: string;
+    state: State;
+}): Promise<ResourceTypeSkeleton>;
+/**
+ * Update resource type
+ * @param resourceTypeUuid resource type uuid
+ * @param {string} resourceTypeData resource type data
+ * @returns {Promise<ResourceTypeSkeleton | null>} a promise that resolves to a resource type object, or null if no update was made
+ */
+export declare function updateResourceType({ resourceTypeUuid, resourceTypeData, state, }: {
+    resourceTypeUuid: string;
+    resourceTypeData: ResourceTypeSkeleton;
+    state: State;
+}): Promise<ResourceTypeSkeleton | null>;
+export declare function deleteResourceType({ resourceTypeUuid, state, }: {
+    resourceTypeUuid: string;
+    state: State;
+}): Promise<any>;
+/**
+ * Delete resource type by name
+ * @param {string} resourceTypeName resource type name
+ * @returns {Promise<ResourceTypeSkeleton>} Promise resolvig to a resource type object
+ */
+export declare function deleteResourceTypeByName({ resourceTypeName, state, }: {
+    resourceTypeName: string;
+    state: State;
+}): Promise<ResourceTypeSkeleton>;
+/**
+ * Export resource type
+ * @param {string} resourceTypeUuid resource type uuid
+ * @returns {Promise<ResourceTypeExportInterface>} a promise that resolves to an ResourceTypeExportInterface object
+ */
+export declare function exportResourceType({ resourceTypeUuid, state, }: {
+    resourceTypeUuid: string;
+    state: State;
+}): Promise<ResourceTypeExportInterface>;
+/**
+ * Export resource type by name
+ * @param {string} resourceTypeName resource type name
+ * @returns {Promise<ResourceTypeExportInterface>} a promise that resolves to an ResourceTypeExportInterface object
+ */
+export declare function exportResourceTypeByName({ resourceTypeName, state, }: {
+    resourceTypeName: string;
+    state: State;
+}): Promise<ResourceTypeExportInterface>;
+/**
+ * Export resource types
+ * @returns {Promise<ResourceTypeExportInterface>} a promise that resolves to an ResourceTypeExportInterface object
+ */
+export declare function exportResourceTypes({ state, }: {
+    state: State;
+}): Promise<ResourceTypeExportInterface>;
+/**
+ * Import resource type by uuid
+ * @param {string} resourceTypeUuid client uuid
+ * @param {ResourceTypeExportInterface} importData import data
+ * @returns {Promise<ResourceTypeSkeleton | null>} a promise that resolves to the imported resource type object, or null if no update was made
+ */
+export declare function importResourceType({ resourceTypeUuid, importData, state, }: {
+    resourceTypeUuid: string;
+    importData: ResourceTypeExportInterface;
+    state: State;
+}): Promise<ResourceTypeSkeleton | null>;
+/**
+ * Import resource type by name
+ * @param {string} resourceTypeName client id
+ * @param {ResourceTypeExportInterface} importData import data
+ * @returns {Promise<ResourceTypeSkeleton | null>} a promise that resolves to the imported resource type object, or null if no update was made
+ */
+export declare function importResourceTypeByName({ resourceTypeName, importData, state, }: {
+    resourceTypeName: string;
+    importData: ResourceTypeExportInterface;
+    state: State;
+}): Promise<ResourceTypeSkeleton | null>;
+/**
+ * Import first resource type
+ * @param {ResourceTypeExportInterface} importData import data
+ * @returns {Promise<ResourceTypeSkeleton | null>} a promise that resolves to the imported resource type object, or null if no update was made
+ */
+export declare function importFirstResourceType({ importData, state, }: {
+    importData: ResourceTypeExportInterface;
+    state: State;
+}): Promise<ResourceTypeSkeleton | null>;
+/**
+ * Import resource types
+ * @param {ResourceTypeExportInterface} importData import data
+ * @returns {Promise<ResourceTypeSkeleton[]>} a promise that resolves to the imported resource type objects
+ */
+export declare function importResourceTypes({ importData, state, }: {
+    importData: ResourceTypeExportInterface;
+    state: State;
+}): Promise<ResourceTypeSkeleton[]>;
+export declare function createResourceType({ resourceTypeData, resourceTypeUuid, state, }: {
+    resourceTypeData: ResourceTypeSkeleton;
+    resourceTypeUuid?: string;
+    state: State;
+}): Promise<ResourceTypeSkeleton>;
+//# sourceMappingURL=ResourceTypeOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceTypeOps.d.ts","sourceRoot":"","sources":["../../src/ops/ResourceTypeOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAUxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,MAAM,YAAY,GAAG;IACzB;;;;OAIG;IACH,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC1E;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACrD;;;;OAIG;IACH,sBAAsB,CACpB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;OAKG;IACH,kBAAkB,CAChB,gBAAgB,EAAE,oBAAoB,EACtC,gBAAgB,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;OAKG;IACH,kBAAkB,CAChB,gBAAgB,EAAE,MAAM,EACxB,gBAAgB,EAAE,oBAAoB,GACrC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAC;IACxC;;;;OAIG;IACH,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC5E;;;;OAIG;IACH,wBAAwB,CACtB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;OAIG;IACH,kBAAkB,CAChB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,2BAA2B,CAAC,CAAC;IACxC;;;;OAIG;IACH,wBAAwB,CACtB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,2BAA2B,CAAC,CAAC;IACxC;;;OAGG;IACH,mBAAmB,IAAI,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC5D;;;;;OAKG;IACH,kBAAkB,CAChB,gBAAgB,EAAE,MAAM,EACxB,UAAU,EAAE,2BAA2B,GACtC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAC;IACxC;;;;;OAKG;IACH,wBAAwB,CACtB,gBAAgB,EAAE,MAAM,EACxB,UAAU,EAAE,2BAA2B,GACtC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAC;IACxC;;;;OAIG;IACH,uBAAuB,CACrB,UAAU,EAAE,2BAA2B,GACtC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAC;IACxC;;;;OAIG;IACH,mBAAmB,CACjB,UAAU,EAAE,2BAA2B,GACtC,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;CACpC,CAAC;yBAEc,OAAO,KAAK,KAAG,YAAY;AAA3C,wBAiFE;AAEF,MAAM,WAAW,2BAA2B;IAC1C,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACpD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,EAC/C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,2BAA2B,CAQ9B;AAED,wBAAsB,gBAAgB,CAAC,EACrC,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,gBAUA;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAUlC;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAwBhC;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,oBAAoB,CAAC;IACvC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAgBvC;AAED,wBAAsB,kBAAkB,CAAC,EACvC,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,gBAUA;AAED;;;;GAIG;AACH,wBAAsB,wBAAwB,CAAC,EAC7C,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAahC;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAwBvC;AAED;;;;GAIG;AACH,wBAAsB,wBAAwB,CAAC,EAC7C,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAuBvC;AAED;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAsCvC;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,gBAAgB,EAChB,UAAU,EACV,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,2BAA2B,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CA0CvC;AAED;;;;;GAKG;AACH,wBAAsB,wBAAwB,CAAC,EAC7C,gBAAgB,EAChB,UAAU,EACV,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,2BAA2B,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CA0CvC;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,EAC5C,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,2BAA2B,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAwCvC;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,2BAA2B,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAmClC;AAED,wBAAsB,kBAAkB,CAAC,EACvC,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,GACN,EAAE;IACD,gBAAgB,EAAE,oBAAoB,CAAC;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAmBhC"}