@knocklabs/cli 0.2.5 → 0.3.1

package/dist/commands/branch/create.js

@@ -44,8 +44,6 @@ class BranchCreate extends _basecommand.default {
         this.log(`  Created at: ${data.created_at}`);
     }
 }
-// Hide until branches are released in GA
-_define_property(BranchCreate, "hidden", true);
 _define_property(BranchCreate, "summary", "Creates a new branch off of the development environment.");
 _define_property(BranchCreate, "enableJsonFlag", true);
 _define_property(BranchCreate, "args", {

package/dist/commands/branch/delete.js

@@ -44,8 +44,6 @@ class BranchDelete extends _basecommand.default {
         this.log(`‣ Successfully deleted branch \`${args.slug}\``);
     }
 }
-// Hide until branches are released in GA
-_define_property(BranchDelete, "hidden", true);
 _define_property(BranchDelete, "summary", "Deletes an existing branch with the given slug.");
 _define_property(BranchDelete, "args", {
     slug: _arg.CustomArgs.slug({

package/dist/commands/branch/exit.js

@@ -39,6 +39,4 @@ class BranchExit extends _basecommand.default {
         this.log("‣ Successfully exited the branch");
     }
 }
-// Hide until branches are released in GA
-_define_property(BranchExit, "hidden", true);
 _define_property(BranchExit, "summary", "Exits the current branch.");

package/dist/commands/branch/list.js

@@ -80,8 +80,6 @@ class BranchList extends _basecommand.default {
         }
     }
 }
-// Hide until branches are released in GA
-_define_property(BranchList, "hidden", true);
 _define_property(BranchList, "summary", "Display all existing branches off of the development environment.");
 _define_property(BranchList, "flags", {
     ..._page.pageFlags

package/dist/commands/branch/switch.js

@@ -142,8 +142,6 @@ class BranchSwitch extends _basecommand.default {
         });
     }
 }
-// Hide until branches are released in GA
-_define_property(BranchSwitch, "hidden", true);
 _define_property(BranchSwitch, "summary", "Switches to an existing branch with the given slug.");
 _define_property(BranchSwitch, "flags", {
     create: _core.Flags.boolean({

package/dist/commands/guide/pull.js

@@ -108,7 +108,9 @@ class GuidePull extends _basecommand.default {
             });
             return this.apiV1.getGuide(props);
         });
-        await _guide.writeGuideDirFromData(dirContext, resp.data);
+        await _guide.writeGuideDirFromData(dirContext, resp.data, {
+            withSchema: true
+        });
         const action = dirContext.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);
         this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath} using ${scope}`);
@@ -125,7 +127,9 @@ class GuidePull extends _basecommand.default {
         if (!input) return;
         _ux.spinner.start(`‣ Loading`);
         const guides = await this.listAllGuides();
-        await _guide.writeGuidesIndexDir(targetDirCtx, guides);
+        await _guide.writeGuidesIndexDir(targetDirCtx, guides, {
+            withSchema: true
+        });
         _ux.spinner.stop();
         const action = targetDirCtx.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);

package/dist/commands/guide/push.js

@@ -121,7 +121,9 @@ class GuidePush extends _basecommand.default {
                 // Update the guide directory with the successfully pushed guide
                 // payload from the server.
                 // eslint-disable-next-line no-await-in-loop
-                await _guide.writeGuideDirFromData(guide, resp.data.guide);
+                await _guide.writeGuideDirFromData(guide, resp.data.guide, {
+                    withSchema: true
+                });
                 continue;
             }
             const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _guide.guideJsonPath(guide), "ApiError");

package/dist/commands/layout/pull.js

@@ -109,7 +109,9 @@ class EmailLayoutPull extends _basecommand.default {
             });
             return this.apiV1.getEmailLayout(props);
         });
-        await _emaillayout.writeEmailLayoutDirFromData(dirContext, resp.data);
+        await _emaillayout.writeEmailLayoutDirFromData(dirContext, resp.data, {
+            withSchema: true
+        });
         const action = dirContext.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);
         this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath} using ${scope}`);
@@ -127,7 +129,9 @@ class EmailLayoutPull extends _basecommand.default {
         if (!input) return;
         _ux.spinner.start(`‣ Loading`);
         const emailLayouts = await this.listAllEmailLayouts();
-        await _emaillayout.writeEmailLayoutIndexDir(targetDirCtx, emailLayouts);
+        await _emaillayout.writeEmailLayoutIndexDir(targetDirCtx, emailLayouts, {
+            withSchema: true
+        });
         _ux.spinner.stop();
         const action = targetDirCtx.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);

