@rockcarver/frodo-lib 4.10.0 → 4.11.0

package/types/ops/UserOps.d.ts

@@ -0,0 +1,199 @@
+import { UserConfigSkeleton, UserGroupSkeleton, UserSkeleton } from '../api/UserApi';
+import { State } from '../shared/State';
+import { ExportMetaData } from './OpsTypes';
+export type User = {
+    /**
+     * Create an empty user export template
+     * @returns {UserExportInterface} an empty user export template
+     */
+    createUserExportTemplate(): UserExportInterface;
+    /**
+     * Read user by id
+     * @param {string} userId User id
+     * @returns {Promise<UserSkeleton>} a promise that resolves to a user object
+     */
+    readUser(userId: string): Promise<UserSkeleton>;
+    /**
+     * Read all users.
+     * @returns {Promise<UserSkeleton[]>} a promise that resolves to an array of user objects
+     */
+    readUsers(): Promise<UserSkeleton[]>;
+    /**
+     * Count all users in the active realm.
+     * @returns {Promise<number>} exact count when supported by the backing API
+     */
+    countUsers(): Promise<number>;
+    /**
+     * Export a single user by id. The response can be saved to file as is.
+     * @param {string} userId User id
+     * @returns {Promise<UserExportInterface>} Promise resolving to a UserExportInterface object.
+     */
+    exportUser(userId: string): Promise<UserExportInterface>;
+    /**
+     * Export all users. The response can be saved to file as is.
+     * @returns {Promise<UserExportInterface>} Promise resolving to a UserExportInterface object.
+     */
+    exportUsers(): Promise<UserExportInterface>;
+    /**
+     * Create an empty user group export template
+     * @returns {UserGroupExportInterface} an empty user group export template
+     */
+    createUserGroupExportTemplate(): UserGroupExportInterface;
+    /**
+     * Read user group by id
+     * @param {string} groupId Group id
+     * @returns {Promise<UserGroupSkeleton>} a promise that resolves to a user group object
+     */
+    readUserGroup(groupId: string): Promise<UserGroupSkeleton>;
+    /**
+     * Read all user groups.
+     * @returns {Promise<UserGroupSkeleton[]>} a promise that resolves to an array of user group objects
+     */
+    readUserGroups(): Promise<UserGroupSkeleton[]>;
+    /**
+     * Export a single user group by id. The response can be saved to file as is.
+     * @param {string} groupId Group id
+     * @returns {Promise<UserGroupExportInterface>} Promise resolving to a UserGroupExportInterface object.
+     */
+    exportUserGroup(groupId: string): Promise<UserGroupExportInterface>;
+    /**
+     * Export all user groups. The response can be saved to file as is.
+     * @returns {Promise<UserGroupExportInterface>} Promise resolving to a UserGroupExportInterface object.
+     */
+    exportUserGroups(): Promise<UserGroupExportInterface>;
+    /**
+     * Import users and their config
+     * @param {UserExportInterface} importData user import data
+     * @param {string} userId Optional user id. If supplied, only the user of that id is imported.
+     * @returns {Promise<UserExportSkeleton[]>} the imported users
+     */
+    importUsers(importData: UserExportInterface, userId?: string): Promise<UserExportSkeleton[]>;
+    /**
+     * Import user groups
+     * @param {UserGroupExportInterface} importData user group import data
+     * @param {string} groupId Optional user group id. If supplied, only the group of that id is imported.
+     * @returns {Promise<UserGroupSkeleton[]>} the imported user groups
+     */
+    importUserGroups(importData: UserGroupExportInterface, groupId?: string): Promise<UserGroupSkeleton[]>;
+};
+declare const _default: (state: State) => User;
+export default _default;
+export type UserExportSkeleton = UserSkeleton & {
+    config: UserConfigSkeleton;
+};
+export interface UserExportInterface {
+    meta?: ExportMetaData;
+    user: Record<string, UserExportSkeleton>;
+}
+export interface UserGroupExportInterface {
+    meta?: ExportMetaData;
+    userGroup: Record<string, UserGroupSkeleton>;
+}
+/**
+ * Create an empty user export template
+ * @returns {UserExportInterface} an empty user export template
+ */
+export declare function createUserExportTemplate({ state, }: {
+    state: State;
+}): UserExportInterface;
+/**
+ * Read user by id
+ * @param {string} userId User id
+ * @returns {Promise<UserSkeleton>} a promise that resolves to a user object
+ */
+export declare function readUser({ userId, state, }: {
+    userId: string;
+    state: State;
+}): Promise<UserSkeleton>;
+/**
+ * Read all users.
+ * @returns {Promise<UserSkeleton[]>} a promise that resolves to an array of user objects
+ */
+export declare function readUsers({ state, }: {
+    state: State;
+}): Promise<UserSkeleton[]>;
+/**
+ * Count all users in the active realm.
+ * @returns {Promise<number>} exact count when supported by the backing API
+ */
+export declare function countUsers({ state }: {
+    state: State;
+}): Promise<number>;
+/**
+ * Export a single user by id. The response can be saved to file as is.
+ * @param {string} userId User id
+ * @returns {Promise<UserExportInterface>} Promise resolving to a UserExportInterface object.
+ */
+export declare function exportUser({ userId, state, }: {
+    userId: string;
+    state: State;
+}): Promise<UserExportInterface>;
+/**
+ * Export all users. The response can be saved to file as is.
+ * @returns {Promise<UserExportInterface>} Promise resolving to a UserExportInterface object.
+ */
+export declare function exportUsers({ state, }: {
+    state: State;
+}): Promise<UserExportInterface>;
+/**
+ * Create an empty user group export template
+ * @returns {UserGroupExportInterface} an empty user group export template
+ */
+export declare function createUserGroupExportTemplate({ state, }: {
+    state: State;
+}): UserGroupExportInterface;
+/**
+ * Read user group by id
+ * @param {string} groupId User group id
+ * @returns {Promise<UserGroupSkeleton>} a promise that resolves to a user group object
+ */
+export declare function readUserGroup({ groupId, state, }: {
+    groupId: string;
+    state: State;
+}): Promise<UserGroupSkeleton>;
+/**
+ * Read all user groups.
+ * @returns {Promise<UserGroupSkeleton[]>} a promise that resolves to an array of user group objects
+ */
+export declare function readUserGroups({ state, }: {
+    state: State;
+}): Promise<UserGroupSkeleton[]>;
+/**
+ * Export a single user group by id. The response can be saved to file as is.
+ * @param {string} groupId User group id
+ * @returns {Promise<UserGroupExportInterface>} Promise resolving to a UserGroupExportInterface object.
+ */
+export declare function exportUserGroup({ groupId, state, }: {
+    groupId: string;
+    state: State;
+}): Promise<UserGroupExportInterface>;
+/**
+ * Export all user groups. The response can be saved to file as is.
+ * @returns {Promise<UserGroupExportInterface>} Promise resolving to a UserGroupExportInterface object.
+ */
+export declare function exportUserGroups({ state, }: {
+    state: State;
+}): Promise<UserGroupExportInterface>;
+/**
+ * Import users and their config
+ * @param {UserExportInterface} importData user import data
+ * @param {string} userId Optional user id. If supplied, only the user of that id is imported.
+ * @returns {Promise<UserExportSkeleton[]>} the imported users
+ */
+export declare function importUsers({ importData, userId, state, }: {
+    importData: UserExportInterface;
+    userId?: string;
+    state: State;
+}): Promise<UserExportSkeleton[]>;
+/**
+ * Import user groups
+ * @param {UserGroupExportInterface} importData user group import data
+ * @param {string} groupId Optional user group id. If supplied, only the group of that id is imported.
+ * @returns {Promise<UserGroupSkeleton[]>} the imported user groups
+ */
+export declare function importUserGroups({ importData, groupId, state, }: {
+    importData: UserGroupExportInterface;
+    groupId?: string;
+    state: State;
+}): Promise<UserGroupSkeleton[]>;
+//# sourceMappingURL=UserOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UserOps.d.ts","sourceRoot":"","sources":["../../src/ops/UserOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAUL,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AASxC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,MAAM,IAAI,GAAG;IACjB;;;OAGG;IACH,wBAAwB,IAAI,mBAAmB,CAAC;IAChD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAChD;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IACrC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACzD;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC5C;;;OAGG;IACH,6BAA6B,IAAI,wBAAwB,CAAC;IAC1D;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC3D;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC/C;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACpE;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACtD;;;;;OAKG;IACH,WAAW,CACT,UAAU,EAAE,mBAAmB,EAC/B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACjC;;;;;OAKG;IACH,gBAAgB,CACd,UAAU,EAAE,wBAAwB,EACpC,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;CACjC,CAAC;yBAEc,OAAO,KAAK,KAAG,IAAI;AAAnC,wBAwDE;AAEF,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG;IAC9C,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CAC9C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,mBAAmB,CAKtB;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,YAAY,CAAC,CAMxB;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAAC,EAC9B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAY1B;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAe7E;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAa/B;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAAC,EAChC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAuC/B;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAAC,EAC5C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,wBAAwB,CAK3B;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,EAClC,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAM7B;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,EACnC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAgB/B;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAYpC;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAsCpC;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,EAChC,UAAU,EACV,MAAM,EACN,KAAK,GACN,EAAE;IACD,UAAU,EAAE,mBAAmB,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAsChC;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,UAAU,EACV,OAAO,EACP,KAAK,GACN,EAAE;IACD,UAAU,EAAE,wBAAwB,CAAC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CA+B/B"}

