shapedef 1.0.0

package/.gitignore

@@ -0,0 +1,232 @@
+# Created by https://www.toptal.com/developers/gitignore/api/vim,emacs,yarn,node
+# Edit at https://www.toptal.com/developers/gitignore?templates=vim,emacs,yarn,node
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+
+# directory configuration
+.dir-locals.el
+
+# network security
+/network-security.data
+
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### yarn ###
+# https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
+
+.yarn/*
+!.yarn/releases
+!.yarn/patches
+!.yarn/plugins
+!.yarn/sdks
+!.yarn/versions
+
+# if you are NOT using Zero-installs, then:
+# comment the following lines
+!.yarn/cache
+
+# and uncomment the following lines
+# .pnp.*
+
+# End of https://www.toptal.com/developers/gitignore/api/vim,emacs,yarn,node

package/CLAUDE.md

@@ -0,0 +1,41 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+```bash
+pnpm build       # Compile TypeScript to both ESM (dist/esm) and CJS (dist/cjs)
+pnpm test        # Run tests with Vitest
+pnpm check       # Type-check without emitting (tsc --noEmit)
+pnpm format      # Format src/ with Prettier
+```
+
+To run a single test file:
+```bash
+pnpm exec vitest run src/translations/typescript.test.ts
+```
+
+## Architecture
+
+**shapedef** is a TypeScript library for defining data shapes and translating them into various formats (currently TypeScript type/interface syntax).
+
+### Core Concepts
+
+**Shape system** (`src/shape.ts`): The central module. Defines all shape variants (`ShapeInt`, `ShapeFloat`, `ShapeStr`, `ShapeBool`, `ShapeDate`, `ShapeNil`, `ShapeUnknown`, `ShapeRef`, `ShapeArray`, `ShapeMapping`, `ShapeTuple`, `ShapeVector`, `ShapeUnion`, plus literal variants) united under the `Shape` union type. Shapes are created via the `shapes` namespace of factory functions (`shapes.int()`, `shapes.str()`, `shapes.mapping({...})`, etc.).
+
+**Annotation system** (`src/shape.ts`): The `annotate` namespace wraps shapes with metadata. Each annotation adds to a `ShapeAnnotations` object (name, title, description, optional, primary, unique, foreign key). Annotated shapes carry their annotations as a phantom type parameter so callers can introspect them at the type level without runtime overhead.
+
+**Phantom types** (`src/phantom.ts`): Encode type-level information that is invisible at runtime. Used to make annotation metadata queryable at the TypeScript type level.
+
+**Translation system** (`src/translations/`): `TranslationFunc<T>` maps a `Shape` to some output type `T`. Translators pattern-match on `shape.type`. The `typescript` translator in `typescript.ts` converts shapes to TypeScript syntax strings (primitives become type keywords; `ShapeMapping` with a name generates an `interface`, anonymous produces an inline object type).
+
+### Adding a New Translator
+
+1. Create `src/translations/<format>.ts` exporting a `TranslationFunc<YourOutputType>`
+2. Add tests in `src/translations/<format>.test.ts`
+3. Re-export from `src/translations/index.ts`
+
+### Module Output
+
+Dual ESM/CJS output via separate `tsconfig.esm.json` / `tsconfig.cjs.json`. Both generate `.d.ts` declarations. The ESM output folder gets an injected `package.json { "type": "module" }` to signal ESM to Node.

package/README.md

@@ -0,0 +1,2 @@
+# shapedef
+Define shapes and translate them into various formats

package/dist/cjs/common/guards.d.ts

@@ -0,0 +1,5 @@
+export declare const isPlainObject: (x: any) => x is Record<PropertyKey, unknown>;
+export declare function has<Keys extends [...PropertyKey[]]>(x: unknown, ...keys: Keys): x is {
+    [Prop in keyof Keys as [Keys[Prop]] extends [string] ? Keys[Prop] : never]: unknown;
+};
+//# sourceMappingURL=guards.d.ts.map

package/dist/cjs/common/guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../../src/common/guards.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,GAAI,GAAG,GAAG,KAAG,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,OAAO,CAKtE,CAAC;AAEF,wBAAgB,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,WAAW,EAAE,CAAC,EACjD,CAAC,EAAE,OAAO,EACV,GAAG,IAAI,EAAE,IAAI,GACZ,CAAC,IAAI;KACL,IAAI,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAC/D,KAAK,GAAG,OAAO;CAClB,CASA"}

package/dist/cjs/common/guards.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPlainObject = void 0;
+exports.has = has;
+const isPlainObject = (x) => {
+    if (x === null || typeof x === "undefined")
+        return false;
+    if (Array.isArray(x))
+        return false;
+    if (x instanceof Date)
+        return false;
+    return Object.getPrototypeOf(x) === Object.prototype;
+};
+exports.isPlainObject = isPlainObject;
+function has(x, ...keys) {
+    if (typeof x === "undefined" || x === null)
+        return false;
+    if (keys.every((key) => Object.hasOwn(x, key) || (typeof x === "object" && key in x)))
+        return true;
+    return false;
+}
+//# sourceMappingURL=guards.js.map

package/dist/cjs/common/guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../../src/common/guards.ts"],"names":[],"mappings":";;;AAOA,kBAeC;AAtBM,MAAM,aAAa,GAAG,CAAC,CAAM,EAAqC,EAAE;IACzE,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,WAAW;QAAE,OAAO,KAAK,CAAC;IACzD,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,CAAC,YAAY,IAAI;QAAE,OAAO,KAAK,CAAC;IACpC,OAAO,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,SAAS,CAAC;AACvD,CAAC,CAAC;AALW,QAAA,aAAa,iBAKxB;AAEF,SAAgB,GAAG,CACjB,CAAU,EACV,GAAG,IAAU;IAKb,IAAI,OAAO,CAAC,KAAK,WAAW,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACzD,IACE,IAAI,CAAC,KAAK,CACR,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,GAAG,IAAI,CAAC,CAAC,CACtE;QAED,OAAO,IAAI,CAAC;IACd,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/cjs/common/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./guards";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/dist/cjs/common/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./guards"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,2CAAyB"}

package/dist/cjs/common/padding.d.ts

@@ -0,0 +1,2 @@
+export declare const mkpad: (n: number, fill?: string) => string;
+//# sourceMappingURL=padding.d.ts.map

package/dist/cjs/common/padding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"padding.d.ts","sourceRoot":"","sources":["../../../src/common/padding.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK,GAAI,GAAG,MAAM,EAAE,OAAM,MAAY,KAAG,MAKnD,CAAC"}

package/dist/cjs/common/padding.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mkpad = void 0;
+const mkpad = (n, fill = " ") => n <= 0 ? "" : (Array.from(Array(n).keys())
+    .map(() => fill)
+    .join(""));
+exports.mkpad = mkpad;
+//# sourceMappingURL=padding.js.map

package/dist/cjs/common/padding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"padding.js","sourceRoot":"","sources":["../../../src/common/padding.ts"],"names":[],"mappings":";;;AAAO,MAAM,KAAK,GAAG,CAAC,CAAS,EAAE,OAAe,GAAG,EAAU,EAAE,CAC7D,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CACZ,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;KACxB,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;KACf,IAAI,CAAC,EAAE,CAAC,CACZ,CAAC;AALS,QAAA,KAAK,SAKd"}

package/dist/cjs/common/types.d.ts

@@ -0,0 +1,8 @@
+export type TupleOf<T> = [T, ...T[]] | [...T[], T] | [T];
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type UnionToIntersection<union> = (union extends any ? (k: union) => void : never) extends ((k: infer intersection) => void) ? intersection : never;
+export type IsUnion<a> = [a] extends [UnionToIntersection<a>] ? false : true;
+export type UnionToTuple<union, output extends any[] = []> = UnionToIntersection<union extends any ? (t: union) => union : never> extends ((_: any) => infer elem) ? UnionToTuple<Exclude<union, elem>, [elem, ...output]> : output;
+//# sourceMappingURL=types.d.ts.map

package/dist/cjs/common/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/common/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEzD,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,GAAG,EAAE,CAAC;AAEP,MAAM,MAAM,mBAAmB,CAAC,KAAK,IACnC,CAAC,KAAK,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CACvD,CAAC,CAAC,EAAE,MAAM,YAAY,KAAK,IAAI,CAChC,GACC,YAAY,GACZ,KAAK,CAAC;AAEV,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC;AAE7E,MAAM,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,SAAS,GAAG,EAAE,GAAG,EAAE,IACvD,mBAAmB,CAAC,KAAK,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,KAAK,KAAK,KAAK,GAAG,KAAK,CAAC,SAAS,CAC3E,CAAC,CAAC,EAAE,GAAG,KAAK,MAAM,IAAI,CACvB,GACC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,MAAM,CAAC,CAAC,GACrD,MAAM,CAAC"}

package/dist/cjs/common/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/common/types.js.map

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

package/dist/cjs/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./shape";
+export * from "./shape-utils";
+export * from "./inputs";
+export * from "./translations";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./shape"), exports);
+__exportStar(require("./shape-utils"), exports);
+__exportStar(require("./inputs"), exports);
+__exportStar(require("./translations"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,gDAA8B;AAC9B,2CAAyB;AACzB,iDAA+B"}

package/dist/cjs/inputs/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./json-schema";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/inputs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/inputs/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/cjs/inputs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./json-schema"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/inputs/index.js.map

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

package/dist/cjs/inputs/json-schema.d.ts

@@ -0,0 +1,4 @@
+import { Shape } from "../shape";
+export declare const fromJSONSchema: (schema: unknown, hint?: Shape, typenameOverride?: string) => Shape;
+export declare const fromJSONSchemaWithDefs: (schema: unknown) => [Record<string, Shape>, Shape];
+//# sourceMappingURL=json-schema.d.ts.map

package/dist/cjs/inputs/json-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-schema.d.ts","sourceRoot":"","sources":["../../../src/inputs/json-schema.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,KAAK,EAAU,MAAM,UAAU,CAAC;AAmCnD,eAAO,MAAM,cAAc,GACzB,QAAQ,OAAO,EACf,OAAO,KAAK,EACZ,mBAAmB,MAAM,KACxB,KA+PF,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,QAAQ,OAAO,KACd,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAwB/B,CAAC"}