@foir/cli 0.67.0 → 0.68.0

package/dist/lib/config-helpers.d.ts

@@ -237,6 +237,20 @@ interface QuotaRule {
     expiresAt?: string;
     /** Custom message returned when this rule's quota is exhausted (e.g., upgrade CTA). */
     message?: string;
+    /**
+     * Refuse the caller when this rule cannot be evaluated, instead of letting
+     * them through.
+     *
+     * Defaults to `false`, which is the behaviour every rule had before this
+     * field existed: if the meter is unreadable the request is allowed. Set it
+     * on a rule that protects something expensive, where serving an unmetered
+     * request costs more than refusing a legitimate one.
+     *
+     * It does not cover every failure. A rule whose own counter is unreadable
+     * refuses; a failure to load the rules at all has no rule to consult and
+     * still allows.
+     */
+    failClosed?: boolean;
 }
 
 interface ApplyConfigOperationInput {

package/dist/lib/migrations.d.ts

@@ -0,0 +1,100 @@
+/**
+ * The decision-file authoring surface: what a `migrations/*.foir.ts` file
+ * imports.
+ *
+ * These types exist so a decision is checked where it is written rather than
+ * on the server after a push. A misspelled verb in a file that only fails
+ * remotely costs a round trip to find out; here it is a red squiggle.
+ */
+/** Move the values to a field with a different key. */
+type RenameTo = {
+    renameTo: string;
+};
+/**
+ * Convert the values to another type.
+ *
+ * `onError` decides what happens to a value that will not cast. The default is
+ * to fail the migration, because silently discarding the ones that did not
+ * convert is how a migration reports success having lost data.
+ */
+type Retype = {
+    retype: {
+        to: string;
+        onError?: 'fail' | 'null' | 'skip';
+    };
+};
+/** Rewrite stored values through a lookup table. */
+type RemapValues = {
+    remapValues: {
+        values: Record<string, string>;
+        failOnUnmapped?: boolean;
+    };
+};
+/** Split one field's value across several, on a separator. */
+type SplitInto = {
+    splitInto: {
+        into: string[];
+        on: string;
+    };
+};
+/** Join several fields into this one, with a separator. */
+type JoinFrom = {
+    joinFrom: {
+        from: string[];
+        with: string;
+    };
+};
+/** Fill this field from another field or a constant. */
+type FillFrom = {
+    fillFrom: {
+        field?: string;
+        constant?: unknown;
+        onlyWhenEmpty?: boolean;
+    };
+};
+/**
+ * Discard the values deliberately.
+ *
+ * Distinct from leaving a field undecided, which the push refuses. This is a
+ * signature on the loss, not a default anyone can fall into.
+ */
+type Drop = {
+    drop: true;
+};
+/**
+ * Leave the data alone — the author is handling it themselves.
+ *
+ * Carries the reason, which the ledger records, so a migration that ran nothing
+ * still says why. The field keeps its tombstone and its grace period.
+ */
+type Hold = {
+    hold: string;
+};
+type FieldDecision = RenameTo | Retype | RemapValues | SplitInto | JoinFrom | FillFrom | Drop | Hold;
+/** One model's decisions, keyed by the field being removed. */
+type ModelDecisions = Record<string, FieldDecision>;
+/** Every model this file speaks for. */
+type MigrationDecisions = Record<string, ModelDecisions>;
+/** What a decision file default-exports. */
+interface MigrationFile {
+    /**
+     * The author's id, conventionally the file's timestamp.
+     *
+     * A handle and an ordering aid — NOT the identity. The server keys the ledger
+     * on a hash of the decisions themselves, because two branches producing the
+     * same timestamp is likely while two producing the same decisions is exactly
+     * the case that should converge on one no-op.
+     */
+    id: string;
+    decisions: MigrationDecisions;
+}
+/**
+ * Declare what happens to the data under fields this push removes.
+ *
+ * Returns a plain object rather than doing anything: a decision file is a
+ * declaration that gets committed and reviewed, and code that acted at import
+ * time would run on every `foir push --dry-run` too.
+ */
+declare function migration(id: string, decisions: MigrationDecisions): MigrationFile;
+
+export { type Drop, type FieldDecision, type FillFrom, type Hold, type JoinFrom, type MigrationDecisions, type MigrationFile, type ModelDecisions, type RemapValues, type RenameTo, type Retype, type SplitInto, migration };

package/dist/lib/migrations.js

@@ -0,0 +1,7 @@
+// src/lib/migrations.ts
+function migration(id, decisions) {
+  return { id, decisions };
+}
+export {
+  migration
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foir/cli",
-  "version": "0.67.0",
+  "version": "0.68.0",
   "description": "Universal platform CLI for Foir platform",
   "type": "module",
   "publishConfig": {
@@ -17,6 +17,10 @@
     "./configs": {
       "types": "./dist/lib/config-helpers.d.ts",
       "import": "./dist/lib/config-helpers.js"
+    },
+    "./migrations": {
+      "types": "./dist/lib/migrations.d.ts",
+      "import": "./dist/lib/migrations.js"
     }
   },
   "files": [
@@ -59,8 +63,8 @@
     "vitest": "^3.2.4",
     "@foir/assistant": "0.0.0",
     "@foir/console-routes": "0.0.0",
-    "@foir/proto-ts": "0.109.0",
     "@foir/rpc-node": "0.0.0",
+    "@foir/proto-ts": "0.109.0",
     "@foir/sdk": "0.9.0"
   },
   "engines": {