@intutic/shared-types 2.5.0 → 2.5.1

package/dist/posturePresets.js.map

@@ -1 +1 @@
-{"version":3,"file":"posturePresets.js","sourceRoot":"","sources":["../src/posturePresets.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;;;AA6HH,kCAGC;AApHD;;GAEG;AACU,QAAA,iBAAiB,GAA6B;IACzD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,WAAW,EACT,iFAAiF;YACjF,2EAA2E;YAC3E,oEAAoE;QACtE,QAAQ,EAAE;YACR,qBAAqB,EAAE,WAAW;YAClC,oBAAoB,EAAE,QAAQ;SAC/B;QACD,qEAAqE;QACrE,mEAAmE;QACnE,uEAAuE;QACvE,+DAA+D;QAC/D,kEAAkE;QAClE,kEAAkE;QAClE,kEAAkE;QAClE,sEAAsE;QACtE,yEAAyE;QACzE,uEAAuE;QACvE,YAAY,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE,wBAAwB,EAAE,IAAI,EAAE;KAC/E;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,+EAA+E;YAC/E,0EAA0E;YAC1E,6BAA6B;QAC/B,QAAQ,EAAE;YACR,qBAAqB,EAAE,SAAS;YAChC,oBAAoB,EAAE,MAAM;SAC7B;QACD,YAAY,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE;KAC/C;IACD;QACE,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,SAAS;QAChB,WAAW,EACT,gFAAgF;YAChF,gFAAgF;YAChF,4EAA4E;QAC9E,QAAQ,EAAE;YACR,qBAAqB,EAAE,YAAY;YACnC,oBAAoB,EAAE,MAAM;SAC7B;QACD,YAAY,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE;KAC9C;CACO,CAAA;AAEV;;;;;;;GAOG;AACU,QAAA,aAAa,GAA6B;IACrD;QACE,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,yEAAyE;YACzE,2EAA2E;YAC3E,gFAAgF;QAClF,QAAQ,EAAE,EAAE;QACZ,YAAY,EAAE;YACZ,iBAAiB,EAAE,IAAI;YACvB,iBAAiB,EAAE,KAAK;YACxB,uBAAuB,EAAE,IAAI;YAC7B,0BAA0B,EAAE,IAAI;SACjC;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,8EAA8E;YAC9E,8EAA8E;YAC9E,+CAA+C;QACjD,QAAQ,EAAE,EAAE;QACZ,YAAY,EAAE;YACZ,iBAAiB,EAAE,KAAK;YACxB,iBAAiB,EAAE,IAAI;YACvB,uBAAuB,EAAE,IAAI;YAC7B,0BAA0B,EAAE,KAAK;SAClC;KACF;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,eAAe;QACtB,WAAW,EACT,0EAA0E;YAC1E,6EAA6E;QAC/E,QAAQ,EAAE,EAAE;QACZ,YAAY,EAAE;YACZ,iBAAiB,EAAE,KAAK;YACxB,iBAAiB,EAAE,KAAK;YACxB,uBAAuB,EAAE,IAAI;YAC7B,0BAA0B,EAAE,KAAK;SAClC;KACF;CACO,CAAA;AAIV,yEAAyE;AACzE,SAAgB,WAAW,CAAC,IAAiB,EAAE,IAAY;IACzD,MAAM,GAAG,GAAG,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,yBAAiB,CAAC,CAAC,CAAC,qBAAa,CAAA;IACnE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AACzC,CAAC"}
+{"version":3,"file":"posturePresets.js","sourceRoot":"","sources":["../src/posturePresets.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;;;AAwIH,kCAGC;AA/HD;;GAEG;AACU,QAAA,iBAAiB,GAA6B;IACzD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,WAAW,EACT,iFAAiF;YACjF,2EAA2E;YAC3E,oEAAoE;QACtE,QAAQ,EAAE;YACR,qBAAqB,EAAE,WAAW;YAClC,oBAAoB,EAAE,QAAQ;SAC/B;QACD,qEAAqE;QACrE,mEAAmE;QACnE,uEAAuE;QACvE,+DAA+D;QAC/D,kEAAkE;QAClE,kEAAkE;QAClE,kEAAkE;QAClE,sEAAsE;QACtE,yEAAyE;QACzE,uEAAuE;QACvE,YAAY,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE,wBAAwB,EAAE,IAAI,EAAE;KAC/E;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,+EAA+E;YAC/E,0EAA0E;YAC1E,6BAA6B;QAC/B,QAAQ,EAAE;YACR,qBAAqB,EAAE,SAAS;YAChC,oBAAoB,EAAE,MAAM;SAC7B;QACD,YAAY,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE;KAC/C;IACD;QACE,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,SAAS;QAChB,WAAW,EACT,gFAAgF;YAChF,gFAAgF;YAChF,4EAA4E;QAC9E,QAAQ,EAAE;YACR,qBAAqB,EAAE,YAAY;YACnC,oBAAoB,EAAE,MAAM;SAC7B;QACD,YAAY,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE;KAC9C;CACO,CAAA;AAEV;;;GAGG;AACH,MAAM,kBAAkB,GACtB,yFAAyF;IACzF,2EAA2E,CAAA;AAE7E;;;;;;;GAOG;AACU,QAAA,aAAa,GAA6B;IACrD;QACE,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,yEAAyE;YACzE,2EAA2E;YAC3E,iFAAiF;YACjF,kBAAkB;QACpB,QAAQ,EAAE,EAAE;QACZ,YAAY,EAAE;YACZ,iBAAiB,EAAE,IAAI;YACvB,iBAAiB,EAAE,KAAK;YACxB,uBAAuB,EAAE,IAAI;YAC7B,0BAA0B,EAAE,IAAI;SACjC;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,8EAA8E;YAC9E,8EAA8E;YAC9E,gDAAgD;YAChD,kBAAkB;QACpB,QAAQ,EAAE,EAAE;QACZ,YAAY,EAAE;YACZ,iBAAiB,EAAE,KAAK;YACxB,iBAAiB,EAAE,IAAI;YACvB,uBAAuB,EAAE,IAAI;YAC7B,0BAA0B,EAAE,KAAK;SAClC;KACF;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,eAAe;QACtB,WAAW,EACT,0EAA0E;YAC1E,8EAA8E;YAC9E,kBAAkB;QACpB,QAAQ,EAAE,EAAE;QACZ,YAAY,EAAE;YACZ,iBAAiB,EAAE,KAAK;YACxB,iBAAiB,EAAE,KAAK;YACxB,uBAAuB,EAAE,IAAI;YAC7B,0BAA0B,EAAE,KAAK;SAClC;KACF;CACO,CAAA;AAIV,yEAAyE;AACzE,SAAgB,WAAW,CAAC,IAAiB,EAAE,IAAY;IACzD,MAAM,GAAG,GAAG,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,yBAAiB,CAAC,CAAC,CAAC,qBAAa,CAAA;IACnE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AACzC,CAAC"}

package/dist/responses/common.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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
+ */
+import { z } from 'zod';
+/** A timestamp: a `Date` the handler returned, serialized by `JSON.stringify`. */
+export declare const IsoTimestamp: z.ZodString;
+/** How a list response's row keys are cased (`lib/listEnvelope.ts` in the control plane). */
+export declare const RowCase: z.ZodEnum<["snake", "camel", "mixed"]>;
+/**
+ * The two keys `applyListEnvelope` adds to a list response: the key that
+ * holds the rows, and how their keys are cased.
+ */
+export declare function listEnvelope<K extends string, C extends z.infer<typeof RowCase>>(listProperty: K, rowCase: C): z.ZodObject<{
+    listProperty: z.ZodLiteral<K>;
+    rowCase: z.ZodLiteral<C>;
+}, "strip", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    listProperty: z.ZodLiteral<K>;
+    rowCase: z.ZodLiteral<C>;
+}>, any> extends infer T ? { [k in keyof T]: T[k]; } : never, z.baseObjectInputType<{
+    listProperty: z.ZodLiteral<K>;
+    rowCase: z.ZodLiteral<C>;
+}> extends infer T_1 ? { [k_1 in keyof T_1]: T_1[k_1]; } : never>;
+/** `{ deleted: true }`, the answer of a delete that has nothing else to say. */
+export declare const DeletedResponse: z.ZodObject<{
+    deleted: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    deleted: true;
+}, {
+    deleted: true;
+}>;
+export type DeletedResponse = z.infer<typeof DeletedResponse>;
+//# sourceMappingURL=common.d.ts.map

package/dist/responses/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/responses/common.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,kFAAkF;AAClF,eAAO,MAAM,YAAY,aAAwC,CAAA;AAEjE,6FAA6F;AAC7F,eAAO,MAAM,OAAO,wCAAsC,CAAA;AAE1D;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;;;;;;;;;kEAE5G;AAED,gFAAgF;AAChF,eAAO,MAAM,eAAe;;;;;;EAAyC,CAAA;AACrE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA"}

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"}