on-zero 0.7.2-1784530701923 → 0.7.2

package/src/orez.ts

@@ -1,331 +0,0 @@
-import { createBuilder, mustGetQuery } from '@rocicorp/zero'
-import { asQueryInternals } from '@rocicorp/zero/bindings'
-import { handleQueryRequest as zeroHandleQueryRequest } from '@rocicorp/zero/server'
-import { createAsyncContext } from '@take-out/helpers'
-import {
-  MutationApplicationError,
-  registerMutators,
-  type JsonValue,
-  type MutatorRegistry,
-  type NormalizedClaims,
-  type SyncExecutor,
-} from 'orez/sync-executor'
-
-import { createPermissions } from './createPermissions'
-import { createMutators } from './helpers/createMutators'
-import { getScopedAuthData, runWithAuthScope } from './helpers/mutatorContext'
-import { runWithQueryContext } from './helpers/queryContext'
-import { getMutationsPermissions } from './modelRegistry'
-import { setCustomQueries } from './run'
-import { getZQL, setEnvironment, setSchema } from './state'
-import { setEvaluatingPermission } from './where'
-import { setRunner } from './zeroRunner'
-
-import type {
-  AdminRoleMode,
-  AuthData,
-  GenericModels,
-  MutatorContext,
-  QueryBuilder,
-  Transaction,
-} from './types'
-import type {
-  AnyQueryRegistry,
-  HumanReadable,
-  Query,
-  Schema as ZeroSchema,
-} from '@rocicorp/zero'
-
-export type ValidateQueryArgs = {
-  authData: AuthData | null
-  queryName: string
-  params: unknown
-}
-
-export type ValidateMutationArgs = {
-  authData: AuthData | null
-  mutatorName: string
-  tableName: string
-  args: unknown
-}
-
-export type ValidateQueryFn = (args: ValidateQueryArgs) => void
-export type ValidateMutationFn = (args: ValidateMutationArgs) => void | Promise<void>
-
-type MutateAuthData = Pick<AuthData, 'id'> & Partial<AuthData>
-
-export type MutateOptions = {
-  authData?: MutateAuthData
-}
-
-export type ServerMutate<Models extends GenericModels> = {
-  [Key in keyof Models]: {
-    [K in keyof Models[Key]['mutate']]: Models[Key]['mutate'][K] extends (
-      ctx: MutatorContext,
-      arg: infer Arg,
-    ) => any
-      ? (arg: Arg, options?: MutateOptions) => Promise<void>
-      : (options?: MutateOptions) => Promise<void>
-  }
-}
-
-export type CreateOrezBindingsOptions<
-  Schema extends ZeroSchema,
-  Models extends GenericModels,
-  ServerActions extends Record<string, unknown>,
-> = {
-  schema: Schema
-  models: Models
-  createServerActions: () => ServerActions
-  queries?: AnyQueryRegistry
-  mutations?: Record<string, Record<string, unknown>>
-  validateQuery?: ValidateQueryFn
-  validateMutation?: ValidateMutationFn
-  defaultAllowAdminRole?: AdminRoleMode
-  mapClaims?: (claims: NormalizedClaims) => AuthData
-}
-
-export type OrezBindings<Schema extends ZeroSchema, Models extends GenericModels> = {
-  mutators: MutatorRegistry<Schema>
-  resolveQuery(
-    name: string,
-    args: readonly JsonValue[],
-    claims: NormalizedClaims,
-  ): Promise<JsonValue>
-  transformQueryRequest(options: {
-    authData: AuthData | null
-    request: Request
-  }): ReturnType<typeof zeroHandleQueryRequest>
-  server(executor: SyncExecutor<Schema>): {
-    mutate: ServerMutate<Models>
-    transaction<Value>(
-      claims: NormalizedClaims,
-      work: (tx: Transaction) => Value | Promise<Value>,
-    ): Promise<Value>
-    query<Result>(
-      claims: NormalizedClaims,
-      work: (q: QueryBuilder) => Query<any, Schema, Result>,
-    ): Promise<HumanReadable<Result>>
-  }
-}
-
-export function createOrezBindings<
-  Schema extends ZeroSchema,
-  Models extends GenericModels,
-  ServerActions extends Record<string, unknown>,
->(
-  options: CreateOrezBindingsOptions<Schema, Models, ServerActions>,
-): OrezBindings<Schema, Models> {
-  setSchema(options.schema, createBuilder(options.schema))
-  setEnvironment('server')
-  if (options.queries) setCustomQueries(options.queries)
-
-  const mapClaims = options.mapClaims ?? defaultMapClaims
-  const permissions = createPermissions({
-    environment: 'server',
-    schema: options.schema,
-    adminRoleMode: options.defaultAllowAdminRole ?? 'all',
-  })
-  const registry: Record<string, MutatorRegistry<Schema>[string]> = {}
-  const invocation = createAsyncContext<{
-    authData: AuthData
-    ctx: Parameters<MutatorRegistry<Schema>[string]>[0]['ctx']
-  }>()
-  const decoratedMutators = createMutators({
-    authData: null,
-    can: permissions.can,
-    createServerActions: options.createServerActions,
-    environment: 'server',
-    models: options.models,
-    mutationValidators: options.mutations,
-    validateMutation: options.validateMutation
-      ? async (input) => {
-          try {
-            await options.validateMutation!(input)
-          } catch (error) {
-            throw mutationApplicationError(error)
-          }
-        }
-      : undefined,
-    resolveAuthData: () => invocation.get()?.authData ?? null,
-    enqueueTask(task, taskOptions) {
-      const current = invocation.get()
-      if (!current) throw new Error('on-zero task scheduled outside an Orez mutation')
-      current.ctx.defer(() => runWithAuthScope(current.authData, task), taskOptions)
-    },
-  }) as Record<string, Record<string, (tx: Transaction, args: unknown) => Promise<void>>>
-
-  for (const [modelName, model] of Object.entries(options.models)) {
-    for (const mutatorName of Object.keys(model.mutate ?? {})) {
-      registry[`${modelName}|${mutatorName}`] = async ({ tx, args, ctx }) => {
-        const authData = mapClaims(ctx.claims)
-        const mutation = decoratedMutators[modelName]?.[mutatorName]
-        if (!mutation)
-          throw new Error(`unknown on-zero mutator: ${modelName}|${mutatorName}`)
-        try {
-          await invocation.run({ authData, ctx }, () =>
-            mutation(tx as unknown as Transaction, args),
-          )
-        } catch (error) {
-          const name = (error as { name?: unknown })?.name
-          if (name === 'MutationApplicationError') throw error
-          if (name !== 'PermissionError' && name !== 'ValiError') throw error
-          throw mutationApplicationError(error)
-        }
-      }
-    }
-  }
-
-  const bindings: OrezBindings<Schema, Models> = {
-    mutators: registerMutators<Schema, typeof registry>(registry),
-    async resolveQuery(name, args, claims) {
-      if (!options.queries) {
-        throw new Error('No queries registered with createOrezBindings.')
-      }
-      const authData = mapClaims(claims)
-      const query = await runWithQueryContext({ authData }, () =>
-        resolveServerQuery({
-          authData,
-          name,
-          args: args[0],
-          queries: options.queries!,
-          permissions,
-          validateQuery: options.validateQuery,
-        }),
-      )
-      return asQueryInternals(query as never).ast as JsonValue
-    },
-    async transformQueryRequest({ authData, request }) {
-      if (!options.queries) {
-        throw new Error('No queries registered with createOrezBindings.')
-      }
-      const handler = (name: string, args: unknown) =>
-        resolveServerQuery({
-          authData,
-          name,
-          args,
-          queries: options.queries!,
-          permissions,
-          validateQuery: options.validateQuery,
-        })
-      const userID = typeof authData?.id === 'string' ? authData.id : undefined
-      return runWithQueryContext({ authData: authData || ({} as AuthData) }, () =>
-        userID === undefined
-          ? zeroHandleQueryRequest(handler as never, options.schema, request)
-          : zeroHandleQueryRequest({
-              handler: handler as never,
-              schema: options.schema,
-              request,
-              userID,
-            }),
-      )
-    },
-    server(executor) {
-      const transaction = <Value>(
-        claims: NormalizedClaims,
-        work: (tx: Transaction) => Value | Promise<Value>,
-      ) => executor.transaction(claims, (tx) => work(tx as unknown as Transaction))
-
-      setRunner((query) =>
-        transaction({ userID: 'server' }, (tx) => tx.run(query as never)),
-      )
-
-      const mutate = new Proxy({} as ServerMutate<Models>, {
-        get(_target, modelName: string) {
-          return new Proxy(
-            {},
-            {
-              get(_inner, mutatorName: string) {
-                const handler = options.models[modelName]?.mutate?.[mutatorName]
-                const acceptsArgument =
-                  typeof handler === 'function' && handler.length > 1
-                return (
-                  argsOrOptions: JsonValue | MutateOptions,
-                  optionsForArgument?: MutateOptions,
-                ) => {
-                  const args = acceptsArgument ? (argsOrOptions as JsonValue) : null
-                  const mutateOptions = acceptsArgument
-                    ? optionsForArgument
-                    : (argsOrOptions as MutateOptions | undefined)
-                  const scoped = mutateOptions?.authData ?? getScopedAuthData()
-                  const claims = authToClaims(scoped)
-                  return executor.execute(`${modelName}|${mutatorName}`, args, claims)
-                }
-              },
-            },
-          )
-        },
-      })
-
-      return {
-        mutate,
-        transaction,
-        query<Result>(
-          claims: NormalizedClaims,
-          work: (q: QueryBuilder) => Query<any, Schema, Result>,
-        ) {
-          return runWithQueryContext({ authData: mapClaims(claims) }, () =>
-            executor.query(claims, (tx) => tx.run(work(getZQL()) as never)),
-          ) as Promise<HumanReadable<Result>>
-        },
-      }
-    },
-  }
-
-  return bindings
-}
-
-function resolveServerQuery({
-  authData,
-  name,
-  args,
-  queries,
-  permissions,
-  validateQuery,
-}: {
-  authData: AuthData | null
-  name: string
-  args: unknown
-  queries: AnyQueryRegistry
-  permissions: ReturnType<typeof createPermissions>
-  validateQuery?: ValidateQueryFn
-}) {
-  if (name.startsWith('permission.')) {
-    const table = name.slice('permission.'.length)
-    const { objOrId } = args as { objOrId: string | Record<string, unknown> }
-    const permission = getMutationsPermissions(table)
-    if (!permission)
-      throw new Error(`[permission] no permission defined for table: ${table}`)
-    setEvaluatingPermission(true)
-    try {
-      return (getZQL() as any)[table]
-        .where((eb: any) =>
-          permissions.buildPermissionQuery(authData, eb, permission, objOrId, table),
-        )
-        .one()
-    } finally {
-      setEvaluatingPermission(false)
-    }
-  }
-
-  validateQuery?.({ authData, queryName: name, params: args })
-  return (mustGetQuery as any)(queries, name).fn({ args, ctx: authData })
-}
-
-function defaultMapClaims(claims: NormalizedClaims): AuthData {
-  return {
-    ...claims,
-    id: typeof claims.id === 'string' ? claims.id : claims.userID,
-  } as AuthData
-}
-
-function authToClaims(authData: AuthData | null | undefined): NormalizedClaims {
-  const data = (authData ?? {}) as unknown as Record<string, JsonValue>
-  const userID = typeof data.id === 'string' ? data.id : 'server'
-  return { ...data, userID }
-}
-
-function mutationApplicationError(error: unknown): MutationApplicationError {
-  const message = error instanceof Error ? error.message : String(error)
-  return new MutationApplicationError(message, message)
-}

