@synthigy/sdk 0.2.1 → 0.2.2

package/README.md

@@ -60,7 +60,9 @@ Run it with `synthigy exec -- node hello.ts`.
   `watchSqlTemplate` for live analytics, `watch` for raw record events.
 
 - **`actingAs` per call.** Every read and write can run as a specific user, with
-  IAM / RBAC / row-level security enforced *server-side*. Tokens never have to
+  IAM / RBAC / row-level security enforced *server-side*; `whoami({ actingAs })`
+  shows who a call runs as — roles, superuser, whether this client may act as
+  users. Tokens never have to
   reach the browser. `client.login` runs the OIDC authorization-code + PKCE
   exchange for your BFF and leaves sessions to you; `createBrowserLogin` does
   the same for a browser app, as a public client with silent renew and tokens

package/codegen/codegen.mjs

@@ -2,7 +2,6 @@
 // Unified codegen tool:
 //   node codegen.mjs <xsql...> [outDir]     — describe + gen TS (saves ops.ir.json)
 //   node codegen.mjs check <xsql...>         — re-describe, diff, exit 1 on drift
-//   node codegen.mjs pull [endpoint] [out]   — pull schema.json (wraps pull.mjs)
 //
 // Config via env: SYNTHIGY_ENDPOINT, SYNTHIGY_CLIENT_ID, SYNTHIGY_CLIENT_SECRET
 
@@ -29,10 +28,9 @@ synthigy-codegen — generate TypeScript types from XSQL operations
 Usage:
   codegen.mjs [flags] <a.xsql> [b.xsql ...] [outDir]   generate TS from one or more xsql files
   codegen.mjs check   [flags] <a.xsql> [b.xsql ...]    re-describe, diff IR, exit 1 on drift
-  codegen.mjs pull    [endpoint] [out]                  pull schema.json only
 
 Flags:
-  --pull               force schema refresh before generating
+  --pull               refresh schema.json beside the .xsql before generating
   --keys snake|camel   field key casing in generated types (default: snake)
   --no-writes          omit sync / stack / delete methods
   --schema <path>      explicit schema.json path (skips auto-pull)
@@ -47,7 +45,6 @@ Examples:
   node codegen.mjs movies.xsql src/generated/        first run auto-pulls schema
   node codegen.mjs --pull movies.xsql src/generated/ force schema refresh + generate
   node codegen.mjs check movies.xsql                 CI drift check
