@madewithremy/admin 0.1.8 → 0.1.9

package/dist/prod.js

@@ -4605,6 +4605,17 @@ function mapTest(ctx, params) {
     }
   );
 }
+function mapDeploy(ctx, params) {
+  return call(
+    ctx,
+    "POST",
+    `${base5(ctx.appId)}/mapper/deploy`,
+    {
+      slug: params.slug,
+      ...params.releaseId ? { releaseId: params.releaseId } : {}
+    }
+  );
+}
 function remap(ctx, params) {
   return call(ctx, "POST", `${base5(ctx.appId)}/remap`, {
     slug: params.slug,
@@ -4668,6 +4679,13 @@ var dataSourceMappersSpecs = {
       message: "Name the objects: --store <name> [--prefix <p>], or --connector for the source's bucket."
     }
   },
+  "datasources map deploy": {
+    usage: "Usage: remy-admin datasources map deploy [--source <slug>] [--release <id>]",
+    flags: {
+      source: { type: "string" },
+      release: { type: "string" }
+    }
+  },
   "datasources remap": {
     usage: "Usage: remy-admin datasources remap [--source <slug>] [--budget <dollars>] [--limit <n>] [--wait] [--timeout <sec>]",
     flags: {
@@ -4782,7 +4800,7 @@ async function mapTest2(ctx, a) {
     dataSource: slug,
     ...result,
     results,
-    note: result.dev ? "Ran the LOCAL mapper through the dev session. Nothing was ingested; deploy to make it live." : "Ran the live release's mapper. Nothing was ingested."
+    note: result.dev ? "Ran the LOCAL mapper through the dev session. Nothing was ingested; push a branch, wait for its build, then `datasources map deploy` to make it the source's mapper." : "Ran the source's active mapper. Nothing was ingested."
   });
   if (result.counts.error > 0) {
     throw new CliError(
@@ -4791,6 +4809,22 @@ async function mapTest2(ctx, a) {
     );
   }
 }
+async function mapDeploy2(ctx, a) {
+  const slug = sourceOf(a);
+  const releaseId = a.str("release");
+  const result = await mapDeploy(ctx, {
+    slug,
+    ...releaseId ? { releaseId } : {}
+  });
+  const { mapper } = result;
+  const from = `${mapper.branch ?? "release"} @ ${(mapper.commitSha ?? "").slice(0, 7)}`;
+  out({
+    dataSource: slug,
+    mapper,
+    changed: result.changed,
+    note: result.changed ? `Active: the mapper compiled by ${from}. Jobs, syncs and add() run it from now on; \`remap\` re-applies it to what is already loaded.` : `Already active: the mapper compiled by ${from}. Nothing changed.`
+  });
+}
 async function remap2(ctx, a) {
   const slug = sourceOf(a);
   const budget = a.num("budget");
@@ -4830,7 +4864,7 @@ async function quarantine2(ctx, a) {
   });
   out({
     ...result,
-    note: result.counts.skipped + result.counts.errors === 0 ? "Nothing quarantined: the mapper produced documents (or deletions) for every object." : `Fix the mapper, deploy, then \`datasources jobs replay ${id}\` to run these through it again.`
+    note: result.counts.skipped + result.counts.errors === 0 ? "Nothing quarantined: the mapper produced documents (or deletions) for every object." : `Fix the mapper, push, \`datasources map deploy\`, then \`datasources jobs replay ${id}\` to run these through it again.`
   });
 }
 async function replay2(ctx, a) {
@@ -4860,6 +4894,7 @@ async function replay2(ctx, a) {
 var dataSourceMappersHandlers = {
   "datasources inspect": inspect2,
   "datasources map test": mapTest2,
+  "datasources map deploy": mapDeploy2,
   "datasources remap": remap2,
   "datasources jobs quarantine": quarantine2,
   "datasources jobs replay": replay2
@@ -4868,6 +4903,7 @@ var dataSourceMappersHelp = `
 Mapping raw objects into documents (mappers):
   remy-admin datasources inspect [--source <slug>] (--store <name> [--prefix <p>] | --connector) [--keys k1,k2] [--limit <n>]
   remy-admin datasources map test [--source <slug>] (--store <name> [--prefix <p>] | --connector) [--keys k1,k2] [--limit <n>] [--dev] [--full]
+  remy-admin datasources map deploy [--source <slug>] [--release <id>]
   remy-admin datasources remap [--source <slug>] [--budget <dollars>] [--limit <n>] [--wait] [--timeout <sec>]
   remy-admin datasources jobs quarantine <id> [--kind skip|error] [--reason <text>] [--cursor <id>] [--limit <n>]
   remy-admin datasources jobs replay <id> [--kind skip|error] [--wait] [--timeout <sec>]
@@ -4889,11 +4925,18 @@ Mapping raw objects into documents (mappers):
   JSON key signatures of ten sampled heads) before a line is written;
   \`map test --dev\` runs the LOCAL mapper through the running dev session
   over real objects and prints every outcome without ingesting anything;
-  deploy; a job or sync runs the compiled mapper; \`jobs quarantine <id>\`
-  lists what it skipped or failed on, by reason; fix, deploy, \`jobs replay
-  <id>\` runs just those objects again; \`remap\` re-applies a changed mapper
-  to every raw copy the source holds \u2014 no origin traffic, unchanged markdown
-  skipped by hash, changed documents superseding their predecessors.
+  push a branch and wait for its build (\`releases wait\`) \u2014 a mapper runs on
+  the platform, so the platform has to compile it, and a private branch
+  build is all it needs; \`map deploy\` makes that build's mapper the
+  source's active one (publishing to main activates the mapper main declares
+  too, so merge the branch before publishing); a job or sync runs it; \`jobs
+  quarantine <id>\` lists what it skipped or failed on, by reason; fix, push,
+  \`map deploy\`, \`jobs replay <id>\` runs just those objects again; \`remap\`
+  re-applies a changed mapper to every raw copy the source holds \u2014 no origin
+  traffic, unchanged markdown skipped by hash, changed documents superseding
+  their predecessors. \`jobs start\` refuses (mapper_not_deployed) while the
+  dev session declares a mapper that is not yet active: the job would have
+  loaded the raw records as documents.
 
   externalId is the identity the platform replaces by: a later object
   producing the same id supersedes the earlier document; \`replaces\` names
@@ -5446,7 +5489,8 @@ Subcommands:
   disconnect   Stop following the bucket; documents stay
   inspect      Profile raw objects (key shapes, types, sizes, JSON keys) before writing a mapper
   map test     Run a source's mapper over real objects and show the outcomes; nothing ingested
-  remap        Re-apply the live mapper to every raw copy the source holds
+  map deploy   Make a build's compiled mapper the source's active one (a branch build will do)
+  remap        Re-apply the active mapper to every raw copy the source holds
   hydrate      Reload an evicted index ahead of the first search
   sample       Draw a sample of a source into a new one with the same config
   eval         Query sets and runs: measure recall, MRR and latency, compare versions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madewithremy/admin",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "Admin SDK + CLI for managing production Remy apps",
   "type": "module",
   "main": "./dist/index.js",