package/types/orez.d.ts

@@ -1,53 +0,0 @@
-import { handleQueryRequest as zeroHandleQueryRequest } from '@rocicorp/zero/server';
-import { type JsonValue, type MutatorRegistry, type NormalizedClaims, type SyncExecutor } from 'orez/sync-executor';
-import type { AdminRoleMode, AuthData, GenericModels, MutatorContext, QueryBuilder, Transaction } from './types';
-import type { AnyQueryRegistry, HumanReadable, Query, Schema as ZeroSchema } from '@rocicorp/zero';
-export type ValidateQueryArgs = {
-    authData: AuthData | null;
-    queryName: string;
-    params: unknown;
-};
-export type ValidateMutationArgs = {
-    authData: AuthData | null;
-    mutatorName: string;
-    tableName: string;
-    args: unknown;
-};
-export type ValidateQueryFn = (args: ValidateQueryArgs) => void;
-export type ValidateMutationFn = (args: ValidateMutationArgs) => void | Promise<void>;
-type MutateAuthData = Pick<AuthData, 'id'> & Partial<AuthData>;
-export type MutateOptions = {
-    authData?: MutateAuthData;
-};
-export type ServerMutate<Models extends GenericModels> = {
-    [Key in keyof Models]: {
-        [K in keyof Models[Key]['mutate']]: Models[Key]['mutate'][K] extends (ctx: MutatorContext, arg: infer Arg) => any ? (arg: Arg, options?: MutateOptions) => Promise<void> : (options?: MutateOptions) => Promise<void>;
-    };
-};
-export type CreateOrezBindingsOptions<Schema extends ZeroSchema, Models extends GenericModels, ServerActions extends Record<string, unknown>> = {
-    schema: Schema;
-    models: Models;
-    createServerActions: () => ServerActions;
-    queries?: AnyQueryRegistry;
-    mutations?: Record<string, Record<string, unknown>>;
-    validateQuery?: ValidateQueryFn;
-    validateMutation?: ValidateMutationFn;
-    defaultAllowAdminRole?: AdminRoleMode;
-    mapClaims?: (claims: NormalizedClaims) => AuthData;
-};
-export type OrezBindings<Schema extends ZeroSchema, Models extends GenericModels> = {
-    mutators: MutatorRegistry<Schema>;
-    resolveQuery(name: string, args: readonly JsonValue[], claims: NormalizedClaims): Promise<JsonValue>;
-    transformQueryRequest(options: {
-        authData: AuthData | null;
-        request: Request;
-    }): ReturnType<typeof zeroHandleQueryRequest>;
-    server(executor: SyncExecutor<Schema>): {
-        mutate: ServerMutate<Models>;
-        transaction<Value>(claims: NormalizedClaims, work: (tx: Transaction) => Value | Promise<Value>): Promise<Value>;
-        query<Result>(claims: NormalizedClaims, work: (q: QueryBuilder) => Query<any, Schema, Result>): Promise<HumanReadable<Result>>;
-    };
-};
-export declare function createOrezBindings<Schema extends ZeroSchema, Models extends GenericModels, ServerActions extends Record<string, unknown>>(options: CreateOrezBindingsOptions<Schema, Models, ServerActions>): OrezBindings<Schema, Models>;
-export {};
-//# sourceMappingURL=orez.d.ts.map

