structured-outputs 0.1.0-beta.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Harry Solovay
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,8 @@
+# `structured-outputs`
+
+Refining this as I work on a story generation use case. Was annoyed by the Zod dependency and figured why not go down
+the rabbit hole.
+
+<!-- A **WIP** purpose-built virtual type system for modeling
+[OpenAI structured outputs](https://platform.openai.com/docs/guides/structured-outputs) without duplicate definitions
+nor codegen. -->

package/esm/F.d.ts

@@ -0,0 +1,13 @@
+import type { Ty } from "./_base.js";
+import type { ValidRootKey } from "./common.js";
+export type F = {
+    type: "function";
+    /** The name of the function. */
+    name: string;
+    /** The description of the function. */
+    description: string;
+    /** Parameters of the function in JSON Schema. */
+    parameters: unknown;
+};
+export declare function F<M extends Record<string, Ty>>(name: string, description: string, models: M, rootKey: ValidRootKey<M>): F;
+//# sourceMappingURL=F.d.ts.map

package/esm/F.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"F.d.ts","sourceRoot":"","sources":["../src/F.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,YAAY,CAAA;AACpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG/C,MAAM,MAAM,CAAC,GAAG;IACd,IAAI,EAAE,UAAU,CAAA;IAChB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,wBAAgB,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAC5C,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GACvB,CAAC,CAOH"}

package/esm/F.js

@@ -0,0 +1,10 @@
+import { schema } from "./schema.js";
+export function F(name, description, models, rootKey) {
+    return {
+        type: "function",
+        name,
+        description,
+        parameters: schema(models, rootKey),
+    };
+}
+//# sourceMappingURL=F.js.map

package/esm/F.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"F.js","sourceRoot":"","sources":["../src/F.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAYpC,MAAM,UAAU,CAAC,CACf,IAAY,EACZ,WAAmB,EACnB,MAAS,EACT,OAAwB;IAExB,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,IAAI;QACJ,WAAW;QACX,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;KACpC,CAAA;AACH,CAAC"}

package/esm/ResponseFormat.d.ts

@@ -0,0 +1,14 @@
+import type { Ty } from "./_base.js";
+import type { ValidRootKey } from "./common.js";
+export type ResponseFormat = {
+    type: "json_schema";
+    /** The desired return type in JSON Schema. */
+    json_schema: {
+        name: string;
+        description: string;
+        schema: Record<string, unknown>;
+        strict: true;
+    };
+};
+export declare function ResponseFormat<M extends Record<string, Ty>>(name: string, description: string, models: M, rootKey: ValidRootKey<M>): ResponseFormat;
+//# sourceMappingURL=ResponseFormat.d.ts.map

package/esm/ResponseFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponseFormat.d.ts","sourceRoot":"","sources":["../src/ResponseFormat.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,YAAY,CAAA;AACpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG/C,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,aAAa,CAAA;IACnB,8CAA8C;IAC9C,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC/B,MAAM,EAAE,IAAI,CAAA;KACb,CAAA;CACF,CAAA;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EACzD,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GACvB,cAAc,CAUhB"}

package/esm/ResponseFormat.js

@@ -0,0 +1,13 @@
+import { schema } from "./schema.js";
+export function ResponseFormat(name, description, models, rootKey) {
+    return {
+        type: "json_schema",
+        json_schema: {
+            name,
+            description,
+            schema: schema(models, rootKey),
+            strict: true,
+        },
+    };
+}
+//# sourceMappingURL=ResponseFormat.js.map

package/esm/ResponseFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponseFormat.js","sourceRoot":"","sources":["../src/ResponseFormat.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAapC,MAAM,UAAU,cAAc,CAC5B,IAAY,EACZ,WAAmB,EACnB,MAAS,EACT,OAAwB;IAExB,OAAO;QACL,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE;YACX,IAAI;YACJ,WAAW;YACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;YAC/B,MAAM,EAAE,IAAI;SACb;KACF,CAAA;AACH,CAAC"}

package/esm/_base.d.ts

@@ -0,0 +1,13 @@
+export interface Ty<N = any> {
+    new (): N;
+    schema(ctx: Context): Record<string, unknown>;
+}
+export declare function make<Ty_ extends Ty>(schema: (ctx: Context) => unknown): Ty_;
+export declare class Context {
+    readonly root: Ty;
+    readonly models?: Record<string, Ty> | undefined;
+    defs: Map<Ty, string>;
+    constructor(root: Ty, models?: Record<string, Ty> | undefined);
+    ref(value: Ty): Record<string, unknown>;
+}
+//# sourceMappingURL=_base.d.ts.map

package/esm/_base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_base.d.ts","sourceRoot":"","sources":["../src/_base.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,EAAE,CAAC,CAAC,GAAG,GAAG;IACzB,QAAO,CAAC,CAAA;IACR,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9C;AAED,wBAAgB,IAAI,CAAC,GAAG,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,GAG/D,GAAG,CACT;AAED,qBAAa,OAAO;IAGhB,QAAQ,CAAC,IAAI,EAAE,EAAE;IACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;IAHtC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;gBAEV,IAAI,EAAE,EAAE,EACR,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,YAAA;IAKtC,GAAG,CAAC,KAAK,EAAE,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAIxC"}

package/esm/_base.js

@@ -0,0 +1,40 @@
+export function make(schema) {
+    var _a;
+    return _a = class Ty {
+        },
+        Object.defineProperty(_a, "schema", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: schema
+        }),
+        _a;
+}
+export class Context {
+    constructor(root, models) {
+        Object.defineProperty(this, "root", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: root
+        });
+        Object.defineProperty(this, "models", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: models
+        });
+        Object.defineProperty(this, "defs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.defs = new Map(models ? Object.entries(models).map(([k, v]) => [v, k]) : []);
+    }
+    ref(value) {
+        const key = this.defs.get(value);
+        return key ? { $ref: `#/$defs/${key}` } : value.schema(this);
+    }
+}
+//# sourceMappingURL=_base.js.map

