@acorex/platform 0.0.0-ACOREX

package/types/acorex-platform-native.d.ts

@@ -0,0 +1,28 @@
+import * as i0 from '@angular/core';
+
+declare class AXPNativeModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPNativeModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXPNativeModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXPNativeModule>;
+}
+
+declare class AXPNativeService {
+    private isDark;
+    constructor();
+    setDarkMode(isDarkMode: boolean): void;
+    checkNetworkStatus(): void;
+    getCurrentLocation(): void;
+    setPreferredLanguage(language: string): void;
+    openExternalLink(url: string): void;
+    authenticateBiometric(): void;
+    selectImageFromGallery(): void;
+    selectImageFromCamera(): void;
+    selectVideoFromGallery(): void;
+    selectVideoFromCamera(): void;
+    selectFile(): void;
+    sendMessageToFlutter(message: string): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPNativeService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPNativeService>;
+}
+
+export { AXPNativeModule, AXPNativeService };

package/types/acorex-platform-runtime-catalog-command-definition.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Shared build-time metadata shapes for command and query catalog definitions.
+ * Lives under `shared/` so secondary ng-packagr entries under `commands/` or `queries/` share a common `src/lib` compilation root.
+ */
+/** Command metadata validation: rule key + optional rule options only. */
+interface AXPCommandValidationRuleValue {
+    rule: string;
+    options?: Record<string, unknown>;
+}
+/**
+ * Widget/interface reference for a schema property (name + optional widget options).
+ */
+interface AXPCommandInterfaceDefinitionValue {
+    name: string;
+    options?: Record<string, unknown>;
+}
+/**
+ * One input/output property description (same structural role as AXPPropertyDefinition).
+ */
+interface AXPCommandSchemaPropertyDefinition {
+    name: string;
+    title: string;
+    description?: string;
+    icon?: string;
+    defaultValue?: unknown;
+    disabled?: boolean;
+    interface: AXPCommandInterfaceDefinitionValue;
+    validations?: AXPCommandValidationRuleValue[];
+}
+/** Structured usage hints for planners and assistants (prefer over duplicating rules only in `description`). */
+interface AXPCommandAiUsageMetadata {
+    whenToUse?: string[];
+    avoidWhen?: string[];
+    /** Registry keys or tool names that commonly follow this command/query. */
+    followUpTools?: string[];
+}
+/** Declarative contracts: what the tool provides, who depends on it, and guarantees (not workflow `outcomes`). */
+interface AXPCommandAiContractsMetadata {
+    provides?: string[];
+    requiredBy?: string[];
+    guarantees?: string[];
+}
+type AXPCommandAiSafetyKind = 'read-only' | 'mutating';
+interface AXPCommandAiSafetyMetadata {
+    kind?: AXPCommandAiSafetyKind;
+    sideEffects?: boolean;
+    requiresConfirmation?: boolean;
+}
+type AXPCommandAiPerformanceCost = 'low' | 'medium' | 'high';
+interface AXPCommandAiPerformanceMetadata {
+    cost?: AXPCommandAiPerformanceCost;
+    cacheable?: boolean;
+}
+interface AXPCommandAiNextStepMetadata {
+    when: string;
+    action: string;
+}
+/**
+ * How to interpret a successful payload for agents (documentation only; not command workflow outcomes).
+ */
+interface AXPCommandAiResultSemanticsMetadata {
+    noMatch?: string;
+    exactMatch?: string;
+    multipleMatches?: string;
+    failed?: string;
+    /** Full catalog listing (e.g. no entity filter). */
+    catalog?: string;
+}
+interface AXPCommandAiMetadata {
+    shortDescription?: string;
+    tags?: string[];
+    usage?: AXPCommandAiUsageMetadata;
+    contracts?: AXPCommandAiContractsMetadata;
+    safety?: AXPCommandAiSafetyMetadata;
+    performance?: AXPCommandAiPerformanceMetadata;
+    nextSteps?: AXPCommandAiNextStepMetadata[];
+    resultSemantics?: AXPCommandAiResultSemanticsMetadata;
+    /**
+     * Default input fragment merged for AI/tool invocations (catalog & tooling).
+     * Runtime merge for a given command is applied in the AI module (not the generic command executor).
+     */
+    toolInputDefaults?: Record<string, unknown>;
+    /**
+     * Optional JSON Schema fragment for LLM tool `parameters` (OpenAI-style function calling).
+     * Merged over the auto-generated schema from catalog `inputs` (`properties` / `required` deep-merged).
+     * Use when widget-to-type inference is insufficient (e.g. `object`, `array`, `enum`, `format`).
+     */
+    toolParametersSchema?: Record<string, unknown>;
+}
+type AXPCommandExecutionMode = 'frontend' | 'backend' | 'both';
+/**
+ * Where this command is intended to appear in product tooling (AI agents, workflow automation pickers, etc.).
+ * Omitted = not declared here; runtimes may fall back to other metadata (e.g. `ai.tags`).
+ */
+type AXPCommandCapability = 'ai' | 'workflow';
+
+/**
+ * Build-time command metadata for AXPCommand implementations.
+ * `inputs` / `outputs` are schema rows (same family as entity optionDefinitions).
+ * Validation entries: only `rule` name and optional `options` (no title/message on rules).
+ * Do not import from Angular templates; sidecars may import `defineCommand` from `@acorex/platform/runtime`.
+ *
+ * Query metadata (fetch-only, no outcomes) is defined in `../queries/query-definition.types.ts` with `defineQuery`.
+ */
+
+type AXPCommandOutcomeDefinition = {
+    mode: 'static';
+    values: string[];
+} | {
+    mode: 'dynamic';
+    summary: string;
+    derivesFrom: string;
+    examples?: string[];
+};
+interface AXPCommandMetadataDefinition {
+    /** Runtime registration key (provideCommand / provideCommandSetups). */
+    key: string;
+    title: string;
+    description: string;
+    executionMode: AXPCommandExecutionMode;
+    /** Input parameters as schema rows. */
+    inputs?: AXPCommandSchemaPropertyDefinition[];
+    /** Output shape as schema rows. */
+    outputs?: AXPCommandSchemaPropertyDefinition[];
+    outcomes: AXPCommandOutcomeDefinition;
+    ai?: AXPCommandAiMetadata;
+    /** Optional list of surfaces that may list or invoke this command as a tool/activity. */
+    capabilities?: AXPCommandCapability[];
+}
+
+/**
+ * Typed identity helper for command metadata sidecars.
+ */
+declare function defineCommand<T extends AXPCommandMetadataDefinition>(definition: T): T;
+
+export { defineCommand };
+export type { AXPCommandAiContractsMetadata, AXPCommandAiMetadata, AXPCommandAiNextStepMetadata, AXPCommandAiPerformanceCost, AXPCommandAiPerformanceMetadata, AXPCommandAiResultSemanticsMetadata, AXPCommandAiSafetyKind, AXPCommandAiSafetyMetadata, AXPCommandAiUsageMetadata, AXPCommandCapability, AXPCommandExecutionMode, AXPCommandInterfaceDefinitionValue, AXPCommandMetadataDefinition, AXPCommandOutcomeDefinition, AXPCommandSchemaPropertyDefinition, AXPCommandValidationRuleValue };

