@pikku/cli 0.12.151 → 0.12.153

package/dist/src/functions/commands/examples.d.ts

@@ -0,0 +1,170 @@
+import { renderExamplesAdd, renderExamplesList, renderExamplesShow } from '../examples/render.js';
+export declare const examplesList: import("#pikku/function").PikkuFunctionConfig<{
+    group?: string | undefined;
+}, {
+    examples: {
+        name: string;
+        title: string;
+        when: string;
+        lang: string;
+        entity: string;
+        deferUntil: string;
+    }[];
+}, "rpc" | "session", import("#pikku/function").PikkuFunction<{
+    group?: string | undefined;
+}, {
+    examples: {
+        name: string;
+        title: string;
+        when: string;
+        lang: string;
+        entity: string;
+        deferUntil: string;
+    }[];
+}, "rpc" | "session", import("#pikku/function").WiredServices> | import("#pikku/function").PikkuFunctionSessionless<{
+    group?: string | undefined;
+}, {
+    examples: {
+        name: string;
+        title: string;
+        when: string;
+        lang: string;
+        entity: string;
+        deferUntil: string;
+    }[];
+}, "rpc" | "session", import("#pikku/function").WiredServices, unknown>, undefined, undefined>;
+export declare const examplesShow: import("#pikku/function").PikkuFunctionConfig<{
+    name: string;
+    entity?: string | undefined;
+}, {
+    found: boolean;
+    name: string;
+    title: string;
+    when: string;
+    source: string;
+    steps: string;
+    code: string;
+    notes: {
+        anchor: string | null;
+        lines: string[];
+    }[];
+    available: string[];
+}, "rpc" | "session", import("#pikku/function").PikkuFunction<{
+    name: string;
+    entity?: string | undefined;
+}, {
+    found: boolean;
+    name: string;
+    title: string;
+    when: string;
+    source: string;
+    steps: string;
+    code: string;
+    notes: {
+        anchor: string | null;
+        lines: string[];
+    }[];
+    available: string[];
+}, "rpc" | "session", import("#pikku/function").WiredServices> | import("#pikku/function").PikkuFunctionSessionless<{
+    name: string;
+    entity?: string | undefined;
+}, {
+    found: boolean;
+    name: string;
+    title: string;
+    when: string;
+    source: string;
+    steps: string;
+    code: string;
+    notes: {
+        anchor: string | null;
+        lines: string[];
+    }[];
+    available: string[];
+}, "rpc" | "session", import("#pikku/function").WiredServices, unknown>, undefined, undefined>;
+export declare const examplesAdd: import("#pikku/function").PikkuFunctionConfig<{
+    name: string;
+    entity?: string | undefined;
+    app?: string | undefined;
+}, {
+    ok: boolean;
+    name: string;
+    entity: string;
+    refusal: string;
+    written: string[];
+    kept: string[];
+    failed: string[];
+    deferred: {
+        path: string;
+        tables: string[];
+    }[];
+    manual: string[];
+    api: {
+        path: string;
+        exports: string[];
+        declarations: string[];
+    }[];
+    when: string;
+    steps: string;
+    notes: {
+        anchor: string | null;
+        lines: string[];
+    }[];
+}, "rpc" | "session", import("#pikku/function").PikkuFunction<{
+    name: string;
+    entity?: string | undefined;
+    app?: string | undefined;
+}, {
+    ok: boolean;
+    name: string;
+    entity: string;
+    refusal: string;
+    written: string[];
+    kept: string[];
+    failed: string[];
+    deferred: {
+        path: string;
+        tables: string[];
+    }[];
+    manual: string[];
+    api: {
+        path: string;
+        exports: string[];
+        declarations: string[];
+    }[];
+    when: string;
+    steps: string;
+    notes: {
+        anchor: string | null;
+        lines: string[];
+    }[];
+}, "rpc" | "session", import("#pikku/function").WiredServices> | import("#pikku/function").PikkuFunctionSessionless<{
+    name: string;
+    entity?: string | undefined;
+    app?: string | undefined;
+}, {
+    ok: boolean;
+    name: string;
+    entity: string;
+    refusal: string;
+    written: string[];
+    kept: string[];
+    failed: string[];
+    deferred: {
+        path: string;
+        tables: string[];
+    }[];
+    manual: string[];
+    api: {
+        path: string;
+        exports: string[];
+        declarations: string[];
+    }[];
+    when: string;
+    steps: string;
+    notes: {
+        anchor: string | null;
+        lines: string[];
+    }[];
+}, "rpc" | "session", import("#pikku/function").WiredServices, unknown>, undefined, undefined>;
+export { renderExamplesAdd, renderExamplesList, renderExamplesShow };

package/dist/src/functions/commands/examples.js

@@ -0,0 +1,28 @@
+import { pikkuSessionlessFunc } from '#pikku/function';
+import { ExamplesAddInputSchema, ExamplesAddOutputSchema, ExamplesListInputSchema, ExamplesListOutputSchema, ExamplesShowInputSchema, ExamplesShowOutputSchema, } from '../examples/command-schemas.js';
+import { runExamplesAdd, runExamplesList, runExamplesShow, } from '../examples/run.js';
+import { renderExamplesAdd, renderExamplesList, renderExamplesShow, } from '../examples/render.js';
+const projectOf = (config) => ({
+    rootDir: config.rootDir,
+    outDir: config.outDir,
+    srcDirectories: config.srcDirectories,
+});
+export const examplesList = pikkuSessionlessFunc({
+    description: 'List the worked examples this CLI ships — one per thing that is easy to get wrong and hard to discover',
+    input: ExamplesListInputSchema,
+    output: ExamplesListOutputSchema,
+    func: async (_services, input) => runExamplesList(input?.group),
+});
+export const examplesShow = pikkuSessionlessFunc({
+    description: 'Print one example, renamed onto your own entity, with everything the recipe says about itself',
+    input: ExamplesShowInputSchema,
+    output: ExamplesShowOutputSchema,
+    func: async ({ config }, input) => runExamplesShow(projectOf(config), input.name, input.entity),
+});
+export const examplesAdd = pikkuSessionlessFunc({
+    description: 'Write one example into this project, already named for your entity, or say what is in the way and write nothing',
+    input: ExamplesAddInputSchema,
+    output: ExamplesAddOutputSchema,
+    func: async ({ config }, input) => runExamplesAdd(projectOf(config), input.name, input.entity, input.app),
+});
+export { renderExamplesAdd, renderExamplesList, renderExamplesShow };