package/esm/_base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_base.js","sourceRoot":"","sources":["../src/_base.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,IAAI,CAAiB,MAAiC;;IACpE,OAAO,KAAA,MAAM,EAAE;SAEd;QADQ;;;;mBAAS,MAAM;UAAA;UAChB,CAAA;AACV,CAAC;AAED,MAAM,OAAO,OAAO;IAElB,YACW,IAAQ,EACR,MAA2B;QADpC;;;;mBAAS,IAAI;WAAI;QACjB;;;;mBAAS,MAAM;WAAqB;QAHtC;;;;;WAAqB;QAKnB,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IACnF,CAAC;IAED,GAAG,CAAC,KAAS;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAChC,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC9D,CAAC;CACF"}

package/esm/array.d.ts

@@ -0,0 +1,4 @@
+import { type Ty } from "./_base.js";
+export declare function array<E extends Ty>(description: string | undefined, element: E): ArrayTy<E>;
+export type ArrayTy<E extends Ty = any> = Ty<Array<InstanceType<E>>>;
+//# sourceMappingURL=array.d.ts.map

package/esm/array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAE,EAAE,MAAM,YAAY,CAAA;AAE1C,wBAAgB,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAM3F;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,EAAE,GAAG,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA"}

package/esm/array.js

@@ -0,0 +1,9 @@
+import { make } from "./_base.js";
+export function array(description, element) {
+    return make((ctx) => ({
+        type: "array",
+        description,
+        items: ctx.ref(element),
+    }));
+}
+//# sourceMappingURL=array.js.map

package/esm/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../src/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAW,MAAM,YAAY,CAAA;AAE1C,MAAM,UAAU,KAAK,CAAe,WAA+B,EAAE,OAAU;IAC7E,OAAO,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,OAAO;QACb,WAAW;QACX,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC;KACxB,CAAC,CAAC,CAAA;AACL,CAAC"}

package/esm/common.d.ts

@@ -0,0 +1,6 @@
+import type { Ty } from "./_base.js";
+import type { ObjectTy } from "./object.js";
+export type ValidRootKey<M extends Record<string, Ty>> = keyof {
+    [K in keyof M as (M[K] extends ObjectTy<any> ? K : never)]: never;
+};
+//# sourceMappingURL=common.d.ts.map

