@hexagramio/saga-ts 0.9.293

package/dist/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,EAAE,aAAa,EAAC,MAAM,UAAU,CAAC;AACpD,OAAO,EAAC,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAC,MAAM,qBAAqB,CAAC;AAGtG,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/commands/bots.js

@@ -0,0 +1,121 @@
+/**
+ * List Bots command
+ * @param search search criteria for bots
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const ListBotsCommand = (accessToken, search) => {
+    return {
+        method: "GET",
+        path: "/bots",
+        params: search ? new URLSearchParams({ search }) : undefined,
+        accessToken
+    };
+};
+/**
+ * Create a new bot command
+ * @param data a CreateBot Object
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export function CreateBotCommand(accessToken, data) {
+    return {
+        method: "POST",
+        path: "/bots",
+        data,
+        accessToken
+    };
+}
+/**
+ * Create an array of bots command
+ * @param data a CreateBot Object array
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export function CreateBotsCommand(accessToken, data) {
+    return {
+        method: "POST",
+        path: "/bots",
+        data,
+        accessToken
+    };
+}
+/**
+ * Get a bot command
+ * @param id the id of the bot
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const GetBotCommand = (accessToken, id) => {
+    return {
+        method: "GET",
+        path: `/bots/${id}`,
+        accessToken
+    };
+};
+/**
+ * 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 const UpdateBotCommand = (accessToken, data) => {
+    return {
+        method: "PUT",
+        path: `/bots/${data._id}`,
+        data,
+        accessToken
+    };
+};
+/**
+ * Delete a bot command
+ * @param id the id of the bot to delete
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const DeleteBotCommand = (accessToken, _id) => {
+    return {
+        method: "DELETE",
+        path: `/bots/${_id}`,
+        accessToken
+    };
+};
+/**
+ * Add a bot property command
+ * @param data the property
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const AddBotPropertyCommand = (accessToken, data) => {
+    return {
+        method: "POST",
+        path: `/bots/${data.parent_id}/properties`,
+        data,
+        accessToken
+    };
+};
+/**
+ * A command to join a bots realtime socket
+ * @param _id id of the bot
+ * @group Socket Commands
+ */
+export const JoinBotCommand = (_id) => {
+    return {
+        method: "/bots",
+        join: true,
+        id: _id
+    };
+};
+/**
+ * A command to leave a bots realtime socket
+ * @param _id id of the bot
+ * @group Socket Commands
+ */
+export const LeaveBotCommand = (_id) => {
+    return {
+        method: "/bots",
+        join: false,
+        id: _id
+    };
+};
+//# sourceMappingURL=bots.js.map

package/dist/commands/bots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bots.js","sourceRoot":"","sources":["../../src/commands/bots.ts"],"names":[],"mappings":"AAeA;;;;;GAKG;AACH,MAAM,CAAC,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;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,WAAmB,EAAC,IAAe;IAClE,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,OAAO;QACZ,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC;AAGD;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAmB,EAAC,IAAiB;IACrE,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,OAAO;QACZ,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,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;AAED;;;;;GAKG;AACH,MAAM,CAAC,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;AAED;;;;;GAKG;AACH,MAAM,CAAC,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;AAGD;;;;;GAKG;AACH,MAAM,CAAC,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;AAED;;;;GAIG;AACH,MAAM,CAAC,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;AACD;;;;GAIG;AACH,MAAM,CAAC,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"}

package/dist/commands/system.d.ts

