digital-products 2.0.1

package/src/index.ts

@@ -0,0 +1,55 @@
+/**
+ * digital-products - Primitives for defining and building digital products
+ *
+ * This package provides primitives for defining digital products:
+ * - Apps: Interactive user-facing applications
+ * - APIs: Programmatic interfaces
+ * - Content: Text/media content with schemas
+ * - Data: Structured data definitions
+ * - Datasets: Curated data collections
+ * - Sites: Websites and documentation
+ * - MCPs: Model Context Protocol servers
+ * - SDKs: Software development kits
+ *
+ * @packageDocumentation
+ */
+
+// Export all types
+export * from './types.js'
+
+// Export entity definitions (Nouns) as namespace to avoid conflicts with types
+export * as Nouns from './entities/index.js'
+
+// Also export individual entity collections for convenience
+export {
+  AllDigitalProductEntities,
+  DigitalProductEntityCategories,
+  Entities,
+  // Category exports
+  ProductEntities,
+  ProductCategories,
+  InterfaceEntities,
+  InterfaceCategories,
+  ContentEntities,
+  ContentCategories,
+  WebEntities,
+  WebCategories,
+  AIEntities,
+  AICategories,
+  LifecycleEntities,
+  LifecycleCategories,
+} from './entities/index.js'
+
+// Export registry
+export { registry } from './registry.js'
+
+// Export product constructors
+export { Product, createProduct, registerProduct } from './product.js'
+export { App, Route, State, Auth } from './app.js'
+export { API, Endpoint, APIAuth, RateLimit } from './api.js'
+export { Content, Workflow } from './content.js'
+export { Data, Index, Relationship, Validate } from './data.js'
+export { Dataset } from './dataset.js'
+export { Site, Nav, SEO, Analytics } from './site.js'
+export { MCP, Tool, Resource, Prompt, MCPConfig } from './mcp.js'
+export { SDK, Export, Example } from './sdk.js'

package/src/mcp.ts

@@ -0,0 +1,163 @@
+/**
+ * MCP() - Define a Model Context Protocol server
+ */
+
+import type { MCPDefinition, MCPTool, MCPResource, MCPPrompt, MCPConfig } from './types.js'
+import type { SimpleSchema } from 'ai-functions'
+import { registerProduct } from './product.js'
+
+/**
+ * Create an MCP server definition
+ *
+ * @example
+ * ```ts
+ * const mcpServer = MCP({
+ *   id: 'my-mcp',
+ *   name: 'My MCP Server',
+ *   description: 'Custom MCP server for AI tools',
+ *   version: '1.0.0',
+ *   transport: 'stdio',
+ *   tools: [
+ *     Tool('searchFiles', 'Search for files in the project', {
+ *       query: 'Search query',
+ *       path: 'Directory to search in',
+ *     }),
+ *     Tool('readFile', 'Read file contents', {
+ *       path: 'File path to read',
+ *     }),
+ *   ],
+ *   resources: [
+ *     Resource('file://', 'Project Files', 'Access to project files'),
+ *   ],
+ *   prompts: [
+ *     Prompt('codeReview', 'Review code for best practices',
+ *       'Review the following code:\n\n{{code}}'),
+ *   ],
+ * })
+ * ```
+ */
+export function MCP(config: Omit<MCPDefinition, 'type'>): MCPDefinition {
+  const mcp: MCPDefinition = {
+    type: 'mcp',
+    id: config.id,
+    name: config.name,
+    description: config.description,
+    version: config.version,
+    transport: config.transport,
+    tools: config.tools,
+    resources: config.resources,
+    prompts: config.prompts,
+    config: config.config,
+    metadata: config.metadata,
+    tags: config.tags,
+    status: config.status || 'active',
+  }
+
+  return registerProduct(mcp)
+}
+
+/**
+ * Helper to create an MCP tool
+ *
+ * @example
+ * ```ts
+ * const tool = Tool(
+ *   'searchCode',
+ *   'Search code using regex',
+ *   {
+ *     pattern: 'Regex pattern to search for',
+ *     path: 'Directory to search in',
+ *   },
+ *   async (input) => {
+ *     // Tool implementation
+ *     return { matches: [] }
+ *   }
+ * )
+ * ```
+ */
+export function Tool(
+  name: string,
+  description: string,
+  inputSchema: SimpleSchema,
+  handler?: (input: unknown) => Promise<unknown>
+): MCPTool {
+  return {
+    name,
+    description,
+    inputSchema,
+    handler,
+  }
+}
+
+/**
+ * Helper to create an MCP resource
+ *
+ * @example
+ * ```ts
+ * const resource = Resource(
+ *   'file://project',
+ *   'Project Files',
+ *   'Access to all project files',
+ *   'application/json'
+ * )
+ * ```
+ */
+export function Resource(
+  uri: string,
+  name: string,
+  description: string,
+  mimeType?: string
+): MCPResource {
+  return {
+    uri,
+    name,
+    description,
+    mimeType,
+  }
+}
+
+/**
+ * Helper to create an MCP prompt
+ *
+ * @example
+ * ```ts
+ * const prompt = Prompt(
+ *   'summarize',
+ *   'Summarize text',
+ *   'Summarize the following:\n\n{{text}}',
+ *   { text: 'Text to summarize' }
+ * )
+ * ```
+ */
+export function Prompt(
+  name: string,
+  description: string,
+  template: string,
+  args?: SimpleSchema
+): MCPPrompt {
+  return {
+    name,
+    description,
+    template,
+    arguments: args,
+  }
+}
+
+/**
+ * Helper to configure MCP server
+ *
+ * @example
+ * ```ts
+ * const config = MCPConfig({
+ *   port: 3000,
+ *   host: 'localhost',
+ *   auth: {
+ *     type: 'bearer',
+ *     token: process.env.MCP_TOKEN,
+ *   },
+ * })
+ * ```
+ */
+export function MCPConfig(config: MCPConfig): MCPConfig {
+  return config
+}

