@seamapi/types 0.0.4 → 0.0.6

package/README.md

@@ -7,10 +7,45 @@ TypeScript types for the Seam API.
 
 ## Description
 
-TODO
+This repository aggregates the latest route schemas and type definitions for the Seam API.
+Upstream Seam repositories automatically contribute updates on every deployment
+via a Pull Request opened by Seam Bot.
+This ensures downstream consumers, e.g., the SDK, fakes, documentation generators, etc.,
+have a single source of truth that stays up to date with the API.
+
+### Structure
+
+The main entrypoint for this module is empty: there is dedicated entrypoint for each Seam API namespace.
+
+Each directory under `src/lib/seam/*` is owned by an upstream Seam repository.
+These files should not be edited manually as they will be overridden by automation.
+
+Each entrypoint may export one or more of the following:
+
+- Zod schemas: collectively exported as a single object named `schemas`.
+- Types: derived directly from the [Zod Schemas][zod] and exported at the top level.
+- A separate collection of Zod schmeas named `routes`.
+- A type named `Routes` that implements the
+  [Route Definition interface from typed-axios][typed-axios Route Definition].
+- The OpenAPI schema as a plain object named `openapi`.
+
+[nextlove]: https://github.com/seamapi/nextlove
+[typed-axios Route Definition]: https://github.com/seamapi/typed-axios#route-definition
+[OpenAPI]: https://www.openapis.org/
+[zod]: https://zod.dev/
 
 ## Installation
 
+### Types Only
+
+Add this as a development dependency to your project using [npm] with
+
+```
+$ npm install --save-dev @seamapi/types
+```
+
+### Types and Zod Schemas
+
 Add this as a dependency to your project using [npm] with
 
 ```
@@ -28,7 +63,6 @@ $ git clone https://github.com/seamapi/types.git
 $ cd types
 $ nvm install
 $ npm install
-$ npm run test:watch
 ```
 
 Primary development tasks are defined under `scripts` in `package.json`

package/connect.d.ts

@@ -0,0 +1 @@
+export * from './lib/seam/connect/index.js';

package/connect.js

@@ -0,0 +1,2 @@
+export * from './lib/seam/connect/index.js';
+//# sourceMappingURL=connect.js.map

package/connect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect.js","sourceRoot":"","sources":["src/connect.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAA"}

package/dist/connect.cjs

@@ -0,0 +1,12 @@
+'use strict';
+
+var zod = require('zod');
+
+// src/lib/seam/connect/models/workspace.ts
+var workspace = zod.z.object({
+  workspace_id: zod.z.string().uuid()
+});
+
+exports.workspace = workspace;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=connect.cjs.map

package/dist/connect.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/seam/connect/models/workspace.ts"],"names":[],"mappings":";AAAA,SAAS,SAAS;AAEX,IAAM,YAAY,EAAE,OAAO;AAAA,EAChC,cAAc,EAAE,OAAO,EAAE,KAAK;AAChC,CAAC","sourcesContent":["import { z } from \"zod\"\n\nexport const workspace = z.object({\n  workspace_id: z.string().uuid(),\n})\nexport type Workspace = z.infer<typeof workspace>\n"]}

package/dist/connect.d.cts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+
+declare const workspace: z.ZodObject<{
+    workspace_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    workspace_id: string;
+}, {
+    workspace_id: string;
+}>;
+type Workspace = z.infer<typeof workspace>;
+
+export { Workspace, workspace };

package/dist/index.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+// src/index.ts
+var src_default = null;
+
+module.exports = src_default;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAA,IAAO,cAAQ","sourcesContent":["export default null\n"]}

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+declare const _default: null;
+
+export { _default as default };

package/index.d.ts

@@ -1,2 +1,2 @@
-export { default } from './lib/index.js';
-export * from './lib/index.js';
+declare const _default: null;
+export default _default;

package/index.js

@@ -1,3 +1,2 @@
-export { default } from './lib/index.js';
-export * from './lib/index.js';
+export default null;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,eAAe,IAAI,CAAA"}

package/lib/seam/connect/index.d.ts

@@ -0,0 +1 @@
+export * from "./models/index.js";

package/lib/seam/connect/index.js

@@ -0,0 +1,2 @@
+export * from "./models/index.js";
+//# sourceMappingURL=index.js.map

package/lib/seam/connect/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}

package/lib/seam/connect/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./workspace.js";

package/lib/seam/connect/models/index.js

@@ -0,0 +1,2 @@
+export * from "./workspace.js";
+//# sourceMappingURL=index.js.map

package/lib/seam/connect/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}

package/lib/seam/connect/models/workspace.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export declare const workspace: z.ZodObject<{
+    workspace_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    workspace_id: string;
+}, {
+    workspace_id: string;
+}>;
+export type Workspace = z.infer<typeof workspace>;

package/lib/seam/connect/models/workspace.js

@@ -0,0 +1,5 @@
+import { z } from "zod";
+export const workspace = z.object({
+    workspace_id: z.string().uuid(),
+});
+//# sourceMappingURL=workspace.js.map

