@adobe-apimesh/mesh-builder 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,40 @@
+# Mesh Builder
+
+Package with mesh artifacts building and compiling logic
+
+## Exports
+
+### validateMesh
+
+validateMesh(meshConfig: MeshConfig) => Promise<boolean>
+
+Validate Mesh function takes the `meshConfig` as argument and validates if the mesh confines with the CLI rules. Upon a successful validation the function resolves the returned promise. If validation fails, all reasons for invalidation will be thrown in the rejected promise.
+
+### buildMesh
+
+buildMesh(meshId: string, meshConfig: MeshConfig) => Promise<boolean | undefined>
+
+Build Mesh function takes the `meshId` and `meshConfig` as arguments and builds the mesh artifacts under the `mesh-artifact` folder in the current working directory under the `meshId` sub directory.
+
+Upon a successful build, `buildMesh` returns a Promise that resolves to `true` and `false` for a failure. `buildMesh` will throw `MeshBuildError` if there is a bulid error.
+
+### compileMesh
+
+compileMesh(meshId: string) => Promise<string[]>
+
+Compile Mesh function takes the `meshId` to find the built TypeScript mesh artifacts under the `mesh-artifact` folder and compiles them to JavaScript using the `typescript` package. It returns a Promise of JavaScript file paths that have been compiled and written to file system.
+
+## Types
+
+```ts
+buildMesh(meshId: string, meshConfig: MeshConfig) => Promise<boolean | undefined>
+
+compileMesh(meshId: string) => Promise<string[]>
+
+type MeshBuildError {
+    name: string;
+    stack?: string;
+    cause?: unknown;
+    requestId?: string;
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe-apimesh/mesh-builder",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": false,
   "main": "dist/meshBuilder.js",
   "license": "MIT",