@quadrokit/shared 0.1.0

package/README.md

@@ -0,0 +1,10 @@
+# `@quadrokit/shared`
+
+Small **TypeScript** types and helpers for the **4D REST catalog** JSON (e.g. `dataClasses`, `methods`, `__NAME`).
+
+## Exports
+
+- Catalog shape types (`CatalogJson`, `CatalogDataClass`, …)
+- `sessionCookieName(catalog)` — builds `4DSID_${__NAME}` from catalog metadata (verify against your 4D deployment)
+
+Used by `@quadrokit/client` codegen and can be reused in other tooling.

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@quadrokit/shared",
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
+    }
+  },
+  "scripts": {
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}

package/src/catalog.ts

@@ -0,0 +1,70 @@
+/** 4D REST catalog JSON (subset used by QuadroKit). */
+
+export type CatalogAttributeKind =
+  | 'storage'
+  | 'relatedEntity'
+  | 'relatedEntities'
+  | 'calculated'
+  | 'alias'
+
+export interface CatalogAttribute {
+  name: string
+  kind: CatalogAttributeKind
+  type?: string
+  exposed?: boolean
+  path?: string
+  foreignKey?: string
+  inverseName?: string
+  reversePath?: boolean
+  readOnly?: boolean
+  behavior?: string
+  simpleDate?: boolean
+  not_null?: boolean
+  identifying?: boolean
+}
+
+export interface CatalogMethod {
+  name: string
+  applyTo?: string
+  scope?: string
+  from?: string
+  allowedOnHTTPGET?: boolean
+  exposed?: boolean
+}
+
+export interface CatalogDataClass {
+  name: string
+  className: string
+  collectionName: string
+  exposed: boolean
+  attributes: CatalogAttribute[]
+  methods?: CatalogMethod[]
+  key?: { name: string }[]
+}
+
+export interface CatalogSingletonMethod {
+  name: string
+  allowedOnHTTPGET?: boolean
+  exposed?: boolean
+}
+
+export interface CatalogSingleton {
+  name: string
+  exposed: boolean
+  methods: CatalogSingletonMethod[]
+}
+
+export interface CatalogJson {
+  __UNIQID?: string
+  __BASEID?: string
+  __NAME?: string
+  properties?: Record<string, unknown>
+  singletons?: CatalogSingleton[]
+  methods?: CatalogMethod[]
+  dataClasses?: CatalogDataClass[]
+}
+
+export function sessionCookieName(catalog: Pick<CatalogJson, '__NAME'>): string {
+  const db = catalog.__NAME ?? 'default'
+  return `4DSID_${db}`
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+export type {
+  CatalogAttribute,
+  CatalogAttributeKind,
+  CatalogDataClass,
+  CatalogJson,
+  CatalogMethod,
+  CatalogSingleton,
+  CatalogSingletonMethod,
+} from './catalog.js'
+export { sessionCookieName } from './catalog.js'

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "noEmit": true
+  },
+  "include": ["src/**/*.ts"]
+}