@metacall/protocol 0.1.24 → 0.1.26

package/README.md

@@ -0,0 +1,34 @@
+# MetaCall Protocol
+
+This repository contains the protocol implementation for MetaCall FaaS. It is a client that allows deploying to [MetaCall FaaS](https://dashboard.metacall.io) or its [open source reimplementation](https://github.com/metacall/faas) written in TypeScript.
+
+## Documentation
+
+Explore the detailed documentation for the MetaCall Protocol in the [doc](doc) directory. It provides comprehensive information on the protocol, its implementation details, and best practices for integration.
+
+## [Core](https://github.com/metacall/core)
+
+The ultimate polyglot programming experience.
+
+## [Deploy](https://github.com/metacall/deploy)
+
+Tool for deploying into MetaCall FaaS platform.
+
+## [Examples](https://github.com/metacall/examples)
+
+A collection of use cases and examples to be deployed in MetaCall.
+
+## [FaaS](https://github.com/metacall/faas)
+
+The FaaS platform reimplementation for MetaCall.
+
+## Testing
+
+The [test](test) directory contains various tests for the MetaCall Protocol. These tests are designed to ensure the reliability and correctness of the protocol implementation. If you encounter any issues or inconsistencies, please report them by opening an [issue](https://github.com/metacall/protocol-repo/issues).
+
+## Contributing
+
+We welcome contributions from the community. If you have ideas, suggestions, or want to report a bug, please feel free to open an [issue](https://github.com/metacall/protocol/issues) or submit a [pull request](https://github.com/metacall/protocol/pulls).
+## License
+
+This repository is licensed under the [Apache License, Version 2.0](LICENSE). Feel free to use, modify, and distribute the code in accordance with the terms specified in the license.

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from './deployment';
+export * from './language';
+export * from './login';
+export * from './package';
+export * from './plan';
+export * from './token';
+import metacallAPI from './protocol';
+export * from './protocol';
+export default metacallAPI;

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./deployment"), exports);
+__exportStar(require("./language"), exports);
+__exportStar(require("./login"), exports);
+__exportStar(require("./package"), exports);
+__exportStar(require("./plan"), exports);
+__exportStar(require("./token"), exports);
+const protocol_1 = __importDefault(require("./protocol"));
+__exportStar(require("./protocol"), exports);
+exports.default = protocol_1.default;

package/dist/package.d.ts

@@ -1,5 +1,6 @@
 import { MetaCallJSON } from './deployment';
 export declare const findFilesPath: (path?: string, ignoreFiles?: string[]) => Promise<string[]>;
+export declare const pathIsMetaCallJson: (path: string) => boolean;
 export declare const findMetaCallJsons: (files: string[]) => string[];
 export declare const findRunners: (files: string[]) => Set<string>;
 export declare enum PackageError {

package/dist/package.js

@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateJsonsFromFiles = exports.generatePackage = exports.PackageError = exports.findRunners = exports.findMetaCallJsons = exports.findFilesPath = void 0;
+exports.generateJsonsFromFiles = exports.generatePackage = exports.PackageError = exports.findRunners = exports.findMetaCallJsons = exports.pathIsMetaCallJson = exports.findFilesPath = void 0;
 const ignore_walk_1 = __importDefault(require("ignore-walk"));
 const path_1 = require("path");
 const language_1 = require("./language");
@@ -28,7 +28,8 @@ const findFilesPath = async (path = process.cwd(), ignoreFiles = ['.gitignore'])
 })).filter(x => !x.startsWith('.git'));
 exports.findFilesPath = findFilesPath;
 const pathIsMetaCallJson = (path) => !!/^metacall(-.+)?\.json$/.exec(path_1.basename(path));
-const findMetaCallJsons = (files) => files.filter(pathIsMetaCallJson);
+exports.pathIsMetaCallJson = pathIsMetaCallJson;
+const findMetaCallJsons = (files) => files.filter(exports.pathIsMetaCallJson);
 exports.findMetaCallJsons = findMetaCallJsons;
 const findRunners = (files) => {
     const runners = new Set();

package/dist/protocol.d.ts

@@ -10,7 +10,10 @@ export interface SubscriptionDeploy {
     date: number;
     deploy: string;
 }
-export declare type ResourceType = 'Package' | 'Repository';
+export declare enum ResourceType {
+    Package = "Package",
+    Repository = "Repository"
+}
 export interface AddResponse {
     id: string;
 }
@@ -24,7 +27,7 @@ export interface API {
     listSubscriptions(): Promise<SubscriptionMap>;
     listSubscriptionsDeploys(): Promise<SubscriptionDeploy[]>;
     inspect(): Promise<Deployment[]>;
-    upload(name: string, blob: unknown, jsons: MetaCallJSON[], runners: string[]): Promise<string>;
+    upload(name: string, blob: unknown, jsons?: MetaCallJSON[], runners?: string[]): Promise<string>;
     add(url: string, branch: string, jsons: MetaCallJSON[]): Promise<AddResponse>;
     deploy(name: string, env: {
         name: string;

package/dist/protocol.js

@@ -22,12 +22,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isProtocolError = void 0;
+exports.ResourceType = exports.isProtocolError = void 0;
 const axios_1 = __importDefault(require("axios"));
 const form_data_1 = __importDefault(require("form-data"));
 const deployment_1 = require("./deployment");
 const isProtocolError = (err) => axios_1.default.isAxiosError(err);
 exports.isProtocolError = isProtocolError;
+var ResourceType;
+(function (ResourceType) {
+    ResourceType["Package"] = "Package";
+    ResourceType["Repository"] = "Repository";
+})(ResourceType = exports.ResourceType || (exports.ResourceType = {}));
 exports.default = (token, baseURL) => {
     const api = {
         refresh: () => axios_1.default
@@ -71,6 +76,7 @@ exports.default = (token, baseURL) => {
         })
             .then(res => res.data),
         upload: async (name, blob, jsons = [], runners = []) => {
+            var _a, _b;
             const fd = new form_data_1.default();
             fd.append('id', name);
             fd.append('type', 'application/x-zip-compressed');
@@ -83,7 +89,7 @@ exports.default = (token, baseURL) => {
             const res = await axios_1.default.post(baseURL + '/api/package/create', fd, {
                 headers: {
                     Authorization: 'jwt ' + token,
-                    ...fd.getHeaders()
+                    ...((_b = (_a = fd.getHeaders) === null || _a === void 0 ? void 0 : _a.call(fd)) !== null && _b !== void 0 ? _b : {}) // operator chaining to make it compatible with frontend
                 }
             });
             return res.data;

package/package.json

@@ -1,15 +1,19 @@
 {
 	"name": "@metacall/protocol",
-	"version": "0.1.24",
+	"version": "0.1.26",
 	"description": "Tool for deploying into MetaCall FaaS platform.",
 	"exports": {
 		"./*": "./dist/*.js",
+		".": "./dist/index.js",
 		"./package.json": "./package.json"
 	},
 	"typesVersions": {
 		"*": {
 			"*": [
 				"dist/*.d.ts"
+			],
+			".": [
+				"./dist/index.d.ts"
 			]
 		}
 	},
@@ -81,8 +85,6 @@
 		}
 	},
 	"dependencies": {
-		"@types/ignore-walk": "^4.0.0",
-		"@types/jsonwebtoken": "^8.5.8",
 		"axios": "^0.21.0",
 		"form-data": "^3.0.0",
 		"ignore-walk": "^3.0.4",
@@ -90,7 +92,9 @@
 	},
 	"devDependencies": {
 		"@types/express": "^4.17.13",
-		"@types/mocha": "^8.2.2",
+		"@types/ignore-walk": "^4.0.0",
+		"@types/jsonwebtoken": "^8.5.8",
+		"@types/mocha": "^8.2.3",
 		"@types/node": "^14.14.7",
 		"@types/swagger-ui-express": "^4.1.3",
 		"@types/yamljs": "^0.2.31",

package/src/index.ts

@@ -0,0 +1,9 @@
+export * from './deployment';
+export * from './language';
+export * from './login';
+export * from './package';
+export * from './plan';
+export * from './token';
+import metacallAPI from './protocol';
+export * from './protocol';
+export default metacallAPI;

package/src/package.ts

@@ -30,7 +30,7 @@ export const findFilesPath = async (
 		})
 	).filter(x => !x.startsWith('.git'));
 
-const pathIsMetaCallJson = (path: string): boolean =>
+export const pathIsMetaCallJson = (path: string): boolean =>
 	!!/^metacall(-.+)?\.json$/.exec(basename(path));
 
 export const findMetaCallJsons = (files: string[]): string[] =>

package/src/protocol.ts

@@ -37,7 +37,10 @@ export interface SubscriptionDeploy {
 	deploy: string;
 }
 
-export type ResourceType = 'Package' | 'Repository';
+export enum ResourceType {
+	Package = 'Package',
+	Repository = 'Repository'
+}
 
 export interface AddResponse {
 	id: string;
@@ -57,8 +60,8 @@ export interface API {
 	upload(
 		name: string,
 		blob: unknown,
-		jsons: MetaCallJSON[],
-		runners: string[]
+		jsons?: MetaCallJSON[],
+		runners?: string[]
 	): Promise<string>;
 	add(
 		url: string,
@@ -171,7 +174,7 @@ export default (token: string, baseURL: string): API => {
 				{
 					headers: {
 						Authorization: 'jwt ' + token,
-						...fd.getHeaders()
+						...(fd.getHeaders?.() ?? {}) // operator chaining to make it compatible with frontend
 					}
 				}
 			);