package/lib/seam/connect/models/workspace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/models/workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;CAChC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -8,7 +8,13 @@
   "exports": {
     ".": {
       "import": "./index.js",
+      "require": "./dist/index.cjs",
       "types": "./index.d.ts"
+    },
+    "./connect": {
+      "import": "./connect.js",
+      "require": "./dist/connect.cjs",
+      "types": "./connect.d.ts"
     }
   },
   "module": "index.js",
@@ -28,50 +34,54 @@
     "index.js",
     "index.js.map",
     "index.d.ts",
+    "connect.js",
+    "connect.js.map",
+    "connect.d.ts",
+    "dist",
     "lib",
-    "src",
-    "!**/*.test.ts"
+    "src"
   ],
   "scripts": {
-    "build": "npm run build:ts",
-    "postbuild": "node ./index.js",
+    "build": "npm run build:entrypoints",
+    "prebuild": "concurrently --raw --group 'tsx src/index.ts' 'tsx src/connect.ts'",
+    "postbuild": "concurrently --raw --group 'node ./index.js' 'node ./connect.js'",
+    "build:entrypoints": "npm run build:ts",
+    "postbuild:entrypoints": "tsup",
     "build:ts": "tsc --project tsconfig.build.json",
-    "prebuild:ts": "del 'index.*' lib",
+    "prebuild:ts": "del 'index.*' 'connect.*' 'lib'",
     "postbuild:ts": "tsc-alias --project tsconfig.build.json",
     "typecheck": "tsc",
-    "test": "c8 ava",
-    "pretest": "tsx src/index.ts",
-    "test:update": "ava --update-snapshots",
-    "test:watch": "ava --watch",
-    "test:debug": "ava debug --break",
     "lint": "eslint --ignore-path .gitignore .",
     "prelint": "prettier --check --ignore-path .gitignore .",
     "postversion": "git push --follow-tags",
-    "example": "tsx examples",
-    "example:inspect": "tsx --inspect examples",
-    "format": "eslint --ignore-path .gitignore --fix .",
-    "preformat": "prettier --write --ignore-path .gitignore .",
-    "report": "c8 report"
+    "format": "prettier --write --ignore-path .gitignore .",
+    "preformat": "patch-package",
+    "postformat": "eslint --ignore-path .gitignore --fix ."
   },
   "engines": {
     "node": ">=16.13.0",
     "npm": ">= 8.1.0"
   },
+  "peerDependencies": {
+    "zod": "^3.21.4"
+  },
   "devDependencies": {
     "@types/node": "^18.11.18",
-    "ava": "^5.0.1",
-    "c8": "^8.0.0",
+    "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",
     "eslint": "^8.9.0",
     "eslint-config-prettier": "^8.4.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-config-standard-with-typescript": "^36.0.0",
+    "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "eslint-plugin-unused-imports": "^2.0.0",
-    "landlubber": "^1.0.0",
+    "patch-package": "^7.0.1",
     "prettier": "^3.0.0",
     "tsc-alias": "^1.8.2",
+    "tsup": "^7.1.0",
     "tsx": "^3.12.1",
-    "typescript": "^5.0.2"
+    "typescript": "^5.0.2",
+    "zod": "^3.21.4"
   }
 }

package/src/connect.ts

@@ -0,0 +1 @@
+export * from './lib/seam/connect/index.js'

package/src/index.ts

@@ -1,2 +1 @@
-export { default } from 'lib/index.js'
-export * from 'lib/index.js'
+export default null

package/src/lib/seam/.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "trailingComma": "es5",
+  "endOfLine": "lf"
+}

package/src/lib/seam/connect/index.ts

@@ -0,0 +1 @@
+export * from "./models/index.js"

package/src/lib/seam/connect/models/index.ts

@@ -0,0 +1 @@
+export * from "./workspace.js"

package/src/lib/seam/connect/models/workspace.ts

@@ -0,0 +1,6 @@
+import { z } from "zod"
+
+export const workspace = z.object({
+  workspace_id: z.string().uuid(),
+})
+export type Workspace = z.infer<typeof workspace>

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-export { todo as default } from './todo.js';
-export { todo } from './todo.js';

package/lib/index.js

@@ -1,3 +0,0 @@
-export { todo as default } from './todo.js';
-export { todo } from './todo.js';
-//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,OAAO,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA"}

package/lib/todo.d.ts

@@ -1 +0,0 @@
-export declare const todo: (x: string) => string;

package/lib/todo.js

@@ -1,2 +0,0 @@
-export const todo = (x) => x;
-//# sourceMappingURL=todo.js.map

package/lib/todo.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"todo.js","sourceRoot":"","sources":["../src/lib/todo.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,CAAA"}

package/src/lib/index.ts

@@ -1,2 +0,0 @@
-export { todo as default } from './todo.js'
-export { todo } from './todo.js'

package/src/lib/todo.ts

@@ -1 +0,0 @@
-export const todo = (x: string): string => x