tscommons-esm-ai-llm 0.0.2

package/dist/enums/echat-role.d.mts

@@ -0,0 +1,11 @@
+export declare enum ECommonsAiLlmChatRole {
+    USER = "user",
+    ASSISTANT = "assistant",
+    SYSTEM = "system",
+    TOOL = "tool"
+}
+export declare function toECommonsAiLlmChatRole(type: string): ECommonsAiLlmChatRole | undefined;
+export declare function fromECommonsAiLlmChatRole(type: ECommonsAiLlmChatRole): string;
+export declare function isECommonsAiLlmChatRole(test: unknown): test is ECommonsAiLlmChatRole;
+export declare function keyToECommonsAiLlmChatRole(key: string): ECommonsAiLlmChatRole;
+export declare const ECOMMONS_AI_LLM_CHAT_ROLES: ECommonsAiLlmChatRole[];

package/dist/enums/echat-role.mjs

@@ -0,0 +1,55 @@
+import { commonsTypeIsString } from 'tscommons-esm-core';
+export var ECommonsAiLlmChatRole;
+(function (ECommonsAiLlmChatRole) {
+    ECommonsAiLlmChatRole["USER"] = "user";
+    ECommonsAiLlmChatRole["ASSISTANT"] = "assistant";
+    ECommonsAiLlmChatRole["SYSTEM"] = "system";
+    ECommonsAiLlmChatRole["TOOL"] = "tool";
+})(ECommonsAiLlmChatRole || (ECommonsAiLlmChatRole = {}));
+export function toECommonsAiLlmChatRole(type) {
+    switch (type) {
+        case ECommonsAiLlmChatRole.USER.toString():
+            return ECommonsAiLlmChatRole.USER;
+        case ECommonsAiLlmChatRole.ASSISTANT.toString():
+            return ECommonsAiLlmChatRole.ASSISTANT;
+        case ECommonsAiLlmChatRole.SYSTEM.toString():
+            return ECommonsAiLlmChatRole.SYSTEM;
+        case ECommonsAiLlmChatRole.TOOL.toString():
+            return ECommonsAiLlmChatRole.TOOL;
+    }
+    return undefined;
+}
+export function fromECommonsAiLlmChatRole(type) {
+    switch (type) {
+        case ECommonsAiLlmChatRole.USER:
+            return ECommonsAiLlmChatRole.USER.toString();
+        case ECommonsAiLlmChatRole.ASSISTANT:
+            return ECommonsAiLlmChatRole.ASSISTANT.toString();
+        case ECommonsAiLlmChatRole.SYSTEM:
+            return ECommonsAiLlmChatRole.SYSTEM.toString();
+        case ECommonsAiLlmChatRole.TOOL:
+            return ECommonsAiLlmChatRole.TOOL.toString();
+    }
+    throw new Error('Unknown ECommonsAiLlmChatRole');
+}
+export function isECommonsAiLlmChatRole(test) {
+    if (!commonsTypeIsString(test))
+        return false;
+    return toECommonsAiLlmChatRole(test) !== undefined;
+}
+export function keyToECommonsAiLlmChatRole(key) {
+    switch (key) {
+        case 'USER':
+            return ECommonsAiLlmChatRole.USER;
+        case 'ASSISTANT':
+            return ECommonsAiLlmChatRole.ASSISTANT;
+        case 'SYSTEM':
+            return ECommonsAiLlmChatRole.SYSTEM;
+        case 'TOOL':
+            return ECommonsAiLlmChatRole.TOOL;
+    }
+    throw new Error(`Unable to obtain ECommonsAiLlmChatRole for key: ${key}`);
+}
+export const ECOMMONS_AI_LLM_CHAT_ROLES = Object.keys(ECommonsAiLlmChatRole)
+    .map((e) => keyToECommonsAiLlmChatRole(e));
+//# sourceMappingURL=echat-role.mjs.map