package/src/product.ts

@@ -0,0 +1,59 @@
+/**
+ * Generic Product() constructor
+ */
+
+import type { DigitalProduct, ProductDefinition } from './types.js'
+import { registry } from './registry.js'
+
+/**
+ * Create a generic digital product definition
+ *
+ * @example
+ * ```ts
+ * const product = Product({
+ *   id: 'my-product',
+ *   name: 'My Product',
+ *   description: 'A digital product',
+ *   version: '1.0.0',
+ * })
+ * ```
+ */
+export function Product(config: Omit<DigitalProduct, 'type'>): DigitalProduct {
+  const product: DigitalProduct = {
+    id: config.id,
+    name: config.name,
+    description: config.description,
+    version: config.version,
+    metadata: config.metadata,
+    tags: config.tags,
+    status: config.status || 'active',
+  }
+
+  return product
+}
+
+/**
+ * Create and register a product in one step
+ *
+ * @example
+ * ```ts
+ * const product = createProduct({
+ *   id: 'my-product',
+ *   name: 'My Product',
+ *   description: 'A digital product',
+ *   version: '1.0.0',
+ * })
+ * ```
+ */
+export function createProduct(config: Omit<DigitalProduct, 'type'>): DigitalProduct {
+  const product = Product(config)
+  return product
+}
+
+/**
+ * Create and register any product definition
+ */
+export function registerProduct<T extends ProductDefinition>(product: T): T {
+  registry.register(product)
+  return product
+}

package/src/registry.ts

@@ -0,0 +1,41 @@
+/**
+ * Product registry implementation
+ */
+
+import type { ProductDefinition, ProductRegistry } from './types.js'
+
+/**
+ * In-memory product registry
+ */
+class InMemoryProductRegistry implements ProductRegistry {
+  private products = new Map<string, ProductDefinition>()
+
+  register(product: ProductDefinition): void {
+    this.products.set(product.id, product)
+  }
+
+  get(id: string): ProductDefinition | undefined {
+    return this.products.get(id)
+  }
+
+  list(): ProductDefinition[] {
+    return Array.from(this.products.values())
+  }
+
+  listByType<T extends ProductDefinition['type']>(type: T): Extract<ProductDefinition, { type: T }>[] {
+    return this.list().filter((p) => p.type === type) as Extract<ProductDefinition, { type: T }>[]
+  }
+
+  remove(id: string): boolean {
+    return this.products.delete(id)
+  }
+
+  clear(): void {
+    this.products.clear()
+  }
+}
+
+/**
+ * Global product registry instance
+ */
+export const registry: ProductRegistry = new InMemoryProductRegistry()

