@placeos/ts-client 4.5.0 → 4.7.0

package/src/assets/functions.ts

@@ -0,0 +1,440 @@
+import { map } from 'rxjs';
+import {
+    create,
+    del,
+    patch,
+    post,
+    put,
+    query,
+    remove,
+    show,
+    update,
+} from '../api';
+import { apiEndpoint } from '../auth';
+import { toQueryString } from '../utilities/api';
+import {
+    PlaceAsset,
+    PlaceAssetCategory,
+    PlaceAssetPurchaseOrder,
+    PlaceAssetType,
+} from './assets.class';
+import {
+    PlaceAssetCategoryQueryOptions,
+    PlaceAssetPurchaseOrderQueryOptions,
+    PlaceAssetQueryOptions,
+    PlaceAssetTypeQueryOptions,
+} from './interfaces';
+
+///////////////////////////////////////////////////////////////
+//////////////////////////   Assets   /////////////////////////
+///////////////////////////////////////////////////////////////
+
+/**
+ * @private
+ */
+const ASSET_PATH = 'assets';
+
+/** Convert raw server data to an asset object */
+function processAsset(item: Partial<PlaceAsset>) {
+    return new PlaceAsset(item);
+}
+
+/**
+ * Query the available assets
+ * @param query_params Query parameters to add the to request URL
+ */
+export function queryAssets(query_params: PlaceAssetQueryOptions = {}) {
+    return query({
+        query_params,
+        fn: processAsset,
+        path: ASSET_PATH,
+    });
+}
+
+/**
+ * Get the data for an asset
+ * @param id ID of the asset to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export function showAsset(id: string, query_params: Record<string, any> = {}) {
+    return show({
+        id,
+        query_params,
+        fn: processAsset,
+        path: ASSET_PATH,
+    });
+}
+
+/**
+ * Update the asset in the database
+ * @param id ID of the asset
+ * @param form_data New values for the asset
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export function updateAsset(
+    id: string,
+    form_data: Partial<PlaceAsset>,
+    method: 'put' | 'patch' = 'patch',
+) {
+    return update({
+        id,
+        form_data,
+        query_params: {},
+        method,
+        fn: processAsset,
+        path: ASSET_PATH,
+    });
+}
+
+/**
+ * Add a new asset to the database
+ * @param form_data Application data
+ * @param query_params Query parameters to add the to request URL
+ */
+export function addAsset(form_data: Partial<PlaceAsset>) {
+    return create({
+        form_data,
+        query_params: {},
+        fn: processAsset,
+        path: ASSET_PATH,
+    });
+}
+
+/**
+ * Remove an asset from the database
+ * @param id ID of the asset
+ * @param query_params Query parameters to add the to request URL
+ */
+export function removeAsset(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return remove({ id, query_params, path: ASSET_PATH });
+}
+
+/**
+ * Add a list of new assets to the database
+ * @param form_data List of asset data
+ * @param query_params Query parameters to add the to request URL
+ */
+export function addAssets(form_data: Partial<PlaceAsset>[]) {
+    return post(
+        `${apiEndpoint()}${ASSET_PATH}/bulk`,
+        JSON.stringify(form_data),
+        {},
+    ).pipe(map((l: any) => l.map((_: any) => processAsset(_))));
+}
+
+/**
+ * Update a list of assets in the database
+ * @param id ID of the asset
+ * @param form_data New values for the asset
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export function updateAssets(
+    form_data: Partial<PlaceAsset>[],
+    method: 'put' | 'patch' = 'patch',
+) {
+    const verb = method === 'put' ? put : patch;
+    return verb(
+        `${apiEndpoint()}${ASSET_PATH}/bulk`,
+        JSON.stringify(form_data),
+        {},
+    ).pipe(map((l: any) => l.map((_: any) => processAsset(_))));
+}
+
+/**
+ * Remove an asset from the database
+ * @param id ID of the asset
+ * @param query_params Query parameters to add the to request URL
+ */
+export function removeAssets(
+    id_list: string[],
+    query_params: Record<string, any> = {},
+) {
+    const q = toQueryString(query_params);
+    return del(`${apiEndpoint()}${ASSET_PATH}/bulk${q ? '?' + q : ''}`, {
+        body: JSON.stringify(id_list),
+    }).pipe(map((l: any) => l.map((_: any) => processAsset(_))));
+}
+
+///////////////////////////////////////////////////////////////
+////////////////////////   Asset Types   //////////////////////
+///////////////////////////////////////////////////////////////
+
+/**
+ * @private
+ */
+const ASSET_TYPE_PATH = 'asset_types';
+
+/** Convert raw server data to an asset type object */
+function processAssetType(item: Partial<PlaceAssetType>) {
+    return new PlaceAssetType(item);
+}
+
+/**
+ * Query the available asset types
+ * @param query_params Query parameters to add the to request URL
+ */
+export function queryAssetTypes(query_params: PlaceAssetTypeQueryOptions = {}) {
+    return query({
+        query_params,
+        fn: processAssetType,
+        path: ASSET_TYPE_PATH,
+    });
+}
+
+/**
+ * Get the data for an asset type
+ * @param id ID of the asset type to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export function showAssetType(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return show({
+        id,
+        query_params,
+        fn: processAssetType,
+        path: ASSET_TYPE_PATH,
+    });
+}
+
+/**
+ * Update the asset type in the database
+ * @param id ID of the asset type
+ * @param form_data New values for the asset
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export function updateAssetType(
+    id: string,
+    form_data: Partial<PlaceAssetType>,
+    method: 'put' | 'patch' = 'patch',
+) {
+    return update({
+        id,
+        form_data,
+        query_params: {},
+        method,
+        fn: processAssetType,
+        path: ASSET_TYPE_PATH,
+    });
+}
+
+/**
+ * Add a new asset type to the database
+ * @param form_data Application data
+ * @param query_params Query parameters to add the to request URL
+ */
+export function addAssetType(form_data: Partial<PlaceAssetType>) {
+    return create({
+        form_data,
+        query_params: {},
+        fn: processAssetType,
+        path: ASSET_TYPE_PATH,
+    });
+}
+
+/**
+ * Remove an asset type from the database
+ * @param id ID of the asset type
+ * @param query_params Query parameters to add the to request URL
+ */
+export function removeAssetType(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return remove({ id, query_params, path: ASSET_TYPE_PATH });
+}
+
+///////////////////////////////////////////////////////////////
+/////////////////////   Asset Categories   ////////////////////
+///////////////////////////////////////////////////////////////
+
+/**
+ * @private
+ */
+const ASSET_CATEGORY_PATH = 'asset_categories';
+
+/** Convert raw server data to an asset category object */
+function processAssetCategory(item: Partial<PlaceAssetCategory>) {
+    return new PlaceAssetCategory(item);
+}
+
+/**
+ * Query the available asset categories
+ * @param query_params Query parameters to add the to request URL
+ */
+export function queryAssetCategories(
+    query_params: PlaceAssetCategoryQueryOptions = {},
+) {
+    return query({
+        query_params,
+        fn: processAssetCategory,
+        path: ASSET_CATEGORY_PATH,
+    });
+}
+
+/**
+ * Get the data for an asset category
+ * @param id ID of the asset category to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export function showAssetCategory(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return show({
+        id,
+        query_params,
+        fn: processAssetCategory,
+        path: ASSET_CATEGORY_PATH,
+    });
+}
+
+/**
+ * Update the asset category in the database
+ * @param id ID of the asset category
+ * @param form_data New values for the asset category
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export function updateAssetCategory(
+    id: string,
+    form_data: Partial<PlaceAssetCategory>,
+    method: 'put' | 'patch' = 'patch',
+) {
+    return update({
+        id,
+        form_data,
+        query_params: {},
+        method,
+        fn: processAssetCategory,
+        path: ASSET_CATEGORY_PATH,
+    });
+}
+
+/**
+ * Add a new asset category to the database
+ * @param form_data Asset category data
+ * @param query_params Query parameters to add the to request URL
+ */
+export function addAssetCategory(form_data: Partial<PlaceAssetCategory>) {
+    return create({
+        form_data,
+        query_params: {},
+        fn: processAssetCategory,
+        path: ASSET_CATEGORY_PATH,
+    });
+}
+
+/**
+ * Remove an asset category from the database
+ * @param id ID of the asset category
+ * @param query_params Query parameters to add the to request URL
+ */
+export function removeAssetCategory(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return remove({ id, query_params, path: ASSET_CATEGORY_PATH });
+}
+
+///////////////////////////////////////////////////////////////
+//////////////////   Asset Purchase Orders   //////////////////
+///////////////////////////////////////////////////////////////
+
+/**
+ * @private
+ */
+const ASSET_PURCHASE_ORDER_PATH = 'asset_purchase_orders';
+
+/** Convert raw server data to an asset purchase order object */
+function processAssetPurchaseOrder(item: Partial<PlaceAssetPurchaseOrder>) {
+    return new PlaceAssetPurchaseOrder(item);
+}
+
+/**
+ * Query the available asset purchase orders
+ * @param query_params Query parameters to add the to request URL
+ */
+export function queryAssetPurchaseOrders(
+    query_params: PlaceAssetPurchaseOrderQueryOptions = {},
+) {
+    return query({
+        query_params,
+        fn: processAssetPurchaseOrder,
+        path: ASSET_PURCHASE_ORDER_PATH,
+    });
+}
+
+/**
+ * Get the data for an asset purchase order
+ * @param id ID of the asset purchase order to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export function showAssetPurchaseOrder(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return show({
+        id,
+        query_params,
+        fn: processAssetPurchaseOrder,
+        path: ASSET_PURCHASE_ORDER_PATH,
+    });
+}
+
+/**
+ * Update the asset purchase order in the database
+ * @param id ID of the asset purchase order
+ * @param form_data New values for the asset purchase order
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export function updateAssetPurchaseOrder(
+    id: string,
+    form_data: Partial<PlaceAssetPurchaseOrder>,
+    method: 'put' | 'patch' = 'patch',
+) {
+    return update({
+        id,
+        form_data,
+        query_params: {},
+        method,
+        fn: processAssetPurchaseOrder,
+        path: ASSET_PURCHASE_ORDER_PATH,
+    });
+}
+
+/**
+ * Add a new asset purchase order to the database
+ * @param form_data Asset purchase order data
+ * @param query_params Query parameters to add the to request URL
+ */
+export function addAssetPurchaseOrder(
+    form_data: Partial<PlaceAssetPurchaseOrder>,
+) {
+    return create({
+        form_data,
+        query_params: {},
+        fn: processAssetPurchaseOrder,
+        path: ASSET_PURCHASE_ORDER_PATH,
+    });
+}
+
+/**
+ * Remove an asset purchase order from the database
+ * @param id ID of the asset purchase order
+ * @param query_params Query parameters to add the to request URL
+ */
+export function removeAssetPurchaseOrder(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return remove({ id, query_params, path: ASSET_PURCHASE_ORDER_PATH });
+}