-  node codegen.mjs pull http://localhost:7887         pull schema only
 `.trim())
   process.exit(0)
 }
@@ -71,13 +68,6 @@ if (!VALID_KEYS.has(flags.keys)) {
 }
 
 const checkMode = pos[0] === 'check'
-const pullMode  = pos[0] === 'pull'
-
-if (pullMode) {
-  execFileSync(process.execPath, [path.join(here, 'pull.mjs'), ...pos.slice(1)],
-    { stdio: 'inherit', env: process.env })
-  process.exit(0)
-}
 
 // Positionals: last non-.xsql arg is outDir; everything before it (files or dirs)
 // is input. check mode has no outDir — every positional is input.
@@ -90,7 +80,6 @@ const xsqlArgs = hasExplicitOut ? rawPos.slice(0, -1) : rawPos
 if (!xsqlArgs.length) {
   console.error('usage: node codegen.mjs [flags] <file.xsql|dir> [...] [outDir]   (dirs searched recursively)')
   console.error('       node codegen.mjs check <file.xsql|dir> [...]')
-  console.error('       node codegen.mjs pull [endpoint] [schema.json]')
   console.error('flags: --pull                force schema refresh')
   console.error('       --keys snake|camel    field casing (default: snake)')
   console.error('       --no-writes           omit sync/stack/delete methods')
@@ -99,6 +88,8 @@ if (!xsqlArgs.length) {
 }
 
 const isDir = p => fs.existsSync(p) && fs.statSync(p).isDirectory()
+const missing = xsqlArgs.filter(a => !fs.existsSync(path.resolve(a)))
+if (missing.length) { console.error(`no such .xsql file or directory: ${missing.join(', ')}`); process.exit(1) }
 const xsqlPaths = xsqlArgs.flatMap(a => {
   const p = path.resolve(a)
   if (isDir(p))

package/codegen/pull.mjs

@@ -21,8 +21,9 @@ import path from 'node:path'
 import { createClient } from '../src/index.js'
 
 const endpoint = process.argv[2] ?? process.env.SYNTHIGY_ENDPOINT
-if (!endpoint) {
-  console.error('usage: node pull.mjs <endpoint>   (or set SYNTHIGY_ENDPOINT)')
+const out = process.argv[3]
+if (!endpoint || !out) {
+  console.error('usage: node pull.mjs <endpoint> <schema.json>')
   process.exit(1)
 }
 
@@ -41,8 +42,7 @@ if (SYNTHIGY_CLIENT_ID && SYNTHIGY_CLIENT_SECRET) {
   config.token = SYNTHIGY_TOKEN ?? '' // '' = authless (bare server)
 }
 
-const here = path.dirname(new URL(import.meta.url).pathname)
-const outPath = process.argv[3] ? path.resolve(process.argv[3]) : path.join(here, 'schema.json')
+const outPath = path.resolve(out)
 
 const client = createClient(config)
 const schema = await client.schema()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synthigy/sdk",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Zero-dependency client for Synthigy's /data endpoint",
   "author": "Robert Geršak",
   "license": "MIT",

package/src/index.d.ts

@@ -324,11 +324,50 @@ export type SynthigyErrorCode =
   | 'HTTP_ERROR' | 'OPERATION_ERROR' | 'INTERNAL_ERROR'
   | (string & {})
 
+/** `whoami()` — the identity a call runs as. `client` is null in-process (no OAuth client). */
+export interface WhoAmI {
+  xid: string | null
+  name: string | null
+  active: boolean
+  superuser: boolean
+  roles: string[]
+  groups: string[]
+  /** `trusted`: this client may act as users (confidential, active, flagged trusted). */
+  client: { id: string; trusted: boolean } | null
+}
+
+export type SynthigyErrorCategory =
+  | 'auth' | 'iam' | 'validation' | 'not_found'
+  | 'conflict' | 'rate_limit' | 'network' | 'internal'
+
+/** 1-based source position (XSQL_PARSE_ERROR, TEMPLATE_*). */
+export interface SourcePosition { line: number; col: number }
+
 export class SynthigyError extends Error {
   name: 'SynthigyError'
   code: SynthigyErrorCode
+  category: SynthigyErrorCategory
+  /** True for known network/rate_limit/internal codes, or when the server marked the error retryable. */
+  retryable: boolean
   details?: unknown
-  constructor(message: string, code: string, details?: unknown)
+  hint?: string
+  available?: string[]
+  path?: unknown
+  entity?: string
+  relation?: string
+  operator?: string
+  requestId?: string
+  status?: number
+  line?: number
+  col?: number
+  start?: SourcePosition
+  end?: SourcePosition
+  diagnostics?: unknown[]
+  constructor(message: string, code: string, details?: unknown, extras?: {
+    hint?: string; available?: string[]; path?: unknown; entity?: string; relation?: string
+    operator?: string; requestId?: string; status?: number; retryable?: boolean
+    line?: number; col?: number; start?: SourcePosition; end?: SourcePosition; diagnostics?: unknown[]
+  })
 }
 
 // ============================================================================
@@ -789,6 +828,9 @@ export class SynthigyClient {
    */
   deployedModel(opts?: ExecOpts): Promise<Record<string, unknown>>
 
+  /** Who a call runs as, after `actingAs` — roles, superuser, and whether this client may act as users. */
+  whoami(opts?: ExecOpts): Promise<WhoAmI>
+
   /**
    * Deploy a dataset version from a modeler export — pass the export file's
    * contents verbatim, the server decodes it. Requires `dataset:deploy`.
@@ -1210,6 +1252,7 @@ export const op: {
   query(xsql: string, params?: Record<string, unknown>, verb?: string): Operation
   deployedModel(): Operation
   runtimeModel(): Operation
+  whoami(): Operation
   deploy(exportContents: string): Operation
   destroy(datasetXid: string): Operation
 }
@@ -1291,6 +1334,7 @@ export const onboardComplete: SynthigyClient['onboardComplete']
 export const deploy: SynthigyClient['deploy']
 export const destroy: SynthigyClient['destroy']
 export const deployedModel: SynthigyClient['deployedModel']
+export const whoami: SynthigyClient['whoami']
 export const runtimeModel: SynthigyClient['runtimeModel']
 export const token: SynthigyClient['token']
 export function history(): SynthigyClient['history']

package/src/index.js

@@ -2003,6 +2003,19 @@ class SynthigyClient {
     return result.data
   }
 
+  /**
+   * Who a call runs as, after `actingAs`: xid, name, active, superuser, roles,
+   * groups, and `client` ({ id, trusted }) — trusted means it may act as users.
+   *
+   * @param {Object} [opts] - Options ({ actingAs })
+   * @returns {Promise<Object>}
+   */
+  async whoami(opts) {
+    const [result] = await this.exec([{ op: 'whoami' }], opts)
+    if (!result.ok) throw _errorFromServer(result.error, undefined, result._requestId)
+    return result.data
+  }
+
   /**
    * Deploy a dataset version from a modeler export. Pass the export file's
    * contents verbatim — the server decodes it. Requires `dataset:deploy`.
@@ -2561,6 +2574,7 @@ export const op = {
   query:       (xsql, params, verb = 'search') => ({ op: 'xsql', xsql: xsqlDocument(xsql, verb), ...(params !== undefined && { params }) }),
   deployedModel: () => ({ op: 'deployed-model' }),
   runtimeModel: () => ({ op: 'runtime-model' }),
+  whoami:       ()                       => ({ op: 'whoami' }),
   deploy:       (exportContents)         => ({ op: 'deploy', data: exportContents }),
   destroy:      (datasetXid)             => ({ op: 'delete', entity: 'dataset', data: { xid: datasetXid } }),
 }
@@ -2692,6 +2706,7 @@ export const onboardComplete = (...a) => _dflt().onboardComplete(...a)
 export const deploy        = (...a) => _dflt().deploy(...a)
 export const destroy       = (...a) => _dflt().destroy(...a)
 export const deployedModel = (...a) => _dflt().deployedModel(...a)
+export const whoami        = (...a) => _dflt().whoami(...a)
 export const runtimeModel  = (...a) => _dflt().runtimeModel(...a)
 export const token         = (...a) => _dflt().token(...a)
 export const history       = () => _dflt().history