package/types/ops/VersionUtils.d.ts

@@ -0,0 +1,29 @@
+import { State } from '../shared/State';
+export type Version = {
+    getVersion(): string;
+    getBuildTimestamp(): string;
+    getAllVersions(endpoints: {
+        base: string;
+        path: string;
+    }[]): Promise<PromiseSettledResult<any>[]>;
+};
+declare const _default: (state: State) => Version;
+export default _default;
+export declare function getVersion({ state }: {
+    state: State;
+}): string;
+/**
+ * ISO 8601 timestamp of when this frodo-lib build was produced. See
+ * getLibBuildTimestamp in shared/Version.ts for how it's captured.
+ */
+export declare function getBuildTimestamp({ state }: {
+    state: State;
+}): string;
+export declare function getAllVersions({ endpoints, state, }: {
+    endpoints: {
+        base: string;
+        path: string;
+    }[];
+    state: State;
+}): Promise<PromiseSettledResult<any>[]>;
+//# sourceMappingURL=VersionUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"VersionUtils.d.ts","sourceRoot":"","sources":["../../src/ops/VersionUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAGxC,MAAM,MAAM,OAAO,GAAG;IACpB,UAAU,IAAI,MAAM,CAAC;IACrB,iBAAiB,IAAI,MAAM,CAAC;IAC5B,cAAc,CACZ,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,GACF,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;CACzC,CAAC;yBAEc,OAAO,KAAK,KAAG,OAAO;AAAtC,wBAcE;AAEF,wBAAgB,UAAU,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,UAGrD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,UAG5D;AAED,wBAAsB,cAAc,CAAC,EACnC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC5C,KAAK,EAAE,KAAK,CAAC;CACd,wCASA"}