package/dist/enums/echat-role.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"echat-role.mjs","sourceRoot":"","sources":["../../src/enums/echat-role.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEzD,MAAM,CAAN,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,sCAAa,CAAA;IACb,gDAAuB,CAAA;IACvB,0CAAiB,CAAA;IACjB,sCAAa,CAAA;AACf,CAAC,EALW,qBAAqB,KAArB,qBAAqB,QAKhC;AAED,MAAM,UAAU,uBAAuB,CAAC,IAAY;IACnD,QAAQ,IAAI,EAAE,CAAC;QACd,KAAK,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,OAAO,qBAAqB,CAAC,IAAI,CAAC;QACnC,KAAK,qBAAqB,CAAC,SAAS,CAAC,QAAQ,EAAE;YAC9C,OAAO,qBAAqB,CAAC,SAAS,CAAC;QACxC,KAAK,qBAAqB,CAAC,MAAM,CAAC,QAAQ,EAAE;YAC3C,OAAO,qBAAqB,CAAC,MAAM,CAAC;QACrC,KAAK,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,OAAO,qBAAqB,CAAC,IAAI,CAAC;IACpC,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,IAA2B;IACpE,QAAQ,IAAI,EAAE,CAAC;QACd,KAAK,qBAAqB,CAAC,IAAI;YAC9B,OAAO,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9C,KAAK,qBAAqB,CAAC,SAAS;YACnC,OAAO,qBAAqB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QACnD,KAAK,qBAAqB,CAAC,MAAM;YAChC,OAAO,qBAAqB,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAChD,KAAK,qBAAqB,CAAC,IAAI;YAC9B,OAAO,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC/C,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,IAAa;IACpD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAE7C,OAAO,uBAAuB,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,GAAW;IACrD,QAAQ,GAAG,EAAE,CAAC;QACb,KAAK,MAAM;YACV,OAAO,qBAAqB,CAAC,IAAI,CAAC;QACnC,KAAK,WAAW;YACf,OAAO,qBAAqB,CAAC,SAAS,CAAC;QACxC,KAAK,QAAQ;YACZ,OAAO,qBAAqB,CAAC,MAAM,CAAC;QACrC,KAAK,MAAM;YACV,OAAO,qBAAqB,CAAC,IAAI,CAAC;IACpC,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,mDAAmD,GAAG,EAAE,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,CAAC,MAAM,0BAA0B,GAA4B,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC;KAClG,GAAG,CAAC,CAAC,CAAS,EAAyB,EAAE,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+import { ECommonsAiLlmChatRole, toECommonsAiLlmChatRole, fromECommonsAiLlmChatRole, isECommonsAiLlmChatRole, keyToECommonsAiLlmChatRole, ECOMMONS_AI_LLM_CHAT_ROLES } from './enums/echat-role.mjs';
+import { TCommonsAiLlmChatMessage, isTCommonsAiLlmChatMessage, TCommonsAiLlmChatMessageWithOptionalImages, isTCommonsAiLlmChatMessageWithOptionalImages, TCommonsAiLlmEncodedChatMessageWithOptionalImages, isTCommonsAiLlmEncodedChatMessageWithOptionalImages } from './types/tchat-message.mjs';
+export { ECommonsAiLlmChatRole, toECommonsAiLlmChatRole, fromECommonsAiLlmChatRole, isECommonsAiLlmChatRole, keyToECommonsAiLlmChatRole, ECOMMONS_AI_LLM_CHAT_ROLES, TCommonsAiLlmChatMessage, isTCommonsAiLlmChatMessage, TCommonsAiLlmChatMessageWithOptionalImages, isTCommonsAiLlmChatMessageWithOptionalImages, TCommonsAiLlmEncodedChatMessageWithOptionalImages, isTCommonsAiLlmEncodedChatMessageWithOptionalImages };

package/dist/index.mjs

@@ -0,0 +1,4 @@
+import { ECommonsAiLlmChatRole, toECommonsAiLlmChatRole, fromECommonsAiLlmChatRole, isECommonsAiLlmChatRole, keyToECommonsAiLlmChatRole, ECOMMONS_AI_LLM_CHAT_ROLES } from './enums/echat-role.mjs';
+import { isTCommonsAiLlmChatMessage, isTCommonsAiLlmChatMessageWithOptionalImages, isTCommonsAiLlmEncodedChatMessageWithOptionalImages } from './types/tchat-message.mjs';
+export { ECommonsAiLlmChatRole, toECommonsAiLlmChatRole, fromECommonsAiLlmChatRole, isECommonsAiLlmChatRole, keyToECommonsAiLlmChatRole, ECOMMONS_AI_LLM_CHAT_ROLES, isTCommonsAiLlmChatMessage, isTCommonsAiLlmChatMessageWithOptionalImages, isTCommonsAiLlmEncodedChatMessageWithOptionalImages };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAEL,0BAA0B,EAE1B,4CAA4C,EAE5C,mDAAmD,EACpD,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACN,qBAAqB,EACrB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,EAE1B,0BAA0B,EAE1B,4CAA4C,EAE5C,mDAAmD,EACnD,CAAC"}

package/dist/types/tchat-message.d.mts

@@ -0,0 +1,14 @@
+import { ECommonsAiLlmChatRole } from '../enums/echat-role.mjs';
+export type TCommonsAiLlmChatMessage = {
+    role: ECommonsAiLlmChatRole;
+    content: string;
+};
+export declare function isTCommonsAiLlmChatMessage(test: unknown): test is TCommonsAiLlmChatMessage;
+export type TCommonsAiLlmChatMessageWithOptionalImages<BufferT> = TCommonsAiLlmChatMessage & {
+    images?: BufferT[];
+};
+export declare function isTCommonsAiLlmChatMessageWithOptionalImages<BufferT>(test: unknown, isBuffer: (b: unknown) => b is BufferT): test is TCommonsAiLlmChatMessageWithOptionalImages<BufferT>;
+export type TCommonsAiLlmEncodedChatMessageWithOptionalImages = TCommonsAiLlmChatMessage & {
+    images?: string[];
+};
+export declare function isTCommonsAiLlmEncodedChatMessageWithOptionalImages(test: unknown): test is TCommonsAiLlmEncodedChatMessageWithOptionalImages;

package/dist/types/tchat-message.mjs

@@ -0,0 +1,28 @@
+import { commonsTypeHasPropertyArray, commonsTypeHasPropertyEnum, commonsTypeHasPropertyString, commonsTypeHasPropertyStringArrayOrUndefined } from 'tscommons-esm-core';
+import { isECommonsAiLlmChatRole } from '../enums/echat-role.mjs';
+export function isTCommonsAiLlmChatMessage(test) {
+    if (!commonsTypeHasPropertyEnum(test, 'role', isECommonsAiLlmChatRole))
+        return false;
+    if (!commonsTypeHasPropertyString(test, 'content'))
+        return false;
+    return true;
+}
+export function isTCommonsAiLlmChatMessageWithOptionalImages(test, isBuffer) {
+    if (!isTCommonsAiLlmChatMessage(test))
+        return false;
+    if (commonsTypeHasPropertyArray(test, 'images')) {
+        for (const t of test.images) {
+            if (!isBuffer(t))
+                return false;
+        }
+    }
+    return true;
+}
+export function isTCommonsAiLlmEncodedChatMessageWithOptionalImages(test) {
+    if (!isTCommonsAiLlmChatMessage(test))
+        return false;
+    if (!commonsTypeHasPropertyStringArrayOrUndefined(test, 'images'))
+        return false;
+    return true;
+}
+//# sourceMappingURL=tchat-message.mjs.map

package/dist/types/tchat-message.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tchat-message.mjs","sourceRoot":"","sources":["../../src/types/tchat-message.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,0BAA0B,EAC1B,4BAA4B,EAC5B,4CAA4C,EAC7C,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAyB,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAMzF,MAAM,UAAU,0BAA0B,CAAC,IAAa;IACvD,IAAI,CAAC,0BAA0B,CAAwB,IAAI,EAAE,MAAM,EAAE,uBAAuB,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5G,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,SAAS,CAAC;QAAE,OAAO,KAAK,CAAC;IAEjE,OAAO,IAAI,CAAC;AACb,CAAC;AAKD,MAAM,UAAU,4CAA4C,CAC1D,IAAa,EACb,QAAsC;IAEvC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAEpD,IAAI,2BAA2B,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC;QACjD,KAAK,MAAM,CAAC,IAAK,IAA4D,CAAC,MAAmB,EAAE,CAAC;YACnG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAAE,OAAO,KAAK,CAAC;QAChC,CAAC;IACF,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAKD,MAAM,UAAU,mDAAmD,CAAC,IAAa;IAChF,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAEpD,IAAI,CAAC,4CAA4C,CAAC,IAAI,EAAE,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IAEhF,OAAO,IAAI,CAAC;AACb,CAAC"}

package/package.json

@@ -0,0 +1,30 @@
+{
+	"name": "tscommons-esm-ai-llm",
+	"version": "0.0.2",
+	"description": "",
+	"scripts": {
+		"tsc": "./node_modules/typescript/bin/tsc",
+		"preprepare": "rm -rf ./dist; php ~/Dev/etim.php src/ && npm run tsc",
+		"publish-major": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version major && npm install && npm publish && git add . && git commit -m 'publish'",
+		"publish-minor": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version minor && npm install && npm publish && git add . && git commit -m 'publish'",
+		"publish-patch": "rm -rf dist; npm run tsc && npx eslint . && npm run preprepare && npm version patch && npm install && npm publish && git add . && git commit -m 'publish'"
+	},
+	"main": "dist/index.mjs",
+	"types": "dist/index.d.mjs",
+	"type": "module",
+	"author": "Pete Morris",
+	"license": "ISC",
+	"devDependencies": {
+		"@stylistic/eslint-plugin-ts": "^2.11.0",
+		"eslint-plugin-import": "^2.31.0",
+		"eslint-plugin-prefer-arrow-functions": "^3.4.1",
+		"typescript": "^5.7.2",
+		"typescript-eslint": "^8.16.0"
+	},
+	"files": [
+		"dist/**/*"
+	],
+	"dependencies": {
+		"tscommons-esm-core": "^0.0.4"
+	}
+}