package/src/sdk.ts

@@ -0,0 +1,148 @@
+/**
+ * SDK() - Define a software development kit
+ */
+
+import type { SDKDefinition, SDKExport, SDKExample } from './types.js'
+import type { SimpleSchema } from 'ai-functions'
+import { registerProduct } from './product.js'
+
+/**
+ * Create an SDK definition
+ *
+ * @example
+ * ```ts
+ * const mySDK = SDK({
+ *   id: 'my-sdk',
+ *   name: 'My SDK',
+ *   description: 'JavaScript SDK for My API',
+ *   version: '1.0.0',
+ *   language: 'typescript',
+ *   api: 'my-api',
+ *   exports: [
+ *     Export('function', 'createClient', 'Create an API client', {
+ *       parameters: {
+ *         apiKey: 'API key for authentication',
+ *         baseUrl: 'Optional base URL',
+ *       },
+ *       returns: 'API client instance',
+ *     }),
+ *     Export('class', 'APIClient', 'Main API client', {
+ *       methods: [
+ *         Export('function', 'get', 'GET request', {
+ *           parameters: { path: 'Request path' },
+ *           returns: 'Response data',
+ *         }),
+ *         Export('function', 'post', 'POST request', {
+ *           parameters: { path: 'Request path', data: 'Request body' },
+ *           returns: 'Response data',
+ *         }),
+ *       ],
+ *     }),
+ *   ],
+ *   install: 'npm install my-sdk',
+ *   examples: [
+ *     Example(
+ *       'Basic Usage',
+ *       'Create a client and make a request',
+ *       `import { createClient } from 'my-sdk'
+ *
+ * const client = createClient({ apiKey: 'YOUR_API_KEY' })
+ * const users = await client.get('/users')
+ * console.log(users)`
+ *     ),
+ *   ],
+ * })
+ * ```
+ */
+export function SDK(config: Omit<SDKDefinition, 'type'>): SDKDefinition {
+  const sdk: SDKDefinition = {
+    type: 'sdk',
+    id: config.id,
+    name: config.name,
+    description: config.description,
+    version: config.version,
+    language: config.language,
+    api: config.api,
+    exports: config.exports,
+    install: config.install,
+    docs: config.docs,
+    examples: config.examples,
+    metadata: config.metadata,
+    tags: config.tags,
+    status: config.status || 'active',
+  }
+
+  return registerProduct(sdk)
+}
+
+/**
+ * Helper to create an SDK export
+ *
+ * @example
+ * ```ts
+ * const fn = Export('function', 'calculateTotal', 'Calculate order total', {
+ *   parameters: {
+ *     items: ['Array of order items'],
+ *     taxRate: 'Tax rate (number)',
+ *   },
+ *   returns: 'Total amount (number)',
+ * })
+ *
+ * const cls = Export('class', 'OrderManager', 'Manage orders', {
+ *   methods: [
+ *     Export('function', 'create', 'Create order', {
+ *       parameters: { order: 'Order data' },
+ *       returns: 'Created order',
+ *     }),
+ *   ],
+ * })
+ * ```
+ */
+export function Export(
+  type: SDKExport['type'],
+  name: string,
+  description: string,
+  options?: {
+    parameters?: SimpleSchema
+    returns?: SimpleSchema
+    methods?: SDKExport[]
+  }
+): SDKExport {
+  return {
+    type,
+    name,
+    description,
+    parameters: options?.parameters,
+    returns: options?.returns,
+    methods: options?.methods,
+  }
+}
+
+/**
+ * Helper to create an SDK example
+ *
+ * @example
+ * ```ts
+ * const example = Example(
+ *   'Authentication',
+ *   'How to authenticate with the API',
+ *   `const client = createClient({
+ *     apiKey: process.env.API_KEY,
+ *   })`,
+ *   '{ authenticated: true }'
+ * )
+ * ```
+ */
+export function Example(
+  title: string,
+  description: string,
+  code: string,
+  output?: string
+): SDKExample {
+  return {
+    title,
+    description,
+    code,
+    output,
+  }
+}