package/esm/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,YAAY,CAAA;AACpC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM;KAC5D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK;CAClE,CAAA"}

package/esm/common.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=common.js.map

package/esm/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":""}

package/esm/literal.d.ts

@@ -0,0 +1,4 @@
+import { type Ty } from "./_base.js";
+export declare function literal<V extends number | string>(description: string | undefined, value: V): LiteralTy<V>;
+export type LiteralTy<V extends number | string = any> = Ty<V>;
+//# sourceMappingURL=literal.d.ts.map

package/esm/literal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"literal.d.ts","sourceRoot":"","sources":["../src/literal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAE,EAAE,MAAM,YAAY,CAAA;AAE1C,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAK1G;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA"}

package/esm/literal.js

@@ -0,0 +1,8 @@
+import { make } from "./_base.js";
+export function literal(description, value) {
+    return make(() => ({
+        const: value,
+        description,
+    }));
+}
+//# sourceMappingURL=literal.js.map

package/esm/literal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"literal.js","sourceRoot":"","sources":["../src/literal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAW,MAAM,YAAY,CAAA;AAE1C,MAAM,UAAU,OAAO,CAA4B,WAA+B,EAAE,KAAQ;IAC1F,OAAO,IAAI,CAAe,GAAG,EAAE,CAAC,CAAC;QAC/B,KAAK,EAAE,KAAK;QACZ,WAAW;KACZ,CAAC,CAAC,CAAA;AACL,CAAC"}

package/esm/mod.d.ts

@@ -0,0 +1,16 @@
+import type { ArrayTy } from "./array.js";
+import type { NumberTy } from "./number.js";
+import type { ObjectTy } from "./object.js";
+import type { StringTy } from "./string.js";
+export type RootTy = NumberTy | StringTy | ObjectTy | ArrayTy;
+export * from "./array.js";
+export * from "./common.js";
+export * from "./F.js";
+export * from "./literal.js";
+export * from "./number.js";
+export * from "./object.js";
+export * from "./ResponseFormat.js";
+export * from "./schema.js";
+export * from "./string.js";
+export * from "./union.js";
+//# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;AAI7D,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,qBAAqB,CAAA;AACnC,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}

package/esm/mod.js

@@ -0,0 +1,12 @@
+// moderate --exclude _base.ts code_critique.ts
+export * from "./array.js";
+export * from "./common.js";
+export * from "./F.js";
+export * from "./literal.js";
+export * from "./number.js";
+export * from "./object.js";
+export * from "./ResponseFormat.js";
+export * from "./schema.js";
+export * from "./string.js";
+export * from "./union.js";
+//# sourceMappingURL=mod.js.map

package/esm/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAOA,+CAA+C;AAE/C,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,qBAAqB,CAAA;AACnC,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}

package/esm/number.d.ts

@@ -0,0 +1,4 @@
+import { type Ty } from "./_base.js";
+export declare function number(description?: string): NumberTy;
+export type NumberTy = Ty<number>;
+//# sourceMappingURL=number.d.ts.map

package/esm/number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../src/number.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAE,EAAE,MAAM,YAAY,CAAA;AAE1C,wBAAgB,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,QAAQ,CAKrD;AAED,MAAM,MAAM,QAAQ,GAAG,EAAE,CAAC,MAAM,CAAC,CAAA"}

package/esm/number.js

@@ -0,0 +1,8 @@
+import { make } from "./_base.js";
+export function number(description) {
+    return make(() => ({
+        type: "number",
+        description,
+    }));
+}
+//# sourceMappingURL=number.js.map

package/esm/number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../src/number.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAW,MAAM,YAAY,CAAA;AAE1C,MAAM,UAAU,MAAM,CAAC,WAAoB;IACzC,OAAO,IAAI,CAAW,GAAG,EAAE,CAAC,CAAC;QAC3B,IAAI,EAAE,QAAQ;QACd,WAAW;KACZ,CAAC,CAAC,CAAA;AACL,CAAC"}

package/esm/object.d.ts