package/types/ops/classic/ServerOps.d.ts

@@ -0,0 +1,195 @@
+import { ServerPropertiesSkeleton, ServerSkeleton } from '../../api/classic/ServerApi';
+import { State } from '../../shared/State';
+import { ExportMetaData } from '../OpsTypes';
+export type Server = {
+    /**
+     * Create an empty server export template
+     * @returns {ServerExportInterface} an empty server export template
+     */
+    createServerExportTemplate(): ServerExportInterface;
+    /**
+     * Read server by id
+     * @param {string} serverId Server id
+     * @returns {Promise<ServerSkeleton>} a promise that resolves to a server object
+     */
+    readServer(serverId: string): Promise<ServerSkeleton>;
+    /**
+     * Read server by url
+     * @param {string} serverUrl Server url
+     * @returns {Promise<ServerSkeleton>} a promise that resolves to a server object
+     */
+    readServerByUrl(serverUrl: string): Promise<ServerSkeleton>;
+    /**
+     * Read all servers.
+     * @returns {Promise<ServerSkeleton[]>} a promise that resolves to an array of server objects
+     */
+    readServers(): Promise<ServerSkeleton[]>;
+    /**
+     * Export a single server by id. The response can be saved to file as is.
+     * @param {string} serverId Server id
+     * @param {ServerExportOptions} options Server export options
+     * @returns {Promise<ServerExportInterface>} Promise resolving to a ServerExportInterface object.
+     */
+    exportServer(serverId: string, options: ServerExportOptions): Promise<ServerExportInterface>;
+    /**
+     * Export a single server by url. The response can be saved to file as is.
+     * @param {string} serverUrl Server url
+     * @param {ServerExportOptions} options Server export options
+     * @returns {Promise<ServerExportInterface>} Promise resolving to a ServerExportInterface object.
+     */
+    exportServerByUrl(serverUrl: string, options: ServerExportOptions): Promise<ServerExportInterface>;
+    /**
+     * Export all servers. The response can be saved to file as is.
+     * @param {ServerExportOptions} options Server export options
+     * @returns {Promise<ServerExportInterface>} Promise resolving to a ServerExportInterface object.
+     */
+    exportServers(options: ServerExportOptions): Promise<ServerExportInterface>;
+    /**
+     * Creates a server
+     * @param {ServerSkeleton} serverData server object
+     * @returns {Promise<ServerSkeleton>} a promise that resolves to a server object
+     */
+    createServer(serverData: ServerSkeleton): Promise<ServerSkeleton>;
+    /**
+     * Imports the first server from the importData
+     * @param importData server import data
+     * @param options server import options
+     */
+    importFirstServer(importData: ServerExportInterface, options: ServerImportOptions): Promise<ServerExportInterface>;
+    /**
+     * Imports servers along with their properties
+     * @param {ServerExportInterface} importData server import data
+     * @param {ServerImportOptions} options server import options
+     * @param {string} serverId Optional server id. If supplied, only the server (and its properties) of that id is imported. Takes priority over serverUrl if both are provided.
+     * @param {string} serverUrl Optional server url. If supplied, only the server of that url is imported.
+     * @returns {Promise<ServerExportInterface>} a promise that resolves to a server export object
+     */
+    importServers(importData: ServerExportInterface, options: ServerImportOptions, serverId?: string, serverUrl?: string): Promise<ServerExportInterface>;
+};
+declare const _default: (state: State) => Server;
+export default _default;
+/**
+ * Server export options
+ */
+export interface ServerExportOptions {
+    /**
+     * True to export the default server properties, false otherwise
+     */
+    includeDefault: boolean;
+}
+/**
+ * Server import options
+ */
+export interface ServerImportOptions {
+    /**
+     * True to import the default server properties, false otherwise
+     */
+    includeDefault: boolean;
+}
+export type ServerExportSkeleton = ServerSkeleton & {
+    properties: ServerPropertiesSkeleton;
+};
+export interface ServerExportInterface {
+    meta?: ExportMetaData;
+    server: Record<string, ServerExportSkeleton>;
+    defaultProperties: ServerPropertiesSkeleton;
+}
+/**
+ * Create an empty server export template
+ * @returns {ServerExportInterface} an empty server export template
+ */
+export declare function createServerExportTemplate({ state, }: {
+    state: State;
+}): ServerExportInterface;
+/**
+ * Read server by id
+ * @param {string} serverId Server id
+ * @returns {Promise<ServerSkeleton>} a promise that resolves to a server object
+ */
+export declare function readServer({ serverId, state, }: {
+    serverId: string;
+    state: State;
+}): Promise<ServerSkeleton>;
+/**
+ * Read server by url
+ * @param {string} serverUrl Server url
+ * @returns {Promise<ServerSkeleton>} a promise that resolves to a server object
+ */
+export declare function readServerByUrl({ serverUrl, state, }: {
+    serverUrl: string;
+    state: State;
+}): Promise<ServerSkeleton>;
+/**
+ * Read all servers.
+ * @returns {Promise<ServerSkeleton[]>} a promise that resolves to an array of server objects
+ */
+export declare function readServers({ state, }: {
+    state: State;
+}): Promise<ServerSkeleton[]>;
+/**
+ * Export a single server by id. The response can be saved to file as is.
+ * @param {string} serverId Server id
+ * @param {ServerExportOptions} options Server export options
+ * @returns {Promise<ServerExportInterface>} Promise resolving to a ServerExportInterface object.
+ */
+export declare function exportServer({ serverId, options, state, }: {
+    serverId: string;
+    options: ServerExportOptions;
+    state: State;
+}): Promise<ServerExportInterface>;
+/**
+ * Export a single server by url. The response can be saved to file as is.
+ * @param {string} serverUrl Server url
+ * @param {ServerExportOptions} options Server export options
+ * @returns {Promise<ServerExportInterface>} Promise resolving to a ServerExportInterface object.
+ */
+export declare function exportServerByUrl({ serverUrl, options, state, }: {
+    serverUrl: string;
+    options: ServerExportOptions;
+    state: State;
+}): Promise<ServerExportInterface>;
+/**
+ * Export all servers. The response can be saved to file as is.
+ * @param {ServerExportOptions} options Server export options
+ * @returns {Promise<ServerExportInterface>} Promise resolving to a ServerExportInterface object.
+ */
+export declare function exportServers({ options, state, }: {
+    options: ServerExportOptions;
+    state: State;
+}): Promise<ServerExportInterface>;
+/**
+ * Creates a server
+ * @param {ServerSkeleton} serverData server object
+ * @returns {Promise<ServerSkeleton>} a promise that resolves to a server object
+ */
+export declare function createServer({ serverData, state, }: {
+    serverData: ServerSkeleton;
+    state: any;
+}): Promise<ServerSkeleton>;
+/**
+ * Import first server
+ * @param {ServerExportInterface} importData import data
+ * @param {ServerImportOptions} options import options
+ * @returns {Promise<ServerExportInterface>} a promise that resolves to a server export object
+ */
+export declare function importFirstServer({ importData, options, state, }: {
+    importData: ServerExportInterface;
+    options?: ServerImportOptions;
+    state: State;
+}): Promise<ServerExportInterface>;
+/**
+ * Imports servers along with their properties
+ * @param {string} serverId Optional server id. If supplied, only the server (and its properties) of that id is imported. Takes priority over serverUrl if both are provided.
+ * @param {string} serverUrl Optional server url. If supplied, only the server of that url is imported.
+ * @param {ServerExportInterface} importData server import data
+ * @param {ServerImportOptions} options server import options
+ * @returns {Promise<ServerExportInterface>} a promise that resolves to a server export object
+ */
+export declare function importServers({ serverId, serverUrl, importData, options, state, }: {
+    serverId?: string;
+    serverUrl?: string;
+    importData: ServerExportInterface;
+    options: ServerImportOptions;
+    state: any;
+}): Promise<ServerExportInterface>;
+//# sourceMappingURL=ServerOps.d.ts.map