package/src/site.ts

@@ -0,0 +1,127 @@
+/**
+ * Site() - Define a website
+ */
+
+import type { SiteDefinition, NavigationDefinition, SEOConfig, AnalyticsConfig } from './types.js'
+import { registerProduct } from './product.js'
+
+/**
+ * Create a site definition
+ *
+ * @example
+ * ```ts
+ * const docsSite = Site({
+ *   id: 'docs',
+ *   name: 'Documentation Site',
+ *   description: 'Product documentation',
+ *   version: '1.0.0',
+ *   generator: 'fumadocs',
+ *   structure: {
+ *     home: '/docs/index.mdx',
+ *     docs: [
+ *       '/docs/getting-started.mdx',
+ *       '/docs/api-reference.mdx',
+ *     ],
+ *   },
+ *   navigation: [
+ *     Nav('Home', '/'),
+ *     Nav('Docs', '/docs', {
+ *       children: [
+ *         Nav('Getting Started', '/docs/getting-started'),
+ *         Nav('API Reference', '/docs/api-reference'),
+ *       ],
+ *     }),
+ *   ],
+ *   seo: {
+ *     titleTemplate: '%s | My Product',
+ *     description: 'Official documentation for My Product',
+ *     keywords: ['docs', 'api', 'reference'],
+ *   },
+ *   analytics: {
+ *     provider: 'plausible',
+ *     id: 'docs.example.com',
+ *   },
+ * })
+ * ```
+ */
+export function Site(config: Omit<SiteDefinition, 'type'>): SiteDefinition {
+  const site: SiteDefinition = {
+    type: 'site',
+    id: config.id,
+    name: config.name,
+    description: config.description,
+    version: config.version,
+    generator: config.generator || 'next',
+    structure: config.structure,
+    navigation: config.navigation,
+    seo: config.seo,
+    analytics: config.analytics,
+    deployment: config.deployment,
+    metadata: config.metadata,
+    tags: config.tags,
+    status: config.status || 'active',
+  }
+
+  return registerProduct(site)
+}
+
+/**
+ * Helper to create a navigation item
+ *
+ * @example
+ * ```ts
+ * const nav = Nav('Documentation', '/docs', {
+ *   icon: 'book',
+ *   children: [
+ *     Nav('Getting Started', '/docs/getting-started'),
+ *     Nav('API Reference', '/docs/api'),
+ *   ],
+ * })
+ * ```
+ */
+export function Nav(
+  label: string,
+  href: string,
+  options?: Omit<NavigationDefinition, 'label' | 'href'>
+): NavigationDefinition {
+  return {
+    label,
+    href,
+    ...options,
+  }
+}
+
+/**
+ * Helper to configure SEO
+ *
+ * @example
+ * ```ts
+ * const seo = SEO({
+ *   titleTemplate: '%s | My Site',
+ *   description: 'My awesome site',
+ *   keywords: ['keyword1', 'keyword2'],
+ *   ogImage: '/og-image.png',
+ *   twitterCard: 'summary_large_image',
+ * })
+ * ```
+ */
+export function SEO(config: SEOConfig): SEOConfig {
+  return config
+}
+
+/**
+ * Helper to configure analytics
+ *
+ * @example
+ * ```ts
+ * const analytics = Analytics('google', 'G-XXXXXXXXXX')
+ * const analytics = Analytics('plausible', 'example.com')
+ * ```
+ */
+export function Analytics(
+  provider: AnalyticsConfig['provider'],
+  id: string,
+  config?: Record<string, unknown>
+): AnalyticsConfig {
+  return { provider, id, config }
+}