@@ -0,0 +1,7 @@
+import { type Ty } from "./_base.js";
+export declare function object<F extends ObjectTyFields>(description: string | undefined, fields: F): ObjectTy<F>;
+export type ObjectTyFields = Record<string, Ty>;
+export type ObjectTy<F extends ObjectTyFields = any> = Ty<{
+    [K in keyof F]: F[K] extends Ty ? InstanceType<F[K]> : F[K];
+}>;
+//# sourceMappingURL=object.d.ts.map

package/esm/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAE,EAAE,MAAM,YAAY,CAAA;AAE1C,wBAAgB,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAQxG;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AAE/C,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,cAAc,GAAG,GAAG,IAAI,EAAE,CACvD;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAChE,CAAA"}

package/esm/object.js

@@ -0,0 +1,11 @@
+import { make } from "./_base.js";
+export function object(description, fields) {
+    return make((ctx) => ({
+        type: "object",
+        description,
+        properties: Object.fromEntries(Object.entries(fields).map(([k, v]) => [k, ctx.ref(v)])),
+        additionalProperties: false,
+        required: Object.keys(fields),
+    }));
+}
+//# sourceMappingURL=object.js.map

package/esm/object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../src/object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAW,MAAM,YAAY,CAAA;AAE1C,MAAM,UAAU,MAAM,CAA2B,WAA+B,EAAE,MAAS;IACzF,OAAO,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW;QACX,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvF,oBAAoB,EAAE,KAAK;QAC3B,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;KAC9B,CAAC,CAAC,CAAA;AACL,CAAC"}

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/esm/schema.d.ts

@@ -0,0 +1,4 @@
+import { type Ty } from "./_base.js";
+import type { ValidRootKey } from "./common.js";
+export declare function schema<M extends Record<string, Ty>>(models: M, rootKey: ValidRootKey<M>): Record<string, unknown>;
+//# sourceMappingURL=schema.d.ts.map

package/esm/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,EAAE,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAMjH"}

package/esm/schema.js

@@ -0,0 +1,9 @@
+import { Context } from "./_base.js";
+export function schema(models, rootKey) {
+    const root = models[rootKey];
+    const ctx = new Context(root, models);
+    return Object.assign(root.schema(ctx), {
+        $defs: Object.fromEntries(Object.entries(models).map(([k, v]) => [k, v.schema(ctx)])),
+    });
+}
+//# sourceMappingURL=schema.js.map

package/esm/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,MAAM,YAAY,CAAA;AAG7C,MAAM,UAAU,MAAM,CAA+B,MAAS,EAAE,OAAwB;IACtF,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAE,CAAA;IAC7B,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACrC,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;QACrC,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACtF,CAAC,CAAA;AACJ,CAAC"}

package/esm/string.d.ts

@@ -0,0 +1,4 @@
+import { type Ty } from "./_base.js";
+export declare function string(description?: string): StringTy;
+export type StringTy = Ty<string>;
+//# sourceMappingURL=string.d.ts.map

package/esm/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAE,EAAE,MAAM,YAAY,CAAA;AAE1C,wBAAgB,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,QAAQ,CAKrD;AAED,MAAM,MAAM,QAAQ,GAAG,EAAE,CAAC,MAAM,CAAC,CAAA"}

package/esm/string.js

@@ -0,0 +1,8 @@
+import { make } from "./_base.js";
+export function string(description) {
+    return make(() => ({
+        type: "string",
+        description,
+    }));
+}
+//# sourceMappingURL=string.js.map

package/esm/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAW,MAAM,YAAY,CAAA;AAE1C,MAAM,UAAU,MAAM,CAAC,WAAoB;IACzC,OAAO,IAAI,CAAW,GAAG,EAAE,CAAC,CAAC;QAC3B,IAAI,EAAE,QAAQ;QACd,WAAW;KACZ,CAAC,CAAC,CAAA;AACL,CAAC"}

package/esm/union.d.ts

@@ -0,0 +1,6 @@
+import { type Ty } from "./_base.js";
+export declare function union<M extends Ty[]>(description: string | undefined, members: [...M]): UnionTy<M>;
+export type UnionTy<M extends Ty[]> = Ty<{
+    [K in keyof M]: M[K] extends Ty ? InstanceType<M[K]> : M[K];
+}[number]>;
+//# sourceMappingURL=union.d.ts.map

