@serve.zone/interfaces 1.0.30 → 1.0.31

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@serve.zone/interfaces',
-    version: '1.0.30',
+    version: '1.0.31',
     description: 'interfaces for working with containers'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLHdDQUF3QztDQUN0RCxDQUFBIn0=

package/dist_ts/index.d.ts

@@ -1,3 +1,4 @@
 import * as data from './data/index.js';
+import * as platformservice from './platformservice/index.js';
 import * as requests from './requests/index.js';
-export { data, requests };
+export { data, platformservice, requests };

package/dist_ts/index.js

@@ -1,4 +1,5 @@
 import * as data from './data/index.js';
+import * as platformservice from './platformservice/index.js';
 import * as requests from './requests/index.js';
-export { data, requests };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssSUFBSSxNQUFNLGlCQUFpQixDQUFDO0FBQ3hDLE9BQU8sS0FBSyxRQUFRLE1BQU0scUJBQXFCLENBQUM7QUFFaEQsT0FBTyxFQUNMLElBQUksRUFDSixRQUFRLEVBQ1QsQ0FBQSJ9
+export { data, platformservice, requests };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssSUFBSSxNQUFNLGlCQUFpQixDQUFDO0FBQ3hDLE9BQU8sS0FBSyxlQUFlLE1BQU0sNEJBQTRCLENBQUM7QUFDOUQsT0FBTyxLQUFLLFFBQVEsTUFBTSxxQkFBcUIsQ0FBQztBQUVoRCxPQUFPLEVBQ0wsSUFBSSxFQUNKLGVBQWUsRUFDZixRQUFRLEVBQ1QsQ0FBQSJ9

package/dist_ts/platformservice/aibridge.d.ts

@@ -0,0 +1,18 @@
+import * as plugins from '../plugins.js';
+export interface IChat {
+    systemMessage: string;
+    messages: {
+        role: 'assistant' | 'user';
+        content: string;
+    }[];
+}
+export interface IReq_Chat extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Chat> {
+    method: 'chat';
+    request: {
+        chat: IChat;
+    };
+    response: {
+        chat: IChat;
+        latestMessage: string;
+    };
+}

package/dist_ts/platformservice/aibridge.js

@@ -0,0 +1,2 @@
+import * as plugins from '../plugins.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWlicmlkZ2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9wbGF0Zm9ybXNlcnZpY2UvYWlicmlkZ2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUMifQ==

package/dist_ts/platformservice/index.d.ts

@@ -0,0 +1,5 @@
+import * as aibridge from './aibridge.js';
+import * as letter from './letter.js';
+import * as mta from './mta.js';
+import * as sms from './sms.js';
+export { aibridge, letter, mta, sms, };

package/dist_ts/platformservice/index.js

@@ -0,0 +1,6 @@
+import * as aibridge from './aibridge.js';
+import * as letter from './letter.js';
+import * as mta from './mta.js';
+import * as sms from './sms.js';
+export { aibridge, letter, mta, sms, };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9wbGF0Zm9ybXNlcnZpY2UvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLFFBQVEsTUFBTSxlQUFlLENBQUM7QUFDMUMsT0FBTyxLQUFLLE1BQU0sTUFBTSxhQUFhLENBQUM7QUFDdEMsT0FBTyxLQUFLLEdBQUcsTUFBTSxVQUFVLENBQUM7QUFDaEMsT0FBTyxLQUFLLEdBQUcsTUFBTSxVQUFVLENBQUM7QUFFaEMsT0FBTyxFQUNMLFFBQVEsRUFDUixNQUFNLEVBQ04sR0FBRyxFQUNILEdBQUcsR0FDSixDQUFBIn0=

package/dist_ts/platformservice/letter.d.ts

@@ -0,0 +1 @@
+export {};

package/dist_ts/platformservice/letter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibGV0dGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcGxhdGZvcm1zZXJ2aWNlL2xldHRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/dist_ts/platformservice/mta.d.ts

@@ -0,0 +1,30 @@
+import * as plugins from '../plugins.js';
+export type TTemplates = 'default' | 'linkaction' | 'notification';
+export interface IRequestSendEmail extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequestSendEmail> {
+    method: 'sendEmail';
+    request: {
+        title: string;
+        from: string;
+        to: string;
+        body: string;
+        attachments?: Array<{
+            name: string;
+            binaryAttachmentString: string;
+        }>;
+    };
+    response: {
+        /**
+         * the response id allows for handling of responses to that email
+         */
+        responseId: string;
+    };
+}
+export interface IRequestRegisterRecipient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequestRegisterRecipient> {
+    method: 'registerRecepient';
+    request: {
+        emailAddress: string;
+    };
+    response: {
+        status: 'ok' | 'not ok';
+    };
+}