package/types/acorex-platform-runtime-catalog-query-definition.d.ts

@@ -0,0 +1,125 @@
+/**
+ * Shared build-time metadata shapes for command and query catalog definitions.
+ * Lives under `shared/` so secondary ng-packagr entries under `commands/` or `queries/` share a common `src/lib` compilation root.
+ */
+/** Command metadata validation: rule key + optional rule options only. */
+interface AXPCommandValidationRuleValue {
+    rule: string;
+    options?: Record<string, unknown>;
+}
+/**
+ * Widget/interface reference for a schema property (name + optional widget options).
+ */
+interface AXPCommandInterfaceDefinitionValue {
+    name: string;
+    options?: Record<string, unknown>;
+}
+/**
+ * One input/output property description (same structural role as AXPPropertyDefinition).
+ */
+interface AXPCommandSchemaPropertyDefinition {
+    name: string;
+    title: string;
+    description?: string;
+    icon?: string;
+    defaultValue?: unknown;
+    disabled?: boolean;
+    interface: AXPCommandInterfaceDefinitionValue;
+    validations?: AXPCommandValidationRuleValue[];
+}
+/** Structured usage hints for planners and assistants (prefer over duplicating rules only in `description`). */
+interface AXPCommandAiUsageMetadata {
+    whenToUse?: string[];
+    avoidWhen?: string[];
+    /** Registry keys or tool names that commonly follow this command/query. */
+    followUpTools?: string[];
+}
+/** Declarative contracts: what the tool provides, who depends on it, and guarantees (not workflow `outcomes`). */
+interface AXPCommandAiContractsMetadata {
+    provides?: string[];
+    requiredBy?: string[];
+    guarantees?: string[];
+}
+type AXPCommandAiSafetyKind = 'read-only' | 'mutating';
+interface AXPCommandAiSafetyMetadata {
+    kind?: AXPCommandAiSafetyKind;
+    sideEffects?: boolean;
+    requiresConfirmation?: boolean;
+}
+type AXPCommandAiPerformanceCost = 'low' | 'medium' | 'high';
+interface AXPCommandAiPerformanceMetadata {
+    cost?: AXPCommandAiPerformanceCost;
+    cacheable?: boolean;
+}
+interface AXPCommandAiNextStepMetadata {
+    when: string;
+    action: string;
+}
+/**
+ * How to interpret a successful payload for agents (documentation only; not command workflow outcomes).
+ */
+interface AXPCommandAiResultSemanticsMetadata {
+    noMatch?: string;
+    exactMatch?: string;
+    multipleMatches?: string;
+    failed?: string;
+    /** Full catalog listing (e.g. no entity filter). */
+    catalog?: string;
+}
+interface AXPCommandAiMetadata {
+    shortDescription?: string;
+    tags?: string[];
+    usage?: AXPCommandAiUsageMetadata;
+    contracts?: AXPCommandAiContractsMetadata;
+    safety?: AXPCommandAiSafetyMetadata;
+    performance?: AXPCommandAiPerformanceMetadata;
+    nextSteps?: AXPCommandAiNextStepMetadata[];
+    resultSemantics?: AXPCommandAiResultSemanticsMetadata;
+    /**
+     * Default input fragment merged for AI/tool invocations (catalog & tooling).
+     * Runtime merge for a given command is applied in the AI module (not the generic command executor).
+     */
+    toolInputDefaults?: Record<string, unknown>;
+    /**
+     * Optional JSON Schema fragment for LLM tool `parameters` (OpenAI-style function calling).
+     * Merged over the auto-generated schema from catalog `inputs` (`properties` / `required` deep-merged).
+     * Use when widget-to-type inference is insufficient (e.g. `object`, `array`, `enum`, `format`).
+     */
+    toolParametersSchema?: Record<string, unknown>;
+}
+type AXPCommandExecutionMode = 'frontend' | 'backend' | 'both';
+/**
+ * Where this command is intended to appear in product tooling (AI agents, workflow automation pickers, etc.).
+ * Omitted = not declared here; runtimes may fall back to other metadata (e.g. `ai.tags`).
+ */
+type AXPCommandCapability = 'ai' | 'workflow';
+
+/**
+ * Build-time query metadata for AXPQuery implementations.
+ * Mirrors command metadata shape except there are no `outcomes` (queries only `fetch`).
+ * `inputs` / `outputs` are schema rows (same family as entity optionDefinitions).
+ */
+
+/** One input/output property description for query definitions (same as command schema rows). */
+type AXPQuerySchemaPropertyDefinition = AXPCommandSchemaPropertyDefinition;
+interface AXPQueryMetadataDefinition {
+    /** Runtime registration key (provideQuerySetups). */
+    key: string;
+    title: string;
+    description: string;
+    executionMode: AXPCommandExecutionMode;
+    /** Query input / filter parameters as schema rows. */
+    inputs?: AXPQuerySchemaPropertyDefinition[];
+    /** Documented result shape as schema rows. */
+    outputs?: AXPQuerySchemaPropertyDefinition[];
+    ai?: AXPCommandAiMetadata;
+    /** Optional list of surfaces that may list or invoke this query as a tool (e.g. AI assistants). */
+    capabilities?: AXPCommandCapability[];
+}
+
+/**
+ * Typed identity helper for query metadata sidecars.
+ */
+declare function defineQuery<T extends AXPQueryMetadataDefinition>(definition: T): T;
+
+export { defineQuery };