@otonoma/paracord-panels-interface 0.17.1-rc.12

package/src/interface/index.ts

@@ -0,0 +1,74 @@
+// Interface types for communication between a panel and paracord.
+
+import {
+  ObservationCallbackObject,
+  PncpMessageCallbackObject,
+  PncpRequestCallbackObject,
+} from "@otonoma/paranet-client";
+import { MethodCall, MethodReturn } from "./methods";
+
+export * from "./methods";
+
+export const PARACORD_PANEL_REVISION: number = 1;
+
+// Connection request from a panel.
+export interface PanelConnect {
+  apiRevision: number;
+  panelId: string;
+  type: "panelConnect";
+}
+
+// Messages sent through the open channel.
+export interface PanelMessage {
+  // Current revision in use. Must always match `PARACORD_PANEL_REVISION` of the current version in use.
+  apiRevision: number;
+  // Unique id (within the context of a paranet) for the panel issuing the message.
+  panelId: string;
+  // message ID associated with this message. Only unique within the context of a given stream.
+  // This ID is only used for callback association.
+  messageId?: number;
+  body: MessageBody;
+}
+
+export type MessageBody =
+  | PanelMethodCall
+  | PanelMethodReturnMessage
+  | PncpMessageBody
+  | PanelParacordError;
+
+export interface PanelParacordError {
+  type: "paracordError";
+  error: string;
+}
+
+// Message sent from a panel to paracord.
+export interface PanelMethodCall {
+  type: "call";
+  body: MethodCall;
+}
+
+export interface PanelMethodReturnMessage {
+  type: "callReturn";
+  body: MethodReturn;
+}
+
+export type PncpMessageBody =
+  | PncpSkillCallback
+  | PncpMessageCallback
+  | ObservationCallback;
+
+export interface PncpSkillCallback {
+  type: "pncpSkillCb";
+  body: PncpRequestCallbackObject;
+}
+
+export interface PncpMessageCallback {
+  type: "pncpMessageCb";
+  body: PncpMessageCallbackObject;
+}
+
+export interface ObservationCallback {
+  type: "pncpObservationCb";
+  body: ObservationCallbackObject;
+  callback?: any;
+}

package/src/interface/methods.ts

@@ -0,0 +1,136 @@
+import { ConversationId, DocumentArgs, DocumentInfo, ObservationMessageFilter, PncpMessageObject, SkillRequest } from "@otonoma/paranet-client";
+
+// Method calls all must set `method: ""` and `args: ...`.
+export type MethodCall =
+  | PncpRequestCall
+  | PncpResponseCall
+  | PncpMessageCall
+  | RegisterSkillCallbackCall
+  | RegisterObserverCallbackCall
+  | UnregisterObserverCallbackCall
+  | UploadDocumentCall
+  | FetchDocumentCall
+  | GraphqlCall;
+
+// Method call returns.
+export type MethodReturn = PncpCallResponse | GraphqlCallResponse | UploadDocumentResponse | FetchDocumentResponse | RegisterObserverResponse | VoidReturn;
+
+export type PncpRequestCall = {
+  method: "pncpRequest";
+  args: SkillRequest;
+};
+
+export type PncpResponseCall = {
+  method: "pncpResponse";
+  args: PncpMessageResponse;
+};
+
+export type PncpMessageCall = {
+  method: "pncpMessage";
+  args: PncpMessageObject;
+};
+
+export type RegisterSkillCallbackCall = {
+  method: "registerSkillCallback";
+  args: RegisterSkillCallback;
+};
+
+export type RegisterObserverCallbackCall = {
+  method: "registerObserverCallback";
+  args: RegisterObserverCallback;
+};
+
+export type RegisterObserverResponse = {
+  type: "registerObserverCallback";
+  args: {
+    key: string;
+  },
+};
+
+export type UnregisterObserverCallbackCall = {
+  method: "unregisterObserverCallback";
+  args: {
+    key: string;
+  }
+};
+
+export type UploadDocumentCall = {
+  method: "uploadDocumentCall";
+  args: UploadDocumentArgs;
+};
+
+export type UploadDocumentArgs = {
+  args?: DocumentArgs;
+  // `any` is too open, but if we run into specific issues we can deal with it.
+  // Files themselves 
+  body: File | any;
+};
+
+export type UploadDocumentResponse = {
+  type: "uploadDocument";
+  error?: string;
+  body?: DocumentInfo;
+};
+
+export type FetchDocumentCall = {
+  method: "fetchDocumentCall";
+  args: DocumentArgs;
+};
+
+export type FetchDocumentResponse = {
+  type: "fetchDocument";
+  stream?: ReadableStream,
+  error?: any;
+};
+
+export type GraphqlCall = {
+  method: "graphqlCall";
+  args: GraphqlCallArgs;
+};
+
+export type GraphqlCallArgs = {
+  // This should work to provide `gql""` strings given the `any` input.
+  query: string | any;
+  variables?: any;
+};
+
+export type RegisterSkillCallback = {
+  subject: string;
+  action: string;
+};
+
+export type RegisterObserverCallback = {
+  subject: string;
+  action: string;
+  offset?: number;
+  callback?: any;
+  filters?: ObservationMessageFilter[];
+  conversationId?: string;
+};
+
+
+// Response returned from the paranet broker.
+export interface PncpCallResponse {
+  type: "response";
+  conversationId?: ConversationId;
+  messageId: string;
+  date?: Date;
+  actorId?: string;
+  actorVersion?: string;
+}
+
+// Sends a response as a PncpMessage.
+export interface PncpMessageResponse {
+  conversation: string;
+  data: any;
+}
+
+export interface GraphqlCallResponse {
+  type: "graphqlCall";
+  data: any;
+  error?: any;
+}
+
+export interface VoidReturn {
+  type: "void";
+}

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    // "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*"]
+}