package/esm/union.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"union.d.ts","sourceRoot":"","sources":["../src/union.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAE,EAAE,MAAM,YAAY,CAAA;AAE1C,wBAAgB,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAKlG;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,CACtC;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC,MAAM,CAAC,CACxE,CAAA"}

package/esm/union.js

@@ -0,0 +1,8 @@
+import { make } from "./_base.js";
+export function union(description, members) {
+    return make((ctx) => ({
+        description,
+        oneOf: members.map((member) => ctx.ref(member)),
+    }));
+}
+//# sourceMappingURL=union.js.map

package/esm/union.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"union.js","sourceRoot":"","sources":["../src/union.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAW,MAAM,YAAY,CAAA;AAE1C,MAAM,UAAU,KAAK,CAAiB,WAA+B,EAAE,OAAe;IACpF,OAAO,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACpB,WAAW;QACX,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAChD,CAAC,CAAC,CAAA;AACL,CAAC"}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "structured-outputs",
+  "version": "0.1.0-beta.1",
+  "description": "Lightweight virtual types for OpenAI structured outputs.",
+  "repository": "github:harrysolovay/structured-outputs.git",
+  "license": "Apache-2.0",
+  "module": "./esm/mod.js",
+  "exports": {
+    ".": {
+      "import": "./esm/mod.js"
+    }
+  },
+  "dependencies": {
+    "tslib": "^2.6.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.9.0"
+  },
+  "_generatedBy": "dnt@dev"
+}

package/src/F.ts

@@ -0,0 +1,27 @@
+import type { Ty } from "./_base.js"
+import type { ValidRootKey } from "./common.js"
+import { schema } from "./schema.js"
+
+export type F = {
+  type: "function"
+  /** The name of the function. */
+  name: string
+  /** The description of the function. */
+  description: string
+  /** Parameters of the function in JSON Schema. */
+  parameters: unknown
+}
+
+export function F<M extends Record<string, Ty>>(
+  name: string,
+  description: string,
+  models: M,
+  rootKey: ValidRootKey<M>,
+): F {
+  return {
+    type: "function",
+    name,
+    description,
+    parameters: schema(models, rootKey),
+  }
+}

package/src/ResponseFormat.ts

@@ -0,0 +1,31 @@
+import type { Ty } from "./_base.js"
+import type { ValidRootKey } from "./common.js"
+import { schema } from "./schema.js"
+
+export type ResponseFormat = {
+  type: "json_schema"
+  /** The desired return type in JSON Schema. */
+  json_schema: {
+    name: string
+    description: string
+    schema: Record<string, unknown>
+    strict: true
+  }
+}
+
+export function ResponseFormat<M extends Record<string, Ty>>(
+  name: string,
+  description: string,
+  models: M,
+  rootKey: ValidRootKey<M>,
+): ResponseFormat {
+  return {
+    type: "json_schema",
+    json_schema: {
+      name,
+      description,
+      schema: schema(models, rootKey),
+      strict: true,
+    },
+  }
+}

package/src/_base.ts

@@ -0,0 +1,25 @@
+export interface Ty<N = any> {
+  new(): N
+  schema(ctx: Context): Record<string, unknown>
+}
+
+export function make<Ty_ extends Ty>(schema: (ctx: Context) => unknown) {
+  return class Ty {
+    static schema = schema
+  } as Ty_
+}
+
+export class Context {
+  defs: Map<Ty, string>
+  constructor(
+    readonly root: Ty,
+    readonly models?: Record<string, Ty>,
+  ) {
+    this.defs = new Map(models ? Object.entries(models).map(([k, v]) => [v, k]) : [])
+  }
+
+  ref(value: Ty): Record<string, unknown> {
+    const key = this.defs.get(value)
+    return key ? { $ref: `#/$defs/${key}` } : value.schema(this)
+  }
+}

package/src/array.ts

