@intutic/shared-types 2.4.0 → 2.5.1

package/dist/responses/common.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeletedResponse = exports.RowCase = exports.IsoTimestamp = void 0;
+exports.listEnvelope = listEnvelope;
+/**
+ * Building blocks of the control plane's response schemas.
+ *
+ * Each schema in `src/responses/` describes a response body as the client
+ * receives it: JSON, so a timestamp is a string and a field the handler left
+ * `undefined` is absent (`.optional()`), not `null` (`.nullable()`). A route
+ * declares its schema by answering through `respond(c, Schema, body)`
+ * (`services/control-plane/src/lib/respond.ts`); the OpenAPI document
+ * publishes it, `tsc` holds the handler's body to it, and the control plane's
+ * tests reject a body that does not match it or carries a field it does not
+ * declare. Write one from the handler and the service code it returns, never
+ * from what a client expects: where the two disagree, the handler is right.
+ *
+ * Conventions:
+ * - Top-level schemas are named `<Thing>Response` and exported with their
+ *   inferred type under the same name.
+ * - No transforms, defaults or coercions: a schema describes, it does not
+ *   convert.
+ * - In a union, put the branch with more fields first: zod keeps the first
+ *   branch that matches and drops the fields it does not declare, which the
+ *   tests then report as undeclared.
+ *
+ * @module
+ */
+const zod_1 = require("zod");
+/** A timestamp: a `Date` the handler returned, serialized by `JSON.stringify`. */
+exports.IsoTimestamp = zod_1.z.string().datetime({ offset: true });
+/** How a list response's row keys are cased (`lib/listEnvelope.ts` in the control plane). */
+exports.RowCase = zod_1.z.enum(['snake', 'camel', 'mixed']);
+/**
+ * The two keys `applyListEnvelope` adds to a list response: the key that
+ * holds the rows, and how their keys are cased.
+ */
+function listEnvelope(listProperty, rowCase) {
+    return zod_1.z.object({ listProperty: zod_1.z.literal(listProperty), rowCase: zod_1.z.literal(rowCase) });
+}
+/** `{ deleted: true }`, the answer of a delete that has nothing else to say. */
+exports.DeletedResponse = zod_1.z.object({ deleted: zod_1.z.literal(true) });
+//# sourceMappingURL=common.js.map

package/dist/responses/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/responses/common.ts"],"names":[],"mappings":";;;AAoCA,oCAEC;AAtCD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,6BAAuB;AAEvB,kFAAkF;AACrE,QAAA,YAAY,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;AAEjE,6FAA6F;AAChF,QAAA,OAAO,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;AAE1D;;;GAGG;AACH,SAAgB,YAAY,CAAsD,YAAe,EAAE,OAAU;IAC3G,OAAO,OAAC,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,OAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;AACzF,CAAC;AAED,gFAAgF;AACnE,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA"}