package/types/ops/classic/ServerOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerOps.d.ts","sourceRoot":"","sources":["../../../src/ops/classic/ServerOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,wBAAwB,EACxB,cAAc,EACf,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAS3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,MAAM,GAAG;IACnB;;;OAGG;IACH,0BAA0B,IAAI,qBAAqB,CAAC;IACpD;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACtD;;;;OAIG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC5D;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC;;;;;OAKG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;;OAKG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5E;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE;;;;OAIG;IACH,iBAAiB,CACf,UAAU,EAAE,qBAAqB,EACjC,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC;;;;;;;OAOG;IACH,aAAa,CACX,UAAU,EAAE,qBAAqB,EACjC,OAAO,EAAE,mBAAmB,EAC5B,QAAQ,CAAC,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACnC,CAAC;yBAEc,OAAO,KAAK,KAAG,MAAM;AAArC,wBAkEE;AAEF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,UAAU,EAAE,wBAAwB,CAAC;CACtC,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAC7C,iBAAiB,EAAE,wBAAwB,CAAC;CAC7C;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,EACzC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,qBAAqB,CAMxB;AAED;;;;GAIG;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,CAM1B;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CAc1B;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAAC,EAChC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAY5B;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,OAEC,EACD,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAkBjC;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,SAAS,EACT,OAEC,EACD,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAqBjC;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,EAClC,OAEC,EACD,KAAK,GACN,EAAE;IACD,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CA4CjC;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,EACjC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,cAAc,CAAC;IAC3B,KAAK,MAAC;CACP,GAAG,OAAO,CAAC,cAAc,CAAC,CAS1B;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,UAAU,EACV,OAEC,EACD,KAAK,GACN,EAAE;IACD,UAAU,EAAE,qBAAqB,CAAC;IAClC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAgBjC;AAED;;;;;;;GAOG;AACH,wBAAsB,aAAa,CAAC,EAClC,QAAQ,EACR,SAAS,EACT,UAAU,EACV,OAEC,EACD,KAAK,GACN,EAAE;IACD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,qBAAqB,CAAC;IAClC,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,MAAC;CACP,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAkEjC"}

