@stackone/core 1.0.0 → 1.1.0

package/dist/baseConnector.d.ts

@@ -1,5 +1,5 @@
 import { IHttpClient } from '@stackone/transport';
-import { Bundle, HttpOperation, HttpOperations, IConnector, Operation, Service } from './types';
+import { Bundle, HttpOperation, HttpOperations, IConnector, Operation, ResponseFieldMetaData, Service } from './types';
 export declare abstract class BaseConnector implements IConnector {
     protected httpClient: IHttpClient;
     version: string;
@@ -31,6 +31,7 @@ export declare abstract class BaseConnector implements IConnector {
     });
     listOperations: () => string[];
     getOperation: (operationId: string) => HttpOperation;
+    getOperationResponseFieldsMetadata: (operationId: string) => ResponseFieldMetaData[] | null;
     callOperation: ({ operationId, params, credentials, }: {
         operationId: string;
         params?: Record<string, unknown> | undefined;

package/dist/index.es.mjs

@@ -1 +1 @@
-import{HttpClient as t}from"@stackone/transport";class e{constructor({version:e="1",key:r,name:s,services:o={},httpOperations:a={},auth:i,proxy:n,httpClient:h=new t}){this.listOperations=()=>Object.keys(this.httpOperations||{}),this.getOperation=t=>{const e=this.httpOperations?.[t];if(!e)throw new Error(`Operation ${t} not found`);return e},this.callOperation=async({operationId:t,params:e,credentials:r})=>{const s=this.httpOperations?.[t];if(!s)throw new Error(`Operation ${t} not found`);const o=(({params:t,httpOperation:e})=>{const{url:r,method:s}=e;let o=r;const a=[],i=[],n={};let h;Object.entries(t||{}).forEach((([t,r])=>{const s=e.parameters?.[t];if(s)switch(s.in){case"path":o=o.replace(`{${t}}`,r).replace(`:${t}`,r);break;case"query":a.push(`${t}=${r}`);break;case"header":n[t]=r;break;case"cookie":i.push(`${t}=${r}; `);break;case"body":h=r}}));const p=a.length>0?`?${a.join("&")}`:"";return i.length>0&&(n.cookie=i.join("")),{url:`${o}${p}`,method:s,headers:Object.keys(n).length>0?n:void 0,body:h||void 0}})({params:e,httpOperation:s}),{method:a,url:i,headers:n,body:h}=o,{apiKey:p}=r;return{connector:this,input:{operationId:t,params:e},response:await this.httpClient.request({method:a,url:i,headers:{...n,authorization:p},payload:h}),credentials:r}},this.version=e,this.key=r,this.name=s,this.services=o,this.httpOperations=a,this.auth=i,this.proxy=n,this.httpClient=h}}const r="request_body";export{e as BaseConnector,r as REQUEST_BODY_PARAM};
+import{HttpClient as t}from"@stackone/transport";const e=(t,s="")=>{let r=[];if("object"===t.type&&t.properties){const n=""===s||s.endsWith(".")?s:`${s}.`;for(const s in t.properties)r=r.concat(e(t.properties[s],`${n}${s}`))}else"array"===t.type&&t.items?r=r.concat(e(t.items,`${s}[].`)):r.push({name:s.endsWith(".")?s.slice(0,-1):s,type:t.type,description:t.description});return r};class s{constructor({version:s="1",key:r,name:n,services:o={},httpOperations:i={},auth:a,proxy:p,httpClient:c=new t}){this.listOperations=()=>Object.keys(this.httpOperations||{}),this.getOperation=t=>{const e=this.httpOperations?.[t];if(!e)throw new Error(`Operation ${t} not found`);return e},this.getOperationResponseFieldsMetadata=t=>{const s=this.getOperation(t).responses;if(!s)return null;const r=(t=>{const e=Object.entries(t).find((([t])=>t.startsWith("2")));return e?e[1]:null})(s);return r&&r.content["application/json"]?.schema?e(r.content["application/json"]?.schema):null},this.callOperation=async({operationId:t,params:e,credentials:s})=>{const r=this.httpOperations?.[t];if(!r)throw new Error(`Operation ${t} not found`);const n=(({params:t,httpOperation:e})=>{const{url:s,method:r}=e;let n=s;const o=[],i=[],a={};let p;Object.entries(t||{}).forEach((([t,s])=>{const r=e.parameters?.[t];if(r)switch(r.in){case"path":n=n.replace(`{${t}}`,s).replace(`:${t}`,s);break;case"query":o.push(`${t}=${s}`);break;case"header":a[t]=s;break;case"cookie":i.push(`${t}=${s}; `);break;case"body":p=s}}));const c=o.length>0?`?${o.join("&")}`:"";return i.length>0&&(a.cookie=i.join("")),{url:`${n}${c}`,method:r,headers:Object.keys(a).length>0?a:void 0,body:p||void 0}})({params:e,httpOperation:r}),{method:o,url:i,headers:a,body:p}=n,{apiKey:c}=s;return{connector:this,input:{operationId:t,params:e},response:await this.httpClient.request({method:o,url:i,headers:{...a,authorization:c},payload:p}),credentials:s}},this.version=s,this.key=r,this.name=n,this.services=o,this.httpOperations=i,this.auth=a,this.proxy=p,this.httpClient=c}}const r="request_body";export{s as BaseConnector,r as REQUEST_BODY_PARAM};

package/dist/index.js

@@ -1 +1 @@
-"use strict";var t=require("@stackone/transport");exports.BaseConnector=class{constructor({version:e="1",key:r,name:s,services:o={},httpOperations:a={},auth:i,proxy:n,httpClient:h=new t.HttpClient}){this.listOperations=()=>Object.keys(this.httpOperations||{}),this.getOperation=t=>{const e=this.httpOperations?.[t];if(!e)throw new Error(`Operation ${t} not found`);return e},this.callOperation=async({operationId:t,params:e,credentials:r})=>{const s=this.httpOperations?.[t];if(!s)throw new Error(`Operation ${t} not found`);const o=(({params:t,httpOperation:e})=>{const{url:r,method:s}=e;let o=r;const a=[],i=[],n={};let h;Object.entries(t||{}).forEach((([t,r])=>{const s=e.parameters?.[t];if(s)switch(s.in){case"path":o=o.replace(`{${t}}`,r).replace(`:${t}`,r);break;case"query":a.push(`${t}=${r}`);break;case"header":n[t]=r;break;case"cookie":i.push(`${t}=${r}; `);break;case"body":h=r}}));const p=a.length>0?`?${a.join("&")}`:"";return i.length>0&&(n.cookie=i.join("")),{url:`${o}${p}`,method:s,headers:Object.keys(n).length>0?n:void 0,body:h||void 0}})({params:e,httpOperation:s}),{method:a,url:i,headers:n,body:h}=o,{apiKey:p}=r;return{connector:this,input:{operationId:t,params:e},response:await this.httpClient.request({method:a,url:i,headers:{...n,authorization:p},payload:h}),credentials:r}},this.version=e,this.key=r,this.name=s,this.services=o,this.httpOperations=a,this.auth=i,this.proxy=n,this.httpClient=h}},exports.REQUEST_BODY_PARAM="request_body";
+"use strict";var t=require("@stackone/transport");const e=(t,s="")=>{let r=[];if("object"===t.type&&t.properties){const n=""===s||s.endsWith(".")?s:`${s}.`;for(const s in t.properties)r=r.concat(e(t.properties[s],`${n}${s}`))}else"array"===t.type&&t.items?r=r.concat(e(t.items,`${s}[].`)):r.push({name:s.endsWith(".")?s.slice(0,-1):s,type:t.type,description:t.description});return r};exports.BaseConnector=class{constructor({version:s="1",key:r,name:n,services:o={},httpOperations:i={},auth:a,proxy:p,httpClient:c=new t.HttpClient}){this.listOperations=()=>Object.keys(this.httpOperations||{}),this.getOperation=t=>{const e=this.httpOperations?.[t];if(!e)throw new Error(`Operation ${t} not found`);return e},this.getOperationResponseFieldsMetadata=t=>{const s=this.getOperation(t).responses;if(!s)return null;const r=(t=>{const e=Object.entries(t).find((([t])=>t.startsWith("2")));return e?e[1]:null})(s);return r&&r.content["application/json"]?.schema?e(r.content["application/json"]?.schema):null},this.callOperation=async({operationId:t,params:e,credentials:s})=>{const r=this.httpOperations?.[t];if(!r)throw new Error(`Operation ${t} not found`);const n=(({params:t,httpOperation:e})=>{const{url:s,method:r}=e;let n=s;const o=[],i=[],a={};let p;Object.entries(t||{}).forEach((([t,s])=>{const r=e.parameters?.[t];if(r)switch(r.in){case"path":n=n.replace(`{${t}}`,s).replace(`:${t}`,s);break;case"query":o.push(`${t}=${s}`);break;case"header":a[t]=s;break;case"cookie":i.push(`${t}=${s}; `);break;case"body":p=s}}));const c=o.length>0?`?${o.join("&")}`:"";return i.length>0&&(a.cookie=i.join("")),{url:`${n}${c}`,method:r,headers:Object.keys(a).length>0?a:void 0,body:p||void 0}})({params:e,httpOperation:r}),{method:o,url:i,headers:a,body:p}=n,{apiKey:c}=s;return{connector:this,input:{operationId:t,params:e},response:await this.httpClient.request({method:o,url:i,headers:{...a,authorization:c},payload:p}),credentials:s}},this.version=s,this.key=r,this.name=n,this.services=o,this.httpOperations=i,this.auth=a,this.proxy=p,this.httpClient=c}},exports.REQUEST_BODY_PARAM="request_body";

package/dist/responseMetaData.d.ts

@@ -0,0 +1,3 @@
+import { HttpParameterSchema, HttpResponses, HttpSchemaResponse, ResponseFieldMetaData } from './types';
+export declare const getSuccessfulResponse: (responses: HttpResponses) => HttpSchemaResponse | null;
+export declare const getResponseFieldsMetaData: (schema: HttpParameterSchema, parentFieldKey?: string) => ResponseFieldMetaData[];

package/dist/types.d.ts

@@ -38,12 +38,37 @@ export interface HttpParameter {
     type: HttpParameterType;
     isArray?: boolean;
 }
+export type HttpResponses = {
+    [key: string]: HttpSchemaResponse;
+};
+export type HttpSchemaResponse = {
+    description: string;
+    content: {
+        [key: string]: {
+            schema: HttpParameterSchema;
+        };
+    };
+};
+export type HttpParameterSchema = {
+    type: string;
+    description?: string;
+    properties?: {
+        [key: string]: HttpParameterSchema;
+    };
+    items?: HttpParameterSchema;
+};
+export type ResponseFieldMetaData = {
+    name: string;
+    type: HttpParameterType;
+    description?: string;
+};
 export type HttpOperation = {
     url: string;
     method: HttpMethod;
     parameters?: {
         [key: string]: HttpParameter;
     };
+    responses: HttpResponses;
 };
 export type HttpOperations = {
     [key: string]: HttpOperation;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stackone/core",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "",
     "main": "dist/index.js",
     "module": "dist/index.es.js",
@@ -18,7 +18,7 @@
         "lint:fix": "npm run lint -- --fix",
         "test": "vitest run",
         "test:watch": "vitest watch",
-        "publish": "npm publish --access=public"
+        "publish-release": "npm publish --access=public"
     },
     "keywords": [],
     "author": "StackOne",