@elevasis/sdk 1.11.0 → 1.12.0

package/reference/scaffold/operations/workflow-recipes.md

@@ -2,6 +2,9 @@
 title: Workflow Recipes
 description: Anatomy of a workflow, adapter usage, and trigger patterns -- runnable email-notification example replaces the trivial echo workflow. Resolves eval score 2/5 on workflow authoring.
 ---
+<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
+<!-- Regenerate: pnpm scaffold:sync -->
+
 
 # Workflow Recipes
 
@@ -32,7 +35,7 @@ config: {
 ### Contract
 
 ```typescript
-// foundations/types/index.ts -- shared with frontend
+// core/types/index.ts -- shared with frontend
 export const emailNotificationInputSchema = z.object({
   recipientEmail: z.string().email(),
   recipientName: z.string().min(1),
@@ -54,7 +57,7 @@ export type EmailNotificationOutput = z.infer<typeof emailNotificationOutputSche
 
 ```typescript
 // operations/src/email-notification/index.ts
-import { emailNotificationInputSchema, emailNotificationOutputSchema } from '@foundation/types'
+import { emailNotificationInputSchema, emailNotificationOutputSchema } from '@core/types'
 
 contract: {
   inputSchema: emailNotificationInputSchema,
@@ -64,16 +67,16 @@ contract: {
 
 **Rules:**
 
-- Define schemas in `foundations/types/index.ts` -- never inline Zod schemas in workflow files.
-- Both runtimes (frontend and platform) import from `@foundation/types`, keeping validation consistent.
-- `@foundation/types` resolves to `foundations/types/index.ts` via the tsconfig path alias.
+- Define schemas in `core/types/index.ts` -- never inline Zod schemas in workflow files.
+- Both runtimes (frontend and platform) import from `@core/types`, keeping validation consistent.
+- `@core/types` resolves to `core/types/index.ts` via the tsconfig path alias.
 
 **Entity-backed workflows:** for workflows that operate on a domain entity, reference the entity contract rather than redeclaring it.
 
 ```typescript
-// foundations/types/index.ts
+// core/types/index.ts
 import { BaseDealSchema } from '@elevasis/core/entities'
-import { DealSchema } from '@foundation/types/entities' // project-local extended version
+import { DealSchema } from '@core/types/entities' // project-local extended version
 
 export const closeDealInputSchema = z.object({
   deal: DealSchema,
@@ -83,7 +86,7 @@ export const closeDealInputSchema = z.object({
 export type CloseDealInput = z.infer<typeof closeDealInputSchema>
 ```
 
-`DealSchema` is defined in `foundations/types/entities.ts` by extending `BaseDealSchema` with project-specific metadata. See [../recipes/extend-a-base-entity.md](../recipes/extend-a-base-entity.md) for the pattern.
+`DealSchema` is defined in `core/types/entities.ts` by extending `BaseDealSchema` with project-specific metadata. See [../recipes/extend-a-base-entity.md](../recipes/extend-a-base-entity.md) for the pattern.
 
 ### Steps
 
@@ -291,7 +294,7 @@ Use this pattern in React components and hooks. `apiRequest` automatically attac
 // ui/src/features/notifications/hooks/useSendEmailNotification.ts
 import { useMutation } from '@tanstack/react-query'
 import { useApiClient } from '@/lib/hooks/useApiClient'
-import type { EmailNotificationInput, EmailNotificationOutput } from '@foundation/types'
+import type { EmailNotificationInput, EmailNotificationOutput } from '@core/types'
 
 export function useSendEmailNotification() {
   const { apiRequest } = useApiClient()
@@ -457,7 +460,7 @@ Use `runWorkflow` for project-owned workflows. This tests the workflow contract,
 import { describe, expect, it } from 'vitest'
 import { runWorkflow, mockNotifications } from '@elevasis/sdk/test-utils'
 import { emailNotification } from './index'
-import type { EmailNotificationOutput } from '@foundation/types'
+import type { EmailNotificationOutput } from '@core/types'
 
 describe('emailNotification workflow', () => {
   it('runs the notify step with a mocked notification adapter', async () => {

package/reference/scaffold/recipes/add-a-feature.md

@@ -2,6 +2,9 @@
 title: Add a Feature
 description: Add a shell feature using the flat Organization Model feature list, manifest registration, routes, and guards.
 ---
+<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
+<!-- Regenerate: pnpm scaffold:sync -->
+
 
 # Add a Feature
 

package/reference/scaffold/recipes/add-a-resource.md

@@ -2,6 +2,9 @@
 title: Add a Resource
 description: Add a workflow or agent with resource metadata, graph links, and deployment verification.
 ---
+<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
+<!-- Regenerate: pnpm scaffold:sync -->
+
 
 # Add a Resource
 

package/reference/scaffold/recipes/customize-organization-model.md

@@ -2,6 +2,9 @@
 title: Customize organization-model.ts
 description: Annotated walkthrough for customizing the flat Organization Model in template-derived projects.
 ---
+<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
+<!-- Regenerate: pnpm scaffold:sync -->
+
 
 # Customize organization-model.ts
 

package/reference/scaffold/recipes/extend-a-base-entity.md

@@ -2,12 +2,15 @@
 title: Extend a Base Entity
 description: Add project-specific metadata to the canonical entity shapes (Project, Deal, Company, etc.) from @elevasis/core/entities using the TMeta extension slot.
 ---
+<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
+<!-- Regenerate: pnpm scaffold:sync -->
+
 
 # Extend a Base Entity
 
 Workflows and UI features often operate on domain entities such as projects, deals, companies, or contacts. Rather than each project declaring its own shape from scratch, `@elevasis/core/entities` provides typed base interfaces generic over a `<TMeta>` slot. External projects extend these to add project-specific fields while keeping the canonical shape stable and interoperable with platform tooling.
 
-The canonical demo lives in `foundations/types/entities.ts` of any scaffold project.
+The canonical demo lives in `core/types/entities.ts` of any scaffold project.
 
 ---
 
@@ -30,7 +33,7 @@ All imports come from `@elevasis/core/entities`.
 
 ## Recipe 1 -- Extend a base entity with custom metadata
 
-Place this in `foundations/types/entities.ts`. This is the primary pattern -- the scaffold template ships this exact example.
+Place this in `core/types/entities.ts`. This is the primary pattern -- the scaffold template ships this exact example.
 
 ```ts
 import { z } from 'zod'
@@ -56,7 +59,7 @@ Key points:
 - `BaseProjectSchema.extend({ metadata: ... })` merges your metadata Zod schema into the validated shape. Zod handles the rest.
 - `BaseProject<ProjectMeta>` infers the TypeScript type with your metadata typed correctly.
 - Only the `metadata` field is extended -- all other base fields (`id`, `organizationId`, `name`, `status`, `createdAt`, `updatedAt`, etc.) are inherited unchanged.
-- This file is the single source of truth for entity shapes across `foundations/`, `operations/`, and `ui/`.
+- This file is the single source of truth for entity shapes across `core/`, `operations/`, and `ui/`.
 
 ---
 
@@ -84,7 +87,7 @@ Workflows that operate on projects or deals should reference the project-local e
 ```ts
 import { z } from 'zod'
 import type { WorkflowDefinition } from '@elevasis/sdk'
-import { ProjectSchema } from '@foundation/types/entities'
+import { ProjectSchema } from '@core/types/entities'
 
 export const myWorkflow: WorkflowDefinition = {
   id: 'my-workflow',
@@ -96,16 +99,16 @@ export const myWorkflow: WorkflowDefinition = {
 }
 ```
 
-The `@foundation/*` alias maps to the `foundations/` workspace package. This keeps entity contracts in one place and ensures the workflow input type matches whatever the UI passes as the execution payload.
+The `@core/*` alias maps to the `core/` workspace package. This keeps entity contracts in one place and ensures the workflow input type matches whatever the UI passes as the execution payload.
 
 ---
 
 ## Recipe 4 -- Reference entity types from the UI
 
-UI components accept entity types directly in props. The entity type flows from the `foundations` package through the component into the workflow execution payload:
+UI components accept entity types directly in props. The entity type flows from the `core` package through the component into the workflow execution payload:
 
 ```tsx
-import type { Project } from '@foundation/types/entities'
+import type { Project } from '@core/types/entities'
 
 interface ProjectCardProps {
   project: Project
@@ -127,7 +130,7 @@ When wiring this to a `RunResourceButton`, the entity instance becomes the workf
 
 ## Verification
 
-- **Type-check foundations:** `pnpm -C foundations test` runs the Vitest suite. The template ships `foundations/types/entities.test.ts` as a working smoke-check -- it `safeParse`s a valid project (expects success) and an invalid one (expects failure). Run this after any schema change.
+- **Test core contracts:** `pnpm -C core test` runs the Vitest suite. The template ships `core/types/entities.test.ts` as a working smoke-check -- it `safeParse`s a valid project (expects success) and an invalid one (expects failure). Run this after any schema change.
 - **Round-trip safeParse:** Call `ProjectSchema.safeParse(candidateObject)` in a test or REPL to confirm the Zod shape accepts the data your workflows and UI will produce.
 - **Cross-package type check:** `pnpm -C ui build` will surface any TypeScript errors if a UI component or hook passes a mismatched entity type to a workflow input.
 

package/reference/scaffold/recipes/gate-by-feature-or-admin.md

@@ -2,6 +2,9 @@
 title: Gate by Feature or Admin
 description: Decision table and recipes for gating routes, sidebar entries, and UI elements by Organization Model feature ID or admin role.
 ---
+<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
+<!-- Regenerate: pnpm scaffold:sync -->
+
 
 # Gate by Feature or Admin
 

package/reference/scaffold/recipes/index.md

@@ -2,6 +2,9 @@
 title: Pathway Recipes
 description: Terse end-to-end walkthroughs for the three most common authoring tasks -- adding a feature, adding a resource, and gating access.
 ---
+<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
+<!-- Regenerate: pnpm scaffold:sync -->
+
 
 # Pathway Recipes