@robbeverhelst/do 1.391.0 → 1.392.0

package/dist/do.js

@@ -14420,7 +14420,7 @@ var configError = (message) => new CliError("config", message, EXIT.CONFIG);
 
 // src/meta.ts
 var CLI_NAME = "do";
-var VERSION = "1.391.0";
+var VERSION = "1.392.0";
 var API_PREFIX = "/api/v1";
 var DEFAULT_API_URL = "http://localhost:3001";
 
@@ -23933,6 +23933,24 @@ var collectionSavedViews = pgTable("collection_saved_views", {
 }, (t) => [
   index("collection_saved_views_tenant_idx").on(t.tenantId)
 ]);
+var collectionKinds = pgTable("collection_kinds", {
+  id: text("id").primaryKey(),
+  tenantId: text("tenant_id").notNull().references(() => tenants.id),
+  key: text("key").notNull(),
+  name: text("name").notNull(),
+  one: text("one").notNull(),
+  many: text("many").notNull(),
+  icon: text("icon").notNull().default("tag"),
+  preset: text("preset"),
+  fields: jsonb("fields").$type().notNull().default([]),
+  statusWords: jsonb("status_words").$type().notNull(),
+  view: text("view").notNull().default("grid"),
+  createdByUserId: text("created_by_user_id").references(() => users.id, {
+    onDelete: "set null"
+  }),
+  createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow(),
+  updatedAt: timestamp("updated_at", { withTimezone: true }).notNull().defaultNow()
+}, (t) => [unique("collection_kinds_tenant_key_uniq").on(t.tenantId, t.key)]);
 
 // ../../packages/schema/src/contracts/collection-values.ts
 var collectionStatusValues = ["want", "have", "doing", "done", "dropped", "gone"];
@@ -26139,6 +26157,162 @@ var circleOperations = defineOperations({
   })
 });
 