package/dist/commands/layout/push.js

@@ -121,7 +121,9 @@ class EmailLayoutPush extends _basecommand.default {
                 // Update the layout directory with the successfully pushed layout
                 // payload from the server.
                 // eslint-disable-next-line no-await-in-loop
-                await _emaillayout.writeEmailLayoutDirFromData(layout, resp.data.email_layout);
+                await _emaillayout.writeEmailLayoutDirFromData(layout, resp.data.email_layout, {
+                    withSchema: true
+                });
                 continue;
             }
             const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _emaillayout.emailLayoutJsonPath(layout), "ApiError");

package/dist/commands/message-type/pull.js

@@ -112,7 +112,9 @@ class MessageTypePull extends _basecommand.default {
             });
             return this.apiV1.getMessageType(props);
         });
-        await _messagetype.writeMessageTypeDirFromData(dirContext, resp.data);
+        await _messagetype.writeMessageTypeDirFromData(dirContext, resp.data, {
+            withSchema: true
+        });
         const action = dirContext.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);
         this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath} using ${scope}`);
@@ -161,7 +163,9 @@ class MessageTypePull extends _basecommand.default {
         if (!input) return;
         _ux.spinner.start(`‣ Loading`);
         const messageTypes = await this.listAllMessageTypes();
-        await _messagetype.writeMessageTypesIndexDir(targetDirCtx, messageTypes);
+        await _messagetype.writeMessageTypesIndexDir(targetDirCtx, messageTypes, {
+            withSchema: true
+        });
         _ux.spinner.stop();
         const action = targetDirCtx.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);

package/dist/commands/message-type/push.js

@@ -121,7 +121,9 @@ class MessageTypePush extends _basecommand.default {
                 // Update the message type directory with the successfully pushed message
                 // type payload from the server.
                 // eslint-disable-next-line no-await-in-loop
-                await _messagetype.writeMessageTypeDirFromData(messageType, resp.data.message_type);
+                await _messagetype.writeMessageTypeDirFromData(messageType, resp.data.message_type, {
+                    withSchema: true
+                });
                 continue;
             }
             const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _messagetype.messageTypeJsonPath(messageType), "ApiError");

package/dist/commands/partial/pull.js

@@ -109,7 +109,9 @@ class PartialPull extends _basecommand.default {
             });
             return this.apiV1.getPartial(props);
         });
-        await _partial.writePartialDirFromData(dirContext, resp.data);
+        await _partial.writePartialDirFromData(dirContext, resp.data, {
+            withSchema: true
+        });
         const action = dirContext.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);
         this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath} using ${scope}`);
@@ -127,7 +129,9 @@ class PartialPull extends _basecommand.default {
         if (!input) return;
         _ux.spinner.start(`‣ Loading`);
         const partials = await this.listAllPartials();
-        await _partial.writePartialsIndexDir(targetDirCtx, partials);
+        await _partial.writePartialsIndexDir(targetDirCtx, partials, {
+            withSchema: true
+        });
         _ux.spinner.stop();
         const action = targetDirCtx.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);

package/dist/commands/partial/push.js

@@ -121,7 +121,9 @@ class PartialPush extends _basecommand.default {
                 // Update the partial directory with the successfully pushed partial
                 // payload from the server.
                 // eslint-disable-next-line no-await-in-loop
-                await _partial.writePartialDirFromData(partial, resp.data.partial);
+                await _partial.writePartialDirFromData(partial, resp.data.partial, {
+                    withSchema: true
+                });
                 continue;
             }
             const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _partial.partialJsonPath(partial), "ApiError");

package/dist/commands/workflow/pull.js

@@ -113,7 +113,9 @@ class WorkflowPull extends _basecommand.default {
             return this.apiV1.getWorkflow(props);
         });
         // 3. Write the fetched workflow to create or update the workflow directory.