package/types/orez.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"orez.d.ts","sourceRoot":"","sources":["../src/orez.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,IAAI,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAEpF,OAAO,EAGL,KAAK,SAAS,EACd,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EAClB,MAAM,oBAAoB,CAAA;AAY3B,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,aAAa,EACb,cAAc,EACd,YAAY,EACZ,WAAW,EACZ,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,KAAK,EACL,MAAM,IAAI,UAAU,EACrB,MAAM,gBAAgB,CAAA;AAEvB,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,CAAA;AAC/D,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAErF,KAAK,cAAc,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;AAE9D,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,cAAc,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,MAAM,SAAS,aAAa,IAAI;KACtD,GAAG,IAAI,MAAM,MAAM,GAAG;SACpB,CAAC,IAAI,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CACnE,GAAG,EAAE,cAAc,EACnB,GAAG,EAAE,MAAM,GAAG,KACX,GAAG,GACJ,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,GACpD,CAAC,OAAO,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC;KAC/C;CACF,CAAA;AAED,MAAM,MAAM,yBAAyB,CACnC,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,aAAa,EAC5B,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC3C;IACF,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,mBAAmB,EAAE,MAAM,aAAa,CAAA;IACxC,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACnD,aAAa,CAAC,EAAE,eAAe,CAAA;IAC/B,gBAAgB,CAAC,EAAE,kBAAkB,CAAA;IACrC,qBAAqB,CAAC,EAAE,aAAa,CAAA;IACrC,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,QAAQ,CAAA;CACnD,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,MAAM,SAAS,UAAU,EAAE,MAAM,SAAS,aAAa,IAAI;IAClF,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IACjC,YAAY,CACV,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,SAAS,SAAS,EAAE,EAC1B,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,qBAAqB,CAAC,OAAO,EAAE;QAC7B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;QACzB,OAAO,EAAE,OAAO,CAAA;KACjB,GAAG,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAA;IAC7C,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG;QACtC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;QAC5B,WAAW,CAAC,KAAK,EACf,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAChD,OAAO,CAAC,KAAK,CAAC,CAAA;QACjB,KAAK,CAAC,MAAM,EACV,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,CAAC,EAAE,YAAY,KAAK,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,GACpD,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;KAClC,CAAA;CACF,CAAA;AAED,wBAAgB,kBAAkB,CAChC,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,aAAa,EAC5B,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAE7C,OAAO,EAAE,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,GAChE,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CA8J9B"}

package/types/orez.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=orez.test.d.ts.map

package/types/orez.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"orez.test.d.ts","sourceRoot":"","sources":["../src/orez.test.ts"],"names":[],"mappings":""}