@yahoo/uds-create-config 4.10.1 → 4.10.3

package/dist/configs/documentation.d.ts

@@ -0,0 +1,256 @@
+import { ComputedInput } from "../framework/registry.js";
+import { DerivedEntityClass } from "../framework/defineDerivedEntity.js";
+import { EntityClass } from "../framework/defineEntity.js";
+import { ConfigClass } from "../framework/defineConfig.js";
+import { Config } from "../framework/Config.js";
+import * as _$zod from "zod";
+import * as _$zod_v4_core0 from "zod/v4/core";
+
+//#region src/configs/documentation.d.ts
+declare const DocumentationLibrary: ConfigClass<{
+  documents: EntityClass<_$zod.ZodObject<{
+    title: _$zod.ZodString;
+    summary: _$zod.ZodOptional<_$zod.ZodString>;
+    markdown: _$zod.ZodString;
+    category: _$zod.ZodString;
+    public: _$zod.ZodDefault<_$zod.ZodBoolean>;
+    products: _$zod.ZodArray<_$zod.ZodEnum<{
+      create: "create";
+      uds: "uds";
+    }>>;
+    platform: _$zod.ZodOptional<_$zod.ZodEnum<{
+      mobile: "mobile";
+      web: "web";
+    }>>;
+  }, _$zod_v4_core0.$strict>, _$zod.ZodObject<Record<never, never>, _$zod_v4_core0.$strip>, "documentation", {
+    readonly search: {
+      readonly input: _$zod.ZodObject<{
+        query: _$zod.ZodDefault<_$zod.ZodString>;
+      }, _$zod_v4_core0.$strip>;
+      readonly readOnly: true;
+      readonly label: "Search";
+      readonly description: "Find articles by text in their path, title, summary, or Markdown. An empty query browses all articles. Returns metadata without article bodies; use get to read an article.";
+      readonly scope: "collection";
+      readonly example: () => {
+        query: string;
+      };
+      readonly handler: (input: Record<string, unknown>, config: Config) => {
+        path: string;
+        title: string;
+        summary: string | undefined;
+        category: string;
+        products: ("create" | "uds")[];
+        platform: "mobile" | "web" | undefined;
+      }[];
+    };
+  }, Record<never, never>, false, Record<never, never>, Record<never, never>>;
+}, {
+  operations: DerivedEntityClass<_$zod.ZodObject<{
+    kind: _$zod.ZodString;
+    verb: _$zod.ZodString;
+    readOnly: _$zod.ZodBoolean;
+    label: _$zod.ZodString;
+    description: _$zod.ZodString;
+    scope: _$zod.ZodString;
+    creates: _$zod.ZodBoolean;
+    approval: _$zod.ZodOptional<_$zod.ZodEnum<{
+      destructive: "destructive";
+      "reference-change": "reference-change";
+    }>>;
+  }, _$zod_v4_core0.$strip>, {
+    inputSchema: ({
+      member: op,
+      config
+    }: Omit<ComputedInput, "member"> & {
+      member: {
+        kind: string;
+        verb: string;
+        readOnly: boolean;
+        label: string;
+        description: string;
+        scope: string;
+        creates: boolean;
+        approval?: "destructive" | "reference-change" | undefined;
+      };
+    }) => _$zod.ZodTypeAny<unknown, unknown, _$zod_v4_core0.$ZodTypeInternals<unknown, unknown>> | undefined;
+    execute: ({
+      member: op,
+      config: declaring
+    }: Omit<ComputedInput, "member"> & {
+      member: {
+        kind: string;
+        verb: string;
+        readOnly: boolean;
+        label: string;
+        description: string;
+        scope: string;
+        creates: boolean;
+        approval?: "destructive" | "reference-change" | undefined;
+      };
+    }) => ((input: Record<string, unknown>, config: Config) => unknown) | undefined;
+    field: ({
+      member: op
+    }: Omit<ComputedInput, "member"> & {
+      member: {
+        kind: string;
+        verb: string;
+        readOnly: boolean;
+        label: string;
+        description: string;
+        scope: string;
+        creates: boolean;
+        approval?: "destructive" | "reference-change" | undefined;
+      };
+    }) => string | undefined;
+    title: ({
+      member: op,
+      config
+    }: Omit<ComputedInput, "member"> & {
+      member: {
+        kind: string;
+        verb: string;
+        readOnly: boolean;
+        label: string;
+        description: string;
+        scope: string;
+        creates: boolean;
+        approval?: "destructive" | "reference-change" | undefined;
+      };
+    }) => ((entity: string) => string) | undefined;
+    example: ({
+      member: op,
+      config
+    }: Omit<ComputedInput, "member"> & {
+      member: {
+        kind: string;
+        verb: string;
+        readOnly: boolean;
+        label: string;
+        description: string;
+        scope: string;
+        creates: boolean;
+        approval?: "destructive" | "reference-change" | undefined;
+      };
+    }) => Record<string, unknown> | undefined;
+  }>;
+  tools: DerivedEntityClass<_$zod.ZodObject<{
+    operation: DerivedEntityClass<_$zod.ZodObject<{
+      kind: _$zod.ZodString;
+      verb: _$zod.ZodString;
+      readOnly: _$zod.ZodBoolean;
+      label: _$zod.ZodString;
+      description: _$zod.ZodString;
+      scope: _$zod.ZodString;
+      creates: _$zod.ZodBoolean;
+      approval: _$zod.ZodOptional<_$zod.ZodEnum<{
+        destructive: "destructive";
+        "reference-change": "reference-change";
+      }>>;
+    }, _$zod_v4_core0.$strip>, {
+      inputSchema: ({
+        member: op,
+        config
+      }: Omit<ComputedInput, "member"> & {
+        member: {
+          kind: string;
+          verb: string;
+          readOnly: boolean;
+          label: string;
+          description: string;
+          scope: string;
+          creates: boolean;
+          approval?: "destructive" | "reference-change" | undefined;
+        };
+      }) => _$zod.ZodTypeAny<unknown, unknown, _$zod_v4_core0.$ZodTypeInternals<unknown, unknown>> | undefined;
+      execute: ({
+        member: op,
+        config: declaring
+      }: Omit<ComputedInput, "member"> & {
+        member: {
+          kind: string;
+          verb: string;
+          readOnly: boolean;
+          label: string;
+          description: string;
+          scope: string;
+          creates: boolean;
+          approval?: "destructive" | "reference-change" | undefined;
+        };
+      }) => ((input: Record<string, unknown>, config: Config) => unknown) | undefined;
+      field: ({
+        member: op
+      }: Omit<ComputedInput, "member"> & {
+        member: {
+          kind: string;
+          verb: string;
+          readOnly: boolean;
+          label: string;
+          description: string;
+          scope: string;
+          creates: boolean;
+          approval?: "destructive" | "reference-change" | undefined;
+        };
+      }) => string | undefined;
+      title: ({
+        member: op,
+        config
+      }: Omit<ComputedInput, "member"> & {
+        member: {
+          kind: string;
+          verb: string;
+          readOnly: boolean;
+          label: string;
+          description: string;
+          scope: string;
+          creates: boolean;
+          approval?: "destructive" | "reference-change" | undefined;
+        };
+      }) => ((entity: string) => string) | undefined;
+      example: ({
+        member: op,
+        config
+      }: Omit<ComputedInput, "member"> & {
+        member: {
+          kind: string;
+          verb: string;
+          readOnly: boolean;
+          label: string;
+          description: string;
+          scope: string;
+          creates: boolean;
+          approval?: "destructive" | "reference-change" | undefined;
+        };
+      }) => Record<string, unknown> | undefined;
+    }>;
+    name: _$zod.ZodString;
+    description: _$zod.ZodString;
+    enabled: _$zod.ZodDefault<_$zod.ZodBoolean>;
+  }, _$zod_v4_core0.$strip>, {
+    kind: (input: ComputedInput) => string | undefined;
+    verb: (input: ComputedInput) => string | undefined;
+    readOnly: ({
+      member,
+      config
+    }: Omit<ComputedInput, "member"> & {
+      member: {
+        operation: {
+          __ref: string;
+        };
+        name: string;
+        description: string;
+        enabled: boolean;
+      };
+    }) => boolean;
+    inputSchema: (input: ComputedInput) => _$zod.ZodTypeAny<unknown, unknown, _$zod_v4_core0.$ZodTypeInternals<unknown, unknown>> | undefined;
+    execute: (input: ComputedInput) => ((input: Record<string, unknown>, config: Config) => unknown) | undefined;
+    action: (input: ComputedInput) => string | undefined;
+    field: (input: ComputedInput) => string | undefined;
+    scope: (input: ComputedInput) => string | undefined;
+    approval: (input: ComputedInput) => "destructive" | "reference-change" | undefined;
+    label: (input: ComputedInput) => string | undefined;
+    shortLabel: (input: ComputedInput) => string | undefined;
+    example: (input: ComputedInput) => Record<string, unknown> | undefined;
+  }>;
+}, Record<never, never>>;
+//#endregion
+export { DocumentationLibrary };

package/dist/configs/documentation.js

@@ -0,0 +1,16 @@
+import { Operation } from "../entities/system/Operation.js";
+import { Tool } from "../entities/system/Tool.js";
+import { defineConfig } from "../framework/defineConfig.js";
+import { Documentation } from "../entities/documentation/Documentation.js";
+//#region src/configs/documentation.ts
+const DocumentationLibrary = defineConfig({
+	name: "documentation-library",
+	description: "Knowledge Base articles about UDS and Create, independently of users’ design systems.",
+	entities: { documents: Documentation },
+	derivedEntities: {
+		operations: Operation,
+		tools: Tool
+	}
+});
+//#endregion
+export { DocumentationLibrary };