@trakit/sync 0.0.5 → 0.0.7

package/API/Constants.d.ts

@@ -0,0 +1,8 @@
+import { SyncName } from "@trakit/objects";
+/**
+ * A mapping of object names to their component parts.
+ */
+export declare const OBJECT_COMPOUNDS: {
+    [key in SyncName | string]: SyncName[];
+};
+//# sourceMappingURL=Constants.d.ts.map

package/API/Functions.d.ts

@@ -0,0 +1,42 @@
+import { Payload, Reply } from "@trakit/commands";
+import { codified, email, guid, JsonObject, JsonValue, nothing, SyncName, ulong } from "@trakit/objects";
+/**
+ * Creates a standardized error response.
+ * @param ex The error to include in the response.
+ * @returns A standardized error response object.
+ */
+export declare function createClientErrorResponse(ex: Error, response?: JsonValue): JsonObject;
+/**
+ * Returns the name of the identifying key for the given Trak-iT Object type.
+ * @param type
+ * @returns
+ */
+export declare function getJsonKeyName(type: SyncName): "login" | "code" | "handle" | "key" | "guid" | "id";
+/**
+ * Returns the value of the identifying key for the given Trak-iT Object.
+ * @param json
+ * @param type
+ * @returns
+ */
+export declare function getJsonKeyValue(json: JsonObject, type: SyncName): ulong | guid | email | codified | string;
+/**
+ * Translated type name to object name to account for some legacy message names.
+ * @param typeName
+ * @returns
+ */
+export declare function makeObjectName(typeName: string): SyncName;
+/**
+ * Factory to create Payload classes based on type name.
+ * @param type		SyncName representing the type of the payload.
+ * @param suffix	Optional suffix to append to the class name.  Defaults to "Get".
+ * @returns
+ */
+export declare function makePayloadClass(type: SyncName, suffix?: string | nothing): (new (json: JsonObject) => Payload) | nothing;
+/**
+ * Factory to create Reply classes based on type name.
+ * @param type		SyncName representing the type of the reply.
+ * @param suffix	Optional suffix to append to the class name.  Defaults to "Get".
+ * @returns
+ */
+export declare function makeReplyClass(type: SyncName, suffix?: string | nothing): (new (json: JsonObject) => Reply) | nothing;
+//# sourceMappingURL=Functions.d.ts.map

package/API/TrakitBaseCommander.d.ts

@@ -0,0 +1,70 @@
+import { Payload, Reply, RepSelfGet } from '@trakit/commands';
+import { guid, Machine, nothing, url } from '@trakit/objects';
+/**
+ * The base class used to help define interaction with all Trak-iT API services.
+ */
+export declare abstract class TrakitBaseCommander<TRequest> {
+    /**
+     * Details of the {@link User} or {@link Machine} who is connected to the underlying Trak-iT API service.
+     */
+    account: RepSelfGet;
+    /**
+     * {@link url} of the underlying Trak-iT API service.
+     */
+    baseAddress: URL | null;
+    /**
+     * Additional (optional) values added to the query-string of the connection request.
+     */
+    readonly query: Map<string, string>;
+    /**
+     * Additional (optional) HTTP headers added to the connection request.
+     */
+    readonly headers: Map<string, string>;
+    /**
+     * Returns the {@link baseAddress} with the appropriate path, query values.
+     * @param path  Optional path to append to the base address.
+     * @returns     The constructed URL string.
+     */
+    protected createBaseUrl(path?: URL | url | nothing): URL;
+    constructor(account?: RepSelfGet | {
+        machine: {
+            key: string;
+        };
+    } | Machine | {
+        key: string;
+    } | {
+        ghostId: guid;
+    } | guid | nothing, baseAddress?: URL | url | nothing);
+    /**
+     * Sets the authentication mechanism using either a session id or a Machine object.
+     * @param account  The session id (string), {@link Machine} object, or {@link RepSelfGet} object.
+     */
+    setAuth(account?: RepSelfGet | {
+        machine: {
+            key: string;
+        };
+    } | Machine | {
+        key: string;
+    } | {
+        ghostId: guid;
+    } | guid | nothing): void;
+    /**
+     * Sends a command to the underlying service, and returns a Promise that completes when a reply is received.
+     * @param payload   The payload to send to the service.
+     * @returns         A promise that settles based on the underlying service's response.
+     */
+    command<TReply extends Reply>(payload: Payload): Promise<TReply>;
+    /**
+     * Creates a request object to send to the underlying service.
+     * @param payload The payload to send to the underlying service.
+     * @returns       The request object to send to the underlying service.
+     */
+    abstract _createRequest(payload: Payload): TRequest;
+    /**
+     * Sends a request to the underlying service, and returns a Promise that completes when a reply is received.
+     * @param request	The request object to send to the service.
+     * @returns			A promise that resolves for any response, and rejects for client-side and transport errors.
+     */
+    abstract _relayRequest(request: TRequest): Promise<any>;
+}
+//# sourceMappingURL=TrakitBaseCommander.d.ts.map