+// ../../packages/schema/src/contracts/collection-kinds.ts
+var collectionKindFieldTypeValues = [
+  "text",
+  "number",
+  "choice",
+  "year",
+  "date",
+  "yesno"
+];
+var collectionKindFieldTypeSchema = _enum2(collectionKindFieldTypeValues);
+var collectionKindIconValues = [
+  "disc",
+  "dice",
+  "brick",
+  "book",
+  "pad",
+  "sprout",
+  "paw",
+  "tag"
+];
+var collectionKindIconSchema = _enum2(collectionKindIconValues);
+var collectionKindPresetValues = ["lego", "vinyl", "board", "custom"];
+var collectionKindPresetSchema = _enum2(collectionKindPresetValues);
+var slug = string2().min(1).max(40).regex(/^[a-z0-9]+(-[a-z0-9]+)*$/, "lowercase letters and digits, dashes between");
+var collectionKindKeySchema = slug.refine((k) => !collectionTypeValues.includes(k), "that's a built-in kind");
+var collectionKindFieldSchema = object({
+  key: slug,
+  label: string2().trim().min(1).max(40),
+  type: collectionKindFieldTypeSchema,
+  choices: array(string2().trim().min(1).max(40)).max(30).optional()
+}).strict().refine((f) => f.type === "choice" || f.choices === undefined, {
+  message: "only a choice field has choices",
+  path: ["choices"]
+});
+var collectionKindFieldsSchema = array(collectionKindFieldSchema).max(12).refine((fs) => new Set(fs.map((f) => f.key)).size === fs.length, "each field key once");
+var word = string2().trim().min(1).max(30);
+var collectionKindStatusWordsSchema = object({ want: word, have: word, doing: word, done: word, dropped: word }).strict();
+var collectionKindSchema = object({
+  id: ulidSchema,
+  key: string2(),
+  name: string2(),
+  one: string2(),
+  many: string2(),
+  icon: string2(),
+  preset: string2().nullable(),
+  fields: array(object({
+    key: string2(),
+    label: string2(),
+    type: string2(),
+    choices: array(string2()).optional()
+  })),
+  statusWords: collectionKindStatusWordsSchema,
+  view: string2(),
+  itemCount: number2().int(),
+  createdAt: exports_coerce.date(),
+  updatedAt: exports_coerce.date()
+});
+var name2 = string2().trim().min(1).max(40);
+var createCollectionKindInputSchema = object({
+  id: ulidSchema,
+  name: name2,
+  key: collectionKindKeySchema.optional(),
+  one: name2.optional(),
+  many: name2.optional(),
+  icon: collectionKindIconSchema.optional(),
+  preset: collectionKindPresetSchema.optional(),
+  fields: collectionKindFieldsSchema.optional(),
+  statusWords: collectionKindStatusWordsSchema.optional()
+}).strict();
+var updateCollectionKindInputSchema = object({
+  name: name2.optional(),
+  one: name2.optional(),
+  many: name2.optional(),
+  icon: collectionKindIconSchema.optional(),
+  fields: collectionKindFieldsSchema.optional(),
+  statusWords: collectionKindStatusWordsSchema.optional()
+}).strict();
+var f = (label, type) => ({
+  key: kindSlug(label),
+  label,
+  type
+});
+var COLLECTION_KIND_PRESETS = {
+  lego: {
+    name: "LEGO",
+    one: "set",
+    icon: "brick",
+    fields: [
+      f("Set number", "text"),
+      f("Pieces", "number"),
+      f("Theme", "choice"),
+      f("Bags", "number"),
+      f("Minifigures", "number"),
+      f("Released", "year")
+    ],
+    statusWords: {
+      want: "Want",
+      have: "In the box",
+      doing: "Building",
+      done: "Built",
+      dropped: "Parted out"
+    }
+  },
+  vinyl: {
+    name: "Vinyl",
+    one: "record",
+    icon: "disc",
+    fields: [
+      f("Artist", "text"),
+      f("Label", "choice"),
+      f("Pressing", "text"),
+      f("Speed", "number"),
+      f("Condition", "choice"),
+      f("Released", "year")
+    ],
+    statusWords: {
+      want: "Want",
+      have: "Have",
+      doing: "On rotation",
+      done: "Played out",
+      dropped: "Sold"
+    }
+  },
+  board: {
+    name: "Board games",
+    one: "board game",
+    icon: "dice",
+    fields: [
+      f("Players", "number"),
+      f("Play time", "text"),
+      f("Designer", "text"),
+      f("Expansions", "text"),
+      f("Plays", "number"),
+      f("Released", "year")
+    ],
+    statusWords: {
+      want: "Want",
+      have: "Have",
+      doing: "Learning",
+      done: "Played",
+      dropped: "Gave away"
+    }
+  },
+  custom: {
+    name: "",
+    one: "",
+    icon: "tag",
+    fields: [f("Maker", "text"), f("Year", "year"), f("Condition", "choice")],
+    statusWords: { want: "Want", have: "Have", doing: "Using", done: "Done", dropped: "Gone" }
+  }
+};
+function kindSlug(name) {
+  const s = name.toLowerCase().normalize("NFKD").replace(/[\u0300-\u036F]/g, "").replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "").slice(0, 40).replace(/-+$/, "");
+  return s || "kind";
+}
+
 // ../../packages/schema/src/contracts/pagination.ts
 var paginationQuerySchema = object({
   limit: exports_coerce.number().int().positive().optional(),
@@ -26149,6 +26323,7 @@ var paginationQuerySchema = object({
 var READ2 = ["collections:read"];
 var WRITE2 = ["collections:write"];
 var entryParams = { entryId: "The entry's ULID." };
+var kindParams = { kindId: "The kind's ULID." };
 var collectionOperations = defineOperations({
   ...crudOperations({
     segment: "collection",
@@ -26204,6 +26379,65 @@ var collectionOperations = defineOperations({
     status: 200,
     response: { description: "The Type registry." }
   },
+  listKinds: {
+    method: "get",
+    path: "/collection/kinds",
+    scopes: READ2,
+    tag: "Collection",
+    summary: "List the Space's own kinds",
+    description: "The kinds the Space added (vinyl, board games, \u2026) beside the built-in Types, by name: each with its `key` (what an Item of it carries as its `type`), `name`, `one`/`many`, `icon`, the `preset` it started from, its `fields` (key, label, type: `text`, `number`, `choice`, `year`, `date` or `yesno`, and a choice field's `choices`; the first three show on its tile), its `statusWords` for want, have, doing, done and dropped, its `view` (`grid`) and `itemCount`.",
+    status: 200,
+    response: { description: "The kinds." }
+  },
+  createKind: {
+    method: "post",
+    path: "/collection/kinds",
+    scopes: WRITE2,
+    tag: "Collection",
+    summary: "Add a kind",
+    description: "Start from a `preset` (`lego`, `vinyl`, `board` or `custom`, \"Something else\") and a `name`; what's left out comes from the preset (the icon, the fields, the status words), the `key` is the name's slug (never a built-in Type; 409 when the Space has it) and `one`/`many` come from the name. It starts on the clean grid.",
+    body: createCollectionKindInputSchema,
+    status: 201,
+    response: { description: "The kind." },
+    errors: { 400: true, 409: "The Space already has a kind with this key." }
+  },
+  getKind: {
+    method: "get",
+    path: "/collection/kinds/{kindId}",
+    pathParams: kindParams,
+    scopes: READ2,
+    tag: "Collection",
+    summary: "A kind of the Space's own",
+    description: "The same shape as a row of the list.",
+    status: 200,
+    response: { description: "The kind." },
+    errors: { 404: true }
+  },
+  updateKind: {
+    method: "patch",
+    path: "/collection/kinds/{kindId}",
+    pathParams: kindParams,
+    scopes: WRITE2,
+    tag: "Collection",
+    summary: "Change a kind",
+    description: "Its name, one/many, icon, `fields` (replaces the list) or `statusWords`; a field left out stays. The key never changes.",
+    body: updateCollectionKindInputSchema,
+    status: 200,
+    response: { description: "The kind." },
+    errors: { 400: true, 404: true }
+  },
+  removeKind: {
+    method: "delete",
+    path: "/collection/kinds/{kindId}",
+    pathParams: kindParams,
+    scopes: WRITE2,
+    tag: "Collection",
+    summary: "Remove a kind",
+    description: "Only a kind with no Items (409 otherwise: move or remove them first).",
+    status: 204,
+    response: { description: "Removed." },
+    errors: { 404: true, 409: "The kind still has Items." }
+  },
   backfillCovers: {
     method: "post",
     path: "/collection/covers",
@@ -40340,18 +40574,18 @@ var runPlayStatusValues = [
   "dropped"
 ];
 var runPlayStatusSchema = _enum2(runPlayStatusValues);
-var name2 = string2().trim().min(1).max(200);
+var name3 = string2().trim().min(1).max(200);
 var text5 = string2().trim().max(2000);
 var shortText2 = string2().trim().max(300);
 var isoDate = string2().regex(/^\d{4}-\d{2}-\d{2}$/, "must be an ISO date (YYYY-MM-DD)");
 var ref = string2().trim().min(1).max(200);
 var runCharacterSchema = object({
-  name: name2,
+  name: name3,
   pronoun: _enum2(["he", "she", "they"]).nullish(),
   subtitle: shortText2.nullish(),
   level: number2().int().min(0).max(1e4).nullish(),
   build: shortText2.nullish(),
-  stats: array(object({ k: name2, v: union([number2(), shortText2]) }).strict()).max(40).optional(),
+  stats: array(object({ k: name3, v: union([number2(), shortText2]) }).strict()).max(40).optional(),
   traits: array(shortText2).max(20).optional(),
   backstory: text5.nullish(),
   rules: array(shortText2).max(30).optional(),
@@ -40360,12 +40594,12 @@ var runCharacterSchema = object({
 var runArcSchema = object({
   title: shortText2.nullish(),
   chapters: array(object({
-    key: name2,
-    name: name2,
+    key: name3,
+    name: name3,
     range: shortText2.nullish(),
     moral: text5.nullish()
   }).strict()).max(40),
-  current: name2.nullish()
+  current: name3.nullish()
 }).strict();
 var runStepStatusValues = ["done", "now", "todo", "skipped"];
 var runStepStatusSchema = _enum2(runStepStatusValues);
@@ -40378,7 +40612,7 @@ var runQuestStatusValues = ["active", "paused", "planned", "done", "failed"];
 var runQuestStatusSchema = _enum2(runQuestStatusValues);
 var runQuestSchema = object({
   ref: ref.nullish(),
-  name: name2,
+  name: name3,
   line: shortText2.nullish(),
   status: runQuestStatusSchema.default("active"),
   objective: text5.nullish(),
@@ -40393,7 +40627,7 @@ var runQuestSchema = object({
   }).strict()).max(40).optional(),
   pausedAt: shortText2.nullish(),
   why: text5.nullish(),
-  revisitAt: name2.nullish()
+  revisitAt: name3.nullish()
 }).strict();
 var runNextStepsSchema = object({
   items: array(shortText2.pipe(string2().min(1))).max(3),
@@ -40402,50 +40636,50 @@ var runNextStepsSchema = object({
 }).strict();
 var runChoiceSchema = object({
   ref: ref.nullish(),
-  title: name2,
+  title: name3,
   place: shortText2.nullish(),
   status: _enum2(["made", "planned"]).default("made"),
   options: array(shortText2).max(6).optional(),
   why: text5.nullish(),
   consequence: text5.nullish(),
-  revisitAt: name2.nullish(),
-  chapter: name2.nullish(),
+  revisitAt: name3.nullish(),
+  chapter: name3.nullish(),
   tone: _enum2(["good", "grey", "dark"]).nullish(),
   on: isoDate.nullish()
 }).strict();
 var runHomeSchema = object({
   ref: ref.nullish(),
-  name: name2,
+  name: name3,
   role: _enum2(["home", "collector", "storage", "planned", "later"]).default("home"),
   place: shortText2.nullish(),
-  upgrades: array(object({ name: name2, done: boolean2().default(false) }).strict()).max(40).optional(),
+  upgrades: array(object({ name: name3, done: boolean2().default(false) }).strict()).max(40).optional(),
   steward: shortText2.nullish(),
   note: text5.nullish()
 }).strict();
 var runPersonSchema = object({
   ref: ref.nullish(),
-  name: name2,
+  name: name3,
   role: _enum2(["child", "spouse", "steward", "follower", "pet", "rival", "other"]),
   status: _enum2(["with", "planned", "lost"]).default("with"),
   home: shortText2.nullish(),
   note: text5.nullish()
 }).strict();
 var runMountSchema = object({
-  name: name2,
+  name: name3,
   status: _enum2(["with", "planned", "lost"]).default("with"),
   note: text5.nullish()
 }).strict();
 var runUniqueSchema = object({
   ref: ref.nullish(),
-  name: name2,
+  name: name3,
   status: _enum2(["have", "now", "want"]).default("have"),
   source: shortText2.nullish(),
   displayAt: shortText2.nullish(),
-  set: name2.nullish()
+  set: name3.nullish()
 }).strict();
 var runChecklistSchema = object({
   key: string2().trim().min(1).max(60).regex(/^[a-z0-9][a-z0-9_-]*$/, "must be a lowercase slug"),
-  label: name2,
+  label: name3,
   total: number2().int().min(0).max(5000).nullish(),
   items: array(object({ id: ref, label: shortText2.nullish() }).strict()).max(5000).optional(),
   done: array(ref).max(5000),
@@ -40454,7 +40688,7 @@ var runChecklistSchema = object({
   legend: shortText2.nullish()
 }).strict();
 var runTeamMemberSchema = object({
-  species: name2,
+  species: name3,
   nick: shortText2.nullish(),
   level: number2().int().min(1).max(100).nullish(),
   nature: shortText2.nullish(),
@@ -40468,8 +40702,8 @@ var runAchievementsSchema = object({
   source: _enum2(["steam", "xbox", "psn", "manual"]).default("manual"),
   total: number2().int().min(0).max(5000).nullish(),
   enabled: boolean2().default(true),
-  unlocked: array(object({ name: name2, on: isoDate.nullish(), hint: shortText2.nullish(), key: ref.nullish() }).strict()).max(5000),
-  locked: array(object({ name: name2, hint: shortText2.nullish(), key: ref.nullish() }).strict()).max(5000).optional(),
+  unlocked: array(object({ name: name3, on: isoDate.nullish(), hint: shortText2.nullish(), key: ref.nullish() }).strict()).max(5000),
+  locked: array(object({ name: name3, hint: shortText2.nullish(), key: ref.nullish() }).strict()).max(5000).optional(),
   syncedAt: string2().datetime({ offset: true }).nullish()
 }).strict();
 var runRareFindsSchema = object({
@@ -40479,7 +40713,7 @@ var runRareFindsSchema = object({
 }).strict();
 var runInstallSchema = object({
   edition: shortText2.nullish(),
-  mods: array(object({ name: name2, url: string2().url().max(2000).nullish() }).strict()).max(200).default([]),
+  mods: array(object({ name: name3, url: string2().url().max(2000).nullish() }).strict()).max(200).default([]),
   savePath: string2().trim().max(500).nullish(),
   lastBackup: isoDate.nullish(),
   notes: text5.nullish()
@@ -40489,7 +40723,7 @@ var runSaveFields = {
   game: _enum2(["skyrim"]).default("skyrim"),
   fileName: shortText2.nullish(),
   saveNumber: number2().int().min(0).max(1e9),
-  playerName: name2,
+  playerName: name3,
   level: number2().int().min(0).max(1e4),
   location: shortText2,
   race: shortText2.nullish(),
@@ -40535,7 +40769,7 @@ var runFacetSchema = object({
   install: runInstallSchema.nullish(),
   save: runSaveSchema.nullish(),
   money: object({ goal: shortText2.nullish(), purpose: shortText2.nullish() }).strict().nullish(),
-  links: array(object({ label: name2, url: string2().url().max(2000) }).strict()).max(50).optional()
+  links: array(object({ label: name3, url: string2().url().max(2000) }).strict()).max(50).optional()
 }).strict();
 var runListSectionValues = [
   "orderOfPlay",
@@ -40689,12 +40923,12 @@ var runSaveHeaderResultSchema = object({
 var createRunInputSchema = object({
   id: ulidSchema,
   gameId: ulidSchema,
-  title: name2,
+  title: name3,
   status: runPlayStatusSchema.optional(),
   facet: runFacetSchema.optional()
 }).strict();
 var updateRunInputSchema = object({
-  title: name2.optional(),
+  title: name3.optional(),
   status: runPlayStatusSchema.optional(),
   facet: runFacetSchema.optional()
 }).strict();
@@ -47132,6 +47366,106 @@ var commands9 = [
       return { data: types, render: renderList };
     }
   },
+  {
+    spec: {
+      path: ["collection", "kinds"],
+      summary: "List the Space's own kinds (vinyl, board games, \u2026) with their fields and words.",
+      args: [],
+      flags: [],
+      scopes: [...collectionOperations.listKinds.scopes],
+      returns: "CollectionKind[]",
+      notes: `${routeOf(collectionOperations.listKinds)}. Each kind's \`key\` is what an Item of it carries as its \`type\`.`
+    },
+    run: async ({ requireClient }) => ({
+      data: await requireClient().getPage(pathOf(collectionOperations.listKinds)),
+      render: renderList
+    })
+  },
+  {
+    spec: {
+      path: ["collection", "kind"],
+      summary: "One of the Space's own kinds.",
+      args: [{ name: "id", required: true, description: "Kind ULID." }],
+      flags: [],
+      scopes: [...collectionOperations.getKind.scopes],
+      returns: "CollectionKind",
+      notes: `${routeOf(collectionOperations.getKind)}.`
+    },
+    run: readOperation(collectionOperations.getKind, renderRecord, { kindId: "kind id" })
+  },
+  {
+    spec: {
+      path: ["collection", "kind-add"],
+      summary: "Add a kind: from a preset (lego, vinyl, board, custom) or from scratch.",
+      args: [{ name: "name", required: true, description: 'Its name ("Vinyl").' }],
+      flags: [
+        {
+          name: "preset",
+          type: "string",
+          description: `Start from ${Object.keys(COLLECTION_KIND_PRESETS).join(", ")}; what's left out comes from it.`
+        },
+        {
+          name: "data",
+          type: "string",
+          description: 'More JSON: `{ "key": "\u2026", "one": "record", "many": "records", "icon": "disc", "fields": [{ "key": "artist", "label": "Artist", "type": "text" }], "statusWords": { \u2026 } }`. The id is minted.'
+        }
+      ],
+      scopes: [...collectionOperations.createKind.scopes],
+      returns: "CollectionKind",
+      notes: `${routeOf(collectionOperations.createKind)}. The key is the name's slug unless given; a key the Space has is a 409. \`do collection kind-add Vinyl --preset vinyl\`.`
+    },
+    run: async ({ args, flags, requireClient }) => {
+      const name = requireArg(args, 0, "name");
+      const preset = flagString(flags, "preset");
+      if (preset)
+        parseInput(collectionKindPresetSchema, preset);
+      const body = parseInput(createCollectionKindInputSchema, {
+        id: ulid3(),
+        name,
+        ...preset ? { preset } : {},
+        ...readDataFlag(flags)
+      });
+      return {
+        data: await requireClient().post(pathOf(collectionOperations.createKind), body),
+        render: renderRecord
+      };
+    }
+  },
+  {
+    spec: {
+      path: ["collection", "kind-update"],
+      summary: "Change a kind: its name, one/many, icon, fields or status words (the key stays).",
+      args: [{ name: "id", required: true, description: "Kind ULID." }],
+      flags: [{ name: "data", type: "string", description: "UpdateCollectionKindInput JSON." }],
+      scopes: [...collectionOperations.updateKind.scopes],
+      returns: "CollectionKind",
+      notes: `${routeOf(collectionOperations.updateKind)}. \`fields\` replaces the list.`
+    },
+    run: async ({ args, flags, requireClient }) => {
+      const kindId = requireArg(args, 0, "kind id");
+      const body = parseInput(updateCollectionKindInputSchema, readDataFlag(flags));
+      return {
+        data: await requireClient().patch(pathOf(collectionOperations.updateKind, { kindId }), body),
+        render: renderRecord
+      };
+    }
+  },
+  {
+    spec: {
+      path: ["collection", "kind-remove"],
+      summary: "Remove a kind that has no Items.",
+      args: [{ name: "id", required: true, description: "Kind ULID." }],
+      flags: [],
+      scopes: [...collectionOperations.removeKind.scopes],
+      returns: "void",
+      notes: `${routeOf(collectionOperations.removeKind)}. A 409 while it still has Items.`
+    },
+    run: async ({ args, requireClient }) => {
+      const kindId = requireArg(args, 0, "kind id");
+      await requireClient().delete(pathOf(collectionOperations.removeKind, { kindId }));
+      return { data: { ok: true, kindId }, render: renderRecord };
+    }
+  },
   {
     spec: {
       path: ["collection", "list"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robbeverhelst/do",
-  "version": "1.391.0",
+  "version": "1.392.0",
   "private": false,
   "description": "do — the agent-drivable CLI over the public /api/v1 surface",
   "homepage": "https://github.com/robbeverhelst/do/tree/main/apps/cli",