@@ -0,0 +1,18 @@
+import { HTTPCommand } from "../index";
+/**
+ * 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/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,UAAU,CAAC;AAGrC;;;;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/commands/system.js

@@ -0,0 +1,25 @@
+/**
+ * Command to return the current saga build version
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const GetBuildVersionCommand = (accessToken) => {
+    return {
+        method: "GET",
+        path: "/build",
+        accessToken
+    };
+};
+/**
+ * Command to trigger a saga rebuild
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const TriggerBuildCommand = (accessToken) => {
+    return {
+        method: "GET",
+        path: "/build",
+        accessToken
+    };
+};
+//# sourceMappingURL=system.js.map

package/dist/commands/system.js.map

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

package/dist/commands/test_data.d.ts

@@ -0,0 +1,10 @@
+import { HTTPCommand } from "../index";
+/**
+ * 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/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,UAAU,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,gBAAiB,MAAM,KAAE,YAAa;IAAC,EAAE,EAAC,CAAC,CAAA;CAAC,CAM7E,CAAA"}

package/dist/commands/test_data.js

@@ -0,0 +1,13 @@
+/**
+ * Command to remove all data flagged with test_data from the saga
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const DeleteTestDataCommand = (accessToken) => {
+    return {
+        method: "DELETE",
+        path: "/test",
+        accessToken
+    };
+};
+//# sourceMappingURL=test_data.js.map

package/dist/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;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,WAAmB,EAAuB,EAAE;IAChF,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,OAAO;QACZ,WAAW;KACZ,CAAA;AACH,CAAC,CAAA"}

package/dist/commands/user.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Lit of user messages and functions to generate user commands
+ * @packageDocumentation
+ */
+import { Authentication, HTTPCommand, SocketCommand } from "../index";
+import { CreateProperty, Id, List, ReadProperty, Tags, TestData, TimeStamp } from "../lib/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>;
+/**
+ * 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/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,EACL,cAAc,EACd,WAAW,EACX,aAAa,EACd,MAAM,UAAU,CAAC;AAClB,OAAO,EAAC,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAC,MAAM,qBAAqB,CAAC;AAEtG;;;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;;;;;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"}

package/dist/commands/user.js

@@ -0,0 +1,170 @@
+/**
+ * Creates a command to get the user associated with the given accessToken
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const WhoAmICommand = (accessToken) => {
+    return {
+        method: "GET",
+        path: "/users/whoami",
+        accessToken
+    };
+};
+/**
+ * Command to login a user
+ * @param username string
+ * @param password string
+ * @group HTTP Commands
+ */
+export const LoginUserCommand = (data) => {
+    return {
+        method: "POST",
+        path: "/users/login",
+        data
+    };
+};
+/**
+ * Create command to register a user
+ * @param username string
+ * @param password string
+ * @group HTTP Commands
+ */
+export const RegisterUserCommand = (data) => {
+    return {
+        method: "POST",
+        path: "/users",
+        data
+    };
+};
+/**
+ * Command to create a generated user
+ * @param basicUser an optional model
+ * @group HTTP Commands
+ */
+export const CreateGenerateBasicUserCommand = (data = {}) => {
+    return {
+        method: "POST",
+        path: "/users/generate/basic",
+        data
+    };
+};
+/**
+ * Command to create a test user
+ * @param basicUser an optional model
+ * @group HTTP Commands
+ */
+export const CreateTestUserCommand = (username) => {
+    return {
+        method: "POST",
+        path: "/users/generate/test",
+        data: {
+            username
+        }
+    };
+};
+/**
+ * List Users command
+ * @param search search criteria for ysers
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const ListUsersCommand = (accessToken, search) => {
+    return {
+        method: "GET",
+        path: "/users",
+        params: search ? new URLSearchParams({ search }) : undefined,
+        accessToken
+    };
+};
+/**
+ * Get a user command
+ * @param id the id of the user
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const GetUserCommand = (accessToken, id) => {
+    return {
+        method: "GET",
+        path: `/users/${id}`,
+        accessToken
+    };
+};
+/**
+ * Refresh token command
+ * @param id the id of the user
+ * @param refreshToken the refresh token
+  * @group HTTP Commands
+ */
+export const RefreshTokenCommand = (refreshToken, id) => {
+    return {
+        method: "POST",
+        path: `/users/${id}/refresh_token`,
+        data: { refreshToken }
+    };
+};
+/**
+ * Delete a user command
+ * @param id the id of the user
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const GetDeleteCommand = (accessToken, id) => {
+    return {
+        method: "DELETE",
+        path: `/users/${id}`,
+        accessToken
+    };
+};
+/**
+ * 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 const UpdateUserCommand = (accessToken, data) => {
+    return {
+        method: "PUT",
+        path: `/users/${data._id}`,
+        data,
+        accessToken
+    };
+};
+/**
+ * Add a bot property command
+ * @param data the property
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export const AddUserPropertyCommand = (accessToken, data) => {
+    return {
+        method: "POST",
+        path: `/users/${data.parent_id}/properties`,
+        data,
+        accessToken
+    };
+};
+/**
+ * A command to join a users realtime socket
+ * @param _id the id of the user
+ * @group Socket Commands
+ */
+export const JoinUserCommand = (_id) => {
+    return {
+        method: "/users",
+        join: true,
+        id: _id
+    };
+};
+/**
+ * A command to leave a users realtime socket
+ * @param _id the id of the user
+ * @group Socket Commands
+ */
+export const LeaveUserCommand = (_id) => {
+    return {
+        method: "/users",
+        join: false,
+        id: _id
+    };
+};
+//# sourceMappingURL=user.js.map