package/types/ops/classic/SiteOps.d.ts

@@ -0,0 +1,117 @@
+import { SiteSkeleton } from '../../api/classic/SiteApi';
+import { State } from '../../shared/State';
+import { ExportMetaData } from '../OpsTypes';
+export type Site = {
+    /**
+     * Create an empty site export template
+     * @returns {SiteExportInterface} an empty site export template
+     */
+    createSiteExportTemplate(): SiteExportInterface;
+    /**
+     * Read site by id
+     * @param {string} siteId Site id
+     * @returns {Promise<SiteSkeleton>} a promise that resolves to a site object
+     */
+    readSite(siteId: string): Promise<SiteSkeleton>;
+    /**
+     * Read all sites.
+     * @returns {Promise<SiteSkeleton[]>} a promise that resolves to an array of site objects
+     */
+    readSites(): Promise<SiteSkeleton[]>;
+    /**
+     * Export a single site by id. The response can be saved to file as is.
+     * @param {string} siteId Site id
+     * @returns {Promise<SiteExportInterface>} Promise resolving to a SiteExportInterface object.
+     */
+    exportSite(siteId: string): Promise<SiteExportInterface>;
+    /**
+     * Export all sites. The response can be saved to file as is.
+     * @returns {Promise<SiteExportInterface>} Promise resolving to a SiteExportInterface object.
+     */
+    exportSites(): Promise<SiteExportInterface>;
+    /**
+     * Update site
+     * @param {string} siteId site id
+     * @param {SiteSkeleton} siteData site data
+     * @returns {Promise<SiteSkeleton>} a promise resolving to a site object
+     */
+    updateSite(siteId: string, siteData: SiteSkeleton): Promise<SiteSkeleton>;
+    /**
+     * Import sites
+     * @param {SiteExportInterface} importData site import data
+     * @param {string} siteId Optional site id. If supplied, only the site of that id is imported. Takes priority over siteUrl if both are provided.
+     * @param {string} siteUrl Optional site url. If supplied, only the site of that url is imported.
+     * @returns {Promise<SiteSkeleton[]>} the imported sites
+     */
+    importSites(importData: SiteExportInterface, siteId?: string, siteUrl?: string): Promise<SiteSkeleton[]>;
+};
+declare const _default: (state: State) => Site;
+export default _default;
+export interface SiteExportInterface {
+    meta?: ExportMetaData;
+    site: Record<string, SiteSkeleton>;
+}
+/**
+ * Create an empty site export template
+ * @returns {SiteExportInterface} an empty site export template
+ */
+export declare function createSiteExportTemplate({ state, }: {
+    state: State;
+}): SiteExportInterface;
+/**
+ * Read site by id
+ * @param {string} siteId Site id
+ * @returns {Promise<SiteSkeleton>} a promise that resolves to a site object
+ */
+export declare function readSite({ siteId, state, }: {
+    siteId: string;
+    state: State;
+}): Promise<SiteSkeleton>;
+/**
+ * Read all sites.
+ * @returns {Promise<SiteSkeleton[]>} a promise that resolves to an array of site objects
+ */
+export declare function readSites({ state, }: {
+    state: State;
+}): Promise<SiteSkeleton[]>;
+/**
+ * Export a single site by id. The response can be saved to file as is.
+ * @param {string} siteId Site id
+ * @returns {Promise<SiteExportInterface>} Promise resolving to a SiteExportInterface object.
+ */
+export declare function exportSite({ siteId, state, }: {
+    siteId: string;
+    state: State;
+}): Promise<SiteExportInterface>;
+/**
+ * Export all sites. The response can be saved to file as is.
+ * @returns {Promise<SiteExportInterface>} Promise resolving to a SiteExportInterface object.
+ */
+export declare function exportSites({ state, }: {
+    state: State;
+}): Promise<SiteExportInterface>;
+/**
+ * Update site
+ * @param {string} siteId site id
+ * @param {SiteSkeleton} siteData site config object
+ * @returns {Promise<SiteSkeleton>} a promise that resolves to a site object
+ */
+export declare function updateSite({ siteId, siteData, state, }: {
+    siteId: string;
+    siteData: SiteSkeleton;
+    state: State;
+}): Promise<SiteSkeleton>;
+/**
+ * Import sites
+ * @param {string} siteId Optional site id. If supplied, only the site of that id is imported. Takes priority over siteUrl if both are provided.
+ * @param {string} siteUrl Optional site url. If supplied, only the site of that url is imported.
+ * @param {SiteExportInterface} importData site import data
+ * @returns {Promise<SiteSkeleton[]>} the imported sites
+ */
+export declare function importSites({ siteId, siteUrl, importData, state, }: {
+    siteId?: string;
+    siteUrl?: string;
+    importData: SiteExportInterface;
+    state: State;
+}): Promise<SiteSkeleton[]>;
+//# sourceMappingURL=SiteOps.d.ts.map

package/types/ops/classic/SiteOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SiteOps.d.ts","sourceRoot":"","sources":["../../../src/ops/classic/SiteOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,YAAY,EACb,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAS3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,IAAI,GAAG;IACjB;;;OAGG;IACH,wBAAwB,IAAI,mBAAmB,CAAC;IAChD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAChD;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IACrC;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACzD;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC5C;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1E;;;;;;OAMG;IACH,WAAW,CACT,UAAU,EAAE,mBAAmB,EAC/B,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;CAC5B,CAAC;yBAEc,OAAO,KAAK,KAAG,IAAI;AAAnC,wBAoCE;AAEF,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CACpC;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,mBAAmB,CAKtB;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,YAAY,CAAC,CAMxB;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAAC,EAC9B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAY1B;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAc/B;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAAC,EAChC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAqC/B;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,QAAQ,EACR,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,YAAY,CAAC,CAExB;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,EAChC,MAAM,EACN,OAAO,EACP,UAAU,EACV,KAAK,GACN,EAAE;IACD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,mBAAmB,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAmC1B"}