package/src/assets/interfaces.ts

@@ -0,0 +1,41 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
+
+/** Mapping of available query parameters for the assets index endpoint */
+export interface PlaceAssetQueryOptions extends PlaceResourceQueryOptions {
+    /** Return assets which are in the zone provided */
+    zone_id?: string;
+    /** Return assets that match the asset type ID provided */
+    type_id?: string;
+    /** Return assets that match the purchase order ID provided */
+    order_id?: string;
+    /** Return assets that have a matching barcode */
+    barcode?: string;
+    /** Return assets that have a matching serial number */
+    serial_number?: string;
+}
+
+/** Mapping of available query parameters for the asset types index endpoint */
+export interface PlaceAssetTypeQueryOptions extends PlaceResourceQueryOptions {
+    /** Return assets with the provided brand name */
+    brand?: string;
+    /** Return assets with the provided model number */
+    model_number?: string;
+    /** Return asset types in the category provided */
+    category_id?: string;
+    /** Filters the asset count to the zone provided */
+    zone_id?: string;
+}
+
+/** Mapping of available query parameters for the asset categories index endpoint */
+export interface PlaceAssetCategoryQueryOptions extends PlaceResourceQueryOptions {
+    /**
+     * Filter categories by hidden status.
+     * `true` returns only hidden categories,
+     * `false` returns only non-hidden categories,
+     * `undefined` returns all categories.
+     */
+    hidden?: boolean;
+}
+
+/** Mapping of available query parameters for the asset purchase orders index endpoint */
+export interface PlaceAssetPurchaseOrderQueryOptions extends PlaceResourceQueryOptions {}

