@ptkl/sdk 0.2.1 → 0.2.2

package/dist/types/api/apiUser.d.ts

@@ -1,6 +1,6 @@
-import BaseClient from "./baseClient";
-export default class APIUser extends BaseClient {
-    apiAuth(username: string, password: string): Promise<import("axios").AxiosResponse<any, any>>;
+import PlatformBaseClient from "./platformBaseClient";
+export default class APIUser extends PlatformBaseClient {
+    auth(username: string, password: string, project: string): Promise<import("axios").AxiosResponse<any, any>>;
     newSecret(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
     revokeSecret(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
     edit(uuid: string, roles: string[]): Promise<import("axios").AxiosResponse<any, any>>;

package/dist/types/api/apps.d.ts

@@ -1,7 +1,7 @@
-import BaseClient from "./baseClient";
-export default class Apps extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class Apps extends PlatformBaseClient {
     private appType;
-    constructor(client: any, appType?: string);
+    constructor(appType?: string);
     updateSettings(updateValues: any, ref: string): Promise<any>;
     download(ref: string, version: string): Promise<any>;
     upload(formData: FormData): Promise<any>;

package/dist/types/api/baseClient.d.ts

@@ -2,4 +2,5 @@ import { AxiosInstance } from "axios";
 export default class BaseClient {
     client: AxiosInstance;
     constructor(client: AxiosInstance);
+    setClient(client: AxiosInstance): this;
 }

package/dist/types/api/component.d.ts

@@ -1,10 +1,8 @@
-import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model } from "src/types/component";
-import BaseClient from "./baseClient";
-import { AxiosInstance } from "axios";
-export default class Component extends BaseClient {
+import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions } from "src/types/component";
+import PlatformBaseClient from "./platformBaseClient";
+export default class Component extends PlatformBaseClient {
     private ref;
-    constructor(adapter: AxiosInstance, ref: string);
-    new(ref: string): this;
+    constructor(ref?: string | null);
     /**
      * Find method to search for models
      *
@@ -55,17 +53,31 @@ export default class Component extends BaseClient {
      * @param data
      * @returns
      */
-    update(uuid: string, data: Record<string, any>): Promise<unknown>;
-    concurrentUpdate(uuid: string, version: number, data: Record<string, any>): Promise<unknown>;
-    create(model: Record<string, any>): Promise<unknown>;
-    delete(uuid: string): Promise<unknown>;
-    aggregate(pipeline: FindAggregateParams): Promise<unknown>;
-    settings(): Promise<unknown>;
-    saveSettings(settings: any): Promise<unknown>;
+    update(uuid: string, data: Record<string, any>, options: UpdateOptions): Promise<any>;
+    /**
+     * Update many models
+     *
+     * @param data
+     * @param options
+     * @returns
+     */
+    updateMany(data: Record<string, any>[], options: UpdateOptions): Promise<any>;
+    /**
+     * Concurrent update model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @param version number - The version of the model
+     * @param data
+     * @returns
+     */
+    concurrentUpdate(uuid: string, version: number, data: Record<string, any>, options: UpdateOptions): Promise<any>;
+    create(model: Record<string, any>): Promise<any>;
+    delete(uuid: string): Promise<any>;
+    aggregate(pipeline: FindAggregateParams): Promise<any>;
+    settings(): Promise<any>;
+    saveSettings(settings: any, version: string): Promise<any>;
     saveTemplatesDist(version: string, sdkVersion: string, engine: string, dist: Record<string, string>): Promise<any>;
-    workflow(event: string, input: any): Promise<import("axios").AxiosResponse<any, any>>;
-    function(name: string, input: any): Promise<import("axios").AxiosResponse<any, any>>;
-    all(): Promise<any>;
-    setup(data: any): Promise<import("axios").AxiosResponse<any, any>>;
+    workflow(event: string, input: any): Promise<any>;
+    function(name: string, input: any): Promise<any>;
 }
-export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model };
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, };

package/dist/types/api/componentUtils.d.ts

@@ -0,0 +1,5 @@
+import PlatformBaseClient from "./platformBaseClient";
+export default class ComponentUtils extends PlatformBaseClient {
+    list(): Promise<any>;
+    create(data: any): Promise<any>;
+}

package/dist/types/api/forge.d.ts

@@ -1,6 +1,5 @@
-import BaseClient from "./baseClient";
-export default class Forge extends BaseClient {
-    constructor(client: any);
+import PlatformBaseClient from "./platformBaseClient";
+export default class Forge extends PlatformBaseClient {
     bundleUpload(buffer: Buffer): Promise<any>;
     getWorkspaceApps(): Promise<any>;
 }

package/dist/types/api/functions.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "./baseClient";
-export default class Functions extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class Functions extends PlatformBaseClient {
     list(): Promise<any>;
     get(ref: string): Promise<any>;
     update(uuid: string, update: any): Promise<any>;

package/dist/types/api/integrations/invoicing.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "../baseClient";
-export default class Invoicing extends BaseClient {
+import PlatformBaseClient from "../platformBaseClient";
+export default class Invoicing extends PlatformBaseClient {
     getSalesInvoices(provider: string, page: number): Promise<import("axios").AxiosResponse<any, any>>;
     acceptPurchaseInvoice(provider: string, id: string, comment: string): Promise<import("axios").AxiosResponse<any, any>>;
     request(method: string, endpoint: string, params: any): Promise<import("axios").AxiosResponse<any, any>>;

package/dist/types/api/integrations/media.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "../baseClient";
-export default class Media extends BaseClient {
+import IntegrationsBaseClient from "../integrationsBaseClient";
+export default class Media extends IntegrationsBaseClient {
     list(data: any): Promise<import("axios").AxiosResponse<any, any>>;
     libraries(): Promise<import("axios").AxiosResponse<any, any>>;
     upload(payload: any): Promise<import("axios").AxiosResponse<any, any> | undefined>;

package/dist/types/api/integrations/serbiaUtil.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "../baseClient";
-export default class SerbiaUtil extends BaseClient {
+import IntegrationsBaseClient from "../integrationsBaseClient";
+export default class SerbiaUtil extends IntegrationsBaseClient {
     nsbSearch(params: any): Promise<import("axios").AxiosResponse<any, any>>;
     getReceiptFromUrl(url: string, source: string): Promise<import("axios").AxiosResponse<any, any>>;
     getContoList(): Promise<import("axios").AxiosResponse<any, any>>;

package/dist/types/api/integrations/vpfr.d.ts

@@ -1,4 +1,4 @@
-import BaseClient from "../baseClient";
-export default class VPFR extends BaseClient {
+import IntegrationsBaseClient from "../integrationsBaseClient";
+export default class VPFR extends IntegrationsBaseClient {
     request(method: string, endpoint: string, params?: any): Promise<import("axios").AxiosResponse<any, any>>;
 }

package/dist/types/api/integrations.d.ts

@@ -1,8 +1,11 @@
-import BaseClient from "./baseClient";
-import { AxiosInstance } from "axios";
-export default class Integrations extends BaseClient {
+import IntegrationsBaseClient from "./integrationsBaseClient";
+export default class Integrations extends IntegrationsBaseClient {
     private integrations;
-    constructor(adapter: AxiosInstance);
+    constructor(options?: {
+        env?: string;
+        token?: string;
+        host?: string;
+    });
     getSerbiaUtilities(): any;
     getMedia(): any;
     getVPFR(): any;

package/dist/types/api/integrationsBaseClient.d.ts

@@ -0,0 +1,8 @@
+import BaseClient from "./baseClient";
+export default class IntegrationsBaseClient extends BaseClient {
+    constructor(options?: {
+        env?: string;
+        token?: string;
+        host?: string;
+    });
+}

package/dist/types/api/platform.d.ts

@@ -5,22 +5,14 @@ import APIUser from "./apiUser";
 import Users from "./users";
 import Apps from "./apps";
 import Component from "./component";
-import Integration from "./integrations";
+import ComponentUtils from "./componentUtils";
 import Ratchet from "./ratchet";
 import Sandbox from "./sandbox";
 import System from "./system";
 import Workflow from "./workflow";
 import Forge from "./forge";
-export default class Platform {
-    private platformClient;
-    private integrationsClient;
-    constructor(options: {
-        env?: string;
-        token?: string;
-        host?: string;
-        integrationHost?: string;
-    });
-    setPlatformClient(client: AxiosInstance): void;
+import PlatformBaseClient from "./platformBaseClient";
+export default class Platform extends PlatformBaseClient {
     getPlatformClient(): AxiosInstance;
     getPlatformBaseURL(): string;
     apiUser(): APIUser;
@@ -30,7 +22,7 @@ export default class Platform {
     app(appType: string): Apps;
     forge(): Forge;
     component(ref: string): Component;
-    integrations(): Integration;
+    componentUtils(): ComponentUtils;
     ratchet(): Ratchet;
     sandbox(): Sandbox;
     system(): System;

package/dist/types/api/platformBaseClient.d.ts

@@ -0,0 +1,27 @@
+import BaseClient from "./baseClient";
+/**
+ * Base client for the platform API
+ * Classes that extend PlatformBaseClient have intentins of only working in platform context
+ *
+ *
+ * @class PlatformBaseClient
+ * @extends BaseClient
+ * @constructor
+ * @param {AxiosInstance} [client] - The axios instance to use for the client
+ *
+ * @example
+ * // if sdk is used in the forge app that is running in the platform context
+ * const utils = new ComponentUtils()
+ * // this won't work outside of platform context because client needs authtorization to communicate with the API.
+ *
+ */
+export default class PlatformBaseClient extends BaseClient {
+    protected env: string | null;
+    protected token: string | null;
+    protected host: string | null;
+    constructor(options?: {
+        env?: string;
+        token?: string;
+        host?: string;
+    });
+}

package/dist/types/api/ratchet.d.ts

@@ -1,4 +1,4 @@
-import BaseClient from "./baseClient";
-export default class Ratchet extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class Ratchet extends PlatformBaseClient {
     query(name: string, params: any): Promise<any>;
 }

package/dist/types/api/roles.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "./baseClient";
-export default class Roles extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class Roles extends PlatformBaseClient {
     create(role: any): Promise<any>;
     delete(uuid: string): Promise<any>;
     list(): Promise<any>;

package/dist/types/api/sandbox.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "./baseClient";
-export default class Sandbox extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class Sandbox extends PlatformBaseClient {
     /**
      * Call the sandbox service to execute a serverless function
      *

package/dist/types/api/system.d.ts

@@ -1,4 +1,4 @@
-import BaseClient from "./baseClient";
-export default class System extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class System extends PlatformBaseClient {
     resourceResolver(ref: string, resourceName: string, format?: string): Promise<any>;
 }

package/dist/types/api/thunder.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "./baseClient";
-export default class Thunder extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class Thunder extends PlatformBaseClient {
     read(type: string, filters: any, flag: string, options?: any): Promise<any>;
     write(type: string, filters: any, d: any, flag: any): Promise<any>;
     operation(name: string, filters: any, data: any): Promise<any>;

package/dist/types/api/users.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "./baseClient";
-export default class Users extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class Users extends PlatformBaseClient {
     invite(email: string, roles: string[]): Promise<import("axios").AxiosResponse<any, any>>;
     delete(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
 }

package/dist/types/api/workflow.d.ts

@@ -1,4 +1,4 @@
-import BaseClient from "./baseClient";
-export default class Workflow extends BaseClient {
+import PlatformBaseClient from "./platformBaseClient";
+export default class Workflow extends PlatformBaseClient {
     trigger(id: string, event: string, data: any): Promise<import("axios").AxiosResponse<any, any>>;
 }

package/dist/types/index.d.ts

@@ -1,13 +1,14 @@
 import Platform from './api/platform';
-export * as Component from './api/component';
-export * as Integration from './api/integrations';
-export * as Ratchet from './api/ratchet';
-export * as Sandbox from './api/sandbox';
-export * as System from './api/system';
-export * as Users from './api/users';
-export * as Functions from './api/functions';
-export * as APIUser from './api/apiUser';
-export * as Roles from './api/roles';
-export * as Apps from './api/apps';
-export * as Workflow from './api/workflow';
+export { default as Component } from './api/component';
+export { default as Integration } from './api/integrations';
+export { default as Ratchet } from './api/ratchet';
+export { default as Sandbox } from './api/sandbox';
+export { default as System } from './api/system';
+export { default as Users } from './api/users';
+export { default as Functions } from './api/functions';
+export { default as APIUser } from './api/apiUser';
+export { default as Roles } from './api/roles';
+export { default as Apps } from './api/apps';
+export { default as Workflow } from './api/workflow';
+export { default as ComponentUtils } from './api/componentUtils';
 export default Platform;

package/dist/types/types/component.d.ts

@@ -41,4 +41,7 @@ type Model = {
     deleted_by: string;
     [key: string]: any;
 };
-export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, };
+type UpdateOptions = {
+    force_update_protected_fields: boolean;
+};
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptkl/sdk",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "scripts": {
     "build": "rollup -c",
     "docs": "typedoc"