@company-semantics/contracts 58.5.1 → 59.0.0

package/src/resource-keys.ts

@@ -25,184 +25,20 @@ export function resolveScope(context: {
   return { orgId: context.impersonatedOrgId ?? context.orgId };
 }
 
-/*
- * ---------------------------------------------------------------------------
- * fromQueryKey's routing tables, and the drift detector over them.
- * ---------------------------------------------------------------------------
- *
- * `toQueryKey` has always been safe: its switch is exhaustive and its `never`
- * guard makes a new union member a compile error. `fromQueryKey` was not. Its
- * five lookup tables are hand-maintained, and a member missing from all of them
- * fell through to a RUNTIME `throw` — which `matchesResourceKey` catches and
- * turns into "matches nothing", and which `useResource` turns into a query that
- * never fetches. Silent in both directions (ADR-CONTRACTS-119).
- *
- * Two mechanisms, and BOTH are needed:
- *
- *   `satisfies` on each table catches a WRONG entry — a typo, or a literal
- *   parked under the wrong scope. It cannot catch an entry that is simply
- *   absent, because an array is free to be a subset of its element type.
- *
- *   `_EveryResourceKeyIsRouted` below catches the ABSENT entry, which is the
- *   failure that actually shipped. It is the half that closes the hole.
- */
-
-/**
- * The identity segments a member carries — every field that is neither the type
- * tag nor a scope discriminator. `member` → `"memberId"`; `commentThreads` →
- * `"subjectType" | "subjectId"`; a scope-only key → `never`.
- */
-type IdentityFieldsOf<T extends ResourceKey["type"]> = Exclude<
-  keyof Extract<ResourceKey, { type: T }>,
-  "type" | "orgId" | "userId" | "scope"
->;
-
-/**
- * Type literals whose whole shape is the tag plus one scope discriminator —
- * i.e. the members that belong in a scope ARRAY rather than an identity MAP.
- * Distributes over the union (`K` is a naked type parameter).
- */
-type ScopeOnlyType<K = ResourceKey> = K extends {
-  type: infer T extends ResourceKey["type"];
-}
-  ? [IdentityFieldsOf<T>] extends [never]
-    ? T
-    : never
-  : never;
-
-type OrgScopedType = Extract<
-  ScopeOnlyType,
-  Extract<ResourceKey, { orgId: string }>["type"]
->;
-type UserScopedType = Extract<
-  ScopeOnlyType,
-  Extract<ResourceKey, { userId: string }>["type"]
->;
-type SystemScopedType = Extract<
-  ScopeOnlyType,
-  Extract<ResourceKey, { scope: "system" }>["type"]
->;
-
-/**
- * Identities with a single extra segment. The `satisfies` checks the FIELD NAME
- * against that member's own keys, so renaming `memberId` in the union — or
- * pointing a key at a field it does not have — fails to compile here.
- */
-const IDENTITY_FIELDS = {
-  member: "memberId",
-  team: "teamId",
-  department: "departmentId",
-  chat: "chatId",
-  companyMdDoc: "slug",
-  companyMdContextBank: "slug",
-  companyMdAccessRequests: "docId",
-  companyMdDocHistory: "docId",
-  orgUnit: "unitId",
-  orgUnitChildren: "unitId",
-  orgUnitAncestors: "unitId",
-  orgUnitMemberships: "unitId",
-  orgUnitPermissions: "unitId",
-  orgUnitOpenRoles: "unitId",
-  orgUnitMyAuthority: "unitId",
-} as const satisfies { [T in ResourceKey["type"]]?: IdentityFieldsOf<T> };
-
-/**
- * Identities with a COMPOSITE (multi-segment) identity. Checked before
- * {@link IDENTITY_FIELDS}, which hard-asserts a two-element `rest` and would
- * otherwise reject these.
- *
- * A map of its own rather than widening `IDENTITY_FIELDS` to `string | string[]`:
- * the single-segment case is every other key in the union, and making it pay for
- * this one would put a branch in the hot path for no reader's benefit.
- */
-const COMPOSITE_IDENTITY_FIELDS = {
-  commentThreads: ["subjectType", "subjectId"],
-  companyMdDocVersion: ["docId", "versionId"],
-} as const satisfies {
-  [T in ResourceKey["type"]]?: readonly IdentityFieldsOf<T>[];
-};
-
-const ORG_SCOPED_TYPES = [
-  "members",
-  "departments",
-  "chats",
-  "teams",
-  "integrations",
-  "invites",
-  "orgDirectory",
-  "auditEvents",
-  "timeline",
-  "workspace",
-  "workspaceDomains",
-  "authSettings",
-  "billing",
-  "aiUsage",
-  "deletionEligibility",
-  "transferOwnership",
-  "companyMdDocs",
-  "directGrants",
-  "orgTree",
-  "orgLevelConfig",
-  "peopleOrgChart",
-  "orgUnitOwners",
-  "actionItems",
-  "feed",
-  "orgSystemEvents",
-] as const satisfies readonly OrgScopedType[];
-
-const USER_SCOPED_TYPES = [
-  "dismissedBanners",
-  "userOrgs",
-  "sessions",
-  "userMd",
-  "viewer",
-] as const satisfies readonly UserScopedType[];
-
 /**
- * System-scoped types (ADR-CONTRACTS-052) — tenant-less super-admin resources.
- * Their query key is [type, 'system']; they carry no orgId or userId.
- * Intentionally NOT exported — internal to the parser like the other scope arrays.
- */
-const SYSTEM_SCOPED_TYPES = [
-  "internalAdminAiProviders",
-  "internalAdminPrompts",
-  "internalAdminAiRuntimeDefaults",
-  "factoryFloor",
-  "factorySnapshot",
-  "factoryKpis",
-] as const satisfies readonly SystemScopedType[];
-
-/** Every literal `fromQueryKey` can route, across all five tables. */
-type RoutedType =
-  | keyof typeof IDENTITY_FIELDS
-  | keyof typeof COMPOSITE_IDENTITY_FIELDS
-  | (typeof ORG_SCOPED_TYPES)[number]
-  | (typeof USER_SCOPED_TYPES)[number]
-  | (typeof SYSTEM_SCOPED_TYPES)[number];
-
-type Assert<T extends true> = T;
-
-/**
- * THE DRIFT DETECTOR. Register a union member and forget its routing table and
- * this fails to compile — instead of shipping a key that parses nowhere,
- * matches nothing, and disables the query that reads it.
- *
- * The false branch resolves to the UNROUTED LITERALS rather than to `false`, so
- * the diagnostic names the culprit:
- *   `Type '"directGrants"' does not satisfy the constraint 'true'`.
- *
- * EXPORTED, though nothing consumes it. This package ships `src`, so every
- * consumer typechecks this file under ITS OWN compiler options — and the
- * backend sets `noUnusedLocals`, which rejects an unexported type alias that
- * nothing references. Keeping it private broke `tsc` in a consumer while
- * passing here, so the export is what makes the assertion portable, not a
- * widening of the public vocabulary. Do not "tidy" it away.
+ * The routing tables `fromQueryKey` reads, and the drift detector over them,
+ * live in `resource-key-tables.ts`. `RoutingExhaustivenessWitness` is
+ * re-exported so its import path is unchanged — see the note on its definition
+ * for why it is exported at all.
  */
-export type RoutingExhaustivenessWitness = Assert<
-  [Exclude<ResourceKey["type"], RoutedType>] extends [never]
-    ? true
-    : Exclude<ResourceKey["type"], RoutedType>
->;
+export type { RoutingExhaustivenessWitness } from "./resource-key-tables";
+import {
+  IDENTITY_FIELDS,
+  COMPOSITE_IDENTITY_FIELDS,
+  ORG_SCOPED_TYPES,
+  USER_SCOPED_TYPES,
+  SYSTEM_SCOPED_TYPES,
+} from "./resource-key-tables";
 
 /**
  * Canonical ResourceKey → query key conversion.