@hexagramio/saga-ts 0.9.293-1

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2023 DBA Hexagram.io (https://hexagram.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**
+
+- [Saga Typescript SDK](#saga-typescript-sdk)
+  - [Install](#install)
+  - [Tests](#tests)
+  - [Build](#build)
+  - [Usage](#usage)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Saga Typescript SDK
+
+Typescript SDK to interface with a Saga API host. The implementation is based on the [command design pattern](https://en.wikipedia.org/wiki/Command_pattern).  
+
+Login and Add Property
+
+```js
+
+import {
+  APIError, 
+  Authentication, 
+  sendHTTPCommand} from "../src";
+
+import {
+  Lo,
+  Authentication,
+  sendHTTPCommand} from "../src/";
+
+const baseURL="https://saga-api.com";
+await authentication = await sendHTTPCommand()
+
+
+```
+

package/dist/cjs/commands/bots.d.ts

@@ -0,0 +1,75 @@
+import { HTTPCommand } from "../senders/http";
+import { SocketCommand } from "../senders/socket";
+import { CreateProperty, Id, List, ReadProperty, Tags, TestData, TimeStamp } from "../shared/types";
+export interface CreateBot extends TestData, Tags {
+    name: string;
+}
+export interface UpdateBot extends CreateBot, Id {
+}
+export interface ReadBot extends UpdateBot, TimeStamp {
+    properties: Record<string, ReadProperty>;
+}
+/**
+ * List Bots command
+ * @param search search criteria for bots
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const ListBotsCommand: (accessToken: string, search?: string) => HTTPCommand<List<ReadBot>>;
+/**
+ * Create a new bot command
+ * @param data a CreateBot Object
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare function CreateBotCommand(accessToken: string, data: CreateBot): HTTPCommand<ReadBot>;
+/**
+ * Create an array of bots command
+ * @param data a CreateBot Object array
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare function CreateBotsCommand(accessToken: string, data: CreateBot[]): HTTPCommand<ReadBot[]>;
+/**
+ * Get a bot command
+ * @param id the id of the bot
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const GetBotCommand: (accessToken: string, id: string) => HTTPCommand<ReadBot>;
+/**
+ * Update the bot command
+ * @param data the bot needing to be updated, the _id of the bot is used to select the bot
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const UpdateBotCommand: (accessToken: string, data: UpdateBot) => HTTPCommand<ReadBot>;
+/**
+ * Delete a bot command
+ * @param id the id of the bot to delete
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const DeleteBotCommand: (accessToken: string, _id: string) => HTTPCommand<{
+    ok: true;
+}>;
+/**
+ * Add a bot property command
+ * @param data the property
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const AddBotPropertyCommand: (accessToken: string, data: CreateProperty) => HTTPCommand<ReadProperty>;
+/**
+ * A command to join a bots realtime socket
+ * @param _id id of the bot
+ * @group Socket Commands
+ */
+export declare const JoinBotCommand: (_id: string) => SocketCommand;
+/**
+ * A command to leave a bots realtime socket
+ * @param _id id of the bot
+ * @group Socket Commands
+ */
+export declare const LeaveBotCommand: (_id: string) => SocketCommand;
+//# sourceMappingURL=bots.d.ts.map

package/dist/cjs/commands/bots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bots.d.ts","sourceRoot":"","sources":["../../../src/commands/bots.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAC,aAAa,EAAC,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAC,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAIlG,MAAM,WAAW,SAAU,SAAQ,QAAQ,EAAE,IAAI;IAC/C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAU,SAAQ,SAAS,EAAE,EAAE;CAC/C;AACD,MAAM,WAAW,OAAQ,SAAQ,SAAS,EAAC,SAAS;IAClD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CAC1C;AAGD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,gBAAiB,MAAM,WAAW,MAAM,KAAE,YAAa,KAAK,OAAO,CAAC,CAO/F,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAC,IAAI,EAAE,SAAS,GAAE,WAAW,CAAC,OAAO,CAAC,CAOzF;AAGD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAC,IAAI,EAAE,SAAS,EAAE,GAAE,WAAW,CAAC,OAAO,EAAE,CAAC,CAO9F;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,gBAAiB,MAAM,MAAM,MAAM,KAAE,YAAY,OAAO,CAMjF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBAAiB,MAAM,QAAQ,SAAS,KAAE,YAAY,OAAO,CAOzF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBAAiB,MAAM,OAAO,MAAM,KAAE,YAAY;IAAC,EAAE,EAAC,IAAI,CAAA;CAAC,CAMvF,CAAA;AAGD;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,gBAAiB,MAAM,QAAO,cAAc,KAAE,YAAY,YAAY,CAOvG,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,QAAQ,MAAM,KAAG,aAM3C,CAAA;AACD;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAQ,MAAM,KAAG,aAM5C,CAAA"}

package/dist/cjs/commands/bots.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeaveBotCommand = exports.JoinBotCommand = exports.AddBotPropertyCommand = exports.DeleteBotCommand = exports.UpdateBotCommand = exports.GetBotCommand = exports.CreateBotsCommand = exports.CreateBotCommand = exports.ListBotsCommand = void 0;
+/**
+ * List Bots command
+ * @param search search criteria for bots
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const ListBotsCommand = (accessToken, search) => {
+    return {
+        method: "GET",
+        path: "/bots",
+        params: search ? new URLSearchParams({ search }) : undefined,
+        accessToken
+    };
+};
+exports.ListBotsCommand = ListBotsCommand;
+/**
+ * Create a new bot command
+ * @param data a CreateBot Object
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+function CreateBotCommand(accessToken, data) {
+    return {
+        method: "POST",
+        path: "/bots",
+        data,
+        accessToken
+    };
+}
+exports.CreateBotCommand = CreateBotCommand;
+/**
+ * Create an array of bots command
+ * @param data a CreateBot Object array
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+function CreateBotsCommand(accessToken, data) {
+    return {
+        method: "POST",
+        path: "/bots",
+        data,
+        accessToken
+    };
+}
+exports.CreateBotsCommand = CreateBotsCommand;
+/**
+ * Get a bot command
+ * @param id the id of the bot
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const GetBotCommand = (accessToken, id) => {
+    return {
+        method: "GET",
+        path: `/bots/${id}`,
+        accessToken
+    };
+};
+exports.GetBotCommand = GetBotCommand;
+/**
+ * Update the bot command
+ * @param data the bot needing to be updated, the _id of the bot is used to select the bot
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const UpdateBotCommand = (accessToken, data) => {
+    return {
+        method: "PUT",
+        path: `/bots/${data._id}`,
+        data,
+        accessToken
+    };
+};
+exports.UpdateBotCommand = UpdateBotCommand;
+/**
+ * Delete a bot command
+ * @param id the id of the bot to delete
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const DeleteBotCommand = (accessToken, _id) => {
+    return {
+        method: "DELETE",
+        path: `/bots/${_id}`,
+        accessToken
+    };
+};
+exports.DeleteBotCommand = DeleteBotCommand;
+/**
+ * Add a bot property command
+ * @param data the property
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const AddBotPropertyCommand = (accessToken, data) => {
+    return {
+        method: "POST",
+        path: `/bots/${data.parent_id}/properties`,
+        data,
+        accessToken
+    };
+};
+exports.AddBotPropertyCommand = AddBotPropertyCommand;
+/**
+ * A command to join a bots realtime socket
+ * @param _id id of the bot
+ * @group Socket Commands
+ */
+const JoinBotCommand = (_id) => {
+    return {
+        method: "/bots",
+        join: true,
+        id: _id
+    };
+};
+exports.JoinBotCommand = JoinBotCommand;
+/**
+ * A command to leave a bots realtime socket
+ * @param _id id of the bot
+ * @group Socket Commands
+ */
+const LeaveBotCommand = (_id) => {
+    return {
+        method: "/bots",
+        join: false,
+        id: _id
+    };
+};
+exports.LeaveBotCommand = LeaveBotCommand;
+//# sourceMappingURL=bots.js.map

package/dist/cjs/commands/bots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bots.js","sourceRoot":"","sources":["../../../src/commands/bots.ts"],"names":[],"mappings":";;;AAkBA;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAAC,WAAmB,EAAE,MAAe,EAA8B,EAAE;IAClG,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,OAAO;QACZ,MAAM,EAAC,MAAM,CAAA,CAAC,CAAA,IAAI,eAAe,CAAC,EAAC,MAAM,EAAC,CAAC,CAAA,CAAC,CAAA,SAAS;QACrD,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAPY,QAAA,eAAe,mBAO3B;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,WAAmB,EAAC,IAAe;IAClE,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,OAAO;QACZ,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC;AAPD,4CAOC;AAGD;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,WAAmB,EAAC,IAAiB;IACrE,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,OAAO;QACZ,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC;AAPD,8CAOC;AAED;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,WAAmB,EAAE,EAAU,EAAsB,EAAE;IACnF,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,SAAS,EAAE,EAAE;QAClB,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AANY,QAAA,aAAa,iBAMzB;AAED;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,WAAmB,EAAE,IAAe,EAAsB,EAAE;IAC3F,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,SAAS,IAAI,CAAC,GAAG,EAAE;QACxB,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAPY,QAAA,gBAAgB,oBAO5B;AAED;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,WAAmB,EAAE,GAAW,EAAwB,EAAE;IACzF,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,SAAS,GAAG,EAAE;QACnB,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AANY,QAAA,gBAAgB,oBAM5B;AAGD;;;;;GAKG;AACI,MAAM,qBAAqB,GAAG,CAAC,WAAmB,EAAE,IAAmB,EAA2B,EAAE;IACzG,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,SAAS,IAAI,CAAC,SAAS,aAAa;QACzC,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAPY,QAAA,qBAAqB,yBAOjC;AAED;;;;GAIG;AACI,MAAM,cAAc,GAAG,CAAC,GAAU,EAAiB,EAAE;IAC1D,OAAO;QACL,MAAM,EAAC,OAAO;QACd,IAAI,EAAC,IAAI;QACT,EAAE,EAAC,GAAG;KACP,CAAA;AACH,CAAC,CAAA;AANY,QAAA,cAAc,kBAM1B;AACD;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAC,GAAU,EAAiB,EAAE;IAC3D,OAAO;QACL,MAAM,EAAC,OAAO;QACd,IAAI,EAAC,KAAK;QACV,EAAE,EAAC,GAAG;KACP,CAAA;AACH,CAAC,CAAA;AANY,QAAA,eAAe,mBAM3B"}

package/dist/cjs/commands/system.d.ts

@@ -0,0 +1,18 @@
+import { HTTPCommand } from "../senders/http";
+/**
+ * Command to return the current saga build version
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const GetBuildVersionCommand: (accessToken: string) => HTTPCommand<{
+    version: string;
+}>;
+/**
+ * Command to trigger a saga rebuild
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const TriggerBuildCommand: (accessToken: string) => HTTPCommand<{
+    version: string;
+}>;
+//# sourceMappingURL=system.d.ts.map

package/dist/cjs/commands/system.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.d.ts","sourceRoot":"","sources":["../../../src/commands/system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAG5C;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAAiB,MAAM,KAAE,YAAa;IAAC,OAAO,EAAC,MAAM,CAAA;CAAC,CAMxF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,gBAAiB,MAAM,KAAE,YAAa;IAAC,OAAO,EAAC,MAAM,CAAA;CAAC,CAMrF,CAAA"}

package/dist/cjs/commands/system.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TriggerBuildCommand = exports.GetBuildVersionCommand = void 0;
+/**
+ * Command to return the current saga build version
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const GetBuildVersionCommand = (accessToken) => {
+    return {
+        method: "GET",
+        path: "/build",
+        accessToken
+    };
+};
+exports.GetBuildVersionCommand = GetBuildVersionCommand;
+/**
+ * Command to trigger a saga rebuild
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const TriggerBuildCommand = (accessToken) => {
+    return {
+        method: "GET",
+        path: "/build",
+        accessToken
+    };
+};
+exports.TriggerBuildCommand = TriggerBuildCommand;
+//# sourceMappingURL=system.js.map

package/dist/cjs/commands/system.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.js","sourceRoot":"","sources":["../../../src/commands/system.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,CAAC,WAAmB,EAAgC,EAAE;IAC1F,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,QAAQ;QACb,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AANY,QAAA,sBAAsB,0BAMlC;AAED;;;;GAIG;AACI,MAAM,mBAAmB,GAAG,CAAC,WAAmB,EAAgC,EAAE;IACvF,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,QAAQ;QACb,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AANY,QAAA,mBAAmB,uBAM/B"}

package/dist/cjs/commands/test_data.d.ts

@@ -0,0 +1,10 @@
+import { HTTPCommand } from "../senders/http";
+/**
+ * Command to remove all data flagged with test_data from the saga
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const DeleteTestDataCommand: (accessToken: string) => HTTPCommand<{
+    ok: 1;
+}>;
+//# sourceMappingURL=test_data.d.ts.map

package/dist/cjs/commands/test_data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test_data.d.ts","sourceRoot":"","sources":["../../../src/commands/test_data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,gBAAiB,MAAM,KAAE,YAAa;IAAC,EAAE,EAAC,CAAC,CAAA;CAAC,CAM7E,CAAA"}

package/dist/cjs/commands/test_data.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteTestDataCommand = void 0;
+/**
+ * Command to remove all data flagged with test_data from the saga
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const DeleteTestDataCommand = (accessToken) => {
+    return {
+        method: "DELETE",
+        path: "/test",
+        accessToken
+    };
+};
+exports.DeleteTestDataCommand = DeleteTestDataCommand;
+//# sourceMappingURL=test_data.js.map

package/dist/cjs/commands/test_data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test_data.js","sourceRoot":"","sources":["../../../src/commands/test_data.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CAAC,WAAmB,EAAuB,EAAE;IAChF,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,OAAO;QACZ,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AANY,QAAA,qBAAqB,yBAMjC"}

package/dist/cjs/commands/user.d.ts

@@ -0,0 +1,151 @@
+/**
+ * Lit of user messages and functions to generate user commands
+ * @packageDocumentation
+ */
+import { HTTPCommand } from "../senders/http";
+import { SocketCommand } from "../senders/socket";
+import { CreateProperty, Id, List, ReadProperty, Tags, TestData, TimeStamp } from "../shared/types";
+/**
+ * used to update basic user
+ * @group User Types
+ */
+export interface UpdateUser extends Id {
+    username?: string;
+    tags?: [string];
+    email?: string;
+    displayname?: string;
+}
+/**
+ *
+ * @group User Types
+ */
+export interface ReadUser extends TimeStamp, Id, TestData, Tags {
+    username: string;
+    properties: Record<string, ReadProperty>;
+    tags?: [string];
+}
+/**
+ * Basic User Creation Message
+ * @group User Types
+ */
+export interface BasicUser extends Tags {
+    prefix?: "";
+}
+/**
+ * Register User Message
+ * @group User Types
+ */
+export interface RegisterUser extends Tags {
+    username: string;
+    password: string;
+    email?: string;
+    displayname?: string;
+}
+/**
+ * Login User Message
+ * @group User Types
+ */
+export interface LoginUser extends Tags {
+    username: string;
+    password: string;
+}
+/**
+ * Creates a command to get the user associated with the given accessToken
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const WhoAmICommand: (accessToken: string) => HTTPCommand<ReadUser>;
+/**
+ * Encapsulates authentication tokens. An authentication object is returned i.e. from {@link LoginUserCommand} It's required for most HTTP Commands.
+ */
+export interface Authentication {
+    /**
+     * Required access token
+     */
+    accessToken: string;
+    /**
+     * Used to retrieve a new access token using {@link RefreshTokenCommand}
+     */
+    refreshToken: string;
+}
+/**
+ * Command to login a user
+ * @param username string
+ * @param password string
+ * @group HTTP Commands
+ */
+export declare const LoginUserCommand: (data: LoginUser) => HTTPCommand<ReadUser & Authentication>;
+/**
+ * Create command to register a user
+ * @param username string
+ * @param password string
+ * @group HTTP Commands
+ */
+export declare const RegisterUserCommand: (data: RegisterUser) => HTTPCommand<ReadUser & Authentication>;
+/**
+ * Command to create a generated user
+ * @param basicUser an optional model
+ * @group HTTP Commands
+ */
+export declare const CreateGenerateBasicUserCommand: (data?: BasicUser) => HTTPCommand<ReadUser>;
+/**
+ * Command to create a test user
+ * @param basicUser an optional model
+ * @group HTTP Commands
+ */
+export declare const CreateTestUserCommand: (username?: string) => HTTPCommand<ReadUser>;
+/**
+ * List Users command
+ * @param search search criteria for ysers
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const ListUsersCommand: (accessToken: string, search?: string) => HTTPCommand<List<ReadUser>>;
+/**
+ * Get a user command
+ * @param id the id of the user
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const GetUserCommand: (accessToken: string, id: string) => HTTPCommand<ReadUser>;
+/**
+ * Refresh token command
+ * @param id the id of the user
+ * @param refreshToken the refresh token
+  * @group HTTP Commands
+ */
+export declare const RefreshTokenCommand: (refreshToken: string, id: string) => HTTPCommand<Authentication>;
+/**
+ * Delete a user command
+ * @param id the id of the user
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const GetDeleteCommand: (accessToken: string, id: string) => HTTPCommand<ReadUser>;
+/**
+ * Update the user command
+ * @param data the user needing to be updated, the _id of the user is used to select the user
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const UpdateUserCommand: (accessToken: string, data: UpdateUser) => HTTPCommand<ReadUser>;
+/**
+ * Add a bot property command
+ * @param data the property
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const AddUserPropertyCommand: (accessToken: string, data: CreateProperty) => HTTPCommand<ReadProperty>;
+/**
+ * A command to join a users realtime socket
+ * @param _id the id of the user
+ * @group Socket Commands
+ */
+export declare const JoinUserCommand: (_id: string) => SocketCommand;
+/**
+ * A command to leave a users realtime socket
+ * @param _id the id of the user
+ * @group Socket Commands
+ */
+export declare const LeaveUserCommand: (_id: string) => SocketCommand;
+//# sourceMappingURL=user.d.ts.map

package/dist/cjs/commands/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/commands/user.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAC,aAAa,EAAC,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAC,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAElG;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,EAAE;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACzC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,IAAI;IACrC,MAAM,CAAC,EAAC,EAAE,CAAA;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,IAAI;IAExC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,IAAI;IAErC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAGD;;;;GAIG;AACH,eAAO,MAAM,aAAa,gBAAgB,MAAM,KAAE,YAAY,QAAQ,CAMrE,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,SAAU,SAAS,KAAE,YAAa,QAAQ,GAAG,cAAc,CAMvF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,SAAU,YAAY,KAAE,YAAa,QAAQ,GAAG,cAAc,CAM7F,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,UAAS,SAAS,KAAK,YAAY,QAAQ,CAMrF,CAAA;AACD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,cAAc,MAAM,KAAE,YAAY,QAAQ,CAQ3E,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBAAiB,MAAM,WAAU,MAAM,KAAE,YAAa,KAAK,QAAQ,CAAC,CAOhG,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,gBAAiB,MAAM,MAAK,MAAM,KAAE,YAAY,QAAQ,CAMlF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,iBAAkB,MAAM,MAAM,MAAM,KAAE,YAAY,cAAc,CAM/F,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBAAiB,MAAM,MAAK,MAAM,KAAE,YAAY,QAAQ,CAMpF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,gBAAiB,MAAM,QAAO,UAAU,KAAE,YAAY,QAAQ,CAO3F,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,gBAAiB,MAAM,QAAM,cAAc,KAAE,YAAY,YAAY,CAOvG,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAQ,MAAM,KAAG,aAM5C,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAAQ,MAAM,KAAG,aAM7C,CAAA"}