Merge branch 'manifest-jsondoc' of https://github.com/fetsorn/monorepo …

…into fetsorn-manifest-jsondoc
polywrap · Jun 21, 2022 · 411c1a9 · 411c1a9
2 parents 55c73ea + fdda03b
commit 411c1a9
Show file tree

Hide file tree

Showing 46 changed files with 1,080 additions and 0 deletions.
diff --git a/packages/js/core/src/manifest/formats/polywrap.app/0.0.1-prealpha.1.ts b/packages/js/core/src/manifest/formats/polywrap.app/0.0.1-prealpha.1.ts
@@ -7,11 +7,29 @@
  */
 
 export interface AppManifest {
+  /**
+   * Polywrap app manifest format version.
+   */
   format: "0.0.1-prealpha.1";
+  /**
+   * Language in which the source code is written.
+   */
   language: string;
+  /**
+   * Path to graphql schema.
+   */
   schema: string;
+  /**
+   * Redirects enabling the import of plugins.
+   */
   import_redirects?: {
+    /**
+     * URI resolving to the plugin schema.
+     */
     uri: string;
+    /**
+     * Graphql schema for imported plugin.
+     */
     schema: string;
   }[];
   __type: "AppManifest";

diff --git a/packages/js/core/src/manifest/formats/polywrap.app/0.0.1-prealpha.2.ts b/packages/js/core/src/manifest/formats/polywrap.app/0.0.1-prealpha.2.ts
@@ -7,12 +7,33 @@
  */
 
 export interface AppManifest {
+  /**
+   * Polywrap app manifest format version.
+   */
   format: "0.0.1-prealpha.2";
+  /**
+   * Name of this wrapper package.
+   */
   name: string;
+  /**
+   * Language in which the source code is written.
+   */
   language: string;
+  /**
+   * Path to graphql schema.
+   */
   schema: string;
+  /**
+   * Redirects enabling the import of plugins.
+   */
   import_redirects?: {
+    /**
+     * URI resolving to the plugin schema.
+     */
     uri: string;
+    /**
+     * Graphql schema for imported plugin.
+     */
     schema: string;
   }[];
   __type: "AppManifest";

diff --git a/packages/js/core/src/manifest/formats/polywrap.build/0.0.1-prealpha.1.ts b/packages/js/core/src/manifest/formats/polywrap.build/0.0.1-prealpha.1.ts
@@ -7,12 +7,30 @@
  */
 
 export interface BuildManifest {
+  /**
+   * Polywrap build manifest format version.
+   */
   format: "0.0.1-prealpha.1";
+  /**
+   * Docker build artifact properties.
+   */
   docker?: {
+    /**
+     * Docker image name.
+     */
     name?: string;
+    /**
+     * Docker image file name.
+     */
     dockerfile?: string;
+    /**
+     * Id of the docker image.
+     */
     buildImageId?: string;
   };
+  /**
+   * Custom configuration.
+   */
   config?: {
     [k: string]: unknown;
   };

diff --git a/packages/js/core/src/manifest/formats/polywrap.build/0.0.1-prealpha.2.ts b/packages/js/core/src/manifest/formats/polywrap.build/0.0.1-prealpha.2.ts
@@ -7,18 +7,45 @@
  */
 
 export interface BuildManifest {
+  /**
+   * Polywrap build manifest format version.
+   */
   format: "0.0.1-prealpha.2";
   docker?: {
+    /**
+     * Docker image name.
+     */
     name?: string;
+    /**
+     * Docker image file name.
+     */
     dockerfile?: string;
+    /**
+     * Id of the docker image.
+     */
     buildImageId?: string;
   };
+  /**
+   * Custom configuration.
+   */
   config?: {
     [k: string]: unknown;
   };
+  /**
+   * Locally linked packages into docker build image.
+   */
   linked_packages?: {
+    /**
+     * Package name
+     */
     name: string;
+    /**
+     * Path to linked package directory.
+     */
     path: string;
+    /**
+     * Ignore files matching this regex in linked package directory.
+     */
     filter?: string;
   }[];
   __type: "BuildManifest";

diff --git a/packages/js/core/src/manifest/formats/polywrap.build/0.0.1-prealpha.3.ts b/packages/js/core/src/manifest/formats/polywrap.build/0.0.1-prealpha.3.ts
@@ -7,26 +7,68 @@
  */
 
 export interface BuildManifest {
+  /**
+   * Polywrap build manifest format version.
+   */
   format: "0.0.1-prealpha.3";
   docker?: {
+    /**
+     * Docker image name.
+     */
     name?: string;
+    /**
+     * Docker image file name.
+     */
     dockerfile?: string;
+    /**
+     * Id of the docker image.
+     */
     buildImageId?: string;
+    /**
+     * Configuration options for Docker Buildx, set to true for default value.
+     */
     buildx?:
       | {
+          /**
+           * Path to cache directory, set to true for default value, set to false to disable caching.
+           */
           cache?: string | boolean;
+          /**
+           * Path to cache directory, set to true or false for default value.
+           */
           output?: string | boolean;
+          /**
+           * Remove a builder instance.
+           */
           removeBuilder?: boolean;
         }
       | boolean;
+    /**
+     * Remove the image.
+     */
     removeImage?: boolean;
   };
+  /**
+   * Custom configuration.
+   */
   config?: {
     [k: string]: unknown;
   };
+  /**
+   * Locally linked packages into docker build image.
+   */
   linked_packages?: {
+    /**
+     * Package name.
+     */
     name: string;
+    /**
+     * Path to linked package directory.
+     */
     path: string;
+    /**
+     * Ignore files matching this regex in linked package directory.
+     */
     filter?: string;
   }[];
   __type: "BuildManifest";

diff --git a/packages/js/core/src/manifest/formats/polywrap.deploy/0.0.1-prealpha.1.ts b/packages/js/core/src/manifest/formats/polywrap.deploy/0.0.1-prealpha.1.ts
@@ -7,18 +7,35 @@
  */
 
 export interface DeployManifest {
+  /**
+   * Polywrap deployment manifest format version.
+   */
   format: "0.0.1-prealpha.1";
   stages: {
     /**
+     * Deployment stage.
+     *
      * This interface was referenced by `undefined`'s JSON-Schema definition
      * via the `patternProperty` "^.*$".
      */
     [k: string]: {
+      /**
+       * Name of the publisher plugin.
+       */
       package: string;
+      /**
+       * Custom configuration.
+       */
       config?: {
         [k: string]: unknown;
       };
+      /**
+       * Name of the required stage.
+       */
       depends_on?: string;
+      /**
+       * URI resolving to the publisher plugin.
+       */
       uri?: string;
     };
   };

diff --git a/packages/js/core/src/manifest/formats/polywrap.infra/0.0.1-prealpha.1.ts b/packages/js/core/src/manifest/formats/polywrap.infra/0.0.1-prealpha.1.ts
@@ -7,7 +7,13 @@
  */
 
 export interface InfraManifest {
+  /**
+   * Polywrap infra manifest format version.
+   */
   format: "0.0.1-prealpha.1";
+  /**
+   * Path to docker compose manifest.
+   */
   dockerCompose?: string;
   env?: {
     /**
@@ -25,12 +31,30 @@ export interface InfraManifest {
   };
   __type: "InfraManifest";
 }
+/**
+ * A remote docker-compose package.
+ */
 export interface RemoteModule {
+  /**
+   * Package name.
+   */
   package: string;
+  /**
+   * Package registry name.
+   */
   registry: string;
+  /**
+   * Package version.
+   */
   version: string;
+  /**
+   * Path to docker-compose file in the package directory.
+   */
   dockerComposePath?: string;
 }
 export interface LocalModule {
+  /**
+   * Path to the package.
+   */
   path: string;
 }
diff --git a/packages/js/core/src/manifest/formats/polywrap.infra/0.0.1-prealpha.2.ts b/packages/js/core/src/manifest/formats/polywrap.infra/0.0.1-prealpha.2.ts
@@ -6,10 +6,19 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
+/**
+ * A module available by default.
+ */
 export type DefaultModule = "default";
 
 export interface InfraManifest {
+  /**
+   * Polywrap infra manifest format version.
+   */
   format: "0.0.1-prealpha.2";
+  /**
+   * Path to docker compose manifest.
+   */
   dockerCompose?: string;
   env?: {
     /**
@@ -27,12 +36,33 @@ export interface InfraManifest {
   };
   __type: "InfraManifest";
 }
+/**
+ * A remote package with a docker-compose file.
+ */
 export interface RemoteModule {
+  /**
+   * Package name.
+   */
   package: string;
+  /**
+   * Package registry name.
+   */
   registry: string;
+  /**
+   * Package version.
+   */
   version: string;
+  /**
+   * Path to docker-compose file in the package directory.
+   */
   dockerComposePath?: string;
 }
+/**
+ * A local package with a docker-compose file.
+ */
 export interface LocalModule {
+  /**
+   * Path to the package.
+   */
   path: string;
 }