-        await _workflow.writeWorkflowDirFromData(dirContext, resp.data);
+        await _workflow.writeWorkflowDirFromData(dirContext, resp.data, {
+            withSchema: true
+        });
         const action = dirContext.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);
         this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath} using ${scope}`);
@@ -162,7 +164,9 @@ class WorkflowPull extends _basecommand.default {
         // Fetch all workflows then write them to the local file system.
         _ux.spinner.start(`‣ Loading`);
         const workflows = await this.listAllWorkflows();
-        await _workflow.writeWorkflowsIndexDir(targetDirCtx, workflows);
+        await _workflow.writeWorkflowsIndexDir(targetDirCtx, workflows, {
+            withSchema: true
+        });
         _ux.spinner.stop();
         const action = targetDirCtx.exists ? "updated" : "created";
         const scope = (0, _command.formatCommandScope)(flags);

package/dist/commands/workflow/push.js

@@ -121,7 +121,9 @@ class WorkflowPush extends _basecommand.default {
                 // Update the workflow directory with the successfully pushed workflow
                 // payload from the server.
                 // eslint-disable-next-line no-await-in-loop
-                await _workflow.writeWorkflowDirFromData(workflow, resp.data.workflow);
+                await _workflow.writeWorkflowDirFromData(workflow, resp.data.workflow, {
+                    withSchema: true
+                });
                 continue;
             }
             const error = new _error.SourceError((0, _request.formatErrorRespMessage)(resp), _workflow.workflowJsonPath(workflow), "ApiError");

package/dist/lib/helpers/flag.js

@@ -148,8 +148,6 @@ const slug = _core.Flags.custom({
 });
 const branch = slug({
     summary: "The slug of the branch to use.",
-    // TODO Hide until branching is released in GA
-    hidden: true,
     // Memoize this flag's default. oclif runs this default function even when the flag is unused.
     // Using lodash's once avoids unnecessarily reading the branch file multiple times.
     default: (0, _lodash.once)(_branch.readSlugFromBranchFile)

package/dist/lib/marshal/email-layout/processor.isomorphic.js

@@ -38,8 +38,9 @@ const compileExtractionSettings = (emailLayout)=>{
     }
     return map;
 };
-const buildEmailLayoutDirBundle = (remoteEmailLayout, localEmailLayout = {})=>{
+const buildEmailLayoutDirBundle = (remoteEmailLayout, localEmailLayout, $schema)=>{
     const bundle = {};
+    localEmailLayout = localEmailLayout || {};
     const mutRemoteEmailLayout = (0, _lodash.cloneDeep)(remoteEmailLayout);
     // A map of extraction settings of every field in the email layout
     const compiledExtractionSettings = compileExtractionSettings(mutRemoteEmailLayout);
@@ -75,5 +76,5 @@ const buildEmailLayoutDirBundle = (remoteEmailLayout, localEmailLayout = {})=>{
     // the layout JSON realtive path + the file content.
     return (0, _lodash.set)(bundle, [
         LAYOUT_JSON
-    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemoteEmailLayout));
+    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemoteEmailLayout, $schema));
 };

package/dist/lib/marshal/email-layout/writer.js

@@ -73,13 +73,15 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout)=>{
+const EMAIL_LAYOUT_SCHEMA = "https://schemas.knock.app/cli/email-layout.json";
+const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout, options)=>{
+    const { withSchema = false } = options || {};
     // If the layout directory exists on the file system (i.e. previously
     // pulled before), then read the layout file to use as a reference.
     const [localEmailLayout] = emailLayoutDirCtx.exists ? await (0, _reader.readEmailLayoutDir)(emailLayoutDirCtx, {
         withExtractedFiles: true
     }) : [];
-    const bundle = (0, _processorisomorphic.buildEmailLayoutDirBundle)(remoteEmailLayout, localEmailLayout);
+    const bundle = (0, _processorisomorphic.buildEmailLayoutDirBundle)(remoteEmailLayout, localEmailLayout, withSchema ? EMAIL_LAYOUT_SCHEMA : undefined);
     const backupDirPath = _nodepath.default.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
         // We store a backup in case there's an error.
@@ -109,7 +111,7 @@ const writeEmailLayoutDirFromData = async (emailLayoutDirCtx, remoteEmailLayout)
         await _fsextra.remove(backupDirPath);
     }
 };
-const writeEmailLayoutIndexDir = async (indexDirCtx, remoteEmailLayouts)=>{
+const writeEmailLayoutIndexDir = async (indexDirCtx, remoteEmailLayouts, options)=>{
     const backupDirPath = _nodepath.default.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
         if (indexDirCtx.exists) {
@@ -124,7 +126,7 @@ const writeEmailLayoutIndexDir = async (indexDirCtx, remoteEmailLayouts)=>{
                 abspath: emailLayoutDirPath,
                 exists: indexDirCtx.exists ? await (0, _helpers.isEmailLayoutDir)(emailLayoutDirPath) : false
             };
-            return writeEmailLayoutDirFromData(emailLayoutDirCtx, remoteEmailLayout);
+            return writeEmailLayoutDirFromData(emailLayoutDirCtx, remoteEmailLayout, options);
         });
         await Promise.all(writeEmailLayoutDirPromises);
     } catch (error) {

package/dist/lib/marshal/guide/processor.isomorphic.js

@@ -45,8 +45,9 @@ const compileExtractionSettings = (guide)=>{
     }
     return map;
 };
-const buildGuideDirBundle = (remoteGuide, localGuide = {})=>{
+const buildGuideDirBundle = (remoteGuide, localGuide, $schema)=>{
     const bundle = {};
+    localGuide = localGuide || {};
     const mutRemoteGuide = (0, _lodash.cloneDeep)(remoteGuide);
     // A map of extraction settings of every field in the guide.
     const compiledExtractionSettings = compileExtractionSettings(mutRemoteGuide);
@@ -81,5 +82,5 @@ const buildGuideDirBundle = (remoteGuide, localGuide = {})=>{
     // the guide JSON relative path + the file content.
     return (0, _lodash.set)(bundle, [
         GUIDE_JSON
-    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemoteGuide));
+    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemoteGuide, $schema));
 };

package/dist/lib/marshal/guide/writer.js

@@ -68,13 +68,15 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const writeGuideDirFromData = async (guideDirCtx, remoteGuide)=>{
+const GUIDE_SCHEMA = "https://schemas.knock.app/cli/guide.json";
+const writeGuideDirFromData = async (guideDirCtx, remoteGuide, options)=>{
+    const { withSchema = false } = options || {};
     // If the guide directory exists on the file system (i.e. previously
     // pulled before), then read the guide file to use as a reference.
     const [localGuide] = guideDirCtx.exists ? await (0, _reader.readGuideDir)(guideDirCtx, {
         withExtractedFiles: true
     }) : [];
-    const bundle = (0, _processorisomorphic.buildGuideDirBundle)(remoteGuide, localGuide);
+    const bundle = (0, _processorisomorphic.buildGuideDirBundle)(remoteGuide, localGuide, withSchema ? GUIDE_SCHEMA : undefined);
     return writeGuideDirFromBundle(guideDirCtx, bundle);
 };
 /*
@@ -136,7 +138,7 @@ const writeGuideDirFromData = async (guideDirCtx, remoteGuide)=>{
     });
     await Promise.all(promises);
 };
-const writeGuidesIndexDir = async (indexDirCtx, remoteGuides)=>{
+const writeGuidesIndexDir = async (indexDirCtx, remoteGuides, options)=>{
     const backupDirPath = _nodepath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
         // If the index directory already exists, back it up in the temp sandbox
@@ -154,7 +156,7 @@ const writeGuidesIndexDir = async (indexDirCtx, remoteGuides)=>{
                 abspath: guideDirPath,
                 exists: indexDirCtx.exists ? await (0, _helpers.isGuideDir)(guideDirPath) : false
             };
-            return writeGuideDirFromData(guideDirCtx, guide);
+            return writeGuideDirFromData(guideDirCtx, guide, options);
         });
         await Promise.all(writeGuideDirPromises);
     } catch (error) {

package/dist/lib/marshal/message-type/processor.isomorphic.js

@@ -38,9 +38,10 @@ const compileExtractionSettings = (messageType)=>{
     }
     return map;
 };
-const buildMessageTypeDirBundle = (remoteMessageType, localMessageType = {})=>{
+const buildMessageTypeDirBundle = (remoteMessageType, localMessageType, $schema)=>{
     const bundle = {};
     const mutRemoteMessageType = (0, _lodash.cloneDeep)(remoteMessageType);
+    localMessageType = localMessageType || {};
     // A map of extraction settings of every field in the message type
     const compiledExtractionSettings = compileExtractionSettings(mutRemoteMessageType);
     // Iterate through each extractable field, determine whether we need to
@@ -74,5 +75,5 @@ const buildMessageTypeDirBundle = (remoteMessageType, localMessageType = {})=>{
     // the message type JSON relative path + the file content.
     return (0, _lodash.set)(bundle, [
         MESSAGE_TYPE_JSON
-    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemoteMessageType));
+    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemoteMessageType, $schema));
 };

package/dist/lib/marshal/message-type/writer.js

@@ -68,13 +68,15 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const writeMessageTypeDirFromData = async (messageTypeDirCtx, remoteMessageType)=>{
+const MESSAGE_TYPE_SCHEMA = "https://schemas.knock.app/cli/message-type.json";
+const writeMessageTypeDirFromData = async (messageTypeDirCtx, remoteMessageType, options)=>{
+    const { withSchema = false } = options || {};
     // If the message type directory exists on the file system (i.e. previously
     // pulled before), then read the message type file to use as a reference.
     const [localMessageType] = messageTypeDirCtx.exists ? await (0, _reader.readMessageTypeDir)(messageTypeDirCtx, {
         withExtractedFiles: true
     }) : [];
-    const bundle = (0, _processorisomorphic.buildMessageTypeDirBundle)(remoteMessageType, localMessageType);
+    const bundle = (0, _processorisomorphic.buildMessageTypeDirBundle)(remoteMessageType, localMessageType, withSchema ? MESSAGE_TYPE_SCHEMA : undefined);
     return writeMessageTypeDirFromBundle(messageTypeDirCtx, bundle);
 };
 /*
@@ -136,7 +138,7 @@ const writeMessageTypeDirFromData = async (messageTypeDirCtx, remoteMessageType)
     });
     await Promise.all(promises);
 };
-const writeMessageTypesIndexDir = async (indexDirCtx, remoteMessageTypes)=>{
+const writeMessageTypesIndexDir = async (indexDirCtx, remoteMessageTypes, options)=>{
     const backupDirPath = _nodepath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
         // If the index directory already exists, back it up in the temp sandbox
@@ -154,7 +156,7 @@ const writeMessageTypesIndexDir = async (indexDirCtx, remoteMessageTypes)=>{
                 abspath: messageTypeDirPath,
                 exists: indexDirCtx.exists ? await (0, _helpers.isMessageTypeDir)(messageTypeDirPath) : false
             };
-            return writeMessageTypeDirFromData(messageTypeDirCtx, messageType);
+            return writeMessageTypeDirFromData(messageTypeDirCtx, messageType, options);
         });
         await Promise.all(promises);
     } catch (error) {

package/dist/lib/marshal/partial/processor.isomorphic.js

@@ -61,8 +61,9 @@ const compileExtractionSettings = (partial)=>{
     }
     return map;
 };
-const buildPartialDirBundle = (remotePartial, localPartial = {})=>{
+const buildPartialDirBundle = (remotePartial, localPartial, $schema)=>{
     const bundle = {};
+    localPartial = localPartial || {};
     const mutRemotePartial = (0, _lodash.cloneDeep)(remotePartial);
     // A map of extraction settings of every field in the partial
     const compiledExtractionSettings = compileExtractionSettings(mutRemotePartial);
@@ -97,5 +98,5 @@ const buildPartialDirBundle = (remotePartial, localPartial = {})=>{
     // the partial JSON relative path + the file content.
     return (0, _lodash.set)(bundle, [
         PARTIAL_JSON
-    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemotePartial));
+    ], (0, _helpersisomorphic.prepareResourceJson)(mutRemotePartial, $schema));
 };

package/dist/lib/marshal/partial/writer.js

@@ -68,13 +68,15 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const writePartialDirFromData = async (partialDirCtx, remotePartial)=>{
+const PARTIAL_SCHEMA = "https://schemas.knock.app/cli/partial.json";
+const writePartialDirFromData = async (partialDirCtx, remotePartial, options)=>{
+    const { withSchema = false } = options || {};
     // If the partial directory exists on the file system (i.e. previously
     // pulled before), then read the partial file to use as a reference.
     const [localPartial] = partialDirCtx.exists ? await (0, _reader.readPartialDir)(partialDirCtx, {
         withExtractedFiles: true
     }) : [];
-    const bundle = (0, _processorisomorphic.buildPartialDirBundle)(remotePartial, localPartial);
+    const bundle = (0, _processorisomorphic.buildPartialDirBundle)(remotePartial, localPartial, withSchema ? PARTIAL_SCHEMA : undefined);
     return writePartialDirFromBundle(partialDirCtx, bundle);
 };
 /*
@@ -136,7 +138,7 @@ const writePartialDirFromData = async (partialDirCtx, remotePartial)=>{
     });
     await Promise.all(promises);
 };
-const writePartialsIndexDir = async (indexDirCtx, remotePartials)=>{
+const writePartialsIndexDir = async (indexDirCtx, remotePartials, options)=>{
     const backupDirPath = _nodepath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
         // If the index directory already exists, back it up in the temp sandbox
@@ -154,7 +156,7 @@ const writePartialsIndexDir = async (indexDirCtx, remotePartials)=>{
                 abspath: partialDirPath,
                 exists: indexDirCtx.exists ? await (0, _helpers.isPartialDir)(partialDirPath) : false
             };
-            return writePartialDirFromData(partialDirCtx, partial);
+            return writePartialDirFromData(partialDirCtx, partial, options);
         });
         await Promise.all(writePartialDirPromises);
     } catch (error) {

package/dist/lib/marshal/shared/helpers.isomorphic.js

@@ -15,7 +15,7 @@ const REMOVED_READONLY_FIELDS = [
     "sha",
     "updated_at"
 ];
-const prepareResourceJson = (resource)=>{
+const prepareResourceJson = (resource, $schema)=>{
     var _resource___annotation;
     const readonlyFields = ((_resource___annotation = resource.__annotation) === null || _resource___annotation === void 0 ? void 0 : _resource___annotation.readonly_fields) || [];
     const [readonly, remainder] = (0, _objectisomorphic.split)(resource, readonlyFields);
@@ -25,6 +25,12 @@ const prepareResourceJson = (resource)=>{
         ...remainder,
         __readonly: filteredReadonlyFields
     };
+    // Append the $schema property to the resource JSON if it is provided.
+    if ($schema) {
+        Object.assign(resourceJson, {
+            $schema
+        });
+    }
     // Strip out all schema annotations, so not to expose them to end users.
     return (0, _objectisomorphic.omitDeep)(resourceJson, [
         "__annotation"

package/dist/lib/marshal/workflow/processor.isomorphic.js

@@ -250,8 +250,9 @@ const recursivelyBuildWorkflowDirBundle = (bundle, steps, localWorkflowStepsByRe
         }
     }
 };
-const buildWorkflowDirBundle = (remoteWorkflow, localWorkflow = {})=>{
+const buildWorkflowDirBundle = (remoteWorkflow, localWorkflow, $schema)=>{
     const bundle = {};
+    localWorkflow = localWorkflow || {};
     const mutWorkflow = (0, _lodash.cloneDeep)(remoteWorkflow);
     const localWorkflowStepsByRef = keyLocalWorkflowStepsByRef(localWorkflow.steps);
     // Recursively traverse the workflow step tree, mutating it and the bundle
@@ -260,5 +261,5 @@ const buildWorkflowDirBundle = (remoteWorkflow, localWorkflow = {})=>{
     // Then, prepare the workflow data to be written into a workflow json file.
     return (0, _lodash.set)(bundle, [
         WORKFLOW_JSON
-    ], (0, _helpersisomorphic.prepareResourceJson)(mutWorkflow));
+    ], (0, _helpersisomorphic.prepareResourceJson)(mutWorkflow, $schema));
 };

package/dist/lib/marshal/workflow/writer.js

@@ -71,13 +71,15 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const writeWorkflowDirFromData = async (workflowDirCtx, remoteWorkflow)=>{
+const WORKFLOW_SCHEMA = "https://schemas.knock.app/cli/workflow.json";
+const writeWorkflowDirFromData = async (workflowDirCtx, remoteWorkflow, options)=>{
+    const { withSchema = false } = options || {};
     // If the workflow directory exists on the file system (i.e. previously
     // pulled before), then read the workflow file to use as a reference.
     const [localWorkflow] = workflowDirCtx.exists ? await (0, _reader.readWorkflowDir)(workflowDirCtx, {
         withExtractedFiles: true
     }) : [];
-    const bundle = (0, _processorisomorphic.buildWorkflowDirBundle)(remoteWorkflow, localWorkflow);
+    const bundle = (0, _processorisomorphic.buildWorkflowDirBundle)(remoteWorkflow, localWorkflow, withSchema ? WORKFLOW_SCHEMA : undefined);
     return writeWorkflowDirFromBundle(workflowDirCtx, bundle);
 };
 const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
@@ -132,7 +134,7 @@ const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
     });
     await Promise.all(promises);
 };
-const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
+const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows, options)=>{
     const backupDirPath = _nodepath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
         // If the index directory already exists, back it up in the temp sandbox
@@ -150,7 +152,7 @@ const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
                 abspath: workflowDirPath,
                 exists: indexDirCtx.exists ? await (0, _helpers.isWorkflowDir)(workflowDirPath) : false
             };
-            return writeWorkflowDirFromData(workflowDirCtx, workflow);
+            return writeWorkflowDirFromData(workflowDirCtx, workflow, options);
         });
         await Promise.all(writeWorkflowDirPromises);
     } catch (error) {