package/dist/commands/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/commands/user.ts"],"names":[],"mappings":"AA8DA;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAE,CAAC,WAAmB,EAAwB,EAAE;IACxE,OAAO;QACL,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,eAAe;QACrB,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAe,EAA0C,EAAE;IAC1F,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,cAAc;QACpB,IAAI;KACL,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAkB,EAA0C,EAAE;IAChG,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,QAAQ;QACd,IAAI;KACL,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,OAAe,EAAE,EAAuB,EAAE;IACvF,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,uBAAuB;QAC7B,IAAI;KACL,CAAA;AACH,CAAC,CAAA;AACD;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAuB,EAAE;IAC7E,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE;YACJ,QAAQ;SACT;KACF,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,WAAmB,EAAC,MAAe,EAA+B,EAAE;IACnG,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,QAAQ;QACb,MAAM,EAAC,MAAM,CAAA,CAAC,CAAA,IAAI,eAAe,CAAC,EAAC,MAAM,EAAC,CAAC,CAAA,CAAC,CAAA,SAAS;QACrD,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,WAAmB,EAAC,EAAU,EAAuB,EAAE;IACpF,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,UAAU,EAAE,EAAE;QACnB,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,YAAoB,EAAE,EAAU,EAA6B,EAAE;IACjG,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,UAAU,EAAE,gBAAgB;QACjC,IAAI,EAAC,EAAC,YAAY,EAAC;KACpB,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,WAAmB,EAAC,EAAU,EAAuB,EAAE;IACtF,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,UAAU,EAAE,EAAE;QACnB,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,WAAmB,EAAC,IAAgB,EAAuB,EAAE;IAC7F,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,UAAU,IAAI,CAAC,GAAG,EAAE;QACzB,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,WAAmB,EAAC,IAAmB,EAA2B,EAAE;IACzG,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,UAAU,IAAI,CAAC,SAAS,aAAa;QAC1C,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAU,EAAiB,EAAE;IAC3D,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,IAAI;QACT,EAAE,EAAC,GAAG;KACP,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAU,EAAiB,EAAE;IAC5D,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,KAAK;QACV,EAAE,EAAC,GAAG;KACP,CAAA;AACH,CAAC,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Central Module that contains the methods to issue
+ * HTTPCommands and SocketCommands to a SAGA host
+ * @packageDocumentation
+ */
+/// <reference types="node" />
+import { URLSearchParams } from "url";
+import { ReadMessage, ReadProperty } from "./lib/shared_types";
+/**
+ * The APIError is thrown when a HTTPCommand or SocketCommands fails to execute
+ */
+export declare class APIError extends Error {
+    /**
+     * a saga status code as explained in the actual saga documentation,
+     * very much aligned to HTTP Status codes
+     */
+    statusCode: number;
+    /**
+     * The path of the HTTPCommand or SocketCommand that caused the error
+     */
+    path?: string;
+    /**
+     * Details on what field were not permitted
+     */
+    errors?: Record<string, string>;
+    /**
+     * Create a
+     * @param message the error message
+     * @param statusCode a saga status code as explained in the actual saga documentation, very much aligned to HTTP Status codes
+     * @param errors list of field names and the reason why the field wasn't permitted
+     * @param path The path of the HTTPCommand or SocketCommand that caused the error
+     */
+    constructor(message: string, statusCode: number, errors?: Record<string, string>, path?: string);
+}
+/**
+ * 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;
+}
+/**
+ * Interface to represent the various mutations of a HTTP Command profile.
+ */
+export interface HTTPCommand<T> {
+    method: "GET" | "PUT" | "POST" | "DELETE";
+    path: string;
+    params?: URLSearchParams;
+    data?: any;
+    accessToken?: string;
+}
+/**
+ * Send the HTTP Command to the host with the given baseURL
+ * @param baseURL the baseURL of the HTTP Api, i.e 'https://example.api.hexagram.io'
+ * @param command the actual command to send
+ * @return a promise containing the response from the command
+ * @throws an APIError if the operations fails
+ */
+export declare const sendHTTPCommand: <T>(baseURL: URL, command: HTTPCommand<T>) => Promise<T>;
+/**
+ * The events a socket session can receive.
+ */
+export interface EventMap {
+    "/properties": ReadProperty;
+    "/messages": ReadMessage;
+    "authenticated": any;
+}
+/**
+ * A socket join command
+ */
+export interface SocketJoinCommand {
+    method: "/users" | "/bots" | "/globals" | "/jobs/runnable_calls" | "/jobs/versions" | "/scripts/runnable_calls" | "/scripts/versions" | "/system" | "/npm_packages";
+    id: string;
+    join: boolean;
+}
+/**
+ * The discriminating union type of socket commands,
+ * for it just contains the join commands, but the
+ * intent is to hold other socket commands as well
+ */
+export type SocketCommand = SocketJoinCommand;
+/**
+ * Class that wraps saga socket connection logic and manages realtime saga socket events. The
+ */
+export declare class SocketSession {
+    private socket;
+    private readonly maxRetries;
+    private commandStack;
+    private ready;
+    /**
+     * Set connection parameters.
+     * @param host the host to connect to
+     * @param accessToken the access token to authenticate
+     * @param errorNotify callback function that will be called when errors occur
+     */
+    constructor(host: URL, accessToken: string, errorNotify: (error: APIError) => any, options?: {
+        delayAuthentication?: number;
+        triggerDisconnectAndConnect?: number;
+    });
+    private emitStackedCommands;
+    on<E extends keyof EventMap>(type: E, listener: (ev: EventMap[E]) => undefined): void;
+    off<E extends keyof EventMap>(type: E, listener?: (ev: EventMap[E]) => undefined): void;
+    /**
+     * Send commands to the server
+     * @param command
+     * @throws APIError if error ack is send back from server
+     */
+    emitCommand(command: SocketCommand): Promise<unknown>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;AAIH,OAAO,EAAC,eAAe,EAAC,MAAM,KAAK,CAAC;AACpC,OAAO,EAAC,WAAW,EAAE,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAQ7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IAEH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE/B;;;;;;OAMG;gBACS,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM;CAM/F;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,MAAM,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,IAAI,CAAC,EAAE,GAAG,CAAE;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAGD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,eAAsB,GAAG,wCAwCpD,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,aAAa,EAAE,YAAY,CAAC;IAC5B,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,GAAG,CAAC;CAEtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,GACrC,sBAAsB,GAAG,gBAAgB,GACzC,yBAAyB,GAAG,mBAAmB,GAC/C,SAAS,GAAG,eAAe,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;AAG9C;;GAEG;AACH,qBAAa,aAAa;IAExB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAO;IAClC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,KAAK,CAAS;IAEtB;;;;;OAKG;gBAED,IAAI,EAAE,GAAG,EACT,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,GAAG,EACrC,OAAO,CAAC,EAAC;QAAC,mBAAmB,CAAC,EAAC,MAAM,CAAC;QAAA,2BAA2B,CAAC,EAAC,MAAM,CAAA;KAAC;IAyD7E,OAAO,CAAC,mBAAmB;IAW1B,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,SAAS,GAAG,IAAI;IAKrF,GAAG,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,SAAS,GAAG,IAAI;IAKvF;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa;CA0BzC"}