package/src/clusters/functions.ts

@@ -1,7 +1,16 @@
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { apiEndpoint } from '../auth/functions';
+import { get, post } from '../http/functions';
 import { query, remove, show } from '../resources/functions';
 import { HashMap } from '../utilities/types';
 import { PlaceCluster } from './cluster';
-import { PlaceClusterQueryOptions } from './interfaces';
+import {
+    PlaceClusterQueryOptions,
+    PlaceClusterShowOptions,
+    PlaceClusterTerminateOptions,
+    PlaceClusterVersions,
+} from './interfaces';
 import { PlaceProcess } from './process';
 
 /**
@@ -29,17 +38,20 @@ export function queryClusters(query_params: PlaceClusterQueryOptions = {}) {
  */
 export function showCluster(
     id: string,
-    query_params: PlaceClusterQueryOptions = {},
+    query_params: PlaceClusterShowOptions = {},
 ) {
     return show({ id, query_params, fn: process, path: PATH });
 }
 
 /**
- * Query the available process for a cluster
+ * Query the available processes for a cluster
  * @param id ID of the cluster to query
  * @param query_params Query parameters to add the to request URL
  */
-export function queryProcesses(id: string, query_params: HashMap = {}) {
+export function queryProcesses(
+    id: string,
+    query_params: PlaceClusterShowOptions = {},
+) {
     return show({
         id,
         query_params,
@@ -52,10 +64,29 @@ export function queryProcesses(id: string, query_params: HashMap = {}) {
 }
 
 /**
- * Terminal a process in a cluster
+ * Terminate a process in a cluster
  * @param id ID of the cluster associated with the process
- * @param driver Name of the process to kill
+ * @param query_params Query parameters including driver name (required)
+ */
+export function terminateProcess(
+    id: string,
+    query_params: PlaceClusterTerminateOptions,
+) {
+    return remove({ id, query_params, path: PATH });
+}
+
+/**
+ * Force the core nodes to perform a cluster rebalance
+ */
+export function clusterRebalance(): Observable<void> {
+    const url = `${apiEndpoint()}${PATH}/rebalance`;
+    return post(url, {}).pipe(map(() => undefined));
+}
+
+/**
+ * Get the core node versions
  */
-export function terminateProcess(id: string, driver: string) {
-    return remove({ id, query_params: { driver }, path: PATH });
+export function clusterVersions(): Observable<PlaceClusterVersions> {
+    const url = `${apiEndpoint()}${PATH}/versions`;
+    return get(url).pipe(map((resp: HashMap) => resp as PlaceClusterVersions));
 }

package/src/clusters/interfaces.ts

@@ -1,9 +1,27 @@
-/** Mapping of available query paramters for the application index endpoint */
+/** Mapping of available query parameters for the cluster index endpoint */
 export interface PlaceClusterQueryOptions {
-    /** Whether the cluster status details should be included */
-    include_status?: string;
+    /** Return the detailed status of the node including memory and CPU usage */
+    include_status?: boolean;
     /** Number of results to return. Defaults to `20`. Max `500` */
     limit?: number;
     /** Offset the page of results. Max `10000` */
     offset?: number;
 }
+
+/** Mapping of available query parameters for the cluster show endpoint */
+export interface PlaceClusterShowOptions {
+    /** Return the detailed status of the drivers running on the node */
+    include_status?: boolean;
+}
+
+/** Mapping of available query parameters for the cluster delete endpoint (terminate process) */
+export interface PlaceClusterTerminateOptions {
+    /** The name of the driver to terminate (required) */
+    driver: string;
+}
+
+/** Response from the cluster versions endpoint */
+export interface PlaceClusterVersions {
+    /** Map of node ID to version string */
+    [nodeId: string]: string;
+}

package/src/domains/functions.ts

@@ -1,3 +1,7 @@
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { apiEndpoint } from '../auth/functions';
+import { get } from '../http/functions';
 import { create, query, remove, show, update } from '../resources/functions';
 import { PlaceResourceQueryOptions } from '../resources/interface';
 import { HashMap } from '../utilities/types';
@@ -24,10 +28,9 @@ export function queryDomains(query_params: PlaceResourceQueryOptions = {}) {
 /**
  * Get the data for a domain
  * @param id ID of the domain to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export function showDomain(id: string, query_params: HashMap = {}) {
-    return show({ id, query_params, fn: process, path: PATH });
+export function showDomain(id: string) {
+    return show({ id, query_params: {}, fn: process, path: PATH });
 }
 
 /**
@@ -64,8 +67,16 @@ export function addDomain(form_data: Partial<PlaceDomain>) {
 /**
  * Remove a domain from the database
  * @param id ID of the domain
- * @param query_params Query parameters to add the to request URL
  */
-export function removeDomain(id: string, query_params: HashMap = {}) {
-    return remove({ id, query_params, path: PATH });
+export function removeDomain(id: string) {
+    return remove({ id, query_params: {}, path: PATH });
+}
+
+/**
+ * Find the domain name by looking into domain registered email domains
+ * @param email Email address to lookup
+ */
+export function lookupDomainByEmail(email: string): Observable<PlaceDomain> {
+    const url = `${apiEndpoint()}${PATH}/lookup/${encodeURIComponent(email)}`;
+    return get(url).pipe(map((resp: HashMap) => process(resp as Partial<PlaceDomain>)));
 }

package/src/drivers/functions.ts

@@ -6,9 +6,8 @@ import {
     task,
     update,
 } from '../resources/functions';
-import { HashMap } from '../utilities/types';
 import { PlaceDriver } from './driver';
-import { PlaceDriverQueryOptions } from './interfaces';
+import { PlaceDriverQueryOptions, PlaceDriverShowOptions } from './interfaces';
 
 /**
  * @private
@@ -33,7 +32,7 @@ export function queryDrivers(query_params: PlaceDriverQueryOptions = {}) {
  * @param id ID of the driver to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export function showDriver(id: string, query_params: HashMap = {}) {
+export function showDriver(id: string, query_params: PlaceDriverShowOptions = {}) {
     return show({ id, query_params, fn: process, path: PATH });
 }
 
@@ -71,10 +70,9 @@ export function addDriver(form_data: Partial<PlaceDriver>) {
 /**
  * Remove a driver from the database
  * @param id ID of the driver
- * @param query_params Query parameters to add the to request URL
  */
-export function removeDriver(id: string, query_params: HashMap = {}) {
-    return remove({ id, query_params, path: PATH });
+export function removeDriver(id: string) {
+    return remove({ id, query_params: {}, path: PATH });
 }
 
 /**

package/src/drivers/interfaces.ts

@@ -1,15 +1,19 @@
-/** Mapping of available query paramters for the dependencies index */
-export interface PlaceDriverQueryOptions {
-    /** Set maximum number of results to return. Defaults to `20` */
-    limit?: number;
-    /** Set number of results to skip. Defaults to `0` */
-    offset?: number;
-    /** Filter result by type of driver. One of either `ssh`, `device`, `service` or `logic` */
+import { PlaceResourceQueryOptions } from '../resources/interface';
+
+/** Mapping of available query parameters for the drivers index endpoint */
+export interface PlaceDriverQueryOptions extends PlaceResourceQueryOptions {
+    /** Filter result by type of driver */
     role?: 'ssh' | 'device' | 'service' | 'logic' | 'websocket';
     /** Only return drivers that have an update available */
     update_available?: boolean;
 }
 
+/** Mapping of available query parameters for the drivers show endpoint */
+export interface PlaceDriverShowOptions {
+    /** Check if the driver is compiled */
+    compilation_status?: boolean;
+}
+
 /** List of details that can be assigned to a new Driver */
 export interface PlaceDriverDetails {
     /** Default name for the driver */