package/dist_ts/platformservice/mta.js

@@ -0,0 +1,2 @@
+import * as plugins from '../plugins.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcGxhdGZvcm1zZXJ2aWNlL210YS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQyJ9

package/dist_ts/platformservice/sms.d.ts

@@ -0,0 +1,23 @@
+import * as plugins from '../plugins.js';
+export interface IRequest_SendSms extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_SendSms> {
+    method: 'sendSms';
+    request: {
+        toNumber: number;
+        fromName: string;
+        messageText: string;
+    };
+    response: {
+        status: 'ok' | 'not ok';
+    };
+}
+export interface IRequest_SendVerificationCode extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_SendVerificationCode> {
+    method: 'sendVerificationCode';
+    request: {
+        toNumber: number;
+        fromName: string;
+    };
+    response: {
+        status: 'ok' | 'not ok';
+        verificationCode: string;
+    };
+}

package/dist_ts/platformservice/sms.js

@@ -0,0 +1,2 @@
+import * as plugins from '../plugins.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcGxhdGZvcm1zZXJ2aWNlL3Ntcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQyJ9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serve.zone/interfaces",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "private": false,
   "description": "interfaces for working with containers",
   "main": "dist_ts/index.js",

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@serve.zone/interfaces',
-  version: '1.0.30',
+  version: '1.0.31',
   description: 'interfaces for working with containers'
 }

package/ts/index.ts

@@ -1,7 +1,9 @@
 import * as data from './data/index.js';
+import * as platformservice from './platformservice/index.js';
 import * as requests from './requests/index.js';
 
 export {
   data,
+  platformservice,
   requests
 }

package/ts/platformservice/00readme.md

@@ -0,0 +1 @@
+The platform folder contains types that can be used for talking with the underlying platform by apps running on serve.zone.

package/ts/platformservice/aibridge.ts

@@ -0,0 +1,23 @@
+import * as plugins from '../plugins.js';
+
+export interface IChat {
+  systemMessage: string;
+  messages: {
+    role: 'assistant' | 'user';
+    content: string;
+  }[];
+}
+
+export interface IReq_Chat extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Chat
+>  {
+  method: 'chat',
+  request: {
+    chat: IChat;
+  };
+  response: {
+    chat: IChat;
+    latestMessage: string;
+  }
+}

package/ts/platformservice/index.ts

@@ -0,0 +1,11 @@
+import * as aibridge from './aibridge.js';
+import * as letter from './letter.js';
+import * as mta from './mta.js';
+import * as sms from './sms.js';
+
+export {
+  aibridge,
+  letter,
+  mta,
+  sms,
+}

package/ts/platformservice/mta.ts

@@ -0,0 +1,39 @@
+import * as plugins from '../plugins.js';
+
+export type TTemplates = 'default' | 'linkaction' | 'notification';
+
+export interface IRequestSendEmail extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequestSendEmail
+> {
+  method: 'sendEmail';
+  request: {
+    title: string;
+    from: string;
+    to: string;
+    body: string;
+    attachments?: Array<{
+      name: string;
+      binaryAttachmentString: string;
+    }>
+  };
+  response: {
+    /**
+     * the response id allows for handling of responses to that email
+     */
+    responseId: string;
+  };
+}
+
+export interface IRequestRegisterRecipient extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequestRegisterRecipient
+> {
+  method: 'registerRecepient';
+  request: {
+    emailAddress: string;
+  };
+  response: {
+    status: 'ok' | 'not ok';
+  };
+}

package/ts/platformservice/sms.ts

@@ -0,0 +1,33 @@
+import * as plugins from '../plugins.js';
+
+export interface IRequest_SendSms
+  extends plugins.typedrequestInterfaces.implementsTR<
+    plugins.typedrequestInterfaces.ITypedRequest,
+    IRequest_SendSms
+  > {
+    method: 'sendSms';
+    request: {
+      toNumber: number;
+      fromName: string;
+      messageText: string;
+    };
+    response: {
+      status: 'ok' | 'not ok';
+    }
+  }
+
+  export interface IRequest_SendVerificationCode
+  extends plugins.typedrequestInterfaces.implementsTR<
+    plugins.typedrequestInterfaces.ITypedRequest,
+    IRequest_SendVerificationCode
+  > {
+    method: 'sendVerificationCode';
+    request: {
+      toNumber: number;
+      fromName: string;
+    };
+    response: {
+      status: 'ok' | 'not ok';
+      verificationCode: string;
+    }
+  }