@@ -0,0 +1,11 @@
+import { make, type Ty } from "./_base.js"
+
+export function array<E extends Ty>(description: string | undefined, element: E): ArrayTy<E> {
+  return make((ctx) => ({
+    type: "array",
+    description,
+    items: ctx.ref(element),
+  }))
+}
+
+export type ArrayTy<E extends Ty = any> = Ty<Array<InstanceType<E>>>

package/src/common.ts

@@ -0,0 +1,6 @@
+import type { Ty } from "./_base.js"
+import type { ObjectTy } from "./object.js"
+
+export type ValidRootKey<M extends Record<string, Ty>> = keyof {
+  [K in keyof M as (M[K] extends ObjectTy<any> ? K : never)]: never
+}

package/src/literal.ts

@@ -0,0 +1,10 @@
+import { make, type Ty } from "./_base.js"
+
+export function literal<V extends number | string>(description: string | undefined, value: V): LiteralTy<V> {
+  return make<LiteralTy<V>>(() => ({
+    const: value,
+    description,
+  }))
+}
+
+export type LiteralTy<V extends number | string = any> = Ty<V>

package/src/mod.ts

@@ -0,0 +1,19 @@
+import type { ArrayTy } from "./array.js"
+import type { NumberTy } from "./number.js"
+import type { ObjectTy } from "./object.js"
+import type { StringTy } from "./string.js"
+
+export type RootTy = NumberTy | StringTy | ObjectTy | ArrayTy
+
+// moderate --exclude _base.ts code_critique.ts
+
+export * from "./array.js"
+export * from "./common.js"
+export * from "./F.js"
+export * from "./literal.js"
+export * from "./number.js"
+export * from "./object.js"
+export * from "./ResponseFormat.js"
+export * from "./schema.js"
+export * from "./string.js"
+export * from "./union.js"

package/src/number.ts

@@ -0,0 +1,10 @@
+import { make, type Ty } from "./_base.js"
+
+export function number(description?: string): NumberTy {
+  return make<NumberTy>(() => ({
+    type: "number",
+    description,
+  }))
+}
+
+export type NumberTy = Ty<number>

package/src/object.ts

@@ -0,0 +1,17 @@
+import { make, type Ty } from "./_base.js"
+
+export function object<F extends ObjectTyFields>(description: string | undefined, fields: F): ObjectTy<F> {
+  return make((ctx) => ({
+    type: "object",
+    description,
+    properties: Object.fromEntries(Object.entries(fields).map(([k, v]) => [k, ctx.ref(v)])),
+    additionalProperties: false,
+    required: Object.keys(fields),
+  }))
+}
+
+export type ObjectTyFields = Record<string, Ty>
+
+export type ObjectTy<F extends ObjectTyFields = any> = Ty<
+  { [K in keyof F]: F[K] extends Ty ? InstanceType<F[K]> : F[K] }
+>

package/src/schema.ts

@@ -0,0 +1,10 @@
+import { Context, type Ty } from "./_base.js"
+import type { ValidRootKey } from "./common.js"
+
+export function schema<M extends Record<string, Ty>>(models: M, rootKey: ValidRootKey<M>): Record<string, unknown> {
+  const root = models[rootKey]!
+  const ctx = new Context(root, models)
+  return Object.assign(root.schema(ctx), {
+    $defs: Object.fromEntries(Object.entries(models).map(([k, v]) => [k, v.schema(ctx)])),
+  })
+}

package/src/string.ts

@@ -0,0 +1,10 @@
+import { make, type Ty } from "./_base.js"
+
+export function string(description?: string): StringTy {
+  return make<StringTy>(() => ({
+    type: "string",
+    description,
+  }))
+}
+
+export type StringTy = Ty<string>

package/src/union.ts

@@ -0,0 +1,12 @@
+import { make, type Ty } from "./_base.js"
+
+export function union<M extends Ty[]>(description: string | undefined, members: [...M]): UnionTy<M> {
+  return make((ctx) => ({
+    description,
+    oneOf: members.map((member) => ctx.ref(member)),
+  }))
+}
+
+export type UnionTy<M extends Ty[]> = Ty<
+  { [K in keyof M]: M[K] extends Ty ? InstanceType<M[K]> : M[K] }[number]
+>