@cauthyhq/spec 0.0.0 → 0.2.0

package/index.d.ts

@@ -0,0 +1,24 @@
+// The types of Cauthy's public API (openapi/cauthy.yaml) and of the auth-bff
+// protocol (openapi/auth-bff.yaml), generated by openapi-typescript into
+// cauthy.d.ts and auth-bff.d.ts. Types only: import them with `import type`.
+import type { components as CauthyComponents, operations as CauthyOperations, paths as CauthyPaths } from './cauthy.js'
+import type { components as AuthBffComponents, paths as AuthBffPaths } from './auth-bff.js'
+
+export type { AuthBffComponents, AuthBffPaths, CauthyComponents, CauthyOperations, CauthyPaths }
+
+/** A schema of Cauthy's public API by name: `CauthySchema<'OAuthUserInfo'>`. */
+export type CauthySchema<Name extends keyof CauthyComponents['schemas']> = CauthyComponents['schemas'][Name]
+
+/** `{"data": T}`: how Cauthy answers with one resource. */
+export interface CauthyData<T> {
+  data: T
+}
+
+/** `{"data": T[], "total_count": n}`: how Cauthy answers with a list. */
+export interface CauthyList<T> {
+  data: T[]
+  total_count: number
+}
+
+/** The auth-bff protocol version these types describe (cauthy-sdk-spec's VERSION). */
+export type ProtocolVersion = 1

package/package.json

@@ -1,8 +1,46 @@
 {
   "name": "@cauthyhq/spec",
-  "version": "0.0.0",
-  "description": "Reserved for Cauthy. The real package is coming; see https://github.com/vennet-developers.",
+  "version": "0.2.0",
+  "description": "TypeScript types of Cauthy's public API and of the auth-bff protocol, generated from cauthy-sdk-spec.",
   "license": "Apache-2.0",
-  "repository": { "type": "git", "url": "https://github.com/vennet-developers/cauthy-sdk-spec" },
-  "files": ["README.md"]
+  "author": "Vennet Developers",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vennet-developers/cauthy-sdk-spec.git",
+    "directory": "packages/spec"
+  },
+  "homepage": "https://github.com/vennet-developers/cauthy-sdk-spec/tree/main/packages/spec#readme",
+  "bugs": "https://github.com/vennet-developers/cauthy-sdk-spec/issues",
+  "cauthy": {
+    "protocol": 1
+  },
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "index.d.ts",
+    "cauthy.d.ts",
+    "auth-bff.d.ts",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "generate": "openapi-typescript ../../openapi/cauthy.yaml -o cauthy.d.ts && openapi-typescript ../../openapi/auth-bff.yaml -o auth-bff.d.ts",
+    "typecheck": "tsc -p tsconfig.json",
+    "prepack": "cp ../../LICENSE ../../NOTICE ."
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "devDependencies": {
+    "openapi-typescript": "7.13.0",
+    "typescript": "5.9.3"
+  }
 }